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));
226 if ($user_id !== false) {
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|array 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 $json = json_encode(end($return));
391 if (x($_GET, 'callback')) {
392 $json = $_GET['callback'] . "(" . $json . ")";
397 header("Content-Type: application/rss+xml");
398 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
401 header("Content-Type: application/atom+xml");
402 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
409 logger('API call not implemented: ' . $a->query_string);
410 throw new NotImplementedException();
411 } catch (HTTPException $e) {
412 header("HTTP/1.1 {$e->httpcode} {$e->httpdesc}");
413 return api_error($type, $e);
418 * @brief Format API error string
420 * @param string $type Return type (xml, json, rss, as)
421 * @param object $e HTTPException Error object
422 * @return string|array error message formatted as $type
424 function api_error($type, $e)
428 $error = ($e->getMessage() !== "" ? $e->getMessage() : $e->httpdesc);
429 /// @TODO: https://dev.twitter.com/overview/api/response-codes
431 $error = ["error" => $error,
432 "code" => $e->httpcode . " " . $e->httpdesc,
433 "request" => $a->query_string];
435 $return = api_format_data('status', $type, ['status' => $error]);
439 header("Content-Type: text/xml");
442 header("Content-Type: application/json");
443 $return = json_encode($return);
446 header("Content-Type: application/rss+xml");
449 header("Content-Type: application/atom+xml");
457 * @brief Set values for RSS template
460 * @param array $arr Array to be passed to template
461 * @param array $user_info User info
463 * @todo find proper type-hints
465 function api_rss_extra(App $a, $arr, $user_info)
467 if (is_null($user_info)) {
468 $user_info = api_get_user($a);
471 $arr['$user'] = $user_info;
473 'alternate' => $user_info['url'],
474 'self' => System::baseUrl() . "/" . $a->query_string,
475 'base' => System::baseUrl(),
476 'updated' => api_date(null),
477 'atom_updated' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
478 'language' => $user_info['language'],
479 'logo' => System::baseUrl() . "/images/friendica-32.png",
487 * @brief Unique contact to contact url.
489 * @param int $id Contact id
490 * @return bool|string
491 * Contact url or False if contact id is unknown
493 function api_unique_id_to_nurl($id)
495 $r = dba::selectFirst('contact', ['nurl'], ['uid' => 0, 'id' => $id]);
497 if (DBM::is_result($r)) {
505 * @brief Get user info array.
507 * @param object $a App
508 * @param int|string $contact_id Contact ID or URL
510 function api_get_user(App $a, $contact_id = null)
518 logger("api_get_user: Fetching user data for user ".$contact_id, LOGGER_DEBUG);
520 // Searching for contact URL
521 if (!is_null($contact_id) && (intval($contact_id) == 0)) {
522 $user = dbesc(normalise_link($contact_id));
524 $extra_query = "AND `contact`.`nurl` = '%s' ";
525 if (api_user() !== false) {
526 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
530 // Searching for contact id with uid = 0
531 if (!is_null($contact_id) && (intval($contact_id) != 0)) {
532 $user = dbesc(api_unique_id_to_nurl(intval($contact_id)));
535 throw new BadRequestException("User not found.");
539 $extra_query = "AND `contact`.`nurl` = '%s' ";
540 if (api_user() !== false) {
541 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
545 if (is_null($user) && x($_GET, 'user_id')) {
546 $user = dbesc(api_unique_id_to_nurl($_GET['user_id']));
549 throw new BadRequestException("User not found.");
553 $extra_query = "AND `contact`.`nurl` = '%s' ";
554 if (api_user() !== false) {
555 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
558 if (is_null($user) && x($_GET, 'screen_name')) {
559 $user = dbesc($_GET['screen_name']);
560 $extra_query = "AND `contact`.`nick` = '%s' ";
561 if (api_user() !== false) {
562 $extra_query .= "AND `contact`.`uid`=".intval(api_user());
566 if (is_null($user) && x($_GET, 'profileurl')) {
567 $user = dbesc(normalise_link($_GET['profileurl']));
568 $extra_query = "AND `contact`.`nurl` = '%s' ";
569 if (api_user() !== false) {
570 $extra_query .= "AND `contact`.`uid`=".intval(api_user());
574 if (is_null($user) && ($a->argc > (count($called_api) - 1)) && (count($called_api) > 0)) {
575 $argid = count($called_api);
576 list($user, $null) = explode(".", $a->argv[$argid]);
577 if (is_numeric($user)) {
578 $user = dbesc(api_unique_id_to_nurl(intval($user)));
582 $extra_query = "AND `contact`.`nurl` = '%s' ";
583 if (api_user() !== false) {
584 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
588 $user = dbesc($user);
589 $extra_query = "AND `contact`.`nick` = '%s' ";
590 if (api_user() !== false) {
591 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
596 logger("api_get_user: user ".$user, LOGGER_DEBUG);
599 if (api_user() === false) {
603 $user = $_SESSION['uid'];
604 $extra_query = "AND `contact`.`uid` = %d AND `contact`.`self` ";
608 logger('api_user: ' . $extra_query . ', user: ' . $user);
612 "SELECT *, `contact`.`id` AS `cid` FROM `contact`
618 // Selecting the id by priority, friendica first
619 if (is_array($uinfo)) {
620 api_best_nickname($uinfo);
623 // if the contact wasn't found, fetch it from the contacts with uid = 0
624 if (!DBM::is_result($uinfo)) {
628 $r = q("SELECT * FROM `contact` WHERE `uid` = 0 AND `nurl` = '%s' LIMIT 1", dbesc(normalise_link($url)));
631 if (DBM::is_result($r)) {
632 $network_name = ContactSelector::networkToName($r[0]['network'], $r[0]['url']);
634 // If no nick where given, extract it from the address
635 if (($r[0]['nick'] == "") || ($r[0]['name'] == $r[0]['nick'])) {
636 $r[0]['nick'] = api_get_nick($r[0]["url"]);
641 'id_str' => (string) $r[0]["id"],
642 'name' => $r[0]["name"],
643 'screen_name' => (($r[0]['nick']) ? $r[0]['nick'] : $r[0]['name']),
644 'location' => ($r[0]["location"] != "") ? $r[0]["location"] : $network_name,
645 'description' => $r[0]["about"],
646 'profile_image_url' => $r[0]["micro"],
647 'profile_image_url_https' => $r[0]["micro"],
648 'profile_image_url_profile_size' => $r[0]["thumb"],
649 'profile_image_url_large' => $r[0]["photo"],
650 'url' => $r[0]["url"],
651 'protected' => false,
652 'followers_count' => 0,
653 'friends_count' => 0,
655 'created_at' => api_date($r[0]["created"]),
656 'favourites_count' => 0,
658 'time_zone' => 'UTC',
659 'geo_enabled' => false,
661 'statuses_count' => 0,
663 'contributors_enabled' => false,
664 'is_translator' => false,
665 'is_translation_enabled' => false,
666 'following' => false,
667 'follow_request_sent' => false,
668 'statusnet_blocking' => false,
669 'notifications' => false,
670 'statusnet_profile_url' => $r[0]["url"],
672 'cid' => Contact::getIdForURL($r[0]["url"], api_user(), true),
674 'network' => $r[0]["network"],
679 throw new BadRequestException("User not found.");
683 if ($uinfo[0]['self']) {
684 if ($uinfo[0]['network'] == "") {
685 $uinfo[0]['network'] = NETWORK_DFRN;
689 "SELECT * FROM `user` WHERE `uid` = %d LIMIT 1",
693 "SELECT * FROM `profile` WHERE `uid` = %d AND `is-default` = 1 LIMIT 1",
697 /// @TODO old-lost code? (twice)
698 // Counting is deactivated by now, due to performance issues
699 // count public wall messages
700 //$r = q("SELECT COUNT(*) as `count` FROM `item` WHERE `uid` = %d AND `wall`",
701 // intval($uinfo[0]['uid'])
703 //$countitms = $r[0]['count'];
706 // Counting is deactivated by now, due to performance issues
707 //$r = q("SELECT count(*) as `count` FROM `item`
708 // WHERE `contact-id` = %d",
709 // intval($uinfo[0]['id'])
711 //$countitms = $r[0]['count'];
715 /// @TODO old-lost code? (twice)
717 // Counting is deactivated by now, due to performance issues
719 $r = q("SELECT count(*) as `count` FROM `contact`
720 WHERE `uid` = %d AND `rel` IN ( %d, %d )
721 AND `self`=0 AND NOT `blocked` AND NOT `pending` AND `hidden`=0",
722 intval($uinfo[0]['uid']),
723 intval(CONTACT_IS_SHARING),
724 intval(CONTACT_IS_FRIEND)
726 $countfriends = $r[0]['count'];
728 $r = q("SELECT count(*) as `count` FROM `contact`
729 WHERE `uid` = %d AND `rel` IN ( %d, %d )
730 AND `self`=0 AND NOT `blocked` AND NOT `pending` AND `hidden`=0",
731 intval($uinfo[0]['uid']),
732 intval(CONTACT_IS_FOLLOWER),
733 intval(CONTACT_IS_FRIEND)
735 $countfollowers = $r[0]['count'];
737 $r = q("SELECT count(*) as `count` FROM item where starred = 1 and uid = %d and deleted = 0",
738 intval($uinfo[0]['uid'])
740 $starred = $r[0]['count'];
743 if (! $uinfo[0]['self']) {
753 // Add a nick if it isn't present there
754 if (($uinfo[0]['nick'] == "") || ($uinfo[0]['name'] == $uinfo[0]['nick'])) {
755 $uinfo[0]['nick'] = api_get_nick($uinfo[0]["url"]);
758 $network_name = ContactSelector::networkToName($uinfo[0]['network'], $uinfo[0]['url']);
760 $pcontact_id = Contact::getIdForURL($uinfo[0]['url'], 0, true);
762 if (!empty($profile[0]['about'])) {
763 $description = $profile[0]['about'];
765 $description = $uinfo[0]["about"];
768 if (!empty($usr[0]['default-location'])) {
769 $location = $usr[0]['default-location'];
770 } elseif (!empty($uinfo[0]["location"])) {
771 $location = $uinfo[0]["location"];
773 $location = $network_name;
777 'id' => intval($pcontact_id),
778 'id_str' => (string) intval($pcontact_id),
779 'name' => (($uinfo[0]['name']) ? $uinfo[0]['name'] : $uinfo[0]['nick']),
780 'screen_name' => (($uinfo[0]['nick']) ? $uinfo[0]['nick'] : $uinfo[0]['name']),
781 'location' => $location,
782 'description' => $description,
783 'profile_image_url' => $uinfo[0]['micro'],
784 'profile_image_url_https' => $uinfo[0]['micro'],
785 'profile_image_url_profile_size' => $uinfo[0]["thumb"],
786 'profile_image_url_large' => $uinfo[0]["photo"],
787 'url' => $uinfo[0]['url'],
788 'protected' => false,
789 'followers_count' => intval($countfollowers),
790 'friends_count' => intval($countfriends),
792 'created_at' => api_date($uinfo[0]['created']),
793 'favourites_count' => intval($starred),
795 'time_zone' => 'UTC',
796 'geo_enabled' => false,
798 'statuses_count' => intval($countitms),
800 'contributors_enabled' => false,
801 'is_translator' => false,
802 'is_translation_enabled' => false,
803 'following' => (($uinfo[0]['rel'] == CONTACT_IS_FOLLOWER) || ($uinfo[0]['rel'] == CONTACT_IS_FRIEND)),
804 'follow_request_sent' => false,
805 'statusnet_blocking' => false,
806 'notifications' => false,
808 //'statusnet_profile_url' => System::baseUrl()."/contacts/".$uinfo[0]['cid'],
809 'statusnet_profile_url' => $uinfo[0]['url'],
810 'uid' => intval($uinfo[0]['uid']),
811 'cid' => intval($uinfo[0]['cid']),
812 'self' => $uinfo[0]['self'],
813 'network' => $uinfo[0]['network'],
816 // If this is a local user and it uses Frio, we can get its color preferences.
818 $theme_info = dba::selectFirst('user', ['theme'], ['uid' => $ret['uid']]);
819 if ($theme_info['theme'] === 'frio') {
820 $schema = PConfig::get($ret['uid'], 'frio', 'schema');
821 if ($schema && ($schema != '---')) {
822 if (file_exists('view/theme/frio/schema/'.$schema.'.php')) {
823 $schemefile = 'view/theme/frio/schema/'.$schema.'.php';
824 require_once $schemefile;
827 $nav_bg = PConfig::get($ret['uid'], 'frio', 'nav_bg');
828 $link_color = PConfig::get($ret['uid'], 'frio', 'link_color');
829 $bgcolor = PConfig::get($ret['uid'], 'frio', 'background_color');
835 $link_color = "#6fdbe8";
838 $bgcolor = "#ededed";
841 $ret['profile_sidebar_fill_color'] = str_replace('#', '', $nav_bg);
842 $ret['profile_link_color'] = str_replace('#', '', $link_color);
843 $ret['profile_background_color'] = str_replace('#', '', $bgcolor);
851 * @brief return api-formatted array for item's author and owner
853 * @param object $a App
854 * @param array $item item from db
855 * @return array(array:author, array:owner)
857 function api_item_get_user(App $a, $item)
859 $status_user = api_get_user($a, $item["author-link"]);
861 $status_user["protected"] = (($item["allow_cid"] != "") ||
862 ($item["allow_gid"] != "") ||
863 ($item["deny_cid"] != "") ||
864 ($item["deny_gid"] != "") ||
867 if ($item['thr-parent'] == $item['uri']) {
868 $owner_user = api_get_user($a, $item["owner-link"]);
870 $owner_user = $status_user;
873 return ([$status_user, $owner_user]);
877 * @brief walks recursively through an array with the possibility to change value and key
879 * @param array $array The array to walk through
880 * @param string $callback The callback function
882 * @return array the transformed array
884 function api_walk_recursive(array &$array, callable $callback)
888 foreach ($array as $k => $v) {
890 if ($callback($v, $k)) {
891 $new_array[$k] = api_walk_recursive($v, $callback);
894 if ($callback($v, $k)) {
905 * @brief Callback function to transform the array in an array that can be transformed in a XML file
907 * @param mixed $item Array item value
908 * @param string $key Array key
910 * @return boolean Should the array item be deleted?
912 function api_reformat_xml(&$item, &$key)
914 if (is_bool($item)) {
915 $item = ($item ? "true" : "false");
918 if (substr($key, 0, 10) == "statusnet_") {
919 $key = "statusnet:".substr($key, 10);
920 } elseif (substr($key, 0, 10) == "friendica_") {
921 $key = "friendica:".substr($key, 10);
923 /// @TODO old-lost code?
925 // $key = "default:".$key;
931 * @brief Creates the XML from a JSON style array
933 * @param array $data JSON style array
934 * @param string $root_element Name of the root element
936 * @return string The XML data
938 function api_create_xml($data, $root_element)
940 $childname = key($data);
941 $data2 = array_pop($data);
944 $namespaces = ["" => "http://api.twitter.com",
945 "statusnet" => "http://status.net/schema/api/1/",
946 "friendica" => "http://friendi.ca/schema/api/1/",
947 "georss" => "http://www.georss.org/georss"];
949 /// @todo Auto detection of needed namespaces
950 if (in_array($root_element, ["ok", "hash", "config", "version", "ids", "notes", "photos"])) {
954 if (is_array($data2)) {
955 api_walk_recursive($data2, "api_reformat_xml");
962 foreach ($data2 as $item) {
963 $data4[$i++.":".$childname] = $item;
969 $data3 = [$root_element => $data2];
971 $ret = XML::fromArray($data3, $xml, false, $namespaces);
976 * @brief Formats the data according to the data type
978 * @param string $root_element Name of the root element
979 * @param string $type Return type (atom, rss, xml, json)
980 * @param array $data JSON style array
982 * @return (string|array) XML data or JSON data
984 function api_format_data($root_element, $type, $data)
990 $ret = api_create_xml($data, $root_element);
1006 * Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful;
1007 * returns a 401 status code and an error message if not.
1008 * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-account-verify_credentials
1010 * @param string $type Return type (atom, rss, xml, json)
1012 function api_account_verify_credentials($type)
1017 if (api_user() === false) {
1018 throw new ForbiddenException();
1021 unset($_REQUEST["user_id"]);
1022 unset($_GET["user_id"]);
1024 unset($_REQUEST["screen_name"]);
1025 unset($_GET["screen_name"]);
1027 $skip_status = (x($_REQUEST, 'skip_status')?$_REQUEST['skip_status'] : false);
1029 $user_info = api_get_user($a);
1031 // "verified" isn't used here in the standard
1032 unset($user_info["verified"]);
1034 // - Adding last status
1035 if (!$skip_status) {
1036 $user_info["status"] = api_status_show("raw");
1037 if (!count($user_info["status"])) {
1038 unset($user_info["status"]);
1040 unset($user_info["status"]["user"]);
1044 // "uid" and "self" are only needed for some internal stuff, so remove it from here
1045 unset($user_info["uid"]);
1046 unset($user_info["self"]);
1048 return api_format_data("user", $type, ['user' => $user_info]);
1051 /// @TODO move to top of file or somewhere better
1052 api_register_func('api/account/verify_credentials', 'api_account_verify_credentials', true);
1055 * Get data from $_POST or $_GET
1059 function requestdata($k)
1061 if (x($_POST, $k)) {
1071 * Waitman Gobble Mod
1073 * @param string $type Return type (atom, rss, xml, json)
1075 * @return array|string
1077 function api_statuses_mediap($type)
1081 if (api_user() === false) {
1082 logger('api_statuses_update: no user');
1083 throw new ForbiddenException();
1085 $user_info = api_get_user($a);
1087 $_REQUEST['type'] = 'wall';
1088 $_REQUEST['profile_uid'] = api_user();
1089 $_REQUEST['api_source'] = true;
1090 $txt = requestdata('status');
1091 /// @TODO old-lost code?
1092 //$txt = urldecode(requestdata('status'));
1094 if ((strpos($txt, '<') !== false) || (strpos($txt, '>') !== false)) {
1095 $txt = html2bb_video($txt);
1096 $config = HTMLPurifier_Config::createDefault();
1097 $config->set('Cache.DefinitionImpl', null);
1098 $purifier = new HTMLPurifier($config);
1099 $txt = $purifier->purify($txt);
1101 $txt = HTML::toBBCode($txt);
1103 $a->argv[1]=$user_info['screen_name']; //should be set to username?
1105 // tell wall_upload function to return img info instead of echo
1106 $_REQUEST['hush'] = 'yeah';
1107 $bebop = wall_upload_post($a);
1109 // now that we have the img url in bbcode we can add it to the status and insert the wall item.
1110 $_REQUEST['body'] = $txt . "\n\n" . $bebop;
1113 // this should output the last post (the one we just posted).
1114 return api_status_show($type);
1117 /// @TODO move this to top of file or somewhere better!
1118 api_register_func('api/statuses/mediap', 'api_statuses_mediap', true, API_METHOD_POST);
1121 * Updates the user’s current status.
1123 * @param string $type Return type (atom, rss, xml, json)
1125 * @return array|string
1126 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-update
1128 function api_statuses_update($type)
1133 if (api_user() === false) {
1134 logger('api_statuses_update: no user');
1135 throw new ForbiddenException();
1140 // convert $_POST array items to the form we use for web posts.
1141 if (requestdata('htmlstatus')) {
1142 $txt = requestdata('htmlstatus');
1143 if ((strpos($txt, '<') !== false) || (strpos($txt, '>') !== false)) {
1144 $txt = html2bb_video($txt);
1146 $config = HTMLPurifier_Config::createDefault();
1147 $config->set('Cache.DefinitionImpl', null);
1149 $purifier = new HTMLPurifier($config);
1150 $txt = $purifier->purify($txt);
1152 $_REQUEST['body'] = HTML::toBBCode($txt);
1155 $_REQUEST['body'] = requestdata('status');
1158 $_REQUEST['title'] = requestdata('title');
1160 $parent = requestdata('in_reply_to_status_id');
1162 // Twidere sends "-1" if it is no reply ...
1163 if ($parent == -1) {
1167 if (ctype_digit($parent)) {
1168 $_REQUEST['parent'] = $parent;
1170 $_REQUEST['parent_uri'] = $parent;
1173 if (requestdata('lat') && requestdata('long')) {
1174 $_REQUEST['coord'] = sprintf("%s %s", requestdata('lat'), requestdata('long'));
1176 $_REQUEST['profile_uid'] = api_user();
1179 $_REQUEST['type'] = 'net-comment';
1181 // Check for throttling (maximum posts per day, week and month)
1182 $throttle_day = Config::get('system', 'throttle_limit_day');
1183 if ($throttle_day > 0) {
1184 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60);
1187 "SELECT COUNT(*) AS `posts_day` FROM `item` WHERE `uid`=%d AND `wall`
1188 AND `created` > '%s' AND `id` = `parent`",
1193 if (DBM::is_result($r)) {
1194 $posts_day = $r[0]["posts_day"];
1199 if ($posts_day > $throttle_day) {
1200 logger('Daily posting limit reached for user '.api_user(), LOGGER_DEBUG);
1201 // die(api_error($type, L10n::t("Daily posting limit of %d posts reached. The post was rejected.", $throttle_day));
1202 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));
1206 $throttle_week = Config::get('system', 'throttle_limit_week');
1207 if ($throttle_week > 0) {
1208 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*7);
1211 "SELECT COUNT(*) AS `posts_week` FROM `item` WHERE `uid`=%d AND `wall`
1212 AND `created` > '%s' AND `id` = `parent`",
1217 if (DBM::is_result($r)) {
1218 $posts_week = $r[0]["posts_week"];
1223 if ($posts_week > $throttle_week) {
1224 logger('Weekly posting limit reached for user '.api_user(), LOGGER_DEBUG);
1225 // die(api_error($type, L10n::t("Weekly posting limit of %d posts reached. The post was rejected.", $throttle_week)));
1226 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));
1230 $throttle_month = Config::get('system', 'throttle_limit_month');
1231 if ($throttle_month > 0) {
1232 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*30);
1235 "SELECT COUNT(*) AS `posts_month` FROM `item` WHERE `uid`=%d AND `wall`
1236 AND `created` > '%s' AND `id` = `parent`",
1241 if (DBM::is_result($r)) {
1242 $posts_month = $r[0]["posts_month"];
1247 if ($posts_month > $throttle_month) {
1248 logger('Monthly posting limit reached for user '.api_user(), LOGGER_DEBUG);
1249 // die(api_error($type, L10n::t("Monthly posting limit of %d posts reached. The post was rejected.", $throttle_month));
1250 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));
1254 $_REQUEST['type'] = 'wall';
1257 if (x($_FILES, 'media')) {
1258 // upload the image if we have one
1259 $_REQUEST['hush'] = 'yeah'; //tell wall_upload function to return img info instead of echo
1260 $media = wall_upload_post($a);
1261 if (strlen($media) > 0) {
1262 $_REQUEST['body'] .= "\n\n" . $media;
1266 // To-Do: Multiple IDs
1267 if (requestdata('media_ids')) {
1269 "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",
1270 intval(requestdata('media_ids')),
1273 if (DBM::is_result($r)) {
1274 $phototypes = Image::supportedTypes();
1275 $ext = $phototypes[$r[0]['type']];
1276 $_REQUEST['body'] .= "\n\n" . '[url=' . System::baseUrl() . '/photos/' . $r[0]['nickname'] . '/image/' . $r[0]['resource-id'] . ']';
1277 $_REQUEST['body'] .= '[img]' . System::baseUrl() . '/photo/' . $r[0]['resource-id'] . '-' . $r[0]['scale'] . '.' . $ext . '[/img][/url]';
1281 // set this so that the item_post() function is quiet and doesn't redirect or emit json
1283 $_REQUEST['api_source'] = true;
1285 if (!x($_REQUEST, "source")) {
1286 $_REQUEST["source"] = api_source();
1289 // call out normal post function
1292 // this should output the last post (the one we just posted).
1293 return api_status_show($type);
1296 /// @TODO move to top of file or somewhere better
1297 api_register_func('api/statuses/update', 'api_statuses_update', true, API_METHOD_POST);
1298 api_register_func('api/statuses/update_with_media', 'api_statuses_update', true, API_METHOD_POST);
1301 * Uploads an image to Friendica.
1304 * @see https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload
1306 function api_media_upload()
1310 if (api_user() === false) {
1312 throw new ForbiddenException();
1317 if (!x($_FILES, 'media')) {
1319 throw new BadRequestException("No media.");
1322 $media = wall_upload_post($a, false);
1325 throw new InternalServerErrorException();
1329 $returndata["media_id"] = $media["id"];
1330 $returndata["media_id_string"] = (string)$media["id"];
1331 $returndata["size"] = $media["size"];
1332 $returndata["image"] = ["w" => $media["width"],
1333 "h" => $media["height"],
1334 "image_type" => $media["type"]];
1336 logger("Media uploaded: " . print_r($returndata, true), LOGGER_DEBUG);
1338 return ["media" => $returndata];
1341 /// @TODO move to top of file or somewhere better
1342 api_register_func('api/media/upload', 'api_media_upload', true, API_METHOD_POST);
1346 * @param string $type Return type (atom, rss, xml, json)
1348 * @return array|string
1350 function api_status_show($type)
1354 $user_info = api_get_user($a);
1356 logger('api_status_show: user_info: '.print_r($user_info, true), LOGGER_DEBUG);
1358 if ($type == "raw") {
1359 $privacy_sql = "AND `item`.`allow_cid`='' AND `item`.`allow_gid`='' AND `item`.`deny_cid`='' AND `item`.`deny_gid`=''";
1364 // get last public wall message
1368 WHERE `item`.`contact-id` = %d AND `item`.`uid` = %d
1369 AND ((`item`.`author-link` IN ('%s', '%s')) OR (`item`.`owner-link` IN ('%s', '%s')))
1370 AND `item`.`type` != 'activity' $privacy_sql
1371 ORDER BY `item`.`id` DESC
1373 intval($user_info['cid']),
1375 dbesc($user_info['url']),
1376 dbesc(normalise_link($user_info['url'])),
1377 dbesc($user_info['url']),
1378 dbesc(normalise_link($user_info['url']))
1381 if (DBM::is_result($lastwall)) {
1382 $lastwall = $lastwall[0];
1384 $in_reply_to = api_in_reply_to($lastwall);
1386 $converted = api_convert_item($lastwall);
1388 if ($type == "xml") {
1389 $geo = "georss:point";
1395 'created_at' => api_date($lastwall['created']),
1396 'id' => intval($lastwall['id']),
1397 'id_str' => (string) $lastwall['id'],
1398 'text' => $converted["text"],
1399 'source' => (($lastwall['app']) ? $lastwall['app'] : 'web'),
1400 'truncated' => false,
1401 'in_reply_to_status_id' => $in_reply_to['status_id'],
1402 'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
1403 'in_reply_to_user_id' => $in_reply_to['user_id'],
1404 'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
1405 'in_reply_to_screen_name' => $in_reply_to['screen_name'],
1406 'user' => $user_info,
1408 'coordinates' => "",
1410 'contributors' => "",
1411 'is_quote_status' => false,
1412 'retweet_count' => 0,
1413 'favorite_count' => 0,
1414 'favorited' => $lastwall['starred'] ? true : false,
1415 'retweeted' => false,
1416 'possibly_sensitive' => false,
1418 'statusnet_html' => $converted["html"],
1419 'statusnet_conversation_id' => $lastwall['parent'],
1420 'external_url' => System::baseUrl() . "/display/" . $lastwall['guid'],
1423 if (count($converted["attachments"]) > 0) {
1424 $status_info["attachments"] = $converted["attachments"];
1427 if (count($converted["entities"]) > 0) {
1428 $status_info["entities"] = $converted["entities"];
1431 if (($lastwall['item_network'] != "") && ($status_info["source"] == 'web')) {
1432 $status_info["source"] = ContactSelector::networkToName($lastwall['item_network'], $user_info['url']);
1433 } elseif (($lastwall['item_network'] != "") && (ContactSelector::networkToName($lastwall['item_network'], $user_info['url']) != $status_info["source"])) {
1434 $status_info["source"] = trim($status_info["source"].' ('.ContactSelector::networkToName($lastwall['item_network'], $user_info['url']).')');
1437 // "uid" and "self" are only needed for some internal stuff, so remove it from here
1438 unset($status_info["user"]["uid"]);
1439 unset($status_info["user"]["self"]);
1441 logger('status_info: '.print_r($status_info, true), LOGGER_DEBUG);
1443 if ($type == "raw") {
1444 return $status_info;
1447 return api_format_data("statuses", $type, ['status' => $status_info]);
1452 * Returns extended information of a given user, specified by ID or screen name as per the required id parameter.
1453 * The author's most recent status will be returned inline.
1455 * @param string $type Return type (atom, rss, xml, json)
1456 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-show
1458 function api_users_show($type)
1462 $user_info = api_get_user($a);
1466 INNER JOIN `contact` ON `contact`.`id`=`item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
1467 WHERE `item`.`uid` = %d AND `verb` = '%s' AND `item`.`contact-id` = %d
1468 AND ((`item`.`author-link` IN ('%s', '%s')) OR (`item`.`owner-link` IN ('%s', '%s')))
1469 AND `type`!='activity'
1470 AND `item`.`allow_cid`='' AND `item`.`allow_gid`='' AND `item`.`deny_cid`='' AND `item`.`deny_gid`=''
1474 dbesc(ACTIVITY_POST),
1475 intval($user_info['cid']),
1476 dbesc($user_info['url']),
1477 dbesc(normalise_link($user_info['url'])),
1478 dbesc($user_info['url']),
1479 dbesc(normalise_link($user_info['url']))
1482 if (DBM::is_result($lastwall)) {
1483 $lastwall = $lastwall[0];
1485 $in_reply_to = api_in_reply_to($lastwall);
1487 $converted = api_convert_item($lastwall);
1489 if ($type == "xml") {
1490 $geo = "georss:point";
1495 $user_info['status'] = [
1496 'text' => $converted["text"],
1497 'truncated' => false,
1498 'created_at' => api_date($lastwall['created']),
1499 'in_reply_to_status_id' => $in_reply_to['status_id'],
1500 'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
1501 'source' => (($lastwall['app']) ? $lastwall['app'] : 'web'),
1502 'id' => intval($lastwall['contact-id']),
1503 'id_str' => (string) $lastwall['contact-id'],
1504 'in_reply_to_user_id' => $in_reply_to['user_id'],
1505 'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
1506 'in_reply_to_screen_name' => $in_reply_to['screen_name'],
1508 'favorited' => $lastwall['starred'] ? true : false,
1509 'statusnet_html' => $converted["html"],
1510 'statusnet_conversation_id' => $lastwall['parent'],
1511 'external_url' => System::baseUrl() . "/display/" . $lastwall['guid'],
1514 if (count($converted["attachments"]) > 0) {
1515 $user_info["status"]["attachments"] = $converted["attachments"];
1518 if (count($converted["entities"]) > 0) {
1519 $user_info["status"]["entities"] = $converted["entities"];
1522 if (($lastwall['item_network'] != "") && ($user_info["status"]["source"] == 'web')) {
1523 $user_info["status"]["source"] = ContactSelector::networkToName($lastwall['item_network'], $user_info['url']);
1526 if (($lastwall['item_network'] != "") && (ContactSelector::networkToName($lastwall['item_network'], $user_info['url']) != $user_info["status"]["source"])) {
1527 $user_info["status"]["source"] = trim($user_info["status"]["source"] . ' (' . ContactSelector::networkToName($lastwall['item_network'], $user_info['url']) . ')');
1531 // "uid" and "self" are only needed for some internal stuff, so remove it from here
1532 unset($user_info["uid"]);
1533 unset($user_info["self"]);
1535 return api_format_data("user", $type, ['user' => $user_info]);
1538 /// @TODO move to top of file or somewhere better
1539 api_register_func('api/users/show', 'api_users_show');
1540 api_register_func('api/externalprofile/show', 'api_users_show');
1543 * Search a public user account.
1545 * @param string $type Return type (atom, rss, xml, json)
1547 * @return array|string
1548 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-search
1550 function api_users_search($type)
1556 if (x($_GET, 'q')) {
1557 $r = q("SELECT id FROM `contact` WHERE `uid` = 0 AND `name` = '%s'", dbesc($_GET["q"]));
1559 if (!DBM::is_result($r)) {
1560 $r = q("SELECT `id` FROM `contact` WHERE `uid` = 0 AND `nick` = '%s'", dbesc($_GET["q"]));
1563 if (DBM::is_result($r)) {
1565 foreach ($r as $user) {
1566 $user_info = api_get_user($a, $user["id"]);
1568 if ($type == "xml") {
1569 $userlist[$k++.":user"] = $user_info;
1571 $userlist[] = $user_info;
1574 $userlist = ["users" => $userlist];
1576 throw new BadRequestException("User not found.");
1579 throw new BadRequestException("User not found.");
1582 return api_format_data("users", $type, $userlist);
1585 /// @TODO move to top of file or somewhere better
1586 api_register_func('api/users/search', 'api_users_search');
1589 * Return user objects
1591 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-lookup
1593 * @param string $type Return format: json or xml
1595 * @return array|string
1596 * @throws NotFoundException if the results are empty.
1598 function api_users_lookup($type)
1602 if (x($_REQUEST['user_id'])) {
1603 foreach (explode(',', $_REQUEST['user_id']) as $id) {
1605 $users[] = api_get_user(get_app(), $id);
1610 if (empty($users)) {
1611 throw new NotFoundException;
1614 return api_format_data("users", $type, ['users' => $users]);
1617 /// @TODO move to top of file or somewhere better
1618 api_register_func('api/users/lookup', 'api_users_lookup', true);
1621 * Returns statuses that match a specified query.
1623 * @see https://developer.twitter.com/en/docs/tweets/search/api-reference/get-search-tweets
1625 * @param string $type Return format: json, xml, atom, rss
1627 * @return array|string
1628 * @throws BadRequestException if the "q" parameter is missing.
1630 function api_search($type)
1633 $user_info = api_get_user($a);
1635 if (api_user() === false || $user_info === false) {
1636 throw new ForbiddenException();
1642 if (!x($_REQUEST, 'q')) {
1643 throw new BadRequestException("q parameter is required.");
1646 if (x($_REQUEST, 'rpp')) {
1647 $count = $_REQUEST['rpp'];
1648 } elseif (x($_REQUEST, 'count')) {
1649 $count = $_REQUEST['count'];
1654 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
1655 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
1656 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] - 1 : 0);
1658 $start = $page * $count;
1661 $sql_extra .= ' AND `item`.`id` <= ' . intval($max_id);
1665 "SELECT ".item_fieldlists()."
1666 FROM `item` ".item_joins()."
1667 WHERE ".item_condition()." AND (`item`.`uid` = 0 OR (`item`.`uid` = ? AND NOT `item`.`global`))
1668 AND `item`.`body` LIKE CONCAT('%',?,'%')
1671 ORDER BY `item`.`id` DESC LIMIT ".intval($start)." ,".intval($count)." ",
1677 $data['status'] = api_format_items(dba::inArray($r), $user_info);
1679 return api_format_data("statuses", $type, $data);
1682 /// @TODO move to top of file or somewhere better
1683 api_register_func('api/search/tweets', 'api_search', true);
1684 api_register_func('api/search', 'api_search', true);
1687 * Returns the most recent statuses posted by the user and the users they follow.
1689 * @see https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-home_timeline
1691 * @param string $type Return type (atom, rss, xml, json)
1693 * @todo Optional parameters
1694 * @todo Add reply info
1696 function api_statuses_home_timeline($type)
1699 $user_info = api_get_user($a);
1701 if (api_user() === false || $user_info === false) {
1702 throw new ForbiddenException();
1705 unset($_REQUEST["user_id"]);
1706 unset($_GET["user_id"]);
1708 unset($_REQUEST["screen_name"]);
1709 unset($_GET["screen_name"]);
1711 // get last network messages
1714 $count = (x($_REQUEST, 'count') ? $_REQUEST['count'] : 20);
1715 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] - 1 : 0);
1719 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
1720 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
1721 //$since_id = 0;//$since_id = (x($_REQUEST, 'since_id')?$_REQUEST['since_id'] : 0);
1722 $exclude_replies = (x($_REQUEST, 'exclude_replies') ? 1 : 0);
1723 $conversation_id = (x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0);
1725 $start = $page * $count;
1729 $sql_extra .= ' AND `item`.`id` <= ' . intval($max_id);
1731 if ($exclude_replies > 0) {
1732 $sql_extra .= ' AND `item`.`parent` = `item`.`id`';
1734 if ($conversation_id > 0) {
1735 $sql_extra .= ' AND `item`.`parent` = ' . intval($conversation_id);
1739 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`,
1740 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
1741 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
1742 `contact`.`id` AS `cid`
1744 STRAIGHT_JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
1745 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
1746 WHERE `item`.`uid` = %d AND `verb` = '%s'
1747 AND `item`.`visible` AND NOT `item`.`moderated` AND NOT `item`.`deleted`
1750 ORDER BY `item`.`id` DESC LIMIT %d ,%d ",
1752 dbesc(ACTIVITY_POST),
1758 $ret = api_format_items($r, $user_info, false, $type);
1760 // Set all posts from the query above to seen
1762 foreach ($r as $item) {
1763 $idarray[] = intval($item["id"]);
1766 if (!empty($idarray)) {
1767 $unseen = dba::exists('item', ['unseen' => true, 'id' => $idarray]);
1769 Item::update(['unseen' => false], ['unseen' => true, 'id' => $idarray]);
1773 $data = ['status' => $ret];
1777 $data = api_rss_extra($a, $data, $user_info);
1781 return api_format_data("statuses", $type, $data);
1784 /// @TODO move to top of file or somewhere better
1785 api_register_func('api/statuses/home_timeline', 'api_statuses_home_timeline', true);
1786 api_register_func('api/statuses/friends_timeline', 'api_statuses_home_timeline', true);
1789 * Returns the most recent statuses from public users.
1791 * @param string $type Return type (atom, rss, xml, json)
1793 * @return array|string
1795 function api_statuses_public_timeline($type)
1798 $user_info = api_get_user($a);
1800 if (api_user() === false || $user_info === false) {
1801 throw new ForbiddenException();
1804 // get last network messages
1807 $count = (x($_REQUEST, 'count') ? $_REQUEST['count'] : 20);
1808 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] -1 : 0);
1812 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
1813 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
1814 //$since_id = 0;//$since_id = (x($_REQUEST, 'since_id')?$_REQUEST['since_id'] : 0);
1815 $exclude_replies = (x($_REQUEST, 'exclude_replies') ? 1 : 0);
1816 $conversation_id = (x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0);
1818 $start = $page * $count;
1821 if ($exclude_replies && !$conversation_id) {
1823 $sql_extra = 'AND `thread`.`iid` <= ' . intval($max_id);
1827 "SELECT " . item_fieldlists() . "
1829 STRAIGHT_JOIN `item` ON `item`.`id` = `thread`.`iid`
1830 " . item_joins() . "
1831 STRAIGHT_JOIN `user` ON `user`.`uid` = `thread`.`uid`
1832 AND NOT `user`.`hidewall`
1834 AND NOT `thread`.`private`
1836 AND `thread`.`visible`
1837 AND NOT `thread`.`deleted`
1838 AND NOT `thread`.`moderated`
1839 AND `thread`.`iid` > ?
1841 ORDER BY `thread`.`iid` DESC
1842 LIMIT " . intval($start) . ", " . intval($count),
1847 $r = dba::inArray($r);
1850 $sql_extra = 'AND `item`.`id` <= ' . intval($max_id);
1852 if ($conversation_id > 0) {
1853 $sql_extra .= ' AND `item`.`parent` = ' . intval($conversation_id);
1857 "SELECT " . item_fieldlists() . "
1859 " . item_joins() . "
1860 STRAIGHT_JOIN `user` ON `user`.`uid` = `item`.`uid`
1861 AND NOT `user`.`hidewall`
1863 AND NOT `item`.`private`
1865 AND `item`.`visible`
1866 AND NOT `item`.`deleted`
1867 AND NOT `item`.`moderated`
1870 ORDER BY `item`.`id` DESC
1871 LIMIT " . intval($start) . ", " . intval($count),
1876 $r = dba::inArray($r);
1879 $ret = api_format_items($r, $user_info, false, $type);
1881 $data = ['status' => $ret];
1885 $data = api_rss_extra($a, $data, $user_info);
1889 return api_format_data("statuses", $type, $data);
1892 /// @TODO move to top of file or somewhere better
1893 api_register_func('api/statuses/public_timeline', 'api_statuses_public_timeline', true);
1896 * Returns the most recent statuses posted by users this node knows about.
1898 * @brief Returns the list of public federated posts this node knows about
1900 * @param string $type Return format: json, xml, atom, rss
1901 * @return array|string
1902 * @throws ForbiddenException
1904 function api_statuses_networkpublic_timeline($type)
1907 $user_info = api_get_user($a);
1909 if (api_user() === false || $user_info === false) {
1910 throw new ForbiddenException();
1913 $since_id = x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0;
1914 $max_id = x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0;
1917 $count = x($_REQUEST, 'count') ? $_REQUEST['count'] : 20;
1918 $page = x($_REQUEST, 'page') ? $_REQUEST['page'] : 1;
1922 $start = ($page - 1) * $count;
1926 $sql_extra = 'AND `thread`.`iid` <= ' . intval($max_id);
1930 "SELECT " . item_fieldlists() . "
1932 STRAIGHT_JOIN `item` ON `item`.`id` = `thread`.`iid`
1933 " . item_joins() . "
1934 WHERE `thread`.`uid` = 0
1936 AND NOT `thread`.`private`
1937 AND `thread`.`visible`
1938 AND NOT `thread`.`deleted`
1939 AND NOT `thread`.`moderated`
1940 AND `thread`.`iid` > ?
1942 ORDER BY `thread`.`iid` DESC
1943 LIMIT " . intval($start) . ", " . intval($count),
1948 $r = dba::inArray($r);
1950 $ret = api_format_items($r, $user_info, false, $type);
1952 $data = ['status' => $ret];
1956 $data = api_rss_extra($a, $data, $user_info);
1960 return api_format_data("statuses", $type, $data);
1963 /// @TODO move to top of file or somewhere better
1964 api_register_func('api/statuses/networkpublic_timeline', 'api_statuses_networkpublic_timeline', true);
1967 * Returns a single status.
1969 * @param string $type Return type (atom, rss, xml, json)
1971 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-statuses-show-id
1973 function api_statuses_show($type)
1976 $user_info = api_get_user($a);
1978 if (api_user() === false || $user_info === false) {
1979 throw new ForbiddenException();
1983 $id = intval($a->argv[3]);
1986 $id = intval($_REQUEST["id"]);
1991 $id = intval($a->argv[4]);
1994 logger('API: api_statuses_show: ' . $id);
1996 $conversation = (x($_REQUEST, 'conversation') ? 1 : 0);
1999 if ($conversation) {
2000 $sql_extra .= " AND `item`.`parent` = %d ORDER BY `id` ASC ";
2002 $sql_extra .= " AND `item`.`id` = %d";
2005 // try to fetch the item for the local user - or the public item, if there is no local one
2006 $uri_item = dba::selectFirst('item', ['uri'], ['id' => $id]);
2007 if (!DBM::is_result($uri_item)) {
2008 throw new BadRequestException("There is no status with this id.");
2011 $item = dba::selectFirst('item', ['id'], ['uri' => $uri_item['uri'], 'uid' => [0, api_user()]], ['order' => ['uid' => true]]);
2012 if (!DBM::is_result($item)) {
2013 throw new BadRequestException("There is no status with this id.");
2019 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`,
2020 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
2021 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
2022 `contact`.`id` AS `cid`
2024 INNER JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
2025 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
2026 WHERE `item`.`visible` AND NOT `item`.`moderated` AND NOT `item`.`deleted`
2027 AND `item`.`uid` IN (0, %d) AND `item`.`verb` = '%s'
2030 dbesc(ACTIVITY_POST),
2034 /// @TODO How about copying this to above methods which don't check $r ?
2035 if (!DBM::is_result($r)) {
2036 throw new BadRequestException("There is no status with this id.");
2039 $ret = api_format_items($r, $user_info, false, $type);
2041 if ($conversation) {
2042 $data = ['status' => $ret];
2043 return api_format_data("statuses", $type, $data);
2045 $data = ['status' => $ret[0]];
2046 return api_format_data("status", $type, $data);
2050 /// @TODO move to top of file or somewhere better
2051 api_register_func('api/statuses/show', 'api_statuses_show', true);
2055 * @param string $type Return type (atom, rss, xml, json)
2057 * @todo nothing to say?
2059 function api_conversation_show($type)
2062 $user_info = api_get_user($a);
2064 if (api_user() === false || $user_info === false) {
2065 throw new ForbiddenException();
2069 $id = intval($a->argv[3]);
2070 $count = (x($_REQUEST, 'count') ? $_REQUEST['count'] : 20);
2071 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] - 1 : 0);
2075 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
2076 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
2078 $start = $page*$count;
2081 $id = intval($_REQUEST["id"]);
2086 $id = intval($a->argv[4]);
2089 logger('API: api_conversation_show: '.$id);
2091 // try to fetch the item for the local user - or the public item, if there is no local one
2092 $item = dba::selectFirst('item', ['parent-uri'], ['id' => $id]);
2093 if (!DBM::is_result($item)) {
2094 throw new BadRequestException("There is no status with this id.");
2097 $parent = dba::selectFirst('item', ['id'], ['uri' => $item['parent-uri'], 'uid' => [0, api_user()]], ['order' => ['uid' => true]]);
2098 if (!DBM::is_result($parent)) {
2099 throw new BadRequestException("There is no status with this id.");
2102 $id = $parent['id'];
2107 $sql_extra = ' AND `item`.`id` <= ' . intval($max_id);
2111 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`,
2112 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
2113 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
2114 `contact`.`id` AS `cid`
2116 STRAIGHT_JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
2117 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
2118 WHERE `item`.`parent` = %d AND `item`.`visible`
2119 AND NOT `item`.`moderated` AND NOT `item`.`deleted`
2120 AND `item`.`uid` IN (0, %d) AND `item`.`verb` = '%s'
2121 AND `item`.`id`>%d $sql_extra
2122 ORDER BY `item`.`id` DESC LIMIT %d ,%d",
2125 dbesc(ACTIVITY_POST),
2131 if (!DBM::is_result($r)) {
2132 throw new BadRequestException("There is no status with this id.");
2135 $ret = api_format_items($r, $user_info, false, $type);
2137 $data = ['status' => $ret];
2138 return api_format_data("statuses", $type, $data);
2141 /// @TODO move to top of file or somewhere better
2142 api_register_func('api/conversation/show', 'api_conversation_show', true);
2143 api_register_func('api/statusnet/conversation', 'api_conversation_show', true);
2148 * @param string $type Return type (atom, rss, xml, json)
2150 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-retweet-id
2152 function api_statuses_repeat($type)
2158 if (api_user() === false) {
2159 throw new ForbiddenException();
2165 $id = intval($a->argv[3]);
2168 $id = intval($_REQUEST["id"]);
2173 $id = intval($a->argv[4]);
2176 logger('API: api_statuses_repeat: '.$id);
2179 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`, `contact`.`nick` as `reply_author`,
2180 `contact`.`name`, `contact`.`photo` as `reply_photo`, `contact`.`url` as `reply_url`, `contact`.`rel`,
2181 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
2182 `contact`.`id` AS `cid`
2184 INNER JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
2185 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
2186 WHERE `item`.`visible` AND NOT `item`.`moderated` AND NOT `item`.`deleted`
2187 AND NOT `item`.`private` AND `item`.`allow_cid` = '' AND `item`.`allow_gid` = ''
2188 AND `item`.`deny_cid` = '' AND `item`.`deny_gid` = ''
2189 AND `item`.`id`=%d",
2193 /// @TODO other style than above functions!
2194 if (DBM::is_result($r) && $r[0]['body'] != "") {
2195 if (strpos($r[0]['body'], "[/share]") !== false) {
2196 $pos = strpos($r[0]['body'], "[share");
2197 $post = substr($r[0]['body'], $pos);
2199 $post = share_header($r[0]['author-name'], $r[0]['author-link'], $r[0]['author-avatar'], $r[0]['guid'], $r[0]['created'], $r[0]['plink']);
2201 $post .= $r[0]['body'];
2202 $post .= "[/share]";
2204 $_REQUEST['body'] = $post;
2205 $_REQUEST['profile_uid'] = api_user();
2206 $_REQUEST['type'] = 'wall';
2207 $_REQUEST['api_source'] = true;
2209 if (!x($_REQUEST, "source")) {
2210 $_REQUEST["source"] = api_source();
2215 throw new ForbiddenException();
2218 // this should output the last post (the one we just posted).
2220 return api_status_show($type);
2223 /// @TODO move to top of file or somewhere better
2224 api_register_func('api/statuses/retweet', 'api_statuses_repeat', true, API_METHOD_POST);
2227 * Destroys a specific status.
2229 * @param string $type Return type (atom, rss, xml, json)
2231 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-destroy-id
2233 function api_statuses_destroy($type)
2237 if (api_user() === false) {
2238 throw new ForbiddenException();
2244 $id = intval($a->argv[3]);
2247 $id = intval($_REQUEST["id"]);
2252 $id = intval($a->argv[4]);
2255 logger('API: api_statuses_destroy: '.$id);
2257 $ret = api_statuses_show($type);
2259 Item::deleteById($id);
2264 /// @TODO move to top of file or somewhere better
2265 api_register_func('api/statuses/destroy', 'api_statuses_destroy', true, API_METHOD_DELETE);
2268 * Returns the most recent mentions.
2270 * @param string $type Return type (atom, rss, xml, json)
2272 * @see http://developer.twitter.com/doc/get/statuses/mentions
2274 function api_statuses_mentions($type)
2277 $user_info = api_get_user($a);
2279 if (api_user() === false || $user_info === false) {
2280 throw new ForbiddenException();
2283 unset($_REQUEST["user_id"]);
2284 unset($_GET["user_id"]);
2286 unset($_REQUEST["screen_name"]);
2287 unset($_GET["screen_name"]);
2289 // get last network messages
2292 $since_id = defaults($_REQUEST, 'since_id', 0);
2293 $max_id = defaults($_REQUEST, 'max_id' , 0);
2294 $count = defaults($_REQUEST, 'count' , 20);
2295 $page = defaults($_REQUEST, 'page' , 1);
2300 $start = ($page - 1) * $count;
2302 // Ugly code - should be changed
2303 $myurl = System::baseUrl() . '/profile/'. $a->user['nickname'];
2304 $myurl = substr($myurl, strpos($myurl, '://') + 3);
2305 $myurl = str_replace('www.', '', $myurl);
2310 $sql_extra .= ' AND `item`.`id` <= ' . intval($max_id);
2314 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`,
2315 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
2316 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
2317 `contact`.`id` AS `cid`
2318 FROM `item` FORCE INDEX (`uid_id`)
2319 STRAIGHT_JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
2320 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
2321 WHERE `item`.`uid` = %d AND `verb` = '%s'
2322 AND NOT (`item`.`author-link` IN ('https://%s', 'http://%s'))
2323 AND `item`.`visible` AND NOT `item`.`moderated` AND NOT `item`.`deleted`
2324 AND `item`.`parent` IN (SELECT `iid` FROM `thread` WHERE `uid` = %d AND `mention` AND !`ignored`)
2327 ORDER BY `item`.`id` DESC LIMIT %d ,%d ",
2329 dbesc(ACTIVITY_POST),
2330 dbesc(protect_sprintf($myurl)),
2331 dbesc(protect_sprintf($myurl)),
2338 $ret = api_format_items($r, $user_info, false, $type);
2340 $data = ['status' => $ret];
2344 $data = api_rss_extra($a, $data, $user_info);
2348 return api_format_data("statuses", $type, $data);
2351 /// @TODO move to top of file or somewhere better
2352 api_register_func('api/statuses/mentions', 'api_statuses_mentions', true);
2353 api_register_func('api/statuses/replies', 'api_statuses_mentions', true);
2356 * Returns the most recent statuses posted by the user.
2358 * @brief Returns a user's public timeline
2360 * @param string $type Either "json" or "xml"
2361 * @return string|array
2362 * @throws ForbiddenException
2363 * @see https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-user_timeline
2365 function api_statuses_user_timeline($type)
2368 $user_info = api_get_user($a);
2370 if (api_user() === false || $user_info === false) {
2371 throw new ForbiddenException();
2375 "api_statuses_user_timeline: api_user: ". api_user() .
2376 "\nuser_info: ".print_r($user_info, true) .
2377 "\n_REQUEST: ".print_r($_REQUEST, true),
2381 $since_id = x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0;
2382 $max_id = x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0;
2383 $exclude_replies = x($_REQUEST, 'exclude_replies') ? 1 : 0;
2384 $conversation_id = x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0;
2387 $count = x($_REQUEST, 'count') ? $_REQUEST['count'] : 20;
2388 $page = x($_REQUEST, 'page') ? $_REQUEST['page'] : 1;
2392 $start = ($page - 1) * $count;
2395 if ($user_info['self'] == 1) {
2396 $sql_extra .= " AND `item`.`wall` = 1 ";
2399 if ($exclude_replies > 0) {
2400 $sql_extra .= ' AND `item`.`parent` = `item`.`id`';
2403 if ($conversation_id > 0) {
2404 $sql_extra .= ' AND `item`.`parent` = ' . intval($conversation_id);
2408 $sql_extra .= ' AND `item`.`id` <= ' . intval($max_id);
2412 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`,
2413 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
2414 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
2415 `contact`.`id` AS `cid`
2416 FROM `item` FORCE INDEX (`uid_contactid_id`)
2417 STRAIGHT_JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
2418 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
2419 WHERE `item`.`uid` = %d AND `verb` = '%s'
2420 AND `item`.`contact-id` = %d
2421 AND `item`.`visible` AND NOT `item`.`moderated` AND NOT `item`.`deleted`
2423 AND `item`.`id` > %d
2424 ORDER BY `item`.`id` DESC LIMIT %d ,%d ",
2426 dbesc(ACTIVITY_POST),
2427 intval($user_info['cid']),
2433 $ret = api_format_items($r, $user_info, true, $type);
2435 $data = ['status' => $ret];
2439 $data = api_rss_extra($a, $data, $user_info);
2443 return api_format_data("statuses", $type, $data);
2446 /// @TODO move to top of file or somewhere better
2447 api_register_func('api/statuses/user_timeline', 'api_statuses_user_timeline', true);
2450 * Star/unstar an item.
2451 * param: id : id of the item
2453 * @param string $type Return type (atom, rss, xml, json)
2455 * @see https://web.archive.org/web/20131019055350/https://dev.twitter.com/docs/api/1/post/favorites/create/%3Aid
2457 function api_favorites_create_destroy($type)
2461 if (api_user() === false) {
2462 throw new ForbiddenException();
2465 // for versioned api.
2466 /// @TODO We need a better global soluton
2467 $action_argv_id = 2;
2468 if ($a->argv[1] == "1.1") {
2469 $action_argv_id = 3;
2472 if ($a->argc <= $action_argv_id) {
2473 throw new BadRequestException("Invalid request.");
2475 $action = str_replace("." . $type, "", $a->argv[$action_argv_id]);
2476 if ($a->argc == $action_argv_id + 2) {
2477 $itemid = intval($a->argv[$action_argv_id + 1]);
2479 /// @TODO use x() to check if _REQUEST contains 'id'
2480 $itemid = intval($_REQUEST['id']);
2483 $item = q("SELECT * FROM `item` WHERE `id`=%d AND `uid`=%d LIMIT 1", $itemid, api_user());
2485 if (!DBM::is_result($item) || count($item) == 0) {
2486 throw new BadRequestException("Invalid item.");
2491 $item[0]['starred'] = 1;
2494 $item[0]['starred'] = 0;
2497 throw new BadRequestException("Invalid action ".$action);
2500 $r = Item::update(['starred' => $item[0]['starred']], ['id' => $itemid]);
2503 throw new InternalServerErrorException("DB error");
2507 $user_info = api_get_user($a);
2508 $rets = api_format_items($item, $user_info, false, $type);
2511 $data = ['status' => $ret];
2515 $data = api_rss_extra($a, $data, $user_info);
2518 return api_format_data("status", $type, $data);
2521 /// @TODO move to top of file or somewhere better
2522 api_register_func('api/favorites/create', 'api_favorites_create_destroy', true, API_METHOD_POST);
2523 api_register_func('api/favorites/destroy', 'api_favorites_create_destroy', true, API_METHOD_DELETE);
2526 * Returns the most recent favorite statuses.
2528 * @param string $type Return type (atom, rss, xml, json)
2530 * @return string|array
2532 function api_favorites($type)
2537 $user_info = api_get_user($a);
2539 if (api_user() === false || $user_info === false) {
2540 throw new ForbiddenException();
2545 // in friendica starred item are private
2546 // return favorites only for self
2547 logger('api_favorites: self:' . $user_info['self']);
2549 if ($user_info['self'] == 0) {
2555 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
2556 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
2557 $count = (x($_GET, 'count') ? $_GET['count'] : 20);
2558 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] -1 : 0);
2563 $start = $page*$count;
2566 $sql_extra .= ' AND `item`.`id` <= ' . intval($max_id);
2570 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`,
2571 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
2572 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
2573 `contact`.`id` AS `cid`
2574 FROM `item`, `contact`
2575 WHERE `item`.`uid` = %d
2576 AND `item`.`visible` = 1 AND `item`.`moderated` = 0 AND `item`.`deleted` = 0
2577 AND `item`.`starred` = 1
2578 AND `contact`.`id` = `item`.`contact-id`
2579 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
2582 ORDER BY `item`.`id` DESC LIMIT %d ,%d ",
2589 $ret = api_format_items($r, $user_info, false, $type);
2592 $data = ['status' => $ret];
2596 $data = api_rss_extra($a, $data, $user_info);
2599 return api_format_data("statuses", $type, $data);
2602 /// @TODO move to top of file or somewhere better
2603 api_register_func('api/favorites', 'api_favorites', true);
2607 * @param array $item
2608 * @param array $recipient
2609 * @param array $sender
2613 function api_format_messages($item, $recipient, $sender)
2615 // standard meta information
2617 'id' => $item['id'],
2618 'sender_id' => $sender['id'] ,
2620 'recipient_id' => $recipient['id'],
2621 'created_at' => api_date($item['created']),
2622 'sender_screen_name' => $sender['screen_name'],
2623 'recipient_screen_name' => $recipient['screen_name'],
2624 'sender' => $sender,
2625 'recipient' => $recipient,
2627 'friendica_seen' => $item['seen'],
2628 'friendica_parent_uri' => $item['parent-uri'],
2631 // "uid" and "self" are only needed for some internal stuff, so remove it from here
2632 unset($ret["sender"]["uid"]);
2633 unset($ret["sender"]["self"]);
2634 unset($ret["recipient"]["uid"]);
2635 unset($ret["recipient"]["self"]);
2637 //don't send title to regular StatusNET requests to avoid confusing these apps
2638 if (x($_GET, 'getText')) {
2639 $ret['title'] = $item['title'];
2640 if ($_GET['getText'] == 'html') {
2641 $ret['text'] = BBCode::convert($item['body'], false);
2642 } elseif ($_GET['getText'] == 'plain') {
2643 $ret['text'] = trim(HTML::toPlaintext(BBCode::convert(api_clean_plain_items($item['body']), false, 2, true), 0));
2646 $ret['text'] = $item['title'] . "\n" . HTML::toPlaintext(BBCode::convert(api_clean_plain_items($item['body']), false, 2, true), 0);
2648 if (x($_GET, 'getUserObjects') && $_GET['getUserObjects'] == 'false') {
2649 unset($ret['sender']);
2650 unset($ret['recipient']);
2658 * @param array $item
2662 function api_convert_item($item)
2664 $body = $item['body'];
2665 $attachments = api_get_attachments($body);
2667 // Workaround for ostatus messages where the title is identically to the body
2668 $html = BBCode::convert(api_clean_plain_items($body), false, 2, true);
2669 $statusbody = trim(HTML::toPlaintext($html, 0));
2671 // handle data: images
2672 $statusbody = api_format_items_embeded_images($item, $statusbody);
2674 $statustitle = trim($item['title']);
2676 if (($statustitle != '') && (strpos($statusbody, $statustitle) !== false)) {
2677 $statustext = trim($statusbody);
2679 $statustext = trim($statustitle."\n\n".$statusbody);
2682 if (($item["network"] == NETWORK_FEED) && (strlen($statustext)> 1000)) {
2683 $statustext = substr($statustext, 0, 1000)."... \n".$item["plink"];
2686 $statushtml = BBCode::convert(api_clean_attachments($body), false);
2688 // Workaround for clients with limited HTML parser functionality
2689 $search = ["<br>", "<blockquote>", "</blockquote>",
2690 "<h1>", "</h1>", "<h2>", "</h2>",
2691 "<h3>", "</h3>", "<h4>", "</h4>",
2692 "<h5>", "</h5>", "<h6>", "</h6>"];
2693 $replace = ["<br>", "<br><blockquote>", "</blockquote><br>",
2694 "<br><h1>", "</h1><br>", "<br><h2>", "</h2><br>",
2695 "<br><h3>", "</h3><br>", "<br><h4>", "</h4><br>",
2696 "<br><h5>", "</h5><br>", "<br><h6>", "</h6><br>"];
2697 $statushtml = str_replace($search, $replace, $statushtml);
2699 if ($item['title'] != "") {
2700 $statushtml = "<br><h4>" . BBCode::convert($item['title']) . "</h4><br>" . $statushtml;
2704 $oldtext = $statushtml;
2705 $statushtml = str_replace("<br><br>", "<br>", $statushtml);
2706 } while ($oldtext != $statushtml);
2708 if (substr($statushtml, 0, 4) == '<br>') {
2709 $statushtml = substr($statushtml, 4);
2712 if (substr($statushtml, 0, -4) == '<br>') {
2713 $statushtml = substr($statushtml, -4);
2716 // feeds without body should contain the link
2717 if (($item['network'] == NETWORK_FEED) && (strlen($item['body']) == 0)) {
2718 $statushtml .= BBCode::convert($item['plink']);
2721 $entities = api_get_entitities($statustext, $body);
2724 "text" => $statustext,
2725 "html" => $statushtml,
2726 "attachments" => $attachments,
2727 "entities" => $entities
2733 * @param string $body
2735 * @return array|false
2737 function api_get_attachments(&$body)
2740 $text = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $text);
2742 $URLSearchString = "^\[\]";
2743 $ret = preg_match_all("/\[img\]([$URLSearchString]*)\[\/img\]/ism", $text, $images);
2751 foreach ($images[1] as $image) {
2752 $imagedata = Image::getInfoFromURL($image);
2755 $attachments[] = ["url" => $image, "mimetype" => $imagedata["mime"], "size" => $imagedata["size"]];
2759 if (strstr($_SERVER['HTTP_USER_AGENT'], "AndStatus")) {
2760 foreach ($images[0] as $orig) {
2761 $body = str_replace($orig, "", $body);
2765 return $attachments;
2770 * @param string $text
2771 * @param string $bbcode
2774 * @todo Links at the first character of the post
2776 function api_get_entitities(&$text, $bbcode)
2778 $include_entities = strtolower(x($_REQUEST, 'include_entities') ? $_REQUEST['include_entities'] : "false");
2780 if ($include_entities != "true") {
2781 preg_match_all("/\[img](.*?)\[\/img\]/ism", $bbcode, $images);
2783 foreach ($images[1] as $image) {
2784 $replace = proxy_url($image);
2785 $text = str_replace($image, $replace, $text);
2790 $bbcode = BBCode::cleanPictureLinks($bbcode);
2792 // Change pure links in text to bbcode uris
2793 $bbcode = preg_replace("/([^\]\='".'"'."]|^)(https?\:\/\/[a-zA-Z0-9\:\/\-\?\&\;\.\=\_\~\#\%\$\!\+\,]+)/ism", '$1[url=$2]$2[/url]', $bbcode);
2796 $entities["hashtags"] = [];
2797 $entities["symbols"] = [];
2798 $entities["urls"] = [];
2799 $entities["user_mentions"] = [];
2801 $URLSearchString = "^\[\]";
2803 $bbcode = preg_replace("/#\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '#$2', $bbcode);
2805 $bbcode = preg_replace("/\[bookmark\=([$URLSearchString]*)\](.*?)\[\/bookmark\]/ism", '[url=$1]$2[/url]', $bbcode);
2806 //$bbcode = preg_replace("/\[url\](.*?)\[\/url\]/ism",'[url=$1]$1[/url]',$bbcode);
2807 $bbcode = preg_replace("/\[video\](.*?)\[\/video\]/ism", '[url=$1]$1[/url]', $bbcode);
2809 $bbcode = preg_replace(
2810 "/\[youtube\]([A-Za-z0-9\-_=]+)(.*?)\[\/youtube\]/ism",
2811 '[url=https://www.youtube.com/watch?v=$1]https://www.youtube.com/watch?v=$1[/url]',
2814 $bbcode = preg_replace("/\[youtube\](.*?)\[\/youtube\]/ism", '[url=$1]$1[/url]', $bbcode);
2816 $bbcode = preg_replace(
2817 "/\[vimeo\]([0-9]+)(.*?)\[\/vimeo\]/ism",
2818 '[url=https://vimeo.com/$1]https://vimeo.com/$1[/url]',
2821 $bbcode = preg_replace("/\[vimeo\](.*?)\[\/vimeo\]/ism", '[url=$1]$1[/url]', $bbcode);
2823 $bbcode = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $bbcode);
2825 //preg_match_all("/\[url\]([$URLSearchString]*)\[\/url\]/ism", $bbcode, $urls1);
2826 preg_match_all("/\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", $bbcode, $urls);
2829 foreach ($urls[1] as $id => $url) {
2830 //$start = strpos($text, $url, $offset);
2831 $start = iconv_strpos($text, $url, 0, "UTF-8");
2832 if (!($start === false)) {
2833 $ordered_urls[$start] = ["url" => $url, "title" => $urls[2][$id]];
2837 ksort($ordered_urls);
2840 //foreach ($urls[1] AS $id=>$url) {
2841 foreach ($ordered_urls as $url) {
2842 if ((substr($url["title"], 0, 7) != "http://") && (substr($url["title"], 0, 8) != "https://")
2843 && !strpos($url["title"], "http://") && !strpos($url["title"], "https://")
2845 $display_url = $url["title"];
2847 $display_url = str_replace(["http://www.", "https://www."], ["", ""], $url["url"]);
2848 $display_url = str_replace(["http://", "https://"], ["", ""], $display_url);
2850 if (strlen($display_url) > 26) {
2851 $display_url = substr($display_url, 0, 25)."…";
2855 //$start = strpos($text, $url, $offset);
2856 $start = iconv_strpos($text, $url["url"], $offset, "UTF-8");
2857 if (!($start === false)) {
2858 $entities["urls"][] = ["url" => $url["url"],
2859 "expanded_url" => $url["url"],
2860 "display_url" => $display_url,
2861 "indices" => [$start, $start+strlen($url["url"])]];
2862 $offset = $start + 1;
2866 preg_match_all("/\[img](.*?)\[\/img\]/ism", $bbcode, $images);
2867 $ordered_images = [];
2868 foreach ($images[1] as $image) {
2869 //$start = strpos($text, $url, $offset);
2870 $start = iconv_strpos($text, $image, 0, "UTF-8");
2871 if (!($start === false)) {
2872 $ordered_images[$start] = $image;
2875 //$entities["media"] = array();
2878 foreach ($ordered_images as $url) {
2879 $display_url = str_replace(["http://www.", "https://www."], ["", ""], $url);
2880 $display_url = str_replace(["http://", "https://"], ["", ""], $display_url);
2882 if (strlen($display_url) > 26) {
2883 $display_url = substr($display_url, 0, 25)."…";
2886 $start = iconv_strpos($text, $url, $offset, "UTF-8");
2887 if (!($start === false)) {
2888 $image = Image::getInfoFromURL($url);
2890 // If image cache is activated, then use the following sizes:
2891 // thumb (150), small (340), medium (600) and large (1024)
2892 if (!Config::get("system", "proxy_disabled")) {
2893 $media_url = proxy_url($url);
2896 $scale = Image::getScalingDimensions($image[0], $image[1], 150);
2897 $sizes["thumb"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2899 if (($image[0] > 150) || ($image[1] > 150)) {
2900 $scale = Image::getScalingDimensions($image[0], $image[1], 340);
2901 $sizes["small"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2904 $scale = Image::getScalingDimensions($image[0], $image[1], 600);
2905 $sizes["medium"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2907 if (($image[0] > 600) || ($image[1] > 600)) {
2908 $scale = Image::getScalingDimensions($image[0], $image[1], 1024);
2909 $sizes["large"] = ["w" => $scale["width"], "h" => $scale["height"], "resize" => "fit"];
2913 $sizes["medium"] = ["w" => $image[0], "h" => $image[1], "resize" => "fit"];
2916 $entities["media"][] = [
2918 "id_str" => (string)$start+1,
2919 "indices" => [$start, $start+strlen($url)],
2920 "media_url" => normalise_link($media_url),
2921 "media_url_https" => $media_url,
2923 "display_url" => $display_url,
2924 "expanded_url" => $url,
2928 $offset = $start + 1;
2937 * @param array $item
2938 * @param string $text
2942 function api_format_items_embeded_images($item, $text)
2944 $text = preg_replace_callback(
2945 '|data:image/([^;]+)[^=]+=*|m',
2946 function () use ($item) {
2947 return System::baseUrl() . '/display/' . $item['guid'];
2955 * @brief return <a href='url'>name</a> as array
2957 * @param string $txt text
2962 function api_contactlink_to_array($txt)
2965 $r = preg_match_all('|<a href="([^"]*)">([^<]*)</a>|', $txt, $match);
2966 if ($r && count($match)==3) {
2968 'name' => $match[2],
2982 * @brief return likes, dislikes and attend status for item
2984 * @param array $item array
2985 * @param string $type Return type (atom, rss, xml, json)
2988 * likes => int count,
2989 * dislikes => int count
2991 function api_format_items_activities(&$item, $type = "json")
3000 'attendmaybe' => [],
3005 WHERE uid=%d AND `thr-parent`="%s" AND visible AND NOT deleted',
3006 intval($item['uid']),
3010 foreach ($items as $i) {
3011 // not used as result should be structured like other user data
3012 //builtin_activity_puller($i, $activities);
3014 // get user data and add it to the array of the activity
3015 $user = api_get_user($a, $i['author-link']);
3016 switch ($i['verb']) {
3018 $activities['like'][] = $user;
3020 case ACTIVITY_DISLIKE:
3021 $activities['dislike'][] = $user;
3023 case ACTIVITY_ATTEND:
3024 $activities['attendyes'][] = $user;
3026 case ACTIVITY_ATTENDNO:
3027 $activities['attendno'][] = $user;
3029 case ACTIVITY_ATTENDMAYBE:
3030 $activities['attendmaybe'][] = $user;
3037 if ($type == "xml") {
3038 $xml_activities = [];
3039 foreach ($activities as $k => $v) {
3040 // change xml element from "like" to "friendica:like"
3041 $xml_activities["friendica:".$k] = $v;
3042 // add user data into xml output
3044 foreach ($v as $user) {
3045 $xml_activities["friendica:".$k][$k_user++.":user"] = $user;
3048 $activities = $xml_activities;
3056 * @brief return data from profiles
3058 * @param array $profile_row array containing data from db table 'profile'
3061 function api_format_items_profiles($profile_row)
3064 'profile_id' => $profile_row['id'],
3065 'profile_name' => $profile_row['profile-name'],
3066 'is_default' => $profile_row['is-default'] ? true : false,
3067 'hide_friends' => $profile_row['hide-friends'] ? true : false,
3068 'profile_photo' => $profile_row['photo'],
3069 'profile_thumb' => $profile_row['thumb'],
3070 'publish' => $profile_row['publish'] ? true : false,
3071 'net_publish' => $profile_row['net-publish'] ? true : false,
3072 'description' => $profile_row['pdesc'],
3073 'date_of_birth' => $profile_row['dob'],
3074 'address' => $profile_row['address'],
3075 'city' => $profile_row['locality'],
3076 'region' => $profile_row['region'],
3077 'postal_code' => $profile_row['postal-code'],
3078 'country' => $profile_row['country-name'],
3079 'hometown' => $profile_row['hometown'],
3080 'gender' => $profile_row['gender'],
3081 'marital' => $profile_row['marital'],
3082 'marital_with' => $profile_row['with'],
3083 'marital_since' => $profile_row['howlong'],
3084 'sexual' => $profile_row['sexual'],
3085 'politic' => $profile_row['politic'],
3086 'religion' => $profile_row['religion'],
3087 'public_keywords' => $profile_row['pub_keywords'],
3088 'private_keywords' => $profile_row['prv_keywords'],
3089 'likes' => BBCode::convert(api_clean_plain_items($profile_row['likes']) , false, 2),
3090 'dislikes' => BBCode::convert(api_clean_plain_items($profile_row['dislikes']) , false, 2),
3091 'about' => BBCode::convert(api_clean_plain_items($profile_row['about']) , false, 2),
3092 'music' => BBCode::convert(api_clean_plain_items($profile_row['music']) , false, 2),
3093 'book' => BBCode::convert(api_clean_plain_items($profile_row['book']) , false, 2),
3094 'tv' => BBCode::convert(api_clean_plain_items($profile_row['tv']) , false, 2),
3095 'film' => BBCode::convert(api_clean_plain_items($profile_row['film']) , false, 2),
3096 'interest' => BBCode::convert(api_clean_plain_items($profile_row['interest']) , false, 2),
3097 'romance' => BBCode::convert(api_clean_plain_items($profile_row['romance']) , false, 2),
3098 'work' => BBCode::convert(api_clean_plain_items($profile_row['work']) , false, 2),
3099 'education' => BBCode::convert(api_clean_plain_items($profile_row['education']), false, 2),
3100 'social_networks' => BBCode::convert(api_clean_plain_items($profile_row['contact']) , false, 2),
3101 'homepage' => $profile_row['homepage'],
3108 * @brief format items to be returned by api
3110 * @param array $r array of items
3111 * @param array $user_info
3112 * @param bool $filter_user filter items by $user_info
3113 * @param string $type Return type (atom, rss, xml, json)
3115 function api_format_items($r, $user_info, $filter_user = false, $type = "json")
3121 foreach ($r as $item) {
3122 localize_item($item);
3123 list($status_user, $owner_user) = api_item_get_user($a, $item);
3125 // Look if the posts are matching if they should be filtered by user id
3126 if ($filter_user && ($status_user["id"] != $user_info["id"])) {
3130 $in_reply_to = api_in_reply_to($item);
3132 $converted = api_convert_item($item);
3134 if ($type == "xml") {
3135 $geo = "georss:point";
3141 'text' => $converted["text"],
3142 'truncated' => false,
3143 'created_at'=> api_date($item['created']),
3144 'in_reply_to_status_id' => $in_reply_to['status_id'],
3145 'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
3146 'source' => (($item['app']) ? $item['app'] : 'web'),
3147 'id' => intval($item['id']),
3148 'id_str' => (string) intval($item['id']),
3149 'in_reply_to_user_id' => $in_reply_to['user_id'],
3150 'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
3151 'in_reply_to_screen_name' => $in_reply_to['screen_name'],
3153 'favorited' => $item['starred'] ? true : false,
3154 'user' => $status_user ,
3155 'friendica_owner' => $owner_user,
3156 //'entities' => NULL,
3157 'statusnet_html' => $converted["html"],
3158 'statusnet_conversation_id' => $item['parent'],
3159 'external_url' => System::baseUrl() . "/display/" . $item['guid'],
3160 'friendica_activities' => api_format_items_activities($item, $type),
3163 if (count($converted["attachments"]) > 0) {
3164 $status["attachments"] = $converted["attachments"];
3167 if (count($converted["entities"]) > 0) {
3168 $status["entities"] = $converted["entities"];
3171 if (($item['item_network'] != "") && ($status["source"] == 'web')) {
3172 $status["source"] = ContactSelector::networkToName($item['item_network'], $user_info['url']);
3173 } elseif (($item['item_network'] != "") && (ContactSelector::networkToName($item['item_network'], $user_info['url']) != $status["source"])) {
3174 $status["source"] = trim($status["source"].' ('.ContactSelector::networkToName($item['item_network'], $user_info['url']).')');
3178 // Retweets are only valid for top postings
3179 // It doesn't work reliable with the link if its a feed
3180 //$IsRetweet = ($item['owner-link'] != $item['author-link']);
3182 // $IsRetweet = (($item['owner-name'] != $item['author-name']) || ($item['owner-avatar'] != $item['author-avatar']));
3185 if ($item["id"] == $item["parent"]) {
3186 $retweeted_item = api_share_as_retweet($item);
3187 if ($retweeted_item !== false) {
3188 $retweeted_status = $status;
3190 $retweeted_status["user"] = api_get_user($a, $retweeted_item["author-link"]);
3191 } catch (BadRequestException $e) {
3192 // user not found. should be found?
3193 /// @todo check if the user should be always found
3194 $retweeted_status["user"] = [];
3197 $rt_converted = api_convert_item($retweeted_item);
3199 $retweeted_status['text'] = $rt_converted["text"];
3200 $retweeted_status['statusnet_html'] = $rt_converted["html"];
3201 $retweeted_status['friendica_activities'] = api_format_items_activities($retweeted_item, $type);
3202 $retweeted_status['created_at'] = api_date($retweeted_item['created']);
3203 $status['retweeted_status'] = $retweeted_status;
3207 // "uid" and "self" are only needed for some internal stuff, so remove it from here
3208 unset($status["user"]["uid"]);
3209 unset($status["user"]["self"]);
3211 if ($item["coord"] != "") {
3212 $coords = explode(' ', $item["coord"]);
3213 if (count($coords) == 2) {
3214 if ($type == "json") {
3215 $status["geo"] = ['type' => 'Point',
3216 'coordinates' => [(float) $coords[0],
3217 (float) $coords[1]]];
3218 } else {// Not sure if this is the official format - if someone founds a documentation we can check
3219 $status["georss:point"] = $item["coord"];
3229 * Returns the remaining number of API requests available to the user before the API limit is reached.
3231 * @param string $type Return type (atom, rss, xml, json)
3233 * @return array|string
3235 function api_account_rate_limit_status($type)
3237 if ($type == "xml") {
3239 'remaining-hits' => '150',
3240 '@attributes' => ["type" => "integer"],
3241 'hourly-limit' => '150',
3242 '@attributes2' => ["type" => "integer"],
3243 'reset-time' => DateTimeFormat::utc('now + 1 hour', DateTimeFormat::ATOM),
3244 '@attributes3' => ["type" => "datetime"],
3245 'reset_time_in_seconds' => strtotime('now + 1 hour'),
3246 '@attributes4' => ["type" => "integer"],
3250 'reset_time_in_seconds' => strtotime('now + 1 hour'),
3251 'remaining_hits' => '150',
3252 'hourly_limit' => '150',
3253 'reset_time' => api_date(DateTimeFormat::utc('now + 1 hour', DateTimeFormat::ATOM)),
3257 return api_format_data('hash', $type, ['hash' => $hash]);
3260 /// @TODO move to top of file or somewhere better
3261 api_register_func('api/account/rate_limit_status', 'api_account_rate_limit_status', true);
3264 * Returns the string "ok" in the requested format with a 200 OK HTTP status code.
3266 * @param string $type Return type (atom, rss, xml, json)
3268 * @return array|string
3270 function api_help_test($type)
3272 if ($type == 'xml') {
3278 return api_format_data('ok', $type, ["ok" => $ok]);
3281 /// @TODO move to top of file or somewhere better
3282 api_register_func('api/help/test', 'api_help_test', false);
3285 * Returns all lists the user subscribes to.
3287 * @param string $type Return type (atom, rss, xml, json)
3289 * @return array|string
3290 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-list
3292 function api_lists_list($type)
3295 /// @TODO $ret is not filled here?
3296 return api_format_data('lists', $type, ["lists_list" => $ret]);
3299 /// @TODO move to top of file or somewhere better
3300 api_register_func('api/lists/list', 'api_lists_list', true);
3301 api_register_func('api/lists/subscriptions', 'api_lists_list', true);
3304 * Returns all groups the user owns.
3306 * @param string $type Return type (atom, rss, xml, json)
3308 * @return array|string
3309 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships
3311 function api_lists_ownerships($type)
3315 if (api_user() === false) {
3316 throw new ForbiddenException();
3320 $user_info = api_get_user($a);
3321 $uid = $user_info['uid'];
3323 $groups = dba::select('group', [], ['deleted' => 0, 'uid' => $uid]);
3325 // loop through all groups
3327 foreach ($groups as $group) {
3328 if ($group['visible']) {
3334 'name' => $group['name'],
3335 'id' => intval($group['id']),
3336 'id_str' => (string) $group['id'],
3337 'user' => $user_info,
3341 return api_format_data("lists", $type, ['lists' => ['lists' => $lists]]);
3344 /// @TODO move to top of file or somewhere better
3345 api_register_func('api/lists/ownerships', 'api_lists_ownerships', true);
3348 * Returns recent statuses from users in the specified group.
3350 * @param string $type Return type (atom, rss, xml, json)
3352 * @return array|string
3353 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships
3355 function api_lists_statuses($type)
3359 $user_info = api_get_user($a);
3360 if (api_user() === false || $user_info === false) {
3361 throw new ForbiddenException();
3364 unset($_REQUEST["user_id"]);
3365 unset($_GET["user_id"]);
3367 unset($_REQUEST["screen_name"]);
3368 unset($_GET["screen_name"]);
3370 if (empty($_REQUEST['list_id'])) {
3371 throw new BadRequestException('list_id not specified');
3375 $count = (x($_REQUEST, 'count') ? $_REQUEST['count'] : 20);
3376 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] - 1 : 0);
3380 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
3381 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
3382 $exclude_replies = (x($_REQUEST, 'exclude_replies') ? 1 : 0);
3383 $conversation_id = (x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0);
3385 $start = $page * $count;
3389 $sql_extra .= ' AND `item`.`id` <= ' . intval($max_id);
3391 if ($exclude_replies > 0) {
3392 $sql_extra .= ' AND `item`.`parent` = `item`.`id`';
3394 if ($conversation_id > 0) {
3395 $sql_extra .= ' AND `item`.`parent` = ' . intval($conversation_id);
3399 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`,
3400 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
3401 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
3402 `contact`.`id` AS `cid`, `group_member`.`gid`
3404 STRAIGHT_JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
3405 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
3406 STRAIGHT_JOIN `group_member` ON `group_member`.`contact-id` = `item`.`contact-id`
3407 WHERE `item`.`uid` = ? AND `verb` = ?
3408 AND `item`.`visible` AND NOT `item`.`moderated` AND NOT `item`.`deleted`
3411 AND `group_member`.`gid` = ?
3412 ORDER BY `item`.`id` DESC LIMIT ".intval($start)." ,".intval($count),
3416 $_REQUEST['list_id']
3419 $items = api_format_items(dba::inArray($statuses), $user_info, false, $type);
3421 $data = ['status' => $items];
3425 $data = api_rss_extra($a, $data, $user_info);
3429 return api_format_data("statuses", $type, $data);
3432 /// @TODO move to top of file or somewhere better
3433 api_register_func('api/lists/statuses', 'api_lists_statuses', true);
3436 * Considers friends and followers lists to be private and won't return
3437 * anything if any user_id parameter is passed.
3439 * @brief Returns either the friends of the follower list
3441 * @param string $qtype Either "friends" or "followers"
3442 * @return boolean|array
3443 * @throws ForbiddenException
3445 function api_statuses_f($qtype)
3449 if (api_user() === false) {
3450 throw new ForbiddenException();
3454 $count = x($_GET, 'count') ? $_GET['count'] : 20;
3455 $page = x($_GET, 'page') ? $_GET['page'] : 1;
3459 $start = ($page - 1) * $count;
3461 $user_info = api_get_user($a);
3463 if (x($_GET, 'cursor') && $_GET['cursor'] == 'undefined') {
3464 /* this is to stop Hotot to load friends multiple times
3465 * I'm not sure if I'm missing return something or
3466 * is a bug in hotot. Workaround, meantime
3470 return array('$users' => $ret);*/
3475 if ($qtype == 'friends') {
3476 $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(CONTACT_IS_SHARING), intval(CONTACT_IS_FRIEND));
3477 } elseif ($qtype == 'followers') {
3478 $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(CONTACT_IS_FOLLOWER), intval(CONTACT_IS_FRIEND));
3481 // friends and followers only for self
3482 if ($user_info['self'] == 0) {
3483 $sql_extra = " AND false ";
3486 if ($qtype == 'blocks') {
3487 $sql_filter = 'AND `blocked` AND NOT `pending`';
3488 } elseif ($qtype == 'incoming') {
3489 $sql_filter = 'AND `pending`';
3491 $sql_filter = 'AND (NOT `blocked` OR `pending`)';
3509 foreach ($r as $cid) {
3510 $user = api_get_user($a, $cid['nurl']);
3511 // "uid" and "self" are only needed for some internal stuff, so remove it from here
3512 unset($user["uid"]);
3513 unset($user["self"]);
3520 return ['user' => $ret];
3525 * Returns the user's friends.
3527 * @brief Returns the list of friends of the provided user
3529 * @deprecated By Twitter API in favor of friends/list
3531 * @param string $type Either "json" or "xml"
3532 * @return boolean|string|array
3534 function api_statuses_friends($type)
3536 $data = api_statuses_f("friends");
3537 if ($data === false) {
3540 return api_format_data("users", $type, $data);
3544 * Returns the user's followers.
3546 * @brief Returns the list of followers of the provided user
3548 * @deprecated By Twitter API in favor of friends/list
3550 * @param string $type Either "json" or "xml"
3551 * @return boolean|string|array
3553 function api_statuses_followers($type)
3555 $data = api_statuses_f("followers");
3556 if ($data === false) {
3559 return api_format_data("users", $type, $data);
3562 /// @TODO move to top of file or somewhere better
3563 api_register_func('api/statuses/friends', 'api_statuses_friends', true);
3564 api_register_func('api/statuses/followers', 'api_statuses_followers', true);
3567 * Returns the list of blocked users
3569 * @see https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/get-blocks-list
3571 * @param string $type Either "json" or "xml"
3573 * @return boolean|string|array
3575 function api_blocks_list($type)
3577 $data = api_statuses_f('blocks');
3578 if ($data === false) {
3581 return api_format_data("users", $type, $data);
3584 /// @TODO move to top of file or somewhere better
3585 api_register_func('api/blocks/list', 'api_blocks_list', true);
3588 * Returns the list of pending users IDs
3590 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-incoming
3592 * @param string $type Either "json" or "xml"
3594 * @return boolean|string|array
3596 function api_friendships_incoming($type)
3598 $data = api_statuses_f('incoming');
3599 if ($data === false) {
3604 foreach ($data['user'] as $user) {
3605 $ids[] = $user['id'];
3608 return api_format_data("ids", $type, ['id' => $ids]);
3611 /// @TODO move to top of file or somewhere better
3612 api_register_func('api/friendships/incoming', 'api_friendships_incoming', true);
3615 * Returns the instance's configuration information.
3617 * @param string $type Return type (atom, rss, xml, json)
3619 * @return array|string
3621 function api_statusnet_config($type)
3625 $name = $a->config['sitename'];
3626 $server = $a->get_hostname();
3627 $logo = System::baseUrl() . '/images/friendica-64.png';
3628 $email = $a->config['admin_email'];
3629 $closed = (($a->config['register_policy'] == REGISTER_CLOSED) ? 'true' : 'false');
3630 $private = ((Config::get('system', 'block_public')) ? 'true' : 'false');
3631 $textlimit = (string) (($a->config['max_import_size']) ? $a->config['max_import_size'] : 200000);
3632 if ($a->config['api_import_size']) {
3633 $textlimit = (string) $a->config['api_import_size'];
3635 $ssl = ((Config::get('system', 'have_ssl')) ? 'true' : 'false');
3636 $sslserver = (($ssl === 'true') ? str_replace('http:', 'https:', System::baseUrl()) : '');
3639 'site' => ['name' => $name,'server' => $server, 'theme' => 'default', 'path' => '',
3640 'logo' => $logo, 'fancy' => true, 'language' => 'en', 'email' => $email, 'broughtby' => '',
3641 'broughtbyurl' => '', 'timezone' => 'UTC', 'closed' => $closed, 'inviteonly' => false,
3642 'private' => $private, 'textlimit' => $textlimit, 'sslserver' => $sslserver, 'ssl' => $ssl,
3643 'shorturllength' => '30',
3645 'FRIENDICA_PLATFORM' => FRIENDICA_PLATFORM,
3646 'FRIENDICA_VERSION' => FRIENDICA_VERSION,
3647 'DFRN_PROTOCOL_VERSION' => DFRN_PROTOCOL_VERSION,
3648 'DB_UPDATE_VERSION' => DB_UPDATE_VERSION
3653 return api_format_data('config', $type, ['config' => $config]);
3656 /// @TODO move to top of file or somewhere better
3657 api_register_func('api/gnusocial/config', 'api_statusnet_config', false);
3658 api_register_func('api/statusnet/config', 'api_statusnet_config', false);
3662 * @param string $type Return type (atom, rss, xml, json)
3664 * @return array|string
3666 function api_statusnet_version($type)
3669 $fake_statusnet_version = "0.9.7";
3671 return api_format_data('version', $type, ['version' => $fake_statusnet_version]);
3674 /// @TODO move to top of file or somewhere better
3675 api_register_func('api/gnusocial/version', 'api_statusnet_version', false);
3676 api_register_func('api/statusnet/version', 'api_statusnet_version', false);
3680 * @param string $type Return type (atom, rss, xml, json)
3682 * @todo use api_format_data() to return data
3684 function api_ff_ids($type)
3687 throw new ForbiddenException();
3694 $stringify_ids = defaults($_REQUEST, 'stringify_ids', false);
3697 "SELECT `pcontact`.`id` FROM `contact`
3698 INNER JOIN `contact` AS `pcontact` ON `contact`.`nurl` = `pcontact`.`nurl` AND `pcontact`.`uid` = 0
3699 WHERE `contact`.`uid` = %s AND NOT `contact`.`self`",
3702 if (!DBM::is_result($r)) {
3707 foreach ($r as $rr) {
3708 if ($stringify_ids) {
3711 $ids[] = intval($rr['id']);
3715 return api_format_data("ids", $type, ['id' => $ids]);
3719 * Returns the ID of every user the user is following.
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-friends-ids
3726 function api_friends_ids($type)
3728 return api_ff_ids($type);
3732 * Returns the ID of every user following the user.
3734 * @param string $type Return type (atom, rss, xml, json)
3736 * @return array|string
3737 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-followers-ids
3739 function api_followers_ids($type)
3741 return api_ff_ids($type);
3744 /// @TODO move to top of file or somewhere better
3745 api_register_func('api/friends/ids', 'api_friends_ids', true);
3746 api_register_func('api/followers/ids', 'api_followers_ids', true);
3749 * Sends a new direct message.
3751 * @param string $type Return type (atom, rss, xml, json)
3753 * @return array|string
3754 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/new-message
3756 function api_direct_messages_new($type)
3761 if (api_user() === false) {
3762 throw new ForbiddenException();
3765 if (!x($_POST, "text") || (!x($_POST, "screen_name") && !x($_POST, "user_id"))) {
3769 $sender = api_get_user($a);
3771 if ($_POST['screen_name']) {
3773 "SELECT `id`, `nurl`, `network` FROM `contact` WHERE `uid`=%d AND `nick`='%s'",
3775 dbesc($_POST['screen_name'])
3778 // Selecting the id by priority, friendica first
3779 api_best_nickname($r);
3781 $recipient = api_get_user($a, $r[0]['nurl']);
3783 $recipient = api_get_user($a, $_POST['user_id']);
3788 if (x($_REQUEST, 'replyto')) {
3790 'SELECT `parent-uri`, `title` FROM `mail` WHERE `uid`=%d AND `id`=%d',
3792 intval($_REQUEST['replyto'])
3794 $replyto = $r[0]['parent-uri'];
3795 $sub = $r[0]['title'];
3797 if (x($_REQUEST, 'title')) {
3798 $sub = $_REQUEST['title'];
3800 $sub = ((strlen($_POST['text'])>10) ? substr($_POST['text'], 0, 10)."...":$_POST['text']);
3804 $id = Mail::send($recipient['cid'], $_POST['text'], $sub, $replyto);
3807 $r = q("SELECT * FROM `mail` WHERE id=%d", intval($id));
3808 $ret = api_format_messages($r[0], $recipient, $sender);
3810 $ret = ["error"=>$id];
3813 $data = ['direct_message'=>$ret];
3818 $data = api_rss_extra($a, $data, $sender);
3821 return api_format_data("direct-messages", $type, $data);
3824 /// @TODO move to top of file or somewhere better
3825 api_register_func('api/direct_messages/new', 'api_direct_messages_new', true, API_METHOD_POST);
3828 * Destroys a direct message.
3830 * @brief delete a direct_message from mail table through api
3832 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3833 * @return string|array
3834 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/delete-message
3836 function api_direct_messages_destroy($type)
3840 if (api_user() === false) {
3841 throw new ForbiddenException();
3845 $user_info = api_get_user($a);
3847 $id = (x($_REQUEST, 'id') ? $_REQUEST['id'] : 0);
3849 $parenturi = (x($_REQUEST, 'friendica_parenturi') ? $_REQUEST['friendica_parenturi'] : "");
3850 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3851 /// @todo optional parameter 'include_entities' from Twitter API not yet implemented
3853 $uid = $user_info['uid'];
3854 // error if no id or parenturi specified (for clients posting parent-uri as well)
3855 if ($verbose == "true" && ($id == 0 || $parenturi == "")) {
3856 $answer = ['result' => 'error', 'message' => 'message id or parenturi not specified'];
3857 return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3860 // BadRequestException if no id specified (for clients using Twitter API)
3862 throw new BadRequestException('Message id not specified');
3865 // add parent-uri to sql command if specified by calling app
3866 $sql_extra = ($parenturi != "" ? " AND `parent-uri` = '" . dbesc($parenturi) . "'" : "");
3868 // get data of the specified message id
3870 "SELECT `id` FROM `mail` WHERE `uid` = %d AND `id` = %d" . $sql_extra,
3875 // error message if specified id is not in database
3876 if (!DBM::is_result($r)) {
3877 if ($verbose == "true") {
3878 $answer = ['result' => 'error', 'message' => 'message id not in database'];
3879 return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3881 /// @todo BadRequestException ok for Twitter API clients?
3882 throw new BadRequestException('message id not in database');
3887 "DELETE FROM `mail` WHERE `uid` = %d AND `id` = %d" . $sql_extra,
3892 if ($verbose == "true") {
3895 $answer = ['result' => 'ok', 'message' => 'message deleted'];
3896 return api_format_data("direct_message_delete", $type, ['$result' => $answer]);
3898 $answer = ['result' => 'error', 'message' => 'unknown error'];
3899 return api_format_data("direct_messages_delete", $type, ['$result' => $answer]);
3902 /// @todo return JSON data like Twitter API not yet implemented
3905 /// @TODO move to top of file or somewhere better
3906 api_register_func('api/direct_messages/destroy', 'api_direct_messages_destroy', true, API_METHOD_DELETE);
3910 * @param string $type Return type (atom, rss, xml, json)
3911 * @param string $box
3912 * @param string $verbose
3914 * @return array|string
3916 function api_direct_messages_box($type, $box, $verbose)
3919 $user_info = api_get_user($a);
3921 if (api_user() === false || $user_info === false) {
3922 throw new ForbiddenException();
3926 $count = (x($_GET, 'count') ? $_GET['count'] : 20);
3927 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] -1 : 0);
3932 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
3933 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
3935 $user_id = (x($_REQUEST, 'user_id') ? $_REQUEST['user_id'] : "");
3936 $screen_name = (x($_REQUEST, 'screen_name') ? $_REQUEST['screen_name'] : "");
3939 unset($_REQUEST["user_id"]);
3940 unset($_GET["user_id"]);
3942 unset($_REQUEST["screen_name"]);
3943 unset($_GET["screen_name"]);
3945 $profile_url = $user_info["url"];
3948 $start = $page * $count;
3953 if ($box=="sentbox") {
3954 $sql_extra = "`mail`.`from-url`='" . dbesc($profile_url) . "'";
3955 } elseif ($box == "conversation") {
3956 $sql_extra = "`mail`.`parent-uri`='" . dbesc($_GET["uri"]) . "'";
3957 } elseif ($box == "all") {
3958 $sql_extra = "true";
3959 } elseif ($box == "inbox") {
3960 $sql_extra = "`mail`.`from-url`!='" . dbesc($profile_url) . "'";
3964 $sql_extra .= ' AND `mail`.`id` <= ' . intval($max_id);
3967 if ($user_id != "") {
3968 $sql_extra .= ' AND `mail`.`contact-id` = ' . intval($user_id);
3969 } elseif ($screen_name !="") {
3970 $sql_extra .= " AND `contact`.`nick` = '" . dbesc($screen_name). "'";
3974 "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",
3980 if ($verbose == "true" && !DBM::is_result($r)) {
3981 $answer = ['result' => 'error', 'message' => 'no mails available'];
3982 return api_format_data("direct_messages_all", $type, ['$result' => $answer]);
3986 foreach ($r as $item) {
3987 if ($box == "inbox" || $item['from-url'] != $profile_url) {
3988 $recipient = $user_info;
3989 $sender = api_get_user($a, normalise_link($item['contact-url']));
3990 } elseif ($box == "sentbox" || $item['from-url'] == $profile_url) {
3991 $recipient = api_get_user($a, normalise_link($item['contact-url']));
3992 $sender = $user_info;
3995 if (isset($recipient) && isset($sender)) {
3996 $ret[] = api_format_messages($item, $recipient, $sender);
4001 $data = ['direct_message' => $ret];
4005 $data = api_rss_extra($a, $data, $user_info);
4008 return api_format_data("direct-messages", $type, $data);
4012 * Returns the most recent direct messages sent by the user.
4014 * @param string $type Return type (atom, rss, xml, json)
4016 * @return array|string
4017 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-sent-message
4019 function api_direct_messages_sentbox($type)
4021 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
4022 return api_direct_messages_box($type, "sentbox", $verbose);
4026 * Returns the most recent direct messages sent to the user.
4028 * @param string $type Return type (atom, rss, xml, json)
4030 * @return array|string
4031 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-messages
4033 function api_direct_messages_inbox($type)
4035 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
4036 return api_direct_messages_box($type, "inbox", $verbose);
4041 * @param string $type Return type (atom, rss, xml, json)
4043 * @return array|string
4045 function api_direct_messages_all($type)
4047 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
4048 return api_direct_messages_box($type, "all", $verbose);
4053 * @param string $type Return type (atom, rss, xml, json)
4055 * @return array|string
4057 function api_direct_messages_conversation($type)
4059 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
4060 return api_direct_messages_box($type, "conversation", $verbose);
4063 /// @TODO move to top of file or somewhere better
4064 api_register_func('api/direct_messages/conversation', 'api_direct_messages_conversation', true);
4065 api_register_func('api/direct_messages/all', 'api_direct_messages_all', true);
4066 api_register_func('api/direct_messages/sent', 'api_direct_messages_sentbox', true);
4067 api_register_func('api/direct_messages', 'api_direct_messages_inbox', true);
4070 * Returns an OAuth Request Token.
4072 * @see https://oauth.net/core/1.0/#auth_step1
4074 function api_oauth_request_token()
4076 $oauth1 = new FKOAuth1();
4078 $r = $oauth1->fetch_request_token(OAuthRequest::from_request());
4079 } catch (Exception $e) {
4080 echo "error=" . OAuthUtil::urlencode_rfc3986($e->getMessage());
4088 * Returns an OAuth Access Token.
4090 * @return array|string
4091 * @see https://oauth.net/core/1.0/#auth_step3
4093 function api_oauth_access_token()
4095 $oauth1 = new FKOAuth1();
4097 $r = $oauth1->fetch_access_token(OAuthRequest::from_request());
4098 } catch (Exception $e) {
4099 echo "error=". OAuthUtil::urlencode_rfc3986($e->getMessage());
4106 /// @TODO move to top of file or somewhere better
4107 api_register_func('api/oauth/request_token', 'api_oauth_request_token', false);
4108 api_register_func('api/oauth/access_token', 'api_oauth_access_token', false);
4112 * @brief delete a complete photoalbum with all containing photos from database through api
4114 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4115 * @return string|array
4117 function api_fr_photoalbum_delete($type)
4119 if (api_user() === false) {
4120 throw new ForbiddenException();
4123 $album = (x($_REQUEST, 'album') ? $_REQUEST['album'] : "");
4125 // we do not allow calls without album string
4127 throw new BadRequestException("no albumname specified");
4129 // check if album is existing
4131 "SELECT DISTINCT `resource-id` FROM `photo` WHERE `uid` = %d AND `album` = '%s'",
4135 if (!DBM::is_result($r)) {
4136 throw new BadRequestException("album not available");
4139 // function for setting the items to "deleted = 1" which ensures that comments, likes etc. are not shown anymore
4140 // to the user and the contacts of the users (drop_items() performs the federation of the deletion to other networks
4141 foreach ($r as $rr) {
4143 "SELECT `id` FROM `item` WHERE `uid` = %d AND `resource-id` = '%s' AND `type` = 'photo'",
4144 intval(local_user()),
4145 dbesc($rr['resource-id'])
4148 if (!DBM::is_result($photo_item)) {
4149 throw new InternalServerErrorException("problem with deleting items occured");
4151 Item::deleteById($photo_item[0]['id']);
4154 // now let's delete all photos from the album
4155 $result = dba::delete('photo', ['uid' => api_user(), 'album' => $album]);
4157 // return success of deletion or error message
4159 $answer = ['result' => 'deleted', 'message' => 'album `' . $album . '` with all containing photos has been deleted.'];
4160 return api_format_data("photoalbum_delete", $type, ['$result' => $answer]);
4162 throw new InternalServerErrorException("unknown error - deleting from database failed");
4167 * @brief update the name of the album for all photos of an album
4169 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4170 * @return string|array
4172 function api_fr_photoalbum_update($type)
4174 if (api_user() === false) {
4175 throw new ForbiddenException();
4178 $album = (x($_REQUEST, 'album') ? $_REQUEST['album'] : "");
4179 $album_new = (x($_REQUEST, 'album_new') ? $_REQUEST['album_new'] : "");
4181 // we do not allow calls without album string
4183 throw new BadRequestException("no albumname specified");
4185 if ($album_new == "") {
4186 throw new BadRequestException("no new albumname specified");
4188 // check if album is existing
4189 if (!dba::exists('photo', ['uid' => api_user(), 'album' => $album])) {
4190 throw new BadRequestException("album not available");
4192 // now let's update all photos to the albumname
4193 $result = dba::update('photo', ['album' => $album_new], ['uid' => api_user(), 'album' => $album]);
4195 // return success of updating or error message
4197 $answer = ['result' => 'updated', 'message' => 'album `' . $album . '` with all containing photos has been renamed to `' . $album_new . '`.'];
4198 return api_format_data("photoalbum_update", $type, ['$result' => $answer]);
4200 throw new InternalServerErrorException("unknown error - updating in database failed");
4206 * @brief list all photos of the authenticated user
4208 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4209 * @return string|array
4211 function api_fr_photos_list($type)
4213 if (api_user() === false) {
4214 throw new ForbiddenException();
4217 "SELECT `resource-id`, MAX(scale) AS `scale`, `album`, `filename`, `type`, MAX(`created`) AS `created`,
4218 MAX(`edited`) AS `edited`, MAX(`desc`) AS `desc` FROM `photo`
4219 WHERE `uid` = %d AND `album` != 'Contact Photos' GROUP BY `resource-id`",
4220 intval(local_user())
4223 'image/jpeg' => 'jpg',
4224 'image/png' => 'png',
4225 'image/gif' => 'gif'
4227 $data = ['photo'=>[]];
4228 if (DBM::is_result($r)) {
4229 foreach ($r as $rr) {
4231 $photo['id'] = $rr['resource-id'];
4232 $photo['album'] = $rr['album'];
4233 $photo['filename'] = $rr['filename'];
4234 $photo['type'] = $rr['type'];
4235 $thumb = System::baseUrl() . "/photo/" . $rr['resource-id'] . "-" . $rr['scale'] . "." . $typetoext[$rr['type']];
4236 $photo['created'] = $rr['created'];
4237 $photo['edited'] = $rr['edited'];
4238 $photo['desc'] = $rr['desc'];
4240 if ($type == "xml") {
4241 $data['photo'][] = ["@attributes" => $photo, "1" => $thumb];
4243 $photo['thumb'] = $thumb;
4244 $data['photo'][] = $photo;
4248 return api_format_data("photos", $type, $data);
4252 * @brief upload a new photo or change an existing photo
4254 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4255 * @return string|array
4257 function api_fr_photo_create_update($type)
4259 if (api_user() === false) {
4260 throw new ForbiddenException();
4263 $photo_id = (x($_REQUEST, 'photo_id') ? $_REQUEST['photo_id'] : null);
4264 $desc = (x($_REQUEST, 'desc') ? $_REQUEST['desc'] : (array_key_exists('desc', $_REQUEST) ? "" : null)); // extra check necessary to distinguish between 'not provided' and 'empty string'
4265 $album = (x($_REQUEST, 'album') ? $_REQUEST['album'] : null);
4266 $album_new = (x($_REQUEST, 'album_new') ? $_REQUEST['album_new'] : null);
4267 $allow_cid = (x($_REQUEST, 'allow_cid') ? $_REQUEST['allow_cid'] : (array_key_exists('allow_cid', $_REQUEST) ? " " : null));
4268 $deny_cid = (x($_REQUEST, 'deny_cid') ? $_REQUEST['deny_cid'] : (array_key_exists('deny_cid', $_REQUEST) ? " " : null));
4269 $allow_gid = (x($_REQUEST, 'allow_gid') ? $_REQUEST['allow_gid'] : (array_key_exists('allow_gid', $_REQUEST) ? " " : null));
4270 $deny_gid = (x($_REQUEST, 'deny_gid') ? $_REQUEST['deny_gid'] : (array_key_exists('deny_gid', $_REQUEST) ? " " : null));
4271 $visibility = (x($_REQUEST, 'visibility') ? (($_REQUEST['visibility'] == "true" || $_REQUEST['visibility'] == 1) ? true : false) : false);
4273 // do several checks on input parameters
4274 // we do not allow calls without album string
4275 if ($album == null) {
4276 throw new BadRequestException("no albumname specified");
4278 // if photo_id == null --> we are uploading a new photo
4279 if ($photo_id == null) {
4282 // error if no media posted in create-mode
4283 if (!x($_FILES, 'media')) {
4285 throw new BadRequestException("no media data submitted");
4288 // album_new will be ignored in create-mode
4293 // check if photo is existing in database
4295 "SELECT `id` FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s' AND `album` = '%s'",
4300 if (!DBM::is_result($r)) {
4301 throw new BadRequestException("photo not available");
4305 // checks on acl strings provided by clients
4306 $acl_input_error = false;
4307 $acl_input_error |= check_acl_input($allow_cid);
4308 $acl_input_error |= check_acl_input($deny_cid);
4309 $acl_input_error |= check_acl_input($allow_gid);
4310 $acl_input_error |= check_acl_input($deny_gid);
4311 if ($acl_input_error) {
4312 throw new BadRequestException("acl data invalid");
4314 // now let's upload the new media in create-mode
4315 if ($mode == "create") {
4316 $media = $_FILES['media'];
4317 $data = save_media_to_database("photo", $media, $type, $album, trim($allow_cid), trim($deny_cid), trim($allow_gid), trim($deny_gid), $desc, $visibility);
4319 // return success of updating or error message
4320 if (!is_null($data)) {
4321 return api_format_data("photo_create", $type, $data);
4323 throw new InternalServerErrorException("unknown error - uploading photo failed, see Friendica log for more information");
4327 // now let's do the changes in update-mode
4328 if ($mode == "update") {
4331 if (!is_null($desc)) {
4332 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`desc` = '$desc'";
4335 if (!is_null($album_new)) {
4336 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`album` = '$album_new'";
4339 if (!is_null($allow_cid)) {
4340 $allow_cid = trim($allow_cid);
4341 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`allow_cid` = '$allow_cid'";
4344 if (!is_null($deny_cid)) {
4345 $deny_cid = trim($deny_cid);
4346 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`deny_cid` = '$deny_cid'";
4349 if (!is_null($allow_gid)) {
4350 $allow_gid = trim($allow_gid);
4351 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`allow_gid` = '$allow_gid'";
4354 if (!is_null($deny_gid)) {
4355 $deny_gid = trim($deny_gid);
4356 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`deny_gid` = '$deny_gid'";
4360 if ($sql_extra != "") {
4361 $nothingtodo = false;
4363 "UPDATE `photo` SET %s, `edited`='%s' WHERE `uid` = %d AND `resource-id` = '%s' AND `album` = '%s'",
4365 DateTimeFormat::utcNow(), // update edited timestamp
4371 $nothingtodo = true;
4374 if (x($_FILES, 'media')) {
4375 $nothingtodo = false;
4376 $media = $_FILES['media'];
4377 $data = save_media_to_database("photo", $media, $type, $album, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $desc, 0, $visibility, $photo_id);
4378 if (!is_null($data)) {
4379 return api_format_data("photo_update", $type, $data);
4383 // return success of updating or error message
4385 $answer = ['result' => 'updated', 'message' => 'Image id `' . $photo_id . '` has been updated.'];
4386 return api_format_data("photo_update", $type, ['$result' => $answer]);
4389 $answer = ['result' => 'cancelled', 'message' => 'Nothing to update for image id `' . $photo_id . '`.'];
4390 return api_format_data("photo_update", $type, ['$result' => $answer]);
4392 throw new InternalServerErrorException("unknown error - update photo entry in database failed");
4395 throw new InternalServerErrorException("unknown error - this error on uploading or updating a photo should never happen");
4400 * @brief delete a single photo from the database through api
4402 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4403 * @return string|array
4405 function api_fr_photo_delete($type)
4407 if (api_user() === false) {
4408 throw new ForbiddenException();
4411 $photo_id = (x($_REQUEST, 'photo_id') ? $_REQUEST['photo_id'] : null);
4413 // do several checks on input parameters
4414 // we do not allow calls without photo id
4415 if ($photo_id == null) {
4416 throw new BadRequestException("no photo_id specified");
4418 // check if photo is existing in database
4420 "SELECT `id` FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s'",
4424 if (!DBM::is_result($r)) {
4425 throw new BadRequestException("photo not available");
4427 // now we can perform on the deletion of the photo
4428 $result = dba::delete('photo', ['uid' => api_user(), 'resource-id' => $photo_id]);
4430 // return success of deletion or error message
4432 // retrieve the id of the parent element (the photo element)
4434 "SELECT `id` FROM `item` WHERE `uid` = %d AND `resource-id` = '%s' AND `type` = 'photo'",
4435 intval(local_user()),
4439 if (!DBM::is_result($photo_item)) {
4440 throw new InternalServerErrorException("problem with deleting items occured");
4442 // function for setting the items to "deleted = 1" which ensures that comments, likes etc. are not shown anymore
4443 // to the user and the contacts of the users (drop_items() do all the necessary magic to avoid orphans in database and federate deletion)
4444 Item::deleteById($photo_item[0]['id']);
4446 $answer = ['result' => 'deleted', 'message' => 'photo with id `' . $photo_id . '` has been deleted from server.'];
4447 return api_format_data("photo_delete", $type, ['$result' => $answer]);
4449 throw new InternalServerErrorException("unknown error on deleting photo from database table");
4455 * @brief returns the details of a specified photo id, if scale is given, returns the photo data in base 64
4457 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4458 * @return string|array
4460 function api_fr_photo_detail($type)
4462 if (api_user() === false) {
4463 throw new ForbiddenException();
4465 if (!x($_REQUEST, 'photo_id')) {
4466 throw new BadRequestException("No photo id.");
4469 $scale = (x($_REQUEST, 'scale') ? intval($_REQUEST['scale']) : false);
4470 $photo_id = $_REQUEST['photo_id'];
4472 // prepare json/xml output with data from database for the requested photo
4473 $data = prepare_photo_data($type, $scale, $photo_id);
4475 return api_format_data("photo_detail", $type, $data);
4480 * Updates the user’s profile image.
4482 * @brief updates the profile image for the user (either a specified profile or the default profile)
4484 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4486 * @return string|array
4487 * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_image
4489 function api_account_update_profile_image($type)
4491 if (api_user() === false) {
4492 throw new ForbiddenException();
4495 $profile_id = defaults($_REQUEST, 'profile_id', 0);
4497 // error if image data is missing
4498 if (!x($_FILES, 'image')) {
4499 throw new BadRequestException("no media data submitted");
4502 // check if specified profile id is valid
4503 if ($profile_id != 0) {
4504 $profile = dba::selectFirst('profile', ['is-default'], ['uid' => api_user(), 'id' => $profile_id]);
4505 // error message if specified profile id is not in database
4506 if (!DBM::is_result($profile)) {
4507 throw new BadRequestException("profile_id not available");
4509 $is_default_profile = $profile['is-default'];
4511 $is_default_profile = 1;
4514 // get mediadata from image or media (Twitter call api/account/update_profile_image provides image)
4516 if (x($_FILES, 'image')) {
4517 $media = $_FILES['image'];
4518 } elseif (x($_FILES, 'media')) {
4519 $media = $_FILES['media'];
4521 // save new profile image
4522 $data = save_media_to_database("profileimage", $media, $type, L10n::t('Profile Photos'), "", "", "", "", "", $is_default_profile);
4525 if (is_array($media['type'])) {
4526 $filetype = $media['type'][0];
4528 $filetype = $media['type'];
4530 if ($filetype == "image/jpeg") {
4532 } elseif ($filetype == "image/png") {
4535 throw new InternalServerErrorException('Unsupported filetype');
4537 // change specified profile or all profiles to the new resource-id
4538 if ($is_default_profile) {
4539 $condition = ["`profile` AND `resource-id` != ? AND `uid` = ?", $data['photo']['id'], api_user()];
4540 dba::update('photo', ['profile' => false], $condition);
4542 $fields = ['photo' => System::baseUrl() . '/photo/' . $data['photo']['id'] . '-4.' . $filetype,
4543 'thumb' => System::baseUrl() . '/photo/' . $data['photo']['id'] . '-5.' . $filetype];
4544 dba::update('profile', $fields, ['id' => $_REQUEST['profile'], 'uid' => api_user()]);
4547 Contact::updateSelfFromUserID(api_user(), true);
4549 // Update global directory in background
4550 //$user = api_get_user(get_app());
4551 $url = System::baseUrl() . '/profile/' . get_app()->user['nickname'];
4552 if ($url && strlen(Config::get('system', 'directory'))) {
4553 Worker::add(PRIORITY_LOW, "Directory", $url);
4556 Worker::add(PRIORITY_LOW, 'ProfileUpdate', api_user());
4558 // output for client
4560 return api_account_verify_credentials($type);
4562 // SaveMediaToDatabase failed for some reason
4563 throw new InternalServerErrorException("image upload failed");
4567 // place api-register for photoalbum calls before 'api/friendica/photo', otherwise this function is never reached
4568 api_register_func('api/friendica/photoalbum/delete', 'api_fr_photoalbum_delete', true, API_METHOD_DELETE);
4569 api_register_func('api/friendica/photoalbum/update', 'api_fr_photoalbum_update', true, API_METHOD_POST);
4570 api_register_func('api/friendica/photos/list', 'api_fr_photos_list', true);
4571 api_register_func('api/friendica/photo/create', 'api_fr_photo_create_update', true, API_METHOD_POST);
4572 api_register_func('api/friendica/photo/update', 'api_fr_photo_create_update', true, API_METHOD_POST);
4573 api_register_func('api/friendica/photo/delete', 'api_fr_photo_delete', true, API_METHOD_DELETE);
4574 api_register_func('api/friendica/photo', 'api_fr_photo_detail', true);
4575 api_register_func('api/account/update_profile_image', 'api_account_update_profile_image', true, API_METHOD_POST);
4578 * Update user profile
4580 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4582 * @return array|string
4584 function api_account_update_profile($type)
4586 $local_user = api_user();
4587 $api_user = api_get_user(get_app());
4589 if (!empty($_POST['name'])) {
4590 dba::update('profile', ['name' => $_POST['name']], ['uid' => $local_user]);
4591 dba::update('user', ['username' => $_POST['name']], ['uid' => $local_user]);
4592 dba::update('contact', ['name' => $_POST['name']], ['uid' => $local_user, 'self' => 1]);
4593 dba::update('contact', ['name' => $_POST['name']], ['id' => $api_user['id']]);
4596 if (isset($_POST['description'])) {
4597 dba::update('profile', ['about' => $_POST['description']], ['uid' => $local_user]);
4598 dba::update('contact', ['about' => $_POST['description']], ['uid' => $local_user, 'self' => 1]);
4599 dba::update('contact', ['about' => $_POST['description']], ['id' => $api_user['id']]);
4602 Worker::add(PRIORITY_LOW, 'ProfileUpdate', $local_user);
4603 // Update global directory in background
4604 if ($api_user['url'] && strlen(Config::get('system', 'directory'))) {
4605 Worker::add(PRIORITY_LOW, "Directory", $api_user['url']);
4608 return api_account_verify_credentials($type);
4611 /// @TODO move to top of file or somewhere better
4612 api_register_func('api/account/update_profile', 'api_account_update_profile', true, API_METHOD_POST);
4616 * @param string $acl_string
4618 function check_acl_input($acl_string)
4620 if ($acl_string == null || $acl_string == " ") {
4623 $contact_not_found = false;
4625 // split <x><y><z> into array of cid's
4626 preg_match_all("/<[A-Za-z0-9]+>/", $acl_string, $array);
4628 // check for each cid if it is available on server
4629 $cid_array = $array[0];
4630 foreach ($cid_array as $cid) {
4631 $cid = str_replace("<", "", $cid);
4632 $cid = str_replace(">", "", $cid);
4634 "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
4638 $contact_not_found |= !DBM::is_result($contact);
4640 return $contact_not_found;
4645 * @param string $mediatype
4646 * @param array $media
4647 * @param string $type
4648 * @param string $album
4649 * @param string $allow_cid
4650 * @param string $deny_cid
4651 * @param string $allow_gid
4652 * @param string $deny_gid
4653 * @param string $desc
4654 * @param integer $profile
4655 * @param boolean $visibility
4656 * @param string $photo_id
4658 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)
4666 if (is_array($media)) {
4667 if (is_array($media['tmp_name'])) {
4668 $src = $media['tmp_name'][0];
4670 $src = $media['tmp_name'];
4672 if (is_array($media['name'])) {
4673 $filename = basename($media['name'][0]);
4675 $filename = basename($media['name']);
4677 if (is_array($media['size'])) {
4678 $filesize = intval($media['size'][0]);
4680 $filesize = intval($media['size']);
4682 if (is_array($media['type'])) {
4683 $filetype = $media['type'][0];
4685 $filetype = $media['type'];
4689 if ($filetype == "") {
4690 $filetype=Image::guessType($filename);
4692 $imagedata = getimagesize($src);
4694 $filetype = $imagedata['mime'];
4697 "File upload src: " . $src . " - filename: " . $filename .
4698 " - size: " . $filesize . " - type: " . $filetype,
4702 // check if there was a php upload error
4703 if ($filesize == 0 && $media['error'] == 1) {
4704 throw new InternalServerErrorException("image size exceeds PHP config settings, file was rejected by server");
4706 // check against max upload size within Friendica instance
4707 $maximagesize = Config::get('system', 'maximagesize');
4708 if ($maximagesize && ($filesize > $maximagesize)) {
4709 $formattedBytes = formatBytes($maximagesize);
4710 throw new InternalServerErrorException("image size exceeds Friendica config setting (uploaded size: $formattedBytes)");
4713 // create Photo instance with the data of the image
4714 $imagedata = @file_get_contents($src);
4715 $Image = new Image($imagedata, $filetype);
4716 if (! $Image->isValid()) {
4717 throw new InternalServerErrorException("unable to process image data");
4720 // check orientation of image
4721 $Image->orient($src);
4724 // check max length of images on server
4725 $max_length = Config::get('system', 'max_image_length');
4726 if (! $max_length) {
4727 $max_length = MAX_IMAGE_LENGTH;
4729 if ($max_length > 0) {
4730 $Image->scaleDown($max_length);
4731 logger("File upload: Scaling picture to new size " . $max_length, LOGGER_DEBUG);
4733 $width = $Image->getWidth();
4734 $height = $Image->getHeight();
4736 // create a new resource-id if not already provided
4737 $hash = ($photo_id == null) ? Photo::newResource() : $photo_id;
4739 if ($mediatype == "photo") {
4740 // upload normal image (scales 0, 1, 2)
4741 logger("photo upload: starting new photo upload", LOGGER_DEBUG);
4743 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 0, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4745 logger("photo upload: image upload with scale 0 (original size) failed");
4747 if ($width > 640 || $height > 640) {
4748 $Image->scaleDown(640);
4749 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 1, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4751 logger("photo upload: image upload with scale 1 (640x640) failed");
4755 if ($width > 320 || $height > 320) {
4756 $Image->scaleDown(320);
4757 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 2, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4759 logger("photo upload: image upload with scale 2 (320x320) failed");
4762 logger("photo upload: new photo upload ended", LOGGER_DEBUG);
4763 } elseif ($mediatype == "profileimage") {
4764 // upload profile image (scales 4, 5, 6)
4765 logger("photo upload: starting new profile image upload", LOGGER_DEBUG);
4767 if ($width > 175 || $height > 175) {
4768 $Image->scaleDown(175);
4769 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 4, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4771 logger("photo upload: profile image upload with scale 4 (175x175) failed");
4775 if ($width > 80 || $height > 80) {
4776 $Image->scaleDown(80);
4777 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 5, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4779 logger("photo upload: profile image upload with scale 5 (80x80) failed");
4783 if ($width > 48 || $height > 48) {
4784 $Image->scaleDown(48);
4785 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 6, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4787 logger("photo upload: profile image upload with scale 6 (48x48) failed");
4790 $Image->__destruct();
4791 logger("photo upload: new profile image upload ended", LOGGER_DEBUG);
4794 if (isset($r) && $r) {
4795 // create entry in 'item'-table on new uploads to enable users to comment/like/dislike the photo
4796 if ($photo_id == null && $mediatype == "photo") {
4797 post_photo_item($hash, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility);
4799 // on success return image data in json/xml format (like /api/friendica/photo does when no scale is given)
4800 return prepare_photo_data($type, false, $hash);
4802 throw new InternalServerErrorException("image upload failed");
4808 * @param string $hash
4809 * @param string $allow_cid
4810 * @param string $deny_cid
4811 * @param string $allow_gid
4812 * @param string $deny_gid
4813 * @param string $filetype
4814 * @param boolean $visibility
4816 function post_photo_item($hash, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility = false)
4818 // get data about the api authenticated user
4819 $uri = item_new_uri(get_app()->get_hostname(), intval(api_user()));
4820 $owner_record = q("SELECT * FROM `contact` WHERE `uid`= %d AND `self` LIMIT 1", intval(api_user()));
4823 $arr['guid'] = get_guid(32);
4824 $arr['uid'] = intval(api_user());
4826 $arr['parent-uri'] = $uri;
4827 $arr['type'] = 'photo';
4829 $arr['resource-id'] = $hash;
4830 $arr['contact-id'] = $owner_record[0]['id'];
4831 $arr['owner-name'] = $owner_record[0]['name'];
4832 $arr['owner-link'] = $owner_record[0]['url'];
4833 $arr['owner-avatar'] = $owner_record[0]['thumb'];
4834 $arr['author-name'] = $owner_record[0]['name'];
4835 $arr['author-link'] = $owner_record[0]['url'];
4836 $arr['author-avatar'] = $owner_record[0]['thumb'];
4838 $arr['allow_cid'] = $allow_cid;
4839 $arr['allow_gid'] = $allow_gid;
4840 $arr['deny_cid'] = $deny_cid;
4841 $arr['deny_gid'] = $deny_gid;
4842 $arr['visible'] = $visibility;
4846 'image/jpeg' => 'jpg',
4847 'image/png' => 'png',
4848 'image/gif' => 'gif'
4851 // adds link to the thumbnail scale photo
4852 $arr['body'] = '[url=' . System::baseUrl() . '/photos/' . $owner_record[0]['nick'] . '/image/' . $hash . ']'
4853 . '[img]' . System::baseUrl() . '/photo/' . $hash . '-' . "2" . '.'. $typetoext[$filetype] . '[/img]'
4856 // do the magic for storing the item in the database and trigger the federation to other contacts
4862 * @param string $type
4864 * @param string $photo_id
4868 function prepare_photo_data($type, $scale, $photo_id)
4871 $user_info = api_get_user($a);
4873 if ($user_info === false) {
4874 throw new ForbiddenException();
4877 $scale_sql = ($scale === false ? "" : sprintf("AND scale=%d", intval($scale)));
4878 $data_sql = ($scale === false ? "" : "data, ");
4880 // added allow_cid, allow_gid, deny_cid, deny_gid to output as string like stored in database
4881 // clients needs to convert this in their way for further processing
4883 "SELECT %s `resource-id`, `created`, `edited`, `title`, `desc`, `album`, `filename`,
4884 `type`, `height`, `width`, `datasize`, `profile`, `allow_cid`, `deny_cid`, `allow_gid`, `deny_gid`,
4885 MIN(`scale`) AS `minscale`, MAX(`scale`) AS `maxscale`
4886 FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s' %s GROUP BY `resource-id`",
4888 intval(local_user()),
4894 'image/jpeg' => 'jpg',
4895 'image/png' => 'png',
4896 'image/gif' => 'gif'
4899 // prepare output data for photo
4900 if (DBM::is_result($r)) {
4901 $data = ['photo' => $r[0]];
4902 $data['photo']['id'] = $data['photo']['resource-id'];
4903 if ($scale !== false) {
4904 $data['photo']['data'] = base64_encode($data['photo']['data']);
4906 unset($data['photo']['datasize']); //needed only with scale param
4908 if ($type == "xml") {
4909 $data['photo']['links'] = [];
4910 for ($k = intval($data['photo']['minscale']); $k <= intval($data['photo']['maxscale']); $k++) {
4911 $data['photo']['links'][$k . ":link"]["@attributes"] = ["type" => $data['photo']['type'],
4913 "href" => System::baseUrl() . "/photo/" . $data['photo']['resource-id'] . "-" . $k . "." . $typetoext[$data['photo']['type']]];
4916 $data['photo']['link'] = [];
4917 // when we have profile images we could have only scales from 4 to 6, but index of array always needs to start with 0
4919 for ($k = intval($data['photo']['minscale']); $k <= intval($data['photo']['maxscale']); $k++) {
4920 $data['photo']['link'][$i] = System::baseUrl() . "/photo/" . $data['photo']['resource-id'] . "-" . $k . "." . $typetoext[$data['photo']['type']];
4924 unset($data['photo']['resource-id']);
4925 unset($data['photo']['minscale']);
4926 unset($data['photo']['maxscale']);
4928 throw new NotFoundException();
4931 // retrieve item element for getting activities (like, dislike etc.) related to photo
4933 "SELECT * FROM `item` WHERE `uid` = %d AND `resource-id` = '%s' AND `type` = 'photo'",
4934 intval(local_user()),
4937 $data['photo']['friendica_activities'] = api_format_items_activities($item[0], $type);
4939 // retrieve comments on photo
4941 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`,
4942 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
4943 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
4944 `contact`.`id` AS `cid`
4946 STRAIGHT_JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
4947 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
4948 WHERE `item`.`parent` = %d AND `item`.`visible`
4949 AND NOT `item`.`moderated` AND NOT `item`.`deleted`
4950 AND `item`.`uid` = %d AND (`item`.`verb`='%s' OR `type`='photo')",
4951 intval($item[0]['parent']),
4953 dbesc(ACTIVITY_POST)
4956 // prepare output of comments
4957 $commentData = api_format_items($r, $user_info, false, $type);
4959 if ($type == "xml") {
4961 foreach ($commentData as $comment) {
4962 $comments[$k++ . ":comment"] = $comment;
4965 foreach ($commentData as $comment) {
4966 $comments[] = $comment;
4969 $data['photo']['friendica_comments'] = $comments;
4971 // include info if rights on photo and rights on item are mismatching
4972 $rights_mismatch = $data['photo']['allow_cid'] != $item[0]['allow_cid'] ||
4973 $data['photo']['deny_cid'] != $item[0]['deny_cid'] ||
4974 $data['photo']['allow_gid'] != $item[0]['allow_gid'] ||
4975 $data['photo']['deny_cid'] != $item[0]['deny_cid'];
4976 $data['photo']['rights_mismatch'] = $rights_mismatch;
4983 * Similar as /mod/redir.php
4984 * redirect to 'url' after dfrn auth
4986 * Why this when there is mod/redir.php already?
4987 * This use api_user() and api_login()
4990 * c_url: url of remote contact to auth to
4991 * url: string, url to redirect after auth
4993 function api_friendica_remoteauth()
4995 $url = (x($_GET, 'url') ? $_GET['url'] : '');
4996 $c_url = (x($_GET, 'c_url') ? $_GET['c_url'] : '');
4998 if ($url === '' || $c_url === '') {
4999 throw new BadRequestException("Wrong parameters.");
5002 $c_url = normalise_link($c_url);
5006 $contact = dba::selectFirst('contact', [], ['uid' => api_user(), 'nurl' => $c_url]);
5008 if (!DBM::is_result($contact) || ($contact['network'] !== NETWORK_DFRN)) {
5009 throw new BadRequestException("Unknown contact");
5012 $cid = $contact['id'];
5014 $dfrn_id = defaults($contact, 'issued-id', $contact['dfrn-id']);
5016 if ($contact['duplex'] && $contact['issued-id']) {
5017 $orig_id = $contact['issued-id'];
5018 $dfrn_id = '1:' . $orig_id;
5020 if ($contact['duplex'] && $contact['dfrn-id']) {
5021 $orig_id = $contact['dfrn-id'];
5022 $dfrn_id = '0:' . $orig_id;
5025 $sec = random_string();
5027 $fields = ['uid' => api_user(), 'cid' => $cid, 'dfrn_id' => $dfrn_id,
5028 'sec' => $sec, 'expire' => time() + 45];
5029 dba::insert('profile_check', $fields);
5031 logger($contact['name'] . ' ' . $sec, LOGGER_DEBUG);
5032 $dest = ($url ? '&destination_url=' . $url : '');
5034 $contact['poll'] . '?dfrn_id=' . $dfrn_id
5035 . '&dfrn_version=' . DFRN_PROTOCOL_VERSION
5036 . '&type=profile&sec=' . $sec . $dest
5039 api_register_func('api/friendica/remoteauth', 'api_friendica_remoteauth', true);
5042 * @brief Return the item shared, if the item contains only the [share] tag
5044 * @param array $item Sharer item
5045 * @return array|false Shared item or false if not a reshare
5047 function api_share_as_retweet(&$item)
5049 $body = trim($item["body"]);
5051 if (Diaspora::isReshare($body, false)===false) {
5055 /// @TODO "$1" should maybe mean '$1' ?
5056 $attributes = preg_replace("/\[share(.*?)\]\s?(.*?)\s?\[\/share\]\s?/ism", "$1", $body);
5058 * Skip if there is no shared message in there
5059 * we already checked this in diaspora::isReshare()
5060 * but better one more than one less...
5062 if ($body == $attributes) {
5067 // build the fake reshared item
5068 $reshared_item = $item;
5071 preg_match("/author='(.*?)'/ism", $attributes, $matches);
5072 if ($matches[1] != "") {
5073 $author = html_entity_decode($matches[1], ENT_QUOTES, 'UTF-8');
5076 preg_match('/author="(.*?)"/ism', $attributes, $matches);
5077 if ($matches[1] != "") {
5078 $author = $matches[1];
5082 preg_match("/profile='(.*?)'/ism", $attributes, $matches);
5083 if ($matches[1] != "") {
5084 $profile = $matches[1];
5087 preg_match('/profile="(.*?)"/ism', $attributes, $matches);
5088 if ($matches[1] != "") {
5089 $profile = $matches[1];
5093 preg_match("/avatar='(.*?)'/ism", $attributes, $matches);
5094 if ($matches[1] != "") {
5095 $avatar = $matches[1];
5098 preg_match('/avatar="(.*?)"/ism', $attributes, $matches);
5099 if ($matches[1] != "") {
5100 $avatar = $matches[1];
5104 preg_match("/link='(.*?)'/ism", $attributes, $matches);
5105 if ($matches[1] != "") {
5106 $link = $matches[1];
5109 preg_match('/link="(.*?)"/ism', $attributes, $matches);
5110 if ($matches[1] != "") {
5111 $link = $matches[1];
5115 preg_match("/posted='(.*?)'/ism", $attributes, $matches);
5116 if ($matches[1] != "") {
5117 $posted = $matches[1];
5120 preg_match('/posted="(.*?)"/ism', $attributes, $matches);
5121 if ($matches[1] != "") {
5122 $posted = $matches[1];
5125 $shared_body = preg_replace("/\[share(.*?)\]\s?(.*?)\s?\[\/share\]\s?/ism", "$2", $body);
5127 if (($shared_body == "") || ($profile == "") || ($author == "") || ($avatar == "") || ($posted == "")) {
5131 $reshared_item["body"] = $shared_body;
5132 $reshared_item["author-name"] = $author;
5133 $reshared_item["author-link"] = $profile;
5134 $reshared_item["author-avatar"] = $avatar;
5135 $reshared_item["plink"] = $link;
5136 $reshared_item["created"] = $posted;
5137 $reshared_item["edited"] = $posted;
5139 return $reshared_item;
5144 * @param string $profile
5146 * @return string|false
5147 * @todo remove trailing junk from profile url
5148 * @todo pump.io check has to check the website
5150 function api_get_nick($profile)
5155 "SELECT `nick` FROM `contact` WHERE `uid` = 0 AND `nurl` = '%s'",
5156 dbesc(normalise_link($profile))
5159 if (DBM::is_result($r)) {
5160 $nick = $r[0]["nick"];
5165 "SELECT `nick` FROM `contact` WHERE `uid` = 0 AND `nurl` = '%s'",
5166 dbesc(normalise_link($profile))
5169 if (DBM::is_result($r)) {
5170 $nick = $r[0]["nick"];
5175 $friendica = preg_replace("=https?://(.*)/profile/(.*)=ism", "$2", $profile);
5176 if ($friendica != $profile) {
5182 $diaspora = preg_replace("=https?://(.*)/u/(.*)=ism", "$2", $profile);
5183 if ($diaspora != $profile) {
5189 $twitter = preg_replace("=https?://twitter.com/(.*)=ism", "$1", $profile);
5190 if ($twitter != $profile) {
5197 $StatusnetHost = preg_replace("=https?://(.*)/user/(.*)=ism", "$1", $profile);
5198 if ($StatusnetHost != $profile) {
5199 $StatusnetUser = preg_replace("=https?://(.*)/user/(.*)=ism", "$2", $profile);
5200 if ($StatusnetUser != $profile) {
5201 $UserData = Network::fetchUrl("http://".$StatusnetHost."/api/users/show.json?user_id=".$StatusnetUser);
5202 $user = json_decode($UserData);
5204 $nick = $user->screen_name;
5210 // To-Do: look at the page if its really a pumpio site
5211 //if (!$nick == "") {
5212 // $pumpio = preg_replace("=https?://(.*)/(.*)/=ism", "$2", $profile."/");
5213 // if ($pumpio != $profile)
5215 // <div class="media" id="profile-block" data-profile-id="acct:kabniel@microca.st">
5228 * @param array $item
5232 function api_in_reply_to($item)
5236 $in_reply_to['status_id'] = null;
5237 $in_reply_to['user_id'] = null;
5238 $in_reply_to['status_id_str'] = null;
5239 $in_reply_to['user_id_str'] = null;
5240 $in_reply_to['screen_name'] = null;
5242 if (($item['thr-parent'] != $item['uri']) && (intval($item['parent']) != intval($item['id']))) {
5244 "SELECT `id` FROM `item` WHERE `uid` = %d AND `uri` = '%s' LIMIT 1",
5245 intval($item['uid']),
5246 dbesc($item['thr-parent'])
5249 if (DBM::is_result($r)) {
5250 $in_reply_to['status_id'] = intval($r[0]['id']);
5252 $in_reply_to['status_id'] = intval($item['parent']);
5255 $in_reply_to['status_id_str'] = (string) intval($in_reply_to['status_id']);
5258 "SELECT `contact`.`nick`, `contact`.`name`, `contact`.`id`, `contact`.`url` FROM item
5259 STRAIGHT_JOIN `contact` ON `contact`.`id` = `item`.`author-id`
5260 WHERE `item`.`id` = %d LIMIT 1",
5261 intval($in_reply_to['status_id'])
5264 if (DBM::is_result($r)) {
5265 if ($r[0]['nick'] == "") {
5266 $r[0]['nick'] = api_get_nick($r[0]["url"]);
5269 $in_reply_to['screen_name'] = (($r[0]['nick']) ? $r[0]['nick'] : $r[0]['name']);
5270 $in_reply_to['user_id'] = intval($r[0]['id']);
5271 $in_reply_to['user_id_str'] = (string) intval($r[0]['id']);
5274 // There seems to be situation, where both fields are identical:
5275 // https://github.com/friendica/friendica/issues/1010
5276 // This is a bugfix for that.
5277 if (intval($in_reply_to['status_id']) == intval($item['id'])) {
5278 logger('this message should never appear: id: '.$item['id'].' similar to reply-to: '.$in_reply_to['status_id'], LOGGER_DEBUG);
5279 $in_reply_to['status_id'] = null;
5280 $in_reply_to['user_id'] = null;
5281 $in_reply_to['status_id_str'] = null;
5282 $in_reply_to['user_id_str'] = null;
5283 $in_reply_to['screen_name'] = null;
5287 return $in_reply_to;
5292 * @param string $Text
5296 function api_clean_plain_items($Text)
5298 $include_entities = strtolower(x($_REQUEST, 'include_entities') ? $_REQUEST['include_entities'] : "false");
5300 $Text = BBCode::cleanPictureLinks($Text);
5301 $URLSearchString = "^\[\]";
5303 $Text = preg_replace("/([!#@])\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '$1$3', $Text);
5305 if ($include_entities == "true") {
5306 $Text = preg_replace("/\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '[url=$1]$1[/url]', $Text);
5309 // Simplify "attachment" element
5310 $Text = api_clean_attachments($Text);
5316 * @brief Removes most sharing information for API text export
5318 * @param string $body The original body
5320 * @return string Cleaned body
5322 function api_clean_attachments($body)
5324 $data = BBCode::getAttachmentData($body);
5331 if (isset($data["text"])) {
5332 $body = $data["text"];
5334 if (($body == "") && isset($data["title"])) {
5335 $body = $data["title"];
5337 if (isset($data["url"])) {
5338 $body .= "\n".$data["url"];
5340 $body .= $data["after"];
5347 * @param array $contacts
5351 function api_best_nickname(&$contacts)
5355 if (count($contacts) == 0) {
5359 foreach ($contacts as $contact) {
5360 if ($contact["network"] == "") {
5361 $contact["network"] = "dfrn";
5362 $best_contact = [$contact];
5366 if (sizeof($best_contact) == 0) {
5367 foreach ($contacts as $contact) {
5368 if ($contact["network"] == "dfrn") {
5369 $best_contact = [$contact];
5374 if (sizeof($best_contact) == 0) {
5375 foreach ($contacts as $contact) {
5376 if ($contact["network"] == "dspr") {
5377 $best_contact = [$contact];
5382 if (sizeof($best_contact) == 0) {
5383 foreach ($contacts as $contact) {
5384 if ($contact["network"] == "stat") {
5385 $best_contact = [$contact];
5390 if (sizeof($best_contact) == 0) {
5391 foreach ($contacts as $contact) {
5392 if ($contact["network"] == "pump") {
5393 $best_contact = [$contact];
5398 if (sizeof($best_contact) == 0) {
5399 foreach ($contacts as $contact) {
5400 if ($contact["network"] == "twit") {
5401 $best_contact = [$contact];
5406 if (sizeof($best_contact) == 1) {
5407 $contacts = $best_contact;
5409 $contacts = [$contacts[0]];
5414 * Return all or a specified group of the user with the containing contacts.
5416 * @param string $type Return type (atom, rss, xml, json)
5418 * @return array|string
5420 function api_friendica_group_show($type)
5424 if (api_user() === false) {
5425 throw new ForbiddenException();
5429 $user_info = api_get_user($a);
5430 $gid = (x($_REQUEST, 'gid') ? $_REQUEST['gid'] : 0);
5431 $uid = $user_info['uid'];
5433 // get data of the specified group id or all groups if not specified
5436 "SELECT * FROM `group` WHERE `deleted` = 0 AND `uid` = %d AND `id` = %d",
5440 // error message if specified gid is not in database
5441 if (!DBM::is_result($r)) {
5442 throw new BadRequestException("gid not available");
5446 "SELECT * FROM `group` WHERE `deleted` = 0 AND `uid` = %d",
5451 // loop through all groups and retrieve all members for adding data in the user array
5453 foreach ($r as $rr) {
5454 $members = Contact::getByGroupId($rr['id']);
5457 if ($type == "xml") {
5458 $user_element = "users";
5460 foreach ($members as $member) {
5461 $user = api_get_user($a, $member['nurl']);
5462 $users[$k++.":user"] = $user;
5465 $user_element = "user";
5466 foreach ($members as $member) {
5467 $user = api_get_user($a, $member['nurl']);
5471 $grps[] = ['name' => $rr['name'], 'gid' => $rr['id'], $user_element => $users];
5473 return api_format_data("groups", $type, ['group' => $grps]);
5475 api_register_func('api/friendica/group_show', 'api_friendica_group_show', true);
5479 * Delete the specified group of the user.
5481 * @param string $type Return type (atom, rss, xml, json)
5483 * @return array|string
5485 function api_friendica_group_delete($type)
5489 if (api_user() === false) {
5490 throw new ForbiddenException();
5494 $user_info = api_get_user($a);
5495 $gid = (x($_REQUEST, 'gid') ? $_REQUEST['gid'] : 0);
5496 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5497 $uid = $user_info['uid'];
5499 // error if no gid specified
5500 if ($gid == 0 || $name == "") {
5501 throw new BadRequestException('gid or name not specified');
5504 // get data of the specified group id
5506 "SELECT * FROM `group` WHERE `uid` = %d AND `id` = %d",
5510 // error message if specified gid is not in database
5511 if (!DBM::is_result($r)) {
5512 throw new BadRequestException('gid not available');
5515 // get data of the specified group id and group name
5517 "SELECT * FROM `group` WHERE `uid` = %d AND `id` = %d AND `name` = '%s'",
5522 // error message if specified gid is not in database
5523 if (!DBM::is_result($rname)) {
5524 throw new BadRequestException('wrong group name');
5528 $ret = Group::removeByName($uid, $name);
5531 $success = ['success' => $ret, 'gid' => $gid, 'name' => $name, 'status' => 'deleted', 'wrong users' => []];
5532 return api_format_data("group_delete", $type, ['result' => $success]);
5534 throw new BadRequestException('other API error');
5537 api_register_func('api/friendica/group_delete', 'api_friendica_group_delete', true, API_METHOD_DELETE);
5542 * @param string $type Return type (atom, rss, xml, json)
5544 * @return array|string
5545 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-destroy
5547 function api_lists_destroy($type)
5551 if (api_user() === false) {
5552 throw new ForbiddenException();
5556 $user_info = api_get_user($a);
5557 $gid = (x($_REQUEST, 'list_id') ? $_REQUEST['list_id'] : 0);
5558 $uid = $user_info['uid'];
5560 // error if no gid specified
5562 throw new BadRequestException('gid not specified');
5565 // get data of the specified group id
5566 $group = dba::selectFirst('group', [], ['uid' => $uid, 'id' => $gid]);
5567 // error message if specified gid is not in database
5569 throw new BadRequestException('gid not available');
5572 if (Group::remove($gid)) {
5574 'name' => $group['name'],
5575 'id' => intval($gid),
5576 'id_str' => (string) $gid,
5577 'user' => $user_info
5580 return api_format_data("lists", $type, ['lists' => $list]);
5583 api_register_func('api/lists/destroy', 'api_lists_destroy', true, API_METHOD_DELETE);
5586 * Add a new group to the database.
5588 * @param string $name Group name
5589 * @param int $uid User ID
5590 * @param array $users List of users to add to the group
5594 function group_create($name, $uid, $users = [])
5596 // error if no name specified
5598 throw new BadRequestException('group name not specified');
5601 // get data of the specified group name
5603 "SELECT * FROM `group` WHERE `uid` = %d AND `name` = '%s' AND `deleted` = 0",
5607 // error message if specified group name already exists
5608 if (DBM::is_result($rname)) {
5609 throw new BadRequestException('group name already exists');
5612 // check if specified group name is a deleted group
5614 "SELECT * FROM `group` WHERE `uid` = %d AND `name` = '%s' AND `deleted` = 1",
5618 // error message if specified group name already exists
5619 if (DBM::is_result($rname)) {
5620 $reactivate_group = true;
5624 $ret = Group::create($uid, $name);
5626 $gid = Group::getIdByName($uid, $name);
5628 throw new BadRequestException('other API error');
5632 $erroraddinguser = false;
5634 foreach ($users as $user) {
5635 $cid = $user['cid'];
5636 // check if user really exists as contact
5638 "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
5642 if (count($contact)) {
5643 Group::addMember($gid, $cid);
5645 $erroraddinguser = true;
5646 $errorusers[] = $cid;
5650 // return success message incl. missing users in array
5651 $status = ($erroraddinguser ? "missing user" : ((isset($reactivate_group) && $reactivate_group) ? "reactivated" : "ok"));
5653 return ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers];
5657 * Create the specified group with the posted array of contacts.
5659 * @param string $type Return type (atom, rss, xml, json)
5661 * @return array|string
5663 function api_friendica_group_create($type)
5667 if (api_user() === false) {
5668 throw new ForbiddenException();
5672 $user_info = api_get_user($a);
5673 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5674 $uid = $user_info['uid'];
5675 $json = json_decode($_POST['json'], true);
5676 $users = $json['user'];
5678 $success = group_create($name, $uid, $users);
5680 return api_format_data("group_create", $type, ['result' => $success]);
5682 api_register_func('api/friendica/group_create', 'api_friendica_group_create', true, API_METHOD_POST);
5685 * Create a new group.
5687 * @param string $type Return type (atom, rss, xml, json)
5689 * @return array|string
5690 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-create
5692 function api_lists_create($type)
5696 if (api_user() === false) {
5697 throw new ForbiddenException();
5701 $user_info = api_get_user($a);
5702 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5703 $uid = $user_info['uid'];
5705 $success = group_create($name, $uid);
5706 if ($success['success']) {
5708 'name' => $success['name'],
5709 'id' => intval($success['gid']),
5710 'id_str' => (string) $success['gid'],
5711 'user' => $user_info
5714 return api_format_data("lists", $type, ['lists'=>$grp]);
5717 api_register_func('api/lists/create', 'api_lists_create', true, API_METHOD_POST);
5720 * Update the specified group with the posted array of contacts.
5722 * @param string $type Return type (atom, rss, xml, json)
5724 * @return array|string
5726 function api_friendica_group_update($type)
5730 if (api_user() === false) {
5731 throw new ForbiddenException();
5735 $user_info = api_get_user($a);
5736 $uid = $user_info['uid'];
5737 $gid = (x($_REQUEST, 'gid') ? $_REQUEST['gid'] : 0);
5738 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5739 $json = json_decode($_POST['json'], true);
5740 $users = $json['user'];
5742 // error if no name specified
5744 throw new BadRequestException('group name not specified');
5747 // error if no gid specified
5749 throw new BadRequestException('gid not specified');
5753 $members = Contact::getByGroupId($gid);
5754 foreach ($members as $member) {
5755 $cid = $member['id'];
5756 foreach ($users as $user) {
5757 $found = ($user['cid'] == $cid ? true : false);
5759 if (!isset($found) || !$found) {
5760 Group::removeMemberByName($uid, $name, $cid);
5765 $erroraddinguser = false;
5767 foreach ($users as $user) {
5768 $cid = $user['cid'];
5769 // check if user really exists as contact
5771 "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
5776 if (count($contact)) {
5777 Group::addMember($gid, $cid);
5779 $erroraddinguser = true;
5780 $errorusers[] = $cid;
5784 // return success message incl. missing users in array
5785 $status = ($erroraddinguser ? "missing user" : "ok");
5786 $success = ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers];
5787 return api_format_data("group_update", $type, ['result' => $success]);
5790 api_register_func('api/friendica/group_update', 'api_friendica_group_update', true, API_METHOD_POST);
5793 * Update information about a group.
5795 * @param string $type Return type (atom, rss, xml, json)
5797 * @return array|string
5798 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-update
5800 function api_lists_update($type)
5804 if (api_user() === false) {
5805 throw new ForbiddenException();
5809 $user_info = api_get_user($a);
5810 $gid = (x($_REQUEST, 'list_id') ? $_REQUEST['list_id'] : 0);
5811 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5812 $uid = $user_info['uid'];
5814 // error if no gid specified
5816 throw new BadRequestException('gid not specified');
5819 // get data of the specified group id
5820 $group = dba::selectFirst('group', [], ['uid' => $uid, 'id' => $gid]);
5821 // error message if specified gid is not in database
5823 throw new BadRequestException('gid not available');
5826 if (Group::update($gid, $name)) {
5829 'id' => intval($gid),
5830 'id_str' => (string) $gid,
5831 'user' => $user_info
5834 return api_format_data("lists", $type, ['lists' => $list]);
5838 api_register_func('api/lists/update', 'api_lists_update', true, API_METHOD_POST);
5842 * @param string $type Return type (atom, rss, xml, json)
5844 * @return array|string
5846 function api_friendica_activity($type)
5850 if (api_user() === false) {
5851 throw new ForbiddenException();
5853 $verb = strtolower($a->argv[3]);
5854 $verb = preg_replace("|\..*$|", "", $verb);
5856 $id = (x($_REQUEST, 'id') ? $_REQUEST['id'] : 0);
5858 $res = Item::performLike($id, $verb);
5861 if ($type == "xml") {
5866 return api_format_data('ok', $type, ['ok' => $ok]);
5868 throw new BadRequestException('Error adding activity');
5872 /// @TODO move to top of file or somewhere better
5873 api_register_func('api/friendica/activity/like', 'api_friendica_activity', true, API_METHOD_POST);
5874 api_register_func('api/friendica/activity/dislike', 'api_friendica_activity', true, API_METHOD_POST);
5875 api_register_func('api/friendica/activity/attendyes', 'api_friendica_activity', true, API_METHOD_POST);
5876 api_register_func('api/friendica/activity/attendno', 'api_friendica_activity', true, API_METHOD_POST);
5877 api_register_func('api/friendica/activity/attendmaybe', 'api_friendica_activity', true, API_METHOD_POST);
5878 api_register_func('api/friendica/activity/unlike', 'api_friendica_activity', true, API_METHOD_POST);
5879 api_register_func('api/friendica/activity/undislike', 'api_friendica_activity', true, API_METHOD_POST);
5880 api_register_func('api/friendica/activity/unattendyes', 'api_friendica_activity', true, API_METHOD_POST);
5881 api_register_func('api/friendica/activity/unattendno', 'api_friendica_activity', true, API_METHOD_POST);
5882 api_register_func('api/friendica/activity/unattendmaybe', 'api_friendica_activity', true, API_METHOD_POST);
5885 * @brief Returns notifications
5887 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5888 * @return string|array
5890 function api_friendica_notification($type)
5894 if (api_user() === false) {
5895 throw new ForbiddenException();
5898 throw new BadRequestException("Invalid argument count");
5900 $nm = new NotificationsManager();
5902 $notes = $nm->getAll([], "+seen -date", 50);
5904 if ($type == "xml") {
5906 foreach ($notes as $note) {
5907 $xmlnotes[] = ["@attributes" => $note];
5913 return api_format_data("notes", $type, ['note' => $notes]);
5917 * POST request with 'id' param as notification id
5919 * @brief Set notification as seen and returns associated item (if possible)
5921 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5922 * @return string|array
5924 function api_friendica_notification_seen($type)
5927 $user_info = api_get_user($a);
5929 if (api_user() === false || $user_info === false) {
5930 throw new ForbiddenException();
5933 throw new BadRequestException("Invalid argument count");
5936 $id = (x($_REQUEST, 'id') ? intval($_REQUEST['id']) : 0);
5938 $nm = new NotificationsManager();
5939 $note = $nm->getByID($id);
5940 if (is_null($note)) {
5941 throw new BadRequestException("Invalid argument");
5944 $nm->setSeen($note);
5945 if ($note['otype']=='item') {
5946 // would be really better with an ItemsManager and $im->getByID() :-P
5948 "SELECT * FROM `item` WHERE `id`=%d AND `uid`=%d",
5949 intval($note['iid']),
5950 intval(local_user())
5953 // we found the item, return it to the user
5954 $ret = api_format_items($r, $user_info, false, $type);
5955 $data = ['status' => $ret];
5956 return api_format_data("status", $type, $data);
5958 // the item can't be found, but we set the note as seen, so we count this as a success
5960 return api_format_data('result', $type, ['result' => "success"]);
5963 /// @TODO move to top of file or somewhere better
5964 api_register_func('api/friendica/notification/seen', 'api_friendica_notification_seen', true, API_METHOD_POST);
5965 api_register_func('api/friendica/notification', 'api_friendica_notification', true, API_METHOD_GET);
5968 * @brief update a direct_message to seen state
5970 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5971 * @return string|array (success result=ok, error result=error with error message)
5973 function api_friendica_direct_messages_setseen($type)
5976 if (api_user() === false) {
5977 throw new ForbiddenException();
5981 $user_info = api_get_user($a);
5982 $uid = $user_info['uid'];
5983 $id = (x($_REQUEST, 'id') ? $_REQUEST['id'] : 0);
5985 // return error if id is zero
5987 $answer = ['result' => 'error', 'message' => 'message id not specified'];
5988 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
5991 // error message if specified id is not in database
5992 if (!dba::exists('mail', ['id' => $id, 'uid' => $uid])) {
5993 $answer = ['result' => 'error', 'message' => 'message id not in database'];
5994 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
5997 // update seen indicator
5998 $result = dba::update('mail', ['seen' => true], ['id' => $id]);
6002 $answer = ['result' => 'ok', 'message' => 'message set to seen'];
6003 return api_format_data("direct_message_setseen", $type, ['$result' => $answer]);
6005 $answer = ['result' => 'error', 'message' => 'unknown error'];
6006 return api_format_data("direct_messages_setseen", $type, ['$result' => $answer]);
6010 /// @TODO move to top of file or somewhere better
6011 api_register_func('api/friendica/direct_messages_setseen', 'api_friendica_direct_messages_setseen', true);
6014 * @brief search for direct_messages containing a searchstring through api
6016 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
6017 * @param string $box
6018 * @return string|array (success: success=true if found and search_result contains found messages,
6019 * success=false if nothing was found, search_result='nothing found',
6020 * error: result=error with error message)
6022 function api_friendica_direct_messages_search($type, $box = "")
6026 if (api_user() === false) {
6027 throw new ForbiddenException();
6031 $user_info = api_get_user($a);
6032 $searchstring = (x($_REQUEST, 'searchstring') ? $_REQUEST['searchstring'] : "");
6033 $uid = $user_info['uid'];
6035 // error if no searchstring specified
6036 if ($searchstring == "") {
6037 $answer = ['result' => 'error', 'message' => 'searchstring not specified'];
6038 return api_format_data("direct_messages_search", $type, ['$result' => $answer]);
6041 // get data for the specified searchstring
6043 "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",
6045 dbesc('%'.$searchstring.'%')
6048 $profile_url = $user_info["url"];
6050 // message if nothing was found
6051 if (!DBM::is_result($r)) {
6052 $success = ['success' => false, 'search_results' => 'problem with query'];
6053 } elseif (count($r) == 0) {
6054 $success = ['success' => false, 'search_results' => 'nothing found'];
6057 foreach ($r as $item) {
6058 if ($box == "inbox" || $item['from-url'] != $profile_url) {
6059 $recipient = $user_info;
6060 $sender = api_get_user($a, normalise_link($item['contact-url']));
6061 } elseif ($box == "sentbox" || $item['from-url'] == $profile_url) {
6062 $recipient = api_get_user($a, normalise_link($item['contact-url']));
6063 $sender = $user_info;
6066 if (isset($recipient) && isset($sender)) {
6067 $ret[] = api_format_messages($item, $recipient, $sender);
6070 $success = ['success' => true, 'search_results' => $ret];
6073 return api_format_data("direct_message_search", $type, ['$result' => $success]);
6076 /// @TODO move to top of file or somewhere better
6077 api_register_func('api/friendica/direct_messages_search', 'api_friendica_direct_messages_search', true);
6080 * @brief return data of all the profiles a user has to the client
6082 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
6083 * @return string|array
6085 function api_friendica_profile_show($type)
6089 if (api_user() === false) {
6090 throw new ForbiddenException();
6094 $profile_id = (x($_REQUEST, 'profile_id') ? $_REQUEST['profile_id'] : 0);
6096 // retrieve general information about profiles for user
6097 $multi_profiles = Feature::isEnabled(api_user(), 'multi_profiles');
6098 $directory = Config::get('system', 'directory');
6100 // get data of the specified profile id or all profiles of the user if not specified
6101 if ($profile_id != 0) {
6103 "SELECT * FROM `profile` WHERE `uid` = %d AND `id` = %d",
6108 // error message if specified gid is not in database
6109 if (!DBM::is_result($r)) {
6110 throw new BadRequestException("profile_id not available");
6114 "SELECT * FROM `profile` WHERE `uid` = %d",
6118 // loop through all returned profiles and retrieve data and users
6121 foreach ($r as $rr) {
6122 $profile = api_format_items_profiles($rr);
6124 // select all users from contact table, loop and prepare standard return for user data
6127 "SELECT `id`, `nurl` FROM `contact` WHERE `uid`= %d AND `profile-id` = %d",
6129 intval($rr['profile_id'])
6132 foreach ($nurls as $nurl) {
6133 $user = api_get_user($a, $nurl['nurl']);
6134 ($type == "xml") ? $users[$k++ . ":user"] = $user : $users[] = $user;
6136 $profile['users'] = $users;
6138 // add prepared profile data to array for final return
6139 if ($type == "xml") {
6140 $profiles[$k++ . ":profile"] = $profile;
6142 $profiles[] = $profile;
6146 // return settings, authenticated user and profiles data
6147 $self = q("SELECT `nurl` FROM `contact` WHERE `uid`= %d AND `self` LIMIT 1", intval(api_user()));
6149 $result = ['multi_profiles' => $multi_profiles ? true : false,
6150 'global_dir' => $directory,
6151 'friendica_owner' => api_get_user($a, $self[0]['nurl']),
6152 'profiles' => $profiles];
6153 return api_format_data("friendica_profiles", $type, ['$result' => $result]);
6155 api_register_func('api/friendica/profile/show', 'api_friendica_profile_show', true, API_METHOD_GET);
6158 * Returns a list of saved searches.
6160 * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-saved_searches-list
6162 * @param string $type Return format: json or xml
6164 * @return string|array
6166 function api_saved_searches_list($type)
6168 $terms = dba::select('search', ['id', 'term'], ['uid' => local_user()]);
6171 while ($term = $terms->fetch()) {
6173 'created_at' => api_date(time()),
6174 'id' => intval($term['id']),
6175 'id_str' => $term['id'],
6176 'name' => $term['term'],
6178 'query' => $term['term']
6184 return api_format_data("terms", $type, ['terms' => $result]);
6187 /// @TODO move to top of file or somewhere better
6188 api_register_func('api/saved_searches/list', 'api_saved_searches_list', true);
6191 @TODO Maybe open to implement?
6193 [pagename] => api/1.1/statuses/lookup.json
6194 [id] => 605138389168451584
6195 [include_cards] => true
6196 [cards_platform] => Android-12
6197 [include_entities] => true
6198 [include_my_retweet] => 1
6200 [include_reply_count] => true
6201 [include_descendent_reply_count] => true
6205 Not implemented by now:
6206 statuses/retweets_of_me
6211 account/update_location
6212 account/update_profile_background_image
6215 friendica/profile/update
6216 friendica/profile/create
6217 friendica/profile/delete
6219 Not implemented in status.net:
6220 statuses/retweeted_to_me
6221 statuses/retweeted_by_me
6222 direct_messages/destroy
6224 account/update_delivery_device
6225 notifications/follow