<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* LiteSpeed Cache CLI Crawler Commands

[2] Fix | Delete

*

[3] Fix | Delete

* Provides WP-CLI commands for managing LiteSpeed Cache crawlers.

[4] Fix | Delete

*

[5] Fix | Delete

* @package LiteSpeed

[6] Fix | Delete

* @since 1.1.0

[7] Fix | Delete

*/

[8] Fix | Delete

[9] Fix | Delete

namespace LiteSpeed\CLI;

[10] Fix | Delete

[11] Fix | Delete

defined('WPINC') || exit();

[12] Fix | Delete

[13] Fix | Delete

use LiteSpeed\Debug2;

[14] Fix | Delete

use LiteSpeed\Base;

[15] Fix | Delete

use LiteSpeed\Task;

[16] Fix | Delete

use LiteSpeed\Crawler as Crawler2;

[17] Fix | Delete

use WP_CLI;

[18] Fix | Delete

[19] Fix | Delete

/**

[20] Fix | Delete

* Crawler

[21] Fix | Delete

*/

[22] Fix | Delete

class Crawler extends Base {

[23] Fix | Delete

/**

[24] Fix | Delete

* Crawler instance

[25] Fix | Delete

*

[26] Fix | Delete

* @var Crawler2 $crawler

[27] Fix | Delete

*/

[28] Fix | Delete

private $crawler;

[29] Fix | Delete

[30] Fix | Delete

/**

[31] Fix | Delete

* Constructor for Crawler CLI commands

[32] Fix | Delete

*

[33] Fix | Delete

* @since 1.1.0

[34] Fix | Delete

*/

[35] Fix | Delete

public function __construct() {

[36] Fix | Delete

Debug2::debug('CLI_Crawler init');

[37] Fix | Delete

[38] Fix | Delete

$this->crawler = Crawler2::cls();

[39] Fix | Delete

}

[40] Fix | Delete

[41] Fix | Delete

/**

[42] Fix | Delete

* List all crawlers

[43] Fix | Delete

*

[44] Fix | Delete

* Displays a table of all crawlers with their details.

[45] Fix | Delete

*

[46] Fix | Delete

* ## OPTIONS

[47] Fix | Delete

*

[48] Fix | Delete

* ## EXAMPLES

[49] Fix | Delete

*

[50] Fix | Delete

* # List all crawlers

[51] Fix | Delete

* $ wp litespeed-crawler l

[52] Fix | Delete

*

[53] Fix | Delete

* @since 1.1.0

[54] Fix | Delete

*/

[55] Fix | Delete

public function l() {

[56] Fix | Delete

$this->list();

[57] Fix | Delete

}

[58] Fix | Delete

[59] Fix | Delete

/**

[60] Fix | Delete

* List all crawlers

[61] Fix | Delete

*

[62] Fix | Delete

* Displays a table of all crawlers with their details.

[63] Fix | Delete

*

[64] Fix | Delete

* ## OPTIONS

[65] Fix | Delete

*

[66] Fix | Delete

* ## EXAMPLES

[67] Fix | Delete

*

[68] Fix | Delete

* # List all crawlers

[69] Fix | Delete

* $ wp litespeed-crawler list

[70] Fix | Delete

*

[71] Fix | Delete

* @since 1.1.0

[72] Fix | Delete

*/

[73] Fix | Delete

public function list() {

[74] Fix | Delete

$crawler_list = $this->crawler->list_crawlers();

[75] Fix | Delete

$summary = Crawler2::get_summary();

[76] Fix | Delete

if ($summary['curr_crawler'] >= count($crawler_list)) {

[77] Fix | Delete

$summary['curr_crawler'] = 0;

[78] Fix | Delete

}

[79] Fix | Delete

$is_running = time() - $summary['is_running'] <= 900;

[80] Fix | Delete

[81] Fix | Delete

$crawler_run_interval = defined('LITESPEED_CRAWLER_RUN_INTERVAL') ? LITESPEED_CRAWLER_RUN_INTERVAL : 600; // Specify time in seconds for the time between each run interval

[82] Fix | Delete

if ($crawler_run_interval > 0) {

[83] Fix | Delete

$recurrence = '';

[84] Fix | Delete

$hours = (int) floor($crawler_run_interval / 3600);

[85] Fix | Delete

if ($hours) {

[86] Fix | Delete

if ($hours > 1) {

[87] Fix | Delete

$recurrence .= sprintf(__('%d hours', 'litespeed-cache'), $hours);

[88] Fix | Delete

} else {

[89] Fix | Delete

$recurrence .= sprintf(__('%d hour', 'litespeed-cache'), $hours);

[90] Fix | Delete

}

[91] Fix | Delete

}

[92] Fix | Delete

$minutes = (int) floor(($crawler_run_interval % 3600) / 60);

[93] Fix | Delete

if ($minutes) {

[94] Fix | Delete

$recurrence .= ' ';

[95] Fix | Delete

if ($minutes > 1) {

[96] Fix | Delete

$recurrence .= sprintf(__('%d minutes', 'litespeed-cache'), $minutes);

[97] Fix | Delete

} else {

[98] Fix | Delete

$recurrence .= sprintf(__('%d minute', 'litespeed-cache'), $minutes);

[99] Fix | Delete

}

[100] Fix | Delete

}

[101] Fix | Delete

}

[102] Fix | Delete

[103] Fix | Delete

$list = array();

[104] Fix | Delete

foreach ($crawler_list as $i => $v) {

[105] Fix | Delete

$hit = !empty($summary['crawler_stats'][$i][Crawler2::STATUS_HIT]) ? $summary['crawler_stats'][$i][Crawler2::STATUS_HIT] : 0;

[106] Fix | Delete

$miss = !empty($summary['crawler_stats'][$i][Crawler2::STATUS_MISS]) ? $summary['crawler_stats'][$i][Crawler2::STATUS_MISS] : 0;

[107] Fix | Delete

[108] Fix | Delete

$blacklisted = !empty($summary['crawler_stats'][$i][Crawler2::STATUS_BLACKLIST]) ? $summary['crawler_stats'][$i][Crawler2::STATUS_BLACKLIST] : 0;

[109] Fix | Delete

$blacklisted += !empty($summary['crawler_stats'][$i][Crawler2::STATUS_NOCACHE]) ? $summary['crawler_stats'][$i][Crawler2::STATUS_NOCACHE] : 0;

[110] Fix | Delete

[111] Fix | Delete

if (isset($summary['crawler_stats'][$i][Crawler2::STATUS_WAIT])) {

[112] Fix | Delete

$waiting = $summary['crawler_stats'][$i][Crawler2::STATUS_WAIT] ?? 0;

[113] Fix | Delete

} else {

[114] Fix | Delete

$waiting = $summary['list_size'] - $hit - $miss - $blacklisted;

[115] Fix | Delete

}

[116] Fix | Delete

[117] Fix | Delete

$analytics = 'Waiting: ' . $waiting;

[118] Fix | Delete

$analytics .= ' Hit: ' . $hit;

[119] Fix | Delete

$analytics .= ' Miss: ' . $miss;

[120] Fix | Delete

$analytics .= ' Blocked: ' . $blacklisted;

[121] Fix | Delete

[122] Fix | Delete

$running = '';

[123] Fix | Delete

if ($i === $summary['curr_crawler']) {

[124] Fix | Delete

$running = 'Pos: ' . ($summary['last_pos'] + 1);

[125] Fix | Delete

if ($is_running) {

[126] Fix | Delete

$running .= '(Running)';

[127] Fix | Delete

}

[128] Fix | Delete

}

[129] Fix | Delete

[130] Fix | Delete

$status = $this->crawler->is_active($i) ? '✅' : '❌';

[131] Fix | Delete

[132] Fix | Delete

$list[] = array(

[133] Fix | Delete

'ID' => $i + 1,

[134] Fix | Delete

'Name' => wp_strip_all_tags($v['title']),

[135] Fix | Delete

'Frequency' => $recurrence,

[136] Fix | Delete

'Status' => $status,

[137] Fix | Delete

'Analytics' => $analytics,

[138] Fix | Delete

'Running' => $running,

[139] Fix | Delete

);

[140] Fix | Delete

}

[141] Fix | Delete

[142] Fix | Delete

WP_CLI\Utils\format_items('table', $list, array( 'ID', 'Name', 'Frequency', 'Status', 'Analytics', 'Running' ));

[143] Fix | Delete

}

[144] Fix | Delete

[145] Fix | Delete

/**

[146] Fix | Delete

* Enable one crawler

[147] Fix | Delete

*

[148] Fix | Delete

* ## OPTIONS

[149] Fix | Delete

*

[150] Fix | Delete

* <id>

[151] Fix | Delete

* : The ID of the crawler to enable.

[152] Fix | Delete

*

[153] Fix | Delete

* ## EXAMPLES

[154] Fix | Delete

*

[155] Fix | Delete

* # Turn on 2nd crawler

[156] Fix | Delete

* $ wp litespeed-crawler enable 2

[157] Fix | Delete

*

[158] Fix | Delete

* @since 1.1.0

[159] Fix | Delete

* @param array $args Command arguments.

[160] Fix | Delete

*/

[161] Fix | Delete

public function enable( $args ) {

[162] Fix | Delete

$id = $args[0] - 1;

[163] Fix | Delete

if ($this->crawler->is_active($id)) {

[164] Fix | Delete

WP_CLI::error('ID #' . $id . ' had been enabled');

[165] Fix | Delete

return;

[166] Fix | Delete

}

[167] Fix | Delete

[168] Fix | Delete

$this->crawler->toggle_activeness($id);

[169] Fix | Delete

WP_CLI::success('Enabled crawler #' . $id);

[170] Fix | Delete

}

[171] Fix | Delete

[172] Fix | Delete

/**

[173] Fix | Delete

* Disable one crawler

[174] Fix | Delete

*

[175] Fix | Delete

* ## OPTIONS

[176] Fix | Delete

*

[177] Fix | Delete

* <id>

[178] Fix | Delete

* : The ID of the crawler to disable.

[179] Fix | Delete

*

[180] Fix | Delete

* ## EXAMPLES

[181] Fix | Delete

*

[182] Fix | Delete

* # Turn off 1st crawler

[183] Fix | Delete

* $ wp litespeed-crawler disable 1

[184] Fix | Delete

*

[185] Fix | Delete

* @since 1.1.0

[186] Fix | Delete

* @param array $args Command arguments.

[187] Fix | Delete

*/

[188] Fix | Delete

public function disable( $args ) {

[189] Fix | Delete

$id = $args[0] - 1;

[190] Fix | Delete

if (!$this->crawler->is_active($id)) {

[191] Fix | Delete

WP_CLI::error('ID #' . $id . ' has been disabled');

[192] Fix | Delete

return;

[193] Fix | Delete

}

[194] Fix | Delete

[195] Fix | Delete

$this->crawler->toggle_activeness($id);

[196] Fix | Delete

WP_CLI::success('Disabled crawler #' . $id);

[197] Fix | Delete

}

[198] Fix | Delete

[199] Fix | Delete

/**

[200] Fix | Delete

* Run crawling

[201] Fix | Delete

*

[202] Fix | Delete

* ## OPTIONS

[203] Fix | Delete

*

[204] Fix | Delete

* ## EXAMPLES

[205] Fix | Delete

*

[206] Fix | Delete

* # Start crawling

[207] Fix | Delete

* $ wp litespeed-crawler r

[208] Fix | Delete

*

[209] Fix | Delete

* @since 1.1.0

[210] Fix | Delete

*/

[211] Fix | Delete

public function r() {

[212] Fix | Delete

$this->run();

[213] Fix | Delete

}

[214] Fix | Delete

[215] Fix | Delete

/**

[216] Fix | Delete

* Run crawling

[217] Fix | Delete

*

[218] Fix | Delete

* ## OPTIONS

[219] Fix | Delete

*

[220] Fix | Delete

* ## EXAMPLES

[221] Fix | Delete

*

[222] Fix | Delete

* # Start crawling

[223] Fix | Delete

* $ wp litespeed-crawler run

[224] Fix | Delete

*

[225] Fix | Delete

* @since 1.1.0

[226] Fix | Delete

*/

[227] Fix | Delete

public function run() {

[228] Fix | Delete

self::debug('⚠️⚠️⚠️ Forced take over lane (CLI)');

[229] Fix | Delete

$this->crawler->Release_lane();

[230] Fix | Delete

[231] Fix | Delete

Task::async_call('crawler');

[232] Fix | Delete

[233] Fix | Delete

$summary = Crawler2::get_summary();

[234] Fix | Delete

[235] Fix | Delete

WP_CLI::success('Start crawling. Current crawler #' . ($summary['curr_crawler'] + 1) . ' [position] ' . $summary['last_pos'] . ' [total] ' . $summary['list_size']);

[236] Fix | Delete

}

[237] Fix | Delete

[238] Fix | Delete

/**

[239] Fix | Delete

* Reset crawler position

[240] Fix | Delete

*

[241] Fix | Delete

* ## OPTIONS

[242] Fix | Delete

*

[243] Fix | Delete

* ## EXAMPLES

[244] Fix | Delete

*

[245] Fix | Delete

* # Reset crawler position

[246] Fix | Delete

* $ wp litespeed-crawler reset

[247] Fix | Delete

*

[248] Fix | Delete

* @since 1.1.0

[249] Fix | Delete

*/

[250] Fix | Delete

public function reset() {

[251] Fix | Delete

$this->crawler->reset_pos();

[252] Fix | Delete

[253] Fix | Delete

$summary = Crawler2::get_summary();

[254] Fix | Delete

[255] Fix | Delete

WP_CLI::success('Reset position. Current crawler #' . ($summary['curr_crawler'] + 1) . ' [position] ' . $summary['last_pos'] . ' [total] ' . $summary['list_size']);

[256] Fix | Delete

}

[257] Fix | Delete

}

[258] Fix | Delete

[259] Fix | Delete