From 140736a1e49d47376ebc893aa2da250ba3d836a3 Mon Sep 17 00:00:00 2001
From: Bharat Mediratta <bharat@menalto.com>
Date: Sun, 16 Nov 2008 07:14:12 +0000
Subject: Several large changes:

1) Changed the way that we get forms.  Now, if you want to get a form
   for a REST resource you prefix /form to the resource id.  So:
    /form/photo/1    : returns a form for editing photo id 1
    /form/comments/1 : returns a form for adding a comment to photo id 1
    /form/comment/1  : returns a form for editing comment id 1

2) Changed the comment module to have two controllers:
    comment:  deals with a single comment resource
    comments: deal with collections of comments attached to an item

Related stuff:
- Moved the comments js into the theme
- Reworked Comment_Helper for clarity
- Moved form generation code down into Comment_Helper
- Cleaned up routes (eliminating new comment ones added in recent rev)
- Added form() function to all REST controllers
- Changed comment module to use a block instead of an arbitrary helper call from the theme
- Comment controller only returns HTML currently, but returns a 201 Created status
  code when a new comment is added, which the Ajax code can catch and act upon.
- Got rid of a lot of extra views in comment module
---
 modules/comment/controllers/comment.php      | 88 +++++++---------------------
 modules/comment/controllers/comments.php     | 76 ++++++++++++++++++++++++
 modules/comment/helpers/comment.php          | 74 ++++++++++++++++++-----
 modules/comment/views/comment.html.php       | 11 ++++
 modules/comment/views/comment_form.html.php  | 35 -----------
 modules/comment/views/comment_list.html.php  | 13 ----
 modules/comment/views/show_comments.html.php | 11 ----
 7 files changed, 165 insertions(+), 143 deletions(-)
 create mode 100644 modules/comment/controllers/comments.php
 create mode 100644 modules/comment/views/comment.html.php
 delete mode 100644 modules/comment/views/comment_form.html.php
 delete mode 100644 modules/comment/views/comment_list.html.php
 delete mode 100644 modules/comment/views/show_comments.html.php

(limited to 'modules')

diff --git a/modules/comment/controllers/comment.php b/modules/comment/controllers/comment.php
index d2135cf9..a8f52443 100644
--- a/modules/comment/controllers/comment.php
+++ b/modules/comment/controllers/comment.php
@@ -21,50 +21,29 @@ class Comment_Controller extends REST_Controller {
   protected $resource_type = "comment";
 
   /**
-   * Return the form for adding comments.
+   * Present a form for editing a comment
+   *  @see Rest_Controller::form($resource)
    */
-  public function _get_form($comment) {
-    $form = new Forge(url::current(true), "", "post", array("id" => "gComment"));
-    $group = $form->group(_("Add Comment"));
-    $group->input("author")
-      ->label(_("Author"))
-      ->id("gAuthor")
-      ->class(null)
-      ->value($comment->author);
-    $group->input("email")
-      ->label(_("Email"))
-      ->id("gEmail")
-      ->class(null)
-      ->value($comment->email);
-    $group->textarea("text")
-      ->label(_("Text"))
-      ->id("gText")
-      ->class(null)
-      ->value($comment->text);
-    $group->hidden("item_id")
-      ->value($comment->item_id);
-    $group->submit(_("Add"));
-
-    $this->_add_validation_rules(ORM::factory("comment")->validation_rules, $form);
-
-    return $form;
+  public function _form($comment) {
+    $form = comment::get_edit_form($comment);
+    print $form->render("form.html");
   }
 
   /**
-   * @todo Refactor this into a more generic location
+   * Get an existing comment.
+   *  @see Rest_Controller::_get($resource)
    */
-  private function _add_validation_rules($rules, $form) {
-    foreach ($form->inputs as $name => $input) {
-      if (isset($input->inputs)) {
-        $this->_add_validation_rules($rules, $input);
-      }
-      if (isset($rules[$name])) {
-        $input->rules($rules[$name]);
-      }
-    }
+  public function _get($comment) {
+    $v = new View("comment.html");
+    $v->comment = $comment;
+    print $v;
   }
 
-  public function add($item_id) {
+  /**
+   * Update existing comment.
+   *  @see Rest_Controller::_put($resource)
+   */
+  public function _put($comment) {
     $comment = ORM::factory('comment');
     $comment->item_id = $item_id;
 
@@ -77,43 +56,16 @@ class Comment_Controller extends REST_Controller {
       $comment->datetime = time();
       $comment->item_id = $this->input->post('item_id');
       $comment->save();
-
-      $data = array('valid' => true, 'html' => sprintf(comment::show_comment_list($item_id)));
-    } else {
-      $data = array('valid' => false, 'html' => sprintf($form->render()));
+      return;
     }
-
-    if (request::method() == "get") {
-      print $data['html'];
-    } else if (request::method() == "post") {
-      print json_encode($data);
-    }
-  }
-
-  public function get_item_comments($item_id) {
-    print comment::show_comment_list($item_id);
-  }
-
-  /**
-   * Get an existing comment.
-   *  @see Rest_Controller::_get($resource)
-   */
-  public function _get($user) {
-    throw new Exception("@todo Comment_Controller::_get NOT IMPLEMENTED");
-  }
-
-  /**
-   * Update existing comment.
-   *  @see Rest_Controller::_put($resource)
-   */
-  public function _put($resource) {
-    throw new Exception("@todo Comment_Controller::_put NOT IMPLEMENTED");
+    print $form->render();
   }
 
   /**
+   * Add a new comment
    *  @see Rest_Controller::_post($resource)
    */
-  public function _post($user) {
+  public function _post($comment) {
     throw new Exception("@todo Comment_Controller::_post NOT IMPLEMENTED");
   }
 
diff --git a/modules/comment/controllers/comments.php b/modules/comment/controllers/comments.php
new file mode 100644
index 00000000..a0233a0b
--- /dev/null
+++ b/modules/comment/controllers/comments.php
@@ -0,0 +1,76 @@
+<?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 Comments_Controller extends REST_Controller {
+  protected $resource_type = "item";
+
+  /**
+   * Present a form for adding a new comment to this item
+   *  @see Rest_Controller::form($resource)
+   */
+  public function _form($item) {
+    $form = comment::get_add_form($item);
+    print $form->render("form.html");
+  }
+
+  /**
+   * Show the comment collection
+   *  @see Rest_Controller::_get($resource)
+   */
+  public function _get($item) {
+    print comment::get_comments($item);
+  }
+
+  /**
+   * Update existing comment collection.
+   *  @see Rest_Controller::_put($resource)
+   */
+  public function _put($item) {
+    throw new Exception("@todo Comment_Controller::_put NOT IMPLEMENTED");
+  }
+
+  /**
+   * Add a new comment to the collection
+   * @see Rest_Controller::_post($resource)
+   */
+  public function _post($item) {
+    $form = comment::get_add_form($item);
+    if ($form->validate()) {
+      $comment = ORM::factory('comment');
+      $comment->author = $this->input->post('author');
+      $comment->email = $this->input->post('email');
+      $comment->text = $this->input->post('text');
+      $comment->datetime = time();
+      $comment->item_id = $item->id;
+      $comment->save();
+
+      header("HTTP/1.1 201 Created");
+      header("Location: " . url::site("comment/{$comment->id}"));
+    }
+    print $form->render("form.html");
+  }
+
+  /**
+   * Delete existing comment collection.
+   *  @see Rest_Controller::_delete($resource)
+   */
+  public function _delete($item) {
+    throw new Exception("@todo Comment_Controller::_delete NOT IMPLEMENTED");
+  }
+}
diff --git a/modules/comment/helpers/comment.php b/modules/comment/helpers/comment.php
index 9eed8451..1c876f10 100644
--- a/modules/comment/helpers/comment.php
+++ b/modules/comment/helpers/comment.php
@@ -54,26 +54,68 @@ class Comment_Core {
     return $comment->save();
   }
 
-  static function show_comments($item_id) {
-    $v = new View('show_comments.html');
-    $v->comment_list = Comment::show_comment_list($item_id);
-    $v->comment_form = Comment::show_comment_form($item_id);
-    $v->render(true);
+  static function get_add_form($item) {
+    $form = new Forge(url::site("comments/{$item->id}"), "", "post", array("id" => "gCommentForm"));
+    $group = $form->group(_("Add Comment"));
+    $group->input("author") ->label(_("Author")) ->id("gAuthor");
+    $group->input("email")  ->label(_("Email"))  ->id("gEmail");
+    $group->textarea("text")->label(_("Text"))   ->id("gText");
+    $group->submit(_("Add"));
+
+    comment::_add_validation_rules("comment", $form);
+    return $form;
+  }
+
+  static function get_edit_form($comment) {
+    $form = new Forge(url::site("comment/{$comment->id}"), "", "post", array("id" => "gCommentForm"));
+    $group = $form->group(_("Edit Comment"));
+    $group->input("author") ->label(_("Author")) ->id("gAuthor") ->value($comment->author);
+    $group->input("email")  ->label(_("Email"))  ->id("gEmail")  ->value($comment->email);
+    $group->textarea("text")->label(_("Text"))   ->id("gText")   ->value($comment->text);
+    $group->submit(_("Edit"));
+
+    comment::_add_validation_rules("comment", $form);
+    return $form;
+  }
+
+  /**
+   * @todo Refactor this into a more generic location
+   */
+  private static function _add_validation_rules($model_name, $form) {
+    $rules = ORM::factory($model_name)->validation_rules;
+    foreach ($form->inputs as $name => $input) {
+      if (isset($input->inputs)) {
+        comment::_add_validation_rules($model_name, $input);
+      }
+      if (isset($rules[$name])) {
+        $input->rules($rules[$name]);
+      }
+    }
   }
 
-  static function show_comment_list($item_id) {
-    $v = new View('comment_list.html');
-    $v->item_id = $item_id;
-    $v->comments = ORM::factory('comment')->where('item_id', $item_id)
-      ->orderby('datetime', 'desc')
-      ->find_all()->as_array();
-    return $v;
+  static function block($theme, $show_add_form=true) {
+    $block = new Block;
+    $block->id = "gComment";
+    $block->title = _("Comments");
+    $block->content = comment::get_comments($theme->item());
+
+    if ($show_add_form) {
+      $block->content .= comment::get_add_form($theme->item())->render("form.html");
+    }
+    return $block;
   }
 
-  static function show_comment_form($item_id) {
-    $v = new View('comment_form.html');
-    $v->item_id = $item_id;
-    return $v;
+  static function get_comments($item) {
+    $comments = array("<ul>");
+    foreach (ORM::factory('comment')->where('item_id', $item->id)
+             ->orderby('datetime', 'asc')
+             ->find_all() as $comment) {
+      $v = new View("comment.html");
+      $v->comment = $comment;
+      $comments[] = $v;
+    }
+    $comments[] = "</ul>";
+    return implode("\n", $comments);
   }
 
   /**
diff --git a/modules/comment/views/comment.html.php b/modules/comment/views/comment.html.php
new file mode 100644
index 00000000..2b306404
--- /dev/null
+++ b/modules/comment/views/comment.html.php
@@ -0,0 +1,11 @@
+<? defined("SYSPATH") or die("No direct script access."); ?>
+<li id="gComment-<?= $comment->id; ?>">
+  <p>
+    <a href="#" class="gAuthor"><?= $comment->author ?></a>
+    <?= comment::format_elapsed_time($comment->datetime) ?>,
+    <span class="gUnderstate"><?= strftime('%c', $comment->datetime) ?></span>
+  </p>
+  <div>
+    <?= $comment->text ?> 
+  </div>
+</li>
diff --git a/modules/comment/views/comment_form.html.php b/modules/comment/views/comment_form.html.php
deleted file mode 100644
index 86c76dba..00000000
--- a/modules/comment/views/comment_form.html.php
+++ /dev/null
@@ -1,35 +0,0 @@
-<? defined("SYSPATH") or die("No direct script access."); ?>
-<script type="text/javascript">
-  // <![CDATA[
-function show_comment_add_form(url) {
-  $("#gCommentAddLink").hide();
-  $.get(url, function(data) {
-    $("#gCommentAddFormContainer").html(data);
-    ajaxify_comment_add_form();
-  });
-}
-
-function ajaxify_comment_add_form() {
-  $("form#gComment").ajaxForm({
-    dataType: 'json',
-    success: function(response_data, status_text) {
-      if (response_data['valid']) {
-        $("#gCommentThread").html(response_data["html"]);
-    $("#gCommentAddFormContainer").html("");
-        $("#gCommentAddLink").show();
-      } else {
-        $("#gCommentAddFormContainer").html(response_data["html"]);
-        ajaxify_comment_add_form();
-      }
-    },
-  });
-}
-  // ]]>
-</script>
-<span id="gCommentAddLink">
-  <a href="javascript:show_comment_add_form('<?= url::site("photo/{$item_id}/comments/add") ?>')">
-    <?= _("Add Comment") ?>
-  </a>
-</span>
-<div id="gCommentAddFormContainer"></div>
-
diff --git a/modules/comment/views/comment_list.html.php b/modules/comment/views/comment_list.html.php
deleted file mode 100644
index 16371541..00000000
--- a/modules/comment/views/comment_list.html.php
+++ /dev/null
@@ -1,13 +0,0 @@
-<? defined("SYSPATH") or die("No direct script access."); ?>
-<? foreach (array_reverse($comments) as $index => $comment): ?>
-<li id="gComment-<?= $index; ?>" class="gComment <?= text::alternate("gEven", "gOdd") ?>">
-  <p>
-    <a href="#" class="gAuthor"><?= $comment->author ?></a>
-    <?= comment::format_elapsed_time($comment->datetime) ?>,
-    <span class="gUnderstate"><?= strftime('%c', $comment->datetime) ?></span>
-  </p>
-  <div>
-    <?= $comment->text ?>
-  </div>
-</li>
-<? endforeach; ?>
diff --git a/modules/comment/views/show_comments.html.php b/modules/comment/views/show_comments.html.php
deleted file mode 100644
index 35b2c67a..00000000
--- a/modules/comment/views/show_comments.html.php
+++ /dev/null
@@ -1,11 +0,0 @@
-<? defined("SYSPATH") or die("No direct script access."); ?>
-<div id="gComments">
-  <? if ($comment_list): ?>
-    <h2><?= _("Comments") ?></h2>
-    <ul id="gCommentThread">
-      <?= $comment_list ?>
-    </ul>
-  <? endif ?>
-
-  <?= $comment_form ?>
-</div>
-- 
cgit v1.2.3