<?php
/**
 * Order Class
 *
 * The JigoShop order class handles order data.
 *
 * DISCLAIMER
 *
 * Do not edit or add directly to this file if you wish to upgrade Jigoshop to newer
 * versions in the future. If you wish to customise Jigoshop core for your needs,
 * please use our GitHub repository to publish essential changes for consideration.
 *
 * @package		Jigoshop
 * @category	Customer
 * @author		Jigowatt
 * @copyright	Copyright (c) 2011-2012 Jigowatt Ltd.
 * @license		http://jigoshop.com/license/commercial-edition
 */
class jigoshop_order {

	public $_data = array();

	public function __get($variable) {
		return isset($this->_data[$variable]) ? $this->_data[$variable] : null;
	}

	public function __set($variable, $value) {
		$this->_data[$variable] = $value;
	}

	/** Get the order if ID is passed, otherwise the order is new and empty */
	function jigoshop_order( $id='' ) {
		if ($id>0) apply_filters('jigoshop_get_order', $this->get_order( $id ), $id);
	}

	/** Gets an order from the database */
	function get_order( $id = 0 ) {
		if (!$id) return false;
		if ($result = get_post( $id )) :
			$this->populate( $result );
			return true;
		endif;
		return false;
	}

	/** Populates an order from the loaded post data */
	function populate( $result ) {

		// Standard post data
		$this->id = $result->ID;
		$this->order_date = $result->post_date;
		$this->modified_date = $result->post_modified;
		$this->customer_note = $result->post_excerpt;


		// Custom field data
		$this->order_key			= (string) get_post_meta( $this->id, 'order_key', true );
		$this->user_id 				= (int) get_post_meta( $this->id, 'customer_user', true );
		$this->items 				= (array) get_post_meta( $this->id, 'order_items', true );
		$this->order_data			= (array) maybe_unserialize( get_post_meta( $this->id, 'order_data', true ) );

		$this->billing_first_name 	= (string) $this->get_value_from_data('billing_first_name');
		$this->billing_last_name 	= (string) $this->get_value_from_data('billing_last_name');
		$this->billing_company	 	= (string) $this->get_value_from_data('billing_company');
		$this->billing_address_1 	= (string) $this->get_value_from_data('billing_address_1');
		$this->billing_address_2 	= (string) $this->get_value_from_data('billing_address_2');
		$this->billing_city 		= (string) $this->get_value_from_data('billing_city');
		$this->billing_postcode 	= (string) $this->get_value_from_data('billing_postcode');
		$this->billing_country 		= (string) $this->get_value_from_data('billing_country');
		$this->billing_state 		= (string) $this->get_value_from_data('billing_state');
		$this->billing_email 		= (string) $this->get_value_from_data('billing_email');
		$this->billing_phone 		= (string) $this->get_value_from_data('billing_phone');
		$this->shipping_first_name 	= (string) $this->get_value_from_data('shipping_first_name');
		$this->shipping_last_name	= (string) $this->get_value_from_data('shipping_last_name');
		$this->shipping_company 	= (string) $this->get_value_from_data('shipping_company');
		$this->shipping_address_1 	= (string) $this->get_value_from_data('shipping_address_1');
		$this->shipping_address_2 	= (string) $this->get_value_from_data('shipping_address_2');
		$this->shipping_city 		= (string) $this->get_value_from_data('shipping_city');
		$this->shipping_postcode 	= (string) $this->get_value_from_data('shipping_postcode');
		$this->shipping_country 	= (string) $this->get_value_from_data('shipping_country');
		$this->shipping_state 		= (string) $this->get_value_from_data('shipping_state');

		$this->shipping_method 		= (string) $this->get_value_from_data('shipping_method');
		$this->shipping_method_title= (string) $this->get_value_from_data('shipping_method_title');
		$this->shipping_service		= (string) $this->get_value_from_data('shipping_service');

		$this->payment_method 		= (string) $this->get_value_from_data('payment_method');
		$this->payment_method_title = (string) $this->get_value_from_data('payment_method_title');

		$this->order_subtotal 		= (string) $this->get_value_from_data('order_subtotal');
		$this->order_subtotal_inc_tax   = (string) $this->get_value_from_data('order_subtotal_inc_tax');

		$this->order_shipping 		= (string) $this->get_value_from_data('order_shipping');
		$this->order_discount 		= (string) $this->get_value_from_data('order_discount');
        $this->order_discount_coupons = $this->get_value_from_data('order_discount_coupons'); //array
		$this->order_tax 		= $this->get_order_tax_array('order_tax');
		$this->order_shipping_tax	= (string) $this->get_value_from_data('order_shipping_tax');
		$this->order_total 			= (string) $this->get_value_from_data('order_total');

		// Formatted Addresses
		$formatted_address = array();
		$country = ($this->billing_country && isset(jigoshop_countries::$countries[$this->billing_country])) ? jigoshop_countries::$countries[$this->billing_country] : $this->billing_country;
		$address =  array_map('trim', array(
			$this->billing_address_1,
			$this->billing_address_2,
			$this->billing_city,
			$this->billing_state,
			$this->billing_postcode,
			$country
		));
		foreach ($address as $part) if (!empty($part)) $formatted_address[] = $part;
		$this->formatted_billing_address = implode(', ', $formatted_address);

		if ($this->shipping_address_1) :
			$formatted_address = array();
			$country = ($this->shipping_country && isset(jigoshop_countries::$countries[$this->shipping_country])) ? jigoshop_countries::$countries[$this->shipping_country] : $this->shipping_country;
			$address = array_map('trim', array(
				$this->shipping_address_1,
				$this->shipping_address_2,
				$this->shipping_city,
				$this->shipping_state,
				$this->shipping_postcode,
				$country
			));
			foreach ($address as $part) if (!empty($part)) $formatted_address[] = $part;
			$this->formatted_shipping_address = implode(', ', $formatted_address);
		endif;

		// Taxonomy data
		$terms = get_the_terms( $this->id, 'shop_order_status' );
		if (!is_wp_error($terms) && $terms) :
			$term = current($terms);
			$this->status = $term->slug;
		else :
			$this->status = 'pending';
		endif;

	}

        private function get_order_tax_array( $key ) {
            $array_string = $this->get_value_from_data($key);
            $divisor = $this->get_value_from_data('order_tax_divisor');
            return jigoshop_tax::get_taxes_as_array($array_string, $divisor);
        }

	function get_value_from_data( $key ) {
		if (isset($this->order_data[$key])) return $this->order_data[$key]; else return '';
	}

	/** Gets shipping and product tax */
	function get_total_tax() {
        $order_tax = 0;

        if ($this->get_tax_classes() && is_array($this->get_tax_classes())) :

            foreach ($this->get_tax_classes() as $tax_class) :
                $order_tax += $this->order_tax[$tax_class]['amount'];
            endforeach;

        endif;

        return jigoshop_price($order_tax, array('with_currency' => false));
	}

        public function get_tax_classes() {

            return ($this->order_tax && is_array($this->order_tax) ? array_keys($this->order_tax) : array());
        }

        public function tax_class_is_not_compound($tax_class) {
            return !$this->order_tax[$tax_class]['compound'];
        }

        public function get_tax_rate($tax_class) {
            return $this->order_tax[$tax_class]['rate'];
        }

        public function get_tax_amount($tax_class) {
            return jigoshop_price($this->order_tax[$tax_class]['amount']);
        }

        public function get_tax_class_for_display($tax_class) {
            return $this->order_tax[$tax_class]['display'];
        }

        /** Gets subtotal */
	function get_subtotal_to_display() {


			$subtotal = jigoshop_price($this->order_subtotal);

			if ($this->order_tax>0) :
				$subtotal .= __(' <small>(ex. tax)</small>', 'jigoshop');
			endif;

		return $subtotal;
	}

	/** Gets shipping */
	function get_shipping_to_display() {

		if ($this->order_shipping > 0) :

				$shipping = jigoshop_price($this->order_shipping);
				if ($this->order_shipping_tax > 0) : //tax applied to shipping
					if ($this->shipping_service != NULL || $this->shipping_service) :
						$shipping .= sprintf(__(' <small>(ex. tax) %s via %s</small>', 'jigoshop'), ucwords($this->shipping_service), ucwords($this->shipping_method_title));
					else :
						$shipping .= sprintf(__(' <small>(ex. tax) via %s</small>', 'jigoshop'), ucwords($this->shipping_method_title));
					endif;
				else : // when no tax applied to shipping
                    if ($this->shipping_service != NULL || $this->shipping_service) :
                        $shipping .= sprintf(__(' <small>%s via %s</small>', 'jigoshop'), ucwords($this->shipping_service), ucwords($this->shipping_method_title));
                    else :
                        $shipping .= sprintf(__(' <small>via %s</small>', 'jigoshop'), ucwords($this->shipping_method_title));
                    endif;
                endif;

		else :
			$shipping = __('Free!', 'jigoshop');
		endif;

		return $shipping;
	}

	/** Get a product (either product or variation) */
	function get_product_from_item( $item ) {

		if (isset($item['variation_id']) && $item['variation_id']>0) :
			$_product = new jigoshop_product_variation( $item['variation_id'] );
		else :
			$_product = new jigoshop_product( $item['id'] );
		endif;

		return $_product;

	}

	/** Output items for display in emails */
	function email_order_items_list( $show_download_links = false, $show_sku = false ) {

		$return = '';

		foreach($this->items as $item) :

			$_product = $this->get_product_from_item( $item );

			$return .= $item['qty'] . ' x ' . html_entity_decode(apply_filters('jigoshop_order_product_title', $item['name'], $_product), ENT_QUOTES, 'UTF-8');

			if ($show_sku) :

				$return .= ' (#' . $_product->sku . ')';

			endif;

			$return .= ' - ' . html_entity_decode(strip_tags(jigoshop_price( $item['cost']*$item['qty'], array('ex_tax_label' => 1 ))), ENT_COMPAT, 'UTF-8');

			if (isset($_product->variation_data)) :
				$return .= PHP_EOL . jigoshop_get_formatted_variation( $item['variation'], true);
			endif;

			if ($show_download_links) :

				if ($_product->exists) :

					if ($_product->is_type('downloadable')) :
						$return .= PHP_EOL . 'Your download link for this file is:';
						$return .= PHP_EOL . ' - ' . $this->get_downloadable_file_url( $item['id'] ) . '';
					endif;

				endif;

			endif;

			$return .= PHP_EOL;

		endforeach;

		return $return;

	}

	/** Output bank transfer details for display in emails */
	function email_bank_details() {

		$title 			= get_option('jigoshop_bank_transfer_title');
		$description 	= get_option('jigoshop_bank_transfer_description');
		$bank_name 		= get_option('jigoshop_bank_transfer_bank_name');
		$acc_number 	= get_option('jigoshop_bank_transfer_acc_number');
		$sort_code 		= get_option('jigoshop_bank_transfer_sort_code');
		$iban 			= get_option('jigoshop_bank_transfer_iban');
		$bic 			= get_option('jigoshop_bank_transfer_bic');
		$additional 	= get_option('jigoshop_bank_transfer_additional');

		$bank_info = null;
		if ($description) $bank_info .= wpautop(wptexturize($description)) . PHP_EOL;
		if ($bank_name) $bank_info .= __('Bank Name', 'jigoshop').": \t" . wptexturize($bank_name) . PHP_EOL;
		if ($acc_number) $bank_info .= __('Account Number', 'jigoshop').":\t " .wptexturize($acc_number) . PHP_EOL;
		if ($sort_code) $bank_info .= __('Sort Code', 'jigoshop').":\t" . wptexturize($sort_code) . PHP_EOL;
		if ($iban) $bank_info .= __('IBAN', 'jigoshop').": \t\t" .wptexturize($iban) . PHP_EOL;
		if ($bic) $bank_info .= __('BIC', 'jigoshop').": \t\t " .wptexturize($bic) . PHP_EOL;
		if ($additional) $bank_info .= wpautop(__('Additional Information', 'jigoshop').": " . PHP_EOL . wpautop(wptexturize($additional)));

		if ($bank_info)
			return wpautop($bank_info);

	}

	/**  Generates a URL so that a customer can checkout/pay for their (unpaid - pending) order via a link */
	function get_checkout_payment_url() {

		$payment_page = apply_filters('jigoshop_get_checkout_payment_url', get_permalink(jigoshop_get_page_id('pay')));

		if (get_option('jigoshop_force_ssl_checkout')=='yes' || is_ssl()) $payment_page = str_replace('http:', 'https:', $payment_page);

		return add_query_arg('pay_for_order', 'true', add_query_arg('order', $this->order_key, add_query_arg('order_id', $this->id, $payment_page)));
	}


	/** Generates a URL so that a customer can cancel their (unpaid - pending) order */
	function get_cancel_order_url() {
		return apply_filters('jigoshop_get_cancel_order', jigoshop::nonce_url( 'cancel_order', add_query_arg('cancel_order', 'true', add_query_arg('order', $this->order_key, add_query_arg('order_id', $this->id, home_url())))));
	}


	/** Gets a downloadable products file url */
	function get_downloadable_file_url( $item_id ) {

	 	$user_email = $this->billing_email;

		if ($this->user_id>0) :
			$user_info = get_userdata($this->user_id);
			if ($user_info->user_email) :
				$user_email = $user_info->user_email;
			endif;
		endif;

	 	return add_query_arg('download_file', $item_id, add_query_arg('order', $this->order_key, add_query_arg('email', $user_email, home_url())));
	 }

	/**
	 * Adds a note (comment) to the order
	 *
	 * @param   string	$note		Note to add
	 * @param   int		$private	Currently unused
	 */
	function add_order_note( $note, $private = 1 ) {

		$comment = array(
			'comment_post_ID'      => $this->id,
			'comment_author'       => 'Jigoshop',
			'comment_author_email' => null,
			'comment_author_url'   => null,
			'comment_content'      => $note,
			'comment_type'         => 'jigoshop',
			'comment_parent'       => 0,
			'comment_date'         => current_time('mysql'),
			'comment_date_gmt'     => current_time('mysql', 1),
		);

		$comment_id = wp_insert_comment( $comment );
		add_comment_meta($comment_id, 'private', $private);
	}

	/**
	 * Adds a note (comment) to the order
	 *
	 * @param   string	$new_status		Status to change the order to
	 * @param   string	$note			Optional note to add
	 */
	function update_status( $new_status, $note = '' ) {

		if ($note) $note .= ' ';

		$new_status = get_term_by( 'slug', sanitize_title( $new_status ), 'shop_order_status');
		if ($new_status) :

			wp_set_object_terms($this->id, $new_status->slug, 'shop_order_status');

			if ( $this->status != $new_status->slug ) :
				// Status was changed
				do_action( 'order_status_'.$new_status->slug, $this->id );
				do_action( 'order_status_'.$this->status.'_to_'.$new_status->slug, $this->id );
				$this->add_order_note( $note . sprintf( __('Order status changed from %s to %s.', 'jigoshop'), $this->status, $new_status->slug ) );
				clean_term_cache( '', 'shop_order_status' );

				// If completed add completion date to order
				if( $new_status->slug === 'completed' ) {
					update_post_meta( $this->id, '_js_completed_date', current_time('timestamp'));
					$this->add_sale(); // Add the sale to the records
				}
			endif;

		endif;

	}

	/**
	 * Adds a sale to the record
	 *
	 * @return void
	 **/
	function add_sale() {

		if( $this->items ) {
			foreach($this->items as $item) {
				$sales =	absint(get_post_meta($item['id'], 'total_sales', true));
				$sales +=	absint($item['qty']);
				update_post_meta($item['id'], '_js_total_sales', $sales);
			}
		}
	}

	/**
	 * Cancel the order and restore the cart (before payment)
	 *
	 * @param   string	$note	Optional note to add
	 */
	function cancel_order( $note = '' ) {

		unset( jigoshop_session::instance()->order_awaiting_payment );

		$this->update_status('cancelled', $note);

	}

	/**
	 * When a payment is complete this function is called
	 *
	 * Most of the time this should mark an order as 'processing' so that admin can process/post the items
	 * If the cart contains only downloadable items then the order is 'complete' since the admin needs to take no action
	 * Stock levels are reduced at this point
	 */
	function payment_complete() {

		unset( jigoshop_session::instance()->order_awaiting_payment );

		$downloadable_order = false;

		if (sizeof($this->items)>0) foreach ($this->items as $item) :

			if ($item['id']>0) :
				$_product = $this->get_product_from_item( $item );

				if ( $_product->exists && $_product->is_type('downloadable') ) :
					$downloadable_order = true;
					continue;
				endif;

			endif;

			$downloadable_order = false;
			break;

		endforeach;

		if ($downloadable_order) :
			$this->update_status('completed');
		else :
			$this->update_status('processing');
		endif;

		// Payment is complete so reduce stock levels
		$this->reduce_order_stock();

		// Add the sale
		$this->add_sale();

	}

	/**
	 * Reduce stock levels
	 */
	function reduce_order_stock() {

		// Reduce stock levels and do any other actions with products in the cart
		if (sizeof($this->items)>0) foreach ($this->items as $item) :

			if ($item['id']>0) :
				$_product = $this->get_product_from_item( $item );

				if ( $_product->exists && $_product->managing_stock() ) :

					$old_stock = $_product->stock;

					$new_quantity = $_product->reduce_stock( $item['qty'] );

					$this->add_order_note( sprintf( __('Item #%s stock reduced from %s to %s.', 'jigoshop'), $item['id'], $old_stock, $new_quantity) );

					if ($new_quantity<0) :
						do_action('jigoshop_product_on_backorder_notification', $this->id, $item['id'], $item['qty']);
					endif;

					// stock status notifications
                    if (get_option('jigoshop_notify_no_stock_amount') >= 0 && get_option('jigoshop_notify_no_stock_amount') >= $new_quantity) :
						do_action('jigoshop_no_stock_notification', $item['id']);
					elseif (get_option('jigoshop_notify_low_stock_amount') && get_option('jigoshop_notify_low_stock_amount')>=$new_quantity) :
						do_action('jigoshop_low_stock_notification', $item['id']);
					endif;

				endif;

			endif;

		endforeach;

		$this->add_order_note( __('Order item stock reduced successfully.', 'jigoshop') );

	}

}