PhysicalDocumentManager.inc
16.6 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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
<?php
/**
* $Id$
*
* Contains all functions required to upload, alter and
* delete a physical document.
*
* The contents of this file are subject to the KnowledgeTree Public
* License Version 1.1.2 ("License"); You may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.knowledgetree.com/KPL
*
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied.
* See the License for the specific language governing rights and
* limitations under the License.
*
* All copies of the Covered Code must include on each user interface screen:
* (i) the "Powered by KnowledgeTree" logo and
* (ii) the KnowledgeTree copyright notice
* in the same form as they appear in the distribution. See the License for
* requirements.
*
* The Original Code is: KnowledgeTree Open Source
*
* The Initial Developer of the Original Code is The Jam Warehouse Software
* (Pty) Ltd, trading as KnowledgeTree.
* Portions created by The Jam Warehouse Software (Pty) Ltd are Copyright
* (C) 2007 The Jam Warehouse Software (Pty) Ltd;
* All Rights Reserved.
* Contributor( s): ______________________________________
*/
// used for well-known MIME deterministic techniques
if (!extension_loaded('fileinfo')) {
@dl('fileinfo.' . PHP_SHLIB_SUFFIX);
}
require_once(KT_LIB_DIR . '/mime.inc.php');
class PhysicalDocumentManager {
/**
* Stream a document to a client over http
*
* @param Primary key of document to stream
*
* @return int number of bytes read from file on success or false otherwise;
*
* @todo investigate possible problem in MSIE 5.5 concerning Content-Disposition header
*/
function downloadPhysicalDocument($iDocumentID) {
//get the document
$oDocument = & Document::get($iDocumentID);
//get the path to the document on the server
$sDocumentFileSystemPath = $oDocument->getPath();
if (file_exists($sDocumentFileSystemPath)) {
//set the correct headers
header("Content-Type: " .
KTMime::getMimeTypeName($oDocument->getMimeTypeID()));
header("Content-Length: ". $oDocument->getFileSize());
header("Content-Disposition: attachment; filename=\"" . $oDocument->getFileName() . "\"");
header("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
header("Cache-Control: must-revalidate");
header("Content-Location: ".$oDocument->getFileName());
readfile($sDocumentFileSystemPath);
} else {
return false;
}
}
/**
* Stream a particular version of a document to a client over http
*
* @param Primary key of document to stream
* @param Primary key of document to stream
* @return int number of bytes read from file on success or false otherwise;
*/
function downloadVersionedPhysicalDocument($iDocumentID, $sVersion) {
//get the document
$oDocument = & Document::get($iDocumentID);
//get the path to the document on the server
$sDocumentFileSystemPath = $oDocument->getPath() . "-$sVersion";
if (file_exists($sDocumentFileSystemPath)) {
//set the correct headers
header("Content-Type: " .
KTMime::getMimeTypeName($oDocument->getMimeTypeID()));
header("Content-Length: ". filesize($sDocumentFileSystemPath));
// prefix the filename presented to the browser to preserve the document extension
header('Content-Disposition: attachment; filename="' . "$sVersion-" . $oDocument->getFileName() . '"');
header("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
header("Cache-Control: must-revalidate");
header("Content-Location: ".$oDocument->getFileName());
readfile($sDocumentFileSystemPath);
} else {
return false;
}
}
/**
* Move a document to a new folder
*
* return boolean true on successful move, false otherwhise
*/
function moveDocument($sOldDocumentPath, $oDocument, $oFolder) {
global $default;
// current document path
$sCurrentPath = $sOldDocumentPath;
// the destination path
$sDestinationFolderPath = Folder::getFolderPath($oFolder->getID()) . $oDocument->getFileName();
// find all the previous versions of this document and move them
// ie. interrogate transaction history for all CHECKIN transactions and retrieve the versions
// FIXME: refactor array getOldVersionPaths($iDocumentID)??
$sql = $default->db;
$sQuery = "SELECT DISTINCT version FROM $default->document_transactions_table WHERE document_id = ? AND transaction_id = ?";/*ok*/
$aParams = array($oDocument->getID(), CHECKOUT);
$result = $sql->query(array($sQuery, $aParams));
if ($result) {
while ($sql->next_record()) {
$sVersion = $sql->f("version");
if ($sVersion <> $oDocument->getVersion()) {
$sSourcePath = $sCurrentPath . "-" . $sVersion;
$sDestinationPath = $sDestinationFolderPath . "-" . $sVersion;
// move it to the new folder
$default->log->info("PhysicalDocumentManager::moveDocument moving $sSourcePath to $sDestinationPath");
if (!PhysicalDocumentManager::move($sSourcePath, $sDestinationPath)) {
// FIXME: can't bail now since we don't have transactions- so we doggedly continue deleting and logging errors
$default->log->error("PhysicalDocumentManager::moveDocument error moving $sSourcePath to $sDestinationPath; documentID=" . $oDocument->getID() . "; folderID=" . $oFolder->getID());
}
}
}
} else {
$default->log->error("PhysicalDocumentManager::moveDocument error looking up document versions, id=" . $oDocument->getID());
}
// now move the current version
if (PhysicalDocumentManager::move($sCurrentPath, $sDestinationFolderPath)) {
return true;
} else {
$default->log->error("PhysicalDocumentManager::moveDocument couldn't move $sCurrentPath to $sDestinationFolderPath, documentID=" . $oDocument->getID());
return false;
}
}
/**
* Move a file
*
* @param string source path
* @param string destination path
*/
function move($sOldDocumentPath, $sNewDocumentPath) {
global $default;
if (file_exists($sOldDocumentPath)) {
//copy the file to the new destination
if (copy($sOldDocumentPath, $sNewDocumentPath)) {
//delete the old one
@unlink($sOldDocumentPath);
return true;
} else {
return false;
}
} else {
return false;
}
}
/**
* Deletes a document- moves it to the Deleted/ folder
*
* return boolean true on successful move, false otherwhise
*/
function delete($oDocument) {
global $default;
// current document path
$sCurrentPath = $oDocument->getPath();
// check if the deleted folder exists and create it if not
$sDeletedPrefix = $default->documentRoot . "/Deleted";
if (!file_exists($sDeletedPrefix)) {
mkdir($sDeletedPrefix, 0755);
}
// move the file to the deleted folder, prefixed by its document id
$sDeletedPrefix = $default->documentRoot . "/Deleted/" . $oDocument->getID() . "-" . $oDocument->getFileName();
// find all the previous versions of this document and move them
// ie. interrogate transaction history for all CHECKIN transactions and retrieve the versions
// FIXME: refactor
$sql = $default->db;
$sQuery = "SELECT DISTINCT version FROM $default->document_transactions_table WHERE document_id = ? AND transaction_namespace = ?";/*ok*/
$aParams = array($oDocument->getID(), 'ktcore.transactions.check_out');
$result = $sql->query(array($sQuery, $aParams));
if ($result) {
while ($sql->next_record()) {
$sVersion = $sql->f("version");
if ($sVersion <> $oDocument->getVersion()) {
$sVersionedPath = $sCurrentPath . "-" . $sVersion;
$sDeletedPath = $sDeletedPrefix . "-" . $sVersion;
// move it to the deleted folder
$default->log->info("PhysicalDocumentManager::delete moving $sVersionedPath to $sDeletedPath");
if (!PhysicalDocumentManager::move($sVersionedPath, $sDeletedPath)) {
$default->log->error("PhysicalDocumentManager::delete error moving $sVersionedPath to $sDeletedPath; documentID=" . $oDocument->getID());
// FIXME: can't bail now since we don't have transactions- so we doggedly continue deleting and logging errors
}
}
}
} else {
$default->log->error("PhysicalDocumentManager::delete error looking up document versions, id=" . $oDocument->getID());
}
// now move the current version
if (PhysicalDocumentManager::move($sCurrentPath, $sDeletedPrefix)) {
return true;
} else {
$default->log->error("PhysicalDocumentManager::delete couldn't move $sCurrentPath to $sDeletedPath, documentID=" . $oDocument->getID());
return false;
}
}
/**
* Completely remove a document from the Deleted/ folder
*
* return boolean true on successful move, false otherwhise
*/
function expunge($oDocument) {
global $default;
// deleted document path
$sDeletedPrefix = $default->documentRoot . "/Deleted/" . $oDocument->getID() . "-" . $oDocument->getFileName();
// find all the previous versions of this document and delete them
// ie. interrogate transaction history for all CHECKIN transactions and retrieve the versions
// FIXME: refactor
$sql = $default->db;
$sQuery = "SELECT DISTINCT version FROM $default->document_transactions_table WHERE document_id = ? AND transaction_id = ?";/*ok*/
$aParams = array($oDocument->getID(), CHECKOUT);
$result = $sql->query(array($sQuery, $aParams));
if ($result) {
while ($sql->next_record()) {
$sVersion = $sql->f("version");
if ($sVersion <> $oDocument->getVersion()) {
$sExpungePath = $sDeletedPrefix . "-" . $sVersion;
// zap it
$default->log->info("PhysicalDocumentManager::expunge rm'ing $sExpungePath");
if (file_exists($sExpungePath)) {
if (!@unlink($sExpungePath)) {
$default->log->error("PhysicalDocumentManager::expunge error deleting $sExpungePath; documentID=" . $oDocument->getID());
// FIXME: can't bail now since we don't have transactions- so we doggedly continue deleting and logging errors
}
} else {
$default->log->error("PhysicalDocumentManager::expunge can't rm $sExpungePath because it doesn't exist");
}
}
}
} else {
$default->log->error("PhysicalDocumentManager::expunge error looking up document versions, id=" . $oDocument->getID());
}
if (file_exists($sDeletedPrefix)) {
// now delete the current version
if (@unlink($sDeletedPrefix)) {
$default->log->info("PhysicalDocumentManager::expunge unlinkied $sDeletedPrefix");
return true;
} else {
$default->log->info("PhysicalDocumentManager::expunge couldn't unlink $sDeletedPrefix");
if (file_exists($sDeletedPrefix)) {
return false;
} else {
return true;
}
}
} else {
$default->log->info("PhysicalDocumentManager::expunge can't rm $sDeletedPrefix because it doesn't exist");
return true;
}
}
/**
* Delete a single version of a document
*
* return boolean true on successful delete, false otherwise
*/
function deleteVersion($oVersion) {
global $default;
$iContentId = $oVersion->getContentVersionId();
$oContentVersion = KTDocumentContentVersion::get($iContentId);
$sFullPath = $default->documentRoot.'/'.$oContentVersion->getStoragePath();
if (file_exists($sFullPath)) {
if(@unlink($sFullPath)){
$default->log->info("PhysicalDocumentManager::deleteVersion unlinked $sFullPath");
return true;
}else{
$default->log->info("PhysicalDocumentManager::deleteVersion couldn't unlink $sFullPath");
if (file_exists($sFullPath)) {
return false;
} else {
return true;
}
}
}else{
$default->log->info("PhysicalDocumentManager::deleteVersion can't rm $sFullPath because it doesn't exist");
return true;
}
}
/**
* Restore a document from the Deleted/ folder to the specified folder
*
* return boolean true on successful move, false otherwhise
*/
function restore($oDocument) {
global $default;
// deleted document path (includes previous versions)
$sDeletedPath = $default->documentRoot . "/Deleted/" . $oDocument->getID() . "-" . $oDocument->getFileName();
// NEW FOLDER REALLY NEEDS TO BE /
if (is_null($oDocument->getFolderID())) {
$oDocument->setFolderID(1);
}
//var_dump($oDocument->getFolderID());
$sRestorePath = Folder::getFolderPath($oDocument->getFolderID()) . "/" . $oDocument->getFileName();
// find all the previous versions of this document and move them
// ie. interrogate transaction history for all CHECKIN transactions and retrieve the versions
// FIXME: refactor
$sql = $default->db;
$sQuery = "SELECT DISTINCT version FROM $default->document_transactions_table WHERE document_id = ? AND transaction_id = ?";/*ok*/
$aParams = array($oDocument->getID(), CHECKOUT);
$result = $sql->query(array($sQuery, $aParams));
if ($result) {
while ($sql->next_record()) {
$sVersion = $sql->f("version");
if ($sVersion <> $oDocument->getVersion()) {
$sVersionedDeletedPath = $sDeletedPath . "-" . $sVersion;
$sVersionedRestorePath = $sRestorePath . "-" . $sVersion;
// move it to the new folder
$default->log->info("PhysicalDocumentManager::restore moving $sVersionedDeletedPath to $sVersionedRestorePath");
if (!PhysicalDocumentManager::move($sVersionedDeletedPath, $sVersionedRestorePath)) {
$default->log->error("PhysicalDocumentManager::restore error moving $sVersionedDeletedPath to $sVersionedRestorePath; documentID=" . $oDocument->getID());
// FIXME: can't bail now since we don't have transactions- so we doggedly continue restoring and logging errors
}
}
}
} else {
$default->log->error("PhysicalDocumentManager::expunge error looking up document versions, id=" . $oDocument->getID());
}
// now move the current version
if (PhysicalDocumentManager::move($sDeletedPath, $sRestorePath)) {
return true;
} else {
$default->log->error("PhysicalDocumentManager::restore couldn't move $sDeletedPath to $sRestorePath, documentID=" . $oDocument->getID());
return false;
}
}
/**
* View a document using an inline viewer
*
* @param Primary key of document to view
*
* @return int number of bytes read from file on success or false otherwise;
*
* @todo investigate possible problem in MSIE 5.5 concerning Content-Disposition header
*/
function inlineViewPhysicalDocument($iDocumentID) {
//get the document
$oDocument = & Document::get($iDocumentID);
//get the path to the document on the server
$sDocumentFileSystemPath = $oDocument->getPath();
if (file_exists($sDocumentFileSystemPath)) {
header("Content-Type: application/octet-stream");
header("Content-Length: ". $oDocument->getFileSize());
// prefix the filename presented to the browser to preserve the document extension
header('Content-Disposition: inline; filename="' . $oDocument->getFileName() . '"');
header("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
header("Cache-Control: must-revalidate");
header("Content-Location: ".$oDocument->getFileName());
return readfile($sDocumentFileSystemPath);
} else {
return false;
}
}
/**
* Get the uploaded file information and place it into a document object
*
* @param Array containing uploaded file information (use $aFileArray)
* par Primary key of folder into which document will be placed
*
* @return Document Document object containing uploaded file information
*/
function & createDocumentFromUploadedFile($aFileArray, $iFolderID) {
//get the uploaded document information and put it into a document object
$oDocument = new Document($aFileArray['name'], $aFileArray['name'], $aFileArray['size'], $_SESSION["userID"], KTMime::getMimeTypeID($aFileArray['type'], $aFileArray['name']), $iFolderID);
return $oDocument;
}
}
?>