<?php
/**
 * Download logs.
 *
 * @package rd-downloads
 * phpcs:disable WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching
 */


namespace RdDownloads\App\Models;

if (!class_exists('\\RdDownloads\\App\\Models\\RdDownloadLogs')) {
    class RdDownloadLogs
    {


        use \RdDownloads\App\AppTrait;


        /**
         * @var array All available download logs statuses. Do not change without modified anything called this.
         */
        protected $dlStatuses = [
            'admin_insert',// admin add new downloads
            'admin_update', // admin update download data
            'admin_delete', // admin delete download data
            'admin_clear_logs', // admin clear all the logs
            'auto_purge_old_logs',// automatically purge old logs from cron
            'github_autoupdate',// github auto update
            'user_dl_success', // user (guests and members) download success
            'user_dl_error', // user got an error while downloading
            'user_dl_banned', // user gets banned while downloading
            'user_dl_antbotfailed',// user failed to verify antibot
        ];


        /**
         * Clear all logs and add the log that this admin was cleared the logs.
         *
         * @global \wpdb $wpdb
         */
        public function clearLogs()
        {
            global $wpdb;

            $output = [];

            $truncateResult = $wpdb->query('TRUNCATE TABLE `' . $wpdb->prefix . 'rd_download_logs`');
            $output['truncate'] = $truncateResult;
            if (false === $truncateResult) {
                $output['truncate_error'] = $wpdb->last_error;
                $deleteResult = $wpdb->query('DELETE FROM `' . $wpdb->prefix . 'rd_download_logs`');
                $output['delete'] = $deleteResult;
                if (false === $deleteResult) {
                    $output['delete_error'] = $wpdb->last_error;
                }
            }

            unset($deleteResult, $truncateResult);

            $this->writeLog('admin_clear_logs');

            return $output;
        }// clearLogs


        /**
         * Get one row of data from rd_download_logs and related tables.
         *
         * This method use `get_row()` of `\wpdb` class.
         *
         * @global \wpdb $wpdb
         * @param array $options The conditions to get data. The array key must be map to table fields.<br>
         *                                      Additional array keys:<br>
         *                                      *select = The fields to select in sql statement. This must be string.<br>
         *                                      *conditions = Custom conditions. This value must array and must contain "statement" and "args" in keys. To use conditions, the *select key is not recommended to use.<br>
         *                                      *search = A search keyword. To use search keywords, the *select key is not recommended to use.<br>
         *                                      *return_prepare = Set this to true to just call `prepare()` and return it without execute `get_row()`.<br>
         *                                      Example:
         * <pre>
         * array(
         *     '*select' => 'COUNT(download_id)',
         *     '*conditions' => array(
         *         'statement' => '`download_type` = %d OR `user_id` = %d',// the parenthesis will be cover automatically.
         *         'args' => [0, 1],
         *     ),
         *     '*search' => 'myfile.zip',
         *     '*return_prepare' => false,
         * )
         * </pre>
         * @return object|null|void|string Database query result in format specified by $output or null on failure. If *return_prepare in options was set, it will return prepared statement string.
         */
        public function get(array $options = [])
        {
            global $wpdb;

            // fix ambiguous
            if (isset($options['user_id'])) {
                $options[$wpdb->prefix . 'rd_download_logs.user_id'] = $options['user_id'];
                unset($options['user_id']);
            }
            if (isset($options['download_id'])) {
                $options[$wpdb->prefix . 'rd_download_logs.download_id'] = $options['download_id'];
                unset($options['download_id']);
            }

            // sql
            $prepareValues = [];
            $sql = 'SELECT ';
            if (isset($options['*select'])) {
                // if there is custom select fields.
                $sql .= $options['*select'];
                unset($options['*select']);
            } else {
                // if there is no custom select fields.
                $sql .= $this->getSelectFields();
            }
            $sql .= ' FROM `' . $wpdb->prefix . 'rd_download_logs`';
            $sql .= ' LEFT JOIN `' . $wpdb->prefix . 'rd_downloads` ON `' . $wpdb->prefix . 'rd_download_logs`.`download_id` = `' . $wpdb->prefix . 'rd_downloads`.`download_id`';
            $sql .= ' LEFT JOIN `' . $wpdb->users . '` ON `' . $wpdb->prefix . 'rd_download_logs`.`user_id` = `' . $wpdb->users . '`.`ID`';

            $sql .= ' WHERE %d';
            $prepareValues[] = 1;

            // custom conditions.
            if (
                isset($options['*conditions']) &&
                isset($options['*conditions']['statement']) &&
                isset($options['*conditions']['args']) &&
                is_string($options['*conditions']['statement']) &&
                is_array($options['*conditions']['args'])
            ) {
                $sql .= ' AND (' . $options['*conditions']['statement'] . ')';
                $prepareValues = $prepareValues + $options['*conditions']['args'];
                unset($options['*conditions']);
            }

            // search keywords.
            if (isset($options['*search'])) {
                $sql .= ' AND ' . $this->getSearchFields();
                foreach ($this->getSearchFields(false) as $item) {
                    $prepareValues[] = '%'.$wpdb->esc_like($options['*search']).'%';
                }// endforeach;
                unset($item);
                unset($options['*search']);
            }

            // put the rest of fields into statement.
            $fieldsOptions = $this->populateFieldOptions($options);
            if (!empty($fieldsOptions) && is_array($fieldsOptions)) {
                $sql .= ' AND (';
                // Get array keys
                $arrayKeys = array_keys($fieldsOptions);
                // Fetch last array key
                $lastArrayKey = array_pop($arrayKeys);
                foreach ($fieldsOptions as $name => $value) {
                    if (is_scalar($name) && strpos($name, '*') === false) {
                        if (strpos($name, '.') === false) {
                            $sql .= '`' . $name . '` = %s';
                        } else {
                            $sql .= $name . ' = %s';
                        }
                        $prepareValues[] = $value;
                        if ($name !== $lastArrayKey) {
                            $sql .= ' AND ';
                        }
                    }
                }// endforeach;
                unset($name, $value);
                $sql .= ')';
                unset($arrayKeys, $lastArrayKey);
            }
            unset($fieldsOptions);

            $prepared = $wpdb->prepare($sql, $prepareValues);
            unset($prepareValues, $sql);

            if (isset($options['*return_prepare']) && true === $options['*return_prepare']) {
                return $prepared;
            }

            $result = $wpdb->get_row($prepared);

            return $result;
        }// get


        /**
         * Get searchable fields.
         *
         * @global \wpdb $wpdb
         * @param bool $returnStatement Set to false to return as array fields, set to true to generate SQL statement string.
         * @return array|string Return array values of searchable fields or return SQL statement string with parenthesis.
         */
        public function getSearchFields($returnStatement = true)
        {
            global $wpdb;

            $fields = [
                '`dl_status`',
                '`dl_ip`',
                '`dl_user_agent`',
                '`download_name`',
                '`download_admin_comment`',
                '`download_github_name`',
                '`download_url`',
                '`download_related_path`',
                '`download_file_name`',
            ];

            if (true === $returnStatement) {
                $statement = '(';
                // Get array keys
                $arrayKeys = array_keys($fields);
                // Fetch last array key
                $lastArrayKey = array_pop($arrayKeys);
                foreach ($fields as $key => $item) {
                    $statement .= $item . ' LIKE %s';
                    if ($key !== $lastArrayKey) {
                        $statement .= ' OR ';
                    }
                }// endforeach;
                unset($arrayKeys, $item, $key, $lastArrayKey);
                $statement .= ')';

                return $statement;
            } else {
                return $fields;
            }
        }// getSearchFields


        /**
         * Get select fields.
         *
         * @global \wpdb $wpdb
         * @param bool $returnStatement Set to false to return as array fields, set to true to generate SQL statement string.
         * @return array|string Return array values of select fields or return SQL statement string.
         */
        public function getSelectFields($returnStatement = true)
        {
            global $wpdb;

            $fields = [
                '`' . $wpdb->prefix . 'rd_download_logs`.*',
                '`' . $wpdb->prefix . 'rd_download_logs`.`download_id` AS `download_id`',
                '`' . $wpdb->prefix . 'rd_download_logs`.`user_id` AS `user_id`',
                '`' . $wpdb->users . '`.`ID`',
                '`' . $wpdb->users . '`.`user_login`',
                '`' . $wpdb->users . '`.`user_nicename`',
                '`' . $wpdb->users . '`.`user_email`',
                '`' . $wpdb->users . '`.`user_registered`',
                '`' . $wpdb->users . '`.`display_name`',
            ];

            if (true === $returnStatement) {
                return implode(', ', $fields);
            } else {
                return $fields;
            }
        }// getSelectFields


        /**
         * List items from rd_download_logs and related tables.
         *
         * This method use `get_results()` of `\wpdb` class.
         *
         * @global \wpdb $wpdb
         * @param array $options The conditions to get data. The array key must be map to table fields.<br>
         *                                      Additional array keys:<br>
         *                                      *conditions = Custom conditions. This value must array and must contain "statement" and "args" in keys. To use conditions, the *select key is not recommended to use.<br>
         *                                      *search = A search keyword. To use search keywords, the *select key is not recommended to use.<br>
         *                                      *sort = A field to sort.<br>
         *                                      *order = Order the sorting (ASC, DESC)<br>
         *                                      *current_page = The current page number.<br>
         *                                      *per_page = Total item per page.<br>
         *                                      *unlimit = Set this value to true to skip `LIMIT command and *current_page, *per_page will not work.
         *                                      Example:
         * <pre>
         * array(
         *     'download_id' => 1,
         *     'user_id' => 1,
         *     '*conditions' => array(
         *         'statement' => '`download_type` = %d OR `user_id` = %d',// the parenthesis will be cover automatically.
         *         'args' => [0, 1],
         *     ),
         *     '*search' => 'myfile.zip',
         *     '*sort' => 'download_id',
         *     '*order' => 'DESC',
         *     '*current_page' => 1,
         *     '*per_page' => 20,
         *     '*unlimit' => false,// set to true *current_page, *per_page will not work.
         * )
         * </pre>
         * @return array Return array with "total", "results" in key.
         */
        public function listItems(array $options = [])
        {
            global $wpdb;

            // fix ambiguous
            if (isset($options['user_id'])) {
                $options[$wpdb->prefix . 'rd_download_logs.user_id'] = $options['user_id'];
                unset($options['user_id']);
            }
            if (isset($options['download_id'])) {
                $options[$wpdb->prefix . 'rd_download_logs.download_id'] = $options['download_id'];
                unset($options['download_id']);
            }

            // sql
            $prepareValues = [];
            $sql = 'SELECT %*%, `' . $wpdb->prefix . 'rd_download_logs`.`download_id` AS `download_id`, `' . $wpdb->prefix . 'rd_download_logs`.`user_id` AS `user_id`';
            $sql .= ' FROM `' . $wpdb->prefix . 'rd_download_logs`';
            $sql .= ' LEFT JOIN `' . $wpdb->prefix . 'rd_downloads` ON `' . $wpdb->prefix . 'rd_download_logs`.`download_id` = `' . $wpdb->prefix . 'rd_downloads`.`download_id`';
            $sql .= ' LEFT JOIN `' . $wpdb->users . '` ON `' . $wpdb->prefix . 'rd_download_logs`.`user_id` = `' . $wpdb->users . '`.`ID`';

            $sql .= ' WHERE %d';
            $prepareValues[] = 1;

            // custom conditions.
            if (
                isset($options['*conditions']) &&
                isset($options['*conditions']['statement']) &&
                isset($options['*conditions']['args']) &&
                is_string($options['*conditions']['statement']) &&
                is_array($options['*conditions']['args'])
            ) {
                $sql .= ' AND (' . $options['*conditions']['statement'] . ')';
                $prepareValues = $prepareValues + $options['*conditions']['args'];
                unset($options['*conditions']);
            }

            // search keywords.
            if (isset($options['*search']) && !empty($options['*search'])) {
                $sql .= ' AND ' . $this->getSearchFields();
                foreach ($this->getSearchFields(false) as $item) {
                    $prepareValues[] = '%'.$wpdb->esc_like($options['*search']).'%';
                }// endforeach;
                unset($item);
                unset($options['*search']);
            }

            // put the rest of fields into statement.
            $fieldsOptions = $this->populateFieldOptions($options);
            if (!empty($fieldsOptions) && is_array($fieldsOptions)) {
                $sql .= ' AND (';
                // Get array keys
                $arrayKeys = array_keys($fieldsOptions);
                // Fetch last array key
                $lastArrayKey = array_pop($arrayKeys);
                foreach ($fieldsOptions as $name => $value) {
                    if (is_scalar($name) && strpos($name, '*') === false) {
                        if (strpos($name, '.') === false) {
                            $sql .= '`' . $name . '` = %s';
                        } else {
                            $sql .= $name . ' = %s';
                        }
                        $prepareValues[] = $value;
                        if ($name !== $lastArrayKey) {
                            $sql .= ' AND ';
                        }
                    }
                }// endforeach;
                unset($name, $value);
                $sql .= ')';
                unset($arrayKeys, $lastArrayKey);
            }
            unset($fieldsOptions);

            $total_items = $wpdb->get_var(
                $wpdb->prepare(
                    // phpcs:ignore WordPress.DB.PreparedSQLPlaceholders.UnsupportedPlaceholder, WordPress.DB.PreparedSQLPlaceholders.UnfinishedPrepare
                    str_replace(['%*%'], ['COUNT(' . $wpdb->prefix . 'rd_download_logs.download_id)'], $sql),
                    $prepareValues
                )
            );

            // set sort order
            $sort = 'dl_id';
            if (isset($options['*sort'])) {
                $sort = $options['*sort'];
            }
            if ('user_id' === $sort) {
                $sort = $wpdb->users . '.display_name';
            } elseif ('download_id' === $sort) {
                $sort = $wpdb->prefix . 'rd_download_logs.download_id';
            }

            $order = 'DESC';
            if (isset($options['*order'])) {
                if (strtolower($options['*order']) === 'asc') {
                    $order = 'ASC';
                }  elseif (strtolower($options['*order']) === 'desc') {
                    $order = 'DESC';
                }
            }

            // get data that sliced per page and sort order
            $sql = str_replace('%*%', '*', $sql);
            // sort order
            $sql .= ' ORDER BY ' . $sort . ' ' . $order;
            if (!isset($options['*unlimit']) || (isset($options['*unlimit']) && false === $options['*unlimit'])) {
                // sliced per page
                $current_page = 1;
                if (isset($options['*current_page']) && is_numeric($options['*current_page'])) {
                    $current_page = intval($options['*current_page']);
                }
                $per_page = 20;
                if (isset($options['*per_page']) && is_numeric($options['*per_page'])) {
                    $per_page = intval($options['*per_page']);
                }
                $sql .= ' LIMIT ' . (($current_page - 1) * $per_page) . ', ' . $per_page;
                unset($current_page, $per_page);
            }

            $results = $wpdb->get_results(
                $wpdb->prepare($sql, $prepareValues)
            );
            unset($order, $prepareValues, $sort, $sql);

            return [
                'total' => $total_items,
                'results' => $results,
            ];
        }// listItems


        /**
         * Filter out "*" to keep only fields option from many options (including custom options) based on `get()` and `listItems()` methods.
         *
         * @param array $options The options.
         * @return array Return filtered out any options that contain * mark.
         */
        protected function populateFieldOptions(array $options)
        {
            $output = [];

            foreach ($options as $name => $value) {
                if (is_scalar($name) && strpos($name, '*') === false) {
                    $output[$name] = $value;
                }
            }// endforeach;
            unset($name, $value);

            return $output;
        }// populateFieldOptions


        /**
         * Write log to DB.
         *
         * @global array $rd_downloads_options
         * @global \wpdb $wpdb
         * @param string $status The log status, please refer from `dlStatuses` property.
         * @param array $data The associate array where key is table fields.
         * @return bool
         * @throws \InvalidArgumentException Throws exception if there is invalid argument value.
         */
        public function writeLog($status, array $data = [])
        {
            if (!is_scalar($status)) {
                return false;
            } elseif (!in_array(strtolower($status), $this->dlStatuses)) {
                throw new \InvalidArgumentException('Failed to validate `$status` with class property `dlStatuses` on ' . __FILE__ . ' line ' . (__LINE__ - 1) . '.');
            }

            $this->getOptions();
            global $rd_downloads_options;

            if (isset($rd_downloads_options['rdd_admin_logs']) && strval($rd_downloads_options['rdd_admin_logs']) !== '1') {
                // if admin logs is in the settings page was not set (set to do not log admin actions).
                if (stripos($status, 'admin_') !== false) {
                    // if found admin log.
                    // return false to do nothing.
                    return false;
                }
            }

            if (!isset($data['dl_referrer']) && isset($_GET['rddownloads_http_referrer'])) {
                $data['dl_referrer'] = sanitize_url(wp_unslash($_GET['rddownloads_http_referrer']));
            }

            $prepareData = [];
            $prepareData['user_id'] = get_current_user_id();
            if (strval($prepareData['user_id']) === '0' || empty($prepareData['user_id'])) {
                unset($prepareData['user_id']);
            }
            $prepareData['dl_ip'] = filter_input(INPUT_SERVER, 'REMOTE_ADDR');
            $prepareData['dl_ip'] = (is_string($prepareData['dl_ip']) ? htmlspecialchars($prepareData['dl_ip'], ENT_QUOTES) : $prepareData['dl_ip']);
            $prepareData['dl_user_agent'] = filter_input(INPUT_SERVER, 'HTTP_USER_AGENT');
            $prepareData['dl_user_agent'] = (is_string($prepareData['dl_user_agent']) ? htmlspecialchars($prepareData['dl_user_agent'], ENT_QUOTES) : $prepareData['dl_user_agent']);
            $prepareData['dl_date'] = current_time('mysql');
            $prepareData['dl_date_gmt'] = current_time('mysql', true);

            $data = array_merge($prepareData, $data);
            unset($prepareData);

            $data['dl_status'] = $status;

            global $wpdb;
            $saveResult = $wpdb->insert($wpdb->prefix . 'rd_download_logs', $data);
            if (false !== $saveResult) {
                unset($saveResult);
                return true;
            } else {
                unset($saveResult);
                return false;
            }
        }// writeLog


    }
}