3 * Friendica implementation of statusnet/twitter API
5 * @file include/api.php
6 * @todo Automatically detect if incoming data is HTML or BBCode
10 use Friendica\Content\ContactSelector;
11 use Friendica\Content\Feature;
12 use Friendica\Content\Text\BBCode;
13 use Friendica\Content\Text\HTML;
14 use Friendica\Core\Addon;
15 use Friendica\Core\Config;
16 use Friendica\Core\L10n;
17 use Friendica\Core\NotificationsManager;
18 use Friendica\Core\PConfig;
19 use Friendica\Core\System;
20 use Friendica\Core\Worker;
21 use Friendica\Database\DBM;
22 use Friendica\Model\Contact;
23 use Friendica\Model\Group;
24 use Friendica\Model\Item;
25 use Friendica\Model\Mail;
26 use Friendica\Model\Photo;
27 use Friendica\Model\User;
28 use Friendica\Network\FKOAuth1;
29 use Friendica\Network\HTTPException;
30 use Friendica\Network\HTTPException\BadRequestException;
31 use Friendica\Network\HTTPException\ForbiddenException;
32 use Friendica\Network\HTTPException\InternalServerErrorException;
33 use Friendica\Network\HTTPException\MethodNotAllowedException;
34 use Friendica\Network\HTTPException\NotFoundException;
35 use Friendica\Network\HTTPException\NotImplementedException;
36 use Friendica\Network\HTTPException\TooManyRequestsException;
37 use Friendica\Network\HTTPException\UnauthorizedException;
38 use Friendica\Object\Image;
39 use Friendica\Protocol\Diaspora;
40 use Friendica\Util\DateTimeFormat;
41 use Friendica\Util\Network;
42 use Friendica\Util\XML;
44 require_once 'include/conversation.php';
45 require_once 'mod/share.php';
46 require_once 'mod/item.php';
47 require_once 'include/security.php';
48 require_once 'mod/wall_upload.php';
49 require_once 'mod/proxy.php';
51 define('API_METHOD_ANY', '*');
52 define('API_METHOD_GET', 'GET');
53 define('API_METHOD_POST', 'POST,PUT');
54 define('API_METHOD_DELETE', 'POST,DELETE');
60 * It is not sufficient to use local_user() to check whether someone is allowed to use the API,
61 * because this will open CSRF holes (just embed an image with src=friendicasite.com/api/statuses/update?status=CSRF
62 * into a page, and visitors will post something without noticing it).
64 * @brief Auth API user
68 if (x($_SESSION, 'allow_api')) {
76 * Clients can send 'source' parameter to be show in post metadata
77 * as "sent via <source>".
78 * Some clients doesn't send a source param, we support ones we know
81 * @brief Get source name from API client
84 * Client source name, default to "api" if unset/unknown
88 if (requestdata('source')) {
89 return requestdata('source');
92 // Support for known clients that doesn't send a source name
93 if (strpos($_SERVER['HTTP_USER_AGENT'], "Twidere") !== false) {
97 logger("Unrecognized user-agent ".$_SERVER['HTTP_USER_AGENT'], LOGGER_DEBUG);
103 * @brief Format date for API
105 * @param string $str Source date, as UTC
106 * @return string Date in UTC formatted as "D M d H:i:s +0000 Y"
108 function api_date($str)
110 // Wed May 23 06:01:13 +0000 2007
111 return DateTimeFormat::utc($str, "D M d H:i:s +0000 Y");
115 * Register a function to be the endpoint for defined API path.
117 * @brief Register API endpoint
119 * @param string $path API URL path, relative to System::baseUrl()
120 * @param string $func Function name to call on path request
121 * @param bool $auth API need logged user
122 * @param string $method HTTP method reqiured to call this endpoint.
123 * One of API_METHOD_ANY, API_METHOD_GET, API_METHOD_POST.
124 * Default to API_METHOD_ANY
126 function api_register_func($path, $func, $auth = false, $method = API_METHOD_ANY)
136 // Workaround for hotot
137 $path = str_replace("api/", "api/1.1/", $path);
147 * Log in user via OAuth1 or Simple HTTP Auth.
148 * Simple Auth allow username in form of <pre>user@server</pre>, ignoring server part
150 * @brief Login API user
152 * @param object $a App
153 * @hook 'authenticate'
155 * 'username' => username from login form
156 * 'password' => password from login form
157 * 'authenticated' => return status,
158 * 'user_record' => return authenticated user record
160 * array $user logged user record
162 function api_login(App $a)
164 $oauth1 = new FKOAuth1();
167 list($consumer, $token) = $oauth1->verify_request(OAuthRequest::from_request());
168 if (!is_null($token)) {
169 $oauth1->loginUser($token->uid);
170 Addon::callHooks('logged_in', $a->user);
173 echo __FILE__.__LINE__.__FUNCTION__ . "<pre>";
174 var_dump($consumer, $token);
176 } catch (Exception $e) {
180 // workaround for HTTP-auth in CGI mode
181 if (x($_SERVER, 'REDIRECT_REMOTE_USER')) {
182 $userpass = base64_decode(substr($_SERVER["REDIRECT_REMOTE_USER"], 6)) ;
183 if (strlen($userpass)) {
184 list($name, $password) = explode(':', $userpass);
185 $_SERVER['PHP_AUTH_USER'] = $name;
186 $_SERVER['PHP_AUTH_PW'] = $password;
190 if (!x($_SERVER, 'PHP_AUTH_USER')) {
191 logger('API_login: ' . print_r($_SERVER, true), LOGGER_DEBUG);
192 header('WWW-Authenticate: Basic realm="Friendica"');
193 throw new UnauthorizedException("This API requires login");
196 $user = $_SERVER['PHP_AUTH_USER'];
197 $password = $_SERVER['PHP_AUTH_PW'];
199 // allow "user@server" login (but ignore 'server' part)
200 $at = strstr($user, "@", true);
205 // next code from mod/auth.php. needs better solution
209 'username' => trim($user),
210 'password' => trim($password),
211 'authenticated' => 0,
212 'user_record' => null,
216 * An addon indicates successful login by setting 'authenticated' to non-zero value and returning a user record
217 * Addons should never set 'authenticated' except to indicate success - as hooks may be chained
218 * and later addons should not interfere with an earlier one that succeeded.
220 Addon::callHooks('authenticate', $addon_auth);
222 if ($addon_auth['authenticated'] && count($addon_auth['user_record'])) {
223 $record = $addon_auth['user_record'];
225 $user_id = User::authenticate(trim($user), trim($password));
227 $record = dba::selectFirst('user', [], ['uid' => $user_id]);
231 if (!DBM::is_result($record)) {
232 logger('API_login failure: ' . print_r($_SERVER, true), LOGGER_DEBUG);
233 header('WWW-Authenticate: Basic realm="Friendica"');
234 //header('HTTP/1.0 401 Unauthorized');
235 //die('This api requires login');
236 throw new UnauthorizedException("This API requires login");
239 authenticate_success($record);
241 $_SESSION["allow_api"] = true;
243 Addon::callHooks('logged_in', $a->user);
247 * API endpoints can define which HTTP method to accept when called.
248 * This function check the current HTTP method agains endpoint
251 * @brief Check HTTP method of called API
253 * @param string $method Required methods, uppercase, separated by comma
256 function api_check_method($method)
258 if ($method == "*") {
261 return (strpos($method, $_SERVER['REQUEST_METHOD']) !== false);
265 * Authenticate user, call registered API function, set HTTP headers
267 * @brief Main API entry point
269 * @param object $a App
270 * @return string API call result
272 function api_call(App $a)
274 global $API, $called_api;
277 if (strpos($a->query_string, ".xml") > 0) {
280 if (strpos($a->query_string, ".json") > 0) {
283 if (strpos($a->query_string, ".rss") > 0) {
286 if (strpos($a->query_string, ".atom") > 0) {
291 foreach ($API as $p => $info) {
292 if (strpos($a->query_string, $p) === 0) {
293 if (!api_check_method($info['method'])) {
294 throw new MethodNotAllowedException();
297 $called_api = explode("/", $p);
298 //unset($_SERVER['PHP_AUTH_USER']);
300 /// @TODO should be "true ==[=] $info['auth']", if you miss only one = character, you assign a variable (only with ==). Let's make all this even.
301 if ($info['auth'] === true && api_user() === false) {
305 logger('API call for ' . $a->user['username'] . ': ' . $a->query_string);
306 logger('API parameters: ' . print_r($_REQUEST, true));
308 $stamp = microtime(true);
309 $return = call_user_func($info['func'], $type);
310 $duration = (float) (microtime(true) - $stamp);
311 logger("API call duration: " . round($duration, 2) . "\t" . $a->query_string, LOGGER_DEBUG);
313 if (Config::get("system", "profiler")) {
314 $duration = microtime(true)-$a->performance["start"];
316 /// @TODO round() really everywhere?
318 parse_url($a->query_string, PHP_URL_PATH) . ": " . sprintf(
319 "Database: %s/%s, Cache %s/%s, Network: %s, I/O: %s, Other: %s, Total: %s",
320 round($a->performance["database"] - $a->performance["database_write"], 3),
321 round($a->performance["database_write"], 3),
322 round($a->performance["cache"], 3),
323 round($a->performance["cache_write"], 3),
324 round($a->performance["network"], 2),
325 round($a->performance["file"], 2),
326 round($duration - ($a->performance["database"]
327 + $a->performance["cache"] + $a->performance["cache_write"]
328 + $a->performance["network"] + $a->performance["file"]), 2),
334 if (Config::get("rendertime", "callstack")) {
335 $o = "Database Read:\n";
336 foreach ($a->callstack["database"] as $func => $time) {
337 $time = round($time, 3);
339 $o .= $func . ": " . $time . "\n";
342 $o .= "\nDatabase Write:\n";
343 foreach ($a->callstack["database_write"] as $func => $time) {
344 $time = round($time, 3);
346 $o .= $func . ": " . $time . "\n";
350 $o = "Cache Read:\n";
351 foreach ($a->callstack["cache"] as $func => $time) {
352 $time = round($time, 3);
354 $o .= $func . ": " . $time . "\n";
357 $o .= "\nCache Write:\n";
358 foreach ($a->callstack["cache_write"] as $func => $time) {
359 $time = round($time, 3);
361 $o .= $func . ": " . $time . "\n";
365 $o .= "\nNetwork:\n";
366 foreach ($a->callstack["network"] as $func => $time) {
367 $time = round($time, 3);
369 $o .= $func . ": " . $time . "\n";
372 logger($o, LOGGER_DEBUG);
376 if (false === $return) {
378 * api function returned false withour throw an
379 * exception. This should not happend, throw a 500
381 throw new InternalServerErrorException();
386 header("Content-Type: text/xml");
389 header("Content-Type: application/json");
390 foreach ($return as $rr) {
391 $json = json_encode($rr);
393 if (x($_GET, 'callback')) {
394 $json = $_GET['callback'] . "(" . $json . ")";
399 header("Content-Type: application/rss+xml");
400 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
403 header("Content-Type: application/atom+xml");
404 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
411 logger('API call not implemented: ' . $a->query_string);
412 throw new NotImplementedException();
413 } catch (HTTPException $e) {
414 header("HTTP/1.1 {$e->httpcode} {$e->httpdesc}");
415 return api_error($type, $e);
420 * @brief Format API error string
422 * @param string $type Return type (xml, json, rss, as)
423 * @param object $e HTTPException Error object
424 * @return string error message formatted as $type
426 function api_error($type, $e)
430 $error = ($e->getMessage() !== "" ? $e->getMessage() : $e->httpdesc);
431 /// @TODO: https://dev.twitter.com/overview/api/response-codes
433 $error = ["error" => $error,
434 "code" => $e->httpcode . " " . $e->httpdesc,
435 "request" => $a->query_string];
437 $return = api_format_data('status', $type, ['status' => $error]);
441 header("Content-Type: text/xml");
444 header("Content-Type: application/json");
445 $return = json_encode($return);
448 header("Content-Type: application/rss+xml");
451 header("Content-Type: application/atom+xml");
459 * @brief Set values for RSS template
462 * @param array $arr Array to be passed to template
463 * @param array $user_info User info
465 * @todo find proper type-hints
467 function api_rss_extra(App $a, $arr, $user_info)
469 if (is_null($user_info)) {
470 $user_info = api_get_user($a);
473 $arr['$user'] = $user_info;
475 'alternate' => $user_info['url'],
476 'self' => System::baseUrl() . "/" . $a->query_string,
477 'base' => System::baseUrl(),
478 'updated' => api_date(null),
479 'atom_updated' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
480 'language' => $user_info['language'],
481 'logo' => System::baseUrl() . "/images/friendica-32.png",
489 * @brief Unique contact to contact url.
491 * @param int $id Contact id
492 * @return bool|string
493 * Contact url or False if contact id is unknown
495 function api_unique_id_to_nurl($id)
497 $r = dba::selectFirst('contact', ['nurl'], ['uid' => 0, 'id' => $id]);
499 if (DBM::is_result($r)) {
507 * @brief Get user info array.
509 * @param object $a App
510 * @param int|string $contact_id Contact ID or URL
512 function api_get_user(App $a, $contact_id = null)
520 logger("api_get_user: Fetching user data for user ".$contact_id, LOGGER_DEBUG);
522 // Searching for contact URL
523 if (!is_null($contact_id) && (intval($contact_id) == 0)) {
524 $user = dbesc(normalise_link($contact_id));
526 $extra_query = "AND `contact`.`nurl` = '%s' ";
527 if (api_user() !== false) {
528 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
532 // Searching for contact id with uid = 0
533 if (!is_null($contact_id) && (intval($contact_id) != 0)) {
534 $user = dbesc(api_unique_id_to_nurl($contact_id));
537 throw new BadRequestException("User not found.");
541 $extra_query = "AND `contact`.`nurl` = '%s' ";
542 if (api_user() !== false) {
543 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
547 if (is_null($user) && x($_GET, 'user_id')) {
548 $user = dbesc(api_unique_id_to_nurl($_GET['user_id']));
551 throw new BadRequestException("User not found.");
555 $extra_query = "AND `contact`.`nurl` = '%s' ";
556 if (api_user() !== false) {
557 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
560 if (is_null($user) && x($_GET, 'screen_name')) {
561 $user = dbesc($_GET['screen_name']);
562 $extra_query = "AND `contact`.`nick` = '%s' ";
563 if (api_user() !== false) {
564 $extra_query .= "AND `contact`.`uid`=".intval(api_user());
568 if (is_null($user) && x($_GET, 'profileurl')) {
569 $user = dbesc(normalise_link($_GET['profileurl']));
570 $extra_query = "AND `contact`.`nurl` = '%s' ";
571 if (api_user() !== false) {
572 $extra_query .= "AND `contact`.`uid`=".intval(api_user());
576 if (is_null($user) && ($a->argc > (count($called_api) - 1)) && (count($called_api) > 0)) {
577 $argid = count($called_api);
578 list($user, $null) = explode(".", $a->argv[$argid]);
579 if (is_numeric($user)) {
580 $user = dbesc(api_unique_id_to_nurl($user));
587 $extra_query = "AND `contact`.`nurl` = '%s' ";
588 if (api_user() !== false) {
589 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
592 $user = dbesc($user);
593 $extra_query = "AND `contact`.`nick` = '%s' ";
594 if (api_user() !== false) {
595 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
600 logger("api_get_user: user ".$user, LOGGER_DEBUG);
603 if (api_user() === false) {
607 $user = $_SESSION['uid'];
608 $extra_query = "AND `contact`.`uid` = %d AND `contact`.`self` ";
612 logger('api_user: ' . $extra_query . ', user: ' . $user);
616 "SELECT *, `contact`.`id` AS `cid` FROM `contact`
622 // Selecting the id by priority, friendica first
623 api_best_nickname($uinfo);
625 // if the contact wasn't found, fetch it from the contacts with uid = 0
626 if (!DBM::is_result($uinfo)) {
630 $r = q("SELECT * FROM `contact` WHERE `uid` = 0 AND `nurl` = '%s' LIMIT 1", dbesc(normalise_link($url)));
633 if (DBM::is_result($r)) {
634 $network_name = ContactSelector::networkToName($r[0]['network'], $r[0]['url']);
636 // If no nick where given, extract it from the address
637 if (($r[0]['nick'] == "") || ($r[0]['name'] == $r[0]['nick'])) {
638 $r[0]['nick'] = api_get_nick($r[0]["url"]);
643 'id_str' => (string) $r[0]["id"],
644 'name' => $r[0]["name"],
645 'screen_name' => (($r[0]['nick']) ? $r[0]['nick'] : $r[0]['name']),
646 'location' => ($r[0]["location"] != "") ? $r[0]["location"] : $network_name,
647 'description' => $r[0]["about"],
648 'profile_image_url' => $r[0]["micro"],
649 'profile_image_url_https' => $r[0]["micro"],
650 'profile_image_url_profile_size' => $r[0]["thumb"],
651 'profile_image_url_large' => $r[0]["photo"],
652 'url' => $r[0]["url"],
653 'protected' => false,
654 'followers_count' => 0,
655 'friends_count' => 0,
657 'created_at' => api_date($r[0]["created"]),
658 'favourites_count' => 0,
660 'time_zone' => 'UTC',
661 'geo_enabled' => false,
663 'statuses_count' => 0,
665 'contributors_enabled' => false,
666 'is_translator' => false,
667 'is_translation_enabled' => false,
668 'following' => false,
669 'follow_request_sent' => false,
670 'statusnet_blocking' => false,
671 'notifications' => false,
672 'statusnet_profile_url' => $r[0]["url"],
674 'cid' => Contact::getIdForURL($r[0]["url"], api_user(), true),
676 'network' => $r[0]["network"],
681 throw new BadRequestException("User not found.");
685 if ($uinfo[0]['self']) {
686 if ($uinfo[0]['network'] == "") {
687 $uinfo[0]['network'] = NETWORK_DFRN;
691 "SELECT * FROM `user` WHERE `uid` = %d LIMIT 1",
695 "SELECT * FROM `profile` WHERE `uid` = %d AND `is-default` = 1 LIMIT 1",
699 /// @TODO old-lost code? (twice)
700 // Counting is deactivated by now, due to performance issues
701 // count public wall messages
702 //$r = q("SELECT COUNT(*) as `count` FROM `item` WHERE `uid` = %d AND `wall`",
703 // intval($uinfo[0]['uid'])
705 //$countitms = $r[0]['count'];
708 // Counting is deactivated by now, due to performance issues
709 //$r = q("SELECT count(*) as `count` FROM `item`
710 // WHERE `contact-id` = %d",
711 // intval($uinfo[0]['id'])
713 //$countitms = $r[0]['count'];
717 /// @TODO old-lost code? (twice)
719 // Counting is deactivated by now, due to performance issues
721 $r = q("SELECT count(*) as `count` FROM `contact`
722 WHERE `uid` = %d AND `rel` IN ( %d, %d )
723 AND `self`=0 AND NOT `blocked` AND NOT `pending` AND `hidden`=0",
724 intval($uinfo[0]['uid']),
725 intval(CONTACT_IS_SHARING),
726 intval(CONTACT_IS_FRIEND)
728 $countfriends = $r[0]['count'];
730 $r = q("SELECT count(*) as `count` FROM `contact`
731 WHERE `uid` = %d AND `rel` IN ( %d, %d )
732 AND `self`=0 AND NOT `blocked` AND NOT `pending` AND `hidden`=0",
733 intval($uinfo[0]['uid']),
734 intval(CONTACT_IS_FOLLOWER),
735 intval(CONTACT_IS_FRIEND)
737 $countfollowers = $r[0]['count'];
739 $r = q("SELECT count(*) as `count` FROM item where starred = 1 and uid = %d and deleted = 0",
740 intval($uinfo[0]['uid'])
742 $starred = $r[0]['count'];
745 if (! $uinfo[0]['self']) {
755 // Add a nick if it isn't present there
756 if (($uinfo[0]['nick'] == "") || ($uinfo[0]['name'] == $uinfo[0]['nick'])) {
757 $uinfo[0]['nick'] = api_get_nick($uinfo[0]["url"]);
760 $network_name = ContactSelector::networkToName($uinfo[0]['network'], $uinfo[0]['url']);
762 $pcontact_id = Contact::getIdForURL($uinfo[0]['url'], 0, true);
764 if (!empty($profile[0]['about'])) {
765 $description = $profile[0]['about'];
767 $description = $uinfo[0]["about"];
770 if (!empty($usr[0]['default-location'])) {
771 $location = $usr[0]['default-location'];
772 } elseif (!empty($uinfo[0]["location"])) {
773 $location = $uinfo[0]["location"];
775 $location = $network_name;
779 'id' => intval($pcontact_id),
780 'id_str' => (string) intval($pcontact_id),
781 'name' => (($uinfo[0]['name']) ? $uinfo[0]['name'] : $uinfo[0]['nick']),
782 'screen_name' => (($uinfo[0]['nick']) ? $uinfo[0]['nick'] : $uinfo[0]['name']),
783 'location' => $location,
784 'description' => $description,
785 'profile_image_url' => $uinfo[0]['micro'],
786 'profile_image_url_https' => $uinfo[0]['micro'],
787 'profile_image_url_profile_size' => $uinfo[0]["thumb"],
788 'profile_image_url_large' => $uinfo[0]["photo"],
789 'url' => $uinfo[0]['url'],
790 'protected' => false,
791 'followers_count' => intval($countfollowers),
792 'friends_count' => intval($countfriends),
794 'created_at' => api_date($uinfo[0]['created']),
795 'favourites_count' => intval($starred),
797 'time_zone' => 'UTC',
798 'geo_enabled' => false,
800 'statuses_count' => intval($countitms),
802 'contributors_enabled' => false,
803 'is_translator' => false,
804 'is_translation_enabled' => false,
805 'following' => (($uinfo[0]['rel'] == CONTACT_IS_FOLLOWER) || ($uinfo[0]['rel'] == CONTACT_IS_FRIEND)),
806 'follow_request_sent' => false,
807 'statusnet_blocking' => false,
808 'notifications' => false,
810 //'statusnet_profile_url' => System::baseUrl()."/contacts/".$uinfo[0]['cid'],
811 'statusnet_profile_url' => $uinfo[0]['url'],
812 'uid' => intval($uinfo[0]['uid']),
813 'cid' => intval($uinfo[0]['cid']),
814 'self' => $uinfo[0]['self'],
815 'network' => $uinfo[0]['network'],
818 // If this is a local user and it uses Frio, we can get its color preferences.
820 $theme_info = dba::selectFirst('user', ['theme'], ['uid' => $ret['uid']]);
821 if ($theme_info['theme'] === 'frio') {
822 $schema = PConfig::get($ret['uid'], 'frio', 'schema');
823 if ($schema && ($schema != '---')) {
824 if (file_exists('view/theme/frio/schema/'.$schema.'.php')) {
825 $schemefile = 'view/theme/frio/schema/'.$schema.'.php';
826 require_once $schemefile;
829 $nav_bg = PConfig::get($ret['uid'], 'frio', 'nav_bg');
830 $link_color = PConfig::get($ret['uid'], 'frio', 'link_color');
831 $bgcolor = PConfig::get($ret['uid'], 'frio', 'background_color');
837 $link_color = "#6fdbe8";
840 $bgcolor = "#ededed";
843 $ret['profile_sidebar_fill_color'] = str_replace('#', '', $nav_bg);
844 $ret['profile_link_color'] = str_replace('#', '', $link_color);
845 $ret['profile_background_color'] = str_replace('#', '', $bgcolor);
853 * @brief return api-formatted array for item's author and owner
855 * @param object $a App
856 * @param array $item item from db
857 * @return array(array:author, array:owner)
859 function api_item_get_user(App $a, $item)
861 $status_user = api_get_user($a, $item["author-link"]);
863 $status_user["protected"] = (($item["allow_cid"] != "") ||
864 ($item["allow_gid"] != "") ||
865 ($item["deny_cid"] != "") ||
866 ($item["deny_gid"] != "") ||
869 if ($item['thr-parent'] == $item['uri']) {
870 $owner_user = api_get_user($a, $item["owner-link"]);
872 $owner_user = $status_user;
875 return ([$status_user, $owner_user]);
879 * @brief walks recursively through an array with the possibility to change value and key
881 * @param array $array The array to walk through
882 * @param string $callback The callback function
884 * @return array the transformed array
886 function api_walk_recursive(array &$array, callable $callback)
890 foreach ($array as $k => $v) {
892 if ($callback($v, $k)) {
893 $new_array[$k] = api_walk_recursive($v, $callback);
896 if ($callback($v, $k)) {
907 * @brief Callback function to transform the array in an array that can be transformed in a XML file
909 * @param mixed $item Array item value
910 * @param string $key Array key
912 * @return boolean Should the array item be deleted?
914 function api_reformat_xml(&$item, &$key)
916 if (is_bool($item)) {
917 $item = ($item ? "true" : "false");
920 if (substr($key, 0, 10) == "statusnet_") {
921 $key = "statusnet:".substr($key, 10);
922 } elseif (substr($key, 0, 10) == "friendica_") {
923 $key = "friendica:".substr($key, 10);
925 /// @TODO old-lost code?
927 // $key = "default:".$key;
933 * @brief Creates the XML from a JSON style array
935 * @param array $data JSON style array
936 * @param string $root_element Name of the root element
938 * @return string The XML data
940 function api_create_xml($data, $root_element)
942 $childname = key($data);
943 $data2 = array_pop($data);
946 $namespaces = ["" => "http://api.twitter.com",
947 "statusnet" => "http://status.net/schema/api/1/",
948 "friendica" => "http://friendi.ca/schema/api/1/",
949 "georss" => "http://www.georss.org/georss"];
951 /// @todo Auto detection of needed namespaces
952 if (in_array($root_element, ["ok", "hash", "config", "version", "ids", "notes", "photos"])) {
956 if (is_array($data2)) {
957 api_walk_recursive($data2, "api_reformat_xml");
964 foreach ($data2 as $item) {
965 $data4[$i++.":".$childname] = $item;
971 $data3 = [$root_element => $data2];
973 $ret = XML::fromArray($data3, $xml, false, $namespaces);
978 * @brief Formats the data according to the data type
980 * @param string $root_element Name of the root element
981 * @param string $type Return type (atom, rss, xml, json)
982 * @param array $data JSON style array
984 * @return (string|object|array) XML data or JSON data
986 function api_format_data($root_element, $type, $data)
992 $ret = api_create_xml($data, $root_element);
1007 * Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful;
1008 * returns a 401 status code and an error message if not.
1009 * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-account-verify_credentials
1011 * @param string $type Return type (atom, rss, xml, json)
1013 function api_account_verify_credentials($type)
1018 if (api_user() === false) {
1019 throw new ForbiddenException();
1022 unset($_REQUEST["user_id"]);
1023 unset($_GET["user_id"]);
1025 unset($_REQUEST["screen_name"]);
1026 unset($_GET["screen_name"]);
1028 $skip_status = (x($_REQUEST, 'skip_status')?$_REQUEST['skip_status'] : false);
1030 $user_info = api_get_user($a);
1032 // "verified" isn't used here in the standard
1033 unset($user_info["verified"]);
1035 // - Adding last status
1036 if (!$skip_status) {
1037 $user_info["status"] = api_status_show("raw");
1038 if (!count($user_info["status"])) {
1039 unset($user_info["status"]);
1041 unset($user_info["status"]["user"]);
1045 // "uid" and "self" are only needed for some internal stuff, so remove it from here
1046 unset($user_info["uid"]);
1047 unset($user_info["self"]);
1049 return api_format_data("user", $type, ['user' => $user_info]);
1052 /// @TODO move to top of file or somewhere better
1053 api_register_func('api/account/verify_credentials', 'api_account_verify_credentials', true);
1056 * Get data from $_POST or $_GET
1060 function requestdata($k)
1062 if (x($_POST, $k)) {
1072 * Waitman Gobble Mod
1074 * @param string $type Return type (atom, rss, xml, json)
1076 * @return array|string
1078 function api_statuses_mediap($type)
1082 if (api_user() === false) {
1083 logger('api_statuses_update: no user');
1084 throw new ForbiddenException();
1086 $user_info = api_get_user($a);
1088 $_REQUEST['type'] = 'wall';
1089 $_REQUEST['profile_uid'] = api_user();
1090 $_REQUEST['api_source'] = true;
1091 $txt = requestdata('status');
1092 /// @TODO old-lost code?
1093 //$txt = urldecode(requestdata('status'));
1095 if ((strpos($txt, '<') !== false) || (strpos($txt, '>') !== false)) {
1096 $txt = html2bb_video($txt);
1097 $config = HTMLPurifier_Config::createDefault();
1098 $config->set('Cache.DefinitionImpl', null);
1099 $purifier = new HTMLPurifier($config);
1100 $txt = $purifier->purify($txt);
1102 $txt = HTML::toBBCode($txt);
1104 $a->argv[1]=$user_info['screen_name']; //should be set to username?
1106 // tell wall_upload function to return img info instead of echo
1107 $_REQUEST['hush'] = 'yeah';
1108 $bebop = wall_upload_post($a);
1110 // now that we have the img url in bbcode we can add it to the status and insert the wall item.
1111 $_REQUEST['body'] = $txt . "\n\n" . $bebop;
1114 // this should output the last post (the one we just posted).
1115 return api_status_show($type);
1118 /// @TODO move this to top of file or somewhere better!
1119 api_register_func('api/statuses/mediap', 'api_statuses_mediap', true, API_METHOD_POST);
1122 * Updates the user’s current status.
1124 * @param string $type Return type (atom, rss, xml, json)
1126 * @return array|string
1127 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-update
1129 function api_statuses_update($type)
1134 if (api_user() === false) {
1135 logger('api_statuses_update: no user');
1136 throw new ForbiddenException();
1141 // convert $_POST array items to the form we use for web posts.
1142 if (requestdata('htmlstatus')) {
1143 $txt = requestdata('htmlstatus');
1144 if ((strpos($txt, '<') !== false) || (strpos($txt, '>') !== false)) {
1145 $txt = html2bb_video($txt);
1147 $config = HTMLPurifier_Config::createDefault();
1148 $config->set('Cache.DefinitionImpl', null);
1150 $purifier = new HTMLPurifier($config);
1151 $txt = $purifier->purify($txt);
1153 $_REQUEST['body'] = HTML::toBBCode($txt);
1156 $_REQUEST['body'] = requestdata('status');
1159 $_REQUEST['title'] = requestdata('title');
1161 $parent = requestdata('in_reply_to_status_id');
1163 // Twidere sends "-1" if it is no reply ...
1164 if ($parent == -1) {
1168 if (ctype_digit($parent)) {
1169 $_REQUEST['parent'] = $parent;
1171 $_REQUEST['parent_uri'] = $parent;
1174 if (requestdata('lat') && requestdata('long')) {
1175 $_REQUEST['coord'] = sprintf("%s %s", requestdata('lat'), requestdata('long'));
1177 $_REQUEST['profile_uid'] = api_user();
1180 $_REQUEST['type'] = 'net-comment';
1182 // Check for throttling (maximum posts per day, week and month)
1183 $throttle_day = Config::get('system', 'throttle_limit_day');
1184 if ($throttle_day > 0) {
1185 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60);
1188 "SELECT COUNT(*) AS `posts_day` FROM `item` WHERE `uid`=%d AND `wall`
1189 AND `created` > '%s' AND `id` = `parent`",
1194 if (DBM::is_result($r)) {
1195 $posts_day = $r[0]["posts_day"];
1200 if ($posts_day > $throttle_day) {
1201 logger('Daily posting limit reached for user '.api_user(), LOGGER_DEBUG);
1202 // die(api_error($type, L10n::t("Daily posting limit of %d posts reached. The post was rejected.", $throttle_day));
1203 throw new TooManyRequestsException(L10n::tt("Daily posting limit of %d post reached. The post was rejected.", "Daily posting limit of %d posts reached. The post was rejected.", $throttle_day));
1207 $throttle_week = Config::get('system', 'throttle_limit_week');
1208 if ($throttle_week > 0) {
1209 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*7);
1212 "SELECT COUNT(*) AS `posts_week` FROM `item` WHERE `uid`=%d AND `wall`
1213 AND `created` > '%s' AND `id` = `parent`",
1218 if (DBM::is_result($r)) {
1219 $posts_week = $r[0]["posts_week"];
1224 if ($posts_week > $throttle_week) {
1225 logger('Weekly posting limit reached for user '.api_user(), LOGGER_DEBUG);
1226 // die(api_error($type, L10n::t("Weekly posting limit of %d posts reached. The post was rejected.", $throttle_week)));
1227 throw new TooManyRequestsException(L10n::tt("Weekly posting limit of %d post reached. The post was rejected.", "Weekly posting limit of %d posts reached. The post was rejected.", $throttle_week));
1231 $throttle_month = Config::get('system', 'throttle_limit_month');
1232 if ($throttle_month > 0) {
1233 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*30);
1236 "SELECT COUNT(*) AS `posts_month` FROM `item` WHERE `uid`=%d AND `wall`
1237 AND `created` > '%s' AND `id` = `parent`",
1242 if (DBM::is_result($r)) {
1243 $posts_month = $r[0]["posts_month"];
1248 if ($posts_month > $throttle_month) {
1249 logger('Monthly posting limit reached for user '.api_user(), LOGGER_DEBUG);
1250 // die(api_error($type, L10n::t("Monthly posting limit of %d posts reached. The post was rejected.", $throttle_month));
1251 throw new TooManyRequestsException(L10n::t("Monthly posting limit of %d post reached. The post was rejected.", "Monthly posting limit of %d posts reached. The post was rejected.", $throttle_month));
1255 $_REQUEST['type'] = 'wall';
1258 if (x($_FILES, 'media')) {
1259 // upload the image if we have one
1260 $_REQUEST['hush'] = 'yeah'; //tell wall_upload function to return img info instead of echo
1261 $media = wall_upload_post($a);
1262 if (strlen($media) > 0) {
1263 $_REQUEST['body'] .= "\n\n" . $media;
1267 // To-Do: Multiple IDs
1268 if (requestdata('media_ids')) {
1270 "SELECT `resource-id`, `scale`, `nickname`, `type` FROM `photo` INNER JOIN `user` ON `user`.`uid` = `photo`.`uid` WHERE `resource-id` IN (SELECT `resource-id` FROM `photo` WHERE `id` = %d) AND `scale` > 0 AND `photo`.`uid` = %d ORDER BY `photo`.`width` DESC LIMIT 1",
1271 intval(requestdata('media_ids')),
1274 if (DBM::is_result($r)) {
1275 $phototypes = Image::supportedTypes();
1276 $ext = $phototypes[$r[0]['type']];
1277 $_REQUEST['body'] .= "\n\n" . '[url=' . System::baseUrl() . '/photos/' . $r[0]['nickname'] . '/image/' . $r[0]['resource-id'] . ']';
1278 $_REQUEST['body'] .= '[img]' . System::baseUrl() . '/photo/' . $r[0]['resource-id'] . '-' . $r[0]['scale'] . '.' . $ext . '[/img][/url]';
1282 // set this so that the item_post() function is quiet and doesn't redirect or emit json
1284 $_REQUEST['api_source'] = true;
1286 if (!x($_REQUEST, "source")) {
1287 $_REQUEST["source"] = api_source();
1290 // call out normal post function
1293 // this should output the last post (the one we just posted).
1294 return api_status_show($type);
1297 /// @TODO move to top of file or somewhere better
1298 api_register_func('api/statuses/update', 'api_statuses_update', true, API_METHOD_POST);
1299 api_register_func('api/statuses/update_with_media', 'api_statuses_update', true, API_METHOD_POST);
1302 * Uploads an image to Friendica.
1305 * @see https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload
1307 function api_media_upload()
1311 if (api_user() === false) {
1313 throw new ForbiddenException();
1318 if (!x($_FILES, 'media')) {
1320 throw new BadRequestException("No media.");
1323 $media = wall_upload_post($a, false);
1326 throw new InternalServerErrorException();
1330 $returndata["media_id"] = $media["id"];
1331 $returndata["media_id_string"] = (string)$media["id"];
1332 $returndata["size"] = $media["size"];
1333 $returndata["image"] = ["w" => $media["width"],
1334 "h" => $media["height"],
1335 "image_type" => $media["type"]];
1337 logger("Media uploaded: " . print_r($returndata, true), LOGGER_DEBUG);
1339 return ["media" => $returndata];
1342 /// @TODO move to top of file or somewhere better
1343 api_register_func('api/media/upload', 'api_media_upload', true, API_METHOD_POST);
1347 * @param string $type Return type (atom, rss, xml, json)
1349 * @return array|string
1351 function api_status_show($type)
1355 $user_info = api_get_user($a);
1357 logger('api_status_show: user_info: '.print_r($user_info, true), LOGGER_DEBUG);
1359 if ($type == "raw") {
1360 $privacy_sql = "AND `item`.`allow_cid`='' AND `item`.`allow_gid`='' AND `item`.`deny_cid`='' AND `item`.`deny_gid`=''";
1365 // get last public wall message
1369 WHERE `item`.`contact-id` = %d AND `item`.`uid` = %d
1370 AND ((`item`.`author-link` IN ('%s', '%s')) OR (`item`.`owner-link` IN ('%s', '%s')))
1371 AND `item`.`type` != 'activity' $privacy_sql
1372 ORDER BY `item`.`id` DESC
1374 intval($user_info['cid']),
1376 dbesc($user_info['url']),
1377 dbesc(normalise_link($user_info['url'])),
1378 dbesc($user_info['url']),
1379 dbesc(normalise_link($user_info['url']))
1382 if (DBM::is_result($lastwall)) {
1383 $lastwall = $lastwall[0];
1385 $in_reply_to = api_in_reply_to($lastwall);
1387 $converted = api_convert_item($lastwall);
1389 if ($type == "xml") {
1390 $geo = "georss:point";
1396 'created_at' => api_date($lastwall['created']),
1397 'id' => intval($lastwall['id']),
1398 'id_str' => (string) $lastwall['id'],
1399 'text' => $converted["text"],
1400 'source' => (($lastwall['app']) ? $lastwall['app'] : 'web'),
1401 'truncated' => false,
1402 'in_reply_to_status_id' => $in_reply_to['status_id'],
1403 'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
1404 'in_reply_to_user_id' => $in_reply_to['user_id'],
1405 'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
1406 'in_reply_to_screen_name' => $in_reply_to['screen_name'],
1407 'user' => $user_info,
1409 'coordinates' => "",
1411 'contributors' => "",
1412 'is_quote_status' => false,
1413 'retweet_count' => 0,
1414 'favorite_count' => 0,
1415 'favorited' => $lastwall['starred'] ? true : false,
1416 'retweeted' => false,
1417 'possibly_sensitive' => false,
1419 'statusnet_html' => $converted["html"],
1420 'statusnet_conversation_id' => $lastwall['parent'],
1421 'external_url' => System::baseUrl() . "/display/" . $lastwall['guid'],
1424 if (count($converted["attachments"]) > 0) {
1425 $status_info["attachments"] = $converted["attachments"];
1428 if (count($converted["entities"]) > 0) {
1429 $status_info["entities"] = $converted["entities"];
1432 if (($lastwall['item_network'] != "") && ($status["source"] == 'web')) {
1433 $status_info["source"] = ContactSelector::networkToName($lastwall['item_network'], $user_info['url']);
1434 } elseif (($lastwall['item_network'] != "") && (ContactSelector::networkToName($lastwall['item_network'], $user_info['url']) != $status_info["source"])) {
1435 $status_info["source"] = trim($status_info["source"].' ('.ContactSelector::networkToName($lastwall['item_network'], $user_info['url']).')');
1438 // "uid" and "self" are only needed for some internal stuff, so remove it from here
1439 unset($status_info["user"]["uid"]);
1440 unset($status_info["user"]["self"]);
1443 logger('status_info: '.print_r($status_info, true), LOGGER_DEBUG);
1445 if ($type == "raw") {
1446 return $status_info;
1449 return api_format_data("statuses", $type, ['status' => $status_info]);
1453 * Returns extended information of a given user, specified by ID or screen name as per the required id parameter.
1454 * The author's most recent status will be returned inline.
1456 * @param string $type Return type (atom, rss, xml, json)
1457 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-show
1459 function api_users_show($type)
1463 $user_info = api_get_user($a);
1467 INNER JOIN `contact` ON `contact`.`id`=`item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
1468 WHERE `item`.`uid` = %d AND `verb` = '%s' AND `item`.`contact-id` = %d
1469 AND ((`item`.`author-link` IN ('%s', '%s')) OR (`item`.`owner-link` IN ('%s', '%s')))
1470 AND `type`!='activity'
1471 AND `item`.`allow_cid`='' AND `item`.`allow_gid`='' AND `item`.`deny_cid`='' AND `item`.`deny_gid`=''
1475 dbesc(ACTIVITY_POST),
1476 intval($user_info['cid']),
1477 dbesc($user_info['url']),
1478 dbesc(normalise_link($user_info['url'])),
1479 dbesc($user_info['url']),
1480 dbesc(normalise_link($user_info['url']))
1483 if (DBM::is_result($lastwall)) {
1484 $lastwall = $lastwall[0];
1486 $in_reply_to = api_in_reply_to($lastwall);
1488 $converted = api_convert_item($lastwall);
1490 if ($type == "xml") {
1491 $geo = "georss:point";
1496 $user_info['status'] = [
1497 'text' => $converted["text"],
1498 'truncated' => false,
1499 'created_at' => api_date($lastwall['created']),
1500 'in_reply_to_status_id' => $in_reply_to['status_id'],
1501 'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
1502 'source' => (($lastwall['app']) ? $lastwall['app'] : 'web'),
1503 'id' => intval($lastwall['contact-id']),
1504 'id_str' => (string) $lastwall['contact-id'],
1505 'in_reply_to_user_id' => $in_reply_to['user_id'],
1506 'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
1507 'in_reply_to_screen_name' => $in_reply_to['screen_name'],
1509 'favorited' => $lastwall['starred'] ? true : false,
1510 'statusnet_html' => $converted["html"],
1511 'statusnet_conversation_id' => $lastwall['parent'],
1512 'external_url' => System::baseUrl() . "/display/" . $lastwall['guid'],
1515 if (count($converted["attachments"]) > 0) {
1516 $user_info["status"]["attachments"] = $converted["attachments"];
1519 if (count($converted["entities"]) > 0) {
1520 $user_info["status"]["entities"] = $converted["entities"];
1523 if (($lastwall['item_network'] != "") && ($user_info["status"]["source"] == 'web')) {
1524 $user_info["status"]["source"] = ContactSelector::networkToName($lastwall['item_network'], $user_info['url']);
1527 if (($lastwall['item_network'] != "") && (ContactSelector::networkToName($lastwall['item_network'], $user_info['url']) != $user_info["status"]["source"])) {
1528 $user_info["status"]["source"] = trim($user_info["status"]["source"] . ' (' . ContactSelector::networkToName($lastwall['item_network'], $user_info['url']) . ')');
1532 // "uid" and "self" are only needed for some internal stuff, so remove it from here
1533 unset($user_info["uid"]);
1534 unset($user_info["self"]);
1536 return api_format_data("user", $type, ['user' => $user_info]);
1539 /// @TODO move to top of file or somewhere better
1540 api_register_func('api/users/show', 'api_users_show');
1541 api_register_func('api/externalprofile/show', 'api_users_show');
1544 * Search a public user account.
1546 * @param string $type Return type (atom, rss, xml, json)
1548 * @return array|string
1549 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-search
1551 function api_users_search($type)
1557 if (x($_GET, 'q')) {
1558 $r = q("SELECT id FROM `contact` WHERE `uid` = 0 AND `name` = '%s'", dbesc($_GET["q"]));
1560 if (!DBM::is_result($r)) {
1561 $r = q("SELECT `id` FROM `contact` WHERE `uid` = 0 AND `nick` = '%s'", dbesc($_GET["q"]));
1564 if (DBM::is_result($r)) {
1566 foreach ($r as $user) {
1567 $user_info = api_get_user($a, $user["id"]);
1569 if ($type == "xml") {
1570 $userlist[$k++.":user"] = $user_info;
1572 $userlist[] = $user_info;
1575 $userlist = ["users" => $userlist];
1577 throw new BadRequestException("User not found.");
1580 throw new BadRequestException("User not found.");
1583 return api_format_data("users", $type, $userlist);
1586 /// @TODO move to top of file or somewhere better
1587 api_register_func('api/users/search', 'api_users_search');
1590 * Return user objects
1592 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-lookup
1594 * @param string $type Return format: json or xml
1596 * @return array|string
1597 * @throws NotFoundException if the results are empty.
1599 function api_users_lookup($type)
1603 if (x($_REQUEST['user_id'])) {
1604 foreach (explode(',', $_REQUEST['user_id']) as $id) {
1606 $users[] = api_get_user(get_app(), $id);
1611 if (empty($users)) {
1612 throw new NotFoundException;
1615 return api_format_data("users", $type, ['users' => $users]);
1618 /// @TODO move to top of file or somewhere better
1619 api_register_func('api/users/lookup', 'api_users_lookup', true);
1622 * Returns statuses that match a specified query.
1624 * @see https://developer.twitter.com/en/docs/tweets/search/api-reference/get-search-tweets
1626 * @param string $type Return format: json, xml, atom, rss
1628 * @return array|string
1629 * @throws BadRequestException if the "q" parameter is missing.
1631 function api_search($type)
1636 if (!x($_REQUEST, 'q')) {
1637 throw new BadRequestException("q parameter is required.");
1640 if (x($_REQUEST, 'rpp')) {
1641 $count = $_REQUEST['rpp'];
1642 } elseif (x($_REQUEST, 'count')) {
1643 $count = $_REQUEST['count'];
1648 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
1649 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
1650 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] - 1 : 0);
1652 $start = $page * $count;
1655 $sql_extra .= ' AND `item`.`id` <= ' . intval($max_id);
1659 "SELECT ".item_fieldlists()."
1660 FROM `item` ".item_joins()."
1661 WHERE ".item_condition()." AND (`item`.`uid` = 0 OR (`item`.`uid` = ? AND NOT `item`.`global`))
1662 AND `item`.`body` LIKE CONCAT('%',?,'%')
1665 ORDER BY `item`.`id` DESC LIMIT ".intval($start)." ,".intval($count)." ",
1671 $data['status'] = api_format_items(dba::inArray($r), api_get_user(get_app()));
1673 return api_format_data("statuses", $type, $data);
1676 /// @TODO move to top of file or somewhere better
1677 api_register_func('api/search/tweets', 'api_search', true);
1678 api_register_func('api/search', 'api_search', true);
1681 * Returns the most recent statuses posted by the user and the users they follow.
1683 * @see https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-home_timeline
1685 * @param string $type Return type (atom, rss, xml, json)
1687 * @todo Optional parameters
1688 * @todo Add reply info
1690 function api_statuses_home_timeline($type)
1694 if (api_user() === false) {
1695 throw new ForbiddenException();
1698 unset($_REQUEST["user_id"]);
1699 unset($_GET["user_id"]);
1701 unset($_REQUEST["screen_name"]);
1702 unset($_GET["screen_name"]);
1704 $user_info = api_get_user($a);
1705 // get last network messages
1708 $count = (x($_REQUEST, 'count') ? $_REQUEST['count'] : 20);
1709 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] - 1 : 0);
1713 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
1714 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
1715 //$since_id = 0;//$since_id = (x($_REQUEST, 'since_id')?$_REQUEST['since_id'] : 0);
1716 $exclude_replies = (x($_REQUEST, 'exclude_replies') ? 1 : 0);
1717 $conversation_id = (x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0);
1719 $start = $page * $count;
1723 $sql_extra .= ' AND `item`.`id` <= ' . intval($max_id);
1725 if ($exclude_replies > 0) {
1726 $sql_extra .= ' AND `item`.`parent` = `item`.`id`';
1728 if ($conversation_id > 0) {
1729 $sql_extra .= ' AND `item`.`parent` = ' . intval($conversation_id);
1733 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`,
1734 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
1735 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
1736 `contact`.`id` AS `cid`
1738 STRAIGHT_JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
1739 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
1740 WHERE `item`.`uid` = %d AND `verb` = '%s'
1741 AND `item`.`visible` AND NOT `item`.`moderated` AND NOT `item`.`deleted`
1744 ORDER BY `item`.`id` DESC LIMIT %d ,%d ",
1746 dbesc(ACTIVITY_POST),
1752 $ret = api_format_items($r, $user_info, false, $type);
1754 // Set all posts from the query above to seen
1756 foreach ($r as $item) {
1757 $idarray[] = intval($item["id"]);
1760 $idlist = implode(",", $idarray);
1762 if ($idlist != "") {
1763 $unseen = q("SELECT `id` FROM `item` WHERE `unseen` AND `id` IN (%s)", $idlist);
1766 q("UPDATE `item` SET `unseen` = 0 WHERE `unseen` AND `id` IN (%s)", $idlist);
1770 $data = ['status' => $ret];
1774 $data = api_rss_extra($a, $data, $user_info);
1778 return api_format_data("statuses", $type, $data);
1781 /// @TODO move to top of file or somewhere better
1782 api_register_func('api/statuses/home_timeline', 'api_statuses_home_timeline', true);
1783 api_register_func('api/statuses/friends_timeline', 'api_statuses_home_timeline', true);
1786 * Returns the most recent statuses from public users.
1788 * @param string $type Return type (atom, rss, xml, json)
1790 * @return array|string
1792 function api_statuses_public_timeline($type)
1796 if (api_user() === false) {
1797 throw new ForbiddenException();
1800 $user_info = api_get_user($a);
1801 // get last network messages
1804 $count = (x($_REQUEST, 'count') ? $_REQUEST['count'] : 20);
1805 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] -1 : 0);
1809 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
1810 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
1811 //$since_id = 0;//$since_id = (x($_REQUEST, 'since_id')?$_REQUEST['since_id'] : 0);
1812 $exclude_replies = (x($_REQUEST, 'exclude_replies') ? 1 : 0);
1813 $conversation_id = (x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0);
1815 $start = $page * $count;
1818 if ($exclude_replies && !$conversation_id) {
1820 $sql_extra = 'AND `thread`.`iid` <= ' . intval($max_id);
1824 "SELECT " . item_fieldlists() . "
1826 STRAIGHT_JOIN `item` ON `item`.`id` = `thread`.`iid`
1827 " . item_joins() . "
1828 STRAIGHT_JOIN `user` ON `user`.`uid` = `thread`.`uid`
1829 AND NOT `user`.`hidewall`
1831 AND NOT `thread`.`private`
1833 AND `thread`.`visible`
1834 AND NOT `thread`.`deleted`
1835 AND NOT `thread`.`moderated`
1836 AND `thread`.`iid` > ?
1838 ORDER BY `thread`.`iid` DESC
1839 LIMIT " . intval($start) . ", " . intval($count),
1844 $r = dba::inArray($r);
1847 $sql_extra = 'AND `item`.`id` <= ' . intval($max_id);
1849 if ($conversation_id > 0) {
1850 $sql_extra .= ' AND `item`.`parent` = ' . intval($conversation_id);
1854 "SELECT " . item_fieldlists() . "
1856 " . item_joins() . "
1857 STRAIGHT_JOIN `user` ON `user`.`uid` = `item`.`uid`
1858 AND NOT `user`.`hidewall`
1860 AND NOT `item`.`private`
1862 AND `item`.`visible`
1863 AND NOT `item`.`deleted`
1864 AND NOT `item`.`moderated`
1867 ORDER BY `item`.`id` DESC
1868 LIMIT " . intval($start) . ", " . intval($count),
1873 $r = dba::inArray($r);
1876 $ret = api_format_items($r, $user_info, false, $type);
1878 $data = ['status' => $ret];
1882 $data = api_rss_extra($a, $data, $user_info);
1886 return api_format_data("statuses", $type, $data);
1889 /// @TODO move to top of file or somewhere better
1890 api_register_func('api/statuses/public_timeline', 'api_statuses_public_timeline', true);
1893 * Returns the most recent statuses posted by users this node knows about.
1895 * @brief Returns the list of public federated posts this node knows about
1897 * @param string $type Return format: json, xml, atom, rss
1898 * @return array|string
1899 * @throws ForbiddenException
1901 function api_statuses_networkpublic_timeline($type)
1905 if (api_user() === false) {
1906 throw new ForbiddenException();
1909 $user_info = api_get_user($a);
1911 $since_id = x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0;
1912 $max_id = x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0;
1915 $count = x($_REQUEST, 'count') ? $_REQUEST['count'] : 20;
1916 $page = x($_REQUEST, 'page') ? $_REQUEST['page'] : 1;
1920 $start = ($page - 1) * $count;
1924 $sql_extra = 'AND `thread`.`iid` <= ' . intval($max_id);
1928 "SELECT " . item_fieldlists() . "
1930 STRAIGHT_JOIN `item` ON `item`.`id` = `thread`.`iid`
1931 " . item_joins() . "
1932 WHERE `thread`.`uid` = 0
1934 AND NOT `thread`.`private`
1935 AND `thread`.`visible`
1936 AND NOT `thread`.`deleted`
1937 AND NOT `thread`.`moderated`
1938 AND `thread`.`iid` > ?
1940 ORDER BY `thread`.`iid` DESC
1941 LIMIT " . intval($start) . ", " . intval($count),
1946 $r = dba::inArray($r);
1948 $ret = api_format_items($r, $user_info, false, $type);
1950 $data = ['status' => $ret];
1954 $data = api_rss_extra($a, $data, $user_info);
1958 return api_format_data("statuses", $type, $data);
1961 /// @TODO move to top of file or somewhere better
1962 api_register_func('api/statuses/networkpublic_timeline', 'api_statuses_networkpublic_timeline', true);
1965 * Returns a single status.
1967 * @param string $type Return type (atom, rss, xml, json)
1969 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-statuses-show-id
1971 function api_statuses_show($type)
1975 if (api_user() === false) {
1976 throw new ForbiddenException();
1979 $user_info = api_get_user($a);
1982 $id = intval($a->argv[3]);
1985 $id = intval($_REQUEST["id"]);
1990 $id = intval($a->argv[4]);
1993 logger('API: api_statuses_show: ' . $id);
1995 $conversation = (x($_REQUEST, 'conversation') ? 1 : 0);
1998 if ($conversation) {
1999 $sql_extra .= " AND `item`.`parent` = %d ORDER BY `id` ASC ";
2001 $sql_extra .= " AND `item`.`id` = %d";
2005 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`,
2006 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
2007 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
2008 `contact`.`id` AS `cid`
2010 INNER JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
2011 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
2012 WHERE `item`.`visible` AND NOT `item`.`moderated` AND NOT `item`.`deleted`
2013 AND `item`.`uid` = %d AND `item`.`verb` = '%s'
2016 dbesc(ACTIVITY_POST),
2020 /// @TODO How about copying this to above methods which don't check $r ?
2021 if (!DBM::is_result($r)) {
2022 throw new BadRequestException("There is no status with this id.");
2025 $ret = api_format_items($r, $user_info, false, $type);
2027 if ($conversation) {
2028 $data = ['status' => $ret];
2029 return api_format_data("statuses", $type, $data);
2031 $data = ['status' => $ret[0]];
2032 return api_format_data("status", $type, $data);
2036 /// @TODO move to top of file or somewhere better
2037 api_register_func('api/statuses/show', 'api_statuses_show', true);
2041 * @param string $type Return type (atom, rss, xml, json)
2043 * @todo nothing to say?
2045 function api_conversation_show($type)
2049 if (api_user() === false) {
2050 throw new ForbiddenException();
2053 $user_info = api_get_user($a);
2056 $id = intval($a->argv[3]);
2057 $count = (x($_REQUEST, 'count') ? $_REQUEST['count'] : 20);
2058 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] - 1 : 0);
2062 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
2063 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
2065 $start = $page*$count;
2068 $id = intval($_REQUEST["id"]);
2073 $id = intval($a->argv[4]);
2076 logger('API: api_conversation_show: '.$id);
2078 $r = q("SELECT `parent` FROM `item` WHERE `id` = %d", intval($id));
2079 if (DBM::is_result($r)) {
2080 $id = $r[0]["parent"];
2086 $sql_extra = ' AND `item`.`id` <= ' . intval($max_id);
2089 // Not sure why this query was so complicated. We should keep it here for a while,
2090 // just to make sure that we really don't need it.
2091 // FROM `item` INNER JOIN (SELECT `uri`,`parent` FROM `item` WHERE `id` = %d) AS `temp1`
2092 // ON (`item`.`thr-parent` = `temp1`.`uri` AND `item`.`parent` = `temp1`.`parent`)
2095 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`,
2096 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
2097 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
2098 `contact`.`id` AS `cid`
2100 STRAIGHT_JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
2101 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
2102 WHERE `item`.`parent` = %d AND `item`.`visible`
2103 AND NOT `item`.`moderated` AND NOT `item`.`deleted`
2104 AND `item`.`uid` = %d AND `item`.`verb` = '%s'
2105 AND `item`.`id`>%d $sql_extra
2106 ORDER BY `item`.`id` DESC LIMIT %d ,%d",
2109 dbesc(ACTIVITY_POST),
2115 if (!DBM::is_result($r)) {
2116 throw new BadRequestException("There is no status with this id.");
2119 $ret = api_format_items($r, $user_info, false, $type);
2121 $data = ['status' => $ret];
2122 return api_format_data("statuses", $type, $data);
2125 /// @TODO move to top of file or somewhere better
2126 api_register_func('api/conversation/show', 'api_conversation_show', true);
2127 api_register_func('api/statusnet/conversation', 'api_conversation_show', true);
2132 * @param string $type Return type (atom, rss, xml, json)
2134 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-retweet-id
2136 function api_statuses_repeat($type)
2142 if (api_user() === false) {
2143 throw new ForbiddenException();
2149 $id = intval($a->argv[3]);
2152 $id = intval($_REQUEST["id"]);
2157 $id = intval($a->argv[4]);
2160 logger('API: api_statuses_repeat: '.$id);
2163 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`, `contact`.`nick` as `reply_author`,
2164 `contact`.`name`, `contact`.`photo` as `reply_photo`, `contact`.`url` as `reply_url`, `contact`.`rel`,
2165 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
2166 `contact`.`id` AS `cid`
2168 INNER JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
2169 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
2170 WHERE `item`.`visible` AND NOT `item`.`moderated` AND NOT `item`.`deleted`
2171 AND NOT `item`.`private` AND `item`.`allow_cid` = '' AND `item`.`allow_gid` = ''
2172 AND `item`.`deny_cid` = '' AND `item`.`deny_gid` = ''
2173 AND `item`.`id`=%d",
2177 /// @TODO other style than above functions!
2178 if (DBM::is_result($r) && $r[0]['body'] != "") {
2179 if (strpos($r[0]['body'], "[/share]") !== false) {
2180 $pos = strpos($r[0]['body'], "[share");
2181 $post = substr($r[0]['body'], $pos);
2183 $post = share_header($r[0]['author-name'], $r[0]['author-link'], $r[0]['author-avatar'], $r[0]['guid'], $r[0]['created'], $r[0]['plink']);
2185 $post .= $r[0]['body'];
2186 $post .= "[/share]";
2188 $_REQUEST['body'] = $post;
2189 $_REQUEST['profile_uid'] = api_user();
2190 $_REQUEST['type'] = 'wall';
2191 $_REQUEST['api_source'] = true;
2193 if (!x($_REQUEST, "source")) {
2194 $_REQUEST["source"] = api_source();
2199 throw new ForbiddenException();
2202 // this should output the last post (the one we just posted).
2204 return api_status_show($type);
2207 /// @TODO move to top of file or somewhere better
2208 api_register_func('api/statuses/retweet', 'api_statuses_repeat', true, API_METHOD_POST);
2211 * Destroys a specific status.
2213 * @param string $type Return type (atom, rss, xml, json)
2215 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-destroy-id
2217 function api_statuses_destroy($type)
2221 if (api_user() === false) {
2222 throw new ForbiddenException();
2228 $id = intval($a->argv[3]);
2231 $id = intval($_REQUEST["id"]);
2236 $id = intval($a->argv[4]);
2239 logger('API: api_statuses_destroy: '.$id);
2241 $ret = api_statuses_show($type);
2243 Item::deleteById($id);
2248 /// @TODO move to top of file or somewhere better
2249 api_register_func('api/statuses/destroy', 'api_statuses_destroy', true, API_METHOD_DELETE);
2252 * Returns the most recent mentions.
2254 * @param string $type Return type (atom, rss, xml, json)
2256 * @see http://developer.twitter.com/doc/get/statuses/mentions
2258 function api_statuses_mentions($type)
2262 if (api_user() === false) {
2263 throw new ForbiddenException();
2266 unset($_REQUEST["user_id"]);
2267 unset($_GET["user_id"]);
2269 unset($_REQUEST["screen_name"]);
2270 unset($_GET["screen_name"]);
2272 $user_info = api_get_user($a);
2273 // get last network messages
2277 $since_id = defaults($_REQUEST, 'since_id', 0);
2278 $max_id = defaults($_REQUEST, 'max_id' , 0);
2279 $count = defaults($_REQUEST, 'count' , 20);
2280 $page = defaults($_REQUEST, 'page' , 1);
2285 $start = ($page - 1) * $count;
2287 // Ugly code - should be changed
2288 $myurl = System::baseUrl() . '/profile/'. $a->user['nickname'];
2289 $myurl = substr($myurl, strpos($myurl, '://') + 3);
2290 $myurl = str_replace('www.', '', $myurl);
2295 $sql_extra .= ' AND `item`.`id` <= ' . intval($max_id);
2299 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`,
2300 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
2301 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
2302 `contact`.`id` AS `cid`
2303 FROM `item` FORCE INDEX (`uid_id`)
2304 STRAIGHT_JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
2305 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
2306 WHERE `item`.`uid` = %d AND `verb` = '%s'
2307 AND NOT (`item`.`author-link` IN ('https://%s', 'http://%s'))
2308 AND `item`.`visible` AND NOT `item`.`moderated` AND NOT `item`.`deleted`
2309 AND `item`.`parent` IN (SELECT `iid` FROM `thread` WHERE `uid` = %d AND `mention` AND !`ignored`)
2312 ORDER BY `item`.`id` DESC LIMIT %d ,%d ",
2314 dbesc(ACTIVITY_POST),
2315 dbesc(protect_sprintf($myurl)),
2316 dbesc(protect_sprintf($myurl)),
2323 $ret = api_format_items($r, $user_info, false, $type);
2325 $data = ['status' => $ret];
2329 $data = api_rss_extra($a, $data, $user_info);
2333 return api_format_data("statuses", $type, $data);
2336 /// @TODO move to top of file or somewhere better
2337 api_register_func('api/statuses/mentions', 'api_statuses_mentions', true);
2338 api_register_func('api/statuses/replies', 'api_statuses_mentions', true);
2341 * Returns the most recent statuses posted by the user.
2343 * @brief Returns a user's public timeline
2345 * @param string $type Either "json" or "xml"
2346 * @return string|array
2347 * @throws ForbiddenException
2348 * @see https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-user_timeline
2350 function api_statuses_user_timeline($type)
2354 if (api_user() === false) {
2355 throw new ForbiddenException();
2358 $user_info = api_get_user($a);
2361 "api_statuses_user_timeline: api_user: ". api_user() .
2362 "\nuser_info: ".print_r($user_info, true) .
2363 "\n_REQUEST: ".print_r($_REQUEST, true),
2367 $since_id = x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0;
2368 $max_id = x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0;
2369 $exclude_replies = x($_REQUEST, 'exclude_replies') ? 1 : 0;
2370 $conversation_id = x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0;
2373 $count = x($_REQUEST, 'count') ? $_REQUEST['count'] : 20;
2374 $page = x($_REQUEST, 'page') ? $_REQUEST['page'] : 1;
2378 $start = ($page - 1) * $count;
2381 if ($user_info['self'] == 1) {
2382 $sql_extra .= " AND `item`.`wall` = 1 ";
2385 if ($exclude_replies > 0) {
2386 $sql_extra .= ' AND `item`.`parent` = `item`.`id`';
2389 if ($conversation_id > 0) {
2390 $sql_extra .= ' AND `item`.`parent` = ' . intval($conversation_id);
2394 $sql_extra .= ' AND `item`.`id` <= ' . intval($max_id);
2398 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`,
2399 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
2400 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
2401 `contact`.`id` AS `cid`
2402 FROM `item` FORCE INDEX (`uid_contactid_id`)
2403 STRAIGHT_JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
2404 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
2405 WHERE `item`.`uid` = %d AND `verb` = '%s'
2406 AND `item`.`contact-id` = %d
2407 AND `item`.`visible` AND NOT `item`.`moderated` AND NOT `item`.`deleted`
2409 AND `item`.`id` > %d
2410 ORDER BY `item`.`id` DESC LIMIT %d ,%d ",
2412 dbesc(ACTIVITY_POST),
2413 intval($user_info['cid']),
2419 $ret = api_format_items($r, $user_info, true, $type);
2421 $data = ['status' => $ret];
2425 $data = api_rss_extra($a, $data, $user_info);
2429 return api_format_data("statuses", $type, $data);
2432 /// @TODO move to top of file or somewhere better
2433 api_register_func('api/statuses/user_timeline', 'api_statuses_user_timeline', true);
2436 * Star/unstar an item.
2437 * param: id : id of the item
2439 * @param string $type Return type (atom, rss, xml, json)
2441 * @see https://web.archive.org/web/20131019055350/https://dev.twitter.com/docs/api/1/post/favorites/create/%3Aid
2443 function api_favorites_create_destroy($type)
2447 if (api_user() === false) {
2448 throw new ForbiddenException();
2451 // for versioned api.
2452 /// @TODO We need a better global soluton
2453 $action_argv_id = 2;
2454 if ($a->argv[1] == "1.1") {
2455 $action_argv_id = 3;
2458 if ($a->argc <= $action_argv_id) {
2459 throw new BadRequestException("Invalid request.");
2461 $action = str_replace("." . $type, "", $a->argv[$action_argv_id]);
2462 if ($a->argc == $action_argv_id + 2) {
2463 $itemid = intval($a->argv[$action_argv_id + 1]);
2465 /// @TODO use x() to check if _REQUEST contains 'id'
2466 $itemid = intval($_REQUEST['id']);
2469 $item = q("SELECT * FROM `item` WHERE `id`=%d AND `uid`=%d LIMIT 1", $itemid, api_user());
2471 if (!DBM::is_result($item) || count($item) == 0) {
2472 throw new BadRequestException("Invalid item.");
2477 $item[0]['starred'] = 1;
2480 $item[0]['starred'] = 0;
2483 throw new BadRequestException("Invalid action ".$action);
2486 $r = Item::update(['starred' => $item[0]['starred']], ['id' => $itemid]);
2489 throw new InternalServerErrorException("DB error");
2493 $user_info = api_get_user($a);
2494 $rets = api_format_items($item, $user_info, false, $type);
2497 $data = ['status' => $ret];
2501 $data = api_rss_extra($a, $data, $user_info);
2504 return api_format_data("status", $type, $data);
2507 /// @TODO move to top of file or somewhere better
2508 api_register_func('api/favorites/create', 'api_favorites_create_destroy', true, API_METHOD_POST);
2509 api_register_func('api/favorites/destroy', 'api_favorites_create_destroy', true, API_METHOD_DELETE);
2512 * Returns the most recent favorite statuses.
2514 * @param string $type Return type (atom, rss, xml, json)
2516 * @return string|array
2518 function api_favorites($type)
2524 if (api_user() === false) {
2525 throw new ForbiddenException();
2530 $user_info = api_get_user($a);
2532 // in friendica starred item are private
2533 // return favorites only for self
2534 logger('api_favorites: self:' . $user_info['self']);
2536 if ($user_info['self'] == 0) {
2542 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
2543 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
2544 $count = (x($_GET, 'count') ? $_GET['count'] : 20);
2545 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] -1 : 0);
2550 $start = $page*$count;
2553 $sql_extra .= ' AND `item`.`id` <= ' . intval($max_id);
2557 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`,
2558 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
2559 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
2560 `contact`.`id` AS `cid`
2561 FROM `item`, `contact`
2562 WHERE `item`.`uid` = %d
2563 AND `item`.`visible` = 1 AND `item`.`moderated` = 0 AND `item`.`deleted` = 0
2564 AND `item`.`starred` = 1
2565 AND `contact`.`id` = `item`.`contact-id`
2566 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
2569 ORDER BY `item`.`id` DESC LIMIT %d ,%d ",
2576 $ret = api_format_items($r, $user_info, false, $type);
2579 $data = ['status' => $ret];
2583 $data = api_rss_extra($a, $data, $user_info);
2586 return api_format_data("statuses", $type, $data);
2589 /// @TODO move to top of file or somewhere better
2590 api_register_func('api/favorites', 'api_favorites', true);
2594 * @param array $item
2595 * @param array $recipient
2596 * @param array $sender
2600 function api_format_messages($item, $recipient, $sender)
2602 // standard meta information
2604 'id' => $item['id'],
2605 'sender_id' => $sender['id'] ,
2607 'recipient_id' => $recipient['id'],
2608 'created_at' => api_date($item['created']),
2609 'sender_screen_name' => $sender['screen_name'],
2610 'recipient_screen_name' => $recipient['screen_name'],
2611 'sender' => $sender,
2612 'recipient' => $recipient,
2614 'friendica_seen' => $item['seen'],
2615 'friendica_parent_uri' => $item['parent-uri'],
2618 // "uid" and "self" are only needed for some internal stuff, so remove it from here
2619 unset($ret["sender"]["uid"]);
2620 unset($ret["sender"]["self"]);
2621 unset($ret["recipient"]["uid"]);
2622 unset($ret["recipient"]["self"]);
2624 //don't send title to regular StatusNET requests to avoid confusing these apps
2625 if (x($_GET, 'getText')) {
2626 $ret['title'] = $item['title'];
2627 if ($_GET['getText'] == 'html') {
2628 $ret['text'] = BBCode::convert($item['body'], false);
2629 } elseif ($_GET['getText'] == 'plain') {
2630 $ret['text'] = trim(HTML::toPlaintext(BBCode::convert(api_clean_plain_items($item['body']), false, 2, true), 0));
2633 $ret['text'] = $item['title'] . "\n" . HTML::toPlaintext(BBCode::convert(api_clean_plain_items($item['body']), false, 2, true), 0);
2635 if (x($_GET, 'getUserObjects') && $_GET['getUserObjects'] == 'false') {
2636 unset($ret['sender']);
2637 unset($ret['recipient']);
2645 * @param array $item
2649 function api_convert_item($item)
2651 $body = $item['body'];
2652 $attachments = api_get_attachments($body);
2654 // Workaround for ostatus messages where the title is identically to the body
2655 $html = BBCode::convert(api_clean_plain_items($body), false, 2, true);
2656 $statusbody = trim(HTML::toPlaintext($html, 0));
2658 // handle data: images
2659 $statusbody = api_format_items_embeded_images($item, $statusbody);
2661 $statustitle = trim($item['title']);
2663 if (($statustitle != '') && (strpos($statusbody, $statustitle) !== false)) {
2664 $statustext = trim($statusbody);
2666 $statustext = trim($statustitle."\n\n".$statusbody);
2669 if (($item["network"] == NETWORK_FEED) && (strlen($statustext)> 1000)) {
2670 $statustext = substr($statustext, 0, 1000)."... \n".$item["plink"];
2673 $statushtml = BBCode::convert(api_clean_attachments($body), false);
2675 // Workaround for clients with limited HTML parser functionality
2676 $search = ["<br>", "<blockquote>", "</blockquote>",
2677 "<h1>", "</h1>", "<h2>", "</h2>",
2678 "<h3>", "</h3>", "<h4>", "</h4>",
2679 "<h5>", "</h5>", "<h6>", "</h6>"];
2680 $replace = ["<br>", "<br><blockquote>", "</blockquote><br>",
2681 "<br><h1>", "</h1><br>", "<br><h2>", "</h2><br>",
2682 "<br><h3>", "</h3><br>", "<br><h4>", "</h4><br>",
2683 "<br><h5>", "</h5><br>", "<br><h6>", "</h6><br>"];
2684 $statushtml = str_replace($search, $replace, $statushtml);
2686 if ($item['title'] != "") {
2687 $statushtml = "<br><h4>" . BBCode::convert($item['title']) . "</h4><br>" . $statushtml;
2691 $oldtext = $statushtml;
2692 $statushtml = str_replace("<br><br>", "<br>", $statushtml);
2693 } while ($oldtext != $statushtml);
2695 if (substr($statushtml, 0, 4) == '<br>') {
2696 $statushtml = substr($statushtml, 4);
2699 if (substr($statushtml, 0, -4) == '<br>') {
2700 $statushtml = substr($statushtml, -4);
2703 // feeds without body should contain the link
2704 if (($item['network'] == NETWORK_FEED) && (strlen($item['body']) == 0)) {
2705 $statushtml .= BBCode::convert($item['plink']);
2708 $entities = api_get_entitities($statustext, $body);
2711 "text" => $statustext,
2712 "html" => $statushtml,
2713 "attachments" => $attachments,
2714 "entities" => $entities
2720 * @param string $body
2722 * @return array|false
2724 function api_get_attachments(&$body)
2727 $text = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $text);
2729 $URLSearchString = "^\[\]";
2730 $ret = preg_match_all("/\[img\]([$URLSearchString]*)\[\/img\]/ism", $text, $images);
2738 foreach ($images[1] as $image) {
2739 $imagedata = Image::getInfoFromURL($image);
2742 $attachments[] = ["url" => $image, "mimetype" => $imagedata["mime"], "size" => $imagedata["size"]];
2746 if (strstr($_SERVER['HTTP_USER_AGENT'], "AndStatus")) {
2747 foreach ($images[0] as $orig) {
2748 $body = str_replace($orig, "", $body);
2752 return $attachments;
2757 * @param string $text
2758 * @param string $bbcode
2761 * @todo Links at the first character of the post
2763 function api_get_entitities(&$text, $bbcode)
2765 $include_entities = strtolower(x($_REQUEST, 'include_entities') ? $_REQUEST['include_entities'] : "false");
2767 if ($include_entities != "true") {
2768 preg_match_all("/\[img](.*?)\[\/img\]/ism", $bbcode, $images);
2770 foreach ($images[1] as $image) {
2771 $replace = proxy_url($image);
2772 $text = str_replace($image, $replace, $text);
2777 $bbcode = BBCode::cleanPictureLinks($bbcode);
2779 // Change pure links in text to bbcode uris
2780 $bbcode = preg_replace("/([^\]\='".'"'."]|^)(https?\:\/\/[a-zA-Z0-9\:\/\-\?\&\;\.\=\_\~\#\%\$\!\+\,]+)/ism", '$1[url=$2]$2[/url]', $bbcode);
2783 $entities["hashtags"] = [];
2784 $entities["symbols"] = [];
2785 $entities["urls"] = [];
2786 $entities["user_mentions"] = [];
2788 $URLSearchString = "^\[\]";
2790 $bbcode = preg_replace("/#\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '#$2', $bbcode);
2792 $bbcode = preg_replace("/\[bookmark\=([$URLSearchString]*)\](.*?)\[\/bookmark\]/ism", '[url=$1]$2[/url]', $bbcode);
2793 //$bbcode = preg_replace("/\[url\](.*?)\[\/url\]/ism",'[url=$1]$1[/url]',$bbcode);
2794 $bbcode = preg_replace("/\[video\](.*?)\[\/video\]/ism", '[url=$1]$1[/url]', $bbcode);
2796 $bbcode = preg_replace(
2797 "/\[youtube\]([A-Za-z0-9\-_=]+)(.*?)\[\/youtube\]/ism",
2798 '[url=https://www.youtube.com/watch?v=$1]https://www.youtube.com/watch?v=$1[/url]',
2801 $bbcode = preg_replace("/\[youtube\](.*?)\[\/youtube\]/ism", '[url=$1]$1[/url]', $bbcode);
2803 $bbcode = preg_replace(
2804 "/\[vimeo\]([0-9]+)(.*?)\[\/vimeo\]/ism",
2805 '[url=https://vimeo.com/$1]https://vimeo.com/$1[/url]',
2808 $bbcode = preg_replace("/\[vimeo\](.*?)\[\/vimeo\]/ism", '[url=$1]$1[/url]', $bbcode);
2810 $bbcode = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $bbcode);
2812 //preg_match_all("/\[url\]([$URLSearchString]*)\[\/url\]/ism", $bbcode, $urls1);
2813 preg_match_all("/\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", $bbcode, $urls);
2816 foreach ($urls[1] as $id => $url) {
2817 //$start = strpos($text, $url, $offset);
2818 $start = iconv_strpos($text, $url, 0, "UTF-8");
2819 if (!($start === false)) {
2820 $ordered_urls[$start] = ["url" => $url, "title" => $urls[2][$id]];
2824 ksort($ordered_urls);
2827 //foreach ($urls[1] AS $id=>$url) {
2828 foreach ($ordered_urls as $url) {
2829 if ((substr($url["title"], 0, 7) != "http://") && (substr($url["title"], 0, 8) != "https://")
2830 && !strpos($url["title"], "http://") && !strpos($url["title"], "https://")
2832 $display_url = $url["title"];
2834 $display_url = str_replace(["http://www.", "https://www."], ["", ""], $url["url"]);
2835 $display_url = str_replace(["http://", "https://"], ["", ""], $display_url);
2837 if (strlen($display_url) > 26) {
2838 $display_url = substr($display_url, 0, 25)."…";
2842 //$start = strpos($text, $url, $offset);
2843 $start = iconv_strpos($text, $url["url"], $offset, "UTF-8");
2844 if (!($start === false)) {
2845 $entities["urls"][] = ["url" => $url["url"],
2846 "expanded_url" => $url["url"],
2847 "display_url" => $display_url,
2848 "indices" => [$start, $start+strlen($url["url"])]];
2849 $offset = $start + 1;
2853 preg_match_all("/\[img](.*?)\[\/img\]/ism", $bbcode, $images);
2854 $ordered_images = [];
2855 foreach ($images[1] as $image) {
2856 //$start = strpos($text, $url, $offset);
2857 $start = iconv_strpos($text, $image, 0, "UTF-8");
2858 if (!($start === false)) {
2859 $ordered_images[$start] = $image;
2862 //$entities["media"] = array();
2865 foreach ($ordered_images as $url) {
2866 $display_url = str_replace(["http://www.", "https://www."], ["", ""], $url);
2867 $display_url = str_replace(["http://", "https://"], ["", ""], $display_url);
2869 if (strlen($display_url) > 26) {
2870 $display_url = substr($display_url, 0, 25)."…";
2873 $start = iconv_strpos($text, $url, $offset, "UTF-8");
2874 if (!($start === false)) {
2875 $image = Image::getInfoFromURL($url);
2877 // If image cache is activated, then use the following sizes:
2878 // thumb (150), small (340), medium (600) and large (1024)
2879 if (!Config::get("system", "proxy_disabled")) {
2880 $media_url = proxy_url($url);
2883 $scale = Image::getScalingDimensions($image[0], $image[1], 150);
2884 $sizes["thumb"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2886 if (($image[0] > 150) || ($image[1] > 150)) {
2887 $scale = Image::getScalingDimensions($image[0], $image[1], 340);
2888 $sizes["small"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2891 $scale = Image::getScalingDimensions($image[0], $image[1], 600);
2892 $sizes["medium"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2894 if (($image[0] > 600) || ($image[1] > 600)) {
2895 $scale = Image::getScalingDimensions($image[0], $image[1], 1024);
2896 $sizes["large"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2900 $sizes["medium"] = ["w" => $image[0], "h" => $image[1], "resize" => "fit"];
2903 $entities["media"][] = [
2905 "id_str" => (string)$start+1,
2906 "indices" => [$start, $start+strlen($url)],
2907 "media_url" => normalise_link($media_url),
2908 "media_url_https" => $media_url,
2910 "display_url" => $display_url,
2911 "expanded_url" => $url,
2915 $offset = $start + 1;
2924 * @param array $item
2925 * @param string $text
2929 function api_format_items_embeded_images($item, $text)
2931 $text = preg_replace_callback(
2932 '|data:image/([^;]+)[^=]+=*|m',
2933 function () use ($item) {
2934 return System::baseUrl() . '/display/' . $item['guid'];
2942 * @brief return <a href='url'>name</a> as array
2944 * @param string $txt text
2949 function api_contactlink_to_array($txt)
2952 $r = preg_match_all('|<a href="([^"]*)">([^<]*)</a>|', $txt, $match);
2953 if ($r && count($match)==3) {
2955 'name' => $match[2],
2969 * @brief return likes, dislikes and attend status for item
2971 * @param array $item array
2972 * @param string $type Return type (atom, rss, xml, json)
2975 * likes => int count,
2976 * dislikes => int count
2978 function api_format_items_activities(&$item, $type = "json")
2987 'attendmaybe' => [],
2992 WHERE uid=%d AND `thr-parent`="%s" AND visible AND NOT deleted',
2993 intval($item['uid']),
2997 foreach ($items as $i) {
2998 // not used as result should be structured like other user data
2999 //builtin_activity_puller($i, $activities);
3001 // get user data and add it to the array of the activity
3002 $user = api_get_user($a, $i['author-link']);
3003 switch ($i['verb']) {
3005 $activities['like'][] = $user;
3007 case ACTIVITY_DISLIKE:
3008 $activities['dislike'][] = $user;
3010 case ACTIVITY_ATTEND:
3011 $activities['attendyes'][] = $user;
3013 case ACTIVITY_ATTENDNO:
3014 $activities['attendno'][] = $user;
3016 case ACTIVITY_ATTENDMAYBE:
3017 $activities['attendmaybe'][] = $user;
3024 if ($type == "xml") {
3025 $xml_activities = [];
3026 foreach ($activities as $k => $v) {
3027 // change xml element from "like" to "friendica:like"
3028 $xml_activities["friendica:".$k] = $v;
3029 // add user data into xml output
3031 foreach ($v as $user) {
3032 $xml_activities["friendica:".$k][$k_user++.":user"] = $user;
3035 $activities = $xml_activities;
3043 * @brief return data from profiles
3045 * @param array $profile_row array containing data from db table 'profile'
3048 function api_format_items_profiles($profile_row)
3051 'profile_id' => $profile_row['id'],
3052 'profile_name' => $profile_row['profile-name'],
3053 'is_default' => $profile_row['is-default'] ? true : false,
3054 'hide_friends' => $profile_row['hide-friends'] ? true : false,
3055 'profile_photo' => $profile_row['photo'],
3056 'profile_thumb' => $profile_row['thumb'],
3057 'publish' => $profile_row['publish'] ? true : false,
3058 'net_publish' => $profile_row['net-publish'] ? true : false,
3059 'description' => $profile_row['pdesc'],
3060 'date_of_birth' => $profile_row['dob'],
3061 'address' => $profile_row['address'],
3062 'city' => $profile_row['locality'],
3063 'region' => $profile_row['region'],
3064 'postal_code' => $profile_row['postal-code'],
3065 'country' => $profile_row['country-name'],
3066 'hometown' => $profile_row['hometown'],
3067 'gender' => $profile_row['gender'],
3068 'marital' => $profile_row['marital'],
3069 'marital_with' => $profile_row['with'],
3070 'marital_since' => $profile_row['howlong'],
3071 'sexual' => $profile_row['sexual'],
3072 'politic' => $profile_row['politic'],
3073 'religion' => $profile_row['religion'],
3074 'public_keywords' => $profile_row['pub_keywords'],
3075 'private_keywords' => $profile_row['prv_keywords'],
3076 'likes' => BBCode::convert(api_clean_plain_items($profile_row['likes']) , false, 2),
3077 'dislikes' => BBCode::convert(api_clean_plain_items($profile_row['dislikes']) , false, 2),
3078 'about' => BBCode::convert(api_clean_plain_items($profile_row['about']) , false, 2),
3079 'music' => BBCode::convert(api_clean_plain_items($profile_row['music']) , false, 2),
3080 'book' => BBCode::convert(api_clean_plain_items($profile_row['book']) , false, 2),
3081 'tv' => BBCode::convert(api_clean_plain_items($profile_row['tv']) , false, 2),
3082 'film' => BBCode::convert(api_clean_plain_items($profile_row['film']) , false, 2),
3083 'interest' => BBCode::convert(api_clean_plain_items($profile_row['interest']) , false, 2),
3084 'romance' => BBCode::convert(api_clean_plain_items($profile_row['romance']) , false, 2),
3085 'work' => BBCode::convert(api_clean_plain_items($profile_row['work']) , false, 2),
3086 'education' => BBCode::convert(api_clean_plain_items($profile_row['education']), false, 2),
3087 'social_networks' => BBCode::convert(api_clean_plain_items($profile_row['contact']) , false, 2),
3088 'homepage' => $profile_row['homepage'],
3095 * @brief format items to be returned by api
3097 * @param array $r array of items
3098 * @param array $user_info
3099 * @param bool $filter_user filter items by $user_info
3100 * @param string $type Return type (atom, rss, xml, json)
3102 function api_format_items($r, $user_info, $filter_user = false, $type = "json")
3108 foreach ($r as $item) {
3109 localize_item($item);
3110 list($status_user, $owner_user) = api_item_get_user($a, $item);
3112 // Look if the posts are matching if they should be filtered by user id
3113 if ($filter_user && ($status_user["id"] != $user_info["id"])) {
3117 $in_reply_to = api_in_reply_to($item);
3119 $converted = api_convert_item($item);
3121 if ($type == "xml") {
3122 $geo = "georss:point";
3128 'text' => $converted["text"],
3129 'truncated' => false,
3130 'created_at'=> api_date($item['created']),
3131 'in_reply_to_status_id' => $in_reply_to['status_id'],
3132 'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
3133 'source' => (($item['app']) ? $item['app'] : 'web'),
3134 'id' => intval($item['id']),
3135 'id_str' => (string) intval($item['id']),
3136 'in_reply_to_user_id' => $in_reply_to['user_id'],
3137 'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
3138 'in_reply_to_screen_name' => $in_reply_to['screen_name'],
3140 'favorited' => $item['starred'] ? true : false,
3141 'user' => $status_user ,
3142 'friendica_owner' => $owner_user,
3143 //'entities' => NULL,
3144 'statusnet_html' => $converted["html"],
3145 'statusnet_conversation_id' => $item['parent'],
3146 'external_url' => System::baseUrl() . "/display/" . $item['guid'],
3147 'friendica_activities' => api_format_items_activities($item, $type),
3150 if (count($converted["attachments"]) > 0) {
3151 $status["attachments"] = $converted["attachments"];
3154 if (count($converted["entities"]) > 0) {
3155 $status["entities"] = $converted["entities"];
3158 if (($item['item_network'] != "") && ($status["source"] == 'web')) {
3159 $status["source"] = ContactSelector::networkToName($item['item_network'], $user_info['url']);
3160 } elseif (($item['item_network'] != "") && (ContactSelector::networkToName($item['item_network'], $user_info['url']) != $status["source"])) {
3161 $status["source"] = trim($status["source"].' ('.ContactSelector::networkToName($item['item_network'], $user_info['url']).')');
3165 // Retweets are only valid for top postings
3166 // It doesn't work reliable with the link if its a feed
3167 //$IsRetweet = ($item['owner-link'] != $item['author-link']);
3169 // $IsRetweet = (($item['owner-name'] != $item['author-name']) || ($item['owner-avatar'] != $item['author-avatar']));
3172 if ($item["id"] == $item["parent"]) {
3173 $retweeted_item = api_share_as_retweet($item);
3174 if ($retweeted_item !== false) {
3175 $retweeted_status = $status;
3177 $retweeted_status["user"] = api_get_user($a, $retweeted_item["author-link"]);
3178 } catch (BadRequestException $e) {
3179 // user not found. should be found?
3180 /// @todo check if the user should be always found
3181 $retweeted_status["user"] = [];
3184 $rt_converted = api_convert_item($retweeted_item);
3186 $retweeted_status['text'] = $rt_converted["text"];
3187 $retweeted_status['statusnet_html'] = $rt_converted["html"];
3188 $retweeted_status['friendica_activities'] = api_format_items_activities($retweeted_item, $type);
3189 $retweeted_status['created_at'] = api_date($retweeted_item['created']);
3190 $status['retweeted_status'] = $retweeted_status;
3194 // "uid" and "self" are only needed for some internal stuff, so remove it from here
3195 unset($status["user"]["uid"]);
3196 unset($status["user"]["self"]);
3198 if ($item["coord"] != "") {
3199 $coords = explode(' ', $item["coord"]);
3200 if (count($coords) == 2) {
3201 if ($type == "json") {
3202 $status["geo"] = ['type' => 'Point',
3203 'coordinates' => [(float) $coords[0],
3204 (float) $coords[1]]];
3205 } else {// Not sure if this is the official format - if someone founds a documentation we can check
3206 $status["georss:point"] = $item["coord"];
3216 * Returns the remaining number of API requests available to the user before the API limit is reached.
3218 * @param string $type Return type (atom, rss, xml, json)
3220 * @return array|string
3222 function api_account_rate_limit_status($type)
3224 if ($type == "xml") {
3226 'remaining-hits' => '150',
3227 '@attributes' => ["type" => "integer"],
3228 'hourly-limit' => '150',
3229 '@attributes2' => ["type" => "integer"],
3230 'reset-time' => DateTimeFormat::utc('now + 1 hour', DateTimeFormat::ATOM),
3231 '@attributes3' => ["type" => "datetime"],
3232 'reset_time_in_seconds' => strtotime('now + 1 hour'),
3233 '@attributes4' => ["type" => "integer"],
3237 'reset_time_in_seconds' => strtotime('now + 1 hour'),
3238 'remaining_hits' => '150',
3239 'hourly_limit' => '150',
3240 'reset_time' => api_date(DateTimeFormat::utc('now + 1 hour', DateTimeFormat::ATOM)),
3244 return api_format_data('hash', $type, ['hash' => $hash]);
3247 /// @TODO move to top of file or somewhere better
3248 api_register_func('api/account/rate_limit_status', 'api_account_rate_limit_status', true);
3251 * Returns the string "ok" in the requested format with a 200 OK HTTP status code.
3253 * @param string $type Return type (atom, rss, xml, json)
3255 * @return array|string
3257 function api_help_test($type)
3259 if ($type == 'xml') {
3265 return api_format_data('ok', $type, ["ok" => $ok]);
3268 /// @TODO move to top of file or somewhere better
3269 api_register_func('api/help/test', 'api_help_test', false);
3272 * Returns all lists the user subscribes to.
3274 * @param string $type Return type (atom, rss, xml, json)
3276 * @return array|string
3277 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-list
3279 function api_lists_list($type)
3282 /// @TODO $ret is not filled here?
3283 return api_format_data('lists', $type, ["lists_list" => $ret]);
3286 /// @TODO move to top of file or somewhere better
3287 api_register_func('api/lists/list', 'api_lists_list', true);
3288 api_register_func('api/lists/subscriptions', 'api_lists_list', true);
3291 * Returns all groups the user owns.
3293 * @param string $type Return type (atom, rss, xml, json)
3295 * @return array|string
3296 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships
3298 function api_lists_ownerships($type)
3302 if (api_user() === false) {
3303 throw new ForbiddenException();
3307 $user_info = api_get_user($a);
3308 $uid = $user_info['uid'];
3310 $groups = dba::select('group', [], ['deleted' => 0, 'uid' => $uid]);
3312 // loop through all groups
3314 foreach ($groups as $group) {
3315 if ($group['visible']) {
3321 'name' => $group['name'],
3322 'id' => intval($group['id']),
3323 'id_str' => (string) $group['id'],
3324 'user' => $user_info,
3328 return api_format_data("lists", $type, ['lists' => ['lists' => $lists]]);
3331 /// @TODO move to top of file or somewhere better
3332 api_register_func('api/lists/ownerships', 'api_lists_ownerships', true);
3335 * Returns recent statuses from users in the specified group.
3337 * @param string $type Return type (atom, rss, xml, json)
3339 * @return array|string
3340 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships
3342 function api_lists_statuses($type)
3346 if (api_user() === false) {
3347 throw new ForbiddenException();
3350 unset($_REQUEST["user_id"]);
3351 unset($_GET["user_id"]);
3353 unset($_REQUEST["screen_name"]);
3354 unset($_GET["screen_name"]);
3356 $user_info = api_get_user($a);
3357 if (empty($_REQUEST['list_id'])) {
3358 throw new BadRequestException('list_id not specified');
3362 $count = (x($_REQUEST, 'count') ? $_REQUEST['count'] : 20);
3363 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] - 1 : 0);
3367 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
3368 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
3369 $exclude_replies = (x($_REQUEST, 'exclude_replies') ? 1 : 0);
3370 $conversation_id = (x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0);
3372 $start = $page * $count;
3376 $sql_extra .= ' AND `item`.`id` <= ' . intval($max_id);
3378 if ($exclude_replies > 0) {
3379 $sql_extra .= ' AND `item`.`parent` = `item`.`id`';
3381 if ($conversation_id > 0) {
3382 $sql_extra .= ' AND `item`.`parent` = ' . intval($conversation_id);
3386 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`,
3387 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
3388 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
3389 `contact`.`id` AS `cid`, `group_member`.`gid`
3391 STRAIGHT_JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
3392 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
3393 STRAIGHT_JOIN `group_member` ON `group_member`.`contact-id` = `item`.`contact-id`
3394 WHERE `item`.`uid` = ? AND `verb` = ?
3395 AND `item`.`visible` AND NOT `item`.`moderated` AND NOT `item`.`deleted`
3398 AND `group_member`.`gid` = ?
3399 ORDER BY `item`.`id` DESC LIMIT ".intval($start)." ,".intval($count),
3403 $_REQUEST['list_id']
3406 $items = api_format_items($statuses, $user_info, false, $type);
3408 $data = ['status' => $items];
3412 $data = api_rss_extra($a, $data, $user_info);
3416 return api_format_data("statuses", $type, $data);
3419 /// @TODO move to top of file or somewhere better
3420 api_register_func('api/lists/statuses', 'api_lists_statuses', true);
3423 * Considers friends and followers lists to be private and won't return
3424 * anything if any user_id parameter is passed.
3426 * @brief Returns either the friends of the follower list
3428 * @param string $qtype Either "friends" or "followers"
3429 * @return boolean|array
3430 * @throws ForbiddenException
3432 function api_statuses_f($qtype)
3436 if (api_user() === false) {
3437 throw new ForbiddenException();
3441 $count = x($_GET, 'count') ? $_GET['count'] : 20;
3442 $page = x($_GET, 'page') ? $_GET['page'] : 1;
3446 $start = ($page - 1) * $count;
3448 $user_info = api_get_user($a);
3450 if (x($_GET, 'cursor') && $_GET['cursor'] == 'undefined') {
3451 /* this is to stop Hotot to load friends multiple times
3452 * I'm not sure if I'm missing return something or
3453 * is a bug in hotot. Workaround, meantime
3457 return array('$users' => $ret);*/
3462 if ($qtype == 'friends') {
3463 $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(CONTACT_IS_SHARING), intval(CONTACT_IS_FRIEND));
3464 } elseif ($qtype == 'followers') {
3465 $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(CONTACT_IS_FOLLOWER), intval(CONTACT_IS_FRIEND));
3468 // friends and followers only for self
3469 if ($user_info['self'] == 0) {
3470 $sql_extra = " AND false ";
3473 if ($qtype == 'blocks') {
3474 $sql_filter = 'AND `blocked` AND NOT `pending`';
3475 } elseif ($qtype == 'incoming') {
3476 $sql_filter = 'AND `pending`';
3478 $sql_filter = 'AND (NOT `blocked` OR `pending`)';
3496 foreach ($r as $cid) {
3497 $user = api_get_user($a, $cid['nurl']);
3498 // "uid" and "self" are only needed for some internal stuff, so remove it from here
3499 unset($user["uid"]);
3500 unset($user["self"]);
3507 return ['user' => $ret];
3512 * Returns the user's friends.
3514 * @brief Returns the list of friends of the provided user
3516 * @deprecated By Twitter API in favor of friends/list
3518 * @param string $type Either "json" or "xml"
3519 * @return boolean|string|array
3521 function api_statuses_friends($type)
3523 $data = api_statuses_f("friends");
3524 if ($data === false) {
3527 return api_format_data("users", $type, $data);
3531 * Returns the user's followers.
3533 * @brief Returns the list of followers of the provided user
3535 * @deprecated By Twitter API in favor of friends/list
3537 * @param string $type Either "json" or "xml"
3538 * @return boolean|string|array
3540 function api_statuses_followers($type)
3542 $data = api_statuses_f("followers");
3543 if ($data === false) {
3546 return api_format_data("users", $type, $data);
3549 /// @TODO move to top of file or somewhere better
3550 api_register_func('api/statuses/friends', 'api_statuses_friends', true);
3551 api_register_func('api/statuses/followers', 'api_statuses_followers', true);
3554 * Returns the list of blocked users
3556 * @see https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/get-blocks-list
3558 * @param string $type Either "json" or "xml"
3560 * @return boolean|string|array
3562 function api_blocks_list($type)
3564 $data = api_statuses_f('blocks');
3565 if ($data === false) {
3568 return api_format_data("users", $type, $data);
3571 /// @TODO move to top of file or somewhere better
3572 api_register_func('api/blocks/list', 'api_blocks_list', true);
3575 * Returns the list of pending users IDs
3577 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-incoming
3579 * @param string $type Either "json" or "xml"
3581 * @return boolean|string|array
3583 function api_friendships_incoming($type)
3585 $data = api_statuses_f('incoming');
3586 if ($data === false) {
3591 foreach ($data['user'] as $user) {
3592 $ids[] = $user['id'];
3595 return api_format_data("ids", $type, ['id' => $ids]);
3598 /// @TODO move to top of file or somewhere better
3599 api_register_func('api/friendships/incoming', 'api_friendships_incoming', true);
3602 * Returns the instance's configuration information.
3604 * @param string $type Return type (atom, rss, xml, json)
3606 * @return array|string
3608 function api_statusnet_config($type)
3612 $name = $a->config['sitename'];
3613 $server = $a->get_hostname();
3614 $logo = System::baseUrl() . '/images/friendica-64.png';
3615 $email = $a->config['admin_email'];
3616 $closed = (($a->config['register_policy'] == REGISTER_CLOSED) ? 'true' : 'false');
3617 $private = ((Config::get('system', 'block_public')) ? 'true' : 'false');
3618 $textlimit = (string) (($a->config['max_import_size']) ? $a->config['max_import_size'] : 200000);
3619 if ($a->config['api_import_size']) {
3620 $textlimit = (string) $a->config['api_import_size'];
3622 $ssl = ((Config::get('system', 'have_ssl')) ? 'true' : 'false');
3623 $sslserver = (($ssl === 'true') ? str_replace('http:', 'https:', System::baseUrl()) : '');
3626 'site' => ['name' => $name,'server' => $server, 'theme' => 'default', 'path' => '',
3627 'logo' => $logo, 'fancy' => true, 'language' => 'en', 'email' => $email, 'broughtby' => '',
3628 'broughtbyurl' => '', 'timezone' => 'UTC', 'closed' => $closed, 'inviteonly' => false,
3629 'private' => $private, 'textlimit' => $textlimit, 'sslserver' => $sslserver, 'ssl' => $ssl,
3630 'shorturllength' => '30',
3632 'FRIENDICA_PLATFORM' => FRIENDICA_PLATFORM,
3633 'FRIENDICA_VERSION' => FRIENDICA_VERSION,
3634 'DFRN_PROTOCOL_VERSION' => DFRN_PROTOCOL_VERSION,
3635 'DB_UPDATE_VERSION' => DB_UPDATE_VERSION
3640 return api_format_data('config', $type, ['config' => $config]);
3643 /// @TODO move to top of file or somewhere better
3644 api_register_func('api/gnusocial/config', 'api_statusnet_config', false);
3645 api_register_func('api/statusnet/config', 'api_statusnet_config', false);
3649 * @param string $type Return type (atom, rss, xml, json)
3651 * @return array|string
3653 function api_statusnet_version($type)
3656 $fake_statusnet_version = "0.9.7";
3658 return api_format_data('version', $type, ['version' => $fake_statusnet_version]);
3661 /// @TODO move to top of file or somewhere better
3662 api_register_func('api/gnusocial/version', 'api_statusnet_version', false);
3663 api_register_func('api/statusnet/version', 'api_statusnet_version', false);
3667 * @param string $type Return type (atom, rss, xml, json)
3669 * @todo use api_format_data() to return data
3671 function api_ff_ids($type)
3674 throw new ForbiddenException();
3681 $stringify_ids = defaults($_REQUEST, 'stringify_ids', false);
3684 "SELECT `pcontact`.`id` FROM `contact`
3685 INNER JOIN `contact` AS `pcontact` ON `contact`.`nurl` = `pcontact`.`nurl` AND `pcontact`.`uid` = 0
3686 WHERE `contact`.`uid` = %s AND NOT `contact`.`self`",
3689 if (!DBM::is_result($r)) {
3694 foreach ($r as $rr) {
3695 if ($stringify_ids) {
3698 $ids[] = intval($rr['id']);
3702 return api_format_data("ids", $type, ['id' => $ids]);
3706 * Returns the ID of every user the user is following.
3708 * @param string $type Return type (atom, rss, xml, json)
3710 * @return array|string
3711 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friends-ids
3713 function api_friends_ids($type)
3715 return api_ff_ids($type);
3719 * Returns the ID of every user following the user.
3721 * @param string $type Return type (atom, rss, xml, json)
3723 * @return array|string
3724 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-followers-ids
3726 function api_followers_ids($type)
3728 return api_ff_ids($type);
3731 /// @TODO move to top of file or somewhere better
3732 api_register_func('api/friends/ids', 'api_friends_ids', true);
3733 api_register_func('api/followers/ids', 'api_followers_ids', true);
3736 * Sends a new direct message.
3738 * @param string $type Return type (atom, rss, xml, json)
3740 * @return array|string
3741 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/new-message
3743 function api_direct_messages_new($type)
3748 if (api_user() === false) {
3749 throw new ForbiddenException();
3752 if (!x($_POST, "text") || (!x($_POST, "screen_name") && !x($_POST, "user_id"))) {
3756 $sender = api_get_user($a);
3758 if ($_POST['screen_name']) {
3760 "SELECT `id`, `nurl`, `network` FROM `contact` WHERE `uid`=%d AND `nick`='%s'",
3762 dbesc($_POST['screen_name'])
3765 // Selecting the id by priority, friendica first
3766 api_best_nickname($r);
3768 $recipient = api_get_user($a, $r[0]['nurl']);
3770 $recipient = api_get_user($a, $_POST['user_id']);
3775 if (x($_REQUEST, 'replyto')) {
3777 'SELECT `parent-uri`, `title` FROM `mail` WHERE `uid`=%d AND `id`=%d',
3779 intval($_REQUEST['replyto'])
3781 $replyto = $r[0]['parent-uri'];
3782 $sub = $r[0]['title'];
3784 if (x($_REQUEST, 'title')) {
3785 $sub = $_REQUEST['title'];
3787 $sub = ((strlen($_POST['text'])>10) ? substr($_POST['text'], 0, 10)."...":$_POST['text']);
3791 $id = Mail::send($recipient['cid'], $_POST['text'], $sub, $replyto);
3794 $r = q("SELECT * FROM `mail` WHERE id=%d", intval($id));
3795 $ret = api_format_messages($r[0], $recipient, $sender);
3797 $ret = ["error"=>$id];
3800 $data = ['direct_message'=>$ret];
3805 $data = api_rss_extra($a, $data, $sender);
3808 return api_format_data("direct-messages", $type, $data);
3811 /// @TODO move to top of file or somewhere better
3812 api_register_func('api/direct_messages/new', 'api_direct_messages_new', true, API_METHOD_POST);
3815 * Destroys a direct message.
3817 * @brief delete a direct_message from mail table through api
3819 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3821 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/delete-message
3823 function api_direct_messages_destroy($type)
3827 if (api_user() === false) {
3828 throw new ForbiddenException();
3832 $user_info = api_get_user($a);
3834 $id = (x($_REQUEST, 'id') ? $_REQUEST['id'] : 0);
3836 $parenturi = (x($_REQUEST, 'friendica_parenturi') ? $_REQUEST['friendica_parenturi'] : "");
3837 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3838 /// @todo optional parameter 'include_entities' from Twitter API not yet implemented
3840 $uid = $user_info['uid'];
3841 // error if no id or parenturi specified (for clients posting parent-uri as well)
3842 if ($verbose == "true" && ($id == 0 || $parenturi == "")) {
3843 $answer = ['result' => 'error', 'message' => 'message id or parenturi not specified'];
3844 return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3847 // BadRequestException if no id specified (for clients using Twitter API)
3849 throw new BadRequestException('Message id not specified');
3852 // add parent-uri to sql command if specified by calling app
3853 $sql_extra = ($parenturi != "" ? " AND `parent-uri` = '" . dbesc($parenturi) . "'" : "");
3855 // get data of the specified message id
3857 "SELECT `id` FROM `mail` WHERE `uid` = %d AND `id` = %d" . $sql_extra,
3862 // error message if specified id is not in database
3863 if (!DBM::is_result($r)) {
3864 if ($verbose == "true") {
3865 $answer = ['result' => 'error', 'message' => 'message id not in database'];
3866 return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3868 /// @todo BadRequestException ok for Twitter API clients?
3869 throw new BadRequestException('message id not in database');
3874 "DELETE FROM `mail` WHERE `uid` = %d AND `id` = %d" . $sql_extra,
3879 if ($verbose == "true") {
3882 $answer = ['result' => 'ok', 'message' => 'message deleted'];
3883 return api_format_data("direct_message_delete", $type, ['$result' => $answer]);
3885 $answer = ['result' => 'error', 'message' => 'unknown error'];
3886 return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3889 /// @todo return JSON data like Twitter API not yet implemented
3892 /// @TODO move to top of file or somewhere better
3893 api_register_func('api/direct_messages/destroy', 'api_direct_messages_destroy', true, API_METHOD_DELETE);
3897 * @param string $type Return type (atom, rss, xml, json)
3898 * @param string $box
3899 * @param string $verbose
3901 * @return array|string
3903 function api_direct_messages_box($type, $box, $verbose)
3907 if (api_user() === false) {
3908 throw new ForbiddenException();
3912 $count = (x($_GET, 'count') ? $_GET['count'] : 20);
3913 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] -1 : 0);
3918 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
3919 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
3921 $user_id = (x($_REQUEST, 'user_id') ? $_REQUEST['user_id'] : "");
3922 $screen_name = (x($_REQUEST, 'screen_name') ? $_REQUEST['screen_name'] : "");
3925 unset($_REQUEST["user_id"]);
3926 unset($_GET["user_id"]);
3928 unset($_REQUEST["screen_name"]);
3929 unset($_GET["screen_name"]);
3931 $user_info = api_get_user($a);
3932 $profile_url = $user_info["url"];
3935 $start = $page * $count;
3940 if ($box=="sentbox") {
3941 $sql_extra = "`mail`.`from-url`='" . dbesc($profile_url) . "'";
3942 } elseif ($box == "conversation") {
3943 $sql_extra = "`mail`.`parent-uri`='" . dbesc($_GET["uri"]) . "'";
3944 } elseif ($box == "all") {
3945 $sql_extra = "true";
3946 } elseif ($box == "inbox") {
3947 $sql_extra = "`mail`.`from-url`!='" . dbesc($profile_url) . "'";
3951 $sql_extra .= ' AND `mail`.`id` <= ' . intval($max_id);
3954 if ($user_id != "") {
3955 $sql_extra .= ' AND `mail`.`contact-id` = ' . intval($user_id);
3956 } elseif ($screen_name !="") {
3957 $sql_extra .= " AND `contact`.`nick` = '" . dbesc($screen_name). "'";
3961 "SELECT `mail`.*, `contact`.`nurl` AS `contact-url` FROM `mail`,`contact` WHERE `mail`.`contact-id` = `contact`.`id` AND `mail`.`uid`=%d AND $sql_extra AND `mail`.`id` > %d ORDER BY `mail`.`id` DESC LIMIT %d,%d",
3967 if ($verbose == "true" && !DBM::is_result($r)) {
3968 $answer = ['result' => 'error', 'message' => 'no mails available'];
3969 return api_format_data("direct_messages_all", $type, ['$result' => $answer]);
3973 foreach ($r as $item) {
3974 if ($box == "inbox" || $item['from-url'] != $profile_url) {
3975 $recipient = $user_info;
3976 $sender = api_get_user($a, normalise_link($item['contact-url']));
3977 } elseif ($box == "sentbox" || $item['from-url'] == $profile_url) {
3978 $recipient = api_get_user($a, normalise_link($item['contact-url']));
3979 $sender = $user_info;
3982 $ret[] = api_format_messages($item, $recipient, $sender);
3986 $data = ['direct_message' => $ret];
3990 $data = api_rss_extra($a, $data, $user_info);
3993 return api_format_data("direct-messages", $type, $data);
3997 * Returns the most recent direct messages sent by the user.
3999 * @param string $type Return type (atom, rss, xml, json)
4001 * @return array|string
4002 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-sent-message
4004 function api_direct_messages_sentbox($type)
4006 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
4007 return api_direct_messages_box($type, "sentbox", $verbose);
4011 * Returns the most recent direct messages sent to the user.
4013 * @param string $type Return type (atom, rss, xml, json)
4015 * @return array|string
4016 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-messages
4018 function api_direct_messages_inbox($type)
4020 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
4021 return api_direct_messages_box($type, "inbox", $verbose);
4026 * @param string $type Return type (atom, rss, xml, json)
4028 * @return array|string
4030 function api_direct_messages_all($type)
4032 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
4033 return api_direct_messages_box($type, "all", $verbose);
4038 * @param string $type Return type (atom, rss, xml, json)
4040 * @return array|string
4042 function api_direct_messages_conversation($type)
4044 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
4045 return api_direct_messages_box($type, "conversation", $verbose);
4048 /// @TODO move to top of file or somewhere better
4049 api_register_func('api/direct_messages/conversation', 'api_direct_messages_conversation', true);
4050 api_register_func('api/direct_messages/all', 'api_direct_messages_all', true);
4051 api_register_func('api/direct_messages/sent', 'api_direct_messages_sentbox', true);
4052 api_register_func('api/direct_messages', 'api_direct_messages_inbox', true);
4055 * Returns an OAuth Request Token.
4057 * @see https://oauth.net/core/1.0/#auth_step1
4059 function api_oauth_request_token()
4061 $oauth1 = new FKOAuth1();
4063 $r = $oauth1->fetch_request_token(OAuthRequest::from_request());
4064 } catch (Exception $e) {
4065 echo "error=" . OAuthUtil::urlencode_rfc3986($e->getMessage());
4073 * Returns an OAuth Access Token.
4075 * @return array|string
4076 * @see https://oauth.net/core/1.0/#auth_step3
4078 function api_oauth_access_token()
4080 $oauth1 = new FKOAuth1();
4082 $r = $oauth1->fetch_access_token(OAuthRequest::from_request());
4083 } catch (Exception $e) {
4084 echo "error=". OAuthUtil::urlencode_rfc3986($e->getMessage());
4091 /// @TODO move to top of file or somewhere better
4092 api_register_func('api/oauth/request_token', 'api_oauth_request_token', false);
4093 api_register_func('api/oauth/access_token', 'api_oauth_access_token', false);
4097 * @brief delete a complete photoalbum with all containing photos from database through api
4099 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4102 function api_fr_photoalbum_delete($type)
4104 if (api_user() === false) {
4105 throw new ForbiddenException();
4108 $album = (x($_REQUEST, 'album') ? $_REQUEST['album'] : "");
4110 // we do not allow calls without album string
4112 throw new BadRequestException("no albumname specified");
4114 // check if album is existing
4116 "SELECT DISTINCT `resource-id` FROM `photo` WHERE `uid` = %d AND `album` = '%s'",
4120 if (!DBM::is_result($r)) {
4121 throw new BadRequestException("album not available");
4124 // function for setting the items to "deleted = 1" which ensures that comments, likes etc. are not shown anymore
4125 // to the user and the contacts of the users (drop_items() performs the federation of the deletion to other networks
4126 foreach ($r as $rr) {
4128 "SELECT `id` FROM `item` WHERE `uid` = %d AND `resource-id` = '%s' AND `type` = 'photo'",
4129 intval(local_user()),
4130 dbesc($rr['resource-id'])
4133 if (!DBM::is_result($photo_item)) {
4134 throw new InternalServerErrorException("problem with deleting items occured");
4136 Item::deleteById($photo_item[0]['id']);
4139 // now let's delete all photos from the album
4140 $result = dba::delete('photo', ['uid' => api_user(), 'album' => $album]);
4142 // return success of deletion or error message
4144 $answer = ['result' => 'deleted', 'message' => 'album `' . $album . '` with all containing photos has been deleted.'];
4145 return api_format_data("photoalbum_delete", $type, ['$result' => $answer]);
4147 throw new InternalServerErrorException("unknown error - deleting from database failed");
4152 * @brief update the name of the album for all photos of an album
4154 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4157 function api_fr_photoalbum_update($type)
4159 if (api_user() === false) {
4160 throw new ForbiddenException();
4163 $album = (x($_REQUEST, 'album') ? $_REQUEST['album'] : "");
4164 $album_new = (x($_REQUEST, 'album_new') ? $_REQUEST['album_new'] : "");
4166 // we do not allow calls without album string
4168 throw new BadRequestException("no albumname specified");
4170 if ($album_new == "") {
4171 throw new BadRequestException("no new albumname specified");
4173 // check if album is existing
4175 "SELECT `id` FROM `photo` WHERE `uid` = %d AND `album` = '%s'",
4179 if (!DBM::is_result($r)) {
4180 throw new BadRequestException("album not available");
4182 // now let's update all photos to the albumname
4184 "UPDATE `photo` SET `album` = '%s' WHERE `uid` = %d AND `album` = '%s'",
4190 // return success of updating or error message
4192 $answer = ['result' => 'updated', 'message' => 'album `' . $album . '` with all containing photos has been renamed to `' . $album_new . '`.'];
4193 return api_format_data("photoalbum_update", $type, ['$result' => $answer]);
4195 throw new InternalServerErrorException("unknown error - updating in database failed");
4201 * @brief list all photos of the authenticated user
4203 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4206 function api_fr_photos_list($type)
4208 if (api_user() === false) {
4209 throw new ForbiddenException();
4212 "SELECT `resource-id`, MAX(scale) AS `scale`, `album`, `filename`, `type`, MAX(`created`) AS `created`,
4213 MAX(`edited`) AS `edited`, MAX(`desc`) AS `desc` FROM `photo`
4214 WHERE `uid` = %d AND `album` != 'Contact Photos' GROUP BY `resource-id`",
4215 intval(local_user())
4218 'image/jpeg' => 'jpg',
4219 'image/png' => 'png',
4220 'image/gif' => 'gif'
4222 $data = ['photo'=>[]];
4223 if (DBM::is_result($r)) {
4224 foreach ($r as $rr) {
4226 $photo['id'] = $rr['resource-id'];
4227 $photo['album'] = $rr['album'];
4228 $photo['filename'] = $rr['filename'];
4229 $photo['type'] = $rr['type'];
4230 $thumb = System::baseUrl() . "/photo/" . $rr['resource-id'] . "-" . $rr['scale'] . "." . $typetoext[$rr['type']];
4231 $photo['created'] = $rr['created'];
4232 $photo['edited'] = $rr['edited'];
4233 $photo['desc'] = $rr['desc'];
4235 if ($type == "xml") {
4236 $data['photo'][] = ["@attributes" => $photo, "1" => $thumb];
4238 $photo['thumb'] = $thumb;
4239 $data['photo'][] = $photo;
4243 return api_format_data("photos", $type, $data);
4247 * @brief upload a new photo or change an existing photo
4249 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4252 function api_fr_photo_create_update($type)
4254 if (api_user() === false) {
4255 throw new ForbiddenException();
4258 $photo_id = (x($_REQUEST, 'photo_id') ? $_REQUEST['photo_id'] : null);
4259 $desc = (x($_REQUEST, 'desc') ? $_REQUEST['desc'] : (array_key_exists('desc', $_REQUEST) ? "" : null)); // extra check necessary to distinguish between 'not provided' and 'empty string'
4260 $album = (x($_REQUEST, 'album') ? $_REQUEST['album'] : null);
4261 $album_new = (x($_REQUEST, 'album_new') ? $_REQUEST['album_new'] : null);
4262 $allow_cid = (x($_REQUEST, 'allow_cid') ? $_REQUEST['allow_cid'] : (array_key_exists('allow_cid', $_REQUEST) ? " " : null));
4263 $deny_cid = (x($_REQUEST, 'deny_cid') ? $_REQUEST['deny_cid'] : (array_key_exists('deny_cid', $_REQUEST) ? " " : null));
4264 $allow_gid = (x($_REQUEST, 'allow_gid') ? $_REQUEST['allow_gid'] : (array_key_exists('allow_gid', $_REQUEST) ? " " : null));
4265 $deny_gid = (x($_REQUEST, 'deny_gid') ? $_REQUEST['deny_gid'] : (array_key_exists('deny_gid', $_REQUEST) ? " " : null));
4266 $visibility = (x($_REQUEST, 'visibility') ? (($_REQUEST['visibility'] == "true" || $_REQUEST['visibility'] == 1) ? true : false) : false);
4268 // do several checks on input parameters
4269 // we do not allow calls without album string
4270 if ($album == null) {
4271 throw new BadRequestException("no albumname specified");
4273 // if photo_id == null --> we are uploading a new photo
4274 if ($photo_id == null) {
4277 // error if no media posted in create-mode
4278 if (!x($_FILES, 'media')) {
4280 throw new BadRequestException("no media data submitted");
4283 // album_new will be ignored in create-mode
4288 // check if photo is existing in database
4290 "SELECT `id` FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s' AND `album` = '%s'",
4295 if (!DBM::is_result($r)) {
4296 throw new BadRequestException("photo not available");
4300 // checks on acl strings provided by clients
4301 $acl_input_error = false;
4302 $acl_input_error |= check_acl_input($allow_cid);
4303 $acl_input_error |= check_acl_input($deny_cid);
4304 $acl_input_error |= check_acl_input($allow_gid);
4305 $acl_input_error |= check_acl_input($deny_gid);
4306 if ($acl_input_error) {
4307 throw new BadRequestException("acl data invalid");
4309 // now let's upload the new media in create-mode
4310 if ($mode == "create") {
4311 $media = $_FILES['media'];
4312 $data = save_media_to_database("photo", $media, $type, $album, trim($allow_cid), trim($deny_cid), trim($allow_gid), trim($deny_gid), $desc, $visibility);
4314 // return success of updating or error message
4315 if (!is_null($data)) {
4316 return api_format_data("photo_create", $type, $data);
4318 throw new InternalServerErrorException("unknown error - uploading photo failed, see Friendica log for more information");
4322 // now let's do the changes in update-mode
4323 if ($mode == "update") {
4326 if (!is_null($desc)) {
4327 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`desc` = '$desc'";
4330 if (!is_null($album_new)) {
4331 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`album` = '$album_new'";
4334 if (!is_null($allow_cid)) {
4335 $allow_cid = trim($allow_cid);
4336 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`allow_cid` = '$allow_cid'";
4339 if (!is_null($deny_cid)) {
4340 $deny_cid = trim($deny_cid);
4341 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`deny_cid` = '$deny_cid'";
4344 if (!is_null($allow_gid)) {
4345 $allow_gid = trim($allow_gid);
4346 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`allow_gid` = '$allow_gid'";
4349 if (!is_null($deny_gid)) {
4350 $deny_gid = trim($deny_gid);
4351 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`deny_gid` = '$deny_gid'";
4355 if ($sql_extra != "") {
4356 $nothingtodo = false;
4358 "UPDATE `photo` SET %s, `edited`='%s' WHERE `uid` = %d AND `resource-id` = '%s' AND `album` = '%s'",
4360 DateTimeFormat::utcNow(), // update edited timestamp
4366 $nothingtodo = true;
4369 if (x($_FILES, 'media')) {
4370 $nothingtodo = false;
4371 $media = $_FILES['media'];
4372 $data = save_media_to_database("photo", $media, $type, $album, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $desc, 0, $visibility, $photo_id);
4373 if (!is_null($data)) {
4374 return api_format_data("photo_update", $type, $data);
4378 // return success of updating or error message
4380 $answer = ['result' => 'updated', 'message' => 'Image id `' . $photo_id . '` has been updated.'];
4381 return api_format_data("photo_update", $type, ['$result' => $answer]);
4384 $answer = ['result' => 'cancelled', 'message' => 'Nothing to update for image id `' . $photo_id . '`.'];
4385 return api_format_data("photo_update", $type, ['$result' => $answer]);
4387 throw new InternalServerErrorException("unknown error - update photo entry in database failed");
4390 throw new InternalServerErrorException("unknown error - this error on uploading or updating a photo should never happen");
4395 * @brief delete a single photo from the database through api
4397 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4400 function api_fr_photo_delete($type)
4402 if (api_user() === false) {
4403 throw new ForbiddenException();
4406 $photo_id = (x($_REQUEST, 'photo_id') ? $_REQUEST['photo_id'] : null);
4408 // do several checks on input parameters
4409 // we do not allow calls without photo id
4410 if ($photo_id == null) {
4411 throw new BadRequestException("no photo_id specified");
4413 // check if photo is existing in database
4415 "SELECT `id` FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s'",
4419 if (!DBM::is_result($r)) {
4420 throw new BadRequestException("photo not available");
4422 // now we can perform on the deletion of the photo
4423 $result = dba::delete('photo', ['uid' => api_user(), 'resource-id' => $photo_id]);
4425 // return success of deletion or error message
4427 // retrieve the id of the parent element (the photo element)
4429 "SELECT `id` FROM `item` WHERE `uid` = %d AND `resource-id` = '%s' AND `type` = 'photo'",
4430 intval(local_user()),
4434 if (!DBM::is_result($photo_item)) {
4435 throw new InternalServerErrorException("problem with deleting items occured");
4437 // function for setting the items to "deleted = 1" which ensures that comments, likes etc. are not shown anymore
4438 // to the user and the contacts of the users (drop_items() do all the necessary magic to avoid orphans in database and federate deletion)
4439 Item::deleteById($photo_item[0]['id']);
4441 $answer = ['result' => 'deleted', 'message' => 'photo with id `' . $photo_id . '` has been deleted from server.'];
4442 return api_format_data("photo_delete", $type, ['$result' => $answer]);
4444 throw new InternalServerErrorException("unknown error on deleting photo from database table");
4450 * @brief returns the details of a specified photo id, if scale is given, returns the photo data in base 64
4452 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4453 * @return string|array
4455 function api_fr_photo_detail($type)
4457 if (api_user() === false) {
4458 throw new ForbiddenException();
4460 if (!x($_REQUEST, 'photo_id')) {
4461 throw new BadRequestException("No photo id.");
4464 $scale = (x($_REQUEST, 'scale') ? intval($_REQUEST['scale']) : false);
4465 $photo_id = $_REQUEST['photo_id'];
4467 // prepare json/xml output with data from database for the requested photo
4468 $data = prepare_photo_data($type, $scale, $photo_id);
4470 return api_format_data("photo_detail", $type, $data);
4475 * Updates the user’s profile image.
4477 * @brief updates the profile image for the user (either a specified profile or the default profile)
4479 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4482 * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_image
4484 function api_account_update_profile_image($type)
4486 if (api_user() === false) {
4487 throw new ForbiddenException();
4490 $profileid = defaults($_REQUEST, 'profile_id', 0);
4492 // error if image data is missing
4493 if (!x($_FILES, 'image')) {
4494 throw new BadRequestException("no media data submitted");
4497 // check if specified profile id is valid
4498 if ($profileid != 0) {
4500 "SELECT `id` FROM `profile` WHERE `uid` = %d AND `id` = %d",
4504 // error message if specified profile id is not in database
4505 if (!DBM::is_result($r)) {
4506 throw new BadRequestException("profile_id not available");
4508 $is_default_profile = $r['profile'];
4510 $is_default_profile = 1;
4513 // get mediadata from image or media (Twitter call api/account/update_profile_image provides image)
4515 if (x($_FILES, 'image')) {
4516 $media = $_FILES['image'];
4517 } elseif (x($_FILES, 'media')) {
4518 $media = $_FILES['media'];
4520 // save new profile image
4521 $data = save_media_to_database("profileimage", $media, $type, L10n::t('Profile Photos'), "", "", "", "", "", $is_default_profile);
4524 if (is_array($media['type'])) {
4525 $filetype = $media['type'][0];
4527 $filetype = $media['type'];
4529 if ($filetype == "image/jpeg") {
4531 } elseif ($filetype == "image/png") {
4534 // change specified profile or all profiles to the new resource-id
4535 if ($is_default_profile) {
4537 "UPDATE `photo` SET `profile` = 0 WHERE `profile` = 1 AND `resource-id` != '%s' AND `uid` = %d",
4538 dbesc($data['photo']['id']),
4539 intval(local_user())
4543 "UPDATE `contact` SET `photo` = '%s', `thumb` = '%s', `micro` = '%s' WHERE `self` AND `uid` = %d",
4544 dbesc(System::baseUrl() . '/photo/' . $data['photo']['id'] . '-4.' . $fileext),
4545 dbesc(System::baseUrl() . '/photo/' . $data['photo']['id'] . '-5.' . $fileext),
4546 dbesc(System::baseUrl() . '/photo/' . $data['photo']['id'] . '-6.' . $fileext),
4547 intval(local_user())
4551 "UPDATE `profile` SET `photo` = '%s', `thumb` = '%s' WHERE `id` = %d AND `uid` = %d",
4552 dbesc(System::baseUrl() . '/photo/' . $data['photo']['id'] . '-4.' . $filetype),
4553 dbesc(System::baseUrl() . '/photo/' . $data['photo']['id'] . '-5.' . $filetype),
4554 intval($_REQUEST['profile']),
4555 intval(local_user())
4559 // we'll set the updated profile-photo timestamp even if it isn't the default profile,
4560 // so that browsers will do a cache update unconditionally
4563 "UPDATE `contact` SET `avatar-date` = '%s' WHERE `self` = 1 AND `uid` = %d",
4564 dbesc(DateTimeFormat::utcNow()),
4565 intval(local_user())
4568 // Update global directory in background
4569 //$user = api_get_user(get_app());
4570 $url = System::baseUrl() . '/profile/' . get_app()->user['nickname'];
4571 if ($url && strlen(Config::get('system', 'directory'))) {
4572 Worker::add(PRIORITY_LOW, "Directory", $url);
4575 Worker::add(PRIORITY_LOW, 'ProfileUpdate', api_user());
4577 // output for client
4579 return api_account_verify_credentials($type);
4581 // SaveMediaToDatabase failed for some reason
4582 throw new InternalServerErrorException("image upload failed");
4586 // place api-register for photoalbum calls before 'api/friendica/photo', otherwise this function is never reached
4587 api_register_func('api/friendica/photoalbum/delete', 'api_fr_photoalbum_delete', true, API_METHOD_DELETE);
4588 api_register_func('api/friendica/photoalbum/update', 'api_fr_photoalbum_update', true, API_METHOD_POST);
4589 api_register_func('api/friendica/photos/list', 'api_fr_photos_list', true);
4590 api_register_func('api/friendica/photo/create', 'api_fr_photo_create_update', true, API_METHOD_POST);
4591 api_register_func('api/friendica/photo/update', 'api_fr_photo_create_update', true, API_METHOD_POST);
4592 api_register_func('api/friendica/photo/delete', 'api_fr_photo_delete', true, API_METHOD_DELETE);
4593 api_register_func('api/friendica/photo', 'api_fr_photo_detail', true);
4594 api_register_func('api/account/update_profile_image', 'api_account_update_profile_image', true, API_METHOD_POST);
4597 * Update user profile
4599 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4601 * @return array|string
4603 function api_account_update_profile($type)
4605 $local_user = api_user();
4606 $api_user = api_get_user(get_app());
4608 if (!empty($_POST['name'])) {
4609 dba::update('profile', ['name' => $_POST['name']], ['uid' => $local_user]);
4610 dba::update('user', ['username' => $_POST['name']], ['uid' => $local_user]);
4611 dba::update('contact', ['name' => $_POST['name']], ['uid' => $local_user, 'self' => 1]);
4612 dba::update('contact', ['name' => $_POST['name']], ['id' => $api_user['id']]);
4615 if (isset($_POST['description'])) {
4616 dba::update('profile', ['about' => $_POST['description']], ['uid' => $local_user]);
4617 dba::update('contact', ['about' => $_POST['description']], ['uid' => $local_user, 'self' => 1]);
4618 dba::update('contact', ['about' => $_POST['description']], ['id' => $api_user['id']]);
4621 Worker::add(PRIORITY_LOW, 'ProfileUpdate', $local_user);
4622 // Update global directory in background
4623 if ($api_user['url'] && strlen(Config::get('system', 'directory'))) {
4624 Worker::add(PRIORITY_LOW, "Directory", $api_user['url']);
4627 return api_account_verify_credentials($type);
4630 /// @TODO move to top of file or somewhere better
4631 api_register_func('api/account/update_profile', 'api_account_update_profile', true, API_METHOD_POST);
4635 * @param string $acl_string
4637 function check_acl_input($acl_string)
4639 if ($acl_string == null || $acl_string == " ") {
4642 $contact_not_found = false;
4644 // split <x><y><z> into array of cid's
4645 preg_match_all("/<[A-Za-z0-9]+>/", $acl_string, $array);
4647 // check for each cid if it is available on server
4648 $cid_array = $array[0];
4649 foreach ($cid_array as $cid) {
4650 $cid = str_replace("<", "", $cid);
4651 $cid = str_replace(">", "", $cid);
4653 "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
4657 $contact_not_found |= !DBM::is_result($contact);
4659 return $contact_not_found;
4664 * @param string $mediatype
4665 * @param array $media
4666 * @param string $type
4667 * @param string $album
4668 * @param string $allow_cid
4669 * @param string $deny_cid
4670 * @param string $allow_gid
4671 * @param string $deny_gid
4672 * @param string $desc
4673 * @param integer $profile
4674 * @param boolean $visibility
4675 * @param string $photo_id
4677 function save_media_to_database($mediatype, $media, $type, $album, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $desc, $profile = 0, $visibility = false, $photo_id = null)
4685 if (is_array($media)) {
4686 if (is_array($media['tmp_name'])) {
4687 $src = $media['tmp_name'][0];
4689 $src = $media['tmp_name'];
4691 if (is_array($media['name'])) {
4692 $filename = basename($media['name'][0]);
4694 $filename = basename($media['name']);
4696 if (is_array($media['size'])) {
4697 $filesize = intval($media['size'][0]);
4699 $filesize = intval($media['size']);
4701 if (is_array($media['type'])) {
4702 $filetype = $media['type'][0];
4704 $filetype = $media['type'];
4708 if ($filetype == "") {
4709 $filetype=Image::guessType($filename);
4711 $imagedata = getimagesize($src);
4713 $filetype = $imagedata['mime'];
4716 "File upload src: " . $src . " - filename: " . $filename .
4717 " - size: " . $filesize . " - type: " . $filetype,
4721 // check if there was a php upload error
4722 if ($filesize == 0 && $media['error'] == 1) {
4723 throw new InternalServerErrorException("image size exceeds PHP config settings, file was rejected by server");
4725 // check against max upload size within Friendica instance
4726 $maximagesize = Config::get('system', 'maximagesize');
4727 if ($maximagesize && ($filesize > $maximagesize)) {
4728 $formattedBytes = formatBytes($maximagesize);
4729 throw new InternalServerErrorException("image size exceeds Friendica config setting (uploaded size: $formattedBytes)");
4732 // create Photo instance with the data of the image
4733 $imagedata = @file_get_contents($src);
4734 $Image = new Image($imagedata, $filetype);
4735 if (! $Image->isValid()) {
4736 throw new InternalServerErrorException("unable to process image data");
4739 // check orientation of image
4740 $Image->orient($src);
4743 // check max length of images on server
4744 $max_length = Config::get('system', 'max_image_length');
4745 if (! $max_length) {
4746 $max_length = MAX_IMAGE_LENGTH;
4748 if ($max_length > 0) {
4749 $Image->scaleDown($max_length);
4750 logger("File upload: Scaling picture to new size " . $max_length, LOGGER_DEBUG);
4752 $width = $Image->getWidth();
4753 $height = $Image->getHeight();
4755 // create a new resource-id if not already provided
4756 $hash = ($photo_id == null) ? Photo::newResource() : $photo_id;
4758 if ($mediatype == "photo") {
4759 // upload normal image (scales 0, 1, 2)
4760 logger("photo upload: starting new photo upload", LOGGER_DEBUG);
4762 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 0, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4764 logger("photo upload: image upload with scale 0 (original size) failed");
4766 if ($width > 640 || $height > 640) {
4767 $Image->scaleDown(640);
4768 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 1, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4770 logger("photo upload: image upload with scale 1 (640x640) failed");
4774 if ($width > 320 || $height > 320) {
4775 $Image->scaleDown(320);
4776 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 2, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4778 logger("photo upload: image upload with scale 2 (320x320) failed");
4781 logger("photo upload: new photo upload ended", LOGGER_DEBUG);
4782 } elseif ($mediatype == "profileimage") {
4783 // upload profile image (scales 4, 5, 6)
4784 logger("photo upload: starting new profile image upload", LOGGER_DEBUG);
4786 if ($width > 175 || $height > 175) {
4787 $Image->scaleDown(175);
4788 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 4, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4790 logger("photo upload: profile image upload with scale 4 (175x175) failed");
4794 if ($width > 80 || $height > 80) {
4795 $Image->scaleDown(80);
4796 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 5, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4798 logger("photo upload: profile image upload with scale 5 (80x80) failed");
4802 if ($width > 48 || $height > 48) {
4803 $Image->scaleDown(48);
4804 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 6, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4806 logger("photo upload: profile image upload with scale 6 (48x48) failed");
4809 $Image->__destruct();
4810 logger("photo upload: new profile image upload ended", LOGGER_DEBUG);
4814 // create entry in 'item'-table on new uploads to enable users to comment/like/dislike the photo
4815 if ($photo_id == null && $mediatype == "photo") {
4816 post_photo_item($hash, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility);
4818 // on success return image data in json/xml format (like /api/friendica/photo does when no scale is given)
4819 return prepare_photo_data($type, false, $hash);
4821 throw new InternalServerErrorException("image upload failed");
4827 * @param string $hash
4828 * @param string $allow_cid
4829 * @param string $deny_cid
4830 * @param string $allow_gid
4831 * @param string $deny_gid
4832 * @param string $filetype
4833 * @param boolean $visibility
4835 function post_photo_item($hash, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility = false)
4837 // get data about the api authenticated user
4838 $uri = item_new_uri(get_app()->get_hostname(), intval(api_user()));
4839 $owner_record = q("SELECT * FROM `contact` WHERE `uid`= %d AND `self` LIMIT 1", intval(api_user()));
4842 $arr['guid'] = get_guid(32);
4843 $arr['uid'] = intval(api_user());
4845 $arr['parent-uri'] = $uri;
4846 $arr['type'] = 'photo';
4848 $arr['resource-id'] = $hash;
4849 $arr['contact-id'] = $owner_record[0]['id'];
4850 $arr['owner-name'] = $owner_record[0]['name'];
4851 $arr['owner-link'] = $owner_record[0]['url'];
4852 $arr['owner-avatar'] = $owner_record[0]['thumb'];
4853 $arr['author-name'] = $owner_record[0]['name'];
4854 $arr['author-link'] = $owner_record[0]['url'];
4855 $arr['author-avatar'] = $owner_record[0]['thumb'];
4857 $arr['allow_cid'] = $allow_cid;
4858 $arr['allow_gid'] = $allow_gid;
4859 $arr['deny_cid'] = $deny_cid;
4860 $arr['deny_gid'] = $deny_gid;
4861 $arr['visible'] = $visibility;
4865 'image/jpeg' => 'jpg',
4866 'image/png' => 'png',
4867 'image/gif' => 'gif'
4870 // adds link to the thumbnail scale photo
4871 $arr['body'] = '[url=' . System::baseUrl() . '/photos/' . $owner_record[0]['nick'] . '/image/' . $hash . ']'
4872 . '[img]' . System::baseUrl() . '/photo/' . $hash . '-' . "2" . '.'. $typetoext[$filetype] . '[/img]'
4875 // do the magic for storing the item in the database and trigger the federation to other contacts
4881 * @param string $type
4883 * @param string $photo_id
4887 function prepare_photo_data($type, $scale, $photo_id)
4889 $scale_sql = ($scale === false ? "" : sprintf("AND scale=%d", intval($scale)));
4890 $data_sql = ($scale === false ? "" : "data, ");
4892 // added allow_cid, allow_gid, deny_cid, deny_gid to output as string like stored in database
4893 // clients needs to convert this in their way for further processing
4895 "SELECT %s `resource-id`, `created`, `edited`, `title`, `desc`, `album`, `filename`,
4896 `type`, `height`, `width`, `datasize`, `profile`, `allow_cid`, `deny_cid`, `allow_gid`, `deny_gid`,
4897 MIN(`scale`) AS `minscale`, MAX(`scale`) AS `maxscale`
4898 FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s' %s GROUP BY `resource-id`",
4900 intval(local_user()),
4906 'image/jpeg' => 'jpg',
4907 'image/png' => 'png',
4908 'image/gif' => 'gif'
4911 // prepare output data for photo
4912 if (DBM::is_result($r)) {
4913 $data = ['photo' => $r[0]];
4914 $data['photo']['id'] = $data['photo']['resource-id'];
4915 if ($scale !== false) {
4916 $data['photo']['data'] = base64_encode($data['photo']['data']);
4918 unset($data['photo']['datasize']); //needed only with scale param
4920 if ($type == "xml") {
4921 $data['photo']['links'] = [];
4922 for ($k = intval($data['photo']['minscale']); $k <= intval($data['photo']['maxscale']); $k++) {
4923 $data['photo']['links'][$k . ":link"]["@attributes"] = ["type" => $data['photo']['type'],
4925 "href" => System::baseUrl() . "/photo/" . $data['photo']['resource-id'] . "-" . $k . "." . $typetoext[$data['photo']['type']]];
4928 $data['photo']['link'] = [];
4929 // when we have profile images we could have only scales from 4 to 6, but index of array always needs to start with 0
4931 for ($k = intval($data['photo']['minscale']); $k <= intval($data['photo']['maxscale']); $k++) {
4932 $data['photo']['link'][$i] = System::baseUrl() . "/photo/" . $data['photo']['resource-id'] . "-" . $k . "." . $typetoext[$data['photo']['type']];
4936 unset($data['photo']['resource-id']);
4937 unset($data['photo']['minscale']);
4938 unset($data['photo']['maxscale']);
4940 throw new NotFoundException();
4943 // retrieve item element for getting activities (like, dislike etc.) related to photo
4945 "SELECT * FROM `item` WHERE `uid` = %d AND `resource-id` = '%s' AND `type` = 'photo'",
4946 intval(local_user()),
4949 $data['photo']['friendica_activities'] = api_format_items_activities($item[0], $type);
4951 // retrieve comments on photo
4953 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`,
4954 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
4955 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
4956 `contact`.`id` AS `cid`
4958 STRAIGHT_JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
4959 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
4960 WHERE `item`.`parent` = %d AND `item`.`visible`
4961 AND NOT `item`.`moderated` AND NOT `item`.`deleted`
4962 AND `item`.`uid` = %d AND (`item`.`verb`='%s' OR `type`='photo')",
4963 intval($item[0]['parent']),
4965 dbesc(ACTIVITY_POST)
4968 // prepare output of comments
4969 $commentData = api_format_items($r, api_get_user(get_app()), false, $type);
4971 if ($type == "xml") {
4973 foreach ($commentData as $comment) {
4974 $comments[$k++ . ":comment"] = $comment;
4977 foreach ($commentData as $comment) {
4978 $comments[] = $comment;
4981 $data['photo']['friendica_comments'] = $comments;
4983 // include info if rights on photo and rights on item are mismatching
4984 $rights_mismatch = $data['photo']['allow_cid'] != $item[0]['allow_cid'] ||
4985 $data['photo']['deny_cid'] != $item[0]['deny_cid'] ||
4986 $data['photo']['allow_gid'] != $item[0]['allow_gid'] ||
4987 $data['photo']['deny_cid'] != $item[0]['deny_cid'];
4988 $data['photo']['rights_mismatch'] = $rights_mismatch;
4995 * Similar as /mod/redir.php
4996 * redirect to 'url' after dfrn auth
4998 * Why this when there is mod/redir.php already?
4999 * This use api_user() and api_login()
5002 * c_url: url of remote contact to auth to
5003 * url: string, url to redirect after auth
5005 function api_friendica_remoteauth()
5007 $url = (x($_GET, 'url') ? $_GET['url'] : '');
5008 $c_url = (x($_GET, 'c_url') ? $_GET['c_url'] : '');
5010 if ($url === '' || $c_url === '') {
5011 throw new BadRequestException("Wrong parameters.");
5014 $c_url = normalise_link($c_url);
5018 $contact = dba::selectFirst('contact', [], ['uid' => api_user(), 'nurl' => $c_url]);
5020 if (!DBM::is_result($contact) || ($contact['network'] !== NETWORK_DFRN)) {
5021 throw new BadRequestException("Unknown contact");
5024 $cid = $contact['id'];
5026 $dfrn_id = defaults($contact, 'issued-id', $contact['dfrn-id']);
5028 if ($contact['duplex'] && $contact['issued-id']) {
5029 $orig_id = $contact['issued-id'];
5030 $dfrn_id = '1:' . $orig_id;
5032 if ($contact['duplex'] && $contact['dfrn-id']) {
5033 $orig_id = $contact['dfrn-id'];
5034 $dfrn_id = '0:' . $orig_id;
5037 $sec = random_string();
5040 "INSERT INTO `profile_check` ( `uid`, `cid`, `dfrn_id`, `sec`, `expire`)
5041 VALUES( %d, %s, '%s', '%s', %d )",
5049 logger($contact['name'] . ' ' . $sec, LOGGER_DEBUG);
5050 $dest = ($url ? '&destination_url=' . $url : '');
5052 $contact['poll'] . '?dfrn_id=' . $dfrn_id
5053 . '&dfrn_version=' . DFRN_PROTOCOL_VERSION
5054 . '&type=profile&sec=' . $sec . $dest
5057 api_register_func('api/friendica/remoteauth', 'api_friendica_remoteauth', true);
5060 * @brief Return the item shared, if the item contains only the [share] tag
5062 * @param array $item Sharer item
5063 * @return array|false Shared item or false if not a reshare
5065 function api_share_as_retweet(&$item)
5067 $body = trim($item["body"]);
5069 if (Diaspora::isReshare($body, false)===false) {
5073 /// @TODO "$1" should maybe mean '$1' ?
5074 $attributes = preg_replace("/\[share(.*?)\]\s?(.*?)\s?\[\/share\]\s?/ism", "$1", $body);
5076 * Skip if there is no shared message in there
5077 * we already checked this in diaspora::isReshare()
5078 * but better one more than one less...
5080 if ($body == $attributes) {
5085 // build the fake reshared item
5086 $reshared_item = $item;
5089 preg_match("/author='(.*?)'/ism", $attributes, $matches);
5090 if ($matches[1] != "") {
5091 $author = html_entity_decode($matches[1], ENT_QUOTES, 'UTF-8');
5094 preg_match('/author="(.*?)"/ism', $attributes, $matches);
5095 if ($matches[1] != "") {
5096 $author = $matches[1];
5100 preg_match("/profile='(.*?)'/ism", $attributes, $matches);
5101 if ($matches[1] != "") {
5102 $profile = $matches[1];
5105 preg_match('/profile="(.*?)"/ism', $attributes, $matches);
5106 if ($matches[1] != "") {
5107 $profile = $matches[1];
5111 preg_match("/avatar='(.*?)'/ism", $attributes, $matches);
5112 if ($matches[1] != "") {
5113 $avatar = $matches[1];
5116 preg_match('/avatar="(.*?)"/ism', $attributes, $matches);
5117 if ($matches[1] != "") {
5118 $avatar = $matches[1];
5122 preg_match("/link='(.*?)'/ism", $attributes, $matches);
5123 if ($matches[1] != "") {
5124 $link = $matches[1];
5127 preg_match('/link="(.*?)"/ism', $attributes, $matches);
5128 if ($matches[1] != "") {
5129 $link = $matches[1];
5133 preg_match("/posted='(.*?)'/ism", $attributes, $matches);
5134 if ($matches[1] != "") {
5135 $posted = $matches[1];
5138 preg_match('/posted="(.*?)"/ism', $attributes, $matches);
5139 if ($matches[1] != "") {
5140 $posted = $matches[1];
5143 $shared_body = preg_replace("/\[share(.*?)\]\s?(.*?)\s?\[\/share\]\s?/ism", "$2", $body);
5145 if (($shared_body == "") || ($profile == "") || ($author == "") || ($avatar == "") || ($posted == "")) {
5149 $reshared_item["body"] = $shared_body;
5150 $reshared_item["author-name"] = $author;
5151 $reshared_item["author-link"] = $profile;
5152 $reshared_item["author-avatar"] = $avatar;
5153 $reshared_item["plink"] = $link;
5154 $reshared_item["created"] = $posted;
5155 $reshared_item["edited"] = $posted;
5157 return $reshared_item;
5162 * @param string $profile
5164 * @return string|false
5165 * @todo remove trailing junk from profile url
5166 * @todo pump.io check has to check the website
5168 function api_get_nick($profile)
5173 "SELECT `nick` FROM `contact` WHERE `uid` = 0 AND `nurl` = '%s'",
5174 dbesc(normalise_link($profile))
5177 if (DBM::is_result($r)) {
5178 $nick = $r[0]["nick"];
5183 "SELECT `nick` FROM `contact` WHERE `uid` = 0 AND `nurl` = '%s'",
5184 dbesc(normalise_link($profile))
5187 if (DBM::is_result($r)) {
5188 $nick = $r[0]["nick"];
5193 $friendica = preg_replace("=https?://(.*)/profile/(.*)=ism", "$2", $profile);
5194 if ($friendica != $profile) {
5200 $diaspora = preg_replace("=https?://(.*)/u/(.*)=ism", "$2", $profile);
5201 if ($diaspora != $profile) {
5207 $twitter = preg_replace("=https?://twitter.com/(.*)=ism", "$1", $profile);
5208 if ($twitter != $profile) {
5215 $StatusnetHost = preg_replace("=https?://(.*)/user/(.*)=ism", "$1", $profile);
5216 if ($StatusnetHost != $profile) {
5217 $StatusnetUser = preg_replace("=https?://(.*)/user/(.*)=ism", "$2", $profile);
5218 if ($StatusnetUser != $profile) {
5219 $UserData = Network::fetchUrl("http://".$StatusnetHost."/api/users/show.json?user_id=".$StatusnetUser);
5220 $user = json_decode($UserData);
5222 $nick = $user->screen_name;
5228 // To-Do: look at the page if its really a pumpio site
5229 //if (!$nick == "") {
5230 // $pumpio = preg_replace("=https?://(.*)/(.*)/=ism", "$2", $profile."/");
5231 // if ($pumpio != $profile)
5233 // <div class="media" id="profile-block" data-profile-id="acct:kabniel@microca.st">
5246 * @param array $item
5250 function api_in_reply_to($item)
5254 $in_reply_to['status_id'] = null;
5255 $in_reply_to['user_id'] = null;
5256 $in_reply_to['status_id_str'] = null;
5257 $in_reply_to['user_id_str'] = null;
5258 $in_reply_to['screen_name'] = null;
5260 if (($item['thr-parent'] != $item['uri']) && (intval($item['parent']) != intval($item['id']))) {
5262 "SELECT `id` FROM `item` WHERE `uid` = %d AND `uri` = '%s' LIMIT 1",
5263 intval($item['uid']),
5264 dbesc($item['thr-parent'])
5267 if (DBM::is_result($r)) {
5268 $in_reply_to['status_id'] = intval($r[0]['id']);
5270 $in_reply_to['status_id'] = intval($item['parent']);
5273 $in_reply_to['status_id_str'] = (string) intval($in_reply_to['status_id']);
5276 "SELECT `contact`.`nick`, `contact`.`name`, `contact`.`id`, `contact`.`url` FROM item
5277 STRAIGHT_JOIN `contact` ON `contact`.`id` = `item`.`author-id`
5278 WHERE `item`.`id` = %d LIMIT 1",
5279 intval($in_reply_to['status_id'])
5282 if (DBM::is_result($r)) {
5283 if ($r[0]['nick'] == "") {
5284 $r[0]['nick'] = api_get_nick($r[0]["url"]);
5287 $in_reply_to['screen_name'] = (($r[0]['nick']) ? $r[0]['nick'] : $r[0]['name']);
5288 $in_reply_to['user_id'] = intval($r[0]['id']);
5289 $in_reply_to['user_id_str'] = (string) intval($r[0]['id']);
5292 // There seems to be situation, where both fields are identical:
5293 // https://github.com/friendica/friendica/issues/1010
5294 // This is a bugfix for that.
5295 if (intval($in_reply_to['status_id']) == intval($item['id'])) {
5296 logger('this message should never appear: id: '.$item['id'].' similar to reply-to: '.$in_reply_to['status_id'], LOGGER_DEBUG);
5297 $in_reply_to['status_id'] = null;
5298 $in_reply_to['user_id'] = null;
5299 $in_reply_to['status_id_str'] = null;
5300 $in_reply_to['user_id_str'] = null;
5301 $in_reply_to['screen_name'] = null;
5305 return $in_reply_to;
5310 * @param string $Text
5314 function api_clean_plain_items($Text)
5316 $include_entities = strtolower(x($_REQUEST, 'include_entities') ? $_REQUEST['include_entities'] : "false");
5318 $Text = BBCode::cleanPictureLinks($Text);
5319 $URLSearchString = "^\[\]";
5321 $Text = preg_replace("/([!#@])\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '$1$3', $Text);
5323 if ($include_entities == "true") {
5324 $Text = preg_replace("/\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '[url=$1]$1[/url]', $Text);
5327 // Simplify "attachment" element
5328 $Text = api_clean_attachments($Text);
5334 * @brief Removes most sharing information for API text export
5336 * @param string $body The original body
5338 * @return string Cleaned body
5340 function api_clean_attachments($body)
5342 $data = BBCode::getAttachmentData($body);
5349 if (isset($data["text"])) {
5350 $body = $data["text"];
5352 if (($body == "") && isset($data["title"])) {
5353 $body = $data["title"];
5355 if (isset($data["url"])) {
5356 $body .= "\n".$data["url"];
5358 $body .= $data["after"];
5365 * @param array $contacts
5369 function api_best_nickname(&$contacts)
5373 if (count($contacts) == 0) {
5377 foreach ($contacts as $contact) {
5378 if ($contact["network"] == "") {
5379 $contact["network"] = "dfrn";
5380 $best_contact = [$contact];
5384 if (sizeof($best_contact) == 0) {
5385 foreach ($contacts as $contact) {
5386 if ($contact["network"] == "dfrn") {
5387 $best_contact = [$contact];
5392 if (sizeof($best_contact) == 0) {
5393 foreach ($contacts as $contact) {
5394 if ($contact["network"] == "dspr") {
5395 $best_contact = [$contact];
5400 if (sizeof($best_contact) == 0) {
5401 foreach ($contacts as $contact) {
5402 if ($contact["network"] == "stat") {
5403 $best_contact = [$contact];
5408 if (sizeof($best_contact) == 0) {
5409 foreach ($contacts as $contact) {
5410 if ($contact["network"] == "pump") {
5411 $best_contact = [$contact];
5416 if (sizeof($best_contact) == 0) {
5417 foreach ($contacts as $contact) {
5418 if ($contact["network"] == "twit") {
5419 $best_contact = [$contact];
5424 if (sizeof($best_contact) == 1) {
5425 $contacts = $best_contact;
5427 $contacts = [$contacts[0]];
5432 * Return all or a specified group of the user with the containing contacts.
5434 * @param string $type Return type (atom, rss, xml, json)
5436 * @return array|string
5438 function api_friendica_group_show($type)
5442 if (api_user() === false) {
5443 throw new ForbiddenException();
5447 $user_info = api_get_user($a);
5448 $gid = (x($_REQUEST, 'gid') ? $_REQUEST['gid'] : 0);
5449 $uid = $user_info['uid'];
5451 // get data of the specified group id or all groups if not specified
5454 "SELECT * FROM `group` WHERE `deleted` = 0 AND `uid` = %d AND `id` = %d",
5458 // error message if specified gid is not in database
5459 if (!DBM::is_result($r)) {
5460 throw new BadRequestException("gid not available");
5464 "SELECT * FROM `group` WHERE `deleted` = 0 AND `uid` = %d",
5469 // loop through all groups and retrieve all members for adding data in the user array
5470 foreach ($r as $rr) {
5471 $members = Contact::getByGroupId($rr['id']);
5474 if ($type == "xml") {
5475 $user_element = "users";
5477 foreach ($members as $member) {
5478 $user = api_get_user($a, $member['nurl']);
5479 $users[$k++.":user"] = $user;
5482 $user_element = "user";
5483 foreach ($members as $member) {
5484 $user = api_get_user($a, $member['nurl']);
5488 $grps[] = ['name' => $rr['name'], 'gid' => $rr['id'], $user_element => $users];
5490 return api_format_data("groups", $type, ['group' => $grps]);
5492 api_register_func('api/friendica/group_show', 'api_friendica_group_show', true);
5496 * Delete the specified group of the user.
5498 * @param string $type Return type (atom, rss, xml, json)
5500 * @return array|string
5502 function api_friendica_group_delete($type)
5506 if (api_user() === false) {
5507 throw new ForbiddenException();
5511 $user_info = api_get_user($a);
5512 $gid = (x($_REQUEST, 'gid') ? $_REQUEST['gid'] : 0);
5513 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5514 $uid = $user_info['uid'];
5516 // error if no gid specified
5517 if ($gid == 0 || $name == "") {
5518 throw new BadRequestException('gid or name not specified');
5521 // get data of the specified group id
5523 "SELECT * FROM `group` WHERE `uid` = %d AND `id` = %d",
5527 // error message if specified gid is not in database
5528 if (!DBM::is_result($r)) {
5529 throw new BadRequestException('gid not available');
5532 // get data of the specified group id and group name
5534 "SELECT * FROM `group` WHERE `uid` = %d AND `id` = %d AND `name` = '%s'",
5539 // error message if specified gid is not in database
5540 if (!DBM::is_result($rname)) {
5541 throw new BadRequestException('wrong group name');
5545 $ret = Group::removeByName($uid, $name);
5548 $success = ['success' => $ret, 'gid' => $gid, 'name' => $name, 'status' => 'deleted', 'wrong users' => []];
5549 return api_format_data("group_delete", $type, ['result' => $success]);
5551 throw new BadRequestException('other API error');
5554 api_register_func('api/friendica/group_delete', 'api_friendica_group_delete', true, API_METHOD_DELETE);
5559 * @param string $type Return type (atom, rss, xml, json)
5561 * @return array|string
5562 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-destroy
5564 function api_lists_destroy($type)
5568 if (api_user() === false) {
5569 throw new ForbiddenException();
5573 $user_info = api_get_user($a);
5574 $gid = (x($_REQUEST, 'list_id') ? $_REQUEST['list_id'] : 0);
5575 $uid = $user_info['uid'];
5577 // error if no gid specified
5579 throw new BadRequestException('gid not specified');
5582 // get data of the specified group id
5583 $group = dba::selectFirst('group', [], ['uid' => $uid, 'id' => $gid]);
5584 // error message if specified gid is not in database
5586 throw new BadRequestException('gid not available');
5589 if (Group::remove($gid)) {
5591 'name' => $group['name'],
5592 'id' => intval($gid),
5593 'id_str' => (string) $gid,
5594 'user' => $user_info
5597 return api_format_data("lists", $type, ['lists' => $list]);
5600 api_register_func('api/lists/destroy', 'api_lists_destroy', true, API_METHOD_DELETE);
5603 * Add a new group to the database.
5605 * @param string $name Group name
5606 * @param int $uid User ID
5607 * @param array $users List of users to add to the group
5611 function group_create($name, $uid, $users = [])
5613 // error if no name specified
5615 throw new BadRequestException('group name not specified');
5618 // get data of the specified group name
5620 "SELECT * FROM `group` WHERE `uid` = %d AND `name` = '%s' AND `deleted` = 0",
5624 // error message if specified group name already exists
5625 if (DBM::is_result($rname)) {
5626 throw new BadRequestException('group name already exists');
5629 // check if specified group name is a deleted group
5631 "SELECT * FROM `group` WHERE `uid` = %d AND `name` = '%s' AND `deleted` = 1",
5635 // error message if specified group name already exists
5636 if (DBM::is_result($rname)) {
5637 $reactivate_group = true;
5641 $ret = Group::create($uid, $name);
5643 $gid = Group::getIdByName($uid, $name);
5645 throw new BadRequestException('other API error');
5649 $erroraddinguser = false;
5651 foreach ($users as $user) {
5652 $cid = $user['cid'];
5653 // check if user really exists as contact
5655 "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
5659 if (count($contact)) {
5660 Group::addMember($gid, $cid);
5662 $erroraddinguser = true;
5663 $errorusers[] = $cid;
5667 // return success message incl. missing users in array
5668 $status = ($erroraddinguser ? "missing user" : ($reactivate_group ? "reactivated" : "ok"));
5670 return ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers];
5674 * Create the specified group with the posted array of contacts.
5676 * @param string $type Return type (atom, rss, xml, json)
5678 * @return array|string
5680 function api_friendica_group_create($type)
5684 if (api_user() === false) {
5685 throw new ForbiddenException();
5689 $user_info = api_get_user($a);
5690 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5691 $uid = $user_info['uid'];
5692 $json = json_decode($_POST['json'], true);
5693 $users = $json['user'];
5695 $success = group_create($name, $uid, $users);
5697 return api_format_data("group_create", $type, ['result' => $success]);
5699 api_register_func('api/friendica/group_create', 'api_friendica_group_create', true, API_METHOD_POST);
5702 * Create a new group.
5704 * @param string $type Return type (atom, rss, xml, json)
5706 * @return array|string
5707 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-create
5709 function api_lists_create($type)
5713 if (api_user() === false) {
5714 throw new ForbiddenException();
5718 $user_info = api_get_user($a);
5719 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5720 $uid = $user_info['uid'];
5722 $success = group_create($name, $uid);
5723 if ($success['success']) {
5725 'name' => $success['name'],
5726 'id' => intval($success['gid']),
5727 'id_str' => (string) $success['gid'],
5728 'user' => $user_info
5731 return api_format_data("lists", $type, ['lists'=>$grp]);
5734 api_register_func('api/lists/create', 'api_lists_create', true, API_METHOD_POST);
5737 * Update the specified group with the posted array of contacts.
5739 * @param string $type Return type (atom, rss, xml, json)
5741 * @return array|string
5743 function api_friendica_group_update($type)
5747 if (api_user() === false) {
5748 throw new ForbiddenException();
5752 $user_info = api_get_user($a);
5753 $uid = $user_info['uid'];
5754 $gid = (x($_REQUEST, 'gid') ? $_REQUEST['gid'] : 0);
5755 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5756 $json = json_decode($_POST['json'], true);
5757 $users = $json['user'];
5759 // error if no name specified
5761 throw new BadRequestException('group name not specified');
5764 // error if no gid specified
5766 throw new BadRequestException('gid not specified');
5770 $members = Contact::getByGroupId($gid);
5771 foreach ($members as $member) {
5772 $cid = $member['id'];
5773 foreach ($users as $user) {
5774 $found = ($user['cid'] == $cid ? true : false);
5777 Group::removeMemberByName($uid, $name, $cid);
5782 $erroraddinguser = false;
5784 foreach ($users as $user) {
5785 $cid = $user['cid'];
5786 // check if user really exists as contact
5788 "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
5793 if (count($contact)) {
5794 Group::addMember($gid, $cid);
5796 $erroraddinguser = true;
5797 $errorusers[] = $cid;
5801 // return success message incl. missing users in array
5802 $status = ($erroraddinguser ? "missing user" : "ok");
5803 $success = ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers];
5804 return api_format_data("group_update", $type, ['result' => $success]);
5807 api_register_func('api/friendica/group_update', 'api_friendica_group_update', true, API_METHOD_POST);
5810 * Update information about a group.
5812 * @param string $type Return type (atom, rss, xml, json)
5814 * @return array|string
5815 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-update
5817 function api_lists_update($type)
5821 if (api_user() === false) {
5822 throw new ForbiddenException();
5826 $user_info = api_get_user($a);
5827 $gid = (x($_REQUEST, 'list_id') ? $_REQUEST['list_id'] : 0);
5828 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5829 $uid = $user_info['uid'];
5831 // error if no gid specified
5833 throw new BadRequestException('gid not specified');
5836 // get data of the specified group id
5837 $group = dba::selectFirst('group', [], ['uid' => $uid, 'id' => $gid]);
5838 // error message if specified gid is not in database
5840 throw new BadRequestException('gid not available');
5843 if (Group::update($gid, $name)) {
5846 'id' => intval($gid),
5847 'id_str' => (string) $gid,
5848 'user' => $user_info
5851 return api_format_data("lists", $type, ['lists' => $list]);
5854 return api_format_data("group_update", $type, ['result' => $success]);
5857 api_register_func('api/lists/update', 'api_lists_update', true, API_METHOD_POST);
5861 * @param string $type Return type (atom, rss, xml, json)
5863 * @return array|string
5865 function api_friendica_activity($type)
5869 if (api_user() === false) {
5870 throw new ForbiddenException();
5872 $verb = strtolower($a->argv[3]);
5873 $verb = preg_replace("|\..*$|", "", $verb);
5875 $id = (x($_REQUEST, 'id') ? $_REQUEST['id'] : 0);
5877 $res = Item::performLike($id, $verb);
5880 if ($type == "xml") {
5885 return api_format_data('ok', $type, ['ok' => $ok]);
5887 throw new BadRequestException('Error adding activity');
5891 /// @TODO move to top of file or somewhere better
5892 api_register_func('api/friendica/activity/like', 'api_friendica_activity', true, API_METHOD_POST);
5893 api_register_func('api/friendica/activity/dislike', 'api_friendica_activity', true, API_METHOD_POST);
5894 api_register_func('api/friendica/activity/attendyes', 'api_friendica_activity', true, API_METHOD_POST);
5895 api_register_func('api/friendica/activity/attendno', 'api_friendica_activity', true, API_METHOD_POST);
5896 api_register_func('api/friendica/activity/attendmaybe', 'api_friendica_activity', true, API_METHOD_POST);
5897 api_register_func('api/friendica/activity/unlike', 'api_friendica_activity', true, API_METHOD_POST);
5898 api_register_func('api/friendica/activity/undislike', 'api_friendica_activity', true, API_METHOD_POST);
5899 api_register_func('api/friendica/activity/unattendyes', 'api_friendica_activity', true, API_METHOD_POST);
5900 api_register_func('api/friendica/activity/unattendno', 'api_friendica_activity', true, API_METHOD_POST);
5901 api_register_func('api/friendica/activity/unattendmaybe', 'api_friendica_activity', true, API_METHOD_POST);
5904 * @brief Returns notifications
5906 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5909 function api_friendica_notification($type)
5913 if (api_user() === false) {
5914 throw new ForbiddenException();
5917 throw new BadRequestException("Invalid argument count");
5919 $nm = new NotificationsManager();
5921 $notes = $nm->getAll([], "+seen -date", 50);
5923 if ($type == "xml") {
5925 foreach ($notes as $note) {
5926 $xmlnotes[] = ["@attributes" => $note];
5932 return api_format_data("notes", $type, ['note' => $notes]);
5936 * POST request with 'id' param as notification id
5938 * @brief Set notification as seen and returns associated item (if possible)
5940 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5943 function api_friendica_notification_seen($type)
5947 if (api_user() === false) {
5948 throw new ForbiddenException();
5951 throw new BadRequestException("Invalid argument count");
5954 $id = (x($_REQUEST, 'id') ? intval($_REQUEST['id']) : 0);
5956 $nm = new NotificationsManager();
5957 $note = $nm->getByID($id);
5958 if (is_null($note)) {
5959 throw new BadRequestException("Invalid argument");
5962 $nm->setSeen($note);
5963 if ($note['otype']=='item') {
5964 // would be really better with an ItemsManager and $im->getByID() :-P
5966 "SELECT * FROM `item` WHERE `id`=%d AND `uid`=%d",
5967 intval($note['iid']),
5968 intval(local_user())
5971 // we found the item, return it to the user
5972 $user_info = api_get_user($a);
5973 $ret = api_format_items($r, $user_info, false, $type);
5974 $data = ['status' => $ret];
5975 return api_format_data("status", $type, $data);
5977 // the item can't be found, but we set the note as seen, so we count this as a success
5979 return api_format_data('result', $type, ['result' => "success"]);
5982 /// @TODO move to top of file or somewhere better
5983 api_register_func('api/friendica/notification/seen', 'api_friendica_notification_seen', true, API_METHOD_POST);
5984 api_register_func('api/friendica/notification', 'api_friendica_notification', true, API_METHOD_GET);
5987 * @brief update a direct_message to seen state
5989 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5990 * @return string (success result=ok, error result=error with error message)
5992 function api_friendica_direct_messages_setseen($type)
5995 if (api_user() === false) {
5996 throw new ForbiddenException();
6000 $user_info = api_get_user($a);
6001 $uid = $user_info['uid'];
6002 $id = (x($_REQUEST, 'id') ? $_REQUEST['id'] : 0);
6004 // return error if id is zero
6006 $answer = ['result' => 'error', 'message' => 'message id not specified'];
6007 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
6010 // get data of the specified message id
6012 "SELECT `id` FROM `mail` WHERE `id` = %d AND `uid` = %d",
6017 // error message if specified id is not in database
6018 if (!DBM::is_result($r)) {
6019 $answer = ['result' => 'error', 'message' => 'message id not in database'];
6020 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
6023 // update seen indicator
6025 "UPDATE `mail` SET `seen` = 1 WHERE `id` = %d AND `uid` = %d",
6032 $answer = ['result' => 'ok', 'message' => 'message set to seen'];
6033 return api_format_data("direct_message_setseen", $type, ['$result' => $answer]);
6035 $answer = ['result' => 'error', 'message' => 'unknown error'];
6036 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
6040 /// @TODO move to top of file or somewhere better
6041 api_register_func('api/friendica/direct_messages_setseen', 'api_friendica_direct_messages_setseen', true);
6044 * @brief search for direct_messages containing a searchstring through api
6046 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
6047 * @param string $box
6048 * @return string (success: success=true if found and search_result contains found messages,
6049 * success=false if nothing was found, search_result='nothing found',
6050 * error: result=error with error message)
6052 function api_friendica_direct_messages_search($type, $box = "")
6056 if (api_user() === false) {
6057 throw new ForbiddenException();
6061 $user_info = api_get_user($a);
6062 $searchstring = (x($_REQUEST, 'searchstring') ? $_REQUEST['searchstring'] : "");
6063 $uid = $user_info['uid'];
6065 // error if no searchstring specified
6066 if ($searchstring == "") {
6067 $answer = ['result' => 'error', 'message' => 'searchstring not specified'];
6068 return api_format_data("direct_messages_search", $type, ['$result' => $answer]);
6071 // get data for the specified searchstring
6073 "SELECT `mail`.*, `contact`.`nurl` AS `contact-url` FROM `mail`,`contact` WHERE `mail`.`contact-id` = `contact`.`id` AND `mail`.`uid`=%d AND `body` LIKE '%s' ORDER BY `mail`.`id` DESC",
6075 dbesc('%'.$searchstring.'%')
6078 $profile_url = $user_info["url"];
6080 // message if nothing was found
6081 if (!DBM::is_result($r)) {
6082 $success = ['success' => false, 'search_results' => 'problem with query'];
6083 } elseif (count($r) == 0) {
6084 $success = ['success' => false, 'search_results' => 'nothing found'];
6087 foreach ($r as $item) {
6088 if ($box == "inbox" || $item['from-url'] != $profile_url) {
6089 $recipient = $user_info;
6090 $sender = api_get_user($a, normalise_link($item['contact-url']));
6091 } elseif ($box == "sentbox" || $item['from-url'] == $profile_url) {
6092 $recipient = api_get_user($a, normalise_link($item['contact-url']));
6093 $sender = $user_info;
6096 $ret[] = api_format_messages($item, $recipient, $sender);
6098 $success = ['success' => true, 'search_results' => $ret];
6101 return api_format_data("direct_message_search", $type, ['$result' => $success]);
6104 /// @TODO move to top of file or somewhere better
6105 api_register_func('api/friendica/direct_messages_search', 'api_friendica_direct_messages_search', true);
6108 * @brief return data of all the profiles a user has to the client
6110 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
6113 function api_friendica_profile_show($type)
6117 if (api_user() === false) {
6118 throw new ForbiddenException();
6122 $profileid = (x($_REQUEST, 'profile_id') ? $_REQUEST['profile_id'] : 0);
6124 // retrieve general information about profiles for user
6125 $multi_profiles = Feature::isEnabled(api_user(), 'multi_profiles');
6126 $directory = Config::get('system', 'directory');
6128 // get data of the specified profile id or all profiles of the user if not specified
6129 if ($profileid != 0) {
6131 "SELECT * FROM `profile` WHERE `uid` = %d AND `id` = %d",
6136 // error message if specified gid is not in database
6137 if (!DBM::is_result($r)) {
6138 throw new BadRequestException("profile_id not available");
6142 "SELECT * FROM `profile` WHERE `uid` = %d",
6146 // loop through all returned profiles and retrieve data and users
6148 foreach ($r as $rr) {
6149 $profile = api_format_items_profiles($rr);
6151 // select all users from contact table, loop and prepare standard return for user data
6154 "SELECT `id`, `nurl` FROM `contact` WHERE `uid`= %d AND `profile-id` = %d",
6156 intval($rr['profile_id'])
6159 foreach ($r as $rr) {
6160 $user = api_get_user($a, $rr['nurl']);
6161 ($type == "xml") ? $users[$k++ . ":user"] = $user : $users[] = $user;
6163 $profile['users'] = $users;
6165 // add prepared profile data to array for final return
6166 if ($type == "xml") {
6167 $profiles[$k++ . ":profile"] = $profile;
6169 $profiles[] = $profile;
6173 // return settings, authenticated user and profiles data
6174 $self = q("SELECT `nurl` FROM `contact` WHERE `uid`= %d AND `self` LIMIT 1", intval(api_user()));
6176 $result = ['multi_profiles' => $multi_profiles ? true : false,
6177 'global_dir' => $directory,
6178 'friendica_owner' => api_get_user($a, $self[0]['nurl']),
6179 'profiles' => $profiles];
6180 return api_format_data("friendica_profiles", $type, ['$result' => $result]);
6182 api_register_func('api/friendica/profile/show', 'api_friendica_profile_show', true, API_METHOD_GET);
6185 * Returns a list of saved searches.
6187 * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-saved_searches-list
6189 * @param string $type Return format: json or xml
6191 * @return string|array
6193 function api_saved_searches_list($type)
6195 $terms = dba::select('search', ['id', 'term'], ['uid' => local_user()]);
6198 while ($term = $terms->fetch()) {
6200 'created_at' => api_date(time()),
6201 'id' => intval($term['id']),
6202 'id_str' => $term['id'],
6203 'name' => $term['term'],
6205 'query' => $term['term']
6211 return api_format_data("terms", $type, ['terms' => $result]);
6214 /// @TODO move to top of file or somewhere better
6215 api_register_func('api/saved_searches/list', 'api_saved_searches_list', true);
6218 @TODO Maybe open to implement?
6220 [pagename] => api/1.1/statuses/lookup.json
6221 [id] => 605138389168451584
6222 [include_cards] => true
6223 [cards_platform] => Android-12
6224 [include_entities] => true
6225 [include_my_retweet] => 1
6227 [include_reply_count] => true
6228 [include_descendent_reply_count] => true
6232 Not implemented by now:
6233 statuses/retweets_of_me
6238 account/update_location
6239 account/update_profile_background_image
6242 friendica/profile/update
6243 friendica/profile/create
6244 friendica/profile/delete
6246 Not implemented in status.net:
6247 statuses/retweeted_to_me
6248 statuses/retweeted_by_me
6249 direct_messages/destroy
6251 account/update_delivery_device
6252 notifications/follow