switchLocale.js

Go to the documentation of this file.

/*
//
// BEGIN SONGBIRD GPL
// 
// This file is part of the Songbird web player.
//
// Copyright(c) 2005-2008 POTI, Inc.
// http://songbirdnest.com
// 
// This file may be licensed under the terms of of the
// GNU General Public License Version 2 (the "GPL").
// 
// Software distributed under the License is distributed 
// on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either 
// express or implied. See the GPL for the specific language 
// governing rights and limitations.
//
// You should have received a copy of the GPL along with this 
// program. If not, go to http://www.gnu.org/licenses/gpl.html
// or write to the Free Software Foundation, Inc., 
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
// 
// END SONGBIRD GPL
//
 */

Components.utils.import("resource://app/jsmodules/StringUtils.jsm");

const MENUBAR_LOCALESBUNDLE_TIMEOUT = 15000;

try {
  // Module specific global for auto-init/deinit support
  var menubar_locales_bundle_module = {};
  var menubar_locales_bundle = null;

  menubar_locales_bundle_module.init_once = 0;
  menubar_locales_bundle_module.deinit_once = 0;
  menubar_locales_bundle_module.onLoad = function()
  {
    if (menubar_locales_bundle_module.init_once++) { dump("WARNING: menubar_locales_bundle double init!!\n"); return; }
    initLocalesBundle();
  }
  menubar_locales_bundle_module.onUnload = function()
  {
    if (menubar_locales_bundle_module.deinit_once++) { dump("WARNING: menubar_locales_bundle double deinit!!\n"); return; }
    window.removeEventListener("load", menubar_locales_bundle_module.onLoad, false);
    window.removeEventListener("unload", menubar_locales_bundle_module.onUnload, false);
    resetLocalesBundle();
  }

  // Auto-init/deinit registration
  window.addEventListener("load", menubar_locales_bundle_module.onLoad, false);
  window.addEventListener("unload", menubar_locales_bundle_module.onUnload, false);

 
  var menubar_locales_installed = null;

  function initLocalesBundle() {
    try {
      var sbIBundle = new Components.Constructor("@songbirdnest.com/Songbird/Bundle;1", "sbIBundle");
      menubar_locales_bundle = new sbIBundle();
      menubar_locales_bundle.bundleId = "locales";
      menubar_locales_bundle.bundleURL = Application.prefs.getValue("songbird.url.locales", "default");
      menubar_locales_bundle.addBundleDataListener(menubarLocalesBundleCB);
      menubar_locales_bundle.retrieveBundleData(MENUBAR_LOCALESBUNDLE_TIMEOUT);
    } catch ( err ) {
      SB_LOG("initLocalesBundle", "" + err );
    }
  }

  function resetLocalesBundle() {
    if (menubar_locales_bundle) menubar_locales_bundle.removeBundleDataListener(menubarLocalesBundleCB);
    menubar_locales_bundle = null;
  }

  var menubarLocalesBundleCB = 
  {
    onDownloadComplete: function(bundle) { menubarLocalesBundleDataReady(); },
    onError: function(bundle) { menubarLocalesBundleDataReady(); },
    QueryInterface : function(aIID)
    {
      if (!aIID.equals(Components.interfaces.sbIBundleDataListener) &&
          !aIID.equals(Components.interfaces.nsISupports)) 
      {
        throw Components.results.NS_ERROR_NO_INTERFACE;
      }
      return this;
    }
  }

  function menubarLocalesBundleDataReady() {
    if (menubar_locales_bundle.bundleExtensionCount > 0) {
      if (_lastmenu) fillLocaleList(_lastmenu);
    }
  }

  function menubarLoadBundledLocales(menu) {

    if (menubar_locales_bundle && menubar_locales_bundle.bundleExtensionCount > 0) {
      
      var className = menu.parentNode.getAttribute("class");

      var separator = null;
      
      var sbs = Components.classes["@mozilla.org/intl/stringbundle;1"]
                          .getService(Components.interfaces.nsIStringBundleService);
      var langNames = sbs.createBundle("chrome://global/locale/languageNames.properties");
      var regNames  = sbs.createBundle("chrome://global/locale/regionNames.properties");

      var elements = Array();
      
      for (var i=0; i < menubar_locales_bundle.bundleExtensionCount; i++) {
        menubar_locales_bundle.setExtensionInstallFlag(i, false);

        var locale = menubar_locales_bundle.getExtensionAttribute(i, "languageTag");
        if (!locale) {
          // Umm, bad server response?
          var localeID = menubar_locales_bundle.getExtensionAttribute(i, "id");
          var localeMatch = /langpack-([^@]+)/(localeID);
          if (localeMatch) {
            locale = localeMatch[1];
          } else {
            // really bad server response; ignore this locale
            continue;
          }
        }
        
        if (menubar_locales_installed.indexOf(locale) != -1) {
          continue;
        }

        var displayName = menubar_locales_bundle.getExtensionAttribute(i, "name");
        if (!displayName) {
          var parts = locale.split(/-/);
  
          if (parts.length > 1) {
            displayName = SBFormattedString("locales.name.format.regional",
                                            [SBString(parts[0], parts[0], langNames),
                                             SBString(parts[1].toLowerCase(), parts[1], regNames)]);
          } else {
            displayName = SBFormattedString("locales.name.format",
                                            [SBString(parts[0], parts[0], langNames)]);
          }
        }

        if (!separator) {
          separator = document.createElement("menuseparator");
          separator.setAttribute("class", className);
          menu.appendChild(separator);
        }

        var item = document.createElement("menuitem");
        item.setAttribute("label", displayName);
        item.setAttribute("name", "locale.switch");
        item.setAttribute("type", "radio");
        item.setAttribute("class", className); 
        item.setAttribute("oncommand", "installLocaleFromBundle(\"" + locale + "\", " + i + ")");

        elements.push(item);
      }
      elements.sort(sortLanguages);
      for (var i =0;i<elements.length;i++) menu.appendChild(elements[i]);
    }
  }


  function switchLocale(locale, wantmessagebox) {
    try 
    {
      var prefs = Components.classes["@mozilla.org/preferences-service;1"].getService(Components.interfaces.nsIPrefBranch);
      var curLocale = "en-US";
      try {
        curLocale = prefs.getCharPref("general.useragent.locale");
      }
      catch (e) { }

      if (locale != curLocale) {
        prefs.setCharPref("general.useragent.locale", locale);
        if (wantmessagebox) {
          sbRestartBox_strings("message.localization", "message.needrestart", "Localization", "This setting will take effect after you restart Songbird");
        }
      }
    }
    catch ( err )
    {
      SB_LOG( "switchLocale - " + err);
    }
  }

  var _lastmenu = null;

  function fillLocaleList(menu) {
    try 
    {
      menubar_locales_installed = Array();
      _lastmenu = menu;
      var prefs = Components.classes["@mozilla.org/preferences-service;1"]
                            .getService(Components.interfaces.nsIPrefBranch);
      var curLocale = "en-US";
      try {
        curLocale = prefs.getCharPref("general.useragent.locale");
      }
      catch (e) { }

      var cr = Components.classes["@mozilla.org/chrome/chrome-registry;1"]
                         .getService(Components.interfaces.nsIToolkitChromeRegistry);

      var sbs = Components.classes["@mozilla.org/intl/stringbundle;1"]
                          .getService(Components.interfaces.nsIStringBundleService);
      var langNames = sbs.createBundle("chrome://global/locale/languageNames.properties");
      var regNames  = sbs.createBundle("chrome://global/locale/regionNames.properties");

      /* clear the existing children */
      var children = menu.childNodes;
      for (var i = children.length; i > 0; --i) {
        menu.removeChild(children[i - 1]);
      }

      var locales = cr.getLocalesForPackage("songbird");
      var elements = Array();
      
      while (locales.hasMore()) {
        var locale = locales.getNext();
        menubar_locales_installed.push(locale);

        var parts = locale.split(/-/);

        var displayName;
        try {
          displayName = langNames.GetStringFromName(parts[0]);
          if (parts.length > 1) {
            try {
              displayName += " (" + regNames.GetStringFromName(parts[1].toLowerCase()) + ")";
            }
            catch (e) {
              displayName += " (" + parts[1] + ")";
            }
          }
        }
        catch (e) {
          displayName = locale;
        }

        var item = document.createElement("menuitem");
        var className = menu.parentNode.getAttribute("class");

        item.setAttribute("label", displayName);
        item.setAttribute("name", "locale.switch");
        item.setAttribute("type", "radio");

        var itemclass = className;
        var flag = getFlagFromBundle(locale);
        if (flag && flag != "") {
          itemclass = itemclass + " menuitem-iconic";
          item.setAttribute("image", flag);
        }
        item.setAttribute("class", itemclass);
 
        if (curLocale == locale) {
          item.setAttribute("checked", "true");
        }
        item.setAttribute("oncommand", "switchLocale(\"" + locale + "\", true)");
        
        elements.push(item);
      }
      
      elements.sort(sortLanguages);
      for (var i =0;i<elements.length;i++) menu.appendChild(elements[i]);
      if (menubar_locales_bundle && menubar_locales_bundle.bundleDataStatus == Components.interfaces.sbIBundle.BUNDLE_DATA_STATUS_SUCCESS) menubarLoadBundledLocales(menu);
    }
    catch ( err )
    {
      SB_LOG( "fillLocaleList - " + err);
    }
  }
  
  function getFlagFromBundle(locale) {
    for (var i=0; i < menubar_locales_bundle.bundleExtensionCount; i++) {
      var name = menubar_locales_bundle.getExtensionAttribute(i, "name");
      name = name.split(" ")[0]; // FIX ! name should not have a trailing " (Country)"
      if (name == locale) return menubar_locales_bundle.getExtensionAttribute(i, "flag");
    }
    return null;
  } 

  function sortLanguages(a, b) 
  {
    var aname = a.getAttribute("label");
    var bname = b.getAttribute("label");
    if (aname == bname) return 0;
    if (aname < bname) return -1;
    return 1;
  }
  
  function installLocaleFromBundle(locale, bundleindex) {
    if (gPrompt.confirm( window, 
                        SBString( "locales.installconfirm.title", "Language Download" ),
                        SBString( "locales.installconfirm.msg", "This language is not installed, would you like to download and install it?" ) ) ) {
      if (bundleindex != -1 && menubar_locales_bundle && bundleindex < menubar_locales_bundle.bundleExtensionCount) {
        for (var i = 0; i < menubar_locales_bundle.bundleExtensionCount; i++) {
          menubar_locales_bundle.setExtensionInstallFlag(i, i == bundleindex);
        }
        var res = menubar_locales_bundle.installFlaggedExtensions(window);
        
        if (res == menubar_locales_bundle.BUNDLE_INSTALL_SUCCESS) {
          switchLocale(locale, true);
        } else {
          gPrompt.alert( window, 
                        SBString( "locales.installfailed.title", "Language Download" ),
                        SBString( "locales.installfailed.msg", "Language installation failed, check your network connectivity!" ) );
        }
      }
    }
  }

}
catch (err)
{
  dump("switch_locales.js - " + err);
}