Merge branch 'MDL-58898-master' of https://github.com/xow/moodle
[moodle.git] / auth / oauth2 / classes / linked_login.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Class for loading/storing issuers from the DB.
19  *
20  * @package    auth_oauth2
21  * @copyright  2017 Damyon Wiese
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
24 namespace auth_oauth2;
26 defined('MOODLE_INTERNAL') || die();
28 use core\persistent;
30 /**
31  * Class for loading/storing issuer from the DB
32  *
33  * @copyright  2017 Damyon Wiese
34  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35  */
36 class linked_login extends persistent {
38     const TABLE = 'auth_oauth2_linked_login';
40     /**
41      * Return the definition of the properties of this model.
42      *
43      * @return array
44      */
45     protected static function define_properties() {
46         return array(
47             'issuerid' => array(
48                 'type' => PARAM_INT
49             ),
50             'userid' => array(
51                 'type' => PARAM_INT
52             ),
53             'username' => array(
54                 'type' => PARAM_RAW
55             ),
56             'email' => array(
57                 'type' => PARAM_RAW
58             ),
59             'confirmtoken' => array(
60                 'type' => PARAM_RAW
61             ),
62             'confirmtokenexpires' => array(
63                 'type' => PARAM_INT
64             )
65         );
66     }
68     /**
69      * Check whether there are any valid linked accounts for this issuer
70      * and username combination.
71      *
72      * @param \core\oauth2\issuer $issuer The issuer
73      * @param string $username The username to check
74      */
75     public static function has_existing_issuer_match(\core\oauth2\issuer $issuer, $username) {
76         global $DB;
78         $where = "issuerid = :issuerid
79               AND username = :username
80               AND (confirmtokenexpires = 0 OR confirmtokenexpires > :maxexpiry)";
82         $count = $DB->count_records_select(static::TABLE, $where, [
83             'issuerid' => $issuer->get('id'),
84             'username' => $username,
85             'maxexpiry' => (new \DateTime('NOW'))->getTimestamp(),
86         ]);
88         return $count > 0;
89     }
91     /**
92      * Remove all linked logins that are using issuers that have been deleted.
93      *
94      * @param int $issuerid The issuer id of the issuer to check, or false to check all (defaults to all)
95      * @return boolean
96      */
97     public static function delete_orphaned($issuerid = false) {
98         global $DB;
99         // Delete any linked_login entries with a issuerid
100         // which does not exist in the issuer table.
101         // In the left join, the issuer id will be null
102         // where a match linked_login.issuerid is not found.
103         $sql = "DELETE FROM {" . self::TABLE . "}
104                  WHERE issuerid NOT IN (SELECT id FROM {" . \core\oauth2\issuer::TABLE . "})";
105         $params = [];
106         if (!empty($issuerid)) {
107             $sql .= ' AND issuerid = ?';
108             $params['issuerid'] = $issuerid;
109         }
110         return $DB->execute($sql, $params);
111     }