fix for KTS-348: discussion subscription notifications.

git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@5954 c91229c3-7414-0410-bfa2-8a42b809f60b

fix for KTS-348: discussion subscription notifications.
git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@5954 c91229c3-7414-0410-bfa2-8a42b809f60b
bshuttle
1 parent a6360f27
Showing 5 changed files with 130 additions and 5 deletions
lib/dashboard/Notification.inc.php
lib/subscriptions/subscriptions.inc.php
plugins/ktstandard/KTDiscussion.php
plugins/ktstandard/KTSubscriptions.php
templates/kt3/notifications/subscriptions.DiscussDocument.smarty
@@ -189,7 +189,9 @@ class KTSubscriptionNotification extends KTNotificationHandler {
         "CheckOutDocument" => 'document',
         "MovedDocument" => 'document',
         "ArchivedDocument" => 'document', // can go through and request un-archival (?)
-        "RestoredArchivedDocument" => 'document');	
+        "RestoredArchivedDocument" => 'document',
+        "DiscussDocument" => 'document',
+        );	
     function KTSubscriptionNotification() {
         $this->_eventTypeNames = array(
@@ -204,7 +206,8 @@ class KTSubscriptionNotification extends KTNotificationHandler {
             "CheckOutDocument" => _kt('Document checked out'),
             "MovedDocument" => _kt('Document moved'),
             "ArchivedDocument" => _kt('Document archived'), // can go through and request un-archival (?)
-            "RestoredArchivedDocument" => _kt('Document restored')
+            "RestoredArchivedDocument" => _kt('Document restored'),
+            "DiscussDocument" => _kt('Document Discussions updated'),            
         );
         //parent::KTNotificationHandler();
     }
@@ -317,6 +317,59 @@ class SubscriptionEvent {
 			}
 		}
     }
+    
+    function DiscussDocument($oModifiedDocument, $oParentFolder)  { 
+        $content = new SubscriptionContent(); // needed for i18n	
+	    // OK:  two actions:  document registrants, folder registrants.
+        $aUsers = $this->_getSubscribers($oModifiedDocument->getId(), $this->subscriptionTypes["Document"]);
+		$aUsers = $this->_pruneAlertedUsers($aUsers); // setup the alerted users.  _might_ be a singleton.
+		foreach ($aUsers as $oSubscriber) {
+		
+		    // notification object first.		
+			$aNotificationOptions = array();
+			$aNotificationOptions['target_user'] = $oSubscriber->getID();
+		    $aNotificationOptions['actor_id'] = KTUtil::arrayGet($_SESSION,"userID", null); // _won't_ be null.
+		    $aNotificationOptions['target_name'] = $oModifiedDocument->getName();
+		    $aNotificationOptions['location_name'] = Folder::generateFullFolderPath($oParentFolder->getId());
+		    $aNotificationOptions['object_id'] = $oModifiedDocument->getId();  // parent folder_id, in this case.
+		    $aNotificationOptions['event_type'] = "DiscussDocument";		
+			$oNotification =& KTSubscriptionNotification::generateSubscriptionNotification($aNotificationOptions);
+			
+			// now the email content.			
+			// FIXME this needs to be handled entirely within notifications from now on.
+			if ($oSubscriber->getEmailNotification() && (strlen($oSubscriber->getEmail()) > 0)) {
+			    $emailContent = $content->getEmailAlertContent($oNotification);
+				$emailSubject = $content->getEmailAlertSubject($oNotification);
+				$oEmail = new EmailAlert($oSubscriber->getEmail(), $emailSubject, $emailContent);
+				$oEmail->send();
+			}
+		}
+		
+        $aUsers = $this->_getSubscribers($oParentFolder->getId(), $this->subscriptionTypes["Folder"]);
+		$aUsers = $this->_pruneAlertedUsers($aUsers); // setup the alerted users.  _might_ be a singleton.
+		foreach ($aUsers as $oSubscriber) {
+		
+		    // notification object first.		
+			$aNotificationOptions = array();
+			$aNotificationOptions['target_user'] = $oSubscriber->getID();
+		    $aNotificationOptions['actor_id'] = KTUtil::arrayGet($_SESSION,"userID", null); // _won't_ be null.
+		    $aNotificationOptions['target_name'] = $oModifiedDocument->getName();
+		    $aNotificationOptions['location_name'] = Folder::generateFullFolderPath($oParentFolder->getId());
+		    $aNotificationOptions['object_id'] = $oModifiedDocument->getId();  // parent folder_id, in this case.
+		    $aNotificationOptions['event_type'] = "DiscussDocument";		
+			$oNotification =& KTSubscriptionNotification::generateSubscriptionNotification($aNotificationOptions);
+			
+			// now the email content.			
+			// FIXME this needs to be handled entirely within notifications from now on.
+			if ($oSubscriber->getEmailNotification() && (strlen($oSubscriber->getEmail()) > 0)) {
+			    $emailContent = $content->getEmailAlertContent($oNotification);
+				$emailSubject = $content->getEmailAlertSubject($oNotification);
+				$oEmail = new EmailAlert($oSubscriber->getEmail(), $emailSubject, $emailContent);
+				$oEmail->send();
+			}
+		}
+    }
+    
     function CheckInDocument($oModifiedDocument, $oParentFolder)  { 
         $content = new SubscriptionContent(); // needed for i18n	
 	    // OK:  two actions:  document registrants, folder registrants.
@@ -677,7 +730,8 @@ class SubscriptionContent {
             "CheckOutDocument" => _kt('Document checked out'),
             "MovedDocument" => _kt('Document moved'),
             "ArchivedDocument" => _kt('Document archived'), // can go through and request un-archival (?)
-            "RestoredArchivedDocument" => _kt('Document restored')
+            "RestoredArchivedDocument" => _kt('Document restored'),
+            "DiscussDocument" => _kt('Document Discussions updated'),                  
         );
 	}
@@ -729,7 +783,8 @@ class SubscriptionContent {
         "CheckOutDocument" => 'document',
         "MovedDocument" => 'document',
         "ArchivedDocument" => 'document', // can go through and request un-archival (?)
-        "RestoredArchivedDocument" => 'document');	
+        "RestoredArchivedDocument" => 'document',
+        "DiscussDocument" => 'document');	
@@ -191,6 +191,22 @@ class KTDocumentDiscussionAction extends KTDocumentAction {
         $res = $oThread->update();
         $aErrorOptions['message'] = _kt("There was an error updating the thread with the new comment");
         $this->oValidator->notError($res, $aErrorOptions);
+        
+        $oKTTriggerRegistry = KTTriggerRegistry::getSingleton();
+        $aTriggers = $oKTTriggerRegistry->getTriggers('discussion', 'postValidate');
+        foreach ($aTriggers as $aTrigger) {
+            $sTrigger = $aTrigger[0];
+            $oTrigger = new $sTrigger;
+            $aInfo = array(
+                "document" => $this->oDocument,
+                "comment" => $oComment,                
+            );
+            $oTrigger->setInfo($aInfo);
+            $ret = $oTrigger->postValidate();
+            if (PEAR::isError($ret)) {
+                $this->oValidator->notError($res, $aErrorOptions);
+            }
+        }        
         // Thread and comment created correctly, commit to database
         $this->commitTransaction();
@@ -303,7 +319,21 @@ class KTDocumentDiscussionAction extends KTDocumentAction {
         $aErrorOptions['message'] = _kt("There was an error updating the thread with the new comment");
         $this->oValidator->notError($res, $aErrorOptions);
-
+        $oKTTriggerRegistry = KTTriggerRegistry::getSingleton();
+        $aTriggers = $oKTTriggerRegistry->getTriggers('discussion', 'postValidate');
+        foreach ($aTriggers as $aTrigger) {
+            $sTrigger = $aTrigger[0];
+            $oTrigger = new $sTrigger;
+            $aInfo = array(
+                "document" => $this->oDocument,
+                "comment" => $oComment,
+            );
+            $oTrigger->setInfo($aInfo);
+            $ret = $oTrigger->postValidate();
+            if (PEAR::isError($ret)) {
+                $this->oValidator->notError($res, $aErrorOptions);
+            }
+        }  
         // Thread and comment created correctly, commit to database
         $this->commitTransaction();
@@ -63,6 +63,8 @@ class KTSubscriptionPlugin extends KTPlugin {
             'ktstandard.triggers.subscription.moveDocument');
         $this->registerTrigger('archive', 'postValidate', 'KTArchiveSubscriptionTrigger',
             'ktstandard.triggers.subscription.archive');
+        $this->registerTrigger('discussion', 'postValidate', 'KTDiscussionSubscriptionTrigger',
+            'ktstandard.triggers.subscription.archive');          
         $this->registerAction('foldersubscriptionaction', 'KTFolderSubscriptionAction',
             'ktstandard.subscription.foldersubscription');
         $this->registerAction('foldersubscriptionaction', 'KTFolderUnsubscriptionAction',
@@ -299,6 +301,24 @@ class KTArchiveSubscriptionTrigger {
 }
 // }}}
+
+
+class KTDiscussionSubscriptionTrigger {
+    var $aInfo = null;
+    function setInfo(&$aInfo) {
+        $this->aInfo =& $aInfo;
+    }
+
+    function postValidate() {
+        $oDocument =& $this->aInfo["document"];
+        $oSubscriptionEvent = new SubscriptionEvent();
+        $oFolder = Folder::get($oDocument->getFolderID());
+        
+        $oSubscriptionEvent->DiscussDocument($oDocument, $oFolder);
+    }
+}
+// }}}
+
 // {{{ KTFolderSubscriptionAction
 class KTFolderSubscriptionAction extends KTFolderAction {
     var $sName = 'ktstandard.subscription.foldersubscription';
+<dt class="actionitem subscription">{$info.title}</dt>
+<dd class="actionmessage">
+<!-- could break this up. -->
+    {if ($info.has_actor)} 
+    {$info.actor_name} has added to the discussion around document "{$info.object_name}".	
+	{else}	
+    The discussion around document "{$info.object_name}" has been updated.	
+	{/if}
+    <div class="actionoptions">    
+        {if !$is_broken}
+        <a href="{ktLink base="notify.php" query="id=`$info.notify_id`"}">{i18n}View Document{/i18n}</a>
+        {else}
+        <span class="descriptiveText">{i18n}Document is no longer available{/i18n}</span>
+        {/if}
+        | <a href="{ktLink base="notify.php" query="id=`$info.notify_id`&notify_action=clear"}">{i18n}Clear Alert{/i18n}</a>
+    </div>
+</dd>