<?php
/**
* Batch Import Class
*
* This is the base class for all batch import methods. Each data import type (customers, payments, etc) extend this class
*
* @package EDD
* @subpackage Admin/Import
* @copyright Copyright (c) 2018, Easy Digital Downloads, LLC
* @license http://opensource.org/licenses/gpl-2.0.php GNU Public License
* @since 2.6
*/
// Exit if accessed directly
defined( 'ABSPATH' ) || exit;
/**
* EDD_Batch_Import Class
*
* @since 2.6
*/
class EDD_Batch_Import {
/**
* The file being imported
*
* @since 2.6
*/
public $file;
/**
* The parsed CSV file being imported
*
* @since 2.6
*/
public $csv;
/**
* Total rows in the CSV file
*
* @since 2.6
*/
public $total;
/**
* The current step being processed
*
* @since 2.6
*/
public $step;
/**
* The number of items to process per step
*
* @since 2.6
*/
public $per_step = 20;
/**
* The capability required to import data
*
* @since 2.6
*/
public $capability_type = 'manage_shop_settings';
/**
* Is the import file empty
*
* @since 2.6
*/
public $is_empty = false;
/**
* Map of CSV columns > database fields
*
* @since 2.6
*/
public $field_mapping = array();
/**
* Get things started
*
* @param $_step int The step to process
* @since 2.6
*/
public function __construct( $_file = '', $_step = 1 ) {
$this->step = $_step;
$this->file = $_file;
$this->done = false;
$this->csv = $this->get_csv_file( $this->file );
$this->total = count( $this->csv );
$this->init();
}
/**
* Initialize the updater. Runs after import file is loaded but before any processing is done.
*
* @since 2.6
* @return void
*/
public function init() {}
/**
* Can we import?
*
* @since 2.6
* @return bool Whether we can iport or not
*/
public function can_import() {
return (bool) apply_filters( 'edd_import_capability', current_user_can( $this->capability_type ) );
}
/**
* Parses the CSV from the file and returns the data as an array.
*
* @since 2.11.5
* @param string $file
*
* @return array
*/
public function get_csv_file( $file ) {
$csv = array_map( 'str_getcsv', file( $this->file ) );
array_walk(
$csv,
function ( &$a ) use ( $csv ) {
/*
* Make sure the two arrays have the same lengths.
* If not, we trim the larger array to match the smaller one.
*/
$min = min( count( $csv[0] ), count( $a ) );
$headers = array_slice( $csv[0], 0, $min );
$values = array_slice( $a, 0, $min );
$a = array_combine( $headers, $values );
}
);
array_shift( $csv );
return $csv;
}
/**
* Get the CSV columns
*
* @since 2.6
* @return array The columns in the CSV
*/
public function get_columns() {
$columns = array();
if ( isset( $this->csv[0] ) && is_array( $this->csv[0] ) ) {
$columns = array_keys( $this->csv[0] );
}
return $columns;
}
/**
* Get the first row of the CSV
*
* This is used for showing an example of what the import will look like
*
* @since 2.6
* @return array The first row after the header of the CSV
*/
public function get_first_row() {
if ( ! is_array( $this->csv ) ) {
return array();
}
return array_map( array( $this, 'trim_preview' ), current( $this->csv ) );
}
/**
* Process a step
*
* @since 2.6
* @return bool
*/
public function process_step() {
$more = false;
if ( ! $this->can_import() ) {
wp_die( __( 'You do not have permission to import data.', 'easy-digital-downloads' ), __( 'Error', 'easy-digital-downloads' ), array( 'response' => 403 ) );
}
return $more;
}
/**
* Return the calculated completion percentage
*
* @since 2.6
* @return int
*/
public function get_percentage_complete() {
return 100;
}
/**
* Map CSV columns to import fields
*
* @since 2.6
* @return void
*/
public function map_fields( $import_fields = array() ) {
$this->field_mapping = array_map( 'sanitize_text_field', $import_fields );
}
/**
* Retrieve the URL to the list table for the import data type
*
* @since 2.6
* @return string
*/
public function get_list_table_url() {}
/**
* Retrieve the label for the import type. Example: Payments
*
* @since 2.6
* @return string
*/
public function get_import_type_label() {}
/**
* Convert a string containing delimiters to an array
*
* @since 2.6
* @param $str Input string to convert to an array
* @return array
*/
public function str_to_array( $str = '' ) {
$array = array();
if( is_array( $str ) ) {
return array_map( 'trim', $str );
}
// Look for standard delimiters
if( false !== strpos( $str, '|' ) ) {
$delimiter = '|';
} elseif( false !== strpos( $str, ',' ) ) {
$delimiter = ',';
} elseif( false !== strpos( $str, ';' ) ) {
$delimiter = ';';
} elseif( false !== strpos( $str, '/' ) && ! filter_var( str_replace( ' ', '%20', $str ), FILTER_VALIDATE_URL ) && '/' !== substr( $str, 0, 1 ) ) {
$delimiter = '/';
}
if( ! empty( $delimiter ) ) {
$array = (array) explode( $delimiter, $str );
} else {
$array[] = $str;
}
return array_map( 'trim', $array );
}
/**
* Convert a files string containing delimiters to an array.
*
* This is identical to str_to_array() except it ignores all / characters.
*
* @since 2.9.20
* @param $str Input string to convert to an array
* @return array
*/
public function convert_file_string_to_array( $str = '' ) {
$array = array();
if( is_array( $str ) ) {
return array_map( 'trim', $str );
}
// Look for standard delimiters
if( false !== strpos( $str, '|' ) ) {
$delimiter = '|';
} elseif( false !== strpos( $str, ',' ) ) {
$delimiter = ',';
} elseif( false !== strpos( $str, ';' ) ) {
$delimiter = ';';
}
if( ! empty( $delimiter ) ) {
$array = (array) explode( $delimiter, $str );
} else {
$array[] = $str;
}
return array_map( 'trim', $array );
}
/**
* Trims a column value for preview
*
* @since 2.6
* @param $str Input string to trim down
* @return string
*/
public function trim_preview( $str = '' ) {
if( ! is_numeric( $str ) ) {
$long = strlen( $str ) >= 30;
$str = substr( $str, 0, 30 );
$str = $long ? $str . '...' : $str;
}
return $str;
}
}