forked from bedezign/yii2-audit
/
AuditingBehavior.php
283 lines (256 loc) · 7.61 KB
/
AuditingBehavior.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
<?php
namespace bedezign\yii2\audit;
use Yii;
use yii\base\Exception;
use yii\db\ActiveRecord;
use bedezign\yii2\audit\models\AuditTrail;
/**
* Class AuditingBehavior
* @package bedezign\yii2\audit
*
* @property \yii\db\ActiveRecord $owner
*/
class AuditingBehavior extends \yii\base\Behavior
{
/**
* Array with fields to save
* You don't need to configure both `allowed` and `ignored`
* @var array
*/
public $allowed = [];
/**
* Array with fields to ignore
* You don't need to configure both `allowed` and `ignored`
* @var array
*/
public $ignored = [];
/**
* Array with classes to ignore
* @var array
*/
public $ignoredClasses = [];
/**
* Skip fields where bouth old and new values are NULL
* @var boolean
*/
public $skipNulls = true;
/**
* Is the behavior is active or not
* @var boolean
*/
public $active = true;
/**
* Get the user_id from an attribute in the owner model
* @var string|null
*/
public $userAttribute;
/**
* Date format to use in stamp - set to "Y-m-d H:i:s" for datetime or "U" for timestamp
* @var string
*/
public $dateFormat = 'Y-m-d H:i:s';
/**
* @var array
*/
private $_oldAttributes = [];
/**
* @inheritdoc
*/
public function events()
{
return [
ActiveRecord::EVENT_AFTER_FIND => 'afterFind',
ActiveRecord::EVENT_AFTER_INSERT => 'afterInsert',
ActiveRecord::EVENT_AFTER_UPDATE => 'afterUpdate',
ActiveRecord::EVENT_AFTER_DELETE => 'afterDelete',
];
}
/**
* @param $event
*/
public function afterFind($event)
{
$this->setOldAttributes($this->owner->getAttributes());
}
/**
* @param $event
*/
public function afterInsert($event)
{
$this->audit('CREATE');
}
/**
* @param $event
*/
public function afterUpdate($event)
{
$this->audit('UPDATE');
}
/**
* @param $event
*/
public function afterDelete($event)
{
$this->audit('DELETE');
}
/**
* @param $action
* @throws \yii\db\Exception
*/
public function audit($action)
{
// If this is a delete then just write one row and get out of here
if ($action == 'DELETE') {
if ($this->active) {
Yii::$app->db->createCommand()->insert(AuditTrail::tableName(), [
'action' => 'DELETE',
'audit_id' => $this->getAuditEntryId(),
'user_id' => $this->getUserId(),
'model' => $this->owner->className(),
'model_id' => $this->getNormalizedPk(),
'stamp' => date($this->dateFormat),
])->execute();
}
return;
}
// Get the new and old attributes
$newAttributes = $this->owner->getAttributes();
$oldAttributes = $this->getOldAttributes();
// Lets check if the whole class should be ignored
if (sizeof($this->ignoredClasses) > 0) {
if (array_search(get_class($this->owner), $this->ignoredClasses) !== false) {
return;
}
}
// Lets unset fields which are not allowed
if (sizeof($this->allowed) > 0) {
foreach ($newAttributes as $f => $v) {
if (array_search($f, $this->allowed) === false) {
unset($newAttributes[$f]);
}
}
foreach ($oldAttributes as $f => $v) {
if (array_search($f, $this->allowed) === false) {
unset($oldAttributes[$f]);
}
}
}
// Lets unset fields which are ignored
if (sizeof($this->ignored) > 0) {
foreach ($newAttributes as $f => $v) {
if (array_search($f, $this->ignored) !== false)
unset($newAttributes[$f]);
}
foreach ($oldAttributes as $f => $v) {
if (array_search($f, $this->ignored) !== false)
unset($oldAttributes[$f]);
}
}
// If no difference then get out of here
if (count(array_diff_assoc($newAttributes, $oldAttributes)) <= 0) {
return;
}
// Now lets actually write the attributes
$this->auditAttributes($action, $newAttributes, $oldAttributes);
// Reset old attributes to handle the case with the same model instance updated multiple times
$this->setOldAttributes($this->owner->getAttributes());
}
/**
* @param $action
* @param $newAttributes
* @param array $oldAttributes
* @throws \yii\db\Exception
*/
public function auditAttributes($action, $newAttributes, $oldAttributes = [])
{
// If we are not active the get out of here
if (!$this->active) {
return;
}
// Setup values outside loop
$audit_id = $this->getAuditEntryId();
$user_id = $this->getUserId();
$model = $this->owner->className();
$model_id = $this->getNormalizedPk();
$stamp = date($this->dateFormat);
// Build a list of fields to log
$rows = array();
foreach ($newAttributes as $name => $new) {
$old = isset($oldAttributes[$name]) ? $oldAttributes[$name] : '';
// If we are skipping nulls then lets see if both sides are null
if ($this->skipNulls && empty($old) && empty($new)) {
continue;
}
// If they are not the same lets write an audit log
if ($new != $old) {
$rows[] = [
$audit_id,
$user_id,
$old,
$new,
$action,
$model,
$model_id,
$name,
$stamp,
];
}
}
// Record the field changes with a batch insert
if ($rows) {
$columns = ['audit_id', 'user_id', 'old_value', 'new_value', 'action', 'model', 'model_id', 'field', 'stamp'];
Yii::$app->db->createCommand()->batchInsert(AuditTrail::tableName(), $columns, $rows)->execute();
}
}
/**
* @return array
*/
public function getOldAttributes()
{
return $this->_oldAttributes;
}
/**
* @param $value
*/
public function setOldAttributes($value)
{
$this->_oldAttributes = $value;
}
/**
* @return string
*/
protected function getNormalizedPk()
{
$pk = $this->owner->getPrimaryKey();
return is_array($pk) ? json_encode($pk) : $pk;
}
/**
* @return int|null|string
*/
protected function getUserId()
{
if (isset($this->userAttribute)) {
$data = $this->owner->getAttributes();
return isset($data[$this->userAttribute]) ? $data[$this->userAttribute] : null;
} else {
try {
$userid = Yii::$app->user->id;
return empty($userid) ? null : $userid;
} catch (Exception $e) {
//If we have no user object, this must be a command line program
return null;
}
}
}
/**
* @return models\AuditEntry|null|static
*/
protected function getAuditEntryId()
{
$entry = Auditing::current() ? Auditing::current()->getEntry() : null;
if ($entry) {
return $entry->id;
}
return null;
}
}