Use events to generate menus, instead of having xxx_menu helpers.

This is the first step towards having a simple, lightweight and
unified API for module interaction.

3 files changed, 135 insertions, 204 deletions

diff --git a/modules/gallery/helpers/gallery_menu.php b/modules/gallery/helpers/gallery_menu.php
deleted file mode 100644
index 040b19e1..00000000
--- a/modules/gallery/helpers/gallery_menu.php
+++ /dev/null
@@ -1,164 +0,0 @@
-<?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.
- */
-class gallery_menu_Core {
-  static function site($menu, $theme) {
-    $menu->append(Menu::factory("link")
-                  ->id("home")
-                  ->label(t("Home"))
-                  ->url(url::site("albums/1")));
-
-    $item = $theme->item();
-
-    $can_edit = $item && access::can("edit", $item);
-    $can_add = $item && access::can("add", $item);
-
-    if ($can_add) {
-      $menu->append(Menu::factory("dialog")
-                    ->id("add_photos_item")
-                    ->label(t("Add photos"))
-                    ->url(url::site("simple_uploader/app/$item->id")));
-    }
-
-    $menu->append($options_menu = Menu::factory("submenu")
-                  ->id("options_menu")
-                  ->label(t("Options")));
-    if ($item && ($can_edit || $can_add)) {
-      if ($can_edit) {
-        $options_menu
-          ->append(Menu::factory("dialog")
-                   ->id("edit_item")
-                   ->label($item->is_album() ? t("Edit album") : t("Edit photo"))
-                   ->url(url::site("form/edit/{$item->type}s/$item->id")));
-      }
-
-      // @todo Move album options menu to the album quick edit pane
-      if ($item->is_album()) {
-        if ($can_add) {
-          $options_menu
-            ->append(Menu::factory("dialog")
-                     ->id("add_album")
-                     ->label(t("Add an album"))
-                     ->url(url::site("form/add/albums/$item->id?type=album")));
-        }
-
-        if ($can_edit) {
-          $options_menu
-            ->append(Menu::factory("dialog")
-                     ->id("edit_permissions")
-                     ->label(t("Edit permissions"))
-                     ->url(url::site("permissions/browse/$item->id")));
-        }
-      }
-    }
-
-    if (user::active()->admin) {
-      $menu->append($admin_menu = Menu::factory("submenu")
-                    ->id("admin_menu")
-                    ->label(t("Admin")));
-      self::admin($admin_menu, $theme);
-      foreach (module::active() as $module) {
-        if ($module->name == "gallery") {
-          continue;
-        }
-        $class = "{$module->name}_menu";
-        if (method_exists($class, "admin")) {
-          call_user_func_array(array($class, "admin"), array(&$admin_menu, $theme));
-        }
-      }
-    }
-  }
-
-  static function album($menu, $theme) {
-  }
-
-  static function tag($menu, $theme) {
-  }
-
-  static function thumb($menu, $theme, $item) {
-    $menu->append(Menu::factory("submenu")
-                  ->id("options_menu")
-                  ->label(t("Options"))
-                  ->css_class("gThumbMenu"));
-  }
-
-  static function photo($menu, $theme) {
-    if (access::can("view_full", $theme->item())) {
-      $menu->append(Menu::factory("link")
-                    ->id("fullsize")
-                    ->label(t("View full size"))
-                    ->url($theme->item()->file_url())
-                    ->css_class("gFullSizeLink"));
-    }
-  }
-
-  static function admin($menu, $theme) {
-    $menu
-      ->append(Menu::factory("link")
-               ->id("dashboard")
-               ->label(t("Dashboard"))
-               ->url(url::site("admin")))
-      ->append(Menu::factory("submenu")
-               ->id("settings_menu")
-               ->label(t("Settings"))
-               ->append(Menu::factory("link")
-                        ->id("graphics_toolkits")
-                        ->label(t("Graphics"))
-                        ->url(url::site("admin/graphics")))
-               ->append(Menu::factory("link")
-                        ->id("languages")
-                        ->label(t("Languages"))
-                        ->url(url::site("admin/languages")))
-               ->append(Menu::factory("link")
-                        ->id("l10n_mode")
-                        ->label(Session::instance()->get("l10n_mode", false)
-                                ? t("Stop translating") : t("Start translating"))
-                        ->url(url::site("l10n_client/toggle_l10n_mode?csrf=" .
-                                        access::csrf_token())))
-               ->append(Menu::factory("link")
-                        ->id("advanced")
-                        ->label(t("Advanced"))
-                        ->url(url::site("admin/advanced_settings"))))
-      ->append(Menu::factory("link")
-               ->id("modules")
-               ->label(t("Modules"))
-               ->url(url::site("admin/modules")))
-      ->append(Menu::factory("submenu")
-               ->id("content_menu")
-               ->label(t("Content")))
-      ->append(Menu::factory("submenu")
-               ->id("appearance_menu")
-               ->label(t("Appearance"))
-               ->append(Menu::factory("link")
-                        ->id("themes")
-                        ->label(t("Theme Choice"))
-                        ->url(url::site("admin/themes")))
-               ->append(Menu::factory("link")
-                        ->id("theme_options")
-                        ->label(t("Theme Options"))
-                        ->url(url::site("admin/theme_options"))))
-      ->append(Menu::factory("submenu")
-               ->id("statistics_menu")
-               ->label(t("Statistics")))
-      ->append(Menu::factory("link")
-               ->id("maintenance")
-               ->label(t("Maintenance"))
-               ->url(url::site("admin/maintenance")));
-  }
-}
diff --git a/modules/gallery/libraries/Admin_View.php b/modules/gallery/libraries/Admin_View.php
index 47770a90..2a48d1e3 100644
--- a/modules/gallery/libraries/Admin_View.php
+++ b/modules/gallery/libraries/Admin_View.php
@@ -44,22 +44,66 @@ class Admin_View_Core extends Gallery_View {
     $this->set_global("user", user::active());
   }
 
-  public function admin_menu() {
-    $menu = Menu::factory("root");
-    gallery_menu::admin($menu, $this);
-
-    foreach (module::active() as $module) {
-      if ($module->name == "gallery") {
-        continue;
-      }
-      $class = "{$module->name}_menu";
-      if (method_exists($class, "admin")) {
-        call_user_func_array(array($class, "admin"), array(&$menu, $this));
-      }
+  public function admin_menu($menu=null) {
+    if (!$menu) {
+      $menu = Menu::factory("root");
     }
 
+    $menu
+      ->append(Menu::factory("link")
+               ->id("dashboard")
+               ->label(t("Dashboard"))
+               ->url(url::site("admin")))
+      ->append(Menu::factory("submenu")
+               ->id("settings_menu")
+               ->label(t("Settings"))
+               ->append(Menu::factory("link")
+                        ->id("graphics_toolkits")
+                        ->label(t("Graphics"))
+                        ->url(url::site("admin/graphics")))
+               ->append(Menu::factory("link")
+                        ->id("languages")
+                        ->label(t("Languages"))
+                        ->url(url::site("admin/languages")))
+               ->append(Menu::factory("link")
+                        ->id("l10n_mode")
+                        ->label(Session::instance()->get("l10n_mode", false)
+                                ? t("Stop translating") : t("Start translating"))
+                        ->url(url::site("l10n_client/toggle_l10n_mode?csrf=" .
+                                        access::csrf_token())))
+               ->append(Menu::factory("link")
+                        ->id("advanced")
+                        ->label(t("Advanced"))
+                        ->url(url::site("admin/advanced_settings"))))
+      ->append(Menu::factory("link")
+               ->id("modules")
+               ->label(t("Modules"))
+               ->url(url::site("admin/modules")))
+      ->append(Menu::factory("submenu")
+               ->id("content_menu")
+               ->label(t("Content")))
+      ->append(Menu::factory("submenu")
+               ->id("appearance_menu")
+               ->label(t("Appearance"))
+               ->append(Menu::factory("link")
+                        ->id("themes")
+                        ->label(t("Theme Choice"))
+                        ->url(url::site("admin/themes")))
+               ->append(Menu::factory("link")
+                        ->id("theme_options")
+                        ->label(t("Theme Options"))
+                        ->url(url::site("admin/theme_options"))))
+      ->append(Menu::factory("submenu")
+               ->id("statistics_menu")
+               ->label(t("Statistics")))
+      ->append(Menu::factory("link")
+               ->id("maintenance")
+               ->label(t("Maintenance"))
+               ->url(url::site("admin/maintenance")));
+
+    module::event("admin_menu", $menu, $this);
     $menu->compact();
-    print $menu;
+    return $menu;
   }
 
   /**
diff --git a/modules/gallery/libraries/Theme_View.php b/modules/gallery/libraries/Theme_View.php
index fa45ec89..60471f75 100644
--- a/modules/gallery/libraries/Theme_View.php
+++ b/modules/gallery/libraries/Theme_View.php
@@ -81,52 +81,103 @@ class Theme_View_Core extends Gallery_View {
   public function site_menu() {
     $menu = Menu::factory("root");
     if ($this->page_type != "login") {
-      gallery_menu::site($menu, $this);
+      $menu->append(Menu::factory("link")
+                    ->id("home")
+                    ->label(t("Home"))
+                    ->url(url::site("albums/1")));
 
-      foreach (module::active() as $module) {
-        if ($module->name == "gallery") {
-          continue;
+      $item = $this->item();
+
+      $can_edit = $item && access::can("edit", $item);
+      $can_add = $item && access::can("add", $item);
+
+      if ($can_add) {
+        $menu->append(Menu::factory("dialog")
+                      ->id("add_photos_item")
+                      ->label(t("Add photos"))
+                      ->url(url::site("simple_uploader/app/$item->id")));
+      }
+
+      $menu->append($options_menu = Menu::factory("submenu")
+                    ->id("options_menu")
+                    ->label(t("Options")));
+      if ($item && ($can_edit || $can_add)) {
+        if ($can_edit) {
+          $options_menu
+            ->append(Menu::factory("dialog")
+                     ->id("edit_item")
+                     ->label($item->is_album() ? t("Edit album") : t("Edit photo"))
+                     ->url(url::site("form/edit/{$item->type}s/$item->id")));
         }
-        $class = "{$module->name}_menu";
-        if (method_exists($class, "site")) {
-          call_user_func_array(array($class, "site"), array(&$menu, $this));
+
+        // @todo Move album options menu to the album quick edit pane
+        if ($item->is_album()) {
+          if ($can_add) {
+            $options_menu
+              ->append(Menu::factory("dialog")
+                       ->id("add_album")
+                       ->label(t("Add an album"))
+                       ->url(url::site("form/add/albums/$item->id?type=album")));
+          }
+
+          if ($can_edit) {
+            $options_menu
+              ->append(Menu::factory("dialog")
+                       ->id("edit_permissions")
+                       ->label(t("Edit permissions"))
+                       ->url(url::site("permissions/browse/$item->id")));
+          }
         }
       }
+
+      if (user::active()->admin) {
+        $menu->append($admin_menu = Menu::factory("submenu")
+                      ->id("admin_menu")
+                      ->label(t("Admin")));
+        Admin_View::admin_menu($admin_menu, $this);
+        module::event("admin_menu", $admin_menu, $this);
+      }
+
+      module::event("site_menu", $menu, $this);
     }
 
-    $menu->compact();
-    print $menu;
+    return $menu->compact();
   }
 
   public function album_menu() {
-    print $this->_menu("album");
+    $menu = Menu::factory("root");
+    module::event("album_menu", $menu, $this);
+    return $menu->compact();
   }
 
   public function tag_menu() {
-    print $this->_menu("tag");
+    $menu = Menu::factory("root");
+    module::event("tag_menu", $menu, $this);
+    return $menu->compact();
   }
 
   public function photo_menu() {
-    print $this->_menu("photo");
-  }
+    $menu = Menu::factory("root");
+    if (access::can("view_full", $this->item())) {
+      $menu->append(Menu::factory("link")
+                    ->id("fullsize")
+                    ->label(t("View full size"))
+                    ->url($this->item()->file_url())
+                    ->css_class("gFullSizeLink"));
+    }
 
-  public function thumb_menu($item) {
-    print $this->_menu("thumb", $item)->css_class("gThumbMenu");
+    module::event("photo_menu", $menu, $this);
+    return $menu->compact();
   }
 
-  private function _menu($type, $item=null) {
-    $menu = Menu::factory("root");
-    call_user_func_array(array("gallery_menu", $type), array(&$menu, $this, $item));
-    foreach (module::active() as $module) {
-      if ($module->name == "gallery") {
-        continue;
-      }
-      $class = "{$module->name}_menu";
-      if (method_exists($class, $type)) {
-        call_user_func_array(array($class, $type), array(&$menu, $this, $item));
-      }
-    }
+  public function thumb_menu($item) {
+    $menu = Menu::factory("root")
+      ->append(Menu::factory("submenu")
+               ->id("options_menu")
+               ->label(t("Options"))
+               ->css_class("gThumbMenu"));
 
+    module::event("thumb_menu", $menu, $this, $item);
     return $menu->compact();
   }