<?php
/**
 * $Id$
 *
 * Business Logic to check out a document
 *
 * Expected form variable:
 * o $fDocumentID - primary key of document user is checking out
 *
 * Licensed under the GNU GPL. For full terms see the file COPYING.
 *
 * @version $Revision$
 * @author Michael Joseph <michael@jamwarehouse.com>, Jam Warehouse (Pty) Ltd, South Africa
 * @package presentation.lookAndFeel.knowledgeTree.documentmanagement
 */

require_once("../../../../config/dmsDefaults.php");

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/foldermanagement/FolderCollaboration.inc");
    require_once("$default->fileSystemRoot/lib/foldermanagement/FolderUserRole.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/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($fDocumentID)) {
                // 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 modification time
                        $oDocument->setLastModifiedDate(getCurrentDateTime());
                        // 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( "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
                            $oPatternCustom->setHtml(getCheckOutEditPage($oDocument, true));
                            
                            
                        } 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(getCheckOutEditPage($oDocument));
                    }
                } else {
                    // this document is already checked out
                    // TODO: for extra credit, tell the user who has this document checked out
                    $oPatternCustom->setHtml(renderErrorPage("This document is already checked out"));                    
                }
            } else {
                // no permission to checkout the document
                $oPatternCustom->setHtml(renderErrorPage("You don't have permission to check out this document"));
            }
        } else {
            // couldn't instantiate the document
            $oPatternCustom->setHtml(renderErrorPage("Could not check out this document"));
        }
    } 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();
}
?>