oauth2: Delete Token

It's about damn time.. that we add ability to delete the OAuth2 Token. This adds a new button to the Token tab that will allow you to delete the current Token.
osTicket · Feb 16, 2023 · ca913ba · ca913ba
1 parent b7718be
commit ca913ba
Show file tree

Hide file tree

Showing 4 changed files with 52 additions and 2 deletions.
diff --git a/include/ajax.email.php b/include/ajax.email.php
@@ -39,4 +39,21 @@ function configureAuth($id, $type, $auth) {
         $template = sprintf('email-%sauth.tmpl.php', $authtype);
         include INCLUDE_DIR . "staff/templates/$template";
     }
+
+    /*
+     * Delete the OAuth2 token
+     */
+    function deleteToken($id, $type) {
+        // Check to make sure the email exists
+        if (!($email=Email::lookup($id)))
+            Http::response(404, 'Unknown Email');
+        // Get the authentication account
+        if (!($account=$email->getAuthAccount($type)))
+            Http::response(404, 'Unknown Authentication Type');
+        // Destory the account config which will delete the token
+        if ($account->destroyConfig())
+            Http::response(201, __('Token Deleted Successfully.'));
+        // Couldn't delete the Token
+        Http::response(404, 'Unable to delete token.');
+    }
 }
diff --git a/include/class.email.php b/include/class.email.php
@@ -983,6 +983,13 @@ public function updateCredentials($auth, $vars, &$errors) {
         return $this->save();
     }
 
+    /*
+     * Destory the account config
+     */
+    function destroyConfig() {
+        return $this->getConfig()->destroy();
+    }
+
     function update($vars, &$errors) {
         return false;
     }
@@ -1010,7 +1017,7 @@ function save($refetch=false) {
 
     function delete() {
         // Destroy the Email config
-        $this->getConfig()->destroy();
+        $this->destroyConfig();
         // Delete the Plugin instance
         if ($this->isOAuthAuth() && ($i=$this->getOAuth2Instance()))
             $i->delete();

diff --git a/include/staff/templates/email-oauth2auth.tmpl.php b/include/staff/templates/email-oauth2auth.tmpl.php
@@ -123,7 +123,14 @@
                      __('Expired Access Token gets auto-refreshed on use'));
         }
         ?>
-        <table class="form_table" width="940" border="0" cellspacing="0" cellpadding="2">
+        <a class="red button action-button pull-right" style="margin-bottom:8px;"
+            id="token-delete" data-toggle="tooltip"
+            href="<?php echo sprintf('#email/%d/auth/config/%s/delete', $email->getId(), $type); ?>"
+            title="Delete" data-original-title="Delete">
+                <i class="icon-trash"></i>&nbsp;<?php echo __('Delete Token'); ?>
+        </a>
+        <div class="clear"></div>
+        <table class="form_table" width="100%" border="0" cellspacing="0" cellpadding="2">
         <thead>
             <tr>
                 <th colspan="2">
@@ -173,3 +180,21 @@
     </span>
 </p>
 </form>
+<script type="text/javascript">
+$(function() {
+    $('#oauth-tabs_container').on('click', 'a#token-delete', function(e) {
+        e.preventDefault();
+        if (confirm(__('Are you sure?'))) {
+            $.ajax({
+              url: 'ajax.php/' + $(this).attr('href').substr(1),
+              type: 'POST',
+              success: function(json) {
+                  $.toggleOverlay(false);
+                  $('#popup').hide();
+              }
+            });
+        }
+        return false;
+    });
+});
+</script>
diff --git a/scp/ajax.php b/scp/ajax.php
@@ -316,6 +316,7 @@ function staffLoginPage($msg='Unauthorized') {
     )),
     url('^/email', patterns('ajax.email.php:EmailAjaxAPI',
         url_post('^/(?P<id>\d+)/stash$', 'stashFormData'),
+        url_post('^/(?P<id>\d+)/auth/config/(?P<type>\w+)/delete$', 'deleteToken'),
         url('^/(?P<id>\d+)/auth/config/(?P<type>\w+)/(?P<auth>.+)$', 'configureAuth'),
     ))
 );