Updated webservice and tasks to check for required scopes

ncstate-delta · Jan 9, 2025 · 394ddec · 394ddec
1 parent d6a515d
commit 394ddec
Show file tree

Hide file tree

Showing 6 changed files with 131 additions and 0 deletions.
diff --git a/classes/task/delete_meeting_recordings.php b/classes/task/delete_meeting_recordings.php
@@ -60,6 +60,27 @@ public function execute() {
             return;
         }
 
+        // Required scopes for deleting meeting recordings.
+        $requiredscopes = [
+            'classic' => [
+                'recording:write:admin',
+            ],
+            'granular' => [
+                'cloud_recording:delete:meeting_recording:admin'
+            ],
+        ];
+
+        $this->scopetype = $this->get_scope_type($this->scopes);
+
+        // Checking for missing scopes.
+        $missingscopes = $this->check_zoom_scopes($requiredscopes[$this->scopetype]);
+        if($missingscopes != []){
+            foreach($missingscopes as $missingscope){
+                mtrace('Missing scope: '.$missingscope);
+            }
+            return;
+        }      
+
         // See if we cannot make anymore API calls.
         $retryafter = get_config('zoom', 'retry-after');
         if (!empty($retryafter) && time() < $retryafter) {

diff --git a/classes/task/get_meeting_recordings.php b/classes/task/get_meeting_recordings.php
@@ -67,6 +67,27 @@ public function execute() {
             return;
         }
 
+        // Required scopes for meeting recordings.
+        $requiredscopes = [
+            'classic' => [
+                'recording:read:admin',
+            ],
+            'granular' => [
+                'cloud_recording:read:list_recording_files:admin'
+            ],
+        ];
+
+        $this->scopetype = $this->get_scope_type($this->scopes);
+
+        // Checking for missing scopes.
+        $missingscopes = $this->check_zoom_scopes($requiredscopes[$this->scopetype]);
+        if($missingscopes != []){
+            foreach($missingscopes as $missingscope){
+                mtrace('Missing scope: '.$missingscope);
+            }
+            return;
+        }
+
         // See if we cannot make anymore API calls.
         $retryafter = get_config('zoom', 'retry-after');
         if (!empty($retryafter) && time() < $retryafter) {

diff --git a/classes/task/get_meeting_reports.php b/classes/task/get_meeting_reports.php
@@ -94,7 +94,27 @@ public function execute($paramstart = null, $paramend = null, $hostuuids = null)
             mtrace('Skipping task - ', $exception->getMessage());
             return;
         }
+        // Required scopes for reports.
+        $requiredscopes = [
+            'classic' => [
+                'report:read:admin'
+            ],
+            'granular' => [
+                'report:read:user:admin'
+            ],
+        ];
 
+        $this->scopetype = $this->get_scope_type($this->scopes);
+
+        // Checking for missing scopes.
+        $missingscopes = $this->check_zoom_scopes($requiredscopes[$this->scopetype]);
+        if($missingscopes != []){
+            foreach($missingscopes as $missingscope){
+                mtrace('Missing scope: '.$missingscope);
+            }
+            return;
+        }
+
         // See if we cannot make anymore API calls.
         $retryafter = get_config('zoom', 'retry-after');
         if (!empty($retryafter) && time() < $retryafter) {

diff --git a/classes/task/update_meetings.php b/classes/task/update_meetings.php
@@ -64,6 +64,27 @@ public function execute() {
             return;
         }
 
+        // Required scopes for updating meetings.
+        $requiredscopes = [
+            'classic' => [
+                'tracking_fields:write:admin',
+            ],
+            'granular' => [
+                'tracking_field:update:tracking_field:admin'
+            ],
+        ];
+
+        $this->scopetype = $this->get_scope_type($this->scopes);
+
+        // Checking for missing scopes.
+        $missingscopes = $this->check_zoom_scopes($requiredscopes[$this->scopetype]);
+        if($missingscopes != []){
+            foreach($missingscopes as $missingscope){
+                mtrace('Missing scope: '.$missingscope);
+            }
+            return;
+        }
+
         // Show trace message.
         mtrace('Starting to process existing Zoom meeting activities ...');
 

diff --git a/classes/task/update_tracking_fields.php b/classes/task/update_tracking_fields.php
@@ -58,6 +58,27 @@ public function execute() {
             return;
         }
 
+        // Required scopes for tracking fields.
+        $requiredscopes = [
+            'classic' => [
+                'tracking_fields:write:admin',
+            ],
+            'granular' => [
+                'tracking_field:update:tracking_field:admin'
+            ],
+        ];
+
+        $this->scopetype = $this->get_scope_type($this->scopes);
+
+        // Checking for missing scopes.
+        $missingscopes = $this->check_zoom_scopes($requiredscopes[$this->scopetype]);
+        if($missingscopes != []){
+            foreach($missingscopes as $missingscope){
+                mtrace('Missing scope: '.$missingscope);
+            }
+            return;
+        }
+
         // Show trace message.
         mtrace('Starting to process existing Zoom tracking fields ...');
 

diff --git a/classes/webservice.php b/classes/webservice.php
@@ -1172,6 +1172,33 @@ public function has_scope($scopes) {
         return !empty($matchingscopes);
     }
 
+    /**
+     * Check for Zoom scopes
+     *
+     * @param string $requiredscopes Required Zoom scopes.
+     * @throws moodle_exception
+     * @return array missingscopes 
+     */
+    public function check_zoom_scopes($requiredscopes) {
+        if (!isset($this->scopes)) {
+            $this->get_access_token();
+        }
+
+        $missingscopes = array_diff($requiredscopes, $this->scopes);
+        return $missingscopes;
+    }
+
+    /**
+     * Checks for the type of scope (classic or granular) of the user.
+     *
+     * @param array $scopes
+     * @throws moodle_exception
+     * @return string scope type
+     */
+    private function get_scope_type($scopes) {
+        return in_array('meeting:read:admin', $scopes, true) ? 'classic' : 'granular';
+    }
+
     /**
      * Stores token and expiration in cache, returns token from OAuth call.
      *