view.php
19 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
<?php
// boilerplate.
require_once("config/dmsDefaults.php");
require_once(KT_LIB_DIR . "/templating/templating.inc.php");
require_once(KT_LIB_DIR . "/templating/kt3template.inc.php");
require_once(KT_LIB_DIR . "/dispatcher.inc.php");
require_once(KT_LIB_DIR . "/util/ktutil.inc");
require_once(KT_LIB_DIR . "/database/dbutil.inc");
// document related includes
require_once(KT_LIB_DIR . "/documentmanagement/Document.inc");
require_once(KT_LIB_DIR . "/documentmanagement/DocumentType.inc");
require_once(KT_LIB_DIR . "/documentmanagement/DocumentFieldLink.inc");
require_once(KT_LIB_DIR . "/documentmanagement/documentmetadataversion.inc.php");
require_once(KT_LIB_DIR . "/documentmanagement/documentcontentversion.inc.php");
require_once(KT_LIB_DIR . "/metadata/fieldset.inc.php");
require_once(KT_LIB_DIR . "/security/Permission.inc");
// widget includes.
require_once(KT_LIB_DIR . "/widgets/portlet.inc.php");
require_once(KT_LIB_DIR . "/widgets/fieldsetDisplay.inc.php");
require_once(KT_LIB_DIR . "/widgets/FieldsetDisplayRegistry.inc.php");
require_once(KT_LIB_DIR . "/actions/documentaction.inc.php");
require_once(KT_LIB_DIR . "/browse/browseutil.inc.php");
class ViewDocumentDispatcher extends KTStandardDispatcher {
var $sSection = "view_details";
var $sHelpPage = 'ktcore/browse.html';
function ViewDocumentDispatcher() {
$this->aBreadcrumbs = array(
array('action' => 'browse', 'name' => _('Browse')),
);
parent::KTStandardDispatcher();
}
function check() {
if (!parent::check()) { return false; }
return true;
}
// FIXME identify the current location somehow.
function addPortlets($currentaction = null) {
$actions = KTDocumentActionUtil::getDocumentActionsForDocument($this->oDocument, $this->oUser);
$oPortlet = new KTActionPortlet(_("Document Actions"));
$oPortlet->setActions($actions, $currentaction);
$this->oPage->addPortlet($oPortlet);
}
function do_main() {
// fix legacy, broken items.
if (KTUtil::arrayGet($_REQUEST, "fDocumentID", true) !== true) {
$_REQUEST["fDocumentId"] = KTUtil::arrayGet($_REQUEST, "fDocumentID");
unset($_REQUEST["fDocumentID"]);
}
$document_data = array();
$document_id = KTUtil::arrayGet($_REQUEST, 'fDocumentId');
if ($document_id === null) {
$this->oPage->addError('No document was requested. Please <a href="' . KTBrowseUtil::getBrowseBaseUrl() . '">browse</a> for one.');
return $this->do_error();
}
$document_data["document_id"] = $document_id;
// try get the document.
$oDocument =& Document::get($document_id);
if (PEAR::isError($oDocument)) {
$this->oPage->addError('The document you attempted to retrieve is invalid. Please <a href="' . KTBrowseUtil::getBrowseBaseUrl() . '">browse</a> for one.');
return $this->do_error();
}
if (!KTBrowseUtil::inAdminMode($this->oUser, $oDocument->getFolderId())) {
if ($oDocument->getStatusID() == ARCHIVED) {
$this->oPage->addError(_('This document has been archived. Please contact the system administrator to have it restored if it is still needed.'));
return $this->do_error();
} else if ($oDocument->getStatusID() == DELETED) {
$this->oPage->addError(_('This document has been deleted. Please contact the system administrator to have it restored if it is still needed.'));
return $this->do_error();
} else if (!Permission::userHasDocumentReadPermission($oDocument)) {
$this->oPage->addError(_('You are not allowed to view this document'));
return $this->do_error();
}
}
if ($oDocument->getStatusID() == ARCHIVED) {
$this->oPage->addError(_('This document has been archived.'));
} else if ($oDocument->getStatusID() == DELETED) {
$this->oPage->addError(_('This document has been deleted.'));
}
$this->oPage->setSecondaryTitle($oDocument->getName());
$aOptions = array(
"documentaction" => "viewDocument",
"folderaction" => "browse",
);
$this->oDocument =& $oDocument;
$this->aBreadcrumbs = array_merge($this->aBreadcrumbs, KTBrowseUtil::breadcrumbsForDocument($oDocument, $aOptions));
$this->oPage->setBreadcrumbDetails(_("document details"));
$this->addPortlets("Document Details");
$document_data["document"] = $oDocument;
$document_data["document_type"] =& DocumentType::get($oDocument->getDocumentTypeID());
$is_valid_doctype = true;
if (PEAR::isError($document_data["document_type"])) {
$this->oPage->addError('The document you requested has an invalid <strong>document type</strong>. Unfortunately, this means that we cannot effectively display it.');
$is_valid_doctype = false;
}
// we want to grab all the md for this doc, since its faster that way.
$mdlist =& DocumentFieldLink::getByDocument($oDocument);
$field_values = array();
foreach ($mdlist as $oFieldLink) {
$field_values[$oFieldLink->getDocumentFieldID()] = $oFieldLink->getValue();
}
//var_dump($field_values);
$document_data["field_values"] = $field_values;
// Fieldset generation.
//
// we need to create a set of FieldsetDisplay objects
// that adapt the Fieldsets associated with this lot
// to the view (i.e. ZX3). Unfortunately, we don't have
// any of the plumbing to do it, so we handle this here.
$fieldsets = array();
// we always have a generic.
array_push($fieldsets, new GenericFieldsetDisplay());
$fieldsetDisplayReg =& KTFieldsetDisplayRegistry::getSingleton();
foreach (KTMetadataUtil::fieldsetsForDocument($oDocument) as $oFieldset) {
$displayClass = $fieldsetDisplayReg->getHandler($oFieldset->getNamespace());
array_push($fieldsets, new $displayClass($oFieldset));
}
$checkout_user = 'Unknown user';
if ($oDocument->getIsCheckedOut() == 1) {
$oCOU = User::get($oDocument->getCheckedOutUserId());
if (!(PEAR::isError($oCOU) || ($oCOU == false))) {
$checkout_user = $oCOU->getName();
}
}
$oTemplating =& KTTemplating::getSingleton();
$oTemplate = $oTemplating->loadTemplate("kt3/view_document");
$aTemplateData = array(
"context" => $this,
"sCheckoutUser" => $checkout_user,
"isCheckoutUser" => ($this->oUser->getId() == $oDocument->getCheckedOutUserId()),
"document_id" => $document_id,
"document" => $oDocument,
"document_data" => $document_data,
"fieldsets" => $fieldsets,
);
//return '<pre>' . print_r($aTemplateData, true) . '</pre>';
return $oTemplate->render($aTemplateData);
}
function do_history() {
$document_data = array();
$document_id = KTUtil::arrayGet($_REQUEST, 'fDocumentId');
if ($document_id === null) {
$this->oPage->addError('No document was requested. Please <a href="' . KTBrowseUtil::getBrowseBaseUrl() . '">browse</a> for one.');
return $this->do_error();
}
$document_data["document_id"] = $document_id;
// try get the document.
$oDocument =& Document::get($document_id);
if (PEAR::isError($oDocument)) {
$this->oPage->addError('The document you attempted to retrieve is invalid. Please <a href="' . KTBrowseUtil::getBrowseBaseUrl() . '">browse</a> for one.');
return $this->do_error();
}
// fixme check perms
$this->oDocument =& $oDocument;
$this->oPage->setSecondaryTitle($oDocument->getName());
$aOptions = array(
"documentaction" => "viewDocument",
"folderaction" => "browse",
);
$this->aBreadcrumbs = array_merge($this->aBreadcrumbs, KTBrowseUtil::breadcrumbsForDocument($oDocument, $aOptions));
$this->oPage->setBreadcrumbDetails(_("history"));
$this->addPortlets("History");
$aTransactions = array();
// FIXME create a sane "view user information" page somewhere.
// FIXME do we really need to use a raw db-access here? probably...
$sQuery = "SELECT DTT.name AS transaction_name, U.name AS user_name, DT.version AS version, DT.comment AS comment, DT.datetime AS datetime " .
"FROM " . KTUtil::getTableName("document_transactions") . " AS DT INNER JOIN " . KTUtil::getTableName("users") . " AS U ON DT.user_id = U.id " .
"INNER JOIN " . KTUtil::getTableName("transaction_types") . " AS DTT ON DTT.namespace = DT.transaction_namespace " .
"WHERE DT.document_id = ? ORDER BY DT.datetime DESC";
$aParams = array($document_id);
$res = DBUtil::getResultArray(array($sQuery, $aParams));
if (PEAR::isError($res)) {
var_dump($res); // FIXME be graceful on failure.
exit(0);
}
// FIXME roll up view transactions
$aTransactions = $res;
// render pass.
$this->oPage->title = _("Document History");
$oTemplating =& KTTemplating::getSingleton();
$oTemplate = $oTemplating->loadTemplate("kt3/view_document_history");
$aTemplateData = array(
"context" => $this,
"document_id" => $document_id,
"document" => $oDocument,
"transactions" => $aTransactions,
);
return $oTemplate->render($aTemplateData);
}
function do_versionhistory() {
// this is the list of documents past.
$document_data = array();
$document_id = KTUtil::arrayGet($_REQUEST, 'fDocumentId');
if ($document_id === null) {
$this->oPage->addError('No document was requested. Please <a href="' . KTBrowseUtil::getBrowseBaseUrl() . '">browse</a> for one.');
return $this->do_error();
}
$document_data["document_id"] = $document_id;
// try get the document.
$oDocument =& Document::get($document_id);
if (PEAR::isError($oDocument)) {
$this->oPage->addError('The document you attempted to retrieve is invalid. Please <a href="' . KTBrowseUtil::getBrowseBaseUrl() . '">browse</a> for one.');
return $this->do_error();
}
// fixme check perms
$this->oPage->setSecondaryTitle($oDocument->getName());
$this->oDocument =& $oDocument;
$aOptions = array(
"documentaction" => "viewDocument",
"folderaction" => "browse",
);
$this->aBreadcrumbs = array_merge($this->aBreadcrumbs, KTBrowseUtil::breadcrumbsForDocument($oDocument, $aOptions));
$this->oPage->setBreadcrumbDetails(_("history"));
$this->addPortlets("History");
$aMetadataVersions = KTDocumentMetadataVersion::getByDocument($oDocument);
$aVersions = array();
foreach ($aMetadataVersions as $oVersion) {
$aVersions[] = Document::get($oDocument->getId(), $oVersion->getId());
}
// render pass.
$this->oPage->title = _("Document History");
$oTemplating =& KTTemplating::getSingleton();
$oTemplate = $oTemplating->loadTemplate("kt3/document/metadata_history");
$aActions = KTDocumentActionUtil::getDocumentActionsByNames(array('ktcore.actions.document.view'));
$oAction = $aActions[0];
$oAction->setDocument($this->oDocument);
$aTemplateData = array(
"context" => $this,
"document_id" => $document_id,
"document" => $oDocument,
"versions" => $aVersions,
'downloadaction' => $oAction,
);
return $oTemplate->render($aTemplateData);
}
// FIXME refactor out the document-info creation into a single utility function.
// this gets in:
// fDocumentId (document to compare against)
// fComparisonVersion (the metadata_version of the appropriate document)
function do_viewComparison() {
$document_data = array();
$document_id = KTUtil::arrayGet($_REQUEST, 'fDocumentId');
if ($document_id === null) {
$this->oPage->addError('No document was requested. Please <a href="' . KTBrowseUtil::getBrowseBaseUrl() . '">browse</a> for one.');
return $this->do_error();
}
$document_data["document_id"] = $document_id;
$base_version = KTUtil::arrayGet($_REQUEST, 'fBaseVersion');
// try get the document.
$oDocument =& Document::get($document_id, $base_version);
if (PEAR::isError($oDocument)) {
$this->oPage->addError('The base document you attempted to retrieve is invalid. Please <a href="' . KTBrowseUtil::getBrowseBaseUrl() . '">browse</a> for one.');
return $this->do_error();
}
if (!Permission::userHasDocumentReadPermission($oDocument)) {
// FIXME inconsistent.
$this->oPage->addError(_('You are not allowed to view this document'));
return $this->do_error();
}
$this->oDocument =& $oDocument;
$this->oPage->setSecondaryTitle($oDocument->getName());
$aOptions = array(
"documentaction" => "viewDocument",
"folderaction" => "browse",
);
$this->aBreadcrumbs = array_merge($this->aBreadcrumbs, KTBrowseUtil::breadcrumbsForDocument($oDocument, $aOptions));
$this->oPage->setBreadcrumbDetails(_("compare versions"));
$comparison_version = KTUtil::arrayGet($_REQUEST, 'fComparisonVersion');
if ($comparison_version=== null) {
$this->oPage->addError('No comparison version was requested. Please <a href="' . KTUtil::addQueryStringSelf('action=history&fDocumentId=' . $document_id) . '">select a version</a>.');
return $this->do_error();
}
$oComparison =& Document::get($oDocument->getId(), $comparison_version);
if (PEAR::isError($oComparison)) {
$this->errorRedirectToMain(_('Invalid document to compare against.'));
}
$comparison_data = array();
$comparison_data['document_id'] = $oComparison->getId();
$document_data["document"] = $oDocument;
$comparison_data['document'] = $oComparison;
$document_data["document_type"] =& DocumentType::get($oDocument->getDocumentTypeID());
$comparison_data["document_type"] =& DocumentType::get($oComparison->getDocumentTypeID());
// follow twice: once for normal, once for comparison.
$is_valid_doctype = true;
if (PEAR::isError($document_data["document_type"])) {
$this->oPage->addError('The document you requested has an invalid <strong>document type</strong>. Unfortunately, this means that we cannot effectively display it.');
$is_valid_doctype = false;
}
// we want to grab all the md for this doc, since its faster that way.
$mdlist =& DocumentFieldLink::getList(array('metadata_version_id = ?', array($oDocument->getMetadataVersionId())));
$field_values = array();
foreach ($mdlist as $oFieldLink) {
$field_values[$oFieldLink->getDocumentFieldID()] = $oFieldLink->getValue();
}
$document_data["field_values"] = $field_values;
$mdlist =& DocumentFieldLink::getList(array('metadata_version_id = ?', array($comparison_version)));
$field_values = array();
foreach ($mdlist as $oFieldLink) {
$field_values[$oFieldLink->getDocumentFieldID()] = $oFieldLink->getValue();
}
$comparison_data["field_values"] = $field_values;
// Fieldset generation.
//
// we need to create a set of FieldsetDisplay objects
// that adapt the Fieldsets associated with this lot
// to the view (i.e. ZX3). Unfortunately, we don't have
// any of the plumbing to do it, so we handle this here.
$fieldsets = array();
// we always have a generic.
array_push($fieldsets, new GenericFieldsetDisplay());
// FIXME can we key this on fieldset namespace? or can we have duplicates?
// now we get the other fieldsets, IF there is a valid doctype.
if ($is_valid_doctype) {
// these are the _actual_ fieldsets.
$fieldsetDisplayReg =& KTFieldsetDisplayRegistry::getSingleton();
// and the generics
$activesets = KTFieldset::getGenericFieldsets();
foreach ($activesets as $oFieldset) {
$displayClass = $fieldsetDisplayReg->getHandler($oFieldset->getNamespace());
array_push($fieldsets, new $displayClass($oFieldset));
}
$activesets = KTFieldset::getForDocumentType($oDocument->getDocumentTypeID());
foreach ($activesets as $oFieldset) {
$displayClass = $fieldsetDisplayReg->getHandler($oFieldset->getNamespace());
array_push($fieldsets, new $displayClass($oFieldset));
}
}
// FIXME handle ad-hoc fieldsets.
$this->addPortlets();
$oTemplating =& KTTemplating::getSingleton();
$oTemplate = $oTemplating->loadTemplate("kt3/compare_document");
$aTemplateData = array(
"context" => $this,
"document_id" => $document_id,
"document" => $oDocument,
"document_data" => $document_data,
"comparison_data" => $comparison_data,
"comparison_document" => $oComparison,
"fieldsets" => $fieldsets,
);
//var_dump($aTemplateData["comparison_data"]);
return $oTemplate->render($aTemplateData);
}
/* we have a lot of error handling. this one is the absolute final failure. */
function do_error() {
return ''; // allow normal rendering of errors.
// FIXME show something useful / generic.
}
function do_startComparison() {
$document_data = array();
$document_id = KTUtil::arrayGet($_REQUEST, 'fDocumentId');
if ($document_id === null) {
$this->oPage->addError('No document was requested. Please <a href="' . KTBrowseUtil::getBrowseBaseUrl() . '">browse</a> for one.');
return $this->do_error();
}
$document_data["document_id"] = $document_id;
$comparison_version = KTUtil::arrayGet($_REQUEST, 'fComparisonVersion');
if ($comparison_version=== null) {
$this->oPage->addError('No comparison version was requested. Please <a href="' . KTUtil::addQueryStringSelf('action=history&fDocumentId='.$document_id) . '">select a version</a>.');
return $this->do_error();
}
// try get the document.
$oDocument =& Document::get($document_id, $comparison_version);
if (PEAR::isError($oDocument)) {
$this->oPage->addError('The document you attempted to retrieve is invalid. Please <a href="' . KTBrowseUtil::getBrowseBaseUrl() . '">browse</a> for one.');
return $this->do_error();
}
if (!Permission::userHasDocumentReadPermission($oDocument)) {
// FIXME inconsistent.
$this->oPage->addError(_('You are not allowed to view this document'));
return $this->do_error();
}
$this->oDocument =& $oDocument;
$this->oPage->setSecondaryTitle($oDocument->getName());
$aOptions = array(
"documentaction" => "viewDocument",
"folderaction" => "browse",
);
$this->aBreadcrumbs = array_merge($this->aBreadcrumbs, KTBrowseUtil::breadcrumbsForDocument($oDocument, $aOptions));
$this->oPage->setBreadcrumbDetails(_("Select Document Version to compare against"));
$aMetadataVersions = KTDocumentMetadataVersion::getByDocument($oDocument);
$aVersions = array();
foreach ($aMetadataVersions as $oVersion) {
$aVersions[] = Document::get($oDocument->getId(), $oVersion->getId());
}
$oTemplating =& KTTemplating::getSingleton();
$oTemplate = $oTemplating->loadTemplate("ktcore/document/comparison_version_select");
$aTemplateData = array(
"context" => $this,
"document_id" => $document_id,
"document" => $oDocument,
"versions" => $aVersions,
'downloadaction' => $oAction,
);
return $oTemplate->render($aTemplateData);
}
function getUserForId($iUserId) {
$u = User::get($iUserId);
if (PEAR::isError($u) || ($u == false)) { return _('User no longer exists'); }
return $u->getName();
}
}
$oDispatcher = new ViewDocumentDispatcher;
$oDispatcher->dispatch();
?>