diff options
author | brettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544> | 2011-03-14 23:07:31 +0000 |
---|---|---|
committer | brettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544> | 2011-03-14 23:07:31 +0000 |
commit | bd28cf062af5f516e8c1b273577a530fc215255b (patch) | |
tree | dcca8a9cbcfe9fe961b6fef2b6a398be49a05b9e /engine | |
parent | eaf59ee54011c3dcc4ee7e344e0dd06160fd9bf4 (diff) | |
download | elgg-bd28cf062af5f516e8c1b273577a530fc215255b.tar.gz elgg-bd28cf062af5f516e8c1b273577a530fc215255b.tar.bz2 |
Fixes #2928: Invalid plugins are shown on the advance page with details about the problem and a link to the docs.
git-svn-id: http://code.elgg.org/elgg/trunk@8709 36083f99-b078-4883-b0ff-0f9b5a30f544
Diffstat (limited to 'engine')
-rw-r--r-- | engine/classes/ElggPlugin.php | 14 | ||||
-rw-r--r-- | engine/classes/ElggPluginPackage.php | 35 |
2 files changed, 34 insertions, 15 deletions
diff --git a/engine/classes/ElggPlugin.php b/engine/classes/ElggPlugin.php index 69b3b1c67..55be2b887 100644 --- a/engine/classes/ElggPlugin.php +++ b/engine/classes/ElggPlugin.php @@ -14,6 +14,7 @@ class ElggPlugin extends ElggObject { private $path; private $pluginID; + private $errorMsg = ''; /** * Set subtype to 'plugin' @@ -86,6 +87,7 @@ class ElggPlugin extends ElggObject { } catch (Exception $e) { // we always have to allow the entity to load. elgg_log("Failed to load $this->guid as a plugin. " . $e->getMessage(), 'WARNING'); + $this->errorMsg = $e->getmessage(); } } @@ -547,14 +549,17 @@ class ElggPlugin extends ElggObject { */ public function isValid() { if (!$this->getID()) { + $this->errorMsg = elgg_echo('ElggPlugin:NoId', array($this->guid)); return false; } if (!$this->package instanceof ElggPluginPackage) { + $this->errorMsg = elgg_echo('ElggPlugin:NoPluginPackagePackage', array($this->getID(), $this->guid)); return false; } if (!$this->package->isValid()) { + $this->errorMsg = $this->package->getError(); return false; } @@ -951,4 +956,13 @@ class ElggPlugin extends ElggObject { return remove_entity_relationship($this->guid, 'active_plugin', $site->guid); } } + + /** + * Returns the last error message registered. + * + * @return string|null + */ + public function getError() { + return $this->errorMsg; + } } diff --git a/engine/classes/ElggPluginPackage.php b/engine/classes/ElggPluginPackage.php index 567ec129f..59d5a95bf 100644 --- a/engine/classes/ElggPluginPackage.php +++ b/engine/classes/ElggPluginPackage.php @@ -48,7 +48,7 @@ class ElggPluginPackage { /** * An invalid plugin error. */ - private $invalidPluginError = ''; + private $errorMsg = ''; /** * Any dependencies messages @@ -122,9 +122,9 @@ class ElggPluginPackage { $this->id = $id; if ($validate && !$this->isValid()) { - if ($this->invalidPluginError) { + if ($this->errorMsg) { throw new PluginException(elgg_echo('PluginException:InvalidPlugin:Details', - array($plugin, $this->invalidPluginError))); + array($plugin, $this->errorMsg))); } else { throw new PluginException(elgg_echo('PluginException:InvalidPlugin', array($plugin))); } @@ -155,14 +155,12 @@ class ElggPluginPackage { return $this->valid; } - $valid = true; - // check required files. $have_req_files = true; foreach ($this->requiredFiles as $file) { if (!is_readable($this->path . $file)) { $have_req_files = false; - $this->invalidPluginError = + $this->errorMsg = elgg_echo('ElggPluginPackage:InvalidPlugin:MissingFile', array($file)); break; } @@ -170,23 +168,21 @@ class ElggPluginPackage { // check required files if (!$have_req_files) { - $valid = false; + return $this->valid = false; } // check for valid manifest. if (!$this->loadManifest()) { - $valid = false; + return $this->valid = false; } // can't require or conflict with yourself or something you provide. // make sure provides are all valid. if (!$this->isSaneDeps()) { - $valid = false; + return $this->valid = false; } - $this->valid = $valid; - - return $valid; + return $this->valid = true; } /** @@ -213,7 +209,7 @@ class ElggPluginPackage { foreach ($provides as $provide) { // only valid provide types if (!in_array($provide['type'], $this->providesSupportedTypes)) { - $this->invalidPluginError = + $this->errorMsg = elgg_echo('ElggPluginPackage:InvalidPlugin:InvalidProvides', array($provide['type'])); return false; } @@ -223,7 +219,7 @@ class ElggPluginPackage { foreach (array('conflicts', 'requires') as $dep_type) { foreach (${$dep_type} as $dep) { if (!in_array($dep['type'], $this->depsSupportedTypes)) { - $this->invalidPluginError = + $this->errorMsg = elgg_echo('ElggPluginPackage:InvalidPlugin:InvalidDependency', array($dep['type'])); return false; } @@ -233,7 +229,7 @@ class ElggPluginPackage { $version_compare = version_compare($provide['version'], $dep['version'], $dep['comparison']); if ($version_compare) { - $this->invalidPluginError = + $this->errorMsg = elgg_echo('ElggPluginPackage:InvalidPlugin:CircularDep', array($dep['type'], $dep['name'], $this->id)); @@ -279,6 +275,7 @@ class ElggPluginPackage { try { $this->manifest = new ElggPluginManifest($file, $this->id); } catch (Exception $e) { + $this->errorMsg = $e->getMessage(); return false; } @@ -605,4 +602,12 @@ class ElggPluginPackage { return $this->id; } + /** + * Returns the last error message. + * + * @return string + */ + public function getError() { + return $this->errorMsg; + } } |