Merge pull request #66 from topcoder-platform/issues-469

Issues-469: archive/unarchive groups

Author: jmgasper

controllers/api/GroupsApiController.php

@@ -112,7 +112,7 @@ public function get($id) {
         if (!$group) {
             throw new NotFoundException('Group');
         }
-        return $group;
+        return ApiUtils::convertOutputKeys($group);
     }
 
     /**
@@ -254,7 +254,7 @@ public function get_members($id, array $query) {
      * @throws ServerException If the group could not be archived.
      * @return
      */
-    public function put_archive($id, array $body) {
+    public function put_archive($id) {
         $this->permission('Groups.Group.Archive');
         $this->idParamSchema();
 
@@ -266,10 +266,31 @@ public function put_archive($id, array $body) {
         if(!$this->groupModel->canArchiveGroup($group)) {
             throw new ClientException('Don\'t have permissions to archive this group.');
         }
-
-        $this->groupModel->archiveGroup($group->GroupID);
+        $this->groupModel->archiveGroup($group->GroupID, 1);
     }
 
+    /**
+     * Unarchive a group.
+     *
+     * @param int $id The ID of the group.
+     * @throws NotFoundException if the group could not be found.
+     * @throws ServerException If the group could not be archived.
+     * @return
+     */
+    public function put_unarchive($id) {
+        $this->permission('Groups.Group.Archive');
+        $this->idParamSchema();
+
+        $group = $this->groupModel->getByGroupID($id);
+        if(!$group) {
+            throw new NotFoundException('Group');
+        }
+
+        if(!$this->groupModel->canArchiveGroup($group)) {
+            throw new ClientException('Don\'t have permissions to unarchive this group.');
+        }
+        $this->groupModel->archiveGroup($group->GroupID, 0);
+    }
 
     /**
      * Remove a member from a group
@@ -415,6 +436,17 @@ public function groupMemberPatchSchema() {
                 ['watch:b' => 'Watch status'], 'in');
     }
 
+    /**
+     * Get Group Archive schema.
+     *
+     * @param string $type The type of schema.
+     * @return Schema Returns a schema object.
+     */
+    public function groupArchiveSchema() {
+        return $this->schema(
+            ['archived:b' => 'Archived status'], 'in');
+    }
+
     /**
      * Get a GroupID/UserID - only conversation record schema.
      *

models/class.groupmodel.php

@@ -1707,39 +1707,35 @@ public function notifyJoinGroup($groupID, $userID) {
         $activityModel->save($data);
     }
 
-
     public function canArchiveGroup($group){
         return Gdn::session()->UserID == $group->OwnerID ||  Gdn::session()->checkPermission(GroupsPlugin::GROUPS_GROUP_ARCHIVE_PERMISSION);
     }
 
+    public function canUnarchiveGroup($group){
+        return Gdn::session()->UserID == $group->OwnerID ||  Gdn::session()->checkPermission(GroupsPlugin::GROUPS_GROUP_ARCHIVE_PERMISSION);
+    }
+
     /**
-     * Archive a group and its categories
+     * Archive/Unarchive a group and its categories
      *
      * @param $group
+     * @param $archived boolean
      */
-    public function archiveGroup($group){
+    public function archiveGroup($group, $archived){
         if(is_numeric($group) && $group > 0) {
             $group = $this->getByGroupID($group);
         }
 
-       if($group->ChallengeID) {
-            $categoryModel = new CategoryModel();
-            $groupCategory = $categoryModel->getByCode($group->ChallengeID);
-            if($groupCategory->DisplayAs !== 'Discussions') {
-                $categories = CategoryModel::getSubtree($groupCategory->CategoryID, true);
-                $categoryIDs = array_column($categories, 'CategoryID');
-            } else {
-                $categoryIDs = [$groupCategory->CategoryID];
-            }
-
-            foreach($categoryIDs as $categoryID) {
-                $category = $categoryModel->getID($categoryID, DATASET_TYPE_ARRAY);
-                $category['Archived'] = 1;
-                $categoryModel->save($category);
-            }
+        $categories = Gdn::sql()->getWhere('Category', ['GroupID' => $group->GroupID])->resultArray();
+        $categoryIDs = array_column($categories, 'CategoryID');
+        $categoryModel = new CategoryModel();
+        foreach($categoryIDs as $categoryID) {
+            $category = $categoryModel->getID($categoryID, DATASET_TYPE_ARRAY);
+            $category['Archived'] = $archived;
+            $categoryModel->save($category);
         }
 
-        $group->Archived = 1;
+        $group->Archived = $archived;
         $this->save($group);
     }
 

openapi/groups.yml

@@ -261,6 +261,23 @@ paths:
       requestBody:
         required: false
       summary: Archive a group.
+  '/groups/{id}/unarchive':
+    put:
+      parameters:
+        - description: The group ID.
+          in: path
+          name: id
+          required: true
+          schema:
+            type: integer
+      responses:
+        '204':
+          description: Success
+      tags:
+        - Groups
+      requestBody:
+        required: false
+      summary: Unarchive a group.
 components:
   requestBodies:
     GroupPost: