@@ -92,36 +92,36 @@ discard block |
||
| 92 | 92 | /** |
| 93 | 93 | * Construct the new Router instance |
| 94 | 94 | */ |
| 95 | - public function __construct(){ |
|
| 96 | - $this->logger =& class_loader('Log', 'classes'); |
|
| 95 | + public function __construct() { |
|
| 96 | + $this->logger = & class_loader('Log', 'classes'); |
|
| 97 | 97 | $this->logger->setLogger('Library::Router'); |
| 98 | 98 | $routesPath = CONFIG_PATH . 'routes.php'; |
| 99 | 99 | $this->logger->debug('Loading of routes configuration file --> ' . $routesPath . ' ...'); |
| 100 | - if(file_exists($routesPath)){ |
|
| 101 | - $this->logger->info('Found routes configuration file --> ' . $routesPath. ' now load it'); |
|
| 100 | + if (file_exists($routesPath)) { |
|
| 101 | + $this->logger->info('Found routes configuration file --> ' . $routesPath . ' now load it'); |
|
| 102 | 102 | require_once $routesPath; |
| 103 | - if(! empty($route) && is_array($route)){ |
|
| 103 | + if (!empty($route) && is_array($route)) { |
|
| 104 | 104 | $this->routes = $route; |
| 105 | 105 | unset($route); |
| 106 | 106 | } |
| 107 | 107 | } |
| 108 | - else{ |
|
| 108 | + else { |
|
| 109 | 109 | show_error('Unable to find the routes configuration file [' . $routesPath . ']'); |
| 110 | 110 | } |
| 111 | 111 | |
| 112 | 112 | //loading routes for module |
| 113 | 113 | $this->logger->debug('Loading of modules routes ... '); |
| 114 | 114 | $modulesRoutes = Module::getModulesRoutes(); |
| 115 | - if($modulesRoutes && is_array($modulesRoutes)){ |
|
| 115 | + if ($modulesRoutes && is_array($modulesRoutes)) { |
|
| 116 | 116 | $this->routes = array_merge($this->routes, $modulesRoutes); |
| 117 | 117 | $this->logger->info('Routes for all modules loaded successfully'); |
| 118 | 118 | } |
| 119 | - else{ |
|
| 119 | + else { |
|
| 120 | 120 | $this->logger->info('No routes found for all modules skipping.'); |
| 121 | 121 | } |
| 122 | 122 | $this->logger->info('The routes configuration are listed below: ' . stringfy_vars($this->routes)); |
| 123 | 123 | |
| 124 | - foreach($this->routes as $pattern => $callback){ |
|
| 124 | + foreach ($this->routes as $pattern => $callback) { |
|
| 125 | 125 | $this->add($pattern, $callback); |
| 126 | 126 | } |
| 127 | 127 | |
@@ -129,14 +129,14 @@ discard block |
||
| 129 | 129 | $uri = isset($_SERVER['REQUEST_URI']) ? $_SERVER['REQUEST_URI'] : ''; |
| 130 | 130 | $this->logger->debug('Check if URL suffix is enabled in the configuration'); |
| 131 | 131 | //remove url suffix from the request URI |
| 132 | - if($suffix = get_config('url_suffix')){ |
|
| 133 | - $this->logger->info('URL suffix is enabled in the configuration, the value is [' . $suffix . ']' ); |
|
| 132 | + if ($suffix = get_config('url_suffix')) { |
|
| 133 | + $this->logger->info('URL suffix is enabled in the configuration, the value is [' . $suffix . ']'); |
|
| 134 | 134 | $uri = str_ireplace($suffix, '', $uri); |
| 135 | 135 | } |
| 136 | - else{ |
|
| 136 | + else { |
|
| 137 | 137 | $this->logger->info('URL suffix is not enabled in the configuration'); |
| 138 | 138 | } |
| 139 | - if(strpos($uri, '?') !== false){ |
|
| 139 | + if (strpos($uri, '?') !== false) { |
|
| 140 | 140 | $uri = substr($uri, 0, strpos($uri, '?')); |
| 141 | 141 | } |
| 142 | 142 | $uri = trim($uri, $this->uriTrim); |
@@ -151,7 +151,7 @@ discard block |
||
| 151 | 151 | */ |
| 152 | 152 | public function add($uri, $callback) { |
| 153 | 153 | $uri = trim($uri, $this->uriTrim); |
| 154 | - if(in_array($uri, $this->pattern)){ |
|
| 154 | + if (in_array($uri, $this->pattern)) { |
|
| 155 | 155 | $this->logger->warning('The route [' . $uri . '] already added, may be adding again can have route conflict'); |
| 156 | 156 | } |
| 157 | 157 | $this->pattern[] = $uri; |
@@ -162,7 +162,7 @@ discard block |
||
| 162 | 162 | * Get the module name |
| 163 | 163 | * @return string |
| 164 | 164 | */ |
| 165 | - public function getModule(){ |
|
| 165 | + public function getModule() { |
|
| 166 | 166 | return $this->module; |
| 167 | 167 | } |
| 168 | 168 | |
@@ -170,7 +170,7 @@ discard block |
||
| 170 | 170 | * Get the controller name |
| 171 | 171 | * @return string |
| 172 | 172 | */ |
| 173 | - public function getController(){ |
|
| 173 | + public function getController() { |
|
| 174 | 174 | return $this->controller; |
| 175 | 175 | } |
| 176 | 176 | |
@@ -178,7 +178,7 @@ discard block |
||
| 178 | 178 | * Get the controller file path |
| 179 | 179 | * @return string |
| 180 | 180 | */ |
| 181 | - public function getControllerPath(){ |
|
| 181 | + public function getControllerPath() { |
|
| 182 | 182 | return $this->controllerPath; |
| 183 | 183 | } |
| 184 | 184 | |
@@ -186,7 +186,7 @@ discard block |
||
| 186 | 186 | * Get the controller method |
| 187 | 187 | * @return string |
| 188 | 188 | */ |
| 189 | - public function getMethod(){ |
|
| 189 | + public function getMethod() { |
|
| 190 | 190 | return $this->method; |
| 191 | 191 | } |
| 192 | 192 | |
@@ -194,7 +194,7 @@ discard block |
||
| 194 | 194 | * Get the request arguments |
| 195 | 195 | * @return array |
| 196 | 196 | */ |
| 197 | - public function getArgs(){ |
|
| 197 | + public function getArgs() { |
|
| 198 | 198 | return $this->args; |
| 199 | 199 | } |
| 200 | 200 | |
@@ -202,7 +202,7 @@ discard block |
||
| 202 | 202 | * Get the URL segments array |
| 203 | 203 | * @return array |
| 204 | 204 | */ |
| 205 | - public function getSegments(){ |
|
| 205 | + public function getSegments() { |
|
| 206 | 206 | return $this->segments; |
| 207 | 207 | } |
| 208 | 208 | |
@@ -211,27 +211,27 @@ discard block |
||
| 211 | 211 | * otherwise send 404 error. |
| 212 | 212 | */ |
| 213 | 213 | public function run() { |
| 214 | - $benchmark =& class_loader('Benchmark'); |
|
| 214 | + $benchmark = & class_loader('Benchmark'); |
|
| 215 | 215 | $benchmark->mark('ROUTING_PROCESS_START'); |
| 216 | 216 | $this->logger->debug('Routing process start ...'); |
| 217 | 217 | $segment = $this->segments; |
| 218 | 218 | $baseUrl = get_config('base_url'); |
| 219 | 219 | //check if the app is not in DOCUMENT_ROOT |
| 220 | - if(isset($segment[0]) && stripos($baseUrl, $segment[0]) != false){ |
|
| 220 | + if (isset($segment[0]) && stripos($baseUrl, $segment[0]) != false) { |
|
| 221 | 221 | array_shift($segment); |
| 222 | 222 | $this->segments = $segment; |
| 223 | 223 | } |
| 224 | 224 | $this->logger->debug('Check if the request URI contains the front controller'); |
| 225 | - if(isset($segment[0]) && $segment[0] == SELF){ |
|
| 225 | + if (isset($segment[0]) && $segment[0] == SELF) { |
|
| 226 | 226 | $this->logger->info('The request URI contains the front controller'); |
| 227 | 227 | array_shift($segment); |
| 228 | 228 | $this->segments = $segment; |
| 229 | 229 | } |
| 230 | - else{ |
|
| 230 | + else { |
|
| 231 | 231 | $this->logger->info('The request URI does not contain the front controller'); |
| 232 | 232 | } |
| 233 | 233 | $uri = implode('/', $segment); |
| 234 | - $this->logger->info('The final Request URI is [' . $uri . ']' ); |
|
| 234 | + $this->logger->info('The final Request URI is [' . $uri . ']'); |
|
| 235 | 235 | //generic routes |
| 236 | 236 | $pattern = array(':num', ':alpha', ':alnum', ':any'); |
| 237 | 237 | $replace = array('[0-9]+', '[a-zA-Z]+', '[a-zA-Z0-9]+', '.*'); |
@@ -245,20 +245,20 @@ discard block |
||
| 245 | 245 | array_shift($args); |
| 246 | 246 | //check if this contains an module |
| 247 | 247 | $moduleControllerMethod = explode('#', $this->callback[$index]); |
| 248 | - if(is_array($moduleControllerMethod) && count($moduleControllerMethod) >= 2){ |
|
| 249 | - $this->logger->info('The current request use the module [' .$moduleControllerMethod[0]. ']'); |
|
| 248 | + if (is_array($moduleControllerMethod) && count($moduleControllerMethod) >= 2) { |
|
| 249 | + $this->logger->info('The current request use the module [' . $moduleControllerMethod[0] . ']'); |
|
| 250 | 250 | $this->module = $moduleControllerMethod[0]; |
| 251 | 251 | $moduleControllerMethod = explode('@', $moduleControllerMethod[1]); |
| 252 | 252 | } |
| 253 | - else{ |
|
| 253 | + else { |
|
| 254 | 254 | $this->logger->info('The current request does not use the module'); |
| 255 | 255 | $moduleControllerMethod = explode('@', $this->callback[$index]); |
| 256 | 256 | } |
| 257 | - if(is_array($moduleControllerMethod)){ |
|
| 258 | - if(isset($moduleControllerMethod[0])){ |
|
| 257 | + if (is_array($moduleControllerMethod)) { |
|
| 258 | + if (isset($moduleControllerMethod[0])) { |
|
| 259 | 259 | $this->controller = $moduleControllerMethod[0]; |
| 260 | 260 | } |
| 261 | - if(isset($moduleControllerMethod[1])){ |
|
| 261 | + if (isset($moduleControllerMethod[1])) { |
|
| 262 | 262 | $this->method = $moduleControllerMethod[1]; |
| 263 | 263 | } |
| 264 | 264 | $this->args = $args; |
@@ -268,73 +268,73 @@ discard block |
||
| 268 | 268 | } |
| 269 | 269 | } |
| 270 | 270 | //first if the controller is not set and the module is set use the module name as the controller |
| 271 | - if(! $this->getController() && $this->getModule()){ |
|
| 271 | + if (!$this->getController() && $this->getModule()) { |
|
| 272 | 272 | $this->logger->info('After loop in predefined routes configuration, the module name is set but the controller is not set, so we will use module as the controller'); |
| 273 | 273 | $this->controller = $this->getModule(); |
| 274 | 274 | } |
| 275 | 275 | //if can not determine the module/controller/method via the defined routes configuration we will use |
| 276 | 276 | //the URL like http://domain.com/module/controller/method/arg1/arg2 |
| 277 | - if(! $this->getController()){ |
|
| 277 | + if (!$this->getController()) { |
|
| 278 | 278 | $this->logger->info('Cannot determine the routing information using the predefined routes configuration, will use the request URI parameters'); |
| 279 | 279 | $nbSegment = count($segment); |
| 280 | 280 | //if segment is null so means no need to perform |
| 281 | - if($nbSegment > 0){ |
|
| 281 | + if ($nbSegment > 0) { |
|
| 282 | 282 | //get the module list |
| 283 | 283 | $modules = Module::getModuleList(); |
| 284 | 284 | //first check if no module |
| 285 | - if(! $modules){ |
|
| 285 | + if (!$modules) { |
|
| 286 | 286 | $this->logger->info('No module was loaded will skip the module checking'); |
| 287 | 287 | //the application don't use module |
| 288 | 288 | //controller |
| 289 | - if(isset($segment[0])){ |
|
| 289 | + if (isset($segment[0])) { |
|
| 290 | 290 | $this->controller = $segment[0]; |
| 291 | 291 | array_shift($segment); |
| 292 | 292 | } |
| 293 | 293 | //method |
| 294 | - if(isset($segment[0])){ |
|
| 294 | + if (isset($segment[0])) { |
|
| 295 | 295 | $this->method = $segment[0]; |
| 296 | 296 | array_shift($segment); |
| 297 | 297 | } |
| 298 | 298 | //args |
| 299 | 299 | $this->args = $segment; |
| 300 | 300 | } |
| 301 | - else{ |
|
| 301 | + else { |
|
| 302 | 302 | $this->logger->info('The application contains a loaded module will check if the current request is found in the module list'); |
| 303 | - if(in_array($segment[0], $modules)){ |
|
| 303 | + if (in_array($segment[0], $modules)) { |
|
| 304 | 304 | $this->logger->info('Found, the current request use the module [' . $segment[0] . ']'); |
| 305 | 305 | $this->module = $segment[0]; |
| 306 | 306 | array_shift($segment); |
| 307 | 307 | //check if the second arg is the controller from module |
| 308 | - if(isset($segment[0])){ |
|
| 308 | + if (isset($segment[0])) { |
|
| 309 | 309 | $this->controller = $segment[0]; |
| 310 | 310 | //check if the request use the same module name and controller |
| 311 | 311 | $path = Module::findControllerFullPath(ucfirst($this->getController()), $this->getModule()); |
| 312 | - if(! $path){ |
|
| 312 | + if (!$path) { |
|
| 313 | 313 | $this->logger->info('The controller [' . $this->getController() . '] not found in the module, may be will use the module [' . $this->getModule() . '] as controller'); |
| 314 | 314 | $this->controller = $this->getModule(); |
| 315 | 315 | } |
| 316 | - else{ |
|
| 316 | + else { |
|
| 317 | 317 | $this->controllerPath = $path; |
| 318 | 318 | array_shift($segment); |
| 319 | 319 | } |
| 320 | 320 | } |
| 321 | 321 | //check for method |
| 322 | - if(isset($segment[0])){ |
|
| 322 | + if (isset($segment[0])) { |
|
| 323 | 323 | $this->method = $segment[0]; |
| 324 | 324 | array_shift($segment); |
| 325 | 325 | } |
| 326 | 326 | //the remaining is for args |
| 327 | 327 | $this->args = $segment; |
| 328 | 328 | } |
| 329 | - else{ |
|
| 329 | + else { |
|
| 330 | 330 | $this->logger->info('The current request information is not found in the module list'); |
| 331 | 331 | //controller |
| 332 | - if(isset($segment[0])){ |
|
| 332 | + if (isset($segment[0])) { |
|
| 333 | 333 | $this->controller = $segment[0]; |
| 334 | 334 | array_shift($segment); |
| 335 | 335 | } |
| 336 | 336 | //method |
| 337 | - if(isset($segment[0])){ |
|
| 337 | + if (isset($segment[0])) { |
|
| 338 | 338 | $this->method = $segment[0]; |
| 339 | 339 | array_shift($segment); |
| 340 | 340 | } |
@@ -344,18 +344,18 @@ discard block |
||
| 344 | 344 | } |
| 345 | 345 | } |
| 346 | 346 | } |
| 347 | - if(! $this->getController() && $this->getModule()){ |
|
| 347 | + if (!$this->getController() && $this->getModule()) { |
|
| 348 | 348 | $this->logger->info('After using the request URI the module name is set but the controller is not set so we will use module as the controller'); |
| 349 | 349 | $this->controller = $this->getModule(); |
| 350 | 350 | } |
| 351 | 351 | //did we set the controller, so set the controller path |
| 352 | - if($this->getController() && ! $this->getControllerPath()){ |
|
| 352 | + if ($this->getController() && !$this->getControllerPath()) { |
|
| 353 | 353 | $this->logger->debug('Setting the file path for the controller [' . $this->getController() . ']'); |
| 354 | 354 | //if it is the module controller |
| 355 | - if($this->getModule()){ |
|
| 355 | + if ($this->getModule()) { |
|
| 356 | 356 | $this->controllerPath = Module::findControllerFullPath(ucfirst($this->getController()), $this->getModule()); |
| 357 | 357 | } |
| 358 | - else{ |
|
| 358 | + else { |
|
| 359 | 359 | $this->controllerPath = APPS_CONTROLLER_PATH . ucfirst($this->getController()) . '.php'; |
| 360 | 360 | } |
| 361 | 361 | } |
@@ -365,20 +365,20 @@ discard block |
||
| 365 | 365 | $this->logger->debug('Loading controller [' . $controller . '], the file path is [' . $classFilePath . ']...'); |
| 366 | 366 | $benchmark->mark('ROUTING_PROCESS_END'); |
| 367 | 367 | $e404 = false; |
| 368 | - if(file_exists($classFilePath)){ |
|
| 368 | + if (file_exists($classFilePath)) { |
|
| 369 | 369 | require_once $classFilePath; |
| 370 | - if(! class_exists($controller, false)){ |
|
| 370 | + if (!class_exists($controller, false)) { |
|
| 371 | 371 | $e404 = true; |
| 372 | - $this->logger->info('The controller file [' .$classFilePath. '] exists but does not contain the class [' . $controller . ']'); |
|
| 372 | + $this->logger->info('The controller file [' . $classFilePath . '] exists but does not contain the class [' . $controller . ']'); |
|
| 373 | 373 | } |
| 374 | - else{ |
|
| 374 | + else { |
|
| 375 | 375 | $controllerInstance = new $controller(); |
| 376 | 376 | $controllerMethod = $this->getMethod(); |
| 377 | - if(! method_exists($controllerInstance, $controllerMethod)){ |
|
| 377 | + if (!method_exists($controllerInstance, $controllerMethod)) { |
|
| 378 | 378 | $e404 = true; |
| 379 | 379 | $this->logger->info('The controller [' . $controller . '] exist but does not contain the method [' . $controllerMethod . ']'); |
| 380 | 380 | } |
| 381 | - else{ |
|
| 381 | + else { |
|
| 382 | 382 | $this->logger->info('Routing data is set correctly now GO!'); |
| 383 | 383 | call_user_func_array(array($controllerInstance, $controllerMethod), $this->getArgs()); |
| 384 | 384 | $obj = & get_instance(); |
@@ -388,12 +388,12 @@ discard block |
||
| 388 | 388 | } |
| 389 | 389 | } |
| 390 | 390 | } |
| 391 | - else{ |
|
| 391 | + else { |
|
| 392 | 392 | $this->logger->info('The controller file path [' . $classFilePath . '] does not exist'); |
| 393 | 393 | $e404 = true; |
| 394 | 394 | } |
| 395 | - if($e404){ |
|
| 396 | - $response =& class_loader('Response', 'classes'); |
|
| 395 | + if ($e404) { |
|
| 396 | + $response = & class_loader('Response', 'classes'); |
|
| 397 | 397 | $response->send404(); |
| 398 | 398 | } |
| 399 | 399 | } |
@@ -24,7 +24,7 @@ discard block |
||
| 24 | 24 | * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
| 25 | 25 | */ |
| 26 | 26 | |
| 27 | - class Log{ |
|
| 27 | + class Log { |
|
| 28 | 28 | |
| 29 | 29 | /** |
| 30 | 30 | * The defined constante for Log level |
@@ -52,14 +52,14 @@ discard block |
||
| 52 | 52 | /** |
| 53 | 53 | * Create new Log instance |
| 54 | 54 | */ |
| 55 | - public function __construct(){ |
|
| 55 | + public function __construct() { |
|
| 56 | 56 | } |
| 57 | 57 | |
| 58 | 58 | /** |
| 59 | 59 | * Set the logger to identify each message in the log |
| 60 | 60 | * @param string $logger the logger name |
| 61 | 61 | */ |
| 62 | - public function setLogger($logger){ |
|
| 62 | + public function setLogger($logger) { |
|
| 63 | 63 | $this->logger = $logger; |
| 64 | 64 | } |
| 65 | 65 | |
@@ -68,7 +68,7 @@ discard block |
||
| 68 | 68 | * @see Log::writeLog for more detail |
| 69 | 69 | * @param string $message the log message to save |
| 70 | 70 | */ |
| 71 | - public function fatal($message){ |
|
| 71 | + public function fatal($message) { |
|
| 72 | 72 | $this->writeLog($message, self::FATAL); |
| 73 | 73 | } |
| 74 | 74 | |
@@ -77,7 +77,7 @@ discard block |
||
| 77 | 77 | * @see Log::writeLog for more detail |
| 78 | 78 | * @param string $message the log message to save |
| 79 | 79 | */ |
| 80 | - public function error($message){ |
|
| 80 | + public function error($message) { |
|
| 81 | 81 | $this->writeLog($message, self::ERROR); |
| 82 | 82 | } |
| 83 | 83 | |
@@ -86,7 +86,7 @@ discard block |
||
| 86 | 86 | * @see Log::writeLog for more detail |
| 87 | 87 | * @param string $message the log message to save |
| 88 | 88 | */ |
| 89 | - public function warning($message){ |
|
| 89 | + public function warning($message) { |
|
| 90 | 90 | $this->writeLog($message, self::WARNING); |
| 91 | 91 | } |
| 92 | 92 | |
@@ -95,7 +95,7 @@ discard block |
||
| 95 | 95 | * @see Log::writeLog for more detail |
| 96 | 96 | * @param string $message the log message to save |
| 97 | 97 | */ |
| 98 | - public function info($message){ |
|
| 98 | + public function info($message) { |
|
| 99 | 99 | $this->writeLog($message, self::INFO); |
| 100 | 100 | } |
| 101 | 101 | |
@@ -104,7 +104,7 @@ discard block |
||
| 104 | 104 | * @see Log::writeLog for more detail |
| 105 | 105 | * @param string $message the log message to save |
| 106 | 106 | */ |
| 107 | - public function debug($message){ |
|
| 107 | + public function debug($message) { |
|
| 108 | 108 | $this->writeLog($message, self::DEBUG); |
| 109 | 109 | } |
| 110 | 110 | |
@@ -115,59 +115,59 @@ discard block |
||
| 115 | 115 | * @param integer|string $level the log level in integer or string format, if is string will convert into integer |
| 116 | 116 | * to allow check the log level threshold. |
| 117 | 117 | */ |
| 118 | - public function writeLog($message, $level = self::INFO){ |
|
| 118 | + public function writeLog($message, $level = self::INFO) { |
|
| 119 | 119 | $configLogLevel = get_config('log_level'); |
| 120 | - if(! $configLogLevel){ |
|
| 120 | + if (!$configLogLevel) { |
|
| 121 | 121 | //so means no need log just stop here |
| 122 | 122 | return; |
| 123 | 123 | } |
| 124 | 124 | //check config log level |
| 125 | - if(! self::isValidConfigLevel($configLogLevel)){ |
|
| 125 | + if (!self::isValidConfigLevel($configLogLevel)) { |
|
| 126 | 126 | //NOTE: here need put the show_error() "logging" to false to prevent loop |
| 127 | 127 | show_error('Invalid config log level [' . $configLogLevel . '], the value must be one of the following: ' . implode(', ', array_map('strtoupper', self::$validConfigLevel)), $title = 'Log Config Error', $logging = false); |
| 128 | 128 | } |
| 129 | 129 | |
| 130 | 130 | //check if config log_logger_name is set |
| 131 | - if($this->logger){ |
|
| 131 | + if ($this->logger) { |
|
| 132 | 132 | $configLoggerName = get_config('log_logger_name', ''); |
| 133 | - if($configLoggerName){ |
|
| 134 | - if (is_array($configLoggerName)){ |
|
| 133 | + if ($configLoggerName) { |
|
| 134 | + if (is_array($configLoggerName)) { |
|
| 135 | 135 | //for best comparaison put all string to lowercase |
| 136 | 136 | $configLoggerName = array_map('strtolower', $configLoggerName); |
| 137 | - if(! in_array(strtolower($this->logger), $configLoggerName)){ |
|
| 137 | + if (!in_array(strtolower($this->logger), $configLoggerName)) { |
|
| 138 | 138 | return; |
| 139 | 139 | } |
| 140 | 140 | } |
| 141 | - else if(strtolower($this->logger) !== strtolower($configLoggerName)){ |
|
| 141 | + else if (strtolower($this->logger) !== strtolower($configLoggerName)) { |
|
| 142 | 142 | return; |
| 143 | 143 | } |
| 144 | 144 | } |
| 145 | 145 | } |
| 146 | 146 | |
| 147 | 147 | //if $level is not an integer |
| 148 | - if(! is_numeric($level)){ |
|
| 148 | + if (!is_numeric($level)) { |
|
| 149 | 149 | $level = self::getLevelValue($level); |
| 150 | 150 | } |
| 151 | 151 | |
| 152 | 152 | //check if can logging regarding the log level config |
| 153 | 153 | $configLevel = self::getLevelValue($configLogLevel); |
| 154 | - if($configLevel > $level){ |
|
| 154 | + if ($configLevel > $level) { |
|
| 155 | 155 | //can't log |
| 156 | 156 | return; |
| 157 | 157 | } |
| 158 | 158 | |
| 159 | 159 | $logSavePath = get_config('log_save_path'); |
| 160 | - if(! $logSavePath){ |
|
| 160 | + if (!$logSavePath) { |
|
| 161 | 161 | $logSavePath = LOGS_PATH; |
| 162 | 162 | } |
| 163 | 163 | |
| 164 | - if(! is_dir($logSavePath) || !is_writable($logSavePath)){ |
|
| 164 | + if (!is_dir($logSavePath) || !is_writable($logSavePath)) { |
|
| 165 | 165 | //NOTE: here need put the show_error() "logging" to false to prevent loop |
| 166 | 166 | show_error('Error : the log dir does not exists or is not writable', $title = 'Log directory error', $logging = false); |
| 167 | 167 | } |
| 168 | 168 | |
| 169 | 169 | $path = $logSavePath . 'logs-' . date('Y-m-d') . '.log'; |
| 170 | - if(! file_exists($path)){ |
|
| 170 | + if (!file_exists($path)) { |
|
| 171 | 171 | touch($path); |
| 172 | 172 | } |
| 173 | 173 | //may be at this time helper user_agent not yet included |
@@ -189,7 +189,7 @@ discard block |
||
| 189 | 189 | |
| 190 | 190 | $str = $logDate . ' [' . str_pad($levelName, 7 /*warning len*/) . '] ' . ' [' . str_pad($ip, 15) . '] ' . $this->logger . ' : ' . $message . ' ' . '[' . $fileInfo['file'] . '::' . $fileInfo['line'] . ']' . "\n"; |
| 191 | 191 | $fp = fopen($path, 'a+'); |
| 192 | - if(is_resource($fp)){ |
|
| 192 | + if (is_resource($fp)) { |
|
| 193 | 193 | flock($fp, LOCK_EX); // exclusive lock, will get released when the file is closed |
| 194 | 194 | fwrite($fp, $str); |
| 195 | 195 | fclose($fp); |
@@ -203,7 +203,7 @@ discard block |
||
| 203 | 203 | * |
| 204 | 204 | * @return boolean true if the given log level is valid, false if not |
| 205 | 205 | */ |
| 206 | - private static function isValidConfigLevel($level){ |
|
| 206 | + private static function isValidConfigLevel($level) { |
|
| 207 | 207 | $level = strtolower($level); |
| 208 | 208 | return in_array($level, self::$validConfigLevel); |
| 209 | 209 | } |
@@ -213,27 +213,27 @@ discard block |
||
| 213 | 213 | * @param string $level the log level in string format |
| 214 | 214 | * @return int the log level in integer format using the predefinied constants |
| 215 | 215 | */ |
| 216 | - private static function getLevelValue($level){ |
|
| 216 | + private static function getLevelValue($level) { |
|
| 217 | 217 | $level = strtolower($level); |
| 218 | 218 | $value = self::NONE; |
| 219 | 219 | |
| 220 | 220 | //the default value is NONE, so means no need test for NONE |
| 221 | - if($level == 'fatal'){ |
|
| 221 | + if ($level == 'fatal') { |
|
| 222 | 222 | $value = self::FATAL; |
| 223 | 223 | } |
| 224 | - else if($level == 'error'){ |
|
| 224 | + else if ($level == 'error') { |
|
| 225 | 225 | $value = self::ERROR; |
| 226 | 226 | } |
| 227 | - else if($level == 'warning' || $level == 'warn'){ |
|
| 227 | + else if ($level == 'warning' || $level == 'warn') { |
|
| 228 | 228 | $value = self::WARNING; |
| 229 | 229 | } |
| 230 | - else if($level == 'info'){ |
|
| 230 | + else if ($level == 'info') { |
|
| 231 | 231 | $value = self::INFO; |
| 232 | 232 | } |
| 233 | - else if($level == 'debug'){ |
|
| 233 | + else if ($level == 'debug') { |
|
| 234 | 234 | $value = self::DEBUG; |
| 235 | 235 | } |
| 236 | - else if($level == 'all'){ |
|
| 236 | + else if ($level == 'all') { |
|
| 237 | 237 | $value = self::ALL; |
| 238 | 238 | } |
| 239 | 239 | return $value; |
@@ -244,23 +244,23 @@ discard block |
||
| 244 | 244 | * @param integer $level the log level in integer format |
| 245 | 245 | * @return string the log level in string format |
| 246 | 246 | */ |
| 247 | - private static function getLevelName($level){ |
|
| 247 | + private static function getLevelName($level) { |
|
| 248 | 248 | $value = ''; |
| 249 | 249 | |
| 250 | 250 | //the default value is NONE, so means no need test for NONE |
| 251 | - if($level == self::FATAL){ |
|
| 251 | + if ($level == self::FATAL) { |
|
| 252 | 252 | $value = 'FATAL'; |
| 253 | 253 | } |
| 254 | - else if($level == self::ERROR){ |
|
| 254 | + else if ($level == self::ERROR) { |
|
| 255 | 255 | $value = 'ERROR'; |
| 256 | 256 | } |
| 257 | - else if($level == self::WARNING){ |
|
| 257 | + else if ($level == self::WARNING) { |
|
| 258 | 258 | $value = 'WARNING'; |
| 259 | 259 | } |
| 260 | - else if($level == self::INFO){ |
|
| 260 | + else if ($level == self::INFO) { |
|
| 261 | 261 | $value = 'INFO'; |
| 262 | 262 | } |
| 263 | - else if($level == self::DEBUG){ |
|
| 263 | + else if ($level == self::DEBUG) { |
|
| 264 | 264 | $value = 'DEBUG'; |
| 265 | 265 | } |
| 266 | 266 | //no need for ALL |
@@ -27,7 +27,7 @@ discard block |
||
| 27 | 27 | /** |
| 28 | 28 | * For application languages management |
| 29 | 29 | */ |
| 30 | - class Lang{ |
|
| 30 | + class Lang { |
|
| 31 | 31 | |
| 32 | 32 | /** |
| 33 | 33 | * The supported available language for this application. |
@@ -67,8 +67,8 @@ discard block |
||
| 67 | 67 | /** |
| 68 | 68 | * Construct new Lang instance |
| 69 | 69 | */ |
| 70 | - public function __construct(){ |
|
| 71 | - $this->logger =& class_loader('Log', 'classes'); |
|
| 70 | + public function __construct() { |
|
| 71 | + $this->logger = & class_loader('Log', 'classes'); |
|
| 72 | 72 | $this->logger->setLogger('Library::Lang'); |
| 73 | 73 | |
| 74 | 74 | $this->default = get_config('default_language', 'en'); |
@@ -76,8 +76,8 @@ discard block |
||
| 76 | 76 | |
| 77 | 77 | //add the supported languages ('key', 'display name') |
| 78 | 78 | $languages = get_config('languages', null); |
| 79 | - if(! empty($languages)){ |
|
| 80 | - foreach($languages as $key => $displayName){ |
|
| 79 | + if (!empty($languages)) { |
|
| 80 | + foreach ($languages as $key => $displayName) { |
|
| 81 | 81 | $this->addLang($key, $displayName); |
| 82 | 82 | } |
| 83 | 83 | } |
@@ -85,15 +85,15 @@ discard block |
||
| 85 | 85 | |
| 86 | 86 | //if the language exists in cookie use it |
| 87 | 87 | $cfgKey = get_config('language_cookie_name'); |
| 88 | - $this->logger->debug('Getting current language from cookie [' .$cfgKey. ']'); |
|
| 88 | + $this->logger->debug('Getting current language from cookie [' . $cfgKey . ']'); |
|
| 89 | 89 | $objCookie = & class_loader('Cookie'); |
| 90 | 90 | $cookieLang = $objCookie->get($cfgKey); |
| 91 | - if($cookieLang && $this->isValid($cookieLang)){ |
|
| 91 | + if ($cookieLang && $this->isValid($cookieLang)) { |
|
| 92 | 92 | $this->current = $cookieLang; |
| 93 | - $this->logger->info('Language from cookie [' .$cfgKey. '] is valid so we will set the language using the cookie value [' .$cookieLang. ']'); |
|
| 93 | + $this->logger->info('Language from cookie [' . $cfgKey . '] is valid so we will set the language using the cookie value [' . $cookieLang . ']'); |
|
| 94 | 94 | } |
| 95 | - else{ |
|
| 96 | - $this->logger->info('Language from cookie [' .$cfgKey. '] is not set, use the default value [' .$this->getDefault(). ']'); |
|
| 95 | + else { |
|
| 96 | + $this->logger->info('Language from cookie [' . $cfgKey . '] is not set, use the default value [' . $this->getDefault() . ']'); |
|
| 97 | 97 | $this->current = $this->getDefault(); |
| 98 | 98 | } |
| 99 | 99 | } |
@@ -103,7 +103,7 @@ discard block |
||
| 103 | 103 | * |
| 104 | 104 | * @return array the language message list |
| 105 | 105 | */ |
| 106 | - public function getAll(){ |
|
| 106 | + public function getAll() { |
|
| 107 | 107 | return $this->languages; |
| 108 | 108 | } |
| 109 | 109 | |
@@ -113,7 +113,7 @@ discard block |
||
| 113 | 113 | * @param string $key the language key to identify |
| 114 | 114 | * @param string $value the language message value |
| 115 | 115 | */ |
| 116 | - public function set($key, $value){ |
|
| 116 | + public function set($key, $value) { |
|
| 117 | 117 | $this->languages[$key] = $value; |
| 118 | 118 | } |
| 119 | 119 | |
@@ -125,11 +125,11 @@ discard block |
||
| 125 | 125 | * |
| 126 | 126 | * @return string the language message value |
| 127 | 127 | */ |
| 128 | - public function get($key, $default = 'LANGUAGE_ERROR'){ |
|
| 129 | - if(isset($this->languages[$key])){ |
|
| 128 | + public function get($key, $default = 'LANGUAGE_ERROR') { |
|
| 129 | + if (isset($this->languages[$key])) { |
|
| 130 | 130 | return $this->languages[$key]; |
| 131 | 131 | } |
| 132 | - $this->logger->warning('Language key [' .$key. '] does not exist use the default value [' .$default. ']'); |
|
| 132 | + $this->logger->warning('Language key [' . $key . '] does not exist use the default value [' . $default . ']'); |
|
| 133 | 133 | return $default; |
| 134 | 134 | } |
| 135 | 135 | |
@@ -140,10 +140,10 @@ discard block |
||
| 140 | 140 | * |
| 141 | 141 | * @return boolean true if the language directory exists, false or not |
| 142 | 142 | */ |
| 143 | - public function isValid($language){ |
|
| 143 | + public function isValid($language) { |
|
| 144 | 144 | $searchDir = array(CORE_LANG_PATH, APP_LANG_PATH); |
| 145 | - foreach($searchDir as $dir){ |
|
| 146 | - if(file_exists($dir . $language) && is_dir($dir . $language)){ |
|
| 145 | + foreach ($searchDir as $dir) { |
|
| 146 | + if (file_exists($dir . $language) && is_dir($dir . $language)) { |
|
| 147 | 147 | return true; |
| 148 | 148 | } |
| 149 | 149 | } |
@@ -155,7 +155,7 @@ discard block |
||
| 155 | 155 | * |
| 156 | 156 | * @return string the default language |
| 157 | 157 | */ |
| 158 | - public function getDefault(){ |
|
| 158 | + public function getDefault() { |
|
| 159 | 159 | return $this->default; |
| 160 | 160 | } |
| 161 | 161 | |
@@ -164,7 +164,7 @@ discard block |
||
| 164 | 164 | * |
| 165 | 165 | * @return string the current language |
| 166 | 166 | */ |
| 167 | - public function getCurrent(){ |
|
| 167 | + public function getCurrent() { |
|
| 168 | 168 | return $this->current; |
| 169 | 169 | } |
| 170 | 170 | |
@@ -174,14 +174,14 @@ discard block |
||
| 174 | 174 | * @param string $name the short language name like "en", "fr". |
| 175 | 175 | * @param string $description the human readable description of this language |
| 176 | 176 | */ |
| 177 | - public function addLang($name, $description){ |
|
| 178 | - if(isset($this->availables[$name])){ |
|
| 177 | + public function addLang($name, $description) { |
|
| 178 | + if (isset($this->availables[$name])) { |
|
| 179 | 179 | return; //already added cost in performance |
| 180 | 180 | } |
| 181 | - if($this->isValid($name)){ |
|
| 181 | + if ($this->isValid($name)) { |
|
| 182 | 182 | $this->availables[$name] = $description; |
| 183 | 183 | } |
| 184 | - else{ |
|
| 184 | + else { |
|
| 185 | 185 | show_error('The language [' . $name . '] is not valid or does not exists.'); |
| 186 | 186 | } |
| 187 | 187 | } |
@@ -191,7 +191,7 @@ discard block |
||
| 191 | 191 | * |
| 192 | 192 | * @return array the list of the application language |
| 193 | 193 | */ |
| 194 | - public function getSupported(){ |
|
| 194 | + public function getSupported() { |
|
| 195 | 195 | return $this->availables; |
| 196 | 196 | } |
| 197 | 197 | |
@@ -200,7 +200,7 @@ discard block |
||
| 200 | 200 | * |
| 201 | 201 | * @param array $langs the languages array of the messages to be added |
| 202 | 202 | */ |
| 203 | - public function addLangMessages(array $langs){ |
|
| 203 | + public function addLangMessages(array $langs) { |
|
| 204 | 204 | foreach ($langs as $key => $value) { |
| 205 | 205 | $this->set($key, $value); |
| 206 | 206 | } |
@@ -23,7 +23,7 @@ discard block |
||
| 23 | 23 | * along with this program; if not, write to the Free Software |
| 24 | 24 | * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
| 25 | 25 | */ |
| 26 | - class Session{ |
|
| 26 | + class Session { |
|
| 27 | 27 | |
| 28 | 28 | /** |
| 29 | 29 | * The session flash key to use |
@@ -41,9 +41,9 @@ discard block |
||
| 41 | 41 | * Get the logger singleton instance |
| 42 | 42 | * @return Log the logger instance |
| 43 | 43 | */ |
| 44 | - private static function getLogger(){ |
|
| 45 | - if(self::$logger == null){ |
|
| 46 | - self::$logger[0] =& class_loader('Log', 'classes'); |
|
| 44 | + private static function getLogger() { |
|
| 45 | + if (self::$logger == null) { |
|
| 46 | + self::$logger[0] = & class_loader('Log', 'classes'); |
|
| 47 | 47 | self::$logger[0]->setLogger('Library::Session'); |
| 48 | 48 | } |
| 49 | 49 | return self::$logger[0]; |
@@ -55,14 +55,14 @@ discard block |
||
| 55 | 55 | * @param mixed $default the default value to use if can not find the session item in the list |
| 56 | 56 | * @return mixed the session value if exist or the default value |
| 57 | 57 | */ |
| 58 | - public static function get($item, $default = null){ |
|
| 58 | + public static function get($item, $default = null) { |
|
| 59 | 59 | $logger = self::getLogger(); |
| 60 | - $logger->debug('Getting session data for item [' .$item. '] ...'); |
|
| 61 | - if(array_key_exists($item, $_SESSION)){ |
|
| 60 | + $logger->debug('Getting session data for item [' . $item . '] ...'); |
|
| 61 | + if (array_key_exists($item, $_SESSION)) { |
|
| 62 | 62 | $logger->info('Found session data for item [' . $item . '] the vaue is : [' . stringfy_vars($_SESSION[$item]) . ']'); |
| 63 | 63 | return $_SESSION[$item]; |
| 64 | 64 | } |
| 65 | - $logger->warning('Cannot find session item [' . $item . '] using the default value ['. $default . ']'); |
|
| 65 | + $logger->warning('Cannot find session item [' . $item . '] using the default value [' . $default . ']'); |
|
| 66 | 66 | return $default; |
| 67 | 67 | } |
| 68 | 68 | |
@@ -71,7 +71,7 @@ discard block |
||
| 71 | 71 | * @param string $item the session item name to set |
| 72 | 72 | * @param mixed $value the session item value |
| 73 | 73 | */ |
| 74 | - public static function set($item, $value){ |
|
| 74 | + public static function set($item, $value) { |
|
| 75 | 75 | $logger = self::getLogger(); |
| 76 | 76 | $logger->debug('Setting session data for item [' . $item . '], value [' . stringfy_vars($value) . ']'); |
| 77 | 77 | $_SESSION[$item] = $value; |
@@ -83,16 +83,16 @@ discard block |
||
| 83 | 83 | * @param mixed $default the default value to use if can not find the session flash item in the list |
| 84 | 84 | * @return mixed the session flash value if exist or the default value |
| 85 | 85 | */ |
| 86 | - public static function getFlash($item, $default = null){ |
|
| 86 | + public static function getFlash($item, $default = null) { |
|
| 87 | 87 | $logger = self::getLogger(); |
| 88 | - $key = self::SESSION_FLASH_KEY.'_'.$item; |
|
| 88 | + $key = self::SESSION_FLASH_KEY . '_' . $item; |
|
| 89 | 89 | $return = array_key_exists($key, $_SESSION) ? |
| 90 | 90 | ($_SESSION[$key]) : $default; |
| 91 | - if(array_key_exists($key, $_SESSION)){ |
|
| 91 | + if (array_key_exists($key, $_SESSION)) { |
|
| 92 | 92 | unset($_SESSION[$key]); |
| 93 | 93 | } |
| 94 | - else{ |
|
| 95 | - $logger->warning('Cannot find session flash item ['. $key .'] using the default value ['. $default .']'); |
|
| 94 | + else { |
|
| 95 | + $logger->warning('Cannot find session flash item [' . $key . '] using the default value [' . $default . ']'); |
|
| 96 | 96 | } |
| 97 | 97 | return $return; |
| 98 | 98 | } |
@@ -102,8 +102,8 @@ discard block |
||
| 102 | 102 | * @param string $item the session flash item name |
| 103 | 103 | * @return boolean |
| 104 | 104 | */ |
| 105 | - public static function hasFlash($item){ |
|
| 106 | - $key = self::SESSION_FLASH_KEY.'_'.$item; |
|
| 105 | + public static function hasFlash($item) { |
|
| 106 | + $key = self::SESSION_FLASH_KEY . '_' . $item; |
|
| 107 | 107 | return array_key_exists($key, $_SESSION); |
| 108 | 108 | } |
| 109 | 109 | |
@@ -112,8 +112,8 @@ discard block |
||
| 112 | 112 | * @param string $item the session flash item name to set |
| 113 | 113 | * @param mixed $value the session flash item value |
| 114 | 114 | */ |
| 115 | - public static function setFlash($item, $value){ |
|
| 116 | - $key = self::SESSION_FLASH_KEY.'_'.$item; |
|
| 115 | + public static function setFlash($item, $value) { |
|
| 116 | + $key = self::SESSION_FLASH_KEY . '_' . $item; |
|
| 117 | 117 | $_SESSION[$key] = $value; |
| 118 | 118 | } |
| 119 | 119 | |
@@ -121,14 +121,14 @@ discard block |
||
| 121 | 121 | * Clear the session item in the list |
| 122 | 122 | * @param string $item the session item name to be deleted |
| 123 | 123 | */ |
| 124 | - public static function clear($item){ |
|
| 124 | + public static function clear($item) { |
|
| 125 | 125 | $logger = self::getLogger(); |
| 126 | - if(array_key_exists($item, $_SESSION)){ |
|
| 127 | - $logger->info('Deleting of session for item ['.$item.' ]'); |
|
| 126 | + if (array_key_exists($item, $_SESSION)) { |
|
| 127 | + $logger->info('Deleting of session for item [' . $item . ' ]'); |
|
| 128 | 128 | unset($_SESSION[$item]); |
| 129 | 129 | } |
| 130 | - else{ |
|
| 131 | - $logger->warning('Session item ['.$item.'] to be deleted does not exists'); |
|
| 130 | + else { |
|
| 131 | + $logger->warning('Session item [' . $item . '] to be deleted does not exists'); |
|
| 132 | 132 | } |
| 133 | 133 | } |
| 134 | 134 | |
@@ -136,15 +136,15 @@ discard block |
||
| 136 | 136 | * Clear the session flash item in the list |
| 137 | 137 | * @param string $item the session flash item name to be deleted |
| 138 | 138 | */ |
| 139 | - public static function clearFlash($item){ |
|
| 139 | + public static function clearFlash($item) { |
|
| 140 | 140 | $logger = self::getLogger(); |
| 141 | - $key = self::SESSION_FLASH_KEY.'_'.$item; |
|
| 142 | - if(array_key_exists($key, $_SESSION)){ |
|
| 143 | - $logger->info('Delete session flash for item ['.$item.']'); |
|
| 141 | + $key = self::SESSION_FLASH_KEY . '_' . $item; |
|
| 142 | + if (array_key_exists($key, $_SESSION)) { |
|
| 143 | + $logger->info('Delete session flash for item [' . $item . ']'); |
|
| 144 | 144 | unset($_SESSION[$item]); |
| 145 | 145 | } |
| 146 | - else{ |
|
| 147 | - $logger->warning('Dession flash item ['.$item.'] to be deleted does not exists'); |
|
| 146 | + else { |
|
| 147 | + $logger->warning('Dession flash item [' . $item . '] to be deleted does not exists'); |
|
| 148 | 148 | } |
| 149 | 149 | } |
| 150 | 150 | |
@@ -153,14 +153,14 @@ discard block |
||
| 153 | 153 | * @param string $item the session item name |
| 154 | 154 | * @return boolean |
| 155 | 155 | */ |
| 156 | - public static function exists($item){ |
|
| 156 | + public static function exists($item) { |
|
| 157 | 157 | return array_key_exists($item, $_SESSION); |
| 158 | 158 | } |
| 159 | 159 | |
| 160 | 160 | /** |
| 161 | 161 | * Destroy all session data values |
| 162 | 162 | */ |
| 163 | - public static function clearAll(){ |
|
| 163 | + public static function clearAll() { |
|
| 164 | 164 | session_unset(); |
| 165 | 165 | session_destroy(); |
| 166 | 166 | } |
@@ -24,7 +24,7 @@ discard block |
||
| 24 | 24 | * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
| 25 | 25 | */ |
| 26 | 26 | |
| 27 | - class Request{ |
|
| 27 | + class Request { |
|
| 28 | 28 | |
| 29 | 29 | /** |
| 30 | 30 | * The value for the super global $_GET |
@@ -90,21 +90,21 @@ discard block |
||
| 90 | 90 | /** |
| 91 | 91 | * Construct new request instance |
| 92 | 92 | */ |
| 93 | - public function __construct(){ |
|
| 93 | + public function __construct() { |
|
| 94 | 94 | $this->get = $_GET; |
| 95 | 95 | $this->post = $_POST; |
| 96 | 96 | $this->server = $_SERVER; |
| 97 | 97 | $this->query = $_REQUEST; |
| 98 | 98 | $this->cookie = $_COOKIE; |
| 99 | 99 | $this->file = $_FILES; |
| 100 | - $this->session =& class_loader('Session', 'classes'); |
|
| 100 | + $this->session = & class_loader('Session', 'classes'); |
|
| 101 | 101 | $this->method = $this->server('REQUEST_METHOD'); |
| 102 | 102 | $this->requestUri = $this->server('REQUEST_URI'); |
| 103 | 103 | $this->header = array(); |
| 104 | - if(function_exists('apache_request_headers')){ |
|
| 104 | + if (function_exists('apache_request_headers')) { |
|
| 105 | 105 | $this->header = apache_request_headers(); |
| 106 | 106 | } |
| 107 | - else if(function_exists('getallheaders')){ |
|
| 107 | + else if (function_exists('getallheaders')) { |
|
| 108 | 108 | $this->header = getallheaders(); |
| 109 | 109 | } |
| 110 | 110 | } |
@@ -113,7 +113,7 @@ discard block |
||
| 113 | 113 | * Get the request method |
| 114 | 114 | * @return string |
| 115 | 115 | */ |
| 116 | - public function method(){ |
|
| 116 | + public function method() { |
|
| 117 | 117 | return $this->method; |
| 118 | 118 | } |
| 119 | 119 | |
@@ -121,7 +121,7 @@ discard block |
||
| 121 | 121 | * Get the request URI |
| 122 | 122 | * @return string |
| 123 | 123 | */ |
| 124 | - public function requestUri(){ |
|
| 124 | + public function requestUri() { |
|
| 125 | 125 | return $this->requestUri; |
| 126 | 126 | } |
| 127 | 127 | |
@@ -131,13 +131,13 @@ discard block |
||
| 131 | 131 | * @param boolean $xss if need apply some XSS attack rule on the value |
| 132 | 132 | * @return array|mixed the item value if the key exists or all array if the key does not exists or is empty |
| 133 | 133 | */ |
| 134 | - public function query($key = null, $xss = true){ |
|
| 135 | - if(empty($key)){ |
|
| 134 | + public function query($key = null, $xss = true) { |
|
| 135 | + if (empty($key)) { |
|
| 136 | 136 | //return all |
| 137 | 137 | return $xss ? clean_input($this->query) : $this->query; |
| 138 | 138 | } |
| 139 | 139 | $query = array_key_exists($key, $this->query) ? $this->query[$key] : null; |
| 140 | - if($xss){ |
|
| 140 | + if ($xss) { |
|
| 141 | 141 | $query = clean_input($query); |
| 142 | 142 | } |
| 143 | 143 | return $query; |
@@ -149,13 +149,13 @@ discard block |
||
| 149 | 149 | * @param boolean $xss if need apply some XSS attack rule on the value |
| 150 | 150 | * @return array|mixed the item value if the key exists or all array if the key does not exists or is empty |
| 151 | 151 | */ |
| 152 | - public function get($key = null, $xss = true){ |
|
| 153 | - if(empty($key)){ |
|
| 152 | + public function get($key = null, $xss = true) { |
|
| 153 | + if (empty($key)) { |
|
| 154 | 154 | //return all |
| 155 | 155 | return $xss ? clean_input($this->get) : $this->get; |
| 156 | 156 | } |
| 157 | 157 | $get = array_key_exists($key, $this->get) ? $this->get[$key] : null; |
| 158 | - if($xss){ |
|
| 158 | + if ($xss) { |
|
| 159 | 159 | $get = clean_input($get); |
| 160 | 160 | } |
| 161 | 161 | return $get; |
@@ -167,13 +167,13 @@ discard block |
||
| 167 | 167 | * @param boolean $xss if need apply some XSS attack rule on the value |
| 168 | 168 | * @return array|mixed the item value if the key exists or all array if the key does not exists or is empty |
| 169 | 169 | */ |
| 170 | - public function post($key = null, $xss = true){ |
|
| 171 | - if(empty($key)){ |
|
| 170 | + public function post($key = null, $xss = true) { |
|
| 171 | + if (empty($key)) { |
|
| 172 | 172 | //return all |
| 173 | 173 | return $xss ? clean_input($this->post) : $this->post; |
| 174 | 174 | } |
| 175 | 175 | $post = array_key_exists($key, $this->post) ? $this->post[$key] : null; |
| 176 | - if($xss){ |
|
| 176 | + if ($xss) { |
|
| 177 | 177 | $post = clean_input($post); |
| 178 | 178 | } |
| 179 | 179 | return $post; |
@@ -185,13 +185,13 @@ discard block |
||
| 185 | 185 | * @param boolean $xss if need apply some XSS attack rule on the value |
| 186 | 186 | * @return array|mixed the item value if the key exists or all array if the key does not exists or is empty |
| 187 | 187 | */ |
| 188 | - public function server($key = null, $xss = true){ |
|
| 189 | - if(empty($key)){ |
|
| 188 | + public function server($key = null, $xss = true) { |
|
| 189 | + if (empty($key)) { |
|
| 190 | 190 | //return all |
| 191 | 191 | return $xss ? clean_input($this->server) : $this->server; |
| 192 | 192 | } |
| 193 | 193 | $server = array_key_exists($key, $this->server) ? $this->server[$key] : null; |
| 194 | - if($xss){ |
|
| 194 | + if ($xss) { |
|
| 195 | 195 | $server = clean_input($server); |
| 196 | 196 | } |
| 197 | 197 | return $server; |
@@ -203,13 +203,13 @@ discard block |
||
| 203 | 203 | * @param boolean $xss if need apply some XSS attack rule on the value |
| 204 | 204 | * @return array|mixed the item value if the key exists or all array if the key does not exists or is empty |
| 205 | 205 | */ |
| 206 | - public function cookie($key = null, $xss = true){ |
|
| 207 | - if(empty($key)){ |
|
| 206 | + public function cookie($key = null, $xss = true) { |
|
| 207 | + if (empty($key)) { |
|
| 208 | 208 | //return all |
| 209 | 209 | return $xss ? clean_input($this->cookie) : $this->cookie; |
| 210 | 210 | } |
| 211 | 211 | $cookie = array_key_exists($key, $this->cookie) ? $this->cookie[$key] : null; |
| 212 | - if($xss){ |
|
| 212 | + if ($xss) { |
|
| 213 | 213 | $cookie = clean_input($cookie); |
| 214 | 214 | } |
| 215 | 215 | return $cookie; |
@@ -220,7 +220,7 @@ discard block |
||
| 220 | 220 | * @param string $key the item key to be fetched |
| 221 | 221 | * @return array|mixed the item value if the key exists or all array if the key does not exists or is empty |
| 222 | 222 | */ |
| 223 | - public function file($key){ |
|
| 223 | + public function file($key) { |
|
| 224 | 224 | $file = array_key_exists($key, $this->file) ? $this->file[$key] : null; |
| 225 | 225 | return $file; |
| 226 | 226 | } |
@@ -231,9 +231,9 @@ discard block |
||
| 231 | 231 | * @param boolean $xss if need apply some XSS attack rule on the value |
| 232 | 232 | * @return array|mixed the item value if the key exists or null if the key does not exists |
| 233 | 233 | */ |
| 234 | - public function session($key, $xss = true){ |
|
| 234 | + public function session($key, $xss = true) { |
|
| 235 | 235 | $session = $this->session->get($key); |
| 236 | - if($xss){ |
|
| 236 | + if ($xss) { |
|
| 237 | 237 | $session = clean_input($session); |
| 238 | 238 | } |
| 239 | 239 | return $session; |
@@ -245,9 +245,9 @@ discard block |
||
| 245 | 245 | * @param boolean $xss if need apply some XSS attack rule on the value |
| 246 | 246 | * @return mixed the item value if the key exists or null if the key does not exists |
| 247 | 247 | */ |
| 248 | - public function header($key, $xss = true){ |
|
| 248 | + public function header($key, $xss = true) { |
|
| 249 | 249 | $header = array_key_exists($key, $this->header) ? $this->header[$key] : null; |
| 250 | - if($xss){ |
|
| 250 | + if ($xss) { |
|
| 251 | 251 | $header = clean_input($header); |
| 252 | 252 | } |
| 253 | 253 | return $header; |
@@ -24,7 +24,7 @@ discard block |
||
| 24 | 24 | * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
| 25 | 25 | */ |
| 26 | 26 | |
| 27 | - class Security{ |
|
| 27 | + class Security { |
|
| 28 | 28 | |
| 29 | 29 | /** |
| 30 | 30 | * The logger instance |
@@ -36,9 +36,9 @@ discard block |
||
| 36 | 36 | * Get the logger singleton instance |
| 37 | 37 | * @return Log the logger instance |
| 38 | 38 | */ |
| 39 | - private static function getLogger(){ |
|
| 40 | - if(self::$logger == null){ |
|
| 41 | - self::$logger[0] =& class_loader('Log', 'classes'); |
|
| 39 | + private static function getLogger() { |
|
| 40 | + if (self::$logger == null) { |
|
| 41 | + self::$logger[0] = & class_loader('Log', 'classes'); |
|
| 42 | 42 | self::$logger[0]->setLogger('Library::Security'); |
| 43 | 43 | } |
| 44 | 44 | return self::$logger[0]; |
@@ -49,7 +49,7 @@ discard block |
||
| 49 | 49 | * This method is used to generate the CSRF token |
| 50 | 50 | * @return string the generated CSRF token |
| 51 | 51 | */ |
| 52 | - public static function generateCSRF(){ |
|
| 52 | + public static function generateCSRF() { |
|
| 53 | 53 | $logger = self::getLogger(); |
| 54 | 54 | $logger->debug('Generation of CSRF ...'); |
| 55 | 55 | |
@@ -57,14 +57,14 @@ discard block |
||
| 57 | 57 | $expire = get_config('csrf_expire', 60); |
| 58 | 58 | $keyExpire = 'csrf_expire'; |
| 59 | 59 | $currentTime = time(); |
| 60 | - if(Session::exists($key) && Session::exists($keyExpire) && Session::get($keyExpire) > $currentTime){ |
|
| 60 | + if (Session::exists($key) && Session::exists($keyExpire) && Session::get($keyExpire) > $currentTime) { |
|
| 61 | 61 | $logger->info('The CSRF token not yet expire just return it'); |
| 62 | 62 | return Session::get($key); |
| 63 | 63 | } |
| 64 | - else{ |
|
| 64 | + else { |
|
| 65 | 65 | $newTime = $currentTime + $expire; |
| 66 | 66 | $token = sha1(uniqid()) . sha1(uniqid()); |
| 67 | - $logger->info('The CSRF informations are listed below: key [' .$key. '], key expire [' .$keyExpire. '], expire time [' .$expire. '], token [' .$token. ']'); |
|
| 67 | + $logger->info('The CSRF informations are listed below: key [' . $key . '], key expire [' . $keyExpire . '], expire time [' . $expire . '], token [' . $token . ']'); |
|
| 68 | 68 | Session::set($keyExpire, $newTime); |
| 69 | 69 | Session::set($key, $token); |
| 70 | 70 | return Session::get($key); |
@@ -75,7 +75,7 @@ discard block |
||
| 75 | 75 | * This method is used to check the CSRF if is valid, not yet expire, etc. |
| 76 | 76 | * @return boolean true if valid, false if not valid |
| 77 | 77 | */ |
| 78 | - public static function validateCSRF(){ |
|
| 78 | + public static function validateCSRF() { |
|
| 79 | 79 | $logger = self::getLogger(); |
| 80 | 80 | $logger->debug('Validation of CSRF ...'); |
| 81 | 81 | |
@@ -83,23 +83,23 @@ discard block |
||
| 83 | 83 | $expire = get_config('csrf_expire', 60); |
| 84 | 84 | $keyExpire = 'csrf_expire'; |
| 85 | 85 | $currentTime = time(); |
| 86 | - $logger->info('The CSRF informations are listed below: key [' .$key. '], key expire [' .$keyExpire. '], expire time [' .$expire. ']'); |
|
| 87 | - if(! Session::exists($key) || Session::get($keyExpire) <= $currentTime){ |
|
| 86 | + $logger->info('The CSRF informations are listed below: key [' . $key . '], key expire [' . $keyExpire . '], expire time [' . $expire . ']'); |
|
| 87 | + if (!Session::exists($key) || Session::get($keyExpire) <= $currentTime) { |
|
| 88 | 88 | $logger->warning('The CSRF session data is not valide'); |
| 89 | 89 | return false; |
| 90 | 90 | } |
| 91 | - else{ |
|
| 91 | + else { |
|
| 92 | 92 | //perform form data |
| 93 | 93 | //need use request->query() for best retrieve |
| 94 | 94 | //super instance |
| 95 | 95 | $obj = & get_instance(); |
| 96 | 96 | $token = $obj->request->query($key); |
| 97 | - if(! $token || $token !== Session::get($key) || Session::get($keyExpire) <= $currentTime){ |
|
| 98 | - $logger->warning('The CSRF data [' .$token. '] is not valide may be attacker do his job'); |
|
| 97 | + if (!$token || $token !== Session::get($key) || Session::get($keyExpire) <= $currentTime) { |
|
| 98 | + $logger->warning('The CSRF data [' . $token . '] is not valide may be attacker do his job'); |
|
| 99 | 99 | return false; |
| 100 | 100 | } |
| 101 | - else{ |
|
| 102 | - $logger->info('The CSRF data [' .$token. '] is valide the form data is safe continue'); |
|
| 101 | + else { |
|
| 102 | + $logger->info('The CSRF data [' . $token . '] is valide the form data is safe continue'); |
|
| 103 | 103 | //remove the token from session |
| 104 | 104 | Session::clear($key); |
| 105 | 105 | Session::clear($keyExpire); |
@@ -111,24 +111,24 @@ discard block |
||
| 111 | 111 | /** |
| 112 | 112 | * This method is used to check the whitelist IP address access |
| 113 | 113 | */ |
| 114 | - public static function checkWhiteListIpAccess(){ |
|
| 114 | + public static function checkWhiteListIpAccess() { |
|
| 115 | 115 | $logger = self::getLogger(); |
| 116 | 116 | $logger->debug('Validation of the IP address access ...'); |
| 117 | 117 | $logger->debug('Check if whitelist IP access is enabled in the configuration ...'); |
| 118 | 118 | $isEnable = get_config('white_list_ip_enable', false); |
| 119 | - if($isEnable){ |
|
| 119 | + if ($isEnable) { |
|
| 120 | 120 | $logger->info('Whitelist IP access is enabled in the configuration'); |
| 121 | 121 | $list = get_config('white_list_ip_addresses', array()); |
| 122 | - if(! empty($list)){ |
|
| 122 | + if (!empty($list)) { |
|
| 123 | 123 | //Can't use Loader::functions() at this time because teh "Loader" library is loader after the security prossessing |
| 124 | 124 | require_once CORE_FUNCTIONS_PATH . 'function_user_agent.php'; |
| 125 | 125 | $ip = get_ip(); |
| 126 | - if((count($list) == 1 && $list[0] == '*') || in_array($ip, $list)){ |
|
| 126 | + if ((count($list) == 1 && $list[0] == '*') || in_array($ip, $list)) { |
|
| 127 | 127 | $logger->info('IP address ' . $ip . ' allowed using the wildcard "*" or the full IP'); |
| 128 | 128 | //wildcard to access all ip address |
| 129 | 129 | return; |
| 130 | 130 | } |
| 131 | - else{ |
|
| 131 | + else { |
|
| 132 | 132 | // go through all whitelisted ips |
| 133 | 133 | foreach ($list as $ipaddr) { |
| 134 | 134 | // find the wild card * in whitelisted ip (f.e. find position in "127.0.*" or "127*") |
@@ -154,7 +154,7 @@ discard block |
||
| 154 | 154 | } |
| 155 | 155 | } |
| 156 | 156 | } |
| 157 | - else{ |
|
| 157 | + else { |
|
| 158 | 158 | $logger->info('Whitelist IP access is not enabled in the configuration, ignore checking'); |
| 159 | 159 | } |
| 160 | 160 | } |
@@ -27,7 +27,7 @@ discard block |
||
| 27 | 27 | /** |
| 28 | 28 | * This class represent the event detail to dispatch to correspond listener |
| 29 | 29 | */ |
| 30 | - class EventInfo{ |
|
| 30 | + class EventInfo { |
|
| 31 | 31 | |
| 32 | 32 | /** |
| 33 | 33 | * The event name |
@@ -54,7 +54,7 @@ discard block |
||
| 54 | 54 | */ |
| 55 | 55 | public $stop; |
| 56 | 56 | |
| 57 | - public function __construct($name, $payload = array(), $returnBack = false, $stop = false){ |
|
| 57 | + public function __construct($name, $payload = array(), $returnBack = false, $stop = false) { |
|
| 58 | 58 | $this->name = $name; |
| 59 | 59 | $this->payload = $payload; |
| 60 | 60 | $this->returnBack = $returnBack; |
@@ -29,7 +29,7 @@ discard block |
||
| 29 | 29 | * also to dispatch the event |
| 30 | 30 | */ |
| 31 | 31 | |
| 32 | - class EventDispatcher{ |
|
| 32 | + class EventDispatcher { |
|
| 33 | 33 | |
| 34 | 34 | /** |
| 35 | 35 | * The list of the registered listeners |
@@ -44,8 +44,8 @@ discard block |
||
| 44 | 44 | */ |
| 45 | 45 | private $logger; |
| 46 | 46 | |
| 47 | - public function __construct(){ |
|
| 48 | - $this->logger =& class_loader('Log', 'classes'); |
|
| 47 | + public function __construct() { |
|
| 48 | + $this->logger = & class_loader('Log', 'classes'); |
|
| 49 | 49 | $this->logger->setLogger('Library::EventDispatcher'); |
| 50 | 50 | } |
| 51 | 51 | |
@@ -54,13 +54,13 @@ discard block |
||
| 54 | 54 | * @param string $eventName the name of the event to register for |
| 55 | 55 | * @param callable $listener the function or class method to receive the event information after dispatch |
| 56 | 56 | */ |
| 57 | - public function addListener($eventName, callable $listener){ |
|
| 58 | - $this->logger->debug('Adding new event listener for the event name [' .$eventName. '], listener [' .stringfy_vars($listener). ']'); |
|
| 59 | - if(! isset($this->listeners[$eventName])){ |
|
| 57 | + public function addListener($eventName, callable $listener) { |
|
| 58 | + $this->logger->debug('Adding new event listener for the event name [' . $eventName . '], listener [' . stringfy_vars($listener) . ']'); |
|
| 59 | + if (!isset($this->listeners[$eventName])) { |
|
| 60 | 60 | $this->logger->info('This event does not have the registered event listener before, adding new one'); |
| 61 | 61 | $this->listeners[$eventName] = array(); |
| 62 | 62 | } |
| 63 | - else{ |
|
| 63 | + else { |
|
| 64 | 64 | $this->logger->info('This event already have the registered listener, add this listener to the list'); |
| 65 | 65 | } |
| 66 | 66 | $this->listeners[$eventName][] = $listener; |
@@ -71,19 +71,19 @@ discard block |
||
| 71 | 71 | * @param string $eventName the event name |
| 72 | 72 | * @param callable $listener the listener callback |
| 73 | 73 | */ |
| 74 | - public function removeListener($eventName, callable $listener){ |
|
| 75 | - $this->logger->debug('Removing of the event listener, the event name [' .$eventName. '], listener [' .stringfy_vars($listener). ']'); |
|
| 76 | - if(isset($this->listeners[$eventName])){ |
|
| 74 | + public function removeListener($eventName, callable $listener) { |
|
| 75 | + $this->logger->debug('Removing of the event listener, the event name [' . $eventName . '], listener [' . stringfy_vars($listener) . ']'); |
|
| 76 | + if (isset($this->listeners[$eventName])) { |
|
| 77 | 77 | $this->logger->info('This event have the listeners, check if this listener exists'); |
| 78 | - if(false !== $index = array_search($listener, $this->listeners[$eventName], true)){ |
|
| 79 | - $this->logger->info('Found the listener at index [' .$index. '] remove it'); |
|
| 78 | + if (false !== $index = array_search($listener, $this->listeners[$eventName], true)) { |
|
| 79 | + $this->logger->info('Found the listener at index [' . $index . '] remove it'); |
|
| 80 | 80 | unset($this->listeners[$eventName][$index]); |
| 81 | 81 | } |
| 82 | - else{ |
|
| 82 | + else { |
|
| 83 | 83 | $this->logger->info('Cannot found this listener in the event listener list'); |
| 84 | 84 | } |
| 85 | 85 | } |
| 86 | - else{ |
|
| 86 | + else { |
|
| 87 | 87 | $this->logger->info('This event does not have this listener ignore remove'); |
| 88 | 88 | } |
| 89 | 89 | } |
@@ -93,13 +93,13 @@ discard block |
||
| 93 | 93 | * remove all listeners for this event |
| 94 | 94 | * @param string $eventName the event name |
| 95 | 95 | */ |
| 96 | - public function removeAllListener($eventName = null){ |
|
| 97 | - $this->logger->debug('Removing of all event listener, the event name [' .$eventName. ']'); |
|
| 98 | - if($eventName !== null && isset($this->listeners[$eventName])){ |
|
| 96 | + public function removeAllListener($eventName = null) { |
|
| 97 | + $this->logger->debug('Removing of all event listener, the event name [' . $eventName . ']'); |
|
| 98 | + if ($eventName !== null && isset($this->listeners[$eventName])) { |
|
| 99 | 99 | $this->logger->info('The event name is set of exist in the listener just remove all event listener for this event'); |
| 100 | 100 | unset($this->listeners[$eventName]); |
| 101 | 101 | } |
| 102 | - else{ |
|
| 102 | + else { |
|
| 103 | 103 | $this->logger->info('The event name is not set or does not exist in the listener, so remove all event listener'); |
| 104 | 104 | $this->listeners = array(); |
| 105 | 105 | } |
@@ -110,7 +110,7 @@ discard block |
||
| 110 | 110 | * @param string $eventName the event name |
| 111 | 111 | * @return array the listeners for this event or empty array if this event does not contain any listener |
| 112 | 112 | */ |
| 113 | - public function getListeners($eventName){ |
|
| 113 | + public function getListeners($eventName) { |
|
| 114 | 114 | return isset($this->listeners[$eventName]) ? $this->listeners[$eventName] : array(); |
| 115 | 115 | } |
| 116 | 116 | |
@@ -119,21 +119,21 @@ discard block |
||
| 119 | 119 | * @param mixed|object $event the event information |
| 120 | 120 | * @return void|object if event need return, will return the final EventInfo object. |
| 121 | 121 | */ |
| 122 | - public function dispatch($event){ |
|
| 123 | - if(! $event || !$event instanceof EventInfo){ |
|
| 122 | + public function dispatch($event) { |
|
| 123 | + if (!$event || !$event instanceof EventInfo) { |
|
| 124 | 124 | $this->logger->info('The event is not set or is not an instance of "EventInfo" create the default "EventInfo" object to use instead of.'); |
| 125 | 125 | $event = new EventInfo((string) $event); |
| 126 | 126 | } |
| 127 | - $this->logger->debug('Dispatch to the event listener, the event [' .stringfy_vars($event). ']'); |
|
| 128 | - if(isset($event->stop) && $event->stop){ |
|
| 127 | + $this->logger->debug('Dispatch to the event listener, the event [' . stringfy_vars($event) . ']'); |
|
| 128 | + if (isset($event->stop) && $event->stop) { |
|
| 129 | 129 | $this->logger->info('This event need stopped, no need call any listener'); |
| 130 | 130 | return; |
| 131 | 131 | } |
| 132 | - if($event->returnBack){ |
|
| 132 | + if ($event->returnBack) { |
|
| 133 | 133 | $this->logger->info('This event need return back, return the result for future use'); |
| 134 | 134 | return $this->dispatchToListerners($event); |
| 135 | 135 | } |
| 136 | - else{ |
|
| 136 | + else { |
|
| 137 | 137 | $this->logger->info('This event no need return back the result, just dispatch it'); |
| 138 | 138 | $this->dispatchToListerners($event); |
| 139 | 139 | } |
@@ -144,38 +144,38 @@ discard block |
||
| 144 | 144 | * @param object EventInfo $event the event information |
| 145 | 145 | * @return void|object if event need return, will return the final EventInfo instance. |
| 146 | 146 | */ |
| 147 | - private function dispatchToListerners(EventInfo $event){ |
|
| 147 | + private function dispatchToListerners(EventInfo $event) { |
|
| 148 | 148 | $eBackup = $event; |
| 149 | 149 | $list = $this->getListeners($event->name); |
| 150 | - if(empty($list)){ |
|
| 151 | - $this->logger->info('No event listener is registered for the event [' .$event->name. '] skipping.'); |
|
| 152 | - if($event->returnBack){ |
|
| 150 | + if (empty($list)) { |
|
| 151 | + $this->logger->info('No event listener is registered for the event [' . $event->name . '] skipping.'); |
|
| 152 | + if ($event->returnBack) { |
|
| 153 | 153 | return $event; |
| 154 | 154 | } |
| 155 | 155 | return; |
| 156 | 156 | } |
| 157 | - else{ |
|
| 158 | - $this->logger->info('Found the registered event listener for the event [' .$event->name. '] the list are: ' . stringfy_vars($list)); |
|
| 157 | + else { |
|
| 158 | + $this->logger->info('Found the registered event listener for the event [' . $event->name . '] the list are: ' . stringfy_vars($list)); |
|
| 159 | 159 | } |
| 160 | - foreach($list as $listener){ |
|
| 161 | - if($eBackup->returnBack){ |
|
| 160 | + foreach ($list as $listener) { |
|
| 161 | + if ($eBackup->returnBack) { |
|
| 162 | 162 | $returnedEvent = call_user_func_array($listener, array($event)); |
| 163 | - if($returnedEvent instanceof EventInfo){ |
|
| 163 | + if ($returnedEvent instanceof EventInfo) { |
|
| 164 | 164 | $event = $returnedEvent; |
| 165 | 165 | } |
| 166 | - else{ |
|
| 167 | - show_error('This event [' .$event->name. '] need you return the event object after processing'); |
|
| 166 | + else { |
|
| 167 | + show_error('This event [' . $event->name . '] need you return the event object after processing'); |
|
| 168 | 168 | } |
| 169 | 169 | } |
| 170 | - else{ |
|
| 170 | + else { |
|
| 171 | 171 | call_user_func_array($listener, array($event)); |
| 172 | 172 | } |
| 173 | - if($event->stop){ |
|
| 173 | + if ($event->stop) { |
|
| 174 | 174 | break; |
| 175 | 175 | } |
| 176 | 176 | } |
| 177 | 177 | //only test for original event may be during the flow some listeners change this parameter |
| 178 | - if($eBackup->returnBack){ |
|
| 178 | + if ($eBackup->returnBack) { |
|
| 179 | 179 | return $event; |
| 180 | 180 | } |
| 181 | 181 | } |
@@ -24,7 +24,7 @@ discard block |
||
| 24 | 24 | * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
| 25 | 25 | */ |
| 26 | 26 | |
| 27 | - class Response{ |
|
| 27 | + class Response { |
|
| 28 | 28 | |
| 29 | 29 | /** |
| 30 | 30 | * The list of request header to send with response |
@@ -65,9 +65,9 @@ discard block |
||
| 65 | 65 | /** |
| 66 | 66 | * Construct new response instance |
| 67 | 67 | */ |
| 68 | - public function __construct(){ |
|
| 69 | - $this->_currentUrl = (! empty($_SERVER['REQUEST_URI']) ? $_SERVER['REQUEST_URI'] : '' ) |
|
| 70 | - . (! empty($_SERVER['QUERY_STRING']) ? ('?' . $_SERVER['QUERY_STRING']) : '' ); |
|
| 68 | + public function __construct() { |
|
| 69 | + $this->_currentUrl = (!empty($_SERVER['REQUEST_URI']) ? $_SERVER['REQUEST_URI'] : '') |
|
| 70 | + . (!empty($_SERVER['QUERY_STRING']) ? ('?' . $_SERVER['QUERY_STRING']) : ''); |
|
| 71 | 71 | |
| 72 | 72 | $this->_currentUrlCacheKey = md5($this->_currentUrl); |
| 73 | 73 | |
@@ -82,9 +82,9 @@ discard block |
||
| 82 | 82 | * Get the logger singleton instance |
| 83 | 83 | * @return Log the logger instance |
| 84 | 84 | */ |
| 85 | - private static function getLogger(){ |
|
| 86 | - if(self::$logger == null){ |
|
| 87 | - self::$logger[0] =& class_loader('Log', 'classes'); |
|
| 85 | + private static function getLogger() { |
|
| 86 | + if (self::$logger == null) { |
|
| 87 | + self::$logger[0] = & class_loader('Log', 'classes'); |
|
| 88 | 88 | self::$logger[0]->setLogger('Library::Response'); |
| 89 | 89 | } |
| 90 | 90 | return self::$logger[0]; |
@@ -95,12 +95,12 @@ discard block |
||
| 95 | 95 | * @param integer $httpCode the HTTP status code |
| 96 | 96 | * @param array $headers the additional headers to add to the existing headers list |
| 97 | 97 | */ |
| 98 | - public static function sendHeaders($httpCode = 200, array $headers = array()){ |
|
| 98 | + public static function sendHeaders($httpCode = 200, array $headers = array()) { |
|
| 99 | 99 | set_http_status_header($httpCode); |
| 100 | 100 | self::setHeaders($headers); |
| 101 | - if(! headers_sent()){ |
|
| 102 | - foreach(self::getHeaders() as $key => $value){ |
|
| 103 | - header($key .': '.$value); |
|
| 101 | + if (!headers_sent()) { |
|
| 102 | + foreach (self::getHeaders() as $key => $value) { |
|
| 103 | + header($key . ': ' . $value); |
|
| 104 | 104 | } |
| 105 | 105 | } |
| 106 | 106 | } |
@@ -109,7 +109,7 @@ discard block |
||
| 109 | 109 | * Get the list of the headers |
| 110 | 110 | * @return array the headers list |
| 111 | 111 | */ |
| 112 | - public static function getHeaders(){ |
|
| 112 | + public static function getHeaders() { |
|
| 113 | 113 | return self::$headers; |
| 114 | 114 | } |
| 115 | 115 | |
@@ -118,7 +118,7 @@ discard block |
||
| 118 | 118 | * @param string $name the header name |
| 119 | 119 | * @return string the header value |
| 120 | 120 | */ |
| 121 | - public static function getHeader($name){ |
|
| 121 | + public static function getHeader($name) { |
|
| 122 | 122 | return array_key_exists($name, self::$headers) ? self::$headers[$name] : null; |
| 123 | 123 | } |
| 124 | 124 | |
@@ -128,7 +128,7 @@ discard block |
||
| 128 | 128 | * @param string $name the header name |
| 129 | 129 | * @param string $value the header value to be set |
| 130 | 130 | */ |
| 131 | - public static function setHeader($name, $value){ |
|
| 131 | + public static function setHeader($name, $value) { |
|
| 132 | 132 | self::$headers[$name] = $value; |
| 133 | 133 | } |
| 134 | 134 | |
@@ -137,7 +137,7 @@ discard block |
||
| 137 | 137 | * @param array $headers the list of the headers to set. |
| 138 | 138 | * Note: this will merge with the existing headers |
| 139 | 139 | */ |
| 140 | - public static function setHeaders(array $headers){ |
|
| 140 | + public static function setHeaders(array $headers) { |
|
| 141 | 141 | self::$headers = array_merge(self::getHeaders(), $headers); |
| 142 | 142 | } |
| 143 | 143 | |
@@ -145,17 +145,17 @@ discard block |
||
| 145 | 145 | * Redirect user in the specified page |
| 146 | 146 | * @param string $path the URL or URI to be redirect to |
| 147 | 147 | */ |
| 148 | - public static function redirect($path = ''){ |
|
| 148 | + public static function redirect($path = '') { |
|
| 149 | 149 | $logger = self::getLogger(); |
| 150 | 150 | $url = Url::site_url($path); |
| 151 | - $logger->info('Redirect to URL [' .$url. ']'); |
|
| 152 | - if(! headers_sent()){ |
|
| 153 | - header('Location: '.$url); |
|
| 151 | + $logger->info('Redirect to URL [' . $url . ']'); |
|
| 152 | + if (!headers_sent()) { |
|
| 153 | + header('Location: ' . $url); |
|
| 154 | 154 | exit; |
| 155 | 155 | } |
| 156 | - else{ |
|
| 156 | + else { |
|
| 157 | 157 | echo '<script> |
| 158 | - location.href = "'.$url.'"; |
|
| 158 | + location.href = "'.$url . '"; |
|
| 159 | 159 | </script>'; |
| 160 | 160 | } |
| 161 | 161 | } |
@@ -168,10 +168,10 @@ discard block |
||
| 168 | 168 | * @return void|string if $return is true will return the view content otherwise |
| 169 | 169 | * will display the view content. |
| 170 | 170 | */ |
| 171 | - public function render($view, $data = null, $return = false){ |
|
| 171 | + public function render($view, $data = null, $return = false) { |
|
| 172 | 172 | $logger = self::getLogger(); |
| 173 | 173 | //convert data to an array |
| 174 | - $data = ! is_array($data) ? (array) $data : $data; |
|
| 174 | + $data = !is_array($data) ? (array) $data : $data; |
|
| 175 | 175 | $view = str_ireplace('.php', '', $view); |
| 176 | 176 | $view = trim($view, '/\\'); |
| 177 | 177 | $viewFile = $view . '.php'; |
@@ -180,42 +180,42 @@ discard block |
||
| 180 | 180 | //super instance |
| 181 | 181 | $obj = & get_instance(); |
| 182 | 182 | |
| 183 | - if(Module::hasModule()){ |
|
| 183 | + if (Module::hasModule()) { |
|
| 184 | 184 | //check in module first |
| 185 | 185 | $logger->debug('Checking the view [' . $view . '] from module list ...'); |
| 186 | 186 | $mod = null; |
| 187 | 187 | //check if the request class contains module name |
| 188 | - if(strpos($view, '/') !== false){ |
|
| 188 | + if (strpos($view, '/') !== false) { |
|
| 189 | 189 | $viewPath = explode('/', $view); |
| 190 | - if(isset($viewPath[0]) && in_array($viewPath[0], Module::getModuleList())){ |
|
| 190 | + if (isset($viewPath[0]) && in_array($viewPath[0], Module::getModuleList())) { |
|
| 191 | 191 | $mod = $viewPath[0]; |
| 192 | 192 | array_shift($viewPath); |
| 193 | 193 | $view = implode('/', $viewPath); |
| 194 | 194 | $viewFile = $view . '.php'; |
| 195 | 195 | } |
| 196 | 196 | } |
| 197 | - if(! $mod && !empty($obj->moduleName)){ |
|
| 197 | + if (!$mod && !empty($obj->moduleName)) { |
|
| 198 | 198 | $mod = $obj->moduleName; |
| 199 | 199 | } |
| 200 | - if($mod){ |
|
| 200 | + if ($mod) { |
|
| 201 | 201 | $moduleViewPath = Module::findViewFullPath($view, $mod); |
| 202 | - if($moduleViewPath){ |
|
| 202 | + if ($moduleViewPath) { |
|
| 203 | 203 | $path = $moduleViewPath; |
| 204 | - $logger->info('Found view [' . $view . '] in module [' .$mod. '], the file path is [' .$moduleViewPath. '] we will used it'); |
|
| 204 | + $logger->info('Found view [' . $view . '] in module [' . $mod . '], the file path is [' . $moduleViewPath . '] we will used it'); |
|
| 205 | 205 | } |
| 206 | - else{ |
|
| 207 | - $logger->info('Cannot find view [' . $view . '] in module [' .$mod. '] using the default location'); |
|
| 206 | + else { |
|
| 207 | + $logger->info('Cannot find view [' . $view . '] in module [' . $mod . '] using the default location'); |
|
| 208 | 208 | } |
| 209 | 209 | } |
| 210 | - else{ |
|
| 210 | + else { |
|
| 211 | 211 | $logger->info('The current request does not use module using the default location.'); |
| 212 | 212 | } |
| 213 | 213 | } |
| 214 | 214 | $logger->info('The view file path to be loaded is [' . $path . ']'); |
| 215 | 215 | $found = false; |
| 216 | - if(file_exists($path)){ |
|
| 217 | - foreach(get_object_vars($obj) as $key => $value){ |
|
| 218 | - if(! isset($this->{$key})){ |
|
| 216 | + if (file_exists($path)) { |
|
| 217 | + foreach (get_object_vars($obj) as $key => $value) { |
|
| 218 | + if (!isset($this->{$key})) { |
|
| 219 | 219 | $this->{$key} = & $obj->{$key}; |
| 220 | 220 | } |
| 221 | 221 | } |
@@ -224,39 +224,39 @@ discard block |
||
| 224 | 224 | //need use require() instead of require_once because can load this view many time |
| 225 | 225 | require $path; |
| 226 | 226 | $content = ob_get_clean(); |
| 227 | - if($return){ |
|
| 227 | + if ($return) { |
|
| 228 | 228 | return $content; |
| 229 | 229 | } |
| 230 | 230 | $this->_pageRender .= $content; |
| 231 | 231 | $found = true; |
| 232 | 232 | } |
| 233 | - if(! $found){ |
|
| 234 | - show_error('Unable to find view [' .$view . ']'); |
|
| 233 | + if (!$found) { |
|
| 234 | + show_error('Unable to find view [' . $view . ']'); |
|
| 235 | 235 | } |
| 236 | 236 | } |
| 237 | 237 | |
| 238 | 238 | /** |
| 239 | 239 | * Send the final page output to user |
| 240 | 240 | */ |
| 241 | - public function renderFinalPage(){ |
|
| 241 | + public function renderFinalPage() { |
|
| 242 | 242 | $logger = self::getLogger(); |
| 243 | 243 | $obj = & get_instance(); |
| 244 | 244 | $cachePageStatus = get_config('cache_enable', false) && !empty($obj->view_cache_enable); |
| 245 | 245 | $dispatcher = $obj->eventdispatcher; |
| 246 | 246 | $content = $this->_pageRender; |
| 247 | - if(! $content){ |
|
| 247 | + if (!$content) { |
|
| 248 | 248 | $logger->warning('The final view content is empty.'); |
| 249 | 249 | return; |
| 250 | 250 | } |
| 251 | 251 | //dispatch |
| 252 | 252 | $event = $dispatcher->dispatch(new EventInfo('FINAL_VIEW_READY', $content, true)); |
| 253 | - $content = ! empty($event->payload) ? $event->payload : null; |
|
| 254 | - if(empty($content)){ |
|
| 253 | + $content = !empty($event->payload) ? $event->payload : null; |
|
| 254 | + if (empty($content)) { |
|
| 255 | 255 | $logger->warning('The view content is empty after dispatch to event listeners.'); |
| 256 | 256 | } |
| 257 | 257 | |
| 258 | 258 | //check whether need save the page into cache. |
| 259 | - if($cachePageStatus){ |
|
| 259 | + if ($cachePageStatus) { |
|
| 260 | 260 | //current page URL |
| 261 | 261 | $url = $this->_currentUrl; |
| 262 | 262 | //Cache view Time to live in second |
@@ -271,14 +271,14 @@ discard block |
||
| 271 | 271 | |
| 272 | 272 | //get the cache information to prepare header to send to browser |
| 273 | 273 | $cacheInfo = $cacheInstance->getInfo($cacheKey); |
| 274 | - if($cacheInfo){ |
|
| 274 | + if ($cacheInfo) { |
|
| 275 | 275 | $lastModified = $cacheInfo['mtime']; |
| 276 | 276 | $expire = $cacheInfo['expire']; |
| 277 | 277 | $maxAge = $expire - time(); |
| 278 | 278 | self::setHeader('Pragma', 'public'); |
| 279 | 279 | self::setHeader('Cache-Control', 'max-age=' . $maxAge . ', public'); |
| 280 | - self::setHeader('Expires', gmdate('D, d M Y H:i:s', $expire).' GMT'); |
|
| 281 | - self::setHeader('Last-modified', gmdate('D, d M Y H:i:s', $lastModified).' GMT'); |
|
| 280 | + self::setHeader('Expires', gmdate('D, d M Y H:i:s', $expire) . ' GMT'); |
|
| 281 | + self::setHeader('Last-modified', gmdate('D, d M Y H:i:s', $lastModified) . ' GMT'); |
|
| 282 | 282 | } |
| 283 | 283 | } |
| 284 | 284 | |
@@ -289,10 +289,10 @@ discard block |
||
| 289 | 289 | $content = str_replace(array('{elapsed_time}', '{memory_usage}'), array($elapsedTime, $memoryUsage), $content); |
| 290 | 290 | |
| 291 | 291 | //compress the output if is available |
| 292 | - if (self::$_canCompressOutput){ |
|
| 292 | + if (self::$_canCompressOutput) { |
|
| 293 | 293 | ob_start('ob_gzhandler'); |
| 294 | 294 | } |
| 295 | - else{ |
|
| 295 | + else { |
|
| 296 | 296 | ob_start(); |
| 297 | 297 | } |
| 298 | 298 | self::sendHeaders(200); |
@@ -303,7 +303,7 @@ discard block |
||
| 303 | 303 | /** |
| 304 | 304 | * Send the final page output to user if is cached |
| 305 | 305 | */ |
| 306 | - public function renderFinalPageFromCache(&$cache){ |
|
| 306 | + public function renderFinalPageFromCache(&$cache) { |
|
| 307 | 307 | $logger = self::getLogger(); |
| 308 | 308 | $url = $this->_currentUrl; |
| 309 | 309 | //the current page cache key for identification |
@@ -312,25 +312,25 @@ discard block |
||
| 312 | 312 | $logger->debug('Checking if the page content for the URL [' . $url . '] is cached ...'); |
| 313 | 313 | //get the cache information to prepare header to send to browser |
| 314 | 314 | $cacheInfo = $cache->getInfo($pageCacheKey); |
| 315 | - if($cacheInfo){ |
|
| 315 | + if ($cacheInfo) { |
|
| 316 | 316 | $lastModified = $cacheInfo['mtime']; |
| 317 | 317 | $expire = $cacheInfo['expire']; |
| 318 | 318 | $maxAge = $expire - $_SERVER['REQUEST_TIME']; |
| 319 | 319 | self::setHeader('Pragma', 'public'); |
| 320 | 320 | self::setHeader('Cache-Control', 'max-age=' . $maxAge . ', public'); |
| 321 | - self::setHeader('Expires', gmdate('D, d M Y H:i:s', $expire).' GMT'); |
|
| 322 | - self::setHeader('Last-modified', gmdate('D, d M Y H:i:s', $lastModified).' GMT'); |
|
| 323 | - if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) && $lastModified <= strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE'])){ |
|
| 321 | + self::setHeader('Expires', gmdate('D, d M Y H:i:s', $expire) . ' GMT'); |
|
| 322 | + self::setHeader('Last-modified', gmdate('D, d M Y H:i:s', $lastModified) . ' GMT'); |
|
| 323 | + if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) && $lastModified <= strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE'])) { |
|
| 324 | 324 | $logger->info('The cache page content is not yet expire for the URL [' . $url . '] send 304 header to browser'); |
| 325 | 325 | self::sendHeaders(304); |
| 326 | 326 | return; |
| 327 | 327 | } |
| 328 | - else{ |
|
| 328 | + else { |
|
| 329 | 329 | $logger->info('The cache page content is expired or the browser don\'t send the HTTP_IF_MODIFIED_SINCE header for the URL [' . $url . '] send cache headers to tell the browser'); |
| 330 | 330 | self::sendHeaders(200); |
| 331 | 331 | //get the cache content |
| 332 | 332 | $content = $cache->get($pageCacheKey); |
| 333 | - if($content){ |
|
| 333 | + if ($content) { |
|
| 334 | 334 | $logger->info('The page content for the URL [' . $url . '] already cached just display it'); |
| 335 | 335 | //load benchmark class |
| 336 | 336 | $benchmark = & class_loader('Benchmark'); |
@@ -343,17 +343,17 @@ discard block |
||
| 343 | 343 | |
| 344 | 344 | ///display the final output |
| 345 | 345 | //compress the output if is available |
| 346 | - if (self::$_canCompressOutput){ |
|
| 346 | + if (self::$_canCompressOutput) { |
|
| 347 | 347 | ob_start('ob_gzhandler'); |
| 348 | 348 | } |
| 349 | - else{ |
|
| 349 | + else { |
|
| 350 | 350 | ob_start(); |
| 351 | 351 | } |
| 352 | 352 | echo $content; |
| 353 | 353 | ob_end_flush(); |
| 354 | 354 | return; |
| 355 | 355 | } |
| 356 | - else{ |
|
| 356 | + else { |
|
| 357 | 357 | $logger->info('The page cache content for the URL [' . $url . '] is not valid may be already expired'); |
| 358 | 358 | $cache->delete($pageCacheKey); |
| 359 | 359 | } |
@@ -365,7 +365,7 @@ discard block |
||
| 365 | 365 | * Get the final page to be rendered |
| 366 | 366 | * @return string |
| 367 | 367 | */ |
| 368 | - public function getFinalPageRendered(){ |
|
| 368 | + public function getFinalPageRendered() { |
|
| 369 | 369 | return $this->_pageRender; |
| 370 | 370 | } |
| 371 | 371 | |
@@ -373,14 +373,14 @@ discard block |
||
| 373 | 373 | * Send the HTTP 404 error if can not found the |
| 374 | 374 | * routing information for the current request |
| 375 | 375 | */ |
| 376 | - public static function send404(){ |
|
| 376 | + public static function send404() { |
|
| 377 | 377 | /********* for logs **************/ |
| 378 | 378 | //can't use $obj = & get_instance() here because the global super object will be available until |
| 379 | 379 | //the main controller is loaded even for Loader::library('xxxx'); |
| 380 | 380 | $logger = self::getLogger(); |
| 381 | - $request =& class_loader('Request', 'classes'); |
|
| 382 | - $userAgent =& class_loader('Browser'); |
|
| 383 | - $browser = $userAgent->getPlatform().', '.$userAgent->getBrowser().' '.$userAgent->getVersion(); |
|
| 381 | + $request = & class_loader('Request', 'classes'); |
|
| 382 | + $userAgent = & class_loader('Browser'); |
|
| 383 | + $browser = $userAgent->getPlatform() . ', ' . $userAgent->getBrowser() . ' ' . $userAgent->getVersion(); |
|
| 384 | 384 | |
| 385 | 385 | //here can't use Loader::functions just include the helper manually |
| 386 | 386 | require_once CORE_FUNCTIONS_PATH . 'function_user_agent.php'; |
@@ -390,12 +390,12 @@ discard block |
||
| 390 | 390 | $logger->error($str); |
| 391 | 391 | /***********************************/ |
| 392 | 392 | $path = CORE_VIEWS_PATH . '404.php'; |
| 393 | - if(file_exists($path)){ |
|
| 393 | + if (file_exists($path)) { |
|
| 394 | 394 | //compress the output if is available |
| 395 | - if (self::$_canCompressOutput){ |
|
| 395 | + if (self::$_canCompressOutput) { |
|
| 396 | 396 | ob_start('ob_gzhandler'); |
| 397 | 397 | } |
| 398 | - else{ |
|
| 398 | + else { |
|
| 399 | 399 | ob_start(); |
| 400 | 400 | } |
| 401 | 401 | require_once $path; |
@@ -403,8 +403,8 @@ discard block |
||
| 403 | 403 | self::sendHeaders(404); |
| 404 | 404 | echo $output; |
| 405 | 405 | } |
| 406 | - else{ |
|
| 407 | - show_error('The 404 view [' .$path. '] does not exist'); |
|
| 406 | + else { |
|
| 407 | + show_error('The 404 view [' . $path . '] does not exist'); |
|
| 408 | 408 | } |
| 409 | 409 | } |
| 410 | 410 | |
@@ -412,14 +412,14 @@ discard block |
||
| 412 | 412 | * Display the error to user |
| 413 | 413 | * @param array $data the error information |
| 414 | 414 | */ |
| 415 | - public static function sendError(array $data = array()){ |
|
| 415 | + public static function sendError(array $data = array()) { |
|
| 416 | 416 | $path = CORE_VIEWS_PATH . 'errors.php'; |
| 417 | - if(file_exists($path)){ |
|
| 417 | + if (file_exists($path)) { |
|
| 418 | 418 | //compress the output if exists |
| 419 | - if (self::$_canCompressOutput){ |
|
| 419 | + if (self::$_canCompressOutput) { |
|
| 420 | 420 | ob_start('ob_gzhandler'); |
| 421 | 421 | } |
| 422 | - else{ |
|
| 422 | + else { |
|
| 423 | 423 | ob_start(); |
| 424 | 424 | } |
| 425 | 425 | extract($data); |
@@ -428,7 +428,7 @@ discard block |
||
| 428 | 428 | self::sendHeaders(503); |
| 429 | 429 | echo $output; |
| 430 | 430 | } |
| 431 | - else{ |
|
| 431 | + else { |
|
| 432 | 432 | //can't use show_error() at this time because some dependencies not yet loaded and to prevent loop |
| 433 | 433 | set_http_status_header(503); |
| 434 | 434 | echo 'The error view [' . $path . '] does not exist'; |