Provisioning.php

Go to the documentation of this file.

<?php
/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 This program 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.
*/

namespace Xoops\Auth;

use Xoops\Core\Kernel\Criteria;

class Provisioning
{
    protected $auth_instance;

    public $ldap_provisioning;

    public $ldap_provisioning_upd;

    public $ldap_field_mapping;

    public $ldap_provisioning_group;

    public static function getInstance(AuthAbstract $auth_instance)
    {
        static $provis_instance;
        if (!isset($provis_instance)) {
            $provis_instance = new self($auth_instance);
        }

        return $provis_instance;
    }

    public function __construct(AuthAbstract $auth_instance)
    {
        $xoops = \Xoops::getInstance();
        $this->auth_instance = $auth_instance;
        $configs = $xoops->getConfigs();
        foreach ($configs as $key => $val) {
            $this->$key = $val;
        }
    }

    public function getXoopsUser($uname)
    {
        $xoops = \Xoops::getInstance();
        $member_handler = $xoops->getHandlerMember();
        $criteria = new Criteria('uname', $uname);
        $getuser = $member_handler->getUsers($criteria);
        if (count($getuser) == 1) {
            return $getuser[0];
        } else {
            return false;
        }
    }

    public function sync($data, $uname, $pwd = null)
    {
        $xoopsUser = $this->getXoopsUser($uname);
        if (!$xoopsUser) { // Xoops User Database not exists
            if ($this->ldap_provisioning) {
                $xoopsUser = $this->add($data, $uname, $pwd);
            } else {
                $this->auth_instance->setErrors(0, sprintf(
                    \XoopsLocale::EF_CORRESPONDING_USER_NOT_FOUND_IN_DATABASE,
                    $uname
                ));
            }
        } else { // Xoops User Database exists
            if ($this->ldap_provisioning && $this->ldap_provisioning_upd) {
                $xoopsUser = $this->change($xoopsUser, $data, $uname, $pwd);
            }
        }

        return $xoopsUser;
    }

    protected function setVarsMapping($object, $data)
    {
        $tab_mapping = explode('|', $this->ldap_field_mapping);
        foreach ($tab_mapping as $mapping) {
            $fields = explode('=', trim($mapping));
            if (isset($fields[0]) and ($field0 = trim($fields[0]))) {
                $str = '';
                if (isset($fields[1]) and ($field1 = trim($fields[1]))) {
                    if (!empty($data[$field1][0])) {
                        $str = $data[$field1][0];
                    }
                }
                $object->setVar($field0, $str);
            }
        }
    }

    public function add($data, $uname, $pwd = null)
    {
        $xoops = \Xoops::getInstance();
        $ret = false;
        $member_handler = $xoops->getHandlerMember();
        // Create XOOPS Database User
        $newuser = $member_handler->createUser();
        $newuser->setVar('uname', $uname);
        $newuser->setVar('pass', password_hash(stripslashes($pwd), PASSWORD_DEFAULT));
        $newuser->setVar('rank', 0);
        $newuser->setVar('level', 1);
        $newuser->setVar('timezone_offset', $xoops->getConfig('default_TZ'));
        $newuser->setVar('theme', $xoops->getConfig('theme_set'));
        //$newuser->setVar('umode', $xoops->getConfig('com_mode'));
        //$newuser->setVar('uorder', $xoops->getConfig('com_order'));
        $newuser->setVar('user_regdate', time());
        $this->setVarsMapping($newuser, $data);

        if ($member_handler->insertUser($newuser)) {
            foreach ($this->ldap_provisioning_group as $groupid) {
                $member_handler->addUserToGroup($groupid, $newuser->getVar('uid'));
            }
            $newuser->unsetNew();

            return $newuser;
        } else {
            $xoops->redirect(\XoopsBaseConfig::get('url') . '/user.php', 5, $newuser->getHtmlErrors());
        }

        return $ret;
    }

    public function change(\XoopsUser $xoopsUser, $data, $uname, $pwd = null)
    {
        $xoops = \Xoops::getInstance();
        $ret = false;
        $member_handler = $xoops->getHandlerMember();
        $xoopsUser->setVar('pass', password_hash(stripslashes($pwd), PASSWORD_DEFAULT));
        $this->setVarsMapping($xoopsUser, $data);

        if ($member_handler->insertUser($xoopsUser)) {
            return $xoopsUser;
        } else {
            $xoops->redirect(\XoopsBaseConfig::get('url') . '/user.php', 5, $xoopsUser->getHtmlErrors());
        }

        return $ret;
    }

    public function delete()
    {
    }

    public function suspend()
    {
    }

    public function restore()
    {
    }

    public function resetpwd()
    {
    }
}