nextcloud/lib/private/api.php

481 lines
13 KiB
PHP
Raw Normal View History

<?php
use OCP\API;
use OCP\AppFramework\Http;
/**
2015-03-26 13:44:34 +03:00
* @author Bart Visscher <bartv@thisnet.nl>
* @author Bernhard Posselt <dev@bernhard-posselt.com>
* @author Björn Schießle <schiessle@owncloud.com>
2015-06-25 12:43:55 +03:00
* @author Joas Schilling <nickvergessen@owncloud.com>
2015-03-26 13:44:34 +03:00
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
* @author Lukas Reschke <lukas@owncloud.com>
* @author Michael Gapczynski <GapczynskiM@gmail.com>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Robin Appelman <icewind@owncloud.com>
* @author Thomas Müller <thomas.mueller@tmit.eu>
* @author Tom Needham <tom@owncloud.com>
* @author Vincent Petry <pvince81@owncloud.com>
*
* @copyright Copyright (c) 2015, 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/>
*
*/
2012-07-29 01:50:40 +04:00
class OC_API {
/**
* API authentication levels
*/
/** @deprecated Use \OCP\API::GUEST_AUTH instead */
const GUEST_AUTH = 0;
/** @deprecated Use \OCP\API::USER_AUTH instead */
const USER_AUTH = 1;
/** @deprecated Use \OCP\API::SUBADMIN_AUTH instead */
const SUBADMIN_AUTH = 2;
/** @deprecated Use \OCP\API::ADMIN_AUTH instead */
const ADMIN_AUTH = 3;
2014-01-13 15:27:05 +04:00
/**
* API Response Codes
*/
/** @deprecated Use \OCP\API::RESPOND_UNAUTHORISED instead */
const RESPOND_UNAUTHORISED = 997;
/** @deprecated Use \OCP\API::RESPOND_SERVER_ERROR instead */
const RESPOND_SERVER_ERROR = 996;
/** @deprecated Use \OCP\API::RESPOND_NOT_FOUND instead */
const RESPOND_NOT_FOUND = 998;
/** @deprecated Use \OCP\API::RESPOND_UNKNOWN_ERROR instead */
const RESPOND_UNKNOWN_ERROR = 999;
2014-01-13 15:27:05 +04:00
2012-07-29 01:50:40 +04:00
/**
* api actions
*/
protected static $actions = array();
private static $logoutRequired = false;
2014-12-17 22:22:51 +03:00
private static $isLoggedIn = false;
2014-01-13 15:27:05 +04:00
2012-07-29 01:50:40 +04:00
/**
* registers an api call
* @param string $method the http method
* @param string $url the url to match
* @param callable $action the function to run
* @param string $app the id of the app registering the call
* @param int $authLevel the level of authentication required for the call
* @param array $defaults
* @param array $requirements
*/
2014-01-13 15:27:05 +04:00
public static function register($method, $url, $action, $app,
$authLevel = API::USER_AUTH,
2012-08-01 01:26:15 +04:00
$defaults = array(),
$requirements = array()) {
2012-07-29 01:50:40 +04:00
$name = strtolower($method).$url;
2012-07-30 22:52:47 +04:00
$name = str_replace(array('/', '{', '}'), '_', $name);
if(!isset(self::$actions[$name])) {
$oldCollection = OC::$server->getRouter()->getCurrentCollection();
OC::$server->getRouter()->useCollection('ocs');
OC::$server->getRouter()->create($name, $url)
->method($method)
->defaults($defaults)
->requirements($requirements)
2012-07-29 01:50:40 +04:00
->action('OC_API', 'call');
self::$actions[$name] = array();
OC::$server->getRouter()->useCollection($oldCollection);
2012-07-29 01:50:40 +04:00
}
self::$actions[$name][] = array('app' => $app, 'action' => $action, 'authlevel' => $authLevel);
2012-07-29 01:50:40 +04:00
}
2014-01-13 15:27:05 +04:00
2012-07-29 01:50:40 +04:00
/**
* handles an api call
* @param array $parameters
*/
public static function call($parameters) {
$request = \OC::$server->getRequest();
2015-03-01 13:46:39 +03:00
$method = $request->getMethod();
2012-09-17 16:08:17 +04:00
// Prepare the request variables
2015-03-01 13:46:39 +03:00
if($method === 'PUT') {
$parameters['_put'] = $request->getParams();
2015-03-01 13:46:39 +03:00
} else if($method === 'DELETE') {
$parameters['_delete'] = $request->getParams();
2012-09-17 16:08:17 +04:00
}
2012-07-30 23:03:41 +04:00
$name = $parameters['_route'];
// Foreach registered action
$responses = array();
foreach(self::$actions[$name] as $action) {
// Check authentication and availability
if(!self::isAuthorised($action)) {
$responses[] = array(
'app' => $action['app'],
'response' => new OC_OCS_Result(null, API::RESPOND_UNAUTHORISED, 'Unauthorised'),
'shipped' => OC_App::isShipped($action['app']),
);
continue;
2013-01-14 23:30:39 +04:00
}
if(!is_callable($action['action'])) {
$responses[] = array(
'app' => $action['app'],
'response' => new OC_OCS_Result(null, API::RESPOND_NOT_FOUND, 'Api method not found'),
'shipped' => OC_App::isShipped($action['app']),
);
continue;
}
// Run the action
$responses[] = array(
'app' => $action['app'],
'response' => call_user_func($action['action'], $parameters),
'shipped' => OC_App::isShipped($action['app']),
);
}
$response = self::mergeResponses($responses);
2014-03-12 03:35:19 +04:00
$format = self::requestedFormat();
if (self::$logoutRequired) {
OC_User::logout();
}
2013-05-02 16:51:53 +04:00
self::respond($response, $format);
2012-07-29 01:50:40 +04:00
}
2014-01-13 15:27:05 +04:00
/**
* merge the returned result objects into one response
* @param array $responses
2014-04-21 17:44:54 +04:00
* @return array|\OC_OCS_Result
*/
public static function mergeResponses($responses) {
// Sort into shipped and third-party
$shipped = array(
2013-02-09 16:50:19 +04:00
'succeeded' => array(),
'failed' => array(),
);
$thirdparty = array(
'succeeded' => array(),
'failed' => array(),
);
2013-01-14 23:30:39 +04:00
foreach($responses as $response) {
if($response['shipped'] || ($response['app'] === 'core')) {
if($response['response']->succeeded()) {
$shipped['succeeded'][$response['app']] = $response;
} else {
$shipped['failed'][$response['app']] = $response;
}
} else {
if($response['response']->succeeded()) {
$thirdparty['succeeded'][$response['app']] = $response;
} else {
$thirdparty['failed'][$response['app']] = $response;
}
}
}
// Remove any error responses if there is one shipped response that succeeded
if(!empty($shipped['failed'])) {
// Which shipped response do we use if they all failed?
// They may have failed for different reasons (different status codes)
// Which response code should we return?
// Maybe any that are not \OCP\API::RESPOND_SERVER_ERROR
// Merge failed responses if more than one
$data = array();
foreach($shipped['failed'] as $failure) {
$data = array_merge_recursive($data, $failure['response']->getData());
}
$picked = reset($shipped['failed']);
$code = $picked['response']->getStatusCode();
2014-01-13 15:27:05 +04:00
$meta = $picked['response']->getMeta();
$response = new OC_OCS_Result($data, $code, $meta['message']);
return $response;
} elseif(!empty($shipped['succeeded'])) {
$responses = array_merge($shipped['succeeded'], $thirdparty['succeeded']);
} elseif(!empty($thirdparty['failed'])) {
// Merge failed responses if more than one
$data = array();
foreach($thirdparty['failed'] as $failure) {
$data = array_merge_recursive($data, $failure['response']->getData());
}
$picked = reset($thirdparty['failed']);
$code = $picked['response']->getStatusCode();
2014-01-13 15:27:05 +04:00
$meta = $picked['response']->getMeta();
$response = new OC_OCS_Result($data, $code, $meta['message']);
return $response;
} else {
$responses = $thirdparty['succeeded'];
}
// Merge the successful responses
$data = array();
2014-04-21 17:44:54 +04:00
foreach($responses as $response) {
if($response['shipped']) {
$data = array_merge_recursive($response['response']->getData(), $data);
} else {
$data = array_merge_recursive($data, $response['response']->getData());
}
2014-01-13 15:27:05 +04:00
$codes[] = array('code' => $response['response']->getStatusCode(),
'meta' => $response['response']->getMeta());
}
// Use any non 100 status codes
$statusCode = 100;
2014-01-13 15:27:05 +04:00
$statusMessage = null;
foreach($codes as $code) {
2014-01-13 15:27:05 +04:00
if($code['code'] != 100) {
$statusCode = $code['code'];
$statusMessage = $code['meta']['message'];
break;
}
}
2014-01-13 15:27:05 +04:00
$result = new OC_OCS_Result($data, $statusCode, $statusMessage);
return $result;
}
2014-01-13 15:27:05 +04:00
/**
* authenticate the api call
* @param array $action the action details as supplied to OC_API::register()
* @return bool
*/
private static function isAuthorised($action) {
$level = $action['authlevel'];
switch($level) {
case API::GUEST_AUTH:
// Anyone can access
return true;
break;
case API::USER_AUTH:
// User required
return self::loginUser();
break;
case API::SUBADMIN_AUTH:
// Check for subadmin
$user = self::loginUser();
if(!$user) {
return false;
} else {
$subAdmin = OC_SubAdmin::isSubAdmin($user);
$admin = OC_User::isAdminUser($user);
if($subAdmin || $admin) {
return true;
} else {
return false;
}
}
break;
case API::ADMIN_AUTH:
// Check for admin
$user = self::loginUser();
if(!$user) {
return false;
} else {
return OC_User::isAdminUser($user);
}
break;
default:
// oops looks like invalid level supplied
return false;
break;
}
2014-01-13 15:27:05 +04:00
}
/**
* http basic auth
* @return string|false (username, or false on failure)
*/
2014-12-17 22:22:51 +03:00
private static function loginUser() {
if(self::$isLoggedIn === true) {
return \OC_User::getUser();
}
2014-03-07 23:06:06 +04:00
// reuse existing login
$loggedIn = OC_User::isLoggedIn();
if ($loggedIn === true) {
$ocsApiRequest = isset($_SERVER['HTTP_OCS_APIREQUEST']) ? $_SERVER['HTTP_OCS_APIREQUEST'] === 'true' : false;
if ($ocsApiRequest) {
// initialize the user's filesystem
\OC_Util::setUpFS(\OC_User::getUser());
2014-12-17 22:22:51 +03:00
self::$isLoggedIn = true;
return OC_User::getUser();
}
return false;
2014-03-07 23:06:06 +04:00
}
// basic auth - because OC_User::login will create a new session we shall only try to login
// if user and pass are set
if(isset($_SERVER['PHP_AUTH_USER']) && isset($_SERVER['PHP_AUTH_PW']) ) {
$authUser = $_SERVER['PHP_AUTH_USER'];
$authPw = $_SERVER['PHP_AUTH_PW'];
$return = OC_User::login($authUser, $authPw);
if ($return === true) {
self::$logoutRequired = true;
// initialize the user's filesystem
\OC_Util::setUpFS(\OC_User::getUser());
2014-12-17 22:22:51 +03:00
self::$isLoggedIn = true;
return \OC_User::getUser();
}
}
return false;
}
2014-01-13 15:27:05 +04:00
2012-07-29 01:50:40 +04:00
/**
* respond to a call
* @param OC_OCS_Result $result
* @param string $format the format xml|json
*/
public static function respond($result, $format='xml') {
// Send 401 headers if unauthorised
if($result->getStatusCode() === API::RESPOND_UNAUTHORISED) {
header('WWW-Authenticate: Basic realm="Authorisation Required"');
header('HTTP/1.0 401 Unauthorized');
}
foreach($result->getHeaders() as $name => $value) {
header($name . ': ' . $value);
}
$meta = $result->getMeta();
$data = $result->getData();
if (self::isV2()) {
$statusCode = self::mapStatusCodes($result->getStatusCode());
if (!is_null($statusCode)) {
$meta['statuscode'] = $statusCode;
OC_Response::setStatus($statusCode);
}
}
2015-08-03 22:03:11 +03:00
self::setContentType($format);
$body = self::renderResult($format, $meta, $data);
2015-08-03 22:03:11 +03:00
echo $body;
2012-07-29 01:50:40 +04:00
}
2012-08-01 21:48:51 +04:00
/**
* @param XMLWriter $writer
*/
private static function toXML($array, $writer) {
2012-08-01 21:48:51 +04:00
foreach($array as $k => $v) {
if ($k[0] === '@') {
$writer->writeAttribute(substr($k, 1), $v);
continue;
} else if (is_numeric($k)) {
2012-08-02 19:48:09 +04:00
$k = 'element';
}
if(is_array($v)) {
2012-08-01 21:48:51 +04:00
$writer->startElement($k);
self::toXML($v, $writer);
$writer->endElement();
} else {
$writer->writeElement($k, $v);
}
}
}
2014-01-13 15:27:05 +04:00
2014-03-12 03:35:19 +04:00
/**
* @return string
*/
public static function requestedFormat() {
$formats = array('json', 'xml');
$format = !empty($_GET['format']) && in_array($_GET['format'], $formats) ? $_GET['format'] : 'xml';
return $format;
}
/**
* Based on the requested format the response content type is set
*/
2015-08-03 22:03:11 +03:00
public static function setContentType($format = null) {
$format = is_null($format) ? self::requestedFormat() : $format;
2014-03-12 03:35:19 +04:00
if ($format === 'xml') {
header('Content-type: text/xml; charset=UTF-8');
return;
}
if ($format === 'json') {
header('Content-Type: application/json; charset=utf-8');
return;
}
header('Content-Type: application/octet-stream; charset=utf-8');
}
/**
* @return boolean
*/
private static function isV2() {
$request = \OC::$server->getRequest();
$script = $request->getScriptName();
2014-03-12 03:35:19 +04:00
return $script === '/ocs/v2.php';
}
/**
* @param integer $sc
* @return int
*/
public static function mapStatusCodes($sc) {
switch ($sc) {
case API::RESPOND_NOT_FOUND:
return Http::STATUS_NOT_FOUND;
case API::RESPOND_SERVER_ERROR:
return Http::STATUS_INTERNAL_SERVER_ERROR;
case API::RESPOND_UNKNOWN_ERROR:
return Http::STATUS_INTERNAL_SERVER_ERROR;
case API::RESPOND_UNAUTHORISED:
// already handled for v1
return null;
case 100:
return Http::STATUS_OK;
}
// any 2xx, 4xx and 5xx will be used as is
if ($sc >= 200 && $sc < 600) {
return $sc;
}
return Http::STATUS_BAD_REQUEST;
}
2015-08-03 22:03:11 +03:00
/**
* @param string $format
* @return string
*/
public static function renderResult($format, $meta, $data) {
2015-08-03 22:03:11 +03:00
$response = array(
'ocs' => array(
'meta' => $meta,
'data' => $data,
2015-08-03 22:03:11 +03:00
),
);
if ($format == 'json') {
return OC_JSON::encode($response);
}
$writer = new XMLWriter();
$writer->openMemory();
$writer->setIndent(true);
$writer->startDocument();
self::toXML($response, $writer);
$writer->endDocument();
return $writer->outputMemory(true);
}
2012-07-30 23:03:41 +04:00
}