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

ReportParserGenerate::varStartHandler()   F

Complexity

Conditions 19
Paths 1261

Size

Total Lines 61
Code Lines 39

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 19
eloc 39
nc 1261
nop 1
dl 0
loc 61
rs 0.3499
c 0
b 0
f 0

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\Elements\UnknownElement;
26
use Fisharebest\Webtrees\Factories\MarkdownFactory;
27
use Fisharebest\Webtrees\Family;
28
use Fisharebest\Webtrees\Gedcom;
29
use Fisharebest\Webtrees\GedcomRecord;
30
use Fisharebest\Webtrees\I18N;
31
use Fisharebest\Webtrees\Individual;
32
use Fisharebest\Webtrees\Log;
33
use Fisharebest\Webtrees\MediaFile;
34
use Fisharebest\Webtrees\Note;
35
use Fisharebest\Webtrees\Place;
36
use Fisharebest\Webtrees\Registry;
37
use Fisharebest\Webtrees\Tree;
38
use Illuminate\Database\Capsule\Manager as DB; // webtrees 2.1.x
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
        $namesep = "";
1013
        if (isset($attrs['name_sep'])) {
1014
            $namesep = $attrs['name_sep'];
1015
        }
1016
        $famrel = false;
1017
        if (isset($attrs['fam_relation'])) {
1018
            $famrel = true;
1019
        }
1020
        if (!empty($id)) {
1021
            $record = Registry::gedcomRecordFactory()->make($id, $this->tree);
1022
            if ($record === null) {
1023
                return;
1024
            }
1025
            if (!$record->canShowName()) {
1026
                $this->current_element->addText(I18N::translate('Private'));
1027
            } elseif ($nameselect == 'latest') {
1028
                $tmp = $record->getAllNames();
1029
                $name  = strip_tags($tmp[count($tmp) - 1]['full']);
1030
                $this->current_element->addText(trim($name));
1031
            } elseif ($nameselect == 'combined') {
1032
                $tmp = $record->getAllNames();
1033
                $name = $tmp[count($tmp) - 1]['full'];
1034
                $ix1 = strpos($name, '<span class="starredname">');
1035
                if ($ix1 !== false) {   // '«' and '»' mark text for underlining
1036
                    $name = substr_replace($name, '«', $ix1, 26);
1037
                    $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

1037
                    $ix1 = strpos(/** @scrutinizer ignore-type */ $name, '</span>', $ix1);
Loading history...
1038
                    if ($ix1 !== false) {   // '«' and '»' mark text for underlining
1039
                        $name = substr_replace($name, '»', $ix1, 7);
1040
                    }
1041
                }
1042
                $addname = strip_tags((string) $tmp[0]['surn']);
1043
                if (!empty($addname) && !($addname === '@N.N.') && !str_contains($name, $addname)) {
1044
                    $name .= " " . $namesep . " " . $addname;
1045
                }
1046
                $this->current_element->addText(trim($name));
1047
            } else {
1048
                $name = $record->fullName();
1049
                $name = strip_tags($name);
1050
                if (!empty($attrs['truncate'])) {
1051
                    if ((int) $attrs['truncate'] > 0) {
1052
                        $name = Str::limit($name, (int) $attrs['truncate'], I18N::translate('…'));
1053
                    }
1054
                } else {
1055
                    $addname = (string) $record->alternateName();
1056
                    $addname = strip_tags($addname);
1057
                    if (!empty($addname)) {
1058
                        $name .= ' ' . $addname;
1059
                    }
1060
                }
1061
                $this->current_element->addText(trim($name));
1062
            }
1063
        }
1064
        if (isset($record) && $famrel && ($this->mfrelation[$record->xref()] != "")) {
1065
            $this->current_element->addText(" (" . (string) $this->mfrelation[$record->xref()] . ")");
1066
        }
1067
    }
1068
1069
    /**
1070
     * Handle <gedcomValue />
1071
     *
1072
     * @param array<string> $attrs
1073
     *
1074
     * @return void
1075
     */
1076
    protected function gedcomValueStartHandler(array $attrs): void
1077
    {
1078
        $id    = '';
1079
        $match = [];
1080
        if (preg_match('/0 @(.+)@/', $this->gedrec, $match)) {
1081
            $id = $match[1];
1082
        }
1083
1084
        if (isset($attrs['newline']) && $attrs['newline'] === '1') {
1085
            $useBreak = '1';
1086
        } else {
1087
            $useBreak = '0';
1088
        }
1089
1090
        $tag = $attrs['tag'];
1091
        if (!empty($tag)) {
1092
            if ($tag === '@desc') {
1093
                $value = $this->desc;
1094
                $value = trim($value);
1095
                $this->current_element->addText($value);
1096
            }
1097
            if ($tag === '@id') {
1098
                $this->current_element->addText($id);
1099
            } else {
1100
                $tag = str_replace('@fact', $this->fact, $tag);
1101
                if (empty($attrs['level'])) {
1102
                    $level = (int) explode(' ', trim($this->gedrec))[0];
1103
                    if ($level === 0) {
1104
                        $level++;
1105
                    }
1106
                } else {
1107
                    $level = (int) $attrs['level'];
1108
                }
1109
                $tags  = preg_split('/[: ]/', $tag);
1110
                $value = $this->getGedcomValue($tag, $level, $this->gedrec);
1111
                switch (end($tags)) {
1112
                    case 'DATE':
1113
                        $tmp   = new Date($value);
1114
                        $dfmt = "%j %F %Y";
1115
                        if (!empty($attrs['truncate'])) {
1116
                            if ($attrs['truncate'] === "d") {
1117
                                $dfmt = "%j %M %Y";
1118
                            }
1119
                            if ($attrs['truncate'] === "Y") {
1120
                                $dfmt = "%Y";
1121
                            }
1122
                        }
1123
                        $value = strip_tags($tmp->display(null, $dfmt));
1124
                        break;
1125
                    case 'PLAC':
1126
                        $tmp   = new Place($value, $this->tree);
1127
                        $value = $tmp->shortName();
1128
                        break;
1129
                }
1130
                if ($useBreak === '1') {
1131
                    // Insert <br> when multiple dates exist.
1132
                    // This works around a TCPDF bug that incorrectly wraps RTL dates on LTR pages
1133
                    $value = str_replace('(', '<br>(', $value);
1134
                    $value = str_replace('<span dir="ltr"><br>', '<br><span dir="ltr">', $value);
1135
                    $value = str_replace('<span dir="rtl"><br>', '<br><span dir="rtl">', $value);
1136
                    if (substr($value, 0, 4) === '<br>') {
1137
                        $value = substr($value, 4);
1138
                    }
1139
                }
1140
                $tmp = explode(':', $tag);
1141
                if (in_array(end($tmp), ['NOTE', 'TEXT'], true)) {
1142
                    if ($this->tree->getPreference('FORMAT_TEXT') === 'xxmarkdown') {
1143
                        $value = strip_tags(Registry::markdownFactory()->markdown($value, $this->tree), ['br']);
1144
                    } else {
1145
                        $value = str_replace("\n", "<br>", $value);
1146
                        //$value = strip_tags(Registry::markdownFactory()->autolink($value, $this->tree), ['br']);
1147
                    }
1148
                    $value = strtr($value, [MarkdownFactory::BREAK => ' ']);
1149
                }
1150
1151
                if (isset($attrs['lcfirst'])) {
1152
                    $value = lcfirst($value);
1153
                    $value = str_replace(["Å","Ä","Ö"], ["å","ä","ö"], $value);
1154
                }
1155
1156
                if (!empty($attrs['truncate'])) {
1157
                    $value = strip_tags($value);
1158
                    if ((int) $attrs['truncate'] > 0) {
1159
                        $value = Str::limit($value, (int) $attrs['truncate'], I18N::translate('…'));
1160
                    }
1161
                }
1162
                $this->current_element->addText($value);
1163
            }
1164
        }
1165
    }
1166
1167
    /**
1168
     * Handle <repeatTag>
1169
     *
1170
     * @param array<string> $attrs
1171
     *
1172
     * @return void
1173
     */
1174
    protected function repeatTagStartHandler(array $attrs): void
1175
    {
1176
        $this->process_repeats++;
1177
        if ($this->process_repeats > 1) {
1178
            return;
1179
        }
1180
1181
        $this->repeats_stack[] = [$this->repeats, $this->repeat_bytes];
1182
        $this->repeats         = [];
1183
        $this->repeat_bytes    = xml_get_current_line_number($this->parser);
1184
1185
        $tag = $attrs['tag'] ?? '';
1186
        if (!empty($tag)) {
1187
            if ($tag === '@desc') {
1188
                $value = $this->desc;
1189
                $value = trim($value);
1190
                $this->current_element->addText($value);
1191
            } else {
1192
                $tag   = str_replace('@fact', $this->fact, $tag);
1193
                $tags  = explode(':', $tag);
1194
                $level = (int) explode(' ', trim($this->gedrec))[0];
1195
                if ($level === 0) {
1196
                    $level++;
1197
                }
1198
                $subrec = $this->gedrec;
1199
                $t      = $tag;
1200
                $count  = count($tags);
1201
                $i      = 0;
1202
                while ($i < $count) {
1203
                    $t = $tags[$i];
1204
                    if (!empty($t)) {
1205
                        if ($i < ($count - 1)) {
1206
                            $subrec = self::getSubRecord($level, "$level $t", $subrec);
1207
                            if (empty($subrec)) {
1208
                                $level--;
1209
                                $subrec = self::getSubRecord($level, "@ $t", $this->gedrec);
1210
                                if (empty($subrec)) {
1211
                                    return;
1212
                                }
1213
                            }
1214
                        }
1215
                        $level++;
1216
                    }
1217
                    $i++;
1218
                }
1219
                $level--;
1220
                $count = preg_match_all("/$level $t(.*)/", $subrec, $match, PREG_SET_ORDER);
1221
                $i     = 0;
1222
                while ($i < $count) {
1223
                    $i++;
1224
                    // Privacy check - is this a link, and are we allowed to view the linked object?
1225
                    $subrecord = self::getSubRecord($level, "$level $t", $subrec, $i);
1226
                    if (preg_match('/^\d ' . Gedcom::REGEX_TAG . ' @(' . Gedcom::REGEX_XREF . ')@/', $subrecord, $xref_match)) {
1227
                        $linked_object = Registry::gedcomRecordFactory()->make($xref_match[1], $this->tree);
1228
                        if ($linked_object && !$linked_object->canShow()) {
1229
                            //continue;
1230
                        }
1231
                    }
1232
                    $this->repeats[] = $subrecord;
1233
                }
1234
            }
1235
        }
1236
    }
1237
1238
    /**
1239
     * Handle </repeatTag>
1240
     *
1241
     * @return void
1242
     */
1243
    protected function repeatTagEndHandler(): void
1244
    {
1245
        $this->process_repeats--;
1246
        if ($this->process_repeats > 0) {
1247
            return;
1248
        }
1249
1250
        $nnnn = count($this->repeats);
0 ignored issues
show
Unused Code introduced by
The assignment to $nnnn is dead and can be removed.
Loading history...
1251
        $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...
1252
        // Check if there is anything to repeat
1253
        if (count($this->repeats) > 0) {
1254
            // No need to load them if not used...
1255
1256
            //-- read the xml from the file
1257
            $lines = file($this->report);
1258
            if (empty($lines)) {
1259
                error_log(__FILE__ . ":" . __LINE__ . " impossible error!? \n");
1260
                // this can not happen! phpstan forces me to add stupid code
1261
                // we come here because the xml file exists! Is it possible to tell phpstan the $lines *is* an array ??
1262
                die("can not happen!!!");
0 ignored issues
show
Best Practice introduced by
Using exit here is not recommended.

In general, usage of exit should be done with care and only when running in a scripting context like a CLI script.

Loading history...
1263
            }
1264
            $lineoffset = 0;
1265
            foreach ($this->repeats_stack as $rep) {
1266
                if (!empty($rep[1])) {
1267
                    $lineoffset = $lineoffset + (int) ($rep[1]) - 1;
1268
                }
1269
            }
1270
            while (!str_contains($lines[$lineoffset + $this->repeat_bytes], '<RepeatTag')) {
1271
                $lineoffset--;
1272
            }
1273
            $lineoffset++;
1274
            $reportxml = "<tempdoc>\n";
1275
            $line_nr   = $lineoffset + $this->repeat_bytes;
1276
            $lnnn = $line_nr;
0 ignored issues
show
Unused Code introduced by
The assignment to $lnnn is dead and can be removed.
Loading history...
1277
            // RepeatTag Level counter
1278
            $count = 1;
1279
            while (0 < $count) {
1280
                if (str_contains($lines[$line_nr], '<RepeatTag')) {
1281
                    $count++;
1282
                } elseif (str_contains($lines[$line_nr], '</RepeatTag')) {
1283
                    $count--;
1284
                }
1285
                if (0 < $count) {
1286
                    $reportxml .= $lines[$line_nr];
1287
                }
1288
                $line_nr++;
1289
            }
1290
            // No need to drag this
1291
            unset($lines);
1292
            $reportxml .= "</tempdoc>\n";
1293
            // Save original values
1294
            $this->parser_stack[] = $this->parser;
1295
            $oldgedrec            = $this->gedrec;
1296
            foreach ($this->repeats as $gedrec) {
1297
                $this->gedrec  = $gedrec;
1298
                $repeat_parser = xml_parser_create();
1299
                $this->parser  = $repeat_parser;
1300
                xml_parser_set_option($repeat_parser, XML_OPTION_CASE_FOLDING, 0);
1301
1302
                xml_set_element_handler(
1303
                    $repeat_parser,
1304
                    function ($parser, string $name, array $attrs): void {
1305
                        $this->startElement($parser, $name, $attrs);
1306
                    },
1307
                    function ($parser, string $name): void {
1308
                        $this->endElement($parser, $name);
1309
                    }
1310
                );
1311
1312
                xml_set_character_data_handler(
1313
                    $repeat_parser,
1314
                    function ($parser, string $data): void {
1315
                        $this->characterData($parser, $data);
1316
                    }
1317
                );
1318
1319
                if (!xml_parse($repeat_parser, $reportxml, true)) {
1320
                    throw new DomainException(sprintf(
1321
                        'RepeatTagEHandler XML error: %s at line %d',
1322
                        xml_error_string(xml_get_error_code($repeat_parser)),
1323
                        xml_get_current_line_number($repeat_parser)
1324
                    ));
1325
                }
1326
                xml_parser_free($repeat_parser);
1327
            }
1328
            // Restore original values
1329
            $this->gedrec = $oldgedrec;
1330
            $this->parser = array_pop($this->parser_stack);
1331
        }
1332
        [$this->repeats, $this->repeat_bytes] = array_pop($this->repeats_stack);
1333
    }
1334
1335
    /**
1336
     * Variable lookup
1337
     * Retrieve predefined variables :
1338
     * @ desc GEDCOM fact description, example:
1339
     *        1 EVEN This is a description
1340
     * @ fact GEDCOM fact tag, such as BIRT, DEAT etc.
1341
     * $ I18N::translate('....')
1342
     * $ language_settings[]
1343
     *
1344
     * @param array<string> $attrs an array of key value pairs for the attributes
1345
     *
1346
     * @return void
1347
     */
1348
    protected function varStartHandler(array $attrs): void
1349
    {
1350
        if (!isset($attrs['var'])) {
1351
            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));
1352
        }
1353
1354
        $var = $attrs['var'];
1355
        // SetVar element preset variables
1356
        if (!empty($this->vars[$var]['id'])) {
1357
            $var = $this->vars[$var]['id'];
1358
        } else {
1359
            $tfact = $this->fact;
1360
            if (($this->fact === 'EVEN' || $this->fact === 'FACT') && $this->type !== '') {
1361
                // Use :
1362
                // n TYPE This text if string
1363
                $tfact = $this->type;
1364
            } else {
1365
                foreach ([Individual::RECORD_TYPE, Family::RECORD_TYPE] as $record_type) {
1366
                    $element = Registry::elementFactory()->make($record_type . ':' . $this->fact);
1367
1368
                    if (!$element instanceof UnknownElement) {
1369
                        $tfact = $element->label();
1370
                        break;
1371
                    }
1372
                }
1373
            }
1374
1375
            $var = strtr($var, ['@desc' => $this->desc, '@fact' => $tfact]);
1376
1377
            if (preg_match('/^I18N::number\((.+)\)$/', $var, $match)) {
1378
                $var = I18N::number((int) $match[1]);
1379
            } elseif (preg_match('/^I18N::translate\(\'(.+)\'\)$/', $var, $match)) {
1380
                $var = I18N::translate($match[1]);
1381
            } elseif (preg_match('/^I18N::translate\(\$(.+)\)$/', $var, $match)) {
1382
                $var = I18N::translate($this->vars[$match[1]]['id']);
1383
            } elseif (preg_match('/^I18N::translateContext\(\'(.+)\', *\'(.+)\'\)$/', $var, $match)) {
1384
                $var = I18N::translateContext($match[1], $match[2]);
1385
            }
1386
        }
1387
        // Check if variable is set as a date and reformat the date
1388
        if (isset($attrs['date'])) {
1389
            if ($attrs['date'] === '1') {
1390
                $g   = new Date($var);
1391
                $var = $g->display();
1392
            }
1393
        }
1394
        if (isset($attrs['amp'])) {
1395
            $var = str_replace("%26", '&', $var);
1396
        }
1397
        if (isset($attrs['cut'])) {
1398
            $cut = (int) $attrs['cut'];
1399
            $var = $cut > 0 ? substr($var, 0, $cut) : substr($var, $cut);
1400
            if ($cut == 0) {
1401
                $var = "";
1402
            }
1403
        }
1404
        if (isset($attrs['lcfirst'])) {
1405
            $var = lcfirst($var);
1406
        }
1407
        $this->current_element->addText($var);
1408
        $this->text = $var; // Used for title/description
1409
    }
1410
1411
    /**
1412
     * Handle <facts>
1413
     *
1414
     * @param array<string> $attrs
1415
     *
1416
     * @return void
1417
     */
1418
    protected function factsStartHandler(array $attrs): void
1419
    {
1420
        $this->process_repeats++;
1421
        if ($this->process_repeats > 1) {
1422
            return;
1423
        }
1424
1425
        $this->repeats_stack[] = [$this->repeats, $this->repeat_bytes];
1426
        $this->repeats         = [];
1427
        $this->repeat_bytes    = xml_get_current_line_number($this->parser);
1428
1429
        $id    = '';
1430
        $match = [];
1431
        if (preg_match('/0 @(.+)@/', $this->gedrec, $match)) {
1432
            $id = $match[1];
1433
        }
1434
        $tag = '';
1435
        if (isset($attrs['ignore'])) {
1436
            $tag .= $attrs['ignore'];
1437
        }
1438
        if (preg_match('/\$(.+)/', $tag, $match)) {
1439
            $tag = $this->vars[$match[1]]['id'];
1440
        }
1441
1442
        $record = Registry::gedcomRecordFactory()->make($id, $this->tree);
1443
        if (empty($attrs['diff']) && !empty($id)) {
1444
            $facts = $record->facts([], true);
1445
            $this->repeats = [];
1446
            $nonfacts      = explode(',', $tag);
1447
            foreach ($facts as $fact) {
1448
                $tag = explode(':', $fact->tag())[1];
1449
1450
                if (!in_array($tag, $nonfacts, true)) {
1451
                    $this->repeats[] = $fact->gedcom();
1452
                }
1453
            }
1454
        } else {
1455
            foreach ($record->facts() as $fact) {
1456
                if (($fact->isPendingAddition() || $fact->isPendingDeletion()) && !str_ends_with($fact->tag(), ':CHAN')) {
1457
                    $this->repeats[] = $fact->gedcom();
1458
                }
1459
            }
1460
        }
1461
1462
        $jdarr = [];
1463
        // Add fact/event for FAM:DIV and for death of spouse
1464
        foreach ($this->repeats as $key => $fact) {
1465
            $jdarr[$key] = 0;
1466
            if (preg_match('/1 FAMS @(.+)@/', $fact, $match)) {
1467
                $famid = $match[1];
1468
                $fam = Registry::familyFactory()->make($match[1], $this->tree);
1469
                if ($fam === null) {
1470
                    continue;
1471
                }
1472
                $dt = $this->getGedcomValue("MARR:DATE", 0, $fam->gedcom());
1473
                if ($dt == "") {
1474
                    $dt = $this->getGedcomValue("ENGA:DATE", 0, $fam->gedcom());
1475
                }
1476
                if ($dt == "" && $this->getGedcomValue("EVEN:TYPE", 0, $fam->gedcom()) == "Sambo") {
1477
                    $dt = $this->getGedcomValue("EVEN:DATE", 0, $fam->gedcom());
1478
                }
1479
                $date = new Date($dt);
1480
                $jd = $date->julianDay();
1481
                $jdarr[$key] = $jd;
1482
                // Divorce
1483
                $dt = $this->getGedcomValue("DIV:DATE", 0, $fam->gedcom());
1484
                if ($dt != "") {
1485
                    $this->repeats[] = "1 DIV\n2 DATE " . $dt . "\n";
1486
                }
1487
                // Separation // Doesn't work!! getGedComValue only reports the first event!! I.e. no match here
1488
                if ($this->getGedcomValue("EVEN:TYPE", 0, $fam->gedcom()) == "Separation") {
1489
                    $dt = $this->getGedcomValue("EVEN:DATE", 0, $fam->gedcom());
1490
                    if ($dt != "") {
1491
                        $this->repeats[] = "1 EVEN\n2 TYPE Separation\n2 DATE " . $dt . "\n";
1492
                    }
1493
                }
1494
                // death of husband / wife
1495
                $husb = $fam->husband();
1496
                $wife = $fam->wife();
1497
                if ($this->getGedcomValue("SEX", 0, $this->gedrec) == "M") {
1498
                    $spouse = $wife;
1499
                } else {
1500
                    $spouse = $husb;
1501
                }
1502
                if ($spouse) {
1503
                    $dt = $this->getGedcomValue("DEAT:DATE", 0, $spouse->gedcom());
1504
                } else {
1505
                    $dt = "";
1506
                }
1507
                if ($dt != "") {
1508
                    $this->repeats[] = "1 _SP_DEAT\n2 DATE " . $dt . "\n2 _O_FAM " . $famid . "\n";
1509
                }
1510
            }
1511
        }
1512
        // Find the dates for the facts that are found
1513
        foreach ($this->repeats as $key => $fact) {
1514
            if (preg_match('/[234] DATE ([^\n]+)/', $fact, $match)) {
1515
                $date = new Date($match[1]);
1516
                $jd = $date->julianDay();
1517
                $jdarr[$key] = $jd;
1518
            }
1519
        }
1520
1521
        // Sort facts in chronological order, if possible
1522
        $m = count($this->repeats) - 1;
1523
        $prevd = 0;
1524
        for ($i = 0; $i <= $m; $i++) { // keep undated events after previous dated event
1525
            if ($jdarr[$i] === 0) {
1526
                $jdarr[$i] = $prevd;
1527
            } else {
1528
                $prevd = $jdarr[$i];
1529
            }
1530
        }
1531
1532
        while ($m > 1) {
1533
            $n = count($this->repeats);
1534
            while ($n > 1) {
1535
                if ($jdarr[$n - 2] > $jdarr[$n - 1] && $jdarr[$n - 1] !== 0) {
1536
                    $s = $this->repeats[$n - 1];
1537
                    $this->repeats[$n - 1] = $this->repeats[$n - 2];
1538
                    $this->repeats[$n - 2] = $s;
1539
                    $s = $jdarr[$n - 1];
1540
                    $jdarr[$n - 1] = $jdarr[$n - 2];
1541
                    $jdarr[$n - 2] = $s;
1542
                }
1543
                $n -= 1;
1544
            }
1545
            $m -= 1;
1546
        }
1547
1548
        // Remove spouse deaths that are too late: after new marriage or own death
1549
        $currfam = "";
1550
        for ($i = 0; $i <= count($this->repeats) - 1; $i++) {
1551
            if (preg_match('/[1234] FAMS @(.+)@/', $this->repeats[$i], $match)) {
1552
                $currfam = $match[1];
1553
            }
1554
            if (preg_match('/_SP_DEAT.*\n2 DATE (.*)\n.*_O_FAM (.+)\n/', $this->repeats[$i], $match)) {
1555
                if ($currfam != $match[2] || $i == count($this->repeats) - 1) {
1556
                    $this->repeats[$i] = "1 _XXX\n";
1557
                } // ignore fact
1558
            }
1559
        }
1560
    }
1561
1562
    /**
1563
     * Handle </facts>
1564
     *
1565
     * @return void
1566
     */
1567
    protected function factsEndHandler(): void
1568
    {
1569
        $this->process_repeats--;
1570
        if ($this->process_repeats > 0) {
1571
            return;
1572
        }
1573
1574
        // Check if there is anything to repeat
1575
        if (count($this->repeats) > 0) {
1576
            $line       = xml_get_current_line_number($this->parser) - 1;
1577
            $lineoffset = 0;
1578
            foreach ($this->repeats_stack as $rep) {
1579
                $lineoffset = $lineoffset + (int) ($rep[1]) - 1;
1580
            }
1581
1582
            //-- read the xml from the file
1583
            $lines = file($this->report);
1584
            if (empty($lines)) {
1585
                error_log(__FILE__ . ":" . __LINE__ . " impossible error!? \n");
1586
                // this can not happen! phpstan forces me to add stupid code
1587
                // we come here because the xml file exists! Is it possible to tell phpstan the $lines *is* an array ??
1588
                die("can not happen!!!");
0 ignored issues
show
Best Practice introduced by
Using exit here is not recommended.

In general, usage of exit should be done with care and only when running in a scripting context like a CLI script.

Loading history...
1589
            }
1590
            while ($lineoffset + $this->repeat_bytes > 0 && !str_contains($lines[$lineoffset + $this->repeat_bytes], '<Facts ')) {
1591
                $lineoffset--;
1592
            }
1593
            $lineoffset++;
1594
            $reportxml = "<tempdoc>\n";
1595
            $i         = $line + $lineoffset;
1596
            $line_nr   = $this->repeat_bytes + $lineoffset;
1597
            while ($line_nr < $i) {
1598
                $reportxml .= $lines[$line_nr];
1599
                $line_nr++;
1600
            }
1601
            // No need to drag this
1602
            unset($lines);
1603
            $reportxml .= "</tempdoc>\n";
1604
            // Save original values
1605
            $this->parser_stack[] = $this->parser;
1606
            $oldgedrec = $this->gedrec;
1607
            $count = count($this->repeats);
1608
            $i = 0;
1609
            while ($i < $count) {
1610
                if (!isset($this->repeats[$i])) {
1611
                    $i++;
1612
                    continue; // this fact has been removed above, occured too late
1613
                }
1614
                $this->gedrec = $this->repeats[$i];
1615
                $this->fact = '';
1616
                $this->desc = '';
1617
                if (preg_match('/1 (\w+)(.*)/', $this->gedrec, $match)) {
1618
                    $this->fact = $match[1];
1619
                    if ($this->fact === 'EVEN' || $this->fact === 'FACT') {
1620
                        $tmatch = [];
1621
                        if (preg_match('/2 TYPE (.+)/', $this->gedrec, $tmatch)) {
1622
                            $this->type = trim($tmatch[1]);
1623
                        } else {
1624
                            $this->type = ' ';
1625
                        }
1626
                    }
1627
                    $this->desc = trim($match[2]);
1628
                    $this->desc .= self::getCont(2, $this->gedrec);
1629
                }
1630
                $repeat_parser = xml_parser_create();
1631
                $this->parser  = $repeat_parser;
1632
                xml_parser_set_option($repeat_parser, XML_OPTION_CASE_FOLDING, 0);
1633
1634
                xml_set_element_handler(
1635
                    $repeat_parser,
1636
                    function ($parser, string $name, array $attrs): void {
1637
                        $this->startElement($parser, $name, $attrs);
1638
                    },
1639
                    function ($parser, string $name): void {
1640
                        $this->endElement($parser, $name);
1641
                    }
1642
                );
1643
1644
                xml_set_character_data_handler(
1645
                    $repeat_parser,
1646
                    function ($parser, string $data): void {
1647
                        $this->characterData($parser, $data);
1648
                    }
1649
                );
1650
1651
                if (!xml_parse($repeat_parser, $reportxml, true)) {
1652
                    throw new DomainException(sprintf(
1653
                        'FactsEHandler XML error: %s at line %d',
1654
                        xml_error_string(xml_get_error_code($repeat_parser)),
1655
                        xml_get_current_line_number($repeat_parser)
1656
                    ));
1657
                }
1658
                xml_parser_free($repeat_parser);
1659
                $i++;
1660
            }
1661
            // Restore original values
1662
            $this->parser = array_pop($this->parser_stack);
1663
            $this->gedrec = $oldgedrec;
1664
        }
1665
        [$this->repeats, $this->repeat_bytes] = array_pop($this->repeats_stack);
1666
    }
1667
1668
    /**
1669
     * Setting upp or changing variables in the XML
1670
     * The XML variable name and value is stored in $this->vars
1671
     *
1672
     * @param array<string> $attrs an array of key value pairs for the attributes
1673
     *
1674
     * @return void
1675
     */
1676
    protected function setVarStartHandler(array $attrs): void
1677
    {
1678
        if (empty($attrs['name'])) {
1679
            throw new DomainException('REPORT ERROR var: The attribute "name" is missing or not set in the XML file');
1680
        }
1681
1682
        $name  = $attrs['name'];
1683
        $value = $attrs['value'];
1684
        if (isset($attrs['dumpvar'])) {
1685
            $dumpvar = $attrs['dumpvar'];
1686
        } else {
1687
            $dumpvar = "";
1688
        }
1689
        $curr_id = "";
1690
        $match = [];
1691
        if (preg_match('/0 @(.+)@/', $this->gedrec, $match)) {
1692
            $curr_id = $match[1];
1693
        }
1694
        $match = [];
1695
        // Current GEDCOM record strings
1696
        if ($value === '@ID') {
1697
            if (preg_match('/0 @(.+)@/', $this->gedrec, $match)) {
1698
                $value = $match[1];
1699
            }
1700
        } elseif ($value === '@fact') {
1701
            $value = $this->fact;
1702
        } elseif ($value === '@lang') {
1703
            $value = I18N::languageTag();
1704
        } elseif ($value === '@desc') {
1705
            $value = $this->desc;
1706
        } elseif ($value === '@format') {
1707
            if (isset($_GET["format"])) {
1708
                $value = $_GET["format"];
1709
            } else {
1710
                $value = "";
1711
            }
1712
        } elseif ($value === '@generation') {
1713
            $value = (string) $this->generation;
1714
        } elseif ($value === '@base_url') {
1715
            $value = "";
1716
            if (array_key_exists("REQUEST_URI", $_SERVER)) {
1717
                $value = urldecode($_SERVER["REQUEST_URI"]);
1718
            }
1719
            $url1 = "";
1720
            $i = strpos($value, "route=");
1721
            if ($i !== false) {
1722
                $url1 = substr($value, 0, $i + 6);
1723
                $value = substr($value, $i + 6);
1724
            }
1725
            $i = strpos($value, "/report");
1726
            if ($i !== false) {
1727
                $value = substr($value, 0, $i);
1728
            }
1729
            $value = $url1 . $value;
1730
        } elseif ($value === '@relation') {
1731
            if (isset($this->mfrelation[$curr_id]) && $curr_id != "") {
1732
                $value = (string) $this->mfrelation[$curr_id];
1733
            } else {
1734
                $value = "";
1735
            }
1736
        } elseif (preg_match("/@(\w+)/", $value, $match)) {
1737
            $gmatch = [];
1738
            if (preg_match("/\d $match[1] (.+)/", $this->gedrec, $gmatch)) {
1739
                $value = str_replace('@', '', trim($gmatch[1]));
1740
            }
1741
        } elseif (preg_match("/@\\$(\w+)/", $value, $match)) {
1742
            if ($match[1] == "dump" && $this->vars['dval']['id'] > 0) {
1743
                // if ($this->vars[ 'dval' ]['id'] == 1001)
1744
                if ($dumpvar == "gedrec") {
1745
                    error_log("\n---- setvar start  " . date("Y-m-d H:i:s") . " RPG " . __LINE__ . "  " . $name . "  gedcom=\n" . $this->gedrec . "\n", 3, "my-errors.log");
1746
                } elseif ($dumpvar != "") {
1747
                    error_log("var: " . $dumpvar . " = " . $this->vars[$dumpvar]['id'] . "\n", 3, "my-errors.log");
1748
                } else {
1749
                    if (array_key_exists('dval', $this->vars)) {
1750
                        $nnn = $this->vars['dval']['id'];
1751
                    } else {
1752
                        $nnn = 0;
1753
                    }
1754
                    error_log("\n---- setvar start  " . date("Y-m-d H:i:s") . " RPG " . __LINE__ . "  " . $name . "  -----\n", 3, "my-errors.log");
1755
                    foreach ($this->vars as $key => $val) {
1756
                        if ($nnn-- < 0) {
1757
                            error_log($key . "='" . $val['id'] . "'\n", 3, "my-errors.log");
1758
                        }
1759
                    }
1760
                }
1761
            }
1762
            $value = $this->vars[$match[1]]['id'];
1763
            if (isset($this->vars[$value]['id'])) {
1764
                $value = '$' . $this->vars[$match[1]]['id'];
1765
            } else {
1766
                $value = "0";
1767
            }
1768
        }
1769
        if (isset($attrs['trim'])) {
1770
            $value = str_replace($attrs['trim'], '', $value);
1771
        }
1772
        if (preg_match("/\\$(\w+)/", $name, $match)) {
1773
            $name = $this->vars["'" . $match[1] . "'"]['id'];
1774
        }
1775
        $count = preg_match_all("/\\$(\w+)/", $value, $match, PREG_SET_ORDER);
1776
        $i     = 0;
1777
        while ($i < $count) {
1778
            $t     = $this->vars[$match[$i][1]]['id'];
1779
            $value = preg_replace('/\$' . $match[$i][1] . '/', $t, $value, 1);
1780
            $i++;
1781
        }
1782
        if (preg_match('/^I18N::number\((.+)\)$/', $value, $match)) {
1783
            $value = I18N::number((int) $match[1]);
1784
        } elseif (preg_match('/^I18N::translate\(\'(.+)\'\)$/', $value, $match)) {
1785
            $value = I18N::translate($match[1]);
1786
        } elseif (preg_match('/^I18N::translateContext\(\'(.+)\', *\'(.+)\'\)$/', $value, $match)) {
1787
            $value = I18N::translateContext($match[1], $match[2]);
1788
        }
1789
        if (isset($attrs['lcfirst'])) { // set 1st char to lower case
1790
            if ($attrs['lcfirst'] == '1') {
1791
                $value = lcfirst($value);
1792
            }
1793
        }
1794
1795
        // Arithmetic functions
1796
        if (preg_match("/(\d+)\s*([-+*\/])\s*(\d+)/", $value, $match)) {
1797
            // Create an expression language with the functions used by our reports.
1798
            $expression_provider  = new ReportExpressionLanguageProvider();
1799
            $expression_cache     = new NullAdapter();
1800
            $expression_language  = new ExpressionLanguage($expression_cache, [$expression_provider]);
1801
1802
            $value = (string) $expression_language->evaluate($value);
1803
        }
1804
1805
        if (str_contains($value, '@')) {
1806
            $value = '';
1807
        }
1808
        $this->vars[$name]['id'] = $value;
1809
        if ($name == 'title') {
1810
            $this->wt_report->title = $value;
1811
        }
1812
    }
1813
1814
    /**
1815
     * Handle <if>
1816
     *
1817
     * @param array<string> $attrs
1818
     *
1819
     * @return void
1820
     */
1821
    protected function ifStartHandler(array $attrs): void
1822
    {
1823
        if ($this->process_ifs > 0) {
1824
            $this->process_ifs++;
1825
1826
            return;
1827
        }
1828
1829
        $condition = $attrs['condition'];
1830
        $condition = $this->substituteVars($condition, true);
1831
        $condition = str_replace([
1832
            ' LT ',
1833
            ' GT ',
1834
        ], [
1835
            '<',
1836
            '>',
1837
        ], $condition);
1838
        // Replace the first occurrence only once of @fact:DATE or in any other combinations to the current fact, such as BIRT
1839
        $condition = str_replace('@fact:', $this->fact . ':', $condition);
1840
        $match     = [];
1841
        $count     = preg_match_all("/@([\w:.]+)/", $condition, $match, PREG_SET_ORDER);
1842
        $i         = 0;
1843
        while ($i < $count) {
1844
            $id    = $match[$i][1];
1845
            $value = '""';
1846
            if ($id === 'ID') {
1847
                if (preg_match('/0 @(.+)@/', $this->gedrec, $match)) {
1848
                    $value = "'" . $match[1] . "'";
1849
                }
1850
            } elseif ($id === 'fact') {
1851
                $value = '"' . $this->fact . '"';
1852
            } elseif ($id === 'desc') {
1853
                $value = '"' . addslashes($this->desc) . '"';
1854
            } elseif ($id === 'generation') {
1855
                $value = '"' . $this->generation . '"';
1856
            } else {
1857
                $level = (int) explode(' ', trim($this->gedrec))[0];
1858
                if ($level === 0) {
1859
                    $level++;
1860
                }
1861
                $value = $this->getGedcomValue($id, $level, $this->gedrec);
1862
                if (empty($value)) {
1863
                    $level++;
1864
                    $value = $this->getGedcomValue($id, $level, $this->gedrec);
1865
                }
1866
                $value = preg_replace('/^@(' . Gedcom::REGEX_XREF . ')@$/', '$1', $value);
1867
                $value = '"' . addslashes($value) . '"';
1868
            }
1869
            $condition = str_replace("@$id", $value, $condition);
1870
            $i++;
1871
        }
1872
1873
        // Create an expression language with the functions used by our reports.
1874
        $expression_provider  = new ReportExpressionLanguageProvider();
1875
        $expression_cache     = new NullAdapter();
1876
        $expression_language  = new ExpressionLanguage($expression_cache, [$expression_provider]);
1877
1878
        $ret = $expression_language->evaluate($condition);
1879
1880
        if (!$ret) {
1881
            $this->process_ifs++;
1882
        }
1883
    }
1884
1885
    /**
1886
     * Handle </if>
1887
     *
1888
     * @return void
1889
     */
1890
    protected function ifEndHandler(): void
1891
    {
1892
        if ($this->process_ifs > 0) {
1893
            $this->process_ifs--;
1894
        }
1895
    }
1896
1897
    /**
1898
     * Handle <footnote>
1899
     * Collect the Footnote links
1900
     * GEDCOM Records that are protected by Privacy setting will be ignored
1901
     *
1902
     * @param array<string> $attrs
1903
     *
1904
     * @return void
1905
     */
1906
    protected function footnoteStartHandler(array $attrs): void
1907
    {
1908
        $id = '';
1909
        if (preg_match('/[0-9] (.+) @(.+)@/', $this->gedrec, $match)) {
1910
            $id = $match[2];
1911
        }
1912
        $record = Registry::gedcomRecordFactory()->make($id, $this->tree);
1913
        if ($record && $record->canShow()) {
1914
            $this->print_data_stack[] = $this->print_data;
1915
            $this->print_data         = true;
1916
            $style                    = '';
1917
            if (!empty($attrs['style'])) {
1918
                $style = $attrs['style'];
1919
            }
1920
            $this->footnote_element = $this->current_element;
1921
            $this->current_element  = $this->report_root->createFootnote($style);
1922
        } else {
1923
            $this->print_data       = false;
1924
            $this->process_footnote = false;
1925
        }
1926
    }
1927
1928
    /**
1929
     * Handle </footnote>
1930
     * Print the collected Footnote data
1931
     *
1932
     * @return void
1933
     */
1934
    protected function footnoteEndHandler(): void
1935
    {
1936
        if ($this->process_footnote) {
1937
            $this->print_data = array_pop($this->print_data_stack);
1938
            $temp             = trim($this->current_element->getValue());
1939
            if (strlen($temp) > 3) {
1940
                $this->wt_report->addElement($this->current_element);
1941
            }
1942
            $this->current_element = $this->footnote_element;
1943
        } else {
1944
            $this->process_footnote = true;
1945
        }
1946
    }
1947
1948
    /**
1949
     * Handle <footnoteTexts />
1950
     *
1951
     * @return void
1952
     */
1953
    protected function footnoteTextsStartHandler(): void
1954
    {
1955
        $temp = 'footnotetexts';
1956
        $this->wt_report->addElement($temp);
1957
    }
1958
1959
    /**
1960
     * XML element Forced line break handler - HTML code
1961
     *
1962
     * @return void
1963
     */
1964
    protected function brStartHandler(): void
1965
    {
1966
        if ($this->print_data && $this->process_gedcoms === 0) {
1967
            $this->current_element->addText('<br>');
1968
        }
1969
    }
1970
1971
    /**
1972
     * Handle <sp />
1973
     * Forced space
1974
     *
1975
     * @return void
1976
     */
1977
    protected function spStartHandler(): void
1978
    {
1979
        if ($this->print_data && $this->process_gedcoms === 0) {
1980
            $this->current_element->addText(' ');
1981
        }
1982
    }
1983
1984
    /**
1985
     * Handle <highlightedImage />
1986
     *
1987
     * @param array<string> $attrs
1988
     *
1989
     * @return void
1990
     */
1991
    protected function highlightedImageStartHandler(array $attrs): void
1992
    {
1993
        $id = '';
1994
        if (preg_match('/0 @(.+)@/', $this->gedrec, $match)) {
1995
            $id = $match[1];
1996
        }
1997
1998
        // Position the top corner of this box on the page
1999
        $top = (float) ($attrs['top'] ?? ReportBaseElement::CURRENT_POSITION);
2000
2001
        // Position the left corner of this box on the page
2002
        $left = (float) ($attrs['left'] ?? ReportBaseElement::CURRENT_POSITION);
2003
2004
        // string Align the image in left, center, right (or empty to use x/y position).
2005
        $align = $attrs['align'] ?? '';
2006
2007
        // string Next Line should be T:next to the image, N:next line
2008
        $ln = $attrs['ln'] ?? 'T';
2009
2010
        // Width, height (or both).
2011
        $width  = (float) ($attrs['width'] ?? 0.0);
2012
        $height = (float) ($attrs['height'] ?? 0.0);
2013
2014
        $person     = Registry::individualFactory()->make($id, $this->tree);
2015
        $media_file = $person->findHighlightedMediaFile();
2016
2017
        if ($media_file instanceof MediaFile && $media_file->fileExists()) {
2018
            $image      = imagecreatefromstring($media_file->fileContents());
2019
            $attributes = [imagesx($image), imagesy($image)];
2020
2021
            if ($width > 0 && $height == 0) {
2022
                $perc   = $width / $attributes[0];
2023
                $height = round($attributes[1] * $perc);
2024
            } elseif ($height > 0 && $width == 0) {
2025
                $perc  = $height / $attributes[1];
2026
                $width = round($attributes[0] * $perc);
2027
            } else {
2028
                $width  = (float) $attributes[0];
2029
                $height = (float) $attributes[1];
2030
            }
2031
            $image = $this->report_root->createImageFromObject($media_file, $left, $top, $width, $height, $align, $ln);
2032
            $this->wt_report->addElement($image);
2033
        }
2034
    }
2035
2036
    /**
2037
     * Handle <image/>
2038
     *
2039
     * @param array<string> $attrs
2040
     *
2041
     * @return void
2042
     */
2043
    protected function imageStartHandler(array $attrs): void
2044
    {
2045
        // Position the top corner of this box on the page. the default is the current position
2046
        $top = (float) ($attrs['top'] ?? ReportBaseElement::CURRENT_POSITION);
2047
2048
        // mixed Position the left corner of this box on the page. the default is the current position
2049
        $left = (float) ($attrs['left'] ?? ReportBaseElement::CURRENT_POSITION);
2050
2051
        // string Align the image in left, center, right (or empty to use x/y position).
2052
        $align = $attrs['align'] ?? '';
2053
2054
        // string Next Line should be T:next to the image, N:next line
2055
        $ln = $attrs['ln'] ?? 'T';
2056
2057
        // Width, height (or both).
2058
        $width  = (float) ($attrs['width'] ?? 0.0);
2059
        $height = (float) ($attrs['height'] ?? 0.0);
2060
2061
        $file = $attrs['file'] ?? '';
2062
2063
        if ($file === '@FILE') {
2064
            $match = [];
2065
            if (preg_match("/1 OBJE @(.+)@/", $this->gedrec, $match)) {
2066
                $mediaobject = Registry::mediaFactory()->make($match[1], $this->tree);
2067
                $media_file  = $mediaobject->firstImageFile();
2068
2069
                if ($media_file instanceof MediaFile && $media_file->fileExists()) {
2070
                    $image      = imagecreatefromstring($media_file->fileContents());
2071
                    $attributes = [imagesx($image), imagesy($image)];
2072
2073
                    if ($width > 0 && $height == 0) {
2074
                        $perc   = $width / $attributes[0];
2075
                        $height = round($attributes[1] * $perc);
2076
                    } elseif ($height > 0 && $width == 0) {
2077
                        $perc  = $height / $attributes[1];
2078
                        $width = round($attributes[0] * $perc);
2079
                    } else {
2080
                        $width  = (float) $attributes[0];
2081
                        $height = (float) $attributes[1];
2082
                    }
2083
                    $image = $this->report_root->createImageFromObject($media_file, $left, $top, $width, $height, $align, $ln);
2084
                    $this->wt_report->addElement($image);
2085
                }
2086
            }
2087
        } else {
2088
            if (file_exists($file) && preg_match('/(jpg|jpeg|png|gif)$/i', $file)) {
2089
                $size = getimagesize($file);
2090
                if ($width > 0 && $height == 0) {
2091
                    $perc   = $width / $size[0];
2092
                    $height = round($size[1] * $perc);
2093
                } elseif ($height > 0 && $width == 0) {
2094
                    $perc  = $height / $size[1];
2095
                    $width = round($size[0] * $perc);
2096
                } else {
2097
                    $width  = $size[0];
2098
                    $height = $size[1];
2099
                }
2100
                $image = $this->report_root->createImage($file, $left, $top, $width, $height, $align, $ln);
2101
                $this->wt_report->addElement($image);
2102
            }
2103
        }
2104
    }
2105
2106
    /**
2107
     * Handle <line>
2108
     *
2109
     * @param array<string> $attrs
2110
     *
2111
     * @return void
2112
     */
2113
    protected function lineStartHandler(array $attrs): void
2114
    {
2115
        // Start horizontal position, current position (default)
2116
        $x1 = ReportBaseElement::CURRENT_POSITION;
2117
        if (isset($attrs['x1'])) {
2118
            if ($attrs['x1'] === '0') {
2119
                $x1 = 0;
2120
            } elseif ($attrs['x1'] === '.') {
2121
                $x1 = ReportBaseElement::CURRENT_POSITION;
2122
            } elseif (!empty($attrs['x1'])) {
2123
                $x1 = (float) $attrs['x1'];
2124
            }
2125
        }
2126
        // Start vertical position, current position (default)
2127
        $y1 = ReportBaseElement::CURRENT_POSITION;
2128
        if (isset($attrs['y1'])) {
2129
            if ($attrs['y1'] === '0') {
2130
                $y1 = 0;
2131
            } elseif ($attrs['y1'] === '.') {
2132
                $y1 = ReportBaseElement::CURRENT_POSITION;
2133
            } elseif (!empty($attrs['y1'])) {
2134
                $y1 = (float) $attrs['y1'];
2135
            }
2136
        }
2137
        // End horizontal position, maximum width (default)
2138
        $x2 = ReportBaseElement::CURRENT_POSITION;
2139
        if (isset($attrs['x2'])) {
2140
            if ($attrs['x2'] === '0') {
2141
                $x2 = 0;
2142
            } elseif ($attrs['x2'] === '.') {
2143
                $x2 = ReportBaseElement::CURRENT_POSITION;
2144
            } elseif (!empty($attrs['x2'])) {
2145
                $x2 = (float) $attrs['x2'];
2146
            }
2147
        }
2148
        // End vertical position
2149
        $y2 = ReportBaseElement::CURRENT_POSITION;
2150
        if (isset($attrs['y2'])) {
2151
            if ($attrs['y2'] === '0') {
2152
                $y2 = 0;
2153
            } elseif ($attrs['y2'] === '.') {
2154
                $y2 = ReportBaseElement::CURRENT_POSITION;
2155
            } elseif (!empty($attrs['y2'])) {
2156
                $y2 = (float) $attrs['y2'];
2157
            }
2158
        }
2159
2160
        $line = $this->report_root->createLine($x1, $y1, $x2, $y2);
2161
        $this->wt_report->addElement($line);
2162
    }
2163
2164
    /**
2165
     * Handle <list>
2166
     *
2167
     * @param array<string> $attrs
2168
     *
2169
     * @return void
2170
     */
2171
    protected function listStartHandler(array $attrs): void
2172
    {
2173
        $this->process_repeats++;
2174
        if ($this->process_repeats > 1) {
2175
            return;
2176
        }
2177
2178
        $match = [];
2179
        if (isset($attrs['sortby'])) {
2180
            $sortby = $attrs['sortby'];
2181
            if (preg_match("/\\$(\w+)/", $sortby, $match)) {
2182
                $sortby = $this->vars[$match[1]]['id'];
2183
                $sortby = trim($sortby);
2184
            }
2185
        } else {
2186
            $sortby = 'NAME';
2187
        }
2188
2189
        $listname = $attrs['list'] ?? 'individual';
2190
2191
        // Some filters/sorts can be applied using SQL, while others require PHP
2192
        switch ($listname) {
2193
            case 'pending':
2194
                $this->list = DB::table('change')
2195
                    ->whereIn('change_id', function (Builder $query): void {
2196
                        $query->select([new Expression('MAX(change_id)')])
2197
                            ->from('change')
2198
                            ->where('gedcom_id', '=', $this->tree->id())
2199
                            ->where('status', '=', 'pending')
2200
                            ->groupBy(['xref']);
2201
                    })
2202
                    ->get()
2203
                    ->map(fn (object $row): ?GedcomRecord => Registry::gedcomRecordFactory()->make($row->xref, $this->tree, $row->new_gedcom ?: $row->old_gedcom))
2204
                    ->filter()
2205
                    ->all();
2206
                break;
2207
2208
            case 'individual':
2209
                $query = DB::table('individuals')
2210
                    ->where('i_file', '=', $this->tree->id())
2211
                    ->select(['i_id AS xref', 'i_gedcom AS gedcom'])
2212
                    ->distinct();
2213
2214
                foreach ($attrs as $attr => $value) {
2215
                    if (str_starts_with($attr, 'filter') && $value !== '') {
2216
                        $value = $this->substituteVars($value, false);
2217
                        // Convert the various filters into SQL
2218
                        if (preg_match('/^(\w+):DATE (LTE|GTE) (.+)$/', $value, $match)) {
2219
                            $query->join('dates AS ' . $attr, static function (JoinClause $join) use ($attr): void {
2220
                                $join
2221
                                    ->on($attr . '.d_gid', '=', 'i_id')
2222
                                    ->on($attr . '.d_file', '=', 'i_file');
2223
                            });
2224
2225
                            $query->where($attr . '.d_fact', '=', $match[1]);
2226
2227
                            $date = new Date($match[3]);
2228
2229
                            if ($match[2] === 'LTE') {
2230
                                $query->where($attr . '.d_julianday2', '<=', $date->maximumJulianDay());
2231
                            } else {
2232
                                $query->where($attr . '.d_julianday1', '>=', $date->minimumJulianDay());
2233
                            }
2234
2235
                            // This filter has been fully processed
2236
                            unset($attrs[$attr]);
2237
                        } elseif (preg_match('/^NAME CONTAINS (.+)$/', $value, $match)) {
2238
                            $query->join('name AS ' . $attr, static function (JoinClause $join) use ($attr): void {
2239
                                $join
2240
                                    ->on($attr . '.n_id', '=', 'i_id')
2241
                                    ->on($attr . '.n_file', '=', 'i_file');
2242
                            });
2243
                            // Search the DB only if there is any name supplied
2244
                            $names = explode(' ', $match[1]);
2245
                            foreach ($names as $name) {
2246
                                $query->where($attr . '.n_full', 'LIKE', '%' . addcslashes($name, '\\%_') . '%');
2247
                            }
2248
2249
                            // This filter has been fully processed
2250
                            unset($attrs[$attr]);
2251
                        } elseif (preg_match('/^LIKE \/(.+)\/$/', $value, $match)) {
2252
                            // Convert newline escape sequences to actual new lines
2253
                            $match[1] = str_replace('\n', "\n", $match[1]);
2254
2255
                            $query->where('i_gedcom', 'LIKE', $match[1]);
2256
2257
                            // This filter has been fully processed
2258
                            unset($attrs[$attr]);
2259
                        } elseif (preg_match('/^(?:\w*):PLAC CONTAINS (.+)$/', $value, $match)) {
2260
                            // Don't unset this filter. This is just initial filtering for performance
2261
                            $query
2262
                                ->join('placelinks AS ' . $attr . 'a', static function (JoinClause $join) use ($attr): void {
2263
                                    $join
2264
                                        ->on($attr . 'a.pl_file', '=', 'i_file')
2265
                                        ->on($attr . 'a.pl_gid', '=', 'i_id');
2266
                                })
2267
                                ->join('places AS ' . $attr . 'b', static function (JoinClause $join) use ($attr): void {
2268
                                    $join
2269
                                        ->on($attr . 'b.p_file', '=', $attr . 'a.pl_file')
2270
                                        ->on($attr . 'b.p_id', '=', $attr . 'a.pl_p_id');
2271
                                })
2272
                                ->where($attr . 'b.p_place', 'LIKE', '%' . addcslashes($match[1], '\\%_') . '%');
2273
                        } elseif (preg_match('/^(\w*):(\w+) CONTAINS (.+)$/', $value, $match)) {
2274
                            // Don't unset this filter. This is just initial filtering for performance
2275
                            $match[3] = strtr($match[3], ['\\' => '\\\\', '%'  => '\\%', '_'  => '\\_', ' ' => '%']);
2276
                            $like = "%\n1 " . $match[1] . "%\n2 " . $match[2] . '%' . $match[3] . '%';
2277
                            $query->where('i_gedcom', 'LIKE', $like);
2278
                        } elseif (preg_match('/^(\w+) CONTAINS (.*)$/', $value, $match)) {
2279
                            // Don't unset this filter. This is just initial filtering for performance
2280
                            $match[2] = strtr($match[2], ['\\' => '\\\\', '%'  => '\\%', '_'  => '\\_', ' ' => '%']);
2281
                            $like = "%\n1 " . $match[1] . '%' . $match[2] . '%';
2282
                            $query->where('i_gedcom', 'LIKE', $like);
2283
                        }
2284
                    }
2285
                }
2286
2287
                $this->list = [];
2288
2289
                foreach ($query->get() as $row) {
2290
                    $this->list[$row->xref] = Registry::individualFactory()->make($row->xref, $this->tree, $row->gedcom);
2291
                }
2292
                break;
2293
2294
            case 'family':
2295
                $query = DB::table('families')
2296
                    ->where('f_file', '=', $this->tree->id())
2297
                    ->select(['f_id AS xref', 'f_gedcom AS gedcom'])
2298
                    ->distinct();
2299
2300
                foreach ($attrs as $attr => $value) {
2301
                    if (str_starts_with($attr, 'filter') && $value !== '') {
2302
                        $value = $this->substituteVars($value, false);
2303
                        // Convert the various filters into SQL
2304
                        if (preg_match('/^(\w+):DATE (LTE|GTE) (.+)$/', $value, $match)) {
2305
                            $query->join('dates AS ' . $attr, static function (JoinClause $join) use ($attr): void {
2306
                                $join
2307
                                    ->on($attr . '.d_gid', '=', 'f_id')
2308
                                    ->on($attr . '.d_file', '=', 'f_file');
2309
                            });
2310
2311
                            $query->where($attr . '.d_fact', '=', $match[1]);
2312
2313
                            $date = new Date($match[3]);
2314
2315
                            if ($match[2] === 'LTE') {
2316
                                $query->where($attr . '.d_julianday2', '<=', $date->maximumJulianDay());
2317
                            } else {
2318
                                $query->where($attr . '.d_julianday1', '>=', $date->minimumJulianDay());
2319
                            }
2320
2321
                            // This filter has been fully processed
2322
                            unset($attrs[$attr]);
2323
                        } elseif (preg_match('/^LIKE \/(.+)\/$/', $value, $match)) {
2324
                            // Convert newline escape sequences to actual new lines
2325
                            $match[1] = str_replace('\n', "\n", $match[1]);
2326
2327
                            $query->where('f_gedcom', 'LIKE', $match[1]);
2328
2329
                            // This filter has been fully processed
2330
                            unset($attrs[$attr]);
2331
                        } elseif (preg_match('/^NAME CONTAINS (.*)$/', $value, $match)) {
2332
                            if ($sortby === 'NAME' || $match[1] !== '') {
2333
                                $query->join('name AS ' . $attr, static function (JoinClause $join) use ($attr): void {
2334
                                    $join
2335
                                        ->on($attr . '.n_file', '=', 'f_file')
2336
                                        ->where(static function (Builder $query): void {
2337
                                            $query
2338
                                                ->whereColumn('n_id', '=', 'f_husb')
2339
                                                ->orWhereColumn('n_id', '=', 'f_wife');
2340
                                        });
2341
                                });
2342
                                // Search the DB only if there is any name supplied
2343
                                if ($match[1] != '') {
2344
                                    $names = explode(' ', $match[1]);
2345
                                    foreach ($names as $name) {
2346
                                        $query->where($attr . '.n_full', 'LIKE', '%' . addcslashes($name, '\\%_') . '%');
2347
                                    }
2348
                                }
2349
                            }
2350
2351
                            // This filter has been fully processed
2352
                            unset($attrs[$attr]);
2353
                        } elseif (preg_match('/^(?:\w*):PLAC CONTAINS (.+)$/', $value, $match)) {
2354
                            // Don't unset this filter. This is just initial filtering for performance
2355
                            $query
2356
                                ->join('placelinks AS ' . $attr . 'a', static function (JoinClause $join) use ($attr): void {
2357
                                    $join
2358
                                        ->on($attr . 'a.pl_file', '=', 'f_file')
2359
                                        ->on($attr . 'a.pl_gid', '=', 'f_id');
2360
                                })
2361
                                ->join('places AS ' . $attr . 'b', static function (JoinClause $join) use ($attr): void {
2362
                                    $join
2363
                                        ->on($attr . 'b.p_file', '=', $attr . 'a.pl_file')
2364
                                        ->on($attr . 'b.p_id', '=', $attr . 'a.pl_p_id');
2365
                                })
2366
                                ->where($attr . 'b.p_place', 'LIKE', '%' . addcslashes($match[1], '\\%_') . '%');
2367
                        } elseif (preg_match('/^(\w*):(\w+) CONTAINS (.+)$/', $value, $match)) {
2368
                            // Don't unset this filter. This is just initial filtering for performance
2369
                            $match[3] = strtr($match[3], ['\\' => '\\\\', '%'  => '\\%', '_'  => '\\_', ' ' => '%']);
2370
                            $like = "%\n1 " . $match[1] . "%\n2 " . $match[2] . '%' . $match[3] . '%';
2371
                            $query->where('f_gedcom', 'LIKE', $like);
2372
                        } elseif (preg_match('/^(\w+) CONTAINS (.+)$/', $value, $match)) {
2373
                            // Don't unset this filter. This is just initial filtering for performance
2374
                            $match[2] = strtr($match[2], ['\\' => '\\\\', '%'  => '\\%', '_'  => '\\_', ' ' => '%']);
2375
                            $like = "%\n1 " . $match[1] . '%' . $match[2] . '%';
2376
                            $query->where('f_gedcom', 'LIKE', $like);
2377
                        }
2378
                    }
2379
                }
2380
2381
                $this->list = [];
2382
2383
                foreach ($query->get() as $row) {
2384
                    $this->list[$row->xref] = Registry::familyFactory()->make($row->xref, $this->tree, $row->gedcom);
2385
                }
2386
                break;
2387
2388
            default:
2389
                throw new DomainException('Invalid list name: ' . $listname);
2390
        }
2391
2392
        $filters  = [];
2393
        $filters2 = [];
2394
        if (isset($attrs['filter1']) && count($this->list) > 0) {
2395
            foreach ($attrs as $key => $value) {
2396
                if (preg_match("/filter(\d)/", $key)) {
2397
                    $condition = $value;
2398
                    if (preg_match("/@(\w+)/", $condition, $match)) {
2399
                        $id    = $match[1];
2400
                        $value = "''";
2401
                        if ($id === 'ID') {
2402
                            if (preg_match('/0 @(.+)@/', $this->gedrec, $match)) {
2403
                                $value = "'" . $match[1] . "'";
2404
                            }
2405
                        } elseif ($id === 'fact') {
2406
                            $value = "'" . $this->fact . "'";
2407
                        } elseif ($id === 'desc') {
2408
                            $value = "'" . $this->desc . "'";
2409
                        } else {
2410
                            if (preg_match("/\d $id (.+)/", $this->gedrec, $match)) {
2411
                                $value = "'" . str_replace('@', '', trim($match[1])) . "'";
2412
                            }
2413
                        }
2414
                        $condition = preg_replace("/@$id/", $value, $condition);
2415
                    }
2416
                    //-- handle regular expressions
2417
                    if (preg_match("/([A-Z:]+)\s*([^\s]+)\s*(.+)/", $condition, $match)) {
2418
                        $tag  = trim($match[1]);
2419
                        $expr = trim($match[2]);
2420
                        $val  = trim($match[3]);
2421
                        if (preg_match("/\\$(\w+)/", $val, $match)) {
2422
                            $val = $this->vars[$match[1]]['id'];
2423
                            $val = trim($val);
2424
                        }
2425
                        if ($val !== '') {
2426
                            $searchstr = '';
2427
                            $tags      = explode(':', $tag);
2428
                            //-- only limit to a level number if we are specifically looking at a level
2429
                            if (count($tags) > 1) {
2430
                                $level = 1;
2431
                                $t = 'XXXX';
2432
                                foreach ($tags as $t) {
2433
                                    if (!empty($searchstr)) {
2434
                                        $searchstr .= "[^\n]*(\n[2-9][^\n]*)*\n";
2435
                                    }
2436
                                    //-- search for both EMAIL and _EMAIL... silly double gedcom standard
2437
                                    if ($t === 'EMAIL' || $t === '_EMAIL') {
2438
                                        $t = '_?EMAIL';
2439
                                    }
2440
                                    $searchstr .= $level . ' ' . $t;
2441
                                    $level++;
2442
                                }
2443
                            } else {
2444
                                if ($tag === 'EMAIL' || $tag === '_EMAIL') {
2445
                                    $tag = '_?EMAIL';
2446
                                }
2447
                                $t         = $tag;
2448
                                $searchstr = '1 ' . $tag;
2449
                            }
2450
                            switch ($expr) {
2451
                                case 'CONTAINS':
2452
                                    if ($t === 'PLAC') {
2453
                                        $searchstr .= "[^\n]*[, ]*" . $val;
2454
                                    } else {
2455
                                        $searchstr .= "[^\n]*" . $val;
2456
                                    }
2457
                                    $filters[] = $searchstr;
2458
                                    break;
2459
                                default:
2460
                                    $filters2[] = [
2461
                                        'tag'  => $tag,
2462
                                        'expr' => $expr,
2463
                                        'val'  => $val,
2464
                                    ];
2465
                                    break;
2466
                            }
2467
                        }
2468
                    }
2469
                }
2470
            }
2471
        }
2472
        //-- apply other filters to the list that could not be added to the search string
2473
        if ($filters !== []) {
2474
            foreach ($this->list as $key => $record) {
2475
                foreach ($filters as $filter) {
2476
                    if (!preg_match('/' . $filter . '/i', $record->privatizeGedcom(Auth::accessLevel($this->tree)))) {
2477
                        unset($this->list[$key]);
2478
                        break;
2479
                    }
2480
                }
2481
            }
2482
        }
2483
        if ($filters2 !== []) {
2484
            $mylist = [];
2485
            foreach ($this->list as $indi) {
2486
                $key  = $indi->xref();
2487
                $grec = $indi->privatizeGedcom(Auth::accessLevel($this->tree));
2488
                $keep = true;
2489
                foreach ($filters2 as $filter) {
2490
                    if ($keep) {
2491
                        $tag  = $filter['tag'];
2492
                        $expr = $filter['expr'];
2493
                        $val  = $filter['val'];
2494
                        if ($val === "''") {
2495
                            $val = '';
2496
                        }
2497
                        $tags = explode(':', $tag);
2498
                        $t    = end($tags);
2499
                        $v    = $this->getGedcomValue($tag, 1, $grec);
2500
                        //-- check for EMAIL and _EMAIL (silly double gedcom standard :P)
2501
                        if ($t === 'EMAIL' && empty($v)) {
2502
                            $tag  = str_replace('EMAIL', '_EMAIL', $tag);
2503
                            $tags = explode(':', $tag);
2504
                            $t    = end($tags);
2505
                            $v    = self::getSubRecord(1, $tag, $grec);
2506
                        }
2507
2508
                        switch ($expr) {
2509
                            case 'GTE':
2510
                                if ($t === 'DATE') {
2511
                                    $date1 = new Date($v);
2512
                                    $date2 = new Date($val);
2513
                                    $keep  = (Date::compare($date1, $date2) >= 0);
2514
                                } elseif ($val >= $v) {
2515
                                    $keep = true;
2516
                                }
2517
                                break;
2518
                            case 'LTE':
2519
                                if ($t === 'DATE') {
2520
                                    $date1 = new Date($v);
2521
                                    $date2 = new Date($val);
2522
                                    $keep  = (Date::compare($date1, $date2) <= 0);
2523
                                } elseif ($val >= $v) {
2524
                                    $keep = true;
2525
                                }
2526
                                break;
2527
                            default:
2528
                                if ($v == $val) {
2529
                                    $keep = true;
2530
                                } else {
2531
                                    $keep = false;
2532
                                }
2533
                                break;
2534
                        }
2535
                    }
2536
                }
2537
                if ($keep) {
2538
                    $mylist[$key] = $indi;
2539
                }
2540
            }
2541
            $this->list = $mylist;
2542
        }
2543
2544
        switch ($sortby) {
2545
            case 'NAME':
2546
                uasort($this->list, GedcomRecord::nameComparator());
2547
                break;
2548
            case 'CHAN':
2549
                uasort($this->list, GedcomRecord::lastChangeComparator());
2550
                break;
2551
            case 'BIRT:DATE':
2552
                uasort($this->list, Individual::birthDateComparator());
2553
                break;
2554
            case 'DEAT:DATE':
2555
                uasort($this->list, Individual::deathDateComparator());
2556
                break;
2557
            case 'MARR:DATE':
2558
                uasort($this->list, Family::marriageDateComparator());
2559
                break;
2560
            default:
2561
                // unsorted or already sorted by SQL
2562
                break;
2563
        }
2564
2565
        $this->repeats_stack[] = [$this->repeats, $this->repeat_bytes];
2566
        $this->repeat_bytes    = xml_get_current_line_number($this->parser) + 1;
2567
    }
2568
2569
    /**
2570
     * Handle </list>
2571
     *
2572
     * @return void
2573
     */
2574
    protected function listEndHandler(): void
2575
    {
2576
        $this->process_repeats--;
2577
        if ($this->process_repeats > 0) {
2578
            return;
2579
        }
2580
2581
        // Check if there is any list
2582
        if (count($this->list) > 0) {
2583
            $lineoffset = 0;
2584
            foreach ($this->repeats_stack as $rep) {
2585
                $lineoffset = $lineoffset + (int) ($rep[1]) - 1;
2586
            }
2587
            //-- read the xml from the file
2588
            $lines = file($this->report);
2589
            if (empty($lines)) {
2590
                error_log(__FILE__ . ":" . __LINE__ . " impossible error!? \n");
2591
                // this can not happen! phpstan forces me to add stupid code
2592
                // we come here because the xml file exists! Is it possible to tell phpstan the $lines *is* an array ??
2593
                die("can not happen!!!");
0 ignored issues
show
Best Practice introduced by
Using exit here is not recommended.

In general, usage of exit should be done with care and only when running in a scripting context like a CLI script.

Loading history...
2594
            }
2595
            while ((!str_contains($lines[$lineoffset + $this->repeat_bytes], '<List')) && (($lineoffset + $this->repeat_bytes) > 0)) {
2596
                $lineoffset--;
2597
            }
2598
            $lineoffset++;
2599
            $reportxml = "<tempdoc>\n";
2600
            $line_nr   = $lineoffset + $this->repeat_bytes;
2601
            // List Level counter
2602
            $count = 1;
2603
            while (0 < $count) {
2604
                if (str_contains($lines[$line_nr], '<List')) {
2605
                    $count++;
2606
                } elseif (str_contains($lines[$line_nr], '</List')) {
2607
                    $count--;
2608
                }
2609
                if (0 < $count) {
2610
                    $reportxml .= $lines[$line_nr];
2611
                }
2612
                $line_nr++;
2613
            }
2614
            // No need to drag this
2615
            unset($lines);
2616
            $reportxml .= '</tempdoc>';
2617
            // Save original values
2618
            $this->parser_stack[] = $this->parser;
2619
            $oldgedrec            = $this->gedrec;
2620
2621
            $this->list_total   = count($this->list);
2622
            $this->list_private = 0;
2623
            foreach ($this->list as $record) {
2624
                if ($record->canShow()) {
2625
                    $this->gedrec = $record->privatizeGedcom(Auth::accessLevel($record->tree()));
2626
                    //-- start the sax parser
2627
                    $repeat_parser = xml_parser_create();
2628
                    $this->parser  = $repeat_parser;
2629
                    xml_parser_set_option($repeat_parser, XML_OPTION_CASE_FOLDING, 0);
2630
2631
                    xml_set_element_handler(
2632
                        $repeat_parser,
2633
                        function ($parser, string $name, array $attrs): void {
2634
                            $this->startElement($parser, $name, $attrs);
2635
                        },
2636
                        function ($parser, string $name): void {
2637
                            $this->endElement($parser, $name);
2638
                        }
2639
                    );
2640
2641
                    xml_set_character_data_handler(
2642
                        $repeat_parser,
2643
                        function ($parser, string $data): void {
2644
                            $this->characterData($parser, $data);
2645
                        }
2646
                    );
2647
2648
                    if (!xml_parse($repeat_parser, $reportxml, true)) {
2649
                        throw new DomainException(sprintf(
2650
                            'ListEHandler XML error: %s at line %d',
2651
                            xml_error_string(xml_get_error_code($repeat_parser)),
2652
                            xml_get_current_line_number($repeat_parser)
2653
                        ));
2654
                    }
2655
                    xml_parser_free($repeat_parser);
2656
                } else {
2657
                    $this->list_private++;
2658
                }
2659
            }
2660
            $this->list   = [];
2661
            $this->parser = array_pop($this->parser_stack);
2662
            $this->gedrec = $oldgedrec;
2663
        }
2664
        [$this->repeats, $this->repeat_bytes] = array_pop($this->repeats_stack);
2665
    }
2666
2667
    /**
2668
     * Handle <listTotal>
2669
     * Prints the total number of records in a list
2670
     * The total number is collected from <list> and <relatives>
2671
     *
2672
     * @return void
2673
     */
2674
    protected function listTotalStartHandler(): void
2675
    {
2676
        if ($this->list_private == 0) {
2677
            $this->current_element->addText((string) $this->list_total);
2678
        } else {
2679
            $this->current_element->addText(($this->list_total - $this->list_private) . ' / ' . $this->list_total);
2680
        }
2681
    }
2682
2683
    /**
2684
     * Handle <relatives>
2685
     *
2686
     * @param array<string> $attrs
2687
     *
2688
     * @return void
2689
     */
2690
    protected function relativesStartHandler(array $attrs): void
2691
    {
2692
        $this->process_repeats++;
2693
        if ($this->process_repeats > 1) {
2694
            return;
2695
        }
2696
2697
        $sortby = $attrs['sortby'] ?? 'NAME';
2698
2699
        $match = [];
2700
        if (preg_match("/\\$(\w+)/", $sortby, $match)) {
2701
            $sortby = $this->vars[$match[1]]['id'];
2702
            $sortby = trim($sortby);
2703
        }
2704
2705
        $maxgen = -1;
2706
        if (isset($attrs['maxgen'])) {
2707
            $maxgen = (int) $attrs['maxgen'];
2708
        }
2709
2710
        $group = $attrs['group'] ?? 'child-family';
2711
2712
        if (preg_match("/\\$(\w+)/", $group, $match)) {
2713
            $group = $this->vars[$match[1]]['id'];
2714
            $group = trim($group);
2715
        }
2716
2717
        $id = $attrs['id'] ?? '';
2718
2719
        if (preg_match("/\\$(\w+)/", $id, $match)) {
2720
            $id = $this->vars[$match[1]]['id'];
2721
            $id = trim($id);
2722
        }
2723
2724
        $this->list = [];
2725
        $person     = Registry::individualFactory()->make($id, $this->tree);
2726
        if ($person instanceof Individual) {
2727
            $this->list[$id] = $person;
2728
            $this->mfrelation[$id] = "";
2729
            $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...
2730
            switch ($group) {
2731
                case 'child-family':
2732
                    foreach ($person->childFamilies() as $family) {
2733
                        foreach ($family->spouses() as $spouse) {
2734
                            $this->list[$spouse->xref()] = $spouse;
2735
                        }
2736
2737
                        foreach ($family->children() as $child) {
2738
                            $this->list[$child->xref()] = $child;
2739
                        }
2740
                    }
2741
                    break;
2742
                case 'spouse-family':
2743
                    foreach ($person->spouseFamilies() as $family) {
2744
                        foreach ($family->spouses() as $spouse) {
2745
                            $this->list[$spouse->xref()] = $spouse;
2746
                        }
2747
2748
                        foreach ($family->children() as $child) {
2749
                            $this->list[$child->xref()] = $child;
2750
                        }
2751
                    }
2752
                    break;
2753
                case 'direct-ancestors':
2754
                    $this->addAncestors($this->list, $id, false, $maxgen);
2755
                    break;
2756
                case 'ancestors':
2757
                    $this->addAncestors($this->list, $id, true, $maxgen);
2758
                    break;
2759
                case 'descendants':
2760
                    $this->list[$id]->generation = 1;
2761
                    $this->addDescendancy($this->list, $id, false, $maxgen);
2762
                    break;
2763
                case 'all':
2764
                    $this->addAncestors($this->list, $id, true, $maxgen);
2765
                    $this->addDescendancy($this->list, $id, true, $maxgen);
2766
                    break;
2767
            }
2768
        }
2769
2770
        switch ($sortby) {
2771
            case 'NAME':
2772
                uasort($this->list, GedcomRecord::nameComparator());
2773
                break;
2774
            case 'BIRT:DATE':
2775
                uasort($this->list, Individual::birthDateComparator());
2776
                break;
2777
            case 'DEAT:DATE':
2778
                uasort($this->list, Individual::deathDateComparator());
2779
                break;
2780
            case 'generation':
2781
                $newarray = [];
2782
                reset($this->list);
2783
                $genCounter = 1;
2784
                while (count($newarray) < count($this->list)) {
2785
                    foreach ($this->list as $key => $value) {
2786
                        if ($value->generation < 0) {
2787
                            // indication of husband or wife
2788
                            $this->generation = -$value->generation;
2789
                        } else {
2790
                            $this->generation = $value->generation;
2791
                        }
2792
                        if ($this->generation == $genCounter) {
2793
                            $newarray[$key] = (object) ['generation' => $this->generation];
2794
                        }
2795
                    }
2796
                    $genCounter++;
2797
                }
2798
                $this->list = $newarray;
2799
                break;
2800
            default:
2801
                // unsorted
2802
                break;
2803
        }
2804
        $this->repeats_stack[] = [$this->repeats, $this->repeat_bytes];
2805
        $this->repeat_bytes    = xml_get_current_line_number($this->parser) + 1;
2806
    }
2807
2808
    /**
2809
     * Handle </relatives>
2810
     *
2811
     * @return void
2812
     */
2813
    protected function relativesEndHandler(): void
2814
    {
2815
        $this->process_repeats--;
2816
        if ($this->process_repeats > 0) {
2817
            return;
2818
        }
2819
2820
        // Check if there is any relatives
2821
        if (count($this->list) > 0) {
2822
            $lineoffset = 0;
2823
            foreach ($this->repeats_stack as $rep) {
2824
                $lineoffset = $lineoffset + (int) ($rep[1]) - 1;
2825
            }
2826
            //-- read the xml from the file
2827
            $lines = file($this->report);
2828
            if (empty($lines)) {
2829
                error_log(__FILE__ . ":" . __LINE__ . " impossible error!? \n");
2830
                // this can not happen! phpstan forces me to add stupid code
2831
                // we come here because the xml file exists! Is it possible to tell phpstan the $lines *is* an array ??
2832
                die("can not happen!!!");
0 ignored issues
show
Best Practice introduced by
Using exit here is not recommended.

In general, usage of exit should be done with care and only when running in a scripting context like a CLI script.

Loading history...
2833
            }
2834
            while (!str_contains($lines[$lineoffset + $this->repeat_bytes], '<Relatives') && $lineoffset + $this->repeat_bytes > 0) {
2835
                $lineoffset--;
2836
            }
2837
            $lineoffset++;
2838
            $reportxml = "<tempdoc>\n";
2839
            $line_nr   = $lineoffset + $this->repeat_bytes;
2840
            // Relatives Level counter
2841
            $count = 1;
2842
            while (0 < $count) {
2843
                if (str_contains($lines[$line_nr], '<Relatives')) {
2844
                    $count++;
2845
                } elseif (str_contains($lines[$line_nr], '</Relatives')) {
2846
                    $count--;
2847
                }
2848
                if (0 < $count) {
2849
                    $reportxml .= $lines[$line_nr];
2850
                }
2851
                $line_nr++;
2852
            }
2853
            // No need to drag this
2854
            unset($lines);
2855
            $reportxml .= "</tempdoc>\n";
2856
            // Save original values
2857
            $this->parser_stack[] = $this->parser;
2858
            $oldgedrec            = $this->gedrec;
2859
2860
            $this->list_total   = count($this->list);
2861
            $this->list_private = 0;
2862
            foreach ($this->list as $key => $value) {
2863
                if (isset($value->generation)) {
2864
                    $this->generation = $value->generation;
2865
                }
2866
                $xref = $key;
2867
                $this->vars["dupl"]["id"] = "no";
2868
                if (substr($key, 0, 2) == "D_") {
2869
                    $xref = substr($key, strrpos($key, "_") + 1);
2870
                    $this->vars["dupl"]["id"] = "yes";
2871
                }
2872
                $tmp          = Registry::gedcomRecordFactory()->make((string) $xref, $this->tree);
2873
                $this->gedrec = $tmp->privatizeGedcom(Auth::accessLevel($this->tree));
2874
2875
                $repeat_parser = xml_parser_create();
2876
                $this->parser  = $repeat_parser;
2877
                xml_parser_set_option($repeat_parser, XML_OPTION_CASE_FOLDING, 0);
2878
2879
                xml_set_element_handler(
2880
                    $repeat_parser,
2881
                    function ($parser, string $name, array $attrs): void {
2882
                        $this->startElement($parser, $name, $attrs);
2883
                    },
2884
                    function ($parser, string $name): void {
2885
                        $this->endElement($parser, $name);
2886
                    }
2887
                );
2888
2889
                xml_set_character_data_handler(
2890
                    $repeat_parser,
2891
                    function ($parser, string $data): void {
2892
                        $this->characterData($parser, $data);
2893
                    }
2894
                );
2895
2896
                if (!xml_parse($repeat_parser, $reportxml, true)) {
2897
                    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)));
2898
                }
2899
                xml_parser_free($repeat_parser);
2900
            }
2901
            // Clean up the list array
2902
            $this->list   = [];
2903
            $this->parser = array_pop($this->parser_stack);
2904
            $this->gedrec = $oldgedrec;
2905
        }
2906
        [$this->repeats, $this->repeat_bytes] = array_pop($this->repeats_stack);
2907
    }
2908
2909
    /**
2910
     * Handle <generation />
2911
     * Prints the number of generations
2912
     *
2913
     * @return void
2914
     */
2915
    protected function generationStartHandler(): void
2916
    {
2917
        $this->current_element->addText((string) $this->generation);
2918
    }
2919
2920
    /**
2921
     * Handle <newPage />
2922
     * Has to be placed in an element (header, body or footer)
2923
     *
2924
     * @return void
2925
     */
2926
    protected function newPageStartHandler(): void
2927
    {
2928
        $temp = 'addpage';
2929
        $this->wt_report->addElement($temp);
2930
    }
2931
2932
    /**
2933
     * Handle </title>
2934
     *
2935
     * @return void
2936
     */
2937
    protected function titleEndHandler(): void
2938
    {
2939
        $this->report_root->addTitle($this->text);
2940
    }
2941
2942
    /**
2943
     * Handle </description>
2944
     *
2945
     * @return void
2946
     */
2947
    protected function descriptionEndHandler(): void
2948
    {
2949
        $this->report_root->addDescription($this->text);
2950
    }
2951
2952
    /**
2953
     * Create a list of all descendants.
2954
     *
2955
     * @param array<Individual> $list
2956
     * @param string            $pid
2957
     * @param bool              $parents
2958
     * @param int               $generations
2959
     *
2960
     * @return void
2961
     */
2962
    private function addDescendancy(&$list, $pid, $parents = false, $generations = -1): void
2963
    {
2964
        $person = Registry::individualFactory()->make($pid, $this->tree);
2965
        if ($person === null) {
2966
            return;
2967
        }
2968
2969
        static $focusperson = true;
2970
        static $dupl = 1;
2971
        $sx = $person->sex();
2972
        $rl = "x"; // unknown
2973
        if ($sx == "M") {
2974
            $rl = "s";
2975
        } // son
2976
        if ($sx == "F") {
2977
            $rl = "d";
0 ignored issues
show
Unused Code introduced by
The assignment to $rl is dead and can be removed.
Loading history...
2978
        } // daughter
2979
        if ($focusperson) {
2980
            $this->mfrelation[$pid] = "";
2981
        }
2982
        $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...
2983
2984
        $newpid = $pid;
2985
        if (!isset($list[$pid])) {
2986
            $list[$pid] = $person;
2987
        } elseif (!$focusperson) {
2988
            $newpid = "D_" . $dupl . "_" . $pid;
2989
            $list[$newpid] = $person;
2990
        }
2991
        if (!isset($list[$newpid]->generation)) {
2992
            $list[$newpid]->generation = 0;
2993
        }
2994
        $focusperson = false;
2995
        foreach ($person->spouseFamilies() as $family) {
2996
            if ($parents) {
2997
                $husband = $family->husband();
2998
                $wife    = $family->wife();
2999
                if ($husband) {
3000
                    $list[$husband->xref()] = $husband;
3001
                    if (isset($list[$pid]->generation)) {
3002
                        $list[$husband->xref()]->generation = $list[$pid]->generation - 1;
3003
                    } else {
3004
                        $list[$husband->xref()]->generation = 1;
3005
                    }
3006
                }
3007
                if ($wife) {
3008
                    $list[$wife->xref()] = $wife;
3009
                    if (isset($list[$pid]->generation)) {
3010
                        $list[$wife->xref()]->generation = $list[$pid]->generation - 1;
3011
                    } else {
3012
                        $list[$wife->xref()]->generation = 1;
3013
                    }
3014
                }
3015
            }
3016
            $husband = $family->husband();
3017
            $wife = $family->wife();
3018
3019
            if ($husband && $wife) {
3020
                if ($husband->xref() == $person->xref()) {
3021
                    $this->mfrelation[$wife->xref()] = $this->mfrelation[$person->xref()] . "x";
3022
                    if ($wife->canShow()) {
3023
                        $list[$wife->xref()] = $wife;
3024
                    }
3025
                    if (!isset($wife->generation)) {
3026
                        $wife->generation = $person->generation;
3027
                    }
3028
                    $nam = $wife->getAllNames()[0]['fullNN'];
3029
                } else {
3030
                    $this->mfrelation[$husband->xref()] = $this->mfrelation[$person->xref()] . "x";
3031
                    if ($husband->canShow()) {
3032
                        $list[$husband->xref()] = $husband;
3033
                    }
3034
                    if (!isset($husband->generation)) {
3035
                        $husband->generation = $person->generation;
3036
                    }
3037
                    $nam = $husband->getAllNames()[0]['fullNN'];
3038
                }
3039
            }
3040
3041
            $children = $family->children();
3042
            foreach ($children as $child) {
3043
                if ($child) {
3044
                    $sx = $child->sex();
3045
                    $rl = "x"; // unknown
3046
                    if ($sx == "M") {
3047
                        $rl = "s";
3048
                    } // son
3049
                    if ($sx == "F") {
3050
                        $rl = "d";
3051
                    } // daughter
3052
                    $rl = $this->mfrelation[$person->xref()] . $rl;
3053
                    $this->mfrelation[$child->xref()] = $rl;
3054
                    if (isset($list[$pid]->generation)) {
3055
                        $child->generation = $list[$pid]->generation + 1;
3056
                    } else {
3057
                        $child->generation = 2;
3058
                    }
3059
                }
3060
            }
3061
            if ($generations == -1 || $list[$pid]->generation < $generations) {
3062
                foreach ($children as $child) {
3063
                    if ($child->canShow()) {
3064
                        $this->addDescendancy($list, $child->xref(), $parents, $generations);
3065
                    } // recurse on the childs family
3066
                }
3067
            }
3068
        }
3069
        $focusperson = false;
0 ignored issues
show
Unused Code introduced by
The assignment to $focusperson is dead and can be removed.
Loading history...
3070
    }
3071
3072
    /**
3073
     * Create a list of all ancestors.
3074
     *
3075
     * @param array<Individual> $list
3076
     * @param string            $pid
3077
     * @param bool              $children
3078
     * @param int               $generations
3079
     *
3080
     * @return void
3081
     */
3082
    private function addAncestors(array &$list, string $pid, bool $children = false, int $generations = -1): void
3083
    {
3084
        $genlist                = [$pid];
3085
        $list[$pid]->generation = 1;
3086
        while (count($genlist) > 0) {
3087
            $id = array_shift($genlist);
3088
            if (str_starts_with($id, 'empty')) {
3089
                continue; // id can be something like “empty7”
3090
            }
3091
            if (!isset($this->mfrelation[$id])) {
3092
                $this->mfrelation[$id] = "";
3093
            }
3094
            $person = Registry::individualFactory()->make($id, $this->tree);
3095
            foreach ($person->childFamilies() as $family) {
3096
                $husband = $family->husband();
3097
                $wife    = $family->wife();
3098
                if ($husband) {
3099
                    $list[$husband->xref()]             = $husband;
3100
                    $list[$husband->xref()]->generation = $list[$id]->generation + 1;
3101
                    $this->mfrelation[$husband->xref()] = $this->mfrelation[$id] . "f";
3102
                }
3103
                if ($wife) {
3104
                    $list[$wife->xref()]             = $wife;
3105
                    $list[$wife->xref()]->generation = $list[$id]->generation + 1;
3106
                    $this->mfrelation[$wife->xref()] = $this->mfrelation[$id] . "m";
3107
                }
3108
                if ($generations == -1 || $list[$id]->generation + 1 < $generations) {
3109
                    if ($husband) {
3110
                        $genlist[] = $husband->xref();
3111
                    }
3112
                    if ($wife) {
3113
                        $genlist[] = $wife->xref();
3114
                    }
3115
                }
3116
                if ($children && isset($person)) {
3117
                    // unnecessary test of $person to satisfy phpstan!
3118
                    foreach ($family->children() as $child) {
3119
                        $list[$child->xref()] = $child;
3120
                        $child->generation = $list[$id]->generation ?? 1;
3121
                        if ($child->xref() != $person->xref()) {
3122
                            $this->mfrelation[$child->xref()] = $this->mfrelation[$id] . "x";
3123
                        }
3124
                    }
3125
                }
3126
            }
3127
        }
3128
    }
3129
3130
    /**
3131
     * get gedcom tag value
3132
     *
3133
     * @param string $tag    The tag to find, use : to delineate subtags
3134
     * @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
3135
     * @param string $gedrec The gedcom record to get the value from
3136
     *
3137
     * @return string the value of a gedcom tag from the given gedcom record
3138
     */
3139
    private function getGedcomValue(string $tag, int $level, string $gedrec): string
3140
    {
3141
        if ($gedrec === '') {
3142
            return '';
3143
        }
3144
        $tags      = explode(':', $tag);
3145
        $origlevel = $level;
3146
        if ($level === 0) {
3147
            $level = $gedrec[0] + 1;
3148
        }
3149
3150
        $subrec = $gedrec;
3151
        $t = 'XXXX';
3152
        foreach ($tags as $t) {
3153
            $lastsubrec = $subrec;
3154
            $subrec     = self::getSubRecord($level, "$level $t", $subrec);
3155
            if (empty($subrec) && $origlevel == 0) {
3156
                $level--;
3157
                $subrec = self::getSubRecord($level, "$level $t", $lastsubrec);
3158
            }
3159
            if (empty($subrec)) {
3160
                if ($t === 'TITL') {
3161
                    $subrec = self::getSubRecord($level, "$level ABBR", $lastsubrec);
3162
                    if (!empty($subrec)) {
3163
                        $t = 'ABBR';
3164
                    }
3165
                }
3166
                if ($subrec === '') {
3167
                    if ($level > 0) {
3168
                        $level--;
3169
                    }
3170
                    $subrec = self::getSubRecord($level, "@ $t", $gedrec);
3171
                    if ($subrec === '') {
3172
                        return '';
3173
                    }
3174
                }
3175
            }
3176
            $level++;
3177
        }
3178
        $level--;
3179
        $ct = preg_match("/$level $t(.*)/", $subrec, $match);
3180
        if ($ct === 0) {
3181
            $ct = preg_match("/$level @.+@ (.+)/", $subrec, $match);
3182
        }
3183
        if ($ct === 0) {
3184
            $ct = preg_match("/@ $t (.+)/", $subrec, $match);
3185
        }
3186
        if ($ct > 0) {
3187
            $value = trim($match[1]);
3188
            if ($t === 'NOTE' && preg_match('/^@(.+)@$/', $value, $match)) {
3189
                $note = Registry::noteFactory()->make($match[1], $this->tree);
3190
                if ($note instanceof Note) {
3191
                    $value = $note->getNote();
3192
                } else {
3193
                    //-- set the value to the id without the @
3194
                    $value = $match[1];
3195
                }
3196
            }
3197
            if ($level !== 0 || $t !== 'NOTE') {
3198
                $value .= self::getCont($level + 1, $subrec);
3199
            }
3200
3201
            if ($tag === 'NAME' || $tag === '_MARNM' || $tag === '_AKA') {
3202
                return strtr($value, ['/' => '']);
3203
            }
3204
3205
            if ($tag === 'NAME' || $tag === '_MARNM' || $tag === '_AKA') {
3206
                return strtr($value, ['/' => '']);
3207
            }
3208
3209
            return $value;
3210
        }
3211
3212
        return '';
3213
    }
3214
3215
    /**
3216
     * Replace variable identifiers with their values.
3217
     *
3218
     * @param string $expression An expression such as "$foo == 123"
3219
     * @param bool   $quote      Whether to add quotation marks
3220
     *
3221
     * @return string
3222
     */
3223
    private function substituteVars($expression, $quote): string
3224
    {
3225
        return preg_replace_callback(
3226
            '/\$(\w+)/',
3227
            function (array $matches) use ($quote): string {
3228
                if (isset($this->vars[$matches[1]]['id'])) {
3229
                    if ($quote) {
3230
                        return "'" . addcslashes($this->vars[$matches[1]]['id'], "'") . "'";
3231
                    }
3232
3233
                    return $this->vars[$matches[1]]['id'];
3234
                }
3235
3236
                Log::addErrorLog(sprintf('Undefined variable $%s in report', $matches[1]));
3237
3238
                return '$' . $matches[1];
3239
            },
3240
            $expression
3241
        );
3242
    }
3243
}
3244