documentutil.inc.php
5.87 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
<?php /* vim: set expandtab softtabstop=4 shiftwidth=4 foldmethod=marker: */
/**
* $Id$
*
* Document-handling utility functions
*
* Simplifies and canonicalises operations such as adding, updating, and
* deleting documents from the repository.
*
* Copyright (c) 2005 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 Neil Blakey-Milner, Jam Warehouse (Pty) Ltd, South Africa
*/
require_once(KT_LIB_DIR . '/documentmanagement/DocumentFieldLink.inc');
class KTDocumentUtil {
function createMetadataVersion($oDocument) {
if (is_numeric($oDocument)) {
$oDocument =& Document::get($oDocument);
if (PEAR::isError($oDocument)) {
return $oDocument;
}
}
// XXX: PHP5 clone
$oVersionDocument = $oDocument;
$oVersionDocument->iId = -1;
$oVersionDocument->setStatusID(STATUS_VERSION);
$oVersionDocument->setLiveDocumentID($oDocument->getID());
$oVersionDocument->setIsCheckedOut(false);
$oVersionDocument->setCheckedOutUserID(null);
$res = $oVersionDocument->create();
if ($res !== true) {
if (PEAR::isError($res)) {
return $res;
}
// XXX: Remove when Document uses PEAR Errors
return PEAR::raiseError($_SESSION["errorMessage"]);
}
$aFields =& DocumentFieldLink::getByDocument($oDocument);
$iVersionDocumentID = $oVersionDocument->getID();
foreach ($aFields as $oDFL) {
// XXX: PHP5 clone
$oVersionDFL = $oDFL;
$oVersionDFL->iId = -1;
$oVersionDFL->setDocumentID($iVersionDocumentID);
$res = $oVersionDFL->create();
}
return $oVersionDocument;
}
function bumpVersion($oDocument) {
if (is_numeric($oDocument)) {
$oDocument =& Document::get($oDocument);
if (PEAR::isError($oDocument)) {
return $oDocument;
}
}
$oDocument->setMetadataVersion($oDocument->getMetadataVersion()+1);
return $oDocument->update();
}
function setModifiedDate($oDocument) {
if (is_numeric($oDocument)) {
$oDocument =& Document::get($oDocument);
if (PEAR::isError($oDocument)) {
return $oDocument;
}
}
$oDocument->setLastModifiedDate(getCurrentDateTime());
return $oDocument->update();
}
function checkin($oDocument, $sFilename, $sCheckInComment, $sCheckInType = "minor") {
$sBackupPath = $oDocument->getPath() . "-" . $oDocument->getMajorVersionNumber() . "." . $oDocument->getMinorVersionNumber();
$bSuccess = @copy($oDocument->getPath(), $sBackupPath);
if ($bSuccess === false) {
return PEAR::raiseError(_("Unable to backup document prior to upload"));
}
$oVersionedDocument = KTDocumentUtil::createMetadataVersion($oDocument);
if (PEAR::isError($oVersionedDocument)) {
return $oVersionedDocument;
}
if (!PhysicalDocumentManager::uploadPhysicalDocument($oDocument, $oDocument->getFolderID(), "", $sFilename)) {
// reinstate the backup
copy($sBackupPath, $oDocument->getPath());
// remove the backup
unlink($sBackupPath);
return PEAR::raiseError(_("An error occurred while storing the new file on the filesystem"));
}
$oDocument->setMetadataVersion($oDocument->getMetadataVersion()+1);
$oDocument->setFileSize($_FILES['fFile']['size']);
$oDocument->setLastModifiedDate(getCurrentDateTime());
$oDocument->setIsCheckedOut(false);
$oDocument->setCheckedOutUserID(-1);
// bump the version numbers
if ($sCheckInType == "major") {
$oDocument->setMajorVersionNumber($oDocument->getMajorVersionNumber()+1);
$oDocument->setMinorVersionNumber(0);
} else if ($sCheckInType == "minor") {
$oDocument->setMinorVersionNumber($oDocument->getMinorVersionNumber()+1);
}
$bSuccess = $oDocument->update();
if ($bSuccess !== true) {
if (PEAR::isError($bSuccess)) {
return $bSuccess;
}
return PEAR::raiseError(_("An error occurred while storing this document in the database"));
}
// create the document transaction record
$oDocumentTransaction = & new DocumentTransaction($oDocument->getID(), $sCheckInComment, CHECKIN);
// TODO: check transaction creation status?
$oDocumentTransaction->create();
// fire subscription alerts for the checked in document
$count = SubscriptionEngine::fireSubscription($oDocument->getID(), SubscriptionConstants::subscriptionAlertType("CheckInDocument"),
SubscriptionConstants::subscriptionType("DocumentSubscription"),
array( "folderID" => $oDocument->getFolderID(),
"modifiedDocumentName" => $oDocument->getName() ));
global $default;
$default->log->info("checkInDocumentBL.php fired $count subscription alerts for checked out document " . $oDocument->getName());
return true;
}
}
?>