Waca\Helpers\IrcNotificationHelper

Complexity

Total Complexity

40

Size/Duplication

Total Lines	497
Duplicated Lines	0 %

Importance

Changes	10
Bugs	0	Features	2

31 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	12	1
A	userApproved()	0	3	1
A	userNew()	0	3	1
B	send()	0	56	6
A	requestDeferred()	0	9	1
A	userPrefChange()	0	3	1
A	welcomeTemplateCreated()	0	3	1
A	requestUnreserved()	0	3	1
A	requestReservationSent()	0	7	1
A	requestDeferredWithMail()	0	11	1
A	welcomeTemplateEdited()	0	3	1
A	requestCloseQueued()	0	5	1
A	unbanned()	0	4	1
A	requestReserveBroken()	0	5	1
A	requestClosed()	0	5	1
A	userRolesEdited()	0	4	1
A	userRenamed()	0	3	1
A	emailEdited()	0	4	1
A	requestReceived()	0	13	1
A	userDeactivated()	0	3	1
A	welcomeTemplateDeleted()	0	3	1
A	emailCreated()	0	4	1
A	siteNoticeEdited()	0	3	1
A	commentEdited()	0	6	1
A	alertFlaggedComments()	0	3	1
A	requestCreationFailed()	0	3	1
A	commentCreated()	0	16	3
A	requestWelcomeFailed()	0	3	1
A	banned()	0	16	3
A	requestReserved()	0	5	1
A	sentMail()	0	4	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 PhpAmqpLib\Connection\AMQPConnectionConfig;
use PhpAmqpLib\Connection\AMQPConnectionFactory;
use PhpAmqpLib\Message\AMQPMessage;
use Waca\DataObjects\Ban;
use Waca\DataObjects\Comment;
use Waca\DataObjects\Domain;
use Waca\DataObjects\EmailTemplate;
use Waca\DataObjects\Request;
use Waca\DataObjects\RequestQueue;
use Waca\DataObjects\User;
use Waca\DataObjects\WelcomeTemplate;
use Waca\ExceptionHandler;
use Waca\IrcColourCode;
use Waca\PdoDatabase;
use Waca\SiteConfiguration;

/**
 * Class IrcNotificationHelper
 * @package Waca\Helpers
 */
class IrcNotificationHelper
{
    /** @var bool $notificationsEnabled */
    private $notificationsEnabled;
    /** @var User $currentUser */
    private $currentUser;
    /** @var string $instanceName */
    private $instanceName;
    /** @var string */
    private $baseUrl;
    /** @var SiteConfiguration */
    private $siteConfiguration;
    /** @var PdoDatabase */
    private $primaryDatabase;

    /**
     * IrcNotificationHelper constructor.
     *
     * @param SiteConfiguration $siteConfiguration
     * @param PdoDatabase       $primaryDatabase
     */
    public function __construct(
        SiteConfiguration $siteConfiguration,
        PdoDatabase $primaryDatabase
    ) {
        $this->siteConfiguration = $siteConfiguration;
        $this->primaryDatabase = $primaryDatabase;

        $this->notificationsEnabled = $siteConfiguration->getIrcNotificationsEnabled();
        $this->instanceName = $siteConfiguration->getIrcNotificationsInstance();
        $this->baseUrl = $siteConfiguration->getBaseUrl();

        $this->currentUser = User::getCurrent($primaryDatabase);
    }

    /**
     * Send a notification
     *
     * This method does some *basic* filtering for IRC safety, and then delivers the message to an AMQP queue manager.
     * It is the responsibility of the queue manager and consumer to handle message delivery to IRC, message routing to
     * the correct channel, and message expiry.
     *
     * It's also arguably the responsibility of the consumer to ensure the message is *safe* for delivery to IRC.
     *
     * As of Feb 2022, the message consumer is stwalkerster's IRC bot Helpmebot.
     *
     * @param string $message The text to send
     */
    protected function send($message)
    {
        $instanceName = $this->instanceName;

        if (!$this->notificationsEnabled) {
            return;
        }

        $blacklist = array("DCC", "CCTP", "PRIVMSG");
        $message = str_replace($blacklist, "(IRC Blacklist)", $message); // Lets stop DCC etc

        $msg = $message;
        if ($instanceName !== null && mb_strlen($instanceName) > 0) {
            $msg = IrcColourCode::RESET . IrcColourCode::BOLD . "[$instanceName]" . IrcColourCode::RESET . ": $message";
        }

        // FIXME: domains!
        /** @var Domain $domain */
        $domain = Domain::getById(1, $this->primaryDatabase);

        try {
            $amqpSiteConfig = $this->siteConfiguration->getAmqpConfiguration();

            $amqpConnectionConfig = new AMQPConnectionConfig();
            $amqpConnectionConfig->setHost($amqpSiteConfig['host']);
            $amqpConnectionConfig->setPort($amqpSiteConfig['port']);
            $amqpConnectionConfig->setUser($amqpSiteConfig['user']);
            $amqpConnectionConfig->setPassword($amqpSiteConfig['password']);
            $amqpConnectionConfig->setVhost($amqpSiteConfig['vhost']);

            if ($amqpSiteConfig['tls']) {
                $amqpConnectionConfig->setIsSecure(true);
                $amqpConnectionConfig->setSslVerify(true);
            }
            else {
                $amqpConnectionConfig->setIsSecure(false);
            }

            $connection = AMQPConnectionFactory::create($amqpConnectionConfig);
            $channel = $connection->channel();

            $msg = new AMQPMessage(substr($msg, 0, 512));
            $msg->set('user_id', $amqpSiteConfig['user']);
            $msg->set('app_id', $this->siteConfiguration->getUserAgent());
            $msg->set('content_type', 'text/plain');
            
            $channel->basic_publish($msg, $amqpSiteConfig['exchange'], $domain->getNotificationTarget());
            $channel->close();
        }
        catch (Exception $ex) {
            // OK, so we failed to send the notification - that db might be down?
            // This is non-critical, so silently fail.
            ExceptionHandler::logExceptionToDisk($ex, $this->siteConfiguration);

            // Disable notifications for remainder of request.
            $this->notificationsEnabled = false;
        }
    }

    #region user management

    /**
     * send a new user notification
     *
     * @param User $user
     */
    public function userNew(User $user)
    {
        $this->send("New user: {$user->getUsername()}");
    }

    /**
     * send an approved notification
     *
     * @param User $user
     */
    public function userApproved(User $user)
    {
        $this->send("{$user->getUsername()} approved by " . $this->currentUser->getUsername());
    }

    /**
     * send a deactivated notification
     *
     * @param User   $user
     * @param string $reason The reason the user has been deactivated
     */
    public function userDeactivated(User $user, $reason)
    {
        $this->send("{$user->getUsername()} deactivated by " . $this->currentUser->getUsername() . " ($reason)");
    }

    /**
     * Send a preference change notification
     *
     * @param User $user
     */
    public function userPrefChange(User $user)
    {
        $this->send("{$user->getUsername()}'s preferences were changed by " . $this->currentUser->getUsername());
    }

    /**
     * Send a user renamed notification
     *
     * @param User   $user
     * @param string $old
     */
    public function userRenamed(User $user, $old)
    {
        $this->send($this->currentUser->getUsername() . " renamed $old to {$user->getUsername()}");
    }

    /**
     * @param User   $user
     * @param string $reason
     */
    public function userRolesEdited(User $user, $reason)
    {
        $currentUser = $this->currentUser->getUsername();
        $this->send("Active roles for {$user->getUsername()} changed by " . $currentUser . " ($reason)");
    }

    #endregion

    #region Site Notice

    /**
     * Summary of siteNoticeEdited
     */
    public function siteNoticeEdited()
    {
        $this->send("Site notice edited by " . $this->currentUser->getUsername());
    }
    #endregion

    #region Welcome Templates
    /**
     * Summary of welcomeTemplateCreated
     *
     * @param WelcomeTemplate $template
     */
    public function welcomeTemplateCreated(WelcomeTemplate $template)
    {
        $this->send("Welcome template {$template->getId()} created by " . $this->currentUser->getUsername());
    }

    /**
     * Summary of welcomeTemplateDeleted
     *
     * @param int $templateid
     */
    public function welcomeTemplateDeleted($templateid)
    {
        $this->send("Welcome template {$templateid} deleted by " . $this->currentUser->getUsername());
    }

    /**
     * Summary of welcomeTemplateEdited
     *
     * @param WelcomeTemplate $template
     */
    public function welcomeTemplateEdited(WelcomeTemplate $template)
    {
        $this->send("Welcome template {$template->getId()} edited by " . $this->currentUser->getUsername());
    }

    #endregion

    #region bans
    /**
     * Summary of banned
     *
     * @param Ban $ban
     */
    public function banned(Ban $ban)
    {
        if ($ban->getDuration() === null) {
            $duration = "indefinitely";
        }
        else {
            $duration = "until " . date("F j, Y, g:i a", $ban->getDuration());
        }

        $username = $this->currentUser->getUsername();

        if ($ban->getVisibility() == 'user') {
            $this->send("Ban {$ban->getId()} set by {$username} for '{$ban->getReason()}' {$duration}");
        }
        else {
            $this->send("Ban {$ban->getId()} set by {$username} {$duration}");
        }
    }

    /**
     * Summary of unbanned
     *
     * @param Ban    $ban
     * @param string $unbanReason
     */
    public function unbanned(Ban $ban, $unbanReason)
    {
        $this->send("Ban {$ban->getId()} unbanned by " . $this->currentUser
                ->getUsername() . " (" . $unbanReason . ")");
    }

    #endregion

    #region request management

    /**
     * Summary of requestReceived
     *
     * @param Request $request
     */
    public function requestReceived(Request $request)
    {
        $this->send(
            IrcColourCode::DARK_GREY . "[["
            . IrcColourCode::DARK_GREEN . "acc:"
            . IrcColourCode::ORANGE . $request->getId()
            . IrcColourCode::DARK_GREY . "]]"
            . IrcColourCode::RED . " N "
            . IrcColourCode::DARK_BLUE . $this->baseUrl . "/internal.php/viewRequest?id={$request->getId()} "
            . IrcColourCode::DARK_RED . "* "
            . IrcColourCode::DARK_GREEN . $request->getName()
            . IrcColourCode::DARK_RED . " * "
            . IrcColourCode::RESET
        );
    }

    /**
     * Summary of requestDeferred
     *
     * @param Request $request
     */
    public function requestDeferred(Request $request)
    {
        /** @var RequestQueue $queue */
        $queue = RequestQueue::getById($request->getQueue(), $request->getDatabase());

        $deferTo = $queue->getDisplayName();
        $username = $this->currentUser->getUsername();

        $this->send("Request {$request->getId()} ({$request->getName()}) deferred to {$deferTo} by {$username}");
    }

    /**
     *
     * Summary of requestDeferredWithMail
     *
     * @param Request $request
     */
    public function requestDeferredWithMail(Request $request)
    {
        /** @var RequestQueue $queue */
        $queue = RequestQueue::getById($request->getQueue(), $request->getDatabase());

        $deferTo = $queue->getDisplayName();
        $username = $this->currentUser->getUsername();
        $id = $request->getId();
        $name = $request->getName();

        $this->send("Request {$id} ({$name}) deferred to {$deferTo} with an email by {$username}");
    }

    /**
     * Summary of requestClosed
     *
     * @param Request $request
     * @param string  $closetype
     */
    public function requestClosed(Request $request, $closetype)
    {
        $username = $this->currentUser->getUsername();

        $this->send("Request {$request->getId()} ({$request->getName()}) closed ($closetype) by {$username}");
    }

    /**
     * Summary of requestClosed
     *
     * @param Request $request
     * @param string  $closetype
     */
    public function requestCloseQueued(Request $request, $closetype)
    {
        $username = $this->currentUser->getUsername();

        $this->send("Request {$request->getId()} ({$request->getName()}) queued for creation ($closetype) by {$username}");
    }

    /**
     * Summary of requestClosed
     *
     * @param Request $request
     * @param User    $triggerUser
     */
    public function requestCreationFailed(Request $request, User $triggerUser)
    {
        $this->send("Request {$request->getId()} ({$request->getName()}) failed auto-creation for {$triggerUser->getUsername()}, and was sent to the hospital queue.");
    }

    /**
     * @param Request $request
     * @param User    $triggerUser
     */
    public function requestWelcomeFailed(Request $request, User $triggerUser)
    {
        $this->send("Request {$request->getId()} ({$request->getName()}) failed welcome for {$triggerUser->getUsername()}.");
    }

    /**
     * Summary of sentMail
     *
     * @param Request $request
     */
    public function sentMail(Request $request)
    {
        $this->send($this->currentUser->getUsername()
            . " sent an email related to Request {$request->getId()} ({$request->getName()})");
    }

    #endregion

    #region reservations

    /**
     * Summary of requestReserved
     *
     * @param Request $request
     */
    public function requestReserved(Request $request)
    {
        $username = $this->currentUser->getUsername();

        $this->send("Request {$request->getId()} ({$request->getName()}) reserved by {$username}");
    }

    /**
     * Summary of requestReserveBroken
     *
     * @param Request $request
     */
    public function requestReserveBroken(Request $request)
    {
        $username = $this->currentUser->getUsername();

        $this->send("Reservation on request {$request->getId()} ({$request->getName()}) broken by {$username}");
    }

    /**
     * Summary of requestUnreserved
     *
     * @param Request $request
     */
    public function requestUnreserved(Request $request)
    {
        $this->send("Request {$request->getId()} ({$request->getName()}) is no longer being handled.");
    }

    /**
     * Summary of requestReservationSent
     *
     * @param Request $request
     * @param User    $target
     */
    public function requestReservationSent(Request $request, User $target)
    {
        $username = $this->currentUser->getUsername();

        $this->send(
            "Reservation of request {$request->getId()} ({$request->getName()}) sent to {$target->getUsername()} by "
            . $username);
    }

    #endregion

    #region comments

    /**
     * Summary of commentCreated
     *
     * @param Comment $comment
     * @param Request $request
     */
    public function commentCreated(Comment $comment, Request $request)
    {
        $username = $this->currentUser->getUsername();
        switch ($comment->getVisibility()) {
            case 'admin':
                $visibility = " with visibility 'admin'";
                break;
            case 'checkuser':
                $visibility = " with visibility 'checkuser'";
                break;
            default:
                $visibility = "";
                break;
        }

        $this->send("{$username} posted a comment on request {$request->getId()} ({$request->getName()}){$visibility}");
    }

    /**
     * Summary of commentEdited
     *
     * @param Comment $comment
     * @param Request $request
     */
    public function commentEdited(Comment $comment, Request $request)
    {
        $username = $this->currentUser->getUsername();

        $this->send(<<<TAG
Comment {$comment->getId()} on request {$request->getId()} ({$request->getName()}) edited by {$username}
TAG
        );
    }

    public function alertFlaggedComments(int $count)
    {
        $this->send("There are ${count} flagged comments on closed requests currently awaiting redaction.");
    }

    #endregion

    #region email management (close reasons)

    /**
     * Summary of emailCreated
     *
     * @param EmailTemplate $template
     */
    public function emailCreated(EmailTemplate $template)
    {
        $username = $this->currentUser->getUsername();
        $this->send("Email {$template->getId()} ({$template->getName()}) created by " . $username);
    }

    /**
     * Summary of emailEdited
     *
     * @param EmailTemplate $template
     */
    public function emailEdited(EmailTemplate $template)
    {
        $username = $this->currentUser->getUsername();
        $this->send("Email {$template->getId()} ({$template->getName()}) edited by " . $username);
    }
    #endregion
}