1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
/** |
4
|
|
|
* @package cellcote/laravel-proxify |
5
|
|
|
* @author Michele Andreoli <michi.andreoli[at]gmail.com> |
6
|
|
|
* @copyright Copyright (c) Michele Andreoli |
7
|
|
|
* @author Rik Schreurs <rik.schreurs[at]mail.com> |
8
|
|
|
* @copyright Copyright (c) Rik Schreurs |
9
|
|
|
* @license http://mit-license.org/ |
10
|
|
|
* @link https://github.com/cellcote/laravel-proxify |
11
|
|
|
*/ |
12
|
|
|
|
13
|
|
|
namespace Cellcote\LaravelProxify; |
14
|
|
|
|
15
|
|
|
use Cellcote\LaravelProxify\Exceptions\CookieExpiredException; |
16
|
|
|
use Cellcote\LaravelProxify\Exceptions\ProxyMissingParamException; |
17
|
|
|
use Cellcote\LaravelProxify\Managers\CookieManager; |
18
|
|
|
use Cellcote\LaravelProxify\Managers\RequestManager; |
19
|
|
|
use Illuminate\Http\Response; |
20
|
|
|
|
21
|
|
|
class Proxy { |
22
|
|
|
|
23
|
|
|
private $callMode = null; |
24
|
|
|
private $uriParam = null; |
25
|
|
|
private $skipParam = null; |
26
|
|
|
private $redirectUri = null; |
27
|
|
|
private $clientSecrets = null; |
28
|
|
|
private $cookieManager = null; |
29
|
|
|
private $useHeader = false; |
30
|
|
|
|
31
|
|
|
/** |
32
|
|
|
* @param $params |
33
|
|
|
*/ |
34
|
|
|
public function __construct($params) { |
35
|
|
|
$this->skipParam = $params['skip_param']; |
36
|
|
|
$this->redirectUri = $params['redirect_login']; |
37
|
|
|
$this->clientSecrets = $params['client_secrets']; |
38
|
|
|
$this->useHeader = $params['use_header']; |
39
|
|
|
$this->cookieManager = new CookieManager($params['cookie_info']); |
40
|
|
|
} |
41
|
|
|
|
42
|
|
|
/** |
43
|
|
|
* @param $method |
44
|
|
|
* @param array $inputs |
45
|
|
|
* @return Response |
46
|
|
|
* @throws CookieExpiredException |
47
|
|
|
* @throws ProxyMissingParamException |
48
|
|
|
* @throws \Exception |
49
|
|
|
*/ |
50
|
|
|
public function makeRequest($method, Array $inputs, $url) { |
51
|
|
|
$this->uri = $url; |
52
|
|
|
|
53
|
|
|
//Retrieve the call mode from input parameters |
54
|
|
|
$this->callMode = $this->getRequestMode($inputs); |
55
|
|
|
|
56
|
|
|
//Remove parameters from inputs |
57
|
|
|
$inputs = ProxyAux::removeQueryValue($inputs, $this->uriParam); |
58
|
|
|
$inputs = ProxyAux::removeQueryValue($inputs, $this->skipParam); |
59
|
|
|
|
60
|
|
|
//Read the cookie if exists |
61
|
|
|
$parsedCookie = null; |
62
|
|
|
if ($this->callMode !== ProxyAux::MODE_SKIP) { |
63
|
|
|
try { |
64
|
|
|
$parsedCookie = $this->cookieManager->tryParseCookie($this->callMode); |
65
|
|
|
} catch (CookieExpiredException $ex) { |
66
|
|
|
if (isset($this->redirectUri) && !empty($this->redirectUri)) { |
67
|
|
|
return \Redirect::to($this->redirectUri); |
|
|
|
|
68
|
|
|
} |
69
|
|
|
throw $ex; |
70
|
|
|
} |
71
|
|
|
} |
72
|
|
|
|
73
|
|
|
//Create the new request |
74
|
|
|
$requestManager = new RequestManager($this->uri, $method, $this->clientSecrets, $this->callMode, $this->cookieManager); |
75
|
|
|
if ($this->useHeader) { |
76
|
|
|
$requestManager->enableHeader(); |
77
|
|
|
} |
78
|
|
|
$proxyResponse = $requestManager->executeRequest($inputs, $parsedCookie); |
79
|
|
|
|
80
|
|
|
return $this->setApiResponse($proxyResponse['response'], $proxyResponse['cookie']); |
81
|
|
|
} |
82
|
|
|
|
83
|
|
|
/** |
84
|
|
|
* @param $inputs |
85
|
|
|
* @return string |
86
|
|
|
*/ |
87
|
|
|
private function getRequestMode($inputs) { |
88
|
|
|
$grantType = ProxyAux::getQueryValue($inputs, ProxyAux::GRANT_TYPE); |
89
|
|
|
$skip = ProxyAux::getQueryValue($inputs, $this->skipParam); |
90
|
|
|
$mode = ProxyAux::MODE_TOKEN; |
91
|
|
|
|
92
|
|
|
if (isset($grantType)) { |
93
|
|
|
if ($grantType === ProxyAux::PASSWORD_GRANT) { |
94
|
|
|
$mode = ProxyAux::MODE_LOGIN; |
95
|
|
|
} |
96
|
|
|
} else if (isset($skip) && strtolower($skip) === 'true') { |
97
|
|
|
$mode = ProxyAux::MODE_SKIP; |
98
|
|
|
} |
99
|
|
|
|
100
|
|
|
return $mode; |
101
|
|
|
} |
102
|
|
|
|
103
|
|
|
/** |
104
|
|
|
* @param $proxyResponse |
105
|
|
|
* @param $cookie |
106
|
|
|
* @return Response |
107
|
|
|
*/ |
108
|
|
|
private function setApiResponse($proxyResponse, $cookie) { |
109
|
|
|
$response = new Response($proxyResponse->getContent(), $proxyResponse->getStatusCode()); |
110
|
|
|
|
111
|
|
|
if ($this->callMode === ProxyAux::MODE_LOGIN) { |
112
|
|
|
$response->setContent(json_encode($this->successAccessToken())); |
113
|
|
|
} |
114
|
|
|
if (isset($cookie)) { |
115
|
|
|
$response->withCookie($cookie); |
116
|
|
|
} |
117
|
|
|
|
118
|
|
|
return $response; |
119
|
|
|
} |
120
|
|
|
|
121
|
|
|
/** |
122
|
|
|
* @return array |
123
|
|
|
*/ |
124
|
|
|
private function successAccessToken() { |
125
|
|
|
return array( |
126
|
|
|
'success_code' => 'access_token_ok', |
127
|
|
|
'success_message' => \Lang::get('api-proxy-laravel::messages.access_token_ok') |
128
|
|
|
); |
129
|
|
|
} |
130
|
|
|
|
131
|
|
|
} |
If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.
Let’s take a look at an example:
Our function
my_function
expects aPost
object, and outputs the author of the post. The base classPost
returns a simple string and outputting a simple string will work just fine. However, the child classBlogPost
which is a sub-type ofPost
instead decided to return anobject
, and is therefore violating the SOLID principles. If aBlogPost
were passed tomy_function
, PHP would not complain, but ultimately fail when executing thestrtoupper
call in its body.