Passed
Pull Request — main (#4945)
by
unknown
06:07
created

ReportParserGenerate::substituteVars()   A

Complexity

Conditions 3
Paths 1

Size

Total Lines 18
Code Lines 10

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 3
eloc 10
nc 1
nop 2
dl 0
loc 18
rs 9.9332
c 0
b 0
f 0
1
<?php
2
3
/**
4
 * webtrees: online genealogy
5
 * Copyright (C) 2023 webtrees development team
6
 * This program is free software: you can redistribute it and/or modify
7
 * it under the terms of the GNU General Public License as published by
8
 * the Free Software Foundation, either version 3 of the License, or
9
 * (at your option) any later version.
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
 * You should have received a copy of the GNU General Public License
15
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
16
 */
17
18
declare(strict_types=1);
19
20
namespace Fisharebest\Webtrees\Report;
21
22
use DomainException;
23
use Fisharebest\Webtrees\Auth;
24
use Fisharebest\Webtrees\Date;
25
use Fisharebest\Webtrees\DB;
26
use Fisharebest\Webtrees\Elements\UnknownElement;
27
use Fisharebest\Webtrees\Factories\MarkdownFactory;
28
use Fisharebest\Webtrees\Family;
29
use Fisharebest\Webtrees\Gedcom;
30
use Fisharebest\Webtrees\GedcomRecord;
31
use Fisharebest\Webtrees\I18N;
32
use Fisharebest\Webtrees\Individual;
33
use Fisharebest\Webtrees\Log;
34
use Fisharebest\Webtrees\MediaFile;
35
use Fisharebest\Webtrees\Note;
36
use Fisharebest\Webtrees\Place;
37
use Fisharebest\Webtrees\Registry;
38
use Fisharebest\Webtrees\Tree;
39
use Illuminate\Database\Query\Builder;
40
use Illuminate\Database\Query\Expression;
41
use Illuminate\Database\Query\JoinClause;
42
use Illuminate\Support\Str;
43
use LogicException;
44
use Symfony\Component\Cache\Adapter\NullAdapter;
45
use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
46
use XMLParser;
47
48
use function addcslashes;
49
use function addslashes;
50
use function array_pop;
51
use function array_shift;
52
use function assert;
53
use function count;
54
use function end;
55
use function explode;
56
use function file;
57
use function file_exists;
58
use function getimagesize;
59
use function imagecreatefromstring;
60
use function imagesx;
61
use function imagesy;
62
use function in_array;
63
use function ltrim;
64
use function method_exists;
65
use function preg_match;
66
use function preg_match_all;
67
use function preg_replace;
68
use function preg_replace_callback;
69
use function preg_split;
70
use function reset;
71
use function round;
72
use function sprintf;
73
use function str_contains;
74
use function str_ends_with;
75
use function str_replace;
76
use function str_starts_with;
77
use function strip_tags;
78
use function strlen;
79
use function strpos;
80
use function strtoupper;
81
use function substr;
82
use function substr_replace;
83
use function trim;
84
use function uasort;
85
use function xml_error_string;
86
use function xml_get_current_line_number;
87
use function xml_get_error_code;
88
use function xml_parse;
89
use function xml_parser_create;
90
use function xml_parser_free;
91
use function xml_parser_set_option;
92
use function xml_set_character_data_handler;
93
use function xml_set_element_handler;
94
95
use const PREG_OFFSET_CAPTURE;
96
use const PREG_SET_ORDER;
97
use const XML_OPTION_CASE_FOLDING;
98
99
/**
100
 * Class ReportParserGenerate - parse a report.xml file and generate the report.
101
 */
102
class ReportParserGenerate extends ReportParserBase
103
{
104
    /** Are we collecting data from <Footnote> elements */
105
    private bool $process_footnote = true;
106
107
    /** Are we currently outputting data? */
108
    private bool $print_data = false;
109
110
    /** @var array<int,bool> Push-down stack of $print_data */
111
    private array $print_data_stack = [];
112
113
    /** Are we processing GEDCOM data */
114
    private int $process_gedcoms = 0;
115
116
    /** Are we processing conditionals */
117
    private int $process_ifs = 0;
118
119
    /** Are we processing repeats */
120
    private int $process_repeats = 0;
121
122
    /** Quantity of data to repeat during loops */
123
    private int $repeat_bytes = 0;
124
125
    /** @var array<string> Repeated data when iterating over loops */
126
    private array $repeats = [];
127
128
    /** @var array<int,array<int,array<string>|int>> Nested repeating data */
129
    private array $repeats_stack = [];
130
131
    /** @var array<AbstractRenderer> Nested repeating data */
132
    private array $wt_report_stack = [];
133
134
    // Nested repeating data
135
    private XMLParser $parser;
136
137
    /** @var XMLParser[] (resource[] before PHP 8.0) Nested repeating data */
138
    private array $parser_stack = [];
139
140
    /** The current GEDCOM record */
141
    private string $gedrec = '';
142
143
    /** @var array<int,array<int,string>> Nested GEDCOM records */
144
    private array $gedrec_stack = [];
145
146
    /** @var ReportBaseElement The currently processed element */
147
    private $current_element;
148
149
    /** @var ReportBaseElement The currently processed element */
150
    private $footnote_element;
151
152
    /** The GEDCOM fact currently being processed */
153
    private string $fact = '';
154
155
    /** The GEDCOM value currently being processed */
156
    private string $desc = '';
157
158
    /** The GEDCOM type currently being processed */
159
    private string $type = '';
160
161
    /** The current generational level */
162
    private int $generation = 1;
163
164
    /** @var array<static|GedcomRecord> Source data for processing lists */
165
    private array $list = [];
166
167
    /** Number of items in lists */
168
    private int $list_total = 0;
169
170
    /** Number of items filtered from lists */
171
    private int $list_private = 0;
172
173
    /** @var string The filename of the XML report */
174
    protected $report;
175
176
    /** @var AbstractRenderer A factory for creating report elements */
177
    private $report_root;
178
179
    /** @var AbstractRenderer Nested report elements */
180
    private $wt_report;
181
182
    /** @var array<array<string>> Variables defined in the report at run-time */
183
    private array $vars;
184
185
    /** @var array<string> Family relationship */
186
    private array $mfrelation = [];
187
188
    private Tree $tree;
189
190
    /**
191
     * Create a parser for a report
192
     *
193
     * @param string               $report The XML filename
194
     * @param AbstractRenderer     $report_root
195
     * @param array<array<string>> $vars
196
     * @param Tree                 $tree
197
     */
198
    public function __construct(string $report, AbstractRenderer $report_root, array $vars, Tree $tree)
199
    {
200
        $this->report          = $report;
201
        $this->report_root     = $report_root;
202
        $this->wt_report       = $report_root;
203
        $this->current_element = new ReportBaseElement();
204
        $this->vars            = $vars;
205
        $this->tree            = $tree;
206
207
        parent::__construct($report);
208
    }
209
210
    /**
211
     * get a gedcom subrecord
212
     *
213
     * searches a gedcom record and returns a subrecord of it. A subrecord is defined starting at a
214
     * line with level N and all subsequent lines greater than N until the next N level is reached.
215
     * For example, the following is a BIRT subrecord:
216
     * <code>1 BIRT
217
     * 2 DATE 1 JAN 1900
218
     * 2 PLAC Phoenix, Maricopa, Arizona</code>
219
     * The following example is the DATE subrecord of the above BIRT subrecord:
220
     * <code>2 DATE 1 JAN 1900</code>
221
     *
222
     * @param int    $level   the N level of the subrecord to get
223
     * @param string $tag     a gedcom tag or string to search for in the record (ie 1 BIRT or 2 DATE)
224
     * @param string $gedrec  the parent gedcom record to search in
225
     * @param int    $num     this allows you to specify which matching <var>$tag</var> to get. Oftentimes a
226
     *                        gedcom record will have more that 1 of the same type of subrecord. An individual may have
227
     *                        multiple events for example. Passing $num=1 would get the first 1. Passing $num=2 would get the
228
     *                        second one, etc.
229
     *
230
     * @return string the subrecord that was found or an empty string "" if not found.
231
     */
232
    public static function getSubRecord(int $level, string $tag, string $gedrec, int $num = 1): string
233
    {
234
        if ($gedrec === '') {
235
            return '';
236
        }
237
        // -- adding \n before and after gedrec
238
        $gedrec       = "\n" . $gedrec . "\n";
239
        $tag          = trim($tag);
240
        $searchTarget = "~[\n]" . $tag . "[\s]~";
241
        $ct           = preg_match_all($searchTarget, $gedrec, $match, PREG_SET_ORDER | PREG_OFFSET_CAPTURE);
242
        if ($ct === 0) {
243
            return '';
244
        }
245
        if ($ct < $num) {
246
            return '';
247
        }
248
        $pos1 = $match[$num - 1][0][1];
249
        $pos2 = strpos($gedrec, "\n$level", $pos1 + 1);
250
        if (!$pos2) {
251
            $pos2 = strpos($gedrec, "\n1", $pos1 + 1);
252
        }
253
        if (!$pos2) {
254
            $pos2 = strpos($gedrec, "\nWT_", $pos1 + 1); // WT_SPOUSE, WT_FAMILY_ID ...
255
        }
256
        if (!$pos2) {
257
            return ltrim(substr($gedrec, $pos1));
258
        }
259
        $subrec = substr($gedrec, $pos1, $pos2 - $pos1);
260
261
        return ltrim($subrec);
262
    }
263
264
    /**
265
     * get CONT lines
266
     *
267
     * get the N+1 CONT or CONC lines of a gedcom subrecord
268
     *
269
     * @param int    $nlevel the level of the CONT lines to get
270
     * @param string $nrec   the gedcom subrecord to search in
271
     *
272
     * @return string a string with all CONT lines merged
273
     */
274
    public static function getCont(int $nlevel, string $nrec): string
275
    {
276
        $text = '';
277
278
        $subrecords = explode("\n", $nrec);
279
        foreach ($subrecords as $thisSubrecord) {
280
            if (substr($thisSubrecord, 0, 2) !== $nlevel . ' ') {
281
                continue;
282
            }
283
            $subrecordType = substr($thisSubrecord, 2, 4);
284
            if ($subrecordType === 'CONT') {
285
                $text .= "\n" . substr($thisSubrecord, 7);
286
            }
287
        }
288
289
        return $text;
290
    }
291
292
    /**
293
     * XML start element handler
294
     * This function is called whenever a starting element is reached
295
     * The element handler will be called if found, otherwise it must be HTML
296
     *
297
     * @param resource      $parser the resource handler for the XML parser
298
     * @param string        $name   the name of the XML element parsed
299
     * @param array<string> $attrs  an array of key value pairs for the attributes
300
     *
301
     * @return void
302
     */
303
    protected function startElement($parser, string $name, array $attrs): void
304
    {
305
        $newattrs = [];
306
307
        foreach ($attrs as $key => $value) {
308
            if (preg_match("/^\\$(\w+)$/", $value, $match)) {
309
                if (isset($this->vars[$match[1]]['id']) && !isset($this->vars[$match[1]]['gedcom'])) {
310
                    $value = $this->vars[$match[1]]['id'];
311
                }
312
            }
313
            $newattrs[$key] = $value;
314
        }
315
        $attrs = $newattrs;
316
        if ($this->process_footnote && ($this->process_ifs === 0 || $name === 'if') && ($this->process_gedcoms === 0 || $name === 'Gedcom') && ($this->process_repeats === 0 || $name === 'Facts' || $name === 'RepeatTag')) {
317
            $method = $name . 'StartHandler';
318
319
            if (method_exists($this, $method)) {
320
                $this->{$method}($attrs);
321
            }
322
        }
323
    }
324
325
    /**
326
     * XML end element handler
327
     * This function is called whenever an ending element is reached
328
     * The element handler will be called if found, otherwise it must be HTML
329
     *
330
     * @param resource $parser the resource handler for the XML parser
331
     * @param string   $name   the name of the XML element parsed
332
     *
333
     * @return void
334
     */
335
    protected function endElement($parser, string $name): void
336
    {
337
        if (($this->process_footnote || $name === 'Footnote') && ($this->process_ifs === 0 || $name === 'if') && ($this->process_gedcoms === 0 || $name === 'Gedcom') && ($this->process_repeats === 0 || $name === 'Facts' || $name === 'RepeatTag' || $name === 'List' || $name === 'Relatives')) {
338
            $method = $name . 'EndHandler';
339
340
            if (method_exists($this, $method)) {
341
                $this->{$method}();
342
            }
343
        }
344
    }
345
346
    /**
347
     * XML character data handler
348
     *
349
     * @param resource $parser the resource handler for the XML parser
350
     * @param string   $data   the name of the XML element parsed
351
     *
352
     * @return void
353
     */
354
    protected function characterData($parser, string $data): void
355
    {
356
        if ($this->print_data && $this->process_gedcoms === 0 && $this->process_ifs === 0 && $this->process_repeats === 0) {
357
            $this->current_element->addText($data);
358
        }
359
    }
360
361
    /**
362
     * Handle <style>
363
     *
364
     * @param array<string> $attrs
365
     *
366
     * @return void
367
     */
368
    protected function styleStartHandler(array $attrs): void
369
    {
370
        if (empty($attrs['name'])) {
371
            throw new DomainException('REPORT ERROR Style: The "name" of the style is missing or not set in the XML file.');
372
        }
373
374
        $style = [
375
            'name'  => $attrs['name'],
376
            'font'  => $attrs['font'] ?? $this->wt_report->default_font,
377
            'size'  => (float) ($attrs['size'] ?? $this->wt_report->default_font_size),
378
            'style' => $attrs['style'] ?? '',
379
        ];
380
381
        $this->wt_report->addStyle($style);
382
    }
383
384
    /**
385
     * Handle <doc>
386
     * Sets up the basics of the document proparties
387
     *
388
     * @param array<string> $attrs
389
     *
390
     * @return void
391
     */
392
    protected function docStartHandler(array $attrs): void
393
    {
394
        $this->parser = $this->xml_parser;
395
396
        // Custom page width
397
        if (!empty($attrs['customwidth'])) {
398
            $this->wt_report->page_width = (float) $attrs['customwidth'];
399
        }
400
        // Custom Page height
401
        if (!empty($attrs['customheight'])) {
402
            $this->wt_report->page_height = (float) $attrs['customheight'];
403
        }
404
405
        // Left Margin
406
        if (isset($attrs['leftmargin'])) {
407
            if ($attrs['leftmargin'] === '0') {
408
                $this->wt_report->left_margin = 0;
409
            } elseif (!empty($attrs['leftmargin'])) {
410
                $this->wt_report->left_margin = (float) $attrs['leftmargin'];
411
            }
412
        }
413
        // Right Margin
414
        if (isset($attrs['rightmargin'])) {
415
            if ($attrs['rightmargin'] === '0') {
416
                $this->wt_report->right_margin = 0;
417
            } elseif (!empty($attrs['rightmargin'])) {
418
                $this->wt_report->right_margin = (float) $attrs['rightmargin'];
419
            }
420
        }
421
        // Top Margin
422
        if (isset($attrs['topmargin'])) {
423
            if ($attrs['topmargin'] === '0') {
424
                $this->wt_report->top_margin = 0;
425
            } elseif (!empty($attrs['topmargin'])) {
426
                $this->wt_report->top_margin = (float) $attrs['topmargin'];
427
            }
428
        }
429
        // Bottom Margin
430
        if (isset($attrs['bottommargin'])) {
431
            if ($attrs['bottommargin'] === '0') {
432
                $this->wt_report->bottom_margin = 0;
433
            } elseif (!empty($attrs['bottommargin'])) {
434
                $this->wt_report->bottom_margin = (float) $attrs['bottommargin'];
435
            }
436
        }
437
        // Header Margin
438
        if (isset($attrs['headermargin'])) {
439
            if ($attrs['headermargin'] === '0') {
440
                $this->wt_report->header_margin = 0;
441
            } elseif (!empty($attrs['headermargin'])) {
442
                $this->wt_report->header_margin = (float) $attrs['headermargin'];
443
            }
444
        }
445
        // Footer Margin
446
        if (isset($attrs['footermargin'])) {
447
            if ($attrs['footermargin'] === '0') {
448
                $this->wt_report->footer_margin = 0;
449
            } elseif (!empty($attrs['footermargin'])) {
450
                $this->wt_report->footer_margin = (float) $attrs['footermargin'];
451
            }
452
        }
453
454
        // Page Orientation
455
        if (!empty($attrs['orientation'])) {
456
            if ($attrs['orientation'] === 'landscape') {
457
                $this->wt_report->orientation = 'landscape';
458
            } elseif ($attrs['orientation'] === 'portrait') {
459
                $this->wt_report->orientation = 'portrait';
460
            }
461
        }
462
        // Page Size
463
        if (!empty($attrs['pageSize'])) {
464
            $this->wt_report->page_format = $attrs['pageSize'];
465
        }
466
467
        // Show Generated By...
468
        if (isset($attrs['showGeneratedBy'])) {
469
            if ($attrs['showGeneratedBy'] === '0') {
470
                $this->wt_report->show_generated_by = false;
471
            } elseif ($attrs['showGeneratedBy'] === '1') {
472
                $this->wt_report->show_generated_by = true;
473
            }
474
        }
475
476
        $this->wt_report->setup();
477
    }
478
479
    /**
480
     * Handle </doc>
481
     *
482
     * @return void
483
     */
484
    protected function docEndHandler(): void
485
    {
486
        $this->wt_report->run();
487
    }
488
489
    /**
490
     * Handle <header>
491
     *
492
     * @return void
493
     */
494
    protected function headerStartHandler(): void
495
    {
496
        // Clear the Header before any new elements are added
497
        $this->wt_report->clearHeader();
498
        $this->wt_report->setProcessing('H');
499
    }
500
501
    /**
502
     * Handle <body>
503
     *
504
     * @return void
505
     */
506
    protected function bodyStartHandler(): void
507
    {
508
        $this->wt_report->setProcessing('B');
509
    }
510
511
    /**
512
     * Handle <footer>
513
     *
514
     * @return void
515
     */
516
    protected function footerStartHandler(): void
517
    {
518
        $this->wt_report->setProcessing('F');
519
    }
520
521
    /**
522
     * Handle <cell>
523
     *
524
     * @param array<string,string> $attrs
525
     *
526
     * @return void
527
     */
528
    protected function cellStartHandler(array $attrs): void
529
    {
530
        // string The text alignment of the text in this box.
531
        $align = $attrs['align'] ?? '';
532
        // RTL supported left/right alignment
533
        if ($align === 'rightrtl') {
534
            if ($this->wt_report->rtl) {
535
                $align = 'left';
536
            } else {
537
                $align = 'right';
538
            }
539
        } elseif ($align === 'leftrtl') {
540
            if ($this->wt_report->rtl) {
541
                $align = 'right';
542
            } else {
543
                $align = 'left';
544
            }
545
        }
546
547
        // The color to fill the background of this cell
548
        $bgcolor = $attrs['bgcolor'] ?? '';
549
550
        // Whether the background should be painted
551
        $fill = (bool) ($attrs['fill'] ?? '0');
552
553
        // If true reset the last cell height
554
        $reseth = (bool) ($attrs['reseth'] ?? '1');
555
556
        // Whether a border should be printed around this box
557
        $border = $attrs['border'] ?? '';
558
559
        // string Border color in HTML code
560
        $bocolor = $attrs['bocolor'] ?? '';
561
562
        // Cell height (expressed in points) The starting height of this cell. If the text wraps the height will automatically be adjusted.
563
        $height = (int) ($attrs['height'] ?? '0');
564
565
        // int Cell width (expressed in points) Setting the width to 0 will make it the width from the current location to the right margin.
566
        $width = (int) ($attrs['width'] ?? '0');
567
568
        // Stretch character mode
569
        $stretch = (int) ($attrs['stretch'] ?? '0');
570
571
        // mixed Position the left corner of this box on the page. The default is the current position.
572
        $left = ReportBaseElement::CURRENT_POSITION;
573
        if (isset($attrs['left'])) {
574
            if ($attrs['left'] === '.') {
575
                $left = ReportBaseElement::CURRENT_POSITION;
576
            } elseif (!empty($attrs['left'])) {
577
                $left = (float) $attrs['left'];
578
            } elseif ($attrs['left'] === '0') {
579
                $left = 0.0;
580
            }
581
        }
582
        // mixed Position the top corner of this box on the page. the default is the current position
583
        $top = ReportBaseElement::CURRENT_POSITION;
584
        if (isset($attrs['top'])) {
585
            if ($attrs['top'] === '.') {
586
                $top = ReportBaseElement::CURRENT_POSITION;
587
            } elseif (!empty($attrs['top'])) {
588
                $top = (float) $attrs['top'];
589
            } elseif ($attrs['top'] === '0') {
590
                $top = 0.0;
591
            }
592
        }
593
594
        // The name of the Style that should be used to render the text.
595
        $style = $attrs['style'] ?? '';
596
597
        // string Text color in html code
598
        $tcolor = $attrs['tcolor'] ?? '';
599
600
        // int Indicates where the current position should go after the call.
601
        $ln = 0;
602
        if (isset($attrs['newline'])) {
603
            if (!empty($attrs['newline'])) {
604
                $ln = (int) $attrs['newline'];
605
            } elseif ($attrs['newline'] === '0') {
606
                $ln = 0;
607
            }
608
        }
609
610
        if ($align === 'left') {
611
            $align = 'L';
612
        } elseif ($align === 'right') {
613
            $align = 'R';
614
        } elseif ($align === 'center') {
615
            $align = 'C';
616
        } elseif ($align === 'justify') {
617
            $align = 'J';
618
        }
619
620
        $this->print_data_stack[] = $this->print_data;
621
        $this->print_data         = true;
622
623
        $this->current_element = $this->report_root->createCell(
624
            (int) $width,
625
            (int) $height,
626
            $border,
627
            $align,
628
            $bgcolor,
629
            $style,
630
            $ln,
631
            $top,
632
            $left,
633
            $fill,
634
            $stretch,
635
            $bocolor,
636
            $tcolor,
637
            $reseth
638
        );
639
640
        // set string URL to be a link
641
        if (isset($attrs['url'])) {
642
            $url = $attrs['url'];
643
            $this->current_element->setUrl($url);
644
        } else {
645
            $url = "";
0 ignored issues
show
Unused Code introduced by
The assignment to $url is dead and can be removed.
Loading history...
646
        }
647
    }
648
649
    /**
650
     * Handle </cell>
651
     *
652
     * @return void
653
     */
654
    protected function cellEndHandler(): void
655
    {
656
        $this->print_data = array_pop($this->print_data_stack);
657
        $this->wt_report->addElement($this->current_element);
658
    }
659
660
    /**
661
     * Handle <now />
662
     *
663
     * @return void
664
     */
665
    protected function nowStartHandler(): void
666
    {
667
        $this->current_element->addText(Registry::timestampFactory()->now()->isoFormat('LLLL'));
668
    }
669
670
    /**
671
     * Handle <pageNum />
672
     *
673
     * @return void
674
     */
675
    protected function pageNumStartHandler(): void
676
    {
677
        $this->current_element->addText('#PAGENUM#');
678
    }
679
680
    /**
681
     * Handle <totalPages />
682
     *
683
     * @return void
684
     */
685
    protected function totalPagesStartHandler(): void
686
    {
687
        $this->current_element->addText('{{:ptp:}}');
688
    }
689
690
    /**
691
     * Called at the start of an element.
692
     *
693
     * @param array<string> $attrs an array of key value pairs for the attributes
694
     *
695
     * @return void
696
     */
697
    protected function gedcomStartHandler(array $attrs): void
698
    {
699
        if ($this->process_gedcoms > 0) {
700
            $this->process_gedcoms++;
701
702
            return;
703
        }
704
705
        $tag       = $attrs['id'];
706
        $tag       = str_replace('@fact', $this->fact, $tag);
707
        $tags      = explode(':', $tag);
708
        $newgedrec = '';
709
        if (count($tags) < 2) {
710
            $tmp       = Registry::gedcomRecordFactory()->make($attrs['id'], $this->tree);
711
            $newgedrec = $tmp ? $tmp->privatizeGedcom(Auth::accessLevel($this->tree)) : '';
712
        }
713
        if (empty($newgedrec)) {
714
            $tgedrec   = $this->gedrec;
715
            $newgedrec = '';
716
            foreach ($tags as $tag) {
717
                if (preg_match('/\$(.+)/', $tag, $match)) {
718
                    if (isset($this->vars[$match[1]]['gedcom'])) {
719
                        $newgedrec = $this->vars[$match[1]]['gedcom'];
720
                    } else {
721
                        $tmp       = Registry::gedcomRecordFactory()->make($match[1], $this->tree);
722
                        $newgedrec = $tmp ? $tmp->privatizeGedcom(Auth::accessLevel($this->tree)) : '';
723
                    }
724
                } else {
725
                    if (preg_match('/@(.+)/', $tag, $match)) {
726
                        $gmatch = [];
727
                        if (preg_match("/\d $match[1] @([^@]+)@/", $tgedrec, $gmatch)) {
728
                            $tmp       = Registry::gedcomRecordFactory()->make($gmatch[1], $this->tree);
729
                            $newgedrec = $tmp ? $tmp->privatizeGedcom(Auth::accessLevel($this->tree)) : '';
730
                            $tgedrec   = $newgedrec;
731
                        } else {
732
                            $newgedrec = '';
733
                            break;
734
                        }
735
                    } else {
736
                        $level     = 1 + (int) explode(' ', trim($tgedrec))[0];
737
                        $newgedrec = self::getSubRecord($level, "$level $tag", $tgedrec);
738
                        $tgedrec   = $newgedrec;
739
                    }
740
                }
741
            }
742
        }
743
        if (!empty($newgedrec)) {
744
            $this->gedrec_stack[] = [$this->gedrec, $this->fact, $this->desc];
745
            $this->gedrec         = $newgedrec;
746
            if (preg_match("/(\d+) (_?[A-Z0-9]+) (.*)/", $this->gedrec, $match)) {
747
                $this->fact = $match[2];
748
                $this->desc = trim($match[3]);
749
            }
750
        } else {
751
            $this->process_gedcoms++;
752
        }
753
    }
754
755
    /**
756
     * Called at the end of an element.
757
     *
758
     * @return void
759
     */
760
    protected function gedcomEndHandler(): void
761
    {
762
        if ($this->process_gedcoms > 0) {
763
            $this->process_gedcoms--;
764
        } else {
765
            [$this->gedrec, $this->fact, $this->desc] = array_pop($this->gedrec_stack);
766
        }
767
    }
768
769
    /**
770
     * Handle <textBox>
771
     *
772
     * @param array<string> $attrs
773
     *
774
     * @return void
775
     */
776
    protected function textBoxStartHandler(array $attrs): void
777
    {
778
        // string Background color code
779
        $bgcolor = '';
780
        if (!empty($attrs['bgcolor'])) {
781
            $bgcolor = $attrs['bgcolor'];
782
        }
783
784
        // boolean Wether or not fill the background color
785
        $fill = true;
786
        if (isset($attrs['fill'])) {
787
            if ($attrs['fill'] === '0') {
788
                $fill = false;
789
            } elseif ($attrs['fill'] === '1') {
790
                $fill = true;
791
            }
792
        }
793
794
        // var boolean Whether or not a border should be printed around this box. 0 = no border, 1 = border. Default is 0
795
        $border = false;
796
        if (isset($attrs['border'])) {
797
            if ($attrs['border'] === '1') {
798
                $border = true;
799
            } elseif ($attrs['border'] === '0') {
800
                $border = false;
801
            }
802
        }
803
804
        // int The starting height of this cell. If the text wraps the height will automatically be adjusted
805
        $height = 0;
806
        if (!empty($attrs['height'])) {
807
            $height = (int) $attrs['height'];
808
        }
809
        // int Setting the width to 0 will make it the width from the current location to the margin
810
        $width = 0;
811
        if (!empty($attrs['width'])) {
812
            $width = (int) $attrs['width'];
813
        }
814
815
        // mixed Position the left corner of this box on the page. The default is the current position.
816
        $left = ReportBaseElement::CURRENT_POSITION;
817
        if (isset($attrs['left'])) {
818
            if ($attrs['left'] === '.') {
819
                $left = ReportBaseElement::CURRENT_POSITION;
820
            } elseif (!empty($attrs['left'])) {
821
                $left = (int) $attrs['left'];
822
            } elseif ($attrs['left'] === '0') {
823
                $left = 0;
824
            }
825
        }
826
        // mixed Position the top corner of this box on the page. the default is the current position
827
        $top = ReportBaseElement::CURRENT_POSITION;
828
        if (isset($attrs['top'])) {
829
            if ($attrs['top'] === '.') {
830
                $top = ReportBaseElement::CURRENT_POSITION;
831
            } elseif (!empty($attrs['top'])) {
832
                $top = (int) $attrs['top'];
833
            } elseif ($attrs['top'] === '0') {
834
                $top = 0;
835
            }
836
        }
837
        // position of box absolute or relative, and possibly top and height
838
        if (isset($attrs['pos'])) {
839
            $pos = $attrs['pos'];
840
            if (substr($pos, 0, 3) == 'abs') {
841
                //-- check absolute or relative position
842
                $top += -222000;
843
            }
844
            if (substr($pos, 0, 3) == 'rel') {
845
                //-- check absolute or relative position
846
                $top = -100000;
847
            }
848
            if (substr($pos, 3, 3) == '_fh') {
849
                $top = -100012;
850
            }
851
            if (substr($pos, 3, 3) == '_f2') {
852
                $top = -100018;
853
            }
854
            if (substr($pos, 6, 5) == '_html') {
855
                $top = -90012;
856
            }
857
        }
858
        // boolean After this box is finished rendering, should the next section of text start immediately after the this box or should it start on a new line under this box. 0 = no new line, 1 = force new line. Default is 0
859
        $newline = false;
860
        if (isset($attrs['newline'])) {
861
            if ($attrs['newline'] === '1') {
862
                $newline = true;
863
            } elseif ($attrs['newline'] === '0') {
864
                $newline = false;
865
            }
866
        }
867
        // boolean
868
        $pagecheck = true;
869
        if (isset($attrs['pagecheck'])) {
870
            if ($attrs['pagecheck'] === '0') {
871
                $pagecheck = false;
872
            } elseif ($attrs['pagecheck'] === '1') {
873
                $pagecheck = true;
874
            }
875
        }
876
        // boolean Cell padding
877
        $padding = true;
878
        if (isset($attrs['padding'])) {
879
            if ($attrs['padding'] === '0') {
880
                $padding = false;
881
            } elseif ($attrs['padding'] === '1') {
882
                $padding = true;
883
            }
884
        }
885
        // boolean Reset this box Height
886
        $reseth = false;
887
        if (isset($attrs['reseth'])) {
888
            if ($attrs['reseth'] === '1') {
889
                $reseth = true;
890
            } elseif ($attrs['reseth'] === '0') {
891
                $reseth = false;
892
            }
893
        }
894
895
        // string Style of rendering
896
        $style = '';
897
898
        $this->print_data_stack[] = $this->print_data;
899
        $this->print_data         = false;
900
901
        $this->wt_report_stack[] = $this->wt_report;
902
        $this->wt_report         = $this->report_root->createTextBox(
0 ignored issues
show
Documentation Bug introduced by
It seems like $this->report_root->crea...ill, $padding, $reseth) of type Fisharebest\Webtrees\Report\ReportBaseTextbox is incompatible with the declared type Fisharebest\Webtrees\Report\AbstractRenderer of property $wt_report.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
903
            $width,
904
            $height,
905
            $border,
906
            $bgcolor,
907
            $newline,
908
            $left,
909
            $top,
910
            $pagecheck,
911
            $style,
912
            $fill,
913
            $padding,
914
            $reseth
915
        );
916
    }
917
918
    /**
919
     * Handle <textBox>
920
     *
921
     * @return void
922
     */
923
    protected function textBoxEndHandler(): void
924
    {
925
        $this->print_data      = array_pop($this->print_data_stack);
926
        $this->current_element = $this->wt_report;
0 ignored issues
show
Documentation Bug introduced by
It seems like $this->wt_report of type Fisharebest\Webtrees\Report\AbstractRenderer is incompatible with the declared type Fisharebest\Webtrees\Report\ReportBaseElement of property $current_element.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
927
928
        // The TextBox handler is mis-using the wt_report attribute to store an element.
929
        // Until this can be re-designed, we need this assertion to help static analysis tools.
930
        assert($this->current_element instanceof ReportBaseElement, new LogicException());
931
932
        $this->wt_report = array_pop($this->wt_report_stack);
933
        $this->wt_report->addElement($this->current_element);
934
    }
935
936
    /**
937
     * XLM <Text>.
938
     *
939
     * @param array<string> $attrs an array of key value pairs for the attributes
940
     *
941
     * @return void
942
     */
943
    protected function textStartHandler(array $attrs): void
944
    {
945
        $this->print_data_stack[] = $this->print_data;
946
        $this->print_data         = true;
947
948
        // string The name of the Style that should be used to render the text.
949
        $style = '';
950
        if (isset($attrs['style'])) {
951
            $style = $attrs['style'];
952
        }
953
954
        // string  The color of the text - Keep the black color as default
955
        $color = '';
956
        if (isset($attrs['color'])) {
957
            $color = $attrs['color'];
958
        }
959
960
        $this->current_element = $this->report_root->createText($style, $color);
961
    }
962
963
    /**
964
     * Handle </text>
965
     *
966
     * @return void
967
     */
968
    protected function textEndHandler(): void
969
    {
970
        $this->print_data = array_pop($this->print_data_stack);
971
        $this->wt_report->addElement($this->current_element);
972
    }
973
974
    /**
975
     * Handle <getPersonName />
976
     * Get the name
977
     * 1. id is empty - current GEDCOM record
978
     * 2. id is set with a record id
979
     *
980
     * @param array<string> $attrs an array of key value pairs for the attributes
981
     *
982
     * @return void
983
     */
984
    protected function getPersonNameStartHandler(array $attrs): void
985
    {
986
        $id    = '';
987
        $match = [];
988
        if (empty($attrs['id'])) {
989
            if (preg_match('/0 @(.+)@/', $this->gedrec, $match)) {
990
                $id = $match[1];
991
            }
992
        } else {
993
            if (preg_match('/\$(.+)/', $attrs['id'], $match)) {
994
                if (isset($this->vars[$match[1]]['id'])) {
995
                    $id = $this->vars[$match[1]]['id'];
996
                }
997
            } else {
998
                if (preg_match('/@(.+)/', $attrs['id'], $match)) {
999
                    $gmatch = [];
1000
                    if (preg_match("/\d $match[1] @([^@]+)@/", $this->gedrec, $gmatch)) {
1001
                        $id = $gmatch[1];
1002
                    }
1003
                } else {
1004
                    $id = $attrs['id'];
1005
                }
1006
            }
1007
        }
1008
        $nameselect = "";
1009
        if (isset($attrs['select'])) {
1010
            $nameselect = $attrs['select'];
1011
        }
1012
        $famrel = false;
1013
        if (isset($attrs['fam_relation'])) {
1014
            $famrel = true;
1015
        }
1016
        if (!empty($id)) {
1017
            $record = Registry::gedcomRecordFactory()->make($id, $this->tree);
1018
            if ($record === null) {
1019
                return;
1020
            }
1021
            if (!$record->canShowName()) {
1022
                $this->current_element->addText(I18N::translate('Private'));
1023
            } elseif ($nameselect == 'latest') {
1024
                $tmp = $record->getAllNames();
1025
                $name  = strip_tags($tmp[count($tmp) - 1]['full']);
1026
                $this->current_element->addText(trim($name));
1027
            } elseif ($nameselect == 'combined') {
1028
                $tmp = $record->getAllNames();
1029
                $name = $tmp[count($tmp) - 1]['full'];
1030
                $ix1 = strpos($name, '<span class="starredname">');
1031
                if ($ix1 !== false) {   // '«' and '»' mark text for underlining
1032
                    $name = substr_replace($name, '«', $ix1, 26);
1033
                    $ix1 = strpos($name, '</span>', $ix1);
0 ignored issues
show
Bug introduced by
It seems like $name can also be of type array; however, parameter $haystack of strpos() does only seem to accept string, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

1033
                    $ix1 = strpos(/** @scrutinizer ignore-type */ $name, '</span>', $ix1);
Loading history...
1034
                    if ($ix1 !== false) {   // '«' and '»' mark text for underlining
1035
                        $name = substr_replace($name, '»', $ix1, 7);
1036
                    }
1037
                }
1038
                $addname = strip_tags((string) $tmp[0]['surn']);
1039
                if (!empty($addname) && !($addname === '@N.N.') && !str_contains($name, $addname)) {
1040
                    $name .= " " . I18N::translate('b.') . " " . $addname;
1041
                }
1042
                $this->current_element->addText(trim($name));
1043
            } else {
1044
                $name = $record->fullName();
1045
                $name = strip_tags($name);
1046
                if (!empty($attrs['truncate'])) {
1047
                    if ((int) $attrs['truncate'] > 0) {
1048
                        $name = Str::limit($name, (int) $attrs['truncate'], I18N::translate('…'));
1049
                    }
1050
                } else {
1051
                    $addname = (string) $record->alternateName();
1052
                    $addname = strip_tags($addname);
1053
                    if (!empty($addname)) {
1054
                        $name .= ' ' . $addname;
1055
                    }
1056
                }
1057
                $this->current_element->addText(trim($name));
1058
            }
1059
        }
1060
        if (isset($record) && $famrel && ($this->mfrelation[$record->xref()] != "")) {
1061
            $this->current_element->addText(" (" . (string) $this->mfrelation[$record->xref()] . ")");
1062
        }
1063
    }
1064
1065
    /**
1066
     * Handle <gedcomValue />
1067
     *
1068
     * @param array<string> $attrs
1069
     *
1070
     * @return void
1071
     */
1072
    protected function gedcomValueStartHandler(array $attrs): void
1073
    {
1074
        $id    = '';
1075
        $match = [];
1076
        if (preg_match('/0 @(.+)@/', $this->gedrec, $match)) {
1077
            $id = $match[1];
1078
        }
1079
1080
        if (isset($attrs['newline']) && $attrs['newline'] === '1') {
1081
            $useBreak = '1';
1082
        } else {
1083
            $useBreak = '0';
1084
        }
1085
1086
        $tag = $attrs['tag'];
1087
        if (!empty($tag)) {
1088
            if ($tag === '@desc') {
1089
                $value = $this->desc;
1090
                $value = trim($value);
1091
                $this->current_element->addText($value);
1092
            }
1093
            if ($tag === '@id') {
1094
                $this->current_element->addText($id);
1095
            } else {
1096
                $tag = str_replace('@fact', $this->fact, $tag);
1097
                if (empty($attrs['level'])) {
1098
                    $level = (int) explode(' ', trim($this->gedrec))[0];
1099
                    if ($level === 0) {
1100
                        $level++;
1101
                    }
1102
                } else {
1103
                    $level = (int) $attrs['level'];
1104
                }
1105
                $tags  = preg_split('/[: ]/', $tag);
1106
                $value = $this->getGedcomValue($tag, $level, $this->gedrec);
1107
                switch (end($tags)) {
1108
                    case 'DATE':
1109
                        $tmp   = new Date($value);
1110
                        $dfmt = "%j %F %Y";
1111
                        if (!empty($attrs['truncate'])) {
1112
                            if ($attrs['truncate'] === "d") {
1113
                                $dfmt = "%j %M %Y";
1114
                            }
1115
                            if ($attrs['truncate'] === "Y") {
1116
                                $dfmt = "%Y";
1117
                            }
1118
                        }
1119
                        $value = strip_tags($tmp->display(null, $dfmt));
1120
                        break;
1121
                    case 'PLAC':
1122
                        $tmp   = new Place($value, $this->tree);
1123
                        $value = $tmp->shortName();
1124
                        break;
1125
                }
1126
                if ($useBreak === '1') {
1127
                    // Insert <br> when multiple dates exist.
1128
                    // This works around a TCPDF bug that incorrectly wraps RTL dates on LTR pages
1129
                    $value = str_replace('(', '<br>(', $value);
1130
                    $value = str_replace('<span dir="ltr"><br>', '<br><span dir="ltr">', $value);
1131
                    $value = str_replace('<span dir="rtl"><br>', '<br><span dir="rtl">', $value);
1132
                    if (substr($value, 0, 4) === '<br>') {
1133
                        $value = substr($value, 4);
1134
                    }
1135
                }
1136
                $tmp = explode(':', $tag);
1137
                if (in_array(end($tmp), ['NOTE', 'TEXT'], true)) {
1138
                    if ($this->tree->getPreference('FORMAT_TEXT') === 'xxmarkdown') {
1139
                        $value = strip_tags(Registry::markdownFactory()->markdown($value, $this->tree), ['br']);
1140
                    } else {
1141
                        $value = str_replace("\n", "<br>", $value);
1142
                        //$value = strip_tags(Registry::markdownFactory()->autolink($value, $this->tree), ['br']);
1143
                    }
1144
                    $value = strtr($value, [MarkdownFactory::BREAK => ' ']);
1145
                }
1146
1147
                if (isset($attrs['lcfirst'])) {
1148
                    $value = lcfirst($value);
1149
                    $value = str_replace(["Å","Ä","Ö"], ["å","ä","ö"], $value);
1150
                }
1151
1152
                if (!empty($attrs['truncate'])) {
1153
                    $value = strip_tags($value);
1154
                    if ((int) $attrs['truncate'] > 0) {
1155
                        $value = Str::limit($value, (int) $attrs['truncate'], I18N::translate('…'));
1156
                    }
1157
                }
1158
                $this->current_element->addText($value);
1159
            }
1160
        }
1161
    }
1162
1163
    /**
1164
     * Handle <repeatTag>
1165
     *
1166
     * @param array<string> $attrs
1167
     *
1168
     * @return void
1169
     */
1170
    protected function repeatTagStartHandler(array $attrs): void
1171
    {
1172
        $this->process_repeats++;
1173
        if ($this->process_repeats > 1) {
1174
            return;
1175
        }
1176
1177
        $this->repeats_stack[] = [$this->repeats, $this->repeat_bytes];
1178
        $this->repeats         = [];
1179
        $this->repeat_bytes    = xml_get_current_line_number($this->parser);
1180
1181
        $tag = $attrs['tag'] ?? '';
1182
        if (!empty($tag)) {
1183
            if ($tag === '@desc') {
1184
                $value = $this->desc;
1185
                $value = trim($value);
1186
                $this->current_element->addText($value);
1187
            } else {
1188
                $tag   = str_replace('@fact', $this->fact, $tag);
1189
                $tags  = explode(':', $tag);
1190
                $level = (int) explode(' ', trim($this->gedrec))[0];
1191
                if ($level === 0) {
1192
                    $level++;
1193
                }
1194
                $subrec = $this->gedrec;
1195
                $t      = $tag;
1196
                $count  = count($tags);
1197
                $i      = 0;
1198
                while ($i < $count) {
1199
                    $t = $tags[$i];
1200
                    if (!empty($t)) {
1201
                        if ($i < ($count - 1)) {
1202
                            $subrec = self::getSubRecord($level, "$level $t", $subrec);
1203
                            if (empty($subrec)) {
1204
                                $level--;
1205
                                $subrec = self::getSubRecord($level, "@ $t", $this->gedrec);
1206
                                if (empty($subrec)) {
1207
                                    return;
1208
                                }
1209
                            }
1210
                        }
1211
                        $level++;
1212
                    }
1213
                    $i++;
1214
                }
1215
                $level--;
1216
                $count = preg_match_all("/$level $t(.*)/", $subrec, $match, PREG_SET_ORDER);
1217
                $i     = 0;
1218
                while ($i < $count) {
1219
                    $i++;
1220
                    // Privacy check - is this a link, and are we allowed to view the linked object?
1221
                    $subrecord = self::getSubRecord($level, "$level $t", $subrec, $i);
1222
                    if (preg_match('/^\d ' . Gedcom::REGEX_TAG . ' @(' . Gedcom::REGEX_XREF . ')@/', $subrecord, $xref_match)) {
1223
                        $linked_object = Registry::gedcomRecordFactory()->make($xref_match[1], $this->tree);
1224
                        if ($linked_object && !$linked_object->canShow()) {
1225
                            //continue;
1226
                        }
1227
                    }
1228
                    $this->repeats[] = $subrecord;
1229
                }
1230
            }
1231
        }
1232
    }
1233
1234
    /**
1235
     * Handle </repeatTag>
1236
     *
1237
     * @var mixed $rep
1238
     * @return void
1239
     */
1240
    protected function repeatTagEndHandler(): void
1241
    {
1242
        $this->process_repeats--;
1243
        if ($this->process_repeats > 0) {
1244
            return;
1245
        }
1246
1247
        $nnnn = count($this->repeats);
0 ignored issues
show
Unused Code introduced by
The assignment to $nnnn is dead and can be removed.
Loading history...
1248
        $rpt1 = isset($this->repeats[0]) ? $this->repeats[0] : "";
0 ignored issues
show
Unused Code introduced by
The assignment to $rpt1 is dead and can be removed.
Loading history...
1249
        // Check if there is anything to repeat
1250
        if (count($this->repeats) > 0) {
1251
            // No need to load them if not used...
1252
1253
            //-- read the xml from the file
1254
            $lines = file($this->report);
1255
            $lineoffset = 0;
1256
            foreach ($this->repeats_stack as $rep) {
1257
                $lineoffset = $lineoffset + (int) $rep[1] - 1;
1258
            }
1259
            while (!str_contains($lines[$lineoffset + $this->repeat_bytes], '<RepeatTag')) {
1260
                $lineoffset--;
1261
            }
1262
            $lineoffset++;
1263
            $reportxml = "<tempdoc>\n";
1264
            $line_nr   = $lineoffset + $this->repeat_bytes;
1265
            $lnnn = $line_nr;
0 ignored issues
show
Unused Code introduced by
The assignment to $lnnn is dead and can be removed.
Loading history...
1266
            // RepeatTag Level counter
1267
            $count = 1;
1268
            while (0 < $count) {
1269
                if (str_contains($lines[$line_nr], '<RepeatTag')) {
1270
                    $count++;
1271
                } elseif (str_contains($lines[$line_nr], '</RepeatTag')) {
1272
                    $count--;
1273
                }
1274
                if (0 < $count) {
1275
                    $reportxml .= $lines[$line_nr];
1276
                }
1277
                $line_nr++;
1278
            }
1279
            // No need to drag this
1280
            unset($lines);
1281
            $reportxml .= "</tempdoc>\n";
1282
            // Save original values
1283
            $this->parser_stack[] = $this->parser;
1284
            $oldgedrec            = $this->gedrec;
1285
            foreach ($this->repeats as $gedrec) {
1286
                $this->gedrec  = $gedrec;
1287
                $repeat_parser = xml_parser_create();
1288
                $this->parser  = $repeat_parser;
1289
                xml_parser_set_option($repeat_parser, XML_OPTION_CASE_FOLDING, 0);
1290
1291
                xml_set_element_handler(
1292
                    $repeat_parser,
1293
                    function ($parser, string $name, array $attrs): void {
1294
                        $this->startElement($parser, $name, $attrs);
1295
                    },
1296
                    function ($parser, string $name): void {
1297
                        $this->endElement($parser, $name);
1298
                    }
1299
                );
1300
1301
                xml_set_character_data_handler(
1302
                    $repeat_parser,
1303
                    function ($parser, string $data): void {
1304
                        $this->characterData($parser, $data);
1305
                    }
1306
                );
1307
1308
                if (!xml_parse($repeat_parser, $reportxml, true)) {
1309
                    throw new DomainException(sprintf(
1310
                        'RepeatTagEHandler XML error: %s at line %d',
1311
                        xml_error_string(xml_get_error_code($repeat_parser)),
1312
                        xml_get_current_line_number($repeat_parser)
1313
                    ));
1314
                }
1315
                xml_parser_free($repeat_parser);
1316
            }
1317
            // Restore original values
1318
            $this->gedrec = $oldgedrec;
1319
            $this->parser = array_pop($this->parser_stack);
1320
        }
1321
        [$this->repeats, $this->repeat_bytes] = array_pop($this->repeats_stack);
1322
    }
1323
1324
    /**
1325
     * Variable lookup
1326
     * Retrieve predefined variables :
1327
     * @ desc GEDCOM fact description, example:
1328
     *        1 EVEN This is a description
1329
     * @ fact GEDCOM fact tag, such as BIRT, DEAT etc.
1330
     * $ I18N::translate('....')
1331
     * $ language_settings[]
1332
     *
1333
     * @param array<string> $attrs an array of key value pairs for the attributes
1334
     *
1335
     * @return void
1336
     */
1337
    protected function varStartHandler(array $attrs): void
1338
    {
1339
        if (!isset($attrs['var'])) {
1340
            throw new DomainException('REPORT ERROR var: The attribute "var=" is missing or not set in the XML file on line: ' . xml_get_current_line_number($this->parser));
1341
        }
1342
1343
        $var = $attrs['var'];
1344
        // SetVar element preset variables
1345
        if (!empty($this->vars[$var]['id'])) {
1346
            $var = $this->vars[$var]['id'];
1347
        } else {
1348
            $tfact = $this->fact;
1349
            if (($this->fact === 'EVEN' || $this->fact === 'FACT') && $this->type !== '') {
1350
                // Use :
1351
                // n TYPE This text if string
1352
                $tfact = $this->type;
1353
            } else {
1354
                foreach ([Individual::RECORD_TYPE, Family::RECORD_TYPE] as $record_type) {
1355
                    $element = Registry::elementFactory()->make($record_type . ':' . $this->fact);
1356
1357
                    if (!$element instanceof UnknownElement) {
1358
                        $tfact = $element->label();
1359
                        break;
1360
                    }
1361
                }
1362
            }
1363
1364
            $var = strtr($var, ['@desc' => $this->desc, '@fact' => $tfact]);
1365
1366
            if (preg_match('/^I18N::number\((.+)\)$/', $var, $match)) {
1367
                $var = I18N::number((int) $match[1]);
1368
            } elseif (preg_match('/^I18N::translate\(\'(.+)\'\)$/', $var, $match)) {
1369
                $var = I18N::translate($match[1]);
1370
            } elseif (preg_match('/^I18N::translate\(\$(.+)\)$/', $var, $match)) {
1371
                $var = I18N::translate($this->vars[$match[1]]['id']);
1372
            } elseif (preg_match('/^I18N::translateContext\(\'(.+)\', *\'(.+)\'\)$/', $var, $match)) {
1373
                $var = I18N::translateContext($match[1], $match[2]);
1374
            }
1375
        }
1376
        // Check if variable is set as a date and reformat the date
1377
        if (isset($attrs['date'])) {
1378
            if ($attrs['date'] === '1') {
1379
                $g   = new Date($var);
1380
                $var = $g->display();
1381
            }
1382
        }
1383
        if (isset($attrs['amp'])) {
1384
            $var = str_replace("%26", '&', $var);
1385
        }
1386
        if (isset($attrs['cut'])) {
1387
            $cut = (int) $attrs['cut'];
1388
            $var = $cut > 0 ? substr($var, 0, $cut) : substr($var, $cut);
1389
            if ($cut == 0) {
1390
                $var = "";
1391
            }
1392
        }
1393
        if (isset($attrs['lcfirst'])) {
1394
            $var = lcfirst($var);
1395
        }
1396
        $this->current_element->addText($var);
1397
        $this->text = $var; // Used for title/description
1398
    }
1399
1400
    /**
1401
     * Handle <facts>
1402
     *
1403
     * @param array<string> $attrs
1404
     *
1405
     * @return void
1406
     */
1407
    protected function factsStartHandler(array $attrs): void
1408
    {
1409
        $this->process_repeats++;
1410
        if ($this->process_repeats > 1) {
1411
            return;
1412
        }
1413
1414
        $this->repeats_stack[] = [$this->repeats, $this->repeat_bytes];
1415
        $this->repeats         = [];
1416
        $this->repeat_bytes    = xml_get_current_line_number($this->parser);
1417
1418
        $id    = '';
1419
        $match = [];
1420
        if (preg_match('/0 @(.+)@/', $this->gedrec, $match)) {
1421
            $id = $match[1];
1422
        }
1423
        $tag = '';
1424
        if (isset($attrs['ignore'])) {
1425
            $tag .= $attrs['ignore'];
1426
        }
1427
        if (preg_match('/\$(.+)/', $tag, $match)) {
1428
            $tag = $this->vars[$match[1]]['id'];
1429
        }
1430
1431
        $record = Registry::gedcomRecordFactory()->make($id, $this->tree);
1432
        if (empty($attrs['diff']) && !empty($id)) {
1433
            $facts = $record->facts([], true);
1434
            $this->repeats = [];
1435
            $nonfacts      = explode(',', $tag);
1436
            foreach ($facts as $fact) {
1437
                $tag = explode(':', $fact->tag())[1];
1438
1439
                if (!in_array($tag, $nonfacts, true)) {
1440
                    $this->repeats[] = $fact->gedcom();
1441
                }
1442
            }
1443
        } else {
1444
            foreach ($record->facts() as $fact) {
1445
                if (($fact->isPendingAddition() || $fact->isPendingDeletion()) && !str_ends_with($fact->tag(), ':CHAN')) {
1446
                    $this->repeats[] = $fact->gedcom();
1447
                }
1448
            }
1449
        }
1450
1451
        $jdarr = [];
1452
        // Add fact/event for FAM:DIV and for death of spouse
1453
        foreach ($this->repeats as $key => $fact) {
1454
            $jdarr[$key] = 0;
1455
            if (preg_match('/1 FAMS @(.+)@/', $fact, $match)) {
1456
                $famid = $match[1];
1457
                $fam = Registry::familyFactory()->make($match[1], $this->tree);
1458
                if ($fam === null) {
1459
                    continue;
1460
                }
1461
                $dt = $this->getGedcomValue("MARR:DATE", 0, $fam->gedcom());
1462
                if ($dt == "") {
1463
                    $dt = $this->getGedcomValue("ENGA:DATE", 0, $fam->gedcom());
1464
                }
1465
                if ($dt == "" && $this->getGedcomValue("EVEN:TYPE", 0, $fam->gedcom()) == "Sambo") {
1466
                    $dt = $this->getGedcomValue("EVEN:DATE", 0, $fam->gedcom());
1467
                }
1468
                $date = new Date($dt);
1469
                $jd = $date->julianDay();
1470
                $jdarr[$key] = $jd;
1471
                // Divorce
1472
                $dt = $this->getGedcomValue("DIV:DATE", 0, $fam->gedcom());
1473
                if ($dt != "") {
1474
                    $this->repeats[] = "1 DIV\n2 DATE " . $dt . "\n";
1475
                }
1476
                // Separation // Doesn't work!! getGedComValue only reports the first event!! I.e. no match here
1477
                if ($this->getGedcomValue("EVEN:TYPE", 0, $fam->gedcom()) == "Separation") {
1478
                    $dt = $this->getGedcomValue("EVEN:DATE", 0, $fam->gedcom());
1479
                    if ($dt != "") {
1480
                        $this->repeats[] = "1 EVEN\n2 TYPE Separation\n2 DATE " . $dt . "\n";
1481
                    }
1482
                }
1483
                // death of husband / wife
1484
                $husb = $fam->husband();
1485
                $wife = $fam->wife();
1486
                if ($this->getGedcomValue("SEX", 0, $this->gedrec) == "M") {
1487
                    $spouse = $wife;
1488
                } else {
1489
                    $spouse = $husb;
1490
                }
1491
                if ($spouse) {
1492
                    $dt = $this->getGedcomValue("DEAT:DATE", 0, $spouse->gedcom());
1493
                } else {
1494
                    $dt = "";
1495
                }
1496
                if ($dt != "") {
1497
                    $this->repeats[] = "1 _SP_DEAT\n2 DATE " . $dt . "\n2 _O_FAM " . $famid . "\n";
1498
                }
1499
            }
1500
        }
1501
        // Find the dates for the facts that are found
1502
        foreach ($this->repeats as $key => $fact) {
1503
            if (preg_match('/[234] DATE ([^\n]+)/', $fact, $match)) {
1504
                $date = new Date($match[1]);
1505
                $jd = $date->julianDay();
1506
                $jdarr[$key] = $jd;
1507
            }
1508
        }
1509
1510
        // Sort facts in chronological order, if possible
1511
        $m = count($this->repeats) - 1;
1512
        $prevd = 0;
1513
        for ($i = 0; $i <= $m; $i++) { // keep undated events after previous dated event
1514
            if ($jdarr[$i] === 0) {
1515
                $jdarr[$i] = $prevd;
1516
            } else {
1517
                $prevd = $jdarr[$i];
1518
            }
1519
        }
1520
1521
        while ($m > 1) {
1522
            $n = count($this->repeats);
1523
            while ($n > 1) {
1524
                if ($jdarr[$n - 2] > $jdarr[$n - 1] && $jdarr[$n - 1] !== 0) {
1525
                    $s = $this->repeats[$n - 1];
1526
                    $this->repeats[$n - 1] = $this->repeats[$n - 2];
1527
                    $this->repeats[$n - 2] = $s;
1528
                    $s = $jdarr[$n - 1];
1529
                    $jdarr[$n - 1] = $jdarr[$n - 2];
1530
                    $jdarr[$n - 2] = $s;
1531
                }
1532
                $n -= 1;
1533
            }
1534
            $m -= 1;
1535
        }
1536
1537
        // Remove spouse deaths that are too late: after new marriage or own death
1538
        $currfam = "";
1539
        for ($i = 0; $i <= count($this->repeats) - 1; $i++) {
1540
            if (preg_match('/[1234] FAMS @(.+)@/', $this->repeats[$i], $match)) {
1541
                $currfam = $match[1];
1542
            }
1543
            if (preg_match('/_SP_DEAT.*\n2 DATE (.*)\n.*_O_FAM (.+)\n/', $this->repeats[$i], $match)) {
1544
                if ($currfam != $match[2] || $i == count($this->repeats) - 1) {
1545
                    $this->repeats[$i] = "1 _XXX\n";
1546
                } // ignore fact
1547
            }
1548
        }
1549
    }
1550
1551
    /**
1552
     * Handle </facts>
1553
     *
1554
     * @return void
1555
     */
1556
    protected function factsEndHandler(): void
1557
    {
1558
        $this->process_repeats--;
1559
        if ($this->process_repeats > 0) {
1560
            return;
1561
        }
1562
1563
        // Check if there is anything to repeat
1564
        if (count($this->repeats) > 0) {
1565
            $line       = xml_get_current_line_number($this->parser) - 1;
1566
            $lineoffset = 0;
1567
            foreach ($this->repeats_stack as $rep) {
1568
                $lineoffset = $lineoffset + (int) $rep[1] - 1;
1569
            }
1570
1571
            //-- read the xml from the file
1572
            $lines = file($this->report);
1573
            while ($lineoffset + $this->repeat_bytes > 0 && !str_contains($lines[$lineoffset + $this->repeat_bytes], '<Facts ')) {
1574
                $lineoffset--;
1575
            }
1576
            $lineoffset++;
1577
            $reportxml = "<tempdoc>\n";
1578
            $i         = $line + $lineoffset;
1579
            $line_nr   = $this->repeat_bytes + $lineoffset;
1580
            while ($line_nr < $i) {
1581
                $reportxml .= $lines[$line_nr];
1582
                $line_nr++;
1583
            }
1584
            // No need to drag this
1585
            unset($lines);
1586
            $reportxml .= "</tempdoc>\n";
1587
            // Save original values
1588
            $this->parser_stack[] = $this->parser;
1589
            $oldgedrec = $this->gedrec;
1590
            $count = count($this->repeats);
1591
            $i = 0;
1592
            while ($i < $count) {
1593
                if (!isset($this->repeats[$i])) {
1594
                    $i++;
1595
                    continue; // this fact has been removed above, occured too late
1596
                }
1597
                $this->gedrec = $this->repeats[$i];
1598
                $this->fact = '';
1599
                $this->desc = '';
1600
                if (preg_match('/1 (\w+)(.*)/', $this->gedrec, $match)) {
1601
                    $this->fact = $match[1];
1602
                    if ($this->fact === 'EVEN' || $this->fact === 'FACT') {
1603
                        $tmatch = [];
1604
                        if (preg_match('/2 TYPE (.+)/', $this->gedrec, $tmatch)) {
1605
                            $this->type = trim($tmatch[1]);
1606
                        } else {
1607
                            $this->type = ' ';
1608
                        }
1609
                    }
1610
                    $this->desc = trim($match[2]);
1611
                    $this->desc .= self::getCont(2, $this->gedrec);
1612
                }
1613
                $repeat_parser = xml_parser_create();
1614
                $this->parser  = $repeat_parser;
1615
                xml_parser_set_option($repeat_parser, XML_OPTION_CASE_FOLDING, 0);
1616
1617
                xml_set_element_handler(
1618
                    $repeat_parser,
1619
                    function ($parser, string $name, array $attrs): void {
1620
                        $this->startElement($parser, $name, $attrs);
1621
                    },
1622
                    function ($parser, string $name): void {
1623
                        $this->endElement($parser, $name);
1624
                    }
1625
                );
1626
1627
                xml_set_character_data_handler(
1628
                    $repeat_parser,
1629
                    function ($parser, string $data): void {
1630
                        $this->characterData($parser, $data);
1631
                    }
1632
                );
1633
1634
                if (!xml_parse($repeat_parser, $reportxml, true)) {
1635
                    throw new DomainException(sprintf(
1636
                        'FactsEHandler XML error: %s at line %d',
1637
                        xml_error_string(xml_get_error_code($repeat_parser)),
1638
                        xml_get_current_line_number($repeat_parser)
1639
                    ));
1640
                }
1641
                xml_parser_free($repeat_parser);
1642
                $i++;
1643
            }
1644
            // Restore original values
1645
            $this->parser = array_pop($this->parser_stack);
1646
            $this->gedrec = $oldgedrec;
1647
        }
1648
        [$this->repeats, $this->repeat_bytes] = array_pop($this->repeats_stack);
1649
    }
1650
1651
    /**
1652
     * Setting upp or changing variables in the XML
1653
     * The XML variable name and value is stored in $this->vars
1654
     *
1655
     * @param array<string> $attrs an array of key value pairs for the attributes
1656
     *
1657
     * @return void
1658
     */
1659
    protected function setVarStartHandler(array $attrs): void
1660
    {
1661
        if (empty($attrs['name'])) {
1662
            throw new DomainException('REPORT ERROR var: The attribute "name" is missing or not set in the XML file');
1663
        }
1664
1665
        $name  = $attrs['name'];
1666
        $value = $attrs['value'];
1667
        if (isset($attrs['dumpvar'])) {
1668
            $dumpvar = $attrs['dumpvar'];
1669
        } else {
1670
            $dumpvar = "";
1671
        }
1672
        $curr_id = "";
1673
        $match = [];
1674
        if (preg_match('/0 @(.+)@/', $this->gedrec, $match)) {
1675
            $curr_id = $match[1];
1676
        }
1677
        $match = [];
1678
        // Current GEDCOM record strings
1679
        if ($value === '@ID') {
1680
            if (preg_match('/0 @(.+)@/', $this->gedrec, $match)) {
1681
                $value = $match[1];
1682
            }
1683
        } elseif ($value === '@fact') {
1684
            $value = $this->fact;
1685
        } elseif ($value === '@desc') {
1686
            $value = $this->desc;
1687
        } elseif ($value === '@format') {
1688
            if (isset($_GET["format"])) {
1689
                $value = $_GET["format"];
1690
            } else {
1691
                $value = "";
1692
            }
1693
        } elseif ($value === '@generation') {
1694
            $value = (string) $this->generation;
1695
        } elseif ($value === '@base_url') {
1696
            $value = "";
1697
            if (array_key_exists("route", $_GET)) {
1698
                $value = $_GET["route"];
1699
            }
1700
            $i = strpos($value, "%2Freport");
1701
            if ($i === false) {
1702
                $i = strpos($value, "/report");
1703
            }
1704
            if ($i !== false) {
1705
                $value = substr($value, 0, $i);
1706
            }
1707
            $value = "index.php?route=" . $value;
1708
        } elseif ($value === '@relation') {
1709
            if (isset($this->mfrelation[$curr_id]) && $curr_id != "") {
1710
                $value = (string) $this->mfrelation[$curr_id];
1711
            } else {
1712
                $value = "";
1713
            }
1714
        } elseif (preg_match("/@(\w+)/", $value, $match)) {
1715
            $gmatch = [];
1716
            if (preg_match("/\d $match[1] (.+)/", $this->gedrec, $gmatch)) {
1717
                $value = str_replace('@', '', trim($gmatch[1]));
1718
            }
1719
        } elseif (preg_match("/@\\$(\w+)/", $value, $match)) {
1720
            if ($match[1] == "dump" && $this->vars['dval']['id'] > 0) {
1721
                // if ($this->vars[ 'dval' ]['id'] == 1001)
1722
                if ($dumpvar == "gedrec") {
1723
                    error_log("\n---- setvar start  " . date("Y-m-d H:i:s") . " RPG " . __LINE__ . "  " . $name . "  gedcom=\n" . $this->gedrec . "\n", 3, "my-errors.log");
1724
                } elseif ($dumpvar != "") {
1725
                    error_log("var: " . $dumpvar . " = " . $this->vars[$dumpvar]['id'] . "\n", 3, "my-errors.log");
1726
                } else {
1727
                    if (array_key_exists('dval', $this->vars)) {
1728
                        $nnn = $this->vars['dval']['id'];
1729
                    } else {
1730
                        $nnn = 0;
1731
                    }
1732
                    error_log("\n---- setvar start  " . date("Y-m-d H:i:s") . " RPG " . __LINE__ . "  " . $name . "  -----\n", 3, "my-errors.log");
1733
                    foreach ($this->vars as $key => $val) {
1734
                        if ($nnn-- < 0) {
1735
                            error_log($key . "='" . $val['id'] . "'\n", 3, "my-errors.log");
1736
                        }
1737
                    }
1738
                }
1739
            }
1740
            $value = $this->vars[$match[1]]['id'];
1741
            if (isset($this->vars[$value]['id'])) {
1742
                $value = '$' . $this->vars[$match[1]]['id'];
1743
            } else {
1744
                $value = "0";
1745
            }
1746
        }
1747
        if (isset($attrs['trim'])) {
1748
            $value = str_replace($attrs['trim'], '', $value);
1749
        }
1750
        if (preg_match("/\\$(\w+)/", $name, $match)) {
1751
            $name = $this->vars["'" . $match[1] . "'"]['id'];
1752
        }
1753
        $count = preg_match_all("/\\$(\w+)/", $value, $match, PREG_SET_ORDER);
1754
        $i     = 0;
1755
        while ($i < $count) {
1756
            $t     = $this->vars[$match[$i][1]]['id'];
1757
            $value = preg_replace('/\$' . $match[$i][1] . '/', $t, $value, 1);
1758
            $i++;
1759
        }
1760
        if (preg_match('/^I18N::number\((.+)\)$/', $value, $match)) {
1761
            $value = I18N::number((int) $match[1]);
1762
        } elseif (preg_match('/^I18N::translate\(\'(.+)\'\)$/', $value, $match)) {
1763
            $value = I18N::translate($match[1]);
1764
        } elseif (preg_match('/^I18N::translateContext\(\'(.+)\', *\'(.+)\'\)$/', $value, $match)) {
1765
            $value = I18N::translateContext($match[1], $match[2]);
1766
        }
1767
        if (isset($attrs['lcfirst'])) { // set 1st char to lower case
1768
            $value = lcfirst($value);
1769
        }
1770
1771
        // Arithmetic functions
1772
        if (preg_match("/(\d+)\s*([-+*\/])\s*(\d+)/", $value, $match)) {
1773
            // Create an expression language with the functions used by our reports.
1774
            $expression_provider  = new ReportExpressionLanguageProvider();
1775
            $expression_cache     = new NullAdapter();
1776
            $expression_language  = new ExpressionLanguage($expression_cache, [$expression_provider]);
1777
1778
            $value = (string) $expression_language->evaluate($value);
1779
        }
1780
1781
        if (str_contains($value, '@')) {
1782
            $value = '';
1783
        }
1784
        $this->vars[$name]['id'] = $value;
1785
        if ($name == 'title') {
1786
            $this->wt_report->title = $value;
1787
        }
1788
    }
1789
1790
    /**
1791
     * Handle <if>
1792
     *
1793
     * @param array<string> $attrs
1794
     *
1795
     * @return void
1796
     */
1797
    protected function ifStartHandler(array $attrs): void
1798
    {
1799
        if ($this->process_ifs > 0) {
1800
            $this->process_ifs++;
1801
1802
            return;
1803
        }
1804
1805
        $condition = $attrs['condition'];
1806
        $condition = $this->substituteVars($condition, true);
1807
        $condition = str_replace([
1808
            ' LT ',
1809
            ' GT ',
1810
        ], [
1811
            '<',
1812
            '>',
1813
        ], $condition);
1814
        // Replace the first occurrence only once of @fact:DATE or in any other combinations to the current fact, such as BIRT
1815
        $condition = str_replace('@fact:', $this->fact . ':', $condition);
1816
        $match     = [];
1817
        $count     = preg_match_all("/@([\w:.]+)/", $condition, $match, PREG_SET_ORDER);
1818
        $i         = 0;
1819
        while ($i < $count) {
1820
            $id    = $match[$i][1];
1821
            $value = '""';
1822
            if ($id === 'ID') {
1823
                if (preg_match('/0 @(.+)@/', $this->gedrec, $match)) {
1824
                    $value = "'" . $match[1] . "'";
1825
                }
1826
            } elseif ($id === 'fact') {
1827
                $value = '"' . $this->fact . '"';
1828
            } elseif ($id === 'desc') {
1829
                $value = '"' . addslashes($this->desc) . '"';
1830
            } elseif ($id === 'generation') {
1831
                $value = '"' . $this->generation . '"';
1832
            } else {
1833
                $level = (int) explode(' ', trim($this->gedrec))[0];
1834
                if ($level === 0) {
1835
                    $level++;
1836
                }
1837
                $value = $this->getGedcomValue($id, $level, $this->gedrec);
1838
                if (empty($value)) {
1839
                    $level++;
1840
                    $value = $this->getGedcomValue($id, $level, $this->gedrec);
1841
                }
1842
                $value = preg_replace('/^@(' . Gedcom::REGEX_XREF . ')@$/', '$1', $value);
1843
                $value = '"' . addslashes($value) . '"';
1844
            }
1845
            $condition = str_replace("@$id", $value, $condition);
1846
            $i++;
1847
        }
1848
1849
        // Create an expression language with the functions used by our reports.
1850
        $expression_provider  = new ReportExpressionLanguageProvider();
1851
        $expression_cache     = new NullAdapter();
1852
        $expression_language  = new ExpressionLanguage($expression_cache, [$expression_provider]);
1853
1854
        $ret = $expression_language->evaluate($condition);
1855
1856
        if (!$ret) {
1857
            $this->process_ifs++;
1858
        }
1859
    }
1860
1861
    /**
1862
     * Handle </if>
1863
     *
1864
     * @return void
1865
     */
1866
    protected function ifEndHandler(): void
1867
    {
1868
        if ($this->process_ifs > 0) {
1869
            $this->process_ifs--;
1870
        }
1871
    }
1872
1873
    /**
1874
     * Handle <footnote>
1875
     * Collect the Footnote links
1876
     * GEDCOM Records that are protected by Privacy setting will be ignored
1877
     *
1878
     * @param array<string> $attrs
1879
     *
1880
     * @return void
1881
     */
1882
    protected function footnoteStartHandler(array $attrs): void
1883
    {
1884
        $id = '';
1885
        if (preg_match('/[0-9] (.+) @(.+)@/', $this->gedrec, $match)) {
1886
            $id = $match[2];
1887
        }
1888
        $record = Registry::gedcomRecordFactory()->make($id, $this->tree);
1889
        if ($record && $record->canShow()) {
1890
            $this->print_data_stack[] = $this->print_data;
1891
            $this->print_data         = true;
1892
            $style                    = '';
1893
            if (!empty($attrs['style'])) {
1894
                $style = $attrs['style'];
1895
            }
1896
            $this->footnote_element = $this->current_element;
1897
            $this->current_element  = $this->report_root->createFootnote($style);
1898
        } else {
1899
            $this->print_data       = false;
1900
            $this->process_footnote = false;
1901
        }
1902
    }
1903
1904
    /**
1905
     * Handle </footnote>
1906
     * Print the collected Footnote data
1907
     *
1908
     * @return void
1909
     */
1910
    protected function footnoteEndHandler(): void
1911
    {
1912
        if ($this->process_footnote) {
1913
            $this->print_data = array_pop($this->print_data_stack);
1914
            $temp             = trim($this->current_element->getValue());
1915
            if (strlen($temp) > 3) {
1916
                $this->wt_report->addElement($this->current_element);
1917
            }
1918
            $this->current_element = $this->footnote_element;
1919
        } else {
1920
            $this->process_footnote = true;
1921
        }
1922
    }
1923
1924
    /**
1925
     * Handle <footnoteTexts />
1926
     *
1927
     * @return void
1928
     */
1929
    protected function footnoteTextsStartHandler(): void
1930
    {
1931
        $temp = 'footnotetexts';
1932
        $this->wt_report->addElement($temp);
1933
    }
1934
1935
    /**
1936
     * XML element Forced line break handler - HTML code
1937
     *
1938
     * @return void
1939
     */
1940
    protected function brStartHandler(): void
1941
    {
1942
        if ($this->print_data && $this->process_gedcoms === 0) {
1943
            $this->current_element->addText('<br>');
1944
        }
1945
    }
1946
1947
    /**
1948
     * Handle <sp />
1949
     * Forced space
1950
     *
1951
     * @return void
1952
     */
1953
    protected function spStartHandler(): void
1954
    {
1955
        if ($this->print_data && $this->process_gedcoms === 0) {
1956
            $this->current_element->addText(' ');
1957
        }
1958
    }
1959
1960
    /**
1961
     * Handle <highlightedImage />
1962
     *
1963
     * @param array<string> $attrs
1964
     *
1965
     * @return void
1966
     */
1967
    protected function highlightedImageStartHandler(array $attrs): void
1968
    {
1969
        $id = '';
1970
        if (preg_match('/0 @(.+)@/', $this->gedrec, $match)) {
1971
            $id = $match[1];
1972
        }
1973
1974
        // Position the top corner of this box on the page
1975
        $top = (float) ($attrs['top'] ?? ReportBaseElement::CURRENT_POSITION);
1976
1977
        // Position the left corner of this box on the page
1978
        $left = (float) ($attrs['left'] ?? ReportBaseElement::CURRENT_POSITION);
1979
1980
        // string Align the image in left, center, right (or empty to use x/y position).
1981
        $align = $attrs['align'] ?? '';
1982
1983
        // string Next Line should be T:next to the image, N:next line
1984
        $ln = $attrs['ln'] ?? 'T';
1985
1986
        // Width, height (or both).
1987
        $width  = (float) ($attrs['width'] ?? 0.0);
1988
        $height = (float) ($attrs['height'] ?? 0.0);
1989
1990
        $person     = Registry::individualFactory()->make($id, $this->tree);
1991
        $media_file = $person->findHighlightedMediaFile();
1992
1993
        if ($media_file instanceof MediaFile && $media_file->fileExists()) {
1994
            $image      = imagecreatefromstring($media_file->fileContents());
1995
            $attributes = [imagesx($image), imagesy($image)];
1996
1997
            if ($width > 0 && $height == 0) {
1998
                $perc   = $width / $attributes[0];
1999
                $height = round($attributes[1] * $perc);
2000
            } elseif ($height > 0 && $width == 0) {
2001
                $perc  = $height / $attributes[1];
2002
                $width = round($attributes[0] * $perc);
2003
            } else {
2004
                $width  = (float) $attributes[0];
2005
                $height = (float) $attributes[1];
2006
            }
2007
            $image = $this->report_root->createImageFromObject($media_file, $left, $top, $width, $height, $align, $ln);
2008
            $this->wt_report->addElement($image);
2009
        }
2010
    }
2011
2012
    /**
2013
     * Handle <image/>
2014
     *
2015
     * @param array<string> $attrs
2016
     *
2017
     * @return void
2018
     */
2019
    protected function imageStartHandler(array $attrs): void
2020
    {
2021
        // Position the top corner of this box on the page. the default is the current position
2022
        $top = (float) ($attrs['top'] ?? ReportBaseElement::CURRENT_POSITION);
2023
2024
        // mixed Position the left corner of this box on the page. the default is the current position
2025
        $left = (float) ($attrs['left'] ?? ReportBaseElement::CURRENT_POSITION);
2026
2027
        // string Align the image in left, center, right (or empty to use x/y position).
2028
        $align = $attrs['align'] ?? '';
2029
2030
        // string Next Line should be T:next to the image, N:next line
2031
        $ln = $attrs['ln'] ?? 'T';
2032
2033
        // Width, height (or both).
2034
        $width  = (float) ($attrs['width'] ?? 0.0);
2035
        $height = (float) ($attrs['height'] ?? 0.0);
2036
2037
        $file = $attrs['file'] ?? '';
2038
2039
        if ($file === '@FILE') {
2040
            $match = [];
2041
            if (preg_match("/\d OBJE @(.+)@/", $this->gedrec, $match)) {
2042
                $mediaobject = Registry::mediaFactory()->make($match[1], $this->tree);
2043
                $media_file  = $mediaobject->firstImageFile();
2044
2045
                if ($media_file instanceof MediaFile && $media_file->fileExists()) {
2046
                    $image      = imagecreatefromstring($media_file->fileContents());
2047
                    $attributes = [imagesx($image), imagesy($image)];
2048
2049
                    if ($width > 0 && $height == 0) {
2050
                        $perc   = $width / $attributes[0];
2051
                        $height = round($attributes[1] * $perc);
2052
                    } elseif ($height > 0 && $width == 0) {
2053
                        $perc  = $height / $attributes[1];
2054
                        $width = round($attributes[0] * $perc);
2055
                    } else {
2056
                        $width  = (float) $attributes[0];
2057
                        $height = (float) $attributes[1];
2058
                    }
2059
                    $image = $this->report_root->createImageFromObject($media_file, $left, $top, $width, $height, $align, $ln);
2060
                    $this->wt_report->addElement($image);
2061
                }
2062
            }
2063
        } else {
2064
            if (file_exists($file) && preg_match('/(jpg|jpeg|png|gif)$/i', $file)) {
2065
                $size = getimagesize($file);
2066
                if ($width > 0 && $height == 0) {
2067
                    $perc   = $width / $size[0];
2068
                    $height = round($size[1] * $perc);
2069
                } elseif ($height > 0 && $width == 0) {
2070
                    $perc  = $height / $size[1];
2071
                    $width = round($size[0] * $perc);
2072
                } else {
2073
                    $width  = $size[0];
2074
                    $height = $size[1];
2075
                }
2076
                $image = $this->report_root->createImage($file, $left, $top, $width, $height, $align, $ln);
2077
                $this->wt_report->addElement($image);
2078
            }
2079
        }
2080
    }
2081
2082
    /**
2083
     * Handle <line>
2084
     *
2085
     * @param array<string> $attrs
2086
     *
2087
     * @return void
2088
     */
2089
    protected function lineStartHandler(array $attrs): void
2090
    {
2091
        // Start horizontal position, current position (default)
2092
        $x1 = ReportBaseElement::CURRENT_POSITION;
2093
        if (isset($attrs['x1'])) {
2094
            if ($attrs['x1'] === '0') {
2095
                $x1 = 0;
2096
            } elseif ($attrs['x1'] === '.') {
2097
                $x1 = ReportBaseElement::CURRENT_POSITION;
2098
            } elseif (!empty($attrs['x1'])) {
2099
                $x1 = (float) $attrs['x1'];
2100
            }
2101
        }
2102
        // Start vertical position, current position (default)
2103
        $y1 = ReportBaseElement::CURRENT_POSITION;
2104
        if (isset($attrs['y1'])) {
2105
            if ($attrs['y1'] === '0') {
2106
                $y1 = 0;
2107
            } elseif ($attrs['y1'] === '.') {
2108
                $y1 = ReportBaseElement::CURRENT_POSITION;
2109
            } elseif (!empty($attrs['y1'])) {
2110
                $y1 = (float) $attrs['y1'];
2111
            }
2112
        }
2113
        // End horizontal position, maximum width (default)
2114
        $x2 = ReportBaseElement::CURRENT_POSITION;
2115
        if (isset($attrs['x2'])) {
2116
            if ($attrs['x2'] === '0') {
2117
                $x2 = 0;
2118
            } elseif ($attrs['x2'] === '.') {
2119
                $x2 = ReportBaseElement::CURRENT_POSITION;
2120
            } elseif (!empty($attrs['x2'])) {
2121
                $x2 = (float) $attrs['x2'];
2122
            }
2123
        }
2124
        // End vertical position
2125
        $y2 = ReportBaseElement::CURRENT_POSITION;
2126
        if (isset($attrs['y2'])) {
2127
            if ($attrs['y2'] === '0') {
2128
                $y2 = 0;
2129
            } elseif ($attrs['y2'] === '.') {
2130
                $y2 = ReportBaseElement::CURRENT_POSITION;
2131
            } elseif (!empty($attrs['y2'])) {
2132
                $y2 = (float) $attrs['y2'];
2133
            }
2134
        }
2135
2136
        $line = $this->report_root->createLine($x1, $y1, $x2, $y2);
2137
        $this->wt_report->addElement($line);
2138
    }
2139
2140
    /**
2141
     * Handle <list>
2142
     *
2143
     * @param array<string> $attrs
2144
     *
2145
     * @return void
2146
     */
2147
    protected function listStartHandler(array $attrs): void
2148
    {
2149
        $this->process_repeats++;
2150
        if ($this->process_repeats > 1) {
2151
            return;
2152
        }
2153
2154
        $match = [];
2155
        if (isset($attrs['sortby'])) {
2156
            $sortby = $attrs['sortby'];
2157
            if (preg_match("/\\$(\w+)/", $sortby, $match)) {
2158
                $sortby = $this->vars[$match[1]]['id'];
2159
                $sortby = trim($sortby);
2160
            }
2161
        } else {
2162
            $sortby = 'NAME';
2163
        }
2164
2165
        $listname = $attrs['list'] ?? 'individual';
2166
2167
        // Some filters/sorts can be applied using SQL, while others require PHP
2168
        switch ($listname) {
2169
            case 'pending':
2170
                $this->list = DB::table('change')
2171
                    ->whereIn('change_id', function (Builder $query): void {
2172
                        $query->select([new Expression('MAX(change_id)')])
2173
                            ->from('change')
2174
                            ->where('gedcom_id', '=', $this->tree->id())
2175
                            ->where('status', '=', 'pending')
2176
                            ->groupBy(['xref']);
2177
                    })
2178
                    ->get()
2179
                    ->map(fn (object $row): ?GedcomRecord => Registry::gedcomRecordFactory()->make($row->xref, $this->tree, $row->new_gedcom ?: $row->old_gedcom))
2180
                    ->filter()
2181
                    ->all();
2182
                break;
2183
2184
            case 'individual':
2185
                $query = DB::table('individuals')
2186
                    ->where('i_file', '=', $this->tree->id())
2187
                    ->select(['i_id AS xref', 'i_gedcom AS gedcom'])
2188
                    ->distinct();
2189
2190
                foreach ($attrs as $attr => $value) {
2191
                    if (str_starts_with($attr, 'filter') && $value !== '') {
2192
                        $value = $this->substituteVars($value, false);
2193
                        // Convert the various filters into SQL
2194
                        if (preg_match('/^(\w+):DATE (LTE|GTE) (.+)$/', $value, $match)) {
2195
                            $query->join('dates AS ' . $attr, static function (JoinClause $join) use ($attr): void {
2196
                                $join
2197
                                    ->on($attr . '.d_gid', '=', 'i_id')
2198
                                    ->on($attr . '.d_file', '=', 'i_file');
2199
                            });
2200
2201
                            $query->where($attr . '.d_fact', '=', $match[1]);
2202
2203
                            $date = new Date($match[3]);
2204
2205
                            if ($match[2] === 'LTE') {
2206
                                $query->where($attr . '.d_julianday2', '<=', $date->maximumJulianDay());
2207
                            } else {
2208
                                $query->where($attr . '.d_julianday1', '>=', $date->minimumJulianDay());
2209
                            }
2210
2211
                            // This filter has been fully processed
2212
                            unset($attrs[$attr]);
2213
                        } elseif (preg_match('/^NAME CONTAINS (.+)$/', $value, $match)) {
2214
                            $query->join('name AS ' . $attr, static function (JoinClause $join) use ($attr): void {
2215
                                $join
2216
                                    ->on($attr . '.n_id', '=', 'i_id')
2217
                                    ->on($attr . '.n_file', '=', 'i_file');
2218
                            });
2219
                            // Search the DB only if there is any name supplied
2220
                            $names = explode(' ', $match[1]);
2221
                            foreach ($names as $name) {
2222
                                $query->where($attr . '.n_full', 'LIKE', '%' . addcslashes($name, '\\%_') . '%');
2223
                            }
2224
2225
                            // This filter has been fully processed
2226
                            unset($attrs[$attr]);
2227
                        } elseif (preg_match('/^LIKE \/(.+)\/$/', $value, $match)) {
2228
                            // Convert newline escape sequences to actual new lines
2229
                            $match[1] = str_replace('\n', "\n", $match[1]);
2230
2231
                            $query->where('i_gedcom', 'LIKE', $match[1]);
2232
2233
                            // This filter has been fully processed
2234
                            unset($attrs[$attr]);
2235
                        } elseif (preg_match('/^(?:\w*):PLAC CONTAINS (.+)$/', $value, $match)) {
2236
                            // Don't unset this filter. This is just initial filtering for performance
2237
                            $query
2238
                                ->join('placelinks AS ' . $attr . 'a', static function (JoinClause $join) use ($attr): void {
2239
                                    $join
2240
                                        ->on($attr . 'a.pl_file', '=', 'i_file')
2241
                                        ->on($attr . 'a.pl_gid', '=', 'i_id');
2242
                                })
2243
                                ->join('places AS ' . $attr . 'b', static function (JoinClause $join) use ($attr): void {
2244
                                    $join
2245
                                        ->on($attr . 'b.p_file', '=', $attr . 'a.pl_file')
2246
                                        ->on($attr . 'b.p_id', '=', $attr . 'a.pl_p_id');
2247
                                })
2248
                                ->where($attr . 'b.p_place', 'LIKE', '%' . addcslashes($match[1], '\\%_') . '%');
2249
                        } elseif (preg_match('/^(\w*):(\w+) CONTAINS (.+)$/', $value, $match)) {
2250
                            // Don't unset this filter. This is just initial filtering for performance
2251
                            $match[3] = strtr($match[3], ['\\' => '\\\\', '%'  => '\\%', '_'  => '\\_', ' ' => '%']);
2252
                            $like = "%\n1 " . $match[1] . "%\n2 " . $match[2] . '%' . $match[3] . '%';
2253
                            $query->where('i_gedcom', 'LIKE', $like);
2254
                        } elseif (preg_match('/^(\w+) CONTAINS (.*)$/', $value, $match)) {
2255
                            // Don't unset this filter. This is just initial filtering for performance
2256
                            $match[2] = strtr($match[2], ['\\' => '\\\\', '%'  => '\\%', '_'  => '\\_', ' ' => '%']);
2257
                            $like = "%\n1 " . $match[1] . '%' . $match[2] . '%';
2258
                            $query->where('i_gedcom', 'LIKE', $like);
2259
                        }
2260
                    }
2261
                }
2262
2263
                $this->list = [];
2264
2265
                foreach ($query->get() as $row) {
2266
                    $this->list[$row->xref] = Registry::individualFactory()->make($row->xref, $this->tree, $row->gedcom);
2267
                }
2268
                break;
2269
2270
            case 'family':
2271
                $query = DB::table('families')
2272
                    ->where('f_file', '=', $this->tree->id())
2273
                    ->select(['f_id AS xref', 'f_gedcom AS gedcom'])
2274
                    ->distinct();
2275
2276
                foreach ($attrs as $attr => $value) {
2277
                    if (str_starts_with($attr, 'filter') && $value !== '') {
2278
                        $value = $this->substituteVars($value, false);
2279
                        // Convert the various filters into SQL
2280
                        if (preg_match('/^(\w+):DATE (LTE|GTE) (.+)$/', $value, $match)) {
2281
                            $query->join('dates AS ' . $attr, static function (JoinClause $join) use ($attr): void {
2282
                                $join
2283
                                    ->on($attr . '.d_gid', '=', 'f_id')
2284
                                    ->on($attr . '.d_file', '=', 'f_file');
2285
                            });
2286
2287
                            $query->where($attr . '.d_fact', '=', $match[1]);
2288
2289
                            $date = new Date($match[3]);
2290
2291
                            if ($match[2] === 'LTE') {
2292
                                $query->where($attr . '.d_julianday2', '<=', $date->maximumJulianDay());
2293
                            } else {
2294
                                $query->where($attr . '.d_julianday1', '>=', $date->minimumJulianDay());
2295
                            }
2296
2297
                            // This filter has been fully processed
2298
                            unset($attrs[$attr]);
2299
                        } elseif (preg_match('/^LIKE \/(.+)\/$/', $value, $match)) {
2300
                            // Convert newline escape sequences to actual new lines
2301
                            $match[1] = str_replace('\n', "\n", $match[1]);
2302
2303
                            $query->where('f_gedcom', 'LIKE', $match[1]);
2304
2305
                            // This filter has been fully processed
2306
                            unset($attrs[$attr]);
2307
                        } elseif (preg_match('/^NAME CONTAINS (.*)$/', $value, $match)) {
2308
                            if ($sortby === 'NAME' || $match[1] !== '') {
2309
                                $query->join('name AS ' . $attr, static function (JoinClause $join) use ($attr): void {
2310
                                    $join
2311
                                        ->on($attr . '.n_file', '=', 'f_file')
2312
                                        ->where(static function (Builder $query): void {
2313
                                            $query
2314
                                                ->whereColumn('n_id', '=', 'f_husb')
2315
                                                ->orWhereColumn('n_id', '=', 'f_wife');
2316
                                        });
2317
                                });
2318
                                // Search the DB only if there is any name supplied
2319
                                if ($match[1] != '') {
2320
                                    $names = explode(' ', $match[1]);
2321
                                    foreach ($names as $name) {
2322
                                        $query->where($attr . '.n_full', 'LIKE', '%' . addcslashes($name, '\\%_') . '%');
2323
                                    }
2324
                                }
2325
                            }
2326
2327
                            // This filter has been fully processed
2328
                            unset($attrs[$attr]);
2329
                        } elseif (preg_match('/^(?:\w*):PLAC CONTAINS (.+)$/', $value, $match)) {
2330
                            // Don't unset this filter. This is just initial filtering for performance
2331
                            $query
2332
                                ->join('placelinks AS ' . $attr . 'a', static function (JoinClause $join) use ($attr): void {
2333
                                    $join
2334
                                        ->on($attr . 'a.pl_file', '=', 'f_file')
2335
                                        ->on($attr . 'a.pl_gid', '=', 'f_id');
2336
                                })
2337
                                ->join('places AS ' . $attr . 'b', static function (JoinClause $join) use ($attr): void {
2338
                                    $join
2339
                                        ->on($attr . 'b.p_file', '=', $attr . 'a.pl_file')
2340
                                        ->on($attr . 'b.p_id', '=', $attr . 'a.pl_p_id');
2341
                                })
2342
                                ->where($attr . 'b.p_place', 'LIKE', '%' . addcslashes($match[1], '\\%_') . '%');
2343
                        } elseif (preg_match('/^(\w*):(\w+) CONTAINS (.+)$/', $value, $match)) {
2344
                            // Don't unset this filter. This is just initial filtering for performance
2345
                            $match[3] = strtr($match[3], ['\\' => '\\\\', '%'  => '\\%', '_'  => '\\_', ' ' => '%']);
2346
                            $like = "%\n1 " . $match[1] . "%\n2 " . $match[2] . '%' . $match[3] . '%';
2347
                            $query->where('f_gedcom', 'LIKE', $like);
2348
                        } elseif (preg_match('/^(\w+) CONTAINS (.+)$/', $value, $match)) {
2349
                            // Don't unset this filter. This is just initial filtering for performance
2350
                            $match[2] = strtr($match[2], ['\\' => '\\\\', '%'  => '\\%', '_'  => '\\_', ' ' => '%']);
2351
                            $like = "%\n1 " . $match[1] . '%' . $match[2] . '%';
2352
                            $query->where('f_gedcom', 'LIKE', $like);
2353
                        }
2354
                    }
2355
                }
2356
2357
                $this->list = [];
2358
2359
                foreach ($query->get() as $row) {
2360
                    $this->list[$row->xref] = Registry::familyFactory()->make($row->xref, $this->tree, $row->gedcom);
2361
                }
2362
                break;
2363
2364
            default:
2365
                throw new DomainException('Invalid list name: ' . $listname);
2366
        }
2367
2368
        $filters  = [];
2369
        $filters2 = [];
2370
        if (isset($attrs['filter1']) && count($this->list) > 0) {
2371
            foreach ($attrs as $key => $value) {
2372
                if (preg_match("/filter(\d)/", $key)) {
2373
                    $condition = $value;
2374
                    if (preg_match("/@(\w+)/", $condition, $match)) {
2375
                        $id    = $match[1];
2376
                        $value = "''";
2377
                        if ($id === 'ID') {
2378
                            if (preg_match('/0 @(.+)@/', $this->gedrec, $match)) {
2379
                                $value = "'" . $match[1] . "'";
2380
                            }
2381
                        } elseif ($id === 'fact') {
2382
                            $value = "'" . $this->fact . "'";
2383
                        } elseif ($id === 'desc') {
2384
                            $value = "'" . $this->desc . "'";
2385
                        } else {
2386
                            if (preg_match("/\d $id (.+)/", $this->gedrec, $match)) {
2387
                                $value = "'" . str_replace('@', '', trim($match[1])) . "'";
2388
                            }
2389
                        }
2390
                        $condition = preg_replace("/@$id/", $value, $condition);
2391
                    }
2392
                    //-- handle regular expressions
2393
                    if (preg_match("/([A-Z:]+)\s*([^\s]+)\s*(.+)/", $condition, $match)) {
2394
                        $tag  = trim($match[1]);
2395
                        $expr = trim($match[2]);
2396
                        $val  = trim($match[3]);
2397
                        if (preg_match("/\\$(\w+)/", $val, $match)) {
2398
                            $val = $this->vars[$match[1]]['id'];
2399
                            $val = trim($val);
2400
                        }
2401
                        if ($val !== '') {
2402
                            $searchstr = '';
2403
                            $tags      = explode(':', $tag);
2404
                            //-- only limit to a level number if we are specifically looking at a level
2405
                            if (count($tags) > 1) {
2406
                                $level = 1;
2407
                                $t = 'XXXX';
2408
                                foreach ($tags as $t) {
2409
                                    if (!empty($searchstr)) {
2410
                                        $searchstr .= "[^\n]*(\n[2-9][^\n]*)*\n";
2411
                                    }
2412
                                    //-- search for both EMAIL and _EMAIL... silly double gedcom standard
2413
                                    if ($t === 'EMAIL' || $t === '_EMAIL') {
2414
                                        $t = '_?EMAIL';
2415
                                    }
2416
                                    $searchstr .= $level . ' ' . $t;
2417
                                    $level++;
2418
                                }
2419
                            } else {
2420
                                if ($tag === 'EMAIL' || $tag === '_EMAIL') {
2421
                                    $tag = '_?EMAIL';
2422
                                }
2423
                                $t         = $tag;
2424
                                $searchstr = '1 ' . $tag;
2425
                            }
2426
                            switch ($expr) {
2427
                                case 'CONTAINS':
2428
                                    if ($t === 'PLAC') {
2429
                                        $searchstr .= "[^\n]*[, ]*" . $val;
2430
                                    } else {
2431
                                        $searchstr .= "[^\n]*" . $val;
2432
                                    }
2433
                                    $filters[] = $searchstr;
2434
                                    break;
2435
                                default:
2436
                                    $filters2[] = [
2437
                                        'tag'  => $tag,
2438
                                        'expr' => $expr,
2439
                                        'val'  => $val,
2440
                                    ];
2441
                                    break;
2442
                            }
2443
                        }
2444
                    }
2445
                }
2446
            }
2447
        }
2448
        //-- apply other filters to the list that could not be added to the search string
2449
        if ($filters !== []) {
2450
            foreach ($this->list as $key => $record) {
2451
                foreach ($filters as $filter) {
2452
                    if (!preg_match('/' . $filter . '/i', $record->privatizeGedcom(Auth::accessLevel($this->tree)))) {
2453
                        unset($this->list[$key]);
2454
                        break;
2455
                    }
2456
                }
2457
            }
2458
        }
2459
        if ($filters2 !== []) {
2460
            $mylist = [];
2461
            foreach ($this->list as $indi) {
2462
                $key  = $indi->xref();
2463
                $grec = $indi->privatizeGedcom(Auth::accessLevel($this->tree));
2464
                $keep = true;
2465
                foreach ($filters2 as $filter) {
2466
                    if ($keep) {
2467
                        $tag  = $filter['tag'];
2468
                        $expr = $filter['expr'];
2469
                        $val  = $filter['val'];
2470
                        if ($val === "''") {
2471
                            $val = '';
2472
                        }
2473
                        $tags = explode(':', $tag);
2474
                        $t    = end($tags);
2475
                        $v    = $this->getGedcomValue($tag, 1, $grec);
2476
                        //-- check for EMAIL and _EMAIL (silly double gedcom standard :P)
2477
                        if ($t === 'EMAIL' && empty($v)) {
2478
                            $tag  = str_replace('EMAIL', '_EMAIL', $tag);
2479
                            $tags = explode(':', $tag);
2480
                            $t    = end($tags);
2481
                            $v    = self::getSubRecord(1, $tag, $grec);
2482
                        }
2483
2484
                        switch ($expr) {
2485
                            case 'GTE':
2486
                                if ($t === 'DATE') {
2487
                                    $date1 = new Date($v);
2488
                                    $date2 = new Date($val);
2489
                                    $keep  = (Date::compare($date1, $date2) >= 0);
2490
                                } elseif ($val >= $v) {
2491
                                    $keep = true;
2492
                                }
2493
                                break;
2494
                            case 'LTE':
2495
                                if ($t === 'DATE') {
2496
                                    $date1 = new Date($v);
2497
                                    $date2 = new Date($val);
2498
                                    $keep  = (Date::compare($date1, $date2) <= 0);
2499
                                } elseif ($val >= $v) {
2500
                                    $keep = true;
2501
                                }
2502
                                break;
2503
                            default:
2504
                                if ($v == $val) {
2505
                                    $keep = true;
2506
                                } else {
2507
                                    $keep = false;
2508
                                }
2509
                                break;
2510
                        }
2511
                    }
2512
                }
2513
                if ($keep) {
2514
                    $mylist[$key] = $indi;
2515
                }
2516
            }
2517
            $this->list = $mylist;
2518
        }
2519
2520
        switch ($sortby) {
2521
            case 'NAME':
2522
                uasort($this->list, GedcomRecord::nameComparator());
2523
                break;
2524
            case 'CHAN':
2525
                uasort($this->list, GedcomRecord::lastChangeComparator());
2526
                break;
2527
            case 'BIRT:DATE':
2528
                uasort($this->list, Individual::birthDateComparator());
2529
                break;
2530
            case 'DEAT:DATE':
2531
                uasort($this->list, Individual::deathDateComparator());
2532
                break;
2533
            case 'MARR:DATE':
2534
                uasort($this->list, Family::marriageDateComparator());
2535
                break;
2536
            default:
2537
                // unsorted or already sorted by SQL
2538
                break;
2539
        }
2540
2541
        $this->repeats_stack[] = [$this->repeats, $this->repeat_bytes];
2542
        $this->repeat_bytes    = xml_get_current_line_number($this->parser) + 1;
2543
    }
2544
2545
    /**
2546
     * Handle </list>
2547
     *
2548
     * @return void
2549
     */
2550
    protected function listEndHandler(): void
2551
    {
2552
        $this->process_repeats--;
2553
        if ($this->process_repeats > 0) {
2554
            return;
2555
        }
2556
2557
        // Check if there is any list
2558
        if (count($this->list) > 0) {
2559
            $lineoffset = 0;
2560
            foreach ($this->repeats_stack as $rep) {
2561
                $lineoffset = $lineoffset + (int) $rep[1] - 1;
2562
            }
2563
            //-- read the xml from the file
2564
            $lines = file($this->report);
2565
            while ((!str_contains($lines[$lineoffset + $this->repeat_bytes], '<List')) && (($lineoffset + $this->repeat_bytes) > 0)) {
2566
                $lineoffset--;
2567
            }
2568
            $lineoffset++;
2569
            $reportxml = "<tempdoc>\n";
2570
            $line_nr   = $lineoffset + $this->repeat_bytes;
2571
            // List Level counter
2572
            $count = 1;
2573
            while (0 < $count) {
2574
                if (str_contains($lines[$line_nr], '<List')) {
2575
                    $count++;
2576
                } elseif (str_contains($lines[$line_nr], '</List')) {
2577
                    $count--;
2578
                }
2579
                if (0 < $count) {
2580
                    $reportxml .= $lines[$line_nr];
2581
                }
2582
                $line_nr++;
2583
            }
2584
            // No need to drag this
2585
            unset($lines);
2586
            $reportxml .= '</tempdoc>';
2587
            // Save original values
2588
            $this->parser_stack[] = $this->parser;
2589
            $oldgedrec            = $this->gedrec;
2590
2591
            $this->list_total   = count($this->list);
2592
            $this->list_private = 0;
2593
            foreach ($this->list as $record) {
2594
                if ($record->canShow()) {
2595
                    $this->gedrec = $record->privatizeGedcom(Auth::accessLevel($record->tree()));
2596
                    //-- start the sax parser
2597
                    $repeat_parser = xml_parser_create();
2598
                    $this->parser  = $repeat_parser;
2599
                    xml_parser_set_option($repeat_parser, XML_OPTION_CASE_FOLDING, 0);
2600
2601
                    xml_set_element_handler(
2602
                        $repeat_parser,
2603
                        function ($parser, string $name, array $attrs): void {
2604
                            $this->startElement($parser, $name, $attrs);
2605
                        },
2606
                        function ($parser, string $name): void {
2607
                            $this->endElement($parser, $name);
2608
                        }
2609
                    );
2610
2611
                    xml_set_character_data_handler(
2612
                        $repeat_parser,
2613
                        function ($parser, string $data): void {
2614
                            $this->characterData($parser, $data);
2615
                        }
2616
                    );
2617
2618
                    if (!xml_parse($repeat_parser, $reportxml, true)) {
2619
                        throw new DomainException(sprintf(
2620
                            'ListEHandler XML error: %s at line %d',
2621
                            xml_error_string(xml_get_error_code($repeat_parser)),
2622
                            xml_get_current_line_number($repeat_parser)
2623
                        ));
2624
                    }
2625
                    xml_parser_free($repeat_parser);
2626
                } else {
2627
                    $this->list_private++;
2628
                }
2629
            }
2630
            $this->list   = [];
2631
            $this->parser = array_pop($this->parser_stack);
2632
            $this->gedrec = $oldgedrec;
2633
        }
2634
        [$this->repeats, $this->repeat_bytes] = array_pop($this->repeats_stack);
2635
    }
2636
2637
    /**
2638
     * Handle <listTotal>
2639
     * Prints the total number of records in a list
2640
     * The total number is collected from <list> and <relatives>
2641
     *
2642
     * @return void
2643
     */
2644
    protected function listTotalStartHandler(): void
2645
    {
2646
        if ($this->list_private == 0) {
2647
            $this->current_element->addText((string) $this->list_total);
2648
        } else {
2649
            $this->current_element->addText(($this->list_total - $this->list_private) . ' / ' . $this->list_total);
2650
        }
2651
    }
2652
2653
    /**
2654
     * Handle <relatives>
2655
     *
2656
     * @param array<string> $attrs
2657
     *
2658
     * @return void
2659
     */
2660
    protected function relativesStartHandler(array $attrs): void
2661
    {
2662
        $this->process_repeats++;
2663
        if ($this->process_repeats > 1) {
2664
            return;
2665
        }
2666
2667
        $sortby = $attrs['sortby'] ?? 'NAME';
2668
2669
        $match = [];
2670
        if (preg_match("/\\$(\w+)/", $sortby, $match)) {
2671
            $sortby = $this->vars[$match[1]]['id'];
2672
            $sortby = trim($sortby);
2673
        }
2674
2675
        $maxgen = -1;
2676
        if (isset($attrs['maxgen'])) {
2677
            $maxgen = (int) $attrs['maxgen'];
2678
        }
2679
2680
        $group = $attrs['group'] ?? 'child-family';
2681
2682
        if (preg_match("/\\$(\w+)/", $group, $match)) {
2683
            $group = $this->vars[$match[1]]['id'];
2684
            $group = trim($group);
2685
        }
2686
2687
        $id = $attrs['id'] ?? '';
2688
2689
        if (preg_match("/\\$(\w+)/", $id, $match)) {
2690
            $id = $this->vars[$match[1]]['id'];
2691
            $id = trim($id);
2692
        }
2693
2694
        $this->list = [];
2695
        $person     = Registry::individualFactory()->make($id, $this->tree);
2696
        if ($person instanceof Individual) {
2697
            $this->list[$id] = $person;
2698
            $this->mfrelation[$id] = "";
2699
            $nam = $person->getAllNames()[0]['fullNN'];
0 ignored issues
show
Unused Code introduced by
The assignment to $nam is dead and can be removed.
Loading history...
2700
            switch ($group) {
2701
                case 'child-family':
2702
                    foreach ($person->childFamilies() as $family) {
2703
                        foreach ($family->spouses() as $spouse) {
2704
                            $this->list[$spouse->xref()] = $spouse;
2705
                        }
2706
2707
                        foreach ($family->children() as $child) {
2708
                            $this->list[$child->xref()] = $child;
2709
                        }
2710
                    }
2711
                    break;
2712
                case 'spouse-family':
2713
                    foreach ($person->spouseFamilies() as $family) {
2714
                        foreach ($family->spouses() as $spouse) {
2715
                            $this->list[$spouse->xref()] = $spouse;
2716
                        }
2717
2718
                        foreach ($family->children() as $child) {
2719
                            $this->list[$child->xref()] = $child;
2720
                        }
2721
                    }
2722
                    break;
2723
                case 'direct-ancestors':
2724
                    $this->addAncestors($this->list, $id, false, $maxgen);
2725
                    break;
2726
                case 'ancestors':
2727
                    $this->addAncestors($this->list, $id, true, $maxgen);
2728
                    break;
2729
                case 'descendants':
2730
                    $this->list[$id]->generation = 1;
2731
                    $this->addDescendancy($this->list, $id, false, $maxgen);
2732
                    break;
2733
                case 'all':
2734
                    $this->addAncestors($this->list, $id, true, $maxgen);
2735
                    $this->addDescendancy($this->list, $id, true, $maxgen);
2736
                    break;
2737
            }
2738
        }
2739
2740
        switch ($sortby) {
2741
            case 'NAME':
2742
                uasort($this->list, GedcomRecord::nameComparator());
2743
                break;
2744
            case 'BIRT:DATE':
2745
                uasort($this->list, Individual::birthDateComparator());
2746
                break;
2747
            case 'DEAT:DATE':
2748
                uasort($this->list, Individual::deathDateComparator());
2749
                break;
2750
            case 'generation':
2751
                $newarray = [];
2752
                reset($this->list);
2753
                $genCounter = 1;
2754
                while (count($newarray) < count($this->list)) {
2755
                    foreach ($this->list as $key => $value) {
2756
                        if ($value->generation < 0) {
2757
                            // indication of husband or wife
2758
                            $this->generation = -$value->generation;
2759
                        } else {
2760
                            $this->generation = $value->generation;
2761
                        }
2762
                        if ($this->generation == $genCounter) {
2763
                            $newarray[$key] = (object) ['generation' => $this->generation];
2764
                        }
2765
                    }
2766
                    $genCounter++;
2767
                }
2768
                $this->list = $newarray;
2769
                break;
2770
            default:
2771
                // unsorted
2772
                break;
2773
        }
2774
        $this->repeats_stack[] = [$this->repeats, $this->repeat_bytes];
2775
        $this->repeat_bytes    = xml_get_current_line_number($this->parser) + 1;
2776
    }
2777
2778
    /**
2779
     * Handle </relatives>
2780
     *
2781
     * @return void
2782
     */
2783
    protected function relativesEndHandler(): void
2784
    {
2785
        $this->process_repeats--;
2786
        if ($this->process_repeats > 0) {
2787
            return;
2788
        }
2789
2790
        // Check if there is any relatives
2791
        if (count($this->list) > 0) {
2792
            $lineoffset = 0;
2793
            foreach ($this->repeats_stack as $rep) {
2794
                $lineoffset = $lineoffset + (int) $rep[1] - 1;
2795
            }
2796
            //-- read the xml from the file
2797
            $lines = file($this->report);
2798
            while (!str_contains($lines[$lineoffset + $this->repeat_bytes], '<Relatives') && $lineoffset + $this->repeat_bytes > 0) {
2799
                $lineoffset--;
2800
            }
2801
            $lineoffset++;
2802
            $reportxml = "<tempdoc>\n";
2803
            $line_nr   = $lineoffset + $this->repeat_bytes;
2804
            // Relatives Level counter
2805
            $count = 1;
2806
            while (0 < $count) {
2807
                if (str_contains($lines[$line_nr], '<Relatives')) {
2808
                    $count++;
2809
                } elseif (str_contains($lines[$line_nr], '</Relatives')) {
2810
                    $count--;
2811
                }
2812
                if (0 < $count) {
2813
                    $reportxml .= $lines[$line_nr];
2814
                }
2815
                $line_nr++;
2816
            }
2817
            // No need to drag this
2818
            unset($lines);
2819
            $reportxml .= "</tempdoc>\n";
2820
            // Save original values
2821
            $this->parser_stack[] = $this->parser;
2822
            $oldgedrec            = $this->gedrec;
2823
2824
            $this->list_total   = count($this->list);
2825
            $this->list_private = 0;
2826
            foreach ($this->list as $key => $value) {
2827
                if (isset($value->generation)) {
2828
                    $this->generation = $value->generation;
2829
                }
2830
                $xref = $key;
2831
                $this->vars["dupl"]["id"] = "no";
2832
                if (substr($key, 0, 2) == "D_") {
2833
                    $xref = substr($key, strrpos($key, "_") + 1);
2834
                    $this->vars["dupl"]["id"] = "yes";
2835
                }
2836
                $tmp          = Registry::gedcomRecordFactory()->make((string) $xref, $this->tree);
2837
                $this->gedrec = $tmp->privatizeGedcom(Auth::accessLevel($this->tree));
2838
2839
                $repeat_parser = xml_parser_create();
2840
                $this->parser  = $repeat_parser;
2841
                xml_parser_set_option($repeat_parser, XML_OPTION_CASE_FOLDING, 0);
2842
2843
                xml_set_element_handler(
2844
                    $repeat_parser,
2845
                    function ($parser, string $name, array $attrs): void {
2846
                        $this->startElement($parser, $name, $attrs);
2847
                    },
2848
                    function ($parser, string $name): void {
2849
                        $this->endElement($parser, $name);
2850
                    }
2851
                );
2852
2853
                xml_set_character_data_handler(
2854
                    $repeat_parser,
2855
                    function ($parser, string $data): void {
2856
                        $this->characterData($parser, $data);
2857
                    }
2858
                );
2859
2860
                if (!xml_parse($repeat_parser, $reportxml, true)) {
2861
                    throw new DomainException(sprintf('RelativesEHandler XML error: %s at line %d', xml_error_string(xml_get_error_code($repeat_parser)), xml_get_current_line_number($repeat_parser)));
2862
                }
2863
                xml_parser_free($repeat_parser);
2864
            }
2865
            // Clean up the list array
2866
            $this->list   = [];
2867
            $this->parser = array_pop($this->parser_stack);
2868
            $this->gedrec = $oldgedrec;
2869
        }
2870
        [$this->repeats, $this->repeat_bytes] = array_pop($this->repeats_stack);
2871
    }
2872
2873
    /**
2874
     * Handle <generation />
2875
     * Prints the number of generations
2876
     *
2877
     * @return void
2878
     */
2879
    protected function generationStartHandler(): void
2880
    {
2881
        $this->current_element->addText((string) $this->generation);
2882
    }
2883
2884
    /**
2885
     * Handle <newPage />
2886
     * Has to be placed in an element (header, body or footer)
2887
     *
2888
     * @return void
2889
     */
2890
    protected function newPageStartHandler(): void
2891
    {
2892
        $temp = 'addpage';
2893
        $this->wt_report->addElement($temp);
2894
    }
2895
2896
    /**
2897
     * Handle </title>
2898
     *
2899
     * @return void
2900
     */
2901
    protected function titleEndHandler(): void
2902
    {
2903
        $this->report_root->addTitle($this->text);
2904
    }
2905
2906
    /**
2907
     * Handle </description>
2908
     *
2909
     * @return void
2910
     */
2911
    protected function descriptionEndHandler(): void
2912
    {
2913
        $this->report_root->addDescription($this->text);
2914
    }
2915
2916
    /**
2917
     * Create a list of all descendants.
2918
     *
2919
     * @param array<Individual> $list
2920
     * @param string            $pid
2921
     * @param bool              $parents
2922
     * @param int               $generations
2923
     *
2924
     * @return void
2925
     */
2926
    private function addDescendancy(&$list, $pid, $parents = false, $generations = -1): void
2927
    {
2928
        $person = Registry::individualFactory()->make($pid, $this->tree);
2929
        if ($person === null) {
2930
            return;
2931
        }
2932
2933
        static $focusperson = true;
2934
        static $dupl = 1;
2935
        $sx = $person->sex();
2936
        $rl = "x"; // unknown
2937
        if ($sx == "M") {
2938
            $rl = "s";
2939
        } // son
2940
        if ($sx == "F") {
2941
            $rl = "d";
0 ignored issues
show
Unused Code introduced by
The assignment to $rl is dead and can be removed.
Loading history...
2942
        } // daughter
2943
        if ($focusperson) {
2944
            $this->mfrelation[$pid] = "";
2945
        }
2946
        $nam = $person->getAllNames()[0]['fullNN'];
0 ignored issues
show
Unused Code introduced by
The assignment to $nam is dead and can be removed.
Loading history...
2947
2948
        $newpid = $pid;
2949
        if (!isset($list[$pid])) {
2950
            $list[$pid] = $person;
2951
        } elseif (!$focusperson) {
2952
            $newpid = "D_" . $dupl . "_" . $pid;
2953
            $list[$newpid] = $person;
2954
        }
2955
        if (!isset($list[$newpid]->generation)) {
2956
            $list[$newpid]->generation = 0;
2957
        }
2958
        $focusperson = false;
2959
        foreach ($person->spouseFamilies() as $family) {
2960
            if ($parents) {
2961
                $husband = $family->husband();
2962
                $wife    = $family->wife();
2963
                if ($husband) {
2964
                    $list[$husband->xref()] = $husband;
2965
                    if (isset($list[$pid]->generation)) {
2966
                        $list[$husband->xref()]->generation = $list[$pid]->generation - 1;
2967
                    } else {
2968
                        $list[$husband->xref()]->generation = 1;
2969
                    }
2970
                }
2971
                if ($wife) {
2972
                    $list[$wife->xref()] = $wife;
2973
                    if (isset($list[$pid]->generation)) {
2974
                        $list[$wife->xref()]->generation = $list[$pid]->generation - 1;
2975
                    } else {
2976
                        $list[$wife->xref()]->generation = 1;
2977
                    }
2978
                }
2979
            }
2980
            $husband = $family->husband();
2981
            $wife = $family->wife();
2982
2983
            if ($husband && $wife) {
2984
                if ($husband->xref() == $person->xref()) {
2985
                    $this->mfrelation[$wife->xref()] = $this->mfrelation[$person->xref()] . "x";
2986
                    if ($wife->canShow()) {
2987
                        $list[$wife->xref()] = $wife;
2988
                    }
2989
                    if (!isset($wife->generation)) {
2990
                        $wife->generation = $person->generation;
2991
                    }
2992
                    $nam = $wife->getAllNames()[0]['fullNN'];
2993
                } else {
2994
                    $this->mfrelation[$husband->xref()] = $this->mfrelation[$person->xref()] . "x";
2995
                    if ($husband->canShow()) {
2996
                        $list[$husband->xref()] = $husband;
2997
                    }
2998
                    if (!isset($husband->generation)) {
2999
                        $husband->generation = $person->generation;
3000
                    }
3001
                    $nam = $husband->getAllNames()[0]['fullNN'];
3002
                }
3003
            }
3004
3005
            $children = $family->children();
3006
            foreach ($children as $child) {
3007
                if ($child) {
3008
                    $sx = $child->sex();
3009
                    $rl = "x"; // unknown
3010
                    if ($sx == "M") {
3011
                        $rl = "s";
3012
                    } // son
3013
                    if ($sx == "F") {
3014
                        $rl = "d";
3015
                    } // daughter
3016
                    $rl = $this->mfrelation[$person->xref()] . $rl;
3017
                    $this->mfrelation[$child->xref()] = $rl;
3018
                    if (isset($list[$pid]->generation)) {
3019
                        $child->generation = $list[$pid]->generation + 1;
3020
                    } else {
3021
                        $child->generation = 2;
3022
                    }
3023
                }
3024
            }
3025
            if ($generations == -1 || $list[$pid]->generation < $generations) {
3026
                foreach ($children as $child) {
3027
                    if ($child->canShow()) {
3028
                        $this->addDescendancy($list, $child->xref(), $parents, $generations);
3029
                    } // recurse on the childs family
3030
                }
3031
            }
3032
        }
3033
        $focusperson = false;
0 ignored issues
show
Unused Code introduced by
The assignment to $focusperson is dead and can be removed.
Loading history...
3034
    }
3035
3036
    /**
3037
     * Create a list of all ancestors.
3038
     *
3039
     * @param array<Individual> $list
3040
     * @param string            $pid
3041
     * @param bool              $children
3042
     * @param int               $generations
3043
     *
3044
     * @return void
3045
     */
3046
    private function addAncestors(array &$list, string $pid, bool $children = false, int $generations = -1): void
3047
    {
3048
        $genlist                = [$pid];
3049
        $list[$pid]->generation = 1;
3050
        while (count($genlist) > 0) {
3051
            $id = array_shift($genlist);
3052
            if (str_starts_with($id, 'empty')) {
3053
                continue; // id can be something like “empty7”
3054
            }
3055
            if (!isset($this->mfrelation[$id])) {
3056
                $this->mfrelation[$id] = "";
3057
            }
3058
            $person = Registry::individualFactory()->make($id, $this->tree);
3059
            foreach ($person->childFamilies() as $family) {
3060
                $husband = $family->husband();
3061
                $wife    = $family->wife();
3062
                if ($husband) {
3063
                    $list[$husband->xref()]             = $husband;
3064
                    $list[$husband->xref()]->generation = $list[$id]->generation + 1;
3065
                    $this->mfrelation[$husband->xref()] = $this->mfrelation[$id] . "f";
3066
                }
3067
                if ($wife) {
3068
                    $list[$wife->xref()]             = $wife;
3069
                    $list[$wife->xref()]->generation = $list[$id]->generation + 1;
3070
                    $this->mfrelation[$wife->xref()] = $this->mfrelation[$id] . "m";
3071
                }
3072
                if ($generations == -1 || $list[$id]->generation + 1 < $generations) {
3073
                    if ($husband) {
3074
                        $genlist[] = $husband->xref();
3075
                    }
3076
                    if ($wife) {
3077
                        $genlist[] = $wife->xref();
3078
                    }
3079
                }
3080
                if ($children && isset($person)) {
3081
                    // unnecessary test of $person to satisfy phpstan!
3082
                    foreach ($family->children() as $child) {
3083
                        $list[$child->xref()] = $child;
3084
                        $child->generation = $list[$id]->generation ?? 1;
3085
                        if ($child->xref() != $person->xref()) {
3086
                            $this->mfrelation[$child->xref()] = $this->mfrelation[$id] . "x";
3087
                        }
3088
                    }
3089
                }
3090
            }
3091
        }
3092
    }
3093
3094
    /**
3095
     * get gedcom tag value
3096
     *
3097
     * @param string $tag    The tag to find, use : to delineate subtags
3098
     * @param int    $level  The gedcom line level of the first tag to find, setting level to 0 will cause it to use 1+ the level of the incoming record
3099
     * @param string $gedrec The gedcom record to get the value from
3100
     *
3101
     * @return string the value of a gedcom tag from the given gedcom record
3102
     */
3103
    private function getGedcomValue(string $tag, int $level, string $gedrec): string
3104
    {
3105
        if ($gedrec === '') {
3106
            return '';
3107
        }
3108
        $tags      = explode(':', $tag);
3109
        $origlevel = $level;
3110
        if ($level === 0) {
3111
            $level = $gedrec[0] + 1;
3112
        }
3113
3114
        $subrec = $gedrec;
3115
        $t = 'XXXX';
3116
        foreach ($tags as $t) {
3117
            $lastsubrec = $subrec;
3118
            $subrec     = self::getSubRecord($level, "$level $t", $subrec);
3119
            if (empty($subrec) && $origlevel == 0) {
3120
                $level--;
3121
                $subrec = self::getSubRecord($level, "$level $t", $lastsubrec);
3122
            }
3123
            if (empty($subrec)) {
3124
                if ($t === 'TITL') {
3125
                    $subrec = self::getSubRecord($level, "$level ABBR", $lastsubrec);
3126
                    if (!empty($subrec)) {
3127
                        $t = 'ABBR';
3128
                    }
3129
                }
3130
                if ($subrec === '') {
3131
                    if ($level > 0) {
3132
                        $level--;
3133
                    }
3134
                    $subrec = self::getSubRecord($level, "@ $t", $gedrec);
3135
                    if ($subrec === '') {
3136
                        return '';
3137
                    }
3138
                }
3139
            }
3140
            $level++;
3141
        }
3142
        $level--;
3143
        $ct = preg_match("/$level $t(.*)/", $subrec, $match);
3144
        if ($ct === 0) {
3145
            $ct = preg_match("/$level @.+@ (.+)/", $subrec, $match);
3146
        }
3147
        if ($ct === 0) {
3148
            $ct = preg_match("/@ $t (.+)/", $subrec, $match);
3149
        }
3150
        if ($ct > 0) {
3151
            $value = trim($match[1]);
3152
            if ($t === 'NOTE' && preg_match('/^@(.+)@$/', $value, $match)) {
3153
                $note = Registry::noteFactory()->make($match[1], $this->tree);
3154
                if ($note instanceof Note) {
3155
                    $value = $note->getNote();
3156
                } else {
3157
                    //-- set the value to the id without the @
3158
                    $value = $match[1];
3159
                }
3160
            }
3161
            if ($level !== 0 || $t !== 'NOTE') {
3162
                $value .= self::getCont($level + 1, $subrec);
3163
            }
3164
3165
            if ($tag === 'NAME' || $tag === '_MARNM' || $tag === '_AKA') {
3166
                return strtr($value, ['/' => '']);
3167
            }
3168
3169
            if ($tag === 'NAME' || $tag === '_MARNM' || $tag === '_AKA') {
3170
                return strtr($value, ['/' => '']);
3171
            }
3172
3173
            return $value;
3174
        }
3175
3176
        return '';
3177
    }
3178
3179
    /**
3180
     * Replace variable identifiers with their values.
3181
     *
3182
     * @param string $expression An expression such as "$foo == 123"
3183
     * @param bool   $quote      Whether to add quotation marks
3184
     *
3185
     * @return string
3186
     */
3187
    private function substituteVars($expression, $quote): string
3188
    {
3189
        return preg_replace_callback(
3190
            '/\$(\w+)/',
3191
            function (array $matches) use ($quote): string {
3192
                if (isset($this->vars[$matches[1]]['id'])) {
3193
                    if ($quote) {
3194
                        return "'" . addcslashes($this->vars[$matches[1]]['id'], "'") . "'";
3195
                    }
3196
3197
                    return $this->vars[$matches[1]]['id'];
3198
                }
3199
3200
                Log::addErrorLog(sprintf('Undefined variable $%s in report', $matches[1]));
3201
3202
                return '$' . $matches[1];
3203
            },
3204
            $expression
3205
        );
3206
    }
3207
}
3208