Restructure things so that the application is now just another module.

Kohana makes this type of transition fairly straightforward in that
all controllers/helpers/etc are still located in the cascading
filesystem without any extra effort, except that I've temporarily
added a hack to force modules/gallery into the module path.

Rename what's left of "core" to be "application" so that it conforms
more closely to the Kohana standard (basically, just
application/config/config.php which is the minimal thing that you need
in the application directory)

There's still considerable work left to be done here.

1 files changed, 357 insertions, 0 deletions

diff --git a/modules/gallery/helpers/module.php b/modules/gallery/helpers/module.php
new file mode 100644
index 00000000..a48c89ed
--- /dev/null
+++ b/modules/gallery/helpers/module.php
@@ -0,0 +1,357 @@
+<?php defined("SYSPATH") or die("No direct script access.");
+/**
+ * Gallery - a web based photo album viewer and editor
+ * Copyright (C) 2000-2009 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 $active = array();
+  public static $modules = array();
+  public static $var_cache = null;
+
+  /**
+   * Set the version of the corresponding Module_Model
+   * @param string  $module_name
+   * @param integer $version
+   */
+  static function set_version($module_name, $version) {
+    $module = self::get($module_name);
+    if (!$module->loaded) {
+      $module->name = $module_name;
+      $module->active = $module_name == "core";  // only core is active by default
+    }
+    $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) {
+    // @todo can't easily use model_cache here because it throw an exception on missing models.
+    return ORM::factory("module", array("name" => $module_name));
+  }
+
+  /**
+   * Check to see if a module is installed
+   * @param string $module_name
+   */
+  static function is_installed($module_name) {
+    return array_key_exists($module_name, self::$modules);
+  }
+
+  /**
+   * Check to see if a module is active
+   * @param string $module_name
+   */
+  static function is_active($module_name) {
+    return array_key_exists($module_name, self::$modules) &&
+      self::$modules[$module_name]->active;
+  }
+
+  /**
+   * Return the list of available modules, including uninstalled 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 = self::is_installed($module_name);
+      $modules->$module_name->active = self::is_active($module_name);
+      $modules->$module_name->version = self::get_version($module_name);
+      $modules->$module_name->locked = false;
+    }
+
+    // Lock certain modules
+    $modules->core->locked = true;
+    $modules->user->locked = true;
+    $modules->ksort();
+
+    return $modules;
+  }
+
+  /**
+   * Return a list of all the active modules in no particular order.
+   */
+  static function active() {
+    return self::$active;
+  }
+
+  /**
+   * Install a module.  This will call <module>_installer::install(), which is responsible for
+   * creating database tables, setting module variables and and calling module::set_version().
+   * Note that after installing, the module must be activated before it is available for use.
+   * @param string $module_name
+   */
+  static function install($module_name) {
+    $kohana_modules = Kohana::config("core.modules");
+    $kohana_modules[] = MODPATH . $module_name;
+    Kohana::config_set("core.modules",  $kohana_modules);
+
+    $installer_class = "{$module_name}_installer";
+    if (method_exists($installer_class, "install")) {
+      call_user_func_array(array($installer_class, "install"), array());
+    }
+
+    // Now the module is installed but inactive, so don't leave it in the active path
+    array_pop($kohana_modules);
+    Kohana::config_set("core.modules",  $kohana_modules);
+
+    log::success(
+      "module", t("Installed module %module_name", array("module_name" => $module_name)));
+  }
+
+  /**
+   * Activate an installed module.  This will call <module>_installer::activate() which should take
+   * any steps to make sure that the module is ready for use.  This will also activate any
+   * existing graphics rules for this module.
+   * @param string $module_name
+   */
+  static function activate($module_name) {
+    $kohana_modules = Kohana::config("core.modules");
+    $kohana_modules[] = MODPATH . $module_name;
+    Kohana::config_set("core.modules",  $kohana_modules);
+
+    $installer_class = "{$module_name}_installer";
+    if (method_exists($installer_class, "activate")) {
+      call_user_func_array(array($installer_class, "activate"), array());
+    }
+
+    $module = self::get($module_name);
+    if ($module->loaded) {
+      $module->active = true;
+      $module->save();
+    }
+
+    self::load_modules();
+    graphics::activate_rules($module_name);
+    log::success(
+      "module", t("Activated module %module_name", array("module_name" => $module_name)));
+  }
+
+  /**
+   * Deactivate an installed module.  This will call <module>_installer::deactivate() which
+   * should take any cleanup steps to make sure that the module isn't visible in any way.
+   * @param string $module_name
+   */
+  static function deactivate($module_name) {
+    $installer_class = "{$module_name}_installer";
+    if (method_exists($installer_class, "deactivate")) {
+      call_user_func_array(array($installer_class, "deactivate"), array());
+    }
+
+    $module = self::get($module_name);
+    if ($module->loaded) {
+      $module->active = false;
+      $module->save();
+    }
+
+    self::load_modules();
+    graphics::deactivate_rules($module_name);
+    log::success(
+      "module", t("Deactivated module %module_name", array("module_name" => $module_name)));
+  }
+
+  /**
+   * Uninstall a deactivated module.  This will call <module>_installer::uninstall() which should
+   * take whatever steps necessary to make sure that all traces of a module are gone.
+   * @param string $module_name
+   */
+  static function uninstall($module_name) {
+    $installer_class = "{$module_name}_installer";
+    if (method_exists($installer_class, "uninstall")) {
+      call_user_func(array($installer_class, "uninstall"));
+    }
+
+    graphics::remove_rule($module_name);
+    $module = self::get($module_name);
+    if ($module->loaded) {
+      $module->delete();
+    }
+
+    // We could delete the module vars here too, but it's nice to leave them around
+    // in case the module gets reinstalled.
+
+    self::load_modules();
+    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"];
+    $modules = ORM::factory("module")->find_all();
+
+    self::$modules = array();
+    self::$active = array();
+    foreach ($modules as $module) {
+      self::$modules[$module->name] = $module;
+      if ($module->active) {
+        self::$active[] = $module;
+      }
+      if ($module->name != "core") {
+        $kohana_modules[] = MODPATH . $module->name;
+      }
+    }
+    Kohana::config_set("core.modules", $kohana_modules);
+  }
+
+  /**
+   * 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) {
+    $args = func_get_args();
+    array_shift($args);
+    $function = str_replace(".", "_", $name);
+
+    foreach (self::$modules as $module) {
+      if (!$module->active) {
+        continue;
+      }
+
+      $class = "{$module->name}_event";
+      if (method_exists($class, $function)) {
+        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) {
+    // We cache all vars in core._cache so that we can load all vars at once for
+    // performance.
+    if (empty(self::$var_cache)) {
+      $row = Database::instance()
+        ->select("value")
+        ->from("vars")
+        ->where(array("module_name" => "core", "name" => "_cache"))
+        ->get()
+        ->current();
+      if ($row) {
+        self::$var_cache = unserialize($row->value);
+      } else {
+        // core._cache doesn't exist.  Create it now.
+        foreach (Database::instance()
+                 ->select("module_name", "name", "value")
+                 ->from("vars")
+                 ->orderby("module_name", "name")
+                 ->get() as $row) {
+          if ($row->module_name == "core" && $row->name == "_cache") {
+            // This could happen if there's a race condition
+            continue;
+          }
+          self::$var_cache->{$row->module_name}->{$row->name} = $row->value;
+        }
+        $cache = ORM::factory("var");
+        $cache->module_name = "core";
+        $cache->name = "_cache";
+        $cache->value = serialize(self::$var_cache);
+        $cache->save();
+      }
+    }
+
+    if (isset(self::$var_cache->$module_name->$name)) {
+      return self::$var_cache->$module_name->$name;
+    } else {
+      return $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->module_name = $module_name;
+      $var->name = $name;
+    }
+    $var->value = $value;
+    $var->save();
+
+    Database::instance()->delete("vars", array("module_name" => "core", "name" => "_cache"));
+    self::$var_cache = null;
+ }
+
+  /**
+   * 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'");
+
+    Database::instance()->delete("vars", array("module_name" => "core", "name" => "_cache"));
+    self::$var_cache = null;
+  }
+
+ /**
+   * 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();
+    }
+
+    Database::instance()->delete("vars", array("module_name" => "core", "name" => "_cache"));
+    self::$var_cache = null;
+  }
+
+  /**
+   * Return the version of the installed module.
+   * @param string $module_name
+   */
+  static function get_version($module_name) {
+    return self::get($module_name)->version;
+  }
+}