first commit

user/profile/field/social/classes/helper.php

@@ -0,0 +1,74 @@
+<?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/>.
+
+/**
+ * Contains class profilefield_social\networks
+ *
+ * @package    profilefield_social
+ * @copyright  2020 Bas Brands
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace profilefield_social;
+
+/**
+ * helper class for social profile fields.
+ *
+ * @copyright  2020 Bas Brands <bas@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class helper  {
+
+    /**
+     * Get the available social networks
+     *
+     * @return array list of social networks.
+     */
+    public static function get_networks(): array {
+        return [
+            'icq' => get_string('icqnumber', 'profilefield_social'),
+            'msn' => get_string('msnid', 'profilefield_social'),
+            'aim' => get_string('aimid', 'profilefield_social'),
+            'yahoo' => get_string('yahooid', 'profilefield_social'),
+            'skype' => get_string('skypeid', 'profilefield_social'),
+            'url' => get_string('webpage', 'profilefield_social'),
+        ];
+    }
+
+    /**
+     * Get the translated fieldname string for a network.
+     *
+     * @param string $fieldname Network short name.
+     * @return string network name.
+     */
+    public static function get_fieldname(string $fieldname): string {
+        $networks = self::get_networks();
+        return $networks[$fieldname];
+    }
+
+    /**
+     * Get the available network url formats.
+     *
+     * @return array list network url strings.
+     */
+    public static function get_network_urls(): array {
+        return [
+            'skype' => '<a href="skype:%%ENCODED%%?call">%%PLAIN%%</a>',
+            'icq' => '<a href="http://www.icq.com/whitepages/cmd.php?uin=%%ENCODED%%&action=message">%%PLAIN%%</a>',
+            'url' => '<a href="%%PLAIN%%">%%PLAIN%%</a>'
+        ];
+    }
+}

user/profile/field/social/classes/privacy/provider.php

@@ -0,0 +1,214 @@
+<?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/>.
+
+/**
+ * Privacy class for requesting user data.
+ *
+ * @package    profilefield_social
+ * @copyright  2020 Bas Brands
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace profilefield_social\privacy;
+
+defined('MOODLE_INTERNAL') || die();
+
+use \core_privacy\local\metadata\collection;
+use \core_privacy\local\request\contextlist;
+use \core_privacy\local\request\approved_contextlist;
+use core_privacy\local\request\userlist;
+use core_privacy\local\request\approved_userlist;
+
+/**
+ * Privacy class for requesting user data.
+ *
+ * @copyright  2018 Mihail Geshoski <mihail@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class provider implements
+    \core_privacy\local\metadata\provider,
+    \core_privacy\local\request\core_userlist_provider,
+    \core_privacy\local\request\plugin\provider {
+
+    /**
+     * Returns meta data about this system.
+     *
+     * @param   collection $collection The initialised collection to add items to.
+     * @return  collection A listing of user data stored through this system.
+     */
+    public static function get_metadata(collection $collection): collection {
+        return $collection->add_database_table('user_info_data', [
+            'userid' => 'privacy:metadata:profile_field_social:userid',
+            'fieldid' => 'privacy:metadata:profile_field_social:fieldid',
+            'data' => 'privacy:metadata:profile_field_social:data',
+            'dataformat' => 'privacy:metadata:profile_field_social:dataformat'
+        ], 'privacy:metadata:profile_field_social:tableexplanation');
+    }
+
+    /**
+     * Get the list of contexts that contain user information for the specified user.
+     *
+     * @param   int         $userid     The user to search.
+     * @return  contextlist $contextlist  The contextlist containing the list of contexts used in this plugin.
+     */
+    public static function get_contexts_for_userid(int $userid): contextlist {
+        $sql = "SELECT ctx.id
+                  FROM {user_info_data} uda
+                  JOIN {user_info_field} uif ON uda.fieldid = uif.id
+                  JOIN {context} ctx ON ctx.instanceid = uda.userid
+                       AND ctx.contextlevel = :contextlevel
+                 WHERE uda.userid = :userid
+                       AND uif.datatype = :datatype";
+        $params = [
+            'userid' => $userid,
+            'contextlevel' => CONTEXT_USER,
+            'datatype' => 'social'
+        ];
+        $contextlist = new contextlist();
+        $contextlist->add_from_sql($sql, $params);
+
+        return $contextlist;
+    }
+
+    /**
+     * Get the list of users within a specific 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_user) {
+            return;
+        }
+
+        $sql = "SELECT uda.userid
+                  FROM {user_info_data} uda
+                  JOIN {user_info_field} uif
+                       ON uda.fieldid = uif.id
+                 WHERE uda.userid = :userid
+                       AND uif.datatype = :datatype";
+
+        $params = [
+            'userid' => $context->instanceid,
+            'datatype' => 'social'
+        ];
+
+        $userlist->add_from_sql('userid', $sql, $params);
+    }
+
+    /**
+     * Export all user data for the specified user, in the specified contexts.
+     *
+     * @param approved_contextlist $contextlist The approved contexts to export information for.
+     */
+    public static function export_user_data(approved_contextlist $contextlist) {
+        $user = $contextlist->get_user();
+        foreach ($contextlist->get_contexts() as $context) {
+            // Check if the context is a user context.
+            if ($context->contextlevel == CONTEXT_USER && $context->instanceid == $user->id) {
+                $results = static::get_records($user->id);
+                foreach ($results as $result) {
+                    $data = (object) [
+                        'name' => $result->name,
+                        'description' => $result->description,
+                        'data' => $result->data
+                    ];
+                    \core_privacy\local\request\writer::with_context($context)->export_data([
+                        get_string('pluginname', 'profilefield_social')], $data);
+                }
+            }
+        }
+    }
+
+    /**
+     * Delete all user data which matches the specified context.
+     *
+     * @param   context $context A user context.
+     */
+    public static function delete_data_for_all_users_in_context(\context $context) {
+        // Delete data only for user context.
+        if ($context->contextlevel == CONTEXT_USER) {
+            static::delete_data($context->instanceid);
+        }
+    }
+
+    /**
+     * 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) {
+        $context = $userlist->get_context();
+
+        if ($context instanceof \context_user) {
+            static::delete_data($context->instanceid);
+        }
+    }
+
+    /**
+     * Delete all user data for the specified user, in the specified contexts.
+     *
+     * @param   approved_contextlist    $contextlist    The approved contexts and user information to delete information for.
+     */
+    public static function delete_data_for_user(approved_contextlist $contextlist) {
+        $user = $contextlist->get_user();
+        foreach ($contextlist->get_contexts() as $context) {
+            // Check if the context is a user context.
+            if ($context->contextlevel == CONTEXT_USER && $context->instanceid == $user->id) {
+                static::delete_data($context->instanceid);
+            }
+        }
+    }
+
+    /**
+     * Delete data related to a userid.
+     *
+     * @param  int $userid The user ID
+     */
+    protected static function delete_data($userid) {
+        global $DB;
+        $params = [
+            'userid' => $userid,
+            'datatype' => 'social'
+        ];
+
+        $DB->delete_records_select('user_info_data', "fieldid IN (
+                SELECT id FROM {user_info_field} WHERE datatype = :datatype)
+                AND userid = :userid", $params);
+    }
+
+    /**
+     * Get records related to this plugin and user.
+     *
+     * @param  int $userid The user ID
+     * @return array An array of records.
+     */
+    protected static function get_records($userid) {
+        global $DB;
+        $sql = "SELECT *
+                  FROM {user_info_data} uda
+                  JOIN {user_info_field} uif ON uda.fieldid = uif.id
+                 WHERE uda.userid = :userid
+                       AND uif.datatype = :datatype";
+        $params = [
+            'userid' => $userid,
+            'datatype' => 'social'
+        ];
+
+        return $DB->get_records_sql($sql, $params);
+    }
+}

user/profile/field/social/define.class.php

@@ -0,0 +1,95 @@
+<?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/>.
+
+/**
+ * Textarea profile field define.
+ *
+ * @package   profilefield_social
+ * @copyright 2020 Bas Brands <bas@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+/**
+ * Class profile_define_social.
+ *
+ * @copyright  2020 Bas Brands <bas@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class profile_define_social extends profile_define_base {
+
+    /**
+     * Prints out the form snippet for the part of creating or editing a profile field common to all data types.
+     *
+     * @param MoodleQuickForm $form instance of the moodleform class
+     */
+    public function define_form_common(&$form) {
+        $availablenetworks = profilefield_social\helper::get_networks();
+        $networks = array_merge(['0' => get_string('select')], $availablenetworks);
+
+        $form->addElement('hidden', 'defaultdata', '');
+        $form->setType('defaultdata', PARAM_TEXT);
+
+        $form->addElement('select', 'param1', get_string('networktype', 'profilefield_social'), $networks);
+        $form->addRule('param1', get_string('required'), 'required', null, 'client');
+        $form->setType('param1', PARAM_TEXT);
+
+        parent::define_form_common($form);
+        $form->removeElement('name');
+    }
+
+    /**
+     * Alter form based on submitted or existing data.
+     *
+     * @param MoodleQuickForm $form
+     */
+    public function define_after_data(&$form) {
+        if (isset($form->_defaultValues['name'])) {
+            $form->setDefault('param1', $form->_defaultValues['name']);
+        }
+    }
+
+    /**
+     * Validate the data from the add/edit profile field form that is common to all data types.
+     *
+     * Generally this method should not be overwritten by child classes.
+     *
+     * @param stdClass|array $data from the add/edit profile field form
+     * @param array $files
+     * @return  array    associative array of error messages
+     */
+    public function define_validate_common($data, $files) {
+        $err = parent::define_validate_common($data, $files);
+
+        $networks = profilefield_social\helper::get_networks();
+        if (empty($data->param1) || !array_key_exists($data->param1, $networks)) {
+            $err['param1'] = get_string('invalidnetwork', 'profilefield_social');
+        }
+        return $err;
+    }
+
+    /**
+     * Preprocess data from the add/edit profile field form before it is saved.
+     *
+     * This method is a hook for the child classes to overwrite.
+     *
+     * @param array|stdClass $data from the add/edit profile field form
+     * @return array|stdClass processed data object
+     */
+    public function define_save_preprocess($data) {
+        $data->name = $data->param1;
+        return $data;
+    }
+}

user/profile/field/social/field.class.php

@@ -0,0 +1,86 @@
+<?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/>.
+
+/**
+ * Social profile field define.
+ *
+ * @package    profilefield_social
+ * @copyright  2020 Bas Brands <bas@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+/**
+ * Class profile_field_social.
+ *
+ * @copyright  2020 Bas Brands <bas@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class profile_field_social extends profile_field_base {
+
+    /**
+     * Adds elements for this field type to the edit form.
+     * @param moodleform $mform
+     */
+    public function edit_field_add($mform) {
+        $mform->addElement('text', $this->inputname, $this->field->name, null, null);
+        if ($this->field->param1 === 'url') {
+            $mform->setType($this->inputname, PARAM_URL);
+        } else {
+            $mform->setType($this->inputname, PARAM_NOTAGS);
+        }
+    }
+
+    /**
+     * alter the fieldname to be fetched from the language file.
+     *
+     * @param stdClass $field
+     */
+    public function set_field($field) {
+        $networks = profilefield_social\helper::get_networks();
+        $field->name = $networks[$field->name];
+        parent::set_field($field);
+    }
+
+    /**
+     * Display the data for this field
+     * @return string
+     */
+    public function display_data() {
+        $network = $this->field->param1;
+        $networkurls = profilefield_social\helper::get_network_urls();
+
+        if (array_key_exists($network, $networkurls)) {
+            $pattern = ['%%ENCODED%%', '%%PLAIN%%'];
+            $data = [rawurlencode($this->data), $this->data];
+            return str_replace($pattern, $data, $networkurls[$network]);
+        }
+
+        return $this->data;
+    }
+
+    /**
+     * Return the field type and null properties.
+     * This will be used for validating the data submitted by a user.
+     *
+     * @return array the param type and null property
+     * @since Moodle 3.2
+     */
+    public function get_field_properties() {
+        return array(PARAM_TEXT, NULL_NOT_ALLOWED);
+    }
+}
+
+

user/profile/field/social/lang/en/profilefield_social.php

@@ -0,0 +1,39 @@
+<?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/>.
+
+/**
+ * Strings for component 'profilefield_social'
+ *
+ * @package   profilefield_social
+ * @copyright 2020 Bas Brands <bas@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+$string['invalidnetwork'] = 'Invalid social network';
+$string['networkinuse'] = 'Social network has already been added';
+$string['pluginname'] = 'Social';
+$string['networktype'] = 'Network type';
+$string['privacy:metadata:profile_field_social:data'] = 'Text area user profile field user data';
+$string['privacy:metadata:profile_field_social:dataformat'] = 'The format of Text area user profile field user data';
+$string['privacy:metadata:profile_field_social:fieldid'] = 'The ID of the profile field';
+$string['privacy:metadata:profile_field_social:tableexplanation'] = 'Additional profile data';
+$string['privacy:metadata:profile_field_social:userid'] = 'The ID of the user whose data is stored by the social user profile field';
+$string['aimid'] = 'AIM ID';
+$string['yahooid'] = 'Yahoo ID';
+$string['skypeid'] = 'Skype ID';
+$string['icqnumber'] = 'ICQ number';
+$string['msnid'] = 'MSN ID';
+$string['webpage'] = 'Web page';

user/profile/field/social/tests/behat/social_profile_field.feature

@@ -0,0 +1,23 @@
+@core @core_user
+Feature: Social profile fields can not have a duplicate shortname.
+  In order edit social profile fields properly
+  As an admin
+  I should not be able to create duplicate shortnames for social profile fields.
+
+  @javascript
+  Scenario: Verify you can edit social profile fields.
+    Given I log in as "admin"
+    When I navigate to "Users > Accounts > User profile fields" in site administration
+    And I click on "Create a new profile field" "link"
+    And I click on "Social" "link"
+    And I set the following fields to these values:
+      | Network type                  | Yahoo ID         |
+      | Short name                    | yahoo            |
+    And I click on "Save changes" "button"
+    And I click on "Create a new profile field" "link"
+    And I click on "Social" "link"
+    And I set the following fields to these values:
+      | Network type                  | Yahoo ID         |
+      | Short name                    | yahoo            |
+    And I click on "Save changes" "button"
+    Then I should see "This short name is already in use"

user/profile/field/social/tests/privacy/provider_test.php

@@ -0,0 +1,301 @@
+<?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/>.
+
+/**
+ * Base class for unit tests for profilefield_social.
+ *
+ * @package   profilefield_social
+ * @copyright 2020 Bas Brands <bas@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace profilefield_social\privacy;
+
+defined('MOODLE_INTERNAL') || die();
+
+use core_privacy\tests\provider_testcase;
+use profilefield_social\privacy\provider;
+use core_privacy\local\request\approved_userlist;
+
+/**
+ * Unit tests for user\profile\field\social\classes\privacy\provider.php
+ *
+ * @copyright  2020 Bas Brands <bas@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class provider_test extends provider_testcase {
+
+    /**
+     * Basic setup for these tests.
+     */
+    public function setUp(): void {
+        $this->resetAfterTest(true);
+    }
+
+    /**
+     * Test getting the context for the user ID related to this plugin.
+     */
+    public function test_get_contexts_for_userid(): void {
+        global $DB;
+        // Create profile category.
+        $categoryid = $this->add_profile_category();
+        // Create profile field.
+        $profilefieldid = $this->add_profile_field($categoryid, 'social');
+        // Create a user.
+        $user = $this->getDataGenerator()->create_user();
+        $this->add_user_info_data($user->id, $profilefieldid, 'test data');
+        // Get the field that was created.
+        $userfielddata = $DB->get_records('user_info_data', array('userid' => $user->id));
+        // Confirm we got the right number of user field data.
+        $this->assertCount(1, $userfielddata);
+        $context = \context_user::instance($user->id);
+        $contextlist = provider::get_contexts_for_userid($user->id);
+        $this->assertEquals($context, $contextlist->current());
+    }
+
+    /**
+     * Test that data is exported correctly for this plugin.
+     */
+    public function test_export_user_data(): void {
+        // Create profile category.
+        $categoryid = $this->add_profile_category();
+        // Create social profile field.
+        $socialprofilefieldid = $this->add_profile_field($categoryid, 'social');
+        // Create checkbox profile field.
+        $checkboxprofilefieldid = $this->add_profile_field($categoryid, 'checkbox');
+        // Create a user.
+        $user = $this->getDataGenerator()->create_user();
+        $context = \context_user::instance($user->id);
+        // Add social user info data.
+        $this->add_user_info_data($user->id, $socialprofilefieldid, '#icq-1294923');
+        // Add checkbox user info data.
+        $this->add_user_info_data($user->id, $checkboxprofilefieldid, 'test data');
+        $writer = \core_privacy\local\request\writer::with_context($context);
+        $this->assertFalse($writer->has_any_data());
+        $this->export_context_data_for_user($user->id, $context, 'profilefield_social');
+        $data = $writer->get_data([get_string('pluginname', 'profilefield_social')]);
+        $this->assertCount(3, (array) $data);
+        $this->assertEquals('icq', $data->name);
+        $this->assertEquals('', $data->description);
+        $this->assertEquals('#icq-1294923', $data->data);
+    }
+
+    /**
+     * Test that user data is deleted using the context.
+     */
+    public function test_delete_data_for_all_users_in_context(): void {
+        global $DB;
+        // Create profile category.
+        $categoryid = $this->add_profile_category();
+        // Create social profile field.
+        $socialprofilefieldid = $this->add_profile_field($categoryid, 'social');
+        // Create checkbox profile field.
+        $checkboxprofilefieldid = $this->add_profile_field($categoryid, 'checkbox');
+        // Create a user.
+        $user = $this->getDataGenerator()->create_user();
+        $context = \context_user::instance($user->id);
+        // Add social user info data.
+        $this->add_user_info_data($user->id, $socialprofilefieldid, '#icq-1294923');
+        // Add checkbox user info data.
+        $this->add_user_info_data($user->id, $checkboxprofilefieldid, 'test data');
+        // Check that we have two entries.
+        $userinfodata = $DB->get_records('user_info_data', ['userid' => $user->id]);
+        $this->assertCount(2, $userinfodata);
+        provider::delete_data_for_all_users_in_context($context);
+        // Check that the correct profile field has been deleted.
+        $userinfodata = $DB->get_records('user_info_data', ['userid' => $user->id]);
+        $this->assertCount(1, $userinfodata);
+        $this->assertNotEquals('#icq-1294923', reset($userinfodata)->data);
+    }
+
+    /**
+     * Test that user data is deleted for this user.
+     */
+    public function test_delete_data_for_user(): void {
+        global $DB;
+        // Create profile category.
+        $categoryid = $this->add_profile_category();
+        // Create social profile field.
+        $socialprofilefieldid = $this->add_profile_field($categoryid, 'social');
+        // Create checkbox profile field.
+        $checkboxprofilefieldid = $this->add_profile_field($categoryid, 'checkbox');
+        // Create a user.
+        $user = $this->getDataGenerator()->create_user();
+        $context = \context_user::instance($user->id);
+        // Add social user info data.
+        $this->add_user_info_data($user->id, $socialprofilefieldid, '#icq-1294923');
+        // Add checkbox user info data.
+        $this->add_user_info_data($user->id, $checkboxprofilefieldid, 'test data');
+        // Check that we have two entries.
+        $userinfodata = $DB->get_records('user_info_data', ['userid' => $user->id]);
+        $this->assertCount(2, $userinfodata);
+        $approvedlist = new \core_privacy\local\request\approved_contextlist($user, 'profilefield_social',
+            [$context->id]);
+        provider::delete_data_for_user($approvedlist);
+        // Check that the correct profile field has been deleted.
+        $userinfodata = $DB->get_records('user_info_data', ['userid' => $user->id]);
+        $this->assertCount(1, $userinfodata);
+        $this->assertNotEquals('#icq-1294923', reset($userinfodata)->data);
+    }
+
+    /**
+     * Test that only users with a user context are fetched.
+     */
+    public function test_get_users_in_context(): void {
+        $this->resetAfterTest();
+
+        $component = 'profilefield_social';
+        // Create profile category.
+        $categoryid = $this->add_profile_category();
+        // Create profile field.
+        $profilefieldid = $this->add_profile_field($categoryid, 'social');
+
+        // Create a user.
+        $user = $this->getDataGenerator()->create_user();
+        $usercontext = \context_user::instance($user->id);
+        // The list of users should not return anything yet (related data still haven't been created).
+        $userlist = new \core_privacy\local\request\userlist($usercontext, $component);
+        provider::get_users_in_context($userlist);
+        $this->assertCount(0, $userlist);
+
+        $this->add_user_info_data($user->id, $profilefieldid, 'test data');
+
+        // The list of users for user context should return the user.
+        provider::get_users_in_context($userlist);
+        $this->assertCount(1, $userlist);
+        $expected = [$user->id];
+        $actual = $userlist->get_userids();
+        $this->assertEquals($expected, $actual);
+
+        // The list of users for system context should not return any users.
+        $systemcontext = \context_system::instance();
+        $userlist = new \core_privacy\local\request\userlist($systemcontext, $component);
+        provider::get_users_in_context($userlist);
+        $this->assertCount(0, $userlist);
+    }
+
+    /**
+     * Test that data for users in approved userlist is deleted.
+     */
+    public function test_delete_data_for_users(): void {
+        $this->resetAfterTest();
+
+        $component = 'profilefield_social';
+        // Create profile category.
+        $categoryid = $this->add_profile_category();
+        // Create profile field.
+        $profilefieldid = $this->add_profile_field($categoryid, 'social');
+
+        // Create user1.
+        $user1 = $this->getDataGenerator()->create_user();
+        $usercontext1 = \context_user::instance($user1->id);
+        // Create user2.
+        $user2 = $this->getDataGenerator()->create_user();
+        $usercontext2 = \context_user::instance($user2->id);
+
+        $this->add_user_info_data($user1->id, $profilefieldid, 'test data');
+        $this->add_user_info_data($user2->id, $profilefieldid, 'test data');
+
+        // The list of users for usercontext1 should return user1.
+        $userlist1 = new \core_privacy\local\request\userlist($usercontext1, $component);
+        provider::get_users_in_context($userlist1);
+        $this->assertCount(1, $userlist1);
+        $expected = [$user1->id];
+        $actual = $userlist1->get_userids();
+        $this->assertEquals($expected, $actual);
+
+        // The list of users for usercontext2 should return user2.
+        $userlist2 = new \core_privacy\local\request\userlist($usercontext2, $component);
+        provider::get_users_in_context($userlist2);
+        $this->assertCount(1, $userlist2);
+        $expected = [$user2->id];
+        $actual = $userlist2->get_userids();
+        $this->assertEquals($expected, $actual);
+
+        // Add userlist1 to the approved user list.
+        $approvedlist = new approved_userlist($usercontext1, $component, $userlist1->get_userids());
+
+        // Delete user data using delete_data_for_user for usercontext1.
+        provider::delete_data_for_users($approvedlist);
+
+        // Re-fetch users in usercontext1 - The user list should now be empty.
+        $userlist1 = new \core_privacy\local\request\userlist($usercontext1, $component);
+        provider::get_users_in_context($userlist1);
+        $this->assertCount(0, $userlist1);
+
+        // Re-fetch users in usercontext2 - The user list should not be empty (user2).
+        $userlist2 = new \core_privacy\local\request\userlist($usercontext2, $component);
+        provider::get_users_in_context($userlist2);
+        $this->assertCount(1, $userlist2);
+
+        // User data should be only removed in the user context.
+        $systemcontext = \context_system::instance();
+        // Add userlist2 to the approved user list in the system context.
+        $approvedlist = new approved_userlist($systemcontext, $component, $userlist2->get_userids());
+        // Delete user1 data using delete_data_for_user.
+        provider::delete_data_for_users($approvedlist);
+        // Re-fetch users in usercontext2 - The user list should not be empty (user2).
+        $userlist1 = new \core_privacy\local\request\userlist($usercontext2, $component);
+        provider::get_users_in_context($userlist1);
+        $this->assertCount(1, $userlist1);
+    }
+
+    /**
+     * Add dummy user info data.
+     *
+     * @param int $userid The ID of the user
+     * @param int $fieldid The ID of the field
+     * @param string $data The data
+     */
+    private function add_user_info_data($userid, $fieldid, $data) {
+        global $DB;
+        $userinfodata = array(
+            'userid' => $userid,
+            'fieldid' => $fieldid,
+            'data' => $data,
+            'dataformat' => 0
+        );
+
+        $DB->insert_record('user_info_data', $userinfodata);
+    }
+
+    /**
+     * Add dummy profile category.
+     *
+     * @return int The ID of the profile category
+     */
+    private function add_profile_category() {
+        $cat = $this->getDataGenerator()->create_custom_profile_field_category(['name' => 'Test category']);
+        return $cat->id;
+    }
+
+    /**
+     * Add dummy profile field.
+     *
+     * @param int $categoryid The ID of the profile category
+     * @param string $datatype The datatype of the profile field
+     * @return int The ID of the profile field
+     */
+    private function add_profile_field($categoryid, $datatype) {
+        $data = $this->getDataGenerator()->create_custom_profile_field([
+            'datatype' => $datatype,
+            'shortname' => 'icq',
+            'name' => 'icq',
+            'description' => '',
+            'categoryid' => $categoryid,
+        ]);
+        return $data->id;
+    }
+}

user/profile/field/social/upgradelib.php

@@ -0,0 +1,196 @@
+<?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/>.
+
+/**
+ * Contains upgrade and install functions for the social profile fields.
+ *
+ * @package    profilefield_social
+ * @copyright  2020 Bas Brands <bas@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+require_once("$CFG->dirroot/user/profile/definelib.php");
+
+/**
+ * Create the default category for custom profile fields if it does not exist yet.
+ *
+ * @return int Category ID for social user profile category.
+ */
+function user_profile_social_create_info_category(): int {
+    global $DB;
+
+    $categories = $DB->get_records('user_info_category', null, 'sortorder ASC');
+    // Check that we have at least one category defined.
+    if (empty($categories)) {
+        $defaultcategory = (object) [
+            'name' => get_string('profiledefaultcategory', 'admin'),
+            'sortorder' => 1
+        ];
+        return $DB->insert_record('user_info_category', $defaultcategory);
+    } else {
+        return (int)$DB->get_field_sql('SELECT min(id) from {user_info_category}');
+    }
+}
+
+/**
+ * Called on upgrade to create new profile fields based on the old user table columns
+ * for icq, msn, aim, skype and url.
+ *
+ * @param string $social Social profile field.
+ */
+function user_profile_social_moveto_profilefield($social) {
+    global $DB;
+
+    $users = $DB->get_records_select('user', "$social IS NOT NULL AND $social != ''");
+    if (count($users)) {
+        $profilefield = user_profile_social_create_profilefield($social);
+        foreach ($users as $user) {
+            $userinfodata = [
+                'userid' => $user->id,
+                'fieldid' => $profilefield->id,
+                'data' => $user->$social,
+                'dataformat' => 0
+            ];
+            $user->$social = '';
+            $DB->update_record('user', $user);
+            $DB->insert_record('user_info_data', $userinfodata);
+        }
+    }
+}
+
+/**
+ * Create an new custom social profile field if it does not exist
+ *
+ * @param string $social Social profile field.
+ * @return object DB record or social profield field.
+ */
+function user_profile_social_create_profilefield($social) {
+    global $DB, $CFG;
+
+    $hiddenfields = explode(',', $CFG->hiddenuserfields);
+    $confignames = [
+        'url' => 'webpage',
+        'icq' => 'icqnumber',
+        'skype' => 'skypeid',
+        'yahoo' => 'yahooid',
+        'aim' => 'aimid',
+        'msn' => 'msnid',
+    ];
+    $visible = (in_array($confignames[$social], $hiddenfields)) ? 3 : 2;
+
+    $categoryid = user_profile_social_create_info_category();
+
+    $newfield = (object)[
+        'shortname' => $social,
+        'name' => $social,
+        'datatype' => 'social',
+        'description' => '',
+        'descriptionformat' => 1,
+        'categoryid' => $categoryid,
+        'required' => 0,
+        'locked' => 0,
+        'visible' => $visible,
+        'forceunique' => 0,
+        'signup' => 0,
+        'defaultdata' => '',
+        'defaultdataformat' => 0,
+        'param1' => $social
+    ];
+
+    $profilefield = $DB->get_record_sql(
+        'SELECT * FROM {user_info_field} WHERE datatype = :datatype AND ' .
+        $DB->sql_compare_text('param1') . ' = ' . $DB->sql_compare_text(':social', 40),
+        ['datatype' => 'social', 'social' => $social]);
+
+    if (!$profilefield) {
+
+        // Find a new unique shortname.
+        $count = 0;
+        $shortname = $newfield->shortname;
+        while ($field = $DB->get_record('user_info_field', array('shortname' => $shortname))) {
+            $count++;
+            $shortname = $newfield->shortname . '_' . $count;
+        }
+        $newfield->shortname = $shortname;
+
+        $profileclass = new profile_define_base();
+        $profileclass->define_save($newfield);
+        profile_reorder_fields();
+
+        $profilefield = $DB->get_record_sql(
+            'SELECT * FROM {user_info_field} WHERE datatype = :datatype AND ' .
+            $DB->sql_compare_text('param1') . ' = ' . $DB->sql_compare_text(':social', 40),
+            ['datatype' => 'social', 'social' => $social]);
+    }
+    if (!$profilefield) {
+        throw new moodle_exception('upgradeerror', 'admin', 'could not create new social profile field');
+    }
+    return $profilefield;
+}
+
+/**
+ * Update the module availability configuration for all course modules
+ *
+ */
+function user_profile_social_update_module_availability() {
+    global $DB;
+    // Use transaction to improve performance if there are many individual database updates.
+    $transaction = $DB->start_delegated_transaction();
+    // Query all the course_modules entries that have availability set.
+    $rs = $DB->get_recordset_select('course_modules', 'availability IS NOT NULL', [], '', 'id, availability');
+    foreach ($rs as $mod) {
+        if (isset($mod->availability)) {
+            $availability = json_decode($mod->availability);
+            if (!is_null($availability)) {
+                user_profile_social_update_availability_structure($availability);
+                $newavailability = json_encode($availability);
+                if ($newavailability !== $mod->availability) {
+                    $mod->availability = json_encode($availability);
+                    $DB->update_record('course_modules', $mod);
+                }
+            }
+        }
+    }
+    $rs->close();
+    $transaction->allow_commit();
+}
+
+/**
+ * Loop through the availability info and change all move standard profile
+ * fields for icq, skype, aim, yahoo, msn and url to be custom profile fields.
+ * @param mixed $structure The availability object.
+ */
+function user_profile_social_update_availability_structure(&$structure) {
+    if (is_array($structure)) {
+        foreach ($structure as $st) {
+            user_profile_social_update_availability_structure($st);
+        }
+    }
+    foreach ($structure as $key => $value) {
+        if ($key === 'c' && is_array($value)) {
+            user_profile_social_update_availability_structure($value);
+        }
+        if ($key === 'type' && $value === 'profile') {
+            if (isset($structure->sf) && in_array($structure->sf,
+                ['icq', 'skype', 'aim', 'yahoo', 'msn', 'url'])) {
+                $structure->cf = $structure->sf;
+                unset($structure->sf);
+            }
+        }
+    }
+}

user/profile/field/social/version.php

@@ -0,0 +1,29 @@
+<?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/>.
+
+/**
+ * Version information for the social profile field.
+ *
+ * @package    profilefield_social
+ * @copyright  2020 Bas Brands <bas@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$plugin->version   = 2024042200;
+$plugin->requires  = 2024041600;
+$plugin->component = 'profilefield_social';