From 5133a31d3c713e3e3c562e6fcd131ed2738d8798 Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Wed, 4 Oct 2017 16:21:50 +0200 Subject: Add public api for remote api Signed-off-by: Robin Appelman --- lib/public/IServerContainer.php | 12 +++ lib/public/Remote/Api/IApiCollection.php | 43 +++++++++++ lib/public/Remote/Api/IApiFactory.php | 39 ++++++++++ lib/public/Remote/Api/ICapabilitiesApi.php | 34 ++++++++ lib/public/Remote/Api/IUserApi.php | 37 +++++++++ lib/public/Remote/ICredentials.php | 43 +++++++++++ lib/public/Remote/IInstance.php | 66 ++++++++++++++++ lib/public/Remote/IInstanceFactory.php | 35 +++++++++ lib/public/Remote/IUser.php | 120 +++++++++++++++++++++++++++++ 9 files changed, 429 insertions(+) create mode 100644 lib/public/Remote/Api/IApiCollection.php create mode 100644 lib/public/Remote/Api/IApiFactory.php create mode 100644 lib/public/Remote/Api/ICapabilitiesApi.php create mode 100644 lib/public/Remote/Api/IUserApi.php create mode 100644 lib/public/Remote/ICredentials.php create mode 100644 lib/public/Remote/IInstance.php create mode 100644 lib/public/Remote/IInstanceFactory.php create mode 100644 lib/public/Remote/IUser.php (limited to 'lib/public') diff --git a/lib/public/IServerContainer.php b/lib/public/IServerContainer.php index 8c33a765d5e..851a3c7e2bb 100644 --- a/lib/public/IServerContainer.php +++ b/lib/public/IServerContainer.php @@ -541,4 +541,16 @@ interface IServerContainer extends IContainer { * @since 12.0.0 */ public function getCloudIdManager(); + + /** + * @return \OCP\Remote\Api\IApiFactory + * @since 13.0.0 + */ + public function getRemoteApiFactory(); + + /** + * @return \OCP\Remote\IInstanceFactory + * @since 13.0.0 + */ + public function getRemoteInstanceFactory(); } diff --git a/lib/public/Remote/Api/IApiCollection.php b/lib/public/Remote/Api/IApiCollection.php new file mode 100644 index 00000000000..c2bb11114d1 --- /dev/null +++ b/lib/public/Remote/Api/IApiCollection.php @@ -0,0 +1,43 @@ + + * + * @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 . + * + */ + +namespace OCP\Remote\Api; + +/** + * Provides access to the various apis of a remote instance + * + * @since 13.0.0 + */ +interface IApiCollection { + /** + * @return IUserApi + * + * @since 13.0.0 + */ + public function getUserApi(); + + /** + * @return ICapabilitiesApi + * + * @since 13.0.0 + */ + public function getCapabilitiesApi(); +} diff --git a/lib/public/Remote/Api/IApiFactory.php b/lib/public/Remote/Api/IApiFactory.php new file mode 100644 index 00000000000..f1830f4c04a --- /dev/null +++ b/lib/public/Remote/Api/IApiFactory.php @@ -0,0 +1,39 @@ + + * + * @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 . + * + */ + +namespace OCP\Remote\Api; + +use OCP\Remote\ICredentials; +use OCP\Remote\IInstance; + +/** + * @since 13.0.0 + */ +interface IApiFactory { + /** + * @param IInstance $instance + * @param ICredentials $credentials + * @return IApiCollection + * + * @since 13.0.0 + */ + public function getApiCollection(IInstance $instance, ICredentials $credentials); +} diff --git a/lib/public/Remote/Api/ICapabilitiesApi.php b/lib/public/Remote/Api/ICapabilitiesApi.php new file mode 100644 index 00000000000..855be7b520b --- /dev/null +++ b/lib/public/Remote/Api/ICapabilitiesApi.php @@ -0,0 +1,34 @@ + + * + * @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 . + * + */ + +namespace OCP\Remote\Api; + +/** + * @since 13.0.0 + */ +interface ICapabilitiesApi { + /** + * @return array The capabilities in the form of [$appId => [$capability => $value]] + * + * @since 13.0.0 + */ + public function getCapabilities(); +} diff --git a/lib/public/Remote/Api/IUserApi.php b/lib/public/Remote/Api/IUserApi.php new file mode 100644 index 00000000000..9fa05dee01a --- /dev/null +++ b/lib/public/Remote/Api/IUserApi.php @@ -0,0 +1,37 @@ + + * + * @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 . + * + */ + +namespace OCP\Remote\Api; + +use OCP\Remote\IUser; + +/** + * @since 13.0.0 + */ +interface IUserApi { + /** + * @param string $userId + * @return IUser + * + * @since 13.0.0 + */ + public function getUser($userId); +} diff --git a/lib/public/Remote/ICredentials.php b/lib/public/Remote/ICredentials.php new file mode 100644 index 00000000000..587bb4d5930 --- /dev/null +++ b/lib/public/Remote/ICredentials.php @@ -0,0 +1,43 @@ + + * + * @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 . + * + */ + +namespace OCP\Remote; + +/** + * The credentials for a remote user + * + * @since 13.0.0 + */ +interface ICredentials { + /** + * @return string + * + * @since 13.0.0 + */ + public function getUsername(); + + /** + * @return string + * + * @since 13.0.0 + */ + public function getPassword(); +} diff --git a/lib/public/Remote/IInstance.php b/lib/public/Remote/IInstance.php new file mode 100644 index 00000000000..08973308aba --- /dev/null +++ b/lib/public/Remote/IInstance.php @@ -0,0 +1,66 @@ + + * + * @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 . + * + */ + +namespace OCP\Remote; + +/** + * Provides some basic info about a remote Nextcloud instance + * + * @since 13.0.0 + */ +interface IInstance { + /** + * @return string The url of the remote server without protocol + * + * @since 13.0.0 + */ + public function getUrl(); + + /** + * @return string The of of the remote server with protocol + * + * @since 13.0.0 + */ + public function getFullUrl(); + + /** + * @return string The full version string in '13.1.2.3' format + * + * @since 13.0.0 + */ + public function getVersion(); + + /** + * @return string 'http' or 'https' + * + * @since 13.0.0 + */ + public function getProtocol(); + + /** + * Check that the remote server is installed and not in maintenance mode + * + * @since 13.0.0 + * + * @return bool + */ + public function isActive(); +} diff --git a/lib/public/Remote/IInstanceFactory.php b/lib/public/Remote/IInstanceFactory.php new file mode 100644 index 00000000000..22ac85563f3 --- /dev/null +++ b/lib/public/Remote/IInstanceFactory.php @@ -0,0 +1,35 @@ + + * + * @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 . + * + */ + +namespace OCP\Remote; + +/** + * @since 13.0.0 + */ +interface IInstanceFactory { + /** + * @param $url + * @return IInstance + * + * @since 13.0.0 + */ + public function getInstance($url); +} diff --git a/lib/public/Remote/IUser.php b/lib/public/Remote/IUser.php new file mode 100644 index 00000000000..c34531d3847 --- /dev/null +++ b/lib/public/Remote/IUser.php @@ -0,0 +1,120 @@ + + * + * @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 . + * + */ + +namespace OCP\Remote; + +/** + * User info for a remote user + * + * @since 13.0.0 + */ +interface IUser { + /** + * @return string + * + * @since 13.0.0 + */ + public function getUserId(); + + /** + * @return string + * + * @since 13.0.0 + */ + public function getEmail(); + + /** + * @return string + * + * @since 13.0.0 + */ + public function getDisplayName(); + + /** + * @return string + * + * @since 13.0.0 + */ + public function getPhone(); + + /** + * @return string + * + * @since 13.0.0 + */ + public function getAddress(); + + /** + * @return string + * + * @since 13.0.0 + */ + public function getWebsite(); + + /** + * @return string + * + * @since 13.0.0 + */ + public function getTwitter(); + + /** + * @return string[] + * + * @since 13.0.0 + */ + public function getGroups(); + + /** + * @return string + * + * @since 13.0.0 + */ + public function getLanguage(); + + /** + * @return int + * + * @since 13.0.0 + */ + public function getUsedSpace(); + + /** + * @return int + * + * @since 13.0.0 + */ + public function getFreeSpace(); + + /** + * @return int + * + * @since 13.0.0 + */ + public function getTotalSpace(); + + /** + * @return int + * + * @since 13.0.0 + */ + public function getQuota(); +} -- cgit v1.2.3 From 8b01176f60ee85582d467ca9b66aa8fbecd3e54d Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Thu, 19 Oct 2017 13:50:27 +0200 Subject: add more typehints Signed-off-by: Robin Appelman --- lib/private/Remote/Api/ApiBase.php | 1 + lib/private/Remote/Api/ApiCollection.php | 3 +++ lib/private/Remote/Api/ApiFactory.php | 1 + lib/private/Remote/Instance.php | 9 +++++++++ lib/private/Remote/InstanceFactory.php | 2 ++ lib/public/Remote/IInstanceFactory.php | 2 +- 6 files changed, 17 insertions(+), 1 deletion(-) (limited to 'lib/public') diff --git a/lib/private/Remote/Api/ApiBase.php b/lib/private/Remote/Api/ApiBase.php index 64153a9311f..70292a977f4 100644 --- a/lib/private/Remote/Api/ApiBase.php +++ b/lib/private/Remote/Api/ApiBase.php @@ -57,6 +57,7 @@ class ApiBase { * @param array $query * @param array $headers * @return resource|string + * @throws \InvalidArgumentException */ protected function request($method, $url, array $body = [], array $query = [], array $headers = []) { $fullUrl = trim($this->instance->getFullUrl(), '/') . '/' . $url; diff --git a/lib/private/Remote/Api/ApiCollection.php b/lib/private/Remote/Api/ApiCollection.php index 41b1bac0e08..5ce97621dbb 100644 --- a/lib/private/Remote/Api/ApiCollection.php +++ b/lib/private/Remote/Api/ApiCollection.php @@ -28,8 +28,11 @@ use OCP\Remote\ICredentials; use OCP\Remote\IInstance; class ApiCollection implements IApiCollection { + /** @var IInstance */ private $instance; + /** @var ICredentials */ private $credentials; + /** @var IClientService */ private $clientService; public function __construct(IInstance $instance, ICredentials $credentials, IClientService $clientService) { diff --git a/lib/private/Remote/Api/ApiFactory.php b/lib/private/Remote/Api/ApiFactory.php index ea084c188f1..19b8e8eb50c 100644 --- a/lib/private/Remote/Api/ApiFactory.php +++ b/lib/private/Remote/Api/ApiFactory.php @@ -28,6 +28,7 @@ use OCP\Remote\ICredentials; use OCP\Remote\IInstance; class ApiFactory implements IApiFactory { + /** @var IClientService */ private $clientService; public function __construct(IClientService $clientService) { diff --git a/lib/private/Remote/Instance.php b/lib/private/Remote/Instance.php index ab0081d86cf..0ed301ae868 100644 --- a/lib/private/Remote/Instance.php +++ b/lib/private/Remote/Instance.php @@ -39,6 +39,7 @@ class Instance implements IInstance { /** @var IClientService */ private $clientService; + /** @var array|null */ private $status; /** @@ -93,6 +94,10 @@ class Instance implements IInstance { return $status['installed'] && !$status['maintenance']; } + /** + * @return array + * @throws NotFoundException + */ private function getStatus() { if ($this->status) { return $this->status; @@ -120,6 +125,10 @@ class Instance implements IInstance { return $status; } + /** + * @param string $url + * @return bool|string + */ private function downloadStatus($url) { try { $request = $this->clientService->newClient()->get($url); diff --git a/lib/private/Remote/InstanceFactory.php b/lib/private/Remote/InstanceFactory.php index 3b99bc61825..72baa433615 100644 --- a/lib/private/Remote/InstanceFactory.php +++ b/lib/private/Remote/InstanceFactory.php @@ -27,7 +27,9 @@ use OCP\ICache; use OCP\Remote\IInstanceFactory; class InstanceFactory implements IInstanceFactory { + /** @var ICache */ private $cache; + /** @var IClientService */ private $clientService; public function __construct(ICache $cache, IClientService $clientService) { diff --git a/lib/public/Remote/IInstanceFactory.php b/lib/public/Remote/IInstanceFactory.php index 22ac85563f3..6aae463a897 100644 --- a/lib/public/Remote/IInstanceFactory.php +++ b/lib/public/Remote/IInstanceFactory.php @@ -26,7 +26,7 @@ namespace OCP\Remote; */ interface IInstanceFactory { /** - * @param $url + * @param string $url * @return IInstance * * @since 13.0.0 -- cgit v1.2.3