]> git.mxchange.org Git - friendica.git/blobdiff - src/Module/BaseApi.php
Merge pull request #10962 from annando/db-doc
[friendica.git] / src / Module / BaseApi.php
index 505969361899e9a9d7cab9d05750a978642054d9..5b44073f3f6ce4bfee39194aa00c858517a476de 100644 (file)
@@ -25,9 +25,11 @@ use Friendica\BaseModule;
 use Friendica\Core\Logger;
 use Friendica\Core\System;
 use Friendica\DI;
+use Friendica\Model\Post;
 use Friendica\Network\HTTPException;
 use Friendica\Security\BasicAuth;
 use Friendica\Security\OAuth;
+use Friendica\Util\DateTimeFormat;
 use Friendica\Util\HTTPInputData;
 
 require_once __DIR__ . '/../../include/api.php';
@@ -44,6 +46,16 @@ class BaseApi extends BaseModule
         */
        protected static $format = 'json';
 
+       /**
+        * @var array
+        */
+       protected static $boundaries = [];
+
+       /**
+        * @var array
+        */
+       protected static $request = [];
+
        public static function init(array $parameters = [])
        {
                $arguments = DI::args();
@@ -61,52 +73,36 @@ class BaseApi extends BaseModule
 
        public static function delete(array $parameters = [])
        {
-               if (!api_user()) {
-                       throw new HTTPException\UnauthorizedException(DI::l10n()->t('Permission denied.'));
-               }
+               self::checkAllowedScope(self::SCOPE_WRITE);
 
-               $a = DI::app();
-
-               if (!empty($a->user['uid']) && $a->user['uid'] != api_user()) {
+               if (!DI::app()->isLoggedIn()) {
                        throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
                }
        }
 
        public static function patch(array $parameters = [])
        {
-               if (!api_user()) {
-                       throw new HTTPException\UnauthorizedException(DI::l10n()->t('Permission denied.'));
-               }
-
-               $a = DI::app();
+               self::checkAllowedScope(self::SCOPE_WRITE);
 
-               if (!empty($a->user['uid']) && $a->user['uid'] != api_user()) {
+               if (!DI::app()->isLoggedIn()) {
                        throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
                }
        }
 
        public static function post(array $parameters = [])
        {
-               if (!api_user()) {
-                       throw new HTTPException\UnauthorizedException(DI::l10n()->t('Permission denied.'));
-               }
-
-               $a = DI::app();
+               self::checkAllowedScope(self::SCOPE_WRITE);
 
-               if (!empty($a->user['uid']) && $a->user['uid'] != api_user()) {
+               if (!DI::app()->isLoggedIn()) {
                        throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
                }
        }
 
        public static function put(array $parameters = [])
        {
-               if (!api_user()) {
-                       throw new HTTPException\UnauthorizedException(DI::l10n()->t('Permission denied.'));
-               }
+               self::checkAllowedScope(self::SCOPE_WRITE);
 
-               $a = DI::app();
-
-               if (!empty($a->user['uid']) && $a->user['uid'] != api_user()) {
+               if (!DI::app()->isLoggedIn()) {
                        throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
                }
        }
@@ -137,6 +133,11 @@ class BaseApi extends BaseModule
                $httpinput = HTTPInputData::process();
                $input = array_merge($httpinput['variables'], $httpinput['files'], $_REQUEST);
 
+               self::$request    = $input;
+               self::$boundaries = [];
+
+               unset(self::$request['pagename']);
+
                $request = [];
 
                foreach ($defaults as $parameter => $defaultvalue) {
@@ -169,14 +170,52 @@ class BaseApi extends BaseModule
        }
 
        /**
-        * @deprecated Use checkAllowedScope instead
-        * Log in user via OAuth or Basic HTTP Auth.
-        *
-        * @param string $scope the requested scope (read, write, follow)
+        * Set boundaries for the "link" header
+        * @param array $boundaries
+        * @param int $id
+        * @return array
+        */
+       protected static function setBoundaries(int $id)
+       {
+               if (!isset(self::$boundaries['min'])) {
+                       self::$boundaries['min'] = $id;
+               }
+
+               if (!isset(self::$boundaries['max'])) {
+                       self::$boundaries['max'] = $id;
+               }
+
+               self::$boundaries['min'] = min(self::$boundaries['min'], $id);
+               self::$boundaries['max'] = max(self::$boundaries['max'], $id);
+       }
+
+       /**
+        * Set the "link" header with "next" and "prev" links
+        * @return void
         */
-       protected static function login(string $scope)
+       protected static function setLinkHeader()
        {
-               self::checkAllowedScope($scope);
+               if (empty(self::$boundaries)) {
+                       return;
+               }
+
+               $request = self::$request;
+
+               unset($request['min_id']);
+               unset($request['max_id']);
+               unset($request['since_id']);
+
+               $prev_request = $next_request = $request;
+
+               $prev_request['min_id'] = self::$boundaries['max'];
+               $next_request['max_id'] = self::$boundaries['min'];
+
+               $command = DI::baseUrl() . '/' . DI::args()->getCommand();
+
+               $prev = $command . '?' . http_build_query($prev_request);
+               $next = $command . '?' . http_build_query($next_request);
+
+               header('Link: <' . $next . '>; rel="next", <' . $prev . '>; rel="prev"');
        }
 
        /**
@@ -200,7 +239,7 @@ class BaseApi extends BaseModule
         *
         * @return int User ID
         */
-       public static function getCurrentUserID()
+       protected static function getCurrentUserID()
        {
                $uid = OAuth::getCurrentUserID();
 
@@ -237,6 +276,60 @@ class BaseApi extends BaseModule
                }
        }
 
+       public static function checkThrottleLimit()
+       {
+               $uid = self::getCurrentUserID();
+
+               // Check for throttling (maximum posts per day, week and month)
+               $throttle_day = DI::config()->get('system', 'throttle_limit_day');
+               if ($throttle_day > 0) {
+                       $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60);
+
+                       $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", GRAVITY_PARENT, $uid, $datefrom];
+                       $posts_day = Post::countThread($condition);
+
+                       if ($posts_day > $throttle_day) {
+                               Logger::info('Daily posting limit reached', ['uid' => $uid, 'posts' => $posts_day, 'limit' => $throttle_day]);
+                               $error = DI::l10n()->t('Too Many Requests');
+                               $error_description = DI::l10n()->tt("Daily posting limit of %d post reached. The post was rejected.", "Daily posting limit of %d posts reached. The post was rejected.", $throttle_day);
+                               $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
+                               System::jsonError(429, $errorobj->toArray());
+                       }
+               }
+
+               $throttle_week = DI::config()->get('system', 'throttle_limit_week');
+               if ($throttle_week > 0) {
+                       $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*7);
+
+                       $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", GRAVITY_PARENT, $uid, $datefrom];
+                       $posts_week = Post::countThread($condition);
+
+                       if ($posts_week > $throttle_week) {
+                               Logger::info('Weekly posting limit reached', ['uid' => $uid, 'posts' => $posts_week, 'limit' => $throttle_week]);
+                               $error = DI::l10n()->t('Too Many Requests');
+                               $error_description = DI::l10n()->tt("Weekly posting limit of %d post reached. The post was rejected.", "Weekly posting limit of %d posts reached. The post was rejected.", $throttle_week);
+                               $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
+                               System::jsonError(429, $errorobj->toArray());
+                       }
+               }
+
+               $throttle_month = DI::config()->get('system', 'throttle_limit_month');
+               if ($throttle_month > 0) {
+                       $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*30);
+
+                       $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", GRAVITY_PARENT, $uid, $datefrom];
+                       $posts_month = Post::countThread($condition);
+
+                       if ($posts_month > $throttle_month) {
+                               Logger::info('Monthly posting limit reached', ['uid' => $uid, 'posts' => $posts_month, 'limit' => $throttle_month]);
+                               $error = DI::l10n()->t('Too Many Requests');
+                               $error_description = DI::l10n()->t("Monthly posting limit of %d post reached. The post was rejected.", "Monthly posting limit of %d posts reached. The post was rejected.", $throttle_month);
+                               $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
+                               System::jsonError(429, $errorobj->toArray());
+                       }
+               }
+       }
+
        /**
         * Get user info array.
         *