| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537 |
1
1
1
1
1
1
1
1
34
34
34
34
34
9
9
34
34
34
34
34
34
34
34
20
20
34
34
34
34
34
1
7542
66
205
10
195
1
194
10
10
8
8
7
1
10
10
34
34
34
34
34
34
34
1
1
1
1
1
2
2
2
2
3
3
3
3
3
2
2
3
3
2
2
2
2
16
4
4
4
4
4
3
124
118
124
2
124
124
124
10
10
16
16
10
10
10
10
10
124
124
124
86
86
86
38
38
1
1
1
1
1
38
124
124
124
8
8
8
8
8
8
1
1
1
7
6
6
7
6
6
6
6
4
6
6
6
6
6
6
7
5
5
5
2
2
1
1
1
1
2
63
63
63
63
63
63
63
1654
1654
1654
1654
63
63
63
2
2
2
2
2
2
2
2
2
1
1
1
1
1
2
1
| /* globals window, localStorage, navigator */
var FieldDBObject = require("./../FieldDBObject").FieldDBObject;
var ELanguages = require("./ELanguages").ELanguages;
var CORS = require("./../CORS").CORS;
var Q = require("q");
var english_texts = require("./en/messages.json");
var spanish_texts = require("./es/messages.json");
var elanguages = require("./elanguages.json");
/**
* @class The contextualizer can resolves strings depending on context and locale of the user
* @name Contextualizer
*
* @property {ELanguage} defaultLocale The language/context to use if a translation/contextualization is missing.
* @property {ELanguage} currentLocale The current locale to use (often the browsers default locale, or a corpus" default locale).
*
* @extends FieldDBObject
* @constructs
*/
var Contextualizer = function Contextualizer(options) {
Eif (!this._fieldDBtype) {
this._fieldDBtype = "Contextualizer";
}
this.debug("Constructing Contextualizer ", options);
// this.debugMode = true;
var localArguments = arguments;
if (!options) {
options = {};
localArguments = [options];
}
Eif (!options.defaultLocale || !options.defaultLocale.iso) {
options.defaultLocale = {
iso: "en"
};
}
// if (!options.currentLocale || !options.currentLocale.iso) {
// options.currentLocale = {
// iso: "en"
// };
// }
Eif (!options.currentContext) {
options.currentContext = "default";
}
Eif (!options.elanguages) {
options.elanguages = elanguages;
}
FieldDBObject.apply(this, localArguments);
if (!options || options.alwaysConfirmOkay === undefined) {
this.debug("By default it will be okay for users to modify global locale strings. IF they are saved this will affect other users.");
this.alwaysConfirmOkay = true;
}
Iif (this.userOverridenLocalePreference) {
this.currentLocale = this.userOverridenLocalePreference;
} else {
try {
if (navigator.languages[0].indexOf(this.currentLocale.iso) === -1) {
this.currentLocale = navigator.languages[0];
}
} catch (e) {
this.debug("not using hte browser's language", e);
}
}
return this;
};
Contextualizer.prototype = Object.create(FieldDBObject.prototype, /** @lends Contextualizer.prototype */ {
constructor: {
value: Contextualizer
},
INTERNAL_MODELS: {
value: {
elanguages: ELanguages
}
},
_require: {
value: (typeof global !== "undefined") ? global.require : (typeof window !== "undefined") ? window.require : null
},
data: {
get: function() {
return this._data;
},
set: function(value) {
this._data = value;
}
},
currentLocale: {
get: function() {
if (this._currentLocale) {
return this._currentLocale;
}
if (this._mostAvailableLanguage) {
return this._mostAvailableLanguage;
}
return this.defaultLocale;
},
set: function(value) {
Iif (value === this._currentLocale) {
return;
}
if (value && value.toLowerCase && typeof value === "string") {
value = value.toLowerCase().replace(/[^a-z-]/g, "");
if (this.elanguages && this.elanguages[value]) {
value = this.elanguages[value];
} else {
value = {
iso: value
};
}
}
this.debug("SETTING LOCALE FROM " + this._currentLocale + " to ", value, this.data);
this._currentLocale = value;
}
},
userOverridenLocalePreference: {
get: function() {
var userOverridenLocalePreference;
try {
userOverridenLocalePreference = JSON.parse(localStorage.getItem("_userOverridenLocalePreference"));
} catch (e) {
this.debug("Localstorage is not available, using the object there will be no persistance across loads", e, this._userOverridenLocalePreference);
userOverridenLocalePreference = this._userOverridenLocalePreference;
}
Eif (!userOverridenLocalePreference) {
return;
}
return userOverridenLocalePreference;
},
set: function(value) {
Eif (value) {
try {
localStorage.setItem("_userOverridenLocalePreference", JSON.stringify(value));
} catch (e) {
this._userOverridenLocalePreference = value;
this.debug("Localstorage is not available, using the object there will be no persistance across loads", e, this._userOverridenLocalePreference);
}
} else {
try {
localStorage.removeItem("_userOverridenLocalePreference");
} catch (e) {
this.debug("Localstorage is not available, using the object there will be no persistance across loads", e, this._userOverridenLocalePreference);
delete this._userOverridenLocalePreference;
}
}
}
},
availableLanguages: {
get: function() {
this.data = this.data || {};
Iif (this._availableLanguages && this.data[this._availableLanguages._collection[0].iso] && this._availableLanguages._collection[0].length === this.data[this._availableLanguages._collection[0].iso].length) {
return this._availableLanguages;
}
var availLanguages = new ELanguages(),
bestAvailabilityCount = 0;
for (var code in this.data) {
Eif (this.data.hasOwnProperty(code)) {
this.elanguages[code].length = this.data[code].length;
Eif (this.elanguages[code].length > bestAvailabilityCount) {
availLanguages.unshift(this.elanguages[code]);
bestAvailabilityCount = this.elanguages[code].length;
} else {
availLanguages.push(this.elanguages[code]);
}
}
}
Iif (bestAvailabilityCount === 0 || availLanguages.length === 0) {
this.todo("Ensuring that at least english is an available language, not sure if this is a good idea.");
availLanguages.unshift(this.elanguages.en);
} else {
availLanguages._collection.map(function(language) {
language.percentageOfAvailability = Math.round(language.length / bestAvailabilityCount * 100);
return language;
});
}
this.todo("test whether setting the currentLocale to the most complete locale has adverse affects.");
this._mostAvailableLanguage = availLanguages._collection[0];
this._availableLanguages = availLanguages;
return availLanguages;
}
},
defaults: {
get: function() {
return {
en: JSON.parse(JSON.stringify(english_texts)),
es: JSON.parse(JSON.stringify(spanish_texts))
};
}
},
loadDefaults: {
value: function() {
Eif (this.defaults.en) {
this.addMessagesToContextualizedStrings("en", this.defaults.en);
} else {
this.debug("English Locales did not load.");
}
Eif (this.defaults.es) {
this.addMessagesToContextualizedStrings("es", this.defaults.es);
} else {
this.debug("English Locales did not load.");
}
return this;
}
},
localize: {
value: function(message, optionalLocaleForThisCall) {
return this.contextualize(message, optionalLocaleForThisCall);
}
},
contextualize: {
value: function(message, optionalLocaleForThisCall) {
if (!optionalLocaleForThisCall) {
optionalLocaleForThisCall = this.currentLocale.iso;
}
if (optionalLocaleForThisCall && optionalLocaleForThisCall.iso) {
optionalLocaleForThisCall = optionalLocaleForThisCall.iso;
}
this.debug("Resolving localization in " + optionalLocaleForThisCall);
var result = message,
aproperty;
// Use the current context if the caller is requesting localization of an object
if (typeof message === "object") {
var foundAContext = false;
for (aproperty in message) {
Iif (!message.hasOwnProperty(aproperty)) {
continue;
}
if (aproperty.indexOf(this.currentContext) > -1 || ((this.currentContext === "child" || this.currentContext === "game") && aproperty.indexOf("gamified") > -1)) {
result = message[aproperty];
foundAContext = true;
this.debug("Using " + aproperty + " for this contxtualization.");
break;
}
}
Iif (!foundAContext && message.default) {
this.debug("Using default for this contxtualization. ", message);
result = message.default;
}
}
Iif (!this.data) {
this.warn("No localizations available, resolving the key itself: ", result);
return result;
}
var keepTrying = true;
if (this.data[optionalLocaleForThisCall] && this.data[optionalLocaleForThisCall][result] && this.data[optionalLocaleForThisCall][result].message !== undefined) {
result = this.data[optionalLocaleForThisCall][result].message;
this.debug("Resolving requested contextualization using requested language: ", result);
keepTrying = false;
} else Iif (this.data[this.defaultLocale.iso] && this.data[this.defaultLocale.iso][result] && this.data[this.defaultLocale.iso][result].message !== undefined) {
result = this.data[this.defaultLocale.iso][result].message;
this.debug("Resolving requested contextualization using default language: ", result);
keepTrying = false;
} else {
if (typeof message === "object") {
Iif (message[result] && this.data[optionalLocaleForThisCall] && this.data[optionalLocaleForThisCall][message[result]] && this.data[optionalLocaleForThisCall][message[result]].message !== undefined && this.data[optionalLocaleForThisCall][message[result]].message) {
result = this.data[optionalLocaleForThisCall][message[result]].message;
this.debug("Resolving localization using requested contextualization: ", message[result]);
keepTrying = false;
} else Eif (message.default && this.data[optionalLocaleForThisCall] && this.data[optionalLocaleForThisCall][message.default] && this.data[optionalLocaleForThisCall][message.default].message !== undefined && this.data[optionalLocaleForThisCall][message.default].message) {
result = this.data[optionalLocaleForThisCall][message.default].message;
this.debug("Resolving localization using default contextualization: ", message.default);
keepTrying = false;
} else if (message.default && this.data[this.defaultLocale.iso] && this.data[this.defaultLocale.iso][message.default] && this.data[this.defaultLocale.iso][message.default].message !== undefined && this.data[this.defaultLocale.iso][message.default].message) {
result = this.data[this.defaultLocale.iso][message.default].message;
this.debug("Resolving localization using default contextualization and default locale: ", message.default);
keepTrying = false;
}
}
Iif (keepTrying && this.data[this.defaultLocale.iso] && this.data[this.defaultLocale.iso][result] && this.data[this.defaultLocale.iso][result].message !== undefined && this.data[this.defaultLocale.iso][result].message) {
result = this.data[this.defaultLocale.iso][result].message;
this.debug("Resolving localization using default: ", result);
}
}
Iif (keepTrying && !this.requestedCorpusSpecificLocalizations && FieldDBObject && FieldDBObject.application && FieldDBObject.application.corpus && FieldDBObject.application.corpus.loaded && typeof FieldDBObject.application.corpus.getCorpusSpecificLocalizations === "function") {
FieldDBObject.application.corpus.getCorpusSpecificLocalizations();
this.requestedCorpusSpecificLocalizations = true;
}
result = result.replace(/^locale_/, "");
return result;
}
},
/**
*
* @param {String} key A locale to save the message to
* @param {String} value a message which should replace the existing localization
* @return {Promise} A promise for whether or not the update was confirmed and executed
*/
updateContextualization: {
value: function(key, value) {
var deferred = Q.defer(),
self = this,
previousMessage = "",
verb = "create ";
this.whenReadys = this.whenReadys || [];
this.todo("Test async updateContextualization");
this.whenReadys.push(deferred.promise);
this.data[this.currentLocale.iso] = this.data[this.currentLocale.iso] || {};
if (this.data[this.currentLocale.iso][key] && this.data[this.currentLocale.iso][key].message === value) {
Q.nextTick(function() {
deferred.resolve(value);
});
return deferred.promise; //no change
}
if (this.data[this.currentLocale.iso][key]) {
previousMessage = this.data[this.currentLocale.iso][key].message;
verb = "update ";
}
var addTheUsersMessage = function(addkey, addvalue) {
self.debug("Adding the user's message. ", addkey, addvalue);
self.data[self.currentLocale.iso][addkey] = self.data[self.currentLocale.iso][addkey] || {};
self.data[self.currentLocale.iso][addkey].message = addvalue;
if (!self.fossil) {
self.fossil = self.toJSON();
}
self.unsaved = true;
var newLocaleItem = {};
newLocaleItem[key] = {
message: addvalue
};
self.addMessagesToContextualizedStrings(self.currentLocale.iso, newLocaleItem);
Q.nextTick(function() {
deferred.resolve(addvalue);
});
};
if (!this.testingAsyncConfirm && this.alwaysConfirmOkay /* run synchonosuly whenever possible */ ) {
self.debug(" Running synchonosuly. ", key, value);
addTheUsersMessage(key, value);
return deferred.promise;
}
self.debug(" Running asynchonosuly. ", key, value);
this.confirm("Do you also want to " + verb + key + " for other users? \n" + previousMessage + " -> " + value)
.then(function(response) {
self.debug("Recieved confirmation ,", response);
addTheUsersMessage(key, value);
},
function(reason) {
self.debug("Not updating , user clicked cancel", reason);
deferred.reject(reason);
})
.fail(
function(error) {
console.error(error.stack, self);
deferred.reject(error);
});
return deferred.promise;
}
},
audio: {
value: function(key) {
this.debug("Resolving localization in " + this.currentLocale.iso);
var result = {};
if (!this.data) {
this.warn("No localizations available, resolving empty audio details");
return result;
}
if (this.data[this.currentLocale.iso] && this.data[this.currentLocale.iso][key] && this.data[this.currentLocale.iso][key].audio !== undefined && this.data[this.currentLocale.iso][key].audio) {
result = this.data[this.currentLocale.iso][key].audio;
this.debug("Resolving localization audio using requested language: ", result);
} else {
if (this.data[this.defaultLocale.iso] && this.data[this.defaultLocale.iso][key] && this.data[this.defaultLocale.iso][key].audio !== undefined && this.data[this.defaultLocale.iso][key].audio) {
result = this.data[this.defaultLocale.iso][key].audio;
this.warn("Resolving localization audio using default: ", result);
}
}
return result;
}
},
addUrls: {
value: function(files, baseUrl) {
var promises = [],
f;
for (f = 0; f < files.length; f++) {
promises.push(this.addUrl(files[f], baseUrl));
}
return Q.all(promises);
}
},
addUrl: {
value: function(file, baseUrl) {
var deferred = Q.defer(),
localeCode,
self = this;
if (!baseUrl && FieldDBObject && FieldDBObject.application && FieldDBObject.application.corpus && FieldDBObject.application.corpus.url) {
this.debug("using corpus as base url");
baseUrl = FieldDBObject.application.corpus.url;
}
if (file.indexOf("/messages.json" > -1)) {
localeCode = file.replace("/messages.json", "");
if (localeCode.indexOf("/") > -1) {
localeCode = localeCode.substring(localeCode.lastIndexOf("/"));
}
localeCode = localeCode.replace(/[^a-zA-Z-]/g, "").toLowerCase();
if (!localeCode || localeCode.length < 2) {
localeCode = "default";
}
} else {
localeCode = "en";
}
CORS.makeCORSRequest({
method: "GET",
url: baseUrl + "/" + file,
dataType: "json"
}).then(function(localeMessages) {
self.originalDocs = self.originalDocs || [];
self.originalDocs.push(file);
self.addMessagesToContextualizedStrings(localeCode, localeMessages)
.then(deferred.resolve,
deferred.reject)
.fail(function(error) {
console.error(error.stack, self);
deferred.reject(error);
});
}, function(error) {
self.warn("There werent any locales at this url" + baseUrl + " :( Maybe this database has no custom locale messages.", error);
}).fail(function(error) {
console.error(error.stack, self);
deferred.reject(error);
});
return deferred.promise;
}
},
addMessagesToContextualizedStrings: {
value: function(localeCode, localeData) {
var deferred = Q.defer(),
self = this;
Iif (!localeData) {
Q.nextTick(function() {
deferred.reject("The locales data was empty!");
});
return deferred.promise;
}
Iif (!localeCode && localeData._id) {
localeCode = localeData._id.replace("/messages.json", "");
if (localeCode.indexOf("/") > -1) {
localeCode = localeCode.substring(localeCode.lastIndexOf("/"));
}
localeCode = localeCode.replace(/[^a-zA-Z-]/g, "").toLowerCase();
if (!localeCode || localeCode.length < 2) {
localeCode = "default";
}
}
self.originalDocs = self.originalDocs || [];
self.originalDocs.push(localeData);
self.data = self.data || {};
for (var message in localeData) {
Eif (localeData.hasOwnProperty(message) && message.indexOf("_") !== 0) {
self.data[localeCode] = self.data[localeCode] || {
length: 0
};
self.data[localeCode][message] = localeData[message];
self.data[localeCode].length++;
}
}
Q.nextTick(function() {
deferred.resolve(self.data);
});
return deferred.promise;
}
},
save: {
value: function() {
var promises = [];
for (var locale in this.data) {
Iif (!this.data.hasOwnProperty(locale)) {
continue;
}
this.debug("Requsting save of " + locale);
var doc = new FieldDBObject(this.data[locale]);
doc.dbname = this.dbname;
this.debug("Will save locale save of ", doc);
var userHasModifiedContexualizations = !!this.fossil;
if (this.email) {
this.debug(" via Git ", doc);
promises.push(doc.saveToGit({
email: this.email,
message: "Updated locale messages"
}, userHasModifiedContexualizations));
} else {
doc.id = locale + "/messages.json";
// doc.debugMode = true;
this.debug(" via REST ", doc);
promises.push(doc.save(null, userHasModifiedContexualizations));
}
}
return Q.allSettled(promises);
}
}
});
exports.Contextualizer = Contextualizer;
|