- transactions are now keyed on the namespace, so they should survive activati…

…on/de-activation better. - upgrade script for this change. - updated all components in this tree to use the new style transaction - pass a document, _not_ an id. git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@4425 c91229c3-7414-0410-bfa2-8a42b809f60b

- transactions are now keyed on the namespace, so they should survive activati…
…on/de-activation better. - upgrade script for this change. - updated all components in this tree to use the new style transaction - pass a document, _not_ an id. git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@4425 c91229c3-7414-0410-bfa2-8a42b809f60b
bshuttle
1 parent fafd719b
Showing 12 changed files with 67 additions and 93 deletions
lib/documentmanagement/DocumentTransaction.inc
lib/documentmanagement/DocumentTransactionType.inc.php
lib/documentmanagement/documentutil.inc.php
lib/workflow/workflowutil.inc.php
plugins/ktcore/KTDocumentActions.php
plugins/ktcore/admin/deletedDocuments.php
plugins/ktcore/admin/documentCheckout.php
plugins/ktstandard/KTEmail.php
presentation/lookAndFeel/knowledgeTree/documentmanagement/editDocument.php
presentation/lookAndFeel/knowledgeTree/documentmanagement/view.php
sql/mysql/install/structure.sql
sql/mysql/upgrade/2.99.5/transaction_namespaces.sql
 <?php
-DEFINE("CREATE", 1);
-DEFINE("UPDATE", 2);
-DEFINE("DELETE", 3);
-DEFINE("RENAME", 4);
-DEFINE("MOVE", 5);
-DEFINE("DOWNLOAD", 6);
-DEFINE("CHECKIN", 7);
-DEFINE("CHECKOUT", 8);
-DEFINE("COLLAB_ROLLBACK",9);
-DEFINE("VIEW", 10);
-DEFINE("EXPUNGE", 11);
-DEFINE("FORCE_CHECKIN", 12);
-DEFINE("EMAIL_LINK", 13);
-DEFINE("COLLAB_ACCEPT", 14);
-DEFINE("EMAIL_ATTACH", 15);
-DEFINE("WORKFLOW_TRANSITION", 16);
 /**
  * $Id$
  *
@@ -46,23 +30,15 @@ DEFINE(&quot;WORKFLOW_TRANSITION&quot;, 16);
 class DocumentTransaction {
 	/** primary key of document transaction */
-	var $iId;
-	/** primary key of document on which transaction occured */
+	var $iId = -1;
 	var $iDocumentID;
-	/** version of document on which transaction occurs */
 	var $sVersion;
-	/** primary key of user who performed transaction */
 	var $iUserID;
-	/** time of transaction */
 	var $dDateTime;
-	/** IP address of computer that user was logged onto */
 	var $sIP;
-	/** path to documet on file system on which transaction was performed */
 	var $sFilename;
-	/** user comment associated with transaction */
 	var $sComment;
-	/** primary key of transaction type */
-	var $iTransactionID;
+	var $sTransactionNS;
 	/**
 	* Constructor
@@ -72,45 +48,33 @@ class DocumentTransaction {
 	* @param 	Primary key of transaction type
 	*	
 	*/
-	function DocumentTransaction($iNewDocumentID, $sNewComment, $iNewTransactionID, $aOptions = null) {
+	function DocumentTransaction($oDocument, $sNewComment, $sTransactionNS, $aOptions = null) {
         if (is_null($aOptions)) {
             $aOptions = array();
         }
 		//object not stored yet, id = -1
 		$this->iId = -1;
-		$this->iDocumentID = $iNewDocumentID;
+		
+		$this->iDocumentID = $oDocument->getID();
 		$this->sComment = $sNewComment;
-		$this->iTransactionID = $iNewTransactionID;
-		$oDocument = & Document::get($iNewDocumentID);
-		if ($oDocument) {
-			$this->sVersion = $oDocument->getMajorVersionNumber() . "." . $oDocument->getMinorVersionNumber();
-			$oFolder = Folder::get($oDocument->iFolderID);
-			$this->sFileName = addslashes($oFolder->sFullPath . "/" . $oFolder->getName() . "/" . $oDocument->getName());			
-		}
+		$this->sTransactionNS = $sTransactionNS;
+		$this->sVersion = $oDocument->getMajorVersionNumber() . "." . $oDocument->getMinorVersionNumber();
+		$oFolder = Folder::get($oDocument->iFolderID);
+		$this->sFileName = addslashes($oFolder->sFullPath . "/" . $oFolder->getName() . "/" . $oDocument->getName());			
+		
 		$this->iUserID = $_SESSION["userID"];
         $oUser = KTUtil::arrayGet($aOptions, 'user');
-        if ($oUser) {
+		
+        if (!(PEAR::isError($oUser) || ($oUser == false))) {
             $this->iUserID = $oUser->getID();
         }
 		$this->dDateTime = getCurrentDateTime();		
 		$this->sIP = KTUtil::arrayGet($_SERVER, "REMOTE_ADDR", '0.0.0.0');
 	}
-	/**
-	 * Returns the current version
-	 */
-	function getVersion() {
-		return $this->sVersion;
-	}
-
-	function getComment() {
-		return $this->sComment;
-	}
-
-        function _table() {
-            global $default;
-            return $default->document_transactions_table;
-        }
+	function getVersion() {	return $this->sVersion;	}
+	function getComment() {	return $this->sComment;	}
+    function _table() { return KTUtil::getTableName('document_transactions'); }
 	/**
 	* Create the document transaction in the database
@@ -130,7 +94,7 @@ class DocumentTransaction {
                 'ip' => $this->sIP,
                 'filename' => $this->sFileName,
                 'comment' => $this->sComment,
-                'transaction_id' => $this->iTransactionID,
+                'transaction_namespace' => $this->sTransactionNS,
             );
             $id =& DBUtil::autoInsert($this->_table(), $aFieldValues);
@@ -180,7 +144,7 @@ class DocumentTransaction {
 	        $sql = $default->db;
 	        $sql->query(array("SELECT * FROM $default->document_transactions_table WHERE id = ?", $iDocumentTransactionID));/*ok*/
 	        if ($sql->next_record()) {			
-	            $oDocumentTransaction = & new DocumentTransaction($sql->f("document_id"), $sql->f("comment"), $sql->f("transaction_id"));
+	            $oDocumentTransaction = & new DocumentTransaction(Document::get($sql->f("document_id")), $sql->f("comment"), $sql->f("transaction_namespace"));
 	            $oDocumentTransaction->iId = $sql->f("id");	
 				$oDocumentTransaction->sVersion = $sql->f("version");
 				$oDocumentTransaction->iUserID = $sql->f("user_id");
 <?php
 require_once(KT_LIB_DIR . "/ktentity.inc");
+require_once(KT_LIB_DIR . "/util/ktutil.inc"); 
 class KTDocumentTransactionType extends KTEntity {
     /** primary key */
     var $iId = -1;
-    /** help file name */
-    var $sName;
-    /** help file name */
     var $sName;
+    var $sNamespace;
     var $_aFieldToSelect = array(
         "iId" => "id",
@@ -26,30 +25,13 @@ class KTDocumentTransactionType extends KTEntity {
     function setNamespace($sNamespace) { $this->sNamespace = $sNamespace; }
     function _table () {
-        global $default;
-        return $default->transaction_types_table;
-    }
-
-    // STATIC
-    function &get($iId) {
-        return KTEntityUtil::get('KTDocumentTransactionType', $iId);
-    }
-
-    // STATIC
-    function &createFromArray($aOptions) {
-        return KTEntityUtil::createFromArray('KTDocumentTransactionType', $aOptions);
-    }
-
-    // STATIC
-    function &getList($sWhereClause = null) {
-        global $default;
-        return KTEntityUtil::getList($default->permissions_table, 'KTDocumentTransactionType', $sWhereClause);
+        return KTUtil::getTableName('transaction_types');
     }
-    // STATIC
-    function &getByNamespace($sNamespace) {
-        return KTEntityUtil::getBy('KTDocumentTransactionType', 'namespace', $sNamespace);
-    }
+    function &get($iId) { return KTEntityUtil::get('KTDocumentTransactionType', $iId); }
+    function &createFromArray($aOptions) { return KTEntityUtil::createFromArray('KTDocumentTransactionType', $aOptions); }
+    function &getList($sWhereClause = null) { return KTEntityUtil::getList2('KTDocumentTransactionType', $sWhereClause); }
+    function &getByNamespace($sNamespace) { return KTEntityUtil::getBy('KTDocumentTransactionType', 'namespace', $sNamespace); }
 }
 ?>
@@ -135,7 +135,7 @@ class KTDocumentUtil {
         }
         // create the document transaction record
-        $oDocumentTransaction = & new DocumentTransaction($oDocument->getID(), $sCheckInComment, CHECKIN);
+        $oDocumentTransaction = & new DocumentTransaction($oDocument, $sCheckInComment, 'ktcore.transactions.check_in');
         $oDocumentTransaction->create();
         $oKTTriggerRegistry = KTTriggerRegistry::getSingleton();
@@ -423,7 +423,7 @@ class KTDocumentUtil {
         $oUploadChannel->sendMessage(new KTUploadGenericMessage(_("Creating transaction")));
         $aOptions = array('user' => $oUser);
         //create the document transaction record
-        $oDocumentTransaction = & new DocumentTransaction($oDocument->getID(), "Document created", CREATE, $aOptions);
+        $oDocumentTransaction = & new DocumentTransaction($oDocument, "Document created", 'ktcore.transactions.create', $aOptions);
         $res = $oDocumentTransaction->create();
         if (PEAR::isError($res)) {
             $oDocument->delete();
@@ -392,7 +392,7 @@ class KTWorkflowUtil {
         if ($sComments) {
             $sTransactionComments .= "; Reason given was: " . $sComments;
         }
-        $oDocumentTransaction = & new DocumentTransaction($oDocument->getID(), $sTransactionComments, WORKFLOW_TRANSITION);
+        $oDocumentTransaction = & new DocumentTransaction($oDocument, $sTransactionComments, 'ktcore.transactions.workflow_state_transition');
         $oDocumentTransaction->create();
         return true;
@@ -23,7 +23,7 @@ class KTDocumentViewAction extends KTDocumentAction {
     function do_main() {
         $oStorage =& KTStorageManagerUtil::getSingleton();
-        $oDocumentTransaction = & new DocumentTransaction($this->oDocument->getId(), "Document downloaded", DOWNLOAD);
+        $oDocumentTransaction = & new DocumentTransaction($this->oDocument, "Document downloaded", 'ktcore.transactions.download');
         $oDocumentTransaction->create();
         $oStorage->download($this->oDocument);
         exit(0);
@@ -114,7 +114,7 @@ class KTDocumentCheckOutAction extends KTDocumentAction {
             }
         }
-        $oDocumentTransaction = & new DocumentTransaction($this->oDocument->getID(), $sReason, CHECKOUT);
+        $oDocumentTransaction = & new DocumentTransaction($this->oDocument, $sReason, 'ktcore.transactions.check_out');
         $oDocumentTransaction->create();
         $oStorage =& KTStorageManagerUtil::getSingleton();
@@ -289,7 +289,7 @@ class KTDocumentDeleteAction extends KTDocumentAction {
             exit(0);
         }
-        $oDocumentTransaction = & new DocumentTransaction($this->oDocument->getId(), "Document deleted: " . $sReason, DELETE);
+        $oDocumentTransaction = & new DocumentTransaction($this->oDocument, "Document deleted: " . $sReason, 'ktcore.transactions.delete');
         $oDocumentTransaction->create();
         $this->commitTransaction();
@@ -478,7 +478,8 @@ class KTDocumentMoveAction extends KTDocumentAction {
             $sReason);
         // create the document transaction record
-        $oDocumentTransaction = & new DocumentTransaction($this->oDocument->getID(), $sMoveMessage, MOVE);
+        
+        $oDocumentTransaction = & new DocumentTransaction($this->oDocument, $sMoveMessage, 'ktcore.transactions.move');
         $oDocumentTransaction->create();
         $this->commitTransaction();
@@ -81,7 +81,7 @@ class DeletedDocumentsDispatcher extends KTAdminDispatcher {
         foreach ($aDocuments as $oDoc) {
             if (!PhysicalDocumentManager::expunge($oDoc)) { $aErrorDocuments[] = $oDoc->getDisplayPath(); }
             else {
-                $oDocumentTransaction = & new DocumentTransaction($oDoc->getId(), "Document expunged", EXPUNGE);
+                $oDocumentTransaction = & new DocumentTransaction($oDoc, "Document expunged", 'ktcore.transactions.expunge');
                 $oDocumentTransaction->create();
                 // delete this from the db now
@@ -108,7 +108,7 @@ class KTCheckoutAdminDispatcher extends KTAdminDispatcher {
         }
         // checkout cancelled transaction
-        $oDocumentTransaction = & new DocumentTransaction($oDocument->getID(), "Document checked out cancelled", FORCE_CHECKIN);
+        $oDocumentTransaction = & new DocumentTransaction($oDocument, "Document checked out cancelled", 'ktcore.transactions.force_checkin');
         if ($oDocumentTransaction->create()) {
             $default->log->debug("editDocCheckoutBL.php created forced checkin document transaction for document ID=" . $oDocument->getID());                                    	
         } else {
@@ -6,6 +6,7 @@ require_once(KT_LIB_DIR . &quot;/email/Email.inc&quot;);
 require_once(KT_LIB_DIR . "/users/User.inc");
 require_once(KT_LIB_DIR . "/groups/Group.inc");
 require_once(KT_LIB_DIR . "/documentmanagement/DocumentTransaction.inc");
+require_once(KT_LIB_DIR . "/documentmanagement/Document.inc");
 /**
  * Sends emails to the selected groups
@@ -122,7 +123,7 @@ function sendEmailDocument($sDestEmailAddress, $sDestUserName, $iDocumentID, $sD
     }
     // emailed link transaction
-    $oDocumentTransaction = & new DocumentTransaction($iDocumentID, "Document link emailed to $sDestEmailAddress", EMAIL_ATTACH);
+    $oDocumentTransaction = & new DocumentTransaction($oDocument, "Document link emailed to " . $sDestEmailAddress, 'ktcore.transactions.email_attachment');
     if ($oDocumentTransaction->create()) {
         $default->log->debug("emailBL.php created email link document transaction for document ID=$iDocumentID");
     } else {
@@ -164,7 +165,10 @@ function sendEmailHyperlink($sDestEmailAddress, $sDestUserName, $iDocumentID, $s
 	}
 	// emailed link transaction
-	$oDocumentTransaction = & new DocumentTransaction($iDocumentID, "Document link emailed to $sDestEmailAddress", EMAIL_LINK);
+	// need a document to do this.
+	$oDocument =& Document::get($iDocumentID);
+	
+	$oDocumentTransaction = & new DocumentTransaction($oDocument, "Document link emailed to " . $sDestEmailAddress, 'ktcore.transactions.email_link');
 	if ($oDocumentTransaction->create()) {
 		$default->log->debug("emailBL.php created email link document transaction for document ID=$iDocumentID");                                    	
 	} else {
@@ -257,7 +257,7 @@ class KTEditDocumentDispatcher extends KTStandardDispatcher {
 		$oDocument->setLastModifiedDate(getCurrentDateTime());
 		$oDocument->setModifiedUserId($this->oUser->getId());
 		$oDocument->setMetadataVersion($oDocument->getMetadataVersion() + 1);
-        $oDocumentTransaction = & new DocumentTransaction($oDocument->getID(), 'update metadata.', UPDATE);
+        $oDocumentTransaction = & new DocumentTransaction($oDocument, 'update metadata.', 'ktcore.transactions.update');
         $res = $oDocumentTransaction->create();
 		if (PEAR::isError($res)) {
@@ -162,7 +162,7 @@ class ViewDocumentDispatcher extends KTStandardDispatcher {
 		// FIXME do we really need to use a raw db-access here?  probably...
 		$sQuery = "SELECT DTT.name AS transaction_name, U.name AS user_name, DT.version AS version, DT.comment AS comment, DT.datetime AS datetime " .
 			"FROM " . KTUtil::getTableName("document_transactions") . " AS DT INNER JOIN " . KTUtil::getTableName("users") . " AS U ON DT.user_id = U.id " .
-			"INNER JOIN " . KTUtil::getTableName("transaction_types") . " AS DTT ON DTT.id = DT.transaction_id " . 
+			"INNER JOIN " . KTUtil::getTableName("transaction_types") . " AS DTT ON DTT.namespace = DT.transaction_namespace " . 
 			"WHERE DT.document_id = ? ORDER BY DT.datetime DESC";
         $aParams = array($document_id);
 		$res = DBUtil::getResultArray(array($sQuery, $aParams));
@@ -367,11 +367,10 @@ CREATE TABLE `document_transactions` (
   `ip` char(30) default NULL,
   `filename` char(255) NOT NULL default '',
   `comment` char(255) NOT NULL default '',
-  `transaction_id` int(11) default NULL,
+  `transaction_namespace` char(255) NOT NULL default 'ktcore.transactions.event',
   UNIQUE KEY `id` (`id`),
   KEY `fk_document_id` (`document_id`),
   KEY `fk_user_id` (`user_id`),
-  KEY `fk_transaction_id` (`transaction_id`)
 ) ENGINE=InnoDB ;
 -- --------------------------------------------------------
+SET FOREIGN_KEY_CHECKS=0;
+
+ALTER TABLE `document_transactions` ADD `transaction_namespace` char(255) NOT NULL default 'ktcore.transactions.event';
+
+UPDATE `document_transactions` SET `transaction_namespace` = 'ktcore.transactions.create' WHERE `transaction_id` = 1;
+UPDATE `document_transactions` SET `transaction_namespace` = 'ktcore.transactions.update' WHERE `transaction_id` = 2;
+UPDATE `document_transactions` SET `transaction_namespace` = 'ktcore.transactions.delete' WHERE `transaction_id` = 3;
+UPDATE `document_transactions` SET `transaction_namespace` = 'ktcore.transactions.rename' WHERE `transaction_id` = 4;
+UPDATE `document_transactions` SET `transaction_namespace` = 'tcore.transactions.move' WHERE `transaction_id` = 5;
+UPDATE `document_transactions` SET `transaction_namespace` = 'ktcore.transactions.download' WHERE `transaction_id` = 6;
+UPDATE `document_transactions` SET `transaction_namespace` = 'ktcore.transactions.check_in' WHERE `transaction_id` = 7;
+UPDATE `document_transactions` SET `transaction_namespace` = 'ktcore.transactions.check_out' WHERE `transaction_id` = 8;
+UPDATE `document_transactions` SET `transaction_namespace` = 'ktcore.transactions.collaboration_step_rollback' WHERE `transaction_id` = 9;
+UPDATE `document_transactions` SET `transaction_namespace` = 'ktcore.transactions.view' WHERE `transaction_id` = 10;
+UPDATE `document_transactions` SET `transaction_namespace` = 'ktcore.transactions.expunge' WHERE `transaction_id` = 11;
+UPDATE `document_transactions` SET `transaction_namespace` = 'ktcore.transactions.force_checkin' WHERE `transaction_id` = 12;
+UPDATE `document_transactions` SET `transaction_namespace` = 'ktcore.transactions.email_link' WHERE `transaction_id` = 13;
+UPDATE `document_transactions` SET `transaction_namespace` = 'ktcore.transactions.collaboration_step_approve' WHERE `transaction_id` = 14;
+UPDATE `document_transactions` SET `transaction_namespace` = 'ktcore.transactions.email_attachment' WHERE `transaction_id` = 15;
+UPDATE `document_transactions` SET `transaction_namespace` = 'ktcore.transactions.workflow_state_transition' WHERE `transaction_id` = 16;
+
+ALTER TABLE `document_transactions` DROP `transaction_id`;
+
+SET FOREIGN_KEY_CHECKS=1;