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 UpdateChartClassDescriptorArray();
1081}
1082
1083void ChartDatabase::OnDBSProgressUpdate(wxCommandEvent &evt) {
1084 int value = evt.GetInt(); // retrieve progress value
1085 if (m_pprog) {
1086 // Update dialog safely
1087 m_pprog->Update(value);
1088 }
1089}
1090
1091static int in_event;
1092void ChartDatabase::OnEvtThread(OCPN_ChartTableEntryThreadEvent &event) {
1093 if (in_event) int yyp = 4;
1094
1095 in_event++;
1096 // Capture the completed job tickets
1097 auto ticket = event.GetTicket();
1098 if (!ticket) {
1099 in_event--;
1100 return;
1101 }
1102
1103 // Update progress dialog, if present
1104 if (1 /*ticket->b_thread_safe*/) {
1105 if (m_pprog && (m_jobsRemaining > 1)) {
1106 m_progcount++;
1107 double ratio = 100. * (double)m_progcount / m_ticketcount;
1108 int val = ratio;
1109 if (((m_progcount % m_nFileProgressQuantum) == 0)) {
1110 if (val != m_progint) {
1111 m_progint = val;
1112 // printf("%d %d\n", m_progcount, val);
1113#ifdef x__WXMSW__
1114 // On Windows, Update may pump messages even without
1115 // CAN_ABORT/ELAPSED_TIME
1116 wxEventLoopBase *loop = wxEventLoopBase::GetActive();
1117 if (loop) {
1118 // Temporarily deactivate the active loop to prevent re-entrancy
1119 wxEventLoopActivator noLoop(nullptr);
1120 m_pprog->Update(val);
1121 }
1122#else
1123 m_pprog->Update(val);
1124#endif
1125 }
1126 }
1127 }
1128 }
1129
1130 if (!ticket->m_ticket_type) { // TICKET_TYPE_NORMAL
1131 bool collision_found = false;
1132 if (ticket->b_thread_safe) {
1133 wxFileName fn(ticket->m_ChartPath);
1134 ChartCollisionsHashMap::iterator it;
1135 for (it = m_full_collision_map.begin(); it != m_full_collision_map.end();
1136 ++it) {
1137 if (it->first.IsSameAs(fn.GetFullName())) {
1138 // Two files found with identical file name
1139 // For now, just drop this ticket
1140 // TODO Make an (expensive) test on file modification times
1141 collision_found = true;
1142 break;
1143 }
1144 }
1145 if (!collision_found) {
1146 m_full_collision_map[fn.GetFullName()] = 1;
1147 }
1148 // Consider TODO #1 here: Looking for more duolicates acress directories
1149 }
1150
1151 m_ticket_vector.push_back(ticket);
1152 }
1153
1154 int remaining = --m_jobsRemaining;
1155
1156 if (remaining == 0) {
1157 m_pool.Shutdown();
1158 m_pool_deferred.Shutdown();
1159 size_t a = m_ticket_vector.size();
1160
1161 if (m_deferred_ticket_vector.size()) {
1162 // Process the deferred charts in a single thread pool
1163 // load the thread pool from the prepared array
1164 // Enqueue jobs
1165 for (auto &ticket_d : m_deferred_ticket_vector) {
1166 m_pool_deferred.Push(ticket_d);
1167 m_jobsRemaining++;
1168 }
1169 m_deferred_ticket_vector.clear();
1170
1171 // Initialize progress dialog
1172 m_progcount = 0;
1173 m_progint = 0;
1174 m_ticketcount = m_jobsRemaining;
1175 m_nFileProgressQuantum = 1; // wxMax(m_ticketcount / 10, 2);
1176 if (m_pprog) m_pprog->Update(0, _("Processing charts."));
1177
1178 // Start up the queued thread, if necessary
1179 if (m_jobsRemaining) {
1180 const int workerCount = 1;
1181 if (m_pool_deferred.GetWorkerCount() < workerCount) {
1182 int threads_needed = workerCount - m_pool_deferred.GetWorkerCount();
1183 for (int i = 0; i < threads_needed; ++i) {
1184 (new PoolWorkerThread(m_pool_deferred, this))->Run();
1185 m_pool_deferred.AddWorker();
1186 }
1187 }
1188 }
1189 in_event--;
1190 return; // Let the thread run
1191 }
1192
1193 // Now m_ticket_vector is populated with verified tickets
1194 // for all specified directories.
1195
1196 // Add the CTEs from the tickets to the active table
1197 // NB: The active_chartTable was cleared by the Update() method
1198 // before this point
1199
1200 for (auto &ticket_valid : m_ticket_vector) {
1201 if (ticket_valid->m_chart_table_entry)
1202 active_chartTable.push_back(ticket_valid->m_chart_table_entry);
1203 }
1204 size_t c = m_ticket_vector.size();
1205 size_t d = active_chartTable.size();
1206
1207 // Release references to tickets
1208 m_ticket_vector.clear();
1209
1210 FinalizeChartUpdate();
1211 in_event--;
1212 } else
1213 in_event--;
1214}
1215
1216void ChartDatabase::FinalizeChartUpdate() {
1217 // Scrub CTE list, remove any invalid entries,
1218 // as tagged by directory removal
1219 active_chartTable.erase(
1220 std::remove_if(active_chartTable.begin(), active_chartTable.end(),
1221 [](const auto &cte) { return !cte->GetbValid(); }),
1222 active_chartTable.end());
1223
1224 size_t d = active_chartTable.size();
1225
1226 // And once more, setting the Entry index field
1227 active_chartTable_pathindex.clear();
1228 int i = 0;
1229 for (auto cte : active_chartTable) {
1230 active_chartTable_pathindex[cte->GetFullSystemPath()] = i;
1231 cte->SetEntryOffset(i);
1232 i++;
1233 }
1234
1235 m_nentries = active_chartTable.size();
1236 bValid = true;
1237 SetBusy(false);
1238 ChartData->SetBusy(false);
1239
1240 // Finalize the dB on disk
1241 ChartData->SaveBinary(ChartListFileName);
1242 wxLogMessage("Finished chart database Update");
1243 wxLogMessage(" ");
1244
1245 if (m_pprog) m_pprog->Destroy();
1246 m_pprog = nullptr;
1247
1248 // The Update() function may set gWorldMapLocation if at least one of the
1249 // directories contains GSHHS files. Make sure GSHHS is still accessible
1250 if (gWorldMapLocation.empty()) { // Last resort. User might have deleted all
1251 // GSHHG data, but we still might have the
1252 // default dataset distributed with OpenCPN
1253 // or from the package repository...
1254 gWorldMapLocation = gDefaultWorldMapLocation;
1255 m_gshhg_chart_loc = wxEmptyString;
1256 }
1257
1258 // Update canvas and "Crossesland" machinery
1259 if (gWorldMapLocation != m_gshhg_chart_loc) {
1260 // ..For each canvas...
1261 // TODO Move this where?
1262 // for (unsigned int i = 0; i < g_canvasArray.GetCount(); i++) {
1263 // ChartCanvas *cc = g_canvasArray.Item(i);
1264 // if (cc) cc->ResetWorldBackgroundChart();
1265 // }
1266
1267 // Reset the GSHHS singleton which is used to detect land crossing.
1268 gshhsCrossesLandReset();
1269 }
1270
1271 // Purge all charts from cache, and delete.
1272 ChartData->PurgeCache();
1273
1274 // Signal Options dialog that update is finished
1275 GuiEvents::GetInstance().options_on_finalize_chartdbs.Notify();
1276
1277 // Signal a full chart reload
1278 GuiEvents::GetInstance().on_finalize_chartdbs.Notify();
1279}
1280
1281bool ChartDatabase::ScrubGroupArray() {
1282 // For each group,
1283 // make sure that each group element (dir or chart) references at least
1284 // oneitem in the database. If not, remove the element.
1285
1286 bool b_change = false;
1287 unsigned int igroup = 0;
1288 while (igroup < g_pGroupArray->GetCount()) {
1289 bool b_chart_in_element = false;
1290 ChartGroup *pGroup = g_pGroupArray->Item(igroup);
1291
1292 for (unsigned int j = 0; j < pGroup->m_element_array.size(); j++) {
1293 const wxString &element_root = pGroup->m_element_array[j].m_element_name;
1294
1295 for (unsigned int ic = 0;
1296 ic < (unsigned int)ChartData->GetChartTableEntries(); ic++) {
1297 auto &cte = ChartData->GetChartTableEntry(ic);
1298 wxString chart_full_path = cte.GetFullSystemPath();
1299
1300 if (chart_full_path.StartsWith(element_root)) {
1301 b_chart_in_element = true;
1302 break;
1303 }
1304 }
1305
1306 // Explicit check to avoid removing a group containing only GSHHS
1307 if (!b_chart_in_element) {
1308 wxString test_string = "GSHH";
1309 if (element_root.Upper().Contains(test_string))
1310 b_chart_in_element = true;
1311 }
1312
1313 if (!b_chart_in_element) // delete the element
1314 {
1315 pGroup->m_element_array.erase(pGroup->m_element_array.begin() + j);
1316 j--;
1317 b_change = true;
1318 }
1319 }
1320
1321 igroup++; // next group
1322 }
1323
1324 return b_change;
1325}
1326
1327void ChartDatabase::UpdateChartClassDescriptorArray() {
1328 if (m_ChartClassDescriptorArray.empty()) {
1329 m_ChartClassDescriptorArray.push_back(
1330 ChartClassDescriptor("ChartKAP", "*.kap", nullptr, BUILTIN_DESCRIPTOR));
1331 m_ChartClassDescriptorArray.push_back(
1332 ChartClassDescriptor("ChartGEO", "*.geo", nullptr, BUILTIN_DESCRIPTOR));
1333 m_ChartClassDescriptorArray.push_back(
1334 ChartClassDescriptor("s57chart", "*.000", nullptr, BUILTIN_DESCRIPTOR));
1335 m_ChartClassDescriptorArray.push_back(
1336 ChartClassDescriptor("s57chart", "*.s57", nullptr, BUILTIN_DESCRIPTOR));
1337 m_ChartClassDescriptorArray.push_back(ChartClassDescriptor(
1338 "cm93compchart", "00300000.a", nullptr, BUILTIN_DESCRIPTOR));
1339 m_ChartClassDescriptorArray.push_back(ChartClassDescriptor(
1340 "ChartMbTiles", "*.mbtiles", nullptr, BUILTIN_DESCRIPTOR));
1341 }
1342 // If the PlugIn Manager exists, get the array of dynamically loadable
1343 // chart class names
1344 if (g_pi_manager) {
1345 m_ChartClassDescriptorArray.erase(
1346 std::remove_if(m_ChartClassDescriptorArray.begin(),
1347 m_ChartClassDescriptorArray.end(),
1348 [](const ChartClassDescriptor &cd) {
1349 return cd.m_descriptor_type == PLUGIN_DESCRIPTOR;
1350 }),
1351 m_ChartClassDescriptorArray.end());
1352
1353 wxArrayString array = g_pi_manager->GetPlugInChartClassNameArray();
1354 for (unsigned int j = 0; j < array.GetCount(); j++) {
1355 // Instantiate a blank chart to retrieve the directory search mask for
1356 // this chart type
1357 wxString class_name = array[j];
1358 ChartPlugInWrapper *cpiw = new ChartPlugInWrapper(class_name);
1359 if (cpiw) {
1360 wxString mask = cpiw->GetFileSearchMask();
1361
1362 // Get the plugin (ptr) that provides this chart class
1363 auto plugin_t = g_pi_manager->GetProvidingPlugin(class_name);
1364 opencpn_plugin *plugin = dynamic_cast<opencpn_plugin *>(plugin_t);
1365 // Create a new descriptor and add it to the database
1366 m_ChartClassDescriptorArray.push_back(
1367 ChartClassDescriptor(class_name, mask, plugin, PLUGIN_DESCRIPTOR));
1368 delete cpiw;
1369 }
1370 }
1371 }
1372}
1373
1374ChartTableEntry &ChartDatabase::GetChartTableEntry(int index) {
1375 if (index < GetChartTableEntries())
1376 return *active_chartTable[index];
1377 else
1378 return m_ChartTableEntryDummy;
1379}
1380
1381bool ChartDatabase::CompareChartDirArray(ArrayOfCDI &test_array) {
1382 // Compare the parameter "test_array" with this.m_dir_array
1383 // Return true if functionally identical (order does not signify).
1384
1385 if (test_array.GetCount() != m_dir_array.GetCount()) return false;
1386
1387 bool bfound_inner;
1388 unsigned int nfound_outer = 0;
1389
1390 for (unsigned int i = 0; i < test_array.GetCount(); i++) {
1391 ChartDirInfo p = test_array[i];
1392 bfound_inner = false;
1393 for (unsigned int j = 0; j < m_dir_array.GetCount(); j++) {
1394 ChartDirInfo q = m_dir_array[j];
1395
1396 if (p.fullpath.IsSameAs(q.fullpath)) {
1397 bfound_inner = true;
1398 break;
1399 }
1400 }
1401 if (bfound_inner) nfound_outer++;
1402 }
1403
1404 return (nfound_outer == test_array.GetCount());
1405}
1406
1407wxString ChartDatabase::GetMagicNumberCached(wxString dir) {
1408 for (unsigned int j = 0; j < m_dir_array.GetCount(); j++) {
1409 ChartDirInfo q = m_dir_array[j];
1410 if (dir.IsSameAs(q.fullpath)) return q.magic_number;
1411 }
1412
1413 return "";
1414}
1415
1416bool ChartDatabase::Read(const wxString &filePath) {
1417 ChartTableEntry entry;
1418 int entries;
1419
1420 bValid = false;
1421
1422 wxFileName file(filePath);
1423 if (!file.FileExists()) return false;
1424
1425 m_DBFileName = filePath;
1426
1427 wxFFileInputStream ifs(filePath);
1428 if (!ifs.Ok()) return false;
1429
1430 ChartTableHeader cth;
1431 cth.Read(ifs);
1432 if (!cth.CheckValid()) return false;
1433
1434 // Capture the version number
1435 char vbo[5];
1436 memcpy(vbo, cth.GetDBVersionString(), 4);
1437 vbo[4] = 0;
1438 m_dbversion = atoi(&vbo[1]);
1439 s_dbVersion = m_dbversion; // save the static copy
1440
1441 wxLogVerbose("Chartdb:Reading %d directory entries, %d table entries",
1442 cth.GetDirEntries(), cth.GetTableEntries());
1443 wxLogMessage("Chartdb: Chart directory list follows");
1444 if (0 == cth.GetDirEntries()) wxLogMessage(" Nil");
1445
1446 int ind = 0;
1447 for (int iDir = 0; iDir < cth.GetDirEntries(); iDir++) {
1448 wxString dir;
1449 int dirlen;
1450 ifs.Read(&dirlen, sizeof(int));
1451 while (dirlen > 0) {
1452 char dirbuf[1024];
1453 int alen = dirlen > 1023 ? 1023 : dirlen;
1454 if (ifs.Read(&dirbuf, alen).Eof()) goto read_error;
1455 dirbuf[alen] = 0;
1456 dirlen -= alen;
1457 dir.Append(wxString(dirbuf, wxConvUTF8));
1458 }
1459 wxString msg;
1460 msg.Printf(" Chart directory #%d: ", iDir);
1461 msg.Append(dir);
1462 wxLogMessage(msg);
1463 m_chartDirs.Add(dir);
1464 }
1465
1466 entries = cth.GetTableEntries();
1467 // active_chartTable.Alloc(entries);
1468 active_chartTable_pathindex.clear();
1469 while (entries-- && entry.Read(this, ifs)) {
1470 active_chartTable_pathindex[entry.GetFullSystemPath()] = ind++;
1471 auto sharedPtr = std::make_shared<ChartTableEntry>(entry);
1472 active_chartTable.push_back(sharedPtr);
1473 }
1474
1475 entry.Clear();
1476 bValid = true;
1477 entry.SetAvailable(true);
1478
1479 m_nentries = active_chartTable.size();
1480 return true;
1481
1482read_error:
1483 bValid = false;
1484 m_nentries = active_chartTable.size();
1485 return false;
1486}
1487
1489
1490bool ChartDatabase::Write(const wxString &filePath) {
1491 wxFileName file(filePath);
1492 wxFileName dir(
1493 file.GetPath(wxPATH_GET_SEPARATOR | wxPATH_GET_VOLUME, wxPATH_NATIVE));
1494
1495 if (!dir.DirExists() && !dir.Mkdir()) return false;
1496
1497 wxFFileOutputStream ofs(filePath);
1498 if (!ofs.Ok()) return false;
1499
1500 ChartTableHeader cth(m_chartDirs.GetCount(), active_chartTable.size());
1501 cth.Write(ofs);
1502
1503 for (int iDir = 0; iDir < cth.GetDirEntries(); iDir++) {
1504 wxString dir1 = m_chartDirs[iDir];
1505 int dirlen = dir1.length();
1506 char s[200];
1507 strncpy(s, dir1.mb_str(wxConvUTF8), 199);
1508 s[199] = 0;
1509 dirlen = strlen(s);
1510 ofs.Write(&dirlen, sizeof(int));
1511 // ofs.Write(dir.fn_str(), dirlen);
1512 ofs.Write(s, dirlen);
1513 }
1514
1515 for (UINT32 iTable = 0; iTable < active_chartTable.size(); iTable++) {
1516 auto &cte = GetChartTableEntry(iTable);
1517 cte.Write(this, ofs);
1518 }
1519
1520 // Explicitly set the version
1521 m_dbversion = DB_VERSION_CURRENT;
1522
1523 return true;
1524}
1525
1527wxString SplitPath(wxString s, wxString tkd, int nchar, int offset,
1528 int *pn_split) {
1529 wxString r;
1530 int ncr = 0;
1531
1532 int rlen = offset;
1533 wxStringTokenizer tkz(s, tkd);
1534 while (tkz.HasMoreTokens()) {
1535 wxString token = tkz.GetNextToken();
1536 if ((rlen + (int)token.Len() + 1) < nchar) {
1537 r += token;
1538 r += tkd[0];
1539 rlen += token.Len() + 1;
1540 } else {
1541 r += "\n";
1542 ncr++;
1543 for (int i = 0; i < offset; i++) {
1544 r += " ";
1545 }
1546 r += token;
1547 r += tkd[0];
1548 rlen = offset + token.Len() + 1;
1549 }
1550 }
1551
1552 if (pn_split) *pn_split = ncr;
1553
1554 return r.Mid(0, r.Len() - 1); // strip the last separator char
1555}
1556
1557wxString ChartDatabase::GetFullChartInfo(ChartBase *pc, int dbIndex,
1558 int *char_width, int *line_count) {
1559 wxString r;
1560 int lc = 0;
1561 unsigned int max_width = 0;
1562 int ncr;
1563 unsigned int target_width = 60;
1564
1565 const ChartTableEntry &cte = GetChartTableEntry(dbIndex);
1566 wxString line;
1567 line.Empty();
1568 if (pc) {
1569 line = _(" Name: ");
1570 wxString longline = pc->GetName();
1571
1572 wxString tkz;
1573 if (longline.Find(' ') != wxNOT_FOUND) // assume a proper name
1574 tkz = " ";
1575 else
1576 tkz = "/,\\"; // else a file name
1577
1578 if (longline.Len() > target_width) {
1579 line += SplitPath(pc->GetName(), tkz, target_width, 12, &ncr);
1580 max_width = wxMax(max_width, target_width + 4);
1581 lc += ncr;
1582 } else {
1583 line += longline;
1584 max_width = wxMax(max_width, line.Len() + 4);
1585 }
1586 }
1587
1588 line += "\n";
1589 r += line;
1590 lc++;
1591
1592 if (pc) // chart is loaded and available
1593 line.Printf(" %s: 1:%d", _("Scale"), pc->GetNativeScale());
1594 else
1595 line.Printf(" %s: 1:%d", _("Scale"), cte.GetScale());
1596
1597 line += "\n";
1598 max_width = wxMax(max_width, line.Len());
1599 r += line;
1600 lc++;
1601 if (pc) {
1602 wxDateTime ed = pc->GetEditionDate();
1603 if (ed.IsValid()) {
1604 line = _(" Updated: ") + ed.FormatISODate() + "\n";
1605 max_width = wxMax(max_width, line.Len());
1606 r += line;
1607 }
1608 lc++;
1609
1610 line = _(" Source Edition: ") + pc->GetSE() + "\n";
1611 max_width = wxMax(max_width, line.Len());
1612 r += line;
1613 lc++;
1614 }
1615
1616 if (pc) {
1617 line = _(" Depth Units: ") + pc->GetDepthUnits() + "\n";
1618 max_width = wxMax(max_width, line.Len());
1619 r += line;
1620 lc++;
1621
1622 line = _(" Soundings: ") + pc->GetSoundingsDatum() + "\n";
1623 max_width = wxMax(max_width, line.Len());
1624 r += line;
1625 lc++;
1626
1627 line = _(" Datum: ") + pc->GetDatumString() + "\n";
1628 max_width = wxMax(max_width, line.Len());
1629 r += line;
1630 lc++;
1631 }
1632
1633 line = _(" Projection: ");
1634 if (PROJECTION_UNKNOWN == cte.GetChartProjectionType())
1635 line += _("Unknown");
1636 else if (PROJECTION_MERCATOR == cte.GetChartProjectionType())
1637 line += _("Mercator");
1638 else if (PROJECTION_TRANSVERSE_MERCATOR == cte.GetChartProjectionType())
1639 line += _("Transverse Mercator");
1640 else if (PROJECTION_POLYCONIC == cte.GetChartProjectionType())
1641 line += _("Polyconic");
1642 else if (PROJECTION_WEB_MERCATOR == cte.GetChartProjectionType())
1643 line += _("Web Mercator (EPSG:3857)");
1644 line += "\n";
1645 max_width = wxMax(max_width, line.Len());
1646 r += line;
1647 lc++;
1648
1649 line.Empty();
1650 if (pc) {
1651 }
1652
1653 line.Empty();
1654 if (pc && pc->GetExtraInfo().Len()) {
1655 line += pc->GetExtraInfo();
1656 line += "\n";
1657 max_width = wxMax(max_width, line.Len());
1658 r += line;
1659 lc++;
1660 }
1661 if (pc) {
1662 line.Empty();
1663 line = _(" ID: ");
1664 line += pc->GetID();
1665 line += "\n";
1666 max_width = wxMax(max_width, line.Len());
1667 r += line;
1668 lc++;
1669 }
1670
1671 line = _(" ChartFile: ");
1672 wxString longline = *(cte.GetpsFullPath());
1673 if (longline.Len() > target_width) {
1674 line += SplitPath(longline, "/,\\", target_width, 15, &ncr);
1675 max_width = wxMax(max_width, target_width + 4);
1676 lc += ncr;
1677 } else {
1678 line += longline;
1679 max_width = wxMax(max_width, line.Len() + 4);
1680 }
1681 r += line;
1682 r += "\n";
1683 lc++;
1684
1685 if (line_count) *line_count = lc;
1686
1687 if (char_width) *char_width = max_width;
1688
1689 return r;
1690}
1691
1692// ----------------------------------------------------------------------------
1693// Create Chart Table Database by directory search
1694// resulting in valid pChartTable in (this)
1695// ----------------------------------------------------------------------------
1696bool ChartDatabase::Create(ArrayOfCDI &dir_array,
1697 wxGenericProgressDialog *pprog) {
1698 m_dir_array = dir_array;
1699
1700 bValid = false;
1701
1702 m_chartDirs.Clear();
1703 active_chartTable.clear();
1704 active_chartTable_pathindex.clear();
1705
1706 Update(dir_array, true, pprog); // force the update the reload everything
1707
1708 bValid = true;
1709
1710 // Explicitly set the version
1711 m_dbversion = DB_VERSION_CURRENT;
1712
1713 return true;
1714}
1715
1716/*
1717 * Traverse a directory recursively and find the GSHHG directory
1718 * that contains GSHHG data files.
1719 */
1720class GshhsTraverser : public wxDirTraverser {
1721public:
1722 GshhsTraverser() {}
1723 virtual wxDirTraverseResult OnFile(const wxString &filename) override {
1724 wxFileName fn(filename);
1725 wxFileName dir(fn.GetPath());
1726 if (fn.GetFullName().Matches("poly-*-1.dat") &&
1727 dir.GetFullName().IsSameAs("GSHHG", false)) {
1728 parent_dir = fn.GetPath(wxPATH_GET_VOLUME | wxPATH_GET_SEPARATOR);
1729 return wxDIR_STOP;
1730 }
1731 return wxDIR_CONTINUE;
1732 }
1733 virtual wxDirTraverseResult OnDir(const wxString &dirname) override {
1734 // Always recurse into directories.
1735 return wxDIR_CONTINUE;
1736 }
1737 wxString GetGshhsDir() const { return parent_dir; }
1738
1739private:
1740 wxString parent_dir;
1741};
1742
1743/*
1744 * Find and return the full path a of directory containing GSHHG data files.
1745 * Search recursively starting from directory.
1746 */
1747wxString findGshhgDirectory(const wxString &directory) {
1748 wxDir dir(directory);
1749 if (!dir.IsOpened()) {
1750 return wxEmptyString;
1751 }
1752 GshhsTraverser traverser;
1753 dir.Traverse(traverser, wxEmptyString, wxDIR_FILES | wxDIR_DIRS);
1754 return traverser.GetGshhsDir();
1755}
1756
1757bool ChartDatabase::UpdateChartDatabaseInplace(ArrayOfCDI &DirArray,
1758 bool b_force,
1759 wxGenericProgressDialog *_prog) {
1760 // AbstractPlatform::ShowBusySpinner();
1761
1762 m_pprog = _prog;
1763
1764 wxLogMessage(" ");
1765 wxLogMessage("Starting chart database Update...");
1766
1767 // The Update() function may set gWorldMapLocation if at least one of the
1768 // directories contains GSHHS files. Save current situation...
1769 m_gshhg_chart_loc = gWorldMapLocation;
1770 gWorldMapLocation = wxEmptyString;
1771
1772 Update(DirArray, b_force, m_pprog);
1773
1774 // AbstractPlatform::HideBusySpinner();
1775 return true;
1776}
1777
1778// ----------------------------------------------------------------------------
1779// Update existing ChartTable Database by directory search
1780// resulting in valid pChartTable in (this)
1781// ----------------------------------------------------------------------------
1782bool ChartDatabase::Update(ArrayOfCDI &dir_array, bool bForce,
1783 wxGenericProgressDialog *pprog) {
1784 m_pprog = pprog;
1785 m_ticket_vector.clear();
1786 m_full_collision_map.clear();
1787 m_jobsRemaining = 0;
1788 m_deferred_ticket_vector.clear();
1789 SetChartDirArray(dir_array);
1790
1791 bValid = false; // database is not useable right now...
1792 SetBusy(true);
1793 ChartData->SetBusy(true);
1794
1795 // Mark all charts provisionally invalid
1796 for (unsigned int i = 0; i < active_chartTable.size(); i++) {
1797 auto &cte = GetChartTableEntry(i);
1798 cte.SetValid(false);
1799 }
1800
1801 m_chartDirs.Clear();
1802
1803 if (bForce) active_chartTable.clear();
1804
1805 bool lbForce = bForce;
1806
1807 // Do a dB Version upgrade if the current one is obsolete
1808 if (s_dbVersion != DB_VERSION_CURRENT) {
1809 active_chartTable.clear();
1810 lbForce = true;
1811 s_dbVersion = DB_VERSION_CURRENT; // Update the static indicator
1812 m_dbversion = DB_VERSION_CURRENT; // and the member
1813 }
1814
1815 // Get the new charts
1816
1817 for (unsigned int j = 0; j < dir_array.GetCount(); j++) {
1818 ChartDirInfo dir_info = dir_array[j];
1819
1820 // On Android, with SDK >= 30, traversal of a folder that is
1821 // on within the "scoped storage" domain is very slow.
1822 // Aviod it....
1823#ifdef __ANDROID__
1824 if (!androidIsDirWritable(dir_info.fullpath)) continue;
1825#endif
1826
1827 wxString dir_magic;
1828 // Recursively search for a directory that contains GSHHG files starting
1829 // from dir_info.
1830 wxString gshhg_dir = findGshhgDirectory(dir_info.fullpath);
1831 if (!gshhg_dir.empty()) {
1832 // If some polygons exist in the directory, set it as the one to use for
1833 // GSHHG
1834 // TODO: We should probably compare the version and maybe resolutions
1835 // available with what is currently used...
1836 wxLogMessage("Updating GSHHG directory: %s", gshhg_dir.c_str());
1837 gWorldMapLocation = gshhg_dir;
1838 }
1839 if (dir_info.fullpath.Find("OSMSHP") != wxNOT_FOUND) {
1840 if (!wxDir::FindFirst(dir_info.fullpath, "basemap_*.shp").empty()) {
1841 gWorldShapefileLocation =
1842 dir_info.fullpath + wxFileName::GetPathSeparator();
1843 gShapeBasemap.Reset();
1844 }
1845 }
1846
1847 TraverseDirAndAddCharts(dir_info, pprog, dir_magic, lbForce);
1848
1849 // Update the dir_list entry, even if the magic values are the same
1850 dir_info.magic_number = dir_magic;
1851 dir_array.RemoveAt(j);
1852 dir_array.Insert(dir_info, j);
1853
1854 m_chartDirs.Add(dir_info.fullpath);
1855 } // for
1856
1857 // Special case, if chart dir list is truly empty
1858 if (m_chartDirs.IsEmpty() || !m_jobsRemaining) {
1859 if (!m_deferred_ticket_vector.size()) {
1860 FinalizeChartUpdate();
1861 return true;
1862 } else {
1863 auto *evt =
1864 new OCPN_ChartTableEntryThreadEvent(wxEVT_OCPN_CHARTTABLEENTRYTHREAD);
1865 auto ticket_deferred = m_deferred_ticket_vector.back();
1866 ticket_deferred->m_ticket_type = 1; // Mark as a dummy ticket.;
1867 // to trigger an event
1868 m_jobsRemaining = 1;
1869 evt->SetTicket(ticket_deferred);
1870 wxQueueEvent(this, evt);
1871 }
1872 }
1873
1874 // Initialize progress dialog
1875 m_progcount = 0;
1876 m_progint = 0;
1877 m_ticketcount = m_jobsRemaining;
1878 m_nFileProgressQuantum = wxMax(m_ticketcount / 10, 2);
1879 if (pprog) pprog->Update(0, _("Processing charts."));
1880
1881 // Start up the queued threads, if necessary
1882 if (m_jobsRemaining) {
1883 const int workerCount = 4;
1884 if (m_pool.GetWorkerCount() < workerCount) {
1885 int threads_needed = workerCount - m_pool.GetWorkerCount();
1886 for (int i = 0; i < threads_needed; ++i) {
1887 (new PoolWorkerThread(m_pool, this))->Run();
1888 m_pool.AddWorker();
1889 }
1890 }
1891 }
1892
1893 return true;
1894}
1895
1896//-------------------------------------------------------------------
1897// Find Chart dbIndex
1898//-------------------------------------------------------------------
1899
1900int ChartDatabase::FinddbIndex(wxString PathToFind) {
1901 if (active_chartTable_pathindex.find(PathToFind) !=
1902 active_chartTable_pathindex.end())
1903 return active_chartTable_pathindex[PathToFind];
1904
1905 return -1;
1906}
1907
1908//-------------------------------------------------------------------
1909// Disable Chart
1910//-------------------------------------------------------------------
1911
1912int ChartDatabase::DisableChart(wxString &PathToDisable) {
1913 int index = FinddbIndex(PathToDisable);
1914 if (index != -1) {
1915 auto &entry = GetChartTableEntry(index);
1916 entry.Disable();
1917 return 1;
1918 }
1919 return 0;
1920}
1921
1922// ----------------------------------------------------------------------------
1923// Traverse the given directory looking for charts
1924// If bupdate is true, also search the existing database for a name match.
1925// If target chart is already in database, mark the entry valid and skip
1926// additional processing
1927// ----------------------------------------------------------------------------
1928
1929int ChartDatabase::TraverseDirAndAddCharts(ChartDirInfo &dir_info,
1930 wxGenericProgressDialog *pprog,
1931 wxString &dir_magic, bool bForce) {
1932 // Extract the true dir name and magic number from the compound string
1933 wxString dir_path = dir_info.fullpath;
1934#ifdef __ANDROID__
1935 dir_path = wxString(dir_info.fullpath.mb_str(wxConvUTF8));
1936#endif
1937
1938 wxString old_magic = dir_info.magic_number;
1939 wxString new_magic = old_magic;
1940 dir_magic = old_magic; // provisionally the same
1941
1942 int nAdd = 0;
1943
1944 bool b_skipDetectDirChange = false;
1945 bool b_dirchange = false;
1946
1947 // Does this directory actually exist?
1948 if (!wxDir::Exists(dir_path)) return 0;
1949
1950 // Check to see if this is a cm93 directory root
1951 // If so, skip the DetectDirChange since it may be very slow
1952 // and give no information
1953 // Assume a change has happened, and process accordingly
1954 bool b_cm93 = Check_CM93_Structure(dir_path);
1955 if (b_cm93) {
1956 b_skipDetectDirChange = true;
1957 b_dirchange = true;
1958 }
1959
1960 // Quick scan the directory to see if it has changed
1961 // If not, there is no need to scan again.....
1962 if (!b_skipDetectDirChange)
1963 b_dirchange = DetectDirChange(dir_path, dir_info.fullpath, old_magic,
1964 new_magic, pprog);
1965
1966 if (!bForce && !b_dirchange) {
1967 wxString msg(" No change detected on directory ");
1968 msg.Append(dir_path);
1969 wxLogMessage(msg);
1970
1971 // Traverse the database, and mark as valid all charts coming from this
1972 // dir, or anywhere in its tree
1973
1974 wxFileName fn_dir(dir_path, "stuff");
1975 unsigned int dir_path_count = fn_dir.GetDirCount();
1976
1977 if (pprog) pprog->SetTitle(_("OpenCPN Chart Scan...."));
1978
1979 int nEntries = active_chartTable.size();
1980
1981 for (int ic = 0; ic < nEntries; ic++) {
1982 auto &cte = GetChartTableEntry(ic);
1983 wxFileName fn(cte.GetFullSystemPath());
1984
1985 while (fn.GetDirCount() >= dir_path_count) {
1986 if (fn.GetPath() == dir_path) {
1987 auto &cte_a = GetChartTableEntry(ic);
1988 cte_a.SetValid(true);
1989 // if(pprog)
1990 // pprog->Update((ic * 100)
1991 // /nEntries, fn.GetFullPath());
1992
1993 break;
1994 }
1995 fn.RemoveLastDir();
1996 }
1997 }
1998
1999 return 0;
2000 }
2001
2002 // There presumably was a change in the directory contents. Return the new
2003 // magic number
2004 dir_magic = new_magic;
2005
2006 // Look for all possible defined chart classes
2007 for (auto &cd : m_ChartClassDescriptorArray) {
2008 nAdd += SearchDirAndAddCharts(dir_info.fullpath, cd, pprog);
2009 }
2010
2011 return nAdd;
2012}
2013
2014bool ChartDatabase::DetectDirChange(const wxString &dir_path,
2015 const wxString &prog_label,
2016 const wxString &magic, wxString &new_magic,
2017 wxGenericProgressDialog *pprog) {
2018 if (pprog) pprog->SetTitle(_("OpenCPN Directory Scan...."));
2019
2020 // parse the magic number
2021 long long unsigned int nmagic;
2022 wxULongLong nacc = 0;
2023
2024 magic.ToULongLong(&nmagic, 10);
2025
2026 // Get an arraystring of all files
2027 wxArrayString FileList;
2028 wxDir dir(dir_path);
2029 int n_files = dir.GetAllFiles(dir_path, &FileList);
2030 FileList.Sort(); // Ensure persistent order of items being hashed.
2031
2032 FlexHash hash(sizeof nacc);
2033 hash.Reset();
2034
2035 if (pprog) pprog->Update(0, prog_label);
2036
2037 // Traverse the list of files, getting their interesting stuff to add to
2038 // accumulator
2039 for (int ifile = 0; ifile < n_files; ifile++) {
2040 wxFileName file(FileList[ifile]);
2041
2042 // NOTE. Do not ever try to optimize this code by combining `wxString`
2043 // calls. Otherwise `fileNameUTF8` will point to a stale buffer overwritten
2044 // by garbage.
2045 wxString fileNameNative = file.GetFullPath();
2046 wxScopedCharBuffer fileNameUTF8 = fileNameNative.ToUTF8();
2047 hash.Update(fileNameUTF8.data(), fileNameUTF8.length());
2048
2049 // File Size;
2050 wxULongLong size = file.GetSize();
2051 wxULongLong fileSize = ((size != wxInvalidSize) ? size : 0);
2052 hash.Update(&fileSize, (sizeof fileSize));
2053
2054 // Mod time, in ticks
2055 wxDateTime t = file.GetModificationTime();
2056 wxULongLong fileTime = t.GetTicks();
2057 hash.Update(&fileTime, (sizeof fileTime));
2058 }
2059
2060 hash.Finish();
2061 hash.Receive(&nacc);
2062
2063 // Return the calculated magic number
2064 new_magic = nacc.ToString();
2065
2066 // And do the test
2067 if (new_magic != magic)
2068 return true;
2069 else
2070 return false;
2071}
2072
2073bool ChartDatabase::IsChartDirUsed(const wxString &theDir) {
2074 wxString dir(theDir);
2075 if (dir.Last() == '/' || dir.Last() == wxFileName::GetPathSeparator())
2076 dir.RemoveLast();
2077
2078 dir.Append("*");
2079 for (UINT32 i = 0; i < active_chartTable.size(); i++) {
2080 auto &cte_u = GetChartTableEntry(i);
2081 if (cte_u.GetpsFullPath()->Matches(dir)) return true;
2082 }
2083 return false;
2084}
2085
2086//-----------------------------------------------------------------------------
2087// Validate a given directory as a cm93 root database
2088// If it appears to be a cm93 database, then return true
2089//-----------------------------------------------------------------------------
2090bool ChartDatabase::Check_CM93_Structure(wxString dir_name) {
2091 wxString filespec;
2092
2093 wxRegEx test("[0-9]+");
2094
2095 wxDir dirt(dir_name);
2096 wxString candidate;
2097
2098 if (dirt.IsOpened())
2099 wxLogMessage("check_cm93 opened dir OK: " + dir_name);
2100 else {
2101 wxLogMessage("check_cm93 NOT OPENED OK: " + dir_name);
2102 wxLogMessage("check_cm93 returns false." + dir_name);
2103 return false;
2104 }
2105
2106 bool b_maybe_found_cm93 = false;
2107 bool b_cont = dirt.GetFirst(&candidate);
2108
2109 while (b_cont) {
2110 if (test.Matches(candidate) && (candidate.Len() == 8)) {
2111 b_maybe_found_cm93 = true;
2112 break;
2113 }
2114
2115 b_cont = dirt.GetNext(&candidate);
2116 }
2117
2118 if (b_maybe_found_cm93) {
2119 wxString dir_next = dir_name;
2120 dir_next += "/";
2121 dir_next += candidate;
2122 if (wxDir::Exists(dir_next)) {
2123 wxDir dir_n(dir_next);
2124 if (dirt.IsOpened()) {
2125 wxString candidate_n;
2126
2127 wxRegEx test_n("^[A-Ga-g]");
2128 bool b_probably_found_cm93 = false;
2129 bool b_cont_n = dir_n.IsOpened() && dir_n.GetFirst(&candidate_n);
2130 while (b_cont_n) {
2131 if (test_n.Matches(candidate_n) && (candidate_n.Len() == 1)) {
2132 b_probably_found_cm93 = true;
2133 break;
2134 }
2135 b_cont_n = dir_n.GetNext(&candidate_n);
2136 }
2137
2138 if (b_probably_found_cm93) // found a directory that looks
2139 // like {dir_name}/12345678/A
2140 // probably cm93
2141 {
2142 // make sure the dir exists
2143 wxString dir_luk = dir_next;
2144 dir_luk += "/";
2145 dir_luk += candidate_n;
2146 if (wxDir::Exists(dir_luk)) return true;
2147 }
2148 }
2149 }
2150 }
2151
2152 return false;
2153}
2154
2155/*
2156//-----------------------------------------------------------------------------
2157// Validate a given directory as a cm93 root database
2158// If it appears to be a cm93 database, then return the name of an existing cell
2159file
2160// File name will be unique with respect to member element m_cm93_filename_array
2161// If not cm93, return empty string
2162//-----------------------------------------------------------------------------
2163wxString ChartDatabase::Get_CM93_FileName(wxString dir_name)
2164{
2165 wxString filespec;
2166
2167 wxRegEx test("[0-9]+");
2168
2169 wxDir dirt(dir_name);
2170 wxString candidate;
2171
2172 bool b_maybe_found_cm93 = false;
2173 bool b_cont = dirt.GetFirst(&candidate);
2174
2175 while(b_cont)
2176 {
2177 if(test.Matches(candidate)&& (candidate.Len() == 8))
2178 {
2179 b_maybe_found_cm93 = true;
2180 break;
2181 }
2182
2183 b_cont = dirt.GetNext(&candidate);
2184
2185 }
2186
2187 if(b_maybe_found_cm93)
2188 {
2189 wxString dir_next = dir_name;
2190 dir_next += "/";
2191 dir_next += candidate;
2192 if(wxDir::Exists(dir_next))
2193 {
2194 wxDir dir_n(dir_next);
2195 wxString candidate_n;
2196
2197 wxRegEx test_n("^[A-Ga-g]");
2198 bool b_probably_found_cm93 = false;
2199 bool b_cont_n = dir_n.GetFirst(&candidate_n);
2200 while(b_cont_n)
2201 {
2202 if(test_n.Matches(candidate_n) && (candidate_n.Len() ==
22031))
2204 {
2205 b_probably_found_cm93 = true;
2206 break;
2207 }
2208 b_cont_n = dir_n.GetNext(&candidate_n);
2209 }
2210
2211 if(b_probably_found_cm93) // found a directory that
2212looks like {dir_name}/12345678/A probably cm93 { // and we want to try and
2213shorten the recursive search
2214 // make sure the dir exists
2215 wxString dir_luk = dir_next;
2216 dir_luk += "/";
2217 dir_luk += candidate_n;
2218 if(wxDir::Exists(dir_luk))
2219 {
2220 wxString msg("Found probable CM93 database in
2221"); msg += dir_name; wxLogMessage(msg);
2222
2223 wxString dir_name_plus = dir_luk; // be very
2224specific about the dir_name,
2225
2226 wxDir dir_get(dir_name_plus);
2227 wxString one_file;
2228 dir_get.GetFirst(&one_file);
2229
2230 // We must return a unique file name, i.e. one
2231that has not bee seen
2232 // before in this invocation of chart dir
2233scans. bool find_unique = false; while(!find_unique)
2234 {
2235 find_unique = true;
2236 for(unsigned int ifile=0; ifile <
2237m_cm93_filename_array.GetCount(); ifile++)
2238 {
2239 if(m_cm93_filename_array[ifile] ==
2240one_file) find_unique = false;
2241 }
2242 if(!find_unique)
2243 dir_get.GetNext(&one_file);
2244 }
2245
2246 m_cm93_filename_array.Add(one_file);
2247
2248 filespec = one_file;
2249 }
2250
2251 }
2252 }
2253 }
2254
2255 return filespec;
2256}
2257*/
2258
2259int ChartDatabase::SearchDirAndAddCharts(wxString &dir_name_base,
2260 ChartClassDescriptor &chart_desc,
2261 wxGenericProgressDialog *pprog) {
2262 wxString msg("Searching directory: ");
2263 msg += dir_name_base;
2264 msg += " for ";
2265 msg += chart_desc.m_search_mask;
2266 wxLogMessage(msg);
2267
2268 wxString dir_name = dir_name_base;
2269
2270#ifdef __ANDROID__
2271 dir_name = wxString(dir_name_base.mb_str(wxConvUTF8)); // android
2272#endif
2273
2274 if (!wxDir::Exists(dir_name)) return 0;
2275
2276 wxString filespec = chart_desc.m_search_mask.Upper();
2277 wxString lowerFileSpec = chart_desc.m_search_mask.Lower();
2278 wxString filespecXZ = filespec + ".xz";
2279 wxString lowerFileSpecXZ = lowerFileSpec + ".xz";
2280 wxString filename;
2281
2282 // Count the files
2283 wxArrayString FileList;
2284 int gaf_flags = wxDIR_DEFAULT; // as default, recurse into subdirs
2285
2286 // Here is an optimization for MSW/cm93 especially
2287 // If this directory seems to be a cm93, and we are not explicitely looking
2288 // for cm93, then abort Otherwise, we will be looking thru entire cm93 tree
2289 // for non-existent .KAP files, etc.
2290
2291 bool b_found_cm93 = false;
2292 bool b_cm93 = Check_CM93_Structure(dir_name);
2293 if (b_cm93) {
2294 if (filespec != "00300000.A")
2295 return false;
2296 else {
2297 filespec = dir_name;
2298 b_found_cm93 = true;
2299 }
2300 }
2301
2302 if (!b_found_cm93) {
2303 wxDir dir(dir_name);
2304 dir.GetAllFiles(dir_name, &FileList, filespec, gaf_flags);
2305
2306#ifdef __ANDROID__
2307 if (!FileList.GetCount()) {
2308 wxArrayString afl = androidTraverseDir(dir_name, filespec);
2309 for (wxArrayString::const_iterator item = afl.begin(); item != afl.end();
2310 item++)
2311 FileList.Add(*item);
2312 }
2313#endif
2314
2315#ifndef __WXMSW__
2316 if (filespec != lowerFileSpec) {
2317 // add lowercase filespec files too
2318 wxArrayString lowerFileList;
2319 dir.GetAllFiles(dir_name, &lowerFileList, lowerFileSpec, gaf_flags);
2320
2321#ifdef __ANDROID__
2322 if (!lowerFileList.GetCount()) {
2323 wxArrayString afl = androidTraverseDir(dir_name, lowerFileSpec);
2324 for (wxArrayString::const_iterator item = afl.begin();
2325 item != afl.end(); item++)
2326 lowerFileList.Add(*item);
2327 }
2328#endif
2329
2330 for (wxArrayString::const_iterator item = lowerFileList.begin();
2331 item != lowerFileList.end(); item++)
2332 FileList.Add(*item);
2333 }
2334#endif
2335
2336#ifdef OCPN_USE_LZMA
2337 // add xz compressed files;
2338 dir.GetAllFiles(dir_name, &FileList, filespecXZ, gaf_flags);
2339 dir.GetAllFiles(dir_name, &FileList, lowerFileSpecXZ, gaf_flags);
2340#endif
2341
2342 FileList.Sort(); // Sorted processing order makes the progress bar more
2343 // meaningful to the user.
2344 } else { // This is a cm93 dataset, specified as yada/yada/cm93
2345 wxString dir_plus = dir_name;
2346 dir_plus += wxFileName::GetPathSeparator();
2347 FileList.Add(dir_plus);
2348 }
2349
2350 int nFile = FileList.GetCount();
2351
2352 if (!nFile) return false;
2353
2354 int nDirEntry = 0;
2355
2356 // Check to see if there are any charts in the DB which refer to this
2357 // directory If none at all, there is no need to scan the DB for fullpath
2358 // match of each potential addition and bthis_dir_in_dB is false.
2359 // bool bthis_dir_in_dB = IsChartDirUsed(dir_name);
2360
2361 if (pprog) pprog->SetTitle(_("OpenCPN Chart Add...."));
2362
2363 // build a hash table based on filename (without directory prefix) of
2364 // the chart to fast detect identical charts
2365 ChartCollisionsHashMap collision_map;
2366 // int nEntry = active_chartTable.GetCount();
2367 // for (int i = 0; i < nEntry; i++) {
2368 // wxString table_file_name = active_chartTable[i].GetFullSystemPath();
2369 // wxFileName table_file(table_file_name);
2370 // collision_map[table_file.GetFullName()] = i;
2371 // }
2372
2373 // Capture a vector of pending thread tickets for this directory
2374 std::vector<std::shared_ptr<ChartTableEntryJobTicket>> ticket_vector;
2375
2376 for (int ifile = 0; ifile < nFile; ifile++) {
2377 wxFileName file(FileList[ifile]);
2378 wxString full_path = file.GetFullPath();
2379 wxString file_name = file.GetFullName();
2380 wxString utf8_path = full_path;
2381
2382#ifdef __ANDROID__
2383 // The full path (full_name) is the broken Android files system
2384 // interpretation, which does not display well onscreen. So, here we
2385 // reconstruct a full path spec in UTF-8 encoding for later use in string
2386 // displays. This utf-8 string will be used to construct the chart database
2387 // entry if required.
2388 wxFileName fnbase(dir_name_base);
2389 int nDirs = fnbase.GetDirCount();
2390
2391 wxFileName file_target(FileList[ifile]);
2392
2393 for (int i = 0; i < nDirs + 1;
2394 i++) // strip off the erroneous intial directories
2395 file_target.RemoveDir(0);
2396
2397 wxString leftover_path = file_target.GetFullPath();
2398 utf8_path =
2399 dir_name_base + leftover_path; // reconstruct a fully utf-8 version
2400#endif
2401
2402 // Validate the file name again, considering MSW's semi-random treatment
2403 // of case....
2404 // TODO...something fishy here - may need to normalize saved name?
2405 if (!file_name.Matches(lowerFileSpec) && !file_name.Matches(filespec) &&
2406 !file_name.Matches(lowerFileSpecXZ) && !file_name.Matches(filespecXZ) &&
2407 !b_found_cm93) {
2408 // wxLogMessage("FileSpec test failed for:" + file_name);
2409 continue;
2410 }
2411
2412 ChartTableEntry *pnewChart = NULL;
2413 bool bAddFinal = true;
2414 int b_add_msg = 0;
2415
2416#if 0 // TODO Fix?
2417 // Check the collisions map looking for duplicates in directories already
2418 // processed, and choosing the right one.
2419// ChartCollisionsHashMap::const_iterator collision_ptr =
2420// collision_map.find(file_name);
2421// bool collision = (collision_ptr != collision_map.end());
2422// bool file_path_is_same = false;
2423// bool file_time_is_same = false;
2424// ChartTableEntry *pEntry = NULL;
2425// wxString table_file_name;
2426
2427
2428 // Allow multiple cm93 chart sets #4217
2429 if (b_found_cm93) collision = false;
2430
2431 if (collision) {
2432 pEntry = &active_chartTable[collision_ptr->second];
2433 table_file_name = pEntry->GetFullSystemPath();
2434 file_path_is_same =
2435 bthis_dir_in_dB && full_name.IsSameAs(table_file_name);
2436
2437 // If the chart full file paths are exactly the same, select the newer
2438 // one.
2439 if (file_path_is_same) {
2440 b_add_msg++;
2441
2442 // Check the file modification time
2443 time_t t_oldFile = pEntry->GetFileTime();
2444 time_t t_newFile = file.GetModificationTime().GetTicks();
2445
2446 if (t_newFile <= t_oldFile) {
2447 file_time_is_same = true;
2448 bAddFinal = false;
2449 pEntry->SetValid(true);
2450 } else {
2451 bAddFinal = true;
2452 pEntry->SetValid(false);
2453 }
2454 }
2455 }
2456#endif
2457
2458 // Check for duplicates within this directory
2459 bool collision_found = false;
2460 ChartCollisionsHashMap::iterator it;
2461 for (it = collision_map.begin(); it != collision_map.end(); ++it) {
2462 if (it->first.IsSameAs(file_name)) {
2463 // Two files found with identical file name
2464 // For now, just drop this ticket
2465 // TODO Make an (expensive) test on file modification times
2466 collision_found = true;
2467 break;
2468 }
2469 }
2470
2471 if (!collision_found) {
2472 // Create a ticket for this chart
2473 auto ticket = std::make_shared<ChartTableEntryJobTicket>();
2474 ticket->m_ChartPath = full_path;
2475 ticket->m_ChartPathUTF8 = full_path;
2476 ticket->chart_desc = chart_desc;
2477
2478 ticket_vector.push_back(ticket);
2479 collision_map[file_name] = ifile;
2480 }
2481
2482 } // the big loop
2483
2484 // Built-in chart types are all thread-safe
2485 // Check plugin charts
2486 bool is_kap = false; // chart_desc.m_class_name.IsSameAs("ChartKAP");
2487 if (chart_desc.m_descriptor_type == PLUGIN_DESCRIPTOR || is_kap) {
2488 // Check plugin charts API. API >- 118 are known to be thread-safe
2489 opencpn_plugin *plugin = chart_desc.m_plugin;
2490 opencpn_plugin_118 *provider_plugin118 = dynamic_cast<opencpn_plugin_118 *>(
2491 dynamic_cast<opencpn_plugin *>(plugin));
2492
2493 if (!provider_plugin118 || is_kap) {
2494 // old plugin, charts not thread-safe
2495 // So arrange to process the tickets in the main app thread,
2496 // during the event handler, at the end of the queue processing
2497 for (auto &ticket : ticket_vector) {
2498 ticket->b_thread_safe = false;
2499 ticket->m_provider_type = 1;
2500 ticket->provider_class_name = chart_desc.m_class_name;
2501 m_deferred_ticket_vector.push_back(ticket);
2502 }
2503 return nDirEntry;
2504 }
2505 }
2506
2507 // Chart directory is known thread-safe
2508 // load the thread pool from the prepared array
2509 // Enqueue jobs
2510 for (auto &ticket : ticket_vector) {
2511 m_pool.Push(ticket);
2512 m_jobsRemaining++;
2513 }
2514
2515 // Tickets queued, wait for completion events
2516 return nDirEntry;
2517}
2518
2519bool ChartDatabase::AddChart(wxString &chartfilename,
2520 ChartClassDescriptor &chart_desc,
2521 wxGenericProgressDialog *pprog, int isearch,
2522 bool bthis_dir_in_dB) {
2523 bool rv = false;
2524 wxFileName file(chartfilename);
2525 wxString full_name = file.GetFullPath();
2526 wxString file_name = file.GetFullName();
2527
2528 // Validate the file name again, considering MSW's semi-random treatment of
2529 // case....
2530 // TODO...something fishy here - may need to normalize saved name?
2531 // if(!file_name.Matches(lowerFileSpec) && !file_name.Matches(filespec) &&
2532 // !b_found_cm93)
2533 // continue;
2534
2535 if (pprog)
2536 pprog->Update(wxMin((m_pdifile * 100) / m_pdnFile, 100), full_name);
2537
2538 ChartTableEntry *pnewChart = NULL;
2539 bool bAddFinal = true;
2540 int b_add_msg = 0;
2541 wxString msg_fn(full_name);
2542 msg_fn.Replace("%", "%%");
2543
2544 pnewChart = CreateChartTableEntry(full_name, full_name, chart_desc);
2545 if (!pnewChart) {
2546 bAddFinal = false;
2547 wxLogMessage(wxString::Format(
2548 " CreateChartTableEntry() failed for file: %s", msg_fn.c_str()));
2549 return false;
2550 } else // traverse the existing database looking for duplicates, and choosing
2551 // the right one
2552 {
2553 int nEntry = active_chartTable.size();
2554 for (int i = 0; i < nEntry; i++) {
2555 auto &cte_a = GetChartTableEntry(i);
2556 wxString *ptable_file_name = cte_a.GetpsFullPath();
2557
2558 // If the chart full file paths are exactly the same, select the newer
2559 // one
2560 if (bthis_dir_in_dB && full_name.IsSameAs(*ptable_file_name)) {
2561 b_add_msg++;
2562
2563 // Check the file modification time
2564 auto &cte_search = GetChartTableEntry(isearch);
2565 time_t t_oldFile = cte_search.GetFileTime();
2566 time_t t_newFile = file.GetModificationTime().GetTicks();
2567
2568 if (t_newFile <= t_oldFile) {
2569 bAddFinal = false;
2570 cte_search.SetValid(true);
2571 } else {
2572 bAddFinal = true;
2573 cte_search.SetValid(false);
2574 wxLogMessage(
2575 wxString::Format(" Replacing older chart file of same path: %s",
2576 msg_fn.c_str()));
2577 }
2578
2579 break;
2580 }
2581
2582 // Look at the chart file name (without directory prefix) for a further
2583 // check for duplicates This catches the case in which the "same" chart
2584 // is in different locations, and one may be newer than the other.
2585 wxFileName table_file(*ptable_file_name);
2586
2587 if (table_file.GetFullName() == file_name) {
2588 b_add_msg++;
2589
2590 // TODO fix this...
2591#if 0
2592 if (pnewChart->IsEarlierThan(active_chartTable[isearch])) {
2593 // Make sure the compare file actually exists
2594 if (table_file.IsFileReadable()) {
2595 active_chartTable[isearch].SetValid(true);
2596 bAddFinal = false;
2597 wxLogMessage(wxString::Format(
2598 " Retaining newer chart file of same name: %s",
2599 msg_fn.c_str()));
2600 }
2601 } else if (pnewChart->IsEqualTo(active_chartTable[isearch])) {
2602 // The file names (without dir prefix) are identical,
2603 // and the mod times are identical
2604 // Prsume that this is intentional, in order to facilitate
2605 // having the same chart in multiple groups.
2606 // So, add this chart.
2607 bAddFinal = true;
2608 }
2609
2610 else {
2611 active_chartTable[isearch].SetValid(false);
2612 bAddFinal = true;
2613 wxLogMessage(
2614 wxString::Format(" Replacing older chart file of same name: %s",
2615 msg_fn.c_str()));
2616 }
2617#endif
2618 break;
2619 }
2620
2621 // TODO Look at the chart ID as a further check against duplicates
2622
2623 isearch++;
2624 if (nEntry == isearch) isearch = 0;
2625 } // for
2626 }
2627
2628 if (bAddFinal) {
2629 if (0 == b_add_msg) {
2630 wxLogMessage(
2631 wxString::Format(" Adding chart file: %s", msg_fn.c_str()));
2632 }
2633 std::shared_ptr<ChartTableEntry> sharedPtr(pnewChart);
2634 active_chartTable.push_back(sharedPtr);
2635 rv = true;
2636 } else {
2637 delete pnewChart;
2638 // wxLogMessage(wxString::Format(" Not adding chart
2639 // file: %s", msg_fn.c_str()));
2640 rv = false;
2641 }
2642
2643 m_nentries = active_chartTable.size();
2644
2645 return rv;
2646}
2647
2648bool ChartDatabase::AddSingleChart(wxString &ChartFullPath,
2649 bool b_force_full_search) {
2650 // Find a relevant chart class descriptor
2651 wxFileName fn(ChartFullPath);
2652 wxString ext = fn.GetExt();
2653 ext.Prepend("*.");
2654 wxString ext_upper = ext.MakeUpper();
2655 wxString ext_lower = ext.MakeLower();
2656 wxString dir_name = fn.GetPath();
2657
2658 // Search the array of chart class descriptors to find a match
2659 // between the search mask and the chart file extension
2660
2662 for (auto &cd : m_ChartClassDescriptorArray) {
2663 if (cd.m_descriptor_type == PLUGIN_DESCRIPTOR) {
2664 if (cd.m_search_mask == ext_upper) {
2665 desc = cd;
2666 break;
2667 }
2668 if (cd.m_search_mask == ext_lower) {
2669 desc = cd;
2670 break;
2671 }
2672 }
2673 }
2674
2675 // If we know that we need to do a full recursive search of the db,
2676 // then there is no need to verify it by doing a directory match
2677 bool b_recurse = true;
2678 if (!b_force_full_search) b_recurse = IsChartDirUsed(dir_name);
2679
2680 bool rv = AddChart(ChartFullPath, desc, NULL, 0, b_recurse);
2681
2682 // remove duplicates marked in AddChart()
2683
2684 for (unsigned int i = 0; i < active_chartTable.size(); i++) {
2685 auto &cte_r = GetChartTableEntry(i);
2686 if (!cte_r.GetbValid()) {
2687 // TODO fix this
2688 // active_chartTable.RemoveAt(i);
2689 i--; // entry is gone, recheck this index for next entry
2690 }
2691 }
2692
2693 // Update the Entry index fields
2694 for (unsigned int i = 0; i < active_chartTable.size(); i++) {
2695 auto &cte_ef = GetChartTableEntry(i);
2696 cte_ef.SetEntryOffset(i);
2697 }
2698
2699 // Get a new magic number
2700 wxString new_magic;
2701 DetectDirChange(dir_name, "", "", new_magic, 0);
2702
2703 // Update (clone) the CDI array
2704 bool bcfound = false;
2705 ArrayOfCDI NewChartDirArray;
2706
2707 ArrayOfCDI ChartDirArray = GetChartDirArray();
2708 for (unsigned int i = 0; i < ChartDirArray.GetCount(); i++) {
2709 ChartDirInfo cdi = ChartDirArray[i];
2710
2711 ChartDirInfo newcdi = cdi;
2712
2713 // If entry is found that matches this cell, clear the magic number.
2714 if (newcdi.fullpath == dir_name) {
2715 newcdi.magic_number = new_magic;
2716 bcfound = true;
2717 }
2718
2719 NewChartDirArray.Add(newcdi);
2720 }
2721
2722 if (!bcfound) {
2723 ChartDirInfo cdi;
2724 cdi.fullpath = dir_name;
2725 cdi.magic_number = new_magic;
2726 NewChartDirArray.Add(cdi);
2727 }
2728
2729 // Update the database master copy of the CDI array
2730 SetChartDirArray(NewChartDirArray);
2731
2732 // Update the list of chart dirs.
2733 m_chartDirs.Clear();
2734
2735 for (unsigned int i = 0; i < GetChartDirArray().GetCount(); i++) {
2736 ChartDirInfo cdi = GetChartDirArray()[i];
2737 m_chartDirs.Add(cdi.fullpath);
2738 }
2739
2740 m_nentries = active_chartTable.size();
2741
2742 ChartData->UpdateChartDatabaseInplace(NewChartDirArray, false, nullptr);
2743 return rv;
2744}
2745
2746bool ChartDatabase::RemoveSingleChart(wxString &ChartFullPath) {
2747 bool rv = false;
2748
2749 // Walk the chart table, looking for the target
2750 for (unsigned int i = 0; i < active_chartTable.size(); i++) {
2751 auto &cte = GetChartTableEntry(i);
2752 if (ChartFullPath.IsSameAs(cte.GetFullSystemPath())) {
2753 // Fast remove element, order not preserved
2754 std::swap(active_chartTable[i], active_chartTable.back());
2755 active_chartTable.pop_back();
2756 break;
2757 }
2758 }
2759
2760 // Update the EntryOffset fields for the array
2761 for (unsigned int i = 0; i < active_chartTable.size(); i++) {
2762 auto &pcte = GetChartTableEntry(i);
2763 pcte.SetEntryOffset(i);
2764 }
2765
2766 // Check and update the dir array
2767 wxFileName fn(ChartFullPath);
2768 wxString fd = fn.GetPath();
2769 if (!IsChartDirUsed(fd)) {
2770 // Clone a new array, removing the unused directory,
2771 ArrayOfCDI NewChartDirArray;
2772
2773 ArrayOfCDI ChartDirArray = GetChartDirArray();
2774 for (unsigned int i = 0; i < ChartDirArray.GetCount(); i++) {
2775 ChartDirInfo cdi = ChartDirArray[i];
2776
2777 ChartDirInfo newcdi = cdi;
2778
2779 if (newcdi.fullpath != fd) NewChartDirArray.Add(newcdi);
2780 }
2781
2782 SetChartDirArray(NewChartDirArray);
2783 }
2784
2785 // Update the list of chart dirs.
2786 m_chartDirs.Clear();
2787 for (unsigned int i = 0; i < GetChartDirArray().GetCount(); i++) {
2788 ChartDirInfo cdi = GetChartDirArray()[i];
2789 m_chartDirs.Add(cdi.fullpath);
2790 }
2791
2792 m_nentries = active_chartTable.size();
2793 ChartData->UpdateChartDatabaseInplace(m_dir_array, false, nullptr);
2794
2795 return rv;
2796}
2797
2799// Create a Chart object
2801
2802ChartBase *ChartDatabase::GetChart(const wxChar *theFilePath,
2803 ChartClassDescriptor &chart_desc) const {
2804 // TODO: support non-UI chart factory
2805 return NULL;
2806}
2807
2809// Create Chart Table entry by reading chart header info, etc.
2811
2812ChartTableEntry *ChartDatabase::CreateChartTableEntry(
2813 const wxString &filePath, wxString &utf8Path,
2814 ChartClassDescriptor &chart_desc) {
2815 wxString msg_fn(filePath);
2816 msg_fn.Replace("%", "%%");
2817 wxLogMessage(wxString::Format("Loading chart data for %s", msg_fn.c_str()));
2818
2819 ChartBase *pch = GetChart(filePath, chart_desc);
2820 if (pch == NULL) {
2821 wxLogMessage(
2822 wxString::Format(" ...creation failed for %s", msg_fn.c_str()));
2823 return NULL;
2824 }
2825
2826 InitReturn rc = pch->Init(filePath, HEADER_ONLY);
2827 if (rc != INIT_OK) {
2828 delete pch;
2829 wxLogMessage(
2830 wxString::Format(" ...initialization failed for %s", msg_fn.c_str()));
2831 return NULL;
2832 }
2833
2834 ChartTableEntry *ret_val = new ChartTableEntry(*pch, utf8Path);
2835 ret_val->SetValid(true);
2836
2837 delete pch;
2838
2839 return ret_val;
2840}
2841
2842bool ChartDatabase::GetCentroidOfLargestScaleChart(double *clat, double *clon,
2843 ChartFamilyEnum family) {
2844 int cur_max_i = -1;
2845 int cur_max_scale = 0;
2846
2847 int nEntry = active_chartTable.size();
2848
2849 for (int i = 0; i < nEntry; i++) {
2850 auto &cte_fam = GetChartTableEntry(i);
2851 if (GetChartFamily(cte_fam.GetChartType()) == family) {
2852 if (cte_fam.GetScale() > cur_max_scale) {
2853 cur_max_scale = cte_fam.GetScale();
2854 cur_max_i = i;
2855 }
2856 }
2857 }
2858
2859 if (cur_max_i == -1)
2860 return false; // nothing found
2861 else {
2862 auto &cte_sel = GetChartTableEntry(cur_max_i);
2863 *clat = (cte_sel.GetLatMax() + cte_sel.GetLatMin()) / 2.;
2864 *clon = (cte_sel.GetLonMin() + cte_sel.GetLonMax()) / 2.;
2865 }
2866 return true;
2867}
2868
2869//-------------------------------------------------------------------
2870// Get DBChart Projection
2871//-------------------------------------------------------------------
2872int ChartDatabase::GetDBChartProj(int dbIndex) {
2873 if ((bValid) && (dbIndex >= 0) && (dbIndex < (int)active_chartTable.size())) {
2874 auto &cte = GetChartTableEntry(dbIndex);
2875 return cte.GetChartProjectionType();
2876 } else
2877 return PROJECTION_UNKNOWN;
2878}
2879
2880//-------------------------------------------------------------------
2881// Get DBChart Family
2882//-------------------------------------------------------------------
2883int ChartDatabase::GetDBChartFamily(int dbIndex) {
2884 if ((bValid) && (dbIndex >= 0) && (dbIndex < (int)active_chartTable.size())) {
2885 auto &cte = GetChartTableEntry(dbIndex);
2886 return cte.GetChartFamily();
2887 } else
2888 return CHART_FAMILY_UNKNOWN;
2889}
2890
2891//-------------------------------------------------------------------
2892// Get DBChart FullFileName
2893//-------------------------------------------------------------------
2894wxString ChartDatabase::GetDBChartFileName(int dbIndex) {
2895 if ((bValid) && (dbIndex >= 0) && (dbIndex < (int)active_chartTable.size())) {
2896 auto &cte = GetChartTableEntry(dbIndex);
2897 return wxString(cte.GetFullSystemPath());
2898 } else
2899 return "";
2900}
2901
2902//-------------------------------------------------------------------
2903// Get DBChart Type
2904//-------------------------------------------------------------------
2905int ChartDatabase::GetDBChartType(int dbIndex) {
2906 if ((bValid) && (dbIndex >= 0) && (dbIndex < (int)active_chartTable.size())) {
2907 auto &cte = GetChartTableEntry(dbIndex);
2908 return cte.GetChartType();
2909 } else
2910 return 0;
2911}
2912
2913//-------------------------------------------------------------------
2914// Get DBChart Skew
2915//-------------------------------------------------------------------
2916float ChartDatabase::GetDBChartSkew(int dbIndex) {
2917 if ((bValid) && (dbIndex >= 0) && (dbIndex < (int)active_chartTable.size())) {
2918 auto &cte = GetChartTableEntry(dbIndex);
2919 return cte.GetChartSkew();
2920 } else
2921 return 0.;
2922}
2923
2924//-------------------------------------------------------------------
2925// Get DBChart Scale
2926//-------------------------------------------------------------------
2927int ChartDatabase::GetDBChartScale(int dbIndex) {
2928 if ((bValid) && (dbIndex >= 0) && (dbIndex < (int)active_chartTable.size())) {
2929 auto &cte = GetChartTableEntry(dbIndex);
2930 return cte.GetScale();
2931 } else
2932 return 1;
2933}
2934
2935//-------------------------------------------------------------------
2936// Get Lat/Lon Bounding Box from db
2937//-------------------------------------------------------------------
2938bool ChartDatabase::GetDBBoundingBox(int dbIndex, LLBBox &box) {
2939 if ((bValid) && (dbIndex >= 0) && (dbIndex < (int)active_chartTable.size())) {
2940 auto &entry = GetChartTableEntry(dbIndex);
2941 box.Set(entry.GetLatMin(), entry.GetLonMin(), entry.GetLatMax(),
2942 entry.GetLonMax());
2943 }
2944
2945 return true;
2946}
2947
2948const LLBBox &ChartDatabase::GetDBBoundingBox(int dbIndex) {
2949 if ((bValid) && (dbIndex >= 0)) {
2950 auto &entry = GetChartTableEntry(dbIndex);
2951 return entry.GetBBox();
2952 } else {
2953 return m_dummy_bbox;
2954 }
2955}
2956
2957//-------------------------------------------------------------------
2958// Get PlyPoint from Database
2959//-------------------------------------------------------------------
2960int ChartDatabase::GetDBPlyPoint(int dbIndex, int plyindex, float *lat,
2961 float *lon) {
2962 if ((bValid) && (dbIndex >= 0) && (dbIndex < (int)active_chartTable.size())) {
2963 const ChartTableEntry &entry = GetChartTableEntry(dbIndex);
2964 if (entry.GetnPlyEntries()) {
2965 float *fp = entry.GetpPlyTable();
2966 fp += plyindex * 2;
2967 if (lat) *lat = *fp;
2968 fp++;
2969 if (lon) *lon = *fp;
2970 }
2971 return entry.GetnPlyEntries();
2972 } else
2973 return 0;
2974}
2975
2976//-------------------------------------------------------------------
2977// Get AuxPlyPoint from Database
2978//-------------------------------------------------------------------
2979int ChartDatabase::GetDBAuxPlyPoint(int dbIndex, int plyindex, int ply,
2980 float *lat, float *lon) {
2981 if ((bValid) && (dbIndex >= 0) && (dbIndex < (int)active_chartTable.size())) {
2982 const ChartTableEntry &entry = GetChartTableEntry(dbIndex);
2983 if (entry.GetnAuxPlyEntries()) {
2984 float *fp = entry.GetpAuxPlyTableEntry(ply);
2985
2986 fp += plyindex * 2;
2987 if (lat) *lat = *fp;
2988 fp++;
2989 if (lon) *lon = *fp;
2990 }
2991
2992 return entry.GetAuxCntTableEntry(ply);
2993 } else
2994 return 0;
2995}
2996
2997int ChartDatabase::GetnAuxPlyEntries(int dbIndex) {
2998 if ((bValid) && (dbIndex >= 0) && (dbIndex < (int)active_chartTable.size())) {
2999 const ChartTableEntry &entry = GetChartTableEntry(dbIndex);
3000 return entry.GetnAuxPlyEntries();
3001 } else
3002 return 0;
3003}
3004
3005//-------------------------------------------------------------------
3006// Get vector of reduced Plypoints
3007//-------------------------------------------------------------------
3008std::vector<float> ChartDatabase::GetReducedPlyPoints(int dbIndex) {
3009 if ((bValid) && (dbIndex >= 0) && (dbIndex < (int)active_chartTable.size())) {
3010 ChartTableEntry &cte = GetChartTableEntry(dbIndex);
3011 return cte.GetReducedPlyPoints();
3012 }
3013
3014 std::vector<float> dummy;
3015 return dummy;
3016}
3017
3018//-------------------------------------------------------------------
3019// Get vector of reduced AuxPlypoints
3020//-------------------------------------------------------------------
3021std::vector<float> ChartDatabase::GetReducedAuxPlyPoints(int dbIndex,
3022 int iTable) {
3023 if ((bValid) && (dbIndex >= 0) && (dbIndex < (int)active_chartTable.size())) {
3024 auto &cte = GetChartTableEntry(dbIndex);
3025 return cte.GetReducedAuxPlyPoints(iTable);
3026 }
3027
3028 std::vector<float> dummy;
3029 return dummy;
3030}
3031
3032bool ChartDatabase::IsChartAvailable(int dbIndex) {
3033 if ((bValid) && (dbIndex >= 0) && (dbIndex < (int)active_chartTable.size())) {
3034 auto &cte = GetChartTableEntry(dbIndex);
3035
3036 // If not PLugIn chart, assume always available
3037 if (cte.GetChartType() != CHART_TYPE_PLUGIN) return true;
3038
3039 wxString *path = cte.GetpsFullPath();
3040 wxFileName fn(*path);
3041 wxString ext = fn.GetExt();
3042 ext.Prepend("*.");
3043 wxString ext_upper = ext.MakeUpper();
3044 wxString ext_lower = ext.MakeLower();
3045
3046 // Search the array of chart class descriptors to find a match
3047 // between the search mask and the the chart file extension
3048
3049 for (auto &cd : m_ChartClassDescriptorArray) {
3050 if (cd.m_descriptor_type == PLUGIN_DESCRIPTOR) {
3051 wxString search_mask = cd.m_search_mask;
3052
3053 if (search_mask == ext_upper) {
3054 return true;
3055 }
3056 if (search_mask == ext_lower) {
3057 return true;
3058 }
3059 if (path->Matches(search_mask)) {
3060 return true;
3061 }
3062 }
3063 }
3064 }
3065
3066 return false;
3067}
3068
3069void ChartDatabase::ApplyGroupArray(ChartGroupArray *pGroupArray) {
3070 wxString separator(wxFileName::GetPathSeparator());
3071
3072 for (unsigned int ic = 0; ic < active_chartTable.size(); ic++) {
3073 auto &cte = GetChartTableEntry(ic);
3074
3075 cte.ClearGroupArray();
3076
3077 wxString *chart_full_path = cte.GetpsFullPath();
3078
3079 for (unsigned int igroup = 0; igroup < pGroupArray->GetCount(); igroup++) {
3080 ChartGroup *pGroup = pGroupArray->Item(igroup);
3081 for (const auto &elem : pGroup->m_element_array) {
3082 wxString element_root = elem.m_element_name;
3083
3084 // The element may be a full single chart name
3085 // If so, add it
3086 // Otherwise, append a sep character so that similar paths are
3087 // distinguished. See FS#1060
3088 if (!chart_full_path->IsSameAs(element_root))
3089 element_root.Append(
3090 separator); // Prevent comingling similar looking path names
3091 if (chart_full_path->StartsWith(element_root)) {
3092 bool b_add = true;
3093 for (unsigned int k = 0; k < elem.m_missing_name_array.size(); k++) {
3094 const wxString &missing_item = elem.m_missing_name_array[k];
3095 if (chart_full_path->StartsWith(missing_item)) {
3096 if (chart_full_path->IsSameAs(
3097 missing_item)) // missing item is full chart name
3098 {
3099 b_add = false;
3100 break;
3101 } else {
3102 if (wxDir::Exists(missing_item)) // missing item is a dir
3103 {
3104 b_add = false;
3105 break;
3106 }
3107 }
3108 }
3109 }
3110
3111 if (b_add) cte.AddIntToGroupArray(igroup + 1);
3112 }
3113 }
3114 }
3115 }
3116}
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:304
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:486
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:187