aBreadcrumbs = array(
array('action' => 'browse', 'name' => _kt('Browse')),
);
parent::KTStandardDispatcher();
}
function check() {
if (!parent::check()) { return false; }
$this->persistParams(array('fDocumentId'));
return true;
}
// FIXME identify the current location somehow.
function addPortlets($currentaction = null) {
$currentaction = $this->sName;
$actions = KTDocumentActionUtil::getDocumentActionsForDocument($this->oDocument, $this->oUser, 'documentinfo');
$oPortlet = new KTActionPortlet(sprintf(_kt('Document info')));
$oPortlet->setActions($actions, $currentaction);
$this->oPage->addPortlet($oPortlet);
$this->actions = KTDocumentActionUtil::getDocumentActionsForDocument($this->oDocument, $this->oUser);
$oPortlet = new KTActionPortlet(sprintf(_kt('Document actions'), $this->oDocument->getName()));
$oPortlet->setActions($this->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(sprintf(_kt("No document was requested. Please browse for one."), KTBrowseUtil::getBrowseBaseUrl()));
return $this->do_error();
}
// try get the document.
$oDocument =& Document::get($document_id);
if (PEAR::isError($oDocument)) {
$this->oPage->addError(sprintf(_kt("The document you attempted to retrieve is invalid. Please browse for one."), KTBrowseUtil::getBrowseBaseUrl()));
return $this->do_error();
}
$document_id = $oDocument->getId();
$document_data["document_id"] = $oDocument->getId();
if (!KTBrowseUtil::inAdminMode($this->oUser, $oDocument->getFolderId())) {
if ($oDocument->getStatusID() == ARCHIVED) {
$this->oPage->addError(_kt('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(_kt('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(_kt('You are not allowed to view this document'));
return $this->permissionDenied();
}
}
if ($oDocument->getStatusID() == ARCHIVED) {
$this->oPage->addError(_kt('This document has been archived.'));
} else if ($oDocument->getStatusID() == DELETED) {
$this->oPage->addError(_kt('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(_kt("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(_kt('The document you requested has an invalid document type. 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();
}
}
// is the checkout action active?
$bCanCheckin = false;
foreach ($this->actions as $oDocAction) {
$sActName = $oDocAction->sName;
if ($sActName == 'ktcore.actions.document.cancelcheckout') {
if ($oDocAction->getInfo()) {
$bCanCheckin = true;
}
}
}
// viewlets.
$aViewlets = array();
$aViewletActions = KTDocumentActionUtil::getDocumentActionsForDocument($this->oDocument, $this->oUser, 'documentviewlet');
foreach ($aViewletActions as $oAction) {
$aInfo = $oAction->getInfo();
if ($aInfo !== null) {
$aViewlets[] = $oAction->display_viewlet(); // use the action, since we display_viewlet() later.
}
}
$viewlet_data = implode(" ", $aViewlets);
$viewlet_data = trim($viewlet_data);
$content_class = 'view';
if (!empty($viewlet_data)) {
$content_class = 'view withviewlets';
}
$this->oPage->setContentClass($content_class);
$oTemplating =& KTTemplating::getSingleton();
$oTemplate = $oTemplating->loadTemplate("ktcore/document/view");
$aTemplateData = array(
"context" => $this,
"sCheckoutUser" => $checkout_user,
"isCheckoutUser" => ($this->oUser->getId() == $oDocument->getCheckedOutUserId()),
"canCheckin" => $bCanCheckin,
"document_id" => $document_id,
"document" => $oDocument,
"document_data" => $document_data,
"fieldsets" => $fieldsets,
'viewlet_data' => $viewlet_data,
);
//return '' . print_r($aTemplateData, true) . '
';
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(sprintf(_kt("No document was requested. Please browse for one."), KTBrowseUtil::getBrowseBaseUrl()));
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(sprintf(_kt("The base document you attempted to retrieve is invalid. Please browse for one."), KTBrowseUtil::getBrowseBaseUrl()));
return $this->do_error();
}
if (!Permission::userHasDocumentReadPermission($oDocument)) {
// FIXME inconsistent.
$this->oPage->addError(_kt('You are not allowed to view this document'));
return $this->permissionDenied();
}
$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(_kt("compare versions"));
$comparison_version = KTUtil::arrayGet($_REQUEST, 'fComparisonVersion');
if ($comparison_version=== null) {
$this->oPage->addError(sprintf(_kt("No comparison version was requested. Please select a version."), KTUtil::addQueryStringSelf('action=history&fDocumentId=' . $document_id)));
return $this->do_error();
}
$oComparison =& Document::get($oDocument->getId(), $comparison_version);
if (PEAR::isError($oComparison)) {
$this->errorRedirectToMain(_kt('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(_kt('The document you requested has an invalid document type. 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();
$oTemplate = $this->oValidator->validateTemplate("ktcore/document/compare");
$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);
}
function do_error() {
return ' '; // don't actually do anything.
}
function getUserForId($iUserId) {
$u = User::get($iUserId);
if (PEAR::isError($u) || ($u == false)) { return _kt('User no longer exists'); }
return $u->getName();
}
}
$oDispatcher = new ViewDocumentDispatcher;
$oDispatcher->dispatch();
?>