[T19] Update plugin for compatibility

.travis.yml

@@ -9,8 +9,8 @@ cache:
     - $HOME/.npm
 
 php:
- - 5.6
- - 7.1
+ - 7.0
+ - 7.2
 
 addons:
  firefox: 47.0.1
@@ -22,7 +22,7 @@ addons:
 
 env:
  global:
-  - MOODLE_BRANCH=MOODLE_33_STABLE
+  - MOODLE_BRANCH=MOODLE_34_STABLE
   - IGNORE_NAMES=mobile_*.mustache # Mobile mustache has specific syntax, ignore their templates
  matrix:
   - DB=pgsql

CHANGES.md

@@ -1,6 +1,6 @@
 # Changelog
 
-All notable changes to this project will be documented in this file. 
+All notable changes to this project will be documented in this file.
 
 Note - All hash comments refer to the issue number. Eg. #169 refers to https://github.com/markn86/moodle-mod_customcert/issues/169.
 
@@ -18,12 +18,14 @@ Note - All hash comments refer to the issue number. Eg. #169 refers to https://g
 
 ### Fixed
 
+- Missing implementation for privacy provider (#260).
 - Use course module context when calling format_string/text (#200).
 - Exception being thrown when adding the 'teachername' element to site template (#261).
 
-## [3.3.15] - 2018-12-20
+## [3.4.6] - 2018-12-20
 ### Added
 
+- GDPR: Add support for removal of users from a context (see MDL-62560) (#252).
 - Images can be made transparent (#186).
 - Set default values of activity instance settings (#180).
 - Allow element plugins to control if they can be added to a certificate (#225).
@@ -85,15 +87,15 @@ Note - All hash comments refer to the issue number. Eg. #169 refers to https://g
     their certificate. It also allows teachers to view the
     list of issued certificates, with the ability to revoke
     any.
-    
-    This is for the soon-to-be released Moodle Mobile v3.5.0 
+
+    This is for the soon-to-be released Moodle Mobile v3.5.0
     (not to be confused with your Moodle site version) and
     will not work on Mobile versions earlier than this.
-    
+
     If you are running a Moodle site on version 3.4 or below
     you will need to install the local_mobile plugin in order
     for this to work.
-    
+
     If you are running a Moodle site on version 3.0 or below
     then you will need to upgrade.
 ```

classes/element_helper.php

@@ -389,7 +389,7 @@ public static function get_courseid($elementid) {
      * @param int $elementid The element id
      * @return \context The context
      */
-    public static function get_context($elementid) {
+    public static function get_context(int $elementid) : \context {
         global $DB;
 
         $sql = "SELECT ct.contextid

classes/output/mobile.php

@@ -202,7 +202,7 @@ private static function update_active_group($groupmode, $groupid, $allowedgroups
      * @param \context $context
      * @param string $cap
      */
-    protected static function require_capability(\stdClass $cm, \context $context, $cap) {
+    protected static function require_capability(\stdClass $cm, \context $context, string $cap) {
         require_login($cm->course, false, $cm, true, true);
         require_capability($cap, $context);
     }

classes/privacy/provider.php

@@ -25,9 +25,11 @@
 
 use core_privacy\local\metadata\collection;
 use core_privacy\local\request\approved_contextlist;
+use core_privacy\local\request\approved_userlist;
 use core_privacy\local\request\contextlist;
 use core_privacy\local\request\helper;
 use core_privacy\local\request\transform;
+use core_privacy\local\request\userlist;
 use core_privacy\local\request\writer;
 
 defined('MOODLE_INTERNAL') || die();
@@ -40,15 +42,16 @@
  */
 class provider implements
     \core_privacy\local\metadata\provider,
-    \core_privacy\local\request\plugin\provider {
+    \core_privacy\local\request\plugin\provider,
+    \core_privacy\local\request\core_userlist_provider {
 
     /**
      * Return the fields which contain personal data.
      *
      * @param collection $items a reference to the collection to use to store the metadata.
      * @return collection the updated collection of metadata items.
      */
-    public static function get_metadata(collection $items) {
+    public static function get_metadata(collection $items) : collection {
         $items->add_database_table(
             'customcert_issues',
             [
@@ -70,7 +73,7 @@ public static function get_metadata(collection $items) {
      * @param int $userid the userid.
      * @return contextlist the list of contexts containing user info for the user.
      */
-    public static function get_contexts_for_userid($userid) {
+    public static function get_contexts_for_userid(int $userid) : contextlist {
         $sql = "SELECT c.id
                   FROM {context} c
             INNER JOIN {course_modules} cm
@@ -96,6 +99,37 @@ public static function get_contexts_for_userid($userid) {
         return $contextlist;
     }
 
+    /**
+     * Get the list of users who have data within a context.
+     *
+     * @param userlist $userlist The userlist containing the list of users who have data in this context/plugin combination.
+     */
+    public static function get_users_in_context(userlist $userlist) {
+        $context = $userlist->get_context();
+
+        if (!$context instanceof \context_module) {
+            return;
+        }
+
+        // Fetch all users who have a custom certificate.
+        $sql = "SELECT customcertissues.userid
+                  FROM {course_modules} cm
+                  JOIN {modules} m
+                    ON m.id = cm.module AND m.name = :modname
+                  JOIN {customcert} customcert
+                    ON customcert.id = cm.instance
+                  JOIN {customcert_issues} customcertissues
+                    ON customcertissues.customcertid = customcert.id
+                 WHERE cm.id = :cmid";
+
+        $params = [
+            'cmid'      => $context->instanceid,
+            'modname'   => 'customcert',
+        ];
+
+        $userlist->add_from_sql('userid', $sql, $params);
+    }
+
     /**
      * Export personal data for the given approved_contextlist. User and context information is contained within the contextlist.
      *
@@ -182,6 +216,33 @@ public static function delete_data_for_user(approved_contextlist $contextlist) {
         }
     }
 
+    /**
+     * Delete multiple users within a single context.
+     *
+     * @param approved_userlist $userlist The approved context and user information to delete information for.
+     */
+    public static function delete_data_for_users(approved_userlist $userlist) {
+        global $DB;
+
+        $context = $userlist->get_context();
+        if (!$context instanceof \context_module) {
+            return;
+        }
+
+        $cm = get_coursemodule_from_id('customcert', $context->instanceid);
+        if (!$cm) {
+            // Only customcert module will be handled.
+            return;
+        }
+
+        $userids = $userlist->get_userids();
+        list($usersql, $userparams) = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED);
+
+        $select = "customcertid = :customcertid AND userid $usersql";
+        $params = ['customcertid' => $cm->instance] + $userparams;
+        $DB->delete_records_select('customcert_issues', $select, $params);
+    }
+
     /**
      * Return a list of Customcert IDs mapped to their course module ID.
      *

db/upgrade.php

@@ -143,27 +143,7 @@ function xmldb_customcert_upgrade($oldversion) {
         $dbman->change_field_type($table, $field);
 
         // Savepoint reached.
-        upgrade_mod_savepoint(true, 2017050515, 'customcert');
-    }
-
-    if ($oldversion < 2017050518.01) {
-        $table = new xmldb_table('customcert');
-        $index = new xmldb_index('templateid', XMLDB_INDEX_UNIQUE, ['templateid']);
-        if ($dbman->index_exists($table, $index)) {
-            $dbman->drop_index($table, $index);
-        }
-        $key = new xmldb_key('templateid', XMLDB_KEY_FOREIGN, array('templateid'), 'customcert_templates', array('id'));
-        $dbman->add_key($table, $key);
-
-        $table = new xmldb_table('customcert_pages');
-        $index = new xmldb_index('templateid', XMLDB_INDEX_UNIQUE, ['templateid']);
-        if ($dbman->index_exists($table, $index)) {
-            $dbman->drop_index($table, $index);
-        }
-        $key = new xmldb_key('templateid', XMLDB_KEY_FOREIGN, array('templateid'), 'customcert_templates', array('id'));
-        $dbman->add_key($table, $key);
-
-        upgrade_mod_savepoint(true, 2017050518.01, 'customcert');
+        upgrade_mod_savepoint(true, 2017111306, 'customcert');
     }
 
     return true;

element/bgimage/classes/privacy/provider.php

@@ -40,7 +40,7 @@ class provider implements \core_privacy\local\metadata\null_provider {
      *
      * @return  string
      */
-    public static function get_reason() {
+    public static function get_reason() : string {
         return 'privacy:metadata';
     }
 }

element/bgimage/version.php

@@ -24,6 +24,6 @@
 
 defined('MOODLE_INTERNAL') || die('Direct access to this script is forbidden.');
 
-$plugin->version   = 2017050500; // The current module version (Date: YYYYMMDDXX).
-$plugin->requires  = 2017050500; // Requires this Moodle version (3.3).
+$plugin->version   = 2017111300; // The current module version (Date: YYYYMMDDXX).
+$plugin->requires  = 2017111300; // Requires this Moodle version (3.4).
 $plugin->component = 'customcertelement_bgimage';

element/border/classes/privacy/provider.php

@@ -40,7 +40,7 @@ class provider implements \core_privacy\local\metadata\null_provider {
      *
      * @return  string
      */
-    public static function get_reason() {
+    public static function get_reason() : string {
         return 'privacy:metadata';
     }
 }

element/border/version.php

@@ -24,6 +24,6 @@
 
 defined('MOODLE_INTERNAL') || die('Direct access to this script is forbidden.');
 
-$plugin->version   = 2017050500; // The current module version (Date: YYYYMMDDXX).
-$plugin->requires  = 2017050500; // Requires this Moodle version (3.3).
+$plugin->version   = 2017111300; // The current module version (Date: YYYYMMDDXX).
+$plugin->requires  = 2017111300; // Requires this Moodle version (3.4).
 $plugin->component = 'customcertelement_border';

element/categoryname/classes/element.php

@@ -63,7 +63,7 @@ public function render_html() {
      *
      * @return string
      */
-    protected function get_category_name() {
+    protected function get_category_name() : string {
         global $DB, $SITE;
 
         $courseid = \mod_customcert\element_helper::get_courseid($this->get_id());

element/categoryname/classes/privacy/provider.php

@@ -40,7 +40,7 @@ class provider implements \core_privacy\local\metadata\null_provider {
      *
      * @return  string
      */
-    public static function get_reason() {
+    public static function get_reason() : string {
         return 'privacy:metadata';
     }
 }

element/categoryname/version.php

@@ -24,6 +24,6 @@
 
 defined('MOODLE_INTERNAL') || die('Direct access to this script is forbidden.');
 
-$plugin->version   = 2017050500; // The current module version (Date: YYYYMMDDXX).
-$plugin->requires  = 2017050500; // Requires this Moodle version (3.3).
+$plugin->version   = 2017111300; // The current module version (Date: YYYYMMDDXX).
+$plugin->requires  = 2017111300; // Requires this Moodle version (3.4).
 $plugin->component = 'customcertelement_categoryname';

element/code/classes/privacy/provider.php

@@ -40,7 +40,7 @@ class provider implements \core_privacy\local\metadata\null_provider {
      *
      * @return  string
      */
-    public static function get_reason() {
+    public static function get_reason() : string {
         return 'privacy:metadata';
     }
 }

element/code/version.php

@@ -24,6 +24,6 @@
 
 defined('MOODLE_INTERNAL') || die('Direct access to this script is forbidden.');
 
-$plugin->version   = 2017050500; // The current module version (Date: YYYYMMDDXX).
-$plugin->requires  = 2017050500; // Requires this Moodle version (3.3).
+$plugin->version   = 2017111300; // The current module version (Date: YYYYMMDDXX).
+$plugin->requires  = 2017111300; // Requires this Moodle version (3.4).
 $plugin->component = 'customcertelement_code';

element/coursename/classes/element.php

@@ -63,7 +63,7 @@ public function render_html() {
      *
      * @return string
      */
-    protected function get_course_name() {
+    protected function get_course_name() : string {
         $courseid = \mod_customcert\element_helper::get_courseid($this->get_id());
         $course = get_course($courseid);
         $context = \mod_customcert\element_helper::get_context($this->get_id());

element/coursename/classes/privacy/provider.php

@@ -40,7 +40,7 @@ class provider implements \core_privacy\local\metadata\null_provider {
      *
      * @return  string
      */
-    public static function get_reason() {
+    public static function get_reason() : string {
         return 'privacy:metadata';
     }
 }

element/coursename/version.php

@@ -24,6 +24,6 @@
 
 defined('MOODLE_INTERNAL') || die('Direct access to this script is forbidden.');
 
-$plugin->version   = 2017050500; // The current module version (Date: YYYYMMDDXX).
-$plugin->requires  = 2017050500; // Requires this Moodle version (3.3).
+$plugin->version   = 2017111300; // The current module version (Date: YYYYMMDDXX).
+$plugin->requires  = 2017111300; // Requires this Moodle version (3.4).
 $plugin->component = 'customcertelement_coursename';

element/date/classes/privacy/provider.php

@@ -40,7 +40,7 @@ class provider implements \core_privacy\local\metadata\null_provider {
      *
      * @return  string
      */
-    public static function get_reason() {
+    public static function get_reason() : string {
         return 'privacy:metadata';
     }
 }

element/date/version.php

@@ -24,6 +24,6 @@
 
 defined('MOODLE_INTERNAL') || die('Direct access to this script is forbidden.');
 
-$plugin->version   = 2017050500; // The current module version (Date: YYYYMMDDXX).
-$plugin->requires  = 2017050500; // Requires this Moodle version (3.3).
+$plugin->version   = 2017111300; // The current module version (Date: YYYYMMDDXX).
+$plugin->requires  = 2017111300; // Requires this Moodle version (3.4).
 $plugin->component = 'customcertelement_date';

element/digitalsignature/classes/privacy/provider.php

@@ -40,7 +40,7 @@ class provider implements \core_privacy\local\metadata\null_provider {
      *
      * @return  string
      */
-    public static function get_reason() {
+    public static function get_reason() : string {
         return 'privacy:metadata';
     }
 }

element/digitalsignature/version.php

@@ -24,6 +24,6 @@
 
 defined('MOODLE_INTERNAL') || die('Direct access to this script is forbidden.');
 
-$plugin->version   = 2017050500; // The current module version (Date: YYYYMMDDXX).
-$plugin->requires  = 2017050500; // Requires this Moodle version (3.3).
+$plugin->version   = 2017111300; // The current module version (Date: YYYYMMDDXX).
+$plugin->requires  = 2017111300; // Requires this Moodle version (3.4).
 $plugin->component = 'customcertelement_digitalsignature';

element/grade/classes/privacy/provider.php

@@ -40,7 +40,7 @@ class provider implements \core_privacy\local\metadata\null_provider {
      *
      * @return  string
      */
-    public static function get_reason() {
+    public static function get_reason() : string {
         return 'privacy:metadata';
     }
 }

element/grade/version.php

@@ -24,6 +24,6 @@
 
 defined('MOODLE_INTERNAL') || die('Direct access to this script is forbidden.');
 
-$plugin->version   = 2017050500; // The current module version (Date: YYYYMMDDXX).
-$plugin->requires  = 2017050500; // Requires this Moodle version (3.3).
+$plugin->version   = 2017111300; // The current module version (Date: YYYYMMDDXX).
+$plugin->requires  = 2017111300; // Requires this Moodle version (3.4).
 $plugin->component = 'customcertelement_grade';

element/gradeitemname/classes/element.php

@@ -114,7 +114,7 @@ public function definition_after_data($mform) {
      *
      * @return string
      */
-    protected function get_grade_item_name() {
+    protected function get_grade_item_name() : string {
         global $DB;
 
         // Get the course module information.