~xibo-maintainers/xibo/tempel

« back to all changes in this revision

Viewing changes to server/lib/data/display.data.class.php

  • Committer: Dan Garner
  • Date: 2015-01-15 14:26:07 UTC
  • Revision ID: git-v1:0bf2226a1e1e343100602a625c79b0b71a23593d
Migrated from BZR and moved files to root folder.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<?php
2
 
/*
3
 
 * Xibo - Digital Signage - http://www.xibo.org.uk
4
 
 * Copyright (C) 2009-2013 Daniel Garner
5
 
 *
6
 
 * This file is part of Xibo.
7
 
 *
8
 
 * Xibo is free software: you can redistribute it and/or modify
9
 
 * it under the terms of the GNU Affero General Public License as published by
10
 
 * the Free Software Foundation, either version 3 of the License, or
11
 
 * any later version. 
12
 
 *
13
 
 * Xibo is distributed in the hope that it will be useful,
14
 
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15
 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16
 
 * GNU Affero General Public License for more details.
17
 
 *
18
 
 * You should have received a copy of the GNU Affero General Public License
19
 
 * along with Xibo.  If not, see <http://www.gnu.org/licenses/>.
20
 
 */
21
 
defined('XIBO') or die("Sorry, you are not allowed to directly access this page.<br /> Please press the back button in your browser.");
22
 
 
23
 
class Display extends Data {
24
 
 
25
 
    public $loaded;
26
 
 
27
 
    public $displayId;
28
 
    public $isAuditing;
29
 
    public $display;
30
 
    public $description;
31
 
    public $defaultLayoutId;
32
 
    public $license;
33
 
    public $licensed;
34
 
    public $currentLicensed;
35
 
    public $loggedIn;
36
 
    public $lastAccessed;
37
 
    public $incSchedule;
38
 
    public $emailAlert;
39
 
    public $alertTimeout;
40
 
    public $clientAddress;
41
 
    public $mediaInventoryStatus;
42
 
    public $mediaInventoryXml;
43
 
    public $macAddress;
44
 
    public $lastChanged;
45
 
    public $numberOfMacAddressChanges;
46
 
    public $lastWakeOnLanCommandSent;
47
 
    public $wakeOnLanEnabled;
48
 
    public $wakeOnLanTime;
49
 
    public $broadCastAddress;
50
 
    public $secureOn;
51
 
    public $cidr;
52
 
    public $latitude;
53
 
    public $longitude;
54
 
    public $versionInstructions;
55
 
    public $clientType;
56
 
    public $clientVersion;
57
 
    public $clientCode;
58
 
    public $displayProfileId;
59
 
    public $currentLayoutId;
60
 
    public $screenShotRequested;
61
 
 
62
 
    public $displayGroupId;
63
 
    private $_config;
64
 
    
65
 
    public function Load() {
66
 
        try {
67
 
            $dbh = PDOConnect::init();
68
 
        
69
 
            $sth = $dbh->prepare('
70
 
                SELECT display.*, displaygroup.displaygroupid, displaygroup.description, X(display.GeoLocation) AS Latitude, Y(display.GeoLocation) AS Longitude 
71
 
                  FROM `display`
72
 
                    INNER JOIN `lkdisplaydg`
73
 
                    ON lkdisplaydg.displayid = display.displayId
74
 
                    INNER JOIN `displaygroup`
75
 
                    ON displaygroup.displaygroupid = lkdisplaydg.displaygroupid
76
 
                        AND isdisplayspecific = 1
77
 
                WHERE display.displayid = :display_id');
78
 
            
79
 
            $sth->execute(array('display_id' => $this->displayId));
80
 
          
81
 
            if (!$row = $sth->fetch())
82
 
                $this->ThrowError(25004, __('Cannot find display record'));
83
 
 
84
 
            $this->isAuditing = Kit::ValidateParam($row['isAuditing'], _INT);
85
 
            $this->display = Kit::ValidateParam($row['display'], _STRING);
86
 
            $this->description = Kit::ValidateParam($row['description'], _STRING);
87
 
            $this->defaultLayoutId = Kit::ValidateParam($row['defaultlayoutid'], _INT);
88
 
            $this->license = Kit::ValidateParam($row['license'], _STRING);
89
 
            $this->licensed = Kit::ValidateParam($row['licensed'], _INT);
90
 
            $this->loggedIn = Kit::ValidateParam($row['loggedin'], _INT);
91
 
            $this->lastAccessed = Kit::ValidateParam($row['lastaccessed'], _INT);
92
 
            $this->incSchedule = Kit::ValidateParam($row['inc_schedule'], _INT);
93
 
            $this->emailAlert = Kit::ValidateParam($row['email_alert'], _INT);
94
 
            $this->alertTimeout = Kit::ValidateParam($row['alert_timeout'], _INT);
95
 
            $this->clientAddress = Kit::ValidateParam($row['ClientAddress'], _STRING);
96
 
            $this->mediaInventoryStatus = Kit::ValidateParam($row['MediaInventoryStatus'], _INT);
97
 
            $this->mediaInventoryXml = Kit::ValidateParam($row['MediaInventoryXml'], _HTMLSTRING);
98
 
            $this->macAddress = Kit::ValidateParam($row['MacAddress'], _STRING);
99
 
            $this->lastChanged = Kit::ValidateParam($row['LastChanged'], _INT);
100
 
            $this->numberOfMacAddressChanges = Kit::ValidateParam($row['NumberOfMacAddressChanges'], _INT);
101
 
            $this->lastWakeOnLanCommandSent = Kit::ValidateParam($row['LastWakeOnLanCommandSent'], _INT);
102
 
            $this->wakeOnLanEnabled = Kit::ValidateParam($row['WakeOnLan'], _INT);
103
 
            $this->wakeOnLanTime = Kit::ValidateParam($row['WakeOnLanTime'], _STRING);
104
 
            $this->broadCastAddress = Kit::ValidateParam($row['BroadCastAddress'], _STRING);
105
 
            $this->secureOn = Kit::ValidateParam($row['SecureOn'], _STRING);
106
 
            $this->cidr = Kit::ValidateParam($row['Cidr'], _STRING);
107
 
            $this->latitude = Kit::ValidateParam($row['Latitude'], _DOUBLE);
108
 
            $this->longitude = Kit::ValidateParam($row['Longitude'], _DOUBLE);
109
 
            $this->versionInstructions = Kit::ValidateParam($row['version_instructions'], _STRING);
110
 
            $this->clientType = Kit::ValidateParam($row['client_type'], _STRING);
111
 
            $this->clientVersion = Kit::ValidateParam($row['client_version'], _STRING);
112
 
            $this->clientCode = Kit::ValidateParam($row['client_code'], _INT);
113
 
            $this->displayProfileId = Kit::ValidateParam($row['displayprofileid'], _INT);
114
 
            $this->currentLayoutId = Kit::ValidateParam($row['currentLayoutId'], _INT);
115
 
            $this->screenShotRequested = Kit::ValidateParam($row['screenShotRequested'], _INT);
116
 
            
117
 
            $this->displayGroupId = Kit::ValidateParam($row['displaygroupid'], _INT);
118
 
 
119
 
            // Store the current licensed flag, in case we are changing it and need to check it.
120
 
            $this->currentLicensed = $this->licensed;
121
 
 
122
 
            $this->loaded = true;
123
 
 
124
 
            return true;
125
 
        }
126
 
        catch (Exception $e) {
127
 
            
128
 
            Debug::LogEntry('error', $e->getMessage());
129
 
        
130
 
            if (!$this->IsError())
131
 
                $this->SetError(1, __('Unknown Error'));
132
 
        
133
 
            return false;
134
 
        }
135
 
    }
136
 
 
137
 
    /**
138
 
     * Adds a Display
139
 
     * @return 
140
 
     * @param $display Object
141
 
     * @param $isAuditing Object
142
 
     * @param $defaultLayoutID Object
143
 
     * @param $license Object
144
 
     * @param $licensed Object
145
 
     * @param $incSchedule Object
146
 
     */
147
 
    public function Add($display, $isAuditing, $defaultLayoutID, $license, $licensed, $incSchedule) {
148
 
        Debug::LogEntry('audit', 'IN', get_class(), __FUNCTION__);
149
 
        
150
 
        try {
151
 
            $dbh = PDOConnect::init();
152
 
 
153
 
            // Create the SQL
154
 
            $SQL  = "";
155
 
            $SQL .= "INSERT INTO display (display, isAuditing, defaultlayoutid, license, licensed, inc_schedule, email_alert, alert_timeout) ";
156
 
            $SQL .= " VALUES (:display, :isauditing, :defaultlayoutid, :license, :licensed, :inc_schedule, :email_alert, :alert_timeout) ";
157
 
            
158
 
            $sth = $dbh->prepare($SQL);
159
 
            $sth->execute(array(
160
 
                    'display' => $display,
161
 
                    'isauditing' => 0,
162
 
                    'defaultlayoutid' => 1,
163
 
                    'license' => $license,
164
 
                    'licensed' => 0,
165
 
                    'inc_schedule' => 0,
166
 
                    'email_alert' => 0,
167
 
                    'alert_timeout' => 0
168
 
                ));
169
 
        
170
 
            // Get the ID of the inserted record
171
 
            $displayId = $dbh->lastInsertId();
172
 
 
173
 
            // Also want to add the DisplayGroup associated with this Display.
174
 
            $displayGroupObject = new DisplayGroup($this->db);
175
 
 
176
 
            if (!$displayGroupId = $displayGroupObject->Add($display, 1, ''))
177
 
                $this->ThrowError(25001, __('Could not add a display group for the new display.'));
178
 
 
179
 
            // Link the Two together
180
 
            if (!$displayGroupObject->Link($displayGroupId, $displayId))
181
 
                $this->ThrowError(25001, __('Could not link the new display with its group.'));
182
 
            
183
 
            Debug::LogEntry('audit', 'OUT', 'Display', 'Add');
184
 
 
185
 
            return $displayId;
186
 
        }
187
 
        catch (Exception $e) {
188
 
 
189
 
            Debug::LogEntry('error', $e->getMessage());
190
 
 
191
 
            if (!$this->IsError())
192
 
                $this->SetError(25000, __('Could not add display'));
193
 
 
194
 
            return false;
195
 
        }
196
 
    }
197
 
    
198
 
    /**
199
 
     * Edits a Display 
200
 
     * @return 
201
 
     * @param $displayID Object
202
 
     * @param $isAuditing Object
203
 
     * @param $defaultLayoutID Object
204
 
     * @param $licensed Object
205
 
     * @param $incSchedule Object
206
 
     */
207
 
    public function Edit() {
208
 
        Debug::LogEntry('audit', 'IN', get_class(), __FUNCTION__);
209
 
 
210
 
        // Validation
211
 
        if ($this->display == '')
212
 
            return $this->SetError(__("Can not have a display without a name"));
213
 
 
214
 
        if ($this->wakeOnLanEnabled == 1 && $this->wakeOnLanTime == '')
215
 
            return $this->SetError(__('Wake on Lan is enabled, but you have not specified a time to wake the display'));
216
 
        
217
 
        try {
218
 
            $dbh = PDOConnect::init();
219
 
        
220
 
            // Check the number of licensed displays
221
 
            $maxDisplays = Config::GetSetting('MAX_LICENSED_DISPLAYS');
222
 
 
223
 
            if ($maxDisplays > 0) {
224
 
                // See if this is a license switch
225
 
                // Has the licence flag toggled?
226
 
                if ($this->currentLicensed != $this->licensed && $this->licensed == 1)
227
 
                {
228
 
                    // License change - test number of licensed displays.
229
 
                    $sth = $dbh->prepare('SELECT COUNT(DisplayID) AS CountLicensed FROM display WHERE licensed = 1');
230
 
                    $sth->execute();
231
 
 
232
 
                    if (!$row = $sth->fetch())
233
 
                        $this->ThrowError(1, __('Unable to get count of licensed displays.'));
234
 
 
235
 
                    $count = Kit::ValidateParam($row['CountLicensed'], _INT);
236
 
 
237
 
                    $sth->closeCursor();
238
 
 
239
 
                    if ($count + 1 > $maxDisplays)
240
 
                        $this->ThrowError(25000, sprintf(__('You have exceeded your maximum number of licensed displays. %d'), $maxDisplays));
241
 
                }
242
 
            }
243
 
 
244
 
            // Validate some parameters
245
 
 
246
 
            // Fill $addr with client's IP address, if $addr is empty
247
 
            if ($this->broadCastAddress != '')
248
 
            {
249
 
                // Resolve broadcast address
250
 
                // same as (but easier than):  preg_match("/\b(([01]?\d?\d|2[0-4]\d|25[0-5])\.){3}([01]?\d?\d|2[0-4]\d|25[0-5])\b/",$addr)
251
 
                if (!filter_var($this->broadCastAddress, FILTER_VALIDATE_IP))
252
 
                    $this->ThrowError(25015, __('BroadCast Address is not a valid IP Address'));
253
 
            }
254
 
 
255
 
            // Check whether $cidr is valid
256
 
            if ($this->cidr != '')
257
 
            {
258
 
                if ((!is_numeric($this->cidr)) || ($this->cidr < 0) || ($this->cidr > 32))
259
 
                    $this->ThrowError(25015, __('CIDR subnet mask is not a number within the range of 0 to 32.'));
260
 
            }
261
 
 
262
 
            // Check whether $secureOn is valid
263
 
            if ($this->secureOn != '')
264
 
            {
265
 
                $this->secureOn = strtoupper($this->secureOn);
266
 
                $this->secureOn = str_replace(":", "-", $this->secureOn);
267
 
 
268
 
                if ((!preg_match("/([A-F0-9]{2}[-]){5}([0-9A-F]){2}/", $this->secureOn)) || (strlen($this->secureOn) != 17))
269
 
                    $this->ThrowError(25015, __('Pattern of secureOn-password is not "xx-xx-xx-xx-xx-xx" (x = digit or CAPITAL letter)'));
270
 
            }
271
 
 
272
 
            Debug::LogEntry('audit', 'Validation Complete and Passed', 'Display', 'Edit');
273
 
 
274
 
            // Update the display record
275
 
            $SQL  = '
276
 
                UPDATE display 
277
 
                    SET display = :display,
278
 
                        defaultlayoutid = :defaultlayoutid,
279
 
                        inc_schedule = :incschedule,
280
 
                        licensed = :licensed,
281
 
                        isAuditing = :isauditing,
282
 
                        email_alert = :emailalert,
283
 
                        alert_timeout = :alerttimeout,
284
 
                        WakeOnLan = :wakeonlan,
285
 
                        WakeOnLanTime = :wakeonlantime,
286
 
                        BroadCastAddress = :broadcastaddress,
287
 
                        SecureOn = :secureon,
288
 
                        Cidr = :cidr,
289
 
                        GeoLocation = POINT(:latitude, :longitude),
290
 
                        displayprofileid = :displayprofileid
291
 
             WHERE displayid = :displayid';
292
 
 
293
 
            $sth = $dbh->prepare($SQL);
294
 
            $sth->execute(array(
295
 
                    'display' => $this->display,
296
 
                    'defaultlayoutid' => $this->defaultLayoutId,
297
 
                    'incschedule' => $this->incSchedule,
298
 
                    'licensed' => $this->licensed,
299
 
                    'isauditing' => $this->isAuditing,
300
 
                    'emailalert' => $this->emailAlert,
301
 
                    'alerttimeout' => $this->alertTimeout,
302
 
                    'wakeonlan' => $this->wakeOnLanEnabled,
303
 
                    'wakeonlantime' => $this->wakeOnLanTime,
304
 
                    'broadcastaddress' => $this->broadCastAddress,
305
 
                    'secureon' => $this->secureOn,
306
 
                    'cidr' => $this->cidr,
307
 
                    'latitude' => $this->latitude,
308
 
                    'longitude' => $this->longitude,
309
 
                    'displayprofileid' => $this->displayProfileId,
310
 
                    'displayid' => $this->displayId
311
 
                ));
312
 
 
313
 
            Debug::LogEntry('audit', 'Display Edited', 'Display', 'Edit');
314
 
 
315
 
            // Use a DisplayGroup to handle the default layout and displaygroup name for this display
316
 
            Kit::ClassLoader('displaygroup');
317
 
            $displayGroupObject = new DisplayGroup();
318
 
            
319
 
            // Do we also want to update the linked Display Groups name (seeing as that is what we will be presenting to everyone)
320
 
            if (!$displayGroupObject->Edit($this->displayGroupId, $this->display, $this->description)) {
321
 
                $this->ThrowError(25002, __('Could not update this display with a new name.'));
322
 
            }
323
 
 
324
 
            Debug::LogEntry('audit', 'OUT', 'DisplayGroup', 'Edit');
325
 
            
326
 
            return true;
327
 
        }
328
 
        catch (Exception $e) {
329
 
            
330
 
            Debug::LogEntry('error', $e->getMessage(), get_class(), __FUNCTION__);
331
 
 
332
 
            if (!$this->IsError())
333
 
                $this->SetError(25000, __('Could not update display'));
334
 
 
335
 
            return false;
336
 
        }
337
 
    }
338
 
    
339
 
    /**
340
 
     * Deletes a Display
341
 
     * @return 
342
 
     * @param $displayID Object
343
 
     */
344
 
    public function Delete($displayID)
345
 
    {
346
 
        Debug::LogEntry('audit', 'IN', get_class(), __FUNCTION__);
347
 
        
348
 
        try {
349
 
            $dbh = PDOConnect::init();
350
 
 
351
 
            // Pass over to the DisplayGroup data class so that it can try and delete the
352
 
            // display specific group first (it is that group which is linked to schedules)
353
 
            $displayGroupObject = new DisplayGroup($this->db);
354
 
 
355
 
            // Do we also want to update the linked Display Groups name (seeing as that is what we will be presenting to everyone)
356
 
            if (!$displayGroupObject->DeleteDisplay($displayID))
357
 
                $this->ThrowError($displayGroupObject->GetErrorMessage(), $displayGroupObject->GetErrorMessage());
358
 
 
359
 
            // Delete the blacklist
360
 
            $sth = $dbh->prepare('DELETE FROM blacklist WHERE DisplayID = :displayid');
361
 
            $sth->execute(array(
362
 
                    'displayid' => $displayID
363
 
                ));
364
 
 
365
 
            // Now we know the Display Group is gone - and so are any links
366
 
            // delete the display
367
 
            $sth = $dbh->prepare('DELETE FROM display WHERE DisplayID = :displayid');
368
 
            $sth->execute(array(
369
 
                    'displayid' => $displayID
370
 
                ));
371
 
 
372
 
            Debug::LogEntry('audit', 'OUT', 'Display', 'Delete');
373
 
 
374
 
            return true;
375
 
        }
376
 
        catch (Exception $e) {
377
 
            
378
 
            Debug::LogEntry('error', $e->getMessage());
379
 
 
380
 
            if (!$this->IsError())
381
 
                $this->SetError(25015,__('Unable to delete display record.'));
382
 
 
383
 
            return false;
384
 
        }
385
 
    }
386
 
    
387
 
    /**
388
 
     * Edits a Displays Name
389
 
     * @return 
390
 
     * @param $license Object
391
 
     * @param $display Object
392
 
     */
393
 
    public function EditDisplayName($license, $display) 
394
 
    {
395
 
        Debug::LogEntry('audit', 'IN', get_class(), __FUNCTION__);
396
 
 
397
 
        try {
398
 
            $dbh = PDOConnect::init();
399
 
 
400
 
            // Update the display with its new name (using the licence as the key)
401
 
            $sth = $dbh->prepare('UPDATE display SET display = :display WHERE license = :license');
402
 
            $sth->execute(array(
403
 
                    'display' => $display,
404
 
                    'license' => $license
405
 
                ));
406
 
            
407
 
            // Also need to update the display group name here.
408
 
            $displayGroupObject = new DisplayGroup($this->db);
409
 
            
410
 
            // Do we also want to update the linked Display Groups name (seeing as that is what we will be presenting to everyone)
411
 
            if (!$displayGroupObject->EditDisplayGroup($displayID, $display))
412
 
                $this->ThrowError(25015, __('Could not update this display with a new name.'));
413
 
            
414
 
            Debug::LogEntry('audit', 'OUT', 'DisplayGroup', 'EditDisplayName');
415
 
            
416
 
            return true;
417
 
        }
418
 
        catch (Exception $e) {
419
 
            
420
 
            Debug::LogEntry('error', $e->getMessage());
421
 
 
422
 
            if (!$this->IsError())
423
 
                $this->SetError(25015,__('Unable to edit display record.'));
424
 
 
425
 
            return false;
426
 
        }
427
 
    }
428
 
    
429
 
    /**
430
 
     * Sets the information required on the display to indicate that it is still logged in
431
 
     * @param int  $displayId The Display ID
432
 
     * @param array  $status The Display Status
433
 
     */
434
 
    public function Touch($displayId, $status = array())
435
 
    {
436
 
        Debug::LogEntry('audit', 'IN', get_class(), __FUNCTION__);
437
 
        
438
 
        try {
439
 
            $dbh = PDOConnect::init();
440
 
 
441
 
            $this->displayId = $displayId;
442
 
            $this->Load();
443
 
 
444
 
            // Update last accessed and set to be logged in
445
 
            $this->lastAccessed = time();
446
 
            $this->loggedIn = 1;
447
 
 
448
 
            // Pull in any of the optional parameters from the status array
449
 
            $this->clientAddress = (Kit::GetParam('clientAddress', $status, _STRING) == '') ? $this->clientAddress : Kit::GetParam('clientAddress', $status, _STRING);
450
 
            $this->mediaInventoryStatus = (Kit::GetParam('mediaInventoryStatus', $status, _INT) == 0) ? $this->mediaInventoryStatus : Kit::GetParam('mediaInventoryStatus', $status, _INT);
451
 
            $this->mediaInventoryXml = (Kit::GetParam('mediaInventoryXml', $status, _HTMLSTRING) == '') ? $this->mediaInventoryXml : Kit::GetParam('mediaInventoryXml', $status, _HTMLSTRING);
452
 
            $this->clientType = (Kit::GetParam('clientType', $status, _STRING) == '') ? $this->clientType : Kit::GetParam('clientType', $status, _STRING);
453
 
            $this->clientVersion = (Kit::GetParam('clientVersion', $status, _STRING) == '') ? $this->clientVersion : Kit::GetParam('clientVersion', $status, _STRING);
454
 
            $this->clientCode = (Kit::GetParam('clientCode', $status, _INT) == 0) ? $this->clientCode : Kit::GetParam('clientCode', $status, _INT);
455
 
            $this->currentLayoutId = (Kit::GetParam('currentLayoutId', $status, _INT) == 0) ? $this->currentLayoutId : Kit::GetParam('currentLayoutId', $status, _INT);
456
 
            $this->screenShotRequested = (Kit::GetParam('screenShotRequested', $status, _INT, -1) == -1) ? $this->screenShotRequested : Kit::GetParam('screenShotRequested', $status, _INT);
457
 
 
458
 
            // Has the mac address changed
459
 
            if (Kit::GetParam('macAddress', $status, _STRING) != '') {
460
 
                if ($this->macAddress != Kit::GetParam('macAddress', $status, _STRING)) {
461
 
                    // Mac address change detected
462
 
                    $this->macAddress = Kit::GetParam('macAddress', $status, _STRING);
463
 
                    $this->numberOfMacAddressChanges++;
464
 
                    $this->lastChanged = time();
465
 
                }
466
 
            }
467
 
 
468
 
            // Save
469
 
            $SQL = '
470
 
                    UPDATE display SET lastaccessed = :lastAccessed, 
471
 
                        loggedin = :loggedIn,
472
 
                        ClientAddress = :clientAddress,
473
 
                        MediaInventoryStatus = :mediaInventoryStatus,
474
 
                        MediaInventoryXml = :mediaInventoryXml,
475
 
                        client_type = :clientType,
476
 
                        client_version = :clientVersion,
477
 
                        client_code = :clientCode,
478
 
                        MacAddress = :macAddress, 
479
 
                        LastChanged = :lastChanged, 
480
 
                        NumberOfMacAddressChanges = :numberOfMacAddressChanges,
481
 
                        currentLayoutId = :currentLayoutId,
482
 
                        screenShotRequested = :screenShotRequested
483
 
                     WHERE displayId = :displayId
484
 
                ';
485
 
 
486
 
            // Update the display
487
 
            $sth = $dbh->prepare($SQL);
488
 
            $sth->execute(array(
489
 
                    'displayId' => $this->displayId,
490
 
                    'lastAccessed' => $this->lastAccessed,
491
 
                    'loggedIn' => $this->loggedIn,
492
 
                    'clientAddress' => $this->clientAddress,
493
 
                    'mediaInventoryStatus' => $this->mediaInventoryStatus,
494
 
                    'mediaInventoryXml' => $this->mediaInventoryXml,
495
 
                    'clientType' => $this->clientType,
496
 
                    'clientVersion' => $this->clientVersion,
497
 
                    'clientCode' => $this->clientCode,
498
 
                    'macAddress' => $this->macAddress,
499
 
                    'lastChanged' => $this->lastChanged,
500
 
                    'numberOfMacAddressChanges' => $this->numberOfMacAddressChanges,
501
 
                    'currentLayoutId' => $this->currentLayoutId,
502
 
                    'screenShotRequested' => $this->screenShotRequested
503
 
                ));
504
 
 
505
 
            return true;
506
 
        }
507
 
        catch (Exception $e) {
508
 
            Debug::LogEntry('error', $e->getMessage());
509
 
            return $this->SetError(25002, __("Error updating this displays last accessed information."));
510
 
        }
511
 
    }
512
 
 
513
 
    public function RequestScreenShot($displayId) {
514
 
        return $this->Touch($displayId, array('screenShotRequested' => 1));
515
 
    }
516
 
 
517
 
    /**
518
 
     * Flags a display as being incomplete
519
 
     * @param <type> $displayId
520
 
     */
521
 
    public function FlagIncomplete($displayId)
522
 
    {
523
 
        Debug::LogEntry('audit', sprintf('Flag DisplayID %d incomplete.', $displayId), 'display', 'NotifyDisplays');
524
 
 
525
 
        try {
526
 
            $dbh = PDOConnect::init();
527
 
 
528
 
            $sth = $dbh->prepare('UPDATE display SET MediaInventoryStatus = 3 WHERE displayID = :displayid');
529
 
            $sth->execute(array(
530
 
                    'displayid' => $displayId
531
 
                ));
532
 
 
533
 
            return true;
534
 
        }
535
 
        catch (Exception $e) {
536
 
            Debug::LogEntry('error', $e->getMessage());
537
 
            return $this->SetError(25004, 'Unable to Flag Display as incomplete');
538
 
        }
539
 
    }
540
 
 
541
 
    /**
542
 
     * Notify displays of this campaign change
543
 
     * @param <type> $layoutId
544
 
     */
545
 
    public function NotifyDisplays($campaignId)
546
 
    {
547
 
        Debug::LogEntry('audit', sprintf('Checking for Displays to refresh on Layout %d', $campaignId), 'display', 'NotifyDisplays');
548
 
 
549
 
        try {
550
 
            $dbh = PDOConnect::init();
551
 
 
552
 
            $currentdate = time();
553
 
            $rfLookahead = Kit::ValidateParam(Config::GetSetting('REQUIRED_FILES_LOOKAHEAD'), _INT);
554
 
            $rfLookahead = $currentdate + $rfLookahead;
555
 
 
556
 
            // Which displays does a change to this layout effect?
557
 
            $SQL  = " SELECT DISTINCT display.DisplayID ";
558
 
            $SQL .= "   FROM schedule ";
559
 
            $SQL .= "   INNER JOIN schedule_detail ";
560
 
            $SQL .= "   ON schedule_detail.eventid = schedule.eventid ";
561
 
            $SQL .= "   INNER JOIN lkdisplaydg ";
562
 
            $SQL .= "   ON lkdisplaydg.DisplayGroupID = schedule_detail.DisplayGroupID ";
563
 
            $SQL .= "   INNER JOIN display ";
564
 
            $SQL .= "   ON lkdisplaydg.DisplayID = display.displayID ";
565
 
            $SQL .= " WHERE schedule.CampaignID = :campaignid ";
566
 
            $SQL .= " AND schedule_detail.FromDT < :fromdt AND schedule_detail.ToDT > :todt ";
567
 
            $SQL .= " UNION ";
568
 
            $SQL .= " SELECT DISTINCT display.DisplayID ";
569
 
            $SQL .= "   FROM display ";
570
 
            $SQL .= "       INNER JOIN lkcampaignlayout ";
571
 
            $SQL .= "       ON lkcampaignlayout.LayoutID = display.DefaultLayoutID ";
572
 
            $SQL .= " WHERE lkcampaignlayout.CampaignID = :campaignid";
573
 
 
574
 
            $sth = $dbh->prepare($SQL);
575
 
            $sth->execute(array(
576
 
                    'campaignid' => $campaignId,
577
 
                    'fromdt' => $rfLookahead,
578
 
                    'todt' => $currentdate - 3600
579
 
                ));
580
 
 
581
 
            while ($row = $sth->fetch()) {
582
 
                // Notify each display in turn
583
 
                $displayId = Kit::ValidateParam($row['DisplayID'], _INT);
584
 
                $this->FlagIncomplete($displayId);
585
 
            }
586
 
        }
587
 
        catch (Exception $e) {
588
 
            Debug::LogEntry('error', $e->getMessage());
589
 
 
590
 
            if (!$this->IsError())
591
 
                $this->SetError(25004, 'Unable to Flag Display as incomplete');
592
 
 
593
 
            return false;
594
 
        }
595
 
    }
596
 
 
597
 
    /**
598
 
     * Edits the default layout for a display
599
 
     * @param <type> $displayId
600
 
     * @param <type> $defaultLayoutId
601
 
     * @return <type>
602
 
     */
603
 
    public function EditDefaultLayout($displayId, $defaultLayoutId)
604
 
    {
605
 
        Debug::LogEntry('audit', 'IN', get_class(), __FUNCTION__);
606
 
 
607
 
        try {
608
 
            $dbh = PDOConnect::init();
609
 
 
610
 
            $sth = $dbh->prepare('UPDATE display SET defaultLayoutId = :defaultlayoutid WHERE displayID = :displayid');
611
 
            $sth->execute(array(
612
 
                    'defaultlayoutid' => $defaultLayoutId,
613
 
                    'displayid' => $displayId
614
 
                ));
615
 
            
616
 
            // Flag this display as not having all the content
617
 
            $this->FlagIncomplete($displayId);
618
 
 
619
 
            Debug::LogEntry('audit', 'OUT', 'Display', 'EditDefaultLayout');
620
 
 
621
 
            return true;
622
 
        }
623
 
        catch (Exception $e) {
624
 
            Debug::LogEntry('error', $e->getMessage());
625
 
            return $this->SetError(25012, __('Error updating this displays default layout.'));
626
 
        }
627
 
    }
628
 
 
629
 
    public function SetVersionInstructions($displayId, $mediaId, $storedAs) {
630
 
        Debug::LogEntry('audit', 'IN', get_class(), __FUNCTION__);
631
 
 
632
 
        try {
633
 
            $dbh = PDOConnect::init();
634
 
 
635
 
            // Set the instructions
636
 
            $version_instructions = array();
637
 
            $version_instructions['id'] = $mediaId;
638
 
            $version_instructions['file'] = $storedAs;
639
 
        
640
 
            $sth = $dbh->prepare('UPDATE `display` SET version_instructions = :version_instructions WHERE displayid = :displayid');
641
 
            $sth->execute(array(
642
 
                    'displayid' => $displayId,
643
 
                    'version_instructions' => json_encode($version_instructions)
644
 
                ));
645
 
 
646
 
            return true;
647
 
        }
648
 
        catch (Exception $e) {
649
 
            
650
 
            Debug::LogEntry('error', $e->getMessage(), get_class(), __FUNCTION__);
651
 
        
652
 
            if (!$this->IsError())
653
 
                $this->SetError(1, __('Unknown Error'));
654
 
        
655
 
            return false;
656
 
        }
657
 
    }
658
 
 
659
 
    public function GetSetting($key, $default) {
660
 
 
661
 
        if (!$this->SetConfig())
662
 
            return false;
663
 
 
664
 
        // Find
665
 
        $return = $default;
666
 
        foreach($this->_config as $row) {
667
 
            if ($row['name'] == $key || $row['name'] == ucfirst($key)) {
668
 
                //Debug::Audit('Found ' . $key . '. value= ' . $row['value']);
669
 
                $return = $row['value'];
670
 
                break;
671
 
            }
672
 
        }
673
 
 
674
 
        return $return;
675
 
    }
676
 
 
677
 
    private function SetConfig() {
678
 
        if ($this->_config == null) {
679
 
            try {
680
 
                $dbh = PDOConnect::init();
681
 
 
682
 
                $displayProfile = new DisplayProfile();
683
 
                $displayProfile->displayProfileId = $this->displayProfileId;
684
 
            
685
 
                if ($displayProfile->displayProfileId == 0) {
686
 
                    // Load the default profile
687
 
                    $displayProfile->type = $this->clientType;
688
 
                    $displayProfile->LoadDefault();
689
 
                }
690
 
                else {
691
 
                    // Load the specified profile
692
 
                    $displayProfile->Load();
693
 
                }
694
 
        
695
 
                $this->_config = $displayProfile->config;
696
 
                
697
 
                return true;
698
 
            }
699
 
            catch (Exception $e) {
700
 
                
701
 
                Debug::LogEntry('error', $e->getMessage(), get_class(), __FUNCTION__);
702
 
            
703
 
                if (!$this->IsError())
704
 
                    $this->SetError(1, __('Unknown Error'));
705
 
            
706
 
                return false;
707
 
            }
708
 
        }
709
 
    }
710
 
    /**
711
 
     * Assess each Display to correctly set the logged in flag based on last accessed time
712
 
     * @return
713
 
     */
714
 
    public static function ValidateDisplays() {
715
 
        // Maintain an array of timed out displays
716
 
        $timedOutDisplays = array();
717
 
 
718
 
        try {
719
 
            $dbh = PDOConnect::init();
720
 
            $statObject = new Stat();
721
 
        
722
 
            // Get a list of all displays and there last accessed / alert time out value
723
 
            $sth = $dbh->prepare('SELECT displayid, display, lastaccessed, alert_timeout, client_type, displayprofileid, email_alert, loggedin FROM display');
724
 
            $sthUpdate = $dbh->prepare('UPDATE display SET loggedin = 0 WHERE displayid = :displayid');
725
 
            
726
 
            $sth->execute(array());
727
 
 
728
 
            // Get the global time out (overrides the alert time out on the display if 0)
729
 
            $globalTimeout = Config::GetSetting('MAINTENANCE_ALERT_TOUT') * 60;
730
 
        
731
 
            $displays = $sth->fetchAll();
732
 
 
733
 
            foreach ($displays as $row) {
734
 
                $displayid = Kit::ValidateParam($row['displayid'], _INT);
735
 
                $lastAccessed = Kit::ValidateParam($row['lastaccessed'], _INT);
736
 
                $alertTimeout = Kit::ValidateParam($row['alert_timeout'], _INT);
737
 
                $clientType = Kit::ValidateParam($row['client_type'], _WORD);
738
 
                $loggedIn = Kit::ValidateParam($row['loggedin'], _INT);
739
 
 
740
 
                // Get the config object
741
 
                if ($alertTimeout == 0) {
742
 
                    $displayProfileId = (empty($row['displayprofileid']) ? 0 : Kit::ValidateParam($row['displayprofileid'], _INT));
743
 
 
744
 
                    $display = new Display();
745
 
                    $display->displayId = $displayid;
746
 
                    $display->displayProfileId = $displayProfileId;
747
 
                    $display->clientType = $clientType;
748
 
                    $timeoutToTestAgainst = $display->GetSetting('collectInterval', $globalTimeout);
749
 
                }
750
 
                else {
751
 
                    $timeoutToTestAgainst = $globalTimeout;
752
 
                }
753
 
 
754
 
                // Store the time out to test against
755
 
                $row['timeout'] = $timeoutToTestAgainst;
756
 
                $timeOut = $lastAccessed + $timeoutToTestAgainst;
757
 
    
758
 
                // If the last time we accessed is less than now minus the time out
759
 
                if ($timeOut < time()) {
760
 
                    Debug::Audit('Timed out display. Last Accessed: ' . date('Y-m-d h:i:s', $lastAccessed) . '. Time out: ' . date('Y-m-d h:i:s', $timeOut));
761
 
 
762
 
                    // If this is the first switch (i.e. the row was logged in before)
763
 
                    if ($loggedIn == 1) {
764
 
                        
765
 
                        // Update the display and set it as logged out
766
 
                        $sthUpdate->execute(array('displayid' => $displayid));
767
 
                       
768
 
                        // Log the down event
769
 
                        $statObject->displayDown($displayid, $lastAccessed);
770
 
                    }
771
 
 
772
 
                    // Store this row
773
 
                    $timedOutDisplays[] = $row;
774
 
                }
775
 
            }
776
 
 
777
 
            return $timedOutDisplays;  
778
 
        }
779
 
        catch (Exception $e) {
780
 
            
781
 
            Debug::LogEntry('error', $e->getMessage(), get_class(), __FUNCTION__);
782
 
            
783
 
            if (!$this->IsError())
784
 
                $this->SetError(1, __('Unknown Error'));
785
 
        
786
 
            return false;
787
 
        }
788
 
    }
789
 
 
790
 
    /**
791
 
     * Wake this display using a WOL command
792
 
     * @param <int> $displayId
793
 
     * @return <bool>
794
 
     */
795
 
    public function WakeOnLan($displayId)
796
 
    {
797
 
        Debug::LogEntry('audit', 'IN', get_class(), __FUNCTION__);
798
 
 
799
 
        try {
800
 
            $dbh = PDOConnect::init();
801
 
 
802
 
            // Get the Client Address and the Mac Address
803
 
            $sth = $dbh->prepare('SELECT MacAddress, BroadCastAddress, SecureOn, Cidr FROM `display` WHERE DisplayID = :displayid');
804
 
            $sth->execute(array(
805
 
                    'displayid' => $displayId
806
 
                ));
807
 
 
808
 
            if (!$row = $sth->fetch())
809
 
                $this->ThrowError(25013, __('Unable to get the Mac or Client Address'));
810
 
 
811
 
            // Check they are populated
812
 
            if ($row['MacAddress'] == '' || $row['BroadCastAddress'] == '')
813
 
                $this->SetError(25014, __('This display has no mac address recorded against it yet. Make sure the display is running.'));
814
 
 
815
 
            Debug::LogEntry('audit', 'About to send WOL packet to ' . $row['BroadCastAddress'] . ' with Mac Address ' . $row['MacAddress'], 'display', 'WakeOnLan');
816
 
 
817
 
            if (!$this->TransmitWakeOnLan($row['MacAddress'], $row['SecureOn'], $row['BroadCastAddress'], $row['Cidr'], "9"))
818
 
                throw new Exception('Error in TransmitWakeOnLan');
819
 
 
820
 
            // If we succeeded then update this display with the last WOL time
821
 
            $sth = $dbh->prepare('UPDATE `display` SET LastWakeOnLanCommandSent = :lastaccessed WHERE DisplayID = :displayid');
822
 
            $sth->execute(array(
823
 
                    'displayid' => $displayId,
824
 
                    'lastaccessed' => time()
825
 
                ));
826
 
 
827
 
            return true;
828
 
        }
829
 
        catch (Exception $e) {
830
 
            Debug::LogEntry('error', $e->getMessage());
831
 
 
832
 
            if (!$this->IsError())
833
 
                $this->SetError(25012, __('Unknown Error.'));
834
 
 
835
 
            return false;
836
 
        }
837
 
    }
838
 
 
839
 
    /**
840
 
     * Get a list of users that have permission for the provided display
841
 
     * @param  int $displayId The Display
842
 
     * @param  string $authLevel The Auth Level (view|edit|delete)
843
 
     * @return array Users Array
844
 
     */
845
 
    public static function getUsers($displayId, $authLevel = 'view')
846
 
    {
847
 
        try {
848
 
            $dbh = PDOConnect::init();
849
 
        
850
 
            $sth = $dbh->prepare('
851
 
                    SELECT DISTINCT user.userId, user.userName, user.email 
852
 
                      FROM `user` 
853
 
                        INNER JOIN `lkusergroup` 
854
 
                        ON lkusergroup.userId = user.userId
855
 
                        INNER JOIN `group` 
856
 
                        ON group.groupId = lkusergroup.groupId
857
 
                        INNER JOIN `lkdisplaygroupgroup` 
858
 
                        ON lkdisplaygroupgroup.groupId = group.groupId
859
 
                        INNER JOIN `displaygroup` 
860
 
                        ON displaygroup.displayGroupId = lkdisplaygroupgroup.displayGroupId
861
 
                        INNER JOIN `lkdisplaydg` 
862
 
                        ON lkdisplaydg.displayGroupId = lkdisplaygroupgroup.displayGroupId
863
 
                     WHERE lkdisplaydg.displayId = :displayId
864
 
                ');
865
 
 
866
 
            $sth->execute(array(
867
 
                    'displayId' => $displayId
868
 
                ));
869
 
            
870
 
            // Return this list of users
871
 
            return $sth->fetchAll();
872
 
        }
873
 
        catch (Exception $e) {            
874
 
            Debug::LogEntry('error', $e->getMessage(), get_class(), __FUNCTION__);
875
 
            return false;
876
 
        }
877
 
    }
878
 
 
879
 
    /**
880
 
     * Wake On Lan Script
881
 
     *  // Version: 2
882
 
     *  // Author of this application:
883
 
     *  //  DS508_customer (http://www.synology.com/enu/forum/memberlist.php?mode=viewprofile&u=12636)
884
 
     *  //  Please inform the author of any suggestions on (the functionality, graphical design, ... of) this application.
885
 
     *  //  More info: http://wolviaphp.sourceforge.net
886
 
     *  // License: GPLv2.0
887
 
     *
888
 
     * Modified for use with the Xibo project by Dan Garner.
889
 
     */
890
 
    function TransmitWakeOnLan($mac_address, $secureon, $addr, $cidr, $port) {
891
 
        Debug::LogEntry('audit', 'IN', get_class(), __FUNCTION__);
892
 
 
893
 
        // Prepare magic packet: part 1/3 (defined constant)
894
 
        $buf = "";
895
 
        
896
 
        // the defined constant as represented in hexadecimal: FF FF FF FF FF FF (i.e., 6 bytes of hexadecimal FF)
897
 
        for ($a=0; $a<6; $a++) $buf .= chr(255); 
898
 
        
899
 
        // Check whether $mac_address is valid
900
 
        $mac_address = strtoupper($mac_address);
901
 
        $mac_address = str_replace(":", "-", $mac_address);
902
 
        
903
 
        if ((!preg_match("/([A-F0-9]{2}[-]){5}([0-9A-F]){2}/",$mac_address)) || (strlen($mac_address) != 17))
904
 
        {
905
 
            return $this->SetError(25015, __('Pattern of MAC-address is not "xx-xx-xx-xx-xx-xx" (x = digit or letter)'));
906
 
        }
907
 
        else
908
 
        {
909
 
            // Prepare magic packet: part 2/3 (16 times MAC-address)
910
 
            // Split MAC-address into an array of (six) bytes
911
 
            $addr_byte = explode('-', $mac_address); 
912
 
            $hw_addr = "";
913
 
            
914
 
            // Convert MAC-address from bytes to hexadecimal to decimal
915
 
            for ($a=0; $a<6; $a++) $hw_addr .= chr(hexdec($addr_byte[$a])); 
916
 
            
917
 
            $hw_addr_string = "";
918
 
            
919
 
            for ($a=0; $a<16; $a++) $hw_addr_string .= $hw_addr;
920
 
            $buf .= $hw_addr_string;
921
 
        }
922
 
        
923
 
        if ($secureon != "")
924
 
        {
925
 
            // Check whether $secureon is valid
926
 
            $secureon = strtoupper($secureon);
927
 
            $secureon = str_replace(":", "-", $secureon);
928
 
            
929
 
            if ((!preg_match("/([A-F0-9]{2}[-]){5}([0-9A-F]){2}/", $secureon)) || (strlen($secureon) != 17))
930
 
            {
931
 
                return $this->SetError(25015, __('Pattern of SecureOn-password is not "xx-xx-xx-xx-xx-xx" (x = digit or CAPITAL letter)'));
932
 
            }
933
 
            else
934
 
            {
935
 
                // Prepare magic packet: part 3/3 (Secureon password)
936
 
                // Split MAC-address into an array of (six) bytes
937
 
                $addr_byte = explode('-', $secureon); 
938
 
                $hw_addr = "";
939
 
                
940
 
                // Convert MAC address from hexadecimal to decimal
941
 
                for ($a=0; $a<6; $a++) $hw_addr .= chr(hexdec($addr_byte[$a])); 
942
 
                $buf .= $hw_addr;
943
 
            }
944
 
        }
945
 
        
946
 
        // Fill $addr with client's IP address, if $addr is empty
947
 
        if ($addr == "")
948
 
            return $this->SetError(25000, __('No IP Address Specified'));
949
 
        
950
 
        // Resolve broadcast address
951
 
        if (filter_var ($addr, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4)) // same as (but easier than):  preg_match("/\b(([01]?\d?\d|2[0-4]\d|25[0-5])\.){3}([01]?\d?\d|2[0-4]\d|25[0-5])\b/",$addr)
952
 
        {
953
 
            // $addr has an IP-adres format
954
 
        }
955
 
        else
956
 
        {
957
 
            return $this->SetError(25000, __('IP Address Incorrectly Formed'));
958
 
        }
959
 
        
960
 
        // If $cidr is set, replace $addr for its broadcast address
961
 
        if ($cidr != "")
962
 
        {
963
 
            // Check whether $cidr is valid
964
 
            if ((!ctype_digit($cidr)) || ($cidr < 0) || ($cidr > 32))
965
 
            {
966
 
                return $this->SetError(25015, __('CIDR subnet mask is not a number within the range of 0 till 32.'));
967
 
            }
968
 
            
969
 
            // Convert $cidr from one decimal to one inverted binary array
970
 
            $inverted_binary_cidr = "";
971
 
            
972
 
            // Build $inverted_binary_cidr by $cidr * zeros (this is the mask)
973
 
            for ($a=0; $a<$cidr; $a++) $inverted_binary_cidr .= "0"; 
974
 
            
975
 
            // Invert the mask (by postfixing ones to $inverted_binary_cidr untill 32 bits are filled/ complete)
976
 
            $inverted_binary_cidr = $inverted_binary_cidr.substr("11111111111111111111111111111111", 0, 32 - strlen($inverted_binary_cidr));
977
 
            
978
 
            // Convert $inverted_binary_cidr to an array of bits
979
 
            $inverted_binary_cidr_array = str_split($inverted_binary_cidr); 
980
 
            
981
 
            // Convert IP address from four decimals to one binary array
982
 
            // Split IP address into an array of (four) decimals
983
 
            $addr_byte = explode('.', $addr);
984
 
            $binary_addr = "";
985
 
            
986
 
            for ($a=0; $a<4; $a++)
987
 
            {
988
 
                // Prefix zeros
989
 
                $pre = substr("00000000",0,8-strlen(decbin($addr_byte[$a])));
990
 
                
991
 
                // Postfix binary decimal
992
 
                $post = decbin($addr_byte[$a]); 
993
 
                $binary_addr .= $pre.$post;
994
 
            }
995
 
            
996
 
            // Convert $binary_addr to an array of bits
997
 
            $binary_addr_array = str_split($binary_addr); 
998
 
                    
999
 
            // Perform a bitwise OR operation on arrays ($binary_addr_array & $inverted_binary_cidr_array)
1000
 
            $binary_broadcast_addr_array="";
1001
 
            
1002
 
            // binary array of 32 bit variables ('|' = logical operator 'or')
1003
 
            for ($a=0; $a<32; $a++) $binary_broadcast_addr_array[$a] = ($binary_addr_array[$a] | $inverted_binary_cidr_array[$a]);
1004
 
            
1005
 
            // build binary address of four bundles of 8 bits (= 1 byte)
1006
 
            $binary_broadcast_addr = chunk_split(implode("", $binary_broadcast_addr_array), 8, "."); 
1007
 
            
1008
 
            // chop off last dot ('.')
1009
 
            $binary_broadcast_addr = substr($binary_broadcast_addr,0,strlen($binary_broadcast_addr)-1); 
1010
 
            
1011
 
            // binary array of 4 byte variables
1012
 
            $binary_broadcast_addr_array = explode(".", $binary_broadcast_addr); 
1013
 
            $broadcast_addr_array = "";
1014
 
            
1015
 
            // decimal array of 4 byte variables
1016
 
            for ($a=0; $a<4; $a++) $broadcast_addr_array[$a] = bindec($binary_broadcast_addr_array[$a]); 
1017
 
            
1018
 
            // broadcast address
1019
 
            $addr = implode(".", $broadcast_addr_array); 
1020
 
        }
1021
 
        
1022
 
        // Check whether $port is valid
1023
 
        if ((!ctype_digit($port)) || ($port < 0) || ($port > 65536))
1024
 
            return $this->SetError(25000, __('Port is not a number within the range of 0 till 65536. Port Provided: ' . $port));
1025
 
           
1026
 
        // Check whether UDP is supported
1027
 
        if (!array_search('udp', stream_get_transports()))
1028
 
            return $this->SetError(25000, __('No magic packet can been sent, since UDP is unsupported (not a registered socket transport)'));
1029
 
        
1030
 
        // Ready to send the packet
1031
 
        if (function_exists('fsockopen'))
1032
 
        {
1033
 
            // Try fsockopen function - To do: handle error 'Permission denied'
1034
 
            $socket = fsockopen("udp://" . $addr, $port, $errno, $errstr);
1035
 
 
1036
 
            if ($socket)
1037
 
            {
1038
 
                $socket_data = fwrite($socket, $buf);
1039
 
 
1040
 
                if ($socket_data)
1041
 
                {
1042
 
                    $function = "fwrite";
1043
 
                    $sent_fsockopen = "A magic packet of ".$socket_data." bytes has been sent via UDP to IP address: ".$addr.":".$port.", using the '".$function."()' function.";
1044
 
                    $content = bin2hex($buf);
1045
 
 
1046
 
                    $sent_fsockopen = $sent_fsockopen."Contents of magic packet:".strlen($content)." ".$content;
1047
 
                    fclose($socket);
1048
 
                    
1049
 
                    unset($socket);
1050
 
                    
1051
 
                    Debug::LogEntry('audit', $sent_fsockopen, 'display', 'WakeOnLan');
1052
 
                    return true;
1053
 
                }
1054
 
                else
1055
 
                {
1056
 
                    unset($socket);
1057
 
                    
1058
 
                    return $this->SetError(25015, __('Using "fwrite()" failed, due to error: ' . $errstr.  ' ("' . $errno . '")'));
1059
 
                }
1060
 
            }
1061
 
            else
1062
 
            {
1063
 
                unset($socket);
1064
 
                
1065
 
                Debug::LogEntry('audit', __('Using fsockopen() failed, due to denied permission'));
1066
 
            }
1067
 
        }
1068
 
 
1069
 
        // Try socket_create function
1070
 
        if (function_exists('socket_create'))
1071
 
        {
1072
 
            // create socket based on IPv4, datagram and UDP
1073
 
            $socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP); 
1074
 
 
1075
 
            if ($socket)
1076
 
            {
1077
 
                // to enable manipulation of options at the socket level (you may have to change this to 1)
1078
 
                $level = SOL_SOCKET; 
1079
 
                
1080
 
                // to enable permission to transmit broadcast datagrams on the socket (you may have to change this to 6)
1081
 
                $optname = SO_BROADCAST; 
1082
 
                
1083
 
                $optval = true;
1084
 
                $opt_returnvalue = socket_set_option($socket, $level, $optname, $optval);
1085
 
 
1086
 
                if ($opt_returnvalue < 0)
1087
 
                {
1088
 
                    return $this->SetError(25015, __('Using "socket_set_option()" failed, due to error: ' . socket_strerror($opt_returnvalue)));
1089
 
                }
1090
 
 
1091
 
                $flags = 0;
1092
 
 
1093
 
                // To do: handle error 'Operation not permitted'
1094
 
                $socket_data = socket_sendto($socket, $buf, strlen($buf), $flags, $addr, $port);
1095
 
 
1096
 
                if ($socket_data)
1097
 
                {
1098
 
                    $function = "socket_sendto";
1099
 
                    $socket_create = "A magic packet of ". $socket_data . " bytes has been sent via UDP to IP address: ".$addr.":".$port.", using the '".$function."()' function.<br>";
1100
 
 
1101
 
                    $content = bin2hex($buf);
1102
 
                    $socket_create = $socket_create . "Contents of magic packet:" . strlen($content) ." " . $content;
1103
 
 
1104
 
                    socket_close($socket);
1105
 
                    unset($socket);
1106
 
 
1107
 
                    Debug::LogEntry('audit', $socket_create, 'display', 'WakeOnLan');
1108
 
                    return true;
1109
 
                }
1110
 
                else
1111
 
                {
1112
 
                    $error = "Using 'socket_sendto()' failed, due to error: '".socket_strerror(socket_last_error($socket))."' (".socket_last_error($socket).")<br>\n";
1113
 
                    socket_close($socket);
1114
 
                    unset($socket);
1115
 
 
1116
 
                    return $this->SetError(25015, __('Using "socket_sendto()" failed, due to error: ' . socket_strerror(socket_last_error($socket)) . ' (' . socket_last_error($socket) . ')'));
1117
 
                }
1118
 
            }
1119
 
            else
1120
 
            {
1121
 
                return $this->SetError(25015, __('Using "socket_sendto()" failed, due to error: ' . socket_strerror(socket_last_error($socket)) . ' (' . socket_last_error($socket) . ')'));
1122
 
            }
1123
 
        }
1124
 
        else
1125
 
        {
1126
 
            return $this->SetError(25015, __('Wake On Lan Failed as there are no functions available to transmit it'));
1127
 
        }
1128
 
    }
1129
 
}
1130
 
?>