Merge pull request #121 from humhub/enh/content-scheduling

Add content scheduling to content
humhub · May 23, 2023 · 7aff3cb · 7aff3cb
2 parents a40e1a7 + caffce8
commit 7aff3cb
Show file tree

Hide file tree

Showing 9 changed files with 87 additions and 15 deletions.
diff --git a/components/BaseContentController.php b/components/BaseContentController.php
@@ -21,6 +21,7 @@
 use humhub\modules\topic\models\Topic;
 use humhub\modules\topic\permissions\AddTopic;
 use Yii;
+use yii\base\DynamicModel;
 use yii\web\HttpException;
 use yii\web\UploadedFile;
 
@@ -30,6 +31,7 @@
  *
  * @package humhub\modules\rest\components
  */
+
 abstract class BaseContentController extends BaseController
 {
     /**
@@ -396,6 +398,10 @@ protected function updateMetadata(ContentActiveRecord $activeRecord, array $data
             return false;
         }
 
+        if (!$this->updateScheduledAt($activeRecord, $data['metadata'])) {
+            return false;
+        }
+
         return true;
     }
 
@@ -482,4 +488,27 @@ protected function updateLockedComments(ContentActiveRecord $activeRecord, array
         $activeRecord->content->locked_comments = $data['locked_comments'];
         return $activeRecord->content->save();
     }
-}
+
+    protected function updateScheduledAt(ContentActiveRecord $activeRecord, array $data): bool
+    {
+        if (!isset($data['scheduled_at'])) {
+            return true;
+        }
+
+        $validator = DynamicModel::validateData([
+            'scheduled_at' => $data['scheduled_at']
+        ], [
+            ['scheduled_at', 'datetime', 'format' => 'php:Y-m-d H:i:s']
+        ]);
+
+        if (!$validator->validate()) {
+            $activeRecord->addError('scheduled_at', $validator->getFirstError('scheduled_at'));
+
+            return false;
+        }
+
+        $activeRecord->content->getStateService()->schedule($data['scheduled_at']);
+
+        return $activeRecord->content->save();
+    }
+}
diff --git a/components/auth/JwtAuth.php b/components/auth/JwtAuth.php
@@ -10,6 +10,7 @@
 use yii\filters\auth\HttpBearerAuth;
 use Exception;
 use Firebase\JWT\JWT;
+use Firebase\JWT\Key;
 use humhub\modules\rest\models\JwtAuthForm;
 use humhub\modules\user\models\User;
 
@@ -23,7 +24,7 @@ public function authenticate($user, $request, $response)
             $token = $matches[1];
 
             try {
-                $validData = JWT::decode($token, JwtAuthForm::getInstance()->jwtKey, ['HS512']);
+                $validData = JWT::decode($token, new Key(JwtAuthForm::getInstance()->jwtKey, 'HS512'));
                 if (
                     !empty($validData->uid) &&
                     ($identity = User::find()->active()->andWhere(['user.id' => $validData->uid])->one()) &&

diff --git a/controllers/post/PostController.php b/controllers/post/PostController.php
@@ -7,6 +7,7 @@
 
 namespace humhub\modules\rest\controllers\post;
 
+
 use humhub\modules\content\components\ContentActiveRecord;
 use humhub\modules\post\models\Post;
 use humhub\modules\rest\components\BaseContentController;

diff --git a/definitions/ContentDefinitions.php b/definitions/ContentDefinitions.php
@@ -42,13 +42,16 @@ public static function getContentMetadata(Content $content)
             'object_model' => $content->object_model,
             'object_id' => $content->object_id,
             'visibility' => (int) $content->visibility,
+            'state' => (int) $content->state,
             'archived' => (bool) $content->archived,
+            'hidden' => (bool) $content->hidden,
             'pinned' => (bool) $content->pinned,
             'locked_comments' => (bool) $content->locked_comments,
             'created_by' => $content->createdBy ? UserDefinitions::getUserShort($content->createdBy) : null,
             'created_at' => $content->created_at,
             'updated_by' => $content->updatedBy ? UserDefinitions::getUserShort($content->updatedBy) : null,
             'updated_at' => $content->updated_at,
+            'scheduled_at' => $content->scheduled_at,
             'url' => $content->getUrl(true),
             'contentcontainer_id' => $content->contentcontainer_id,
             'stream_channel' => $content->stream_channel

diff --git a/docs/html/content.html b/docs/html/content.html
diff --git a/docs/html/notification.html b/docs/html/notification.html
diff --git a/docs/html/post.html b/docs/html/post.html
diff --git a/docs/swagger/content.yaml b/docs/swagger/content.yaml
@@ -232,6 +232,10 @@ definitions:
         readOnly: true
         example: 12
       visibility:
+        type: integer
+        format: int64
+        example: 1
+      state:
         type: integer
         format: int64
         minimum: 0
@@ -240,12 +244,18 @@ definitions:
       archived:
         type: boolean
         example: true
+      hidden:
+        type: boolean
+        example: true
       pinned:
         type: boolean
         example: false
       locked_comments:
         type: boolean
         example: false
+      scheduled_at:
+        type: string
+        example: "2023-09-14 05:15:00"
       created_by:
         readOnly: true
         allOf:

diff --git a/tests/codeception/api/PostCest.php b/tests/codeception/api/PostCest.php
@@ -6,6 +6,7 @@
 use humhub\modules\rest\definitions\PostDefinitions;
 use rest\ApiTester;
 use tests\codeception\_support\HumHubApiTestCest;
+use yii\helpers\ArrayHelper;
 
 class PostCest extends HumHubApiTestCest
 {
@@ -57,6 +58,33 @@ public function testCreate(ApiTester $I)
         $I->seeSuccessResponseContainsJson($this->getRecordDefinition(15));
     }
 
+    public function testCreateScheduled(ApiTester $I)
+    {
+        $I->wantTo('create a scheduled post');
+        $I->amAdmin();
+
+        $scheduledDate = (new \Datetime('tomorrow'))->format('Y-m-d H:i:s');
+
+        $I->sendPost('post/container/1', [
+            'data' => [
+                'message' => 'New created message from API test',
+                'content' => [
+                    'metadata' => [
+                        'scheduled_at' => $scheduledDate,
+                    ]
+                ]
+            ]
+        ]);
+
+        $I->seeSuccessResponseContainsJson(ArrayHelper::merge($this->getRecordDefinition(16), [
+            'content' => [
+                'metadata' => [
+                    'scheduled_at' => $scheduledDate
+                ]
+            ]
+        ]));
+    }
+
     public function testUpdate(ApiTester $I)
     {
         $I->wantTo('update a post');