composer.json 0000644 00000000633 15246276230 0007277 0 ustar 00 {
"name": "litespeedtech/lscache_wp",
"require-dev": {
"squizlabs/php_codesniffer": "*",
"phpcompatibility/php-compatibility": "*"
},
"prefer-stable": true,
"scripts": {
"post-install-cmd": "phpcs --config-set installed_paths vendor/phpcompatibility/php-compatibility",
"post-update-cmd": "phpcs --config-set installed_paths vendor/phpcompatibility/php-compatibility",
"sniff-check": "phpcs"
}
} src/report.cls.php 0000644 00000014221 15246276230 0010146 0 ustar 00
*/
namespace LiteSpeed;
defined('WPINC') || exit();
class Report extends Base
{
const TYPE_SEND_REPORT = 'send_report';
/**
* Handle all request actions from main cls
*
* @since 1.6.5
* @access public
*/
public function handler()
{
$type = Router::verify_type();
switch ($type) {
case self::TYPE_SEND_REPORT:
$this->post_env();
break;
default:
break;
}
Admin::redirect();
}
/**
* post env report number to ls center server
*
* @since 1.6.5
* @access public
*/
public function post_env()
{
$report_con = $this->generate_environment_report();
// Generate link
$link = !empty($_POST['link']) ? esc_url($_POST['link']) : '';
$notes = !empty($_POST['notes']) ? esc_html($_POST['notes']) : '';
$php_info = !empty($_POST['attach_php']) ? esc_html($_POST['attach_php']) : '';
$report_php = $php_info === '1' ? $this->generate_php_report() : '';
if ($report_php) {
$report_con .= "\nPHPINFO\n" . $report_php;
}
$data = array(
'env' => $report_con,
'link' => $link,
'notes' => $notes,
);
$json = Cloud::post(Cloud::API_REPORT, $data);
if (!is_array($json)) {
return;
}
$num = !empty($json['num']) ? $json['num'] : '--';
$summary = array(
'num' => $num,
'dateline' => time(),
);
self::save_summary($summary);
return $num;
}
/**
* Gathers the PHP information.
*
* @since 7.0
* @access public
*/
public function generate_php_report($flags = INFO_GENERAL | INFO_CONFIGURATION | INFO_MODULES)
{
// INFO_ENVIRONMENT
$report = '';
ob_start();
phpinfo($flags);
$report = ob_get_contents();
ob_end_clean();
preg_match('%.*?(.*?)%s', $report, $report);
return $report[2];
}
/**
* Gathers the environment details and creates the report.
* Will write to the environment report file.
*
* @since 1.0.12
* @access public
*/
public function generate_environment_report($options = null)
{
global $wp_version, $_SERVER;
$frontend_htaccess = Htaccess::get_frontend_htaccess();
$backend_htaccess = Htaccess::get_backend_htaccess();
$paths = array($frontend_htaccess);
if ($frontend_htaccess != $backend_htaccess) {
$paths[] = $backend_htaccess;
}
if (is_multisite()) {
$active_plugins = get_site_option('active_sitewide_plugins');
if (!empty($active_plugins)) {
$active_plugins = array_keys($active_plugins);
}
} else {
$active_plugins = get_option('active_plugins');
}
if (function_exists('wp_get_theme')) {
$theme_obj = wp_get_theme();
$active_theme = $theme_obj->get('Name');
} else {
$active_theme = get_current_theme();
}
$extras = array(
'wordpress version' => $wp_version,
'siteurl' => get_option('siteurl'),
'home' => get_option('home'),
'home_url' => home_url(),
'locale' => get_locale(),
'active theme' => $active_theme,
);
$extras['active plugins'] = $active_plugins;
$extras['cloud'] = Cloud::get_summary();
foreach (array('mini_html', 'pk_b64', 'sk_b64', 'cdn_dash', 'ips') as $v) {
if (!empty($extras['cloud'][$v])) {
unset($extras['cloud'][$v]);
}
}
if (is_null($options)) {
$options = $this->get_options(true);
if (is_multisite()) {
$options2 = $this->get_options();
foreach ($options2 as $k => $v) {
if (isset($options[$k]) && $options[$k] !== $v) {
$options['[Overwritten] ' . $k] = $v;
}
}
}
}
if (!is_null($options) && is_multisite()) {
$blogs = Activation::get_network_ids();
if (!empty($blogs)) {
$i = 0;
foreach ($blogs as $blog_id) {
if (++$i > 3) {
// Only log 3 subsites
break;
}
$opts = $this->cls('Conf')->load_options($blog_id, true);
if (isset($opts[self::O_CACHE])) {
$options['blog ' . $blog_id . ' radio select'] = $opts[self::O_CACHE];
}
}
}
}
// Security: Remove cf key in report
$secure_fields = array(self::O_CDN_CLOUDFLARE_KEY, self::O_OBJECT_PSWD);
foreach ($secure_fields as $v) {
if (!empty($options[$v])) {
$options[$v] = str_repeat('*', strlen($options[$v]));
}
}
$report = $this->build_environment_report($_SERVER, $options, $extras, $paths);
return $report;
}
/**
* Builds the environment report buffer with the given parameters
*
* @access private
*/
private function build_environment_report($server, $options, $extras = array(), $htaccess_paths = array())
{
$server_keys = array(
'DOCUMENT_ROOT' => '',
'SERVER_SOFTWARE' => '',
'X-LSCACHE' => '',
'HTTP_X_LSCACHE' => '',
);
$server_vars = array_intersect_key($server, $server_keys);
$server_vars[] = 'LSWCP_TAG_PREFIX = ' . LSWCP_TAG_PREFIX;
$server_vars = array_merge($server_vars, $this->cls('Base')->server_vars());
$buf = $this->_format_report_section('Server Variables', $server_vars);
$buf .= $this->_format_report_section('WordPress Specific Extras', $extras);
$buf .= $this->_format_report_section('LSCache Plugin Options', $options);
if (empty($htaccess_paths)) {
return $buf;
}
foreach ($htaccess_paths as $path) {
if (!file_exists($path) || !is_readable($path)) {
$buf .= $path . " does not exist or is not readable.\n";
continue;
}
$content = file_get_contents($path);
if ($content === false) {
$buf .= $path . " returned false for file_get_contents.\n";
continue;
}
$buf .= $path . " contents:\n" . $content . "\n\n";
}
return $buf;
}
/**
* Creates a part of the environment report based on a section header and an array for the section parameters.
*
* @since 1.0.12
* @access private
*/
private function _format_report_section($section_header, $section)
{
$tab = ' '; // four spaces
if (empty($section)) {
return 'No matching ' . $section_header . "\n\n";
}
$buf = $section_header;
foreach ($section as $k => $v) {
$buf .= "\n" . $tab;
if (!is_numeric($k)) {
$buf .= $k . ' = ';
}
if (!is_string($v)) {
$v = var_export($v, true);
} else {
$v = esc_html($v);
}
$buf .= $v;
}
return $buf . "\n\n";
}
}
src/img-optm.cls.php 0000644 00000200144 15246276230 0010365 0 ustar 00
*/
namespace LiteSpeed;
use WpOrg\Requests\Autoload;
use WpOrg\Requests\Requests;
defined('WPINC') || exit();
class Img_Optm extends Base
{
const LOG_TAG = 'ποΈ';
const CLOUD_ACTION_NEW_REQ = 'new_req';
const CLOUD_ACTION_TAKEN = 'taken';
const CLOUD_ACTION_REQUEST_DESTROY = 'imgoptm_destroy';
const CLOUD_ACTION_CLEAN = 'clean';
const TYPE_NEW_REQ = 'new_req';
const TYPE_RESCAN = 'rescan';
const TYPE_DESTROY = 'destroy';
const TYPE_RESET_COUNTER = 'reset_counter';
const TYPE_CLEAN = 'clean';
const TYPE_PULL = 'pull';
const TYPE_BATCH_SWITCH_ORI = 'batch_switch_ori';
const TYPE_BATCH_SWITCH_OPTM = 'batch_switch_optm';
const TYPE_CALC_BKUP = 'calc_bkup';
const TYPE_RESET_ROW = 'reset_row';
const TYPE_RM_BKUP = 'rm_bkup';
const STATUS_NEW = 0; // 'new';
const STATUS_RAW = 1; // 'raw';
const STATUS_REQUESTED = 3; // 'requested';
const STATUS_NOTIFIED = 6; // 'notified';
const STATUS_DUPLICATED = 8; // 'duplicated';
const STATUS_PULLED = 9; // 'pulled';
const STATUS_FAILED = -1; //'failed';
const STATUS_MISS = -3; // 'miss';
const STATUS_ERR_FETCH = -5; // 'err_fetch';
const STATUS_ERR_404 = -6; // 'err_404';
const STATUS_ERR_OPTM = -7; // 'err_optm';
const STATUS_XMETA = -8; // 'xmeta';
const STATUS_ERR = -9; // 'err';
const DB_SIZE = 'litespeed-optimize-size';
const DB_SET = 'litespeed-optimize-set';
const DB_NEED_PULL = 'need_pull';
private $wp_upload_dir;
private $tmp_pid;
private $tmp_type;
private $tmp_path;
private $_img_in_queue = array();
private $_existed_src_list = array();
private $_pids_set = array();
private $_thumbnail_set = '';
private $_table_img_optm;
private $_table_img_optming;
private $_cron_ran = false;
private $__media;
private $__data;
protected $_summary;
private $_format = '';
/**
* Init
*
* @since 2.0
*/
public function __construct()
{
Debug2::debug2('[ImgOptm] init');
$this->wp_upload_dir = wp_upload_dir();
$this->__media = $this->cls('Media');
$this->__data = $this->cls('Data');
$this->_table_img_optm = $this->__data->tb('img_optm');
$this->_table_img_optming = $this->__data->tb('img_optming');
$this->_summary = self::get_summary();
if (empty($this->_summary['next_post_id'])) {
$this->_summary['next_post_id'] = 0;
}
if ($this->conf(Base::O_IMG_OPTM_WEBP)) {
$this->_format = 'webp';
if ($this->conf(Base::O_IMG_OPTM_WEBP) == 2) {
$this->_format = 'avif';
}
}
}
/**
* Gather images auto when update attachment meta
* This is to optimize new uploaded images first. Stored in img_optm table.
* Later normal process will auto remove these records when trying to optimize these images again
*
* @since 4.0
*/
public function wp_update_attachment_metadata($meta_value, $post_id)
{
global $wpdb;
self::debug2('ποΈ Auto update attachment meta [id] ' . $post_id);
if (empty($meta_value['file'])) {
return;
}
// Load gathered images
if (!$this->_existed_src_list) {
// To aavoid extra query when recalling this function
self::debug('SELECT src from img_optm table');
if ($this->__data->tb_exist('img_optm')) {
$q = "SELECT src FROM `$this->_table_img_optm` WHERE post_id = %d";
$list = $wpdb->get_results($wpdb->prepare($q, $post_id));
foreach ($list as $v) {
$this->_existed_src_list[] = $post_id . '.' . $v->src;
}
}
if ($this->__data->tb_exist('img_optming')) {
$q = "SELECT src FROM `$this->_table_img_optming` WHERE post_id = %d";
$list = $wpdb->get_results($wpdb->prepare($q, $post_id));
foreach ($list as $v) {
$this->_existed_src_list[] = $post_id . '.' . $v->src;
}
} else {
$this->__data->tb_create('img_optming');
}
}
// Prepare images
$this->tmp_pid = $post_id;
$this->tmp_path = pathinfo($meta_value['file'], PATHINFO_DIRNAME) . '/';
$this->_append_img_queue($meta_value, true);
if (!empty($meta_value['sizes'])) {
array_map(array($this, '_append_img_queue'), $meta_value['sizes']);
}
if (!$this->_img_in_queue) {
self::debug('auto update attachment meta 2 bypass: empty _img_in_queue');
return;
}
// Save to DB
$this->_save_raw();
// $this->_send_request();
}
/**
* Auto send optm request
*
* @since 2.4.1
* @access public
*/
public static function cron_auto_request()
{
if (!defined('DOING_CRON')) {
return false;
}
$instance = self::cls();
$instance->new_req();
}
/**
* Calculate wet run allowance
*
* @since 3.0
*/
public function wet_limit()
{
$wet_limit = 1;
if (!empty($this->_summary['img_taken'])) {
$wet_limit = pow($this->_summary['img_taken'], 2);
}
if ($wet_limit == 1 && !empty($this->_summary['img_status.' . self::STATUS_ERR_OPTM])) {
$wet_limit = pow($this->_summary['img_status.' . self::STATUS_ERR_OPTM], 2);
}
if ($wet_limit < Cloud::IMG_OPTM_DEFAULT_GROUP) {
return $wet_limit;
}
// No limit
return false;
}
/**
* Push raw img to image optm server
*
* @since 1.6
* @access public
*/
public function new_req()
{
global $wpdb;
// check if is running
if (!empty($this->_summary['is_running']) && time() - $this->_summary['is_running'] < apply_filters('litespeed_imgoptm_new_req_interval', 3600)) {
self::debug('The previous req was in 3600s.');
return;
}
$this->_summary['is_running'] = time();
self::save_summary();
// Check if has credit to push
$err = false;
$allowance = Cloud::cls()->allowance(Cloud::SVC_IMG_OPTM, $err);
$wet_limit = $this->wet_limit();
self::debug("allowance_max $allowance wet_limit $wet_limit");
if ($wet_limit && $wet_limit < $allowance) {
$allowance = $wet_limit;
}
if (!$allowance) {
self::debug('β No credit');
Admin_Display::error(Error::msg($err));
$this->_finished_running();
return;
}
self::debug('preparing images to push');
$this->__data->tb_create('img_optming');
$q = "SELECT COUNT(1) FROM `$this->_table_img_optming` WHERE optm_status = %d";
$q = $wpdb->prepare($q, array(self::STATUS_REQUESTED));
$total_requested = $wpdb->get_var($q);
$max_requested = $allowance * 1;
if ($total_requested > $max_requested) {
self::debug('β Too many queued images (' . $total_requested . ' > ' . $max_requested . ')');
Admin_Display::error(Error::msg('too_many_requested'));
$this->_finished_running();
return;
}
$allowance -= $total_requested;
if ($allowance < 1) {
self::debug('β Too many requested images ' . $total_requested);
Admin_Display::error(Error::msg('too_many_requested'));
$this->_finished_running();
return;
}
// Limit maximum number of items waiting to be pulled
$q = "SELECT COUNT(1) FROM `$this->_table_img_optming` WHERE optm_status = %d";
$q = $wpdb->prepare($q, array(self::STATUS_NOTIFIED));
$total_notified = $wpdb->get_var($q);
if ($total_notified > 0) {
self::debug('β Too many notified images (' . $total_notified . ')');
Admin_Display::error(Error::msg('too_many_notified'));
$this->_finished_running();
return;
}
$q = "SELECT COUNT(1) FROM `$this->_table_img_optming` WHERE optm_status IN (%d, %d)";
$q = $wpdb->prepare($q, array(self::STATUS_NEW, self::STATUS_RAW));
$total_new = $wpdb->get_var($q);
// $allowance -= $total_new;
// May need to get more images
$list = array();
$more = $allowance - $total_new;
if ($more > 0) {
$q = "SELECT b.post_id, b.meta_value
FROM `$wpdb->posts` a
LEFT JOIN `$wpdb->postmeta` b ON b.post_id = a.ID
WHERE b.meta_key = '_wp_attachment_metadata'
AND a.post_type = 'attachment'
AND a.post_status = 'inherit'
AND a.ID>%d
AND a.post_mime_type IN ('image/jpeg', 'image/png', 'image/gif')
ORDER BY a.ID
LIMIT %d
";
$q = $wpdb->prepare($q, array($this->_summary['next_post_id'], $more));
$list = $wpdb->get_results($q);
foreach ($list as $v) {
if (!$v->post_id) {
continue;
}
$this->_summary['next_post_id'] = $v->post_id;
$meta_value = $this->_parse_wp_meta_value($v);
if (!$meta_value) {
continue;
}
$meta_value['file'] = wp_normalize_path($meta_value['file']);
$basedir = $this->wp_upload_dir['basedir'] . '/';
if (strpos($meta_value['file'], $basedir) === 0) {
$meta_value['file'] = substr($meta_value['file'], strlen($basedir));
}
$this->tmp_pid = $v->post_id;
$this->tmp_path = pathinfo($meta_value['file'], PATHINFO_DIRNAME) . '/';
$this->_append_img_queue($meta_value, true);
if (!empty($meta_value['sizes'])) {
array_map(array($this, '_append_img_queue'), $meta_value['sizes']);
}
}
self::save_summary();
$num_a = count($this->_img_in_queue);
self::debug('Images found: ' . $num_a);
$this->_filter_duplicated_src();
self::debug('Images after duplicated: ' . count($this->_img_in_queue));
$this->_filter_invalid_src();
self::debug('Images after invalid: ' . count($this->_img_in_queue));
// Check w/ legacy imgoptm table, bypass finished images
$this->_filter_legacy_src();
$num_b = count($this->_img_in_queue);
if ($num_b != $num_a) {
self::debug('Images after filtered duplicated/invalid/legacy src: ' . $num_b);
}
// Save to DB
$this->_save_raw();
}
// Push to Cloud server
$accepted_imgs = $this->_send_request($allowance);
$this->_finished_running();
if (!$accepted_imgs) {
return;
}
$placeholder1 = Admin_Display::print_plural($accepted_imgs[0], 'image');
$placeholder2 = Admin_Display::print_plural($accepted_imgs[1], 'image');
$msg = sprintf(__('Pushed %1$s to Cloud server, accepted %2$s.', 'litespeed-cache'), $placeholder1, $placeholder2);
Admin_Display::success($msg);
}
/**
* Set running to done
*/
private function _finished_running()
{
$this->_summary['is_running'] = 0;
self::save_summary();
}
/**
* Add a new img to queue which will be pushed to request
*
* @since 1.6
* @access private
*/
private function _append_img_queue($meta_value, $is_ori_file = false)
{
if (empty($meta_value['file']) || empty($meta_value['width']) || empty($meta_value['height'])) {
self::debug2('bypass image due to lack of file/w/h: pid ' . $this->tmp_pid, $meta_value);
return;
}
$short_file_path = $meta_value['file'];
if (!$is_ori_file) {
$short_file_path = $this->tmp_path . $short_file_path;
}
// Check if src is gathered already or not
if (in_array($this->tmp_pid . '.' . $short_file_path, $this->_existed_src_list)) {
// Debug2::debug2( '[Img_Optm] bypass image due to gathered: pid ' . $this->tmp_pid . ' ' . $short_file_path );
return;
} else {
// Append handled images
$this->_existed_src_list[] = $this->tmp_pid . '.' . $short_file_path;
}
// check file exists or not
$_img_info = $this->__media->info($short_file_path, $this->tmp_pid);
$extension = pathinfo($short_file_path, PATHINFO_EXTENSION);
if (!$_img_info || !in_array($extension, array('jpg', 'jpeg', 'png', 'gif'))) {
self::debug2('bypass image due to file not exist: pid ' . $this->tmp_pid . ' ' . $short_file_path);
return;
}
// Check if optimized file exists or not
$target_needed = false;
if ($this->_format) {
$target_file_path = $short_file_path . '.' . $this->_format;
if (!$this->__media->info($target_file_path, $this->tmp_pid)) {
$target_needed = true;
}
}
if ($this->conf(self::O_IMG_OPTM_ORI)) {
$target_file_path = substr($short_file_path, 0, -strlen($extension)) . 'bk.' . $extension;
if (!$this->__media->info($target_file_path, $this->tmp_pid)) {
$target_needed = true;
}
}
if (!$target_needed) {
self::debug2('bypass image due to optimized file exists: pid ' . $this->tmp_pid . ' ' . $short_file_path);
return;
}
// Debug2::debug2( '[Img_Optm] adding image: pid ' . $this->tmp_pid );
$this->_img_in_queue[] = array(
'pid' => $this->tmp_pid,
'md5' => $_img_info['md5'],
'url' => $_img_info['url'],
'src' => $short_file_path, // not needed in LiteSpeed IAPI, just leave for local storage after post
'mime_type' => !empty($meta_value['mime-type']) ? $meta_value['mime-type'] : '',
);
}
/**
* Save gathered image raw data
*
* @since 3.0
*/
private function _save_raw()
{
if (empty($this->_img_in_queue)) {
return;
}
$data = array();
$pid_list = array();
foreach ($this->_img_in_queue as $k => $v) {
$_img_info = $this->__media->info($v['src'], $v['pid']);
// attachment doesn't exist, delete the record
if (empty($_img_info['url']) || empty($_img_info['md5'])) {
unset($this->_img_in_queue[$k]);
continue;
}
$pid_list[] = (int) $v['pid'];
$data[] = $v['pid'];
$data[] = self::STATUS_RAW;
$data[] = $v['src'];
}
global $wpdb;
$fields = 'post_id, optm_status, src';
$q = "INSERT INTO `$this->_table_img_optming` ( $fields ) VALUES ";
// Add placeholder
$q .= Utility::chunk_placeholder($data, $fields);
// Store data
$wpdb->query($wpdb->prepare($q, $data));
$count = count($this->_img_in_queue);
self::debug('Added raw images [total] ' . $count);
$this->_img_in_queue = array();
// Save thumbnail groups for future rescan index
$this->_gen_thumbnail_set();
$pid_list = array_unique($pid_list);
self::debug('pid list to append to postmeta', $pid_list);
$pid_list = array_diff($pid_list, $this->_pids_set);
$this->_pids_set = array_merge($this->_pids_set, $pid_list);
$existed_meta = $wpdb->get_results("SELECT * FROM `$wpdb->postmeta` WHERE post_id IN ('" . implode("','", $pid_list) . "') AND meta_key='" . self::DB_SET . "'");
$existed_pid = array();
if ($existed_meta) {
foreach ($existed_meta as $v) {
$existed_pid[] = $v->post_id;
}
self::debug('pid list to update postmeta', $existed_pid);
$wpdb->query(
$wpdb->prepare("UPDATE `$wpdb->postmeta` SET meta_value=%s WHERE post_id IN ('" . implode("','", $existed_pid) . "') AND meta_key=%s", array(
$this->_thumbnail_set,
self::DB_SET,
))
);
}
# Add new meta
$new_pids = $existed_pid ? array_diff($pid_list, $existed_pid) : $pid_list;
if ($new_pids) {
self::debug('pid list to update postmeta', $new_pids);
foreach ($new_pids as $v) {
self::debug('New group set info [pid] ' . $v);
$q = "INSERT INTO `$wpdb->postmeta` (post_id, meta_key, meta_value) VALUES (%d, %s, %s)";
$wpdb->query($wpdb->prepare($q, array($v, self::DB_SET, $this->_thumbnail_set)));
}
}
}
/**
* Generate thumbnail sets of current image group
*
* @since 5.4
*/
private function _gen_thumbnail_set()
{
if ($this->_thumbnail_set) {
return;
}
$set = array();
foreach (Media::cls()->get_image_sizes() as $size) {
$curr_size = $size['width'] . 'x' . $size['height'];
if (in_array($curr_size, $set)) {
continue;
}
$set[] = $curr_size;
}
$this->_thumbnail_set = implode(PHP_EOL, $set);
}
/**
* Filter duplicated src in work table and $this->_img_in_queue, then mark them as duplicated
*
* @since 2.0
* @access private
*/
private function _filter_duplicated_src()
{
global $wpdb;
$srcpath_list = array();
$list = $wpdb->get_results("SELECT src FROM `$this->_table_img_optming`");
foreach ($list as $v) {
$srcpath_list[] = $v->src;
}
foreach ($this->_img_in_queue as $k => $v) {
if (in_array($v['src'], $srcpath_list)) {
unset($this->_img_in_queue[$k]);
continue;
}
$srcpath_list[] = $v['src'];
}
}
/**
* Filter legacy finished ones
*
* @since 5.4
*/
private function _filter_legacy_src()
{
global $wpdb;
if (!$this->__data->tb_exist('img_optm')) {
return;
}
if (!$this->_img_in_queue) {
return;
}
$finished_ids = array();
Utility::compatibility();
$post_ids = array_unique(array_column($this->_img_in_queue, 'pid'));
$list = $wpdb->get_results("SELECT post_id FROM `$this->_table_img_optm` WHERE post_id in (" . implode(',', $post_ids) . ') GROUP BY post_id');
foreach ($list as $v) {
$finished_ids[] = $v->post_id;
}
foreach ($this->_img_in_queue as $k => $v) {
if (in_array($v['pid'], $finished_ids)) {
self::debug('Legacy image optimized [pid] ' . $v['pid']);
unset($this->_img_in_queue[$k]);
continue;
}
}
// Drop all existing legacy records
$wpdb->query("DELETE FROM `$this->_table_img_optm` WHERE post_id in (" . implode(',', $post_ids) . ')');
}
/**
* Filter the invalid src before sending
*
* @since 3.0.8.3
* @access private
*/
private function _filter_invalid_src()
{
$img_in_queue_invalid = array();
foreach ($this->_img_in_queue as $k => $v) {
if ($v['src']) {
$extension = pathinfo($v['src'], PATHINFO_EXTENSION);
}
if (!$v['src'] || empty($extension) || !in_array($extension, array('jpg', 'jpeg', 'png', 'gif'))) {
$img_in_queue_invalid[] = $v['id'];
unset($this->_img_in_queue[$k]);
continue;
}
}
if (!$img_in_queue_invalid) {
return;
}
$count = count($img_in_queue_invalid);
$msg = sprintf(__('Cleared %1$s invalid images.', 'litespeed-cache'), $count);
Admin_Display::success($msg);
self::debug('Found invalid src [total] ' . $count);
}
/**
* Push img request to Cloud server
*
* @since 1.6.7
* @access private
*/
private function _send_request($allowance)
{
global $wpdb;
$q = "SELECT id, src, post_id FROM `$this->_table_img_optming` WHERE optm_status=%d LIMIT %d";
$q = $wpdb->prepare($q, array(self::STATUS_RAW, $allowance));
$_img_in_queue = $wpdb->get_results($q);
if (!$_img_in_queue) {
return;
}
self::debug('Load img in queue [total] ' . count($_img_in_queue));
$list = array();
foreach ($_img_in_queue as $v) {
$_img_info = $this->__media->info($v->src, $v->post_id);
# If record is invalid, remove from img_optming table
if (empty($_img_info['url']) || empty($_img_info['md5'])) {
$wpdb->query($wpdb->prepare("DELETE FROM `$this->_table_img_optming` WHERE id=%d", $v->id));
continue;
}
$img = array(
'id' => $v->id,
'url' => $_img_info['url'],
'md5' => $_img_info['md5'],
);
// Build the needed image types for request as we now support soft reset counter
if ($this->_format) {
$target_file_path = $v->src . '.' . $this->_format;
if ($this->__media->info($target_file_path, $v->post_id)) {
$img['optm_' . $this->_format] = 0;
}
}
if ($this->conf(self::O_IMG_OPTM_ORI)) {
$extension = pathinfo($v->src, PATHINFO_EXTENSION);
$target_file_path = substr($v->src, 0, -strlen($extension)) . 'bk.' . $extension;
if ($this->__media->info($target_file_path, $v->post_id)) {
$img['optm_ori'] = 0;
}
}
$list[] = $img;
}
if (!$list) {
$msg = __('No valid image found in the current request.', 'litespeed-cache');
Admin_Display::error($msg);
return;
}
$data = array(
'action' => self::CLOUD_ACTION_NEW_REQ,
'list' => \json_encode($list),
'optm_ori' => $this->conf(self::O_IMG_OPTM_ORI) ? 1 : 0,
'optm_lossless' => $this->conf(self::O_IMG_OPTM_LOSSLESS) ? 1 : 0,
'keep_exif' => $this->conf(self::O_IMG_OPTM_EXIF) ? 1 : 0,
);
if ($this->_format) {
$data['optm_' . $this->_format] = 1;
}
// Push to Cloud server
$json = Cloud::post(Cloud::SVC_IMG_OPTM, $data);
if (!$json) {
return;
}
// Check data format
if (empty($json['ids'])) {
self::debug('Failed to parse response data from Cloud server ', $json);
$msg = __('No valid image found by Cloud server in the current request.', 'litespeed-cache');
Admin_Display::error($msg);
return;
}
self::debug('Returned data from Cloud server count: ' . count($json['ids']));
$ids = implode(',', array_map('intval', $json['ids']));
// Update img table
$q = "UPDATE `$this->_table_img_optming` SET optm_status = '" . self::STATUS_REQUESTED . "' WHERE id IN ( $ids )";
$wpdb->query($q);
$this->_summary['last_requested'] = time();
self::save_summary();
return array(count($list), count($json['ids']));
}
/**
* Cloud server notify Client img status changed
*
* @access public
*/
public function notify_img()
{
// Interval validation to avoid hacking domain_key
if (!empty($this->_summary['notify_ts_err']) && time() - $this->_summary['notify_ts_err'] < 3) {
return Cloud::err('too_often');
}
$post_data = \json_decode(file_get_contents('php://input'), true);
if (is_null($post_data)) {
$post_data = $_POST;
}
global $wpdb;
$notified_data = $post_data['data'];
if (empty($notified_data) || !is_array($notified_data)) {
self::debug('β notify exit: no notified data');
return Cloud::err('no notified data');
}
if (empty($post_data['server']) || (substr($post_data['server'], -11) !== '.quic.cloud' && substr($post_data['server'], -15) !== '.quicserver.com')) {
self::debug('notify exit: no/wrong server');
return Cloud::err('no/wrong server');
}
if (empty($post_data['status'])) {
self::debug('notify missing status');
return Cloud::err('no status');
}
$status = $post_data['status'];
self::debug('notified status=' . $status);
$last_log_pid = 0;
if (empty($this->_summary['reduced'])) {
$this->_summary['reduced'] = 0;
}
if ($status == self::STATUS_NOTIFIED) {
// Notified data format: [ img_optm_id => [ id=>, src_size=>, ori=>, ori_md5=>, ori_reduced=>, webp=>, webp_md5=>, webp_reduced=> ] ]
$q =
"SELECT a.*, b.meta_id as b_meta_id, b.meta_value AS b_optm_info
FROM `$this->_table_img_optming` a
LEFT JOIN `$wpdb->postmeta` b ON b.post_id = a.post_id AND b.meta_key = %s
WHERE a.id IN ( " .
implode(',', array_fill(0, count($notified_data), '%d')) .
' )';
$list = $wpdb->get_results($wpdb->prepare($q, array_merge(array(self::DB_SIZE), array_keys($notified_data))));
$ls_optm_size_row_exists_postids = array();
foreach ($list as $v) {
$json = $notified_data[$v->id];
// self::debug('Notified data for [id] ' . $v->id, $json);
$server = !empty($json['server']) ? $json['server'] : $post_data['server'];
$server_info = array(
'server' => $server,
);
// Save server side ID to send taken notification after pulled
$server_info['id'] = $json['id'];
if (!empty($json['file_id'])) {
$server_info['file_id'] = $json['file_id'];
}
// Optm info array
$postmeta_info = array(
'ori_total' => 0,
'ori_saved' => 0,
'webp_total' => 0,
'webp_saved' => 0,
'avif_total' => 0,
'avif_saved' => 0,
);
// Init postmeta_info for the first one
if (!empty($v->b_meta_id)) {
foreach (maybe_unserialize($v->b_optm_info) as $k2 => $v2) {
$postmeta_info[$k2] += $v2;
}
}
if (!empty($json['ori'])) {
$server_info['ori_md5'] = $json['ori_md5'];
$server_info['ori'] = $json['ori'];
// Append meta info
$postmeta_info['ori_total'] += $json['src_size'];
$postmeta_info['ori_saved'] += $json['ori_reduced']; // optimized image size info in img_optm tb will be updated when pull
$this->_summary['reduced'] += $json['ori_reduced'];
}
if (!empty($json['webp'])) {
$server_info['webp_md5'] = $json['webp_md5'];
$server_info['webp'] = $json['webp'];
// Append meta info
$postmeta_info['webp_total'] += $json['src_size'];
$postmeta_info['webp_saved'] += $json['webp_reduced'];
$this->_summary['reduced'] += $json['webp_reduced'];
}
if (!empty($json['avif'])) {
$server_info['avif_md5'] = $json['avif_md5'];
$server_info['avif'] = $json['avif'];
// Append meta info
$postmeta_info['avif_total'] += $json['src_size'];
$postmeta_info['avif_saved'] += $json['avif_reduced'];
$this->_summary['reduced'] += $json['avif_reduced'];
}
// Update status and data in working table
$q = "UPDATE `$this->_table_img_optming` SET optm_status = %d, server_info = %s WHERE id = %d ";
$wpdb->query($wpdb->prepare($q, array($status, \json_encode($server_info), $v->id)));
// Update postmeta for optm summary
$postmeta_info = serialize($postmeta_info);
if (empty($v->b_meta_id) && !in_array($v->post_id, $ls_optm_size_row_exists_postids)) {
self::debug('New size info [pid] ' . $v->post_id);
$q = "INSERT INTO `$wpdb->postmeta` ( post_id, meta_key, meta_value ) VALUES ( %d, %s, %s )";
$wpdb->query($wpdb->prepare($q, array($v->post_id, self::DB_SIZE, $postmeta_info)));
$ls_optm_size_row_exists_postids[] = $v->post_id;
} else {
$q = "UPDATE `$wpdb->postmeta` SET meta_value = %s WHERE meta_id = %d ";
$wpdb->query($wpdb->prepare($q, array($postmeta_info, $v->b_meta_id)));
}
// write log
$pid_log = $last_log_pid == $v->post_id ? '.' : $v->post_id;
self::debug('notify_img [status] ' . $status . " \t\t[pid] " . $pid_log . " \t\t[id] " . $v->id);
$last_log_pid = $v->post_id;
}
self::save_summary();
// Mark need_pull tag for cron
self::update_option(self::DB_NEED_PULL, self::STATUS_NOTIFIED);
} else {
// Other errors will directly remove the working records
// Delete from working table
$q = "DELETE FROM `$this->_table_img_optming` WHERE id IN ( " . implode(',', array_fill(0, count($notified_data), '%d')) . ' ) ';
$wpdb->query($wpdb->prepare($q, $notified_data));
}
return Cloud::ok(array('count' => count($notified_data)));
}
/**
* Cron start async req
*
* @since 5.5
*/
public static function start_async_cron()
{
Task::async_call('imgoptm');
}
/**
* Manually start async req
*
* @since 5.5
*/
public static function start_async()
{
Task::async_call('imgoptm_force');
$msg = __('Started async image optimization request', 'litespeed-cache');
Admin_Display::success($msg);
}
/**
* Ajax req handler
*
* @since 5.5
*/
public static function async_handler($force = false)
{
self::debug('------------async-------------start_async_handler');
$tag = self::get_option(self::DB_NEED_PULL);
if (!$tag || $tag != self::STATUS_NOTIFIED) {
self::debug('β no need pull [tag] ' . $tag);
return;
}
if (defined('LITESPEED_IMG_OPTM_PULL_CRON') && !LITESPEED_IMG_OPTM_PULL_CRON) {
self::debug('Cron disabled [define] LITESPEED_IMG_OPTM_PULL_CRON');
return;
}
self::cls()->pull($force);
}
/**
* Calculate pull threads
*
* @since 5.8
* @access private
*/
private function _calc_pull_threads()
{
global $wpdb;
if (defined('LITESPEED_IMG_OPTM_PULL_THREADS')) {
return LITESPEED_IMG_OPTM_PULL_THREADS;
}
// Tune number of images per request based on number of images waiting and cloud packages
$imgs_per_req = 1; // base 1, ramp up to ~50 max
// Ramp up the request rate based on how many images are waiting
$c = "SELECT count(id) FROM `$this->_table_img_optming` WHERE optm_status = %d";
$_c = $wpdb->prepare($c, array(self::STATUS_NOTIFIED));
$images_waiting = $wpdb->get_var($_c);
if ($images_waiting && $images_waiting > 0) {
$imgs_per_req = ceil($images_waiting / 1000); //ie. download 5/request if 5000 images are waiting
}
// Cap the request rate at 50 images per request
$imgs_per_req = min(50, $imgs_per_req);
self::debug('Pulling images at rate: ' . $imgs_per_req . ' Images per request.');
return $imgs_per_req;
}
/**
* Pull optimized img
*
* @since 1.6
* @access public
*/
public function pull($manual = false)
{
global $wpdb;
$timeoutLimit = ini_get('max_execution_time');
$endts = time() + $timeoutLimit;
self::debug('' . ($manual ? 'Manually' : 'Cron') . ' pull started [timeout: ' . $timeoutLimit . 's]');
if ($this->cron_running()) {
self::debug('Pull cron is running');
$msg = __('Pull Cron is running', 'litespeed-cache');
Admin_Display::note($msg);
return;
}
$this->_summary['last_pulled'] = time();
$this->_summary['last_pulled_by_cron'] = !$manual;
self::save_summary();
$imgs_per_req = $this->_calc_pull_threads();
$q = "SELECT * FROM `$this->_table_img_optming` WHERE optm_status = %d ORDER BY id LIMIT %d";
$_q = $wpdb->prepare($q, array(self::STATUS_NOTIFIED, $imgs_per_req));
$rm_ori_bkup = $this->conf(self::O_IMG_OPTM_RM_BKUP);
$total_pulled_ori = 0;
$total_pulled_webp = 0;
$total_pulled_avif = 0;
$server_list = array();
try {
while ($img_rows = $wpdb->get_results($_q)) {
self::debug('timeout left: ' . ($endts - time()) . 's');
if (function_exists('set_time_limit')) {
$endts += 600;
self::debug('Endtime extended to ' . date('Ymd H:i:s', $endts));
set_time_limit(600); // This will be no more important as we use noabort now
}
// Disabled as we use noabort
// if ($endts - time() < 10) {
// self::debug("π¨ End loop due to timeout limit reached " . $timeoutLimit . "s");
// break;
// }
/**
* Update cron timestamp to avoid duplicated running
* @since 1.6.2
*/
$this->_update_cron_running();
// Run requests in parallel
$requests = array(); // store each request URL for Requests::request_multiple()
$imgs_by_req = array(); // store original request data so that we can reference it in the response
$req_counter = 0;
foreach ($img_rows as $row_img) {
// request original image
$server_info = \json_decode($row_img->server_info, true);
if (!empty($server_info['ori'])) {
$image_url = $server_info['server'] . '/' . $server_info['ori'];
self::debug('Queueing pull: ' . $image_url);
$requests[$req_counter] = array(
'url' => $image_url,
'type' => 'GET',
);
$imgs_by_req[$req_counter++] = array(
'type' => 'ori',
'data' => $row_img,
);
}
// request webp image
$webp_size = 0;
if (!empty($server_info['webp'])) {
$image_url = $server_info['server'] . '/' . $server_info['webp'];
self::debug('Queueing pull WebP: ' . $image_url);
$requests[$req_counter] = array(
'url' => $image_url,
'type' => 'GET',
);
$imgs_by_req[$req_counter++] = array(
'type' => 'webp',
'data' => $row_img,
);
}
// request avif image
$avif_size = 0;
if (!empty($server_info['avif'])) {
$image_url = $server_info['server'] . '/' . $server_info['avif'];
self::debug('Queueing pull AVIF: ' . $image_url);
$requests[$req_counter] = array(
'url' => $image_url,
'type' => 'GET',
);
$imgs_by_req[$req_counter++] = array(
'type' => 'avif',
'data' => $row_img,
);
}
}
self::debug('Loaded images count: ' . $req_counter);
$complete_action = function ($response, $req_count) use ($imgs_by_req, $rm_ori_bkup, &$total_pulled_ori, &$total_pulled_webp, &$total_pulled_avif, &$server_list) {
global $wpdb;
$row_data = isset($imgs_by_req[$req_count]) ? $imgs_by_req[$req_count] : false;
if (false === $row_data) {
self::debug('β failed to pull image: Request not found in lookup variable.');
return;
}
$row_type = isset($row_data['type']) ? $row_data['type'] : 'ori';
$row_img = $row_data['data'];
$local_file = $this->wp_upload_dir['basedir'] . '/' . $row_img->src;
$server_info = \json_decode($row_img->server_info, true);
if (empty($response->success)) {
if (!empty($response->status_code) && 404 == $response->status_code) {
$this->_step_back_image($row_img->id);
$msg = __('Some optimized image file(s) has expired and was cleared.', 'litespeed-cache');
Admin_Display::error($msg);
return;
} else {
// handle error
$image_url = $server_info['server'] . '/' . $server_info[$row_type];
self::debug(
'β failed to pull image (' .
$row_type .
'): ' .
(!empty($response->status_code) ? $response->status_code : '') .
' [Local: ' .
$row_img->src .
'] / [remote: ' .
$image_url .
']'
);
throw new \Exception('Failed to pull image ' . (!empty($response->status_code) ? $response->status_code : '') . ' [url] ' . $image_url);
return;
}
}
// Handle wp_remote_get 404 as its success=true
if (!empty($response->status_code)) {
if ($response->status_code == 404) {
$this->_step_back_image($row_img->id);
$msg = __('Some optimized image file(s) has expired and was cleared.', 'litespeed-cache');
Admin_Display::error($msg);
return;
}
// Note: if there is other error status code found in future, handle here
}
if ('webp' === $row_type) {
file_put_contents($local_file . '.webp', $response->body);
if (!file_exists($local_file . '.webp') || !filesize($local_file . '.webp') || md5_file($local_file . '.webp') !== $server_info['webp_md5']) {
self::debug('β Failed to pull optimized webp img: file md5 mismatch, server md5: ' . $server_info['webp_md5']);
// Delete working table
$q = "DELETE FROM `$this->_table_img_optming` WHERE id = %d ";
$wpdb->query($wpdb->prepare($q, $row_img->id));
$msg = __('Pulled WebP image md5 does not match the notified WebP image md5.', 'litespeed-cache');
Admin_Display::error($msg);
return;
}
self::debug('Pulled optimized img WebP: ' . $local_file . '.webp');
$webp_size = filesize($local_file . '.webp');
/**
* API for WebP
* @since 2.9.5
* @since 3.0 $row_img less elements (see above one)
* @see #751737 - API docs for WEBP generation
*/
do_action('litespeed_img_pull_webp', $row_img, $local_file . '.webp');
$total_pulled_webp++;
} elseif ('avif' === $row_type) {
file_put_contents($local_file . '.avif', $response->body);
if (!file_exists($local_file . '.avif') || !filesize($local_file . '.avif') || md5_file($local_file . '.avif') !== $server_info['avif_md5']) {
self::debug('β Failed to pull optimized avif img: file md5 mismatch, server md5: ' . $server_info['avif_md5']);
// Delete working table
$q = "DELETE FROM `$this->_table_img_optming` WHERE id = %d ";
$wpdb->query($wpdb->prepare($q, $row_img->id));
$msg = __('Pulled AVIF image md5 does not match the notified AVIF image md5.', 'litespeed-cache');
Admin_Display::error($msg);
return;
}
self::debug('Pulled optimized img AVIF: ' . $local_file . '.avif');
$avif_size = filesize($local_file . '.avif');
/**
* API for AVIF
* @since 7.0
*/
do_action('litespeed_img_pull_avif', $row_img, $local_file . '.avif');
$total_pulled_avif++;
} else {
// "ori" image type
file_put_contents($local_file . '.tmp', $response->body);
if (!file_exists($local_file . '.tmp') || !filesize($local_file . '.tmp') || md5_file($local_file . '.tmp') !== $server_info['ori_md5']) {
self::debug(
'β Failed to pull optimized img: file md5 mismatch [url] ' .
$server_info['server'] .
'/' .
$server_info['ori'] .
' [server_md5] ' .
$server_info['ori_md5']
);
// Delete working table
$q = "DELETE FROM `$this->_table_img_optming` WHERE id = %d ";
$wpdb->query($wpdb->prepare($q, $row_img->id));
$msg = __('One or more pulled images does not match with the notified image md5', 'litespeed-cache');
Admin_Display::error($msg);
return;
}
// Backup ori img
if (!$rm_ori_bkup) {
$extension = pathinfo($local_file, PATHINFO_EXTENSION);
$bk_file = substr($local_file, 0, -strlen($extension)) . 'bk.' . $extension;
file_exists($local_file) && rename($local_file, $bk_file);
}
// Replace ori img
rename($local_file . '.tmp', $local_file);
self::debug('Pulled optimized img: ' . $local_file);
/**
* API Hook
* @since 2.9.5
* @since 3.0 $row_img has less elements now. Most useful ones are `post_id`/`src`
*/
do_action('litespeed_img_pull_ori', $row_img, $local_file);
self::debug2('Remove _table_img_optming record [id] ' . $row_img->id);
}
// Delete working table
$q = "DELETE FROM `$this->_table_img_optming` WHERE id = %d ";
$wpdb->query($wpdb->prepare($q, $row_img->id));
// Save server_list to notify taken
if (empty($server_list[$server_info['server']])) {
$server_list[$server_info['server']] = array();
}
$server_info_id = !empty($server_info['file_id']) ? $server_info['file_id'] : $server_info['id'];
$server_list[$server_info['server']][] = $server_info_id;
$total_pulled_ori++;
};
$force_wp_remote_get = defined('LITESPEED_FORCE_WP_REMOTE_GET') && LITESPEED_FORCE_WP_REMOTE_GET;
if (!$force_wp_remote_get && class_exists('\WpOrg\Requests\Requests') && class_exists('\WpOrg\Requests\Autoload') && version_compare(PHP_VERSION, '5.6.0', '>=')) {
// Make sure Requests can load internal classes.
Autoload::register();
// Run pull requests in parallel
Requests::request_multiple($requests, array(
'timeout' => 60,
'connect_timeout' => 60,
'complete' => $complete_action,
));
} else {
foreach ($requests as $cnt => $req) {
$wp_response = wp_safe_remote_get($req['url'], array('timeout' => 60));
$request_response = array(
'success' => false,
'status_code' => 0,
'body' => null,
);
if (is_wp_error($wp_response)) {
$error_message = $wp_response->get_error_message();
self::debug('β failed to pull image: ' . $error_message);
} else {
$request_response['success'] = true;
$request_response['status_code'] = $wp_response['response']['code'];
$request_response['body'] = $wp_response['body'];
}
self::debug('response code [code] ' . $wp_response['response']['code'] . ' [url] ' . $req['url']);
$request_response = (object) $request_response;
$complete_action($request_response, $cnt);
}
}
self::debug('Current batch pull finished');
}
} catch (\Exception $e) {
Admin_Display::error('Image pull process failure: ' . $e->getMessage());
}
// Notify IAPI images taken
foreach ($server_list as $server => $img_list) {
$data = array(
'action' => self::CLOUD_ACTION_TAKEN,
'list' => $img_list,
'server' => $server,
);
// TODO: improve this so we do not call once per server, but just once and then filter on the server side
Cloud::post(Cloud::SVC_IMG_OPTM, $data);
}
if (empty($this->_summary['img_taken'])) {
$this->_summary['img_taken'] = 0;
}
$this->_summary['img_taken'] += $total_pulled_ori + $total_pulled_webp + $total_pulled_avif;
self::save_summary();
// Manually running needs to roll back timestamp for next running
if ($manual) {
$this->_update_cron_running(true);
}
// $msg = sprintf(__('Pulled %d image(s)', 'litespeed-cache'), $total_pulled_ori + $total_pulled_webp);
// Admin_Display::success($msg);
// Check if there is still task in queue
$q = "SELECT * FROM `$this->_table_img_optming` WHERE optm_status = %d LIMIT 1";
$to_be_continued = $wpdb->get_row($wpdb->prepare($q, self::STATUS_NOTIFIED));
if ($to_be_continued) {
self::debug('Task in queue, to be continued...');
return;
// return Router::self_redirect(Router::ACTION_IMG_OPTM, self::TYPE_PULL);
}
// If all pulled, update tag to done
self::debug('Marked pull status to all pulled');
self::update_option(self::DB_NEED_PULL, self::STATUS_PULLED);
}
/**
* Push image back to previous status
*
* @since 3.0
* @access private
*/
private function _step_back_image($id)
{
global $wpdb;
self::debug('Push image back to new status [id] ' . $id);
// Reset the image to gathered status
$q = "UPDATE `$this->_table_img_optming` SET optm_status = %d WHERE id = %d ";
$wpdb->query($wpdb->prepare($q, array(self::STATUS_RAW, $id)));
}
/**
* Parse wp's meta value
*
* @since 1.6.7
* @access private
*/
private function _parse_wp_meta_value($v)
{
if (empty($v)) {
self::debug('bypassed parsing meta due to null value');
return false;
}
if (!$v->meta_value) {
self::debug('bypassed parsing meta due to no meta_value: pid ' . $v->post_id);
return false;
}
$meta_value = @maybe_unserialize($v->meta_value);
if (!is_array($meta_value)) {
self::debug('bypassed parsing meta due to meta_value not json: pid ' . $v->post_id);
return false;
}
if (empty($meta_value['file'])) {
self::debug('bypassed parsing meta due to no ori file: pid ' . $v->post_id);
return false;
}
return $meta_value;
}
/**
* Clean up all unfinished queue locally and to Cloud server
*
* @since 2.1.2
* @access public
*/
public function clean()
{
global $wpdb;
// Reset img_optm table's queue
if ($this->__data->tb_exist('img_optming')) {
// Get min post id to mark
$q = "SELECT MIN(post_id) FROM `$this->_table_img_optming`";
$min_pid = $wpdb->get_var($q) - 1;
if ($this->_summary['next_post_id'] > $min_pid) {
$this->_summary['next_post_id'] = $min_pid;
self::save_summary();
}
$q = "DELETE FROM `$this->_table_img_optming`";
$wpdb->query($q);
}
$msg = __('Cleaned up unfinished data successfully.', 'litespeed-cache');
Admin_Display::success($msg);
}
/**
* Reset image counter
*
* @since 7.0
* @access private
*/
private function _reset_counter()
{
self::debug('reset image optm counter');
$this->_summary['next_post_id'] = 0;
self::save_summary();
$this->clean();
$msg = __('Reset image optimization counter successfully.', 'litespeed-cache');
Admin_Display::success($msg);
}
/**
* Destroy all optimized images
*
* @since 3.0
* @access private
*/
private function _destroy()
{
global $wpdb;
self::debug('executing DESTROY process');
$offset = !empty($_GET['litespeed_i']) ? $_GET['litespeed_i'] : 0;
/**
* Limit images each time before redirection to fix Out of memory issue. #665465
* @since 2.9.8
*/
// Start deleting files
$limit = apply_filters('litespeed_imgoptm_destroy_max_rows', 500);
$img_q = "SELECT b.post_id, b.meta_value
FROM `$wpdb->posts` a
LEFT JOIN `$wpdb->postmeta` b ON b.post_id = a.ID
WHERE b.meta_key = '_wp_attachment_metadata'
AND a.post_type = 'attachment'
AND a.post_status = 'inherit'
AND a.post_mime_type IN ('image/jpeg', 'image/png', 'image/gif')
ORDER BY a.ID
LIMIT %d,%d
";
$q = $wpdb->prepare($img_q, array($offset * $limit, $limit));
$list = $wpdb->get_results($q);
$i = 0;
foreach ($list as $v) {
if (!$v->post_id) {
continue;
}
$meta_value = $this->_parse_wp_meta_value($v);
if (!$meta_value) {
continue;
}
$i++;
$this->tmp_pid = $v->post_id;
$this->tmp_path = pathinfo($meta_value['file'], PATHINFO_DIRNAME) . '/';
$this->_destroy_optm_file($meta_value, true);
if (!empty($meta_value['sizes'])) {
array_map(array($this, '_destroy_optm_file'), $meta_value['sizes']);
}
}
self::debug('batch switched images total: ' . $i);
$offset++;
$to_be_continued = $wpdb->get_row($wpdb->prepare($img_q, array($offset * $limit, 1)));
if ($to_be_continued) {
# Check if post_id is beyond next_post_id
self::debug('[next_post_id] ' . $this->_summary['next_post_id'] . ' [cursor post id] ' . $to_be_continued->post_id);
if ($to_be_continued->post_id <= $this->_summary['next_post_id']) {
self::debug('redirecting to next');
return Router::self_redirect(Router::ACTION_IMG_OPTM, self::TYPE_DESTROY);
}
self::debug('π Finished destroying');
}
// Delete postmeta info
$q = "DELETE FROM `$wpdb->postmeta` WHERE meta_key = %s";
$wpdb->query($wpdb->prepare($q, self::DB_SIZE));
$wpdb->query($wpdb->prepare($q, self::DB_SET));
// Delete img_optm table
$this->__data->tb_del('img_optm');
$this->__data->tb_del('img_optming');
// Clear options table summary info
self::delete_option('_summary');
self::delete_option(self::DB_NEED_PULL);
$msg = __('Destroy all optimization data successfully.', 'litespeed-cache');
Admin_Display::success($msg);
}
/**
* Destroy optm file
*/
private function _destroy_optm_file($meta_value, $is_ori_file = false)
{
$short_file_path = $meta_value['file'];
if (!$is_ori_file) {
$short_file_path = $this->tmp_path . $short_file_path;
}
self::debug('deleting ' . $short_file_path);
// del webp
$this->__media->info($short_file_path . '.webp', $this->tmp_pid) && $this->__media->del($short_file_path . '.webp', $this->tmp_pid);
$this->__media->info($short_file_path . '.optm.webp', $this->tmp_pid) && $this->__media->del($short_file_path . '.optm.webp', $this->tmp_pid);
// del avif
$this->__media->info($short_file_path . '.avif', $this->tmp_pid) && $this->__media->del($short_file_path . '.avif', $this->tmp_pid);
$this->__media->info($short_file_path . '.optm.avif', $this->tmp_pid) && $this->__media->del($short_file_path . '.optm.avif', $this->tmp_pid);
$extension = pathinfo($short_file_path, PATHINFO_EXTENSION);
$local_filename = substr($short_file_path, 0, -strlen($extension) - 1);
$bk_file = $local_filename . '.bk.' . $extension;
$bk_optm_file = $local_filename . '.bk.optm.' . $extension;
// del optimized ori
if ($this->__media->info($bk_file, $this->tmp_pid)) {
self::debug('deleting optim ori');
$this->__media->del($short_file_path, $this->tmp_pid);
$this->__media->rename($bk_file, $short_file_path, $this->tmp_pid);
}
$this->__media->info($bk_optm_file, $this->tmp_pid) && $this->__media->del($bk_optm_file, $this->tmp_pid);
}
/**
* Rescan to find new generated images
*
* @since 1.6.7
* @access private
*/
private function _rescan()
{
global $wpdb;
exit('tobedone');
$offset = !empty($_GET['litespeed_i']) ? $_GET['litespeed_i'] : 0;
$limit = 500;
self::debug('rescan images');
// Get images
$q = "SELECT b.post_id, b.meta_value
FROM `$wpdb->posts` a, `$wpdb->postmeta` b
WHERE a.post_type = 'attachment'
AND a.post_status = 'inherit'
AND a.post_mime_type IN ('image/jpeg', 'image/png', 'image/gif')
AND a.ID = b.post_id
AND b.meta_key = '_wp_attachment_metadata'
ORDER BY a.ID
LIMIT %d, %d
";
$list = $wpdb->get_results($wpdb->prepare($q, $offset * $limit, $limit + 1)); // last one is the seed for next batch
if (!$list) {
$msg = __('Rescanned successfully.', 'litespeed-cache');
Admin_Display::success($msg);
self::debug('rescan bypass: no gathered image found');
return;
}
if (count($list) == $limit + 1) {
$to_be_continued = true;
array_pop($list); // last one is the seed for next round, discard here.
} else {
$to_be_continued = false;
}
// Prepare post_ids to inquery gathered images
$pid_set = array();
$scanned_list = array();
foreach ($list as $v) {
$meta_value = $this->_parse_wp_meta_value($v);
if (!$meta_value) {
continue;
}
$scanned_list[] = array(
'pid' => $v->post_id,
'meta' => $meta_value,
);
$pid_set[] = $v->post_id;
}
// Build gathered images
$q = "SELECT src, post_id FROM `$this->_table_img_optm` WHERE post_id IN (" . implode(',', array_fill(0, count($pid_set), '%d')) . ')';
$list = $wpdb->get_results($wpdb->prepare($q, $pid_set));
foreach ($list as $v) {
$this->_existed_src_list[] = $v->post_id . '.' . $v->src;
}
// Find new images
foreach ($scanned_list as $v) {
$meta_value = $v['meta'];
// Parse all child src and put them into $this->_img_in_queue, missing ones to $this->_img_in_queue_missed
$this->tmp_pid = $v['pid'];
$this->tmp_path = pathinfo($meta_value['file'], PATHINFO_DIRNAME) . '/';
$this->_append_img_queue($meta_value, true);
if (!empty($meta_value['sizes'])) {
array_map(array($this, '_append_img_queue'), $meta_value['sizes']);
}
}
self::debug('rescanned [img] ' . count($this->_img_in_queue));
$count = count($this->_img_in_queue);
if ($count > 0) {
// Save to DB
$this->_save_raw();
}
if ($to_be_continued) {
return Router::self_redirect(Router::ACTION_IMG_OPTM, self::TYPE_RESCAN);
}
$msg = $count ? sprintf(__('Rescanned %d images successfully.', 'litespeed-cache'), $count) : __('Rescanned successfully.', 'litespeed-cache');
Admin_Display::success($msg);
}
/**
* Calculate bkup original images storage
*
* @since 2.2.6
* @access private
*/
private function _calc_bkup()
{
global $wpdb;
$offset = !empty($_GET['litespeed_i']) ? $_GET['litespeed_i'] : 0;
$limit = 500;
if (!$offset) {
$this->_summary['bk_summary'] = array(
'date' => time(),
'count' => 0,
'sum' => 0,
);
}
$img_q = "SELECT b.post_id, b.meta_value
FROM `$wpdb->posts` a
LEFT JOIN `$wpdb->postmeta` b ON b.post_id = a.ID
WHERE b.meta_key = '_wp_attachment_metadata'
AND a.post_type = 'attachment'
AND a.post_status = 'inherit'
AND a.post_mime_type IN ('image/jpeg', 'image/png', 'image/gif')
ORDER BY a.ID
LIMIT %d,%d
";
$q = $wpdb->prepare($img_q, array($offset * $limit, $limit));
$list = $wpdb->get_results($q);
foreach ($list as $v) {
if (!$v->post_id) {
continue;
}
$meta_value = $this->_parse_wp_meta_value($v);
if (!$meta_value) {
continue;
}
$this->tmp_pid = $v->post_id;
$this->tmp_path = pathinfo($meta_value['file'], PATHINFO_DIRNAME) . '/';
$this->_get_bk_size($meta_value, true);
if (!empty($meta_value['sizes'])) {
array_map(array($this, '_get_bk_size'), $meta_value['sizes']);
}
}
$this->_summary['bk_summary']['date'] = time();
self::save_summary();
self::debug('_calc_bkup total: ' . $this->_summary['bk_summary']['count'] . ' [size] ' . $this->_summary['bk_summary']['sum']);
$offset++;
$to_be_continued = $wpdb->get_row($wpdb->prepare($img_q, array($offset * $limit, 1)));
if ($to_be_continued) {
return Router::self_redirect(Router::ACTION_IMG_OPTM, self::TYPE_CALC_BKUP);
}
$msg = __('Calculated backups successfully.', 'litespeed-cache');
Admin_Display::success($msg);
}
/**
* Calculate single size
*/
private function _get_bk_size($meta_value, $is_ori_file = false)
{
$short_file_path = $meta_value['file'];
if (!$is_ori_file) {
$short_file_path = $this->tmp_path . $short_file_path;
}
$extension = pathinfo($short_file_path, PATHINFO_EXTENSION);
$local_filename = substr($short_file_path, 0, -strlen($extension) - 1);
$bk_file = $local_filename . '.bk.' . $extension;
$img_info = $this->__media->info($bk_file, $this->tmp_pid);
if (!$img_info) {
return;
}
$this->_summary['bk_summary']['count']++;
$this->_summary['bk_summary']['sum'] += $img_info['size'];
}
/**
* Delete bkup original images storage
*
* @since 2.5
* @access public
*/
public function rm_bkup()
{
global $wpdb;
if (!$this->__data->tb_exist('img_optming')) {
return;
}
$offset = !empty($_GET['litespeed_i']) ? $_GET['litespeed_i'] : 0;
$limit = 500;
if (empty($this->_summary['rmbk_summary'])) {
$this->_summary['rmbk_summary'] = array(
'date' => time(),
'count' => 0,
'sum' => 0,
);
}
$img_q = "SELECT b.post_id, b.meta_value
FROM `$wpdb->posts` a
LEFT JOIN `$wpdb->postmeta` b ON b.post_id = a.ID
WHERE b.meta_key = '_wp_attachment_metadata'
AND a.post_type = 'attachment'
AND a.post_status = 'inherit'
AND a.post_mime_type IN ('image/jpeg', 'image/png', 'image/gif')
ORDER BY a.ID
LIMIT %d,%d
";
$q = $wpdb->prepare($img_q, array($offset * $limit, $limit));
$list = $wpdb->get_results($q);
foreach ($list as $v) {
if (!$v->post_id) {
continue;
}
$meta_value = $this->_parse_wp_meta_value($v);
if (!$meta_value) {
continue;
}
$this->tmp_pid = $v->post_id;
$this->tmp_path = pathinfo($meta_value['file'], PATHINFO_DIRNAME) . '/';
$this->_del_bk_file($meta_value, true);
if (!empty($meta_value['sizes'])) {
array_map(array($this, '_del_bk_file'), $meta_value['sizes']);
}
}
$this->_summary['rmbk_summary']['date'] = time();
self::save_summary();
self::debug('rm_bkup total: ' . $this->_summary['rmbk_summary']['count'] . ' [size] ' . $this->_summary['rmbk_summary']['sum']);
$offset++;
$to_be_continued = $wpdb->get_row($wpdb->prepare($img_q, array($offset * $limit, 1)));
if ($to_be_continued) {
return Router::self_redirect(Router::ACTION_IMG_OPTM, self::TYPE_RM_BKUP);
}
$msg = __('Removed backups successfully.', 'litespeed-cache');
Admin_Display::success($msg);
}
/**
* Delete single file
*/
private function _del_bk_file($meta_value, $is_ori_file = false)
{
$short_file_path = $meta_value['file'];
if (!$is_ori_file) {
$short_file_path = $this->tmp_path . $short_file_path;
}
$extension = pathinfo($short_file_path, PATHINFO_EXTENSION);
$local_filename = substr($short_file_path, 0, -strlen($extension) - 1);
$bk_file = $local_filename . '.bk.' . $extension;
$img_info = $this->__media->info($bk_file, $this->tmp_pid);
if (!$img_info) {
return;
}
$this->_summary['rmbk_summary']['count']++;
$this->_summary['rmbk_summary']['sum'] += $img_info['size'];
$this->__media->del($bk_file, $this->tmp_pid);
}
/**
* Count images
*
* @since 1.6
* @access public
*/
public function img_count()
{
global $wpdb;
$q = "SELECT count(*)
FROM `$wpdb->posts` a
LEFT JOIN `$wpdb->postmeta` b ON b.post_id = a.ID
WHERE b.meta_key = '_wp_attachment_metadata'
AND a.post_type = 'attachment'
AND a.post_status = 'inherit'
AND a.post_mime_type IN ('image/jpeg', 'image/png', 'image/gif')
";
$groups_all = $wpdb->get_var($q);
$groups_new = $wpdb->get_var($q . ' AND ID>' . (int) $this->_summary['next_post_id'] . ' ORDER BY ID');
$groups_done = $wpdb->get_var($q . ' AND ID<=' . (int) $this->_summary['next_post_id'] . ' ORDER BY ID');
$q = "SELECT b.post_id
FROM `$wpdb->posts` a
LEFT JOIN `$wpdb->postmeta` b ON b.post_id = a.ID
WHERE b.meta_key = '_wp_attachment_metadata'
AND a.post_type = 'attachment'
AND a.post_status = 'inherit'
AND a.post_mime_type IN ('image/jpeg', 'image/png', 'image/gif')
ORDER BY a.ID DESC
LIMIT 1
";
$max_id = $wpdb->get_var($q);
$count_list = array(
'max_id' => $max_id,
'groups_all' => $groups_all,
'groups_new' => $groups_new,
'groups_done' => $groups_done,
);
// images count from work table
if ($this->__data->tb_exist('img_optming')) {
$q = "SELECT COUNT(DISTINCT post_id),COUNT(*) FROM `$this->_table_img_optming` WHERE optm_status = %d";
$groups_to_check = array(self::STATUS_RAW, self::STATUS_REQUESTED, self::STATUS_NOTIFIED, self::STATUS_ERR_FETCH);
foreach ($groups_to_check as $v) {
$count_list['img.' . $v] = $count_list['group.' . $v] = 0;
list($count_list['group.' . $v], $count_list['img.' . $v]) = $wpdb->get_row($wpdb->prepare($q, $v), ARRAY_N);
}
}
return $count_list;
}
/**
* Check if fetch cron is running
*
* @since 1.6.2
* @access public
*/
public function cron_running($bool_res = true)
{
$last_run = !empty($this->_summary['last_pull']) ? $this->_summary['last_pull'] : 0;
$is_running = $last_run && time() - $last_run < 120;
if ($bool_res) {
return $is_running;
}
return array($last_run, $is_running);
}
/**
* Update fetch cron timestamp tag
*
* @since 1.6.2
* @access private
*/
private function _update_cron_running($done = false)
{
$this->_summary['last_pull'] = time();
if ($done) {
// Only update cron tag when its from the active running cron
if ($this->_cron_ran) {
// Rollback for next running
$this->_summary['last_pull'] -= 120;
} else {
return;
}
}
self::save_summary();
$this->_cron_ran = true;
}
/**
* Batch switch images to ori/optm version
*
* @since 1.6.2
* @access public
*/
public function batch_switch($type)
{
global $wpdb;
if (defined('LITESPEED_CLI') || defined('DOING_CRON')) {
$offset = 0;
while ($offset !== 'done') {
Admin_Display::info("Starting switch to $type [offset] $offset");
$offset = $this->_batch_switch($type, $offset);
}
} else {
$offset = !empty($_GET['litespeed_i']) ? $_GET['litespeed_i'] : 0;
$newOffset = $this->_batch_switch($type, $offset);
if ($newOffset !== 'done') {
return Router::self_redirect(Router::ACTION_IMG_OPTM, $type);
}
}
$msg = __('Switched images successfully.', 'litespeed-cache');
Admin_Display::success($msg);
}
/**
* Switch images per offset
*/
private function _batch_switch($type, $offset)
{
global $wpdb;
$limit = 500;
$this->tmp_type = $type;
$img_q = "SELECT b.post_id, b.meta_value
FROM `$wpdb->posts` a
LEFT JOIN `$wpdb->postmeta` b ON b.post_id = a.ID
WHERE b.meta_key = '_wp_attachment_metadata'
AND a.post_type = 'attachment'
AND a.post_status = 'inherit'
AND a.post_mime_type IN ('image/jpeg', 'image/png', 'image/gif')
ORDER BY a.ID
LIMIT %d,%d
";
$q = $wpdb->prepare($img_q, array($offset * $limit, $limit));
$list = $wpdb->get_results($q);
$i = 0;
foreach ($list as $v) {
if (!$v->post_id) {
continue;
}
$meta_value = $this->_parse_wp_meta_value($v);
if (!$meta_value) {
continue;
}
$i++;
$this->tmp_pid = $v->post_id;
$this->tmp_path = pathinfo($meta_value['file'], PATHINFO_DIRNAME) . '/';
$this->_switch_bk_file($meta_value, true);
if (!empty($meta_value['sizes'])) {
array_map(array($this, '_switch_bk_file'), $meta_value['sizes']);
}
}
self::debug('batch switched images total: ' . $i . ' [type] ' . $type);
$offset++;
$to_be_continued = $wpdb->get_row($wpdb->prepare($img_q, array($offset * $limit, 1)));
if ($to_be_continued) {
return $offset;
}
return 'done';
}
/**
* Delete single file
*/
private function _switch_bk_file($meta_value, $is_ori_file = false)
{
$short_file_path = $meta_value['file'];
if (!$is_ori_file) {
$short_file_path = $this->tmp_path . $short_file_path;
}
$extension = pathinfo($short_file_path, PATHINFO_EXTENSION);
$local_filename = substr($short_file_path, 0, -strlen($extension) - 1);
$bk_file = $local_filename . '.bk.' . $extension;
$bk_optm_file = $local_filename . '.bk.optm.' . $extension;
// self::debug('_switch_bk_file ' . $bk_file . ' [type] ' . $this->tmp_type);
// switch to ori
if ($this->tmp_type === self::TYPE_BATCH_SWITCH_ORI || $this->tmp_type == 'orig') {
// self::debug('switch to orig ' . $bk_file);
if (!$this->__media->info($bk_file, $this->tmp_pid)) {
return;
}
$this->__media->rename($local_filename . '.' . $extension, $bk_optm_file, $this->tmp_pid);
$this->__media->rename($bk_file, $local_filename . '.' . $extension, $this->tmp_pid);
}
// switch to optm
elseif ($this->tmp_type === self::TYPE_BATCH_SWITCH_OPTM || $this->tmp_type == 'optm') {
// self::debug('switch to optm ' . $bk_file);
if (!$this->__media->info($bk_optm_file, $this->tmp_pid)) {
return;
}
$this->__media->rename($local_filename . '.' . $extension, $bk_file, $this->tmp_pid);
$this->__media->rename($bk_optm_file, $local_filename . '.' . $extension, $this->tmp_pid);
}
}
/**
* Switch image between original one and optimized one
*
* @since 1.6.2
* @access private
*/
private function _switch_optm_file($type)
{
Admin_Display::success(__('Switched to optimized file successfully.', 'litespeed-cache'));
return;
global $wpdb;
$pid = substr($type, 4);
$switch_type = substr($type, 0, 4);
$q = "SELECT src,post_id FROM `$this->_table_img_optm` WHERE post_id = %d AND optm_status = %d";
$list = $wpdb->get_results($wpdb->prepare($q, array($pid, self::STATUS_PULLED)));
$msg = 'Unknown Msg';
foreach ($list as $v) {
// to switch webp file
if ($switch_type === 'webp') {
if ($this->__media->info($v->src . '.webp', $v->post_id)) {
$this->__media->rename($v->src . '.webp', $v->src . '.optm.webp', $v->post_id);
self::debug('Disabled WebP: ' . $v->src);
$msg = __('Disabled WebP file successfully.', 'litespeed-cache');
} elseif ($this->__media->info($v->src . '.optm.webp', $v->post_id)) {
$this->__media->rename($v->src . '.optm.webp', $v->src . '.webp', $v->post_id);
self::debug('Enable WebP: ' . $v->src);
$msg = __('Enabled WebP file successfully.', 'litespeed-cache');
}
}
// to switch avif file
elseif ($switch_type === 'avif') {
if ($this->__media->info($v->src . '.avif', $v->post_id)) {
$this->__media->rename($v->src . '.avif', $v->src . '.optm.avif', $v->post_id);
self::debug('Disabled AVIF: ' . $v->src);
$msg = __('Disabled AVIF file successfully.', 'litespeed-cache');
} elseif ($this->__media->info($v->src . '.optm.avif', $v->post_id)) {
$this->__media->rename($v->src . '.optm.avif', $v->src . '.avif', $v->post_id);
self::debug('Enable AVIF: ' . $v->src);
$msg = __('Enabled AVIF file successfully.', 'litespeed-cache');
}
}
// to switch original file
else {
$extension = pathinfo($v->src, PATHINFO_EXTENSION);
$local_filename = substr($v->src, 0, -strlen($extension) - 1);
$bk_file = $local_filename . '.bk.' . $extension;
$bk_optm_file = $local_filename . '.bk.optm.' . $extension;
// revert ori back
if ($this->__media->info($bk_file, $v->post_id)) {
$this->__media->rename($v->src, $bk_optm_file, $v->post_id);
$this->__media->rename($bk_file, $v->src, $v->post_id);
self::debug('Restore original img: ' . $bk_file);
$msg = __('Restored original file successfully.', 'litespeed-cache');
} elseif ($this->__media->info($bk_optm_file, $v->post_id)) {
$this->__media->rename($v->src, $bk_file, $v->post_id);
$this->__media->rename($bk_optm_file, $v->src, $v->post_id);
self::debug('Switch to optm img: ' . $v->src);
$msg = __('Switched to optimized file successfully.', 'litespeed-cache');
}
}
}
Admin_Display::success($msg);
}
/**
* Delete one optm data and recover original file
*
* @since 2.4.2
* @access public
*/
public function reset_row($post_id)
{
global $wpdb;
if (!$post_id) {
return;
}
// Gathered image don't have DB_SIZE info yet
// $size_meta = get_post_meta( $post_id, self::DB_SIZE, true );
// if ( ! $size_meta ) {
// return;
// }
self::debug('_reset_row [pid] ' . $post_id);
# TODO: Load image sub files
$img_q = "SELECT b.post_id, b.meta_value
FROM `$wpdb->postmeta` b
WHERE b.post_id =%d AND b.meta_key = '_wp_attachment_metadata'";
$q = $wpdb->prepare($img_q, array($post_id));
$v = $wpdb->get_row($q);
$meta_value = $this->_parse_wp_meta_value($v);
if ($meta_value) {
$this->tmp_pid = $v->post_id;
$this->tmp_path = pathinfo($meta_value['file'], PATHINFO_DIRNAME) . '/';
$this->_destroy_optm_file($meta_value, true);
if (!empty($meta_value['sizes'])) {
array_map(array($this, '_destroy_optm_file'), $meta_value['sizes']);
}
}
delete_post_meta($post_id, self::DB_SIZE);
delete_post_meta($post_id, self::DB_SET);
$msg = __('Reset the optimized data successfully.', 'litespeed-cache');
Admin_Display::success($msg);
}
/**
* Show an image's optm status
*
* @since 1.6.5
* @access public
*/
public function check_img()
{
global $wpdb;
$pid = $_POST['data'];
self::debug('Check image [ID] ' . $pid);
$data = array();
$data['img_count'] = $this->img_count();
$data['optm_summary'] = self::get_summary();
$data['_wp_attached_file'] = get_post_meta($pid, '_wp_attached_file', true);
$data['_wp_attachment_metadata'] = get_post_meta($pid, '_wp_attachment_metadata', true);
// Get img_optm data
$q = "SELECT * FROM `$this->_table_img_optm` WHERE post_id = %d";
$list = $wpdb->get_results($wpdb->prepare($q, $pid));
$img_data = array();
if ($list) {
foreach ($list as $v) {
$img_data[] = array(
'id' => $v->id,
'optm_status' => $v->optm_status,
'src' => $v->src,
'srcpath_md5' => $v->srcpath_md5,
'src_md5' => $v->src_md5,
'server_info' => $v->server_info,
);
}
}
$data['img_data'] = $img_data;
return array('_res' => 'ok', 'data' => $data);
}
/**
* Handle all request actions from main cls
*
* @since 2.0
* @access public
*/
public function handler()
{
$type = Router::verify_type();
switch ($type) {
case self::TYPE_RESET_ROW:
$this->reset_row(!empty($_GET['id']) ? $_GET['id'] : false);
break;
case self::TYPE_CALC_BKUP:
$this->_calc_bkup();
break;
case self::TYPE_RM_BKUP:
$this->rm_bkup();
break;
case self::TYPE_NEW_REQ:
$this->new_req();
break;
case self::TYPE_RESCAN:
$this->_rescan();
break;
case self::TYPE_RESET_COUNTER:
$this->_reset_counter();
break;
case self::TYPE_DESTROY:
$this->_destroy();
break;
case self::TYPE_CLEAN:
$this->clean();
break;
case self::TYPE_PULL:
self::start_async();
break;
case self::TYPE_BATCH_SWITCH_ORI:
case self::TYPE_BATCH_SWITCH_OPTM:
$this->batch_switch($type);
break;
case substr($type, 0, 4) === 'avif':
case substr($type, 0, 4) === 'webp':
case substr($type, 0, 4) === 'orig':
$this->_switch_optm_file($type);
break;
default:
break;
}
Admin::redirect();
}
}
src/admin-display.cls.php 0000644 00000106620 15246276230 0011373 0 ustar 00
*/
namespace LiteSpeed;
defined('WPINC') || exit();
class Admin_Display extends Base
{
const LOG_TAG = 'πββοΈ';
const NOTICE_BLUE = 'notice notice-info';
const NOTICE_GREEN = 'notice notice-success';
const NOTICE_RED = 'notice notice-error';
const NOTICE_YELLOW = 'notice notice-warning';
const DB_MSG = 'messages';
const DB_MSG_PIN = 'msg_pin';
const PURGEBY_CAT = '0';
const PURGEBY_PID = '1';
const PURGEBY_TAG = '2';
const PURGEBY_URL = '3';
const PURGEBYOPT_SELECT = 'purgeby';
const PURGEBYOPT_LIST = 'purgebylist';
const DB_DISMISS_MSG = 'dismiss';
const RULECONFLICT_ON = 'ExpiresDefault_1';
const RULECONFLICT_DISMISSED = 'ExpiresDefault_0';
const TYPE_QC_HIDE_BANNER = 'qc_hide_banner';
const COOKIE_QC_HIDE_BANNER = 'litespeed_qc_hide_banner';
protected $messages = array();
protected $default_settings = array();
protected $_is_network_admin = false;
protected $_is_multisite = false;
private $_btn_i = 0;
/**
* Initialize the class and set its properties.
*
* @since 1.0.7
*/
public function __construct()
{
// main css
add_action('admin_enqueue_scripts', array($this, 'enqueue_style'));
// Main js
add_action('admin_enqueue_scripts', array($this, 'enqueue_scripts'));
$this->_is_network_admin = is_network_admin();
$this->_is_multisite = is_multisite();
// Quick access menu
if (is_multisite() && $this->_is_network_admin) {
$manage = 'manage_network_options';
} else {
$manage = 'manage_options';
}
if (current_user_can($manage)) {
if (!defined('LITESPEED_DISABLE_ALL') || !LITESPEED_DISABLE_ALL) {
add_action('wp_before_admin_bar_render', array(GUI::cls(), 'backend_shortcut'));
}
// `admin_notices` is after `admin_enqueue_scripts`
// @see wp-admin/admin-header.php
add_action($this->_is_network_admin ? 'network_admin_notices' : 'admin_notices', array($this, 'display_messages'));
}
/**
* In case this is called outside the admin page
* @see https://codex.wordpress.org/Function_Reference/is_plugin_active_for_network
* @since 2.0
*/
if (!function_exists('is_plugin_active_for_network')) {
require_once ABSPATH . '/wp-admin/includes/plugin.php';
}
// add menus ( Also check for mu-plugins)
if ($this->_is_network_admin && (is_plugin_active_for_network(LSCWP_BASENAME) || defined('LSCWP_MU_PLUGIN'))) {
add_action('network_admin_menu', array($this, 'register_admin_menu'));
} else {
add_action('admin_menu', array($this, 'register_admin_menu'));
}
$this->cls('Metabox')->register_settings();
}
/**
* Show the title of one line
*
* @since 3.0
* @access public
*/
public function title($id)
{
echo Lang::title($id);
}
/**
* Register the admin menu display.
*
* @since 1.0.0
* @access public
*/
public function register_admin_menu()
{
$capability = $this->_is_network_admin ? 'manage_network_options' : 'manage_options';
if (current_user_can($capability)) {
// root menu
add_menu_page('LiteSpeed Cache', 'LiteSpeed Cache', 'manage_options', 'litespeed');
// sub menus
$this->_add_submenu(__('Dashboard', 'litespeed-cache'), 'litespeed', 'show_menu_dash');
!$this->_is_network_admin && $this->_add_submenu(__('Presets', 'litespeed-cache'), 'litespeed-presets', 'show_menu_presets');
$this->_add_submenu(__('General', 'litespeed-cache'), 'litespeed-general', 'show_menu_general');
$this->_add_submenu(__('Cache', 'litespeed-cache'), 'litespeed-cache', 'show_menu_cache');
!$this->_is_network_admin && $this->_add_submenu(__('CDN', 'litespeed-cache'), 'litespeed-cdn', 'show_menu_cdn');
$this->_add_submenu(__('Image Optimization', 'litespeed-cache'), 'litespeed-img_optm', 'show_img_optm');
!$this->_is_network_admin && $this->_add_submenu(__('Page Optimization', 'litespeed-cache'), 'litespeed-page_optm', 'show_page_optm');
$this->_add_submenu(__('Database', 'litespeed-cache'), 'litespeed-db_optm', 'show_db_optm');
!$this->_is_network_admin && $this->_add_submenu(__('Crawler', 'litespeed-cache'), 'litespeed-crawler', 'show_crawler');
$this->_add_submenu(__('Toolbox', 'litespeed-cache'), 'litespeed-toolbox', 'show_toolbox');
// sub menus under options
add_options_page('LiteSpeed Cache', 'LiteSpeed Cache', $capability, 'litespeed-cache-options', array($this, 'show_menu_cache'));
}
}
/**
* Helper function to set up a submenu page.
*
* @since 1.0.4
* @access private
* @param string $menu_title The title that appears on the menu.
* @param string $menu_slug The slug of the page.
* @param string $callback The callback to call if selected.
*/
private function _add_submenu($menu_title, $menu_slug, $callback)
{
add_submenu_page('litespeed', $menu_title, $menu_title, 'manage_options', $menu_slug, array($this, $callback));
}
/**
* Register the stylesheets for the admin area.
*
* @since 1.0.14
* @access public
*/
public function enqueue_style()
{
wp_enqueue_style(Core::PLUGIN_NAME, LSWCP_PLUGIN_URL . 'assets/css/litespeed.css', array(), Core::VER, 'all');
}
/**
* Register the JavaScript for the admin area.
*
* @since 1.0.0
* @access public
*/
public function enqueue_scripts()
{
wp_register_script(Core::PLUGIN_NAME, LSWCP_PLUGIN_URL . 'assets/js/litespeed-cache-admin.js', array(), Core::VER, false);
$localize_data = array();
if (GUI::has_whm_msg()) {
$ajax_url_dismiss_whm = Utility::build_url(Core::ACTION_DISMISS, GUI::TYPE_DISMISS_WHM, true);
$localize_data['ajax_url_dismiss_whm'] = $ajax_url_dismiss_whm;
}
if (GUI::has_msg_ruleconflict()) {
$ajax_url = Utility::build_url(Core::ACTION_DISMISS, GUI::TYPE_DISMISS_EXPIRESDEFAULT, true);
$localize_data['ajax_url_dismiss_ruleconflict'] = $ajax_url;
}
$promo_tag = GUI::cls()->show_promo(true);
if ($promo_tag) {
$ajax_url_promo = Utility::build_url(Core::ACTION_DISMISS, GUI::TYPE_DISMISS_PROMO, true, null, array('promo_tag' => $promo_tag));
$localize_data['ajax_url_promo'] = $ajax_url_promo;
}
// Injection to LiteSpeed pages
global $pagenow;
if ($pagenow == 'admin.php' && !empty($_GET['page']) && (strpos($_GET['page'], 'litespeed-') === 0 || $_GET['page'] == 'litespeed')) {
// Admin footer
add_filter('admin_footer_text', array($this, 'admin_footer_text'), 1);
if ($_GET['page'] == 'litespeed-crawler' || $_GET['page'] == 'litespeed-cdn') {
// Babel JS type correction
add_filter('script_loader_tag', array($this, 'babel_type'), 10, 3);
wp_enqueue_script(Core::PLUGIN_NAME . '-lib-react', LSWCP_PLUGIN_URL . 'assets/js/react.min.js', array(), Core::VER, false);
wp_enqueue_script(Core::PLUGIN_NAME . '-lib-babel', LSWCP_PLUGIN_URL . 'assets/js/babel.min.js', array(), Core::VER, false);
}
// Crawler Cookie Simulation
if ($_GET['page'] == 'litespeed-crawler') {
wp_enqueue_script(Core::PLUGIN_NAME . '-crawler', LSWCP_PLUGIN_URL . 'assets/js/component.crawler.js', array(), Core::VER, false);
$localize_data['lang'] = array();
$localize_data['lang']['cookie_name'] = __('Cookie Name', 'litespeed-cache');
$localize_data['lang']['cookie_value'] = __('Cookie Values', 'litespeed-cache');
$localize_data['lang']['one_per_line'] = Doc::one_per_line(true);
$localize_data['lang']['remove_cookie_simulation'] = __('Remove cookie simulation', 'litespeed-cache');
$localize_data['lang']['add_cookie_simulation_row'] = __('Add new cookie to simulate', 'litespeed-cache');
empty($localize_data['ids']) && ($localize_data['ids'] = array());
$localize_data['ids']['crawler_cookies'] = self::O_CRAWLER_COOKIES;
}
// CDN mapping
if ($_GET['page'] == 'litespeed-cdn') {
$home_url = home_url('/');
$parsed = parse_url($home_url);
$home_url = str_replace($parsed['scheme'] . ':', '', $home_url);
$cdn_url = 'https://cdn.' . substr($home_url, 2);
wp_enqueue_script(Core::PLUGIN_NAME . '-cdn', LSWCP_PLUGIN_URL . 'assets/js/component.cdn.js', array(), Core::VER, false);
$localize_data['lang'] = array();
$localize_data['lang']['cdn_mapping_url'] = Lang::title(self::CDN_MAPPING_URL);
$localize_data['lang']['cdn_mapping_inc_img'] = Lang::title(self::CDN_MAPPING_INC_IMG);
$localize_data['lang']['cdn_mapping_inc_css'] = Lang::title(self::CDN_MAPPING_INC_CSS);
$localize_data['lang']['cdn_mapping_inc_js'] = Lang::title(self::CDN_MAPPING_INC_JS);
$localize_data['lang']['cdn_mapping_filetype'] = Lang::title(self::CDN_MAPPING_FILETYPE);
$localize_data['lang']['cdn_mapping_url_desc'] = sprintf(__('CDN URL to be used. For example, %s', 'litespeed-cache'), '' . $cdn_url . '');
$localize_data['lang']['one_per_line'] = Doc::one_per_line(true);
$localize_data['lang']['cdn_mapping_remove'] = __('Remove CDN URL', 'litespeed-cache');
$localize_data['lang']['add_cdn_mapping_row'] = __('Add new CDN URL', 'litespeed-cache');
$localize_data['lang']['on'] = __('ON', 'litespeed-cache');
$localize_data['lang']['off'] = __('OFF', 'litespeed-cache');
empty($localize_data['ids']) && ($localize_data['ids'] = array());
$localize_data['ids']['cdn_mapping'] = self::O_CDN_MAPPING;
}
// If on Server IP setting page, append getIP link
if ($_GET['page'] == 'litespeed-general') {
$localize_data['ajax_url_getIP'] = function_exists('get_rest_url') ? get_rest_url(null, 'litespeed/v1/tool/check_ip') : '/';
$localize_data['nonce'] = wp_create_nonce('wp_rest');
}
// Activate or deactivate a specific crawler
if ($_GET['page'] == 'litespeed-crawler') {
$localize_data['ajax_url_crawler_switch'] = function_exists('get_rest_url') ? get_rest_url(null, 'litespeed/v1/toggle_crawler_state') : '/';
$localize_data['nonce'] = wp_create_nonce('wp_rest');
}
}
if ($localize_data) {
wp_localize_script(Core::PLUGIN_NAME, 'litespeed_data', $localize_data);
}
wp_enqueue_script(Core::PLUGIN_NAME);
}
/**
* Babel type for crawler
*
* @since 3.6
*/
public function babel_type($tag, $handle, $src)
{
if ($handle != Core::PLUGIN_NAME . '-crawler' && $handle != Core::PLUGIN_NAME . '-cdn') {
return $tag;
}
return '';
}
/**
* Callback that adds LiteSpeed Cache's action links.
*
* @since 1.0.0
* @access public
* @param array $links Previously added links from other plugins.
* @return array Links array with the litespeed cache one appended.
*/
public function add_plugin_links($links)
{
// $links[] = '' . __('Settings', 'litespeed-cache') . '';
$links[] = '' . __('Settings', 'litespeed-cache') . '';
return $links;
}
/**
* Change the admin footer text on LiteSpeed Cache admin pages.
*
* @since 1.0.13
* @param string $footer_text
* @return string
*/
public function admin_footer_text($footer_text)
{
require_once LSCWP_DIR . 'tpl/inc/admin_footer.php';
return $footer_text;
}
/**
* Builds the html for a single notice.
*
* @since 1.0.7
* @access public
* @param string $color The color to use for the notice.
* @param string $str The notice message.
* @return string The built notice html.
*/
public static function build_notice($color, $str, $irremovable = false, $additional_classes = '')
{
$cls = $color;
if ($irremovable) {
$cls .= ' litespeed-irremovable';
} else {
$cls .= ' is-dismissible';
}
if ($additional_classes) {
$cls .= ' ' . $additional_classes;
}
// possible translation
$str = Lang::maybe_translate($str);
return '' . wp_kses_post($str) . '
' .
__('Dismiss', 'litespeed-cache') .
'' .
'
';
}
echo wp_kses_post($msg);
}
}
// if ( $messages != -1 ) {
// self::update_option( self::DB_MSG_PIN, -1 );
// }
if (empty($_GET['page']) || strpos($_GET['page'], 'litespeed') !== 0) {
global $pagenow;
if ($pagenow != 'plugins.php') {
// && $pagenow != 'index.php'
return;
}
}
// Show disable all warning
if (defined('LITESPEED_DISABLE_ALL') && LITESPEED_DISABLE_ALL) {
Admin_Display::error(Error::msg('disabled_all'), true);
}
if (!$this->conf(self::O_NEWS)) {
return;
}
// Show promo from cloud
Cloud::cls()->show_promo();
/**
* Check promo msg first
* @since 2.9
*/
GUI::cls()->show_promo();
// Show version news
Cloud::cls()->news();
}
/**
* Dismiss pinned msg
*
* @since 3.5.2
* @access public
*/
public static function dismiss_pin()
{
if (!isset($_GET['msgid'])) {
return;
}
$messages = self::get_option(self::DB_MSG_PIN, array());
if (!is_array($messages) || empty($messages[$_GET['msgid']])) {
return;
}
unset($messages[$_GET['msgid']]);
if (!$messages) {
$messages = -1;
}
self::update_option(self::DB_MSG_PIN, $messages);
}
/**
* Dismiss pinned msg by msg content
*
* @since 7.0
* @access public
*/
public static function dismiss_pin_by_content($content, $color, $irremovable)
{
$content = self::build_notice($color, $content, $irremovable);
$messages = self::get_option(self::DB_MSG_PIN, array());
$hit = false;
if ($messages != -1) {
foreach ($messages as $k => $v) {
if ($v == $content) {
unset($messages[$k]);
$hit = true;
self::debug('β
pinned msg content hit. Removed');
break;
}
}
}
if ($hit) {
if (!$messages) {
$messages = -1;
}
self::update_option(self::DB_MSG_PIN, $messages);
} else {
self::debug('β No pinned msg content hit');
}
}
/**
* Hooked to the in_widget_form action.
* Appends LiteSpeed Cache settings to the widget edit settings screen.
* This will append the esi on/off selector and ttl text.
*
* @since 1.1.0
* @access public
*/
public function show_widget_edit($widget, $return, $instance)
{
require LSCWP_DIR . 'tpl/esi_widget_edit.php';
}
/**
* Displays the dashboard page.
*
* @since 3.0
* @access public
*/
public function show_menu_dash()
{
$this->cls('Cloud')->maybe_preview_banner();
require_once LSCWP_DIR . 'tpl/dash/entry.tpl.php';
}
/**
* Displays the General page.
*
* @since 5.3
* @access public
*/
public function show_menu_presets()
{
require_once LSCWP_DIR . 'tpl/presets/entry.tpl.php';
}
/**
* Displays the General page.
*
* @since 3.0
* @access public
*/
public function show_menu_general()
{
$this->cls('Cloud')->maybe_preview_banner();
require_once LSCWP_DIR . 'tpl/general/entry.tpl.php';
}
/**
* Displays the CDN page.
*
* @since 3.0
* @access public
*/
public function show_menu_cdn()
{
$this->cls('Cloud')->maybe_preview_banner();
require_once LSCWP_DIR . 'tpl/cdn/entry.tpl.php';
}
/**
* Outputs the LiteSpeed Cache settings page.
*
* @since 1.0.0
* @access public
*/
public function show_menu_cache()
{
if ($this->_is_network_admin) {
require_once LSCWP_DIR . 'tpl/cache/entry_network.tpl.php';
} else {
require_once LSCWP_DIR . 'tpl/cache/entry.tpl.php';
}
}
/**
* Tools page
*
* @since 3.0
* @access public
*/
public function show_toolbox()
{
$this->cls('Cloud')->maybe_preview_banner();
require_once LSCWP_DIR . 'tpl/toolbox/entry.tpl.php';
}
/**
* Outputs the crawler operation page.
*
* @since 1.1.0
* @access public
*/
public function show_crawler()
{
$this->cls('Cloud')->maybe_preview_banner();
require_once LSCWP_DIR . 'tpl/crawler/entry.tpl.php';
}
/**
* Outputs the optimization operation page.
*
* @since 1.6
* @access public
*/
public function show_img_optm()
{
$this->cls('Cloud')->maybe_preview_banner();
require_once LSCWP_DIR . 'tpl/img_optm/entry.tpl.php';
}
/**
* Page optm page.
*
* @since 3.0
* @access public
*/
public function show_page_optm()
{
$this->cls('Cloud')->maybe_preview_banner();
require_once LSCWP_DIR . 'tpl/page_optm/entry.tpl.php';
}
/**
* DB optm page.
*
* @since 3.0
* @access public
*/
public function show_db_optm()
{
require_once LSCWP_DIR . 'tpl/db_optm/entry.tpl.php';
}
/**
* Outputs a notice to the admin panel when the plugin is installed
* via the WHM plugin.
*
* @since 1.0.12
* @access public
*/
public function show_display_installed()
{
require_once LSCWP_DIR . 'tpl/inc/show_display_installed.php';
}
/**
* Display error cookie msg.
*
* @since 1.0.12
* @access public
*/
public static function show_error_cookie()
{
require_once LSCWP_DIR . 'tpl/inc/show_error_cookie.php';
}
/**
* Display warning if lscache is disabled
*
* @since 2.1
* @access public
*/
public function cache_disabled_warning()
{
include LSCWP_DIR . 'tpl/inc/check_cache_disabled.php';
}
/**
* Display conf data upgrading banner
*
* @since 2.1
* @access private
*/
private function _in_upgrading()
{
include LSCWP_DIR . 'tpl/inc/in_upgrading.php';
}
/**
* Output litespeed form info
*
* @since 3.0
* @access public
*/
public function form_action($action = false, $type = false, $has_upload = false)
{
if (!$action) {
$action = Router::ACTION_SAVE_SETTINGS;
}
$has_upload = $has_upload ? 'enctype="multipart/form-data"' : '';
if (!defined('LITESPEED_CONF_LOADED')) {
echo '';
}
echo '
';
if ($type) {
echo '
';
}
wp_nonce_field($action, Router::NONCE);
}
/**
* Output litespeed form info END
*
* @since 3.0
* @access public
*/
public function form_end($disable_reset = false)
{
echo "
";
if (!defined('LITESPEED_CONF_LOADED')) {
submit_button(__('Save Changes', 'litespeed-cache'), 'secondary litespeed-duplicate-float', 'litespeed-submit', true, array('disabled' => 'disabled'));
echo '
";
$this->_check_overwritten($id);
}
/**
* Build a toggle checkbox html snippet
*
* @since 1.7
*/
public function build_toggle($id, $checked = null, $title_on = null, $title_off = null)
{
if ($checked === null && $this->conf($id, true)) {
$checked = true;
}
if ($title_on === null) {
$title_on = __('ON', 'litespeed-cache');
$title_off = __('OFF', 'litespeed-cache');
}
$cls = $checked ? 'primary' : 'default litespeed-toggleoff';
echo "";
}
/**
* Build a switch div html snippet
*
* @since 1.1.0
* @since 1.7 removed param $disable
* @access public
*/
public function build_switch($id, $title_list = false)
{
$this->enroll($id);
echo '';
if (!$title_list) {
$title_list = array(__('OFF', 'litespeed-cache'), __('ON', 'litespeed-cache'));
}
foreach ($title_list as $k => $v) {
$this->_build_radio($id, $k, $v);
}
echo '
';
$this->_check_overwritten($id);
}
/**
* Build a radio input html codes and output
*
* @since 1.1.0
* @access private
*/
private function _build_radio($id, $val, $txt)
{
$id_attr = 'input_radio_' . preg_replace('/\W/', '', $id) . '_' . $val;
$default = isset(self::$_default_options[$id]) ? self::$_default_options[$id] : self::$_default_site_options[$id];
if (!is_string($default)) {
$checked = (int) $this->conf($id, true) === (int) $val ? ' checked ' : '';
} else {
$checked = $this->conf($id, true) === $val ? ' checked ' : '';
}
echo " ";
}
/**
* Show overwritten msg if there is a const defined
*
* @since 3.0
*/
protected function _check_overwritten($id)
{
$const_val = $this->const_overwritten($id);
$primary_val = $this->primary_overwritten($id);
if ($const_val === null && $primary_val === null) {
return;
}
$val = $const_val !== null ? $const_val : $primary_val;
$default = isset(self::$_default_options[$id]) ? self::$_default_options[$id] : self::$_default_site_options[$id];
if (is_bool($default)) {
$val = $val ? __('ON', 'litespeed-cache') : __('OFF', 'litespeed-cache');
} else {
if (is_array($default)) {
$val = implode("\n", $val);
}
$val = esc_textarea($val);
}
echo 'β οΈ ';
if ($const_val !== null) {
echo sprintf(__('This setting is overwritten by the PHP constant %s', 'litespeed-cache'), '' . Base::conf_const($id) . '');
} else {
if (get_current_blog_id() != BLOG_ID_CURRENT_SITE && $this->conf(self::NETWORK_O_USE_PRIMARY)) {
echo __('This setting is overwritten by the primary site setting', 'litespeed-cache');
} else {
echo __('This setting is overwritten by the Network setting', 'litespeed-cache');
}
}
echo ', ' . sprintf(__('currently set to %s', 'litespeed-cache'), "$val") . '
';
}
/**
* Display seconds text and readable layout
*
* @since 3.0
* @access public
*/
public function readable_seconds()
{
echo __('seconds', 'litespeed-cache');
echo ' ';
}
/**
* Display default value
*
* @since 1.1.1
* @access public
*/
public function recommended($id)
{
if (!$this->default_settings) {
$this->default_settings = $this->load_default_vals();
}
$val = $this->default_settings[$id];
if ($val) {
if (is_array($val)) {
$rows = 5;
$cols = 30;
// Flexible rows/cols
$lines = count($val) + 1;
$rows = min(max($lines, $rows), 40);
foreach ($val as $v) {
$cols = max(strlen($v), $cols);
}
$cols = min($cols, 150);
$val = implode("\n", $val);
$val = esc_textarea($val);
$val = '' . __('Default value', 'litespeed-cache') . ':
' . "";
} else {
$val = esc_textarea($val);
$val = "$val";
$val = __('Default value', 'litespeed-cache') . ': ' . $val;
}
echo $val;
}
}
/**
* Validate rewrite rules regex syntax
*
* @since 3.0
*/
protected function _validate_syntax($id)
{
$val = $this->conf($id, true);
if (!$val) {
return;
}
if (!is_array($val)) {
$val = array($val);
}
foreach ($val as $v) {
if (!Utility::syntax_checker($v)) {
echo '
β ' . __('Invalid rewrite rule', 'litespeed-cache') . ': ' . $v . '';
}
}
}
/**
* Validate if the htaccess path is valid
*
* @since 3.0
*/
protected function _validate_htaccess_path($id)
{
$val = $this->conf($id, true);
if (!$val) {
return;
}
if (substr($val, -10) !== '/.htaccess') {
echo '
β ' . sprintf(__('Path must end with %s', 'litespeed-cache'), '/.htaccess') . '';
}
}
/**
* Check ttl instead of error when saving
*
* @since 3.0
*/
protected function _validate_ttl($id, $min = false, $max = false, $allow_zero = false)
{
$val = $this->conf($id, true);
if ($allow_zero && !$val) {
// return;
}
$tip = array();
if ($min && $val < $min && (!$allow_zero || $val != 0)) {
$tip[] = __('Minimum value', 'litespeed-cache') . ': ' . $min . '.';
}
if ($max && $val > $max) {
$tip[] = __('Maximum value', 'litespeed-cache') . ': ' . $max . '.';
}
echo '
';
if ($tip) {
echo ' β ' . implode(' ', $tip) . '';
}
$range = '';
if ($allow_zero) {
$range .= __('Zero, or', 'litespeed-cache') . ' ';
}
if ($min && $max) {
$range .= $min . ' - ' . $max;
} elseif ($min) {
$range .= __('Larger than', 'litespeed-cache') . ' ' . $min;
} elseif ($max) {
$range .= __('Smaller than', 'litespeed-cache') . ' ' . $max;
}
echo __('Value range', 'litespeed-cache') . ': ' . $range . '';
}
/**
* Check if ip is valid
*
* @since 3.0
*/
protected function _validate_ip($id)
{
$val = $this->conf($id, true);
if (!$val) {
return;
}
if (!is_array($val)) {
$val = array($val);
}
$tip = array();
foreach ($val as $v) {
if (!$v) {
continue;
}
if (!\WP_Http::is_ip_address($v)) {
$tip[] = __('Invalid IP', 'litespeed-cache') . ': ' . esc_textarea($v) . '.';
}
}
if ($tip) {
echo '
β ' . implode(' ', $tip) . '';
}
}
/**
* Display API environment variable support
*
* @since 1.8.3
* @access protected
*/
protected function _api_env_var()
{
$args = func_get_args();
$s = '' . implode(', ', $args) . '';
echo ' ' .
__('API', 'litespeed-cache') .
': ' .
sprintf(__('Server variable(s) %s available to override this setting.', 'litespeed-cache'), $s);
Doc::learn_more('https://docs.litespeedtech.com/lscache/lscwp/admin/#limiting-the-crawler');
}
/**
* Display URI setting example
*
* @since 2.6.1
* @access protected
*/
protected function _uri_usage_example()
{
echo __('The URLs will be compared to the REQUEST_URI server variable.', 'litespeed-cache');
echo ' ' . sprintf(__('For example, for %s, %s can be used here.', 'litespeed-cache'), '/mypath/mypage?aa=bb', 'mypage?aa=');
echo '
';
echo sprintf(__('To match the beginning, add %s to the beginning of the item.', 'litespeed-cache'), '^');
echo ' ' . sprintf(__('To do an exact match, add %s to the end of the URL.', 'litespeed-cache'), '$');
echo ' ' . __('One per line.', 'litespeed-cache');
echo '';
}
/**
* Return groups string
*
* @since 2.0
* @access public
*/
public static function print_plural($num, $kind = 'group')
{
if ($num > 1) {
switch ($kind) {
case 'group':
return sprintf(__('%s groups', 'litespeed-cache'), $num);
case 'image':
return sprintf(__('%s images', 'litespeed-cache'), $num);
default:
return $num;
}
}
switch ($kind) {
case 'group':
return sprintf(__('%s group', 'litespeed-cache'), $num);
case 'image':
return sprintf(__('%s image', 'litespeed-cache'), $num);
default:
return $num;
}
}
/**
* Return guidance html
*
* @since 2.0
* @access public
*/
public static function guidance($title, $steps, $current_step)
{
if ($current_step === 'done') {
$current_step = count($steps) + 1;
}
$percentage = ' (' . floor((($current_step - 1) * 100) / count($steps)) . '%)';
$html = '' . '
' . $title . $percentage . '
' . '
';
foreach ($steps as $k => $v) {
$step = $k + 1;
if ($current_step > $step) {
$html .= '- ';
} else {
$html .= '
- ';
}
$html .= $v . '
';
}
$html .= '
', $this->html_foot . '', $this->content);
}
// Drop noscript if enabled
if ($this->conf(self::O_OPTM_NOSCRIPT_RM)) {
// $this->content = preg_replace( '#![](" . LSWCP_PLUGIN_URL . "assets/img/Litespeed.icon.svg){kind=icon}
";
echo sprintf(__('%1$s %2$s files left in queue', 'litespeed-cache'), $counter, $type);
echo '';
echo '