<?php
/**
 * webtrees: online genealogy
 * Copyright (C) 2019 webtrees development team
 * This program 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.
 * 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. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
declare(strict_types=1);

namespace Fisharebest\Webtrees;

/**
 * Test the user functions
 */
class AuthTest extends \Fisharebest\Webtrees\TestCase
{
    protected static $uses_database = true;

    /**
     * @covers \Fisharebest\Webtrees\Auth::check
     * @covers \Fisharebest\Webtrees\Auth::login
     * @covers \Fisharebest\Webtrees\Auth::logout
     *
     * @return void
     */
    public function testLoginAndLogout(): void
    {
        $user = User::create('user', 'User', 'user@example.com', 'secret');
        $this->assertFalse(Auth::check());

        Auth::login($user);
        $this->assertTrue(Auth::check());

        Auth::logout();
        $this->assertFalse(Auth::check());
    }

    /**
     * @covers \Fisharebest\Webtrees\Auth::id
     *
     * @return void
     */
    public function testIdNumbers(): void
    {
        // Initially, a visitor.
        $this->assertNull(Auth::id());

        // ID numbers are issued sequentially, starting at 1.
        $user1 = User::create('user1', 'User1', 'user1@example.com', 'secret');
        Auth::login($user1);
        $this->assertSame(1, Auth::id());

        $user2 = User::create('user2', 'User2', 'user2@example.com', 'secret');
        Auth::login($user2);
        $this->assertSame(2, Auth::id());
    }

    /**
     * @covers \Fisharebest\Webtrees\Auth::user
     *
     * @return void
     */
    public function testVisitors(): void
    {
        // A visitor.
        $user = Auth::user();

        $this->assertSame(0, $user->getUserId());
        $this->assertSame('', $user->getUserName());
        $this->assertSame('', $user->getRealName());
        $this->assertSame('', $user->getEmail());

        // Logged in.
        $user = User::create('user', 'User', 'user@example.com', 'secret');
        Auth::login($user);
        $user = Auth::user();
        $this->assertSame(1, $user->getUserId());
        $this->assertSame('user', $user->getUserName());
        $this->assertSame('User', $user->getRealName());
        $this->assertSame('user@example.com', $user->getEmail());
    }

    /**
     * @covers \Fisharebest\Webtrees\Auth::isAdmin
     *
     * @return void
     */
    public function testAdministrator(): void
    {
        // By default, new users are not admins.
        $user = User::create('admin', 'Administrator', 'admin@example.com', 'secret');
        $this->assertFalse(Auth::isAdmin($user));

        // Make the user a manager.
        $user->setPreference('canadmin', '1');
        $this->assertTrue(Auth::isAdmin($user));

        // Test that the current user is an admin.
        $this->assertFalse(Auth::isAdmin());
        Auth::login($user);
        $this->assertTrue(Auth::isAdmin());
    }

    /**
     * @covers \Fisharebest\Webtrees\Auth::isManager
     * @covers \Fisharebest\Webtrees\Auth::accessLevel
     *
     * @return void
     */
    public function testManager(): void
    {
        $tree = Tree::create('test', 'Test');
        $tree->setPreference('imported', '1');

        // By default, new users are not managers.
        $user = User::create('manager', 'Manager', 'manager@example.com', 'secret');
        $this->assertFalse(Auth::isManager($tree, $user));
        $this->assertSame(Auth::PRIV_PRIVATE, Auth::accessLevel($tree, $user));

        // Make the user a manager.
        $tree->setUserPreference($user, 'canedit', 'admin');
        $this->assertTrue(Auth::isManager($tree, $user));
        $this->assertSame(Auth::PRIV_NONE, Auth::accessLevel($tree, $user));

        // Test that the current user is a manager.
        $this->assertFalse(Auth::isManager($tree));
        $this->assertSame(Auth::PRIV_PRIVATE, Auth::accessLevel($tree));
        Auth::login($user);
        $this->assertTrue(Auth::isManager($tree));
        $this->assertSame(Auth::PRIV_NONE, Auth::accessLevel($tree));
    }

    /**
     * @covers \Fisharebest\Webtrees\Auth::isModerator
     * @covers \Fisharebest\Webtrees\Auth::accessLevel
     *
     * @return void
     */
    public function testModerator(): void
    {
        // By default, new users are not moderators.
        $user = User::create('moderator', 'Moderator', 'moderator@example.com', 'secret');
        $tree = Tree::create('test', 'Test');
        $this->assertFalse(Auth::isModerator($tree, $user));
        $this->assertSame(Auth::PRIV_PRIVATE, Auth::accessLevel($tree, $user));

        // Make the user a moderator.
        $tree->setUserPreference($user, 'canedit', 'accept');
        $this->assertTrue(Auth::isModerator($tree, $user));
        $this->assertSame(Auth::PRIV_USER, Auth::accessLevel($tree, $user));

        // Test that the current user is a moderator.
        $this->assertFalse(Auth::isModerator($tree));
        $this->assertSame(Auth::PRIV_PRIVATE, Auth::accessLevel($tree));
        Auth::login($user);
        $this->assertTrue(Auth::isModerator($tree));
        $this->assertSame(Auth::PRIV_USER, Auth::accessLevel($tree));
    }

    /**
     * @covers \Fisharebest\Webtrees\Auth::isEditor
     * @covers \Fisharebest\Webtrees\Auth::accessLevel
     *
     * @return void
     */
    public function testEditor(): void
    {
        // By default, new users are not editors.
        $user = User::create('editor', 'Editor', 'editor@example.com', 'secret');
        $tree = Tree::create('test', 'Test');
        $this->assertFalse(Auth::isEditor($tree, $user));
        $this->assertSame(Auth::PRIV_PRIVATE, Auth::accessLevel($tree, $user));

        // Make the user an editor.
        $tree->setUserPreference($user, 'canedit', 'edit');
        $this->assertTrue(Auth::isEditor($tree, $user));
        $this->assertSame(Auth::PRIV_USER, Auth::accessLevel($tree, $user));

        // Test that the current user is an editor.
        $this->assertFalse(Auth::isEditor($tree));
        $this->assertSame(Auth::PRIV_PRIVATE, Auth::accessLevel($tree));
        Auth::login($user);
        $this->assertTrue(Auth::isEditor($tree));
        $this->assertSame(Auth::PRIV_USER, Auth::accessLevel($tree));
    }

    /**
     * @covers \Fisharebest\Webtrees\Auth::isMember
     * @covers \Fisharebest\Webtrees\Auth::accessLevel
     *
     * @return void
     */
    public function testMember(): void
    {
        // By default, new users are not members.
        $user = User::create('member', 'Member', 'member@example.com', 'secret');
        $tree = Tree::create('test', 'Test');
        $this->assertFalse(Auth::isMember($tree, $user));
        $this->assertSame(Auth::PRIV_PRIVATE, Auth::accessLevel($tree, $user));

        // Make the user a members.
        $tree->setUserPreference($user, 'canedit', 'access');
        $this->assertTrue(Auth::isMember($tree, $user));
        $this->assertSame(Auth::PRIV_USER, Auth::accessLevel($tree, $user));

        // Test that the current user is a member.
        $this->assertFalse(Auth::isMember($tree));
        $this->assertSame(Auth::PRIV_PRIVATE, Auth::accessLevel($tree));
        Auth::login($user);
        $this->assertTrue(Auth::isMember($tree));
        $this->assertSame(Auth::PRIV_USER, Auth::accessLevel($tree));
    }
}