. */ declare(strict_types=1); namespace Fisharebest\Webtrees\Services; use Fisharebest\Webtrees\Auth; use Fisharebest\Webtrees\Contracts\UserInterface; use Fisharebest\Webtrees\Functions\FunctionsImport; use Fisharebest\Webtrees\I18N; use Fisharebest\Webtrees\Registry; use Fisharebest\Webtrees\Site; use Fisharebest\Webtrees\Tree; use Illuminate\Database\Capsule\Manager as DB; use Illuminate\Database\Query\Builder; use Illuminate\Database\Query\Expression; use Illuminate\Database\Query\JoinClause; use Illuminate\Support\Collection; use Psr\Http\Message\StreamInterface; use RuntimeException; use stdClass; use function assert; use function strlen; use function substr; /** * Tree management and queries. */ class TreeService { // The most likely surname tradition for a given language. private const DEFAULT_SURNAME_TRADITIONS = [ 'es' => 'spanish', 'is' => 'icelandic', 'lt' => 'lithuanian', 'pl' => 'polish', 'pt' => 'portuguese', 'pt-BR' => 'portuguese', ]; /** * All the trees that the current user has permission to access. * * @return Collection */ public function all(): Collection { return Registry::cache()->array()->remember('all-trees', static function (): Collection { // All trees $query = DB::table('gedcom') ->leftJoin('gedcom_setting', static function (JoinClause $join): void { $join->on('gedcom_setting.gedcom_id', '=', 'gedcom.gedcom_id') ->where('gedcom_setting.setting_name', '=', 'title'); }) ->where('gedcom.gedcom_id', '>', 0) ->select([ 'gedcom.gedcom_id AS tree_id', 'gedcom.gedcom_name AS tree_name', 'gedcom_setting.setting_value AS tree_title', ]) ->orderBy('gedcom.sort_order') ->orderBy('gedcom_setting.setting_value'); // Non-admins may not see all trees if (!Auth::isAdmin()) { $query ->join('gedcom_setting AS gs2', static function (JoinClause $join): void { $join ->on('gs2.gedcom_id', '=', 'gedcom.gedcom_id') ->on('gs2.setting_name', '=', 'imported'); }) ->join('gedcom_setting AS gs3', static function (JoinClause $join): void { $join ->on('gs3.gedcom_id', '=', 'gedcom.gedcom_id') ->on('gs3.setting_name', '=', 'REQUIRE_AUTHENTICATION'); }) ->leftJoin('user_gedcom_setting', static function (JoinClause $join): void { $join ->on('user_gedcom_setting.gedcom_id', '=', 'gedcom.gedcom_id') ->on('user_gedcom_setting.user_id', '=', Auth::id()) ->on('user_gedcom_setting.setting_name', '=', UserInterface::PREF_TREE_ROLE); }) ->where(static function (Builder $query): void { $query // Managers ->where('user_gedcom_setting.setting_value', '=', UserInterface::ROLE_MANAGER) // Members ->orWhere(static function (Builder $query): void { $query ->where('gs2.setting_value', '=', '1') ->where('gs3.setting_value', '=', '1') ->where('user_gedcom_setting.setting_value', '<>', UserInterface::ROLE_VISITOR); }) // Public trees ->orWhere(static function (Builder $query): void { $query ->where('gs2.setting_value', '=', '1') ->where('gs3.setting_value', '<>', '1'); }); }); } return $query ->get() ->mapWithKeys(static function (stdClass $row): array { return [$row->tree_name => Tree::rowMapper()($row)]; }); }); } /** * Find a tree by its ID. * * @param int $id * * @return Tree */ public function find(int $id): Tree { $tree = $this->all()->first(static function (Tree $tree) use ($id): bool { return $tree->id() === $id; }); assert($tree instanceof Tree, new RuntimeException()); return $tree; } /** * All trees, name => title * * @return array */ public function titles(): array { return $this->all()->map(static function (Tree $tree): string { return $tree->title(); })->all(); } /** * @param string $name * @param string $title * * @return Tree */ public function create(string $name, string $title): Tree { DB::table('gedcom')->insert([ 'gedcom_name' => $name, ]); $tree_id = (int) DB::connection()->getPdo()->lastInsertId(); $tree = new Tree($tree_id, $name, $title); $tree->setPreference('imported', '1'); $tree->setPreference('title', $title); // Set preferences from default tree (new Builder(DB::connection()))->from('gedcom_setting')->insertUsing( ['gedcom_id', 'setting_name', 'setting_value'], static function (Builder $query) use ($tree_id): void { $query ->select([new Expression($tree_id), 'setting_name', 'setting_value']) ->from('gedcom_setting') ->where('gedcom_id', '=', -1); } ); (new Builder(DB::connection()))->from('default_resn')->insertUsing( ['gedcom_id', 'tag_type', 'resn'], static function (Builder $query) use ($tree_id): void { $query ->select([new Expression($tree_id), 'tag_type', 'resn']) ->from('default_resn') ->where('gedcom_id', '=', -1); } ); // Gedcom and privacy settings $tree->setPreference('REQUIRE_AUTHENTICATION', ''); $tree->setPreference('CONTACT_USER_ID', (string) Auth::id()); $tree->setPreference('WEBMASTER_USER_ID', (string) Auth::id()); $tree->setPreference('LANGUAGE', I18N::languageTag()); // Default to the current admin’s language $tree->setPreference('SURNAME_TRADITION', self::DEFAULT_SURNAME_TRADITIONS[I18N::languageTag()] ?? 'paternal'); // A tree needs at least one record. $head = "0 HEAD\n1 SOUR webtrees\n2 DEST webtrees\n1 GEDC\n2 VERS 5.5.1\n2 FORM LINEAGE-LINKED\n1 CHAR UTF-8"; FunctionsImport::importRecord($head, $tree, true); // I18N: This should be a common/default/placeholder name of an individual. Put slashes around the surname. $name = I18N::translate('John /DOE/'); $note = I18N::translate('Edit this individual and replace their details with your own.'); $indi = "0 @X1@ INDI\n1 NAME " . $name . "\n1 SEX M\n1 BIRT\n2 DATE 01 JAN 1850\n2 NOTE " . $note; FunctionsImport::importRecord($indi, $tree, true); return $tree; } /** * Import data from a gedcom file into this tree. * * @param Tree $tree * @param StreamInterface $stream The GEDCOM file. * @param string $filename The preferred filename, for export/download. * * @return void */ public function importGedcomFile(Tree $tree, StreamInterface $stream, string $filename): void { // Read the file in blocks of roughly 64K. Ensure that each block // contains complete gedcom records. This will ensure we don’t split // multi-byte characters, as well as simplifying the code to import // each block. $file_data = ''; $tree->setPreference('gedcom_filename', $filename); $tree->setPreference('imported', '0'); DB::table('gedcom_chunk')->where('gedcom_id', '=', $tree->id())->delete(); while (!$stream->eof()) { $file_data .= $stream->read(65536); // There is no strrpos() function that searches for substrings :-( for ($pos = strlen($file_data) - 1; $pos > 0; --$pos) { if ($file_data[$pos] === '0' && ($file_data[$pos - 1] === "\n" || $file_data[$pos - 1] === "\r")) { // We’ve found the last record boundary in this chunk of data break; } } if ($pos) { DB::table('gedcom_chunk')->insert([ 'gedcom_id' => $tree->id(), 'chunk_data' => substr($file_data, 0, $pos), ]); $file_data = substr($file_data, $pos); } } DB::table('gedcom_chunk')->insert([ 'gedcom_id' => $tree->id(), 'chunk_data' => $file_data, ]); $stream->close(); } /** * @param Tree $tree */ public function delete(Tree $tree): void { // If this is the default tree, then unset it if (Site::getPreference('DEFAULT_GEDCOM') === $tree->name()) { Site::setPreference('DEFAULT_GEDCOM', ''); } DB::table('gedcom_chunk')->where('gedcom_id', '=', $tree->id())->delete(); $this->deleteGenealogyData($tree, false); DB::table('block_setting') ->join('block', 'block.block_id', '=', 'block_setting.block_id') ->where('gedcom_id', '=', $tree->id()) ->delete(); DB::table('block')->where('gedcom_id', '=', $tree->id())->delete(); DB::table('user_gedcom_setting')->where('gedcom_id', '=', $tree->id())->delete(); DB::table('gedcom_setting')->where('gedcom_id', '=', $tree->id())->delete(); DB::table('module_privacy')->where('gedcom_id', '=', $tree->id())->delete(); DB::table('hit_counter')->where('gedcom_id', '=', $tree->id())->delete(); DB::table('default_resn')->where('gedcom_id', '=', $tree->id())->delete(); DB::table('gedcom_chunk')->where('gedcom_id', '=', $tree->id())->delete(); DB::table('log')->where('gedcom_id', '=', $tree->id())->delete(); DB::table('gedcom')->where('gedcom_id', '=', $tree->id())->delete(); } /** * Delete all the genealogy data from a tree - in preparation for importing * new data. Optionally retain the media data, for when the user has been * editing their data offline using an application which deletes (or does not * support) media data. * * @param Tree $tree * @param bool $keep_media * * @return void */ public function deleteGenealogyData(Tree $tree, bool $keep_media): void { DB::table('individuals')->where('i_file', '=', $tree->id())->delete(); DB::table('families')->where('f_file', '=', $tree->id())->delete(); DB::table('sources')->where('s_file', '=', $tree->id())->delete(); DB::table('other')->where('o_file', '=', $tree->id())->delete(); DB::table('places')->where('p_file', '=', $tree->id())->delete(); DB::table('placelinks')->where('pl_file', '=', $tree->id())->delete(); DB::table('name')->where('n_file', '=', $tree->id())->delete(); DB::table('dates')->where('d_file', '=', $tree->id())->delete(); DB::table('change')->where('gedcom_id', '=', $tree->id())->delete(); if ($keep_media) { DB::table('link')->where('l_file', '=', $tree->id()) ->where('l_type', '<>', 'OBJE') ->delete(); } else { DB::table('link')->where('l_file', '=', $tree->id())->delete(); DB::table('media_file')->where('m_file', '=', $tree->id())->delete(); DB::table('media')->where('m_file', '=', $tree->id())->delete(); } } /** * Generate a unique name for a new tree. * * @return string */ public function uniqueTreeName(): string { $name = 'tree'; $number = 1; while ($this->all()->get($name . $number) instanceof Tree) { $number++; } return $name . $number; } }