root/trunk/modules/mediator.jsm

/* ***** 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 DownThemAll Mediator module.
 *
 * The Initial Developer of the Original Code is Nils Maier
 * Portions created by the Initial Developer are Copyright (C) 2008
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Nils Maier <MaierMan@web.de>
 *
 * 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 ***** */

const EXPORTED_SYMBOLS = [
  'getMostRecent',
  'getMostRecentByUrl',
  'getAllByType',
  'openExternal',
  'openUrl',
  'showNotice',
];
  
const Cc = Components.classes;
const Ci = Components.interfaces;
const Cr = Components.results;
const Cu = Components.utils;
const Exception = Components.Exception;

const mediator =  Cc['@mozilla.org/appshell/window-mediator;1'].getService(Ci.nsIWindowMediator);
const ioservice = Cc['@mozilla.org/network/io-service;1'].getService(Ci.nsIIOService);
const protoservice = Cc['@mozilla.org/uriloader/external-protocol-service;1'].getService(Ci.nsIExternalProtocolService);
const logger = Cc['@downthemall.net/debug-service;1'].getService(Ci.dtaIDebugService);
const windowwatcher = Cc["@mozilla.org/embedcomp/window-watcher;1"].getService(Ci.nsIWindowWatcher);


function objToString(obj) {
  if (obj == null || obj == undefined) {
    return obj;
  }
  if (
    typeof obj == 'string'
    || obj instanceof String
  ) {
    return obj.toString();
  }
  if (
    obj instanceof Ci.nsIURL
    || obj instanceof Ci.nsIURI
  ) {
    return obj.spec;
  }
  if (obj.url) {
    return objToString(obj.url);
  }
  throw new Exception("Not a valid type");
}
function objToUri(obj) {
  if (obj == null || obj == undefined) {
    return null;
  }
  if (obj instanceof Ci.nsIURL || obj instanceof Ci.nsIURI) {
    return obj;
  }
  if (typeof obj == 'string' || obj instanceof String) {
    return ioservice.newURI(obj.toString(), null, null);
  }
  if (obj.url) {
    return objToUri(obj.url);
  } 
  throw new Exception("Not a valid type");
}

/**
 * Gets the most recent window
 * @param type Either a string or an array of string specifying the type of the window
 */
function getMostRecent(type) {
  if (type instanceof Array) {
    for each (t in type) {
      let rv = getMostRecent(t);
      if (rv) {
        return rv;
      }
    }
  }
  return mediator.getMostRecentWindow(type.toString());
}

/**
 * Gets the most recent window by url instead of type 
 */
function getMostRecentByUrl(url) {
  if (!url) {
    return null;
  }
  url = objToString(url);

  let enumerator = mediator.getEnumerator(null);
  while (enumerator.hasMoreElements()) {
    var win = enumerator.getNext();
    if (win.location == url) {
      return win;
    }
  }
  return null;  
}

function getAllByType(type) {
  let rv = [];
  let enumerator = mediator.getEnumerator(type);
  while (enumerator.hasMoreElements()) {
    rv.push(enumerator.getNext());
  }
  return rv;  
}

function openExternal(link) {
  logger.logString("Mediator: Using external handler for " + link);
  protoservice.loadUrl(objToUri(link));
}
function openUrl(window, link, ref) {
  logger.logString("Mediator: Request to open " + link);
  try {
    let win = getMostRecent('navigator:browser');
    if (win) {
      // browser
      if ('delayedOpenTab' in win) {
        win.delayedOpenTab(objToString(link), objToUri(ref));
        return;
      }
      win.getBrowser().addTab(objToString(link), objToString(ref));
      return;
    }
    win = getMostRecent('Songbird:Main');
    if (win) {
      // Songbird
      let tb = win.document.getElementById('content');
      if (tb) {
        tb.loadOneTab(objToString(link), objToUri(ref), null, null, null);
        return;
      }
    }
  }
  catch (ex) {
    logger.log('Mediator: Failed to open tab', ex);
  }
  try {
    window.open(objToString(link));
  }
  catch (ex) {
    logger.log('Mediator: Failed to open window', ex);
    openExternal(link);
  }
}

function showNotice(window, params) {
  windowwatcher.openWindow(
    window,
    'chrome://dta/content/about/notice.xul',
    '_blank',
    'chrome,centerscreen,all,dialog,modal',
    params
    );
}