wp-admin/includes/class-wp-importer.php

   1 <?php
   2 /**
   3  * WP_Importer base class
   4  */
   5 class WP_Importer {
   6         /**
   7          * Class Constructor
   8          *
   9          */
  10         public function __construct() {}
  11
  12         /**
  13          * Returns array with imported permalinks from WordPress database
  14          *
  15          * @global wpdb $wpdb WordPress database abstraction object.
  16          *
  17          * @param string $importer_name
  18          * @param string $bid
  19          * @return array
  20          */
  21         public function get_imported_posts( $importer_name, $bid ) {
  22                 global $wpdb;
  23
  24                 $hashtable = array();
  25
  26                 $limit = 100;
  27                 $offset = 0;
  28
  29                 // Grab all posts in chunks
  30                 do {
  31                         $meta_key = $importer_name . '_' . $bid . '_permalink';
  32                         $sql = $wpdb->prepare( "SELECT post_id, meta_value FROM $wpdb->postmeta WHERE meta_key = '%s' LIMIT %d,%d", $meta_key, $offset, $limit );
  33                         $results = $wpdb->get_results( $sql );
  34
  35                         // Increment offset
  36                         $offset = ( $limit + $offset );
  37
  38                         if ( !empty( $results ) ) {
  39                                 foreach ( $results as $r ) {
  40                                         // Set permalinks into array
  41                                         $hashtable[$r->meta_value] = intval( $r->post_id );
  42                                 }
  43                         }
  44                 } while ( count( $results ) == $limit );
  45
  46                 // Unset to save memory.
  47                 unset( $results, $r );
  48
  49                 return $hashtable;
  50         }
  51
  52         /**
  53          * Return count of imported permalinks from WordPress database
  54          *
  55          * @global wpdb $wpdb WordPress database abstraction object.
  56          *
  57          * @param string $importer_name
  58          * @param string $bid
  59          * @return int
  60          */
  61         public function count_imported_posts( $importer_name, $bid ) {
  62                 global $wpdb;
  63
  64                 $count = 0;
  65
  66                 // Get count of permalinks
  67                 $meta_key = $importer_name . '_' . $bid . '_permalink';
  68                 $sql = $wpdb->prepare( "SELECT COUNT( post_id ) AS cnt FROM $wpdb->postmeta WHERE meta_key = '%s'", $meta_key );
  69
  70                 $result = $wpdb->get_results( $sql );
  71
  72                 if ( !empty( $result ) )
  73                         $count = intval( $result[0]->cnt );
  74
  75                 // Unset to save memory.
  76                 unset( $results );
  77
  78                 return $count;
  79         }
  80
  81         /**
  82          * Set array with imported comments from WordPress database
  83          *
  84          * @global wpdb $wpdb WordPress database abstraction object.
  85          *
  86          * @param string $bid
  87          * @return array
  88          */
  89         public function get_imported_comments( $bid ) {
  90                 global $wpdb;
  91
  92                 $hashtable = array();
  93
  94                 $limit = 100;
  95                 $offset = 0;
  96
  97                 // Grab all comments in chunks
  98                 do {
  99                         $sql = $wpdb->prepare( "SELECT comment_ID, comment_agent FROM $wpdb->comments LIMIT %d,%d", $offset, $limit );
 100                         $results = $wpdb->get_results( $sql );
 101
 102                         // Increment offset
 103                         $offset = ( $limit + $offset );
 104
 105                         if ( !empty( $results ) ) {
 106                                 foreach ( $results as $r ) {
 107                                         // Explode comment_agent key
 108                                         list ( $ca_bid, $source_comment_id ) = explode( '-', $r->comment_agent );
 109                                         $source_comment_id = intval( $source_comment_id );
 110
 111                                         // Check if this comment came from this blog
 112                                         if ( $bid == $ca_bid ) {
 113                                                 $hashtable[$source_comment_id] = intval( $r->comment_ID );
 114                                         }
 115                                 }
 116                         }
 117                 } while ( count( $results ) == $limit );
 118
 119                 // Unset to save memory.
 120                 unset( $results, $r );
 121
 122                 return $hashtable;
 123         }
 124
 125         /**
 126          *
 127          * @param int $blog_id
 128          * @return int|void
 129          */
 130         public function set_blog( $blog_id ) {
 131                 if ( is_numeric( $blog_id ) ) {
 132                         $blog_id = (int) $blog_id;
 133                 } else {
 134                         $blog = 'http://' . preg_replace( '#^https?://#', '', $blog_id );
 135                         if ( ( !$parsed = parse_url( $blog ) ) || empty( $parsed['host'] ) ) {
 136                                 fwrite( STDERR, "Error: can not determine blog_id from $blog_id\n" );
 137                                 exit();
 138                         }
 139                         if ( empty( $parsed['path'] ) )
 140                                 $parsed['path'] = '/';
 141                         $blog = get_blog_details( array( 'domain' => $parsed['host'], 'path' => $parsed['path'] ) );
 142                         if ( !$blog ) {
 143                                 fwrite( STDERR, "Error: Could not find blog\n" );
 144                                 exit();
 145                         }
 146                         $blog_id = (int) $blog->blog_id;
 147                 }
 148
 149                 if ( function_exists( 'is_multisite' ) ) {
 150                         if ( is_multisite() )
 151                                 switch_to_blog( $blog_id );
 152                 }
 153
 154                 return $blog_id;
 155         }
 156
 157         /**
 158          *
 159          * @param int $user_id
 160          * @return int|void
 161          */
 162         public function set_user( $user_id ) {
 163                 if ( is_numeric( $user_id ) ) {
 164                         $user_id = (int) $user_id;
 165                 } else {
 166                         $user_id = (int) username_exists( $user_id );
 167                 }
 168
 169                 if ( !$user_id || !wp_set_current_user( $user_id ) ) {
 170                         fwrite( STDERR, "Error: can not find user\n" );
 171                         exit();
 172                 }
 173
 174                 return $user_id;
 175         }
 176
 177         /**
 178          * Sort by strlen, longest string first
 179          *
 180          * @param string $a
 181          * @param string $b
 182          * @return int
 183          */
 184         public function cmpr_strlen( $a, $b ) {
 185                 return strlen( $b ) - strlen( $a );
 186         }
 187
 188         /**
 189          * GET URL
 190          *
 191          * @param string $url
 192          * @param string $username
 193          * @param string $password
 194          * @param bool   $head
 195          * @return array
 196          */
 197         public function get_page( $url, $username = '', $password = '', $head = false ) {
 198                 // Increase the timeout
 199                 add_filter( 'http_request_timeout', array( $this, 'bump_request_timeout' ) );
 200
 201                 $headers = array();
 202                 $args = array();
 203                 if ( true === $head )
 204                         $args['method'] = 'HEAD';
 205                 if ( !empty( $username ) && !empty( $password ) )
 206                         $headers['Authorization'] = 'Basic ' . base64_encode( "$username:$password" );
 207
 208                 $args['headers'] = $headers;
 209
 210                 return wp_safe_remote_request( $url, $args );
 211         }
 212
 213         /**
 214          * Bump up the request timeout for http requests
 215          *
 216          * @param int $val
 217          * @return int
 218          */
 219         public function bump_request_timeout( $val ) {
 220                 return 60;
 221         }
 222
 223         /**
 224          * Check if user has exceeded disk quota
 225          *
 226          * @return bool
 227          */
 228         public function is_user_over_quota() {
 229                 if ( function_exists( 'upload_is_user_over_quota' ) ) {
 230                         if ( upload_is_user_over_quota() ) {
 231                                 return true;
 232                         }
 233                 }
 234
 235                 return false;
 236         }
 237
 238         /**
 239          * Replace newlines, tabs, and multiple spaces with a single space
 240          *
 241          * @param string $string
 242          * @return string
 243          */
 244         public function min_whitespace( $string ) {
 245                 return preg_replace( '|[\r\n\t ]+|', ' ', $string );
 246         }
 247
 248         /**
 249          * Reset global variables that grow out of control during imports
 250          *
 251          * @global wpdb  $wpdb
 252          * @global array $wp_actions
 253          */
 254         public function stop_the_insanity() {
 255                 global $wpdb, $wp_actions;
 256                 // Or define( 'WP_IMPORTING', true );
 257                 $wpdb->queries = array();
 258                 // Reset $wp_actions to keep it from growing out of control
 259                 $wp_actions = array();
 260         }
 261 }
 262
 263 /**
 264  * Returns value of command line params.
 265  * Exits when a required param is not set.
 266  *
 267  * @param string $param
 268  * @param bool   $required
 269  * @return mixed
 270  */
 271 function get_cli_args( $param, $required = false ) {
 272         $args = $_SERVER['argv'];
 273
 274         $out = array();
 275
 276         $last_arg = null;
 277         $return = null;
 278
 279         $il = sizeof( $args );
 280
 281         for ( $i = 1, $il; $i < $il; $i++ ) {
 282                 if ( (bool) preg_match( "/^--(.+)/", $args[$i], $match ) ) {
 283                         $parts = explode( "=", $match[1] );
 284                         $key = preg_replace( "/[^a-z0-9]+/", "", $parts[0] );
 285
 286                         if ( isset( $parts[1] ) ) {
 287                                 $out[$key] = $parts[1];
 288                         } else {
 289                                 $out[$key] = true;
 290                         }
 291
 292                         $last_arg = $key;
 293                 } elseif ( (bool) preg_match( "/^-([a-zA-Z0-9]+)/", $args[$i], $match ) ) {
 294                         for ( $j = 0, $jl = strlen( $match[1] ); $j < $jl; $j++ ) {
 295                                 $key = $match[1]{$j};
 296                                 $out[$key] = true;
 297                         }
 298
 299                         $last_arg = $key;
 300                 } elseif ( $last_arg !== null ) {
 301                         $out[$last_arg] = $args[$i];
 302                 }
 303         }
 304
 305         // Check array for specified param
 306         if ( isset( $out[$param] ) ) {
 307                 // Set return value
 308                 $return = $out[$param];
 309         }
 310
 311         // Check for missing required param
 312         if ( !isset( $out[$param] ) && $required ) {
 313                 // Display message and exit
 314                 echo "\"$param\" parameter is required but was not specified\n";
 315                 exit();
 316         }
 317
 318         return $return;
 319 }