AyeCode / invoicing

includes/admin/wpinv-admin-functions.php

Indentation +1 added lines, -1 removed lines

@@ -56,7 +56,7 @@
 }
 
 function wpinv_admin_messages() {
-	settings_errors( 'wpinv-notices' );
+    settings_errors( 'wpinv-notices' );
 }
 add_action( 'admin_notices', 'wpinv_admin_messages' );
 

includes/class-getpaid-daily-maintenance.php

Indentation +103 added lines, -103 removed lines

@@ -12,108 +12,108 @@
  */
 class GetPaid_Daily_Maintenance {
 
-	/**
-	 * Class constructor.
-	 */
-	public function __construct(){
-
-		// Clear deprecated events.
-		add_action( 'wp', array( $this, 'maybe_clear_deprecated_events' ) );
-
-		// (Maybe) schedule a cron that runs daily.
-		add_action( 'wp', array( $this, 'maybe_create_scheduled_event' ) );
-
-		// Fired everyday at 7 a.m (this might vary for sites with few visitors)
-		add_action( 'getpaid_daily_maintenance', array( $this, 'log_cron_run' ) );
-		add_action( 'getpaid_daily_maintenance', array( $this, 'backwards_compat' ) );
-		add_action( 'getpaid_daily_maintenance', array( $this, 'maybe_expire_subscriptions' ) );
-		add_action( 'getpaid_daily_maintenance', array( $this, 'maybe_update_geoip_databases' ) );
-
-	}
-
-	/**
-	 * Schedules a cron to run every day at 7 a.m
-	 *
-	 */
-	public function maybe_create_scheduled_event() {
-
-		if ( ! wp_next_scheduled( 'getpaid_daily_maintenance' ) ) {
-			$timestamp = strtotime( 'tomorrow 07:00:00', current_time( 'timestamp' ) );
-			wp_schedule_event( $timestamp, 'daily', 'getpaid_daily_maintenance' );
-		}
-
-	}
-
-	/**
-	 * Clears deprecated events.
-	 *
-	 */
-	public function maybe_clear_deprecated_events() {
-
-		if ( ! get_option( 'wpinv_cleared_old_events' ) ) {
-			wp_clear_scheduled_hook( 'wpinv_register_schedule_event_twicedaily' );
-			wp_clear_scheduled_hook( 'wpinv_register_schedule_event_daily' );
-			update_option( 'wpinv_cleared_old_events', 1 );
-		}
-
-	}
-
-	/**
-	 * Fires the old hook for backwards compatibility.
-	 *
-	 */
-	public function backwards_compat() {
-		do_action( 'wpinv_register_schedule_event_daily' );
-	}
-
-	/**
-	 * Expires expired subscriptions.
-	 *
-	 */
-	public function maybe_expire_subscriptions() {
-
-		// Fetch expired subscriptions (skips those that expire today).
-		$args  = array(
-			'number'             => -1,
-			'count_total'        => false,
-			'status'             => 'trialling active failing cancelled',
-			'date_expires_query' => array(
-				'before'    => 'today',
-				'inclusive' => false,
-			),
-		);
-
-		$subscriptions = new GetPaid_Subscriptions_Query( $args );
-
-		foreach ( $subscriptions->get_results() as $subscription ) {
-			if ( apply_filters( 'getpaid_daily_maintenance_should_expire_subscription', true, $subscription ) ) {
-				$subscription->set_status( 'expired' );
-				$subscription->save();
-			}
-		}
-
-	}
-
-	/**
-	 * Logs cron runs.
-	 *
-	 */
-	public function log_cron_run() {
-		wpinv_error_log( 'GetPaid Daily Cron' );
-	}
-
-	/**
-	 * Updates GeoIP databases.
-	 *
-	 */
-	public function maybe_update_geoip_databases() {
-		$updated = get_transient( 'getpaid_updated_geoip_databases' );
-
-		if ( false === $updated ) {
-			set_transient( 'getpaid_updated_geoip_databases', 1, 15 * DAY_IN_SECONDS );
-			do_action( 'getpaid_update_geoip_databases' );
-		}
-
-	}
+    /**
+     * Class constructor.
+     */
+    public function __construct(){
+
+        // Clear deprecated events.
+        add_action( 'wp', array( $this, 'maybe_clear_deprecated_events' ) );
+
+        // (Maybe) schedule a cron that runs daily.
+        add_action( 'wp', array( $this, 'maybe_create_scheduled_event' ) );
+
+        // Fired everyday at 7 a.m (this might vary for sites with few visitors)
+        add_action( 'getpaid_daily_maintenance', array( $this, 'log_cron_run' ) );
+        add_action( 'getpaid_daily_maintenance', array( $this, 'backwards_compat' ) );
+        add_action( 'getpaid_daily_maintenance', array( $this, 'maybe_expire_subscriptions' ) );
+        add_action( 'getpaid_daily_maintenance', array( $this, 'maybe_update_geoip_databases' ) );
+
+    }
+
+    /**
+     * Schedules a cron to run every day at 7 a.m
+     *
+     */
+    public function maybe_create_scheduled_event() {
+
+        if ( ! wp_next_scheduled( 'getpaid_daily_maintenance' ) ) {
+            $timestamp = strtotime( 'tomorrow 07:00:00', current_time( 'timestamp' ) );
+            wp_schedule_event( $timestamp, 'daily', 'getpaid_daily_maintenance' );
+        }
+
+    }
+
+    /**
+     * Clears deprecated events.
+     *
+     */
+    public function maybe_clear_deprecated_events() {
+
+        if ( ! get_option( 'wpinv_cleared_old_events' ) ) {
+            wp_clear_scheduled_hook( 'wpinv_register_schedule_event_twicedaily' );
+            wp_clear_scheduled_hook( 'wpinv_register_schedule_event_daily' );
+            update_option( 'wpinv_cleared_old_events', 1 );
+        }
+
+    }
+
+    /**
+     * Fires the old hook for backwards compatibility.
+     *
+     */
+    public function backwards_compat() {
+        do_action( 'wpinv_register_schedule_event_daily' );
+    }
+
+    /**
+     * Expires expired subscriptions.
+     *
+     */
+    public function maybe_expire_subscriptions() {
+
+        // Fetch expired subscriptions (skips those that expire today).
+        $args  = array(
+            'number'             => -1,
+            'count_total'        => false,
+            'status'             => 'trialling active failing cancelled',
+            'date_expires_query' => array(
+                'before'    => 'today',
+                'inclusive' => false,
+            ),
+        );
+
+        $subscriptions = new GetPaid_Subscriptions_Query( $args );
+
+        foreach ( $subscriptions->get_results() as $subscription ) {
+            if ( apply_filters( 'getpaid_daily_maintenance_should_expire_subscription', true, $subscription ) ) {
+                $subscription->set_status( 'expired' );
+                $subscription->save();
+            }
+        }
+
+    }
+
+    /**
+     * Logs cron runs.
+     *
+     */
+    public function log_cron_run() {
+        wpinv_error_log( 'GetPaid Daily Cron' );
+    }
+
+    /**
+     * Updates GeoIP databases.
+     *
+     */
+    public function maybe_update_geoip_databases() {
+        $updated = get_transient( 'getpaid_updated_geoip_databases' );
+
+        if ( false === $updated ) {
+            set_transient( 'getpaid_updated_geoip_databases', 1, 15 * DAY_IN_SECONDS );
+            do_action( 'getpaid_update_geoip_databases' );
+        }
+
+    }
 
 }

includes/admin/meta-boxes/class-getpaid-meta-box-invoice-shipping-address.php

Indentation +34 added lines, -34 removed lines

@@ -7,7 +7,7 @@ 
  */
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit; // Exit if accessed directly
+    exit; // Exit if accessed directly
 }
 
 /**
@@ -15,22 +15,22 @@ 
  */
 class GetPaid_Meta_Box_Invoice_Shipping_Address {
 
-	/**
-	 * Output the metabox.
-	 *
-	 * @param WP_Post $post
-	 */
-	public static function output( $post ) {
+    /**
+     * Output the metabox.
+     *
+     * @param WP_Post $post
+     */
+    public static function output( $post ) {
 
-		// Retrieve shipping address.
-		$shipping_address = get_post_meta( $post->ID, 'shipping_address', true );
+        // Retrieve shipping address.
+        $shipping_address = get_post_meta( $post->ID, 'shipping_address', true );
 
-		// Abort if it is invalid.
-		if ( ! is_array( $shipping_address ) ) {
-			return;
-		}
+        // Abort if it is invalid.
+        if ( ! is_array( $shipping_address ) ) {
+            return;
+        }
 
-		?>
+        ?>
 
 		<div class="bsui">
 
@@ -55,31 +55,31 @@ 
 
 		<?php
 
-	}
+    }
 
-	/**
-	 * Prepares a value.
-	 *
-	 * @param array $address
-	 * @param string $key
-	 * @return string
-	 */
-	public static function prepare_for_display( $address, $key ) {
+    /**
+     * Prepares a value.
+     *
+     * @param array $address
+     * @param string $key
+     * @return string
+     */
+    public static function prepare_for_display( $address, $key ) {
 
-		// Prepare the value.
-		$value = $address[ $key ];
+        // Prepare the value.
+        $value = $address[ $key ];
 
-		if ( $key == 'country' ) {
-			$value = wpinv_country_name( $value );
-		}
+        if ( $key == 'country' ) {
+            $value = wpinv_country_name( $value );
+        }
 
-		if ( $key == 'state' ) {
-			$country = isset( $address[ 'country' ] ) ? $address[ 'country' ] : wpinv_get_default_country();
-			$value = wpinv_state_name( $value, $country );
-		}
+        if ( $key == 'state' ) {
+            $country = isset( $address[ 'country' ] ) ? $address[ 'country' ] : wpinv_get_default_country();
+            $value = wpinv_state_name( $value, $country );
+        }
 
-		return sanitize_text_field( $value );
+        return sanitize_text_field( $value );
 
-	}
+    }
 
 }

includes/class-getpaid-notification-email-sender.php

Indentation +134 added lines, -134 removed lines

@@ -13,17 +13,17 @@ 
 class GetPaid_Notification_Email_Sender {
 
     /**
-	 * Whether or not we should inline CSS into the email.
-	 */
-	public $inline_css = true;
+     * Whether or not we should inline CSS into the email.
+     */
+    public $inline_css = true;
 
     /**
-	 * The wp_mail() data.
-	 */
+     * The wp_mail() data.
+     */
     public $wp_mail_data = null;
 
     /**
-	 * Sends a new email.
+     * Sends a new email.
      * 
      * @param string|array $to The recipients email or an array of recipient emails.
      * @param string $subject The email's subject.
@@ -31,49 +31,49 @@ 
      * @param array $attachments The email attachments.
      * 
      * @return bool
-	 */
-	public function send( $to, $subject, $email, $attachments = array() ) {
+     */
+    public function send( $to, $subject, $email, $attachments = array() ) {
 
-		/*
+        /*
 		 * Allow to filter data on per-email basis.
 		 */
-		$data = apply_filters(
-			'getpaid_email_data',
-			array(
-				'to'          => array_filter( array_unique( wpinv_parse_list( $to ) ) ),
-				'subject'     => htmlspecialchars_decode( strip_tags( $subject ), ENT_QUOTES ),
-				'email'       => apply_filters( 'wpinv_mail_content', $email ),
-				'headers'     => $this->get_headers(),
-				'attachments' => $attachments,
-			),
-			$this
-		);
+        $data = apply_filters(
+            'getpaid_email_data',
+            array(
+                'to'          => array_filter( array_unique( wpinv_parse_list( $to ) ) ),
+                'subject'     => htmlspecialchars_decode( strip_tags( $subject ), ENT_QUOTES ),
+                'email'       => apply_filters( 'wpinv_mail_content', $email ),
+                'headers'     => $this->get_headers(),
+                'attachments' => $attachments,
+            ),
+            $this
+        );
 
         // Remove slashes.
         $data               = (array) wp_unslash( $data );
 
         // Cache it.
-		$this->wp_mail_data = $data;
+        $this->wp_mail_data = $data;
 
-		// Attach our own hooks.
-		$this->before_sending();
+        // Attach our own hooks.
+        $this->before_sending();
 
         $result = false;
 
         foreach ( $this->wp_mail_data['to'] as $to ) {
-			$result = $this->_send( $to, $data );
+            $result = $this->_send( $to, $data );
         }
 
-		// Remove our hooks.
-		$this->after_sending();		
+        // Remove our hooks.
+        $this->after_sending();		
 
-		$this->wp_mail_data = null;
+        $this->wp_mail_data = null;
 
-		return $result;
-	}
+        return $result;
+    }
 
-	/**
-	 * Does the actual sending.
+    /**
+     * Does the actual sending.
      * 
      * @param string $to The recipient's email.
      * @param array $data The email's data.
@@ -81,81 +81,81 @@ 
      * @param array $attachments The email attachments.
      * 
      * @return bool
-	 */
-	protected function _send( $to, $data ) {
-
-		// Prepare the sending function.
-		$sending_function = apply_filters( 'getpaid_email_email_sending_function', 'wp_mail' );
-
-		// Send the actual email.
-		$result = call_user_func(
-			$sending_function,
-			$to,
-			html_entity_decode( $data['subject'], ENT_QUOTES, get_bloginfo( 'charset' ) ),
-			$data['email'],
-			$data['headers'],
-			$data['attachments']
-		);
-
-		if ( ! $result ) {
-			$log_message = wp_sprintf( __( "\nTime: %s\nTo: %s\nSubject: %s\n", 'invoicing' ), date_i18n( 'F j Y H:i:s', current_time( 'timestamp' ) ), $to, $data['subject'] );
-			wpinv_error_log( $log_message, __( 'Email from Invoicing plugin failed to send', 'invoicing' ), __FILE__, __LINE__ );
-		}
-
-		return $result;
-	}
+     */
+    protected function _send( $to, $data ) {
+
+        // Prepare the sending function.
+        $sending_function = apply_filters( 'getpaid_email_email_sending_function', 'wp_mail' );
+
+        // Send the actual email.
+        $result = call_user_func(
+            $sending_function,
+            $to,
+            html_entity_decode( $data['subject'], ENT_QUOTES, get_bloginfo( 'charset' ) ),
+            $data['email'],
+            $data['headers'],
+            $data['attachments']
+        );
+
+        if ( ! $result ) {
+            $log_message = wp_sprintf( __( "\nTime: %s\nTo: %s\nSubject: %s\n", 'invoicing' ), date_i18n( 'F j Y H:i:s', current_time( 'timestamp' ) ), $to, $data['subject'] );
+            wpinv_error_log( $log_message, __( 'Email from Invoicing plugin failed to send', 'invoicing' ), __FILE__, __LINE__ );
+        }
+
+        return $result;
+    }
     
     /**
-	 * Retrieves email headers.
-	 */
-	public function get_headers() {
+     * Retrieves email headers.
+     */
+    public function get_headers() {
 
-		$name       = $this->get_from_name();
-		$reply_to   = $this->get_reply_to();
-		$headers    = array( "Reply-To:$name <$reply_to>" );
+        $name       = $this->get_from_name();
+        $reply_to   = $this->get_reply_to();
+        $headers    = array( "Reply-To:$name <$reply_to>" );
 
-		return apply_filters( 'getpaid_email_headers',  $headers, $this );
+        return apply_filters( 'getpaid_email_headers',  $headers, $this );
 
-	}
+    }
 
     /**
-	 * Fires before an email is sent
-	 *
-	 * @since 1.0.0
-	 */
-	public function before_sending() {
+     * Fires before an email is sent
+     *
+     * @since 1.0.0
+     */
+    public function before_sending() {
 
         do_action( 'getpaid_before_send_email', $this );
-		add_filter( 'wp_mail_from', array( $this, 'get_from_address' ), 1000 );
-		add_filter( 'wp_mail_from_name', array( $this, 'get_from_name' ), 1000 );
-		add_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ), 1000 );
-		add_filter( 'wp_mail', array( $this, 'ensure_email_content' ), 1000 );
+        add_filter( 'wp_mail_from', array( $this, 'get_from_address' ), 1000 );
+        add_filter( 'wp_mail_from_name', array( $this, 'get_from_name' ), 1000 );
+        add_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ), 1000 );
+        add_filter( 'wp_mail', array( $this, 'ensure_email_content' ), 1000 );
 
-	}
+    }
 
     /**
-	 * Returns the from name.
-	 */
-	public function get_from_name() {
+     * Returns the from name.
+     */
+    public function get_from_name() {
 
         $from_name = wpinv_get_option( 'email_from_name', get_bloginfo( 'name' ) );
 
-		if ( empty( $from_name ) ) {
-			$from_name =  get_bloginfo( 'name' );
+        if ( empty( $from_name ) ) {
+            $from_name =  get_bloginfo( 'name' );
         }
 
-		return wp_specialchars_decode( $from_name, ENT_QUOTES );
+        return wp_specialchars_decode( $from_name, ENT_QUOTES );
     }
 
     /**
-	 * Returns the from email.
-	 */
-	public function get_from_address() {
+     * Returns the from email.
+     */
+    public function get_from_address() {
 
         $from_address = wpinv_get_option( 'email_from', $this->default_from_address() );
 
-		if ( ! is_email( $from_address ) ) {
-			$from_address =  $this->default_from_address();
+        if ( ! is_email( $from_address ) ) {
+            $from_address =  $this->default_from_address();
         }
         
         return $from_address;
@@ -163,75 +163,75 @@ 
     }
 
     /**
-	 * The default emails from address.
-	 * 
-	 * Defaults to wordpress@$sitename
-	 * Some hosts will block outgoing mail from this address if it doesn't exist,
-	 * but there's no easy alternative. Defaulting to admin_email might appear to be
-	 * another option, but some hosts may refuse to relay mail from an unknown domain.
-	 *
-	 */
-	public function default_from_address() {
-
-		// Get the site domain and get rid of www.
-		$sitename = strtolower( $_SERVER['SERVER_NAME'] );
-		if ( substr( $sitename, 0, 4 ) == 'www.' ) {
-			$sitename = substr( $sitename, 4 );
-		}
-
-		$from_email = 'wordpress@' . $sitename;
-
-		return apply_filters( 'getpaid_default_from_address', $from_email );
+     * The default emails from address.
+     * 
+     * Defaults to wordpress@$sitename
+     * Some hosts will block outgoing mail from this address if it doesn't exist,
+     * but there's no easy alternative. Defaulting to admin_email might appear to be
+     * another option, but some hosts may refuse to relay mail from an unknown domain.
+     *
+     */
+    public function default_from_address() {
+
+        // Get the site domain and get rid of www.
+        $sitename = strtolower( $_SERVER['SERVER_NAME'] );
+        if ( substr( $sitename, 0, 4 ) == 'www.' ) {
+            $sitename = substr( $sitename, 4 );
+        }
+
+        $from_email = 'wordpress@' . $sitename;
+
+        return apply_filters( 'getpaid_default_from_address', $from_email );
 
     }
     
     /**
-	 * Get the email reply-to.
-	 *
-	 *
-	 * @return string The email reply-to address.
-	 */
-	public function get_reply_to() {
+     * Get the email reply-to.
+     *
+     *
+     * @return string The email reply-to address.
+     */
+    public function get_reply_to() {
 
-		$reply_to = wpinv_get_admin_email();
+        $reply_to = wpinv_get_admin_email();
 
-		if ( ! is_email( $reply_to ) ) {
-			$reply_to =  get_option( 'admin_email' );
-		}
+        if ( ! is_email( $reply_to ) ) {
+            $reply_to =  get_option( 'admin_email' );
+        }
 
-		return $reply_to;
+        return $reply_to;
     }
     
     /**
-	 * Get the email content type.
-	 *
-	 */
-	public function get_content_type() {
-		return apply_filters( 'getpaid_email_content_type', 'text/html', $this );
+     * Get the email content type.
+     *
+     */
+    public function get_content_type() {
+        return apply_filters( 'getpaid_email_content_type', 'text/html', $this );
     }
     
     /**
-	 * Ensures that our email messages are not messed up by template plugins.
-	 *
-	 * @return array wp_mail_data.
-	 */
-	public function ensure_email_content( $args ) {
-		$args['message'] = $this->wp_mail_data['email'];
-		return $args;
+     * Ensures that our email messages are not messed up by template plugins.
+     *
+     * @return array wp_mail_data.
+     */
+    public function ensure_email_content( $args ) {
+        $args['message'] = $this->wp_mail_data['email'];
+        return $args;
     }
     
     /**
-	 * A little house keeping after an email is sent.
-	 *
- 	 */
-	public function after_sending() {
+     * A little house keeping after an email is sent.
+     *
+     */
+    public function after_sending() {
 
         do_action( 'getpaid_after_send_email', $this->wp_mail_data );
-		remove_filter( 'wp_mail_from', array( $this, 'get_from_address' ), 1000 );
-		remove_filter( 'wp_mail_from_name', array( $this, 'get_from_name' ), 1000 );
-		remove_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ), 1000 );
-		remove_filter( 'wp_mail', array( $this, 'ensure_email_content' ), 1000000 );
+        remove_filter( 'wp_mail_from', array( $this, 'get_from_address' ), 1000 );
+        remove_filter( 'wp_mail_from_name', array( $this, 'get_from_name' ), 1000 );
+        remove_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ), 1000 );
+        remove_filter( 'wp_mail', array( $this, 'ensure_email_content' ), 1000000 );
 
-	}
+    }
 
 }

includes/reports/class-getpaid-reports-abstract-report.php

Indentation +179 added lines, -179 removed lines

@@ -12,72 +12,72 @@ 
  */
 abstract class GetPaid_Reports_Abstract_Report {
 
-	/**
-	 * @var array
-	 */
-	public $stats;
-
-	/**
-	 * Class constructor.
-	 *
-	 */
-	public function __construct() {
-		$this->prepare_stats();
-	}
-
-	/**
-	 * Retrieves the current range.
-	 *
-	 */
-	public function get_range() {
-		$valid_ranges = $this->get_periods();
-
-		if ( isset( $_GET['date_range'] ) && array_key_exists( $_GET['date_range'], $valid_ranges ) ) {
-			return sanitize_key( $_GET['date_range'] );
-		}
-
-		return '7_days';
-	}
-
-	/**
-	 * Returns an array of date ranges.
-	 *
-	 * @return array
-	 */
-	public function get_periods() {
-
-		$periods = array(
+    /**
+     * @var array
+     */
+    public $stats;
+
+    /**
+     * Class constructor.
+     *
+     */
+    public function __construct() {
+        $this->prepare_stats();
+    }
+
+    /**
+     * Retrieves the current range.
+     *
+     */
+    public function get_range() {
+        $valid_ranges = $this->get_periods();
+
+        if ( isset( $_GET['date_range'] ) && array_key_exists( $_GET['date_range'], $valid_ranges ) ) {
+            return sanitize_key( $_GET['date_range'] );
+        }
+
+        return '7_days';
+    }
+
+    /**
+     * Returns an array of date ranges.
+     *
+     * @return array
+     */
+    public function get_periods() {
+
+        $periods = array(
             'today'     => __( 'Today', 'invoicing' ),
             'yesterday' => __( 'Yesterday', 'invoicing' ),
             '7_days'    => __( 'Last 7 days', 'invoicing' ),
-			'30_days'   => __( 'Last 30 days', 'invoicing' ),
-			'60_days'   => __( 'Last 60 days', 'invoicing' ),
-			'90_days'   => __( 'Last 90 days', 'invoicing' ),
-			'180_days'  => __( 'Last 180 days', 'invoicing' ),
-			'360_days'  => __( 'Last 360 days', 'invoicing' ),
-		);
-
-		return apply_filters( 'getpaid_earning_periods', $periods );
-	}
-
-	/**
-	 * Retrieves the current range's sql.
-	 *
-	 */
-	public function get_range_sql( $range ) {
-
-		$date     = 'CAST(meta.completed_date AS DATE)';
+            '30_days'   => __( 'Last 30 days', 'invoicing' ),
+            '60_days'   => __( 'Last 60 days', 'invoicing' ),
+            '90_days'   => __( 'Last 90 days', 'invoicing' ),
+            '180_days'  => __( 'Last 180 days', 'invoicing' ),
+            '360_days'  => __( 'Last 360 days', 'invoicing' ),
+        );
+
+        return apply_filters( 'getpaid_earning_periods', $periods );
+    }
+
+    /**
+     * Retrieves the current range's sql.
+     *
+     */
+    public function get_range_sql( $range ) {
+
+        $date     = 'CAST(meta.completed_date AS DATE)';
         $datetime = 'meta.completed_date';
 
         // Prepare durations.
         $today                = current_time( 'Y-m-d' );
-		$yesterday            = date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) );
-		$seven_days_ago       = date( 'Y-m-d', strtotime( '-7 days', current_time( 'timestamp' ) ) );
-		$thirty_days_ago      = date( 'Y-m-d', strtotime( '-30 days', current_time( 'timestamp' ) ) );
-		$ninety_days_ago      = date( 'Y-m-d', strtotime( '-90 days', current_time( 'timestamp' ) ) );
-		$sixty_days_ago       = date( 'Y-m-d', strtotime( '-60 days', current_time( 'timestamp' ) ) );
-		$one_eighty_days_ago  = date( 'Y-m-d', strtotime( '-180 days', current_time( 'timestamp' ) ) );
-		$three_sixty_days_ago = date( 'Y-m-d', strtotime( '-360 days', current_time( 'timestamp' ) ) );
+        $yesterday            = date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) );
+        $seven_days_ago       = date( 'Y-m-d', strtotime( '-7 days', current_time( 'timestamp' ) ) );
+        $thirty_days_ago      = date( 'Y-m-d', strtotime( '-30 days', current_time( 'timestamp' ) ) );
+        $ninety_days_ago      = date( 'Y-m-d', strtotime( '-90 days', current_time( 'timestamp' ) ) );
+        $sixty_days_ago       = date( 'Y-m-d', strtotime( '-60 days', current_time( 'timestamp' ) ) );
+        $one_eighty_days_ago  = date( 'Y-m-d', strtotime( '-180 days', current_time( 'timestamp' ) ) );
+        $three_sixty_days_ago = date( 'Y-m-d', strtotime( '-360 days', current_time( 'timestamp' ) ) );
 
         $ranges = array(
 
@@ -94,130 +94,130 @@ 
             '7_days'       => array(
                 "DATE($datetime)",
                 "$date BETWEEN '$seven_days_ago' AND '$today'"
-			),
+            ),
 
-			'30_days'       => array(
+            '30_days'       => array(
                 "DATE($datetime)",
                 "$date BETWEEN '$thirty_days_ago' AND '$today'"
-			),
+            ),
 
-			'60_days'       => array(
+            '60_days'       => array(
                 "DATE($datetime)",
                 "$date BETWEEN '$sixty_days_ago' AND '$today'"
-			),
+            ),
 
-			'90_days'       => array(
+            '90_days'       => array(
                 "WEEK($datetime)",
                 "$date BETWEEN '$ninety_days_ago' AND '$today'"
-			),
+            ),
 
-			'180_days'       => array(
+            '180_days'       => array(
                 "WEEK($datetime)",
                 "$date BETWEEN '$one_eighty_days_ago' AND '$today'"
-			),
+            ),
 
-			'360_days'       => array(
+            '360_days'       => array(
                 "WEEK($datetime)",
                 "$date BETWEEN '$three_sixty_days_ago' AND '$today'"
             ),
 
         );
 
-		$sql = isset( $ranges[ $range ] ) ? $ranges[ $range ] : $ranges[ '7_days' ];
-		return apply_filters( 'getpaid_earning_graphs_get_range_sql', $sql, $range );
-
-	}
-
-	/**
-	 * Retrieves the hours in a day
-	 *
-	 */
-	public function get_hours_in_a_day() {
-
-		return array(
-			'12AM' => __( '12 AM', 'invoicing'),
-			'1AM'  => __( '1 AM', 'invoicing'),
-			'2AM'  => __( '2 AM', 'invoicing'),
-			'3AM'  => __( '3 AM', 'invoicing'),
-			'4AM'  => __( '4 AM', 'invoicing'),
-			'5AM'  => __( '5 AM', 'invoicing'),
-			'6AM'  => __( '6 AM', 'invoicing'),
-			'7AM'  => __( '7 AM', 'invoicing'),
-			'8AM'  => __( '8 AM', 'invoicing'),
-			'9AM'  => __( '9 AM', 'invoicing'),
-			'10AM' => __( '10 AM', 'invoicing'),
-			'11AM' => __( '11 AM', 'invoicing'),
-			'12pm' => __( '12 PM', 'invoicing'),
-			'1PM'  => __( '1 PM', 'invoicing'),
-			'2PM'  => __( '2 PM', 'invoicing'),
-			'3PM'  => __( '3 PM', 'invoicing'),
-			'4PM'  => __( '4 PM', 'invoicing'),
-			'5PM'  => __( '5 PM', 'invoicing'),
-			'6PM'  => __( '6 PM', 'invoicing'),
-			'7PM'  => __( '7 PM', 'invoicing'),
-			'8PM'  => __( '8 PM', 'invoicing'),
-			'9PM'  => __( '9 PM', 'invoicing'),
-			'10PM' => __( '10 PM', 'invoicing'),
-			'11PM' => __( '11 PM', 'invoicing'),
-		);
-
-	}
-
-	/**
-	 * Retrieves the days in a period
-	 *
-	 */
-	public function get_days_in_period( $days ) {
-
-		$return = array();
-		$format = 'Y-m-d';
-
-		if ( $days < 8 ) {
-			$format = 'D';
-		}
-
-		if ( $days < 32 ) {
-			$format = 'M j';
-		}
-
-		while ( $days > 0 ) {
-
-			$key            = date( 'Y-m-d', strtotime( "-$days days", current_time( 'timestamp' ) ) );
-			$label          = date_i18n( $format, strtotime( "-$days days", current_time( 'timestamp' ) ) );
-			$return[ $key ] = $label;
-			$days--;
-
-		}
-
-		return $return;
-	}
-
-	/**
-	 * Retrieves the weeks in a period
-	 *
-	 */
-	public function get_weeks_in_period( $days ) {
-
-		$return = array();
-
-		while ( $days > 0 ) {
-
-			$key            = date( 'W', strtotime( "-$days days", current_time( 'timestamp' ) ) );
-			$label          = date_i18n( 'Y-m-d', strtotime( "-$days days", current_time( 'timestamp' ) ) );
-			$return[ $key ] = $label;
-			$days--;
-
-		}
-
-		return $return;
-	}
-
-	/**
-	 * Displays the report card.
-	 *
-	 */
-	public function display() {
-		?>
+        $sql = isset( $ranges[ $range ] ) ? $ranges[ $range ] : $ranges[ '7_days' ];
+        return apply_filters( 'getpaid_earning_graphs_get_range_sql', $sql, $range );
+
+    }
+
+    /**
+     * Retrieves the hours in a day
+     *
+     */
+    public function get_hours_in_a_day() {
+
+        return array(
+            '12AM' => __( '12 AM', 'invoicing'),
+            '1AM'  => __( '1 AM', 'invoicing'),
+            '2AM'  => __( '2 AM', 'invoicing'),
+            '3AM'  => __( '3 AM', 'invoicing'),
+            '4AM'  => __( '4 AM', 'invoicing'),
+            '5AM'  => __( '5 AM', 'invoicing'),
+            '6AM'  => __( '6 AM', 'invoicing'),
+            '7AM'  => __( '7 AM', 'invoicing'),
+            '8AM'  => __( '8 AM', 'invoicing'),
+            '9AM'  => __( '9 AM', 'invoicing'),
+            '10AM' => __( '10 AM', 'invoicing'),
+            '11AM' => __( '11 AM', 'invoicing'),
+            '12pm' => __( '12 PM', 'invoicing'),
+            '1PM'  => __( '1 PM', 'invoicing'),
+            '2PM'  => __( '2 PM', 'invoicing'),
+            '3PM'  => __( '3 PM', 'invoicing'),
+            '4PM'  => __( '4 PM', 'invoicing'),
+            '5PM'  => __( '5 PM', 'invoicing'),
+            '6PM'  => __( '6 PM', 'invoicing'),
+            '7PM'  => __( '7 PM', 'invoicing'),
+            '8PM'  => __( '8 PM', 'invoicing'),
+            '9PM'  => __( '9 PM', 'invoicing'),
+            '10PM' => __( '10 PM', 'invoicing'),
+            '11PM' => __( '11 PM', 'invoicing'),
+        );
+
+    }
+
+    /**
+     * Retrieves the days in a period
+     *
+     */
+    public function get_days_in_period( $days ) {
+
+        $return = array();
+        $format = 'Y-m-d';
+
+        if ( $days < 8 ) {
+            $format = 'D';
+        }
+
+        if ( $days < 32 ) {
+            $format = 'M j';
+        }
+
+        while ( $days > 0 ) {
+
+            $key            = date( 'Y-m-d', strtotime( "-$days days", current_time( 'timestamp' ) ) );
+            $label          = date_i18n( $format, strtotime( "-$days days", current_time( 'timestamp' ) ) );
+            $return[ $key ] = $label;
+            $days--;
+
+        }
+
+        return $return;
+    }
+
+    /**
+     * Retrieves the weeks in a period
+     *
+     */
+    public function get_weeks_in_period( $days ) {
+
+        $return = array();
+
+        while ( $days > 0 ) {
+
+            $key            = date( 'W', strtotime( "-$days days", current_time( 'timestamp' ) ) );
+            $label          = date_i18n( 'Y-m-d', strtotime( "-$days days", current_time( 'timestamp' ) ) );
+            $return[ $key ] = $label;
+            $days--;
+
+        }
+
+        return $return;
+    }
+
+    /**
+     * Displays the report card.
+     *
+     */
+    public function display() {
+        ?>
 
 			<div class="row">
 				<div class="col-12">
@@ -231,20 +231,20 @@ 
 
 		<?php
 
-	}
-
-	/**
-	 * Prepares the report stats.
-	 *
-	 * Extend this in child classes.
-	 */
-	abstract public function prepare_stats();
-
-	/**
-	 * Displays the actual report.
-	 *
-	 * Extend this in child classes.
-	 */
-	abstract public function display_stats();
+    }
+
+    /**
+     * Prepares the report stats.
+     *
+     * Extend this in child classes.
+     */
+    abstract public function prepare_stats();
+
+    /**
+     * Displays the actual report.
+     *
+     * Extend this in child classes.
+     */
+    abstract public function display_stats();
 
 }

includes/geolocation/class-getpaid-maxmind-database-service.php

Indentation +149 added lines, -149 removed lines

@@ -13,154 +13,154 @@
  */
 class GetPaid_MaxMind_Database_Service {
 
-	/**
-	 * The name of the MaxMind database to utilize.
-	 */
-	const DATABASE = 'GeoLite2-Country';
-
-	/**
-	 * The extension for the MaxMind database.
-	 */
-	const DATABASE_EXTENSION = '.mmdb';
-
-	/**
-	 * A prefix for the MaxMind database filename.
-	 *
-	 * @var string
-	 */
-	private $database_prefix;
-
-	/**
-	 * Class constructor.
-	 *
-	 * @param string|null $database_prefix A prefix for the MaxMind database filename.
-	 */
-	public function __construct( $database_prefix ) {
-		$this->database_prefix = $database_prefix;
-	}
-
-	/**
-	 * Fetches the path that the database should be stored.
-	 *
-	 * @return string The local database path.
-	 */
-	public function get_database_path() {
-		$uploads_dir = wp_upload_dir();
-
-		$database_path = trailingslashit( $uploads_dir['basedir'] ) . 'invoicing/';
-		if ( ! empty( $this->database_prefix ) ) {
-			$database_path .= $this->database_prefix . '-';
-		}
-		$database_path .= self::DATABASE . self::DATABASE_EXTENSION;
-
-		// Filter the geolocation database storage path.
-		return apply_filters( 'getpaid_maxmind_geolocation_database_path', $database_path );
-	}
-
-	/**
-	 * Fetches the database from the MaxMind service.
-	 *
-	 * @param string $license_key The license key to be used when downloading the database.
-	 * @return string|WP_Error The path to the database file or an error if invalid.
-	 */
-	public function download_database( $license_key ) {
-
-		$download_uri = add_query_arg(
-			array(
-				'edition_id'  => self::DATABASE,
-				'license_key' => urlencode( wpinv_clean( $license_key ) ),
-				'suffix'      => 'tar.gz',
-			),
-			'https://download.maxmind.com/app/geoip_download'
-		);
-
-		// Needed for the download_url call right below.
-		require_once ABSPATH . 'wp-admin/includes/file.php';
-
-		$tmp_archive_path = download_url( esc_url_raw( $download_uri ) );
-
-		if ( is_wp_error( $tmp_archive_path ) ) {
-			// Transform the error into something more informative.
-			$error_data = $tmp_archive_path->get_error_data();
-			if ( isset( $error_data['code'] ) && $error_data['code'] == 401 ) {
-				return new WP_Error(
-					'getpaid_maxmind_geolocation_database_license_key',
-					__( 'The MaxMind license key is invalid. If you have recently created this key, you may need to wait for it to become active.', 'invoicing' )
-				);
-			}
-
-			return new WP_Error( 'getpaid_maxmind_geolocation_database_download', __( 'Failed to download the MaxMind database.', 'invoicing' ) );
-		}
-
-		// Extract the database from the archive.
-		return $this->extract_downloaded_database( $tmp_archive_path );
-
-	}
-
-	/**
-	 * Extracts the downloaded database.
-	 *
-	 * @param string $tmp_archive_path The database archive path.
-	 * @return string|WP_Error The path to the database file or an error if invalid.
-	 */
-	protected function extract_downloaded_database( $tmp_archive_path ) {
-
-		// Extract the database from the archive.
-		$tmp_database_path = '';
-
-		try {
-
-			$file              = new PharData( $tmp_archive_path );
-			$tmp_database_path = trailingslashit( dirname( $tmp_archive_path ) ) . trailingslashit( $file->current()->getFilename() ) . self::DATABASE . self::DATABASE_EXTENSION;
-
-			$file->extractTo(
-				dirname( $tmp_archive_path ),
-				trailingslashit( $file->current()->getFilename() ) . self::DATABASE . self::DATABASE_EXTENSION,
-				true
-			);
-
-		} catch ( Exception $exception ) {
-			return new WP_Error( 'invoicing_maxmind_geolocation_database_archive', $exception->getMessage() );
-		} finally {
-			// Remove the archive since we only care about a single file in it.
-			unlink( $tmp_archive_path );
-		}
-
-		return $tmp_database_path;
-	}
-
-	/**
-	 * Fetches the ISO country code associated with an IP address.
-	 *
-	 * @param string $ip_address The IP address to find the country code for.
-	 * @return string The country code for the IP address, or empty if not found.
-	 */
-	public function get_iso_country_code_for_ip( $ip_address ) {
-		$country_code = '';
-
-		if ( ! class_exists( 'MaxMind\Db\Reader' ) ) {
-			return $country_code;
-		}
-
-		$database_path = $this->get_database_path();
-		if ( ! file_exists( $database_path ) ) {
-			return $country_code;
-		}
-
-		try {
-			$reader = new MaxMind\Db\Reader( $database_path );
-			$data   = $reader->get( $ip_address );
-
-			if ( isset( $data['country']['iso_code'] ) ) {
-				$country_code = $data['country']['iso_code'];
-			}
-
-			$reader->close();
-		} catch ( Exception $e ) {
-			wpinv_error_log( $e->getMessage(), 'SOURCE: MaxMind GeoLocation' );
-		}
-
-		return $country_code;
-	}
+    /**
+     * The name of the MaxMind database to utilize.
+     */
+    const DATABASE = 'GeoLite2-Country';
+
+    /**
+     * The extension for the MaxMind database.
+     */
+    const DATABASE_EXTENSION = '.mmdb';
+
+    /**
+     * A prefix for the MaxMind database filename.
+     *
+     * @var string
+     */
+    private $database_prefix;
+
+    /**
+     * Class constructor.
+     *
+     * @param string|null $database_prefix A prefix for the MaxMind database filename.
+     */
+    public function __construct( $database_prefix ) {
+        $this->database_prefix = $database_prefix;
+    }
+
+    /**
+     * Fetches the path that the database should be stored.
+     *
+     * @return string The local database path.
+     */
+    public function get_database_path() {
+        $uploads_dir = wp_upload_dir();
+
+        $database_path = trailingslashit( $uploads_dir['basedir'] ) . 'invoicing/';
+        if ( ! empty( $this->database_prefix ) ) {
+            $database_path .= $this->database_prefix . '-';
+        }
+        $database_path .= self::DATABASE . self::DATABASE_EXTENSION;
+
+        // Filter the geolocation database storage path.
+        return apply_filters( 'getpaid_maxmind_geolocation_database_path', $database_path );
+    }
+
+    /**
+     * Fetches the database from the MaxMind service.
+     *
+     * @param string $license_key The license key to be used when downloading the database.
+     * @return string|WP_Error The path to the database file or an error if invalid.
+     */
+    public function download_database( $license_key ) {
+
+        $download_uri = add_query_arg(
+            array(
+                'edition_id'  => self::DATABASE,
+                'license_key' => urlencode( wpinv_clean( $license_key ) ),
+                'suffix'      => 'tar.gz',
+            ),
+            'https://download.maxmind.com/app/geoip_download'
+        );
+
+        // Needed for the download_url call right below.
+        require_once ABSPATH . 'wp-admin/includes/file.php';
+
+        $tmp_archive_path = download_url( esc_url_raw( $download_uri ) );
+
+        if ( is_wp_error( $tmp_archive_path ) ) {
+            // Transform the error into something more informative.
+            $error_data = $tmp_archive_path->get_error_data();
+            if ( isset( $error_data['code'] ) && $error_data['code'] == 401 ) {
+                return new WP_Error(
+                    'getpaid_maxmind_geolocation_database_license_key',
+                    __( 'The MaxMind license key is invalid. If you have recently created this key, you may need to wait for it to become active.', 'invoicing' )
+                );
+            }
+
+            return new WP_Error( 'getpaid_maxmind_geolocation_database_download', __( 'Failed to download the MaxMind database.', 'invoicing' ) );
+        }
+
+        // Extract the database from the archive.
+        return $this->extract_downloaded_database( $tmp_archive_path );
+
+    }
+
+    /**
+     * Extracts the downloaded database.
+     *
+     * @param string $tmp_archive_path The database archive path.
+     * @return string|WP_Error The path to the database file or an error if invalid.
+     */
+    protected function extract_downloaded_database( $tmp_archive_path ) {
+
+        // Extract the database from the archive.
+        $tmp_database_path = '';
+
+        try {
+
+            $file              = new PharData( $tmp_archive_path );
+            $tmp_database_path = trailingslashit( dirname( $tmp_archive_path ) ) . trailingslashit( $file->current()->getFilename() ) . self::DATABASE . self::DATABASE_EXTENSION;
+
+            $file->extractTo(
+                dirname( $tmp_archive_path ),
+                trailingslashit( $file->current()->getFilename() ) . self::DATABASE . self::DATABASE_EXTENSION,
+                true
+            );
+
+        } catch ( Exception $exception ) {
+            return new WP_Error( 'invoicing_maxmind_geolocation_database_archive', $exception->getMessage() );
+        } finally {
+            // Remove the archive since we only care about a single file in it.
+            unlink( $tmp_archive_path );
+        }
+
+        return $tmp_database_path;
+    }
+
+    /**
+     * Fetches the ISO country code associated with an IP address.
+     *
+     * @param string $ip_address The IP address to find the country code for.
+     * @return string The country code for the IP address, or empty if not found.
+     */
+    public function get_iso_country_code_for_ip( $ip_address ) {
+        $country_code = '';
+
+        if ( ! class_exists( 'MaxMind\Db\Reader' ) ) {
+            return $country_code;
+        }
+
+        $database_path = $this->get_database_path();
+        if ( ! file_exists( $database_path ) ) {
+            return $country_code;
+        }
+
+        try {
+            $reader = new MaxMind\Db\Reader( $database_path );
+            $data   = $reader->get( $ip_address );
+
+            if ( isset( $data['country']['iso_code'] ) ) {
+                $country_code = $data['country']['iso_code'];
+            }
+
+            $reader->close();
+        } catch ( Exception $e ) {
+            wpinv_error_log( $e->getMessage(), 'SOURCE: MaxMind GeoLocation' );
+        }
+
+        return $country_code;
+    }
 
 }

includes/geolocation/class-getpaid-maxmind-geolocation.php

Indentation +159 added lines, -159 removed lines

@@ -16,164 +16,164 @@
  */
 class GetPaid_MaxMind_Geolocation {
 
-	/**
-	 * The service responsible for interacting with the MaxMind database.
-	 *
-	 * @var GetPaid_MaxMind_Database_Service
-	 */
-	private $database_service;
-
-	/**
-	 * Initialize the integration.
-	 */
-	public function __construct() {
-
-		/**
-		 * Supports overriding the database service to be used.
-		 *
-		 * @since 1.0.19
-		 * @return mixed|null The geolocation database service.
-		 */
-		$this->database_service = apply_filters( 'getpaid_maxmind_geolocation_database_service', null );
-		if ( null === $this->database_service ) {
-			$this->database_service = new GetPaid_MaxMind_Database_Service( $this->get_database_prefix() );
-		}
-
-		// Bind to the scheduled updater action.
-		add_action( 'getpaid_update_geoip_databases', array( $this, 'update_database' ) );
-
-		// Bind to the geolocation filter for MaxMind database lookups.
-		add_filter( 'getpaid_get_geolocation', array( $this, 'get_geolocation' ), 10, 2 );
-
-		// Handle maxmind key updates.
-		add_filter( 'wpinv_settings_sanitize_maxmind_license_key', array( $this, 'handle_key_updates' ) );
-
-	}
-
-	/**
-	 * Get database service.
-	 *
-	 * @return GetPaid_MaxMind_Database_Service|null
-	 */
-	public function get_database_service() {
-		return $this->database_service;
-	}
-
-	/**
-	 * Checks to make sure that the license key is valid.
-	 *
-	 * @param string $license_key The new license key.
-	 * @return string
-	 */
-	public function handle_key_updates( $license_key ) {
-
-		// Trim whitespaces and strip slashes.
-		$license_key = trim( $license_key );
-
-		// Abort if the license key is empty or unchanged.
-		if ( empty( $license_key ) ) {
-			return $license_key;
-		}
-
-		// Abort if a database exists and the license key is unchaged.
-		if ( file_exists( $this->database_service->get_database_path() && $license_key == wpinv_get_option( 'maxmind_license_key' ) ) ) {
-			return $license_key;
-		}
-
-		// Check the license key by attempting to download the Geolocation database.
-		$tmp_database_path = $this->database_service->download_database( $license_key );
-		if ( is_wp_error( $tmp_database_path ) ) {
-			getpaid_admin()->show_error( $tmp_database_path->get_error_message() );
-			return $license_key;
-		}
-
-		$this->update_database( /** @scrutinizer ignore-type */ $tmp_database_path );
-
-	}
-
-	/**
-	 * Updates the database used for geolocation queries.
-	 *
-	 * @param string $tmp_database_path Temporary database path.
-	 */
-	public function update_database( $tmp_database_path = null ) {
-
-		// Allow us to easily interact with the filesystem.
-		require_once ABSPATH . 'wp-admin/includes/file.php';
-		WP_Filesystem();
-		global $wp_filesystem;
-
-		// Remove any existing archives to comply with the MaxMind TOS.
-		$target_database_path = $this->database_service->get_database_path();
-
-		// If there's no database path, we can't store the database.
-		if ( empty( $target_database_path ) ) {
-			return;
-		}
-
-		if ( $wp_filesystem->exists( $target_database_path ) ) {
-			$wp_filesystem->delete( $target_database_path );
-		}
-
-		// We can't download a database if there's no license key configured.
-		$license_key = wpinv_get_option( 'maxmind_license_key' );
-		if ( empty( $license_key ) ) {
-			return;
-		}
-
-		if ( empty( $tmp_database_path ) ) {
-			$tmp_database_path = $this->database_service->download_database( $license_key );
-		}
-
-		if ( is_wp_error( $tmp_database_path ) ) {
-			wpinv_error_log( $tmp_database_path->get_error_message() );
-			return;
-		}
-
-		// Move the new database into position.
-		$wp_filesystem->move( $tmp_database_path, $target_database_path, true );
-		$wp_filesystem->delete( dirname( $tmp_database_path ) );
-	}
-
-	/**
-	 * Performs a geolocation lookup against the MaxMind database for the given IP address.
-	 *
-	 * @param array  $data       Geolocation data.
-	 * @param string $ip_address The IP address to geolocate.
-	 * @return array Geolocation including country code, state, city and postcode based on an IP address.
-	 */
-	public function get_geolocation( $data, $ip_address ) {
-
-		if ( ! empty( $data['country'] ) || empty( $ip_address ) ) {
-			return $data;
-		}
-
-		$country_code = $this->database_service->get_iso_country_code_for_ip( $ip_address );
-
-		return array(
-			'country'  => $country_code,
-			'state'    => '',
-			'city'     => '',
-			'postcode' => '',
-		);
-
-	}
-
-	/**
-	 * Fetches the prefix for the MaxMind database file.
-	 *
-	 * @return string
-	 */
-	private function get_database_prefix() {
-
-		$prefix = get_option( 'wpinv_maxmind_database_prefix' );
-
-		if ( empty( $prefix ) ) {
-			$prefix = md5( uniqid( 'wpinv' ) );
-			update_option( 'wpinv_maxmind_database_prefix', $prefix );
-		}
-
-		return $prefix;
-	}
+    /**
+     * The service responsible for interacting with the MaxMind database.
+     *
+     * @var GetPaid_MaxMind_Database_Service
+     */
+    private $database_service;
+
+    /**
+     * Initialize the integration.
+     */
+    public function __construct() {
+
+        /**
+         * Supports overriding the database service to be used.
+         *
+         * @since 1.0.19
+         * @return mixed|null The geolocation database service.
+         */
+        $this->database_service = apply_filters( 'getpaid_maxmind_geolocation_database_service', null );
+        if ( null === $this->database_service ) {
+            $this->database_service = new GetPaid_MaxMind_Database_Service( $this->get_database_prefix() );
+        }
+
+        // Bind to the scheduled updater action.
+        add_action( 'getpaid_update_geoip_databases', array( $this, 'update_database' ) );
+
+        // Bind to the geolocation filter for MaxMind database lookups.
+        add_filter( 'getpaid_get_geolocation', array( $this, 'get_geolocation' ), 10, 2 );
+
+        // Handle maxmind key updates.
+        add_filter( 'wpinv_settings_sanitize_maxmind_license_key', array( $this, 'handle_key_updates' ) );
+
+    }
+
+    /**
+     * Get database service.
+     *
+     * @return GetPaid_MaxMind_Database_Service|null
+     */
+    public function get_database_service() {
+        return $this->database_service;
+    }
+
+    /**
+     * Checks to make sure that the license key is valid.
+     *
+     * @param string $license_key The new license key.
+     * @return string
+     */
+    public function handle_key_updates( $license_key ) {
+
+        // Trim whitespaces and strip slashes.
+        $license_key = trim( $license_key );
+
+        // Abort if the license key is empty or unchanged.
+        if ( empty( $license_key ) ) {
+            return $license_key;
+        }
+
+        // Abort if a database exists and the license key is unchaged.
+        if ( file_exists( $this->database_service->get_database_path() && $license_key == wpinv_get_option( 'maxmind_license_key' ) ) ) {
+            return $license_key;
+        }
+
+        // Check the license key by attempting to download the Geolocation database.
+        $tmp_database_path = $this->database_service->download_database( $license_key );
+        if ( is_wp_error( $tmp_database_path ) ) {
+            getpaid_admin()->show_error( $tmp_database_path->get_error_message() );
+            return $license_key;
+        }
+
+        $this->update_database( /** @scrutinizer ignore-type */ $tmp_database_path );
+
+    }
+
+    /**
+     * Updates the database used for geolocation queries.
+     *
+     * @param string $tmp_database_path Temporary database path.
+     */
+    public function update_database( $tmp_database_path = null ) {
+
+        // Allow us to easily interact with the filesystem.
+        require_once ABSPATH . 'wp-admin/includes/file.php';
+        WP_Filesystem();
+        global $wp_filesystem;
+
+        // Remove any existing archives to comply with the MaxMind TOS.
+        $target_database_path = $this->database_service->get_database_path();
+
+        // If there's no database path, we can't store the database.
+        if ( empty( $target_database_path ) ) {
+            return;
+        }
+
+        if ( $wp_filesystem->exists( $target_database_path ) ) {
+            $wp_filesystem->delete( $target_database_path );
+        }
+
+        // We can't download a database if there's no license key configured.
+        $license_key = wpinv_get_option( 'maxmind_license_key' );
+        if ( empty( $license_key ) ) {
+            return;
+        }
+
+        if ( empty( $tmp_database_path ) ) {
+            $tmp_database_path = $this->database_service->download_database( $license_key );
+        }
+
+        if ( is_wp_error( $tmp_database_path ) ) {
+            wpinv_error_log( $tmp_database_path->get_error_message() );
+            return;
+        }
+
+        // Move the new database into position.
+        $wp_filesystem->move( $tmp_database_path, $target_database_path, true );
+        $wp_filesystem->delete( dirname( $tmp_database_path ) );
+    }
+
+    /**
+     * Performs a geolocation lookup against the MaxMind database for the given IP address.
+     *
+     * @param array  $data       Geolocation data.
+     * @param string $ip_address The IP address to geolocate.
+     * @return array Geolocation including country code, state, city and postcode based on an IP address.
+     */
+    public function get_geolocation( $data, $ip_address ) {
+
+        if ( ! empty( $data['country'] ) || empty( $ip_address ) ) {
+            return $data;
+        }
+
+        $country_code = $this->database_service->get_iso_country_code_for_ip( $ip_address );
+
+        return array(
+            'country'  => $country_code,
+            'state'    => '',
+            'city'     => '',
+            'postcode' => '',
+        );
+
+    }
+
+    /**
+     * Fetches the prefix for the MaxMind database file.
+     *
+     * @return string
+     */
+    private function get_database_prefix() {
+
+        $prefix = get_option( 'wpinv_maxmind_database_prefix' );
+
+        if ( empty( $prefix ) ) {
+            $prefix = md5( uniqid( 'wpinv' ) );
+            update_option( 'wpinv_maxmind_database_prefix', $prefix );
+        }
+
+        return $prefix;
+    }
 
 }

includes/reports/class-getpaid-reports-report-discounts.php

Indentation +81 added lines, -81 removed lines

@@ -12,22 +12,22 @@ 
  */
 class GetPaid_Reports_Report_Discounts extends GetPaid_Reports_Abstract_Report {
 
-	/**
-	 * @var string
-	 */
-	public $field = 'discount_code';
-
-	/**
-	 * Retrieves the discounts sql.
-	 *
-	 */
-	public function get_sql( $range ) {
-		global $wpdb;
-
-		$table      = $wpdb->prefix . 'getpaid_invoices';
-		$clauses    = $this->get_range_sql( $range );
-
-		$sql        = "SELECT
+    /**
+     * @var string
+     */
+    public $field = 'discount_code';
+
+    /**
+     * Retrieves the discounts sql.
+     *
+     */
+    public function get_sql( $range ) {
+        global $wpdb;
+
+        $table      = $wpdb->prefix . 'getpaid_invoices';
+        $clauses    = $this->get_range_sql( $range );
+
+        $sql        = "SELECT
 				meta.discount_code AS discount_code,
 				SUM(total) as total
             FROM $wpdb->posts
@@ -41,91 +41,91 @@ 
 			ORDER BY total DESC
         ";
 
-		return apply_filters( 'getpaid_discounts_graphs_get_sql', $sql, $range );
+        return apply_filters( 'getpaid_discounts_graphs_get_sql', $sql, $range );
 
-	}
+    }
 
-	/**
-	 * Prepares the report stats.
-	 *
-	 */
-	public function prepare_stats() {
-		global $wpdb;
-		$this->stats = $wpdb->get_results( $this->get_sql( $this->get_range() ) );
-		$this->stats = $this->normalize_stats( $this->stats );
-	}
+    /**
+     * Prepares the report stats.
+     *
+     */
+    public function prepare_stats() {
+        global $wpdb;
+        $this->stats = $wpdb->get_results( $this->get_sql( $this->get_range() ) );
+        $this->stats = $this->normalize_stats( $this->stats );
+    }
 
-	/**
-	 * Normalizes the report stats.
-	 *
-	 */
-	public function normalize_stats( $stats ) {
-		$normalized = array();
-		$others     = 0;
-		$did        = 0;
+    /**
+     * Normalizes the report stats.
+     *
+     */
+    public function normalize_stats( $stats ) {
+        $normalized = array();
+        $others     = 0;
+        $did        = 0;
 
-		foreach ( $stats as $stat ) {
+        foreach ( $stats as $stat ) {
 
-			if ( $did > 4 ) {
+            if ( $did > 4 ) {
 
-				$others += wpinv_round_amount( wpinv_sanitize_amount( $stat->total ) );
+                $others += wpinv_round_amount( wpinv_sanitize_amount( $stat->total ) );
 
-			} else {
+            } else {
 
-				$normalized[] = array(
-					'total'         => wpinv_round_amount( wpinv_sanitize_amount( $stat->total ) ),
-					'discount_code' => strip_tags( $stat->discount_code ),
-				);
+                $normalized[] = array(
+                    'total'         => wpinv_round_amount( wpinv_sanitize_amount( $stat->total ) ),
+                    'discount_code' => strip_tags( $stat->discount_code ),
+                );
 
-			}
+            }
 
-			$did++;
-		}
+            $did++;
+        }
 
-		if ( $others > 0 ) {
+        if ( $others > 0 ) {
 
-			$normalized[] = array(
-				'total'         => wpinv_round_amount( wpinv_sanitize_amount( $others ) ),
-				'discount_code' => esc_html__( 'Others', 'invoicing' ),
-			);
+            $normalized[] = array(
+                'total'         => wpinv_round_amount( wpinv_sanitize_amount( $others ) ),
+                'discount_code' => esc_html__( 'Others', 'invoicing' ),
+            );
 
-		}
+        }
 
-		return $normalized;
-	}
+        return $normalized;
+    }
 
-	/**
-	 * Retrieves report data.
-	 *
-	 */
-	public function get_data() {
+    /**
+     * Retrieves report data.
+     *
+     */
+    public function get_data() {
 
-		$data     = wp_list_pluck( $this->stats, 'total' );
-		$colors   = array( '#009688','#4caf50','#8bc34a','#00bcd4','#03a9f4','#2196f3' );
+        $data     = wp_list_pluck( $this->stats, 'total' );
+        $colors   = array( '#009688','#4caf50','#8bc34a','#00bcd4','#03a9f4','#2196f3' );
 
-		shuffle( $colors );
+        shuffle( $colors );
 
-		return array(
-			'data'            => $data,
-			'backgroundColor' => $colors,
-		);
+        return array(
+            'data'            => $data,
+            'backgroundColor' => $colors,
+        );
 
-	}
+    }
 
-	/**
-	 * Retrieves report labels.
-	 *
-	 */
-	public function get_labels() {
-		return wp_list_pluck( $this->stats, 'discount_code' );
-	}
+    /**
+     * Retrieves report labels.
+     *
+     */
+    public function get_labels() {
+        return wp_list_pluck( $this->stats, 'discount_code' );
+    }
 
-	/**
-	 * Displays the actual report.
-	 *
-	 */
-	public function display_stats() {
-		?>
+    /**
+     * Displays the actual report.
+     *
+     */
+    public function display_stats() {
+        ?>
 
 			<canvas id="getpaid-chartjs-earnings-discount_code"></canvas>
 
@@ -154,6 +154,6 @@ 
 			</script>
 
 		<?php
-	}
+    }
 
 }

includes/reports/class-getpaid-reports-report-items.php

Indentation +82 added lines, -82 removed lines

@@ -12,23 +12,23 @@ 
  */
 class GetPaid_Reports_Report_Items extends GetPaid_Reports_Abstract_Report {
 
-	/**
-	 * @var string
-	 */
-	public $field = 'item_name';
-
-	/**
-	 * Retrieves the earning sql.
-	 *
-	 */
-	public function get_sql( $range ) {
-		global $wpdb;
-
-		$table      = $wpdb->prefix . 'getpaid_invoices';
-		$table2     = $wpdb->prefix . 'getpaid_invoice_items';
-		$clauses    = $this->get_range_sql( $range );
-
-		$sql        = "SELECT
+    /**
+     * @var string
+     */
+    public $field = 'item_name';
+
+    /**
+     * Retrieves the earning sql.
+     *
+     */
+    public function get_sql( $range ) {
+        global $wpdb;
+
+        $table      = $wpdb->prefix . 'getpaid_invoices';
+        $table2     = $wpdb->prefix . 'getpaid_invoice_items';
+        $clauses    = $this->get_range_sql( $range );
+
+        $sql        = "SELECT
 				item.item_name AS item_name,
 				item.item_id AS item_id,
 				SUM(price) as total
@@ -43,91 +43,91 @@ 
 			ORDER BY total DESC
         ";
 
-		return apply_filters( 'getpaid_items_graphs_get_sql', $sql, $range );
+        return apply_filters( 'getpaid_items_graphs_get_sql', $sql, $range );
 
-	}
+    }
 
-	/**
-	 * Prepares the report stats.
-	 *
-	 */
-	public function prepare_stats() {
-		global $wpdb;
-		$this->stats = $wpdb->get_results( $this->get_sql( $this->get_range() ) );
-		$this->stats = $this->normalize_stats( $this->stats );
-	}
+    /**
+     * Prepares the report stats.
+     *
+     */
+    public function prepare_stats() {
+        global $wpdb;
+        $this->stats = $wpdb->get_results( $this->get_sql( $this->get_range() ) );
+        $this->stats = $this->normalize_stats( $this->stats );
+    }
 
-	/**
-	 * Normalizes the report stats.
-	 *
-	 */
-	public function normalize_stats( $stats ) {
-		$normalized = array();
-		$others     = 0;
-		$did        = 0;
+    /**
+     * Normalizes the report stats.
+     *
+     */
+    public function normalize_stats( $stats ) {
+        $normalized = array();
+        $others     = 0;
+        $did        = 0;
 
-		foreach ( $stats as $stat ) {
+        foreach ( $stats as $stat ) {
 
-			if ( $did > 4 ) {
+            if ( $did > 4 ) {
 
-				$others += wpinv_round_amount( wpinv_sanitize_amount( $stat->total ) );
+                $others += wpinv_round_amount( wpinv_sanitize_amount( $stat->total ) );
 
-			} else {
+            } else {
 
-				$normalized[] = array(
-					'total'     => wpinv_round_amount( wpinv_sanitize_amount( $stat->total ) ),
-					'item_name' => strip_tags( $stat->item_name ),
-				);
+                $normalized[] = array(
+                    'total'     => wpinv_round_amount( wpinv_sanitize_amount( $stat->total ) ),
+                    'item_name' => strip_tags( $stat->item_name ),
+                );
 
-			}
+            }
 
-			$did++;
-		}
+            $did++;
+        }
 
-		if ( $others > 0 ) {
+        if ( $others > 0 ) {
 
-			$normalized[] = array(
-				'total'     => wpinv_round_amount( wpinv_sanitize_amount( $others ) ),
-				'item_name' => esc_html__( 'Others', 'invoicing' ),
-			);
+            $normalized[] = array(
+                'total'     => wpinv_round_amount( wpinv_sanitize_amount( $others ) ),
+                'item_name' => esc_html__( 'Others', 'invoicing' ),
+            );
 
-		}
+        }
 
-		return $normalized;
-	}
+        return $normalized;
+    }
 
-	/**
-	 * Retrieves report data.
-	 *
-	 */
-	public function get_data() {
+    /**
+     * Retrieves report data.
+     *
+     */
+    public function get_data() {
 
-		$data     = wp_list_pluck( $this->stats, 'total' );
-		$colors   = array( '#009688','#4caf50','#8bc34a','#00bcd4','#03a9f4','#2196f3' );
+        $data     = wp_list_pluck( $this->stats, 'total' );
+        $colors   = array( '#009688','#4caf50','#8bc34a','#00bcd4','#03a9f4','#2196f3' );
 
-		shuffle( $colors );
+        shuffle( $colors );
 
-		return array(
-			'data'            => $data,
-			'backgroundColor' => $colors,
-		);
+        return array(
+            'data'            => $data,
+            'backgroundColor' => $colors,
+        );
 
-	}
+    }
 
-	/**
-	 * Retrieves report labels.
-	 *
-	 */
-	public function get_labels() {
-		return wp_list_pluck( $this->stats, 'item_name' );
-	}
+    /**
+     * Retrieves report labels.
+     *
+     */
+    public function get_labels() {
+        return wp_list_pluck( $this->stats, 'item_name' );
+    }
 
-	/**
-	 * Displays the actual report.
-	 *
-	 */
-	public function display_stats() {
-		?>
+    /**
+     * Displays the actual report.
+     *
+     */
+    public function display_stats() {
+        ?>
 
 			<canvas id="getpaid-chartjs-earnings-items"></canvas>
 
@@ -156,6 +156,6 @@ 
 			</script>
 
 		<?php
-	}
+    }
 
 }