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

ReportParserGenerate::getPersonNameStartHandler()   F

Complexity

Conditions 25
Paths 756

Size

Total Lines 78
Code Lines 59

Duplication

Lines 0
Ratio 0 %

Importance

Changes 2
Bugs 0 Features 0
Metric Value
cc 25
eloc 59
c 2
b 0
f 0
nc 756
nop 1
dl 0
loc 78
rs 0.3388

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

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