Miscellaneous

Collaboration diagram for Miscellaneous:

Functions
	CASClient::getURL ()
	This method returns the URL of the current request (without any ticket CGI parameter). More...
	CASClient::removeParameterFromQueryString ($parameterName, $queryString)
	Removes a parameter from a query string. More...
	CASClient::setURL ($url)
	This method sets the URL of the current request. More...
	CASClient::authError ($failure, $cas_url, $no_response, $bad_response='', $cas_response='', $err_code='', $err_msg='')
	This method is used to print the HTML output when the user was not authenticated. More...

Variables
	CASClient::$_url
	the URL of the current request (without any ticket CGI parameter). More...
	$GLOBALS ['PHPCAS_CLIENT']
	This global variable is used by the interface class phpCAS. More...
	$GLOBALS ['PHPCAS_INIT_CALL']
	This global variable is used to store where the initializer is called from (to print a comprehensive error in case of multiple calls). More...
	$GLOBALS ['PHPCAS_AUTH_CHECK_CALL']
	This global variable is used to store where the method checking the authentication is called from (to print comprehensive errors) More...
	$GLOBALS ['PHPCAS_DEBUG']
	This global variable is used to store phpCAS debug mode. More...
	$PHPCAS_CLIENT
	This global variable is used by the interface class phpCAS. More...
	$PHPCAS_INIT_CALL
	This global variable is used to store where the initializer is called from (to print a comprehensive error in case of multiple calls). More...
	$PHPCAS_AUTH_CHECK_CALL
	This global variable is used to store where the method checking the authentication is called from (to print comprehensive errors) More...
	$PHPCAS_DEBUG
	This global variable is used to store phpCAS debug mode. More...

Detailed Description

Function Documentation

authError()

CASClient::authError (   $failure,   $cas_url,   $no_response,   $bad_response = '',   $cas_response = '',   $err_code = '',   $err_msg = ''  )

private

This method is used to print the HTML output when the user was not authenticated.

Parameters

$failure	the failure that occured
$cas_url	the URL the CAS server was asked for
$no_response	the response from the CAS server (other parameters are ignored if TRUE)
$bad_response	bad response from the CAS server ($err_code and $err_msg ignored if TRUE)
$cas_response	the response of the CAS server
$err_code	the error code given by the CAS server
$err_msg	the error message given by the CAS server

Definition at line 2722 of file client.php.

References $failure, CAS_STR_AUTHENTICATION_FAILED, CAS_STR_YOU_WERE_NOT_AUTHENTICATED, CAS_VERSION_1_0, CAS_VERSION_2_0, exit, CASClient\getServerVersion(), CASClient\getString(), CASClient\getURL(), CASClient\printHTMLFooter(), CASClient\printHTMLHeader(), phpCAS\trace(), phpCAS\traceBegin(), and phpCAS\traceExit().

Referenced by CASClient\validatePGT(), CASClient\validateSA(), and CASClient\validateST().

                {
                phpCAS::traceBegin();
                
                $this->printHTMLHeader($this->getString(CAS_STR_AUTHENTICATION_FAILED));
                printf($this->getString(CAS_STR_YOU_WERE_NOT_AUTHENTICATED),htmlentities($this->getURL()),$_SERVER['SERVER_ADMIN']);
                phpCAS::trace('CAS URL: '.$cas_url);
                phpCAS::trace('Authentication failure: '.$failure);
                if ( $no_response ) {
                        phpCAS::trace('Reason: no response from the CAS server');
                } else {
                        if ( $bad_response ) {
                                phpCAS::trace('Reason: bad response from the CAS server');
                        } else {
                                switch ($this->getServerVersion()) {
                                        case CAS_VERSION_1_0:
                                                phpCAS::trace('Reason: CAS error');
                                                break;
                                        case CAS_VERSION_2_0:
                                                if ( empty($err_code) )
                                                        phpCAS::trace('Reason: no CAS error');
                                                else
                                                        phpCAS::trace('Reason: ['.$err_code.'] CAS error: '.$err_msg);
                                                break;
                                }
                        }
                        phpCAS::trace('CAS response: '.$cas_response);
                }
                $this->printHTMLFooter();
                phpCAS::traceExit();
                exit();
                }

Here is the call graph for this function:

Here is the caller graph for this function:

getURL()

CASClient::getURL ( )

private

This method returns the URL of the current request (without any ticket CGI parameter).

Returns

The URL

Definition at line 2621 of file client.php.

References CASClient\$_url, CASClient\isHttps(), CASClient\removeParameterFromQueryString(), CASClient\setURL(), phpCAS\trace(), and phpCAS\traceEnd().

Referenced by CASClient\authError(), CASClient\getServerLoginURL(), CASClient\getServerProxyValidateURL(), CASClient\getServerSamlValidateURL(), CASClient\getServerServiceValidateURL(), and CASClient\isAuthenticated().

                {
                phpCAS::traceBegin();
                // the URL is built when needed only
                if ( empty($this->_url) ) {
                        $final_uri = '';
                        // remove the ticket if present in the URL
                        $final_uri = ($this->isHttps()) ? 'https' : 'http';
                        $final_uri .= '://';
                        /* replaced by Julien Marchal - v0.4.6
                         * $this->_url .= $_SERVER['SERVER_NAME'];
                         */
                        if(empty($_SERVER['HTTP_X_FORWARDED_SERVER'])){
                                /* replaced by teedog - v0.4.12
                                 * $this->_url .= $_SERVER['SERVER_NAME'];
                                 */
                                if (empty($_SERVER['SERVER_NAME'])) {
                                        $server_name = $_SERVER['HTTP_HOST'];
                                } else {
                                        $server_name = $_SERVER['SERVER_NAME'];
                                }
                        } else {
                                $server_name = $_SERVER['HTTP_X_FORWARDED_SERVER'];
                        }
                        $final_uri .= $server_name;
                        if (!strpos($server_name, ':')) {
                                if ( ($this->isHttps() && $_SERVER['SERVER_PORT']!=443)
                                                || (!$this->isHttps() && $_SERVER['SERVER_PORT']!=80) ) {
                                        $final_uri .= ':';
                                        $final_uri .= $_SERVER['SERVER_PORT'];
                                }
                        }
                        
                        $request_uri    = explode('?', $_SERVER['REQUEST_URI'], 2);
                        $final_uri              .= $request_uri[0];
                        
                        if (isset($request_uri[1]) && $request_uri[1])
                        {
                                $query_string   = $this->removeParameterFromQueryString('ticket', $request_uri[1]);
                                
                                // If the query string still has anything left, append it to the final URI
                                if ($query_string !== '')
                                        $final_uri      .= "?$query_string";
                                
                        }
                        
                        phpCAS::trace("Final URI: $final_uri");
                        $this->setURL($final_uri);
                }
                phpCAS::traceEnd($this->_url);
                return $this->_url;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

removeParameterFromQueryString()

CASClient::removeParameterFromQueryString	(		$parameterName,
			$queryString
	)

Removes a parameter from a query string.

Parameters

string	$parameterName
string	$queryString

Returns

string

http://stackoverflow.com/questions/1842681/regular-expression-to-remove-one-parameter-from-query-string

Definition at line 2685 of file client.php.

Referenced by CASClient\getURL().

        {
                $parameterName  = preg_quote($parameterName);
                return preg_replace("/&$parameterName(=[^&]*)?|^$parameterName(=[^&]*)?&?/", '', $queryString);
        }

Here is the caller graph for this function:

setURL()

CASClient::setURL (   $url )

private

This method sets the URL of the current request.

Parameters

$url	url to set for service

Definition at line 2699 of file client.php.

Referenced by CASClient\getURL().

                {
                $this->_url = $url;
                }

Here is the caller graph for this function:

Variable Documentation

$_url

CASClient::$_url

private

the URL of the current request (without any ticket CGI parameter).

Written and read by CASClient::getURL().

Definition at line 2611 of file client.php.

Referenced by CASClient\getURL().

$GLOBALS [1/4]

$GLOBALS[ 'PHPCAS_CLIENT']

This global variable is used by the interface class phpCAS.

Definition at line 276 of file CAS.php.

$GLOBALS [2/4]

$GLOBALS[ 'PHPCAS_INIT_CALL']

This global variable is used to store where the initializer is called from (to print a comprehensive error in case of multiple calls).

Definition at line 284 of file CAS.php.

$GLOBALS [3/4]

$GLOBALS[ 'PHPCAS_AUTH_CHECK_CALL']

This global variable is used to store where the method checking the authentication is called from (to print comprehensive errors)

Definition at line 297 of file CAS.php.

$GLOBALS [4/4]

$GLOBALS[ 'PHPCAS_DEBUG']

This global variable is used to store phpCAS debug mode.

Definition at line 310 of file CAS.php.

$PHPCAS_AUTH_CHECK_CALL

$PHPCAS_AUTH_CHECK_CALL

This global variable is used to store where the method checking the authentication is called from (to print comprehensive errors)

Definition at line 195 of file CAS.php.

Referenced by phpCAS\checkAuthentication(), phpCAS\forceAuthentication(), phpCAS\getAttributes(), phpCAS\getUser(), phpCAS\isAuthenticated(), phpCAS\serviceMail(), phpCAS\serviceWeb(), phpCAS\setPGTStorageDB(), and phpCAS\setPGTStorageFile().

$PHPCAS_CLIENT

$PHPCAS_CLIENT

This global variable is used by the interface class phpCAS.

Definition at line 176 of file CAS.php.

Referenced by ilAuthCAS\__construct(), phpCAS\checkAuthentication(), ilCASAuth\checkCASAuth(), phpCAS\client(), ilAuthContainerCAS\fetchData(), ilAuthContainerCAS\forceAuthentication(), phpCAS\forceAuthentication(), phpCAS\getAttributes(), phpCAS\getServerLoginURL(), phpCAS\getServerLogoutURL(), phpCAS\getServiceURL(), phpCAS\getUser(), phpCAS\handleLogoutRequests(), phpCAS\isAuthenticated(), phpCAS\isSessionAuthenticated(), ilAuthContainerCAS\loginObserver(), phpCAS\logout(), phpCAS\logoutWithRedirectService(), phpCAS\logoutWithRedirectServiceAndUrl(), phpCAS\logoutWithUrl(), phpCAS\proxy(), phpCAS\retrievePT(), phpCAS\serviceMail(), phpCAS\serviceWeb(), phpCAS\setCacheTimesForAuthRecheck(), phpCAS\setCasServerCACert(), phpCAS\setCasServerCert(), phpCAS\setExtraCurlOption(), phpCAS\setFixedCallbackURL(), phpCAS\setFixedServiceURL(), phpCAS\setHTMLFooter(), phpCAS\setHTMLHeader(), phpCAS\setLang(), phpCAS\setNoCasServerValidation(), phpCAS\setPGTStorageDB(), phpCAS\setPGTStorageFile(), phpCAS\setServerLoginURL(), phpCAS\setServerLogoutURL(), phpCAS\setServerProxyValidateURL(), phpCAS\setServerSamlValidateURL(), and phpCAS\setServerServiceValidateURL().

$PHPCAS_DEBUG

$PHPCAS_DEBUG

This global variable is used to store phpCAS debug mode.

Definition at line 206 of file CAS.php.

Referenced by phpCAS\log(), phpCAS\setDebug(), phpCAS\traceBegin(), phpCAS\traceEnd(), and phpCAS\traceExit().

$PHPCAS_INIT_CALL

$PHPCAS_INIT_CALL

This global variable is used to store where the initializer is called from (to print a comprehensive error in case of multiple calls).

Definition at line 184 of file CAS.php.

Referenced by phpCAS\client(), and phpCAS\proxy().