|
1
|
|
|
<?php |
|
2
|
|
|
/* |
|
3
|
|
|
* This file is part of the Adlogix package. |
|
4
|
|
|
* |
|
5
|
|
|
* (c) Allan Segebarth <[email protected]> |
|
6
|
|
|
* (c) Jean-Jacques Courtens <[email protected]> |
|
7
|
|
|
* |
|
8
|
|
|
* For the full copyright and license information, please view the LICENSE |
|
9
|
|
|
* file that was distributed with this source code. |
|
10
|
|
|
*/ |
|
11
|
|
|
|
|
12
|
|
|
namespace Adlogix\ConfluenceClient\Exception; |
|
13
|
|
|
|
|
14
|
|
|
|
|
15
|
|
|
use GuzzleHttp\Exception\RequestException; |
|
16
|
|
|
use JMS\Serializer\SerializerInterface; |
|
17
|
|
|
use Psr\Http\Message\RequestInterface; |
|
18
|
|
|
use Psr\Http\Message\ResponseInterface; |
|
19
|
|
|
|
|
20
|
|
|
/** |
|
21
|
|
|
* Class ExceptionWrapper |
|
22
|
|
|
* @package Adlogix\ConfluenceClient\Exception |
|
23
|
|
|
* @author Cedric Michaux <[email protected]> |
|
24
|
|
|
*/ |
|
25
|
|
|
class ExceptionWrapper |
|
26
|
|
|
{ |
|
27
|
|
|
const RESPONSE_AUTHENTICATED_FAILED = 'AUTHENTICATED_FAILED'; |
|
28
|
|
|
const RESPONSE_AUTHENTICATION_DENIED = 'AUTHENTICATION_DENIED'; |
|
29
|
|
|
const RESPONSE_AUTHORIZATION_FAILED = 'AUTHORIZATION_FAILED'; |
|
30
|
|
|
const RESPONSE_AUTHORISATION_FAILED = 'AUTHORISATION_FAILED'; |
|
31
|
|
|
const RESPONSE_OUT = 'OUT'; |
|
32
|
|
|
/** |
|
33
|
|
|
* @var SerializerInterface |
|
34
|
|
|
*/ |
|
35
|
|
|
private $serializer; |
|
36
|
|
|
|
|
37
|
|
|
/** |
|
38
|
|
|
* ExceptionWrapper constructor. |
|
39
|
|
|
* |
|
40
|
|
|
* @param SerializerInterface $serializer |
|
41
|
|
|
*/ |
|
42
|
|
|
private function __construct(SerializerInterface $serializer) |
|
43
|
|
|
{ |
|
44
|
|
|
$this->serializer = $serializer; |
|
45
|
|
|
} |
|
46
|
|
|
|
|
47
|
|
|
public static function wrap(RequestException $exception, SerializerInterface $serializer) |
|
48
|
|
|
{ |
|
49
|
|
|
$wrapper = new static($serializer); |
|
50
|
|
|
return $wrapper->parseException($exception); |
|
51
|
|
|
} |
|
52
|
|
|
|
|
53
|
|
|
/** |
|
54
|
|
|
* @param RequestException $exception |
|
55
|
|
|
* |
|
56
|
|
|
* @return ApiException |
|
57
|
|
|
*/ |
|
58
|
|
|
private function parseException(RequestException $exception) |
|
59
|
|
|
{ |
|
60
|
|
|
if ($exception->getCode() == 401) { |
|
61
|
|
|
return new ApiException($this->create401ErrorMessage($exception), $exception->getCode(), $exception); |
|
62
|
|
|
} |
|
63
|
|
|
|
|
64
|
|
|
return new ApiException($exception->getMessage(), $exception->getCode(), $exception); |
|
65
|
|
|
} |
|
66
|
|
|
|
|
67
|
|
|
/** |
|
68
|
|
|
* @param RequestException $exception |
|
69
|
|
|
* |
|
70
|
|
|
* @return string |
|
71
|
|
|
*/ |
|
72
|
|
|
private function create401ErrorMessage(RequestException $exception) |
|
73
|
|
|
{ |
|
74
|
|
|
$request = $exception->getRequest(); |
|
75
|
|
|
$response = $exception->getResponse(); |
|
76
|
|
|
|
|
77
|
|
|
return $this->getExceptionMessage($request, $response); |
|
78
|
|
|
} |
|
79
|
|
|
|
|
80
|
|
|
/** |
|
81
|
|
|
* @param RequestInterface $request |
|
82
|
|
|
* @param ResponseInterface|null $response |
|
83
|
|
|
* |
|
84
|
|
|
* @return string |
|
85
|
|
|
*/ |
|
86
|
|
|
private function getExceptionMessage(RequestInterface $request, $response = null) |
|
87
|
|
|
{ |
|
88
|
|
|
return $this->getExceptionMessageForRequest($request) ?: $this->getExceptionMessageForResponse($response); |
|
89
|
|
|
} |
|
90
|
|
|
|
|
91
|
|
|
/** |
|
92
|
|
|
* @param RequestInterface $request |
|
93
|
|
|
* |
|
94
|
|
|
* @return null|string |
|
95
|
|
|
*/ |
|
96
|
|
|
private function getExceptionMessageForRequest(RequestInterface $request) |
|
97
|
|
|
{ |
|
98
|
|
|
if (!$this->isRequestValid($request)) { |
|
99
|
|
|
return 'Authentication Required'; |
|
100
|
|
|
} |
|
101
|
|
|
return null; |
|
102
|
|
|
} |
|
103
|
|
|
|
|
104
|
|
|
/** |
|
105
|
|
|
* @param RequestInterface $request |
|
106
|
|
|
* |
|
107
|
|
|
* @return bool |
|
108
|
|
|
*/ |
|
109
|
|
|
private function isRequestValid(RequestInterface $request) |
|
110
|
|
|
{ |
|
111
|
|
|
$uri = $request->getUri(); |
|
112
|
|
|
$queryParams = \GuzzleHttp\Psr7\parse_query($uri->getQuery()); |
|
113
|
|
|
|
|
114
|
|
|
return $request->hasHeader('Authorization') |
|
115
|
|
|
|| $request->hasHeader('Authentication') |
|
116
|
|
|
|| array_key_exists('jwt', $queryParams) |
|
117
|
|
|
|| !empty($queryParams['jwt']); |
|
118
|
|
|
} |
|
119
|
|
|
|
|
120
|
|
|
/** |
|
121
|
|
|
* @param ResponseInterface|null $response |
|
122
|
|
|
* |
|
123
|
|
|
* @return string |
|
124
|
|
|
*/ |
|
125
|
|
|
private function getExceptionMessageForResponse($response = null) |
|
126
|
|
|
{ |
|
127
|
|
|
|
|
128
|
|
|
if(null === $response){ |
|
129
|
|
|
return null; |
|
130
|
|
|
} |
|
131
|
|
|
|
|
132
|
|
|
switch ($response->getHeader('X-Seraph-LoginReason')) { |
|
133
|
|
|
case self::RESPONSE_AUTHENTICATED_FAILED: |
|
134
|
|
|
return 'Could not be authenticated'; |
|
135
|
|
|
|
|
136
|
|
|
case self::RESPONSE_AUTHENTICATION_DENIED: |
|
137
|
|
|
return 'Not allowed to login'; |
|
138
|
|
|
|
|
139
|
|
|
case self::RESPONSE_AUTHORISATION_FAILED: |
|
140
|
|
|
return 'Could not be authorised'; |
|
141
|
|
|
|
|
142
|
|
|
case self::RESPONSE_OUT: |
|
143
|
|
|
return 'Logged out'; |
|
144
|
|
|
} |
|
145
|
|
|
return 'Invalid Credentials'; |
|
146
|
|
|
} |
|
147
|
|
|
} |
|
148
|
|
|
|
adlogix /
confluence-rest-php-client
