Create test harnesses for modules

1 files changed, 529 insertions, 0 deletions

diff --git a/app/Module/IndividualFactsTabModule.php b/app/Module/IndividualFactsTabModule.php
new file mode 100644
index 0000000000..00c8df867e
--- /dev/null
+++ b/app/Module/IndividualFactsTabModule.php
@@ -0,0 +1,529 @@
+<?php
+namespace Fisharebest\Webtrees;
+
+/**
+ * webtrees: online genealogy
+ * Copyright (C) 2015 webtrees development team
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/**
+ * Class IndividualFactsTabModule
+ */
+class IndividualFactsTabModule extends Module implements ModuleTabInterface {
+	/** {@inheritdoc} */
+	public function getTitle() {
+		return /* I18N: Name of a module/tab on the individual page. */ I18N::translate('Facts and events');
+	}
+
+	/** {@inheritdoc} */
+	public function getDescription() {
+		return /* I18N: Description of the “Facts and events” module */ I18N::translate('A tab showing the facts and events of an individual.');
+	}
+
+	/** {@inheritdoc} */
+	public function defaultTabOrder() {
+		return 10;
+	}
+
+	/** {@inheritdoc} */
+	public function isGrayedOut() {
+		return false;
+	}
+
+	/** {@inheritdoc} */
+	public function getTabContent() {
+		global $controller;
+		$EXPAND_HISTO_EVENTS = false;
+
+		$indifacts = array();
+		// The individual’s own facts
+		foreach ($controller->record->getFacts() as $fact) {
+			switch ($fact->getTag()) {
+			case 'SEX':
+			case 'NAME':
+			case 'SOUR':
+			case 'OBJE':
+			case 'NOTE':
+			case 'FAMC':
+			case 'FAMS':
+				break;
+			default:
+				if (!array_key_exists('extra_info', Module::getActiveSidebars($controller->record->getTree())) || !ExtraInformationModule::showFact($fact)) {
+					$indifacts[] = $fact;
+				}
+				break;
+			}
+		}
+
+		// Add spouse-family facts
+		foreach ($controller->record->getSpouseFamilies() as $family) {
+			foreach ($family->getFacts() as $fact) {
+				switch ($fact->getTag()) {
+				case 'SOUR':
+				case 'NOTE':
+				case 'OBJE':
+				case 'CHAN':
+				case '_UID':
+				case 'RIN':
+				case 'HUSB':
+				case 'WIFE':
+				case 'CHIL':
+					break;
+				default:
+					$indifacts[] = $fact;
+					break;
+				}
+			}
+			$spouse = $family->getSpouse($controller->record);
+			if ($spouse) {
+				foreach (self::spouseFacts($controller->record, $spouse) as $fact) {
+					$indifacts[] = $fact;
+				}
+			}
+			foreach (self::childFacts($controller->record, $family, '_CHIL', '') as $fact) {
+				$indifacts[] = $fact;
+			}
+		}
+
+		foreach (self::parentFacts($controller->record, 1) as $fact) {
+			$indifacts[] = $fact;
+		}
+		foreach (self::historicalFacts($controller->record) as $fact) {
+			$indifacts[] = $fact;
+		}
+		foreach (self::associateFacts($controller->record) as $fact) {
+			$indifacts[] = $fact;
+		}
+
+		sort_facts($indifacts);
+
+		ob_start();
+
+		echo '<table class="facts_table">';
+		echo '<tbody>';
+		if (!$indifacts) {
+			echo '<tr><td colspan="2" class="facts_value">', I18N::translate('There are no facts for this individual.'), '</td></tr>';
+		}
+
+		echo '<tr><td colspan="2" class="descriptionbox rela"><form action="?"><input id="checkbox_rela_facts" type="checkbox" ';
+		echo $controller->record->getTree()->getPreference('EXPAND_RELATIVES_EVENTS') ? 'checked' : '';
+		echo ' onclick="jQuery(\'tr.rela\').toggle();"><label for="checkbox_rela_facts">', I18N::translate('Events of close relatives'), '</label>';
+		if (file_exists(Site::getPreference('INDEX_DIRECTORY') . 'histo.' . WT_LOCALE . '.php')) {
+			echo ' <input id="checkbox_histo" type="checkbox" ';
+			echo $EXPAND_HISTO_EVENTS ? 'checked' : '';
+			echo ' onclick="jQuery(\'tr.histo\').toggle();"><label for="checkbox_histo">', I18N::translate('Historical facts'), '</label>';
+		}
+		echo '</form></td></tr>';
+
+		foreach ($indifacts as $fact) {
+			print_fact($fact, $controller->record);
+		}
+
+		//-- new fact link
+		if ($controller->record->canEdit()) {
+			print_add_new_fact($controller->record->getXref(), $indifacts, 'INDI');
+		}
+		echo '</tbody>';
+		echo '</table>';
+
+		if (!$controller->record->getTree()->getPreference('EXPAND_RELATIVES_EVENTS')) {
+			echo '<script>jQuery("tr.rela").toggle();</script>';
+		}
+		if (!$EXPAND_HISTO_EVENTS) {
+			echo '<script>jQuery("tr.histo").toggle();</script>';
+		}
+
+
+		return '<div id="' . $this->getName() . '_content">' . ob_get_clean() . '</div>';
+	}
+
+	/** {@inheritdoc} */
+	public function hasTabContent() {
+		return true;
+	}
+
+	/** {@inheritdoc} */
+	public function canLoadAjax() {
+		return !Auth::isSearchEngine(); // Search engines cannot use AJAX
+	}
+
+	/** {@inheritdoc} */
+	public function getPreLoadContent() {
+		return '';
+	}
+
+	/**
+	 * Spouse facts that are shown on an individual’s page.
+	 *
+	 * @param Individual $individual Show events that occured during the lifetime of this individual
+	 * @param Individual $spouse     Show events of this individual
+	 *
+	 * @return Fact[]
+	 */
+	private static function spouseFacts(Individual $individual, Individual $spouse) {
+		$SHOW_RELATIVES_EVENTS = $individual->getTree()->getPreference('SHOW_RELATIVES_EVENTS');
+
+		$facts = array();
+		if (strstr($SHOW_RELATIVES_EVENTS, '_DEAT_SPOU')) {
+			// Only include events between birth and death
+			$birt_date = $individual->getEstimatedBirthDate();
+			$deat_date = $individual->getEstimatedDeathDate();
+
+			foreach ($spouse->getFacts(WT_EVENTS_DEAT) as $fact) {
+
+				$fact_date = $fact->getDate();
+				if ($fact_date->isOK() && Date::compare($birt_date, $fact_date) <= 0 && Date::compare($fact_date, $deat_date) <= 0) {
+					// Convert the event to a close relatives event.
+					$rela_fact = clone($fact);
+					$rela_fact->setTag('_' . $fact->getTag() . '_SPOU');
+					$facts[] = $rela_fact;
+				}
+			}
+		}
+
+		return $facts;
+	}
+
+	/**
+	 * Get the events of children and grandchildren.
+	 *
+	 * @param Individual $person
+	 * @param Family     $family
+	 * @param string     $option
+	 * @param string     $relation
+	 *
+	 * @return Fact[]
+	 */
+	private static function childFacts(Individual $person, Family $family, $option, $relation) {
+		global $controller;
+
+		$SHOW_RELATIVES_EVENTS = $person->getTree()->getPreference('SHOW_RELATIVES_EVENTS');
+
+		$facts = array();
+
+		// Only include events between birth and death
+		$birt_date = $controller->record->getEstimatedBirthDate();
+		$deat_date = $controller->record->getEstimatedDeathDate();
+
+		// Deal with recursion.
+		switch ($option) {
+		case '_CHIL':
+			// Add grandchildren
+			foreach ($family->getChildren() as $child) {
+				foreach ($child->getSpouseFamilies() as $cfamily) {
+					switch ($child->getSex()) {
+					case 'M':
+						foreach (self::childFacts($person, $cfamily, '_GCHI', 'son') as $fact) {
+							$facts[] = $fact;
+						}
+						break;
+					case 'F':
+						foreach (self::childFacts($person, $cfamily, '_GCHI', 'dau') as $fact) {
+							$facts[] = $fact;
+						}
+						break;
+					default:
+						foreach (self::childFacts($person, $cfamily, '_GCHI', 'chi') as $fact) {
+							$facts[] = $fact;
+						}
+						break;
+					}
+				}
+			}
+			break;
+		}
+
+		// For each child in the family
+		foreach ($family->getChildren() as $child) {
+			if ($child->getXref() == $person->getXref()) {
+				// We are not our own sibling!
+				continue;
+			}
+			// add child’s birth
+			if (strpos($SHOW_RELATIVES_EVENTS, '_BIRT' . str_replace('_HSIB', '_SIBL', $option)) !== false) {
+				foreach ($child->getFacts(WT_EVENTS_BIRT) as $fact) {
+					$sgdate = $fact->getDate();
+					// Always show _BIRT_CHIL, even if the dates are not known
+					if ($option == '_CHIL' || $sgdate->isOK() && Date::compare($birt_date, $sgdate) <= 0 && Date::compare($sgdate, $deat_date) <= 0) {
+						if ($option == '_GCHI' && $relation == 'dau') {
+							// Convert the event to a close relatives event.
+							$rela_fact = clone($fact);
+							$rela_fact->setTag('_' . $fact->getTag() . '_GCH1');
+							$facts[] = $rela_fact;
+						} elseif ($option == '_GCHI' && $relation == 'son') {
+							// Convert the event to a close relatives event.
+							$rela_fact = clone($fact);
+							$rela_fact->setTag('_' . $fact->getTag() . '_GCH2');
+							$facts[] = $rela_fact;
+						} else {
+							// Convert the event to a close relatives event.
+							$rela_fact = clone($fact);
+							$rela_fact->setTag('_' . $fact->getTag() . $option);
+							$facts[] = $rela_fact;
+						}
+					}
+				}
+			}
+			// add child’s death
+			if (strpos($SHOW_RELATIVES_EVENTS, '_DEAT' . str_replace('_HSIB', '_SIBL', $option)) !== false) {
+				foreach ($child->getFacts(WT_EVENTS_DEAT) as $fact) {
+					$sgdate = $fact->getDate();
+					if ($sgdate->isOK() && Date::compare($birt_date, $sgdate) <= 0 && Date::compare($sgdate, $deat_date) <= 0) {
+						if ($option == '_GCHI' && $relation == 'dau') {
+							// Convert the event to a close relatives event.
+							$rela_fact = clone($fact);
+							$rela_fact->setTag('_' . $fact->getTag() . '_GCH1');
+							$facts[] = $rela_fact;
+						} elseif ($option == '_GCHI' && $relation == 'son') {
+							// Convert the event to a close relatives event.
+							$rela_fact = clone($fact);
+							$rela_fact->setTag('_' . $fact->getTag() . '_GCH2');
+							$facts[] = $rela_fact;
+						} else {
+							// Convert the event to a close relatives event.
+							$rela_fact = clone($fact);
+							$rela_fact->setTag('_' . $fact->getTag() . $option);
+							$facts[] = $rela_fact;
+						}
+					}
+				}
+			}
+			// add child’s marriage
+			if (strstr($SHOW_RELATIVES_EVENTS, '_MARR' . str_replace('_HSIB', '_SIBL', $option))) {
+				foreach ($child->getSpouseFamilies() as $sfamily) {
+					foreach ($sfamily->getFacts(WT_EVENTS_MARR) as $fact) {
+						$sgdate = $fact->getDate();
+						if ($sgdate->isOK() && Date::compare($birt_date, $sgdate) <= 0 && Date::compare($sgdate, $deat_date) <= 0) {
+							if ($option == '_GCHI' && $relation == 'dau') {
+								// Convert the event to a close relatives event.
+								$rela_fact = clone($fact);
+								$rela_fact->setTag('_' . $fact->getTag() . '_GCH1');
+								$facts[] = $rela_fact;
+							} elseif ($option == '_GCHI' && $relation == 'son') {
+								// Convert the event to a close relatives event.
+								$rela_fact = clone($fact);
+								$rela_fact->setTag('_' . $fact->getTag() . '_GCH2');
+								$facts[] = $rela_fact;
+							} else {
+								// Convert the event to a close relatives event.
+								$rela_fact = clone($fact);
+								$rela_fact->setTag('_' . $fact->getTag() . $option);
+								$facts[] = $rela_fact;
+							}
+						}
+					}
+				}
+			}
+		}
+
+		return $facts;
+	}
+
+	/**
+	 * Get the events of parents and grandparents.
+	 *
+	 * @param Individual $person
+	 * @param integer    $sosa
+	 *
+	 * @return Fact[]
+	 */
+	private static function parentFacts(Individual $person, $sosa) {
+		global $controller;
+
+		$SHOW_RELATIVES_EVENTS = $person->getTree()->getPreference('SHOW_RELATIVES_EVENTS');
+
+		$facts = array();
+
+		// Only include events between birth and death
+		$birt_date = $controller->record->getEstimatedBirthDate();
+		$deat_date = $controller->record->getEstimatedDeathDate();
+
+		if ($sosa == 1) {
+			foreach ($person->getChildFamilies() as $family) {
+				// Add siblings
+				foreach (self::childFacts($person, $family, '_SIBL', '') as $fact) {
+					$facts[] = $fact;
+				}
+				foreach ($family->getSpouses() as $spouse) {
+					foreach ($spouse->getSpouseFamilies() as $sfamily) {
+						if ($family !== $sfamily) {
+							// Add half-siblings
+							foreach (self::childFacts($person, $sfamily, '_HSIB', '') as $fact) {
+								$facts[] = $fact;
+							}
+						}
+					}
+					// Add grandparents
+					foreach (self::parentFacts($spouse, $spouse->getSex() == 'F' ? 3 : 2) as $fact) {
+						$facts[] = $fact;
+					}
+				}
+			}
+
+			if (strstr($SHOW_RELATIVES_EVENTS, '_MARR_PARE')) {
+				// add father/mother marriages
+				foreach ($person->getChildFamilies() as $sfamily) {
+					foreach ($sfamily->getFacts(WT_EVENTS_MARR) as $fact) {
+						if ($fact->getDate()->isOK() && Date::compare($birt_date, $fact->getDate()) <= 0 && Date::compare($fact->getDate(), $deat_date) <= 0) {
+							// marriage of parents (to each other)
+							$rela_fact = clone($fact);
+							$rela_fact->setTag('_' . $fact->getTag() . '_FAMC');
+							$facts[] = $rela_fact;
+						}
+					}
+				}
+				foreach ($person->getChildStepFamilies() as $sfamily) {
+					foreach ($sfamily->getFacts(WT_EVENTS_MARR) as $fact) {
+						if ($fact->getDate()->isOK() && Date::compare($birt_date, $fact->getDate()) <= 0 && Date::compare($fact->getDate(), $deat_date) <= 0) {
+							// marriage of a parent (to another spouse)
+							// Convert the event to a close relatives event
+							$rela_fact = clone($fact);
+							$rela_fact->setTag('_' . $fact->getTag() . '_PARE');
+							$facts[] = $rela_fact;
+						}
+					}
+				}
+			}
+		}
+
+		foreach ($person->getChildFamilies() as $family) {
+			foreach ($family->getSpouses() as $parent) {
+				if (strstr($SHOW_RELATIVES_EVENTS, '_DEAT' . ($sosa == 1 ? '_PARE' : '_GPAR'))) {
+					foreach ($parent->getFacts(WT_EVENTS_DEAT) as $fact) {
+						if ($fact->getDate()->isOK() && Date::compare($birt_date, $fact->getDate()) <= 0 && Date::compare($fact->getDate(), $deat_date) <= 0) {
+							switch ($sosa) {
+							case 1:
+								// Convert the event to a close relatives event.
+								$rela_fact = clone($fact);
+								$rela_fact->setTag('_' . $fact->getTag() . '_PARE');
+								$facts[] = $rela_fact;
+								break;
+							case 2:
+								// Convert the event to a close relatives event
+								$rela_fact = clone($fact);
+								$rela_fact->setTag('_' . $fact->getTag() . '_GPA1');
+								$facts[] = $rela_fact;
+								break;
+							case 3:
+								// Convert the event to a close relatives event
+								$rela_fact = clone($fact);
+								$rela_fact->setTag('_' . $fact->getTag() . '_GPA2');
+								$facts[] = $rela_fact;
+								break;
+							}
+						}
+					}
+				}
+			}
+		}
+
+		return $facts;
+	}
+
+	/**
+	 * Get any historical events.
+	 *
+	 * @param Individual $person
+	 *
+	 * @return Fact[]
+	 */
+	private static function historicalFacts(Individual $person) {
+		$SHOW_RELATIVES_EVENTS = $person->getTree()->getPreference('SHOW_RELATIVES_EVENTS');
+
+		$facts = array();
+
+		if ($SHOW_RELATIVES_EVENTS) {
+			// Only include events between birth and death
+			$birt_date = $person->getEstimatedBirthDate();
+			$deat_date = $person->getEstimatedDeathDate();
+
+			if (file_exists(Site::getPreference('INDEX_DIRECTORY') . 'histo.' . WT_LOCALE . '.php')) {
+				$histo = array();
+				require Site::getPreference('INDEX_DIRECTORY') . 'histo.' . WT_LOCALE . '.php';
+				foreach ($histo as $hist) {
+					// Earlier versions of the WIKI encouraged people to use HTML entities,
+					// rather than UTF8 encoding.
+					$hist = html_entity_decode($hist, ENT_QUOTES, 'UTF-8');
+
+					$fact = new Fact($hist, $person, 'histo');
+					$sdate = $fact->getDate();
+					if ($sdate->isOK() && Date::compare($birt_date, $sdate) <= 0 && Date::compare($sdate, $deat_date) <= 0) {
+						$facts[] = $fact;
+					}
+				}
+			}
+		}
+
+		return $facts;
+	}
+
+	/**
+	 * Get the events of associates.
+	 *
+	 * @param Individual $person
+	 *
+	 * @return Fact[]
+	 */
+	private static function associateFacts(Individual $person) {
+		$facts = array();
+
+		$associates = array_merge(
+			$person->linkedIndividuals('ASSO'),
+			$person->linkedIndividuals('_ASSO'),
+			$person->linkedFamilies('ASSO'),
+			$person->linkedFamilies('_ASSO')
+		);
+		foreach ($associates as $associate) {
+			foreach ($associate->getFacts() as $fact) {
+				$arec = $fact->getAttribute('_ASSO');
+				if (!$arec) {
+					$arec = $fact->getAttribute('ASSO');
+				}
+				if ($arec && trim($arec, '@') === $person->getXref()) {
+					// Extract the important details from the fact
+					$factrec = '1 ' . $fact->getTag();
+					if (preg_match('/\n2 DATE .*/', $fact->getGedcom(), $match)) {
+						$factrec .= $match[0];
+					}
+					if (preg_match('/\n2 PLAC .*/', $fact->getGedcom(), $match)) {
+						$factrec .= $match[0];
+					}
+					if ($associate instanceof Family) {
+						foreach ($associate->getSpouses() as $spouse) {
+							$factrec .= "\n2 _ASSO @" . $spouse->getXref() . '@';
+						}
+					} else {
+						$factrec .= "\n2 _ASSO @" . $associate->getXref() . '@';
+						// CHR/BAPM events are commonly used.  Generate the reverse relationship
+						if (preg_match('/^(?:BAPM|CHR)$/', $fact->getTag()) && preg_match('/2 _?ASSO @(' . $person->getXref() . ')@\n3 RELA god(?:parent|mother|father)/', $fact->getGedcom())) {
+							switch ($associate->getSex()) {
+							case 'M':
+								$factrec .= "\n3 RELA godson";
+								break;
+							case 'F':
+								$factrec .= "\n3 RELA goddaughter";
+								break;
+							default:
+								$factrec .= "\n3 RELA godchild";
+								break;
+							}
+						}
+					}
+					$facts[] = new Fact($factrec, $associate, 'asso');
+				}
+			}
+		}
+
+		return $facts;
+	}
+}