import_page = 'woocommerce_product_csv'; $this->delimiter = empty( $_REQUEST['delimiter'] ) ? ',' : (string) wc_clean( $_REQUEST['delimiter'] ); } /** * Registered callback function for the WordPress Importer. * * Manages the three separate stages of the CSV import process. */ public function dispatch() { $this->header(); $step = empty( $_GET['step'] ) ? 0 : (int) $_GET['step']; switch ( $step ) { case 0: $this->greet(); break; case 1 : check_admin_referer( 'import-upload' ); if ( $this->handle_upload() ) { if ( $this->id ) { $file = get_attached_file( $this->id ); } else { $file = ABSPATH . $this->file_url; } $this->importer_mapping( $file ); } break; case 2 : check_admin_referer( 'woocommerce-csv-importer' ); $file = null; $this->id = isset( $_REQUEST['file_id'] ) ? absint( $_REQUEST['file_id'] ) : ''; $this->file_url = isset( $_REQUEST['file_url'] ) ? sanitize_text_field( $_REQUEST['file_url'] ) : ''; if ( $this->id ) { $file = get_attached_file( $this->id ); } elseif ( $this->file_url ) { $file = ABSPATH . $this->file_url; } $this->import( $file ); break; } $this->footer(); } /** * Import is starting. */ private function import_start() { if ( function_exists( 'gc_enable' ) ) { gc_enable(); } wc_set_time_limit( 0 ); @ob_flush(); @flush(); @ini_set( 'auto_detect_line_endings', '1' ); } /** * Import the file if it exists and is valid. * * @param mixed $file */ public function import( $file ) { if ( ! is_file( $file ) ) { $this->import_error( __( 'The file does not exist, please try again.', 'woocommerce' ) ); } $this->import_start(); $args = array( 'parse' => true ); if ( ! empty( $_POST['map_to'] ) ) { $args['mapping'] = wp_unslash( $_POST['map_to'] ); } $data = $this->read_csv( $file, $args ); // Show Result echo '

'; /* translators: %d: products count */ printf( __( 'Import complete - imported %s products.', 'woocommerce' ), '' . count( $data ) . '' ); echo '

'; $this->import_end(); } /** * Performs post-import cleanup of files and the cache. */ public function import_end() { echo '

' . __( 'All done!', 'woocommerce' ) . ' ' . __( 'View products', 'woocommerce' ) . '' . '

'; do_action( 'import_end' ); } /** * Handles the CSV upload and initial parsing of the file to prepare for. * displaying author import options. * * @return bool False if error uploading or invalid file, true otherwise */ public function handle_upload() { if ( empty( $_POST['file_url'] ) ) { $file = wp_import_handle_upload(); if ( isset( $file['error'] ) ) { $this->import_error( $file['error'] ); } $this->id = absint( $file['id'] ); } elseif ( file_exists( ABSPATH . $_POST['file_url'] ) ) { $this->file_url = esc_attr( $_POST['file_url'] ); } else { $this->import_error(); } return true; } /** * Read a CSV file. * * @param mixed $file * @param array $args See $default_args * @return array */ public function read_csv( $file, $args = array() ) { $default_args = array( 'start_pos' => 0, // File pointer start. 'end_pos' => -1, // File pointer end. 'lines' => -1, // Max lines to read. 'mapping' => array(), // Column mapping. csv_heading => schema_heading. 'parse' => false, // Whether to sanitize and format data. ); $args = wp_parse_args( $args, $default_args ); $data = array( 'raw_headers' => array(), 'data' => array(), ); if ( false !== ( $handle = fopen( $file, 'r' ) ) ) { $data['raw_headers'] = fgetcsv( $handle, 0, $this->delimiter ); if ( 0 !== $args['start_pos'] ) { fseek( $handle, (int) $args['start_pos'] ); } while ( false !== ( $row = fgetcsv( $handle, 0, $this->delimiter ) ) ) { $data['data'][] = $row; if ( ( $args['end_pos'] > 0 && ftell( $handle ) >= $args['end_pos'] ) || 0 === --$args['lines'] ) { break; } } } if ( ! empty( $args['mapping'] ) ) { $data = $this->map_headers( $data, $args['mapping'] ); } if ( $args['parse'] ) { $data = $this->parse_data( $data ); } return apply_filters( 'woocommerce_csv_product_import_data', $data, $file, $args ); } /** * Map raw headers to known headers. * * @param array $data * @param array $mapping 'raw column name' => 'schema column name' * @return array */ public function map_headers( $data, $mapping ) { $data['headers'] = array(); foreach ( $data['raw_headers'] as $heading ) { $data['headers'][] = isset( $mapping[ $heading ] ) ? $mapping[ $heading ] : $heading; } return $data; } /** * Map and format raw data to known fields. * * @param array $data * @return array */ public function parse_data( $data ) { /** * Columns not mentioned here will get parsed with 'esc_attr'. * column_name => callback. */ $data_formatting = array( 'id' => 'absint', 'status' => array( $this, 'parse_bool_field' ), 'featured' => array( $this, 'parse_bool_field' ), 'date_on_sale_from' => 'strtotime', 'date_on_sale_to' => 'strtotime', 'manage_stock' => array( $this, 'parse_bool_field' ), 'backorders' => array( $this, 'parse_bool_field' ), 'sold_individually' => array( $this, 'parse_bool_field' ), 'width' => array( $this, 'parse_float_field' ), 'length' => array( $this, 'parse_float_field' ), 'height' => array( $this, 'parse_float_field' ), 'width' => array( $this, 'parse_float_field' ), 'reviews_allowed' => array( $this, 'parse_bool_field' ), 'purchase_note' => 'wp_kses', 'price' => 'wc_format_decimal', 'regular_price' => 'wc_format_decimal', 'stock_quantity' => 'absint', 'category_ids' => array( $this, 'parse_categories' ), 'tag_ids' => array( $this, 'parse_comma_field' ), 'image_id' => 'absint', 'gallery_image_ids' => array( $this, 'parse_comma_field' ), 'upsell_ids' => array( $this, 'parse_comma_field' ), 'cross_sell_ids' => array( $this, 'parse_comma_field' ), 'download_limit' => 'absint', 'download_expiry' => 'absint', ); $regex_match_data_formatting = array( '/Attribute * Value\(s\)/' => array( $this, 'parse_comma_field' ), '/Attribute * Visible/' => array( $this, 'parse_bool_field' ), '/Download * URL/' => 'esc_url', ); $headers = ! empty( $data['headers'] ) ? $data['headers'] : $data['raw_headers']; $parse_functions = array(); $parsed_data = array(); // Figure out the parse function for each column. foreach ( $headers as $index => $heading ) { $parse_function = 'esc_attr'; if ( isset( $data_formatting[ $heading ] ) ) { $parse_function = $data_formatting[ $heading ]; } else { foreach ( $regex_match_data_formatting as $regex => $callback ) { if ( preg_match( $regex, $heading ) ) { $parse_function = $callback; break; } } } $parse_functions[] = $parse_function; } // Parse the data. foreach ( $data['data'] as $row ) { $item = array(); foreach ( $row as $index => $field ) { $item[ $headers[ $index ] ] = call_user_func( $parse_functions[ $index ], $field ); } $parsed_data[] = $item; } return apply_filters( 'woocommerce_csv_product_parsed_data', $parsed_data, $data ); } /** * Get default fields. * * @return array */ protected function get_default_fields() { $fields = array( 'id', 'type', 'sku', 'name', 'status', 'featured', 'catalog_visibility', 'short_description', 'description', 'date_on_sale_from', 'date_on_sale_to', 'tax_status', 'tax_class', 'stock_status', 'backorders', 'sold_individually', 'weight', 'length', 'width', 'height', 'reviews_allowed', 'purchase_note', 'price', 'regular_price', 'manage_stock', 'stock_quantity', 'category_ids', 'tag_ids', 'shipping_class_id', 'image_id', 'gallery_image_ids', 'downloads', 'download_limit', 'download_expiry', 'parent_id', 'upsell_ids', 'cross_sell_ids', ); return apply_filters( 'woocommerce_csv_product_default_fields', $fields ); } /** * Parse a comma-delineated field from a CSV. * * @param string $field * @return array */ public function parse_comma_field( $field ) { if ( empty( $field ) ) { return array(); } return array_map( 'esc_attr', array_map( 'trim', explode( ',', $field ) ) ); } /** * Parse a field that is generally '1' or '0' but can be something else. * * @param string $field * @return bool|string */ public function parse_bool_field( $field ) { if ( '0' === $field ) { return false; } if ( '1' === $field ) { return true; } // Don't return explicit true or false for empty fields or values like 'notify'. return esc_attr( $field ); } /** * Parse a float value field. * * @param string $field * @return float|string */ public function parse_float_field( $field ) { if ( '' === $field ) { return $field; } return floatval( $field ); } /** * Parse a category field from a CSV. * Categories are separated by commas and subcategories are "parent > subcategory". * * @param string $field * @return array of arrays with "parent" and "name" keys. */ public function parse_categories( $field ) { if ( empty( $field ) ) { return array(); } $sections = array_map( 'trim', explode( ',', $field ) ); $categories = array(); foreach ( $sections as $section ) { // Top level category. if ( false === strpos( $section, '>' ) ) { $categories[] = array( 'parent' => false, 'name' => esc_attr( $section ), ); // Subcategory. } else { $chunks = array_map( 'trim', explode( '>', $section ) ); $categories[] = array( 'parent' => esc_attr( reset( $chunks ) ), 'name' => esc_attr( end( $chunks ) ), ); } } return $categories; } /** * Output header html. */ public function header() { echo '
'; echo '

' . __( 'Import products', 'woocommerce' ) . '

'; } /** * Output footer html. */ public function footer() { echo '
'; } /** * Output information about the uploading process. */ public function greet() { echo '
'; echo '

' . __( 'Hi there! Upload a CSV file containing products to import them into your shop. Choose a .csv file to upload, then click "Upload file and import".', 'woocommerce' ) . '

'; $action = 'admin.php?import=woocommerce_product_csv&step=1'; $bytes = apply_filters( 'import_upload_size_limit', wp_max_upload_size() ); $size = size_format( $bytes ); $upload_dir = wp_upload_dir(); if ( ! empty( $upload_dir['error'] ) ) : ?>

'; } /** * Show import error and quit. * @param string $message */ private function import_error( $message = '' ) { echo '

' . __( 'Sorry, there has been an error.', 'woocommerce' ) . '
'; if ( $message ) { echo esc_html( $message ); } echo '

'; $this->footer(); die(); } /** * Get mapping options. * * @param string $item Item name * @return array */ protected function get_mapping_options( $item = '' ) { $weight_unit = get_option( 'woocommerce_weight_unit' ); $dimension_unit = get_option( 'woocommerce_dimension_unit' ); $options = array( 'id' => __( 'ID', 'woocommerce' ), 'type' => __( 'Type', 'woocommerce' ), 'sku' => __( 'SKU', 'woocommerce' ), 'name' => __( 'Name', 'woocommerce' ), 'status' => __( 'Published', 'woocommerce' ), 'featured' => __( 'Is featured?', 'woocommerce' ), 'catalog_visibility' => __( 'Visibility in catalog', 'woocommerce' ), 'short_description' => __( 'Short Description', 'woocommerce' ), 'description' => __( 'Description', 'woocommerce' ), 'date_on_sale_from' => __( 'Date sale price starts', 'woocommerce' ), 'date_on_sale_to' => __( 'Date sale price ends', 'woocommerce' ), 'tax_status' => __( 'Tax Status', 'woocommerce' ), 'tax_class' => __( 'Tax Class', 'woocommerce' ), 'stock_status' => __( 'In stock?', 'woocommerce' ), 'backorders' => __( 'Backorders allowed?', 'woocommerce' ), 'sold_individually' => __( 'Sold individually?', 'woocommerce' ), /* translators: %s: weight unit */ 'weight' => sprintf( __( 'Weight (%s)', 'woocommerce' ), $weight_unit ), /* translators: %s: dimension unit */ 'length' => sprintf( __( 'Length (%s)', 'woocommerce' ), $dimension_unit ), /* translators: %s: dimension unit */ 'width' => sprintf( __( 'Width (%s)', 'woocommerce' ), $dimension_unit ), /* translators: %s: dimension unit */ 'height' => sprintf( __( 'Height (%s)', 'woocommerce' ), $dimension_unit ), 'reviews_allowed' => __( 'Allow customer reviews?', 'woocommerce' ), 'purchase_note' => __( 'Purchase Note', 'woocommerce' ), 'price' => __( 'Price', 'woocommerce' ), 'regular_price' => __( 'Regular Price', 'woocommerce' ), 'manage_stock' => __( 'Manage stock?', 'woocommerce' ), 'stock_quantity' => __( 'Amount in stock', 'woocommerce' ), 'category_ids' => __( 'Categories', 'woocommerce' ), 'tag_ids' => __( 'Tags', 'woocommerce' ), 'shipping_class_id' => __( 'Shipping Class', 'woocommerce' ), 'attributes' => array( 'name' => __( 'Attributes', 'woocommerce' ), 'options' => array( 'attributes_name' => __( 'Attributes name', 'woocommerce' ), 'attributes_value' => __( 'Attributes value', 'woocommerce' ), 'default_attributes' => __( 'Default attribute', 'woocommerce' ), ), ), 'image_id' => __( 'Featured image', 'woocommerce' ), 'gallery_image_ids' => __( 'Gallery images', 'woocommerce' ), 'downloads' => __( 'Download Name:URL', 'woocommerce' ), 'download_limit' => __( 'Download Limit', 'woocommerce' ), 'download_expiry' => __( 'Download Expiry Days', 'woocommerce' ), 'parent_id' => __( 'Parent', 'woocommerce' ), 'upsell_ids' => __( 'Upsells', 'woocommerce' ), 'cross_sell_ids' => __( 'Cross-sells', 'woocommerce' ), 'meta:' . $item => __( 'Import as meta', 'woocommerce' ), ); return apply_filters( 'woocommerce_csv_product_import_mapping_options', $options. $item ); } /** * CSV mapping. * * @param string $file File path. */ protected function importer_mapping( $file ) { $data = $this->read_csv( $file, array( 'lines' => 1 ) ); $headers = $data['raw_headers']; $sample = $data['data'][0]; // Check if all fields matches. if ( 0 === count( array_diff( $headers, $this->get_default_fields() ) ) ) { $params = array( 'import' => $this->import_page, 'step' => 2, 'file_id' => $this->id, 'file_url' => $this->file_url, 'delimiter' => $this->delimiter, '_wpnonce' => wp_create_nonce( 'woocommerce-csv-importer' ), // wp_nonce_url() escapes & to & breaking redirects. ); wp_redirect( add_query_arg( $params, admin_url( 'admin.php' ) ) ); } include_once( dirname( __FILE__ ) . '/views/html-csv-mapping.php' ); } }