3 * Friendica implementation of statusnet/twitter API
5 * @file include/api.php
6 * @todo Automatically detect if incoming data is HTML or BBCode
9 use Friendica\Content\ContactSelector;
10 use Friendica\Content\Feature;
11 use Friendica\Core\System;
12 use Friendica\Core\Config;
13 use Friendica\Core\NotificationsManager;
14 use Friendica\Core\PConfig;
15 use Friendica\Core\Worker;
16 use Friendica\Database\DBM;
17 use Friendica\Model\Contact;
18 use Friendica\Model\Group;
19 use Friendica\Model\Photo;
20 use Friendica\Model\User;
21 use Friendica\Network\FKOAuth1;
22 use Friendica\Network\HTTPException;
23 use Friendica\Network\HTTPException\BadRequestException;
24 use Friendica\Network\HTTPException\ForbiddenException;
25 use Friendica\Network\HTTPException\InternalServerErrorException;
26 use Friendica\Network\HTTPException\MethodNotAllowedException;
27 use Friendica\Network\HTTPException\NotFoundException;
28 use Friendica\Network\HTTPException\NotImplementedException;
29 use Friendica\Network\HTTPException\UnauthorizedException;
30 use Friendica\Network\HTTPException\TooManyRequestsException;
31 use Friendica\Object\Image;
32 use Friendica\Protocol\Diaspora;
33 use Friendica\Util\XML;
35 require_once 'include/bbcode.php';
36 require_once 'include/datetime.php';
37 require_once 'include/conversation.php';
38 require_once 'include/html2plain.php';
39 require_once 'mod/share.php';
40 require_once 'mod/item.php';
41 require_once 'include/security.php';
42 require_once 'include/html2bbcode.php';
43 require_once 'mod/wall_upload.php';
44 require_once 'mod/proxy.php';
45 require_once 'include/message.php';
46 require_once 'include/like.php';
47 require_once 'include/plaintext.php';
49 define('API_METHOD_ANY', '*');
50 define('API_METHOD_GET', 'GET');
51 define('API_METHOD_POST', 'POST,PUT');
52 define('API_METHOD_DELETE', 'POST,DELETE');
58 * It is not sufficient to use local_user() to check whether someone is allowed to use the API,
59 * because this will open CSRF holes (just embed an image with src=friendicasite.com/api/statuses/update?status=CSRF
60 * into a page, and visitors will post something without noticing it).
62 * @brief Auth API user
66 if (x($_SESSION, 'allow_api')) {
74 * Clients can send 'source' parameter to be show in post metadata
75 * as "sent via <source>".
76 * Some clients doesn't send a source param, we support ones we know
79 * @brief Get source name from API client
82 * Client source name, default to "api" if unset/unknown
86 if (requestdata('source')) {
87 return requestdata('source');
90 // Support for known clients that doesn't send a source name
91 if (strpos($_SERVER['HTTP_USER_AGENT'], "Twidere") !== false) {
95 logger("Unrecognized user-agent ".$_SERVER['HTTP_USER_AGENT'], LOGGER_DEBUG);
101 * @brief Format date for API
103 * @param string $str Source date, as UTC
104 * @return string Date in UTC formatted as "D M d H:i:s +0000 Y"
106 function api_date($str)
108 // Wed May 23 06:01:13 +0000 2007
109 return datetime_convert('UTC', 'UTC', $str, "D M d H:i:s +0000 Y");
113 * Register a function to be the endpoint for defined API path.
115 * @brief Register API endpoint
117 * @param string $path API URL path, relative to System::baseUrl()
118 * @param string $func Function name to call on path request
119 * @param bool $auth API need logged user
120 * @param string $method HTTP method reqiured to call this endpoint.
121 * One of API_METHOD_ANY, API_METHOD_GET, API_METHOD_POST.
122 * Default to API_METHOD_ANY
124 function api_register_func($path, $func, $auth = false, $method = API_METHOD_ANY)
134 // Workaround for hotot
135 $path = str_replace("api/", "api/1.1/", $path);
145 * Log in user via OAuth1 or Simple HTTP Auth.
146 * Simple Auth allow username in form of <pre>user@server</pre>, ignoring server part
148 * @brief Login API user
150 * @param object $a App
151 * @hook 'authenticate'
153 * 'username' => username from login form
154 * 'password' => password from login form
155 * 'authenticated' => return status,
156 * 'user_record' => return authenticated user record
158 * array $user logged user record
160 function api_login(App $a)
162 $oauth1 = new FKOAuth1();
165 list($consumer, $token) = $oauth1->verify_request(OAuthRequest::from_request());
166 if (!is_null($token)) {
167 $oauth1->loginUser($token->uid);
168 call_hooks('logged_in', $a->user);
171 echo __FILE__.__LINE__.__FUNCTION__ . "<pre>";
172 var_dump($consumer, $token);
174 } catch (Exception $e) {
178 // workaround for HTTP-auth in CGI mode
179 if (x($_SERVER, 'REDIRECT_REMOTE_USER')) {
180 $userpass = base64_decode(substr($_SERVER["REDIRECT_REMOTE_USER"], 6)) ;
181 if (strlen($userpass)) {
182 list($name, $password) = explode(':', $userpass);
183 $_SERVER['PHP_AUTH_USER'] = $name;
184 $_SERVER['PHP_AUTH_PW'] = $password;
188 if (!x($_SERVER, 'PHP_AUTH_USER')) {
189 logger('API_login: ' . print_r($_SERVER, true), LOGGER_DEBUG);
190 header('WWW-Authenticate: Basic realm="Friendica"');
191 throw new UnauthorizedException("This API requires login");
194 $user = $_SERVER['PHP_AUTH_USER'];
195 $password = $_SERVER['PHP_AUTH_PW'];
197 // allow "user@server" login (but ignore 'server' part)
198 $at = strstr($user, "@", true);
203 // next code from mod/auth.php. needs better solution
207 'username' => trim($user),
208 'password' => trim($password),
209 'authenticated' => 0,
210 'user_record' => null,
214 * A plugin indicates successful login by setting 'authenticated' to non-zero value and returning a user record
215 * Plugins should never set 'authenticated' except to indicate success - as hooks may be chained
216 * and later plugins should not interfere with an earlier one that succeeded.
218 call_hooks('authenticate', $addon_auth);
220 if ($addon_auth['authenticated'] && count($addon_auth['user_record'])) {
221 $record = $addon_auth['user_record'];
223 $user_id = User::authenticate(trim($user), trim($password));
225 $record = dba::selectFirst('user', [], ['uid' => $user_id]);
229 if (!$record || !count($record)) {
230 logger('API_login failure: ' . print_r($_SERVER, true), LOGGER_DEBUG);
231 header('WWW-Authenticate: Basic realm="Friendica"');
232 //header('HTTP/1.0 401 Unauthorized');
233 //die('This api requires login');
234 throw new UnauthorizedException("This API requires login");
237 authenticate_success($record);
239 $_SESSION["allow_api"] = true;
241 call_hooks('logged_in', $a->user);
245 * API endpoints can define which HTTP method to accept when called.
246 * This function check the current HTTP method agains endpoint
249 * @brief Check HTTP method of called API
251 * @param string $method Required methods, uppercase, separated by comma
254 function api_check_method($method)
256 if ($method == "*") {
259 return (strpos($method, $_SERVER['REQUEST_METHOD']) !== false);
263 * Authenticate user, call registered API function, set HTTP headers
265 * @brief Main API entry point
267 * @param object $a App
268 * @return string API call result
270 function api_call(App $a)
272 global $API, $called_api;
275 if (strpos($a->query_string, ".xml") > 0) {
278 if (strpos($a->query_string, ".json") > 0) {
281 if (strpos($a->query_string, ".rss") > 0) {
284 if (strpos($a->query_string, ".atom") > 0) {
289 foreach ($API as $p => $info) {
290 if (strpos($a->query_string, $p) === 0) {
291 if (!api_check_method($info['method'])) {
292 throw new MethodNotAllowedException();
295 $called_api = explode("/", $p);
296 //unset($_SERVER['PHP_AUTH_USER']);
298 /// @TODO should be "true ==[=] $info['auth']", if you miss only one = character, you assign a variable (only with ==). Let's make all this even.
299 if ($info['auth'] === true && api_user() === false) {
303 logger('API call for ' . $a->user['username'] . ': ' . $a->query_string);
304 logger('API parameters: ' . print_r($_REQUEST, true));
306 $stamp = microtime(true);
307 $return = call_user_func($info['func'], $type);
308 $duration = (float) (microtime(true) - $stamp);
309 logger("API call duration: " . round($duration, 2) . "\t" . $a->query_string, LOGGER_DEBUG);
311 if (Config::get("system", "profiler")) {
312 $duration = microtime(true)-$a->performance["start"];
314 /// @TODO round() really everywhere?
316 parse_url($a->query_string, PHP_URL_PATH) . ": " . sprintf(
317 "Database: %s/%s, Network: %s, I/O: %s, Other: %s, Total: %s",
318 round($a->performance["database"] - $a->performance["database_write"], 3),
319 round($a->performance["database_write"], 3),
320 round($a->performance["network"], 2),
321 round($a->performance["file"], 2),
322 round($duration - ($a->performance["database"] + $a->performance["network"] + $a->performance["file"]), 2),
328 if (Config::get("rendertime", "callstack")) {
329 $o = "Database Read:\n";
330 foreach ($a->callstack["database"] as $func => $time) {
331 $time = round($time, 3);
333 $o .= $func . ": " . $time . "\n";
336 $o .= "\nDatabase Write:\n";
337 foreach ($a->callstack["database_write"] as $func => $time) {
338 $time = round($time, 3);
340 $o .= $func . ": " . $time . "\n";
344 $o .= "\nNetwork:\n";
345 foreach ($a->callstack["network"] as $func => $time) {
346 $time = round($time, 3);
348 $o .= $func . ": " . $time . "\n";
351 logger($o, LOGGER_DEBUG);
355 if (false === $return) {
357 * api function returned false withour throw an
358 * exception. This should not happend, throw a 500
360 throw new InternalServerErrorException();
365 header("Content-Type: text/xml");
368 header("Content-Type: application/json");
369 foreach ($return as $rr) {
370 $json = json_encode($rr);
372 if (x($_GET, 'callback')) {
373 $json = $_GET['callback'] . "(" . $json . ")";
378 header("Content-Type: application/rss+xml");
379 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
382 header("Content-Type: application/atom+xml");
383 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
390 logger('API call not implemented: ' . $a->query_string);
391 throw new NotImplementedException();
392 } catch (HTTPException $e) {
393 header("HTTP/1.1 {$e->httpcode} {$e->httpdesc}");
394 return api_error($type, $e);
399 * @brief Format API error string
401 * @param string $type Return type (xml, json, rss, as)
402 * @param object $e HTTPException Error object
403 * @return string error message formatted as $type
405 function api_error($type, $e)
409 $error = ($e->getMessage() !== "" ? $e->getMessage() : $e->httpdesc);
410 /// @TODO: https://dev.twitter.com/overview/api/response-codes
412 $error = array("error" => $error,
413 "code" => $e->httpcode . " " . $e->httpdesc,
414 "request" => $a->query_string);
416 $return = api_format_data('status', $type, array('status' => $error));
420 header("Content-Type: text/xml");
423 header("Content-Type: application/json");
424 $return = json_encode($return);
427 header("Content-Type: application/rss+xml");
430 header("Content-Type: application/atom+xml");
438 * @brief Set values for RSS template
441 * @param array $arr Array to be passed to template
442 * @param array $user_info User info
444 * @todo find proper type-hints
446 function api_rss_extra(App $a, $arr, $user_info)
448 if (is_null($user_info)) {
449 $user_info = api_get_user($a);
452 $arr['$user'] = $user_info;
453 $arr['$rss'] = array(
454 'alternate' => $user_info['url'],
455 'self' => System::baseUrl() . "/" . $a->query_string,
456 'base' => System::baseUrl(),
457 'updated' => api_date(null),
458 'atom_updated' => datetime_convert('UTC', 'UTC', 'now', ATOM_TIME),
459 'language' => $user_info['language'],
460 'logo' => System::baseUrl() . "/images/friendica-32.png",
468 * @brief Unique contact to contact url.
470 * @param int $id Contact id
471 * @return bool|string
472 * Contact url or False if contact id is unknown
474 function api_unique_id_to_nurl($id)
476 $r = dba::selectFirst('contact', array('nurl'), array('uid' => 0, 'id' => $id));
478 if (DBM::is_result($r)) {
486 * @brief Get user info array.
488 * @param object $a App
489 * @param int|string $contact_id Contact ID or URL
491 function api_get_user(App $a, $contact_id = null)
499 logger("api_get_user: Fetching user data for user ".$contact_id, LOGGER_DEBUG);
501 // Searching for contact URL
502 if (!is_null($contact_id) && (intval($contact_id) == 0)) {
503 $user = dbesc(normalise_link($contact_id));
505 $extra_query = "AND `contact`.`nurl` = '%s' ";
506 if (api_user() !== false) {
507 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
511 // Searching for contact id with uid = 0
512 if (!is_null($contact_id) && (intval($contact_id) != 0)) {
513 $user = dbesc(api_unique_id_to_nurl($contact_id));
516 throw new BadRequestException("User not found.");
520 $extra_query = "AND `contact`.`nurl` = '%s' ";
521 if (api_user() !== false) {
522 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
526 if (is_null($user) && x($_GET, 'user_id')) {
527 $user = dbesc(api_unique_id_to_nurl($_GET['user_id']));
530 throw new BadRequestException("User not found.");
534 $extra_query = "AND `contact`.`nurl` = '%s' ";
535 if (api_user() !== false) {
536 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
539 if (is_null($user) && x($_GET, 'screen_name')) {
540 $user = dbesc($_GET['screen_name']);
541 $extra_query = "AND `contact`.`nick` = '%s' ";
542 if (api_user() !== false) {
543 $extra_query .= "AND `contact`.`uid`=".intval(api_user());
547 if (is_null($user) && x($_GET, 'profileurl')) {
548 $user = dbesc(normalise_link($_GET['profileurl']));
549 $extra_query = "AND `contact`.`nurl` = '%s' ";
550 if (api_user() !== false) {
551 $extra_query .= "AND `contact`.`uid`=".intval(api_user());
555 if (is_null($user) && ($a->argc > (count($called_api) - 1)) && (count($called_api) > 0)) {
556 $argid = count($called_api);
557 list($user, $null) = explode(".", $a->argv[$argid]);
558 if (is_numeric($user)) {
559 $user = dbesc(api_unique_id_to_nurl($user));
566 $extra_query = "AND `contact`.`nurl` = '%s' ";
567 if (api_user() !== false) {
568 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
571 $user = dbesc($user);
572 $extra_query = "AND `contact`.`nick` = '%s' ";
573 if (api_user() !== false) {
574 $extra_query .= "AND `contact`.`uid`=" . intval(api_user());
579 logger("api_get_user: user ".$user, LOGGER_DEBUG);
582 if (api_user() === false) {
586 $user = $_SESSION['uid'];
587 $extra_query = "AND `contact`.`uid` = %d AND `contact`.`self` ";
591 logger('api_user: ' . $extra_query . ', user: ' . $user);
595 "SELECT *, `contact`.`id` AS `cid` FROM `contact`
601 // Selecting the id by priority, friendica first
602 api_best_nickname($uinfo);
604 // if the contact wasn't found, fetch it from the contacts with uid = 0
605 if (!DBM::is_result($uinfo)) {
609 $r = q("SELECT * FROM `contact` WHERE `uid` = 0 AND `nurl` = '%s' LIMIT 1", dbesc(normalise_link($url)));
612 if (DBM::is_result($r)) {
613 $network_name = ContactSelector::networkToName($r[0]['network'], $r[0]['url']);
615 // If no nick where given, extract it from the address
616 if (($r[0]['nick'] == "") || ($r[0]['name'] == $r[0]['nick'])) {
617 $r[0]['nick'] = api_get_nick($r[0]["url"]);
622 'id_str' => (string) $r[0]["id"],
623 'name' => $r[0]["name"],
624 'screen_name' => (($r[0]['nick']) ? $r[0]['nick'] : $r[0]['name']),
625 'location' => ($r[0]["location"] != "") ? $r[0]["location"] : $network_name,
626 'description' => $r[0]["about"],
627 'profile_image_url' => $r[0]["micro"],
628 'profile_image_url_https' => $r[0]["micro"],
629 'url' => $r[0]["url"],
630 'protected' => false,
631 'followers_count' => 0,
632 'friends_count' => 0,
634 'created_at' => api_date($r[0]["created"]),
635 'favourites_count' => 0,
637 'time_zone' => 'UTC',
638 'geo_enabled' => false,
640 'statuses_count' => 0,
642 'contributors_enabled' => false,
643 'is_translator' => false,
644 'is_translation_enabled' => false,
645 'following' => false,
646 'follow_request_sent' => false,
647 'statusnet_blocking' => false,
648 'notifications' => false,
649 'statusnet_profile_url' => $r[0]["url"],
651 'cid' => Contact::getIdForURL($r[0]["url"], api_user(), true),
653 'network' => $r[0]["network"],
658 throw new BadRequestException("User not found.");
662 if ($uinfo[0]['self']) {
663 if ($uinfo[0]['network'] == "") {
664 $uinfo[0]['network'] = NETWORK_DFRN;
668 "SELECT * FROM `user` WHERE `uid` = %d LIMIT 1",
672 "SELECT * FROM `profile` WHERE `uid` = %d AND `is-default` = 1 LIMIT 1",
676 /// @TODO old-lost code? (twice)
677 // Counting is deactivated by now, due to performance issues
678 // count public wall messages
679 //$r = q("SELECT COUNT(*) as `count` FROM `item` WHERE `uid` = %d AND `wall`",
680 // intval($uinfo[0]['uid'])
682 //$countitms = $r[0]['count'];
685 // Counting is deactivated by now, due to performance issues
686 //$r = q("SELECT count(*) as `count` FROM `item`
687 // WHERE `contact-id` = %d",
688 // intval($uinfo[0]['id'])
690 //$countitms = $r[0]['count'];
694 /// @TODO old-lost code? (twice)
696 // Counting is deactivated by now, due to performance issues
698 $r = q("SELECT count(*) as `count` FROM `contact`
699 WHERE `uid` = %d AND `rel` IN ( %d, %d )
700 AND `self`=0 AND NOT `blocked` AND NOT `pending` AND `hidden`=0",
701 intval($uinfo[0]['uid']),
702 intval(CONTACT_IS_SHARING),
703 intval(CONTACT_IS_FRIEND)
705 $countfriends = $r[0]['count'];
707 $r = q("SELECT count(*) as `count` FROM `contact`
708 WHERE `uid` = %d AND `rel` IN ( %d, %d )
709 AND `self`=0 AND NOT `blocked` AND NOT `pending` AND `hidden`=0",
710 intval($uinfo[0]['uid']),
711 intval(CONTACT_IS_FOLLOWER),
712 intval(CONTACT_IS_FRIEND)
714 $countfollowers = $r[0]['count'];
716 $r = q("SELECT count(*) as `count` FROM item where starred = 1 and uid = %d and deleted = 0",
717 intval($uinfo[0]['uid'])
719 $starred = $r[0]['count'];
722 if (! $uinfo[0]['self']) {
732 // Add a nick if it isn't present there
733 if (($uinfo[0]['nick'] == "") || ($uinfo[0]['name'] == $uinfo[0]['nick'])) {
734 $uinfo[0]['nick'] = api_get_nick($uinfo[0]["url"]);
737 $network_name = ContactSelector::networkToName($uinfo[0]['network'], $uinfo[0]['url']);
739 $pcontact_id = Contact::getIdForURL($uinfo[0]['url'], 0, true);
741 if (!empty($profile[0]['about'])) {
742 $description = $profile[0]['about'];
744 $description = $uinfo[0]["about"];
747 if (!empty($usr[0]['default-location'])) {
748 $location = $usr[0]['default-location'];
749 } elseif (!empty($uinfo[0]["location"])) {
750 $location = $uinfo[0]["location"];
752 $location = $network_name;
756 'id' => intval($pcontact_id),
757 'id_str' => (string) intval($pcontact_id),
758 'name' => (($uinfo[0]['name']) ? $uinfo[0]['name'] : $uinfo[0]['nick']),
759 'screen_name' => (($uinfo[0]['nick']) ? $uinfo[0]['nick'] : $uinfo[0]['name']),
760 'location' => $location,
761 'description' => $description,
762 'profile_image_url' => $uinfo[0]['micro'],
763 'profile_image_url_https' => $uinfo[0]['micro'],
764 'url' => $uinfo[0]['url'],
765 'protected' => false,
766 'followers_count' => intval($countfollowers),
767 'friends_count' => intval($countfriends),
769 'created_at' => api_date($uinfo[0]['created']),
770 'favourites_count' => intval($starred),
772 'time_zone' => 'UTC',
773 'geo_enabled' => false,
775 'statuses_count' => intval($countitms),
777 'contributors_enabled' => false,
778 'is_translator' => false,
779 'is_translation_enabled' => false,
780 'following' => (($uinfo[0]['rel'] == CONTACT_IS_FOLLOWER) || ($uinfo[0]['rel'] == CONTACT_IS_FRIEND)),
781 'follow_request_sent' => false,
782 'statusnet_blocking' => false,
783 'notifications' => false,
785 //'statusnet_profile_url' => System::baseUrl()."/contacts/".$uinfo[0]['cid'],
786 'statusnet_profile_url' => $uinfo[0]['url'],
787 'uid' => intval($uinfo[0]['uid']),
788 'cid' => intval($uinfo[0]['cid']),
789 'self' => $uinfo[0]['self'],
790 'network' => $uinfo[0]['network'],
793 // If this is a local user and it uses Frio, we can get its color preferences.
795 $theme_info = dba::selectFirst('user', ['theme'], ['uid' => $ret['uid']]);
796 if ($theme_info['theme'] === 'frio') {
797 $schema = PConfig::get($ret['uid'], 'frio', 'schema');
798 if ($schema && ($schema != '---')) {
799 if (file_exists('view/theme/frio/schema/'.$schema.'.php')) {
800 $schemefile = 'view/theme/frio/schema/'.$schema.'.php';
801 require_once $schemefile;
804 $nav_bg = PConfig::get($ret['uid'], 'frio', 'nav_bg');
805 $link_color = PConfig::get($ret['uid'], 'frio', 'link_color');
806 $bgcolor = PConfig::get($ret['uid'], 'frio', 'background_color');
812 $link_color = "#6fdbe8";
815 $bgcolor = "#ededed";
818 $ret['profile_sidebar_fill_color'] = str_replace('#', '', $nav_bg);
819 $ret['profile_link_color'] = str_replace('#', '', $link_color);
820 $ret['profile_background_color'] = str_replace('#', '', $bgcolor);
828 * @brief return api-formatted array for item's author and owner
830 * @param object $a App
831 * @param array $item item from db
832 * @return array(array:author, array:owner)
834 function api_item_get_user(App $a, $item)
836 $status_user = api_get_user($a, $item["author-link"]);
838 $status_user["protected"] = (($item["allow_cid"] != "") ||
839 ($item["allow_gid"] != "") ||
840 ($item["deny_cid"] != "") ||
841 ($item["deny_gid"] != "") ||
844 if ($item['thr-parent'] == $item['uri']) {
845 $owner_user = api_get_user($a, $item["owner-link"]);
847 $owner_user = $status_user;
850 return (array($status_user, $owner_user));
854 * @brief walks recursively through an array with the possibility to change value and key
856 * @param array $array The array to walk through
857 * @param string $callback The callback function
859 * @return array the transformed array
861 function api_walk_recursive(array &$array, callable $callback)
863 $new_array = array();
865 foreach ($array as $k => $v) {
867 if ($callback($v, $k)) {
868 $new_array[$k] = api_walk_recursive($v, $callback);
871 if ($callback($v, $k)) {
882 * @brief Callback function to transform the array in an array that can be transformed in a XML file
884 * @param mixed $item Array item value
885 * @param string $key Array key
887 * @return boolean Should the array item be deleted?
889 function api_reformat_xml(&$item, &$key)
891 if (is_bool($item)) {
892 $item = ($item ? "true" : "false");
895 if (substr($key, 0, 10) == "statusnet_") {
896 $key = "statusnet:".substr($key, 10);
897 } elseif (substr($key, 0, 10) == "friendica_") {
898 $key = "friendica:".substr($key, 10);
900 /// @TODO old-lost code?
902 // $key = "default:".$key;
908 * @brief Creates the XML from a JSON style array
910 * @param array $data JSON style array
911 * @param string $root_element Name of the root element
913 * @return string The XML data
915 function api_create_xml($data, $root_element)
917 $childname = key($data);
918 $data2 = array_pop($data);
921 $namespaces = array("" => "http://api.twitter.com",
922 "statusnet" => "http://status.net/schema/api/1/",
923 "friendica" => "http://friendi.ca/schema/api/1/",
924 "georss" => "http://www.georss.org/georss");
926 /// @todo Auto detection of needed namespaces
927 if (in_array($root_element, array("ok", "hash", "config", "version", "ids", "notes", "photos"))) {
928 $namespaces = array();
931 if (is_array($data2)) {
932 api_walk_recursive($data2, "api_reformat_xml");
939 foreach ($data2 as $item) {
940 $data4[$i++.":".$childname] = $item;
946 $data3 = array($root_element => $data2);
948 $ret = XML::fromArray($data3, $xml, false, $namespaces);
953 * @brief Formats the data according to the data type
955 * @param string $root_element Name of the root element
956 * @param string $type Return type (atom, rss, xml, json)
957 * @param array $data JSON style array
959 * @return (string|object|array) XML data or JSON data
961 function api_format_data($root_element, $type, $data)
967 $ret = api_create_xml($data, $root_element);
982 * Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful;
983 * returns a 401 status code and an error message if not.
984 * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-account-verify_credentials
986 * @param string $type Return type (atom, rss, xml, json)
988 function api_account_verify_credentials($type)
993 if (api_user() === false) {
994 throw new ForbiddenException();
997 unset($_REQUEST["user_id"]);
998 unset($_GET["user_id"]);
1000 unset($_REQUEST["screen_name"]);
1001 unset($_GET["screen_name"]);
1003 $skip_status = (x($_REQUEST, 'skip_status')?$_REQUEST['skip_status'] : false);
1005 $user_info = api_get_user($a);
1007 // "verified" isn't used here in the standard
1008 unset($user_info["verified"]);
1010 // - Adding last status
1011 if (!$skip_status) {
1012 $user_info["status"] = api_status_show("raw");
1013 if (!count($user_info["status"])) {
1014 unset($user_info["status"]);
1016 unset($user_info["status"]["user"]);
1020 // "uid" and "self" are only needed for some internal stuff, so remove it from here
1021 unset($user_info["uid"]);
1022 unset($user_info["self"]);
1024 return api_format_data("user", $type, array('user' => $user_info));
1027 /// @TODO move to top of file or somewhere better
1028 api_register_func('api/account/verify_credentials', 'api_account_verify_credentials', true);
1031 * Get data from $_POST or $_GET
1035 function requestdata($k)
1037 if (x($_POST, $k)) {
1047 * Waitman Gobble Mod
1049 * @param string $type Return type (atom, rss, xml, json)
1051 * @return array|string
1053 function api_statuses_mediap($type)
1057 if (api_user() === false) {
1058 logger('api_statuses_update: no user');
1059 throw new ForbiddenException();
1061 $user_info = api_get_user($a);
1063 $_REQUEST['type'] = 'wall';
1064 $_REQUEST['profile_uid'] = api_user();
1065 $_REQUEST['api_source'] = true;
1066 $txt = requestdata('status');
1067 /// @TODO old-lost code?
1068 //$txt = urldecode(requestdata('status'));
1070 if ((strpos($txt, '<') !== false) || (strpos($txt, '>') !== false)) {
1071 $txt = html2bb_video($txt);
1072 $config = HTMLPurifier_Config::createDefault();
1073 $config->set('Cache.DefinitionImpl', null);
1074 $purifier = new HTMLPurifier($config);
1075 $txt = $purifier->purify($txt);
1077 $txt = html2bbcode($txt);
1079 $a->argv[1]=$user_info['screen_name']; //should be set to username?
1081 // tell wall_upload function to return img info instead of echo
1082 $_REQUEST['hush'] = 'yeah';
1083 $bebop = wall_upload_post($a);
1085 // now that we have the img url in bbcode we can add it to the status and insert the wall item.
1086 $_REQUEST['body'] = $txt . "\n\n" . $bebop;
1089 // this should output the last post (the one we just posted).
1090 return api_status_show($type);
1093 /// @TODO move this to top of file or somewhere better!
1094 api_register_func('api/statuses/mediap', 'api_statuses_mediap', true, API_METHOD_POST);
1097 * Updates the user’s current status.
1099 * @param string $type Return type (atom, rss, xml, json)
1101 * @return array|string
1102 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-update
1104 function api_statuses_update($type)
1109 if (api_user() === false) {
1110 logger('api_statuses_update: no user');
1111 throw new ForbiddenException();
1116 // convert $_POST array items to the form we use for web posts.
1117 if (requestdata('htmlstatus')) {
1118 $txt = requestdata('htmlstatus');
1119 if ((strpos($txt, '<') !== false) || (strpos($txt, '>') !== false)) {
1120 $txt = html2bb_video($txt);
1122 $config = HTMLPurifier_Config::createDefault();
1123 $config->set('Cache.DefinitionImpl', null);
1125 $purifier = new HTMLPurifier($config);
1126 $txt = $purifier->purify($txt);
1128 $_REQUEST['body'] = html2bbcode($txt);
1131 $_REQUEST['body'] = requestdata('status');
1134 $_REQUEST['title'] = requestdata('title');
1136 $parent = requestdata('in_reply_to_status_id');
1138 // Twidere sends "-1" if it is no reply ...
1139 if ($parent == -1) {
1143 if (ctype_digit($parent)) {
1144 $_REQUEST['parent'] = $parent;
1146 $_REQUEST['parent_uri'] = $parent;
1149 if (requestdata('lat') && requestdata('long')) {
1150 $_REQUEST['coord'] = sprintf("%s %s", requestdata('lat'), requestdata('long'));
1152 $_REQUEST['profile_uid'] = api_user();
1155 $_REQUEST['type'] = 'net-comment';
1157 // Check for throttling (maximum posts per day, week and month)
1158 $throttle_day = Config::get('system', 'throttle_limit_day');
1159 if ($throttle_day > 0) {
1160 $datefrom = date("Y-m-d H:i:s", time() - 24*60*60);
1163 "SELECT COUNT(*) AS `posts_day` FROM `item` WHERE `uid`=%d AND `wall`
1164 AND `created` > '%s' AND `id` = `parent`",
1169 if (DBM::is_result($r)) {
1170 $posts_day = $r[0]["posts_day"];
1175 if ($posts_day > $throttle_day) {
1176 logger('Daily posting limit reached for user '.api_user(), LOGGER_DEBUG);
1177 // die(api_error($type, sprintf(t("Daily posting limit of %d posts reached. The post was rejected."), $throttle_day)));
1178 throw new TooManyRequestsException(sprintf(t("Daily posting limit of %d posts reached. The post was rejected."), $throttle_day));
1182 $throttle_week = Config::get('system', 'throttle_limit_week');
1183 if ($throttle_week > 0) {
1184 $datefrom = date("Y-m-d H:i:s", time() - 24*60*60*7);
1187 "SELECT COUNT(*) AS `posts_week` FROM `item` WHERE `uid`=%d AND `wall`
1188 AND `created` > '%s' AND `id` = `parent`",
1193 if (DBM::is_result($r)) {
1194 $posts_week = $r[0]["posts_week"];
1199 if ($posts_week > $throttle_week) {
1200 logger('Weekly posting limit reached for user '.api_user(), LOGGER_DEBUG);
1201 // die(api_error($type, sprintf(t("Weekly posting limit of %d posts reached. The post was rejected."), $throttle_week)));
1202 throw new TooManyRequestsException(sprintf(t("Weekly posting limit of %d posts reached. The post was rejected."), $throttle_week));
1206 $throttle_month = Config::get('system', 'throttle_limit_month');
1207 if ($throttle_month > 0) {
1208 $datefrom = date("Y-m-d H:i:s", time() - 24*60*60*30);
1211 "SELECT COUNT(*) AS `posts_month` FROM `item` WHERE `uid`=%d AND `wall`
1212 AND `created` > '%s' AND `id` = `parent`",
1217 if (DBM::is_result($r)) {
1218 $posts_month = $r[0]["posts_month"];
1223 if ($posts_month > $throttle_month) {
1224 logger('Monthly posting limit reached for user '.api_user(), LOGGER_DEBUG);
1225 // die(api_error($type, sprintf(t("Monthly posting limit of %d posts reached. The post was rejected."), $throttle_month)));
1226 throw new TooManyRequestsException(sprintf(t("Monthly posting limit of %d posts reached. The post was rejected."), $throttle_month));
1230 $_REQUEST['type'] = 'wall';
1233 if (x($_FILES, 'media')) {
1234 // upload the image if we have one
1235 $_REQUEST['hush'] = 'yeah'; //tell wall_upload function to return img info instead of echo
1236 $media = wall_upload_post($a);
1237 if (strlen($media) > 0) {
1238 $_REQUEST['body'] .= "\n\n" . $media;
1242 // To-Do: Multiple IDs
1243 if (requestdata('media_ids')) {
1245 "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",
1246 intval(requestdata('media_ids')),
1249 if (DBM::is_result($r)) {
1250 $phototypes = Image::supportedTypes();
1251 $ext = $phototypes[$r[0]['type']];
1252 $_REQUEST['body'] .= "\n\n" . '[url=' . System::baseUrl() . '/photos/' . $r[0]['nickname'] . '/image/' . $r[0]['resource-id'] . ']';
1253 $_REQUEST['body'] .= '[img]' . System::baseUrl() . '/photo/' . $r[0]['resource-id'] . '-' . $r[0]['scale'] . '.' . $ext . '[/img][/url]';
1257 // set this so that the item_post() function is quiet and doesn't redirect or emit json
1259 $_REQUEST['api_source'] = true;
1261 if (!x($_REQUEST, "source")) {
1262 $_REQUEST["source"] = api_source();
1265 // call out normal post function
1268 // this should output the last post (the one we just posted).
1269 return api_status_show($type);
1272 /// @TODO move to top of file or somewhere better
1273 api_register_func('api/statuses/update', 'api_statuses_update', true, API_METHOD_POST);
1274 api_register_func('api/statuses/update_with_media', 'api_statuses_update', true, API_METHOD_POST);
1277 * Uploads an image to Friendica.
1280 * @see https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload
1282 function api_media_upload()
1286 if (api_user() === false) {
1288 throw new ForbiddenException();
1293 if (!x($_FILES, 'media')) {
1295 throw new BadRequestException("No media.");
1298 $media = wall_upload_post($a, false);
1301 throw new InternalServerErrorException();
1304 $returndata = array();
1305 $returndata["media_id"] = $media["id"];
1306 $returndata["media_id_string"] = (string)$media["id"];
1307 $returndata["size"] = $media["size"];
1308 $returndata["image"] = array("w" => $media["width"],
1309 "h" => $media["height"],
1310 "image_type" => $media["type"]);
1312 logger("Media uploaded: " . print_r($returndata, true), LOGGER_DEBUG);
1314 return array("media" => $returndata);
1317 /// @TODO move to top of file or somewhere better
1318 api_register_func('api/media/upload', 'api_media_upload', true, API_METHOD_POST);
1322 * @param string $type Return type (atom, rss, xml, json)
1324 * @return array|string
1326 function api_status_show($type)
1330 $user_info = api_get_user($a);
1332 logger('api_status_show: user_info: '.print_r($user_info, true), LOGGER_DEBUG);
1334 if ($type == "raw") {
1335 $privacy_sql = "AND `item`.`allow_cid`='' AND `item`.`allow_gid`='' AND `item`.`deny_cid`='' AND `item`.`deny_gid`=''";
1340 // get last public wall message
1344 WHERE `item`.`contact-id` = %d AND `item`.`uid` = %d
1345 AND ((`item`.`author-link` IN ('%s', '%s')) OR (`item`.`owner-link` IN ('%s', '%s')))
1346 AND `item`.`type` != 'activity' $privacy_sql
1347 ORDER BY `item`.`id` DESC
1349 intval($user_info['cid']),
1351 dbesc($user_info['url']),
1352 dbesc(normalise_link($user_info['url'])),
1353 dbesc($user_info['url']),
1354 dbesc(normalise_link($user_info['url']))
1357 if (DBM::is_result($lastwall)) {
1358 $lastwall = $lastwall[0];
1360 $in_reply_to = api_in_reply_to($lastwall);
1362 $converted = api_convert_item($lastwall);
1364 if ($type == "xml") {
1365 $geo = "georss:point";
1370 $status_info = array(
1371 'created_at' => api_date($lastwall['created']),
1372 'id' => intval($lastwall['id']),
1373 'id_str' => (string) $lastwall['id'],
1374 'text' => $converted["text"],
1375 'source' => (($lastwall['app']) ? $lastwall['app'] : 'web'),
1376 'truncated' => false,
1377 'in_reply_to_status_id' => $in_reply_to['status_id'],
1378 'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
1379 'in_reply_to_user_id' => $in_reply_to['user_id'],
1380 'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
1381 'in_reply_to_screen_name' => $in_reply_to['screen_name'],
1382 'user' => $user_info,
1384 'coordinates' => "",
1386 'contributors' => "",
1387 'is_quote_status' => false,
1388 'retweet_count' => 0,
1389 'favorite_count' => 0,
1390 'favorited' => $lastwall['starred'] ? true : false,
1391 'retweeted' => false,
1392 'possibly_sensitive' => false,
1394 'statusnet_html' => $converted["html"],
1395 'statusnet_conversation_id' => $lastwall['parent'],
1396 'external_url' => System::baseUrl() . "/display/" . $lastwall['guid'],
1399 if (count($converted["attachments"]) > 0) {
1400 $status_info["attachments"] = $converted["attachments"];
1403 if (count($converted["entities"]) > 0) {
1404 $status_info["entities"] = $converted["entities"];
1407 if (($lastwall['item_network'] != "") && ($status["source"] == 'web')) {
1408 $status_info["source"] = ContactSelector::networkToName($lastwall['item_network'], $user_info['url']);
1409 } elseif (($lastwall['item_network'] != "") && (ContactSelector::networkToName($lastwall['item_network'], $user_info['url']) != $status_info["source"])) {
1410 $status_info["source"] = trim($status_info["source"].' ('.ContactSelector::networkToName($lastwall['item_network'], $user_info['url']).')');
1413 // "uid" and "self" are only needed for some internal stuff, so remove it from here
1414 unset($status_info["user"]["uid"]);
1415 unset($status_info["user"]["self"]);
1418 logger('status_info: '.print_r($status_info, true), LOGGER_DEBUG);
1420 if ($type == "raw") {
1421 return $status_info;
1424 return api_format_data("statuses", $type, array('status' => $status_info));
1428 * Returns extended information of a given user, specified by ID or screen name as per the required id parameter.
1429 * The author's most recent status will be returned inline.
1431 * @param string $type Return type (atom, rss, xml, json)
1432 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-show
1434 function api_users_show($type)
1438 $user_info = api_get_user($a);
1442 INNER JOIN `contact` ON `contact`.`id`=`item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
1443 WHERE `item`.`uid` = %d AND `verb` = '%s' AND `item`.`contact-id` = %d
1444 AND ((`item`.`author-link` IN ('%s', '%s')) OR (`item`.`owner-link` IN ('%s', '%s')))
1445 AND `type`!='activity'
1446 AND `item`.`allow_cid`='' AND `item`.`allow_gid`='' AND `item`.`deny_cid`='' AND `item`.`deny_gid`=''
1450 dbesc(ACTIVITY_POST),
1451 intval($user_info['cid']),
1452 dbesc($user_info['url']),
1453 dbesc(normalise_link($user_info['url'])),
1454 dbesc($user_info['url']),
1455 dbesc(normalise_link($user_info['url']))
1458 if (DBM::is_result($lastwall)) {
1459 $lastwall = $lastwall[0];
1461 $in_reply_to = api_in_reply_to($lastwall);
1463 $converted = api_convert_item($lastwall);
1465 if ($type == "xml") {
1466 $geo = "georss:point";
1471 $user_info['status'] = array(
1472 'text' => $converted["text"],
1473 'truncated' => false,
1474 'created_at' => api_date($lastwall['created']),
1475 'in_reply_to_status_id' => $in_reply_to['status_id'],
1476 'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
1477 'source' => (($lastwall['app']) ? $lastwall['app'] : 'web'),
1478 'id' => intval($lastwall['contact-id']),
1479 'id_str' => (string) $lastwall['contact-id'],
1480 'in_reply_to_user_id' => $in_reply_to['user_id'],
1481 'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
1482 'in_reply_to_screen_name' => $in_reply_to['screen_name'],
1484 'favorited' => $lastwall['starred'] ? true : false,
1485 'statusnet_html' => $converted["html"],
1486 'statusnet_conversation_id' => $lastwall['parent'],
1487 'external_url' => System::baseUrl() . "/display/" . $lastwall['guid'],
1490 if (count($converted["attachments"]) > 0) {
1491 $user_info["status"]["attachments"] = $converted["attachments"];
1494 if (count($converted["entities"]) > 0) {
1495 $user_info["status"]["entities"] = $converted["entities"];
1498 if (($lastwall['item_network'] != "") && ($user_info["status"]["source"] == 'web')) {
1499 $user_info["status"]["source"] = ContactSelector::networkToName($lastwall['item_network'], $user_info['url']);
1502 if (($lastwall['item_network'] != "") && (ContactSelector::networkToName($lastwall['item_network'], $user_info['url']) != $user_info["status"]["source"])) {
1503 $user_info["status"]["source"] = trim($user_info["status"]["source"] . ' (' . ContactSelector::networkToName($lastwall['item_network'], $user_info['url']) . ')');
1507 // "uid" and "self" are only needed for some internal stuff, so remove it from here
1508 unset($user_info["uid"]);
1509 unset($user_info["self"]);
1511 return api_format_data("user", $type, array('user' => $user_info));
1514 /// @TODO move to top of file or somewhere better
1515 api_register_func('api/users/show', 'api_users_show');
1516 api_register_func('api/externalprofile/show', 'api_users_show');
1519 * Search a public user account.
1521 * @param string $type Return type (atom, rss, xml, json)
1523 * @return array|string
1524 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-search
1526 function api_users_search($type)
1530 $userlist = array();
1532 if (x($_GET, 'q')) {
1533 $r = q("SELECT id FROM `contact` WHERE `uid` = 0 AND `name` = '%s'", dbesc($_GET["q"]));
1535 if (!DBM::is_result($r)) {
1536 $r = q("SELECT `id` FROM `contact` WHERE `uid` = 0 AND `nick` = '%s'", dbesc($_GET["q"]));
1539 if (DBM::is_result($r)) {
1541 foreach ($r as $user) {
1542 $user_info = api_get_user($a, $user["id"]);
1544 if ($type == "xml") {
1545 $userlist[$k++.":user"] = $user_info;
1547 $userlist[] = $user_info;
1550 $userlist = array("users" => $userlist);
1552 throw new BadRequestException("User not found.");
1555 throw new BadRequestException("User not found.");
1558 return api_format_data("users", $type, $userlist);
1561 /// @TODO move to top of file or somewhere better
1562 api_register_func('api/users/search', 'api_users_search');
1565 * Return user objects
1567 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-lookup
1569 * @param string $type Return format: json or xml
1571 * @return array|string
1572 * @throws NotFoundException if the results are empty.
1574 function api_users_lookup($type)
1578 if (x($_REQUEST['user_id'])) {
1579 foreach (explode(',', $_REQUEST['user_id']) as $id) {
1581 $users[] = api_get_user(get_app(), $id);
1586 if (empty($users)) {
1587 throw new NotFoundException;
1590 return api_format_data("users", $type, array('users' => $users));
1593 /// @TODO move to top of file or somewhere better
1594 api_register_func('api/users/lookup', 'api_users_lookup', true);
1597 * Returns statuses that match a specified query.
1599 * @see https://developer.twitter.com/en/docs/tweets/search/api-reference/get-search-tweets
1601 * @param string $type Return format: json, xml, atom, rss
1603 * @return array|string
1604 * @throws BadRequestException if the "q" parameter is missing.
1606 function api_search($type)
1610 if (!x($_REQUEST, 'q')) {
1611 throw new BadRequestException("q parameter is required.");
1614 if (x($_REQUEST, 'rpp')) {
1615 $count = $_REQUEST['rpp'];
1616 } elseif (x($_REQUEST, 'count')) {
1617 $count = $_REQUEST['count'];
1622 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
1623 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
1624 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] - 1 : 0);
1626 $start = $page * $count;
1629 $sql_extra .= ' AND `item`.`id` <= ' . intval($max_id);
1633 "SELECT ".item_fieldlists()."
1634 FROM `item` ".item_joins()."
1635 WHERE ".item_condition()." AND (`item`.`uid` = 0 OR (`item`.`uid` = ? AND NOT `item`.`global`))
1636 AND `item`.`body` LIKE CONCAT('%',?,'%')
1639 ORDER BY `item`.`id` DESC LIMIT ".intval($start)." ,".intval($count)." ",
1645 $data['status'] = api_format_items(dba::inArray($r), api_get_user(get_app()));
1647 return api_format_data("statuses", $type, $data);
1650 /// @TODO move to top of file or somewhere better
1651 api_register_func('api/search/tweets', 'api_search', true);
1652 api_register_func('api/search', 'api_search', true);
1655 * Returns the most recent statuses posted by the user and the users they follow.
1657 * @see https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-home_timeline
1659 * @param string $type Return type (atom, rss, xml, json)
1661 * @todo Optional parameters
1662 * @todo Add reply info
1664 function api_statuses_home_timeline($type)
1668 if (api_user() === false) {
1669 throw new ForbiddenException();
1672 unset($_REQUEST["user_id"]);
1673 unset($_GET["user_id"]);
1675 unset($_REQUEST["screen_name"]);
1676 unset($_GET["screen_name"]);
1678 $user_info = api_get_user($a);
1679 // get last newtork messages
1682 $count = (x($_REQUEST, 'count') ? $_REQUEST['count'] : 20);
1683 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] - 1 : 0);
1687 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
1688 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
1689 //$since_id = 0;//$since_id = (x($_REQUEST, 'since_id')?$_REQUEST['since_id'] : 0);
1690 $exclude_replies = (x($_REQUEST, 'exclude_replies') ? 1 : 0);
1691 $conversation_id = (x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0);
1693 $start = $page * $count;
1697 $sql_extra .= ' AND `item`.`id` <= ' . intval($max_id);
1699 if ($exclude_replies > 0) {
1700 $sql_extra .= ' AND `item`.`parent` = `item`.`id`';
1702 if ($conversation_id > 0) {
1703 $sql_extra .= ' AND `item`.`parent` = ' . intval($conversation_id);
1707 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`,
1708 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
1709 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
1710 `contact`.`id` AS `cid`
1712 STRAIGHT_JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
1713 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
1714 WHERE `item`.`uid` = %d AND `verb` = '%s'
1715 AND `item`.`visible` AND NOT `item`.`moderated` AND NOT `item`.`deleted`
1718 ORDER BY `item`.`id` DESC LIMIT %d ,%d ",
1720 dbesc(ACTIVITY_POST),
1726 $ret = api_format_items($r, $user_info, false, $type);
1728 // Set all posts from the query above to seen
1730 foreach ($r as $item) {
1731 $idarray[] = intval($item["id"]);
1734 $idlist = implode(",", $idarray);
1736 if ($idlist != "") {
1737 $unseen = q("SELECT `id` FROM `item` WHERE `unseen` AND `id` IN (%s)", $idlist);
1740 q("UPDATE `item` SET `unseen` = 0 WHERE `unseen` AND `id` IN (%s)", $idlist);
1744 $data = array('status' => $ret);
1748 $data = api_rss_extra($a, $data, $user_info);
1752 return api_format_data("statuses", $type, $data);
1755 /// @TODO move to top of file or somewhere better
1756 api_register_func('api/statuses/home_timeline', 'api_statuses_home_timeline', true);
1757 api_register_func('api/statuses/friends_timeline', 'api_statuses_home_timeline', true);
1760 * Returns the most recent statuses from public users.
1762 * @param string $type Return type (atom, rss, xml, json)
1764 * @return array|string
1766 function api_statuses_public_timeline($type)
1770 if (api_user() === false) {
1771 throw new ForbiddenException();
1774 $user_info = api_get_user($a);
1775 // get last newtork messages
1778 $count = (x($_REQUEST, 'count') ? $_REQUEST['count'] : 20);
1779 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] -1 : 0);
1783 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
1784 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
1785 //$since_id = 0;//$since_id = (x($_REQUEST, 'since_id')?$_REQUEST['since_id'] : 0);
1786 $exclude_replies = (x($_REQUEST, 'exclude_replies') ? 1 : 0);
1787 $conversation_id = (x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0);
1789 $start = $page * $count;
1791 if ($exclude_replies && !$conversation_id) {
1793 $sql_extra = 'AND `thread`.`iid` <= ' . intval($max_id);
1797 "SELECT " . item_fieldlists() . "
1799 STRAIGHT_JOIN `item` ON `item`.`id` = `thread`.`iid`
1800 " . item_joins() . "
1801 STRAIGHT_JOIN `user` ON `user`.`uid` = `thread`.`uid`
1802 AND NOT `user`.`hidewall`
1804 AND NOT `thread`.`private`
1806 AND `thread`.`visible`
1807 AND NOT `thread`.`deleted`
1808 AND NOT `thread`.`moderated`
1809 AND `thread`.`iid` > ?
1811 ORDER BY `thread`.`iid` DESC
1812 LIMIT " . intval($start) . ", " . intval($count),
1817 $r = dba::inArray($r);
1820 $sql_extra = 'AND `item`.`id` <= ' . intval($max_id);
1822 if ($conversation_id > 0) {
1823 $sql_extra .= ' AND `item`.`parent` = ' . intval($conversation_id);
1827 "SELECT " . item_fieldlists() . "
1829 " . item_joins() . "
1830 STRAIGHT_JOIN `user` ON `user`.`uid` = `item`.`uid`
1831 AND NOT `user`.`hidewall`
1833 AND NOT `item`.`private`
1835 AND `item`.`visible`
1836 AND NOT `item`.`deleted`
1837 AND NOT `item`.`moderated`
1840 ORDER BY `item`.`id` DESC
1841 LIMIT " . intval($start) . ", " . intval($count),
1846 $r = dba::inArray($r);
1849 $ret = api_format_items($r, $user_info, false, $type);
1851 $data = array('status' => $ret);
1855 $data = api_rss_extra($a, $data, $user_info);
1859 return api_format_data("statuses", $type, $data);
1862 /// @TODO move to top of file or somewhere better
1863 api_register_func('api/statuses/public_timeline', 'api_statuses_public_timeline', true);
1866 * Returns the most recent statuses posted by users this node knows about.
1868 * @brief Returns the list of public federated posts this node knows about
1870 * @param string $type Return format: json, xml, atom, rss
1871 * @return array|string
1872 * @throws ForbiddenException
1874 function api_statuses_networkpublic_timeline($type)
1878 if (api_user() === false) {
1879 throw new ForbiddenException();
1882 $user_info = api_get_user($a);
1884 $since_id = x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0;
1885 $max_id = x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0;
1888 $count = x($_REQUEST, 'count') ? $_REQUEST['count'] : 20;
1889 $page = x($_REQUEST, 'page') ? $_REQUEST['page'] : 1;
1893 $start = ($page - 1) * $count;
1897 $sql_extra = 'AND `thread`.`iid` <= ' . intval($max_id);
1901 "SELECT " . item_fieldlists() . "
1903 STRAIGHT_JOIN `item` ON `item`.`id` = `thread`.`iid`
1904 " . item_joins() . "
1905 WHERE `thread`.`uid` = 0
1907 AND NOT `thread`.`private`
1908 AND `thread`.`visible`
1909 AND NOT `thread`.`deleted`
1910 AND NOT `thread`.`moderated`
1911 AND `thread`.`iid` > ?
1913 ORDER BY `thread`.`iid` DESC
1914 LIMIT " . intval($start) . ", " . intval($count),
1919 $r = dba::inArray($r);
1921 $ret = api_format_items($r, $user_info, false, $type);
1923 $data = array('status' => $ret);
1927 $data = api_rss_extra($a, $data, $user_info);
1931 return api_format_data("statuses", $type, $data);
1934 /// @TODO move to top of file or somewhere better
1935 api_register_func('api/statuses/networkpublic_timeline', 'api_statuses_networkpublic_timeline', true);
1938 * Returns a single status.
1940 * @param string $type Return type (atom, rss, xml, json)
1942 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-statuses-show-id
1944 function api_statuses_show($type)
1948 if (api_user() === false) {
1949 throw new ForbiddenException();
1952 $user_info = api_get_user($a);
1955 $id = intval($a->argv[3]);
1958 $id = intval($_REQUEST["id"]);
1963 $id = intval($a->argv[4]);
1966 logger('API: api_statuses_show: ' . $id);
1968 $conversation = (x($_REQUEST, 'conversation') ? 1 : 0);
1971 if ($conversation) {
1972 $sql_extra .= " AND `item`.`parent` = %d ORDER BY `id` ASC ";
1974 $sql_extra .= " AND `item`.`id` = %d";
1978 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`,
1979 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
1980 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
1981 `contact`.`id` AS `cid`
1983 INNER JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
1984 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
1985 WHERE `item`.`visible` AND NOT `item`.`moderated` AND NOT `item`.`deleted`
1986 AND `item`.`uid` = %d AND `item`.`verb` = '%s'
1989 dbesc(ACTIVITY_POST),
1993 /// @TODO How about copying this to above methods which don't check $r ?
1994 if (!DBM::is_result($r)) {
1995 throw new BadRequestException("There is no status with this id.");
1998 $ret = api_format_items($r, $user_info, false, $type);
2000 if ($conversation) {
2001 $data = array('status' => $ret);
2002 return api_format_data("statuses", $type, $data);
2004 $data = array('status' => $ret[0]);
2005 return api_format_data("status", $type, $data);
2009 /// @TODO move to top of file or somewhere better
2010 api_register_func('api/statuses/show', 'api_statuses_show', true);
2014 * @param string $type Return type (atom, rss, xml, json)
2016 * @todo nothing to say?
2018 function api_conversation_show($type)
2022 if (api_user() === false) {
2023 throw new ForbiddenException();
2026 $user_info = api_get_user($a);
2029 $id = intval($a->argv[3]);
2030 $count = (x($_REQUEST, 'count') ? $_REQUEST['count'] : 20);
2031 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] - 1 : 0);
2035 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
2036 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
2038 $start = $page*$count;
2041 $id = intval($_REQUEST["id"]);
2046 $id = intval($a->argv[4]);
2049 logger('API: api_conversation_show: '.$id);
2051 $r = q("SELECT `parent` FROM `item` WHERE `id` = %d", intval($id));
2052 if (DBM::is_result($r)) {
2053 $id = $r[0]["parent"];
2059 $sql_extra = ' AND `item`.`id` <= ' . intval($max_id);
2062 // Not sure why this query was so complicated. We should keep it here for a while,
2063 // just to make sure that we really don't need it.
2064 // FROM `item` INNER JOIN (SELECT `uri`,`parent` FROM `item` WHERE `id` = %d) AS `temp1`
2065 // ON (`item`.`thr-parent` = `temp1`.`uri` AND `item`.`parent` = `temp1`.`parent`)
2068 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`,
2069 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
2070 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
2071 `contact`.`id` AS `cid`
2073 STRAIGHT_JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
2074 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
2075 WHERE `item`.`parent` = %d AND `item`.`visible`
2076 AND NOT `item`.`moderated` AND NOT `item`.`deleted`
2077 AND `item`.`uid` = %d AND `item`.`verb` = '%s'
2078 AND `item`.`id`>%d $sql_extra
2079 ORDER BY `item`.`id` DESC LIMIT %d ,%d",
2082 dbesc(ACTIVITY_POST),
2088 if (!DBM::is_result($r)) {
2089 throw new BadRequestException("There is no status with this id.");
2092 $ret = api_format_items($r, $user_info, false, $type);
2094 $data = array('status' => $ret);
2095 return api_format_data("statuses", $type, $data);
2098 /// @TODO move to top of file or somewhere better
2099 api_register_func('api/conversation/show', 'api_conversation_show', true);
2100 api_register_func('api/statusnet/conversation', 'api_conversation_show', true);
2105 * @param string $type Return type (atom, rss, xml, json)
2107 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-retweet-id
2109 function api_statuses_repeat($type)
2115 if (api_user() === false) {
2116 throw new ForbiddenException();
2122 $id = intval($a->argv[3]);
2125 $id = intval($_REQUEST["id"]);
2130 $id = intval($a->argv[4]);
2133 logger('API: api_statuses_repeat: '.$id);
2136 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`, `contact`.`nick` as `reply_author`,
2137 `contact`.`name`, `contact`.`photo` as `reply_photo`, `contact`.`url` as `reply_url`, `contact`.`rel`,
2138 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
2139 `contact`.`id` AS `cid`
2141 INNER JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
2142 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
2143 WHERE `item`.`visible` AND NOT `item`.`moderated` AND NOT `item`.`deleted`
2144 AND NOT `item`.`private` AND `item`.`allow_cid` = '' AND `item`.`allow_gid` = ''
2145 AND `item`.`deny_cid` = '' AND `item`.`deny_gid` = ''
2147 AND `item`.`id`=%d",
2151 /// @TODO other style than above functions!
2152 if (DBM::is_result($r) && $r[0]['body'] != "") {
2153 if (strpos($r[0]['body'], "[/share]") !== false) {
2154 $pos = strpos($r[0]['body'], "[share");
2155 $post = substr($r[0]['body'], $pos);
2157 $post = share_header($r[0]['author-name'], $r[0]['author-link'], $r[0]['author-avatar'], $r[0]['guid'], $r[0]['created'], $r[0]['plink']);
2159 $post .= $r[0]['body'];
2160 $post .= "[/share]";
2162 $_REQUEST['body'] = $post;
2163 $_REQUEST['profile_uid'] = api_user();
2164 $_REQUEST['type'] = 'wall';
2165 $_REQUEST['api_source'] = true;
2167 if (!x($_REQUEST, "source")) {
2168 $_REQUEST["source"] = api_source();
2173 throw new ForbiddenException();
2176 // this should output the last post (the one we just posted).
2178 return api_status_show($type);
2181 /// @TODO move to top of file or somewhere better
2182 api_register_func('api/statuses/retweet', 'api_statuses_repeat', true, API_METHOD_POST);
2185 * Destroys a specific status.
2187 * @param string $type Return type (atom, rss, xml, json)
2189 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-destroy-id
2191 function api_statuses_destroy($type)
2195 if (api_user() === false) {
2196 throw new ForbiddenException();
2202 $id = intval($a->argv[3]);
2205 $id = intval($_REQUEST["id"]);
2210 $id = intval($a->argv[4]);
2213 logger('API: api_statuses_destroy: '.$id);
2215 $ret = api_statuses_show($type);
2217 drop_item($id, false);
2222 /// @TODO move to top of file or somewhere better
2223 api_register_func('api/statuses/destroy', 'api_statuses_destroy', true, API_METHOD_DELETE);
2226 * Returns the most recent mentions.
2228 * @param string $type Return type (atom, rss, xml, json)
2230 * @see http://developer.twitter.com/doc/get/statuses/mentions
2232 function api_statuses_mentions($type)
2236 if (api_user() === false) {
2237 throw new ForbiddenException();
2240 unset($_REQUEST["user_id"]);
2241 unset($_GET["user_id"]);
2243 unset($_REQUEST["screen_name"]);
2244 unset($_GET["screen_name"]);
2246 $user_info = api_get_user($a);
2247 // get last newtork messages
2251 $since_id = defaults($_REQUEST, 'since_id', 0);
2252 $max_id = defaults($_REQUEST, 'max_id' , 0);
2253 $count = defaults($_REQUEST, 'count' , 20);
2254 $page = defaults($_REQUEST, 'page' , 1);
2259 $start = ($page - 1) * $count;
2261 // Ugly code - should be changed
2262 $myurl = System::baseUrl() . '/profile/'. $a->user['nickname'];
2263 $myurl = substr($myurl, strpos($myurl, '://') + 3);
2264 $myurl = str_replace('www.', '', $myurl);
2267 $sql_extra = ' AND `item`.`id` <= ' . intval($max_id);
2271 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`,
2272 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
2273 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
2274 `contact`.`id` AS `cid`
2275 FROM `item` FORCE INDEX (`uid_id`)
2276 STRAIGHT_JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
2277 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
2278 WHERE `item`.`uid` = %d AND `verb` = '%s'
2279 AND NOT (`item`.`author-link` IN ('https://%s', 'http://%s'))
2280 AND `item`.`visible` AND NOT `item`.`moderated` AND NOT `item`.`deleted`
2281 AND `item`.`parent` IN (SELECT `iid` FROM `thread` WHERE `uid` = %d AND `mention` AND !`ignored`)
2284 ORDER BY `item`.`id` DESC LIMIT %d ,%d ",
2286 dbesc(ACTIVITY_POST),
2287 dbesc(protect_sprintf($myurl)),
2288 dbesc(protect_sprintf($myurl)),
2295 $ret = api_format_items($r, $user_info, false, $type);
2297 $data = array('status' => $ret);
2301 $data = api_rss_extra($a, $data, $user_info);
2305 return api_format_data("statuses", $type, $data);
2308 /// @TODO move to top of file or somewhere better
2309 api_register_func('api/statuses/mentions', 'api_statuses_mentions', true);
2310 api_register_func('api/statuses/replies', 'api_statuses_mentions', true);
2313 * Returns the most recent statuses posted by the user.
2315 * @brief Returns a user's public timeline
2317 * @param string $type Either "json" or "xml"
2318 * @return string|array
2319 * @throws ForbiddenException
2320 * @see https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-user_timeline
2322 function api_statuses_user_timeline($type)
2326 if (api_user() === false) {
2327 throw new ForbiddenException();
2330 $user_info = api_get_user($a);
2333 "api_statuses_user_timeline: api_user: ". api_user() .
2334 "\nuser_info: ".print_r($user_info, true) .
2335 "\n_REQUEST: ".print_r($_REQUEST, true),
2339 $since_id = x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0;
2340 $max_id = x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0;
2341 $exclude_replies = x($_REQUEST, 'exclude_replies') ? 1 : 0;
2342 $conversation_id = x($_REQUEST, 'conversation_id') ? $_REQUEST['conversation_id'] : 0;
2345 $count = x($_REQUEST, 'count') ? $_REQUEST['count'] : 20;
2346 $page = x($_REQUEST, 'page') ? $_REQUEST['page'] : 1;
2350 $start = ($page - 1) * $count;
2353 if ($user_info['self'] == 1) {
2354 $sql_extra .= " AND `item`.`wall` = 1 ";
2357 if ($exclude_replies > 0) {
2358 $sql_extra .= ' AND `item`.`parent` = `item`.`id`';
2361 if ($conversation_id > 0) {
2362 $sql_extra .= ' AND `item`.`parent` = ' . intval($conversation_id);
2366 $sql_extra .= ' AND `item`.`id` <= ' . intval($max_id);
2370 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`,
2371 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
2372 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
2373 `contact`.`id` AS `cid`
2374 FROM `item` FORCE INDEX (`uid_contactid_id`)
2375 STRAIGHT_JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
2376 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
2377 WHERE `item`.`uid` = %d AND `verb` = '%s'
2378 AND `item`.`contact-id` = %d
2379 AND `item`.`visible` AND NOT `item`.`moderated` AND NOT `item`.`deleted`
2381 AND `item`.`id` > %d
2382 ORDER BY `item`.`id` DESC LIMIT %d ,%d ",
2384 dbesc(ACTIVITY_POST),
2385 intval($user_info['cid']),
2391 $ret = api_format_items($r, $user_info, true, $type);
2393 $data = array('status' => $ret);
2397 $data = api_rss_extra($a, $data, $user_info);
2401 return api_format_data("statuses", $type, $data);
2404 /// @TODO move to top of file or somewhere better
2405 api_register_func('api/statuses/user_timeline', 'api_statuses_user_timeline', true);
2408 * Star/unstar an item.
2409 * param: id : id of the item
2411 * @param string $type Return type (atom, rss, xml, json)
2413 * @see https://web.archive.org/web/20131019055350/https://dev.twitter.com/docs/api/1/post/favorites/create/%3Aid
2415 function api_favorites_create_destroy($type)
2419 if (api_user() === false) {
2420 throw new ForbiddenException();
2423 // for versioned api.
2424 /// @TODO We need a better global soluton
2425 $action_argv_id = 2;
2426 if ($a->argv[1] == "1.1") {
2427 $action_argv_id = 3;
2430 if ($a->argc <= $action_argv_id) {
2431 throw new BadRequestException("Invalid request.");
2433 $action = str_replace("." . $type, "", $a->argv[$action_argv_id]);
2434 if ($a->argc == $action_argv_id + 2) {
2435 $itemid = intval($a->argv[$action_argv_id + 1]);
2437 /// @TODO use x() to check if _REQUEST contains 'id'
2438 $itemid = intval($_REQUEST['id']);
2441 $item = q("SELECT * FROM `item` WHERE `id`=%d AND `uid`=%d LIMIT 1", $itemid, api_user());
2443 if (!DBM::is_result($item) || count($item) == 0) {
2444 throw new BadRequestException("Invalid item.");
2449 $item[0]['starred'] = 1;
2452 $item[0]['starred'] = 0;
2455 throw new BadRequestException("Invalid action ".$action);
2458 $r = q("UPDATE item SET starred=%d WHERE id=%d AND uid=%d", $item[0]['starred'], $itemid, api_user());
2460 q("UPDATE thread SET starred=%d WHERE iid=%d AND uid=%d", $item[0]['starred'], $itemid, api_user());
2463 throw new InternalServerErrorException("DB error");
2467 $user_info = api_get_user($a);
2468 $rets = api_format_items($item, $user_info, false, $type);
2471 $data = array('status' => $ret);
2475 $data = api_rss_extra($a, $data, $user_info);
2478 return api_format_data("status", $type, $data);
2481 /// @TODO move to top of file or somewhere better
2482 api_register_func('api/favorites/create', 'api_favorites_create_destroy', true, API_METHOD_POST);
2483 api_register_func('api/favorites/destroy', 'api_favorites_create_destroy', true, API_METHOD_DELETE);
2486 * Returns the most recent favorite statuses.
2488 * @param string $type Return type (atom, rss, xml, json)
2490 * @return string|array
2492 function api_favorites($type)
2498 if (api_user() === false) {
2499 throw new ForbiddenException();
2502 $called_api = array();
2504 $user_info = api_get_user($a);
2506 // in friendica starred item are private
2507 // return favorites only for self
2508 logger('api_favorites: self:' . $user_info['self']);
2510 if ($user_info['self'] == 0) {
2516 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
2517 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
2518 $count = (x($_GET, 'count') ? $_GET['count'] : 20);
2519 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] -1 : 0);
2524 $start = $page*$count;
2527 $sql_extra .= ' AND `item`.`id` <= ' . intval($max_id);
2531 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`,
2532 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
2533 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
2534 `contact`.`id` AS `cid`
2535 FROM `item`, `contact`
2536 WHERE `item`.`uid` = %d
2537 AND `item`.`visible` = 1 AND `item`.`moderated` = 0 AND `item`.`deleted` = 0
2538 AND `item`.`starred` = 1
2539 AND `contact`.`id` = `item`.`contact-id`
2540 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
2543 ORDER BY `item`.`id` DESC LIMIT %d ,%d ",
2550 $ret = api_format_items($r, $user_info, false, $type);
2553 $data = array('status' => $ret);
2557 $data = api_rss_extra($a, $data, $user_info);
2560 return api_format_data("statuses", $type, $data);
2563 /// @TODO move to top of file or somewhere better
2564 api_register_func('api/favorites', 'api_favorites', true);
2568 * @param array $item
2569 * @param array $recipient
2570 * @param array $sender
2574 function api_format_messages($item, $recipient, $sender)
2576 // standard meta information
2578 'id' => $item['id'],
2579 'sender_id' => $sender['id'] ,
2581 'recipient_id' => $recipient['id'],
2582 'created_at' => api_date($item['created']),
2583 'sender_screen_name' => $sender['screen_name'],
2584 'recipient_screen_name' => $recipient['screen_name'],
2585 'sender' => $sender,
2586 'recipient' => $recipient,
2588 'friendica_seen' => $item['seen'],
2589 'friendica_parent_uri' => $item['parent-uri'],
2592 // "uid" and "self" are only needed for some internal stuff, so remove it from here
2593 unset($ret["sender"]["uid"]);
2594 unset($ret["sender"]["self"]);
2595 unset($ret["recipient"]["uid"]);
2596 unset($ret["recipient"]["self"]);
2598 //don't send title to regular StatusNET requests to avoid confusing these apps
2599 if (x($_GET, 'getText')) {
2600 $ret['title'] = $item['title'];
2601 if ($_GET['getText'] == 'html') {
2602 $ret['text'] = bbcode($item['body'], false, false);
2603 } elseif ($_GET['getText'] == 'plain') {
2604 //$ret['text'] = html2plain(bbcode($item['body'], false, false, true), 0);
2605 $ret['text'] = trim(html2plain(bbcode(api_clean_plain_items($item['body']), false, false, 2, true), 0));
2608 $ret['text'] = $item['title'] . "\n" . html2plain(bbcode(api_clean_plain_items($item['body']), false, false, 2, true), 0);
2610 if (x($_GET, 'getUserObjects') && $_GET['getUserObjects'] == 'false') {
2611 unset($ret['sender']);
2612 unset($ret['recipient']);
2620 * @param array $item
2624 function api_convert_item($item)
2626 $body = $item['body'];
2627 $attachments = api_get_attachments($body);
2629 // Workaround for ostatus messages where the title is identically to the body
2630 $html = bbcode(api_clean_plain_items($body), false, false, 2, true);
2631 $statusbody = trim(html2plain($html, 0));
2633 // handle data: images
2634 $statusbody = api_format_items_embeded_images($item, $statusbody);
2636 $statustitle = trim($item['title']);
2638 if (($statustitle != '') && (strpos($statusbody, $statustitle) !== false)) {
2639 $statustext = trim($statusbody);
2641 $statustext = trim($statustitle."\n\n".$statusbody);
2644 if (($item["network"] == NETWORK_FEED) && (strlen($statustext)> 1000)) {
2645 $statustext = substr($statustext, 0, 1000)."... \n".$item["plink"];
2648 $statushtml = trim(bbcode($body, false, false));
2650 // Workaround for clients with limited HTML parser functionality
2651 $search = array("<br>", "<blockquote>", "</blockquote>",
2652 "<h1>", "</h1>", "<h2>", "</h2>",
2653 "<h3>", "</h3>", "<h4>", "</h4>",
2654 "<h5>", "</h5>", "<h6>", "</h6>");
2655 $replace = array("<br>", "<br><blockquote>", "</blockquote><br>",
2656 "<br><h1>", "</h1><br>", "<br><h2>", "</h2><br>",
2657 "<br><h3>", "</h3><br>", "<br><h4>", "</h4><br>",
2658 "<br><h5>", "</h5><br>", "<br><h6>", "</h6><br>");
2659 $statushtml = str_replace($search, $replace, $statushtml);
2661 if ($item['title'] != "") {
2662 $statushtml = "<br><h4>" . bbcode($item['title']) . "</h4><br>" . $statushtml;
2666 $oldtext = $statushtml;
2667 $statushtml = str_replace("<br><br>", "<br>", $statushtml);
2668 } while ($oldtext != $statushtml);
2670 if (substr($statushtml, 0, 4) == '<br>') {
2671 $statushtml = substr($statushtml, 4);
2674 if (substr($statushtml, 0, -4) == '<br>') {
2675 $statushtml = substr($statushtml, -4);
2678 // feeds without body should contain the link
2679 if (($item['network'] == NETWORK_FEED) && (strlen($item['body']) == 0)) {
2680 $statushtml .= bbcode($item['plink']);
2683 $entities = api_get_entitities($statustext, $body);
2686 "text" => $statustext,
2687 "html" => $statushtml,
2688 "attachments" => $attachments,
2689 "entities" => $entities
2695 * @param string $body
2697 * @return array|false
2699 function api_get_attachments(&$body)
2702 $text = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $text);
2704 $URLSearchString = "^\[\]";
2705 $ret = preg_match_all("/\[img\]([$URLSearchString]*)\[\/img\]/ism", $text, $images);
2711 $attachments = array();
2713 foreach ($images[1] as $image) {
2714 $imagedata = Image::getInfoFromURL($image);
2717 $attachments[] = array("url" => $image, "mimetype" => $imagedata["mime"], "size" => $imagedata["size"]);
2721 if (strstr($_SERVER['HTTP_USER_AGENT'], "AndStatus")) {
2722 foreach ($images[0] as $orig) {
2723 $body = str_replace($orig, "", $body);
2727 return $attachments;
2732 * @param string $text
2733 * @param string $bbcode
2736 * @todo Links at the first character of the post
2738 function api_get_entitities(&$text, $bbcode)
2740 $include_entities = strtolower(x($_REQUEST, 'include_entities') ? $_REQUEST['include_entities'] : "false");
2742 if ($include_entities != "true") {
2743 preg_match_all("/\[img](.*?)\[\/img\]/ism", $bbcode, $images);
2745 foreach ($images[1] as $image) {
2746 $replace = proxy_url($image);
2747 $text = str_replace($image, $replace, $text);
2752 $bbcode = bb_CleanPictureLinks($bbcode);
2754 // Change pure links in text to bbcode uris
2755 $bbcode = preg_replace("/([^\]\='".'"'."]|^)(https?\:\/\/[a-zA-Z0-9\:\/\-\?\&\;\.\=\_\~\#\%\$\!\+\,]+)/ism", '$1[url=$2]$2[/url]', $bbcode);
2757 $entities = array();
2758 $entities["hashtags"] = array();
2759 $entities["symbols"] = array();
2760 $entities["urls"] = array();
2761 $entities["user_mentions"] = array();
2763 $URLSearchString = "^\[\]";
2765 $bbcode = preg_replace("/#\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '#$2', $bbcode);
2767 $bbcode = preg_replace("/\[bookmark\=([$URLSearchString]*)\](.*?)\[\/bookmark\]/ism", '[url=$1]$2[/url]', $bbcode);
2768 //$bbcode = preg_replace("/\[url\](.*?)\[\/url\]/ism",'[url=$1]$1[/url]',$bbcode);
2769 $bbcode = preg_replace("/\[video\](.*?)\[\/video\]/ism", '[url=$1]$1[/url]', $bbcode);
2771 $bbcode = preg_replace(
2772 "/\[youtube\]([A-Za-z0-9\-_=]+)(.*?)\[\/youtube\]/ism",
2773 '[url=https://www.youtube.com/watch?v=$1]https://www.youtube.com/watch?v=$1[/url]',
2776 $bbcode = preg_replace("/\[youtube\](.*?)\[\/youtube\]/ism", '[url=$1]$1[/url]', $bbcode);
2778 $bbcode = preg_replace(
2779 "/\[vimeo\]([0-9]+)(.*?)\[\/vimeo\]/ism",
2780 '[url=https://vimeo.com/$1]https://vimeo.com/$1[/url]',
2783 $bbcode = preg_replace("/\[vimeo\](.*?)\[\/vimeo\]/ism", '[url=$1]$1[/url]', $bbcode);
2785 $bbcode = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $bbcode);
2787 //preg_match_all("/\[url\]([$URLSearchString]*)\[\/url\]/ism", $bbcode, $urls1);
2788 preg_match_all("/\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", $bbcode, $urls);
2790 $ordered_urls = array();
2791 foreach ($urls[1] as $id => $url) {
2792 //$start = strpos($text, $url, $offset);
2793 $start = iconv_strpos($text, $url, 0, "UTF-8");
2794 if (!($start === false)) {
2795 $ordered_urls[$start] = array("url" => $url, "title" => $urls[2][$id]);
2799 ksort($ordered_urls);
2802 //foreach ($urls[1] AS $id=>$url) {
2803 foreach ($ordered_urls as $url) {
2804 if ((substr($url["title"], 0, 7) != "http://") && (substr($url["title"], 0, 8) != "https://")
2805 && !strpos($url["title"], "http://") && !strpos($url["title"], "https://")
2807 $display_url = $url["title"];
2809 $display_url = str_replace(array("http://www.", "https://www."), array("", ""), $url["url"]);
2810 $display_url = str_replace(array("http://", "https://"), array("", ""), $display_url);
2812 if (strlen($display_url) > 26) {
2813 $display_url = substr($display_url, 0, 25)."…";
2817 //$start = strpos($text, $url, $offset);
2818 $start = iconv_strpos($text, $url["url"], $offset, "UTF-8");
2819 if (!($start === false)) {
2820 $entities["urls"][] = array("url" => $url["url"],
2821 "expanded_url" => $url["url"],
2822 "display_url" => $display_url,
2823 "indices" => array($start, $start+strlen($url["url"])));
2824 $offset = $start + 1;
2828 preg_match_all("/\[img](.*?)\[\/img\]/ism", $bbcode, $images);
2829 $ordered_images = array();
2830 foreach ($images[1] as $image) {
2831 //$start = strpos($text, $url, $offset);
2832 $start = iconv_strpos($text, $image, 0, "UTF-8");
2833 if (!($start === false)) {
2834 $ordered_images[$start] = $image;
2837 //$entities["media"] = array();
2840 foreach ($ordered_images as $url) {
2841 $display_url = str_replace(array("http://www.", "https://www."), array("", ""), $url);
2842 $display_url = str_replace(array("http://", "https://"), array("", ""), $display_url);
2844 if (strlen($display_url) > 26) {
2845 $display_url = substr($display_url, 0, 25)."…";
2848 $start = iconv_strpos($text, $url, $offset, "UTF-8");
2849 if (!($start === false)) {
2850 $image = Image::getInfoFromURL($url);
2852 // If image cache is activated, then use the following sizes:
2853 // thumb (150), small (340), medium (600) and large (1024)
2854 if (!Config::get("system", "proxy_disabled")) {
2855 $media_url = proxy_url($url);
2858 $scale = Image::getScalingDimensions($image[0], $image[1], 150);
2859 $sizes["thumb"] = array("w" => $scale["width"], "h" => $scale["height"], "resize" => "fit");
2861 if (($image[0] > 150) || ($image[1] > 150)) {
2862 $scale = Image::getScalingDimensions($image[0], $image[1], 340);
2863 $sizes["small"] = array("w" => $scale["width"], "h" => $scale["height"], "resize" => "fit");
2866 $scale = Image::getScalingDimensions($image[0], $image[1], 600);
2867 $sizes["medium"] = array("w" => $scale["width"], "h" => $scale["height"], "resize" => "fit");
2869 if (($image[0] > 600) || ($image[1] > 600)) {
2870 $scale = Image::getScalingDimensions($image[0], $image[1], 1024);
2871 $sizes["large"] = array("w" => $scale["width"], "h" => $scale["height"], "resize" => "fit");
2875 $sizes["medium"] = array("w" => $image[0], "h" => $image[1], "resize" => "fit");
2878 $entities["media"][] = array(
2880 "id_str" => (string)$start+1,
2881 "indices" => array($start, $start+strlen($url)),
2882 "media_url" => normalise_link($media_url),
2883 "media_url_https" => $media_url,
2885 "display_url" => $display_url,
2886 "expanded_url" => $url,
2890 $offset = $start + 1;
2899 * @param array $item
2900 * @param string $text
2904 function api_format_items_embeded_images($item, $text)
2906 $text = preg_replace_callback(
2907 '|data:image/([^;]+)[^=]+=*|m',
2908 function () use ($item) {
2909 return System::baseUrl() . '/display/' . $item['guid'];
2917 * @brief return <a href='url'>name</a> as array
2919 * @param string $txt text
2924 function api_contactlink_to_array($txt)
2927 $r = preg_match_all('|<a href="([^"]*)">([^<]*)</a>|', $txt, $match);
2928 if ($r && count($match)==3) {
2930 'name' => $match[2],
2944 * @brief return likes, dislikes and attend status for item
2946 * @param array $item array
2947 * @param string $type Return type (atom, rss, xml, json)
2950 * likes => int count,
2951 * dislikes => int count
2953 function api_format_items_activities(&$item, $type = "json")
2957 $activities = array(
2959 'dislike' => array(),
2960 'attendyes' => array(),
2961 'attendno' => array(),
2962 'attendmaybe' => array(),
2967 WHERE uid=%d AND `thr-parent`="%s" AND visible AND NOT deleted',
2968 intval($item['uid']),
2972 foreach ($items as $i) {
2973 // not used as result should be structured like other user data
2974 //builtin_activity_puller($i, $activities);
2976 // get user data and add it to the array of the activity
2977 $user = api_get_user($a, $i['author-link']);
2978 switch ($i['verb']) {
2980 $activities['like'][] = $user;
2982 case ACTIVITY_DISLIKE:
2983 $activities['dislike'][] = $user;
2985 case ACTIVITY_ATTEND:
2986 $activities['attendyes'][] = $user;
2988 case ACTIVITY_ATTENDNO:
2989 $activities['attendno'][] = $user;
2991 case ACTIVITY_ATTENDMAYBE:
2992 $activities['attendmaybe'][] = $user;
2999 if ($type == "xml") {
3000 $xml_activities = array();
3001 foreach ($activities as $k => $v) {
3002 // change xml element from "like" to "friendica:like"
3003 $xml_activities["friendica:".$k] = $v;
3004 // add user data into xml output
3006 foreach ($v as $user) {
3007 $xml_activities["friendica:".$k][$k_user++.":user"] = $user;
3010 $activities = $xml_activities;
3018 * @brief return data from profiles
3020 * @param array $profile_row array containing data from db table 'profile'
3023 function api_format_items_profiles($profile_row)
3026 'profile_id' => $profile_row['id'],
3027 'profile_name' => $profile_row['profile-name'],
3028 'is_default' => $profile_row['is-default'] ? true : false,
3029 'hide_friends' => $profile_row['hide-friends'] ? true : false,
3030 'profile_photo' => $profile_row['photo'],
3031 'profile_thumb' => $profile_row['thumb'],
3032 'publish' => $profile_row['publish'] ? true : false,
3033 'net_publish' => $profile_row['net-publish'] ? true : false,
3034 'description' => $profile_row['pdesc'],
3035 'date_of_birth' => $profile_row['dob'],
3036 'address' => $profile_row['address'],
3037 'city' => $profile_row['locality'],
3038 'region' => $profile_row['region'],
3039 'postal_code' => $profile_row['postal-code'],
3040 'country' => $profile_row['country-name'],
3041 'hometown' => $profile_row['hometown'],
3042 'gender' => $profile_row['gender'],
3043 'marital' => $profile_row['marital'],
3044 'marital_with' => $profile_row['with'],
3045 'marital_since' => $profile_row['howlong'],
3046 'sexual' => $profile_row['sexual'],
3047 'politic' => $profile_row['politic'],
3048 'religion' => $profile_row['religion'],
3049 'public_keywords' => $profile_row['pub_keywords'],
3050 'private_keywords' => $profile_row['prv_keywords'],
3051 'likes' => bbcode(api_clean_plain_items($profile_row['likes']) , false, false, 2, false),
3052 'dislikes' => bbcode(api_clean_plain_items($profile_row['dislikes']) , false, false, 2, false),
3053 'about' => bbcode(api_clean_plain_items($profile_row['about']) , false, false, 2, false),
3054 'music' => bbcode(api_clean_plain_items($profile_row['music']) , false, false, 2, false),
3055 'book' => bbcode(api_clean_plain_items($profile_row['book']) , false, false, 2, false),
3056 'tv' => bbcode(api_clean_plain_items($profile_row['tv']) , false, false, 2, false),
3057 'film' => bbcode(api_clean_plain_items($profile_row['film']) , false, false, 2, false),
3058 'interest' => bbcode(api_clean_plain_items($profile_row['interest']) , false, false, 2, false),
3059 'romance' => bbcode(api_clean_plain_items($profile_row['romance']) , false, false, 2, false),
3060 'work' => bbcode(api_clean_plain_items($profile_row['work']) , false, false, 2, false),
3061 'education' => bbcode(api_clean_plain_items($profile_row['education']), false, false, 2, false),
3062 'social_networks' => bbcode(api_clean_plain_items($profile_row['contact']) , false, false, 2, false),
3063 'homepage' => $profile_row['homepage'],
3070 * @brief format items to be returned by api
3072 * @param array $r array of items
3073 * @param array $user_info
3074 * @param bool $filter_user filter items by $user_info
3075 * @param string $type Return type (atom, rss, xml, json)
3077 function api_format_items($r, $user_info, $filter_user = false, $type = "json")
3083 foreach ($r as $item) {
3084 localize_item($item);
3085 list($status_user, $owner_user) = api_item_get_user($a, $item);
3087 // Look if the posts are matching if they should be filtered by user id
3088 if ($filter_user && ($status_user["id"] != $user_info["id"])) {
3092 $in_reply_to = api_in_reply_to($item);
3094 $converted = api_convert_item($item);
3096 if ($type == "xml") {
3097 $geo = "georss:point";
3103 'text' => $converted["text"],
3104 'truncated' => false,
3105 'created_at'=> api_date($item['created']),
3106 'in_reply_to_status_id' => $in_reply_to['status_id'],
3107 'in_reply_to_status_id_str' => $in_reply_to['status_id_str'],
3108 'source' => (($item['app']) ? $item['app'] : 'web'),
3109 'id' => intval($item['id']),
3110 'id_str' => (string) intval($item['id']),
3111 'in_reply_to_user_id' => $in_reply_to['user_id'],
3112 'in_reply_to_user_id_str' => $in_reply_to['user_id_str'],
3113 'in_reply_to_screen_name' => $in_reply_to['screen_name'],
3115 'favorited' => $item['starred'] ? true : false,
3116 'user' => $status_user ,
3117 'friendica_owner' => $owner_user,
3118 //'entities' => NULL,
3119 'statusnet_html' => $converted["html"],
3120 'statusnet_conversation_id' => $item['parent'],
3121 'external_url' => System::baseUrl() . "/display/" . $item['guid'],
3122 'friendica_activities' => api_format_items_activities($item, $type),
3125 if (count($converted["attachments"]) > 0) {
3126 $status["attachments"] = $converted["attachments"];
3129 if (count($converted["entities"]) > 0) {
3130 $status["entities"] = $converted["entities"];
3133 if (($item['item_network'] != "") && ($status["source"] == 'web')) {
3134 $status["source"] = ContactSelector::networkToName($item['item_network'], $user_info['url']);
3135 } elseif (($item['item_network'] != "") && (ContactSelector::networkToName($item['item_network'], $user_info['url']) != $status["source"])) {
3136 $status["source"] = trim($status["source"].' ('.ContactSelector::networkToName($item['item_network'], $user_info['url']).')');
3140 // Retweets are only valid for top postings
3141 // It doesn't work reliable with the link if its a feed
3142 //$IsRetweet = ($item['owner-link'] != $item['author-link']);
3144 // $IsRetweet = (($item['owner-name'] != $item['author-name']) || ($item['owner-avatar'] != $item['author-avatar']));
3147 if ($item["id"] == $item["parent"]) {
3148 $retweeted_item = api_share_as_retweet($item);
3149 if ($retweeted_item !== false) {
3150 $retweeted_status = $status;
3152 $retweeted_status["user"] = api_get_user($a, $retweeted_item["author-link"]);
3153 } catch (BadRequestException $e) {
3154 // user not found. should be found?
3155 /// @todo check if the user should be always found
3156 $retweeted_status["user"] = array();
3159 $rt_converted = api_convert_item($retweeted_item);
3161 $retweeted_status['text'] = $rt_converted["text"];
3162 $retweeted_status['statusnet_html'] = $rt_converted["html"];
3163 $retweeted_status['friendica_activities'] = api_format_items_activities($retweeted_item, $type);
3164 $retweeted_status['created_at'] = api_date($retweeted_item['created']);
3165 $status['retweeted_status'] = $retweeted_status;
3169 // "uid" and "self" are only needed for some internal stuff, so remove it from here
3170 unset($status["user"]["uid"]);
3171 unset($status["user"]["self"]);
3173 if ($item["coord"] != "") {
3174 $coords = explode(' ', $item["coord"]);
3175 if (count($coords) == 2) {
3176 if ($type == "json") {
3177 $status["geo"] = array('type' => 'Point',
3178 'coordinates' => array((float) $coords[0],
3179 (float) $coords[1]));
3180 } else {// Not sure if this is the official format - if someone founds a documentation we can check
3181 $status["georss:point"] = $item["coord"];
3191 * Returns the remaining number of API requests available to the user before the API limit is reached.
3193 * @param string $type Return type (atom, rss, xml, json)
3195 * @return array|string
3197 function api_account_rate_limit_status($type)
3199 if ($type == "xml") {
3201 'remaining-hits' => '150',
3202 '@attributes' => array("type" => "integer"),
3203 'hourly-limit' => '150',
3204 '@attributes2' => array("type" => "integer"),
3205 'reset-time' => datetime_convert('UTC', 'UTC', 'now + 1 hour', ATOM_TIME),
3206 '@attributes3' => array("type" => "datetime"),
3207 'reset_time_in_seconds' => strtotime('now + 1 hour'),
3208 '@attributes4' => array("type" => "integer"),
3212 'reset_time_in_seconds' => strtotime('now + 1 hour'),
3213 'remaining_hits' => '150',
3214 'hourly_limit' => '150',
3215 'reset_time' => api_date(datetime_convert('UTC', 'UTC', 'now + 1 hour', ATOM_TIME)),
3219 return api_format_data('hash', $type, array('hash' => $hash));
3222 /// @TODO move to top of file or somewhere better
3223 api_register_func('api/account/rate_limit_status', 'api_account_rate_limit_status', true);
3226 * Returns the string "ok" in the requested format with a 200 OK HTTP status code.
3228 * @param string $type Return type (atom, rss, xml, json)
3230 * @return array|string
3232 function api_help_test($type)
3234 if ($type == 'xml') {
3240 return api_format_data('ok', $type, array("ok" => $ok));
3243 /// @TODO move to top of file or somewhere better
3244 api_register_func('api/help/test', 'api_help_test', false);
3248 * @param string $type Return type (atom, rss, xml, json)
3250 * @return array|string
3252 function api_lists($type)
3255 /// @TODO $ret is not filled here?
3256 return api_format_data('lists', $type, array("lists_list" => $ret));
3259 /// @TODO move to top of file or somewhere better
3260 api_register_func('api/lists', 'api_lists', true);
3263 * Returns all lists the user subscribes to.
3265 * @param string $type Return type (atom, rss, xml, json)
3267 * @return array|string
3268 * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-list
3270 function api_lists_list($type)
3273 /// @TODO $ret is not filled here?
3274 return api_format_data('lists', $type, array("lists_list" => $ret));
3277 /// @TODO move to top of file or somewhere better
3278 api_register_func('api/lists/list', 'api_lists_list', true);
3281 * Considers friends and followers lists to be private and won't return
3282 * anything if any user_id parameter is passed.
3284 * @brief Returns either the friends of the follower list
3286 * @param string $qtype Either "friends" or "followers"
3287 * @return boolean|array
3288 * @throws ForbiddenException
3290 function api_statuses_f($qtype)
3294 if (api_user() === false) {
3295 throw new ForbiddenException();
3299 $count = x($_GET, 'count') ? $_GET['count'] : 20;
3300 $page = x($_GET, 'page') ? $_GET['page'] : 1;
3304 $start = ($page - 1) * $count;
3306 $user_info = api_get_user($a);
3308 if (x($_GET, 'cursor') && $_GET['cursor'] == 'undefined') {
3309 /* this is to stop Hotot to load friends multiple times
3310 * I'm not sure if I'm missing return something or
3311 * is a bug in hotot. Workaround, meantime
3315 return array('$users' => $ret);*/
3320 if ($qtype == 'friends') {
3321 $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(CONTACT_IS_SHARING), intval(CONTACT_IS_FRIEND));
3322 } elseif ($qtype == 'followers') {
3323 $sql_extra = sprintf(" AND ( `rel` = %d OR `rel` = %d ) ", intval(CONTACT_IS_FOLLOWER), intval(CONTACT_IS_FRIEND));
3326 // friends and followers only for self
3327 if ($user_info['self'] == 0) {
3328 $sql_extra = " AND false ";
3331 if ($qtype == 'blocks') {
3332 $sql_filter = 'AND `blocked` AND NOT `pending`';
3333 } elseif ($qtype == 'incoming') {
3334 $sql_filter = 'AND `pending`';
3336 $sql_filter = 'AND (NOT `blocked` OR `pending`)';
3354 foreach ($r as $cid) {
3355 $user = api_get_user($a, $cid['nurl']);
3356 // "uid" and "self" are only needed for some internal stuff, so remove it from here
3357 unset($user["uid"]);
3358 unset($user["self"]);
3365 return array('user' => $ret);
3370 * Returns the user's friends.
3372 * @brief Returns the list of friends of the provided user
3374 * @deprecated By Twitter API in favor of friends/list
3376 * @param string $type Either "json" or "xml"
3377 * @return boolean|string|array
3379 function api_statuses_friends($type)
3381 $data = api_statuses_f("friends");
3382 if ($data === false) {
3385 return api_format_data("users", $type, $data);
3389 * Returns the user's followers.
3391 * @brief Returns the list of followers of the provided user
3393 * @deprecated By Twitter API in favor of friends/list
3395 * @param string $type Either "json" or "xml"
3396 * @return boolean|string|array
3398 function api_statuses_followers($type)
3400 $data = api_statuses_f("followers");
3401 if ($data === false) {
3404 return api_format_data("users", $type, $data);
3407 /// @TODO move to top of file or somewhere better
3408 api_register_func('api/statuses/friends', 'api_statuses_friends', true);
3409 api_register_func('api/statuses/followers', 'api_statuses_followers', true);
3412 * Returns the list of blocked users
3414 * @see https://developer.twitter.com/en/docs/accounts-and-users/mute-block-report-users/api-reference/get-blocks-list
3416 * @param string $type Either "json" or "xml"
3418 * @return boolean|string|array
3420 function api_blocks_list($type)
3422 $data = api_statuses_f('blocks');
3423 if ($data === false) {
3426 return api_format_data("users", $type, $data);
3429 /// @TODO move to top of file or somewhere better
3430 api_register_func('api/blocks/list', 'api_blocks_list', true);
3433 * Returns the list of pending users IDs
3435 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-incoming
3437 * @param string $type Either "json" or "xml"
3439 * @return boolean|string|array
3441 function api_friendships_incoming($type)
3443 $data = api_statuses_f('incoming');
3444 if ($data === false) {
3449 foreach ($data['user'] as $user) {
3450 $ids[] = $user['id'];
3453 return api_format_data("ids", $type, array('id' => $ids));
3456 /// @TODO move to top of file or somewhere better
3457 api_register_func('api/friendships/incoming', 'api_friendships_incoming', true);
3460 * Returns the instance's configuration information.
3462 * @param string $type Return type (atom, rss, xml, json)
3464 * @return array|string
3466 function api_statusnet_config($type)
3470 $name = $a->config['sitename'];
3471 $server = $a->get_hostname();
3472 $logo = System::baseUrl() . '/images/friendica-64.png';
3473 $email = $a->config['admin_email'];
3474 $closed = (($a->config['register_policy'] == REGISTER_CLOSED) ? 'true' : 'false');
3475 $private = ((Config::get('system', 'block_public')) ? 'true' : 'false');
3476 $textlimit = (string) (($a->config['max_import_size']) ? $a->config['max_import_size'] : 200000);
3477 if ($a->config['api_import_size']) {
3478 $textlimit = (string) $a->config['api_import_size'];
3480 $ssl = ((Config::get('system', 'have_ssl')) ? 'true' : 'false');
3481 $sslserver = (($ssl === 'true') ? str_replace('http:', 'https:', System::baseUrl()) : '');
3484 'site' => array('name' => $name,'server' => $server, 'theme' => 'default', 'path' => '',
3485 'logo' => $logo, 'fancy' => true, 'language' => 'en', 'email' => $email, 'broughtby' => '',
3486 'broughtbyurl' => '', 'timezone' => 'UTC', 'closed' => $closed, 'inviteonly' => false,
3487 'private' => $private, 'textlimit' => $textlimit, 'sslserver' => $sslserver, 'ssl' => $ssl,
3488 'shorturllength' => '30',
3489 'friendica' => array(
3490 'FRIENDICA_PLATFORM' => FRIENDICA_PLATFORM,
3491 'FRIENDICA_VERSION' => FRIENDICA_VERSION,
3492 'DFRN_PROTOCOL_VERSION' => DFRN_PROTOCOL_VERSION,
3493 'DB_UPDATE_VERSION' => DB_UPDATE_VERSION
3498 return api_format_data('config', $type, array('config' => $config));
3501 /// @TODO move to top of file or somewhere better
3502 api_register_func('api/gnusocial/config', 'api_statusnet_config', false);
3503 api_register_func('api/statusnet/config', 'api_statusnet_config', false);
3507 * @param string $type Return type (atom, rss, xml, json)
3509 * @return array|string
3511 function api_statusnet_version($type)
3514 $fake_statusnet_version = "0.9.7";
3516 return api_format_data('version', $type, array('version' => $fake_statusnet_version));
3519 /// @TODO move to top of file or somewhere better
3520 api_register_func('api/gnusocial/version', 'api_statusnet_version', false);
3521 api_register_func('api/statusnet/version', 'api_statusnet_version', false);
3525 * @param string $type Return type (atom, rss, xml, json)
3527 * @todo use api_format_data() to return data
3529 function api_ff_ids($type)
3532 throw new ForbiddenException();
3537 $stringify_ids = defaults($_REQUEST, 'stringify_ids', false);
3540 "SELECT `pcontact`.`id` FROM `contact`
3541 INNER JOIN `contact` AS `pcontact` ON `contact`.`nurl` = `pcontact`.`nurl` AND `pcontact`.`uid` = 0
3542 WHERE `contact`.`uid` = %s AND NOT `contact`.`self`",
3545 if (!DBM::is_result($r)) {
3550 foreach ($r as $rr) {
3551 if ($stringify_ids) {
3554 $ids[] = intval($rr['id']);
3558 return api_format_data("ids", $type, array('id' => $ids));
3562 * Returns the ID of every user the user is following.
3564 * @param string $type Return type (atom, rss, xml, json)
3566 * @return array|string
3567 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friends-ids
3569 function api_friends_ids($type)
3571 return api_ff_ids($type);
3575 * Returns the ID of every user following the user.
3577 * @param string $type Return type (atom, rss, xml, json)
3579 * @return array|string
3580 * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-followers-ids
3582 function api_followers_ids($type)
3584 return api_ff_ids($type);
3587 /// @TODO move to top of file or somewhere better
3588 api_register_func('api/friends/ids', 'api_friends_ids', true);
3589 api_register_func('api/followers/ids', 'api_followers_ids', true);
3592 * Sends a new direct message.
3594 * @param string $type Return type (atom, rss, xml, json)
3596 * @return array|string
3597 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/new-message
3599 function api_direct_messages_new($type)
3604 if (api_user() === false) {
3605 throw new ForbiddenException();
3608 if (!x($_POST, "text") || (!x($_POST, "screen_name") && !x($_POST, "user_id"))) {
3612 $sender = api_get_user($a);
3614 if ($_POST['screen_name']) {
3616 "SELECT `id`, `nurl`, `network` FROM `contact` WHERE `uid`=%d AND `nick`='%s'",
3618 dbesc($_POST['screen_name'])
3621 // Selecting the id by priority, friendica first
3622 api_best_nickname($r);
3624 $recipient = api_get_user($a, $r[0]['nurl']);
3626 $recipient = api_get_user($a, $_POST['user_id']);
3631 if (x($_REQUEST, 'replyto')) {
3633 'SELECT `parent-uri`, `title` FROM `mail` WHERE `uid`=%d AND `id`=%d',
3635 intval($_REQUEST['replyto'])
3637 $replyto = $r[0]['parent-uri'];
3638 $sub = $r[0]['title'];
3640 if (x($_REQUEST, 'title')) {
3641 $sub = $_REQUEST['title'];
3643 $sub = ((strlen($_POST['text'])>10) ? substr($_POST['text'], 0, 10)."...":$_POST['text']);
3647 $id = send_message($recipient['cid'], $_POST['text'], $sub, $replyto);
3650 $r = q("SELECT * FROM `mail` WHERE id=%d", intval($id));
3651 $ret = api_format_messages($r[0], $recipient, $sender);
3653 $ret = array("error"=>$id);
3656 $data = array('direct_message'=>$ret);
3661 $data = api_rss_extra($a, $data, $user_info);
3664 return api_format_data("direct-messages", $type, $data);
3667 /// @TODO move to top of file or somewhere better
3668 api_register_func('api/direct_messages/new', 'api_direct_messages_new', true, API_METHOD_POST);
3671 * Destroys a direct message.
3673 * @brief delete a direct_message from mail table through api
3675 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3677 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/delete-message
3679 function api_direct_messages_destroy($type)
3683 if (api_user() === false) {
3684 throw new ForbiddenException();
3688 $user_info = api_get_user($a);
3690 $id = (x($_REQUEST, 'id') ? $_REQUEST['id'] : 0);
3692 $parenturi = (x($_REQUEST, 'friendica_parenturi') ? $_REQUEST['friendica_parenturi'] : "");
3693 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3694 /// @todo optional parameter 'include_entities' from Twitter API not yet implemented
3696 $uid = $user_info['uid'];
3697 // error if no id or parenturi specified (for clients posting parent-uri as well)
3698 if ($verbose == "true" && ($id == 0 || $parenturi == "")) {
3699 $answer = array('result' => 'error', 'message' => 'message id or parenturi not specified');
3700 return api_format_data("direct_messages_delete", $type, array('$result' => $answer));
3703 // BadRequestException if no id specified (for clients using Twitter API)
3705 throw new BadRequestException('Message id not specified');
3708 // add parent-uri to sql command if specified by calling app
3709 $sql_extra = ($parenturi != "" ? " AND `parent-uri` = '" . dbesc($parenturi) . "'" : "");
3711 // get data of the specified message id
3713 "SELECT `id` FROM `mail` WHERE `uid` = %d AND `id` = %d" . $sql_extra,
3718 // error message if specified id is not in database
3719 if (!DBM::is_result($r)) {
3720 if ($verbose == "true") {
3721 $answer = array('result' => 'error', 'message' => 'message id not in database');
3722 return api_format_data("direct_messages_delete", $type, array('$result' => $answer));
3724 /// @todo BadRequestException ok for Twitter API clients?
3725 throw new BadRequestException('message id not in database');
3730 "DELETE FROM `mail` WHERE `uid` = %d AND `id` = %d" . $sql_extra,
3735 if ($verbose == "true") {
3738 $answer = array('result' => 'ok', 'message' => 'message deleted');
3739 return api_format_data("direct_message_delete", $type, array('$result' => $answer));
3741 $answer = array('result' => 'error', 'message' => 'unknown error');
3742 return api_format_data("direct_messages_delete", $type, array('$result' => $answer));
3745 /// @todo return JSON data like Twitter API not yet implemented
3748 /// @TODO move to top of file or somewhere better
3749 api_register_func('api/direct_messages/destroy', 'api_direct_messages_destroy', true, API_METHOD_DELETE);
3753 * @param string $type Return type (atom, rss, xml, json)
3754 * @param string $box
3755 * @param string $verbose
3757 * @return array|string
3759 function api_direct_messages_box($type, $box, $verbose)
3763 if (api_user() === false) {
3764 throw new ForbiddenException();
3768 $count = (x($_GET, 'count') ? $_GET['count'] : 20);
3769 $page = (x($_REQUEST, 'page') ? $_REQUEST['page'] -1 : 0);
3774 $since_id = (x($_REQUEST, 'since_id') ? $_REQUEST['since_id'] : 0);
3775 $max_id = (x($_REQUEST, 'max_id') ? $_REQUEST['max_id'] : 0);
3777 $user_id = (x($_REQUEST, 'user_id') ? $_REQUEST['user_id'] : "");
3778 $screen_name = (x($_REQUEST, 'screen_name') ? $_REQUEST['screen_name'] : "");
3781 unset($_REQUEST["user_id"]);
3782 unset($_GET["user_id"]);
3784 unset($_REQUEST["screen_name"]);
3785 unset($_GET["screen_name"]);
3787 $user_info = api_get_user($a);
3788 $profile_url = $user_info["url"];
3791 $start = $page * $count;
3794 if ($box=="sentbox") {
3795 $sql_extra = "`mail`.`from-url`='" . dbesc($profile_url) . "'";
3796 } elseif ($box == "conversation") {
3797 $sql_extra = "`mail`.`parent-uri`='" . dbesc($_GET["uri"]) . "'";
3798 } elseif ($box == "all") {
3799 $sql_extra = "true";
3800 } elseif ($box == "inbox") {
3801 $sql_extra = "`mail`.`from-url`!='" . dbesc($profile_url) . "'";
3805 $sql_extra .= ' AND `mail`.`id` <= ' . intval($max_id);
3808 if ($user_id != "") {
3809 $sql_extra .= ' AND `mail`.`contact-id` = ' . intval($user_id);
3810 } elseif ($screen_name !="") {
3811 $sql_extra .= " AND `contact`.`nick` = '" . dbesc($screen_name). "'";
3815 "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",
3821 if ($verbose == "true" && !DBM::is_result($r)) {
3822 $answer = array('result' => 'error', 'message' => 'no mails available');
3823 return api_format_data("direct_messages_all", $type, array('$result' => $answer));
3827 foreach ($r as $item) {
3828 if ($box == "inbox" || $item['from-url'] != $profile_url) {
3829 $recipient = $user_info;
3830 $sender = api_get_user($a, normalise_link($item['contact-url']));
3831 } elseif ($box == "sentbox" || $item['from-url'] == $profile_url) {
3832 $recipient = api_get_user($a, normalise_link($item['contact-url']));
3833 $sender = $user_info;
3836 $ret[] = api_format_messages($item, $recipient, $sender);
3840 $data = array('direct_message' => $ret);
3844 $data = api_rss_extra($a, $data, $user_info);
3847 return api_format_data("direct-messages", $type, $data);
3851 * Returns the most recent direct messages sent by the user.
3853 * @param string $type Return type (atom, rss, xml, json)
3855 * @return array|string
3856 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-sent-message
3858 function api_direct_messages_sentbox($type)
3860 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3861 return api_direct_messages_box($type, "sentbox", $verbose);
3865 * Returns the most recent direct messages sent to the user.
3867 * @param string $type Return type (atom, rss, xml, json)
3869 * @return array|string
3870 * @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference/get-messages
3872 function api_direct_messages_inbox($type)
3874 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3875 return api_direct_messages_box($type, "inbox", $verbose);
3880 * @param string $type Return type (atom, rss, xml, json)
3882 * @return array|string
3884 function api_direct_messages_all($type)
3886 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3887 return api_direct_messages_box($type, "all", $verbose);
3892 * @param string $type Return type (atom, rss, xml, json)
3894 * @return array|string
3896 function api_direct_messages_conversation($type)
3898 $verbose = (x($_GET, 'friendica_verbose') ? strtolower($_GET['friendica_verbose']) : "false");
3899 return api_direct_messages_box($type, "conversation", $verbose);
3902 /// @TODO move to top of file or somewhere better
3903 api_register_func('api/direct_messages/conversation', 'api_direct_messages_conversation', true);
3904 api_register_func('api/direct_messages/all', 'api_direct_messages_all', true);
3905 api_register_func('api/direct_messages/sent', 'api_direct_messages_sentbox', true);
3906 api_register_func('api/direct_messages', 'api_direct_messages_inbox', true);
3909 * Returns an OAuth Request Token.
3911 * @see https://oauth.net/core/1.0/#auth_step1
3913 function api_oauth_request_token()
3915 $oauth1 = new FKOAuth1();
3917 $r = $oauth1->fetch_request_token(OAuthRequest::from_request());
3918 } catch (Exception $e) {
3919 echo "error=" . OAuthUtil::urlencode_rfc3986($e->getMessage());
3927 * Returns an OAuth Access Token.
3929 * @return array|string
3930 * @see https://oauth.net/core/1.0/#auth_step3
3932 function api_oauth_access_token()
3934 $oauth1 = new FKOAuth1();
3936 $r = $oauth1->fetch_access_token(OAuthRequest::from_request());
3937 } catch (Exception $e) {
3938 echo "error=". OAuthUtil::urlencode_rfc3986($e->getMessage());
3945 /// @TODO move to top of file or somewhere better
3946 api_register_func('api/oauth/request_token', 'api_oauth_request_token', false);
3947 api_register_func('api/oauth/access_token', 'api_oauth_access_token', false);
3951 * @brief delete a complete photoalbum with all containing photos from database through api
3953 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
3956 function api_fr_photoalbum_delete($type)
3958 if (api_user() === false) {
3959 throw new ForbiddenException();
3962 $album = (x($_REQUEST, 'album') ? $_REQUEST['album'] : "");
3964 // we do not allow calls without album string
3966 throw new BadRequestException("no albumname specified");
3968 // check if album is existing
3970 "SELECT DISTINCT `resource-id` FROM `photo` WHERE `uid` = %d AND `album` = '%s'",
3974 if (!DBM::is_result($r)) {
3975 throw new BadRequestException("album not available");
3978 // function for setting the items to "deleted = 1" which ensures that comments, likes etc. are not shown anymore
3979 // to the user and the contacts of the users (drop_items() performs the federation of the deletion to other networks
3980 foreach ($r as $rr) {
3982 "SELECT `id` FROM `item` WHERE `uid` = %d AND `resource-id` = '%s' AND `type` = 'photo'",
3983 intval(local_user()),
3984 dbesc($rr['resource-id'])
3987 if (!DBM::is_result($photo_item)) {
3988 throw new InternalServerErrorException("problem with deleting items occured");
3990 drop_item($photo_item[0]['id'], false);
3993 // now let's delete all photos from the album
3994 $result = dba::delete('photo', array('uid' => api_user(), 'album' => $album));
3996 // return success of deletion or error message
3998 $answer = array('result' => 'deleted', 'message' => 'album `' . $album . '` with all containing photos has been deleted.');
3999 return api_format_data("photoalbum_delete", $type, array('$result' => $answer));
4001 throw new InternalServerErrorException("unknown error - deleting from database failed");
4006 * @brief update the name of the album for all photos of an album
4008 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4011 function api_fr_photoalbum_update($type)
4013 if (api_user() === false) {
4014 throw new ForbiddenException();
4017 $album = (x($_REQUEST, 'album') ? $_REQUEST['album'] : "");
4018 $album_new = (x($_REQUEST, 'album_new') ? $_REQUEST['album_new'] : "");
4020 // we do not allow calls without album string
4022 throw new BadRequestException("no albumname specified");
4024 if ($album_new == "") {
4025 throw new BadRequestException("no new albumname specified");
4027 // check if album is existing
4029 "SELECT `id` FROM `photo` WHERE `uid` = %d AND `album` = '%s'",
4033 if (!DBM::is_result($r)) {
4034 throw new BadRequestException("album not available");
4036 // now let's update all photos to the albumname
4038 "UPDATE `photo` SET `album` = '%s' WHERE `uid` = %d AND `album` = '%s'",
4044 // return success of updating or error message
4046 $answer = array('result' => 'updated', 'message' => 'album `' . $album . '` with all containing photos has been renamed to `' . $album_new . '`.');
4047 return api_format_data("photoalbum_update", $type, array('$result' => $answer));
4049 throw new InternalServerErrorException("unknown error - updating in database failed");
4055 * @brief list all photos of the authenticated user
4057 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4060 function api_fr_photos_list($type)
4062 if (api_user() === false) {
4063 throw new ForbiddenException();
4066 "SELECT `resource-id`, MAX(scale) AS `scale`, `album`, `filename`, `type`, MAX(`created`) AS `created`,
4067 MAX(`edited`) AS `edited`, MAX(`desc`) AS `desc` FROM `photo`
4068 WHERE `uid` = %d AND `album` != 'Contact Photos' GROUP BY `resource-id`",
4069 intval(local_user())
4072 'image/jpeg' => 'jpg',
4073 'image/png' => 'png',
4074 'image/gif' => 'gif'
4076 $data = array('photo'=>array());
4077 if (DBM::is_result($r)) {
4078 foreach ($r as $rr) {
4080 $photo['id'] = $rr['resource-id'];
4081 $photo['album'] = $rr['album'];
4082 $photo['filename'] = $rr['filename'];
4083 $photo['type'] = $rr['type'];
4084 $thumb = System::baseUrl() . "/photo/" . $rr['resource-id'] . "-" . $rr['scale'] . "." . $typetoext[$rr['type']];
4085 $photo['created'] = $rr['created'];
4086 $photo['edited'] = $rr['edited'];
4087 $photo['desc'] = $rr['desc'];
4089 if ($type == "xml") {
4090 $data['photo'][] = array("@attributes" => $photo, "1" => $thumb);
4092 $photo['thumb'] = $thumb;
4093 $data['photo'][] = $photo;
4097 return api_format_data("photos", $type, $data);
4101 * @brief upload a new photo or change an existing photo
4103 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4106 function api_fr_photo_create_update($type)
4108 if (api_user() === false) {
4109 throw new ForbiddenException();
4112 $photo_id = (x($_REQUEST, 'photo_id') ? $_REQUEST['photo_id'] : null);
4113 $desc = (x($_REQUEST, 'desc') ? $_REQUEST['desc'] : (array_key_exists('desc', $_REQUEST) ? "" : null)); // extra check necessary to distinguish between 'not provided' and 'empty string'
4114 $album = (x($_REQUEST, 'album') ? $_REQUEST['album'] : null);
4115 $album_new = (x($_REQUEST, 'album_new') ? $_REQUEST['album_new'] : null);
4116 $allow_cid = (x($_REQUEST, 'allow_cid') ? $_REQUEST['allow_cid'] : (array_key_exists('allow_cid', $_REQUEST) ? " " : null));
4117 $deny_cid = (x($_REQUEST, 'deny_cid') ? $_REQUEST['deny_cid'] : (array_key_exists('deny_cid', $_REQUEST) ? " " : null));
4118 $allow_gid = (x($_REQUEST, 'allow_gid') ? $_REQUEST['allow_gid'] : (array_key_exists('allow_gid', $_REQUEST) ? " " : null));
4119 $deny_gid = (x($_REQUEST, 'deny_gid') ? $_REQUEST['deny_gid'] : (array_key_exists('deny_gid', $_REQUEST) ? " " : null));
4120 $visibility = (x($_REQUEST, 'visibility') ? (($_REQUEST['visibility'] == "true" || $_REQUEST['visibility'] == 1) ? true : false) : false);
4122 // do several checks on input parameters
4123 // we do not allow calls without album string
4124 if ($album == null) {
4125 throw new BadRequestException("no albumname specified");
4127 // if photo_id == null --> we are uploading a new photo
4128 if ($photo_id == null) {
4131 // error if no media posted in create-mode
4132 if (!x($_FILES, 'media')) {
4134 throw new BadRequestException("no media data submitted");
4137 // album_new will be ignored in create-mode
4142 // check if photo is existing in database
4144 "SELECT `id` FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s' AND `album` = '%s'",
4149 if (!DBM::is_result($r)) {
4150 throw new BadRequestException("photo not available");
4154 // checks on acl strings provided by clients
4155 $acl_input_error = false;
4156 $acl_input_error |= check_acl_input($allow_cid);
4157 $acl_input_error |= check_acl_input($deny_cid);
4158 $acl_input_error |= check_acl_input($allow_gid);
4159 $acl_input_error |= check_acl_input($deny_gid);
4160 if ($acl_input_error) {
4161 throw new BadRequestException("acl data invalid");
4163 // now let's upload the new media in create-mode
4164 if ($mode == "create") {
4165 $media = $_FILES['media'];
4166 $data = save_media_to_database("photo", $media, $type, $album, trim($allow_cid), trim($deny_cid), trim($allow_gid), trim($deny_gid), $desc, $visibility);
4168 // return success of updating or error message
4169 if (!is_null($data)) {
4170 return api_format_data("photo_create", $type, $data);
4172 throw new InternalServerErrorException("unknown error - uploading photo failed, see Friendica log for more information");
4176 // now let's do the changes in update-mode
4177 if ($mode == "update") {
4180 if (!is_null($desc)) {
4181 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`desc` = '$desc'";
4184 if (!is_null($album_new)) {
4185 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`album` = '$album_new'";
4188 if (!is_null($allow_cid)) {
4189 $allow_cid = trim($allow_cid);
4190 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`allow_cid` = '$allow_cid'";
4193 if (!is_null($deny_cid)) {
4194 $deny_cid = trim($deny_cid);
4195 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`deny_cid` = '$deny_cid'";
4198 if (!is_null($allow_gid)) {
4199 $allow_gid = trim($allow_gid);
4200 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`allow_gid` = '$allow_gid'";
4203 if (!is_null($deny_gid)) {
4204 $deny_gid = trim($deny_gid);
4205 $sql_extra .= (($sql_extra != "") ? " ," : "") . "`deny_gid` = '$deny_gid'";
4209 if ($sql_extra != "") {
4210 $nothingtodo = false;
4212 "UPDATE `photo` SET %s, `edited`='%s' WHERE `uid` = %d AND `resource-id` = '%s' AND `album` = '%s'",
4214 datetime_convert(), // update edited timestamp
4220 $nothingtodo = true;
4223 if (x($_FILES, 'media')) {
4224 $nothingtodo = false;
4225 $media = $_FILES['media'];
4226 $data = save_media_to_database("photo", $media, $type, $album, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $desc, 0, $visibility, $photo_id);
4227 if (!is_null($data)) {
4228 return api_format_data("photo_update", $type, $data);
4232 // return success of updating or error message
4234 $answer = array('result' => 'updated', 'message' => 'Image id `' . $photo_id . '` has been updated.');
4235 return api_format_data("photo_update", $type, array('$result' => $answer));
4238 $answer = array('result' => 'cancelled', 'message' => 'Nothing to update for image id `' . $photo_id . '`.');
4239 return api_format_data("photo_update", $type, array('$result' => $answer));
4241 throw new InternalServerErrorException("unknown error - update photo entry in database failed");
4244 throw new InternalServerErrorException("unknown error - this error on uploading or updating a photo should never happen");
4249 * @brief delete a single photo from the database through api
4251 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4254 function api_fr_photo_delete($type)
4256 if (api_user() === false) {
4257 throw new ForbiddenException();
4260 $photo_id = (x($_REQUEST, 'photo_id') ? $_REQUEST['photo_id'] : null);
4262 // do several checks on input parameters
4263 // we do not allow calls without photo id
4264 if ($photo_id == null) {
4265 throw new BadRequestException("no photo_id specified");
4267 // check if photo is existing in database
4269 "SELECT `id` FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s'",
4273 if (!DBM::is_result($r)) {
4274 throw new BadRequestException("photo not available");
4276 // now we can perform on the deletion of the photo
4277 $result = dba::delete('photo', array('uid' => api_user(), 'resource-id' => $photo_id));
4279 // return success of deletion or error message
4281 // retrieve the id of the parent element (the photo element)
4283 "SELECT `id` FROM `item` WHERE `uid` = %d AND `resource-id` = '%s' AND `type` = 'photo'",
4284 intval(local_user()),
4288 if (!DBM::is_result($photo_item)) {
4289 throw new InternalServerErrorException("problem with deleting items occured");
4291 // function for setting the items to "deleted = 1" which ensures that comments, likes etc. are not shown anymore
4292 // to the user and the contacts of the users (drop_items() do all the necessary magic to avoid orphans in database and federate deletion)
4293 drop_item($photo_item[0]['id'], false);
4295 $answer = array('result' => 'deleted', 'message' => 'photo with id `' . $photo_id . '` has been deleted from server.');
4296 return api_format_data("photo_delete", $type, array('$result' => $answer));
4298 throw new InternalServerErrorException("unknown error on deleting photo from database table");
4304 * @brief returns the details of a specified photo id, if scale is given, returns the photo data in base 64
4306 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4307 * @return string|array
4309 function api_fr_photo_detail($type)
4311 if (api_user() === false) {
4312 throw new ForbiddenException();
4314 if (!x($_REQUEST, 'photo_id')) {
4315 throw new BadRequestException("No photo id.");
4318 $scale = (x($_REQUEST, 'scale') ? intval($_REQUEST['scale']) : false);
4319 $photo_id = $_REQUEST['photo_id'];
4321 // prepare json/xml output with data from database for the requested photo
4322 $data = prepare_photo_data($type, $scale, $photo_id);
4324 return api_format_data("photo_detail", $type, $data);
4329 * Updates the user’s profile image.
4331 * @brief updates the profile image for the user (either a specified profile or the default profile)
4333 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4336 * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_image
4338 function api_account_update_profile_image($type)
4340 if (api_user() === false) {
4341 throw new ForbiddenException();
4344 $profileid = defaults($_REQUEST, 'profile_id', 0);
4346 // error if image data is missing
4347 if (!x($_FILES, 'image')) {
4348 throw new BadRequestException("no media data submitted");
4351 // check if specified profile id is valid
4352 if ($profileid != 0) {
4354 "SELECT `id` FROM `profile` WHERE `uid` = %d AND `id` = %d",
4358 // error message if specified profile id is not in database
4359 if (!DBM::is_result($r)) {
4360 throw new BadRequestException("profile_id not available");
4362 $is_default_profile = $r['profile'];
4364 $is_default_profile = 1;
4367 // get mediadata from image or media (Twitter call api/account/update_profile_image provides image)
4369 if (x($_FILES, 'image')) {
4370 $media = $_FILES['image'];
4371 } elseif (x($_FILES, 'media')) {
4372 $media = $_FILES['media'];
4374 // save new profile image
4375 $data = save_media_to_database("profileimage", $media, $type, t('Profile Photos'), "", "", "", "", "", $is_default_profile);
4378 if (is_array($media['type'])) {
4379 $filetype = $media['type'][0];
4381 $filetype = $media['type'];
4383 if ($filetype == "image/jpeg") {
4385 } elseif ($filetype == "image/png") {
4388 // change specified profile or all profiles to the new resource-id
4389 if ($is_default_profile) {
4391 "UPDATE `photo` SET `profile` = 0 WHERE `profile` = 1 AND `resource-id` != '%s' AND `uid` = %d",
4392 dbesc($data['photo']['id']),
4393 intval(local_user())
4397 "UPDATE `contact` SET `photo` = '%s', `thumb` = '%s', `micro` = '%s' WHERE `self` AND `uid` = %d",
4398 dbesc(System::baseUrl() . '/photo/' . $data['photo']['id'] . '-4.' . $fileext),
4399 dbesc(System::baseUrl() . '/photo/' . $data['photo']['id'] . '-5.' . $fileext),
4400 dbesc(System::baseUrl() . '/photo/' . $data['photo']['id'] . '-6.' . $fileext),
4401 intval(local_user())
4405 "UPDATE `profile` SET `photo` = '%s', `thumb` = '%s' WHERE `id` = %d AND `uid` = %d",
4406 dbesc(System::baseUrl() . '/photo/' . $data['photo']['id'] . '-4.' . $filetype),
4407 dbesc(System::baseUrl() . '/photo/' . $data['photo']['id'] . '-5.' . $filetype),
4408 intval($_REQUEST['profile']),
4409 intval(local_user())
4413 // we'll set the updated profile-photo timestamp even if it isn't the default profile,
4414 // so that browsers will do a cache update unconditionally
4417 "UPDATE `contact` SET `avatar-date` = '%s' WHERE `self` = 1 AND `uid` = %d",
4418 dbesc(datetime_convert()),
4419 intval(local_user())
4422 // Update global directory in background
4423 //$user = api_get_user(get_app());
4424 $url = System::baseUrl() . '/profile/' . get_app()->user['nickname'];
4425 if ($url && strlen(Config::get('system', 'directory'))) {
4426 Worker::add(PRIORITY_LOW, "Directory", $url);
4429 Worker::add(PRIORITY_LOW, 'ProfileUpdate', api_user());
4431 // output for client
4433 return api_account_verify_credentials($type);
4435 // SaveMediaToDatabase failed for some reason
4436 throw new InternalServerErrorException("image upload failed");
4440 // place api-register for photoalbum calls before 'api/friendica/photo', otherwise this function is never reached
4441 api_register_func('api/friendica/photoalbum/delete', 'api_fr_photoalbum_delete', true, API_METHOD_DELETE);
4442 api_register_func('api/friendica/photoalbum/update', 'api_fr_photoalbum_update', true, API_METHOD_POST);
4443 api_register_func('api/friendica/photos/list', 'api_fr_photos_list', true);
4444 api_register_func('api/friendica/photo/create', 'api_fr_photo_create_update', true, API_METHOD_POST);
4445 api_register_func('api/friendica/photo/update', 'api_fr_photo_create_update', true, API_METHOD_POST);
4446 api_register_func('api/friendica/photo/delete', 'api_fr_photo_delete', true, API_METHOD_DELETE);
4447 api_register_func('api/friendica/photo', 'api_fr_photo_detail', true);
4448 api_register_func('api/account/update_profile_image', 'api_account_update_profile_image', true, API_METHOD_POST);
4451 * Update user profile
4453 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
4455 * @return array|string
4457 function api_account_update_profile($type)
4459 $local_user = api_user();
4460 $api_user = api_get_user(get_app());
4462 if (!empty($_POST['name'])) {
4463 dba::update('profile', ['name' => $_POST['name']], ['uid' => $local_user]);
4464 dba::update('user', ['username' => $_POST['name']], ['uid' => $local_user]);
4465 dba::update('contact', ['name' => $_POST['name']], ['uid' => $local_user, 'self' => 1]);
4466 dba::update('contact', ['name' => $_POST['name']], ['id' => $api_user['id']]);
4469 if (isset($_POST['description'])) {
4470 dba::update('profile', ['about' => $_POST['description']], ['uid' => $local_user]);
4471 dba::update('contact', ['about' => $_POST['description']], ['uid' => $local_user, 'self' => 1]);
4472 dba::update('contact', ['about' => $_POST['description']], ['id' => $api_user['id']]);
4475 Worker::add(PRIORITY_LOW, 'ProfileUpdate', $local_user);
4476 // Update global directory in background
4477 if ($api_user['url'] && strlen(Config::get('system', 'directory'))) {
4478 Worker::add(PRIORITY_LOW, "Directory", $api_user['url']);
4481 return api_account_verify_credentials($type);
4484 /// @TODO move to top of file or somewhere better
4485 api_register_func('api/account/update_profile', 'api_account_update_profile', true, API_METHOD_POST);
4489 * @param string $acl_string
4491 function check_acl_input($acl_string)
4493 if ($acl_string == null || $acl_string == " ") {
4496 $contact_not_found = false;
4498 // split <x><y><z> into array of cid's
4499 preg_match_all("/<[A-Za-z0-9]+>/", $acl_string, $array);
4501 // check for each cid if it is available on server
4502 $cid_array = $array[0];
4503 foreach ($cid_array as $cid) {
4504 $cid = str_replace("<", "", $cid);
4505 $cid = str_replace(">", "", $cid);
4507 "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
4511 $contact_not_found |= !DBM::is_result($contact);
4513 return $contact_not_found;
4518 * @param string $mediatype
4519 * @param array $media
4520 * @param string $type
4521 * @param string $album
4522 * @param string $allow_cid
4523 * @param string $deny_cid
4524 * @param string $allow_gid
4525 * @param string $deny_gid
4526 * @param string $desc
4527 * @param integer $profile
4528 * @param boolean $visibility
4529 * @param string $photo_id
4531 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)
4539 if (is_array($media)) {
4540 if (is_array($media['tmp_name'])) {
4541 $src = $media['tmp_name'][0];
4543 $src = $media['tmp_name'];
4545 if (is_array($media['name'])) {
4546 $filename = basename($media['name'][0]);
4548 $filename = basename($media['name']);
4550 if (is_array($media['size'])) {
4551 $filesize = intval($media['size'][0]);
4553 $filesize = intval($media['size']);
4555 if (is_array($media['type'])) {
4556 $filetype = $media['type'][0];
4558 $filetype = $media['type'];
4562 if ($filetype == "") {
4563 $filetype=Image::guessType($filename);
4565 $imagedata = getimagesize($src);
4567 $filetype = $imagedata['mime'];
4570 "File upload src: " . $src . " - filename: " . $filename .
4571 " - size: " . $filesize . " - type: " . $filetype,
4575 // check if there was a php upload error
4576 if ($filesize == 0 && $media['error'] == 1) {
4577 throw new InternalServerErrorException("image size exceeds PHP config settings, file was rejected by server");
4579 // check against max upload size within Friendica instance
4580 $maximagesize = Config::get('system', 'maximagesize');
4581 if ($maximagesize && ($filesize > $maximagesize)) {
4582 $formattedBytes = formatBytes($maximagesize);
4583 throw new InternalServerErrorException("image size exceeds Friendica config setting (uploaded size: $formattedBytes)");
4586 // create Photo instance with the data of the image
4587 $imagedata = @file_get_contents($src);
4588 $Image = new Image($imagedata, $filetype);
4589 if (! $Image->isValid()) {
4590 throw new InternalServerErrorException("unable to process image data");
4593 // check orientation of image
4594 $Image->orient($src);
4597 // check max length of images on server
4598 $max_length = Config::get('system', 'max_image_length');
4599 if (! $max_length) {
4600 $max_length = MAX_IMAGE_LENGTH;
4602 if ($max_length > 0) {
4603 $Image->scaleDown($max_length);
4604 logger("File upload: Scaling picture to new size " . $max_length, LOGGER_DEBUG);
4606 $width = $Image->getWidth();
4607 $height = $Image->getHeight();
4609 // create a new resource-id if not already provided
4610 $hash = ($photo_id == null) ? photo_new_resource() : $photo_id;
4612 if ($mediatype == "photo") {
4613 // upload normal image (scales 0, 1, 2)
4614 logger("photo upload: starting new photo upload", LOGGER_DEBUG);
4616 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 0, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4618 logger("photo upload: image upload with scale 0 (original size) failed");
4620 if ($width > 640 || $height > 640) {
4621 $Image->scaleDown(640);
4622 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 1, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4624 logger("photo upload: image upload with scale 1 (640x640) failed");
4628 if ($width > 320 || $height > 320) {
4629 $Image->scaleDown(320);
4630 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 2, 0, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4632 logger("photo upload: image upload with scale 2 (320x320) failed");
4635 logger("photo upload: new photo upload ended", LOGGER_DEBUG);
4636 } elseif ($mediatype == "profileimage") {
4637 // upload profile image (scales 4, 5, 6)
4638 logger("photo upload: starting new profile image upload", LOGGER_DEBUG);
4640 if ($width > 175 || $height > 175) {
4641 $Image->scaleDown(175);
4642 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 4, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4644 logger("photo upload: profile image upload with scale 4 (175x175) failed");
4648 if ($width > 80 || $height > 80) {
4649 $Image->scaleDown(80);
4650 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 5, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4652 logger("photo upload: profile image upload with scale 5 (80x80) failed");
4656 if ($width > 48 || $height > 48) {
4657 $Image->scaleDown(48);
4658 $r = Photo::store($Image, local_user(), $visitor, $hash, $filename, $album, 6, $profile, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
4660 logger("photo upload: profile image upload with scale 6 (48x48) failed");
4663 $Image->__destruct();
4664 logger("photo upload: new profile image upload ended", LOGGER_DEBUG);
4668 // create entry in 'item'-table on new uploads to enable users to comment/like/dislike the photo
4669 if ($photo_id == null && $mediatype == "photo") {
4670 post_photo_item($hash, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility);
4672 // on success return image data in json/xml format (like /api/friendica/photo does when no scale is given)
4673 return prepare_photo_data($type, false, $hash);
4675 throw new InternalServerErrorException("image upload failed");
4681 * @param string $hash
4682 * @param string $allow_cid
4683 * @param string $deny_cid
4684 * @param string $allow_gid
4685 * @param string $deny_gid
4686 * @param string $filetype
4687 * @param boolean $visibility
4689 function post_photo_item($hash, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility = false)
4691 // get data about the api authenticated user
4692 $uri = item_new_uri(get_app()->get_hostname(), intval(api_user()));
4693 $owner_record = q("SELECT * FROM `contact` WHERE `uid`= %d AND `self` LIMIT 1", intval(api_user()));
4696 $arr['guid'] = get_guid(32);
4697 $arr['uid'] = intval(api_user());
4699 $arr['parent-uri'] = $uri;
4700 $arr['type'] = 'photo';
4702 $arr['resource-id'] = $hash;
4703 $arr['contact-id'] = $owner_record[0]['id'];
4704 $arr['owner-name'] = $owner_record[0]['name'];
4705 $arr['owner-link'] = $owner_record[0]['url'];
4706 $arr['owner-avatar'] = $owner_record[0]['thumb'];
4707 $arr['author-name'] = $owner_record[0]['name'];
4708 $arr['author-link'] = $owner_record[0]['url'];
4709 $arr['author-avatar'] = $owner_record[0]['thumb'];
4711 $arr['allow_cid'] = $allow_cid;
4712 $arr['allow_gid'] = $allow_gid;
4713 $arr['deny_cid'] = $deny_cid;
4714 $arr['deny_gid'] = $deny_gid;
4715 $arr['last-child'] = 1;
4716 $arr['visible'] = $visibility;
4720 'image/jpeg' => 'jpg',
4721 'image/png' => 'png',
4722 'image/gif' => 'gif'
4725 // adds link to the thumbnail scale photo
4726 $arr['body'] = '[url=' . System::baseUrl() . '/photos/' . $owner_record[0]['nick'] . '/image/' . $hash . ']'
4727 . '[img]' . System::baseUrl() . '/photo/' . $hash . '-' . "2" . '.'. $typetoext[$filetype] . '[/img]'
4730 // do the magic for storing the item in the database and trigger the federation to other contacts
4736 * @param string $type
4738 * @param string $photo_id
4742 function prepare_photo_data($type, $scale, $photo_id)
4744 $scale_sql = ($scale === false ? "" : sprintf("AND scale=%d", intval($scale)));
4745 $data_sql = ($scale === false ? "" : "data, ");
4747 // added allow_cid, allow_gid, deny_cid, deny_gid to output as string like stored in database
4748 // clients needs to convert this in their way for further processing
4750 "SELECT %s `resource-id`, `created`, `edited`, `title`, `desc`, `album`, `filename`,
4751 `type`, `height`, `width`, `datasize`, `profile`, `allow_cid`, `deny_cid`, `allow_gid`, `deny_gid`,
4752 MIN(`scale`) AS `minscale`, MAX(`scale`) AS `maxscale`
4753 FROM `photo` WHERE `uid` = %d AND `resource-id` = '%s' %s GROUP BY `resource-id`",
4755 intval(local_user()),
4761 'image/jpeg' => 'jpg',
4762 'image/png' => 'png',
4763 'image/gif' => 'gif'
4766 // prepare output data for photo
4767 if (DBM::is_result($r)) {
4768 $data = array('photo' => $r[0]);
4769 $data['photo']['id'] = $data['photo']['resource-id'];
4770 if ($scale !== false) {
4771 $data['photo']['data'] = base64_encode($data['photo']['data']);
4773 unset($data['photo']['datasize']); //needed only with scale param
4775 if ($type == "xml") {
4776 $data['photo']['links'] = array();
4777 for ($k = intval($data['photo']['minscale']); $k <= intval($data['photo']['maxscale']); $k++) {
4778 $data['photo']['links'][$k . ":link"]["@attributes"] = array("type" => $data['photo']['type'],
4780 "href" => System::baseUrl() . "/photo/" . $data['photo']['resource-id'] . "-" . $k . "." . $typetoext[$data['photo']['type']]);
4783 $data['photo']['link'] = array();
4784 // when we have profile images we could have only scales from 4 to 6, but index of array always needs to start with 0
4786 for ($k = intval($data['photo']['minscale']); $k <= intval($data['photo']['maxscale']); $k++) {
4787 $data['photo']['link'][$i] = System::baseUrl() . "/photo/" . $data['photo']['resource-id'] . "-" . $k . "." . $typetoext[$data['photo']['type']];
4791 unset($data['photo']['resource-id']);
4792 unset($data['photo']['minscale']);
4793 unset($data['photo']['maxscale']);
4795 throw new NotFoundException();
4798 // retrieve item element for getting activities (like, dislike etc.) related to photo
4800 "SELECT * FROM `item` WHERE `uid` = %d AND `resource-id` = '%s' AND `type` = 'photo'",
4801 intval(local_user()),
4804 $data['photo']['friendica_activities'] = api_format_items_activities($item[0], $type);
4806 // retrieve comments on photo
4808 "SELECT `item`.*, `item`.`id` AS `item_id`, `item`.`network` AS `item_network`,
4809 `contact`.`name`, `contact`.`photo`, `contact`.`url`, `contact`.`rel`,
4810 `contact`.`network`, `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
4811 `contact`.`id` AS `cid`
4813 STRAIGHT_JOIN `contact` ON `contact`.`id` = `item`.`contact-id` AND `contact`.`uid` = `item`.`uid`
4814 AND (NOT `contact`.`blocked` OR `contact`.`pending`)
4815 WHERE `item`.`parent` = %d AND `item`.`visible`
4816 AND NOT `item`.`moderated` AND NOT `item`.`deleted`
4817 AND `item`.`uid` = %d AND (`item`.`verb`='%s' OR `type`='photo')",
4818 intval($item[0]['parent']),
4820 dbesc(ACTIVITY_POST)
4823 // prepare output of comments
4824 $commentData = api_format_items($r, api_get_user(get_app()), false, $type);
4825 $comments = array();
4826 if ($type == "xml") {
4828 foreach ($commentData as $comment) {
4829 $comments[$k++ . ":comment"] = $comment;
4832 foreach ($commentData as $comment) {
4833 $comments[] = $comment;
4836 $data['photo']['friendica_comments'] = $comments;
4838 // include info if rights on photo and rights on item are mismatching
4839 $rights_mismatch = $data['photo']['allow_cid'] != $item[0]['allow_cid'] ||
4840 $data['photo']['deny_cid'] != $item[0]['deny_cid'] ||
4841 $data['photo']['allow_gid'] != $item[0]['allow_gid'] ||
4842 $data['photo']['deny_cid'] != $item[0]['deny_cid'];
4843 $data['photo']['rights_mismatch'] = $rights_mismatch;
4850 * Similar as /mod/redir.php
4851 * redirect to 'url' after dfrn auth
4853 * Why this when there is mod/redir.php already?
4854 * This use api_user() and api_login()
4857 * c_url: url of remote contact to auth to
4858 * url: string, url to redirect after auth
4860 function api_friendica_remoteauth()
4862 $url = (x($_GET, 'url') ? $_GET['url'] : '');
4863 $c_url = (x($_GET, 'c_url') ? $_GET['c_url'] : '');
4865 if ($url === '' || $c_url === '') {
4866 throw new BadRequestException("Wrong parameters.");
4869 $c_url = normalise_link($c_url);
4873 $r = dba::selectFirst('contact', [], ['uid' => api_user(), 'nurl' => $c_url]);
4875 if (!DBM::is_result($r) || ($r['network'] !== NETWORK_DFRN)) {
4876 throw new BadRequestException("Unknown contact");
4881 $dfrn_id = defaults($r, 'issued-id', $r['dfrn-id']);
4883 if ($r['duplex'] && $r['issued-id']) {
4884 $orig_id = $r['issued-id'];
4885 $dfrn_id = '1:' . $orig_id;
4887 if ($r['duplex'] && $r['dfrn-id']) {
4888 $orig_id = $r['dfrn-id'];
4889 $dfrn_id = '0:' . $orig_id;
4892 $sec = random_string();
4895 "INSERT INTO `profile_check` ( `uid`, `cid`, `dfrn_id`, `sec`, `expire`)
4896 VALUES( %d, %s, '%s', '%s', %d )",
4904 logger($r['name'] . ' ' . $sec, LOGGER_DEBUG);
4905 $dest = ($url ? '&destination_url=' . $url : '');
4907 $r['poll'] . '?dfrn_id=' . $dfrn_id
4908 . '&dfrn_version=' . DFRN_PROTOCOL_VERSION
4909 . '&type=profile&sec=' . $sec . $dest . $quiet
4912 api_register_func('api/friendica/remoteauth', 'api_friendica_remoteauth', true);
4915 * @brief Return the item shared, if the item contains only the [share] tag
4917 * @param array $item Sharer item
4918 * @return array|false Shared item or false if not a reshare
4920 function api_share_as_retweet(&$item)
4922 $body = trim($item["body"]);
4924 if (Diaspora::isReshare($body, false)===false) {
4928 /// @TODO "$1" should maybe mean '$1' ?
4929 $attributes = preg_replace("/\[share(.*?)\]\s?(.*?)\s?\[\/share\]\s?/ism", "$1", $body);
4931 * Skip if there is no shared message in there
4932 * we already checked this in diaspora::isReshare()
4933 * but better one more than one less...
4935 if ($body == $attributes) {
4940 // build the fake reshared item
4941 $reshared_item = $item;
4944 preg_match("/author='(.*?)'/ism", $attributes, $matches);
4945 if ($matches[1] != "") {
4946 $author = html_entity_decode($matches[1], ENT_QUOTES, 'UTF-8');
4949 preg_match('/author="(.*?)"/ism', $attributes, $matches);
4950 if ($matches[1] != "") {
4951 $author = $matches[1];
4955 preg_match("/profile='(.*?)'/ism", $attributes, $matches);
4956 if ($matches[1] != "") {
4957 $profile = $matches[1];
4960 preg_match('/profile="(.*?)"/ism', $attributes, $matches);
4961 if ($matches[1] != "") {
4962 $profile = $matches[1];
4966 preg_match("/avatar='(.*?)'/ism", $attributes, $matches);
4967 if ($matches[1] != "") {
4968 $avatar = $matches[1];
4971 preg_match('/avatar="(.*?)"/ism', $attributes, $matches);
4972 if ($matches[1] != "") {
4973 $avatar = $matches[1];
4977 preg_match("/link='(.*?)'/ism", $attributes, $matches);
4978 if ($matches[1] != "") {
4979 $link = $matches[1];
4982 preg_match('/link="(.*?)"/ism', $attributes, $matches);
4983 if ($matches[1] != "") {
4984 $link = $matches[1];
4988 preg_match("/posted='(.*?)'/ism", $attributes, $matches);
4989 if ($matches[1] != "") {
4990 $posted = $matches[1];
4993 preg_match('/posted="(.*?)"/ism', $attributes, $matches);
4994 if ($matches[1] != "") {
4995 $posted = $matches[1];
4998 $shared_body = preg_replace("/\[share(.*?)\]\s?(.*?)\s?\[\/share\]\s?/ism", "$2", $body);
5000 if (($shared_body == "") || ($profile == "") || ($author == "") || ($avatar == "") || ($posted == "")) {
5004 $reshared_item["body"] = $shared_body;
5005 $reshared_item["author-name"] = $author;
5006 $reshared_item["author-link"] = $profile;
5007 $reshared_item["author-avatar"] = $avatar;
5008 $reshared_item["plink"] = $link;
5009 $reshared_item["created"] = $posted;
5010 $reshared_item["edited"] = $posted;
5012 return $reshared_item;
5017 * @param string $profile
5019 * @return string|false
5020 * @todo remove trailing junk from profile url
5021 * @todo pump.io check has to check the website
5023 function api_get_nick($profile)
5028 "SELECT `nick` FROM `contact` WHERE `uid` = 0 AND `nurl` = '%s'",
5029 dbesc(normalise_link($profile))
5032 if (DBM::is_result($r)) {
5033 $nick = $r[0]["nick"];
5038 "SELECT `nick` FROM `contact` WHERE `uid` = 0 AND `nurl` = '%s'",
5039 dbesc(normalise_link($profile))
5042 if (DBM::is_result($r)) {
5043 $nick = $r[0]["nick"];
5048 $friendica = preg_replace("=https?://(.*)/profile/(.*)=ism", "$2", $profile);
5049 if ($friendica != $profile) {
5055 $diaspora = preg_replace("=https?://(.*)/u/(.*)=ism", "$2", $profile);
5056 if ($diaspora != $profile) {
5062 $twitter = preg_replace("=https?://twitter.com/(.*)=ism", "$1", $profile);
5063 if ($twitter != $profile) {
5070 $StatusnetHost = preg_replace("=https?://(.*)/user/(.*)=ism", "$1", $profile);
5071 if ($StatusnetHost != $profile) {
5072 $StatusnetUser = preg_replace("=https?://(.*)/user/(.*)=ism", "$2", $profile);
5073 if ($StatusnetUser != $profile) {
5074 $UserData = fetch_url("http://".$StatusnetHost."/api/users/show.json?user_id=".$StatusnetUser);
5075 $user = json_decode($UserData);
5077 $nick = $user->screen_name;
5083 // To-Do: look at the page if its really a pumpio site
5084 //if (!$nick == "") {
5085 // $pumpio = preg_replace("=https?://(.*)/(.*)/=ism", "$2", $profile."/");
5086 // if ($pumpio != $profile)
5088 // <div class="media" id="profile-block" data-profile-id="acct:kabniel@microca.st">
5101 * @param array $item
5105 function api_in_reply_to($item)
5107 $in_reply_to = array();
5109 $in_reply_to['status_id'] = null;
5110 $in_reply_to['user_id'] = null;
5111 $in_reply_to['status_id_str'] = null;
5112 $in_reply_to['user_id_str'] = null;
5113 $in_reply_to['screen_name'] = null;
5115 if (($item['thr-parent'] != $item['uri']) && (intval($item['parent']) != intval($item['id']))) {
5117 "SELECT `id` FROM `item` WHERE `uid` = %d AND `uri` = '%s' LIMIT 1",
5118 intval($item['uid']),
5119 dbesc($item['thr-parent'])
5122 if (DBM::is_result($r)) {
5123 $in_reply_to['status_id'] = intval($r[0]['id']);
5125 $in_reply_to['status_id'] = intval($item['parent']);
5128 $in_reply_to['status_id_str'] = (string) intval($in_reply_to['status_id']);
5131 "SELECT `contact`.`nick`, `contact`.`name`, `contact`.`id`, `contact`.`url` FROM item
5132 STRAIGHT_JOIN `contact` ON `contact`.`id` = `item`.`author-id`
5133 WHERE `item`.`id` = %d LIMIT 1",
5134 intval($in_reply_to['status_id'])
5137 if (DBM::is_result($r)) {
5138 if ($r[0]['nick'] == "") {
5139 $r[0]['nick'] = api_get_nick($r[0]["url"]);
5142 $in_reply_to['screen_name'] = (($r[0]['nick']) ? $r[0]['nick'] : $r[0]['name']);
5143 $in_reply_to['user_id'] = intval($r[0]['id']);
5144 $in_reply_to['user_id_str'] = (string) intval($r[0]['id']);
5147 // There seems to be situation, where both fields are identical:
5148 // https://github.com/friendica/friendica/issues/1010
5149 // This is a bugfix for that.
5150 if (intval($in_reply_to['status_id']) == intval($item['id'])) {
5151 logger('this message should never appear: id: '.$item['id'].' similar to reply-to: '.$in_reply_to['status_id'], LOGGER_DEBUG);
5152 $in_reply_to['status_id'] = null;
5153 $in_reply_to['user_id'] = null;
5154 $in_reply_to['status_id_str'] = null;
5155 $in_reply_to['user_id_str'] = null;
5156 $in_reply_to['screen_name'] = null;
5160 return $in_reply_to;
5165 * @param string $Text
5169 function api_clean_plain_items($Text)
5171 $include_entities = strtolower(x($_REQUEST, 'include_entities') ? $_REQUEST['include_entities'] : "false");
5173 $Text = bb_CleanPictureLinks($Text);
5174 $URLSearchString = "^\[\]";
5176 $Text = preg_replace("/([!#@])\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '$1$3', $Text);
5178 if ($include_entities == "true") {
5179 $Text = preg_replace("/\[url\=([$URLSearchString]*)\](.*?)\[\/url\]/ism", '[url=$1]$1[/url]', $Text);
5182 // Simplify "attachment" element
5183 $Text = api_clean_attachments($Text);
5189 * @brief Removes most sharing information for API text export
5191 * @param string $body The original body
5193 * @return string Cleaned body
5195 function api_clean_attachments($body)
5197 $data = get_attachment_data($body);
5204 if (isset($data["text"])) {
5205 $body = $data["text"];
5207 if (($body == "") && isset($data["title"])) {
5208 $body = $data["title"];
5210 if (isset($data["url"])) {
5211 $body .= "\n".$data["url"];
5213 $body .= $data["after"];
5220 * @param array $contacts
5224 function api_best_nickname(&$contacts)
5226 $best_contact = array();
5228 if (count($contact) == 0) {
5232 foreach ($contacts as $contact) {
5233 if ($contact["network"] == "") {
5234 $contact["network"] = "dfrn";
5235 $best_contact = array($contact);
5239 if (sizeof($best_contact) == 0) {
5240 foreach ($contacts as $contact) {
5241 if ($contact["network"] == "dfrn") {
5242 $best_contact = array($contact);
5247 if (sizeof($best_contact) == 0) {
5248 foreach ($contacts as $contact) {
5249 if ($contact["network"] == "dspr") {
5250 $best_contact = array($contact);
5255 if (sizeof($best_contact) == 0) {
5256 foreach ($contacts as $contact) {
5257 if ($contact["network"] == "stat") {
5258 $best_contact = array($contact);
5263 if (sizeof($best_contact) == 0) {
5264 foreach ($contacts as $contact) {
5265 if ($contact["network"] == "pump") {
5266 $best_contact = array($contact);
5271 if (sizeof($best_contact) == 0) {
5272 foreach ($contacts as $contact) {
5273 if ($contact["network"] == "twit") {
5274 $best_contact = array($contact);
5279 if (sizeof($best_contact) == 1) {
5280 $contacts = $best_contact;
5282 $contacts = array($contacts[0]);
5287 * Return all or a specified group of the user with the containing contacts.
5289 * @param string $type Return type (atom, rss, xml, json)
5291 * @return array|string
5293 function api_friendica_group_show($type)
5297 if (api_user() === false) {
5298 throw new ForbiddenException();
5302 $user_info = api_get_user($a);
5303 $gid = (x($_REQUEST, 'gid') ? $_REQUEST['gid'] : 0);
5304 $uid = $user_info['uid'];
5306 // get data of the specified group id or all groups if not specified
5309 "SELECT * FROM `group` WHERE `deleted` = 0 AND `uid` = %d AND `id` = %d",
5313 // error message if specified gid is not in database
5314 if (!DBM::is_result($r)) {
5315 throw new BadRequestException("gid not available");
5319 "SELECT * FROM `group` WHERE `deleted` = 0 AND `uid` = %d",
5324 // loop through all groups and retrieve all members for adding data in the user array
5325 foreach ($r as $rr) {
5326 $members = Contact::getByGroupId($rr['id']);
5329 if ($type == "xml") {
5330 $user_element = "users";
5332 foreach ($members as $member) {
5333 $user = api_get_user($a, $member['nurl']);
5334 $users[$k++.":user"] = $user;
5337 $user_element = "user";
5338 foreach ($members as $member) {
5339 $user = api_get_user($a, $member['nurl']);
5343 $grps[] = array('name' => $rr['name'], 'gid' => $rr['id'], $user_element => $users);
5345 return api_format_data("groups", $type, array('group' => $grps));
5347 api_register_func('api/friendica/group_show', 'api_friendica_group_show', true);
5351 * Delete the specified group of the user.
5353 * @param string $type Return type (atom, rss, xml, json)
5355 * @return array|string
5357 function api_friendica_group_delete($type)
5361 if (api_user() === false) {
5362 throw new ForbiddenException();
5366 $user_info = api_get_user($a);
5367 $gid = (x($_REQUEST, 'gid') ? $_REQUEST['gid'] : 0);
5368 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5369 $uid = $user_info['uid'];
5371 // error if no gid specified
5372 if ($gid == 0 || $name == "") {
5373 throw new BadRequestException('gid or name not specified');
5376 // get data of the specified group id
5378 "SELECT * FROM `group` WHERE `uid` = %d AND `id` = %d",
5382 // error message if specified gid is not in database
5383 if (!DBM::is_result($r)) {
5384 throw new BadRequestException('gid not available');
5387 // get data of the specified group id and group name
5389 "SELECT * FROM `group` WHERE `uid` = %d AND `id` = %d AND `name` = '%s'",
5394 // error message if specified gid is not in database
5395 if (!DBM::is_result($rname)) {
5396 throw new BadRequestException('wrong group name');
5400 $ret = Group::removeByName($uid, $name);
5403 $success = array('success' => $ret, 'gid' => $gid, 'name' => $name, 'status' => 'deleted', 'wrong users' => array());
5404 return api_format_data("group_delete", $type, array('result' => $success));
5406 throw new BadRequestException('other API error');
5409 api_register_func('api/friendica/group_delete', 'api_friendica_group_delete', true, API_METHOD_DELETE);
5413 * Create the specified group with the posted array of contacts.
5415 * @param string $type Return type (atom, rss, xml, json)
5417 * @return array|string
5419 function api_friendica_group_create($type)
5423 if (api_user() === false) {
5424 throw new ForbiddenException();
5428 $user_info = api_get_user($a);
5429 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5430 $uid = $user_info['uid'];
5431 $json = json_decode($_POST['json'], true);
5432 $users = $json['user'];
5434 // error if no name specified
5436 throw new BadRequestException('group name not specified');
5439 // get data of the specified group name
5441 "SELECT * FROM `group` WHERE `uid` = %d AND `name` = '%s' AND `deleted` = 0",
5445 // error message if specified group name already exists
5446 if (DBM::is_result($rname)) {
5447 throw new BadRequestException('group name already exists');
5450 // check if specified group name is a deleted group
5452 "SELECT * FROM `group` WHERE `uid` = %d AND `name` = '%s' AND `deleted` = 1",
5456 // error message if specified group name already exists
5457 if (DBM::is_result($rname)) {
5458 $reactivate_group = true;
5462 $ret = Group::create($uid, $name);
5464 $gid = Group::getIdByName($uid, $name);
5466 throw new BadRequestException('other API error');
5470 $erroraddinguser = false;
5471 $errorusers = array();
5472 foreach ($users as $user) {
5473 $cid = $user['cid'];
5474 // check if user really exists as contact
5476 "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
5480 if (count($contact)) {
5481 Group::addMember($gid, $cid);
5483 $erroraddinguser = true;
5484 $errorusers[] = $cid;
5488 // return success message incl. missing users in array
5489 $status = ($erroraddinguser ? "missing user" : ($reactivate_group ? "reactivated" : "ok"));
5490 $success = array('success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers);
5491 return api_format_data("group_create", $type, array('result' => $success));
5493 api_register_func('api/friendica/group_create', 'api_friendica_group_create', true, API_METHOD_POST);
5497 * Update the specified group with the posted array of contacts.
5499 * @param string $type Return type (atom, rss, xml, json)
5501 * @return array|string
5503 function api_friendica_group_update($type)
5507 if (api_user() === false) {
5508 throw new ForbiddenException();
5512 $user_info = api_get_user($a);
5513 $uid = $user_info['uid'];
5514 $gid = (x($_REQUEST, 'gid') ? $_REQUEST['gid'] : 0);
5515 $name = (x($_REQUEST, 'name') ? $_REQUEST['name'] : "");
5516 $json = json_decode($_POST['json'], true);
5517 $users = $json['user'];
5519 // error if no name specified
5521 throw new BadRequestException('group name not specified');
5524 // error if no gid specified
5526 throw new BadRequestException('gid not specified');
5530 $members = Contact::getByGroupId($gid);
5531 foreach ($members as $member) {
5532 $cid = $member['id'];
5533 foreach ($users as $user) {
5534 $found = ($user['cid'] == $cid ? true : false);
5537 Group::removeMemberByName($uid, $name, $cid);
5542 $erroraddinguser = false;
5543 $errorusers = array();
5544 foreach ($users as $user) {
5545 $cid = $user['cid'];
5546 // check if user really exists as contact
5548 "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
5553 if (count($contact)) {
5554 Group::addMember($gid, $cid);
5556 $erroraddinguser = true;
5557 $errorusers[] = $cid;
5561 // return success message incl. missing users in array
5562 $status = ($erroraddinguser ? "missing user" : "ok");
5563 $success = array('success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers);
5564 return api_format_data("group_update", $type, array('result' => $success));
5567 api_register_func('api/friendica/group_update', 'api_friendica_group_update', true, API_METHOD_POST);
5571 * @param string $type Return type (atom, rss, xml, json)
5573 * @return array|string
5575 function api_friendica_activity($type)
5579 if (api_user() === false) {
5580 throw new ForbiddenException();
5582 $verb = strtolower($a->argv[3]);
5583 $verb = preg_replace("|\..*$|", "", $verb);
5585 $id = (x($_REQUEST, 'id') ? $_REQUEST['id'] : 0);
5587 $res = do_like($id, $verb);
5590 if ($type == "xml") {
5595 return api_format_data('ok', $type, array('ok' => $ok));
5597 throw new BadRequestException('Error adding activity');
5601 /// @TODO move to top of file or somewhere better
5602 api_register_func('api/friendica/activity/like', 'api_friendica_activity', true, API_METHOD_POST);
5603 api_register_func('api/friendica/activity/dislike', 'api_friendica_activity', true, API_METHOD_POST);
5604 api_register_func('api/friendica/activity/attendyes', 'api_friendica_activity', true, API_METHOD_POST);
5605 api_register_func('api/friendica/activity/attendno', 'api_friendica_activity', true, API_METHOD_POST);
5606 api_register_func('api/friendica/activity/attendmaybe', 'api_friendica_activity', true, API_METHOD_POST);
5607 api_register_func('api/friendica/activity/unlike', 'api_friendica_activity', true, API_METHOD_POST);
5608 api_register_func('api/friendica/activity/undislike', 'api_friendica_activity', true, API_METHOD_POST);
5609 api_register_func('api/friendica/activity/unattendyes', 'api_friendica_activity', true, API_METHOD_POST);
5610 api_register_func('api/friendica/activity/unattendno', 'api_friendica_activity', true, API_METHOD_POST);
5611 api_register_func('api/friendica/activity/unattendmaybe', 'api_friendica_activity', true, API_METHOD_POST);
5614 * @brief Returns notifications
5616 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5619 function api_friendica_notification($type)
5623 if (api_user() === false) {
5624 throw new ForbiddenException();
5627 throw new BadRequestException("Invalid argument count");
5629 $nm = new NotificationsManager();
5631 $notes = $nm->getAll(array(), "+seen -date", 50);
5633 if ($type == "xml") {
5634 $xmlnotes = array();
5635 foreach ($notes as $note) {
5636 $xmlnotes[] = array("@attributes" => $note);
5642 return api_format_data("notes", $type, array('note' => $notes));
5646 * POST request with 'id' param as notification id
5648 * @brief Set notification as seen and returns associated item (if possible)
5650 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5653 function api_friendica_notification_seen($type)
5657 if (api_user() === false) {
5658 throw new ForbiddenException();
5661 throw new BadRequestException("Invalid argument count");
5664 $id = (x($_REQUEST, 'id') ? intval($_REQUEST['id']) : 0);
5666 $nm = new NotificationsManager();
5667 $note = $nm->getByID($id);
5668 if (is_null($note)) {
5669 throw new BadRequestException("Invalid argument");
5672 $nm->setSeen($note);
5673 if ($note['otype']=='item') {
5674 // would be really better with an ItemsManager and $im->getByID() :-P
5676 "SELECT * FROM `item` WHERE `id`=%d AND `uid`=%d",
5677 intval($note['iid']),
5678 intval(local_user())
5681 // we found the item, return it to the user
5682 $user_info = api_get_user($a);
5683 $ret = api_format_items($r, $user_info, false, $type);
5684 $data = array('status' => $ret);
5685 return api_format_data("status", $type, $data);
5687 // the item can't be found, but we set the note as seen, so we count this as a success
5689 return api_format_data('result', $type, array('result' => "success"));
5692 /// @TODO move to top of file or somewhere better
5693 api_register_func('api/friendica/notification/seen', 'api_friendica_notification_seen', true, API_METHOD_POST);
5694 api_register_func('api/friendica/notification', 'api_friendica_notification', true, API_METHOD_GET);
5697 * @brief update a direct_message to seen state
5699 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5700 * @return string (success result=ok, error result=error with error message)
5702 function api_friendica_direct_messages_setseen($type)
5705 if (api_user() === false) {
5706 throw new ForbiddenException();
5710 $user_info = api_get_user($a);
5711 $uid = $user_info['uid'];
5712 $id = (x($_REQUEST, 'id') ? $_REQUEST['id'] : 0);
5714 // return error if id is zero
5716 $answer = array('result' => 'error', 'message' => 'message id not specified');
5717 return api_format_data("direct_messages_setseen", $type, array('$result' => $answer));
5720 // get data of the specified message id
5722 "SELECT `id` FROM `mail` WHERE `id` = %d AND `uid` = %d",
5727 // error message if specified id is not in database
5728 if (!DBM::is_result($r)) {
5729 $answer = array('result' => 'error', 'message' => 'message id not in database');
5730 return api_format_data("direct_messages_setseen", $type, array('$result' => $answer));
5733 // update seen indicator
5735 "UPDATE `mail` SET `seen` = 1 WHERE `id` = %d AND `uid` = %d",
5742 $answer = array('result' => 'ok', 'message' => 'message set to seen');
5743 return api_format_data("direct_message_setseen", $type, array('$result' => $answer));
5745 $answer = array('result' => 'error', 'message' => 'unknown error');
5746 return api_format_data("direct_messages_setseen", $type, array('$result' => $answer));
5750 /// @TODO move to top of file or somewhere better
5751 api_register_func('api/friendica/direct_messages_setseen', 'api_friendica_direct_messages_setseen', true);
5754 * @brief search for direct_messages containing a searchstring through api
5756 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5757 * @return string (success: success=true if found and search_result contains found messages,
5758 * success=false if nothing was found, search_result='nothing found',
5759 * error: result=error with error message)
5761 function api_friendica_direct_messages_search($type)
5765 if (api_user() === false) {
5766 throw new ForbiddenException();
5770 $user_info = api_get_user($a);
5771 $searchstring = (x($_REQUEST, 'searchstring') ? $_REQUEST['searchstring'] : "");
5772 $uid = $user_info['uid'];
5774 // error if no searchstring specified
5775 if ($searchstring == "") {
5776 $answer = array('result' => 'error', 'message' => 'searchstring not specified');
5777 return api_format_data("direct_messages_search", $type, array('$result' => $answer));
5780 // get data for the specified searchstring
5782 "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",
5784 dbesc('%'.$searchstring.'%')
5787 $profile_url = $user_info["url"];
5789 // message if nothing was found
5790 if (!DBM::is_result($r)) {
5791 $success = array('success' => false, 'search_results' => 'problem with query');
5792 } elseif (count($r) == 0) {
5793 $success = array('success' => false, 'search_results' => 'nothing found');
5796 foreach ($r as $item) {
5797 if ($box == "inbox" || $item['from-url'] != $profile_url) {
5798 $recipient = $user_info;
5799 $sender = api_get_user($a, normalise_link($item['contact-url']));
5800 } elseif ($box == "sentbox" || $item['from-url'] == $profile_url) {
5801 $recipient = api_get_user($a, normalise_link($item['contact-url']));
5802 $sender = $user_info;
5805 $ret[] = api_format_messages($item, $recipient, $sender);
5807 $success = array('success' => true, 'search_results' => $ret);
5810 return api_format_data("direct_message_search", $type, array('$result' => $success));
5813 /// @TODO move to top of file or somewhere better
5814 api_register_func('api/friendica/direct_messages_search', 'api_friendica_direct_messages_search', true);
5817 * @brief return data of all the profiles a user has to the client
5819 * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
5822 function api_friendica_profile_show($type)
5826 if (api_user() === false) {
5827 throw new ForbiddenException();
5831 $profileid = (x($_REQUEST, 'profile_id') ? $_REQUEST['profile_id'] : 0);
5833 // retrieve general information about profiles for user
5834 $multi_profiles = Feature::isEnabled(api_user(), 'multi_profiles');
5835 $directory = Config::get('system', 'directory');
5837 // get data of the specified profile id or all profiles of the user if not specified
5838 if ($profileid != 0) {
5840 "SELECT * FROM `profile` WHERE `uid` = %d AND `id` = %d",
5845 // error message if specified gid is not in database
5846 if (!DBM::is_result($r)) {
5847 throw new BadRequestException("profile_id not available");
5851 "SELECT * FROM `profile` WHERE `uid` = %d",
5855 // loop through all returned profiles and retrieve data and users
5857 foreach ($r as $rr) {
5858 $profile = api_format_items_profiles($rr);
5860 // select all users from contact table, loop and prepare standard return for user data
5863 "SELECT `id`, `nurl` FROM `contact` WHERE `uid`= %d AND `profile-id` = %d",
5865 intval($rr['profile_id'])
5868 foreach ($r as $rr) {
5869 $user = api_get_user($a, $rr['nurl']);
5870 ($type == "xml") ? $users[$k++ . ":user"] = $user : $users[] = $user;
5872 $profile['users'] = $users;
5874 // add prepared profile data to array for final return
5875 if ($type == "xml") {
5876 $profiles[$k++ . ":profile"] = $profile;
5878 $profiles[] = $profile;
5882 // return settings, authenticated user and profiles data
5883 $self = q("SELECT `nurl` FROM `contact` WHERE `uid`= %d AND `self` LIMIT 1", intval(api_user()));
5885 $result = array('multi_profiles' => $multi_profiles ? true : false,
5886 'global_dir' => $directory,
5887 'friendica_owner' => api_get_user($a, $self[0]['nurl']),
5888 'profiles' => $profiles);
5889 return api_format_data("friendica_profiles", $type, array('$result' => $result));
5891 api_register_func('api/friendica/profile/show', 'api_friendica_profile_show', true, API_METHOD_GET);
5894 * Returns a list of saved searches.
5896 * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/get-saved_searches-list
5898 * @param string $type Return format: json or xml
5900 * @return string|array
5902 function api_saved_searches_list($type)
5904 $terms = dba::select('search', array('id', 'term'), array('uid' => local_user()));
5907 while ($term = $terms->fetch()) {
5909 'name' => $term['term'],
5910 'query' => $term['term'],
5911 'id_str' => $term['id'],
5912 'id' => intval($term['id'])
5918 return api_format_data("terms", $type, array('terms' => $result));
5921 /// @TODO move to top of file or somewhere better
5922 api_register_func('api/saved_searches/list', 'api_saved_searches_list', true);
5925 @TODO Maybe open to implement?
5927 [pagename] => api/1.1/statuses/lookup.json
5928 [id] => 605138389168451584
5929 [include_cards] => true
5930 [cards_platform] => Android-12
5931 [include_entities] => true
5932 [include_my_retweet] => 1
5934 [include_reply_count] => true
5935 [include_descendent_reply_count] => true
5939 Not implemented by now:
5940 statuses/retweets_of_me
5945 account/update_location
5946 account/update_profile_background_image
5949 friendica/profile/update
5950 friendica/profile/create
5951 friendica/profile/delete
5953 Not implemented in status.net:
5954 statuses/retweeted_to_me
5955 statuses/retweeted_by_me
5956 direct_messages/destroy
5958 account/update_delivery_device
5959 notifications/follow