workspace/plasma/runners/bookmarks/bookmarksrunner.cpp

   1 /*
   2  *   Copyright 2007 Glenn Ergeerts <glenn.ergeerts@telenet.be>
   3  *
   4  *   This program is free software; you can redistribute it and/or modify
   5  *   it under the terms of the GNU Library General Public License as
   6  *   published by the Free Software Foundation; either version 2, or
   7  *   (at your option) any later version.
   8  *
   9  *   This program is distributed in the hope that it will be useful,
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *   GNU General Public License for more details
  13  *
  14  *   You should have received a copy of the GNU Library General Public
  15  *   License along with this program; if not, write to the
  16  *   Free Software Foundation, Inc.,
  17  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18  */
  19
  20 #include "bookmarksrunner.h"
  21
  22 #include <QAction>
  23 #include <QDBusInterface>
  24 #include <QDBusReply>
  25 #include <QLabel>
  26 #include <QList>
  27 #include <QStack>
  28 #include <QWidget>
  29
  30 #include <KIcon>
  31 #include <KBookmarkManager>
  32 #include <KToolInvocation>
  33 #include <KUrl>
  34 #include <KStandardDirs>
  35
  36
  37 BookmarksRunner::BookmarksRunner( QObject* parent, const QVariantList &args )
  38     : Plasma::AbstractRunner(parent, args)
  39 {
  40     Q_UNUSED(args)
  41     setObjectName("Bookmarks");
  42     m_icon = KIcon("bookmarks");
  43     m_bookmarkManager = KBookmarkManager::userBookmarksManager();
  44 }
  45
  46 BookmarksRunner::~BookmarksRunner()
  47 {
  48 }
  49
  50 void BookmarksRunner::match(Plasma::RunnerContext &context)
  51 {
  52     const QString term = context.query();
  53     if (term.length() < 3) {
  54         return;
  55     }
  56
  57     KBookmarkGroup bookmarkGroup = m_bookmarkManager->root();
  58
  59     QList<Plasma::QueryMatch> matches;
  60     QStack<KBookmarkGroup> groups;
  61
  62     KBookmark bookmark = bookmarkGroup.first();
  63     while (!bookmark.isNull()) {
  64         if (bookmark.isGroup()) { // descend
  65             //kDebug () << "descending into" << bookmark.text();
  66             groups.push(bookmarkGroup);
  67             bookmarkGroup = bookmark.toGroup();
  68             bookmark = bookmarkGroup.first();
  69
  70             while (bookmark.isNull() && !groups.isEmpty()) {
  71                 bookmark = bookmarkGroup;
  72                 bookmarkGroup = groups.pop();
  73                 bookmark = bookmarkGroup.next(bookmark);
  74             }
  75
  76             continue;
  77         }
  78
  79         Plasma::QueryMatch::Type type = Plasma::QueryMatch::NoMatch;
  80         qreal relevance = 0;
  81
  82         if (bookmark.text().toLower() == term.toLower()) {
  83             type = Plasma::QueryMatch::ExactMatch;
  84             relevance = 1.0;
  85         } else if (bookmark.text().contains(term, Qt::CaseInsensitive)) {
  86             type = Plasma::QueryMatch::PossibleMatch;
  87             relevance = 0.4;
  88         } else if (bookmark.url().prettyUrl().contains(term, Qt::CaseInsensitive)) {
  89             type = Plasma::QueryMatch::PossibleMatch;
  90             relevance = 0.2;
  91         }
  92
  93         if (type != Plasma::QueryMatch::NoMatch) {
  94             //kDebug() << "Found bookmark: " << bookmark.text() << " (" << bookmark.url().prettyUrl() << ")";
  95             // getting the favicon is too slow and can easily lead to starving the thread pool out
  96             /*
  97             QIcon icon = getFavicon(bookmark.url());
  98             if (icon.isNull()) {
  99                 match->setIcon(m_icon);
 100             }
 101             else {
 102                 match->setIcon(icon);
 103             }
 104             */
 105             Plasma::QueryMatch match(this);
 106             match.setType(type);
 107             match.setRelevance(relevance);
 108             match.setIcon(m_icon);
 109             match.setText(bookmark.text());
 110             match.setData(bookmark.url().url());
 111             matches << match;
 112         }
 113
 114         bookmark = bookmarkGroup.next(bookmark);
 115         while (bookmark.isNull() && !groups.isEmpty()) {
 116             bookmark = bookmarkGroup;
 117             bookmarkGroup = groups.pop();
 118             //kDebug() << "ascending from" << bookmark.text() << "to" << bookmarkGroup.text();
 119             bookmark = bookmarkGroup.next(bookmark);
 120         }
 121     }
 122
 123     context.addMatches(term, matches);
 124 }
 125
 126 KIcon BookmarksRunner::getFavicon(const KUrl &url)
 127 {
 128     // query the favicons module
 129     QDBusInterface favicon("org.kde.kded", "/modules/favicons", "org.kde.FavIcon");
 130     QDBusReply<QString> reply = favicon.call("iconForUrl", url.url());
 131
 132     if (!reply.isValid()) {
 133         return KIcon();
 134     }
 135
 136     // locate the favicon
 137     QString iconFile = KGlobal::dirs()->findResource("cache",reply.value()+".png");
 138     if(iconFile.isNull()) {
 139         return KIcon();
 140     }
 141
 142     KIcon icon = KIcon(iconFile);
 143
 144     return icon;
 145 }
 146
 147 void BookmarksRunner::run(const Plasma::RunnerContext &context, const Plasma::QueryMatch &action)
 148 {
 149     Q_UNUSED(context);
 150     KUrl url = (KUrl)action.data().toString();
 151     //kDebug() << "BookmarksRunner::run opening: " << url.url();
 152     KToolInvocation::invokeBrowser(url.url());
 153 }
 154
 155 #include "bookmarksrunner.moc"