Issues in LogService.php (master) - Issues in master - XoopsModules25x/xhelp - Measure and Improve Code Quality continuously with Scrutinizer

Issues (1844)

Security Analysis not enabled

File Inclusion

File Inclusion enables an attacker to inject custom files into PHP's file loading mechanism, either explicitly passed to include, or for example via PHP's auto-loading mechanism.

Regex Injection

Regex Injection enables an attacker to execute arbitrary code in your PHP process.

SQL Injection

SQL Injection enables an attacker to execute arbitrary SQL code on your database server gaining access to user data, or manipulating user data.

Response Splitting

Response Splitting can be used to send arbitrary responses.

File Manipulation

File Manipulation enables an attacker to write custom data to files. This potentially leads to injection of arbitrary code on the server.

Object Injection

Object Injection enables an attacker to inject an object into PHP code, and can lead to arbitrary code execution, file exposure, or file manipulation attacks.

File Exposure

File Exposure allows an attacker to gain access to local files that he should not be able to access. These files can for example include database credentials, or other configuration files.

XML Injection

XML Injection enables an attacker to read files on your local filesystem including configuration files, or can be abused to freeze your web-server process.

Code Injection

Code Injection enables an attacker to execute arbitrary code on the server.

Variable Injection

Variable Injection enables an attacker to overwrite program variables with custom data, and can lead to further vulnerabilities.

XPath Injection

XPath Injection enables an attacker to modify the parts of XML document that are read. If that XML document is for example used for authentication, this can lead to further vulnerabilities similar to SQL Injection.

Other Vulnerability

This category comprises other attack vectors such as manipulating the PHP runtime, loading custom extensions, freezing the runtime, or similar.

Command Injection

Command Injection enables an attacker to inject a shell command that is execute with the privileges of the web-server. This can be used to expose sensitive data, or gain access of your server.

LDAP Injection

LDAP Injection enables an attacker to inject LDAP statements potentially granting permission to run unauthorized queries, or modify content inside the LDAP tree.

Cross-Site Scripting

Cross-Site Scripting enables an attacker to inject code into the response of a web-request that is viewed by other users. It can for example be used to bypass access controls, or even to take over other users' accounts.

Header Injection

Unfortunately, the security analysis is currently not available for your project. If you are a non-commercial open-source project, please contact support to gain access.

class/LogService.php (18 issues)

Labels

Severity

<?php declare(strict_types=1);

namespace XoopsModules\Xhelp;

/*
 * You may not change or alter any portion of this comment or credits
 * of supporting developers from this source code or any supporting source code
 * which is considered copyrighted (c) material of the original comment or credit authors.
 *
 * 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.
 */

/**
 * @copyright    {@link https://xoops.org/ XOOPS Project}
 * @license      {@link https://www.gnu.org/licenses/gpl-2.0.html GNU GPL 2 or later}
 * @author       Brian Wahoff <[email protected]>
 * @author       XOOPS Development Team
 */

// require_once XHELP_CLASS_PATH . '/Service.php';

/**
 * xhelp_logService class
 *
 * Part of the Messaging Subsystem.  Uses the LogMessageHandler class for logging
 *
 * @author  Brian Wahoff <[email protected]>
 */
class LogService extends Service
{
    /**
     * Instance of the LogMessageHandler
     *
     * @var LogMessageHandler
     */
    public $logMessageHandler;

    /**
     * Class Constructor
     */
    public function __construct()
    {
        /** @var \XoopsModules\Xhelp\LogMessageHandler $this- >logMessageHandler */
        $this->logMessageHandler = Helper::getInstance()
            ->getHandler('LogMessage');
        $this->init();
    }

    public function attachEvents(): void
    {
        $this->attachEvent('batch_dept', $this);
        $this->attachEvent('batch_owner', $this);
        $this->attachEvent('batch_priority', $this);
        $this->attachEvent('batch_response', $this);
        $this->attachEvent('batch_status', $this);
        $this->attachEvent('close_ticket', $this);
        $this->attachEvent('delete_file', $this);
        $this->attachEvent('edit_response', $this);
        $this->attachEvent('edit_ticket', $this);
        $this->attachEvent('merge_tickets', $this);
        $this->attachEvent('new_response', $this);
        $this->attachEvent('new_response_rating', $this);
        $this->attachEvent('new_ticket', $this);
        $this->attachEvent('reopen_ticket', $this);
        $this->attachEvent('update_owner', $this);
        $this->attachEvent('update_priority', $this);
        $this->attachEvent('update_status', $this);
        $this->attachEvent('new_faq', $this);
    }

    /**
     * Callback function for the 'new_ticket' event
     * @param Ticket $ticket Ticket that was added
     * @return bool        True on success, false on error
     */
    public function new_ticket(Ticket $ticket): bool
    {
        global $xoopsUser;

        $logMessage = $this->logMessageHandler->create();
        $logMessage->setVar('uid', $ticket->getVar('uid'));
        $logMessage->setVar('ticketid', $ticket->getVar('id'));
        $logMessage->setVar('lastUpdated', $ticket->getVar('posted'));
        $logMessage->setVar('posted', $ticket->getVar('posted'));

        if ($xoopsUser->getVar('uid') == $ticket->getVar('uid')) {
            $logMessage->setVar('action', \_XHELP_LOG_ADDTICKET);
        } else {
            // Will display who logged the ticket for the user
            $logMessage->setVar('action', \sprintf(\_XHELP_LOG_ADDTICKET_FORUSER, $xoopsUser::getUnameFromId($ticket->getVar('uid')), $xoopsUser->getVar('uname')));
        }

        return $this->logMessageHandler->insert($logMessage);
    }

    /**
     * Callback function for the 'update_priority' event
     * @param Ticket $ticket      Ticket that was modified
     * @param int    $oldpriority Original ticket priority
     * @return bool        True on success, false on error
     */
    public function update_priority(Ticket $ticket, int $oldpriority): bool
    {
        global $xoopsUser;

        $logMessage = $this->logMessageHandler->create();
        $logMessage->setVar('uid', $xoopsUser->getVar('uid'));
        $logMessage->setVar('ticketid', $ticket->getVar('id'));
        $logMessage->setVar('lastUpdated', $ticket->getVar('lastUpdated'));
        $logMessage->setVar('posted', $ticket->getVar('posted'));
        $logMessage->setVar('action', \sprintf(\_XHELP_LOG_UPDATE_PRIORITY, $oldpriority, $ticket->getVar('priority')));
        $logMessage->setVar('action', \sprintf(\_XHELP_LOG_UPDATE_PRIORITY, $oldpriority, /** @scrutinizer ignore-type */ $ticket->getVar('priority')));

        return $this->logMessageHandler->insert($logMessage);
    }

    /**
     * Callback function for the 'update_status' event
     * @param Ticket                          $ticket    Ticket that was modified
     * @param \XoopsModules\Xhelp\Status|null $oldstatus Original ticket status
     * @param Status                          $newstatus New ticket status
     * @return bool        True on success, false on error
     */
    public function update_status(Ticket $ticket, ?Status $oldstatus, Status $newstatus): bool
    {
        global $xoopsUser;

        $logMessage = $this->logMessageHandler->create();
        $logMessage->setVar('uid', $xoopsUser->getVar('uid'));
        $logMessage->setVar('ticketid', $ticket->getVar('id'));
        $logMessage->setVar('lastUpdated', $ticket->getVar('lastUpdated'));
        $logMessage->setVar('posted', $ticket->getVar('posted'));
        $logMessage->setVar('action', \sprintf(\_XHELP_LOG_UPDATE_STATUS, $oldstatus->getVar('description'), $newstatus->getVar('description')));
        $logMessage->setVar('action', \sprintf(\_XHELP_LOG_UPDATE_STATUS, /** @scrutinizer ignore-type */ $oldstatus->getVar('description'), $newstatus->getVar('description')));

        return $this->logMessageHandler->insert($logMessage, true);
    }

    /**
     * Event: update_owner
     * Triggered after ticket ownership change (Individual)
     * Also See: batch_owner
     * @param Ticket $ticket   Ticket that was changed
     * @param int    $oldowner UID of previous owner
     * @param int    $newowner UID of new owner
     * @return bool        True on success, false on error
     */
    public function update_owner(Ticket $ticket, int $oldowner, int $newowner): bool
    public function update_owner(Ticket $ticket, int $oldowner, /** @scrutinizer ignore-unused */ int $newowner): bool
    {
        global $xoopsUser;

        $logMessage = $this->logMessageHandler->create();
        $logMessage->setVar('uid', $xoopsUser->getVar('uid'));
        $logMessage->setVar('ticketid', $ticket->getVar('id'));
        $logMessage->setVar('lastUpdated', $ticket->getVar('lastUpdated'));
        if ($xoopsUser->getVar('uid') == $ticket->getVar('ownership')) {
            //User claimed ownership
            $logMessage->setVar('action', \_XHELP_LOG_CLAIM_OWNERSHIP);
        } else {
            //Ownership was assigned
            $logMessage->setVar('action', \sprintf(\_XHELP_LOG_ASSIGN_OWNERSHIP, $xoopsUser::getUnameFromId($ticket->getVar('ownership'))));
        }

        return $this->logMessageHandler->insert($logMessage);
    }

    /**
     * Callback function for the reopen_ticket event
     * @param Ticket $ticket Ticket that was re-opened
     * @return bool        True on success, false on error
     */
    public function reopen_ticket(Ticket $ticket): bool
    {
        global $xoopsUser;

        $logMessage = $this->logMessageHandler->create();
        $logMessage->setVar('uid', $xoopsUser->getVar('uid'));
        $logMessage->setVar('ticketid', $ticket->getVar('id'));
        $logMessage->setVar('lastUpdated', $ticket->getVar('lastUpdated'));
        $logMessage->setVar('action', \_XHELP_LOG_REOPEN_TICKET);

        return $this->logMessageHandler->insert($logMessage);
    }

    /**
     * Callback function for the close_ticket event
     * @param Ticket $ticket Ticket that was closed
     * @return bool        True on success, false on error
     */
    public function close_ticket(Ticket $ticket): bool
    {
        global $xoopsUser;

        $logMessage = $this->logMessageHandler->create();
        $logMessage->setVar('uid', $xoopsUser->getVar('uid'));
        $logMessage->setVar('ticketid', $ticket->getVar('id'));
        $logMessage->setVar('lastUpdated', $ticket->getVar('lastUpdated'));
        $logMessage->setVar('action', \_XHELP_LOG_CLOSE_TICKET);

        return $this->logMessageHandler->insert($logMessage);
    }

    /**
     * Add Log information for 'new_response' event
     * @param Ticket   $ticket      Ticket for Response
     * @param Response $newResponse Response that was added
     * @return bool           True on success, false on error
     */
    public function new_response(Ticket $ticket, Response $newResponse): bool
    {
        global $xoopsUser;

        $logMessage = $this->logMessageHandler->create();
        $logMessage->setVar('uid', $xoopsUser->getVar('uid'));
        $logMessage->setVar('ticketid', $ticket->getVar('id'));
        $logMessage->setVar('action', \_XHELP_LOG_ADDRESPONSE);
        $logMessage->setVar('lastUpdated', $newResponse->getVar('updateTime'));

        return $this->logMessageHandler->insert($logMessage);
    }

    /**
     * Callback function for the 'new_response_rating' event
     * @param \XoopsModules\Xhelp\StaffReview $rating   Rating Information
     * @param Ticket                          $ticket   Ticket for Rating
     * @param Response                        $response Response that was rated
     * @return bool           True on success, false on error
     */
    public function new_response_rating(StaffReview $rating, Ticket $ticket, Response $response): bool
    public function new_response_rating(StaffReview $rating, /** @scrutinizer ignore-unused */ Ticket $ticket, Response $response): bool
    {
        global $xoopsUser;

        $logMessage = $this->logMessageHandler->create();
        $logMessage->setVar('uid', $xoopsUser->getVar('uid'));
        $logMessage->setVar('ticketid', $rating->getVar('ticketid'));
        $logMessage->setVar('action', \sprintf(\_XHELP_LOG_ADDRATING, $rating->getVar('responseid')));
        $logMessage->setVar('action', \sprintf(\_XHELP_LOG_ADDRATING, /** @scrutinizer ignore-type */ $rating->getVar('responseid')));
        $logMessage->setVar('lastUpdated', \time());

        return $this->logMessageHandler->insert($logMessage);
    }

    /**
     * Callback function for the 'edit_ticket' event
     * @param array|Ticket $oldTicket  Original Ticket Information
     * @param Ticket       $ticketInfo New Ticket Information
     * @return bool        True on success, false on error
     */
    public function edit_ticket($oldTicket, Ticket $ticketInfo): bool
    public function edit_ticket(/** @scrutinizer ignore-unused */ $oldTicket, Ticket $ticketInfo): bool
    {
        global $xoopsUser;

        $logMessage = $this->logMessageHandler->create();
        $logMessage->setVar('uid', $xoopsUser->getVar('uid'));
        $logMessage->setVar('ticketid', $ticketInfo->getVar('id'));
        $logMessage->setVar('lastUpdated', $ticketInfo->getVar('posted'));
        $logMessage->setVar('posted', $ticketInfo->getVar('posted'));
        $logMessage->setVar('action', \_XHELP_LOG_EDITTICKET);

        return $this->logMessageHandler->insert($logMessage);
    }

    /**
     * Callback function for the 'edit_response' event
     * @param Ticket   $ticket
     * @param Response $response
     * @param Ticket   $oldticket
     * @param Response $oldresponse
     * @return bool True on success, false on error
     * @internal param array $args Array of arguments passed to EventService
     */
    public function edit_response(Ticket $ticket, Response $response, Ticket $oldticket, Response $oldresponse): bool
    public function edit_response(Ticket $ticket, Response $response, Ticket $oldticket, /** @scrutinizer ignore-unused */ Response $oldresponse): bool
    {
        global $xoopsUser;

        $logMessage = $this->logMessageHandler->create();
        $logMessage->setVar('uid', $xoopsUser->getVar('uid'));
        $logMessage->setVar('ticketid', $response->getVar('ticketid'));
        $logMessage->setVar('lastUpdated', $response->getVar('updateTime'));
        $logMessage->setVar('action', \sprintf(\_XHELP_LOG_EDIT_RESPONSE, $response->getVar('id')));
        $logMessage->setVar('action', \sprintf(\_XHELP_LOG_EDIT_RESPONSE, /** @scrutinizer ignore-type */ $response->getVar('id')));

        return $this->logMessageHandler->insert($logMessage);
    }

    /**
     * Add Log Events for 'batch_dept' event
     * @param array          $tickets Array of Ticket objects
     * @param Department|int $dept    New department for tickets
     * @return bool            True on success, false on error
     */
    public function batch_dept(array $tickets, $dept): bool
    {
        global $xoopsUser;
        $helper = Helper::getInstance();

        /** @var \XoopsModules\Xhelp\DepartmentHandler $departmentHandler */
        $departmentHandler = $helper->getHandler('Department');
        $deptObj           = $departmentHandler->get($dept);

        foreach ($tickets as $ticket) {
            $logMessage = $this->logMessageHandler->create();
            $logMessage->setVar('uid', $xoopsUser->getVar('uid'));
            $logMessage->setVar('ticketid', $ticket->getVar('id'));
            $logMessage->setVar('lastUpdated', \time());
            $logMessage->setVar('action', \sprintf(\_XHELP_LOG_SETDEPT, $deptObj->getVar('department')));
            $logMessage->setVar('action', \sprintf(\_XHELP_LOG_SETDEPT, /** @scrutinizer ignore-type */ $deptObj->getVar('department')));
            $this->logMessageHandler->insert($logMessage);
            unset($logMessage);
        }

        return true;
    }

    /**
     * Add Log Events for 'batch_priority' event
     * @param array $tickets  Array of Ticket objects
     * @param int   $priority New priority level for tickets
     * @return bool  True on success, false on error
     */
    public function batch_priority(array $tickets, int $priority): bool
    {
        global $xoopsUser;

        $priority = $priority;
        foreach ($tickets as $ticket) {
            $logMessage = $this->logMessageHandler->create();
            $logMessage->setVar('uid', $xoopsUser->getVar('uid'));
            $logMessage->setVar('ticketid', $ticket->getVar('id'));
            $logMessage->setVar('lastUpdated', $ticket->getVar('lastUpdated'));
            $logMessage->setVar('posted', $ticket->getVar('posted'));
            $logMessage->setVar('action', \sprintf(\_XHELP_LOG_UPDATE_PRIORITY, $ticket->getVar('priority'), $priority));
            $this->logMessageHandler->insert($logMessage);
        }

        return true;
    }

    /**
     * Add Log Events for 'batch_owner' event
     * @param array $tickets Array of Ticket objects
     * @param int   $owner   New owner for tickets
     * @return bool  True on success, false on error
     */
    public function batch_owner(array $tickets, int $owner): bool
    {
        global $xoopsUser;

        $updated   = \time();
        $ownername = ($xoopsUser->getVar('uid') == $owner ? $xoopsUser->getVar('uname') : $xoopsUser::getUnameFromId($owner));
        foreach ($tickets as $ticket) {
            $logMessage = $this->logMessageHandler->create();
            $logMessage->setVar('uid', $xoopsUser->getVar('uid'));
            $logMessage->setVar('ticketid', $ticket->getVar('id'));
            $logMessage->setVar('lastUpdated', $updated);
            if ($xoopsUser->getVar('uid') == $owner) {
                $logMessage->setVar('action', \_XHELP_LOG_CLAIM_OWNERSHIP);
            } else {
                $logMessage->setVar('action', \sprintf(\_XHELP_LOG_ASSIGN_OWNERSHIP, $ownername));
            }
            $this->logMessageHandler->insert($logMessage);
            unset($logMessage);
        }

        return true;
    }

    /**
     * Add Log Events for 'batch_status' event
     * @param array $tickets   Array of Ticket objects
     * @param int   $newstatus New status for tickets
     * @return bool  True on success, false on error
     */
    public function batch_status(array $tickets, int $newstatus): bool
    {
        global $xoopsUser;

        $updated = \time();
        $sStatus = Utility::getStatus($newstatus);
        $uid     = $xoopsUser->getVar('uid');
        foreach ($tickets as $ticket) {
            $logMessage = $this->logMessageHandler->create();
            $logMessage->setVar('uid', $uid);
            $logMessage->setVar('ticketid', $ticket->getVar('id'));
            $logMessage->setVar('lastUpdated', $updated);
            $logMessage->setVar('action', \sprintf(\_XHELP_LOG_UPDATE_STATUS, Utility::getStatus($ticket->getVar('status')), $sStatus));
            $this->logMessageHandler->insert($logMessage, true);
            unset($logMessage);
        }

        return true;
    }

    /**
     * Event: batch_response
     * Triggered after a batch response addition
     * Note: the $response->getVar('ticketid') field is empty for this function
     * @param array    $tickets  The Ticket objects that were modified
     * @param Response $response The response added to each ticket
     * @return bool
     */
    public function batch_response(array $tickets, Response $response): bool
    public function batch_response(array $tickets, /** @scrutinizer ignore-unused */ Response $response): bool
    {
        global $xoopsUser;

        $updateTime = \time();
        $uid        = $xoopsUser->getVar('uid');

        foreach ($tickets as $ticket) {
            $logMessage = $this->logMessageHandler->create();
            $logMessage->setVar('uid', $uid);
            $logMessage->setVar('ticketid', $ticket->getVar('id'));
            $logMessage->setVar('action', \_XHELP_LOG_ADDRESPONSE);
            $logMessage->setVar('lastUpdated', $updateTime);
            $this->logMessageHandler->insert($logMessage);
        }

        return true;
    }

    /**
     * Add Log Events for 'merge_tickets' event
     * @param int $ticketid      First ticket being merged
     * @param int $mergeTicketid Second ticket being merged
     * @param int $newTicket     Resulting merged ticket
     * @return bool True on success, false on error
     */
    public function merge_tickets(int $ticketid, int $mergeTicketid, int $newTicket): bool
    public function merge_tickets(int $ticketid, int $mergeTicketid, /** @scrutinizer ignore-unused */ int $newTicket): bool
    {
        global $xoopsUser;

        $logMessage = $this->logMessageHandler->create();
        $logMessage->setVar('uid', $xoopsUser->getVar('uid'));
        $logMessage->setVar('ticketid', $ticketid);
        $logMessage->setVar('action', \sprintf(\_XHELP_LOG_MERGETICKETS, $mergeTicketid, $ticketid));
        $logMessage->setVar('lastUpdated', \time());
        if ($this->logMessageHandler->insert($logMessage)) {
            return true;
        }

        return false;
    }

    /**
     * Add Log Events for 'delete_file' event
     * @param File $file File being deleted
     * @return bool      True on success, false on error
     */
    public function delete_file(File $file): bool
    {
        global $xoopsUser;

        $filename = $file->getVar('filename');

        $logMessage = $this->logMessageHandler->create();
        $logMessage->setVar('uid', $xoopsUser->getVar('uid'));
        $logMessage->setVar('ticketid', $file->getVar('ticketid'));
        $logMessage->setVar('action', \sprintf(\_XHELP_LOG_DELETEFILE, $filename));
        $logMessage->setVar('action', \sprintf(\_XHELP_LOG_DELETEFILE, /** @scrutinizer ignore-type */ $filename));
        $logMessage->setVar('lastUpdated', \time());

        if ($this->logMessageHandler->insert($logMessage, true)) {
            return true;
        }

        return false;
    }

    /**
     * Event: new_faq
     * Triggered after FAQ addition
     * @param Ticket $ticket Ticket used as base for FAQ
     * @param Faq    $faq    FAQ that was added
     * @return bool
     */
    public function new_faq(Ticket $ticket, Faq $faq): bool
    {
        global $xoopsUser;

        $logMessage = $this->logMessageHandler->create();
        $logMessage->setVar('uid', $xoopsUser->getVar('uid'));
        $logMessage->setVar('ticketid', $ticket->getVar('id'));
        $logMessage->setVar('action', \sprintf(\_XHELP_LOG_NEWFAQ, $faq->getVar('subject')));
        $logMessage->setVar('action', \sprintf(\_XHELP_LOG_NEWFAQ, /** @scrutinizer ignore-type */ $faq->getVar('subject')));

        return $this->logMessageHandler->insert($logMessage, true);
    }

    /**
     * Only have 1 instance of class used
     * @return Service {@link Service}
     */
    public static function getInstance(): Service
    {
        static $instance;
        if (null === $instance) {
            $instance = new static();
        }

        return $instance;
    }
}


XoopsModules25x / xhelp

Issues (1844)

Security Analysis not enabled

class/LogService.php (18 issues)

Labels

Severity

Introduced By

Duplication Side-by-Side

Filter issues like