Files
carpseeds.pl/wp-content/plugins/jet-data-importer/includes/import/class-jet-wxr-importer.php
2024-07-15 11:28:08 +02:00

2551 lines
70 KiB
PHP

<?php
/**
* Main importer class
*/
class Jet_WXR_Importer extends WP_Importer {
/**
* Maximum supported WXR version
*/
const MAX_WXR_VERSION = 1.2;
/**
* Regular expression for checking if a post references an attachment
*
* Note: This is a quick, weak check just to exclude text-only posts. More
* vigorous checking is done later to verify.
*/
const REGEX_HAS_ATTACHMENT_REFS = '!
(
# Match anything with an image or attachment class
class=[\'"].*?\b(wp-image-\d+|attachment-[\w\-]+)\b
|
# Match anything that looks like an upload URL
src=[\'"][^\'"]*(
[0-9]{4}/[0-9]{2}/[^\'"]+\.(jpg|jpeg|png|gif)
|
content/uploads[^\'"]+
)[\'"]
)!ix';
/**
* Version of WXR we're importing.
*
* Defaults to 1.0 for compatibility. Typically overridden by a
* `<wp:wxr_version>` tag at the start of the file.
*
* @var string
*/
protected $version = '1.0';
/**
* Importer options array
*
* @var array
*/
private $options = array();
/**
* Import file
*
* @var string
*/
private $file = null;
/**
* Reader instance
*
* @var object
*/
public $reader = null;
/**
* Logger object
*
* @var object
*/
public $logger = null;
/**
* Processed posts count
*
* @var integer
*/
private $processed = 0;
/**
* Constructor
*
* @param array $options {
* @var bool $prefill_existing_posts Should we prefill `post_exists` calls? (True prefills and uses more memory, false checks once per imported post and takes longer. Default is true.)
* @var bool $prefill_existing_comments Should we prefill `comment_exists` calls? (True prefills and uses more memory, false checks once per imported comment and takes longer. Default is true.)
* @var bool $prefill_existing_terms Should we prefill `term_exists` calls? (True prefills and uses more memory, false checks once per imported term and takes longer. Default is true.)
* @var bool $update_attachment_guids Should attachment GUIDs be updated to the new URL? (True updates the GUID, which keeps compatibility with v1, false doesn't update, and allows deduplication and reimporting. Default is false.)
* @var bool $fetch_attachments Fetch attachments from the remote server. (True fetches and creates attachment posts, false skips attachments. Default is false.)
* @var bool $aggressive_url_search Should we search/replace for URLs aggressively? (True searches all posts' content for old URLs and replaces, false checks for `<img class="wp-image-*">` only. Default is false.)
* @var int $default_author User ID to use if author is missing or invalid. (Default is null, which leaves posts unassigned.)
* }
*/
public function __construct( $options = array(), $file = null ) {
if ( ! current_user_can( 'import' ) ) {
return;
}
$this->options = wp_parse_args( $options, array(
'prefill_existing_posts' => true,
'prefill_existing_comments' => true,
'prefill_existing_terms' => true,
'update_attachment_guids' => true,
'fetch_attachments' => true,
'aggressive_url_search' => false,
'default_author' => null,
) );
$this->file = $file;
$this->reader = $this->get_reader( $this->file );
$this->logger = new Jet_Data_Importer_Logger();
}
/**
* Prepare import process
*
* @return void
*/
public function prepare_import() {
$count = 0;
// Ensure thats no previously stored data prevent us from successfully installation
jdi_cache()->clear_cache();
while ( $this->reader->read() ) {
if ( $this->reader->nodeType !== XMLReader::ELEMENT ) {
continue;
}
$count = $this->increment( $count );
$this->update_summary();
}
jdi_cache()->update( 'total_count', $count );
$summary = jdi_cache()->get( 'import_summary' );
}
/**
* Update import summary counts
*
* @return void
*/
public function update_summary() {
$summary = jdi_cache()->get( 'import_summary' );
if ( ! $summary ) {
$summary = array(
'posts' => 0,
'authors' => 0,
'media' => 0,
'comments' => 0,
'terms' => 0,
'tables' => 0,
);
}
switch ( $this->reader->name ) {
case 'wp:category':
case 'wp:tag':
case 'wp:term':
$summary['terms']++;
break;
case 'wp:user_tables':
$summary['tables']++;
break;
case 'wp:wp_author':
case 'wp:author':
$summary['authors']++;
break;
case 'wp:comment':
$summary['comments']++;
break;
case 'item':
$node = $this->reader->expand();
foreach ( $node->childNodes as $child ) {
// We only care about child elements
if ( $child->nodeType !== XML_ELEMENT_NODE ) {
continue;
}
if ( 'wp:post_type' !== $child->tagName ) {
continue;
}
if ( 'attachment' === $child->textContent ) {
$summary['media']++;
} else {
$summary['posts']++;
}
break; // Left loop
}
break;
default:
// Skip this node, probably handled by something already
break;
}
jdi_cache()->update( 'import_summary', $summary );
}
/**
* Update processed items summeary
*
* @param string $type Processed item type to update (posts, authors, media, comments, terms).
* @return void
*/
public function update_processed_summary( $type ) {
$processed = jdi_cache()->get( 'processed_summary' );
if ( ! is_array( $processed ) ) {
$processed = array(
'posts' => 0,
'authors' => 0,
'media' => 0,
'comments' => 0,
'terms' => 0,
'tables' => 0,
);
}
if ( isset( $processed[ $type ] ) ) {
$processed[ $type ]++;
}
jdi_cache()->update( 'processed_summary', $processed );
}
/**
* Increment passed value depending from processed item
*
* @param integer $current Value to increment.
* @return integer
*/
public function increment( $current = 1 ) {
switch ( $this->reader->name ) {
case 'wp:wxr_version':
case 'generator':
case 'blog_description':
case 'wp:base_site_url':
case 'wp:base_blog_url':
case 'item':
case 'wp:wp_author':
case 'wp:author':
case 'wp:category':
case 'wp:tag':
case 'wp:term':
case 'wp:options':
case 'wp:widgets_data':
case 'wp:user_tables':
$current++;
break;
default:
// Skip this node, probably handled by something already
break;
}
return $current;
}
/**
* Chunked import handler
*
* @param integer $num Number items to process (chunk size).
* @param integer $offset Items offset (chunk number)
* @return void
*/
public function chunked_import( $num = 30, $offset = 0 ) {
$skiped = 0;
$processed = 0;
while ( $this->reader->read() ) {
if ( $this->reader->nodeType !== XMLReader::ELEMENT ) {
continue;
}
if ( $skiped < $offset ) {
$skiped = $this->increment( $skiped );
continue;
}
switch ( $this->reader->name ) {
case 'wp:wxr_version':
// Upgrade to the correct version
$version = $this->reader->readString();
if ( version_compare( $version, self::MAX_WXR_VERSION, '>' ) ) {}
jdi_cache()->update( 'version', $version );
// Handled everything in this node, move on to the next
$this->next();
break;
case 'generator':
jdi_cache()->update( 'generator', $this->reader->readString() );
$this->next();
break;
case 'blog_description':
$description = $this->reader->readString();
jdi_cache()->update( 'description', $description );
update_option( 'blogdescription', $description );
$this->next();
break;
case 'wp:base_site_url':
jdi_cache()->update( 'siteurl', $this->reader->readString() );
$this->next();
break;
case 'wp:base_blog_url':
jdi_cache()->update( 'home', $this->reader->readString() );
$this->next();
break;
case 'wp:user_tables':
$node = $this->reader->expand();
$parsed = $this->parse_tables_node( $node );
if ( is_wp_error( $parsed ) ) {
// Skip the rest of this post
$this->next();
break;
}
$status = $this->process_tables( $parsed );
// Handled everything in this node, move on to the next
$this->next();
break;
case 'wp:options':
$node = $this->reader->expand();
$parsed = $this->parse_options_node( $node );
if ( is_wp_error( $parsed ) ) {
// Skip the rest of this post
$this->next();
break;
}
$status = $this->process_options( $parsed );
// Handled everything in this node, move on to the next
$this->next();
break;
case 'wp:widgets_data':
$data = $this->reader->readString();
$status = $this->process_widgets( $data );
// Handled everything in this node, move on to the next
$this->next();
break;
case 'wp:wp_author':
case 'wp:author':
$node = $this->reader->expand();
$parsed = $this->parse_author_node( $node );
if ( is_wp_error( $parsed ) ) {
// Skip the rest of this post
$this->next();
break;
}
$status = $this->process_author( $parsed['data'], $parsed['meta'] );
// Handled everything in this node, move on to the next
$this->next();
break;
case 'item':
$node = $this->reader->expand();
$parsed = $this->parse_post_node( $node );
if ( is_wp_error( $parsed ) ) {
// Skip the rest of this post
$this->next();
break;
}
$this->process_post( $parsed['data'], $parsed['meta'], $parsed['comments'], $parsed['terms'] );
// Handled everything in this node, move on to the next
$this->next();
break;
case 'wp:category':
$node = $this->reader->expand();
$parsed = $this->parse_term_node( $node, 'category' );
if ( is_wp_error( $parsed ) ) {
// Skip the rest of this post
$this->next();
break;
}
$status = $this->process_term( $parsed['data'], $parsed['meta'] );
// Handled everything in this node, move on to the next
$this->next();
break;
case 'wp:tag':
$node = $this->reader->expand();
$parsed = $this->parse_term_node( $node, 'tag' );
if ( is_wp_error( $parsed ) ) {
// Skip the rest of this post
$this->next();
break;
}
$status = $this->process_term( $parsed['data'], $parsed['meta'] );
// Handled everything in this node, move on to the next
$this->next();
break;
case 'wp:term':
$node = $this->reader->expand();
$parsed = $this->parse_term_node( $node );
if ( is_wp_error( $parsed ) ) {
// Skip the rest of this post
$this->next();
break;
}
$status = $this->process_term( $parsed['data'], $parsed['meta'] );
// Handled everything in this node, move on to the next
$this->next();
break;
default:
// Skip this node, probably handled by something already
break;
}
if ( $this->processed === $num ) {
break;
}
}
}
/**
* Increase processed posts counter and move to next item.
*
* @return function [description]
*/
private function next() {
$this->processed = $this->increment( $this->processed );
$this->reader->next();
}
/**
* Prepare options data
*
* @param object $node Parsed XML options object.
* @return array
*/
protected function parse_options_node( $node ) {
$data = array();
foreach ( $node->childNodes as $child ) {
// We only care about child elements
if ( $child->nodeType !== XML_ELEMENT_NODE ) {
continue;
}
$option_key = str_replace( 'wp:', '', $child->tagName );
$data[ $option_key ] = $child->textContent;
}
return $data;
}
/**
* Prepare tables data
*
* @param object $node Parsed XML tables object.
* @return array
*/
public function parse_tables_node( $node ) {
$data = array();
foreach ( $node->childNodes as $child ) {
// We only care about child elements
if ( $child->nodeType !== XML_ELEMENT_NODE ) {
continue;
}
$data[ $child->tagName ] = $child->textContent;
}
return $data;
}
/**
* Prepare author data
*
* @param object $node Parsed XML author object.
* @return array
*/
protected function parse_author_node( $node ) {
$data = array();
$meta = array();
foreach ( $node->childNodes as $child ) {
// We only care about child elements
if ( $child->nodeType !== XML_ELEMENT_NODE ) {
continue;
}
switch ( $child->tagName ) {
case 'wp:author_login':
$data['user_login'] = $child->textContent;
break;
case 'wp:author_id':
$data['ID'] = $child->textContent;
break;
case 'wp:author_email':
$data['user_email'] = $child->textContent;
break;
case 'wp:author_display_name':
$data['display_name'] = $child->textContent;
break;
case 'wp:author_first_name':
$data['first_name'] = $child->textContent;
break;
case 'wp:author_last_name':
$data['last_name'] = $child->textContent;
break;
}
}
$result = compact( 'data', 'meta' );
$saved = jdi_cache()->update( $data['user_login'], $result, 'users' );
return $result;
}
/**
* Parse a post node into post data.
*
* @param DOMElement $node Parent node of post data (typically `item`).
* @return array|WP_Error Post data array on success, error otherwise.
*/
protected function parse_post_node( $node ) {
$data = array();
$meta = array();
$comments = array();
$terms = array();
foreach ( $node->childNodes as $child ) {
// We only care about child elements
if ( $child->nodeType !== XML_ELEMENT_NODE ) {
continue;
}
switch ( $child->tagName ) {
case 'wp:post_type':
$data['post_type'] = $child->textContent;
break;
case 'title':
$data['post_title'] = $child->textContent;
break;
case 'guid':
$data['guid'] = $child->textContent;
break;
case 'dc:creator':
$data['post_author'] = $child->textContent;
break;
case 'content:encoded':
$data['post_content'] = $child->textContent;
break;
case 'excerpt:encoded':
$data['post_excerpt'] = $child->textContent;
break;
case 'wp:post_id':
$data['post_id'] = $child->textContent;
break;
case 'wp:post_date':
$data['post_date'] = $child->textContent;
break;
case 'wp:post_date_gmt':
$data['post_date_gmt'] = $child->textContent;
break;
case 'wp:comment_status':
$data['comment_status'] = $child->textContent;
break;
case 'wp:ping_status':
$data['ping_status'] = $child->textContent;
break;
case 'wp:post_name':
$data['post_name'] = $child->textContent;
break;
case 'wp:status':
$data['post_status'] = $child->textContent;
if ( $data['post_status'] === 'auto-draft' ) {
// Bail now
return new WP_Error(
'wxr_importer.post.cannot_import_draft',
__( 'Cannot import auto-draft posts', 'jet-data-importer' ),
$data
);
}
break;
case 'wp:post_parent':
$data['post_parent'] = $child->textContent;
break;
case 'wp:menu_order':
$data['menu_order'] = $child->textContent;
break;
case 'wp:post_password':
$data['post_password'] = $child->textContent;
break;
case 'wp:is_sticky':
$data['is_sticky'] = $child->textContent;
break;
case 'wp:attachment_url':
$data['attachment_url'] = $child->textContent;
break;
case 'wp:postmeta':
$meta_item = $this->parse_meta_node( $child );
if ( ! empty( $meta_item ) ) {
$meta[] = $meta_item;
}
break;
case 'wp:comment':
$comment_item = $this->parse_comment_node( $child );
if ( ! empty( $comment_item ) ) {
$comments[] = $comment_item;
}
break;
case 'category':
$term_item = $this->parse_category_node( $child );
if ( ! empty( $term_item ) ) {
$terms[] = $term_item;
}
break;
}
}
return compact( 'data', 'meta', 'comments', 'terms' );
}
/**
* Parse a meta node into meta data.
*
* @param DOMElement $node Parent node of meta data (typically `wp:postmeta` or `wp:commentmeta`).
* @return array|null Meta data array on success, or null on error.
*/
protected function parse_meta_node( $node ) {
foreach ( $node->childNodes as $child ) {
// We only care about child elements
if ( $child->nodeType !== XML_ELEMENT_NODE ) {
continue;
}
switch ( $child->tagName ) {
case 'wp:meta_key':
$key = $child->textContent;
break;
case 'wp:meta_value':
$value = $child->textContent;
break;
}
}
if ( empty( $key ) || empty( $value ) ) {
return null;
}
return compact( 'key', 'value' );
}
/**
* Parse a comment node into comment data.
*
* @param DOMElement $node Parent node of comment data (typically `wp:comment`).
* @return array Comment data array.
*/
protected function parse_comment_node( $node ) {
$data = array(
'commentmeta' => array(),
);
foreach ( $node->childNodes as $child ) {
// We only care about child elements
if ( $child->nodeType !== XML_ELEMENT_NODE ) {
continue;
}
switch ( $child->tagName ) {
case 'wp:comment_id':
$data['comment_id'] = $child->textContent;
break;
case 'wp:comment_author':
$data['comment_author'] = $child->textContent;
break;
case 'wp:comment_author_email':
$data['comment_author_email'] = $child->textContent;
break;
case 'wp:comment_author_IP':
$data['comment_author_IP'] = $child->textContent;
break;
case 'wp:comment_author_url':
$data['comment_author_url'] = $child->textContent;
break;
case 'wp:comment_user_id':
$data['comment_user_id'] = $child->textContent;
break;
case 'wp:comment_date':
$data['comment_date'] = $child->textContent;
break;
case 'wp:comment_date_gmt':
$data['comment_date_gmt'] = $child->textContent;
break;
case 'wp:comment_content':
$data['comment_content'] = $child->textContent;
break;
case 'wp:comment_approved':
$data['comment_approved'] = $child->textContent;
break;
case 'wp:comment_type':
$data['comment_type'] = $child->textContent;
break;
case 'wp:comment_parent':
$data['comment_parent'] = $child->textContent;
break;
case 'wp:commentmeta':
$meta_item = $this->parse_meta_node( $child );
if ( ! empty( $meta_item ) ) {
$data['commentmeta'][] = $meta_item;
}
break;
}
}
return $data;
}
/**
* Parse a comment node into comment data.
*
* @param DOMElement $node Parent node of comment data (typically `wp:comment`).
* @return array Comment data array.
*/
protected function parse_category_node( $node ) {
$data = array(
// Default taxonomy to "category", since this is a `<category>` tag
'taxonomy' => 'category',
);
$meta = array();
if ( $node->hasAttribute( 'domain' ) ) {
$data['taxonomy'] = $node->getAttribute( 'domain' );
}
if ( $node->hasAttribute( 'nicename' ) ) {
$data['slug'] = $node->getAttribute( 'nicename' );
}
$data['name'] = $node->textContent;
if ( empty( $data['slug'] ) ) {
return null;
}
// Just for extra compatibility
if ( $data['taxonomy'] === 'tag' ) {
$data['taxonomy'] = 'post_tag';
}
return $data;
}
/**
* Parse a term node into term data.
*
* @param DOMElement $node Parent node of term data.
* @param string $type Term type.
* @return array Comment data array.
*/
protected function parse_term_node( $node, $type = 'term' ) {
$data = array();
$meta = array();
$tag_name = array(
'id' => 'wp:term_id',
'taxonomy' => 'wp:term_taxonomy',
'slug' => 'wp:term_slug',
'parent' => 'wp:term_parent',
'name' => 'wp:term_name',
'description' => 'wp:term_description',
'meta' => 'wp:termmeta',
);
$taxonomy = null;
// Special casing!
switch ( $type ) {
case 'category':
$tag_name['slug'] = 'wp:category_nicename';
$tag_name['parent'] = 'wp:category_parent';
$tag_name['name'] = 'wp:cat_name';
$tag_name['description'] = 'wp:category_description';
$tag_name['taxonomy'] = null;
$data['taxonomy'] = 'category';
break;
case 'tag':
$tag_name['slug'] = 'wp:tag_slug';
$tag_name['parent'] = null;
$tag_name['name'] = 'wp:tag_name';
$tag_name['description'] = 'wp:tag_description';
$tag_name['taxonomy'] = null;
$data['taxonomy'] = 'post_tag';
break;
}
foreach ( $node->childNodes as $child ) {
// We only care about child elements
if ( $child->nodeType !== XML_ELEMENT_NODE ) {
continue;
}
$key = array_search( $child->tagName, $tag_name );
if ( $key ) {
switch ( $key ) {
case 'meta':
$meta[] = $this->parse_meta_node( $child );
break;
default:
$data[ $key ] = $child->textContent;
break;
}
}
}
if ( empty( $data['taxonomy'] ) ) {
return null;
}
// Compatibility with WXR 1.0
if ( $data['taxonomy'] === 'tag' ) {
$data['taxonomy'] = 'post_tag';
}
return compact( 'data', 'meta' );
}
/**
* Process import options
*
* @param array $data Parsed options to process
*/
protected function process_options( $data ) {
do_action( 'jet-data-importer/import/before-options-processing', $data );
if ( empty( $data ) ) {
return;
}
foreach ( $data as $key => $value ) {
$value = $this->maybe_decode( $value );
if ( empty( $value ) ) {
continue;
}
update_option( $key, $value );
$this->maybe_clone_child_options( $key, $value );
}
do_action( 'jet-data-importer/import/after-options-processing', $data );
}
/**
* Maybe clone passed option name and value into child theme.
*
* @param string $option Option name.
* @param string $value Options value.
* @return void
*/
protected function maybe_clone_child_options( $option, $value ) {
$to_copy = apply_filters( 'jet-data-importer/import/copy-options-to-child', array(
'theme_mods_%s',
'%s_sidebars',
) );
foreach ( $to_copy as $mask ) {
$replace = str_replace( '%s', '', $mask );
if ( false !== strpos( $option, $replace ) ) {
$this->clone_theme_mods( $option, $value, $mask );
}
}
}
/**
* Maybe clone theme mods for child theme.
*
* @param string $option Option name.
* @param array $value Mods to clone.
* @param string $mask OPtion mask to replace.
* @return bool
*/
protected function clone_theme_mods( $option, $value, $mask ) {
$replace = str_replace( '%s', '', $mask );
$imported_theme = str_replace( $replace, '', $option );
$current_theme = get_stylesheet();
if ( $current_theme === $imported_theme ) {
return false;
}
$current_parent = get_template();
if ( $imported_theme !== $current_parent ) {
return false;
}
return update_option( sprintf( $mask, $current_theme ), $value );
}
/**
* Import custom tblaes data
*
* @param array $data Data import.
* @return void
*/
protected function process_tables( $data ) {
if ( empty( $data ) ) {
return;
}
foreach ( $data as $table => $values ) {
if ( ! jdi_tools()->is_db_table_exists( $table ) ) {
continue;
}
$this->process_single_table( $table, $values );
$this->update_processed_summary( 'tables' );
}
do_action( 'jet-data-importer/import/after-import-tables' );
}
/**
* Import single table.
*
* @param string $table Table name.
* @param string $data Serialized table data.
* @return bool
*/
public function process_single_table( $table, $data ) {
global $wpdb;
$name = $wpdb->prefix . $table;
$data = maybe_unserialize( $data );
if ( ! is_array( $data ) ) {
return false;
}
foreach ( $data as $row ) {
$wpdb->replace( $name, $row );
}
}
/**
* Process import widgets
*
* @param string $data JSON-encoded widgets data.
*/
protected function process_widgets( $data ) {
$data = json_decode( $data );
if ( empty( $data ) || ! is_object( $data ) ) {
return;
}
// Hook before import
do_action( 'jet-data-importer/import/before-widgets-processing' );
$data = apply_filters( 'jet-data-importer/import/widgets-data', $data );
// Get all available widgets site supports
$available_widgets = jdi_tools()->available_widgets();
// Get all existing widget instances
$widget_instances = array();
foreach ( $available_widgets as $widget_data ) {
$widget_instances[ $widget_data['id_base'] ] = get_option( 'widget_' . $widget_data['id_base'] );
}
// Begin results
$results = array();
// Loop import data's sidebars
foreach ( $data as $sidebar_id => $widgets ) {
// Skip inactive widgets
// (should not be in export file)
if ( 'wp_inactive_widgets' == $sidebar_id ) {
continue;
}
// Check if sidebar is available on this site
// Otherwise add widgets to inactive, and say so
if ( $sidebar_data = $this->sidebar_exists( $sidebar_id ) ) {
$sidebar_available = true;
$use_sidebar_id = $sidebar_id;
$sidebar_message_type = 'success';
$sidebar_message = '';
} else {
$sidebar_available = false;
$use_sidebar_id = 'wp_inactive_widgets'; // add to inactive if sidebar does not exist in theme
$sidebar_message_type = 'error';
$sidebar_message = esc_html__(
'Sidebar does not exist in theme (using Inactive)', 'jet-data-importer'
);
}
// Result for sidebar
$results[ $sidebar_id ]['name'] = ! empty( $sidebar_data['name'] ) ? $sidebar_data['name'] : $sidebar_id; // sidebar name if theme supports it; otherwise ID
$results[ $sidebar_id ]['message_type'] = $sidebar_message_type;
$results[ $sidebar_id ]['message'] = $sidebar_message;
$results[ $sidebar_id ]['widgets'] = array();
$added_widgets = array();
// Loop widgets
foreach ( $widgets as $widget_instance_id => $widget ) {
$fail = false;
// Get id_base (remove -# from end) and instance ID number
$id_base = preg_replace( '/-[0-9]+$/', '', $widget_instance_id );
$instance_id_number = str_replace( $id_base . '-', '', $widget_instance_id );
// Does site support this widget?
if ( ! $fail && ! isset( $available_widgets[ $id_base ] ) ) {
$fail = true;
$widget_message_type = 'error';
$widget_message = esc_html__( 'Site does not support widget', 'jet-data-importer' ); // explain why widget not imported
}
// Filter to modify settings object before conversion to array and import
// Leave this filter here for backwards compatibility with manipulating objects (before conversion to array below)
// Ideally the newer wie_widget_settings_array below will be used instead of this
$widget = apply_filters( 'jet-data-importer/import/widget-settings', $widget ); // object
// Convert multidimensional objects to multidimensional arrays
// Some plugins like Jetpack Widget Visibility store settings as multidimensional arrays
// Without this, they are imported as objects and cause fatal error on Widgets page
// If this creates problems for plugins that do actually intend settings in objects then may need to consider other approach: https://wordpress.org/support/topic/problem-with-array-of-arrays
// It is probably much more likely that arrays are used than objects, however
$widget = json_decode( json_encode( $widget ), true );
// Filter to modify settings array
// This is preferred over the older wie_widget_settings filter above
// Do before identical check because changes may make it identical to end result (such as URL replacements)
$widget = apply_filters( 'jet-data-importer/import/widget-settings-array', $widget );
// Does widget with identical settings already exist in same sidebar?
if ( ! $fail && isset( $widget_instances[ $id_base ] ) ) {
// Get existing widgets in this sidebar
$sidebars_widgets = get_option( 'sidebars_widgets' );
$sidebar_widgets = isset( $sidebars_widgets[ $use_sidebar_id ] ) ? $sidebars_widgets[ $use_sidebar_id ] : array(); // check Inactive if that's where will go
// Loop widgets with ID base
$single_widget_instances = ! empty( $widget_instances[ $id_base ] ) ? $widget_instances[ $id_base ] : array();
foreach ( $single_widget_instances as $check_id => $check_widget ) {
// Is widget in same sidebar and has identical settings?
if ( in_array( "$id_base-$check_id", $sidebar_widgets ) && (array) $widget == $check_widget ) {
$fail = true;
$widget_message_type = 'warning';
$widget_message = esc_html__( 'Widget already exists', 'jet-data-importer' ); // explain why widget not imported
break;
}
}
}
// No failure
if ( ! $fail ) {
// Add widget instance
$single_widget_instances = get_option( 'widget_' . $id_base ); // all instances for that widget ID base, get fresh every time
$single_widget_instances = ! empty( $single_widget_instances ) ? $single_widget_instances : array( '_multiwidget' => 1 ); // start fresh if have to
$single_widget_instances[] = $widget; // add it
// Get the key it was given
end( $single_widget_instances );
$new_instance_id_number = key( $single_widget_instances );
// If key is 0, make it 1
// When 0, an issue can occur where adding a widget causes data from other widget to load, and the widget doesn't stick (reload wipes it)
if ( '0' === strval( $new_instance_id_number ) ) {
$new_instance_id_number = 1;
$single_widget_instances[$new_instance_id_number] = $single_widget_instances[0];
unset( $single_widget_instances[0] );
}
// Move _multiwidget to end of array for uniformity
if ( isset( $single_widget_instances['_multiwidget'] ) ) {
$multiwidget = $single_widget_instances['_multiwidget'];
unset( $single_widget_instances['_multiwidget'] );
$single_widget_instances['_multiwidget'] = $multiwidget;
}
// Update option with new widget
update_option( 'widget_' . $id_base, $single_widget_instances );
// Assign widget instance to sidebar
$new_instance_id = $id_base . '-' . $new_instance_id_number; // use ID number from new widget instance
$added_widgets[] = $new_instance_id; // add new instance to sidebar
// After widget import action
$after_widget_import = array(
'sidebar' => $use_sidebar_id,
'sidebar_old' => $sidebar_id,
'widget' => $widget,
'widget_type' => $id_base,
'widget_id' => $new_instance_id,
'widget_id_old' => $widget_instance_id,
'widget_id_num' => $new_instance_id_number,
'widget_id_num_old' => $instance_id_number
);
do_action( 'jet-data-importer/import/after-widget-import', $after_widget_import );
// Success message
if ( $sidebar_available ) {
$widget_message_type = 'success';
$widget_message = esc_html__( 'Imported', 'jet-data-importer' );
} else {
$widget_message_type = 'warning';
$widget_message = esc_html__( 'Imported to Inactive', 'jet-data-importer' );
}
}
// Result for widget instance
$results[ $sidebar_id ]['widgets'][ $widget_instance_id ]['name'] = isset( $available_widgets[ $id_base ]['name'] ) ? $available_widgets[ $id_base ]['name'] : $id_base; // widget name or ID if name not available (not supported by site)
$results[ $sidebar_id ]['widgets'][ $widget_instance_id ]['title'] = ! empty( $widget['title'] ) ? $widget['title'] : esc_html__( 'No Title', 'jet-data-importer' ); // show "No Title" if widget instance is untitled
$results[ $sidebar_id ]['widgets'][ $widget_instance_id ]['message_type'] = $widget_message_type;
$results[ $sidebar_id ]['widgets'][ $widget_instance_id ]['message'] = $widget_message;
}
$sidebars_widgets = get_option( 'sidebars_widgets' );
// Check if inactive widgets already exists
if ( ! isset( $sidebars_widgets['wp_inactive_widgets'] ) ) {
$inactive_widgets = array();
} else {
$inactive_widgets = $sidebars_widgets['wp_inactive_widgets'];
}
// If writen sidebar exist in theme - move existing widgets from it to inactive and replace them with new widgets. Otherwise - add new widgets to inactive.
if ( 'wp_inactive_widgets' === $use_sidebar_id ) {
$sidebars_widgets['wp_inactive_widgets'] = array_merge( $inactive_widgets, $added_widgets );
} else {
$existing_widgets = isset( $sidebars_widgets[ $use_sidebar_id ] ) ? $sidebars_widgets[ $use_sidebar_id ] : array();
if ( empty( $existing_widgets ) ) {
$existing_widgets = array();
}
$sidebars_widgets['wp_inactive_widgets'] = array_merge( $inactive_widgets, $existing_widgets );
$sidebars_widgets[ $use_sidebar_id ] = $added_widgets;
}
update_option( 'sidebars_widgets', $sidebars_widgets ); // save the amended data
}
// Hook after import
do_action( 'jet-data-importer/import/after-process-widget', $sidebars_widgets );
// Return results
return apply_filters( 'jet-data-importer/import/widget-import-results', $results );
}
/**
* Check if passed sidebar are exists
*
* @return bool
*/
protected function sidebar_exists( $sidebar ) {
global $wp_registered_sidebars;
if ( isset( $wp_registered_sidebars[ $sidebar ] ) ) {
return $wp_registered_sidebars[ $sidebar ];
}
$theme_name = get_option( 'stylesheet' );
$custom_sidebars = get_option( $theme_name . '_sidebars' );
foreach ( array( $theme_name . '_sidebars', $theme_name . '_sidbars' ) as $option ) {
$custom_sidebars = get_option( $option );
if ( is_array( $custom_sidebars ) && ! empty( $custom_sidebars['custom_sidebar'][ $sidebar ] ) ) {
return $custom_sidebars['custom_sidebar'][ $sidebar ];
}
}
return false;
}
/**
* If passed JSON-encoded array - decode it and return, otherwise - return passed value.
*
* @param string $value String to decode.
* @return mixed
*/
protected function maybe_decode( $value ) {
$maybe_array = json_decode( $value, true );
if ( ! is_array( $maybe_array ) ) {
return $value;
}
return $maybe_array;
}
/**
* Create new posts based on import information
*
* Posts marked as having a parent which doesn't exist will become top level items.
* Doesn't create a new post if: the post type doesn't exist, the given post ID
* is already noted as imported or a post with the same title and date already exists.
* Note that new/updated terms, comments and meta are imported for the last of the above.
*/
protected function process_post( $data, $meta, $comments, $terms ) {
/**
* Pre-process post data.
*
* @param array $data Post data. (Return empty to skip.)
* @param array $meta Meta data.
* @param array $comments Comments on the post.
* @param array $terms Terms on the post.
*/
$data = apply_filters( 'wxr_importer.pre_process.post', $data, $meta, $comments, $terms );
if ( empty( $data ) ) {
return false;
}
$original_id = isset( $data['post_id'] ) ? (int) $data['post_id'] : 0;
$parent_id = isset( $data['post_parent'] ) ? (int) $data['post_parent'] : 0;
$author_id = isset( $data['post_author'] ) ? (int) $data['post_author'] : 0;
$item_type = ( 'attachment' === $data['post_type'] ) ? 'media' : 'posts';
$processed_posts = jdi_cache()->get( 'posts', 'mapping' );
$processed_user_slug = jdi_cache()->get( 'user_slug', 'mapping' );
$processed_terms = jdi_cache()->get( 'terms', 'mapping' );
$remap_posts = jdi_cache()->get( 'posts', 'requires_remapping' );
// Have we already processed this?
if ( isset( $processed_posts[ $original_id ] ) ) {
return;
}
/**
* Allow skip some posts from 3rd party plugins or theme
* (shame on MotoPress)
*
* @param bool
* @param array
*/
$skip_post = apply_filters( 'jet-data-importer/import/skip-post', false, $data );
if ( $skip_post ) {
return;
}
$post_type_object = get_post_type_object( $data['post_type'] );
// Is this type even valid?
if ( ! $post_type_object ) {
$this->logger->warning( sprintf(
__( 'Failed to import "%s": Invalid post type %s', 'jet-data-importer' ),
$data['post_title'],
$data['post_type']
) );
$this->update_processed_summary( $item_type );
return false;
}
$post_exists = $this->post_exists( $data );
if ( $post_exists ) {
$this->logger->info( sprintf(
__('%s "%s" already exists.', 'jet-data-importer'),
$post_type_object->labels->singular_name,
$data['post_title']
) );
// Even though this post already exists, new comments might need importing
$this->process_comments( $comments, $original_id, $data, $post_exists );
$this->update_processed_summary( $item_type );
return false;
}
// Map the parent post, or mark it as one we need to fix
$requires_remapping = false;
if ( $parent_id ) {
if ( isset( $processed_posts[ $parent_id ] ) ) {
$data['post_parent'] = $processed_posts[ $parent_id ];
} else {
$meta[] = array( 'key' => '_wxr_import_parent', 'value' => $parent_id );
$requires_remapping = true;
$data['post_parent'] = 0;
}
}
// Map the author, or mark it as one we need to fix
$author = sanitize_user( $data['post_author'], true );
if ( empty( $author ) ) {
// Missing or invalid author, use default if available.
$data['post_author'] = $this->options['default_author'];
} elseif ( isset( $processed_user_slug[ $author ] ) ) {
$data['post_author'] = $processed_user_slug[ $author ];
} else {
$meta[] = array( 'key' => '_wxr_import_user_slug', 'value' => $author );
$requires_remapping = true;
$data['post_author'] = (int) get_current_user_id();
}
// Does the post look like it contains attachment images?
if ( preg_match( self::REGEX_HAS_ATTACHMENT_REFS, $data['post_content'] ) ) {
$meta[] = array( 'key' => '_wxr_import_has_attachment_refs', 'value' => true );
$requires_remapping = true;
}
// Whitelist to just the keys we allow
$postdata = array(
'import_id' => $data['post_id'],
);
$allowed = array(
'post_author' => true,
'post_date' => true,
'post_date_gmt' => true,
'post_content' => true,
'post_excerpt' => true,
'post_title' => true,
'post_status' => true,
'post_name' => true,
'comment_status' => true,
'ping_status' => true,
'guid' => true,
'post_parent' => true,
'menu_order' => true,
'post_type' => true,
'post_password' => true,
);
foreach ( $data as $key => $value ) {
if ( ! isset( $allowed[ $key ] ) ) {
continue;
}
$postdata[ $key ] = $data[ $key ];
}
$postdata = apply_filters( 'wp_import_post_data_processed', $postdata, $data );
if ( 'attachment' === $postdata['post_type'] ) {
if ( ! $this->options['fetch_attachments'] ) {
$this->logger->notice( sprintf(
__( 'Skipping attachment "%s", fetching attachments disabled', 'jet-data-importer' ),
$data['post_title']
) );
$this->update_processed_summary( $item_type );
return false;
}
$remote_url = ! empty( $data['attachment_url'] ) ? $data['attachment_url'] : $data['guid'];
$post_id = $this->process_attachment( $postdata, $meta, $remote_url );
} else {
$post_id = wp_insert_post( $postdata, true );
do_action( 'wp_import_insert_post', $post_id, $original_id, $postdata, $data );
}
if ( is_wp_error( $post_id ) ) {
$this->logger->error( sprintf(
__( 'Failed to import "%s" (%s)', 'jet-data-importer' ),
$data['post_title'],
$post_type_object->labels->singular_name
) );
$this->logger->debug( $post_id->get_error_message() );
/**
* Post processing failed.
*
* @param WP_Error $post_id Error object.
* @param array $data Raw data imported for the post.
* @param array $meta Raw meta data, already processed by {@see process_post_meta}.
* @param array $comments Raw comment data, already processed by {@see process_comments}.
* @param array $terms Raw term data, already processed.
*/
do_action( 'wxr_importer.process_failed.post', $post_id, $data, $meta, $comments, $terms );
$this->update_processed_summary( $item_type );
return false;
}
// Ensure stickiness is handled correctly too
if ( $data['is_sticky'] == 1 ) {
stick_post( $post_id );
}
// map pre-import ID to local ID
$processed_posts[ $original_id ] = (int) $post_id;
if ( $requires_remapping ) {
$remap_posts[ $post_id ] = true;
jdi_cache()->update( 'posts', $remap_posts, 'requires_remapping' );
}
$this->mark_post_exists( $data, $post_id );
jdi_cache()->update( 'posts', $processed_posts, 'mapping' );
$this->logger->info( sprintf(
__( 'Imported "%s" (%s)', 'jet-data-importer' ),
$data['post_title'],
$post_type_object->labels->singular_name
) );
$this->logger->debug( sprintf(
__( 'Post %d remapped to %d', 'jet-data-importer' ),
$original_id,
$post_id
) );
// Handle the terms too
$terms = apply_filters( 'wp_import_post_terms', $terms, $post_id, $data );
if ( ! empty( $terms ) ) {
$term_ids = array();
foreach ( $terms as $term ) {
$taxonomy = $term['taxonomy'];
$key = sha1( $taxonomy . ':' . $term['slug'] );
if ( isset( $processed_terms[ $key ] ) ) {
$term_ids[ $taxonomy ][] = (int) $processed_terms[ $key ];
} else {
$meta[] = array( 'key' => '_wxr_import_term', 'value' => $term );
$requires_remapping = true;
}
}
foreach ( $term_ids as $tax => $ids ) {
$tt_ids = wp_set_post_terms( $post_id, $ids, $tax );
do_action( 'wp_import_set_post_terms', $tt_ids, $ids, $tax, $post_id, $data );
}
}
$this->process_comments( $comments, $post_id, $data );
$this->process_post_meta( $meta, $post_id, $data );
if ( 'nav_menu_item' === $data['post_type'] ) {
$this->process_menu_item_meta( $post_id, $data, $meta );
}
$this->update_processed_summary( $item_type );
/**
* Post processing completed.
*
* @param int $post_id New post ID.
* @param array $data Raw data imported for the post.
* @param array $meta Raw meta data, already processed by {@see process_post_meta}.
* @param array $comments Raw comment data, already processed by {@see process_comments}.
* @param array $terms Raw term data, already processed.
*/
do_action( 'wxr_importer.processed.post', $post_id, $data, $meta, $comments, $terms );
}
/**
* Process and import user data.
*
* @param array $comments List of comment data arrays.
* @param int $post_id Post to associate with.
* @param array $post Post data.
* @return int|WP_Error Number of comments imported on success, error otherwise.
*/
protected function process_author( $data, $meta ) {
/**
* Pre-process user data.
*
* @param array $data User data. (Return empty to skip.)
* @param array $meta Meta data.
*/
$data = apply_filters( 'wxr_importer.pre_process.user', $data, $meta );
if ( empty( $data ) ) {
return false;
}
// Have we already handled this user?
$original_id = isset( $data['ID'] ) ? $data['ID'] : 0;
$original_slug = $data['user_login'];
$processed_user_slug = jdi_cache()->get( 'user_slug', 'mapping' );
$processed_users = jdi_cache()->get( 'users', 'mapping' );
if ( empty( $processed_user_slug ) ) {
$processed_user_slug = array();
}
if ( empty( $processed_users ) ) {
$processed_users = array();
}
if ( isset( $processed_users[ $original_id ] ) ) {
$existing = $processed_users[ $original_id ];
// Note the slug mapping if we need to too
if ( ! isset( $processed_user_slug[ $original_slug ] ) ) {
$processed_user_slug[ $original_slug ] = $existing;
}
$this->update_processed_summary( 'authors' );
return false;
}
if ( isset( $processed_user_slug[ $original_slug ] ) ) {
$existing = $processed_user_slug[ $original_slug ];
// Ensure we note the mapping too
$processed_users[ $original_id ] = $existing;
$this->update_processed_summary( 'authors' );
return false;
}
// Allow overriding the user's slug
$login = $original_slug;
$user_slug_override = jdi_cache()->get( 'user_slug_override' );
if ( isset( $user_slug_override[ $login ] ) ) {
$login = $user_slug_override[ $login ];
}
$userdata = array(
'user_login' => sanitize_user( $login, true ),
'user_pass' => wp_generate_password(),
);
$allowed = array(
'user_email' => true,
'display_name' => true,
'first_name' => true,
'last_name' => true,
);
foreach ( $data as $key => $value ) {
if ( ! isset( $allowed[ $key ] ) ) {
continue;
}
$userdata[ $key ] = $data[ $key ];
}
$user_id = wp_insert_user( wp_slash( $userdata ) );
if ( is_wp_error( $user_id ) ) {
$this->logger->error( sprintf(
__( 'Failed to import user "%s"', 'jet-data-importer' ),
$userdata['user_login']
) );
$this->logger->debug( $user_id->get_error_message() );
/**
* User processing failed.
*
* @param WP_Error $user_id Error object.
* @param array $userdata Raw data imported for the user.
*/
do_action( 'wxr_importer.process_failed.user', $user_id, $userdata );
$this->update_processed_summary( 'authors' );
return false;
}
if ( $original_id ) {
$processed_users[ $original_id ] = $user_id;
}
$processed_user_slug[ $original_slug ] = $user_id;
$this->logger->info( sprintf(
__( 'Imported user "%s"', 'jet-data-importer' ),
$userdata['user_login']
) );
$this->logger->debug( sprintf(
__( 'User %d remapped to %d', 'jet-data-importer' ),
$original_id,
$user_id
) );
$this->update_processed_summary( 'authors' );
// TODO: Implement meta handling once WXR includes it
/**
* User processing completed.
*
* @param int $user_id New user ID.
* @param array $userdata Raw data imported for the user.
*/
do_action( 'wxr_importer.processed.user', $user_id, $userdata );
}
/**
* Process and import comment data.
*
* @param array $comments List of comment data arrays.
* @param int $post_id Post to associate with.
* @param array $post Post data.
* @return int|WP_Error Number of comments imported on success, error otherwise.
*/
protected function process_term( $data, $meta ) {
/**
* Pre-process term data.
*
* @param array $data Term data. (Return empty to skip.)
* @param array $meta Meta data.
*/
$data = apply_filters( 'wxr_importer.pre_process.term', $data, $meta );
if ( empty( $data ) ) {
return false;
}
$original_id = isset( $data['id'] ) ? (int) $data['id'] : 0;
$original_slug = isset( $data['slug'] ) ? esc_attr( $data['slug'] ) : 0;
$parent_slug = isset( $data['parent'] ) ? esc_attr( $data['parent'] ) : 0;
$mapping_key = sha1( $data['taxonomy'] . ':' . $data['slug'] );
$processed_terms = jdi_cache()->get( 'terms', 'mapping' );
$processed_term_id = jdi_cache()->get( 'term_id', 'mapping' );
$processed_term_slug = jdi_cache()->get( 'term_slug', 'mapping' );
$remap_terms = jdi_cache()->get( 'terms', 'requires_remapping' );
if ( empty( $remap_terms ) ) {
$remap_terms = array();
}
if ( $existing = $this->term_exists( $data ) ) {
$processed_terms[ $mapping_key ] = $existing;
$processed_term_id[ $original_id ] = $existing;
$processed_term_slug[ $original_slug ] = $existing;
$this->update_processed_summary( 'terms' );
return false;
}
// WP really likes to repeat itself in export files
if ( isset( $processed_terms[ $mapping_key ] ) ) {
$this->update_processed_summary( 'terms' );
return false;
}
$termdata = array();
$allowed = array(
'slug' => true,
'description' => true,
);
// Map the parent term, or mark it as one we need to fix
$requires_remapping = false;
if ( $parent_slug ) {
if ( isset( $processed_term_slug[ $parent_slug ] ) ) {
$data['parent'] = $processed_term_slug[ $parent_slug ];
} else {
// Prepare for remapping later
$meta[] = array( 'key' => '_wxr_import_parent', 'value' => $parent_slug );
$requires_remapping = true;
// Wipe the parent for now
$data['parent'] = 0;
}
}
foreach ( $data as $key => $value ) {
if ( ! isset( $allowed[ $key ] ) ) {
continue;
}
$termdata[ $key ] = $data[ $key ];
}
$result = wp_insert_term( $data['name'], $data['taxonomy'], $termdata );
if ( is_wp_error( $result ) ) {
$this->logger->warning( sprintf(
__( 'Failed to import %s %s', 'jet-data-importer' ),
$data['taxonomy'],
$data['name']
) );
$this->logger->debug( $result->get_error_message() );
do_action( 'wp_import_insert_term_failed', $result, $data );
/**
* Term processing failed.
*
* @param WP_Error $result Error object.
* @param array $data Raw data imported for the term.
* @param array $meta Meta data supplied for the term.
*/
do_action( 'wxr_importer.process_failed.term', $result, $data, $meta );
$this->update_processed_summary( 'terms' );
return false;
}
$term_id = $result['term_id'];
$term_mapping_key = $data['taxonomy'] . '-' . $original_slug;
$processed_terms[ $mapping_key ] = $term_id;
$processed_term_id[ $original_id ] = $term_id;
$processed_term_slug[ $term_mapping_key ] = $term_id;
if ( true === $requires_remapping ) {
$remap_terms[ $term_id ] = $data['taxonomy'];
}
jdi_cache()->update( 'terms', $processed_terms, 'mapping' );
jdi_cache()->update( 'term_id', $processed_term_id, 'mapping' );
jdi_cache()->update( 'term_slug', $processed_term_slug, 'mapping' );
jdi_cache()->update( 'terms', $remap_terms, 'requires_remapping' );
$this->logger->info( sprintf(
__( 'Imported "%s" (%s)', 'jet-data-importer' ),
$data['name'],
$data['taxonomy']
) );
$this->logger->debug( sprintf(
__( 'Term %d remapped to %d', 'jet-data-importer' ),
$original_id,
$term_id
) );
$this->process_term_meta( $meta, $term_id, $result );
do_action( 'wp_import_insert_term', $term_id, $data );
$this->update_processed_summary( 'terms' );
/**
* Term processing completed.
*
* @param int $term_id New term ID.
* @param array $data Raw data imported for the term.
*/
do_action( 'wxr_importer.processed.term', $term_id, $data );
}
/**
* Adds meta data to inserted term.
*
* @param array $meta Array with meta data.
* @param int $term_id Term ID
* @param array $term Terma data
* @return voiid
*/
protected function process_term_meta( $meta, $term_id, $term ) {
if ( empty( $meta ) ) {
return;
}
foreach ( $meta as $meta_item ) {
$value = maybe_unserialize( $meta_item['value'] );
add_term_meta( $term_id, $meta_item['key'], $meta_item['value'] );
}
}
/**
* Process and import comment data.
*
* @param array $comments List of comment data arrays.
* @param int $post_id Post to associate with.
* @param array $post Post data.
* @return int|WP_Error Number of comments imported on success, error otherwise.
*/
protected function process_comments( $comments, $post_id, $post, $post_exists = false ) {
$comments = apply_filters( 'wp_import_post_comments', $comments, $post_id, $post );
if ( empty( $comments ) ) {
return 0;
}
$num_comments = 0;
$processed_comments = jdi_cache()->get( 'comments', 'mapping' );
$processed_users = jdi_cache()->get( 'users', 'mapping' );
$remap_comments = jdi_cache()->get( 'comments', 'requires_remapping' );
// Sort by ID to avoid excessive remapping later
usort( $comments, array( $this, 'sort_comments_by_id' ) );
foreach ( $comments as $key => $comment ) {
/**
* Pre-process comment data
*
* @param array $comment Comment data. (Return empty to skip.)
* @param int $post_id Post the comment is attached to.
*/
$comment = apply_filters( 'wxr_importer.pre_process.comment', $comment, $post_id );
if ( empty( $comment ) ) {
return false;
}
$original_id = isset( $comment['comment_id'] ) ? (int) $comment['comment_id'] : 0;
$parent_id = isset( $comment['comment_parent'] ) ? (int) $comment['comment_parent'] : 0;
$author_id = isset( $comment['comment_user_id'] ) ? (int) $comment['comment_user_id'] : 0;
// if this is a new post we can skip the comment_exists() check
// TODO: Check comment_exists for performance
if ( $post_exists && $exists = $this->comment_exists( $comment ) ) {
$processed_comments[ $original_id ] = $exists;
continue;
}
// Remove meta from the main array
$meta = isset( $comment['commentmeta'] ) ? $comment['commentmeta'] : array();
unset( $comment['commentmeta'] );
// Map the parent comment, or mark it as one we need to fix
$requires_remapping = false;
if ( $parent_id ) {
if ( isset( $processed_comments[ $parent_id ] ) ) {
$comment['comment_parent'] = $processed_comments[ $parent_id ];
} else {
// Prepare for remapping later
$meta[] = array( 'key' => '_wxr_import_parent', 'value' => $parent_id );
$requires_remapping = true;
// Wipe the parent for now
$comment['comment_parent'] = 0;
}
}
// Map the author, or mark it as one we need to fix
if ( $author_id ) {
if ( isset( $processed_users[ $author_id ] ) ) {
$comment['user_id'] = $processed_users[ $author_id ];
} else {
// Prepare for remapping later
$meta[] = array( 'key' => '_wxr_import_user', 'value' => $author_id );
$requires_remapping = true;
// Wipe the user for now
$comment['user_id'] = 0;
}
}
// Run standard core filters
$comment['comment_post_ID'] = $post_id;
$comment = wp_filter_comment( $comment );
// wp_insert_comment expects slashed data
$comment_id = wp_insert_comment( wp_slash( $comment ) );
$processed_comments[ $original_id ] = $comment_id;
if ( $requires_remapping ) {
$remap_comments[ $comment_id ] = true;
}
$this->mark_comment_exists( $comment, $comment_id );
/**
* Comment has been imported.
*
* @param int $comment_id New comment ID
* @param array $comment Comment inserted (`comment_id` item refers to the original ID)
* @param int $post_id Post parent of the comment
* @param array $post Post data
*/
do_action( 'wp_import_insert_comment', $comment_id, $comment, $post_id, $post );
// Process the meta items
foreach ( $meta as $meta_item ) {
$value = maybe_unserialize( $meta_item['value'] );
add_comment_meta( $comment_id, wp_slash( $meta_item['key'] ), wp_slash( $value ) );
}
$this->update_processed_summary( 'comments' );
/**
* Post processing completed.
*
* @param int $post_id New post ID.
* @param array $comment Raw data imported for the comment.
* @param array $meta Raw meta data, already processed by {@see process_post_meta}.
* @param array $post_id Parent post ID.
*/
do_action( 'wxr_importer.processed.comment', $comment_id, $comment, $meta, $post_id );
$num_comments++;
}
jdi_cache()->update( 'comments', $processed_comments, 'mapping' );
jdi_cache()->update( 'comments', $remap_comments, 'requires_remapping' );
return $num_comments;
}
/**
* Callback for `usort` to sort comments by ID
*
* @param array $a Comment data for the first comment
* @param array $b Comment data for the second comment
* @return int
*/
public function sort_comments_by_id( $a, $b ) {
if ( empty( $a['comment_id'] ) ) {
return 1;
}
if ( empty( $b['comment_id'] ) ) {
return -1;
}
return $a['comment_id'] - $b['comment_id'];
}
/**
* Process and import post meta items.
*
* @param array $meta List of meta data arrays.
* @param int $post_id Post to associate with.
* @param array $post Post data.
* @return int|WP_Error Number of meta items imported on success, error otherwise.
*/
protected function process_post_meta( $meta, $post_id, $post ) {
if ( empty( $meta ) ) {
return true;
}
$remap_meta = jdi_cache()->get( 'posts_meta', 'requires_remapping' );
$processed_users = jdi_cache()->get( 'users', 'mapping' );
if ( class_exists( 'Elementor\Compatibility' ) ) {
remove_filter(
'wxr_importer.pre_process.post_meta',
array( 'Elementor\Compatibility', 'on_wxr_importer_pre_process_post_meta' )
);
}
foreach ( $meta as $meta_item ) {
/**
* Pre-process post meta data.
*
* @param array $meta_item Meta data. (Return empty to skip.)
* @param int $post_id Post the meta is attached to.
*/
$meta_item = apply_filters( 'wxr_importer.pre_process.post_meta', $meta_item, $post_id );
if ( empty( $meta_item ) ) {
return false;
}
$key = apply_filters( 'import_post_meta_key', $meta_item['key'], $post_id, $post );
$value = false;
$remap_meta = $this->maybe_add_remap_item( $key, $remap_meta, $post_id, 'post' );
if ( '_edit_last' == $key ) {
$value = intval( $meta_item['value'] );
if ( ! isset( $processed_users[ $value ] ) ) {
// Skip!
continue;
}
$value = $processed_users[ $value ];
}
if ( $key ) {
// export gets meta straight from the DB so could have a serialized string
if ( ! $value ) {
$value = maybe_unserialize( $meta_item['value'] );
}
if ( '_elementor_data' === $key ) {
$value = wp_slash( $value );
}
if ( in_array( $key, array( '_form_data', '_notifications_data' ) ) ) {
update_post_meta( $post_id, $key, $value );
} else {
add_post_meta( $post_id, $key, $value );
}
do_action( 'import_post_meta', $post_id, $key, $value );
// if the post has a featured image, take note of this in case of remap
if ( '_thumbnail_id' == $key ) {
jdi_cache()->update( $post_id, (int) $value, 'featured_images' );
}
}
}
jdi_cache()->update( 'posts_meta', $remap_meta, 'requires_remapping' );
return true;
}
/**
* Check if we need to stor this meta for post processing
*
* @param string $meta_key Meta key.
* @param array $requires_remapping Alreday stored data for remapping.
* @param int $post_id Processed post ID.
* @return array
*/
protected function maybe_add_remap_item( $meta_key, $requires_remapping, $object_id, $context ) {
if ( 'term' === $context ) {
$search_key = 'term_meta';
} else {
$search_key = 'post_meta';
}
$remap_meta = jdi()->get_setting( 'remap', $search_key );
if ( ! $remap_meta || ! is_array( $remap_meta ) ) {
return $requires_remapping;
}
if ( array_key_exists( $meta_key, $remap_meta ) ) {
if ( isset( $requires_remapping[ $object_id ] ) ) {
$requires_remapping[ $object_id ][] = $meta_key;
} else {
$requires_remapping[ $object_id ] = array( $meta_key );
}
}
return $requires_remapping;
}
/**
* Attempt to create a new menu item from import data
*
* Fails for draft, orphaned menu items and those without an associated nav_menu
* or an invalid nav_menu term. If the post type or term object which the menu item
* represents doesn't exist then the menu item will not be imported (waits until the
* end of the import to retry again before discarding).
*
* @param array $item Menu item details from WXR file
*/
protected function process_menu_item_meta( $post_id, $data, $meta ) {
$item_type = get_post_meta( $post_id, '_menu_item_type', true );
$original_object_id = get_post_meta( $post_id, '_menu_item_object_id', true );
$object_id = null;
$processed_term_id = jdi_cache()->get( 'term_id', 'mapping' );
$processed_posts = jdi_cache()->get( 'posts', 'mapping' );
$missing_items = jdi_cache()->get( 'missing_menu_items' );
$remap_posts = jdi_cache()->get( 'posts', 'requires_remapping' );
$this->logger->debug( sprintf( 'Processing menu item %s', $item_type ) );
$requires_remapping = false;
switch ( $item_type ) {
case 'taxonomy':
if ( isset( $processed_term_id[ $original_object_id ] ) ) {
$object_id = $processed_term_id[ $original_object_id ];
} else {
add_post_meta( $post_id, '_wxr_import_menu_item', wp_slash( $original_object_id ) );
$requires_remapping = true;
}
break;
case 'post_type':
if ( isset( $processed_posts[ $original_object_id ] ) ) {
$object_id = $processed_posts[ $original_object_id ];
} else {
add_post_meta( $post_id, '_wxr_import_menu_item', wp_slash( $original_object_id ) );
$requires_remapping = true;
}
break;
case 'custom':
// Custom refers to itself, wonderfully easy.
$object_id = $post_id;
$home_url = jdi_cache()->get( 'home' );
foreach ( $meta as $_item ) {
if ( '_menu_item_url' === $_item['key'] && false !== strpos( $_item['value'], $home_url ) ) {
update_post_meta(
$post_id,
'_menu_item_url',
str_replace( $home_url, get_option( 'home' ), $_item['value'] )
);
}
}
break;
default:
// associated object is missing or not imported yet, we'll retry later
$missing_items[] = $item;
$this->logger->debug( 'Unknown menu item type' );
break;
}
if ( $requires_remapping ) {
$remap_posts[ $post_id ] = true;
jdi_cache()->update( 'posts', $remap_posts, 'requires_remapping' );
}
if ( empty( $object_id ) ) {
// Nothing needed here.
return;
}
$this->logger->debug( sprintf( 'Menu item %d mapped to %d', $original_object_id, $object_id ) );
update_post_meta( $post_id, '_menu_item_object_id', wp_slash( $object_id ) );
}
/**
* If fetching attachments is enabled then attempt to create a new attachment
*
* @param array $post Attachment post details from WXR.
* @param string $url URL to fetch attachment from.
* @return int|WP_Error Post ID on success, WP_Error otherwise.
*/
protected function process_attachment( $post, $meta, $remote_url ) {
// try to use _wp_attached file for upload folder placement to ensure the same location as the export site
// e.g. location is 2003/05/image.jpg but the attachment post_date is 2010/09, see media_handle_upload()
$post['upload_date'] = $post['post_date'];
foreach ( $meta as $meta_item ) {
if ( $meta_item['key'] !== '_wp_attached_file' ) {
continue;
}
if ( preg_match( '%^[0-9]{4}/[0-9]{2}%', $meta_item['value'], $matches ) ) {
$post['upload_date'] = $matches[0];
}
break;
}
ini_set( 'max_execution_time', 300 );
set_time_limit( 0 );
// if the URL is absolute, but does not contain address, then upload it assuming base_site_url
if ( preg_match( '|^/[\w\W]+$|', $remote_url ) ) {
$remote_url = rtrim( $this->base_url, '/' ) . $remote_url;
}
$upload = $this->fetch_remote_file( $remote_url, $post );
if ( is_wp_error( $upload ) ) {
return $upload;
}
$info = wp_check_filetype( $upload['file'] );
if ( ! $info ) {
return new WP_Error( 'attachment_processing_error', __( 'Invalid file type', 'jet-data-importer' ) );
}
$post['post_mime_type'] = $info['type'];
// WP really likes using the GUID for display. Allow updating it.
// See https://core.trac.wordpress.org/ticket/33386
if ( $this->options['update_attachment_guids'] ) {
$post['guid'] = $upload['url'];
}
// as per wp-admin/includes/upload.php
$post_id = wp_insert_attachment( $post, $upload['file'] );
if ( is_wp_error( $post_id ) ) {
return $post_id;
}
ini_set( 'max_execution_time', 300 );
set_time_limit( 0 );
//$attachment_metadata = wp_generate_attachment_metadata( $post_id, $upload['file'] );
//wp_update_attachment_metadata( $post_id, $attachment_metadata );
// Map this image URL later if we need to
jdi_cache()->update( $remote_url, $upload['url'], 'url_remap' );
// If we have a HTTPS URL, ensure the HTTP URL gets replaced too
if ( substr( $remote_url, 0, 8 ) === 'https://') {
$insecure_url = 'http' . substr( $remote_url, 5 );
jdi_cache()->update( $insecure_url, $upload['url'], 'url_remap' );
}
if ( $this->options['aggressive_url_search'] ) {
// remap resized image URLs, works by stripping the extension and remapping the URL stub.
/*if ( preg_match( '!^image/!', $info['type'] ) ) {
$parts = pathinfo( $url );
$name = basename( $parts['basename'], ".{$parts['extension']}" ); // PATHINFO_FILENAME in PHP 5.2
$parts_new = pathinfo( $upload['url'] );
$name_new = basename( $parts_new['basename'], ".{$parts_new['extension']}" );
$this->url_remap[$parts['dirname'] . '/' . $name] = $parts_new['dirname'] . '/' . $name_new;
}*/
}
return $post_id;
}
/**
* Attempt to download a remote file attachment
*
* @param string $url URL of item to fetch.
* @param array $post Attachment details.
* @return array|WP_Error Local file location details on success, WP_Error otherwise.
*/
protected function fetch_remote_file( $url, $post ) {
// extract the file name and extension from the url
$file_name = basename( $url );
$file_content = wp_remote_retrieve_body( wp_safe_remote_get( $url ) );
if ( empty( $file_content ) ) {
return false;
}
// get placeholder file in the upload dir with a unique, sanitized filename
$upload = wp_upload_bits( $file_name, '', $file_content, $post['upload_date'] );
if ( $upload['error'] ) {
return new WP_Error( 'upload_dir_error', $upload['error'] );
}
$filesize = filesize( $upload['file'] );
if ( 0 == $filesize ) {
@unlink( $upload['file'] );
return new WP_Error(
'import_file_error',
__( 'Zero size file downloaded', 'jet-data-importer' )
);
}
$max_size = (int) $this->max_attachment_size();
if ( ! empty( $max_size ) && $filesize > $max_size ) {
@unlink( $upload['file'] );
return new WP_Error(
'import_file_error',
sprintf( __( 'Remote file is too large, limit is %s', 'jet-data-importer' ), size_format( $max_size ) )
);
}
return $upload;
}
/**
* Decide what the maximum file size for downloaded attachments is.
* Default is 0 (unlimited), can be filtered via import_attachment_size_limit
*
* @return int Maximum attachment file size to import
*/
protected function max_attachment_size() {
return apply_filters( 'import_attachment_size_limit', 0 );
}
/**
* Does the post exist?
*
* @param array $data Post data to check against.
* @return int|bool Existing post ID if it exists, false otherwise.
*/
protected function post_exists( $data ) {
// Constant-time lookup if we prefilled
$exists_key = $data['guid'];
$existing_posts = jdi_cache()->get( 'posts', 'exists' );
if ( $this->options['prefill_existing_posts'] ) {
return isset( $existing_posts[ $exists_key ] ) ? $existing_posts[ $exists_key ] : false;
}
// No prefilling, but might have already handled it
if ( isset( $existing_posts[ $exists_key ] ) ) {
return $existing_posts[ $exists_key ];
}
// Still nothing, try post_exists, and cache it
$exists = post_exists( $data['post_title'], $data['post_content'], $data['post_date'] );
$existing_posts[ $exists_key ] = $exists;
jdi_cache()->update( 'posts', $existing_posts, 'exists' );
return $exists;
}
/**
* Mark the post as existing.
*
* @param array $data Post data to mark as existing.
* @param int $post_id Post ID.
*/
protected function mark_post_exists( $data, $post_id ) {
$exists_key = $data['guid'];
$existing_posts = jdi_cache()->get( 'posts', 'exists' );
$this->exists['post'][ $exists_key ] = $post_id;
jdi_cache()->update( 'posts', $existing_posts, 'exists' );
}
/**
* Does the comment exist?
*
* @param array $data Comment data to check against.
* @return int|bool Existing comment ID if it exists, false otherwise.
*/
protected function comment_exists( $data ) {
$exists_key = sha1( $data['comment_author'] . ':' . $data['comment_date'] );
$existing_comments = jdi_cache()->get( 'comments', 'exists' );
// Constant-time lookup if we prefilled
if ( $this->options['prefill_existing_comments'] ) {
return isset( $existing_comments[ $exists_key ] ) ? $existing_comments[ $exists_key ] : false;
}
// No prefilling, but might have already handled it
if ( isset( $existing_comments[ $exists_key ] ) ) {
return $existing_comments[ $exists_key ];
}
// Still nothing, try comment_exists, and cache it
$exists = comment_exists( $data['comment_author'], $data['comment_date'] );
$this->existing_comments[ $exists_key ] = $exists;
jdi_cache()->update( 'comments', $existing_comments, 'exists' );
return $exists;
}
/**
* Mark the comment as existing.
*
* @param array $data Comment data to mark as existing.
* @param int $comment_id Comment ID.
*/
protected function mark_comment_exists( $data, $comment_id ) {
$exists_key = sha1( $data['comment_author'] . ':' . $data['comment_date'] );
$existing_comments = jdi_cache()->get( 'comments', 'exists' );
$existing_comments[ $exists_key ] = $comment_id;
jdi_cache()->update( 'comments', $existing_comments, 'exists' );
}
/**
* Does the term exist?
*
* @param array $data Term data to check against.
* @return int|bool Existing term ID if it exists, false otherwise.
*/
protected function term_exists( $data ) {
$exists_key = sha1( $data['taxonomy'] . ':' . $data['slug'] );
$existing_terms = jdi_cache()->get( 'terms', 'exists' );
// Constant-time lookup if we prefilled
if ( $this->options['prefill_existing_terms'] ) {
return isset( $existing_terms[ $exists_key ] ) ? $existing_terms[ $exists_key ] : false;
}
// No prefilling, but might have already handled it
if ( isset( $existing_terms[ $exists_key ] ) ) {
return $existing_terms[ $exists_key ];
}
// Still nothing, try comment_exists, and cache it
$exists = term_exists( $data['slug'], $data['taxonomy'] );
if ( is_array( $exists ) ) {
$exists = $exists['term_id'];
}
$existing_terms[ $exists_key ] = $exists;
jdi_cache()->update( 'terms', $existing_terms, 'exists' );
return $exists;
}
/**
* Mark the term as existing.
*
* @param array $data Term data to mark as existing.
* @param int $term_id Term ID.
*/
protected function mark_term_exists( $data, $term_id ) {
$exists_key = sha1( $data['taxonomy'] . ':' . $data['slug'] );
$existing_terms = jdi_cache()->get( 'terms', 'exists' );
$existing_terms[ $exists_key ] = $comment_id;
jdi_cache()->update( 'terms', $existing_terms, 'exists' );
}
/**
* Get a stream reader for the file.
*
* @param string $file Path to the XML file.
* @return XMLReader|WP_Error Reader instance on success, error otherwise.
*/
protected function get_reader( $file ) {
// Avoid loading external entities for security
$old_value = null;
if ( function_exists( 'libxml_disable_entity_loader' ) ) {
// $old_value = libxml_disable_entity_loader( true );
}
$reader = new XMLReader();
$status = $reader->open( $file );
if ( ! is_null( $old_value ) ) {
// libxml_disable_entity_loader( $old_value );
}
if ( ! $status ) {
return new WP_Error( 'wxr_importer.cannot_parse', __( 'Could not open the file for parsing', 'jet-data-importer' ) );
}
return $reader;
}
}