enwikipedia-acc / waca

includes/Fragments/NavigationMenuAccessControl.php

<?php
/******************************************************************************
 * Wikipedia Account Creation Assistance tool                                 *
 * ACC Development Team. Please see team.json for a list of contributors.     *
 *                                                                            *
 * This is free and unencumbered software released into the public domain.    *
 * Please see LICENSE.md for the full licencing statement.                    *
 ******************************************************************************/

namespace Waca\Fragments;

use Waca\DataObjects\Comment;
use Waca\DataObjects\JobQueue;
use Waca\DataObjects\User;
use Waca\Helpers\SearchHelpers\JobQueueSearchHelper;
use Waca\Pages\PageBan;
use Waca\Pages\PageDomainManagement;
use Waca\Pages\PageEmailManagement;
use Waca\Pages\PageErrorLogViewer;
use Waca\Pages\PageJobQueue;
use Waca\Pages\PageListFlaggedComments;
use Waca\Pages\PageLog;
use Waca\Pages\PageMain;
use Waca\Pages\PageQueueManagement;
use Waca\Pages\PageRequestFormManagement;
use Waca\Pages\PageSearch;
use Waca\Pages\PageSiteNotice;
use Waca\Pages\PageUserManagement;
use Waca\Pages\PageViewRequest;
use Waca\Pages\PageWelcomeTemplateManagement;
use Waca\Pages\Statistics\StatsMain;
use Waca\Pages\Statistics\StatsUsers;
use Waca\PdoDatabase;
use Waca\Security\IDomainAccessManager;
use Waca\Security\ISecurityManager;
use Waca\Security\RoleConfigurationBase;

trait NavigationMenuAccessControl
{
    protected abstract function assign($name, $value);

    protected abstract function getSecurityManager(): ISecurityManager;

    public abstract function getDomainAccessManager(): IDomainAccessManager;

    /**
     * @param $currentUser
     */
    protected function setupNavMenuAccess($currentUser)
    {
        $this->assign('nav__canRequests', $this->getSecurityManager()
                ->allows(PageMain::class, RoleConfigurationBase::MAIN, $currentUser) === ISecurityManager::ALLOWED);

        $this->assign('nav__canLogs', $this->getSecurityManager()
                ->allows(PageLog::class, RoleConfigurationBase::MAIN, $currentUser) === ISecurityManager::ALLOWED);
        $this->assign('nav__canUsers', $this->getSecurityManager()
                ->allows(StatsUsers::class, RoleConfigurationBase::MAIN, $currentUser) === ISecurityManager::ALLOWED);
        $this->assign('nav__canSearch', $this->getSecurityManager()
                ->allows(PageSearch::class, RoleConfigurationBase::MAIN, $currentUser) === ISecurityManager::ALLOWED);
        $this->assign('nav__canStats', $this->getSecurityManager()
                ->allows(StatsMain::class, RoleConfigurationBase::MAIN, $currentUser) === ISecurityManager::ALLOWED);

        $this->assign('nav__canBan', $this->getSecurityManager()
                ->allows(PageBan::class, RoleConfigurationBase::MAIN, $currentUser) === ISecurityManager::ALLOWED);
        $this->assign('nav__canEmailMgmt', $this->getSecurityManager()
                ->allows(PageEmailManagement::class, RoleConfigurationBase::MAIN,
                    $currentUser) === ISecurityManager::ALLOWED);
        $this->assign('nav__canWelcomeMgmt', $this->getSecurityManager()
                ->allows(PageWelcomeTemplateManagement::class, RoleConfigurationBase::MAIN,
                    $currentUser) === ISecurityManager::ALLOWED);
        $this->assign('nav__canSiteNoticeMgmt', $this->getSecurityManager()
                ->allows(PageSiteNotice::class, RoleConfigurationBase::MAIN, $currentUser) === ISecurityManager::ALLOWED);
        $this->assign('nav__canUserMgmt', $this->getSecurityManager()
                ->allows(PageUserManagement::class, RoleConfigurationBase::MAIN,
                    $currentUser) === ISecurityManager::ALLOWED);
        $this->assign('nav__canJobQueue', $this->getSecurityManager()
                ->allows(PageJobQueue::class, RoleConfigurationBase::MAIN,
                    $currentUser) === ISecurityManager::ALLOWED);
        $this->assign('nav__canDomainMgmt', $this->getSecurityManager()
                ->allows(PageDomainManagement::class, RoleConfigurationBase::MAIN,
                    $currentUser) === ISecurityManager::ALLOWED);
        $this->assign('nav__canFlaggedComments', $this->getSecurityManager()
                ->allows(PageListFlaggedComments::class, RoleConfigurationBase::MAIN,
                    $currentUser) === ISecurityManager::ALLOWED);
        $this->assign('nav__canQueueMgmt', $this->getSecurityManager()
                ->allows(PageQueueManagement::class, RoleConfigurationBase::MAIN,
                    $currentUser) === ISecurityManager::ALLOWED);
        $this->assign('nav__canFormMgmt', $this->getSecurityManager()
                ->allows(PageRequestFormManagement::class, RoleConfigurationBase::MAIN,
                    $currentUser) === ISecurityManager::ALLOWED);
        $this->assign('nav__canErrorLog', $this->getSecurityManager()
                ->allows(PageErrorLogViewer::class, RoleConfigurationBase::MAIN, $currentUser) === ISecurityManager::ALLOWED);

        $this->assign('nav__canViewRequest', $this->getSecurityManager()
                ->allows(PageViewRequest::class, RoleConfigurationBase::MAIN, $currentUser) === ISecurityManager::ALLOWED);

        $this->assign('nav__domainList', []);
        if ($this->getDomainAccessManager() !== null) {
            $this->assign('nav__domainList', $this->getDomainAccessManager()->getAllowedDomains($currentUser));
        }
    }

    /**
     * Sets up the badges to draw attention to issues on various admin pages.
     *
     * This function checks to see if a user can access the pages, and if so checks the count of problem areas.
     * If problem areas are found, a number greater than 0 will cause the badge to show up.
     *
     * @param User        $currentUser The current user
     * @param PdoDatabase $database    Database instance
     *
     * @return void
     */
    public function setUpNavBarBadges(User $currentUser, PdoDatabase $database) {
        // Set up some variables.
        // A size of 0 causes nothing to show up on the page (checked on navigation-menu.tpl) so leaving it 0 here is fine.
        $countOfFlagged = 0;
        $countOfJobQueue = 0;

        // Count of flagged comments:
        if($this->barrierTest(RoleConfigurationBase::MAIN, $currentUser, PageListFlaggedComments::class)) {

It seems like barrierTest() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            // We want all flagged comments that haven't been acknowledged if we can visit the page.
            $countOfFlagged = sizeof(Comment::getFlaggedComments($database, 1)); // FIXME: domains
        }

        // Count of failed job queue changes:
        if($this->barrierTest(RoleConfigurationBase::MAIN, $currentUser, PageJobQueue::class)) {
            // We want all failed jobs that haven't been acknowledged if we can visit the page.
            JobQueueSearchHelper::get($database, 1) // FIXME: domains
                ->statusIn([JobQueue::STATUS_FAILED])
                ->notAcknowledged()
                ->getRecordCount($countOfJobQueue);
        }

        // To generate the main badge, add both up.
        // If we add more badges in the future, don't forget to add them here!
        $countOfAll = $countOfFlagged + $countOfJobQueue;

        // Set badge variables
        $this->assign("nav__numFlaggedComments", $countOfFlagged);
        $this->assign("nav__numJobQueueFailed", $countOfJobQueue);
        $this->assign("nav__numAdmin", $countOfAll);
    }
}