woocommerce/admin/importers/tax-rates-importer.php

351 lines
9.6 KiB
PHP
Raw Normal View History

2012-09-10 11:26:26 +00:00
<?php
/**
* Tax Rates importer - import tax rates and local tax rates into WooCommerce.
*
* @author WooThemes
* @category Admin
* @package WooCommerce/Admin/Importers
* @version 1.7.0
*/
2012-11-27 16:22:47 +00:00
2012-10-15 10:32:24 +00:00
if ( ! defined( 'ABSPATH' ) ) exit; // Exit if accessed directly
2012-09-10 11:26:26 +00:00
if ( class_exists( 'WP_Importer' ) ) {
class WC_CSV_Tax_Rates_Import extends WP_Importer {
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
var $id;
var $file_url;
var $import_page;
var $delimiter;
var $posts = array();
var $imported;
var $skipped;
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
/**
* __construct function.
2012-11-27 16:22:47 +00:00
*
2012-09-10 11:26:26 +00:00
* @access public
* @return void
*/
public function __construct() {
$this->import_page = 'woocommerce_tax_rate_csv';
}
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
/**
* Registered callback function for the WordPress Importer
*
* Manages the three separate stages of the CSV import process
*/
function dispatch() {
$this->header();
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
if ( ! empty( $_POST['delimiter'] ) )
$this->delimiter = stripslashes( trim( $_POST['delimiter'] ) );
2012-11-27 16:22:47 +00:00
if ( ! $this->delimiter )
2012-09-10 11:26:26 +00:00
$this->delimiter = ',';
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
$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;
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
add_filter( 'http_request_timeout', array( &$this, 'bump_request_timeout' ) );
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
if ( function_exists( 'gc_enable' ) )
gc_enable();
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
@set_time_limit(0);
@ob_flush();
@flush();
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
$this->import( $file );
}
break;
}
$this->footer();
}
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
/**
* format_data_from_csv function.
2012-11-27 16:22:47 +00:00
*
2012-09-10 11:26:26 +00:00
* @access public
* @param mixed $data
* @param mixed $enc
* @return void
*/
function format_data_from_csv( $data, $enc ) {
return ( $enc == 'UTF-8' ) ? $data : utf8_encode( $data );
}
/**
* import function.
2012-11-27 16:22:47 +00:00
*
2012-09-10 11:26:26 +00:00
* @access public
* @param mixed $file
* @return void
*/
function import( $file ) {
global $woocommerce, $wpdb;
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
$this->imported = $this->skipped = 0;
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
if ( ! is_file($file) ) {
echo '<p><strong>' . __( 'Sorry, there has been an error.', 'woocommerce' ) . '</strong><br />';
echo __( 'The file does not exist, please try again.', 'woocommerce' ) . '</p>';
$this->footer();
die();
}
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
$new_rates = array();
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
if ( ( $handle = fopen( $file, "r" ) ) !== FALSE ) {
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
$header = fgetcsv( $handle, 0, $this->delimiter );
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
if ( sizeof( $header ) == 6 ) {
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
$rates = get_option( 'woocommerce_tax_rates' );
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
while ( ( $row = fgetcsv( $handle, 0, $this->delimiter ) ) !== FALSE ) {
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
$rate = array();
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
list( $rate['countries'], $rate['class'], $rate['label'], $rate['rate'], $rate['compound'], $rate['shipping'] ) = $row;
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
$parsed_countries = array();
$rate['countries'] = array_map( 'trim', explode( '|', $rate['countries'] ) );
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
foreach( $rate['countries'] as $country ) {
if ( strstr( $country, ':' ) ) {
list( $country, $state ) = array_map( 'trim', explode( ':', $country ) );
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
if ( ! isset( $parsed_countries[ $country ] ) )
$parsed_countries[ $country ] = array();
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
$parsed_countries[ $country ][] = $state;
} else {
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
if ( ! isset( $parsed_countries[ $country ] ) )
$parsed_countries[ $country ] = array();
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
$parsed_countries[ $country ][] = '*';
}
}
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
$rate['countries'] = $parsed_countries;
$rate['shipping'] = $rate['shipping'] ? 'yes' : 'no';
$rate['compound'] = $rate['compound'] ? 'yes' : 'no';
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
$new_rates[] = $rate;
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
unset( $rate, $row );
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
$this->imported++;
}
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
$rates = array_merge( $rates, $new_rates );
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
update_option( 'woocommerce_tax_rates', $rates );
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
} elseif ( sizeof( $header ) == 8 ) {
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
$rates = get_option( 'woocommerce_local_tax_rates' );
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
while ( ( $row = fgetcsv( $handle, 0, $this->delimiter ) ) !== FALSE ) {
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
$rate = array();
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
list( $rate['country'], $rate['state'], $rate['postcode'], $rate['class'], $rate['label'], $rate['rate'], $rate['compound'], $rate['shipping'] ) = $row;
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
if ( ! $rate['country'] || ! $rate['postcode'] || ! $rate['rate'] ) {
$this->skipped++;
continue;
}
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
$rate['state'] = $rate['state'] ? $rate['state'] : '*';
$rate['shipping'] = $rate['shipping'] ? 'yes' : 'no';
$rate['compound'] = $rate['compound'] ? 'yes' : 'no';
$rate['postcode'] = array_map( 'trim', explode( '|', $rate['postcode'] ) );
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
$new_rates[] = $rate;
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
unset( $rate, $row );
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
$this->imported++;
}
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
$rates = array_merge( $rates, $new_rates );
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
update_option( 'woocommerce_local_tax_rates', $rates );
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
} else {
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
echo '<p><strong>' . __( 'Sorry, there has been an error.', 'woocommerce' ) . '</strong><br />';
echo __( 'The CSV is invalid.', 'woocommerce' ) . '</p>';
$this->footer();
die();
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
}
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
fclose( $handle );
}
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
// Show Result
echo '<div class="updated settings-error below-h2"><p>
2012-10-16 09:45:33 +00:00
'.sprintf( __( 'Import complete - imported <strong>%s</strong> tax rates and skipped <strong>%s</strong>.', 'woocommerce' ), $this->imported, $this->skipped ).'
2012-09-10 11:26:26 +00:00
</p></div>';
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
$this->import_end();
}
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
/**
* Performs post-import cleanup of files and the cache
*/
function import_end() {
echo '<p>' . __( 'All done!', 'woocommerce' ) . ' <a href="' . admin_url('admin.php?page=woocommerce_settings&tab=tax') . '">' . __( 'View Tax Rates', 'woocommerce' ) . '</a>' . '</p>';
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
do_action( 'import_end' );
}
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
/**
* 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
*/
function handle_upload() {
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
if ( empty( $_POST['file_url'] ) ) {
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
$file = wp_import_handle_upload();
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
if ( isset( $file['error'] ) ) {
echo '<p><strong>' . __( 'Sorry, there has been an error.', 'woocommerce' ) . '</strong><br />';
echo esc_html( $file['error'] ) . '</p>';
return false;
}
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
$this->id = (int) $file['id'];
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
} else {
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
if ( file_exists( ABSPATH . $_POST['file_url'] ) ) {
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
$this->file_url = esc_attr( $_POST['file_url'] );
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
} else {
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
echo '<p><strong>' . __( 'Sorry, there has been an error.', 'woocommerce' ) . '</strong></p>';
return false;
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
}
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
}
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
return true;
}
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
/**
* header function.
2012-11-27 16:22:47 +00:00
*
2012-09-10 11:26:26 +00:00
* @access public
* @return void
*/
function header() {
echo '<div class="wrap"><div class="icon32" id="icon-woocommerce-importer"><br></div>';
echo '<h2>' . __( 'Import Tax Rates', 'woocommerce' ) . '</h2>';
}
/**
* footer function.
2012-11-27 16:22:47 +00:00
*
2012-09-10 11:26:26 +00:00
* @access public
* @return void
*/
function footer() {
echo '</div>';
}
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
/**
* greet function.
2012-11-27 16:22:47 +00:00
*
2012-09-10 11:26:26 +00:00
* @access public
* @return void
*/
function greet() {
global $woocommerce;
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
echo '<div class="narrow">';
echo '<p>' . __( 'Hi there! Upload a CSV file containing tax rates to import the contents into your shop. Choose a .csv file to upload, then click "Upload file and import".', 'woocommerce' ).'</p>';
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
echo '<p>' . sprintf( __( 'Tax rates need to be defined with columns in a specific order (6 columns). <a href="%s">Click here to download a sample</a>.', 'woocommerce' ), $woocommerce->plugin_url() . '/admin/importers/samples/sample_tax_rates.csv' ) . '</p>';
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
echo '<p>' . sprintf( __( 'Local tax rates also need to be defined with columns in a specific order (8 columns). <a href="%s">Click here to download a sample</a>.', 'woocommerce' ), $woocommerce->plugin_url() . '/admin/importers/samples/sample_local_tax_rates.csv' ) . '</p>';
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
$action = 'admin.php?import=woocommerce_tax_rate_csv&step=1';
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
$bytes = apply_filters( 'import_upload_size_limit', wp_max_upload_size() );
$size = wp_convert_bytes_to_hr( $bytes );
$upload_dir = wp_upload_dir();
if ( ! empty( $upload_dir['error'] ) ) :
?><div class="error"><p><?php _e('Before you can upload your import file, you will need to fix the following error:'); ?></p>
<p><strong><?php echo $upload_dir['error']; ?></strong></p></div><?php
else :
?>
<form enctype="multipart/form-data" id="import-upload-form" method="post" action="<?php echo esc_attr(wp_nonce_url($action, 'import-upload')); ?>">
<table class="form-table">
<tbody>
<tr>
<th>
<label for="upload"><?php _e( 'Choose a file from your computer:' ); ?></label>
</th>
<td>
<input type="file" id="upload" name="import" size="25" />
<input type="hidden" name="action" value="save" />
<input type="hidden" name="max_file_size" value="<?php echo $bytes; ?>" />
<small><?php printf( __('Maximum size: %s' ), $size ); ?></small>
</td>
</tr>
<tr>
<th>
<label for="file_url"><?php _e( 'OR enter path to file:', 'woocommerce' ); ?></label>
</th>
<td>
<?php echo ' ' . ABSPATH . ' '; ?><input type="text" id="file_url" name="file_url" size="25" />
</td>
</tr>
<tr>
<th><label><?php _e( 'Delimiter', 'woocommerce' ); ?></label><br/></th>
<td><input type="text" name="delimiter" placeholder="," size="2" /></td>
</tr>
</tbody>
</table>
<p class="submit">
<input type="submit" class="button" value="<?php esc_attr_e( 'Upload file and import' ); ?>" />
</p>
</form>
<?php
endif;
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
echo '</div>';
}
2012-11-27 16:22:47 +00:00
2012-09-10 11:26:26 +00:00
/**
* Added to http_request_timeout filter to force timeout at 60 seconds during import
* @return int 60
*/
function bump_request_timeout() {
return 60;
}
}
}