Changeset 1984:0b0cb9cd7da7 for plugins/maintenance

Timestamp:

09/21/13 23:52:08 (12 years ago)

Author:

Denis Jean-Chirstian <contact@…>

Branch:

default

Message:

Revamp plugin maintenance, step 4 bis, better place for settings according to boss and some typo, addresses #999

Location:

plugins/maintenance

Files:

• _admin.php (modified) (9 diffs)
• inc/class.dc.maintenance.php (modified) (4 diffs)
• inc/class.dc.maintenance.task.php (modified) (5 diffs)
• inc/tasks/class.dc.maintenance.countcomments.php (modified) (1 diff)
• inc/tasks/class.dc.maintenance.indexcomments.php (modified) (1 diff)
• inc/tasks/class.dc.maintenance.indexposts.php (modified) (1 diff)
• inc/tasks/class.dc.maintenance.vacuum.php (modified) (1 diff)
• inc/tasks/class.dc.maintenance.zipmedia.php (modified) (1 diff)
• inc/tasks/class.dc.maintenance.ziptheme.php (modified) (1 diff)
• index.php (modified) (9 diffs)
• js/preferences.js (deleted)
• js/settings.js (added)

plugins/maintenance/_admin.php

@@ -23 +23 @@
 // Admin behaviors
 $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'));
+$core->addBehavior('adminDashboardOptionsForm',   array('dcMaintenanceAdmin',   'adminDashboardOptionsForm'));
+$core->addBehavior('adminAfterDashboardOptionsUpdate', array('dcMaintenanceAdmin',   'adminAfterDashboardOptionsUpdate'));
 
 /**
@@ -60 +59 @@
 
           $tasks[] = 'dcMaintenanceCache';
+          $tasks[] = 'dcMaintenanceIndexposts';
+          $tasks[] = 'dcMaintenanceIndexcomments';
           $tasks[] = 'dcMaintenanceCountcomments';
-          $tasks[] = 'dcMaintenanceIndexcomments';
-          $tasks[] = 'dcMaintenanceIndexposts';
           $tasks[] = 'dcMaintenanceLogs';
           $tasks[] = 'dcMaintenanceVacuum';
           $tasks[] = 'dcMaintenanceZipmedia';
           $tasks[] = 'dcMaintenanceZiptheme';
-     }
-
-     /**
-      * Dashboard headers.
-      *
-      * Add ajavascript to toggle tasks list.
-      */
-     public static function adminPreferencesHeaders()
-     {
-          return dcPage::jsLoad('index.php?pf=maintenance/js/preferences.js');
      }
 
@@ -122 +111 @@
           // 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);
+          $count = 0;
+          foreach($maintenance->getTasks() as $t)
+          {
+               if ($t->expired() !== false){
+                    $count++;
+               }
+          }
+
+          if (!$count) {
+               return null;
+          }
+
+          $icon[0] .= '<br />'.sprintf(__('One task to execute', '%s tasks to execute', $count), $count);
      }
 
@@ -145 +140 @@
 
           $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);
+          foreach($maintenance->getTasks() as $t)
+          {
+               $ts = $t->expired();
+               if ($ts === false){
+                    continue;
+               }
+
+               $lines[] = 
+               '<li title="'.($ts === null ?
+                    __('This task has never been executed.')
+                    :
+                    sprintf(__('Last execution of this task was on %s.'),
+                         dt::dt2str($core->blog->settings->system->date_format, $ts).' '.
+                         dt::dt2str($core->blog->settings->system->time_format, $ts)
+                    )
+               ).'">'.$t->task().'</li>';
+          }
+
+          if (empty($lines)) {
+               return null;
+          }
 
           $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>'.
+               '<p class="warn">'.sprintf(__('There is a task to execute.', 'There are %s tasks to execute.', count($lines)), count($lines)).'</p>'.
                '<ul>'.implode('',$lines).'</ul>'.
-               '<p><a href="plugin.php?p=maintenance">'.__('Manage task').'</a></p>'.
+               '<p><a href="plugin.php?p=maintenance">'.__('Manage tasks').'</a></p>'.
                '</div>'
                ));
@@ -178 +182 @@
       * @param $args     <b>object</b>  dcCore instance or record
       */
-     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()
-          );
+     public static function adminDashboardOptionsForm($core)
+     {
+          $core->auth->user_prefs->addWorkspace('maintenance');
 
           echo
@@ -202 +190 @@
           '<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).
@@ -210 +196 @@
           '<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 
-          '</div>'.
+          __('Display list of expired tasks on dashboard items').'</label></p>'.
+
           '</div>';
      }
@@ -248 +204 @@
       * User preferences update.
       *
-      * @param $cur <b>cursor</b>  Cursor of user options
       * @param $user_id  <b>string</b>  User ID
       */
-     public static function adminBeforeUserOptionsUpdate($cur, $user_id=null)
+     public static function adminAfterDashboardOptionsUpdate($user_id=null)
      {
           global $core;
 
           if (is_null($user_id)) {
-               return null;
-          }
-
-          $maintenance = new dcMaintenance($core);
-          $tasks = $maintenance->getTasks();
-          if (empty($tasks)) {
                return null;
           }
@@ -268 +217 @@
           $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

@@ -25 +25 @@
 class dcMaintenance
 {
-     private $core;
+     public $core;
      private $tasks = array();
      private $tabs = array();
      private $groups = array();
+     private $logs = null;
 
      /**
@@ -44 +45 @@
           $tabs = new ArrayObject();
           $groups = new ArrayObject();
+          $logs = $this->getLogs();
 
           # --BEHAVIOR-- dcMaintenanceRegister
@@ -75 +77 @@
                }
 
-               $this->tasks[$task] = new $task($this->core, 'plugin.php?p=maintenance');
+               $this->tasks[$task] = new $task($this, 'plugin.php?p=maintenance');
           }
 
@@ -230 +232 @@
 
      /**
-      * Get expired tasks.
-      *
-      * @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 remider is used and tasks expired
-                    if ($task->ts() && strtotime($rs->log_dt) + $task->ts() < time()) {
-                         $logs[$rs->log_msg] = $rs->log_dt;
-                    }
+      * Get logs
+      *
+      * Return array(
+      *        task id => array(
+      *             timestamp of last execution,
+      *             logged on current blog or not
+      *        )
+      * )
+      *
+      * @return     <b>array</b> List of logged tasks
+      */
+     public function getLogs()
+     {
+          if ($this->logs === null) {
+               $rs = $this->core->log->getLogs(array(
+                    'log_table' => 'maintenance',
+                    'blog_id' => 'all'
+               ));
+
+               $this->logs = array();
+               while ($rs->fetch()) {
+                    $this->logs[$rs->log_msg] = array(
+                         'ts' => strtotime($rs->log_dt),
+                         'blog' => $rs->blog_id == $this->core->blog->id
+                    );
                }
           }
-          return $logs;
+
+          return $this->logs;
      }
 }

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

@@ -21 +21 @@
 class dcMaintenanceTask
 {
+     protected $maintenance;
      protected $core;
      protected $p_url;
      protected $code;
-     protected $ts = 604800; // one week
+     protected $ts = 0;
+     protected $expired = 0;
      protected $ajax = false;
+     protected $blog = false;
 
      protected $id;
@@ -43 +46 @@
       * use method init() to do it.
       *
-      * @param core <b>dcCore</b>  dcCore instance
+      * @param maintenance    <b>dcMaintenance</b>     dcMaintenance instance
       * @param p_url     <b>string</b>  Maintenance plugin url
       */
-     public function __construct($core, $p_url)
-     {
-          $this->core =& $core;
+     public function __construct($maintenance, $p_url)
+     {
+          $this->maintenance = $maintenance;
+          $this->core = $maintenance->core;
           $this->init();
 
@@ -64 +68 @@
           }
 
-          $core->auth->user_prefs->addWorkspace('maintenance');
-          $ts = $core->auth->user_prefs->maintenance->get('ts_'.$this->id);
-          
+          $this->core->blog->settings->addNamespace('maintenance');
+          $ts = $this->core->blog->settings->maintenance->get('ts_'.$this->id);
+
           $this->ts = abs((integer) $ts);
      }
@@ -99 +103 @@
      {
           return $this->ts === false ? false : abs((integer) $this->ts);
+     }
+
+     /**
+      * Get task expired.
+      *
+      * This return:
+      * - Timstamp of last update if it expired
+      * - False if it not expired or has no recall time
+      * - Null if it has never been executed
+      *
+      * @return     <b>mixed</b>   Last update
+      */
+     public function expired()
+     {
+          if ($this->expired === 0) {
+               if (!$this->ts()) {
+                    $this->expired = false;
+               }
+               else {
+                    $this->expired = null;
+                    $logs = array();
+                    foreach($this->maintenance->getLogs() as $id => $log)
+                    {
+                         if ($id != $this->id() || $this->blog && !$log['blog']) {
+                              continue;
+                         }
+
+                         $this->expired = $log['ts'] + $this->ts() < time() ? $log['ts'] : false;
+                    }
+               }
+          }
+          return $this->expired;
      }
 
@@ -251 +287 @@
      protected function log()
      {
-          $maintenance = new dcMaintenance($this->core);
-          $maintenance->setLog($this->id);
+          $this->maintenance->setLog($this->id);
      }
 }

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

@@ -18 +18 @@
      protected function init()
      {
-          $this->task         = __('Reset comments and ping counters');
+          $this->task         = __('Count again comments and trackbacks');
           $this->success           = __('Comments and trackback counted.');
-          $this->error        = __('Failed to reset comments and ping counters.');
+          $this->error        = __('Failed to count comments and trackbacks.');
      }
 

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

@@ -23 +23 @@
           $this->name         = __('Search engine index');
           $this->task         = __('Index all comments');
-          $this->step_task    = __('next');
+          $this->step_task    = __('Next');
           $this->step         = __('Indexing comment %d to %d.');
           $this->success           = __('Comments index done.');

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

@@ -23 +23 @@
           $this->name         = __('Search engine index');
           $this->task         = __('Index all posts');
-          $this->step_task    = __('next');
+          $this->step_task    = __('Next');
           $this->step         = __('Indexing entry %d to %d.');
           $this->success           = __('Entries index done.');

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

@@ -18 +18 @@
      protected function init()
      {
-          $this->task         = __('Vacuum tables');
+          $this->task         = __('optimize tables');
           $this->success           = __('Optimization successful.');
-          $this->error        = __('Failed to vacuum tables.');
+          $this->error        = __('Failed to optimize tables.');
      }
 

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

@@ -14 +14 @@
 class dcMaintenanceZipmedia extends dcMaintenanceTask
 {
+     protected $blog = true;
      protected $tab = 'backup';
      protected $group = 'zipblog';

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

@@ -14 +14 @@
 class dcMaintenanceZiptheme extends dcMaintenanceTask
 {
+     protected $blog = true;
      protected $tab = 'backup';
      protected $group = 'zipblog';

plugins/maintenance/index.php

@@ -17 +17 @@
 
 $maintenance = new dcMaintenance($core);
+$core->blog->settings->addNamespace('maintenance');
 
 // Set var
 
+$msg = '';
 $headers = '';
 $p_url = 'plugin.php?p=maintenance';
@@ -27 +29 @@
 $code = empty($_POST['code']) ? null : (integer) $_POST['code'];
 $tab = empty($_REQUEST['tab']) ? 'maintenance' : $_REQUEST['tab'];
+
+// Save settings
+
+if (!empty($_POST['settings'])) {
+
+     try {
+          $core->blog->settings->maintenance->put(
+               'plugin_message', 
+               !empty($_POST['settings_plugin_message']), 
+               'boolean', 
+               'Display alert message of expired tasks on plugin page', 
+               true, 
+               true
+          );
+
+          foreach($maintenance->getTasks() as $t) {
+               if (!empty($_POST['settings_recall_time']) && $_POST['settings_recall_time'] == 'seperate') {
+                    $ts = empty($_POST['settings_ts_'.$t->id()]) ? 0 : $_POST['settings_ts_'.$t->id()];
+               }
+               else {
+                    $ts = $_POST['settings_recall_time'];
+               }
+               $core->blog->settings->maintenance->put(
+                    'ts_'.$t->id(), 
+                    abs((integer) $ts), 
+                    'integer', 
+                    sprintf('Recall time for task %s', $t->id()), 
+                    true, 
+                    true
+               );
+          }
+          
+          http::redirect($p_url.'&done=1&tab='.$tab);
+     }
+     catch(Exception $e) {
+          $core->error->add($e->getMessage());
+     }
+}
 
 // Get task object
@@ -58 +98 @@
 }
 
-// Get expired tasks
-$core->auth->user_prefs->addWorkspace('maintenance');
-if ($core->auth->user_prefs->maintenance->plugin_message) {
-     $expired = $maintenance->getExpired();
-}
+// Combos
+
+$combo_ts = array(
+     __('Every week')         => 1,//604800,
+     __('Every two weeks')    => 1209600,
+     __('Every month')        => 2592000,
+     __('Every two months')   => 5184000
+);
+
+$full_combo_ts = array_merge(array(
+     __('Use different periods for each task') => 'seperate'), 
+     $combo_ts
+);
+
+$task_combo_ts = array_merge(array(
+     __('Never') => 0), 
+     $combo_ts
+);
 
 // Display page
@@ -68 +121 @@
 echo '<html><head>
 <title>'.__('Maintenance').'</title>'.
-dcPage::jsPageTabs($tab);
+dcPage::jsPageTabs($tab).
+dcPage::jsLoad('index.php?pf=maintenance/js/settings.js');;
 
 if ($task && $task->ajax()) {
@@ -87 +141 @@
 // Success message
 
-$msg = $task && !empty($_GET['done']) ? dcPage::success($task->success(),true,true,false) : '';
+if (!empty($_GET['done']) && $tab == 'settings') {
+     $msg = dcPage::success(__('Settings successfully updated'), true, true, false);
+}
+elseif (!empty($_GET['done']) && $task) {
+     $msg = dcPage::success($task->success(), true, true, false);
+}
 
 if ($task && ($res = $task->step()) !== null) {
@@ -120 +179 @@
      '</form>'.
      '<p class="step-back">'.
-          '<a class="back" href="'.$p_url.'">'.__('Back').'</a>'.
+          '<a class="back" href="'.$p_url.'&tab='.$task->tab().'">'.__('Back').'</a>'.
      '</p>'.
      '</div>';
@@ -156 +215 @@
                     html::escapeHTML($t->task()).'</label>';
 
-                    if (array_key_exists($t->id(), $expired)) {
-                         $res_task .= 
-                         '<br /> <span class="warn">'.sprintf(
-                              __('Last execution of this task was on %s.'),
-                              dt::dt2str(__('%Y-%m-%d %H:%M'), $expired[$t->id()])
-                         ).' '.
-                         __('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>';
+                    // Expired task alert message
+                    $ts = $t->expired();
+                    if ($core->blog->settings->maintenance->plugin_message && $ts !== false) {
+                         if ($ts === null) {
+                              $res_task .= 
+                              '<br /> <span class="warn">'.
+                              __('This task has never been executed.').' '.
+                              __('You should execute it now.').'</span>';
+                         }
+                         else {
+                              $res_task .= 
+                              '<br /> <span class="warn">'.sprintf(
+                                   __('Last execution of this task was on %s.'),
+                                   dt::str($core->blog->settings->system->date_format, $ts).' '.
+                                   dt::str($core->blog->settings->system->time_format, $ts)
+                              ).' '.
+                              __('You should execute it now.').'</span>';
+                         }
                     }
 
@@ -192 +256 @@
                form::hidden(array('tab'), $tab_id).
                $core->formNonce().'</p>'.
-               '<p class="form-note info">'.__('This may take a very long time').'.</p>'.
+               '<p class="form-note info">'.__('This may take a very long time.').'.</p>'.
                '</form>'.
                '</div>';
@@ -218 +282 @@
           '</div>';
      }
+
+     // Settings
+
+     echo 
+     '<div id="settings" class="multi-part" title="'.__('Settings').'">'.
+     '<h3>'.__('Settings').'</h3>'.
+     '<form action="'.$p_url.'" method="post">'.
+
+     '<p><label for="settings_plugin_message" class="classic">'.
+     form::checkbox('settings_plugin_message', 1, $core->blog->settings->maintenance->plugin_message).
+     __('Display alert messages on expired tasks').'</label></p>'.
+
+     '<p><label for="settings_recall_time">'.__('Recall time for all tasks:').'</label>'.
+     form::combo('settings_recall_time', $full_combo_ts, 'seperate', 'recall-for-all').
+     '</p>'.
+
+     '<p>'.__('Recall time per task:').'</p>';
+
+     foreach($maintenance->getTasks($core) as $t)
+     {
+          echo
+          '<div class="two-boxes">'.
+
+          '<p><label for="settings_ts_'.$t->id().'">'.$t->task().'</label>'.
+          form::combo('settings_ts_'.$t->id(), $task_combo_ts, $t->ts(), 'recall-per-task').
+          '</p>'.
+
+          '</div>';
+     }
+
+     echo 
+     '<p><input type="submit" value="'.__('Save').'" /> '.
+     form::hidden(array('tab'), 'settings').
+     form::hidden(array('settings'), 1).
+     $core->formNonce().'</p>'.
+     '</form>'.
+     '<p class="info">'.sprintf(
+          __('You can place list of expired tasks on your %s.'),
+          '<a href="preferences.php#user-favorites">'.__('Dashboard').'</a>'
+     ).'</a></p>'.
+     '</div>';
 }