Changeset 1969:d2ef655d3195

Timestamp:

09/20/13 18:10:13 (11 years ago)

Author:

Denis Jean-Chirstian <contact@…>

Branch:

default

Message:

Revamp plugin maintenance, step 4, add user prefs (without translation), wait for boss, addresses #999

Location:

plugins/maintenance

Files:

• _admin.php (modified) (9 diffs)
• inc/class.dc.maintenance.php (modified) (2 diffs)
• inc/class.dc.maintenance.task.php (modified) (2 diffs)
• index.php (modified) (2 diffs)
• js/preferences.js (added)

plugins/maintenance/_admin.php

@@ -22 +22 @@
 
 // Admin behaviors
-$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'));
+$core->addBehavior('dcMaintenanceRegister', array('dcMaintenanceAdmin', 'dcMaintenanceRegister'));
+$core->addBehavior('adminPreferencesHeaders', array('dcMaintenanceAdmin', 'adminPreferencesHeaders'));
+$core->addBehavior('adminDashboardFavs', array('dcMaintenanceAdmin', 'adminDashboardFavs'));
+$core->addBehavior('adminDashboardFavsIcon', array('dcMaintenanceAdmin', 'adminDashboardFavsIcon'));
+$core->addBehavior('adminDashboardItems', array('dcMaintenanceAdmin', 'adminDashboardItems'));
+$core->addBehavior('adminPreferencesForm',   array('dcMaintenanceAdmin',   'adminPreferencesForm'));
+$core->addBehavior('adminBeforeUserOptionsUpdate',     array('dcMaintenanceAdmin',   'adminBeforeUserOptionsUpdate'));
 
 /**
@@ -45 +47 @@
       * @param $tabs     <b>arrayObject</b>  Array of tabs to register
       */
-      public static function register($core, $tasks, $groups, $tabs)
+      public static function dcMaintenanceRegister($core, $tasks, $groups, $tabs)
      {
           $tabs['maintenance'] = __('Servicing');
@@ -68 +70 @@
 
      /**
+      * Dashboard headers.
+      *
+      * Add ajavascript to toggle tasks list.
+      */
+     public static function adminPreferencesHeaders()
+     {
+          return dcPage::jsLoad('index.php?pf=maintenance/js/preferences.js');
+     }
+
+     /**
       * Dashboard favs.
       *
@@ -73 +85 @@
       * @param $favs     <b>arrayObject</b>  Array of favs
       */
-     public static function favs($core, $favs)
+     public static function adminDashboardFavs($core, $favs)
      {
           $favs['maintenance'] = new ArrayObject(array(
@@ -95 +107 @@
       * @param $icon     <b>arrayObject</b>  Current fav attributes
       */
-     public static function favsicon($core, $name, $icon)
+     public static function adminDashboardFavsIcon($core, $name, $icon)
      {
           // Check icon
@@ -103 +115 @@
 
           // Check user option
-          $user_options = $core->auth->getOptions();
-          if (empty($user_options['user_maintenance_expired'])) {
+          $core->auth->user_prefs->addWorkspace('maintenance');
+          if (!$core->auth->user_prefs->maintenance->dashboard_icon) {
                return null;
           }
@@ -120 +132 @@
 
      /**
+      * Dashboard items stack.
+      *
+      * @param $core     <b>dcCore</b>  dcCore instance
+      * @param $items    <b>arrayObject</b>  Dashboard items
+      */
+     public static function adminDashboardItems($core, $items)
+     {
+          $core->auth->user_prefs->addWorkspace('maintenance');
+          if (!$core->auth->user_prefs->maintenance->dashboard_item) {
+               return null;
+          }
+
+          $maintenance = new dcMaintenance($core);
+          $tasks = $maintenance->getExpired();
+          if (empty($tasks)) {
+               return null;
+          }
+
+          $lines = array();
+          foreach($tasks as $id => $ts) {
+               $lines[$ts] = 
+               '<li title="'.sprintf(__('Last updated on %s'),
+                    dt::dt2str($core->blog->settings->system->date_format, $ts).' '.
+                    dt::dt2str($core->blog->settings->system->time_format, $ts)
+               ).'">'.$maintenance->getTask($id)->task().'</li>';
+          }
+          ksort($lines);
+
+          $items[] = new ArrayObject(array(
+               '<div id="maintenance-expired">'.
+               '<h3><img src="index.php?pf=maintenance/icon.png" alt="" /> '.__('Maintenance').'</h3>'.
+               '<p>'.sprintf(__('There is a task to update.', 'There are %s tasks to update.', count($tasks)), count($tasks)).'</p>'.
+               '<ul>'.implode('',$lines).'</ul>'.
+               '<p><a href="plugin.php?p=maintenance">'.__('Manage task').'</a></p>'.
+               '</div>'
+               ));
+     }
+
+     /**
       * User preferences form.
       *
@@ -127 +178 @@
       * @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;
+     public static function adminPreferencesForm($core)
+     {
+          $core->auth->user_prefs->addWorkspace('maintenance');
+          $maintenance = new dcMaintenance($core);
+
+          $tasks = $maintenance->getTasks();
+          if (empty($tasks)) {
+               return null;
+          }
+
+          $full_combo_ts = array_merge(array(
+               __('Use different periods for each task') => 'seperate'), 
+               self::comboTs()
+          );
+
+          $task_combo_ts = array_merge(array(
+               __('Never') => 0), 
+               self::comboTs()
+          );
+
+          echo
+          '<div class="fieldset">'.
+          '<h4>'.__('Maintenance').'</h4>'.
+
+          '<div class="two-boxes">'.
+
+          '<p><label for="maintenance_dashboard_icon" class="classic">'.
+          form::checkbox('maintenance_dashboard_icon', 1, $core->auth->user_prefs->maintenance->dashboard_icon).
+          __('Display count of expired tasks on maintenance dashboard icon').'</label></p>'.
+
+          '<p><label for="maintenance_dashboard_item" class="classic">'.
+          form::checkbox('maintenance_dashboard_item', 1, $core->auth->user_prefs->maintenance->dashboard_item).
+          __('Display list of expired tasks on dashboard contents').'</label></p>'.
+
+          '<p><label for="maintenance_plugin_message" class="classic">'.
+          form::checkbox('maintenance_plugin_message', 1, $core->auth->user_prefs->maintenance->plugin_message).
+          __('Display alert message of expired tasks on plugin page').'</label></p>'.
+
+          '</div>'.
+
+          '<div class="two-boxes">'.
+
+          '<p><label for="maintenance_recall_time">'.__('Recall time for all tasks').'</label>'.
+          form::combo('maintenance_recall_time', $full_combo_ts, 'seperate', 'recall-for-all').
+          '</p>'.
+
+          '</div>'.
+
+          '<div id="maintenance-recall-time">'.
+          '<h5>'.__('Recall time per task').'</h5>';
+
+          foreach($tasks as $task) {
+               echo
+               '<div class="two-boxes">'.
+
+               '<p><label for="maintenance_ts_'.$task->id().'">'.$task->task().'</label>'.
+               form::combo('maintenance_ts_'.$task->id(), $task_combo_ts, $task->ts(), 'recall-per-task').
+               '</p>'.
+
+               '</div>';
           }
 
           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>';
+          '</div>'.
+          '</div>';
      }
 
@@ -151 +251 @@
       * @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']);
-          }
+     public static function adminBeforeUserOptionsUpdate($cur, $user_id=null)
+     {
+          global $core;
+
+          if (is_null($user_id)) {
+               return null;
+          }
+
+          $maintenance = new dcMaintenance($core);
+          $tasks = $maintenance->getTasks();
+          if (empty($tasks)) {
+               return null;
+          }
+
+          $core->auth->user_prefs->addWorkspace('maintenance');
+          $core->auth->user_prefs->maintenance->put('dashboard_icon', !empty($_POST['maintenance_dashboard_icon']), 'boolean');
+          $core->auth->user_prefs->maintenance->put('dashboard_item', !empty($_POST['maintenance_dashboard_item']), 'boolean');
+          $core->auth->user_prefs->maintenance->put('plugin_message', !empty($_POST['maintenance_plugin_message']), 'boolean');
+
+          foreach($tasks as $task) {
+               if ($_POST['maintenance_recall_time'] == 'seperate') {
+                    $ts = empty($_POST['maintenance_ts_'.$task->id()]) ? 0 : $_POST['maintenance_ts_'.$task->id()];
+               }
+               else {
+                    $ts = $_POST['maintenance_recall_time'];
+               }
+               $core->auth->user_prefs->maintenance->put('ts_'.$task->id(), abs((integer) $ts), 'integer');
+          }
+     }
+
+     /* @ignore */
+     public static function comboTs()
+     {
+          return array(
+               __('Every week')         => 604800,
+               __('Every two weeks')    => 1209600,
+               __('Every month')        => 2592000,
+               __('Every two months')   => 5184000
+          );
      }
 }

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

@@ -230 +230 @@
 
      /**
-      * Get expired task.
+      * Get expired tasks.
       *
       * @return     <b>array</b>   Array of expired Task ID / date
@@ -246 +246 @@
                // Check if task exists
                if (($task = $this->getTask($rs->log_msg)) !== null) {
-                    // Check if tasks expired
-                    if (strtotime($rs->log_dt) + $task->ts() < time()) {
+                    // Check if remider is used and tasks expired
+                    if ($task->ts() && strtotime($rs->log_dt) + $task->ts() < time()) {
                          $logs[$rs->log_msg] = $rs->log_dt;
                     }

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

@@ -63 +63 @@
                $this->success = __('Task successfully executed.');
           }
+
+          $core->auth->user_prefs->addWorkspace('maintenance');
+          $ts = $core->auth->user_prefs->maintenance->get('ts_'.$this->id);
+          
+          $this->ts = abs((integer) $ts);
      }
 
@@ -93 +98 @@
      public function ts()
      {
-          return abs((integer) $this->ts);
+          return $this->ts === false ? false : abs((integer) $this->ts);
      }
 

plugins/maintenance/index.php

@@ -59 +59 @@
 
 // Get expired tasks
-$user_options = $core->auth->getOptions();
-if (!empty($user_options['user_maintenance_expired'])) {
+$core->auth->user_prefs->addWorkspace('maintenance');
+if ($core->auth->user_prefs->maintenance->plugin_message) {
      $expired = $maintenance->getExpired();
 }
@@ -158 +158 @@
                     if (array_key_exists($t->id(), $expired)) {
                          $res_task .= 
-                         ' <span class="clear form-note warn">'.sprintf(
-                              __('Last execution of this task was on %s. You should execute it again.'),
+                         '<br /> <span class="warn">'.sprintf(
+                              __('Last execution of this task was on %s.'),
                               dt::dt2str(__('%Y-%m-%d %H:%M'), $expired[$t->id()])
-                         ).'</span>';
+                         ).' '.
+                         __('You should execute it now.').'</span>';
+                    }
+                    elseif ($t->ts()) {
+                         $res_task .= 
+                         '<br /> <span class="warn">'.
+                         __('This task has never been executed.').' '.
+                         __('You should execute it now.').'</span>';
                     }