xref: /webtrees/app/Source.php (revision b0fcccb03b84c12d54b4ae85014c3af52863d08c) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2019 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 <http://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees;
21
22use Closure;
23use Exception;
24use Fisharebest\Webtrees\Http\RequestHandlers\SourcePage;
25use Illuminate\Database\Capsule\Manager as DB;
26use stdClass;
27
28/**
29 * A GEDCOM source (SOUR) object.
30 */
31class Source extends GedcomRecord
32{
33    public const RECORD_TYPE = 'SOUR';
34
35    protected const ROUTE_NAME  = SourcePage::class;
36
37    /**
38     * A closure which will create a record from a database row.
39     *
40     * @param Tree $tree
41     *
42     * @return Closure
43     */
44    public static function rowMapper(Tree $tree): Closure
45    {
46        return static function (stdClass $row) use ($tree): Source {
47            return Source::getInstance($row->s_id, $tree, $row->s_gedcom);
48        };
49    }
50
51    /**
52     * Get an instance of a source object. For single records,
53     * we just receive the XREF. For bulk records (such as lists
54     * and search results) we can receive the GEDCOM data as well.
55     *
56     * @param string      $xref
57     * @param Tree        $tree
58     * @param string|null $gedcom
59     *
60     * @throws Exception
61     *
62     * @return Source|null
63     */
64    public static function getInstance(string $xref, Tree $tree, string $gedcom = null): ?self
65    {
66        $record = parent::getInstance($xref, $tree, $gedcom);
67
68        if ($record instanceof self) {
69            return $record;
70        }
71
72        return null;
73    }
74
75    /**
76     * Each object type may have its own special rules, and re-implement this function.
77     *
78     * @param int $access_level
79     *
80     * @return bool
81     */
82    protected function canShowByType(int $access_level): bool
83    {
84        // Hide sources if they are attached to private repositories ...
85        preg_match_all('/\n1 REPO @(.+)@/', $this->gedcom, $matches);
86        foreach ($matches[1] as $match) {
87            $repo = Repository::getInstance($match, $this->tree);
88            if ($repo && !$repo->canShow($access_level)) {
89                return false;
90            }
91        }
92
93        // ... otherwise apply default behavior
94        return parent::canShowByType($access_level);
95    }
96
97    /**
98     * Generate a private version of this record
99     *
100     * @param int $access_level
101     *
102     * @return string
103     */
104    protected function createPrivateGedcomRecord(int $access_level): string
105    {
106        return '0 @' . $this->xref . "@ SOUR\n1 TITL " . I18N::translate('Private');
107    }
108
109    /**
110     * Fetch data from the database
111     *
112     * @param string $xref
113     * @param int    $tree_id
114     *
115     * @return string|null
116     */
117    protected static function fetchGedcomRecord(string $xref, int $tree_id): ?string
118    {
119        return DB::table('sources')
120            ->where('s_id', '=', $xref)
121            ->where('s_file', '=', $tree_id)
122            ->value('s_gedcom');
123    }
124
125    /**
126     * Extract names from the GEDCOM record.
127     *
128     * @return void
129     */
130    public function extractNames(): void
131    {
132        $this->extractNamesFromFacts(1, 'TITL', $this->facts(['TITL']));
133    }
134}
135