-
Notifications
You must be signed in to change notification settings - Fork 3
/
Gov4WebtreesModule.php
1290 lines (1052 loc) · 45.9 KB
/
Gov4WebtreesModule.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
namespace Cissee\Webtrees\Module\Gov4Webtrees;
use Cissee\Webtrees\Module\Gov4Webtrees\FunctionsGov;
use Cissee\Webtrees\Module\Gov4Webtrees\Http\RequestHandlers\GovData;
use Cissee\Webtrees\Module\Gov4Webtrees\Http\RequestHandlers\GovDataDelete;
use Cissee\Webtrees\Module\Gov4Webtrees\Http\RequestHandlers\GovDataEdit;
use Cissee\Webtrees\Module\Gov4Webtrees\Http\RequestHandlers\GovDataList;
use Cissee\Webtrees\Module\Gov4Webtrees\Http\RequestHandlers\GovDataSave;
use Cissee\Webtrees\Module\Gov4Webtrees\Model\GovHierarchy;
use Cissee\Webtrees\Module\Gov4Webtrees\Model\GovHierarchyUtils;
use Cissee\Webtrees\Module\Gov4Webtrees\Model\JulianDayInterval;
use Cissee\WebtreesExt\AbstractModule;
use Cissee\WebtreesExt\Elements\GovIdTypeExt;
use Cissee\WebtreesExt\Elements\GovIdentifierExt;
use Cissee\WebtreesExt\Http\RequestHandlers\FunctionsPlaceProvidersAction;
use Cissee\WebtreesExt\Module\ModuleExtGlobalInterface;
use Cissee\WebtreesExt\Module\ModuleExtGlobalTrait;
use Cissee\WebtreesExt\Module\ModuleMetaInterface;
use Cissee\WebtreesExt\Module\ModuleMetaTrait;
use Cissee\WebtreesExt\MoreI18N;
use Cissee\WebtreesExt\Requests;
use Cissee\WebtreesExt\VirtualFact;
use DateTime;
use Exception;
use Fisharebest\ExtCalendar\GregorianCalendar;
use Fisharebest\Localization\Locale\LocaleInterface;
use Fisharebest\Webtrees\Fact;
use Fisharebest\Webtrees\FlashMessages;
use Fisharebest\Webtrees\GedcomRecord;
use Fisharebest\Webtrees\Http\Middleware\AuthAdministrator;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Location;
use Fisharebest\Webtrees\Module\ModuleConfigInterface;
use Fisharebest\Webtrees\Module\ModuleConfigTrait;
use Fisharebest\Webtrees\Module\ModuleCustomInterface;
use Fisharebest\Webtrees\Module\ModuleCustomTrait;
use Fisharebest\Webtrees\Place;
use Fisharebest\Webtrees\Registry;
use Fisharebest\Webtrees\Report\ReportParserGenerate;
use Fisharebest\Webtrees\Services\ModuleService;
use Fisharebest\Webtrees\Services\SearchService;
use Fisharebest\Webtrees\Session;
use Fisharebest\Webtrees\Tree;
use Fisharebest\Webtrees\View;
use Fisharebest\Webtrees\Webtrees;
use Illuminate\Support\Collection;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Vesta\CommonI18N;
use Vesta\Hook\HookInterfaces\EmptyFunctionsPlace;
use Vesta\Hook\HookInterfaces\EmptyIndividualFactsTabExtender;
use Vesta\Hook\HookInterfaces\EmptyPrintFunctionsPlace;
use Vesta\Hook\HookInterfaces\FunctionsPlaceInterface;
use Vesta\Hook\HookInterfaces\FunctionsPlaceUtils;
use Vesta\Hook\HookInterfaces\GovIdEditControlsInterface;
use Vesta\Hook\HookInterfaces\IndividualFactsTabExtenderInterface;
use Vesta\Hook\HookInterfaces\PrintFunctionsPlaceInterface;
use Vesta\Model\GedcomDateInterval;
use Vesta\Model\GenericViewElement;
use Vesta\Model\GovReference;
use Vesta\Model\LocReference;
use Vesta\Model\MapCoordinates;
use Vesta\Model\PlaceStructure;
use Vesta\Model\Trace;
use Vesta\VestaAdminController;
use Vesta\VestaModuleTrait;
use const CAL_GREGORIAN;
use function cal_to_jd;
use function response;
use function route;
use function view;
class Gov4WebtreesModule extends AbstractModule implements
ModuleCustomInterface,
ModuleMetaInterface,
ModuleConfigInterface,
ModuleExtGlobalInterface,
IndividualFactsTabExtenderInterface,
FunctionsPlaceInterface,
PrintFunctionsPlaceInterface,
GovIdEditControlsInterface {
//cannot use original AbstractModule because we override setPreference, setName
use ModuleCustomTrait,
ModuleMetaTrait,
ModuleConfigTrait,
ModuleExtGlobalTrait,
VestaModuleTrait {
VestaModuleTrait::customTranslations insteadof ModuleCustomTrait;
VestaModuleTrait::getAssetAction insteadof ModuleCustomTrait;
VestaModuleTrait::assetUrl insteadof ModuleCustomTrait;
VestaModuleTrait::getConfigLink insteadof ModuleConfigTrait;
ModuleMetaTrait::customModuleVersion insteadof ModuleCustomTrait;
ModuleMetaTrait::customModuleLatestVersion insteadof ModuleCustomTrait;
}
use Gov4WebtreesModuleTrait;
use EmptyIndividualFactsTabExtender;
use EmptyFunctionsPlace;
use EmptyPrintFunctionsPlace;
protected $module_service;
protected $search_service;
public function __construct(ModuleService $module_service, SearchService $search_service) {
$this->module_service = $module_service;
$this->search_service = $search_service;
}
protected function onBoot(): void {
//cannot do this in constructor: module name not set yet!
//migrate (we need the module name here to store the setting)
$this->updateSchema('\Cissee\Webtrees\Module\Gov4Webtrees\Schema', 'SCHEMA_VERSION', 3);
$this->flashWhatsNew('\Cissee\Webtrees\Module\Gov4Webtrees\WhatsNew', 6);
$router = Registry::routeFactory()->routeMap();
//http://localhost/dev/webtrees_releases/webtrees/admin/gov-data/object_156114
$router->get(GovDataList::class, '/admin/gov-data', new GovDataList($this))
->extras(['middleware' => [AuthAdministrator::class]]);
$router->get(GovData::class, '/admin/gov-data/{gov_id}', new GovData($this))
->extras(['middleware' => [AuthAdministrator::class]]);
$router->get(GovDataEdit::class, '/admin/gov-data-edit/{type}/{key}', new GovDataEdit($this))
->extras(['middleware' => [AuthAdministrator::class]]);
$router->post(GovDataSave::class, '/admin/gov-data-update', GovDataSave::class)
->extras(['middleware' => [AuthAdministrator::class]]);
$router->post(GovDataDelete::class, '/admin/gov-data-delete/{type}/{key}', GovDataDelete::class)
->extras(['middleware' => [AuthAdministrator::class]]);
//replace GovIdentifier (change its edit control)
$ef = Registry::elementFactory();
//note: hopefully no other _custom_ module after this one registers the same tags,
//otherwise we lose
$ef->registerTags([
//these would require a different edit control (to get the PLAC name)
//'FAM:*:PLAC:_GOV' => new GovIdentifierExt(MoreI18N::xlate('GOV identifier')),
//'INDI:*:PLAC:_GOV' => new GovIdentifierExt(MoreI18N::xlate('GOV identifier')),
'_LOC:_GOV' => new GovIdentifierExt(MoreI18N::xlate('GOV identifier')),
//(see also SharedPlaces, and webtrees core)
'_LOC:TYPE:_GOVTYPE' => new GovIdTypeExt($this, I18N::translate('GOV id for type of location')),
]);
//do we want to make _GOV available everywhere for editing though?
//for now, no. otherwise cf SharedPlacesModule customSubTags
}
public function messageGovServerUnavailable(): string {
return I18N::translate("The GOV server seems to be temporarily unavailable.");
}
public function flashGovServerUnavailable() {
//ongoing - error handling in case GOV server is unavailable
//problematic: flash message aren't thead-safe, see webtrees issue #3138
//but we can live with the current fix
$messages = Session::get('flash_messages', []);
if (empty($messages)) {
FlashMessages::addMessage($this->messageGovServerUnavailable());
}
}
public function customModuleAuthorName(): string {
return 'Richard Cissée';
}
public function customModuleMetaDatasJson(): string {
return file_get_contents(__DIR__ . '/metadata.json');
}
public function customModuleLatestMetaDatasJsonUrl(): string {
return 'https://raw.githubusercontent.com/vesta-webtrees-2-custom-modules/vesta_gov4webtrees/master/metadata.json';
}
public function customModuleSupportUrl(): string {
return 'https://cissee.de';
}
public function resourcesFolder(): string {
return __DIR__ . '/resources/';
}
public function headContentOnAdminPage(): string {
return $this->headContent();
}
public function headContent(): string {
//easier to serve this globally, even if not strictly required on each page
//(but required e.g. for pages where gov2html is shown)
$html = '<link href="' . $this->assetUrl('css/style.css') . '" type="text/css" rel="stylesheet" />';
$html .= '<link href="' . $this->assetUrl('css/' . $this->getThemeForCss() . '.css') . '" type="text/css" rel="stylesheet" />';
return $html;
}
public function getHelpAction(ServerRequestInterface $request): ResponseInterface {
$topic = Requests::getString($request, 'topic');
return response(HelpTexts::helpText($topic));
}
//no longer required - css is static now
//public function assetsViaViews(): array {
// return [
// 'css/style.css' => 'css/style',
// 'css/webtrees.css' => 'css/webtrees',
// 'css/minimal.css' => 'css/minimal'];
//}
protected function getThemeForCss(): string {
//align with current theme (supporting the default webtrees themes, and specific custom themes)
$themeName = Session::get('theme');
if ('minimal' !== $themeName) {
if ('fab' === $themeName) {
//fab also uses font awesome icons
$themeName = 'minimal';
} else if ('_myartjaub_ruraltheme_' === $themeName) {
//and the custom 'rural' theme
$themeName = 'minimal';
} else if ('_jc-theme-justlight_' === $themeName) {
//and the custom 'JustLight' theme
$themeName = 'minimal';
} else if ('_jc-theme-justlight2_' === $themeName) {
//and the custom 'JustLight' theme, version 2
$themeName = 'minimal';
} else {
//default
$themeName = 'webtrees';
}
}
return $themeName;
}
public function setPreference(string $setting_name, string $setting_value): void {
if ('RESET' === $setting_name) {
if ('1' === $setting_value) {
FunctionsGov::clear();
//we didn't mean to store this preference at all,
//but we accidentally did. Safer to reset always, that's anyway the intended behavior
$setting_value = '0';
}
}
parent::setPreference($setting_name, $setting_value);
}
////////////////////////////////////////////////////////////////////////////////
//GovIdEditControlsInterface
public function govIdEditControlSelectScriptSnippet(): string {
return $this->govIdEditControlSelectScriptSnippetInternal(true);
}
public function govIdEditControlSelectScriptSnippetInternal(bool $withinModal): string {
$html = view($this->name() . '::script/tom-select-initializer-gov', [
//'withinModal' => $withinModal
]);
return $html;
}
public function govIdEditControl(
?string $govId,
string $id,
string $name,
string $placeName,
?string $placeNameSelector,
bool $forModal,
bool $withLabel): GenericViewElement {
if (!boolval($this->getPreference('SUPPORT_EDITING_ELSEWHERE', '1'))) {
return GenericViewElement::createEmpty();
}
$html = '';
//now loaded globally
//$html .= '<link href="' . $this->assetUrl('css/'.$this->getThemeForCss().'.css') . '" type="text/css" rel="stylesheet" />';
$html .= view($this->name() . '::edit/gov-id-edit-control', [
'moduleName' => $this->name(),
'withLabel' => $withLabel,
'id' => $id,
'name' => $name,
'placeName' => $placeName,
'placeNameSelector' => $placeNameSelector,
'internal' => false,
'selectInitializer' => $forModal ? null : $this->govIdEditControlSelectScriptSnippetInternal(false),
'govId' => $govId]);
$script = View::stack('javascript');
return new GenericViewElement($html, $script);
}
public function govTypeIdEditControl(
?string $govTypeId,
string $id,
string $name): GenericViewElement {
$locale = I18N::locale();
$govTypeIdsByTypeGroup = FunctionsGov::getGovTypeIdsByTypeGroup($this, $locale);
$html = view($this->name() . '::edit/gov-type-id-edit-control', [
'moduleName' => $this->name(),
'id' => $id,
'name' => $name,
'govTypeIdsByTypeGroup' => $govTypeIdsByTypeGroup,
'govTypeId' => $govTypeId]);
$script = View::stack('javascript');
return new GenericViewElement($html, $script);
}
public function govLanguageEditControl(
?string $govLanguage,
string $id,
string $name): GenericViewElement {
$locale = I18N::locale();
$govLanguages = FunctionsGov::getGovLanguages();
$html = view($this->name() . '::edit/gov-language-edit-control', [
'moduleName' => $this->name(),
'id' => $id,
'name' => $name,
'govLanguages' => $govLanguages,
'govLanguage' => $govLanguage]);
$script = View::stack('javascript');
return new GenericViewElement($html, $script);
}
////////////////////////////////////////////////////////////////////////////////
public function getTomSelectGovIdAction(ServerRequestInterface $request): ResponseInterface {
if (!str_starts_with(Webtrees::VERSION, '2.1')) {
throw new Exception;
}
$requestHandler = new TomSelectGovId($this);
return $requestHandler->handle($request);
}
public function getEditGovMappingAction(ServerRequestInterface $request): ResponseInterface {
//'tree' is handled specifically in Router.php
$tree = $request->getAttribute('tree');
assert($tree instanceof Tree);
$controller = new EditGovMappingController($this);
return $controller->editGovMapping($request, $tree);
}
public function postEditGovMappingAction(ServerRequestInterface $request): ResponseInterface {
$controller = new EditGovMappingController($this);
return $controller->editGovMappingAction($request);
}
public function postReloadGovHierarchyAction(ServerRequestInterface $request): ResponseInterface {
$placeName = Requests::getString($request, 'place-name');
$govId = Requests::getString($request, 'gov-id');
//reset in order to reload hierarchy
FunctionsGov::deleteGovObject($govId);
if ($placeName !== '') {
FlashMessages::addMessage(I18N::translate('GOV place hierarchy for %1$s has been reloaded from GOV server.', $placeName));
} else {
FlashMessages::addMessage(I18N::translate('GOV place hierarchy has been reloaded from GOV server.'));
}
//no need to return data
return response();
}
////////////////////////////////////////////////////////////////////////////////
public function hFactsTabRequiresModalVesta(Tree $tree): ?string {
//trigger add the vesta modal placeholder, with custom select2 snippet
$script = $this->govIdEditControlSelectScriptSnippet();
return $script;
}
public function hFactsTabGetAdditionalEditControls(
Fact $fact): GenericViewElement {
$canEdit = false;
if (boolval($this->getPreference('VISITORS_MAY_EDIT', '0'))) {
$canEdit = true;
} else {
$canEdit = $fact->canEdit();
}
if (!$canEdit) {
//not editable
return GenericViewElement::createEmpty();
}
$tag = explode(':', $fact->tag())[1];
if ($tag === '_GOV') {
//direct gov tag (on place or shared place)
$govReference = new GovReference($fact->value(), new Trace(""));
$viewName = $this->name() . '::edit/icon-fact-reload-gov';
//allow to reload the gov hierarchy
$html = view($viewName, [
'moduleName' => $this->name(),
'title' => I18N::translate('reload the GOV place hierarchy'),
'route' => route('module', [
'module' => $this->name(),
'action' => 'ReloadGovHierarchy',
'gov-id' => $govReference->getId(),
'place-name' => ""
])]);
return GenericViewElement::create($html);
}
$ps = PlaceStructure::fromFact($fact);
if ($ps === null) {
//no PLAC (or empty), doesn't make sense to edit here
return GenericViewElement::createEmpty();
}
$readonly = boolval($this->getPreference('NO_ONE_MAY_EDIT', '0')) &&
!boolval($this->getPreference('VISITORS_MAY_EDIT', '0'));
if ($readonly) {
//cannot use this - skips levels 3 tags
//$placerec = '2 PLAC ' . $event->attribute('PLAC');
$placerec = ReportParserGenerate::getSubRecord(2, '2 PLAC', $fact->gedcom());
if (empty($placerec)) {
//nothing to offer here
return GenericViewElement::createEmpty();
}
//get a gov reference (may be provided by ourselves ultimately)
$govReference = FunctionsPlaceUtils::plac2gov($this, $ps, false);
if ($govReference === null) {
//nothing to offer here
return GenericViewElement::createEmpty();
}
$viewName = $this->name() . '::edit/icon-fact-reload-gov';
//allow to reload the gov hierarchy
$html = view($viewName, [
'moduleName' => $this->name(),
'title' => I18N::translate('reload the GOV place hierarchy'),
'route' => route('module', [
'module' => $this->name(),
'action' => 'ReloadGovHierarchy',
'gov-id' => $govReference->getId(),
'place-name' => $fact->place()->gedcomName()
])]);
return GenericViewElement::create($html);
}
//do not use plac2gov here - we're only interested in actual direct mappings at this point!
$govId = Gov4WebtreesModule::plac2govViaMappingTable($ps);
//ok to edit
if ($govId === null) {
$title = I18N::translate('Set GOV id (outside GEDCOM)');
} else {
$title = I18N::translate('Reset GOV id (outside GEDCOM) and reload the GOV place hierarchy');
}
$viewName = $this->name() . '::edit/icon-fact-map-gov';
$html = view($viewName, [
'fact' => $fact,
'moduleName' => $this->name(),
'title' => $title]);
return GenericViewElement::create($html);
}
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
public function hFactsTabGetOutputBeforeTab(
GedcomRecord $record): GenericViewElement {
//loadded uncondditionally anyway!
//$pre = '<link href="' . $this->assetUrl('css/style.css') . '" type="text/css" rel="stylesheet" />';
//return new GenericViewElement($pre, '');
return GenericViewElement::createEmpty();
}
public function hFactsTabGetStyleadds(
GedcomRecord $record,
Fact $fact): array {
$styleadds = [];
if ($fact->id() === 'gov-history') {
$styleadds[] = 'wt-gov-history-fact-pfh collapse'; //see style.css, and hFactsTabGetOutputInDBox
}
return $styleadds;
}
public function hFactsTabGetOutputInDBox(
GedcomRecord $record): GenericViewElement {
if (sizeof($this->hFactsTabGetAdditionalFacts($record)) === 0) {
return GenericViewElement::createEmpty();
}
return $this->getOutputInDescriptionBox(
true,
'show-gov-history-factstab',
'wt-gov-history-fact-pfh',
I18N::translate('GOV Hierarchies'));
}
protected function getOutputInDescriptionBox(
bool $toggleable,
string $id,
string $targetClass,
string $label) {
ob_start();
if ($toggleable) {
?>
<label>
<input id="<?php echo $id; ?>" type="checkbox" data-bs-toggle="collapse" data-bs-target=".<?php echo $targetClass; ?>" data-wt-persist="<?php echo $targetClass; ?>" autocomplete="off">
<?php echo $label; ?>
</label>
<?php
}
return new GenericViewElement(ob_get_clean(), '');
}
public function hFactsTabGetOutputAfterTab(
GedcomRecord $record,
bool $ajax): GenericViewElement {
if (!$ajax) {
//nothing to do - in fact must not initialize twice!
return GenericViewElement::createEmpty();
}
if (sizeof($this->hFactsTabGetAdditionalFacts($record)) === 0) {
return GenericViewElement::createEmpty();
}
return $this->getOutputAfterTab(true, 'show-gov-history-factstab');
}
protected function getOutputAfterTab(
bool $toggleable,
string $toggle): GenericViewElement {
$post = "";
if ($toggleable) {
$post = $this->getScript($toggle);
}
return new GenericViewElement('', $post);
}
protected function getScript($toggle) {
ob_start();
?>
<script>
webtrees.persistentToggle(document.querySelector('#<?php echo $toggle; ?>'));
</script>
<?php
return ob_get_clean();
}
public function hFactsTabGetAdditionalFacts(
GedcomRecord $record) {
$cacheKey = Gov4WebtreesModule::class . '_hFactsTabGetAdditionalFacts_' . $record->tree()->id() . $record->xref();
$self = $this;
$ret = Registry::cache()->array()->remember($cacheKey, static function () use ($self, $record): array {
if (!($record instanceof Location)) {
return [];
}
return $self->govHierarchiesAsFacts($record);
});
return $ret;
}
protected function govHierarchiesAsFacts(
Location $location) {
$loc = $location->xref();
if ($loc === '') {
$locReference = null;
//dummy record, should at least have PLAC
//
$placerec = ReportParserGenerate::getSubRecord(1, '1 PLAC', $location->gedcom());
//strip the '1 PLAC '
$placerec = substr($placerec, 7);
$ps = PlaceStructure::fromName($placerec, $location->tree());
if ($ps === null) {
return [];
}
$gov = FunctionsPlaceUtils::plac2gov($this, $ps, false);
$plac = $placerec;
} else {
$locReference = new LocReference($loc, $location->tree(), new Trace(''));
$gov = FunctionsPlaceUtils::loc2gov($this, $locReference);
$ps = FunctionsPlaceUtils::loc2plac($this, $locReference);
if ($ps !== null) {
$plac = $ps->getGedcomName();
} else {
$plac = '?'; //unexpected!
}
}
if ($gov === null) {
return [];
}
return $this->govHierarchiesAsFactsViaGov(
$gov,
$location,
$plac,
$locReference);
}
public static function customTypeEven(): void {
//this is just to get this string into *.po,
//actual translation is done via Fact::label
/* I18N: custom type for virtual EVEN */ I18N::translate("GOV Hierarchy");
}
protected function govHierarchiesAsFactsViaGov(
GovReference $gov,
GedcomRecord $record,
string $placeName,
?LocReference $locReference) {
/*
error_log("--------------------------------------------------------------------------------------");
error_log("--------------------------------------------------------------------------------------");
error_log("--------------------------------------------------------------------------------------");
*/
try {
$hierarchies = GovHierarchyUtils::hierarchies($this, $record->tree(), $gov, JulianDayInterval::open());
} catch (GOVServerUnavailableException $ex) {
$hierarchies = [];
$this->flashGovServerUnavailable();
}
$facts = [];
/** @var GovHierarchy $hierarchy */
foreach ($hierarchies as $hierarchy) {
$gedcom = "1 FACT";
$gedcom .= "\n2 TYPE GOV Hierarchy";
$interval = $hierarchy->interval()->asGedcomDateInterval();
$placeNameAt = $placeName;
if ($locReference === null) {
//keep fallback $placeNameAt
} else {
//use interval-based placename here (if based on actual _LOC record)
$placeAt = FunctionsPlaceUtils::loc2placAt($this, $locReference, $interval);
if ($placeAt !== null) {
$placeNameAt = $placeAt->getGedcomName();
}
}
$gedcom .= "\n2 PLAC " . $placeNameAt;
//we know the _GOV already, more efficient this way than to re-resolve it
//(resolving via plac2gov anyway isn't certain to succeed if _GOV originates from _LOC)
$gedcom .= "\n3 _GOV " . $gov->getId();
$gedcom .= $interval->toGedcomString(2, true);
//id must match styleadds key in hFactsTabGetStyleadds
$fact = new VirtualFact($gedcom, $record, 'gov-history');
$facts[] = $fact;
}
return $facts;
}
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
public static function plac2govViaMappingTable(PlaceStructure $place): ?string {
$name = $place->getPlace()->placeName();
$fullName = $place->getPlace()->gedcomName();
$placeId = $place->getPlace()->id();
//this occurs in case of new place names (respective change not approved yet)
if (!$placeId) {
return null;
}
if (!$name) {
return null;
}
return FunctionsGov::getGovId($fullName);
}
//see Date.php
//we're not supposed to use that in webtrees, nevermind
//we don't necessarily want the median year, so we have to use our own function
public static function gregorianYear($julianDay) {
$gregorian_calendar = new GregorianCalendar;
list($year) = $gregorian_calendar->jdToYmd($julianDay);
return $year;
}
public function plac2govSupported(): bool {
return true;
}
public function plac2gov(PlaceStructure $ps): ?GovReference {
//1. _GOV set directly?
$govId = $ps->getGov();
if ($govId !== null) {
$trace = new Trace('GOV-Id via Gov4Webtrees module (_GOV tag)');
return new GovReference($govId, $trace, $ps->getLevel());
}
//2. id set via mapping table?
$govId = Gov4WebtreesModule::plac2govViaMappingTable($ps);
if ($govId !== null) {
$trace = new Trace('GOV-Id via Gov4Webtrees module (mapping outside GEDCOM)');
return new GovReference($govId, $trace, $ps->getLevel());
}
return null;
}
public function gov2map(GovReference $govReference): ?MapCoordinates {
try {
$gov = FunctionsGov::retrieveGovObject($this, $govReference->getId());
} catch (GOVServerUnavailableException $ex) {
$gov = null;
$this->flashGovServerUnavailable();
}
if ($gov === null) {
return null;
}
if ($gov->getLat() === null) {
return null;
}
if ($gov->getLon() === null) {
return null;
}
$trace = $govReference->getTrace();
$trace->add('map coordinates via Gov4Webtrees module (data from GOV server)');
return new MapCoordinates($gov->getLat(), $gov->getLon(), $trace);
}
public function gov2html(
GovReference $govReference,
Tree $tree): ?GenericViewElement {
$locale = I18N::locale();
$compactDisplay = boolval($this->getPreference('COMPACT_DISPLAY', '1'));
$withInternalLinks = intval($this->getPreference('DISPLAY_INTERNAL_LINKS', '1'));
$showSettlements = boolval($this->getPreference('ALLOW_SETTLEMENTS', '1'));
$showOrganizational = boolval($this->getPreference('ALLOW_ORGANIZATIONAL', '1'));
$dateTime = new DateTime();
$dateTime->format('Y-m-d');
$julianDay2 = cal_to_jd(CAL_GREGORIAN, $dateTime->format("m"), $dateTime->format("d"), $dateTime->format("Y"));
$tooltip = null;
$debugGovSource = $this->getPreference('DEBUG_GOV_SOURCE', '1');
if ($debugGovSource) {
$tooltip .= $govReference->getTrace()->getAll();
}
$str2 = GenericViewElement::createEmpty();
$julianDayText = I18N::translate('today');
try {
$str2 = $this->getHierarchy(
$compactDisplay,
$withInternalLinks,
$showSettlements,
$showOrganizational,
$locale,
$julianDay2,
$julianDayText,
$govReference,
$tree,
$tooltip);
return $str2;
} catch (GOVServerUnavailableException $ex) {
$this->flashGovServerUnavailable();
return null;
}
}
public function govPgov(
GovReference $govReference,
GedcomDateInterval $dateInterval,
Collection $typesOfLocation,
int $maxLevels = PHP_INT_MAX): Collection {
try {
return $this->govPgovInternal(
$govReference,
$dateInterval,
$typesOfLocation,
$maxLevels);
} catch (GOVServerUnavailableException $ex) {
$this->flashGovServerUnavailable();
return new Collection();
}
}
protected function govPgovInternal(
GovReference $govReference,
GedcomDateInterval $dateInterval,
Collection $typesOfLocation,
int $maxLevels = PHP_INT_MAX): Collection {
$useMedianDate = boolval($this->getPreference('USE_MEDIAN_DATE', '0'));
$showSettlements = boolval($this->getPreference('ALLOW_SETTLEMENTS', '1'));
$showOrganizational = boolval($this->getPreference('ALLOW_ORGANIZATIONAL', '1'));
if ($useMedianDate) {
$julianDay = $dateInterval->getMedian();
} else {
$julianDay = $dateInterval->getMin();
}
if ($julianDay === null) {
return new Collection();
}
$govId = $govReference->getId();
$ret = new Collection();
$gov = FunctionsGov::retrieveGovObject($this, $govId);
//load hierarchy (one per type of location)
foreach ($typesOfLocation as $typeOfLocation) {
$types = array();
$typesFallback1 = array();
$typesFallback2 = array();
if ("POLI" === $typeOfLocation) {
$types = FunctionsGov::admTypes();
//if ($showSettlements) {
//allways fallback, but perhaps don't show
$typesFallback1 = FunctionsGov::settlementTypes();
//}
//if ($showOrganizational) {
//allways fallback, but perhaps don't show
$typesFallback2 = FunctionsGov::orgTypes();
//}
} else if ("RELI" === $typeOfLocation) {
$types = FunctionsGov::religiousTypes();
}
//"GEOG", "CULT" not supported yet!
$currentGov = $gov;
$currentGovId = $govId;
$currentLevel = 0;
//TODO: use from/to rather than single julianDay?
while (($currentGov !== null) && ($maxLevels-- > 0)) {
//next hierarchy level (if any)
$nextGovId = null;
$currentLevel++;
if (sizeOf($types) > 0) {
$nextGovId = FunctionsGov::findGovParentOfType($this, $currentGovId, $currentGov, $julianDay, $types, $gov->getVersion());
$show = true;
}
if (($nextGovId->getId() === null) && (sizeOf($typesFallback1) > 0)) {
$nextGovId = FunctionsGov::findGovParentOfType($this, $currentGovId, $currentGov, $julianDay, $typesFallback1, $gov->getVersion());
$show = $showSettlements;
}
if (($nextGovId->getId() === null) && (sizeOf($typesFallback2) > 0)) {
$nextGovId = FunctionsGov::findGovParentOfType($this, $currentGovId, $currentGov, $julianDay, $typesFallback2, $gov->getVersion());
$show = $showOrganizational;
}
if ($nextGovId->getId() === null) {
break;
}
$currentGovId = $nextGovId->getId();
$currentGov = FunctionsGov::retrieveGovObject($this, $currentGovId);
if ($show && ($currentGov !== null)) {
$trace = $govReference->getTrace();
$trace->add('GOV-Id via Gov4Webtrees module (hierarchy)');
$ret->add(new GovReference(
$currentGovId,
$trace,
$currentLevel));
}
}
}
return $ret;
}
public function gov2plac(GovReference $gov, Tree $tree): ?PlaceStructure {
$ids = new Collection([$gov->getId()]);
$valid_place_id = FunctionsGov::getNamesMappedToGovIds($ids)
//there may be more than one mapping, we use the first for which a place exists
->filter(function (string $place_id) use ($tree): bool {
// Request for a non-existent place?
//WTF SearchService
$query = implode(',', explode(', ', $place_id));
//searching for 'x' may find place 'x, y, z'
//we're only interested in exact matches!
//there should be a better SearchService method for this!
$place = $this->search_service->searchPlaces($tree, $query, 0, 1)
->filter(function (Place $place) use ($place_id): bool {
return ($place->gedcomName() == $place_id);
})
->first();
if ($place === null) {
//gov id has been mapped, but place no longer exists (at least not in this tree)
//or it's a gov-id retrieved e.g. via gov parent hierarchy
return false;
}
return true;
})
->first();
if ($valid_place_id === null) {
//we haven't mapped this gov id at all, cannot use the $place_id
//(we mustn't use the gov name of the place - it may clash with other placenames!)
//or
//gov id has been mapped, but place no longer exists (at least not in this tree)
//or it's a gov-id retrieved e.g. via gov parent hierarchy
return null;
}
//set the _GOV tag to make further operations on this object more efficient
//(we don't have to look it up again)
return PlaceStructure::fromNameAndGov($valid_place_id, $gov->getId(), $tree);
}
////////////////////////////////////////////////////////////////////////////////
public function factPlaceAdditionsBeforePlace(PlaceStructure $place): ?string {
return null;
}
public function factPlaceAdditionsAfterMap(PlaceStructure $place): ?string {
$fpa = $this->factPlaceAdditions($place);
return ($fpa === null) ? null : $fpa->getMain();