woocommerce-advanced-ordernumbers.php 34.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
<?php
/**
 * Plugin Name: Advanced Ordernumbers
 * Plugin URI: http://open-tools.net/WooCommerce/Advanced-Ordernumbers.php
 * Description: Lets the user freely configure the order numbers in WooCommerce.
 * Version: 0.1.0
 * Author: Open Tools, Reinhold Kainhofer
 * Author URI: http://open-tools.net
 * Text Domain: woocommerce-advanced-ordernumbers
 * Domain Path: 
 * License: GPL2+
 WC requires at least: 2.2
WC tested up to: 2.3
*/

/**
17
 * The structure of this plugin originally followed the tutorial, although much of the plugin has been rewritten since then:
18
 * http://www.yaconiello.com/blog/how-to-write-wordpress-plugin/
19
 * A lot of coding ideas were also taken directly from the way things are implemented in WooCommerce itself.
20 21 22 23 24 25 26 27 28 29 30 31 32 33
 */
 
if ( ! defined( 'ABSPATH' ) ) { 
	exit; // Exit if accessed directly
}
/**
 * Check if WooCommerce is active
 **/
if ( in_array( 'woocommerce/woocommerce.php', apply_filters( 'active_plugins', get_option( 'active_plugins' ) ) ) ) {
    // Put your plugin code here
    // Load the language files

	if (!class_exists("OpenToolsOrdernumbers")) {
		class OpenToolsOrdernumbers {
34
			public $ordernumber_meta = "_order_number";
35 36
			public $ordernumber_new_placeholder = "[New Order]";
			public $ordernumber_counter_prefix = 'ordernumber-counter-';
37
			
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
			
			/**
			 * STATIC HELPER FUNCTIONS, WooCommerce-specific
			 */
			public static function __($string) {
				return __($string, 'opentools-advanced-ordernumbers');
			}
			public static function rel_url($file) {
				return plugins_url($file, __FILE__);
			}
			public static function img_url($img) {
				return self::rel_url('assets/images/'.$img );
			}
			public static function css_url($css) {
				return self::rel_url('assets/css/'.$css );
			}
			public static function js_url($js) {
				return self::rel_url('assets/js/'.$js );
			}
			
			
			
			
61 62 63 64 65
			/**
			 * Construct the plugin object
			 */
			public function __construct()
			{
66
				$plugin = plugin_basename(__FILE__); 
67
				load_plugin_textdomain('opentools-ordernumbers', false, basename( dirname( __FILE__ ) ) . '/languages' );
68 69 70 71 72


				// Init settings
				$this->settings = array(
					array(
73 74
						'name' 		=> self::__( 'Advanced Order Numbers'),
						'desc'		=> self::__( 'Configure the format and the counters of the order numbers in WooCommerce.'),
75 76 77 78 79
						'type' 		=> 'title',
						'id' 		=> 'ordernumber_options'
					),

					array(
80 81
						'name' 		=> self::__( 'Customize Order Numbers'),
						'desc' 		=> self::__( 'Check to use custom order numbers rather than the default wordpress post ID.'),
82 83 84 85 86
						'id' 		=> 'customize_ordernumber',
						'type' 		=> 'checkbox',
						'default'	=> 'no'
					),
					array(
87 88
						'title'		=> self::__( 'Order number format'),
						'desc' 		=> self::__( 'The format for the order numbers (variables can be entered as [...], the counter is indicated by the #). To use a different counter name than displayed, put the custom counter name after a |, e.g. "[year]-[month]/#|[year]" to use the month in the order number, but reset the counter only yearly.'),
89 90 91 92 93 94
						'desc_tip'	=> true,
						'id' 		=> 'ordernumber_format',
						'default'	=> '#',
						'type' 		=> 'text',
					),
					array(
95 96
						'title'		=> self::__( 'Use global counter'),
						'desc' 		=> self::__( 'A global counter is independent of the number format and will never reset. A non-global counter runs within the number format and will start from the inital value whenever any of the variables used in the format changes (to be precise: a new counter will be used, so it is possible to have multiple counters running in parallel).'),
97
						'desc_tip'	=> true,
98 99 100 101 102
						'id' 		=> 'ordernumber_global',
						'type' 		=> 'checkbox',
						'default'	=> 'no'
					),
					array(
103 104
						'title' 	=> self::__( 'Counter Digits'),
						'desc' 		=> self::__( 'Minimum number of digits for the number'),
105 106 107 108 109 110
						'desc_tip'	=> true,
						'id' 		=> 'ordernumber_padding',
						'type' 		=> 'number',
						'default'	=> '0'
					),
					array(
111 112
						'title' 	=> self::__( 'Counter Start'),
						'desc' 		=> self::__( 'Start value for each new counter'),
113 114 115 116 117 118
						'desc_tip'	=> true,
						'id' 		=> 'ordernumber_start',
						'type' 		=> 'number',
						'default'	=> '1'
					),
					array(
119 120
						'title'		=> self::__( 'Counter step'),
						'desc' 		=> self::__( 'By how much the counter will be increased after each order. Typically 1.'),
121 122 123 124 125 126 127 128
						'desc_tip'	=> true,
						'id' 		=> 'ordernumber_step',
						'type' 		=> 'number',
						'default'	=> '1'
					),
					array( 'type' => 'sectionend', 'id' => 'ordernumber_options' ),
					
					// TODO: customize order password, and other numbers!
129 130

					array(
131 132
						'name' 		=> self::__( 'Custom Variables'),
						'desc'		=> self::__( 'Define your own (conditional) variables for use in the number formats'),
133 134 135 136 137 138 139 140 141 142
						'type' 		=> 'title',
						'id' 		=> 'ordernumber_variables'
					),
					array(
						'id' 		=> 'ordernumber_variables',
						'type' 		=> 'ordernumber_variables',
					),
					array( 'type' => 'sectionend', 'id' => 'ordernumber_variables' ),

					array(
143
						'name' 		=> self::__( 'Current Counters'),
144 145 146 147
						'type' 		=> 'title',
						'id' 		=> 'ordernumber_counters'
					),
					array(
148 149
						'name' 		=> self::__( 'All Ordernumber Counters'),
						'desc'		=> self::__( 'View and modify the current counter values. The counter value is the value used for the previous number. All changes are immediately applied!'),
150
						'desc_tip'	=> true,
151 152 153 154 155
						'id' 		=> 'ordernumber_counters',
						'type' 		=> 'ordernumber_counters',
					),
					array( 'type' => 'sectionend', 'id' => 'ordernumber_counters' ),

156 157 158 159 160 161 162 163 164
				);
				// Default options

				add_option ('customize_ordernumber', '0');
				add_option ('ordernumber_format',    "#");
				add_option ('ordernumber_global',    '0');
				add_option ('ordernumber_padding',   '1');
				add_option ('ordernumber_start',     '1');
				add_option ('ordernumber_step',      '1');
165
				
166
 				add_option ('ordernumber_variables',  array());
167

168 169 170 171
				// register filters and actions
				
				// CONFIGURATION SCREENS
				add_filter( 'woocommerce_get_sections_checkout',                array($this, 'add_admin_section'));
172
				// The checkout settings page assumes all subpages are payment gateways, so we have to override this and manually pass our settings:
173 174 175
				add_action( 'woocommerce_settings_checkout',                    array( $this, 'settings_output' ) );
				add_action( 'woocommerce_settings_save_checkout',               array( $this, 'settings_save' ) );
				add_action( 'woocommerce_admin_field_ordernumber_counters',     array( $this, 'admin_field_counters' ) );
176 177
				add_action( 'woocommerce_admin_field_ordernumber_variables',    array( $this, 'admin_field_variables' ) );
				add_action( 'pre_update_option_ordernumber_variables',          array( $this, 'update_option_variables'));
178 179 180 181 182 183 184 185 186

				add_action( 'admin_print_styles-woocommerce_page_wc-settings',  array($this, 'print_admin_styles'));
				add_action( 'admin_print_scripts-woocommerce_page_wc-settings', array($this, 'print_admin_scripts'));
				
				// AJAX counter modifications
				add_action( 'wp_ajax_set_counter',    array($this, 'counter_set_callback') );
				add_action( 'wp_ajax_add_counter',    array($this, 'counter_add_callback') );
				add_action( 'wp_ajax_delete_counter', array($this, 'counter_delete_callback') );

187 188
				// Add the ordernumber post meta to the search in the backend
				add_filter( 'woocommerce_shop_order_search_fields', array($this, 'order_search_fields'));
189 190 191
				// Sort the order list in the backend by order number rather than ID, make sure this is called LAST so we modify the defaults passed as arguments
				add_filter( 'manage_edit-shop_order_sortable_columns', array( $this, 'modify_order_column_sortkey' ), 9999 );

192 193 194 195
				// When a new order is created, we immediately assign the order number:
				add_action( 'wp_insert_post', array(&$this, 'check_create_ordernumber'), 10, 3);
				add_action( 'save_post', array(&$this, 'check_create_ordernumber'), 10, 3);
				// The filter to actually return the order number for the given order
196
				add_filter ('woocommerce_order_number', array(&$this, 'get_ordernumber'), 10, 2/*<= Also get the order object! */);
197 198
			}
    
199 200
			// Activate the plugin
			public static function activate() {}
201
    
202 203 204
			// Deactivate the plugin
			public static function deactivate() {}

205 206 207 208
			/**
			 * Insert our own section in the checkout setting page. Rearrange the sections array to make sure our settings
			 * come second place, directly after the default page with the '' key and before all the payment gateways
			 */
209
			function add_admin_section($sections) {
210 211 212 213
				$newsections = array();
				foreach ($sections as $sec => $name ) {
					$newsections[$sec] = $name;
					if ($sec == '') {
214
						$newsections['ordernumber'] = self::__('Order Numbers');
215 216 217
					}
				}
				return $newsections;
218 219
			}
			
220
			public function settings_output() {
221 222 223 224 225
				global $current_section;
				if ($current_section == 'ordernumber') {
					$settings = $this->settings;
					WC_Admin_Settings::output_fields( $settings );
				}
226 227
			}

228
			public function settings_save() {
229 230 231 232 233
				global $current_section;
				if ($current_section == 'ordernumber') {
					$settings = $this->settings;
					WC_Admin_Settings::save_fields( $settings );
				}
234
			}
235
			
236 237 238 239
			/** 
			 * Print the CSS for the counter values and counter variables tables to the page header in the WC backend admin setting page
			 */
			public function print_admin_styles () {
240
				wp_register_style ( 'ordernumber-counter-style',  self::css_url('ordernumber-counter.css') );
241
				wp_enqueue_style('ordernumber-counter-style');
242

243
				wp_register_style ( 'ordernumber-variables-style',  self::css_url('ordernumber-variables.css') );
244
				wp_enqueue_style('ordernumber-variables-style');
245 246 247 248 249 250
			}
			/** 
			 * Print the JS for the counter values and counter variables tables to the page header in the WC backend admin setting page
			 */
			public function print_admin_scripts() {
			
251
				wp_register_script( 'ordernumber-counter-script', self::js_url( 'ordernumber-counter.js',  __FILE__), array('jquery') );
252 253 254 255 256
				wp_enqueue_script( 'ordernumber-counter-script');
				
				// Handle the translations:
				$localizations = array( 'ajax_url' => admin_url( 'admin-ajax.php' ) );
				
257 258 259 260 261
				$localizations['ORDERNUMBER_JS_JSONERROR'] = self::__("Error reading response from server:");
				$localizations['ORDERNUMBER_JS_NOT_AUTHORIZED'] = self::__("You are not authorized to modify order number counters.");
				$localizations['ORDERNUMBER_JS_NEWCOUNTER'] = self::__("Please enter the format/name of the new counter:");
				$localizations['ORDERNUMBER_JS_ADD_FAILED'] = self::__("Failed adding counter {0}");
				$localizations['ORDERNUMBER_JS_INVALID_COUNTERVALUE'] = self::__("You entered an invalid value for the counter.\n\n");
262
				
263 264 265 266
				$localizations['ORDERNUMBER_JS_EDITCOUNTER'] = self::__("{0}Please enter the new value for the counter '{1}' (current value: {2}):");
				$localizations['ORDERNUMBER_JS_MODIFY_FAILED'] = self::__("Failed modifying counter {0}");
				$localizations['ORDERNUMBER_JS_DELETECOUNTER'] = self::__("Really delete counter '{0}' with value '{1}'?");
				$localizations['ORDERNUMBER_JS_DELETE_FAILED'] = self::__("Failed deleting counter {0}");
267 268 269

				// in JavaScript, object properties are accessed as ajax_object.ajax_url, ajax_object.we_value
				wp_localize_script( 'ordernumber-counter-script', 'ajax_ordernumber', $localizations );
270 271 272



273
				wp_register_script( 'ordernumber-variables-script', self::js_url( 'ordernumber-variables.js'), array('jquery') );
274
				wp_enqueue_script( 'ordernumber-variables-script');
275
			}
276

277 278 279 280
			/**
			 * Render the Custom Variables configuration table
			 */
			public function admin_field_variables($settings) {
281 282 283
				$variables = get_option( $settings['id'], array() );
				if (!is_array($variables)) {
					$variables = array();
284
				} ?>
285 286
		<tr valign="top">
		    <td class="forminp forminp-<?php echo sanitize_title( $settings['type'] ) ?>" colspan="2">
287 288 289 290 291 292 293 294 295 296
				<?php
					print $this->customvar_admin_table($settings['id'], $variables);
				?>
			</td>
		</tr> 
		<?php
			}
			
			protected function customvar_admin_table($id, $variables) { ?>
			
297
				<table id="ordernumber_variables_template" style="display:none">
298
					<?php echo $this->create_replacements_row_html($id, array(), 'disabled'); ?>
299 300 301 302
				</table>

				<table id="ordernumber_variables" class="ordernumber_variables widefat wc_input_table sortable" cellspacing="0">
					<?php
303 304
						$columns = array(
							'variables_ifvar'    => self::__( 'If variable ...'),
305
							'variables_ifop'     => '',
306 307 308 309
							'variables_ifval'    => self::__( 'Value'),
							'variables_then'     => self::__( ''),
							'variables_thenvar'  => self::__( 'Set variable ...'),
							'variables_thenval'  => self::__( 'to value ...'),
310 311
							'sort'     => '&nbsp;',
							'variables_settings' => '',
312
						);
313 314 315 316 317 318 319 320 321 322 323
					?>
					<thead>
						<tr>
							<?php
								foreach ( $columns as $key => $column ) {
									echo '<th class="' . esc_attr( $key ) . '">' . esc_html( $column ) . '</th>';
								}
							?>
						</tr>
						<tr id = "ordernumber-replacements-empty-row" class="oton-empty-row-notice <?php echo (empty($variables))?'':'rowhidden'; ?>">
							<td class="oton-empty-row-notice" colspan="8">
324 325
								<em> <?php echo self::__('No custom variables have been defined.'); ?></em>
								<input type="hidden" name="<?php echo $id; ?>" value="" <?php echo (empty($variables))?'':'disabled'; ?>>
326 327 328 329 330 331 332 333 334 335 336 337 338 339
							</td>
						</tr>
					</thead>
					<colgroup>
						<?php 
							foreach ($columns as $key => $column) {
								echo '<col class="' . esc_attr($key) . '" />';
							}
						?>
					</colgroup>

					<tbody>
						<?php
						foreach ($variables as $var) {
340
							echo $this->create_replacements_row_html($id, $var);
341 342 343 344 345 346
						} ?>
					</tbody>
					<tfoot>
						<tr class='addreplacement_row'>
							<td colspan=8 class='variable_add'>
								<div class='ordernumber-variables-addbtn ordernumber-btn' onClick="ordernumberVariablesAddRow('ordernumber_variables_template', 'ordernumber_variables')">
347 348
									<div class='ordernumber-ajax-loading'><img src='<?php echo self::img_url( 'icon-16-new.png' ); ?>' class='ordernumber-counter-addbtn' /></div>
									<?php _e('Add new custom variable'); ?>
349 350 351 352 353
								</div>
							</td>
						</tr>
					</tfoot>
				</table>
354
				<?php
355 356 357 358 359 360
			}

			protected function create_replacements_row_html($name, $values = array(), $disabled = '') {
				$operator = (isset($values['conditionop'])?$values['conditionop']:'');
				$operators = array(
					'equals'       => '=', 
361
					'contains'     => self::__('contains'), 
362 363 364 365
					'smaller'      => '<',
					'smallerequal' => '<=',
					'larger'       => '>',
					'largerequal'  => '>=', 
366 367
					'startswith'   => self::__('starts with'),
					'endswith'     => self::__('ends with'),
368 369 370 371 372 373 374 375 376 377 378 379 380 381
				);
				$html  = '
				<tr>
					<td class="oton-replacement-variable"><input name="' . $name . '[conditionvar][]" value="' . (isset($values['conditionvar'])?$values['conditionvar']:'') . '" ' . $disabled . '/></td>
					<td class="oton-replacement-op"      ><select name="' . $name . '[conditionop][]" ' . $disabled . '>';
				foreach ($operators as $op => $opname) {
					$html .= '		<option value="' . esc_attr($op) . '" ' . (($op === $operator)?'selected':'') . '>' . esc_html($opname) . '</option>';
				}
				$html .= '</td>
					<td class="oton-replacement-value"   ><input name="' . $name . '[conditionval][]" value="' . (isset($values['conditionval'])?$values['conditionval']:'') . '" ' . $disabled . '/></td>
					<td>=></td>
					<td class="oton-replacement-variable"><input name="' . $name . '[newvar][]"       value="' . (isset($values['newvar'])?$values['newvar']:'') .       '" ' . $disabled . '/></td>
					<td class="oton-replacement-newvalue"><input name="' . $name . '[newval][]"       value="' . (isset($values['newval'])?$values['newval']:'') .       '" ' . $disabled . '/></td>
					<td class="sort">&nbsp;</td>
382
					<td><img src="' . self::img_url( 'icon-16-delete.png' ) . '" class="ordernumber-replacement-deletebtn ordernumber-btn"></td>
383 384 385
				</tr>';
				return $html;
			}
386
			
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
			/** 
			 * Store the variable replacements array into the options. Need to transpose the array before we can store it into the options...
			 * This filter is called directly before the option is saved.
			 */
			public function update_option_variables ($value) {
				if (!is_array($value)) 
					return array();
				$keys = array_keys($value);
				$vallist = array();
				
				foreach (array_keys($value[$keys[0]]) as $i) {
					$entry = array();
					foreach ($keys as $k) {
						$entry[$k] = $value[$k][$i];
					}
					$vallist[] = $entry;
				}
				return $vallist;
405
			}
406

407 408 409 410 411
			
			/**
			 * Render the Counter Values modification table
			 */
			public function admin_field_counters ($settings) {
412 413 414 415
				// Description handling
				$field_description = WC_Admin_Settings::get_field_description( $settings );
				extract( $field_description );

416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
				// First, get all counter names:
				$counters = array();
				$pfxlen = strlen($this->ordernumber_counter_prefix );
				foreach (wp_load_alloptions() as $name => $value) {
					if (substr($name, 0, $pfxlen) == $this->ordernumber_counter_prefix) {
						$parts = explode('-', substr($name, $pfxlen), 2);
						if (sizeof($parts)==1) {
							array_unshift($parts, 'ordernumber');
						}
						$counters[] = array(
							'type' => $parts[0],
							'name' => $parts[1],
							'value' => $value,
						);
					}
				} 
				?>
433

434 435
				
		<tr valign="top">
436 437 438 439 440
			<th scope="row" class="titledesc">
				<label for="<?php echo esc_attr( $settings['id'] ); ?>"><?php echo esc_html( $settings['title'] ); ?></label>
				<?php echo $tooltip_html; ?>
			</th>
		    <td class="forminp forminp-<?php echo sanitize_title( $settings['type'] ) ?>">
441
				<img src='<?php echo self::img_url( 'loading.gif' ); ?>' class='wc-ordernumber-loading' style="display: none; position: absolute; top: 2px; left: 0px; z-index: 9999;"/>
442 443 444
				<table class="wc_ordernumber_counters widefat" cellspacing="0">
					<?php
						$columns = apply_filters( 'woocommerce_ordernumber_counters_columns', array(
445 446 447
							'type'     => self::__( ''),
							'name'     => self::__( 'Counter name'),
							'value'    => self::__( 'Counter value'),
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
							'settings' => ''
						) );
					?>
					<thead>
						<tr>
							<?php
								foreach ( $columns as $key => $column ) {
									echo '<th class="counter_' . esc_attr( $key ) . '">' . esc_html( $column ) . '</th>';
								}
							?>
						</tr>
					</thead>
					<colgroup>
						<?php 
							foreach ($columns as $key => $column) {
								echo '<col class="counter_' . esc_attr($key) . '" />';
							}
						?>
					</colgroup>

					<tbody>
						<?php
470 471 472 473
						foreach ($counters as $counter) {
							echo $this->create_admin_counter_row($counter['type'], $counter['name'], $counter['value']);
						} 
						?>
474 475 476 477 478
					</tbody>
					<tfoot>
						<tr class='addcounter_row'>
							<td class="counter_type"></td>
							<td colspan=3 class='counter_add'>
479
								<div class='ordernumber-counter-addbtn ordernumber-btn' onClick="ajaxAddCounter(this, 'ordernumber')">
480 481
									<div class='ordernumber-ajax-loading'><img src='<?php echo self::img_url( 'icon-16-new.png' ); ?>' class='ordernumber-counter-addbtn' /></div>
									<?php _e('Add new counter'); ?>
482 483 484 485 486 487 488 489 490 491
								</div>
							</td>
						</tr>
					</tfoot>
				</table>
			</td>
		</tr> 
		<?php
			}
			
492 493 494
			public function create_admin_counter_row ($type, $format, $value=0) {
				$html =	"
					<tr class='counter_row counter_type_" . $type . "'>
495 496
						<td class='counter_type'>" . self::__($type, 'wooocommerce-advanced-ordernumbers' ) . "</td>
						<td class='counter_format'>" . (empty($format)?("<i>".self::__("[Global]")."</i>"):esc_html($format)) . "</td>
497 498 499
						<td class='counter_value'>" . esc_html($value) . "</td>
						<td class='counter_buttons'>
							<div class='ordernumber-ajax-loading'>
500
							<img src='" . self::img_url( 'icon-16-edit.png' ) . "' 
501 502 503 504
										class='ordernumber-counter-editbtn ordernumber-btn' 
										onClick='ajaxEditCounter(this, " . json_encode($type) . ", " . json_encode($format) . ", " . json_encode($value) . ")' />
							</div>
							<div class='ordernumber-ajax-loading'>
505
								<img src='" . self::img_url( 'icon-16-delete.png' ) . "' 
506 507 508 509 510 511 512
										class='ordernumber-counter-deletebtn ordernumber-btn' 
										onClick='ajaxDeleteCounter(this, " . json_encode($type) . ", " . json_encode($format) . ", " . json_encode($value) . ")' />
							</div>
						</td>
					</tr>";
				return $html;
			}
513 514
			
			
515 516 517 518 519 520 521 522
			/** 
			 * Hook to add the order numer post meta field to the searchable field 
			 * (so the admin can search for the order number in the backend)
			 */
			public function order_search_fields($fields) {
				$fields[] = $this->ordernumber_meta;
				return $fields;
			}
523 524 525 526 527 528 529 530 531 532 533
			
			/**
			 * Sort the order list's "Order" column by our post meta rather than by ID
			 */
			public function modify_order_column_sortkey($columns) {
				$custom = array(
					'order_title' => $this->ordernumber_meta,
				);
				// Use the passed columns as "default", so effectively, only the order_title will be changed:
				return wp_parse_args ($custom, $columns);
			}
534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551
			
			/** 
			 * Handle new posts created in the frontend. This action will be called for all posts, 
			 * not only for orders, so we need to check explicitly. Also, this function will be called
			 * for order updates, so we need to check the update argument, too.
			 */
			public function check_create_ordernumber($post_id, $post, $update) {
				// Is the post really an order?
				// Order numbers are only assigned to orders on creation, not when updating!
				if ($post->post_type != 'shop_order') {
					return;
				} else {
					// Handle new admin-created orders, where the address is entered later on!
					// Assign an order number:
					$number = $this->assign_new_ordernumber($post_id, $post, $update);
				}
				
			}
552

553
			/**
554
			 * Counter handling (simple loading/storing counters), storing them as options
555
			 */
556
			function _getCounter($type, $format, $start=0) {
557
				$count = get_option ($this->ordernumber_counter_prefix.$type.'-'.$format, $start);
558 559 560 561
				return $count;
			}
			// Insert new counter value into the db or update existing one
			function _setCounter($type, $format, $value) {
562
				return update_option($this->ordernumber_counter_prefix.$type.'-'.$format, $value);
563
			}
564 565 566
			function _deleteCounter($type, $format) {
				return delete_option($this->ordernumber_counter_prefix.$type.'-'.$format);
			}
567
			
568 569 570 571 572 573 574 575 576
			public function counter_delete_callback() {
				$json = array('action' => 'delete_counter', 'success' => 0);
				$json['success'] = $this->_deleteCounter($_POST['nrtype'], $_POST['counter']);
				wp_send_json($json);
			}

			public function counter_add_callback () {
				$type = $_POST['nrtype'];
				$format = $_POST['counter'];
577
				$value = isset($_POST['value'])?$_POST['value']:"0";
578 579 580
				$json = array('action' => 'add_counter', 'success' => 0);
				if ($this->_getCounter($type, $format, -1) != -1) {
					// Counter already exists => error message
581
					$json['error'] = sprintf(self::__('Counter "%s" already exists, cannot create again.'), $format);
582 583 584 585 586 587 588 589 590 591 592 593
				} else {
					$json['success'] = $this->_setCounter($type, $format, $value);
					$json['newrow']  = $this->create_admin_counter_row($type, $format, $value);
				}
				wp_send_json($json);
			}
			
			public function counter_set_callback () {
				$json = array('action' => 'set_counter', 'success' => 0);
				$json['success'] = $this->_setCounter($_POST['nrtype'], $_POST['counter'], $_POST['value']);
				wp_send_json($json);
			}
594
			
595 596 597 598 599 600 601
			
			
			/** ***********************************************************
			 * 
			 *  REPLACEMENT FUNCTIONS
			 *
			 **************************************************************/
602 603 604 605 606 607 608 609 610
			
			/* Return a random "string" of the given length taken from the given alphabet */
			static function randomString($alphabet, $len) {
				$alen = strlen($alphabet);
				$r = "";
				for ($n=0; $n<$len; $n++) {
					$r .= $alphabet[mt_rand(0, $alen-1)];
				}
				return $r;
611 612
			}

613 614 615 616 617 618 619 620 621 622 623 624 625
			function replaceRandom ($match) {
				/* the regexp matches (random)(Type)(Len) as match, Type and Len is optional */
				$len = ($match[3]?$match[3]:1);
				// Fallback: If no Type is given, use Digit
				$alphabet = "0123456789";
				// Select the correct alphabet depending on Type
				switch (strtolower($match[2])) {
					case "digit": $alphabet = "0123456789"; break;
					case "hex": $alphabet = "0123456789abcdef"; break;
					case "letter": $alphabet = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"; break;
					case "uletter": $alphabet = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"; break;
					case "lletter": $alphabet = "abcdefghijklmnopqrstuvwxyz"; break;
					case "alphanum": $alphabet = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"; break;
626
				}
627 628
				return self::randomString ($alphabet, $len);
			}
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646
	
			protected function setupDateTimeReplacements (&$reps, $order, $nrtype) {
				$utime = microtime(true);
				$reps["[year]"] = date ("Y", $utime);
				$reps["[year2]"] = date ("y", $utime);
				$reps["[month]"] = date("m", $utime);
				$reps["[day]"] = date("d", $utime);
				$reps["[hour]"] = date("H", $utime);
				$reps["[hour12]"] = date("h", $utime);
				$reps["[ampm]"] = date("a", $utime);
				$reps["[minute]"] = date("i", $utime);
				$reps["[second]"] = date("s", $utime);
				$milliseconds = (int)(1000*($utime - (int)$utime));
				$millisecondsstring = sprintf('%03d', $milliseconds);
				$reps["[decisecond]"] = $millisecondsstring[0];
				$reps["[centisecond]"] = substr($millisecondsstring, 0, 2);
				$reps["[millisecond]"] = $millisecondsstring;
			}
647

648 649 650 651
			protected function setupAddressReplacements(&$reps, $prefix, $address, $nrtype) {
				$reps["[email]"]     = $address->billing_email;
				$reps["[firstname]"] = $address->billing_first_name;
				$reps["[lastname]"]  = $address->billing_last_name;
652

653 654 655 656
				$reps["[company]"]   = $address->billing_company;
				$reps["[zip]"]       = $address->billing_postcode;
				$reps["[postcode]"]  = $address->billing_postcode;
				$reps["[city]"]      = $address->billing_city;
657
        
658 659
				$country = $address->billing_country;
				$state = $address->billing_state;
660 661
				$allcountries = WC()->countries->get_countries();
				$states = WC()->countries->get_states($country);
662
				$reps["[country]"]     = $country;
663 664
				$reps["[countryname]"] = ( isset( $allcountries[ $country ] ) ) ? $allcountries[ $country ] : $country;

665 666
				$reps["[state]"]       = $state;
				$reps["[statename]"]   = ( $country && $state && isset( $states[ $country ][ $state ] ) ) ? $states[ $country ][ $state ] : $state;
667 668 669 670 671 672 673 674
			}
			
			protected function setupStoreReplacements (&$reps, $order, $nrtype) {
			}
    
			protected function setupOrderReplacements (&$reps, $order, $nrtype) {
				$reps["[orderid]"] = $order->id;
				$reps["[ipaddress]"]   = $order->customer_ip_address;
675
				
676 677 678 679
				if ($nrtype != 'ordernumber') {
					$reps["[ordernumber]"] = $order->get_order_number();
				}
				$reps["[orderstatus]"] = $order->get_status();
680
				$reps["[currency]"]    = $order->get_order_currency();
681 682 683 684 685
				$reps["[userid]"]      = $order->get_user_id();

				$this->setupAddressReplacements($reps, "", $order, $nrtype);
	
				$reps["[articles]"]    = $order->get_item_count();
686 687
// 				$reps["[downloadpermitted]"] = $order->is_download_permitted();
// 				$reps["[hasdownloads]"] = $order->has_downloadable_item();
688
// 				$reps["[coupons]"] = $order->get_used_coupons();
689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768
				$reps["[ordertotal]"]      = $order->get_total();
				$reps["[amount]"]      = $order->get_total();
				$reps["[ordersubtotal]"]      = $order->get_subtotal();
				$reps["[totaltax]"]      = $order->get_total_tax();
				$reps["[totalshipping]"]      = $order->get_total_shipping();
			}
   
			protected function setupShippingReplacements(&$reps, $order, $nrtype) {
// 				$reps["[shippingmethod]"] = $order->getShippingMethod();
			}
			
			/*protected function setupInvoiceReplacements (&$reps, $invoice, $order, $nrtype) {
				$reps["[invoiceid]"] = $invoice->getId();
			}*/

			protected function setupReplacements($nrtype, $order) {
				$reps = array();
				$this->setupDateTimeReplacements($reps, $order, $nrtype);
				$this->setupStoreReplacements($reps, $order, $nrtype);
				$this->setupOrderReplacements($reps, $order, $nrtype);
				$this->setupShippingReplacements($reps, $order, $nrtype);
				$reps = apply_filters( 'opentools_ordernumber_replacements', $reps, $order, $nrtype);
				return $reps;
			}

			
			protected function applyCustomVariables ($nrtype, $order, $reps, $customvars) {
				foreach ($customvars as $c) {
					$conditionvar = strtolower($c['conditionvar']);
					$op = $c['conditionop'];

					$found = false;
					$match = false;
					$compareval = null;

					if (isset($reps[$conditionvar])) {
						$found = true;
						$compareval = $reps[$conditionvar];
					} elseif (isset($reps['['.$conditionvar.']'])) {
						$found = true;
						$compareval = $reps['['.$conditionvar.']'];
					}/* elseif ($order && $compareval = $order->getData($conditionvar)) {
						// TODO: Handle order property
						$found = true;
					}*/ else {
						// TODO: Handly other possible properties!
						// TODO: Print out warning that variable could not be found.
					}
					if ($found) {
						$condval = $c['conditionval'];
						switch ($op) {
							case 'equals': 
									$match = ($compareval == $condval); break;
							case 'contains':
									if (is_array($compareval)) {
										$match = in_array($condval, $compareval);
									} else {
										$match = strpos ($compareval, $condval);
									}
									break;
							case 'smaller':
									$match = ($compareval<$condval); break;
							case 'smallerequal':
									$match = ($compareval<=$condval); break;
							case 'larger':
									$match = ($compareval>$condval); break;
							case 'largerequal':
									$match = ($compareval>=$condval); break;
							case 'startswith':
									$match = (substr("$compareval", 0, strlen("$condval")) === "$condval"); break;
							case 'endswith':
									$match = (substr("$compareval", -strlen("$condval")) === "$condval"); break;
						}
					} elseif (empty($conditionvar)) {
						$match = true;
					}
					if ($match) {
						$varname = '['.strtolower($c['newvar']).']';
						$reps[$varname] = $c['newval'];
					}
769
				}
770 771
				return $reps;
			}
772

773 774 775
			protected function doReplacements ($fmt, $reps) {
				// First, replace all random...[n] fields. This needs to be done with a regexp and a callback:
				$fmt = preg_replace_callback ('/\[(random)(.*?)([0-9]*?)\]/', array($this, 'replaceRandom'), $fmt);
776
				return str_ireplace (array_keys($reps), array_values($reps), $fmt);
777
			}
778

779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796
			// Allow the user to override the format like any other custom variable:
			protected function determineNumberFormatString($fmt, $type, $order, $reps) {
				if (isset($reps['['.$type.'_format]'])) {
					return $reps['['.$type.'_format]'];
				} else {
					return $fmt;
				}
			}
			

			/* replace the variables in the given format. $type indicates the type of number, currently only 'ordernumber', because WooCommerce does not support invoices or customer numbers. We might allow the shop owner to customize the order password, though. */
			function replace_fields ($fmt, $type, $order, $customvars) {
				$reps = $this->setupReplacements ($type, $order);
				$reps = $this->applyCustomVariables ($type, $order, $reps, $customvars);
				$format = $this->determineNumberFormatString($fmt, $type, $order, $reps);
				return $this->doReplacements($format, $reps);
			}
			
797 798 799 800 801 802 803
			function create_ordernumber($orderid, $order, $type='ordernumber') {
				if (get_option('customize_'.$type, 'false')) {
					$fmt     = get_option ($type.'_format',  "#");
					$global  = get_option ($type.'_global',  1);
					$padding = get_option ($type.'_padding', 1);
					$step    = get_option ($type.'_step',    1);
					$start   = get_option ($type.'_start',   1)-$step; // The counter contains the PREVIOUS number!
804
					$customvars = get_option ('ordernumber_variables',   array());
805

806
					$nr = $this->replace_fields ($fmt, $type, $order, $customvars);
807 808 809 810 811 812 813 814 815 816 817 818 819

					// Split at a | to get the number format and a possibly different counter increment format
					// If a separate counter format is given after the |, use it, otherwise reuse the number format itself as counter format
					$parts = explode ("|", $nr);
					$format = $parts[0];
        
					$counterfmt = ($global==1)?"":$parts[(count($parts)>1)?1:0];
        
					// Look up the current counter
					$count = $this->_getCounter($type, $counterfmt, $start) + $step;
					$this->_setCounter($type, $counterfmt, $count);
					// return the format with the counter inserted
					$number = str_replace ("#", sprintf('%0' . $padding . 's', $count), $format);
820
					update_post_meta( $orderid, $this->ordernumber_meta, $number );
821 822 823 824 825
					return $number;
				} else {
					return $orderid;
				}
			}
826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847
			
			/** 
			 * The hook to assign a customized order number (unless the order already has one assigned)
			 */
			function assign_new_ordernumber($orderid, $order, $update=true) {
				if ((!$update) && ($order->post_status == 'auto-draft')) {
					// New order => assign placeholder, which will later be overwritten the real order number
					update_post_meta( $orderid, $this->ordernumber_meta, $this->ordernumber_new_placeholder );
				}
				// If we do not have an order (yet), we cannot proceed. But we probably have created the 
				// ordernumber placeholder for that post, so this function has done its job and we can return
				if (!$order instanceof WC_Order) {
					return;
				}
				$number = get_post_meta( $orderid, $this->ordernumber_meta, 'true');
				if ($number == $this->ordernumber_new_placeholder && $order->post_status != 'auto-draft') {
					$number = $this->create_ordernumber($orderid, $order, 'ordernumber');
					// Assign a new number
				}
				return $number;
			}

848 849 850 851
			/** 
			 * The hook to customize order numbers (requests the order number from the database; creates a new ordernumber if no entry exists in the database)
			 */
			function get_ordernumber($orderid, $order) {
852
				$stored_number = get_post_meta( $orderid, $this->ordernumber_meta, 'true');
853 854 855 856 857
				if ($stored_number == $this->ordernumber_new_placeholder) {
					// Check whether the order was now really created => create order number now
					return $this->assign_new_ordernumber($orderid, $order);
				} elseif (!empty($stored_number)) {
					// Order number already exists => simply return it
858
					return $stored_number;
859
				} else {
860
					// No order number was created for this order, so simply use the orderid as default.
861
					return $orderid;
862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877
				}
			}

		}
	}

	if (class_exists("OpenToolsOrdernumbers")) {
		// Installation and uninstallation hooks
		register_activation_hook(__FILE__, array('OpenToolsOrdernumbers', 'activate'));
		register_deactivation_hook(__FILE__, array('OpenToolsOrdernumbers', 'deactivate'));

		// instantiate the plugin class
		$ordernumber_plugin = new OpenToolsOrdernumbers();
	}
 
}