KTS-1613

"possibility to delete a document version" Added a new transaction type for deleting a version of a document. The physical document is deleted but the DB record remains. Committed by: Megan Watson Reviewed by: Conrad Vermeulen git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@7270 c91229c3-7414-0410-bfa2-8a42b809f60b

KTS-1613
"possibility to delete a document version" Added a new transaction type for deleting a version of a document. The physical document is deleted but the DB record remains. Committed by: Megan Watson Reviewed by: Conrad Vermeulen git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@7270 c91229c3-7414-0410-bfa2-8a42b809f60b
megan_w
1 parent 19c6b514
Showing 11 changed files with 265 additions and 8 deletions
lib/documentmanagement/Document.inc
lib/documentmanagement/PhysicalDocumentManager.inc
lib/documentmanagement/documentutil.inc.php
lib/storage/ondiskhashedstoragemanager.inc.php
lib/storage/ondiskpathstoragemanager.inc.php
lib/storage/storagemanager.inc.php
plugins/ktcore/KTDocumentActions.php
sql/mysql/install/data.sql
sql/mysql/upgrade/3.5.0/document_transaction_type.sql
templates/ktcore/document/delete_version.smarty
templates/ktcore/document/metadata_history.smarty
@@ -34,6 +34,7 @@ DEFINE(&quot;PUBLISHED&quot;, 2);
 DEFINE("DELETED", 3);
 DEFINE("ARCHIVED", 4);
 DEFINE("STATUS_INCOMPLETE", 5);
+DEFINE("VERSION_DELETED", 6);
 require_once(KT_LIB_DIR . "/foldermanagement/Folder.inc");
 require_once(KT_LIB_DIR . '/documentmanagement/documentcontentversion.inc.php');
@@ -115,6 +116,9 @@ class Document {
     function getStatusID() { return $this->_oDocumentCore->getStatusId(); }
     function setStatusID($iNewValue) { $this->_oDocumentMetadataVersion->setStatusId($iNewValue); $this->_oDocumentCore->setStatusId($iNewValue); }
+    function getMetadataStatusID() { return $this->_oDocumentMetadataVersion->getStatusId(); }
+    function setMetadataStatusID($iNewValue) { $this->_oDocumentMetadataVersion->setStatusId($iNewValue); }
+
     function getMetadataVersion() { return $this->_oDocumentMetadataVersion->getMetadataVersion(); }
     function setMetadataVersion($iNewValue) { $this->_oDocumentMetadataVersion->getMetadataVersion($iNewValue); }
@@ -284,6 +284,36 @@ class PhysicalDocumentManager {
 		}
 	}
+    /**
+    * 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
 	 *
@@ -1013,7 +1013,67 @@ class KTDocumentUtil {
         return KTPermissionUtil::updatePermissionLookup($oDocument);
     }
+    
+    /**
+    * Delete a selected version of the document.
+    */
+    function deleteVersion($oDocument, $iVersionID, $sReason){
+        
+        $oDocument =& KTUtil::getObject('Document', $oDocument);
+        $oVersion =& KTDocumentMetadataVersion::get($iVersionID);
+        
+        $oStorageManager =& KTStorageManagerUtil::getSingleton();
+
+        global $default;
+
+        if (empty($sReason)) {
+            return PEAR::raiseError(_kt('Deletion requires a reason'));
+        }
+
+        if (PEAR::isError($oDocument) || ($oDocument == false)) {
+            return PEAR::raiseError(_kt('Invalid document object.'));
+        }
+
+        if (PEAR::isError($oVersion) || ($oVersion == false)) {
+            return PEAR::raiseError(_kt('Invalid document version object.'));
+        }
+        
+        $iContentId = $oVersion->getContentVersionId();
+        $oContentVersion = KTDocumentContentVersion::get($iContentId);
+        
+        if (PEAR::isError($oContentVersion) || ($oContentVersion == false)) {
+            DBUtil::rollback();
+            return PEAR::raiseError(_kt('Invalid document content version object.'));
+        }
+        DBUtil::startTransaction();
+        
+        // now delete the document version
+        $res = $oStorageManager->deleteVersion($oVersion);
+        if (PEAR::isError($res) || ($res == false)) {
+            //could not delete the document version from the file system
+            $default->log->error('Deletion: Filesystem error deleting the metadata version ' .
+                $oVersion->getMetadataVersion() . ' of the document ' .
+                $oDocument->getFileName() . ' from folder ' .
+                Folder::getFolderPath($oDocument->getFolderID()) .
+                ' id=' . $oDocument->getFolderID());
+
+            // we use a _real_ transaction here ...
+
+            DBUtil::rollback();
+
+            return PEAR::raiseError(_kt('There was a problem deleting the document from storage.'));
+        }
+        
+        // change status for the metadata version
+        $oVersion->setStatusId(VERSION_DELETED);
+        $oVersion->update();
+        
+        // set the storage path to empty
+//        $oContentVersion->setStoragePath('');
+
+        DBUtil::commit();
+    }
 }
 class KTMetadataValidationError extends PEAR_Error {
@@ -302,6 +302,25 @@ class KTOnDiskHashedStorageManager extends KTStorageManager {
         return true;
     }
+	/**
+	 * Completely remove a document version
+	 *
+	 * return boolean true on successful delete
+	 */
+	function deleteVersion($oVersion) {
+	    $oConfig =& KTConfig::getSingleton();
+	    $sDocumentRoot = $oConfig->get('urls/documentRoot');
+	    $iContentId = $oVersion->getContentVersionId();
+        $oContentVersion = KTDocumentContentVersion::get($iContentId);
+        
+	    $sPath = $oContentVersion->getStoragePath();
+	    $sFullPath = sprintf("%s/%s", $sDocumentRoot, $sPath);
+	    if (file_exists($sFullPath)) {
+            unlink($sFullPath);
+	    }
+	    return true;
+	}
+
     function restore($oDocument) {
         // Storage doesn't care if the document is deleted or restored
         return true;
@@ -399,6 +399,25 @@ class KTOnDiskPathStorageManager extends KTStorageManager {
         }
         return true;
 	}
+	
+	/**
+	 * Completely remove a document version
+	 *
+	 * return boolean true on successful delete
+	 */
+	function deleteVersion($oVersion) {
+	    $oConfig =& KTConfig::getSingleton();
+	    $sDocumentRoot = $oConfig->get('urls/documentRoot');
+	    $iContentId = $oVersion->getContentVersionId();
+        $oContentVersion = KTDocumentContentVersion::get($iContentId);
+        
+	    $sPath = $oContentVersion->getStoragePath();
+	    $sFullPath = sprintf("%s/%s", $sDocumentRoot, $sPath);
+	    if (file_exists($sFullPath)) {
+            unlink($sFullPath);
+	    }
+	    return true;
+	}
 	/**
 	 * Restore a document from the Deleted/ folder to the specified folder
@@ -125,6 +125,10 @@ class KTStorageManager {
         $indexer->deleteDocument($documentid);
     }
+    function deleteVersion(&$oVersion) {
+        return PEAR::raiseError(_kt("Not implemented"));
+    }
+    
     /**
      * Performs any storage changes necessary to account for the
      * document (previously marked as deleted) being restored.
@@ -114,6 +114,8 @@ class KTDocumentVersionHistoryAction extends KTDocumentAction {
     }
     function do_main() {
+        $show_version = KTUtil::arrayGet($_REQUEST, 'show');
+        $showall = (isset($show_version) && ($show_version == 'all')) ? true : false;
         $this->oPage->setSecondaryTitle($this->oDocument->getName());
         $this->oPage->setBreadcrumbDetails(_kt('Version History'));
@@ -121,7 +123,12 @@ class KTDocumentVersionHistoryAction extends KTDocumentAction {
         $aMetadataVersions = KTDocumentMetadataVersion::getByDocument($this->oDocument);
         $aVersions = array();
         foreach ($aMetadataVersions as $oVersion) {
-            $aVersions[] = Document::get($this->oDocument->getId(), $oVersion->getId());
+             $version = Document::get($this->oDocument->getId(), $oVersion->getId());
+             if($showall){
+                $aVersions[] = $version;
+             }else if($version->getMetadataStatusID() != VERSION_DELETED){
+                $aVersions[] = $version;
+             }
         }
         // render pass.
@@ -134,12 +141,24 @@ class KTDocumentVersionHistoryAction extends KTDocumentAction {
         $oAction->setDocument($this->oDocument);
+        // create delete action if user is sys admin or folder admin
+        $bShowDelete = false;
+        require_once(KT_LIB_DIR . '/security/Permission.inc');
+        $oUser =& User::get($_SESSION['userID']);
+        $iFolderId = $this->oDocument->getFolderId();
+        if (Permission::userIsSystemAdministrator($oUser) || Permission::isUnitAdministratorForFolder($oUser, $iFolderId)) {
+            // Check if admin mode is enabled
+            $bShowDelete = KTUtil::arrayGet($_SESSION, 'adminmode', false);
+        }
+
         $aTemplateData = array(
               'context' => $this,
               'document_id' => $this->oDocument->getId(),
               'document' => $this->oDocument,
               'versions' => $aVersions,
               'downloadaction' => $oAction,
+              'showdelete' => $bShowDelete,
+              'showall' => $showall,
         );
         return $oTemplate->render($aTemplateData);
     }
@@ -195,12 +214,50 @@ class KTDocumentVersionHistoryAction extends KTDocumentAction {
         redirect(KTUtil::ktLink('view.php',null,implode('&', $frag)));
     }
-
     function getUserForId($iUserId) {
         $u = User::get($iUserId);
         if (PEAR::isError($u) || ($u == false)) { return _kt('User no longer exists'); }
         return $u->getName();
     }
+    
+    function do_confirmdeleteVersion() {
+        $this->oPage->setSecondaryTitle($this->oDocument->getName());
+        $this->oPage->setBreadcrumbDetails(_kt('Delete document version'));
+        
+        // Display the version name and number
+        $iVersionId = $_REQUEST['version'];
+        $oVersion = Document::get($this->oDocument->getId(), $iVersionId);
+        
+        $oTemplating =& KTTemplating::getSingleton();
+        $oTemplate = $oTemplating->loadTemplate('ktcore/document/delete_version');
+        $aTemplateData = array(
+            'context' => $this,
+            'fDocumentId' => $this->oDocument->getId(),
+            'oVersion' => $oVersion,
+        );
+        return $oTemplate->render($aTemplateData);
+    }
+    
+    function do_deleteVersion() {
+        $iVersionId = $_REQUEST['versionid'];
+        $sReason = $_REQUEST['reason'];
+        $oVersion = Document::get($this->oDocument->getId(), $iVersionId);
+        
+        $res = KTDocumentUtil::deleteVersion($this->oDocument, $iVersionId, $sReason);
+        
+        if(PEAR::isError($res)){
+            $this->addErrorMessage($res->getMessage());
+            redirect(KTDocumentAction::getURL());
+            exit(0);
+        }
+        
+        // Record the transaction
+        $aOptions['version'] = sprintf('%d.%d', $oVersion->getMajorVersionNumber(), $oVersion->getMinorVersionNumber());
+        $oDocumentTransaction = & new DocumentTransaction($this->oDocument, _kt('Document version deleted'), 'ktcore.transactions.delete_version', $aOptions);
+        $oDocumentTransaction->create();
+        
+        redirect(KTDocumentAction::getURL());
+    }
 }
 // }}}
@@ -225,7 +282,7 @@ class KTDocumentViewAction extends KTDocumentAction {
         $iVersion = KTUtil::arrayGet($_REQUEST, 'version');
         if ($iVersion) {
             $oVersion = KTDocumentContentVersion::get($iVersion);
-            $aOptions['version'] = sprintf('%d.%d', $oVersion->getMajorVersionNumber(), $oVersion->getMinorVersionNumber());;
+            $aOptions['version'] = sprintf('%d.%d', $oVersion->getMajorVersionNumber(), $oVersion->getMinorVersionNumber());
             $res = $oStorage->downloadVersion($this->oDocument, $iVersion);
         } else {
             $res = $oStorage->download($this->oDocument);
+INSERT INTO `document_transaction_types_lookup` VALUES (21,'Delete Version','ktcore.transactions.delete_version');
+INSERT INTO `status_lookup` VALUES (6,'Version Deleted');
 \ No newline at end of file
+<h3>{i18n}Delete Document Version{/i18n}</h3>
+
+<span class="descriptiveText">{i18n}On deleting a document version the version history will remain but the document will be <b>permanently</b> deleted.{/i18n}</span>
+<p>{i18n}The following document version has been selected for deletion:{/i18n} </p>
+
+<table>
+<tr>
+<td>Document Version: </td><td>{$oVersion->getName()}</td>
+</tr><tr>
+<td>Metadata version: </td><td>{$oVersion->getMetadataVersion()}</td>
+</tr><tr>
+<td>Content version: </td><td>{$oVersion->getMajorVersionNumber()}.{$oVersion->getMinorVersionNumber()}</td>
+</tr><tr>
+<td>Date created: </td><td>{$oVersion->getVersionCreated()}</td>
+</tr></table>
+
+<p>
+<form action="{$smarty.server.PHP_SELF}" method="POST" />
+<input type="hidden" name="action" value="deleteVersion" />
+<input type="hidden" name="fDocumentId" value="{$fDocumentId}" />
+<input type="hidden" name="versionid" value="{$oVersion->getCurrentMetadataVersionId()}" />
+<b>Reason:</b>
+<br /><textarea rows="10" cols="50" name="reason"></textarea>
+<br /><input type="submit" value="continue" />
+</form>
+</p>
 \ No newline at end of file
@@ -13,6 +13,9 @@
                 <th class="compare">{i18n}Compare with Current{/i18n}</th>
                 <th class="compare">{i18n}Compare with Other Version{/i18n}</th>
 				<th class="versiondate">{i18n}Date Created{/i18n}</th>
+				{if $showdelete}
+				    <th class="deleteversion">{i18n}Delete Version{/i18n}</th>
+				{/if}
             </tr>
         </thead>
         <tbody>
@@ -22,24 +25,57 @@
                 <td class="date">{$oVersion->getMetadataVersion()}</td>
 {capture assign=version}{$oVersion->getMajorVersionNumber()}.{$oVersion->getMinorVersionNumber()}{/capture}
 {capture assign=versionid}{$oVersion->getContentVersionId()}{/capture}
-                <td class="date"><a href="{$downloadaction->getURL()}&version={$versionid}">{$version}</a></td>
+                <td class="date">
+                    {if ($oVersion->getMetadataStatusID() != VERSION_DELETED)}
+                        <a href="{$downloadaction->getURL()}&version={$versionid}">{$version}</a>
+                    {else}
+                        {$version}
+                    {/if}
+                </td>
                 <td class="compare">
                 {if ($document->getMetadataVersion() == $oVersion->getMetadataVersion())}
                    <strong>{i18n}current version{/i18n}</strong>
                 {else}
-                   <a href="{addQS}action=viewComparison&fDocumentId={$document->getId()}&fBaseVersion={$oVersion->getMetadataVersionId()}&fComparisonVersion={$oVersion->getCurrentMetadataVersionId()}{/addQS}">{i18n}compare with current{/i18n}</a></td>
+                    {if ($oVersion->getMetadataStatusID() != VERSION_DELETED)}
+                        <a href="{addQS}action=viewComparison&fDocumentId={$document->getId()}&fBaseVersion={$oVersion->getMetadataVersionId()}&fComparisonVersion={$oVersion->getCurrentMetadataVersionId()}{/addQS}">{i18n}compare with current{/i18n}</a></td>
+                    {else}
+                        &mdash;
+                    {/if}
                 {/if}
                 </td>
                 <td>
                 {if (count($versions) == 1)}
                 &mdash;
                 {else}
-                <a href="{addQS}action=startComparison&fDocumentId={$document->getId()}&fComparisonVersion={$oVersion->getCurrentMetadataVersionId()}{/addQS}">{i18n}compare with other version{/i18n}</a>
+                    {if ($oVersion->getMetadataStatusID() != VERSION_DELETED)}
+                        <a href="{addQS}action=startComparison&fDocumentId={$document->getId()}&fComparisonVersion={$oVersion->getCurrentMetadataVersionId()}{/addQS}">{i18n}compare with other version{/i18n}</a>
+                    {else}
+                        &mdash;
+                    {/if}
                 {/if}
                 </td>
                 <td class="versiondate">{$oVersion->getVersionCreated()}</td>
+                {if $showdelete}
+                    <td class="deleteversion">
+                        {if ($document->getMetadataVersion() != $oVersion->getMetadataVersion())}
+                            {if ($oVersion->getMetadataStatusID() == VERSION_DELETED)}
+                                <strong>{i18n}Version deleted{/i18n}</strong>
+                            {else}
+                                <a href="{addQS}action=confirmdeleteVersion&fDocumentId={$document->getId()}&version={$oVersion->getCurrentMetadataVersionId()}{/addQS}">{i18n}delete version{/i18n}</a>
+                            {/if}
+                        {else}
+                            &nbsp;
+                        {/if}
+                    </td>
+                {/if}
             </tr>
             {/foreach}
         </tbody>
     </table>
+    
+{if ($showdelete && !$showall)}
+    <p>
+    <a href="{addQS}fDocumentId={$document->getId()}&show=all{/addQS}">{i18n}Show deleted versions{/i18n}</a>
+    </p>
+{/if}
 \ No newline at end of file