Started a framework for desktop plugins and modified the screensaver plugins to inherit from a base plugin system

9 files changed, 250 insertions, 121 deletions

diff --git a/src-qt5/core/lumina-desktop-unified/src-screensaver/SSBaseWidget.cpp b/src-qt5/core/lumina-desktop-unified/src-screensaver/SSBaseWidget.cpp
index 7c098887..aa3214a2 100644
--- a/src-qt5/core/lumina-desktop-unified/src-screensaver/SSBaseWidget.cpp
+++ b/src-qt5/core/lumina-desktop-unified/src-screensaver/SSBaseWidget.cpp
@@ -7,6 +7,9 @@
 
 #include "SSBaseWidget.h"
 
+//Relative directory to search along the XDG paths for screensavers
+#define REL_DIR QString("/lumina-desktop/screensavers")
+
 #define DEBUG 0
 
 // ========
@@ -39,10 +42,10 @@ void SSBaseWidget::startPainting(){
   stopPainting();
   //If a random plugin - grab one of the known plugins
   if(plugType=="random"){
-    QList<SSPlugin> valid = SSPluginSystem::findAllPlugins();
+    QList<SSPlugin> valid = PluginSystem::findAllPlugins<SSPlugin>(REL_DIR);
     if(!valid.isEmpty()){ cplug = valid[ qrand()%valid.length() ]; } //grab a random plugin
   }else if(plugType!="none"){
-    cplug = SSPluginSystem::findPlugin(plugType);
+    cplug = PluginSystem::findPlugin<SSPlugin>(plugType, REL_DIR);
   }
   if(DEBUG){ qDebug() << " - Screen Saver:" << plugType << cplug.scriptURL() << cplug.isValid(); }
   if(cplug.isValid()){
diff --git a/src-qt5/core/lumina-desktop-unified/src-screensaver/SSBaseWidget.h b/src-qt5/core/lumina-desktop-unified/src-screensaver/SSBaseWidget.h
index 72e02702..e0a03d17 100644
--- a/src-qt5/core/lumina-desktop-unified/src-screensaver/SSBaseWidget.h
+++ b/src-qt5/core/lumina-desktop-unified/src-screensaver/SSBaseWidget.h
@@ -10,6 +10,7 @@
 #define _LUMINA_DESKTOP_SCREEN_SAVER_BASE_WIDGET_H
 
 #include "global-includes.h"
+#include <plugins-base.h>
 #include <plugins-screensaver.h>
 
 class SSBaseWidget : public QQuickView{
@@ -25,8 +26,8 @@ public slots:
 	void stopPainting();
 
 private:
-        QString plugType;
-        SSPlugin cplug;
+  QString plugType;
+  SSPlugin cplug;
 	QTimer *restartTimer;
 
 private slots:
diff --git a/src-qt5/src-cpp/plugins-base.cpp b/src-qt5/src-cpp/plugins-base.cpp
new file mode 100644
index 00000000..f38374df
--- /dev/null
+++ b/src-qt5/src-cpp/plugins-base.cpp
@@ -0,0 +1,50 @@
+//===========================================
+//  Lumina-desktop source code
+//  Copyright (c) 2017, Ken Moore
+//  Available under the 3-clause BSD license
+//  See the LICENSE file for full details
+//===========================================
+#include "plugins-base.h"
+
+// ============
+//    Base PLUGIN
+// ============
+BasePlugin::BasePlugin(){
+
+}
+
+BasePlugin::~BasePlugin(){
+
+}
+
+void BasePlugin::loadFile(QString path){
+  data = QJsonObject();
+  currentfile = path;
+  QFile file(path);
+  if(!file.exists() || !file.open(QIODevice::ReadOnly)){ return; }
+  data = QJsonDocument::fromJson(file.readAll()).object();
+  //qDebug() << "Loaded ScreenSaver Data:" << currentfile << data;
+  file.close();
+}
+
+QString BasePlugin::translatedObject(QString obj){
+  QJsonObject tmp = data.value(obj).toObject();
+  //Get the current locale
+  QString locale = getenv("LC_ALL");
+  if(locale.isEmpty()){ locale = getenv("LC_MEBaseAGES"); }
+  if(locale.isEmpty()){ locale = getenv("LANG"); }
+  if(locale.isEmpty()){ locale = "default"; }
+  if(locale.contains(".")){ locale = locale.section(".",0,0); } //chop any charset code off the end
+  //Now find which localized string is available and return it
+  if(tmp.contains(locale)){ return tmp.value(locale).toString(); }
+  locale = locale.section("_",0,0); //full locale not found - look for shortened form
+  if(tmp.contains(locale)){ return tmp.value(locale).toString(); }
+  return tmp.value("default").toString(); //use the default version
+}
+
+QUrl BasePlugin::scriptURL(){
+  QString exec = data.value("qml").toObject().value("exec").toString();
+  if(!exec.startsWith("/")){ exec.prepend( currentfile.section("/",0,-2)+"/" ); }
+  return QUrl::fromLocalFile(exec);
+}
+
diff --git a/src-qt5/src-cpp/plugins-base.h b/src-qt5/src-cpp/plugins-base.h
new file mode 100644
index 00000000..26b0eacc
--- /dev/null
+++ b/src-qt5/src-cpp/plugins-base.h
@@ -0,0 +1,107 @@
+//===========================================
+//  Lumina-desktop source code
+//  Copyright (c) 2017, Ken Moore
+//  Available under the 3-clause BSD license
+//  See the LICENSE file for full details
+//===========================================
+// This is a simple class for managing all the various desktop
+//  screensaver plugins that could be available
+//===========================================
+//  NOTE:
+//  This class has a heirarchy-based lookup system
+//  USER plugins > SYSTEM plugins
+//  XDG_DATA_HOME/lumina-desktop/screensavers >  XDG_DATA_DIRS/lumina-desktop/screensavers
+//===========================================
+#ifndef _LUMINA_DESKTOP_BASE_PLUGINS_CLASS_H
+#define _LUMINA_DESKTOP_BASE_PLUGINS_CLASS_H
+
+#include <QJsonObject>
+#include <QString>
+#include <QUrl>
+#include <QObject>
+#include <QJsonDocument>
+#include <QJsonArray>
+#include <QFile>
+#include <QDir>
+#include <QDebug>
+
+class BasePlugin{
+protected:
+	QString currentfile;
+
+public:
+	BasePlugin();
+	virtual ~BasePlugin();
+
+	virtual void loadFile(QString path);
+	bool isLoaded() { return !data.isEmpty(); };
+  bool containsDefault(QString obj) { return data.value(obj).toObject().contains("default"); }
+
+  /**
+   * Check if the plugin is valid as long as the JSON is not empty,
+   * it contains at least a "name", "qml", and "description" object,
+   * and the "name" and "description" objects contain a "default" key. 
+  **/
+	virtual bool isValid() = 0;
+
+	virtual QString translatedObject(QString obj);
+	virtual QUrl scriptURL();
+
+	QJsonObject data; //Hazardous to manually modify
+  QString relDir;
+};
+
+class PluginSystem{
+public:
+  template <class T>
+  static T findPlugin(QString, QString);
+
+  template <class T>
+  static QList<T> findAllPlugins(QString, bool validonly=true);
+};
+
+// ===================
+// 	Base PLUGIN SYSTEM
+// ===================
+template <class T> 
+T PluginSystem::findPlugin(QString name, QString REL_DIR){
+  //qDebug() << "FindPlugin:" << name;
+  T BaseP;
+  if(name.startsWith("/") && QFile::exists(name)){ BaseP.loadFile(name); return BaseP;} //absolute path give - just load that one
+  //Cleanup the input name and ensure it has the right suffix
+  name = name.section("/",-1);
+  if(!name.endsWith(".json")){ name.append(".json"); }
+  //Get the list of directories to search
+  QStringList dirs;
+  dirs << QString(getenv("XDG_DATA_HOME")) << QString(getenv("XDG_DATA_DIRS")).split(":");
+  //Look for that file within these directories and return the first one found
+  for(int i=0; i<dirs.length(); i++){
+    if(!QFile::exists(dirs[i]+REL_DIR+"/"+name)){ continue; }
+    BaseP.loadFile(dirs[i]+REL_DIR+"/"+name);
+    if(BaseP.isValid()){ break; } //got a good one - stop here
+  }
+  return BaseP;
+}
+
+template <class T>
+QList<T> PluginSystem::findAllPlugins(QString REL_DIR, bool validonly) {
+  QList<T> LIST;
+  //Get the list of directories to search
+  QStringList dirs;
+  dirs << QString(getenv("XDG_DATA_HOME")) << QString(getenv("XDG_DATA_DIRS")).split(":");
+ //Look for that file within these directories and return the first one found
+  for(int i=0; i<dirs.length(); i++){
+    if(!QFile::exists(dirs[i]+REL_DIR)){ continue; }
+    QDir dir(dirs[i]+REL_DIR);
+    QStringList files = dir.entryList(QStringList() << "*.json", QDir::Files, QDir::Name);
+     //qDebug() << "Found Files:" << files;
+    for(int j=0; j<files.length(); j++){
+      T tmp;
+      tmp.loadFile(dir.absoluteFilePath(files[j]));
+      //qDebug() << "Loaded File:" << files[j] << tmp.isValid();
+      if(!validonly || tmp.isValid()){ LIST << tmp; }
+    }
+  }
+  return LIST;
+}
+#endif
diff --git a/src-qt5/src-cpp/plugins-base.pri b/src-qt5/src-cpp/plugins-base.pri
new file mode 100644
index 00000000..4aa9d96e
--- /dev/null
+++ b/src-qt5/src-cpp/plugins-base.pri
@@ -0,0 +1,8 @@
+HEADERS *= $${PWD}/plugins-base.h \
+  $${PWD}/plugins-screensaver.h \
+  $${PWD}/plugins-desktop.h
+SOURCES *= $${PWD}/plugins-base.cpp \
+  $${PWD}/plugins-screensaver.cpp \
+  $${PWD}/plugins-desktop.cpp
+
+INCLUDEPATH *= $${PWD}
diff --git a/src-qt5/src-cpp/plugins-desktop.cpp b/src-qt5/src-cpp/plugins-desktop.cpp
new file mode 100644
index 00000000..fdbd676d
--- /dev/null
+++ b/src-qt5/src-cpp/plugins-desktop.cpp
@@ -0,0 +1,40 @@
+//===========================================
+//  Lumina-desktop source code
+//  Copyright (c) 2017, Ken Moore
+//  Available under the 3-clause BSD license
+//  See the LICENSE file for full details
+//===========================================
+#include "plugins-desktop.h"
+
+// ============
+//    DT PLUGIN
+// ============
+DTPlugin::DTPlugin(){
+
+}
+
+DTPlugin::~DTPlugin(){
+
+}
+
+bool DTPlugin::isValid(){
+  if(data.isEmpty()){ return false; }
+  bool ok = data.contains("name") && data.contains("qml") && data.contains("description");
+  ok &= containsDefault("name");
+  ok &= containsDefault("description");
+  if(ok) {
+    QJsonObject tmp = data.value("qml").toObject();
+    QStringList mustexist;
+    QString exec = tmp.value("exec").toString();
+    if(exec.isEmpty() || !exec.endsWith(".qml")){ return false; }
+    mustexist << exec;
+    QJsonArray tmpA = data.value("additional_files").toArray();
+    for(int i=0; i<tmpA.count(); i++){ mustexist << tmpA[i].toString(); }
+    QString reldir = currentfile.section("/",0,-2) + "/";
+    for(int i=0; i<mustexist.length() && ok; i++){
+      if(mustexist[i].startsWith("/")){ ok = QFile::exists(mustexist[i]); }
+      else { ok = QFile::exists(reldir+mustexist[i]); }
+    }
+  }
+  return ok;
+}
diff --git a/src-qt5/src-cpp/plugins-desktop.h b/src-qt5/src-cpp/plugins-desktop.h
new file mode 100644
index 00000000..ed576db1
--- /dev/null
+++ b/src-qt5/src-cpp/plugins-desktop.h
@@ -0,0 +1,29 @@
+//===========================================
+//  Lumina-desktop source code
+//  Copyright (c) 2017, Ken Moore
+//  Available under the 3-clause BSD license
+//  See the LICENSE file for full details
+//===========================================
+#ifndef _LUMINA_DESKTOP_DESKTOP_PLUGINS_CLASS_H
+#define _LUMINA_DESKTOP_DESKTOP_PLUGINS_CLASS_H
+
+#include "plugins-base.h"
+#include <QJsonObject>
+#include <QString>
+#include <QUrl>
+#include <QObject>
+#include <QJsonDocument>
+#include <QJsonArray>
+#include <QFile>
+#include <QDir>
+#include <QDebug>
+
+class DTPlugin : public BasePlugin{
+public:
+	DTPlugin();
+	~DTPlugin();
+
+	virtual bool isValid() Q_DECL_OVERRIDE;
+};
+
+#endif
diff --git a/src-qt5/src-cpp/plugins-screensaver.cpp b/src-qt5/src-cpp/plugins-screensaver.cpp
index 0ceed8e8..6370b068 100644
--- a/src-qt5/src-cpp/plugins-screensaver.cpp
+++ b/src-qt5/src-cpp/plugins-screensaver.cpp
@@ -5,14 +5,6 @@
 //  See the LICENSE file for full details
 //===========================================
 #include "plugins-screensaver.h"
-#include <QJsonDocument>
-#include <QJsonArray>
-#include <QFile>
-#include <QDir>
-#include <QDebug>
-
-//Relative directory to search along the XDG paths for screensavers
-#define REL_DIR QString("/lumina-desktop/screensavers")
 
 // ============
 //    SS PLUGIN
@@ -25,25 +17,6 @@ SSPlugin::~SSPlugin(){
 
 }
 
-void SSPlugin::loadFile(QString path){
-  data = QJsonObject();
-  currentfile = path;
-  QFile file(path);
-  if(!file.exists() || !file.open(QIODevice::ReadOnly)){ return; }
-  data = QJsonDocument::fromJson(file.readAll()).object();
-  //qDebug() << "Loaded ScreenSaver Data:" << currentfile << data;
-  file.close();
-}
-
-bool SSPlugin::isLoaded(){
-  return !data.isEmpty();
-}
-
-/**
- * Check if the plugin is valid as long as the JSON is not empty,
- * it contains at least a "name", "qml", and "description" object,
- * and the "name" and "description" objects contain a "default" key. 
-**/
 bool SSPlugin::isValid(){
   if(data.isEmpty()){ return false; }
   bool ok = data.contains("name") && data.contains("qml") && data.contains("description");
@@ -65,67 +38,3 @@ bool SSPlugin::isValid(){
   }
   return ok;
 }
-
-QString SSPlugin::translatedObject(QString obj){
-  QJsonObject tmp = data.value(obj).toObject();
-  //Get the current locale
-  QString locale = getenv("LC_ALL");
-  if(locale.isEmpty()){ locale = getenv("LC_MESSAGES"); }
-  if(locale.isEmpty()){ locale = getenv("LANG"); }
-  if(locale.isEmpty()){ locale = "default"; }
-  if(locale.contains(".")){ locale = locale.section(".",0,0); } //chop any charset code off the end
-  //Now find which localized string is available and return it
-  if(tmp.contains(locale)){ return tmp.value(locale).toString(); }
-  locale = locale.section("_",0,0); //full locale not found - look for shortened form
-  if(tmp.contains(locale)){ return tmp.value(locale).toString(); }
-  return tmp.value("default").toString(); //use the default version
-}
-
-QUrl SSPlugin::scriptURL(){
-  QString exec = data.value("qml").toObject().value("exec").toString();
-  if(!exec.startsWith("/")){ exec.prepend( currentfile.section("/",0,-2)+"/" ); }
-  return QUrl::fromLocalFile(exec);
-}
-
-// ===================
-// 	SS PLUGIN SYSTEM
-// ===================
-SSPlugin SSPluginSystem::findPlugin(QString name){
-  //qDebug() << "FindPlugin:" << name;
-  SSPlugin SSP;
-  if(name.startsWith("/") && QFile::exists(name)){ SSP.loadFile(name); return SSP;} //absolute path give - just load that one
-  //Cleanup the input name and ensure it has the right suffix
-  name = name.section("/",-1);
-  if(!name.endsWith(".json")){ name.append(".json"); }
-  //Get the list of directories to search
-  QStringList dirs;
-  dirs << QString(getenv("XDG_DATA_HOME")) << QString(getenv("XDG_DATA_DIRS")).split(":");
-  //Look for that file within these directories and return the first one found
-  for(int i=0; i<dirs.length(); i++){
-    if(!QFile::exists(dirs[i]+REL_DIR+"/"+name)){ continue; }
-    SSP.loadFile(dirs[i]+REL_DIR+"/"+name);
-    if(SSP.isValid()){ break; } //got a good one - stop here
-  }
-  return SSP;
-}
-
-QList<SSPlugin> SSPluginSystem::findAllPlugins(bool validonly){
-  QList<SSPlugin> LIST;
-  //Get the list of directories to search
-  QStringList dirs;
-  dirs << QString(getenv("XDG_DATA_HOME")) << QString(getenv("XDG_DATA_DIRS")).split(":");
- //Look for that file within these directories and return the first one found
-  for(int i=0; i<dirs.length(); i++){
-    if(!QFile::exists(dirs[i]+REL_DIR)){ continue; }
-    QDir dir(dirs[i]+REL_DIR);
-    QStringList files = dir.entryList(QStringList() << "*.json", QDir::Files, QDir::Name);
-     //qDebug() << "Found Files:" << files;
-    for(int j=0; j<files.length(); j++){
-      SSPlugin tmp;
-      tmp.loadFile(dir.absoluteFilePath(files[j]));
-      //qDebug() << "Loaded File:" << files[j] << tmp.isValid();
-      if(!validonly || tmp.isValid()){ LIST << tmp; }
-    }
-  }
-  return LIST;
-}
diff --git a/src-qt5/src-cpp/plugins-screensaver.h b/src-qt5/src-cpp/plugins-screensaver.h
index 08210147..042f824d 100644
--- a/src-qt5/src-cpp/plugins-screensaver.h
+++ b/src-qt5/src-cpp/plugins-screensaver.h
@@ -4,44 +4,26 @@
 //  Available under the 3-clause BSD license
 //  See the LICENSE file for full details
 //===========================================
-// This is a simple class for managing all the various desktop
-//  screensaver plugins that could be available
-//===========================================
-//  NOTE:
-//  This class has a heirarchy-based lookup system
-//  USER plugins > SYSTEM plugins
-//  XDG_DATA_HOME/lumina-desktop/screensavers >  XDG_DATA_DIRS/lumina-desktop/screensavers
-//===========================================
 #ifndef _LUMINA_DESKTOP_SCREENSAVER_PLUGINS_CLASS_H
 #define _LUMINA_DESKTOP_SCREENSAVER_PLUGINS_CLASS_H
 
+#include "plugins-base.h"
 #include <QJsonObject>
 #include <QString>
 #include <QUrl>
 #include <QObject>
+#include <QJsonDocument>
+#include <QJsonArray>
+#include <QFile>
+#include <QDir>
+#include <QDebug>
 
-class SSPlugin{
-private:
-	QString currentfile;
-	QJsonObject data; //Hazardous to manually modify
-  bool containsDefault(QString obj) { return data.value(obj).toObject().contains("default"); }
-
+class SSPlugin : public BasePlugin {
 public:
 	SSPlugin();
 	~SSPlugin();
 
-	void loadFile(QString path);
-	bool isLoaded();
-	bool isValid();
-	QString translatedObject(QString obj);
-	QUrl scriptURL();
-};
-
-class SSPluginSystem{
-public:
-	static SSPlugin findPlugin(QString name);
-	static QList<SSPlugin> findAllPlugins(bool validonly = true);
-
+	virtual bool isValid() Q_DECL_OVERRIDE;
 };
 
 #endif