<!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>[2132] 2013/frederickding/importer/trunk/class-wordpress-importer.php: Start separating importer tasks to a subclass of WP_Importer_Cron; 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/2132">2132</a></dd>
<dt>Author</dt> <dd>frederick.ding</dd>
<dt>Date</dt> <dd>2013-07-17 21:58:02 +0000 (Wed, 17 Jul 2013)</dd>
</dl>

<h3>Log Message</h3>
<pre>Start separating importer tasks to a subclass of WP_Importer_Cron; see <a href="http://gsoc.trac.wordpress.org/ticket/327">#327</a>

- Much is still TODO
- Method visibility defined as protected for process tasks
- Omitting anything that produces output directly; see <a href="http://gsoc.trac.wordpress.org/ticket/331">#331</a></pre>

<h3>Added Paths</h3>
<ul>
<li><a href="#2013frederickdingimportertrunkclasswordpressimporterphp">2013/frederickding/importer/trunk/class-wordpress-importer.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="2013frederickdingimportertrunkclasswordpressimporterphp"></a>
<div class="addfile"><h4>Added: 2013/frederickding/importer/trunk/class-wordpress-importer.php (0 => 2132)</h4>
<pre class="diff"><span>
<span class="info">--- 2013/frederickding/importer/trunk/class-wordpress-importer.php                           (rev 0)
+++ 2013/frederickding/importer/trunk/class-wordpress-importer.php      2013-07-17 21:58:02 UTC (rev 2132)
</span><span class="lines">@@ -0,0 +1,209 @@
</span><ins>+<?php
+
+class WordPress_Importer extends WP_Importer_Cron {
+
+       /**
+        * Highest supported WXR version.
+        * 
+        * @var float
+        */
+       const MAX_WXR_VERSION = 1.2;
+
+       /**
+        * Attachment ID of the WXR file.
+        * 
+        * @var int
+        */
+       protected $id;
+       
+       protected $error = null;
+
+       protected $progress = array();
+
+       protected $wxr_file;
+
+       /**
+        * Parses the WXR file and prepares us for the task of processing parsed
+        * data
+        * 
+        * @todo port functionality from WP_Import::import_start()
+        *
+        * @param string $file
+        *              Path to the WXR file for parsing
+        */
+       public function do_parse( $file ) {
+               $parser = new WXR_Parser();
+               return $parser->parse( $file );
+       }
+
+       /**
+        * The main controller for the actual import stage. Modelled on
+        * Tumblr_Import::do_blog_import().
+        * 
+        * @param string $file
+        *              Path to the WXR file for importing
+        * @return boolean Whether the import process is complete
+        */
+       public function do_import( $file ) {
+               // defaults to being done
+               $done = true;
+               
+               $this->error = null;
+               if ( ! empty( $this->progress[$file] ) ) {
+                       $done = false;
+                       
+                       do {
+                               switch ( $this->progress[$file] ) {
+                                       case 'start':
+                                       case 'authors':
+                                               $this->process_author_mappings();
+                                               break;
+                                       case 'categories':
+                                               $this->process_categories();
+                                               break;
+                                       case 'tags':
+                                               $this->process_tags();
+                                               break;
+                                       case 'terms':
+                                               $this->process_terms();
+                                               break;
+                                       case 'attachments':
+                                               $this->process_attachments();
+                                               break;
+                                       case 'posts':
+                                               $this->process_posts();
+                                               break;
+                                       case 'backfill_parents':
+                                               $this->process_parents();
+                                               break;
+                                       case 'backfill_urls':
+                                               $this->process_urls();
+                                               break;
+                                       case 'finish':
+                                       default:
+                                               $done = true;
+                               }
+                               $this->save_vars();
+                       } while ( empty( $this->error ) && ! $done && $this->have_time() );
+               }
+               return $done;
+       }
+
+       /**
+        * Performs post-import cleanup of files and the cache 
+        */
+       public function do_cleanup() {
+               wp_import_cleanup( $this->id );
+               
+               wp_cache_flush();
+               foreach ( get_taxonomies() as $tax ) {
+                       delete_option( "{$tax}_children" );
+                       _get_term_hierarchy( $tax );
+               }
+               
+               wp_defer_term_counting( false );
+               wp_defer_comment_counting( false );
+
+               // do_action('import_end') omitted because that action seems to be 
+               // designed for callbacks that could sent output
+       }
+
+       /**
+        *
+        * @todo
+        */
+       protected function process_author_mappings() {}
+
+       /**
+        *
+        * @todo
+        */
+       protected function process_categories() {}
+
+       /**
+        *
+        * @todo
+        */
+       protected function process_tags() {}
+
+       /**
+        *
+        * @todo
+        */
+       protected function process_terms() {}
+
+       /**
+        *
+        * @todo
+        */
+       protected function process_attachments() {}
+
+       /**
+        *
+        * @todo
+        */
+       protected function process_posts() {}
+
+       /**
+        *
+        * @todo
+        */
+       protected function process_parents() {}
+
+       /**
+        *
+        * @todo
+        */
+       protected function process_urls() {}
+       
+       /**
+        * Decide if the given meta key maps to information we will want to import
+        *
+        * @param string $key The meta key to check
+        * @return string|bool The key if we do want to import, false if not
+        */
+       public function is_valid_meta_key( $key ) {
+               // skip attachment metadata since we'll regenerate it from scratch
+               // skip _edit_lock as not relevant for import
+               if ( in_array( $key, 
+                               array( 
+                                               '_wp_attached_file',
+                                               '_wp_attachment_metadata',
+                                               '_edit_lock' 
+                               ) ) )
+                       return false;
+               return $key;
+       }
+       
+       /**
+        * Decide whether or not the importer is allowed to create users.
+        * Default is true, can be filtered via import_allow_create_users
+        *
+        * @return bool True if creating users is allowed
+        */
+       public function is_allowed_user_creation() {
+               return apply_filters( 'import_allow_create_users', true );
+       }
+
+       /**
+        * Decide whether or not the importer should attempt to download attachment
+        * files. Default is true, can be filtered via
+        * import_allow_fetch_attachments. The choice made at the import options
+        * screen must also be true, false here hides that checkbox.
+        * 
+        * @return bool True if downloading attachments is allowed
+        */
+       public function is_allowed_attachment_fetch() {
+               return apply_filters( 'import_allow_fetch_attachments', true );
+       }
+
+       /**
+        * 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
+        */
+       public function get_max_attachment_size() {
+               return apply_filters( 'import_attachment_size_limit', 0 );
+       }
+}
</ins><span class="cx">\ No newline at end of file
</span></span></pre>
</div>
</div>

</body>
</html>