A look at away to allow modules to define html head contents (links and js) and also allow modules to contribute blocks to the layout.

11 files changed, 146 insertions, 12 deletions

diff --git a/core/helpers/core_installer.php b/core/helpers/core_installer.php
index e0e4f7d9..c627145a 100644
--- a/core/helpers/core_installer.php
+++ b/core/helpers/core_installer.php
@@ -62,6 +62,15 @@ class core_installer {
                    KEY `type` (`type`))
                  ENGINE=InnoDB DEFAULT CHARSET=utf8;");
 
+      $db->query("CREATE TABLE `blocks` (
+                   `id` int(9) NOT NULL auto_increment,
+                   `module` char(255) NOT NULL,
+                   `type` char(32) NOT NULL,
+                   `method` char(255) NOT NULL,
+                   PRIMARY KEY (`id`),
+                   UNIQUE KEY(`type`, `module`))
+                 ENGINE=InnoDB DEFAULT CHARSET=utf8;");
+
       foreach (array("albums", "resizes") as $dir) {
         @mkdir(VARPATH . $dir);
       }
@@ -84,6 +93,7 @@ class core_installer {
     $db = Database::instance();
     $db->query("DROP TABLE IF EXISTS `items`;");
     $db->query("DROP TABLE IF EXISTS `modules`;");
+    $db->query("DROP TABLE IF EXISTS `blocks`;");
     system("/bin/rm -rf " . VARPATH . "albums");
     system("/bin/rm -rf " . VARPATH . "resizes");
   }
diff --git a/core/helpers/dynamic_block.php b/core/helpers/dynamic_block.php
new file mode 100644
index 00000000..db302bc9
--- /dev/null
+++ b/core/helpers/dynamic_block.php
@@ -0,0 +1,48 @@
+<?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 dynamic_block_Core{
+  const HEAD_LINK = "link";
+  const HEAD_SCRIPT = "script";
+  const HEADER_TYPE = "header";
+  const FOOTER_TYPE = "footer";
+  const SIDE_BAR_TYPE = "sidebar";
+  const CONTENT_ALBUM = "album";
+  const CONTENT_PHOTO = "photo";
+  
+  public static function define_blocks($module, $callbacks) {
+    // @todo create unit test for this
+    foreach ($callbacks as $type => $method) {
+      $block = ORM::factory("block");
+      $block->module = $module;
+      $block->type = $type;
+      $block->method = $method;
+      $block->save();
+    }
+  }
+
+  public static function remove_blocks($module) {
+    // @todo and don't forget one for this
+    try {
+      ORM::factory("block")->where("module",$module)->find()->delete();
+    } catch (Exception $e) {
+      Kohana::log("error", $e);
+    }
+  }
+}
diff --git a/core/libraries/Theme.php b/core/libraries/Theme.php
index 4bd8237a..642bfb87 100644
--- a/core/libraries/Theme.php
+++ b/core/libraries/Theme.php
@@ -57,7 +57,23 @@ class Theme_Core {
     return new View("in_place_edit.html");
   }
 
+  public function block($type, $module=null) {
+    $block = ORM::factory("block")
+      ->where("type", $type);
+    if (isset($module)) {
+      $block->where("module", $module);
+    }
+    $result = $block->find_all();
+    $blocks = "";
+    foreach ($result as $block) {
+      $blocks .= call_user_func($block->method, $this);
+    }
+
+    return $blocks;
+  }
+
   public function blocks() {
+    // @todo make type mandatory, its only optional while i try this out for slideshow
     /** @todo: make this data driven */
     $blocks = array(
       'carousel' => carousel::block($this),
@@ -65,6 +81,7 @@ class Theme_Core {
       'info' => info::block($this),
       'gmaps' => gmaps::block($this),
     );
+    kohana::Log("debug", print_r($blocks, true));
     return $blocks;
   }
 }
diff --git a/core/models/block.php b/core/models/block.php
new file mode 100644
index 00000000..20bcee4d
--- /dev/null
+++ b/core/models/block.php
@@ -0,0 +1,21 @@
+<?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 Block_Model extends ORM {
+}
diff --git a/modules/media_rss/helpers/media_rss.php b/modules/media_rss/helpers/media_rss.php
new file mode 100644
index 00000000..c627d837
--- /dev/null
+++ b/modules/media_rss/helpers/media_rss.php
@@ -0,0 +1,25 @@
+<?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 media_rss_Core {
+  public static function link($theme) {
+    $url = url::site("media_rss/feed/{$theme->item()->id}");
+    return "<link rel=\"alternate\" type=\"application/rss+xml\" href=\"$url\"  />";
+  }
+}
diff --git a/modules/media_rss/helpers/media_rss_installer.php b/modules/media_rss/helpers/media_rss_installer.php
index 481adf8a..03ec1d34 100644
--- a/modules/media_rss/helpers/media_rss_installer.php
+++ b/modules/media_rss/helpers/media_rss_installer.php
@@ -24,10 +24,15 @@ class media_rss_installer {
     Kohana::log("debug", "version: $version");
     if ($version == 0) {
       module::set_version("media_rss", 1);
+
+      dynamic_block::define_blocks("media_rss", array(
+        dynamic_block::HEAD_LINK => "media_rss::link",
+      ));
     }
   }
 
   public static function uninstall() {
     module::delete("media_rss");
+    dynamic_block::remove_blocks("media_rss");
   }
 }
diff --git a/modules/slideshow/helpers/slideshow.php b/modules/slideshow/helpers/slideshow.php
index 5fadf36b..e7efd615 100644
--- a/modules/slideshow/helpers/slideshow.php
+++ b/modules/slideshow/helpers/slideshow.php
@@ -17,8 +17,13 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA  02110-1301, USA.
  */
-class slideshow {
-  public static function link() {
+class slideshow_Core {
+  public static function link($theme) {
     return "<a href=\"javascript:PicLensLite.start()\" id=\"gSlideshowLink\" class=\"gButtonLink\">Slideshow</a>";
   }
+
+  public static function script($theme) {
+    return "<script src=\"http://lite.piclens.com/current/piclens.js\" " .
+                    "type=\"text/javascript\"></script>";
+  }
 }
diff --git a/modules/slideshow/helpers/slideshow_installer.php b/modules/slideshow/helpers/slideshow_installer.php
index bd8ef4fc..08687c7b 100644
--- a/modules/slideshow/helpers/slideshow_installer.php
+++ b/modules/slideshow/helpers/slideshow_installer.php
@@ -24,10 +24,17 @@ class slideshow_installer {
     Kohana::log("debug", "version: $version");
     if ($version == 0) {
       module::set_version("slideshow", 1);
+
+      dynamic_block::define_blocks("slideshow", array(
+        dynamic_block::CONTENT_ALBUM => "slideshow::link",
+        dynamic_block::CONTENT_PHOTO => "slideshow::link",
+        dynamic_block::HEAD_SCRIPT => "slideshow::script",
+      ));
     }
   }
 
   public static function uninstall() {
     module::delete("slideshow");
+    dynamic_block::remove_blocks("slideshow");
   }
 }
diff --git a/themes/default/views/album.html.php b/themes/default/views/album.html.php
index 43024840..037ce30b 100644
--- a/themes/default/views/album.html.php
+++ b/themes/default/views/album.html.php
@@ -2,9 +2,7 @@
 <div id="gAlbumHeader">
   <h1><?= $item->title_edit ?></h1>
   <span class="gUnderState"><?= $item->description_edit ?></span>
-  <? if ($theme->module("slideshow")): ?>
-    <?= slideshow::link() ?>
-  <? endif; ?>
+  <?= $theme->block(dynamic_block::CONTENT_ALBUM, "slideshow") ?>
 </div>
 
 <ul id="gAlbumGrid">
diff --git a/themes/default/views/page.html.php b/themes/default/views/page.html.php
index 1f744eba..345e78e8 100644
--- a/themes/default/views/page.html.php
+++ b/themes/default/views/page.html.php
@@ -11,14 +11,13 @@
           media="screen,print,projection" />
     <link rel="stylesheet" type="text/css" href="<?= $theme->url("css/screen.css") ?>"
           media="screen,print,projection" />
-    <link rel="alternate" type="application/rss+xml"
-          href="<?= url::site("media_rss/feed/{$theme->item()->id}") ?>"
-          />
+    <?= $theme->block(dynamic_block::HEAD_LINK) ?>
     <script src="<?= url::file("lib/jquery.js") ?>" type="text/javascript"></script>
     <script src="<?= url::file("lib/jquery.form.js") ?>" type="text/javascript"></script>
+    <?= $theme->block(dynamic_block::HEAD_SCRIPT) ?>
+    <!-- The following scripts would be added via the theme block mechanism -->
     <script src="<?= $theme->url("js/user.js") ?>" type="text/javascript"></script>
     <script src="<?= $theme->url("js/comment.js") ?>" type="text/javascript"></script>
-    <script src="http://lite.piclens.com/current/piclens.js" type="text/javascript"></script>
     <? if ($user): ?>
     <script src="<?= url::file("lib/jquery.jeditable.js") ?>" type="text/javascript"></script>
     <? endif; ?>
diff --git a/themes/default/views/photo.html.php b/themes/default/views/photo.html.php
index 47b7bf4f..26a28b18 100644
--- a/themes/default/views/photo.html.php
+++ b/themes/default/views/photo.html.php
@@ -1,9 +1,8 @@
 <? defined("SYSPATH") or die("No direct script access."); ?>
 <div id="gItem">
   <a href="" class="gButtonLink">Full size (1024x768)</a>
-  <? if ($theme->module("slideshow")): ?>
-    <?= slideshow::link() ?>
-  <? endif; ?>
+  <?= $theme->block(dynamic_block::CONTENT_PHOTO, "slideshow") ?>
+
 
   <img id="gPhotoID-<?= $item->id ?>" alt="photo" src="<?= $item->resize_url() ?>"
        width="<?= $item->resize_width ?>"