From 04f02b49c5d524345bc916aad6e247c714177662 Mon Sep 17 00:00:00 2001
From: Tim Almdal <tnalmdal@shaw.ca>
Date: Sun, 5 Jul 2009 17:38:49 -0700
Subject: Add task logging functionality. When a task runs, it creates a log
 that is stored in the persistant cache for 30 days.  On the admin_maintenance
 page there is a new link for completed tasks "browse log".  Clicking this
 will open a dialog box that has the the contents of the log displayed.

The user can then view the log and close the dialog, or press the save button
to download the log to their local machine.
---
 .../gallery/views/admin_maintenance_show_log.html.php | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 modules/gallery/views/admin_maintenance_show_log.html.php

(limited to 'modules/gallery/views/admin_maintenance_show_log.html.php')

diff --git a/modules/gallery/views/admin_maintenance_show_log.html.php b/modules/gallery/views/admin_maintenance_show_log.html.php
new file mode 100644
index 00000000..afd988bb
--- /dev/null
+++ b/modules/gallery/views/admin_maintenance_show_log.html.php
@@ -0,0 +1,19 @@
+<?php defined("SYSPATH") or die("No direct script access.") ?>
+<script type="text/javascript">
+  dismiss = function() {
+    window.location.reload();
+  }
+  download = function(){
+    // send request
+    $('<form action="<?= url::site("admin/maintenance/save_log/$task->id?csrf=$csrf") ?>" method="post"></form>').
+appendTo('body').submit().remove();
+  };
+</script>
+<div id="gTaskLogDialog">
+  <h1> <?= $task->name ?> </h1>
+  <div class="gTaskLog">
+    <pre><?= p::purify($task->get_task_log()) ?></pre>
+  </div>
+  <button id="gCloseButton" class="ui-state-default ui-corner-all" onclick="dismiss()"><?= t("Close") ?></button>
+  <button id="gSaveButton" class="ui-state-default ui-corner-all" onclick="download()"><?= t("Save") ?></button>
+</div>
-- 
cgit v1.2.3


From 5d9e334fe6d7c7c1cf6d39a12684e215e797b4b3 Mon Sep 17 00:00:00 2001
From: Tim Almdal <tnalmdal@shaw.ca>
Date: Tue, 7 Jul 2009 12:49:21 -0700
Subject: Added a wee bit of phpDoc. Changed the name of the method
 get_task_log to get_log Changed the default name of the file when the log is
 downloaded to gallery3_task_log.txt

---
 modules/gallery/controllers/admin_maintenance.php         |  4 ++--
 modules/gallery/models/task.php                           | 14 +++++++++++++-
 modules/gallery/views/admin_maintenance.html.php          |  2 +-
 modules/gallery/views/admin_maintenance_show_log.html.php |  2 +-
 4 files changed, 17 insertions(+), 5 deletions(-)

(limited to 'modules/gallery/views/admin_maintenance_show_log.html.php')

diff --git a/modules/gallery/controllers/admin_maintenance.php b/modules/gallery/controllers/admin_maintenance.php
index 37cc5222..543961a1 100644
--- a/modules/gallery/controllers/admin_maintenance.php
+++ b/modules/gallery/controllers/admin_maintenance.php
@@ -119,8 +119,8 @@ class Admin_Maintenance_Controller extends Admin_Controller {
     }
 
     header("Content-Type: application/text");
-    header("Content-Disposition: filename=g2_import.txt");
-    print $task->get_task_log();
+    header("Content-Disposition: filename=gallery3_task_log.txt");
+    print $task->get_log();
   }
 
   /**
diff --git a/modules/gallery/models/task.php b/modules/gallery/models/task.php
index 55bb8e21..b7e255a2 100644
--- a/modules/gallery/models/task.php
+++ b/modules/gallery/models/task.php
@@ -49,6 +49,10 @@ class Task_Model extends ORM {
     return user::lookup($this->owner_id);
   }
 
+  /**
+   * Log a message to the task log.
+   * @params $msg mixed a string or array of strings
+   */
   public function log($msg) {
     $key = $this->_cache_key();
     $log = Cache::instance()->get($key);
@@ -63,11 +67,19 @@ class Task_Model extends ORM {
                            array("task", "log", "import"), 2592000);
   }
 
-  public function get_task_log() {
+  /**
+   * Retrieve the cached log information for this task.
+   * @returns the log data or null if there is no log data
+   */
+  public function get_log() {
     $log_data = Cache::instance()->get($this->_cache_key());
     return  $log_data !== null ? $log_data : false;
   }
 
+  /**
+   * Build the task cache key
+   * @returns the key to use in access the cache
+   */
   private function _cache_key() {
     return md5("$this->id; $this->name; $this->callback");
   }
diff --git a/modules/gallery/views/admin_maintenance.html.php b/modules/gallery/views/admin_maintenance.html.php
index f50c95dd..eecc045c 100644
--- a/modules/gallery/views/admin_maintenance.html.php
+++ b/modules/gallery/views/admin_maintenance.html.php
@@ -164,7 +164,7 @@
           <a href="<?= url::site("admin/maintenance/remove/$task->id?csrf=$csrf") ?>">
             <?= t("remove") ?>
           </a>
-          <? if ($task->get_task_log()): ?>
+          <? if ($task->get_log()): ?>
           <a class="gDialogLink" href="<?= url::site("admin/maintenance/show_log/$task->id?csrf=$csrf") ?>">
             <?= t("browse log") ?>
           </a>
diff --git a/modules/gallery/views/admin_maintenance_show_log.html.php b/modules/gallery/views/admin_maintenance_show_log.html.php
index afd988bb..9d850986 100644
--- a/modules/gallery/views/admin_maintenance_show_log.html.php
+++ b/modules/gallery/views/admin_maintenance_show_log.html.php
@@ -12,7 +12,7 @@ appendTo('body').submit().remove();
 <div id="gTaskLogDialog">
   <h1> <?= $task->name ?> </h1>
   <div class="gTaskLog">
-    <pre><?= p::purify($task->get_task_log()) ?></pre>
+    <pre><?= p::purify($task->get_log()) ?></pre>
   </div>
   <button id="gCloseButton" class="ui-state-default ui-corner-all" onclick="dismiss()"><?= t("Close") ?></button>
   <button id="gSaveButton" class="ui-state-default ui-corner-all" onclick="download()"><?= t("Save") ?></button>
-- 
cgit v1.2.3