1<?php 2/** 3 * webtrees: online genealogy 4 * Copyright (C) 2017 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 */ 16namespace Fisharebest\Webtrees; 17 18use Fisharebest\Webtrees\Functions\FunctionsExport; 19use Fisharebest\Webtrees\Functions\FunctionsImport; 20use PDOException; 21 22/** 23 * Provide an interface to the wt_gedcom table. 24 */ 25class Tree { 26 /** @var int The tree's ID number */ 27 private $tree_id; 28 29 /** @var string The tree's name */ 30 private $name; 31 32 /** @var string The tree's title */ 33 private $title; 34 35 /** @var int[] Default access rules for facts in this tree */ 36 private $fact_privacy; 37 38 /** @var int[] Default access rules for individuals in this tree */ 39 private $individual_privacy; 40 41 /** @var integer[][] Default access rules for individual facts in this tree */ 42 private $individual_fact_privacy; 43 44 /** @var Tree[] All trees that we have permission to see. */ 45 private static $trees; 46 47 /** @var string[] Cached copy of the wt_gedcom_setting table. */ 48 private $preferences = []; 49 50 /** @var string[][] Cached copy of the wt_user_gedcom_setting table. */ 51 private $user_preferences = []; 52 53 /** 54 * Create a tree object. This is a private constructor - it can only 55 * be called from Tree::getAll() to ensure proper initialisation. 56 * 57 * @param int $tree_id 58 * @param string $tree_name 59 * @param string $tree_title 60 */ 61 private function __construct($tree_id, $tree_name, $tree_title) { 62 $this->tree_id = $tree_id; 63 $this->name = $tree_name; 64 $this->title = $tree_title; 65 $this->fact_privacy = []; 66 $this->individual_privacy = []; 67 $this->individual_fact_privacy = []; 68 69 // Load the privacy settings for this tree 70 $rows = Database::prepare( 71 "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" . 72 " FROM `##default_resn` WHERE gedcom_id = :tree_id" 73 )->execute([ 74 'priv_public' => Auth::PRIV_PRIVATE, 75 'priv_user' => Auth::PRIV_USER, 76 'priv_none' => Auth::PRIV_NONE, 77 'priv_hide' => Auth::PRIV_HIDE, 78 'tree_id' => $this->tree_id, 79 ])->fetchAll(); 80 81 foreach ($rows as $row) { 82 if ($row->xref !== null) { 83 if ($row->tag_type !== null) { 84 $this->individual_fact_privacy[$row->xref][$row->tag_type] = (int) $row->resn; 85 } else { 86 $this->individual_privacy[$row->xref] = (int) $row->resn; 87 } 88 } else { 89 $this->fact_privacy[$row->tag_type] = (int) $row->resn; 90 } 91 } 92 } 93 94 /** 95 * The ID of this tree 96 * 97 * @return int 98 */ 99 public function getTreeId() { 100 return $this->tree_id; 101 } 102 103 /** 104 * The name of this tree 105 * 106 * @return string 107 */ 108 public function getName() { 109 return $this->name; 110 } 111 112 /** 113 * The name of this tree 114 * 115 * @return string 116 */ 117 public function getNameHtml() { 118 return Html::escape($this->name); 119 } 120 121 /** 122 * The name of this tree 123 * 124 * @return string 125 */ 126 public function getNameUrl() { 127 return rawurlencode($this->name); 128 } 129 130 /** 131 * The title of this tree 132 * 133 * @return string 134 */ 135 public function getTitle() { 136 return $this->title; 137 } 138 139 /** 140 * The title of this tree, with HTML markup 141 * 142 * @return string 143 */ 144 public function getTitleHtml() { 145 return '<span dir="auto">' . Html::escape($this->title) . '</span>'; 146 } 147 148 /** 149 * The fact-level privacy for this tree. 150 * 151 * @return int[] 152 */ 153 public function getFactPrivacy() { 154 return $this->fact_privacy; 155 } 156 157 /** 158 * The individual-level privacy for this tree. 159 * 160 * @return int[] 161 */ 162 public function getIndividualPrivacy() { 163 return $this->individual_privacy; 164 } 165 166 /** 167 * The individual-fact-level privacy for this tree. 168 * 169 * @return integer[][] 170 */ 171 public function getIndividualFactPrivacy() { 172 return $this->individual_fact_privacy; 173 } 174 175 /** 176 * Get the tree’s configuration settings. 177 * 178 * @param string $setting_name 179 * @param string $default 180 * 181 * @return string 182 */ 183 public function getPreference($setting_name, $default = '') { 184 if (empty($this->preferences)) { 185 $this->preferences = Database::prepare( 186 "SELECT SQL_CACHE setting_name, setting_value FROM `##gedcom_setting` WHERE gedcom_id = ?" 187 )->execute([$this->tree_id])->fetchAssoc(); 188 } 189 190 if (array_key_exists($setting_name, $this->preferences)) { 191 return $this->preferences[$setting_name]; 192 } else { 193 return $default; 194 } 195 } 196 197 /** 198 * Set the tree’s configuration settings. 199 * 200 * @param string $setting_name 201 * @param string $setting_value 202 * 203 * @return $this 204 */ 205 public function setPreference($setting_name, $setting_value) { 206 if ($setting_value !== $this->getPreference($setting_name)) { 207 Database::prepare( 208 "REPLACE INTO `##gedcom_setting` (gedcom_id, setting_name, setting_value)" . 209 " VALUES (:tree_id, :setting_name, LEFT(:setting_value, 255))" 210 )->execute([ 211 'tree_id' => $this->tree_id, 212 'setting_name' => $setting_name, 213 'setting_value' => $setting_value, 214 ]); 215 216 $this->preferences[$setting_name] = $setting_value; 217 218 Log::addConfigurationLog('Tree preference "' . $setting_name . '" set to "' . $setting_value . '"', $this); 219 } 220 221 return $this; 222 } 223 224 /** 225 * Get the tree’s user-configuration settings. 226 * 227 * @param User $user 228 * @param string $setting_name 229 * @param string|null $default 230 * 231 * @return string 232 */ 233 public function getUserPreference(User $user, $setting_name, $default = null) { 234 // There are lots of settings, and we need to fetch lots of them on every page 235 // so it is quicker to fetch them all in one go. 236 if (!array_key_exists($user->getUserId(), $this->user_preferences)) { 237 $this->user_preferences[$user->getUserId()] = Database::prepare( 238 "SELECT SQL_CACHE setting_name, setting_value FROM `##user_gedcom_setting` WHERE user_id = ? AND gedcom_id = ?" 239 )->execute([$user->getUserId(), $this->tree_id])->fetchAssoc(); 240 } 241 242 if (array_key_exists($setting_name, $this->user_preferences[$user->getUserId()])) { 243 return $this->user_preferences[$user->getUserId()][$setting_name]; 244 } else { 245 return $default; 246 } 247 } 248 249 /** 250 * Set the tree’s user-configuration settings. 251 * 252 * @param User $user 253 * @param string $setting_name 254 * @param string $setting_value 255 * 256 * @return $this 257 */ 258 public function setUserPreference(User $user, $setting_name, $setting_value) { 259 if ($this->getUserPreference($user, $setting_name) !== $setting_value) { 260 // Update the database 261 if ($setting_value === null) { 262 Database::prepare( 263 "DELETE FROM `##user_gedcom_setting` WHERE gedcom_id = :tree_id AND user_id = :user_id AND setting_name = :setting_name" 264 )->execute([ 265 'tree_id' => $this->tree_id, 266 'user_id' => $user->getUserId(), 267 'setting_name' => $setting_name, 268 ]); 269 } else { 270 Database::prepare( 271 "REPLACE INTO `##user_gedcom_setting` (user_id, gedcom_id, setting_name, setting_value) VALUES (:user_id, :tree_id, :setting_name, LEFT(:setting_value, 255))" 272 )->execute([ 273 'user_id' => $user->getUserId(), 274 'tree_id' => $this->tree_id, 275 'setting_name' => $setting_name, 276 'setting_value' => $setting_value, 277 ]); 278 } 279 // Update our cache 280 $this->user_preferences[$user->getUserId()][$setting_name] = $setting_value; 281 // Audit log of changes 282 Log::addConfigurationLog('Tree preference "' . $setting_name . '" set to "' . $setting_value . '" for user "' . $user->getUserName() . '"', $this); 283 } 284 285 return $this; 286 } 287 288 /** 289 * Can a user accept changes for this tree? 290 * 291 * @param User $user 292 * 293 * @return bool 294 */ 295 public function canAcceptChanges(User $user) { 296 return Auth::isModerator($this, $user); 297 } 298 299 /** 300 * Fetch all the trees that we have permission to access. 301 * 302 * @return Tree[] 303 */ 304 public static function getAll() { 305 if (self::$trees === null) { 306 self::$trees = []; 307 $rows = Database::prepare( 308 "SELECT SQL_CACHE g.gedcom_id AS tree_id, g.gedcom_name AS tree_name, gs1.setting_value AS tree_title" . 309 " FROM `##gedcom` g" . 310 " LEFT JOIN `##gedcom_setting` gs1 ON (g.gedcom_id=gs1.gedcom_id AND gs1.setting_name='title')" . 311 " LEFT JOIN `##gedcom_setting` gs2 ON (g.gedcom_id=gs2.gedcom_id AND gs2.setting_name='imported')" . 312 " LEFT JOIN `##gedcom_setting` gs3 ON (g.gedcom_id=gs3.gedcom_id AND gs3.setting_name='REQUIRE_AUTHENTICATION')" . 313 " LEFT JOIN `##user_gedcom_setting` ugs ON (g.gedcom_id=ugs.gedcom_id AND ugs.setting_name='canedit' AND ugs.user_id=?)" . 314 " WHERE " . 315 " g.gedcom_id>0 AND (" . // exclude the "template" tree 316 " EXISTS (SELECT 1 FROM `##user_setting` WHERE user_id=? AND setting_name='canadmin' AND setting_value=1)" . // Admin sees all 317 " ) OR (" . 318 " (gs2.setting_value = 1 OR ugs.setting_value = 'admin') AND (" . // Allow imported trees, with either: 319 " gs3.setting_value <> 1 OR" . // visitor access 320 " IFNULL(ugs.setting_value, 'none')<>'none'" . // explicit access 321 " )" . 322 " )" . 323 " ORDER BY g.sort_order, 3" 324 )->execute([Auth::id(), Auth::id()])->fetchAll(); 325 foreach ($rows as $row) { 326 self::$trees[] = new self((int) $row->tree_id, $row->tree_name, $row->tree_title); 327 } 328 } 329 330 return self::$trees; 331 } 332 333 /** 334 * Find the tree with a specific ID. 335 * 336 * @param int $tree_id 337 * 338 * @throws \DomainException 339 * 340 * @return Tree 341 */ 342 public static function findById($tree_id) { 343 foreach (self::getAll() as $tree) { 344 if ($tree->tree_id == $tree_id) { 345 return $tree; 346 } 347 } 348 throw new \DomainException; 349 } 350 351 /** 352 * Find the tree with a specific name. 353 * 354 * @param string $tree_name 355 * 356 * @return Tree|null 357 */ 358 public static function findByName($tree_name) { 359 foreach (self::getAll() as $tree) { 360 if ($tree->name === $tree_name) { 361 return $tree; 362 } 363 } 364 365 return null; 366 } 367 368 /** 369 * Create arguments to select_edit_control() 370 * Note - these will be escaped later 371 * 372 * @return string[] 373 */ 374 public static function getIdList() { 375 $list = []; 376 foreach (self::getAll() as $tree) { 377 $list[$tree->tree_id] = $tree->title; 378 } 379 380 return $list; 381 } 382 383 /** 384 * Create arguments to select_edit_control() 385 * Note - these will be escaped later 386 * 387 * @return string[] 388 */ 389 public static function getNameList() { 390 $list = []; 391 foreach (self::getAll() as $tree) { 392 $list[$tree->name] = $tree->title; 393 } 394 395 return $list; 396 } 397 398 /** 399 * Create a new tree 400 * 401 * @param string $tree_name 402 * @param string $tree_title 403 * 404 * @return Tree 405 */ 406 public static function create($tree_name, $tree_title) { 407 try { 408 // Create a new tree 409 Database::prepare( 410 "INSERT INTO `##gedcom` (gedcom_name) VALUES (?)" 411 )->execute([$tree_name]); 412 $tree_id = Database::prepare("SELECT LAST_INSERT_ID()")->fetchOne(); 413 } catch (PDOException $ex) { 414 // A tree with that name already exists? 415 return self::findByName($tree_name); 416 } 417 418 // Update the list of trees - to include this new one 419 self::$trees = null; 420 $tree = self::findById($tree_id); 421 422 $tree->setPreference('imported', '0'); 423 $tree->setPreference('title', $tree_title); 424 425 // Module privacy 426 Module::setDefaultAccess($tree_id); 427 428 // Set preferences from default tree 429 Database::prepare( 430 "INSERT INTO `##gedcom_setting` (gedcom_id, setting_name, setting_value)" . 431 " SELECT :tree_id, setting_name, setting_value" . 432 " FROM `##gedcom_setting` WHERE gedcom_id = -1" 433 )->execute([ 434 'tree_id' => $tree_id, 435 ]); 436 437 Database::prepare( 438 "INSERT INTO `##default_resn` (gedcom_id, tag_type, resn)" . 439 " SELECT :tree_id, tag_type, resn" . 440 " FROM `##default_resn` WHERE gedcom_id = -1" 441 )->execute([ 442 'tree_id' => $tree_id, 443 ]); 444 445 Database::prepare( 446 "INSERT INTO `##block` (gedcom_id, location, block_order, module_name)" . 447 " SELECT :tree_id, location, block_order, module_name" . 448 " FROM `##block` WHERE gedcom_id = -1" 449 )->execute([ 450 'tree_id' => $tree_id, 451 ]); 452 453 // Gedcom and privacy settings 454 $tree->setPreference('CONTACT_USER_ID', Auth::id()); 455 $tree->setPreference('WEBMASTER_USER_ID', Auth::id()); 456 $tree->setPreference('LANGUAGE', WT_LOCALE); // Default to the current admin’s language 457 switch (WT_LOCALE) { 458 case 'es': 459 $tree->setPreference('SURNAME_TRADITION', 'spanish'); 460 break; 461 case 'is': 462 $tree->setPreference('SURNAME_TRADITION', 'icelandic'); 463 break; 464 case 'lt': 465 $tree->setPreference('SURNAME_TRADITION', 'lithuanian'); 466 break; 467 case 'pl': 468 $tree->setPreference('SURNAME_TRADITION', 'polish'); 469 break; 470 case 'pt': 471 case 'pt-BR': 472 $tree->setPreference('SURNAME_TRADITION', 'portuguese'); 473 break; 474 default: 475 $tree->setPreference('SURNAME_TRADITION', 'paternal'); 476 break; 477 } 478 479 // Genealogy data 480 // It is simpler to create a temporary/unimported GEDCOM than to populate all the tables... 481 $john_doe = /* I18N: This should be a common/default/placeholder name of an individual. Put slashes around the surname. */ I18N::translate('John /DOE/'); 482 $note = I18N::translate('Edit this individual and replace their details with your own.'); 483 Database::prepare("INSERT INTO `##gedcom_chunk` (gedcom_id, chunk_data) VALUES (?, ?)")->execute([ 484 $tree_id, 485 "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", 486 ]); 487 488 // Update our cache 489 self::$trees[$tree->tree_id] = $tree; 490 491 return $tree; 492 } 493 494 /** 495 * Are there any pending edits for this tree, than need reviewing by a moderator. 496 * 497 * @return bool 498 */ 499 public function hasPendingEdit() { 500 return (bool) Database::prepare( 501 "SELECT 1 FROM `##change` WHERE status = 'pending' AND gedcom_id = :tree_id" 502 )->execute([ 503 'tree_id' => $this->tree_id, 504 ])->fetchOne(); 505 } 506 507 /** 508 * Delete all the genealogy data from a tree - in preparation for importing 509 * new data. Optionally retain the media data, for when the user has been 510 * editing their data offline using an application which deletes (or does not 511 * support) media data. 512 * 513 * @param bool $keep_media 514 */ 515 public function deleteGenealogyData($keep_media) { 516 Database::prepare("DELETE FROM `##gedcom_chunk` WHERE gedcom_id = ?")->execute([$this->tree_id]); 517 Database::prepare("DELETE FROM `##individuals` WHERE i_file = ?")->execute([$this->tree_id]); 518 Database::prepare("DELETE FROM `##families` WHERE f_file = ?")->execute([$this->tree_id]); 519 Database::prepare("DELETE FROM `##sources` WHERE s_file = ?")->execute([$this->tree_id]); 520 Database::prepare("DELETE FROM `##other` WHERE o_file = ?")->execute([$this->tree_id]); 521 Database::prepare("DELETE FROM `##places` WHERE p_file = ?")->execute([$this->tree_id]); 522 Database::prepare("DELETE FROM `##placelinks` WHERE pl_file = ?")->execute([$this->tree_id]); 523 Database::prepare("DELETE FROM `##name` WHERE n_file = ?")->execute([$this->tree_id]); 524 Database::prepare("DELETE FROM `##dates` WHERE d_file = ?")->execute([$this->tree_id]); 525 Database::prepare("DELETE FROM `##change` WHERE gedcom_id = ?")->execute([$this->tree_id]); 526 527 if ($keep_media) { 528 Database::prepare("DELETE FROM `##link` WHERE l_file =? AND l_type<>'OBJE'")->execute([$this->tree_id]); 529 } else { 530 Database::prepare("DELETE FROM `##link` WHERE l_file =?")->execute([$this->tree_id]); 531 Database::prepare("DELETE FROM `##media` WHERE m_file =?")->execute([$this->tree_id]); 532 } 533 } 534 535 /** 536 * Delete everything relating to a tree 537 */ 538 public function delete() { 539 // If this is the default tree, then unset it 540 if (Site::getPreference('DEFAULT_GEDCOM') === $this->name) { 541 Site::setPreference('DEFAULT_GEDCOM', ''); 542 } 543 544 $this->deleteGenealogyData(false); 545 546 Database::prepare("DELETE `##block_setting` FROM `##block_setting` JOIN `##block` USING (block_id) WHERE gedcom_id=?")->execute([$this->tree_id]); 547 Database::prepare("DELETE FROM `##block` WHERE gedcom_id = ?")->execute([$this->tree_id]); 548 Database::prepare("DELETE FROM `##user_gedcom_setting` WHERE gedcom_id = ?")->execute([$this->tree_id]); 549 Database::prepare("DELETE FROM `##gedcom_setting` WHERE gedcom_id = ?")->execute([$this->tree_id]); 550 Database::prepare("DELETE FROM `##module_privacy` WHERE gedcom_id = ?")->execute([$this->tree_id]); 551 Database::prepare("DELETE FROM `##next_id` WHERE gedcom_id = ?")->execute([$this->tree_id]); 552 Database::prepare("DELETE FROM `##hit_counter` WHERE gedcom_id = ?")->execute([$this->tree_id]); 553 Database::prepare("DELETE FROM `##default_resn` WHERE gedcom_id = ?")->execute([$this->tree_id]); 554 Database::prepare("DELETE FROM `##gedcom_chunk` WHERE gedcom_id = ?")->execute([$this->tree_id]); 555 Database::prepare("DELETE FROM `##log` WHERE gedcom_id = ?")->execute([$this->tree_id]); 556 Database::prepare("DELETE FROM `##gedcom` WHERE gedcom_id = ?")->execute([$this->tree_id]); 557 558 // After updating the database, we need to fetch a new (sorted) copy 559 self::$trees = null; 560 } 561 562 /** 563 * Export the tree to a GEDCOM file 564 * 565 * @param resource $stream 566 */ 567 public function exportGedcom($stream) { 568 $stmt = Database::prepare( 569 "SELECT i_gedcom AS gedcom, i_id AS xref, 1 AS n FROM `##individuals` WHERE i_file = :tree_id_1" . 570 " UNION ALL " . 571 "SELECT f_gedcom AS gedcom, f_id AS xref, 2 AS n FROM `##families` WHERE f_file = :tree_id_2" . 572 " UNION ALL " . 573 "SELECT s_gedcom AS gedcom, s_id AS xref, 3 AS n FROM `##sources` WHERE s_file = :tree_id_3" . 574 " UNION ALL " . 575 "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')" . 576 " UNION ALL " . 577 "SELECT m_gedcom AS gedcom, m_id AS xref, 5 AS n FROM `##media` WHERE m_file = :tree_id_5" . 578 " ORDER BY n, LENGTH(xref), xref" 579 )->execute([ 580 'tree_id_1' => $this->tree_id, 581 'tree_id_2' => $this->tree_id, 582 'tree_id_3' => $this->tree_id, 583 'tree_id_4' => $this->tree_id, 584 'tree_id_5' => $this->tree_id, 585 ]); 586 587 $buffer = FunctionsExport::reformatRecord(FunctionsExport::gedcomHeader($this)); 588 while ($row = $stmt->fetch()) { 589 $buffer .= FunctionsExport::reformatRecord($row->gedcom); 590 if (strlen($buffer) > 65535) { 591 fwrite($stream, $buffer); 592 $buffer = ''; 593 } 594 } 595 fwrite($stream, $buffer . '0 TRLR' . WT_EOL); 596 $stmt->closeCursor(); 597 } 598 599 /** 600 * Import data from a gedcom file into this tree. 601 * 602 * @param string $path The full path to the (possibly temporary) file. 603 * @param string $filename The preferred filename, for export/download. 604 * 605 * @throws \Exception 606 */ 607 public function importGedcomFile($path, $filename) { 608 // Read the file in blocks of roughly 64K. Ensure that each block 609 // contains complete gedcom records. This will ensure we don’t split 610 // multi-byte characters, as well as simplifying the code to import 611 // each block. 612 613 $file_data = ''; 614 $fp = fopen($path, 'rb'); 615 616 // Don’t allow the user to cancel the request. We do not want to be left with an incomplete transaction. 617 ignore_user_abort(true); 618 619 Database::beginTransaction(); 620 $this->deleteGenealogyData($this->getPreference('keep_media')); 621 $this->setPreference('gedcom_filename', $filename); 622 $this->setPreference('imported', '0'); 623 624 while (!feof($fp)) { 625 $file_data .= fread($fp, 65536); 626 // There is no strrpos() function that searches for substrings :-( 627 for ($pos = strlen($file_data) - 1; $pos > 0; --$pos) { 628 if ($file_data[$pos] === '0' && ($file_data[$pos - 1] === "\n" || $file_data[$pos - 1] === "\r")) { 629 // We’ve found the last record boundary in this chunk of data 630 break; 631 } 632 } 633 if ($pos) { 634 Database::prepare( 635 "INSERT INTO `##gedcom_chunk` (gedcom_id, chunk_data) VALUES (?, ?)" 636 )->execute([$this->tree_id, substr($file_data, 0, $pos)]); 637 $file_data = substr($file_data, $pos); 638 } 639 } 640 Database::prepare( 641 "INSERT INTO `##gedcom_chunk` (gedcom_id, chunk_data) VALUES (?, ?)" 642 )->execute([$this->tree_id, $file_data]); 643 644 Database::commit(); 645 fclose($fp); 646 } 647 648 /** 649 * Generate a new XREF, unique across all family trees 650 * 651 * @param string $type 652 * 653 * @return string 654 */ 655 public function getNewXref($type = 'INDI') { 656 /** @var string[] Which tree preference is used for which record type */ 657 static $type_to_preference = [ 658 'INDI' => 'GEDCOM_ID_PREFIX', 659 'FAM' => 'FAM_ID_PREFIX', 660 'OBJE' => 'MEDIA_ID_PREFIX', 661 'NOTE' => 'NOTE_ID_PREFIX', 662 'SOUR' => 'SOURCE_ID_PREFIX', 663 'REPO' => 'REPO_ID_PREFIX', 664 ]; 665 666 if (array_key_exists($type, $type_to_preference)) { 667 $prefix = $this->getPreference($type_to_preference[$type]); 668 } else { 669 // Use the first non-underscore character 670 $prefix = substr(trim($type, '_'), 0, 1); 671 } 672 673 $increment = 1.0; 674 do { 675 // Use LAST_INSERT_ID(expr) to provide a transaction-safe sequence. See 676 // http://dev.mysql.com/doc/refman/5.6/en/information-functions.html#function_last-insert-id 677 $statement = Database::prepare( 678 "UPDATE `##next_id` SET next_id = LAST_INSERT_ID(next_id + :increment) WHERE record_type = :record_type AND gedcom_id = :tree_id" 679 ); 680 $statement->execute([ 681 'increment' => (int) $increment, 682 'record_type' => $type, 683 'tree_id' => $this->tree_id, 684 ]); 685 686 if ($statement->rowCount() === 0) { 687 // First time we've used this record type. 688 Database::prepare( 689 "INSERT INTO `##next_id` (gedcom_id, record_type, next_id) VALUES(:tree_id, :record_type, 1)" 690 )->execute([ 691 'record_type' => $type, 692 'tree_id' => $this->tree_id, 693 ]); 694 $num = 1; 695 } else { 696 $num = Database::prepare("SELECT LAST_INSERT_ID()")->fetchOne(); 697 } 698 699 // Records may already exist with this sequence number. 700 $already_used = Database::prepare( 701 "SELECT i_id FROM `##individuals` WHERE i_id = :i_id" . 702 " UNION ALL " . 703 "SELECT f_id FROM `##families` WHERE f_id = :f_id" . 704 " UNION ALL " . 705 "SELECT s_id FROM `##sources` WHERE s_id = :s_id" . 706 " UNION ALL " . 707 "SELECT m_id FROM `##media` WHERE m_id = :m_id" . 708 " UNION ALL " . 709 "SELECT o_id FROM `##other` WHERE o_id = :o_id" . 710 " UNION ALL " . 711 "SELECT xref FROM `##change` WHERE xref = :xref" 712 )->execute([ 713 'i_id' => $prefix . $num, 714 'f_id' => $prefix . $num, 715 's_id' => $prefix . $num, 716 'm_id' => $prefix . $num, 717 'o_id' => $prefix . $num, 718 'xref' => $prefix . $num, 719 ])->fetchOne(); 720 721 // This exponential increment allows us to scan over large blocks of 722 // existing data in a reasonable time. 723 $increment *= 1.01; 724 } while ($already_used); 725 726 return $prefix . $num; 727 } 728 729 /** 730 * Create a new record from GEDCOM data. 731 * 732 * @param string $gedcom 733 * 734 * @throws \Exception 735 * 736 * @return GedcomRecord|Individual|Family|Note|Source|Repository|Media 737 */ 738 public function createRecord($gedcom) { 739 if (preg_match('/^0 @(' . WT_REGEX_XREF . ')@ (' . WT_REGEX_TAG . ')/', $gedcom, $match)) { 740 $xref = $match[1]; 741 $type = $match[2]; 742 } else { 743 throw new \Exception('Invalid argument to GedcomRecord::createRecord(' . $gedcom . ')'); 744 } 745 if (strpos("\r", $gedcom) !== false) { 746 // MSDOS line endings will break things in horrible ways 747 throw new \Exception('Evil line endings found in GedcomRecord::createRecord(' . $gedcom . ')'); 748 } 749 750 // webtrees creates XREFs containing digits. Anything else (e.g. “new”) is just a placeholder. 751 if (!preg_match('/\d/', $xref)) { 752 $xref = $this->getNewXref($type); 753 $gedcom = preg_replace('/^0 @(' . WT_REGEX_XREF . ')@/', '0 @' . $xref . '@', $gedcom); 754 } 755 756 // Create a change record, if not already present 757 if (!preg_match('/\n1 CHAN/', $gedcom)) { 758 $gedcom .= "\n1 CHAN\n2 DATE " . date('d M Y') . "\n3 TIME " . date('H:i:s') . "\n2 _WT_USER " . Auth::user()->getUserName(); 759 } 760 761 // Create a pending change 762 Database::prepare( 763 "INSERT INTO `##change` (gedcom_id, xref, old_gedcom, new_gedcom, user_id) VALUES (?, ?, '', ?, ?)" 764 )->execute([ 765 $this->tree_id, 766 $xref, 767 $gedcom, 768 Auth::id(), 769 ]); 770 771 Log::addEditLog('Create: ' . $type . ' ' . $xref); 772 773 // Accept this pending change 774 if (Auth::user()->getPreference('auto_accept')) { 775 FunctionsImport::acceptAllChanges($xref, $this->tree_id); 776 } 777 // Return the newly created record. Note that since GedcomRecord 778 // has a cache of pending changes, we cannot use it to create a 779 // record with a newly created pending change. 780 return GedcomRecord::getInstance($xref, $this, $gedcom); 781 } 782} 783