XoopsAuthHandler.php

<?php
/*
 * This file has its roots as part of the Mojavi package which was
 * Copyright (c) 2003 Sean Kerr. It has been incorporated into this
 * derivative work under the terms of the LGPL V2.1.
 * (http://www.gnu.org/licenses/lgpl-2.1.html)
 */

namespace Xmf\Xadr;

use Xmf\Xadr\Exceptions\InvalidConfigurationException;

/**
 * The XoopsAuthHandler implements an AuthorizationHandler that
 * uses XOOPS for user authentication.
 *
 * If a user has not signed in and attempts access to a secure Action,
 * the session will redirect to the system login with the xoops_redirect
 * option set to return to reattempt the secure Action.
 *
 * @category  Xmf\Xadr\XoopsAuthHandler
 * @package   Xmf
 * @author    Richard Griffith <richard@geekwright.com>
 * @author    Sean Kerr <skerr@mojavi.org>
 * @copyright 2013-2015 XOOPS Project (http://xoops.org)
 * @copyright 2003 Sean Kerr
 * @license   GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 * @link      http://xoops.org
 */
class XoopsAuthHandler extends AuthorizationHandler
{

    /**
     * Determine the user authorization status for an action request by
     * verifying against a required privilege.
     *
     *  _This should never be called manually._
     *
     * @param Action $action An Action instance.
     *
     * @return bool|null true if authorized, false otherwise
     *
     * @throws InvalidConfigurationException
     */
    public function execute(Action $action)
    {
        $xoops = \Xoops::getInstance();
        if (!$this->user()->isAuthenticated() || !($this->user() instanceof XoopsUser)) {
            // if we need to authenticate, do XOOPS login rather than
            // using AUTH_UNIT AUTH_ACTION conventions

            $url=$this->controller()->getControllerPath();
            $query = \Xmf\Request::getString('QUERY_STRING', '', 'server');
            if ($query != '') {
                $url = $this->controller()->getControllerPath() . '?' . urlencode($query);
            }
            $parts=parse_url($url);
            $url=$parts['path'].(empty($parts['query'])?'':'?'.$parts['query']);

            $xoops->redirect(
                $xoops->url('www/user.php') . '?xoops_redirect='.$url,
                2,
                \XoopsLocale::E_NO_ACTION_PERMISSION
            );
        }

        $privilege = $action->getRequiredPrivilege();

        if ($privilege !== null
            && !$this->user()->hasPrivilege($privilege)
        ) {
            $secure_unit=$this->Config()->get('SECURE_UNIT', 'App');
            $secure_action=$this->Config()->get('SECURE_ACTION', 'NoPermission');
            // user doesn't have privilege to access
            $action = $this->controller()->getAction($secure_unit, $secure_action);
            if ($action !== null) {
                $this->controller()->forward($secure_unit, $secure_action);
                return false;
            }

            // cannot find secure action
            $error = 'Invalid secure action: ' .
                     'SECURE_UNIT (' . $secure_unit . '), ' .
                     'SECURE_ACTION (' . $secure_action . ')';
            throw new InvalidConfigurationException($error);
        }

        // user is authenticated, and has the required privilege
        // or no privilege is required
        return true;
    }
}