summaryrefslogtreecommitdiffstats
path: root/src/usr/local/www/widgets/widgets/ntp_status.widget.php
blob: c23a02f73d180620d50b1566cf3dae4f81920dc2 (plain)
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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
<?php
/*
 * ntp_status.widget.php
 *
 * part of pfSense (https://www.pfsense.org)
 * Copyright (c) 2004-2016 Rubicon Communications, LLC (Netgate)
 * All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

$nocsrf = true;

require_once("guiconfig.inc");
require_once("pfsense-utils.inc");
require_once("functions.inc");

require_once("/usr/local/www/widgets/include/ntp_status.inc");

function getServerDateItems($inDate) {
	return date('Y,n,j,G,', $inDate) . intval(date('i', $inDate)) . ',' . intval(date('s', $inDate));
	// year (4-digit),month,day,hours (0-23),minutes,seconds
	// use intval to strip leading zero from minutes and seconds
	// so JavaScript won't try to interpret them in octal
	// (use intval instead of ltrim, which translates '00' to '')
}

function clockTimeString($inDate, $showSeconds) {
	return date($showSeconds ? 'G:i:s' : 'g:i', $inDate) . ' ';
}

// For this widget the update period is 6 x larger than most others. It typically defaults
// to once per 60 seconds, not once per 10 seconds
$widgetperiod = isset($config['widgets']['period']) ? $config['widgets']['period'] * 1000 * 6 : 60000;

if ($_REQUEST['updateme']) {
//this block displays only on ajax refresh
	if (isset($config['system']['ipv6allow'])) {
		$inet_version = "";
	} else {
		$inet_version = " -4";
	}

	exec("/usr/local/sbin/ntpq -pn $inet_version | /usr/bin/tail +3", $ntpq_output);
	$ntpq_counter = 0;
	$stratum_text = gettext("stratum");
	foreach ($ntpq_output as $line) {
		if (substr($line, 0, 1) == "*") {
			//Active NTP Peer
			$line = substr($line, 1);
			$peerinfo = preg_split("/[\s\t]+/", $line);
			if ($peerinfo[2] == "1") {
				$syncsource = $peerinfo[0] . " (" . $stratum_text . " " . $peerinfo[2] . ", " . $peerinfo[1] . ")";
			} else {
				$syncsource = $peerinfo[0] . " (" . $stratum_text . " " . $peerinfo[2] . ")";
			}
			$ntpq_counter++;
		} elseif (substr($line, 0, 1) == "o") {
			//Local PPS Peer
			$line = substr($line, 1);
			$peerinfo = preg_split("/[\s\t]+/", $line);
			$syncsource = $peerinfo[1] . " (" . $stratum_text . " " . $peerinfo[2] . ", PPS)";
			$ntpq_counter++;
		}
	}

	exec("/usr/local/sbin/ntpq -c clockvar $inet_version", $ntpq_clockvar_output);
	foreach ($ntpq_clockvar_output as $line) {
		if (substr($line, 0, 9) == "timecode=") {
			$tmp = explode('"', $line);
			$tmp = $tmp[1];
			if (substr($tmp, 0, 6) == '$GPRMC') {
				$gps_vars = explode(",", $tmp);
				$gps_ok	= ($gps_vars[2] == "A");
				$gps_lat_deg = substr($gps_vars[3], 0, 2);
				$gps_lat_min = substr($gps_vars[3], 2) / 60.0;
				$gps_lon_deg = substr($gps_vars[5], 0, 3);
				$gps_lon_min = substr($gps_vars[5], 3) / 60.0;
				$gps_lat = $gps_lat_deg + $gps_lat_min;
				$gps_lat = $gps_lat * (($gps_vars[4] == "N") ? 1 : -1);
				$gps_lon = $gps_lon_deg + $gps_lon_min;
				$gps_lon = $gps_lon * (($gps_vars[6] == "E") ? 1 : -1);
				$gps_la = $gps_vars[4];
				$gps_lo = $gps_vars[6];
			} elseif (substr($tmp, 0, 6) == '$GPGGA') {
				$gps_vars = explode(",", $tmp);
				$gps_ok	= $gps_vars[6];
				$gps_lat_deg = substr($gps_vars[2], 0, 2);
				$gps_lat_min = substr($gps_vars[2], 2) / 60.0;
				$gps_lon_deg = substr($gps_vars[4], 0, 3);
				$gps_lon_min = substr($gps_vars[4], 3) / 60.0;
				$gps_lat = $gps_lat_deg + $gps_lat_min;
				$gps_lat = $gps_lat * (($gps_vars[3] == "N") ? 1 : -1);
				$gps_lon = $gps_lon_deg + $gps_lon_min;
				$gps_lon = $gps_lon * (($gps_vars[5] == "E") ? 1 : -1);
				$gps_alt = $gps_vars[9];
				$gps_alt_unit = $gps_vars[10];
				$gps_sat = $gps_vars[7];
				$gps_la = $gps_vars[3];
				$gps_lo = $gps_vars[5];
			} elseif (substr($tmp, 0, 6) == '$GPGLL') {
				$gps_vars = explode(",", $tmp);
				$gps_ok	= ($gps_vars[6] == "A");
				$gps_lat_deg = substr($gps_vars[1], 0, 2);
				$gps_lat_min = substr($gps_vars[1], 2) / 60.0;
				$gps_lon_deg = substr($gps_vars[3], 0, 3);
				$gps_lon_min = substr($gps_vars[3], 3) / 60.0;
				$gps_lat = $gps_lat_deg + $gps_lat_min;
				$gps_lat = $gps_lat * (($gps_vars[2] == "N") ? 1 : -1);
				$gps_lon = $gps_lon_deg + $gps_lon_min;
				$gps_lon = $gps_lon * (($gps_vars[4] == "E") ? 1 : -1);
				$gps_la = $gps_vars[2];
				$gps_lo = $gps_vars[4];
			}
		}
	}

	if (isset($config['ntpd']['gps']['type']) && ($config['ntpd']['gps']['type'] == 'SureGPS') && (isset($gps_ok))) {
		//GSV message is only enabled by init commands in services_ntpd_gps.php for SureGPS board
		$gpsport = fopen("/dev/gps0", "r+");
		while ($gpsport) {
			$buffer = fgets($gpsport);
			if (substr($buffer, 0, 6) == '$GPGSV') {
				//echo $buffer."\n";
				$gpgsv = explode(',', $buffer);
				$gps_satview = $gpgsv[3];
				break;
			}
		}
	}
?>

<table id="ntp_status_widget" class="table table-striped table-hover">
	<tr>
		<th><?=gettext('Server Time')?></th>
		<td id="ClockTime"> <!-- ntpStatusClock -->
			<script type="text/javascript">
			//<![CDATA[
			var ntpServerTime = new Date('<?=date_format(date_create(), 'c')?>');
			//]]>
			</script>
			<!-- display initial value before javascript takes over -->
			<?=gmdate('D j Y H:i:s \G\M\T O (T)');?>
		</td>
	</tr>
	<tr>
		<th><?=gettext('Sync Source')?></th>
		<td>
		<?php if ($ntpq_counter == 0): ?>
			<i><?=gettext('No active peers available')?></i>
		<?php else: ?>
			<?=$syncsource;?>
		<?php endif; ?>
		</td>
	</tr>
	<?php if (($gps_ok) && ($gps_lat) && ($gps_lon)): ?>
		<tr>
			<th><?=gettext('Clock location')?></th>
			<td>
				<a target="_gmaps" href="http://maps.google.com/?q=<?=$gps_lat;?>,<?=$gps_lon;?>">
				<?php
				echo sprintf("%.5f", $gps_lat) . " " . $gps_la . ", " . sprintf("%.5f", $gps_lon) . " " . $gps_lo; ?>
				</a>
				<?php if (isset($gps_alt)) {echo " (" . $gps_alt . " " . $gps_alt_unit . " alt.)";} ?>
			</td>
		</tr>
		<?php if (isset($gps_sat) || isset($gps_satview)): ?>
			<tr>
				<th><?=gettext('Satellites')?></th>
				<td>
				<?php
				if (isset($gps_satview)) {echo gettext('in view') . ' ' . intval($gps_satview);}
				if (isset($gps_sat) && isset($gps_satview)) {echo ', ';}
				if (isset($gps_sat)) {echo gettext('in use') . ' ' . $gps_sat;}
				?>
				</td>
			</tr>
		<?php endif; ?>
	<?php endif; ?>
</table>

<?php
	exit;
}
?>
<script type="text/javascript">
//<![CDATA[
function ntpWidgetUpdateFromServer() {
	$.ajax({
		type: 'get',
		url: '/widgets/widgets/ntp_status.widget.php',
		dataFilter: function(raw){
			// We reload the entire widget, strip this block of javascript from it
			return raw.replace(/<script>([\s\S]*)<\/script>/gi, '');
		},
		dataType: 'html',
		success: function(data){
			console.log(data);
			$('#ntp_status_widget').html(data);
		}
	});
}

function ntpWidgetUpdateDisplay() {
	// Javascript handles overflowing
	ntpServerTime.setSeconds(ntpServerTime.getSeconds()+1);

	$('#ntpStatusClock').html(ntpServerTime.toString());
}
//]]>
</script>

<script type="text/javascript">
//<![CDATA[
/* set up variables used to init clock in BODY's onLoad handler;
   should be done as early as possible */
var clockLocalStartTime = new Date();
var clockServerStartTime = new Date(<?php echo(getServerDateItems($gDate))?>);

/* stub functions for older browsers;
   will be overridden by next JavaScript1.2 block */
function clockInit() {
}
//]]>
</script>

<script type="text/javascript">
//<![CDATA[
/*** simpleFindObj, by Andrew Shearer

Efficiently finds an object by name/id, using whichever of the IE,
classic Netscape, or Netscape 6/W3C DOM methods is available.
The optional inLayer argument helps Netscape 4 find objects in
the named layer or floating DIV. */
function simpleFindObj(name, inLayer) {
	return document[name] || (document.all && document.all[name])
		|| (document.getElementById && document.getElementById(name))
		|| (document.layers && inLayer && document.layers[inLayer].document[name]);
}

/*** Beginning of Clock 2.1.2, by Andrew Shearer
See: http://www.shearersoftware.com/software/web-tools/clock/
Redistribution is permitted with the above notice intact.

Client-side clock, based on computed time differential between browser &
server. The server time is inserted by server-side JavaScript, and local
time is subtracted from it by client-side JavaScript while the page is
loading.

Cookies: The local and remote times are saved in cookies named
localClock and remoteClock, so that when the page is loaded from local
cache (e.g. by the Back button) the clock will know that the embedded
server time is stale compared to the local time, since it already
matches its cookie. It can then base the calculations on both cookies,
without reloading the page from the server. (IE 4 & 5 for Windows didn't
respect Response.Expires = 0, so if cookies weren't used, the clock
would be wrong after going to another page then clicking Back. Netscape
& Mac IE were OK.)

Every so often (by default, one hour) the clock will reload the page, to
make sure the clock is in sync (as well as to update the rest of the
page content).

Compatibility: IE 4.x and 5.0, Netscape 4.x and 6.0, Mozilla 1.0. Mac & Windows.

History:  1.0	2000-05-09 GIF-image digits
		  2.0	2000-06-29 Uses text DIV layers (so 4.0 browsers req'd), &
						 cookies to work around Win IE stale-time bug
		  2.1	2002-10-12 Noted Mozilla 1.0 compatibility; released PHP version.
		  2.1.1 2002-10-20 Fixed octal bug in the PHP translation; the number of
						minutes & seconds were misinterpreted when less than 10
		  2.1.2 2003-08-07 The previous fix had introduced a bug when the
						minutes or seconds were exactly 0. Thanks to Man Bui
						for reporting the bug.
*/
var clockIncrementMillis = 1000;
var localTime;
var clockOffset;
var clockExpirationLocal;
var clockShowsSeconds = true;
var clockTimerID = null;

function clockInit(localDateObject, serverDateObject)
{
	var origRemoteClock = parseInt(clockGetCookieData("remoteClock"));
	var origLocalClock = parseInt(clockGetCookieData("localClock"));
	var newRemoteClock = serverDateObject.getTime();
	// May be stale (WinIE); will check against cookie later
	// Can't use the millisec. ctor here because of client inconsistencies.
	var newLocalClock = localDateObject.getTime();
	var maxClockAge = 60 * 60 * 1000;	// get new time from server every 1hr

	if (newRemoteClock != origRemoteClock) {
		// new clocks are up-to-date (newer than any cookies)
		document.cookie = "remoteClock=" + newRemoteClock;
		document.cookie = "localClock=" + newLocalClock;
		clockOffset = newRemoteClock - newLocalClock;
		clockExpirationLocal = newLocalClock + maxClockAge;
		localTime = newLocalClock;	// to keep clockUpdate() happy
	} else if (origLocalClock != origLocalClock) {
		// error; localClock cookie is invalid (parsed as NaN)
		clockOffset = null;
		clockExpirationLocal = null;
	} else {
		// fall back to clocks in cookies
		clockOffset = origRemoteClock - origLocalClock;
		clockExpirationLocal = origLocalClock + maxClockAge;
		localTime = origLocalClock;
		// so clockUpdate() will reload if newLocalClock
		// is earlier (clock was reset)
	}
	/* Reload page at server midnight to display the new date,
	   by expiring the clock then */
	var nextDayLocal = (new Date(serverDateObject.getFullYear(),
			serverDateObject.getMonth(),
			serverDateObject.getDate() + 1)).getTime() - clockOffset;
	if (nextDayLocal < clockExpirationLocal) {
		clockExpirationLocal = nextDayLocal;
	}
}

function clockOnLoad()
{
	clockUpdate();
}

function clockOnUnload() {
	clockClearTimeout();
}

function clockClearTimeout() {
	if (clockTimerID) {
		clearTimeout(clockTimerID);
		clockTimerID = null;
	}
}

function clockToggleSeconds()
{
	clockClearTimeout();
	if (clockShowsSeconds) {
		clockShowsSeconds = false;
		clockIncrementMillis = 60000;
	} else {
		clockShowsSeconds = true;
		clockIncrementMillis = 1000;
	}
	clockUpdate();
}

function clockTimeString(inHours, inMinutes, inSeconds) {
	return inHours
	+ (inMinutes < 10 ? ":0" : ":") + inMinutes
	+ (inSeconds < 10 ? ":0" : ":") + inSeconds;
}

function clockDisplayTime(inHours, inMinutes, inSeconds) {
	clockWriteToDiv("ClockTime", clockTimeString(inHours, inMinutes, inSeconds));
}

function clockWriteToDiv(divName, newValue) // APS 6/29/00
{
	var divObject = simpleFindObj(divName);
	newValue =	newValue + ' (' + new Date().toString().match(/([A-Z]+[\+-][0-9]+)/)[1] + ')';
	if (divObject && divObject.innerHTML) {
		divObject.innerHTML = newValue;
	} else if (divObject && divObject.document) {
		divObject.document.writeln(newValue);
		divObject.document.close();
	}
	// else divObject wasn't found; it's only a clock, so don't bother complaining
}

function clockGetCookieData(label) {
	/* find the value of the specified cookie in the document's
	semicolon-delimited collection. For IE Win98 compatibility, search
	from the end of the string (to find most specific host/path) and
	don't require "=" between cookie name & empty cookie values. Returns
	null if cookie not found. One remaining problem: Under IE 5 [Win98],
	setting a cookie with no equals sign creates a cookie with no name,
	just data, which is indistinguishable from a cookie with that name
	but no data but can't be overwritten by any cookie with an equals
	sign. */
	var c = document.cookie;
	if (c) {
		var labelLen = label.length, cEnd = c.length;
		while (cEnd > 0) {
			var cStart = c.lastIndexOf(';',cEnd-1) + 1;
			/* bug fix to Danny Goodman's code: calculate cEnd, to
			prevent walking the string char-by-char & finding cookie
			labels that contained the desired label as suffixes */
			// skip leading spaces
			while (cStart < cEnd && c.charAt(cStart)==" ") {
				cStart++;
			}
			if (cStart + labelLen <= cEnd && c.substr(cStart,labelLen) == label) {
				if (cStart + labelLen == cEnd) {
					return ""; // empty cookie value, no "="
				} else if (c.charAt(cStart+labelLen) == "=") {
					// has "=" after label
					return unescape(c.substring(cStart + labelLen + 1,cEnd));
				}
			}
			cEnd = cStart - 1;	// skip semicolon
		}
	}
	return null;
}

/* Called regularly to update the clock display as well as onLoad (user
   may have clicked the Back button to arrive here, so the clock would need
   an immediate update) */
function clockUpdate()
{
	var lastLocalTime = localTime;
	localTime = (new Date()).getTime();

	// Sanity-check the diff. in local time between successive calls;
	//	 reload if user has reset system clock
	if (clockOffset == null) {
		clockDisplayTime(null, null, null);
	} else if (localTime < lastLocalTime || clockExpirationLocal < localTime) {
		// Clock expired, or time appeared to go backward (user reset
		// the clock). Reset cookies to prevent infinite reload loop if
		// server doesn't give a new time.
		document.cookie = 'remoteClock=-';
		document.cookie = 'localClock=-';
		location.reload();		// will refresh time values in cookies
	} else {
		// Compute what time would be on server
		var serverTime = new Date(localTime);
		clockDisplayTime(serverTime.getHours(), serverTime.getMinutes(),
			serverTime.getSeconds());

		// Reschedule this func to run on next even clockIncrementMillis boundary
		clockTimerID = setTimeout("clockUpdate()",
			clockIncrementMillis - (serverTime.getTime() % clockIncrementMillis));
	}
}

/*** End of Clock ***/
window.onload=clockInit(clockLocalStartTime, clockServerStartTime);clockOnLoad();
window.onunload=clockOnUnload()
clockUpdate();
//]]>
</script>

<table id="ntpstatus" class="table table-striped table-hover">
	<tbody>
		<tr>
			<td>
				<?=gettext('Updating...')?>
			</td>
		</tr>
	</tbody>
</table>

<script type="text/javascript">
//<![CDATA[
	function ntp_getstatus() {
		scroll(0,0);
		var url = "/widgets/widgets/ntp_status.widget.php";
		var pars = 'updateme=yes';
		$.ajax(
			url,
			{
				type: 'get',
				data: pars,
				complete: ntpstatuscallback
			});
	}

	function ntpstatuscallback(transport) {
		// The server returns formatted html code
		var responseStringNtp = transport.responseText
		$('#ntpstatus').prop('innerHTML',responseStringNtp);

		// Refresh the status at the configured interval
		setTimeout('ntp_getstatus()', "<?=$widgetperiod?>");
	}

	// Start polling for updates some small random number of seconds from now (so that all the widgets don't
	// hit the server at exactly the same time)
	setTimeout(ntp_getstatus, Math.floor((Math.random() * 10000) + 1000));

//]]>
</script>
OpenPOWER on IntegriCloud