mirror of
https://github.com/WordPress/WordPress.git
synced 2024-11-05 02:10:45 +01:00
fa1e1a8850
Move the internals of `get_network_by_path()` to `WP_Network()` and allow network objects to be retrieved by passing a requested domain and path. Props johnjamesjacoby, jeremyfelt, drewapicture, wonderboymusic. See #31985. Built from https://develop.svn.wordpress.org/trunk@34099 git-svn-id: http://core.svn.wordpress.org/trunk@34067 1a063a9b-81f0-0310-95a4-ce76da25c4cd
350 lines
11 KiB
PHP
350 lines
11 KiB
PHP
<?php
|
|
/**
|
|
* These functions are needed to load Multisite.
|
|
*
|
|
* @since 3.0.0
|
|
*
|
|
* @package WordPress
|
|
* @subpackage Multisite
|
|
*/
|
|
|
|
/**
|
|
* Whether a subdomain configuration is enabled.
|
|
*
|
|
* @since 3.0.0
|
|
*
|
|
* @return bool True if subdomain configuration is enabled, false otherwise.
|
|
*/
|
|
function is_subdomain_install() {
|
|
if ( defined('SUBDOMAIN_INSTALL') )
|
|
return SUBDOMAIN_INSTALL;
|
|
|
|
return ( defined( 'VHOST' ) && VHOST == 'yes' );
|
|
}
|
|
|
|
/**
|
|
* Returns array of network plugin files to be included in global scope.
|
|
*
|
|
* The default directory is wp-content/plugins. To change the default directory
|
|
* manually, define `WP_PLUGIN_DIR` and `WP_PLUGIN_URL` in `wp-config.php`.
|
|
*
|
|
* @access private
|
|
* @since 3.1.0
|
|
*
|
|
* @return array Files to include.
|
|
*/
|
|
function wp_get_active_network_plugins() {
|
|
$active_plugins = (array) get_site_option( 'active_sitewide_plugins', array() );
|
|
if ( empty( $active_plugins ) )
|
|
return array();
|
|
|
|
$plugins = array();
|
|
$active_plugins = array_keys( $active_plugins );
|
|
sort( $active_plugins );
|
|
|
|
foreach ( $active_plugins as $plugin ) {
|
|
if ( ! validate_file( $plugin ) // $plugin must validate as file
|
|
&& '.php' == substr( $plugin, -4 ) // $plugin must end with '.php'
|
|
&& file_exists( WP_PLUGIN_DIR . '/' . $plugin ) // $plugin must exist
|
|
)
|
|
$plugins[] = WP_PLUGIN_DIR . '/' . $plugin;
|
|
}
|
|
return $plugins;
|
|
}
|
|
|
|
/**
|
|
* Checks status of current blog.
|
|
*
|
|
* Checks if the blog is deleted, inactive, archived, or spammed.
|
|
*
|
|
* Dies with a default message if the blog does not pass the check.
|
|
*
|
|
* To change the default message when a blog does not pass the check,
|
|
* use the wp-content/blog-deleted.php, blog-inactive.php and
|
|
* blog-suspended.php drop-ins.
|
|
*
|
|
* @since 3.0.0
|
|
*
|
|
* @return true|string Returns true on success, or drop-in file to include.
|
|
*/
|
|
function ms_site_check() {
|
|
$blog = get_blog_details();
|
|
|
|
/**
|
|
* Filter checking the status of the current blog.
|
|
*
|
|
* @since 3.0.0
|
|
*
|
|
* @param bool null Whether to skip the blog status check. Default null.
|
|
*/
|
|
$check = apply_filters( 'ms_site_check', null );
|
|
if ( null !== $check )
|
|
return true;
|
|
|
|
// Allow super admins to see blocked sites
|
|
if ( is_super_admin() )
|
|
return true;
|
|
|
|
if ( '1' == $blog->deleted ) {
|
|
if ( file_exists( WP_CONTENT_DIR . '/blog-deleted.php' ) )
|
|
return WP_CONTENT_DIR . '/blog-deleted.php';
|
|
else
|
|
wp_die( __( 'This site is no longer available.' ), '', array( 'response' => 410 ) );
|
|
}
|
|
|
|
if ( '2' == $blog->deleted ) {
|
|
if ( file_exists( WP_CONTENT_DIR . '/blog-inactive.php' ) )
|
|
return WP_CONTENT_DIR . '/blog-inactive.php';
|
|
else
|
|
wp_die( sprintf( __( 'This site has not been activated yet. If you are having problems activating your site, please contact <a href="mailto:%1$s">%1$s</a>.' ), str_replace( '@', ' AT ', get_site_option( 'admin_email', 'support@' . get_current_site()->domain ) ) ) );
|
|
}
|
|
|
|
if ( $blog->archived == '1' || $blog->spam == '1' ) {
|
|
if ( file_exists( WP_CONTENT_DIR . '/blog-suspended.php' ) )
|
|
return WP_CONTENT_DIR . '/blog-suspended.php';
|
|
else
|
|
wp_die( __( 'This site has been archived or suspended.' ), '', array( 'response' => 410 ) );
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Retrieve a network object by its domain and path.
|
|
*
|
|
* @since 3.9.0
|
|
* @since 4.4.0 Converted to a wrapper for WP_Network::get_by_path()
|
|
*
|
|
* @param string $domain Domain to check.
|
|
* @param string $path Path to check.
|
|
* @param int|null $segments Path segments to use. Defaults to null, or the full path.
|
|
* @return WP_Network|false Network object if successful. False when no network is found.
|
|
*/
|
|
function get_network_by_path( $domain, $path, $segments = null ) {
|
|
return WP_Network::get_by_path( $domain, $path, $segments );
|
|
}
|
|
|
|
/**
|
|
* Retrieve an object containing information about the requested network.
|
|
*
|
|
* @since 3.9.0
|
|
* @since 4.4.0 Converted to leverage WP_Network
|
|
*
|
|
* @param object|int $network The network's database row or ID.
|
|
* @return WP_Network|false Object containing network information if found, false if not.
|
|
*/
|
|
function wp_get_network( $network ) {
|
|
if ( ! is_object( $network ) ) {
|
|
$network = WP_Network::get_instance( $network );
|
|
} else {
|
|
$network = new WP_Network( $network );
|
|
}
|
|
|
|
return $network;
|
|
}
|
|
|
|
/**
|
|
* Retrieve a site object by its domain and path.
|
|
*
|
|
* @since 3.9.0
|
|
*
|
|
* @global wpdb $wpdb
|
|
*
|
|
* @param string $domain Domain to check.
|
|
* @param string $path Path to check.
|
|
* @param int|null $segments Path segments to use. Defaults to null, or the full path.
|
|
* @return object|false Site object if successful. False when no site is found.
|
|
*/
|
|
function get_site_by_path( $domain, $path, $segments = null ) {
|
|
global $wpdb;
|
|
|
|
$path_segments = array_filter( explode( '/', trim( $path, '/' ) ) );
|
|
|
|
/**
|
|
* Filter the number of path segments to consider when searching for a site.
|
|
*
|
|
* @since 3.9.0
|
|
*
|
|
* @param int|null $segments The number of path segments to consider. WordPress by default looks at
|
|
* one path segment following the network path. The function default of
|
|
* null only makes sense when you know the requested path should match a site.
|
|
* @param string $domain The requested domain.
|
|
* @param string $path The requested path, in full.
|
|
*/
|
|
$segments = apply_filters( 'site_by_path_segments_count', $segments, $domain, $path );
|
|
|
|
if ( null !== $segments && count( $path_segments ) > $segments ) {
|
|
$path_segments = array_slice( $path_segments, 0, $segments );
|
|
}
|
|
|
|
$paths = array();
|
|
|
|
while ( count( $path_segments ) ) {
|
|
$paths[] = '/' . implode( '/', $path_segments ) . '/';
|
|
array_pop( $path_segments );
|
|
}
|
|
|
|
$paths[] = '/';
|
|
|
|
/**
|
|
* Determine a site by its domain and path.
|
|
*
|
|
* This allows one to short-circuit the default logic, perhaps by
|
|
* replacing it with a routine that is more optimal for your setup.
|
|
*
|
|
* Return null to avoid the short-circuit. Return false if no site
|
|
* can be found at the requested domain and path. Otherwise, return
|
|
* a site object.
|
|
*
|
|
* @since 3.9.0
|
|
*
|
|
* @param null|bool|object $site Site value to return by path.
|
|
* @param string $domain The requested domain.
|
|
* @param string $path The requested path, in full.
|
|
* @param int|null $segments The suggested number of paths to consult.
|
|
* Default null, meaning the entire path was to be consulted.
|
|
* @param array $paths The paths to search for, based on $path and $segments.
|
|
*/
|
|
$pre = apply_filters( 'pre_get_site_by_path', null, $domain, $path, $segments, $paths );
|
|
if ( null !== $pre ) {
|
|
return $pre;
|
|
}
|
|
|
|
/*
|
|
* @todo
|
|
* get_blog_details(), caching, etc. Consider alternative optimization routes,
|
|
* perhaps as an opt-in for plugins, rather than using the pre_* filter.
|
|
* For example: The segments filter can expand or ignore paths.
|
|
* If persistent caching is enabled, we could query the DB for a path <> '/'
|
|
* then cache whether we can just always ignore paths.
|
|
*/
|
|
|
|
// Either www or non-www is supported, not both. If a www domain is requested,
|
|
// query for both to provide the proper redirect.
|
|
$domains = array( $domain );
|
|
if ( 'www.' === substr( $domain, 0, 4 ) ) {
|
|
$domains[] = substr( $domain, 4 );
|
|
$search_domains = "'" . implode( "', '", $wpdb->_escape( $domains ) ) . "'";
|
|
}
|
|
|
|
if ( count( $paths ) > 1 ) {
|
|
$search_paths = "'" . implode( "', '", $wpdb->_escape( $paths ) ) . "'";
|
|
}
|
|
|
|
if ( count( $domains ) > 1 && count( $paths ) > 1 ) {
|
|
$site = $wpdb->get_row( "SELECT * FROM $wpdb->blogs WHERE domain IN ($search_domains) AND path IN ($search_paths) ORDER BY CHAR_LENGTH(domain) DESC, CHAR_LENGTH(path) DESC LIMIT 1" );
|
|
} elseif ( count( $domains ) > 1 ) {
|
|
$sql = $wpdb->prepare( "SELECT * FROM $wpdb->blogs WHERE path = %s", $paths[0] );
|
|
$sql .= " AND domain IN ($search_domains) ORDER BY CHAR_LENGTH(domain) DESC LIMIT 1";
|
|
$site = $wpdb->get_row( $sql );
|
|
} elseif ( count( $paths ) > 1 ) {
|
|
$sql = $wpdb->prepare( "SELECT * FROM $wpdb->blogs WHERE domain = %s", $domains[0] );
|
|
$sql .= " AND path IN ($search_paths) ORDER BY CHAR_LENGTH(path) DESC LIMIT 1";
|
|
$site = $wpdb->get_row( $sql );
|
|
} else {
|
|
$site = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->blogs WHERE domain = %s AND path = %s", $domains[0], $paths[0] ) );
|
|
}
|
|
|
|
if ( $site ) {
|
|
// @todo get_blog_details()
|
|
return $site;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Displays a failure message.
|
|
*
|
|
* Used when a blog's tables do not exist. Checks for a missing $wpdb->site table as well.
|
|
*
|
|
* @access private
|
|
* @since 3.0.0
|
|
* @since 4.4.0 The `$domain` and `$path` parameters were added.
|
|
*
|
|
* @global wpdb $wpdb
|
|
*
|
|
* @param string $domain The requested domain for the error to reference.
|
|
* @param string $path The requested path for the error to reference.
|
|
*/
|
|
function ms_not_installed( $domain, $path ) {
|
|
global $wpdb;
|
|
|
|
if ( ! is_admin() ) {
|
|
dead_db();
|
|
}
|
|
|
|
wp_load_translations_early();
|
|
|
|
$title = __( 'Error establishing a database connection' );
|
|
|
|
$msg = '<h1>' . $title . '</h1>';
|
|
$msg .= '<p>' . __( 'If your site does not display, please contact the owner of this network.' ) . '';
|
|
$msg .= ' ' . __( 'If you are the owner of this network please check that MySQL is running properly and all tables are error free.' ) . '</p>';
|
|
$query = $wpdb->prepare( "SHOW TABLES LIKE %s", $wpdb->esc_like( $wpdb->site ) );
|
|
if ( ! $wpdb->get_var( $query ) ) {
|
|
$msg .= '<p>' . sprintf(
|
|
/* translators: %s: table name */
|
|
__( '<strong>Database tables are missing.</strong> This means that MySQL is not running, WordPress was not installed properly, or someone deleted %s. You really should look at your database now.' ),
|
|
'<code>' . $wpdb->site . '</code>'
|
|
) . '</p>';
|
|
} else {
|
|
$msg .= '<p>' . sprintf(
|
|
/* translators: 1: site url, 2: table name, 3: database name */
|
|
__( '<strong>Could not find site %1$s.</strong> Searched for table %2$s in database %3$s. Is that right?' ),
|
|
'<code>' . rtrim( $domain . $path, '/' ) . '</code>',
|
|
'<code>' . $wpdb->blogs . '</code>',
|
|
'<code>' . DB_NAME . '</code>'
|
|
) . '</p>';
|
|
}
|
|
$msg .= '<p><strong>' . __( 'What do I do now?' ) . '</strong> ';
|
|
$msg .= __( 'Read the <a target="_blank" href="https://codex.wordpress.org/Debugging_a_WordPress_Network">bug report</a> page. Some of the guidelines there may help you figure out what went wrong.' );
|
|
$msg .= ' ' . __( 'If you’re still stuck with this message, then check that your database contains the following tables:' ) . '</p><ul>';
|
|
foreach ( $wpdb->tables('global') as $t => $table ) {
|
|
if ( 'sitecategories' == $t )
|
|
continue;
|
|
$msg .= '<li>' . $table . '</li>';
|
|
}
|
|
$msg .= '</ul>';
|
|
|
|
wp_die( $msg, $title, array( 'response' => 500 ) );
|
|
}
|
|
|
|
/**
|
|
* This deprecated function formerly set the site_name property of the $current_site object.
|
|
*
|
|
* This function simply returns the object, as before.
|
|
* The bootstrap takes care of setting site_name.
|
|
*
|
|
* @access private
|
|
* @since 3.0.0
|
|
* @deprecated 3.9.0 Use get_current_site() instead.
|
|
*
|
|
* @param object $current_site
|
|
* @return object
|
|
*/
|
|
function get_current_site_name( $current_site ) {
|
|
_deprecated_function( __FUNCTION__, '3.9', 'get_current_site()' );
|
|
return $current_site;
|
|
}
|
|
|
|
/**
|
|
* This deprecated function managed much of the site and network loading in multisite.
|
|
*
|
|
* The current bootstrap code is now responsible for parsing the site and network load as
|
|
* well as setting the global $current_site object.
|
|
*
|
|
* @access private
|
|
* @since 3.0.0
|
|
* @deprecated 3.9.0
|
|
*
|
|
* @global object $current_site
|
|
*
|
|
* @return object
|
|
*/
|
|
function wpmu_current_site() {
|
|
global $current_site;
|
|
_deprecated_function( __FUNCTION__, '3.9' );
|
|
return $current_site;
|
|
}
|