OpenCPN Partial API docs
Loading...
Searching...
No Matches
chartdbs.cpp
Go to the documentation of this file.
1/**************************************************************************
2 * Copyright (C) 2010 by David S. Register *
3 * Copyright (C) 2010 by Mark A Sikes *
4 * *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) any later version. *
9 * *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
14 * *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, see <https://www.gnu.org/licenses/>. *
17 **************************************************************************/
18
25#include "gl_headers.h"
26
27#include <wx/wxprec.h>
28
29#ifndef WX_PRECOMP
30#include <wx/wx.h>
31#endif
32
33#include <wx/arrimpl.cpp>
34#include <wx/dir.h>
35#include <wx/encconv.h>
36#include <wx/progdlg.h>
37#include <wx/regex.h>
38#include <wx/tokenzr.h>
39#include <wx/evtloop.h>
40
41#include "model/gui_events.h"
42
43#include "chartbase.h"
44#include "chartdbs.h"
45#include "flex_hash.h"
46#include "LOD_reduce.h"
47#include "mbtiles.h"
48#include "navutil.h"
49#include "pluginmanager.h"
50#include "shapefile_basemap.h"
51#include "chartdb_thread.h"
52
53#ifndef UINT32
54#define UINT32 unsigned int
55#endif
56
57#ifdef __ANDROID__
58#include "androidUTIL.h"
59#endif
60
61ChartGroupArray *g_pGroupArray;
62
63static int s_dbVersion; // Database version currently in use at runtime
64 // Needed for ChartTableEntry::GetChartType() only
65 // TODO This can go away at opencpn Version 1.3.8 and
66 // above....
68
69static ChartFamilyEnum GetChartFamily(int charttype) {
70 ChartFamilyEnum cf;
71
72 switch (charttype) {
73 case CHART_TYPE_KAP:
74 cf = CHART_FAMILY_RASTER;
75 break;
76 case CHART_TYPE_GEO:
77 cf = CHART_FAMILY_RASTER;
78 break;
79 case CHART_TYPE_S57:
80 cf = CHART_FAMILY_VECTOR;
81 break;
82 case CHART_TYPE_CM93:
83 cf = CHART_FAMILY_VECTOR;
84 break;
85 case CHART_TYPE_CM93COMP:
86 cf = CHART_FAMILY_VECTOR;
87 break;
88 case CHART_TYPE_DUMMY:
89 cf = CHART_FAMILY_RASTER;
90 break;
91 case CHART_TYPE_UNKNOWN:
92 cf = CHART_FAMILY_UNKNOWN;
93 break;
94 default:
95 cf = CHART_FAMILY_UNKNOWN;
96 break;
97 }
98 return cf;
99}
100
102// ChartTableHeader
104
105void ChartTableHeader::Read(wxInputStream &is) {
106 is.Read(this, sizeof(ChartTableHeader));
107}
108
109void ChartTableHeader::Write(wxOutputStream &os) {
110 char vb[5];
111 sprintf(vb, "V%03d", DB_VERSION_CURRENT);
112
113 memcpy(dbVersion, vb, 4);
114 os.Write(this, sizeof(ChartTableHeader));
115}
116
117bool ChartTableHeader::CheckValid() {
118 char vb[5];
119 sprintf(vb, "V%03d", DB_VERSION_CURRENT);
120 if (strncmp(vb, dbVersion, sizeof(dbVersion))) {
121 wxString msg;
122 char vbo[5];
123 memcpy(vbo, dbVersion, 4);
124 vbo[4] = 0;
125 msg.Append(wxString(vbo, wxConvUTF8));
126 msg.Prepend(" Warning: found incorrect chart db version: ");
127 wxLogMessage(msg);
128
129 // return false; // no match....
130
131 // Try previous version....
132 sprintf(vb, "V%03d", DB_VERSION_PREVIOUS);
133 if (strncmp(vb, dbVersion, sizeof(dbVersion)))
134 return false;
135 else {
136 wxLogMessage(
137 " Scheduling db upgrade to current db version on "
138 "Options->Charts page visit...");
139 return true;
140 }
141
142 } else {
143 wxString msg;
144 char vbo[5];
145 memcpy(vbo, dbVersion, 4);
146 vbo[4] = 0;
147 msg.Append(wxString(vbo, wxConvUTF8));
148 msg.Prepend("Loading chart db version: ");
149 wxLogMessage(msg);
150 }
151
152 return true;
153}
154
156// ChartTableEntry
158
159void ChartTableEntry::SetScale(int scale) {
160 Scale = scale;
161 rounding = 0;
162 // XXX find the right rounding
163 if (Scale >= 1000) rounding = 5 * pow(10, log10(Scale) - 2);
164}
165
166ChartTableEntry::ChartTableEntry(ChartBase &theChart, wxString &utf8Path) {
167 Clear();
168
169 char *pt = (char *)malloc(strlen(utf8Path.mb_str(wxConvUTF8)) + 1);
170 strcpy(pt, utf8Path.mb_str(wxConvUTF8));
171 pFullPath = pt;
172
173 SetScale(theChart.GetNativeScale());
174
175 ChartType = theChart.GetChartType();
176 ChartFamily = theChart.GetChartFamily();
177
178 Skew = theChart.GetChartSkew();
179 ProjectionType = theChart.GetChartProjectionType();
180
181 wxDateTime ed = theChart.GetEditionDate();
182 if (theChart.GetEditionDate().IsValid())
183 edition_date = theChart.GetEditionDate().GetTicks();
184
185 wxFileName fn(theChart.GetFullPath());
186 if (fn.GetModificationTime().IsValid())
187 file_date = fn.GetModificationTime().GetTicks();
188
189 m_pfilename = new wxString; // create and populate helper members
190 *m_pfilename = fn.GetFullName();
191 m_psFullPath = new wxString;
192 *m_psFullPath = utf8Path;
193 m_fullSystemPath = utf8Path;
194 m_FullPath = std::string(pFullPath);
195
196#ifdef __ANDROID__
197 m_fullSystemPath = wxString(utf8Path.mb_str(wxConvUTF8));
198#endif
199
200 Extent ext;
201 theChart.GetChartExtent(&ext);
202 LatMax = ext.NLAT;
203 LatMin = ext.SLAT;
204 LonMin = ext.WLON;
205 LonMax = ext.ELON;
206
207 m_bbox.Set(LatMin, LonMin, LatMax, LonMax);
208
209 // Fill in the PLY information
210 // LOD calculation
211 int LOD_pixels = 1;
212 double scale_max_zoom = Scale / 4;
213
214 double display_ppm = 1 / .00025; // nominal for most LCD displays
215 double meters_per_pixel_max_scale = scale_max_zoom / display_ppm;
216 double LOD_meters = meters_per_pixel_max_scale * LOD_pixels;
217
218 // double LOD_meters = 5;
219
220 // If COVR table has only one entry, us it for the primary Ply Table
221 if (theChart.GetCOVREntries() == 1) {
222 nPlyEntries = theChart.GetCOVRTablePoints(0);
223
224 if (nPlyEntries > 5 && (LOD_meters > .01)) {
225 std::vector<int> index_keep{0, nPlyEntries - 1, 1, nPlyEntries - 2};
226
227 double *DPbuffer = (double *)malloc(2 * nPlyEntries * sizeof(double));
228
229 double *pfed = DPbuffer;
230 Plypoint *ppp = (Plypoint *)theChart.GetCOVRTableHead(0);
231
232 for (int i = 0; i < nPlyEntries; i++) {
233 *pfed++ = ppp->ltp;
234 *pfed++ = ppp->lnp;
235 ppp++;
236 }
237
238 DouglasPeucker(DPbuffer, 1, nPlyEntries - 2, LOD_meters / (1852 * 60),
239 &index_keep);
240 // printf("DB DP Reduction: %d/%d\n", index_keep.size(),
241 // nPlyEntries);
242
243 // Mark the keepers by adding a simple constant to ltp
244 for (unsigned int i = 0; i < index_keep.size(); i++) {
245 DPbuffer[2 * index_keep[i]] += 2000.;
246 }
247
248 float *pf = (float *)malloc(2 * index_keep.size() * sizeof(float));
249 float *pfe = pf;
250
251 for (int i = 0; i < nPlyEntries; i++) {
252 if (DPbuffer[2 * i] > 1000.) {
253 *pfe++ = DPbuffer[2 * i] - 2000.;
254 *pfe++ = DPbuffer[(2 * i) + 1];
255 }
256 }
257
258 pPlyTable = pf;
259 nPlyEntries = index_keep.size();
260 free(DPbuffer);
261 } else {
262 float *pf = (float *)malloc(2 * nPlyEntries * sizeof(float));
263 pPlyTable = pf;
264 float *pfe = pf;
265 Plypoint *ppp = (Plypoint *)theChart.GetCOVRTableHead(0);
266
267 for (int i = 0; i < nPlyEntries; i++) {
268 *pfe++ = ppp->ltp;
269 *pfe++ = ppp->lnp;
270 ppp++;
271 }
272 }
273 }
274 // Else create a rectangular primary Ply Table from the chart extents
275 // and create AuxPly table from the COVR tables
276 else {
277 // Create new artificial Ply table from chart extents
278 nPlyEntries = 4;
279 float *pf1 = (float *)malloc(2 * 4 * sizeof(float));
280 pPlyTable = pf1;
281 float *pfe = pf1;
282 Extent fext;
283 theChart.GetChartExtent(&fext);
284
285 *pfe++ = fext.NLAT; // LatMax;
286 *pfe++ = fext.WLON; // LonMin;
287
288 *pfe++ = fext.NLAT; // LatMax;
289 *pfe++ = fext.ELON; // LonMax;
290
291 *pfe++ = fext.SLAT; // LatMin;
292 *pfe++ = fext.ELON; // LonMax;
293
294 *pfe++ = fext.SLAT; // LatMin;
295 *pfe++ = fext.WLON; // LonMin;
296
297 // Fill in the structure for pAuxPlyTable
298
299 nAuxPlyEntries = theChart.GetCOVREntries();
300 wxASSERT(nAuxPlyEntries);
301 float **pfp = (float **)malloc(nAuxPlyEntries * sizeof(float *));
302 float **pft0 = pfp;
303 int *pip = (int *)malloc(nAuxPlyEntries * sizeof(int));
304
305 for (int j = 0; j < nAuxPlyEntries; j++) {
306 int nPE = theChart.GetCOVRTablePoints(j);
307
308 if (nPE > 5 && (LOD_meters > .01)) {
309 std::vector<int> index_keep{0, nPE - 1, 1, nPE - 2};
310
311 double *DPbuffer = (double *)malloc(2 * nPE * sizeof(double));
312
313 double *pfed = DPbuffer;
314 Plypoint *ppp = (Plypoint *)theChart.GetCOVRTableHead(j);
315
316 for (int i = 0; i < nPE; i++) {
317 *pfed++ = ppp->ltp;
318 *pfed++ = ppp->lnp;
319 ppp++;
320 }
321
322 DouglasPeucker(DPbuffer, 1, nPE - 2, LOD_meters / (1852 * 60),
323 &index_keep);
324 // printf("DBa DP Reduction: %d/%d\n",
325 // index_keep.size(), nPE);
326
327 // Mark the keepers by adding a simple constant to ltp
328 for (unsigned int i = 0; i < index_keep.size(); i++) {
329 DPbuffer[2 * index_keep[i]] += 2000.;
330 }
331
332 float *pf = (float *)malloc(2 * index_keep.size() * sizeof(float));
333 float *pfe1 = pf;
334
335 for (int i = 0; i < nPE; i++) {
336 if (DPbuffer[2 * i] > 1000.) {
337 *pfe1++ = DPbuffer[2 * i] - 2000.;
338 *pfe1++ = DPbuffer[(2 * i) + 1];
339 }
340 }
341
342 pft0[j] = pf;
343 pip[j] = index_keep.size();
344 free(DPbuffer);
345 } else {
346 float *pf_entry =
347 (float *)malloc(theChart.GetCOVRTablePoints(j) * 2 * sizeof(float));
348 memcpy(pf_entry, theChart.GetCOVRTableHead(j),
349 theChart.GetCOVRTablePoints(j) * 2 * sizeof(float));
350 pft0[j] = pf_entry;
351 pip[j] = theChart.GetCOVRTablePoints(j);
352 }
353 }
354
355 pAuxPlyTable = pfp;
356 pAuxCntTable = pip;
357 }
358
359 // Get and populate the NoCovr tables
360
361 nNoCovrPlyEntries = theChart.GetNoCOVREntries();
362 if (nNoCovrPlyEntries == 0) return;
363
364 float **pfpnc = (float **)malloc(nNoCovrPlyEntries * sizeof(float *));
365 float **pft0nc = pfpnc;
366 int *pipnc = (int *)malloc(nNoCovrPlyEntries * sizeof(int));
367
368 for (int j = 0; j < nNoCovrPlyEntries; j++) {
369 float *pf_entry =
370 (float *)malloc(theChart.GetNoCOVRTablePoints(j) * 2 * sizeof(float));
371 memcpy(pf_entry, theChart.GetNoCOVRTableHead(j),
372 theChart.GetNoCOVRTablePoints(j) * 2 * sizeof(float));
373 pft0nc[j] = pf_entry;
374 pipnc[j] = theChart.GetNoCOVRTablePoints(j);
375 }
376
377 pNoCovrPlyTable = pfpnc;
378 pNoCovrCntTable = pipnc;
379}
380
382
383ChartTableEntry::~ChartTableEntry() {
384 // free(pFullPath);
385 free(pPlyTable);
386
387 for (int i = 0; i < nAuxPlyEntries; i++) free(pAuxPlyTable[i]);
388 free(pAuxPlyTable);
389 free(pAuxCntTable);
390
391 if (nNoCovrPlyEntries) {
392 for (int i = 0; i < nNoCovrPlyEntries; i++) free(pNoCovrPlyTable[i]);
393 free(pNoCovrPlyTable);
394 free(pNoCovrCntTable);
395 }
396
397 delete m_pfilename;
398 delete m_psFullPath;
399}
400
402
404
405bool ChartTableEntry::IsEarlierThan(const ChartTableEntry &cte) const {
406 wxDateTime mine(edition_date);
407 wxDateTime theirs(cte.edition_date);
408
409 if (!mine.IsValid() || !theirs.IsValid())
410 return false; // will have the effect of keeping all questionable charts
411
412 return (mine.IsEarlierThan(theirs));
413}
414
415bool ChartTableEntry::IsEqualTo(const ChartTableEntry &cte) const {
416 wxDateTime mine(edition_date);
417 wxDateTime theirs(cte.edition_date);
418
419 if (!mine.IsValid() || !theirs.IsValid())
420 return true; // will have the effect of keeping all questionable charts
421
422 return (mine.IsEqualTo(theirs));
423}
424
426
427static int convertChartType(int charttype) {
428 // Hackeroo here....
429 // dB version 14 had different ChartType Enum, patch it here
430 if (s_dbVersion == 14) {
431 switch (charttype) {
432 case 0:
433 return CHART_TYPE_KAP;
434 case 1:
435 return CHART_TYPE_GEO;
436 case 2:
437 return CHART_TYPE_S57;
438 case 3:
439 return CHART_TYPE_CM93;
440 case 4:
441 return CHART_TYPE_CM93COMP;
442 case 5:
443 return CHART_TYPE_UNKNOWN;
444 case 6:
445 return CHART_TYPE_DONTCARE;
446 case 7:
447 return CHART_TYPE_DUMMY;
448 default:
449 return CHART_TYPE_UNKNOWN;
450 }
451 }
452 return charttype;
453}
454
455static int convertChartFamily(int charttype, int chartfamily) {
456 if (s_dbVersion < 18) {
457 switch (charttype) {
458 case CHART_TYPE_KAP:
459 case CHART_TYPE_GEO:
460 return CHART_FAMILY_RASTER;
461
462 case CHART_TYPE_S57:
463 case CHART_TYPE_CM93:
464 case CHART_TYPE_CM93COMP:
465 return CHART_FAMILY_VECTOR;
466
467 default:
468 return CHART_FAMILY_UNKNOWN;
469 }
470 }
471 return chartfamily;
472}
473
474bool ChartTableEntry::Read(const ChartDatabase *pDb, wxInputStream &is) {
475 char path[4096], *cp;
476
477 Clear();
478
479 // Allow reading of current db format, and maybe others
480 ChartDatabase *pD = (ChartDatabase *)pDb;
481 int db_version = pD->GetVersion();
482
483 if (db_version == 18) {
484 // Read the path first
485 for (cp = path; (*cp = (char)is.GetC()) != 0; cp++);
486 pFullPath = (char *)malloc(cp - path + 1);
487 strncpy(pFullPath, path, cp - path + 1);
488 wxLogVerbose(" Chart %s", pFullPath);
489
490 // Create and populate the helper members
491 m_pfilename = new wxString;
492 wxString fullfilename(pFullPath, wxConvUTF8);
493 wxFileName fn(fullfilename);
494 *m_pfilename = fn.GetFullName();
495 m_psFullPath = new wxString;
496 *m_psFullPath = fullfilename;
497 m_fullSystemPath = fullfilename;
498 m_FullPath = std::string(pFullPath);
499
500#ifdef __ANDROID__
501 m_fullSystemPath = wxString(fullfilename.mb_str(wxConvUTF8));
502#endif
503 // Read the table entry
505 is.Read(&cte, sizeof(ChartTableEntry_onDisk_18));
506
507 // Transcribe the elements....
508 EntryOffset = cte.EntryOffset;
509 ChartType = cte.ChartType;
510 ChartFamily = cte.ChartFamily;
511 LatMax = cte.LatMax;
512 LatMin = cte.LatMin;
513 LonMax = cte.LonMax;
514 LonMin = cte.LonMin;
515
516 m_bbox.Set(LatMin, LonMin, LatMax, LonMax);
517
518 Skew = cte.skew;
519 ProjectionType = cte.ProjectionType;
520
521 SetScale(cte.Scale);
522 edition_date = cte.edition_date;
523 file_date = cte.file_date;
524
525 nPlyEntries = cte.nPlyEntries;
526 nAuxPlyEntries = cte.nAuxPlyEntries;
527
528 nNoCovrPlyEntries = cte.nNoCovrPlyEntries;
529
530 bValid = cte.bValid;
531
532 if (nPlyEntries) {
533 int npeSize = nPlyEntries * 2 * sizeof(float);
534 pPlyTable = (float *)malloc(npeSize);
535 is.Read(pPlyTable, npeSize);
536 }
537
538 if (nAuxPlyEntries) {
539 int napeSize = nAuxPlyEntries * sizeof(int);
540 pAuxPlyTable = (float **)malloc(nAuxPlyEntries * sizeof(float *));
541 pAuxCntTable = (int *)malloc(napeSize);
542 is.Read(pAuxCntTable, napeSize);
543
544 for (int nAuxPlyEntry = 0; nAuxPlyEntry < nAuxPlyEntries;
545 nAuxPlyEntry++) {
546 int nfSize = pAuxCntTable[nAuxPlyEntry] * 2 * sizeof(float);
547 pAuxPlyTable[nAuxPlyEntry] = (float *)malloc(nfSize);
548 is.Read(pAuxPlyTable[nAuxPlyEntry], nfSize);
549 }
550 }
551
552 if (nNoCovrPlyEntries) {
553 int napeSize = nNoCovrPlyEntries * sizeof(int);
554 pNoCovrCntTable = (int *)malloc(napeSize);
555 is.Read(pNoCovrCntTable, napeSize);
556
557 pNoCovrPlyTable = (float **)malloc(nNoCovrPlyEntries * sizeof(float *));
558 for (int i = 0; i < nNoCovrPlyEntries; i++) {
559 int nfSize = pNoCovrCntTable[i] * 2 * sizeof(float);
560 pNoCovrPlyTable[i] = (float *)malloc(nfSize);
561 is.Read(pNoCovrPlyTable[i], nfSize);
562 }
563 }
564 }
565
566 else if (db_version == 17) {
567 // Read the path first
568 for (cp = path; (*cp = (char)is.GetC()) != 0; cp++);
569 pFullPath = (char *)malloc(cp - path + 1);
570 strncpy(pFullPath, path, cp - path + 1);
571 wxLogVerbose(" Chart %s", pFullPath);
572
573 // Create and populate the helper members
574 m_pfilename = new wxString;
575 wxString fullfilename(pFullPath, wxConvUTF8);
576 wxFileName fn(fullfilename);
577 *m_pfilename = fn.GetFullName();
578 m_psFullPath = new wxString;
579 *m_psFullPath = fullfilename;
580 m_FullPath = std::string(pFullPath);
581
582 // Read the table entry
584 is.Read(&cte, sizeof(ChartTableEntry_onDisk_17));
585
586 // Transcribe the elements....
587 EntryOffset = cte.EntryOffset;
588 ChartType = cte.ChartType;
589 LatMax = cte.LatMax;
590 LatMin = cte.LatMin;
591 LonMax = cte.LonMax;
592 LonMin = cte.LonMin;
593
594 m_bbox.Set(LatMin, LatMax, LonMin, LonMax);
595
596 Skew = cte.skew;
597 ProjectionType = cte.ProjectionType;
598
599 SetScale(cte.Scale);
600 edition_date = cte.edition_date;
601 file_date = cte.file_date;
602
603 nPlyEntries = cte.nPlyEntries;
604 nAuxPlyEntries = cte.nAuxPlyEntries;
605
606 nNoCovrPlyEntries = cte.nNoCovrPlyEntries;
607
608 bValid = cte.bValid;
609
610 if (nPlyEntries) {
611 int npeSize = nPlyEntries * 2 * sizeof(float);
612 pPlyTable = (float *)malloc(npeSize);
613 is.Read(pPlyTable, npeSize);
614 }
615
616 if (nAuxPlyEntries) {
617 int napeSize = nAuxPlyEntries * sizeof(int);
618 pAuxPlyTable = (float **)malloc(nAuxPlyEntries * sizeof(float *));
619 pAuxCntTable = (int *)malloc(napeSize);
620 is.Read(pAuxCntTable, napeSize);
621
622 for (int nAuxPlyEntry = 0; nAuxPlyEntry < nAuxPlyEntries;
623 nAuxPlyEntry++) {
624 int nfSize = pAuxCntTable[nAuxPlyEntry] * 2 * sizeof(float);
625 pAuxPlyTable[nAuxPlyEntry] = (float *)malloc(nfSize);
626 is.Read(pAuxPlyTable[nAuxPlyEntry], nfSize);
627 }
628 }
629
630 if (nNoCovrPlyEntries) {
631 int napeSize = nNoCovrPlyEntries * sizeof(int);
632 pNoCovrCntTable = (int *)malloc(napeSize);
633 is.Read(pNoCovrCntTable, napeSize);
634
635 pNoCovrPlyTable = (float **)malloc(nNoCovrPlyEntries * sizeof(float *));
636 for (int i = 0; i < nNoCovrPlyEntries; i++) {
637 int nfSize = pNoCovrCntTable[i] * 2 * sizeof(float);
638 pNoCovrPlyTable[i] = (float *)malloc(nfSize);
639 is.Read(pNoCovrPlyTable[i], nfSize);
640 }
641 }
642 }
643
644 else if (db_version == 16) {
645 // Read the path first
646 for (cp = path; (*cp = (char)is.GetC()) != 0; cp++);
647 // TODO: optimize prepended dir
648 pFullPath = (char *)malloc(cp - path + 1);
649 strncpy(pFullPath, path, cp - path + 1);
650 wxLogVerbose(" Chart %s", pFullPath);
651
652 // Create and populate the helper members
653 m_pfilename = new wxString;
654 wxString fullfilename(pFullPath, wxConvUTF8);
655 wxFileName fn(fullfilename);
656 *m_pfilename = fn.GetFullName();
657 m_psFullPath = new wxString;
658 *m_psFullPath = fullfilename;
659 m_FullPath = std::string(pFullPath);
660
661 // Read the table entry
663 is.Read(&cte, sizeof(ChartTableEntry_onDisk_16));
664
665 // Transcribe the elements....
666 EntryOffset = cte.EntryOffset;
667 ChartType = cte.ChartType;
668 LatMax = cte.LatMax;
669 LatMin = cte.LatMin;
670 LonMax = cte.LonMax;
671 LonMin = cte.LonMin;
672
673 m_bbox.Set(LatMin, LatMax, LonMin, LonMax);
674
675 Skew = cte.skew;
676 ProjectionType = cte.ProjectionType;
677
678 SetScale(cte.Scale);
679 edition_date = cte.edition_date;
680 file_date = cte.file_date;
681
682 nPlyEntries = cte.nPlyEntries;
683 nAuxPlyEntries = cte.nAuxPlyEntries;
684
685 bValid = cte.bValid;
686
687 if (nPlyEntries) {
688 int npeSize = nPlyEntries * 2 * sizeof(float);
689 pPlyTable = (float *)malloc(npeSize);
690 is.Read(pPlyTable, npeSize);
691 }
692
693 if (nAuxPlyEntries) {
694 int napeSize = nAuxPlyEntries * sizeof(int);
695 pAuxPlyTable = (float **)malloc(nAuxPlyEntries * sizeof(float *));
696 pAuxCntTable = (int *)malloc(napeSize);
697 is.Read(pAuxCntTable, napeSize);
698
699 for (int nAuxPlyEntry = 0; nAuxPlyEntry < nAuxPlyEntries;
700 nAuxPlyEntry++) {
701 int nfSize = pAuxCntTable[nAuxPlyEntry] * 2 * sizeof(float);
702 pAuxPlyTable[nAuxPlyEntry] = (float *)malloc(nfSize);
703 is.Read(pAuxPlyTable[nAuxPlyEntry], nfSize);
704 }
705 }
706 }
707
708 else if (db_version == 15) {
709 // Read the path first
710 for (cp = path; (*cp = (char)is.GetC()) != 0; cp++);
711 // TODO: optimize prepended dir
712 pFullPath = (char *)malloc(cp - path + 1);
713 strncpy(pFullPath, path, cp - path + 1);
714 wxLogVerbose(" Chart %s", pFullPath);
715
716 // Read the table entry
718 is.Read(&cte, sizeof(ChartTableEntry_onDisk_15));
719
720 // Transcribe the elements....
721 EntryOffset = cte.EntryOffset;
722 ChartType = cte.ChartType;
723 LatMax = cte.LatMax;
724 LatMin = cte.LatMin;
725 LonMax = cte.LonMax;
726 LonMin = cte.LonMin;
727
728 m_bbox.Set(LatMin, LatMax, LonMin, LonMax);
729
730 SetScale(cte.Scale);
731 edition_date = cte.edition_date;
732 file_date = cte.file_date;
733
734 nPlyEntries = cte.nPlyEntries;
735 nAuxPlyEntries = cte.nAuxPlyEntries;
736
737 bValid = cte.bValid;
738
739 if (nPlyEntries) {
740 int npeSize = nPlyEntries * 2 * sizeof(float);
741 pPlyTable = (float *)malloc(npeSize);
742 is.Read(pPlyTable, npeSize);
743 }
744
745 if (nAuxPlyEntries) {
746 int napeSize = nAuxPlyEntries * sizeof(int);
747 pAuxPlyTable = (float **)malloc(nAuxPlyEntries * sizeof(float *));
748 pAuxCntTable = (int *)malloc(napeSize);
749 is.Read(pAuxCntTable, napeSize);
750
751 for (int nAuxPlyEntry = 0; nAuxPlyEntry < nAuxPlyEntries;
752 nAuxPlyEntry++) {
753 int nfSize = pAuxCntTable[nAuxPlyEntry] * 2 * sizeof(float);
754 pAuxPlyTable[nAuxPlyEntry] = (float *)malloc(nfSize);
755 is.Read(pAuxPlyTable[nAuxPlyEntry], nfSize);
756 }
757 }
758 } else if (db_version == 14) {
759 // Read the path first
760 for (cp = path; (*cp = (char)is.GetC()) != 0; cp++);
761 pFullPath = (char *)malloc(cp - path + 1);
762 strncpy(pFullPath, path, cp - path + 1);
763 wxLogVerbose(" Chart %s", pFullPath);
764
765 // Read the table entry
767 is.Read(&cte, sizeof(ChartTableEntry_onDisk_14));
768
769 // Transcribe the elements....
770 EntryOffset = cte.EntryOffset;
771 ChartType = cte.ChartType;
772 LatMax = cte.LatMax;
773 LatMin = cte.LatMin;
774 LonMax = cte.LonMax;
775 LonMin = cte.LonMin;
776
777 m_bbox.Set(LatMin, LatMax, LonMin, LonMax);
778
779 SetScale(cte.Scale);
780 edition_date = cte.edition_date;
781 file_date = 0; // file_date does not exist in V14;
782 nPlyEntries = cte.nPlyEntries;
783 nAuxPlyEntries = cte.nAuxPlyEntries;
784 bValid = cte.bValid;
785
786 if (nPlyEntries) {
787 int npeSize = nPlyEntries * 2 * sizeof(float);
788 pPlyTable = (float *)malloc(npeSize);
789 is.Read(pPlyTable, npeSize);
790 }
791
792 if (nAuxPlyEntries) {
793 int napeSize = nAuxPlyEntries * sizeof(int);
794 pAuxPlyTable = (float **)malloc(nAuxPlyEntries * sizeof(float *));
795 pAuxCntTable = (int *)malloc(napeSize);
796 is.Read(pAuxCntTable, napeSize);
797
798 for (int nAuxPlyEntry = 0; nAuxPlyEntry < nAuxPlyEntries;
799 nAuxPlyEntry++) {
800 int nfSize = pAuxCntTable[nAuxPlyEntry] * 2 * sizeof(float);
801 pAuxPlyTable[nAuxPlyEntry] = (float *)malloc(nfSize);
802 is.Read(pAuxPlyTable[nAuxPlyEntry], nfSize);
803 }
804 }
805 }
806 ChartFamily = convertChartFamily(ChartType, ChartFamily);
807 ChartType = convertChartType(ChartType);
808
809 return true;
810}
811
813
814bool ChartTableEntry::Write(const ChartDatabase *pDb, wxOutputStream &os) {
815 os.Write(pFullPath, strlen(pFullPath) + 1);
816
817 // Write the current version type only
818 // Create an on_disk table entry
820
821 // Transcribe the elements....
822 cte.EntryOffset = EntryOffset;
823 cte.ChartType = ChartType;
824 cte.ChartFamily = ChartFamily;
825 cte.LatMax = LatMax;
826 cte.LatMin = LatMin;
827 cte.LonMax = LonMax;
828 cte.LonMin = LonMin;
829
830 cte.Scale = Scale;
831 cte.edition_date = edition_date;
832 cte.file_date = file_date;
833
834 cte.nPlyEntries = nPlyEntries;
835 cte.nAuxPlyEntries = nAuxPlyEntries;
836
837 cte.skew = Skew;
838 cte.ProjectionType = ProjectionType;
839
840 cte.bValid = bValid;
841
842 cte.nNoCovrPlyEntries = nNoCovrPlyEntries;
843
844 os.Write(&cte, sizeof(ChartTableEntry_onDisk_18));
845 wxLogVerbose(" Wrote Chart %s", pFullPath);
846
847 // Write out the tables
848 if (nPlyEntries) {
849 int npeSize = nPlyEntries * 2 * sizeof(float);
850 os.Write(pPlyTable, npeSize);
851 }
852
853 if (nAuxPlyEntries) {
854 int napeSize = nAuxPlyEntries * sizeof(int);
855 os.Write(pAuxCntTable, napeSize);
856
857 for (int nAuxPlyEntry = 0; nAuxPlyEntry < nAuxPlyEntries; nAuxPlyEntry++) {
858 int nfSize = pAuxCntTable[nAuxPlyEntry] * 2 * sizeof(float);
859 os.Write(pAuxPlyTable[nAuxPlyEntry], nfSize);
860 }
861 }
862
863 if (nNoCovrPlyEntries) {
864 int ncSize = nNoCovrPlyEntries * sizeof(int);
865 os.Write(pNoCovrCntTable, ncSize);
866
867 for (int i = 0; i < nNoCovrPlyEntries; i++) {
868 int nctSize = pNoCovrCntTable[i] * 2 * sizeof(float);
869 os.Write(pNoCovrPlyTable[i], nctSize);
870 }
871 }
872
873 return true;
874}
875
877
878void ChartTableEntry::Clear() {
879 pFullPath = NULL;
880 pPlyTable = NULL;
881 pAuxPlyTable = NULL;
882 pAuxCntTable = NULL;
883 bValid = false;
884 ;
885 pNoCovrCntTable = NULL;
886 pNoCovrPlyTable = NULL;
887
888 nNoCovrPlyEntries = 0;
889 nAuxPlyEntries = 0;
890
891 m_pfilename = NULL; // a helper member, not on disk
892 m_psFullPath = NULL;
893 Scale = 1e8; // Very small scale
894}
895
897
898void ChartTableEntry::Disable() {
899 // Mark this chart in the database, so that it will not be seen during this
900 // run How? By setting the chart bounding box to an absurd value
901 // TODO... Fix this heinous hack
902 LatMax += (float)1000.;
903 LatMin += (float)1000.;
904}
905
906void ChartTableEntry::ReEnable() {
907 if (LatMax > 90.) {
908 LatMax -= (float)1000.;
909 LatMin -= (float)1000.;
910 }
911}
912bool ChartTableEntry::IsBasemap() const {
913 wxFileName fn(GetFullPath());
914 return (fn.GetPath().Lower().Contains("basemap"));
915}
916
917std::vector<float> ChartTableEntry::GetReducedPlyPoints() {
918 if (m_reducedPlyPoints.size()) return m_reducedPlyPoints;
919
920 // Reduce the LOD of the chart outline PlyPoints
921 float LOD_meters = 1;
922
923 float plylat, plylon;
924 const int nPoints = GetnPlyEntries();
925
926 float *fpo = GetpPlyTable();
927
928 double *ppd = new double[nPoints * 2];
929 double *ppsm = new double[nPoints * 2];
930 double *npr = ppd;
931 double *npsm = ppsm;
932 for (int i = 0; i < nPoints; i++) {
933 plylat = fpo[i * 2];
934 plylon = fpo[i * 2 + 1];
935
936 double x, y;
937 toSM(plylat, plylon, fpo[0], fpo[1], &x, &y);
938
939 *npr++ = plylon;
940 *npr++ = plylat;
941 *npsm++ = x;
942 *npsm++ = y;
943 }
944
945 std::vector<int> index_keep;
946 if (nPoints > 10) {
947 index_keep.push_back(0);
948 index_keep.push_back(nPoints - 1);
949 index_keep.push_back(1);
950 index_keep.push_back(nPoints - 2);
951
952 DouglasPeuckerM(ppsm, 1, nPoints - 2, LOD_meters, &index_keep);
953
954 } else {
955 index_keep.resize(nPoints);
956 for (int i = 0; i < nPoints; i++) index_keep[i] = i;
957 }
958
959 double *ppr = ppd;
960 for (int ip = 0; ip < nPoints; ip++) {
961 double x = *ppr++;
962 double y = *ppr++;
963
964 for (unsigned int j = 0; j < index_keep.size(); j++) {
965 if (index_keep[j] == ip) {
966 m_reducedPlyPoints.push_back(x);
967 m_reducedPlyPoints.push_back(y);
968 break;
969 }
970 }
971 }
972
973 delete[] ppd;
974 delete[] ppsm;
975
976 int nprr = m_reducedPlyPoints.size() / 2;
977
978 return m_reducedPlyPoints;
979}
980
981std::vector<float> ChartTableEntry::GetReducedAuxPlyPoints(int iTable) {
982 // Maybe need to initialize the vector
983 if (!m_reducedAuxPlyPointsVector.size()) {
984 std::vector<float> vec;
985 for (int i = 0; i < GetnAuxPlyEntries(); i++) {
986 m_reducedAuxPlyPointsVector.push_back(vec);
987 }
988 }
989
990 std::vector<float> vec;
991
992 // Invalid parameter
993 if ((unsigned int)iTable >= m_reducedAuxPlyPointsVector.size()) return vec;
994
995 if (m_reducedAuxPlyPointsVector.at(iTable).size())
996 return m_reducedAuxPlyPointsVector.at(iTable);
997
998 // Reduce the LOD of the chart outline PlyPoints
999 float LOD_meters = 1.0;
1000
1001 const int nPoints = GetAuxCntTableEntry(iTable);
1002 float *fpo = GetpAuxPlyTableEntry(iTable);
1003
1004 double *ppd = new double[nPoints * 2];
1005 double *ppsm = new double[nPoints * 2];
1006 double *npr = ppd;
1007 double *npsm = ppsm;
1008 float plylat, plylon;
1009
1010 for (int i = 0; i < nPoints; i++) {
1011 plylat = fpo[i * 2];
1012 plylon = fpo[i * 2 + 1];
1013
1014 double x, y;
1015 toSM(plylat, plylon, fpo[0], fpo[1], &x, &y);
1016
1017 *npr++ = plylon;
1018 *npr++ = plylat;
1019 *npsm++ = x;
1020 *npsm++ = y;
1021 }
1022
1023 std::vector<int> index_keep;
1024 if (nPoints > 10) {
1025 index_keep.push_back(0);
1026 index_keep.push_back(nPoints - 1);
1027 index_keep.push_back(1);
1028 index_keep.push_back(nPoints - 2);
1029
1030 DouglasPeuckerM(ppsm, 1, nPoints - 2, LOD_meters, &index_keep);
1031
1032 } else {
1033 index_keep.resize(nPoints);
1034 for (int i = 0; i < nPoints; i++) index_keep[i] = i;
1035 }
1036
1037 int nnn = index_keep.size();
1038
1039 double *ppr = ppd;
1040 for (int ip = 0; ip < nPoints; ip++) {
1041 double x = *ppr++;
1042 double y = *ppr++;
1043
1044 for (unsigned int j = 0; j < index_keep.size(); j++) {
1045 if (index_keep[j] == ip) {
1046 vec.push_back(x);
1047 vec.push_back(y);
1048 break;
1049 }
1050 }
1051 }
1052
1053 delete[] ppd;
1054 delete[] ppsm;
1055
1056 m_reducedAuxPlyPointsVector[iTable] = vec;
1057
1058 int nprr = vec.size() / 2;
1059
1060 return vec;
1061}
1062
1064// ChartDatabase
1066const int ID_DBS_PROGRESS_UPDATE = wxNewId();
1067
1068WX_DEFINE_OBJARRAY(ChartTable);
1069
1070ChartDatabase::ChartDatabase() {
1071 bValid = false;
1072 SetBusy(false);
1073
1074 m_ChartTableEntryDummy.Clear();
1075
1076 Bind(wxEVT_OCPN_CHARTTABLEENTRYTHREAD, &ChartDatabase::OnEvtThread, this);
1077 Bind(wxEVT_COMMAND_MENU_SELECTED, &ChartDatabase::OnDBSProgressUpdate, this,
1078 ID_DBS_PROGRESS_UPDATE);
1079
1080 m_progress_timer.SetOwner(this, ID_TIMER_UPDATE_PROGRESS);
1081 Bind(wxEVT_TIMER, &ChartDatabase::OnProgessTimer, this,
1082 ID_TIMER_UPDATE_PROGRESS);
1083
1084 m_update_competion_timer.SetOwner(this, ID_TIMER_UPDATE_COMPLETE);
1085 Bind(wxEVT_TIMER, &ChartDatabase::OnUpdateComplete, this,
1086 ID_TIMER_UPDATE_COMPLETE);
1087
1088 UpdateChartClassDescriptorArray();
1089}
1090
1091void ChartDatabase::OnDBSProgressUpdate(wxCommandEvent &evt) {}
1092
1093void ChartDatabase::OnUpdateComplete(wxTimerEvent &event) {
1094 ProcessThreadQueueEmpty();
1095}
1096
1097void ChartDatabase::OnProgessTimer(wxTimerEvent &event) {
1098 if (m_pprog && m_progress_timer.IsRunning() && (m_jobsRemaining > 1)) {
1099 if (m_progress_dirty.exchange(false)) {
1100#ifdef __ANDROID__
1101 qDebug() << " ***Update()" << m_jobsRemaining;
1102#endif
1103 m_pprog->Update(m_progress_value, m_progress_message);
1104#ifdef __ANDROID__
1105 qDebug() << " ---Update() out" << m_jobsRemaining;
1106#endif
1107 }
1108 }
1109}
1110
1111void ChartDatabase::ProcessThreadQueueEmpty() {
1112#ifdef __ANDROID__
1113 qDebug() << "ProcessThreadQueueEmpty";
1114#endif
1115 if (m_deferred_ticket_vector.size()) {
1116 // Process the deferred charts in a single thread pool
1117 // load the thread pool from the prepared array
1118 // Enqueue jobs
1119 for (auto &ticket_d : m_deferred_ticket_vector) {
1120 m_pool_deferred.Push(ticket_d);
1121 m_jobsRemaining++;
1122 }
1123 m_deferred_ticket_vector.clear();
1124
1125 // Initialize progress dialog
1126 m_progcount = 0;
1127 m_progint = 0;
1128 m_ticketcount = m_jobsRemaining;
1129 m_nFileProgressQuantum = 1; // wxMax(m_ticketcount / 10, 2);
1130 m_progress_message = _("Processing charts");
1131 m_progress_timer.Start(50, wxTIMER_CONTINUOUS);
1132
1133 // Start up the queued thread, if necessary
1134 if (m_jobsRemaining) {
1135 const int workerCount = 1;
1136 if (m_pool_deferred.GetWorkerCount() < workerCount) {
1137 int threads_needed = workerCount - m_pool_deferred.GetWorkerCount();
1138 for (int i = 0; i < threads_needed; ++i) {
1139 (new PoolWorkerThread(m_pool_deferred, this))->Run();
1140 m_pool_deferred.AddWorker();
1141 }
1142 }
1143 }
1144 return; // Let the thread run
1145 }
1146
1147 m_progress_timer.Stop();
1148 if (m_pprog) m_pprog->Hide();
1149
1150 // Now m_ticket_vector is populated with verified tickets
1151 // for all specified directories.
1152
1153 // Add the CTEs from the tickets to the active table
1154 // NB: The active_chartTable was cleared by the Update() method
1155 // before this point
1156
1157 for (auto &ticket_valid : m_ticket_vector) {
1158 if (ticket_valid->m_chart_table_entry)
1159 active_chartTable.push_back(ticket_valid->m_chart_table_entry);
1160 }
1161
1162 // Release references to tickets
1163 m_ticket_vector.clear();
1164
1165#ifdef __ANDROID__
1166 qDebug() << "FinalizeChartUpdate";
1167#endif
1168
1169 FinalizeChartUpdate();
1170}
1171
1172void ChartDatabase::OnEvtThread(OCPN_ChartTableEntryThreadEvent &event) {
1173#ifdef __ANDROID__
1174 qDebug() << "Remaining: " << m_jobsRemaining;
1175#endif
1176 // Capture the completed job tickets
1177 auto ticket = event.GetTicket();
1178 if (!ticket) {
1179 return;
1180 }
1181
1182 // Update progress dialog, if present
1183 if (m_pprog && (m_jobsRemaining > 1)) {
1184 m_progcount++;
1185 double ratio = 100. * (double)m_progcount / m_ticketcount;
1186 int val = ratio;
1187 if (((m_progcount % m_nFileProgressQuantum) == 0)) {
1188 if (val != m_progint) {
1189 m_progint = val;
1190 m_progress_value = val;
1191 m_progress_dirty = true;
1192 }
1193 }
1194 }
1195
1196 if (!ticket->m_ticket_type) { // TICKET_TYPE_NORMAL
1197 bool collision_found = false;
1198 if (ticket->b_thread_safe) {
1199 wxFileName fn(ticket->m_ChartPath);
1200 ChartCollisionsHashMap::iterator it;
1201 for (it = m_full_collision_map.begin(); it != m_full_collision_map.end();
1202 ++it) {
1203 if (it->first.IsSameAs(fn.GetFullName())) {
1204 // Two files found with identical file name
1205 // For now, just drop this ticket
1206 // TODO Make an (expensive) test on file modification times
1207 collision_found = true;
1208 break;
1209 }
1210 }
1211 if (!collision_found) {
1212 m_full_collision_map[fn.GetFullName()] = 1;
1213 }
1214 // Consider TODO #1 here: Looking for more duolicates acress directories
1215 }
1216
1217 m_ticket_vector.push_back(ticket);
1218 }
1219
1220 int remaining = --m_jobsRemaining;
1221
1222 // Update throttle.
1223 m_pool.pending_events--;
1224 m_pool_deferred.pending_events--;
1225
1226 if (remaining == 0) {
1227 m_pool.Shutdown();
1228 m_pool_deferred.Shutdown();
1229 m_progress_timer.Stop();
1230
1231#ifdef __ANDROID__
1232 qDebug() << "Fire completion Oneshot";
1233#endif
1234 m_update_competion_timer.Start(100, wxTIMER_ONE_SHOT);
1235 }
1236}
1237
1238void ChartDatabase::FinalizeChartUpdate() {
1239 // Scrub CTE list, remove any invalid entries,
1240 // as tagged by directory removal
1241 active_chartTable.erase(
1242 std::remove_if(active_chartTable.begin(), active_chartTable.end(),
1243 [](const auto &cte) { return !cte->GetbValid(); }),
1244 active_chartTable.end());
1245
1246 size_t d = active_chartTable.size();
1247
1248 // And once more, setting the Entry index field
1249 active_chartTable_pathindex.clear();
1250 int i = 0;
1251 for (auto cte : active_chartTable) {
1252 active_chartTable_pathindex[cte->GetFullSystemPath()] = i;
1253 cte->SetEntryOffset(i);
1254 i++;
1255 }
1256
1257 m_nentries = active_chartTable.size();
1258 bValid = true;
1259 SetBusy(false);
1260 ChartData->SetBusy(false);
1261
1262 // Finalize the dB on disk
1263 ChartData->SaveBinary(ChartListFileName);
1264 wxLogMessage("Finished chart database Update");
1265 wxLogMessage(" ");
1266
1267 if (m_pprog) m_pprog->Destroy();
1268 m_pprog = nullptr;
1269
1270 // The Update() function may set gWorldMapLocation if at least one of the
1271 // directories contains GSHHS files. Make sure GSHHS is still accessible
1272 if (gWorldMapLocation.empty()) { // Last resort. User might have deleted all
1273 // GSHHG data, but we still might have the
1274 // default dataset distributed with OpenCPN
1275 // or from the package repository...
1276 gWorldMapLocation = gDefaultWorldMapLocation;
1277 m_gshhg_chart_loc = wxEmptyString;
1278 }
1279
1280 // Update canvas and "Crossesland" machinery
1281 if (gWorldMapLocation != m_gshhg_chart_loc) {
1282 // ..For each canvas...
1283 // TODO Move this where?
1284 // for (unsigned int i = 0; i < g_canvasArray.GetCount(); i++) {
1285 // ChartCanvas *cc = g_canvasArray.Item(i);
1286 // if (cc) cc->ResetWorldBackgroundChart();
1287 // }
1288
1289 // Reset the GSHHS singleton which is used to detect land crossing.
1290 gshhsCrossesLandReset();
1291 }
1292
1293 // Purge all charts from cache, and delete.
1294 ChartData->PurgeCache();
1295
1296 // Signal Options dialog that update is finished
1297 GuiEvents::GetInstance().options_on_finalize_chartdbs.Notify();
1298
1299 // Signal a full chart reload
1300 GuiEvents::GetInstance().on_finalize_chartdbs.Notify();
1301}
1302
1303bool ChartDatabase::ScrubGroupArray() {
1304 // For each group,
1305 // make sure that each group element (dir or chart) references at least
1306 // oneitem in the database. If not, remove the element.
1307
1308 bool b_change = false;
1309 unsigned int igroup = 0;
1310 while (igroup < g_pGroupArray->GetCount()) {
1311 bool b_chart_in_element = false;
1312 ChartGroup *pGroup = g_pGroupArray->Item(igroup);
1313
1314 for (unsigned int j = 0; j < pGroup->m_element_array.size(); j++) {
1315 const wxString &element_root = pGroup->m_element_array[j].m_element_name;
1316
1317 for (unsigned int ic = 0;
1318 ic < (unsigned int)ChartData->GetChartTableEntries(); ic++) {
1319 auto &cte = ChartData->GetChartTableEntry(ic);
1320 wxString chart_full_path = cte.GetFullSystemPath();
1321
1322 if (chart_full_path.StartsWith(element_root)) {
1323 b_chart_in_element = true;
1324 break;
1325 }
1326 }
1327
1328 // Explicit check to avoid removing a group containing only GSHHS
1329 if (!b_chart_in_element) {
1330 wxString test_string = "GSHH";
1331 if (element_root.Upper().Contains(test_string))
1332 b_chart_in_element = true;
1333 }
1334
1335 if (!b_chart_in_element) // delete the element
1336 {
1337 pGroup->m_element_array.erase(pGroup->m_element_array.begin() + j);
1338 j--;
1339 b_change = true;
1340 }
1341 }
1342
1343 igroup++; // next group
1344 }
1345
1346 return b_change;
1347}
1348
1349void ChartDatabase::UpdateChartClassDescriptorArray() {
1350 if (m_ChartClassDescriptorArray.empty()) {
1351 m_ChartClassDescriptorArray.push_back(
1352 ChartClassDescriptor("ChartKAP", "*.kap", nullptr, BUILTIN_DESCRIPTOR));
1353 m_ChartClassDescriptorArray.push_back(
1354 ChartClassDescriptor("ChartGEO", "*.geo", nullptr, BUILTIN_DESCRIPTOR));
1355 m_ChartClassDescriptorArray.push_back(
1356 ChartClassDescriptor("s57chart", "*.000", nullptr, BUILTIN_DESCRIPTOR));
1357 m_ChartClassDescriptorArray.push_back(
1358 ChartClassDescriptor("s57chart", "*.s57", nullptr, BUILTIN_DESCRIPTOR));
1359 m_ChartClassDescriptorArray.push_back(ChartClassDescriptor(
1360 "cm93compchart", "00300000.a", nullptr, BUILTIN_DESCRIPTOR));
1361 m_ChartClassDescriptorArray.push_back(ChartClassDescriptor(
1362 "ChartMbTiles", "*.mbtiles", nullptr, BUILTIN_DESCRIPTOR));
1363 }
1364 // If the PlugIn Manager exists, get the array of dynamically loadable
1365 // chart class names
1366 if (g_pi_manager) {
1367 m_ChartClassDescriptorArray.erase(
1368 std::remove_if(m_ChartClassDescriptorArray.begin(),
1369 m_ChartClassDescriptorArray.end(),
1370 [](const ChartClassDescriptor &cd) {
1371 return cd.m_descriptor_type == PLUGIN_DESCRIPTOR;
1372 }),
1373 m_ChartClassDescriptorArray.end());
1374
1375 wxArrayString array = g_pi_manager->GetPlugInChartClassNameArray();
1376 for (unsigned int j = 0; j < array.GetCount(); j++) {
1377 // Instantiate a blank chart to retrieve the directory search mask for
1378 // this chart type
1379 wxString class_name = array[j];
1380 ChartPlugInWrapper *cpiw = new ChartPlugInWrapper(class_name);
1381 if (cpiw) {
1382 wxString mask = cpiw->GetFileSearchMask();
1383
1384 // Get the plugin (ptr) that provides this chart class
1385 auto plugin_t = g_pi_manager->GetProvidingPlugin(class_name);
1386 opencpn_plugin *plugin = dynamic_cast<opencpn_plugin *>(plugin_t);
1387 // Create a new descriptor and add it to the database
1388 m_ChartClassDescriptorArray.push_back(
1389 ChartClassDescriptor(class_name, mask, plugin, PLUGIN_DESCRIPTOR));
1390 delete cpiw;
1391 }
1392 }
1393 }
1394}
1395
1396ChartTableEntry &ChartDatabase::GetChartTableEntry(int index) {
1397 if (index < GetChartTableEntries())
1398 return *active_chartTable[index];
1399 else
1400 return m_ChartTableEntryDummy;
1401}
1402
1403bool ChartDatabase::CompareChartDirArray(ArrayOfCDI &test_array) {
1404 // Compare the parameter "test_array" with this.m_dir_array
1405 // Return true if functionally identical (order does not signify).
1406
1407 if (test_array.GetCount() != m_dir_array.GetCount()) return false;
1408
1409 bool bfound_inner;
1410 unsigned int nfound_outer = 0;
1411
1412 for (unsigned int i = 0; i < test_array.GetCount(); i++) {
1413 ChartDirInfo p = test_array[i];
1414 bfound_inner = false;
1415 for (unsigned int j = 0; j < m_dir_array.GetCount(); j++) {
1416 ChartDirInfo q = m_dir_array[j];
1417
1418 if (p.fullpath.IsSameAs(q.fullpath)) {
1419 bfound_inner = true;
1420 break;
1421 }
1422 }
1423 if (bfound_inner) nfound_outer++;
1424 }
1425
1426 return (nfound_outer == test_array.GetCount());
1427}
1428
1429wxString ChartDatabase::GetMagicNumberCached(wxString dir) {
1430 for (unsigned int j = 0; j < m_dir_array.GetCount(); j++) {
1431 ChartDirInfo q = m_dir_array[j];
1432 if (dir.IsSameAs(q.fullpath)) return q.magic_number;
1433 }
1434
1435 return "";
1436}
1437
1438bool ChartDatabase::Read(const wxString &filePath) {
1439 ChartTableEntry entry;
1440 int entries;
1441
1442 bValid = false;
1443
1444 wxFileName file(filePath);
1445 if (!file.FileExists()) return false;
1446
1447 m_DBFileName = filePath;
1448
1449 wxFFileInputStream ifs(filePath);
1450 if (!ifs.Ok()) return false;
1451
1452 ChartTableHeader cth;
1453 cth.Read(ifs);
1454 if (!cth.CheckValid()) return false;
1455
1456 // Capture the version number
1457 char vbo[5];
1458 memcpy(vbo, cth.GetDBVersionString(), 4);
1459 vbo[4] = 0;
1460 m_dbversion = atoi(&vbo[1]);
1461 s_dbVersion = m_dbversion; // save the static copy
1462
1463 wxLogVerbose("Chartdb:Reading %d directory entries, %d table entries",
1464 cth.GetDirEntries(), cth.GetTableEntries());
1465 wxLogMessage("Chartdb: Chart directory list follows");
1466 if (0 == cth.GetDirEntries()) wxLogMessage(" Nil");
1467
1468 int ind = 0;
1469 for (int iDir = 0; iDir < cth.GetDirEntries(); iDir++) {
1470 wxString dir;
1471 int dirlen;
1472 ifs.Read(&dirlen, sizeof(int));
1473 while (dirlen > 0) {
1474 char dirbuf[1024];
1475 int alen = dirlen > 1023 ? 1023 : dirlen;
1476 if (ifs.Read(&dirbuf, alen).Eof()) goto read_error;
1477 dirbuf[alen] = 0;
1478 dirlen -= alen;
1479 dir.Append(wxString(dirbuf, wxConvUTF8));
1480 }
1481 wxString msg;
1482 msg.Printf(" Chart directory #%d: ", iDir);
1483 msg.Append(dir);
1484 wxLogMessage(msg);
1485 m_chartDirs.Add(dir);
1486 }
1487
1488 entries = cth.GetTableEntries();
1489 // active_chartTable.Alloc(entries);
1490 active_chartTable_pathindex.clear();
1491 while (entries-- && entry.Read(this, ifs)) {
1492 active_chartTable_pathindex[entry.GetFullSystemPath()] = ind++;
1493 auto sharedPtr = std::make_shared<ChartTableEntry>(entry);
1494 active_chartTable.push_back(sharedPtr);
1495 }
1496
1497 entry.Clear();
1498 bValid = true;
1499 entry.SetAvailable(true);
1500
1501 m_nentries = active_chartTable.size();
1502 return true;
1503
1504read_error:
1505 bValid = false;
1506 m_nentries = active_chartTable.size();
1507 return false;
1508}
1509
1511
1512bool ChartDatabase::Write(const wxString &filePath) {
1513 wxFileName file(filePath);
1514 wxFileName dir(
1515 file.GetPath(wxPATH_GET_SEPARATOR | wxPATH_GET_VOLUME, wxPATH_NATIVE));
1516
1517 if (!dir.DirExists() && !dir.Mkdir()) return false;
1518
1519 wxFFileOutputStream ofs(filePath);
1520 if (!ofs.Ok()) return false;
1521
1522 ChartTableHeader cth(m_chartDirs.GetCount(), active_chartTable.size());
1523 cth.Write(ofs);
1524
1525 for (int iDir = 0; iDir < cth.GetDirEntries(); iDir++) {
1526 wxString dir1 = m_chartDirs[iDir];
1527 int dirlen = dir1.length();
1528 char s[200];
1529 strncpy(s, dir1.mb_str(wxConvUTF8), 199);
1530 s[199] = 0;
1531 dirlen = strlen(s);
1532 ofs.Write(&dirlen, sizeof(int));
1533 // ofs.Write(dir.fn_str(), dirlen);
1534 ofs.Write(s, dirlen);
1535 }
1536
1537 for (UINT32 iTable = 0; iTable < active_chartTable.size(); iTable++) {
1538 auto &cte = GetChartTableEntry(iTable);
1539 cte.Write(this, ofs);
1540 }
1541
1542 // Explicitly set the version
1543 m_dbversion = DB_VERSION_CURRENT;
1544
1545 return true;
1546}
1547
1549wxString SplitPath(wxString s, wxString tkd, int nchar, int offset,
1550 int *pn_split) {
1551 wxString r;
1552 int ncr = 0;
1553
1554 int rlen = offset;
1555 wxStringTokenizer tkz(s, tkd);
1556 while (tkz.HasMoreTokens()) {
1557 wxString token = tkz.GetNextToken();
1558 if ((rlen + (int)token.Len() + 1) < nchar) {
1559 r += token;
1560 r += tkd[0];
1561 rlen += token.Len() + 1;
1562 } else {
1563 r += "\n";
1564 ncr++;
1565 for (int i = 0; i < offset; i++) {
1566 r += " ";
1567 }
1568 r += token;
1569 r += tkd[0];
1570 rlen = offset + token.Len() + 1;
1571 }
1572 }
1573
1574 if (pn_split) *pn_split = ncr;
1575
1576 return r.Mid(0, r.Len() - 1); // strip the last separator char
1577}
1578
1579wxString ChartDatabase::GetFullChartInfo(ChartBase *pc, int dbIndex,
1580 int *char_width, int *line_count) {
1581 wxString r;
1582 int lc = 0;
1583 unsigned int max_width = 0;
1584 int ncr;
1585 unsigned int target_width = 60;
1586
1587 const ChartTableEntry &cte = GetChartTableEntry(dbIndex);
1588 wxString line;
1589 line.Empty();
1590 if (pc) {
1591 line = _(" Name: ");
1592 wxString longline = pc->GetName();
1593
1594 wxString tkz;
1595 if (longline.Find(' ') != wxNOT_FOUND) // assume a proper name
1596 tkz = " ";
1597 else
1598 tkz = "/,\\"; // else a file name
1599
1600 if (longline.Len() > target_width) {
1601 line += SplitPath(pc->GetName(), tkz, target_width, 12, &ncr);
1602 max_width = wxMax(max_width, target_width + 4);
1603 lc += ncr;
1604 } else {
1605 line += longline;
1606 max_width = wxMax(max_width, line.Len() + 4);
1607 }
1608 }
1609
1610 line += "\n";
1611 r += line;
1612 lc++;
1613
1614 if (pc) // chart is loaded and available
1615 line.Printf(" %s: 1:%d", _("Scale"), pc->GetNativeScale());
1616 else
1617 line.Printf(" %s: 1:%d", _("Scale"), cte.GetScale());
1618
1619 line += "\n";
1620 max_width = wxMax(max_width, line.Len());
1621 r += line;
1622 lc++;
1623 if (pc) {
1624 wxDateTime ed = pc->GetEditionDate();
1625 if (ed.IsValid()) {
1626 line = _(" Updated: ") + ed.FormatISODate() + "\n";
1627 max_width = wxMax(max_width, line.Len());
1628 r += line;
1629 }
1630 lc++;
1631
1632 line = _(" Source Edition: ") + pc->GetSE() + "\n";
1633 max_width = wxMax(max_width, line.Len());
1634 r += line;
1635 lc++;
1636 }
1637
1638 if (pc) {
1639 line = _(" Depth Units: ") + pc->GetDepthUnits() + "\n";
1640 max_width = wxMax(max_width, line.Len());
1641 r += line;
1642 lc++;
1643
1644 line = _(" Soundings: ") + pc->GetSoundingsDatum() + "\n";
1645 max_width = wxMax(max_width, line.Len());
1646 r += line;
1647 lc++;
1648
1649 line = _(" Datum: ") + pc->GetDatumString() + "\n";
1650 max_width = wxMax(max_width, line.Len());
1651 r += line;
1652 lc++;
1653 }
1654
1655 line = _(" Projection: ");
1656 if (PROJECTION_UNKNOWN == cte.GetChartProjectionType())
1657 line += _("Unknown");
1658 else if (PROJECTION_MERCATOR == cte.GetChartProjectionType())
1659 line += _("Mercator");
1660 else if (PROJECTION_TRANSVERSE_MERCATOR == cte.GetChartProjectionType())
1661 line += _("Transverse Mercator");
1662 else if (PROJECTION_POLYCONIC == cte.GetChartProjectionType())
1663 line += _("Polyconic");
1664 else if (PROJECTION_WEB_MERCATOR == cte.GetChartProjectionType())
1665 line += _("Web Mercator (EPSG:3857)");
1666 line += "\n";
1667 max_width = wxMax(max_width, line.Len());
1668 r += line;
1669 lc++;
1670
1671 line.Empty();
1672 if (pc) {
1673 }
1674
1675 line.Empty();
1676 if (pc && pc->GetExtraInfo().Len()) {
1677 line += pc->GetExtraInfo();
1678 line += "\n";
1679 max_width = wxMax(max_width, line.Len());
1680 r += line;
1681 lc++;
1682 }
1683 if (pc) {
1684 line.Empty();
1685 line = _(" ID: ");
1686 line += pc->GetID();
1687 line += "\n";
1688 max_width = wxMax(max_width, line.Len());
1689 r += line;
1690 lc++;
1691 }
1692
1693 line = _(" ChartFile: ");
1694 wxString longline = *(cte.GetpsFullPath());
1695 if (longline.Len() > target_width) {
1696 line += SplitPath(longline, "/,\\", target_width, 15, &ncr);
1697 max_width = wxMax(max_width, target_width + 4);
1698 lc += ncr;
1699 } else {
1700 line += longline;
1701 max_width = wxMax(max_width, line.Len() + 4);
1702 }
1703 r += line;
1704 r += "\n";
1705 lc++;
1706
1707 if (line_count) *line_count = lc;
1708
1709 if (char_width) *char_width = max_width;
1710
1711 return r;
1712}
1713
1714// ----------------------------------------------------------------------------
1715// Create Chart Table Database by directory search
1716// resulting in valid pChartTable in (this)
1717// ----------------------------------------------------------------------------
1718bool ChartDatabase::Create(ArrayOfCDI &dir_array,
1719 wxGenericProgressDialog *pprog) {
1720 m_dir_array = dir_array;
1721
1722 bValid = false;
1723
1724 m_chartDirs.Clear();
1725 active_chartTable.clear();
1726 active_chartTable_pathindex.clear();
1727
1728 Update(dir_array, true, pprog); // force the update the reload everything
1729
1730 bValid = true;
1731
1732 // Explicitly set the version
1733 m_dbversion = DB_VERSION_CURRENT;
1734
1735 return true;
1736}
1737
1738/*
1739 * Traverse a directory recursively and find the GSHHG directory
1740 * that contains GSHHG data files.
1741 */
1742class GshhsTraverser : public wxDirTraverser {
1743public:
1744 GshhsTraverser() {}
1745 virtual wxDirTraverseResult OnFile(const wxString &filename) override {
1746 wxFileName fn(filename);
1747 wxFileName dir(fn.GetPath());
1748 if (fn.GetFullName().Matches("poly-*-1.dat") &&
1749 dir.GetFullName().IsSameAs("GSHHG", false)) {
1750 parent_dir = fn.GetPath(wxPATH_GET_VOLUME | wxPATH_GET_SEPARATOR);
1751 return wxDIR_STOP;
1752 }
1753 return wxDIR_CONTINUE;
1754 }
1755 virtual wxDirTraverseResult OnDir(const wxString &dirname) override {
1756 // Always recurse into directories.
1757 return wxDIR_CONTINUE;
1758 }
1759 wxString GetGshhsDir() const { return parent_dir; }
1760
1761private:
1762 wxString parent_dir;
1763};
1764
1765/*
1766 * Find and return the full path a of directory containing GSHHG data files.
1767 * Search recursively starting from directory.
1768 */
1769wxString findGshhgDirectory(const wxString &directory) {
1770 wxDir dir(directory);
1771 if (!dir.IsOpened()) {
1772 return wxEmptyString;
1773 }
1774 GshhsTraverser traverser;
1775 dir.Traverse(traverser, wxEmptyString, wxDIR_FILES | wxDIR_DIRS);
1776 return traverser.GetGshhsDir();
1777}
1778
1779bool ChartDatabase::UpdateChartDatabaseInplace(ArrayOfCDI &DirArray,
1780 bool b_force,
1781 wxGenericProgressDialog *_prog) {
1782 // AbstractPlatform::ShowBusySpinner();
1783
1784 m_pprog = _prog;
1785
1786 wxLogMessage(" ");
1787 wxLogMessage("Starting chart database Update...");
1788
1789 // The Update() function may set gWorldMapLocation if at least one of the
1790 // directories contains GSHHS files. Save current situation...
1791 m_gshhg_chart_loc = gWorldMapLocation;
1792 gWorldMapLocation = wxEmptyString;
1793
1794 Update(DirArray, b_force, m_pprog);
1795
1796 // AbstractPlatform::HideBusySpinner();
1797 return true;
1798}
1799
1800// ----------------------------------------------------------------------------
1801// Update existing ChartTable Database by directory search
1802// resulting in valid pChartTable in (this)
1803// ----------------------------------------------------------------------------
1804bool ChartDatabase::Update(ArrayOfCDI &dir_array, bool bForce,
1805 wxGenericProgressDialog *pprog) {
1806 m_pprog = pprog;
1807 m_ticket_vector.clear();
1808 m_full_collision_map.clear();
1809 m_jobsRemaining = 0;
1810 m_deferred_ticket_vector.clear();
1811 SetChartDirArray(dir_array);
1812
1813 bValid = false; // database is not useable right now...
1814 SetBusy(true);
1815 ChartData->SetBusy(true);
1816
1817 // Mark all charts provisionally invalid
1818 for (unsigned int i = 0; i < active_chartTable.size(); i++) {
1819 auto &cte = GetChartTableEntry(i);
1820 cte.SetValid(false);
1821 }
1822
1823 m_chartDirs.Clear();
1824
1825 if (bForce) active_chartTable.clear();
1826
1827 bool lbForce = bForce;
1828
1829 // Do a dB Version upgrade if the current one is obsolete
1830 if (s_dbVersion != DB_VERSION_CURRENT) {
1831 active_chartTable.clear();
1832 lbForce = true;
1833 s_dbVersion = DB_VERSION_CURRENT; // Update the static indicator
1834 m_dbversion = DB_VERSION_CURRENT; // and the member
1835 }
1836
1837 // Get the new charts
1838
1839 for (unsigned int j = 0; j < dir_array.GetCount(); j++) {
1840 ChartDirInfo dir_info = dir_array[j];
1841
1842 // On Android, with SDK >= 30, traversal of a folder that is
1843 // on within the "scoped storage" domain is very slow.
1844 // Aviod it....
1845#ifdef __ANDROID__
1846 if (!androidIsDirWritable(dir_info.fullpath)) continue;
1847#endif
1848
1849 wxString dir_magic;
1850 // Recursively search for a directory that contains GSHHG files starting
1851 // from dir_info.
1852 wxString gshhg_dir = findGshhgDirectory(dir_info.fullpath);
1853 if (!gshhg_dir.empty()) {
1854 // If some polygons exist in the directory, set it as the one to use for
1855 // GSHHG
1856 // TODO: We should probably compare the version and maybe resolutions
1857 // available with what is currently used...
1858 wxLogMessage("Updating GSHHG directory: %s", gshhg_dir.c_str());
1859 gWorldMapLocation = gshhg_dir;
1860 }
1861
1862 // If the user has added a directory containig an extended OSMSHP basemap
1863 // then capture the location, and reset the basemap render amchine.
1864 if (dir_info.fullpath.Find("OSMSHP") != wxNOT_FOUND) {
1865 if (!wxDir::FindFirst(dir_info.fullpath, "basemap_*.shp").empty()) {
1866 wxLogMessage("Updating OSMSHP directory: %s", dir_info.fullpath);
1867 gWorldShapefileLocation =
1868 dir_info.fullpath + wxFileName::GetPathSeparator();
1869 gShapeBasemap.Reset();
1870 }
1871 }
1872
1873 TraverseDirAndAddCharts(dir_info, pprog, dir_magic, lbForce);
1874
1875 // Update the dir_list entry, even if the magic values are the same
1876 dir_info.magic_number = dir_magic;
1877 dir_array.RemoveAt(j);
1878 dir_array.Insert(dir_info, j);
1879
1880 m_chartDirs.Add(dir_info.fullpath);
1881 } // for
1882
1883 // Special case, if chart dir list is truly empty
1884 if (m_chartDirs.IsEmpty() || !m_jobsRemaining) {
1885 if (!m_deferred_ticket_vector.size()) {
1886 FinalizeChartUpdate();
1887 return true;
1888 } else {
1889 auto *evt =
1890 new OCPN_ChartTableEntryThreadEvent(wxEVT_OCPN_CHARTTABLEENTRYTHREAD);
1891 auto ticket_deferred = m_deferred_ticket_vector.back();
1892 ticket_deferred->m_ticket_type = 1; // Mark as a dummy ticket.;
1893 // to trigger an event
1894 m_jobsRemaining = 1;
1895 evt->SetTicket(ticket_deferred);
1896 wxQueueEvent(this, evt);
1897 }
1898 }
1899
1900 // Initialize progress dialog
1901 m_progcount = 0;
1902 m_progint = 0;
1903 m_ticketcount = m_jobsRemaining;
1904 m_nFileProgressQuantum = 1; // wxMax(m_ticketcount / 10, 2);
1905 m_progress_message = _("Processing charts");
1906
1907 m_progress_timer.Start(50, wxTIMER_CONTINUOUS);
1908
1909 // Start up the queued threads, if necessary
1910 if (m_jobsRemaining) {
1911 int workerCount = 4;
1912#ifdef __ANDROID__
1913 workerCount = 1; // A little less stress on busy phones.
1914#endif
1915 if (m_pool.GetWorkerCount() < workerCount) {
1916 int threads_needed = workerCount - m_pool.GetWorkerCount();
1917 for (int i = 0; i < threads_needed; ++i) {
1918 (new PoolWorkerThread(m_pool, this))->Run();
1919 m_pool.AddWorker();
1920 }
1921 }
1922 }
1923
1924 return true;
1925}
1926
1927//-------------------------------------------------------------------
1928// Find Chart dbIndex
1929//-------------------------------------------------------------------
1930
1931int ChartDatabase::FinddbIndex(wxString PathToFind) {
1932 if (active_chartTable_pathindex.find(PathToFind) !=
1933 active_chartTable_pathindex.end())
1934 return active_chartTable_pathindex[PathToFind];
1935
1936 return -1;
1937}
1938
1939//-------------------------------------------------------------------
1940// Disable Chart
1941//-------------------------------------------------------------------
1942
1943int ChartDatabase::DisableChart(wxString &PathToDisable) {
1944 int index = FinddbIndex(PathToDisable);
1945 if (index != -1) {
1946 auto &entry = GetChartTableEntry(index);
1947 entry.Disable();
1948 return 1;
1949 }
1950 return 0;
1951}
1952
1953// ----------------------------------------------------------------------------
1954// Traverse the given directory looking for charts
1955// If bupdate is true, also search the existing database for a name match.
1956// If target chart is already in database, mark the entry valid and skip
1957// additional processing
1958// ----------------------------------------------------------------------------
1959
1960int ChartDatabase::TraverseDirAndAddCharts(ChartDirInfo &dir_info,
1961 wxGenericProgressDialog *pprog,
1962 wxString &dir_magic, bool bForce) {
1963 // Extract the true dir name and magic number from the compound string
1964 wxString dir_path = dir_info.fullpath;
1965#ifdef __ANDROID__
1966 dir_path = wxString(dir_info.fullpath.mb_str(wxConvUTF8));
1967#endif
1968
1969 wxString old_magic = dir_info.magic_number;
1970 wxString new_magic = old_magic;
1971 dir_magic = old_magic; // provisionally the same
1972
1973 int nAdd = 0;
1974
1975 bool b_skipDetectDirChange = false;
1976 bool b_dirchange = false;
1977
1978 // Does this directory actually exist?
1979 if (!wxDir::Exists(dir_path)) return 0;
1980
1981 // Check to see if this is a cm93 directory root
1982 // If so, skip the DetectDirChange since it may be very slow
1983 // and give no information
1984 // Assume a change has happened, and process accordingly
1985 bool b_cm93 = Check_CM93_Structure(dir_path);
1986 if (b_cm93) {
1987 b_skipDetectDirChange = true;
1988 b_dirchange = true;
1989 }
1990
1991 // Quick scan the directory to see if it has changed
1992 // If not, there is no need to scan again.....
1993 if (!b_skipDetectDirChange)
1994 b_dirchange = DetectDirChange(dir_path, dir_info.fullpath, old_magic,
1995 new_magic, pprog);
1996
1997 if (!bForce && !b_dirchange) {
1998 wxString msg(" No change detected on directory ");
1999 msg.Append(dir_path);
2000 wxLogMessage(msg);
2001
2002 // Traverse the database, and mark as valid all charts coming from this
2003 // dir, or anywhere in its tree
2004
2005 wxFileName fn_dir(dir_path, "stuff");
2006 unsigned int dir_path_count = fn_dir.GetDirCount();
2007
2008 if (pprog) pprog->SetTitle(_("OpenCPN Chart Scan...."));
2009
2010 int nEntries = active_chartTable.size();
2011
2012 for (int ic = 0; ic < nEntries; ic++) {
2013 auto &cte = GetChartTableEntry(ic);
2014 wxFileName fn(cte.GetFullSystemPath());
2015
2016 while (fn.GetDirCount() >= dir_path_count) {
2017 if (fn.GetPath() == dir_path) {
2018 auto &cte_a = GetChartTableEntry(ic);
2019 cte_a.SetValid(true);
2020 // if(pprog)
2021 // pprog->Update((ic * 100)
2022 // /nEntries, fn.GetFullPath());
2023
2024 break;
2025 }
2026 fn.RemoveLastDir();
2027 }
2028 }
2029
2030 return 0;
2031 }
2032
2033 // There presumably was a change in the directory contents. Return the new
2034 // magic number
2035 dir_magic = new_magic;
2036
2037 // Look for all possible defined chart classes
2038 for (auto &cd : m_ChartClassDescriptorArray) {
2039 nAdd += SearchDirAndAddCharts(dir_info.fullpath, cd, pprog);
2040 }
2041
2042 return nAdd;
2043}
2044
2045bool ChartDatabase::DetectDirChange(const wxString &dir_path,
2046 const wxString &prog_label,
2047 const wxString &magic, wxString &new_magic,
2048 wxGenericProgressDialog *pprog) {
2049 if (pprog) pprog->SetTitle(_("OpenCPN Directory Scan...."));
2050
2051 // parse the magic number
2052 long long unsigned int nmagic;
2053 wxULongLong nacc = 0;
2054
2055 magic.ToULongLong(&nmagic, 10);
2056
2057 // Get an arraystring of all files
2058 wxArrayString FileList;
2059 wxDir dir(dir_path);
2060 int n_files = dir.GetAllFiles(dir_path, &FileList);
2061 FileList.Sort(); // Ensure persistent order of items being hashed.
2062
2063 FlexHash hash(sizeof nacc);
2064 hash.Reset();
2065
2066 if (pprog) pprog->Update(0, prog_label);
2067
2068 // Traverse the list of files, getting their interesting stuff to add to
2069 // accumulator
2070 for (int ifile = 0; ifile < n_files; ifile++) {
2071 wxFileName file(FileList[ifile]);
2072
2073 // NOTE. Do not ever try to optimize this code by combining `wxString`
2074 // calls. Otherwise `fileNameUTF8` will point to a stale buffer overwritten
2075 // by garbage.
2076 wxString fileNameNative = file.GetFullPath();
2077 wxScopedCharBuffer fileNameUTF8 = fileNameNative.ToUTF8();
2078 hash.Update(fileNameUTF8.data(), fileNameUTF8.length());
2079
2080 // File Size;
2081 wxULongLong size = file.GetSize();
2082 wxULongLong fileSize = ((size != wxInvalidSize) ? size : 0);
2083 hash.Update(&fileSize, (sizeof fileSize));
2084
2085 // Mod time, in ticks
2086 wxDateTime t = file.GetModificationTime();
2087 wxULongLong fileTime = t.GetTicks();
2088 hash.Update(&fileTime, (sizeof fileTime));
2089 }
2090
2091 hash.Finish();
2092 hash.Receive(&nacc);
2093
2094 // Return the calculated magic number
2095 new_magic = nacc.ToString();
2096
2097 // And do the test
2098 if (new_magic != magic)
2099 return true;
2100 else
2101 return false;
2102}
2103
2104bool ChartDatabase::IsChartDirUsed(const wxString &theDir) {
2105 wxString dir(theDir);
2106 if (dir.Last() == '/' || dir.Last() == wxFileName::GetPathSeparator())
2107 dir.RemoveLast();
2108
2109 dir.Append("*");
2110 for (UINT32 i = 0; i < active_chartTable.size(); i++) {
2111 auto &cte_u = GetChartTableEntry(i);
2112 if (cte_u.GetpsFullPath()->Matches(dir)) return true;
2113 }
2114 return false;
2115}
2116
2117//-----------------------------------------------------------------------------
2118// Validate a given directory as a cm93 root database
2119// If it appears to be a cm93 database, then return true
2120//-----------------------------------------------------------------------------
2121bool ChartDatabase::Check_CM93_Structure(wxString dir_name) {
2122 wxString filespec;
2123
2124 wxRegEx test("[0-9]+");
2125
2126 wxDir dirt(dir_name);
2127 wxString candidate;
2128
2129 if (dirt.IsOpened())
2130 wxLogMessage("check_cm93 opened dir OK: " + dir_name);
2131 else {
2132 wxLogMessage("check_cm93 NOT OPENED OK: " + dir_name);
2133 wxLogMessage("check_cm93 returns false." + dir_name);
2134 return false;
2135 }
2136
2137 bool b_maybe_found_cm93 = false;
2138 bool b_cont = dirt.GetFirst(&candidate);
2139
2140 while (b_cont) {
2141 if (test.Matches(candidate) && (candidate.Len() == 8)) {
2142 b_maybe_found_cm93 = true;
2143 break;
2144 }
2145
2146 b_cont = dirt.GetNext(&candidate);
2147 }
2148
2149 if (b_maybe_found_cm93) {
2150 wxString dir_next = dir_name;
2151 dir_next += "/";
2152 dir_next += candidate;
2153 if (wxDir::Exists(dir_next)) {
2154 wxDir dir_n(dir_next);
2155 if (dirt.IsOpened()) {
2156 wxString candidate_n;
2157
2158 wxRegEx test_n("^[A-Ga-g]");
2159 bool b_probably_found_cm93 = false;
2160 bool b_cont_n = dir_n.IsOpened() && dir_n.GetFirst(&candidate_n);
2161 while (b_cont_n) {
2162 if (test_n.Matches(candidate_n) && (candidate_n.Len() == 1)) {
2163 b_probably_found_cm93 = true;
2164 break;
2165 }
2166 b_cont_n = dir_n.GetNext(&candidate_n);
2167 }
2168
2169 if (b_probably_found_cm93) // found a directory that looks
2170 // like {dir_name}/12345678/A
2171 // probably cm93
2172 {
2173 // make sure the dir exists
2174 wxString dir_luk = dir_next;
2175 dir_luk += "/";
2176 dir_luk += candidate_n;
2177 if (wxDir::Exists(dir_luk)) return true;
2178 }
2179 }
2180 }
2181 }
2182
2183 return false;
2184}
2185
2186/*
2187//-----------------------------------------------------------------------------
2188// Validate a given directory as a cm93 root database
2189// If it appears to be a cm93 database, then return the name of an existing cell
2190file
2191// File name will be unique with respect to member element m_cm93_filename_array
2192// If not cm93, return empty string
2193//-----------------------------------------------------------------------------
2194wxString ChartDatabase::Get_CM93_FileName(wxString dir_name)
2195{
2196 wxString filespec;
2197
2198 wxRegEx test("[0-9]+");
2199
2200 wxDir dirt(dir_name);
2201 wxString candidate;
2202
2203 bool b_maybe_found_cm93 = false;
2204 bool b_cont = dirt.GetFirst(&candidate);
2205
2206 while(b_cont)
2207 {
2208 if(test.Matches(candidate)&& (candidate.Len() == 8))
2209 {
2210 b_maybe_found_cm93 = true;
2211 break;
2212 }
2213
2214 b_cont = dirt.GetNext(&candidate);
2215
2216 }
2217
2218 if(b_maybe_found_cm93)
2219 {
2220 wxString dir_next = dir_name;
2221 dir_next += "/";
2222 dir_next += candidate;
2223 if(wxDir::Exists(dir_next))
2224 {
2225 wxDir dir_n(dir_next);
2226 wxString candidate_n;
2227
2228 wxRegEx test_n("^[A-Ga-g]");
2229 bool b_probably_found_cm93 = false;
2230 bool b_cont_n = dir_n.GetFirst(&candidate_n);
2231 while(b_cont_n)
2232 {
2233 if(test_n.Matches(candidate_n) && (candidate_n.Len() ==
22341))
2235 {
2236 b_probably_found_cm93 = true;
2237 break;
2238 }
2239 b_cont_n = dir_n.GetNext(&candidate_n);
2240 }
2241
2242 if(b_probably_found_cm93) // found a directory that
2243looks like {dir_name}/12345678/A probably cm93 { // and we want to try and
2244shorten the recursive search
2245 // make sure the dir exists
2246 wxString dir_luk = dir_next;
2247 dir_luk += "/";
2248 dir_luk += candidate_n;
2249 if(wxDir::Exists(dir_luk))
2250 {
2251 wxString msg("Found probable CM93 database in
2252"); msg += dir_name; wxLogMessage(msg);
2253
2254 wxString dir_name_plus = dir_luk; // be very
2255specific about the dir_name,
2256
2257 wxDir dir_get(dir_name_plus);
2258 wxString one_file;
2259 dir_get.GetFirst(&one_file);
2260
2261 // We must return a unique file name, i.e. one
2262that has not bee seen
2263 // before in this invocation of chart dir
2264scans. bool find_unique = false; while(!find_unique)
2265 {
2266 find_unique = true;
2267 for(unsigned int ifile=0; ifile <
2268m_cm93_filename_array.GetCount(); ifile++)
2269 {
2270 if(m_cm93_filename_array[ifile] ==
2271one_file) find_unique = false;
2272 }
2273 if(!find_unique)
2274 dir_get.GetNext(&one_file);
2275 }
2276
2277 m_cm93_filename_array.Add(one_file);
2278
2279 filespec = one_file;
2280 }
2281
2282 }
2283 }
2284 }
2285
2286 return filespec;
2287}
2288*/
2289
2290int ChartDatabase::SearchDirAndAddCharts(wxString &dir_name_base,
2291 ChartClassDescriptor &chart_desc,
2292 wxGenericProgressDialog *pprog) {
2293 wxString msg("Searching directory: ");
2294 msg += dir_name_base;
2295 msg += " for ";
2296 msg += chart_desc.m_search_mask;
2297 wxLogMessage(msg);
2298
2299 wxString dir_name = dir_name_base;
2300
2301#ifdef __ANDROID__
2302 dir_name = wxString(dir_name_base.mb_str(wxConvUTF8)); // android
2303#endif
2304
2305 if (!wxDir::Exists(dir_name)) return 0;
2306
2307 wxString filespec = chart_desc.m_search_mask.Upper();
2308 wxString lowerFileSpec = chart_desc.m_search_mask.Lower();
2309 wxString filespecXZ = filespec + ".xz";
2310 wxString lowerFileSpecXZ = lowerFileSpec + ".xz";
2311 wxString filename;
2312
2313 // Count the files
2314 wxArrayString FileList;
2315 int gaf_flags = wxDIR_DEFAULT; // as default, recurse into subdirs
2316
2317 // Here is an optimization for MSW/cm93 especially
2318 // If this directory seems to be a cm93, and we are not explicitely looking
2319 // for cm93, then abort Otherwise, we will be looking thru entire cm93 tree
2320 // for non-existent .KAP files, etc.
2321
2322 bool b_found_cm93 = false;
2323 bool b_cm93 = Check_CM93_Structure(dir_name);
2324 if (b_cm93) {
2325 if (filespec != "00300000.A")
2326 return false;
2327 else {
2328 filespec = dir_name;
2329 b_found_cm93 = true;
2330 }
2331 }
2332
2333 if (!b_found_cm93) {
2334 wxDir dir(dir_name);
2335 dir.GetAllFiles(dir_name, &FileList, filespec, gaf_flags);
2336
2337#ifdef __ANDROID__
2338 if (!FileList.GetCount()) {
2339 wxArrayString afl = androidTraverseDir(dir_name, filespec);
2340 for (wxArrayString::const_iterator item = afl.begin(); item != afl.end();
2341 item++)
2342 FileList.Add(*item);
2343 }
2344#endif
2345
2346#ifndef __WXMSW__
2347 if (filespec != lowerFileSpec) {
2348 // add lowercase filespec files too
2349 wxArrayString lowerFileList;
2350 dir.GetAllFiles(dir_name, &lowerFileList, lowerFileSpec, gaf_flags);
2351
2352#ifdef __ANDROID__
2353 if (!lowerFileList.GetCount()) {
2354 wxArrayString afl = androidTraverseDir(dir_name, lowerFileSpec);
2355 for (wxArrayString::const_iterator item = afl.begin();
2356 item != afl.end(); item++)
2357 lowerFileList.Add(*item);
2358 }
2359#endif
2360
2361 for (wxArrayString::const_iterator item = lowerFileList.begin();
2362 item != lowerFileList.end(); item++)
2363 FileList.Add(*item);
2364 }
2365#endif
2366
2367#ifdef OCPN_USE_LZMA
2368 // add xz compressed files;
2369 dir.GetAllFiles(dir_name, &FileList, filespecXZ, gaf_flags);
2370 dir.GetAllFiles(dir_name, &FileList, lowerFileSpecXZ, gaf_flags);
2371#endif
2372
2373 FileList.Sort(); // Sorted processing order makes the progress bar more
2374 // meaningful to the user.
2375 } else { // This is a cm93 dataset, specified as yada/yada/cm93
2376 wxString dir_plus = dir_name;
2377 dir_plus += wxFileName::GetPathSeparator();
2378 FileList.Add(dir_plus);
2379 }
2380
2381 int nFile = FileList.GetCount();
2382
2383 if (!nFile) return false;
2384
2385 int nDirEntry = 0;
2386
2387 // Check to see if there are any charts in the DB which refer to this
2388 // directory If none at all, there is no need to scan the DB for fullpath
2389 // match of each potential addition and bthis_dir_in_dB is false.
2390 // bool bthis_dir_in_dB = IsChartDirUsed(dir_name);
2391
2392 if (pprog) pprog->SetTitle(_("OpenCPN Chart Add...."));
2393
2394 // build a hash table based on filename (without directory prefix) of
2395 // the chart to fast detect identical charts
2396 ChartCollisionsHashMap collision_map;
2397 // int nEntry = active_chartTable.GetCount();
2398 // for (int i = 0; i < nEntry; i++) {
2399 // wxString table_file_name = active_chartTable[i].GetFullSystemPath();
2400 // wxFileName table_file(table_file_name);
2401 // collision_map[table_file.GetFullName()] = i;
2402 // }
2403
2404 // Capture a vector of pending thread tickets for this directory
2405 std::vector<std::shared_ptr<ChartTableEntryJobTicket>> ticket_vector;
2406
2407 for (int ifile = 0; ifile < nFile; ifile++) {
2408 wxFileName file(FileList[ifile]);
2409 wxString full_path = file.GetFullPath();
2410 wxString file_name = file.GetFullName();
2411 wxString utf8_path = full_path;
2412
2413#ifdef __ANDROID__
2414 // The full path (full_name) is the broken Android files system
2415 // interpretation, which does not display well onscreen. So, here we
2416 // reconstruct a full path spec in UTF-8 encoding for later use in string
2417 // displays. This utf-8 string will be used to construct the chart database
2418 // entry if required.
2419 wxFileName fnbase(dir_name_base);
2420 int nDirs = fnbase.GetDirCount();
2421
2422 wxFileName file_target(FileList[ifile]);
2423
2424 for (int i = 0; i < nDirs + 1;
2425 i++) // strip off the erroneous intial directories
2426 file_target.RemoveDir(0);
2427
2428 wxString leftover_path = file_target.GetFullPath();
2429 utf8_path =
2430 dir_name_base + leftover_path; // reconstruct a fully utf-8 version
2431#endif
2432
2433 // Validate the file name again, considering MSW's semi-random treatment
2434 // of case....
2435 // TODO...something fishy here - may need to normalize saved name?
2436 if (!file_name.Matches(lowerFileSpec) && !file_name.Matches(filespec) &&
2437 !file_name.Matches(lowerFileSpecXZ) && !file_name.Matches(filespecXZ) &&
2438 !b_found_cm93) {
2439 // wxLogMessage("FileSpec test failed for:" + file_name);
2440 continue;
2441 }
2442
2443 ChartTableEntry *pnewChart = NULL;
2444 bool bAddFinal = true;
2445 int b_add_msg = 0;
2446
2447#if 0 // TODO Fix?
2448 // Check the collisions map looking for duplicates in directories already
2449 // processed, and choosing the right one.
2450// ChartCollisionsHashMap::const_iterator collision_ptr =
2451// collision_map.find(file_name);
2452// bool collision = (collision_ptr != collision_map.end());
2453// bool file_path_is_same = false;
2454// bool file_time_is_same = false;
2455// ChartTableEntry *pEntry = NULL;
2456// wxString table_file_name;
2457
2458
2459 // Allow multiple cm93 chart sets #4217
2460 if (b_found_cm93) collision = false;
2461
2462 if (collision) {
2463 pEntry = &active_chartTable[collision_ptr->second];
2464 table_file_name = pEntry->GetFullSystemPath();
2465 file_path_is_same =
2466 bthis_dir_in_dB && full_name.IsSameAs(table_file_name);
2467
2468 // If the chart full file paths are exactly the same, select the newer
2469 // one.
2470 if (file_path_is_same) {
2471 b_add_msg++;
2472
2473 // Check the file modification time
2474 time_t t_oldFile = pEntry->GetFileTime();
2475 time_t t_newFile = file.GetModificationTime().GetTicks();
2476
2477 if (t_newFile <= t_oldFile) {
2478 file_time_is_same = true;
2479 bAddFinal = false;
2480 pEntry->SetValid(true);
2481 } else {
2482 bAddFinal = true;
2483 pEntry->SetValid(false);
2484 }
2485 }
2486 }
2487#endif
2488
2489 // Check for duplicates within this directory
2490 bool collision_found = false;
2491 ChartCollisionsHashMap::iterator it;
2492 for (it = collision_map.begin(); it != collision_map.end(); ++it) {
2493 if (it->first.IsSameAs(file_name)) {
2494 // Two files found with identical file name
2495 // For now, just drop this ticket
2496 // TODO Make an (expensive) test on file modification times
2497 collision_found = true;
2498 break;
2499 }
2500 }
2501
2502 if (!collision_found) {
2503 // Create a ticket for this chart
2504 auto ticket = std::make_shared<ChartTableEntryJobTicket>();
2505 ticket->m_ChartPath = full_path;
2506 ticket->m_ChartPathUTF8 = full_path;
2507 ticket->chart_desc = chart_desc;
2508
2509 ticket_vector.push_back(ticket);
2510 collision_map[file_name] = ifile;
2511 }
2512
2513 } // the big loop
2514
2515 // Built-in chart types are all thread-safe
2516 // Check plugin charts
2517 bool is_kap = false; // chart_desc.m_class_name.IsSameAs("ChartKAP");
2518 if (chart_desc.m_descriptor_type == PLUGIN_DESCRIPTOR || is_kap) {
2519 // Check plugin charts API. API >- 118 are known to be thread-safe
2520 opencpn_plugin *plugin = chart_desc.m_plugin;
2521 opencpn_plugin_118 *provider_plugin118 = dynamic_cast<opencpn_plugin_118 *>(
2522 dynamic_cast<opencpn_plugin *>(plugin));
2523
2524 if (!provider_plugin118 || is_kap) {
2525 // old plugin, charts not thread-safe
2526 // So arrange to process the tickets in the main app thread,
2527 // during the event handler, at the end of the queue processing
2528 for (auto &ticket : ticket_vector) {
2529 ticket->b_thread_safe = false;
2530 ticket->m_provider_type = 1;
2531 ticket->provider_class_name = chart_desc.m_class_name;
2532 m_deferred_ticket_vector.push_back(ticket);
2533 }
2534 return nDirEntry;
2535 }
2536 }
2537
2538 // Chart directory is known thread-safe
2539 // load the thread pool from the prepared array
2540 // Enqueue jobs
2541 for (auto &ticket : ticket_vector) {
2542 m_pool.Push(ticket);
2543 m_jobsRemaining++;
2544 }
2545
2546 // Tickets queued, wait for completion events
2547 return nDirEntry;
2548}
2549
2550bool ChartDatabase::AddChart(wxString &chartfilename,
2551 ChartClassDescriptor &chart_desc,
2552 wxGenericProgressDialog *pprog, int isearch,
2553 bool bthis_dir_in_dB) {
2554 bool rv = false;
2555 wxFileName file(chartfilename);
2556 wxString full_name = file.GetFullPath();
2557 wxString file_name = file.GetFullName();
2558
2559 // Validate the file name again, considering MSW's semi-random treatment of
2560 // case....
2561 // TODO...something fishy here - may need to normalize saved name?
2562 // if(!file_name.Matches(lowerFileSpec) && !file_name.Matches(filespec) &&
2563 // !b_found_cm93)
2564 // continue;
2565
2566 if (pprog)
2567 pprog->Update(wxMin((m_pdifile * 100) / m_pdnFile, 100), full_name);
2568
2569 ChartTableEntry *pnewChart = NULL;
2570 bool bAddFinal = true;
2571 int b_add_msg = 0;
2572 wxString msg_fn(full_name);
2573 msg_fn.Replace("%", "%%");
2574
2575 pnewChart = CreateChartTableEntry(full_name, full_name, chart_desc);
2576 if (!pnewChart) {
2577 bAddFinal = false;
2578 wxLogMessage(wxString::Format(
2579 " CreateChartTableEntry() failed for file: %s", msg_fn.c_str()));
2580 return false;
2581 } else // traverse the existing database looking for duplicates, and choosing
2582 // the right one
2583 {
2584 int nEntry = active_chartTable.size();
2585 for (int i = 0; i < nEntry; i++) {
2586 auto &cte_a = GetChartTableEntry(i);
2587 wxString *ptable_file_name = cte_a.GetpsFullPath();
2588
2589 // If the chart full file paths are exactly the same, select the newer
2590 // one
2591 if (bthis_dir_in_dB && full_name.IsSameAs(*ptable_file_name)) {
2592 b_add_msg++;
2593
2594 // Check the file modification time
2595 auto &cte_search = GetChartTableEntry(isearch);
2596 time_t t_oldFile = cte_search.GetFileTime();
2597 time_t t_newFile = file.GetModificationTime().GetTicks();
2598
2599 if (t_newFile <= t_oldFile) {
2600 bAddFinal = false;
2601 cte_search.SetValid(true);
2602 } else {
2603 bAddFinal = true;
2604 cte_search.SetValid(false);
2605 wxLogMessage(
2606 wxString::Format(" Replacing older chart file of same path: %s",
2607 msg_fn.c_str()));
2608 }
2609
2610 break;
2611 }
2612
2613 // Look at the chart file name (without directory prefix) for a further
2614 // check for duplicates This catches the case in which the "same" chart
2615 // is in different locations, and one may be newer than the other.
2616 wxFileName table_file(*ptable_file_name);
2617
2618 if (table_file.GetFullName() == file_name) {
2619 b_add_msg++;
2620
2621 // TODO fix this...
2622#if 0
2623 if (pnewChart->IsEarlierThan(active_chartTable[isearch])) {
2624 // Make sure the compare file actually exists
2625 if (table_file.IsFileReadable()) {
2626 active_chartTable[isearch].SetValid(true);
2627 bAddFinal = false;
2628 wxLogMessage(wxString::Format(
2629 " Retaining newer chart file of same name: %s",
2630 msg_fn.c_str()));
2631 }
2632 } else if (pnewChart->IsEqualTo(active_chartTable[isearch])) {
2633 // The file names (without dir prefix) are identical,
2634 // and the mod times are identical
2635 // Prsume that this is intentional, in order to facilitate
2636 // having the same chart in multiple groups.
2637 // So, add this chart.
2638 bAddFinal = true;
2639 }
2640
2641 else {
2642 active_chartTable[isearch].SetValid(false);
2643 bAddFinal = true;
2644 wxLogMessage(
2645 wxString::Format(" Replacing older chart file of same name: %s",
2646 msg_fn.c_str()));
2647 }
2648#endif
2649 break;
2650 }
2651
2652 // TODO Look at the chart ID as a further check against duplicates
2653
2654 isearch++;
2655 if (nEntry == isearch) isearch = 0;
2656 } // for
2657 }
2658
2659 if (bAddFinal) {
2660 if (0 == b_add_msg) {
2661 wxLogMessage(
2662 wxString::Format(" Adding chart file: %s", msg_fn.c_str()));
2663 }
2664 std::shared_ptr<ChartTableEntry> sharedPtr(pnewChart);
2665 active_chartTable.push_back(sharedPtr);
2666 rv = true;
2667 } else {
2668 delete pnewChart;
2669 // wxLogMessage(wxString::Format(" Not adding chart
2670 // file: %s", msg_fn.c_str()));
2671 rv = false;
2672 }
2673
2674 m_nentries = active_chartTable.size();
2675
2676 return rv;
2677}
2678
2679bool ChartDatabase::AddSingleChart(wxString &ChartFullPath,
2680 bool b_force_full_search) {
2681 // Find a relevant chart class descriptor
2682 wxFileName fn(ChartFullPath);
2683 wxString ext = fn.GetExt();
2684 ext.Prepend("*.");
2685 wxString ext_upper = ext.MakeUpper();
2686 wxString ext_lower = ext.MakeLower();
2687 wxString dir_name = fn.GetPath();
2688
2689 // Search the array of chart class descriptors to find a match
2690 // between the search mask and the chart file extension
2691
2693 for (auto &cd : m_ChartClassDescriptorArray) {
2694 if (cd.m_descriptor_type == PLUGIN_DESCRIPTOR) {
2695 if (cd.m_search_mask == ext_upper) {
2696 desc = cd;
2697 break;
2698 }
2699 if (cd.m_search_mask == ext_lower) {
2700 desc = cd;
2701 break;
2702 }
2703 }
2704 }
2705
2706 // If we know that we need to do a full recursive search of the db,
2707 // then there is no need to verify it by doing a directory match
2708 bool b_recurse = true;
2709 if (!b_force_full_search) b_recurse = IsChartDirUsed(dir_name);
2710
2711 bool rv = AddChart(ChartFullPath, desc, NULL, 0, b_recurse);
2712
2713 // remove duplicates marked in AddChart()
2714
2715 for (unsigned int i = 0; i < active_chartTable.size(); i++) {
2716 auto &cte_r = GetChartTableEntry(i);
2717 if (!cte_r.GetbValid()) {
2718 // TODO fix this
2719 // active_chartTable.RemoveAt(i);
2720 i--; // entry is gone, recheck this index for next entry
2721 }
2722 }
2723
2724 // Update the Entry index fields
2725 for (unsigned int i = 0; i < active_chartTable.size(); i++) {
2726 auto &cte_ef = GetChartTableEntry(i);
2727 cte_ef.SetEntryOffset(i);
2728 }
2729
2730 // Get a new magic number
2731 wxString new_magic;
2732 DetectDirChange(dir_name, "", "", new_magic, 0);
2733
2734 // Update (clone) the CDI array
2735 bool bcfound = false;
2736 ArrayOfCDI NewChartDirArray;
2737
2738 ArrayOfCDI ChartDirArray = GetChartDirArray();
2739 for (unsigned int i = 0; i < ChartDirArray.GetCount(); i++) {
2740 ChartDirInfo cdi = ChartDirArray[i];
2741
2742 ChartDirInfo newcdi = cdi;
2743
2744 // If entry is found that matches this cell, clear the magic number.
2745 if (newcdi.fullpath == dir_name) {
2746 newcdi.magic_number = new_magic;
2747 bcfound = true;
2748 }
2749
2750 NewChartDirArray.Add(newcdi);
2751 }
2752
2753 if (!bcfound) {
2754 ChartDirInfo cdi;
2755 cdi.fullpath = dir_name;
2756 cdi.magic_number = new_magic;
2757 NewChartDirArray.Add(cdi);
2758 }
2759
2760 // Update the database master copy of the CDI array
2761 SetChartDirArray(NewChartDirArray);
2762
2763 // Update the list of chart dirs.
2764 m_chartDirs.Clear();
2765
2766 for (unsigned int i = 0; i < GetChartDirArray().GetCount(); i++) {
2767 ChartDirInfo cdi = GetChartDirArray()[i];
2768 m_chartDirs.Add(cdi.fullpath);
2769 }
2770
2771 m_nentries = active_chartTable.size();
2772
2773 ChartData->UpdateChartDatabaseInplace(NewChartDirArray, false, nullptr);
2774 return rv;
2775}
2776
2777bool ChartDatabase::RemoveSingleChart(wxString &ChartFullPath) {
2778 bool rv = false;
2779
2780 // Walk the chart table, looking for the target
2781 for (unsigned int i = 0; i < active_chartTable.size(); i++) {
2782 auto &cte = GetChartTableEntry(i);
2783 if (ChartFullPath.IsSameAs(cte.GetFullSystemPath())) {
2784 // Fast remove element, order not preserved
2785 std::swap(active_chartTable[i], active_chartTable.back());
2786 active_chartTable.pop_back();
2787 break;
2788 }
2789 }
2790
2791 // Update the EntryOffset fields for the array
2792 for (unsigned int i = 0; i < active_chartTable.size(); i++) {
2793 auto &pcte = GetChartTableEntry(i);
2794 pcte.SetEntryOffset(i);
2795 }
2796
2797 // Check and update the dir array
2798 wxFileName fn(ChartFullPath);
2799 wxString fd = fn.GetPath();
2800 if (!IsChartDirUsed(fd)) {
2801 // Clone a new array, removing the unused directory,
2802 ArrayOfCDI NewChartDirArray;
2803
2804 ArrayOfCDI ChartDirArray = GetChartDirArray();
2805 for (unsigned int i = 0; i < ChartDirArray.GetCount(); i++) {
2806 ChartDirInfo cdi = ChartDirArray[i];
2807
2808 ChartDirInfo newcdi = cdi;
2809
2810 if (newcdi.fullpath != fd) NewChartDirArray.Add(newcdi);
2811 }
2812
2813 SetChartDirArray(NewChartDirArray);
2814 }
2815
2816 // Update the list of chart dirs.
2817 m_chartDirs.Clear();
2818 for (unsigned int i = 0; i < GetChartDirArray().GetCount(); i++) {
2819 ChartDirInfo cdi = GetChartDirArray()[i];
2820 m_chartDirs.Add(cdi.fullpath);
2821 }
2822
2823 m_nentries = active_chartTable.size();
2824 ChartData->UpdateChartDatabaseInplace(m_dir_array, false, nullptr);
2825
2826 return rv;
2827}
2828
2830// Create a Chart object
2832
2833ChartBase *ChartDatabase::GetChart(const wxChar *theFilePath,
2834 ChartClassDescriptor &chart_desc) const {
2835 // TODO: support non-UI chart factory
2836 return NULL;
2837}
2838
2840// Create Chart Table entry by reading chart header info, etc.
2842
2843ChartTableEntry *ChartDatabase::CreateChartTableEntry(
2844 const wxString &filePath, wxString &utf8Path,
2845 ChartClassDescriptor &chart_desc) {
2846 wxString msg_fn(filePath);
2847 msg_fn.Replace("%", "%%");
2848 wxLogMessage(wxString::Format("Loading chart data for %s", msg_fn.c_str()));
2849
2850#ifdef __ANDROID__
2851 qDebug() << " CCTE: " << filePath.ToStdString().c_str();
2852#endif
2853 ChartBase *pch = GetChart(filePath, chart_desc);
2854 if (pch == NULL) {
2855 wxLogMessage(
2856 wxString::Format(" ...creation failed for %s", msg_fn.c_str()));
2857 return NULL;
2858 }
2859
2860 InitReturn rc = pch->Init(filePath, HEADER_ONLY);
2861 if (rc != INIT_OK) {
2862 delete pch;
2863 wxLogMessage(
2864 wxString::Format(" ...initialization failed for %s", msg_fn.c_str()));
2865 return NULL;
2866 }
2867
2868 ChartTableEntry *ret_val = new ChartTableEntry(*pch, utf8Path);
2869 ret_val->SetValid(true);
2870
2871 delete pch;
2872
2873 return ret_val;
2874}
2875
2876bool ChartDatabase::GetCentroidOfLargestScaleChart(double *clat, double *clon,
2877 ChartFamilyEnum family) {
2878 int cur_max_i = -1;
2879 int cur_max_scale = 0;
2880
2881 int nEntry = active_chartTable.size();
2882
2883 for (int i = 0; i < nEntry; i++) {
2884 auto &cte_fam = GetChartTableEntry(i);
2885 if (GetChartFamily(cte_fam.GetChartType()) == family) {
2886 if (cte_fam.GetScale() > cur_max_scale) {
2887 cur_max_scale = cte_fam.GetScale();
2888 cur_max_i = i;
2889 }
2890 }
2891 }
2892
2893 if (cur_max_i == -1)
2894 return false; // nothing found
2895 else {
2896 auto &cte_sel = GetChartTableEntry(cur_max_i);
2897 *clat = (cte_sel.GetLatMax() + cte_sel.GetLatMin()) / 2.;
2898 *clon = (cte_sel.GetLonMin() + cte_sel.GetLonMax()) / 2.;
2899 }
2900 return true;
2901}
2902
2903//-------------------------------------------------------------------
2904// Get DBChart Projection
2905//-------------------------------------------------------------------
2906int ChartDatabase::GetDBChartProj(int dbIndex) {
2907 if ((bValid) && (dbIndex >= 0) && (dbIndex < (int)active_chartTable.size())) {
2908 auto &cte = GetChartTableEntry(dbIndex);
2909 return cte.GetChartProjectionType();
2910 } else
2911 return PROJECTION_UNKNOWN;
2912}
2913
2914//-------------------------------------------------------------------
2915// Get DBChart Family
2916//-------------------------------------------------------------------
2917int ChartDatabase::GetDBChartFamily(int dbIndex) {
2918 if ((bValid) && (dbIndex >= 0) && (dbIndex < (int)active_chartTable.size())) {
2919 auto &cte = GetChartTableEntry(dbIndex);
2920 return cte.GetChartFamily();
2921 } else
2922 return CHART_FAMILY_UNKNOWN;
2923}
2924
2925//-------------------------------------------------------------------
2926// Get DBChart FullFileName
2927//-------------------------------------------------------------------
2928wxString ChartDatabase::GetDBChartFileName(int dbIndex) {
2929 if ((bValid) && (dbIndex >= 0) && (dbIndex < (int)active_chartTable.size())) {
2930 auto &cte = GetChartTableEntry(dbIndex);
2931 return wxString(cte.GetFullSystemPath());
2932 } else
2933 return "";
2934}
2935
2936//-------------------------------------------------------------------
2937// Get DBChart Type
2938//-------------------------------------------------------------------
2939int ChartDatabase::GetDBChartType(int dbIndex) {
2940 if ((bValid) && (dbIndex >= 0) && (dbIndex < (int)active_chartTable.size())) {
2941 auto &cte = GetChartTableEntry(dbIndex);
2942 return cte.GetChartType();
2943 } else
2944 return 0;
2945}
2946
2947//-------------------------------------------------------------------
2948// Get DBChart Skew
2949//-------------------------------------------------------------------
2950float ChartDatabase::GetDBChartSkew(int dbIndex) {
2951 if ((bValid) && (dbIndex >= 0) && (dbIndex < (int)active_chartTable.size())) {
2952 auto &cte = GetChartTableEntry(dbIndex);
2953 return cte.GetChartSkew();
2954 } else
2955 return 0.;
2956}
2957
2958//-------------------------------------------------------------------
2959// Get DBChart Scale
2960//-------------------------------------------------------------------
2961int ChartDatabase::GetDBChartScale(int dbIndex) {
2962 if ((bValid) && (dbIndex >= 0) && (dbIndex < (int)active_chartTable.size())) {
2963 auto &cte = GetChartTableEntry(dbIndex);
2964 return cte.GetScale();
2965 } else
2966 return 1;
2967}
2968
2969//-------------------------------------------------------------------
2970// Get Lat/Lon Bounding Box from db
2971//-------------------------------------------------------------------
2972bool ChartDatabase::GetDBBoundingBox(int dbIndex, LLBBox &box) {
2973 if ((bValid) && (dbIndex >= 0) && (dbIndex < (int)active_chartTable.size())) {
2974 auto &entry = GetChartTableEntry(dbIndex);
2975 box.Set(entry.GetLatMin(), entry.GetLonMin(), entry.GetLatMax(),
2976 entry.GetLonMax());
2977 }
2978
2979 return true;
2980}
2981
2982const LLBBox &ChartDatabase::GetDBBoundingBox(int dbIndex) {
2983 if ((bValid) && (dbIndex >= 0)) {
2984 auto &entry = GetChartTableEntry(dbIndex);
2985 return entry.GetBBox();
2986 } else {
2987 return m_dummy_bbox;
2988 }
2989}
2990
2991//-------------------------------------------------------------------
2992// Get PlyPoint from Database
2993//-------------------------------------------------------------------
2994int ChartDatabase::GetDBPlyPoint(int dbIndex, int plyindex, float *lat,
2995 float *lon) {
2996 if ((bValid) && (dbIndex >= 0) && (dbIndex < (int)active_chartTable.size())) {
2997 const ChartTableEntry &entry = GetChartTableEntry(dbIndex);
2998 if (entry.GetnPlyEntries()) {
2999 float *fp = entry.GetpPlyTable();
3000 fp += plyindex * 2;
3001 if (lat) *lat = *fp;
3002 fp++;
3003 if (lon) *lon = *fp;
3004 }
3005 return entry.GetnPlyEntries();
3006 } else
3007 return 0;
3008}
3009
3010//-------------------------------------------------------------------
3011// Get AuxPlyPoint from Database
3012//-------------------------------------------------------------------
3013int ChartDatabase::GetDBAuxPlyPoint(int dbIndex, int plyindex, int ply,
3014 float *lat, float *lon) {
3015 if ((bValid) && (dbIndex >= 0) && (dbIndex < (int)active_chartTable.size())) {
3016 const ChartTableEntry &entry = GetChartTableEntry(dbIndex);
3017 if (entry.GetnAuxPlyEntries()) {
3018 float *fp = entry.GetpAuxPlyTableEntry(ply);
3019
3020 fp += plyindex * 2;
3021 if (lat) *lat = *fp;
3022 fp++;
3023 if (lon) *lon = *fp;
3024 }
3025
3026 return entry.GetAuxCntTableEntry(ply);
3027 } else
3028 return 0;
3029}
3030
3031int ChartDatabase::GetnAuxPlyEntries(int dbIndex) {
3032 if ((bValid) && (dbIndex >= 0) && (dbIndex < (int)active_chartTable.size())) {
3033 const ChartTableEntry &entry = GetChartTableEntry(dbIndex);
3034 return entry.GetnAuxPlyEntries();
3035 } else
3036 return 0;
3037}
3038
3039//-------------------------------------------------------------------
3040// Get vector of reduced Plypoints
3041//-------------------------------------------------------------------
3042std::vector<float> ChartDatabase::GetReducedPlyPoints(int dbIndex) {
3043 if ((bValid) && (dbIndex >= 0) && (dbIndex < (int)active_chartTable.size())) {
3044 ChartTableEntry &cte = GetChartTableEntry(dbIndex);
3045 return cte.GetReducedPlyPoints();
3046 }
3047
3048 std::vector<float> dummy;
3049 return dummy;
3050}
3051
3052//-------------------------------------------------------------------
3053// Get vector of reduced AuxPlypoints
3054//-------------------------------------------------------------------
3055std::vector<float> ChartDatabase::GetReducedAuxPlyPoints(int dbIndex,
3056 int iTable) {
3057 if ((bValid) && (dbIndex >= 0) && (dbIndex < (int)active_chartTable.size())) {
3058 auto &cte = GetChartTableEntry(dbIndex);
3059 return cte.GetReducedAuxPlyPoints(iTable);
3060 }
3061
3062 std::vector<float> dummy;
3063 return dummy;
3064}
3065
3066bool ChartDatabase::IsChartAvailable(int dbIndex) {
3067 if ((bValid) && (dbIndex >= 0) && (dbIndex < (int)active_chartTable.size())) {
3068 auto &cte = GetChartTableEntry(dbIndex);
3069
3070 // If not PLugIn chart, assume always available
3071 if (cte.GetChartType() != CHART_TYPE_PLUGIN) return true;
3072
3073 wxString *path = cte.GetpsFullPath();
3074 wxFileName fn(*path);
3075 wxString ext = fn.GetExt();
3076 ext.Prepend("*.");
3077 wxString ext_upper = ext.MakeUpper();
3078 wxString ext_lower = ext.MakeLower();
3079
3080 // Search the array of chart class descriptors to find a match
3081 // between the search mask and the the chart file extension
3082
3083 for (auto &cd : m_ChartClassDescriptorArray) {
3084 if (cd.m_descriptor_type == PLUGIN_DESCRIPTOR) {
3085 wxString search_mask = cd.m_search_mask;
3086
3087 if (search_mask == ext_upper) {
3088 return true;
3089 }
3090 if (search_mask == ext_lower) {
3091 return true;
3092 }
3093 if (path->Matches(search_mask)) {
3094 return true;
3095 }
3096 }
3097 }
3098 }
3099
3100 return false;
3101}
3102
3103void ChartDatabase::ApplyGroupArray(ChartGroupArray *pGroupArray) {
3104 wxString separator(wxFileName::GetPathSeparator());
3105
3106 for (unsigned int ic = 0; ic < active_chartTable.size(); ic++) {
3107 auto &cte = GetChartTableEntry(ic);
3108
3109 cte.ClearGroupArray();
3110
3111 wxString *chart_full_path = cte.GetpsFullPath();
3112
3113 for (unsigned int igroup = 0; igroup < pGroupArray->GetCount(); igroup++) {
3114 ChartGroup *pGroup = pGroupArray->Item(igroup);
3115 for (const auto &elem : pGroup->m_element_array) {
3116 wxString element_root = elem.m_element_name;
3117
3118 // The element may be a full single chart name
3119 // If so, add it
3120 // Otherwise, append a sep character so that similar paths are
3121 // distinguished. See FS#1060
3122 if (!chart_full_path->IsSameAs(element_root))
3123 element_root.Append(
3124 separator); // Prevent comingling similar looking path names
3125 if (chart_full_path->StartsWith(element_root)) {
3126 bool b_add = true;
3127 for (unsigned int k = 0; k < elem.m_missing_name_array.size(); k++) {
3128 const wxString &missing_item = elem.m_missing_name_array[k];
3129 if (chart_full_path->StartsWith(missing_item)) {
3130 if (chart_full_path->IsSameAs(
3131 missing_item)) // missing item is full chart name
3132 {
3133 b_add = false;
3134 break;
3135 } else {
3136 if (wxDir::Exists(missing_item)) // missing item is a dir
3137 {
3138 b_add = false;
3139 break;
3140 }
3141 }
3142 }
3143 }
3144
3145 if (b_add) cte.AddIntToGroupArray(igroup + 1);
3146 }
3147 }
3148 }
3149 }
3150}
General chart base definitions.
ChartDB * ChartData
Global instance.
Definition chartdb.cpp:71
Define threaded chart database classes.
ChartGroupArray * g_pGroupArray
Global instance.
Definition chartdbs.cpp:61
Basic chart info storage.
ChartGroupArray * g_pGroupArray
Global instance.
Definition chartdbs.cpp:61
Base class for all chart types.
Definition chartbase.h:126
Manages a database of charts, including reading, writing, and querying chart information.
Definition chartdbs.h:307
bool Create(ArrayOfCDI &dir_array, wxGenericProgressDialog *pprog)
Creates a new chart database from a list of directories.
bool Update(ArrayOfCDI &dir_array, bool bForce, wxGenericProgressDialog *pprog)
Updates the chart database.
Represents a user-defined collection of logically related charts.
Definition chartdbs.h:500
Wrapper class for plugin-based charts.
Definition chartimg.h:389
void Notify() override
Notify all listeners, no data supplied.
Class for computing hash of arbitrary length.
Definition flex_hash.h:34
EventVar options_on_finalize_chartdbs
Notified when chartdbs async operations complete, to finalize settings.
Definition gui_events.h:74
EventVar on_finalize_chartdbs
Notified when chartdbs async operations complete, to reload charts.
Definition gui_events.h:71
Base class for OpenCPN plugins.
Hash of arbitrary length.
Platform independent GL includes.
Misc GUI event vars, a singleton.
Utility functions.
PlugInManager * g_pi_manager
Global instance.
PlugInManager and helper classes – Mostly gui parts (dialogs) and plugin API stuff.
ShapeBaseChartSet gShapeBasemap
global instance
Shapefile basemap.
Represents an entry in the chart table, containing information about a single chart.
Definition chartdbs.h:190