]> git.mxchange.org Git - friendica.git/commitdiff
API: Unified request parameter handling
authorMichael <heluecht@pirati.ca>
Fri, 28 May 2021 06:10:32 +0000 (06:10 +0000)
committerMichael <heluecht@pirati.ca>
Fri, 28 May 2021 06:10:32 +0000 (06:10 +0000)
src/Module/Api/Mastodon/Lists.php
src/Module/Api/Mastodon/Media.php
src/Module/Api/Mastodon/Statuses.php
src/Module/BaseApi.php

index 5681ebf8a9425e37bee123ce99fa5a20fd8ba2cf..38a9c16640ffedc1ed9889292ee065752ad21d29 100644 (file)
@@ -78,13 +78,16 @@ class Lists extends BaseApi
 
        public static function put(array $parameters = [])
        {
-               $data = self::getPutData();
+               $request = self::getRequest([
+                       'title'          => '', // The title of the list to be updated.
+                       'replies_policy' => '', // Enumerable oneOf followed list none.
+               ]);
 
-               if (empty($data['title']) || empty($parameters['id'])) {
+               if (empty($request['title']) || empty($parameters['id'])) {
                        DI::mstdnError()->UnprocessableEntity();
                }
 
-               Group::update($parameters['id'], $data['title']);
+               Group::update($parameters['id'], $request['title']);
        }
 
        /**
index daabf53f31f11d3f90e3342f66a4f6771686776b..f232cd3d5ea76e26a8114aff0eae5c617746b5c5 100644 (file)
@@ -58,7 +58,12 @@ class Media extends BaseApi
                self::login(self::SCOPE_WRITE);
                $uid = self::getCurrentUserID();
 
-               $data = self::getPutData();
+               $request = self::getRequest([
+                       'file'        => [], // The file to be attached, using multipart form data.
+                       'thumbnail'   => [], // The custom thumbnail of the media to be attached, using multipart form data.
+                       'description' => '', // A plain-text description of the media, for accessibility purposes.
+                       'focus'       => '', // Two floating points (x,y), comma-delimited ranging from -1.0 to 1.0
+               ]);
 
                if (empty($parameters['id'])) {
                        DI::mstdnError()->UnprocessableEntity();
@@ -69,7 +74,7 @@ class Media extends BaseApi
                        DI::mstdnError()->RecordNotFound();
                }
 
-               Photo::update(['desc' => $data['description'] ?? ''], ['resource-id' => $photo['resource-id']]);
+               Photo::update(['desc' => $request['description']], ['resource-id' => $photo['resource-id']]);
 
                System::jsonExit(DI::mstdnAttachment()->createFromPhoto($parameters['id']));
        }
index 9bbc3bf6361515446b3b649a7206a14c7be5875f..0699c410879b7dfd905378c8a316df06d8e72e08 100644 (file)
@@ -46,21 +46,22 @@ class Statuses extends BaseApi
                self::login(self::SCOPE_WRITE);
                $uid = self::getCurrentUserID();
 
-               $data = self::getJsonPostData();
-
-               $status         = $data['status'] ?? '';
-               $media_ids      = $data['media_ids'] ?? [];
-               $in_reply_to_id = $data['in_reply_to_id'] ?? 0;
-               $sensitive      = $data['sensitive'] ?? false; // @todo Possibly trigger "nsfw" flag?
-               $spoiler_text   = $data['spoiler_text'] ?? '';
-               $visibility     = $data['visibility'] ?? '';
-               $scheduled_at   = $data['scheduled_at'] ?? ''; // Currently unsupported, but maybe in the future
-               $language       = $data['language'] ?? '';
+               $request = self::getRequest([
+                       'status'         => '',    // Text content of the status. If media_ids is provided, this becomes optional. Attaching a poll is optional while status is provided.
+                       'media_ids'      => [],    // Array of Attachment ids to be attached as media. If provided, status becomes optional, and poll cannot be used.
+                       'poll'           => [],    // Poll data. If provided, media_ids cannot be used, and poll[expires_in] must be provided.
+                       'in_reply_to_id' => 0,     // ID of the status being replied to, if status is a reply
+                       'sensitive'      => false, // Mark status and attached media as sensitive?
+                       'spoiler_text'   => '',    // Text to be shown as a warning or subject before the actual content. Statuses are generally collapsed behind this field.
+                       'visibility'     => '',    // Visibility of the posted status. Enumerable oneOf public, unlisted, private, direct.
+                       'scheduled_at'   => '',    // ISO 8601 Datetime at which to schedule a status. Providing this paramter will cause ScheduledStatus to be returned instead of Status. Must be at least 5 minutes in the future.
+                       'language'       => '',    // ISO 639 language code for this status.
+               ]);
 
                $owner = User::getOwnerDataById($uid);
 
                // The imput is defined as text. So we can use Markdown for some enhancements
-               $body = Markdown::toBBCode($status);
+               $body = Markdown::toBBCode($request['status']);
 
                $body = BBCode::expandTags($body);
 
@@ -69,7 +70,7 @@ class Statuses extends BaseApi
                $item['verb']       = Activity::POST;
                $item['contact-id'] = $owner['id'];
                $item['author-id']  = $item['owner-id'] = Contact::getPublicIdByUserId($uid);
-               $item['title']      = $spoiler_text;
+               $item['title']      = $request['spoiler_text'];
                $item['body']       = $body;
 
                if (!empty(self::getCurrentApplication()['name'])) {
@@ -80,7 +81,7 @@ class Statuses extends BaseApi
                        $item['app'] = 'API';
                }
 
-               switch ($visibility) {
+               switch ($request['visibility']) {
                        case 'public':
                                $item['allow_cid'] = '';
                                $item['allow_gid'] = '';
@@ -112,7 +113,7 @@ class Statuses extends BaseApi
                        case 'direct':
                                // Direct messages are currently unsupported
                                DI::mstdnError()->InternalError('Direct messages are currently unsupported');
-                               break;          
+                               break;
                        default:
                                $item['allow_cid'] = $owner['allow_cid'];
                                $item['allow_gid'] = $owner['allow_gid'];
@@ -129,12 +130,12 @@ class Statuses extends BaseApi
                                break;
                }
 
-               if (!empty($language)) {
-                       $item['language'] = json_encode([$language => 1]);
+               if (!empty($request['language'])) {
+                       $item['language'] = json_encode([$request['language'] => 1]);
                }
 
-               if ($in_reply_to_id) {
-                       $parent = Post::selectFirst(['uri'], ['uri-id' => $in_reply_to_id, 'uid' => [0, $uid]]);
+               if ($request['in_reply_to_id']) {
+                       $parent = Post::selectFirst(['uri'], ['uri-id' => $request['in_reply_to_id'], 'uid' => [0, $uid]]);
                        $item['thr-parent']  = $parent['uri'];
                        $item['gravity']     = GRAVITY_COMMENT;
                        $item['object-type'] = Activity\ObjectType::COMMENT;
@@ -143,16 +144,16 @@ class Statuses extends BaseApi
                        $item['object-type'] = Activity\ObjectType::NOTE;
                }
 
-               if (!empty($media_ids)) {
+               if (!empty($request['media_ids'])) {
                        $item['object-type'] = Activity\ObjectType::IMAGE;
                        $item['post-type']   = Item::PT_IMAGE;
                        $item['attachments'] = [];
 
-                       foreach ($media_ids as $id) {
+                       foreach ($request['media_ids'] as $id) {
                                $media = DBA::toArray(DBA::p("SELECT `resource-id`, `scale`, `type`, `desc`, `filename`, `datasize`, `width`, `height` FROM `photo`
                                                WHERE `resource-id` IN (SELECT `resource-id` FROM `photo` WHERE `id` = ?) AND `photo`.`uid` = ?
                                                ORDER BY `photo`.`width` DESC LIMIT 2", $id, $uid));
-                                       
+
                                if (empty($media)) {
                                        continue;
                                }
@@ -162,7 +163,7 @@ class Statuses extends BaseApi
                                $ressources[] = $media[0]['resource-id'];
                                $phototypes = Images::supportedTypes();
                                $ext = $phototypes[$media[0]['type']];
-                       
+
                                $attachment = ['type' => Post\Media::IMAGE, 'mimetype' => $media[0]['type'],
                                        'url' => DI::baseUrl() . '/photo/' . $media[0]['resource-id'] . '-' . $media[0]['scale'] . '.' . $ext,
                                        'size' => $media[0]['datasize'],
@@ -170,7 +171,7 @@ class Statuses extends BaseApi
                                        'description' => $media[0]['desc'] ?? '',
                                        'width' => $media[0]['width'],
                                        'height' => $media[0]['height']];
-                       
+
                                if (count($media) > 1) {
                                        $attachment['preview'] = DI::baseUrl() . '/photo/' . $media[1]['resource-id'] . '-' . $media[1]['scale'] . '.' . $ext;
                                        $attachment['preview-width'] = $media[1]['width'];
@@ -184,7 +185,7 @@ class Statuses extends BaseApi
                if (!empty($id)) {
                        $item = Post::selectFirst(['uri-id'], ['id' => $id]);
                        if (!empty($item['uri-id'])) {
-                               System::jsonExit(DI::mstdnStatus()->createFromUriId($item['uri-id'], $uid));            
+                               System::jsonExit(DI::mstdnStatus()->createFromUriId($item['uri-id'], $uid));
                        }
                }
 
index e0b1da01b4fea48bf68e423edd26482dbcf8f126..aca6070ae1e6cba1d1d1b0e29330887d8645b0fb 100644 (file)
@@ -29,7 +29,7 @@ use Friendica\Database\DBA;
 use Friendica\DI;
 use Friendica\Network\HTTPException;
 use Friendica\Util\DateTimeFormat;
-use Friendica\Util\Network;
+use Friendica\Util\HTTPInputData;
 
 require_once __DIR__ . '/../../include/api.php';
 
@@ -129,7 +129,7 @@ class BaseApi extends BaseModule
        public static function unsupported(string $method = 'all')
        {
                $path = DI::args()->getQueryString();
-               Logger::info('Unimplemented API call', ['method' => $method, 'path' => $path, 'agent' => $_SERVER['HTTP_USER_AGENT'] ?? '', 'request' => $_REQUEST ?? []]);
+               Logger::info('Unimplemented API call', ['method' => $method, 'path' => $path, 'agent' => $_SERVER['HTTP_USER_AGENT'] ?? '', 'request' => HTTPInputData::process()]);
                $error = DI::l10n()->t('API endpoint %s %s is not implemented', strtoupper($method), $path);
                $error_description = DI::l10n()->t('The API endpoint is currently not implemented but might be in the future.');
                $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
@@ -142,25 +142,28 @@ class BaseApi extends BaseModule
         * @return array request data
         */
        public static function getRequest(array $defaults) {
+               $httpinput = HTTPInputData::process();
+               $input = array_merge($httpinput['variables'], $httpinput['files'], $_REQUEST);
+
                $request = [];
 
                foreach ($defaults as $parameter => $defaultvalue) {
                        if (is_string($defaultvalue)) {
-                               $request[$parameter] = $_REQUEST[$parameter] ?? $defaultvalue;
+                               $request[$parameter] = $input[$parameter] ?? $defaultvalue;
                        } elseif (is_int($defaultvalue)) {
-                               $request[$parameter] = (int)($_REQUEST[$parameter] ?? $defaultvalue);
+                               $request[$parameter] = (int)($input[$parameter] ?? $defaultvalue);
                        } elseif (is_float($defaultvalue)) {
-                               $request[$parameter] = (float)($_REQUEST[$parameter] ?? $defaultvalue);
+                               $request[$parameter] = (float)($input[$parameter] ?? $defaultvalue);
                        } elseif (is_array($defaultvalue)) {
-                               $request[$parameter] = $_REQUEST[$parameter] ?? [];
+                               $request[$parameter] = $input[$parameter] ?? [];
                        } elseif (is_bool($defaultvalue)) {
-                               $request[$parameter] = in_array(strtolower($_REQUEST[$parameter] ?? ''), ['true', '1']);
+                               $request[$parameter] = in_array(strtolower($input[$parameter] ?? ''), ['true', '1']);
                        } else {
                                Logger::notice('Unhandled default value type', ['parameter' => $parameter, 'type' => gettype($defaultvalue)]);
                        }
                }
 
-               foreach ($_REQUEST ?? [] as $parameter => $value) {
+               foreach ($input ?? [] as $parameter => $value) {
                        if ($parameter == 'pagename') {
                                continue;
                        }
@@ -173,45 +176,6 @@ class BaseApi extends BaseModule
                return $request;
        }
 
-       /**
-        * Get post data that is transmitted as JSON
-        *
-        * @return array request data
-        */
-       public static function getJsonPostData()
-       {
-               $postdata = Network::postdata();
-               if (empty($postdata)) {
-                       return [];
-               }
-
-               return json_decode($postdata, true);
-       }
-
-       /**
-        * Get request data for put requests
-        *
-        * @return array request data
-        */
-       public static function getPutData()
-       {
-               $rawdata = Network::postdata();
-               if (empty($rawdata)) {
-                       return [];
-               }
-
-               $putdata = [];
-
-               foreach (explode('&', $rawdata) as $value) {
-                       $data = explode('=', $value);
-                       if (count($data) == 2) {
-                               $putdata[$data[0]] = urldecode($data[1]);
-                       }
-               }
-
-               return $putdata;
-       }
-
        /**
         * Log in user via OAuth1 or Simple HTTP Auth.
         *
@@ -394,7 +358,7 @@ class BaseApi extends BaseModule
                                Logger::warning('Requested token scope is not allowed for the application', ['token' => $fields, 'application' => $application]);
                        }
                }
-       
+
                if (!DBA::insert('application-token', $fields, Database::INSERT_UPDATE)) {
                        return [];
                }