/**
* Plugin Name: Ivory Search
* Plugin URI: https://ivorysearch.com
* Description: The WordPress Search plugin that provides Search Form Customizer, WooCommerce Search, Image Search, Search Shortcode, AJAX Search & Live Search support!
* Version: 5.5.11
* Author: Ivory Search
* Author URI: https://ivorysearch.com/
* License: GPL2+
* License URI: https://www.gnu.org/licenses/gpl-2.0.txt
* Domain Path: /languages/
* Text Domain: add-search-to-menu
*
*
* WC tested up to: 9
*
* Ivory Search is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* any later version.
*
* Ivory Search is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Ivory Search. If not, see https://www.gnu.org/licenses/gpl-2.0.html.
*/
/**
* Includes necessary dependencies and starts the plugin.
*
* @package IS
*/
if ( !defined( 'ABSPATH' ) ) {
exit;
// Exits if accessed directly.
}
if ( function_exists( 'is_fs' ) ) {
is_fs()->set_basename( false, __FILE__ );
return;
}
/**
* Main Ivory Search Class.
*
* @class Ivory_Search
*/
final class Ivory_Search {
/**
* Core singleton class
* @var self
*/
private static $_instance;
/**
* Gets the instance of this class.
*
* @return self
*/
public static function getInstance() {
if ( !self::$_instance instanceof self ) {
self::$_instance = new self();
}
return self::$_instance;
}
/**
* Defines Ivory Search Constants.
*/
public function define_constants() {
if ( !defined( 'IS_VERSION' ) ) {
define( 'IS_VERSION', '5.5.11' );
}
if ( !defined( 'IS_PLUGIN_FILE' ) ) {
define( 'IS_PLUGIN_FILE', __FILE__ );
}
if ( !defined( 'IS_PLUGIN_BASE' ) ) {
define( 'IS_PLUGIN_BASE', plugin_basename( IS_PLUGIN_FILE ) );
}
if ( !defined( 'IS_PLUGIN_DIR' ) ) {
define( 'IS_PLUGIN_DIR', plugin_dir_path( IS_PLUGIN_FILE ) );
}
if ( !defined( 'IS_PLUGIN_URI' ) ) {
define( 'IS_PLUGIN_URI', plugins_url( '/', IS_PLUGIN_FILE ) );
}
if ( !defined( 'IS_ADMIN_READ_CAPABILITY' ) ) {
define( 'IS_ADMIN_READ_CAPABILITY', 'edit_posts' );
}
if ( !defined( 'IS_ADMIN_READ_WRITE_CAPABILITY' ) ) {
define( 'IS_ADMIN_READ_WRITE_CAPABILITY', 'publish_pages' );
}
}
/**
* Includes required core files used in admin and on the frontend.
*/
public function includes() {
/**
* Common Files
*/
require_once IS_PLUGIN_DIR . 'includes/base-functions.php';
require_once IS_PLUGIN_DIR . 'includes/class-is-activator.php';
require_once IS_PLUGIN_DIR . 'includes/class-is-admin-public.php';
require_once IS_PLUGIN_DIR . 'includes/class-is-base-options.php';
require_once IS_PLUGIN_DIR . 'includes/class-is-customizer-panel.php';
require_once IS_PLUGIN_DIR . 'includes/class-is-customizer.php';
require_once IS_PLUGIN_DIR . 'includes/class-is-deactivator.php';
require_once IS_PLUGIN_DIR . 'includes/class-is-debug.php';
require_once IS_PLUGIN_DIR . 'includes/class-is-i18n.php';
require_once IS_PLUGIN_DIR . 'includes/class-is-index-builder.php';
require_once IS_PLUGIN_DIR . 'includes/class-is-index-helper.php';
require_once IS_PLUGIN_DIR . 'includes/class-is-index-manager.php';
require_once IS_PLUGIN_DIR . 'includes/class-is-index-match.php';
require_once IS_PLUGIN_DIR . 'includes/class-is-index-matches.php';
require_once IS_PLUGIN_DIR . 'includes/class-is-index-model.php';
require_once IS_PLUGIN_DIR . 'includes/class-is-index-options.php';
require_once IS_PLUGIN_DIR . 'includes/class-is.php';
require_once IS_PLUGIN_DIR . 'includes/class-is-search-form.php';
require_once IS_PLUGIN_DIR . 'includes/class-is-widget.php';
if ( is_admin() || defined( 'DOING_AJAX' ) && DOING_AJAX ) {
/**
* Admin Files
*/
require_once IS_PLUGIN_DIR . 'admin/class-is-admin.php';
require_once IS_PLUGIN_DIR . 'admin/class-is-editor.php';
require_once IS_PLUGIN_DIR . 'admin/class-is-help.php';
require_once IS_PLUGIN_DIR . 'admin/class-is-list-table.php';
require_once IS_PLUGIN_DIR . 'admin/class-is-settings-fields.php';
require_once IS_PLUGIN_DIR . 'admin/class-is-settings-index-fields.php';
if ( class_exists( 'TablePress' ) ) {
require_once IS_PLUGIN_DIR . 'includes/compatibility/class-is-tablepress-compat.php';
}
}
if ( !is_admin() || defined( 'DOING_AJAX' ) && DOING_AJAX ) {
/**
* Public Files
*/
require_once IS_PLUGIN_DIR . 'public/class-is-ajax.php';
require_once IS_PLUGIN_DIR . 'public/class-is-public.php';
require_once IS_PLUGIN_DIR . 'public/class-is-index-search.php';
}
}
/**
* Hooks into initialization actions and filters.
*/
public function register_activ_deactiv_hooks() {
// Executes necessary actions on plugin activation and deactivation.
register_activation_hook( IS_PLUGIN_FILE, array('IS_Activator', 'activate') );
register_deactivation_hook( IS_PLUGIN_FILE, array('IS_Deactivator', 'deactivate') );
}
/**
* Starts plugin execution.
*/
function start() {
$is_loader = IS_Loader::getInstance();
$is_loader->load();
}
}
/**
* Starts plugin execution.
*/
function ivory_search_start() {
$is = Ivory_Search::getInstance();
$is->start();
}
add_action( 'plugins_loaded', 'ivory_search_start' );
/**
* Freemius needs to be loaded before plugins_loaded.
* Otherwise, the fs register_unistall_hook will get
* Freemius not defined.
*
* @since 5.0
*/
$is = Ivory_Search::getInstance();
$is->define_constants();
require_once IS_PLUGIN_DIR . 'includes/freemius.php';
/**
* Registering these hooks inside the 'plugins_loaded' or 'init' hooks will not work.
*
* @since 5.4.9
*/
$is->includes();
$is->register_activ_deactiv_hooks();
declare (strict_types=1);
namespace ElementorDeps\DI;
use ElementorDeps\DI\Definition\ArrayDefinitionExtension;
use ElementorDeps\DI\Definition\EnvironmentVariableDefinition;
use ElementorDeps\DI\Definition\Helper\AutowireDefinitionHelper;
use ElementorDeps\DI\Definition\Helper\CreateDefinitionHelper;
use ElementorDeps\DI\Definition\Helper\FactoryDefinitionHelper;
use ElementorDeps\DI\Definition\Reference;
use ElementorDeps\DI\Definition\StringDefinition;
use ElementorDeps\DI\Definition\ValueDefinition;
if (!\function_exists('ElementorDeps\\DI\\value')) {
/**
* Helper for defining a value.
*
* @param mixed $value
*/
function value($value) : ValueDefinition
{
return new ValueDefinition($value);
}
}
if (!\function_exists('ElementorDeps\\DI\\create')) {
/**
* Helper for defining an object.
*
* @param string|null $className Class name of the object.
* If null, the name of the entry (in the container) will be used as class name.
*/
function create(string $className = null) : CreateDefinitionHelper
{
return new CreateDefinitionHelper($className);
}
}
if (!\function_exists('ElementorDeps\\DI\\autowire')) {
/**
* Helper for autowiring an object.
*
* @param string|null $className Class name of the object.
* If null, the name of the entry (in the container) will be used as class name.
*/
function autowire(string $className = null) : AutowireDefinitionHelper
{
return new AutowireDefinitionHelper($className);
}
}
if (!\function_exists('ElementorDeps\\DI\\factory')) {
/**
* Helper for defining a container entry using a factory function/callable.
*
* @param callable $factory The factory is a callable that takes the container as parameter
* and returns the value to register in the container.
*/
function factory($factory) : FactoryDefinitionHelper
{
return new FactoryDefinitionHelper($factory);
}
}
if (!\function_exists('ElementorDeps\\DI\\decorate')) {
/**
* Decorate the previous definition using a callable.
*
* Example:
*
* 'foo' => decorate(function ($foo, $container) {
* return new CachedFoo($foo, $container->get('cache'));
* })
*
* @param callable $callable The callable takes the decorated object as first parameter and
* the container as second.
*/
function decorate($callable) : FactoryDefinitionHelper
{
return new FactoryDefinitionHelper($callable, \true);
}
}
if (!\function_exists('ElementorDeps\\DI\\get')) {
/**
* Helper for referencing another container entry in an object definition.
*/
function get(string $entryName) : Reference
{
return new Reference($entryName);
}
}
if (!\function_exists('ElementorDeps\\DI\\env')) {
/**
* Helper for referencing environment variables.
*
* @param string $variableName The name of the environment variable.
* @param mixed $defaultValue The default value to be used if the environment variable is not defined.
*/
function env(string $variableName, $defaultValue = null) : EnvironmentVariableDefinition
{
// Only mark as optional if the default value was *explicitly* provided.
$isOptional = 2 === \func_num_args();
return new EnvironmentVariableDefinition($variableName, $isOptional, $defaultValue);
}
}
if (!\function_exists('ElementorDeps\\DI\\add')) {
/**
* Helper for extending another definition.
*
* Example:
*
* 'log.backends' => DI\add(DI\get('My\Custom\LogBackend'))
*
* or:
*
* 'log.backends' => DI\add([
* DI\get('My\Custom\LogBackend')
* ])
*
* @param mixed|array $values A value or an array of values to add to the array.
*
* @since 5.0
*/
function add($values) : ArrayDefinitionExtension
{
if (!\is_array($values)) {
$values = [$values];
}
return new ArrayDefinitionExtension($values);
}
}
if (!\function_exists('ElementorDeps\\DI\\string')) {
/**
* Helper for concatenating strings.
*
* Example:
*
* 'log.filename' => DI\string('{app.path}/app.log')
*
* @param string $expression A string expression. Use the `{}` placeholders to reference other container entries.
*
* @since 5.0
*/
function string(string $expression) : StringDefinition
{
return new StringDefinition($expression);
}
}
if (!defined('ABSPATH')) die('No direct access.');
/**
* Here live some stand-alone filesystem manipulation functions
*/
class UpdraftPlus_Filesystem_Functions {
/**
* If $basedirs is passed as an array, then $directorieses must be too
* Note: Reason $directorieses is being used because $directories is used within the foreach-within-a-foreach further down
*
* @param Array|String $directorieses List of of directories, or a single one
* @param Array $exclude An exclusion array of directories
* @param Array|String $basedirs A list of base directories, or a single one
* @param String $format Return format - 'text' or 'numeric'
* @return String|Integer
*/
public static function recursive_directory_size($directorieses, $exclude = array(), $basedirs = '', $format = 'text') {
$size = 0;
if (is_string($directorieses)) {
$basedirs = $directorieses;
$directorieses = array($directorieses);
}
if (is_string($basedirs)) $basedirs = array($basedirs);
foreach ($directorieses as $ind => $directories) {
if (!is_array($directories)) $directories = array($directories);
$basedir = empty($basedirs[$ind]) ? $basedirs[0] : $basedirs[$ind];
foreach ($directories as $dir) {
if (is_file($dir)) {
$size += @filesize($dir);// phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged -- Silenced to suppress errors that may arise because of the function.
} else {
$suffix = ('' != $basedir) ? ((0 === strpos($dir, $basedir.'/')) ? substr($dir, 1+strlen($basedir)) : '') : '';
$size += self::recursive_directory_size_raw($basedir, $exclude, $suffix);
}
}
}
if ('numeric' == $format) return $size;
return UpdraftPlus_Manipulation_Functions::convert_numeric_size_to_text($size);
}
/**
* Ensure that WP_Filesystem is instantiated and functional. Otherwise, outputs necessary HTML and dies.
*
* @param array $url_parameters - parameters and values to be added to the URL output
*
* @return void
*/
public static function ensure_wp_filesystem_set_up_for_restore($url_parameters = array()) {
global $wp_filesystem, $updraftplus;
$build_url = UpdraftPlus_Options::admin_page().'?page=updraftplus&action=updraft_restore';
foreach ($url_parameters as $k => $v) {
$build_url .= '&'.$k.'='.$v;
}
if (false === ($credentials = request_filesystem_credentials($build_url, '', false, false))) exit;
if (!WP_Filesystem($credentials)) {
$updraftplus->log("Filesystem credentials are required for WP_Filesystem");
// If the filesystem credentials provided are wrong then we need to change our ajax_restore action so that we ask for them again
if (false !== strpos($build_url, 'updraftplus_ajax_restore=do_ajax_restore')) $build_url = str_replace('updraftplus_ajax_restore=do_ajax_restore', 'updraftplus_ajax_restore=continue_ajax_restore', $build_url);
request_filesystem_credentials($build_url, '', true, false);
if ($wp_filesystem->errors->get_error_code()) {
echo '
';
exit;
}
}
}
/**
* Get the html of "Web-server disk space" line which resides above of the existing backup table
*
* @param Boolean $will_immediately_calculate_disk_space Whether disk space should be counted now or when user click Refresh link
*
* @return String Web server disk space html to render
*/
public static function web_server_disk_space($will_immediately_calculate_disk_space = true) {
if ($will_immediately_calculate_disk_space) {
$disk_space_used = self::get_disk_space_used('updraft', 'numeric');
if ($disk_space_used > apply_filters('updraftplus_display_usage_line_threshold_size', 104857600)) { // 104857600 = 100 MB = (100 * 1024 * 1024)
$disk_space_text = UpdraftPlus_Manipulation_Functions::convert_numeric_size_to_text($disk_space_used);
$refresh_link_text = __('refresh', 'updraftplus');
return self::web_server_disk_space_html($disk_space_text, $refresh_link_text);
} else {
return '';
}
} else {
$disk_space_text = '';
$refresh_link_text = __('calculate', 'updraftplus');
return self::web_server_disk_space_html($disk_space_text, $refresh_link_text);
}
}
/**
* Get the html of "Web-server disk space" line which resides above of the existing backup table
*
* @param String $disk_space_text The texts which represents disk space usage
* @param String $refresh_link_text Refresh disk space link text
*
* @return String - Web server disk space HTML
*/
public static function web_server_disk_space_html($disk_space_text, $refresh_link_text) {
return ''.__('Web-server disk space in use by UpdraftPlus', 'updraftplus').': '.$disk_space_text.' '.$refresh_link_text.'';
}
/**
* Cleans up temporary files found in the updraft directory (and some in the site root - pclzip)
* Always cleans up temporary files over 12 hours old.
* With parameters, also cleans up those.
* Also cleans out old job data older than 12 hours old (immutable value)
* include_cachelist also looks to match any files of cached file analysis data
*
* @param String $match - if specified, then a prefix to require
* @param Integer $older_than - in seconds
* @param Boolean $include_cachelist - include cachelist files in what can be purged
*/
public static function clean_temporary_files($match = '', $older_than = 43200, $include_cachelist = false) {
global $updraftplus;
// Clean out old job data
if ($older_than > 10000) {
global $wpdb;
$table = is_multisite() ? $wpdb->sitemeta : $wpdb->options;
$key_column = is_multisite() ? 'meta_key' : 'option_name';
$value_column = is_multisite() ? 'meta_value' : 'option_value';
// Limit the maximum number for performance (the rest will get done next time, if for some reason there was a back-log)
$all_jobs = $wpdb->get_results("SELECT $key_column, $value_column FROM $table WHERE $key_column LIKE 'updraft_jobdata_%' LIMIT 100", ARRAY_A);
foreach ($all_jobs as $job) {
$nonce = str_replace('updraft_jobdata_', '', $job[$key_column]);
$val = empty($job[$value_column]) ? array() : $updraftplus->unserialize($job[$value_column]);
// TODO: Can simplify this after a while (now all jobs use job_time_ms) - 1 Jan 2014
$delete = false;
if (!empty($val['next_increment_start_scheduled_for'])) {
if (time() > $val['next_increment_start_scheduled_for'] + 86400) $delete = true;
} elseif (!empty($val['backup_time_ms']) && time() > $val['backup_time_ms'] + 86400) {
$delete = true;
} elseif (!empty($val['job_time_ms']) && time() > $val['job_time_ms'] + 86400) {
$delete = true;
} elseif (!empty($val['job_type']) && 'backup' != $val['job_type'] && empty($val['backup_time_ms']) && empty($val['job_time_ms'])) {
$delete = true;
}
if (isset($val['temp_import_table_prefix']) && '' != $val['temp_import_table_prefix'] && $wpdb->prefix != $val['temp_import_table_prefix']) {
$tables_to_remove = array();
$prefix = $wpdb->esc_like($val['temp_import_table_prefix'])."%";
$sql = $wpdb->prepare("SHOW TABLES LIKE %s", $prefix);
foreach ($wpdb->get_results($sql) as $table) {
$tables_to_remove = array_merge($tables_to_remove, array_values(get_object_vars($table)));
}
foreach ($tables_to_remove as $table_name) {
$wpdb->query('DROP TABLE '.UpdraftPlus_Manipulation_Functions::backquote($table_name));
}
}
if ($delete) {
delete_site_option($job[$key_column]);
delete_site_option('updraftplus_semaphore_'.$nonce);
}
}
}
$updraft_dir = $updraftplus->backups_dir_location();
$now_time = time();
$files_deleted = 0;
$include_cachelist = defined('DOING_CRON') && DOING_CRON && doing_action('updraftplus_clean_temporary_files') ? true : $include_cachelist;
if ($handle = opendir($updraft_dir)) {
while (false !== ($entry = readdir($handle))) {
$manifest_match = preg_match("/updraftplus-manifest\.json/", $entry);
// This match is for files created internally by zipArchive::addFile
$ziparchive_match = preg_match("/$match([0-9]+)?\.zip\.tmp\.(?:[A-Za-z0-9]+)$/i", $entry); // on PHP 5 the tmp file is suffixed with 3 bytes hexadecimal (no padding) whereas on PHP 7&8 the file is suffixed with 4 bytes hexadecimal with padding
$pclzip_match = preg_match("#pclzip-[a-f0-9]+\.(?:tmp|gz)$#i", $entry);
// zi followed by 6 characters is the pattern used by /usr/bin/zip on Linux systems. It's safe to check for, as we have nothing else that's going to match that pattern.
$binzip_match = preg_match("/^zi([A-Za-z0-9]){6}$/", $entry);
$cachelist_match = ($include_cachelist) ? preg_match("/-cachelist-.*(?:info|\.tmp)$/i", $entry) : false;
$browserlog_match = preg_match('/^log\.[0-9a-f]+-browser\.txt$/', $entry);
$downloader_client_match = preg_match("/$match([0-9]+)?\.zip\.tmp\.(?:[A-Za-z0-9]+)\.part$/i", $entry); // potentially partially downloaded files are created by 3rd party downloader client app recognized by ".part" extension at the end of the backup file name (e.g. .zip.tmp.3b9r8r.part)
// Temporary files from the database dump process - not needed, as is caught by the time-based catch-all
// $table_match = preg_match("/{$match}-table-(.*)\.table(\.tmp)?\.gz$/i", $entry);
// The gz goes in with the txt, because we *don't* want to reap the raw .txt files
if ((preg_match("/$match\.(tmp|table|txt\.gz)(\.gz)?$/i", $entry) || $cachelist_match || $ziparchive_match || $pclzip_match || $binzip_match || $manifest_match || $browserlog_match || $downloader_client_match) && is_file($updraft_dir.'/'.$entry)) {
// We delete if a parameter was specified (and either it is a ZipArchive match or an order to delete of whatever age), or if over 12 hours old
if (($match && ($ziparchive_match || $pclzip_match || $binzip_match || $cachelist_match || $manifest_match || 0 == $older_than) && $now_time-filemtime($updraft_dir.'/'.$entry) >= $older_than) || $now_time-filemtime($updraft_dir.'/'.$entry)>43200) {
$skip_dblog = (0 == $files_deleted % 25) ? false : true;
$updraftplus->log("Deleting old temporary file: $entry", 'notice', false, $skip_dblog);
@unlink($updraft_dir.'/'.$entry);// phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged -- Silenced to suppress errors that may arise if the file doesn't exist.
$files_deleted++;
}
} elseif (preg_match('/^log\.[0-9a-f]+\.txt$/', $entry) && $now_time-filemtime($updraft_dir.'/'.$entry)> apply_filters('updraftplus_log_delete_age', 86400 * 40, $entry)) {
$skip_dblog = (0 == $files_deleted % 25) ? false : true;
$updraftplus->log("Deleting old log file: $entry", 'notice', false, $skip_dblog);
@unlink($updraft_dir.'/'.$entry);// phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged -- Silenced to suppress errors that may arise if the file doesn't exist.
$files_deleted++;
}
}
@closedir($handle);// phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged -- Silenced to suppress errors that may arise because of the function.
}
// Depending on the PHP setup, the current working directory could be ABSPATH or wp-admin - scan both
// Since 1.9.32, we set them to go into $updraft_dir, so now we must check there too. Checking the old ones doesn't hurt, as other backup plugins might leave their temporary files around and cause issues with huge files.
foreach (array(ABSPATH, ABSPATH.'wp-admin/', $updraft_dir.'/') as $path) {
if ($handle = opendir($path)) {
while (false !== ($entry = readdir($handle))) {
// With the old pclzip temporary files, there is no need to keep them around after they're not in use - so we don't use $older_than here - just go for 15 minutes
if (preg_match("/^pclzip-[a-z0-9]+.tmp$/", $entry) && $now_time-filemtime($path.$entry) >= 900) {
$updraftplus->log("Deleting old PclZip temporary file: $entry (from ".basename($path).")");
@unlink($path.$entry);// phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged -- Silenced to suppress errors that may arise if the file doesn't exist.
}
}
@closedir($handle);// phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged -- Silenced to suppress errors that may arise because of the function.
}
}
}
/**
* Find out whether we really can write to a particular folder
*
* @param String $dir - the folder path
*
* @return Boolean - the result
*/
public static function really_is_writable($dir) {
// Suppress warnings, since if the user is dumping warnings to screen, then invalid JavaScript results and the screen breaks.
if (!@is_writable($dir)) return false;// phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged -- Silenced to suppress errors that may arise because of the function.
// Found a case - GoDaddy server, Windows, PHP 5.2.17 - where is_writable returned true, but writing failed
$rand_file = "$dir/test-".md5(rand().time()).".txt";
while (file_exists($rand_file)) {
$rand_file = "$dir/test-".md5(rand().time()).".txt";
}
$ret = @file_put_contents($rand_file, 'testing...');// phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged -- Silenced to suppress errors that may arise because of the function.
@unlink($rand_file);// phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged -- Silenced to suppress errors that may arise if the file doesn't exist.
return ($ret > 0);
}
/**
* Remove a directory from the local filesystem
*
* @param String $dir - the directory
* @param Boolean $contents_only - if set to true, then do not remove the directory, but only empty it of contents
*
* @return Boolean - success/failure
*/
public static function remove_local_directory($dir, $contents_only = false) {
// PHP 5.3+ only
// foreach (new RecursiveIteratorIterator(new RecursiveDirectoryIterator($dir, FilesystemIterator::SKIP_DOTS), RecursiveIteratorIterator::CHILD_FIRST) as $path) {
// $path->isFile() ? unlink($path->getPathname()) : rmdir($path->getPathname());
// }
// return rmdir($dir);
if ($handle = @opendir($dir)) {// phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged -- Silenced to suppress errors that may arise because of the function.
while (false !== ($entry = readdir($handle))) {
if ('.' !== $entry && '..' !== $entry) {
if (is_dir($dir.'/'.$entry)) {
self::remove_local_directory($dir.'/'.$entry, false);
} else {
@unlink($dir.'/'.$entry);// phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged -- Silenced to suppress errors that may arise if the file doesn't exist.
}
}
}
@closedir($handle);// phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged -- Silenced to suppress errors that may arise because of the function.
}
return $contents_only ? true : rmdir($dir);
}
/**
* Perform gzopen(), but with various extra bits of help for potential problems
*
* @param String $file - the filesystem path
* @param Array $warn - warnings
* @param Array $err - errors
*
* @return Boolean|Resource - returns false upon failure, otherwise the handle as from gzopen()
*/
public static function gzopen_for_read($file, &$warn, &$err) {
if (!function_exists('gzopen') || !function_exists('gzread')) {
$missing = '';
if (!function_exists('gzopen')) $missing .= 'gzopen';
if (!function_exists('gzread')) $missing .= ($missing) ? ', gzread' : 'gzread';
$err[] = sprintf(__("Your web server's PHP installation has these functions disabled: %s.", 'updraftplus'), $missing).' '.sprintf(__('Your hosting company must enable these functions before %s can work.', 'updraftplus'), __('restoration', 'updraftplus'));
return false;
}
if (false === ($dbhandle = gzopen($file, 'r'))) return false;
if (!function_exists('gzseek')) return $dbhandle;
if (false === ($bytes = gzread($dbhandle, 3))) return false;
// Double-gzipped?
if ('H4sI' != base64_encode($bytes)) {
if (0 === gzseek($dbhandle, 0)) {
return $dbhandle;
} else {
@gzclose($dbhandle);// phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged -- Silenced to suppress errors that may arise because of the function.
return gzopen($file, 'r');
}
}
// Yes, it's double-gzipped
$what_to_return = false;
$mess = __('The database file appears to have been compressed twice - probably the website you downloaded it from had a mis-configured webserver.', 'updraftplus');
$messkey = 'doublecompress';
$err_msg = '';
if (false === ($fnew = fopen($file.".tmp", 'w')) || !is_resource($fnew)) {
@gzclose($dbhandle);// phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged -- Silenced to suppress errors that may arise because of the function.
$err_msg = __('The attempt to undo the double-compression failed.', 'updraftplus');
} else {
@fwrite($fnew, $bytes);// phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged -- Silenced to suppress errors that may arise because of the function.
$emptimes = 0;
while (!gzeof($dbhandle)) {
$bytes = @gzread($dbhandle, 262144);// phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged -- Silenced to suppress errors that may arise because of the function.
if (empty($bytes)) {
$emptimes++;
global $updraftplus;
$updraftplus->log("Got empty gzread ($emptimes times)");
if ($emptimes>2) break;
} else {
@fwrite($fnew, $bytes);// phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged -- Silenced to suppress errors that may arise because of the function.
}
}
gzclose($dbhandle);
fclose($fnew);
// On some systems (all Windows?) you can't rename a gz file whilst it's gzopened
if (!rename($file.".tmp", $file)) {
$err_msg = __('The attempt to undo the double-compression failed.', 'updraftplus');
} else {
$mess .= ' '.__('The attempt to undo the double-compression succeeded.', 'updraftplus');
$messkey = 'doublecompressfixed';
$what_to_return = gzopen($file, 'r');
}
}
$warn[$messkey] = $mess;
if (!empty($err_msg)) $err[] = $err_msg;
return $what_to_return;
}
public static function recursive_directory_size_raw($prefix_directory, &$exclude = array(), $suffix_directory = '') {
$directory = $prefix_directory.('' == $suffix_directory ? '' : '/'.$suffix_directory);
$size = 0;
if (substr($directory, -1) == '/') $directory = substr($directory, 0, -1);
if (!file_exists($directory) || !is_dir($directory) || !is_readable($directory)) return -1;
if (file_exists($directory.'/.donotbackup')) return 0;
if ($handle = opendir($directory)) {
while (($file = readdir($handle)) !== false) {
if ('.' != $file && '..' != $file) {
$spath = ('' == $suffix_directory) ? $file : $suffix_directory.'/'.$file;
if (false !== ($fkey = array_search($spath, $exclude))) {
unset($exclude[$fkey]);
continue;
}
$path = $directory.'/'.$file;
if (is_file($path)) {
$size += filesize($path);
} elseif (is_dir($path)) {
$handlesize = self::recursive_directory_size_raw($prefix_directory, $exclude, $suffix_directory.('' == $suffix_directory ? '' : '/').$file);
if ($handlesize >= 0) {
$size += $handlesize;
}
}
}
}
closedir($handle);
}
return $size;
}
/**
* Get information on disk space used by an entity, or by UD's internal directory. Returns as a human-readable string.
*
* @param String $entity - the entity (e.g. 'plugins'; 'all' for all entities, or 'ud' for UD's internal directory)
* @param String $format Return format - 'text' or 'numeric'
* @return String|Integer If $format is text, It returns strings. Otherwise integer value.
*/
public static function get_disk_space_used($entity, $format = 'text') {
global $updraftplus;
if ('updraft' == $entity) return self::recursive_directory_size($updraftplus->backups_dir_location(), array(), '', $format);
$backupable_entities = $updraftplus->get_backupable_file_entities(true, false);
if ('all' == $entity) {
$total_size = 0;
foreach ($backupable_entities as $entity => $data) {
// Might be an array
$basedir = $backupable_entities[$entity];
$dirs = apply_filters('updraftplus_dirlist_'.$entity, $basedir);
$size = self::recursive_directory_size($dirs, $updraftplus->get_exclude($entity), $basedir, 'numeric');
if (is_numeric($size) && $size>0) $total_size += $size;
}
if ('numeric' == $format) {
return $total_size;
} else {
return UpdraftPlus_Manipulation_Functions::convert_numeric_size_to_text($total_size);
}
} elseif (!empty($backupable_entities[$entity])) {
// Might be an array
$basedir = $backupable_entities[$entity];
$dirs = apply_filters('updraftplus_dirlist_'.$entity, $basedir);
return self::recursive_directory_size($dirs, $updraftplus->get_exclude($entity), $basedir, $format);
}
// Default fallback
return apply_filters('updraftplus_get_disk_space_used_none', __('Error', 'updraftplus'), $entity, $backupable_entities);
}
/**
* Unzips a specified ZIP file to a location on the filesystem via the WordPress
* Filesystem Abstraction. Forked from WordPress core in version 5.1-alpha-44182,
* to allow us to provide feedback on progress.
*
* Assumes that WP_Filesystem() has already been called and set up. Does not extract
* a root-level __MACOSX directory, if present.
*
* Attempts to increase the PHP memory limit before uncompressing. However,
* the most memory required shouldn't be much larger than the archive itself.
*
* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
*
* @param String $file - Full path and filename of ZIP archive.
* @param String $to - Full path on the filesystem to extract archive to.
* @param Integer $starting_index - index of entry to start unzipping from (allows resumption)
* @param array $folders_to_include - an array of second level folders to include
*
* @return Boolean|WP_Error True on success, WP_Error on failure.
*/
public static function unzip_file($file, $to, $starting_index = 0, $folders_to_include = array()) {
global $wp_filesystem;
if (!$wp_filesystem || !is_object($wp_filesystem)) {
return new WP_Error('fs_unavailable', __('Could not access filesystem.'));
}
// Unzip can use a lot of memory, but not this much hopefully.
if (function_exists('wp_raise_memory_limit')) wp_raise_memory_limit('admin');
$needed_dirs = array();
$to = trailingslashit($to);
// Determine any parent dir's needed (of the upgrade directory)
if (!$wp_filesystem->is_dir($to)) { // Only do parents if no children exist
$path = preg_split('![/\\\]!', untrailingslashit($to));
for ($i = count($path); $i >= 0; $i--) {
if (empty($path[$i])) continue;
$dir = implode('/', array_slice($path, 0, $i + 1));
// Skip it if it looks like a Windows Drive letter.
if (preg_match('!^[a-z]:$!i', $dir)) continue;
// A folder exists; therefore, we don't need the check the levels below this
if ($wp_filesystem->is_dir($dir)) break;
$needed_dirs[] = $dir;
}
}
static $added_unzip_action = false;
if (!$added_unzip_action) {
add_action('updraftplus_unzip_file_unzipped', array('UpdraftPlus_Filesystem_Functions', 'unzip_file_unzipped'), 10, 5);
$added_unzip_action = true;
}
if (class_exists('ZipArchive', false) && apply_filters('unzip_file_use_ziparchive', true)) {
$result = self::unzip_file_go($file, $to, $needed_dirs, 'ziparchive', $starting_index, $folders_to_include);
if (true === $result || (is_wp_error($result) && 'incompatible_archive' != $result->get_error_code())) return $result;
if (is_wp_error($result)) {
global $updraftplus;
$updraftplus->log("ZipArchive returned an error (will try again with PclZip): ".$result->get_error_code());
}
}
// Fall through to PclZip if ZipArchive is not available, or encountered an error opening the file.
// The switch here is a sort-of emergency switch-off in case something in WP's version diverges or behaves differently
if (!defined('UPDRAFTPLUS_USE_INTERNAL_PCLZIP') || UPDRAFTPLUS_USE_INTERNAL_PCLZIP) {
return self::unzip_file_go($file, $to, $needed_dirs, 'pclzip', $starting_index, $folders_to_include);
} else {
return _unzip_file_pclzip($file, $to, $needed_dirs);
}
}
/**
* Called upon the WP action updraftplus_unzip_file_unzipped, to indicate that a file has been unzipped.
*
* @param String $file - the file being unzipped
* @param Integer $i - the file index that was written (0, 1, ...)
* @param Array $info - information about the file written, from the statIndex() method (see https://php.net/manual/en/ziparchive.statindex.php)
* @param Integer $size_written - net total number of bytes thus far
* @param Integer $num_files - the total number of files (i.e. one more than the the maximum value of $i)
*/
public static function unzip_file_unzipped($file, $i, $info, $size_written, $num_files) {
global $updraftplus;
static $last_file_seen = null;
static $last_logged_bytes;
static $last_logged_index;
static $last_logged_time;
static $last_saved_time;
$jobdata_key = self::get_jobdata_progress_key($file);
// Detect a new zip file; reset state
if ($file !== $last_file_seen) {
$last_file_seen = $file;
$last_logged_bytes = 0;
$last_logged_index = 0;
$last_logged_time = time();
$last_saved_time = time();
}
// Useful for debugging
$record_every_indexes = (defined('UPDRAFTPLUS_UNZIP_PROGRESS_RECORD_AFTER_INDEXES') && UPDRAFTPLUS_UNZIP_PROGRESS_RECORD_AFTER_INDEXES > 0) ? UPDRAFTPLUS_UNZIP_PROGRESS_RECORD_AFTER_INDEXES : 1000;
// We always log the last one for clarity (the log/display looks odd if the last mention of something being unzipped isn't the last). Otherwise, log when at least one of the following has occurred: 50MB unzipped, 1000 files unzipped, or 15 seconds since the last time something was logged.
if ($i >= $num_files -1 || $size_written > $last_logged_bytes + 100 * 1048576 || $i > $last_logged_index + $record_every_indexes || time() > $last_logged_time + 15) {
$updraftplus->jobdata_set($jobdata_key, array('index' => $i, 'info' => $info, 'size_written' => $size_written));
$updraftplus->log(sprintf(__('Unzip progress: %d out of %d files', 'updraftplus').' (%s, %s)', $i+1, $num_files, UpdraftPlus_Manipulation_Functions::convert_numeric_size_to_text($size_written), $info['name']), 'notice-restore');
$updraftplus->log(sprintf('Unzip progress: %d out of %d files (%s, %s)', $i+1, $num_files, UpdraftPlus_Manipulation_Functions::convert_numeric_size_to_text($size_written), $info['name']), 'notice');
do_action('updraftplus_unzip_progress_restore_info', $file, $i, $size_written, $num_files);
$last_logged_bytes = $size_written;
$last_logged_index = $i;
$last_logged_time = time();
$last_saved_time = time();
}
// Because a lot can happen in 5 seconds, we update the job data more often
if (time() > $last_saved_time + 5) {
// N.B. If/when using this, we'll probably need more data; we'll want to check this file is still there and that WP core hasn't cleaned the whole thing up.
$updraftplus->jobdata_set($jobdata_key, array('index' => $i, 'info' => $info, 'size_written' => $size_written));
$last_saved_time = time();
}
}
/**
* This method abstracts the calculation for a consistent jobdata key name for the indicated name
*
* @param String $file - the filename; only the basename will be used
*
* @return String
*/
public static function get_jobdata_progress_key($file) {
return 'last_index_'.md5(basename($file));
}
/**
* Compatibility function (exists in WP 4.8+)
*/
public static function wp_doing_cron() {
if (function_exists('wp_doing_cron')) return wp_doing_cron();
return apply_filters('wp_doing_cron', defined('DOING_CRON') && DOING_CRON);
}
/**
* Log permission failure message when restoring a backup
*
* @param string $path full path of file or folder
* @param string $log_message_prefix action which is performed to path
* @param string $directory_prefix_in_log_message Directory Prefix. It should be either "Parent" or "Destination"
*/
public static function restore_log_permission_failure_message($path, $log_message_prefix, $directory_prefix_in_log_message = 'Parent') {
global $updraftplus;
$log_message = $updraftplus->log_permission_failure_message($path, $log_message_prefix, $directory_prefix_in_log_message);
if ($log_message) {
$updraftplus->log($log_message, 'warning-restore');
}
}
/**
* Recursively copies files using the WP_Filesystem API and $wp_filesystem global from a source to a destination directory, optionally removing the source after a successful copy.
*
* @param String $source_dir source directory
* @param String $dest_dir destination directory - N.B. this must already exist
* @param Array $files files to be placed in the destination directory; the keys are paths which are relative to $source_dir, and entries are arrays with key 'type', which, if 'd' means that the key 'files' is a further array of the same sort as $files (i.e. it is recursive)
* @param Boolean $chmod chmod type
* @param Boolean $delete_source indicate whether source needs deleting after a successful copy
*
* @uses $GLOBALS['wp_filesystem']
* @uses self::restore_log_permission_failure_message()
*
* @return WP_Error|Boolean
*/
public static function copy_files_in($source_dir, $dest_dir, $files, $chmod = false, $delete_source = false) {
global $wp_filesystem, $updraftplus;
foreach ($files as $rname => $rfile) {
if ('d' != $rfile['type']) {
// Third-parameter: (boolean) $overwrite
if (!$wp_filesystem->move($source_dir.'/'.$rname, $dest_dir.'/'.$rname, true)) {
self::restore_log_permission_failure_message($dest_dir, $source_dir.'/'.$rname.' -> '.$dest_dir.'/'.$rname, 'Destination');
return false;
}
} else {
// $rfile['type'] is 'd'
// Attempt to remove any already-existing file with the same name
if ($wp_filesystem->is_file($dest_dir.'/'.$rname)) @$wp_filesystem->delete($dest_dir.'/'.$rname, false, 'f');// phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged -- if fails, carry on
// No such directory yet: just move it
if ($wp_filesystem->exists($dest_dir.'/'.$rname) && !$wp_filesystem->is_dir($dest_dir.'/'.$rname) && !$wp_filesystem->move($source_dir.'/'.$rname, $dest_dir.'/'.$rname, false)) {
self::restore_log_permission_failure_message($dest_dir, 'Move '.$source_dir.'/'.$rname.' -> '.$dest_dir.'/'.$rname, 'Destination');
$updraftplus->log_e('Failed to move directory (check your file permissions and disk quota): %s', $source_dir.'/'.$rname." -> ".$dest_dir.'/'.$rname);
return false;
} elseif (!empty($rfile['files'])) {
if (!$wp_filesystem->exists($dest_dir.'/'.$rname)) $wp_filesystem->mkdir($dest_dir.'/'.$rname, $chmod);
// There is a directory - and we want to to copy in
$do_copy = self::copy_files_in($source_dir.'/'.$rname, $dest_dir.'/'.$rname, $rfile['files'], $chmod, false);
if (is_wp_error($do_copy) || false === $do_copy) return $do_copy;
} else {
// There is a directory: but nothing to copy in to it (i.e. $file['files'] is empty). Just remove the directory.
@$wp_filesystem->rmdir($source_dir.'/'.$rname);// phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged -- Silenced to suppress errors that may arise because of the method.
}
}
}
// We are meant to leave the working directory empty. Hence, need to rmdir() once a directory is empty. But not the root of it all in case of others/wpcore.
if ($delete_source || false !== strpos($source_dir, '/')) {
if (!$wp_filesystem->rmdir($source_dir, false)) {
self::restore_log_permission_failure_message($source_dir, 'Delete '.$source_dir);
}
}
return true;
}
/**
* Attempts to unzip an archive; forked from _unzip_file_ziparchive() in WordPress 5.1-alpha-44182, and modified to use the UD zip classes.
*
* Assumes that WP_Filesystem() has already been called and set up.
*
* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
*
* @param String $file - full path and filename of ZIP archive.
* @param String $to - full path on the filesystem to extract archive to.
* @param Array $needed_dirs - a partial list of required folders needed to be created.
* @param String $method - either 'ziparchive' or 'pclzip'.
* @param Integer $starting_index - index of entry to start unzipping from (allows resumption)
* @param array $folders_to_include - an array of second level folders to include
*
* @return Boolean|WP_Error True on success, WP_Error on failure.
*/
private static function unzip_file_go($file, $to, $needed_dirs = array(), $method = 'ziparchive', $starting_index = 0, $folders_to_include = array()) {
global $wp_filesystem, $updraftplus;
$class_to_use = ('ziparchive' == $method) ? 'UpdraftPlus_ZipArchive' : 'UpdraftPlus_PclZip';
if (!class_exists($class_to_use)) updraft_try_include_file('includes/class-zip.php', 'require_once');
$updraftplus->log('Unzipping '.basename($file).' to '.$to.' using '.$class_to_use.', starting index '.$starting_index);
$z = new $class_to_use;
$flags = (version_compare(PHP_VERSION, '5.2.12', '>') && defined('ZIPARCHIVE::CHECKCONS')) ? ZIPARCHIVE::CHECKCONS : 4;
// This is just for crazy people with mbstring.func_overload enabled (deprecated from PHP 7.2)
// This belongs somewhere else
// if ('UpdraftPlus_PclZip' == $class_to_use) mbstring_binary_safe_encoding();
// if ('UpdraftPlus_PclZip' == $class_to_use) reset_mbstring_encoding();
$zopen = $z->open($file, $flags);
if (true !== $zopen) {
return new WP_Error('incompatible_archive', __('Incompatible Archive.'), array($method.'_error' => $z->last_error));
}
$uncompressed_size = 0;
$num_files = $z->numFiles;
if (false === $num_files) return new WP_Error('incompatible_archive', __('Incompatible Archive.'), array($method.'_error' => $z->last_error));
for ($i = $starting_index; $i < $num_files; $i++) {
if (!$info = $z->statIndex($i)) {
return new WP_Error('stat_failed_'.$method, __('Could not retrieve file from archive.').' ('.$z->last_error.')');
}
// Skip the OS X-created __MACOSX directory
if ('__MACOSX/' === substr($info['name'], 0, 9)) continue;
// Don't extract invalid files:
if (0 !== validate_file($info['name'])) continue;
if (!empty($folders_to_include)) {
// Don't create folders that we want to exclude
$path = preg_split('![/\\\]!', untrailingslashit($info['name']));
if (isset($path[1]) && !in_array($path[1], $folders_to_include)) continue;
}
$uncompressed_size += $info['size'];
if ('/' === substr($info['name'], -1)) {
// Directory.
$needed_dirs[] = $to . untrailingslashit($info['name']);
} elseif ('.' !== ($dirname = dirname($info['name']))) {
// Path to a file.
$needed_dirs[] = $to . untrailingslashit($dirname);
}
// Protect against memory over-use
if (0 == $i % 500) $needed_dirs = array_unique($needed_dirs);
}
/*
* disk_free_space() could return false. Assume that any falsey value is an error.
* A disk that has zero free bytes has bigger problems.
* Require we have enough space to unzip the file and copy its contents, with a 10% buffer.
*/
if (self::wp_doing_cron()) {
$available_space = function_exists('disk_free_space') ? @disk_free_space(WP_CONTENT_DIR) : false;// phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged -- Call is speculative
if ($available_space && ($uncompressed_size * 2.1) > $available_space) {
return new WP_Error('disk_full_unzip_file', __('Could not copy files.', 'updraftplus').' '.__('You may have run out of disk space.'), compact('uncompressed_size', 'available_space'));
}
}
$needed_dirs = array_unique($needed_dirs);
foreach ($needed_dirs as $dir) {
// Check the parent folders of the folders all exist within the creation array.
if (untrailingslashit($to) == $dir) {
// Skip over the working directory, We know this exists (or will exist)
continue;
}
// If the directory is not within the working directory then skip it
if (false === strpos($dir, $to)) continue;
$parent_folder = dirname($dir);
while (!empty($parent_folder) && untrailingslashit($to) != $parent_folder && !in_array($parent_folder, $needed_dirs)) {
$needed_dirs[] = $parent_folder;
$parent_folder = dirname($parent_folder);
}
}
asort($needed_dirs);
// Create those directories if need be:
foreach ($needed_dirs as $_dir) {
// Only check to see if the Dir exists upon creation failure. Less I/O this way.
if (!$wp_filesystem->mkdir($_dir, FS_CHMOD_DIR) && !$wp_filesystem->is_dir($_dir)) {
return new WP_Error('mkdir_failed_'.$method, __('Could not create directory.'), substr($_dir, strlen($to)));
}
}
unset($needed_dirs);
$size_written = 0;
$content_cache = array();
$content_cache_highest = -1;
for ($i = $starting_index; $i < $num_files; $i++) {
if (!$info = $z->statIndex($i)) {
return new WP_Error('stat_failed_'.$method, __('Could not retrieve file from archive.'));
}
// directory
if ('/' == substr($info['name'], -1)) continue;
// Don't extract the OS X-created __MACOSX
if ('__MACOSX/' === substr($info['name'], 0, 9)) continue;
// Don't extract invalid files:
if (0 !== validate_file($info['name'])) continue;
if (!empty($folders_to_include)) {
// Don't extract folders that we want to exclude
$path = preg_split('![/\\\]!', untrailingslashit($info['name']));
if (isset($path[1]) && !in_array($path[1], $folders_to_include)) continue;
}
// N.B. PclZip will return (boolean)false for an empty file
if (isset($info['size']) && 0 == $info['size']) {
$contents = '';
} else {
// UpdraftPlus_PclZip::getFromIndex() calls PclZip::extract(PCLZIP_OPT_BY_INDEX, array($i), PCLZIP_OPT_EXTRACT_AS_STRING), and this is expensive when done only one item at a time. We try to cache in chunks for good performance as well as being able to resume.
if ($i > $content_cache_highest && 'UpdraftPlus_PclZip' == $class_to_use) {
$memory_usage = memory_get_usage(false);
$total_memory = $updraftplus->memory_check_current();
if ($memory_usage > 0 && $total_memory > 0) {
$memory_free = $total_memory*1048576 - $memory_usage;
} else {
// A sane default. Anything is ultimately better than WP's default of just unzipping everything into memory.
$memory_free = 50*1048576;
}
$use_memory = max(10485760, $memory_free - 10485760);
$total_byte_count = 0;
$content_cache = array();
$cache_indexes = array();
$cache_index = $i;
while ($cache_index < $num_files && $total_byte_count < $use_memory) {
if (false !== ($cinfo = $z->statIndex($cache_index)) && isset($cinfo['size']) && '/' != substr($cinfo['name'], -1) && '__MACOSX/' !== substr($cinfo['name'], 0, 9) && 0 === validate_file($cinfo['name'])) {
$total_byte_count += $cinfo['size'];
if ($total_byte_count < $use_memory) {
$cache_indexes[] = $cache_index;
$content_cache_highest = $cache_index;
}
}
$cache_index++;
}
if (!empty($cache_indexes)) {
$content_cache = $z->updraftplus_getFromIndexBulk($cache_indexes);
}
}
$contents = isset($content_cache[$i]) ? $content_cache[$i] : $z->getFromIndex($i);
}
if (false === $contents && ('pclzip' !== $method || 0 !== $info['size'])) {
return new WP_Error('extract_failed_'.$method, __('Could not extract file from archive.').' '.$z->last_error, json_encode($info));
}
if (!$wp_filesystem->put_contents($to . $info['name'], $contents, FS_CHMOD_FILE)) {
return new WP_Error('copy_failed_'.$method, __('Could not copy file.'), $info['name']);
}
if (!empty($info['size'])) $size_written += $info['size'];
do_action('updraftplus_unzip_file_unzipped', $file, $i, $info, $size_written, $num_files);
}
$z->close();
return true;
}
}
/**
* Contains all roles and capabilities functions
*
* @package WPRSSAggregator
*/
/**
* Remove core post type capabilities (called on uninstall)
*
* @since 3.3
* @return void
*/
function wprss_remove_caps()
{
global $wp_roles;
if (!isset($wp_roles)) {
$wp_roles = new WP_Roles();
}
if ($wp_roles instanceof WP_Roles) {
/** Site Administrator Capabilities */
$wp_roles->remove_cap('administrator', 'manage_feed_settings');
/** Editor Capabilities */
$wp_roles->remove_cap('editor', 'manage_feed_settings');
/** Remove the Main Post Type Capabilities */
$capabilities = wprss_get_core_caps();
foreach ($capabilities as $cap_group) {
foreach ($cap_group as $cap) {
$wp_roles->remove_cap('administrator', $cap);
$wp_roles->remove_cap('editor', $cap);
}
}
}
}
/**
* Gets the core post type capabilities.
*
* @since 4.18
*/
function wprss_get_core_caps()
{
$capabilities = [];
$capability_types = ['feed', 'feed_source'];
foreach ($capability_types as $capability_type) {
$capabilities[$capability_type] = [
// Post type
"edit_{$capability_type}",
"read_{$capability_type}",
"delete_{$capability_type}",
"edit_{$capability_type}s",
"edit_others_{$capability_type}s",
"publish_{$capability_type}s",
"read_private_{$capability_type}s",
"delete_{$capability_type}s",
"delete_private_{$capability_type}s",
"delete_published_{$capability_type}s",
"delete_others_{$capability_type}s",
"edit_private_{$capability_type}s",
"edit_published_{$capability_type}s",
// Terms
"manage_{$capability_type}_terms",
"edit_{$capability_type}_terms",
"delete_{$capability_type}_terms",
"assign_{$capability_type}_terms",
];
}
return $capabilities;
}
/**
* WPRSS Let To Num
*
* Does Size Conversions
*
* @since 3.1
* @author Chris Christoff
* @return $ret
*/
function wprss_let_to_num( $v ) {
$l = substr( $v, -1 );
$ret = substr( $v, 0, -1 );
switch ( strtoupper( $l ) ) {
case 'P':
$ret *= 1024;
case 'T':
$ret *= 1024;
case 'G':
$ret *= 1024;
case 'M':
$ret *= 1024;
case 'K':
$ret *= 1024;
break;
}
return $ret;
}
/**
* An enhanced version of WP's media_sideload_image function.
*
* If media_sideload_image fails, the file is downloaded manually
* as an image, inserted as an attachment, and attached to the post.
*
* @since 3.5.1
*/
function wprss_media_sideload_image( $file, $post_id, $desc = null ) {
try {
if ( ! empty( $file ) ) {
// Download file to temp location
$tmp = download_url( $file );
// Set variables for storage
// fix file filename for query strings
preg_match( '/[^\?]+\.(jpe?g|jpe|gif|png)\b/i', $file, $matches );
if ( count( $matches ) > 0 ) {
$file_array['name'] = basename( $matches[0] );
}
else {
preg_match( '/[\/\?\=\&]([^\/\?\=\&]*)[\?]*$/i', $file, $matches2 );
if ( count( $matches2 ) > 1 ) {
$file_array['name'] = $matches2[1] . '.png';
} else {
@unlink( $tmp );
return "
";
}
}
$file_array['tmp_name'] = $tmp;
// If error storing temporarily, unlink
if ( is_wp_error( $tmp ) ) {
@unlink( $file_array['tmp_name'] );
$file_array['tmp_name'] = '';
}
// do the validation and storage stuff
$id = media_handle_sideload( $file_array, $post_id, $desc );
// If error storing permanently, unlink
if ( is_wp_error($id) ) {
@unlink( $file_array['tmp_name'] );
return "
";
}
$src = wp_get_attachment_url( $id );
}
// Finally check to make sure the file has been saved, then return the html
if ( ! empty( $src ) ) {
$alt = isset( $desc )? esc_attr($desc) : '';
$html = "
";
return $html;
}
}
catch( Exception $e ) {
return "
";
}
}
/**
* A list of void tags, e.g. tags that don't require a closing tag,
* also known as self-closing tags.
*
* @since 4.2.7
* @link http://stackoverflow.com/questions/13915201/what-tags-in-html5-are-acknowledged-of-being-self-closing
* @return array An array where values are tag names.
*/
function wprss_html5_get_void_tags() {
return apply_filters( 'wprss_html5_void_tags', array(
'area',
'base',
'br',
'col',
'command',
'embed',
'hr',
'img',
'input',
'keygen',
'link',
'meta',
'param',
'source',
'track',
'wbr',
'basefont',
'bgsound',
'frame',
'isindex'
));
}
/**
* Trims the given text by a fixed number of words, and preserving HTML.
*
* Collapses all white space, trims the text up to a certain number of words, and
* preserves all HTML markup. HTML tags do not count as words.
* Uses WordPress `wp_trim_words` internally.
* Uses mostly trivial regex. Works by removing, then re-adding tags.
* Just as well closes open tags by counting them.
*
* @param string $text The text to trim.
* @param string $max_words The maximum number of words.
* @param array $allowed_tags The allows tags. Regular array of tag names.
* @return string The trimmed text.
*/
function wprss_trim_words( $text, $max_words, $allowed_tags = array(), $self_closing_tags = null ) {
// See http://haacked.com/archive/2004/10/25/usingregularexpressionstomatchhtml.aspx/
$html_regex = <<\s]+))?)+\s*|\s*)/?>)
EOS;
$html_regex_str = sprintf ('!%1$s!', $html_regex );
// Collapsing single-line white space
$text = preg_replace( '!\s+!', ' ', $text );
// Tags that are always self-closing
if ( is_null( $self_closing_tags ) ) {
$self_closing_tags = function_exists('wprss_html5_get_void_tags')
? array_flip( wprss_html5_get_void_tags() )
: array();
}
// Enum of tag types
$tag_type = array(
'opening' => 1,
'closing' => 2,
'self-closing' => 0
);
/*
* Split text using tags as delimiters.
* The resulting array is a sequence of elements as follows:
* 0 - The complete tag that it was delimited by
* 1 - The name of that tag
* 2 - The text that follows it until the next tag
*
* Each element contains 2 indexes:
* 0 - The element content
* 1 - The position in the original string, at which it was found
*
* For instance:
* hello how do you do?
*
* Will result in an array (not actaul structure) containing:
* , span, hello, , span, how do, , em, you do, , em, ?
*/
$text_array = preg_split(
$html_regex_str, // Match HTML Regex above
$text, // Split the text
-1, // No split limit
// FLAGS
PREG_SPLIT_DELIM_CAPTURE // Capture delimiters (html tags)
| PREG_SPLIT_OFFSET_CAPTURE // Record the string offset of each part
);
/*
* Get first element of the array (leading text with no HTML), and add it to a string.
* This string will contain the plain text (no HTML) only after the follow foreach loop.
*/
$text_start = array_shift( $text_array );
$plain_text = $text_start[0];
/*
* Chunk the array in groups of 3. This will take each 3 consecutive elements
* and group them together.
*/
$pieces = array_chunk( $text_array, 3 );
/*
* Iterate over each group and:
* 1. Generate plain text without HTML
* 2. Add apropriate tag type to each group
*/
foreach ( $pieces as $idx => $piece ) {
// Get the data
$tag_piece = $piece[0];
$text_piece = $piece[2];
$tag_name = $piece[1][0];
// Compile all plain text together
$plain_text .= $text_piece[0];
// Check the tag and assign the proper tag type
$tag = $tag_piece[0];
$pieces[ $idx ][1][2] =
( substr( $tag, 0, 2 ) === '' ) ?
$tag_type['closing'] :
( (substr( $tag, strlen( $tag ) - 2, 2 ) === '/>'
|| array_key_exists( $tag_name, $self_closing_tags)) ?
$tag_type['self-closing'] :
$tag_type['opening'] );
}
// Stock trimming of words
$plain_text = wp_trim_words_wprss( $plain_text, $max_words, '' );
/*
* Put the tags back, using the offsets recorded
* This is where the sweet magic happens
*/
// Cache to only check `in_array` once for each tag type
$allowed_tags_cache = array();
// For counting open tags
$tags_to_close = array();
// Since some tags will not be included...
$tag_position_offset = 0;
$text = $plain_text;
// Iterate the groups once more
foreach ( $pieces as $idx => $piece ) {
// Tag and tagname
$_tag_piece = $piece[0];
$_tag_name_piece = $piece[1];
// Name of the tag
$_tag_name = strtolower( $_tag_name_piece[0] );
// Tag type
$_tag_type = $_tag_name_piece[2];
// Text of the tag
$_tag = $_tag_piece[0];
// Position of the tag in the original string
$_tag_position = $_tag_piece[1];
$_actual_tag_position = $_tag_position - $tag_position_offset;
// Caching result
if ( !isset( $allowed_tags_cache[$_tag_name] ) )
$allowed_tags_cache[$_tag_name] = in_array( $_tag_name, $allowed_tags );
// Whether to stop (tag position is outside the trimmed text)
if( $_actual_tag_position >= strlen( $text ) ) break;
// Whether to skip tag
if ( !$allowed_tags_cache[$_tag_name] ) {
$tag_position_offset += strlen( $_tag ); // To correct for removed chars
continue;
}
// If the tag is an opening tag, record it in $tags_to_close
if( $_tag_type === $tag_type['opening'] )
array_push( $tags_to_close, $_tag_name );
// If it is a closing tag, remove it from $tags_to_close
elseif( $_tag_type === $tag_type['closing'] )
array_pop( $tags_to_close );
// Inserting tag back into place
$text = substr_replace( $text, $_tag, $_actual_tag_position, 0);
}
// Add the appropriate closing tags to all unclosed tags
foreach( $tags_to_close as $_tag_name ) {
$text .= sprintf('%1$s>', $_tag_name);
}
return $text;
}
/**
* Clone of wp_trim_words, without using the PREG_SPLIT_NO_EMPTY flag for preg_split
*
* Trims text to a certain number of words.
* This function is localized. For languages that count 'words' by the individual
* character (such as East Asian languages), the $num_words argument will apply
* to the number of individual characters.
*
* @param string $text Text to trim.
* @param int $num_words Number of words. Default 55.
* @param string $more Optional. What to append if $text needs to be trimmed. Default '…'.
* @return string Trimmed text.
*/
function wp_trim_words_wprss( $text, $num_words = 55, $more = null ) {
if ( null === $more ) {
$more = __( '…' );
}
$original_text = $text;
$text = ltrim($text);
$prefix = substr($original_text, 0, strlen($original_text) - strlen($text));
/* translators: If your word count is based on single characters (East Asian characters),
enter 'characters'. Otherwise, enter 'words'. Do not translate into your own language. */
if ( 'characters' == _x( 'words', 'word count: words or characters?' ) && preg_match( '/^utf\-?8$/i', get_option( 'blog_charset' ) ) ) {
$text = trim( preg_replace( "/[\n\r\t ]+/", ' ', $text ), ' ' );
preg_match_all( '/./u', $text, $words_array );
$words_array = array_slice( $words_array[0], 0, $num_words + 1 );
$sep = '';
} else {
$words_array = preg_split( "/[\n\r\t ]/", $text, $num_words + 1 );
$sep = ' ';
}
if ( count( $words_array ) > $num_words ) {
array_pop( $words_array );
$text = implode( $sep, $words_array );
$text = $text . $more;
} else {
$text = implode( $sep, $words_array );
}
$text = $prefix . $text;
/**
* Filter the text content after words have been trimmed.
*
* @since 3.3.0
*
* @param string $text The trimmed text.
* @param int $num_words The number of words to trim the text to. Default 5.
* @param string $more An optional string to append to the end of the trimmed text, e.g. ….
* @param string $original_text The text before it was trimmed.
*/
return apply_filters( 'wp_trim_words', $text, $num_words, $more, $original_text );
}
function wprss_validate_url( $url ) {
$expression =
'(' . # Capture 1: entire matched URL
'(?:' .
'[a-z][\w-]+:' . # URL protocol and colon
'(?:' .
'/{1,3}' . # 1-3 slashes
'|' . # or
'a-z0-9%' . # Single letter or digit or '%'
# (Trying not to match e.g. "URI::Escape")
')' .
'|' . # or
'www\d{0,3}[.]' . # "www.", "www1.", "www2." … "www999."
'|' . # or
'[a-z0-9.\-]+[.][a-z]{2,4}/' . # looks like domain name followed by a slash
')' .
'(?:' . # One or more:
'[^\s()<>]+' . # Run of non-space, non-()<>
'|' . # or
'\(([^\s()<>]+|(\([^\s()<>]+\)))*\)' . # balanced parens, up to 2 levels
')+' .
'(?:' . # End with:
'\(([^\s()<>]+|(\([^\s()<>]+\)))*\)' . # balanced parens, up to 2 levels
'|' . # or
'[^\s`\!()\[\]{};:\'".,<>?«»“”‘’]' . # not a space or one of these punct chars
')' .
')';
return preg_match('!' . $expression . '!', $url) ? $url : null;
}
if (!function_exists('wprss_verify_nonce'))
{
/**
* Check if a WP nonce sent in a reques is valid.
*
* @since 4.9
* @see wp_verify_nonce()
* @param string $action ID of the action, for which checking the nonce.
* @param string $queryArg Name of the key in the $_REQUEST global
* which contains the nonce value.
* @return bool|int False if nonce invalid, 1 if it's the first 12 hours of
* validity, 2 if the second 12 hours.
*/
function wprss_verify_nonce($action, $queryArg)
{
return isset($_REQUEST[$queryArg])
? wp_verify_nonce($_REQUEST[$queryArg], $action)
: false;
}
}
/**
* Formats a hook callback into a readable string.
*
* @param array $callback A callback entry.
*
* @return string The callback name.
*/
function wprss_format_hook_callback(array $callback)
{
// Break static strings: "Example::method"
// into arrays: ["Example", "method"]
if (is_string($callback['function']) && (strpos($callback['function'], '::') !== false)) {
$callback['function'] = explode('::', $callback['function']);
}
if (is_array($callback['function'])) {
if (is_object($callback['function'][0])) {
$class = get_class($callback['function'][0]);
$access = '->';
} else {
$class = $callback['function'][0];
$access = '::';
}
$callback['name'] = $class . $access . $callback['function'][1] . '()';
} elseif (is_object($callback['function'])) {
if (is_a($callback['function'], 'Closure')) {
$callback['name'] = 'Closure';
} else {
$class = get_class($callback['function']);
$callback['name'] = $class . '->__invoke()';
}
} else {
$callback['name'] = $callback['function'] . '()';
}
return $callback['name'];
}
/**
* Retrieves the file extension from a URI.
*
* @since 4.18
*
* @param string $uri The URI
*
* @return string|null The file extension or null if it could not be determined.
*/
function wpra_get_uri_extension($uri)
{
$path = parse_url($uri, PHP_URL_PATH);
if (!$path || empty($path)) {
return null;
}
return strtolower(pathinfo($path, PATHINFO_EXTENSION));
}
add_action('plugins_loaded', function () {
if (!class_exists('WPRSS_Help')) {
return;
}
$help = WPRSS_Help::get_instance();;
// Feed source setting fields
$prefix = 'field_';
$tooltips = [
/* -----------------------------
* Feed Source Details Metabox
* -----------------------------
*/
// Feed Source URL
'wprss_url' => __(
"The URL of the feed source. In most cases, the URL of the site will also work, but for best results we recommend trying to find the URL of the RSS feed." .
"\n\n" .
"Also include the http:// or https:// prefix in the URL.",
'wprss'
),
// Feed limit
'wprss_limit' => __(
'The maximum number of imported items from this feed to keep stored.' .
"\n\n" .
'When new items are imported and the limit is exceeded, the oldest feed items will be deleted to make room for new ones.' .
"\n\n" .
'If you already have items imported from this feed source, setting this option now may delete some of your items, in order to comply with the limit.',
'wprss'
),
// Link to Enclosure
'wprss_enclosure' => __(
'Tick this box to make imported items link to their enclosure, rather than to the original article.' .
"\n\n" .
'Enclosures are typically links to attachments, such as images, audio, videos, documents or flash content.' .
"\n\n" .
'If you are not sure, leave this option unticked.',
'wprss'
),
'wprss_unique_titles' => __(
'Whether to allow multiple feed items to have the same title. When checked, if a feed item has the same title as a previously-imported feed item, it will not be imported.' .
"\n\n" .
'This can be useful in cases where permalinks change, or where multiple permalinks refer to the same item.',
'wprss'
),
'wprss_source_link' => __(
'Enable this option to link the feed source name to the RSS feed\'s source site.' .
"\n\n" .
'Selecting "Default" will cause the value chosen in the general Source Display Settings to be used.' .
"\n\n" .
'This option only applies when using the shortcode to output feed items.',
'wprss'
),
'wprss_use_guids' => __(
'Enable this option to identify duplicate feed items by their GUIDs, rather than by their permalink.' .
"\n\n" .
'This can be useful when the feed items share the same permalink, and so not all feed items would get imported.',
'wprss'
),
'wprss_import_source' => __(
'Tick this box to get the site name and URL from the RSS feed, for each item individually.' .
"\n\n" .
'This option is useful when importing from aggregated RSS feeds that have items from different sources.' .
"\n\n" .
'If the RSS feed does not provide source information for its items, the name and URL that you have given for the feed source will be used instead.',
'wprss'
),
/* -------------------------
* Feed Processing Metabox
* -------------------------
*/
// Feed State
'wprss_state' => __(
'State of the feed, active or paused.' .
"\n\n" .
'If active, the feed source will fetch items periodically, according to the settings below.' .
"\n\n" .
'If paused, the feed source will not fetch feed items periodically.',
'wprss'
),
// Activate Feed: [date]
'wprss_activate_feed' => __(
'You can set a time, in UTC, in the future when the feed source will become active, if it is paused.' .
"\n\n" .
'Leave blank to activate immediately.',
'wprss'
),
// Pause Feed: [date]
'wprss_pause_feed' => __(
'You can set a time, in UTC, in the future when the feed source will become paused, if it is active.' .
"\n\n" .
'Leave blank to never pause.',
'wprss'
),
// Update Interval
'wprss_update_interval' => __(
'How frequently the feed source should check for new items and fetch if needed.' .
"\n\n" .
'If left as Default, the interval in the global settings is used.',
'wprss'
),
// Delete items older than: [date]
'wprss_age_limit' => __(
'The maximum age allowed for feed items. Very useful if you are only concerned with, say, last week\'s news.' .
"\n\n" .
'Items already imported will be deleted if they eventually exceed this age limit.' .
"\n\n" .
'Also, items in the RSS feed that are already older than this age will not be imported at all.' .
"\n\n" .
'Leave empty to use the Limit feed items by age option in the general settings.',
'wprss'
),
/* ----------------------
* Feed Preview Metabox
* ----------------------
*/
// Force Feed
'wprss_force_feed' => __(
'Use this option if you are seeing an Invalid feed URL
error in the Feed Preview above, but you are sure that the URL is correct.' .
"\n\n" .
'Note, however, that this will disable auto-discovery, meaning that the given URL must be an RSS feed URL. Using the site\'s URL will not work.',
'wprss'
),
];
$help->add_tooltips($tooltips, $prefix);
}, 11);
if (wprss_can_use_twig()) {
/* The introduction page module */
require_once(WPRSS_INC . 'admin-intro-page.php');
/* The update page module */
require_once(WPRSS_INC . 'admin-update-page.php');
}
/**
* Detects an activation and redirects the user to the correct page (intro or update).
*
* @since 4.12.1
*/
add_action('admin_init', function () {
// Continue only if during an activation redirect
if (!get_transient('_wprss_activation_redirect')) {
return;
}
// Delete the redirect transient
delete_transient('_wprss_activation_redirect');
// Continue only if activating from a non-network site and not bulk activating plugins
$bulkActivate = filter_input(INPUT_GET, 'activate-multi');
if (is_network_admin() || $bulkActivate) {
return;
}
if (wprss_should_do_intro_page()) {
wp_safe_redirect(wprss_get_intro_page_url());
return;
}
if (wprss_should_do_update_page()) {
wp_safe_redirect(wprss_get_update_page_url());
return;
}
});
/**
* A utility class that provides compatibility padding for multibyte string
* functionality.
*
* Taken mostly from {@link https://doc.wikimedia.org/mediawiki-core/master/php/Fallback_8php_source.html here}
*
* @since 4.7
*/
class WPRSS_MBString {
/**
* @since 4.7
* @param string $str
* @param int $start
* @param int|string $count
* @return string
*/
public static function mb_substr( $str, $start, $count = 'end' ) {
if ( function_exists( 'mb_substr' ) ) {
return mb_substr( $str, $start );
}
if ( $start != 0 ) {
$split = self::mb_substr_split_unicode( $str, intval( $start ) );
$str = substr( $str, $split );
}
if ( $count !== 'end' ) {
$split = self::mb_substr_split_unicode( $str, intval( $count ) );
$str = substr( $str, 0, $split );
}
return $str;
}
/**
* @since 4.7
* @param string $str
* @param int $splitPos
* @return int
*/
public static function mb_substr_split_unicode( $str, $splitPos ) {
if ( $splitPos == 0 ) {
return 0;
}
$byteLen = strlen( $str );
if ( $splitPos > 0 ) {
if ( $splitPos > 256 ) {
// Optimize large string offsets by skipping ahead N bytes.
// This will cut out most of our slow time on Latin-based text,
// and 1/2 to 1/3 on East European and Asian scripts.
$bytePos = $splitPos;
while ( $bytePos < $byteLen && $str[$bytePos] >= "\x80" && $str[$bytePos] < "\xc0" ) {
++$bytePos;
}
$charPos = mb_strlen( substr( $str, 0, $bytePos ) );
} else {
$charPos = 0;
$bytePos = 0;
}
while ( $charPos++ < $splitPos ) {
++$bytePos;
// Move past any tail bytes
while ( $bytePos < $byteLen && $str[$bytePos] >= "\x80" && $str[$bytePos] < "\xc0" ) {
++$bytePos;
}
}
} else {
$splitPosX = $splitPos + 1;
$charPos = 0; // relative to end of string; we don't care about the actual char position here
$bytePos = $byteLen;
while ( $bytePos > 0 && $charPos-- >= $splitPosX ) {
--$bytePos;
// Move past any tail bytes
while ( $bytePos > 0 && $str[$bytePos] >= "\x80" && $str[$bytePos] < "\xc0" ) {
--$bytePos;
}
}
}
return $bytePos;
}
/**
* @since 4.7
* @param string $str
* @return int
*/
public static function mb_strlen( $str, $enc = '' ) {
if ( function_exists( 'mb_strlen' ) ) {
return mb_strlen( $str );
}
$counts = count_chars( $str );
$total = 0;
// Count ASCII bytes
for ( $i = 0; $i < 0x80; $i++ ) {
$total += $counts[$i];
}
// Count multibyte sequence heads
for ( $i = 0xc0; $i < 0xff; $i++ ) {
$total += $counts[$i];
}
return $total;
}
/**
* @since 4.7
* @param string $haystack
* @param string $needle
* @param int $offset
* @return int|boolean
*/
public static function mb_strpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
if ( function_exists( 'mb_strpos' ) ) {
return mb_strpos( $haystack, $needle, $offset );
}
$needle = preg_quote( $needle, '/' );
$ar = array();
preg_match( '/' . $needle . '/u', $haystack, $ar, PREG_OFFSET_CAPTURE, $offset );
if ( isset( $ar[0][1] ) ) {
return $ar[0][1];
} else {
return false;
}
}
/**
* @since 4.7
* @param string $haystack
* @param string $needle
* @param int $offset
* @return int|boolean
*/
public static function mb_stripos( $haystack, $needle, $offset = 0, $encoding = '' ) {
if ( function_exists( 'mb_stripos' ) ) {
return mb_stripos( $haystack, $needle, $offset );
}
$needle = preg_quote( $needle, '/' );
$ar = array();
preg_match( '/' . $needle . '/ui', $haystack, $ar, PREG_OFFSET_CAPTURE, $offset );
if ( isset( $ar[0][1] ) ) {
return $ar[0][1];
} else {
return false;
}
}
/**
* @since 4.7
* @param string $haystack
* @param string $needle
* @param int $offset
* @return int|boolean
*/
public static function mb_strrpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
if ( function_exists( 'mb_strrpos' ) ) {
return mb_strrpos( $haystack, $needle, $offset );
}
$needle = preg_quote( $needle, '/' );
$ar = array();
preg_match_all( '/' . $needle . '/u', $haystack, $ar, PREG_OFFSET_CAPTURE, $offset );
if ( isset( $ar[0] ) && count( $ar[0] ) > 0 && isset( $ar[0][count( $ar[0] ) - 1][1] ) ) {
return $ar[0][count( $ar[0] ) - 1][1];
} else {
return false;
}
}
/**
* Lowercase a UTF-8 string.
* This supports accented letters, but nothing more.
* Taken from {@link https://github.com/drupal/drupal/blob/9.x/core/includes/unicode.inc#L432 here}.
*
* @since 4.7
* @param string $text The string to run the operation on.
* @return string The string in lowercase.
*/
public static function mb_strtolower( $text ) {
if ( function_exists( 'mb_strtolower' ) )
return mb_strtolower( $text );
// Use C-locale for ASCII-only lowercase
$text = strtolower( $text );
// Case flip Latin-1 accented letters
$text = preg_replace_callback( '/\xC3[\x80-\x96\x98-\x9E]/', array( __CLASS__, '_unicode_caseflip' ), $text );
return $text;
}
/**
* Flips U+C0-U+DE to U+E0-U+FD and back.
*
* @since 4.7
* @param $matches An array of matches.
* @return array The Latin-1 version of the array of matches.
* @see mb_strtolower()
*/
public static function _unicode_caseflip( $matches ) {
return $matches[0][0] . chr( ord( $matches[0][1] ) ^ 32 );
}
}
#-----------------------------------------
# RT-Theme wpml_functions.php
#-----------------------------------------
if( ! function_exists("rtframework_wpml_get_current_language") ){
/**
* rtframework_wpml_get_current_language
* @return string language
*/
function rtframework_wpml_get_current_language(){
return apply_filters( 'wpml_current_language', NULL );
}
}
#
# WPML match page id
# returns the page of default language
# @returns $id
#
if( ! function_exists("rtframework_wpml_page_id") ){
function rtframework_wpml_page_id($id){
$default_language = apply_filters( 'wpml_default_language', null );
return apply_filters( 'wpml_object_id', $id, 'page', true, $default_language);
}
}
#
# WPML match page id
# returns the current language version of the page
# @returns $id
#
if( ! function_exists("rtframework_wpml_translated_page_id") ){
function rtframework_wpml_translated_page_id($id){
return apply_filters( 'wpml_object_id', $id, 'page' );
}
}
#
# WPML match post id
# return the id's translated version
#
if( ! function_exists("rtframework_wpml_post_id") ){
function rtframework_wpml_post_id( $id = "", $post_type = "post"){
return apply_filters( 'wpml_object_id', $id, $post_type, true);
}
}
#
# WPML match category id
#
if( ! function_exists("rtframework_wpml_category_id") ){
function rtframework_wpml_category_id($id){
$default_language = apply_filters( 'wpml_default_language', null );
return apply_filters( 'wpml_object_id', $id, 'category', true, $default_language);
}
}
#
# WPML match portfolio category id
#
if( ! function_exists("rtframework_wpml_portfolio_category_id") ){
function rtframework_wpml_portfolio_category_id($id){
$default_language = apply_filters( 'wpml_default_language', null );
return apply_filters( 'wpml_object_id', $id, 'portfolio_categories', true, $default_language);
}
}
#
# WPML match categories
#
if( ! function_exists("rtframework_wpml_lang_object_ids") ){
function rtframework_wpml_lang_object_ids($ids_array = array(), $type = "", $language = "") {
if(function_exists('icl_object_id')) {
global $sitepress;
if( empty( $language ) ){
$language = apply_filters( 'wpml_default_language', null );
}
//if provided ids is an array
if( is_array( $ids_array ) ){
$res = array();
foreach ($ids_array as $id) {
$xlat = apply_filters( 'wpml_object_id', $id, $type, false, $language);
if(!is_null($xlat)) $res[] = $xlat;
}
return $res;
}else{
$res = array();
$ids_array = explode(",", $ids_array);
foreach ($ids_array as $id) {
$xlat = apply_filters( 'wpml_object_id', $id, $type, false, $language);
if(!is_null($xlat)) $res[] = $xlat;
}
return implode( ",", $res );
}
} else {
return $ids_array;
}
}
}
#
# Get WPML Plugin Flags
#
if( ! function_exists("rtframework_wpml_languages_list") ){
function rtframework_wpml_languages_list( $flags = false ){
if( ! function_exists('icl_get_languages')) {
return;
}
$languages = icl_get_languages('skip_missing=0');
if(!empty($languages)){
echo '';
foreach($languages as $l){
echo '- ';
if($l['country_flag_url']){
if($flags){
echo '
';
}
echo ''.$l['native_name'].'';
}
echo ' ';
}
echo '
';
}
}
}
#
# Get WPML Plugin Flags
#
if( ! function_exists("rtframework_wpml_languages_custom_flags") ){
function rtframework_wpml_languages_custom_flags(){
if( ! function_exists('icl_get_languages')) {
return;
}
$languages = icl_get_languages('skip_missing=0');
if(!empty($languages)){
echo ''."\n";
foreach($languages as $l){
$code = isset( $l['language_code'] ) ? $l['language_code'] : "";
$code = isset( $l['code'] ) ? $l['code'] : $code;
if( ! strpos($l['country_flag_url'], "sitepress-multilingual-cms") || ! file_exists(get_template_directory()."/images/flags/".$code.".png") ){
$img_url = $l['country_flag_url'];
}else{
$img_url = get_template_directory_uri()."/images/flags/".$code.".png";
}
echo '- '."\n";
if($l['country_flag_url']){
echo "\t".''.$l['native_name'].''."\n";
}
echo '
'."\n";
}
echo '
'."\n";
}
}
}
#
# WPML Home URL
#
if( ! function_exists("rtframework_wpml_get_home_url") ){
function rtframework_wpml_get_home_url(){
$home_url = apply_filters( 'wpml_home_url', home_url() );
return rtrim( $home_url, '/') . '/';
}
}
#
# WPML String Register
#
if( ! function_exists("rtframework_wpml_register_string") ){
function rtframework_wpml_register_string($context, $name, $value){
if ( trim( $value ) ){
do_action( 'wpml_register_single_string', $context, $name, $value );
}
}
}
#
# WPML Get Registered String
if( ! function_exists("rtframework_wpml_t") ){
/**
* Get string translation of a theme mod value
* @return string
*/
function rtframework_wpml_t($name="", $field="", $value=""){
if(function_exists('icl_translate')) {
return apply_filters( 'wpml_translate_single_string', $value, $field, $name );
}
return $value;
}
}
?>