405 lines
16 KiB
PHP
405 lines
16 KiB
PHP
|
<?php
|
||
|
|
/**
|
||
|
|
* $Id$
|
||
|
|
*
|
||
|
|
* Contains all functions required to upload, alter and
|
||
|
|
* delete a physical document.
|
||
|
|
*
|
||
|
|
* KnowledgeTree Community Edition
|
||
|
|
* Document Management Made Simple
|
||
|
|
* Copyright (C) 2008, 2009 KnowledgeTree Inc.
|
||
|
|
*
|
||
|
|
*
|
||
|
|
* This program is free software; you can redistribute it and/or modify it under
|
||
|
|
* the terms of the GNU General Public License version 3 as published by the
|
||
|
|
* Free Software Foundation.
|
||
|
|
*
|
||
|
|
* 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, see <http://www.gnu.org/licenses/>.
|
||
|
|
*
|
||
|
|
* You can contact KnowledgeTree Inc., PO Box 7775 #87847, San Francisco,
|
||
|
|
* California 94120-7775, or email info@knowledgetree.com.
|
||
|
|
*
|
||
|
|
* The interactive user interfaces in modified source and object code versions
|
||
|
|
* of this program must display Appropriate Legal Notices, as required under
|
||
|
|
* Section 5 of the GNU General Public License version 3.
|
||
|
|
*
|
||
|
|
* In accordance with Section 7(b) of the GNU General Public License version 3,
|
||
|
|
* these Appropriate Legal Notices must retain the display of the "Powered by
|
||
|
|
* KnowledgeTree" logo and retain the original copyright notice. If the display of the
|
||
|
|
* logo is not reasonably feasible for technical reasons, the Appropriate Legal Notices
|
||
|
|
* must display the words "Powered by KnowledgeTree" and retain the original
|
||
|
|
* copyright notice.
|
||
|
|
* 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();
|
||
|
|
|
||
|
|
$mimeType = KTMime::getMimeTypeName($oDocument->getMimeTypeID());
|
||
|
|
$fileSize = $oDocument->getFileSize();
|
||
|
|
$fileName = $oDocument->getFileName();
|
||
|
|
|
||
|
|
return KTUtil::download($sDocumentFileSystemPath, $mimeType, $fileSize, $fileName);
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* 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";
|
||
|
|
|
||
|
|
$mimeType = KTMime::getMimeTypeName($oDocument->getMimeTypeID());
|
||
|
|
$fileSize = $oDocument->getFileSize();
|
||
|
|
$fileName = $sVersion.'-'.$oDocument->getFileName();
|
||
|
|
|
||
|
|
return KTUtil::download($sDocumentFileSystemPath, $mimeType, $fileSize, $fileName);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* 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;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
?>
|