Newer
Older
<?php
/**
* Admin_Cronjobs_SchedulesController
*
* Controller class for the schedules of cronjobs
*
* @author Jan-Hendrik Willms <tleilax+studip@gmail.com>
* @license GPL2 or any laterversion
* @category Stud.IP
* @since 2.4
*/
class Admin_Cronjobs_SchedulesController extends AuthenticatedController
{
protected $_autobind = true;
/**
* Set up this controller.
*
* @param String $action Name of the action to be invoked
* @param Array $args Arguments to be passed to the action method
*/
public function before_filter(&$action, &$args)
{
parent::before_filter($action, $args);
Navigation::activateItem('/admin/config/cronjobs');
PageLayout::setTitle(_('Cronjob-Verwaltung') . ' - ' . _('Cronjobs'));
if (empty($_SESSION['cronjob-filter'])) {
$_SESSION['cronjob-filter'] = [
'where' => '1',
'values' => array_fill_keys(['type', 'status', 'task_id'], null),
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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
];
}
// Setup sidebar
$sidebar = Sidebar::Get();
// Aktionen
$views = $sidebar->addWidget(new ViewsWidget());
$views->addLink(
_('Cronjobs verwalten'),
$this->url_for('admin/cronjobs/schedules')
)->setActive(true);
$views->addLink(
_('Aufgaben verwalten'),
$this->url_for('admin/cronjobs/tasks')
);
$views->addLink(
_('Logs anzeigen'),
$this->url_for('admin/cronjobs/logs')
);
$actions = $sidebar->addWidget(new ActionsWidget());
$actions->addLink(
_('Neuen Cronjob registrieren'),
$this->editURL(),
Icon::create('add')
);
}
/**
* Displays all available schedules according to the set filters.
*
* @param int $page Which page to display
*/
public function index_action($page = 0)
{
$filter = $_SESSION['cronjob-filter'];
$this->total = CronjobSchedule::countBySql('1');
$this->pagination = Pagination::create(
CronjobSchedule::countBySql($filter['where']),
$page
);
$this->schedules = $this->pagination->loadSORMCollection(
CronjobSchedule::class,
$filter['where']
);
// Filters
$this->tasks = CronjobTask::findBySql('1');
$this->filter = $filter['values'];
}
/**
* Displays a schedule.
*
* @param CronjobSchedule $schedule Schedule to display
*/
public function display_action(CronjobSchedule $schedule)
{
if (!$this->schedule) {
PageLayout::postError(_('Es gibt keinen Cronjob mit dieser Id.'));
$this->redirect('admin/cronjobs/schedules');
return;
}
$title = sprintf(_('Cronjob "%s" anzeigen'), $this->schedule->title);
PageLayout::setTitle($title);
}
/**
* Sets the filters for the schedule view.
* Filters are stored in the session.
*/
public function filter_action()
{
$filter = array_filter(Request::optionArray('filter'));
$conditions = [];
if (!empty($filter['type'])) {
$conditions[] = "type = " . DBManager::get()->quote($filter['type']);
}
if (!empty($filter['status'])) {
$active = (int)($filter['status'] === 'active');
$conditions[] = "active = " . DBManager::get()->quote($active);
}
if (!empty($filter['task_id'])) {
$conditions[] = "task_id = " . DBManager::get()->quote($filter['task_id']);
}
$_SESSION['cronjob-filter'] = [
'where' => implode(' AND ' , $conditions) ?: '1',
'values' => $filter,
];
$this->redirect('admin/cronjobs/schedules');
}
/**
* Edits a schedule.
*
* @param String $id Id of the schedule in question (null to create)
* @param int $page Return to this page after editing (optional)
*/
public function edit_action(CronjobSchedule $schedule = null, $page = 0)
{
if (Request::submitted('store')) {
$parameters = Request::getArray('parameters');
$schedule->priority = Request::option('priority', 'normal');
$schedule->title = Request::get('title');
$schedule->description = Request::get('description');
$schedule->active = Request::int('active', 0);
if ($schedule->isNew()) {
$schedule->task_id = Request::option('task_id');
}
$schedule->parameters = $parameters[$schedule->task_id];
$schedule->type = Request::option('type') === 'once'
? 'once'
: 'periodic';
if ($schedule->type === 'once') {
$temp = Request::getArray('once');
$schedule->next_execution = strtotime($temp['date'] . ' ' . $temp['time']);
} else {
$temp = Request::getArray('periodic');
$schedule->minute = $this->extractCronItem($temp['minute']);
$schedule->hour = $this->extractCronItem($temp['hour']);
$schedule->day = $this->extractCronItem($temp['day']);
$schedule->month = $this->extractCronItem($temp['month']);
$schedule->day_of_week = mb_strlen($temp['day_of_week']['value'])
? (int) $temp['day_of_week']['value']
: null;
if ($schedule->active) {
$schedule->next_execution = $schedule->calculateNextExecution();
}
}
$schedule->store();
PageLayout::postSuccess(_('Die Änderungen wurden gespeichert.'));
$this->redirect('admin/cronjobs/schedules/index/' . $page);
return;
}
PageLayout::setTitle(_('Cronjob-Verwaltung') . ' - ' . _('Cronjob bearbeiten'));
$actions = Sidebar::get()->addWidget(new ActionsWidget());
$actions->addLink(
_('Zurück zur Übersicht'),
$this->indexURL($page),
Icon::create('link-intern')
);
$this->page = $page;
$this->tasks = CronjobTask::findBySql('1');
}
/**
* Extracts a cron value from a request item.
*
* @param Array $item Request item consisting of a type (either empty,
* 'once' or 'periodic') and a value (either null
* or a signed int)
* @return mixed Null if type is empty, a negative number if type is
* 'periodic' or a positive number or 0 if type is 'once'
*/
private function extractCronItem($item)
{
if ($item['type'] === '') {
return null;
}
$value = (int) $item['value'];
return $item['type'] === 'periodic'
? $value * -1
: $value;
}
/**
* Activates a schedule.
*
* @param CronjobSchedule $schedule Schedule to activate
* @param int $page Return to this page after activating (optional)
*/
public function activate_action(CronjobSchedule $schedule, $page = 0)
{
$schedule->activate();
if (!Request::isXhr()) {
PageLayout::postSuccess(_('Der Cronjob wurde aktiviert.'));
}
$this->redirect("admin/cronjobs/schedules/index/{$page}#job-{$schedule->id}");
}
/**
* Deactivates a schedule.
*
* @param CronjobSchedule $schedule Schedule to deactivate
* @param int $page Return to this page after deactivating (optional)
*/
public function deactivate_action(CronjobSchedule $schedule, $page = 0)
{
$schedule->deactivate();
if (!Request::isXhr()) {
PageLayout::postSuccess(_('Der Cronjob wurde deaktiviert.'));
}
$this->redirect("admin/cronjobs/schedules/index/{$page}#job-{$schedule->id}");
}
/**
* Cancels/deletes a schedule.
*
* @param CronjobSchedule $schedule Schedule to cancel
* @param int $page Return to this page after canceling (optional)
*/
public function cancel_action(CronjobSchedule $schedule, $page = 0)
{
CSRFProtection::verifyUnsafeRequest();
$schedule->delete();
PageLayout::postSuccess(_('Der Cronjob wurde gelöscht.'));
$this->redirect("admin/cronjobs/schedules/index/{$page}");
}
/**
* Performs a bulk operation on a set of schedules. Operation can be
* either activating, deactivating or canceling/deleting.
*
* @param int $page Return to this page afterwarsd (optional)
*/
public function bulk_action($page = 0)
{
$action = Request::option('action');
$ids = Request::optionArray('ids');
$schedules = CronjobSchedule::findMany($ids);
if ($action === 'activate') {
$schedules = array_filter($schedules, function ($item) { return !$item->active; });
$failed = 0;
foreach ($schedules as $schedule) {
if ($schedule->task->active) {
$schedule->activate();
} else {
$failed += 1;
}
}
if ($failed > 0) {
$message = ngettext('%u Cronjob konnte nicht aktiviert werden, da die entsprechende Aufgabe deaktiviert ist.',
'%u Cronjob(s) konnte(n) nicht aktiviert werden, da die entsprechende Aufgabe deaktiviert ist.',
$failed);
$message = sprintf($message, $failed);
PageLayout::postInfo($message);
}
$n = count($schedules) - $failed;
$message = sprintf(ngettext('%u Cronjob wurde aktiviert.', '%u Cronjobs wurden aktiviert.', $n), $n);
PageLayout::postSuccess($message);
} else if ($action === 'deactivate') {
$schedules = array_filter($schedules, function ($item) { return $item->active; });
foreach ($schedules as $schedule) {
$schedule->deactivate();
}
$n = count($schedules);
$message = sprintf(ngettext('%u Cronjob wurde deaktiviert.', '%u Cronjobs wurden deaktiviert.', $n), $n);
PageLayout::postSuccess($message);
} else if ($action === 'cancel') {
foreach ($schedules as $schedule) {
$schedule->delete();
}
$n = count($schedules);
$message = sprintf(ngettext('%u Cronjob wurde gelöscht.', '%u Cronjobs wurden gelöscht.', $n), $n);
PageLayout::postSuccess($message);
}
$this->redirect("admin/cronjobs/schedules/index/{$page}");
}
}