bfi-thumb/bfi-thumb.php000066600000056732152141441240011026 0ustar00. */ /** Uses WP's Image Editor Class to resize and filter images * * @param $url string the local image URL to manipulate * @param $params array the options to perform on the image. Keys and values supported: * 'width' int pixels * 'height' int pixels * 'opacity' int 0-100 * 'color' string hex-color #000000-#ffffff * 'grayscale' bool * 'negate' bool * 'crop' bool * 'crop_only' bool * 'crop_x' bool string * 'crop_y' bool string * 'crop_width' bool string * 'crop_height' bool string * 'quality' int 1-100 * @param $single boolean, if false then an array of data will be returned * * @return string|array containing the url of the resized modified image */ if ( ! defined( 'ABSPATH' ) ) exit; // Exit if accessed directly. if ( ! defined( 'BFITHUMB_UPLOAD_DIR' ) ) { define( 'BFITHUMB_UPLOAD_DIR', 'elementor/thumbs' ); } if ( ! function_exists( 'bfi_thumb' ) ) { function bfi_thumb( $url, $params = array(), $single = true ) { $class = BFI_Class_Factory::getNewestVersion( 'BFI_Thumb' ); return call_user_func( array( $class, 'thumb' ), $url, $params, $single ); } } /** * Class factory, this is to make sure that when multiple bfi_thumb scripts * are used (e.g. a plugin and a theme both use it), we always use the * latest version. */ if ( ! class_exists( 'BFI_Class_Factory' ) ) { class BFI_Class_Factory { public static $versions = array(); public static $latestClass = array(); public static function addClassVersion( $baseClassName, $className, $version ) { if ( empty( self::$versions[ $baseClassName ] ) ) { self::$versions[ $baseClassName ] = array(); } self::$versions[ $baseClassName ][] = array( 'class' => $className, 'version' => $version, ); } public static function getNewestVersion( $baseClassName ) { if ( empty( self::$latestClass[ $baseClassName ] ) ) { usort( self::$versions[ $baseClassName ], array( __CLASS__, "versionCompare" ) ); self::$latestClass[ $baseClassName ] = self::$versions[ $baseClassName ][0]['class']; unset( self::$versions[ $baseClassName ] ); } return self::$latestClass[ $baseClassName ]; } public static function versionCompare( $a, $b ) { return version_compare( $a['version'], $b['version'] ) == 1 ? -1 : 1; } } } /* * Change the default image editors */ add_filter( 'wp_image_editors', 'bfi_wp_image_editor' ); // Instead of using the default image editors, use our extended ones if ( ! function_exists( 'bfi_wp_image_editor' ) ) { function bfi_wp_image_editor( $editorArray ) { // Make sure that we use the latest versions return array( BFI_Class_Factory::getNewestVersion( 'BFI_Image_Editor_GD' ), BFI_Class_Factory::getNewestVersion( 'BFI_Image_Editor_Imagick' ), ); } } /* * Include the WP Image classes */ require_once ABSPATH . WPINC . '/class-wp-image-editor.php'; require_once ABSPATH . WPINC . '/class-wp-image-editor-imagick.php'; require_once ABSPATH . WPINC . '/class-wp-image-editor-gd.php'; /* * Enhanced Imagemagick Image Editor */ if ( ! class_exists( 'BFI_Image_Editor_Imagick_1_3' ) ) { BFI_Class_Factory::addClassVersion( 'BFI_Image_Editor_Imagick', 'BFI_Image_Editor_Imagick_1_3', '1.3' ); class BFI_Image_Editor_Imagick_1_3 extends WP_Image_Editor_Imagick { /** Changes the opacity of the image * * @supports 3.5.1 * @access public * * @param float $opacity (0.0-1.0) * * @return boolean|WP_Error */ public function opacity( $opacity ) { $opacity /= 100; try { // From: http://stackoverflow.com/questions/3538851/php-imagick-setimageopacity-destroys-transparency-and-does-nothing // preserves transparency //$this->image->setImageOpacity($opacity); return $this->image->evaluateImage( Imagick::EVALUATE_MULTIPLY, $opacity, Imagick::CHANNEL_ALPHA ); } catch ( Exception $e ) { return new WP_Error( 'image_opacity_error', $e->getMessage() ); } } /** Tints the image a different color * * @supports 3.5.1 * @access public * * @param string hex color e.g. #ff00ff * * @return boolean|WP_Error */ public function colorize( $hexColor ) { try { return $this->image->colorizeImage( $hexColor, 1.0 ); } catch ( Exception $e ) { return new WP_Error( 'image_colorize_error', $e->getMessage() ); } } /** Makes the image grayscale * * @supports 3.5.1 * @access public * * @return boolean|WP_Error */ public function grayscale() { try { return $this->image->modulateImage( 100, 0, 100 ); } catch ( Exception $e ) { return new WP_Error( 'image_grayscale_error', $e->getMessage() ); } } /** Negates the image * * @supports 3.5.1 * @access public * * @return boolean|WP_Error */ public function negate() { try { return $this->image->negateImage( false ); } catch ( Exception $e ) { return new WP_Error( 'image_negate_error', $e->getMessage() ); } } } } /* * Enhanced GD Image Editor */ if ( ! class_exists( 'BFI_Image_Editor_GD_1_3' ) ) { BFI_Class_Factory::addClassVersion( 'BFI_Image_Editor_GD', 'BFI_Image_Editor_GD_1_3', '1.3' ); class BFI_Image_Editor_GD_1_3 extends WP_Image_Editor_GD { /** Rotates current image counter-clockwise by $angle. * Ported from image-edit.php * Added presevation of alpha channels * * @since 3.5.0 * @access public * * @param float $angle * * @return boolean|WP_Error */ public function rotate( $angle ) { if ( function_exists( 'imagerotate' ) ) { $rotated = imagerotate( $this->image, $angle, 0 ); // Add alpha blending imagealphablending( $rotated, true ); imagesavealpha( $rotated, true ); if ( is_resource( $rotated ) ) { imagedestroy( $this->image ); $this->image = $rotated; $this->update_size(); return true; } } return new WP_Error( 'image_rotate_error', 'Image rotate failed.', $this->file ); } /** Changes the opacity of the image * * @supports 3.5.1 * @access public * * @param float $opacity (0.0-1.0) * * @return boolean|WP_Error */ public function opacity( $opacity ) { $opacity /= 100; $filtered = $this->_opacity( $this->image, $opacity ); if ( is_resource( $filtered ) ) { // imagedestroy($this->image); $this->image = $filtered; return true; } return new WP_Error( 'image_opacity_error', 'Image opacity change failed.', $this->file ); } // from: http://php.net/manual/en/function.imagefilter.php // params: image resource id, opacity (eg. 0.0-1.0) protected function _opacity( $image, $opacity ) { if ( ! function_exists( 'imagealphablending' ) || ! function_exists( 'imagecolorat' ) || ! function_exists( 'imagecolorallocatealpha' ) || ! function_exists( 'imagesetpixel' ) ) { return false; } // get image width and height $w = imagesx( $image ); $h = imagesy( $image ); // turn alpha blending off imagealphablending( $image, false ); // find the most opaque pixel in the image (the one with the smallest alpha value) $minalpha = 127; for ( $x = 0; $x < $w; $x++ ) { for ( $y = 0; $y < $h; $y++ ) { $alpha = ( imagecolorat( $image, $x, $y ) >> 24 ) & 0xFF; if ( $alpha < $minalpha ) { $minalpha = $alpha; } } } // loop through image pixels and modify alpha for each for ( $x = 0; $x < $w; $x++ ) { for ( $y = 0; $y < $h; $y++ ) { // get current alpha value (represents the TANSPARENCY!) $colorxy = imagecolorat( $image, $x, $y ); $alpha = ( $colorxy >> 24 ) & 0xFF; // calculate new alpha if ( $minalpha !== 127 ) { $alpha = 127 + 127 * $opacity * ( $alpha - 127 ) / ( 127 - $minalpha ); } else { $alpha += 127 * $opacity; } // get the color index with new alpha $alphacolorxy = imagecolorallocatealpha( $image, ( $colorxy >> 16 ) & 0xFF, ( $colorxy >> 8 ) & 0xFF, $colorxy & 0xFF, $alpha ); // set pixel with the new color + opacity if ( ! imagesetpixel( $image, $x, $y, $alphacolorxy ) ) { return false; } } } imagesavealpha( $image, true ); return $image; } /** Tints the image a different color * * @supports 3.5.1 * @access public * * @param string hex color e.g. #ff00ff * * @return boolean|WP_Error */ public function colorize( $hexColor ) { if ( function_exists( 'imagefilter' ) && function_exists( 'imagesavealpha' ) && function_exists( 'imagealphablending' ) ) { $hexColor = preg_replace( '#^\##', '', $hexColor ); $r = hexdec( substr( $hexColor, 0, 2 ) ); $g = hexdec( substr( $hexColor, 2, 2 ) ); $b = hexdec( substr( $hexColor, 2, 2 ) ); imagealphablending( $this->image, false ); if ( imagefilter( $this->image, IMG_FILTER_COLORIZE, $r, $g, $b, 0 ) ) { imagesavealpha( $this->image, true ); return true; } } return new WP_Error( 'image_colorize_error', 'Image color change failed.', $this->file ); } /** Makes the image grayscale * * @supports 3.5.1 * @access public * * @return boolean|WP_Error */ public function grayscale() { if ( function_exists( 'imagefilter' ) ) { if ( imagefilter( $this->image, IMG_FILTER_GRAYSCALE ) ) { return true; } } return new WP_Error( 'image_grayscale_error', 'Image grayscale failed.', $this->file ); } /** Negates the image * * @supports 3.5.1 * @access public * * @return boolean|WP_Error */ public function negate() { if ( function_exists( 'imagefilter' ) ) { if ( imagefilter( $this->image, IMG_FILTER_NEGATE ) ) { return true; } } return new WP_Error( 'image_negate_error', 'Image negate failed.', $this->file ); } } } /* * Main Class */ if ( ! class_exists( 'BFI_Thumb_1_3' ) ) { BFI_Class_Factory::addClassVersion( 'BFI_Thumb', 'BFI_Thumb_1_3', '1.3' ); class BFI_Thumb_1_3 { /** Uses WP's Image Editor Class to resize and filter images * Inspired by: https://github.com/sy4mil/Aqua-Resizer/blob/master/aq_resizer.php * * @param $url string the local image URL to manipulate * @param $params array the options to perform on the image. Keys and values supported: * 'width' int pixels * 'height' int pixels * 'opacity' int 0-100 * 'color' string hex-color #000000-#ffffff * 'grayscale' bool * 'crop' bool * 'negate' bool * 'crop_only' bool * 'crop_x' bool string * 'crop_y' bool string * 'crop_width' bool string * 'crop_height' bool string * 'quality' int 1-100 * @param $single boolean, if false then an array of data will be returned * * @return string|array */ public static function thumb( $url, $params = array(), $single = true ) { extract( $params ); //validate inputs if ( ! $url ) { return false; } $crop_only = isset( $crop_only ) ? $crop_only : false; //define upload path & dir $upload_info = wp_upload_dir(); $upload_dir = $upload_info['basedir']; $upload_url = $upload_info['baseurl']; $theme_url = get_template_directory_uri(); $theme_dir = get_template_directory(); // find the path of the image. Perform 2 checks: // #1 check if the image is in the uploads folder if ( strpos( $url, $upload_url ) !== false ) { $rel_path = str_replace( $upload_url, '', $url ); $img_path = $upload_dir . $rel_path; // #2 check if the image is in the current theme folder } else if ( strpos( $url, $theme_url ) !== false ) { $rel_path = str_replace( $theme_url, '', $url ); $img_path = $theme_dir . $rel_path; } // Fail if we can't find the image in our WP local directory if ( empty( $img_path ) ) { return $url; } // check if img path exists, and is an image indeed if ( ! @file_exists( $img_path ) || ! getimagesize( $img_path ) ) { return $url; } // This is the filename $basename = basename( $img_path ); //get image info $info = pathinfo( $img_path ); $ext = $info['extension']; list( $orig_w, $orig_h ) = getimagesize( $img_path ); // support percentage dimensions. compute percentage based on // the original dimensions if ( isset( $width ) ) { if ( stripos( $width, '%' ) !== false ) { $width = (int) ( (float) str_replace( '%', '', $width ) / 100 * $orig_w ); } } if ( isset( $height ) ) { if ( stripos( $height, '%' ) !== false ) { $height = (int) ( (float) str_replace( '%', '', $height ) / 100 * $orig_h ); } } // The only purpose of this is to determine the final width and height // without performing any actual image manipulation, which will be used // to check whether a resize was previously done. if ( isset( $width ) && $crop_only === false ) { //get image size after cropping $dims = image_resize_dimensions( $orig_w, $orig_h, $width, isset( $height ) ? $height : null, isset( $crop ) ? $crop : false ); $dst_w = $dims[4]; $dst_h = $dims[5]; } else if ( $crop_only === true ) { // we don't want a resize, // but only a crop in the image // get x position to start croping $src_x = ( isset( $crop_x ) ) ? $crop_x : 0; // get y position to start croping $src_y = ( isset( $crop_y ) ) ? $crop_y : 0; // width of the crop if ( isset( $crop_width ) ) { $src_w = $crop_width; } else if ( isset( $width ) ) { $src_w = $width; } else { $src_w = $orig_w; } // height of the crop if ( isset( $crop_height ) ) { $src_h = $crop_height; } else if ( isset( $height ) ) { $src_h = $height; } else { $src_h = $orig_h; } // set the width resize with the crop if ( isset( $crop_width ) && isset( $width ) ) { $dst_w = $width; } else { $dst_w = null; } // set the height resize with the crop if ( isset( $crop_height ) && isset( $height ) ) { $dst_h = $height; } else { $dst_h = null; } // allow percentages if ( isset( $dst_w ) ) { if ( stripos( $dst_w, '%' ) !== false ) { $dst_w = (int) ( (float) str_replace( '%', '', $dst_w ) / 100 * $orig_w ); } } if ( isset( $dst_h ) ) { if ( stripos( $dst_h, '%' ) !== false ) { $dst_h = (int) ( (float) str_replace( '%', '', $dst_h ) / 100 * $orig_h ); } } $dims = image_resize_dimensions( $src_w, $src_h, $dst_w, $dst_h, false ); $dst_w = $dims[4]; $dst_h = $dims[5]; // Make the pos x and pos y work with percentages if ( stripos( $src_x, '%' ) !== false ) { $src_x = (int) ( (float) str_replace( '%', '', $width ) / 100 * $orig_w ); } if ( stripos( $src_y, '%' ) !== false ) { $src_y = (int) ( (float) str_replace( '%', '', $height ) / 100 * $orig_h ); } // allow center to position crop start if ( $src_x === 'center' ) { $src_x = ( $orig_w - $src_w ) / 2; } if ( $src_y === 'center' ) { $src_y = ( $orig_h - $src_h ) / 2; } } // create the suffix for the saved file // we can use this to check whether we need to create a new file or just use an existing one. $suffix = (string) filemtime( $img_path ) . ( isset( $width ) ? str_pad( (string) $width, 5, '0', STR_PAD_LEFT ) : '00000' ) . ( isset( $height ) ? str_pad( (string) $height, 5, '0', STR_PAD_LEFT ) : '00000' ) . ( isset( $opacity ) ? str_pad( (string) $opacity, 3, '0', STR_PAD_LEFT ) : '100' ) . ( isset( $color ) ? str_pad( preg_replace( '#^\##', '', $color ), 8, '0', STR_PAD_LEFT ) : '00000000' ) . ( isset( $grayscale ) ? ( $grayscale ? '1' : '0' ) : '0' ) . ( isset( $crop ) ? ( $crop ? '1' : '0' ) : '0' ) . ( isset( $negate ) ? ( $negate ? '1' : '0' ) : '0' ) . ( isset( $crop_only ) ? ( $crop_only ? '1' : '0' ) : '0' ) . ( isset( $src_x ) ? str_pad( (string) $src_x, 5, '0', STR_PAD_LEFT ) : '00000' ) . ( isset( $src_y ) ? str_pad( (string) $src_y, 5, '0', STR_PAD_LEFT ) : '00000' ) . ( isset( $src_w ) ? str_pad( (string) $src_w, 5, '0', STR_PAD_LEFT ) : '00000' ) . ( isset( $src_h ) ? str_pad( (string) $src_h, 5, '0', STR_PAD_LEFT ) : '00000' ) . ( isset( $dst_w ) ? str_pad( (string) $dst_w, 5, '0', STR_PAD_LEFT ) : '00000' ) . ( isset( $dst_h ) ? str_pad( (string) $dst_h, 5, '0', STR_PAD_LEFT ) : '00000' ) . ( ( isset ( $quality ) && $quality > 0 && $quality <= 100 ) ? ( $quality ? (string) $quality : '0' ) : '0' ); $suffix = self::base_convert_arbitrary( $suffix, 10, 36 ); // use this to check if cropped image already exists, so we can return that instead $dst_rel_path = str_replace( '.' . $ext, '', basename( $img_path ) ); // If opacity is set, change the image type to png if ( isset( $opacity ) ) { $ext = 'png'; } // Create the upload subdirectory, this is where // we store all our generated images if ( defined( 'BFITHUMB_UPLOAD_DIR' ) ) { $upload_dir .= "/" . BFITHUMB_UPLOAD_DIR; $upload_url .= "/" . BFITHUMB_UPLOAD_DIR; } else { $upload_dir .= "/bfi_thumb"; $upload_url .= "/bfi_thumb"; } if ( ! is_dir( $upload_dir ) ) { wp_mkdir_p( $upload_dir ); } // desination paths and urls $destfilename = "{$upload_dir}/{$dst_rel_path}-{$suffix}.{$ext}"; // The urls generated have lower case extensions regardless of the original case $ext = strtolower( $ext ); $img_url = "{$upload_url}/{$dst_rel_path}-{$suffix}.{$ext}"; // if file exists, just return it if ( @file_exists( $destfilename ) && getimagesize( $destfilename ) ) { } else { // perform resizing and other filters $editor = wp_get_image_editor( $img_path ); if ( is_wp_error( $editor ) ) { return false; } /* * Perform image manipulations */ if ( $crop_only === false ) { if ( ( isset( $width ) && $width ) || ( isset( $height ) && $height ) ) { if ( is_wp_error( $editor->resize( isset( $width ) ? $width : null, isset( $height ) ? $height : null, isset( $crop ) ? $crop : false ) ) ) { return false; } } } else { if ( is_wp_error( $editor->crop( $src_x, $src_y, $src_w, $src_h, $dst_w, $dst_h ) ) ) { return false; } } if ( isset( $negate ) ) { if ( $negate ) { if ( is_wp_error( $editor->negate() ) ) { return false; } } } if ( isset( $opacity ) ) { if ( is_wp_error( $editor->opacity( $opacity ) ) ) { return false; } } if ( isset( $grayscale ) ) { if ( $grayscale ) { if ( is_wp_error( $editor->grayscale() ) ) { return false; } } } if ( isset( $color ) ) { if ( is_wp_error( $editor->colorize( $color ) ) ) { return false; } } // set the image quality (1-100) to save this image at if ( isset( $quality ) && $quality > 0 && $quality <= 100 && $ext != 'png' ) { $editor->set_quality( $quality ); } // save our new image $mime_type = isset( $opacity ) ? 'image/png' : null; $resized_file = $editor->save( $destfilename, $mime_type ); } //return the output if ( $single ) { $image = $img_url; } else { //array return $image = array( 0 => $img_url, 1 => isset( $dst_w ) ? $dst_w : $orig_w, 2 => isset( $dst_h ) ? $dst_h : $orig_h, ); } return $image; } /** Shortens a number into a base 36 string * * @param $number string a string of numbers to convert * @param $fromBase starting base * @param $toBase base to convert the number to * * @return string base converted characters */ protected static function base_convert_arbitrary( $number, $fromBase, $toBase ) { $digits = '0123456789abcdefghijklmnopqrstuvwxyz'; $length = strlen( $number ); $result = ''; $nibbles = array(); for ( $i = 0; $i < $length; ++$i ) { $nibbles[ $i ] = strpos( $digits, $number[ $i ] ); } do { $value = 0; $newlen = 0; for ( $i = 0; $i < $length; ++$i ) { $value = $value * $fromBase + $nibbles[ $i ]; if ( $value >= $toBase ) { $nibbles[ $newlen++ ] = (int) ( $value / $toBase ); $value %= $toBase; } else if ( $newlen > 0 ) { $nibbles[ $newlen++ ] = 0; } } $length = $newlen; $result = $digits[ $value ] . $result; } while ( $newlen != 0 ); return $result; } } } // don't use the default resizer since we want to allow resizing to larger sizes (than the original one) // Parts are copied from media.php // Crop is always applied (just like timthumb) // Don't use this inside the admin since sometimes images in the media library get resized if ( ! is_admin() ) { add_filter( 'image_resize_dimensions', 'bfi_image_resize_dimensions', 10, 5 ); } if ( ! function_exists( 'bfi_image_resize_dimensions' ) ) { function bfi_image_resize_dimensions( $payload, $orig_w, $orig_h, $dest_w, $dest_h, $crop = false ) { $aspect_ratio = $orig_w / $orig_h; $new_w = $dest_w; $new_h = $dest_h; if ( empty( $new_w ) || $new_w < 0 ) { $new_w = intval( $new_h * $aspect_ratio ); } if ( empty( $new_h ) || $new_h < 0 ) { $new_h = intval( $new_w / $aspect_ratio ); } $size_ratio = max( $new_w / $orig_w, $new_h / $orig_h ); $crop_w = round( $new_w / $size_ratio ); $crop_h = round( $new_h / $size_ratio ); $s_x = floor( ( $orig_w - $crop_w ) / 2 ); $s_y = floor( ( $orig_h - $crop_h ) / 2 ); // Safe guard against super large or zero images which might cause 500 errors if ( $new_w > 5000 || $new_h > 5000 || $new_w <= 0 || $new_h <= 0 ) { return null; } // the return array matches the parameters to imagecopyresampled() // int dst_x, int dst_y, int src_x, int src_y, int dst_w, int dst_h, int src_w, int src_h return array( 0, 0, (int) $s_x, (int) $s_y, (int) $new_w, (int) $new_h, (int) $crop_w, (int) $crop_h ); } } // This function allows us to latch on WP image functions such as // the_post_thumbnail, get_image_tag and wp_get_attachment_image_src // so that you won't have to use the function bfi_thumb in order to do resizing. // To make this work, in the WP image functions, when specifying an // array for the image dimensions, add a 'bfi_thumb' => true to // the array, then add your normal $params arguments. // // e.g. the_post_thumbnail( array( 1024, 400, 'bfi_thumb' => true, 'grayscale' => true ) ); add_filter( 'image_downsize', 'bfi_image_downsize', 1, 3 ); if ( ! function_exists( 'bfi_image_downsize' ) ) { function bfi_image_downsize( $out, $id, $size ) { if ( ! is_array( $size ) ) { return false; } if ( ! array_key_exists( 'bfi_thumb', $size ) ) { return false; } if ( empty( $size['bfi_thumb'] ) ) { return false; } $img_url = wp_get_attachment_url( $id ); $params = $size; $params['width'] = $size[0]; $params['height'] = $size[1]; $resized_img_url = bfi_thumb( $img_url, $params ); return array( $resized_img_url, $size[0], $size[1], false ); } } wp-background-process/wp-background-process.php000066600000025363152141441240015726 0ustar00cron_hook_identifier = $this->identifier . '_cron'; $this->cron_interval_identifier = $this->identifier . '_cron_interval'; add_action( $this->cron_hook_identifier, array( $this, 'handle_cron_healthcheck' ) ); add_filter( 'cron_schedules', array( $this, 'schedule_cron_healthcheck' ) ); } /** * Dispatch * * @access public * @return void */ public function dispatch() { // Schedule the cron healthcheck. $this->schedule_event(); // Perform remote post. return parent::dispatch(); } /** * Push to queue * * @param mixed $data Data. * * @return $this */ public function push_to_queue( $data ) { $this->data[] = $data; return $this; } /** * Save queue * * @return $this */ public function save() { $key = $this->generate_key(); if ( ! empty( $this->data ) ) { update_site_option( $key, $this->data ); } return $this; } /** * Update queue * * @param string $key Key. * @param array $data Data. * * @return $this */ public function update( $key, $data ) { if ( ! empty( $data ) ) { update_site_option( $key, $data ); } return $this; } /** * Delete queue * * @param string $key Key. * * @return $this */ public function delete( $key ) { delete_site_option( $key ); return $this; } /** * Generate key * * Generates a unique key based on microtime. Queue items are * given a unique key so that they can be merged upon save. * * @param int $length Length. * * @return string */ protected function generate_key( $length = 64 ) { $unique = md5( microtime() . rand() ); $prepend = $this->identifier . '_batch_'; return substr( $prepend . $unique, 0, $length ); } /** * Maybe process queue * * Checks whether data exists within the queue and that * the process is not already running. */ public function maybe_handle() { // Don't lock up other requests while processing session_write_close(); if ( $this->is_process_running() ) { // Background process already running. wp_die(); } if ( $this->is_queue_empty() ) { // No data to process. wp_die(); } check_ajax_referer( $this->identifier, 'nonce' ); $this->handle(); wp_die(); } /** * Is queue empty * * @return bool */ protected function is_queue_empty() { global $wpdb; $table = $wpdb->options; $column = 'option_name'; if ( is_multisite() ) { $table = $wpdb->sitemeta; $column = 'meta_key'; } $key = $wpdb->esc_like( $this->identifier . '_batch_' ) . '%'; $count = $wpdb->get_var( $wpdb->prepare( " SELECT COUNT(*) FROM {$table} WHERE {$column} LIKE %s ", $key ) ); return ( $count > 0 ) ? false : true; } /** * Is process running * * Check whether the current process is already running * in a background process. */ protected function is_process_running() { if ( get_site_transient( $this->identifier . '_process_lock' ) ) { // Process already running. return true; } return false; } /** * Lock process * * Lock the process so that multiple instances can't run simultaneously. * Override if applicable, but the duration should be greater than that * defined in the time_exceeded() method. */ protected function lock_process() { $this->start_time = time(); // Set start time of current process. $lock_duration = ( property_exists( $this, 'queue_lock_time' ) ) ? $this->queue_lock_time : 60; // 1 minute $lock_duration = apply_filters( $this->identifier . '_queue_lock_time', $lock_duration ); set_site_transient( $this->identifier . '_process_lock', microtime(), $lock_duration ); } /** * Unlock process * * Unlock the process so that other instances can spawn. * * @return $this */ protected function unlock_process() { delete_site_transient( $this->identifier . '_process_lock' ); return $this; } /** * Get batch * * @return stdClass Return the first batch from the queue */ protected function get_batch() { global $wpdb; $table = $wpdb->options; $column = 'option_name'; $key_column = 'option_id'; $value_column = 'option_value'; if ( is_multisite() ) { $table = $wpdb->sitemeta; $column = 'meta_key'; $key_column = 'meta_id'; $value_column = 'meta_value'; } $key = $wpdb->esc_like( $this->identifier . '_batch_' ) . '%'; $query = $wpdb->get_row( $wpdb->prepare( " SELECT * FROM {$table} WHERE {$column} LIKE %s ORDER BY {$key_column} ASC LIMIT 1 ", $key ) ); $batch = new stdClass(); $batch->key = $query->$column; $batch->data = maybe_unserialize( $query->$value_column ); return $batch; } /** * Handle * * Pass each queue item to the task handler, while remaining * within server memory and time limit constraints. */ protected function handle() { $this->lock_process(); do { $batch = $this->get_batch(); foreach ( $batch->data as $key => $value ) { $task = $this->task( $value ); if ( false !== $task ) { $batch->data[ $key ] = $task; } else { unset( $batch->data[ $key ] ); } if ( $this->time_exceeded() || $this->memory_exceeded() ) { // Batch limits reached. break; } } // Update or delete current batch. if ( ! empty( $batch->data ) ) { $this->update( $batch->key, $batch->data ); } else { $this->delete( $batch->key ); } } while ( ! $this->time_exceeded() && ! $this->memory_exceeded() && ! $this->is_queue_empty() ); $this->unlock_process(); // Start next batch or complete process. if ( ! $this->is_queue_empty() ) { $this->dispatch(); } else { $this->complete(); } wp_die(); } /** * Memory exceeded * * Ensures the batch process never exceeds 90% * of the maximum WordPress memory. * * @return bool */ protected function memory_exceeded() { $memory_limit = $this->get_memory_limit() * 0.9; // 90% of max memory $current_memory = memory_get_usage( true ); $return = false; if ( $current_memory >= $memory_limit ) { $return = true; } return apply_filters( $this->identifier . '_memory_exceeded', $return ); } /** * Get memory limit * * @return int */ protected function get_memory_limit() { if ( function_exists( 'ini_get' ) ) { $memory_limit = ini_get( 'memory_limit' ); } else { // Sensible default. $memory_limit = '128M'; } if ( ! $memory_limit || -1 === intval( $memory_limit ) ) { // Unlimited, set to 32GB. $memory_limit = '32000M'; } return intval( $memory_limit ) * 1024 * 1024; } /** * Time exceeded. * * Ensures the batch never exceeds a sensible time limit. * A timeout limit of 30s is common on shared hosting. * * @return bool */ protected function time_exceeded() { $finish = $this->start_time + apply_filters( $this->identifier . '_default_time_limit', 20 ); // 20 seconds $return = false; if ( time() >= $finish ) { $return = true; } return apply_filters( $this->identifier . '_time_exceeded', $return ); } /** * Complete. * * Override if applicable, but ensure that the below actions are * performed, or, call parent::complete(). */ protected function complete() { // Unschedule the cron healthcheck. $this->clear_scheduled_event(); } /** * Schedule cron healthcheck * * @access public * @param mixed $schedules Schedules. * @return mixed */ public function schedule_cron_healthcheck( $schedules ) { $interval = apply_filters( $this->identifier . '_cron_interval', 5 ); if ( property_exists( $this, 'cron_interval' ) ) { $interval = apply_filters( $this->identifier . '_cron_interval', $this->cron_interval ); } // Adds every 5 minutes to the existing schedules. $schedules[ $this->identifier . '_cron_interval' ] = array( 'interval' => MINUTE_IN_SECONDS * $interval, 'display' => sprintf( __( 'Every %d Minutes', 'elementor' ), $interval ), ); return $schedules; } /** * Handle cron healthcheck * * Restart the background process if not already running * and data exists in the queue. */ public function handle_cron_healthcheck() { if ( $this->is_process_running() ) { // Background process already running. exit; } if ( $this->is_queue_empty() ) { // No data to process. $this->clear_scheduled_event(); exit; } $this->handle(); exit; } /** * Schedule event */ protected function schedule_event() { if ( ! wp_next_scheduled( $this->cron_hook_identifier ) ) { wp_schedule_event( time(), $this->cron_interval_identifier, $this->cron_hook_identifier ); } } /** * Clear scheduled event */ protected function clear_scheduled_event() { $timestamp = wp_next_scheduled( $this->cron_hook_identifier ); if ( $timestamp ) { wp_unschedule_event( $timestamp, $this->cron_hook_identifier ); } } /** * Cancel Process * * Stop processing queue items, clear cronjob and delete batch. * */ public function cancel_process() { if ( ! $this->is_queue_empty() ) { $batch = $this->get_batch(); $this->delete( $batch->key ); wp_clear_scheduled_hook( $this->cron_hook_identifier ); } } /** * Task * * Override this method to perform any actions required on each * queue item. Return the modified item for further processing * in the next pass through. Or, return false to remove the * item from the queue. * * @param mixed $item Queue item to iterate over. * * @return mixed */ abstract protected function task( $item ); } } wp-background-process/wp-async-request.php000066600000005671152141441240014736 0ustar00identifier = $this->prefix . '_' . $this->action; add_action( 'wp_ajax_' . $this->identifier, array( $this, 'maybe_handle' ) ); add_action( 'wp_ajax_nopriv_' . $this->identifier, array( $this, 'maybe_handle' ) ); } /** * Set data used during the request * * @param array $data Data. * * @return $this */ public function data( $data ) { $this->data = $data; return $this; } /** * Dispatch the async request * * @return array|WP_Error */ public function dispatch() { $url = add_query_arg( $this->get_query_args(), $this->get_query_url() ); $args = $this->get_post_args(); return wp_remote_post( esc_url_raw( $url ), $args ); } /** * Get query args * * @return array */ protected function get_query_args() { if ( property_exists( $this, 'query_args' ) ) { return $this->query_args; } return array( 'action' => $this->identifier, 'nonce' => wp_create_nonce( $this->identifier ), ); } /** * Get query URL * * @return string */ protected function get_query_url() { if ( property_exists( $this, 'query_url' ) ) { return $this->query_url; } return admin_url( 'admin-ajax.php' ); } /** * Get post args * * @return array */ protected function get_post_args() { if ( property_exists( $this, 'post_args' ) ) { return $this->post_args; } return array( 'timeout' => 0.01, 'blocking' => false, 'body' => $this->data, 'cookies' => $_COOKIE, 'sslverify' => apply_filters( 'https_local_ssl_verify', false ), ); } /** * Maybe handle * * Check for correct nonce and pass to handler. */ public function maybe_handle() { // Don't lock up other requests while processing session_write_close(); check_ajax_referer( $this->identifier, 'nonce' ); $this->handle(); wp_die(); } /** * Handle * * Override this method to perform any actions required * during the async request. */ abstract protected function handle(); } }