1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
<?php defined("SYSPATH") or die("No direct script access.");
/**
* Gallery - a web based photo album viewer and editor
* Copyright (C) 2000-2008 Bharat Mediratta
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or (at
* your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
*/
class Admin_Maintenance_Controller extends Admin_Controller {
/**
* Get all available tasks
* @todo move task definition out into the modules
*/
private function _get_task_definitions() {
$dirty_count = graphics::find_dirty_images_query()->count();
return array(
"graphics::rebuild_dirty_images" => new ArrayObject(
array("name" => t("Rebuild Images"),
"callback" => "graphics::rebuild_dirty_images",
"description" => (
$dirty_count ?
t(array("one" => "You have one image which is out of date",
"other" => "You have {{count}} out-of-date images"),
array("count" => $dirty_count))
: t("All your images are up to date")),
"severity" => $dirty_count ? log::WARNING : log::SUCCESS),
ArrayObject::ARRAY_AS_PROPS));
}
/**
* Show a list of all available, running and finished tasks.
*/
public function index() {
$query = Database::instance()->query(
"UPDATE `tasks` SET `state` = 'stalled' " .
"WHERE done = 0 " .
"AND state <> 'stalled' " .
"AND unix_timestamp(now()) - updated > 120");
$stalled_count = $query->count();
if ($stalled_count) {
log::warning("tasks",
t(array("one" => "One task is stalled",
"other" => "{{count}} tasks are stalled"),
array("count" => $stalled_count)),
t("{{link_start}}view{{link_end}}",
array("link_start" => "<a href=\"" . url::site("admin/maintenance") . "\">",
"link_start" => "</a>")));
}
$view = new Admin_View("admin.html");
$view->content = new View("admin_maintenance.html");
$view->content->task_definitions = $this->_get_task_definitions();
$view->content->running_tasks = ORM::factory("task")->where("done", 0)->find_all();
$view->content->finished_tasks = ORM::factory("task")->where("done", 1)->find_all();
$view->content->csrf = access::csrf_token();
print $view;
}
/**
* Start a new task
* @param string $task_callback
*/
public function start($task_callback) {
access::verify_csrf();
$task_definitions = $this->_get_task_definitions();
$task = ORM::factory("task");
$task->callback = $task_callback;
$task->name = $task_definitions[$task_callback]->name;
$task->percent_complete = 0;
$task->status = "";
$task->state = "started";
$task->context = serialize(array());
$task->save();
$view = new View("admin_maintenance_task.html");
$view->csrf = access::csrf_token();
$view->task = $task;
log::info("tasks", t("Task {{task_name}} started (task id {{task_id}})",
array("task_name" => $task->name, "task_id" => $task->id)),
html::anchor(url::site("admin/maintenance"), t("maintenance")));
print $view;
}
/**
* Resume a stalled task
* @param string $task_id
*/
public function resume($task_id) {
access::verify_csrf();
$task = ORM::factory("task", $task_id);
if (!$task->loaded) {
throw new Exception("@todo MISSING_TASK");
}
$view = new View("admin_maintenance_task.html");
$view->csrf = access::csrf_token();
$view->task = $task;
log::info("tasks", t("Task {{task_name}} resumed (task id {{task_id}})",
array("task_name" => $task->name, "task_id" => $task->id)),
html::anchor(url::site("admin/maintenance"), t("maintenance")));
print $view;
}
/**
* Cancel a task.
* @param string $task_id
*/
public function cancel($task_id) {
access::verify_csrf();
$task = ORM::factory("task", $task_id);
if (!$task->loaded) {
throw new Exception("@todo MISSING_TASK");
}
$task->done = 1;
$task->state = "cancelled";
$task->save();
message::success(t("Task cancelled"));
url::redirect("admin/maintenance");
}
/**
* Remove a task.
* @param string $task_id
*/
public function remove($task_id) {
access::verify_csrf();
$task = ORM::factory("task", $task_id);
if (!$task->loaded) {
throw new Exception("@todo MISSING_TASK");
}
$task->delete();
message::success(t("Task removed"));
url::redirect("admin/maintenance");
}
/**
* Run a task. This will trigger the task to do a small amount of work, then it will report
* back with status on the task.
* @param string $task_id
*/
public function run($task_id) {
access::verify_csrf();
$task = ORM::factory("task", $task_id);
if (!$task->loaded) {
throw new Exception("@todo MISSING_TASK");
}
$task->state = "running";
call_user_func_array($task->callback, array(&$task));
$task->save();
if ($task->done) {
switch ($task->state) {
case "success":
log::success("tasks", t("Task {{task_name}} completed (task id {{task_id}})",
array("task_name" => $task->name, "task_id" => $task->id)),
html::anchor(url::site("admin/maintenance"), t("maintenance")));
message::success(t("Task completed successfully"));
break;
case "error":
log::error("tasks", t("Task {{task_name}} failed (task id {{task_id}})",
array("task_name" => $task->name, "task_id" => $task->id)),
html::anchor(url::site("admin/maintenance"), t("maintenance")));
message::success(t("Task failed"));
break;
}
print json_encode(
array("result" => "success",
"task" => $task->as_array(),
"location" => url::site("admin/maintenance")));
} else {
print json_encode(
array("result" => "in_progress",
"task" => $task->as_array()));
}
}
}
|