Projects / Osmosis

<?php
/* SVN FILE: $Id$ */
/**
 * Ósmosis LMS: <http://www.osmosislms.org/>
 * Copyright 2008, Ósmosis LMS
 *
 * This file is part of Ósmosis LMS.
 * Ósmosis LMS is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Ósmosis LMS is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Ósmosis LMS.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @filesource
 * @copyright		Copyright 2008, Ósmosis LMS
 * @link			http://www.osmosislms.org/
 * @package			org.osmosislms
 * @subpackage		org.osmosislms.app
 * @since			Version 2.0 
 * @version			$Revision$
 * @modifiedby		$LastChangedBy$
 * @lastmodified	$Date$
 * @license			http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License Version 3
 */
/**
 * This Model handles the logging of changes in other models.
 * @see LoggableBehavior
 */
class ModelLog extends AppModel {

	var $name = 'ModelLog';

	/**
	 * BelongsTo (1-N) relation descriptors
	 *
	 * @var array
	 **/
	var $belongsTo = array(
		// ModelLog BelongsTo Member (Member that executed the save action)
		'Member' => array(
			'className' => 'Member',
			'foreignKey' => 'member_id',
			'conditions' => '',
			'fields' => '',
			'order' => ''
		)
	);

	/**
	 * Override to support find('log') on this model
	 *
	 * @see Model::find 
	 * @see ModelLog::_findLog
	 */	
	function find($conditions = null, $fields = array(), $order = null, $recursive = null) {
		if (is_string($conditions) && $conditions == 'log') {
			return $this->_findLog($fields);
		} else {
			return parent::find($conditions,$fields,$order,$recursive);
		}
	}

	/**
	 * Returns the log of registered modifications 
	 *
	 * @param array $options 
	 * @return array Logs
	 */	
	function _findLog($options) {
		$limit = 50;
		if (isset($options['limit']))
			$limit = $options['limit'];
		$logs = $this->find('all',
			array(
				'conditions' => array(
					'time >' => strtotime("-1 weeks"),
					'model' => array_keys($options['models']),
					'course_id' => $options['course_id']
				),
				'limit' => $limit,
				'order' => 'created DESC'
			)
		);

		$results = $queried = array();
		foreach ($logs as $i => $log) {
			$modelLog = $log['ModelLog'];
			$modelName = $modelLog['model'];
			$entity_id = $modelLog['entity_id'];
			
			if (isset($queried[$modelName][$entity_id])) {
				if ($queried[$modelName][$entity_id] === false)
					continue;
				$data = $queried[$modelName][$entity_id];
			} else {
				$contain = array();
				if (isset($options['models'][$modelName]['contain'])) {
					$contain = $options['models'][$modelName]['contain'];
				}
				$data = $this->__getModelData($modelName, ${$modelName}, $options['plugin'], $entity_id, $contain, $options['models'][$modelName]['fields']);
				
				$queried[$modelName][$entity_id] = false;
				
				if (!$data) {
					continue;
				}
				
			}
			
			$log['ModelLog']['data'] = $data;
			if (isset($options['models'][$modelName]['order_by'])) {
				$entity_id = Set::extract($options['models'][$modelName]['order_by'] . '[:first]', $log['ModelLog']['data'] );
				$entity_id = $entity_id[0];
			}
			$results[$modelLog['course_id']][$modelName][$entity_id][] = $log;
		}
		return $results;
	}

	/**
	 * Gets the data of an entity from Model
	 *
	 * @param string $modelName 
	 * @param object $Model Model object of type $modelName
	 * @param string $plugin Plugin that provides the model
	 * @param string $id ID of the entity
	 * @param mixed $contain Related models to use in Model::contain (or false to set recursive to -1)
	 * @param array $fields field
	 * @return data of the model entity of false if not found
	 */
	function __getModelData($modelName, &$Model, $plugin, $id, $contain, $fields) {
		if (!$Model) {
			$Model = ClassRegistry::init($plugin.'.'.$modelName);
		}
		if ($contain) {
			$Model->contain($contain);
		} elseif ($contain === false) {
			$recursive = -1;
		}
		
		$conditions = array($modelName . '.id' => $id);
		$result = $Model->find('first',compact('conditions','fields','recursive'));
		return $result;
	}
}
?>