1 /* ***** BEGIN LICENSE BLOCK *****
  2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  3  *
  4  * The contents of this file are subject to the Mozilla Public License Version
  5  * 1.1 (the "License"); you may not use this file except in compliance with
  6  * the License. You may obtain a copy of the License at
  7  * http://www.mozilla.org/MPL/
  8  *
  9  * Software distributed under the License is distributed on an "AS IS" basis,
 10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 11  * for the specific language governing rights and limitations under the
 12  * License.
 13  *
 14  * The Original Code is gContactSync.
 15  *
 16  * The Initial Developer of the Original Code is
 17  * Josh Geenen <gcontactsync@pirules.org>.
 18  * Portions created by the Initial Developer are Copyright (C) 2008-2010
 19  * the Initial Developer. All Rights Reserved.
 20  *
 21  * Contributor(s):
 22  *
 23  * Alternatively, the contents of this file may be used under the terms of
 24  * either the GNU General Public License Version 2 or later (the "GPL"), or
 25  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 26  * in which case the provisions of the GPL or the LGPL are applicable instead
 27  * of those above. If you wish to allow use of your version of this file only
 28  * under the terms of either the GPL or the LGPL, and not to allow others to
 29  * use your version of this file under the terms of the MPL, indicate your
 30  * decision by deleting the provisions above and replace them with the notice
 31  * and other provisions required by the GPL or the LGPL. If you do not delete
 32  * the provisions above, a recipient may use your version of this file under
 33  * the terms of any one of the MPL, the GPL or the LGPL.
 34  *
 35  * ***** END LICENSE BLOCK ***** */
 36 
 37 if (!com) var com = {}; // A generic wrapper variable
 38 // A wrapper for all GCS functions and variables
 39 if (!com.gContactSync) com.gContactSync = {};
 40 
 41 /**
 42  * Contains all of the string bundles included in gContactSync and provides
 43  * a method (getStr) to find a string by looking in every bundle.
 44  * NOTE:  This requires that string bundles have unique names for strings.
 45  * NOTE:  Must be initialized when the window is loaded.
 46  * @class
 47  */
 48 com.gContactSync.StringBundle = {
 49   /** Stores all string bundle elements */
 50   mBundles:     {},
 51   /** Stores whether this class has been initialized */
 52   mInitialized: false,
 53   /** Stores whether the user agent should be replaced in strings */
 54   mReplaceUserAgent: false,
 55   /** The user agent (Thunderbird, SeaMonkey, or Postbox). */
 56   mUserAgent:   "Thunderbird",
 57 
 58   /**
 59    * Initializes the string bundle.
 60    */
 61   init: function StringBundle_init() {
 62     if (com.gContactSync.StringBundle.mInitialized) {
 63       return true;
 64     }
 65 
 66     com.gContactSync.StringBundle.mBundles.mStrings =
 67       document.getElementById("gContactSyncStringBundle");
 68       
 69     if (!com.gContactSync.StringBundle.mBundles.mStrings) {
 70       var err = "Error - com.gContactSync.StringBundle could not be initialized\n";
 71       com.gContactSync.alertError(err);
 72       throw err;
 73     }
 74 
 75     // Check the user agent
 76     if (window.navigator.userAgent.indexOf("SeaMonkey") != -1) {
 77       com.gContactSync.StringBundle.mUserAgent        = "SeaMonkey";
 78       com.gContactSync.StringBundle.mReplaceUserAgent = true;
 79     } else if (window.navigator.userAgent.indexOf("Postbox") != -1) {
 80       com.gContactSync.StringBundle.mUserAgent        = "Postbox";
 81       com.gContactSync.StringBundle.mReplaceUserAgent = true;
 82     }
 83 
 84     com.gContactSync.StringBundle.mInitialized = true;
 85     return true;
 86   },
 87   /**
 88    * Searches every string bundle until a string is found with the given name.
 89    * If com.gContactSync.StringBundle.mReplaceUserAgent is set to true, this
 90    * will replace all instances of "Thunderbird" with the string in
 91    * com.gContactSync.StringBundle.mUserAgent.
 92    * @param aName {string} The name of the string to search for.
 93    * @returns {string} The translated string.
 94    */
 95   getStr: function StringBundle_getStr(aName) {
 96     var str = aName, i;
 97     
 98     // initialize the string bundle if it wasn't already done
 99     if (!com.gContactSync.StringBundle.mInitialized) {
100       com.gContactSync.StringBundle.init();
101     }
102 
103     for (i in com.gContactSync.StringBundle.mBundles) {
104       try {
105         str = com.gContactSync.StringBundle.mBundles[i].getString(aName);
106 
107         // If necessary, replace all instances of Thunderbird with the actual
108         // user agent.
109         if (com.gContactSync.StringBundle.mReplaceUserAgent) {
110           str = str.replace(/Thunderbird/g, com.gContactSync.StringBundle.mUserAgent);
111         }
112 
113         break;
114       } catch (e) {} // if the bundle doesn't exist or if the string
115                      // isn't in it skip to the next
116     }
117 
118     return str;
119   }
120 };
121