checkOutDocumentBL.php
6.65 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
<?php
/**
* $Id$
*
* Business Logic to check out a document
*
* Expected form variable:
* o $fDocumentID - primary key of document user is checking out
*
* Copyright (c) 2003 Jam Warehouse http://www.jamwarehouse.com
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* 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, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* @version $Revision$
* @author Michael Joseph <michael@jamwarehouse.com>, 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();
}
?>