Changeset 1940:0fb7e85337bf

Timestamp:

09/18/13 10:51:42 (12 years ago)

Author:

Denis Jean-Chirstian <contact@…>

Branch:

default

Message:

Revamp plugin maintenance, step 2, add task reminder, addresses #999

Files:

• locales/en/plugins.po (modified) (1 diff)
• locales/fr/plugins.po (modified) (1 diff)
• plugins/maintenance/_admin.php (modified) (4 diffs)
• plugins/maintenance/inc/class.dc.maintenance.php (modified) (1 diff)
• plugins/maintenance/inc/class.dc.maintenance.task.php (modified) (4 diffs)
• plugins/maintenance/index.php (modified) (4 diffs)

locales/en/plugins.po

@@ -958 +958 @@
 msgstr ""
 
+msgid "one task to update"
+msgstr ""
+
+#, php-format
+msgid "%s tasks to update"
+msgstr ""
+
+msgid "Show maintenance tasks to update."
+msgstr ""
+
+#, php-format
+msgid "Last execution of this task was on %s. You should execute it again."
+msgstr ""
+
 msgid "Failed to empty templates cache directory."
 msgstr ""

locales/fr/plugins.po

@@ -1119 +1119 @@
 msgstr "Impossible d'exécuter la tâche."
 
+msgid "One task to update"
+msgid_plural "%s tasks to update"
+msgstr[] "Une tâche à mettre à jour"
+msgstr[] "%s tâches à mettre à jour"
+
+msgid "Show maintenance tasks to update."
+msgstr "Afficher les tâches de maintenance à mettre à jour."
+
+#, php-format
+msgid "Last execution of this task was on %s. You should execute it again."
+msgstr "La dernière exécution de cette tâches était le %s. Vous devriez l'exécuter à nouveau."
+
 msgid "Failed to empty templates cache directory."
 msgstr "Impossible de vider le répertoire de cache des « templates »."

plugins/maintenance/_admin.php

@@ -24 +24 @@
 $core->addBehavior('dcMaintenanceRegister', array('dcMaintenanceAdmin', 'register'));
 $core->addBehavior('adminDashboardFavs', array('dcMaintenanceAdmin', 'favs'));
+$core->addBehavior('adminDashboardFavsIcon', array('dcMaintenanceAdmin', 'favsicon'));
+$core->addBehavior('adminPreferencesForm',   array('dcMaintenanceAdmin',   'prefform'));
+$core->addBehavior('adminBeforeUserOptionsUpdate',     array('dcMaintenanceAdmin',   'userupd'));
 
 /**
@@ -35 +38 @@
 {
      /**
-      * Register default tasks
+      * Register default tasks.
       *
       * @param $core     <b>dcCore</b>  dcCore instance
@@ -57 +60 @@
 
      /**
-      * Dashboard favs
+      * Dashboard favs.
       *
       * @param $core     <b>dcCore</b>  dcCore instance
@@ -74 +77 @@
      }
 
-     /** @todo Rminder*/
+     /**
+      * Dashboard favs icon.
+      *
+      * This updates maintenance fav icon text 
+      * if there are tasks required maintenance.
+      *
+      * @param $core     <b>dcCore</b>  dcCore instance
+      * @param $name     <b>string</b>  Current fav name
+      * @param $icon     <b>arrayObject</b>  Current fav attributes
+      */
+     public static function favsicon($core, $name, $icon)
+     {
+          // Check icon
+          if ($name !== 'maintenance') {
+               return null;
+          }
+
+          // Check user option
+          $user_options = $core->auth->getOptions();
+          if (empty($user_options['user_maintenance_expired'])) {
+               return null;
+          }
+
+          // Check expired tasks
+          $maintenance = new dcMaintenance($core);
+          $expired = $maintenance->getExpired();
+          $expired = count($expired);
+          if (!$expired) {
+               return null;
+          }
+
+          $icon[0] .= '<br />'.sprintf(__('One task to update', '%s tasks to update', $expired), $expired);
+     }
+
+     /**
+      * User preferences form.
+      *
+      * This add options for superadmin user 
+      * to show or not expired taks.
+      *
+      * @param $args     <b>object</b>  dcCore instance or record
+      */
+     public static function prefform($args)
+     {
+          $opts = array();
+          if ($args instanceof dcCore) {
+               $opts = $args->auth->getOptions();
+               $core = $args;
+          }
+          elseif ($args instanceof record) {
+               $opts = $args->options();
+               $core = $args->core;
+          }
+
+          echo 
+          '<p><label for="user_maintenance_expired" class="classic">'.
+          form::checkbox('user_maintenance_expired', 1, !empty($opts['user_maintenance_expired'])).' '.
+          __('Show maintenance tasks to update.').'</label></p>';
+     }
+
+     /**
+      * User preferences update.
+      *
+      * @param $cur <b>cursor</b>  Cursor of user options
+      * @param $user_id  <b>string</b>  User ID
+      */
+     public static function userupd($cur, $user_id=null)
+     {
+          if (!is_null($user_id)) {
+               $cur->user_options['user_maintenance_expired'] = !empty($_POST['user_maintenance_expired']);
+          }
+     }
 }

plugins/maintenance/inc/class.dc.maintenance.php

@@ -137 +137 @@
           return $res;
      }
+
+     /**
+      * Set log for a task.
+      *
+      * @param id   <b>string</b>  Task ID
+      */
+     public function setLog($id)
+     {
+          // Check if taks exists
+          if (!$this->getTask($id)) {
+               return null;
+          }
+
+          // Get logs from this task
+          $rs = $this->core->con->select (
+               'SELECT log_id '.
+               'FROM '.$this->core->prefix.'log '.
+               "WHERE log_msg = '".$this->core->con->escape($id)."' ".
+               "AND log_table = 'maintenance' "
+          );
+
+          $logs = array();
+          while ($rs->fetch()) {
+               $logs[] = $rs->log_id;
+          }
+
+          // Delete old logs
+          if (!empty($logs)) {
+               $this->core->log->delLogs($logs);
+          }
+
+          // Add new log
+          $cur = $this->core->con->openCursor($this->core->prefix.'log');
+
+          $cur->log_msg = $id;
+          $cur->log_table = 'maintenance';
+          $cur->user_id = $this->core->auth->userID();
+
+          $this->core->log->addLog($cur);
+     }
+
+     /**
+      * Delete all maintenance logs.
+      */
+     public function delLogs()
+     {
+          // Retrieve logs from this task
+          $rs = $this->core->log->getLogs(array(
+               'log_table' => 'maintenance',
+               'blog_id' => 'all'
+          ));
+
+          $logs = array();
+          while ($rs->fetch()) {
+               $logs[] = $rs->log_id;
+          }
+
+          // Delete old logs
+          if (!empty($logs)) {
+               $this->core->log->delLogs($logs);
+          }
+     }
+
+     /**
+      * Get expired task.
+      *
+      * @return     <b>array</b>   Array of expired Task ID / date
+      */
+     public function getExpired()
+     {
+          // Retrieve logs from this task
+          $rs = $this->core->log->getLogs(array(
+               'log_table' => 'maintenance',
+               'blog_id' => 'all'
+          ));
+
+          $logs = array();
+          while ($rs->fetch()) {
+               // Check if task exists
+               if (($task = $this->getTask($rs->log_msg)) !== null) {
+                    // Check if tasks expired
+                    if (strtotime($rs->log_dt) + $task->ts() < time()) {
+                         $logs[$rs->log_msg] = $rs->log_dt;
+                    }
+               }
+          }
+          return $logs;
+     }
 }

plugins/maintenance/inc/class.dc.maintenance.task.php

@@ -24 +24 @@
      protected $p_url;
      protected $code;
+     protected $ts = 604800; // one week
 
      protected $id;
@@ -33 +34 @@
      protected $error;
      protected $success;
-     protected $reminder;
 
      /**
@@ -85 +85 @@
 
      /**
+      * Get timestamp between maintenances.
+      *
+      * @return     <b>intetger</b>     Timestamp
+      */
+     public function ts()
+     {
+          return abs((integer) $this->ts);
+     }
+
+     /**
       * Get task ID.
       *
@@ -165 +175 @@
      }
 
-     /** @todo */
-     public function reminder()
-     {
-          return null;
-     }
-
      /**
       * Get header.

plugins/maintenance/index.php

@@ -23 +23 @@
 $p_url = 'plugin.php?p=maintenance';
 $task = null;
+$expired = array();
 
 $code = empty($_POST['code']) ? null : (integer) $_POST['code'];
@@ -48 +49 @@
           }
           if (true === $code) {
+               $maintenance->setLog($task->id());
                http::redirect($p_url.'&task='.$task->id().'&done=1&tab='.$tab);
           }
@@ -54 +56 @@
           $core->error->add($e->getMessage());
      }
+}
+
+// Get expired tasks
+$user_options = $core->auth->getOptions();
+if (!empty($user_options['user_maintenance_expired'])) {
+     $expired = $maintenance->getExpired();
 }
 
@@ -144 +152 @@
 
                $res .=  
-               '<p>'.form::radio(array('task', $t->id()),$t->id()).' '.
+               '<p>'.form::radio(array('task', $t->id()), $t->id()).' '.
                '<label class="classic" for="'.$t->id().'">'.
-               html::escapeHTML($t->task()).'</label></p>';
+               html::escapeHTML($t->task()).'</label>';
+
+               if (array_key_exists($t->id(), $expired)) {
+                    $res .= 
+                    ' <span class="clear form-note warn">'.sprintf(
+                         __('Last execution of this task was on %s. You should execute it again.'),
+                         dt::dt2str(__('%Y-%m-%d %H:%M'), $expired[$t->id()])
+                    ).'</span>';
+               }
+
+               $res .= '</p>';
           }