2020-05-02 17:48:34 +02:00
< ? php
/*******************************************************************************
* Copyright ( C ) 2007 Easter - eggs
2021-04-13 18:04:19 +02:00
* https :// ldapsaisie . org
2020-05-02 17:48:34 +02:00
*
* Author : See AUTHORS file in top - level directory .
*
* This program is free software ; you can redistribute it and / or
* modify it under the terms of the GNU General Public License version 2
* as published by the Free Software Foundation .
*
* This program is distributed in the hope that it will be useful ,
* but WITHOUT ANY WARRANTY ; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE . See the
* GNU General Public License for more details .
*
* You should have received a copy of the GNU General Public License
* along with this program ; if not , write to the Free Software
* Foundation , Inc . , 59 Temple Place - Suite 330 , Boston , MA 02111 - 1307 , USA .
******************************************************************************/
LSsession :: loadLSclass ( 'LSurlRequest' );
2020-05-08 12:48:06 +02:00
LSsession :: loadLSclass ( 'LSlog_staticLoggerClass' );
2020-05-02 17:48:34 +02:00
/**
* URL Routing Manager for LdapSaisie
*
* @ author Benjamin Renard < brenard @ easter - eggs . com >
*/
2020-05-08 12:48:06 +02:00
class LSurl extends LSlog_staticLoggerClass {
2020-05-02 17:48:34 +02:00
/*
* Configured URL patterns :
*
2021-08-18 12:29:50 +02:00
* Example :
2020-05-02 17:48:34 +02:00
*
* array (
* '|get/(?P<name>[a-zA-Z0-9]+)$|' => array (
* 'handler' => 'get' ,
* 'authenticated' => true ,
2021-08-18 12:29:50 +02:00
* 'api_mode' => false ,
* 'methods' => array ( 'GET' ),
2020-05-02 17:48:34 +02:00
* ),
* '|get/all$|' => => array (
* 'handler' => 'get_all' ,
* 'authenticated' => true ,
2021-08-18 12:29:50 +02:00
* 'api_mode' => false ,
* 'methods' => array ( 'GET' , 'POST' ),
2020-05-02 17:48:34 +02:00
* ),
* )
*
*/
private static $patterns = array ();
/**
* Add an URL pattern
*
* @ param [ in ] $pattern string The URL pattern ( required )
* @ param [ in ] $handler callable The URL pattern handler ( must be callable , required )
* @ param [ in ] $authenticated boolean Permit to define if this URL is accessible only for authenticated users ( optional , default : true )
* @ param [ in ] $override boolean Allow override if a command already exists with the same name ( optional , default : false )
2021-02-03 14:40:28 +01:00
* @ param [ in ] $api_mode boolean Enable API mode ( optional , default : false )
2021-06-24 10:21:50 +02:00
* @ param [ in ] $methods array | null HTTP method ( optional , default : array ( 'GET' , 'POST' ))
2020-05-02 17:48:34 +02:00
**/
2021-06-24 10:21:50 +02:00
public static function add_handler ( $pattern , $handler = null , $authenticated = true , $override = true , $api_mode = false , $methods = null ) {
if ( is_null ( $methods ))
$methods = array ( 'GET' , 'POST' );
else
$methods = ensureIsArray ( $methods );
2020-05-02 17:48:34 +02:00
if ( is_array ( $pattern )) {
if ( is_null ( $handler ))
foreach ( $pattern as $p => $h )
2021-08-18 12:29:50 +02:00
self :: add_handler ( $p , $h , $authenticated , $override , $api_mode , $methods );
2020-05-02 17:48:34 +02:00
else
foreach ( $pattern as $p )
2021-08-18 12:29:50 +02:00
self :: add_handler ( $p , $handler , $authenticated , $override , $api_mode , $methods );
2020-05-02 17:48:34 +02:00
}
else {
if ( ! isset ( self :: $patterns [ $pattern ])) {
self :: $patterns [ $pattern ] = array (
'handler' => $handler ,
'authenticated' => $authenticated ,
2021-02-03 14:40:28 +01:00
'api_mode' => $api_mode ,
2021-06-24 10:21:50 +02:00
'methods' => $methods ,
2020-05-02 17:48:34 +02:00
);
}
elseif ( $override ) {
2020-05-08 15:16:24 +02:00
self :: log_debug ( " URL : override pattern ' $pattern ' with handler ' $handler ' (old handler = ' " . self :: $patterns [ $pattern ] . " ') " );
2020-05-02 17:48:34 +02:00
self :: $patterns [ $pattern ] = array (
'handler' => $handler ,
'authenticated' => $authenticated ,
2021-02-03 14:40:28 +01:00
'api_mode' => $api_mode ,
2021-06-24 10:21:50 +02:00
'methods' => $methods ,
2020-05-02 17:48:34 +02:00
);
}
else {
2020-05-08 15:16:24 +02:00
self :: log_debug ( " URL : pattern ' $pattern ' already defined : do not override. " );
2020-05-02 17:48:34 +02:00
}
}
}
/**
* Interprets the requested URL and return the corresponding LSurlRequest object
*
* @ param [ in ] $default_url string | null The default URL if current one does not
* match with any configured pattern .
*
* @ retval LSurlRequest The LSurlRequest object corresponding to the the requested URL .
**/
private static function get_request ( $default_url = null ) {
$current_url = self :: get_current_url ();
if ( is_null ( $current_url )) {
2020-05-08 15:16:24 +02:00
self :: log_fatal ( _ ( " Fail to determine the requested URL. " ));
2020-05-02 17:48:34 +02:00
exit ();
}
if ( ! is_array ( self :: $patterns )) {
2020-06-25 16:03:49 +02:00
self :: log_fatal ( _ ( " No URL patterns configured ! " ));
2020-05-02 17:48:34 +02:00
exit ();
}
2020-05-08 15:16:24 +02:00
self :: log_debug ( " URL : current url = ' $current_url ' " );
self :: log_debug ( " URL : check current url with the following URL patterns : \n - " . implode ( " \n - " , array_keys ( self :: $patterns )));
2020-05-02 17:48:34 +02:00
foreach ( self :: $patterns as $pattern => $handler_infos ) {
2021-06-24 10:21:50 +02:00
$m = self :: url_match ( $pattern , $current_url , $handler_infos [ 'methods' ]);
2020-05-02 17:48:34 +02:00
if ( is_array ( $m )) {
$request = new LSurlRequest ( $current_url , $handler_infos , $m );
// Reset last redirect
if ( isset ( $_SESSION [ 'last_redirect' ]))
unset ( $_SESSION [ 'last_redirect' ]);
2020-05-08 15:16:24 +02:00
self :: log_debug ( " URL : result : \n " . varDump ( $request , 1 ));
2020-05-02 17:48:34 +02:00
return $request ;
}
}
if ( ! is_null ( $default_url )) {
2020-05-08 15:16:24 +02:00
self :: log_debug ( " Current URL match with no pattern. Redirect to default URL (' $default_url ') " );
2020-05-02 17:48:34 +02:00
self :: redirect ( $default_url );
exit ();
}
2021-02-03 14:40:28 +01:00
// Error 404
$api_mode = ( strpos ( $current_url , 'api/' ) === 0 );
self :: log_debug ( " Current URL match with no pattern. Use error 404 handler (API mode= $api_mode ). " );
2020-05-02 17:48:34 +02:00
return new LSurlRequest (
$current_url ,
array (
'handler' => array ( 'LSurl' , 'error_404' ),
'authenticated' => false ,
2021-02-03 14:40:28 +01:00
'api_mode' => $api_mode ,
2020-05-02 17:48:34 +02:00
)
);
}
/**
* Check if the current requested URL match with a specific pattern
*
* @ param [ in ] $pattern string The URL pattern
* @ param [ in ] $current_url string | false The current URL ( optional )
2021-06-24 10:21:50 +02:00
* @ param [ in ] $methods array | null HTTP method ( optional , default : no check )
2020-05-02 17:48:34 +02:00
*
* @ retval array | false The URL info if pattern matched , false otherwise .
**/
2021-06-24 10:21:50 +02:00
private static function url_match ( $pattern , $current_url = false , $methods = null ) {
if ( $methods && ! in_array ( $_SERVER [ 'REQUEST_METHOD' ], $methods ))
return false ;
2020-05-02 17:48:34 +02:00
if ( $current_url === false ) {
$current_url = self :: get_current_url ();
if ( ! $current_url ) return False ;
}
if ( preg_match ( $pattern , $current_url , $m )) {
2020-05-08 15:16:24 +02:00
self :: log_debug ( " URL : Match found with pattern ' $pattern ' : \n \t " . str_replace ( " \n " , " \n \t " , print_r ( $m , 1 )));
2020-05-02 17:48:34 +02:00
return $m ;
}
return False ;
}
2020-05-07 11:35:38 +02:00
/**
* Get the public absolute URL
*
* @ param [ in ] $relative_url string | null Relative URL to convert ( Default : current URL )
*
* @ retval string The public absolute URL
**/
public static function get_public_absolute_url ( $relative_url = null ) {
if ( ! is_string ( $relative_url ))
$relative_url = self :: get_current_url ();
$public_root_url = LSconfig :: get ( 'public_root_url' , '/' , 'string' );
if ( $public_root_url [ 0 ] == '/' ) {
2020-05-08 15:16:24 +02:00
self :: log_debug ( " LSurl :: get_public_absolute_url( $relative_url ): configured public root URL is relative ( $public_root_url ) => try to detect it from current request infos. " );
2020-05-07 11:35:38 +02:00
$public_root_url = 'http' . ( isset ( $_SERVER [ 'HTTPS' ]) && $_SERVER [ 'HTTPS' ] == 'on' ? 's' : '' ) . '://' . $_SERVER [ 'HTTP_HOST' ] . $public_root_url ;
2020-05-08 15:16:24 +02:00
self :: log_debug ( " LSurl :: get_public_absolute_url( $relative_url ): detected public_root_url: $public_root_url " );
2020-05-07 11:35:38 +02:00
}
$url = self :: remove_trailing_slash ( $public_root_url ) . " / $relative_url " ;
2020-05-08 15:16:24 +02:00
self :: log_debug ( " LSurl :: get_public_absolute_url( $relative_url ): result = $url " );
2020-05-07 11:35:38 +02:00
return $url ;
}
2020-05-02 17:48:34 +02:00
/**
* Trigger redirect to specified URL ( or homepage if omited )
*
* @ param [ in ] $go string | false The destination URL
*
* @ retval void
**/
public static function redirect ( $go = false ) {
$public_root_url = LSconfig :: get ( 'public_root_url' , '/' , 'string' );
if ( $go === false )
$go = " " ;
2020-08-20 18:11:48 +02:00
if ( preg_match ( '#^(https?:)?//#' , $go )) {
2020-05-02 17:48:34 +02:00
$url = $go ;
}
else {
// Check $public_root_url end
if ( substr ( $public_root_url , - 1 ) == '/' ) {
$public_root_url = substr ( $public_root_url , 0 , - 1 );
}
$url = " $public_root_url / $go " ;
}
// Prevent loop
if ( isset ( $_SESSION [ 'last_redirect' ]) && $_SESSION [ 'last_redirect' ] == $url )
2020-05-08 15:16:24 +02:00
self :: log_fatal ( _ ( " Fail to determine the requested URL (loop detected). " ));
2020-05-02 17:48:34 +02:00
else
$_SESSION [ 'last_redirect' ] = $url ;
2020-05-08 15:16:24 +02:00
self :: log_debug ( " redirect( $go ) => Redirect to : < $url > " );
2020-05-02 17:48:34 +02:00
header ( " Location: $url " );
2020-05-04 18:28:20 +02:00
// Set & display template
LStemplate :: assign ( 'url' , $url );
LStemplate :: display ( 'redirect.tpl' );
2020-05-02 17:48:34 +02:00
exit ();
}
/**
* Error 404 handler
*
* @ param [ in ] $request LSurlRequest | null The request ( optional , default : null )
*
* @ retval void
**/
public static function error_404 ( $request = null ) {
2021-02-03 14:40:28 +01:00
http_response_code ( 404 );
$error = _ ( " The requested page was not found. " );
if ( LSsession :: getAjaxDisplay () || ( $request && $request -> api_mode )) {
LSerror :: addErrorCode ( null , $error );
LSsession :: displayAjaxReturn ();
}
else {
LStemplate :: assign ( 'error' , $error );
LSsession :: setTemplate ( 'error.tpl' );
LSsession :: displayTemplate ();
}
2020-05-02 17:48:34 +02:00
}
/**
* Handle the current requested URL
*
* @ param [ in ] $default_url string | null The default URL if current one does not
* match with any configured pattern .
*
* @ retval void
**/
public static function handle_request ( $default_url = null ) {
$request = self :: get_request ( $default_url );
if ( ! is_callable ( $request -> handler )) {
2020-05-08 15:16:24 +02:00
self :: log_error ( " URL handler function " . $request -> handler . " () does not exists ! " );
2020-06-25 16:03:49 +02:00
self :: log_fatal ( _ ( " This request could not be handled. " ));
2020-05-02 17:48:34 +02:00
}
2021-02-03 14:40:28 +01:00
if ( $request -> api_mode )
LSsession :: setApiMode ();
elseif ( class_exists ( 'LStemplate' ))
2020-05-02 17:48:34 +02:00
LStemplate :: assign ( 'request' , $request );
// Check authentication (if need)
if ( $request -> authenticated && ! LSsession :: startLSsession ()) {
LSsession :: displayTemplate ();
return true ;
}
try {
return call_user_func ( $request -> handler , $request );
}
catch ( Exception $e ) {
2020-05-08 12:32:21 +02:00
self :: log_exception ( $e , " An exception occured running URL handler function " . $request -> handler . " () " );
2020-06-25 16:03:49 +02:00
self :: log_fatal ( _ ( " This request could not be processed correctly. " ));
2020-05-02 17:48:34 +02:00
}
}
/**
2021-08-25 18:02:37 +02:00
* Helpers to retrieve current requested URL
2020-05-02 17:48:34 +02:00
*/
/*
2020-06-25 16:00:20 +02:00
* Try to detect current requested URL and return it
2020-05-02 17:48:34 +02:00
*
* @ retval string | false The current request URL or false if detection fail
**/
2020-06-25 16:00:20 +02:00
private static function get_current_url () {
2020-05-08 15:16:24 +02:00
self :: log_debug ( " URL : request URI = ' " . $_SERVER [ 'REQUEST_URI' ] . " ' " );
2020-05-02 17:48:34 +02:00
$base = self :: get_rewrite_base ();
2020-05-08 15:16:24 +02:00
self :: log_debug ( " URL : rewrite base = ' $base ' " );
2020-05-02 17:48:34 +02:00
if ( $_SERVER [ 'REQUEST_URI' ] == $base )
return '' ;
if ( substr ( $_SERVER [ 'REQUEST_URI' ], 0 , strlen ( $base )) != $base ) {
2020-05-08 15:16:24 +02:00
self :: log_error ( " URL : request URI ( " . $_SERVER [ 'REQUEST_URI' ] . " ) does not start with rewrite base ( $base ) " );
2020-05-02 17:48:34 +02:00
return False ;
}
$current_url = substr ( $_SERVER [ 'REQUEST_URI' ], strlen ( $base ));
// URL contain params ?
$params_start = strpos ( $current_url , '?' );
if ( $params_start !== false ) {
// Params detected, remove it
// No url / currrent url start by '?' ?
if ( $params_start == 0 )
return '' ;
else
return substr ( $current_url , 0 , $params_start );
}
return $current_url ;
}
/**
* Try to detect rewrite base from public root URL
*
* @ retval string The detected rewrite base
**/
private static function get_rewrite_base () {
$public_root_url = LSconfig :: get ( 'public_root_url' , '/' , 'string' );
2020-06-25 16:17:38 +02:00
$rewrite_base = '/' ;
2020-06-25 16:08:49 +02:00
if ( preg_match ( '|^https?://[^/]+(/.*)$|' , $public_root_url , $m ))
2020-06-29 16:59:23 +02:00
$rewrite_base = $m [ 1 ];
2020-06-25 16:08:49 +02:00
elseif ( preg_match ( '|^(/.+)$|' , $public_root_url , $m ))
2020-06-29 16:59:23 +02:00
$rewrite_base = $m [ 1 ];
2020-06-25 16:17:38 +02:00
if ( $rewrite_base != '/' )
return self :: remove_trailing_slash ( $rewrite_base ) . '/' ;
return $rewrite_base ;
2020-05-02 17:48:34 +02:00
}
/**
* Remove trailing slash in specified URL
*
* @ param [ in ] $url string The URL
*
* @ retval string The specified URL without trailing slash
**/
private static function remove_trailing_slash ( $url ) {
if ( $url == '/' )
return $url ;
elseif ( substr ( $url , - 1 ) == '/' )
return substr ( $url , 0 , - 1 );
return $url ;
}
}