Add option to delay notifications when entry added to channel if entr…

alpha/apps/kaltura/lib/batch2/kFlowHelper.php

@@ -2967,6 +2967,16 @@ public static function addDeliveryTagToEntry(entry $entry)
 			$entry->save();
 		}
 	}
+
+	public static function handleDelayedNotification(entry $entry)
+	{
+		$delayedLockedJob = BatchJobLockPeer::retrieveByEntryIdAndStatus($entry->getEntryId(), BatchJob::BATCHJOB_STATUS_DELAYED);
+		if ($delayedLockedJob)
+		{
+			$delayedJob = BatchJobPeer::retrieveByEntryIdAndStatus($entry->getEntryId(), BatchJob::BATCHJOB_STATUS_DELAYED);
+			kJobsManager::updateBatchJob($delayedJob, BatchJob::BATCHJOB_STATUS_PENDING);
+		}
+	}
 
 	/**
 	 * @param entry $entry

alpha/apps/kaltura/lib/batch2/kFlowManager.php

@@ -686,6 +686,7 @@ public function objectChanged(BaseObject $object, array $modifiedColumns)
 			&& $object->getStatus() == entryStatus::READY)
 		{
 			kFlowHelper::addDeliveryTagToEntry($object);
+			kFlowHelper::handleDelayedNotification($object);
 		}
 
 		if ($object instanceof entry

alpha/lib/model/BatchJob.php

@@ -35,6 +35,7 @@ class BatchJob extends BaseBatchJob implements ISyncableFile
 	const BATCHJOB_STATUS_FINISHED_PARTIALLY = 12;
 	const BATCHJOB_STATUS_SUSPEND = 13;
 	const BATCHJOB_STATUS_SUSPEND_ALMOST_DONE = 14;
+	const BATCHJOB_STATUS_DELAYED = 15;
 
 	const FILE_SYNC_BATCHJOB_SUB_TYPE_BULKUPLOAD = 1;
 	const FILE_SYNC_BATCHJOB_SUB_TYPE_CONFIG = 3;

alpha/lib/model/BatchJobLockPeer.php

@@ -20,8 +20,8 @@ class BatchJobLockPeer extends BaseBatchJobLockPeer {
 	);
 
 	const COUNT = 'COUNT(batch_job_lock.ID)';
-	
-	
+
+
 	/**
 	 * This function returns a list of all job statuses that still require scheduling
 	 * and therefore a lock object should appear for them in the lock table.
@@ -35,7 +35,8 @@ public static function getSchedulingRequiredStatusList()
 			BatchJob::BATCHJOB_STATUS_RETRY,
 			BatchJob::BATCHJOB_STATUS_PROCESSING,
 			BatchJob::BATCHJOB_STATUS_PROCESSED,
-			BatchJob::BATCHJOB_STATUS_MOVEFILE
+			BatchJob::BATCHJOB_STATUS_MOVEFILE,
+			BatchJob::BATCHJOB_STATUS_DELAYED
 		);
 	}
 
@@ -243,4 +244,12 @@ public static function retrieveByEntryId($entryId, array $jobTypes = null, array
 
 	    return self::doSelect($c);
 	}
+
+	public static function retrieveByEntryIdAndStatus($obj_id, $status)
+	{
+		$c = new Criteria();
+		$c->add ( self::ENTRY_ID , $obj_id );
+		$c->add ( self::STATUS , $status );
+		return self::doSelectOne( $c );
+	}
 } // BatchJobLockPeer

alpha/lib/model/BatchJobPeer.php

@@ -32,6 +32,7 @@ public static function getUnClosedStatusList()
 			BatchJob::BATCHJOB_STATUS_PROCESSED,
 			BatchJob::BATCHJOB_STATUS_MOVEFILE,
 			BatchJob::BATCHJOB_STATUS_RETRY,
+			BatchJob::BATCHJOB_STATUS_DELAYED
 		);
 	}
 
@@ -79,6 +80,14 @@ public static function retrieveByEntryId($obj_id)
 		$c->add ( self::ENTRY_ID , $obj_id );
 		return self::doSelect( $c );
 	}
+
+	public static function retrieveByEntryIdAndStatus($obj_id, $status)
+	{
+		$c = new Criteria();
+		$c->add ( self::ENTRY_ID , $obj_id );
+		$c->add ( self::STATUS , $status );
+		return self::doSelectOne( $c );
+	}
 
 	public static function doAvgTimeDiff($jobType, $t1, $t2, PDO $con = null)
 	{

deployment/permissions/object.KalturaEventNotificationTemplate.ini

@@ -55,3 +55,15 @@ permissionItem8.parameter = manualDispatchEnabled
 permissionItem8.action = insert
 permissionItem8.partnerId = -2
 permissionItem8.permissions = eventNotification.SYSTEM_ADMIN_EVENT_NOTIFICATION_INSERT, PARTNER_-2_GROUP_*_PERMISSION
+
+permissionItem9.object = KalturaEventNotificationTemplate
+permissionItem9.parameter = eventDelayedConditions
+permissionItem9.action = insert
+permissionItem9.partnerId = -2
+permissionItem9.permissions = eventNotification.SYSTEM_ADMIN_EVENT_NOTIFICATION_INSERT, PARTNER_-2_GROUP_*_PERMISSION
+
+permissionItem10.object = KalturaEventNotificationTemplate
+permissionItem10.parameter = eventDelayedConditions
+permissionItem10.action = update
+permissionItem10.partnerId = -2
+permissionItem10.permissions = eventNotification.SYSTEM_ADMIN_EVENT_NOTIFICATION_MODIFY, PARTNER_-2_GROUP_*_PERMISSION

deployment/updates/scripts/add_permissions/2025_01_19_eventNotification_update_eventDelayedConditions_permission.php

@@ -0,0 +1,9 @@
+<?php
+/**
+ * @package deployment
+ * @subpackage scorpius.roles_and_permissions
+ */
+
+$script = realpath(dirname(__FILE__) . '/../../../../') . '/alpha/scripts/utils/permissions/addPermissionsAndItems.php';
+$config = realpath(dirname(__FILE__)) . '/../../../permissions/object.KalturaEventNotificationTemplate.ini';
+passthru("php $script $config");

plugins/event_notification/lib/api/enums/KalturaEventNotificationDelayedConditions.php

@@ -0,0 +1,9 @@
+<?php
+/**
+ * @package plugins.eventNotification
+ * @subpackage api.enum
+ * @see EventNotificationTemplateStatus
+ */
+class KalturaEventNotificationDelayedConditions extends KalturaEnum implements EventNotificationDelayedConditions
+{
+}

plugins/event_notification/lib/api/types/KalturaEventNotificationTemplate.php

@@ -114,6 +114,14 @@ class KalturaEventNotificationTemplate extends KalturaObject implements IFiltera
 	 * @var KalturaEventNotificationParameterArray
 	 */
 	public $userParameters;
+
+	/**
+	 * Event batch job will be delayed until specific condition criteria is met
+	 *
+	 * @var KalturaEventNotificationDelayedConditions
+	 * @requiresPermission update
+	 */
+	public $eventDelayedConditions;
 
 	/**
 	 * mapping between the field on this object (on the left) and the setter/getter on the entry object (on the right)  
@@ -134,6 +142,7 @@ class KalturaEventNotificationTemplate extends KalturaObject implements IFiltera
 		'eventConditions',
 		'contentParameters',
 		'userParameters',
+		'eventDelayedConditions'
 	);
 
 	/* (non-PHPdoc)
@@ -173,7 +182,7 @@ public function toObject($dbObject = null, $propertiesToSkip = array())
 	{
 		if(is_null($dbObject))
 			throw new kCoreException("Event notification template type [" . $this->type . "] not found", kCoreException::OBJECT_TYPE_NOT_FOUND, $this->type);
-        	
+
 		return parent::toObject($dbObject, $propertiesToSkip);
 	}
 
@@ -219,4 +228,4 @@ protected function validate (EventNotificationTemplate $sourceObject = null)
 			}
 		}
 	}
-}
+}

plugins/event_notification/lib/model/BatchEventNotificationTemplate.php

@@ -117,7 +117,29 @@ protected function addEventNotificationDispatchJob($eventNotificationType, kEven
 		$batchJob = kJobsManager::addJob($batchJob, $jobData, $jobType, $eventNotificationType);
 		$jobData->setJobId($batchJob->getId());
 		$batchJob->setData($jobData);
-
+
+		if ($this->getEventDelayedConditions() && $entryId && $this->areDelayedEventConditionsMet($entryId))
+		{
+			return kJobsManager::updateBatchJob($batchJob, BatchJob::BATCHJOB_STATUS_DELAYED);
+		}
+
 		return kJobsManager::updateBatchJob($batchJob, BatchJob::BATCHJOB_STATUS_PENDING);
 	}
+
+	public function areDelayedEventConditionsMet($objectId)
+	{
+		$delayedEventConditions = $this->getEventDelayedConditions();
+		if ($delayedEventConditions)
+		{
+			switch ($delayedEventConditions)
+			{
+				case EventNotificationDelayedConditions::PENDING_ENTRY_READY:
+				{
+					$entry = BaseentryPeer::retrieveByPK($objectId);
+					return $entry->getStatus() !== entryStatus::READY;
+				}
+			}
+		}
+		return false;
+	}
 }

plugins/event_notification/lib/model/EventNotificationTemplate.php

@@ -21,6 +21,7 @@ abstract class EventNotificationTemplate extends BaseEventNotificationTemplate i
 	const CUSTOM_DATA_MANUAL_DISPATCH_ENABLED = 'manualDispatchEnabled';
 	const CUSTOM_DATA_AUTOMATIC_DISPATCH_ENABLED = 'automaticDispatchEnabled';
 	const CUSTOM_DATA_URL_ENCODE = 'urlEncode';
+	const EVENT_DELAYED_CONDITIONS = 'eventDelayedConditions';
 
 	/**
 	 * Dispatch the event notification
@@ -58,6 +59,16 @@ public function getCacheInvalidationKeys()
 	{
 		return array("eventNotificationTemplate:id=".strtolower($this->getId()), "eventNotificationTemplate:partnerId=".strtolower($this->getPartnerId()));
 	}
+
+	public function setEventDelayedConditions($v)
+	{
+		return $this->putInCustomData(self::EVENT_DELAYED_CONDITIONS, $v);
+	}
+
+	public function getEventDelayedConditions()
+	{
+		return $this->getFromCustomData(self::EVENT_DELAYED_CONDITIONS, null, null);
+	}
 
 	public function getContentParametersKeyValueArray()
 	{

plugins/event_notification/lib/model/enums/EventNotificationDelayedConditions.php

@@ -0,0 +1,10 @@
+<?php
+/**
+ * @package plugins.eventNotification
+ * @subpackage model.enum
+ */ 
+interface EventNotificationDelayedConditions extends BaseEnum
+{
+	const NONE = 0;
+	const PENDING_ENTRY_READY = 1;
+}

plugins/event_notification/providers/email/lib/EmailNotificationTemplateConfiguration.php

@@ -39,6 +39,16 @@ public function populateFromObject($object, $add_underscore = true)
 	 */
 	protected function addTypeElements(Kaltura_Client_EventNotification_Type_EventNotificationTemplate $eventNotificationTemplate)
 	{
+		$this->addElement('select', 'event_delayed_conditions', array(
+			'label'			=> 'Delay Notification Condition:',
+			'filters'		=> array('StringTrim'),
+			'required'		=> true,
+			'multiOptions' 	=> array(
+				Kaltura_Client_EventNotification_Enum_EventNotificationDelayedConditions::NONE => 'Do not delay',
+				Kaltura_Client_EventNotification_Enum_EventNotificationDelayedConditions::PENDING_ENTRY_READY => 'Until entry is ready',
+			),
+		));
+
 		$format = new Kaltura_Form_Element_EnumSelect('format', array(
 			'enum' => 'Kaltura_Client_EmailNotification_Enum_EmailNotificationFormat',
 			'label'			=> 'Format:',
@@ -159,4 +169,4 @@ protected function populateHeaderField($object , $headerName)
             ));
         }
 	}	
-}
+}

plugins/event_notification/providers/http/admin/HttpNotificationTemplateConfiguration.php

@@ -90,6 +90,16 @@ protected function addTypeElements(Kaltura_Client_EventNotification_Type_EventNo
 		));
 		$this->addElements(array($element));
 
+		$this->addElement('select', 'event_delayed_conditions', array(
+			'label'			=> 'Delay Notification Condition:',
+			'filters'		=> array('StringTrim'),
+			'required'		=> true,
+			'multiOptions' 	=> array(
+				Kaltura_Client_EventNotification_Enum_EventNotificationDelayedConditions::NONE => 'None',
+				Kaltura_Client_EventNotification_Enum_EventNotificationDelayedConditions::PENDING_ENTRY_READY => 'When entry is ready',
+			),
+		));
+
 		$this->addElement('select', 'secureHashingAlgo', array(
 			'label'			=> 'Secure Hashing Algorithm:',
 			'filters'		=> array('StringTrim'),
@@ -159,4 +169,4 @@ protected function addTypeElements(Kaltura_Client_EventNotification_Type_EventNo
 				'decorators' 	=> array('FormElements', 'Fieldset', array('HtmlTag', array('tag' => 'div', 'style' => 'display: none', 'id' => 'frmFreeText'))),
 		));
 	}
-}
+}

release-notes.md

@@ -1,3 +1,9 @@
+# Ursa-21.8.0
+## Add option to delay notifications ##
+* Issue Type: Task
+* Issue ID: PLAT-25045
+### Deployment script ### 
+    php deployment/updates/scripts/add_permissions/2025_01_19_eventNotification_update_eventDelayedConditions_permission.php
 # Ursa-21.4.0
 ## Kava - redirect external client tags to dedicated druid url ##
 - Issue Type: Story