6 namespace Friendica\Test\legacy;
9 use Friendica\Core\Config\Capability\IManageConfigValues;
10 use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues;
11 use Friendica\Core\Protocol;
13 use Friendica\Model\Post;
14 use Friendica\Module\Api\ApiResponse;
15 use Friendica\Module\BaseApi;
16 use Friendica\Network\HTTPException;
17 use Friendica\Security\BasicAuth;
18 use Friendica\Test\FixtureTest;
19 use Friendica\Util\Arrays;
20 use Friendica\Util\DateTimeFormat;
21 use Friendica\Util\Temporal;
22 use Monolog\Handler\TestHandler;
24 require_once __DIR__ . '/../../include/api.php';
27 * Tests for the API functions.
29 * Functions that use header() need to be tested in a separate process.
30 * @see https://phpunit.de/manual/5.7/en/appendixes.annotations.html#appendixes.annotations.runTestsInSeparateProcesses
32 * @backupGlobals enabled
34 class ApiTest extends FixtureTest
37 * @var TestHandler Can handle log-outputs
44 protected $friendUser;
48 protected $wrongUserId;
53 /** @var IManageConfigValues */
57 * Create variables used by tests.
59 protected function setUp() : void
61 global $API, $called_api;
67 /** @var IManageConfigValues $config */
68 $this->config = $this->dice->create(IManageConfigValues::class);
70 $this->config->set('system', 'url', 'http://localhost');
71 $this->config->set('system', 'hostname', 'localhost');
72 $this->config->set('system', 'worker_dont_fork', true);
75 $this->config->set('config', 'hostname', 'localhost');
76 $this->config->set('system', 'throttle_limit_day', 100);
77 $this->config->set('system', 'throttle_limit_week', 100);
78 $this->config->set('system', 'throttle_limit_month', 100);
79 $this->config->set('system', 'theme', 'system_theme');
83 $this->app = DI::app();
85 DI::args()->setArgc(1);
87 // User data that the test database is populated with
90 'name' => 'Self contact',
91 'nick' => 'selfcontact',
92 'nurl' => 'http://localhost/profile/selfcontact'
96 'name' => 'Friend contact',
97 'nick' => 'friendcontact',
98 'nurl' => 'http://localhost/profile/friendcontact'
102 'name' => 'othercontact',
103 'nick' => 'othercontact',
104 'nurl' => 'http://localhost/profile/othercontact'
107 // User ID that we know is not in the database
108 $this->wrongUserId = 666;
110 DI::session()->start();
112 // Most API require login so we force the session
114 'authenticated' => true,
115 'uid' => $this->selfUser['id']
117 BasicAuth::setCurrentUserID($this->selfUser['id']);
121 * Assert that an user array contains expected keys.
123 * @param array $user User array
127 private function assertSelfUser(array $user)
129 self::assertEquals($this->selfUser['id'], $user['uid']);
130 self::assertEquals($this->selfUser['id'], $user['cid']);
131 self::assertEquals(1, $user['self']);
132 self::assertEquals('DFRN', $user['location']);
133 self::assertEquals($this->selfUser['name'], $user['name']);
134 self::assertEquals($this->selfUser['nick'], $user['screen_name']);
135 self::assertEquals('dfrn', $user['network']);
136 self::assertTrue($user['verified']);
140 * Assert that an user array contains expected keys.
142 * @param array $user User array
146 private function assertOtherUser(array $user = [])
148 self::assertEquals($this->otherUser['id'], $user['id']);
149 self::assertEquals($this->otherUser['id'], $user['id_str']);
150 self::assertEquals($this->otherUser['name'], $user['name']);
151 self::assertEquals($this->otherUser['nick'], $user['screen_name']);
152 self::assertFalse($user['verified']);
156 * Assert that a status array contains expected keys.
158 * @param array $status Status array
162 private function assertStatus(array $status = [])
164 self::assertIsString($status['text'] ?? '');
165 self::assertIsInt($status['id'] ?? '');
166 // We could probably do more checks here.
170 * Assert that a list array contains expected keys.
172 * @param array $list List array
176 private function assertList(array $list = [])
178 self::assertIsString($list['name']);
179 self::assertIsInt($list['id']);
180 self::assertIsString('string', $list['id_str']);
181 self::assertContains($list['mode'], ['public', 'private']);
182 // We could probably do more checks here.
186 * Assert that the string is XML and contain the root element.
188 * @param string $result XML string
189 * @param string $root_element Root element name
193 private function assertXml($result = '', $root_element = '')
195 self::assertStringStartsWith('<?xml version="1.0"?>', $result);
196 self::assertStringContainsString('<' . $root_element, $result);
197 // We could probably do more checks here.
201 * Get the path to a temporary empty PNG image.
203 * @return string Path
205 private function getTempImage()
207 $tmpFile = tempnam(sys_get_temp_dir(), 'tmp_file');
211 // Empty 1x1 px PNG image
212 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8/5+hHgAHggJ/PchI7wAAAABJRU5ErkJggg=='
220 * Test the api_user() function.
224 public function testApiUser()
226 self::assertEquals($this->selfUser['id'], BaseApi::getCurrentUserID());
230 * Test the api_user() function with an unallowed user.
234 public function testApiUserWithUnallowedUser()
236 // self::assertEquals(false, api_user());
240 * Test the api_source() function.
244 public function testApiSource()
246 self::assertEquals('api', BasicAuth::getCurrentApplicationToken()['name']);
250 * Test the api_source() function with a Twidere user agent.
254 public function testApiSourceWithTwidere()
256 $_SERVER['HTTP_USER_AGENT'] = 'Twidere';
257 self::assertEquals('Twidere', BasicAuth::getCurrentApplicationToken()['name']);
261 * Test the api_source() function with a GET parameter.
265 public function testApiSourceWithGet()
267 $_REQUEST['source'] = 'source_name';
268 self::assertEquals('source_name', BasicAuth::getCurrentApplicationToken()['name']);
272 * Test the api_date() function.
276 public function testApiDate()
278 self::assertEquals('Wed Oct 10 00:00:00 +0000 1990', DateTimeFormat::utc('1990-10-10', DateTimeFormat::API));
282 * Test the api_register_func() function.
286 public function testApiRegisterFunc()
298 self::assertTrue($API['api_path']['auth']);
299 self::assertEquals('method', $API['api_path']['method']);
300 self::assertTrue(is_callable($API['api_path']['func']));
304 * Test the BasicAuth::getCurrentUserID() function without any login.
306 * @runInSeparateProcess
307 * @preserveGlobalState disabled
308 * @preserveGlobalState disabled
310 public function testApiLoginWithoutLogin()
312 BasicAuth::setCurrentUserID();
313 $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
314 BasicAuth::getCurrentUserID(true);
318 * Test the BasicAuth::getCurrentUserID() function with a bad login.
320 * @runInSeparateProcess
321 * @preserveGlobalState disabled
322 * @preserveGlobalState disabled
324 public function testApiLoginWithBadLogin()
326 BasicAuth::setCurrentUserID();
327 $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
328 $_SERVER['PHP_AUTH_USER'] = 'user@server';
329 BasicAuth::getCurrentUserID(true);
333 * Test the BasicAuth::getCurrentUserID() function with oAuth.
337 public function testApiLoginWithOauth()
339 $this->markTestIncomplete('Can we test this easily?');
343 * Test the BasicAuth::getCurrentUserID() function with authentication provided by an addon.
347 public function testApiLoginWithAddonAuth()
349 $this->markTestIncomplete('Can we test this easily?');
353 * Test the BasicAuth::getCurrentUserID() function with a correct login.
355 * @runInSeparateProcess
356 * @preserveGlobalState disabled
357 * @doesNotPerformAssertions
359 public function testApiLoginWithCorrectLogin()
361 BasicAuth::setCurrentUserID();
362 $_SERVER['PHP_AUTH_USER'] = 'Test user';
363 $_SERVER['PHP_AUTH_PW'] = 'password';
364 BasicAuth::getCurrentUserID(true);
368 * Test the BasicAuth::getCurrentUserID() function with a remote user.
370 * @runInSeparateProcess
371 * @preserveGlobalState disabled
373 public function testApiLoginWithRemoteUser()
375 BasicAuth::setCurrentUserID();
376 $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
377 $_SERVER['REDIRECT_REMOTE_USER'] = '123456dXNlcjpwYXNzd29yZA==';
378 BasicAuth::getCurrentUserID(true);
382 * Test the api_call() function.
384 * @runInSeparateProcess
385 * @preserveGlobalState disabled
387 public function testApiCall()
391 'method' => 'method',
392 'func' => function () {
393 return ['data' => ['some_data']];
396 $_SERVER['REQUEST_METHOD'] = 'method';
397 $_SERVER['QUERY_STRING'] = 'pagename=api_path';
398 $_GET['callback'] = 'callback_name';
400 $args = DI::args()->determine($_SERVER, $_GET);
403 'callback_name(["some_data"])',
404 api_call($this->app, $args)
409 * Test the api_call() function with the profiled enabled.
411 * @runInSeparateProcess
412 * @preserveGlobalState disabled
414 public function testApiCallWithProfiler()
418 'method' => 'method',
419 'func' => function () {
420 return ['data' => ['some_data']];
424 $_SERVER['REQUEST_METHOD'] = 'method';
425 $_SERVER['QUERY_STRING'] = 'pagename=api_path';
427 $args = DI::args()->determine($_SERVER, $_GET);
429 $this->config->set('system', 'profiler', true);
430 $this->config->set('rendertime', 'callstack', true);
431 $this->app->callstack = [
432 'database' => ['some_function' => 200],
433 'database_write' => ['some_function' => 200],
434 'cache' => ['some_function' => 200],
435 'cache_write' => ['some_function' => 200],
436 'network' => ['some_function' => 200]
441 api_call($this->app, $args)
446 * Test the api_call() function with a JSON result.
448 * @runInSeparateProcess
449 * @preserveGlobalState disabled
451 public function testApiCallWithJson()
455 'method' => 'method',
456 'func' => function () {
457 return ['data' => ['some_data']];
460 $_SERVER['REQUEST_METHOD'] = 'method';
461 $_SERVER['QUERY_STRING'] = 'pagename=api_path.json';
463 $args = DI::args()->determine($_SERVER, $_GET);
467 api_call($this->app, $args)
472 * Test the api_call() function with an XML result.
474 * @runInSeparateProcess
475 * @preserveGlobalState disabled
477 public function testApiCallWithXml()
481 'method' => 'method',
482 'func' => function () {
486 $_SERVER['REQUEST_METHOD'] = 'method';
487 $_SERVER['QUERY_STRING'] = 'pagename=api_path.xml';
489 $args = DI::args()->determine($_SERVER, $_GET);
493 api_call($this->app, $args)
498 * Test the api_call() function with an RSS result.
500 * @runInSeparateProcess
501 * @preserveGlobalState disabled
503 public function testApiCallWithRss()
507 'method' => 'method',
508 'func' => function () {
512 $_SERVER['REQUEST_METHOD'] = 'method';
513 $_SERVER['QUERY_STRING'] = 'pagename=api_path.rss';
515 $args = DI::args()->determine($_SERVER, $_GET);
518 '<?xml version="1.0" encoding="UTF-8"?>' . "\n" .
520 api_call($this->app, $args)
525 * Test the api_call() function with an Atom result.
527 * @runInSeparateProcess
528 * @preserveGlobalState disabled
530 public function testApiCallWithAtom()
534 'method' => 'method',
535 'func' => function () {
539 $_SERVER['REQUEST_METHOD'] = 'method';
540 $_SERVER['QUERY_STRING'] = 'pagename=api_path.atom';
542 $args = DI::args()->determine($_SERVER, $_GET);
545 '<?xml version="1.0" encoding="UTF-8"?>' . "\n" .
547 api_call($this->app, $args)
552 * Test the api_rss_extra() function.
556 public function testApiRssExtra()
559 $user_info = ['url' => 'user_url', 'lang' => 'en'];
560 $result = api_rss_extra([], $user_info);
561 self::assertEquals($user_info, $result['$user']);
562 self::assertEquals($user_info['url'], $result['$rss']['alternate']);
563 self::assertArrayHasKey('self', $result['$rss']);
564 self::assertArrayHasKey('base', $result['$rss']);
565 self::assertArrayHasKey('updated', $result['$rss']);
566 self::assertArrayHasKey('atom_updated', $result['$rss']);
567 self::assertArrayHasKey('language', $result['$rss']);
568 self::assertArrayHasKey('logo', $result['$rss']);
573 * Test the api_rss_extra() function without any user info.
577 public function testApiRssExtraWithoutUserInfo()
580 $result = api_rss_extra([], null);
581 self::assertIsArray($result['$user']);
582 self::assertArrayHasKey('alternate', $result['$rss']);
583 self::assertArrayHasKey('self', $result['$rss']);
584 self::assertArrayHasKey('base', $result['$rss']);
585 self::assertArrayHasKey('updated', $result['$rss']);
586 self::assertArrayHasKey('atom_updated', $result['$rss']);
587 self::assertArrayHasKey('language', $result['$rss']);
588 self::assertArrayHasKey('logo', $result['$rss']);
593 * Test the api_get_user() function.
597 public function testApiGetUser()
599 // $user = api_get_user();
600 // self::assertSelfUser($user);
601 // self::assertEquals('708fa0', $user['profile_sidebar_fill_color']);
602 // self::assertEquals('6fdbe8', $user['profile_link_color']);
603 // self::assertEquals('ededed', $user['profile_background_color']);
607 * Test the api_get_user() function with a Frio schema.
611 public function testApiGetUserWithFrioSchema()
613 // $pConfig = $this->dice->create(IManagePersonalConfigValues::class);
614 // $pConfig->set($this->selfUser['id'], 'frio', 'schema', 'red');
615 // $user = api_get_user();
616 // self::assertSelfUser($user);
617 // self::assertEquals('708fa0', $user['profile_sidebar_fill_color']);
618 // self::assertEquals('6fdbe8', $user['profile_link_color']);
619 // self::assertEquals('ededed', $user['profile_background_color']);
623 * Test the api_get_user() function with an empty Frio schema.
627 public function testApiGetUserWithEmptyFrioSchema()
629 // $pConfig = $this->dice->create(IManagePersonalConfigValues::class);
630 // $pConfig->set($this->selfUser['id'], 'frio', 'schema', '---');
631 // $user = api_get_user();
632 // self::assertSelfUser($user);
633 // self::assertEquals('708fa0', $user['profile_sidebar_fill_color']);
634 // self::assertEquals('6fdbe8', $user['profile_link_color']);
635 // self::assertEquals('ededed', $user['profile_background_color']);
639 * Test the api_get_user() function with a custom Frio schema.
643 public function testApiGetUserWithCustomFrioSchema()
645 // $pConfig = $this->dice->create(IManagePersonalConfigValues::class);
646 // $pConfig->set($this->selfUser['id'], 'frio', 'schema', '---');
647 // $pConfig->set($this->selfUser['id'], 'frio', 'nav_bg', '#123456');
648 // $pConfig->set($this->selfUser['id'], 'frio', 'link_color', '#123456');
649 // $pConfig->set($this->selfUser['id'], 'frio', 'background_color', '#123456');
650 // $user = api_get_user();
651 // self::assertSelfUser($user);
652 // self::assertEquals('123456', $user['profile_sidebar_fill_color']);
653 // self::assertEquals('123456', $user['profile_link_color']);
654 // self::assertEquals('123456', $user['profile_background_color']);
658 * Test the api_get_user() function with an user that is not allowed to use the API.
660 * @runInSeparateProcess
661 * @preserveGlobalState disabled
663 public function testApiGetUserWithoutApiUser()
665 // api_get_user() with empty parameters is not used anymore
667 $_SERVER['PHP_AUTH_USER'] = 'Test user';
668 $_SERVER['PHP_AUTH_PW'] = 'password';
669 BasicAuth::setCurrentUserID();
670 self::assertFalse(api_get_user());
675 * Test the api_get_user() function with an user ID in a GET parameter.
679 public function testApiGetUserWithGetId()
681 // self::assertOtherUser(api_get_user());
685 * Test the api_get_user() function with a wrong user ID in a GET parameter.
689 public function testApiGetUserWithWrongGetId()
691 // $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
692 // self::assertOtherUser(api_get_user());
696 * Test the api_get_user() function with an user name in a GET parameter.
700 public function testApiGetUserWithGetName()
702 // self::assertSelfUser(api_get_user());
706 * Test the api_get_user() function with a profile URL in a GET parameter.
710 public function testApiGetUserWithGetUrl()
712 // self::assertSelfUser(api_get_user());
716 * Test the api_get_user() function with an user ID in the API path.
720 public function testApiGetUserWithNumericCalledApi()
722 // global $called_api;
723 // $called_api = ['api_path'];
724 // DI::args()->setArgv(['', $this->otherUser['id'] . '.json']);
725 // self::assertOtherUser(api_get_user());
729 * Test the api_get_user() function with the $called_api global variable.
733 public function testApiGetUserWithCalledApi()
735 // global $called_api;
736 // $called_api = ['api', 'api_path'];
737 // self::assertSelfUser(api_get_user());
741 * Test the Arrays::walkRecursive() function.
745 public function testApiWalkRecursive()
750 Arrays::walkRecursive(
753 // Should we test this with a callback that actually does something?
761 * Test the Arrays::walkRecursive() function with an array.
765 public function testApiWalkRecursiveWithArray()
767 $array = [['item1'], ['item2']];
770 Arrays::walkRecursive(
773 // Should we test this with a callback that actually does something?
781 * Test the BaseApi::reformatXML() function.
785 public function testApiReformatXml()
789 self::assertTrue(ApiResponse::reformatXML($item, $key));
790 self::assertEquals('true', $item);
794 * Test the BaseApi::reformatXML() function with a statusnet_api key.
798 public function testApiReformatXmlWithStatusnetKey()
801 $key = 'statusnet_api';
802 self::assertTrue(ApiResponse::reformatXML($item, $key));
803 self::assertEquals('statusnet:api', $key);
807 * Test the BaseApi::reformatXML() function with a friendica_api key.
811 public function testApiReformatXmlWithFriendicaKey()
814 $key = 'friendica_api';
815 self::assertTrue(ApiResponse::reformatXML($item, $key));
816 self::assertEquals('friendica:api', $key);
820 * Test the BaseApi::createXML() function.
824 public function testApiCreateXml()
827 '<?xml version="1.0"?>' . "\n" .
828 '<root_element xmlns="http://api.twitter.com" xmlns:statusnet="http://status.net/schema/api/1/" ' .
829 'xmlns:friendica="http://friendi.ca/schema/api/1/" ' .
830 'xmlns:georss="http://www.georss.org/georss">' . "\n" .
831 ' <data>some_data</data>' . "\n" .
832 '</root_element>' . "\n",
833 DI::apiResponse()->createXML(['data' => ['some_data']], 'root_element')
838 * Test the BaseApi::createXML() function without any XML namespace.
842 public function testApiCreateXmlWithoutNamespaces()
845 '<?xml version="1.0"?>' . "\n" .
847 ' <data>some_data</data>' . "\n" .
849 DI::apiResponse()->createXML(['data' => ['some_data']], 'ok')
854 * Test the BaseApi::formatData() function.
858 public function testApiFormatData()
860 $data = ['some_data'];
861 self::assertEquals($data, DI::apiResponse()->formatData('root_element', 'json', $data));
865 * Test the BaseApi::formatData() function with an XML result.
869 public function testApiFormatDataWithXml()
872 '<?xml version="1.0"?>' . "\n" .
873 '<root_element xmlns="http://api.twitter.com" xmlns:statusnet="http://status.net/schema/api/1/" ' .
874 'xmlns:friendica="http://friendi.ca/schema/api/1/" ' .
875 'xmlns:georss="http://www.georss.org/georss">' . "\n" .
876 ' <data>some_data</data>' . "\n" .
877 '</root_element>' . "\n",
878 DI::apiResponse()->formatData('root_element', 'xml', ['data' => ['some_data']])
883 * Test the api_account_verify_credentials() function.
887 public function testApiAccountVerifyCredentials()
889 // self::assertArrayHasKey('user', api_account_verify_credentials('json'));
893 * Test the api_account_verify_credentials() function without an authenticated user.
897 public function testApiAccountVerifyCredentialsWithoutAuthenticatedUser()
899 // $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
900 // BasicAuth::setCurrentUserID();
901 // $_SESSION['authenticated'] = false;
902 // api_account_verify_credentials('json');
906 * Test the api_statuses_mediap() function.
910 public function testApiStatusesMediap()
912 DI::args()->setArgc(2);
920 'tmp_name' => $this->getTempImage(),
921 'name' => 'spacer.png',
922 'type' => 'image/png'
925 $_GET['status'] = '<b>Status content</b>';
927 $result = api_statuses_mediap('json');
928 self::assertStatus($result['status']);
932 * Test the api_statuses_mediap() function without an authenticated user.
936 public function testApiStatusesMediapWithoutAuthenticatedUser()
938 $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
939 BasicAuth::setCurrentUserID();
940 $_SESSION['authenticated'] = false;
941 api_statuses_mediap('json');
945 * Test the api_statuses_update() function.
949 public function testApiStatusesUpdate()
951 $_GET['status'] = 'Status content #friendica';
952 $_GET['in_reply_to_status_id'] = -1;
961 'tmp_name' => $this->getTempImage(),
962 'name' => 'spacer.png',
963 'type' => 'image/png'
967 $result = api_statuses_update('json');
968 self::assertStatus($result['status']);
972 * Test the api_statuses_update() function with an HTML status.
976 public function testApiStatusesUpdateWithHtml()
978 $_GET['htmlstatus'] = '<b>Status content</b>';
980 $result = api_statuses_update('json');
981 self::assertStatus($result['status']);
985 * Test the api_statuses_update() function without an authenticated user.
989 public function testApiStatusesUpdateWithoutAuthenticatedUser()
991 $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
992 BasicAuth::setCurrentUserID();
993 $_SESSION['authenticated'] = false;
994 api_statuses_update('json');
998 * Test the api_statuses_update() function with a parent status.
1002 public function testApiStatusesUpdateWithParent()
1004 $this->markTestIncomplete('This triggers an exit() somewhere and kills PHPUnit.');
1008 * Test the api_statuses_update() function with a media_ids parameter.
1012 public function testApiStatusesUpdateWithMediaIds()
1014 $this->markTestIncomplete();
1018 * Test the api_statuses_update() function with the throttle limit reached.
1022 public function testApiStatusesUpdateWithDayThrottleReached()
1024 $this->markTestIncomplete();
1028 * Test the api_media_upload() function.
1029 * @runInSeparateProcess
1030 * @preserveGlobalState disabled
1032 public function testApiMediaUpload()
1034 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
1039 * Test the api_media_upload() function without an authenticated user.
1043 public function testApiMediaUploadWithoutAuthenticatedUser()
1045 $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
1046 BasicAuth::setCurrentUserID();
1047 $_SESSION['authenticated'] = false;
1052 * Test the api_media_upload() function with an invalid uploaded media.
1056 public function testApiMediaUploadWithMedia()
1058 $this->expectException(\Friendica\Network\HTTPException\InternalServerErrorException::class);
1062 'tmp_name' => 'tmp_name'
1069 * Test the api_media_upload() function with an valid uploaded media.
1073 public function testApiMediaUploadWithValidMedia()
1081 'tmp_name' => $this->getTempImage(),
1082 'name' => 'spacer.png',
1083 'type' => 'image/png'
1087 DI::args()->setArgc(2);
1089 $result = api_media_upload();
1090 self::assertEquals('image/png', $result['media']['image']['image_type']);
1091 self::assertEquals(1, $result['media']['image']['w']);
1092 self::assertEquals(1, $result['media']['image']['h']);
1093 self::assertNotEmpty($result['media']['image']['friendica_preview_url']);
1097 * Test the api_status_show() function.
1099 public function testApiStatusShowWithJson()
1101 // $result = api_status_show('json', 1);
1102 // self::assertStatus($result['status']);
1106 * Test the api_status_show() function with an XML result.
1108 public function testApiStatusShowWithXml()
1110 // $result = api_status_show('xml', 1);
1111 // self::assertXml($result, 'statuses');
1115 * Test the api_get_last_status() function
1117 public function testApiGetLastStatus()
1119 // $item = api_get_last_status($this->selfUser['id'], $this->selfUser['id']);
1120 // self::assertNotNull($item);
1124 * Test the api_users_show() function.
1128 public function testApiUsersShow()
1130 $result = api_users_show('json');
1131 // We can't use assertSelfUser() here because the user object is missing some properties.
1132 self::assertEquals($this->selfUser['id'], $result['user']['cid']);
1133 self::assertEquals('DFRN', $result['user']['location']);
1134 self::assertEquals($this->selfUser['name'], $result['user']['name']);
1135 self::assertEquals($this->selfUser['nick'], $result['user']['screen_name']);
1136 self::assertTrue($result['user']['verified']);
1140 * Test the api_users_show() function with an XML result.
1144 public function testApiUsersShowWithXml()
1146 $result = api_users_show('xml');
1147 self::assertXml($result, 'statuses');
1151 * Test the api_users_search() function.
1155 public function testApiUsersSearch()
1157 $_GET['q'] = 'othercontact';
1158 $result = api_users_search('json');
1159 self::assertOtherUser($result['users'][0]);
1163 * Test the api_users_search() function with an XML result.
1167 public function testApiUsersSearchWithXml()
1169 $_GET['q'] = 'othercontact';
1170 $result = api_users_search('xml');
1171 self::assertXml($result, 'users');
1175 * Test the api_users_search() function without a GET q parameter.
1179 public function testApiUsersSearchWithoutQuery()
1181 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
1182 api_users_search('json');
1186 * Test the api_users_lookup() function.
1190 public function testApiUsersLookup()
1192 $this->expectException(\Friendica\Network\HTTPException\NotFoundException::class);
1193 api_users_lookup('json');
1197 * Test the api_users_lookup() function with an user ID.
1201 public function testApiUsersLookupWithUserId()
1203 $_REQUEST['user_id'] = $this->otherUser['id'];
1204 $result = api_users_lookup('json');
1205 self::assertOtherUser($result['users'][0]);
1209 * Test the api_search() function.
1213 public function testApiSearch()
1215 $_REQUEST['q'] = 'reply';
1216 $_REQUEST['max_id'] = 10;
1217 $result = api_search('json');
1218 foreach ($result['status'] as $status) {
1219 self::assertStatus($status);
1220 self::assertStringContainsStringIgnoringCase('reply', $status['text'], '', true);
1225 * Test the api_search() function a count parameter.
1229 public function testApiSearchWithCount()
1231 $_REQUEST['q'] = 'reply';
1232 $_REQUEST['count'] = 20;
1233 $result = api_search('json');
1234 foreach ($result['status'] as $status) {
1235 self::assertStatus($status);
1236 self::assertStringContainsStringIgnoringCase('reply', $status['text'], '', true);
1241 * Test the api_search() function with an rpp parameter.
1245 public function testApiSearchWithRpp()
1247 $_REQUEST['q'] = 'reply';
1248 $_REQUEST['rpp'] = 20;
1249 $result = api_search('json');
1250 foreach ($result['status'] as $status) {
1251 self::assertStatus($status);
1252 self::assertStringContainsStringIgnoringCase('reply', $status['text'], '', true);
1257 * Test the api_search() function with an q parameter contains hashtag.
1258 * @doesNotPerformAssertions
1260 public function testApiSearchWithHashtag()
1262 $_REQUEST['q'] = '%23friendica';
1263 $result = api_search('json');
1264 foreach ($result['status'] as $status) {
1265 self::assertStatus($status);
1266 self::assertStringContainsStringIgnoringCase('#friendica', $status['text'], '', true);
1271 * Test the api_search() function with an exclude_replies parameter.
1272 * @doesNotPerformAssertions
1274 public function testApiSearchWithExcludeReplies()
1276 $_REQUEST['max_id'] = 10;
1277 $_REQUEST['exclude_replies'] = true;
1278 $_REQUEST['q'] = 'friendica';
1279 $result = api_search('json');
1280 foreach ($result['status'] as $status) {
1281 self::assertStatus($status);
1286 * Test the api_search() function without an authenticated user.
1290 public function testApiSearchWithUnallowedUser()
1292 $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
1293 BasicAuth::setCurrentUserID();
1298 * Test the api_search() function without any GET query parameter.
1302 public function testApiSearchWithoutQuery()
1304 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
1309 * Test the api_statuses_home_timeline() function.
1313 public function testApiStatusesHomeTimeline()
1316 $_REQUEST['max_id'] = 10;
1317 $_REQUEST['exclude_replies'] = true;
1318 $_REQUEST['conversation_id'] = 1;
1319 $result = api_statuses_home_timeline('json');
1320 self::assertNotEmpty($result['status']);
1321 foreach ($result['status'] as $status) {
1322 self::assertStatus($status);
1328 * Test the api_statuses_home_timeline() function with a negative page parameter.
1332 public function testApiStatusesHomeTimelineWithNegativePage()
1335 $_REQUEST['page'] = -2;
1336 $result = api_statuses_home_timeline('json');
1337 self::assertNotEmpty($result['status']);
1338 foreach ($result['status'] as $status) {
1339 self::assertStatus($status);
1345 * Test the api_statuses_home_timeline() with an unallowed user.
1349 public function testApiStatusesHomeTimelineWithUnallowedUser()
1352 $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
1353 BasicAuth::setCurrentUserID();
1354 api_statuses_home_timeline('json');
1359 * Test the api_statuses_home_timeline() function with an RSS result.
1363 public function testApiStatusesHomeTimelineWithRss()
1365 // $result = api_statuses_home_timeline('rss');
1366 // self::assertXml($result, 'statuses');
1370 * Test the api_statuses_public_timeline() function.
1374 public function testApiStatusesPublicTimeline()
1377 $_REQUEST['max_id'] = 10;
1378 $_REQUEST['conversation_id'] = 1;
1379 $result = api_statuses_public_timeline('json');
1380 self::assertNotEmpty($result['status']);
1381 foreach ($result['status'] as $status) {
1382 self::assertStatus($status);
1388 * Test the api_statuses_public_timeline() function with the exclude_replies parameter.
1392 public function testApiStatusesPublicTimelineWithExcludeReplies()
1395 $_REQUEST['max_id'] = 10;
1396 $_REQUEST['exclude_replies'] = true;
1397 $result = api_statuses_public_timeline('json');
1398 self::assertNotEmpty($result['status']);
1399 foreach ($result['status'] as $status) {
1400 self::assertStatus($status);
1406 * Test the api_statuses_public_timeline() function with a negative page parameter.
1410 public function testApiStatusesPublicTimelineWithNegativePage()
1413 $_REQUEST['page'] = -2;
1414 $result = api_statuses_public_timeline('json');
1415 self::assertNotEmpty($result['status']);
1416 foreach ($result['status'] as $status) {
1417 self::assertStatus($status);
1423 * Test the api_statuses_public_timeline() function with an unallowed user.
1427 public function testApiStatusesPublicTimelineWithUnallowedUser()
1429 // $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
1430 // BasicAuth::setCurrentUserID();
1431 // api_statuses_public_timeline('json');
1435 * Test the api_statuses_public_timeline() function with an RSS result.
1439 public function testApiStatusesPublicTimelineWithRss()
1441 // $result = api_statuses_public_timeline('rss');
1442 // self::assertXml($result, 'statuses');
1446 * Test the api_statuses_networkpublic_timeline() function.
1450 public function testApiStatusesNetworkpublicTimeline()
1453 $_REQUEST['max_id'] = 10;
1454 $result = api_statuses_networkpublic_timeline('json');
1455 self::assertNotEmpty($result['status']);
1456 foreach ($result['status'] as $status) {
1457 self::assertStatus($status);
1463 * Test the api_statuses_networkpublic_timeline() function with a negative page parameter.
1467 public function testApiStatusesNetworkpublicTimelineWithNegativePage()
1470 $_REQUEST['page'] = -2;
1471 $result = api_statuses_networkpublic_timeline('json');
1472 self::assertNotEmpty($result['status']);
1473 foreach ($result['status'] as $status) {
1474 self::assertStatus($status);
1480 * Test the api_statuses_networkpublic_timeline() function with an unallowed user.
1484 public function testApiStatusesNetworkpublicTimelineWithUnallowedUser()
1486 // $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
1487 // BasicAuth::setCurrentUserID();
1488 // api_statuses_networkpublic_timeline('json');
1492 * Test the api_statuses_networkpublic_timeline() function with an RSS result.
1496 public function testApiStatusesNetworkpublicTimelineWithRss()
1498 // $result = api_statuses_networkpublic_timeline('rss');
1499 // self::assertXml($result, 'statuses');
1503 * Test the api_statuses_show() function.
1507 public function testApiStatusesShow()
1509 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
1510 api_statuses_show('json');
1514 * Test the api_statuses_show() function with an ID.
1518 public function testApiStatusesShowWithId()
1520 DI::args()->setArgv(['', '', '', 1]);
1521 $result = api_statuses_show('json');
1522 self::assertStatus($result['status']);
1526 * Test the api_statuses_show() function with the conversation parameter.
1530 public function testApiStatusesShowWithConversation()
1532 DI::args()->setArgv(['', '', '', 1]);
1533 $_REQUEST['conversation'] = 1;
1534 $result = api_statuses_show('json');
1535 self::assertNotEmpty($result['status']);
1536 foreach ($result['status'] as $status) {
1537 self::assertStatus($status);
1542 * Test the api_statuses_show() function with an unallowed user.
1546 public function testApiStatusesShowWithUnallowedUser()
1548 $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
1549 BasicAuth::setCurrentUserID();
1550 api_statuses_show('json');
1554 * Test the api_conversation_show() function.
1558 public function testApiConversationShow()
1560 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
1561 api_conversation_show('json');
1565 * Test the api_conversation_show() function with an ID.
1569 public function testApiConversationShowWithId()
1571 DI::args()->setArgv(['', '', '', 1]);
1572 $_REQUEST['max_id'] = 10;
1573 $_REQUEST['page'] = -2;
1574 $result = api_conversation_show('json');
1575 self::assertNotEmpty($result['status']);
1576 foreach ($result['status'] as $status) {
1577 self::assertStatus($status);
1582 * Test the api_conversation_show() function with an unallowed user.
1586 public function testApiConversationShowWithUnallowedUser()
1588 $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
1589 BasicAuth::setCurrentUserID();
1590 api_conversation_show('json');
1594 * Test the api_statuses_repeat() function.
1598 public function testApiStatusesRepeat()
1600 $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
1601 api_statuses_repeat('json');
1605 * Test the api_statuses_repeat() function without an authenticated user.
1609 public function testApiStatusesRepeatWithoutAuthenticatedUser()
1611 $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
1612 BasicAuth::setCurrentUserID();
1613 $_SESSION['authenticated'] = false;
1614 api_statuses_repeat('json');
1618 * Test the api_statuses_repeat() function with an ID.
1622 public function testApiStatusesRepeatWithId()
1624 DI::args()->setArgv(['', '', '', 1]);
1625 $result = api_statuses_repeat('json');
1626 self::assertStatus($result['status']);
1628 // Also test with a shared status
1629 DI::args()->setArgv(['', '', '', 5]);
1630 $result = api_statuses_repeat('json');
1631 self::assertStatus($result['status']);
1635 * Test the api_statuses_destroy() function.
1639 public function testApiStatusesDestroy()
1641 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
1642 api_statuses_destroy('json');
1646 * Test the api_statuses_destroy() function without an authenticated user.
1650 public function testApiStatusesDestroyWithoutAuthenticatedUser()
1652 $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
1653 BasicAuth::setCurrentUserID();
1654 $_SESSION['authenticated'] = false;
1655 api_statuses_destroy('json');
1659 * Test the api_statuses_destroy() function with an ID.
1663 public function testApiStatusesDestroyWithId()
1665 DI::args()->setArgv(['', '', '', 1]);
1666 $result = api_statuses_destroy('json');
1667 self::assertStatus($result['status']);
1671 * Test the api_statuses_mentions() function.
1675 public function testApiStatusesMentions()
1678 $this->app->setLoggedInUserNickname($this->selfUser['nick']);
1679 $_REQUEST['max_id'] = 10;
1680 $result = api_statuses_mentions('json');
1681 self::assertEmpty($result['status']);
1682 // We should test with mentions in the database.
1687 * Test the api_statuses_mentions() function with a negative page parameter.
1691 public function testApiStatusesMentionsWithNegativePage()
1693 // $_REQUEST['page'] = -2;
1694 // $result = api_statuses_mentions('json');
1695 // self::assertEmpty($result['status']);
1699 * Test the api_statuses_mentions() function with an unallowed user.
1703 public function testApiStatusesMentionsWithUnallowedUser()
1705 // $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
1706 // BasicAuth::setCurrentUserID();
1707 // api_statuses_mentions('json');
1711 * Test the api_statuses_mentions() function with an RSS result.
1715 public function testApiStatusesMentionsWithRss()
1717 // $result = api_statuses_mentions('rss');
1718 // self::assertXml($result, 'statuses');
1722 * Test the api_statuses_user_timeline() function.
1726 public function testApiStatusesUserTimeline()
1729 $_REQUEST['user_id'] = 42;
1730 $_REQUEST['max_id'] = 10;
1731 $_REQUEST['exclude_replies'] = true;
1732 $_REQUEST['conversation_id'] = 7;
1734 $result = api_statuses_user_timeline('json');
1735 self::assertNotEmpty($result['status']);
1736 foreach ($result['status'] as $status) {
1737 self::assertStatus($status);
1743 * Test the api_statuses_user_timeline() function with a negative page parameter.
1747 public function testApiStatusesUserTimelineWithNegativePage()
1750 $_REQUEST['user_id'] = 42;
1751 $_REQUEST['page'] = -2;
1753 $result = api_statuses_user_timeline('json');
1754 self::assertNotEmpty($result['status']);
1755 foreach ($result['status'] as $status) {
1756 self::assertStatus($status);
1762 * Test the api_statuses_user_timeline() function with an RSS result.
1766 public function testApiStatusesUserTimelineWithRss()
1768 // $result = api_statuses_user_timeline('rss');
1769 // self::assertXml($result, 'statuses');
1773 * Test the api_statuses_user_timeline() function with an unallowed user.
1777 public function testApiStatusesUserTimelineWithUnallowedUser()
1779 // $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
1780 // BasicAuth::setCurrentUserID();
1781 // api_statuses_user_timeline('json');
1785 * Test the api_favorites_create_destroy() function.
1789 public function testApiFavoritesCreateDestroy()
1791 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
1792 DI::args()->setArgv(['api', '1.1', 'favorites', 'create']);
1793 api_favorites_create_destroy('json');
1797 * Test the api_favorites_create_destroy() function with an invalid ID.
1801 public function testApiFavoritesCreateDestroyWithInvalidId()
1803 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
1804 DI::args()->setArgv(['api', '1.1', 'favorites', 'create', '12.json']);
1805 api_favorites_create_destroy('json');
1809 * Test the api_favorites_create_destroy() function with an invalid action.
1813 public function testApiFavoritesCreateDestroyWithInvalidAction()
1815 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
1816 DI::args()->setArgv(['api', '1.1', 'favorites', 'change.json']);
1817 $_REQUEST['id'] = 1;
1818 api_favorites_create_destroy('json');
1822 * Test the api_favorites_create_destroy() function with the create action.
1826 public function testApiFavoritesCreateDestroyWithCreateAction()
1828 DI::args()->setArgv(['api', '1.1', 'favorites', 'create.json']);
1829 $_REQUEST['id'] = 3;
1830 $result = api_favorites_create_destroy('json');
1831 self::assertStatus($result['status']);
1835 * Test the api_favorites_create_destroy() function with the create action and an RSS result.
1839 public function testApiFavoritesCreateDestroyWithCreateActionAndRss()
1841 DI::args()->setArgv(['api', '1.1', 'favorites', 'create.rss']);
1842 $_REQUEST['id'] = 3;
1843 $result = api_favorites_create_destroy('rss');
1844 self::assertXml($result, 'status');
1848 * Test the api_favorites_create_destroy() function with the destroy action.
1852 public function testApiFavoritesCreateDestroyWithDestroyAction()
1854 DI::args()->setArgv(['api', '1.1', 'favorites', 'destroy.json']);
1855 $_REQUEST['id'] = 3;
1856 $result = api_favorites_create_destroy('json');
1857 self::assertStatus($result['status']);
1861 * Test the api_favorites_create_destroy() function without an authenticated user.
1865 public function testApiFavoritesCreateDestroyWithoutAuthenticatedUser()
1867 $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
1868 DI::args()->setArgv(['api', '1.1', 'favorites', 'create.json']);
1869 BasicAuth::setCurrentUserID();
1870 $_SESSION['authenticated'] = false;
1871 api_favorites_create_destroy('json');
1875 * Test the api_favorites() function.
1879 public function testApiFavorites()
1882 $_REQUEST['page'] = -1;
1883 $_REQUEST['max_id'] = 10;
1884 $result = api_favorites('json');
1885 foreach ($result['status'] as $status) {
1886 self::assertStatus($status);
1892 * Test the api_favorites() function with an RSS result.
1896 public function testApiFavoritesWithRss()
1898 // $result = api_favorites('rss');
1899 // self::assertXml($result, 'statuses');
1903 * Test the api_favorites() function with an unallowed user.
1907 public function testApiFavoritesWithUnallowedUser()
1909 // $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
1910 // BasicAuth::setCurrentUserID();
1911 // api_favorites('json');
1915 * Test the api_format_messages() function.
1919 public function testApiFormatMessages()
1921 $result = api_format_messages(
1922 ['id' => 1, 'uri-id' => 1, 'title' => 'item_title', 'body' => '[b]item_body[/b]'],
1923 ['id' => 2, 'uri-id' => 2, 'screen_name' => 'recipient_name'],
1924 ['id' => 3, 'uri-id' => 2, 'screen_name' => 'sender_name']
1926 self::assertEquals('item_title' . "\n" . 'item_body', $result['text']);
1927 self::assertEquals(1, $result['id']);
1928 self::assertEquals(2, $result['recipient_id']);
1929 self::assertEquals(3, $result['sender_id']);
1930 self::assertEquals('recipient_name', $result['recipient_screen_name']);
1931 self::assertEquals('sender_name', $result['sender_screen_name']);
1935 * Test the api_format_messages() function with HTML.
1939 public function testApiFormatMessagesWithHtmlText()
1941 $_GET['getText'] = 'html';
1942 $result = api_format_messages(
1943 ['id' => 1, 'uri-id' => 1, 'title' => 'item_title', 'body' => '[b]item_body[/b]'],
1944 ['id' => 2, 'uri-id' => 2, 'screen_name' => 'recipient_name'],
1945 ['id' => 3, 'uri-id' => 3, 'screen_name' => 'sender_name']
1947 self::assertEquals('item_title', $result['title']);
1948 self::assertEquals('<strong>item_body</strong>', $result['text']);
1952 * Test the api_format_messages() function with plain text.
1956 public function testApiFormatMessagesWithPlainText()
1958 $_GET['getText'] = 'plain';
1959 $result = api_format_messages(
1960 ['id' => 1, 'uri-id' => 1, 'title' => 'item_title', 'body' => '[b]item_body[/b]'],
1961 ['id' => 2, 'uri-id' => 2, 'screen_name' => 'recipient_name'],
1962 ['id' => 3, 'uri-id' => 3, 'screen_name' => 'sender_name']
1964 self::assertEquals('item_title', $result['title']);
1965 self::assertEquals('item_body', $result['text']);
1969 * Test the api_format_messages() function with the getUserObjects GET parameter set to false.
1973 public function testApiFormatMessagesWithoutUserObjects()
1975 $_GET['getUserObjects'] = 'false';
1976 $result = api_format_messages(
1977 ['id' => 1, 'uri-id' => 1, 'title' => 'item_title', 'body' => '[b]item_body[/b]'],
1978 ['id' => 2, 'uri-id' => 2, 'screen_name' => 'recipient_name'],
1979 ['id' => 3, 'uri-id' => 3, 'screen_name' => 'sender_name']
1981 self::assertTrue(!isset($result['sender']));
1982 self::assertTrue(!isset($result['recipient']));
1986 * Test the api_convert_item() function.
1990 public function testApiConvertItem()
1993 $result = api_convert_item(
1995 'network' => 'feed',
1996 'title' => 'item_title',
1998 // We need a long string to test that it is correctly cut
1999 'body' => 'perspiciatis impedit voluptatem quis molestiae ea qui ' .
2000 'reiciendis dolorum aut ducimus sunt consequatur inventore dolor ' .
2001 'officiis pariatur doloremque nemo culpa aut quidem qui dolore ' .
2002 'laudantium atque commodi alias voluptatem non possimus aperiam ' .
2003 'ipsum rerum consequuntur aut amet fugit quia aliquid praesentium ' .
2004 'repellendus quibusdam et et inventore mollitia rerum sit autem ' .
2005 'pariatur maiores ipsum accusantium perferendis vel sit possimus ' .
2006 'veritatis nihil distinctio qui eum repellat officia illum quos ' .
2007 'impedit quam iste esse unde qui suscipit aut facilis ut inventore ' .
2008 'omnis exercitationem quo magnam consequatur maxime aut illum ' .
2009 'soluta quaerat natus unde aspernatur et sed beatae nihil ullam ' .
2010 'temporibus corporis ratione blanditiis perspiciatis impedit ' .
2011 'voluptatem quis molestiae ea qui reiciendis dolorum aut ducimus ' .
2012 'sunt consequatur inventore dolor officiis pariatur doloremque ' .
2013 'nemo culpa aut quidem qui dolore laudantium atque commodi alias ' .
2014 'voluptatem non possimus aperiam ipsum rerum consequuntur aut ' .
2015 'amet fugit quia aliquid praesentium repellendus quibusdam et et ' .
2016 'inventore mollitia rerum sit autem pariatur maiores ipsum accusantium ' .
2017 'perferendis vel sit possimus veritatis nihil distinctio qui eum ' .
2018 'repellat officia illum quos impedit quam iste esse unde qui ' .
2019 'suscipit aut facilis ut inventore omnis exercitationem quo magnam ' .
2020 'consequatur maxime aut illum soluta quaerat natus unde aspernatur ' .
2021 'et sed beatae nihil ullam temporibus corporis ratione blanditiis',
2022 'plink' => 'item_plink'
2025 self::assertStringStartsWith('item_title', $result['text']);
2026 self::assertStringStartsWith('<h4>item_title</h4><br>perspiciatis impedit voluptatem', $result['html']);
2031 * Test the api_convert_item() function with an empty item body.
2035 public function testApiConvertItemWithoutBody()
2038 $result = api_convert_item(
2040 'network' => 'feed',
2041 'title' => 'item_title',
2044 'plink' => 'item_plink'
2047 self::assertEquals("item_title", $result['text']);
2048 self::assertEquals('<h4>item_title</h4><br>item_plink', $result['html']);
2053 * Test the api_convert_item() function with the title in the body.
2057 public function testApiConvertItemWithTitleInBody()
2060 $result = api_convert_item(
2062 'title' => 'item_title',
2063 'body' => 'item_title item_body',
2067 self::assertEquals('item_title item_body', $result['text']);
2068 self::assertEquals('<h4>item_title</h4><br>item_title item_body', $result['html']);
2073 * Test the api_get_attachments() function.
2077 public function testApiGetAttachments()
2080 // self::assertEmpty(api_get_attachments($body, 0));
2084 * Test the api_get_attachments() function with an img tag.
2088 public function testApiGetAttachmentsWithImage()
2090 // $body = '[img]http://via.placeholder.com/1x1.png[/img]';
2091 // self::assertIsArray(api_get_attachments($body, 0));
2095 * Test the api_get_attachments() function with an img tag and an AndStatus user agent.
2099 public function testApiGetAttachmentsWithImageAndAndStatus()
2101 // $_SERVER['HTTP_USER_AGENT'] = 'AndStatus';
2102 // $body = '[img]http://via.placeholder.com/1x1.png[/img]';
2103 // self::assertIsArray(api_get_attachments($body, 0));
2107 * Test the api_get_entitities() function.
2111 public function testApiGetEntitities()
2114 // self::assertIsArray(api_get_entitities($text, 'bbcode', 0));
2118 * Test the api_get_entitities() function with the include_entities parameter.
2122 public function testApiGetEntititiesWithIncludeEntities()
2125 $_REQUEST['include_entities'] = 'true';
2127 $result = api_get_entitities($text, 'bbcode', 0);
2128 self::assertIsArray($result['hashtags']);
2129 self::assertIsArray($result['symbols']);
2130 self::assertIsArray($result['urls']);
2131 self::assertIsArray($result['user_mentions']);
2136 * Test the api_format_items_embeded_images() function.
2140 public function testApiFormatItemsEmbededImages()
2144 'text ' . DI::baseUrl() . '/display/item_guid',
2145 api_format_items_embeded_images(['guid' => 'item_guid'], 'text data:image/foo')
2151 * Test the api_format_items_activities() function.
2155 public function testApiFormatItemsActivities()
2157 $item = ['uid' => 0, 'uri-id' => 1];
2158 $result = DI::friendicaActivities()->createFromUriId($item['uri-id'], $item['uid']);
2159 self::assertArrayHasKey('like', $result);
2160 self::assertArrayHasKey('dislike', $result);
2161 self::assertArrayHasKey('attendyes', $result);
2162 self::assertArrayHasKey('attendno', $result);
2163 self::assertArrayHasKey('attendmaybe', $result);
2167 * Test the api_format_items_activities() function with an XML result.
2171 public function testApiFormatItemsActivitiesWithXml()
2173 $item = ['uid' => 0, 'uri-id' => 1];
2174 $result = DI::friendicaActivities()->createFromUriId($item['uri-id'], $item['uid'], 'xml');
2175 self::assertArrayHasKey('friendica:like', $result);
2176 self::assertArrayHasKey('friendica:dislike', $result);
2177 self::assertArrayHasKey('friendica:attendyes', $result);
2178 self::assertArrayHasKey('friendica:attendno', $result);
2179 self::assertArrayHasKey('friendica:attendmaybe', $result);
2183 * Test the api_format_items() function.
2184 * @doesNotPerformAssertions
2186 public function testApiFormatItems()
2189 $items = Post::selectToArray([], ['uid' => 42]);
2190 foreach ($items as $item) {
2191 $status = api_format_item($item);
2192 self::assertStatus($status);
2198 * Test the api_format_items() function with an XML result.
2199 * @doesNotPerformAssertions
2201 public function testApiFormatItemsWithXml()
2204 $items = Post::selectToArray([], ['uid' => 42]);
2205 foreach ($items as $item) {
2206 $status = api_format_item($item, 'xml');
2207 self::assertStatus($status);
2213 * Test the api_lists_list() function.
2217 public function testApiListsList()
2219 $result = api_lists_list('json');
2220 self::assertEquals(['lists_list' => []], $result);
2224 * Test the api_lists_ownerships() function.
2228 public function testApiListsOwnerships()
2230 $result = api_lists_ownerships('json');
2231 foreach ($result['lists']['lists'] as $list) {
2232 self::assertList($list);
2237 * Test the api_lists_ownerships() function without an authenticated user.
2241 public function testApiListsOwnershipsWithoutAuthenticatedUser()
2243 $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
2244 BasicAuth::setCurrentUserID();
2245 $_SESSION['authenticated'] = false;
2246 api_lists_ownerships('json');
2250 * Test the api_lists_statuses() function.
2254 public function testApiListsStatuses()
2256 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
2257 api_lists_statuses('json');
2261 * Test the api_lists_statuses() function with a list ID.
2262 * @doesNotPerformAssertions
2264 public function testApiListsStatusesWithListId()
2266 $_REQUEST['list_id'] = 1;
2267 $_REQUEST['page'] = -1;
2268 $_REQUEST['max_id'] = 10;
2269 $result = api_lists_statuses('json');
2270 foreach ($result['status'] as $status) {
2271 self::assertStatus($status);
2276 * Test the api_lists_statuses() function with a list ID and a RSS result.
2280 public function testApiListsStatusesWithListIdAndRss()
2282 $_REQUEST['list_id'] = 1;
2283 $result = api_lists_statuses('rss');
2284 self::assertXml($result, 'statuses');
2288 * Test the api_lists_statuses() function with an unallowed user.
2292 public function testApiListsStatusesWithUnallowedUser()
2294 $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
2295 BasicAuth::setCurrentUserID();
2296 api_lists_statuses('json');
2300 * Test the api_statuses_f() function.
2304 public function testApiStatusesFWithFriends()
2307 $result = api_statuses_f('friends');
2308 self::assertArrayHasKey('user', $result);
2312 * Test the api_statuses_f() function.
2316 public function testApiStatusesFWithFollowers()
2318 $result = api_statuses_f('followers');
2319 self::assertArrayHasKey('user', $result);
2323 * Test the api_statuses_f() function.
2327 public function testApiStatusesFWithBlocks()
2329 $result = api_statuses_f('blocks');
2330 self::assertArrayHasKey('user', $result);
2334 * Test the api_statuses_f() function.
2338 public function testApiStatusesFWithIncoming()
2340 $result = api_statuses_f('incoming');
2341 self::assertArrayHasKey('user', $result);
2345 * Test the api_statuses_f() function an undefined cursor GET variable.
2349 public function testApiStatusesFWithUndefinedCursor()
2351 $_GET['cursor'] = 'undefined';
2352 self::assertFalse(api_statuses_f('friends'));
2356 * Test the api_statuses_friends() function.
2360 public function testApiStatusesFriends()
2362 $result = api_statuses_friends('json');
2363 self::assertArrayHasKey('user', $result);
2367 * Test the api_statuses_friends() function an undefined cursor GET variable.
2371 public function testApiStatusesFriendsWithUndefinedCursor()
2373 $_GET['cursor'] = 'undefined';
2374 self::assertFalse(api_statuses_friends('json'));
2378 * Test the api_statuses_followers() function.
2382 public function testApiStatusesFollowers()
2384 $result = api_statuses_followers('json');
2385 self::assertArrayHasKey('user', $result);
2389 * Test the api_statuses_followers() function an undefined cursor GET variable.
2393 public function testApiStatusesFollowersWithUndefinedCursor()
2395 $_GET['cursor'] = 'undefined';
2396 self::assertFalse(api_statuses_followers('json'));
2400 * Test the api_blocks_list() function.
2404 public function testApiBlocksList()
2406 $result = api_blocks_list('json');
2407 self::assertArrayHasKey('user', $result);
2411 * Test the api_blocks_list() function an undefined cursor GET variable.
2415 public function testApiBlocksListWithUndefinedCursor()
2417 $_GET['cursor'] = 'undefined';
2418 self::assertFalse(api_blocks_list('json'));
2422 * Test the api_friendships_incoming() function.
2426 public function testApiFriendshipsIncoming()
2428 $result = api_friendships_incoming('json');
2429 self::assertArrayHasKey('id', $result);
2433 * Test the api_friendships_incoming() function an undefined cursor GET variable.
2437 public function testApiFriendshipsIncomingWithUndefinedCursor()
2439 $_GET['cursor'] = 'undefined';
2440 self::assertFalse(api_friendships_incoming('json'));
2444 * Test the api_statusnet_config() function.
2448 public function testApiStatusnetConfig()
2451 $result = api_statusnet_config('json');
2452 self::assertEquals('localhost', $result['config']['site']['server']);
2453 self::assertEquals('default', $result['config']['site']['theme']);
2454 self::assertEquals(DI::baseUrl() . '/images/friendica-64.png', $result['config']['site']['logo']);
2455 self::assertTrue($result['config']['site']['fancy']);
2456 self::assertEquals('en', $result['config']['site']['language']);
2457 self::assertEquals('UTC', $result['config']['site']['timezone']);
2458 self::assertEquals(200000, $result['config']['site']['textlimit']);
2459 self::assertEquals('false', $result['config']['site']['private']);
2460 self::assertEquals('false', $result['config']['site']['ssl']);
2461 self::assertEquals(30, $result['config']['site']['shorturllength']);
2466 * Test the api_direct_messages_new() function.
2470 public function testApiDirectMessagesNew()
2472 $result = api_direct_messages_new('json');
2473 self::assertNull($result);
2477 * Test the api_direct_messages_new() function without an authenticated user.
2481 public function testApiDirectMessagesNewWithoutAuthenticatedUser()
2483 $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
2484 BasicAuth::setCurrentUserID();
2485 $_SESSION['authenticated'] = false;
2486 api_direct_messages_new('json');
2490 * Test the api_direct_messages_new() function with an user ID.
2494 public function testApiDirectMessagesNewWithUserId()
2496 $_POST['text'] = 'message_text';
2497 $_POST['user_id'] = $this->otherUser['id'];
2498 $result = api_direct_messages_new('json');
2499 self::assertEquals(['direct_message' => ['error' => -1]], $result);
2503 * Test the api_direct_messages_new() function with a screen name.
2507 public function testApiDirectMessagesNewWithScreenName()
2509 $this->app->setLoggedInUserNickname($this->selfUser['nick']);
2510 $_POST['text'] = 'message_text';
2511 $_POST['user_id'] = $this->friendUser['id'];
2512 $result = api_direct_messages_new('json');
2513 self::assertStringContainsString('message_text', $result['direct_message']['text']);
2514 self::assertEquals('selfcontact', $result['direct_message']['sender_screen_name']);
2515 self::assertEquals(1, $result['direct_message']['friendica_seen']);
2519 * Test the api_direct_messages_new() function with a title.
2523 public function testApiDirectMessagesNewWithTitle()
2525 $this->app->setLoggedInUserNickname($this->selfUser['nick']);
2526 $_POST['text'] = 'message_text';
2527 $_POST['user_id'] = $this->friendUser['id'];
2528 $_REQUEST['title'] = 'message_title';
2529 $result = api_direct_messages_new('json');
2530 self::assertStringContainsString('message_text', $result['direct_message']['text']);
2531 self::assertStringContainsString('message_title', $result['direct_message']['text']);
2532 self::assertEquals('selfcontact', $result['direct_message']['sender_screen_name']);
2533 self::assertEquals(1, $result['direct_message']['friendica_seen']);
2537 * Test the api_direct_messages_new() function with an RSS result.
2541 public function testApiDirectMessagesNewWithRss()
2543 $this->app->setLoggedInUserNickname($this->selfUser['nick']);
2544 $_POST['text'] = 'message_text';
2545 $_POST['user_id'] = $this->friendUser['id'];
2546 $result = api_direct_messages_new('rss');
2547 self::assertXml($result, 'direct-messages');
2551 * Test the api_direct_messages_destroy() function.
2555 public function testApiDirectMessagesDestroy()
2557 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
2558 api_direct_messages_destroy('json');
2562 * Test the api_direct_messages_destroy() function with the friendica_verbose GET param.
2566 public function testApiDirectMessagesDestroyWithVerbose()
2568 $_GET['friendica_verbose'] = 'true';
2569 $result = api_direct_messages_destroy('json');
2573 'result' => 'error',
2574 'message' => 'message id or parenturi not specified'
2582 * Test the api_direct_messages_destroy() function without an authenticated user.
2586 public function testApiDirectMessagesDestroyWithoutAuthenticatedUser()
2588 $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
2589 BasicAuth::setCurrentUserID();
2590 $_SESSION['authenticated'] = false;
2591 api_direct_messages_destroy('json');
2595 * Test the api_direct_messages_destroy() function with a non-zero ID.
2599 public function testApiDirectMessagesDestroyWithId()
2601 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
2602 $_REQUEST['id'] = 1;
2603 api_direct_messages_destroy('json');
2607 * Test the api_direct_messages_destroy() with a non-zero ID and the friendica_verbose GET param.
2611 public function testApiDirectMessagesDestroyWithIdAndVerbose()
2613 $_REQUEST['id'] = 1;
2614 $_REQUEST['friendica_parenturi'] = 'parent_uri';
2615 $_GET['friendica_verbose'] = 'true';
2616 $result = api_direct_messages_destroy('json');
2620 'result' => 'error',
2621 'message' => 'message id not in database'
2629 * Test the api_direct_messages_destroy() function with a non-zero ID.
2633 public function testApiDirectMessagesDestroyWithCorrectId()
2635 $this->markTestIncomplete('We need to add a dataset for this.');
2639 * Test the api_direct_messages_box() function.
2643 public function testApiDirectMessagesBoxWithSentbox()
2645 $_REQUEST['page'] = -1;
2646 $_REQUEST['max_id'] = 10;
2647 $result = api_direct_messages_box('json', 'sentbox', 'false');
2648 self::assertArrayHasKey('direct_message', $result);
2652 * Test the api_direct_messages_box() function.
2656 public function testApiDirectMessagesBoxWithConversation()
2658 $result = api_direct_messages_box('json', 'conversation', 'false');
2659 self::assertArrayHasKey('direct_message', $result);
2663 * Test the api_direct_messages_box() function.
2667 public function testApiDirectMessagesBoxWithAll()
2669 $result = api_direct_messages_box('json', 'all', 'false');
2670 self::assertArrayHasKey('direct_message', $result);
2674 * Test the api_direct_messages_box() function.
2678 public function testApiDirectMessagesBoxWithInbox()
2680 $result = api_direct_messages_box('json', 'inbox', 'false');
2681 self::assertArrayHasKey('direct_message', $result);
2685 * Test the api_direct_messages_box() function.
2689 public function testApiDirectMessagesBoxWithVerbose()
2691 $result = api_direct_messages_box('json', 'sentbox', 'true');
2695 'result' => 'error',
2696 'message' => 'no mails available'
2704 * Test the api_direct_messages_box() function with a RSS result.
2708 public function testApiDirectMessagesBoxWithRss()
2710 $result = api_direct_messages_box('rss', 'sentbox', 'false');
2711 self::assertXml($result, 'direct-messages');
2715 * Test the api_direct_messages_box() function without an authenticated user.
2719 public function testApiDirectMessagesBoxWithUnallowedUser()
2721 $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
2722 BasicAuth::setCurrentUserID();
2723 api_direct_messages_box('json', 'sentbox', 'false');
2727 * Test the api_direct_messages_sentbox() function.
2731 public function testApiDirectMessagesSentbox()
2733 $result = api_direct_messages_sentbox('json');
2734 self::assertArrayHasKey('direct_message', $result);
2738 * Test the api_direct_messages_inbox() function.
2742 public function testApiDirectMessagesInbox()
2744 $result = api_direct_messages_inbox('json');
2745 self::assertArrayHasKey('direct_message', $result);
2749 * Test the api_direct_messages_all() function.
2753 public function testApiDirectMessagesAll()
2755 $result = api_direct_messages_all('json');
2756 self::assertArrayHasKey('direct_message', $result);
2760 * Test the api_direct_messages_conversation() function.
2764 public function testApiDirectMessagesConversation()
2766 $result = api_direct_messages_conversation('json');
2767 self::assertArrayHasKey('direct_message', $result);
2771 * Test the api_oauth_request_token() function.
2775 public function testApiOauthRequestToken()
2777 $this->markTestIncomplete('exit() kills phpunit as well');
2781 * Test the api_oauth_access_token() function.
2785 public function testApiOauthAccessToken()
2787 $this->markTestIncomplete('exit() kills phpunit as well');
2791 * Test the api_fr_photos_list() function.
2795 public function testApiFrPhotosList()
2797 $result = api_fr_photos_list('json');
2798 self::assertArrayHasKey('photo', $result);
2802 * Test the api_fr_photos_list() function without an authenticated user.
2806 public function testApiFrPhotosListWithoutAuthenticatedUser()
2808 $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
2809 BasicAuth::setCurrentUserID();
2810 $_SESSION['authenticated'] = false;
2811 api_fr_photos_list('json');
2815 * Test the api_fr_photo_create_update() function.
2817 public function testApiFrPhotoCreateUpdate()
2819 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
2820 api_fr_photo_create_update('json');
2824 * Test the api_fr_photo_create_update() function without an authenticated user.
2828 public function testApiFrPhotoCreateUpdateWithoutAuthenticatedUser()
2830 $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
2831 BasicAuth::setCurrentUserID();
2832 $_SESSION['authenticated'] = false;
2833 api_fr_photo_create_update('json');
2837 * Test the api_fr_photo_create_update() function with an album name.
2841 public function testApiFrPhotoCreateUpdateWithAlbum()
2843 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
2844 $_REQUEST['album'] = 'album_name';
2845 api_fr_photo_create_update('json');
2849 * Test the api_fr_photo_create_update() function with the update mode.
2853 public function testApiFrPhotoCreateUpdateWithUpdate()
2855 $this->markTestIncomplete('We need to create a dataset for this');
2859 * Test the api_fr_photo_create_update() function with an uploaded file.
2863 public function testApiFrPhotoCreateUpdateWithFile()
2865 $this->markTestIncomplete();
2869 * Test the api_fr_photo_detail() function.
2873 public function testApiFrPhotoDetail()
2875 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
2876 api_fr_photo_detail('json');
2880 * Test the api_fr_photo_detail() function without an authenticated user.
2884 public function testApiFrPhotoDetailWithoutAuthenticatedUser()
2886 $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
2887 BasicAuth::setCurrentUserID();
2888 $_SESSION['authenticated'] = false;
2889 api_fr_photo_detail('json');
2893 * Test the api_fr_photo_detail() function with a photo ID.
2897 public function testApiFrPhotoDetailWithPhotoId()
2899 $this->expectException(\Friendica\Network\HTTPException\NotFoundException::class);
2900 $_REQUEST['photo_id'] = 1;
2901 api_fr_photo_detail('json');
2905 * Test the api_fr_photo_detail() function with a correct photo ID.
2909 public function testApiFrPhotoDetailCorrectPhotoId()
2911 $this->markTestIncomplete('We need to create a dataset for this.');
2915 * Test the api_account_update_profile_image() function.
2919 public function testApiAccountUpdateProfileImage()
2921 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
2922 api_account_update_profile_image('json');
2926 * Test the api_account_update_profile_image() function without an authenticated user.
2930 public function testApiAccountUpdateProfileImageWithoutAuthenticatedUser()
2932 $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
2933 BasicAuth::setCurrentUserID();
2934 $_SESSION['authenticated'] = false;
2935 api_account_update_profile_image('json');
2939 * Test the api_account_update_profile_image() function with an uploaded file.
2943 public function testApiAccountUpdateProfileImageWithUpload()
2945 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
2946 $this->markTestIncomplete();
2951 * Test the api_account_update_profile() function.
2955 public function testApiAccountUpdateProfile()
2958 $_POST['name'] = 'new_name';
2959 $_POST['description'] = 'new_description';
2960 $result = api_account_update_profile('json');
2961 // We can't use assertSelfUser() here because the user object is missing some properties.
2962 self::assertEquals($this->selfUser['id'], $result['user']['cid']);
2963 self::assertEquals('DFRN', $result['user']['location']);
2964 self::assertEquals($this->selfUser['nick'], $result['user']['screen_name']);
2965 self::assertEquals('new_name', $result['user']['name']);
2966 self::assertEquals('new_description', $result['user']['description']);
2971 * Test the check_acl_input() function.
2975 public function testCheckAclInput()
2977 $result = check_acl_input('<aclstring>', BaseApi::getCurrentUserID());
2978 // Where does this result come from?
2979 self::assertEquals(1, $result);
2983 * Test the check_acl_input() function with an empty ACL string.
2987 public function testCheckAclInputWithEmptyAclString()
2989 $result = check_acl_input(' ', BaseApi::getCurrentUserID());
2990 self::assertFalse($result);
2994 * Test the save_media_to_database() function.
2998 public function testSaveMediaToDatabase()
3000 $this->markTestIncomplete();
3004 * Test the post_photo_item() function.
3008 public function testPostPhotoItem()
3010 $this->markTestIncomplete();
3014 * Test the prepare_photo_data() function.
3018 public function testPreparePhotoData()
3020 $this->markTestIncomplete();
3024 * Test the api_share_as_retweet() function with a valid item.
3028 public function testApiShareAsRetweetWithValidItem()
3030 $this->markTestIncomplete();
3034 * Test the api_in_reply_to() function with a valid item.
3038 public function testApiInReplyToWithValidItem()
3040 $this->markTestIncomplete();
3044 * Test the api_clean_plain_items() function.
3048 public function testApiCleanPlainItems()
3050 $_REQUEST['include_entities'] = 'true';
3051 $result = api_clean_plain_items('some_text [url="some_url"]some_text[/url]');
3052 self::assertEquals('some_text [url="some_url"]"some_url"[/url]', $result);
3056 * Test the api_best_nickname() function with contacts.
3060 public function testApiBestNicknameWithContacts()
3062 $this->markTestIncomplete();
3066 * Test the api_friendica_group_show() function.
3070 public function testApiFriendicaGroupShow()
3072 $this->markTestIncomplete();
3076 * Test the api_friendica_group_delete() function.
3080 public function testApiFriendicaGroupDelete()
3082 $this->markTestIncomplete();
3086 * Test the api_lists_destroy() function.
3090 public function testApiListsDestroy()
3092 $this->markTestIncomplete();
3096 * Test the group_create() function.
3100 public function testGroupCreate()
3102 $this->markTestIncomplete();
3106 * Test the api_friendica_group_create() function.
3110 public function testApiFriendicaGroupCreate()
3112 $this->markTestIncomplete();
3116 * Test the api_lists_create() function.
3120 public function testApiListsCreate()
3122 $this->markTestIncomplete();
3126 * Test the api_friendica_group_update() function.
3130 public function testApiFriendicaGroupUpdate()
3132 $this->markTestIncomplete();
3136 * Test the api_lists_update() function.
3140 public function testApiListsUpdate()
3142 $this->markTestIncomplete();
3146 * Test the api_friendica_activity() function.
3150 public function testApiFriendicaActivity()
3152 $this->markTestIncomplete();
3156 * Test the api_friendica_notification_seen() function.
3160 public function testApiFriendicaNotificationSeen()
3162 $this->markTestIncomplete();
3166 * Test the api_friendica_direct_messages_setseen() function.
3170 public function testApiFriendicaDirectMessagesSetseen()
3172 $this->markTestIncomplete();
3176 * Test the api_friendica_direct_messages_search() function.
3180 public function testApiFriendicaDirectMessagesSearch()
3182 $this->markTestIncomplete();