Merge pull request #798 from kaltura/IX-9.10.0-convert-engine-message

Added support in EngineMessage and reflect in on the flavor.
kaltura · Jan 30, 2014 · 3fc3003 · 3fc3003
2 parents bd1705c + 46630f2
commit 3fc3003
Show file tree

Hide file tree

Showing 6 changed files with 55 additions and 27 deletions.
diff --git a/alpha/apps/kaltura/lib/batch2/kFlowHelper.php b/alpha/apps/kaltura/lib/batch2/kFlowHelper.php
@@ -507,15 +507,21 @@ public static function handleConvertFinished(BatchJob $dbBatchJob, kConvertJobDa
 		if(!$flavorAsset)
 			throw new APIException(APIErrors::INVALID_FLAVOR_ASSET_ID, $data->getFlavorAssetId());
 
-		$flavorAsset->setDescription($flavorAsset->getDescription() . "\n" . $dbBatchJob->getMessage());
+		$shouldSave = false;
+		if(!is_null($data->getEngineMessage())) {
+			$flavorAsset->setDescription($flavorAsset->getDescription() . "\n" . $data->getEngineMessage());
+			$shouldSave = true;
+		}
 
 		$flavorParamsOutput = $data->getFlavorParamsOutput();
 
-		if($data->getDestFileSyncLocalPath())
-		{
-		$flavorAsset->incrementVersion();
-		$flavorAsset->save();
-		}
+		if($data->getDestFileSyncLocalPath()) {
+			$flavorAsset->incrementVersion();
+			$shouldSave = true;
+		}		
+
+		if($shouldSave)
+			$flavorAsset->save();
 
 		if(count($data->getExtraDestFileSyncs()))
 		{
@@ -940,10 +946,10 @@ public static function handleConvertFailed(BatchJob $dbBatchJob, kConvertJobData
 		if(!$flavorAsset)
 			throw new APIException(APIErrors::INVALID_FLAVOR_ASSET_ID, $data->getFlavorAssetId());
 
-		$description = $flavorAsset->getDescription();
-		$description .= "\n" . $dbBatchJob->getMessage();
-		$flavorAsset->setDescription($description);
-		$flavorAsset->save();
+		if(!is_null($data->getEngineMessage())) {
+			$flavorAsset->setDescription($flavorAsset->getDescription() . "\n" . $data->getEngineMessage());
+			$flavorAsset->save();
+		}
 
 		// creats the file sync
 		if(file_exists($data->getLogFileSyncLocalPath()))

diff --git a/alpha/apps/kaltura/lib/batch2/model/kConvertJobData.php b/alpha/apps/kaltura/lib/batch2/model/kConvertJobData.php
@@ -54,6 +54,11 @@ class kConvertJobData extends kConvartableJobData
 	 */
 	private $extraDestFileSyncs;	
 
+	/**
+	 * @var string
+	 */
+	private $engineMessage;
+
 	/**
 	 * @return the $destFileSyncLocalPath
 	 */
@@ -287,5 +292,22 @@ public function getExtraDestFileSyncs() {
 	 */
 	public function setExtraDestFileSyncs($destFileSyncs) {
 		$this->extraDestFileSyncs = $destFileSyncs;
-	}	
+	}
+
+	/**
+	 * @return the $engineMessage
+	 */
+	public function getEngineMessage() {
+		return $this->engineMessage;
+	}
+
+	/**
+	 * @param string $engineMessage
+	 */
+	public function setEngineMessage($engineMessage) {
+		$this->engineMessage = $engineMessage;
+	}
+
+
+
 }
diff --git a/api_v3/lib/types/batch/KalturaConvertJobData.php b/api_v3/lib/types/batch/KalturaConvertJobData.php
@@ -46,6 +46,11 @@ class KalturaConvertJobData extends KalturaConvartableJobData
 	 * @var KalturaDestFileSyncDescriptorArray
 	 */
 	public $extraDestFileSyncs;
+
+	/**
+	 * @var string
+	 */
+	public $engineMessage;
 
 	private static $map_between_objects = array
 	(
@@ -57,6 +62,7 @@ class KalturaConvertJobData extends KalturaConvartableJobData
 		"remoteMediaId" ,
 		"customData" ,
 		"extraDestFileSyncs",
+		"engineMessage",
 	);
 
 	public function getMapBetweenObjects ( )

diff --git a/batch/batches/Convert/KAsyncConvert.class.php b/batch/batches/Convert/KAsyncConvert.class.php
@@ -207,9 +207,7 @@ protected function convertJob(KalturaBatchJob $job, KalturaConvertJobData $data)
 			$this->stopMonitor();
 
 			$jobMessage = "engine [" . get_class($this->operationEngine) . "] converted successfully. ";
-			if($this->operationEngine->getMessage())
-				$jobMessage =  " Engine message [ " . $jobMessage.$this->operationEngine->getMessage() . "]";
-
+
 			if(!$isDone)
 			{
 				return $this->closeJob($job, null, null, $jobMessage, KalturaBatchJobStatus::ALMOST_DONE, $data);
@@ -222,6 +220,7 @@ protected function convertJob(KalturaBatchJob $job, KalturaConvertJobData $data)
 		}
 		catch(KOperationEngineException $e)
 		{
+			$data = $this->operationEngine->getData();
 			$log = $this->operationEngine->getLogData();
 			//removing unsuported XML chars
 			$log  = preg_replace('/[^\t\n\r\x{20}-\x{d7ff}\x{e000}-\x{fffd}\x{10000}-\x{10ffff}]/u','',$log);
@@ -237,9 +236,8 @@ protected function convertJob(KalturaBatchJob $job, KalturaConvertJobData $data)
 				}
 			}
 			$err = "engine [" . get_class($this->operationEngine) . "] converted failed: " . $e->getMessage();
-			if($this->operationEngine->getMessage())
-				$err .= " Engine message [ " . $this->operationEngine->getMessage() . "]";
-			return $this->closeJob($job, KalturaBatchJobErrorTypes::APP, KalturaBatchJobAppErrors::CONVERSION_FAILED, $err, KalturaBatchJobStatus::FAILED);
+
+			return $this->closeJob($job, KalturaBatchJobErrorTypes::APP, KalturaBatchJobAppErrors::CONVERSION_FAILED, $err, KalturaBatchJobStatus::FAILED, $data);
 		}
 	}
 
@@ -328,11 +326,7 @@ private function moveFile(KalturaBatchJob $job, KalturaConvertJobData $data)
 			$data->logFileSyncLocalPath = '';
 		}
 
-		$jobMessage = $job->message;
-		if($this->operationEngine->getMessage())
-				$jobMessage .=  " Engine message [ " . $this->operationEngine->getMessage() . "]";
-
-		return $this->closeJob($job, null, null, $jobMessage, $job->status, $data);
+		return $this->closeJob($job, null, null, $job->message, $job->status, $data);
 	}
 
 	private function moveExtraFiles(KalturaConvertJobData &$data, $sharedFile)

diff --git a/plugins/content/document/lib/operation_engines/KOperationEngineImageMagick.php b/plugins/content/document/lib/operation_engines/KOperationEngineImageMagick.php
@@ -71,11 +71,11 @@ public function operate(kOperator $operator = null, $inFilePath, $configFilePath
 		// - Test file type
 		$errorMsg = $this->checkFileType($realInFilePath, $this->SUPPORTED_FILE_TYPES);
 		if(!is_null($errorMsg))
-			$this->message = $errorMsg;
+			$this->data->engineMessage = $errorMsg;
 
 		// Test password required
 		if($this->testPasswordRequired($realInFilePath)) {
-			$this->message = "Password required.";
+			$this->data->engineMessage = "Password required.";
 		}
 
 		parent::operate($operator, $realInFilePath, $configFilePath);
@@ -87,7 +87,7 @@ public function operate(kOperator $operator = null, $inFilePath, $configFilePath
 		$firstImage = $outDirPath . DIRECTORY_SEPARATOR . $imagesList[0];
 		$errorMsg = $this->testBlackImage($identifyExe, $firstImage, $errorMsg);
 		if(!is_null($errorMsg)) {
-			$this->message = $errorMsg;
+			$this->data->engineMessage = $errorMsg;
 		}
 
 		$imagesListXML = $this->createImagesListXML($imagesList);

diff --git a/plugins/content/document/lib/operation_engines/KOperationEnginePdfCreator.php b/plugins/content/document/lib/operation_engines/KOperationEnginePdfCreator.php
@@ -113,7 +113,7 @@ public function operate(kOperator $operator = null, $inFilePath, $configFilePath
 		// Test file type 
 		$errorMsg = $this->checkFileType($realInFilePath, $this->SUPPORTED_FILE_TYPES);
 		if(!is_null($errorMsg))
-			$this->message = $errorMsg;
+			$this->data->engineMessage = $errorMsg;
 
 		parent::operate($operator, $realInFilePath, $configFilePath);
 
@@ -202,7 +202,7 @@ private function validateOutput($inFilePath, $outFilePath)
 			$outputNum = $this->getNumberOfPages($outputPdfInfo);
 			if($inputNum != $outputNum) {
 				$errorMsg = "Output file doesn't match expected page count (input: $inputNum, output: $outputNum)";
-				$this->message = $errorMsg;
+				$this->data->engineMessage = $errorMsg;
 			}
 		}
 	}