class.extensionmanager.php

/symphony/lib/toolkit/class.extensionmanager.php

https://github.com/scottkf/nicholscommunications
PHP | 483 lines | 321 code | 140 blank | 22 comment | 75 complexity | 99cf637f9bfb00c0d523633207ceaad3 MD5 | raw file

<?php

	include_once(TOOLKIT . '/class.manager.php');
	include_once(TOOLKIT . '/class.extension.php');

	define_safe('EXTENSION_ENABLED', 10);
	define_safe('EXTENSION_DISABLED', 11);
	define_safe('EXTENSION_NOT_INSTALLED', 12);
	define_safe('EXTENSION_REQUIRES_UPDATE', 13);

    Class ExtensionManager extends Manager{

		static private $_enabled_extensions = NULL;
		static private $_subscriptions = NULL;
		static private $_extensions = NULL;

        function __getClassName($name){
	        return 'extension_' . $name;
        }

        function __getClassPath($name){
	        return EXTENSIONS . strtolower("/$name");
        }

        function __getDriverPath($name){
	        return $this->__getClassPath($name) . '/extension.driver.php';
        }

        public function getClassPath($name){
	        return EXTENSIONS . strtolower("/$name");
        }

		private function __buildExtensionList() {
			if (self::$_extensions == NULL) {
				$extensions = Symphony::Database()->fetch("SELECT * FROM `tbl_extensions`");
				foreach($extensions as $extension) {
					self::$_extensions[$extension['name']] = $extension;
				}
			}
		}

		public function sortByStatus($s1, $s2){

			if($s1['status'] == EXTENSION_ENABLED) $status_s1 = 2;
			elseif(in_array($s1['status'], array(EXTENSION_DISABLED, EXTENSION_NOT_INSTALLED, EXTENSION_REQUIRES_UPDATE))) $status_s1 = 1;
			else $status_s1 = 0;

			if($s2['status'] == EXTENSION_ENABLED) $status_s2 = 2;
			elseif(in_array($s2['status'], array(EXTENSION_DISABLED, EXTENSION_NOT_INSTALLED, EXTENSION_REQUIRES_UPDATE))) $status_s2 = 1;
			else $status_s2 = 0;

			return $status_s2 - $status_s1;
		}

		public function sortByName($a, $b) {
			return strnatcasecmp($a['name'], $b['name']);
		}

		public function enable($name){
			if(false == ($obj =& $this->create($name))){
				trigger_error(__('Could not %1$s %2$s, there was a problem loading the object. Check the driver class exists.', array(__FUNCTION__, $name)), E_USER_WARNING);
				return false;
			}

			## If not installed, install it
			if($this->__requiresInstallation($name) && $obj->install() === false){
				return false;
			}

			## If requires and upate before enabling, than update it first
			elseif(($about = $this->about($name)) && ($previousVersion = $this->__requiresUpdate($about)) !== false) $obj->update($previousVersion);

			$id = $this->registerService($name);

			## Now enable the extension
			$obj->enable();

			unset($obj);

			return true;

		}

		public function disable($name){

			if(false == ($obj =& $this->create($name))){
				trigger_error(__('Could not %1$s %2$s, there was a problem loading the object. Check the driver class exists.', array(__FUNCTION__, $name)), E_USER_ERROR);
				return false;
			}

			$this->__canUninstallOrDisable($obj);

			$id = $this->registerService($name, false);

			$obj->disable();
			unset($obj);

			$this->pruneService($name, true);

			return true;
		}

		public function uninstall($name){

			if(false == ($obj =& $this->create($name))){
				trigger_error(__('Could not %1$s %2$s, there was a problem loading the object. Check the driver class exists.', array(__FUNCTION__, $name)), E_USER_WARNING);
				return false;
			}
			
			$this->__canUninstallOrDisable($obj);

			$obj->uninstall();
			unset($obj);

			$this->pruneService($name);

			return true;
		}
		
		private function __canUninstallOrDisable(Extension $obj){
			
			// Make sure, if this extension has provided Fields, Data Sources or Events, that they aren't in use
			$extension_handle = strtolower(preg_replace('/^extension_/i', NULL, get_class($obj)));

			// Fields:
			if(is_dir(EXTENSIONS . "/{$extension_handle}/fields")){
				foreach(glob(EXTENSIONS . "/{$extension_handle}/fields/field.*.php") as $file){
					$type = preg_replace(array('/^field\./i', '/\.php$/i'), NULL, basename($file));
					if(Symphony::Database()->fetchVar('count', 0, "SELECT COUNT(*) AS `count` FROM `tbl_fields` WHERE `type` = '{$type}'") > 0){
						$about = $obj->about();
						throw new Exception(
							__(
								"The field '%s', provided by the Extension '%s', is currently in use. Please remove it from your sections prior to uninstalling or disabling.",
								array(basename($file), $about['name'])
							)
						);
					}
				}
			}
			
			// Data Sources:
			if(is_dir(EXTENSIONS . "/{$extension_handle}/data-sources")){
				foreach(glob(EXTENSIONS . "/{$extension_handle}/data-sources/data.*.php") as $file){
				
					$handle = preg_replace(array('/^data\./i', '/\.php$/i'), NULL, basename($file));
					if(Symphony::Database()->fetchVar('count', 0, "SELECT COUNT(*) AS `count` FROM `tbl_pages` WHERE `data_sources` REGEXP '[[:<:]]{$handle}[[:>:]]' ") > 0){
						$about = $obj->about();
						throw new Exception(
							__(
								"The Data Source '%s', provided by the Extension '%s', is currently in use. Please remove it from your pages prior to uninstalling or disabling.",
								array(basename($file), $about['name'])
							)
						);
					}
				}				
			}
			
			// Events
			if(is_dir(EXTENSIONS . "/{$extension_handle}/events")){
				foreach(glob(EXTENSIONS . "/{$extension_handle}/events/event.*.php") as $file){
					$handle = preg_replace(array('/^event\./i', '/\.php$/i'), NULL, basename($file));
					if(Symphony::Database()->fetchVar('count', 0, "SELECT COUNT(*) AS `count` FROM `tbl_pages` WHERE `events` REGEXP '[[:<:]]{$handle}[[:>:]]' ") > 0){
						$about = $obj->about();
						throw new Exception(
							__(
								"The Event '%s', provided by the Extension '%s', is currently in use. Please remove it from your pages prior to uninstalling or disabling.",
								array(basename($file), $about['name'])
							)
						);
					}
				}				
			}
		}
		
		public function fetchStatus($name){	
			$this->__buildExtensionList();
			
			$status = self::$_extensions[$name]['status'];
			
			if(!$status) return EXTENSION_NOT_INSTALLED;			
			if($status == 'enabled') return EXTENSION_ENABLED;
			
			return EXTENSION_DISABLED;
		}

		public function pruneService($name, $delegates_only=false){

	        $classname = $this->__getClassName($name);
	        $path = $this->__getDriverPath($name);

			if(!@file_exists($path)) return false;

			$delegates = Symphony::Database()->fetchCol('id', "SELECT tbl_extensions_delegates.`id` FROM `tbl_extensions_delegates`
											 LEFT JOIN `tbl_extensions` ON (`tbl_extensions`.id = `tbl_extensions_delegates`.extension_id)
											 WHERE `tbl_extensions`.name = '$name'");

			if(!empty($delegates)) Symphony::Database()->delete('tbl_extensions_delegates', " `id` IN ('". implode("', '", $delegates). "') ");

			if(!$delegates_only) Symphony::Database()->delete('tbl_extensions', " `name` = '$name' ");

			## Remove the unused DB records
			$this->__cleanupDatabase();

			return true;
		}

		public function registerService($name, $enable=true){

	        $classname = $this->__getClassName($name);
	        $path = $this->__getDriverPath($name);

			if(!@file_exists($path)) return false;

			require_once($path);

			$subscribed = call_user_func(array(&$classname, "getSubscribedDelegates"));

			if($existing_id = $this->fetchExtensionID($name))
				Symphony::Database()->delete('tbl_extensions_delegates', " `extension_id` = '$existing_id' ");

			Symphony::Database()->delete('tbl_extensions', " `name` = '$name' ");

			$info = $this->about($name);

			Symphony::Database()->insert(
				array(
					'name' => $name,
					'status' => ($enable ? 'enabled' : 'disabled'),
					'version' => $info['version']
				),
				'tbl_extensions'
			);

			$id = Symphony::Database()->getInsertID();

			if(is_array($subscribed) && !empty($subscribed)){
				foreach($subscribed as $s){

					Symphony::Database()->insert(
						array(
							'extension_id' => $id,
							'page' => $s['page'],
							'delegate' => $s['delegate'],
							'callback' => $s['callback']
						),
						'tbl_extensions_delegates'
					);

				}
			}

			## Remove the unused DB records
			$this->__cleanupDatabase();

			return $id;
		}

		public function listInstalledHandles(){
			if(is_null(self::$_enabled_extensions)) {
				self::$_enabled_extensions = Symphony::Database()->fetchCol('name',
					"SELECT `name` FROM `tbl_extensions` WHERE `status` = 'enabled'"
				);
			}
			return self::$_enabled_extensions;
		}

        ## Will return a list of all extensions and their about information
        public function listAll(){

			$extensions = array();
			$result = array();
	        $structure = General::listStructure(EXTENSIONS, array(), false, 'asc', EXTENSIONS);

	        $extensions = $structure['dirlist'];

	        if(is_array($extensions) && !empty($extensions)){
		        foreach($extensions as $e){
					if($about = $this->about($e)) $result[$e] = $about;
		        }
	        }

			return $result;
        }

        public function notifyMembers($delegate, $page, $context=array()){

	        if((int)Symphony::Configuration()->get('allow_page_subscription', 'symphony') != 1) return;

			if (is_null(self::$_subscriptions)) {
				self::$_subscriptions = Symphony::Database()->fetch("
					SELECT t1.name, t2.page, t2.delegate, t2.callback
					FROM `tbl_extensions` as t1 INNER JOIN `tbl_extensions_delegates` as t2 ON t1.id = t2.extension_id
					WHERE t1.status = 'enabled'");
			}

			// Make sure $page is an array
			if(!is_array($page)){

				// Support for pseudo-global delegates (including legacy support for /administration/)
				if(preg_match('/\/?(administration|backend)\/?/', $page)){
					$page = array(
						'backend', '/backend/',
						'administration', '/administration/'
					);
				}

				else{
					$page = array($page);
				}
			}

			// Support for global delegate subscription
			if(!in_array('*', $page)){
				$page[] = '*';
			}

			$services = null;
			foreach(self::$_subscriptions as $subscription) {
				foreach($page as $p) {
					if ($p == $subscription['page'] && $delegate == $subscription['delegate']) {
						if (!is_array($services)) $services = array();
						$services[] = $subscription;
					}
				}
			}

			if(!is_array($services) || empty($services)) return NULL;

	        $context += array('parent' => &$this->_Parent, 'page' => $page, 'delegate' => $delegate);

			foreach($services as $s){

				$obj = $this->create($s['name']);

				if(is_object($obj) && in_array($s['callback'], get_class_methods($obj))){
					$obj->{$s['callback']}($context);
					unset($obj);
				}

			}

        }

        ## Creates a new object and returns a pointer to it
        public function create($name, $param=array(), $slient=false){

			if(!is_array(self::$_pool)) $this->flush();

			if(!isset(self::$_pool[$name])){
		        $classname = $this->__getClassName($name);
		        $path = $this->__getDriverPath($name);

		        if(!is_file($path)){
			        if(!$slient) trigger_error(__('Could not find extension at location %s', array($path)), E_USER_ERROR);
			        return false;
		        }

				if(!class_exists($classname)) require_once($path);

				if(!is_array($param)) $param = array();

				if(!isset($param['parent'])) $param['parent'] =& $this->_Parent;

				##Create the object
				self::$_pool[$name] = new $classname($param);
			}

			return self::$_pool[$name];

        }

		## Return object instance of a named extension
		public function getInstance($name){

			$extensions = $this->_pool;

			foreach($extensions as $e){
				if(get_class($e) == $name) return $e;
			}

		}

		private function __requiresUpdate($info){

			if($info['status'] == EXTENSION_NOT_INSTALLED) return false;

			$current_version = $this->fetchInstalledVersion($info['handle']);

			return (version_compare($current_version, $info['version'], '<') ? $current_version : false);
		}

		private function __requiresInstallation($name){
			$this->__buildExtensionList();			
			$id = self::$_extensions[$name]['id'];
			return (is_numeric($id) ? false : true);
		}


		public function fetchInstalledVersion($name){
			$this->__buildExtensionList();
			return $id = self::$_extensions[$name]['version'];
		}

		public function fetchExtensionID($name){
			$this->__buildExtensionList();
			return $id = self::$_extensions[$name]['id'];
		}

		public function fetchCustomMenu($name){

		    $classname = $this->__getClassName($name);

			if(!class_exists($classname)){

		        $path = $this->__getDriverPath($name);

				if(!@file_exists($path)) return false;

				require_once($path);
			}

			return @call_user_func(array(&$classname, 'fetchCustomMenu'));
		}

        ## Returns the about details of a service
        public function about($name){

	        $classname = $this->__getClassName($name);
	        $path = $this->__getDriverPath($name);

			if(!@file_exists($path)) return false;

			require_once($path);

	        if($about = @call_user_func(array(&$classname, "about"))){

				$about['handle'] = $name;
				$about['status'] = $this->fetchStatus($name);

				$nav = @call_user_func(array(&$classname, 'fetchNavigation'));

				if($nav != NULL) $about['navigation'] = $nav;

				if($this->__requiresUpdate($about)) $about['status'] = EXTENSION_REQUIRES_UPDATE;

				return $about;
			}

			return false;

        }

		private function __cleanupDatabase(){

			## Grab any extensions sitting in the database
			$rows = Symphony::Database()->fetch("SELECT `name` FROM `tbl_extensions`");

			## Iterate over each row
			if(is_array($rows) && !empty($rows)){
				foreach($rows as $r){
					$name = $r['name'];

					## Grab the install location
					$path = $this->__getClassPath($name);

					## If it doesnt exist, remove the DB rows
					if(!@is_dir($path)){

						if($existing_id = $this->fetchExtensionID($name))
							Symphony::Database()->delete("tbl_extensions_delegates", " `extension_id` = $existing_id ");

						Symphony::Database()->delete('tbl_extensions', " `name` = '$name' LIMIT 1");

					}
				}
			}

			## Remove old delegate information
			$disabled = Symphony::Database()->fetchCol('id', "SELECT `id` FROM `tbl_extensions` WHERE `status` = 'disabled'");
			if(!empty($disabled)) Symphony::Database()->delete('tbl_extensions_delegates', " `extension_id` IN ('". implode("', '", $disabled). "') ");
		}

    }