Merge branch 'MDL-58898-master' of https://github.com/xow/moodle
authorAndrew Nicols <andrew@nicols.co.uk>
Fri, 12 May 2017 04:32:23 +0000 (12:32 +0800)
committerAndrew Nicols <andrew@nicols.co.uk>
Fri, 12 May 2017 04:32:23 +0000 (12:32 +0800)
auth/oauth2/classes/api.php
auth/oauth2/classes/linked_login.php
auth/oauth2/linkedlogins.php
auth/oauth2/tests/api_test.php [new file with mode: 0644]

index a96ebc6..d13a083 100644 (file)
@@ -39,6 +39,16 @@ defined('MOODLE_INTERNAL') || die();
  */
 class api {
 
+    /**
+     * Remove all linked logins that are using issuers that have been deleted.
+     *
+     * @param int $issuerid The issuer id of the issuer to check, or false to check all (defaults to all)
+     * @return boolean
+     */
+    public static function clean_orphaned_linked_logins($issuerid = false) {
+        return linked_login::delete_orphaned($issuerid);
+    }
+
     /**
      * List linked logins
      *
index a3fa2b9..96be2ae 100644 (file)
@@ -88,4 +88,26 @@ class linked_login extends persistent {
         return $count > 0;
     }
 
+    /**
+     * Remove all linked logins that are using issuers that have been deleted.
+     *
+     * @param int $issuerid The issuer id of the issuer to check, or false to check all (defaults to all)
+     * @return boolean
+     */
+    public static function delete_orphaned($issuerid = false) {
+        global $DB;
+        // Delete any linked_login entries with a issuerid
+        // which does not exist in the issuer table.
+        // In the left join, the issuer id will be null
+        // where a match linked_login.issuerid is not found.
+        $sql = "DELETE FROM {" . self::TABLE . "}
+                 WHERE issuerid NOT IN (SELECT id FROM {" . \core\oauth2\issuer::TABLE . "})";
+        $params = [];
+        if (!empty($issuerid)) {
+            $sql .= ' AND issuerid = ?';
+            $params['issuerid'] = $issuerid;
+        }
+        return $DB->execute($sql, $params);
+    }
+
 }
index fe18f8f..ff9a89f 100644 (file)
@@ -83,6 +83,7 @@ $linkedlogin = null;
 echo $OUTPUT->header();
 echo $OUTPUT->heading(get_string('linkedlogins', 'auth_oauth2'));
 echo $OUTPUT->doc_link('Linked_Logins', get_string('linkedloginshelp', 'auth_oauth2'));
+auth_oauth2\api::clean_orphaned_linked_logins();
 $linkedlogins = auth_oauth2\api::get_linked_logins();
 
 echo $renderer->linked_logins_table($linkedlogins);
diff --git a/auth/oauth2/tests/api_test.php b/auth/oauth2/tests/api_test.php
new file mode 100644 (file)
index 0000000..817430a
--- /dev/null
@@ -0,0 +1,101 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Auth oauth2 api functions tests.
+ *
+ * @package     auth_oauth2
+ * @copyright   2017 Damyon Wiese
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+
+/**
+ * External auth oauth2 API tests.
+ *
+ * @package     auth_oauth2
+ * @copyright   2017 Damyon Wiese
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class auth_oauth2_external_testcase extends advanced_testcase {
+
+    /**
+     * Test the cleaning of orphaned linked logins for all issuers.
+     */
+    public function test_clean_orphaned_linked_logins() {
+        $this->resetAfterTest();
+        $this->setAdminUser();
+
+        $issuer = \core\oauth2\api::create_standard_issuer('google');
+        \core\oauth2\api::create_standard_issuer('microsoft');
+
+        $user = $this->getDataGenerator()->create_user();
+        $info = [];
+        $info['username'] = 'banana';
+        $info['email'] = 'banana@example.com';
+        \auth_oauth2\api::link_login($info, $issuer, $user->id, false);
+
+        \core\oauth2\api::delete_issuer($issuer->get('id'));
+
+        $linkedlogins = \auth_oauth2\api::get_linked_logins($user->id, $issuer);
+        $this->assertCount(1, $linkedlogins);
+
+        \auth_oauth2\api::clean_orphaned_linked_logins();
+
+        $linkedlogins = \auth_oauth2\api::get_linked_logins($user->id, $issuer);
+        $this->assertCount(0, $linkedlogins);
+
+        $match = \auth_oauth2\api::match_username_to_user('banana', $issuer);
+        $this->assertFalse($match);
+    }
+
+    /**
+     * Test the cleaning of orphaned linked logins for a specific issuer.
+     */
+    public function test_clean_orphaned_linked_logins_with_issuer_id() {
+        $this->resetAfterTest();
+        $this->setAdminUser();
+
+        $issuer1 = \core\oauth2\api::create_standard_issuer('google');
+        $issuer2 = \core\oauth2\api::create_standard_issuer('microsoft');
+
+        $user1 = $this->getDataGenerator()->create_user();
+        $info = [];
+        $info['username'] = 'banana';
+        $info['email'] = 'banana@example.com';
+        \auth_oauth2\api::link_login($info, $issuer1, $user1->id, false);
+
+        $user2 = $this->getDataGenerator()->create_user();
+        $info = [];
+        $info['username'] = 'apple';
+        $info['email'] = 'apple@example.com';
+        \auth_oauth2\api::link_login($info, $issuer2, $user2->id, false);
+
+        \core\oauth2\api::delete_issuer($issuer1->get('id'));
+
+        \auth_oauth2\api::clean_orphaned_linked_logins($issuer1->get('id'));
+
+        $linkedlogins = \auth_oauth2\api::get_linked_logins($user1->id, $issuer1);
+        $this->assertCount(0, $linkedlogins);
+
+        $linkedlogins = \auth_oauth2\api::get_linked_logins($user2->id, $issuer2);
+        $this->assertCount(1, $linkedlogins);
+    }
+
+}