Completed
Pull Request — develop (#143)
by Tony
06:44
created

Device::eventlog()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 1
Bugs 0 Features 1
Metric Value
c 1
b 0
f 1
dl 0
loc 4
rs 10
ccs 2
cts 2
cp 1
cc 1
eloc 2
nc 1
nop 0
crap 1
1
<?php
2
3
namespace App\Models;
4
5
use Illuminate\Database\Eloquent\Model;
6
7
/**
8
 * App\Models\Device
9
 *
10
 * @property integer $device_id
11
 * @property string $hostname
12
 * @property string $sysName
13
 * @property mixed $ip
14
 * @property string $community
15
 * @property string $authlevel
16
 * @property string $authname
17
 * @property string $authpass
18
 * @property string $authalgo
19
 * @property string $cryptopass
20
 * @property string $cryptoalgo
21
 * @property string $snmpver
22
 * @property integer $port
23
 * @property string $transport
24
 * @property integer $timeout
25
 * @property integer $retries
26
 * @property string $bgpLocalAs
27
 * @property string $sysObjectID
28
 * @property string $sysDescr
29
 * @property string $sysContact
30
 * @property string $version
31
 * @property string $hardware
32
 * @property string $features
33
 * @property string $location
34
 * @property string $os
35
 * @property boolean $status
36
 * @property string $status_reason
37
 * @property boolean $ignore
38
 * @property boolean $disabled
39
 * @property integer $uptime
40
 * @property integer $agent_uptime
41
 * @property string $last_polled
42
 * @property string $last_poll_attempted
43
 * @property float $last_polled_timetaken
44
 * @property float $last_discovered_timetaken
45
 * @property string $last_discovered
46
 * @property string $last_ping
47
 * @property float $last_ping_timetaken
48
 * @property string $purpose
49
 * @property string $type
50
 * @property string $serial
51
 * @property string $icon
52
 * @property integer $poller_group
53
 * @property boolean $override_sysLocation
54
 * @property string $notes
55
 * @property integer $port_association_mode
56
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\User[] $users
57
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\Port[] $ports
58
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\General\Syslog[] $syslogs
59
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\General\Eventlog[] $eventlogs
60
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\Alerting\Alert[] $alerts
61
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\Alerting\Rule[] $rules
62
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\General\Eventlog[] $eventlog
63
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\Sensor[] $sensors
64
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereDeviceId($value)
65
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereHostname($value)
66
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereSysName($value)
67
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereIp($value)
68
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereCommunity($value)
69
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereAuthlevel($value)
70
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereAuthname($value)
71
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereAuthpass($value)
72
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereAuthalgo($value)
73
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereCryptopass($value)
74
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereCryptoalgo($value)
75
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereSnmpver($value)
76
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device wherePort($value)
77
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereTransport($value)
78
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereTimeout($value)
79
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereRetries($value)
80
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereBgpLocalAs($value)
81
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereSysObjectID($value)
82
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereSysDescr($value)
83
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereSysContact($value)
84
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereVersion($value)
85
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereHardware($value)
86
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereFeatures($value)
87
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereLocation($value)
88
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereOs($value)
89
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereStatus($value)
90
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereStatusReason($value)
91
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereIgnore($value)
92
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereDisabled($value)
93
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereUptime($value)
94
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereAgentUptime($value)
95
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereLastPolled($value)
96
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereLastPollAttempted($value)
97
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereLastPolledTimetaken($value)
98
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereLastDiscoveredTimetaken($value)
99
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereLastDiscovered($value)
100
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereLastPing($value)
101
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereLastPingTimetaken($value)
102
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device wherePurpose($value)
103
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereType($value)
104
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereSerial($value)
105
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereIcon($value)
106
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device wherePollerGroup($value)
107
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereOverrideSysLocation($value)
108
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device whereNotes($value)
109
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device wherePortAssociationMode($value)
110
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device isUp()
111
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device isDown()
112
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device isIgnored()
113
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device notIgnored()
114
 * @method static \Illuminate\Database\Query\Builder|\App\Models\Device isDisabled()
115
 * @mixin \Eloquent
116
 */
117
class Device extends Model
118
{
119
    /**
120
     * Indicates if the model should be timestamped.
121
     *
122
     * @var bool
123
     */
124
    public $timestamps = false;
125
    /**
126
     * The table associated with the model.
127
     *
128
     * @var string
129
     */
130 20
    protected $table = 'devices';
131
    /**
132 20
     * The primary key column name.
133
     *
134 20
     * @var string
135
     */
136 1
    protected $primaryKey = 'device_id';
137 1
138 1
    /**
139 20
     * The attributes that are mass assignable.
140 20
     *
141
     * @var array
142
     */
143
    protected $fillable = ['hostname', 'ip', 'status', 'status_reason'];
144
145
    /**
146
     * Initialize this class
147
     */
148
    public static function boot()
149
    {
150
        parent::boot();
151
152
        static::deleting(function(Device $device) {
153
            // delete related data
154
            $device->ports()->delete();
155 18
            $device->syslogs()->delete();
156
            $device->eventlogs()->delete();
157 18
        });
158
    }
159
160
    /**
161
     * @return string
162
     */
163 1
    public function logo()
164
    {
165 1
        $icon = $this->icon;
166
        if (isset($icon)) {
167
            return asset('images/os/'.$icon.'.png');
168
        }
169
        else {
170
            return asset('images/os/generic.png');
171 1
        }
172
    }
173 1
174
    /**
175
     * @param int $seconds
176
     * @return string
177
     */
178
    public function formatUptime($seconds)
179
    {
180
        if (empty($seconds)) {
181
            $seconds = 0;
182
        }
183
        $from = new \DateTime("@0");
184
        $to = new \DateTime("@$seconds");
185
        return $from->diff($to)->format('%a d, %h h, %i m and %s s');
186
    }
187
188
    // ---- Accessors/Mutators ----
189
190
    public function getIpAttribute($ip)
191
    {
192
        if (empty($ip)) {
193
            return null;
194
        }
195
        // @ suppresses warning, inet_ntop() returns false if it fails
196
        return @inet_ntop($ip) ?: null;
197
    }
198
199
    public function setIpAttribute($ip)
200
    {
201
        $this->attributes['ip'] = inet_pton($ip);
202
    }
203
204 1
    // ---- Query scopes ----
205
206 1
    public function scopeIsUp($query)
207 1
    {
208
        return $query->where([
209
            ['status', '=', 1],
210
            ['ignore', '=', 0],
211
            ['disabled', '=', 0]
212 18
        ]);
213
    }
214 18
215 18
    public function scopeIsDown($query)
216
    {
217
        return $query->where([
218
            ['status', '=', 0],
219
            ['ignore', '=', 0],
220
            ['disabled', '=', 0]
221
        ]);
222
    }
223
224
    public function scopeIsIgnored($query)
225
    {
226
        return $query->where([
227
            ['ignore', '=', 1],
228
            ['disabled', '=', 0]
229
        ]);
230
    }
231
232
    public function scopeNotIgnored($query)
233
    {
234
        return $query->where([
235
            ['ignore', '=', 0]
236
        ]);
237
    }
238
239
    public function scopeIsDisabled($query)
240
    {
241
        return $query->where([
242
            ['disabled', '=', 1]
243
        ]);
244
    }
245
246
    // ---- Define Relationships ----
247
248
    /**
249
     * Relationship to App\Models\Alerting\Alert
250
     *
251
     * @return \Illuminate\Database\Eloquent\Relations\hasMany
252
     */
253
    public function alerts()
254
    {
255
        return $this->hasMany('App\Models\Alerting\Alert', 'device_id');
256
    }
257
258
    /**
259
     * Relationship to App\Models\General\Eventlog
260
     *
261
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
262
     */
263
    public function eventlogs()
264
    {
265
        return $this->hasMany('App\Models\General\Eventlog', 'host', 'device_id');
266
    }
267
268
    /**
269
     * Relationship to App\Models\DeviceGroup
270
     *
271
     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
272
     */
273
    public function groups()
274
    {
275
        return $this->belongsToMany('App\Models\DeviceGroup', 'device_group_device', 'device_id', 'device_group_id');
276
    }
277
278
    /**
279
     * Relationship to App\Models\Port
280
     * Returns a list of the ports this device has.
281
     */
282
    public function ports()
283
    {
284
        return $this->hasMany('App\Models\Port', 'device_id', 'device_id');
285
    }
286
287
    /**
288
     * Relationship to App\Models\Alerting\Rule
289
     *
290
     * @return \Illuminate\Database\Eloquent\Relations\hasMany
291
     */
292
    public function rules()
293
    {
294
        return $this->hasMany('App\Models\Alerting\Rule', 'device_id');
295
    }
296
297
    /**
298
     * Relationship to App\Models\Sensor
299
     *
300
     * @return \Illuminate\Database\Eloquent\Relations\hasMany
301
     */
302
    public function sensors()
303
    {
304
        return $this->hasMany('App\Models\Sensor', 'device_id');
305
    }
306
307
    /**
308
     * Relationship to App\Models\General\Syslog
309
     *
310
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
311
     */
312
    public function syslogs()
313
    {
314
        return $this->hasMany('App\Models\General\Syslog', 'device_id', 'device_id');
315
    }
316
317
    /**
318
     * Relationship to App\Models\User
319
     * Does not include users with global permissions.
320
     *
321
     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
322
     */
323
    public function users()
324
    {
325
        return $this->belongsToMany('App\Models\User', 'devices_perms', 'device_id', 'user_id');
326
    }
327
}
328