/
approve.php
460 lines (387 loc) · 16.8 KB
/
approve.php
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
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
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
<?php
if(!defined('DOKU_INC')) die();
class action_plugin_approve_approve extends DokuWiki_Action_Plugin {
/**
* @param Doku_Event_Handler $controller
*/
public function register(Doku_Event_Handler $controller) {
$controller->register_hook('TPL_ACT_RENDER', 'AFTER', $this, 'handle_diff_accept');
$controller->register_hook('HTML_SHOWREV_OUTPUT', 'BEFORE', $this, 'handle_showrev');
$controller->register_hook('ACTION_ACT_PREPROCESS', 'BEFORE', $this, 'handle_approve');
$controller->register_hook('ACTION_ACT_PREPROCESS', 'BEFORE', $this, 'handle_mark_ready_for_approval');
$controller->register_hook('ACTION_ACT_PREPROCESS', 'BEFORE', $this, 'handle_viewer');
$controller->register_hook('TPL_ACT_RENDER', 'BEFORE', $this, 'handle_display_banner');
$controller->register_hook('COMMON_WIKIPAGE_SAVE', 'AFTER', $this, 'handle_pagesave_after');
}
/**
* @param Doku_Event $event
*/
public function handle_diff_accept(Doku_Event $event) {
global $INFO;
try {
/** @var \helper_plugin_approve_db $db_helper */
$db_helper = plugin_load('helper', 'approve_db');
$sqlite = $db_helper->getDB();
} catch (Exception $e) {
msg($e->getMessage(), -1);
return;
}
/** @var helper_plugin_approve $helper */
$helper = plugin_load('helper', 'approve');
if (!$helper->use_approve_here($sqlite, $INFO['id'])) return;
if ($event->data == 'diff' && isset($_GET['approve'])) {
$href = wl($INFO['id'], ['approve' => 'approve']);
ptln('<a href="' . $href . '">'.$this->getLang('approve').'</a>');
}
if ($this->getConf('ready_for_approval') && $event->data == 'diff' && isset($_GET['ready_for_approval'])) {
$href = wl($INFO['id'], ['ready_for_approval' => 'ready_for_approval']);
ptln('<a href="' . $href . '">'.$this->getLang('approve_ready').'</a>');
}
}
/**
* @param Doku_Event $event
*/
public function handle_showrev(Doku_Event $event) {
global $INFO;
try {
/** @var \helper_plugin_approve_db $db_helper */
$db_helper = plugin_load('helper', 'approve_db');
$sqlite = $db_helper->getDB();
} catch (Exception $e) {
msg($e->getMessage(), -1);
return;
}
/** @var helper_plugin_approve $helper */
$helper = plugin_load('helper', 'approve');
if (!$helper->use_approve_here($sqlite, $INFO['id'])) return;
$last_approved_rev = $helper->find_last_approved($sqlite, $INFO['id']);
if ($last_approved_rev == $INFO['rev']) {
$event->preventDefault();
}
}
/**
* @param Doku_Event $event
*/
public function handle_approve(Doku_Event $event) {
global $INFO;
try {
/** @var \helper_plugin_approve_db $db_helper */
$db_helper = plugin_load('helper', 'approve_db');
$sqlite = $db_helper->getDB();
} catch (Exception $e) {
msg($e->getMessage(), -1);
return;
}
/** @var helper_plugin_approve $helper */
$helper = plugin_load('helper', 'approve');
if ($event->data != 'show') return;
if (!isset($_GET['approve'])) return;
if (!$helper->use_approve_here($sqlite, $INFO['id'], $approver)) return;
if (!$helper->client_can_approve($INFO['id'], $approver)) return;
$res = $sqlite->query('SELECT MAX(version)+1 FROM revision
WHERE page=?', $INFO['id']);
$next_version = $sqlite->res2single($res);
if (!$next_version) {
$next_version = 1;
}
//approved IS NULL prevents from overriding already approved page
$sqlite->query('UPDATE revision
SET approved=?, approved_by=?, version=?
WHERE page=? AND current=1 AND approved IS NULL',
date('c'), $INFO['client'], $next_version, $INFO['id']);
header('Location: ' . wl($INFO['id']));
}
/**
* @param Doku_Event $event
*/
public function handle_mark_ready_for_approval(Doku_Event $event) {
global $INFO;
try {
/** @var \helper_plugin_approve_db $db_helper */
$db_helper = plugin_load('helper', 'approve_db');
$sqlite = $db_helper->getDB();
} catch (Exception $e) {
msg($e->getMessage(), -1);
return;
}
/** @var helper_plugin_approve $helper */
$helper = plugin_load('helper', 'approve');
if ($event->data != 'show') return;
if (!isset($_GET['ready_for_approval'])) return;
if (!$helper->use_approve_here($sqlite, $INFO['id'])) return;
if (!$helper->client_can_mark_ready_for_approval($INFO['id'])) return;
$sqlite->query('UPDATE revision SET ready_for_approval=?, ready_for_approval_by=?
WHERE page=? AND current=1 AND ready_for_approval IS NULL',
date('c'), $INFO['client'], $INFO['id']);
header('Location: ' . wl($INFO['id']));
}
/**
* Redirect to newest approved page for user that don't have EDIT permission.
*
* @param Doku_Event $event
*/
public function handle_viewer(Doku_Event $event) {
global $INFO;
try {
/** @var \helper_plugin_approve_db $db_helper */
$db_helper = plugin_load('helper', 'approve_db');
$sqlite = $db_helper->getDB();
} catch (Exception $e) {
msg($e->getMessage(), -1);
return;
}
/** @var helper_plugin_approve $helper */
$helper = plugin_load('helper', 'approve');
if ($event->data != 'show') return;
//apply only to current page
if ($INFO['rev'] != 0) return;
if (!$helper->use_approve_here($sqlite, $INFO['id'], $approver)) return;
if ($helper->client_can_see_drafts($INFO['id'], $approver)) return;
$last_approved_rev = $helper->find_last_approved($sqlite, $INFO['id']);
//no page is approved
if (!$last_approved_rev) return;
$last_change_date = @filemtime(wikiFN($INFO['id']));
//current page is approved
if ($last_approved_rev == $last_change_date) return;
header("Location: " . wl($INFO['id'], ['rev' => $last_approved_rev], false, '&'));
}
/**
* @param Doku_Event $event
*/
public function handle_display_banner(Doku_Event $event) {
global $INFO;
/* Return true if banner should not be displayed for users with or below read only permission. */
if(auth_quickaclcheck($ID) <= AUTH_READ && !$this->getConf('display_banner_for_readonly')) {
return true;
};
/* Not returned - rendering the banner */
try {
/** @var \helper_plugin_approve_db $db_helper */
$db_helper = plugin_load('helper', 'approve_db');
$sqlite = $db_helper->getDB();
} catch (Exception $e) {
msg($e->getMessage(), -1);
return;
}
/** @var helper_plugin_approve $helper */
$helper = plugin_load('helper', 'approve');
if ($event->data != 'show') return;
if (!$INFO['exists']) return;
if (!$helper->use_approve_here($sqlite, $INFO['id'], $approver)) return;
// $last_change_date = p_get_metadata($INFO['id'], 'last_change date');
$last_change_date = @filemtime(wikiFN($INFO['id']));
$rev = !$INFO['rev'] ? $last_change_date : $INFO['rev'];
$res = $sqlite->query('SELECT ready_for_approval, ready_for_approval_by,
approved, approved_by, version
FROM revision
WHERE page=? AND rev=?', $INFO['id'], $rev);
$approve = $sqlite->res_fetch_assoc($res);
$classes = [];
if ($this->getConf('prettyprint')) {
$classes[] = 'plugin__approve_noprint';
}
if ($approve['approved']) {
$classes[] = 'plugin__approve_green';
} elseif ($this->getConf('ready_for_approval') && $approve['ready_for_approval']) {
$classes[] = 'plugin__approve_ready';
} else {
$classes[] = 'plugin__approve_red';
}
ptln('<div id="plugin__approve" class="' . implode(' ', $classes) . '">');
// tpl_pageinfo();
// ptln(' | ');
if ($approve['approved']) {
ptln('<strong>'.$this->getLang('approved').'</strong>');
ptln(' ' . dformat(strtotime($approve['approved'])));
if($this->getConf('banner_long')) {
ptln(' ' . $this->getLang('by') . ' ' . userlink($approve['approved_by'], true));
ptln(' (' . $this->getLang('version') . ': ' . $approve['version'] . ')');
}
//not the newest page
if ($rev != $last_change_date) {
$res = $sqlite->query('SELECT rev, current FROM revision
WHERE page=? AND approved IS NOT NULL
ORDER BY rev DESC LIMIT 1', $INFO['id']);
$last_approve = $sqlite->res_fetch_assoc($res);
//we can see drafts
if ($helper->client_can_see_drafts($INFO['id'], $approver)) {
ptln('<a href="' . wl($INFO['id']) . '">');
ptln($this->getLang($last_approve['current'] ? 'newest_approved' : 'newest_draft'));
ptln('</a>');
//we cannot see link to draft but there is some newer approved version
} elseif ($last_approve['rev'] != $rev) {
$urlParameters = [];
if (!$last_approve['current']) {
$urlParameters['rev'] = $last_approve['rev'];
}
ptln('<a href="' . wl($INFO['id'], $urlParameters) . '">');
ptln($this->getLang('newest_approved'));
ptln('</a>');
}
}
} else {
if ($this->getConf('ready_for_approval') && $approve['ready_for_approval']) {
ptln('<strong>'.$this->getLang('marked_approve_ready').'</strong>');
ptln(' ' . dformat(strtotime($approve['ready_for_approval'])));
ptln(' ' . $this->getLang('by') . ' ' . userlink($approve['ready_for_approval_by'], true));
} else {
ptln('<strong>'.$this->getLang('draft').'</strong>');
}
$res = $sqlite->query('SELECT rev, current FROM revision
WHERE page=? AND approved IS NOT NULL
ORDER BY rev DESC LIMIT 1', $INFO['id']);
$last_approve = $sqlite->res_fetch_assoc($res);
//not exists approve for current page
if (!$last_approve) {
//not the newest page
if ($rev != $last_change_date) {
ptln('<a href="'.wl($INFO['id']).'">');
ptln($this->getLang('newest_draft'));
ptln('</a>');
}
} else {
$urlParameters = [];
if (!$last_approve['current']) {
$urlParameters['rev'] = $last_approve['rev'];
}
ptln('<a href="' . wl($INFO['id'], $urlParameters) . '">');
ptln($this->getLang('newest_approved'));
ptln('</a>');
}
//we are in current page
if ($rev == $last_change_date) {
//compare with the last approved page or 0 if there is no approved versions
$last_approved_rev = 0;
if (isset($last_approve['rev'])) {
$last_approved_rev = $last_approve['rev'];
}
if ($this->getConf('ready_for_approval') &&
$helper->client_can_mark_ready_for_approval($INFO['id']) &&
!$approve['ready_for_approval']) {
$urlParameters = [
'rev' => $last_approved_rev,
'do' => 'diff',
'ready_for_approval' => 'ready_for_approval'
];
ptln(' | <a href="'.wl($INFO['id'], $urlParameters).'">');
ptln($this->getLang('approve_ready'));
ptln('</a>');
}
if ($helper->client_can_approve($INFO['id'], $approver)) {
$urlParameters = [
'rev' => $last_approved_rev,
'do' => 'diff',
'approve' => 'approve'
];
ptln(' | <a href="'.wl($INFO['id'], $urlParameters).'">');
ptln($this->getLang('approve'));
ptln('</a>');
}
}
}
if ($approver && $this->getConf('banner_long')) {
ptln(' | ' . $this->getLang('approver') . ': ' . userlink($approver, true));
}
ptln('</div>');
}
/**
* @return bool|string|void
*/
protected function lastRevisionHasntApprovalData($id) {
try {
/** @var \helper_plugin_approve_db $db_helper */
$db_helper = plugin_load('helper', 'approve_db');
$sqlite = $db_helper->getDB();
} catch (Exception $e) {
msg($e->getMessage(), -1);
return;
}
$res = $sqlite->query('SELECT rev FROM revision
WHERE page=?
AND current=1
AND approved IS NULL
AND ready_for_approval IS NULL', $id);
return $sqlite->res2single($res);
}
/**
*
* @param Doku_Event $event event object by reference
* @return void
*/
public function handle_pagesave_after(Doku_Event $event) {
try {
/** @var \helper_plugin_approve_db $db_helper */
$db_helper = plugin_load('helper', 'approve_db');
$sqlite = $db_helper->getDB();
} catch (Exception $e) {
msg($e->getMessage(), -1);
return;
}
/** @var helper_plugin_approve $helper */
$helper = plugin_load('helper', 'approve');
//no content was changed
if (!$event->data['contentChanged']) return;
$changeType = $event->data['changeType'];
if ($changeType == DOKU_CHANGE_TYPE_REVERT) {
if ($event->data['oldContent'] == '') {
$changeType = DOKU_CHANGE_TYPE_CREATE;
} else {
$changeType = DOKU_CHANGE_TYPE_EDIT;
}
}
$id = $event->data['id'];
switch ($changeType) {
case DOKU_CHANGE_TYPE_EDIT:
case DOKU_CHANGE_TYPE_REVERT:
case DOKU_CHANGE_TYPE_MINOR_EDIT:
$last_change_date = $event->data['newRevision'];
//if the current page has approved or ready_for_approval -- keep it
$rev = $this->lastRevisionHasntApprovalData($id);
if ($rev) {
$sqlite->query('UPDATE revision SET rev=? WHERE page=? AND rev=?',
$last_change_date, $id, $rev);
} else {
//keep previous record
$sqlite->query('UPDATE revision SET current=0
WHERE page=?
AND current=1', $id);
$sqlite->storeEntry('revision', [
'page' => $id,
'rev' => $last_change_date,
'current' => 1
]);
}
break;
case DOKU_CHANGE_TYPE_DELETE:
//delete information about availability of a page but keep the history
$sqlite->query('DELETE FROM page WHERE page=?', $id);
//delete revision if no information about approvals
$rev = $this->lastRevisionHasntApprovalData($id);
if ($rev) {
$sqlite->query('DELETE FROM revision WHERE page=? AND rev=?', $id, $rev);
} else {
$sqlite->query('UPDATE revision SET current=0 WHERE page=? AND current=1', $id);
}
break;
case DOKU_CHANGE_TYPE_CREATE:
if ($helper->isPageAssigned($sqlite, $id, $newApprover)) {
$data = [
'page' => $id,
'hidden' => $helper->in_hidden_namespace($sqlite, $id) ? '1' : '0'
];
if (!blank($newApprover)) {
$data['approver'] = $newApprover;
}
$sqlite->storeEntry('page', $data);
}
//store revision
$last_change_date = $event->data['newRevision'];
$sqlite->storeEntry('revision', [
'page' => $id,
'rev' => $last_change_date,
'current' => 1
]);
break;
}
}
}