<!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>[2167] 2013/frederickding/importer/trunk: Change step handling to fix bugs; 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/2167">2167</a></dd>
<dt>Author</dt> <dd>frederick.ding</dd>
<dt>Date</dt> <dd>2013-07-29 05:23:49 +0000 (Mon, 29 Jul 2013)</dd>
</dl>

<h3>Log Message</h3>
<pre>Change step handling to fix bugs; see <a href="http://gsoc.trac.wordpress.org/ticket/327">#327</a>

- Fixed elseif bug with advancing steps
- Changed each process step to advance to the next one if it has nothing to do
- Added `get_step()`</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#2013frederickdingimportertrunkclasswordpressimporterphp">2013/frederickding/importer/trunk/class-wordpress-importer.php</a></li>
<li><a href="#2013frederickdingimportertrunkteststestclasswordpressimporterphp">2013/frederickding/importer/trunk/tests/test-class-wordpress-importer.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 (2166 => 2167)</h4>
<pre class="diff"><span>
<span class="info">--- 2013/frederickding/importer/trunk/class-wordpress-importer.php   2013-07-29 05:23:39 UTC (rev 2166)
+++ 2013/frederickding/importer/trunk/class-wordpress-importer.php      2013-07-29 05:23:49 UTC (rev 2167)
</span><span class="lines">@@ -312,15 +312,20 @@
</span><span class="cx">                          'backfill_urls',
</span><span class="cx">                          'finish' 
</span><span class="cx">          );
</span><del>-                       // if no step provided, advance to the next step
</del><ins>+
+               // if no step provided, advance to the next step
</ins><span class="cx">           if ( empty( $step ) && ! empty( $this->wxr_file ) ) {
</span><del>-                       if ( ! isset( $this->progress[$this->wxr_file] ) ) {
</del><ins>+                        if ( empty( $this->progress[$this->wxr_file] ) ) {
</ins><span class="cx">                           // process hasn't yet started; start it
</span><span class="cx">                          $step = $steps[0];
</span><del>-                       } elseif ( $step_index = array_search( 
-                                       $this->progress[$this->wxr_file], $steps ) ) {
-                               if ( $step_index === 0 )
</del><ins>+                        } else {
+                               $step_index = array_search( $this->progress[$this->wxr_file], $steps );
+
+                               // if currently on start step, fast forward 2 steps in total
+                               if ( $step_index === 0 ) {
</ins><span class="cx">                                   $step_index ++;
</span><ins>+                               }
+                               // autoadvance to finish
</ins><span class="cx">                           if ( $step_index < count( $steps ) )
</span><span class="cx">                                  $step = $steps[$step_index + 1];
</span><span class="cx">                  }
</span><span class="lines">@@ -330,6 +335,7 @@
</span><span class="cx">                                  __( 'Invalid step', 'wordpress-importer' ) );
</span><span class="cx">          }
</span><span class="cx">          $this->progress[$this->wxr_file] = $step;
</span><ins>+
</ins><span class="cx">           return $step;
</span><span class="cx">  }
</span><span class="cx"> 
</span><span class="lines">@@ -505,8 +511,10 @@
</span><span class="cx">          $this->categories = apply_filters( 'wp_import_categories', 
</span><span class="cx">                          $this->categories );
</span><span class="cx">          
</span><del>-               if ( empty( $this->categories ) )
-                       return;
</del><ins>+                if ( empty( $this->categories ) ) {
+                       $this->advance();
+                       return true;
+               }
</ins><span class="cx">           
</span><span class="cx">          foreach ( $this->categories as $cat ) {
</span><span class="cx">                  // if the category already exists leave it alone
</span><span class="lines">@@ -561,8 +569,10 @@
</span><span class="cx">  protected function process_tags() {
</span><span class="cx">          $this->tags = apply_filters( 'wp_import_tags', $this->tags );
</span><span class="cx">          
</span><del>-               if ( empty( $this->tags ) )
-                       return;
</del><ins>+                if ( empty( $this->tags ) ) {
+                       $this->advance();
+                       return true;
+               }
</ins><span class="cx">           
</span><span class="cx">          foreach ( $this->tags as $tag ) {
</span><span class="cx">                  // if the tag already exists leave it alone
</span><span class="lines">@@ -612,8 +622,10 @@
</span><span class="cx">  protected function process_terms() {
</span><span class="cx">          $this->terms = apply_filters( 'wp_import_terms', $this->terms );
</span><span class="cx">          
</span><del>-               if ( empty( $this->terms ) )
-                       return;
</del><ins>+                if ( empty( $this->terms ) ) {
+                       $this->advance();
+                       return true;
+               }
</ins><span class="cx">           
</span><span class="cx">          foreach ( $this->terms as $term ) {
</span><span class="cx">                  // if the term already exists in the correct taxonomy leave it alone
</span><span class="lines">@@ -981,13 +993,19 @@
</span><span class="cx">   *
</span><span class="cx">   * @todo
</span><span class="cx">   */
</span><del>-       protected function process_parents() {}
</del><ins>+        protected function process_parents() {
+           $this->advance();
+           return true;
+       }
</ins><span class="cx"> 
</span><span class="cx">  /**
</span><span class="cx">   *
</span><span class="cx">   * @todo
</span><span class="cx">   */
</span><del>-       protected function process_urls() {}
</del><ins>+        protected function process_urls() {
+           $this->advance();
+           return true;
+       }
</ins><span class="cx"> 
</span><span class="cx">  /**
</span><span class="cx">   * Decide if the given meta key maps to information we will want to import
</span><span class="lines">@@ -1064,6 +1082,21 @@
</span><span class="cx">  }
</span><span class="cx"> 
</span><span class="cx">  /**
</span><ins>+        * Retrieves the current step.
+        *
+        * @return string|WP_Error
+        */
+       public function get_step() {
+               if ( ! isset( $this->wxr_file ) ) {
+                   // cannot set user options before WXR data is parsed
+                   return new WP_Error( 'import_step_error',
+                       __( 'Cannot get step without parsed data',
+                           'wordpress-importer' ) );
+               }
+               return $this->progress[$this->wxr_file];
+       }
+
+       /**
</ins><span class="cx">    * Stores parameters typically used for user input.
</span><span class="cx">   *
</span><span class="cx">   * Previously, some of these params would have been directly accessed with
</span><span class="lines">@@ -1071,7 +1104,7 @@
</span><span class="cx">   *
</span><span class="cx">   * @param string $name          
</span><span class="cx">   * @param mixed $value          
</span><del>-        * @return boolean WP_Error if unsuccessful, an error object
</del><ins>+         * @return boolean|WP_Error if unsuccessful, an error object
</ins><span class="cx">    */
</span><span class="cx">  public function set_param ( $name, $value ) {
</span><span class="cx">          if ( ! isset( $this->wxr_file ) ) {
</span><span class="lines">@@ -1088,6 +1121,27 @@
</span><span class="cx">  }
</span><span class="cx"> 
</span><span class="cx">  /**
</span><ins>+        * Unsets a parameter.
+        *
+        * @param string $name
+        * @return boolean|WP_Error
+        */
+       public function unset_param ( $name ) {
+               if ( ! isset( $this->wxr_file ) ) {
+                   // cannot set user options before WXR data is parsed
+                   return new WP_Error( 'import_param_unset_error',
+                       __( 'Cannot unset param without parsed data',
+                           'wordpress-importer' ) );
+               }
+               if ( ! is_array( $this->params[$this->wxr_file] ) )
+                   $this->params[$this->wxr_file] = array();
+               elseif(key_exists($name, $this->params[$this->wxr_file]))
+                       unset($this->params[$this->wxr_file][$name]);
+
+               return true;
+       }
+
+       /**
</ins><span class="cx">    * Retrieves parameters typically used for user input.
</span><span class="cx">   *
</span><span class="cx">   * @param string $name          
</span></span></pre></div>
<a id="2013frederickdingimportertrunkteststestclasswordpressimporterphp"></a>
<div class="modfile"><h4>Modified: 2013/frederickding/importer/trunk/tests/test-class-wordpress-importer.php (2166 => 2167)</h4>
<pre class="diff"><span>
<span class="info">--- 2013/frederickding/importer/trunk/tests/test-class-wordpress-importer.php        2013-07-29 05:23:39 UTC (rev 2166)
+++ 2013/frederickding/importer/trunk/tests/test-class-wordpress-importer.php   2013-07-29 05:23:49 UTC (rev 2167)
</span><span class="lines">@@ -83,12 +83,20 @@
</span><span class="cx">  public function test_advance() {
</span><span class="cx">          $instance = new WordPress_Importer();
</span><span class="cx">          
</span><ins>+               // hack it into submission; nothing else will function without a
+               // properly defined wxr_file
+               self::set( $instance, 'wxr_file', 'test-nonexistent.xml' );
+
</ins><span class="cx">           // with no step defined
</span><del>-               $this->assertWPError( $instance->advance(), 'Invalid step' );
</del><ins>+                $this->assertEquals( 'start', $instance->advance() );
</ins><span class="cx">           
</span><span class="cx">          // non-existent step
</span><del>-               $this->assertWPError( $instance->advance( rand_str( 10 ) ), 
-                               'Invalid step' );
</del><ins>+                $this->assertWPError( $instance->advance( rand_str( 10 ) ) );
+
+               // if on a terms step, the next step is posts
+               $this->assertEquals( 'terms', $instance->advance( 'terms' ) );
+               $this->assertEquals( 'terms', $instance->get_step() );
+               $this->assertEquals( 'posts', $instance->advance() );
</ins><span class="cx">           
</span><span class="cx">          // valid step
</span><span class="cx">          $this->assertEquals( 'finish', $instance->advance( 'finish' ) );
</span></span></pre>
</div>
</div>

</body>
</html>