Skip to content

Commit

Permalink
Merge pull request #480 from danielgimeno/AuditlogEventsConfPage
Browse files Browse the repository at this point in the history 
New feature: configuration AuditLog config page + new log survey sett…
  • Loading branch information
@Aestu
Aestu committed Apr 19, 2016
2 parents bc83888 + 71b3dc0 commit a30bb11
Show file tree
Hide file tree
Showing 3 changed files with 194 additions and 28 deletions.
6 changes: 6 additions & 0 deletions application/controllers/admin/database.php
View file
Expand Up @@ -1233,6 +1233,12 @@ function index($sa = null)
$oSurvey->tokenlength = App()->request->getPost('tokenlength');
$oSurvey->adminemail = App()->request->getPost('adminemail');
$oSurvey->bounce_email = App()->request->getPost('bounce_email');

$event = new PluginEvent('newSurveySettings');
$event->set('newSurvey', $oSurvey);
$event->set('survey', $iSurveyID);
App()->getPluginManager()->dispatchEvent($event);

if ($oSurvey->save())
{
Yii::app()->setFlashMessage(gT("Survey settings were successfully saved."));
Expand Down
13 changes: 13 additions & 0 deletions application/controllers/admin/tokens.php
View file
Expand Up @@ -625,6 +625,12 @@ function editToken($iSurveyId)

foreach ($aData as $k => $v)
$token->$k = $v;

$beforeParticipantSave = new PluginEvent('beforeParticipantSave');
$beforeParticipantSave->set('model',$token );
$beforeParticipantSave->set('iSurveyID',$iSurveyId );
App()->getPluginManager()->dispatchEvent($beforeParticipantSave);

echo $token->update();
}
// if add it will insert a new row
Expand Down Expand Up @@ -902,6 +908,13 @@ function delete($iSurveyID)
self::_newtokentable($iSurveyID);
}

$token = Token::model($iSurveyID)->find('tid=' . $sTokenIDs);

$beforeParticipantDelete = new PluginEvent('beforeParticipantDelete');
$beforeParticipantDelete->set('model',$token );
$beforeParticipantDelete->set('iSurveyID',$iSurveyID );
App()->getPluginManager()->dispatchEvent($beforeParticipantDelete);

if (Permission::model()->hasSurveyPermission($iSurveyID, 'tokens', 'delete'))
{
$aTokenIds = explode(',', $sTokenIDs); //Make the tokenids string into an array
Expand Down
203 changes: 175 additions & 28 deletions plugins/AuditLog/AuditLog.php
View file
@@ -1,31 +1,93 @@
<?php
class AuditLog extends \ls\pluginmanager\PluginBase {

protected $storage = 'DbStorage';
protected $storage = 'DbStorage';
static protected $description = 'Core: Create an audit log of changes';
static protected $name = 'auditlog';



protected $settings = array(
'AuditLog_Log_UserSave' => array(
'type' => 'checkbox',
'label' => 'Log if a user was modified or created',
'default' => '1',
),
'AuditLog_Log_UserLogin' => array(
'type' => 'checkbox',
'label' => 'Log if a user is logged successfully',
'default' => '1',
),
'AuditLog_Log_UserLogout' => array(
'type' => 'checkbox',
'label' => 'Log if user has logout',
'default' => '1',
),
'AuditLog_Log_UserFailedLoginAttempt' => array(
'type' => 'checkbox',
'label' => 'Log if a user login has failed',
'default' => '1',
),
'AuditLog_Log_UserDelete' => array(
'type' => 'checkbox',
'label' => 'Log if a user was deleted',
'default' => '1',
),
'AuditLog_Log_ParticipantSave' => array(
'type' => 'checkbox',
'label' => 'Log if a participant was modified or created',
'default' => '1',
),
'AuditLog_Log_ParticipantDelete' => array(
'type' => 'checkbox',
'label' => 'Log if a participant was deleted',
'default' => '1',
),
'AuditLog_Log_UserPermissionsChanged' => array(
'type' => 'checkbox',
'label' => 'Log if a user permissions changes',
'default' => '1',
),
'AuditLog_Log_SurveySettings' => array(
'type' => 'checkbox',
'label' => 'Log if a user changes survey settings',
'default' => '1',
),
);


public function init() {
$this->subscribe('beforeSurveySettings');
$this->subscribe('newSurveySettings');
$this->subscribe('beforeActivate');
$this->subscribe('beforeUserSave');
$this->subscribe('beforeUserDelete');
$this->subscribe('beforePermissionSetSave');
$this->subscribe('beforeParticipantSave');
$this->subscribe('beforeParticipantDelete');
$this->subscribe('beforePermissionSetSave');
$this->subscribe('beforeParticipantSave');
$this->subscribe('beforeParticipantDelete');
$this->subscribe('beforeLogout');
$this->subscribe('afterSuccessfulLogin');
$this->subscribe('afterFailedLoginAttempt');
}

/**
* check for setting for a single operation event, login user, save or delete
* @return boolean
*/
private function checkSetting($settingName) {
$pluginsettings = $this->getPluginSettings(true);
// Logging will done if setted to true
return $pluginsettings[$settingName]['current'] == 1;
}


/**
* User logout to the audit log
* @return unknown_type
*/
public function beforeLogout()
{
if (!$this->checkSetting('AuditLog_Log_UserLogout')) {
return;
}
$oUser = $this->api->getCurrentUser();
if ($oUser != false)
{
Expand All @@ -45,6 +107,10 @@ public function beforeLogout()
*/
public function afterSuccessfulLogin()
{
if (!$this->checkSetting('AuditLog_Log_UserLogin')) {
return;
}

$iUserID=$this->api->getCurrentUser()->uid;
$oAutoLog = $this->api->newModel($this, 'log');
$oAutoLog->uid=$iUserID;
Expand All @@ -60,6 +126,9 @@ public function afterSuccessfulLogin()
*/
public function afterFailedLoginAttempt()
{
if (!$this->checkSetting('AuditLog_Log_UserFailedLoginAttempt')) {
return;
}
$event = $this->getEvent();
$identity = $event->get('identity');
$oAutoLog = $this->api->newModel($this, 'log');
Expand All @@ -75,6 +144,11 @@ public function afterFailedLoginAttempt()
*/
public function beforePermissionSetSave()
{

if (!$this->checkSetting('AuditLog_Log_UserPermissionsChanged')) {
return;
}

$event = $this->getEvent();
$aNewPermissions=$event->get('aNewPermissions');
$iSurveyID=$event->get('iSurveyID');
Expand All @@ -96,20 +170,45 @@ public function beforePermissionSetSave()
$oAutoLog->save();
}
}

/**
* Function catches if a participant was modified or created
* All data is saved - only the password hash is anonymized for security reasons
*/
public function beforeParticipantSave()
{

$event = $this->getEvent();
$iSurveyID=$event->get('iSurveyID');
if (!$this->checkSetting('AuditLog_Log_ParticipantSave') || !$this->get('auditing', 'Survey', $iSurveyID, false)) {
return;
}

$oNewParticipant=$this->getEvent()->get('model');
if ($oNewParticipant->isNewRecord)
{
return;
}
$oCurrentUser=$this->api->getCurrentUser();

if (is_null($oNewParticipant->participant_id)){ // Token not participant
$newValues=$oNewParticipant->getAttributes();

$oldvalues= $this->api->getToken($iSurveyID, $oNewParticipant->token)->getAttributes();
if (count(array_diff_assoc($newValues,$oldvalues))){
$oAutoLog = $this->api->newModel($this, 'log');
$oAutoLog->uid=$oCurrentUser->uid;
$oAutoLog->entity='token';
$oAutoLog->action='update';
$oAutoLog->entityid=$newValues['tid'];
$oAutoLog->oldvalues=json_encode(array_diff_assoc($oldvalues,$newValues));
$oAutoLog->newvalues=json_encode(array_diff_assoc($newValues,$oldvalues));
$oAutoLog->fields=implode(',',array_keys(array_diff_assoc($newValues,$oldvalues)));
$oAutoLog->save();
}
return;
}

$aOldValues=$this->api->getParticipant($oNewParticipant->participant_id)->getAttributes();
$aNewValues=$oNewParticipant->getAttributes();

Expand All @@ -125,14 +224,20 @@ public function beforeParticipantSave()
$oAutoLog->fields=implode(',',array_keys(array_diff_assoc($aNewValues,$aOldValues)));
$oAutoLog->save();
}
}
}

/**
* Function catches if a participant was modified or created
* All data is saved - only the password hash is anonymized for security reasons
*/
public function beforeParticipantDelete()
{
$event = $this->getEvent();
$iSurveyID=$event->get('iSurveyID');
if (!$this->checkSetting('AuditLog_Log_ParticipantDelete') || !$this->get('auditing', 'Survey', $iSurveyID, false)) {
return;
}

$oNewParticipant=$this->getEvent()->get('model');
$oCurrentUser=$this->api->getCurrentUser();

Expand All @@ -146,18 +251,23 @@ public function beforeParticipantDelete()
$oAutoLog->oldvalues=json_encode($aValues);
$oAutoLog->fields=implode(',',array_keys($aValues));
$oAutoLog->save();
}
}


/**
* Function catches if a user was modified or created
* All data is saved - only the password hash is anonymized for security reasons
*/
public function beforeUserSave()
{

if (!$this->checkSetting('AuditLog_Log_UserSave')) {
return;
}
$oUserData=$this->getEvent()->get('model');

$oCurrentUser=$this->api->getCurrentUser();

$aNewValues=$oUserData->getAttributes();
if (!isset($oUserData->uid))
{
Expand All @@ -167,11 +277,11 @@ public function beforeUserSave()
$aNewValues['password']='*MASKED*PASSWORD*';
}
else
{
{
$oOldUser=$this->api->getUser($oUserData->uid);
$sAction='update';
$aOldValues=$oOldUser->getAttributes();

// Postgres delivers bytea fields as streams
if (gettype($aOldValues['password'])=='resource')
{
Expand All @@ -182,9 +292,9 @@ public function beforeUserSave()
{
$aOldValues['password']='*MASKED*OLD*PASSWORD*';
$aNewValues['password']='*MASKED*NEW*PASSWORD*';
};
}
}

if (count(array_diff_assoc($aNewValues,$aOldValues)))
{
$oAutoLog = $this->api->newModel($this, 'log');
Expand All @@ -203,9 +313,17 @@ public function beforeUserSave()
$oAutoLog->save();
}
}


/**
* Function catches if a user was deleted
* All data is saved - only the password hash is anonymized for security reasons
*/
public function beforeUserDelete()
{
if (!$this->checkSetting('AuditLog_Log_UserDelete')) {
return;
}

$oUserData=$this->getEvent()->get('model');
$oCurrentUser=$this->api->getCurrentUser();
$oOldUser=$this->api->getUser($oUserData->uid);
Expand All @@ -224,8 +342,8 @@ public function beforeUserDelete()
}
}



public function beforeActivate()
{
if (!$this->api->tableExists($this, 'log'))
Expand All @@ -249,17 +367,19 @@ public function beforeActivate()
*/
public function beforeSurveySettings()
{
$pluginsettings = $this->getPluginSettings(true);

$event = $this->getEvent();
$event->set("surveysettings.{$this->id}", array(
'name' => get_class($this),
'settings' => array(
'auditing' => array(
'type' => 'select',
'options'=>array(0=>'No',
1=>'Yes'),
'default'=>0,
'tab'=>'notification', // @todo: Setting no used yet
'category'=>'Auditing for person-related data', // @todo: Setting no used yet
1=>'Yes'),
'default' => 1,
'tab' => 'notification', // @todo: Setting no used yet
'category' => 'Auditing for person-related data', // @todo: Setting no used yet
'label' => 'Audit log for this survey',
'current' => $this->get('auditing', 'Survey', $event->get('survey'))
)
Expand All @@ -270,10 +390,37 @@ public function beforeSurveySettings()
public function newSurveySettings()
{
$event = $this->getEvent();
foreach ($event->get('settings') as $name => $value)
{
$this->set($name, $value, 'Survey', $event->get('survey'));
$iSurveyID=$event->get('survey');
if (!is_null($event->get('settings'))){
foreach ($event->get('settings') as $name => $value)
{
$this->set($name, $value, 'Survey', $event->get('survey'));
}
}
}

if (!$this->checkSetting('AuditLog_Log_SurveySettings') || !$this->get('auditing', 'Survey', $iSurveyID, false)) {
return;
}

$oCurrentUser=$this->api->getCurrentUser();
$newSurvey=$event->get('newSurvey');
if (!is_null($newSurvey)) {
$newAttributes = $newSurvey->getAttributes();
$oldSurvey=Survey::model()->find('sid = :sid', array(':sid' => $iSurveyID));

$oldAttributes= $oldSurvey->getAttributes();
$diff = array_diff_assoc($newAttributes, $oldAttributes);
if (count($diff)>0){
$oAutoLog = $this->api->newModel($this, 'log');
$oAutoLog->uid=$oCurrentUser->uid;
$oAutoLog->entity='survey';
$oAutoLog->entityid=$iSurveyID;
$oAutoLog->action='update';
$oAutoLog->oldvalues=json_encode($oldAttributes);
$oAutoLog->newvalues=json_encode($newAttributes);
$oAutoLog->fields=json_encode($diff);
$oAutoLog->save();
}
}
}
}

0 comments on commit a30bb11

Please sign in to comment.