dcCore dcCore instance */ public function __construct($core) { $this->core = $core; $this->p_url = $core->adminurl->get('admin.plugin.maintenance'); $logs = $this->getLogs(); $this->init(); } /** * Initialize list of tabs and groups and tasks. * * To register a tab or group or task, * use behavior dcMaintenanceInit then a method of * dcMaintenance like addTab('myTab', ...). */ protected function init() { # --BEHAVIOR-- dcMaintenanceInit $this->core->callBehavior('dcMaintenanceInit', $this); } /// @name Tab methods //@{ /** * Add a tab. * * @param id string Tab ID * @param name string Tab name * @param options string Options * @return dcMaintenance Self */ public function addTab($id, $name, $options = []) { $this->tabs[$id] = new dcMaintenanceDescriptor($id, $name, $options); return $this; } /** * Get a tab. * * @param id string Tab ID * @return object dcMaintenanceDescriptor of a tab */ public function getTab($id) { return array_key_exists($id, $this->tabs) ? $this->tabs[$id] : null; } /** * Get tabs. * * @return array Array of tabs ID and name */ public function getTabs() { return $this->tabs; } //@} /// @name Group methods //@{ /** * Add a group. * * @param id string Group ID * @param name string Group name * @param options string Options * @return dcMaintenance Self */ public function addGroup($id, $name, $options = []) { $this->groups[$id] = new dcMaintenanceDescriptor($id, $name, $options); return $this; } /** * Get a group. * * @param id string Group ID * @return object dcMaintenanceDescriptor of a group */ public function getGroup($id) { return array_key_exists($id, $this->groups) ? $this->groups[$id] : null; } /** * Get groups. * * @return array Array of groups ID and descriptor */ public function getGroups() { return $this->groups; } //@} /// @name Task methods //@{ /** * Add a task. * * @param task mixed Class name or object * @return boolean True if it is added * @return dcMaintenance Self */ public function addTask($task) { if (class_exists($task) && is_subclass_of($task, 'dcMaintenanceTask')) { $this->tasks[$task] = new $task($this); } return $this; } /** * Get a task object. * * @param id string task ID * @return mixed Task object or null if not exists */ public function getTask($id) { return array_key_exists($id, $this->tasks) ? $this->tasks[$id] : null; } /** * Get tasks. * * @return array Array of tasks objects */ public function getTasks() { return $this->tasks; } /** * Get headers for plugin maintenance admin page. * * @return string Page headers */ public function getHeaders() { $res = ''; foreach ($this->tasks as $task) { $res .= $task->header(); } return $res; } //@} /// @name Log methods //@{ /** * Set log for a task. * * @param id string Task ID */ public function setLog($id) { // Check if taks exists if (!$this->getTask($id)) { return; } // 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 = []; 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([ 'log_table' => 'maintenance', 'blog_id' => 'all' ]); $logs = []; while ($rs->fetch()) { $logs[] = $rs->log_id; } // Delete old logs if (!empty($logs)) { $this->core->log->delLogs($logs); } } /** * Get logs * * Return [ * task id => [ * timestamp of last execution, * logged on current blog or not * ] * ] * * @return array List of logged tasks */ public function getLogs() { if ($this->logs === null) { $rs = $this->core->log->getLogs([ 'log_table' => 'maintenance', 'blog_id' => 'all' ]); $this->logs = []; while ($rs->fetch()) { $this->logs[$rs->log_msg] = [ 'ts' => strtotime($rs->log_dt), 'blog' => $rs->blog_id == $this->core->blog->id ]; } } return $this->logs; } //@} }