workspace/libs/plasma/appletbrowser.cpp

   1 /*
   2  *   Copyright (C) 2007 Ivan Cukic <ivan.cukic+kde@gmail.com>
   3  *
   4  *   This program is free software; you can redistribute it and/or modify
   5  *   it under the terms of the GNU Library/Lesser General Public License
   6  *   version 2, or (at your option) any later version, as published by the
   7  *   Free Software Foundation
   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/Lesser 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 "plasma/appletbrowser.h"
  21
  22 #include <QVBoxLayout>
  23 #include <QLabel>
  24
  25 #include <KAction>
  26 #include <KConfig>
  27 #include <KConfigGroup>
  28 #include <KMenu>
  29 #include <KPageWidgetItem>
  30 #include <KPushButton>
  31 #include <KServiceTypeTrader>
  32 #include <KStandardAction>
  33
  34 #include "plasma/applet.h"
  35 #include "plasma/corona.h"
  36 #include "plasma/containment.h"
  37 #include "plasma/appletbrowser/kcategorizeditemsview_p.h"
  38 #include "plasma/appletbrowser/plasmaappletitemmodel_p.h"
  39 #include "plasma/appletbrowser/openwidgetassistant_p.h"
  40
  41 namespace Plasma
  42 {
  43
  44 class AppletBrowserWidget::Private
  45 {
  46 public:
  47     Private(Containment* cont, AppletBrowserWidget* w)
  48         : containment(cont),
  49           appletList(0),
  50           config("plasmarc"),
  51           configGroup(&config, "Applet Browser"),
  52           itemModel(configGroup, w),
  53           filterModel(w)
  54     {
  55     }
  56
  57     void initFilters();
  58
  59     QString application;
  60     Plasma::Containment *containment;
  61     KCategorizedItemsView *appletList;
  62     QHash<QString, int> runningApplets; // applet name => count
  63     //extra hash so we can look up the names of deleted applets
  64     QHash<Plasma::Applet*, QString> appletNames;
  65
  66     KConfig config;
  67     KConfigGroup configGroup;
  68
  69     PlasmaAppletItemModel itemModel;
  70     KCategorizedItemsViewModels::DefaultFilterModel filterModel;
  71 };
  72
  73 void AppletBrowserWidget::Private::initFilters()
  74 {
  75     filterModel.clear();
  76
  77     filterModel.addFilter(i18n("All Widgets"),
  78                           KCategorizedItemsViewModels::Filter(), new KIcon("plasma"));
  79
  80     // Recommended emblems and filters
  81     QRegExp rx("recommended[.]([0-9A-Za-z]+)[.]caption");
  82     QMapIterator<QString, QString> i(configGroup.entryMap());
  83     while (i.hasNext()) {
  84         i.next();
  85         if (!rx.exactMatch(i.key())) {
  86             continue;
  87         }
  88         //kDebug() << "These are the key/vals in rc file " << rx.cap(1) << "\n";
  89
  90         QString id = rx.cap(1);
  91         QString caption = configGroup.readEntry("recommended." + id + ".caption");
  92         QString icon    = configGroup.readEntry("recommended." + id + ".icon");
  93         QString plugins = configGroup.readEntry("recommended." + id + ".plugins");
  94
  95         appletList->addEmblem(i18n("Recommended by %1", caption), new KIcon(icon),
  96                               KCategorizedItemsViewModels::Filter("recommended." + id, true));
  97         filterModel.addFilter(i18n("Recommended by %1", caption),
  98                               KCategorizedItemsViewModels::Filter("recommended." + id, true), new KIcon(icon));
  99     }
 100
 101     // Filters: Special
 102     filterModel.addFilter(i18n("My Favorite Widgets"),
 103                           KCategorizedItemsViewModels::Filter("favorite", true),
 104                           new KIcon("bookmarks"));
 105     filterModel.addFilter(i18n("Widgets I Have Used Before"),
 106                           KCategorizedItemsViewModels::Filter("used", true),
 107                           new KIcon("view-history"));
 108     filterModel.addFilter(i18n("Currently Running Widgets"),
 109                           KCategorizedItemsViewModels::Filter("running", true),
 110                           new KIcon("view-history"));
 111
 112     filterModel.addSeparator(i18n("Categories:"));
 113
 114     foreach (const QString& category, Plasma::Applet::knownCategories(application)) {
 115         filterModel.addFilter(category,
 116                               KCategorizedItemsViewModels::Filter("category", category));
 117     }
 118 }
 119
 120 AppletBrowserWidget::AppletBrowserWidget(Plasma::Containment * containment, QWidget * parent, Qt::WindowFlags f)
 121     : QWidget(parent, f),
 122     d(new Private(containment, this))
 123 {
 124     init();
 125 }
 126
 127 AppletBrowserWidget::~AppletBrowserWidget()
 128 {
 129     delete d;
 130 }
 131
 132 void AppletBrowserWidget::init()
 133 {
 134     QVBoxLayout *layout = new QVBoxLayout(this);
 135
 136     d->appletList = new KCategorizedItemsView(this);
 137     connect(d->appletList, SIGNAL(activated(const QModelIndex &)), this, SLOT(addApplet()));
 138     layout->addWidget( d->appletList );
 139
 140     // Other Emblems
 141     d->appletList->addEmblem(i18n("Widgets I Have Used Before"), new KIcon("view-history"),
 142                                 KCategorizedItemsViewModels::Filter("used", true));
 143
 144     d->initFilters();
 145     d->appletList->setFilterModel(&d->filterModel);
 146
 147     // Other models
 148     d->appletList->setItemModel(&d->itemModel);
 149     initRunningApplets();
 150
 151     setLayout(layout);
 152 }
 153
 154 void AppletBrowserWidget::initRunningApplets()
 155 {
 156 //get applets from corona, count them, send results to model
 157     if (!d->containment) {
 158         return;
 159     }
 160
 161     kDebug() << d->runningApplets.count();
 162     Plasma::Corona *c = d->containment->corona();
 163
 164     //we've tried our best to get a corona
 165     //we don't want just one containment, we want them all
 166     if (!c) {
 167         kDebug() << "can't happen";
 168         return;
 169     }
 170
 171     d->appletNames.clear();
 172     d->runningApplets.clear();
 173     QList<Containment*> containments = c->containments();
 174     foreach (Containment * containment,containments) {
 175         connect(containment, SIGNAL(appletAdded(Plasma::Applet*)), this, SLOT(appletAdded(Plasma::Applet*)));
 176         //TODO track containments too?
 177         QList<Applet*>applets=containment->applets();
 178         foreach (Applet *applet,applets) {
 179             d->runningApplets[applet->name()]++;
 180             d->appletNames.insert(applet, applet->name());
 181             connect(applet, SIGNAL(destroyed(QObject*)), this, SLOT(appletDestroyed(QObject*)));
 182         }
 183     }
 184
 185     kDebug() << d->runningApplets;
 186     d->itemModel.setRunningApplets(d->runningApplets);
 187 }
 188
 189 void AppletBrowserWidget::setApplication(const QString& app)
 190 {
 191     d->application = app;
 192     d->initFilters();
 193     d->itemModel.setApplication(app);
 194
 195     //FIXME: AFAIK this shouldn't be necessary ... but here it is. need to find out what in that
 196     //       maze of models and views is screwing up
 197     d->appletList->setItemModel(&d->itemModel);
 198
 199     kDebug() << d->runningApplets;
 200     d->itemModel.setRunningApplets(d->runningApplets);
 201 }
 202
 203 QString AppletBrowserWidget::application()
 204 {
 205     return d->application;
 206 }
 207
 208 void AppletBrowserWidget::setContainment(Plasma::Containment *containment)
 209 {
 210     d->containment = containment;
 211 }
 212
 213 Containment *AppletBrowserWidget::containment() const
 214 {
 215     return d->containment;
 216 }
 217
 218 void AppletBrowserWidget::addApplet()
 219 {
 220     kDebug() << "Button ADD clicked";
 221     if (!d->containment) {
 222         return;
 223     }
 224
 225     foreach (AbstractItem *item, d->appletList->selectedItems()) {
 226         PlasmaAppletItem *selectedItem = (PlasmaAppletItem *) item;
 227         kDebug() << "Adding applet " << selectedItem->name() << "to containment";
 228         d->containment->addApplet(selectedItem->pluginName(), selectedItem->arguments());
 229     }
 230 }
 231
 232 void AppletBrowserWidget::appletAdded(Plasma::Applet* applet)
 233 {
 234     QString name = applet->name();
 235     kDebug() << name;
 236
 237     d->runningApplets[name]++;
 238     d->appletNames.insert(applet, name);
 239     connect(applet, SIGNAL(destroyed(QObject*)), this, SLOT(appletDestroyed(QObject*)));
 240     d->itemModel.setRunningApplets(name, d->runningApplets[name]);
 241 }
 242
 243 void AppletBrowserWidget::appletDestroyed(QObject* applet)
 244 {
 245     kDebug() << applet;
 246     Plasma::Applet* a = (Plasma::Applet*)applet; //don't care if it's valid, just need the address
 247
 248     QString name = d->appletNames.take(a);
 249
 250     int count = 0;
 251     if (d->runningApplets.contains(name)) {
 252         count = d->runningApplets[name] - 1;
 253
 254         if (count < 1) {
 255             d->runningApplets.remove(name);
 256         } else {
 257             d->runningApplets[name] = count;
 258         }
 259     }
 260
 261     d->itemModel.setRunningApplets(name, count);
 262 }
 263
 264 void AppletBrowserWidget::destroyApplets(const QString &name)
 265 {
 266     if (!d->containment) {
 267         return;
 268     }
 269
 270     Plasma::Corona *c = d->containment->corona();
 271
 272     //we've tried our best to get a corona
 273     //we don't want just one containment, we want them all
 274     if (!c) {
 275         kDebug() << "can't happen";
 276         return;
 277     }
 278
 279     foreach (Containment *containment, c->containments()) {
 280         QList<Applet*> applets = containment->applets();
 281         foreach (Applet *applet,applets) {
 282             d->appletNames.remove(applet);
 283             if (applet->name() == name) {
 284                 applet->disconnect(this);
 285                 applet->destroy();
 286             }
 287         }
 288     }
 289
 290     d->runningApplets.remove(name);
 291     d->itemModel.setRunningApplets(name, 0);
 292 }
 293
 294 void AppletBrowserWidget::downloadWidgets()
 295 {
 296     //TODO: implement
 297     kDebug() << "GHNS button clicked";
 298 }
 299
 300 void AppletBrowserWidget::openWidgetFile()
 301 {
 302     // TODO: if we already have one of these showing and the user clicks to add it again, show the same window?
 303     OpenWidgetAssistant *assistant = new OpenWidgetAssistant(topLevelWidget());
 304     assistant->setAttribute(Qt::WA_DeleteOnClose, true);
 305     assistant->show();
 306 }
 307
 308 class AppletBrowser::Private
 309 {
 310 public:
 311     void init(AppletBrowser*, Plasma::Containment*);
 312     AppletBrowserWidget *widget;
 313 };
 314
 315 AppletBrowser::AppletBrowser(Plasma::Containment * containment, QWidget * parent, Qt::WindowFlags f)
 316     : KDialog(parent, f),
 317       d(new Private)
 318 {
 319     d->init(this, containment);
 320 }
 321
 322 void AppletBrowser::Private::init(AppletBrowser *q, Plasma::Containment *containment)
 323 {
 324     widget = new AppletBrowserWidget(containment, q);
 325
 326     q->setMainWidget(widget);
 327     q->setWindowTitle(i18n("Widgets"));
 328
 329     q->setButtons(KDialog::Apply | KDialog::Close | KDialog::User1);
 330     q->setButtonText(KDialog::Apply, i18n("Add Widget"));
 331     q->setButtonText(KDialog::User1, i18n("Install New Widgets"));
 332
 333     KMenu *widgetsMenu = new KMenu(i18n("Get New Widgets"), q);
 334     QAction *action = new QAction(KIcon("applications-internet"),
 335                                   i18n("Download from the Internet"), q);
 336     connect(action, SIGNAL(triggered(bool)), widget, SLOT(downloadWidgets()));
 337     widgetsMenu->addAction(action);
 338
 339     action = new QAction(KIcon("applications-internet"),
 340                          i18n("Install from file"), q);
 341     connect(action, SIGNAL(triggered(bool)), widget, SLOT(openWidgetFile()));
 342     widgetsMenu->addAction(action);
 343     q->button(KDialog::User1)->setMenu(widgetsMenu);
 344
 345     q->setButtonToolTip(KDialog::Close, i18n("Close the dialog"));
 346     q->setButtonWhatsThis(KDialog::Close, i18n("<qt>When clicking <b>Close</b>, this dialog will be closed with no further action taken.</qt>"));
 347     q->setButtonToolTip(KDialog::Apply, i18n("Add selected widgets"));
 348     q->setButtonWhatsThis(KDialog::Apply, i18n("<qt>When clicking <b>Add Widget</b>, the selected widgets will be added to your desktop.</qt>"));
 349     q->setButtonToolTip(KDialog::User1, i18n("Download new widgets"));
 350     q->setButtonWhatsThis(KDialog::User1, i18n("<qt>When clicking <b>Get New Widgets</b>, a dialog will open to allow you to download new widgets. You need to be connected to the Internet.</qt>"));
 351
 352     connect(q, SIGNAL(applyClicked()), widget, SLOT(addApplet()));
 353
 354     q->setInitialSize(QSize(400, 600));
 355     KConfigGroup cg(KGlobal::config(), "PlasmaAppletBrowserDialog");
 356     q->restoreDialogSize(cg);
 357 }
 358
 359 AppletBrowser::~AppletBrowser()
 360 {
 361     KConfigGroup cg(KGlobal::config(), "PlasmaAppletBrowserDialog");
 362     saveDialogSize(cg);
 363 }
 364
 365 void AppletBrowser::setApplication(const QString& app)
 366 {
 367     d->widget->setApplication( app );
 368 }
 369
 370 QString AppletBrowser::application()
 371 {
 372     return d->widget->application();
 373 }
 374
 375 void AppletBrowser::setContainment(Plasma::Containment *containment)
 376 {
 377     d->widget->setContainment(containment);
 378 }
 379
 380 Containment* AppletBrowser::containment() const
 381 {
 382     return d->widget->containment();
 383 }
 384
 385 } // namespace Plasma
 386
 387 #include "appletbrowser.moc"