FileMaster

Edit File: ConnectionReports.php

<?php

namespace Cleantalk\ApbctWP;

use Cleantalk\Antispam\CleantalkRequest;
use Cleantalk\Antispam\CleantalkResponse;
use Cleantalk\ApbctWP\Variables\Server;
use Cleantalk\Common\TextPlateStatic;
use Cleantalk\Common\TT;

class ConnectionReports
{
    /**
     * Statistics of state
     * @var int[]
     */
    public $reports_count = array(
        'positive' => 0,
        'negative' => 0,
        'total' => 0,
        'stat_since' => 0
    );

/**
     * Instance of DB object
     * @var DB
     */
    private $db;

/**
     * DB table name
     * @var string
     */
    private $cr_table_name;

/**
     * Limit of reports to keep
     * @var int
     */
    private $reports_limit = 20;

/**
     * @var array Current reports data from DB
     */
    private $reports_data = array();

/**
     * @var bool Flag to track if reports data needs refreshing
     */
    private $reports_data_dirty = true;

/**
     * @var array|null Cache for unsent reports IDs
     */
    private $unsent_reports_cache = null;

/**
     * ConnectionReports constructor.
     * @param DB $db
     * @param string $cr_table_name
     */
    public function __construct(DB $db, $cr_table_name)
    {
        global $apbct;
        $this->db = $db;
        $this->cr_table_name = $cr_table_name;

// Initialize reports count from APBCT data
        $this->initializeReportsCount($apbct);

// Defer loading reports data until actually needed
    }

/**
     * Initialize reports count from APBCT data
     * @param mixed $apbct
     */
    private function initializeReportsCount($apbct)
    {
        $this->reports_count['positive'] = isset($apbct->data['connection_reports_count']['positive'])
            ? $apbct->data['connection_reports_count']['positive']
            : 0;
        $this->reports_count['negative'] = isset($apbct->data['connection_reports_count']['negative'])
            ? $apbct->data['connection_reports_count']['negative']
            : 0;
        $this->reports_count['total'] = isset($apbct->data['connection_reports_count']['total'])
            ? $apbct->data['connection_reports_count']['total']
            : 0;
        $this->reports_count['stat_since'] = isset($apbct->data['connection_reports_count']['stat_since'])
            ? $apbct->data['connection_reports_count']['stat_since']
            : date('d M');
    }

/**
     * Get reports data with lazy loading
     * @return array
     */
    private function getReportsData()
    {
        if ($this->reports_data_dirty || empty($this->reports_data)) {
            $this->loadReportsDataFromDb();
        }
        return $this->reports_data;
    }

/**
     * Initialize once all the reports data from Db to class
     */
    private function loadReportsDataFromDb()
    {
        $table_exist = $this->db->fetchAll(
            'SHOW TABLES LIKE "' . $this->cr_table_name . '";'
        );

if (empty($table_exist)) {
            $this->reports_data = array();
            $this->reports_data_dirty = false;
            $this->unsent_reports_cache = null;
            return;
        }

$sql = "SELECT *, FROM_UNIXTIME(date) AS date, FROM_UNIXTIME(sent_on) AS sent_on FROM " . $this->cr_table_name . " ORDER BY date;";
        $this->reports_data = TT::toArray($this->db->fetchAll($sql));
        $this->reports_data_dirty = false;
        $this->unsent_reports_cache = null; // Invalidate cache
    }

/**
     * Mark reports data as dirty (needs refresh)
     */
    private function markReportsDataDirty()
    {
        $this->reports_data_dirty = true;
        $this->unsent_reports_cache = null;
    }

/**
     * Update global stats in state
     */
    private function updateStats()
    {
        global $apbct;
        $positive = isset($this->reports_count['positive']) ? $this->reports_count['positive'] : 0;
        $negative = isset($this->reports_count['negative']) ? $this->reports_count['negative'] : 0;
        $this->reports_count['total'] = $positive + $negative;
        $apbct->data['connection_reports_count'] = $this->reports_count;
        $apbct->saveData();
    }

/**
     * Array of report's IDs that has null on sent_on field
     * @return array
     */
    private function getUnsentReportsIds()
    {
        if ($this->unsent_reports_cache !== null) {
            return $this->unsent_reports_cache;
        }

$result = array();
        $reports_data = $this->getReportsData();

foreach ($reports_data as $row) {
            if (isset($row['id']) && (empty($row['sent_on']) || $row['sent_on'] === 'NULL')) {
                $result[] = $row['id'];
            }
        }

$this->unsent_reports_cache = $result;
        return $result;
    }

/**
     * Set reports as sent in batch
     * @param array $ids Array of report IDs
     */
    private function setReportsAsSent(array $ids)
    {
        if (empty($ids)) {
            return;
        }

// Use IN clause for batch update
        $placeholders = implode(',', array_fill(0, count($ids), '%s'));
        $query = "UPDATE " . $this->cr_table_name . " SET sent_on = %s WHERE id IN ($placeholders)";

$params = array_merge([time()], $ids);
        $this->db->prepare($query, $params);
        $this->db->execute($this->db->getQuery());

$this->markReportsDataDirty();
    }

/**
     * Rotates reports in DB, remove oldest one.
     */
    private function rotateReports()
    {
        $reports_data = $this->getReportsData();

if (count($reports_data) >= $this->reports_limit) {
            $overlimit = count($reports_data) - $this->reports_limit + 1;
            $reports_to_del = array_slice($reports_data, 0, $overlimit);

$ids = array_column($reports_to_del, 'id');
            $placeholders = implode(',', array_fill(0, count($ids), '%s'));

$this->db->prepare(
                "DELETE FROM " . $this->cr_table_name . " WHERE id IN ($placeholders)",
                $ids
            );
            $this->db->execute($this->db->getQuery());

$this->markReportsDataDirty();
        }
    }

/**
     * Return reports data by their Ids
     * @param array $ids
     * @return array
     */
    private function getReportsDataByIds(array $ids)
    {
        if (empty($ids)) {
            return array();
        }

$reports = array();
        $reports_data = $this->getReportsData();

foreach ($reports_data as $report) {
            if (in_array($report['id'], $ids, false)) {
                $reports[] = $report;
            }
        }

return $reports;
    }

/**
     * Add report data to DB
     * @param string $lib_report HTTP lib report text
     * @param string $failed_work_urls Current work URLs of CT server that failed
     * @param array $request_content CleanTalk request content
     * @param bool $post_blocked_via_js_check Flag if JS check passed request or not
     */
    private function addReportToDb(
        $lib_report = '',
        $failed_work_urls = '',
        $request_content = array(),
        $post_blocked_via_js_check = false
    ) {
        $cr_data = array(
            'date' => time(),
            'page_url' => get_site_url() . TT::toString(Server::get('REQUEST_URI')),
            'lib_report' => $lib_report,
            'failed_work_urls' => $failed_work_urls,
            'request_content' => json_encode(esc_sql($request_content)),
            'js_block' => $post_blocked_via_js_check ? '1' : '0'
        );

$this->db->prepare(
            "INSERT INTO " . $this->cr_table_name . "
            SET
                date = %s,
                page_url = %s,
                lib_report = %s,
                failed_work_urls = %s,
                request_content = %s,
                js_block = %s",
            array(
                $cr_data['date'],
                $cr_data['page_url'],
                $cr_data['lib_report'],
                $cr_data['failed_work_urls'],
                $cr_data['request_content'],
                $cr_data['js_block'],
            )
        );

$this->db->execute($this->db->getQuery());
        $this->markReportsDataDirty();
    }

/**
     * Return HTML of negative reports table
     * @return string
     * @psalm-suppress PossiblyUnusedMethod
     * @psalm-suppress PossiblyUndefinedStringArrayOffset
     */
    public function prepareNegativeReportsHtmlForSettingsPage()
    {
        $reports_data = $this->getReportsData();

if (empty($reports_data)) {
            return '';
        }

$rows = '';
        $stat_since = isset($this->reports_count['stat_since']) ? $this->reports_count['stat_since'] : '';
        $total = isset($this->reports_count['total']) ? $this->reports_count['total'] : '';
        $positive = isset($this->reports_count['positive']) ? $this->reports_count['positive'] : '';
        $negative = isset($this->reports_count['negative']) ? $this->reports_count['negative'] : '';

$reports_html = '<div>From '
 . Escape::escHtml($stat_since)
 . ' to ' . Escape::escHtml(date('d M')) . ' has been made '
 . Escape::escHtml($total)
 . ' calls, where ' . Escape::escHtml($positive) . ' were success and '
 . Escape::escHtml($negative) . ' were negative
 </div>';

foreach ($reports_data as $key => $report) {
            $rows .= $this->prepareReportRow($key, $report);
        }

$reports_html .= "
 <table id='apbct_negative_reports_table'>
 <th colspan='7'>Failed connection reports</th>
 <tr>
 <td>#</td>
 <td>Date</td>
 <td>Page URL</td>
 <td>Report</td>
 <td>Server IP</td>
 <td>Blocked via JS</td>
 <td>Status</td>
 </tr>"
 . $rows
 . "</table>";

return $reports_html;
    }

/**
     * Prepare single report row HTML
     * @param int $key
     * @param array $report
     * @return string
     */
    private function prepareReportRow($key, $report)
    {
        // Determine status and color
        if (isset($report['sent_on']) && $report['sent_on']) {
            $status = 'Sent';
            $color = 'gray';
        } else {
            $status = 'New';
            $color = 'black';
        }

$report_date = isset($report['date']) ? $report['date'] : time();
        $report_page_url = isset($report['page_url']) ? $report['page_url'] : '';
        $report_lib_report = isset($report['lib_report']) ? $report['lib_report'] : '';
        $report_failed_work_urls = isset($report['failed_work_urls']) ? $report['failed_work_urls'] : '';
        $report_js_block = isset($report['js_block']) ? $report['js_block'] : 0;

return '<tr style="color:' . $color . '">'
 . '<td>' . Escape::escHtml((int)$key + 1) . '.</td>'
 . '<td>' . Escape::escHtml($report_date) . '</td>'
 . '<td>' . Escape::escUrl($report_page_url) . '</td>'
 . '<td>' . Escape::escHtml($report_lib_report) . '</td>'
 . '<td>' . Escape::escHtml($report_failed_work_urls) . '</td>'
 . '<td>' . Escape::escHtml($report_js_block === '1' ? 'Yes' : 'No') . '</td>'
 . '<td>' . Escape::escHtml($status) . '</td>'
 . '</tr>';
 }

/**
     * Check if there are reports kept
     * @return bool
     * @psalm-suppress PossiblyUnusedMethod
     */
    public function hasNegativeReports()
    {
        return count($this->getReportsData()) > 0;
    }

/**
     * Init connection reports handling
     * @param CleantalkRequest $request
     * @param CleantalkResponse $request_response
     * @param bool $post_blocked_via_js_check
     * @psalm-suppress PossiblyUnusedMethod
     */
    public function handleRequest(
        CleantalkRequest $request,
        CleantalkResponse $request_response,
        $post_blocked_via_js_check
    ) {
        // Succeeded connection
        if ($request_response->errno === 0 && empty($request_response->errstr)) {
            if (isset($this->reports_count['positive'])) {
                $this->reports_count['positive']++;
            } else {
                $this->reports_count['positive'] = 1;
            }
        } else {
            // Failed to connect. Add a negative report
            $this->rotateReports();
            if (isset($this->reports_count['negative'])) {
                $this->reports_count['negative']++;
            } else {
                $this->reports_count['negative'] = 1;
            }
            $this->addReportToDb(
                $request_response->errstr,
                $request_response->failed_connections_urls_string,
                Helper::arrayObjectToArray($request),
                $post_blocked_via_js_check
            );
        }
        $this->updateStats();
    }

/**
     * Send email to welcome@cleantlk.org about failed connection reports
     * @param array $unsent_reports_ids IDs of reports that still not sent
     * @param bool $is_cron_task Set if this is a cron task
     * @return bool
     * @psalm-suppress PossiblyUnusedMethod
     */
    private function sendEmail(array $unsent_reports_ids, $is_cron_task = false)
    {
        global $apbct;
        $selection = $this->getReportsDataByIds($unsent_reports_ids);

if (empty($selection)) {
            return false;
        }

$to = $apbct->data['email_for_reports'];
        $subject = "CleanTalk Service Report: Connection v" . APBCT_VERSION . " for " . Server::getString('HTTP_HOST') ;

$message = $this->prepareEmailContent($selection, $is_cron_task);
        $headers = "Content-type: text/html; charset=utf-8 \r\n";
        $headers .= 'From: ' . ct_get_admin_email();

if (wp_mail($to, $subject, $message, $headers)) {
            return true;
        }
        return false;
    }

/**
     * Prepare email content
     * @param array $selection
     * @param bool $is_cron_task
     * @return string
     */
    private function prepareEmailContent(array $selection, $is_cron_task = false)
    {
        global $apbct;
        $stat_since = isset($this->reports_count['stat_since']) ? $this->reports_count['stat_since'] : '';
        $total = isset($this->reports_count['total']) ? $this->reports_count['total'] : '';
        $positive = isset($this->reports_count['positive']) ? $this->reports_count['positive'] : '';
        $negative = isset($this->reports_count['negative']) ? $this->reports_count['negative'] : '';

$message = '
 <html lang="en">
 <head>
 <title></title>
 </head>
 <body>
 From ' . Escape::escHtml($stat_since) . ' to ' . Escape::escHtml(date('d M')) . ' has been made ' . Escape::escHtml($total) .
 ' calls, where ' . Escape::escHtml($positive) . ' were success and ' . Escape::escHtml($negative) . ' were negative
 Negative report:
 <table>
 <tr>
 <td>&nbsp;</td>
 <td>Date</td>
 <td>Page URL</td>
 <td>Library report</td>
 <td>Server IP</td>
 <td>Blocked via JS</td>
 </tr>';

$counter = 0;
 foreach ($selection as $report) {
 $message .= '<tr>'
 . '<td>' . (++$counter) . '.</td>'
 . '<td>' . TT::toString($report['date']) . '</td>'
 . '<td>' . Escape::escUrl($report['page_url']) . '</td>'
 . '<td>' . Escape::escHtml($report['lib_report']) . '</td>'
 . '<td>' . Escape::escHtml($report['failed_work_urls']) . '</td>'
 . '<td>' . ($report['js_block'] === '1' ? 'Yes' : 'No') . '</td>'
 . '</tr>';
 }

$message .= '</table> ';
 $message .= ' ' . ($is_cron_task ? 'This is a cron task.' : 'This is a manual task.') . ' ';
 $message .= ' Site service_id: ' . $apbct->data['service_id'] . ' ';
 $message .= '</body></html>';

return $message;
    }

/**
     * Init reports sending
     * @param bool $is_cron_task Set if this is a cron task
     * @return string Used just to debug CRON task
     * @psalm-suppress PossiblyUnusedMethod
     */
    public function sendUnsentReports($is_cron_task = false)
    {
        $unsent_reports_ids = $this->getUnsentReportsIds();

if (!empty($unsent_reports_ids)) {
            if ($this->sendEmail($unsent_reports_ids, $is_cron_task)) {
                $this->setReportsAsSent($unsent_reports_ids);
                return count($unsent_reports_ids) . ' reports were sent.';
            }
        }
        return 'Nothing to sent.';
    }

/**
     * Check if there are unsent reports
     * @return bool
     * @psalm-suppress PossiblyUnusedMethod
     */
    public function hasUnsentReports()
    {
        return !empty($this->getUnsentReportsIds());
    }

/**
     * Prepare data for remote call answer
     * @return array
     * @psalm-suppress PossiblyUnusedMethod
     */
    public function remoteCallOutput()
    {
        return $this->getReportsData();
    }

/**
     * Truncate connection reports DB
     *  @psalm-suppress PossiblyUnusedMethod
     */
    public function wipeReportsData()
    {
        $this->db->execute("TRUNCATE TABLE " . $this->cr_table_name);
        $this->markReportsDataDirty();
    }

/**
 * Get option description
 * @param bool $sfw_enabled
 * @param string $brand_name
 * @return string
 */
 public static function getOptionDescription($sfw_enabled, $brand_name, $email)
 {
 $send_connection_reports__sfw_text = '';
 $sfw_outdated_message = '';
 if ($sfw_enabled) {
 $send_connection_reports__sfw_text = ' ' . __('- status of SpamFireWall database updating process', 'cleantalk-spam-protect');
 $sfw_outdated_message = ' ' . __('Also, if enabled, a notification will appear in the plugin settings informing you that the SpamFireWall database is outdated.', 'cleantalk-spam-protect');
 }
 return TextPlateStatic::render(
 '{{first_row}} {{second_row}} {{list_1}}{{list_2}}{{sfw_outdated_message}}',
 array(
 'first_row' => __("Checking this box you allow plugin to send the information about your connection.", 'cleantalk-spam-protect'),
 'second_row' => esc_html__(
 sprintf(
 'These reports are to be sent to %s and could contain',
 $email
 )
 ),
 'list_1' => esc_html__(
 sprintf(
 '- connection status to %s cloud during Anti-Spam request',
 TT::toString($brand_name, __('service', 'cleantalk-spam-protect'))
 )
 ),
 'list_2' => $send_connection_reports__sfw_text,
 'sfw_outdated_message' => $sfw_outdated_message,
 )
 );
 }
}

Back