/usr/share/xul-ext/personasplus/modules/service.js is in xul-ext-personasplus 1.7.3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 | /* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is Personas.
*
* The Initial Developer of the Original Code is Mozilla.
* Portions created by the Initial Developer are Copyright (C) 2007
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Chris Beard <cbeard@mozilla.org>
* Myk Melez <myk@mozilla.org>
* Jose E. Bolanos <jose@appcoast.com>
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
let EXPORTED_SYMBOLS = ["PersonaService", "PERSONAS_EXTENSION_ID"];
const Cc = Components.classes;
const Ci = Components.interfaces;
const Cr = Components.results;
const Cu = Components.utils;
// modules that come with Firefox
Cu.import("resource://gre/modules/ctypes.jsm")
Cu.import("resource://gre/modules/osfile.jsm")
Cu.import("resource://gre/modules/AddonManager.jsm");
Cu.import("resource://gre/modules/Services.jsm");
Cu.import("resource://gre/modules/XPCOMUtils.jsm");
// LightweightThemeManager may not be not available (Firefox < 3.6 or Thunderbird)
try { Cu.import("resource://gre/modules/LightweightThemeManager.jsm"); }
catch (e) { LightweightThemeManager = null; }
// modules that are generic
Cu.import("resource://personas/modules/log4moz.js");
Cu.import("resource://personas/modules/Observers.js");
Cu.import("resource://personas/modules/Preferences.js");
Cu.import("resource://personas/modules/StringBundle.js");
Cu.import("resource://personas/modules/URI.js");
const PERSONAS_EXTENSION_ID = "personas@christopher.beard";
const COOKIE_INITIAL_PERSONA = "initial_persona";
function endsWith(str, end) {
return !end || end.length <= str.length && end == str.slice(-end.length);
}
let PersonaService = {
THUNDERBIRD_ID: "{3550f703-e582-4d05-9a08-453d09bdfdc6}",
FIREFOX_ID: "{ec8030f7-c20a-464f-9b0e-13a3a9e97384}",
// Wraps event listener functions so errors are not lost.
wrap: function(fn) {
return function() {
try {
return fn.apply(this, arguments);
} catch (e) {
Cu.reportError(e);
}
};
},
//**************************************************************************//
// Shortcuts
// Access to extensions.personas.* preferences. To access other preferences,
// call the Preferences module directly.
get _prefs() {
delete this._prefs;
return this._prefs = new Preferences("extensions.personas.");
},
get _strings() {
delete this._strings;
return this._strings = new StringBundle("chrome://personas/locale/personas.properties");
},
get appInfo() {
delete this.appInfo;
return this.appInfo = Cc["@mozilla.org/xre/app-info;1"].
getService(Ci.nsIXULAppInfo).
QueryInterface(Ci.nsIXULRuntime);
},
get _log() {
delete this._log;
return this._log = Log4Moz.getConfiguredLogger("PersonaService");
},
//**************************************************************************//
// Initialization & Destruction
_init: function() {
let t = this;
AddonManager.getAddonByID(PERSONAS_EXTENSION_ID, function (addon) {
t.urlSource = "personas-plus-" + addon.version;
t.onAddonsHostChanged();
});
// Observe quit so we can destroy ourselves.
Observers.add("quit-application", this.onQuitApplication, this);
// Observe the "cookie-changed" topic to load the favorite personas when
// the user signs in.
if (false)
// Skip this for now, since AMO session cookies are not currently
// cooperative
Observers.add("cookie-changed", this.onCookieChanged, this);
// Observe the "lightweight-theme-changed" to sync the add-on with the
// lightweight theme manager.
Observers.add("lightweight-theme-changed",
this.onLightweightThemeChanged, this);
// Observe HTTP responses to detect login and logout
Observers.add("http-on-examine-response",
this.onHTTPResponse, this);
this._prefs.observe("useTextColor", this.onUseColorChanged, this);
this._prefs.observe("useAccentColor", this.onUseColorChanged, this);
this._prefs.observe("selected", this.onSelectedModeChanged, this);
this._prefs.observe("addons-host", this.onAddonsHostChanged, this);
this._ltmSyncTimer = Cc["@mozilla.org/timer;1"].createInstance(Ci.nsITimer);
// Change to the initial persona if preferences indicate that a persona
// should be active but they don't specify the persona that is active.
// This normally happens only on first run, although it could theoretically
// happen at other times.
//
// The initial persona is either the persona specified by a cookie (set by
// the gallery), the one specified by the extensions.personas.initial
// preference (set by a distribution.ini file for a BYOB/bundle/distributon
// build), or the Groovy Blue persona which is hardcoded into this code.
//
// NOTE: the logic here is carefully designed to achieve the correct outcome
// under a variety of circumstances and should be changed with caution!
// See bug 513765 and bug 503300 for some details on why it works this way.
//
if (this._prefs.get("selected") == "current" && !this._prefs.get("current")) {
if (this._prefs.has("initial"))
this.changeToPersona(JSON.parse(this._prefs.get("initial")));
else if (LightweightThemeManager && LightweightThemeManager.currentTheme)
this.changeToPersona(LightweightThemeManager.currentTheme);
else {
let addonSlug = this._prefs.get("initial.slug");
let url = this.getURL("addon-details", { "ADDON_SLUG": addonSlug });
this._makeRequest(url, function (event) {
let responseJSON = JSON.parse(event.target.responseText);
this._log.debug("Fetched persona from " + url + " " +
JSON.stringify(responseJSON.theme));
this.changeToPersona(this.getPersonaJSON(responseJSON));
// There seems to be a bug in the LightweightThemeManager that
// prevents this from being called automatically at this
// point.
LightweightThemeManager.themeChanged(
LightweightThemeManager.currentTheme);
}.bind(this));
}
}
let timerManager = Cc["@mozilla.org/updates/timer-manager;1"].
getService(Ci.nsIUpdateTimerManager);
// Load cached personas data
this.loadDataFromCache();
// Refresh data, then set a timer to refresh it periodically.
// This isn't quite right, since we always load data on startup, even if
// we've recently refreshed it. And the timer that refreshes data ignores
// the data load on startup, so if it's been more than the timer interval
// since a user last started her browser, we load the data twice:
// once because the browser starts and once because the refresh timer fires.
this.refreshData();
let dataRefreshCallback = {
_svc: this,
notify: function(timer) { this._svc._refreshDataWithMetrics() }
};
timerManager.registerTimer("personas-data-refresh-timer",
dataRefreshCallback,
86400 /* in seconds == one day */);
// Refresh the current persona once per day. We only do this for
// Thunderbird and Firefox < 3.6, since the LightweightThemeManager
// does this for Firefox 3.6.
if (!LightweightThemeManager) {
let personaRefreshCallback = {
_svc: this,
notify: function(timer) { this._svc._refreshPersona() }
};
timerManager.registerTimer("personas-persona-refresh-timer",
personaRefreshCallback,
86400 /* in seconds == one day */);
}
// Load cached favorite personas
this.loadFavoritesFromCache();
// Refresh the favorite personas once per day.
let favoritesRefreshCallback = {
_svc: this,
notify: function(timer) { this._svc.refreshFavorites() }
};
timerManager.registerTimer("personas-favorites-refresh-timer",
favoritesRefreshCallback,
24 * 60 * 60);
this._rotationTimer = Cc["@mozilla.org/timer;1"].createInstance(Ci.nsITimer);
this.onSelectedModeChanged();
},
_destroy: function() {
Observers.remove("cookie-changed", this.onCookieChanged, this);
Observers.remove("lightweight-theme-changed",
this.onLightweightThemeChanged, this);
Observers.remove("http-on-examine-response", this.onHTTPResponse, this);
this._prefs.ignore("useTextColor", this.onUseColorChanged, this);
this._prefs.ignore("useAccentColor", this.onUseColorChanged, this);
this._prefs.ignore("selected", this.onSelectedModeChanged, this);
this._prefs.ignore("addons-host", this.onAddonsHostChanged, this);
},
// The `src` parameter used in AMO requests.
urlSource: "personas-plus",
//**************************************************************************//
// XPCOM Plumbing
QueryInterface: XPCOMUtils.generateQI([Ci.nsIObserver,
Ci.nsIDOMEventListener,
Ci.nsITimerCallback]),
//**************************************************************************//
// Data Retrieval
_makeRequest: function(url, loadCallback, headers, aIsBinary, wantErrors, options) {
let request = Cc["@mozilla.org/xmlextras/xmlhttprequest;1"].createInstance();
request.addEventListener("load", this.wrap(loadCallback), false);
if (wantErrors)
request.addEventListener("error", this.wrap(loadCallback), false);
request.open("GET", url, true);
// Force the request to include cookies even though this chrome code
// is seen as a third-party, so the server knows the user for which we are
// requesting favorites (or anything else user-specific in the future).
// This only works in Firefox 3.6; in Firefox 3.5 the request will instead
// fail to send cookies if the user has disabled third-party cookies.
try {
request.channel.QueryInterface(Ci.nsIHttpChannelInternal).
forceAllowThirdPartyCookie = true;
}
catch(ex) { /* user is using Firefox 3.5 */ }
if (headers)
for (let header in headers)
request.setRequestHeader(header, headers[header]);
if (aIsBinary)
request.overrideMimeType('text/plain; charset=x-user-defined');
else if (/^file:/.test(url) && !/\.xml$/.test(url))
request.overrideMimeType('text/plain');
if (options)
for (let option in options)
request[option] = options[option];
request.send(null);
},
/**
* Refresh data. This method gets called on demand (including on startup)
* and retrieves data without passing any additional information about
* the selected persona and the application (that information is only included
* in the daily retrieval so we can get consistent daily statistics from it
* no matter how many times a user starts the application in a given day).
*/
refreshData: function() {
let url = this.getURL("featured-feed");
this._makeRequest(url, this.onDataLoadComplete.bind(this));
},
/**
* Refresh data, providing metrics on persona usage in the process.
* This method gets called approximately once per day on a cross-session timer
* (provided Firefox is run every day), updates the version of the data
* that is currently in memory, and passes information about the selected
* persona and the host application to the server for statistical analysis
* (f.e. figuring out which personas are the most popular).
*/
_refreshDataWithMetrics: function() {
let appInfo = Cc["@mozilla.org/xre/app-info;1"].
getService(Ci.nsIXULAppInfo);
let xulRuntime = Cc["@mozilla.org/xre/app-info;1"].
getService(Ci.nsIXULRuntime);
// Calculate the amount of time (in hours) since the persona was last changed.
let duration = "";
if (this._prefs.has("persona.lastChanged"))
duration = Math.round((new Date() - new Date(parseInt(this._prefs.get("persona.lastChanged")))) / 1000 / 60 / 60);
// This logic is based on ExtensionManager::_updateLocale.
let locale;
try {
if (Preferences.get("intl.locale.matchOS")) {
let localeSvc = Cc["@mozilla.org/intl/nslocaleservice;1"].
getService(Ci.nsILocaleService);
locale = localeSvc.getLocaleComponentForUserAgent();
}
else
throw "set locale in the catch block";
}
catch (ex) {
locale = Preferences.get("general.useragent.locale");
}
let params = {
type: this.selected,
id: this.currentPersona ? this.currentPersona.id : "",
duration: duration,
appID: appInfo.ID,
appVersion: appInfo.version,
appLocale: locale,
appOS: xulRuntime.OS,
appABI: xulRuntime.XPCOMABI
};
//dump("params: " + [name + "=" + encodeURIComponent(params[name]) for (name in params)].join("&") + "\n");
let url = this.getURL("featured-feed") +
"?" + [name + "=" + encodeURIComponent(params[name]) for (name in params)].join("&");
this._makeRequest(url, this.onDataLoadComplete.bind(this));
},
onDataLoadComplete: function(aEvent) {
let request = aEvent.target;
// XXX Try to reload again sooner?
if (request.status != 200)
throw("problem loading data: " + request.status + " - " + request.statusText);
let response = JSON.parse(request.responseText);
this.personas = {
featured: response.addons
};
// Cache the response
let cacheDirectory =
FileUtils.getDirectory(FileUtils.getPersonasDirectory(), "cache");
FileUtils.writeFile(cacheDirectory, "personas.json", request.responseText);
},
/**
* Attempts to load this.personas from the cached file in cache/personas.json
*/
loadDataFromCache: function() {
let path =
FileUtils.getDirectory(FileUtils.getPersonasDirectory(), "cache");
path.append("personas.json");
this._makeRequest(Services.io.newFileURI(path).spec, onload.bind(this),
null, false, true);
function onload(event) {
try {
this.personas = JSON.parse(event.target.responseText);
}
catch (e) {
// Could not load from cached data, file empty or does not exist perhaps
return;
}
// Now that we have data, pick a new random persona. Currently, this is
// the only time we pick a random persona besides when the user selects
// the "Random From [category]" menuitem, which means the user gets a new
// random persona each time they start the browser.
if (this.selected == "random") {
this.currentPersona = this._getRandomPersonaFromCategory(this.category);
this._prefs.reset("persona.lastRefreshed");
this._notifyPersonaChanged(this.currentPersona);
}
}
},
/**
* Makes a request to obtain the favorite personas json. This occurs only if
* a user is currenly signed in.
*/
refreshFavorites: function(aURL) {
let url = aURL || this.getURL("favorites-feed");
this._makeRequest(url, this.onFavoritesLoadComplete.bind(this, aURL),
null, null, true);
},
/**
* Handles the response from the refreshFavorites method. Loads the favorite
* personas list.
* @param aURL The URL passed to refreshFavorites
* @param aEvent The Http request event object.
*/
onFavoritesLoadComplete: function(aURL, aEvent) {
let request = aEvent.target;
this.favoritesError = false;
if (request.status != 200 || request.getResponseHeader("Content-Type") != "application/json") {
this._log.info("problem loading favorites from " + request.channel.name + ": " + request.status + " - " + request.statusText);
if (request.status != 200)
this.favoritesError = true;
this.favorites = null;
return;
}
try {
var json = JSON.parse(request.responseText)
.addons.filter(function (a) a.theme);
}
catch(ex) {
this._log.debug("error parsing favorites data: " + request.responseText.slice(0, 100) + "...");
return;
}
this[aURL ? "_favorites" : "favorites"] = json;
},
/**
* Attempts to load this.favorites from the cached file in
* cache/favorites.json
*/
loadFavoritesFromCache: function() {
let path = FileUtils.getDirectory(FileUtils.getPersonasDirectory(), "cache");
path.append("favorites.json");
try {
this.refreshFavorites(Services.io.newFileURI(path).spec);
}
catch (e) {
Cu.reportError(e);
}
},
/**
* Adds the given persona to the favorites list. If the persona is already
* in the list then it is replaced.
* @param aPersona The persona object to be added.
*/
addFavoritePersona: function(aPersona) {
// Make sure the favorites list exists.
if (!this.favorites)
this.favorites = [];
let i = this._findPersonaInArray(aPersona, this.favorites);
if (i >= 0)
this.favorites[i] = aPersona;
else
this.favorites.push(aPersona);
},
/**
* Removes the given persona from the favorites list, if found.
* @param aPersona The persona object to be removed.
*/
removeFavoritePersona: function(aPersona) {
// Abort if the favorites list hasn't been created.
if (!this.favorites)
return;
let i = this._findPersonaInArray(aPersona, this.favorites);
if (i >= 0)
this.favorites.splice(i, 1);
},
_refreshPersona: function() {
// Only refresh the persona if the user selected a specific persona with an
// ID and update URL. If the user selected a random persona, we'll change
// it the next time we refresh the directory; if the user selected
// the default persona, we don't need to refresh it, as it doesn't change;
// if the user selected a custom persona (which doesn't have an ID), it's
// not clear what refreshing it would mean; and if the persona doesn't have
// an update URL, then we don't have a way to refresh it.
if (this.selected != "current" ||
!this.currentPersona ||
!this.currentPersona.id ||
!this.currentPersona.updateURL)
return;
let headers = {};
if (this._prefs.has("persona.lastRefreshed")) {
let date = new Date(parseInt(this._prefs.get("persona.lastRefreshed")));
headers["If-Modified-Since"] = DateUtils.toRFC1123(date);
}
let currentPersona;
try { currentPersona = JSON.stringify(this.currentPersona) }
catch(ex) { currentPersona = "error JSON.stringify-ing currentPersona " +
this.currentPersona + ": " + ex }
this._log.debug("_refreshPersona: currentPersona = " + currentPersona +
"; url = " + this.currentPersona.updateURL);
let t = this;
this._makeRequest(this.currentPersona.updateURL,
function(evt) { t.onPersonaLoadComplete(evt) },
headers);
},
onPersonaLoadComplete: function(event) {
let request = event.target;
this._log.debug("onPersonaLoadComplete: status = " + request.status +
"; responseText = " + request.responseText);
// 304 means the file we requested has not been modified since the
// If-Modified-Since date we specified, so there's nothing to do.
if (request.status == 304) {
//dump("304 - the persona has not been modified\n");
return;
}
if (request.status != 200)
throw("problem refreshing persona: " + request.status + " - " + request.statusText);
let persona = JSON.parse(request.responseText);
// If the persona we're refreshing is no longer the selected persona,
// then cancel the refresh (otherwise we'd undo whatever changes the user
// has just made).
if (this.selected != "current" || !this.currentPersona ||
this.currentPersona.id != persona.id) {
//dump("persona " + persona.id + "(" + persona.name + ") no longer the current persona; ignoring refresh\n");
return;
}
// If the version strings are identical, the persona hasn't changed.
if ((persona.version || "") == (this.currentPersona.version || ""))
return;
// Set the current persona to the updated version we got from the server,
// and notify observers about the change.
this.currentPersona = persona;
this._notifyPersonaChanged(this.currentPersona);
// Record when this refresh took place so the next refresh only looks
// for changes since this refresh.
// Note: we set the preference to a string value because preferences
// can't hold large enough integer values.
this._prefs.set("persona.lastRefreshed", new Date().getTime().toString());
},
//**************************************************************************//
// Implementation
// The JSON feed of personas retrieved from the server.
// Loaded upon service initialization and reloaded periodically thereafter.
personas: null,
// The JSON feed of favorite personas retrieved from the server.
_favorites: null,
get favorites() this._favorites,
set favorites(val) {
this._favorites = val;
let path =
FileUtils.getDirectory(FileUtils.getPersonasDirectory(), "cache");
// Cache the response
if (val && typeof val == "object")
// This FileUtils nonsense has to go...
FileUtils.writeFile(path, "favorites.json", JSON.stringify(val));
else {
path.append("favorites.json");
OS.File.remove(path.spec);
}
},
/**
* extensions.personas.selected: the type of persona that the user selected;
* possible values are default (the default Firefox theme), random (a random
* persona from a category), current (the value of this.currentPersona), and
* randomFavorite (a random persona from the favorite list).
*/
get selected() { return this._prefs.get("selected") },
set selected(newVal) { this._prefs.set("selected", newVal); },
/**
* extensions.personas.current: the current persona
*/
get currentPersona() {
let current = this._prefs.get("current");
if (current) {
try { return JSON.parse(current) }
catch(ex) { Cu.reportError("error getting current persona: " + ex) }
}
return null;
},
set currentPersona(newVal) {
try {
this._prefs.set("current", JSON.stringify(newVal));
this._cachePersonaImages(newVal);
}
catch(ex) { Cu.reportError("error setting current persona: " + ex) }
},
/**
* extensions.personas.category: the category from which to pick a random
* persona.
*/
get category() { return this._prefs.get("category") },
set category(newVal) { this._prefs.set("category", newVal) },
/**
* Returns a formatted URL from preferences.
*/
getURL: function(pref, replacements) {
let defaults = {
SRC: this.urlSource
};
let t = this;
return this._prefs.get(pref + ".url")
.replace(/%([A-Z_]+)%/g, function(m0, m1) {
if (replacements && m1 in replacements)
return encodeURIComponent(replacements[m1]);
if (m1 in defaults)
return encodeURIComponent(defaults[m1]);
let pref = m1.toLowerCase().replace(/_/g, "-");
return encodeURIComponent(t._prefs.get(pref));
});
},
/**
* extensions.personas.custom: the custom persona.
*/
get customPersona() {
let custom = this._prefs.get("custom");
if (custom) {
try { return JSON.parse(custom) }
catch(ex) { Cu.reportError("error getting custom persona: " + ex) }
}
return null;
},
set customPersona(newVal) {
try { this._prefs.set("custom", JSON.stringify(newVal)) }
catch(ex) { Cu.reportError("error setting custom persona: " + ex) }
},
/**
* Notifies the persona changes or uses the lightweight theme manager
* functionality for this purpose (if available)
* @param aPersona the persona to be set as current if the lightweight theme
* manager is available
*/
_notifyPersonaChanged: function(aPersona) {
this._log.debug("_notifyPersonaChanged:\n" + Log4Moz.getStackTrace());
if (LightweightThemeManager) {
if (aPersona && aPersona.custom && LightweightThemeManager.setLocalTheme)
LightweightThemeManager.setLocalTheme(aPersona);
else
LightweightThemeManager.currentTheme = aPersona;
}
else
Observers.notify("personas:persona:changed");
},
changeToDefaultPersona: function() {
this.selected = "default";
this._prefs.set("persona.lastChanged", new Date().getTime().toString());
this._notifyPersonaChanged(null);
},
changeToRandomPersona: function(category) {
this.category = category;
this.currentPersona = this._getRandomPersonaFromCategory(category);
this.selected = "random";
this._prefs.set("persona.lastChanged", new Date().getTime().toString());
this._notifyPersonaChanged(this.currentPersona);
},
changeToRandomFavoritePersona: function() {
if (this.favorites && this.favorites.length > 0) {
this.currentPersona = this._getRandomPersonaFromArray(this.favorites);
this.selected = "randomFavorite";
this._prefs.set("persona.lastChanged", new Date().getTime().toString());
this._notifyPersonaChanged(this.currentPersona);
}
},
changeToPersona: function(persona) {
// The id must be a string and not an integer in order for the
// LightweightThemeManager to accept the persona. Older versions used to
// set a zero to the id of custom personas; if so, it needs to be changed
// to a "1". See: https://bugzilla.mozilla.org/show_bug.cgi?id=554220
if (persona.custom && persona.id === 0)
persona.id = "1";
// Check whether the persona is in the favorites or the recent lists,
// in which case the change-notification should not be shown.
let recent = this.getRecentPersonas();
let favorites = this.favorites;
let inRecent =
(recent && recent.some(function(v) v.id == persona.id));
let inFavorites =
(favorites && favorites.some(function(v) v.id == persona.id));
this.currentPersona = persona;
this._addPersonaToRecent(persona);
this.selected = "current";
this._prefs.reset("persona.lastRefreshed");
this._prefs.set("persona.lastChanged", new Date().getTime().toString());
this._notifyPersonaChanged(this.currentPersona);
// Show the notification if the selected persona is not in the favorite or
// recent lists, is not a custom persona and its author or username is not null.
// In this case we make sure at least one of these two fields is not null
// to prevent bug 526788.
if (!inRecent && !inFavorites && !persona.custom && (persona.author || persona.username))
this._showPersonaChangeNotification();
},
getPersonaJSON: function(data) {
if (data.theme) {
if (data.learnmore && !data.theme.detailURL)
data.theme.detailURL = this.updateURLSource(data.learnmore);
let authorURL = data.authors && data.authors[0] && data.authors[0].link;
if (authorURL)
data.theme.authorURL = this.updateURLSource(authorURL);
return data.theme;
}
return data;
},
updateURLSource: function(url) {
return url.replace(/([?&])src=api($|&)/, "$1src=personas-plus$2");
},
/**
* Reverts the current persona to the previously selected persona, if
* available
*/
revertToPreviousPersona: function() {
let undonePersonaId = this.currentPersona.id;
let previousPersona = this._prefs.get("lastselected1");
if (previousPersona) {
this.currentPersona = JSON.parse(previousPersona);
this._revertRecent();
this.selected = "current";
if (LightweightThemeManager) {
// forget the lightweight theme too
LightweightThemeManager.forgetUsedTheme(undonePersonaId);
if (this.currentPersona && this.currentPersona.custom &&
LightweightThemeManager.setLocalTheme)
LightweightThemeManager.setLocalTheme(this.currentPersona);
else
LightweightThemeManager.currentTheme = this.currentPersona;
}
else
this.resetPersona();
}
},
/**
* Shows a notification displaying the currently selected persona and button
* to revert the changes.
*/
_showPersonaChangeNotification: function() {
// Obtain most recent window and its notification box
let wm =
Cc["@mozilla.org/appshell/window-mediator;1"].
getService(Ci.nsIWindowMediator);
let notificationBox;
switch (this.appInfo.ID) {
case this.FIREFOX_ID:
notificationBox = wm.getMostRecentWindow("navigator:browser").
getBrowser().getNotificationBox();
break;
case this.THUNDERBIRD_ID:
notificationBox = wm.getMostRecentWindow("mail:3pane").
document.getElementById("mail-notification-box");
break;
default:
throw "unknown application ID " + this.appInfo.ID;
}
// If there is another notification of the same kind already, remove it.
let oldNotification =
notificationBox.getNotificationWithValue("lwtheme-install-notification");
if (oldNotification)
notificationBox.removeNotification(oldNotification);
let message = this._strings.get("notification.personaWasSelected",
[this.currentPersona.name,
(this.currentPersona.author ?
this.currentPersona.author :
this.currentPersona.username)]);
let revertButton = {
label : this._strings.get("notification.revertButton.label"),
accessKey : this._strings.get("notification.revertButton.accesskey"),
popup : null,
callback : function() { PersonaService.revertToPreviousPersona(); }
};
notificationBox.appendNotification(
message, "lwtheme-install-notification", null,
notificationBox.PRIORITY_INFO_MEDIUM, [ revertButton ] );
},
/**
* Looks for the given persona in the given array and returns its index.
* @param aPersona The persona to be found.
* @param aPersonaArray The array in which to look for the persona.
* @return The index of the persona in the array; -1 if not found.
*/
_findPersonaInArray: function(aPersona, aPersonaArray) {
for (let i = 0; i < aPersonaArray.length; i++) {
if (aPersonaArray[i].id == aPersona.id)
return i;
}
return -1;
},
_getRandomPersonaFromArray: function(aPersonaArray) {
// Get a random item from the list, trying up to five times to get one
// that is different from the currently-selected item in the category
// (if any). We use Math.floor instead of Math.round to pick a random
// number because the JS reference says Math.round returns a non-uniform
// distribution
// <http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Math:random#Examples>.
if (aPersonaArray && aPersonaArray.length > 0) {
let randomIndex, randomItem;
for (let i = 0; i < 5; i++) {
randomIndex = Math.floor(Math.random() * aPersonaArray.length);
randomItem = aPersonaArray[randomIndex];
if (!this.currentPersona || randomItem.id != this.currentPersona.id)
break;
}
return this.getPersonaJSON(randomItem);
}
return this.currentPersona;
},
_getRandomPersonaFromCategory: function(aCategoryName) {
// If we have the list of categories, use it to pick a random persona
// from the selected category.
if (this.personas) {
let personas = null;
if (aCategoryName == "featured")
personas = this.personas.featured;
if (personas)
return this._getRandomPersonaFromArray(personas);
}
return this.currentPersona;
},
/**
* Obtains the list of recently selected personas, parsed from the
* "lastselected" preferences.
* @param aHowMany (Optional, default 4) How many personas to obtain.
* @return The list of recent personas.
*/
getRecentPersonas: function(aHowMany) {
if (!aHowMany)
aHowMany = 4;
// Parse the list from the preferences
let personas = [];
for (let i = 0; i < aHowMany; i++) {
if (this._prefs.has("lastselected" + i)) {
try {
personas.push(JSON.parse(this._prefs.get("lastselected" + i)));
}
catch(ex) {}
}
}
return personas;
},
_addPersonaToRecent: function(persona) {
let personas = this.getRecentPersonas();
// Remove personas with the same ID (i.e. don't allow the recent persona
// to appear twice on the list). Afterwards, we'll add the recent persona
// to the list in a way that makes it the most recent one.
if (persona.id)
personas = personas.filter(function(v) !v.id || v.id != persona.id);
// Make the new persona the most recent one.
personas.unshift(persona);
// Note: at this point, there might be five personas on the list, four
// that we parsed from preferences and the one we're now adding. But we
// only serialize the first four back to preferences, so the oldest one
// drops off the end of the list.
// We store five in case we need to revert changes in the list alter on,
// even though only four will be displayed.
for (let i = 0; i < 5; i++) {
if (i < personas.length)
this._prefs.set("lastselected" + i, JSON.stringify(personas[i]));
else
this._prefs.reset("lastselected" + i);
}
},
/**
* Removes the most recent persona from the recent list, and leaves the
* following four personas as the most recent.
*/
_revertRecent: function() {
// Create a new list of recent personas, removing the first one, but
// including the 5th (hidden) one.
let personas = this.getRecentPersonas(5);
personas.shift();
// Serialize the list of recent personas.
for (let i = 0; i < 5; i++) {
if (i < personas.length)
this._prefs.set("lastselected" + i, JSON.stringify(personas[i]));
else
this._prefs.reset("lastselected" + i);
}
},
onUseColorChanged: function() {
// Notify observers that the persona has changed so the change in whether
// or not to use the text or accent color will get applied. The persona
// hasn't really changed, but doing this has the desired effect without any
// known unwanted side effects.
Observers.notify("personas:persona:changed");
},
previewingPersona: null,
/**
* Display the given persona temporarily. Useful for showing users who are
* browsing the directory of personas what a given persona will look like
* when selected, f.e. on mouseover. Consumers who call this method should
* call resetPersona when the preview ends, f.e. on mouseout.
*/
previewPersona: function(persona) {
if (LightweightThemeManager)
LightweightThemeManager.previewTheme(persona);
else {
this.previewingPersona = persona;
Observers.notify("personas:persona:changed");
}
},
/**
* Stop previewing a persona.
*/
resetPersona: function() {
if (LightweightThemeManager)
LightweightThemeManager.resetPreview();
else {
this.previewingPersona = null;
Observers.notify("personas:persona:changed");
}
},
/**
* Gets the persona specified by the initial_persona cookie.
*/
_getPersonaFromCookie: function() {
let authorizedHosts = this._prefs.get("authorizedHosts").split(/[, ]+/);
let cookieManager =
Cc["@mozilla.org/cookiemanager;1"].getService(Ci.nsICookieManager);
let cookieEnu = cookieManager.enumerator;
let selectedCookie = null;
while (cookieEnu.hasMoreElements()) {
let cookie = cookieEnu.getNext().QueryInterface(Ci.nsICookie);
// XXX: Remove the initial dot from the host name, if any, before it is
// compared against the authorized hosts. This fixes the bug reported in
// bug 492392 that getpersonas.com and www.getpersonas.com cookies
// imported from IE have the cookie host .getpersonas.com, so they didn't
// match any of the authorized hosts.
let cookieHost = cookie.host.replace(/^\./, "");
if (cookie.name == COOKIE_INITIAL_PERSONA &&
authorizedHosts.some(function(v) v == cookieHost)) {
// There could be more than one "initial_persona" cookie. The cookie
// with latest expiration time is selected.
if (null == selectedCookie ||
cookie.expires > selectedCookie.expires) {
selectedCookie = cookie;
}
cookieManager.remove(cookie.host, cookie.name, cookie.path, false);
}
}
if (selectedCookie)
return JSON.parse(decodeURIComponent(selectedCookie.value));
return null;
},
//**************************************************************************//
// Lightweight Themes - Personas synchronization
_ltmSyncTimer : null,
/**
* Updates the add-on to reflect the changes from the Tools - Add-ons - Themes
* dialog. If a lightweight theme is set, it is also set as the add-on's current
* persona. If a regular theme is set, the current persona is set to "default".
*/
onLightweightThemeChanged: function() {
let currentTheme = LightweightThemeManager.currentTheme;
this._ltmSyncTimer.cancel();
if (currentTheme &&
(currentTheme.id != this.currentPersona.id || this.selected == "default"))
this.changeToPersona(currentTheme);
else if (!currentTheme && this.selected != "default") {
// XXX: In Firefox 4, a persona change using the LightweightThemeManager causes
// two "lightweight-theme-changed" notifications to be fired instead of one:
// the first one with a null theme, and the second one with the actual theme.
// This causes the extension to get confused, as the first null theme causes
// it go change the persona to the default one, losing the "random" setting,
// amongst other things. To circumvent this, notifications with a "null" theme
// are delayed just a bit to allow the second notification to cancel it. If there's
// no second notification, then the null theme is applied.
// See: https://bugzilla.mozilla.org/show_bug.cgi?id=631803
let t = this;
this._ltmSyncTimer.initWithCallback(
{ notify: function() { t.changeToDefaultPersona(); } },
100,
Ci.nsITimer.TYPE_ONE_SHOT);
}
},
//**************************************************************************//
// Random Rotation
_rotationTimer : null,
/**
* Checks the current value of the "selected" preference and sets the
* rotation timer accordingly.
*/
onSelectedModeChanged: function() {
this._rotationTimer.cancel();
let selectedMode = this.selected;
if (selectedMode == "random" || selectedMode == "randomFavorite") {
let interval = this._prefs.get("rotationInterval") * 1000;
let that = this;
this._rotationTimer.initWithCallback(
{ notify: function(aTimer) { that._rotatePersona(); } },
interval, Ci.nsITimer.TYPE_REPEATING_SLACK);
this._rotatePersona();
}
},
/**
* Ensures that cookies are enabled for our current add-ons host, and
* prompts the user to enable them if not.
*/
checkCookiesEnabled: function() {
const PERM = "cookie";
const ALLOW = 1, SESSION_ONLY = 8;
try {
let prefs = new Preferences("network.cookie.");
let cookiesEnabled = (prefs.get("alwaysAcceptSessionCookies") ||
prefs.get("cookieBehavior") != 2);
let uri = Services.io.newURI(this.getURL("favorites-feed"), null, null);
let _ = this._strings.get.bind(this._strings);
if (cookiesEnabled
|| ~[ALLOW, SESSION_ONLY].indexOf(Services.perms.testPermission(uri, PERM))) {
this._prefs.reset("naggedAboutCookies");
} else {
if (this._prefs.get("naggedAboutCookies") == this.addonsHost)
return;
let stopNagging = { value: true };
let enableCookies = Services.prompt.confirmCheck(
null, _("cookies.confirm.title"),
_("cookies.confirm.message", [this.addonsHost]),
_("cookies.confirm.checkbox"),
stopNagging);
if (enableCookies) {
Services.perms.remove(uri.host, PERM);
Services.perms.add(uri, PERM, ALLOW);
}
else if (stopNagging.value) {
this._prefs.set("naggedAboutCookies", this.addonsHost);
}
}
}
catch (e) {
Cu.reportError(e);
}
},
/**
* Handles the addons-host preference being changed.
*/
onAddonsHostChanged: function() {
this.addonsHost = this._prefs.get("addons-host");
this.checkCookiesEnabled()
this.refreshFavorites();
},
/**
* Changes the current persona to a random persona of the same category (while
* in "random" mode) or a random persona from he favorite list (while in
* "randomFavorite" mode).
*/
_rotatePersona: function() {
switch (this.selected) {
case "random":
this.changeToRandomPersona(this.category);
break;
case "randomFavorite":
this.changeToRandomFavoritePersona();
break;
}
},
//**************************************************************************//
// Persona Images Caching
/**
* Caches the header and footer images of the given persona inside the
* directory [profile]/personas/cache/[persona.id]. It removes all other
* existing persona directories before doing so.
* @param aPersona The persona for which to cache the images.
*/
_cachePersonaImages: function(aPersona) {
let cacheDirectory =
FileUtils.getDirectory(FileUtils.getPersonasDirectory(), "cache");
// Remove all other subdirectories in the cache directory
// XXX: In the future, if we want to keep more than one persona cached
// this step would be removed.
let subdirs = FileUtils.getDirectoryEntries(cacheDirectory);
for (let i = 0; i < subdirs.length; i++) {
if (subdirs[i].isDirectory())
subdirs[i].remove(true);
}
// Create directory for the given persona
let personaDir = FileUtils.getDirectory(cacheDirectory, aPersona.id);
// Save header if specified.
let header = aPersona.headerURL || aPersona.header;
if (header) {
// The header can be a base64 string or a malformed URL, in which case
// the error can be safely ignored.
try {
let headerURI = URI.get(header, null, null)
.QueryInterface(Ci.nsIURL);
let headerCallback = function(aEvent) {
let request = aEvent.target;
// Save only if the folder still exists (Could have been deleted already)
if (request.status == 200 && personaDir.exists()) {
FileUtils.writeBinaryFile(
personaDir.clone(),
"header." + headerURI.fileExtension,
Uint8Array(request.response));
}
};
this._makeRequest(headerURI.spec, headerCallback, null, true, true,
{ responseType: "arraybuffer" });
}
catch (e) {}
}
// Save footer if specified.
let footer = aPersona.footerURL || aPersona.footer;
if (footer) {
// The footer can be a base64 string or a malformed URL, in which case
// the error can be safely ignored.
try {
let footerURI = URI.get(footer, null, null)
.QueryInterface(Ci.nsIURL);
let footerCallback = function(aEvent) {
let request = aEvent.target;
// Save only if the folder still exists (Could have been deleted already)
if (request.status == 200 && personaDir.exists()) {
FileUtils.writeBinaryFile(
personaDir.clone(),
"footer." + footerURI.fileExtension,
Uint8Array(request.response));
}
};
this._makeRequest(footerURI.spec, footerCallback, null, true, true,
{ responseType: "arraybuffer" });
}
catch (e) {}
}
},
/**
* Obtains the cached images of the given persona. This are stored in the
* _cachePersonaImages method under the directory
* [profile]/personas/cache/[persona.id].
* @param aPersona The persona for which to look the cached images.
* @return An object with "header" and "footer" properties, each containing
* the file URL of the image. Null otherwise.
*/
getCachedPersonaImages: function(aPersona) {
let cacheDirectory =
FileUtils.getDirectory(FileUtils.getPersonasDirectory(), "cache");
let personaDir = FileUtils.getDirectory(cacheDirectory, aPersona.id, true);
if (personaDir.exists()) {
let headerFile = personaDir.clone();
let footerFile = personaDir.clone();
let headerFileExtension =
URI.get(aPersona.headerURL || aPersona.header, null, null)
.QueryInterface(Ci.nsIURL).fileExtension;
let footerFileExtension =
URI.get(aPersona.footerURL || aPersona.footer, null, null)
.QueryInterface(Ci.nsIURL).fileExtension;
headerFile.append("header" + "." + headerFileExtension);
footerFile.append("footer" + "." + footerFileExtension);
if (headerFile.exists() && footerFile.exists()) {
let ios =
Cc["@mozilla.org/network/io-service;1"].getService(Ci.nsIIOService);
let headerURI = ios.newFileURI(headerFile);
let footerURI = ios.newFileURI(footerFile);
return {
header: headerURI.spec,
footer: footerURI.spec
};
}
}
return null;
},
/**
* Monitors changes in cookies. If the modified cookie is the Personas session
* cookie, then the favorites are refreshed (if the user is signed in).
* @param aCookie The cookie that has been added, changed or removed.
*/
onCookieChanged: function(aCookie, aChange) {
if (aCookie instanceof Ci.nsICookie) {
if (aCookie.name == "sessionid" && (aCookie.host == this.addonsHost ||
aCookie.host == "." + this.addonsHost)) {
if (aCookie.value == this._cookieValue)
return;
this._cookieValue = aCookie.value;
this.refreshFavorites();
}
}
else if (aCookie instanceof Ci.nsIArray) {
for (let enum_ = aCookie.enumerate(); enum_.hasMoreElements();)
this.onCookieChanged(enum_.getNext());
}
},
_cookieValue: null,
/**
* Monitors HTTP responses so that we can heuristically detect logins
* and logouts.
* @param aRequest The HTTP request
*/
onHTTPResponse: function(aRequest) {
aRequest.QueryInterface(Ci.nsIHttpChannel);
let uri = aRequest.URI.QueryInterface(Ci.nsIURL);
if (uri.host != this.addonsHost)
return;
if (endsWith(uri.filePath, "/users/logout")
|| aRequest.requestMethod == "POST" && endsWith(uri.filePath, "/users/login"))
this.refreshFavorites();
},
onQuitApplication: function() {
Observers.remove("quit-application", this.onQuitApplication, this);
this._destroy();
}
};
let DateUtils = {
/**
* Returns the number as a string with a 0 prepended to it if it contains
* only one digit, for formats like ISO 8601 that require two digit month,
* day, hour, minute, and second values (f.e. so midnight on January 1, 2009
* becomes 2009:01:01T00:00:00Z instead of 2009:1:1T0:0:0Z, which would be
* invalid).
*/
_pad: function(number) {
return (number >= 0 && number <= 9) ? "0" + number : "" + number;
},
/**
* Format a date per ISO 8601, in particular the subset described in
* http://www.w3.org/TR/NOTE-datetime, which is recommended for date
* interchange on the internet.
*
* Example: 1994-11-06T08:49:37Z
*
* @param date {Date} the date to format
* @returns {String} the date formatted per ISO 8601
*/
toISO8601: function(date) {
let year = date.getUTCFullYear();
let month = this._pad(date.getUTCMonth() + 1);
let day = this._pad(date.getUTCDate());
let hours = this._pad(date.getUTCHours());
let minutes = this._pad(date.getUTCMinutes());
let seconds = this._pad(date.getUTCSeconds());
return year + "-" + month + "-" + day + "T" +
hours + ":" + minutes + ":" + seconds + "Z";
},
/**
* Format a date per RFC 1123, which is the standard for HTTP headers.
*
* Example: Sun, 06 Nov 1994 08:49:37 GMT
*
* I'd love to use Datejs here, but its Date::toString formatting method
* doesn't convert dates to their UTC equivalents before formatting them,
* resulting in incorrect output (since RFC 1123 requires dates to be
* in UTC), so instead I roll my own.
*
* @param date {Date} the date to format
* @returns {String} the date formatted per RFC 1123
*/
toRFC1123: function(date) {
let dayOfWeek = ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"][date.getUTCDay()];
let day = this._pad(date.getUTCDate());
let month = ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"][date.getUTCMonth()];
let year = date.getUTCFullYear();
let hours = this._pad(date.getUTCHours());
let minutes = this._pad(date.getUTCMinutes());
let seconds = this._pad(date.getUTCSeconds());
return dayOfWeek + ", " + day + " " + month + " " + year + " " +
hours + ":" + minutes + ":" + seconds + " GMT";
}
};
let FileUtils = {
/**
* Gets the [profile]/personas directory.
* @return The reference to the personas directory (nsIFile).
*/
getPersonasDirectory: function() {
let directoryService =
Cc["@mozilla.org/file/directory_service;1"].getService(Ci.nsIProperties);
let dir = directoryService.get("ProfD", Ci.nsIFile);
return this.getDirectory(dir, "personas");
},
/**
* Gets a reference to a directory (nsIFile) specified by the given name,
* located inside the given parent directory.
* @param aParentDirectory The parent directory of the directory to obtain.
* @param aDirectoryName The name of the directory to obtain.
* @param aDontCreate (Optional) Whether or not to create the directory if it
* does not exist.
* @return The reference to the directory (nsIFile).
*/
getDirectory: function(aParentDirectory, aDirectoryName, aDontCreate) {
let dir = aParentDirectory.clone();
try {
dir.append(aDirectoryName);
if (!dir.exists() || !dir.isDirectory()) {
if (!aDontCreate) {
// read and write permissions to owner and group, read-only for others.
dir.create(Ci.nsIFile.DIRECTORY_TYPE, 0774);
}
}
}
catch (ex) {
Cu.reportError("Could not create '" + aDirectoryName + "' directory");
dir = null;
}
return dir;
},
/**
* Gets an array of the entries (nsIFile) found in the given directory.
* @param aDirectory The directory from which to obtain the entries.
* @return The array of entries.
*/
getDirectoryEntries: function(aDirectory) {
let entries = [];
try {
let enu = aDirectory.directoryEntries;
while (enu.hasMoreElements()) {
let entry = enu.getNext().QueryInterface(Ci.nsIFile);
entries.push(entry);
}
}
catch (ex) {
Cu.reportError("Could not read entries of directory");
}
return entries;
},
/**
* Reads the contents of a text file located at the given directory.
* @param aDirectory The directory in which the file is read from (nsIFile)
* @param aFileName The name of the file to be read.
* @return The contents of the file (string), if any.
*/
readFile: function(aDirectory, aFileName) {
let data = "";
try {
let file = aDirectory.clone();
file.append(aFileName);
if (file.exists()) {
let fstream =
Cc["@mozilla.org/network/file-input-stream;1"].
createInstance(Ci.nsIFileInputStream);
fstream.init(file, -1, 0, 0);
let cstream =
Cc["@mozilla.org/intl/converter-input-stream;1"].
createInstance(Ci.nsIConverterInputStream);
cstream.init(fstream, "UTF-8", 0, 0);
let (str = {}) {
// read the whole file
while (cstream.readString(-1, str))
data += str.value;
}
cstream.close(); // this also closes fstream
}
}
catch (ex) {
Cu.reportError("Could not read file " + aFileName);
}
return data;
},
/**
* Writes a text file in the given directory. If the file already exists it is
* overwritten.
* @param aDirectory The directory in which the file will be written (nsIFile).
* @param aFileName The name of the file to be written.
* @param aData The contents of the file.
*/
writeFile: function(aDirectory, aFileName, aData) {
try {
let file = aDirectory.clone();
file.append(aFileName);
return OS.File.writeAtomic(file.path, aData,
{ tmpPath: file.path + ".tmp" });
}
catch (ex) {
Cu.reportError("Could not write file " + aFileName);
}
},
/**
* Writes a binary file in the given directory. If the file already exists it
* is overwritten.
* @param aDirectory The directory in which the file will be written (nsIFile).
* @param aFileName The name of the file to be written.
* @param aData The binary contents of the file.
*/
writeBinaryFile: function(aDirectory, aFileName, aData) {
try {
let file = aDirectory.clone();
file.append(aFileName);
OS.File.writeAtomic(file.path, aData,
{ tmpPath: file.path + ".tmp" });
}
catch (ex) {
Cu.reportError("Could not write binary file " + aFileName);
}
}
};
try {
PersonaService._init();
}
catch (e) {
Cu.reportError(e);
}
|