From 5d35573039f42b6dd231d448cfb80e7a47f41eaa Mon Sep 17 00:00:00 2001 From: Neil Blakey-Milner Date: Sat, 19 Nov 2005 21:56:24 +0000 Subject: [PATCH] Remove old checkin and checkout pages. --- presentation/lookAndFeel/knowledgeTree/documentmanagement/checkInDocumentBL.php | 149 ----------------------------------------------------------------------------------------------------------------------------------------------------- presentation/lookAndFeel/knowledgeTree/documentmanagement/checkInDocumentUI.inc | 112 ---------------------------------------------------------------------------------------------------------------- presentation/lookAndFeel/knowledgeTree/documentmanagement/checkOutDocumentBL.php | 129 --------------------------------------------------------------------------------------------------------------------------------- presentation/lookAndFeel/knowledgeTree/documentmanagement/checkOutDocumentUI.inc | 76 ---------------------------------------------------------------------------- 4 files changed, 0 insertions(+), 466 deletions(-) delete mode 100644 presentation/lookAndFeel/knowledgeTree/documentmanagement/checkInDocumentBL.php delete mode 100644 presentation/lookAndFeel/knowledgeTree/documentmanagement/checkInDocumentUI.inc delete mode 100644 presentation/lookAndFeel/knowledgeTree/documentmanagement/checkOutDocumentBL.php delete mode 100644 presentation/lookAndFeel/knowledgeTree/documentmanagement/checkOutDocumentUI.inc diff --git a/presentation/lookAndFeel/knowledgeTree/documentmanagement/checkInDocumentBL.php b/presentation/lookAndFeel/knowledgeTree/documentmanagement/checkInDocumentBL.php deleted file mode 100644 index a1dd2a7..0000000 --- a/presentation/lookAndFeel/knowledgeTree/documentmanagement/checkInDocumentBL.php +++ /dev/null @@ -1,149 +0,0 @@ -, Jam Warehouse (Pty) Ltd, South Africa - * @package documentmanagement - */ - -require_once("../../../../config/dmsDefaults.php"); -require_once(KT_LIB_DIR . '/documentmanagement/documentutil.inc.php'); - -KTUtil::extractGPC('fDocumentID', 'fForStore', 'fFolderID', 'fCheckInComment', 'fCheckInType'); - -if (!checkSession()) { - die("Session not set up"); -} - -require_once("$default->fileSystemRoot/lib/email/Email.inc"); - -require_once("$default->fileSystemRoot/lib/users/User.inc"); - -require_once("$default->fileSystemRoot/lib/documentmanagement/PhysicalDocumentManager.inc"); -require_once("$default->fileSystemRoot/lib/documentmanagement/DocumentTransaction.inc"); -require_once("$default->fileSystemRoot/lib/documentmanagement/Document.inc"); - -require_once("$default->fileSystemRoot/lib/roles/Role.inc"); -require_once("$default->fileSystemRoot/lib/foldermanagement/Folder.inc"); - -require_once("$default->fileSystemRoot/lib/visualpatterns/PatternListFromQuery.inc"); -require_once("$default->fileSystemRoot/lib/visualpatterns/PatternTableSqlQuery.inc"); -require_once("$default->fileSystemRoot/lib/visualpatterns/PatternCustom.inc"); -require_once("$default->fileSystemRoot/lib/visualpatterns/PatternListFromQuery.inc"); -require_once("$default->fileSystemRoot/lib/visualpatterns/PatternTableSqlQuery.inc"); - -require_once("$default->fileSystemRoot/presentation/lookAndFeel/knowledgeTree/documentmanagement/checkInDocumentUI.inc"); -require_once("$default->fileSystemRoot/presentation/lookAndFeel/knowledgeTree/documentmanagement/documentUI.inc"); -require_once("$default->fileSystemRoot/presentation/lookAndFeel/knowledgeTree/documentmanagement/viewUI.inc"); -require_once("$default->fileSystemRoot/presentation/lookAndFeel/knowledgeTree/foldermanagement/folderUI.inc"); -require_once("$default->fileSystemRoot/presentation/Html.inc"); - -require_once("$default->fileSystemRoot/lib/subscriptions/SubscriptionEngine.inc"); - -function checkinDocument() { - $oPatternCustom = & new PatternCustom(); - - $iDocumentID = KTUtil::arrayGet($_REQUEST, 'fDocumentID'); - - if (empty($iDocumentID)) { - // no document id was set when coming to this page, - $oPatternCustom->setHtml(renderErrorPage(_("No document is currently selected for check in"))); - return $oPatternCustom; - } - // instantiate the document - $oDocument = & Document::get($iDocumentID); - - if (!$oDocument) { - // couldn't instantiate the document - $oPatternCustom->setHtml(renderErrorPage(_("Could not check in this document"))); - return $oPatternCustom; - } - - // user has permission to check the document in - if (!Permission::userHasDocumentWritePermission($oDocument)) { - // no permission to checkout the document - $oPatternCustom->setHtml(renderErrorPage(_("You do not have permission to check in this document"))); - return $oPatternCustom; - } - - // and the document is checked out - if (!$oDocument->getIsCheckedOut()) { - $oPatternCustom->setHtml(renderErrorPage(_("You can't check in this document because its not checked out"))); - return $oPatternCustom; - } - - // by you - if ($oDocument->getCheckedOutUserID() != $_SESSION["userID"]) { - // you don't have this doc checked out - $oUser = User::get($oDocument->getCheckedOutUserID()); - $oPatternCustom->setHtml(renderErrorPage(_("You can't check in this document because its checked out by") . $oUser->getName())); - return $oPatternCustom; - } - - // if we're ready to perform the updates - $bForStore = KTUtil::arrayGet($_REQUEST, 'fForStore'); - if (! $bForStore) { - // prompt the user for a check in comment and the file - $oPatternCustom->setHtml(getCheckInPage($oDocument)); - return $oPatternCustom; - } - - // make sure the user actually selected a file first - if (strlen($_FILES['fFile']['name']) == 0) { - $sErrorMessage = _("Please select a document by first clicking on 'Browse'. Then click 'Check-In'"); - $oPatternCustom->setHtml(getCheckInPage($oDocument)); - return $oPatternCustom; - } - - // and that the filename matches - global $default; - $default->log->info("checkInDocumentBL.php uploaded filename=" . $_FILES['fFile']['name'] . "; current filename=" . $oDocument->getFileName()); - if ($oDocument->getFileName() != $_FILES['fFile']['name']) { - $sErrorMessage = _("The file you selected does not match the current filename in the DMS. Please try again."); - $oPatternCustom->setHtml(getCheckInPage($oDocument)); - return $oPatternCustom; - } - - $sCheckInComment = KTUtil::arrayGet($_REQUEST, 'fCheckInComment'); - $sCheckInType = KTUtil::arrayGet($_REQUEST, 'fCheckInType'); - $res = KTDocumentUtil::checkin($oDocument, $_FILES['fFile']['tmp_name'], $sCheckInComment, $sCheckInType); - if (PEAR::isError($res)) { - $oPatternCustom->setHtml(getErrorPage($res)); - return $oPatternCustom; - } - redirect("$default->rootUrl/control.php?action=viewDocument&fDocumentID=" . $oDocument->getID()); -} - -require_once("$default->fileSystemRoot/presentation/webpageTemplate.inc"); -$oPatternCustom = checkinDocument(); -$main->setCentralPayload($oPatternCustom); -$main->setFormAction($_SERVER["PHP_SELF"]); -$main->setFormEncType("multipart/form-data"); -if (isset($sErrorMessage)) { - $main->setErrorMessage($sErrorMessage); -} -$main->render(); - -?> diff --git a/presentation/lookAndFeel/knowledgeTree/documentmanagement/checkInDocumentUI.inc b/presentation/lookAndFeel/knowledgeTree/documentmanagement/checkInDocumentUI.inc deleted file mode 100644 index 678d884..0000000 --- a/presentation/lookAndFeel/knowledgeTree/documentmanagement/checkInDocumentUI.inc +++ /dev/null @@ -1,112 +0,0 @@ -, Jam Warehouse (Pty) Ltd, South Africa - * @package documentmanagement - */ - -/** - * Prompts the user for a check in comment and revision type - * - * @param object the document we're checking in - */ -function renderCheckInPage($oDocument) { - global $default; - - $sToRender = "\n"; - $sToRender .= "\n"; - $sToRender .= "\n"; - $sToRender .= "
" . _("Select the file to check in") . ":
"; - /* - $sToRender .= "
"; - $sToRender .= "\n"; - $sToRender .= ""; - $sToRender .= "\"browse\"\n"; - */ - $sToRender .= "
\n"; - - $sToRender .= "\n"; - $sToRender .= "\n"; - $sToRender .= "\n"; - $sToRender .= "\n"; - $sToRender .= "\n"; - $sToRender .= "getID() . "\"/>\n"; - $sToRender .= "\n"; - - /* - $sToRender .= "\n"; - $sToRender .= "\n"; - */ - $sToRender .= "
" . _("Enter a check in comment for the document") . "
\n"; - $sToRender .= " Minor Revision\n"; - $sToRender .= "
\n"; - $sToRender .= " Major Revision\n"; - $sToRender .= "
\n"; - - $sToRender .= "\n"; - $sToRender .= "\n"; - // FIXME: if the document name contains an apostrophe this js doesn't work - $sToRender .= "\n"; - $sToRender .= "\n"; - $sToRender .= "
getFileName() . " with ' + document.MainForm.fFile.value + '?'); } else return false;\"/>\n"; - $sToRender .= "rootUrl/control.php?action=viewDocument&fDocumentID=" . $oDocument->getID() . "\">
\n"; - - /* - $sToRender .= "\n\n\n\n"; - */ - return $sToRender; -} - -/** - * Displays the document view page with additional input controls - * for checking in the document - * - * @param object the document to view and check out - */ -function getCheckInPage($oDocument) { - $sToRender .= renderHeading(_("Check In Document")); - $sToRender .= renderDocumentPath($oDocument, false) . "\n\n"; - $sToRender .= renderCheckInPage($oDocument); - $sToRender .= renderDocumentData($oDocument, $bEdit); - return $sToRender; -} -?> diff --git a/presentation/lookAndFeel/knowledgeTree/documentmanagement/checkOutDocumentBL.php b/presentation/lookAndFeel/knowledgeTree/documentmanagement/checkOutDocumentBL.php deleted file mode 100644 index 7a8de25..0000000 --- a/presentation/lookAndFeel/knowledgeTree/documentmanagement/checkOutDocumentBL.php +++ /dev/null @@ -1,129 +0,0 @@ -, Jam Warehouse (Pty) Ltd, South Africa - * @package documentmanagement - */ - -require_once("../../../../config/dmsDefaults.php"); - -KTUtil::extractGPC('fDocumentID', 'fForStore', 'fCheckOutComment'); - -if (checkSession()) { - - require_once("$default->fileSystemRoot/lib/email/Email.inc"); - - require_once("$default->fileSystemRoot/lib/users/User.inc"); - - require_once("$default->fileSystemRoot/lib/documentmanagement/PhysicalDocumentManager.inc"); - require_once("$default->fileSystemRoot/lib/documentmanagement/DocumentTransaction.inc"); - require_once("$default->fileSystemRoot/lib/documentmanagement/Document.inc"); - - require_once("$default->fileSystemRoot/lib/roles/Role.inc"); - require_once("$default->fileSystemRoot/lib/foldermanagement/Folder.inc"); - - require_once("$default->fileSystemRoot/lib/visualpatterns/PatternListFromQuery.inc"); - require_once("$default->fileSystemRoot/lib/visualpatterns/PatternTableSqlQuery.inc"); - require_once("$default->fileSystemRoot/lib/visualpatterns/PatternCustom.inc"); - require_once("$default->fileSystemRoot/lib/visualpatterns/PatternListFromQuery.inc"); - require_once("$default->fileSystemRoot/lib/visualpatterns/PatternTableSqlQuery.inc"); - - require_once("$default->fileSystemRoot/presentation/lookAndFeel/knowledgeTree/documentmanagement/checkOutDocumentUI.inc"); - require_once("$default->fileSystemRoot/presentation/lookAndFeel/knowledgeTree/documentmanagement/documentUI.inc"); - require_once("$default->fileSystemRoot/presentation/lookAndFeel/knowledgeTree/documentmanagement/viewUI.inc"); - require_once("$default->fileSystemRoot/presentation/lookAndFeel/knowledgeTree/foldermanagement/folderUI.inc"); - require_once("$default->fileSystemRoot/presentation/Html.inc"); - - require_once("$default->fileSystemRoot/lib/subscriptions/SubscriptionEngine.inc"); - - $oPatternCustom = & new PatternCustom(); - - if (isset($fDocumentID)) { - // instantiate the document - $oDocument = & Document::get($fDocumentID); - if ($oDocument) { - // user has permission to check the document out - if (Permission::userHasDocumentWritePermission($oDocument)) { - // and its not checked out already - if (!$oDocument->getIsCheckedOut()) { - // if we're ready to perform the updates - if ($fForStore) { - // flip the checkout status - $oDocument->setIsCheckedOut(true); - // set the user checking the document out - $oDocument->setCheckedOutUserID($_SESSION["userID"]); - // update it - if ($oDocument->update()) { - - //create the document transaction record - $oDocumentTransaction = & new DocumentTransaction($oDocument->getID(), $fCheckOutComment, CHECKOUT); - // TODO: check transaction creation status? - $oDocumentTransaction->create(); - - // fire subscription alerts for the checked out document - $count = SubscriptionEngine::fireSubscription($fDocumentID, SubscriptionConstants::subscriptionAlertType("CheckOutDocument"), - SubscriptionConstants::subscriptionType("DocumentSubscription"), - array( "folderID" => $oDocument->getFolderID(), - "modifiedDocumentName" => $oDocument->getName() )); - $default->log->info("checkOutDocumentBL.php fired $count subscription alerts for checked out document " . $oDocument->getName()); - - // display checkout success message in the document view page - controllerRedirect("viewDocument", "fDocumentID=$fDocumentID&fCheckedOut=1"); - - } else { - // document update failed - $oPatternCustom->setHtml(renderErrorPage(_("An error occurred while storing this document in the database"))); - } - } else { - // prompt the user for a checkout comment - $oPatternCustom->setHtml(getCheckOutPage($oDocument)); - } - } else { - // this document is already checked out - // TODO: for extra credit, tell the user who has this document checked out - // but we don't display the check out button unless they have the document checked out already - // so we should ever get here. - $oPatternCustom->setHtml(renderErrorPage(_("This document is already checked out"), $fDocumentID)); - } - } else { - // no permission to checkout the document - $oPatternCustom->setHtml(renderErrorPage(_("You don't have permission to check out this document"), $fDocumentID)); - } - } else { - // couldn't instantiate the document - $oPatternCustom->setHtml(renderErrorPage(_("Could not check out this document"), $fDocumentID)); - } - } else { - // no document id was set when coming to this page, - $oPatternCustom->setHtml(renderErrorPage(_("No document is currently selected for check out"))); - } - - require_once("$default->fileSystemRoot/presentation/webpageTemplate.inc"); - $main->setCentralPayload($oPatternCustom); - $main->setFormAction($_SERVER["PHP_SELF"]); - $main->render(); -} -?> diff --git a/presentation/lookAndFeel/knowledgeTree/documentmanagement/checkOutDocumentUI.inc b/presentation/lookAndFeel/knowledgeTree/documentmanagement/checkOutDocumentUI.inc deleted file mode 100644 index 4407d54..0000000 --- a/presentation/lookAndFeel/knowledgeTree/documentmanagement/checkOutDocumentUI.inc +++ /dev/null @@ -1,76 +0,0 @@ -, Jam Warehouse (Pty) Ltd, South Africa - * @package documentmanagement - */ - -/** - * Prompts the user for a checkout comment - * - * @param object the document we're checking out - */ -function renderCheckOutPage($oDocument) { - global $default; - - $sToRender = "\n"; - $sToRender .= "\n"; - $sToRender .= "\n"; - $sToRender .= "\n"; - $sToRender .= "\n"; - $sToRender .= "\n"; - $sToRender .= "\n"; - $sToRender .= "\n"; - $sToRender .= "\n"; - $sToRender .= "\n"; - $sToRender .= "\n"; - $sToRender .= "
" . _("Enter a check out comment for the document") . "
getID() . "\"/>
\n"; - $sToRender .= generateControllerLink("viewDocument", "fDocumentID=" . $oDocument->getID(), "") . "
\n"; - - return $sToRender; -} - -/** - * Displays the document view page with additional input controls - * for checking out the document - * - * @param object the document to view and check out - */ -function getCheckOutPage($oDocument, $bCheckedOut = false) { - global $default; - - $sToRender .= renderHeading(_("Check Out Document")); - $sToRender .= renderDocumentPath($oDocument, false) . "\n\n"; - if ($bCheckedOut) { - $sToRender .= ""; - $sToRender .= "\n"; - $sToRender .= "\n"; - $sToRender .= "
" . _("You have now checked out this document. No one else can make updates to the document while you have it checked out. Click the Download button to get the latest version of the file. Please check it back in, as soon as you finish working on it.") . "
rootUrl/control.php?action=downloadDocument&fDocumentID=" . $oDocument->getID() . "\">\n"; - $sToRender .= "rootUrl/control.php?action=viewDocument&fDocumentID=" . $oDocument->getID() . "\">
"; - } else { - $sToRender .= renderCheckOutPage($oDocument); - } - $sToRender .= renderDocumentData($oDocument, $bEdit); - return $sToRender; -} -?> -- libgit2 0.21.4