Waca\Helpers\Logger

Complexity

Total Complexity

47

Size/Duplication

Total Lines	423
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

43 Methods

Rating	Name	Duplication	Size	Complexity
A	newUser()	0	3	1
A	backgroundJobComplete()	0	3	1
A	userRolesEdited()	0	15	1
A	deferRequest()	0	3	1
A	unflaggedComment()	0	3	1
A	welcomeTemplateEdited()	0	3	1
A	requestQueueEdited()	0	3	1
A	requestFormEdited()	0	3	1
A	userGlobalRolesEdited()	0	14	1
A	createLogEntry()	0	33	5
A	domainCreated()	0	3	1
A	requestQueueCreated()	0	3	1
A	emailConfirmed()	0	3	1
A	welcomeTemplateDeleted()	0	3	1
A	backgroundJobAcknowledged()	0	3	1
A	enqueuedJobQueue()	0	3	1
A	siteNoticeEdited()	0	3	1
A	sentMail()	0	3	1
A	userPreferencesChange()	0	3	1
A	banned()	0	3	1
A	domainEdited()	0	3	1
A	approvedUser()	0	3	1
A	renamedUser()	0	3	1
A	editedEmail()	0	3	1
A	manuallyConfirmRequest()	0	3	1
A	editComment()	0	4	1
A	unreserve()	0	3	1
A	reserve()	0	3	1
A	unbanned()	0	3	1
A	sendReservation()	0	4	1
A	breakReserve()	0	3	1
A	backgroundJobIssue()	0	4	1
A	backgroundJobCancelled()	0	3	1
A	banReplaced()	0	3	1
A	requestFormCreated()	0	3	1
A	hospitalised()	0	3	1
A	createEmail()	0	3	1
A	welcomeTemplateCreated()	0	3	1
A	flaggedComment()	0	3	1
A	closeRequest()	0	3	1
A	backgroundJobRequeued()	0	3	1
A	deactivatedUser()	0	3	1
A	requestedReactivation()	0	3	1

<?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\Helpers;

use Exception;
use Waca\DataObject;
use Waca\DataObjects\Ban;
use Waca\DataObjects\Comment;
use Waca\DataObjects\Domain;
use Waca\DataObjects\EmailTemplate;
use Waca\DataObjects\JobQueue;
use Waca\DataObjects\Log;
use Waca\DataObjects\Request;
use Waca\DataObjects\RequestForm;
use Waca\DataObjects\RequestQueue;
use Waca\DataObjects\SiteNotice;
use Waca\DataObjects\User;
use Waca\DataObjects\WelcomeTemplate;
use Waca\PdoDatabase;

/**
 * Helper class for creating log entries
 *
 * Logger description.
 *
 * @version 1.0
 * @author  stwalkerster
 */
class Logger
{
    /**
     * @param PdoDatabase $database
     * @param Request     $object
     */
    public static function emailConfirmed(PdoDatabase $database, Request $object)
    {
        self::createLogEntry($database, $object, "Email Confirmed", null, User::getCommunity());
    }

    /**
     * @param PdoDatabase $database
     * @param DataObject  $object
     * @param string      $logAction
     * @param null|string $comment
     * @param User|null   $user
     * @param int|null    $domain
     *
     * @throws Exception
     */
    private static function createLogEntry(
        PdoDatabase $database,
        DataObject $object,
        $logAction,
        $comment = null,
        $user = null,
        ?int $domain = null
    ) {
        if ($user == null) {
            $user = User::getCurrent($database);
        }

        $objectType = get_class($object);
        if (strpos($objectType, 'Waca\\DataObjects\\') !== false) {
            $objectType = str_replace('Waca\\DataObjects\\', '', $objectType);
        }

        $log = new Log();

        if ($domain !== null) {
            $log->setDomain($domain);
        }
        elseif (method_exists($object, 'getDomain')) {
            $log->setDomain($object->getDomain());
        }

        $log->setDatabase($database);
        $log->setAction($logAction);
        $log->setObjectId($object->getId());
        $log->setObjectType($objectType);
        $log->setUser($user);
        $log->setComment($comment);
        $log->save();
    }

    #region Users

    /**
     * @throws Exception
     */
    public static function newUser(PdoDatabase $database, User $user)
    {
        self::createLogEntry($database, $user, 'Registered', null, User::getCommunity());
    }

    /**
     * @throws Exception
     */
    public static function approvedUser(PdoDatabase $database, User $object)
    {
        self::createLogEntry($database, $object, "Approved");
    }

    /**
     * @throws Exception
     */
    public static function deactivatedUser(PdoDatabase $database, User $object, string $comment)
    {
        self::createLogEntry($database, $object, 'DeactivatedUser', $comment);
    }

    /**
     * @throws Exception
     */
    public static function requestedReactivation(PdoDatabase $database, User $object, string $comment)
    {
        self::createLogEntry($database, $object, 'RequestedReactivation', $comment);
    }

    /**
     * @throws Exception
     */
    public static function renamedUser(PdoDatabase $database, User $object, string $comment)
    {
        self::createLogEntry($database, $object, "Renamed", $comment);
    }

    /**
     * @throws Exception
     */
    public static function userPreferencesChange(PdoDatabase $database, User $object)
    {
        self::createLogEntry($database, $object, "Prefchange");
    }

    /**
     * @throws Exception
     */
    public static function userRolesEdited(
        PdoDatabase $database,
        User $object,
        string $reason,
        array $added,
        array $removed,
        int $domain
    ) {
        $logData = serialize(array(
            'added'   => $added,
            'removed' => $removed,
            'reason'  => $reason,
        ));

        self::createLogEntry($database, $object, "RoleChange", $logData, null, $domain);
    }

    /**
     * @throws Exception
     */
    public static function userGlobalRolesEdited(
        PdoDatabase $database,
        User $object,
        string $reason,
        array $added,
        array $removed
    ): void {
        $logData = serialize(array(
            'added' => $added,
            'removed' => $removed,
            'reason' => $reason,
        ));

        self::createLogEntry($database, $object, "GlobalRoleChange", $logData);
    }

    #endregion

    /**
     * @param PdoDatabase $database
     * @param SiteNotice  $object
     */
    public static function siteNoticeEdited(PdoDatabase $database, SiteNotice $object)
    {
        self::createLogEntry($database, $object, "Edited");
    }

    #region Welcome Templates

    /**
     * @param PdoDatabase     $database
     * @param WelcomeTemplate $object
     */
    public static function welcomeTemplateCreated(PdoDatabase $database, WelcomeTemplate $object)
    {
        self::createLogEntry($database, $object, "CreatedTemplate");
    }

    /**
     * @param PdoDatabase     $database
     * @param WelcomeTemplate $object
     */
    public static function welcomeTemplateEdited(PdoDatabase $database, WelcomeTemplate $object)
    {
        self::createLogEntry($database, $object, "EditedTemplate");
    }

    /**
     * @param PdoDatabase     $database
     * @param WelcomeTemplate $object
     */
    public static function welcomeTemplateDeleted(PdoDatabase $database, WelcomeTemplate $object)
    {
        self::createLogEntry($database, $object, "DeletedTemplate");
    }

    #endregion

    #region Bans

    /**
     * @param PdoDatabase $database
     * @param Ban         $object
     * @param string      $reason
     */
    public static function banned(PdoDatabase $database, Ban $object, $reason)
    {
        self::createLogEntry($database, $object, "Banned", $reason);
    }

    /**
     * @param PdoDatabase $database
     * @param Ban         $object
     * @param string      $reason
     */
    public static function unbanned(PdoDatabase $database, Ban $object, $reason)
    {
        self::createLogEntry($database, $object, "Unbanned", $reason);
    }

    public static function banReplaced(PdoDatabase $database, Ban $object)
    {
        self::createLogEntry($database, $object, "BanReplaced");
    }

    #endregion

    #region Requests

    /**
     * @param PdoDatabase $database
     * @param Request     $object
     * @param string      $target
     */
    public static function deferRequest(PdoDatabase $database, Request $object, $target)
    {
        self::createLogEntry($database, $object, "Deferred to $target");
    }

    /**
     * @param PdoDatabase $database
     * @param Request     $object
     * @param integer     $target
     * @param string      $comment
     * @param User|null   $logUser
     */
    public static function closeRequest(PdoDatabase $database, Request $object, $target, $comment, User $logUser = null)
    {
        self::createLogEntry($database, $object, "Closed $target", $comment, $logUser);
    }

    public static function manuallyConfirmRequest(PdoDatabase $database, Request $object)
    {
        self::createLogEntry($database, $object, "Manually Confirmed");
    }

    /**
     * @param PdoDatabase $database
     * @param Request     $object
     */
    public static function reserve(PdoDatabase $database, Request $object)
    {
        self::createLogEntry($database, $object, "Reserved");
    }

    /**
     * @param PdoDatabase $database
     * @param Request     $object
     */
    public static function breakReserve(PdoDatabase $database, Request $object)
    {
        self::createLogEntry($database, $object, "BreakReserve");
    }

    /**
     * @param PdoDatabase $database
     * @param Request     $object
     */
    public static function unreserve(PdoDatabase $database, Request $object)
    {
        self::createLogEntry($database, $object, "Unreserved");
    }

    /**
     * @param PdoDatabase $database
     * @param Comment     $object
     * @param Request     $request
     */
    public static function editComment(PdoDatabase $database, Comment $object, Request $request)
    {
        self::createLogEntry($database, $request, "EditComment-r");
        self::createLogEntry($database, $object, "EditComment-c", null, null, $request->getDomain());
    }

    /**
     * @param PdoDatabase $database
     * @param Comment     $object
     */
    public static function flaggedComment(PdoDatabase $database, Comment $object, int $domain)
    {
        self::createLogEntry($database, $object, "FlaggedComment", null, null, $domain);
    }

    /**
     * @param PdoDatabase $database
     * @param Comment     $object
     */
    public static function unflaggedComment(PdoDatabase $database, Comment $object, int $domain)
    {
        self::createLogEntry($database, $object, "UnflaggedComment", null, null, $domain);
    }

    /**
     * @param PdoDatabase $database
     * @param Request     $object
     * @param User        $target
     */
    public static function sendReservation(PdoDatabase $database, Request $object, User $target)
    {
        self::createLogEntry($database, $object, "SendReserved");
        self::createLogEntry($database, $object, "ReceiveReserved", null, $target);
    }

    /**
     * @param PdoDatabase $database
     * @param Request     $object
     * @param string      $comment
     */
    public static function sentMail(PdoDatabase $database, Request $object, $comment)
    {
        self::createLogEntry($database, $object, "SentMail", $comment);
    }

    /**
     * @param PdoDatabase $database
     * @param Request     $object
     */
    public static function enqueuedJobQueue(PdoDatabase $database, Request $object)
    {
        self::createLogEntry($database, $object, 'EnqueuedJobQueue');
    }

    public static function hospitalised(PdoDatabase $database, Request $object)
    {
        self::createLogEntry($database, $object, 'Hospitalised');
    }
    #endregion

    #region Email templates

    /**
     * @param PdoDatabase   $database
     * @param EmailTemplate $object
     */
    public static function createEmail(PdoDatabase $database, EmailTemplate $object)
    {
        self::createLogEntry($database, $object, "CreatedEmail");
    }

    /**
     * @param PdoDatabase   $database
     * @param EmailTemplate $object
     */
    public static function editedEmail(PdoDatabase $database, EmailTemplate $object)
    {
        self::createLogEntry($database, $object, "EditedEmail");
    }

    #endregion

    #region Display

    #endregion

    #region Automation

    public static function backgroundJobComplete(PdoDatabase $database, JobQueue $job)
    {
        self::createLogEntry($database, $job, 'JobCompleted', null, User::getCommunity());
    }

    public static function backgroundJobIssue(PdoDatabase $database, JobQueue $job)
    {
        $data = array('status' => $job->getStatus(), 'error' => $job->getError());
        self::createLogEntry($database, $job, 'JobIssue', serialize($data), User::getCommunity());
    }

    public static function backgroundJobCancelled(PdoDatabase $database, JobQueue $job)
    {
        self::createLogEntry($database, $job, 'JobCancelled', $job->getError());
    }

    public static function backgroundJobRequeued(PdoDatabase $database, JobQueue $job)
    {
        self::createLogEntry($database, $job, 'JobRequeued');
    }

    public static function backgroundJobAcknowledged(PdoDatabase $database, JobQueue $job, $comment = null)
    {
        self::createLogEntry($database, $job, 'JobAcknowledged', $comment);
    }
    #endregion

    #region Request Queues
    public static function requestQueueCreated(PdoDatabase $database, RequestQueue $queue)
    {
        self::createLogEntry($database, $queue, 'QueueCreated');
    }

    public static function requestQueueEdited(PdoDatabase $database, RequestQueue $queue)
    {
        self::createLogEntry($database, $queue, 'QueueEdited');
    }
    #endregion
    #region Domains
    public static function domainCreated(PdoDatabase $database, Domain $domain)
    {
        self::createLogEntry($database, $domain, 'DomainCreated');
    }

    public static function domainEdited(PdoDatabase $database, Domain $domain)
    {
        self::createLogEntry($database, $domain, 'DomainEdited');
    }
    #endregion
    #region Request Forms
    public static function requestFormCreated(PdoDatabase $database, RequestForm $requestForm)
    {
        self::createLogEntry($database, $requestForm, 'RequestFormCreated');
    }

    public static function requestFormEdited(PdoDatabase $database, RequestForm $requestForm)
    {
        self::createLogEntry($database, $requestForm, 'RequestFormEdited');
    }
    #endregion
}