lib.php

<?php

// This file contains extra functions for Agora and XTECBlocs services.

const XTECADMIN_USERNAME = 'xtecadmin';
const ADMIN_USERNAME = 'admin';
const DATE_FORMAT_LITERAL = 'Y-m-d H:i:s';


/**
 * Decide if the current installation is XTECBlocs or not
 *
 * @return boolean
 */
function is_xtecblocs(): bool
{
    global $isBlocs;
    return $isBlocs;
}

/**
 * Decide if the current installation is Àgora or not
 *
 * @return boolean
 */
function is_agora(): bool
{
    global $isAgora;
    return $isAgora;
}

/**
 * Decide if user has full access. In Àgora must be xtecadmin and
 * in XTECBlocs must be network admin.
 *
 * @return boolean
 */
function is_xtec_super_admin(): bool
{
    return is_xtecadmin() || is_blocsadmin();
}

/**
 * Check if the current logged user is Agora xtecadmin.
 */
function is_xtecadmin(): bool
{
    global $current_user, $isAgora;
    return $isAgora && isset($current_user->user_login) && ($current_user->user_login === 'xtecadmin');
}

/**
 * Check if the current logged user is blocs admin.
 */
function is_blocsadmin(): bool
{
    global $isBlocs;
    return $isBlocs && is_super_admin();
}

/**
 * Get the ID of xtecadmin user.
 *
 * @return int ID of xtecadmin
 */
function get_xtecadmin_id(): int
{
    return get_user_by('login', 'xtecadmin')->ID;
}

/**
 * Get the username of xtecadmin
 *
 * @return string username of xtecadmin
 */
function get_xtecadmin_username(): string
{
    return 'xtecadmin';
}

/**
 * Collect basic statistical and security information.
 *
 * @throws Exception
 */
function save_stats(): void
{
    global $current_user, $table_prefix, $wpdb;

    $table = $table_prefix . 'stats';

    // Get the local timestamp
    $dt = new DateTime('now', new DateTimeZone(wp_timezone_string()));
    $dt->setTimestamp(time());
    $datetime = $dt->format(DATE_FORMAT_LITERAL);

    $ip = $ipForward = $ipClient = $userAgent = $uri = '';

    // Usage of filter_input() guarantees that info is clean.
    if (!empty($_SERVER['REMOTE_ADDR'])) {
        $ip = filter_input(INPUT_SERVER, 'REMOTE_ADDR', FILTER_SANITIZE_FULL_SPECIAL_CHARS);
    }

    if (!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) {
        $ipForward = filter_input(INPUT_SERVER, 'HTTP_X_FORWARDED_FOR', FILTER_SANITIZE_FULL_SPECIAL_CHARS);
    }

    if (!empty($_SERVER['HTTP_CLIENT_IP'])) {
        $ipClient = filter_input(INPUT_SERVER, 'HTTP_CLIENT_IP', FILTER_SANITIZE_FULL_SPECIAL_CHARS);
    }

    if (!empty($_SERVER['HTTP_USER_AGENT'])) {
        $userAgent = filter_input(INPUT_SERVER, 'HTTP_USER_AGENT', FILTER_SANITIZE_FULL_SPECIAL_CHARS);
    }

    if (!empty($_SERVER['REQUEST_URI'])) {
        $uri = filter_input(INPUT_SERVER, 'REQUEST_URI', FILTER_SANITIZE_FULL_SPECIAL_CHARS);
        if (isset($_REQUEST['action']) && strrpos($uri, 'admin-ajax.php')) {
            // Added action information to ajax callbacks
            $uri .= '?action=' . $_REQUEST['action'];
        }
    }

    $uid = $current_user->ID;
    $username = $current_user->user_login;
    $email = $current_user->user_email;

    $isadmin = current_user_can('manage_options');
    $action = array_key_exists('action', $_REQUEST) ? $_REQUEST['action'] : '';

    // Save additional information in some cases.
    $content = xtec_save_action_content($action, $table_prefix, $wpdb);

    $data = [
        'datetime' => $datetime,
        'ip' => $ip,
        'ipForward' => $ipForward,
        'ipClient' => $ipClient,
        'userAgent' => $userAgent,
        'uri' => $uri,
        'uid' => $uid,
        'isadmin' => $isadmin,
        'username' => $username,
        'email' => $email,
    ];

    $fields = ['%s', '%s', '%s', '%s', '%s', '%s', '%d', '%d', '%s', '%s'];

    if (!empty($content)) {
        $data['content'] = $content;
        $fields[] = '%s';
    }
    $wpdb->insert($table, $data, $fields);

    // Update the number of visits in wp_options. Exclude cron and Heartbeat actions.
    if ((!str_contains($uri, 'wp-cron')) && (!str_contains($uri, 'wp-admin'))) {
        xtec_update_visits($isadmin);
    }
}

// Helper function for saving action-specific content.
function xtec_save_action_content(string $action, string $table_prefix, wpdb $wpdb): string
{
    switch ($action) {
        case 'delete_activity':
        case 'delete_activity_comment':
            // Deleting bp-activity
            $result = ['id' => $_REQUEST['id'] ?? null];
            if (!$result['id']) {
                return '';
            }
            $query = "SELECT content FROM {$table_prefix}bp_activity WHERE id='" . $result['id'] . "'";
            $result['content'] = $wpdb->get_var($query);
            return var_export($result, true);

        case 'bbp-edit-topic':
            // Editing bp-forum topic
            $is_editing = isset($_REQUEST['bbp_log_topic_edit']) && $_REQUEST['bbp_log_topic_edit'];
            if ($is_editing) {
                $result = ['id' => $_REQUEST['bbp_topic_id'] ?? null];
                if (!$result['id']) {
                    return '';
                }
                $query = "SELECT post_content, post_title FROM {$table_prefix}posts WHERE id=" . $result['id'];
                $tmp_result = $wpdb->get_results($query);
                $result['old_content'] = $tmp_result[0]->post_content ?? '';
                $result['old_title'] = $tmp_result[0]->post_title ?? '';
                return var_export($result, true);
            }
            break;

        case 'bbp-edit-reply':
            // Editing bp-forum reply
            $is_editing = isset($_REQUEST['bbp_log_reply_edit']) && $_REQUEST['bbp_log_reply_edit'];
            if ($is_editing) {
                $result = ['id' => $_REQUEST['bbp_reply_id'] ?? null];
                if (!$result['id']) {
                    return '';
                }
                $query = "SELECT post_content FROM {$table_prefix}posts WHERE id=" . $result['id'];
                $result['old_content'] = $wpdb->get_var($query);
                return var_export($result, true);
            }
            break;

        default:
            return '';
    }

    return '';
}

// Helper function for updating visit counts.
function xtec_update_visits(bool $isadmin): void
{
    $visits = get_option('xtec-stats-visits');
    $include_admin = get_option('xtec-stats-include-admin');

    // If the option is not set yet, creates it and set initial value.
    if ($visits === false) {
        global $wpdb, $table_prefix;
        $query = "SELECT count(*) AS Total FROM {$table_prefix}stats
                  WHERE uri NOT LIKE('%wp-cron%') AND uri NOT LIKE('%wp-admin%')";
        $result = $wpdb->get_results($query);
        $total = $result[0]->Total ?? 0;
        add_option('xtec-stats-visits', $total);
        if ($include_admin === false) {
            add_option('xtec-stats-include-admin', 'on');
        }
    } elseif (!$isadmin || ($include_admin === 'on')) {
        // Increase the number of visits by 1.
        update_option('xtec-stats-visits', (int)$visits + 1);
    }
}

/**
 * This action is called from the WordPress cron (it's supposed to be programmed). Remove all wp_stats content
 *  older that one year and the visits of the search robots older than two months.
 *
 * @global object $wpdb
 * @author Toni Ginard
 */
function remove_old_stats(): void
{
    global $wpdb;

    $time = strtotime("-1 year");
    $datetime = date(DATE_FORMAT_LITERAL, $time);

    $table = $wpdb->prefix . 'stats';
    $wpdb->query("DELETE FROM `$table` WHERE datetime < '$datetime' ");

    $time = strtotime("-2 month");
    $datetime = date(DATE_FORMAT_LITERAL, $time);
    $search_bots = [
        'Baidu',
        'Googlebot',
        'Yahoo',
        'bingbot',
        'YandexBot',
        'GrapeshotCrawler',
        'DotBot',
        'Gecko/20100101 Firefox/6.0.2',
    ];
    $where = "WHERE datetime < '$datetime' AND (`userAgent` like '%" . implode('%\' or `userAgent` like \'%', $search_bots) . "%')";

    $wpdb->query("DELETE FROM `$table` $where");
}

function parse_cli_args(): void
{
    global $cliargs;

    $cliargs = [];
    $rawoptions = $_SERVER['argv'];

    if (($key = array_search('--', $rawoptions, true)) !== false) {
        $rawoptions = array_slice($rawoptions, 0, $key);
    }

    unset($rawoptions[0]);

    foreach ($rawoptions as $raw) {
        $value = '';

        if (str_starts_with($raw, '--')) {
            $value = substr($raw, 2);
        } else if (str_starts_with($raw, '-')) {
            $value = substr($raw, 1);
        }

        $parts = explode('=', $value);

        if (count($parts) === 1) {
            $key = reset($parts);
            $value = true;
        } else {
            $key = array_shift($parts);
            $value = implode('=', $parts);
            $value = str_replace("\\'", "'", $value);
        }

        $cliargs[$key] = $value;
    }
}

function get_cli_arg($arg)
{
    global $cliargs;
    if (empty($cliargs)) {
        parse_cli_args();
    }

    return $cliargs[$arg] ?? false;
}