path: root/app/Functions/FunctionsCharts.php

<?php
/**
 * webtrees: online genealogy
 * Copyright (C) 2017 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/>.
 */
namespace Fisharebest\Webtrees\Functions;

use Fisharebest\Webtrees\Auth;
use Fisharebest\Webtrees\Family;
use Fisharebest\Webtrees\FontAwesome;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Individual;
use Fisharebest\Webtrees\Theme;

/**
 * Class FunctionsCharts - common functions
 */
class FunctionsCharts {
	/**
	 * print a table cell with sosa number
	 *
	 * @param int    $sosa
	 * @param string $pid  optional pid
	 * @param string $icon which arrow to use
	 */
	public static function printSosaNumber($sosa, $pid = '', $icon = '') {
		if (substr($sosa, -1, 1) === '.') {
			$personLabel = substr($sosa, 0, -1);
		} else {
			$personLabel = $sosa;
		}
		if ($icon == '') {
			$visibility = 'hidden';
		} else {
			$visibility = 'normal';
		}
		echo '<td class="subheaders center" style="vertical-align: middle; text-indent: 0px; margin-top: 0px; white-space: nowrap; visibility: ', $visibility, ';">';
		echo $personLabel;
		if ($sosa != '1' && $pid !== '') {
			echo '<br>';
			echo FontAwesome::linkIcon($icon, $pid, ['href' => '#' . $pid]);
		}
		echo '</td>';
	}

	/**
	 * print the parents table for a family
	 *
	 * @param Family $family    family gedcom ID
	 * @param int    $sosa      child sosa number
	 * @param string $label     indi label (descendancy booklet)
	 * @param string $parid     parent ID (descendancy booklet)
	 * @param string $gparid    gd-parent ID (descendancy booklet)
	 */
	public static function printFamilyParents(Family $family, $sosa = 0, $label = '', $parid = '', $gparid = '') {

		$pbheight = Theme::theme()->parameter('chart-box-y') + 14;

		$husb = $family->getHusband();
		if ($husb) {
			echo '<a name="', $husb->getXref(), '"></a>';
		} else {
			$husb = new Individual('M', "0 @M@ INDI\n1 SEX M", null, $family->getTree());
		}
		$wife = $family->getWife();
		if ($wife) {
			echo '<a name="', $wife->getXref(), '"></a>';
		} else {
			$wife = new Individual('F', "0 @F@ INDI\n1 SEX F", null, $family->getTree());
		}

		if ($sosa) {
			echo '<p class="name_head">', $family->getFullName(), '</p>';
		}

		/**
		 * husband side
		 */
		echo '<table cellspacing="0" cellpadding="0" border="0"><tr><td rowspan="2">';
		echo '<table cellspacing="0" cellpadding="0" border="0"><tr>';

		if ($parid) {
			if ($husb->getXref() == $parid) {
				self::printSosaNumber($label, '', 'arrow-up');
			} else {
				self::printSosaNumber($label, '', 'arrow-up');
			}
		} elseif ($sosa) {
			self::printSosaNumber($sosa * 2, '', 'arrow-up');
		}
		if ($husb->isPendingAddtion()) {
			echo '<td class="new">';
		} elseif ($husb->isPendingDeletion()) {
			echo '<td class="old">';
		} else {
			echo '<td>';
		}
		FunctionsPrint::printPedigreePerson($husb);
		echo '</td></tr></table>';
		echo '</td>';
		// husband’s parents
		$hfam = $husb->getPrimaryChildFamily();
		if ($hfam) {
			// remove the|| test for $sosa
			echo '<td rowspan="2"><img src="' . Theme::theme()->parameter('image-hline') . '"></td><td rowspan="2"><img  src="' . Theme::theme()->parameter('image-vline') . '" width="3" height="' . ($pbheight - 14 ) . '"></td>';
			echo '<td><img class="linea1 lined1"  src="' . Theme::theme()->parameter('image-hline') . '"></td><td>';
			// husband’s father
			if ($hfam && $hfam->getHusband()) {
				echo '<table cellspacing="0" cellpadding="0" border="0"><tr>';
				if ($sosa > 0) {
					self::printSosaNumber($sosa * 4, $hfam->getHusband()->getXref(), 'arrow-down');
				}
				if (!empty($gparid) && $hfam->getHusband()->getXref() == $gparid) {
					self::printSosaNumber(trim(substr($label, 0, -3), '.') . '.', '', 'arrow-up');
				}
				echo '<td>';
				FunctionsPrint::printPedigreePerson($hfam->getHusband());
				echo '</td></tr></table>';
			} elseif ($hfam && !$hfam->getHusband()) {
				// Empty box for grandfather
				echo '<table cellspacing="0" cellpadding="0" border="0"><tr>';
				echo '<td>';
				FunctionsPrint::printPedigreePerson($hfam->getHusband());
				echo '</td></tr></table>';
			}
			echo '</td>';
		}
		if ($hfam && ($sosa != -1)) {
			echo '<td rowspan="2">';
			echo FontAwesome::linkIcon('arrow-end', $hfam->getXref(), ['href' => ($sosa == 0 ? '?famid=' . $hfam->getXref() . '&amp;ged=' . $hfam->getTree()->getNameUrl() : '#' . $hfam->getXref())]);
			echo '</td>';
		}
		if ($hfam) {
			// husband’s mother
			echo '</tr><tr><td><img class="linea2 lined2"  src="' . Theme::theme()->parameter('image-hline') . '"></td><td>';
			if ($hfam && $hfam->getWife()) {
				echo '<table cellspacing="0" cellpadding="0" border="0"><tr>';
				if ($sosa > 0) {
					self::printSosaNumber($sosa * 4 + 1, $hfam->getWife()->getXref(), 'arrow-down');
				}
				if (!empty($gparid) && $hfam->getWife()->getXref() == $gparid) {
					self::printSosaNumber(trim(substr($label, 0, -3), '.') . '.', '', 'arrow-up');
				}
				echo '<td>';
				FunctionsPrint::printPedigreePerson($hfam->getWife());
				echo '</td></tr></table>';
			} elseif ($hfam && !$hfam->getWife()) {
				// Empty box for grandmother
				echo '<table cellspacing="0" cellpadding="0" border="0"><tr>';
				echo '<td>';
				FunctionsPrint::printPedigreePerson($hfam->getWife());
				echo '</td></tr></table>';
			}
			echo '</td>';
		}
		echo '</tr></table>';
		if ($sosa && $family->canShow()) {
			foreach ($family->getFacts(WT_EVENTS_MARR) as $fact) {
				echo '<a href="', $family->getHtmlUrl(), '" class="details1">';
				echo str_repeat('&nbsp;', 10);
				echo $fact->summary();
				echo '</a>';
			}
		} else {
			echo '<br>';
		}

		/**
		 * wife side
		 */
		echo '<table cellspacing="0" cellpadding="0" border="0"><tr><td rowspan="2">';
		echo '<table cellspacing="0" cellpadding="0" border="0"><tr>';
		if ($parid) {
			if ($wife->getXref() == $parid) {
				self::printSosaNumber($label, '', 'arrow-up');
			} else {
				self::printSosaNumber($label, '', 'arrow-up');
			}
		} elseif ($sosa) {
			self::printSosaNumber($sosa * 2 + 1, '', 'arrow-up');
		}
		if ($wife->isPendingAddtion()) {
			echo '<td class="new">';
		} elseif ($wife->isPendingDeletion()) {
			echo '<td class="old">';
		} else {
			echo '<td>';
		}
		FunctionsPrint::printPedigreePerson($wife);
		echo '</td></tr></table>';
		echo '</td>';
		// wife’s parents
		$hfam = $wife->getPrimaryChildFamily();
		if ($hfam) {
			echo '<td rowspan="2"><img src="' . Theme::theme()->parameter('image-hline') . '"></td><td rowspan="2"><img src="' . Theme::theme()->parameter('image-vline') . '" width="3" height="' . ($pbheight - 14 ) . '"></td>';
			echo '<td><img class="linea3 lined3" src="' . Theme::theme()->parameter('image-hline') . '"></td><td>';
			// wife’s father
			if ($hfam && $hfam->getHusband()) {
				echo '<table cellspacing="0" cellpadding="0" border="0"><tr>';
				if ($sosa > 0) {
					self::printSosaNumber($sosa * 4 + 2, $hfam->getHusband()->getXref(), 'arrow-down');
				}
				if (!empty($gparid) && $hfam->getHusband()->getXref() == $gparid) {
					self::printSosaNumber(trim(substr($label, 0, -3), '.') . '.', '', 'arrow-up');
				}
				echo '<td>';
				FunctionsPrint::printPedigreePerson($hfam->getHusband());
				echo '</td></tr></table>';
			} elseif ($hfam && !$hfam->getHusband()) {
				// Empty box for grandfather
				echo '<table cellspacing="0" cellpadding="0" border="0"><tr>';
				echo '<td>';
				FunctionsPrint::printPedigreePerson($hfam->getHusband());
				echo '</td></tr></table>';
			}
			echo '</td>';
		}
		if ($hfam && ($sosa != -1)) {
			echo '<td rowspan="2">';
			echo FontAwesome::linkIcon('arrow-end', $hfam->getXref(), ['href' => ($sosa == 0 ? '?famid=' . $hfam->getXref() . '&amp;ged=' . $hfam->getTree()->getNameUrl() : '#' . $hfam->getXref())]);

			echo '</td>';
		}
		if ($hfam) {
			// wife’s mother
			echo '</tr><tr><td><img class="linea4 lined4"  src="' . Theme::theme()->parameter('image-hline') . '"></td><td>';
			if ($hfam && $hfam->getWife()) {
				echo '<table cellspacing="0" cellpadding="0" border="0"><tr>';
				if ($sosa > 0) {
					self::printSosaNumber($sosa * 4 + 3, $hfam->getWife()->getXref(), 'arrow-down');
				}
				if (!empty($gparid) && $hfam->getWife()->getXref() == $gparid) {
					self::printSosaNumber(trim(substr($label, 0, -3), '.') . '.', '', 'arrow-up');
				}
				echo '<td>';
				FunctionsPrint::printPedigreePerson($hfam->getWife());
				echo '</td></tr></table>';
			} elseif ($hfam && !$hfam->getWife()) {
				// Empty box for grandmother
				echo '<table cellspacing="0" cellpadding="0" border="0"><tr>';
				echo '<td>';
				FunctionsPrint::printPedigreePerson($hfam->getWife());
				echo '</td></tr></table>';
			}
			echo '</td>';
		}
		echo '</tr></table>';
	}

	/**
	 * print the children table for a family
	 *
	 * @param Family $family       family
	 * @param string $childid      child ID
	 * @param int    $sosa         child sosa number
	 * @param string $label        indi label (descendancy booklet)
	 * @param int    $show_cousins display cousins on chart
	 */
	public static function printFamilyChildren(Family $family, $childid = '', $sosa = 0, $label = '', $show_cousins = 0) {
		$bheight = Theme::theme()->parameter('chart-box-y');

		$pbheight = $bheight + 14;

		$children = $family->getChildren();
		$numchil  = count($children);

		echo '<table border="0" cellpadding="0" cellspacing="0"><tr>';
		if ($sosa > 0) {
			echo '<td></td>';
		}
		echo '<td><span class="subheaders">';
		if ($numchil == 0) {
			echo I18N::translate('No children');
		} else {
			echo I18N::plural('%s child', '%s children', $numchil, $numchil);
		}
		echo '</span>';

		if ($sosa == 0 && Auth::isEditor($family->getTree())) {
			echo '<br>';
			echo '<a href="edit_interface.php?action=add_child_to_family&amp;ged=' . $family->getTree()->getNameHtml() . '&amp;xref=' . $family->getXref() . '&amp;gender=U">' . I18N::translate('Add a child to this family') . '</a>';
			echo ' <a class="icon-sex_m_15x15" href="edit_interface.php?action=add_child_to_family&amp;ged=' . $family->getTree()->getNameHtml() . '&amp;xref=' . $family->getXref() . '&amp;gender=M" title="', I18N::translate('son'), '"></a>';
			echo ' <a class="icon-sex_f_15x15" href="edit_interface.php?action=add_child_to_family&amp;ged=' . $family->getTree()->getNameHtml() . '&amp;xref=' . $family->getXref() . '&amp;gender=F" title="', I18N::translate('daughter'), '"></a>';
			echo '<br><br>';
		}
		echo '</td>';
		if ($sosa > 0) {
			echo '<td></td><td></td>';
		}
		echo '</tr>';

		$nchi = 1;
		if ($children) {
			foreach ($children as $child) {
				echo '<tr>';
				if ($sosa != 0) {
					if ($child->getXref() == $childid) {
						self::printSosaNumber($sosa, $childid, 'arrow-up');
					} elseif (empty($label)) {
						self::printSosaNumber('', '', 'arrow-up');
					} else {
						self::printSosaNumber($label . ($nchi++) . '.', '', 'arrow-up');
					}
				}
				if ($child->isPendingAddtion()) {
					echo '<td class="new">';
				} elseif ($child->isPendingDeletion()) {
					echo '<td class="old">';
				} else {
					echo '<td>';
				}
				FunctionsPrint::printPedigreePerson($child);
				echo '</td>';
				if ($sosa != 0) {
					// loop for all families where current child is a spouse
					$famids = $child->getSpouseFamilies();

					$maxfam = count($famids) - 1;
					for ($f = 0; $f <= $maxfam; $f++) {
						$famid_child = $famids[$f]->getXref();
						// multiple marriages
						if ($f > 0) {
							echo '</tr><tr><td></td>';
							echo '<td style="text-align:end; vertical-align: top;">';

							//find out how many cousins there are to establish vertical line on second families
							$fchildren = $famids[$f]->getChildren();
							$kids      = count($fchildren);
							$Pheader   = ($bheight - 1) * $kids;
							$PBadj     = 6; // default
							if ($show_cousins > 0) {
								if ($kids) {
									$PBadj = max(0, $Pheader / 2 + $kids * 4.5);
								}
							}

							if ($f == $maxfam) {
								echo '<img height="' . ((($bheight / 2)) ) . 'px"';
							} else {
								echo '<img height="' . $pbheight . 'px"';
							}
							echo ' width="3" src="' . Theme::theme()->parameter('image-vline') . '">';
							echo '</td>';
						}
						echo '<td class="details1" style="text-align:center;">';
						$spouse = $famids[$f]->getSpouse($child);

						$marr = $famids[$f]->getFirstFact('MARR');
						$div  = $famids[$f]->getFirstFact('DIV');
						if ($marr) {
							// marriage date
							echo $marr->getDate()->minimumDate()->format('%Y');
							// divorce date
							if ($div) {
								echo '–', $div->getDate()->minimumDate()->format('%Y');
							}
							echo '<img class="linea5 lined5 " width="100%" height="3" src="' . Theme::theme()->parameter('image-hline') . '">';
						} else { echo '<img width="100%" height="3" src="' . Theme::theme()->parameter('image-hline') . '">';
						}
						echo '</td>';
						// spouse information
						echo '<td style="vertical-align: center;';
						if (!empty($divrec)) {
							echo ' filter:alpha(opacity=40);opacity:0.4;">';
						} else {
							echo '">';
						}
						FunctionsPrint::printPedigreePerson($spouse);
						echo '</td>';
						// cousins
						if ($show_cousins) {
							self::printCousins($famid_child);
						}
					}
				}
				echo '</tr>';
			}
		} elseif ($sosa < 1) {
			// message 'no children' except for sosa
			if (preg_match('/\n1 NCHI (\d+)/', $family->getGedcom(), $match) && $match[1] == 0) {
				echo '<tr><td><i class="icon-childless"></i> ' . I18N::translate('This family remained childless') . '</td></tr>';
			}
		}
		echo '</table><br>';
	}

	/**
	 * print a family with Sosa-Stradonitz numbering system
	 * ($rootid=1, father=2, mother=3 ...)
	 *
	 * @param string $famid        family gedcom ID
	 * @param string $childid      tree root ID
	 * @param int    $sosa         starting sosa number
	 * @param string $label        indi label (descendancy booklet)
	 * @param string $parid        parent ID (descendancy booklet)
	 * @param string $gparid       gd-parent ID (descendancy booklet)
	 * @param int    $show_cousins display cousins on chart
	 */
	public static function printSosaFamily($famid, $childid, $sosa, $label = '', $parid = '', $gparid = '', $show_cousins = 0) {
		global $WT_TREE;
		echo '<hr>';
		echo '<p class="family-break">';
		if (!empty($famid)) {
			echo '<a name="', $famid, '"></a>';
		}
		self::printFamilyParents(Family::getInstance($famid, $WT_TREE), $sosa, $label, $parid, $gparid);
		echo '<br>';
		echo '<table cellspacing="0" cellpadding="0" border="0"><tr><td>';
		self::printFamilyChildren(Family::getInstance($famid, $WT_TREE), $childid, $sosa, $label, $show_cousins);
		echo '</td></tr></table>';
		echo '<br>';
	}

	/**
	 * builds and returns sosa relationship name in the active language
	 *
	 * @param string $sosa sosa number
	 *
	 * @return string
	 */
	public static function getSosaName($sosa) {
		$path = '';
		while ($sosa > 1) {
			if ($sosa % 2 == 1) {
				$sosa -= 1;
				$path = 'mot' . $path;
			} else {
				$path = 'fat' . $path;
			}
			$sosa /= 2;
		}

		return Functions::getRelationshipNameFromPath($path, null, null);
	}

	/**
	 * print cousins list
	 *
	 * @param string $famid family ID
	 */
	public static function printCousins($famid) {
		global $WT_TREE;

		$bheight   = Theme::theme()->parameter('chart-box-y');
		$family    = Family::getInstance($famid, $WT_TREE);
		$fchildren = $family->getChildren();
		$kids      = count($fchildren);

		echo '<td>';
		if ($kids) {
			echo '<table cellspacing="0" cellpadding="0" border="0" ><tr>';
			if ($kids > 1) {
				echo '<td rowspan="', $kids, '"><img width="3px" height="', (($bheight) * ($kids - 1)), 'px" src="', Theme::theme()->parameter('image-vline'), '"></td>';
			}
			$ctkids = count($fchildren);
			$i      = 1;
			foreach ($fchildren as $fchil) {
				if ($i == 1) {
					echo '<td><img width="10px" height="3px" style="vertical-align:middle"';
				} else {
					echo '<td><img width="10px" height="3px"';
				}
				if (I18N::direction() === 'ltr') {
					echo ' style="padding-right: 2px;"';
				} else {
					echo ' style="padding-left: 2px;"';
				}
				echo ' src="', Theme::theme()->parameter('image-hline'), '"></td><td>';
				FunctionsPrint::printPedigreePerson($fchil);
				echo '</td></tr>';
				if ($i < $ctkids) {
					echo '<tr>';
					$i++;
				}
			}
			echo '</table>';
		} else {
			// If there is known that there are no children (as opposed to no known children)
			if (preg_match('/\n1 NCHI (\d+)/', $family->getGedcom(), $match) && $match[1] == 0) {
				echo ' <i class="icon-childless" title="', I18N::translate('This family remained childless'), '"></i>';
			}
		}
		echo '</td>';
	}
}