<?php
/**
* webtrees: online genealogy
* Copyright (C) 2016 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\Controller;
use Fisharebest\Webtrees\Auth;
use Fisharebest\Webtrees\Database;
use Fisharebest\Webtrees\Family;
use Fisharebest\Webtrees\Filter;
use Fisharebest\Webtrees\Functions\Functions;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Individual;
use Fisharebest\Webtrees\Theme;
/**
* Controller for full-page, themed HTML responses
*/
class PageController extends BaseController {
/** @var string Most pages are not intended for robots */
private $meta_robots = 'noindex,nofollow';
/** @var string <head><title> $page_title </title></head> */
private $page_title = WT_WEBTREES;
/** @var bool Is this a popup window? */
private $popup;
/**
* What should this page show in the browser’s title bar?
*
* @param string $page_title
*
* @return $this
*/
public function setPageTitle($page_title) {
$this->page_title = $page_title;
return $this;
}
/**
* Some pages will want to display this as <h1> $page_title </h1>
*
* @return string
*/
public function getPageTitle() {
return $this->page_title;
}
/**
* Should robots index this page?
*
* @param string $meta_robots
*
* @return $this
*/
public function setMetaRobots($meta_robots) {
$this->meta_robots = $meta_robots;
return $this;
}
/**
* Should robots index this page?
*
* @return string
*/
public function getMetaRobots() {
return $this->meta_robots;
}
/**
* Restrict access
*
* @param bool $condition
*
* @return $this
*/
public function restrictAccess($condition) {
if ($condition !== true) {
header('Location: ' . WT_LOGIN_URL . '?url=' . rawurlencode(Functions::getQueryUrl()));
exit;
}
return $this;
}
/**
* Print the page footer, using the theme
*/
public function pageFooter() {
echo
Theme::theme()->footerContainer() .
'<!--[if lt IE 9]><script src="' . WT_JQUERY_JS_URL . '"></script><![endif]-->' .
'<!--[if gte IE 9]><!--><script src="' . WT_JQUERY2_JS_URL . '"></script><!--<![endif]-->' .
'<script src="' . WT_JQUERYUI_JS_URL . '"></script>' .
'<script src="' . WT_WEBTREES_JS_URL . '"></script>' .
$this->getJavascript() .
Theme::theme()->hookFooterExtraJavascript() .
(WT_DEBUG_SQL ? Database::getQueryLog() : '') .
'</body>' .
'</html>' . PHP_EOL .
'<!-- webtrees: ' . WT_VERSION . ' -->' .
'<!-- Execution time: ' . I18N::number(microtime(true) - WT_START_TIME, 3) . ' seconds -->' .
'<!-- Memory: ' . I18N::number(memory_get_peak_usage(true) / 1024) . ' KB -->' .
'<!-- SQL queries: ' . I18N::number(Database::getQueryCount()) . ' -->';
}
/**
* Print the page footer, using the theme
* Note that popup windows are deprecated
*/
public function pageFooterPopupWindow() {
echo
Theme::theme()->footerContainerPopupWindow() .
'<!--[if lt IE 9]><script src="' . WT_JQUERY_JS_URL . '"></script><![endif]-->' .
'<!--[if gte IE 9]><!--><script src="' . WT_JQUERY2_JS_URL . '"></script><!--<![endif]-->' .
'<script src="' . WT_JQUERYUI_JS_URL . '"></script>' .
'<script src="' . WT_WEBTREES_JS_URL . '"></script>' .
$this->getJavascript() .
Theme::theme()->hookFooterExtraJavascript() .
(WT_DEBUG_SQL ? Database::getQueryLog() : '') .
'</body>' .
'</html>' . PHP_EOL .
'<!-- webtrees: ' . WT_VERSION . ' -->' .
'<!-- Execution time: ' . I18N::number(microtime(true) - WT_START_TIME, 3) . ' seconds -->' .
'<!-- Memory: ' . I18N::number(memory_get_peak_usage(true) / 1024) . ' KB -->' .
'<!-- SQL queries: ' . I18N::number(Database::getQueryCount()) . ' -->';
}
/**
* Print the page header, using the theme
*
* @param bool $popup Is this a popup window
*
* @return $this
*/
public function pageHeader($popup = false) {
global $WT_TREE;
$this->popup = $popup;
// Give Javascript access to some PHP constants
$this->addInlineJavascript('
var WT_STATIC_URL = "' . Filter::escapeJs(WT_STATIC_URL) . '";
var WT_MODULES_DIR = "' . Filter::escapeJs(WT_MODULES_DIR) . '";
var WT_GEDCOM = "' . Filter::escapeJs($WT_TREE ? $WT_TREE->getName() : '') . '";
var textDirection = "' . Filter::escapeJs(I18N::direction()) . '";
var WT_SCRIPT_NAME = "' . Filter::escapeJs(WT_SCRIPT_NAME) . '";
var WT_LOCALE = "' . Filter::escapeJs(WT_LOCALE) . '";
var WT_CSRF_TOKEN = "' . Filter::escapeJs(Filter::getCsrfToken()) . '";
', self::JS_PRIORITY_HIGH);
Theme::theme()->sendHeaders();
echo Theme::theme()->doctype();
echo Theme::theme()->html();
echo Theme::theme()->head($this);
if ($this->popup) {
echo Theme::theme()->bodyHeaderPopupWindow();
// We've displayed the header - display the footer automatically
register_shutdown_function(array($this, 'pageFooterPopupWindow'), $this->popup);
} else {
echo Theme::theme()->bodyHeader();
// We've displayed the header - display the footer automatically
register_shutdown_function(array($this, 'pageFooter'), $this->popup);
}
return $this;
}
/**
* Get significant information from this page, to allow other pages such as
* charts and reports to initialise with the same records
*
* @return Individual
*/
public function getSignificantIndividual() {
global $WT_TREE;
static $individual; // Only query the DB once.
if (!$individual && $WT_TREE->getUserPreference(Auth::user(), 'rootid')) {
$individual = Individual::getInstance($WT_TREE->getUserPreference(Auth::user(), 'rootid'), $WT_TREE);
}
if (!$individual && $WT_TREE->getUserPreference(Auth::user(), 'gedcomid')) {
$individual = Individual::getInstance($WT_TREE->getUserPreference(Auth::user(), 'gedcomid'), $WT_TREE);
}
if (!$individual) {
$individual = Individual::getInstance($WT_TREE->getPreference('PEDIGREE_ROOT_ID'), $WT_TREE);
}
if (!$individual) {
$individual = Individual::getInstance(
Database::prepare(
"SELECT MIN(i_id) FROM `##individuals` WHERE i_file=?"
)->execute(array($WT_TREE->getTreeId()))->fetchOne(),
$WT_TREE
);
}
if (!$individual) {
// always return a record
$individual = new Individual('I', '0 @I@ INDI', null, $WT_TREE);
}
return $individual;
}
/**
* Get significant information from this page, to allow other pages such as
* charts and reports to initialise with the same records
*
* @return Family
*/
public function getSignificantFamily() {
$individual = $this->getSignificantIndividual();
if ($individual) {
foreach ($individual->getChildFamilies() as $family) {
return $family;
}
foreach ($individual->getSpouseFamilies() as $family) {
return $family;
}
}
// always return a record
return new Family('F', '0 @F@ FAM', null, $individual->getTree());
}
/**
* Get significant information from this page, to allow other pages such as
* charts and reports to initialise with the same records
*
* @return string
*/
public function getSignificantSurname() {
return '';
}
}