Import export taxes. Closes #447.

This commit is contained in:
Mike Jolley 2012-09-10 12:26:26 +01:00
parent e10a29b3c0
commit 0fd46e7923
14 changed files with 639 additions and 15 deletions

View File

@ -0,0 +1,37 @@
<?php
/**
* Init/register importers for WooCommerce.
*
* @author WooThemes
* @category Admin
* @package WooCommerce/Admin/Importers
* @version 1.7.0
*/
register_importer( 'woocommerce_tax_rate_csv', __( 'WooCommerce Tax Rates (CSV)', 'woocommerce' ), __( 'Import <strong>tax rates</strong> to your store via a csv file.', 'woocommerce'), 'woocommerce_tax_rates_importer' );
/**
* woocommerce_tax_rates_importer function.
*
* @access public
* @return void
*/
function woocommerce_tax_rates_importer() {
// Load Importer API
require_once ABSPATH . 'wp-admin/includes/import.php';
if ( ! class_exists( 'WP_Importer' ) ) {
$class_wp_importer = ABSPATH . 'wp-admin/includes/class-wp-importer.php';
if ( file_exists( $class_wp_importer ) )
require $class_wp_importer;
}
// includes
require dirname( __FILE__ ) . '/tax-rates-importer.php';
// Dispatch
$WC_CSV_Tax_Rates_Import = new WC_CSV_Tax_Rates_Import();
$WC_CSV_Tax_Rates_Import->dispatch();
}

View File

@ -0,0 +1,2 @@
"country","state","postcode","class","label","rate","compound","shipping"
"US","FL","12345","","Florida tax","5.0000","0","1"
1 country state postcode class label rate compound shipping
2 US FL 12345 Florida tax 5.0000 0 1

View File

@ -0,0 +1,4 @@
"countries","class","label","rate","compound","shipping"
"GB","","VAT","20.0000","0","1"
"GB","reduced-rate","VAT","5.0000","0","1"
"GB","zero-rate","VAT","0.0000","0","1"
1 countries class label rate compound shipping
2 GB VAT 20.0000 0 1
3 GB reduced-rate VAT 5.0000 0 1
4 GB zero-rate VAT 0.0000 0 1

View File

@ -0,0 +1,350 @@
<?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
*/
if ( class_exists( 'WP_Importer' ) ) {
class WC_CSV_Tax_Rates_Import extends WP_Importer {
var $id;
var $file_url;
var $import_page;
var $delimiter;
var $posts = array();
var $imported;
var $skipped;
/**
* __construct function.
*
* @access public
* @return void
*/
public function __construct() {
$this->import_page = 'woocommerce_tax_rate_csv';
}
/**
* Registered callback function for the WordPress Importer
*
* Manages the three separate stages of the CSV import process
*/
function dispatch() {
$this->header();
if ( ! empty( $_POST['delimiter'] ) )
$this->delimiter = stripslashes( trim( $_POST['delimiter'] ) );
if ( ! $this->delimiter )
$this->delimiter = ',';
$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;
add_filter( 'http_request_timeout', array( &$this, 'bump_request_timeout' ) );
if ( function_exists( 'gc_enable' ) )
gc_enable();
@set_time_limit(0);
@ob_flush();
@flush();
$this->import( $file );
}
break;
}
$this->footer();
}
/**
* format_data_from_csv function.
*
* @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.
*
* @access public
* @param mixed $file
* @return void
*/
function import( $file ) {
global $woocommerce, $wpdb;
$this->imported = $this->skipped = 0;
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();
}
$new_rates = array();
if ( ( $handle = fopen( $file, "r" ) ) !== FALSE ) {
$header = fgetcsv( $handle, 0, $this->delimiter );
if ( sizeof( $header ) == 6 ) {
$rates = get_option( 'woocommerce_tax_rates' );
while ( ( $row = fgetcsv( $handle, 0, $this->delimiter ) ) !== FALSE ) {
$rate = array();
list( $rate['countries'], $rate['class'], $rate['label'], $rate['rate'], $rate['compound'], $rate['shipping'] ) = $row;
$parsed_countries = array();
$rate['countries'] = array_map( 'trim', explode( '|', $rate['countries'] ) );
foreach( $rate['countries'] as $country ) {
if ( strstr( $country, ':' ) ) {
list( $country, $state ) = array_map( 'trim', explode( ':', $country ) );
if ( ! isset( $parsed_countries[ $country ] ) )
$parsed_countries[ $country ] = array();
$parsed_countries[ $country ][] = $state;
} else {
if ( ! isset( $parsed_countries[ $country ] ) )
$parsed_countries[ $country ] = array();
$parsed_countries[ $country ][] = '*';
}
}
$rate['countries'] = $parsed_countries;
$rate['shipping'] = $rate['shipping'] ? 'yes' : 'no';
$rate['compound'] = $rate['compound'] ? 'yes' : 'no';
$new_rates[] = $rate;
unset( $rate, $row );
$this->imported++;
}
$rates = array_merge( $rates, $new_rates );
update_option( 'woocommerce_tax_rates', $rates );
} elseif ( sizeof( $header ) == 8 ) {
$rates = get_option( 'woocommerce_local_tax_rates' );
while ( ( $row = fgetcsv( $handle, 0, $this->delimiter ) ) !== FALSE ) {
$rate = array();
list( $rate['country'], $rate['state'], $rate['postcode'], $rate['class'], $rate['label'], $rate['rate'], $rate['compound'], $rate['shipping'] ) = $row;
if ( ! $rate['country'] || ! $rate['postcode'] || ! $rate['rate'] ) {
$this->skipped++;
continue;
}
$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'] ) );
$new_rates[] = $rate;
unset( $rate, $row );
$this->imported++;
}
$rates = array_merge( $rates, $new_rates );
update_option( 'woocommerce_local_tax_rates', $rates );
} else {
echo '<p><strong>' . __( 'Sorry, there has been an error.', 'woocommerce' ) . '</strong><br />';
echo __( 'The CSV is invalid.', 'woocommerce' ) . '</p>';
$this->footer();
die();
}
fclose( $handle );
}
// Show Result
echo '<div class="updated settings-error below-h2"><p>
'.sprintf( __('Import complete - imported <strong>%s</strong> tax rates and skipped <strong>%s</strong>.', 'woocommerce'), $this->imported, $this->skipped ).'
</p></div>';
$this->import_end();
}
/**
* Performs post-import cleanup of files and the cache
*/
function import_end() {
wp_cache_flush();
echo '<p>' . __( 'All done!', 'woocommerce' ) . ' <a href="' . admin_url('admin.php?page=woocommerce_settings&tab=tax') . '">' . __( 'View Tax Rates', 'woocommerce' ) . '</a>' . '</p>';
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
*/
function handle_upload() {
if ( empty( $_POST['file_url'] ) ) {
$file = wp_import_handle_upload();
if ( isset( $file['error'] ) ) {
echo '<p><strong>' . __( 'Sorry, there has been an error.', 'woocommerce' ) . '</strong><br />';
echo esc_html( $file['error'] ) . '</p>';
return false;
}
$this->id = (int) $file['id'];
} else {
if ( file_exists( ABSPATH . $_POST['file_url'] ) ) {
$this->file_url = esc_attr( $_POST['file_url'] );
} else {
echo '<p><strong>' . __( 'Sorry, there has been an error.', 'woocommerce' ) . '</strong></p>';
return false;
}
}
return true;
}
/**
* header function.
*
* @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.
*
* @access public
* @return void
*/
function footer() {
echo '</div>';
}
/**
* greet function.
*
* @access public
* @return void
*/
function greet() {
global $woocommerce;
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>';
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>';
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>';
$action = 'admin.php?import=woocommerce_tax_rate_csv&step=1';
$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;
echo '</div>';
}
/**
* Added to http_request_timeout filter to force timeout at 60 seconds during import
* @return int 60
*/
function bump_request_timeout() {
return 60;
}
}
}

View File

@ -0,0 +1,129 @@
<?php
/**
* WC_CSV_Exporter class.
*
* Takes any data and turns it into a CSV for output.
*
* @class WC_Cart
* @version 1.6.4
* @package WooCommerce/Classes
* @author WooThemes
*/
class WC_CSV_Exporter {
/**
* @var mixed
* @access private
*/
private $_csv = '';
/**
* @var string
* @access private
*/
private $_filename = '';
/**
* @var string
* @access private
*/
private $_output = true;
/**
* __construct function.
*
* @access public
* @param bool $output (default: true)
* @param mixed $filename
* @return void
*/
function __construct( $columns = array(), $output = true, $filename = '' ) {
$this->_csv = '';
$this->_filename = $filename ? $filename : 'export.csv';
if ( $this->_output = $output )
$this->start();
if ( $columns )
$this->set_columns( $columns );
}
function set_filename( $filename ) {
$this->_filename = $filename ? $filename : 'export.csv';
}
/**
* set_columns function.
*
* @access public
* @return void
*/
function set_columns( $columns = array() ) {
$this->add_row( $columns );
unset( $columns );
}
/**
* add_row function.
*
* @access public
* @return void
*/
function add_row( $row ) {
$row = implode( ',', array_map( array( &$this, 'wrap_column' ), $row ) ) . "\n";
if ( $this->_output )
fwrite( $this->_csv, $row );
else
$this->_csv += $row;
unset( $row );
}
/**
* start function.
*
* @access public
* @return void
*/
function start() {
if ( headers_sent() )
wp_die( 'Headers already sent' );
@set_time_limit(0);
@ob_clean();
header( "Content-Type: text/csv; charset=UTF-8" );
header( "Content-Disposition: attachment; filename={$this->_filename}" );
header( "Pragma: no-cache" );
header( "Expires: 0" );
$this->_csv = fopen( 'php://output', 'w') ;
}
/**
* end function.
*
* @access public
* @return void
*/
function end() {
fclose( $this->_csv );
exit;
}
/**
* wrap_column function.
*
* @access public
* @param mixed $data
* @return void
*/
function wrap_column( $data ) {
return '"' . str_replace( '"', '""', $data ) . '"';
}
}

View File

@ -16,17 +16,17 @@
*/
function woocommerce_tax_rates_setting() {
global $woocommerce;
woocommerce_export_tax_rates();
$tax_classes = array_filter(array_map('trim', explode("\n", get_option('woocommerce_tax_classes'))));
$tax_rates = get_option('woocommerce_tax_rates');
$local_tax_rates = get_option('woocommerce_local_tax_rates');
$tax_classes = array_filter( array_map( 'trim', explode( "\n", get_option( 'woocommerce_tax_classes' ) ) ) );
$tax_rates = get_option( 'woocommerce_tax_rates' );
$local_tax_rates = get_option( 'woocommerce_local_tax_rates' );
?><tr valign="top">
<th scope="row" class="titledesc"><?php _e('Tax Rates', 'woocommerce') ?></th>
<th scope="row" class="titledesc"><?php _e( 'Tax Rates', 'woocommerce' ) ?></th>
<td class="forminp">
<!--<a class="button export_rates"><?php _e('Export rates', 'woocommerce'); ?></a>
<a class="button import_rates"><?php _e('Import rates', 'woocommerce'); ?></a>
<p style="margin-top:0;" class="description"><?php printf(__('Define tax rates for countries and states below, or alternatively upload a CSV file containing your rates to <code>wp-content/woocommerce_tax_rates.csv</code> instead. <a href="%s">Download sample csv.</a>', 'woocommerce'), ''); ?></p>-->
<table class="taxrows widefat" cellspacing="0">
<thead>
<tr>
@ -41,10 +41,14 @@ function woocommerce_tax_rates_setting() {
</thead>
<tfoot>
<tr>
<th colspan="2"><a href="#" class="add_tax_rate button"><?php _e('+ Add Tax Rate', 'woocommerce'); ?></a></th>
<th colspan="2">
<a href="#" class="add_tax_rate button"><?php _e('+ Add Tax Rate', 'woocommerce'); ?></a>
</th>
<th colspan="6">
<small><?php _e('All matching rates will be applied, and non-compound rates will be summed.', 'woocommerce'); ?></small>
<a href="#" class="dupe button"><?php _e('Duplicate selected rows', 'woocommerce'); ?></a> <a href="#" class="remove button"><?php _e('Delete selected rows', 'woocommerce'); ?></a>
<a href="#" class="dupe button"><?php _e('Duplicate selected', 'woocommerce'); ?></a>
<a href="#" class="remove button"><?php _e('Delete selected', 'woocommerce'); ?></a>
</th>
</tr>
</tfoot>
@ -91,6 +95,12 @@ function woocommerce_tax_rates_setting() {
</tbody>
</table>
<a class="button export_rates" href="<?php echo add_query_arg( 'wc_export_tax_rates', 1 ); ?>"><?php _e('Export rates', 'woocommerce'); ?></a>
<a class="button import_rates" href="<?php echo admin_url( 'admin.php?import=woocommerce_tax_rate_csv' ); ?>"><?php _e('Import rates', 'woocommerce'); ?></a>
<p style="margin-top:8px;" class="description"><?php _e('Define tax rates for countries and states above. You can also import them from a CSV file.', 'woocommerce'); ?></p>
</td>
</tr>
<tr valign="top">
@ -158,6 +168,11 @@ function woocommerce_tax_rates_setting() {
</tbody>
</table>
<a class="button export_rates" href="<?php echo add_query_arg( 'wc_export_tax_rates', 2 ); ?>"><?php _e('Export rates', 'woocommerce'); ?></a>
<a class="button import_rates" href="<?php echo admin_url( 'admin.php?import=woocommerce_tax_rate_csv' ); ?>"><?php _e('Import rates', 'woocommerce'); ?></a>
<p style="margin-top:8px;" class="description"><?php _e('Define local tax rates for specific post/zip codes above. You can also import them from a CSV file.', 'woocommerce'); ?></p>
</td>
</tr>
@ -400,4 +415,80 @@ function woocommerce_tax_row_label( $selected ) {
endif;
return $return;
}
/**
* woocommerce_export_tax_rates function.
*
* @access public
* @return void
*/
function woocommerce_export_tax_rates() {
if ( empty( $_GET['wc_export_tax_rates'] ) )
return;
global $woocommerce;
if ( ! class_exists('WC_CSV_Exporter') )
include( $woocommerce->plugin_path() . '/admin/includes/class-wc-csv-exporter.php' );
$export = absint( $_GET['wc_export_tax_rates'] );
if ( $export == 1 ) {
$tax_rates = get_option('woocommerce_tax_rates');
$csv = new WC_CSV_Exporter( array( 'countries', 'class', 'label', 'rate', 'compound', 'shipping' ), true, 'tax_rates.csv' );
if ( $tax_rates )
foreach( $tax_rates as $rate ) {
$countries = array();
foreach ( $rate['countries'] as $country => $states ) {
foreach( $states as $state ) {
if ( $state == '*' ) {
$countries[] = $country;
} else {
$countries[] = $country . ':' . $state;
}
}
}
$csv->add_row( array(
implode( ' | ', $countries ),
$rate['class'],
$rate['label'],
$rate['rate'],
$rate['compound'] == 'yes' ? 1 : 0,
$rate['shipping'] == 'yes' ? 1 : 0
) );
}
$csv->end();
} else {
$tax_rates = get_option('woocommerce_local_tax_rates');
$csv = new WC_CSV_Exporter( array( 'country', 'state', 'postcode', 'class', 'label', 'rate', 'compound', 'shipping' ), true, 'local_tax_rates.csv' );
if ( $tax_rates )
foreach( $tax_rates as $rate ) {
$csv->add_row( array(
$rate['country'],
$rate['state'],
implode( ' | ', $rate['postcode'] ),
$rate['class'],
$rate['label'],
$rate['rate'],
$rate['compound'] == 'yes' ? 1 : 0,
$rate['shipping'] == 'yes' ? 1 : 0
) );
}
$csv->end();
}
}

View File

@ -374,9 +374,9 @@ function woocommerce_compile_less_styles() {
// Colours changed - recompile less
if ( ! class_exists( 'lessc' ) )
include_once('includes/lessc.inc.php');
include_once('includes/class-lessc.php');
if ( ! class_exists( 'cssmin' ) )
include_once('includes/cssmin.inc.php');
include_once('includes/class-cssmin.php');
try {
// Set default if colours not set

View File

@ -227,6 +227,11 @@ function woocommerce_admin_init() {
include_once( 'woocommerce-admin-users.php' );
}
// Register importers
if ( defined( 'WP_LOAD_IMPORTERS' ) ) {
include_once( 'importers/importers-init.php' );
}
}
add_action('admin_init', 'woocommerce_admin_init');

View File

@ -29,6 +29,8 @@ if ( ! function_exists( 'woocommerce_settings' ) ) {
*/
function woocommerce_settings() {
global $woocommerce, $woocommerce_settings;
do_action( 'woocommerce_settings_start' );
// Get current tab/section
$current_tab = ( empty( $_GET['tab'] ) ) ? 'general' : urldecode( $_GET['tab'] );

File diff suppressed because one or more lines are too long

View File

@ -1210,9 +1210,9 @@ mark.notice {
}
a.export_rates, a.import_rates {
float:right;
margin-left: 3px;
margin-top: -3px;
margin-bottom: 3px;
margin-left: 9px;
margin-top: 6px;
margin-bottom: 0;
}
.woocommerce table.shippingrows, .woocommerce table.taxrows {
td, th {
@ -1286,6 +1286,9 @@ a.export_rates, a.import_rates {
display: block;
}
}
td.rate {
white-space: nowrap;
}
}
table.wc_gateways, table.wc_shipping {
position: relative;

View File

@ -157,6 +157,7 @@ Yes you can! Join in on our [GitHub repository](http://github.com/woothemes/wooc
* Feature - Added wildcard support to local delivery postcodes
* Feature - Option to enable Cash on Delivery for select shipping methods only
* Feature - Stopped using PHP sessions for cart data - using cookies and transients instead to allow WC to function better with static caching. Also to reduce support regarding hosts and session configurations.
* Feature - Export and Import Tax Rates from a CSV file.
* Templating - email-order-items.php change get_downloadable_file_url() to get_downloadable_file_urls() to support multiple files