xref: /webtrees/app/Source.php (revision 9b802b22a7b94d1d30e0433dd46fe641f3757505) 
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2019 webtrees development team
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16declare(strict_types=1);
17
18namespace Fisharebest\Webtrees;
19
20use Illuminate\Database\Capsule\Manager as DB;
21
22/**
23 * A GEDCOM source (SOUR) object.
24 */
25class Source extends GedcomRecord
26{
27    public const RECORD_TYPE = 'SOUR';
28
29    protected const ROUTE_NAME  = 'source';
30
31    /**
32     * Get an instance of a source object. For single records,
33     * we just receive the XREF. For bulk records (such as lists
34     * and search results) we can receive the GEDCOM data as well.
35     *
36     * @param string      $xref
37     * @param Tree        $tree
38     * @param string|null $gedcom
39     *
40     * @throws \Exception
41     *
42     * @return Source|null
43     */
44    public static function getInstance(string $xref, Tree $tree, string $gedcom = null)
45    {
46        $record = parent::getInstance($xref, $tree, $gedcom);
47
48        if ($record instanceof Source) {
49            return $record;
50        }
51
52        return null;
53    }
54
55    /**
56     * Each object type may have its own special rules, and re-implement this function.
57     *
58     * @param int $access_level
59     *
60     * @return bool
61     */
62    protected function canShowByType(int $access_level): bool
63    {
64        // Hide sources if they are attached to private repositories ...
65        preg_match_all('/\n1 REPO @(.+)@/', $this->gedcom, $matches);
66        foreach ($matches[1] as $match) {
67            $repo = Repository::getInstance($match, $this->tree);
68            if ($repo && !$repo->canShow($access_level)) {
69                return false;
70            }
71        }
72
73        // ... otherwise apply default behaviour
74        return parent::canShowByType($access_level);
75    }
76
77    /**
78     * Generate a private version of this record
79     *
80     * @param int $access_level
81     *
82     * @return string
83     */
84    protected function createPrivateGedcomRecord(int $access_level): string
85    {
86        return '0 @' . $this->xref . "@ SOUR\n1 TITL " . I18N::translate('Private');
87    }
88
89    /**
90     * Fetch data from the database
91     *
92     * @param string $xref
93     * @param int    $tree_id
94     *
95     * @return null|string
96     */
97    protected static function fetchGedcomRecord(string $xref, int $tree_id)
98    {
99        return DB::table('sources')
100            ->where('s_id', '=', $xref)
101            ->where('s_file', '=', $tree_id)
102            ->value('s_gedcom');
103    }
104
105    /**
106     * Extract names from the GEDCOM record.
107     *
108     * @return void
109     */
110    public function extractNames()
111    {
112        parent::extractNamesFromFacts(1, 'TITL', $this->facts(['TITL']));
113    }
114}
115