name = __( 'XML Sitemap', 'all-in-one-seo-pack' ); // Human-readable name of the plugin.
$this->prefix = 'aiosp_sitemap_'; // Option prefix.
$this->file = __FILE__; // The current file.
$this->extra_sitemaps = array();
$this->extra_sitemaps = apply_filters( $this->prefix . 'extra', $this->extra_sitemaps );
}
parent::__construct();
$this->comment_string = 'Sitemap %s generated by All in One SEO Pack %s by Michael Torbert of Semper Fi Web Design on %s';
$this->help_text = array(
'daily_cron' => __( 'Notify search engines based on the selected schedule, and also update static sitemap daily if in use. (this uses WP-Cron, so make sure this is working properly on your server as well)', 'all-in-one-seo-pack' ),
'indexes' => __( 'Organize sitemap entries into distinct files in your sitemap. Enable this only if your sitemap contains over 50,000 URLs or the file is over 5MB in size.', 'all-in-one-seo-pack' ),
'max_posts' => __( 'Allows you to specify the maximum number of posts in a sitemap (up to 50,000).', 'all-in-one-seo-pack' ),
'posttypes' => __( 'Select which Post Types appear in your sitemap.', 'all-in-one-seo-pack' ),
'taxonomies' => __( 'Select which taxonomy archives appear in your sitemap', 'all-in-one-seo-pack' ),
'archive' => __( 'Include Date Archives in your sitemap.', 'all-in-one-seo-pack' ),
'author' => __( 'Include Author Archives in your sitemap.', 'all-in-one-seo-pack' ),
'images' => __( 'Exclude Images in your sitemap.', 'all-in-one-seo-pack' ),
'gzipped' => __( 'Create a compressed sitemap file in .xml.gz format.', 'all-in-one-seo-pack' ),
'robots' => __( 'Places a link to your Sitemap.xml into your virtual Robots.txt file.', 'all-in-one-seo-pack' ),
'rewrite' => __( 'Dynamically creates the XML sitemap instead of using a static file.', 'all-in-one-seo-pack' ),
'addl_url' => __( 'URL to the page. This field accepts relative URLs or absolute URLs with the protocol specified.', 'all-in-one-seo-pack' ),
'addl_prio' => __( 'The priority of the page.', 'all-in-one-seo-pack' ),
'addl_freq' => __( 'The frequency of the page.', 'all-in-one-seo-pack' ),
'addl_mod' => __( 'Last modified date of the page.', 'all-in-one-seo-pack' ),
'excl_categories' => __( 'Entries from these categories will be excluded from the sitemap.', 'all-in-one-seo-pack' ),
'excl_pages' => __( 'Use page slugs or page IDs, seperated by commas, to exclude pages from the sitemap.', 'all-in-one-seo-pack' ),
);
$this->help_anchors = array(
'daily_cron' => '#schedule-updates',
'indexes' => '#enable-sitemap-indexes',
'max_posts' => '#enable-sitemap-indexes',
'posttypes' => '#post-types-and-taxonomies',
'taxonomies' => '#post-types-and-taxonomies',
'archive' => '#include-archive-pages',
'author' => '#include-archive-pages',
'images' => '#exclude-images',
'gzipped' => '#create-compressed-sitemap',
'robots' => '#link-from-virtual-robots',
'rewrite' => '#dynamically-generate-sitemap',
'addl_url' => '#additional-pages',
'addl_prio' => '#additional-pages',
'addl_freq' => '#additional-pages',
'addl_mod' => '#additional-pages',
'excl_categories' => '#excluded-items',
'excl_pages' => '#excluded-items',
);
$this->default_options = array(
'daily_cron' => array(
'name' => __( 'Schedule Updates', 'all-in-one-seo-pack' ),
'type' => 'select',
'initial_options' => array(
0 => __( 'No Schedule', 'all-in-one-seo-pack' ),
'daily' => __( 'Daily', 'all-in-one-seo-pack' ),
'weekly' => __( 'Weekly', 'all-in-one-seo-pack' ),
'monthly' => __( 'Monthly', 'all-in-one-seo-pack' ),
),
'default' => 0,
),
'indexes' => array( 'name' => __( 'Enable Sitemap Indexes', 'all-in-one-seo-pack' ) ),
'max_posts' => array(
'name' => __( 'Maximum Posts Per Sitemap Page', 'all-in-one-seo-pack' ),
'type' => 'text',
'default' => 50000,
'condshow' => array( "{$this->prefix}indexes" => 'on', "{$this->prefix}indexes" => 'on' ),
),
'posttypes' => array(
'name' => __( 'Post Types', 'all-in-one-seo-pack' ),
'type' => 'multicheckbox',
'default' => 'all',
),
'taxonomies' => array(
'name' => __( 'Taxonomies', 'all-in-one-seo-pack' ),
'type' => 'multicheckbox',
'default' => 'all',
),
'archive' => array( 'name' => __( 'Include Date Archive Pages', 'all-in-one-seo-pack' ) ),
'author' => array( 'name' => __( 'Include Author Pages', 'all-in-one-seo-pack' ) ),
'images' => array( 'name' => __( 'Exclude Images', 'all-in-one-seo-pack' ) ),
'gzipped' => array(
'name' => __( 'Create Compressed Sitemap', 'all-in-one-seo-pack' ),
'default' => 'On',
),
'robots' => array(
'name' => __( 'Link From Virtual Robots.txt', 'all-in-one-seo-pack' ),
'default' => 'On',
),
'rewrite' => array(
'name' => __( 'Dynamically Generate Sitemap', 'all-in-one-seo-pack' ),
'default' => 'On',
),
);
$status_options = array(
'link' => array( 'default' => '', 'type' => 'html', 'label' => 'none', 'save' => false ),
);
$this->layout = array(
'status' => array(
'name' => __( 'Sitemap Status', 'all-in-one-seo-pack' ),
'help_link' => 'https://semperplugins.com/documentation/xml-sitemaps-module/',
'options' => array_keys( $status_options ),
),
'default' => array(
'name' => $this->name,
'help_link' => 'https://semperplugins.com/documentation/xml-sitemaps-module/',
'options' => array_keys( $this->default_options ),
),
);
$prio = array();
for ( $i = 0; $i <= 10; $i ++ ) {
$str = sprintf( '%0.1f', $i / 10.0 );
$prio[ $str ] = $str;
}
$arr_no = array( 'no' => __( 'Do Not Override', 'all-in-one-seo-pack' ) );
$arr_sel = array( 'sel' => __( 'Select Individual', 'all-in-one-seo-pack' ) );
$this->prio_sel = array_merge( $arr_no, $arr_sel, $prio );
$this->prio = array_merge( $arr_no, $prio );
$freq = array();
foreach ( array( 'always', 'hourly', 'daily', 'weekly', 'monthly', 'yearly', 'never' ) as $f ) {
$freq[ $f ] = $f;
}
$this->freq_sel = array_merge( $arr_no, $arr_sel, $freq );
$this->freq = array_merge( $arr_no, $freq );
foreach (
array(
'prio' => __( 'priority', 'all-in-one-seo-pack' ),
'freq' => __( 'frequency', 'all-in-one-seo-pack' ),
) as $k => $v
) {
$s = "{$k}_options";
$$s = array();
foreach (
array(
'homepage' => __( 'homepage', 'all-in-one-seo-pack' ),
'post' => __( 'posts', 'all-in-one-seo-pack' ),
'taxonomies' => __( 'taxonomies', 'all-in-one-seo-pack' ),
'archive' => __( 'archive pages', 'all-in-one-seo-pack' ),
'author' => __( 'author pages', 'all-in-one-seo-pack' ),
) as $opt => $val
) {
$arr = $$s;
if ( ( 'post' === $opt ) || ( 'taxonomies' === $opt ) ) {
$iopts = $this->{"{$k}_sel"};
} else {
$iopts = $this->$k;
}
$arr[ $k . '_' . $opt ] = array(
'name' => $this->ucwords( $val ),
'help_text' => sprintf( __( 'Manually set the %1$s of your %2$s.', 'all-in-one-seo-pack' ), $v, $val ),
'type' => 'select',
'initial_options' => $iopts,
'default' => 'no',
);
if ( ( 'archive' === $opt ) || ( 'author' === $opt ) ) {
$arr[ $k . '_' . $opt ]['condshow'] = array( $this->prefix . $opt => 'on' );
}
$$s = $arr;
}
}
$addl_options = array(
'addl_instructions' => array(
'default' => '' . __( 'Enter information below for any additional links for your sitemap not already managed through WordPress.', 'all-in-one-seo-pack' ) . '
', esc_url( get_admin_url( null, "admin.php?page=$aioseop_plugin_dirname/modules/aioseop_sitemap.php" ) ) ), ' ' )
);
}
}
/**
* Update sitemap from posts.
*
* @param $new_status
* @param $old_status
* @param $post
*/
function update_sitemap_from_posts( $new_status, $old_status, $post ) {
if ( $this->option_isset( 'rewrite' ) ) {
// TODO if dynamic, delete transient (we currently don't do transients).
return;
}
$posttypes = array();
if ( ! empty( $this->options[ "{$this->prefix}posttypes" ] ) ) {
$posttypes = $this->options[ "{$this->prefix}posttypes" ];
}
if ( ! in_array( $post->post_type, $posttypes, true ) ) {
return;
}
$statuses_for_updating = array( 'new', 'publish', 'trash' );
if ( ! in_array( $new_status, $statuses_for_updating, true ) ) {
return;
}
$this->do_sitemaps();
}
/**
* Add cron schedules.
*
* Add new intervals of a week and a month.
*
* @link https://codex.wordpress.org/Plugin_API/Filter_Reference/cron_schedules
*
* @param $schedules
*
* @return mixed
*/
function add_cron_schedules( $schedules ) {
$schedules['weekly'] = array(
'interval' => 604800, // 1 week in seconds.
'display' => __( 'Once Weekly', 'all-in-one-seo-pack' ),
);
$schedules['monthly'] = array(
'interval' => 2629740, // 1 month in seconds.
'display' => __( 'Once Monthly', 'all-in-one-seo-pack' ),
);
return $schedules;
}
/**
* Cron update.
*/
function cron_update() {
add_filter( 'cron_schedules', array( $this, 'add_cron_schedules' ) );
if ( ! wp_next_scheduled( $this->prefix . 'daily_update_cron' ) ) {
wp_schedule_event( time(), $this->options[ $this->prefix . 'daily_cron' ], $this->prefix . 'daily_update_cron' );
}
}
/**
* Daily update.
*/
function daily_update() {
$last_run = get_option( $this->prefix . 'cron_last_run' );
if ( empty( $last_run ) || ( time() - $last_run > 23.5 * 60 * 60 ) ) {
// Sanity check.
$this->do_sitemaps( __( 'Daily scheduled sitemap check has finished.', 'all-in-one-seo-pack' ) );
}
$last_run = time();
update_option( $this->prefix . 'cron_last_run', $last_run );
}
/**
* Initialize options, after constructor.
*/
function load_sitemap_options() {
// Load initial options / set defaults.
$this->update_options();
if ( ! empty( $this->options[ "{$this->prefix}indexes" ] ) ) {
if ( $this->options[ "{$this->prefix}max_posts" ] && ( $this->options[ "{$this->prefix}max_posts" ] > 0 ) && ( $this->options[ "{$this->prefix}max_posts" ] < 50000 ) ) {
$this->max_posts = $this->options[ "{$this->prefix}max_posts" ];
}
}
if ( is_multisite() ) {
$this->options[ "{$this->prefix}rewrite" ] = 'On';
}
if ( $this->options[ "{$this->prefix}rewrite" ] ) {
$this->setup_rewrites();
}
if ( $this->option_isset( 'robots' ) ) {
add_action( 'do_robots', array( $this, 'do_robots' ), 100 );
}
if ( isset( $this->options[ $this->prefix . 'daily_cron' ] ) && $this->options[ $this->prefix . 'daily_cron' ] ) {
add_action( 'wp', array( $this, 'cron_update' ) );
} else {
if ( $time = wp_next_scheduled( $this->prefix . 'daily_update_cron' ) ) {
wp_unschedule_event( $time, $this->prefix . 'daily_update_cron' );
}
}
}
/**
* Custom settings.
*
* Displays boxes for add pages to sitemap option. Requires WordPress 4.1.
*
* @param $buf
* @param $args
*
* @return string
*/
function display_custom_options( $buf, $args ) {
if ( "{$this->prefix}addl_pages" === $args['name'] ) {
$buf .= "";
if ( ! empty( $args['value'] ) ) {
$buf .= "
\n";
foreach ( $args['value'] as $k => $v ) {
if ( is_object( $v ) ) {
$v = (Array) $v;
}
$buf .= "\t{$v['prio']} {$v['freq']} {$v['mod']}
\n";
}
}
$args['options']['type'] = 'hidden';
if ( ! empty( $args['value'] ) ) {
$args['value'] = wp_json_encode( $args['value'] );
} else {
$args['options']['type'] = 'html';
}
if ( empty( $args['value'] ) ) {
$args['value'] = '';
}
$buf .= $this->get_option_html( $args );
$buf .= '
' . __( 'view your sitemap', 'all-in-one-seo-pack' ) . ' ' );
$options[ $this->prefix . 'link' ] .= __( ' Your sitemap has been created with content and images.', 'all-in-one-seo-pack' );
if ( '0' !== get_option( 'blog_public' ) ) {
$options[ $this->prefix . 'link' ] .= ' ' . __( 'Changes are automatically submitted to search engines.', 'all-in-one-seo-pack' );
}
if ( $this->option_isset( 'rewrite' ) ) {
$rule = $this->get_rewrite_url( $url );
$rules = $this->get_rewrite_rules();
if ( ! in_array( $rule, $rules ) ) {
$options[ $this->prefix . 'link' ] .= '' . __( 'Dynamic sitemap generation does not appear to be using the correct rewrite rules; please disable any other sitemap plugins or functionality on your site and reset your permalinks.', 'all-in-one-seo-pack' ) . '
';
}
}
if ( ! get_option( 'blog_public' ) ) {
global $wp_version;
if ( version_compare( $wp_version, '3.5.0', '>=' ) || function_exists( 'set_url_scheme' ) ) {
$privacy_link = '' . __( 'Reading Settings', 'all-in-one-seo-pack' ) . ' ';
} else {
$privacy_link = '' . __( 'Privacy Settings', 'all-in-one-seo-pack' ) . ' ';
}
$options[ $this->prefix . 'link' ] .= '' . sprintf( __( 'Warning: your privacy settings are configured to ask search engines to not index your site; you can change this under %s for your blog.', 'all-in-one-seo-pack' ), $privacy_link );
}
return $options;
}
/**
* Filter options.
*
* Handle 'all' option for post types / taxonomies, further sanitization of filename, rewrites on for multisite, setting up addl pages option.
*
* @param $options
*
* @return mixed
*/
function filter_options( $options ) {
if ( ! isset( $this->default_options['posttypes']['initial_options'] ) ) {
$this->add_post_types();
}
if ( is_array( $options[ "{$this->prefix}posttypes" ] ) && in_array( 'all', $options[ "{$this->prefix}posttypes" ] ) && is_array( $this->default_options['posttypes']['initial_options'] ) ) {
$options[ "{$this->prefix}posttypes" ] = array_keys( $this->default_options['posttypes']['initial_options'] );
}
if ( is_array( $options[ "{$this->prefix}taxonomies" ] ) && in_array( 'all', $options[ "{$this->prefix}taxonomies" ] ) && is_array( $this->default_options['taxonomies']['initial_options'] ) ) {
$options[ "{$this->prefix}taxonomies" ] = array_keys( $this->default_options['taxonomies']['initial_options'] );
}
if ( is_multisite() ) {
$options[ $this->prefix . 'rewrite' ] = 'On';
}
if ( ! is_array( $options[ $this->prefix . 'addl_pages' ] ) ) {
$options[ $this->prefix . 'addl_pages' ] = wp_specialchars_decode( stripslashes_deep( $options[ $this->prefix . 'addl_pages' ] ), ENT_QUOTES );
$decoded = json_decode( $options[ $this->prefix . 'addl_pages' ] );
if ( null === $decoded ) {
$decoded = maybe_unserialize( $options[ $this->prefix . 'addl_pages' ] );
}
if ( ! is_array( $decoded ) ) {
$decoded = (Array) $decoded;
}
if ( null === $decoded ) {
$decoded = $options[ $this->prefix . 'addl_pages' ];
}
$options[ $this->prefix . 'addl_pages' ] = $decoded;
}
if ( is_array( $options[ $this->prefix . 'addl_pages' ] ) ) {
foreach ( $options[ $this->prefix . 'addl_pages' ] as $k => $v ) {
if ( is_object( $v ) ) {
$options[ $this->prefix . 'addl_pages' ][ $k ] = (Array) $v;
}
}
}
if ( isset( $options[ $this->prefix . 'addl_pages' ][0] ) ) {
unset( $options[ $this->prefix . 'addl_pages' ][0] );
}
// TODO Refactor all these... use a nonce, dump the incoming _Post into an array and use that.
if ( ! empty( $_POST[ $this->prefix . 'addl_url' ] ) ) {
foreach ( array( 'addl_url', 'addl_prio', 'addl_freq', 'addl_mod' ) as $field ) {
if ( ! empty( $_POST[ $this->prefix . $field ] ) ) {
$_POST[ $this->prefix . $field ] = esc_attr( wp_kses_post( $_POST[ $this->prefix . $field ] ) );
} else {
$_POST[ $this->prefix . $field ] = '';
}
}
if ( ! is_array( $options[ $this->prefix . 'addl_pages' ] ) ) {
$options[ $this->prefix . 'addl_pages' ] = array();
}
$options[ $this->prefix . 'addl_pages' ][ $_POST[ $this->prefix . 'addl_url' ] ] = array(
'prio' => $_POST[ $this->prefix . 'addl_prio' ],
'freq' => $_POST[ $this->prefix . 'addl_freq' ],
'mod' => $_POST[ $this->prefix . 'addl_mod' ],
);
}
return $options;
}
/**
* Get sitemap urls of child blogs, if any.
*
* @return mixed|void
*/
function get_child_sitemap_urls() {
$siteurls = array();
$blogs = $this->get_child_blogs();
if ( ! empty( $blogs ) ) {
$option_name = $this->get_option_name();
foreach ( $blogs as $blog_id ) {
if ( $this->is_aioseop_active_on_blog( $blog_id ) ) {
$options = get_blog_option( $blog_id, $this->parent_option );
if ( ! empty( $options ) && ! empty( $options['modules'] ) && ! empty( $options['modules']['aiosp_feature_manager_options'] )
&& ! empty( $options['modules']['aiosp_feature_manager_options']['aiosp_feature_manager_enable_sitemap'] )
&& ! empty( $options['modules'][ $option_name ] )
) {
global $wpdb;
$sitemap_options = $options['modules'][ $option_name ];
$siteurl = '';
if ( defined( 'SUNRISE' ) && SUNRISE && is_object( $wpdb ) && isset( $wpdb->dmtable ) && ! empty( $wpdb->dmtable ) ) {
// @codingStandardsIgnoreStart
$domain = $wpdb->get_var( "SELECT domain FROM {$wpdb->dmtable} WHERE blog_id = '$blog_id' AND active = 1 LIMIT 1" );
// @codingStandardsIgnoreEnd
if ( $domain ) {
if ( false == isset( $_SERVER['HTTPS'] ) ) {
$_SERVER['HTTPS'] = 'Off';
}
$protocol = ( 'on' == strtolower( $_SERVER['HTTPS'] ) ) ? 'https://' : 'http://';
$siteurl = untrailingslashit( $protocol . $domain );
}
}
if ( ! $siteurl ) {
$siteurl = get_home_url( $blog_id );
}
$url = $siteurl . '/' . $this->get_filename() . '.xml';
if ( $sitemap_options[ "{$this->prefix}gzipped" ] ) {
$url .= '.gz';
}
$siteurls[] = $url;
}
}
}
}
$siteurls = apply_filters( $this->prefix . 'sitemap_urls', $siteurls ); // Legacy.
return apply_filters( $this->prefix . 'child_urls', $siteurls );
}
/**
* Gets the home path.
*
* If we're in wp-admin, use the WordPress function, otherwise we user our own version here.
* This only applies to static sitemaps.
*
* @since 2.3.6.1
*
* @return mixed|string
*/
function get_home_path() {
if ( function_exists( 'get_home_path' ) ) {
return get_home_path();
}
$home = set_url_scheme( get_option( 'home' ), 'http' );
$siteurl = set_url_scheme( get_option( 'siteurl' ), 'http' );
if ( ! empty( $home ) && 0 !== strcasecmp( $home, $siteurl ) ) {
$wp_path_rel_to_home = str_ireplace( $home, '', $siteurl ); /* $siteurl - $home */
$pos = strripos( str_replace( '\\', '/', $_SERVER['SCRIPT_FILENAME'] ), trailingslashit( $wp_path_rel_to_home ) );
$home_path = substr( $_SERVER['SCRIPT_FILENAME'], 0, $pos );
$home_path = trailingslashit( $home_path );
} else {
$home_path = ABSPATH;
}
return str_replace( '\\', '/', $home_path );
}
/**
* Whitelists files from static sitemap conflict warning.
*
* For right now, this is just externally produced news sitemaps until we figure out something better.
*
* @param $file
*
* @since 2.3.10.2
*
* @return string
*/
function whitelist_static_sitemaps( $file ) {
$whitelist = array( 'sitemap_news.xml', 'sitemap-news.xml' );
if ( in_array( $file, $whitelist, true ) ) {
return '';
}
return $file;
}
/**
* Scan for sitemaps on filesystem.
*
* @return array
*/
function scan_match_files() {
$scan1 = $scan2 = '';
$files = array();
$filename = $this->get_filename();
if ( ! empty( $filename ) ) {
$scan1 = get_home_path() . $filename . '*.xml';
if ( ! empty( $this->options["{$this->prefix}gzipped"] ) ) {
$scan2 .= get_home_path() . $filename . '*.xml.gz';
}
if ( empty( $scan1 ) && empty( $scan2 ) ) {
return $files;
}
$home_path = get_home_path();
$filescan = $this->scandir( $home_path );
if ( ! empty( $filescan ) ) {
foreach ( $filescan as $f ) {
if ( ! empty( $scan1 ) && fnmatch( $scan1, $home_path . $f ) ) {
$f = $this->whitelist_static_sitemaps( $f );
$files[] = $home_path . $f;
continue;
}
if ( ! empty( $scan2 ) && fnmatch( $scan2, $home_path . $f ) ) {
$files[] = $home_path . $f;
}
}
}
return $files;
}
}
/**
* Scan for sitemaps.
*
* Handle deleting / renaming of conflicting sitemap files.
*/
function do_sitemap_scan() {
$msg = '';
if ( ! empty( $this->options[ "{$this->prefix}rewrite" ] ) && ( get_option( 'permalink_structure' ) === '' ) ) {
$msg = '
' . __( 'Warning: dynamic sitemap generation must have permalinks enabled.', 'all-in-one-seo-pack' ) . '
';
}
if ( ! empty( $_POST['aioseop_sitemap_rename_files'] ) || ! empty( $_POST['aioseop_sitemap_delete_files'] ) ) {
$nonce = $_POST['nonce-aioseop'];
if ( ! wp_verify_nonce( $nonce, 'aioseop-nonce' ) ) {
die( __( 'Security Check - If you receive this in error, log out and back in to WordPress', 'all-in-one-seo-pack' ) );
}
if ( ! empty( $_POST['aioseop_sitemap_conflict'] ) ) {
$files = $this->scan_match_files();
foreach ( $files as $f => $file ) {
$files[ $f ] = realpath( $file );
}
foreach ( $_POST['aioseop_sitemap_conflict'] as $ren_file ) {
$ren_file = realpath( get_home_path() . $ren_file );
if ( in_array( $ren_file, $files ) ) {
if ( ! empty( $_POST['aioseop_sitemap_delete_files'] ) ) {
if ( $this->delete_file( $ren_file ) ) {
$msg .= '' . sprintf( __( 'Deleted %s.', 'all-in-one-seo-pack' ), $ren_file ) . '
';
}
continue;
}
$count = 0;
do {
$ren_to = $ren_file . '._' . sprintf( '%03d', $count ) . '.old';
$count ++;
} while ( $this->file_exists( $ren_to ) && ( $count < 1000 ) );
if ( $count >= 1000 ) {
$msg .= '' . sprintf( __( "Couldn't rename file %s!", 'all-in-one-seo-pack' ), $ren_file ) . '
';
} else {
$ren = $this->rename_file( $ren_file, $ren_to );
if ( $ren ) {
$msg .= '' . sprintf( __( 'Renamed %1$s to %2$s.', 'all-in-one-seo-pack' ), $ren_file, $ren_to ) . '
';
}
}
} else {
$msg .= '' . sprintf( __( "Couldn't find file %s!", 'all-in-one-seo-pack' ), $ren_file ) . '
';
}
}
}
} else {
$msg .= $this->scan_sitemaps();
}
if ( ! empty( $msg ) ) {
$this->output_error( $msg );
}
}
/**
* Do the scan, return the results.
*
* @return string
*/
function scan_sitemaps() {
$msg = '';
$files = $this->scan_match_files();
if ( ! empty( $files ) ) {
$msg = $this->sitemap_warning( $files );
}
return $msg;
}
/**
* Get problem files.
*
* Get the list of potentially conflicting sitemap files, identify whether they came from us, are blank, or are of unknown origin.
*
* @param $files
* @param $msg
*
* In 2.3.10 we added the ability to see empty sitemap files as well.
*
* @return array
*/
function get_problem_files( $files, &$msg ) {
$problem_files = array();
$use_wpfs = true;
$wpfs = $this->get_filesystem_object();
if ( ! is_object( $wpfs ) ) {
$use_wpfs = false;
} else {
if ( 'direct' === $wpfs->method ) {
$use_wpfs = false;
}
}
foreach ( $files as $f ) {
if ( $this->is_file( $f ) ) {
$fn = $f;
$compressed = false;
if ( $this->substr( $f, - 3 ) === '.gz' ) {
$compressed = true;
}
if ( $use_wpfs ) {
if ( $compressed ) { // Inefficient but necessary.
$file = $this->load_file( $fn );
if ( ! empty( $file ) ) {
$file = gzuncompress( $file, 4096 );
}
} else {
$file = $this->load_file( $fn, false, null, - 1, 4096 );
}
} else {
if ( $compressed ) {
$file_resource = gzopen( $fn, 'rb' );
$file = gzread( $file_resource, 4096 );
gzclose( $file_resource );
} else {
$file = file_get_contents( $fn, false, null, 0, 4096 );
}
}
if ( ! empty( $file ) ) {
$matches = array();
if ( preg_match(
'//',
$file, $matches
) ) {
if ( ! empty( $this->options[ "{$this->prefix}rewrite" ] ) ) {
$msg .= '' . sprintf(
__( "Warning: a static sitemap '%1\$s' generated by All in One SEO Pack %2\$s on %3\$s already exists that may conflict with dynamic sitemap generation.", 'all-in-one-seo-pack' ),
$f, $matches[2], $matches[3]
) . "
\n";
$problem_files[] = $f;
}
} else {
$msg .= '' . sprintf( __( 'Potential conflict with unknown file %s.', 'all-in-one-seo-pack' ), $f ) . "
\n";
$problem_files[] = $f;
}
} else {
$msg .= '' . sprintf( __( 'Removed empty file %s.', 'all-in-one-seo-pack' ), $f ) . "
\n";
$problem_files[] = $f;
// This is causing all problem_files to be deleted automatically; which may be the intent.
// TODO Either create a seperate variable for this set of problem_files, or a final loop to clean problem_files before returning.
foreach ( $problem_files as $f => $file ) {
$files[ $f ] = realpath( $file );
$this->delete_file( realpath( $file ) );
}
$problem_files = false; // Don't return anything. If it's blank, we'll take care of it here.
}
}
}
return $problem_files;
}
/**
* Display sitemap warning.
*
* Display the warning and the form for conflicting sitemap files.
*
* @param $files
*
* @return string
*/
function sitemap_warning( $files ) {
$msg = '';
$conflict = false;
$problem_files = $this->get_problem_files( $files, $msg );
if ( ! empty( $problem_files ) ) {
$conflict = true;
}
if ( $conflict ) {
foreach ( $problem_files as $p ) {
$msg .= "prefix . 'xml_namespace', array(
'xmlns' => 'http://www.sitemaps.org/schemas/sitemap/0.9',
'xmlns:image' => 'http://www.google.com/schemas/sitemap-image/1.1',
)
);
if ( ! empty( $namespaces ) ) {
$ns = array();
foreach ( $namespaces as $k => $v ) {
$ns[] = esc_attr( $k ) . '=' . '"' . esc_url( $v, array( 'http', 'https' ) ) . '"';
}
$xml_header .= join( "\r\n\t", $ns );
}
$xml_header .= '>' . "\r\n";
echo $xml_header;
$count = 0;
foreach ( $urls as $url ) {
echo "\t\r\n";
if ( is_array( $url ) ) {
foreach ( $url as $k => $v ) {
if ( ! empty( $v ) ) {
if ( 'loc' === $k ) {
$v = esc_url( $v );
}
if ( is_array( $v ) ) {
$buf = "\t\t\t<$k>\r\n";
foreach ( $v as $ext => $attr ) {
if ( is_array( $attr ) ) {
$buf = '';
echo "\t\t<$k>\r\n";
foreach ( $attr as $a => $nested ) {
if ( is_array( $nested ) ) {
echo "\t\t\t<$a>\r\n";
foreach ( $nested as $next => $nattr ) {
echo "\t\t\t\t<$next>$nattr\r\n";
}
echo "\t\t\t\r\n";
} else {
echo "\t\t\t<$a>$nested\r\n";
}
}
echo "\t\t\r\n";
} else {
$buf .= "\t\t\t<$ext>$attr\r\n";
}
}
if ( ! empty( $buf ) ) {
echo $buf . "\t\t\r\n";
}
} else {
echo "\t\t<$k>$v\r\n";
}
}
}
} else {
echo "\t\t" . esc_url( $url ) . " \r\n";
}
echo "\t \r\n";
if ( $count >= $max_items ) {
break;
}
}
echo ' ';
}
/**
* Output the XML for a sitemap index.
*
* @param $urls
* @param string $comment
*
* @return null
*/
function output_sitemap_index( $urls, $comment = '' ) {
$max_items = 50000;
if ( ! is_array( $urls ) ) {
return null;
}
echo '' . "\r\n\r\n";
echo '\r\n";
$xsl_url = $this->get_sitemap_xsl();
echo '' . "\r\n";
echo '' . "\r\n";
$count = 0;
foreach ( $urls as $url ) {
echo "\t\r\n";
if ( is_array( $url ) ) {
foreach ( $url as $k => $v ) {
if ( 'loc' === $k ) {
echo "\t\t<$k>" . esc_url( $v ) . "\r\n";
} elseif ( 'lastmod' === $k ) {
echo "\t\t<$k>$v\r\n";
}
}
} else {
echo "\t\t" . esc_url( $url ) . " \r\n";
}
echo "\t \r\n";
$count ++;
if ( $count >= $max_items ) {
break;
}
}
echo ' ';
}
/**
* Return an XML sitemap index as a string.
*
* @param $urls
* @param string $comment
*
* @return string
*/
function build_sitemap_index( $urls, $comment = '' ) {
ob_start();
$this->output_sitemap_index( $urls, $comment );
return ob_get_clean();
}
/**
* Return an XML sitemap as a string.
*
* @param $urls
* @param string $comment
*
* @return string
*/
function build_sitemap( $urls, $comment = '' ) {
ob_start();
$this->output_sitemap( $urls, $comment );
return ob_get_clean();
}
/**
* Return sitemap data for an array of terms.
*
* @param $terms
*
* @return array
*/
function get_term_priority_data( $terms ) {
$prio = array();
if ( is_array( $terms ) ) {
$def_prio = $this->get_default_priority( 'taxonomies' );
$def_freq = $this->get_default_frequency( 'taxonomies' );
foreach ( $terms as $term ) {
$pr_info = array();
$pr_info['loc'] = $this->get_term_link( $term, $term->taxonomy );
if ( ( 'sel' === $this->options[ $this->prefix . 'freq_taxonomies' ] ) && isset( $this->options[ $this->prefix . 'freq_taxonomies_' . $term->taxonomy ] ) && ( 'no' != $this->options[ $this->prefix . 'freq_taxonomies_' . $term->taxonomy ] ) ) {
$pr_info['changefreq'] = $this->options[ $this->prefix . 'freq_taxonomies_' . $term->taxonomy ];
} else {
$pr_info['changefreq'] = $def_freq;
}
if ( ( 'sel' === $this->options[ $this->prefix . 'prio_taxonomies' ] ) && isset( $this->options[ $this->prefix . 'prio_taxonomies_' . $term->taxonomy ] ) && ( 'no' != $this->options[ $this->prefix . 'prio_taxonomies_' . $term->taxonomy ] ) ) {
$pr_info['priority'] = $this->options[ $this->prefix . 'prio_taxonomies_' . $term->taxonomy ];
} else {
$pr_info['priority'] = $def_prio;
}
$pr_info['image:image'] = $this->get_images_from_term( $term );
$prio[] = $pr_info;
}
}
return $prio;
}
/**
* Return a list of permalinks for an array of terms.
*
* @param $terms
*
* @return array
*/
function get_term_permalinks( $terms ) {
$links = array();
if ( is_array( $terms ) ) {
foreach ( $terms as $term ) {
$url = $this->get_term_link( $term );
$links[] = $url;
}
}
return $links;
}
/**
* Return permalinks for archives.
*
* @param $posts
*
* @return array
*/
function get_archive_permalinks( $posts ) {
$links = array();
$archives = array();
if ( is_array( $posts ) ) {
foreach ( $posts as $post ) {
$date = mysql2date( 'U', $post->post_date );
$year = date( 'Y', $date );
$month = date( 'm', $date );
$archives[ $year . '-' . $month ] = array( $year, $month );
}
}
$archives = array_keys( $archives );
foreach ( $archives as $d ) {
$links[] = get_month_link( $d[0], $d[1] );
}
return $links;
}
/**
* Return permalinks for authors.
*
* @param $posts
*
* @return array
*/
function get_author_permalinks( $posts ) {
$links = array();
$authors = array();
if ( is_array( $posts ) ) {
foreach ( $posts as $post ) {
$authors[ $post->author_id ] = 1;
}
}
$authors = array_keys( $authors );
foreach ( $authors as $auth_id ) {
$links[] = get_author_posts_url( $auth_id );
}
return $links;
}
/**
* Return permalinks for posts.
*
* @param $posts
*
* @return array
*/
function get_post_permalinks( $posts ) {
$links = array();
if ( is_array( $posts ) ) {
foreach ( $posts as $post ) {
$post->filter = 'sample';
$url = $this->get_permalink( $post );
$links[] = $url;
}
}
return $links;
}
/**
* Convert back from parse_url.
*
* Props to thomas at gielfeldt dot com.
*
* @link http://www.php.net/manual/en/function.parse-url.php#106731
*
* @param $parsed_url
*
* @return string
*/
function unparse_url( $parsed_url ) {
$scheme = isset( $parsed_url['scheme'] ) ? $parsed_url['scheme'] . '://' : '';
$host = isset( $parsed_url['host'] ) ? $parsed_url['host'] : '';
if ( ! empty( $host ) && empty( $scheme ) ) {
$scheme = '//';
}
$port = isset( $parsed_url['port'] ) ? ':' . $parsed_url['port'] : '';
$user = isset( $parsed_url['user'] ) ? $parsed_url['user'] : '';
$pass = isset( $parsed_url['pass'] ) ? ':' . $parsed_url['pass'] : '';
$pass = ( $user || $pass ) ? "$pass@" : '';
$path = isset( $parsed_url['path'] ) ? $parsed_url['path'] : '';
$query = isset( $parsed_url['query'] ) ? '?' . $parsed_url['query'] : '';
$fragment = isset( $parsed_url['fragment'] ) ? '#' . $parsed_url['fragment'] : '';
return "$scheme$user$pass$host$port$path$query$fragment";
}
/**
* Gets additional pages.
* Return data for user entered additional pages.
*
* @since 2.3.6
* @since 2.3.12.3 Refactored to use aioseop_home_url() for compatibility purposes.
*
* @return array|mixed|void
*/
function get_addl_pages_only() {
$pages = array();
if ( ! empty( $this->options[ $this->prefix . 'addl_pages' ] ) ) {
$siteurl = parse_url( aioseop_home_url() );
foreach ( $this->options[ $this->prefix . 'addl_pages' ] as $k => $v ) {
$url = parse_url( $k );
if ( empty( $url['scheme'] ) ) {
$url['scheme'] = $siteurl['scheme'];
}
if ( empty( $url['host'] ) ) {
$url['host'] = $siteurl['host'];
}
if ( ! empty( $url['path'] ) && substr( $url['path'], 0, 1 ) !== '/' ) {
$url['path'] = '/' . $url['path'];
}
$freq = $prio = $mod = '';
if ( ! empty( $v['mod'] ) ) {
$mod = $v['mod'];
}
if ( ! empty( $v['freq'] ) ) {
$freq = $v['freq'];
}
if ( ! empty( $v['prio'] ) ) {
$prio = $v['prio'];
}
if ( 'no' == $freq ) {
$freq = '';
}
if ( 'no' == $prio ) {
$prio = '';
}
$mod = date( 'Y-m-d\TH:i:s\Z', mysql2date( 'U', $mod ) );
$pages[] = array(
'loc' => $this->unparse_url( $url ),
'lastmod' => $mod,
'changefreq' => $freq,
'priority' => $prio,
);
}
}
$pages = apply_filters( $this->prefix . 'addl_pages_only', $pages );
return $pages;
}
/**
* Return data for user entered additional pages and extra pages.
*
* @since 2.3.6
* @since 2.3.12.3 Refactored to use aioseop_home_url() for compatibility purposes.
*
* @return array|mixed|void
*/
function get_addl_pages() {
$home = array();
$home = array(
'loc' => aioseop_home_url(),
'changefreq' => $this->get_default_frequency( 'homepage' ),
'priority' => $this->get_default_priority( 'homepage' ),
'image:image' => $this->get_images_from_post( (int) get_option( 'page_on_front' ) ),
);
$posts = (int) get_option( 'page_for_posts' );
if ( $posts ) {
$posts = $this->get_permalink( $posts );
if ( $posts == $home['loc'] ) {
$posts = array();
} else {
$posts = array(
'loc' => $posts,
'changefreq' => $this->get_default_frequency( 'blog' ),
'priority' => $this->get_default_priority( 'blog' ),
);
}
} else {
$posts = array();
}
$pages = $this->get_addl_pages_only();
if ( ! empty( $home ) ) {
$pages[] = $home;
}
if ( ! empty( $posts ) ) {
$pages[] = $posts;
}
$pages = apply_filters( $this->prefix . 'addl_pages', $pages );
return $pages;
}
/**
* Return links for user entered additional pages.
*
* @return array
*/
function get_addl_page_links() {
if ( ! empty( $this->options[ $this->prefix . 'addl_pages' ] ) ) {
return array_keys( $this->options[ $this->prefix . 'addl_pages' ] );
}
return array();
}
/**
* Scores posts based on date and relative comment count, if any.
*
* @param $date
* @param int $stats
*
* @return array
*/
function get_prio_calc( $date, $stats = 0 ) {
static $cur_time = null;
if ( null === $cur_time ) {
$cur_time = time();
}
$time = $cur_time - mysql2date( 'U', $date );
if ( ! empty( $stats ) && isset( $stats['max'] ) && $stats['max'] ) {
$minadj = $time >> 3;
$maxadj = $time >> 1;
$avg = $stats['count'] / $stats['total'];
$calc = ( $stats['comment_count'] - $stats['min'] ) / $stats['max'];
$calc = $maxadj * $calc;
if ( $avg < $stats['comment_count'] ) {
$minadj = $time >> 2;
} else {
$maxadj = $time >> 2;
}
if ( $calc > $maxadj ) {
$calc = $maxadj;
}
if ( $calc < $minadj ) {
$calc = $minadj;
}
$time -= $calc;
}
$days = $time / ( 60 * 60 * 24 );
$prio_table = array(
'daily' => 7,
'weekly' => 30,
'monthly' => 210,
'yearly' => null,
);
$interval = 1.0;
$prev_days = 0;
foreach ( $prio_table as $change => $max_days ) {
$interval -= 0.3;
if ( null === $max_days ) {
$changefreq = $change;
$prio = 0.1;
break;
}
if ( $days < $max_days ) {
$int_days_max = $max_days - $prev_days;
$int_days = $days - $prev_days;
$prio = $interval + ( (int) ( 3 * ( ( $max_days - $int_days ) / $int_days_max ) ) / 10.0 );
$changefreq = $change;
break;
}
$prev_days = $max_days;
}
return array( 'lastmod' => $date, 'changefreq' => $changefreq, 'priority' => $prio );
}
/**
* Generate sitemap priority data for archives from an array of posts.
*
* @param $posts
*
* @return array
*/
function get_archive_prio_from_posts( $posts ) {
$archives = array();
if ( is_array( $posts ) ) {
foreach ( $posts as $p ) {
if ( 'post' !== $p->post_type ) {
continue;
}
$date = date( 'Y-m', mysql2date( 'U', $p->post_date ) );
if ( empty( $archives[ $date ] ) ) {
$archives[ $date ] = $p;
} else {
if ( $p->post_modified > $archives[ $date ]->post_modified ) {
$archives[ $date ] = $p;
}
}
}
}
if ( ! empty( $archives ) ) {
return $this->get_prio_from_posts(
$archives, $this->get_default_priority( 'archive', true ), $this->get_default_frequency( 'archive', true ), array(
$this,
'get_archive_link_from_post',
)
);
}
return $archives;
}
/**
* Return an archive link from a post.
*
* @param $post
*
* @return bool|string
*/
function get_archive_link_from_post( $post ) {
if ( 'post' !== $post->post_type ) {
return false;
}
$date = mysql2date( 'U', $post->post_date );
return get_month_link( date( 'Y', $date ), date( 'm', $date ) );
}
/**
* Generate sitemap priority data for authors from an array of posts.
*
* @param $posts
*
* @return array
*/
function get_author_prio_from_posts( $posts ) {
$authors = array();
if ( is_array( $posts ) ) {
foreach ( $posts as $p ) {
if ( 'post' !== $p->post_type ) {
continue;
}
if ( empty( $authors[ $p->post_author ] ) ) {
$authors[ $p->post_author ] = $p;
} else {
if ( $p->post_modified > $authors[ $p->post_author ]->post_modified ) {
$authors[ $p->post_author ] = $p;
}
}
}
}
return $this->get_prio_from_posts(
$authors, $this->get_default_priority( 'author', true ), $this->get_default_frequency( 'author', true ), array(
$this,
'get_author_link_from_post',
)
);
}
/**
* Return an author link from a post.
*
* @param $post
*
* @return string
*/
function get_author_link_from_post( $post ) {
return get_author_posts_url( $post->post_author );
}
/**
* Return comment statistics on an array of posts.
*
* @param $posts
*
* @return array|int
*/
function get_comment_count_stats( $posts ) {
$count = 0;
$total = 0.0;
$min = null;
$max = 0;
if ( is_array( $posts ) ) {
foreach ( $posts as $post ) {
if ( ! empty( $post->comment_count ) ) {
$cnt = $post->comment_count;
$count ++;
$total += $cnt;
if ( null === $min ) {
$min = $cnt;
}
if ( $max < $cnt ) {
$max = $cnt;
}
if ( $min > $cnt ) {
$min = $cnt;
}
}
}
}
if ( $count ) {
return array( 'max' => $max, 'min' => $min, 'total' => $total, 'count' => $cnt );
} else {
return 0;
}
}
/**
* Generate sitemap priority data from an array of posts.
*
* @param $posts
* @param bool $prio_override
* @param bool $freq_override
* @param string $linkfunc
*
* @return array
*/
function get_prio_from_posts( $posts, $prio_override = false, $freq_override = false, $linkfunc = 'get_permalink' ) {
$prio = array();
$args = array(
'prio_override' => $prio_override,
'freq_override' => $freq_override,
'linkfunc' => $linkfunc,
);
if ( $prio_override && $freq_override ) {
$stats = 0;
} else {
$stats = $this->get_comment_count_stats( $posts );
}
if ( is_array( $posts ) ) {
foreach ( $posts as $post ) {
// Determine if we check the post for images.
$is_single = true;
$url = '';
$post->filter = 'sample';
if ( 'get_permalink' === $linkfunc ) {
$url = $this->get_permalink( $post );
} else {
$url = call_user_func( $linkfunc, $post );
$is_single = false;
}
$date = $post->post_modified_gmt;
if ( '0000-00-00 00:00:00' === $date ) {
$date = $post->post_date_gmt;
}
if ( '0000-00-00 00:00:00' !== $date ) {
$date = date( 'Y-m-d\TH:i:s\Z', mysql2date( 'U', $date ) );
} else {
$date = 0;
}
if ( $prio_override && $freq_override ) {
$pr_info = array( 'lastmod' => $date, 'changefreq' => null, 'priority' => null );
} else {
if ( empty( $post->comment_count ) ) {
$stat = 0;
} else {
$stat = $stats;
}
if ( ! empty( $stat ) ) {
$stat['comment_count'] = $post->comment_count;
}
$pr_info = $this->get_prio_calc( $date, $stat );
}
if ( $freq_override ) {
$pr_info['changefreq'] = $freq_override;
}
if ( $prio_override ) {
$pr_info['priority'] = $prio_override;
}
if ( ( 'sel' === $this->options[ $this->prefix . 'prio_post' ] ) && isset( $this->options[ $this->prefix . 'prio_post_' . $post->post_type ] ) ) {
if ( ( 'no' != $this->options[ $this->prefix . 'prio_post_' . $post->post_type ] ) && ( 'sel' !== $this->options[ $this->prefix . 'prio_post_' . $post->post_type ] ) ) {
$pr_info['priority'] = $this->options[ $this->prefix . 'prio_post_' . $post->post_type ];
}
}
if ( ( 'sel' === $this->options[ $this->prefix . 'freq_post' ] ) && isset( $this->options[ $this->prefix . 'freq_post_' . $post->post_type ] ) ) {
if ( ( 'no' != $this->options[ $this->prefix . 'freq_post_' . $post->post_type ] ) && ( 'sel' !== $this->options[ $this->prefix . 'freq_post_' . $post->post_type ] ) ) {
$pr_info['changefreq'] = $this->options[ $this->prefix . 'freq_post_' . $post->post_type ];
}
}
$pr_info = array(
'loc' => $url,
) + $pr_info; // Prepend loc to the array.
if ( is_float( $pr_info['priority'] ) ) {
$pr_info['priority'] = sprintf( '%0.1F', $pr_info['priority'] );
}
$pr_info['image:image'] = $is_single ? $this->get_images_from_post( $post ) : null;
$pr_info = apply_filters( $this->prefix . 'prio_item_filter', $pr_info, $post, $args );
if ( ! empty( $pr_info ) ) {
$prio[] = $pr_info;
}
}
}
return $prio;
}
/**
* Return the images attached to the term.
*
* @param WP_Term $term the term object.
*
* @since 2.4
*
* @return array
*/
private function get_images_from_term( $term ) {
global $wp_version;
if ( ! aiosp_include_images() ) {
return array();
}
$images = array();
// the table term meta table is not defined for lower versions.
if ( version_compare( $wp_version, '4.4.0', '>=' ) ) {
$thumbnail_id = get_term_meta( $term->term_id, 'thumbnail_id', true );
if ( $thumbnail_id ) {
$image = wp_get_attachment_url( $thumbnail_id );
if ( $image ) {
$images['image:image'] = array(
'image:loc' => $image,
);
}
}
}
return $images;
}
/**
* Return the images from the post.
*
* @param WP_Post $post the post object.
*
* @since 2.4
*
* @return array
*/
private function get_images_from_post( $post ) {
global $wp_version;
if ( ! aiosp_include_images() ) {
return array();
}
$images = array();
if ( is_numeric( $post ) ) {
if ( 0 === $post ) {
return null;
}
$post = get_post( $post );
}
if ( 'attachment' === $post->post_type ) {
if ( false === strpos( $post->post_mime_type, 'image/' ) ) {
// Ignore all attachments except images.
return null;
}
$attributes = wp_get_attachment_image_src( $post->ID );
if ( $attributes ) {
$images[] = array(
'image:loc' => $this->clean_url( $attributes[0] ),
);
}
return $images;
}
$attached_url = get_the_post_thumbnail_url( $post->ID );
if ( $attached_url ) {
$images[] = $attached_url;
}
$content = '';
$content = $post->post_content;
// Check images galleries in the content. DO NOT run the_content filter here as it might cause issues with other shortcodes.
if ( has_shortcode( $content, 'gallery' ) ) {
$galleries = get_post_galleries( $post, false );
if ( $galleries ) {
foreach ( $galleries as $gallery ) {
$images = array_merge( $images, $gallery['src'] );
}
}
}
$this->parse_content_for_images( $content, $images );
if ( $images ) {
$tmp = $images;
if ( 1 < count( $images ) ) {
// Filter out duplicates.
$tmp = array_unique( $images );
}
// remove any invalid/empty images.
$tmp = array_filter( $images, array( $this, 'is_image_valid' ) );
$images = array();
foreach ( $tmp as $image ) {
$images[] = array(
'image:loc' => $this->clean_url( $image ),
);
}
}
return $images;
}
/**
* Cleans the URL so that its acceptable in the sitemap.
*
* @param string $url The image url.
*
* @since 2.4.1
*
* @return string
*/
function clean_url( $url ) {
// remove the query string.
$url = strtok( $url, '?' );
// make the url XML-safe.
$url = htmlspecialchars( $url );
// Make the url absolute, if its relative.
$url = aiosp_common::absolutize_url( $url );
return apply_filters( 'aioseop_clean_url', $url );
}
/**
* Validate the image.
* NOTE: We will use parse_url here instead of wp_parse_url as we will correct the URLs beforehand and
* this saves us the need to check PHP version support.
*
* @param string $image The image src.
*
* @since 2.4.1
* @since 2.4.3 Compatibility with Pre v4.7 wp_parse_url().
*
* @return bool
*/
function is_image_valid( $image ) {
global $wp_version;
// Bail if empty image.
if ( empty( $image ) ) {
return false;
}
global $wp_version;
if ( version_compare( $wp_version, '4.4', '<' ) ) {
$p_url = parse_url( $image );
$url = $p_url['scheme'] . $p_url['host'] . $p_url['path'];
} elseif ( version_compare( $wp_version, '4.7', '<' ) ) {
// Compatability for older WP version that don't have 4.7 changes.
// @link https://core.trac.wordpress.org/changeset/38726
$p_url = wp_parse_url( $image );
$url = $p_url['scheme'] . $p_url['host'] . $p_url['path'];
} else {
$component = PHP_URL_PATH;
$url = wp_parse_url( $image, $component );
}
// make the url absolute, if its relative.
$image = aiosp_common::absolutize_url( $image );
$extn = pathinfo( parse_url( $image, PHP_URL_PATH ), PATHINFO_EXTENSION );
$allowed = apply_filters( 'aioseop_allowed_image_extensions', self::$image_extensions );
// Bail if image does not refer to an image file otherwise google webmaster tools might reject the sitemap.
if ( ! in_array( $extn, $allowed, true ) ) {
return false;
}
$image_host = parse_url( $image, PHP_URL_HOST );
$host = parse_url( home_url(), PHP_URL_HOST );
if ( $image_host !== $host ) {
// Allowed hosts will be provided in a wildcard format i.e. img.yahoo.* or *.akamai.*.
// And we will convert that into a regular expression for matching.
$whitelist = apply_filters( 'aioseop_images_allowed_from_hosts', array() );
$allowed = false;
if ( $whitelist ) {
foreach ( $whitelist as $pattern ) {
if ( preg_match( '/' . str_replace( '*', '.*', $pattern ) . '/', $image_host ) === 1 ) {
$allowed = true;
break;
}
}
}
return $allowed;
}
return true;
}
/**
* Parse the post for images.
*
* @param string $content the post content.
* @param array $images the array of images.
*/
function parse_content_for_images( $content, &$images ) {
$total = substr_count( $content, 'option_isset( 'excl_categories' ) ) {
$args['exclude'] = $this->options[ $this->prefix . 'excl_categories' ];
}
if ( ! empty( $this->options[ "{$this->prefix}indexes" ] ) ) {
$args['number'] = $this->max_posts;
$args['offset'] = $page * $this->max_posts;
}
return $args;
}
/**
* Return excluded categories and pages for post queries.
*
* @param $args
*
* @return mixed
*/
function set_post_args( $args ) {
if ( $this->option_isset( 'excl_categories' ) ) {
$cats = array();
foreach ( $this->options[ $this->prefix . 'excl_categories' ] as $c ) {
$cats[] = - $c;
}
$args['category'] = implode( ',', $cats );
}
if ( $this->option_isset( 'excl_pages' ) ) {
$args['exclude'] = $this->options[ $this->prefix . 'excl_pages' ];
}
return $args;
}
/**
* Return sitemap data for archives.
*
* @return array
*/
function get_archive_prio_data() {
$args = array( 'numberposts' => 50000, 'post_type' => 'post' );
$args = $this->set_post_args( $args );
$posts = $this->get_all_post_type_data( $args );
return $this->get_archive_prio_from_posts( $posts );
}
/**
* Return sitemap data for authors.
*
* @return array
*/
function get_author_prio_data() {
$args = array( 'numberposts' => 50000, 'post_type' => 'post' );
$args = $this->set_post_args( $args );
$posts = $this->get_all_post_type_data( $args );
return $this->get_author_prio_from_posts( $posts );
}
/**
* Return sitemap data for posts.
*
* @param string $include
* @param string $status
* @param int $page
*
* @return array
*/
function get_all_post_priority_data( $include = 'any', $status = 'publish', $page = 0 ) {
$posts = $page_query = array();
if ( ! empty( $this->options[ "{$this->prefix}indexes" ] ) ) {
$page_query = array( 'offset' => $page * $this->max_posts );
}
if ( ( 'publish' === $status ) && ( 'attachment' === $include ) ) {
$status = 'inherit';
}
if ( is_array( $include ) && ( ( $pos = array_search( 'attachment', $include ) ) !== false ) ) {
unset( $include[ $pos ] );
$att_args = array( 'post_type' => 'attachment', 'post_status' => 'inherit' );
$att_args = array_merge( $att_args, $page_query );
$posts = $this->get_all_post_type_data( $att_args );
}
$args = array( 'post_type' => $include, 'post_status' => $status );
$args = array_merge( $args, $page_query );
$args = $this->set_post_args( $args );
$posts = array_merge( $this->get_all_post_type_data( $args ), $posts );
return $this->get_prio_from_posts( $posts, $this->get_default_priority( 'post', true ), $this->get_default_frequency( 'post', true ) );
}
/**
* Return a list of all permalinks.
*
* @param string $include
* @param string $status
*
* @return array
*/
function get_all_permalinks( $include = 'any', $status = 'publish' ) {
$args = array( 'post_type' => $include, 'post_status' => $status );
$args = $this->set_post_args( $args );
$posts = $this->get_all_post_type_data( $args );
$links = $this->get_post_permalinks( $posts );
if ( $this->option_isset( 'archive' ) ) {
$links = array_merge( $links, $this->get_archive_permalinks( $posts ) );
}
if ( $this->option_isset( 'author' ) ) {
$links = array_merge( $links, $this->get_author_permalinks( $posts ) );
}
return $links;
}
/**
* Static memory cache for permalink_structure option.
*
* @param $pre
*
* @return null
*/
function cache_structure( $pre ) {
return $this->cache_struct;
}
/**
* Static memory cache for home option.
*
* @param $pre
*
* @return null
*/
function cache_home( $pre ) {
return $this->cache_home;
}
/**
* Cache permalink_structure and home for repeated sitemap queries.
*/
function cache_options() {
static $start = true;
if ( $start ) {
$this->cache_struct = get_option( 'permalink_structure' );
if ( ! empty( $this->cache_struct ) ) {
add_filter( 'pre_option_permalink_structure', array( $this, 'cache_structure' ) );
}
$this->cache_home = get_option( 'home' );
if ( ! empty( $this->cache_home ) ) {
add_filter( 'pre_option_home', array( $this, 'cache_home' ) );
}
$start = false;
}
}
/**
* Call get_term_link with caching in place.
*
* @param $term
* @param string $taxonomy
*
* @return string|WP_Error
*/
function get_term_link( $term, $taxonomy = '' ) {
static $start = true;
if ( $start ) {
$this->cache_options();
$start = false;
}
return get_term_link( $term, $taxonomy );
}
/**
* Call get_permalink with caching in place.
*
* @param $post
*
* @return false|string
*/
function get_permalink( $post ) {
static $start = true;
if ( $start ) {
$this->cache_options();
$start = false;
}
return aioseop_get_permalink( $post );
}
/**
* Return term counts using wp_count_terms().
*
* @param $args
*
* @return array|int|mixed|null|void|WP_Error
*/
function get_all_term_counts( $args ) {
$term_counts = null;
if ( ! empty( $args ) && ! empty( $args['taxonomy'] ) ) {
if ( ! is_array( $args['taxonomy'] ) || ( count( $args['taxonomy'] ) == 1 ) ) {
if ( is_array( $args['taxonomy'] ) ) {
$args['taxonomy'] = array_shift( $args['taxonomy'] );
}
$term_counts = wp_count_terms( $args['taxonomy'], array( 'hide_empty' => true ) );
} else {
foreach ( $args['taxonomy'] as $taxonomy ) {
if ( 'all' === $taxonomy ) {
continue;
}
$term_counts[ $taxonomy ] = wp_count_terms( $taxonomy, array( 'hide_empty' => true ) );
}
}
}
$term_counts = apply_filters( $this->prefix . 'term_counts', $term_counts, $args );
return $term_counts;
}
/**
* Return post counts.
*
* @since 2.4.3 Refactored to use get_post_count() instead of wp_count_posts().
* @param $args
*
* @return array
*/
function get_all_post_counts( $args ) {
$post_counts = array();
$status = 'inherit';
if ( ! empty( $args['post_status'] ) ) {
$status = $args['post_status'];
}
if ( ! empty( $args ) && ! empty( $args['post_type'] ) ) {
// #884: removed hard-to-understand code here which suspected $args['post_type'] to NOT be an array. Do not see any case in which this is likely to happen.
foreach ( $args['post_type'] as $post_type ) {
$count_args = $args;
if ( 'all' === $post_type ) {
continue;
}
if ( 'attachment' === $post_type ) {
$count_args['post_status'] = 'inherit';
}
$count_args['post_type'] = $post_type;
$post_counts[ $post_type ] = $this->get_post_count( $count_args );
}
}
$post_counts = apply_filters( $this->prefix . 'post_counts', $post_counts, $args );
return $post_counts;
}
/**
* Modify the post arguments in case third-party plugins are being used e.g. WPML.
*
* @param $args
*/
function modify_post_params_for_external_plugins( &$args ) {
// if WPML is being used, do not suppress filters.
if ( defined( 'ICL_SITEPRESS_VERSION' ) ) {
$args['suppress_filters'] = false;
}
$args = apply_filters( $this->prefix . 'modify_post_params', $args );
}
/**
* Return post counts for the specified arguments.
*
* @param $args
*
* @return int
*/
function get_post_count( $args ) {
$this->modify_post_params_for_external_plugins( $args );
// we will use WP_Query instead of get_posts here as that is more efficient.
// BEWARE: since we are using WP_Query, suppress_filters is false.
$args['posts_per_page'] = -1;
$args['fields'] = 'ids';
$args['update_post_meta_cache'] = false;
$args['update_post_term_cache'] = false;
$query = new WP_Query( $args );
if ( $query->have_posts() ) {
return $query->post_count;
}
return 0;
}
/**
* Get total post count.
*
* @param $args
*
* @return int
*/
function get_total_post_count( $args ) {
$total = 0;
$counts = $this->get_all_post_counts( $args );
if ( ! empty( $counts ) ) {
foreach ( $counts as $count ) {
$total += $count;
}
}
return $total;
}
/**
* Return post data using get_posts().
*
* @param $args
*
* @return array|mixed|void
*/
function get_all_post_type_data( $args ) {
$defaults = array(
'numberposts' => $this->max_posts,
'offset' => 0,
'category' => 0,
'orderby' => 'post_date',
'order' => 'DESC',
'include' => array(),
'exclude' => array(),
'post_type' => 'any',
'meta_key' => '',
'meta_value' => '',
'meta_compare' => '',
'meta_query' => '',
'cache_results' => false,
'no_found_rows' => true,
);
$this->modify_post_params_for_external_plugins( $defaults );
/*
* Filter to exclude password protected posts.
* TODO: move to its own function and call it from here, returning whatever is appropriate.
* @since 2.3.12
*/
if ( apply_filters( 'aioseop_sitemap_include_password_posts', true ) === false ) {
$defaults['has_password'] = false;
}
$args = wp_parse_args( $args, $defaults );
if ( empty( $args['post_type'] ) ) {
return apply_filters( $this->prefix . 'post_filter', array(), $args );
}
$exclude_slugs = array();
if ( ! empty( $args['exclude'] ) ) {
$exclude = preg_split( '/[\s,]+/', trim( $args['exclude'] ) );
if ( ! empty( $exclude ) ) {
foreach ( $exclude as $k => $v ) {
if ( ! is_numeric( $v ) || ( $v != (int) $v ) ) {
$exclude_slugs[] = $v;
unset( $exclude[ $k ] );
}
}
if ( ! empty( $exclude_slugs ) ) {
$args['exclude'] = implode( ',', $exclude );
}
}
}
$ex_args = $args;
$ex_args['meta_key'] = '_aioseop_sitemap_exclude';
$ex_args['meta_value'] = 'on';
$ex_args['meta_compare'] = '=';
$ex_args['fields'] = 'ids';
$ex_args['posts_per_page'] = - 1;
$q = new WP_Query( $ex_args );
if ( ! is_array( $args['exclude'] ) ) {
$args['exclude'] = explode( ',', $args['exclude'] );
}
if ( ! empty( $q->posts ) ) {
$args['exclude'] = array_merge( $args['exclude'], $q->posts );
}
$this->excludes = array_merge( $args['exclude'], $exclude_slugs ); // Add excluded slugs and IDs to class var.
// TODO: consider using WP_Query instead of get_posts to improve efficiency.
$posts = get_posts( apply_filters( $this->prefix . 'post_query', $args ) );
if ( ! empty( $exclude_slugs ) ) {
foreach ( $posts as $k => $v ) {
if ( in_array( $v->post_name, $exclude_slugs ) ) {
unset( $posts[ $k ] );
}
}
}
$posts = apply_filters( $this->prefix . 'post_filter', $posts, $args );
return $posts;
}
}
}