/
View.php
192 lines (166 loc) · 4.45 KB
/
View.php
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
<?php
/**
* @copyright Copyright (c) 2011-2020, The volkszaehler.org project
* @license https://www.gnu.org/licenses/gpl-3.0.txt GNU General Public License version 3
*/
/*
* This file is part of volkzaehler.org
*
* volkzaehler.org 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
* any later version.
*
* volkzaehler.org 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 volkszaehler.org. If not, see <http://www.gnu.org/licenses/>.
*/
namespace Volkszaehler\View;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Volkszaehler\Interpreter;
use Volkszaehler\Model;
use Volkszaehler\Util;
/**
* Base class for all view formats
*
* @author Steffen Vogel <info@steffenvogel.de>
*/
abstract class View {
/**
* Round all values to save bandwidth
*
* @var integer round all values to x decimals
*/
const PRECISION = 3;
/**
* @var Request
*/
protected $request;
/**
* @var Response
*/
protected $response;
/**
* SQL queries analysis result (debug mode)
* @var float
*/
protected $sqlTotalTime;
protected $sqlWorstTime;
/**
* Constructor
*/
public function __construct(Request $request) {
$this->request = $request;
$this->response = new Response();
}
/**
* Get response instance
*/
public function getResponse() {
return $this->response;
}
/**
* Creates exception response
*
* @param \Exception $exception
*/
public function getExceptionResponse(\Throwable $exception) {
$this->add($exception);
// only set status code if default - allows controllers to overwrite
if ($this->response->getStatusCode() == Response::HTTP_OK) {
$this->response->setStatusCode(Response::HTTP_BAD_REQUEST);
}
return $this->send();
}
/**
* Render response and send it to the client
*/
public function send() {
if (Util\Debug::isActivated()) {
$this->add(Util\Debug::getInstance());
}
$this->response->setContent($this->render());
return $this->response;
}
/**
* Sets caching mode for the browser
*
* @todo implement remaining caching modes
* @param string $mode
* @param integer $value timestamp in seconds or offset in seconds
*/
public function setCaching($mode, $value) {
switch ($mode) {
case 'modified': // Last-modified
$this->response->headers->set('Last-Modified', gmdate('D, d M Y H:i:s', $value) . ' GMT');
case 'expires': // Expire
$this->response->headers->set('Expires', gmdate('D, d M Y H:i:s', $value) . ' GMT');
break;
case 'age': // Cache-control: max-age=
$this->response->headers->set('Cache-control', 'max-age=' . $value);
break;
case 'off':
case FALSE:
$this->response->headers->set('Cache-control', 'no-cache');
$this->response->headers->set('Pragma', 'no-cache');
default:
throw new \Exception('Unknown caching mode: \'' . $mode . '\'');
}
}
/**
* Round decimal numbers to given precision
*
* @param number $number float the number
* @return float|string the formatted number
*/
public static function formatNumber($number) {
return is_null($number) ? null : round($number, self::PRECISION);
}
/**
* Format timestamp according to request
* @return mixed
* @throws \Exception
*/
public function formatTimestamp($ts) {
switch ($this->request->query->get('tsfmt')) {
case 'sql':
return strftime('%Y-%m-%d %H:%M:%S', intval($ts/1000));
case 'unix':
case 'ms':
case '':
case NULL:
return 0 + $ts;
default:
throw new \Exception('Unknown tsfmt');
}
}
/**
* Analyze SQL statements
* @param array $queries sql queries from logger
*/
protected function getSQLTimes($queries) {
foreach ($queries as $query) {
$this->sqlTotalTime += $query['executionMS'];
if ($query['executionMS'] > $this->sqlWorstTime) {
$this->sqlWorstTime = $query['executionMS'];
}
}
}
public abstract function add($object);
protected abstract function render();
/**
* Get primitive type or class
*/
public static function getClassOrType($var) {
if ('object' === ($cot = gettype($var))) {
$cot = get_class($var);
}
return $cot;
}
}
?>