lib.php

<?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/>.

/**
 * Automatically create a username according to a given tenant
 * Default: username of creator plus prefix
 *
 * @param  stdClass $creator  user who creates new user
 * @return string username
 */
function block_userprofile_update_create_username(stdClass $creator): string {
    $blockconfig = block_userprofile_update_get_config();
    $usernumber = [];

    // Get all users that have the same partnerid.
    $partnerusers = block_userprofile_update_get_matchingusers($blockconfig['partnerid'], $blockconfig['profilepartnerid'],
            $creator->id);
    if (!empty($partnerusers)) {
        foreach ($partnerusers as $user) {
            $success = preg_match('/m(\d+?)_.+?/', $user->username, $matches);
            if ($success) {
                $usernumber[] = $matches[1];
            }
        }
    }
    if (!empty($usernumber)) {
        $newusernumber = max($usernumber) + 1;
        $username = 'm' . $newusernumber . "_" . $creator->profile[$blockconfig['profilepartnerid']];
    } else {
        $username = 'm1_'. $creator->profile[$blockconfig['profilepartnerid']];
    }
    // Define new username.
    return $username;
}

/**
 *  Get all users who have the same partnerid.
 *
 * @param string $partnerid PBL number
 * @param string $profilefieldshortname name of the profile field used to store the partnerid
 * @param int $userid the id of the partner usually $USER
 * @param bool $excludepartner do not retrieve the partners of the tenant
 * @return array of user objects indexed by user id
 */
function block_userprofile_update_get_matchingusers(string $partnerid,
        string $profilefieldshortname, int $userid): array {
    global $DB;
    if (empty($partnerid)) {
        return [];
    }
    $usercreators = user_get_users_by_id([$userid]);
    $usercreator = $usercreators[$userid];
    profile_load_custom_fields($usercreator);
    $partnerfield = get_config('block_userprofile_update', 'ispartner');
    // When the usercreator is not partner, then an employee creates the user. So include employee in the count
    if (!isset($usercreator->profile[$partnerfield]) || $usercreator->profile[$partnerfield] === "0") {
        $userid = 0;
    }
    // Construct the SQL query to retrieve users with the same "partnerid".
    $sql = "SELECT u.* 
        FROM {user} u
        INNER JOIN {user_info_data} pid ON u.id = pid.userid
        WHERE pid.data = :partnerid
        AND pid.fieldid = (SELECT id FROM {user_info_field} WHERE shortname = :fieldshortname)
        AND u.id != :userid";

    $params = array('partnerid' => $partnerid, 'fieldshortname' => $profilefieldshortname, 'userid' => $userid);
    // Execute the query.
    return $DB->get_records_sql($sql, $params);
}

/**
 * Get partner from tennant of current $USER.
 * @return array of userids
 */
function block_userprofile_update_get_tenant_partners(): array {
    global $DB;
    $config = block_userprofile_update_get_config();
    $params = ['tenantfield' => $config['profiletenant'], 'partnerfield' => $config['ispartner'],
            'tenantname' => $config['tenant']];
    $sql = "SELECT u.id
    FROM {user} u 
    JOIN {user_info_data} uid ON uid.userid = u.id
    JOIN {user_info_field} uif ON uif.id = uid.fieldid
    JOIN {user_info_data} uid2 ON uid2.userid = u.id
    JOIN {user_info_field} uif2 ON uif2.id = uid2.fieldid
    WHERE uif.shortname = :partnerfield AND uid.data = '1'
    AND uif2.shortname = :tenantfield AND uid2.data = :tenantname";
    $userids = $DB->get_fieldset_sql($sql, $params);
    return $userids;
}

/**
 *  Get config and profile field values for $USER.
 *  We get the partnerid of the user, the profile field name where it is saved and
 *  the tenantname and the profilefield short name where the tenant name ist saved.
 *
 * @return array with partnerid, tenant, profilepartnerid, profiletenant
 */
function block_userprofile_update_get_config(): array {
    global $USER;
    // Profile field where the partner id is saved.
    $profilefieldpartnerid = get_config('block_userprofile_update', 'partnerid');
    $profiletenant = get_config('block_userprofile_update', 'selecttenant');
    $partnerfield = get_config('block_userprofile_update', 'ispartner');
    $partnerstatusfield = get_config('block_userprofile_update', 'partnerstatus');
    // Get the partnerid.
    profile_load_custom_fields($USER);
    $partnerid = $USER->profile[$profilefieldpartnerid] ?: 0;
    $tenantid = $USER->profile[$profiletenant] ?: '';
    return ['partnerid' => $partnerid,
            'tenant' => $tenantid,
            'ispartner' => $partnerfield,
            'profilepartnerid' => $profilefieldpartnerid,
            'profiletenant' => $profiletenant,
            'profilestatusfield' => $partnerstatusfield];
}