diff options
author | Roeland Douma <rullzer@users.noreply.github.com> | 2016-05-12 09:43:53 +0200 |
---|---|---|
committer | Thomas Müller <DeepDiver1975@users.noreply.github.com> | 2016-05-12 09:43:53 +0200 |
commit | 9b05f37fad88fdf78fdfee9473c27ba5be12abb2 (patch) | |
tree | bdfeccfb14c40691e0022f0416f6c80c72da8151 /lib/private/OCS | |
parent | 52add798d4d814b5276e324c2e98404ff0abe020 (diff) | |
download | nextcloud-server-9b05f37fad88fdf78fdfee9473c27ba5be12abb2.tar.gz nextcloud-server-9b05f37fad88fdf78fdfee9473c27ba5be12abb2.zip |
lib/private/ocs to PSR-4 (#24558)
* Move OC_OCS_XX to legacy
* Move \OC\OCS to PSR-4
* OC_OCS_xx to \OC\OCS\xx
* Moved OC_OCS_xx to proper namespace
* OC_OCS_xx is still there for legacy reasons as a wrapper
* No calls to OC_OCS_xx in \OC\OCS\
Diffstat (limited to 'lib/private/OCS')
-rw-r--r-- | lib/private/OCS/Cloud.php | 54 | ||||
-rw-r--r-- | lib/private/OCS/Config.php | 37 | ||||
-rw-r--r-- | lib/private/OCS/CoreCapabilities.php | 58 | ||||
-rw-r--r-- | lib/private/OCS/Exception.php | 34 | ||||
-rw-r--r-- | lib/private/OCS/Person.php | 43 | ||||
-rw-r--r-- | lib/private/OCS/PrivateData.php | 112 | ||||
-rw-r--r-- | lib/private/OCS/Result.php | 158 |
7 files changed, 496 insertions, 0 deletions
diff --git a/lib/private/OCS/Cloud.php b/lib/private/OCS/Cloud.php new file mode 100644 index 00000000000..9686e9bfb58 --- /dev/null +++ b/lib/private/OCS/Cloud.php @@ -0,0 +1,54 @@ +<?php +/** + * @author Morris Jobke <hey@morrisjobke.de> + * @author Roeland Jago Douma <rullzer@owncloud.com> + * @author Thomas Müller <thomas.mueller@tmit.eu> + * @author Tom Needham <tom@owncloud.com> + * + * @copyright Copyright (c) 2016, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License, version 3, + * as published by the Free Software Foundation. + * + * 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, version 3, + * along with this program. If not, see <http://www.gnu.org/licenses/> + * + */ + +namespace OC\OCS; + +class Cloud { + + public static function getCapabilities() { + $result = array(); + list($major, $minor, $micro) = \OCP\Util::getVersion(); + $result['version'] = array( + 'major' => $major, + 'minor' => $minor, + 'micro' => $micro, + 'string' => \OC_Util::getVersionString(), + 'edition' => \OC_Util::getEditionString(), + ); + + $result['capabilities'] = \OC::$server->getCapabilitiesManager()->getCapabilities(); + + return new Result($result); + } + + public static function getCurrentUser() { + $userObject = \OC::$server->getUserManager()->get(\OC_User::getUser()); + $data = array( + 'id' => $userObject->getUID(), + 'display-name' => $userObject->getDisplayName(), + 'email' => $userObject->getEMailAddress(), + ); + return new Result($data); + } +} diff --git a/lib/private/OCS/Config.php b/lib/private/OCS/Config.php new file mode 100644 index 00000000000..5478411d6fd --- /dev/null +++ b/lib/private/OCS/Config.php @@ -0,0 +1,37 @@ +<?php +/** + * @author Bart Visscher <bartv@thisnet.nl> + * @author Morris Jobke <hey@morrisjobke.de> + * @author Tom Needham <tom@owncloud.com> + * + * @copyright Copyright (c) 2016, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License, version 3, + * as published by the Free Software Foundation. + * + * 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, version 3, + * along with this program. If not, see <http://www.gnu.org/licenses/> + * + */ + +namespace OC\OCS; + +class Config { + + public static function apiConfig() { + $xml['version'] = '1.7'; + $xml['website'] = 'ownCloud'; + $xml['host'] = \OCP\Util::getServerHost(); + $xml['contact'] = ''; + $xml['ssl'] = 'false'; + return new Result($xml); + } + +} diff --git a/lib/private/OCS/CoreCapabilities.php b/lib/private/OCS/CoreCapabilities.php new file mode 100644 index 00000000000..388a58791b4 --- /dev/null +++ b/lib/private/OCS/CoreCapabilities.php @@ -0,0 +1,58 @@ +<?php +/** + * @author Roeland Jago Douma <rullzer@owncloud.com> + * @author Thomas Müller <thomas.mueller@tmit.eu> + * + * @copyright Copyright (c) 2016, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License, version 3, + * as published by the Free Software Foundation. + * + * 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, version 3, + * along with this program. If not, see <http://www.gnu.org/licenses/> + * + */ + +namespace OC\OCS; + +use OCP\Capabilities\ICapability; +use OCP\IConfig; + +/** + * Class Capabilities + * + * @package OC\OCS + */ +class CoreCapabilities implements ICapability { + + /** @var IConfig */ + private $config; + + /** + * @param IConfig $config + */ + public function __construct(IConfig $config) { + $this->config = $config; + } + + /** + * Return this classes capabilities + * + * @return array + */ + public function getCapabilities() { + return [ + 'core' => [ + 'pollinterval' => $this->config->getSystemValue('pollinterval', 60), + 'webdav-root' => $this->config->getSystemValue('webdav-root', 'remote.php/webdav'), + ] + ]; + } +} diff --git a/lib/private/OCS/Exception.php b/lib/private/OCS/Exception.php new file mode 100644 index 00000000000..33c88fcf7d3 --- /dev/null +++ b/lib/private/OCS/Exception.php @@ -0,0 +1,34 @@ +<?php +/** + * @author Thomas Müller <thomas.mueller@tmit.eu> + * + * @copyright Copyright (c) 2016, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License, version 3, + * as published by the Free Software Foundation. + * + * 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, version 3, + * along with this program. If not, see <http://www.gnu.org/licenses/> + * + */ + +namespace OC\OCS; + +class Exception extends \Exception { + + public function __construct(Result $result) { + $this->result = $result; + } + + public function getResult() { + return $this->result; + } + +} diff --git a/lib/private/OCS/Person.php b/lib/private/OCS/Person.php new file mode 100644 index 00000000000..fd33504e0a8 --- /dev/null +++ b/lib/private/OCS/Person.php @@ -0,0 +1,43 @@ +<?php +/** + * @author Bart Visscher <bartv@thisnet.nl> + * @author Morris Jobke <hey@morrisjobke.de> + * @author Tom Needham <tom@owncloud.com> + * + * @copyright Copyright (c) 2016, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License, version 3, + * as published by the Free Software Foundation. + * + * 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, version 3, + * along with this program. If not, see <http://www.gnu.org/licenses/> + * + */ + +namespace OC\OCS; + +class Person { + + public static function check() { + $login = isset($_POST['login']) ? $_POST['login'] : false; + $password = isset($_POST['password']) ? $_POST['password'] : false; + if($login && $password) { + if(\OC_User::checkPassword($login, $password)) { + $xml['person']['personid'] = $login; + return new Result($xml); + } else { + return new Result(null, 102); + } + } else { + return new Result(null, 101); + } + } + +} diff --git a/lib/private/OCS/PrivateData.php b/lib/private/OCS/PrivateData.php new file mode 100644 index 00000000000..c69d8b9cc17 --- /dev/null +++ b/lib/private/OCS/PrivateData.php @@ -0,0 +1,112 @@ +<?php +/** + * @author Andreas Fischer <bantu@owncloud.com> + * @author Bart Visscher <bartv@thisnet.nl> + * @author Frank Karlitschek <frank@owncloud.org> + * @author Lukas Reschke <lukas@owncloud.com> + * @author Morris Jobke <hey@morrisjobke.de> + * @author Thomas Müller <thomas.mueller@tmit.eu> + * @author Tom Needham <tom@owncloud.com> + * + * @copyright Copyright (c) 2016, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License, version 3, + * as published by the Free Software Foundation. + * + * 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, version 3, + * along with this program. If not, see <http://www.gnu.org/licenses/> + * + */ + +namespace OC\OCS; + +class PrivateData { + + /** + * read keys + * test: curl http://login:passwd@oc/core/ocs/v1.php/privatedata/getattribute/testy/123 + * test: curl http://login:passwd@oc/core/ocs/v1.php/privatedata/getattribute/testy + * @param array $parameters The OCS parameter + * @return \OC_OCS_Result + */ + public static function get($parameters) { + $user = \OC_User::getUser(); + $app = addslashes(strip_tags($parameters['app'])); + $key = isset($parameters['key']) ? addslashes(strip_tags($parameters['key'])) : null; + + if(empty($key)) { + $query = \OCP\DB::prepare('SELECT `key`, `app`, `value` FROM `*PREFIX*privatedata` WHERE `user` = ? AND `app` = ? '); + $result = $query->execute(array($user, $app)); + } else { + $query = \OCP\DB::prepare('SELECT `key`, `app`, `value` FROM `*PREFIX*privatedata` WHERE `user` = ? AND `app` = ? AND `key` = ? '); + $result = $query->execute(array($user, $app, $key)); + } + + $xml = array(); + while ($row = $result->fetchRow()) { + $data=array(); + $data['key']=$row['key']; + $data['app']=$row['app']; + $data['value']=$row['value']; + $xml[] = $data; + } + + return new Result($xml); + } + + /** + * set a key + * test: curl http://login:passwd@oc/core/ocs/v1.php/privatedata/setattribute/testy/123 --data "value=foobar" + * @param array $parameters The OCS parameter + * @return \OC_OCS_Result + */ + public static function set($parameters) { + $user = \OC_User::getUser(); + $app = addslashes(strip_tags($parameters['app'])); + $key = addslashes(strip_tags($parameters['key'])); + $value = (string)$_POST['value']; + + // update in DB + $query = \OCP\DB::prepare('UPDATE `*PREFIX*privatedata` SET `value` = ? WHERE `user` = ? AND `app` = ? AND `key` = ?'); + $numRows = $query->execute(array($value, $user, $app, $key)); + + if ($numRows === false || $numRows === 0) { + // store in DB + $query = \OCP\DB::prepare('INSERT INTO `*PREFIX*privatedata` (`user`, `app`, `key`, `value`)' . ' VALUES(?, ?, ?, ?)'); + $query->execute(array($user, $app, $key, $value)); + } + + return new Result(null, 100); + } + + /** + * delete a key + * test: curl http://login:passwd@oc/core/ocs/v1.php/privatedata/deleteattribute/testy/123 --data "post=1" + * @param array $parameters The OCS parameter + * @return \OC_OCS_Result + */ + public static function delete($parameters) { + $user = \OC_User::getUser(); + if (!isset($parameters['app']) or !isset($parameters['key'])) { + //key and app are NOT optional here + return new Result(null, 101); + } + + $app = addslashes(strip_tags($parameters['app'])); + $key = addslashes(strip_tags($parameters['key'])); + + // delete in DB + $query = \OCP\DB::prepare('DELETE FROM `*PREFIX*privatedata` WHERE `user` = ? AND `app` = ? AND `key` = ? '); + $query->execute(array($user, $app, $key )); + + return new Result(null, 100); + } +} + diff --git a/lib/private/OCS/Result.php b/lib/private/OCS/Result.php new file mode 100644 index 00000000000..c2c61e2383d --- /dev/null +++ b/lib/private/OCS/Result.php @@ -0,0 +1,158 @@ +<?php +/** + * @author Bart Visscher <bartv@thisnet.nl> + * @author Björn Schießle <schiessle@owncloud.com> + * @author Christopher Schäpers <kondou@ts.unde.re> + * @author Lukas Reschke <lukas@owncloud.com> + * @author Morris Jobke <hey@morrisjobke.de> + * @author Robin McCorkell <robin@mccorkell.me.uk> + * @author Thomas Müller <thomas.mueller@tmit.eu> + * @author Tom Needham <tom@owncloud.com> + * + * @copyright Copyright (c) 2016, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License, version 3, + * as published by the Free Software Foundation. + * + * 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, version 3, + * along with this program. If not, see <http://www.gnu.org/licenses/> + * + */ + +namespace OC\OCS; + +class Result { + + /** @var array */ + protected $data; + + /** @var null|string */ + protected $message; + + /** @var int */ + protected $statusCode; + + /** @var integer */ + protected $items; + + /** @var integer */ + protected $perPage; + + /** @var array */ + private $headers = []; + + /** + * create the OCS_Result object + * @param mixed $data the data to return + * @param int $code + * @param null|string $message + * @param array $headers + */ + public function __construct($data = null, $code = 100, $message = null, $headers = []) { + if ($data === null) { + $this->data = array(); + } elseif (!is_array($data)) { + $this->data = array($this->data); + } else { + $this->data = $data; + } + $this->statusCode = $code; + $this->message = $message; + $this->headers = $headers; + } + + /** + * optionally set the total number of items available + * @param int $items + */ + public function setTotalItems($items) { + $this->items = $items; + } + + /** + * optionally set the the number of items per page + * @param int $items + */ + public function setItemsPerPage($items) { + $this->perPage = $items; + } + + /** + * get the status code + * @return int + */ + public function getStatusCode() { + return $this->statusCode; + } + + /** + * get the meta data for the result + * @return array + */ + public function getMeta() { + $meta = array(); + $meta['status'] = $this->succeeded() ? 'ok' : 'failure'; + $meta['statuscode'] = $this->statusCode; + $meta['message'] = $this->message; + if(isset($this->items)) { + $meta['totalitems'] = $this->items; + } + if(isset($this->perPage)) { + $meta['itemsperpage'] = $this->perPage; + } + return $meta; + + } + + /** + * get the result data + * @return array + */ + public function getData() { + return $this->data; + } + + /** + * return bool Whether the method succeeded + * @return bool + */ + public function succeeded() { + return ($this->statusCode == 100); + } + + /** + * Adds a new header to the response + * @param string $name The name of the HTTP header + * @param string $value The value, null will delete it + * @return $this + */ + public function addHeader($name, $value) { + $name = trim($name); // always remove leading and trailing whitespace + // to be able to reliably check for security + // headers + + if(is_null($value)) { + unset($this->headers[$name]); + } else { + $this->headers[$name] = $value; + } + + return $this; + } + + /** + * Returns the set headers + * @return array the headers + */ + public function getHeaders() { + return $this->headers; + } + +} |