OpenCPN Partial API docs
Loading...
Searching...
No Matches
chartcatalog.cpp
1/******************************************************************************
2 * $Id: chartcatalog.cpp,v 1.0 2011/02/26 01:54:37 nohal Exp $
3 *
4 * Project: OpenCPN
5 * Purpose: Chart downloader Plugin
6 * Author: Pavel Kalian
7 *
8 ***************************************************************************
9 * Copyright (C) 2011 by Pavel Kalian *
10 * $EMAIL$ *
11 * *
12 * This program is free software; you can redistribute it and/or modify *
13 * it under the terms of the GNU General Public License as published by *
14 * the Free Software Foundation; either version 2 of the License, or *
15 * (at your option) any later version. *
16 * *
17 * This program is distributed in the hope that it will be useful, *
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
20 * GNU General Public License for more details. *
21 * *
22 * You should have received a copy of the GNU General Public License *
23 * along with this program; if not, write to the *
24 * Free Software Foundation, Inc., *
25 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
26 ***************************************************************************
27 */
28
29#include "chartcatalog.h"
30#include <wx/tokenzr.h>
31#include <memory>
32
33// Chart Catalog implementation
34bool ChartCatalog::LoadFromFile(wxString path, bool headerOnly) {
35 dt_valid = wxInvalidDateTime; // Invalidate all dates
36 date_created = dt_valid; // so dates of one catalog
37 time_created = dt_valid; // don't propagate into another
38 date_valid = dt_valid;
39 title = _("Catalog is not valid."); // Invalidate the title in case we read a
40 // bad file
41 if (!wxFileExists(path)) return false;
42
43 pugi::xml_document doc;
44 bool ret = doc.load_file(path.mb_str());
45 if (ret)
46 ret = LoadFromXml(&doc, headerOnly);
47 else
48 charts.clear();
49
50 return ret;
51}
52
53ChartCatalog::ChartCatalog() {}
54
55ChartCatalog::~ChartCatalog() {}
56
57wxDateTime ChartCatalog::GetReleaseDate() {
58 if (!dt_valid.IsValid()) {
59 // date-time was invalid so we will create it from time_created and
60 // date_created If they are not valid then we return an invalid date for
61 // debugging purposes
62 if (date_created.IsValid() && time_created.IsValid()) {
63 dt_valid.ParseDate(date_created.FormatDate());
64 dt_valid.ParseTime(time_created.FormatTime());
65 dt_valid.MakeFromTimezone(wxDateTime::UTC);
66 }
67 }
68 wxASSERT(dt_valid.IsValid());
69 return dt_valid;
70}
71
72bool ChartCatalog::LoadFromXml(pugi::xml_document *doc, bool headerOnly) {
73 pugi::xml_node root = doc->first_child();
74
75 wxString rootName = wxString::FromUTF8(root.name());
76 charts.clear();
77 if (rootName.StartsWith(_T("RncProductCatalog"))) {
78 if (!ParseNoaaHeader(root.first_child())) {
79 return false;
80 }
81 if (headerOnly) return true;
82
83 for (pugi::xml_node element = root.first_child(); element;
84 element = element.next_sibling()) {
85 if (!strcmp(element.name(), "chart")) {
86 charts.push_back(std::make_unique<RasterChart>(element));
87 }
88 }
89 } else if (rootName.StartsWith(_T("EncProductCatalog"))) {
90 if (!ParseNoaaHeader(root.first_child())) {
91 return false;
92 }
93 if (headerOnly) return true;
94
95 for (pugi::xml_node element = root.first_child(); element;
96 element = element.next_sibling()) {
97 if (!strcmp(element.name(), "cell")) {
98 charts.push_back(std::make_unique<EncCell>(element));
99 }
100 }
101 }
102 // "IENCBuoyProductCatalog" and "IENCSouthwestPassProductCatalog" added by
103 // .Paul.
104 else if (rootName.StartsWith(_T("IENCU37ProductCatalog")) ||
105 rootName.StartsWith(_T("IENCBuoyProductCatalog")) ||
106 rootName.StartsWith(_T("IENCSouthwestPassProductCatalog"))) {
107 if (!ParseNoaaHeader(root.first_child())) {
108 return false;
109 }
110 if (headerOnly) return true;
111
112 for (pugi::xml_node element = root.first_child(); element;
113 element = element.next_sibling()) {
114 if (!strcmp(element.name(), "Cell")) {
115 charts.push_back(std::make_unique<IEncCell>(element));
116 }
117 }
118 } else {
119 return false;
120 }
121
122 return true;
123}
124
125bool ChartCatalog::ParseNoaaHeader(const pugi::xml_node &xmldata) {
126 for (pugi::xml_node element = xmldata.first_child(); element;
127 element = element.next_sibling()) {
128 if (!strcmp(element.name(), "title")) {
129 title = wxString::FromUTF8(element.first_child().value());
130 } else if (!strcmp(element.name(), "date_created")) {
131 date_created.ParseDate(wxString::FromUTF8(element.first_child().value()));
132 wxASSERT(date_created.IsValid());
133 } else if (!strcmp(element.name(), "time_created")) {
134 time_created.ParseTime(wxString::FromUTF8(element.first_child().value()));
135 wxASSERT(time_created.IsValid());
136 } else if (!strcmp(element.name(), "date_valid")) {
137 date_valid.ParseDate(wxString::FromUTF8(element.first_child().value()));
138 wxASSERT(time_created.IsValid());
139 } else if (!strcmp(element.name(), "time_valid")) {
140 time_valid.ParseTime(wxString::FromUTF8(element.first_child().value()));
141 wxASSERT(time_created.IsValid());
142 } else if (!strcmp(element.name(), "dt_valid")) {
143 wxStringTokenizer tk(wxString::FromUTF8(element.first_child().value()),
144 _T("TZ"));
145 dt_valid.ParseDate(tk.GetNextToken());
146 dt_valid.ParseTime(tk.GetNextToken());
147 dt_valid.MakeFromTimezone(wxDateTime::UTC);
148 wxASSERT(dt_valid.IsValid());
149 } else if (!strcmp(element.name(), "ref_spec")) {
150 ref_spec = wxString::FromUTF8(element.first_child().value());
151 } else if (!strcmp(element.name(), "ref_spec_vers")) {
152 ref_spec_vers = wxString::FromUTF8(element.first_child().value());
153 } else if (!strcmp(element.name(), "s62AgencyCode")) {
154 s62AgencyCode = wxString::FromUTF8(element.first_child().value());
155 }
156 }
157
158 return true;
159}
160
161Chart::~Chart() {
162 coast_guard_districts->Clear();
163 wxDELETE(coast_guard_districts);
164 states->Clear();
165 wxDELETE(states);
166 regions->Clear();
167 wxDELETE(regions);
168 wxDELETE(nm);
169 wxDELETE(lnm);
170}
171
172Chart::Chart(pugi::xml_node &xmldata) {
173 coast_guard_districts = new wxArrayString();
174 states = new wxArrayString();
175 regions = new wxArrayString();
176 target_filename = wxEmptyString;
177 reference_file = wxEmptyString;
178 manual_download_url = wxEmptyString;
179 title = wxEmptyString;
180 zipfile_location = wxEmptyString;
181 zipfile_size = -1;
182 zipfile_datetime = wxInvalidDateTime;
183 zipfile_datetime_iso8601 = wxInvalidDateTime;
184 uadt = wxInvalidDateTime;
185 isdt = wxInvalidDateTime;
186 edtn = -1;
187 updn = -1;
188 nm = NULL;
189 lnm = NULL;
190
191 for (pugi::xml_node element = xmldata.first_child(); element;
192 element = element.next_sibling()) {
193 if (!strcmp(element.name(), "title")) {
194 title = wxString::FromUTF8(element.first_child().value());
195 } else if (!strcmp(element.name(), "lname")) {
196 title = wxString::FromUTF8(element.first_child().value());
197 } else if (!strcmp(element.name(), "coast_guard_districts")) {
198 for (pugi::xml_node subElement = element.first_child(); subElement;
199 subElement = subElement.next_sibling()) {
200 coast_guard_districts->Add(
201 wxString::FromUTF8(subElement.first_child().value()));
202 }
203 } else if (!strcmp(element.name(), "states")) {
204 for (pugi::xml_node subElement = element.first_child(); subElement;
205 subElement = subElement.next_sibling()) {
206 states->Add(wxString::FromUTF8(subElement.first_child().value()));
207 }
208 } else if (!strcmp(element.name(), "regions")) {
209 for (pugi::xml_node subElement = element.first_child(); subElement;
210 subElement = subElement.next_sibling()) {
211 regions->Add(wxString::FromUTF8(subElement.first_child().value()));
212 }
213 } else if (!strcmp(element.name(), "zipfile_location")) {
214 zipfile_location = wxString::FromUTF8(element.first_child().value());
215 } else if (!strcmp(element.name(), "zipfile_datetime")) {
216 if (zipfile_datetime.ParseFormat(
217 wxString::FromUTF8(element.first_child().value()),
218 _T("%Y%m%d_%H%M%S")))
219 zipfile_datetime.MakeFromTimezone(wxDateTime::UTC);
220 } else if (!strcmp(element.name(), "zipfile_datetime_iso8601")) {
221 wxStringTokenizer tk(wxString::FromUTF8(element.first_child().value()),
222 _T("TZ"));
223 zipfile_datetime_iso8601.ParseDate(tk.GetNextToken());
224 zipfile_datetime_iso8601.ParseTime(tk.GetNextToken());
225 zipfile_datetime_iso8601.MakeFromTimezone(wxDateTime::UTC);
226 } else if (!strcmp(element.name(), "zipfile_size")) {
227 zipfile_size = wxAtoi(wxString::FromUTF8(element.first_child().value()));
228 } else if (!strcmp(element.name(), "edtn")) {
229 edtn = wxAtoi(wxString::FromUTF8(element.first_child().value()));
230 } else if (!strcmp(element.name(), "updn")) {
231 updn = wxAtoi(wxString::FromUTF8(element.first_child().value()));
232 } else if (!strcmp(element.name(), "uadt")) {
233 uadt.ParseFormat(wxString::FromUTF8(element.first_child().value()),
234 "%Y-%m-%d");
235 } else if (!strcmp(element.name(), "isdt")) {
236 isdt.ParseFormat(wxString::FromUTF8(element.first_child().value()),
237 "%Y-%m-%d");
238 } else if (!strcmp(element.name(), "cov")) {
239 for (pugi::xml_node subElement = element.first_child(); subElement;
240 subElement = subElement.next_sibling()) {
241 coverage.push_back(std::make_unique<Panel>(subElement));
242 }
243 } else if (!strcmp(element.name(), "target_filename")) {
244 target_filename = wxString::FromUTF8(element.first_child().value());
245 } else if (!strcmp(element.name(), "reference_file")) {
246 reference_file = wxString::FromUTF8(element.first_child().value());
247 } else if (!strcmp(element.name(), "manual_download_url")) {
248 manual_download_url = wxString::FromUTF8(element.first_child().value());
249 } else if (!strcmp(element.name(), "nm")) {
250 // NOT USED
251 // nm = new NoticeToMariners(element);
252 } else if (!strcmp(element.name(), "lnm")) {
253 // NOT USED
254 // lnm = new NoticeToMariners(element);
255 }
256 }
257}
258
259wxString Chart::GetChartFilename(bool to_check) {
260 if (to_check && reference_file != wxEmptyString) return reference_file;
261 if (target_filename != wxEmptyString) return target_filename;
262 wxString file;
263 wxStringTokenizer tk(zipfile_location, _T("/"));
264 do {
265 file = tk.GetNextToken();
266 } while (tk.HasMoreTokens());
267 return file;
268}
269
270RasterChart::RasterChart(pugi::xml_node &xmldata) : Chart(xmldata) {
271 number = wxEmptyString;
272 source_edition = -1;
273 raster_edition = -1;
274 ntm_edition = -1;
275 source_date = wxEmptyString;
276 ntm_date = wxEmptyString;
277 source_edition_last_correction = wxEmptyString;
278 raster_edition_last_correction = wxEmptyString;
279 ntm_edition_last_correction = wxEmptyString;
280
281 for (pugi::xml_node element = xmldata.first_child(); element;
282 element = element.next_sibling()) {
283 if (!strcmp(element.name(), "number")) {
284 number = wxString::FromUTF8(element.first_child().value());
285 } else if (!strcmp(element.name(), "source_edition")) {
286 source_edition =
287 wxAtoi(wxString::FromUTF8(element.first_child().value()));
288 } else if (!strcmp(element.name(), "raster_edition")) {
289 raster_edition =
290 wxAtoi(wxString::FromUTF8(element.first_child().value()));
291 } else if (!strcmp(element.name(), "ntm_edition")) {
292 ntm_edition = wxAtoi(wxString::FromUTF8(element.first_child().value()));
293 } else if (!strcmp(element.name(), "source_date")) {
294 source_date = wxString::FromUTF8(element.first_child().value());
295 } else if (!strcmp(element.name(), "ntm_date")) {
296 ntm_date = wxString::FromUTF8(element.first_child().value());
297 } else if (!strcmp(element.name(), "source_edition_last_correction")) {
298 source_edition_last_correction =
299 wxString::FromUTF8(element.first_child().value());
300 } else if (!strcmp(element.name(), "raster_edition_last_correction")) {
301 raster_edition_last_correction =
302 wxString::FromUTF8(element.first_child().value());
303 } else if (!strcmp(element.name(), "ntm_edition_last_correction")) {
304 ntm_edition_last_correction =
305 wxString::FromUTF8(element.first_child().value());
306 }
307 }
308}
309
310EncCell::EncCell(pugi::xml_node &xmldata) : Chart(xmldata) {
311 number = wxEmptyString; // Use number (not name) for zip file name and cell
312 // name .Paul.
313 src_chart = wxEmptyString;
314 cscale = -1;
315 status = wxEmptyString;
316 edtn = -1;
317 updn = -1;
318 uadt = wxInvalidDateTime;
319 isdt = wxInvalidDateTime;
320
321 for (pugi::xml_node element = xmldata.first_child(); element;
322 element = element.next_sibling()) {
323 if (!strcmp(element.name(), "name")) {
324 number = wxString::FromUTF8(element.first_child().value());
325 } else if (!strcmp(element.name(), "src_chart")) {
326 src_chart = wxString::FromUTF8(element.first_child().value());
327 } else if (!strcmp(element.name(), "cscale")) {
328 cscale = wxAtoi(wxString::FromUTF8(element.first_child().value()));
329 } else if (!strcmp(element.name(), "status")) {
330 status = wxString::FromUTF8(element.first_child().value());
331 } else if (!strcmp(element.name(), "edtn")) {
332 edtn = wxAtoi(wxString::FromUTF8(element.first_child().value()));
333 } else if (!strcmp(element.name(), "updn")) {
334 updn = wxAtoi(wxString::FromUTF8(element.first_child().value()));
335 } else if (!strcmp(element.name(), "uadt")) {
336 uadt.ParseDateTime(wxString::FromUTF8(element.first_child().value()));
337 } else if (!strcmp(element.name(), "isdt")) {
338 isdt.ParseDateTime(wxString::FromUTF8(element.first_child().value()));
339 }
340 }
341}
342
343IEncCell::IEncCell(pugi::xml_node &xmldata) : Chart(xmldata) {
344 // Use number (not name) for zip file name and cell name .Paul.
345 number = wxEmptyString;
346 location = NULL;
347 river_name = wxEmptyString;
348 river_miles = NULL;
349 area = NULL;
350 edition = wxEmptyString;
351 shp_file = NULL;
352 s57_file = NULL;
353 kml_file = NULL;
354
355 for (pugi::xml_node element = xmldata.first_child(); element;
356 element = element.next_sibling()) {
357 if (!strcmp(element.name(), "name")) {
358 // Use number (not name) for zip file name and cell name .Paul.
359 number = wxString::FromUTF8(element.first_child().value());
360 zipfile_location = wxString::Format(_T("%s.zip"), number.c_str());
361 } else if (!strcmp(element.name(), "location")) {
362 location = new Location(element);
363 } else if (!strcmp(element.name(), "river_name")) {
364 river_name = wxString::FromUTF8(element.first_child().value());
365 } else if (!strcmp(element.name(), "river_miles")) {
366 river_miles = new RiverMiles(element);
367 } else if (!strcmp(element.name(), "river_miles")) {
368 river_miles = new RiverMiles(element);
369 } else if (!strcmp(element.name(), "area")) {
370 area = new Area(element);
371 } else if (!strcmp(element.name(), "shp_file")) {
372 shp_file = new ChartFile(element);
373 } else if (!strcmp(element.name(), "s57_file")) {
374 s57_file = new ChartFile(element);
375 } else if (!strcmp(element.name(), "kml_file")) {
376 kml_file = new ChartFile(element);
377 } else if (!strcmp(element.name(), "edition")) {
378 edition = wxString::FromUTF8(element.first_child().value());
379 }
380 }
381}
382
383IEncCell::~IEncCell() {
384 wxDELETE(location);
385 wxDELETE(river_miles);
386 wxDELETE(area);
387 wxDELETE(shp_file);
388 wxDELETE(s57_file);
389 wxDELETE(kml_file);
390}
391
392wxString IEncCell::GetChartTitle()
393// Revised by .Paul. to support IENC catalogs that do not identify rivers or
394// river miles.
395{
396 if (river_name != wxEmptyString) {
397 // This formatting of river_name.c_str() ... river_miles->end works for
398 // "IENCU37ProductCatalog" where river_name is specified.
399 return wxString::Format(_("%s (%s to %s), river miles %3.1f - %3.1f"),
400 river_name.c_str(), location->from.c_str(),
401 location->to.c_str(), river_miles->begin,
402 river_miles->end);
403 } else {
404 // Simply use the Cell_name for "IENCBuoyProductCatalog" or
405 // "IENCSouthwestPassProductCatalog" where river_name is not specified.
406 // Cell_name is in number.c_str() Cell_name was in name.c_str()
407 return wxString::Format(_("%s"), number.c_str()); // .Paul.
408 }
409}
410
411wxString IEncCell::GetDownloadLocation() { return s57_file->location; }
412
413wxDateTime IEncCell::GetUpdateDatetime() { return s57_file->date_posted; }
414
415ChartFile::ChartFile(pugi::xml_node &xmldata) {
416 file_size = -1;
417 location = wxEmptyString;
418 date_posted = wxInvalidDateTime;
419 time_posted = wxInvalidDateTime;
420
421 for (pugi::xml_node element = xmldata.first_child(); element;
422 element = element.next_sibling()) {
423 if (!strcmp(element.name(), "location")) {
424 location = wxString::FromUTF8(element.first_child().value());
425 } else if (!strcmp(element.name(), "date_posted")) {
426 date_posted.ParseDate(wxString::FromUTF8(element.first_child().value()));
427 } else if (!strcmp(element.name(), "time_posted")) {
428 if (strlen(element.first_child().value()))
429 time_posted.ParseTime(
430 wxString::FromUTF8(element.first_child().value()));
431 else
432 time_posted.ParseTime(_T("00:00:00"));
433 } else if (!strcmp(element.name(), "file_size")) {
434 if (strlen(element.first_child().value()))
435 file_size = wxAtoi(wxString::FromUTF8(element.first_child().value()));
436 else
437 file_size = -1;
438 }
439 }
440}
441
442Area::Area(pugi::xml_node &xmldata) {
443 north = 0.0;
444 south = 0.0;
445 east = 0.0;
446 west = 0.0;
447
448 for (pugi::xml_node element = xmldata.first_child(); element;
449 element = element.next_sibling()) {
450 if (!strcmp(element.name(), "north")) {
451 north = wxAtof(wxString::FromUTF8(element.first_child().value()));
452 } else if (!strcmp(element.name(), "south")) {
453 south = wxAtof(wxString::FromUTF8(element.first_child().value()));
454 } else if (!strcmp(element.name(), "east")) {
455 east = wxAtof(wxString::FromUTF8(element.first_child().value()));
456 } else if (!strcmp(element.name(), "west")) {
457 west = wxAtof(wxString::FromUTF8(element.first_child().value()));
458 }
459 }
460}
461
462RiverMiles::RiverMiles(pugi::xml_node &xmldata) {
463 begin = -1;
464 end = -1;
465 for (pugi::xml_node element = xmldata.first_child(); element;
466 element = element.next_sibling()) {
467 if (!strcmp(element.name(), "begin")) {
468 begin = wxAtof(wxString::FromUTF8(element.first_child().value()));
469 } else if (!strcmp(element.name(), "end")) {
470 end = wxAtof(wxString::FromUTF8(element.first_child().value()));
471 }
472 }
473}
474
475Location::Location(pugi::xml_node &xmldata) {
476 from = wxEmptyString;
477 to = wxEmptyString;
478 for (pugi::xml_node element = xmldata.first_child(); element;
479 element = element.next_sibling()) {
480 if (!strcmp(element.name(), "from")) {
481 from = wxString::FromUTF8(element.first_child().value());
482 } else if (!strcmp(element.name(), "to")) {
483 to = wxString::FromUTF8(element.first_child().value());
484 }
485 }
486}
487
488NoticeToMariners::NoticeToMariners(pugi::xml_node &xmldata) {
489 agency = wxEmptyString;
490 doc = wxEmptyString;
491 date = wxInvalidDateTime;
492
493 for (pugi::xml_node element = xmldata.first_child(); element;
494 element = element.next_sibling()) {
495 if (!strcmp(element.name(), "nm_agency")) {
496 agency = wxString::FromUTF8(element.first_child().value());
497 } else if (!strcmp(element.name(), "lnm_agency")) {
498 agency = wxString::FromUTF8(element.first_child().value());
499 } else if (!strcmp(element.name(), "doc")) {
500 doc = wxString::FromUTF8(element.first_child().value());
501 } else if (!strcmp(element.name(), "date")) {
502 date.ParseDate(wxString::FromUTF8(element.first_child().value()));
503 }
504 }
505}
506
507Panel::Panel(pugi::xml_node &xmldata) {
508 panel_no = -1;
509
510 for (pugi::xml_node element = xmldata.first_child(); element;
511 element = element.next_sibling()) {
512 if (!strcmp(element.name(), "panel_no")) {
513 panel_no = wxAtoi(wxString::FromUTF8(element.first_child().value()));
514 } else if (!strcmp(element.name(), "vertex")) {
515 // NOT USED
516 // vertexes.Add(new Vertex(element));
517 }
518 }
519}
520
521Panel::~Panel() {}
522
523RncPanel::RncPanel(pugi::xml_node &xmldata) : Panel(xmldata) {
524 panel_title = wxEmptyString;
525 file_name = wxEmptyString;
526 scale = 0;
527
528 for (pugi::xml_node element = xmldata.first_child(); element;
529 element = element.next_sibling()) {
530 if (!strcmp(element.name(), "panel_title")) {
531 panel_title = wxString::FromUTF8(element.first_child().value());
532 } else if (!strcmp(element.name(), "file_name")) {
533 file_name = wxString::FromUTF8(element.first_child().value());
534 } else if (!strcmp(element.name(), "scale")) {
535 scale = wxAtoi(wxString::FromUTF8(element.first_child().value()));
536 }
537 }
538}
539
540EncPanel::EncPanel(pugi::xml_node &xmldata) : Panel(xmldata) {
541 type = wxEmptyString;
542 for (pugi::xml_node element = xmldata.first_child(); element;
543 element = element.next_sibling()) {
544 if (!strcmp(element.name(), "type")) {
545 type = wxString::FromUTF8(element.first_child().value());
546 }
547 }
548}
549
550Vertex::Vertex(pugi::xml_node &xmldata) {
551 // Init properties
552 lat = 999.0;
553 lon = 999.0;
554 for (pugi::xml_node element = xmldata.first_child(); element;
555 element = element.next_sibling()) {
556 if (!strcmp(element.name(), "lat")) {
557 wxString::FromUTF8(element.first_child().value()).ToDouble(&lat);
558 } else if (!strcmp(element.name(), "lon")) {
559 wxString::FromUTF8(element.first_child().value()).ToDouble(&lon);
560 }
561 }
562}
pugi::xml_document
Definition pugixml.hpp:1054
pugi::xml_node
Definition pugixml.hpp:461