BaseResponse.php
2.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
<?php
/**
* CAS response class.
*
* @package \WPCASServerPlugin\Server
* @version 1.2.0
* @since 1.2.0
*/
namespace Cassava\CAS\Response;
use Cassava\CAS;
use Cassava\Exception\GeneralException;
/**
* Implements the base CAS response.
*
* @version 1.2.0
*/
class BaseResponse {
/**
* CAS XML Namespace URI
*/
const CAS_NS = 'http://www.yale.edu/tp/cas';
/**
* XML response document.
* @var \DOMDocument
*/
protected $document;
/**
* XML response node.
* @var \DOMNode
*/
protected $response;
/**
* Response constructor.
*
* @uses \get_bloginfo()
*/
public function __construct() {
$this->document = new \DOMDocument( '1.0', \get_bloginfo( 'charset' ) );
}
/**
* Wrap a CAS 2.0 XML response and output it as a string.
*
* @return string CAS 2.0+ server response as an XML string.
*/
public function prepare() {
$root = $this->createElement( 'serviceResponse' );
if ( ! empty( $this->response ) ) {
$root->appendChild( $this->response );
}
// Removing all child nodes from response document:
while ( $this->document->firstChild ) {
$this->document->removeChild( $this->document->firstChild );
}
$this->document->appendChild( $root );
return $this->document->saveXML();
}
/**
* Set error response.
*
* @param \WP_Error|null $error Response error.
* @param string $tag Response XML tag (defaults to `authenticationFailure`).
*
* @uses \WP_Error
* @uses \do_action()
*/
public function setError( \WP_Error $error = null, $tag = 'authenticationFailure' ) {
/**
* Fires if the CAS server has to return an XML error.
*
* @param WP_Error $error WordPress error to return as XML.
*/
\do_action( 'cas_server_error', $error );
$message = __( 'Unknown error', 'wp-cas-server' );
$code = GeneralException::ERROR_INTERNAL_ERROR;
if ( ! empty( $error ) ) {
$code = $error->get_error_code();
$message = $error->get_error_message( $code );
}
$this->response = $this->createElement( $tag, $message );
$this->response->setAttribute( 'code', $code );
}
/**
* Create response element.
*
* @param string $element Unqualified element tag name.
* @param string|null $value Optional element value.
* @return \DOMNode XML element.
*/
protected function createElement( $element, $value = null ) {
return $this->document->createElementNS( static::CAS_NS, "cas:$element", $value );
}
}