-
Notifications
You must be signed in to change notification settings - Fork 7
/
ITpings_connector.php
1302 lines (1128 loc) · 39.5 KB
/
ITpings_connector.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
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
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/* In a decent IDE, press Ctrl+Shift+Minus to collapse all code blocks */
include('ITpings_configuration.php');
include('ITpings_sensor_triggers.php');
include('ITpings__database_views.php');
include('ITpings__database_queries.php');
include('ITpings__database_maintenance.php');
//region ===== HELPER FUNCTIONS ===================================================================
/**
* Check if $haystack contains $needle
* @param $haystack
* @param $needle
* @return bool
*/
function contains($haystack, $needle)
{
return strpos($haystack, $needle) !== FALSE;
}
/**
* brutal approach against SQL injection attempts in QueryString Parameters
* Return first element after split on 'illegal' SQL characters
* @param $str
* @return mixed
*/
function SQL_InjectionSave_OneWordString($str)
{
return preg_split("/[&=:;]/", $str)[0];
}
/**
* Test if a Lat/Lon location has decimals, to filter (fake) entries like 10,20
* @param $lat
* @param $lon
* @return bool - TRUE when $lat and $lon have no decimals (most likely a fake location)
*/
function is_Location_without_Decimals($lat, $lon)
{
return (floor($lat) == $lat AND floor($lon) == $lon);
}
//endregion == HELPER FUNCTIONS ===================================================================
//region ===== MYSQL DATABASE ACCESS ==============================================================
/**
* Global MySQL connection with settings from IT_pings_configuration.php
**/
$MySQL_DB_Connection = mysqli_connect(DBHOST, DBUSERNAME, DBPASSWORD, DBNAME);
if (mysqli_connect_errno()) {
die("Failed to connect to MySQL: " . mysqli_connect_error());
}
/**
* Building a single JSON response structure
* so we can easily return any info we need (like ALL the max(_pingid) count from multiple tables
*/
$JSON_response = array();
$JSON_response[QUERYKEY_ip] = PING_ORIGIN;
$JSON_response[QUERYKEY_mysqlversion] = mysqli_get_server_info($MySQL_DB_Connection);
$JSON_response[QUERYKEY_timezone] = date_default_timezone_get();//ini_get('date.timezone');
$JSON_response[QUERYKEY_rowcount] = 0;
$JSON_response[QUERY_PARAMETER_MAXROWS] = FALSE;
$JSON_response[QUERYKEY_skipcount] = 0;
$JSON_response[QUERYKEY_querytime] = FALSE;
$JSON_response[QUERYKEY_sql] = FALSE;
$JSON_response[QUERYKEY_messages] = [];
$JSON_response[QUERYKEY_errors] = [];
$JSON_response[QUERYKEY_maxids] = FALSE;
$JSON_response[QUERYKEY_result] = FALSE;
/**
* Record how long the PHP processing took
* Return JSON data to the document output
*/
function return_JSON_response()
{
global $JSON_response;
$JSON_response[QUERYKEY_querytime] = microtime(true) - $JSON_response[QUERYKEY_querytime];
print json_encode($JSON_response);
}
/**
* Clean up JSON structure when the data isn't required
* The declarations were added to the Top of the document before, so the user sees them at the Top of the document (and does not have to scroll down)
*/
function remove_no_longer_required_keys_from_JSON_response()
{
global $JSON_response;
unset($JSON_response[QUERYKEY_mysqlversion]);
unset($JSON_response[QUERYKEY_timezone]);
unset($JSON_response[QUERYKEY_ip]);
unset($JSON_response[QUERYKEY_rowcount]);
unset($JSON_response[QUERY_PARAMETER_MAXROWS]);
unset($JSON_response[QUERYKEY_querytime]);
unset($JSON_response[QUERYKEY_skipcount]);
unset($JSON_response[QUERYKEY_messages]);
unset($JSON_response[QUERYKEY_errors]);
unset($JSON_response[QUERYKEY_result]);
unset($JSON_response[$JSON_response[QUERYKEY_sql]]);
}
/**
* add every error to the error Array
* @param $error - String
*/
function add_JSON_error_to_JSON_response($error)
{
global $JSON_response;
array_push($JSON_response[QUERYKEY_errors], $error);
}
/**
* Add every text msg to the messages array
* @param $msg - String
*/
function add_JSON_message_to_JSON_response($msg)
{
global $JSON_response;
array_push($JSON_response['messages'], $msg);
}
/**
* Loop over MySQL result removing rows so the total result is $maxrows
*
* @param $result
* @param $maxrows
* @return array
*/
function skip_every_Nth_row_From_SQL_result($result, $maxrows)
{
global $JSON_response;
/**
* It is faster to filter with PHP for the SQL result on every Nth row,
* doing it with SQL takes 20% to 100%+ longer
**/
// SELECT *
// FROM (
// SELECT
// @row := @row +1 AS rownum, _pingid
// FROM (
// SELECT @row :=0) r, ITpings__SensorValues
// ) ranked
// WHERE rownum % 4 = 1
$rows = array();
$rowcount = mysqli_num_rows($result);
$JSON_response[QUERY_PARAMETER_MAXROWS] = (int)$maxrows;
$Nth_row = ceil($rowcount / $maxrows);// to do: offset error, maxrows=200 returns 199, make sure first and last row element are always added
$rowcount = 0;
$skipped_rowcount = 0;
$index = 0;
$lastrow = false;
while ($row = mysqli_fetch_assoc($result)) {
$this_is_Nth_row = ($index % $Nth_row) === 0;
if ($this_is_Nth_row OR $index === 0) {
$rows[] = $row;
$rowcount++;
} else {
$skipped_rowcount++;
}
$lastrow = $row; // bug: rowcount and skipped_rowcount is 1 off when the lastrow === Nth row
$index++;
}
if ($lastrow) $rows[] = $lastrow;
$JSON_response['QUERYKEY_skipcount'] = $skipped_rowcount;
add_JSON_message_to_JSON_response("PHP Function skip_every_Nth_row_From_SQL_result() Skipped $skipped_rowcount rows from the result, so the JSON response returns $maxrows rows");
return $rows;
}
/**
* Execute $sql query, returning rows or undefined
* @param $sql
* @return bool|mysqli_result
*/
function SQL_QUERY_ROWS($sql)
{
global $MySQL_DB_Connection;
insert_TTN_Event(ENUM_EVENTTYPE_Log, 'SQL', $sql);
$result = mysqli_query($MySQL_DB_Connection, $sql);
if (!$result) {
$error = mysqli_error($MySQL_DB_Connection);
add_JSON_error_to_JSON_response($error);
}
return $result;
}
/**
* Execute a SQL delete statement,
* adding SQL statement to Event and the JSON Output (always handy for enduser)
* @param $sql
* @return bool|mysqli_result
*/
function SQL_DELETE($sql, $addEvent = true)
{
global $MySQL_DB_Connection;
if ($addEvent) insert_TTN_Event(ENUM_EVENTTYPE_Log, 'SQL', $sql);
add_JSON_message_to_JSON_response($sql);
$result = mysqli_query($MySQL_DB_Connection, $sql);
if (!$result) {
$error = mysqli_error($MySQL_DB_Connection);
add_JSON_error_to_JSON_response($error);
}
return $result;
}
function SQL_MULTI_QUERY($sql, $addEvent = true)
{
global $MySQL_DB_Connection;
if ($addEvent) insert_TTN_Event(ENUM_EVENTTYPE_Log, 'SQL', $sql);
add_JSON_message_to_JSON_response($sql);
$result = mysqli_multi_query($MySQL_DB_Connection, $sql);
if (!$result) {
$error = mysqli_error($MySQL_DB_Connection);
add_JSON_error_to_JSON_response($error);
}
return $result;
}
/**
* Main SQL query function
*
* RETURNS FIRST!!!! ROW OR JSON ENCODED OUTPUT
*
* @param $sql
* @param bool $returnJSON
* @return array|int|null|string
*
*/
function SQL_Query($sql, $returnJSON = FALSE)
{
global $MySQL_DB_Connection;
global $JSON_response;
global $QueryStringParameters;
global $_ITPINGS_VIEWNAMES;
//$JSON_response[QUERYKEY_sql] = shortenTableName($sql);
$JSON_response[QUERYKEY_sql] = $sql;
$JSON_response[QUERYKEY_querytime] = microtime(true);
$result = mysqli_query($MySQL_DB_Connection, $sql);
if ($result) {
if ($returnJSON) {
$maxrows = $QueryStringParameters[QUERY_PARAMETER_MAXROWS] ?? 0;
$rows = array();
if ($maxrows) {
$rows = skip_every_Nth_row_From_SQL_result($result, $maxrows);
} else {
while ($row = mysqli_fetch_assoc($result)) {
$rows[] = $row;
}
}
$JSON_response[QUERYKEY_rowcount] = sizeof($rows);
// http://nitschinger.at/Handling-JSON-like-a-boss-in-PHP/
//header('Content-type: application/json');
$JSON_response[QUERYKEY_result] = $rows;
return_JSON_response();
} else {
return (gettype($result) === 'boolean') ? $result : mysqli_fetch_assoc($result); // return boolean OR first $row
}
} else {
$error = mysqli_error($MySQL_DB_Connection);
add_JSON_error_to_JSON_response($error);
if (contains($error, "doesn't exist")) {
$queryName = TABLE_PREFIX . $QueryStringParameters['query'];
if (in_array($queryName, $_ITPINGS_VIEWNAMES)) {
$JSON_response['createorreplaceview'] = Create_Or_Replace_View($queryName);
}
}
return_JSON_response();
}
return false;
}
/**
* @param $view_name
* @param $sql
* @return bool|mysqli_result
*/
function SQL_CREATE_or_REPLACE_VIEW($view_name, $sql)
{
global $MySQL_DB_Connection;
insert_TTN_Event(ENUM_EVENTTYPE_NewView, $view_name, $sql);
$result = mysqli_query($MySQL_DB_Connection, $sql);
if (!$result) {
$error = mysqli_error($MySQL_DB_Connection);
add_JSON_error_to_JSON_response($error);
}
return $result;
}
/**
* @param $table_name
* @param $fieldvalues
*
* @return number = Primary key for new Table entry
*/
function SQL_INSERT($table_name, $fieldvalues)
{
global $MySQL_DB_Connection;
$sql = "INSERT INTO $table_name VALUES ( " . implode(COMMA, $fieldvalues) . ");";
$result = mysqli_query($MySQL_DB_Connection, $sql);
return ($result) ? mysqli_insert_id($MySQL_DB_Connection) : 0;
}
/**
* @param $str
* @return string
*/
function SQL_EscapeString($str)
{
global $MySQL_DB_Connection;
//https://www.npmjs.com/package/mysql#escaping-query-values
return mysqli_real_escape_string($MySQL_DB_Connection, $str);
}
/**
* @param $val
* @param string $quote
* @return string
* Quote a given $val
*/
function Quoted($val, $quote = "'")
{
return (isset($val) OR $val == 0) ? $quote . SQL_EscapeString($val) . $quote : "NULL";
}
/**
* @param $val
* @return string
* (not) quote numbers
*/
function Valued($val)
{
return Quoted($val, EMPTY_STRING); // No quotes
}
//endregion == MYSQL DATABASE ACCESS ==============================================================
//region ===== CREATE ITPINGS DATABASE : TABLES ===================================================
/**
* @param $table_name
* @param $primary_key_name - can be False to indicate this table has NO primary key
* @param $primary_key_type
* @param $fields - array of ['fieldname','fieldtype','fieldcomment']
* @param $foreignkeys - array of ['foreignkeyname','declaration']
* @return bool|mysqli_result
*/
function create_Table($table_name, $primary_key_name, $primary_key_type, $fields, $foreignkeys)
{
global $MySQL_DB_Connection;
$sql = "CREATE TABLE IF NOT EXISTS $table_name";
$sql .= " (";
// add Primary Key field (not all tables have Primary Keys)
if ($primary_key_name) {
$sql .= "$primary_key_name $primary_key_type UNSIGNED NOT NULL UNIQUE AUTO_INCREMENT COMMENT 'ITpings Primary Key' , ";
}
//add Table fields
if (is_array($fields) || is_object($fields)) {
foreach ($fields as $index => $field) {
if ($index > 0) $sql .= " , ";
$sql .= " $field[0] $field[1] COMMENT '$field[2]'";
}
}
// add Foreign Keys
if (is_array($foreignkeys) || is_object($foreignkeys)) {
foreach ($foreignkeys as $index => $key) {
$sql .= " , FOREIGN KEY ($key[0]) $key[1]";
}
}
// add Primary Key
if ($primary_key_name) {
$sql .= " , PRIMARY KEY ($primary_key_name)";
}
$sql .= ") ENGINE=InnoDB DEFAULT CHARSET=utf8;";
insert_TTN_Event(ENUM_EVENTTYPE_NewTable, $table_name, $sql);
return mysqli_query($MySQL_DB_Connection, $sql);
}
/**
* create Lookup Table (Frequencies,Moldulations,Datarates,Codingrates,Location)
* @param $table
* @param $primary_key_name
* @param $field_name
* @param $field_datatype
* @return array
*/
function create_LookupTable($table, $primary_key_name, $field_name, $field_datatype)
{
create_Table($table
, $primary_key_name
, TYPE_FOREIGNKEY_LOOKUPTABLE
, [[$field_name, $field_datatype, "TTN " . $field_name]]
, NO_FOREIGNKEYS
);
// return declaration for Lookup table
return [
$primary_key_name
, TYPE_FOREIGNKEY_LOOKUPTABLE
, " REFERENCES " . $table];
}
/**
* Create dedicated data table to store Sensor values (Temperature, Light, Battery)
* @param $table
*/
function create_DataTable($table, $valuefieldDefinition)
{
global $_DBFIELD_APPLICATION_DEVICE;
global $_FOREIGNKEY_APPLICATIONDEVICES;
create_Table($table
, PRIMARYKEY_Ping
, TYPE_FOREIGNKEY
, [//Fields
$_DBFIELD_APPLICATION_DEVICE
, $valuefieldDefinition
]
, [$_FOREIGNKEY_APPLICATIONDEVICES]
);
}
/** Create Database Schema with tables:
* events
* origins
* locations
* frequencies
* modulations
* data_rates
* coding_rates
* applications
* devices
* gateways
* pings
* pingedgateways
* sensors
* sensorvalues
* POSTrequests
**/
function create_ITpings_Tables()
{
//bit dirty, in strict PHP defines can not be Arrays, so they (arrays) are declared as Global variables
global $_DBFIELD_EVENTTYPE;
global $_DBFIELD_EVENTLABEL;
global $_DBFIELD_EVENTVALUE;
global $_DBFIELD_PRIMARYKEY_APPLICATION;
global $_DBFIELD_PRIMARYKEY_DEVICE;
global $_DBFIELD_POST_BODY;
global $_DBFIELD_APPLICATION_ID;
global $_DBFIELD_APPLICATION_DESCRIPTION;
global $_DBFIELD_DEVICE_ID;
global $_DBFIELD_HARDWARE_SERIAL;
global $_DBFIELD_LATITUDE;
global $_DBFIELD_LONGITUDE;
global $_DBFIELD_ALTITUDE;
global $_DBFIELD_LOCATION_SOURCE;
global $_DBFIELD_GATEWAY_ID;
global $_DBFIELD_TRUSTED_GATEWAY;
global $_DBFIELD_LOCATION;
global $_DBFIELD_CREATED_TIMESTAMP;
global $_DBFIELD_APPLICATION_DEVICE;
global $_DBFIELD_PORT;
global $_DBFIELD_FRAME_COUNTER;
global $_DBFIELD_DOWNLINKURL;
global $_DBFIELD_PAYLOAD_RAW;
global $_DBFIELD_PINGED_GATEWAY_TIMESTAMP;
global $_DBFIELD_ITPINGS_TIME;
global $_DBFIELD_CHANNEL;
global $_DBFIELD_RSSI;
global $_DBFIELD_SNR;
global $_DBFIELD_RFCHAIN;
global $_DBFIELD_SENSORNAME;
global $_DBFIELD_PRIMARYKEY_PING;
global $_DBFIELD_PRIMARYKEY_SENSOR;
global $_DBFIELD_SENSORVALUE;
global $_FOREIGNKEY_APPLICATIONS;
global $_FOREIGNKEY_DEVICES;
global $_FOREIGNKEY_APPLICATIONDEVICES;
global $_FOREIGNKEY_PINGS;
global $_FOREIGNKEY_GATEWAYS;
global $_FOREIGNKEY_SENSORS;
global $_FOREIGNKEY_LOCATIONS;
create_Table(TABLE_EVENTS
, NO_PRIMARYKEY
, FALSE
, [//Fields
$_DBFIELD_PRIMARYKEY_PING
, $_DBFIELD_EVENTTYPE
, $_DBFIELD_EVENTLABEL
, $_DBFIELD_EVENTVALUE
]
, NO_FOREIGNKEYS/** No Foreign Key so the Events table can be used for any entry **/
);
if (SAVE_POST_AS_ONE_STRING) {
create_Table(TABLE_POSTREQUESTS
, PRIMARYKEY_POSTrequests
, TYPE_FOREIGNKEY
, [//Fields
PRIMARYKEY_Ping,
$_DBFIELD_POST_BODY
]
, [$_FOREIGNKEY_PINGS]
);
}
create_Table(TABLE_APPLICATIONS
, PRIMARYKEY_Application
, TYPE_FOREIGNKEY
, [$_DBFIELD_APPLICATION_ID
, $_DBFIELD_APPLICATION_DESCRIPTION]
, NO_FOREIGNKEYS
);
create_Table(TABLE_DEVICES
, PRIMARYKEY_Device
, TYPE_FOREIGNKEY
, [$_DBFIELD_DEVICE_ID
, $_DBFIELD_HARDWARE_SERIAL
]
, NO_FOREIGNKEYS
);
create_Table(TABLE_APPLICATIONDEVICES
, PRIMARYKEY_ApplicationDevice
, TYPE_FOREIGNKEY
, [//Fields
$_DBFIELD_PRIMARYKEY_APPLICATION
, $_DBFIELD_PRIMARYKEY_DEVICE
]
, [$_FOREIGNKEY_APPLICATIONS, $_FOREIGNKEY_DEVICES]
);
$frequency_declaration = create_LookupTable(TABLE_FREQUENCIES
, PRIMARYKEY_Frequency
, ITPINGS_FREQUENCY
, TYPE_FREQUENCY);
$modulation_declaration = create_LookupTable(TABLE_MODULATIONS
, PRIMARYKEY_Modulation
, ITPINGS_MODULATION
, TYPE_MODULATION);
$datarate_declaration = create_LookupTable(TABLE_DATARATES
, PRIMARYKEY_Datarate
, ITPINGS_DATA_RATE
, TYPE_DATA_RATE);
$codingrate_declaration = create_LookupTable(TABLE_CODINGRATES
, PRIMARYKEY_Codingrate
, ITPINGS_CODING_RATE
, TYPE_CODING_RATE);
$origin_declaration = create_LookupTable(TABLE_ORIGINS
, PRIMARYKEY_Origin
, ITPINGS_ORIGIN
, TYPE_ITPINGS_ORIGIN);
create_Table(TABLE_LOCATIONS
, PRIMARYKEY_Location
, TYPE_FOREIGNKEY
, [$_DBFIELD_LATITUDE
, $_DBFIELD_LONGITUDE
, $_DBFIELD_ALTITUDE
//, $_DBFIELD_HDOP
, $_DBFIELD_LOCATION_SOURCE
]
, NO_FOREIGNKEYS
);
create_Table(TABLE_GATEWAYS
, PRIMARYKEY_Gateway
, TYPE_FOREIGNKEY
, [$_DBFIELD_GATEWAY_ID
, $_DBFIELD_TRUSTED_GATEWAY
, $_DBFIELD_LOCATION
]
, [$_FOREIGNKEY_LOCATIONS]
);
create_Table(TABLE_PINGS
, PRIMARYKEY_Ping
, TYPE_FOREIGNKEY
, [//Fields
$_DBFIELD_CREATED_TIMESTAMP
, $_DBFIELD_APPLICATION_DEVICE
, $_DBFIELD_PORT
, $_DBFIELD_FRAME_COUNTER
, $_DBFIELD_DOWNLINKURL
, $_DBFIELD_PAYLOAD_RAW
, $_DBFIELD_ITPINGS_TIME
, $frequency_declaration
, $modulation_declaration
, $datarate_declaration
, $codingrate_declaration
, $_DBFIELD_LOCATION
, $origin_declaration
]
, [$_FOREIGNKEY_APPLICATIONDEVICES]
);
create_Table(TABLE_PINGEDGATEWAYS
, NO_PRIMARYKEY
, FALSE
, [//Fields
$_DBFIELD_PRIMARYKEY_PING
, [PRIMARYKEY_Gateway, TYPE_FOREIGNKEY, 'PrimaryKey:' . TABLE_GATEWAYS]
, $_DBFIELD_PINGED_GATEWAY_TIMESTAMP
, $_DBFIELD_ITPINGS_TIME
, $_DBFIELD_CHANNEL
, $_DBFIELD_RSSI
, $_DBFIELD_SNR
, $_DBFIELD_RFCHAIN
]
, [$_FOREIGNKEY_PINGS, $_FOREIGNKEY_GATEWAYS]
);
create_Table(TABLE_SENSORS
, PRIMARYKEY_Sensor
, TYPE_FOREIGNKEY
, [//Fields
$_DBFIELD_APPLICATION_DEVICE
, $_DBFIELD_SENSORNAME
]
, [$_FOREIGNKEY_APPLICATIONDEVICES]
);
create_Table(TABLE_SENSORVALUES
, NO_PRIMARYKEY
, FALSE
, [//Fields
$_DBFIELD_PRIMARYKEY_PING
, $_DBFIELD_PRIMARYKEY_SENSOR
, $_DBFIELD_SENSORVALUE
]
, [$_FOREIGNKEY_PINGS, $_FOREIGNKEY_SENSORS]
);
/** Data tables to reduce size of _sensorvalues Table **/
create_DataTable(TABLE_DATA_TEMPERATURE, [ITPINGS_SENSOR_VALUE, 'DECIMAL(3,1)', 'Temperature value']);
create_DataTable(TABLE_DATA_LUMINOSITY, [ITPINGS_SENSOR_VALUE, 'SMALLINT(2)', 'Luminosity/Light value']);
create_DataTable(TABLE_DATA_BATTERY, [ITPINGS_SENSOR_VALUE, 'DECIMAL(2)', 'Battery level value']);
create_Table(TABLE_DATA_ACCELEROMETER
, PRIMARYKEY_Ping
, TYPE_FOREIGNKEY
, [//Fields
$_DBFIELD_APPLICATION_DEVICE
, ['x', 'FLOAT(4,3)', 'x movement']
, ['y', 'FLOAT(4,3)', 'y movement']
, ['z', 'FLOAT(4,3)', 'z movement']
]
, [$_FOREIGNKEY_APPLICATIONDEVICES]
);
}//end function createTables
//endregion == CREATE ITPINGS DATABASE : TABLES ===================================================
/** PHP_include ITpings__database_views **/
//region ===== PROCESS POST REQUEST , SAVE DATA TO ALL TABLES =====================================
/**
* Insert an event in the Events Table
*
* @param $event_type
* @param $event_label
* @param string $event_value
*/
function insert_TTN_Event($event_type, $event_label, $event_value = '')
{
global $request;
$pingid = $request[PRIMARYKEY_Ping];
if (!$pingid) $pingid = 1; // force logging of Database creation on ping 1
SQL_INSERT(TABLE_EVENTS
, [//values
$pingid
, Quoted($event_type)
, Quoted($event_label)
, Quoted($event_value)
]);
}
/**
* Find a matching row in the database, or NULL for non found
*
* @param $table_name
* @param $where_clause
* @param $primary_key_field
*
* @return array|null
*/
function SQL_find_existing_key_id($primary_key_field, $table_name, $where_clause)
{
$sql = "SELECT $primary_key_field FROM $table_name WHERE $where_clause ORDER BY $primary_key_field DESC LIMIT 1;";
return SQL_Query($sql)[$primary_key_field];
}
/**
* find existing value in a table, OR create new entry
* Returns a String for a SQL Insert statement
*
* @param $table
* @param $primarykey
* @param $lookup_field
* @param $lookup_value
* @return string
*/
function process_Lookup_Insert_New_value($table, $primarykey, $lookup_field, $lookup_value)
{
global $request;
/** is there a value in the lookup $table? **/
$key_id = SQL_find_existing_key_id($primarykey, $table, $lookup_field . " = " . $lookup_value);
/** If there is no existing value, insert this new lookup_value in the corresponding Lookup $table **/
if (!$key_id) {
insert_TTN_Event(ENUM_EVENTTYPE_Log, 'New' . $lookup_field, $lookup_value);
$key_id = SQL_INSERT($table, [AUTOINCREMENT_TABLE_PRIMARYKEY, $lookup_value]);
}
/** record the existing OR new id in the global $request **/
$request[$primarykey] = $key_id;
/** return a string for a SQL Insert statement **/
return COMMA . $primarykey . " = " . $key_id;
}
/**
* find an existing Application or create a new Application
* sets the found/created ID value in the global $request object
*/
function process_Application()
{
global $request;
$request_Application_ID = $request[TTN_app_id];
$key_id = SQL_find_existing_key_id(
PRIMARYKEY_Application
, TABLE_APPLICATIONS
, ITPINGS_APPLICATION_ID . " = " . Quoted($request_Application_ID)
);
if (!$key_id) {
insert_TTN_Event(
ENUM_EVENTTYPE_NewApp
, $request_Application_ID
);
$key_id = SQL_INSERT(
TABLE_APPLICATIONS
, [//values
AUTOINCREMENT_TABLE_PRIMARYKEY
, Quoted($request_Application_ID)
, Quoted('Get description from TTN')
]);
}
$request[PRIMARYKEY_Application] = $key_id;
}
/**
* find an existing Device or create a new Device
* sets the found/created ID value in the global $request object
*/
function process_Device()
{
global $request;
$request_Device_ID = $request[TTN_dev_id];
$key_id = SQL_find_existing_key_id(
PRIMARYKEY_Device
, TABLE_DEVICES
, ITPINGS_DEVICE_ID . " = " . Quoted($request_Device_ID)
);
if (!$key_id) {
insert_TTN_Event(
ENUM_EVENTTYPE_NewDevice
, $request_Device_ID
);
$key_id = SQL_INSERT(
TABLE_DEVICES
, [//values
AUTOINCREMENT_TABLE_PRIMARYKEY
, Quoted($request_Device_ID)
, Quoted($request[TTN_hardware_serial])
]);
}
$request[PRIMARYKEY_Device] = $key_id;
}
/**
* find an existing Application/Device or create a new Application/Device
* sets the found/created ID value in the global $request object
*/
function process_ApplicationDevice_Information()
{
global $request;
/**
* process Application and Device information in this request
*
* in TTN a Device can only be registered to ONE Application
* ITpings allows for any combination
*/
process_Application(); // Find known Application, else save new App
process_Device(); // Find known Device, else save as new Device
$key_id = SQL_find_existing_key_id(
PRIMARYKEY_ApplicationDevice
, TABLE_APPLICATIONDEVICES
, PRIMARYKEY_Application . " = " . $request[PRIMARYKEY_Application] . " AND " . PRIMARYKEY_Device . " = " . $request[PRIMARYKEY_Device]
);
if (!$key_id) {
//not Logging NewAppDev to _events Table
$key_id = SQL_INSERT(
TABLE_APPLICATIONDEVICES
, [//values
AUTOINCREMENT_TABLE_PRIMARYKEY
, Valued($request[PRIMARYKEY_Application])
, Valued($request[PRIMARYKEY_Device])
]);
}
$request[PRIMARYKEY_ApplicationDevice] = $key_id;
}
/**
* @param $where
* @return array|null
*/
function find_location_in_TableLocations($where)
{
return SQL_find_existing_key_id(PRIMARYKEY_Location, TABLE_LOCATIONS, $where);
}
/**
* find an existing GEO location / create a new Location
* sets the found/created ID value in the global $request object
* returns the existing OR new ID
* @param $lat
* @param $lon
* @param $alt
* @param $location_source
* @return array|null|number
*/
function process_Ping_and_Gateway_Location($lat, $lon, $alt, $location_source)
{
global $request;
$valid_location = true;
if ($lat == "") {
$valid_location = false;
$lat = "0";
}
if ($lon == "") $lon = "0";
//hardcoded! for now. todo: proces other (non 'registry') location_source settings
if ($location_source === 'registry') {
$location_source = 1;
} else {
$valid_location = false;
insert_TTN_Event(ENUM_EVENTTYPE_Error, 'invalid LocationSource', "$location_source: $lat / $lon");
$location_source = 1;
//return 1; // main gateway
};
//first check coordinates without height, later append altitude on $where
$where = ITPINGS_LATITUDE . "=$lat AND " . ITPINGS_LONGITUDE . "=$lon";
$key_id = find_location_in_TableLocations($where);
if ($valid_location AND !$key_id) {
// New Location
$key_id = SQL_INSERT(
TABLE_LOCATIONS
, [AUTOINCREMENT_TABLE_PRIMARYKEY
, $lat
, $lon
, $alt
//, $HDOP
, $location_source
]);
insert_TTN_Event(ENUM_EVENTTYPE_NewLocation, $lat, $lon);
} else { //existing location, now check Height
if ($valid_location AND CHECK_THE_ALTITUDE_IN_PING) {
if ($alt) {
$height_key_id = find_location_in_TableLocations($where . " AND " . ITPINGS_ALTITUDE . "=$alt");
if ($height_key_id) {
$key_id = $height_key_id;
} else {
insert_TTN_Event(ENUM_EVENTTYPE_Log,
'Height change for Device',
"(" . PRIMARYKEY_Location . "=$key_id) " . $request[TTN_dev_id]);
SQL_Query("UPDATE " . TABLE_LOCATIONS . " SET " . ITPINGS_ALTITUDE . "=$alt WHERE " . PRIMARYKEY_Location . "=" . $key_id);
//returns the key_id for the lat/lon (excluding alt) is used
}
} else {
insert_TTN_Event(ENUM_EVENTTYPE_Log, 'No altitude for Device', $request[TTN_dev_id]);
//returns the key_id for the lat/lon (excluding alt) is used
}
}
}
$request[PRIMARYKEY_Location] = $key_id;
return $key_id;
}
/**
* Find matching Gateway ID, OVER x metres distance, the Gateway is recorded again (as being moved)
*
* @param $gtw_id
* @param $latitude
* @param $longitude
* @return array|null
*/
function find_Nearest_Gateway_With_Same_ID($gtw_id, $latitude, $longitude)
{
$sql = "SELECT * ";
if ($latitude) {
$GTWradLAT = deg2rad($latitude);
$GTWradLON = deg2rad($longitude);
$radius = 6371;// 6371 for Kilometers, 3959 for Miles
$sql .= " , ($radius * acos(cos($GTWradLAT) * cos(radians(" . ITPINGS_LATITUDE . "))";
$sql .= " * cos(radians(" . ITPINGS_LONGITUDE . ") - $GTWradLON) + sin($GTWradLAT)";
$sql .= " * sin(radians(" . ITPINGS_LATITUDE . ")))) AS distance";
}
$sql .= " FROM " . VIEWNAME_GATEWAYS . " WHERE " . ITPINGS_GATEWAY_ID . " = " . Quoted($gtw_id);
if ($latitude) { // GPS has inaccurate fixes, to prevent 'moving' Gateway recordings a tolerance for lat/lon is calculated
$sql .= " HAVING distance < " . GATEWAY_POSITION_TOLERANCE . " ORDER BY distance;"; // default 0.02 = 20 meter
} else {
$sql .= " ORDER BY " . PRIMARYKEY_Gateway . " DESC;";
}
return SQL_Query($sql);
}
/**
* Find a Gateway or create a new Gateway
*
* @param $gateway Object from the POST request
* @return number ID value of existing/new Gateway
*/
function get_Gateway_ID_by_processing_one_Gateway($gateway)
{
global $request;
// GPS has inaccurate fixes,
// to prevent 'moving' Gateway recordings a tolerance for lat/lon is calculated
$request_GateWay_ID = $gateway[TTN_gtw_id];
$device_location = $request[TTN_dev_id] . " / " . $request_GateWay_ID;
$lat = $gateway[TTN_latitude];