watchFolderPrefs.js

Go to the documentation of this file.

/* -*- Mode: Java; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set sw=2 :miv */
/*
//
// BEGIN SONGBIRD GPL
//
// This file is part of the Songbird web player.
//
// Copyright(c) 2005-2009 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
//
 */

//------------------------------------------------------------------------------
//
// Watch folder preferences imported services.
//
//------------------------------------------------------------------------------

// Songbird imports.
Components.utils.import("resource://app/jsmodules/ArrayConverter.jsm");
Components.utils.import("resource://app/jsmodules/SBJobUtils.jsm");
Components.utils.import("resource://app/jsmodules/StringUtils.jsm");

//------------------------------------------------------------------------------
//
// Watch folder preferences services defs.
//
//------------------------------------------------------------------------------

// Component manager defs.
if (typeof(Cc) == "undefined")
  var Cc = Components.classes;
if (typeof(Ci) == "undefined")
  var Ci = Components.interfaces;
if (typeof(Cr) == "undefined")
  var Cr = Components.results;
if (typeof(Cu) == "undefined")
  var Cu = Components.utils;


//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
//
// Watch folder preference pane services.
//
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

var watchFolderPrefsPane = {

  // set to true when the folder path has changed
  // will also be set if watch folders was toggled disabled -> enabled
  folderPathChanged: false,

  // Used to determine if this script should assign the pref manually
  shouldSetWFPathPref: false,

  //----------------------------------------------------------------------------
  //
  // Event handling services.
  //
  //----------------------------------------------------------------------------

  doPaneLoad: function watchFolderPrefsPane_doPaneLoad() {
    // Instant-apply prefs (mac and linux) will notify the pref and update the
    // watch folder component before this dialog can warn the user. If the
    // current platform is not windows, disable instant-apply and handle the
    // pref assignment in this script.
    // See bug 15570.
    try {
      var sysInfo = Cc["@mozilla.org/system-info;1"]
                      .getService(Ci.nsIPropertyBag2);
      if (sysInfo.getProperty("name") != "Windows_NT") {
        this.shouldSetWFPathPref = true;
      }
    }
    catch (e) {
    }

    if (this.shouldSetWFPathPref) {
      // Remove the preferences attribute.
      document.getElementById("watch_folder_path_textbox")
              .removeAttribute("preference");
    }

    // Update the UI.
    this._updateUIState();

    var self = this;
    function forceCheck(event) {
      if (event.type == "dialogcancel" &&
          !Application.prefs.getValue("browser.preferences.instantApply", true))
      {
        return;
      }
      if (!self._checkForValidPref(false)) {
        event.preventDefault();
        event.stopPropagation();
        return false;
      }

      var watchFolderEnablePrefElem =
            document.getElementById("watch_folder_enable_pref");
      var watchFolderPathPrefElem =
            document.getElementById("watch_folder_path_pref");
      var watchFolderEnableCheckboxElem =
            document.getElementById("watch_folder_enable_checkbox");
      var watchFolderPathTextboxElem =
            document.getElementById("watch_folder_path_textbox");

      // explicitly saving these prefs because they're not inside a prefpane
      watchFolderEnablePrefElem.valueFromPreferences = watchFolderEnableCheckboxElem.checked;
      watchFolderPathPrefElem.valueFromPreferences = watchFolderPathTextboxElem.value;

      var watchFolderEnableCheckbox =
            document.getElementById("watch_folder_enable_checkbox");
      var shouldPrompt = self.folderPathChanged;

      // should never prompt for watch folder rescan if it's not enabled
      shouldPrompt &= watchFolderEnableCheckbox.checked;

      if (shouldPrompt) {
        // offer to rescan with the _new_ watch dir, taking into account that
        // instantApply may be off
        var watchFolderDir = Cc["@mozilla.org/file/local;1"]
                               .createInstance(Ci.nsILocalFile);
        var watchFolderPath =
          watchFolderPathPrefElem.getElementValue(watchFolderPathTextboxElem);
        watchFolderDir.initWithPath(watchFolderPath);
        self._rescan(watchFolderDir);
      }
    }
    window.addEventListener('dialogaccept', forceCheck, true);
    window.addEventListener('dialogcancel', forceCheck, true);
  },


  doImportOptionsChange:
    function watchFolderPrefsPane_doImportOptionsChange(aEvent) {
    // Update the UI.
    this._checkForValidPref(true);
  },


  doBrowseCommand: function watchFolderPrefsPane_doBrowseCommand(aEvent) {
    // Get the currently selected watch folder directory.
    var watchFolderPathPrefElem =
          document.getElementById("watch_folder_path_pref");
    var watchFolderPathTextboxElem =
          document.getElementById("watch_folder_path_textbox");
    var watchFolderDir = Cc["@mozilla.org/file/local;1"]
                           .createInstance(Ci.nsILocalFile);
    try {
      watchFolderDir.initWithPath(watchFolderPathPrefElem.value);
      if (!watchFolderDir.exists() ||
          !watchFolderDir.isDirectory() ||
          watchFolderDir.isSymlink()) {
        watchFolderDir = null;
      }
    } catch (ex) {
      watchFolderDir = null;
    }

    // Set up a file picker for browsing.
    var filePicker = Cc["@mozilla.org/filepicker;1"]
                       .createInstance(Ci.nsIFilePicker);
    var filePickerMsg = SBString("watch_folder.file_picker_msg");
    filePicker.init(window, filePickerMsg, Ci.nsIFilePicker.modeGetFolder);

    // Set the file picker initial directory.
    if (watchFolderDir)
      filePicker.displayDirectory = watchFolderDir;

    // Show the file picker.
    var result = filePicker.show();

    // Update the watch folder path.
    if ((result == Ci.nsIFilePicker.returnOK) &&
        (filePicker.file.isDirectory())) {
      // Update the text box - the preference will be set in
      // _checkForValidPref() if it is valid
      watchFolderPathTextboxElem.value = filePicker.file.path;
      this.onPathChanged(aEvent);
    }

    this._checkForValidPref();
  },
  
  onPathChanged: function watchFolderPrefsPane_onPathChanged(aEvent) {
    this.folderPathChanged = true;
    this._updateUIState();
    return true;
  },


  //----------------------------------------------------------------------------
  //
  // Internal services.
  //
  //----------------------------------------------------------------------------
  
  _updateUIState: function()
  {
    this._checkManageMedia();
    var checkbox = document.getElementById("watch_folder_enable_checkbox");
    var enabled = checkbox.checked;
    var broadcaster = document.getElementById("watch_folder_disabled_broadcaster");

    if (enabled) {
      broadcaster.removeAttribute("disabled");
    } else {
      broadcaster.setAttribute("disabled", "true");
    }

    this._checkForValidPref();
  },
  
  _checkManageMedia: function()
  {
    var manageMediaValue = Application.prefs.getValue("songbird.media_management.library.enabled", false);
    var watchFolderEnableWarning = document.getElementById("watch_folder_enable_warning");
    if (!manageMediaValue) {
      watchFolderEnableWarning.setAttribute("hidden", "true");
    }
  },

  _removeErrorNotifications: function()
  {
    var oldNotif, notifBox = document.getElementById("watch_folder_notification_box");

    while ((oldNotif = notifBox.getNotificationWithValue("watch_folder_error"))) {
      notifBox.removeNotification(oldNotif);
    }
  },

  _showErrorNotification: function(aMsg)
  {
    var notifBox = document.getElementById("watch_folder_notification_box");

    // focus this pref pane and this tab
    var pane = document.getElementById("paneImportMedia");
    document.documentElement.showPane(pane);
    document.getElementById("import_media_tabs").selectedItem = document.getElementById("watch_folder_tab");
      
    // show the notification, hiding any other ones of this class
    this._removeErrorNotifications();
    notifBox.appendNotification(aMsg, "watch_folder_error", null,
                                notifBox.PRIORITY_CRITICAL_LOW, []);
  },

  _checkForValidPref: function watchFolderPrefsPane__checkForValidPref(aSilent)
  {
    this._removeErrorNotifications();

    var self = this;
    function showErrorNotification(aMsg)
    {
      if (!aSilent) {
        self._showErrorNotification(aMsg);
      }
    }

    // Set the watch folder hidden if the watch folder services are not
    // available.
    var watchFolderSupported = ("@songbirdnest.com/watch-folder-service;1" in Cc);
    if (watchFolderSupported) {
      watchFolderSupported = Cc["@songbirdnest.com/watch-folder-service;1"]
                               .getService(Ci.sbIWatchFolderService)
                               .isSupported;
    }
    var watchFolderHiddenElem =
          document.getElementById("watch_folder_hidden_broadcaster");
    if (watchFolderSupported) {
        watchFolderHiddenElem.removeAttribute("hidden");
    } else {
        watchFolderHiddenElem.setAttribute("hidden", "true");
    }

    var checkbox = document.getElementById("watch_folder_enable_checkbox");
    var enabled = checkbox.checked;

    if (!enabled) {
      // if it's not enabled, we allow whatever.
      return true;
    }

    var watchFolderPathPrefElem =
          document.getElementById("watch_folder_path_pref");
    var watchFolderPathTextboxElem =
          document.getElementById("watch_folder_path_textbox");

    // only continue checking the folder path validity if the path changed
    if (!this.folderPathChanged)
      return true;

    var path = watchFolderPathPrefElem.getElementValue(watchFolderPathTextboxElem);
    if (!path) {
      // there is no pref set, but watch folder is enabled. Complain.
      showErrorNotification(SBString("prefs.watch_folder.error.no_path"));
      return false;
    }
    
    var dir = null;
    try {
      dir = Cc["@mozilla.org/file/local;1"].createInstance(Ci.nsILocalFile);
      dir.initWithPath(path);
      if (!dir.exists()) {
        showErrorNotification(SBFormattedString("prefs.watch_folder.error.not_exist", [dir.path]));
        return false;
      }
      if (!dir.isDirectory()) {
        showErrorNotification(SBFormattedString("prefs.watch_folder.error.not_directory", [dir.path]));
        return false;
      }
      if (!dir.isReadable()) {
        showErrorNotification(SBFormattedString("prefs.watch_folder.error.not_readable", [dir.path]));
        return false;
      }
    } catch (e) {
      // failed to create the dir (e.g. invalid path?)
      Components.utils.reportError(e);
      showErrorNotification(SBFormattedString("prefs.watch_folder.error.generic", [path]));
      return false;
    }

    // The path seems legit, if this script is supposed to set the WF path pref
    // do that now.
    if (this.shouldSetWFPathPref) {
      document.getElementById("watch_folder_path_pref")
              .valueFromPreferences = path;
    }

    return true;
  },
  
  _rescan: function watchFolderPrefsPane__rescan(aFile) {
    var shouldImportTitle = 
      SBString("watch_folder.new_folder.scan_title");
    var shouldImportMsg = 
      SBFormattedString("watch_folder.new_folder.scan_text", [aFile.path]);
    
    var promptService = Cc['@mozilla.org/embedcomp/prompt-service;1']
                          .getService(Ci.nsIPromptService);
    var promptButtons = 
      promptService.STD_YES_NO_BUTTONS + promptService.BUTTON_POS_1_DEFAULT;
                            
    var checkState = {};       
    var result = promptService.confirmEx(window, 
                                         shouldImportTitle, 
                                         shouldImportMsg, 
                                         promptButtons, 
                                         null, 
                                         null, 
                                         null, 
                                         null, 
                                         checkState);
    if(result == 0) {
      var importer = Cc['@songbirdnest.com/Songbird/DirectoryImportService;1']
                       .getService(Ci.sbIDirectoryImportService);
      var directoryArray = ArrayConverter.nsIArray([aFile]);
      
      var job = importer.import(directoryArray);
      SBJobUtils.showProgressDialog(job, window, 0);
    }
  }
};