allow PackageStructures to provide their own online browsers

svn path=/trunk/KDE/kdebase/workspace/libs/plasma/; revision=871119

appletbrowser.cpp

@@ -31,14 +31,13 @@
 #include <KServiceTypeTrader>
 #include <KStandardAction>
 
-#include <knewstuff2/engine.h>
-
 #include "plasma/applet.h"
 #include "plasma/corona.h"
 #include "plasma/containment.h"
 #include "plasma/appletbrowser/kcategorizeditemsview_p.h"
 #include "plasma/appletbrowser/plasmaappletitemmodel_p.h"
 #include "plasma/appletbrowser/openwidgetassistant_p.h"
+#include "plasma/private/packages_p.h"
 
 namespace Plasma
 {
@@ -322,12 +321,41 @@ void AppletBrowserWidget::destroyApplets(const QString &name)
     d->itemModel.setRunningApplets(name, 0);
 }
 
-void AppletBrowserWidget::downloadWidgets()
+void AppletBrowserWidget::downloadWidgets(const QString &type)
 {
-    KNS::Engine engine(0);
-    if (engine.init("plasmoids.knsrc")) {
-        KNS::Entry::List entries = engine.downloadDialogModal(this);
+    kDebug() << type;
+    PackageStructure *installer = 0;
+
+    if (!type.isEmpty()) {
+        QString constraint = QString("'%1' == [X-KDE-PluginInfo-Name]").arg(type);
+        KService::List offers = KServiceTypeTrader::self()->query("Plasma/PackageStructure",
+                                                                  constraint);
+
+        if (offers.isEmpty()) {
+            kDebug() << "could not find requested PackageStructure plugin" << type;
+        } else {
+            KService::Ptr service = offers.first();
+            QString error;
+            installer = service->createInstance<Plasma::PackageStructure>(topLevelWidget(),
+                                                                          QVariantList(), &error);
+
+            if (installer) {
+                connect(installer, SIGNAL(newWidgetBrowserFinished()),
+                        installer, SLOT(deleteLater()));
+            } else {
+                kDebug() << "found, but could not load requested PackageStructure plugin" << type
+                         << "; reported error was" << error;
+            }
+        }
     }
+
+    if (!installer) {
+        // we don't need to delete the default Applet::packageStructure as that
+        // belongs to the applet
+        installer = new PlasmoidPackage();
+    }
+
+    installer->createNewWidgetBrowser(this);
 }
 
 void AppletBrowserWidget::openWidgetFile()
@@ -342,19 +370,51 @@ void AppletBrowserWidget::openWidgetFile()
 class AppletBrowserPrivate
 {
 public:
-    void init(AppletBrowser*);
+    void init(AppletBrowser *browser);
+    void populateWidgetsMenu();
+
+    AppletBrowser *q;
     AppletBrowserWidget *widget;
+    QMenu *widgetsMenu;
 };
 
-AppletBrowser::AppletBrowser(QWidget * parent, Qt::WindowFlags f)
-    : KDialog(parent, f),
-      d(new AppletBrowserPrivate)
+void AppletBrowserPrivate::populateWidgetsMenu()
 {
-    d->init(this);
+    if (!widgetsMenu->actions().isEmpty()) {
+        // already populated.
+        return;
+    }
+
+    QSignalMapper *mapper = new QSignalMapper(q);
+    QObject::connect(mapper, SIGNAL(mapped(QString)), widget, SLOT(downloadWidgets(QString)));
+
+    QAction *action = new QAction(KIcon("applications-internet"),
+                                  i18n("Download New Plasma Widgets"), q);
+    QObject::connect(action, SIGNAL(triggered(bool)), mapper, SLOT(map()));
+    mapper->setMapping(action, QString());
+    widgetsMenu->addAction(action);
+
+    KService::List offers = KServiceTypeTrader::self()->query("Plasma/PackageStructure");
+    foreach (const KService::Ptr service, offers) {
+        if (service->property("X-Plasma-ProvidesWidgetBrowser").toBool()) {
+            QAction *action = new QAction(KIcon("applications-internet"),
+                                          i18n("Download New %1 Widgets", service->name()), q);
+            QObject::connect(action, SIGNAL(triggered(bool)), mapper, SLOT(map()));
+            mapper->setMapping(action, service->property("X-KDE-PluginInfo-Name").toString());
+        }
+    }
+
+    widgetsMenu->addSeparator();
+
+    action = new QAction(KIcon("package-x-generic"),
+                         i18n("Install A Widget From A Local File..."), q);
+    QObject::connect(action, SIGNAL(triggered(bool)), widget, SLOT(openWidgetFile()));
+    widgetsMenu->addAction(action);
 }
 
-void AppletBrowserPrivate::init(AppletBrowser *q)
+void AppletBrowserPrivate::init(AppletBrowser *browser)
 {
+    q = browser;
     widget = new AppletBrowserWidget(q);
 
     q->setMainWidget(widget);
@@ -364,16 +424,8 @@ void AppletBrowserPrivate::init(AppletBrowser *q)
     q->setButtonText(KDialog::Apply, i18n("Add Widget"));
     q->setButtonText(KDialog::User1, i18n("Install New Widgets"));
 
-    KMenu *widgetsMenu = new KMenu(i18n("Get New Widgets"), q);
-    QAction *action = new QAction(KIcon("applications-internet"),
-                                  i18n("Download From Internet"), q);
-    QObject::connect(action, SIGNAL(triggered(bool)), widget, SLOT(downloadWidgets()));
-    widgetsMenu->addAction(action);
-
-    action = new QAction(KIcon("applications-internet"),
-                         i18n("Install From File..."), q);
-    QObject::connect(action, SIGNAL(triggered(bool)), widget, SLOT(openWidgetFile()));
-    widgetsMenu->addAction(action);
+    widgetsMenu = new KMenu(i18n("Get New Widgets"), q);
+    QObject::connect(widgetsMenu, SIGNAL(aboutToShow()), q, SLOT(populateWidgetsMenu()));
     q->button(KDialog::User1)->setMenu(widgetsMenu);
 
     q->setButtonToolTip(KDialog::Close, i18n("Close the dialog"));
@@ -390,6 +442,13 @@ void AppletBrowserPrivate::init(AppletBrowser *q)
     q->restoreDialogSize(cg);
 }
 
+AppletBrowser::AppletBrowser(QWidget * parent, Qt::WindowFlags f)
+    : KDialog(parent, f),
+      d(new AppletBrowserPrivate)
+{
+    d->init(this);
+}
+
 AppletBrowser::~AppletBrowser()
 {
     KConfigGroup cg(KGlobal::config(), "PlasmaAppletBrowserDialog");

appletbrowser.h

@@ -68,8 +68,12 @@ public Q_SLOTS:
 
     /**
      * Launches a download dialog to retrieve new applets from the Internet
+     *
+     * @arg type the type of widget to download; an empty string means the default
+     *           Plasma widgets will be accessed, any other value should map to a
+     *           PackageStructure PluginInfo-Name entry that provides a widget browser.
      */
-    void downloadWidgets();
+    void downloadWidgets(const QString &type = QString());
 
     /**
      * Opens a file dialog to open a widget from a local file
@@ -107,6 +111,7 @@ public:
     Containment *containment() const;
 
 private:
+    Q_PRIVATE_SLOT(d, void populateWidgetsMenu());
     AppletBrowserPrivate * const d;
 };
 

packagestructure.cpp

@@ -401,6 +401,11 @@ bool PackageStructure::uninstallPackage(const QString &packageName, const QStrin
     return Package::uninstallPackage(packageName, packageRoot, d->servicePrefix);
 }
 
+void PackageStructure::createNewWidgetBrowser(QWidget *parent)
+{
+    emit newWidgetBrowserFinished();
+}
+
 QString PackageStructure::defaultPackageRoot() const
 {
     return d->packageRoot;

packagestructure.h

@@ -237,6 +237,20 @@ public:
      */
     virtual bool uninstallPackage(const QString &packageName, const QString &packageRoot);
 
+    /**
+     * When called, the package plugin should display a window to the user
+     * that they can use to browser, select and then install widgets supported by
+     * this package plugin with.
+     *
+     * The user interface may be an in-process dialog or an out-of-process application.
+     *
+     * When the process is complete, the newWidgetBrowserFinished() signal must be
+     * emitted.
+     *
+     * @args parent the parent widget to use for the widget
+     */
+    virtual void createNewWidgetBrowser(QWidget *parent = 0);
+
     /**
      * @return the prefix inserted between the base path and content entries
      */
@@ -257,6 +271,12 @@ public:
      */
     void setServicePrefix(const QString &servicePrefix);
 
+Q_SIGNALS:
+    /**
+     * Emitted when the new widget browser process completes.
+     */
+    void newWidgetBrowserFinished();
+
 protected:
     /**
      * Sets the prefix that all the contents in this package should

private/packages.cpp

@@ -23,6 +23,8 @@
 #include <KDesktopFile>
 #include <KLocale>
 
+#include <knewstuff2/engine.h>
+
 namespace Plasma
 {
 
@@ -65,6 +67,15 @@ void PlasmoidPackage::pathChanged()
     }
 }
 
+void PlasmoidPackage::createNewWidgetBrowser(QWidget *parent)
+{
+    KNS::Engine engine(0);
+    if (engine.init("plasmoids.knsrc")) {
+        /* KNS::Entry::List entries = */ engine.downloadDialogModal(parent);
+    }
+    emit newWidgetBrowserFinished();
+}
+
 ThemePackage::ThemePackage(QObject *parent)
     : Plasma::PackageStructure(parent, QString("Plasma Theme"))
 {

private/packages_p.h

@@ -30,6 +30,7 @@ class PlasmoidPackage : public PackageStructure
     Q_OBJECT
 public:
     explicit PlasmoidPackage(QObject *parent = 0);
+    void createNewWidgetBrowser(QWidget *parent = 0);
 
 protected:
     void pathChanged();

servicetypes/plasma-packagestructure.desktop

@@ -53,3 +53,7 @@ Type=QString
 [PropertyDef::X-Plasma-PackageFileMimetypes]
 Type=QStringList
 
+[PropertyDef::X-Plasma-ProvidesWidgetBrowser]
+Type=bool
+
+