LogableBehavior

This behavior is created to easily let you (the developer) log users activities that relates to database modifications (ie, add, edit and delete). If you just want to see what your users are doing or need to be able to say “That is not a bug, I can see from my log that you deleted the post yesterday.” and don’t want to spend more time that it takes to do “var $actsAs = array(‘Logable’);” then this behavior is for you.

What

The intent of this behavior is to create a row in a log table every time a model’s data (or all the model that the behavior is applied to) is created, edited or deleted. The PHP developer can set this log table up to include as much detail as is required, and that is all the configuration that is needed.

How
Requirements:

1. The behavior found below in this Article.
2. A Log model( empty but for a order variable [created DESC]
3. actsAs = array(“Logable”); on models that should be logged:
4. A “logs” table with these fields required :

• id (int)
• title (string) automagically filled with the display field of the model that was modified.
• created (date/datetime) filled by cake in normal way

Supply configuration to the Model Class. Below is the Example:

<?php
class Apple extends AppModel {
var $name = 'Apple';
var $actsAs = array('Logable' => array(
'userModel' => 'User',
'userKey' => 'user_id',
'change' => 'list', // options are 'list' or 'full'
'description_ids' => TRUE // options are TRUE or FALSE
));
[..]
?>


The change fields modifies what will be automagic filled in the change field if the log table has it.

Usage

If you are using the user feature of the behavior, the models needs to know the id of the active user. This is most easily set in app controller in this way, but note that you may use the Logable::setUserData() method manually should you so desire.
Controller Class:


<?php
// In AppController (or single controller if only needed once) add these lines to beforeFilter :
if (sizeof($this->uses) && $this->{$this->modelClass}->Behaviors->attached('Logable')) {
$this->{$this->modelClass}->setUserData($this->activeUser);
}
?>

Where “$activeUser” should be an array in the standard format for the User model used.

Get the logs out

To extract the logs, no matter of you want all events, or just for one model or one user, or even one user’s activity on one model, you can ask any model that the behavior is enabled on. There are two methods:

• findLog($params)
• findUserActions($user_id, $params)

You can off course query the Log model in the normal way.

findLog

This is the main function for retrieving the logged activities. It will by default (when called with no parameters) return all activities for the model it is called from, but it can also be used for any or all models from any model. The available options are listed bellow.

• model (string)
• action (string) (add/edit/delte) defaults to NULL (ie. all)
• fields (array)
• order (string) defaults to ‘created DESC’
• conditions (array) add custom conditions
• model_id (int) ForeignKey for a single instance of logged model
• user_id (int) defaults to NULL (all users).

Remember to user your own foreignKey if you did not use ‘user_id’


<?php // examples
// All acitivities on current model
$data = $this->Apple->findLog();
// All acitivities on current model instance
$data = $this->Apple->findLog('model_id'=>32);
// I am in apple controller, but i want acitivities for the user on a specific Logo isntance
$data = $this->Apple->findLog(array('user_id'=>66,'model'=>'Logo','model_id'=>123));
?>

findUserActions

The first parameter is compulsory and is the ID of the user (foreignKey). The second is an array of options. The available options are listed bellow. Model and fields does the expected things, while events will create a description on the fly. This function is intended to be improved in the next version to be translatable / customizable.

• model (string)
• [li]events (boolean)
• [li]fields (array)


<?php // examples
// note we are asking for a different model
$data = $this->User->findUserActions(301,array('model' => 'BookTest'));
$data = $this->Apple->findUserActions(301,array('events' => true));
$data = $this->Model->findUserActions(301,array('fields' => array('id','model'),'model' => 'BookTest');
?>

You can download the newest version, including tests, here :

http://code.google.com/p/alkemann/downloads/list
Or you can grab version 1.3 here

Behavior Class:


<?php
class LogableBehavior extends ModelBehavior
{
var $user = NULL;
var $UserModel = FALSE;
function setup(&$Model, $config = null) {
$this->settings = array(
'userModel' => 'User',
'userKey' => 'user_id',
'change' => 'list',
'description_ids' => TRUE
);
if ($config) {
$this->settings = array_merge($this->settings, $config);
}

App::import(‘model’,’Log’);
$this->Log = new Log();
if ($this->settings[‘userModel’] != $Model->alias) {
if (App::import(‘model’,$this->settings[‘userModel’])) {
$this->UserModel = new $this->settings[‘userModel’]();
}
} else {
$this->UserModel = $Model;
}

}

function settings(&$Model) {
return $this->settings;
}

function findLog(&$Model, $params = array()) {
$defaults = array(
‘model’ => NULL,
‘action’ => NULL,
‘order’ => ‘created DESC’,
$this->settings[‘userKey’] => NULL,
‘conditions’ => array(),
‘model_id’ => NULL,
‘fields’ => array(),
);
$params = array_merge($defaults, $params);
$options = array(‘order’ => $params[‘order’], ‘conditions’ => $params[‘conditions’], ‘fields’ => $params[‘fields’]);
if ($params[‘model’] === NULL) {
$params[‘model’] = $Model->alias;
}
if ($params[‘model’]) {
if (isset($this->Log->_schema[‘model’])) {
$options[‘conditions’][‘model’] = $params[‘model’];
} elseif (isset($this->Log->_schema[‘description’])) {
$options[‘conditions’][‘description LIKE ‘] = $params[‘model’].’%’;
} else {
return FALSE;
}
}
if ($params[‘action’] && isset($this->Log->_schema[‘action’])) {
$options[‘conditions’][‘action’] = $params[‘action’];
}
if ($params[ $this->settings[‘userKey’] ] && $this->UserModel && is_numeric($params[ $this->settings[‘userKey’] ])) {
$options[‘conditions’][$this->settings[‘userKey’]] = $params[ $this->settings[‘userKey’] ];
}
if ($params[‘model_id’] && is_numeric($params[‘model_id’])) {
$options[‘conditions’][‘model_id’] = $params[‘model_id’];
}
return $this->Log->find(‘all’,$options);
}

function findUserActions(&$Model, $user_id, $params = array()) {
if (!$this->UserModel) {
return NULL;
}
// if logged in user is asking for her own log, use the data we allready have
if ( isset($this->user)
&& isset($this->user[$this->UserModel->alias][$this->UserModel->primaryKey])
&& $user_id == $this->user[$this->UserModel->alias][$this->UserModel->primaryKey]
&& isset($this->user[$this->UserModel->alias][$this->UserModel->displayField]) ) {
$username = $this->user[$this->UserModel->alias][$this->UserModel->displayField];
} else {
$this->UserModel->recursive = -1;
$user = $this->UserModel->find(array($this->UserModel->primaryKey => $user_id));
$username = $user[$this->UserModel->alias][$this->UserModel->displayField];
}
$fields = array();
if (isset($params[‘fields’])) {
if (is_array($params[‘fields’])) {
$fields = $params[‘fields’];
} else {
$fields = array($params[‘fields’]);
}
}
$conditions = array($this->settings[‘userKey’] => $user_id);
if (isset($params[‘model’])) {
$conditions[‘model’] = $params[‘model’];
}
$data = $this->Log->find(‘all’, array(
‘conditions’ => $conditions,
‘recursive’ => -1,
‘fields’ => $fields
));
if (! isset($params[‘events’]) || (isset($params[‘events’]) && $params[‘events’] == false)) {
return $data;
}
$result = array();
foreach ($data as $key => $row) {$one = $row[‘Log’];
$result[$key][‘Log’][‘id’] = $one[‘id’];
$result[$key][‘Log’][‘event’] = $username;
// have all the detail models and change as list :
if (isset($one[‘model’]) && isset($one[‘action’]) && isset($one[‘change’]) && isset($one[‘model_id’])) {
if ($one[‘action’] == ‘edit’) {
$result[$key][‘Log’][‘event’] .= ‘ edited ‘.$one[‘change’].’ of ‘.low($one[‘model’]).'(id ‘.$one[‘model_id’].’)’;
// ‘ at ‘.$one[‘created’];
} elseif ($one[‘action’] == ‘add’) {
$result[$key][‘Log’][‘event’] .= ‘ added a ‘.low($one[‘model’]).'(id ‘.$one[‘model_id’].’)’;
} elseif ($one[‘action’] == ‘delete’) {
$result[$key][‘Log’][‘event’] .= ‘ deleted the ‘.low($one[‘model’]).'(id ‘.$one[‘model_id’].’)’;
}

} elseif ( isset($one[‘model’]) && isset($one[‘action’]) && isset($one[‘model_id’]) ) { // have model,model_id and action
if ($one[‘action’] == ‘edit’) {
$result[$key][‘Log’][‘event’] .= ‘ edited ‘.low($one[‘model’]).'(id ‘.$one[‘model_id’].’)’;
// ‘ at ‘.$one[‘created’];
} elseif ($one[‘action’] == ‘add’) {
$result[$key][‘Log’][‘event’] .= ‘ added a ‘.low($one[‘model’]).'(id ‘.$one[‘model_id’].’)’;
} elseif ($one[‘action’] == ‘delete’) {
$result[$key][‘Log’][‘event’] .= ‘ deleted the ‘.low($one[‘model’]).'(id ‘.$one[‘model_id’].’)’;
}
} else { // only description field exist
$result[$key][‘Log’][‘event’] = $one[‘description’];
}

}
return $result;
}

function setUserData(&$Model, $userData = null) {
if ($userData) {
$this->user = $userData;
}
}

function clearUserData(&$Model) {
$this->user = NULL;
}

function beforeDelete(&$Model) {
$Model->recursive = -1;
$Model->read();
}

function afterDelete(&$Model) {
$logData = array();
if (isset($this->Log->_schema[‘description’])) {
$logData[‘Log’][‘description’] = $Model->alias;
if (isset($Model->data[$Model->alias][$Model->displayField]) && $Model->displayField != $Model->primaryKey) {
$logData[‘Log’][‘description’] .= ‘ “‘.$Model->data[$Model->alias][$Model->displayField].'”‘;
}
if ($this->settings[‘description_ids’]) {
$logData[‘Log’][‘description’] .= ‘ (‘.$Model->id.’) ‘;
}
$logData[‘Log’][‘description’] .= __(‘deleted’,TRUE);
}
$logData[‘Log’][‘action’] = ‘delete’;
$this->_saveLog($Model, $logData);
}

function beforeSave(&$Model) {
if (isset($this->Log->_schema[‘change’]) && $Model->id) {
$Model->recursive = -1;
$this->old = $Model->find(array($Model->primaryKey => $Model->id));
}
}

function afterSave(&$Model,$created) {
if ($Model->id) {
$id = $Model->id;
} elseif ($Model->insertId) {
$id = $Model->insertId;
}
if (isset($this->Log->_schema[‘model_id’])) {
$logData[‘Log’][‘model_id’] = $id;
}
if (isset($this->Log->_schema[‘description’])) {
$logData[‘Log’][‘description’] = $Model->alias;
if (isset($Model->data[$Model->alias][$Model->displayField]) && $Model->displayField != $Model->primaryKey) {
$logData[‘Log’][‘description’] .= ‘ “‘.$Model->data[$Model->alias][$Model->displayField].'”‘;
}

if ($this->settings[‘description_ids’]) {
$logData[‘Log’][‘description’] .= ‘ (‘.$id.’) ‘;
}

if ($created) {
$logData[‘Log’][‘description’] .= __(‘added’,TRUE);
} else {
$logData[‘Log’][‘description’] .= __(‘updated’,TRUE);
}
}
if (isset($this->Log->_schema[‘action’])) {
if ($created) {
$logData[‘Log’][‘action’] = ‘add’;
} else {
$logData[‘Log’][‘action’] = ‘edit’;
}

}

if (isset($this->Log->_schema[‘change’])) {
$logData[‘Log’][‘change’] = ”;
foreach ($Model->data[$Model->alias] as $key => $value) {
if (isset($Model->data[$Model->alias][$Model->primaryKey]) && !empty($this->old)) {
$old = $this->old[$Model->alias][$key];
} else {
$old = ”;
}
if ($key != ‘modified’ && $value != $old) {
if ($this->settings[‘change’] == ‘full’) {
$logData[‘Log’][‘change’] .= $key . ‘ (‘.$old.’) => (‘.$value.’), ‘;
} else {
$logData[‘Log’][‘change’] .= $key . ‘, ‘;
}
}
}
if (strlen($logData[‘Log’][‘change’])) {
$logData[‘Log’][‘change’] = substr($logData[‘Log’][‘change’],0,-2);
} else {
return true;
}
}
$this->_saveLog($Model, $logData);
}

function _saveLog(&$Model, $logData) {
if (isset($Model->data[$Model->alias][$Model->displayField]) && $Model->displayField != $Model->primaryKey) {
$logData[‘Log’][‘title’] = $Model->data[$Model->alias][$Model->displayField];
} else {
if ($Model->id) {
$id = $Model->id;
} elseif (isset($Model->data[$Model->alias][$Model->primaryKey])) {
$id = $Model->data[$Model->alias][$Model->primaryKey];
} else {
$id = ‘MISSING’;
}
$logData[‘Log’][‘title’] = $Model->alias.’ (‘.$id.’)’;
}

if (isset($this->Log->_schema[‘model’])) {
$logData[‘Log’][‘model’] = $Model->alias;
}

if (isset($this->Log->_schema[‘model_id’])) {
if ($Model->id) {
$logData[‘Log’][‘model_id’] = $Model->id;
} elseif ($Model->insertId) {
$logData[‘Log’][‘model_id’] = $Model->insertId;
}
}

if (!isset($this->Log->_schema[ ‘action’ ])) {
unset($logData[‘Log’][‘action’]);
}

if (isset($this->Log->_schema[ $this->settings[‘userKey’] ]) && $this->user) {
$logData[‘Log’][$this->settings[‘userKey’]] = $this->user[$this->UserModel->alias][$this->UserModel->primaryKey];
}

if (isset($this->Log->_schema[‘description’])) {
if ($this->user && $this->UserModel) {
$logData[‘Log’][‘description’] .= ‘ by ‘.$this->settings[‘userModel’].’ “‘.
$this->user[$this->UserModel->alias][$this->UserModel->displayField].'”‘;
if ($this->settings[‘description_ids’]) {
$logData[‘Log’][‘description’] .= ‘ (‘.$this->user[$this->UserModel->alias][$this->UserModel->primaryKey].’)’;
}

} else {
// UserModel is active, but the data hasnt been set. Assume system action.
$logData[‘Log’][‘description’] .= ‘ by System’;
}
$logData[‘Log’][‘description’] .= ‘.’;
}

$this->Log->create($logData);
$this->Log->save(NULL,FALSE);
}
}
?>
</code>

I hope this will help …. thank you…!