ImmutableActionPlugin.php
8.3 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
<?php
/**
* $Id$
*
* KnowledgeTree Community Edition
* Document Management Made Simple
* Copyright (C) 2008, 2009 KnowledgeTree Inc.
* Portions copyright The Jam Warehouse Software (Pty) Limited
*
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License version 3 as published by the
* Free Software Foundation.
*
* 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, see <http://www.gnu.org/licenses/>.
*
* You can contact KnowledgeTree Inc., PO Box 7775 #87847, San Francisco,
* California 94120-7775, or email info@knowledgetree.com.
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU General Public License version 3.
*
* In accordance with Section 7(b) of the GNU General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "Powered by
* KnowledgeTree" logo and retain the original copyright notice. If the display of the
* logo is not reasonably feasible for technical reasons, the Appropriate Legal Notices
* must display the words "Powered by KnowledgeTree" and retain the original
* copyright notice.
* Contributor( s): ______________________________________
*
*/
require_once(KT_LIB_DIR . '/plugins/plugin.inc.php');
require_once(KT_LIB_DIR . '/documentmanagement/documentutil.inc.php');
class KTImmutableActionPlugin extends KTPlugin {
var $sNamespace = "ktstandard.immutableaction.plugin";
function KTImmutableActionPlugin($sFilename = null) {
$res = parent::KTPlugin($sFilename);
$this->sFriendlyName = _kt('Immutable action plugin');
return $res;
}
function setup() {
$this->registerAction('documentaction', 'KTDocumentImmutableAction', 'ktcore.actions.document.immutable');
}
}
$oRegistry =& KTPluginRegistry::getSingleton();
$oRegistry->registerPlugin('KTImmutableActionPlugin', 'ktstandard.immutableaction.plugin', __FILE__);
class KTDocumentImmutableAction extends KTDocumentAction {
var $sName = "ktcore.actions.document.immutable";
var $_sShowPermission = 'ktcore.permissions.security';
var $_bMutator = true;
function getDisplayName() {
return _kt('Make immutable');
}
function getInfo() {
if ($this->oDocument->getIsCheckedOut()) {
return null;
}
return parent::getInfo();
}
/*
* Checks if document is Checked Out
* Not really needed, since the action is removed on Check Out
* Still a good precaution though
*
*/
function check() {
$res = parent::check();
if ($res !== true) {
return $res;
}
if ($this->oDocument->getIsCheckedOut()) {
$_SESSION['KTErrorMessage'][]= _kt('This document can\'t be made immutable because it is checked out');
controllerRedirect('viewDocument', 'fDocumentId=' . $this->oDocument->getId());
exit(0);
}
return true;
}
function form_confirm() {
$oForm = new KTForm;
$oForm->setOptions(array(
'label' => _kt('Are you sure?'),
'description' => '',
'action' => 'main',
'fail_action' => 'main',
'cancel_url' => KTBrowseUtil::getUrlForDocument($this->oDocument),
'submit_label' => _kt('Make Immutable'),
'context' => &$this,
));
return $oForm;
}
function form_main() {
$oForm = new KTForm;
$oForm->setOptions(array(
'label' => _kt('Make Immutable'),
'action' => 'immutable',
'fail_action' => 'main',
'cancel_url' => KTBrowseUtil::getUrlForDocument($this->oDocument),
'submit_label' => _kt('Make Immutable'),
'context' => &$this,
));
// Electronic Signature if enabled
global $default;
if($default->enableESignatures){
$widgets[] = array('ktcore.widgets.info', array(
'label' => _kt('This action requires authentication'),
'description' => _kt('Please provide your user credentials as confirmation of this action.'),
'name' => 'info'
));
$widgets[] = array('ktcore.widgets.string', array(
'label' => _kt('Username'),
'name' => 'sign_username',
'required' => true
));
$widgets[] = array('ktcore.widgets.password', array(
'label' => _kt('Password'),
'name' => 'sign_password',
'required' => true
));
}
$widgets[] = array('ktcore.widgets.reason', array(
'label' => _kt('Reason'),
'description' => _kt('Please specify why you are making this document immutable. Please bear in mind that you can use a maximum of <strong>250</strong> characters.'),
'name' => 'reason',
));
$oForm->setWidgets($widgets);
$validators[] = array('ktcore.validators.string', array(
'test' => 'reason',
'min_length' => 1,
'max_length' => 250,
'output' => 'reason',
));
if($default->enableESignatures){
$validators[] = array('electonic.signatures.validators.authenticate', array(
'object_id' => $this->oDocument->iId,
'type' => 'document',
'action' => 'ktcore.transactions.immutable',
'test' => 'info',
'output' => 'info'
));
}
$oForm->setValidators($validators);
return $oForm;
}
function do_main() {
$this->oPage->setBreadcrumbDetails(_kt('Immutable'));
//check if we need confirmation for symblolic links linking to this document
if(count($this->oDocument->getSymbolicLinks())>0 && KTutil::arrayGet($_REQUEST,'postReceived') != 1){
$this->redirectTo("confirm");
}
$oTemplate =& $this->oValidator->validateTemplate('ktstandard/action/immutable');
$oForm = $this->form_main();
$oTemplate->setData(array(
'context' => &$this,
'form' => $oForm,
));
return $oTemplate->render();
}
function do_confirm(){
$this->oPage->setBreadcrumbDetails(_kt('Confirm Making Document Immutable'));
$oTemplate =& $this->oValidator->validateTemplate('ktstandard/action/immutable_confirm');
$oForm = $this->form_confirm();
$oTemplate->setData(array(
'context' => &$this,
'form' => $oForm,
));
return $oTemplate->render();
}
function do_immutable() {
$oForm = $this->form_main();
$res = $oForm->validate();
$data = $res['results'];
if (!empty($res['errors'])) {
return $oForm->handleError();
}
$sReason = $data['reason'];
$fFolderId = $this->oDocument->getFolderId();
$reason = KTUtil::arrayGet($_REQUEST['data'], 'reason');
$this->oDocument->setImmutable(true);
$this->oDocument->update();
// create the document transaction record
$oDocumentTransaction = new DocumentTransaction($this->oDocument, $reason, 'ktcore.transactions.immutable');
$oDocumentTransaction->create();
controllerRedirect('viewDocument', 'fDocumentId=' . $this->oDocument->getId());
exit(0);
}
// No validation main()
// function do_main() {
// if(!$this->oDocument->getIsCheckedOut())
// {
// $this->oDocument->setImmutable(true);
// $this->oDocument->update();
// controllerRedirect('viewDocument', 'fDocumentId=' . $this->oDocument->getId());
// }
// else
// {
// $this->addErrorMessage(_kt('Document is checked out and cannot be made immutable'));
// controllerRedirect('viewDocument', 'fDocumentId=' . $this->oDocument->getId());
// }
// }
}