Plugin module support, first draft.

LimeSurvey · Jan 12, 2015 · 555ae71 · 555ae71
1 parent f2195fb
commit 555ae71
Show file tree

Hide file tree

Showing 30 changed files with 496 additions and 339 deletions.
diff --git a/application/Psr4AutoloaderClass.php b/application/Psr4AutoloaderClass.php
@@ -60,7 +60,7 @@ class Psr4AutoloaderClass
      */
     public function register()
     {
-        spl_autoload_register(array($this, 'loadClass'));
+        spl_autoload_register(array($this, 'loadClass'), true, true);
     }
 
     /**

diff --git a/application/config/internal.php b/application/config/internal.php
@@ -99,14 +99,14 @@
         ),
         'pluginManager' => [
             'class' => "\\ls\\pluginmanager\\PluginManager",
-            'api' => "\\ls\\pluginmanager\\LimesurveyApi"
-
+            'api' => "\\ls\\pluginmanager\\LimesurveyApi",
+            'plugins' => require_once(__DIR__ . '/plugins.php')
         ]
-    )
+    ),
+
 );
 
 
-
 $result = CMap::mergeArray($internalConfig, $userConfig);
 /**
  * Some workarounds for erroneous settings in user config.php.

diff --git a/application/config/plugins.php b/application/config/plugins.php
@@ -0,0 +1,21 @@
+<?php
+return array (
+    'AuditLog' => 
+    array (
+        'name' => 'AuditLog',
+        'namespace' => '',
+        'description' => 'Core: Create an audit log of changes',
+        'type' => 'simple',
+        'dir' => '/home/sam/Projects/LimeSurvey/plugins/AuditLog',
+        'class' => '\\AuditLog',
+    ),
+    'ModulePlugin' => 
+    array (
+        'name' => 'ModulePlugin',
+        'namespace' => '\\befound\\ls\\ModulePlugin',
+        'description' => 'Example plugin that uses a Yii module.',
+        'type' => 'module',
+        'dir' => '/home/sam/Projects/LimeSurvey/plugins/befound/ls/ModulePlugin',
+        'class' => '\\befound\\ls\\ModulePlugin\\ModulePlugin',
+    ),
+);
diff --git a/application/controllers/PluginsController.php b/application/controllers/PluginsController.php
@@ -30,7 +30,7 @@ public function _init()
     public function accessRules()
     {
         $aRules = array(
-            array('allow', 'roles' => array('administrator')),
+            array('allow', 'roles' => array('superadmin')),
             array('allow', 'actions' => array('direct')),
             array('deny')
         );

diff --git a/application/core/LSHttpRequest.php b/application/core/LSHttpRequest.php
@@ -16,7 +16,7 @@
  * Description of HttpRequest
  *
  *
- * Used in LSYii_Application.php
+ * Used in WebApplication.php
  * <pre>
  *    'request'=>array(
  *        'class'=>'HttpRequest',

diff --git a/application/core/LSWebUser.php b/application/core/LSWebUser.php
@@ -21,15 +21,13 @@ public function __construct()
 
         public function checkAccess($operation, $params = array(), $allowCaching = true)
         {
-            if ($operation == 'administrator')
-            {
-                return Permission::model()->hasGlobalPermission('superadmin', 'read');
-            }
-            else
-            {
-                return parent::checkAccess($operation, $params, $allowCaching);
-            }
-
+            $defaults = [
+                'entity' => 'global',
+                'entity_id' => 0,
+                'crud' => 'read'
+            ];
+            $params = array_merge($defaults, $params);
+            return Permission::model()->hasPermission($params['entity_id'], $params['entity'], $operation, $params['crud']);
         }
 
         public function getStateKeyPrefix()

diff --git a/application/core/LSYii_Application.php → application/core/WebApplication.php b/application/core/LSYii_Application.php → application/core/WebApplication.php
@@ -21,8 +21,9 @@
 * Implements global  config
 * @property CLogRouter $log Log router component.
 */
-class LSYii_Application extends CWebApplication
+class WebApplication extends CWebApplication
 {
+    public $loader;
     protected $config = array();
 
     /**
@@ -39,6 +40,20 @@ class LSYii_Application extends CWebApplication
     */
     public function __construct($config = null)
     {
+        /**
+         * Load Psr4 autoloader, should be replaced by composer autoloader at some point.
+         */
+        require __DIR__ . '/../Psr4AutoloaderClass.php';
+        $this->loader = new Psr4AutoloaderClass();
+        $this->loader->register();
+        $this->loader->addNamespace('ls\\pluginmanager', __DIR__ . '/../libraries/PluginManager');
+        foreach($config['modules'] as $module) {
+            if (isset($module['namespace'], $module['dir'])) {
+                $this->loader->addNamespace($module['namespace'], $module['dir']);
+            }
+            class_exists($module['class']);
+        }
+
         parent::__construct($config);
         Yii::setPathOfAlias('bootstrap' , Yii::getPathOfAlias('ext.bootstrap'));
         // Load the default and environmental settings from different files into self.
@@ -130,7 +145,7 @@ public function setConfig($name, $value)
      *
      * @param string $message
      * @param string $type
-     * @return LSYii_Application Provides a fluent interface
+     * @return WebApplication Provides a fluent interface
      */
     public function setFlashMessage($message,$type='default')
     {
@@ -204,6 +219,6 @@ public function getPluginManager()
         return $this->getComponent('pluginManager');
     }
 
-
+   
 }
 
diff --git a/application/core/plugins/AuthLDAP/AuthLDAP.php b/application/core/plugins/AuthLDAP/AuthLDAP.php
@@ -1,4 +1,5 @@
 <?php
+use ls\pluginmanager\AuthPluginBase;
 class AuthLDAP extends AuthPluginBase
 {
     protected $storage = 'DbStorage';
@@ -86,8 +87,8 @@ class AuthLDAP extends AuthPluginBase
                 )
     );
 
-    public function __construct(PluginManager $manager, $id) {
-        parent::__construct($manager, $id);
+    public function init() 
+    {
 
         /**
          * Here you should handle subscribing to the events your plugin will handle
@@ -176,7 +177,7 @@ public function newUserSession()
 
         if ($user === null && $this->autoCreate === false)
         {
-            // If the user doesnt exist ín the LS database, he can not login
+            // If the user doesnt exist �n the LS database, he can not login
             $this->setAuthFailure(self::ERROR_USERNAME_INVALID);
             return;
         }

diff --git a/application/core/plugins/Authdb/Authdb.php b/application/core/plugins/Authdb/Authdb.php
@@ -1,6 +1,5 @@
 <?php
 use ls\pluginmanager\AuthPluginBase;
-use ls\pluginmanager\PluginManager;
 
 class Authdb extends AuthPluginBase
 {
@@ -10,10 +9,8 @@ class Authdb extends AuthPluginBase
     static protected $description = 'Core: Database authentication + exports';
     static protected $name = 'LimeSurvey internal database';
 
-    public function __construct(PluginManager $manager, $id)
+    public function init()
     {
-        parent::__construct($manager, $id);
-
         /**
          * Here you should handle subscribing to the events your plugin will handle
          */

diff --git a/application/core/plugins/Authwebserver/Authwebserver.php b/application/core/plugins/Authwebserver/Authwebserver.php
@@ -1,4 +1,6 @@
 <?php
+use ls\pluginmanager\AuthPluginBase;
+
 class Authwebserver extends AuthPluginBase
 {
     protected $storage = 'DbStorage';    
@@ -23,9 +25,8 @@ class Authwebserver extends AuthPluginBase
                 )
     );
 
-    public function __construct(PluginManager $manager, $id) {
-        parent::__construct($manager, $id);
-
+    public function init() 
+    {
         /**
          * Here you should handle subscribing to the events your plugin will handle
          */

diff --git a/application/core/plugins/ExportR/ExportR.php b/application/core/plugins/ExportR/ExportR.php
@@ -1,13 +1,15 @@
 <?php
+use ls\pluginmanager\PluginBase;
+
 class ExportR extends PluginBase {
 
     protected $storage = 'DbStorage';
 
     static protected $description = 'Core: R-export';
     static protected $name = 'Export results to R';
 
-    public function __construct(PluginManager $manager, $id) {
-        parent::__construct($manager, $id);
+    public function init() 
+    {
 
         /**
          * Here you should handle subscribing to the events your plugin will handle

diff --git a/application/core/plugins/ExportSTATAxml/ExportSTATAxml.php b/application/core/plugins/ExportSTATAxml/ExportSTATAxml.php
@@ -1,13 +1,14 @@
 <?php
+use ls\pluginmanager\PluginBase;
 class ExportSTATAxml extends PluginBase {
 
     protected $storage = 'DbStorage';
 
     static protected $description = 'Core: Export survey results to a STATA xml file';
     static protected $name = 'STATA Export';
 
-    public function __construct(PluginManager $manager, $id) {
-        parent::__construct($manager, $id);
+    public function init()
+    {
 
         /**
          * Here you should handle subscribing to the events your plugin will handle

diff --git a/application/helpers/globals.php b/application/helpers/globals.php
@@ -8,7 +8,7 @@
 
     /**
      * Helper function to replace calls to Yii::app() and enable correct code completion.
-     * @return LSYii_Application
+     * @return WebApplication
      */
     function App()
     {