famlist.php

<?php
/**
 * Kiwitrees: Web based Family History software
 * Copyright (C) 2012 to 2017 kiwitrees.net
 *
 * Derived from webtrees (www.webtrees.net)
 * Copyright (C) 2010 to 2012 webtrees development team
 *
 * Derived from PhpGedView (phpgedview.sourceforge.net)
 * Copyright (C) 2002 to 2010 PGV Development Team
 *
 * Kiwitrees 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 Kiwitrees.  If not, see <http://www.gnu.org/licenses/>.
 */

define('KT_SCRIPT_NAME', 'famlist.php');
require './includes/session.php';
require_once KT_ROOT.'includes/functions/functions_print_lists.php';

// We show three different lists: initials, surnames and individuals
// Note that the data may contain special chars, such as surname="<unknown>",
$alpha   =safe_GET('alpha', KT_REGEX_UNSAFE); // All surnames beginning with this letter where "@"=unknown and ","=none
$surname =safe_GET('surname', KT_REGEX_UNSAFE); // All indis with this surname.  NB - allow ' and "
$show_all=safe_GET('show_all', array('no','yes'), 'no'); // All indis
// Long lists can be broken down by given name
$show_all_firstnames=safe_GET('show_all_firstnames', array('no','yes'), 'no');
if ($show_all_firstnames=='yes') {
	$falpha='';
} else {
	$falpha=safe_GET('falpha'); // All first names beginning with this letter
}

$show_marnm=get_user_setting(KT_USER_ID, KT_SCRIPT_NAME.'_show_marnm');
switch (safe_GET('show_marnm', array('no','yes'))) {
case 'no':
	$show_marnm=false;
	if (KT_USER_ID) {
		set_user_setting(KT_USER_ID, KT_SCRIPT_NAME.'_show_marnm', $show_marnm);
	}
	break;
case 'yes':
	$show_marnm=true;
	if (KT_USER_ID) {
		set_user_setting(KT_USER_ID, KT_SCRIPT_NAME.'_show_marnm', $show_marnm);
	}
	break;
}

// Make sure selections are consistent.
// i.e. can't specify show_all and surname at the same time.
if ($show_all=='yes') {
	if ($show_all_firstnames=='yes') {
		$alpha='';
		$surname='';
		$legend=KT_I18N::translate('All');
		$url=KT_SCRIPT_NAME.'?show_all=yes&amp;ged='.KT_GEDURL;
		$show='indi';
	} else	if ($falpha) {
		$alpha='';
		$surname='';
		$legend=KT_I18N::translate('All').', '.htmlspecialchars($falpha).'…';
		$url=KT_SCRIPT_NAME.'?show_all=yes&amp;ged='.KT_GEDURL;
		$show='indi';
	} else {
		$alpha='';
		$surname='';
		$legend=KT_I18N::translate('All');
		$url=KT_SCRIPT_NAME.'?show_all=yes'.'&amp;ged='.KT_GEDURL;
		$show=safe_GET('show', array('surn', 'indi'), 'surn');
	}
} elseif ($surname) {
	$alpha=KT_Query_Name::initialLetter($surname); // so we can highlight the initial letter
	$show_all='no';
	if ($surname=='@N.N.') {
		$legend=$UNKNOWN_NN;
	} else {
		$legend=htmlspecialchars($surname);
		// The surname parameter is a root/canonical form.
		// Display it as the actual surname
		foreach (KT_Query_Name::surnames($surname, $alpha, $show_marnm === 'yes', true, KT_GED_ID) as $details) {
			$legend = implode('/', array_keys($details));
		}
	}
	$url=KT_SCRIPT_NAME.'?surname='.rawurlencode($surname).'&amp;ged='.KT_GEDURL;
	switch($falpha) {
	case '':
		break;
	case '@':
		$legend.=', '.$UNKNOWN_PN;
		$url.='&amp;falpha='.rawurlencode($falpha).'&amp;ged='.KT_GEDURL;
		break;
	default:
		$legend.=', '.htmlspecialchars($falpha).'…';
		$url.='&amp;falpha='.rawurlencode($falpha).'&amp;ged='.KT_GEDURL;
		break;
	}
	$show='indi'; // SURN list makes no sense here
} elseif ($alpha=='@') {
	$show_all='no';
	$legend=$UNKNOWN_NN;
	$url=KT_SCRIPT_NAME.'?alpha='.rawurlencode($alpha).'&amp;ged='.KT_GEDURL;
	$show='indi'; // SURN list makes no sense here
} elseif ($alpha==',') {
	$show_all='no';
	$legend=KT_I18N::translate('None');
	$url=KT_SCRIPT_NAME.'?alpha='.rawurlencode($alpha).'&amp;ged='.KT_GEDURL;
	$show='indi'; // SURN list makes no sense here
} elseif ($alpha) {
	$show_all='no';
	$legend=htmlspecialchars($alpha).'…';
	$url=KT_SCRIPT_NAME.'?alpha='.rawurlencode($alpha).'&amp;ged='.KT_GEDURL;
	$show=safe_GET('show', array('surn', 'indi'), 'surn');
} else {
	$show_all='no';
	$legend='…';
	$url=KT_SCRIPT_NAME.'?ged='.KT_GEDURL;
	$show='none'; // Don't show lists until something is chosen
}
$legend = '<span dir="auto">'.$legend.'</span>';
$surname ? $surnameheader = ': ' . $surname : $surnameheader = '';


$controller = new KT_Controller_Page();
$controller
	->restrictAccess(KT_Module::isActiveList(KT_GED_ID, 'list_families', KT_USER_ACCESS_LEVEL))
	->setPageTitle(KT_I18N::translate('Families').' : '.$legend)
	->pageHeader();

echo '
	<div id="famlist-page">
		<h2 class="center">' . KT_I18N::translate('Families') . $surnameheader . '</h2>';

		// Print a selection list of initial letters
		$list=array();
		foreach (KT_Query_Name::surnameAlpha($show_marnm, true, KT_GED_ID) as $letter=>$count) {
			switch ($letter) {
			case '@':
				$html=$UNKNOWN_NN;
				break;
			case ',':
				$html=KT_I18N::translate('None');
				break;
			default:
				$html=htmlspecialchars($letter);
				break;
			}
			if ($count) {
				if ($letter==$alpha) {
					$list[]='<a href="'.KT_SCRIPT_NAME.'?alpha='.rawurlencode($letter).'&amp;ged='.KT_GEDURL.'" class="warning" title="'.$count.'">'.$html.'</a>';
				} else {
					$list[]='<a href="'.KT_SCRIPT_NAME.'?alpha='.rawurlencode($letter).'&amp;ged='.KT_GEDURL.'" title="'.$count.'">'.$html.'</a>';
				}
			} else {
				$list[]=$html;
			}
		}

		// Search spiders don't get the "show all" option as the other links give them everything.
		if (!$SEARCH_SPIDER) {
			if ($show_all=='yes') {
				$list[]='<span class="warning">'.KT_I18N::translate('All').'</span>';
			} else {
				$list[]='<a href="'.KT_SCRIPT_NAME.'?show_all=yes'.'&amp;ged='.KT_GEDURL.'">'.KT_I18N::translate('All').'</a>';
			}
		}
		echo '<p class="center alpha_index">', join(' | ', $list), '</p>';

		// Search spiders don't get an option to show/hide the surname sublists,
		// nor does it make sense on the all/unknown/surname views
		if (!$SEARCH_SPIDER) {
			echo '<p class="center marr_names">';
			if ($show!='none') {
				if ($show_marnm) {
					echo '<a href="', $url, '&amp;show='.$show.'&amp;show_marnm=no">', KT_I18N::translate('Exclude individuals with “%s” as a married name', $legend), '</a>';
				} else {
					echo '<a href="', $url, '&amp;show='.$show.'&amp;show_marnm=yes">', KT_I18N::translate('Include individuals with “%s” as a married name', $legend), '</a>';
				}

				if ($alpha!='@' && $alpha!=',' && !$surname) {
					if ($show=='surn') {
						echo '<br><a href="', $url, '&amp;show=indi">', KT_I18N::translate('Show the list of individuals'), '</a>';
					} else {
						echo '<br><a href="', $url, '&amp;show=surn">', KT_I18N::translate('Show the list of surnames'), '</a>';
					}
				}
			}
			echo '</p>';
		}

			if ($show=='indi' || $show=='surn') {
			$surns=KT_Query_Name::surnames($surname, $alpha, $show_marnm, true, KT_GED_ID);
			if ($show=='surn') {
				// Show the surname list
				switch ($SURNAME_LIST_STYLE) {
				case 'style1';
					echo format_surname_list($surns, 3, true, KT_SCRIPT_NAME);
					break;
				case 'style3':
					echo format_surname_tagcloud($surns, KT_SCRIPT_NAME, true);
					break;
				case 'style2':
				default:
					echo format_surname_table($surns, KT_SCRIPT_NAME, '1');
					break;
				}
			} else {
				// Show the list
				$count=0;
				foreach ($surns as $surnames) {
					foreach ($surnames as $list) {
						$count+=count($list);
					}
				}
				// Don't sublists short lists.
				if ($count<get_gedcom_setting(KT_GED_ID, 'SUBLIST_TRIGGER_I')) {
					$falpha='';
					$show_all_firstnames='no';
				} else {
					$givn_initials=KT_Query_Name::givenAlpha($surname, $alpha, $show_marnm, true, KT_GED_ID);
					// Break long lists by initial letter of given name
					if ($surname || $show_all=='yes') {
						// Don't show the list until we have some filter criteria
						$show=($falpha || $show_all_firstnames=='yes') ? 'indi' : 'none';
						$list=array();
						foreach ($givn_initials as $givn_initial=>$count) {
							switch ($givn_initial) {
							case '@':
								$html=$UNKNOWN_PN;
								break;
							default:
								$html=htmlspecialchars($givn_initial);
								break;
							}
							if ($count) {
								if ($show=='indi' && $givn_initial==$falpha && $show_all_firstnames=='no') {
									$list[]='<a class="warning" href="'.$url.'&amp;falpha='.rawurlencode($givn_initial).'" title="'.$count.'">'.$html.'</a>';
								} else {
									$list[]='<a href="'.$url.'&amp;falpha='.rawurlencode($givn_initial).'" title="'.$count.'">'.$html.'</a>';
								}
							} else {
								$list[]=$html;
							}
						}
						// Search spiders don't get the "show all" option as the other links give them everything.
						if (!$SEARCH_SPIDER) {
							if ($show_all_firstnames=='yes') {
								$list[]='<span class="warning">'.KT_I18N::translate('All').'</span>';
							} else {
								$list[]='<a href="'.$url.'&amp;show_all_firstnames=yes">'.KT_I18N::translate('All').'</a>';
							}
						}
						if ($show_all=='no') {
							echo '<h2 class="center">', KT_I18N::translate('Individuals with surname %s', $legend), '</h2>';
						}
						echo '<p class="center alpha_index">', join(' | ', $list), '</p>';
					}
				}
				if ($show=='indi') {
					echo format_fam_table(
						KT_Query_Name::families($surname, $alpha, $falpha, $show_marnm, KT_GED_ID)
					);
				}
			}
		}
	echo '</div>';