-
Notifications
You must be signed in to change notification settings - Fork 375
/
Copy pathgmt_remote.c
1924 lines (1742 loc) · 91.9 KB
/
gmt_remote.c
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
/*--------------------------------------------------------------------
*
* Copyright (c) 1991-2025 by the GMT Team (https://www.generic-mapping-tools.org/team.html)
* See LICENSE.TXT file for copying and redistribution conditions.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; version 3 or any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* Contact info: www.generic-mapping-tools.org
*--------------------------------------------------------------------*/
/* Program: gmt_remote.c
* Purpose: routines involved in handling remote files and tiles
*
* Author: Paul Wessel
* Date: 15-Sept-2017
*
* A) List of exported gmt_* functions available to modules and libraries via gmt_dev.h:
*
* gmt_dataserver_url
* gmt_download_file
* gmt_download_file_if_not_found
* gmt_download_tiles
* gmt_file_is_a_tile
* gmt_file_is_cache
* gmt_file_is_tiled_list
* gmt_get_dataset_tiles
* gmt_get_tile_id
* gmt_refresh_server
* gmt_remote_dataset_id
* gmt_remote_no_extension
* gmt_remote_no_resolution_given
* gmt_remote_resolutions
* gmt_set_remote_and_local_filenames
* gmt_set_unspecified_remote_registration
* gmt_use_srtm_coverage
*
* B) List of exported gmtlib_* functions available to libraries via gmt_internals.h:
*
* gmtlib_assemble_tiles
* gmtlib_file_is_jpeg2000_tile
* gmtlib_get_tile_list
* gmtlib_remote_file_is_tiled
*
* gmtremote_* functions are all static and used only in this file, hence not exported.
*/
#include "gmt_dev.h"
#include "gmt_internals.h"
#include <curl/curl.h>
#ifdef WIN32
#include <sys/utime.h>
#endif
#define GMT_HASH_INDEX 0
#define GMT_INFO_INDEX 1
/* Copy a file from the GMT auto-download directory or the Internet. We recognize
* different types and names of files.
* 1. There are data sets of use to all GMT users, such as global relief:
* @earth_relief_<res>.grd Various global relief grids
* We may add more data later but this is our start.
* 2. Data sets only used to run an example or a test script
* and these are all called @*, i.e., a '@' is prepended to the name.
* They live in a cache subdirectory under the GMT_DATA_SERVER
* and will be placed in a cache directory in the users ~/.gmt directory.
* 3. Generic URLs starting with http:, https:, or ftp: These will be
* downloaded to the cache directory.
* If auto-download is enabled and a requested input file matches these
* names and not found by normal means then we download the file to the
* user-directory. All places that open files (GMT_Read_Data) will do
* this check by first calling gmt_download_file_if_not_found.
*/
/* Need global variables for this black magic. Here is the problem:
* When a user accesses a large remote file and there is a power-outage
* or the user types Ctrl-C, the remote file is only partially copied
* over and is useless. In those cases we should make sure we delete
* the incomplete file before killing ourselves. Below is the implementation
* for Linux/macOS that handles these cases. The actual CURL calls
* are bracketed by gmtremote_turn_on_ctrl_C_check and gmtremote_turn_off_ctrl_C_check which
* temporarily activates or deactivates our signal action on Ctrl-C.
* P. Wessel, June 30, 2019.
*/
#if !(defined(WIN32) || defined(NO_SIGHANDLER))
#define GMT_CATCH_CTRL_C
#include <signal.h>
struct sigaction cleanup_action, default_action;
char *file_to_delete_if_ctrl_C;
#endif
struct LOCFILE_FP {
char *file; /* Pointer to file name */
FILE *fp; /* Open file pointer */
};
GMT_LOCAL void gmtremote_delete_file_then_exit (int sig_no) {
/* If we catch a CTRL-C during CURL download we must assume file is corrupted and remove it before exiting */
gmt_M_unused (sig_no);
#ifdef GMT_CATCH_CTRL_C
#ifdef DEBUG
fprintf (stderr, "Emergency removal of file %s due to Ctrl-C action\n", file_to_delete_if_ctrl_C);
#endif
remove (file_to_delete_if_ctrl_C); /* Remove if we can, ignore any returns */
sigaction (SIGINT, &default_action, NULL); /* Reset the default action */
kill (0, SIGINT); /* Perform the final Ctrl-C action and die */
#endif
}
GMT_LOCAL void gmtremote_turn_on_ctrl_C_check (char *file) {
#ifdef GMT_CATCH_CTRL_C
file_to_delete_if_ctrl_C = file; /* File to delete if CTRL-C is caught */
gmt_M_memset (&cleanup_action, 1, struct sigaction); /* Initialize the structure to NULL */
cleanup_action.sa_handler = &gmtremote_delete_file_then_exit; /* Set function we should call if CTRL-C is caught */
sigaction(SIGINT, &cleanup_action, &default_action); /* Activate the alternative signal checking */
#else
gmt_M_unused (file);
#endif
}
GMT_LOCAL void gmtremote_turn_off_ctrl_C_check () {
#ifdef GMT_CATCH_CTRL_C
file_to_delete_if_ctrl_C = NULL; /* Remove trace of any file name */
sigaction (SIGINT, &default_action, NULL); /* Reset default signal action */
#endif
}
struct FtpFile { /* Needed for argument to libcurl */
const char *filename; /* Name of file to write */
FILE *fp; /* File pointer to said file */
};
GMT_LOCAL size_t gmtremote_throw_away (void *ptr, size_t size, size_t nmemb, void *data) {
gmt_M_unused (ptr);
gmt_M_unused (data);
/* We are not interested in the headers itself,
so we only return the file size we would have saved ... */
return (size_t)(size * nmemb);
}
GMT_LOCAL size_t gmtremote_fwrite_callback (void *buffer, size_t size, size_t nmemb, void *stream) {
struct FtpFile *out = (struct FtpFile *)stream;
if (out == NULL) return GMT_NOERROR; /* This cannot happen but Coverity fusses */
if (!out->fp) { /* Open file for writing */
out->fp = fopen (out->filename, "wb");
if (!out->fp)
return -1; /* failure, can't open file to write */
}
return fwrite (buffer, size, nmemb, out->fp);
}
GMT_LOCAL int gmtremote_compare_names (const void *item_1, const void *item_2) {
/* Compare function used to sort the GMT_DATA_INFO array of structures into alphabetical order */
const char *name_1 = ((struct GMT_DATA_INFO *)item_1)->file;
const char *name_2 = ((struct GMT_DATA_INFO *)item_2)->file;
return (strcmp (name_1, name_2));
}
GMT_LOCAL int gmtremote_parse_version (char *line) {
/* Parse a line like "# 6.1.0 or later GMT version required" and we will make no
* assumptions about how much space before the version. */
int k = 1, start, major, minor, release;
char text[GMT_LEN64] = {""};
if (line[0] != '#') return 1; /* Not a comment record! */
strncpy (text, line, GMT_LEN64-1);
while (isspace (text[k])) k++; /* Skip until we get to the version */
start = k;
while (isdigit(text[k]) || text[k] == '.') k++; /* Wind to end of version */
text[k] = '\0'; /* Chop off the rest */
if (sscanf (&text[start], "%d.%d.%d", &major, &minor, &release) != 3) return 1;
if (major > GMT_MAJOR_VERSION) return 2; /* Definitively too old */
if (major < GMT_MAJOR_VERSION) return 0; /* Should be fine */
if (minor > GMT_MINOR_VERSION) return 2; /* Definitively too old */
if (minor < GMT_MINOR_VERSION) return 0; /* Should be fine */
if (release > GMT_RELEASE_VERSION) return 2; /* Definitively too old */
return GMT_NOERROR;
}
GMT_LOCAL int gmtremote_remove_item (struct GMTAPI_CTRL *API, char *path, bool directory) {
int error = GMT_NOERROR;
if (directory) { /* Delete populated directories via an operating system remove call */
char del_cmd[PATH_MAX] = {""};
#ifdef _WIN32
char *t = gmt_strrep (path, "/", "\\"); /* DOS rmdir needs paths with back-slashes */
strcpy (del_cmd, "rmdir /s /q ");
strncat (del_cmd, t, PATH_MAX-1);
gmt_M_str_free (t);
#else
sprintf (del_cmd, "rm -rf %s", path);
#endif
if ((error = system (del_cmd))) {
GMT_Report (API, GMT_MSG_ERROR, "Failed to remove %s [error = %d]\n", path, error);
error = GMT_RUNTIME_ERROR;
}
}
else /* Just delete a single file */
gmt_remove_file (API->GMT, path);
return error;
}
GMT_LOCAL struct GMT_DATA_INFO *gmtremote_data_load (struct GMTAPI_CTRL *API, int *n) {
/* Read contents of the info file into an array of structs */
bool parse_extra_data = false;
int k = 0, nr, start_here = 0;
FILE *fp = NULL;
struct GMT_DATA_INFO *I = NULL;
char unit, line[GMT_LEN512] = {""}, file[PATH_MAX] = {""}, *c = NULL;
struct GMT_CTRL *GMT = API->GMT;
snprintf (file, PATH_MAX, "%s/%s", GMT->session.USERDIR, GMT_INFO_SERVER_FILE);
GMT_Report (API, GMT_MSG_DEBUG, "Load contents from %s\n", file);
*n = 0;
if ((fp = fopen (file, "r")) == NULL) {
GMT_Report (API, GMT_MSG_ERROR, "Unable to open file %s\n", file);
return NULL;
}
if (fgets (line, GMT_LEN256, fp) == NULL) { /* Try to get first record */
fclose (fp);
GMT_Report (API, GMT_MSG_ERROR, "Read error first record in file %s\n", file);
GMT_Report (API, GMT_MSG_ERROR, "Deleting %s so it can get regenerated - please try again\n", file);
gmt_remove_file (GMT, file);
return NULL;
}
*n = atoi (line); /* Number of non-commented records to follow */
if (*n <= 0 || *n > GMT_BIG_CHUNK) { /* Probably not a good value */
fclose (fp);
GMT_Report (API, GMT_MSG_ERROR, "Bad record counter in file %s\n", file);
GMT_Report (API, GMT_MSG_ERROR, "Deleting %s so it can get regenerated - please try again\n", file);
gmt_remove_file (GMT, file);
return NULL;
}
if (fgets (line, GMT_LEN256, fp) == NULL) { /* Try to get second record */
fclose (fp);
GMT_Report (API, GMT_MSG_ERROR, "Read error second record in file %s\n", file);
return NULL;
}
if ((k = gmtremote_parse_version (line))) {
fclose (fp);
gmt_chop (line);
if (k == 2)
GMT_Report (API, GMT_MSG_NOTICE, "Your GMT version too old to use the remote data mechanism - please upgrade to %s or later\n", line);
else
GMT_Report (API, GMT_MSG_ERROR, "Unable to parse \"%s\" to extract GMT version\n", line);
*n = 0; /* No good */
return NULL;
}
if ((I = gmt_M_memory (GMT, NULL, *n, struct GMT_DATA_INFO)) == NULL) {
fclose (fp);
GMT_Report (API, GMT_MSG_ERROR, "Unable to allocate %d GMT_DATA_INFO structures!\n", *n);
return NULL;
}
/* Watch for "#% " records with high-res data in very odd resolutions, such as 52.0732883317s for Pluto's original grid.
* Since 6.4 only used 8-bytes to hold that resolution it is not able to use that dataset - it requires >= 6.5.
* Thus, such information records are flagged by a leading "#% " which turns it into a comment and it is then
* always skipped by those GMT version who are not aware of this yet. GMT 6.5 will, however, be allowed to parse
* such lines (skipping the 3 leading bytes) and has a 32-byte struct member to hold the much longer string.
*/
parse_extra_data = (GMT_MAJOR_VERSION > 6 || (GMT_MAJOR_VERSION == 6 && GMT_MINOR_VERSION >= 5));
while (fgets (line, GMT_LEN512, fp) != NULL) {
start_here = 0; /* line[0] is the start of the info record */
if (line[0] == '#') { /* Skip any comments unless parse_extra_data is true */
if (parse_extra_data && strncmp (line, "#% ", 3U) == 0) {
start_here = 3;
(*n)++; /* Got one more data set via the #% comment - increase array */
if ((I = gmt_M_memory (GMT, I, *n, struct GMT_DATA_INFO)) == NULL) {
fclose (fp);
GMT_Report (API, GMT_MSG_ERROR, "Unable to reallocate %d GMT_DATA_INFO structures!\n", *n);
return NULL;
}
}
else /* No, just skip the comment */
continue;
}
if ((nr = sscanf (&line[start_here], "%s %s %s %c %lg %lg %s %lg %s %s %s %s %[^\n]", I[k].dir, I[k].file, I[k].inc, &I[k].reg, &I[k].scale, &I[k].offset, I[k].size, &I[k].tile_size, I[k].date, I[k].coverage, I[k].filler, I[k].CPT, I[k].remark)) != 13) {
GMT_Report (API, GMT_MSG_WARNING, "File %s should have 13 fields but only %d read for record %d - download error???\n", file, nr, k);
gmt_M_free (GMT, I);
fclose (fp);
return NULL;
}
/* Extract some useful bits to have in separate variables */
sscanf (I[k].inc, "%lg%c", &I[k].d_inc, &unit);
if (unit == 'm') I[k].d_inc *= GMT_MIN2DEG; /* E.g., 30m becomes 0.5 */
else if (unit == 's') I[k].d_inc *= GMT_SEC2DEG; /* E.g., 30s becomes 0.00833333333333 */
if ((c = strchr (I[k].file, '.'))) /* Get the file extension */
strcpy (I[k].ext, c);
if (I[k].tile_size > 0.0) { /* A tiled dataset */
size_t len = strlen (I[k].file);
strncpy (I[k].tag, I[k].file, len-1); /* Remote trailing slash */
}
k++;
}
fclose (fp);
if (k != *n) {
GMT_Report (API, GMT_MSG_WARNING, "File %s said it has %d records but only found %d - download error???\n", file, *n, k);
GMT_Report (API, GMT_MSG_WARNING, "File %s should be deleted. Please try again\n", file);
*n = 0; /* Flag that excrement hit the fan */
}
/* Soft alphabetically on file names */
qsort (I, *n, sizeof (struct GMT_DATA_INFO), gmtremote_compare_names);
for (k = 0; k < *n; k++) I[k].id = k; /* Give running number as ID in the sorted array */
if (GMT->current.io.new_data_list) { /* Take this opportunity to delete datasets that are past their expiration date */
time_t mod_time;
struct tm *UTC = NULL;
struct stat buf;
int year, month, day, kyear, kmonth, kday;
size_t L;
GMT->current.io.new_data_list = false; /* We only do this once after a gmt_data_server.txt update */
if (GMT->session.USERDIR == NULL) goto out_of_here; /* Cannot have server data if no user directory is set */
if (access (GMT->session.USERDIR, R_OK)) goto out_of_here; /* Set, but have not made a user directory yet, so cannot have any remote data yet either */
for (k = 0; k < *n; k++) { /* Check the release date of each data set that has been downloaded against the local file date */
if (sscanf (I[k].date, "%d-%d-%d", &kyear, &kmonth, &kday) != 3) continue; /* Maybe malformed datestring or on purpose to never check */
snprintf (file, PATH_MAX, "%s/%s%s", GMT->session.USERDIR, I[k].dir, I[k].file); /* Local path, may end in slash if a tile directory*/
if ((L = strlen (file) - 1) && file[L] == '/') file[L] = '\0'; /* Chop off trailing / that indicates directory of tiles */
if (access (file, R_OK)) continue; /* No such file or directory yet */
/* Here we have a local copy of this remote file or directory - we examine its creation date */
if (stat (file, &buf)) {
GMT_Report (API, GMT_MSG_WARNING, "Unable to get information about %s - skip\n", file);
continue;
}
/* Get its modification (creation) time */
#ifdef __APPLE__
mod_time = buf.st_mtimespec.tv_sec; /* Apple even has tv_nsec for nano-seconds... */
#else
mod_time = buf.st_mtime;
#endif
/* Extract the year, month, day integers */
UTC = gmtime (&mod_time);
year = UTC->tm_year + 1900; /* Yep, how stupid is that, Y2K lovers. I guess 2030 might overflow a 32-bit int... */
month = UTC->tm_mon + 1; /* Make it 1-12 since it is 0-11 */
day = UTC->tm_mday; /* Yep, lets start at 1 for days and 0 for months, makes sense */
if (kyear < year) continue; /* The origin year is older than our file so no need to check further */
if (kyear == year) { /* Our file and the server file is both from the same year */
if (kmonth < month) continue; /* The origin month is older than our copy so no need to check further */
if (kmonth == month) { /* Same year, same month, we are so close! */
if (kday < day) continue; /* The origin day is older than our copy so no need to check further */
}
}
/* If we get here we need to remove the outdated file or directory so we may download the latest on next try */
if (gmtremote_remove_item (API, file, I[k].tile_size > 0.0)) {
GMT_Report (GMT->parent, GMT_MSG_WARNING, "Unable to remove %s \n", file);
}
}
}
out_of_here:
return (I);
};
GMT_LOCAL int gmtremote_compare_key (const void *item_1, const void *item_2) {
/* We are passing string item_1 without any leading @ */
const char *name_1 = (char *)item_1;
const char *name_2 = ((struct GMT_DATA_INFO *)item_2)->file;
size_t len = strlen (name_1);
return (strncmp (name_1, name_2, len));
}
GMT_LOCAL int gmtremote_wind_to_file (const char *file) {
int k = (int)(strlen (file) - 2); /* This jumps past any trailing / for tiles */
while (k >= 0 && file[k] != '/') k--;
return (k+1);
}
int gmt_remote_no_resolution_given (struct GMTAPI_CTRL *API, const char *rfile, int *registration) {
/* Return first entry to a list of different resolutions for the
* same data set. For instance, if file is "earth_relief" then we
* return the ID to the first one listed. */
char *c = NULL, *p = NULL, dir[GMT_LEN64] = {""}, file[GMT_LEN128] = {""};
int ID = GMT_NOTSET, reg = GMT_NOTSET;
size_t L;
if (rfile == NULL || rfile[0] == '\0') return GMT_NOTSET; /* No file name given */
if (rfile[0] != '@') return GMT_NOTSET; /* No remote file name given */
strcpy (file, &rfile[1]); /* Make a copy but skipping leading @ character */
if ((c = strchr (file, '+'))) c[0] = '\0'; /* Chop of modifiers such as in grdimage -I */
L = strlen (file);
if (!strncmp (&file[L-2], "_g", 2U)) { /* Want a gridline-registered version */
reg = GMT_GRID_NODE_REG;
file[L-2] = '\0';
}
else if (!strncmp (&file[L-2], "_p", 2U)) { /* Want a pixel-registered version */
reg = GMT_GRID_PIXEL_REG;
file[L-2] = '\0';
}
for (int k = 0; ID == GMT_NOTSET && k < API->n_remote_info; k++) {
L = strlen (API->remote_info[k].dir) - 1; /* Length of directory without the trailing slash */
strncpy (dir, API->remote_info[k].dir, L); /* Make a copy without the trailing slash */
dir[L] = '\0'; /* Terminate string */
p = strrchr (dir, '/'); /* Start of final subdirectory */
p++; /* Skip past the slash */
if (!strcmp (p, file)) ID = k; /* Found it */
}
if (ID != GMT_NOTSET && registration)
*registration = reg; /* Pass back desired [or any] registration */
return (ID); /* Start of the family or -1 */
}
struct GMT_RESOLUTION *gmt_remote_resolutions (struct GMTAPI_CTRL *API, const char *rfile, unsigned int *n) {
/* Return list of available resolutions and registrations for the specified data set family.
* For instance, if file is "earth_relief" then we return an array of structs
* with the resolution and registration from 01d (g&p) to 91s (g) .*/
char *c = NULL, *p = NULL, dir[GMT_LEN64] = {""}, file[GMT_LEN128] = {""};
static char *registration = "gp"; /* The two types of registrations */
int reg = GMT_NOTSET;
unsigned int id = 0;
size_t L, n_alloc = GMT_SMALL_CHUNK;
struct GMT_RESOLUTION *R = NULL;
if (rfile == NULL || rfile[0] == '\0') return NULL; /* No file name given */
if (rfile[0] != '@') return NULL; /* No remote file name given */
strcpy (file, &rfile[1]); /* Make a copy but skipping leading @ character */
if ((c = strchr (file, '+'))) c[0] = '\0'; /* Chop of modifiers such as in grdimage -I */
L = strlen (file);
if (!strncmp (&file[L-2], "_g", 2U)) { /* Want a gridline-registered version */
reg = GMT_GRID_NODE_REG;
file[L-2] = '\0';
}
else if (!strncmp (&file[L-2], "_p", 2U)) { /* Want a pixel-registered version */
reg = GMT_GRID_PIXEL_REG;
file[L-2] = '\0';
}
if ((R = gmt_M_memory (API->GMT, NULL, n_alloc, struct GMT_RESOLUTION)) == NULL)
return NULL; /* No memory */
for (int k = 0; k < API->n_remote_info; k++) {
L = strlen (API->remote_info[k].dir) - 1; /* Length of directory without the trailing slash */
strncpy (dir, API->remote_info[k].dir, L); /* Make a copy without the trailing slash */
dir[L] = '\0'; /* Terminate string */
p = strrchr (dir, '/'); /* Start of final subdirectory */
p++; /* Skip past the slash */
if (!strcmp (p, file) && (reg == GMT_NOTSET || registration[reg] == API->remote_info[k].reg)) { /* Got one to keep */
R[id].resolution = urint (1.0 / API->remote_info[k].d_inc); /* Number of nodes per degree */
strncpy (R[id].inc, API->remote_info[k].inc, GMT_LEN32); /* Copy the formatted inc string */
R[id].reg = API->remote_info[k].reg; /* Copy the registration */
id++;
}
if (id == n_alloc) { /* Need more memory */
n_alloc += GMT_SMALL_CHUNK;
if ((R = gmt_M_memory (API->GMT, NULL, n_alloc, struct GMT_RESOLUTION)) == NULL)
return NULL; /* No memory */
}
}
if (id) { /* Did find some */
if ((R = gmt_M_memory (API->GMT, R, id, struct GMT_RESOLUTION)) == NULL)
return NULL; /* No memory */
*n = id;
}
else { /* No luck, probably filename typo */
gmt_M_free (API->GMT, R);
*n = 0;
}
return (R);
}
int gmt_remote_dataset_id (struct GMTAPI_CTRL *API, const char *ifile) {
/* Return the entry in the remote file table of file is found, else -1.
* Complications to consider before finding a match:
* Input file may or may not have leading @
* Input file may or may not have _g or _p for registration
* Input file may or many not have an extension
* Key file may be a tiled data set and thus ends with '/'
*/
int pos = 0;
char file[PATH_MAX] = {""};
struct GMT_DATA_INFO *key = NULL;
if (ifile == NULL || ifile[0] == '\0') return GMT_NOTSET; /* No file name given */
if (ifile[0] == '@') pos = 1; /* Skip any leading remote flag */
/* Exclude leading directory for local saved versions of the file */
if (pos == 0) pos = gmtremote_wind_to_file (ifile); /* Skip any leading directories */
/* Must handle the use of srtm_relief vs earth_relief for the 01s and 03s data */
if (strncmp (&ifile[pos], "srtm_relief_0", 13U) == 0) /* Gave strm special name */
sprintf (file, "earth_%s", &ifile[pos+5]); /* Replace srtm with earth */
else /* Just copy as is from pos */
strcpy (file, &ifile[pos]);
key = bsearch (file, API->remote_info, API->n_remote_info, sizeof (struct GMT_DATA_INFO), gmtremote_compare_key);
if (key) { /* Make sure we actually got a real hit since file = "earth" will find a key starting with "earth****" */
char *ckey = strrchr (key->file, '.'); /* Find location of the start of the key file extension (or NULL if no extension) */
char *cfile = strrchr (file, '.'); /* Find location of the start of the input file extension (or NULL if no extension) */
size_t Lfile = (cfile) ? (size_t)(cfile - file) : strlen (file); /* Length of key file name without extension */
size_t Lkey = (ckey) ? (size_t)(ckey - key->file) : strlen (key->file); /* Length of key file name without extension */
if (ckey == NULL && Lkey > 1 && key->file[Lkey-1] == '/') Lkey--; /* Skip trailing dir flag */
if (Lkey > Lfile && Lkey > 2 && key->file[Lkey-2] == '_' && strchr ("gp", key->file[Lkey-1])) Lkey -= 2; /* Remove the length of _g or _p from Lkey */
if (Lfile != Lkey) /* Not an exact match (apart from trailing _p|g) */
key = NULL;
}
return ((key == NULL) ? GMT_NOTSET : key->id);
}
bool gmt_file_is_cache (struct GMTAPI_CTRL *API, const char *file) {
/* Returns true if a remote file is a cache file */
if (file == NULL || file[0] == '\0') return false; /* Nothing given */
if (gmt_M_file_is_memory (file)) return false; /* Memory files are not remote */
if (file[0] != '@') return false; /* Cannot be a remote file, let alone cache */
if (gmt_remote_dataset_id (API, file) != GMT_NOTSET) return false; /* Found a remote dataset, but not cache */
return true;
}
int gmt_set_unspecified_remote_registration (struct GMTAPI_CTRL *API, char **file_ptr) {
/* If a remote file is missing _g or _p we find which one we should use and revise the file accordingly.
* There are a few different scenarios where this can happen:
* 1. Users of GMT <= 6.0.0 are used to say earth_relief_01m. These will now get p.
* 2. Users who do not care about registration. If so, they get p if available.
* We return 1 if filename was changed, otherwise 0. */
char newfile[GMT_LEN256] = {""}, dir[GMT_LEN128] = {""}, reg[2] = {'p', 'g'};
char *file = NULL, *infile = NULL, *c = NULL, *p = NULL, *q = NULL;
int k_data, k, kstart = 0, kstop = 2, kinc = 1, reg_added = 0;
size_t L;
if (file_ptr == NULL || (file = *file_ptr) == NULL || file[0] == '\0') return 0;
if (gmt_M_file_is_memory (file)) return 0; /* Not a remote file for sure */
if (file[0] != '@') return 0;
infile = strdup (file);
if ((c = strchr (infile, '+'))) /* Got modifiers, probably from grdimage or similar, chop off for now */
c[0] = '\0';
/* Deal with any extension the user may have added */
(void)gmt_chop_ext (infile);
/* If the remote file is found then there is nothing to do */
if ((k_data = gmt_remote_dataset_id (API, infile)) == GMT_NOTSET) goto clean_up;
API->remote_id = k_data;
L = strlen (API->remote_info[k_data].dir) - 1; /* Length of dir minus trailing slash */
strncpy (dir, API->remote_info[k_data].dir, L); dir[L] = '\0'; /* Duplicate dir without slash */
p = strrchr (dir, '/') + 1; /* Start of final subdirectory (skipping over the slash we found) */
q = strstr (file, p); /* Start of the file name (most likely the same as &file[1] but we want to make sure) */
if (q == NULL) return 0; /* Should never happen but definitively nothing more to do here - just a safety valve */
q += strlen (p); /* Move to the end of family name after which any registration codes would be found */
if (strstr (q, "_p") || strstr (q, "_g")) goto clean_up; /* Already have the registration codes */
if (API->use_gridline_registration) { /* Switch order so checking for g first, then p */
if (API->use_gridline_registration_warn)
GMT_Report (API, GMT_MSG_INFORMATION, "Remote dataset given to a data processing module but no registration was specified - default to gridline registration (if available)\n");
kstart = 1; kstop = -1; kinc = -1;
}
for (k = kstart; k != kstop; k += kinc) {
/* First see if this _<reg> version exists of this dataset */
sprintf (newfile, "%s_%c", infile, reg[k]);
if ((k_data = gmt_remote_dataset_id (API, newfile)) != GMT_NOTSET) {
/* Found, replace given file name with this */
if (c) { /* Restore the modifiers */
c[0] = '+';
if (gmt_found_modifier (API->GMT, c, "os"))
GMT_Report (API, GMT_MSG_WARNING, "Cannot append +s<scl> and/or +o<offset> to the remote global grid %s - ignored\n", newfile);
else
strcat (newfile, c);
}
gmt_M_str_free (*file_ptr);
*file_ptr = strdup (newfile);
API->remote_id = k_data;
GMT_Report (API, GMT_MSG_DEBUG, "Input remote grid modified to have registration: %s\n", newfile);
reg_added = 1;
goto clean_up;
}
}
clean_up:
gmt_M_str_free (infile);
return (reg_added);
}
int gmt_remote_no_extension (struct GMTAPI_CTRL *API, const char *file) {
int k_data = gmt_remote_dataset_id (API, file);
if (k_data == GMT_NOTSET) return GMT_NOTSET;
if (API->remote_info[k_data].ext[0] == '\0') return GMT_NOTSET; /* Tiled grid */
if (strstr (file, API->remote_info[k_data].ext)) return GMT_NOTSET; /* Already has extension */
return k_data; /* Missing its extension */
}
GMT_LOCAL void gmtremote_display_attribution (struct GMTAPI_CTRL *API, int key, const char *file, int tile) {
/* Display a notice regarding the source of this data set */
char *c = NULL, name[GMT_LEN128] = {""};
if (key != GMT_NOTSET && !API->server_announced && !strchr (file, ':')) { /* Server file has no http:// here */
if ((c = strrchr (API->GMT->session.DATASERVER, '/'))) /* Found last slash in http:// */
strcpy (name, ++c);
else /* Just in case */
strncpy (name, gmt_dataserver_url (API), GMT_LEN128-1);
if ((c = strchr (name, '.'))) c[0] = '\0'; /* Chop off stuff after the initial name */
gmt_str_toupper (name);
GMT_Report (API, GMT_MSG_NOTICE, "Remote data courtesy of GMT data server %s [%s]\n\n", API->GMT->session.DATASERVER, gmt_dataserver_url (API));
API->server_announced = true;
}
if (key == GMT_NOTSET) { /* A Cache file */
if (strchr (file, ':')) /* Generic URL */
GMT_Report (API, GMT_MSG_INFORMATION, " -> Download URL file: %s\n", file);
else
GMT_Report (API, GMT_MSG_INFORMATION, " -> Download cache file: %s\n", file);
}
else { /* Remote data sets */
if (!API->remote_info[key].used) {
GMT_Report (API, GMT_MSG_NOTICE, "%s.\n", API->remote_info[key].remark);
API->remote_info[key].used = true;
}
if (tile) { /* Temporarily remote the trailing slash when printing the dataset name */
c = strrchr (API->remote_info[key].file, '/');
c[0] = '\0';
strncpy (name, &file[1], 7U); name[7] = '\0';
GMT_Report (API, GMT_MSG_NOTICE, " -> Download %lgx%lg degree grid tile (%s): %s\n",
API->remote_info[key].tile_size, API->remote_info[key].tile_size, API->remote_info[key].file, name);
c[0] = '/';
}
else
GMT_Report (API, GMT_MSG_NOTICE, " -> Download grid file [%s]: %s\n", API->remote_info[key].size, API->remote_info[key].file);
}
}
GMT_LOCAL int gmtremote_find_and_give_data_attribution (struct GMTAPI_CTRL *API, const char *file) {
/* Print attribution when the @remotefile is downloaded for the first time */
char *c = NULL;
int match, tile = 0;
if (file == NULL || file[0] == '\0') return GMT_NOTSET; /* No file name given */
if ((c = strstr (file, ".grd")) || (c = strstr (file, ".tif"))) /* Ignore extension in comparison */
c[0] = '\0';
if ((match = gmt_remote_dataset_id (API, file)) == GMT_NOTSET) { /* Check if it is a tile */
if ((match = gmt_file_is_a_tile (API, file, GMT_LOCAL_DIR)) != GMT_NOTSET) /* Got a remote tile */
tile = 1;
}
gmtremote_display_attribution (API, match, file, tile);
if (c) c[0] = '.'; /* Restore extension */
return (match);
}
GMT_LOCAL char *gmtremote_lockfile (struct GMT_CTRL *GMT, char *file) {
/* Create a dummy file in temp with extension .download and use as a lock file */
char *c = strrchr (file, '/');
char Lfile[PATH_MAX] = {""};
if (c) /* Found the last slash, skip it */
c++;
else /* No path, just point to file */
c = file;
if (c[0] == '@') c++; /* Skip any leading @ sign */
sprintf (Lfile, "%s/%s.download", GMT->parent->tmp_dir, c);
return (strdup (Lfile));
}
GMT_LOCAL size_t gmtremote_skip_large_files (struct GMT_CTRL *GMT, char * URL, size_t limit) {
/* Get the remote file's size and if too large we refuse to download */
CURL *curl = NULL;
CURLcode res;
curl_off_t filesize = 0;
size_t action = 0;
char curl_useragent[GMT_LEN64];
if (limit == 0) return 0; /* Download regardless of size */
curl_global_init (CURL_GLOBAL_DEFAULT);
if ((curl = curl_easy_init ())) {
curl_easy_setopt (curl, CURLOPT_URL, URL);
/* Set the user agent */
sprintf (curl_useragent, "GMT/%s", GMT_STRING);
curl_easy_setopt(curl, CURLOPT_USERAGENT, curl_useragent);
/* Do not download the file */
curl_easy_setopt (curl, CURLOPT_NOBODY, 1L);
/* Tell libcurl to not verify the peer */
curl_easy_setopt (curl, CURLOPT_SSL_VERIFYPEER, 0L);
/* Tell libcurl to fail on 4xx responses (e.g. 404) */
curl_easy_setopt (curl, CURLOPT_FAILONERROR, 1L);
/* Tell libcurl to follow 30x redirects */
curl_easy_setopt (curl, CURLOPT_FOLLOWLOCATION, 1L);
/* No header output: TODO 14.1 http-style HEAD output for ftp */
curl_easy_setopt (curl, CURLOPT_HEADERFUNCTION, gmtremote_throw_away);
curl_easy_setopt (curl, CURLOPT_HEADER, 0L);
/* Complete connection within 10 seconds */
curl_easy_setopt (curl, CURLOPT_CONNECTTIMEOUT, GMT_CONNECT_TIME_OUT);
res = curl_easy_perform (curl);
if ((res = curl_easy_perform (curl)) == CURLE_OK) {
res = curl_easy_getinfo (curl, CURLINFO_CONTENT_LENGTH_DOWNLOAD_T, &filesize);
if ((res == CURLE_OK) && (filesize > 0.0)) { /* Got the size */
GMT_Report (GMT->parent, GMT_MSG_INFORMATION, "Remote file %s: Size is %0.0f bytes\n", URL, filesize);
action = ((size_t)filesize < limit) ? 0 : (size_t)filesize;
}
}
else /* We failed */
GMT_Report (GMT->parent, GMT_MSG_ERROR, "Remote file %s: Curl returned error %d\n", URL, res);
/* always cleanup */
curl_easy_cleanup (curl);
}
curl_global_cleanup ();
return action;
}
CURL * gmtremote_setup_curl (struct GMTAPI_CTRL *API, char *url, char *local_file, struct FtpFile *urlfile, unsigned int time_out) {
/* Single function that sets up an impending CURL operation */
char curl_useragent[GMT_LEN64];
CURL *Curl = NULL;
if ((Curl = curl_easy_init ()) == NULL) {
GMT_Report (API, GMT_MSG_ERROR, "Failed to initiate curl - cannot obtain %s\n", url);
return NULL;
}
sprintf (curl_useragent, "GMT/%s", GMT_STRING);
if (curl_easy_setopt(Curl, CURLOPT_USERAGENT, curl_useragent)) { /* Set the user agent */
GMT_Report (API, GMT_MSG_ERROR, "Failed to set curl user agent\n");
return NULL;
}
if (curl_easy_setopt (Curl, CURLOPT_SSL_VERIFYPEER, 0L)) { /* Tell libcurl to not verify the peer */
GMT_Report (API, GMT_MSG_ERROR, "Failed to set curl option to not verify the peer\n");
return NULL;
}
if (curl_easy_setopt (Curl, CURLOPT_FOLLOWLOCATION, 1L)) { /* Tell libcurl to follow 30x redirects */
GMT_Report (API, GMT_MSG_ERROR, "Failed to set curl option to follow redirects\n");
return NULL;
}
if (curl_easy_setopt (Curl, CURLOPT_FAILONERROR, 1L)) { /* Tell libcurl to fail on 4xx responses (e.g. 404) */
GMT_Report (API, GMT_MSG_ERROR, "Failed to set curl option to fail for 4xx responses\n");
return NULL;
}
if (curl_easy_setopt (Curl, CURLOPT_URL, url)) { /* Set the URL to copy */
GMT_Report (API, GMT_MSG_ERROR, "Failed to set curl option to read from %s\n", url);
return NULL;
}
if (curl_easy_setopt (Curl, CURLOPT_CONNECTTIMEOUT, GMT_CONNECT_TIME_OUT)) { /* Set connection timeout to 10s [300] */
GMT_Report (API, GMT_MSG_ERROR, "Failed to set curl option to limit connection timeout to %lds\n", GMT_CONNECT_TIME_OUT);
return NULL;
}
if (time_out) { /* Set a timeout limit */
if (curl_easy_setopt (Curl, CURLOPT_TIMEOUT, time_out)) {
GMT_Report (API, GMT_MSG_ERROR, "Failed to set curl option to time out after %d seconds\n", time_out);
return NULL;
}
}
urlfile->filename = local_file; /* Set pointer to local filename */
/* Define our callback to get called when there's data to be written */
if (curl_easy_setopt (Curl, CURLOPT_WRITEFUNCTION, gmtremote_fwrite_callback)) {
GMT_Report (API, GMT_MSG_ERROR, "Failed to set curl output callback function\n");
return NULL;
}
/* Set a pointer to our struct that will be passed to the callback function */
if (curl_easy_setopt (Curl, CURLOPT_WRITEDATA, urlfile)) {
GMT_Report (API, GMT_MSG_ERROR, "Failed to set curl option to write to %s\n", local_file);
return NULL;
}
return Curl; /* Happily return the Curl pointer */
}
GMT_LOCAL struct LOCFILE_FP *gmtremote_lock_on (struct GMT_CTRL *GMT, char *file) {
/* Creates filename for lock and activates the lock */
struct LOCFILE_FP *P = gmt_M_memory (GMT, NULL, 1, struct LOCFILE_FP);
if (P == NULL) return NULL;
P->file = gmtremote_lockfile (GMT, file);
if ((P->fp = fopen (P->file, "w")) == NULL) {
GMT_Report (GMT->parent, GMT_MSG_ERROR, "Failed to create lock file %s\n", P->file);
gmt_M_str_free (P->file);
gmt_M_free (GMT, P);
return NULL;
}
gmtlib_file_lock (GMT, fileno(P->fp)); /* Attempt exclusive lock */
return P;
}
GMT_LOCAL void gmtremote_lock_off (struct GMT_CTRL *GMT, struct LOCFILE_FP **P) {
/* Deactivates the lock on the file */
gmtlib_file_unlock (GMT, fileno((*P)->fp));
fclose ((*P)->fp);
gmt_remove_file (GMT, (*P)->file);
gmt_M_str_free ((*P)->file);
gmt_M_free (GMT, *P);
}
/* Deal with hash values of cache/data files */
GMT_LOCAL int gmtremote_get_url (struct GMT_CTRL *GMT, char *url, char *file, char *orig, unsigned int index, bool do_lock) {
bool turn_ctrl_C_off = false;
int curl_err = 0, error = GMT_NOERROR;
long time_spent;
CURL *Curl = NULL;
struct LOCFILE_FP *LF = NULL;
struct FtpFile urlfile = {NULL, NULL};
struct GMTAPI_CTRL *API = GMT->parent;
time_t begin, end;
if (GMT->current.setting.auto_download == GMT_NO_DOWNLOAD) { /* Not allowed to use remote copying */
GMT_Report (GMT->parent, GMT_MSG_INFORMATION, "Remote download is currently deactivated\n");
return 1;
}
if (GMT->current.io.internet_error) return 1; /* Not able to use remote copying in this session */
/* Make a lock */
if (do_lock && (LF = gmtremote_lock_on (GMT, file)) == NULL)
return 1;
/* If file locking held us up as another process was downloading the same file,
* then that file should now be available. So we check again if it is before proceeding */
if (do_lock && !access (file, F_OK))
goto unlocking1; /* Yes it was, unlock and return no error */
/* Initialize the curl session */
if ((Curl = gmtremote_setup_curl (API, url, file, &urlfile, GMT_HASH_TIME_OUT)) == NULL)
goto unlocking1;
GMT_Report (GMT->parent, GMT_MSG_INFORMATION, "Downloading file %s ...\n", url);
gmtremote_turn_on_ctrl_C_check (file); turn_ctrl_C_off = true;
begin = time (NULL);
if ((curl_err = curl_easy_perform (Curl))) { /* Failed, give error message */
end = time (NULL);
time_spent = (long)(end - begin);
GMT_Report (GMT->parent, GMT_MSG_INFORMATION, "Unable to download file %s\n", url);
GMT_Report (GMT->parent, GMT_MSG_INFORMATION, "Libcurl Error: %s\n", curl_easy_strerror (curl_err));
if (urlfile.fp != NULL) {
fclose (urlfile.fp);
urlfile.fp = NULL;
}
if (time_spent >= GMT_HASH_TIME_OUT) { /* Ten seconds is too long time - server down? */
GMT_Report (GMT->parent, GMT_MSG_INFORMATION, "GMT data server may be down - delay checking hash file for 24 hours\n");
GMT_Report (GMT->parent, GMT_MSG_INFORMATION, "You can turn remote file download off by setting GMT_DATA_UPDATE_INTERVAL to \"off\"\n");
if (orig && !access (orig, F_OK)) { /* Refresh modification time of original hash file */
#ifdef WIN32
_utime (orig, NULL);
#else
utimes (orig, NULL);
#endif
GMT->current.io.refreshed[index] = GMT->current.io.internet_error = true;
}
}
error = 1; goto unlocking1;
}
curl_easy_cleanup (Curl);
if (urlfile.fp) /* close the local file */
fclose (urlfile.fp);
unlocking1:
/* Remove lock file after successful download */
if (do_lock) gmtremote_lock_off (GMT, &LF);
if (turn_ctrl_C_off) gmtremote_turn_off_ctrl_C_check ();
return error;
}
GMT_LOCAL struct GMT_DATA_HASH *gmtremote_hash_load (struct GMT_CTRL *GMT, char *file, int *n) {
/* Read contents of the hash file into an array of structs */
int k;
FILE *fp = NULL;
struct GMT_DATA_HASH *L = NULL;
char line[GMT_LEN256] = {""};
GMT_Report (GMT->parent, GMT_MSG_DEBUG, "Load contents from %s\n", file);
*n = 0;
if ((fp = fopen (file, "r")) == NULL) return NULL;
if (fgets (line, GMT_LEN256, fp) == NULL) { /* Try to get first record */
fclose (fp);
return NULL;
}
*n = atoi (line); /* Number of records to follow */
if (*n <= 0 || *n > GMT_BIG_CHUNK) { /* Probably not a good value */
fclose (fp);
return NULL;
}
if ((L = gmt_M_memory (GMT, NULL, *n, struct GMT_DATA_HASH)) == NULL) return NULL;
for (k = 0; k < *n; k++) {
if (fgets (line, GMT_LEN256, fp) == NULL) break; /* Next record */
sscanf (line, "%s %s %" PRIuS, L[k].name, L[k].hash, &L[k].size);
}
fclose (fp);
if (k != *n) {
GMT_Report (GMT->parent, GMT_MSG_WARNING, "File %s said it has %d records but only found %d - download error???\n", file, *n, k);
GMT_Report (GMT->parent, GMT_MSG_WARNING, "File %s will be deleted. Please try again\n", file);
*n = 0; /* Flag that excrement hit the fan */
}
return (L);
};
GMT_LOCAL char * gmtlib_prepend_server_name (struct GMT_CTRL *GMT, bool cache) {
/* If the current GMT server is one of candidate, static, or test, then
* we append that directory to the local path so that we do not overwrite
* what we obtain from the official server [e.g., oceania, europe, ...]
* which places data under the "server" directory. */
static char *ghost_server[5] = {"candidate", "static", "test", "server", GMT_DATA_SERVER};
unsigned int k;
if (GMT->session.DATASERVER == NULL) return NULL; /* Not initialized yet */
for (k = 0; k < 3; k++) {
if (!strcmp (GMT->session.DATASERVER, ghost_server[k]))
return (ghost_server[k]);
}
if (k > 3) k--; /* Since oceania is the same as server in this context */
return (cache) ? NULL : ghost_server[k]; /* The users default data server (k = 3) except cache is not under server on oceania */
}
GMT_LOCAL void gmtremote_init_paths (struct GMTAPI_CTRL *API) {
/* If GMT_DATA_SERVER is static|test|candidate then we need to update internal paths */
char *srv_dir = NULL, path[PATH_MAX] = {""};
struct GMT_CTRL *GMT = API->GMT; /* Short hand */
if (API->paths_initialized) return; /* Been here done that */
GMT_Report (API, GMT_MSG_DEBUG, "GMT_DATA_SERVER is %s\n", (GMT->session.DATASERVER == NULL) ? "NOT set" : GMT->session.DATASERVER);
if (GMT->session.DATASERVER == NULL) return;
if ((srv_dir = gmtlib_prepend_server_name (GMT, false)) == NULL) return;
if (!strcmp (srv_dir, "server") || !strcmp ("oceania", GMT_DATA_SERVER)) return;
/* One of the ghost-servers */
gmt_M_str_free (GMT->session.USERDIR);
gmt_M_str_free (GMT->session.CACHEDIR);
snprintf (path, PATH_MAX, "%s/.gmt/%s", GMT->session.HOMEDIR, srv_dir);
GMT->session.USERDIR = gmt_strdup_noquote (path);
snprintf (path, PATH_MAX, "%s/.gmt/%s/cache", GMT->session.HOMEDIR, srv_dir);
GMT->session.CACHEDIR = gmt_strdup_noquote (path);
API->paths_initialized = true;
GMT_Report (API, GMT_MSG_DEBUG, "USERDIR is now %s and CACHEDIR is now %s\n", GMT->session.USERDIR, GMT->session.CACHEDIR);
}
GMT_LOCAL int gmtremote_refresh (struct GMTAPI_CTRL *API, unsigned int index) {
/* This function is called every time we are about to access a @remotefile.
* It is called twice: Once for the hash table and once for the info table.
* First we check that we have the GMT_HASH_SERVER_FILE in the server directory.
* If we don't then we download it and return since no old file to compare to.
* If we do find the hash file then we get its creation time [st_mtime] as
* well as the current system time. If the file is < GMT->current.setting.refresh_time
* days old we are done.
* If the file is older we rename it to *.old and download the latest hash file.
* This is the same for both values of index (hash and info). For hash, we do more:
* Next, we load the contents of both files and do a double loop to find the
* entries for each old file in the new list, for all files. If the old file
* is no longer in the list then we delete the data file. If the hash code for
* a file has changed then we delete the local file so that the new versions
* will be downloaded from the server. Otherwise we do nothing.
* The result of this is that any file(s) that have changed will be removed
* so that they must be downloaded again to get the new versions.
*/
struct stat buf;
time_t mod_time, right_now = time (NULL); /* Unix time right now */
char indexpath[PATH_MAX] = {""}, old_indexpath[PATH_MAX] = {""};
char new_indexpath[PATH_MAX] = {""}, url[PATH_MAX] = {""};
const char *index_file = (index == GMT_HASH_INDEX) ? GMT_HASH_SERVER_FILE : GMT_INFO_SERVER_FILE;
struct GMT_CTRL *GMT = API->GMT; /* Short hand */
struct LOCFILE_FP *LF = NULL;
if (GMT->current.io.refreshed[index]) return GMT_NOERROR; /* Already been here */
gmtremote_init_paths (API); /* Initialize USERDIR and CACHEDIR for ghost-servers */
/* Set the full local path to the index_file */
snprintf (indexpath, PATH_MAX, "%s/%s", GMT->session.USERDIR, index_file);
if (access (indexpath, R_OK)) { /* Not found locally so need to download the first time */
char serverdir[PATH_MAX] = {""};
snprintf (serverdir, PATH_MAX, "%s", GMT->session.USERDIR);
if (access (serverdir, R_OK) && gmt_mkdir (serverdir)) {
GMT_Report (API, GMT_MSG_ERROR, "Unable to create GMT server directory : %s\n", serverdir);
return 1;
}
snprintf (url, PATH_MAX, "%s/%s", gmt_dataserver_url (API), index_file);
GMT_Report (API, GMT_MSG_DEBUG, "Download remote file %s for the first time\n", url);
if (gmtremote_get_url (GMT, url, indexpath, NULL, index, true)) {
GMT_Report (API, GMT_MSG_INFORMATION, "Failed to get remote file %s\n", url);
if (!access (indexpath, F_OK)) gmt_remove_file (GMT, indexpath); /* Remove index file just in case it got corrupted or zero size */
GMT->current.setting.auto_download = GMT_NO_DOWNLOAD; /* Temporarily turn off auto download in this session only */
GMT->current.io.internet_error = true; /* No point trying again */
return 1;
}
GMT->current.io.refreshed[index] = true; /* Done our job */
return GMT_NOERROR;
}
else
GMT_Report (API, GMT_MSG_DEBUG, "Local file %s found\n", indexpath);
GMT->current.io.refreshed[index] = true; /* Done our job */
/* Here we have the existing index file and its path is in indexpath. Check how old it is */
if (stat (indexpath, &buf)) {
GMT_Report (API, GMT_MSG_ERROR, "Unable to get information about %s - abort\n", indexpath);
return 1;
}
/* Get its modification (creation) time */
#ifdef __APPLE__
mod_time = buf.st_mtimespec.tv_sec; /* Apple even has tv_nsec for nano-seconds... */
#else
mod_time = buf.st_mtime;
#endif
if ((right_now - mod_time) > (GMT_DAY2SEC_I * GMT->current.setting.refresh_time)) { /* Older than selected number of days; Time to get a new index file */
GMT_Report (API, GMT_MSG_DEBUG, "File %s older than 24 hours, get latest from server.\n", indexpath);
strcpy (new_indexpath, indexpath); /* Duplicate path name */
strcat (new_indexpath, ".new"); /* Append .new to the copied path */
strcpy (old_indexpath, indexpath); /* Duplicate path name */
strcat (old_indexpath, ".old"); /* Append .old to the copied path */
snprintf (url, PATH_MAX, "%s/%s", gmt_dataserver_url (API), index_file); /* Set remote path to new index file */
/* Here we will try to download a file */
/* Make a lock on the file */
if ((LF = gmtremote_lock_on (GMT, (char *)new_indexpath)) == NULL)
return 1;