-
Notifications
You must be signed in to change notification settings - Fork 0
/
ApiClient.php
131 lines (111 loc) · 4.69 KB
/
ApiClient.php
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
<?php
/*
START LICENSE AND COPYRIGHT
This file is part of ZfExtended library
Copyright (c) 2013 - 2022 Marc Mittag; MittagQI - Quality Informatics; All rights reserved.
Contact: http://www.MittagQI.com/ / service (ATT) MittagQI.com
This file may be used under the terms of the GNU LESSER GENERAL PUBLIC LICENSE version 3
as published by the Free Software Foundation and appearing in the file lgpl3-license.txt
included in the packaging of this file. Please review the following information
to ensure the GNU LESSER GENERAL PUBLIC LICENSE version 3.0 requirements will be met:
https://www.gnu.org/licenses/lgpl-3.0.txt
@copyright Marc Mittag, MittagQI - Quality Informatics
@author MittagQI - Quality Informatics
@license GNU LESSER GENERAL PUBLIC LICENSE version 3
https://www.gnu.org/licenses/lgpl-3.0.txt
END LICENSE AND COPYRIGHT
*/
use MittagQI\ZfExtended\CsrfProtection;
/**
* Represents an API-Client for the T5 API
* Sets the correct environment & authorization cookie
*/
class ZfExtended_ApiClient extends Zend_Http_Client
{
private string $translate5ApiUrl;
/**
* Creates a Cleient for requesting the T5 API For an API-request the authorization-cookie needs to be set
* @param string|null $uri
* @throws Zend_Exception
* @throws Zend_Http_Client_Exception
* @throws ZfExtended_Exception
*/
public function __construct($uri = null, string $authorizationCookie = null, string $authorizationToken = null)
{
$this->translate5ApiUrl = self::getServerBaseURL();
$config = Zend_Registry::get('config');
parent::__construct($uri, $config); // why do we pass "our" config here ?
// we need to trigger correct environment for request on our own API while API-testing
// security: APPLICATION_APITEST can only be set, when the instance is set up for testing
if (defined('APPLICATION_APITEST') && APPLICATION_APITEST) {
$origin = (APPLICATION_ENV === ZfExtended_BaseIndex::ENVIRONMENT_TEST) ? ZfExtended_BaseIndex::ORIGIN_TEST : ZfExtended_BaseIndex::ORIGIN_APPTEST;
$this->setHeaders('Origin', $origin);
}
// use token if given from outside or used by current request
if ($authorizationToken === null) {
$authorizationToken = ZfExtended_Authentication::getInstance()->getUsedToken();
}
if ($authorizationToken !== null && strlen($authorizationToken) > 0) {
$this->setHeaders(ZfExtended_Authentication::APPLICATION_TOKEN_HEADER . ': ' . $authorizationToken);
return;
}
//by default use the session cookie
$authCookieName = Zend_Registry::get('config')->resources->ZfExtended_Resource_Session->name;
if ($authorizationCookie === null) {
if (! array_key_exists($authCookieName, $_COOKIE)) {
throw new ZfExtended_Exception('ZfExtended_ApiClient: Authorization Cookie is not set.');
}
$authorizationCookie = $_COOKIE[$authCookieName];
}
$this->setCookie($authCookieName, $authorizationCookie);
// add CSRF protection
CsrfProtection::getInstance()->addRequestHeaders($this);
}
/**
* Overridden to set the correct Host & Scheme
* @param string|Zend_Uri_Http $uri
* @return $this|ZfExtended_ApiClient
* @throws Zend_Exception
* @throws Zend_Http_Client_Exception
* @throws Zend_Uri_Exception
*/
public function setUri($uri)
{
// complement T5 base url
if (is_string($uri)) {
$uri = $this->setT5SchemeAndHost($uri);
} elseif ($uri instanceof Zend_Uri_Http) {
$uri = $this->setT5SchemeAndHost($uri->__toString());
}
return parent::setUri($uri);
}
/**
* Replaces scheme & host in any URL to the T5 one
*/
private function setT5SchemeAndHost(string $url): string
{
if (str_contains($url, '://')) {
$parts = explode('://', $url);
$parts = explode('/', $parts[1]);
if (count($parts) === 0) {
return $this->translate5ApiUrl;
}
array_shift($parts);
return $this->translate5ApiUrl . '/' . implode('/', $parts);
}
return $this->translate5ApiUrl . '/' . ltrim($url, '/');
}
/**
* returns the server base URL with scheme
* @throws Zend_Exception
*/
public static function getServerBaseURL(): string
{
$config = Zend_Registry::get('config');
$url = $config->runtimeOptions->worker->server;
if (empty($url)) {
return $config->runtimeOptions->server->protocol . $config->runtimeOptions->server->name;
}
return $url;
}
}