Change the quick pan from static to dynamic. This allows modules to add buttons to the

quick pane.  The quick pane is now divided into 4 sections: left, center, right and
additional.  Additional items appear in the drop down box.  Buttons are not sorted
within the groupings.

In addition, the quick pane will overflow onto the "additional" dropdown if there is not
enough room to display all the buttons.

The use case is the digibug printing module needed to add a button to the quick pane, and
I don't like putting code into core that says if module is active... That's another one
of those code smells :-)

Signed-off-by: Tim Almdal <tnalmdal@shaw.ca>

3 files changed, 160 insertions, 91 deletions

diff --git a/modules/gallery/controllers/quick.php b/modules/gallery/controllers/quick.php
index cff6686b..6203728c 100644
--- a/modules/gallery/controllers/quick.php
+++ b/modules/gallery/controllers/quick.php
@@ -25,6 +25,8 @@ class Quick_Controller extends Controller {
     }
 
     $view = new View("quick_pane.html");
+    $view->button_list =
+      gallery_quick::get_quick_buttons($item, Input::instance()->get("page_type"));
     $view->item = $item;
     $view->page_type = Input::instance()->get("page_type");
     print $view;
diff --git a/modules/gallery/helpers/gallery_quick.php b/modules/gallery/helpers/gallery_quick.php
new file mode 100644
index 00000000..19ed23dc
--- /dev/null
+++ b/modules/gallery/helpers/gallery_quick.php
@@ -0,0 +1,146 @@
+<?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_quick_Core {
+  static function get_quick_buttons($item, $page_type) {
+    $buttons = self::buttons($item, $page_type);
+    foreach (module::active() as $module) {
+      if ($module->name == "gallery") {
+        continue;
+      }
+      $class_name = "{$module->name}_quick";
+      if (method_exists($class_name, "buttons")) {
+        $module_buttons = call_user_func(array($class_name, "buttons"), $item, $page_type);
+        foreach (array("left", "center", "right", "additional") as $position) {
+          if (!empty($module_buttons[$position])) {
+            $buttons[$position] = array_merge($buttons[$position], $module_buttons[$position]);
+          }
+        }
+      }
+    }
+
+    $sorted_buttons->main = array();
+    foreach (array("left", "center", "right") as $position) {
+      $sorted_buttons->main = array_merge($sorted_buttons->main, $buttons[$position]);
+    }
+
+    $sorted_buttons->additional = $buttons["additional"];
+    $max_display = empty($sorted_buttons->additional) ? 6 : 5;
+    if (count($sorted_buttons->main) >= $max_display) {
+      $to_move = array_slice($sorted_buttons->main, 5);
+      $sorted_buttons->additional = array_merge($to_move, $sorted_buttons->additional);
+      for ($i = count($sorted_buttons->main); $i >= 5; $i--) {
+        unset($sorted_buttons->main[$i]);
+      }
+    }
+
+    Kohana::log("error", ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>");
+    Kohana::log("error", Kohana::debug($sorted_buttons));
+    Kohana::log("error", "<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<");
+    return $sorted_buttons;
+  }
+
+  static function buttons($item, $page_type) {
+    $elements = array("left" => array(), "center" => array(), "right" => array(),
+                      "additional"  => array());
+    switch ($item->type) {
+    case "movie":
+      $edit_title = t("Edit this movie");
+      $move_title = t("Move this movie to another album");
+      $cover_title = t("Choose this movie as the album cover");
+      $delete_title = t("Delete this movie");
+      break;
+    case "album":
+      $edit_title = t("Edit this album");
+      $move_title = t("Move this album to another album");
+      $cover_title = t("Choose this album as the album cover");
+      $delete_title = t("Delete this album");
+      break;
+    default:
+      $edit_title = t("Edit this photo");
+      $move_title = t("Move this photo to another album");
+      $cover_title = t("Choose this photo as the album cover");
+      $delete_title = t("Delete this photo");
+      break;
+    }
+
+    $csrf = access::csrf_token();
+    $elements["left"][] = (object)array(
+      "title" => $edit_title,
+      "class" => "gDialogLink gButtonLink",
+      "icon" => "ui-icon-pencil",
+      "href" => url::site("quick/form_edit/$item->id?page_type=$page_type"));
+    if ($item->is_photo() && graphics::can("rotate")) {
+      $elements["left"][] =
+        (object)array(
+          "title" => t("Rotate 90 degrees counter clockwise"),
+          "class" => "gButtonLink",
+          "icon" => "ui-icon-rotate-ccw",
+          "href" => url::site("quick/form_edit/$item->id/ccw?csrf=$csrf&?page_type=$page_type"));
+      $elements["left"][] =
+        (object)array(
+          "title" => t("Rotate 90 degrees clockwise"),
+          "class" => "gButtonLink",
+          "icon" => "ui-icon-rotate-cw",
+          "href" => url::site("quick/form_edit/$item->id/cw?csrf=$csrf&page_type=$page_type"));
+    }
+
+    // Don't move photos from the photo page; we don't yet have a good way of redirecting after move
+    if ($page_type == "album") {
+      $elements["left"][] = (object)array(
+        "title" => $move_title,
+        "class" => "gDialogLink gButtonLink",
+        "icon" => "ui-icon-folder-open",
+        "href" => url::site("move/browse/$item->id"));
+    }
+
+    if (access::can("edit", $item->parent())) {
+      $disabledState =
+        $item->type == "album" && empty($item->album_cover_item_id) ? " ui-state-disabled" : "";
+      $elements["right"][] = (object)array(
+        "title" => $cover_title,
+        "class" => "gButtonLink{$disabledState}",
+        "icon" => "ui-icon-star",
+        "href" => url::site("quick/make_album_cover/$item->id?csrf=$csrf&page_type=$page_type"));
+
+      $elements["right"][] = (object)array(
+        "title" => $delete_title,
+        "class" => "gButtonLink",
+        "icon" => "ui-icon-trash",
+        "id" => "gQuickDelete",
+        "href" => url::site("quick/form_delete/$item->id?csrf=$csrf&page_type=$page_type"));
+    }
+
+    if ($item->is_album()) {
+      $elements["additional"][] = (object)array(
+        "title" => t("Add a photo"),
+        "class" => "add_item gDialogLink",
+        "href" => url::site("simple_uploader/app/$item->id"));
+      $elements["additional"][] = (object)array(
+        "title" => t("Add an album"),
+        "class" => "add_album gDialogLink",
+        "href" => url::site("form/add/albums/$item->id?type=album"));
+      $elements["additional"][] = (object)array(
+        "title" => t("Edit permissions"),
+        "class" => "permissions gDialogLink",
+        "href" => url::site("permissions/browse/$item->id"));
+    }
+    return $elements;
+  }
+}
diff --git a/modules/gallery/views/quick_pane.html.php b/modules/gallery/views/quick_pane.html.php
index f50e1abe..eabf4a67 100644
--- a/modules/gallery/views/quick_pane.html.php
+++ b/modules/gallery/views/quick_pane.html.php
@@ -1,85 +1,14 @@
 <?php defined("SYSPATH") or die("No direct script access.") ?>
-<? if ($item->type == "photo"): ?>
-<? $title = t("Edit this photo") ?>
-<? elseif ($item->type == "movie"): ?>
-<? $title = t("Edit this movie") ?>
-<? elseif ($item->type == "album"): ?>
-<? $title = t("Edit this album") ?>
-<? endif ?>
-<a class="gDialogLink gButtonLink ui-corner-all ui-state-default" href="<?= url::site("quick/form_edit/$item->id?page_type=$page_type") ?>"
-  title="<?= $title ?>">
-  <span class="ui-icon ui-icon-pencil">
-    <?= $title ?>
-  </span>
-</a>
-
-<? if ($item->is_photo() && graphics::can("rotate")): ?>
-<a class="gButtonLink ui-corner-all ui-state-default" href="<?= url::site("quick/rotate/$item->id/ccw?csrf=$csrf&page_type=$page_type") ?>"
-  title="<?= t("Rotate 90 degrees counter clockwise") ?>">
-  <span class="ui-icon ui-icon-rotate-ccw">
-    <?= t("Rotate 90 degrees counter clockwise") ?>
-  </span>
-</a>
-
-<a class="gButtonLink ui-corner-all ui-state-default" href="<?= url::site("quick/rotate/$item->id/cw?csrf=$csrf&page_type=$page_type") ?>"
-  title="<?= t("Rotate 90 degrees clockwise") ?>">
-  <span class="ui-icon ui-icon-rotate-cw">
-    <?= t("Rotate 90 degrees clockwise") ?>
+<? foreach ($button_list->main as $button): ?>
+<a class="<?= $button->class ?> ui-corner-all ui-state-default" href="<?= $button->href ?>"
+  title="<?= $button->title ?>">
+  <span class="ui-icon <?= $button->icon ?>">
+    <?= $button->title ?>
   </span>
 </a>
-<? endif ?>
+<? endforeach ?>
 
-<? // Don't move photos from the photo page; we don't yet have a good way of redirecting after move ?>
-<? if ($page_type == "album"): ?>
-<? if ($item->type == "photo"): ?>
-<? $title = t("Move this photo to another album") ?>
-<? elseif ($item->type == "movie"): ?>
-<? $title = t("Move this movie to another album") ?>
-<? elseif ($item->type == "album"): ?>
-<? $title = t("Move this album to another album") ?>
-<? endif ?>
-<a class="gDialogLink gButtonLink ui-corner-all ui-state-default" href="<?= url::site("move/browse/$item->id") ?>"
-  title="<?= $title ?>">
-  <span class="ui-icon ui-icon-folder-open">
-    <?= $title ?>
-  </span>
-</a>
-<? endif ?>
-
-<? $disabledState = "" ?>
-<? if (access::can("edit", $item->parent())): ?>
-<? if ($item->type == "photo"): ?>
-<? $title = t("Choose this photo as the album cover") ?>
-<? elseif ($item->type == "movie"): ?>
-<? $title = t("Choose this movie as the album cover") ?>
-<? elseif ($item->type == "album"): ?>
-<? if (empty($item->album_cover_item_id)): ?>
-<? $disabledState = empty($item->album_cover_item_id) ? " ui-state-disabled" : "" ?>
-<? endif ?>
-<? $title = t("Choose this album as the album cover") ?>
-<? endif ?>
-<a class="gButtonLink ui-corner-all ui-state-default<?= $disabledState ?>" href="<?= url::site("quick/make_album_cover/$item->id?csrf=$csrf&page_type=$page_type") ?>"
-   title="<?= $title ?>">
-  <span class="ui-icon ui-icon-star">
-    <?= $title ?>
-  </span>
-</a>
-
-<? if ($item->type == "photo"): ?>
-<? $title = t("Delete this photo") ?>
-<? elseif ($item->type == "movie"): ?>
-<? $title = t("Delete this movie") ?>
-<? elseif ($item->type == "album"): ?>
-<? $title = t("Delete this album") ?>
-<? endif ?>
-<a class="gDialogLink gButtonLink ui-corner-all ui-state-default" href="<?= url::site("quick/form_delete/$item->id?page_type=$page_type") ?>" id="gQuickDelete" title="<?= $title ?>">
-  <span class="ui-icon ui-icon-trash">
-    <?= $title ?>
-  </span>
-</a>
-<? endif ?>
-
-<? if ($item->is_album()): ?>
+<? if (!empty($button_list->additional)): ?>
 <a class="gButtonLink ui-corner-all ui-state-default options" href="#" title="<?= t("additional options") ?>">
   <span class="ui-icon ui-icon-triangle-1-s">
     <?= t("Additional options") ?>
@@ -87,19 +16,11 @@
 </a>
 
 <ul id="gQuickPaneOptions" style="display: none">
-  <li><a class="add_item gDialogLink" href="<?= url::site("simple_uploader/app/$item->id") ?>"
-    title="<?= t("Add a photo") ?>">
-    <?= t("Add a photo") ?>
-  </a></li>
-
-  <li><a class="add_album gDialogLink" href="<?= url::site("form/add/albums/$item->id?type=album") ?>"
-    title="<?= t("Add an album") ?>">
-    <?= t("Add an album") ?>
-  </a></li>
-
-  <li><a class="permissions gDialogLink" href="<?= url::site("permissions/browse/$item->id") ?>"
-    title="<?= t("Edit permissions") ?>">
-    <?= t("Edit permissions") ?>
+  <? foreach ($button_list->additional as $button): ?>
+  <li><a class="<?= $button->class ?>" href="<?= $button->href ?>"
+    title="<?= $button->title ?>">
+    <?=  $button->title ?>
   </a></li>
+  <? endforeach ?>
 </ul>
 <? endif ?>