Files
gallery3/core/helpers/module.php
Tim Almdal 9b68fd46b2 Add the ability for modules to define hooks. The challenge is that
when the hooks are run, we haven't added all the installed modules to
the path, So if a module defines a hook it will never be run.

This change runs any module defined hooks as part of the gallery initialization.
2009-03-03 16:09:23 +00:00

278 lines
8.4 KiB
PHP

<?php defined("SYSPATH") or die("No direct script access.");
/**
* Gallery - a web based photo album viewer and editor
* Copyright (C) 2000-2008 Bharat Mediratta
*
* 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., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
*/
/**
* This is the API for handling modules.
*
* Note: by design, this class does not do any permission checking.
*/
class module_Core {
public static $module_names = array();
public static $modules = array();
static function get_version($module_name) {
return ORM::factory("module")->where("name", $module_name)->find()->version;
}
/**
* Set the version of the corresponding Module_Model
* @param string $module_name
* @param integer $version
*/
static function set_version($module_name, $version) {
$module = ORM::factory("module")->where("name", $module_name)->find();
if (!$module->loaded) {
$module->name = $module_name;
}
$module->version = 1;
$module->save();
Kohana::log("debug", "$module_name: version is now $version");
}
/**
* Load the corresponding Module_Model
* @param string $module_name
*/
static function get($module_name) {
return model_cache::get("module", $module_name, "name");
}
/**
* Delete the corresponding Module_Model
* @param string $module_name
*/
static function delete($module_name) {
$module = ORM::factory("module")->where("name", $module_name)->find();
if ($module->loaded) {
$db = Database::instance();
$db->delete("graphics_rules", array("module_name" => $module->name));
$module->delete();
// We could delete the module vars here too, but it's nice to leave them around in case the
// module gets reinstalled.
Kohana::log("debug", "$module_name: module deleted");
}
}
/**
* Check to see if a module is installed
* @param string $module_name
*/
static function is_installed($module_name) {
return !empty(self::$module_names[$module_name]);
}
/**
* Return the list of installed modules.
*/
static function installed() {
return self::$modules;
}
/**
* Return the list of available modules.
*/
static function available() {
$modules = new ArrayObject(array(), ArrayObject::ARRAY_AS_PROPS);
foreach (array_merge(array("core/module.info"), glob(MODPATH . "*/module.info")) as $file) {
$module_name = basename(dirname($file));
$modules->$module_name = new ArrayObject(parse_ini_file($file), ArrayObject::ARRAY_AS_PROPS);
$modules->$module_name->installed =
empty(self::$modules[$module_name]) ?
null : self::$modules[$module_name]->version;
$modules->$module_name->locked = false;
}
// Lock certain modules
$modules->core->locked = true;
$modules->user->locked = true;
$modules->ksort();
return $modules;
}
/**
* Install a module.
*/
static function install($module_name) {
$installer_class = "{$module_name}_installer";
Kohana::log("debug", "$installer_class install (initial)");
if ($module_name != "core") {
require_once(DOCROOT . "modules/${module_name}/helpers/{$installer_class}.php");
}
$kohana_modules = Kohana::config("core.modules");
$kohana_modules[] = MODPATH . $module_name;
Kohana::config_set("core.modules", $kohana_modules);
if (method_exists($installer_class, "install")) {
call_user_func_array(array($installer_class, "install"), array());
}
self::load_modules();
log::success("module", t("Installed module %module_name", array("module_name" => $module_name)));
}
/**
* Uninstall a module.
*/
static function uninstall($module_name) {
$installer_class = "{$module_name}_installer";
Kohana::log("debug", "$installer_class uninstall");
call_user_func(array($installer_class, "uninstall"));
log::success("module", t("Uninstalled module %module_name", array("module_name" => $module_name)));
}
/**
* Load the active modules. This is called at bootstrap time.
*/
static function load_modules() {
// Reload module list from the config file since we'll do a refresh after calling install()
$core = Kohana::config_load("core");
$kohana_modules = $core["modules"];
self::$module_names = array();
self::$modules = array();
// This is one of the first database operations that we'll do, so it may fail if there's no
// install yet. Try to handle this situation gracefully expecting that the scaffolding will
// Do The Right Thing.
// Reverting from installer stage 1.
// @todo get rid of this extra error checking when we have an installer.
set_error_handler(array("module", "dummy_error_handler"));
try {
$modules = ORM::factory("module")->find_all();
} catch (Exception $e) {
return;
}
try {
$hooks = array();
foreach ($modules as $module) {
self::$module_names[$module->name] = $module->name;
self::$modules[$module->name] = $module;
$kohana_modules[] = MODPATH . $module->name;
$module_path = MODPATH . $module->name;
$kohana_modules[] = $module_path;
if (file_exists("$module_path/hooks") &&
($hook_files = glob("$module_path/hooks/*.php")) !== false) {
$hooks = array_merge($hooks, $hook_files);
}
}
Kohana::config_set("core.modules", $kohana_modules);
/*
* Kohana loads the hooks before all the installed module paths are defined, so lets call
* any module hooks now
*/
foreach($hooks as $hook) {
include($hook);
}
} catch (Exception $e) {
self::$module_names = array();
self::$modules = array();
}
self::event("gallery_ready");
}
static function dummy_error_handler() { }
/**
* Run a specific event on all active modules.
* @param string $name the event name
* @param mixed $data data to pass to each event handler
*/
static function event($name, &$data=null) {
foreach (self::installed() as $module) {
$class = "{$module->name}_event";
$function = str_replace(".", "_", $name);
if (method_exists($class, $function)) {
$args = func_get_args();
array_shift($args);
call_user_func_array(array($class, $function), $args);
}
}
}
/**
* Get a variable from this module
* @param string $module_name
* @param string $name
* @param string $default_value
* @return the value
*/
static function get_var($module_name, $name, $default_value=null) {
$var = ORM::factory("var")
->where("module_name", $module_name)
->where("name", $name)
->find();
return $var->loaded ? $var->value : $default_value;
}
/**
* Store a variable for this module
* @param string $module_name
* @param string $name
* @param string $value
*/
static function set_var($module_name, $name, $value) {
$var = ORM::factory("var")
->where("module_name", $module_name)
->where("name", $name)
->find();
if (!$var->loaded) {
$var = ORM::factory("var");
$var->module_name = $module_name;
$var->name = $name;
}
$var->value = $value;
$var->save();
}
/**
* Increment the value of a variable for this module
* @param string $module_name
* @param string $name
* @param string $increment (optional, default is 1)
*/
static function incr_var($module_name, $name, $increment=1) {
Database::instance()->query(
"UPDATE {vars} SET `value` = `value` + $increment " .
"WHERE `module_name` = '$module_name' " .
"AND `name` = '$name'");
}
/**
* Remove a variable for this module.
* @param string $module_name
* @param string $name
*/
static function clear_var($module_name, $name) {
$var = ORM::factory("var")
->where("module_name", $module_name)
->where("name", $name)
->find();
if ($var->loaded) {
$var->delete();
}
}
}