Refactor dashboard block handling out into a dashboard helper so that

module installers don't have to know the grotty details of how it works.

4 files changed, 82 insertions, 50 deletions

diff --git a/core/controllers/admin_dashboard.php b/core/controllers/admin_dashboard.php
index 1a845e04..43b61868 100644
--- a/core/controllers/admin_dashboard.php
+++ b/core/controllers/admin_dashboard.php
@@ -27,49 +27,46 @@ class Admin_Dashboard_Controller extends Admin_Controller {
     $block_adder->content = $this->get_add_block_form();
 
     $view = new Admin_View("admin.html");
-    $view->content = $this->get_blocks($blocks["main"]);
-    $view->sidebar = $block_adder . $this->get_blocks($blocks["sidebar"]);
+    $view->content = dashboard::get_blocks($blocks["main"]);
+    $view->sidebar = $block_adder . dashboard::get_blocks($blocks["sidebar"]);
     print $view;
   }
 
   public function add_block() {
     $form = $this->get_add_block_form();
     if ($form->validate()) {
-      list ($module_name, $id) = explode(":", $form->add_block->id->value);
-      $blocks = unserialize(module::get_var("core", "dashboard_blocks"));
-      $available = $this->get_block_list();
+      list ($module_name, $block_id) = explode(":", $form->add_block->id->value);
+      $blocks = dashboard::get_active();
+      $available = dashboard::get_available();
 
       if ($form->add_block->center->value) {
-        $blocks["main"][] = array($module_name, $id);
+        dashboard::add_block("main", $module_name, $block_id);
         message::success(
           t("Added <b>{{title}}</b> block to the main dashboard area",
             array("title" => $available["$module_name:$id"])));
       } else {
-        $blocks["sidebar"][] = array($module_name, $id);
+        dashboard::add_block("sidebar", $module_name, $block_id);
         message::success(
           t("Added <b>{{title}}</b> to the dashboard sidebar",
             array("title" => $available["$module_name:$id"])));
       }
-      module::set_var("core", "dashboard_blocks", serialize($blocks));
     }
     url::redirect("admin/dashboard");
   }
 
   public function remove_block($id) {
     access::verify_csrf();
-    $blocks = unserialize(module::get_var("core", "dashboard_blocks"));
-
+    $blocks = dashboard::get_active();
     if (array_key_exists($id, $blocks["sidebar"])) {
       $deleted = $blocks["sidebar"][$id];
-      unset($blocks["sidebar"][$id]);
+      dashboard::remove_block("sidebar", $id);
     } else if (array_key_exists($id, $blocks["main"])) {
       $deleted = $blocks["main"][$id];
-      unset($blocks["main"][$id]);
+      dashboard::remove_block("main", $id);
     }
 
     if (!empty($deleted)) {
-      module::set_var("core", "dashboard_blocks", serialize($blocks));
-      $available = $this->get_block_list();
+      $available = dashboard::get_available();
       $title = $available[join(":", $deleted)];
       message::success(t("Removed <b>{{title}}</b> block", array("title" => $title)));
     }
@@ -77,34 +74,10 @@ class Admin_Dashboard_Controller extends Admin_Controller {
     url::redirect("admin");
   }
 
-  private function get_blocks($blocks) {
-    $result = "";
-    foreach ($blocks as $id => $desc) {
-      if (method_exists("$desc[0]_dashboard", "get_block")) {
-        $block = call_user_func(array("$desc[0]_dashboard", "get_block"), $desc[1]);
-        $block->id = $id;
-        $result .= $block;
-      }
-    }
-    return $result;
-  }
-
-  private function get_block_list() {
-    $blocks = array();
-    foreach (module::installed() as $module) {
-      if (method_exists("{$module->name}_dashboard", "get_list")) {
-        foreach (call_user_func(array("{$module->name}_dashboard", "get_list")) as $id => $title) {
-          $blocks["{$module->name}:$id"] = $title;
-        }
-      }
-    }
-    return $blocks;
-  }
-
   public function get_add_block_form() {
     $form = new Forge("admin/dashboard/add_block", "", "post");
     $group = $form->group("add_block")->label(t("Add Block"));
-    $group->dropdown("id")->label("Available Blocks")->options($this->get_block_list());
+    $group->dropdown("id")->label("Available Blocks")->options(dashboard::get_available());
     $group->submit("center")->value(t("Add to center"));
     $group->submit("sidebar")->value(t("Add to sidebar"));
     return $form;
diff --git a/core/helpers/core_installer.php b/core/helpers/core_installer.php
index e809d687..ff5def5f 100644
--- a/core/helpers/core_installer.php
+++ b/core/helpers/core_installer.php
@@ -234,14 +234,12 @@ class core_installer {
         $theme->save();
       }
 
-      module::set_var(
-        "core", "dashboard_blocks", serialize(
-          array("sidebar" => array(rand() => array("core", "stats"),
-                                   rand() => array("core", "platform_info"),
-                                   rand() => array("core", "project_news")),
-                "main" => array(rand() => array("core", "welcome"),
-                                rand() => array("core", "photo_stream"),
-                                rand() => array("core", "log_entries")))));
+      dashboard::add_block("sidebar", "core", "stats");
+      dashboard::add_block("sidebar", "core", "platform_info");
+      dashboard::add_block("sidebar", "core", "project_news");
+      dashboard::add_block("main", "core", "welcome");
+      dashboard::add_block("main", "core", "photo_stream");
+      dashboard::add_block("main", "core", "log_entries");
 
       module::set_version("core", 1);
       module::set_var("core", "version", "3.0");
diff --git a/core/helpers/dashboard.php b/core/helpers/dashboard.php
new file mode 100644
index 00000000..61ff01ce
--- /dev/null
+++ b/core/helpers/dashboard.php
@@ -0,0 +1,63 @@
+<?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.
+ */
+class dashboard_Core {
+  public static function get_active() {
+    return unserialize(module::get_var("core", "dashboard_blocks", "a:{}"));
+  }
+
+  public static function add_block($location, $module_name, $block_id) {
+    $blocks = self::get_active();
+    $blocks[$location][rand()] = array($module_name, $block_id);
+    module::set_var("core", "dashboard_blocks", serialize($blocks));
+  }
+
+  public static function remove_block($location, $block_id) {
+    $blocks = self::get_active();
+    unset($blocks[$location][$block_id]);
+    unset($blocks[$location][$block_id]);
+    module::set_var("core", "dashboard_blocks", serialize($blocks));
+  }
+
+  public static function get_available() {
+    $blocks = array();
+
+    foreach (module::installed() as $module) {
+      if (method_exists("{$module->name}_dashboard", "get_list")) {
+        foreach (call_user_func(array("{$module->name}_dashboard", "get_list")) as $id => $title) {
+          $blocks["{$module->name}:$id"] = $title;
+        }
+      }
+    }
+    return $blocks;
+  }
+
+  public static function get_blocks($blocks) {
+    $result = "";
+    foreach ($blocks as $id => $desc) {
+      if (method_exists("$desc[0]_dashboard", "get_block")) {
+        $block = call_user_func(array("$desc[0]_dashboard", "get_block"), $desc[1]);
+        $block->id = $id;
+        $result .= $block;
+      }
+    }
+    return $result;
+  }
+}
+
diff --git a/modules/comment/helpers/comment_installer.php b/modules/comment/helpers/comment_installer.php
index b54692ec..34968cb0 100644
--- a/modules/comment/helpers/comment_installer.php
+++ b/modules/comment/helpers/comment_installer.php
@@ -50,9 +50,7 @@ class comment_installer {
                  ENGINE=InnoDB DEFAULT CHARSET=utf8;");
 
 
-      $dashboard_blocks = unserialize(module::get_var("core", "dashboard_blocks"));
-      $dashboard_blocks["main"][rand()] = array("comment", "recent_comments");
-      module::set_var("core", "dashboard_blocks", serialize($dashboard_blocks));
+      dashboard::add_block("main", "comment", "recent_comments");
       module::set_var("comment", "spam_caught", 0);
       module::set_version("comment", 1);
     }