-
Notifications
You must be signed in to change notification settings - Fork 12
/
Copy pathclass-trackserver.php
1693 lines (1489 loc) · 56 KB
/
class-trackserver.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
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
require_once TRACKSERVER_PLUGIN_DIR . 'class-trackserver-shortcode.php';
if ( ! class_exists( 'Trackserver' ) ) {
/**
* The main plugin class.
*/
class Trackserver {
/**
* LeafletJS version that Trackserver will use.
*
* @since 5.0
* @access private
* @var str $leaflet_version
*/
private $leaflet_version = '1.9.4';
/**
* Default values for options. See class constructor for more.
*
* @since 1.0
* @access private
* @var array $option_defaults
*/
private $option_defaults = array(
'trackserver_slug' => 'trackserver',
'trackme_slug' => 'trackme',
'trackme_extension' => 'z',
'mapmytracks_tag' => 'mapmytracks',
'osmand_slug' => 'osmand',
'osmand_trackname_format' => 'OsmAnd %F %H',
'sendlocation_slug' => 'sendlocation',
'sendlocation_trackname_format' => 'SendLocation %F %H',
'owntracks_slug' => 'owntracks',
'owntracks_trackname_format' => 'Owntracks %F',
'upload_tag' => 'tsupload',
'embedded_slug' => 'tsmap',
'gettrack_slug' => 'trackserver/gettrack',
'enable_proxy' => false,
'db_version' => false,
'fetchmode_all' => true,
);
private $user_meta_defaults = array(
'ts_infobar_template' => '{displayname} - {lat},{lon} - {timestamp}',
);
// phpcs:disable
private $shortcode = 'tsmap';
private $shortcode2 = 'tsscripts';
public $track_format = 'polyline'; // 'polyline' or 'geojson'
private $trackserver_scripts = array();
private $trackserver_styles = array();
public $permissions;
public $tbl_tracks;
public $tbl_locations;
public $options;
public $mapdata = array();
public $bulk_action_result_msg = false;
public $url_prefix = '';
private $have_scripts = false;
public $need_scripts = false;
public $need_maplibre = false;
// phpcs:enable
/**
* Class constructor.
*
* @since 1.0
*/
public function __construct() {
global $wpdb;
$this->tbl_tracks = $wpdb->prefix . 'ts_tracks';
$this->tbl_locations = $wpdb->prefix . 'ts_locations';
$this->init_options();
$this->user_meta_defaults['ts_tracks_admin_view'] = '0';
$this->user_meta_defaults['ts_owntracks_share'] = '';
$this->user_meta_defaults['ts_owntracks_follow'] = '';
$this->user_meta_defaults['ts_geofences'] = array(
array(
'lat' => 0,
'lon' => 0,
'radius' => 0,
'action' => 'hide',
),
);
// Bootstrap
$this->add_actions();
if ( is_admin() ) {
require_once TRACKSERVER_PLUGIN_DIR . 'class-trackserver-admin.php';
Trackserver_Admin::get_instance( $this )->add_actions();
}
}
/**
* Initialize Trackserver options, merging new options on the fly.
*
* @since 3.0
*/
public function init_options() {
$options = get_option( 'trackserver_options' );
if ( ! $options ) {
$options = array();
}
$this->options = array_merge( $this->option_defaults, $options );
update_option( 'trackserver_options', $this->options );
// Remove options that are no longer in use.
$this->delete_option( 'osmand_key' );
$this->delete_option( 'normalize_tripnames' );
$this->delete_option( 'tripnames_format' );
// Initialize map profiles and remove old options.
$this->init_map_profiles();
$this->delete_option( 'tile_url' );
$this->delete_option( 'attribution' );
}
/**
* Initialize map profiles
*
* @since 6.0
*/
private function init_map_profiles() {
$this->map_profiles = get_option( 'trackserver_map_profiles' );
if ( ! $this->map_profiles ) {
$this->map_profiles = array();
}
if ( count( $this->map_profiles ) === 0 ) {
$tile_url = ( isset( $this->options['tile_url'] ) ? $this->options['tile_url'] : 'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png' );
$attribution = ( isset( $this->options['attribution'] ) ? $this->options['attribution'] : '© <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a>' );
$this->map_profiles[] = array(
'label' => 'default',
'tile_url' => $tile_url,
'attribution' => $attribution,
'min_zoom' => 0,
'max_zoom' => 22,
'default_lat' => '51.443168',
'default_lon' => '5.447200',
);
}
update_option( 'trackserver_map_profiles', $this->map_profiles );
}
/**
* Write a line to the PHP error log, trying to be smart about complex values
*
* @since 3.0
*/
public function debug( $log ) {
if ( true === WP_DEBUG ) {
if ( is_array( $log ) || is_object( $log ) ) {
error_log( print_r( $log, true ) );
} else {
error_log( $log );
}
}
}
/**
* Add missing default user meta values
* WARNING: this function will run on every request, so keep it lean.
*
* @since 1.9
*/
public function init_user_meta( $user_id = null ) {
if ( is_null( $user_id ) ) {
$user_id = get_current_user_id();
}
if ( ! user_can( $user_id, 'use_trackserver' ) ) {
return;
}
// Set default profile values for the given user
foreach ( $this->user_meta_defaults as $key => $value ) {
if ( get_user_meta( $user_id, $key, true ) === '' ) {
update_user_meta( $user_id, $key, $value );
}
}
// Handle 'ts_app_passwords' specially, because it needs existing values
if ( get_user_meta( $user_id, 'ts_app_passwords', true ) === '' ) {
$passwords = array();
$password_perms = array(
'ts_trackme_key' => array( 'read', 'write', 'delete' ),
'ts_osmand_key' => array( 'write' ),
'ts_sendlocation_key' => array( 'write' ),
);
// Copy each of the three existing keys to an app password with appropriate permissions, if non-empty
foreach ( $password_perms as $key => $value ) {
$srcval = get_user_meta( $user_id, $key, true );
if ( $srcval !== '' ) {
$passwords[] = array(
'password' => $srcval,
'permissions' => $value,
);
}
}
// If none of the keys exist, create one default app password with write permissions only.
if ( empty( $passwords ) ) {
$passwords[] = array(
'password' => substr( md5( uniqid() ), -8 ),
'permissions' => array( 'write' ),
);
}
// If the keys have been copied successfully, we can delete the originals.
if ( update_user_meta( $user_id, 'ts_app_passwords', $passwords ) !== false ) {
delete_user_meta( $user_id, 'ts_trackme_key' );
delete_user_meta( $user_id, 'ts_osmand_key' );
delete_user_meta( $user_id, 'ts_sendlocation_key' );
}
}
}
/**
* Add common actions and filters.
*
* @since 1.0
*/
private function add_actions() {
// Set up permalink-related values
add_action( 'wp_loaded', array( &$this, 'wp_loaded' ) );
// Custom request parser; core protocol handler
add_action( 'parse_request', array( &$this, 'parse_request' ) );
// Front-end JavaScript and CSS
add_action( 'wp_enqueue_scripts', array( &$this, 'wp_enqueue_scripts' ) );
add_action( 'wp_footer', array( &$this, 'wp_footer' ) );
// Shortcodes
Trackserver_Shortcode::get_instance( $this );
// Media upload
add_filter( 'upload_mimes', array( &$this, 'upload_mimes' ) );
add_filter( 'media_send_to_editor', array( &$this, 'media_send_to_editor' ), 10, 3 );
// Custom post type for embedded maps
add_action( 'init', array( &$this, 'wp_init' ) );
add_filter( 'single_template', array( &$this, 'get_tsmap_single_template' ) );
add_filter( '404_template', array( &$this, 'get_tsmap_404_template' ) );
}
/**
* Handler for 'init' action.
*
* @since 4.3
*/
public function wp_init() {
$this->load_textdomain();
$this->register_tsmap_post_type();
}
/**
* Handler for 'wp_loaded' action. Sets up the URL prefix for all
* Trackserver-generated URLs based on the use of permalinks
*
* If permalinks are not in use, or the main index (index.php) is used in
* the permalink structure, the main index should also be used in all
* URLs used and generated by Trackserver.
*
* @since 1.3
*/
public function wp_loaded() {
global $wp_rewrite;
if ( ! $wp_rewrite->using_permalinks() || $wp_rewrite->using_index_permalinks() ) {
$this->url_prefix = '/' . $wp_rewrite->index;
}
$this->init_user_meta();
}
/**
* Update options.
*
* Set the value in the options array and write the array to the database.
*
* @since 1.0
*
* @see update_option()
*
* @param string $option Option name
* @param string $value Option value
*/
public function update_option( $option, $value ) {
$this->options[ $option ] = $value;
update_option( 'trackserver_options', $this->options );
}
/**
* Remove an option
*
* Remove a key from the options array and write the array to the database.
*
* @since 1.9
*
* @param string $option Option name
*/
public function delete_option( $option ) {
if ( array_key_exists( $option, $this->options ) ) {
unset( $this->options[ $option ] );
update_option( 'trackserver_options', $this->options );
}
}
/**
* Wrapper for wp_enqueue_script() that keeps a list of this plugin's scripts
*
* @since 5.0
*/
private function wp_enqueue_script( ...$args ) {
$this->trackserver_scripts[] = $args[0];
wp_enqueue_script( ...$args );
}
/**
* Wrapper for wp_enqueue_style() that keeps a list of this plugin's styles
*
* @since 5.0
*/
private function wp_enqueue_style( ...$args ) {
$this->trackserver_styles[] = $args[0];
wp_enqueue_style( ...$args );
}
/**
* Function to load scripts for both front-end and admin. It is called from the
* 'wp_enqueue_scripts' and 'admin_enqueue_scripts' handlers.
*
* @since 1.0
*/
public function load_common_scripts() {
$this->wp_enqueue_style( 'leaflet-js', TRACKSERVER_JSLIB . 'leaflet-' . $this->leaflet_version . '/leaflet.css' );
$this->wp_enqueue_script( 'leaflet-js', TRACKSERVER_JSLIB . 'leaflet-' . $this->leaflet_version . '/leaflet.js', array(), false, true );
$this->wp_enqueue_style( 'leaflet-fullscreen', TRACKSERVER_JSLIB . 'leaflet-fullscreen-1.0.2/leaflet.fullscreen.css' );
$this->wp_enqueue_script( 'leaflet-fullscreen', TRACKSERVER_JSLIB . 'leaflet-fullscreen-1.0.2/Leaflet.fullscreen.min.js', array(), false, true );
$this->wp_enqueue_script( 'leaflet-omnivore', TRACKSERVER_PLUGIN_URL . 'trackserver-omnivore.js', array(), TRACKSERVER_VERSION, true );
$this->wp_enqueue_style( 'trackserver', TRACKSERVER_PLUGIN_URL . 'trackserver.css', array(), TRACKSERVER_VERSION );
$this->wp_enqueue_script( 'promise-polyfill', TRACKSERVER_JSLIB . 'promise-polyfill-6.0.2/promise.min.js', array(), false, true );
$this->wp_enqueue_script( 'leaflet-textpath', TRACKSERVER_JSLIB . 'leaflet-textpath-1.2.3/leaflet.textpath.js', array(), TRACKSERVER_VERSION, true );
// To be localized in wp_footer() with data from the shortcode(s). Enqueued last, in wp_enqueue_scripts.
// Also localized and enqueued in admin_enqueue_scripts
wp_register_script( 'trackserver', TRACKSERVER_PLUGIN_URL . 'trackserver.js', array(), TRACKSERVER_VERSION, true );
$settings = array(
'plugin_url' => TRACKSERVER_PLUGIN_URL,
'leaflet_version' => $this->leaflet_version,
);
wp_localize_script( 'trackserver', 'trackserver_settings', $settings );
$i18n = array(
'no_tracks_to_display' => __( 'No tracks to display.', 'trackserver' ),
);
wp_localize_script( 'trackserver', 'trackserver_i18n', $i18n );
}
/**
* Handler for 'wp_enqueue_scripts'. Load javascript and stylesheets on
* the front-end.
*
* @since 1.0
*/
public function wp_enqueue_scripts( $force = false ) {
global $post;
if ( $force || $this->detect_shortcode() ) {
/* For embedded maps, we want to print only the necessary scripts, and
* skip scripts added by other plugins. We use an extra action in the
* 'wp_head' hook, that runs after 'wp_enqueue_scripts' (prio 1) and
* before 'wp_print_styles' (prio 8) and 'wp_print_head_scripts' (prio
* 9). Another approach would be to just clear the queue here and start
* empty, but we have no way of knowing what will be added afterwards,
* so that wouldn't be effective.
*/
if ( $post->post_type === 'tsmap' ) {
add_action( 'wp_head', array( &$this, 'tsmap_dequeue_scripts' ), 5 );
}
$this->load_common_scripts();
// Live-update only on the front-end, not in admin
$this->wp_enqueue_style( 'leaflet-messagebox', TRACKSERVER_JSLIB . 'leaflet-messagebox-1.0/leaflet-messagebox.css' );
$this->wp_enqueue_script( 'leaflet-messagebox', TRACKSERVER_JSLIB . 'leaflet-messagebox-1.0/leaflet-messagebox.js', array(), false, true );
$this->wp_enqueue_style( 'leaflet-liveupdate', TRACKSERVER_JSLIB . 'leaflet-liveupdate-1.1/leaflet-liveupdate.css' );
$this->wp_enqueue_script( 'leaflet-liveupdate', TRACKSERVER_JSLIB . 'leaflet-liveupdate-1.1/leaflet-liveupdate.js', array(), false, true );
// Instruct wp_footer() that we already have the scripts.
$this->have_scripts = true;
}
}
/**
* Function added to the wp_head() hook to dequeue unneeded styles and scripts for embedded maps.
*
* This function takes the currently queued scripts and styles, and
* everything that is not added by Trackserver is removed from the queue.
* See wp_enqueue_scripts() above for more information.
*
* @since 5.0
*/
public function tsmap_dequeue_scripts() {
foreach ( wp_scripts()->queue as $script ) {
if ( ! in_array( $script, $this->trackserver_scripts, true ) ) {
wp_dequeue_script( $script );
}
}
foreach ( wp_styles()->queue as $css ) {
if ( ! in_array( $css, $this->trackserver_styles, true ) ) {
wp_dequeue_style( $css );
}
}
}
/**
* Function to load the gettext domain for this plugin. Called from the 'init' hook.
*
* @since 4.3
*/
private function load_textdomain() {
// Load the MO file for the current language.
load_plugin_textdomain( 'trackserver', false, dirname( plugin_basename( __FILE__ ) ) . '/lang/' );
}
/**
* Detect shortcode
*
* This function tries to detect Trackserver's shortcodes [tsmap] or [tsscripts]
* in the current query's output and returns true if it is found.
*
* @since 1.0
*/
private function detect_shortcode() {
global $wp_query;
$posts = $wp_query->posts;
if ( is_array( $posts ) ) {
foreach ( $posts as $post ) {
if ( $this->has_shortcode( $post ) ) {
return true;
}
}
}
return false;
}
/**
* Function to find the Trackserver shortcodes in the content of a post or page
*
* @since 2.0
*/
private function has_shortcode( $post ) {
$pattern = get_shortcode_regex();
if ( preg_match_all( '/' . $pattern . '/s', $post->post_content, $matches )
&& array_key_exists( 2, $matches )
&& ( in_array( $this->shortcode, $matches[2], true ) || in_array( $this->shortcode2, $matches[2], true ) ) ) {
return true;
}
return false;
}
/**
* Provision the JavaScript that initializes the map(s) with settings and data
*
* @since 2.0
*/
public function wp_footer() {
if ( $this->need_scripts && ! $this->have_scripts ) {
$this->wp_enqueue_scripts( true );
}
// Enqueue Maplibre GL JS is necessary
if ( $this->need_maplibre ) {
$this->wp_enqueue_style( 'maplibre-gl', TRACKSERVER_JSLIB . 'maplibre-gl-4.7.1/maplibre-gl.css' );
$this->wp_enqueue_script( 'maplibre-gl', TRACKSERVER_JSLIB . 'maplibre-gl-4.7.1/maplibre-gl.js', array(), false, true );
$this->wp_enqueue_script( 'leaflet-maplibre-gl', TRACKSERVER_JSLIB . 'maplibre-gl-4.7.1/leaflet-maplibre-gl.js', array(), false, true );
}
// Enqueue the main script last
if ( $this->need_scripts ) {
$this->wp_enqueue_script( 'trackserver' );
}
wp_localize_script( 'trackserver', 'trackserver_mapdata', $this->mapdata );
}
/**
* Handle the request.
*
* This function compares the incoming request against a list of known
* protcols. Protocols can be distinguished by URL (regexp-based),
* mandatory GET/POST parameters, request method and Content-Type. If a
* match is found, the appropriate request handler is called. If username
* and access key are present in the URL, they are used. If no protocol is
* matched, the request is passed on to WP.
*
* @since 1.0
* @since 5.0 Use intelligent protocol matchers against a universal Trackserver slug
*/
public function parse_request( $wp ) {
// Handle requests to all the Trackserver URL paths. Requests will in principle match both GET
// and POST requests, unless a 'method' key is present in the protocol's properties.
$req_uri = $this->get_request_uri();
$slug = $this->options['trackserver_slug'];
$pattern1 = '/^(?<slug>' . preg_quote( $slug, '/' ) . ')\/(?<username>[^\/]+)\/(?<password>[^\/]+)\/?$/';
$pattern2 = '/^(?<slug>' . preg_quote( $slug, '/' ) . ')\/?$/';
$protocols = array(
'gettrack' => array(
'pattern' => '/^(?<slug>' . preg_quote( $this->options['gettrack_slug'], '/' ) . ')\/?$/',
),
'trackmeold1' => array(
'pattern' => '/^(?<slug>' . preg_quote( $slug, '/' ) . ')\/(?<method>requests|export|cloud)\.(?<ext>.*)/',
),
'trackme1' => array(
'pattern' => '/^(?<slug>' . preg_quote( $slug, '/' ) . ')\/(?<username>[^\/]+)\/(?<password>[^\/]+)\/(?<method>requests|export|cloud)\.(?<ext>.*)/',
),
'ulogger' => array(
'pattern' => '/^(?<slug>' . preg_quote( $slug, '/' ) . ')\/client\/index\.php/',
),
'mapmytracks1' => array(
'pattern' => $pattern2,
'params' => array( 'request' ),
),
'upload1' => array(
'pattern' => $pattern2,
'method' => 'POST',
'enctype' => 'multipart/form-data',
),
'owntracks1' => array(
'pattern' => $pattern2,
'method' => 'POST',
'enctype' => 'application/json',
),
'get1' => array(
'pattern' => $pattern1,
),
'get2' => array(
'pattern' => $pattern2,
),
// The matches below all use dedicated slugs and are DEPRECATED as of v5.0
'trackmeold2' => array(
'pattern' => '/^(?<slug>' . preg_quote( $this->options['trackme_slug'], '/' ) . ')\/(?<method>requests|export|cloud)\.(?<ext>.*)/',
),
'trackme2' => array(
'pattern' => '/^(?<slug>' . preg_quote( $this->options['trackme_slug'], '/' ) .
')\/(?<username>[^\/]+)\/(?<password>[^\/]+)\/(?<method>requests|export|cloud)\.(?<ext>.*)/',
),
'mapmytracks2' => array(
'pattern' => '/^(?<slug>' . preg_quote( $this->options['mapmytracks_tag'], '/' ) . ')\/?$/',
),
'osmand' => array(
'pattern' => '/^(?<slug>' . preg_quote( $this->options['osmand_slug'], '/' ) . ')\/?$/',
),
'sendlocation' => array(
'pattern' => '/^(?<slug>' . preg_quote( $this->options['sendlocation_slug'], '/' ) . ')\/(?<username>[^\/]+)\/(?<password>[^\/]+)\/?$/',
),
'upload2' => array(
'pattern' => '/^(?<slug>' . preg_quote( $this->options['upload_tag'], '/' ) . ')\/?$/',
'method' => 'POST',
'enctype' => 'multipart/form-data',
),
'owntracks2' => array(
'pattern' => '/^(?<slug>' . preg_quote( $this->options['owntracks_slug'], '/' ) . ')\/?$/',
'method' => 'POST',
'enctype' => 'application/json',
),
);
foreach ( $protocols as $proto => $props ) {
// Match the URL
$n = preg_match( $props['pattern'], $req_uri, $matches );
if ( $n === 1 ) {
// Get credentials from the URL if present
if ( ! empty( $matches['username'] ) ) {
$username = rawurldecode( stripslashes( $matches['username'] ) );
$password = rawurldecode( stripslashes( $matches['password'] ) );
} else {
$username = null;
$password = null;
}
// Check mandatory parameters
if ( ! empty( $props['params'] ) ) {
// Count the number of params that are present in $props['params'],
// but not in $_REQUEST. There should be none to match this protocol.
if ( count( array_diff_key( array_flip( $props['params'] ), $_REQUEST ) ) > 0 ) {
continue;
}
}
// Check mandatory HTTP request method
if ( ! empty( $props['method'] ) ) {
if ( $_SERVER['REQUEST_METHOD'] !== $props['method'] ) {
continue;
}
}
// Check mandatory Content-Type
if ( ! empty( $props['enctype'] ) ) {
$req_enctype = strtok( $_SERVER['CONTENT_TYPE'], ';' ); // Strip charset/boundary off header
if ( $req_enctype !== $props['enctype'] ) {
continue;
}
}
if ( $proto === 'gettrack' ) {
Trackserver_Shortcode::get_instance( $this )->handle_gettrack();
} elseif ( $proto === 'trackmeold1' || $proto === 'trackmeold2' || $proto === 'trackme1' || $proto === 'trackme2' ) {
require_once TRACKSERVER_PLUGIN_DIR . 'class-trackserver-trackme.php';
Trackserver_Trackme::get_instance( $this )->handle_protocol( $matches['method'], $username, $password );
} elseif ( $proto === 'mapmytracks1' || $proto === 'mapmytracks2' ) {
require_once TRACKSERVER_PLUGIN_DIR . 'class-trackserver-mapmytracks.php';
$client = new Trackserver_Mapmytracks( $this );
$client->handle_request();
} elseif ( $proto === 'ulogger' ) {
require_once TRACKSERVER_PLUGIN_DIR . 'class-trackserver-ulogger.php';
$client = new Trackserver_Ulogger( $this );
$client->handle_request();
} elseif ( $proto === 'get1' || $proto === 'get2' || $proto === 'osmand' || $proto === 'sendlocation' ) {
require_once TRACKSERVER_PLUGIN_DIR . 'class-trackserver-getrequest.php';
$client = new Trackserver_Getrequest( $this, $username, $password );
$client->handle_request();
} elseif ( $proto === 'upload1' || $proto === 'upload2' ) {
$this->handle_upload();
} elseif ( $proto === 'owntracks1' || $proto === 'owntracks2' ) {
require_once TRACKSERVER_PLUGIN_DIR . 'class-trackserver-owntracks.php';
Trackserver_OwnTracks::get_instance( $this )->handle_request();
} else {
$this->http_terminate( 500, 'BUG: Unhandled protocol. Please file a bug report.' );
}
die();
}
}
return $wp;
}
/**
* A function to get the real request URI, stripped of all the basics. What
* this function returns is meant to be used to match against, for URIs
* that Trackserver must handle.
*
* The code is borrowed from WP's own parse_request() function.
*
* @since 5.0
*/
private function get_request_uri() {
global $wp_rewrite;
$home_path0 = parse_url( home_url(), PHP_URL_PATH );
$home_path = ( empty( $home_path0 ) ? '' : trim( $home_path0, '/' ) ) . $this->url_prefix;
$home_path_regex = sprintf( '|^%s|i', preg_quote( $home_path, '|' ) );
$pathinfo = isset( $_SERVER['PATH_INFO'] ) ? $_SERVER['PATH_INFO'] : '';
list( $pathinfo ) = explode( '?', $pathinfo );
$pathinfo = trim( $pathinfo, '/' );
$pathinfo = preg_replace( $home_path_regex, '', $pathinfo );
$pathinfo = trim( $pathinfo, '/' );
list( $request_uri ) = explode( '?', $_SERVER['REQUEST_URI'] );
$request_uri = str_replace( $pathinfo, '', $request_uri );
$request_uri = trim( $request_uri, '/' );
$request_uri = preg_replace( $home_path_regex, '', $request_uri );
$request_uri = trim( $request_uri, '/' );
// The requested permalink is in $pathinfo for path info requests and $request_uri for other requests.
if ( ! empty( $pathinfo ) && ! preg_match( '|^.*' . preg_quote( $wp_rewrite->index, '|' ) . '$|', $pathinfo ) ) {
$requested_path = $pathinfo;
} else {
// If the request uri is the index, blank it out so that we don't try to match it against a rule.
if ( $request_uri === $wp_rewrite->index ) {
$request_uri = '';
}
$requested_path = $request_uri;
}
// Strip 'index.php' from the beginning, if present
if ( substr( $requested_path, 0, strlen( $wp_rewrite->index ) ) === $wp_rewrite->index ) {
$requested_path = substr( $requested_path, strlen( $wp_rewrite->index ) );
}
return $requested_path;
}
/**
* Terminate the current script, sending a HTTP status code and
* a message. To be used for protocols that do not require a specific
* response, like OsmAnd and SendLocation, but unlike Trackme, for example.
*
* @since 2.0
*/
public function http_terminate( $http = '403', $message = 'Access denied' ) {
http_response_code( $http );
header( 'Content-Type: text/plain' );
echo $message . "\n";
die();
}
/**
* Return a list of user IDs that share their location with us.
*
* The function does a query directly on the 'usermeta' table, which is ugly.
* We want to match a given username against a comma-separated list of usernames.
* Unfortunately, using WP_User_Query is not feasable, because the 'LIKE' comparator
* doesn't allow us to match the beginning or the end of the meta data. If one
* username is a substring of another, we're in trouble: if the given username is
* 'john', and the list ends with ',johnpetersen', there is no way to avoid a match.
* Also, using the 'REGEXP' comparator would force us to construct a regexp
* containing a user name, which seems hard to properly quote.
*
* Instead, we do it like it's done in update_meta_cache()
* https://core.trac.wordpress.org/browser/tags/4.9.2/src/wp-includes/meta.php#L787
*
* The ID of the requesting user is always included.
*
* @since 4.1
*/
private function get_users_sharing( $user ) {
global $wpdb;
$username = $user->user_login;
$table = _get_meta_table( 'user' );
$sql = $wpdb->prepare(
// phpcs:ignore
"SELECT user_id, meta_key, meta_value FROM $table WHERE meta_key='ts_owntracks_share' AND (" .
'meta_value=%s OR meta_value LIKE %s OR meta_value LIKE %s OR meta_value LIKE %s)',
$username,
'%,' . $wpdb->esc_like( $username ),
'%,' . $wpdb->esc_like( $username ) . ',%',
$wpdb->esc_like( $username ) . ',%'
);
// phpcs:ignore
$res = $wpdb->get_results( $sql, ARRAY_A );
$user_ids = array( $user->ID );
foreach ( $res as $row ) {
$user_ids[] = (int) $row['user_id'];
}
return array_unique( $user_ids );
}
/**
* Return an array of user IDs who we follow, that are sharing with us.
*
* The list of users sharing their location with us is filtered for the
* users we are following. An empty list means we follow all users. If
* there are positive usernames in the list, we intersect the list of
* sharing users with the list of users we follow. If there are negative
* usernames in the list, they are removed from the final list.
*
* @since 4.1
*/
public function get_followed_users( $user ) {
$friends = $this->get_users_sharing( $user );
$following = get_user_meta( $user->ID, 'ts_owntracks_follow', true );
if ( empty( $following ) ) {
return $friends;
}
$following = array_unique( array_map( 'trim', explode( ',', $following ) ) ); // convert to array and trim whitespace
$do_follow = array( $user->ID );
$dont_follow = array();
foreach ( $following as $f ) {
$ff = ( $f[0] === '!' ? substr( $f, 1 ) : $f );
$u = get_user_by( 'login', $ff );
if ( ! $u ) { // username not found
continue;
}
if ( $f[0] === '!' ) {
$dont_follow[] = $u->ID;
} else {
$do_follow[] = $u->ID;
}
}
// our own user ID is always in the list
if ( count( $do_follow ) > 1 ) {
$friends = array_intersect( $friends, $do_follow );
}
if ( ! empty( $dont_follow ) ) {
$friends = array_diff( $friends, $dont_follow );
}
return array_values( $friends ); // strip explicit keys
}
/**
* Validate credentials for basic HTTP authentication.
*
* If no credentials are received, a 401 status code is sent. Validation is
* delegated to validate_credentials(). If that function returns a trueish
* value, we return it as is. Otherwise, we terminate the request (default)
* or return false, if so requested.
*
* On success, the return value is the validated user's ID. By passing
* 'object' as the second argument, the WP_User object is requested and
* returned instead.
*
* @since 1.0
*/
public function validate_http_basicauth( $do_return = false, $what = 'id' ) {
if ( ! isset( $_SERVER['PHP_AUTH_USER'] ) ) {
header( 'WWW-Authenticate: Basic realm="Authentication Required"' );
header( 'HTTP/1.0 401 Unauthorized' );
die( "Authentication required\n" );
}
$valid = $this->validate_credentials( $_SERVER['PHP_AUTH_USER'], $_SERVER['PHP_AUTH_PW'], $what, true );
if ( $do_return || $valid !== false ) {
return $valid;
}
$this->http_terminate( '403', 'Username or password incorrect' );
}
/**
* Validate given credentials against user metadata and optionally the WP
* password.
*
* With valid credentials, this function returns the authenticated user's
* ID by default, or a WP_User object on request (3rd argument). Otherwise,
* it returns false.
*
* @since 5.0
*/
public function validate_credentials( $username, $password, $what = 'id', $wppass = false ) {
if ( empty( $username ) || empty( $password ) ) {
return false;
}
$user = get_user_by( 'login', $username );
if ( $user && user_can( $user, 'use_trackserver' ) ) {
$this->init_user_meta( $user->ID );
if ( $wppass ) {
$hash = $user->data->user_pass;
if ( wp_check_password( $password, $hash, $user->ID ) ) {
$this->permissions = array( 'read', 'write', 'delete' );
return ( $what === 'object' ? $user : $user->ID );
}
}
$passwords = get_user_meta( $user->ID, 'ts_app_passwords', true );
foreach ( $passwords as $entry ) {
if ( $password === $entry['password'] ) {
$this->permissions = $entry['permissions'];
return ( $what === 'object' ? $user : $user->ID );
}
}
}
return false;
}
/**
* Validate HTTP basic authentication, only if a username and password were sent in the request.
*
* If no credentials are found, return NULL.
*
* This function is meant to be used, where HTTP basic auth is optional,
* and authentication will be handled by another mechanism if it is not
* used. The actual validation is delegated to validate_http_basicauth().
*
* By default, invalid credentials will terminate the request.
*
* @since 4.3
*/
public function try_http_basicauth( $do_return = false, $what = 'id' ) {
if ( isset( $_SERVER['PHP_AUTH_USER'] ) && isset( $_SERVER['PHP_AUTH_PW'] ) ) {
return $this->validate_http_basicauth( $do_return, $what );
}
return null;
}
/**
* Calculate the local time offset and correct for DST.
*
* We use the same method as 'wp_timezone_override_offset', which serves
* as a default override for the 'gmt_offset' option, except we use a
* given timestamp for the calculation instead of the current time.
*
* The timezone used is WP's configured timezone if any, or else PHP's
* system timezone if set. Ultimately, we fall back to 'Europe/London',
* which is just like UTC/GMT, but with DST.
*
* Ideally, we would lookup the timezone from the actual coordinates of
* the track points, but we don't have a the necessary data. We could use
* a service like the Google Time Zone API, but those usually require
* registration, so we don't do that (yet). So the calculation may be
* incorrect if your track is from a location that has different DST
* rules than the chosen time zone.
*
* We calculate the offset once, so even if a DST transition took place
* during your track, it remains continuous.
*
* @since 1.3
*
* @param int $ts The unix timestamp to calculate an offset for.
*/
public function utc_to_local_offset( $ts ) {
$localtz = get_option( 'timezone_string' );
if ( ! $localtz ) {
$localtz = ini_get( 'date.timezone' );
if ( ! $localtz ) {
$localtz = 'Europe/London';
}
}
$timezone_object = timezone_open( $localtz );
$datetime_object = date_create(); // DateTime object with UTC timezone
if ( false === $timezone_object || false === $datetime_object ) {
return 0;
}
date_timestamp_set( $datetime_object, $ts );
return timezone_offset_get( $timezone_object, $datetime_object );
}
public function mapmytracks_insert_points( $points, $trip_id, $user_id ) {
global $wpdb;
if ( $points ) {
$now = current_time( 'Y-m-d H:i:s' );
$offset = $this->utc_to_local_offset( $points[0]['timestamp'] );
$sqldata = array();
foreach ( $points as $p ) {
$ts = $p['timestamp'] + $offset;
$occurred = date( 'Y-m-d H:i:s', $ts ); // phpcs:ignore
$fenced = $this->is_geofenced( $user_id, $p );
if ( $fenced === 'discard' ) {
continue;
}
$hidden = ( $fenced === 'hide' ? 1 : 0 );
$sqldata[] = $wpdb->prepare( '(%d, %s, %s, %s, %s, %s, %d)', $trip_id, $p['latitude'], $p['longitude'], $p['altitude'], $now, $occurred, $hidden );
}
// Let's see how many rows we can put in a single MySQL INSERT query.
// A row is roughly 86 bytes, so lets's use 100 to be on the safe side.
$sql = "SHOW VARIABLES LIKE 'max_allowed_packet'"; // returns 2 columns, we need the second
$max_bytes = intval( $wpdb->get_var( $sql, 1 ) ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
if ( $max_bytes ) {
$max_rows = (int) ( $max_bytes / 100 );
} else {
$max_rows = 10000; // max_allowed_packet is 1MB by default
}
$sqldata = array_chunk( $sqldata, $max_rows );
// Insert the data into the databae in chunks of $max_rows.
// If insertion fails, return false immediately
foreach ( $sqldata as $chunk ) {
$sql = 'INSERT INTO ' . $this->tbl_locations . ' (trip_id, latitude, longitude, altitude, created, occurred, hidden) VALUES ';
$sql .= implode( ',', $chunk );
if ( $wpdb->query( $sql ) === false ) { // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
return false;
}
}
// Update the track's distance in the database
$this->calculate_distance( $trip_id );
}
return true;