<?php
/**
* Download import class
*
* This class handles importing downloads with the batch processing API
*
* @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_Downloads_Import Class
*
* @since 2.6
*/
class EDD_Batch_Downloads_Import extends EDD_Batch_Import {
/**
* Set up our import config.
*
* @since 2.6
* @return void
*/
public function init() {
// Set up default field map values
$this->field_mapping = array(
'post_title' => '',
'post_name' => '',
'post_status' => 'draft',
'post_author' => '',
'post_date' => '',
'post_content' => '',
'post_excerpt' => '',
'price' => '',
'files' => '',
'categories' => '',
'tags' => '',
'sku' => '',
'earnings' => '',
'sales' => '',
'featured_image' => '',
'download_limit' => '',
'notes' => ''
);
}
/**
* 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 ) );
}
$i = 1;
$offset = $this->step > 1 ? ( $this->per_step * ( $this->step - 1 ) ) : 0;
if( $offset > $this->total ) {
$this->done = true;
// Delete the uploaded CSV file.
unlink( $this->file );
}
if( ! $this->done && $this->csv ) {
$more = true;
foreach( $this->csv as $key => $row ) {
// Skip all rows until we pass our offset
if( $key + 1 <= $offset ) {
continue;
}
// Done with this batch
if( $i > $this->per_step ) {
break;
}
// Import Download
$args = array(
'post_type' => 'download',
'post_title' => '',
'post_name' => '',
'post_status' => '',
'post_author' => '',
'post_date' => '',
'post_content' => '',
'post_excerpt' => ''
);
foreach ( $args as $key => $field ) {
if ( ! empty( $this->field_mapping[ $key ] ) && ! empty( $row[ $this->field_mapping[ $key ] ] ) ) {
$args[ $key ] = $row[ $this->field_mapping[ $key ] ];
}
}
if ( empty( $args['post_author'] ) ) {
$user = wp_get_current_user();
$args['post_author'] = $user->ID;
} else {
// Check all forms of possible user inputs, email, ID, login.
if ( is_email( $args['post_author'] ) ) {
$user = get_user_by( 'email', $args['post_author'] );
} elseif ( is_numeric( $args['post_author'] ) ) {
$user = get_user_by( 'ID', $args['post_author'] );
} else {
$user = get_user_by( 'login', $args['post_author'] );
}
// If we don't find one, resort to the logged in user.
if ( false === $user ) {
$user = wp_get_current_user();
}
$args['post_author'] = $user->ID;
}
// Format the date properly
if ( ! empty( $args['post_date'] ) ) {
$timestamp = strtotime( $args['post_date'], current_time( 'timestamp' ) );
$date = date( 'Y-m-d H:i:s', $timestamp );
// If the date provided results in a date string, use it, or just default to today so it imports
if ( ! empty( $date ) ) {
$args['post_date'] = $date;
} else {
$date = '';
}
}
// Detect any status that could map to `publish`
if ( ! empty( $args['post_status'] ) ) {
$published_statuses = array(
'live',
'published',
);
$current_status = strtolower( $args['post_status'] );
if ( in_array( $current_status, $published_statuses ) ) {
$args['post_status'] = 'publish';
}
}
$download_id = wp_insert_post( $args );
// setup categories
if( ! empty( $this->field_mapping['categories'] ) && ! empty( $row[ $this->field_mapping['categories'] ] ) ) {
$categories = $this->str_to_array( $row[ $this->field_mapping['categories'] ] );
$this->set_taxonomy_terms( $download_id, $categories, 'download_category' );
}
// setup tags
if( ! empty( $this->field_mapping['tags'] ) && ! empty( $row[ $this->field_mapping['tags'] ] ) ) {
$tags = $this->str_to_array( $row[ $this->field_mapping['tags'] ] );
$this->set_taxonomy_terms( $download_id, $tags, 'download_tag' );
}
// setup price(s)
if( ! empty( $this->field_mapping['price'] ) && ! empty( $row[ $this->field_mapping['price'] ] ) ) {
$price = $row[ $this->field_mapping['price'] ];
$this->set_price( $download_id, $price );
}
// setup files
if( ! empty( $this->field_mapping['files'] ) && ! empty( $row[ $this->field_mapping['files'] ] ) ) {
$files = $this->convert_file_string_to_array( $row[ $this->field_mapping['files'] ] );
$this->set_files( $download_id, $files );
}
// Product Image
if( ! empty( $this->field_mapping['featured_image'] ) && ! empty( $row[ $this->field_mapping['featured_image'] ] ) ) {
$image = sanitize_text_field( $row[ $this->field_mapping['featured_image'] ] );
$this->set_image( $download_id, $image, $args['post_author'] );
}
// File download limit
if( ! empty( $this->field_mapping['download_limit'] ) && ! empty( $row[ $this->field_mapping['download_limit'] ] ) ) {
update_post_meta( $download_id, '_edd_download_limit', absint( $row[ $this->field_mapping['download_limit'] ] ) );
}
// Sale count
if( ! empty( $this->field_mapping['sales'] ) && ! empty( $row[ $this->field_mapping['sales'] ] ) ) {
update_post_meta( $download_id, '_edd_download_sales', absint( $row[ $this->field_mapping['sales'] ] ) );
}
// Earnings
if( ! empty( $this->field_mapping['earnings'] ) && ! empty( $row[ $this->field_mapping['earnings'] ] ) ) {
update_post_meta( $download_id, '_edd_download_earnings', edd_sanitize_amount( $row[ $this->field_mapping['earnings'] ] ) );
}
// Notes
if( ! empty( $this->field_mapping['notes'] ) && ! empty( $row[ $this->field_mapping['notes'] ] ) ) {
update_post_meta( $download_id, 'edd_product_notes', sanitize_text_field( $row[ $this->field_mapping['notes'] ] ) );
}
// SKU
if( ! empty( $this->field_mapping[ 'sku' ] ) && ! empty( $row[ $this->field_mapping[ 'sku' ] ] ) ) {
update_post_meta( $download_id, 'edd_sku', sanitize_text_field( $row[ $this->field_mapping['sku'] ] ) );
}
// Custom fields
$i++;
}
}
return $more;
}
/**
* Return the calculated completion percentage
*
* @since 2.6
* @return int
*/
public function get_percentage_complete() {
if( $this->total > 0 ) {
$percentage = ( $this->step * $this->per_step / $this->total ) * 100;
}
if( $percentage > 100 ) {
$percentage = 100;
}
return $percentage;
}
/**
* Set up and store the price for the download
*
* @since 2.6
* @return void
*/
private function set_price( $download_id = 0, $price = '' ) {
if( is_numeric( $price ) ) {
update_post_meta( $download_id, 'edd_price', edd_sanitize_amount( $price ) );
} else {
$prices = $this->str_to_array( $price );
if( ! empty( $prices ) ) {
$variable_prices = array();
$price_id = 1;
foreach( $prices as $price ) {
// See if this matches the EDD Download export for variable prices
if( false !== strpos( $price, ':' ) ) {
$price = array_map( 'trim', explode( ':', $price ) );
$variable_prices[ $price_id ] = array( 'name' => $price[ 0 ], 'amount' => $price[ 1 ] );
$price_id++;
}
}
update_post_meta( $download_id, '_variable_pricing', 1 );
update_post_meta( $download_id, 'edd_variable_prices', $variable_prices );
}
}
}
/**
* Set up and store the file downloads
*
* @since 2.6
* @return void
*/
private function set_files( $download_id = 0, $files = array() ) {
if( ! empty( $files ) ) {
$download_files = array();
$file_id = 1;
foreach( $files as $file ) {
$condition = '';
if ( false !== strpos( $file, ';' ) ) {
$split_on = strpos( $file, ';' );
$file_url = substr( $file, 0, $split_on );
$condition = substr( $file, $split_on + 1 );
} else {
$file_url = $file;
}
$download_file_args = array(
'index' => $file_id,
'file' => $file_url,
'name' => basename( $file_url ),
'condition' => empty( $condition ) ? 'all' : $condition
);
$download_files[ $file_id ] = $download_file_args;
$file_id++;
}
update_post_meta( $download_id, 'edd_download_files', $download_files );
}
}
/**
* Set up and store the Featured Image
*
* @since 2.6
* @return void
*/
private function set_image( $download_id = 0, $image = '', $post_author = 0 ) {
$is_url = false !== filter_var( $image, FILTER_VALIDATE_URL );
$is_local = $is_url && false !== strpos( site_url(), $image );
$ext = edd_get_file_extension( $image );
if( $is_url && $is_local ) {
// Image given by URL, see if we have an attachment already
$attachment_id = attachment_url_to_postid( $image );
} elseif( $is_url ) {
if( ! function_exists( 'media_sideload_image' ) ) {
require_once( ABSPATH . 'wp-admin/includes/file.php' );
}
// Image given by external URL
$url = media_sideload_image( $image, $download_id, '', 'src' );
if( ! is_wp_error( $url ) ) {
$attachment_id = attachment_url_to_postid( $url );
}
} elseif( false === strpos( $image, '/' ) && edd_get_file_extension( $image ) ) {
// Image given by name only
$upload_dir = wp_upload_dir();
if( file_exists( trailingslashit( $upload_dir['path'] ) . $image ) ) {
// Look in current upload directory first
$file = trailingslashit( $upload_dir['path'] ) . $image;
} else {
// Now look through year/month sub folders of upload directory for files with our image's same extension
$files = glob( $upload_dir['basedir'] . '/*/*/*' . $ext );
foreach( $files as $file ) {
if( basename( $file ) == $image ) {
// Found our file
break;
}
// Make sure $file is unset so our empty check below does not return a false positive
unset( $file );
}
}
if( ! empty( $file ) ) {
// We found the file, let's see if it already exists in the media library
$guid = str_replace( $upload_dir['basedir'], $upload_dir['baseurl'], $file );
$attachment_id = attachment_url_to_postid( $guid );
if( empty( $attachment_id ) ) {
// Doesn't exist in the media library, let's add it
$filetype = wp_check_filetype( basename( $file ), null );
// Prepare an array of post data for the attachment.
$attachment = array(
'guid' => $guid,
'post_mime_type' => $filetype['type'],
'post_title' => preg_replace( '/\.[^.]+$/', '', $image ),
'post_content' => '',
'post_status' => 'inherit',
'post_author' => $post_author
);
// Insert the attachment.
$attachment_id = wp_insert_attachment( $attachment, $file, $download_id );
// Make sure that this file is included, as wp_generate_attachment_metadata() depends on it.
require_once( ABSPATH . 'wp-admin/includes/image.php' );
// Generate the metadata for the attachment, and update the database record.
$attach_data = wp_generate_attachment_metadata( $attachment_id, $file );
wp_update_attachment_metadata( $attachment_id, $attach_data );
}
}
}
if( ! empty( $attachment_id ) ) {
return set_post_thumbnail( $download_id, $attachment_id );
}
return false;
}
/**
* Set up and taxonomy terms
*
* @since 2.6
* @return void
*/
private function set_taxonomy_terms( $download_id = 0, $terms = array(), $taxonomy = 'download_category' ) {
$terms = $this->maybe_create_terms( $terms, $taxonomy );
if( ! empty( $terms ) ) {
wp_set_object_terms( $download_id, $terms, $taxonomy );
}
}
/**
* Locate term IDs or create terms if none are found
*
* @since 2.6
* @return array
*/
private function maybe_create_terms( $terms = array(), $taxonomy = 'download_category' ) {
// Return of term IDs
$term_ids = array();
foreach( $terms as $term ) {
if( is_numeric( $term ) && 0 === (int) $term ) {
$t = get_term( $term, $taxonomy );
} else {
$t = get_term_by( 'name', $term, $taxonomy );
if( ! $t ) {
$t = get_term_by( 'slug', $term, $taxonomy );
}
}
if( ! empty( $t ) ) {
$term_ids[] = $t->term_id;
} else {
$term_data = wp_insert_term( $term, $taxonomy, array( 'slug' => sanitize_title( $term ) ) );
if( ! is_wp_error( $term_data ) ) {
$term_ids[] = $term_data['term_id'];
}
}
}
return array_map( 'absint', $term_ids );
}
/**
* Retrieve URL to Downloads list table
*
* @since 2.6
* @return string
*/
public function get_list_table_url() {
return edd_get_admin_base_url();
}
/**
* Retrieve Download label
*
* @since 2.6
* @return void
*/
public function get_import_type_label() {
return edd_get_label_plural( true );
}
}