ird-iridium-gateway.php

<?php
/*
Iridium for WooCommerce
https://github.com/steevebrush/iridium-woocommerce
Adapted by stevebrush from krb plugin
*/


//---------------------------------------------------------------------------
add_action('plugins_loaded', 'IRD__plugins_loaded__load_Iridium_gateway', 0);
//---------------------------------------------------------------------------

//###########################################################################
// Hook payment gateway into WooCommerce

function IRD__plugins_loaded__load_Iridium_gateway ()
{

    if (!class_exists('WC_Payment_Gateway'))
    	// Nothing happens here because WooCommerce is not loaded
    	return;

	//=======================================================================
	/**
	 * Iridium Payment Gateway
	 *
	 * Provides a Iridium Payment Gateway
	 *
	 * @class 		IRD_Iridium
	 * @extends		WC_Payment_Gateway
	 * @version
	 * @package
	 * @author 		KittyCatTech
	 */
	class IRD_Iridium extends WC_Payment_Gateway
	{
		//-------------------------------------------------------------------
	    /**
	     * Constructor for the gateway.
	     *
	     * @access public
	     * @return void
	     */
		public function __construct()
		{
			$this->id				= 'Iridium';
			$this->icon 			= plugins_url('/images/IRD_buyitnow_32x.png', __FILE__);	// 32 pixels high
			$this->has_fields 		= false;
			$this->method_title     = __( 'Iridium', 'woocommerce' );

			// Load IRD settings.
			$IRD_settings = IRD__get_settings ();
			$this->service_provider = $IRD_settings['service_provider']; // This need to be before $this->init_settings otherwise it generate PHP Notice: "Undefined property: IRD_Iridium::$service_provider" down below.

			// Load the form fields.
			$this->init_form_fields();
			$this->init_settings();

			// Define user set variables
			$this->title 		= $this->settings['title'];	// The title which the user is shown on the checkout – retrieved from the settings which init_settings loads.
			$this->Iridium_addr_merchant = $this->settings['Iridium_addr_merchant'];	// Forwarding address where all product payments will aggregate.
			
			$this->confs_num = $IRD_settings['confs_num'];  //$this->settings['confirmations'];
			$this->description 	= $this->settings['description'];	// Short description about the gateway which is shown on checkout.
			$this->instructions = $this->settings['instructions'];	// Detailed payment instructions for the buyer.
			$this->instructions_multi_payment_str  = __('You may send payments from multiple accounts to reach the total required.', 'woocommerce');
			$this->instructions_single_payment_str = __('You must pay in a single payment in full.', 'woocommerce');

			// Actions
			if ( version_compare( WOOCOMMERCE_VERSION, '2.0.0', '>=' ) )
				add_action('woocommerce_update_options_payment_gateways_' . $this->id, array( $this, 'process_admin_options' ) );
			else
				add_action('woocommerce_update_options_payment_gateways', array($this, 'process_admin_options')); // hook into this action to save options in the backend

		    add_action('woocommerce_thankyou_' . $this->id, array($this, 'IRD__thankyou_page')); // hooks into the thank you page after payment

	    	// Customer Emails
		    add_action('woocommerce_email_before_order_table', array($this, 'IRD__email_instructions'), 10, 2); // hooks into the email template to show additional details

			// Validate currently set currency for the store. Must be among supported ones.
			if (!IRD__is_gateway_valid_for_use()) $this->enabled = false;
	    }
		//-------------------------------------------------------------------

		//-------------------------------------------------------------------
	    /**
	     * Check if this gateway is enabled and available for the store's default currency
	     *
	     * @access public
	     * @return bool
	     */
	    function is_gateway_valid_for_use(&$ret_reason_message=NULL)
	    {
	    	$valid = true;

	    	//----------------------------------
	    	// Validate settings
	    	if (!$this->service_provider)
	    	{
	    		$reason_message = __("Iridium Service Provider is not selected", 'woocommerce');
	    		$valid = false;
	    	}
	    	
	    	else if ($this->service_provider=='local_wallet')
	    	{
			    $walletd_api = $IRD_settings['walletd_api'];
	    		$wallet_api = New ForkNoteWalletd($walletd_api);
	    		$IRD_settings = IRD__get_settings();
          		$address = $IRD_settings['address'];
	    		if (!$address)
	    		{
		    		$reason_message = __("Please specify Wallet Address in Iridium plugin settings.", 'woocommerce');
		    		$valid = false;
		    	}
	    		// else if (!preg_match ('/^xpub[a-zA-Z0-9]{98}$/', $address))
	    		// {
		    	// 	$reason_message = __("Iridium Address ($address) is invalid. Must be 98 characters long, consisting of digits and letters.", 'woocommerce');
		    	// 	$valid = false;
		    	// }
		    	else if ($wallet_api->getBalance($address) === false)
		    	{
		    		$reason_message = __("Iridium address is not found in wallet.", 'woocommerce');
		    		$valid = false;
		    	}
	    	}

	    	if (!$valid)
	    	{
	    		if ($ret_reason_message !== NULL)
	    			$ret_reason_message = $reason_message;
	    		return false;
	    	}
	    	//----------------------------------

	    	//----------------------------------
	    	// Validate connection to exchange rate services

	   		$store_currency_code = get_woocommerce_currency();
	   		if ($store_currency_code != 'IRD')
	   		{
					$currency_rate = IRD__get_exchange_rate_per_Iridium ($store_currency_code, 'getfirst', false);
					if (!$currency_rate)
					{
						$valid = false;

						// Assemble error message.
						$error_msg = "ERROR: Cannot determine exchange rates (for '$store_currency_code')! {{{ERROR_MESSAGE}}} Make sure your PHP settings are configured properly and your server can (is allowed to) connect to external WEB services via PHP.";
						$extra_error_message = "";
						$fns = array ('file_get_contents', 'curl_init', 'curl_setopt', 'curl_setopt_array', 'curl_exec');
						$fns = array_filter ($fns, 'IRD__function_not_exists');
						$extra_error_message = "";
						if (count($fns))
							$extra_error_message = "The following PHP functions are disabled on your server: " . implode (", ", $fns) . ".";

						$reason_message = str_replace('{{{ERROR_MESSAGE}}}', $extra_error_message, $error_msg);

		    		if ($ret_reason_message !== NULL)
		    			$ret_reason_message = $reason_message;
		    		return false;
					}
				}

	     	return true;
	    	//----------------------------------
	    }
		//-------------------------------------------------------------------

		//-------------------------------------------------------------------
	    /**
	     * Initialise Gateway Settings Form Fields
	     *
	     * @access public
	     * @return void
	     */
	    function init_form_fields()
	    {
		    // This defines the settings we want to show in the admin area.
		    // This allows user to customize payment gateway.
		    // Add as many as you see fit.
		    // See this for more form elements: http://wcdocs.woothemes.com/codex/extending/settings-api/

	    	//-----------------------------------
	    	// Assemble currency ticker.
	   		$store_currency_code = get_woocommerce_currency();
	   		if ($store_currency_code == 'IRD')
	   			$currency_code = 'USD';
	   		else
	   			$currency_code = $store_currency_code;

				$currency_ticker = IRD__get_exchange_rate_per_Iridium ($currency_code, 'getfirst', true);
	    	//-----------------------------------

	    	//-----------------------------------
	    	// Payment instructions
//	    	$payment_instructions = '
//<table class="IRD-payment-instructions-table" id="IRD-payment-instructions-table">
//  <tr class="bpit-table-row">
//    <td colspan="2">' . __('Please send your Iridium payment as follows:', 'woocommerce') . '</td>
//  </tr>
//  <tr class="bpit-table-row">
//    <td style="vertical-align:middle;" class="bpit-td-name bpit-td-name-amount">
//      ' . __('Amount', 'woocommerce') . ' (<strong>IRD</strong>):
//    </td>
//    <td class="bpit-td-value bpit-td-value-amount">
//      <div style="border:1px solid #EC6D00;padding:2px 6px;margin:2px;background-color:#EEEEEE;border-radius:2px;color:#000000;">
//      	{{{IRDCOINS_AMOUNT}}}
//      </div>
//    </td>
//  </tr>
//    <tr class="bpit-table-row">
//    <td style="vertical-align:middle;" class="bpit-td-name bpit-td-name-IRDaddr">
//      ' . __('Payment ID:', 'woocommerce') . '
//    </td>
//    <td class="bpit-td-value bpit-td-value-IRDaddr">
//      <div style="border:1px solid #EC6D00;padding:2px 6px;margin:2px;background-color:#EEEEEE;border-radius:2px;color:#CC0000;">
//        {{{IRDCOINS_PAYMENTID}}}
//      </div>
//    </td>
//  </tr>
//  <tr class="bpit-table-row">
//    <td style="vertical-align:middle;" class="bpit-td-name bpit-td-name-IRDaddr">
//      ' . __('Address:', 'woocommerce') . '
//    </td>
//    <td class="bpit-td-value bpit-td-value-IRDaddr">
//      <div style="border:1px solid #EC6D00;padding:2px 6px;margin:2px;background-color:#EEEEEE;border-radius:2px;color:#CC0000;">
//        {{{IRDCOINS_ADDRESS}}}
//      </div>
//    </td>
//  </tr>
//</table>
//
//' . __('Please note:', 'woocommerce') . '
//<ol class="bpit-instructions">
//    <li>' . __('You must make a payment within 1 hour, or your order will be cancelled', 'woocommerce') . '</li>
//    <li>' . __('As soon as your payment is received in full you will receive email confirmation with order delivery details.', 'woocommerce') . '</li>
//    <li>{{{EXTRA_INSTRUCTIONS}}}</li>
//</ol>
//';
$payment_instructions = '
<table class="table_iridium">
    <thead>
        <tr>
            <th><img style=" height: 34px; float: right;margin: -5px 5px 0 0;"  src="' . plugins_url('/images/IRD_buyitnow_32x.png', __FILE__).'">' . __('Please send your Iridium payment as follows :', 'woocommerce') . '</th>
        </tr>
    </thead>
    <tbody>
       
         <tr>
            <td>' . __('Amount', 'woocommerce') . ' : <br/><strong>{{{IRDCOINS_AMOUNT}}} IRD</strong><br/>'  . __('Address : ', 'woocommerce') . '<br/><span style="font-size: 0.8em;font-weight: bold;">{{{IRDCOINS_ADDRESS}}}</span><br/>' . __('Payment ID : ', 'woocommerce'). '<span style="font-size: 0.9em;font-weight: bold;"><br/>{{{IRDCOINS_PAYMENTID}}}</span><br/><span style=" color: red;">' .__('Mandatory or your transaction will be lost', 'woocommerce') . '</span></td>
        </tr>
        <tr>
            <td>' . __('Please note:', 'woocommerce') . '
            <ol style="font-size: 0.9em;">
    <li>' . __('You must make a payment within 2 hours, or your order will be cancelled', 'woocommerce') . '</li>
    <li>' . __('As soon as your payment is received in full you will receive an email confirmation with order delivery details.', 'woocommerce') . '</li>
    <li>{{{EXTRA_INSTRUCTIONS}}}</li>
</ol></td>
        </tr>
    </tbody>
    
</tr>
</table>';
				$payment_instructions_description = trim ($payment_instructions_description);
	    	//-----------------------------------

	    	$this->form_fields = array(
				'enabled' => array(
								'title' => __( 'Enable/Disable', 'woocommerce' ),
								'type' => 'checkbox',
								'label' => __( 'Enable Iridium', 'woocommerce' ),
								'default' => 'yes'
							),
				'title' => array(
								'title' => __( 'Title', 'woocommerce' ),
								'type' => 'text',
								'description' => __( 'This controls the title which the user sees during checkout.', 'woocommerce' ),
								'default' => __( 'Iridium Payment', 'woocommerce' )
							),

				'Iridium_addr_merchant' => array(
								'title' => __( 'Iridium Address', 'woocommerce' ),
								'type' => 'text',
								'css'     => '',
								'disabled' => false,
								'description' => __( 'Your Iridium address where customer sends you payment for the product. It must be in your walletd container.', 'woocommerce' ),
								'default' => '',
							),

				'description' => array(
								'title' => __( 'Customer Message', 'woocommerce' ),
								'type' => 'text',
								'description' => __( 'Initial instructions for the customer at checkout screen', 'woocommerce' ),
								'default' => __( 'Please proceed to the next screen to see necessary payment details.', 'woocommerce' )
							),
				'instructions' => array(
								'title' => __( 'Payment Instructions (HTML)', 'woocommerce' ),
								'type' => 'textarea',
								'description' => $payment_instructions_description,
								'default' => $payment_instructions,
							),
				);
	    }

		//-------------------------------------------------------------------
		/**
		 * Admin Panel Options
		 * - Options for bits like 'title' and availability on a country-by-country basis
		 *
		 * @access public
		 * @return void
		 */
		public function admin_options()
		{
			$validation_msg = "";
			$store_valid    = IRD__is_gateway_valid_for_use ($validation_msg);

			// After defining the options, we need to display them too; thats where this next function comes into play:
	    	?>
	    	<h3><?php _e('Iridium Payment', 'woocommerce'); ?></h3>
	    	<p>
	    		<?php _e('Allows WooCommerce to accept payments in Iridium.',
	    				'woocommerce'); ?>
	    	</p>
	    	<?php
	    		echo $store_valid ? ( '<p style="border:5px solid #EC6D00;padding:5px 10px;font-weight:bold;color:#ec6d00;background-color:#ec6d00;">' .
			                          __('Iridium payment gateway is operational','woocommerce') .
			                          '</p>') : ('<p style="border:1px solid #DDD;padding:5px 10px;font-weight:bold;color:#EE0000;background-color:#FFFFAA;">' .
            __('Iridium payment gateway is not operational (try to re-enter and save Iridium Plugin settings): ','woocommerce') . $validation_msg . '</p>');
	    	?>
	    	<table class="form-table">
	    	<?php
	    		// Generate the HTML For the settings form.
	    		$this->generate_settings_html();
	    	?>
			</table><!--/.form-table-->
	    	<?php
	    }
		//-------------------------------------------------------------------

		//-------------------------------------------------------------------
	  // Hook into admin options saving.
    public function process_admin_options()
    {
    	// Call parent
    	parent::process_admin_options();

      return;
    }
		//-------------------------------------------------------------------

		//-------------------------------------------------------------------
	    /**
	     * Process the payment and return the result
	     *
	     * @access public
	     * @param int $order_id
	     * @return array
	     */
		function process_payment ($order_id)
		{
      $IRD_settings = IRD__get_settings ();
			$order = new WC_Order ($order_id);

			// TODO: Implement CRM features within store admin dashboard
			$order_meta = array();
			$order_meta['IRD_order'] = $order;
			$order_meta['IRD_items'] = $order->get_items();
			$order_meta['IRD_b_addr'] = $order->get_formatted_billing_address();
			$order_meta['IRD_s_addr'] = $order->get_formatted_shipping_address();
			$order_meta['IRD_b_email'] = $order->billing_email;
			$order_meta['IRD_currency'] = $order->order_currency;
			$order_meta['IRD_settings'] = $IRD_settings;
			$order_meta['IRD_store'] = plugins_url ('' , __FILE__);


			//-----------------------------------
			// Save Iridium payment info together with the order.
			// Note: this code must be on top here, as other filters will be called from here and will use these values ...
			//
			// Calculate realtime Iridium price (if exchange is necessary)

			$exchange_rate = IRD__get_exchange_rate_per_Iridium (get_woocommerce_currency(), 'getfirst');
			/// $exchange_rate = IRD__get_exchange_rate_per_Iridium (get_woocommerce_currency(), $this->exchange_rate_retrieval_method, $this->exchange_rate_type);
			if (!$exchange_rate)
			{
				$msg = 'ERROR: Cannot determine Iridium exchange rate. Possible issues: store server does not allow outgoing connections, exchange rate servers are blocking incoming connections or down. ' .
					   'You may avoid that by setting store currency directly to Iridium(IRD)';
      			IRD__log_event (__FILE__, __LINE__, $msg);
      			exit ('<h2 style="color:red;">' . $msg . '</h2>');
			}

			$order_total_in_IRD   = ($order->get_total() / $exchange_rate);
			if (get_woocommerce_currency() != 'IRD')
				// @TODO Apply exchange rate multiplier only for stores with non-Iridium default currency.
				$order_total_in_IRD = $order_total_in_IRD;

			$order_total_in_IRD   = sprintf ("%.2f", $order_total_in_IRD); // round price to 2 Decimal Places

  		$Iridium_address = false;

  		$order_info =
  			array (
  				'order_meta'							=> $order_meta,
  				'order_id'								=> $order_id,
  				'order_total'			    	 	=> $order_total_in_IRD,  // Order total in IRD
  				'order_datetime'  				=> date('Y-m-d H:i:s T'),
  				'requested_by_ip'					=> @$_SERVER['REMOTE_ADDR'],
  				'requested_by_ua'					=> @$_SERVER['HTTP_USER_AGENT'],
  				'requested_by_srv'				=> IRD__base64_encode(serialize($_SERVER)),
  				);

  		$ret_info_array = array();

			   $walletd_api = $IRD_settings['walletd_api'];
               $wallet_api = New ForkNoteWalletd($walletd_api);

               $Iridium_payment_id = IRD__generate_new_Iridium_payment_id($IRD_settings, $order_info);

               $Iridium_address = $IRD_settings['address'];


   			IRD__log_event (__FILE__, __LINE__, "     Generated unique Iridium Payment ID: '{$Iridium_payment_id}' Address: '{$Iridium_address}' for order_id " . $order_id);

     	update_post_meta (
     		$order_id, 			// post id ($order_id)
     		'order_total_in_IRD', 	// meta key
     		$order_total_in_IRD 	// meta value. If array - will be auto-serialized
     		);
     	update_post_meta (
     		$order_id, 			// post id ($order_id)
     		'Iridium_payment_id',	// meta key
     		$Iridium_payment_id 	// meta value. If array - will be auto-serialized
     		);
     	update_post_meta (
     		$order_id, 			// post id ($order_id)
     		'Iridium_address',	// meta key
     		$Iridium_address 	// meta value. If array - will be auto-serialized
     		);
     	update_post_meta (
     		$order_id, 			// post id ($order_id)
     		'Iridium_paid_total',	// meta key
     		"0" 	// meta value. If array - will be auto-serialized
     		);
     	update_post_meta (
     		$order_id, 			// post id ($order_id)
     		'Iridium_refunded',	// meta key
     		"0" 	// meta value. If array - will be auto-serialized
     		);
     	update_post_meta (
     		$order_id, 				// post id ($order_id)
     		'_incoming_payments',	// meta key. Starts with '_' - hidden from UI.
     		array()					// array (array('datetime'=>'', 'from_addr'=>'', 'amount'=>''),)
     		);
     	update_post_meta (
     		$order_id, 				// post id ($order_id)
     		'_payment_completed',	// meta key. Starts with '_' - hidden from UI.
     		0					// array (array('datetime'=>'', 'from_addr'=>'', 'amount'=>''),)
     		);
			//-----------------------------------


			// The Iridium gateway does not take payment immediately, but it does need to change the orders status to on-hold
			// (so the store owner knows that Iridium payment is pending).
			// We also need to tell WooCommerce that it needs to redirect to the thankyou page – this is done with the returned array
			// and the result being a success.
			//
			global $woocommerce;

			//	Updating the order status:

			// Mark as on-hold (we're awaiting for Iridiums payment to arrive)
			$order->update_status('on-hold', __('Awaiting Iridium payment to arrive', 'woocommerce'));

/*
			///////////////////////////////////////
			// timbowhite's suggestion:
			// -----------------------
			// Mark as pending (we're awaiting for Iridiums payment to arrive), not 'on-hold' since
			// woocommerce does not automatically cancel expired on-hold orders. Woocommerce handles holding the stock
		    // for pending orders until order payment is complete.
			$order->update_status('pending', __('Awaiting Iridium payment to arrive', 'woocommerce'));

			// Me: 'pending' does not trigger "Thank you" page and neither email sending. Not sure why.
			//			Also - I think cancellation of unpaid orders needs to be initiated from cron job, as only we know when order needs to be cancelled,
			//			by scanning "on-hold" orders through 'assigned_address_expires_in_mins' timeout check.
			///////////////////////////////////////
*/
			// Remove cart
			$woocommerce->cart->empty_cart();

			// Empty awaiting payment session
			unset($_SESSION['order_awaiting_payment']);

			// Return thankyou redirect
			if (version_compare (WOOCOMMERCE_VERSION, '2.1', '<'))
			{
				return array(
					'result' 	=> 'success',
					'redirect'	=> add_query_arg('key', $order->order_key, add_query_arg('order', $order_id, get_permalink(woocommerce_get_page_id('thanks'))))
				);
			}
			else
			{
				return array(
						'result' 	=> 'success',
						'redirect'	=> add_query_arg('key', $order->order_key, add_query_arg('order', $order_id, $this->get_return_url( $order )))
					);
			}
		}
		//-------------------------------------------------------------------

		//-------------------------------------------------------------------
	    /**
	     * Output for the order received page.
	     *
	     * @access public
	     * @return void
	     */
		function IRD__thankyou_page($order_id)
		{
			// IRD__thankyou_page is hooked into the "thank you" page and in the simplest case can just echo’s the description.

			// Get order object.
			// http://wcdocs.woothemes.com/apidocs/class-WC_Order.html
			$order = new WC_Order($order_id);

			// Assemble detailed instructions.
			$order_total_in_IRD = get_post_meta($order->id, 'order_total_in_IRD',   true); // set single to true to receive properly unserialized array
			$Iridium_payment_id = get_post_meta($order->id, 'Iridium_payment_id', true); // set single to true to receive properly unserialized array
			$Iridium_address = get_post_meta($order->id, 'Iridium_address', true); // set single to true to receive properly unserialized array


			$instructions = $this->instructions;
			$instructions = str_replace ('{{{IRDCOINS_AMOUNT}}}',  $order_total_in_IRD, $instructions);
			$instructions = str_replace ('{{{IRDCOINS_PAYMENTID}}}', $Iridium_payment_id, 	$instructions);
			$instructions = str_replace ('{{{IRDCOINS_ADDRESS}}}', $Iridium_address, 	$instructions);
			$instructions =
				str_replace (
					'{{{EXTRA_INSTRUCTIONS}}}',

					$this->instructions_multi_payment_str,
					$instructions
					);
            $order->add_order_note( __("Order instructions: price: {$order_total_in_IRD} IRD, incoming account: {$Iridium_address} payment id: {$Iridium_payment_id}", 'woocommerce'));

	        echo wpautop (wptexturize ($instructions));
		}
		//-------------------------------------------------------------------

		//-------------------------------------------------------------------
	    /**
	     * Add content to the WC emails.
	     *
	     * @access public
	     * @param WC_Order $order
	     * @param bool $sent_to_admin
	     * @return void
	     */
		function IRD__email_instructions ($order, $sent_to_admin)
		{
	    	if ($sent_to_admin) return;
	    	if (!in_array($order->status, array('pending', 'on-hold'), true)) return;
	    	if ($order->payment_method !== 'Iridium') return;

	    	// Assemble payment instructions for email
			$order_total_in_IRD = get_post_meta($order->id, 'order_total_in_IRD',   true); // set single to true to receive properly unserialized array
			$Iridium_payment_id = get_post_meta($order->id, 'Iridium_payment_id', true); // set single to true to receive properly unserialized array
			$Iridium_address = get_post_meta($order->id, 'Iridium_address', true); // set single to true to receive properly unserialized array


			$instructions = $this->instructions;
			$instructions = str_replace ('{{{IRDCOINS_AMOUNT}}}',  $order_total_in_IRD, 	$instructions);
			$instructions = str_replace ('{{{IRDCOINS_PAYMENTID}}}', $Iridium_payment_id, 	$instructions);
			$instructions = str_replace ('{{{IRDCOINS_ADDRESS}}}', $Iridium_address, 	$instructions);
			$instructions =
				str_replace (
					'{{{EXTRA_INSTRUCTIONS}}}',

					$this->instructions_multi_payment_str,
					$instructions
					);

			echo wpautop (wptexturize ($instructions));
		}
		//-------------------------------------------------------------------

	}
	//=======================================================================


	//-----------------------------------------------------------------------
	// Hook into WooCommerce - add necessary hooks and filters
	add_filter ('woocommerce_payment_gateways', 	'IRD__add_Iridium_gateway' );

	// Disable unnecessary billing fields.
	/// Note: it affects whole store.
	/// add_filter ('woocommerce_checkout_fields' , 	'IRD__woocommerce_checkout_fields' );

	add_filter ('woocommerce_currencies', 			'IRD__add_IRD_currency');
	add_filter ('woocommerce_currency_symbol', 		'IRD__add_IRD_currency_symbol', 10, 2);

	// Change [Order] button text on checkout screen.
    /// Note: this will affect all payment methods.
    /// add_filter ('woocommerce_order_button_text', 	'IRD__order_button_text');
	//-----------------------------------------------------------------------

	//=======================================================================
	/**
	 * Add the gateway to WooCommerce
	 *
	 * @access public
	 * @param array $methods
	 * @package
	 * @return array
	 */
	function IRD__add_Iridium_gateway( $methods )
	{
		$methods[] = 'IRD_Iridium';
		return $methods;
	}
	//=======================================================================

	//=======================================================================
	// Our hooked in function - $fields is passed via the filter!
	function IRD__woocommerce_checkout_fields ($fields)
	{
	     unset($fields['order']['order_comments']);
	     unset($fields['billing']['billing_first_name']);
	     unset($fields['billing']['billing_last_name']);
	     unset($fields['billing']['billing_company']);
	     unset($fields['billing']['billing_address_1']);
	     unset($fields['billing']['billing_address_2']);
	     unset($fields['billing']['billing_city']);
	     unset($fields['billing']['billing_postcode']);
	     unset($fields['billing']['billing_country']);
	     unset($fields['billing']['billing_state']);
	     unset($fields['billing']['billing_phone']);
	     return $fields;
	}
	//=======================================================================

	//=======================================================================
	function IRD__add_IRD_currency($currencies)
	{
	     $currencies['IRD'] = __( 'Iridium', 'woocommerce' );
	     return $currencies;
	}
	//=======================================================================

	//=======================================================================
	function IRD__add_IRD_currency_symbol($currency_symbol, $currency)
	{
		switch( $currency )
		{
			case 'IRD':
				$currency_symbol = '$IRD'; // ฿
				break;
		}

		return $currency_symbol;
	}
	//=======================================================================

	//=======================================================================
 	function IRD__order_button_text () { return 'Continue'; }
	//=======================================================================
}
//###########################################################################

//===========================================================================
function IRD__process_payment_completed_for_order ($order_id, $Iridiums_paid=false)
{

	if ($Iridiums_paid)
		update_post_meta ($order_id, 'Iridium_paid_total', $Iridiums_paid);

	// Payment completed
	// Make sure this logic is done only once, in case customer keeps sending payments :)
	if (!get_post_meta($order_id, '_payment_completed', true))
	{
		update_post_meta ($order_id, '_payment_completed', '1');

		IRD__log_event (__FILE__, __LINE__, "Success: order '{$order_id}' paid in full. Processing and notifying customer ...");

		// Instantiate order object.
		$order = new WC_Order($order_id);
		$order->add_order_note( __('Order paid in full', 'woocommerce') );

	  $order->payment_complete();

    $IRD_settings = IRD__get_settings();
		if ($IRD_settings['autocomplete_paid_orders'])
		{
  		// Ensure order is completed.
			$order->update_status('completed', __('Order marked as completed according to Iridium plugin settings', 'woocommerce'));
		}

		// Notify admin about payment processed
		$email = get_settings('admin_email');
		if (!$email)
		  $email = get_option('admin_email');
		if ($email)
		{
			// Send email from admin to admin
			IRD__send_email ($email, $email, "Full payment received for order ID: '{$order_id}'",
				"Order ID: '{$order_id}' paid in full. <br />Received IRD: '$Iridiums_paid'.<br />Please process and complete order for customer."
				);
		}
	}
}
//===========================================================================