nupplaPhil/friendica
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

API: spme Functionality is transferred to new places

Browse source
This commit is contained in:
Michael 2021-11-08 21:35:41 +00:00
parent 6ce1e1e7f8
commit f5b47fccce
7 changed files with 389 additions and 450 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

493
include/api.php
View file

File diff suppressed because it is too large Load diff

2
mod/wall_upload.php
View file

@ -55,7 +55,7 @@ function wall_upload_post(App $a, $desktopmode = true)
return;
}
} else {
$user_info = api_get_user($a);
$user_info = api_get_user();
$user = DBA::selectFirst('owner-view', ['id', 'uid', 'nickname', 'page-flags'], ['nickname' => $user_info['screen_name'], 'blocked' => false]);
}
} else {

36
src/Module/Api/Friendica/GNUSocial/Version.php Normal file
View file

@ -0,0 +1,36 @@
<?php
/**
* @copyright Copyright (C) 2010-2021, the Friendica project
*
* @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\Api\Friendica\GNUSocial;
use Friendica\Module\BaseApi;
/**
* API endpoint: /api/friendica/gnusocial/version, /api/friendica/statusnet/version
*/
class Version extends BaseApi
{
public static function rawContent(array $parameters = [])
{
echo self::format('version', ['version' => '0.9.7']);
exit;
}
}

42
src/Module/Api/Friendica/Help/Test.php Normal file
View file

@ -0,0 +1,42 @@
<?php
/**
* @copyright Copyright (C) 2010-2021, the Friendica project
*
* @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\Api\Friendica\Help;
use Friendica\Module\BaseApi;
/**
* API endpoint: /api/friendica/help/test
*/
class Test extends BaseApi
{
public static function rawContent(array $parameters = [])
{
if (self::$format == 'xml') {
$ok = 'true';
} else {
$ok = 'ok';
}
echo self::format('ok', ['ok' => $ok]);
exit;
}
}

141
src/Module/BaseApi.php
View file

@ -31,6 +31,7 @@ use Friendica\Security\BasicAuth;
use Friendica\Security\OAuth;
use Friendica\Util\DateTimeFormat;
use Friendica\Util\HTTPInputData;
use Friendica\Util\XML;
require_once __DIR__ . '/../../include/api.php';
@ -342,7 +343,7 @@ class BaseApi extends BaseModule
*/
protected static function getUser($contact_id = null)
{
return api_get_user(DI::app(), $contact_id);
return api_get_user($contact_id);
}
/**
@ -354,28 +355,28 @@ class BaseApi extends BaseModule
*/
protected static function format(string $root_element, array $data)
{
$return = api_format_data($root_element, self::$format, $data);
$return = self::formatData($root_element, self::$format, $data);
switch (self::$format) {
case "xml":
header("Content-Type: text/xml");
case 'xml':
header('Content-Type: text/xml');
break;
case "json":
header("Content-Type: application/json");
case 'json':
header('Content-Type: application/json');
if (!empty($return)) {
$json = json_encode(end($return));
if (!empty($_GET['callback'])) {
$json = $_GET['callback'] . "(" . $json . ")";
$json = $_GET['callback'] . '(' . $json . ')';
}
$return = $json;
}
break;
case "rss":
header("Content-Type: application/rss+xml");
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");
case 'atom':
header('Content-Type: application/atom+xml');
$return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
break;
}
@ -383,15 +384,123 @@ class BaseApi extends BaseModule
return $return;
}
/**
* walks recursively through an array with the possibility to change value and key
*
* @param array $array The array to walk through
* @param callable $callback The callback function
*
* @return array the transformed array
*/
static public function walkRecursive(array &$array, callable $callback)
{
$new_array = [];
foreach ($array as $k => $v) {
if (is_array($v)) {
if ($callback($v, $k)) {
$new_array[$k] = self::walkRecursive($v, $callback);
}
} else {
if ($callback($v, $k)) {
$new_array[$k] = $v;
}
}
}
$array = $new_array;
return $array;
}
/**
* Formats the data according to the data type
*
* @param string $root_element Name of the root element
* @param string $type Return type (atom, rss, xml, json)
* @param array $data JSON style array
*
* @return array|string (string|array) XML data or JSON data
*/
public static function formatData($root_element, string $type, array $data)
{
switch ($type) {
case 'atom':
case 'rss':
case 'xml':
$ret = self::createXML($data, $root_element);
break;
case 'json':
default:
$ret = $data;
break;
}
return $ret;
}
/**
* Callback function to transform the array in an array that can be transformed in a XML file
*
* @param mixed $item Array item value
* @param string $key Array key
*
* @return boolean
*/
public static function reformatXML(&$item, &$key)
{
if (is_bool($item)) {
$item = ($item ? 'true' : 'false');
}
if (substr($key, 0, 10) == 'statusnet_') {
$key = 'statusnet:'.substr($key, 10);
} elseif (substr($key, 0, 10) == 'friendica_') {
$key = 'friendica:'.substr($key, 10);
}
return true;
}
/**
* Creates the XML from a JSON style array
*
* @param $data
* @param $root_element
* @return string
* @param array $data JSON style array
* @param string $root_element Name of the root element
*
* @return string The XML data
*/
protected static function createXml($data, $root_element)
public static function createXML(array $data, $root_element)
{
return api_create_xml($data, $root_element);
$childname = key($data);
$data2 = array_pop($data);
$namespaces = ['' => 'http://api.twitter.com',
'statusnet' => 'http://status.net/schema/api/1/',
'friendica' => 'http://friendi.ca/schema/api/1/',
'georss' => 'http://www.georss.org/georss'];
/// @todo Auto detection of needed namespaces
if (in_array($root_element, ['ok', 'hash', 'config', 'version', 'ids', 'notes', 'photos'])) {
$namespaces = [];
}
if (is_array($data2)) {
$key = key($data2);
self::walkRecursive($data2, ['Friendica\Module\BaseApi', 'reformatXML']);
if ($key == '0') {
$data4 = [];
$i = 1;
foreach ($data2 as $item) {
$data4[$i++ . ':' . $childname] = $item;
}
$data2 = $data4;
}
}
$data3 = [$root_element => $data2];
$ret = XML::fromArray($data3, $xml, false, $namespaces);
return $ret;
}
}

24
static/routes.config.php
View file

@ -100,9 +100,9 @@ $apiRoutes = [
'/photo[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::GET ]],
],
'/gnusocial/config[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::GET ]],
'/gnusocial/version[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::GET ]],
'/help/test[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::GET ]],
'/gnusocial/config[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::GET ]],
'/gnusocial/version[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\GNUSocial\Version::class, [R::GET ]],
'/help/test[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Help\Test::class, [R::GET ]],
'/lists' => [
'/create[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [ R::POST]],
@ -114,15 +114,15 @@ $apiRoutes = [
'/update[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [ R::POST]],
],
'/media/upload[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [ R::POST]],
'/media/metadata/create[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [ R::POST]],
'/saved_searches/list[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::GET ]],
'/search/tweets[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::GET ]],
'/search[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::GET ]],
'/statusnet/config[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::GET ]],
'/statusnet/conversation[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::GET ]],
'/statusnet/conversation/{id:\d+}[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::GET ]],
'/statusnet/version[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::GET ]],
'/media/upload[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [ R::POST]],
'/media/metadata/create[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [ R::POST]],
'/saved_searches/list[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::GET ]],
'/search/tweets[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::GET ]],
'/search[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::GET ]],
'/statusnet/config[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::GET ]],
'/statusnet/conversation[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::GET ]],
'/statusnet/conversation/{id:\d+}[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::GET ]],
'/statusnet/version[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\GNUSocial\Version::class, [R::GET ]],
'/statuses' => [
'/destroy[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::DELETE, R::POST]],

101
tests/legacy/ApiTest.php
View file

@ -10,7 +10,9 @@ use Friendica\Core\Config\Capability\IManageConfigValues;
use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues;
use Friendica\Core\Protocol;
use Friendica\DI;
use Friendica\Module\BaseApi;
use Friendica\Network\HTTPException;
use Friendica\Security\BasicAuth;
use Friendica\Test\FixtureTest;
use Friendica\Util\DateTimeFormat;
use Friendica\Util\Temporal;
@ -298,7 +300,7 @@ class ApiTest extends FixtureTest
}
/**
* Test the api_login() function without any login.
* Test the BasicAuth::getCurrentUserID() function without any login.
*
* @runInSeparateProcess
* @preserveGlobalState disabled
@ -307,11 +309,11 @@ class ApiTest extends FixtureTest
public function testApiLoginWithoutLogin()
{
$this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
api_login($this->app);
BasicAuth::getCurrentUserID(true);
}
/**
* Test the api_login() function with a bad login.
* Test the BasicAuth::getCurrentUserID() function with a bad login.
*
* @runInSeparateProcess
* @preserveGlobalState disabled
@ -321,11 +323,11 @@ class ApiTest extends FixtureTest
{
$this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
$_SERVER['PHP_AUTH_USER'] = 'user@server';
api_login($this->app);
BasicAuth::getCurrentUserID(true);
}
/**
* Test the api_login() function with oAuth.
* Test the BasicAuth::getCurrentUserID() function with oAuth.
*
* @return void
*/
@ -335,7 +337,7 @@ class ApiTest extends FixtureTest
}
/**
* Test the api_login() function with authentication provided by an addon.
* Test the BasicAuth::getCurrentUserID() function with authentication provided by an addon.
*
* @return void
*/
@ -345,7 +347,7 @@ class ApiTest extends FixtureTest
}
/**
* Test the api_login() function with a correct login.
* Test the BasicAuth::getCurrentUserID() function with a correct login.
*
* @runInSeparateProcess
* @preserveGlobalState disabled
@ -355,11 +357,11 @@ class ApiTest extends FixtureTest
{
$_SERVER['PHP_AUTH_USER'] = 'Test user';
$_SERVER['PHP_AUTH_PW'] = 'password';
api_login($this->app);
BasicAuth::getCurrentUserID(true);
}
/**
* Test the api_login() function with a remote user.
* Test the BasicAuth::getCurrentUserID() function with a remote user.
*
* @runInSeparateProcess
* @preserveGlobalState disabled
@ -368,7 +370,7 @@ class ApiTest extends FixtureTest
{
$this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
$_SERVER['REDIRECT_REMOTE_USER'] = '123456dXNlcjpwYXNzd29yZA==';
api_login($this->app);
BasicAuth::getCurrentUserID(true);
}
/**
@ -799,7 +801,7 @@ class ApiTest extends FixtureTest
*/
public function testApiGetUser()
{
$user = api_get_user($this->app);
$user = api_get_user();
self::assertSelfUser($user);
self::assertEquals('708fa0', $user['profile_sidebar_fill_color']);
self::assertEquals('6fdbe8', $user['profile_link_color']);
@ -815,7 +817,7 @@ class ApiTest extends FixtureTest
{
$pConfig = $this->dice->create(IManagePersonalConfigValues::class);
$pConfig->set($this->selfUser['id'], 'frio', 'schema', 'red');
$user = api_get_user($this->app);
$user = api_get_user();
self::assertSelfUser($user);
self::assertEquals('708fa0', $user['profile_sidebar_fill_color']);
self::assertEquals('6fdbe8', $user['profile_link_color']);
@ -831,7 +833,7 @@ class ApiTest extends FixtureTest
{
$pConfig = $this->dice->create(IManagePersonalConfigValues::class);
$pConfig->set($this->selfUser['id'], 'frio', 'schema', '---');
$user = api_get_user($this->app);
$user = api_get_user();
self::assertSelfUser($user);
self::assertEquals('708fa0', $user['profile_sidebar_fill_color']);
self::assertEquals('6fdbe8', $user['profile_link_color']);
@ -850,7 +852,7 @@ class ApiTest extends FixtureTest
$pConfig->set($this->selfUser['id'], 'frio', 'nav_bg', '#123456');
$pConfig->set($this->selfUser['id'], 'frio', 'link_color', '#123456');
$pConfig->set($this->selfUser['id'], 'frio', 'background_color', '#123456');
$user = api_get_user($this->app);
$user = api_get_user();
self::assertSelfUser($user);
self::assertEquals('123456', $user['profile_sidebar_fill_color']);
self::assertEquals('123456', $user['profile_link_color']);
@ -868,7 +870,7 @@ class ApiTest extends FixtureTest
$_SERVER['PHP_AUTH_USER'] = 'Test user';
$_SERVER['PHP_AUTH_PW'] = 'password';
$_SESSION['allow_api'] = false;
self::assertFalse(api_get_user($this->app));
self::assertFalse(api_get_user());
}
/**
@ -879,7 +881,7 @@ class ApiTest extends FixtureTest
public function testApiGetUserWithGetId()
{
$_GET['user_id'] = $this->otherUser['id'];
self::assertOtherUser(api_get_user($this->app));
self::assertOtherUser(api_get_user());
}
/**
@ -891,7 +893,7 @@ class ApiTest extends FixtureTest
{
$this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
$_GET['user_id'] = $this->wrongUserId;
self::assertOtherUser(api_get_user($this->app));
self::assertOtherUser(api_get_user());
}
/**
@ -902,7 +904,7 @@ class ApiTest extends FixtureTest
public function testApiGetUserWithGetName()
{
$_GET['screen_name'] = $this->selfUser['nick'];
self::assertSelfUser(api_get_user($this->app));
self::assertSelfUser(api_get_user());
}
/**
@ -913,7 +915,7 @@ class ApiTest extends FixtureTest
public function testApiGetUserWithGetUrl()
{
$_GET['profileurl'] = $this->selfUser['nurl'];
self::assertSelfUser(api_get_user($this->app));
self::assertSelfUser(api_get_user());
}
/**
@ -926,7 +928,7 @@ class ApiTest extends FixtureTest
global $called_api;
$called_api = ['api_path'];
DI::args()->setArgv(['', $this->otherUser['id'] . '.json']);
self::assertOtherUser(api_get_user($this->app));
self::assertOtherUser(api_get_user());
}
/**
@ -938,7 +940,7 @@ class ApiTest extends FixtureTest
{
global $called_api;
$called_api = ['api', 'api_path'];
self::assertSelfUser(api_get_user($this->app));
self::assertSelfUser(api_get_user());
}
/**
@ -948,7 +950,7 @@ class ApiTest extends FixtureTest
*/
public function testApiGetUserWithCorrectUser()
{
self::assertOtherUser(api_get_user($this->app, $this->otherUser['id']));
self::assertOtherUser(api_get_user($this->otherUser['id']));
}
/**
@ -959,7 +961,7 @@ class ApiTest extends FixtureTest
public function testApiGetUserWithWrongUser()
{
$this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
self::assertOtherUser(api_get_user($this->app, $this->wrongUserId));
self::assertOtherUser(api_get_user($this->wrongUserId));
}
/**
@ -969,7 +971,7 @@ class ApiTest extends FixtureTest
*/
public function testApiGetUserWithZeroUser()
{
self::assertSelfUser(api_get_user($this->app, 0));
self::assertSelfUser(api_get_user(0));
}
/**
@ -996,7 +998,7 @@ class ApiTest extends FixtureTest
}
/**
* Test the api_walk_recursive() function.
* Test the BaseApi::walkRecursive() function.
*
* @return void
*/
@ -1005,7 +1007,7 @@ class ApiTest extends FixtureTest
$array = ['item1'];
self::assertEquals(
$array,
api_walk_recursive(
BaseApi::walkRecursive(
$array,
function () {
// Should we test this with a callback that actually does something?
@ -1016,7 +1018,7 @@ class ApiTest extends FixtureTest
}
/**
* Test the api_walk_recursive() function with an array.
* Test the BaseApi::walkRecursive() function with an array.
*
* @return void
*/
@ -1025,7 +1027,7 @@ class ApiTest extends FixtureTest
$array = [['item1'], ['item2']];
self::assertEquals(
$array,
api_walk_recursive(
BaseApi::walkRecursive(
$array,
function () {
// Should we test this with a callback that actually does something?
@ -1036,7 +1038,7 @@ class ApiTest extends FixtureTest
}
/**
* Test the api_reformat_xml() function.
* Test the BaseApi::reformatXML() function.
*
* @return void
*/
@ -1044,12 +1046,12 @@ class ApiTest extends FixtureTest
{
$item = true;
$key = '';
self::assertTrue(api_reformat_xml($item, $key));
self::assertTrue(BaseApi::reformatXML($item, $key));
self::assertEquals('true', $item);
}
/**
* Test the api_reformat_xml() function with a statusnet_api key.
* Test the BaseApi::reformatXML() function with a statusnet_api key.
*
* @return void
*/
@ -1057,12 +1059,12 @@ class ApiTest extends FixtureTest
{
$item = '';
$key = 'statusnet_api';
self::assertTrue(api_reformat_xml($item, $key));
self::assertTrue(BaseApi::reformatXML($item, $key));
self::assertEquals('statusnet:api', $key);
}
/**
* Test the api_reformat_xml() function with a friendica_api key.
* Test the BaseApi::reformatXML() function with a friendica_api key.
*
* @return void
*/
@ -1070,12 +1072,12 @@ class ApiTest extends FixtureTest
{
$item = '';
$key = 'friendica_api';
self::assertTrue(api_reformat_xml($item, $key));
self::assertTrue(BaseApi::reformatXML($item, $key));
self::assertEquals('friendica:api', $key);
}
/**
* Test the api_create_xml() function.
* Test the BaseApi::createXML() function.
*
* @return void
*/
@ -1088,12 +1090,12 @@ class ApiTest extends FixtureTest
'xmlns:georss="http://www.georss.org/georss">' . "\n" .
' <data>some_data</data>' . "\n" .
'</root_element>' . "\n",
api_create_xml(['data' => ['some_data']], 'root_element')
BaseApi::createXML(['data' => ['some_data']], 'root_element')
);
}
/**
* Test the api_create_xml() function without any XML namespace.
* Test the BaseApi::createXML() function without any XML namespace.
*
* @return void
*/
@ -1104,23 +1106,23 @@ class ApiTest extends FixtureTest
'<ok>' . "\n" .
' <data>some_data</data>' . "\n" .
'</ok>' . "\n",
api_create_xml(['data' => ['some_data']], 'ok')
BaseApi::createXML(['data' => ['some_data']], 'ok')
);
}
/**
* Test the api_format_data() function.
* Test the BaseApi::formatData() function.
*
* @return void
*/
public function testApiFormatData()
{
$data = ['some_data'];
self::assertEquals($data, api_format_data('root_element', 'json', $data));
self::assertEquals($data, BaseApi::formatData('root_element', 'json', $data));
}
/**
* Test the api_format_data() function with an XML result.
* Test the BaseApi::formatData() function with an XML result.
*
* @return void
*/
@ -1133,7 +1135,7 @@ class ApiTest extends FixtureTest
'xmlns:georss="http://www.georss.org/georss">' . "\n" .
' <data>some_data</data>' . "\n" .
'</root_element>' . "\n",
api_format_data('root_element', 'xml', ['data' => ['some_data']])
BaseApi::formatData('root_element', 'xml', ['data' => ['some_data']])
);
}
@ -2546,8 +2548,9 @@ class ApiTest extends FixtureTest
*/
public function testApiHelpTest()
{
$result = api_help_test('json');
self::assertEquals(['ok' => 'ok'], $result);
// @todo How to test the new API?
// $result = api_help_test('json');
// self::assertEquals(['ok' => 'ok'], $result);
}
/**
@ -2557,8 +2560,9 @@ class ApiTest extends FixtureTest
*/
public function testApiHelpTestWithXml()
{
$result = api_help_test('xml');
self::assertXml($result, 'ok');
// @todo How to test the new API?
// $result = api_help_test('xml');
// self::assertXml($result, 'ok');
}
/**
@ -2819,8 +2823,9 @@ class ApiTest extends FixtureTest
*/
public function testApiStatusnetVersion()
{
$result = api_statusnet_version('json');
self::assertEquals('0.9.7', $result['version']);
// @todo How to test the new API?
// $result = api_statusnet_version('json');
// self::assertEquals('0.9.7', $result['version']);
}
/**