sintonia/airtime_mvc/application/services/HistoryService.php

<?php

require_once 'formatters/LengthFormatter.php';

class Application_Service_HistoryService
{
	private $con;
	private $timezone;
	
	const TEMPLATE_TYPE_ITEM = "item";
	const TEMPLATE_TYPE_FILE = "file";

	public function __construct()
	{
		$this->con = isset($con) ? $con : Propel::getConnection(CcPlayoutHistoryPeer::DATABASE_NAME);
		$this->timezone = Application_Model_Preference::GetTimezone();
	}
	
	public function getSupportedTemplateTypes()
	{
		return array(self::TEMPLATE_TYPE_ITEM, self::TEMPLATE_TYPE_FILE);
	}
	
	//opts is from datatables.
	public function getPlayedItemData($startDT, $endDT, $opts)
	{
		$mainSqlQuery = "";
		$paramMap = array();
		$sqlTypes = $this->getSqlTypes();
		
		$start = $startDT->format("Y-m-d H:i:s");
		$end = $endDT->format("Y-m-d H:i:s");
		$paramMap["starts"] = $start;
		$paramMap["ends"] = $end;
		
		$template = $this->getConfiguredItemTemplate();
		$fields = $template["fields"];
		$required = $this->mandatoryItemFields();		
		
		$fields_filemd = array();
		$filemd_keys = array();
		$fields_general = array();
		$general_keys = array();
		
		foreach ($fields as $index=>$field) {
			
			if (in_array($field["name"], $required)) {
				continue;
			}
			
			if ($field["isFileMd"]) {
				$fields_filemd[] = $field;
				$filemd_keys[] = $field["name"];
			}
			else {
				$fields_general[] = $field;
				$general_keys[] = $field["name"];
			}
		}
		
		$historyRange = "(".
		"SELECT history.starts, history.ends, history.id AS history_id".
		" FROM cc_playout_history as history".
		" WHERE history.starts >= :starts and history.starts < :ends".
		") AS history_range";
				
		$manualMeta = "(".
		"SELECT %KEY%.value AS %KEY%, %KEY%.history_id".
		" FROM (".
		" SELECT * from cc_playout_history_metadata AS phm WHERE phm.key = :meta_%KEY%".
		" ) AS %KEY%".
		" ) AS %KEY%_filter";
		
		$mainSelect = array("history_range.starts", "history_range.ends", "history_range.history_id");
		$mdFilters = array();
		
		$numFileMdFields = count($fields_filemd);
		
		if ($numFileMdFields > 0) {
		
			//these 3 selects are only needed if $fields_filemd has some fields.
			$fileSelect = array("history_file.history_id");
			$nonNullFileSelect = array("file.id as file_id");
			$nullFileSelect = array("null_file.history_id");
			
			$fileMdFilters = array();
			
			//populate the different dynamic selects with file info.
			for ($i = 0; $i < $numFileMdFields; $i++) {
				
				$field = $fields_filemd[$i];
				$key = $field["name"];
				$type = $sqlTypes[$field["type"]];
				
				$fileSelect[] = "file_md.{$key}::{$type}";
				$nonNullFileSelect[] = "file.{$key}::{$type}";
				$nullFileSelect[] = "{$key}_filter.{$key}::{$type}";
				$mainSelect[] = "file_info.{$key}::{$type}";
				
				$fileMdFilters[] = str_replace("%KEY%", $key, $manualMeta);
				$paramMap["meta_{$key}"] = $key;
			}
			
			//the files associated with scheduled playback in Airtime.
			$historyFile = "(".
			"SELECT history.id AS history_id, history.file_id".
			" FROM cc_playout_history AS history".
			" WHERE history.file_id IS NOT NULL".
			") AS history_file";
			
			$fileMd = "(".
			"SELECT %NON_NULL_FILE_SELECT%".
			" FROM cc_files AS file".
			") AS file_md";
			
			$fileMd = str_replace("%NON_NULL_FILE_SELECT%", join(", ", $nonNullFileSelect), $fileMd);
			
			//null files are from manually added data (filling in webstream info etc)
			$nullFile = "(".
			"SELECT history.id AS history_id".
			" FROM cc_playout_history AS history".
			" WHERE history.file_id IS NULL".
			") AS null_file";
			
			
			//----------------------------------
			//building the file inner query
			
			$fileSqlQuery = 
			"SELECT ".join(", ", $fileSelect).
			" FROM {$historyFile}".
			" LEFT JOIN {$fileMd} USING (file_id)".
			" UNION".
			" SELECT ".join(", ", $nullFileSelect).
			" FROM {$nullFile}";
			
			foreach ($fileMdFilters as $filter) {
				
				$fileSqlQuery.=
				" LEFT JOIN {$filter} USING(history_id)";
			}
				
		}
		
		for ($i = 0, $len = count($fields_general); $i < $len; $i++) {
			
			$field = $fields_general[$i];
			$key = $field["name"];
			$type = $sqlTypes[$field["type"]];
			
			$mdFilters[] = str_replace("%KEY%", $key, $manualMeta);
			$paramMap["meta_{$key}"] = $key;
			$mainSelect[] = "{$key}_filter.{$key}::{$type}";
		}
		
		$mainSqlQuery.=
		"SELECT ".join(", ", $mainSelect).
		" FROM {$historyRange}";
		
		if (isset($fileSqlQuery)) {
			
			$mainSqlQuery.=
			" LEFT JOIN ( {$fileSqlQuery} ) as file_info USING(history_id)";
		}
		
		foreach ($mdFilters as $filter) {
		
			$mainSqlQuery.=
			" LEFT JOIN {$filter} USING(history_id)";
		}
		
		//----------------------------------------------------------------------
		//need to count the total rows to tell Datatables.
		$stmt = $this->con->prepare($mainSqlQuery);
		foreach ($paramMap as $param => $v) {
			$stmt->bindValue($param, $v);
		}
		
		if ($stmt->execute()) {
			$totalRows = $stmt->rowCount();
		}
		else {
			$msg = implode(',', $stmt->errorInfo());
			throw new Exception("Error: $msg");
		}
		
		//------------------------------------------------------------------------
		//Using Datatables parameters to sort the data.
		
		$numOrderColumns = $opts["iSortingCols"];
		$orderBys = array();
		
		for ($i = 0; $i < $numOrderColumns; $i++) {
			
			$colNum = $opts["iSortCol_".$i];
			$key = $opts["mDataProp_".$colNum];
			$sortDir = $opts["sSortDir_".$i];
			
			if (in_array($key, $required)) {

				$orderBys[] = "history_range.{$key} {$sortDir}";
			}
			else if (in_array($key, $filemd_keys)) {
			
				$orderBys[] = "file_info.{$key} {$sortDir}";
			}
			else if (in_array($key, $general_keys)) {

				$orderBys[] = "{$key}_filter.{$key} {$sortDir}";
			}
			else {
				throw new Exception("Error: $key is not part of the template.");
			}
		}
		
		if ($numOrderColumns > 0) {
			
			$orders = join(", ", $orderBys);
			
			$mainSqlQuery.=
			" ORDER BY {$orders}";
		}
		
		//---------------------------------------------------------------
		//using Datatables parameters to add limits/offsets
		
		$displayLength = intval($opts["iDisplayLength"]);
		//limit the results returned.
		if ($displayLength !== -1) {
			$mainSqlQuery.=
			" OFFSET :offset LIMIT :limit";
			
			$paramMap["offset"] = $opts["iDisplayStart"];
			$paramMap["limit"] = $displayLength;
		}
			
		$stmt = $this->con->prepare($mainSqlQuery);
		foreach ($paramMap as $param => $v) {
			$stmt->bindValue($param, $v);
		}
		
		$rows = array();
		if ($stmt->execute()) {
			$rows = $stmt->fetchAll(PDO::FETCH_ASSOC);
		}
		else {
			$msg = implode(',', $stmt->errorInfo());
			throw new Exception("Error: $msg");
		}
		
		//-----------------------------------------------------------------------
		//processing results.
		
		$timezoneUTC = new DateTimeZone("UTC");
		$timezoneLocal = new DateTimeZone($this->timezone);
		
		//need to display the results in the station's timezone.
		foreach ($rows as $index => &$result) {
		
			$dateTime = new DateTime($result["starts"], $timezoneUTC);
			$dateTime->setTimezone($timezoneLocal);
			$result["starts"] = $dateTime->format("Y-m-d H:i:s");
		
			$dateTime = new DateTime($result["ends"], $timezoneUTC);
			$dateTime->setTimezone($timezoneLocal);
			$result["ends"] = $dateTime->format("Y-m-d H:i:s");
		}
		
		return array(
			"sEcho" => intval($opts["sEcho"]),
			//"iTotalDisplayRecords" => intval($totalDisplayRows),
			"iTotalDisplayRecords" => intval($totalRows),
			"iTotalRecords" => intval($totalRows),
			"history" => $rows
		);
	}

	public function getFileSummaryData($startDT, $endDT, $opts)
	{
		$select = array (
			"summary.played", 
			"summary.file_id", 
			"summary.".MDATA_KEY_TITLE,
			"summary.".MDATA_KEY_CREATOR
		);
		
		$mainSqlQuery = "";
		$paramMap = array();
		$start = $startDT->format("Y-m-d H:i:s");
		$end = $endDT->format("Y-m-d H:i:s");
		
		$paramMap["starts"] = $start;
		$paramMap["ends"] = $end;
		
		$template = $this->getConfiguredFileTemplate();
		$fields = $template["fields"];
		$required = $this->mandatoryFileFields();

		foreach ($fields as $index=>$field) {
			
			$key = $field["name"];
			
			if (in_array($field["name"], $required)) {
				continue;
			}

			$select[] = "summary.{$key}";
		}

		$fileSummaryTable = "((
			SELECT COUNT(history.file_id) as played, history.file_id as file_id
			FROM cc_playout_history AS history
			WHERE history.starts >= :starts AND history.starts < :ends
			AND history.file_id IS NOT NULL
			GROUP BY history.file_id
		) AS playout
		LEFT JOIN cc_files AS file ON (file.id = playout.file_id)) AS summary";

		$mainSqlQuery.=
		"SELECT ".join(", ", $select).
		" FROM {$fileSummaryTable}";
		
		//-------------------------------------------------------------------------
		//need to count the total rows to tell Datatables.
		$stmt = $this->con->prepare($mainSqlQuery);
		foreach ($paramMap as $param => $v) {
			$stmt->bindValue($param, $v);
		}
		
		if ($stmt->execute()) {
			$totalRows = $stmt->rowCount();
		}
		else {
			$msg = implode(',', $stmt->errorInfo());
			throw new Exception("Error: $msg");
		}
		
		//------------------------------------------------------------------------
		//Using Datatables parameters to sort the data.
		
		$numOrderColumns = $opts["iSortingCols"];
		$orderBys = array();
		
		for ($i = 0; $i < $numOrderColumns; $i++) {
				
			$colNum = $opts["iSortCol_".$i];
			$key = $opts["mDataProp_".$colNum];
			$sortDir = $opts["sSortDir_".$i];
				
			$orderBys[] = "summary.{$key} {$sortDir}";
		}
		
		if ($numOrderColumns > 0) {
				
			$orders = join(", ", $orderBys);
				
			$mainSqlQuery.=
			" ORDER BY {$orders}";
		}
		
		//------------------------------------------------------------
		//using datatables params to add limits/offsets
		$displayLength = intval($opts["iDisplayLength"]);
		if ($displayLength !== -1) {
			$mainSqlQuery.=
			" OFFSET :offset LIMIT :limit";
				
			$paramMap["offset"] = $opts["iDisplayStart"];
			$paramMap["limit"] = $displayLength;
		}
			
		$stmt = $this->con->prepare($mainSqlQuery);
		foreach ($paramMap as $param => $v) {
			$stmt->bindValue($param, $v);
		}
		
		$rows = array();
		if ($stmt->execute()) {
			$rows = $stmt->fetchAll(PDO::FETCH_ASSOC);
		}
		else {
			$msg = implode(',', $stmt->errorInfo());
			throw new Exception("Error: $msg");
		}
		
		//-----------------------------------------------------------------
		//processing the results
		foreach ($rows as &$row) {
			$formatter = new LengthFormatter($row['length']);
			$row['length'] = $formatter->format();
		}

		return array(
			"sEcho" => intval($opts["sEcho"]),
			//"iTotalDisplayRecords" => intval($totalDisplayRows),
			"iTotalDisplayRecords" => intval($totalRows),
			"iTotalRecords" => intval($totalRows),
			"history" => $rows
		);
	}

	public function insertPlayedItem($schedId) {

		$this->con->beginTransaction();

		try {

			$item = CcScheduleQuery::create()->findPK($schedId, $this->con);

			//TODO figure out how to combine these all into 1 query.
			$showInstance = $item->getCcShowInstances($this->con);
			$show = $showInstance->getCcShow($this->con);

			$fileId = $item->getDbFileId();

			//don't add webstreams
			if (isset($fileId)) {

				$metadata = array();
				$metadata["showname"] = $show->getDbName();

				$history = new CcPlayoutHistory();
				$history->setDbFileId($fileId);
				$history->setDbStarts($item->getDbStarts(null));
				$history->setDbEnds($item->getDbEnds(null));

				foreach ($metadata as $key => $val) {
					$meta = new CcPlayoutHistoryMetaData();
					$meta->setDbKey($key);
					$meta->setDbValue($val);

					$history->addCcPlayoutHistoryMetaData($meta);
				}

				$history->save($this->con);
			}

			$this->con->commit();
		}
		catch (Exception $e) {
			$this->con->rollback();
			throw $e;
		}
	}

	/* id is an id in cc_playout_history */
	public function makeHistoryItemForm($id, $populate=false) {

		try {
			$form = new Application_Form_EditHistoryItem();
			$template = $this->getConfiguredItemTemplate();
			$required = $this->mandatoryItemFields();
			$form->createFromTemplate($template["fields"], $required);

			if ($populate) {
				$formValues = array();
				
				$historyRecord = CcPlayoutHistoryQuery::create()->findPk($id, $this->con);
				$file = $historyRecord->getCcFiles();
				
				if (isset($file)) {
					$f = Application_Model_StoredFile::createWithFile($file, $this->con);
					$filemd = $f->getDbColMetadata();
				}
				$metadata = array();
				$mds = $historyRecord->getCcPlayoutHistoryMetaDatas();
				foreach ($mds as $md) {
					$metadata[$md->getDbKey()] = $md->getDbValue();
				}
				
				$prefix = Application_Form_EditHistoryItem::ID_PREFIX;
				$formValues["{$prefix}id"] = $id;
				
				foreach($template["fields"] as $index => $field) {
					
					$key = $field["name"];
					
					if (in_array($key, $required)) {
						
						$method = "getDb".ucfirst($key);
						$value = $historyRecord->$method();
					}
					else if (isset($filemd) && $field["isFileMd"]) {
						
						$value = $filemd[$key];
					}
					else if (isset($metadata[$key])) {
						$value = $metadata[$key];
					}
					
					//need to convert to the station's local time first.
					if ($field["type"] == TEMPLATE_DATETIME) {
						$timezoneUTC = new DateTimeZone("UTC");
						$timezoneLocal = new DateTimeZone($this->timezone);
						
						$dateTime = new DateTime($value, $timezoneUTC);
						$dateTime->setTimezone($timezoneLocal);
						$value = $dateTime->format("Y-m-d H:i:s");
					}
					
					$formValues["$prefix{$key}"] = $value;
				}
				
				$form->populate($formValues);
			}
			
			return $form;
		}
		catch (Exception $e) {
			Logging::info($e);
			throw $e;
		}
	}

	/* id is an id in cc_files */
	public function makeHistoryFileForm($id) {

	    try {
		    $form = new Application_Form_EditHistoryFile();

		    $file = Application_Model_StoredFile::RecallById($id, $this->con);
		    $md = $file->getDbColMetadata();

		    $form->populate(array(
		        'his_file_id' => $id,
		        'his_file_title' => $md[MDATA_KEY_TITLE],
		        'his_file_creator' => $md[MDATA_KEY_CREATOR],
		        'his_file_composer' => $md[MDATA_KEY_COMPOSER],
		        'his_file_copyright' => $md[MDATA_KEY_COPYRIGHT]
		    ));

		    return $form;
	    }
	    catch (Exception $e) {
	        Logging::info($e);
	        throw $e;
	    }
	}

	public function populateTemplateItem($values, $id=null) {

		$this->con->beginTransaction();

		try {
		    $template = $this->getConfiguredItemTemplate();
		    $prefix = Application_Form_EditHistoryItem::ID_PREFIX;
		    
		    if (isset($id)) {
		    	$historyRecord = CcPlayoutHistoryQuery::create()->findPk($id, $this->con);
		    }
		    else {
		    	$historyRecord = new CcPlayoutHistory();
		    }
		    
		    $timezoneUTC = new DateTimeZone("UTC");
		    $timezoneLocal = new DateTimeZone($this->timezone);

	    	$dateTime = new DateTime($values[$prefix."starts"], $timezoneLocal);
	    	$dateTime->setTimezone($timezoneUTC);
	    	$historyRecord->setDbStarts($dateTime->format("Y-m-d H:i:s"));

	    	$dateTime = new DateTime($values[$prefix."ends"], $timezoneLocal);
	    	$dateTime->setTimezone($timezoneUTC);
	    	$historyRecord->setDbEnds($dateTime->format("Y-m-d H:i:s"));

	    	$templateValues = $values[$prefix."template"];

	    	$file = $historyRecord->getCcFiles();

	    	$md = array();
	    	$metadata = array();
	    	$fields = $template["fields"];
	    	$required = $this->mandatoryItemFields();

	    	for ($i = 0, $len = count($fields); $i < $len; $i++) {
	    		
	    	    $field = $fields[$i];
	    	    $key = $field["name"];
	    	    
	    	    //required is delt with before this loop.
	    	    if (in_array($key, $required)) {
	    	    	continue;
	    	    }
	    	    
	    	    $isFileMd = $field["isFileMd"];
	    	    $entry = $templateValues[$prefix.$key];
	    	    
	    	    if ($isFileMd && isset($file)) {
	    	        Logging::info("adding metadata associated to a file for {$key}");
	    	        $md[$key] = $entry;
	    	    }
	    	    else {
	    	    	Logging::info("adding metadata for {$key}");
                    $metadata[$key] = $entry;
	    	    }
	    	}
	    	
	    	if (count($md) > 0) {
	    		$f = Application_Model_StoredFile::createWithFile($file, $this->con);
	    		$f->setDbColMetadata($md);
	    	}

	    	//Use this array to update existing values.
	    	$mds = $historyRecord->getCcPlayoutHistoryMetaDatas();
	    	foreach ($mds as $md) {
	    		$prevmd[$md->getDbKey()] = $md;
	    	}
	    	foreach ($metadata as $key => $val) {

	    		if (isset($prevmd[$key])) {
	    			$meta = $prevmd[$key];
	    			$meta->setDbValue($val);
	    		}
	    		else {
	    			$meta = new CcPlayoutHistoryMetaData();
	    			$meta->setDbKey($key);
	    			$meta->setDbValue($val);
	    			
	    			$historyRecord->addCcPlayoutHistoryMetaData($meta);
	    		}	
	    	}

	    	$historyRecord->save($this->con);
	    	$this->con->commit();
    	}
    	catch (Exception $e) {
    		$this->con->rollback();
    		throw $e;
    	}

	}

	public function createPlayedItem($data) {

		try {
			$form = $this->makeHistoryItemForm(null);
			$history_id = $form->getElement("his_item_id");

	        if ($form->isValid($data)) {
	        	$history_id->setIgnore(true);
	        	$values = $form->getValues();

	        	Logging::info("created list item");
	        	Logging::info($values);

	        	$this->populateTemplateItem($values);
	        }
	        else {
	        	Logging::info("created list item NOT VALID");
	        	Logging::info($form->getMessages());
	        }
		}
		catch (Exception $e) {
			throw $e;
		}
	}

	/* id is an id in cc_playout_history */
	public function editPlayedItem($data) {

		try {
			$id = $data["his_item_id"];
			$form = $this->makeHistoryItemForm($id);
			$history_id = $form->getElement("his_item_id");
			$history_id->setRequired(true);

			if ($form->isValid($data)) {
			    $history_id->setIgnore(true);
	        	$values = $form->getValues();

	        	Logging::info("edited list item");
	        	Logging::info($values);
	        	
	        	$this->populateTemplateItem($values, $id);
	        }
	        else {
	        	Logging::info("edited list item NOT VALID");
	        }

	        Logging::info($form->getMessages());
		}
		catch (Exception $e) {
			Logging::info($e);
		}
	}

	/* id is an id in cc_files */
	public function editPlayedFile($data) {

		$this->con->beginTransaction();

		try {
	        $form = new Application_Form_EditHistoryFile();

	        $json = $form->processAjax($data);
	        Logging::info($json);

	        if ($form->isValid($data)) {

	            $id = $data["his_file_id"];
	            $file = Application_Model_StoredFile::RecallById($id, $this->con);

	            $md = array(
	                MDATA_KEY_TITLE => $data['his_file_title'],
	                MDATA_KEY_CREATOR => $data['his_file_creator'],
	                MDATA_KEY_COMPOSER => $data['his_file_composer'],
	                MDATA_KEY_COPYRIGHT => $data['his_file_copyright']
	            );

	            $file->setDbColMetadata($md);
	        }

	        $this->con->commit();
		}
		catch (Exception $e) {
			$this->con->rollback();
			Logging::info($e);
			throw $e;
		}

        return $json;
	}

	/* id is an id in cc_playout_history */
	public function deletePlayedItem($id) {

		$this->con->beginTransaction();

		try {

			$record = CcPlayoutHistoryQuery::create()->findPk($id, $this->con);
			$record->delete($this->con);

			$this->con->commit();
		}
		catch (Exception $e) {
			$this->con->rollback();
			Logging::info($e);
			throw $e;
		}
	}


	//---------------- Following code is for History Templates --------------------------//

	public function getFieldTypes() {

	    $fields = array(
    	    TEMPLATE_DATE,
    	    TEMPLATE_TIME,
    	    TEMPLATE_DATETIME,
    	    TEMPLATE_STRING,
    	    TEMPLATE_BOOLEAN,
    	    TEMPLATE_INT,
    	    TEMPLATE_FLOAT,
	    );

	    return $fields;
	}
	
	private function getSqlTypes() {
	
		$fields = array(
			TEMPLATE_DATE => "date",
			TEMPLATE_TIME => "time",
			TEMPLATE_DATETIME => "datetime",
			TEMPLATE_STRING => "text",
			TEMPLATE_BOOLEAN => "boolean",
			TEMPLATE_INT => "integer",
			TEMPLATE_FLOAT => "float",
		);
	
		return $fields;
	}
	
	public function getFileMetadataTypes() {
		
		$fileMD = array(
			array("name"=> MDATA_KEY_TITLE, "type"=> TEMPLATE_STRING, "sql"),
			array("name"=> MDATA_KEY_CREATOR, "type"=> TEMPLATE_STRING),
			array("name"=> MDATA_KEY_SOURCE, "type"=> TEMPLATE_STRING),
			array("name"=> MDATA_KEY_DURATION, "type"=> TEMPLATE_STRING),
			array("name"=> MDATA_KEY_GENRE, "type"=> TEMPLATE_STRING),
			array("name"=> MDATA_KEY_MOOD, "type"=> TEMPLATE_STRING),
			array("name"=> MDATA_KEY_LABEL, "type"=> TEMPLATE_STRING),
			array("name"=> MDATA_KEY_COMPOSER, "type"=> TEMPLATE_STRING),
			array("name"=> MDATA_KEY_ISRC, "type"=> TEMPLATE_STRING),
			array("name"=> MDATA_KEY_COPYRIGHT, "type"=> TEMPLATE_STRING),
			array("name"=> MDATA_KEY_YEAR, "type"=> TEMPLATE_INT),
			array("name"=> MDATA_KEY_TRACKNUMBER, "type"=> TEMPLATE_INT),
			array("name"=> MDATA_KEY_CONDUCTOR, "type"=> TEMPLATE_STRING),
			array("name"=> MDATA_KEY_LANGUAGE, "type"=> TEMPLATE_STRING),
		);
		
		return $fileMD;
	}

	public function mandatoryItemFields() {

	    $fields = array("starts", "ends");

	    return $fields;
	}
	
	public function mandatoryFileFields() {
	
		$fields = array("played", MDATA_KEY_TITLE, MDATA_KEY_CREATOR);
	
		return $fields;
	}

	private function defaultItemTemplate() {

		$template = array();
		$fields = array();

		$fields[] = array("name" => "starts", "type" => TEMPLATE_DATETIME, "isFileMd" => false);
		$fields[] = array("name" => "ends", "type" => TEMPLATE_DATETIME, "isFileMd" => false);
		$fields[] = array("name" => MDATA_KEY_TITLE, "type" => TEMPLATE_STRING, "isFileMd" => true); //these fields can be populated from an associated file.
		$fields[] = array("name" => MDATA_KEY_CREATOR, "type" => TEMPLATE_STRING, "isFileMd" => true);

		$template["name"] = "Log Sheet ".date("Y-m-d H:i:s")." Template";
		$template["fields"] = $fields;
		
		return $template;
	}
	
	/*
	 * Default File Summary Template. Taken from The Czech radio requirements (customer requested this in the past).
	 */
	private function defaultFileTemplate() {
	
		$template = array();
		$fields = array();
	
		$fields[] = array("name" => MDATA_KEY_TITLE, "type" => TEMPLATE_STRING, "isFileMd" => true);
		$fields[] = array("name" => MDATA_KEY_CREATOR, "type" => TEMPLATE_STRING, "isFileMd" => true);
		$fields[] = array("name" => "played", "type" => TEMPLATE_INT, "isFileMd" => false);
		$fields[] = array("name" => MDATA_KEY_DURATION, "type" => TEMPLATE_STRING, "isFileMd" => true);
		$fields[] = array("name" => MDATA_KEY_COMPOSER, "type" => TEMPLATE_STRING, "isFileMd" => true);
		$fields[] = array("name" => MDATA_KEY_COPYRIGHT, "type" => TEMPLATE_STRING, "isFileMd" => true);
	
		$template["name"] = "File Summary ".date("Y-m-d H:i:s")." Template";
		$template["fields"] = $fields;
	
		return $template;
	}
	
	public function loadTemplate($id) {

		try {
			
			if (!is_numeric($id)) {
				throw new Exception("Error: $id is not numeric.");
			}
			
			$template = CcPlayoutHistoryTemplateQuery::create()->findPk($id, $this->con);
			
			if (empty($template)) {
				throw new Exception("Error: Template $id does not exist.");
			}
			
			$c = new Criteria();
			$c->addAscendingOrderByColumn(CcPlayoutHistoryTemplateFieldPeer::POSITION);
			$config = $template->getCcPlayoutHistoryTemplateFields($c, $this->con);
			$fields = array();
			
			foreach ($config as $item) {
				
				$fields[] = array(
					"name" => $item->getDbName(), 
					"type" => $item->getDbType(),
					"isFileMd" => $item->getDbIsFileMD(),
					"id" => $item->getDbId()
				);
			}
			
			$data = array();
			$data["id"] = $template->getDbId();
			$data["name"] = $template->getDbName();
			$data["fields"] = $fields;
			$data["type"] = $template->getDbType();
			
			return $data;
		}
		catch (Exception $e) {
			throw $e;
		}
	}

	public function getItemTemplate($id) {

		if (is_numeric($id)) {
			Logging::info("template id is: $id");
			$template = $this->loadTemplate($id);
		}
		else {
			Logging::info("Using default template");
			$template = $this->defaultItemTemplate();
		}

		return $template;
	}
	
	public function getTemplates($type) {
		
		$list = array();
		
		try {
			
			$query =  CcPlayoutHistoryTemplateQuery::create()
				->setFormatter(ModelCriteria::FORMAT_ON_DEMAND);
			
			if (isset($type)) {
				$templates = $query->findByDbType($type);
			}
			else {
				$templates = $query->find();
			}
			
			foreach ($templates as $template) {
				$list[$template->getDbId()] = $template->getDbName();
			}
			
			return $list;
		}
		catch (Exception $e) {
			throw $e;
		}
	}
	
	public function getListItemTemplates() {
		return $this->getTemplates(self::TEMPLATE_TYPE_ITEM);
	}
	
	public function getFileTemplates() {
		return $this->getTemplates(self::TEMPLATE_TYPE_FILE);
	}
	
	private function datatablesColumns($template) {
		
		$columns = array();
			
		foreach ($template["fields"] as $index=>$field) {
		
			$key = $field["name"];
		
			$columns[] = array(
				"sTitle"=> $key,
				"mDataProp"=> $key,
				"sClass"=> "his_{$key}"
			);
		}
			
		return $columns;
	}
	
	public function getDatatablesLogSheetColumns() {
		
		try {
			$template = $this->getConfiguredItemTemplate();	
			return $this->datatablesColumns($template);
		}
		catch (Exception $e) {
			throw $e;
		}
	}
	
	public function getDatatablesFileSummaryColumns() {
	
		try {
			$template = $this->getConfiguredFileTemplate();
			return $this->datatablesColumns($template);
		}
		catch (Exception $e) {
			throw $e;
		}
	}
	
	public function getConfiguredItemTemplate() {
		
		try {
			$id = Application_Model_Preference::GetHistoryItemTemplate();
			
			if (is_numeric($id)) {
				$template = $this->loadTemplate($id);
			}
			else {
				$template = $this->defaultItemTemplate();
			}
			return $template;
		}
		catch (Exception $e) {
			throw $e;
		}
	}
	
	public function setConfiguredItemTemplate($id) {
		try {
			Application_Model_Preference::SetHistoryItemTemplate($id);
		}
		catch (Exception $e) {
			throw $e;
		}
	}
	
	public function getConfiguredFileTemplate() {
	
		try {
			$id = Application_Model_Preference::GetHistoryFileTemplate();
				
			if (is_numeric($id)) {
				$template = $this->loadTemplate($id);
			}
			else {
				$template = $this->defaultFileTemplate();
			}
			return $template;
		}
		catch (Exception $e) {
			throw $e;
		}
	}
	
	public function setConfiguredFileTemplate($id) {
		try {
			Application_Model_Preference::SetHistoryFileTemplate($id);
		}
		catch (Exception $e) {
			throw $e;
		}
	}
	
	public function setConfiguredTemplate($id) {
		try {
			
			$template = $this->loadTemplate($id);
			$type = $template["type"];
			
			$setTemplate = "setConfigured".ucfirst($type)."Template";
			
			$this->$setTemplate($id);
		}
		catch (Exception $e) {
			throw $e;
		}
	}
	
	public function getConfiguredTemplateIds() {
		
		try {
			$id = Application_Model_Preference::GetHistoryItemTemplate();
			$id2 = Application_Model_Preference::GetHistoryFileTemplate();
			
			$configured = array();
			
			if (is_numeric($id)) {
				$configured[] = $id;
			}
			
			if (is_numeric($id2)) {
				$configured[] = $id2;
			}
			
			return $configured;
		}
		catch (Exception $e) {
			throw $e;
		}
	}
	
	public function createTemplate($config) {
		
		$this->con->beginTransaction();
		
		try {
			
			$type = $config["type"];
			
			$method = "default".ucfirst($type)."Template";
			$default = $this->$method();
			
			$name = isset($config["name"]) ? $config["name"] : $default["name"];
			$fields = isset($config["fields"]) ? $config["fields"] : $default["fields"];
			
			$doSetDefault = isset($config['setDefault']) ? $config['setDefault'] : false;
		
			$template = new CcPlayoutHistoryTemplate();
			$template->setDbName($name);
			$template->setDbType($type);

			foreach ($fields as $index=>$field) {
				
				$isMd = ($field["isFileMd"] == 'true') ? true : false;
				
				$templateField = new CcPlayoutHistoryTemplateField();
				$templateField->setDbName($field["name"]);
				$templateField->setDbType($field["type"]);
				$templateField->setDbIsFileMD($isMd);
				$templateField->setDbPosition($index);
				
				$template->addCcPlayoutHistoryTemplateField($templateField);
			}
			
			$template->save($this->con);
						
			if ($doSetDefault) {
				$this->setConfiguredItemTemplate($template->getDbid());
			}
			
			$this->con->commit();
			
			return $template->getDbid();
		}
		catch (Exception $e) {
			$this->con->rollback();
			throw $e;
		}		
	}
	
	public function updateItemTemplate($id, $name, $fields, $doSetDefault=false) {
	
		$this->con->beginTransaction();
	
		try {
				
			$template = CcPlayoutHistoryTemplateQuery::create()->findPk($id, $this->con);
			$template->setDbName($name);
			
			if (count($fields) === 0) {
				$t = $this->defaultItemTemplate();
				$fields = $t["fields"]; 
			}
			
			$template->getCcPlayoutHistoryTemplateFields()->delete($this->con);
			
			foreach ($fields as $index=>$field) {
	
				$isMd = ($field["isFileMd"] == 'true') ? true : false;
	
				$templateField = new CcPlayoutHistoryTemplateField();
				$templateField->setDbName($field["name"]);
				$templateField->setDbType($field["type"]);
				$templateField->setDbIsFileMD($isMd);
				$templateField->setDbPosition($index);
	
				$template->addCcPlayoutHistoryTemplateField($templateField);
			}
				
			$template->save($this->con);
	
			if ($doSetDefault) {
				$this->setConfiguredItemTemplate($template->getDbid());
			}
				
			$this->con->commit();
		}
		catch (Exception $e) {
			$this->con->rollback();
			throw $e;
		}
	}
	
	public function deleteTemplate($id) {
		
		$this->con->beginTransaction();
		
		try {
			
			$template = CcPlayoutHistoryTemplateQuery::create()->findPk($id, $this->con);
			$template->delete($this->con);
			
		    $this->con->commit();
		}
		catch (Exception $e) {
			$this->con->rollback();
			throw $e;
		}
	}
}