%PDF-
%PDF-
Mini Shell
Mini Shell
<?php
/**
*
* @package Duplicator
* @copyright (c) 2021, Snapcreek LLC
*
*/
namespace Duplicator\Libs\Snap;
/**
* Wordpress utility functions
*
* old: SnapWP
*/
class SnapWP
{
const DEFAULT_MAX_GET_SITES_NUMBER = 10000;
const PATH_FULL = 0;
const PATH_RELATIVE = 1;
const PATH_AUTO = 2;
private static $corePathList = null;
private static $safeAbsPath = null;
/**
*
* @var string if not empty alters isWpCore's operation
*/
private static $wpCoreRelativePath = '';
/**
* return safe ABSPATH without last /
* perform safe function only one time
*
* @return string
*/
public static function getSafeAbsPath()
{
if (is_null(self::$safeAbsPath)) {
if (defined('ABSPATH')) {
self::$safeAbsPath = SnapIO::safePathUntrailingslashit(ABSPATH);
} else {
self::$safeAbsPath = '';
}
}
return self::$safeAbsPath;
}
/**
* Return wp-config path or false if not found
*
* @return bool|string
*/
public static function getWPConfigPath()
{
static $configPath = null;
if (is_null($configPath)) {
$absPath = SnapIO::safePathTrailingslashit(ABSPATH, true);
$absParent = dirname($absPath) . '/';
if (file_exists($absPath . 'wp-config.php')) {
$configPath = $absPath . 'wp-config.php';
} elseif (@file_exists($absParent . 'wp-config.php') && !@file_exists($absParent . 'wp-settings.php')) {
$configPath = $absParent . 'wp-config.php';
} else {
$configPath = false;
}
}
return $configPath;
}
/**
* Get wordpress table info by table name
*
* @param string $table table name
* @param string $prefix wordpress prefix
*
* @return array [
* 'isCore' => bool,
* 'havePrefix' => bool,
* 'subsiteId' => int,
* 'isMultisiteCore' => bool
* ]
*/
public static function getTableInfoByName($table, $prefix)
{
$result = array(
'isCore' => false,
'havePrefix' => false,
'subsiteId' => -1,
'isMultisiteCore' => false
);
if (preg_match('/^' . preg_quote($prefix, '/') . '(?:(\d+)_)?(.+)/', $table, $matches) !== 1) {
return $result;
}
$result['havePrefix'] = true;
$nameWithoutPrefix = $matches[2];
$result['isMultisiteCore'] = in_array($nameWithoutPrefix, self::getMultisiteTables());
$result['isCore'] = $result['isMultisiteCore'] || in_array($nameWithoutPrefix, self::getSiteCoreTables());
if (is_numeric($matches[1])) {
$result['subsiteId'] = (int) $matches[1];
} elseif (!$result['isMultisiteCore']) {
$result['subsiteId'] = 1;
}
return $result;
}
/**
* Get the list of wp prefixes from given tables list
*
* @param string[] $tables List of table names to check for unique WP prefixes
*
* @return string[]
*/
public static function getUniqueWPTablePrefixes($tables)
{
$userPrefix = array();
$userMetaPrefix = array();
foreach ($tables as $table) {
if (preg_match("/^(.*)users$/m", $table, $matches)) {
$userPrefix[] = $matches[1];
} elseif (preg_match("/^(.*)usermeta$/m", $table, $matches)) {
$userMetaPrefix[] = $matches[1];
}
}
return array_intersect($userPrefix, $userMetaPrefix);
}
/**
* Modifies the database based on specified SQL statements.
*
* Useful for creating new tables and updating existing tables to a new structure.
*
* From Wordpress dbDelta
*
* @global \wpdb $wpdb WordPress database abstraction object.
*
* @param string[]|string $queries Optional. The query to run. Can be multiple queries
* in an array, or a string of queries separated by
* semicolons. Default empty string.
* @param bool $execute Optional. Whether or not to execute the query right away.
* Default true.
* @return array Strings containing the results of the various update queries.
*/
public static function dbDelta($queries = '', $execute = true)
{
$mysqliDriver = new \mysqli_driver();
$defReporting = $mysqliDriver->report_mode;
mysqli_report(MYSQLI_REPORT_OFF);
$result = dbDelta($queries, $execute);
mysqli_report($defReporting);
return $result;
}
/**
* Get Auto_increment value of wp_blogs table in multisite.
* That is id of the first next subsite that will be imported.
*
* @return int // returns Auto_increment value of wp_blogs table in multisite,
* // returns -1 if Auto_increment value can not be obtained for any reason
*/
public static function getNextSubsiteIdAI()
{
$nextSubsiteIdAI = -1;
if (!is_multisite()) {
return $nextSubsiteIdAI;
}
/** @var \wpdb $wpdb */
global $wpdb;
$sql = $wpdb->prepare("SHOW TABLE STATUS LIKE %s", $wpdb->prefix . "blogs");
$result = $wpdb->get_results($sql, ARRAY_A);
if (count($result) < 1) {
return $nextSubsiteIdAI;
}
$row = $result[0];
if (array_key_exists("Auto_increment", $row)) {
$nextSubsiteIdAI = intval($row["Auto_increment"]);
}
return $nextSubsiteIdAI;
}
/**
* From a tables list filters all tables without WP prefix
*
* @param string[] $tables tables list
*
* @return string[]
*/
public static function getTablesWithPrefix($tables)
{
/** @var \wpdb $wpdb */
global $wpdb;
$tables = (array) $tables;
$result = array();
foreach ($tables as $table) {
if (strpos($table, $wpdb->prefix) === 0) {
$result[] = $table;
}
}
return $result;
}
/**
* Check if passed folder is home folder
*
* @param string $folder folder path
*
* @return boolean return true if folder is wordpress home folder
*
*/
public static function isWpHomeFolder($folder)
{
$indexPhp = SnapIO::trailingslashit($folder) . 'index.php';
if (!file_exists($indexPhp)) {
return false;
}
if (($indexContent = file_get_contents($indexPhp)) === false) {
return false;
}
return (preg_match('/require\s*[\s\(].*[\'"].*wp-blog-header.php[\'"]\s*\)?/', $indexContent) === 1);
}
/**
* This function is the equivalent of the get_home_path function but with various fixes
*
* @staticvar string $home_path
* @return string
*/
public static function getHomePath()
{
static $home_path = null;
if (is_null($home_path)) {
// outside wordpress this function makes no sense
if (!defined('ABSPATH')) {
$home_path = false;
return $home_path;
}
if (isset($_SERVER['SCRIPT_FILENAME']) && is_readable($_SERVER['SCRIPT_FILENAME'])) {
$scriptFilename = $_SERVER['SCRIPT_FILENAME'];
} else {
$files = get_included_files();
$scriptFilename = array_shift($files);
}
$realScriptDirname = SnapIO::safePathTrailingslashit(dirname($scriptFilename), true);
$realAbsPath = SnapIO::safePathTrailingslashit(ABSPATH, true);
if (strpos($realScriptDirname, $realAbsPath) === 0) {
// normalize URLs without www
$home = SnapURL::wwwRemove(set_url_scheme(get_option('home'), 'http'));
$siteurl = SnapURL::wwwRemove(set_url_scheme(get_option('siteurl'), 'http'));
if (!empty($home) && 0 !== strcasecmp($home, $siteurl)) {
if (stripos($siteurl, $home) === 0) {
$wp_path_rel_to_home = str_ireplace($home, '', $siteurl); /* $siteurl - $home */
$pos = strripos(
str_replace('\\', '/', $scriptFilename),
SnapIO::trailingslashit($wp_path_rel_to_home)
);
$home_path = substr($scriptFilename, 0, $pos);
$home_path = SnapIO::trailingslashit($home_path);
} else {
$home_path = ABSPATH;
}
} else {
$home_path = ABSPATH;
}
} else {
// On frontend the home path is the folder of index.php
$home_path = SnapIO::trailingslashit(dirname($scriptFilename));
}
// make sure the folder exists or consider ABSPATH
if (!file_exists($home_path)) {
$home_path = ABSPATH;
}
$home_path = str_replace('\\', '/', $home_path);
}
return $home_path;
}
/**
* Return admin url, if is multisite return network_admin_url
*
* @param string $path Optional. Path relative to the admin URL. Default 'admin'.
* @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl().
* 'http' or 'https' can be passed to force those schemes.
* @return string Admin URL link with optional path appended.
*/
public static function getAdminUrl($path, $scheme = 'admin')
{
if (is_multisite()) {
return network_admin_url($path, $scheme);
} else {
return admin_url($path, $scheme);
}
}
/**
* Ser relative abs path
*
* @param string $string abs path
*
* @return void
*/
public static function setWpCoreRelativeAbsPath($string = '')
{
self::$wpCoreRelativePath = (string) $string;
}
/**
* check if path is in wordpress core list
* PATH_FULL and PATH_RELATIVE is better optimized and perform less operations
*
* @param string $path file path
* @param int $fullPath if PATH_AUTO check if is a full path or relative path
* if PATH_FULL remove ABSPATH len without check
* if PATH_RELATIVE consider path a relative path
* @param bool $isSafe if false call rtrim(SnapIO::safePath( PATH ), '/')
* if true consider path a safe path without check
*
*
* @return boolean
*/
public static function isWpCore($path, $fullPath = self::PATH_AUTO, $isSafe = false)
{
if ($isSafe == false) {
$path = rtrim(SnapIO::safePath($path), '/');
}
switch ($fullPath) {
case self::PATH_FULL:
$absPath = self::getSafeAbsPath();
if (strlen($path) < strlen($absPath)) {
return false;
}
$relPath = ltrim(substr($path, strlen($absPath)), '/');
break;
case self::PATH_RELATIVE:
if (($relPath = SnapIO::getRelativePath($path, self::$wpCoreRelativePath)) === false) {
return false;
}
break;
case self::PATH_AUTO:
default:
$absPath = self::getSafeAbsPath();
if (strpos($path, $absPath) === 0) {
$relPath = ltrim(substr($path, strlen($absPath)), '/');
} else {
$relPath = ltrim($path, '/');
}
}
// if rel path is empty is consider root path so is a core folder.
if (strlen($relPath) === 0) {
return true;
}
$pExploded = explode('/', $relPath);
$corePaths = self::getCorePathsList();
foreach ($pExploded as $current) {
if (!isset($corePaths[$current])) {
return false;
}
if (is_scalar($corePaths[$current])) {
// is file so don't have childs
$corePaths = array();
} else {
$corePaths = $corePaths[$current];
}
}
return true;
}
/**
*
* @param string $relPath // if empty is consider abs root path
* @return array // [ 'dirs' => [] , 'files' => [] ]
*/
public static function getWpCoreFilesListInFolder($relPath = '')
{
$corePaths = self::getCorePathsList();
if (strlen($relPath) > 0) {
$pExploded = explode('/', $relPath);
foreach ($pExploded as $current) {
if (!isset($corePaths[$current])) {
$corePaths = array();
break;
}
if (is_scalar($corePaths[$current])) {
// is file so don't have childs
$corePaths = array();
} else {
$corePaths = $corePaths[$current];
}
}
}
$result = array(
'dirs' => array(),
'files' => array()
);
foreach ($corePaths as $name => $content) {
if (is_array($content)) {
$result['dirs'][] = $name;
} else {
$result['files'][] = $name;
}
}
return $result;
}
/**
* get core path list from relative abs path
* [
* 'folder' => [
* 's-folder1' => [
* file1 => [],
* file2 => [],
* ],
* 's-folder2' => [],
* file1 => []
* ]
* ]
*
* @return array
*/
public static function getCorePathsList()
{
if (is_null(self::$corePathList)) {
require_once(dirname(__FILE__) . '/wordpress_core_files.php');
}
return self::$corePathList;
}
/**
* Returns the main site ID for the network.
*
* Copied from the source of the get_main_site_id() except first line in https://developer.wordpress.org/reference/functions/get_main_site_id/
* get_main_site_id() is introduced in WP 4.9.0. It is for backward compatibility
*
* @param int|null $network_id network id
*
* @return int The ID of the main site.
*/
public static function getMainSiteId($network_id = null)
{
// For > WP 4.9.0
if (function_exists('get_main_site_id')) {
return get_main_site_id($network_id);
}
if (!is_multisite()) {
return get_current_blog_id();
}
$network = function_exists('get_network') ? get_network($network_id) : wp_get_network($network_id);
if (!$network) {
return 0;
}
return $network->site_id;
}
/**
* Return object list of sites
*
* @param string|array $args list of filters, see wordpress get_sites function
*
* @return WP_Site[]|int[] site list or ids
*/
public static function getSites($args = array())
{
if (!function_exists('is_multisite') || !is_multisite()) {
return false;
}
if (!isset($args['number'])) {
$args['number'] = self::DEFAULT_MAX_GET_SITES_NUMBER;
}
if (function_exists('get_sites')) {
return get_sites($args);
} else {
$result = array();
$blogs = wp_get_sites($args);
$returnIds = (isset($args['fields']) && $args['fields'] === 'ids');
foreach ($blogs as $blog) {
if (is_array($blog)) {
$blog = (object) $blog;
}
$result[] = ($returnIds ? $blog->blog_id : $blog);
}
return $result;
}
}
/**
* Return list of subiste ids
*
* @return int[]
*/
public static function getSitesIds()
{
if (!is_multisite()) {
return array(1);
}
return SnapWP::getSites(array('fields' => 'ids'));
}
/**
* return the list of possible dropins plugins
*
* @return string[]
*/
public static function getDropinsPluginsNames()
{
return array(
'advanced-cache.php', // WP_CACHE
'db.php', // auto on load
'db-error.php', // auto on error
'install.php', // auto on installation
'maintenance.php', // auto on maintenance
'object-cache.php', // auto on load
'php-error.php', // auto on error
'fatal-error-handler.php', // auto on error
'sunrise.php',
'blog-deleted.php',
'blog-inactive.php',
'blog-suspended.php'
);
}
/**
* Return site and subsite tables names without prefix
*
* @return string[]
*/
public static function getSiteCoreTables()
{
return array(
'commentmeta',
'comments',
'links',
'options',
'postmeta',
'posts',
'term_relationships',
'term_taxonomy',
'terms',
'termmeta'
);
}
/**
* Return multisite general tables without prefix
*
* @return string[]
*/
public static function getMultisiteTables()
{
return array(
'blogmeta',
'blogs',
'blog_versions',
'registration_log',
'signups',
'site',
'sitemeta'
);
}
/**
* Returns wp option "timezone_string"
*
* @return string // timezone_string, will be empty if manual offset is chosen
*/
public static function getTimeZoneString()
{
static $timezoneString = null;
if (is_null($timezoneString)) {
$timezoneString = get_option('timezone_string');
}
return $timezoneString;
}
/**
* Returns 1 if DST is active on given timestamp, 0 if it's not active.
* Currently active timezone is taken into account.
*
* @param integer $timestamp In seconds
*
* @return integer // 1 if DST is active, 0 otherwise
*/
public static function getDST($timestamp)
{
$timezoneString = self::getTimeZoneString();
if (!$timezoneString) {
// There is no DST if manual offset is chosen in WP settings timezone
return 0;
}
$date = new \DateTime();
$date->setTimestamp($timestamp);
$date->setTimezone(new \DateTimeZone($timezoneString));
return $date->format('I');
}
/**
* Converts timestamp to date string with given format, according to
* currently selected timezone in Wordpress settings
*
* @param string $format Format for date
* @param integer $timestamp In seconds
*
* @return string // Date converted to string in currently selected timezone
*/
public static function getDateInWPTimezone($format, $timestamp)
{
$timezoneString = self::getTimeZoneString();
if ($timezoneString) {
// Particular timezone is selected, not manual offset. This means that DST could be in place,
// and we can't use current gmt_offset. We have to use the timezone!
$date = new \DateTime();
$date->setTimestamp($timestamp);
$date->setTimezone(new \DateTimeZone($timezoneString));
return $date->format($format);
}
// Manual offset is selected. In this case there is no DST so we can
// create the date string using current gmt_offset.
$local_time = $timestamp + ((int) get_option('gmt_offset') * 3600);
return (string) date($format, $local_time);
}
/**
*
* @param int $blogId // f multisite and blogId > 0 return the user of blog
* @return array
*/
public static function getAdminUserLists($blogId = 0)
{
$args = array(
'fields' => array('id', 'user_login')
);
if (is_multisite()) {
$args['blog_id'] = $blogId;
if ($blogId == 0) {
$args['login__in'] = get_site_option('site_admins');
}
} else {
$args['role'] = 'administrator';
}
return get_users($args);
}
/**
* Return post types count
*
* @return array
*/
public static function getPostTypesCount()
{
$postTypes = get_post_types();
$postTypeCount = array();
foreach ($postTypes as $postName) {
$postObj = get_post_type_object($postName);
if (!$postObj->public) {
continue;
}
$postCountForTypes = (array) wp_count_posts($postName);
$postCount = 0;
foreach ($postCountForTypes as $num) {
$postCount += $num;
}
$postTypeCount[$postObj->label] = $postCount;
}
return $postTypeCount;
}
}
Zerion Mini Shell 1.0