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
|
<?php
/**
* Piwik - Open source web analytics
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
* @version $Id$
*
* @category Piwik
* @package Piwik
*/
/**
* Transition for pre-Piwik 0.4.4
*/
if(!defined('PIWIK_USER_PATH'))
{
define('PIWIK_USER_PATH', PIWIK_INCLUDE_PATH);
}
/**
* View class to render the user interface
*
* @package Piwik
*/
class Piwik_View implements Piwik_View_Interface
{
// view types
const STANDARD = 0; // REGULAR, FULL, CLASSIC
const MOBILE = 1;
const CLI = 2;
const COREUPDATER_ONE_CLICK_DONE = 'update_one_click_done';
private $template = '';
private $smarty = false;
private $contentType = 'text/html; charset=utf-8';
private $xFrameOptions = null;
public function __construct( $templateFile, $smConf = array(), $filter = true )
{
$this->template = $templateFile;
$this->smarty = new Piwik_Smarty($smConf, $filter);
// global value accessible to all templates: the piwik base URL for the current request
$this->piwik_version = Piwik_Version::VERSION;
$this->cacheBuster = md5(Piwik_Common::getSalt() . PHP_VERSION . Piwik_Version::VERSION);
$this->piwikUrl = Piwik_Common::sanitizeInputValue(Piwik_Url::getCurrentUrlWithoutFileName());
}
/**
* Directly assigns a variable to the view script.
* VAR names may not be prefixed with '_'.
*
* @param string $key The variable name.
* @param mixed $val The variable value.
*/
public function __set($key, $val)
{
$this->smarty->assign($key, $val);
}
/**
* Retrieves an assigned variable.
* VAR names may not be prefixed with '_'.
*
* @param string $key The variable name.
* @return mixed The variable value.
*/
public function __get($key)
{
return $this->smarty->get_template_vars($key);
}
/**
* Renders the current view.
*
* @return string Generated template
*/
public function render()
{
try {
$this->currentModule = Piwik::getModule();
$this->currentAction = Piwik::getAction();
$userLogin = Piwik::getCurrentUserLogin();
$this->userLogin = $userLogin;
$count = Piwik::getWebsitesCountToDisplay();
$sites = Piwik_SitesManager_API::getInstance()->getSitesWithAtLeastViewAccess($count);
usort($sites, create_function('$site1, $site2', 'return strcasecmp($site1["name"], $site2["name"]);'));
$this->sites = $sites;
$this->url = Piwik_Common::sanitizeInputValue(Piwik_Url::getCurrentUrl());
$this->token_auth = Piwik::getCurrentUserTokenAuth();
$this->userHasSomeAdminAccess = Piwik::isUserHasSomeAdminAccess();
$this->userIsSuperUser = Piwik::isUserIsSuperUser();
$this->latest_version_available = Piwik_UpdateCheck::isNewestVersionAvailable();
$this->disableLink = Piwik_Common::getRequestVar('disableLink', 0, 'int');
$this->isWidget = Piwik_Common::getRequestVar('widget', 0, 'int');
if(Piwik_Config::getInstance()->General['autocomplete_min_sites'] <= count($sites))
{
$this->show_autocompleter = true;
}
else
{
$this->show_autocompleter = false;
}
$this->loginModule = Piwik::getLoginPluginName();
$user = Piwik_UsersManager_API::getInstance()->getUser($userLogin);
$this->userAlias = $user['alias'];
} catch(Exception $e) {
// can fail, for example at installation (no plugin loaded yet)
}
$this->totalTimeGeneration = Zend_Registry::get('timer')->getTime();
try {
$this->totalNumberOfQueries = Piwik::getQueryCount();
}
catch(Exception $e){
$this->totalNumberOfQueries = 0;
}
Piwik::overrideCacheControlHeaders('no-store');
@header('Content-Type: '.$this->contentType);
// always sending this header, sometimes empty, to ensure that Dashboard embed loads (which could call this header() multiple times, the last one will prevail)
@header('X-Frame-Options: '. (string)$this->xFrameOptions);
return $this->smarty->fetch($this->template);
}
/**
* Set Content-Type field in HTTP response.
* Since PHP 5.1.2, header() protects against header injection attacks.
*
* @param string $contentType
*/
public function setContentType( $contentType )
{
$this->contentType = $contentType;
}
/**
* Set X-Frame-Options field in the HTTP response.
*
* @param string $option ('deny' or 'sameorigin')
*/
public function setXFrameOptions( $option = 'deny' )
{
if($option === 'deny' || $option === 'sameorigin')
{
$this->xFrameOptions = $option;
}
if($option == 'allow')
{
$this->xFrameOptions = null;
}
}
/**
* Add form to view
*
* @param Piwik_QuickForm2 $form
*/
public function addForm( $form )
{
if($form instanceof Piwik_QuickForm2)
{
// assign array with form data
$this->smarty->assign('form_data', $form->getFormData());
$this->smarty->assign('element_list', $form->getElementList());
}
}
/**
* Assign value to a variable for use in Smarty template
*
* @param string|array $var
* @param mixed $value
*/
public function assign($var, $value=null)
{
if (is_string($var))
{
$this->smarty->assign($var, $value);
}
elseif (is_array($var))
{
foreach ($var as $key => $value)
{
$this->smarty->assign($key, $value);
}
}
}
/**
* Clear compiled Smarty templates
*/
static public function clearCompiledTemplates()
{
$view = new Piwik_View(null);
$view->smarty->clear_compiled_tpl();
}
/*
public function isCached($template)
{
if ($this->smarty->is_cached($template))
{
return true;
}
return false;
}
public function setCaching($caching)
{
$this->smarty->caching = $caching;
}
*/
/**
* Render the single report template
*
* @param string $title Report title
* @param string $reportHtml Report body
* @param bool $fetch If true, return report contents as a string; else echo to screen
* @return string Report contents if $fetch == true
*/
static public function singleReport($title, $reportHtml, $fetch = false)
{
$view = new Piwik_View('CoreHome/templates/single_report.tpl');
$view->title = $title;
$view->report = $reportHtml;
if ($fetch)
{
return $view->render();
}
echo $view->render();
}
/**
* View factory method
*
* @param string $templateName Template name (e.g., 'index')
* @param int $viewType View type (e.g., Piwik_View::CLI)
* @throws Exception
* @return Piwik_View|Piwik_View_OneClickDone
*/
static public function factory( $templateName = null, $viewType = null)
{
if ($templateName == self::COREUPDATER_ONE_CLICK_DONE)
{
return new Piwik_View_OneClickDone(Piwik::getCurrentUserTokenAuth());
}
Piwik_PostEvent('View.getViewType', $viewType);
// get caller
$bt = @debug_backtrace();
if($bt === null || !isset($bt[0]))
{
throw new Exception("View factory cannot be invoked");
}
$path = dirname($bt[0]['file']);
// determine best view type
if($viewType === null)
{
if(Piwik_Common::isPhpCliMode())
{
$viewType = self::CLI;
}
else
{
$viewType = self::STANDARD;
}
}
// get template filename
if($viewType == self::CLI)
{
$templateFile = $path.'/templates/cli_'.$templateName.'.tpl';
if(file_exists($templateFile))
{
return new Piwik_View($templateFile, array(), false);
}
$viewType = self::STANDARD;
}
if($viewType == self::MOBILE)
{
$templateFile = $path.'/templates/mobile_'.$templateName.'.tpl';
if(!file_exists($templateFile))
{
$viewType = self::STANDARD;
}
}
if($viewType != self::MOBILE)
{
$templateFile = $path.'/templates/'.$templateName.'.tpl';
}
// Specified template not found
// We allow for no specified template
if(!empty($templateName)
&& !file_exists($templateFile))
{
throw new Exception('Template not found: '.$templateFile);
}
return new Piwik_View($templateFile);
}
}
|