1a25f0a04SGreg Roach<?php 2a25f0a04SGreg Roach/** 3a25f0a04SGreg Roach * webtrees: online genealogy 4369c0ce6SGreg Roach * Copyright (C) 2016 webtrees development team 5a25f0a04SGreg Roach * This program is free software: you can redistribute it and/or modify 6a25f0a04SGreg Roach * it under the terms of the GNU General Public License as published by 7a25f0a04SGreg Roach * the Free Software Foundation, either version 3 of the License, or 8a25f0a04SGreg Roach * (at your option) any later version. 9a25f0a04SGreg Roach * This program is distributed in the hope that it will be useful, 10a25f0a04SGreg Roach * but WITHOUT ANY WARRANTY; without even the implied warranty of 11a25f0a04SGreg Roach * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12a25f0a04SGreg Roach * GNU General Public License for more details. 13a25f0a04SGreg Roach * You should have received a copy of the GNU General Public License 14a25f0a04SGreg Roach * along with this program. If not, see <http://www.gnu.org/licenses/>. 15a25f0a04SGreg Roach */ 1676692c8bSGreg Roachnamespace Fisharebest\Webtrees; 17a25f0a04SGreg Roach 183d7a8a4cSGreg Roachuse Fisharebest\Webtrees\Functions\FunctionsExport; 193d7a8a4cSGreg Roachuse Fisharebest\Webtrees\Functions\FunctionsImport; 20a25f0a04SGreg Roachuse PDOException; 21a25f0a04SGreg Roach 22a25f0a04SGreg Roach/** 2376692c8bSGreg Roach * Provide an interface to the wt_gedcom table. 24a25f0a04SGreg Roach */ 25a25f0a04SGreg Roachclass Tree { 26cbc1590aSGreg Roach /** @var int The tree's ID number */ 27518bbdc1SGreg Roach private $tree_id; 28518bbdc1SGreg Roach 29a25f0a04SGreg Roach /** @var string The tree's name */ 30a25f0a04SGreg Roach private $name; 31518bbdc1SGreg Roach 32a25f0a04SGreg Roach /** @var string The tree's title */ 33a25f0a04SGreg Roach private $title; 34a25f0a04SGreg Roach 35e2052359SGreg Roach /** @var int[] Default access rules for facts in this tree */ 36518bbdc1SGreg Roach private $fact_privacy; 37518bbdc1SGreg Roach 38e2052359SGreg Roach /** @var int[] Default access rules for individuals in this tree */ 39518bbdc1SGreg Roach private $individual_privacy; 40518bbdc1SGreg Roach 41518bbdc1SGreg Roach /** @var integer[][] Default access rules for individual facts in this tree */ 42518bbdc1SGreg Roach private $individual_fact_privacy; 43518bbdc1SGreg Roach 44a25f0a04SGreg Roach /** @var Tree[] All trees that we have permission to see. */ 45a25f0a04SGreg Roach private static $trees; 46a25f0a04SGreg Roach 47a25f0a04SGreg Roach /** @var string[] Cached copy of the wt_gedcom_setting table. */ 48a25f0a04SGreg Roach private $preferences; 49a25f0a04SGreg Roach 50a25f0a04SGreg Roach /** @var string[][] Cached copy of the wt_user_gedcom_setting table. */ 51*13abd6f3SGreg Roach private $user_preferences = []; 52a25f0a04SGreg Roach 53a25f0a04SGreg Roach /** 54a25f0a04SGreg Roach * Create a tree object. This is a private constructor - it can only 55a25f0a04SGreg Roach * be called from Tree::getAll() to ensure proper initialisation. 56a25f0a04SGreg Roach * 57cbc1590aSGreg Roach * @param int $tree_id 58a25f0a04SGreg Roach * @param string $tree_name 59a25f0a04SGreg Roach * @param string $tree_title 60a25f0a04SGreg Roach */ 61518bbdc1SGreg Roach private function __construct($tree_id, $tree_name, $tree_title) { 62518bbdc1SGreg Roach $this->tree_id = $tree_id; 63a25f0a04SGreg Roach $this->name = $tree_name; 64a25f0a04SGreg Roach $this->title = $tree_title; 65*13abd6f3SGreg Roach $this->fact_privacy = []; 66*13abd6f3SGreg Roach $this->individual_privacy = []; 67*13abd6f3SGreg Roach $this->individual_fact_privacy = []; 68518bbdc1SGreg Roach 69518bbdc1SGreg Roach // Load the privacy settings for this tree 70518bbdc1SGreg Roach $rows = Database::prepare( 71518bbdc1SGreg Roach "SELECT SQL_CACHE xref, tag_type, CASE resn WHEN 'none' THEN :priv_public WHEN 'privacy' THEN :priv_user WHEN 'confidential' THEN :priv_none WHEN 'hidden' THEN :priv_hide END AS resn" . 72518bbdc1SGreg Roach " FROM `##default_resn` WHERE gedcom_id = :tree_id" 73*13abd6f3SGreg Roach )->execute([ 744b9ff166SGreg Roach 'priv_public' => Auth::PRIV_PRIVATE, 754b9ff166SGreg Roach 'priv_user' => Auth::PRIV_USER, 764b9ff166SGreg Roach 'priv_none' => Auth::PRIV_NONE, 774b9ff166SGreg Roach 'priv_hide' => Auth::PRIV_HIDE, 78cbc1590aSGreg Roach 'tree_id' => $this->tree_id, 79*13abd6f3SGreg Roach ])->fetchAll(); 80518bbdc1SGreg Roach 81518bbdc1SGreg Roach foreach ($rows as $row) { 82518bbdc1SGreg Roach if ($row->xref !== null) { 83518bbdc1SGreg Roach if ($row->tag_type !== null) { 84518bbdc1SGreg Roach $this->individual_fact_privacy[$row->xref][$row->tag_type] = (int) $row->resn; 85518bbdc1SGreg Roach } else { 86518bbdc1SGreg Roach $this->individual_privacy[$row->xref] = (int) $row->resn; 87518bbdc1SGreg Roach } 88518bbdc1SGreg Roach } else { 89518bbdc1SGreg Roach $this->fact_privacy[$row->tag_type] = (int) $row->resn; 90518bbdc1SGreg Roach } 91518bbdc1SGreg Roach } 92518bbdc1SGreg Roach 93a25f0a04SGreg Roach } 94a25f0a04SGreg Roach 95a25f0a04SGreg Roach /** 96a25f0a04SGreg Roach * The ID of this tree 97a25f0a04SGreg Roach * 98cbc1590aSGreg Roach * @return int 99a25f0a04SGreg Roach */ 100518bbdc1SGreg Roach public function getTreeId() { 101518bbdc1SGreg Roach return $this->tree_id; 102a25f0a04SGreg Roach } 103a25f0a04SGreg Roach 104a25f0a04SGreg Roach /** 105a25f0a04SGreg Roach * The name of this tree 106a25f0a04SGreg Roach * 107a25f0a04SGreg Roach * @return string 108a25f0a04SGreg Roach */ 109000959d9SGreg Roach public function getName() { 110a25f0a04SGreg Roach return $this->name; 111a25f0a04SGreg Roach } 112a25f0a04SGreg Roach 113a25f0a04SGreg Roach /** 114a25f0a04SGreg Roach * The name of this tree 115a25f0a04SGreg Roach * 116a25f0a04SGreg Roach * @return string 117a25f0a04SGreg Roach */ 118000959d9SGreg Roach public function getNameHtml() { 119a25f0a04SGreg Roach return Filter::escapeHtml($this->name); 120a25f0a04SGreg Roach } 121a25f0a04SGreg Roach 122a25f0a04SGreg Roach /** 123a25f0a04SGreg Roach * The name of this tree 124a25f0a04SGreg Roach * 125a25f0a04SGreg Roach * @return string 126a25f0a04SGreg Roach */ 127000959d9SGreg Roach public function getNameUrl() { 128a25f0a04SGreg Roach return Filter::escapeUrl($this->name); 129a25f0a04SGreg Roach } 130a25f0a04SGreg Roach 131a25f0a04SGreg Roach /** 132a25f0a04SGreg Roach * The title of this tree 133a25f0a04SGreg Roach * 134a25f0a04SGreg Roach * @return string 135a25f0a04SGreg Roach */ 136000959d9SGreg Roach public function getTitle() { 137a25f0a04SGreg Roach return $this->title; 138a25f0a04SGreg Roach } 139a25f0a04SGreg Roach 140a25f0a04SGreg Roach /** 141a25f0a04SGreg Roach * The title of this tree, with HTML markup 142a25f0a04SGreg Roach * 143a25f0a04SGreg Roach * @return string 144a25f0a04SGreg Roach */ 145000959d9SGreg Roach public function getTitleHtml() { 146a77340e1SGreg Roach return '<span dir="auto">' . Filter::escapeHtml($this->title) . '</span>'; 147a25f0a04SGreg Roach } 148a25f0a04SGreg Roach 149a25f0a04SGreg Roach /** 150518bbdc1SGreg Roach * The fact-level privacy for this tree. 151518bbdc1SGreg Roach * 152e2052359SGreg Roach * @return int[] 153518bbdc1SGreg Roach */ 154518bbdc1SGreg Roach public function getFactPrivacy() { 155518bbdc1SGreg Roach return $this->fact_privacy; 156518bbdc1SGreg Roach } 157518bbdc1SGreg Roach 158518bbdc1SGreg Roach /** 159518bbdc1SGreg Roach * The individual-level privacy for this tree. 160518bbdc1SGreg Roach * 161e2052359SGreg Roach * @return int[] 162518bbdc1SGreg Roach */ 163518bbdc1SGreg Roach public function getIndividualPrivacy() { 164518bbdc1SGreg Roach return $this->individual_privacy; 165518bbdc1SGreg Roach } 166518bbdc1SGreg Roach 167518bbdc1SGreg Roach /** 168518bbdc1SGreg Roach * The individual-fact-level privacy for this tree. 169518bbdc1SGreg Roach * 1704f381cf1SGreg Roach * @return integer[][] 171518bbdc1SGreg Roach */ 172518bbdc1SGreg Roach public function getIndividualFactPrivacy() { 173518bbdc1SGreg Roach return $this->individual_fact_privacy; 174518bbdc1SGreg Roach } 175518bbdc1SGreg Roach 176518bbdc1SGreg Roach /** 177a25f0a04SGreg Roach * Get the tree’s configuration settings. 178a25f0a04SGreg Roach * 179a25f0a04SGreg Roach * @param string $setting_name 180a25f0a04SGreg Roach * @param string|null $default 181a25f0a04SGreg Roach * 182a25f0a04SGreg Roach * @return string|null 183a25f0a04SGreg Roach */ 184a25f0a04SGreg Roach public function getPreference($setting_name, $default = null) { 185a25f0a04SGreg Roach if ($this->preferences === null) { 186a25f0a04SGreg Roach $this->preferences = Database::prepare( 187a25f0a04SGreg Roach "SELECT SQL_CACHE setting_name, setting_value FROM `##gedcom_setting` WHERE gedcom_id = ?" 188*13abd6f3SGreg Roach )->execute([$this->tree_id])->fetchAssoc(); 189a25f0a04SGreg Roach } 190a25f0a04SGreg Roach 191a25f0a04SGreg Roach if (array_key_exists($setting_name, $this->preferences)) { 192a25f0a04SGreg Roach return $this->preferences[$setting_name]; 193a25f0a04SGreg Roach } else { 194a25f0a04SGreg Roach return $default; 195a25f0a04SGreg Roach } 196a25f0a04SGreg Roach } 197a25f0a04SGreg Roach 198a25f0a04SGreg Roach /** 199a25f0a04SGreg Roach * Set the tree’s configuration settings. 200a25f0a04SGreg Roach * 201a25f0a04SGreg Roach * @param string $setting_name 202a25f0a04SGreg Roach * @param string $setting_value 203a25f0a04SGreg Roach * 204a25f0a04SGreg Roach * @return $this 205a25f0a04SGreg Roach */ 206a25f0a04SGreg Roach public function setPreference($setting_name, $setting_value) { 207a25f0a04SGreg Roach if ($setting_value !== $this->getPreference($setting_name)) { 208a25f0a04SGreg Roach // Update the database 209a25f0a04SGreg Roach if ($setting_value === null) { 210a25f0a04SGreg Roach Database::prepare( 211a25f0a04SGreg Roach "DELETE FROM `##gedcom_setting` WHERE gedcom_id = :tree_id AND setting_name = :setting_name" 212*13abd6f3SGreg Roach )->execute([ 213518bbdc1SGreg Roach 'tree_id' => $this->tree_id, 214a25f0a04SGreg Roach 'setting_name' => $setting_name, 215*13abd6f3SGreg Roach ]); 216a25f0a04SGreg Roach } else { 217a25f0a04SGreg Roach Database::prepare( 218a25f0a04SGreg Roach "REPLACE INTO `##gedcom_setting` (gedcom_id, setting_name, setting_value)" . 219a25f0a04SGreg Roach " VALUES (:tree_id, :setting_name, LEFT(:setting_value, 255))" 220*13abd6f3SGreg Roach )->execute([ 221518bbdc1SGreg Roach 'tree_id' => $this->tree_id, 222a25f0a04SGreg Roach 'setting_name' => $setting_name, 223a25f0a04SGreg Roach 'setting_value' => $setting_value, 224*13abd6f3SGreg Roach ]); 225a25f0a04SGreg Roach } 226a25f0a04SGreg Roach // Update our cache 227a25f0a04SGreg Roach $this->preferences[$setting_name] = $setting_value; 228a25f0a04SGreg Roach // Audit log of changes 22972292b7dSGreg Roach Log::addConfigurationLog('Tree preference "' . $setting_name . '" set to "' . $setting_value . '"', $this); 230a25f0a04SGreg Roach } 231a25f0a04SGreg Roach 232a25f0a04SGreg Roach return $this; 233a25f0a04SGreg Roach } 234a25f0a04SGreg Roach 235a25f0a04SGreg Roach /** 236a25f0a04SGreg Roach * Get the tree’s user-configuration settings. 237a25f0a04SGreg Roach * 238a25f0a04SGreg Roach * @param User $user 239a25f0a04SGreg Roach * @param string $setting_name 240a25f0a04SGreg Roach * @param string|null $default 241a25f0a04SGreg Roach * 242a25f0a04SGreg Roach * @return string 243a25f0a04SGreg Roach */ 244a25f0a04SGreg Roach public function getUserPreference(User $user, $setting_name, $default = null) { 245a25f0a04SGreg Roach // There are lots of settings, and we need to fetch lots of them on every page 246a25f0a04SGreg Roach // so it is quicker to fetch them all in one go. 247a25f0a04SGreg Roach if (!array_key_exists($user->getUserId(), $this->user_preferences)) { 248a25f0a04SGreg Roach $this->user_preferences[$user->getUserId()] = Database::prepare( 249a25f0a04SGreg Roach "SELECT SQL_CACHE setting_name, setting_value FROM `##user_gedcom_setting` WHERE user_id = ? AND gedcom_id = ?" 250*13abd6f3SGreg Roach )->execute([$user->getUserId(), $this->tree_id])->fetchAssoc(); 251a25f0a04SGreg Roach } 252a25f0a04SGreg Roach 253a25f0a04SGreg Roach if (array_key_exists($setting_name, $this->user_preferences[$user->getUserId()])) { 254a25f0a04SGreg Roach return $this->user_preferences[$user->getUserId()][$setting_name]; 255a25f0a04SGreg Roach } else { 256a25f0a04SGreg Roach return $default; 257a25f0a04SGreg Roach } 258a25f0a04SGreg Roach } 259a25f0a04SGreg Roach 260a25f0a04SGreg Roach /** 261a25f0a04SGreg Roach * Set the tree’s user-configuration settings. 262a25f0a04SGreg Roach * 263a25f0a04SGreg Roach * @param User $user 264a25f0a04SGreg Roach * @param string $setting_name 265a25f0a04SGreg Roach * @param string $setting_value 266a25f0a04SGreg Roach * 267a25f0a04SGreg Roach * @return $this 268a25f0a04SGreg Roach */ 269a25f0a04SGreg Roach public function setUserPreference(User $user, $setting_name, $setting_value) { 270a25f0a04SGreg Roach if ($this->getUserPreference($user, $setting_name) !== $setting_value) { 271a25f0a04SGreg Roach // Update the database 272a25f0a04SGreg Roach if ($setting_value === null) { 273a25f0a04SGreg Roach Database::prepare( 274a25f0a04SGreg Roach "DELETE FROM `##user_gedcom_setting` WHERE gedcom_id = :tree_id AND user_id = :user_id AND setting_name = :setting_name" 275*13abd6f3SGreg Roach )->execute([ 276518bbdc1SGreg Roach 'tree_id' => $this->tree_id, 277a25f0a04SGreg Roach 'user_id' => $user->getUserId(), 278a25f0a04SGreg Roach 'setting_name' => $setting_name, 279*13abd6f3SGreg Roach ]); 280a25f0a04SGreg Roach } else { 281a25f0a04SGreg Roach Database::prepare( 282a25f0a04SGreg Roach "REPLACE INTO `##user_gedcom_setting` (user_id, gedcom_id, setting_name, setting_value) VALUES (:user_id, :tree_id, :setting_name, LEFT(:setting_value, 255))" 283*13abd6f3SGreg Roach )->execute([ 284a25f0a04SGreg Roach 'user_id' => $user->getUserId(), 285518bbdc1SGreg Roach 'tree_id' => $this->tree_id, 286a25f0a04SGreg Roach 'setting_name' => $setting_name, 287cbc1590aSGreg Roach 'setting_value' => $setting_value, 288*13abd6f3SGreg Roach ]); 289a25f0a04SGreg Roach } 290a25f0a04SGreg Roach // Update our cache 291a25f0a04SGreg Roach $this->user_preferences[$user->getUserId()][$setting_name] = $setting_value; 292a25f0a04SGreg Roach // Audit log of changes 29372292b7dSGreg Roach Log::addConfigurationLog('Tree preference "' . $setting_name . '" set to "' . $setting_value . '" for user "' . $user->getUserName() . '"', $this); 294a25f0a04SGreg Roach } 295a25f0a04SGreg Roach 296a25f0a04SGreg Roach return $this; 297a25f0a04SGreg Roach } 298a25f0a04SGreg Roach 299a25f0a04SGreg Roach /** 300a25f0a04SGreg Roach * Can a user accept changes for this tree? 301a25f0a04SGreg Roach * 302a25f0a04SGreg Roach * @param User $user 303a25f0a04SGreg Roach * 304cbc1590aSGreg Roach * @return bool 305a25f0a04SGreg Roach */ 306a25f0a04SGreg Roach public function canAcceptChanges(User $user) { 307a25f0a04SGreg Roach return Auth::isModerator($this, $user); 308a25f0a04SGreg Roach } 309a25f0a04SGreg Roach 310a25f0a04SGreg Roach /** 311a25f0a04SGreg Roach * Fetch all the trees that we have permission to access. 312a25f0a04SGreg Roach * 313a25f0a04SGreg Roach * @return Tree[] 314a25f0a04SGreg Roach */ 315a25f0a04SGreg Roach public static function getAll() { 316a25f0a04SGreg Roach if (self::$trees === null) { 317*13abd6f3SGreg Roach self::$trees = []; 318a25f0a04SGreg Roach $rows = Database::prepare( 319a25f0a04SGreg Roach "SELECT SQL_CACHE g.gedcom_id AS tree_id, g.gedcom_name AS tree_name, gs1.setting_value AS tree_title" . 320a25f0a04SGreg Roach " FROM `##gedcom` g" . 321a25f0a04SGreg Roach " LEFT JOIN `##gedcom_setting` gs1 ON (g.gedcom_id=gs1.gedcom_id AND gs1.setting_name='title')" . 322a25f0a04SGreg Roach " LEFT JOIN `##gedcom_setting` gs2 ON (g.gedcom_id=gs2.gedcom_id AND gs2.setting_name='imported')" . 323a25f0a04SGreg Roach " LEFT JOIN `##gedcom_setting` gs3 ON (g.gedcom_id=gs3.gedcom_id AND gs3.setting_name='REQUIRE_AUTHENTICATION')" . 324a25f0a04SGreg Roach " LEFT JOIN `##user_gedcom_setting` ugs ON (g.gedcom_id=ugs.gedcom_id AND ugs.setting_name='canedit' AND ugs.user_id=?)" . 325a25f0a04SGreg Roach " WHERE " . 326a25f0a04SGreg Roach " g.gedcom_id>0 AND (" . // exclude the "template" tree 327a25f0a04SGreg Roach " EXISTS (SELECT 1 FROM `##user_setting` WHERE user_id=? AND setting_name='canadmin' AND setting_value=1)" . // Admin sees all 328a25f0a04SGreg Roach " ) OR (" . 3298cca4ddeSGreg Roach " (gs2.setting_value = 1 OR ugs.setting_value = 'admin') AND (" . // Allow imported trees, with either: 330a25f0a04SGreg Roach " gs3.setting_value <> 1 OR" . // visitor access 331a25f0a04SGreg Roach " IFNULL(ugs.setting_value, 'none')<>'none'" . // explicit access 332a25f0a04SGreg Roach " )" . 333a25f0a04SGreg Roach " )" . 334a25f0a04SGreg Roach " ORDER BY g.sort_order, 3" 335*13abd6f3SGreg Roach )->execute([Auth::id(), Auth::id()])->fetchAll(); 336a25f0a04SGreg Roach foreach ($rows as $row) { 33709c6c661SGreg Roach self::$trees[] = new self((int) $row->tree_id, $row->tree_name, $row->tree_title); 338a25f0a04SGreg Roach } 339a25f0a04SGreg Roach } 340a25f0a04SGreg Roach 341a25f0a04SGreg Roach return self::$trees; 342a25f0a04SGreg Roach } 343a25f0a04SGreg Roach 344a25f0a04SGreg Roach /** 345d2cdeb3fSGreg Roach * Find the tree with a specific ID. 346a25f0a04SGreg Roach * 347cbc1590aSGreg Roach * @param int $tree_id 348cbc1590aSGreg Roach * 349cbc1590aSGreg Roach * @throws \DomainException 350a25f0a04SGreg Roach * 351a25f0a04SGreg Roach * @return Tree 352a25f0a04SGreg Roach */ 353d2cdeb3fSGreg Roach public static function findById($tree_id) { 35451d0f842SGreg Roach foreach (self::getAll() as $tree) { 355e568acceSGreg Roach if ($tree->tree_id == $tree_id) { 35651d0f842SGreg Roach return $tree; 35751d0f842SGreg Roach } 35851d0f842SGreg Roach } 35951d0f842SGreg Roach throw new \DomainException; 360a25f0a04SGreg Roach } 361a25f0a04SGreg Roach 362a25f0a04SGreg Roach /** 363d2cdeb3fSGreg Roach * Find the tree with a specific name. 364cf4bcc09SGreg Roach * 365cf4bcc09SGreg Roach * @param string $tree_name 366cf4bcc09SGreg Roach * 367cf4bcc09SGreg Roach * @return Tree|null 368cf4bcc09SGreg Roach */ 369cf4bcc09SGreg Roach public static function findByName($tree_name) { 370cf4bcc09SGreg Roach foreach (self::getAll() as $tree) { 37151d0f842SGreg Roach if ($tree->name === $tree_name) { 372cf4bcc09SGreg Roach return $tree; 373cf4bcc09SGreg Roach } 374cf4bcc09SGreg Roach } 375cf4bcc09SGreg Roach 376cf4bcc09SGreg Roach return null; 377cf4bcc09SGreg Roach } 378cf4bcc09SGreg Roach 379cf4bcc09SGreg Roach /** 380a25f0a04SGreg Roach * Create arguments to select_edit_control() 381a25f0a04SGreg Roach * Note - these will be escaped later 382a25f0a04SGreg Roach * 383a25f0a04SGreg Roach * @return string[] 384a25f0a04SGreg Roach */ 385a25f0a04SGreg Roach public static function getIdList() { 386*13abd6f3SGreg Roach $list = []; 387a25f0a04SGreg Roach foreach (self::getAll() as $tree) { 388518bbdc1SGreg Roach $list[$tree->tree_id] = $tree->title; 389a25f0a04SGreg Roach } 390a25f0a04SGreg Roach 391a25f0a04SGreg Roach return $list; 392a25f0a04SGreg Roach } 393a25f0a04SGreg Roach 394a25f0a04SGreg Roach /** 395a25f0a04SGreg Roach * Create arguments to select_edit_control() 396a25f0a04SGreg Roach * Note - these will be escaped later 397a25f0a04SGreg Roach * 398a25f0a04SGreg Roach * @return string[] 399a25f0a04SGreg Roach */ 400a25f0a04SGreg Roach public static function getNameList() { 401*13abd6f3SGreg Roach $list = []; 402a25f0a04SGreg Roach foreach (self::getAll() as $tree) { 403a25f0a04SGreg Roach $list[$tree->name] = $tree->title; 404a25f0a04SGreg Roach } 405a25f0a04SGreg Roach 406a25f0a04SGreg Roach return $list; 407a25f0a04SGreg Roach } 408a25f0a04SGreg Roach 409a25f0a04SGreg Roach /** 410a25f0a04SGreg Roach * Create a new tree 411a25f0a04SGreg Roach * 412a25f0a04SGreg Roach * @param string $tree_name 413a25f0a04SGreg Roach * @param string $tree_title 414a25f0a04SGreg Roach * 415a25f0a04SGreg Roach * @return Tree 416a25f0a04SGreg Roach */ 417a25f0a04SGreg Roach public static function create($tree_name, $tree_title) { 418a25f0a04SGreg Roach try { 419a25f0a04SGreg Roach // Create a new tree 420a25f0a04SGreg Roach Database::prepare( 421a25f0a04SGreg Roach "INSERT INTO `##gedcom` (gedcom_name) VALUES (?)" 422*13abd6f3SGreg Roach )->execute([$tree_name]); 423a25f0a04SGreg Roach $tree_id = Database::prepare("SELECT LAST_INSERT_ID()")->fetchOne(); 424a25f0a04SGreg Roach } catch (PDOException $ex) { 425a25f0a04SGreg Roach // A tree with that name already exists? 426ef2fd529SGreg Roach return self::findByName($tree_name); 427a25f0a04SGreg Roach } 428a25f0a04SGreg Roach 429a25f0a04SGreg Roach // Update the list of trees - to include this new one 430a25f0a04SGreg Roach self::$trees = null; 431d2cdeb3fSGreg Roach $tree = self::findById($tree_id); 432a25f0a04SGreg Roach 433a25f0a04SGreg Roach $tree->setPreference('imported', '0'); 434a25f0a04SGreg Roach $tree->setPreference('title', $tree_title); 435a25f0a04SGreg Roach 436a25f0a04SGreg Roach // Module privacy 437a25f0a04SGreg Roach Module::setDefaultAccess($tree_id); 438a25f0a04SGreg Roach 4391507cbcaSGreg Roach // Set preferences from default tree 4401507cbcaSGreg Roach Database::prepare( 4411507cbcaSGreg Roach "INSERT INTO `##gedcom_setting` (gedcom_id, setting_name, setting_value)" . 4421507cbcaSGreg Roach " SELECT :tree_id, setting_name, setting_value" . 4431507cbcaSGreg Roach " FROM `##gedcom_setting` WHERE gedcom_id = -1" 444*13abd6f3SGreg Roach )->execute([ 4451507cbcaSGreg Roach 'tree_id' => $tree_id, 446*13abd6f3SGreg Roach ]); 4471507cbcaSGreg Roach 4481507cbcaSGreg Roach Database::prepare( 4491507cbcaSGreg Roach "INSERT INTO `##default_resn` (gedcom_id, tag_type, resn)" . 4501507cbcaSGreg Roach " SELECT :tree_id, tag_type, resn" . 4511507cbcaSGreg Roach " FROM `##default_resn` WHERE gedcom_id = -1" 452*13abd6f3SGreg Roach )->execute([ 4531507cbcaSGreg Roach 'tree_id' => $tree_id, 454*13abd6f3SGreg Roach ]); 4551507cbcaSGreg Roach 4561507cbcaSGreg Roach Database::prepare( 4571507cbcaSGreg Roach "INSERT INTO `##block` (gedcom_id, location, block_order, module_name)" . 4581507cbcaSGreg Roach " SELECT :tree_id, location, block_order, module_name" . 4591507cbcaSGreg Roach " FROM `##block` WHERE gedcom_id = -1" 460*13abd6f3SGreg Roach )->execute([ 4611507cbcaSGreg Roach 'tree_id' => $tree_id, 462*13abd6f3SGreg Roach ]); 4631507cbcaSGreg Roach 464a25f0a04SGreg Roach // Gedcom and privacy settings 465a25f0a04SGreg Roach $tree->setPreference('CONTACT_USER_ID', Auth::id()); 4661507cbcaSGreg Roach $tree->setPreference('WEBMASTER_USER_ID', Auth::id()); 467a25f0a04SGreg Roach $tree->setPreference('LANGUAGE', WT_LOCALE); // Default to the current admin’s language 468a25f0a04SGreg Roach switch (WT_LOCALE) { 469a25f0a04SGreg Roach case 'es': 470a25f0a04SGreg Roach $tree->setPreference('SURNAME_TRADITION', 'spanish'); 471a25f0a04SGreg Roach break; 472a25f0a04SGreg Roach case 'is': 473a25f0a04SGreg Roach $tree->setPreference('SURNAME_TRADITION', 'icelandic'); 474a25f0a04SGreg Roach break; 475a25f0a04SGreg Roach case 'lt': 476a25f0a04SGreg Roach $tree->setPreference('SURNAME_TRADITION', 'lithuanian'); 477a25f0a04SGreg Roach break; 478a25f0a04SGreg Roach case 'pl': 479a25f0a04SGreg Roach $tree->setPreference('SURNAME_TRADITION', 'polish'); 480a25f0a04SGreg Roach break; 481a25f0a04SGreg Roach case 'pt': 482a25f0a04SGreg Roach case 'pt-BR': 483a25f0a04SGreg Roach $tree->setPreference('SURNAME_TRADITION', 'portuguese'); 484a25f0a04SGreg Roach break; 485a25f0a04SGreg Roach default: 486a25f0a04SGreg Roach $tree->setPreference('SURNAME_TRADITION', 'paternal'); 487a25f0a04SGreg Roach break; 488a25f0a04SGreg Roach } 489a25f0a04SGreg Roach 490a25f0a04SGreg Roach // Genealogy data 491a25f0a04SGreg Roach // It is simpler to create a temporary/unimported GEDCOM than to populate all the tables... 492a25f0a04SGreg Roach $john_doe = /* I18N: This should be a common/default/placeholder name of an individual. Put slashes around the surname. */ 493a25f0a04SGreg Roach I18N::translate('John /DOE/'); 49477e70a22SGreg Roach $note = I18N::translate('Edit this individual and replace their details with your own.'); 495*13abd6f3SGreg Roach Database::prepare("INSERT INTO `##gedcom_chunk` (gedcom_id, chunk_data) VALUES (?, ?)")->execute([ 496a25f0a04SGreg Roach $tree_id, 497cbc1590aSGreg Roach "0 HEAD\n1 CHAR UTF-8\n0 @I1@ INDI\n1 NAME {$john_doe}\n1 SEX M\n1 BIRT\n2 DATE 01 JAN 1850\n2 NOTE {$note}\n0 TRLR\n", 498*13abd6f3SGreg Roach ]); 499a25f0a04SGreg Roach 500a25f0a04SGreg Roach // Update our cache 501518bbdc1SGreg Roach self::$trees[$tree->tree_id] = $tree; 502a25f0a04SGreg Roach 503a25f0a04SGreg Roach return $tree; 504a25f0a04SGreg Roach } 505a25f0a04SGreg Roach 506a25f0a04SGreg Roach /** 507b78374c5SGreg Roach * Are there any pending edits for this tree, than need reviewing by a moderator. 508b78374c5SGreg Roach * 509b78374c5SGreg Roach * @return bool 510b78374c5SGreg Roach */ 511b78374c5SGreg Roach public function hasPendingEdit() { 512b78374c5SGreg Roach return (bool) Database::prepare( 513b78374c5SGreg Roach "SELECT 1 FROM `##change` WHERE status = 'pending' AND gedcom_id = :tree_id" 514*13abd6f3SGreg Roach )->execute([ 515cbc1590aSGreg Roach 'tree_id' => $this->tree_id, 516*13abd6f3SGreg Roach ])->fetchOne(); 517b78374c5SGreg Roach } 518b78374c5SGreg Roach 519b78374c5SGreg Roach /** 520a25f0a04SGreg Roach * Delete all the genealogy data from a tree - in preparation for importing 521a25f0a04SGreg Roach * new data. Optionally retain the media data, for when the user has been 522a25f0a04SGreg Roach * editing their data offline using an application which deletes (or does not 523a25f0a04SGreg Roach * support) media data. 524a25f0a04SGreg Roach * 525a25f0a04SGreg Roach * @param bool $keep_media 526a25f0a04SGreg Roach */ 527a25f0a04SGreg Roach public function deleteGenealogyData($keep_media) { 528*13abd6f3SGreg Roach Database::prepare("DELETE FROM `##gedcom_chunk` WHERE gedcom_id = ?")->execute([$this->tree_id]); 529*13abd6f3SGreg Roach Database::prepare("DELETE FROM `##individuals` WHERE i_file = ?")->execute([$this->tree_id]); 530*13abd6f3SGreg Roach Database::prepare("DELETE FROM `##families` WHERE f_file = ?")->execute([$this->tree_id]); 531*13abd6f3SGreg Roach Database::prepare("DELETE FROM `##sources` WHERE s_file = ?")->execute([$this->tree_id]); 532*13abd6f3SGreg Roach Database::prepare("DELETE FROM `##other` WHERE o_file = ?")->execute([$this->tree_id]); 533*13abd6f3SGreg Roach Database::prepare("DELETE FROM `##places` WHERE p_file = ?")->execute([$this->tree_id]); 534*13abd6f3SGreg Roach Database::prepare("DELETE FROM `##placelinks` WHERE pl_file = ?")->execute([$this->tree_id]); 535*13abd6f3SGreg Roach Database::prepare("DELETE FROM `##name` WHERE n_file = ?")->execute([$this->tree_id]); 536*13abd6f3SGreg Roach Database::prepare("DELETE FROM `##dates` WHERE d_file = ?")->execute([$this->tree_id]); 537*13abd6f3SGreg Roach Database::prepare("DELETE FROM `##change` WHERE gedcom_id = ?")->execute([$this->tree_id]); 538a25f0a04SGreg Roach 539a25f0a04SGreg Roach if ($keep_media) { 540*13abd6f3SGreg Roach Database::prepare("DELETE FROM `##link` WHERE l_file =? AND l_type<>'OBJE'")->execute([$this->tree_id]); 541a25f0a04SGreg Roach } else { 542*13abd6f3SGreg Roach Database::prepare("DELETE FROM `##link` WHERE l_file =?")->execute([$this->tree_id]); 543*13abd6f3SGreg Roach Database::prepare("DELETE FROM `##media` WHERE m_file =?")->execute([$this->tree_id]); 544a25f0a04SGreg Roach } 545a25f0a04SGreg Roach } 546a25f0a04SGreg Roach 547a25f0a04SGreg Roach /** 548a25f0a04SGreg Roach * Delete everything relating to a tree 549a25f0a04SGreg Roach */ 550a25f0a04SGreg Roach public function delete() { 551a25f0a04SGreg Roach // If this is the default tree, then unset it 552ef2fd529SGreg Roach if (Site::getPreference('DEFAULT_GEDCOM') === $this->name) { 553a25f0a04SGreg Roach Site::setPreference('DEFAULT_GEDCOM', ''); 554a25f0a04SGreg Roach } 555a25f0a04SGreg Roach 556a25f0a04SGreg Roach $this->deleteGenealogyData(false); 557a25f0a04SGreg Roach 558*13abd6f3SGreg Roach Database::prepare("DELETE `##block_setting` FROM `##block_setting` JOIN `##block` USING (block_id) WHERE gedcom_id=?")->execute([$this->tree_id]); 559*13abd6f3SGreg Roach Database::prepare("DELETE FROM `##block` WHERE gedcom_id = ?")->execute([$this->tree_id]); 560*13abd6f3SGreg Roach Database::prepare("DELETE FROM `##user_gedcom_setting` WHERE gedcom_id = ?")->execute([$this->tree_id]); 561*13abd6f3SGreg Roach Database::prepare("DELETE FROM `##gedcom_setting` WHERE gedcom_id = ?")->execute([$this->tree_id]); 562*13abd6f3SGreg Roach Database::prepare("DELETE FROM `##module_privacy` WHERE gedcom_id = ?")->execute([$this->tree_id]); 563*13abd6f3SGreg Roach Database::prepare("DELETE FROM `##next_id` WHERE gedcom_id = ?")->execute([$this->tree_id]); 564*13abd6f3SGreg Roach Database::prepare("DELETE FROM `##hit_counter` WHERE gedcom_id = ?")->execute([$this->tree_id]); 565*13abd6f3SGreg Roach Database::prepare("DELETE FROM `##default_resn` WHERE gedcom_id = ?")->execute([$this->tree_id]); 566*13abd6f3SGreg Roach Database::prepare("DELETE FROM `##gedcom_chunk` WHERE gedcom_id = ?")->execute([$this->tree_id]); 567*13abd6f3SGreg Roach Database::prepare("DELETE FROM `##log` WHERE gedcom_id = ?")->execute([$this->tree_id]); 568*13abd6f3SGreg Roach Database::prepare("DELETE FROM `##gedcom` WHERE gedcom_id = ?")->execute([$this->tree_id]); 569a25f0a04SGreg Roach 570a25f0a04SGreg Roach // After updating the database, we need to fetch a new (sorted) copy 571a25f0a04SGreg Roach self::$trees = null; 572a25f0a04SGreg Roach } 573a25f0a04SGreg Roach 574a25f0a04SGreg Roach /** 575a25f0a04SGreg Roach * Export the tree to a GEDCOM file 576a25f0a04SGreg Roach * 5775792757eSGreg Roach * @param resource $stream 578a25f0a04SGreg Roach */ 5795792757eSGreg Roach public function exportGedcom($stream) { 5805792757eSGreg Roach $stmt = Database::prepare( 581e56ef01aSGreg Roach "SELECT i_gedcom AS gedcom, i_id AS xref, 1 AS n FROM `##individuals` WHERE i_file = :tree_id_1" . 5825792757eSGreg Roach " UNION ALL " . 583e56ef01aSGreg Roach "SELECT f_gedcom AS gedcom, f_id AS xref, 2 AS n FROM `##families` WHERE f_file = :tree_id_2" . 5845792757eSGreg Roach " UNION ALL " . 585e56ef01aSGreg Roach "SELECT s_gedcom AS gedcom, s_id AS xref, 3 AS n FROM `##sources` WHERE s_file = :tree_id_3" . 5865792757eSGreg Roach " UNION ALL " . 587e56ef01aSGreg Roach "SELECT o_gedcom AS gedcom, o_id AS xref, 4 AS n FROM `##other` WHERE o_file = :tree_id_4 AND o_type NOT IN ('HEAD', 'TRLR')" . 5885792757eSGreg Roach " UNION ALL " . 589e56ef01aSGreg Roach "SELECT m_gedcom AS gedcom, m_id AS xref, 5 AS n FROM `##media` WHERE m_file = :tree_id_5" . 590e56ef01aSGreg Roach " ORDER BY n, LENGTH(xref), xref" 591*13abd6f3SGreg Roach )->execute([ 5925792757eSGreg Roach 'tree_id_1' => $this->tree_id, 5935792757eSGreg Roach 'tree_id_2' => $this->tree_id, 5945792757eSGreg Roach 'tree_id_3' => $this->tree_id, 5955792757eSGreg Roach 'tree_id_4' => $this->tree_id, 596cbc1590aSGreg Roach 'tree_id_5' => $this->tree_id, 597*13abd6f3SGreg Roach ]); 598a25f0a04SGreg Roach 5993d7a8a4cSGreg Roach $buffer = FunctionsExport::reformatRecord(FunctionsExport::gedcomHeader($this)); 600a25f0a04SGreg Roach while ($row = $stmt->fetch()) { 6013d7a8a4cSGreg Roach $buffer .= FunctionsExport::reformatRecord($row->gedcom); 602a25f0a04SGreg Roach if (strlen($buffer) > 65535) { 6035792757eSGreg Roach fwrite($stream, $buffer); 604a25f0a04SGreg Roach $buffer = ''; 605a25f0a04SGreg Roach } 606a25f0a04SGreg Roach } 6075792757eSGreg Roach fwrite($stream, $buffer . '0 TRLR' . WT_EOL); 608195d09d8SGreg Roach $stmt->closeCursor(); 609a25f0a04SGreg Roach } 610a25f0a04SGreg Roach 611a25f0a04SGreg Roach /** 612a25f0a04SGreg Roach * Import data from a gedcom file into this tree. 613a25f0a04SGreg Roach * 614a25f0a04SGreg Roach * @param string $path The full path to the (possibly temporary) file. 615a25f0a04SGreg Roach * @param string $filename The preferred filename, for export/download. 616a25f0a04SGreg Roach * 617a25f0a04SGreg Roach * @throws \Exception 618a25f0a04SGreg Roach */ 619ed1bbedbSGreg Roach public function importGedcomFile($path, $filename) { 620a25f0a04SGreg Roach // Read the file in blocks of roughly 64K. Ensure that each block 621a25f0a04SGreg Roach // contains complete gedcom records. This will ensure we don’t split 622a25f0a04SGreg Roach // multi-byte characters, as well as simplifying the code to import 623a25f0a04SGreg Roach // each block. 624a25f0a04SGreg Roach 625a25f0a04SGreg Roach $file_data = ''; 626a25f0a04SGreg Roach $fp = fopen($path, 'rb'); 627a25f0a04SGreg Roach 628a25f0a04SGreg Roach // Don’t allow the user to cancel the request. We do not want to be left with an incomplete transaction. 629a25f0a04SGreg Roach ignore_user_abort(true); 630a25f0a04SGreg Roach 631a25f0a04SGreg Roach Database::beginTransaction(); 632ed1bbedbSGreg Roach $this->deleteGenealogyData($this->getPreference('keep_media')); 633a25f0a04SGreg Roach $this->setPreference('gedcom_filename', $filename); 634a25f0a04SGreg Roach $this->setPreference('imported', '0'); 635a25f0a04SGreg Roach 636a25f0a04SGreg Roach while (!feof($fp)) { 637a25f0a04SGreg Roach $file_data .= fread($fp, 65536); 638a25f0a04SGreg Roach // There is no strrpos() function that searches for substrings :-( 639a25f0a04SGreg Roach for ($pos = strlen($file_data) - 1; $pos > 0; --$pos) { 640a25f0a04SGreg Roach if ($file_data[$pos] === '0' && ($file_data[$pos - 1] === "\n" || $file_data[$pos - 1] === "\r")) { 641a25f0a04SGreg Roach // We’ve found the last record boundary in this chunk of data 642a25f0a04SGreg Roach break; 643a25f0a04SGreg Roach } 644a25f0a04SGreg Roach } 645a25f0a04SGreg Roach if ($pos) { 646a25f0a04SGreg Roach Database::prepare( 647a25f0a04SGreg Roach "INSERT INTO `##gedcom_chunk` (gedcom_id, chunk_data) VALUES (?, ?)" 648*13abd6f3SGreg Roach )->execute([$this->tree_id, substr($file_data, 0, $pos)]); 649a25f0a04SGreg Roach $file_data = substr($file_data, $pos); 650a25f0a04SGreg Roach } 651a25f0a04SGreg Roach } 652a25f0a04SGreg Roach Database::prepare( 653a25f0a04SGreg Roach "INSERT INTO `##gedcom_chunk` (gedcom_id, chunk_data) VALUES (?, ?)" 654*13abd6f3SGreg Roach )->execute([$this->tree_id, $file_data]); 655a25f0a04SGreg Roach 656a25f0a04SGreg Roach Database::commit(); 657a25f0a04SGreg Roach fclose($fp); 658a25f0a04SGreg Roach } 659304f20d5SGreg Roach 660304f20d5SGreg Roach /** 661b90d8accSGreg Roach * Generate a new XREF, unique across all family trees 662b90d8accSGreg Roach * 663b90d8accSGreg Roach * @param string $type 664b90d8accSGreg Roach * 665b90d8accSGreg Roach * @return string 666b90d8accSGreg Roach */ 6670fb1a955SGreg Roach public function getNewXref($type = 'INDI') { 668b90d8accSGreg Roach /** @var string[] Which tree preference is used for which record type */ 669*13abd6f3SGreg Roach static $type_to_preference = [ 670b90d8accSGreg Roach 'INDI' => 'GEDCOM_ID_PREFIX', 671b90d8accSGreg Roach 'FAM' => 'FAM_ID_PREFIX', 672b90d8accSGreg Roach 'OBJE' => 'MEDIA_ID_PREFIX', 673b90d8accSGreg Roach 'NOTE' => 'NOTE_ID_PREFIX', 674b90d8accSGreg Roach 'SOUR' => 'SOURCE_ID_PREFIX', 675b90d8accSGreg Roach 'REPO' => 'REPO_ID_PREFIX', 676*13abd6f3SGreg Roach ]; 677b90d8accSGreg Roach 678b90d8accSGreg Roach if (array_key_exists($type, $type_to_preference)) { 679b90d8accSGreg Roach $prefix = $this->getPreference($type_to_preference[$type]); 680b90d8accSGreg Roach } else { 681b90d8accSGreg Roach // Use the first non-underscore character 682b90d8accSGreg Roach $prefix = substr(trim($type, '_'), 0, 1); 683b90d8accSGreg Roach } 684b90d8accSGreg Roach 685971d66c8SGreg Roach $increment = 1.0; 686b90d8accSGreg Roach do { 687b90d8accSGreg Roach // Use LAST_INSERT_ID(expr) to provide a transaction-safe sequence. See 688b90d8accSGreg Roach // http://dev.mysql.com/doc/refman/5.6/en/information-functions.html#function_last-insert-id 689b90d8accSGreg Roach $statement = Database::prepare( 690971d66c8SGreg Roach "UPDATE `##next_id` SET next_id = LAST_INSERT_ID(next_id + :increment) WHERE record_type = :record_type AND gedcom_id = :tree_id" 691b90d8accSGreg Roach ); 692*13abd6f3SGreg Roach $statement->execute([ 693971d66c8SGreg Roach 'increment' => (int) $increment, 694b90d8accSGreg Roach 'record_type' => $type, 695bb7c2cdcSGreg Roach 'tree_id' => $this->tree_id, 696*13abd6f3SGreg Roach ]); 697b90d8accSGreg Roach 698b90d8accSGreg Roach if ($statement->rowCount() === 0) { 699b90d8accSGreg Roach // First time we've used this record type. 700b90d8accSGreg Roach Database::prepare( 701b90d8accSGreg Roach "INSERT INTO `##next_id` (gedcom_id, record_type, next_id) VALUES(:tree_id, :record_type, 1)" 702*13abd6f3SGreg Roach )->execute([ 703b90d8accSGreg Roach 'record_type' => $type, 704bb7c2cdcSGreg Roach 'tree_id' => $this->tree_id, 705*13abd6f3SGreg Roach ]); 706b90d8accSGreg Roach $num = 1; 707b90d8accSGreg Roach } else { 708b90d8accSGreg Roach $num = Database::prepare("SELECT LAST_INSERT_ID()")->fetchOne(); 709b90d8accSGreg Roach } 710b90d8accSGreg Roach 711b90d8accSGreg Roach // Records may already exist with this sequence number. 712b90d8accSGreg Roach $already_used = Database::prepare( 713b90d8accSGreg Roach "SELECT i_id FROM `##individuals` WHERE i_id = :i_id" . 714b90d8accSGreg Roach " UNION ALL " . 715b90d8accSGreg Roach "SELECT f_id FROM `##families` WHERE f_id = :f_id" . 716b90d8accSGreg Roach " UNION ALL " . 717b90d8accSGreg Roach "SELECT s_id FROM `##sources` WHERE s_id = :s_id" . 718b90d8accSGreg Roach " UNION ALL " . 719b90d8accSGreg Roach "SELECT m_id FROM `##media` WHERE m_id = :m_id" . 720b90d8accSGreg Roach " UNION ALL " . 721b90d8accSGreg Roach "SELECT o_id FROM `##other` WHERE o_id = :o_id" . 722b90d8accSGreg Roach " UNION ALL " . 723b90d8accSGreg Roach "SELECT xref FROM `##change` WHERE xref = :xref" 724*13abd6f3SGreg Roach )->execute([ 725b90d8accSGreg Roach 'i_id' => $prefix . $num, 726b90d8accSGreg Roach 'f_id' => $prefix . $num, 727b90d8accSGreg Roach 's_id' => $prefix . $num, 728b90d8accSGreg Roach 'm_id' => $prefix . $num, 729b90d8accSGreg Roach 'o_id' => $prefix . $num, 730b90d8accSGreg Roach 'xref' => $prefix . $num, 731*13abd6f3SGreg Roach ])->fetchOne(); 732971d66c8SGreg Roach 733971d66c8SGreg Roach // This exponential increment allows us to scan over large blocks of 734971d66c8SGreg Roach // existing data in a reasonable time. 735971d66c8SGreg Roach $increment *= 1.01; 736b90d8accSGreg Roach } while ($already_used); 737b90d8accSGreg Roach 738b90d8accSGreg Roach return $prefix . $num; 739b90d8accSGreg Roach } 740b90d8accSGreg Roach 741b90d8accSGreg Roach /** 742304f20d5SGreg Roach * Create a new record from GEDCOM data. 743304f20d5SGreg Roach * 744304f20d5SGreg Roach * @param string $gedcom 745304f20d5SGreg Roach * 746304f20d5SGreg Roach * @throws \Exception 747cbc1590aSGreg Roach * 748cbc1590aSGreg Roach * @return GedcomRecord 749304f20d5SGreg Roach */ 750304f20d5SGreg Roach public function createRecord($gedcom) { 751304f20d5SGreg Roach if (preg_match('/^0 @(' . WT_REGEX_XREF . ')@ (' . WT_REGEX_TAG . ')/', $gedcom, $match)) { 752304f20d5SGreg Roach $xref = $match[1]; 753304f20d5SGreg Roach $type = $match[2]; 754304f20d5SGreg Roach } else { 755304f20d5SGreg Roach throw new \Exception('Invalid argument to GedcomRecord::createRecord(' . $gedcom . ')'); 756304f20d5SGreg Roach } 757304f20d5SGreg Roach if (strpos("\r", $gedcom) !== false) { 758304f20d5SGreg Roach // MSDOS line endings will break things in horrible ways 759304f20d5SGreg Roach throw new \Exception('Evil line endings found in GedcomRecord::createRecord(' . $gedcom . ')'); 760304f20d5SGreg Roach } 761304f20d5SGreg Roach 762304f20d5SGreg Roach // webtrees creates XREFs containing digits. Anything else (e.g. “new”) is just a placeholder. 763304f20d5SGreg Roach if (!preg_match('/\d/', $xref)) { 764b90d8accSGreg Roach $xref = $this->getNewXref($type); 765304f20d5SGreg Roach $gedcom = preg_replace('/^0 @(' . WT_REGEX_XREF . ')@/', '0 @' . $xref . '@', $gedcom); 766304f20d5SGreg Roach } 767304f20d5SGreg Roach 768304f20d5SGreg Roach // Create a change record, if not already present 769304f20d5SGreg Roach if (!preg_match('/\n1 CHAN/', $gedcom)) { 770304f20d5SGreg Roach $gedcom .= "\n1 CHAN\n2 DATE " . date('d M Y') . "\n3 TIME " . date('H:i:s') . "\n2 _WT_USER " . Auth::user()->getUserName(); 771304f20d5SGreg Roach } 772304f20d5SGreg Roach 773304f20d5SGreg Roach // Create a pending change 774304f20d5SGreg Roach Database::prepare( 775304f20d5SGreg Roach "INSERT INTO `##change` (gedcom_id, xref, old_gedcom, new_gedcom, user_id) VALUES (?, ?, '', ?, ?)" 776*13abd6f3SGreg Roach )->execute([ 777bb7c2cdcSGreg Roach $this->tree_id, 778304f20d5SGreg Roach $xref, 779304f20d5SGreg Roach $gedcom, 780cbc1590aSGreg Roach Auth::id(), 781*13abd6f3SGreg Roach ]); 782304f20d5SGreg Roach 783304f20d5SGreg Roach Log::addEditLog('Create: ' . $type . ' ' . $xref); 784304f20d5SGreg Roach 785304f20d5SGreg Roach // Accept this pending change 786304f20d5SGreg Roach if (Auth::user()->getPreference('auto_accept')) { 7873d7a8a4cSGreg Roach FunctionsImport::acceptAllChanges($xref, $this->tree_id); 788304f20d5SGreg Roach } 789bb7c2cdcSGreg Roach // Return the newly created record. Note that since GedcomRecord 790bb7c2cdcSGreg Roach // has a cache of pending changes, we cannot use it to create a 791bb7c2cdcSGreg Roach // record with a newly created pending change. 79224ec66ceSGreg Roach return GedcomRecord::getInstance($xref, $this, $gedcom); 793304f20d5SGreg Roach } 794a25f0a04SGreg Roach} 795