add external config file and support presets

--this patch adds an external config file in order to store the user layouts. Adds also in the globalSettings the layouts mechanism --todo: the confirmation dialog is not working correctly for some reason. It doesnt return the accept value and on the exec() function is crashing
8 years ago · 883750267a
parent 884c12d980
commit 883750267a
4 changed files with 226 additions and 69 deletions
--- a/app/dockcorona.cpp
+++ b/app/dockcorona.cpp
@ -59,7 +59,6 @@ DockCorona::DockCorona(QObject *parent)
 {
    KPackage::Package package(new DockPackage(this));
    m_screenPool->load();
-    m_globalSettings->load();

    if (!package.isValid()) {
        qWarning() << staticMetaObject.className()
@ -71,6 +70,9 @@ DockCorona::DockCorona(QObject *parent)
    }

    setKPackage(package);
+    //! global settings must be loaded after the package has been set
+    m_globalSettings->load();
+
    qmlRegisterTypes();
    QFontDatabase::addApplicationFont(kPackage().filePath("tangerineFont"));

--- a/app/globalsettings.cpp
+++ b/app/globalsettings.cpp
@ -22,6 +22,7 @@ GlobalSettings::GlobalSettings(QObject *parent)
    : QObject(parent)
 {
    m_corona = qobject_cast<DockCorona *>(parent);
+    m_ghostWidget = new QWidget();

    if (m_corona) {
        m_configGroup = m_corona->config()->group("General");
@ -33,6 +34,8 @@ GlobalSettings::GlobalSettings(QObject *parent)
        connect(m_altSessionAction, &QAction::triggered, this, &GlobalSettings::enableAltSession);
        connect(m_corona, &DockCorona::currentSessionChanged, this, &GlobalSettings::currentSessionChangedSlot);

+        connect(this, &GlobalSettings::importLayoutSignal, this, &GlobalSettings::importLayoutInternal);
+
        init();
    }
 }
@ -40,7 +43,9 @@ GlobalSettings::GlobalSettings(QObject *parent)
 GlobalSettings::~GlobalSettings()
 {
    m_altSessionAction->deleteLater();
+    m_ghostWidget->deleteLater();
    m_configGroup.sync();
+    m_externalGroup.sync();
 }

 void GlobalSettings::init()
@ -52,27 +57,13 @@ void GlobalSettings::init()
        setAutostart(true);
    }

-    //! load default layouts
-    QVariantMap layout1;
-    layout1.insert(QString("key"), QString(i18nc("default layout", "Default")));
-    layout1.insert(QString("value"), QVariant(QString(m_corona->kPackage().filePath("layout1"))));
-
-    QVariantMap layout2;
-    layout2.insert(QString("key"), QString(i18nc("plasma layout", "Plasma")));
-    layout2.insert(QString("value"), QVariant(QString(m_corona->kPackage().filePath("layout2"))));
-
-    QVariantMap layout3;
-    layout3.insert(QString("key"), QString(i18nc("unity layout", "Unity")));
-    layout3.insert(QString("value"), QVariant(QString(m_corona->kPackage().filePath("layout3"))));
-
-    QVariantMap layout4;
-    layout4.insert(QString("key"), QString(i18nc("extended layout", "Extended")));
-    layout4.insert(QString("value"), QVariant(QString(m_corona->kPackage().filePath("layout4"))));
+    initExtConfiguration();
+}

-    m_defaultLayouts.append(layout1);
-    m_defaultLayouts.append(layout2);
-    m_defaultLayouts.append(layout3);
-    m_defaultLayouts.append(layout4);
+void GlobalSettings::initExtConfiguration()
+{
+    KSharedConfigPtr extConfig = KSharedConfig::openConfig(QDir::homePath() + "/.config/lattedockextrc");
+    m_externalGroup = KConfigGroup(extConfig, "External");
 }

 void GlobalSettings::enableAltSession(bool enabled)
@ -156,11 +147,12 @@ void GlobalSettings::setCurrentSession(Dock::SessionType session)
    }
 }

-
 //!BEGIN configuration functions
 void GlobalSettings::load()
 {
    setExposeAltSession(m_configGroup.readEntry("exposeAltSession", false));
+
+    loadExtConfiguration();
 }

 void GlobalSettings::save()
@ -168,6 +160,64 @@ void GlobalSettings::save()
    m_configGroup.writeEntry("exposeAltSession", m_exposeAltSession);
    m_configGroup.sync();
 }
+
+void GlobalSettings::loadExtConfiguration()
+{
+    //! load default layouts
+    QVariantMap layout1;
+    layout1.insert(QString("key"), QString(i18nc("default layout", "Default")));
+    layout1.insert(QString("value"), QVariant(QString(m_corona->kPackage().filePath("layout1"))));
+
+    QVariantMap layout2;
+    layout2.insert(QString("key"), QString(i18nc("plasma layout", "Plasma")));
+    layout2.insert(QString("value"), QVariant(QString(m_corona->kPackage().filePath("layout2"))));
+
+    QVariantMap layout3;
+    layout3.insert(QString("key"), QString(i18nc("unity layout", "Unity")));
+    layout3.insert(QString("value"), QVariant(QString(m_corona->kPackage().filePath("layout3"))));
+
+    QVariantMap layout4;
+    layout4.insert(QString("key"), QString(i18nc("extended layout", "Extended")));
+    layout4.insert(QString("value"), QVariant(QString(m_corona->kPackage().filePath("layout4"))));
+
+    m_defaultLayouts.append(layout1);
+    m_defaultLayouts.append(layout2);
+    m_defaultLayouts.append(layout3);
+    m_defaultLayouts.append(layout4);
+
+    //! load user layouts
+    QStringList userLayouts = m_externalGroup.readEntry("userLayouts", QStringList());
+    QStringList confirmedLayouts;
+
+    foreach (QString layout, userLayouts) {
+        QFile layoutFile(layout);
+
+        if (layoutFile.exists() && !confirmedLayouts.contains(layout)) {
+            confirmedLayouts.append(layout);
+
+            QVariantMap userLayout;
+            int p1 = layout.lastIndexOf("/");
+            int p2 = layout.lastIndexOf(".");
+            //!add the filename as a key
+            userLayout.insert(QString("key"), layout.mid(p1 + 1, p2 - p1 - 1));
+            userLayout.insert(QString("value"), QVariant(QString(layout)));
+
+            m_userLayouts.append(userLayout);
+            m_userLayoutsFiles.append(layout);
+        }
+    }
+
+    //! a save is needed because on first loading we check also if any of the user layout files
+    //! has been removed by the user
+    saveExtConfiguration();
+}
+
+void GlobalSettings::saveExtConfiguration()
+{
+    m_externalGroup.writeEntry("userLayouts", m_userLayoutsFiles);
+    m_externalGroup.sync();
+}
+
 //!END configuration functions

 bool GlobalSettings::importHelper(const QString &fileName)
@ -247,6 +297,7 @@ bool GlobalSettings::importHelper(const QString &fileName)

    return true;
 }
+
 void GlobalSettings::importConfiguration()
 {
    if (m_fileDialog) {
@ -269,59 +320,110 @@ void GlobalSettings::importConfiguration()

    connect(m_fileDialog.data(), &QFileDialog::fileSelected
    , this, [&](const QString & file) {
+        importLayoutInternal(file);
+    });

-        auto showMsgError = [&]() {
-            auto msg = new QMessageBox;
-            msg->setText(i18nc("import/export config", "The file has a wrong format"));
-            msg->setDetailedText(i18nc("import/export config", "Do you want to open other file?"));
-            msg->setStandardButtons(QMessageBox::Ok | QMessageBox::Cancel);
+    m_fileDialog->open();
+}

-            connect(msg, &QMessageBox::accepted, this, &GlobalSettings::importConfiguration);
-            connect(msg, &QMessageBox::finished, msg, &QMessageBox::deleteLater);
+void GlobalSettings::importLayout(QString name, QString file)
+{
+    qDebug() << "layout should be imported : " << file;

-            msg->open();
-        };
+    auto msg = new QMessageBox(m_ghostWidget);
+    //msg->setIcon(QMessageBox::Warning);
+    msg->setWindowTitle(i18n("Activate Layout"));
+    msg->setText(i18n("You are going to activate a layout called <b>%1</b>, <br>by doing so the current layout will be lost... <br>Do you want to proceed?").arg(name));
+    msg->setStandardButtons(QMessageBox::Ok | QMessageBox::Cancel);
+    msg->setDefaultButton(QMessageBox::Cancel);

-        if (!QFile::exists(file)) {
-            showMsgError();
-            return;
-        }
+    connect(msg, &QMessageBox::accepted, this, [this, file] {
+        importLayoutInternal(file);
+    });
+    connect(msg, &QMessageBox::finished,  msg, &QMessageBox::deleteLater);

-        KTar archive(file, QStringLiteral("application/x-tar"));
-        archive.open(QIODevice::ReadOnly);
+    msg->open();
+}

-        if (!archive.isOpen()) {
-            showMsgError();
-            return;
-        }
+void GlobalSettings::importLayoutInternal(QString file)
+{
+    auto showMsgError = [&]() {
+        auto msg = new QMessageBox;
+        msg->setText(i18nc("import/export config", "The file has a wrong format"));
+        msg->setDetailedText(i18nc("import/export config", "Do you want to open other file?"));
+        msg->setStandardButtons(QMessageBox::Ok | QMessageBox::Cancel);
+
+        connect(msg, &QMessageBox::accepted, this, &GlobalSettings::importConfiguration);
+        connect(msg, &QMessageBox::finished, msg, &QMessageBox::deleteLater);

-        auto rootDir = archive.directory();
+        msg->open();
+    };

-        if (rootDir) {
-            foreach (auto &name, rootDir->entries()) {
-                auto fileEntry = rootDir->file(name);
+    if (!QFile::exists(file)) {
+        showMsgError();
+        return;
+    }

-                if (fileEntry && (fileEntry->name() == "lattedockrc"
-                                  || fileEntry->name() == "lattedock-appletsrc")) {
-                    continue;
-                } else {
-                    archive.close();
-                    showMsgError();
-                    return;
-                }
+    //! start:: update the user layouts
+
+    //! first check if this is a default layout, in that case it shouldnt be added
+    bool defaultLayout = false;
+
+    foreach (QVariant it, m_userLayouts) {
+        if (it.canConvert<QVariantMap>()) {
+            QVariantMap map = it.toMap();
+
+            if (map["value"].toString() == file) {
+                defaultLayout = true;
+                break;
            }
        }
+    }

-        archive.close();
-        //NOTE: Restart latte for import the new configuration
-        QProcess::startDetached(qGuiApp->applicationFilePath() + " --import \"" + file + "\"");
-        qGuiApp->exit();
+    if (!defaultLayout) {
+        if (m_userLayoutsFiles.contains(file)) {
+            m_userLayoutsFiles.removeAll(file);
+        }

-    });
+        m_userLayoutsFiles.prepend(file);
+        saveExtConfiguration();
+    }

-    m_fileDialog->open();
+    //! end:: update the user layouts
+
+    KTar archive(file, QStringLiteral("application/x-tar"));
+    archive.open(QIODevice::ReadOnly);
+
+    if (!archive.isOpen()) {
+        showMsgError();
+        return;
+    }
+
+    auto rootDir = archive.directory();
+
+    if (rootDir) {
+        foreach (auto &name, rootDir->entries()) {
+            auto fileEntry = rootDir->file(name);
+
+            if (fileEntry && (fileEntry->name() == "lattedockrc"
+                              || fileEntry->name() == "lattedock-appletsrc")) {
+                continue;
+            } else {
+                archive.close();
+                showMsgError();
+                return;
+            }
+        }
+    }
+
+    archive.close();
+    //NOTE: Restart latte for import the new configuration
+    QProcess::startDetached(qGuiApp->applicationFilePath() + " --import \"" + file + "\"");
+    qGuiApp->exit();
 }

+
+
 void GlobalSettings::exportConfiguration()
 {
    if (m_fileDialog) {
@ -392,7 +494,39 @@ void GlobalSettings::exportConfiguration()

 QVariantList GlobalSettings::layouts()
 {
-    return m_defaultLayouts;
+    QVariantList result;
+    result.append(m_defaultLayouts);
+
+    //! clean up the user styles first in case some of them has been deleted from
+    //! the filesystem
+    foreach (QString layout, m_userLayoutsFiles) {
+        QFile layoutFile(layout);
+
+        if (!layoutFile.exists()) {
+            m_userLayoutsFiles.removeAll(layout);
+
+            foreach (QVariant it, m_userLayouts) {
+                if (it.canConvert<QVariantMap>()) {
+                    QVariantMap map = it.toMap();
+
+                    if (map["value"].toString() == layout) {
+                        m_userLayouts.removeAll(it);
+                    }
+                }
+            }
+        }
+    }
+
+    if (m_userLayouts.size() > 0) {
+        QVariantMap emptyRecord;
+        emptyRecord.insert(QString("key"), QString("-----"));
+        emptyRecord.insert(QString("value"), QVariant(QString("")));
+        result.append(emptyRecord);
+
+        result.append(m_userLayouts);
+    }
+
+    return result;
 }

 }
--- a/app/globalsettings.h
+++ b/app/globalsettings.h
@ -26,6 +26,7 @@

 #include <QFileDialog>
 #include <QPointer>
+#include <QWidget>

 #include <KConfigGroup>
 #include <KSharedConfig>
@ -62,6 +63,7 @@ public:
    static bool importHelper(const QString &fileName);
    Q_INVOKABLE void importConfiguration();
    Q_INVOKABLE void exportConfiguration();
+    Q_INVOKABLE void importLayout(QString name, QString file);
    Q_INVOKABLE QVariantList layouts();

 signals:
@ -69,22 +71,31 @@ signals:
    void currentSessionChanged();
    void autostartChanged();
    void exposeAltSessionChanged();
+    void importLayoutSignal(QString);

 private slots:
    void currentSessionChangedSlot(Dock::SessionType type);
    void enableAltSession(bool enabled);
+    void importLayoutInternal(QString file);

 private:
    void save();
    void init();
+    void initExtConfiguration();
+    void loadExtConfiguration();
+    void saveExtConfiguration();

    bool m_exposeAltSession{false};
    QAction *m_altSessionAction{nullptr};
    DockCorona *m_corona{nullptr};
    QPointer<QFileDialog> m_fileDialog;
+    QPointer<QWidget> m_ghostWidget;
    QVariantList m_defaultLayouts;
+    QVariantList m_userLayouts;
+    QStringList m_userLayoutsFiles;

    KConfigGroup m_configGroup;
+    KConfigGroup m_externalGroup;
 };

 }
--- a/shell/contents/configuration/AppearanceConfig.qml
+++ b/shell/contents/configuration/AppearanceConfig.qml
@ -68,24 +68,34 @@ PlasmaComponents.Page {
                PlasmaComponents.ComboBox {
                    id: layoutCmb
                    Layout.preferredWidth: 0.5 * dialog.maxWidth
+
+                    property var layouts: [i18nc("current layout","Current")];
+                    property var layoutObjs
+
                    Component.onCompleted: layoutCmb.loadLayouts();

                    function loadLayouts(){
+                        layoutObjs = globalSettings.layouts();

-                        var layouts = [i18n("Current")];
-                        var layoutsC = globalSettings.layouts();
-
-                        for(var i=0; i<layoutsC.length; ++i){
-                            layouts.push(layoutsC[i].key);
+                        for(var i=0; i<layoutObjs.length; ++i){
+                            layouts.push(layoutObjs[i].key);
                        }

-                        layouts.push("-----");
-                        layouts.push("myfavourite1");
-
                        model = layouts;
-
                        currentIndex = 0;
                    }
+
+                    onCurrentIndexChanged: {
+                        if (currentIndex>0 && layoutObjs[currentIndex-1].value === ""){
+                            currentIndex = 0;
+                            return;
+                        }
+
+                        if (currentIndex>0) {
+                            globalSettings.importLayout(layoutObjs[currentIndex-1].key,
+                                                        layoutObjs[currentIndex-1].value);
+                        }
+                    }
                }

                PlasmaComponents.Button {