path: root/includes/classes/class_module.php

<?php
/**
 * Classes and libraries for module system
 *
 * webtrees: Web based Family History software
 * Copyright (C) 2010 webtrees development team.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * @package webtrees
 * @subpackage Modules
 * @version $Id$
 */

if (!defined('WT_WEBTREES')) {
	header('HTTP/1.0 403 Forbidden');
	exit;
}

define('WT_CLASS_MODULE_PHP', '');

// Modules can optionally implement the following interfaces.
interface WT_Module_Block {
	public function getBlock($block_id);
	public function loadAjax();
	public function isUserBlock();
	public function isGedcomBlock();
	public function configureBlock($block_id);
}

interface WT_Module_Chart {
	public function getChart();
}

interface WT_Module_Config {
	public function getConfigLink();
}

interface WT_Module_Menu {
	public function defaultMenuOrder();
}

interface WT_Module_Report {
	public function getReportMenus();
}

interface WT_Module_Sidebar {
	public function defaultSidebarOrder();
	public function getSidebarContent();
	public function getSidebarAjaxContent();
	public function hasSidebarContent();
}

interface WT_Module_Tab {
	public function defaultTabOrder();
	public function getTabContent();
	public function hasTabContent();
	public function canLoadAjax();
	public function getPreLoadContent();
	public function getJSCallback();
}

interface WT_Module_Theme {
	public function getTheme();
}

abstract class WT_Module {
	// Each module must provide the following functions
	abstract public function getTitle();       // To label tabs, etc.
	abstract public function getDescription(); // A sentence describing what this module does

	// This is the default for the module and all its components.
	public function defaultAccessLevel() {
		// Returns one of: WT_PRIV_HIDE, WT_PRIV_PUBLIC, WT_PRIV_USER, WT_PRIV_ADMIN
		return WT_PRIV_PUBLIC;
	}

	// This is an internal name, used to generate identifiers
	final public function getName() {
		return str_replace('_WT_Module', '', get_class($this));
	}

	// Some modules may use the page's controller
	protected $controller;
	final public function &getController()   { return $this->controller; }
	final public function setController(&$c) { $this->controller=$c;     }

	// Run an action specified on the URL through module.php?mod=FOO&mod_action=BAR
	public function modAction($mod_action) {
	}

	final static public function getActiveModules() {
		$module_names=WT_DB::prepare(
			"SELECT module_name".
			" FROM `##module`".
			" WHERE status='enabled'".
			" ORDER BY module_name"
		)->fetchOneColumn();
		$array=array();
		foreach ($module_names as $module_name) {
			if (file_exists(WT_ROOT.'modules/'.$module_name.'/module.php')) {
				require_once WT_ROOT.'modules/'.$module_name.'/module.php';
				$class=$module_name.'_WT_Module';
				$array[$module_name]=new $class();
			} else {
				// Module has been deleted from disk?  Remove it from the database.
				AddToLog("Module {$module_name} has been deleted from disk - deleting from database", 'config');
				WT_DB::prepare("DELETE FROM `##module_privacy` WHERE module_name=?")->execute(array($module_name));
				WT_DB::prepare("DELETE FROM `##module_setting` WHERE module_name=?")->execute(array($module_name));
				WT_DB::prepare("DELETE `##block_setting` FROM `##block` JOIN `##block_setting` USING (block_id) WHERE module_name=?")->execute(array($module_name));
				WT_DB::prepare("DELETE FROM `##block`          WHERE module_name=?")->execute(array($module_name));
				WT_DB::prepare("DELETE FROM `##module`         WHERE module_name=?")->execute(array($module_name));
			}
		}
		return $array;
	}

	final static private function getActiveModulesByComponent($component, $ged_id, $access_level) {
		$module_names=WT_DB::prepare(
			"SELECT module_name".
			" FROM `##module`".
			" JOIN `##module_privacy` USING (module_name)".
			" WHERE gedcom_id=? AND component=? AND status='enabled' AND access_level>=?".
			" ORDER BY CASE component WHEN 'menu' THEN menu_order WHEN 'sidebar' THEN sidebar_order WHEN 'tab' THEN tab_order ELSE 0 END, module_name"
		)->execute(array($ged_id, $component, $access_level))->fetchOneColumn();
		$array=array();
		foreach ($module_names as $module_name) {
			if (file_exists(WT_ROOT.'modules/'.$module_name.'/module.php')) {
				require_once WT_ROOT.'modules/'.$module_name.'/module.php';
				$class=$module_name.'_WT_Module';
				$array[$module_name]=new $class();
			} else {
				// Module has been deleted from disk?  Remove it from the database.
				AddToLog("Module {$module_name} has been deleted from disk - deleting from database", 'config');
				WT_DB::prepare("DELETE FROM `##module_privacy` WHERE module_name=?")->execute(array($module_name));
				WT_DB::prepare("DELETE FROM `##module` WHERE module_name=?")->execute(array($module_name));
			}
		}
		if ($component!='menu' && $component!='sidebar' && $component!='tab') {
			uasort($array, create_function('$x,$y', 'return utf8_strcasecmp($x->getTitle(), $y->getTitle());'));
		}
		return $array;
	}

	// Get a list of all the active, authorised blocks
	final static public function getActiveBlocks($ged_id=WT_GED_ID, $access_level=WT_USER_ACCESS_LEVEL) {
		static $blocks=null;
		if ($blocks===null) {
			$blocks=self::getActiveModulesByComponent('block', $ged_id, $access_level);
		}
		return $blocks;
	}

	// Get a list of all the active, authorised charts
	final static public function getActiveCharts($ged_id=WT_GED_ID, $access_level=WT_USER_ACCESS_LEVEL) {
		static $charts=null;
		if ($charts===null) {
			$charts=self::getActiveModulesByComponent('chart', $ged_id, $access_level);
		}
		return $charts;
	}

	// Get a list of all the active, authorised menus
	final static public function getActiveMenus($ged_id=WT_GED_ID, $access_level=WT_USER_ACCESS_LEVEL) {
		static $menus=null;
		if ($menus===null) {
			$menus=self::getActiveModulesByComponent('menu', $ged_id, $access_level);
		}
		return $menus;
	}

	// Get a list of all the active, authorised reports
	final static public function getActiveReports($ged_id=WT_GED_ID, $access_level=WT_USER_ACCESS_LEVEL) {
		static $reports=null;
		if ($reports===null) {
			$reports=self::getActiveModulesByComponent('report', $ged_id, $access_level);
		}
		return $reports;
	}

	// Get a list of all the active, authorised sidebars
	final static public function getActiveSidebars($ged_id=WT_GED_ID, $access_level=WT_USER_ACCESS_LEVEL) {
		static $sidebars=null;
		if ($sidebars===null) {
			$sidebars=self::getActiveModulesByComponent('sidebar', $ged_id, $access_level);
		}
		return $sidebars;
	}

	// Get a list of all the active, authorised tabs
	final static public function getActiveTabs($ged_id=WT_GED_ID, $access_level=WT_USER_ACCESS_LEVEL) {
		static $tabs=null;
		if ($tabs===null) {
			$tabs=self::getActiveModulesByComponent('tab', $ged_id, $access_level);
		}
		return $tabs;
	}

	// Get a list of all the active, authorised themes
	final static public function getActiveThemes($ged_id=WT_GED_ID, $access_level=WT_USER_ACCESS_LEVEL) {
		static $themes=null;
		if ($themes===null) {
			$themes=self::getActiveModulesByComponent('theme', $ged_id, $access_level);
		}
		return $themes;
	}

	// Get installed modules
	final static public function getInstalledModules() {
		static $modules=null;
		if ($modules===null) {
			$dir=opendir(WT_ROOT.'modules');
			while (($file=readdir($dir))!==false) {
				if (preg_match('/^[a-zA-Z0-9_]+$/', $file) && file_exists(WT_ROOT.'modules/'.$file.'/module.php')) {
					require_once WT_ROOT.'modules/'.$file.'/module.php';
					$class=$file.'_WT_Module';
					$modules[$file]=new $class();
				}
			}
			uasort($modules, create_function('$x,$y', 'return utf8_strcasecmp($x->getTitle(), $y->getTitle());'));
		}
		return $modules;
	}

	// Get installed blocks
	final static public function getInstalledBlocks() {
		$modules=array();
		foreach (self::getInstalledModules() as $name=>$module) {
			if ($module instanceof WT_Module_Block) {
				$modules[$name]=$module;
			}
		}
		return $modules;
	}

	// Get installed charts
	final static public function getInstalledCharts() {
		$modules=array();
		foreach (self::getInstalledModules() as $name=>$module) {
			if ($module instanceof WT_Module_Chart) {
				$modules[$name]=$module;
			}
		}
		return $modules;
	}

	// Get installed menus
	final static public function getInstalledMenus() {
		$modules=array();
		foreach (self::getInstalledModules() as $name=>$module) {
			if ($module instanceof WT_Module_Menu) {
				$module->sort=WT_DB::prepare(
					"SELECT menu_order FROM `##module` WHERE module_name=?"
				)->execute(array($module->getName()))->fetchOne();
				$modules[$name]=$module;
			}
		}
		usort($modules, create_function('$x,$y', 'return $x->sort - $y->sort;'));
		return $modules;
	}

	// Get installed reports
	final static public function getInstalledReports() {
		$modules=array();
		foreach (self::getInstalledModules() as $name=>$module) {
			if ($module instanceof WT_Module_Report) {
				$modules[$name]=$module;
			}
		}
		return $modules;
	}

	// Get installed sidebars
	final static public function getInstalledSidebars() {
		$modules=array();
		foreach (self::getInstalledModules() as $name=>$module) {
			if ($module instanceof WT_Module_Sidebar) {
				$module->sort=WT_DB::prepare(
					"SELECT sidebar_order FROM `##module` WHERE module_name=?"
				)->execute(array($module->getName()))->fetchOne();
				$modules[$name]=$module;
			}
		}
		usort($modules, create_function('$x,$y', 'return $x->sort - $y->sort;'));
		return $modules;
	}

	// Get installed tabs
	final static public function getInstalledTabs() {
		$modules=array();
		foreach (self::getInstalledModules() as $name=>$module) {
			if ($module instanceof WT_Module_Tab) {
				$module->sort=WT_DB::prepare(
					"SELECT tab_order FROM `##module` WHERE module_name=?"
				)->execute(array($module->getName()))->fetchOne();
				$modules[$name]=$module;
			}
		}
		usort($modules, create_function('$x,$y', 'return $x->sort - $y->sort;'));
		return $modules;
	}

	// Get installed themes
	final static public function getInstalledThemes() {
		$modules=array();
		foreach (self::getInstalledModules() as $name=>$module) {
			if ($module instanceof WT_Module_Theme) {
				$modules[$name]=$module;
			}
		}
		return $modules;
	}

	//
	final static public function setDefaultAccess($ged_id) {
		foreach (self::getInstalledModules() as $module) {
			WT_DB::prepare("INSERT IGNORE INTO `##module` (module_name, menu_order, sidebar_order, tab_order) VALUES (?, ?, ?, ?)")
				->execute(array(
					$module->getName(),
					$module instanceof WT_Module_Menu    ? $module->defaultMenuOrder   () : null,
					$module instanceof WT_Module_Sidebar ? $module->defaultSidebarOrder() : null,
					$module instanceof WT_Module_Tab     ? $module->defaultTabOrder    () : null
				));
		}
		WT_DB::prepare("DELETE FROM `##module_privacy` WHERE gedcom_id=?")->execute(array($ged_id));
		foreach (self::getInstalledMenus() as $module) {
			WT_DB::prepare(
				"INSERT INTO `##module_privacy` (module_name, gedcom_id, component, access_level) VALUES (?, ?, 'menu', ?)"
			)->execute(array($module->getName(), $ged_id, $module->defaultAccessLevel()));
		}
		foreach (self::getInstalledSidebars() as $module) {
			WT_DB::prepare(
				"INSERT INTO `##module_privacy` (module_name, gedcom_id, component, access_level) VALUES (?, ?, 'sidebar', ?)"
			)->execute(array($module->getName(), $ged_id, $module->defaultAccessLevel()));
		}
		foreach (self::getInstalledTabs() as $module) {
			WT_DB::prepare(
				"INSERT INTO `##module_privacy` (module_name, gedcom_id, component, access_level) VALUES (?, ?, 'tab', ?)"
			)->execute(array($module->getName(), $ged_id, $module->defaultAccessLevel()));
		}
		foreach (self::getInstalledBlocks() as $module) {
			WT_DB::prepare(
				"INSERT INTO `##module_privacy` (module_name, gedcom_id, component, access_level) VALUES (?, ?, 'block', ?)"
			)->execute(array($module->getName(), $ged_id, $module->defaultAccessLevel()));
		}
		foreach (self::getInstalledCharts() as $module) {
			WT_DB::prepare(
				"INSERT INTO `##module_privacy` (module_name, gedcom_id, component, access_level) VALUES (?, ?, 'charts', ?)"
			)->execute(array($module->getName(), $ged_id, $module->defaultAccessLevel()));
		}
		foreach (self::getInstalledReports() as $module) {
			WT_DB::prepare(
				"INSERT INTO `##module_privacy` (module_name, gedcom_id, component, access_level) VALUES (?, ?, 'report', ?)"
			)->execute(array($module->getName(), $ged_id, $module->defaultAccessLevel()));
		}
		foreach (self::getInstalledThemes() as $module) {
			WT_DB::prepare(
				"INSERT INTO `##module_privacy` (module_name, gedcom_id, component, access_level) VALUES (?, ?, 'theme', ?)"
			)->execute(array($module->getName(), $ged_id, $module->defaultAccessLevel()));
		}
	}
}