1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
|
<?php
// Base controller for all other controllers
//
// webtrees: Web based Family History software
// Copyright (C) 2012 webtrees development team.
//
// Derived from PhpGedView
// Copyright (C) 2002 to 2009 PGV Development Team. All rights reserved.
//
// 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 2 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, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//
// $Id$
if (!defined('WT_WEBTREES')) {
header('HTTP/1.0 403 Forbidden');
exit;
}
class WT_Controller_Base {
// Page header information
const DOCTYPE ='<!DOCTYPE html>'; // HTML5
private $canonical_url='';
private $meta_robots ='noindex,nofollow'; // Most pages are not intended for robots
protected $page_header =false; // Have we printed a page header?
private $page_title =WT_WEBTREES; // <head><title> $page_title </title></head>
// The controller accumulates Javascript (inline and external), and renders it in the footer
const JS_PRIORITY_HIGH = 0;
const JS_PRIORITY_NORMAL = 1;
const JS_PRIORITY_LOW = 2;
private $inline_javascript=array(
self::JS_PRIORITY_HIGH =>array(),
self::JS_PRIORITY_NORMAL=>array(),
self::JS_PRIORITY_LOW =>array(),
);
private $external_javascript=array();
// Startup activity
public function __construct() {
// (almost?) every page uses these scripts....
$this
->addExternalJavascript(WT_STATIC_URL.'js/webtrees.js')
->addExternalJavascript(WT_JQUERY_URL)
->addExternalJavascript(WT_JQUERYUI_URL);
}
// Shutdown activity
public function __destruct() {
// If we printed a header, automatically print a footer
if ($this->page_header) {
$this->pageFooter();
}
}
// What should this page show in the browser's title bar?
public function setPageTitle($page_title) {
$this->page_title=$page_title;
return $this;
}
// Some pages will want to display this as <h2> $page_title </h2>
public function getPageTitle() {
return $this->page_title;
}
// What is the preferred URL for this page?
public function setCanonicalUrl($canonical_url) {
$this->canonical_url=$canonical_url;
return $this;
}
// Should robots index this page?
public function setMetaRobots($meta_robots) {
$this->meta_robots=$meta_robots;
return $this;
}
// Restrict access
public function requireAdminLogin() {
require_once WT_ROOT.'includes/functions/functions.php'; // for get_query_url
if (!WT_USER_IS_ADMIN) {
header('Location: '.WT_LOGIN_URL.'?url='.rawurlencode(get_query_url()));
exit;
}
return $this;
}
// Restrict access
public function requireManagerLogin($ged_id=WT_GED_ID) {
require_once WT_ROOT.'includes/functions/functions.php'; // for get_query_url
if (
$ged_id==WT_GED_ID && !WT_USER_GEDCOM_ADMIN ||
$ged_id!=WT_GED_ID && userGedcomAdmin(WT_USER_ID, $gedcom_id)
) {
header('Location: '.WT_LOGIN_URL.'?url='.rawurlencode(get_query_url()));
exit;
}
return $this;
}
// Restrict access
public function requireAcceptLogin() {
require_once WT_ROOT.'includes/functions/functions.php'; // for get_query_url
if (!WT_USER_CAN_ACCEPT) {
header('Location: '.WT_LOGIN_URL.'?url='.rawurlencode(get_query_url()));
exit;
}
return $this;
}
// Restrict access
public function requireEditorLogin() {
require_once WT_ROOT.'includes/functions/functions.php'; // for get_query_url
if (!WT_USER_CAN_EDIT) {
header('Location: '.WT_LOGIN_URL.'?url='.rawurlencode(get_query_url()));
exit;
}
return $this;
}
// Restrict access
public function requireMemberLogin() {
require_once WT_ROOT.'includes/functions/functions.php'; // for get_query_url
if (!WT_USER_ID) {
header('Location: '.WT_LOGIN_URL.'?url='.rawurlencode(get_query_url()));
exit;
}
return $this;
}
// Make a list of external Javascript, so we can render them in the footer
public function addExternalJavascript($script_name) {
$this->external_javascript[$script_name]=true;
return $this;
}
// Make a list of inline Javascript, so we can render them in the footer
// NOTE: there is no need to use "jQuery(document).ready(function(){...})", etc.
// as this Javascript won't be inserted until the very end of the page.
public function addInlineJavascript($script, $priority=self::JS_PRIORITY_NORMAL) {
if (WT_DEBUG) {
/* Show where the JS was added */
$backtrace=debug_backtrace();
$script='/* '.$backtrace[0]['file'].':'.$backtrace[0]['line'].' */'.PHP_EOL.$script;
}
$tmp=&$this->inline_javascript[$priority];
$tmp[]=$script;
return $this;
}
// We've collected up Javascript fragments while rendering the page.
// Now display them.
public function getJavascript() {
// Modernizr.load() doesn't seem to work well with AJAX responses.
// Temporarily disable this while we investigate
$TMP_HTML='';
$TMP_JS='';
$html='';
// Insert the high priority scripts before external resources
if ($this->inline_javascript[self::JS_PRIORITY_HIGH]) {
$html.=PHP_EOL.'<script>';
foreach ($this->inline_javascript[self::JS_PRIORITY_HIGH] as $script) {
$html.=$script;
$TMP_JS.=$script;
}
$html.='</script>';
$this->inline_javascript[self::JS_PRIORITY_HIGH] = array();
}
// Load external libraries asynchronously
$load_js=array();
foreach (array_keys($this->external_javascript) as $script_name) {
$load_js[]='"'.$script_name.'"';
$TMP_HTML.='<script src="'.htmlspecialchars($script_name).'"></script>';
}
$load_js='[' . implode(',', $load_js) . ']';
// Process the scripts, in priority order, after the libraries have loaded
$complete_js='';
if ($this->inline_javascript) {
foreach ($this->inline_javascript as $scripts) {
foreach ($scripts as $script) {
$complete_js.=$script;
}
}
}
// We could, in theory, inject JS at any point in the page (not just the bottom) - prepare for next time
$this->inline_javascript=array(
self::JS_PRIORITY_HIGH =>array(),
self::JS_PRIORITY_NORMAL=>array(),
self::JS_PRIORITY_LOW =>array(),
);
$this->external_javascript=array();
return '<script>' . $TMP_JS . '</script>' . $TMP_HTML . '<script>' . $complete_js . '</script>';
return $html . '<script>Modernizr.load({load:' . $load_js . ',complete:function(){' . $complete_js . '}});</script>';
}
// Print the page header, using the theme
public function pageHeader() {
// Import global variables into the local scope, for the theme's header.php
global $BROWSERTYPE, $SEARCH_SPIDER, $TEXT_DIRECTION, $REQUIRE_AUTHENTICATION;
global $stylesheet, $headerfile, $view;
// The title often includes the names of records, which may have markup
// that cannot be used in the page title.
$title=html_entity_decode(strip_tags($this->page_title), ENT_QUOTES, 'UTF-8');
// Initialise variables for the theme's header.php
$LINK_CANONICAL =$this->canonical_url;
$META_ROBOTS =$this->meta_robots;
$META_DESCRIPTION=get_gedcom_setting(WT_GED_ID, 'META_DESCRIPTION', WT_TREE_TITLE);
$META_GENERATOR =WT_WEBTREES.'-'.WT_VERSION_TEXT.' - '.WT_WEBTREES_URL;
$META_TITLE =get_gedcom_setting(WT_GED_ID, 'META_TITLE');
if ($META_TITLE) {
$title.=' - '.$META_TITLE;
}
// This javascript needs to be loaded in the header, *before* the CSS.
// All other javascript should be defered until the end of the page
$javascript= '<script src="'.WT_STATIC_URL.'js/modernizr.custom-2.6.1.js"></script>';
// Give Javascript access to some PHP constants
$this->addInlineJavascript('
var WT_STATIC_URL = "'.WT_STATIC_URL.'";
var WT_THEME_DIR = "'.WT_THEME_DIR.'";
var WT_MODULES_DIR = "'.WT_MODULES_DIR.'";
var WT_GEDCOM = "'.WT_GEDCOM.'";
var WT_GED_ID = "'.WT_GED_ID.'";
var WT_USER_ID = "'.WT_USER_ID.'";
var textDirection = "'.$TEXT_DIRECTION.'";
var browserType = "'.$BROWSERTYPE.'";
var WT_SCRIPT_NAME = "'.WT_SCRIPT_NAME.'";
var WT_LOCALE = "'.WT_LOCALE.'";
var accesstime = '.WT_DB::prepare("SELECT UNIX_TIMESTAMP(NOW())")->fetchOne().';
', self::JS_PRIORITY_HIGH);
// Temporary fix for access to main menu hover elements on android touch devices
$this->addInlineJavascript('
var ua = navigator.userAgent.toLowerCase();
var isAndroid = ua.indexOf("android") > -1;
if(isAndroid) {
jQuery("#main-menu > li > a").attr("href", "#");
jQuery("a.icon_arrow").attr("href", "#");
}
');
// Tell IE to use standards mode instead of compatability mode.
if ($BROWSERTYPE=='msie') {
header("X-UA-Compatible: IE=Edge");
}
header('Content-Type: text/html; charset=UTF-8');
require WT_ROOT.$headerfile;
// Flush the output, so the browser can render the header and load javascript
// while we are preparing data for the page
if (ini_get('output_buffering')) {
ob_flush();
}
flush();
// Once we've displayed the header, we should no longer write session data.
Zend_Session::writeClose();
// We've displayed the header - display the footer automatically
$this->page_header=true;
return $this;
}
// Print the page footer, using the theme
protected function pageFooter() {
global $footerfile, $TEXT_DIRECTION, $view;
require WT_ROOT.$footerfile;
if (WT_DEBUG_SQL) {
echo WT_DB::getQueryLog();
}
echo $this->getJavascript();
echo '</body></html>';
return $this;
}
// Get significant information from this page, to allow other pages such as
// charts and reports to initialise with the same records
public function getSignificantIndividual() {
static $individual; // Only query the DB once.
if (!$individual && WT_USER_ROOT_ID) {
$individual=WT_Person::getInstance(WT_USER_ROOT_ID);
}
if (!$individual && WT_USER_GEDCOM_ID) {
$individual=WT_Person::getInstance(WT_USER_GEDCOM_ID);
}
if (!$individual) {
$individual=WT_Person::getInstance(get_gedcom_setting(WT_GED_ID, 'PEDIGREE_ROOT_ID'));
}
if (!$individual) {
$individual=WT_Person::getInstance(
WT_DB::prepare(
"SELECT MIN(i_id) FROM `##individuals` WHERE i_file=?"
)->execute(array(WT_GED_ID))->fetchOne()
);
}
if (!$individual) {
// always return a record
$individual=new WT_Person('0 @I@ INDI');
}
return $individual;
}
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 WT_Family('0 @F@ FAM');
}
public function getSignificantSurname() {
return '';
}
}
|
