<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* The avatar cache class.

[2] Fix | Delete

*

[3] Fix | Delete

* Caches remote (e.g., Gravatar) avatars locally and rewrites URLs

[4] Fix | Delete

* to serve cached copies with a TTL. Supports on-demand generation

[5] Fix | Delete

* during page render and batch generation via cron.

[6] Fix | Delete

*

[7] Fix | Delete

* @since 3.0

[8] Fix | Delete

* @package LiteSpeed

[9] Fix | Delete

*/

[10] Fix | Delete

[11] Fix | Delete

namespace LiteSpeed;

[12] Fix | Delete

[13] Fix | Delete

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

[14] Fix | Delete

[15] Fix | Delete

/**

[16] Fix | Delete

* Class Avatar

[17] Fix | Delete

*/

[18] Fix | Delete

class Avatar extends Base {

[19] Fix | Delete

[20] Fix | Delete

const TYPE_GENERATE = 'generate';

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* Avatar cache TTL (seconds).

[24] Fix | Delete

*

[25] Fix | Delete

* @var int

[26] Fix | Delete

*/

[27] Fix | Delete

private $_conf_cache_ttl;

[28] Fix | Delete

[29] Fix | Delete

/**

[30] Fix | Delete

* Avatar DB table name.

[31] Fix | Delete

*

[32] Fix | Delete

* @var string

[33] Fix | Delete

*/

[34] Fix | Delete

private $_tb;

[35] Fix | Delete

[36] Fix | Delete

/**

[37] Fix | Delete

* In-request map from original URL => rewritten URL to avoid duplicates.

[38] Fix | Delete

*

[39] Fix | Delete

* @var array<string,string>

[40] Fix | Delete

*/

[41] Fix | Delete

private $_avatar_realtime_gen_dict = [];

[42] Fix | Delete

[43] Fix | Delete

/**

[44] Fix | Delete

* Summary/status data for last requests.

[45] Fix | Delete

*

[46] Fix | Delete

* @var array<string,mixed>

[47] Fix | Delete

*/

[48] Fix | Delete

protected $_summary;

[49] Fix | Delete

[50] Fix | Delete

/**

[51] Fix | Delete

* Init.

[52] Fix | Delete

*

[53] Fix | Delete

* @since 1.4

[54] Fix | Delete

*/

[55] Fix | Delete

public function __construct() {

[56] Fix | Delete

$this->_tb = Data::cls()->tb( 'avatar' );

[57] Fix | Delete

[58] Fix | Delete

if ( ! $this->conf( self::O_DISCUSS_AVATAR_CACHE ) ) {

[59] Fix | Delete

return;

[60] Fix | Delete

}

[61] Fix | Delete

[62] Fix | Delete

self::debug2( '[Avatar] init' );

[63] Fix | Delete

[64] Fix | Delete

$this->_conf_cache_ttl = $this->conf( self::O_DISCUSS_AVATAR_CACHE_TTL );

[65] Fix | Delete

[66] Fix | Delete

add_filter( 'get_avatar_url', [ $this, 'crawl_avatar' ] );

[67] Fix | Delete

[68] Fix | Delete

$this->_summary = self::get_summary();

[69] Fix | Delete

}

[70] Fix | Delete

[71] Fix | Delete

/**

[72] Fix | Delete

* Check whether DB table is needed.

[73] Fix | Delete

*

[74] Fix | Delete

* @since 3.0

[75] Fix | Delete

* @access public

[76] Fix | Delete

* @return bool

[77] Fix | Delete

*/

[78] Fix | Delete

public function need_db() {

[79] Fix | Delete

return (bool) $this->conf( self::O_DISCUSS_AVATAR_CACHE );

[80] Fix | Delete

}

[81] Fix | Delete

[82] Fix | Delete

/**

[83] Fix | Delete

* Serve static avatar by md5 (used by local static route).

[84] Fix | Delete

*

[85] Fix | Delete

* @since 3.0

[86] Fix | Delete

* @access public

[87] Fix | Delete

* @param string $md5 MD5 hash of original avatar URL.

[88] Fix | Delete

* @return void

[89] Fix | Delete

*/

[90] Fix | Delete

public function serve_static( $md5 ) {

[91] Fix | Delete

global $wpdb;

[92] Fix | Delete

[93] Fix | Delete

self::debug( '[Avatar] is avatar request' );

[94] Fix | Delete

[95] Fix | Delete

if ( strlen( $md5 ) !== 32 ) {

[96] Fix | Delete

self::debug( '[Avatar] wrong md5 ' . $md5 );

[97] Fix | Delete

return;

[98] Fix | Delete

}

[99] Fix | Delete

[100] Fix | Delete

$url = $wpdb->get_var( // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching

[101] Fix | Delete

$wpdb->prepare(

[102] Fix | Delete

'SELECT url FROM `' . $this->_tb . '` WHERE md5 = %s', // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared

[103] Fix | Delete

$md5

[104] Fix | Delete

)

[105] Fix | Delete

);

[106] Fix | Delete

[107] Fix | Delete

if ( ! $url ) {

[108] Fix | Delete

self::debug( '[Avatar] no matched url for md5 ' . $md5 );

[109] Fix | Delete

return;

[110] Fix | Delete

}

[111] Fix | Delete

[112] Fix | Delete

$url = $this->_generate( $url );

[113] Fix | Delete

[114] Fix | Delete

wp_safe_redirect( $url );

[115] Fix | Delete

exit;

[116] Fix | Delete

}

[117] Fix | Delete

[118] Fix | Delete

/**

[119] Fix | Delete

* Localize/replace avatar URL with cached one (filter callback).

[120] Fix | Delete

*

[121] Fix | Delete

* @since 3.0

[122] Fix | Delete

* @access public

[123] Fix | Delete

* @param string $url Original avatar URL.

[124] Fix | Delete

* @return string Rewritten/cached avatar URL (or original).

[125] Fix | Delete

*/

[126] Fix | Delete

public function crawl_avatar( $url ) {

[127] Fix | Delete

if ( ! $url ) {

[128] Fix | Delete

return $url;

[129] Fix | Delete

}

[130] Fix | Delete

[131] Fix | Delete

// Check if already generated in this request.

[132] Fix | Delete

if ( ! empty( $this->_avatar_realtime_gen_dict[ $url ] ) ) {

[133] Fix | Delete

self::debug2( '[Avatar] already in dict [url] ' . $url );

[134] Fix | Delete

return $this->_avatar_realtime_gen_dict[ $url ];

[135] Fix | Delete

}

[136] Fix | Delete

[137] Fix | Delete

$realpath = $this->_realpath( $url );

[138] Fix | Delete

$mtime = file_exists( $realpath ) ? filemtime( $realpath ) : false;

[139] Fix | Delete

[140] Fix | Delete

if ( $mtime && time() - (int) $mtime <= $this->_conf_cache_ttl ) {

[141] Fix | Delete

self::debug2( '[Avatar] cache file exists [url] ' . $url );

[142] Fix | Delete

return $this->_rewrite( $url, $mtime );

[143] Fix | Delete

}

[144] Fix | Delete

[145] Fix | Delete

// Only handle gravatar or known remote avatar providers; keep generic check for "gravatar.com".

[146] Fix | Delete

if ( strpos( $url, 'gravatar.com' ) === false ) {

[147] Fix | Delete

return $url;

[148] Fix | Delete

}

[149] Fix | Delete

[150] Fix | Delete

// Throttle generation.

[151] Fix | Delete

if ( ! empty( $this->_summary['curr_request'] ) && time() - (int) $this->_summary['curr_request'] < 300 ) {

[152] Fix | Delete

self::debug2( '[Avatar] Bypass generating due to interval limit [url] ' . $url );

[153] Fix | Delete

return $url;

[154] Fix | Delete

}

[155] Fix | Delete

[156] Fix | Delete

// Generate immediately and track for this request.

[157] Fix | Delete

$this->_avatar_realtime_gen_dict[ $url ] = $this->_generate( $url );

[158] Fix | Delete

[159] Fix | Delete

return $this->_avatar_realtime_gen_dict[ $url ];

[160] Fix | Delete

}

[161] Fix | Delete

[162] Fix | Delete

/**

[163] Fix | Delete

* Count queued avatars (expired ones) for cron.

[164] Fix | Delete

*

[165] Fix | Delete

* @since 3.0

[166] Fix | Delete

* @access public

[167] Fix | Delete

* @return int|false

[168] Fix | Delete

*/

[169] Fix | Delete

public function queue_count() {

[170] Fix | Delete

global $wpdb;

[171] Fix | Delete

[172] Fix | Delete

if ( ! Data::cls()->tb_exist( 'avatar' ) ) {

[173] Fix | Delete

Data::cls()->tb_create( 'avatar' );

[174] Fix | Delete

}

[175] Fix | Delete

[176] Fix | Delete

$cnt = $wpdb->get_var( // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching

[177] Fix | Delete

$wpdb->prepare(

[178] Fix | Delete

'SELECT COUNT(*) FROM `' . $this->_tb . '` WHERE dateline < %d', // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared

[179] Fix | Delete

time() - $this->_conf_cache_ttl

[180] Fix | Delete

)

[181] Fix | Delete

);

[182] Fix | Delete

[183] Fix | Delete

return (int) $cnt;

[184] Fix | Delete

}

[185] Fix | Delete

[186] Fix | Delete

/**

[187] Fix | Delete

* Build final local URL for cached avatar.

[188] Fix | Delete

*

[189] Fix | Delete

* @since 3.0

[190] Fix | Delete

* @param string $url Original URL.

[191] Fix | Delete

* @param int|null $time Optional filemtime for cache busting.

[192] Fix | Delete

* @return string Local URL.

[193] Fix | Delete

*/

[194] Fix | Delete

private function _rewrite( $url, $time = null ) {

[195] Fix | Delete

$qs = $time ? '?ver=' . $time : '';

[196] Fix | Delete

return LITESPEED_STATIC_URL . '/avatar/' . $this->_filepath( $url ) . $qs;

[197] Fix | Delete

}

[198] Fix | Delete

[199] Fix | Delete

/**

[200] Fix | Delete

* Generate filesystem realpath for cache file.

[201] Fix | Delete

*

[202] Fix | Delete

* @since 3.0

[203] Fix | Delete

* @access private

[204] Fix | Delete

* @param string $url Original URL.

[205] Fix | Delete

* @return string Absolute filesystem path.

[206] Fix | Delete

*/

[207] Fix | Delete

private function _realpath( $url ) {

[208] Fix | Delete

return LITESPEED_STATIC_DIR . '/avatar/' . $this->_filepath( $url );

[209] Fix | Delete

}

[210] Fix | Delete

[211] Fix | Delete

/**

[212] Fix | Delete

* Get relative filepath for cached avatar.

[213] Fix | Delete

*

[214] Fix | Delete

* @since 4.0

[215] Fix | Delete

* @param string $url Original URL.

[216] Fix | Delete

* @return string Relative path under avatar/ (may include blog id).

[217] Fix | Delete

*/

[218] Fix | Delete

private function _filepath( $url ) {

[219] Fix | Delete

$filename = md5( $url ) . '.jpg';

[220] Fix | Delete

if ( is_multisite() ) {

[221] Fix | Delete

$filename = get_current_blog_id() . '/' . $filename;

[222] Fix | Delete

}

[223] Fix | Delete

return $filename;

[224] Fix | Delete

}

[225] Fix | Delete

[226] Fix | Delete

/**

[227] Fix | Delete

* Cron generation for expired avatars.

[228] Fix | Delete

*

[229] Fix | Delete

* @since 3.0

[230] Fix | Delete

* @access public

[231] Fix | Delete

* @param bool $force Bypass throttle.

[232] Fix | Delete

* @return void

[233] Fix | Delete

*/

[234] Fix | Delete

public static function cron( $force = false ) {

[235] Fix | Delete

global $wpdb;

[236] Fix | Delete

[237] Fix | Delete

$_instance = self::cls();

[238] Fix | Delete

if ( ! $_instance->queue_count() ) {

[239] Fix | Delete

self::debug( '[Avatar] no queue' );

[240] Fix | Delete

return;

[241] Fix | Delete

}

[242] Fix | Delete

[243] Fix | Delete

// For cron, need to check request interval too.

[244] Fix | Delete

if ( ! $force ) {

[245] Fix | Delete

if ( ! empty( $_instance->_summary['curr_request'] ) && time() - (int) $_instance->_summary['curr_request'] < 300 ) {

[246] Fix | Delete

self::debug( '[Avatar] curr_request too close' );

[247] Fix | Delete

return;

[248] Fix | Delete

}

[249] Fix | Delete

}

[250] Fix | Delete

[251] Fix | Delete

$list = $wpdb->get_results( // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching

[252] Fix | Delete

$wpdb->prepare(

[253] Fix | Delete

'SELECT url FROM `' . $_instance->_tb . '` WHERE dateline < %d ORDER BY id DESC LIMIT %d', // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared

[254] Fix | Delete

time() - $_instance->_conf_cache_ttl,

[255] Fix | Delete

(int) apply_filters( 'litespeed_avatar_limit', 30 )

[256] Fix | Delete

)

[257] Fix | Delete

);

[258] Fix | Delete

self::debug( '[Avatar] cron job [count] ' . ( $list ? count( $list ) : 0 ) );

[259] Fix | Delete

[260] Fix | Delete

if ( $list ) {

[261] Fix | Delete

foreach ( $list as $v ) {

[262] Fix | Delete

self::debug( '[Avatar] cron job [url] ' . $v->url );

[263] Fix | Delete

$_instance->_generate( $v->url );

[264] Fix | Delete

}

[265] Fix | Delete

}

[266] Fix | Delete

}

[267] Fix | Delete

[268] Fix | Delete

/**

[269] Fix | Delete

* Download and store the avatar locally, then update DB row.

[270] Fix | Delete

*

[271] Fix | Delete

* @since 3.0

[272] Fix | Delete

* @access private

[273] Fix | Delete

* @param string $url Original avatar URL.

[274] Fix | Delete

* @return string Rewritten local URL (fallback to original on failure).

[275] Fix | Delete

*/

[276] Fix | Delete

private function _generate( $url ) {

[277] Fix | Delete

global $wpdb;

[278] Fix | Delete

[279] Fix | Delete

$file = $this->_realpath( $url );

[280] Fix | Delete

[281] Fix | Delete

// Mark request start

[282] Fix | Delete

self::save_summary(

[283] Fix | Delete

[

[284] Fix | Delete

'curr_request' => time(),

[285] Fix | Delete

]

[286] Fix | Delete

);

[287] Fix | Delete

[288] Fix | Delete

// Ensure cache directory exists

[289] Fix | Delete

$this->_maybe_mk_cache_folder( 'avatar' );

[290] Fix | Delete

[291] Fix | Delete

$response = wp_safe_remote_get(

[292] Fix | Delete

$url,

[293] Fix | Delete

[

[294] Fix | Delete

'timeout' => 180,

[295] Fix | Delete

'stream' => true,

[296] Fix | Delete

'filename' => $file,

[297] Fix | Delete

]

[298] Fix | Delete

);

[299] Fix | Delete

[300] Fix | Delete

self::debug( '[Avatar] _generate [url] ' . $url );

[301] Fix | Delete

[302] Fix | Delete

// Parse response data

[303] Fix | Delete

if ( is_wp_error( $response ) ) {

[304] Fix | Delete

$error_message = $response->get_error_message();

[305] Fix | Delete

if ( file_exists( $file ) ) {

[306] Fix | Delete

wp_delete_file( $file );

[307] Fix | Delete

}

[308] Fix | Delete

self::debug( '[Avatar] failed to get: ' . $error_message );

[309] Fix | Delete

return $url;

[310] Fix | Delete

}

[311] Fix | Delete

[312] Fix | Delete

// Save summary data

[313] Fix | Delete

self::save_summary(

[314] Fix | Delete

[

[315] Fix | Delete

'last_spent' => time() - (int) $this->_summary['curr_request'],

[316] Fix | Delete

'last_request' => $this->_summary['curr_request'],

[317] Fix | Delete

'curr_request' => 0,

[318] Fix | Delete

]

[319] Fix | Delete

);

[320] Fix | Delete

[321] Fix | Delete

// Update/insert DB record

[322] Fix | Delete

$md5 = md5( $url );

[323] Fix | Delete

[324] Fix | Delete

$existed = $wpdb->query( // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching

[325] Fix | Delete

$wpdb->prepare(

[326] Fix | Delete

'UPDATE `' . $this->_tb . '` SET dateline = %d WHERE md5 = %s', // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared

[327] Fix | Delete

time(),

[328] Fix | Delete

$md5

[329] Fix | Delete

)

[330] Fix | Delete

);

[331] Fix | Delete

[332] Fix | Delete

if ( ! $existed ) {

[333] Fix | Delete

$wpdb->query( // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching

[334] Fix | Delete

$wpdb->prepare(

[335] Fix | Delete

'INSERT INTO `' . $this->_tb . '` (url, md5, dateline) VALUES (%s, %s, %d)', // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared

[336] Fix | Delete

$url,

[337] Fix | Delete

$md5,

[338] Fix | Delete

time()

[339] Fix | Delete

)

[340] Fix | Delete

);

[341] Fix | Delete

}

[342] Fix | Delete

[343] Fix | Delete

self::debug( '[Avatar] saved avatar ' . $file );

[344] Fix | Delete

[345] Fix | Delete

return $this->_rewrite( $url );

[346] Fix | Delete

}

[347] Fix | Delete

[348] Fix | Delete

/**

[349] Fix | Delete

* Handle all request actions from main cls.

[350] Fix | Delete

*

[351] Fix | Delete

* @since 3.0

[352] Fix | Delete

* @access public

[353] Fix | Delete

* @return void

[354] Fix | Delete

*/

[355] Fix | Delete

public function handler() {

[356] Fix | Delete

$type = Router::verify_type();

[357] Fix | Delete

[358] Fix | Delete

switch ( $type ) {

[359] Fix | Delete

case self::TYPE_GENERATE:

[360] Fix | Delete

self::cron( true );

[361] Fix | Delete

break;

[362] Fix | Delete

[363] Fix | Delete

default:

[364] Fix | Delete

break;

[365] Fix | Delete

}

[366] Fix | Delete

[367] Fix | Delete

Admin::redirect();

[368] Fix | Delete

}

[369] Fix | Delete

}

[370] Fix | Delete

[371] Fix | Delete