5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 class TaskHandler extends BaseHandler implements Registerable, HandleableTask {
25 // Exception constants
26 const EXCEPTION_TASK_IS_INVALID = 0xb00;
29 * Protected constructor
33 protected function __construct () {
34 // Call parent constructor
35 parent::__construct(__CLASS__);
38 $this->setHandlerName('task');
42 * Creates an instance of this class
44 * @return $handlerInstance An instance of a HandleableTask class
46 public static final function createTaskHandler () {
48 $handlerInstance = new TaskHandler();
50 // Output debug message
51 self::createDebugInstance(__CLASS__)->debugOutput('TASK-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: Initializing task handler.');
54 $handlerInstance->setListInstance(ObjectFactory::createObjectByConfiguredName('task_list_class'));
56 // Get default instance
57 $handlerInstance->setIteratorInstance($handlerInstance->getListInstance()->getIterator());
59 // Init visitor instance for faster loop
60 $handlerInstance->setVisitorInstance(ObjectFactory::createObjectByConfiguredName('active_task_visitor_class'));
62 // Register the first (and generic) idle-loop task
63 $taskInstance = ObjectFactory::createObjectByConfiguredName('idle_task_class');
64 $handlerInstance->registerTask('idle_loop', $taskInstance);
66 // Output debug message
67 self::createDebugInstance(__CLASS__)->debugOutput('TASK-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: Task handler initialized.');
69 // Return the prepared instance
70 return $handlerInstance;
74 * Tries to execute the given task. If as task should not be started (yet)
75 * or the interval time (see task_interval_delay) is not yet reached the
76 * task is quietly skipped.
79 * @throws InvalidTaskException If the current task is invalid
81 private function executeCurrentTask () {
82 // Update no task by default
85 // Is the current task valid?
86 if (!$this->getListInstance()->getIterator()->valid()) {
88 throw new InvalidTaskException($this, self::EXCEPTION_TASK_IS_INVALID);
92 $currentTask = $this->getListInstance()->getIterator()->current();
94 // Is the task not yet started?
95 if ($currentTask['task_started'] === FALSE) {
96 // Determine difference between current time and registration
97 $diff = ($this->getMilliTime() - $currentTask['task_registered']) * 1000;
99 // Should we start now?
100 if ($diff < $currentTask['task_startup_delay']) {
101 // Skip this silently
102 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('TASK-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: Task ' . $currentTask['id'] . ' not started: diff=' . $diff . ',task_startup_delay=' . $currentTask['task_startup_delay']);
106 // Launch the task and mark it as updated
107 $currentTask['task_started'] = TRUE;
111 self::createDebugInstance(__CLASS__)->debugOutput('TASK-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: Task ' . $currentTask['id'] . ' started with startup_delay=' . $currentTask['task_startup_delay'] . 'ms');
114 // Get time difference from interval delay
115 $diff = ($this->getMilliTime() - $currentTask['task_last_activity']) * 1000;
118 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('TASK-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: Task ' . $currentTask['id'] . ' diff=' . $diff . ',task_interval_delay=' . $currentTask['task_interval_delay'] . ',task_max_runs=' . $currentTask['task_max_runs'] . ',task_total_runs=' . $currentTask['task_total_runs']);
120 // Is the interval delay reached?
121 if ((($diff < $currentTask['task_interval_delay']) && ($currentTask['task_max_runs'] == 0)) || (($currentTask['task_max_runs'] > 0) && ($currentTask['task_total_runs'] == $currentTask['task_max_runs']))) {
122 // Should we update the task from startup?
123 if ($updateTask === TRUE) {
124 // Update the task before leaving
125 $this->updateTask($currentTask);
128 // Skip this silently
133 $currentTask['task_last_activity'] = $this->getMilliTime();
136 $currentTask['task_total_runs']++;
139 $this->updateTask($currentTask);
142 // @TODO Messurement can be added around this call
143 $currentTask['task_instance']->accept($this->getVisitorInstance());
147 * Updates given task by updating the underlaying list
149 * @param $taskEntry An array with a task
152 private function updateTask (array $taskEntry) {
153 // Get the key from current iteration
154 $key = $this->getListInstance()->getIterator()->key();
156 // Get the hash from key
157 $hash = $this->getListInstance()->getHash($key);
160 $this->getListInstance()->updateCurrentEntryByHash($hash, $taskEntry);
164 * Unregisters the given task
166 * @param $taskData Data of the task
169 private function unregisterTask (array $taskData) {
171 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('TASK-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: Removing task ' . $taskData['id'] . ' from queue - CALLED!');
174 $this->getListInstance()->removeEntry('tasks', $taskData);
177 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('TASK-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: Removing task ' . $taskData['id'] . ' from queue - EXIT!');
181 * Searches a task by given instance
183 * @param $taskInstanc An instanceof a Taskable class
184 * @return $taskName Name of the task as used while registration
186 public function searchTask (Taskable $taskInstance) {
187 // Default is an empty (not found) task name
191 $taskList = $this->getListInstance()->getArrayFromList('tasks');
193 // Search all instances
194 foreach ($taskList as $currentTask) {
195 // Does it match given task instance?
196 if ($currentTask['task_instance']->equals($taskInstance)) {
198 $taskName = $currentTask['id'];
210 * Registers a task with a task handler.
212 * @param $taskName A task name to register the task on
213 * @param $taskInstance The instance we should register as a task
216 public function registerTask ($taskName, Visitable $taskInstance) {
219 // Identifier for the generateHash() method
221 // Whether the task is started
222 'task_started' => FALSE,
223 // Whether the task is paused (not yet implemented)
224 'task_paused' => FALSE,
225 // Whether the task can be paused (not yet implemented)
226 'task_pauseable' => TRUE,
227 // Timestamp of registration
228 'task_registered' => $this->getMilliTime(),
229 // Last activity timestamp
230 'task_last_activity' => 0,
231 // Total runs of this task
232 'task_total_runs' => 0,
233 // Task instance itself
234 'task_instance' => $taskInstance,
235 // Startup delay in milliseconds
236 'task_startup_delay' => $this->getConfigInstance()->getConfigEntry('task_' . $taskName . '_startup_delay'),
237 // Interval time (delay) in milliseconds before this task is executed again
238 'task_interval_delay' => $this->getConfigInstance()->getConfigEntry('task_' . $taskName . '_interval_delay'),
239 // How often should this task run?
240 'task_max_runs' => $this->getConfigInstance()->getConfigEntry('task_' . $taskName . '_max_runs'),
244 $this->getListInstance()->addEntry('tasks', $taskEntry);
247 self::createDebugInstance(__CLASS__)->debugOutput('TASK-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: Task registered: taskName=' . $taskName .
248 ' (taskInstance=' . $taskInstance->__toString() . ')' .
249 ', startupDelay=' . $taskEntry['task_startup_delay'] . 'ms' .
250 ', intervalDelay=' . $taskEntry['task_interval_delay'] . 'ms' .
251 ', maxRuns=' . $taskEntry['task_max_runs'] . ' ...'
256 * Checks whether tasks are left including idle task
258 * @return $tasksLeft Whether there are tasks left to handle
260 public function hasTasksLeft () {
261 // Do we have tasks there?
262 $tasksLeft = (($this->getListInstance() instanceof Listable) && ($this->getListInstance()->count() > 0));
269 * Handles all tasks by checking if they should startup or if it is their
270 * turn to run. You should use this method in a while() loop in conjuntion
271 * with hasTasksLeft() so you can e.g. shutdown by adding a ShutdownTask
272 * which will attempt to remove all tasks from the task handler.
276 public function handleTasks () {
278 if (!$this->getListInstance()->getIterator()->valid()) {
279 // Rewind to the beginning for next loop
280 $this->getListInstance()->getIterator()->rewind();
283 // Try to execute the task
284 $this->executeCurrentTask();
287 $this->getListInstance()->getIterator()->next();
291 * Shuts down all tasks and the task handler itself. This method should be
292 * called from a corresponding filter class.
296 public function doShutdown () {
297 // Always rewind to the beginning for next loop
298 $this->getListInstance()->getIterator()->rewind();
301 self::createDebugInstance(__CLASS__)->debugOutput('TASK-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: Shutting down all ' . $this->getListInstance()->count() . ' tasks...');
303 // Remember all tasks that has been shutdown for removal
306 // Instance a visitor
307 $this->setVisitorInstance(ObjectFactory::createObjectByConfiguredName('shutdown_task_visitor_class'));
309 // Shutdown all tasks in once go
310 while ($this->getListInstance()->getIterator()->valid()) {
312 $currentTask = $this->getListInstance()->getIterator()->current();
314 // Output debug message
315 self::createDebugInstance(__CLASS__)->debugOutput('TASK-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: Shutting down task ' . $currentTask['id'] . ' (taskInstance=' . $currentTask['task_instance']->__toString() . ') ...');
318 $currentTask['task_instance']->accept($this->getVisitorInstance());
320 // Remember this task
321 array_push($tasks, $currentTask);
323 // Advance to next one
324 $this->getListInstance()->getIterator()->next();
328 self::createDebugInstance(__CLASS__)->debugOutput('TASK-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: Shutdown of all tasks completed.');
331 foreach ($tasks as $entry) {
332 $this->unregisterTask($entry);