woocommerce-customer-order-csv-export.php
19.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
<?php
/**
* Plugin Name: WooCommerce Customer/Order CSV Export
* Plugin URI: http://www.woothemes.com/products/ordercustomer-csv-export/
* Description: Easily download customers & orders in CSV format and automatically export FTP or HTTP POST on a recurring schedule
* Author: WooThemes / SkyVerge
* Author URI: http://www.woothemes.com
* Version: 3.12.1
* Text Domain: woocommerce-customer-order-csv-export
* Domain Path: /i18n/languages/
*
* Copyright: (c) 2012-2016 SkyVerge (info@skyverge.com)
*
* License: GNU General Public License v3.0
* License URI: http://www.gnu.org/licenses/gpl-3.0.html
*
* @package WC-Customer-Order-CSV-Export
* @author SkyVerge
* @category Export
* @copyright Copyright (c) 2012-2016, SkyVerge, Inc.
* @license http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0
*/
defined( 'ABSPATH' ) or exit;
// Required functions
if ( ! function_exists( 'woothemes_queue_update' ) ) {
require_once( plugin_dir_path( __FILE__ ) . 'woo-includes/woo-functions.php' );
}
// Plugin updates
woothemes_queue_update( plugin_basename( __FILE__ ), '914de15813a903c767b55445608bf290', '18652' );
// WC active check
if ( ! is_woocommerce_active() ) {
return;
}
// Required library class
if ( ! class_exists( 'SV_WC_Framework_Bootstrap' ) ) {
require_once( plugin_dir_path( __FILE__ ) . 'lib/skyverge/woocommerce/class-sv-wc-framework-bootstrap.php' );
}
SV_WC_Framework_Bootstrap::instance()->register_plugin( '4.4.0', __( 'WooCommerce Customer/Order CSV Export', 'woocommerce-customer-order-csv-export' ), __FILE__, 'init_woocommerce_customer_order_csv_export', array(
'minimum_wc_version' => '2.4.13',
'minimum_wp_version' => '4.1',
'backwards_compatible' => '4.4.0',
) );
function init_woocommerce_customer_order_csv_export() {
/**
* # WooCommerce Customer/Order CSV Export
*
* ## Plugin Overview
*
* This plugin exports customers and orders in CSV format. Customers can be exported via
* CSV Export > Export and are selected from orders in a selectable date range. Orders can be
* exported in bulk from CSV Export > Export and from the Orders / Edit Order screen, as well as auto-exported
* via FTP and HTTP POST on a recurring schedule.
*
* ## Class Description
*
* The main class for Customer/Order CSV Export. This class handles general lifecycle and setup functions, as well
* as marking new orders as un-exported and handling the AJAX export action on the Order screen.
*
* ## Admin Considerations
*
* A 'CSV Export' sub-menu item is added under 'WooCommerce', with two tabs: 'Export' for handling bulk exports of
* both customers and orders, and 'Settings' which define the output format for both customers and orders, as well as
* auto-export interval & FTP/HTTP POST settings.
*
* An 'Export Status' column is added to the Orders list table, along with a new order action icon for downloading the order
* to a CSV. Another order action is added to the Edit Order screen under the order actions select box.
*
* ## Database
*
* ### Options Table
*
* + `wc_customer_order_csv_export_order_format` - order export format
* + `wc_customer_order_csv_export_customer_format` - customer export format
* + `wc_customer_order_csv_export_order_filename` - filename used for order exports
* + `wc_customer_order_csv_export_customer_filename` - filename used for customer exports
* + `wc_customer_order_csv_export_auto_export_method` - export method for auto-exports, defaults to 'disabled'
* + `wc_customer_order_csv_export_auto_export_interval` - export interval for auto-exports, in minutes
* + `wc_customer_order_csv_export_auto_export_statuses` - array of order statuses that are valid for auto-export
* + `wc_customer_order_csv_export_ftp_server` - FTP server
* + `wc_customer_order_csv_export_ftp_username` - FTP username
* + `wc_customer_order_csv_export_ftp_password` - FTP password
* + `wc_customer_order_csv_export_ftp_port` - FTP port
* + `wc_customer_order_csv_export_ftp_path` - FTP initial path
* + `wc_customer_order_csv_export_ftp_security` - type of FTP security, e.g. 'sftp'
* + `wc_customer_order_csv_export_passive_mode` - whether to enable passive mode for FTP connections
* + `wc_customer_order_csv_export_http_post_url` - the URL to POST exported CSV data to, when HTTP POST is enabled as a method
* + `wc_customer_order_csv_export_version` the plugin version, set on install & upgrade
*
* ### Order Meta
*
* + `_wc_customer_order_csv_export_is_exported` - bool, indicates if an order has been auto-exported or not, set on post insert
* ## Cron
*
* + `wc_customer_order_csv_export_auto_export_interval` - custom interval for auto-export action
* + `wc_customer_order_csv_export_auto_export_orders` - custom hook for auto-exporting orders
*
*/
class WC_Customer_Order_CSV_Export extends SV_WC_Plugin {
/** plugin version number */
const VERSION = '3.12.1';
/** @var WC_Customer_Order_CSV_Export single instance of this plugin */
protected static $instance;
/** plugin id */
const PLUGIN_ID = 'customer_order_csv_export';
/** plugin text domain, DEPRECATED as of 3.11.0 */
const TEXT_DOMAIN = 'woocommerce-customer-order-csv-export';
/** @var \WC_Customer_Order_CSV_Export_Admin instance */
protected $admin;
/** @var \WC_Customer_Order_CSV_Export_Compatibility instance */
protected $compatibility;
/** @var \WC_Customer_Order_CSV_Export_Cron instance */
protected $cron;
/**
* Setup main plugin class
*
* @since 3.0
* @return \WC_Customer_Order_CSV_Export
*/
public function __construct() {
parent::__construct( self::PLUGIN_ID, self::VERSION );
// required files
$this->includes();
// Set orders as not-exported when created
add_action( 'wp_insert_post', array( $this, 'mark_order_not_exported' ), 10, 2 );
// Admin
if ( is_admin() ) {
// handle single order CSV export download from order action button
add_action( 'wp_ajax_wc_customer_order_csv_export_export_order', array( $this, 'process_ajax_export_order' ) );
if ( ! is_ajax() ) {
$this->admin_includes();
}
}
// Subscriptions support
if ( $this->is_plugin_active( 'woocommerce-subscriptions.php' ) ) {
if ( SV_WC_Plugin_Compatibility::is_wc_subscriptions_version_gte_2_0() ) {
// Prevent that new subscription renewal orders from being automatically marked as 'exported'
add_filter( 'wcs_subscription_meta', array( $this, 'subscriptions_remove_subscription_order_meta' ), 10, 3 );
add_filter( 'wcs_upgrade_subscription_meta_to_copy', array( $this, 'subscriptions_remove_subscription_order_meta_during_upgrade' ) );
add_filter( 'wcs_renewal_order_meta', array( $this, 'subscriptions_remove_renewal_order_meta' ) );
}
}
// clear scheduled events on deactivation
register_deactivation_hook( $this->get_file(), array( $this->get_cron_instance(), 'clear_scheduled_export' ) );
}
/**
* Set each new order as not exported. This is done because querying orders that have a specific meta key / value
* is much more reliable than querying orders that don't have a specific meta key / value AND prevents accidental
* export of a massive set of old orders on first run
*
* @since 3.0
* @param int $post_id new order ID
* @param object $post the post object
*/
public function mark_order_not_exported( $post_id, $post ) {
if ( 'shop_order' == $post->post_type ) {
// force unique, because oddly this can be invoked when changing the status of an existing order
add_post_meta( $post_id, '_wc_customer_order_csv_export_is_exported', 0, true );
}
}
/**
* Downloads order in CSV format (from order action button on 'Orders' page)
*
* @since 3.0
*/
public function process_ajax_export_order() {
if ( ! is_admin() || ! current_user_can( 'edit_posts' ) ) {
wp_die( __( 'You do not have sufficient permissions to access this page.', 'woocommerce-customer-order-csv-export' ) );
}
if ( ! check_admin_referer( 'wc_customer_order_csv_export_export_order' ) ) {
wp_die( __( 'You have taken too long, please go back and try again.', 'woocommerce-customer-order-csv-export' ) );
}
$order_id = ! empty( $_GET['order_id'] ) ? absint( $_GET['order_id'] ) : '';
if ( ! $order_id ) {
die;
}
$export = new WC_Customer_Order_CSV_Export_Handler( $order_id );
$export->download();
wp_redirect( wp_get_referer() );
exit;
}
/**
* Includes required classes
*
* @since 3.0
*/
public function includes() {
// handles exporting / uploading / emailing
require_once( $this->get_plugin_path() . '/includes/class-wc-customer-order-csv-export-handler.php' );
require_once( $this->get_plugin_path() . '/includes/export-methods/interface-wc-customer-order-csv-export-method.php' );
// handles generating CSV
require_once( $this->get_plugin_path() . '/includes/class-wc-customer-order-csv-export-generator.php' );
// compatibility for legacy export formats and other extensions
$this->compatibility = $this->load_class( '/includes/class-wc-customer-order-csv-export-compatibility.php', 'WC_Customer_Order_CSV_Export_Compatibility' );
// handles scheduling and execution of automatic export / upload
$this->cron = $this->load_class( '/includes/class-wc-customer-order-csv-export-cron.php', 'WC_Customer_Order_CSV_Export_Cron' );
}
/**
* Loads the Admin & AJAX classes
*
* @since 3.0
*/
public function admin_includes() {
// loads the admin settings page and adds functionality to the order admin
$this->admin = $this->load_class( '/includes/admin/class-wc-customer-order-csv-export-admin.php', 'WC_Customer_Order_CSV_Export_Admin' );
// message handler
$this->admin->message_handler = $this->get_message_handler();
}
/**
* Return admin class instance
*
* @since 3.12.0
* @return \WC_Customer_Order_CSV_Export_Admin
*/
public function get_admin_instance() {
return $this->admin;
}
/**
* Return compatibility class instance
*
* @since 3.12.0
* @return \WC_Customer_Order_CSV_Export_Compatibility
*/
public function get_compatibility_instance() {
return $this->compatibility;
}
/**
* Return cron class instance
*
* @since 3.12.0
* @return \WC_Customer_Order_CSV_Export_Cron
*/
public function get_cron_instance() {
return $this->cron;
}
/**
* Backwards compat for changing the visibility of admin instance.
*
* @TODO Remove this as part of WC 2.7 compat {IT 2016-05-19}
*
* @since 3.12.0
*/
public function __get( $name ) {
switch ( $name ) {
case 'admin':
/* @deprecated since 3.12.0 */
_deprecated_function( 'wc_customer_order_csv_export()->admin', '3.12.0', 'wc_customer_order_csv_export()->get_admin_instance()' );
return $this->get_admin_instance();
case 'compatibility':
/* @deprecated since 3.12.0 */
_deprecated_function( 'wc_customer_order_csv_export()->compatibility', '3.12.0', 'wc_customer_order_csv_export()->get_compatibility_instance()' );
return $this->get_compatibility_instance();
case 'cron':
/* @deprecated since 3.12.0 */
_deprecated_function( 'wc_customer_order_csv_export()->cron', '3.12.0', 'wc_customer_order_csv_export()->get_cron_instance()' );
return $this->get_cron_instance();
}
// you're probably doing it wrong
trigger_error( 'Call to undefined property ' . __CLASS__ . '::' . $name, E_USER_ERROR );
return null;
}
/**
* Load plugin text domain.
*
* @since 3.0
* @see SV_WC_Plugin::load_translation()
*/
public function load_translation() {
load_plugin_textdomain( 'woocommerce-customer-order-csv-export', false, dirname( plugin_basename( $this->get_file() ) ) . '/i18n/languages' );
}
/** Admin Methods ******************************************************/
/**
* Render a notice for the user to select their desired export format
*
* @since 3.4.0
* @see SV_WC_Plugin::add_admin_notices()
*/
public function add_admin_notices() {
// show any dependency notices
parent::add_admin_notices();
// add notice for selecting export format
$this->get_admin_notice_handler()->add_admin_notice(
sprintf( __( 'Thanks for installing the Customer/Order CSV Export plugin! To get started, please %sset your export format%s. ', 'woocommerce-customer-order-csv-export' ), '<a href="' . $this->get_settings_url() . '">', '</a>' ),
'export-format-notice',
array( 'always_show_on_settings' => false, 'notice_class' => 'updated' )
);
}
/** Subscriptions compatibility *******************************************/
/**
* Don't copy _wc_customer_order_csv_export_is_exported meta
* to renewal orders from the WC_Subscription object.
* Generally the subscription object should not have any order-specific meta.
*
* The WC_Subscription object shouldn't have this meta set, but up until 3.10.3
* this plugin didn't exclude its meta from copying to WC_Subscription the
* object during the upgrade to Subscriptions 2.0.
*
* @since 3.10.3
* @param array $order_meta order meta to copy
* @return array
*/
public function subscriptions_remove_renewal_order_meta( $order_meta ) {
foreach ( $order_meta as $index => $meta ) {
if ( '_wc_customer_order_csv_export_is_exported' == $meta['meta_key'] ) {
unset( $order_meta[ $index ] );
}
}
return $order_meta;
}
/**
* Remove _wc_customer_order_csv_export_is_exported meta
* when creating a subscription object from an order at checkout.
*
* @since 3.10.3
* @param array $order_meta meta on order
* @param WC_Subscription $to_order order meta is being copied to
* @param WC_Order $from_order order meta is being copied from
* @return array
*/
public function subscriptions_remove_subscription_order_meta( $order_meta, $to_order, $from_order ) {
// only when copying from an order to a subscription
if ( $to_order instanceof WC_Subscription && $from_order instanceof WC_Order ) {
foreach ( $order_meta as $index => $meta ) {
if ( '_wc_customer_order_csv_export_is_exported' == $meta['meta_key'] ) {
unset( $order_meta[ $index ] );
}
}
}
return $order_meta;
}
/**
* Don't copy over _wc_customer_order_csv_export_is_exported meta
* during the upgrade from WooCommerce Subscriptions v1.5 to v2.0
*
* @since 3.10.3
* @param array $order_meta meta to copy
* @return array
*/
public function subscriptions_remove_subscription_order_meta_during_upgrade( $order_meta ) {
if ( isset( $order_meta['_wc_customer_order_csv_export_is_exported'] ) ) {
unset( $order_meta['_wc_customer_order_csv_export_is_exported'] );
}
return $order_meta;
}
/** Helper Methods ******************************************************/
/**
* Main Customer/Order CSV Export Instance, ensures only one instance is/can be loaded
*
* @since 3.9.0
* @see wc_customer_order_csv_export()
* @return WC_Customer_Order_CSV_Export
*/
public static function instance() {
if ( is_null( self::$instance ) ) {
self::$instance = new self();
}
return self::$instance;
}
/**
* Returns the plugin name, localized
*
* @since 3.0
* @see SV_WC_Plugin::get_plugin_name()
* @return string the plugin name
*/
public function get_plugin_name() {
return __( 'WooCommerce Customer/Order CSV Export', 'woocommerce-customer-order-csv-export' );
}
/**
* Returns __FILE__
*
* @since 3.0
* @see SV_WC_Plugin::get_file()
* @return string the full path and filename of the plugin file
*/
protected function get_file() {
return __FILE__;
}
/**
* Gets the plugin documentation url, which for Customer/Order CSV Export is non-standard
*
* @since 3.0.0
* @see SV_WC_Plugin::get_documentation_url()
* @return string documentation URL
*/
public function get_documentation_url() {
return 'http://docs.woothemes.com/document/ordercustomer-csv-exporter/';
}
/**
* Gets the plugin support URL
*
* @since 3.10.0
* @see SV_WC_Plugin::get_support_url()
* @return string
*/
public function get_support_url() {
return 'http://support.woothemes.com/';
}
/**
* Gets the URL to the settings page
*
* @since 3.0
* @see SV_WC_Plugin::is_plugin_settings()
* @param string $_ unused
* @return string URL to the settings page
*/
public function get_settings_url( $_ = '' ) {
return admin_url( 'admin.php?page=wc_customer_order_csv_export&tab=settings' );
}
/**
* Returns conditional dependencies based on the FTP security selected
*
* @since 3.0
* @see SV_WC_Plugin::get_dependencies()
* @return array of dependencies
*/
protected function get_dependencies() {
// check if FTP is the chosen method
if ( 'ftp' !== get_option( 'wc_customer_order_csv_export_auto_export_method' ) ) {
return array();
}
$ftp_security = get_option( 'wc_customer_order_csv_export_ftp_security' );
if ( 'sftp' == $ftp_security ) {
return array( 'ssh2' );
}
if ( 'ftp_ssl' == $ftp_security ) {
return array( 'curl' );
}
if ( 'ftps' == $ftp_security ) {
return array( 'ftp', 'openssl' );
}
return array();
}
/**
* Returns conditional function dependencies based on the FTP security selected
*
* @since 3.1
* @see SV_WC_Plugin::get_function_dependencies()
* @return array of dependencies
*/
protected function get_function_dependencies() {
// check if FTP is the chosen method
if ( 'ftp' !== get_option( 'wc_customer_order_csv_export_auto_export_method' ) ) {
return array();
}
$ftp_security = get_option( 'wc_customer_order_csv_export_ftp_security' );
if ( 'ftps' == $ftp_security ) {
return array( 'ftp_ssl_connect' );
}
return array();
}
/** Lifecycle Methods ******************************************************/
/**
* Install default settings
*
* @since 3.0
* @see SV_WC_Plugin::install()
*/
protected function install() {
require_once( $this->get_plugin_path() . '/includes/admin/class-wc-customer-order-csv-export-admin.php' );
foreach ( WC_Customer_Order_CSV_Export_Admin::get_settings( 'settings' ) as $setting ) {
if ( isset( $setting['default'] ) ) {
update_option( $setting['id'], $setting['default'] );
}
}
}
/**
* Upgrade to $installed_version
*
* @since 3.0.4
* @see SV_WC_Plugin::upgrade()
*/
protected function upgrade( $installed_version ) {
// upgrade to 3.0.4
if ( version_compare( $installed_version, '3.0.4', '<' ) ) {
// wc_customer_order_csv_export_passive_mode > wc_customer_order_csv_export_ftp_passive_mode
update_option( 'wc_customer_order_csv_export_ftp_passive_mode', get_option( 'wc_customer_order_csv_export_passive_mode' ) );
delete_option( 'wc_customer_order_csv_export_passive_mode' );
}
// upgrate to 3.4.0
if ( version_compare( $installed_version, '3.4.0', '<' ) ) {
// update order statuses for 2.2+
$order_status_options = array( 'wc_customer_order_csv_export_statuses', 'wc_customer_order_csv_export_auto_export_statuses' );
foreach ( $order_status_options as $option ) {
$order_statuses = (array) get_option( $option );
$new_order_statuses = array();
foreach ( $order_statuses as $status ) {
$new_order_statuses[] = 'wc-' . $status;
}
update_option( $option, $new_order_statuses );
}
}
// upgrade to 3.12.0
if ( version_compare( $installed_version, '3.12.0', '<' ) ) {
if ( 'import' == get_option( 'wc_customer_order_csv_export_order_format' ) ) {
update_option( 'wc_customer_order_csv_export_order_format', 'legacy_import' );
}
}
}
} // end \WC_Customer_Order_CSV_Export class
/**
* Returns the One True Instance of Customer/Order CSV Export
*
* @since 3.9.0
* @return WC_Customer_Order_CSV_Export instance of Customer/Order CSV Export main class
*/
function wc_customer_order_csv_export() {
return WC_Customer_Order_CSV_Export::instance();
}
// fire it up!
wc_customer_order_csv_export();
} // init_woocommerce_customer_order_csv_export()