159 lines
4.2 KiB
PHP
159 lines
4.2 KiB
PHP
<?php
|
|
/**
|
|
* @copyright Copyright (C) 2020, Friendica
|
|
*
|
|
* @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 <https://www.gnu.org/licenses/>.
|
|
*
|
|
*/
|
|
|
|
namespace Friendica\Module;
|
|
|
|
use Friendica\BaseModule;
|
|
use Friendica\DI;
|
|
use Friendica\Network\HTTPException;
|
|
|
|
require_once __DIR__ . '/../../include/api.php';
|
|
|
|
class BaseApi extends BaseModule
|
|
{
|
|
/**
|
|
* @var string json|xml|rss|atom
|
|
*/
|
|
protected static $format = 'json';
|
|
/**
|
|
* @var bool|int
|
|
*/
|
|
protected static $current_user_id;
|
|
|
|
public static function init(array $parameters = [])
|
|
{
|
|
$arguments = DI::args();
|
|
|
|
if (substr($arguments->getQueryString(), -4) === '.xml') {
|
|
self::$format = 'xml';
|
|
}
|
|
if (substr($arguments->getQueryString(), -4) === '.rss') {
|
|
self::$format = 'rss';
|
|
}
|
|
if (substr($arguments->getQueryString(), -4) === '.atom') {
|
|
self::$format = 'atom';
|
|
}
|
|
}
|
|
|
|
public static function post(array $parameters = [])
|
|
{
|
|
if (!api_user()) {
|
|
throw new HTTPException\UnauthorizedException(DI::l10n()->t('Permission denied.'));
|
|
}
|
|
|
|
$a = DI::app();
|
|
|
|
if (!empty($a->user['uid']) && $a->user['uid'] != api_user()) {
|
|
throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Log in user via OAuth1 or Simple HTTP Auth.
|
|
*
|
|
* Simple Auth allow username in form of <pre>user@server</pre>, ignoring server part
|
|
*
|
|
* @return bool Was a user authenticated?
|
|
* @throws HTTPException\ForbiddenException
|
|
* @throws HTTPException\UnauthorizedException
|
|
* @throws HTTPException\InternalServerErrorException
|
|
* @hook 'authenticate'
|
|
* array $addon_auth
|
|
* 'username' => username from login form
|
|
* 'password' => password from login form
|
|
* 'authenticated' => return status,
|
|
* 'user_record' => return authenticated user record
|
|
*/
|
|
protected static function login()
|
|
{
|
|
api_login(DI::app());
|
|
|
|
self::$current_user_id = api_user();
|
|
|
|
return (bool)self::$current_user_id;
|
|
}
|
|
|
|
/**
|
|
* Get user info array.
|
|
*
|
|
* @param int|string $contact_id Contact ID or URL
|
|
* @return array|bool
|
|
* @throws HTTPException\BadRequestException
|
|
* @throws HTTPException\InternalServerErrorException
|
|
* @throws HTTPException\UnauthorizedException
|
|
* @throws \ImagickException
|
|
*/
|
|
protected static function getUser($contact_id = null)
|
|
{
|
|
return api_get_user(DI::app(), $contact_id);
|
|
}
|
|
|
|
/**
|
|
* Formats the data according to the data type
|
|
*
|
|
* @param string $root_element
|
|
* @param array $data An array with a single element containing the returned result
|
|
* @return false|string
|
|
*/
|
|
protected static function format(string $root_element, array $data)
|
|
{
|
|
$return = api_format_data($root_element, self::$format, $data);
|
|
|
|
switch (self::$format) {
|
|
case "xml":
|
|
header("Content-Type: text/xml");
|
|
break;
|
|
case "json":
|
|
header("Content-Type: application/json");
|
|
if (!empty($return)) {
|
|
$json = json_encode(end($return));
|
|
if (!empty($_GET['callback'])) {
|
|
$json = $_GET['callback'] . "(" . $json . ")";
|
|
}
|
|
$return = $json;
|
|
}
|
|
break;
|
|
case "rss":
|
|
header("Content-Type: application/rss+xml");
|
|
$return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
|
|
break;
|
|
case "atom":
|
|
header("Content-Type: application/atom+xml");
|
|
$return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
|
|
break;
|
|
}
|
|
|
|
return $return;
|
|
}
|
|
|
|
/**
|
|
* Creates the XML from a JSON style array
|
|
*
|
|
* @param $data
|
|
* @param $root_element
|
|
* @return string
|
|
*/
|
|
protected static function createXml($data, $root_element)
|
|
{
|
|
return api_create_xml($data, $root_element);
|
|
}
|
|
}
|