<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[2134] 2013/frederickding/importer/trunk: Add parsing action to WordPress_Importer cron class; see #327</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://gsoc.trac.wordpress.org/changeset/2134">2134</a></dd>
<dt>Author</dt> <dd>frederick.ding</dd>
<dt>Date</dt> <dd>2013-07-18 21:52:14 +0000 (Thu, 18 Jul 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Add parsing action to WordPress_Importer cron class; see <a href="http://gsoc.trac.wordpress.org/ticket/327">#327</a>
- Whitespace/formatting changes</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#2013frederickdingimportertrunkclasswordpressimporterphp">2013/frederickding/importer/trunk/class-wordpress-importer.php</a></li>
<li><a href="#2013frederickdingimportertrunkclasswpimportercronphp">2013/frederickding/importer/trunk/class-wp-importer-cron.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="2013frederickdingimportertrunkclasswordpressimporterphp"></a>
<div class="modfile"><h4>Modified: 2013/frederickding/importer/trunk/class-wordpress-importer.php (2133 => 2134)</h4>
<pre class="diff"><span>
<span class="info">--- 2013/frederickding/importer/trunk/class-wordpress-importer.php 2013-07-18 21:51:59 UTC (rev 2133)
+++ 2013/frederickding/importer/trunk/class-wordpress-importer.php 2013-07-18 21:52:14 UTC (rev 2134)
</span><span class="lines">@@ -15,25 +15,68 @@
</span><span class="cx"> * @var int
</span><span class="cx"> */
</span><span class="cx"> protected $id;
</span><ins>+
+ /**
+ * WXR version of the file to be imported.
+ *
+ * @var float
+ */
+ protected $version;
+
+ protected $error = null;
</ins><span class="cx">
</span><del>- protected $error = null;
</del><ins>+ protected $warnings = array();
</ins><span class="cx">
</span><span class="cx"> protected $progress = array();
</span><span class="cx">
</span><span class="cx"> protected $wxr_file;
</span><ins>+
+ protected $authors = array();
+
+ protected $_data = array();
</ins><span class="cx">
</span><span class="cx"> /**
</span><span class="cx"> * Parses the WXR file and prepares us for the task of processing parsed
</span><span class="cx"> * data
</span><span class="cx"> *
</span><del>- * @todo port functionality from WP_Import::import_start()
- *
</del><span class="cx"> * @param string $file
</span><span class="cx"> * Path to the WXR file for parsing
</span><ins>+ * @return array WP_Error data if successful, or an instance of WP_Error if
+ * a problem occurred
</ins><span class="cx"> */
</span><span class="cx"> public function do_parse( $file ) {
</span><ins>+ if ( ! is_file( $file ) ) {
+ return new WP_Error( 'import_wxr_error',
+ __( 'The file does not exist, please try again.',
+ 'wordpress-importer' ), $file );
+ }
+
</ins><span class="cx"> $parser = new WXR_Parser();
</span><del>- return $parser->parse( $file );
</del><ins>+
+ $data = $parser->parse( $file );
+
+ // pass through errors
+ if ( is_wp_error( $data ) )
+ return $data;
+
+ // check for acceptable version
+ $version = floatval( $data['version'] );
+ if ( $version > self::MAX_WXR_VERSION ) {
+ return new WP_Error( 'import_wxr_error',
+ __( 'WXR version newer than importer',
+ 'wordpress-importer' ), $version );
+ }
+
+ $this->version = $version;
+ $this->wxr_file = $file;
+ $this->_data = $data;
+
+ /**
+ *
+ * @todo persistent storage without taking up too much space, or more
+ * efficient parsing of only the section needed
+ */
+ return $data;
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -44,11 +87,14 @@
</span><span class="cx"> * Path to the WXR file for importing
</span><span class="cx"> * @return boolean Whether the import process is complete
</span><span class="cx"> */
</span><del>- public function do_import( $file ) {
</del><ins>+ public function do_import( $file = '' ) {
</ins><span class="cx"> // defaults to being done
</span><span class="cx"> $done = true;
</span><ins>+ $this->error = null;
</ins><span class="cx">
</span><del>- $this->error = null;
</del><ins>+ if ( empty( $file ) )
+ $file = $this->wxr_file;
+
</ins><span class="cx"> if ( ! empty( $this->progress[$file] ) ) {
</span><span class="cx"> $done = false;
</span><span class="cx">
</span><span class="lines">@@ -90,7 +136,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Performs post-import cleanup of files and the cache
</del><ins>+ * Performs post-import cleanup of files and the cache
</ins><span class="cx"> */
</span><span class="cx"> public function do_cleanup() {
</span><span class="cx"> wp_import_cleanup( $this->id );
</span><span class="lines">@@ -103,8 +149,8 @@
</span><span class="cx">
</span><span class="cx"> wp_defer_term_counting( false );
</span><span class="cx"> wp_defer_comment_counting( false );
</span><del>-
- // do_action('import_end') omitted because that action seems to be
</del><ins>+
+ // do_action('import_end') omitted because that action seems to be
</ins><span class="cx"> // designed for callbacks that could sent output
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -155,12 +201,13 @@
</span><span class="cx"> * @todo
</span><span class="cx"> */
</span><span class="cx"> protected function process_urls() {}
</span><del>-
</del><ins>+
</ins><span class="cx"> /**
</span><span class="cx"> * Decide if the given meta key maps to information we will want to import
</span><del>- *
- * @param string $key The meta key to check
- * @return string|bool The key if we do want to import, false if not
</del><ins>+ *
+ * @param string $key
+ * The meta key to check
+ * @return string bool key if we do want to import, false if not
</ins><span class="cx"> */
</span><span class="cx"> public function is_valid_meta_key( $key ) {
</span><span class="cx"> // skip attachment metadata since we'll regenerate it from scratch
</span><span class="lines">@@ -174,11 +221,11 @@
</span><span class="cx"> return false;
</span><span class="cx"> return $key;
</span><span class="cx"> }
</span><del>-
</del><ins>+
</ins><span class="cx"> /**
</span><del>- * Decide whether or not the importer is allowed to create users.
- * Default is true, can be filtered via import_allow_create_users
- *
</del><ins>+ * Decide whether or not the importer is allowed to create users. Default is
+ * true, can be filtered via import_allow_create_users
+ *
</ins><span class="cx"> * @return bool True if creating users is allowed
</span><span class="cx"> */
</span><span class="cx"> public function is_allowed_user_creation() {
</span><span class="lines">@@ -206,4 +253,12 @@
</span><span class="cx"> public function get_max_attachment_size() {
</span><span class="cx"> return apply_filters( 'import_attachment_size_limit', 0 );
</span><span class="cx"> }
</span><ins>+
+ public function get_error() {
+ return $this->error;
+ }
+
+ public function get_warnings() {
+ return $this->warnings;
+ }
</ins><span class="cx"> }
</span><span class="cx">\ No newline at end of file
</span></span></pre></div>
<a id="2013frederickdingimportertrunkclasswpimportercronphp"></a>
<div class="modfile"><h4>Modified: 2013/frederickding/importer/trunk/class-wp-importer-cron.php (2133 => 2134)</h4>
<pre class="diff"><span>
<span class="info">--- 2013/frederickding/importer/trunk/class-wp-importer-cron.php 2013-07-18 21:51:59 UTC (rev 2133)
+++ 2013/frederickding/importer/trunk/class-wp-importer-cron.php 2013-07-18 21:52:14 UTC (rev 2134)
</span><span class="lines">@@ -93,21 +93,26 @@
</span><span class="cx"> /**
</span><span class="cx"> * Dispatches a cron event to an importer job or cleans up.
</span><span class="cx"> *
</span><del>- * @param array $args optional
</del><ins>+ * @param array $args
+ * optional
</ins><span class="cx"> */
</span><del>- function importer_callback( $args=array() ) {
- $args = (array)$args;
-
- if ( isset($this->callback) ) {
- $complete = call_user_func_array( array( $this, $this->callback ), $args );
</del><ins>+ function importer_callback( $args = array() ) {
+ $args = (array) $args;
+
+ if ( isset( $this->callback ) ) {
+ $complete = call_user_func_array(
+ array(
+ $this,
+ $this->callback
+ ), $args );
</ins><span class="cx"> } else {
</span><span class="cx"> // no callback, force the cron job to end
</span><span class="cx"> $complete = true;
</span><span class="cx"> }
</span><del>-
</del><ins>+
</ins><span class="cx"> if ( $complete ) {
</span><span class="cx"> // importer is finished, stop the scheduler
</span><del>- wp_clear_scheduled_hook( 'wp_cron_importer_hook', $args);
</del><ins>+ wp_clear_scheduled_hook( 'wp_cron_importer_hook', $args );
</ins><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>