KTDocumentActions.php
26.7 KB
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
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
<?php
require_once(KT_LIB_DIR . '/actions/documentaction.inc.php');
require_once(KT_LIB_DIR . '/subscriptions/Subscription.inc');
require_once(KT_LIB_DIR . '/widgets/fieldWidgets.php');
require_once(KT_LIB_DIR . '/browse/browseutil.inc.php');
require_once(KT_LIB_DIR . '/documentmanagement/documentutil.inc.php');
require_once(KT_LIB_DIR . '/documentmanagement/PhysicalDocumentManager.inc');
$oRegistry =& KTPluginRegistry::getSingleton();
$oPlugin =& $oRegistry->getPlugin('ktcore.plugin');
// {{{ KTDocumentViewAction
class KTDocumentViewAction extends KTDocumentAction {
var $sBuiltInAction = 'downloadDocument';
var $sDisplayName = 'Download';
var $sName = 'ktcore.actions.document.view';
function customiseInfo($aInfo) {
$aInfo['alert'] = _("This will download a copy of the document and is not the same as Checking Out a document. Changes to this downloaded file will not be managed in the DMS.");
return $aInfo;
}
function do_main() {
$oStorage =& KTStorageManagerUtil::getSingleton();
$oDocumentTransaction = & new DocumentTransaction($this->oDocument, "Document downloaded", 'ktcore.transactions.download');
$oDocumentTransaction->create();
$oStorage->download($this->oDocument);
exit(0);
}
}
$oPlugin->registerAction('documentaction', 'KTDocumentViewAction', 'ktcore.actions.document.view');
// }}}
// {{{ KTDocumentCheckOutAction
class KTDocumentCheckOutAction extends KTDocumentAction {
var $sBuiltInAction = 'checkOutDocument';
var $sDisplayName = 'Checkout';
var $sName = 'ktcore.actions.document.checkout';
var $_sDisablePermission = "ktcore.permissions.write";
function getInfo() {
if ($this->oDocument->getIsCheckedOut()) {
return null;
}
return parent::getInfo();
}
function check() {
$res = parent::check();
if ($res !== true) {
return $res;
}
if ($this->oDocument->getIsCheckedOut()) {
$_SESSION['KTErrorMessage'][] = _("This document is already checked out");
controllerRedirect('viewDocument', 'fDocumentId=' . $this->oDocument->getId());
exit(0);
}
return true;
}
function do_main() {
$this->oPage->setBreadcrumbDetails("checkout");
$oTemplate =& $this->oValidator->validateTemplate('ktcore/action/checkout');
$checkout_fields = array();
$checkout_fields[] = new KTStringWidget(_('Reason'), _('The reason for the checkout of this document for historical purposes, and to inform those who wish to check out this document.'), 'reason', "", $this->oPage, true);
$oTemplate->setData(array(
'context' => &$this,
'checkout_fields' => $checkout_fields,
));
return $oTemplate->render();
}
function do_checkout() {
$sReason = KTUtil::arrayGet($_REQUEST, 'reason');
$this->oValidator->notEmpty($sReason);
$oTemplate =& $this->oValidator->validateTemplate('ktcore/action/checkout_final');
$oTemplate->setData(array(
'context' => &$this,
'reason' => $sReason,
));
return $oTemplate->render();
}
function do_checkout_final() {
$sReason = KTUtil::arrayGet($_REQUEST, 'reason');
$this->oValidator->notEmpty($sReason);
// flip the checkout status
$this->oDocument->setIsCheckedOut(true);
// set the user checking the document out
$this->oDocument->setCheckedOutUserID($_SESSION["userID"]);
// update it
if (!$this->oDocument->update()) {
$_SESSION['KTErrorMessage'][] = _("There was a problem checking out the document.");
controllerRedirect('viewDocument', 'fDocumentId=' . $this->oDocument->getId());
}
$oKTTriggerRegistry = KTTriggerRegistry::getSingleton();
$aTriggers = $oKTTriggerRegistry->getTriggers('checkout', 'postValidate');
foreach ($aTriggers as $aTrigger) {
$sTrigger = $aTrigger[0];
$oTrigger = new $sTrigger;
$aInfo = array(
"document" => $this->oDocument,
);
$oTrigger->setInfo($aInfo);
$ret = $oTrigger->postValidate();
if (PEAR::isError($ret)) {
$this->oDocument->delete();
return $ret;
}
}
$oDocumentTransaction = & new DocumentTransaction($this->oDocument, $sReason, 'ktcore.transactions.check_out');
$oDocumentTransaction->create();
$oStorage =& KTStorageManagerUtil::getSingleton();
$oStorage->download($this->oDocument);
exit(0);
}
}
$oPlugin->registerAction('documentaction', 'KTDocumentCheckOutAction', 'ktcore.actions.document.checkout');
// }}}
// {{{ KTDocumentCheckInAction
class KTDocumentCheckInAction extends KTDocumentAction {
var $sBuiltInAction = 'checkInDocument';
var $sDisplayName = 'Checkin';
var $sName = 'ktcore.actions.document.checkin';
var $_sShowPermission = "ktcore.permissions.write";
function getInfo() {
if (!$this->oDocument->getIsCheckedOut()) {
return null;
}
if ($this->oDocument->getCheckedOutUserID() != $this->oUser->getId()) {
return null;
}
return parent::getInfo();
}
function check() {
$res = parent::check();
if ($res !== true) {
return $res;
}
if (!$this->oDocument->getIsCheckedOut()) {
$_SESSION['KTErrorMessage'][] = _("This document is not checked out");
controllerRedirect('viewDocument', 'fDocumentId=' . $this->oDocument->getId());
exit(0);
}
if ($this->oDocument->getCheckedOutUserID() != $this->oUser->getId()) {
$_SESSION['KTErrorMessage'][] = _("This document is checked out, but not by you");
controllerRedirect('viewDocument', 'fDocumentId=' . $this->oDocument->getId());
exit(0);
}
return true;
}
function do_main() {
$this->oPage->setBreadcrumbDetails("checkin");
$oTemplate =& $this->oValidator->validateTemplate('ktcore/action/checkin');
$sReason = KTUtil::arrayGet($_REQUEST, 'reason', "");
$checkin_fields = array();
$checkin_fields[] = new KTFileUploadWidget(_('File'), _('The updated document.'), 'file', "", $this->oPage, true);
$checkin_fields[] = new KTStringWidget(_('Description'), _('Describe the changes made to the document.'), 'reason', $sReason, $this->oPage, true);
$oTemplate->setData(array(
'context' => &$this,
'checkin_fields' => $checkin_fields,
));
return $oTemplate->render();
}
function do_checkin() {
$sReason = KTUtil::arrayGet($_REQUEST, 'reason');
$sReason = $this->oValidator->notEmpty($sReason);
// make sure the user actually selected a file first
if (strlen($_FILES['file']['name']) == 0) {
$this->errorRedirectToMain(_("No file was uploaded"), 'fDocumentId=' . $this->oDocument->getId() . '&reason=' . $sReason);
}
// and that the filename matches
global $default;
$default->log->info("checkInDocumentBL.php uploaded filename=" . $_FILES['file']['name'] . "; current filename=" . $this->oDocument->getFileName());
if ($this->oDocument->getFileName() != $_FILES['file']['name']) {
$this->errorRedirectToMain(_("The file name of the uploaded file does not match the file name of the document in the system"), 'fDocumentId=' . $this->oDocument->getId() . '&reason=' . $sReason);
}
$res = KTDocumentUtil::checkin($this->oDocument, $_FILES['file']['tmp_name'], $sReason, $this->oUser);
if (PEAR::isError($res)) {
$this->errorRedirectToMain(_("An error occurred while trying to check in the document"), 'fDocumentId=' . $this->oDocument->getId() . '&reason=' . $sReason);
}
redirect("$default->rootUrl/control.php?action=viewDocument&fDocumentID=" . $this->oDocument->getID());
}
}
$oPlugin->registerAction('documentaction', 'KTDocumentCheckInAction', 'ktcore.actions.document.checkin');
// }}}
// {{{ KTDocumentEditAction
class KTDocumentEditAction extends KTDocumentAction {
var $sDisplayName = 'Edit metadata';
var $sName = 'ktcore.actions.document.edit';
function getURL() {
return generateControllerLink("editDocument", sprintf("fDocumentId=%d", $this->oDocument->getID()));
}
}
$oPlugin->registerAction('documentaction', 'KTDocumentEditAction', 'ktcore.actions.document.edit');
// }}}
// {{{ KTDocumentDeleteAction
class KTDocumentDeleteAction extends KTDocumentAction {
var $sBuiltInAction = 'deleteDocument';
var $sDisplayName = 'Delete';
var $sName = 'ktcore.actions.document.delete';
var $_sDisablePermission = "ktcore.permissions.write";
function getInfo() {
if ($this->oDocument->getIsCheckedOut()) {
return null;
}
return parent::getInfo();
}
function check() {
$res = parent::check();
if ($res !== true) {
return $res;
}
if ($this->oDocument->getIsCheckedOut()) {
$_SESSION["KTErrorMessage"][]= _("This document can't be deleted because it is checked out");
controllerRedirect('viewDocument', 'fDocumentId=' . $this->oDocument->getId());
exit(0);
}
return true;
}
function do_main() {
$this->oPage->setBreadcrumbDetails("delete");
$oTemplate =& $this->oValidator->validateTemplate('ktcore/action/delete');
$delete_fields = array();
$delete_fields[] = new KTStringWidget(_('Reason'), _('The reason for this document to be removed.'), 'reason', "", $this->oPage, true);
$oTemplate->setData(array(
'context' => &$this,
'delete_fields' => $delete_fields,
));
return $oTemplate->render();
}
function do_delete() {
global $default;
$sReason = KTUtil::arrayGet($_REQUEST, 'reason');
$this->oValidator->notEmpty($sReason);
$this->startTransaction();
// flip the status id
$this->oDocument->setStatusID(DELETED);
if (!$this->oDocument->update()) {
$_SESSION["KTErrorMessage"][]= _("There was a problem deleting the document from the database.");
controllerRedirect('viewDocument', 'fDocumentId=' . $this->oDocument->getId());
exit(0);
}
// now move the document to the delete folder
if (!PhysicalDocumentManager::delete($this->oDocument)) {
//could not delete the document from the file system
$default->log->error("deleteDocumentBL.php Filesystem error deleting document " .
$this->oDocument->getFileName() . " from folder " .
Folder::getFolderPath($this->oDocument->getFolderID()) .
" id=" . $this->oDocument->getFolderID());
//reverse the document deletion
$this->oDocument->setStatusID(LIVE);
$this->oDocument->update();
//get rid of the document transaction
$_SESSION["KTErrorMessage"][]= _("There was a problem deleting the document from storage.");
controllerRedirect('viewDocument', 'fDocumentId=' . $this->oDocument->getId());
exit(0);
}
$oDocumentTransaction = & new DocumentTransaction($this->oDocument, "Document deleted: " . $sReason, 'ktcore.transactions.delete');
$oDocumentTransaction->create();
$this->commitTransaction();
// At this point, the document is deleted.
$oKTTriggerRegistry = KTTriggerRegistry::getSingleton();
$aTriggers = $oKTTriggerRegistry->getTriggers('delete', 'postValidate');
foreach ($aTriggers as $aTrigger) {
$sTrigger = $aTrigger[0];
$oTrigger = new $sTrigger;
$aInfo = array(
"document" => $this->oDocument,
);
$oTrigger->setInfo($aInfo);
$ret = $oTrigger->postValidate();
if (PEAR::isError($ret)) {
$this->oDocument->delete();
return $ret;
}
}
controllerRedirect('browse', 'fFolderId=' . $this->oDocument->getFolderId());
exit(0);
}
}
$oPlugin->registerAction('documentaction', 'KTDocumentDeleteAction', 'ktcore.actions.document.delete');
// }}}
require_once(KT_LIB_DIR . "/browse/DocumentCollection.inc.php");
require_once(KT_LIB_DIR . "/browse/BrowseColumns.inc.php");
require_once(KT_LIB_DIR . "/browse/PartialQuery.inc.php");
class KTDocumentMoveColumn extends TitleColumn {
function KTDocumentMoveColumn($sLabel, $sName, $oDocument) {
$this->oDocument = $oDocument;
parent::TitleColumn($sLabel, $sName);
}
function buildFolderLink($aDataRow) {
$baseurl = KTUtil::arrayGet($this->aOptions, "folderurl", "");
$kt_path_info = KTUtil::arrayGet($_REQUEST, 'kt_path_info');
if (empty($kt_path_info)) {
return sprintf('%s?fDocumentId=%d&fFolderId=%d', $baseurl, $this->oDocument->getId(), $aDataRow["folder"]->getId());
} else {
return sprintf('%s?kt_path_info=%s&fDocumentId=%d&fFolderId=%d', $baseurl, $kt_path_info, $this->oDocument->getId(), $aDataRow["folder"]->getId());
}
}
}
// {{{ KTDocumentMoveAction
class KTDocumentMoveAction extends KTDocumentAction {
var $sBuiltInAction = 'moveDocument';
var $sDisplayName = 'Move';
var $sName = 'ktcore.actions.document.move';
var $_sShowPermission = "ktcore.permissions.write";
function getInfo() {
if ($this->oDocument->getIsCheckedOut()) {
return null;
}
return parent::getInfo();
}
function check() {
$res = parent::check();
if ($res !== true) {
return $res;
}
if ($this->oDocument->getIsCheckedOut()) {
$_SESSION["KTErrorMessage"][]= _("This document can't be deleted because it is checked out");
controllerRedirect('viewDocument', 'fDocumentId=' . $this->oDocument->getId());
exit(0);
}
$iFolderId = KTUtil::arrayGet($_REQUEST, 'fFolderId', $this->oDocument->getFolderId());
$this->oFolder = $this->oValidator->validateFolder($iFolderId);
$this->oDocumentFolder = $this->oValidator->validateFolder($this->oDocument->getFolderId());
return true;
}
function do_main() {
$this->oPage->setBreadcrumbDetails(_("move"));
$oTemplate =& $this->oValidator->validateTemplate('ktcore/action/move');
$move_fields = array();
$aNames = $this->oDocumentFolder->getPathArray();
$aNames[] = $this->oDocument->getName();
$sDocumentName = join(" » ", $aNames);
$move_fields[] = new KTStaticTextWidget(_('Document to move'), '', 'fDocumentId', $sDocumentName, $this->oPage, false);
$collection = new DocumentCollection();
$collection->addColumn(new KTDocumentMoveColumn("Test 1 (title)","title", $this->oDocument));
$qObj = new FolderBrowseQuery($this->oFolder->getId());
$collection->setQueryObject($qObj);
$batchPage = (int) KTUtil::arrayGet($_REQUEST, "page", 0);
$batchSize = 20;
$resultURL = sprintf("?fDocumentId=%d&fFolderId=%d", $this->oDocument->getId(), $this->oFolder->getId());
$collection->setBatching($resultURL, $batchPage, $batchSize);
// ordering. (direction and column)
$displayOrder = KTUtil::arrayGet($_REQUEST, 'sort_order', "asc");
if ($displayOrder !== "asc") { $displayOrder = "desc"; }
$displayControl = KTUtil::arrayGet($_REQUEST, 'sort_on', "title");
$collection->setSorting($displayControl, $displayOrder);
$collection->getResults();
$aBreadcrumbs = array();
$folder_path_names = $this->oFolder->getPathArray();
$folder_path_ids = explode(',', $this->oFolder->getParentFolderIds());
if ($folder_path_ids[0] == 0) {
$folder_path_ids = array();
}
$folder_path_ids[] = $this->oFolder->getId();
foreach (range(0, count($folder_path_ids) - 1) as $index) {
$id = $folder_path_ids[$index];
$url = sprintf("?fDocumentId=%d&fFolderId=%d", $this->oDocument->getId(), $id);
$aBreadcrumbs[] = array("url" => $url, "name" => $folder_path_names[$index]);
}
$oTemplate->setData(array(
'context' => &$this,
'move_fields' => $move_fields,
'collection' => $collection,
'collection_breadcrumbs' => $aBreadcrumbs,
));
return $oTemplate->render();
}
function do_move() {
$this->oPage->setBreadcrumbDetails(_("move"));
$oTemplate =& $this->oValidator->validateTemplate('ktcore/action/move_final');
$sFolderPath = join(" » ", $this->oFolder->getPathArray());
$aNames = $this->oDocumentFolder->getPathArray();
$aNames[] = $this->oDocument->getName();
$sDocumentName = join(" » ", $aNames);
$move_fields = array();
$move_fields[] = new KTStaticTextWidget(_('Document to move'), '', 'fDocumentId', $sDocumentName, $this->oPage, false);
$move_fields[] = new KTStaticTextWidget(_('Target folder'), '', 'fFolderId', $sFolderPath, $this->oPage, false);
$move_fields[] = new KTStringWidget(_('Reason'), _('The reason for this document to be moved.'), 'reason', "", $this->oPage, true);
$oTemplate->setData(array(
'context' => &$this,
'move_fields' => $move_fields,
));
return $oTemplate->render();
}
function do_move_final() {
$sReason = KTUtil::arrayGet($_REQUEST, 'reason');
$aOptions = array(
'message' => _("No reason given"),
'redirect_to' => array('move', sprintf('fDocumentId=%d&fFolderId=%d', $this->oDocument->getId(), $this->oFolder->getId())),
);
$this->oValidator->notEmpty($sReason, $aOptions);
if (!Permission::userHasFolderWritePermission($this->oFolder)) {
$this->errorRedirectTo("main", _("You do not have permission to move a document to this location"), sprintf("fDocumentId=%d&fFolderId=%d", $this->oDocument->getId(), $this->oFolder->getId()));
exit(0);
}
$this->startTransaction();
//put the document in the new folder
$this->oDocument->setFolderID($this->oFolder->getId());
if (!$this->oDocument->update(true)) {
$this->errorRedirectTo("main", _("There was a problem updating the document's location in the database"), sprintf("fDocumentId=%d&fFolderId=%d", $this->oDocument->getId(), $this->oFolder->getId()));
}
//move the document on the file system
$oStorage =& KTStorageManagerUtil::getSingleton();
if (!$oStorage->moveDocument($this->oDocument, $this->oDocumentFolder, $this->oFolder)) {
$this->oDocument->setFolderID($this->oDocumentFolder->getId());
$this->oDocument->update(true);
errorRedirectTo("move", _("There was a problem updating the document's location in the repository storage"), sprintf("fDocumentId=%d&fFolderId=%d", $this->oDocument->getId(), $this->oFolder->getId()));
}
$this->oDocument->update();
$sMoveMessage = sprintf("Moved from %s/%s to %s/%s: %s",
$this->oDocumentFolder->getFullPath(),
$this->oDocumentFolder->getName(),
$this->oFolder->getFullPath(),
$this->oFolder->getName(),
$sReason);
// create the document transaction record
$oDocumentTransaction = & new DocumentTransaction($this->oDocument, $sMoveMessage, 'ktcore.transactions.move');
$oDocumentTransaction->create();
$this->commitTransaction();
$oKTTriggerRegistry = KTTriggerRegistry::getSingleton();
$aTriggers = $oKTTriggerRegistry->getTriggers('moveDocument', 'postValidate');
foreach ($aTriggers as $aTrigger) {
$sTrigger = $aTrigger[0];
$oTrigger = new $sTrigger;
$aInfo = array(
"document" => $this->oDocument,
"old_folder" => $this->oDocumentFolder,
"new_folder" => $this->oFolder,
);
$oTrigger->setInfo($aInfo);
$ret = $oTrigger->postValidate();
if (PEAR::isError($ret)) {
$this->oDocument->delete();
return $ret;
}
}
controllerRedirect('viewDocument', 'fDocumentId=' . $this->oDocument->getId());
exit(0);
}
}
$oPlugin->registerAction('documentaction', 'KTDocumentMoveAction', 'ktcore.actions.document.move');
// }}}
// {{{ KTDocumentHistoryAction
class KTDocumentTransactionHistoryAction extends KTDocumentAction {
var $sDisplayName = 'Transaction History';
var $sName = 'ktcore.actions.document.transactionhistory';
function getURL() {
return generateControllerLink("viewDocument", sprintf("action=history&fDocumentId=%d", $this->oDocument->getID()));
}
}
$oPlugin->registerAction('documentaction', 'KTDocumentTransactionHistoryAction', 'ktcore.actions.document.transactionhistory');
// }}}
// {{{ KTDocumentHistoryAction
class KTDocumentVersionHistoryAction extends KTDocumentAction {
var $sDisplayName = 'Version History';
var $sName = 'ktcore.actions.document.versionhistory';
function getURL() {
return generateControllerLink("viewDocument", sprintf("action=versionhistory&fDocumentId=%d", $this->oDocument->getID()));
}
}
$oPlugin->registerAction('documentaction', 'KTDocumentVersionHistoryAction', 'ktcore.actions.document.versionhistory');
// }}}
// {{{ KTDocumentArchiveAction
class KTDocumentArchiveAction extends KTDocumentAction {
var $sDisplayName = 'Archive';
var $sName = 'ktcore.actions.document.archive';
var $_sShowPermission = "ktcore.permissions.write";
function getInfo() {
if ($this->oDocument->getIsCheckedOut()) {
return null;
}
return parent::getInfo();
}
function do_main() {
$this->oPage->setBreadcrumbDetails(_("archiving"));
$oTemplate =& $this->oValidator->validateTemplate('ktcore/action/archive');
$fields = array();
$fields[] = new KTStringWidget(_('Reason'), _('The reason for the archiving of this document. This will be displayed when the archived document is to be displayed.'), 'reason', "", $this->oPage, true);
$oTemplate->setData(array(
'context' => &$this,
'fields' => $fields,
));
return $oTemplate->render();
}
function do_archive() {
$this->startTransaction();
$this->oDocument->setStatusID(ARCHIVED);
if (!$this->oDocument->update()) {
$_SESSION['KTErrorMessage'][] = _("There was a database error while trying to archive this file");
controllerRedirect('viewDocument', 'fDocumentId=' . $this->oDocument->getId());
exit(0);
}
$this->commitTransaction();
$oKTTriggerRegistry = KTTriggerRegistry::getSingleton();
$aTriggers = $oKTTriggerRegistry->getTriggers('archive', 'postValidate');
foreach ($aTriggers as $aTrigger) {
$sTrigger = $aTrigger[0];
$oTrigger = new $sTrigger;
$aInfo = array(
"document" => $this->oDocument,
);
$oTrigger->setInfo($aInfo);
$ret = $oTrigger->postValidate();
if (PEAR::isError($ret)) {
$this->oDocument->delete();
return $ret;
}
}
controllerRedirect('viewDocument', 'fDocumentId=' . $this->oDocument->getId());
exit(0);
}
}
$oPlugin->registerAction('documentaction', 'KTDocumentArchiveAction', 'ktcore.actions.document.archive');
// }}}
// {{{ KTDocumentWorkflowAction
class KTDocumentWorkflowAction extends KTDocumentAction {
var $sBuiltInAction = 'documentWorkflow';
var $sDisplayName = 'Workflow';
var $sName = 'ktcore.actions.document.workflow';
var $_sShowPermission = "ktcore.permissions.write";
function do_main() {
$this->oPage->setBreadcrumbDetails(_("workflow"));
$oTemplate =& $this->oValidator->validateTemplate("ktcore/workflow/documentWorkflow");
$oDocument =& $this->oValidator->validateDocument($_REQUEST['fDocumentId']);
$oWorkflow = KTWorkflowUtil::getWorkflowForDocument($oDocument);
$oWorkflowState = KTWorkflowUtil::getWorkflowStateForDocument($oDocument);
$oUser =& User::get($_SESSION['userID']);
$aTransitions = KTWorkflowUtil::getTransitionsForDocumentUser($oDocument, $oUser);
$aWorkflows = KTWorkflow::getList();
$fieldErrors = null;
$transition_fields = array();
if ($aTransitions) {
$aVocab = array();
foreach ($aTransitions as $oTransition) {
$aVocab[$oTransition->getId()] = $oTransition->showDescription();
}
$fieldOptions = array("vocab" => $aVocab);
$transition_fields[] = new KTLookupWidget(_('Transition to perform'), 'FIXME', 'fTransitionId', null, $this->oPage, true, null, $fieldErrors, $fieldOptions);
$transition_fields[] = new KTStringWidget(_('Reason for transition'), _('Describe the changes made to the document.'), 'fComments', "", $this->oPage, true);
}
$aTemplateData = array(
'oDocument' => $oDocument,
'oWorkflow' => $oWorkflow,
'oState' => $oWorkflowState,
'aTransitions' => $aTransitions,
'aWorkflows' => $aWorkflows,
'transition_fields' => $transition_fields,
);
return $oTemplate->render($aTemplateData);
}
function do_startWorkflow() {
$oDocument =& $this->oValidator->validateDocument($_REQUEST['fDocumentId']);
$oWorkflow =& $this->oValidator->validateWorkflow($_REQUEST['fWorkflowId']);
$res = KTWorkflowUtil::startWorkflowOnDocument($oWorkflow, $oDocument);
$this->successRedirectToMain(_('Workflow started'),
array('fDocumentId' => $oDocument->getId()));
exit(0);
}
function do_performTransition() {
$oDocument =& $this->oValidator->validateDocument($_REQUEST['fDocumentId']);
$oTransition =& $this->oValidator->validateWorkflowTransition($_REQUEST['fTransitionId']);
$sComments =& $this->oValidator->notEmpty($_REQUEST['fComments']);
$oUser =& User::get($_SESSION['userID']);
$res = KTWorkflowUtil::performTransitionOnDocument($oTransition, $oDocument, $oUser, $sComments);
$this->successRedirectToMain(_('Transition performed'),
array('fDocumentId' => $oDocument->getId()));
}
}
$oPlugin->registerAction('documentaction', 'KTDocumentWorkflowAction', 'ktcore.actions.document.workflow');
// }}}
?>