path: root/readcatlater.js

// ==VimperatorPlugin==
// @name           Read Cat Later
// @description-ja Read It Later 的な物
// @license        Creative Commons 2.1 (Attribution + Share Alike)
// @version        1.0
// ==/VimperatorPlugin==
//
// Usage:
//    :readcatlater [タグ]
//    :rcl
//    で、現在のURLを後で読むリストに追加する。
//
//    :readcatnow タイトル
//    :rcn タイトル
//    で、そのURLを開く。
//    ! 付きの場合は、開いた後にブックマークから削除する。
//
// License:
//    http://creativecommons.org/licenses/by-sa/2.1/jp/
//    http://creativecommons.org/licenses/by-sa/2.1/jp/deed
//
// Link:
//    http://d.hatena.ne.jp/nokturnalmortum/20080918#1221729188

(function () {
  liberator.log('readcatlater.js loading');

  // このプラグインでブックマークしたときに必ずつくタグ
  const RCL_TAG = 'readcatlater';
  // このプラグインが保存するブックマークのフォルダ名
  // 変更しても良いし、場所を移動しても平気である。
  const FOLDER_NAME = 'L';
  // 逆順表示
  const REVERSE = eval(liberator.globalVariables.readcatlater_reverse || 'false');

  let prefs = {
    prefix: 'extensions.vimperator.plugins.readcatlater.',

    prefs: Components.classes["@mozilla.org/preferences-service;1"].
             getService(Components.interfaces.nsIPrefBranch),

    get: function (name, def) {
      var name, type;
      try {
        const nsIPrefBranch = Components.interfaces.nsIPrefBranch;
        name = this.prefix + name;
        type = this.prefs.getPrefType(name);
        switch (type) {
          case nsIPrefBranch.PREF_STRING:
            try {
              return this.prefs.getComplexValue(name, Components.interfaces.nsISupportsString).data;
            } catch (e) {
              this.prefs.getCharPref(name);
            }
            break;
          case nsIPrefBranch.PREF_INT:
            return this.prefs.getIntPref(name);
            break;
          case nsIPrefBranch.PREF_BOOL:
            return this.prefs.getBoolPref(name);
          default:
            return def;
        }
      } catch (e) {
        return def;
      }
    },

    set: function (name, value, type) {
      var name = this.prefix + name;
      switch (type || typeof value) {
        case 'string':
          let str = Cc['@mozilla.org/supports-string;1'].
                      createInstance(Ci.nsISupportsString);
          str.data = value;
          return this.prefs.setComplexValue(name, Components.interfaces.nsISupportsString, str);
        case 'boolean':
          return this.prefs.setBoolPref(name, value);
        case 'number':
          return this.prefs.setIntPref(name, value);
        default:
          alert('unknown pref type');
      }
    },
  };


  const migemo = Cc['@piro.sakura.ne.jp/xmigemo/factory;1'].
                   getService(Components.interfaces.pIXMigemoFactory).
                   getService("ja");
  const tagssvc = Cc["@mozilla.org/browser/tagging-service;1"].
                      getService(Ci.nsITaggingService);
  const IOService = Cc["@mozilla.org/network/io-service;1"].
                      getService(Ci.nsIIOService);
  const myURI = IOService.newURI("http://www.mozilla.com", null, null);
  const bookmarks = Cc["@mozilla.org/browser/nav-bookmarks-service;1"].
                      getService(Ci.nsINavBookmarksService);
  const history = Cc["@mozilla.org/browser/nav-history-service;1"].
                    getService(Ci.nsINavHistoryService);

  let [folderId, folderGUID] = [prefs.get('folderId', false), prefs.get('folderGUID', false)];

  if (!(folderGUID && folderId && (folderId == bookmarks.getItemIdForGUID(folderGUID)))) {
    folderId = bookmarks.createFolder(bookmarks.toolbarFolder, FOLDER_NAME, bookmarks.DEFAULT_INDEX);
    prefs.set('folderId', folderId);
    prefs.set('folderGUID', bookmarks.getItemGUID(folderId));
  }

  /*
  // Get an array of tags for a URI
  let myTags = tagssvc.getTagsForURI(myURI, {});
  // Get an array of URIs for a tag
  let taggedURIs = tagssvc.getURIsForTag("mozilla");
  // Get an array of all tags
  let arrayOfAllTags = tagssvc.allTags;
  // Remove tags from a URI
  tagssvc.untagURI(myURI, ["mozilla", "firefox"]);
  */

  function openURI (uri) {
    if (window.content.document.location.href == 'about:blank') {
      window.loadURI(uri);
    } else {
      if ('delayedOpenTab' in window)
        window.delayedOpenTab(uri, null);
      else
        window.getBrowser().addTab(uri, null);
    }
  }

  function makeURI (uri) {
    return IOService.newURI(uri, null, null);
  }

  function addEntry (doc, tags) {
    var loc = doc.location.href;
    //履歴の物が検出されてしまう。
    //if (bookmarks.isBookmarked(makeURI(loc)))
    //  return;
    var title = doc.title || loc;
    var uri = makeURI(loc);
    var bkmk = bookmarks.insertBookmark(folderId, uri, bookmarks.DEFAULT_INDEX, title);
    tags.push(RCL_TAG);
    tagssvc.tagURI(uri, tags);
    return title;
  }

  function splitBySpaces (str) {
    return [it for each (it in str.split(/\s+/)) if (/\w/.test(it))];
  }

  function RCL_Bookmarks (terms) { try {
    let query = history.getNewQuery();
    query.setFolders([folderId], 1);

    let m;
    if (terms) {
      let ts = splitBySpaces(terms).map(function (it) {
        var re = new RegExp(migemo.getRegExp(it), 'i');
        var f = function (it) re.exec(it);
        return {s: it, r: f};
      });
      m = function (it)
        ts.some(function (t)
          (it.URI.indexOf(t.s) >= 0 || it.title.indexOf(t.s) >= 0 ||
           t.r(it.URI) || t.r(it.title))
            ? true : false);
    } else {
      m = function () true;
    }

    let result = [];
    let qres = history.executeQueries([query], 1, history.getNewQueryOptions());
    let folderNode = qres.root;

    let closeOriginally = !folderNode.containerOpen;
    if (closeOriginally)
      folderNode.containerOpen = true;

    for (let i = 0; i < folderNode.childCount; ++i) {
      let node = folderNode.getChild(i);
      if (PlacesUtils.nodeIsBookmark(node)) {
        let it = {id:    node.itemId,
                  title: node.title,
                  URI:   node.uri };
        if (m(it))
          result.push(it);
      }
    }

    if (closeOriginally)
      folderNode.containerOpen = false;

    return liberator.globalVariables.readcatlater_reverse ? result.reverse() : result;
  } catch (e) { liberator.log(e); } }

  function completer (context, arg, bang) {
    context.title = ['URL', 'Title'];
    context.items = RCL_Bookmarks(context.filter).
                      filter(function (it) it.id).
                      map(function (it) [it.URI, bookmarks.getItemTitle(it.id)]);
  }

  function removeItems (uri) {
    var removed = false;
    for each (let id in bookmarks.getBookmarkIdsForURI(makeURI(uri), {}))
      if (folderId == bookmarks.getFolderIdForItem(id)) {
        removed = true;
        bookmarks.removeItem(id);
      }
    return removed;
  }

  /********************************************************************************
  * Add Command
  ********************************************************************************/

  commands.addUserCommand(
    ['readcatlater', 'rcl'],
    'read cat later',
    function (args, _, num, extra) {
      // for HEAD
      if (args.string != undefined)
        args = args.string;
      var res = addEntry(window.content.document, splitBySpaces(args)); // FIXME
      if (res)
        liberator.echo('"' + title + '" was added');
      else
        liberator.echo("this URI already exists!?");
    },
    {}
  );

  commands.addUserCommand(
    ['readcatnow', 'rcn'],
    'read cat now',
    function (arg, bang, num, extra) {
      let uri = arg.string;
      openURI(uri);
      if (!bang && removeItems(uri))
        liberator.echo('"' + uri + '" was removed.');
    },
    {
      completer: completer
    },
    true
  );

  commands.addUserCommand(
    ['deletecatnow', 'dcn'],
    'delete cat now',
    function (arg, bang, num, extra) {
      let uri = arg.string;
      if (removeItems(uri))
        liberator.echo('"' + uri + '" was removed.');
    },
    {
      completer: completer
    },
    true
  );

  liberator.log('readcatlater.js loaded');

})();