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
|
<?php
// Base controller for all other controllers
//
// webtrees: Web based Family History software
// Copyright (C) 2013 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 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 {
// 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();
private $external_stylesheet = array();
protected $page_header = false; // Have we printed a page header?
// Startup activity
public function __construct() {
}
// Shutdown activity
public function __destruct() {
// If we printed a header, automatically print a footer
if ($this->page_header) {
$this->pageFooter();
}
}
// 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 external stylesheets, so we can render them in the header
public function addExternalStylesheet($stylesheet, $attributes=array()) {
$this->external_stylesheet[$stylesheet]=$attributes;
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() {
// 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() {
if (WT_DEBUG_SQL) {
echo WT_DB::getQueryLog();
}
echo $this->getJavascript();
}
}
|
