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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
<?php
/**
* @copyright Copyright (c) 2017 Arthur Schiwon <blizzz@arthur-schiwon.de>
*
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\User_LDAP\Controller;
use OC\CapabilitiesManager;
use OC\Core\Controller\OCSController;
use OC\Security\Bruteforce\Throttler;
use OC\Security\IdentityProof\Manager;
use OCA\User_LDAP\Configuration;
use OCA\User_LDAP\Helper;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\OCS\OCSBadRequestException;
use OCP\AppFramework\OCS\OCSException;
use OCP\AppFramework\OCS\OCSNotFoundException;
use OCP\ILogger;
use OCP\IRequest;
use OCP\IUserManager;
use OCP\IUserSession;
class ConfigAPIController extends OCSController {
/** @var Helper */
private $ldapHelper;
/** @var ILogger */
private $logger;
public function __construct(
$appName,
IRequest $request,
CapabilitiesManager $capabilitiesManager,
IUserSession $userSession,
IUserManager $userManager,
Throttler $throttler,
Manager $keyManager,
Helper $ldapHelper,
ILogger $logger
) {
parent::__construct(
$appName,
$request,
$capabilitiesManager,
$userSession,
$userManager,
$throttler,
$keyManager
);
$this->ldapHelper = $ldapHelper;
$this->logger = $logger;
}
/**
* creates a new (empty) configuration and returns the resulting prefix
*
* Example: curl -X POST -H "OCS-APIREQUEST: true" -u $admin:$password \
* https://nextcloud.server/ocs/v1.php/apps/user_ldap/api/v1/config
*
* results in:
*
* <?xml version="1.0"?>
* <ocs>
* <meta>
* <status>ok</status>
* <statuscode>100</statuscode>
* <message>OK</message>
* <totalitems></totalitems>
* <itemsperpage></itemsperpage>
* </meta>
* <data>
* <prefix>s40</prefix>
* </data>
* </ocs>
*
* Failing example: if an exception is thrown (e.g. Database connection lost)
* the detailed error will be logged. The output will then look like:
*
* <?xml version="1.0"?>
* <ocs>
* <meta>
* <status>failure</status>
* <statuscode>999</statuscode>
* <message>An issue occurred when creating the new config.</message>
* <totalitems></totalitems>
* <itemsperpage></itemsperpage>
* </meta>
* <data/>
* </ocs>
*
* For JSON output provide the format=json parameter
*
* @return DataResponse
* @throws OCSException
*/
public function create() {
try {
$configPrefix = $this->ldapHelper->getNextServerConfigurationPrefix();
$configHolder = new Configuration($configPrefix);
$configHolder->saveConfiguration();
} catch (\Exception $e) {
$this->logger->logException($e);
throw new OCSException('An issue occurred when creating the new config.');
}
return new DataResponse(['prefix' => $configPrefix]);
}
/**
* Deletes a LDAP configuration, if present.
*
* Example:
* curl -X DELETE -H "OCS-APIREQUEST: true" -u $admin:$password \
* https://nextcloud.server/ocs/v1.php/apps/user_ldap/api/v1/config/s60
*
* <?xml version="1.0"?>
* <ocs>
* <meta>
* <status>ok</status>
* <statuscode>100</statuscode>
* <message>OK</message>
* <totalitems></totalitems>
* <itemsperpage></itemsperpage>
* </meta>
* <data/>
* </ocs>
*
* @param $configID
* @return DataResponse
* @throws OCSBadRequestException
* @throws OCSException
*/
public function delete($configID) {
$initial = substr($configID, 0, 1);
$number = substr($configID, 1);
if($initial !== 's' || $number !== strval(intval($number))) {
throw new OCSBadRequestException('Not a valid config ID');
}
try {
$prefixes = $this->ldapHelper->getServerConfigurationPrefixes();
if(!in_array($configID, $prefixes)) {
throw new OCSNotFoundException('Config ID not found');
}
if(!$this->ldapHelper->deleteServerConfiguration($configID)) {
throw new OCSException('Could not delete configuration');
}
} catch(OCSException $e) {
throw $e;
} catch(\Exception $e) {
$this->logger->logException($e);
throw new OCSException('An issue occurred when deleting the config.');
}
return new DataResponse();
}
}
|
