space-admin.php

<?php
/**
Spacecoin for WooCommerce
https://github.com/SpaceWorksCo/WooCommerce-SPACE
 */

// Include everything
include (dirname(__FILE__) . '/space-include-all.php');

//===========================================================================
// Global vars.

global $g_SPACE__plugin_directory_url;
$g_SPACE__plugin_directory_url = plugins_url ('', __FILE__);

global $g_SPACE__cron_script_url;
$g_SPACE__cron_script_url = $g_SPACE__plugin_directory_url . '/space-cron.php';

//===========================================================================

//===========================================================================
// Global default settings
global $g_SPACE__config_defaults;
$g_SPACE__config_defaults = array (

   // ------- Hidden constants
// 'supported_currencies_arr'             =>  array ('USD', 'AUD', 'CAD', 'CHF', 'CNY', 'DKK', 'EUR', 'GBP', 'HKD', 'JPY', 'NZD', 'PLN', 'RUB', 'SEK', 'SGD', 'THB'), // Not used right now.
   'database_schema_version'              => 1.4,
   'assigned_address_expires_in_mins'     => 4*60,  // 4 hours to pay for order and receive necessary number of confirmations.
   'funds_received_value_expires_in_mins' => 5,	// 'received_funds_checked_at' is fresh (considered to be a valid value) if it was last checked within 'funds_received_value_expires_in_mins' minutes.
   'starting_index_for_new_addresses'     => 2,   // Generate new addresses for the wallet starting from this index.
   'max_spacecoin_api_failures'          => 3,   // Return error after this number of sequential failed attempts to retrieve spacecoin data.
   'max_unusable_generated_addresses'     => 20,  // Return error after this number of unusable (non-empty) spacecoin addresses were sequentially generated
   'spacecoin_api_timeout_secs'          => 20,  // Connection and request timeouts for curl operations dealing with spacecoin explorer requests.
   'exchange_rate_api_timeout_secs'       => 10,  // Connection and request timeouts for curl operations dealing with exchange rate API requests.
   'soft_cron_job_schedule_name'          => 'minutes_1',   // WP cron job frequency
   'delete_expired_unpaid_orders'         => 1,   // Automatically delete expired, unpaid orders from WooCommerce->Orders database
   'reuse_expired_addresses'              => 1,   // True - may reduce anonymously of store customers (someone may click/generate bunch of fake orders to list many addresses that in a future will be used by real customers).
                                                    // False - better anonymously but may leave many addresses in wallet unused (and hence will require very high 'gap limit') due to many unpaid order clicks.
                                                    //        In this case it is recommended to regenerate new wallet after 'gap limit' reaches 1000.
   'max_unused_addresses_buffer'          => 10,    // Do not pre-generate more than these number of unused addresses. Pre-generation is done only by hard cron job or manually at plugin settings.
   'cache_exchange_rates_for_minutes'	  => 10,	// Cache exchange rate for that number of minutes without re-calling exchange rate API's.
// 'soft_cron_max_loops_per_run'		  => 2,		// NOT USED. Check up to this number of assigned addresses per soft cron run. Each loop involves number of DB queries as well as API query to spacecoin explorer - and this may slow down the site.
   'elists'								  => array(),
   'use_aggregated_api'					  => '0',   // Use aggregated API to efficiently retrieve address balance

   // ------- General Settings
   'license_key'                          => 'UNLICENSED',
   'api_key'                              => substr(md5(microtime()), -16),
   // New, ported from WooCommerce settings pages.
   'service_provider'				 	  =>  'electrum_wallet',		// 'spacecoin',
   'electrum_mpk_saved'                   =>  '', // Saved, non-normalized value - MPK's separated by space / \n / ,
   'electrum_mpks'                        =>  array(), // Normalized array of MPK's - derived from saved.
   'confs_num'                            =>  '4', // number of confirmations required before accepting payment.
   'exchange_rate_type'                   =>  'realtime', // 'realtime', 'bestrate'.
   'exchange_multiplier'                  =>  '1.00',

   'delete_db_tables_on_uninstall'        =>  '0',
   'autocomplete_paid_orders'			  =>  '1',
   'enable_soft_cron_job'                 =>  '1',    // Enable "soft" Wordpress-driven cron jobs.

   // ------- Copy of $this->settings of 'SPACE_Spacecoin' class.
   // DEPRECATED (only blockchain.info related settings still remain there.)
   'gateway_settings'                     =>  array('confirmations' => 6),

   // ------- Special settings
   'exchange_rates'                       =>  array('EUR' => array('method|type' => array('time-last-checked' => 0, 'exchange_rate' => 1), 'GBP' => array())),
   );
//===========================================================================

//===========================================================================
function SPACE__GetPluginNameVersionEdition()
{
  $return_data = '<h2 style="border-bottom:1px solid #DDD;padding-bottom:10px;margin-bottom:20px;">' .
            SPACE_PLUGIN_NAME . ', version: <span style="color:#EE0000;">' .
            SPACE_VERSION. '</span>'.
          '</h2>';

  return $return_data;
}
//===========================================================================

//===========================================================================
function SPACE__GetProUrl() { return 'https://spacecoin.network'; }
function SPACE__GetProLabel()
{
   return '<span style="background-color:#FF4;color:#F44;border:1px solid #F44;padding:2px 6px;font-family:\'Open Sans\',sans-serif;font-size:14px;border-radius:6px;"><a href="' . SPACE__GetProUrl() . '">PRO Only</a></span>';
}
//===========================================================================

//===========================================================================
// These are coming from plugin-specific table.
function SPACE__get_persistent_settings ($key = false)
{
////// PERSISTENT SETTINGS CURRENTLY UNUSED
return array();
//////
  global $wpdb;

  $persistent_settings_table_name = $wpdb->prefix . 'space_persistent_settings';
  $sql_query = "SELECT * FROM `$persistent_settings_table_name` WHERE `id` = '1';";

  $row = $wpdb->get_row($sql_query, ARRAY_A);
  if ($row)
  {
    $settings = @unserialize($row['settings']);
    if ($key)
      return $settings[$key];
    else
      return $settings;
  }
  else
    return array();
}
//===========================================================================

//===========================================================================
function SPACE__update_persistent_settings ($space_use_these_settings_array = false)
{
////// PERSISTENT SETTINGS CURRENTLY UNUSED
return;
//////
  global $wpdb;

  $persistent_settings_table_name = $wpdb->prefix . 'space_persistent_settings';

  if (!$space_use_these_settings)
    $space_use_these_settings = array();

  $db_ready_settings = SPACE__safe_string_escape (serialize($space_use_these_settings_array));

  $wpdb->update($persistent_settings_table_name, array('settings' => $db_ready_settings), array('id' => '1'), array('%s'));
}
//===========================================================================

//===========================================================================
// Wipe existing table's contents and recreate first record with all defaults.
function SPACE__reset_all_persistent_settings ()
{
////// PERSISTENT SETTINGS CURRENTLY UNUSED
return;
//////

  global $wpdb;
  global $g_SPACE__config_defaults;

  $persistent_settings_table_name = $wpdb->prefix . 'space_persistent_settings';

  $initial_settings = SPACE__safe_string_escape (serialize($g_SPACE__config_defaults));

  $query = "TRUNCATE TABLE `$persistent_settings_table_name`;";
  $wpdb->query ($query);

  $query = "INSERT INTO `$persistent_settings_table_name`
      (`id`, `settings`)
        VALUES
      ('1', '$initial_settings');";
  $wpdb->query ($query);
}
//===========================================================================

//===========================================================================
function SPACE__get_settings ($key = false)
{
  global   $g_SPACE__plugin_directory_url;
  global   $g_SPACE__config_defaults;

  $space_settings = get_option (SPACE_SETTINGS_NAME);
  if (!is_array($space_settings))
    $space_settings = array();


  if ($key)
    return (@$space_settings[$key]);
  else
    return ($space_settings);
}
//===========================================================================

//===========================================================================
function SPACE__update_settings ($space_use_these_settings = false, $also_update_persistent_settings = false)
{
   if ($space_use_these_settings)
      {
      if ($also_update_persistent_settings)
        SPACE__update_persistent_settings ($space_use_these_settings);

      update_option (SPACE_SETTINGS_NAME, $space_use_these_settings);
      return;
      }

   global   $g_SPACE__config_defaults;

   // Load current settings and overwrite them with whatever values are present on submitted form
   $space_settings = SPACE__get_settings();

   foreach ($g_SPACE__config_defaults as $k => $v)
      {
      if (isset($_POST[$k]))
         {
          check_admin_referer( 'space-settings' ); // CSRF protection
          if ( !current_user_can( 'manage_options' ) ) // Access control
          wp_die( __( 'You do not have sufficient permissions to access this page.' ) );
         if (!isset($space_settings[$k]))
            $space_settings[$k] = ""; // Force set to something.
         SPACE__update_individual_space_setting ($space_settings[$k], $_POST[$k]);
         }
      // If not in POST - existing will be used.
      }

   //---------------------------------------
   // Validation
   //if ($space_settings['aff_payout_percents3'] > 90)
   //   $space_settings['aff_payout_percents3'] = "90";
   //---------------------------------------

  // ---------------------------------------
  // Post-process variables.

  // Array of MPK's. Single MPK = element with idx=0
  $space_settings['electrum_mpks'] = preg_split("/[\s,]+/", $space_settings['electrum_mpk_saved']);
  // ---------------------------------------


  if ($also_update_persistent_settings)
    SPACE__update_persistent_settings ($space_settings);

  update_option (SPACE_SETTINGS_NAME, $space_settings);
}
//===========================================================================

//===========================================================================
// Takes care of recursive updating
function SPACE__update_individual_space_setting (&$space_current_setting, $space_new_setting)
{
   if (is_string($space_new_setting))
      $space_current_setting = SPACE__stripslashes ($space_new_setting);
   else if (is_array($space_new_setting))  // Note: new setting may not exist yet in current setting: curr[t5] - not set yet, while new[t5] set.
      {
      // Need to do recursive
      foreach ($space_new_setting as $k => $v)
         {
         if (!isset($space_current_setting[$k]))
            $space_current_setting[$k] = "";   // If not set yet - force set it to something.
         SPACE__update_individual_space_setting ($space_current_setting[$k], $v);
         }
      }
   else
      $space_current_setting = $space_new_setting;
}
//===========================================================================

//===========================================================================
//
// Reset settings only for one screen
function SPACE__reset_partial_settings ($also_reset_persistent_settings = false)
{
   global   $g_SPACE__config_defaults;

   // Load current settings and overwrite ones that are present on submitted form with defaults
   $space_settings = SPACE__get_settings();

   foreach ($_POST as $k=>$v)
      {
        check_admin_referer( 'space-settings' ); // CSRF protection
        if ( !current_user_can( 'manage_options' ) ) // Access control
        wp_die( __( 'You do not have sufficient permissions to access this page.' ) );
      if (isset($g_SPACE__config_defaults[$k]))
         {
         if (!isset($space_settings[$k]))
            $space_settings[$k] = ""; // Force set to something.
         SPACE__update_individual_space_setting ($space_settings[$k], $g_SPACE__config_defaults[$k]);
         }
      }

  update_option (SPACE_SETTINGS_NAME, $space_settings);

  if ($also_reset_persistent_settings)
    SPACE__update_persistent_settings ($space_settings);
}
//===========================================================================

//===========================================================================
function SPACE__reset_all_settings ($also_reset_persistent_settings = false)
{
  global   $g_SPACE__config_defaults;

  update_option (SPACE_SETTINGS_NAME, $g_SPACE__config_defaults);

  if ($also_reset_persistent_settings)
    SPACE__reset_all_persistent_settings ();
}
//===========================================================================

//===========================================================================
// Recursively strip slashes from all elements of multi-nested array
function SPACE__stripslashes (&$val)
{
   if (is_string($val))
      return (stripslashes($val));
   if (!is_array($val))
      return $val;

   foreach ($val as $k=>$v)
      {
      $val[$k] = SPACE__stripslashes ($v);
      }

   return $val;
}
//===========================================================================

//===========================================================================
/*
    ----------------------------------
    : Table 'space_addresses' :
    ----------------------------------
      status                "unused"      - never been used address with last known zero balance
                            "assigned"    - order was placed and this address was assigned for payment
                            "revalidate"  - assigned/expired, unused or unknown address suddenly got non-zero balance in it. Revalidate it for possible late order payment against meta_data.
                            "used"        - order was placed and this address and payment in full was received. Address will not be used again.
                            "xused"       - address was used (touched with funds) by unknown entity outside of this application. No metadata is present for this address, will not be able to correlated it with any order.
                            "unknown"     - new address was generated but cannot retrieve balance due to blockchain API failure.
*/
function SPACE__create_database_tables ($space_settings)
{
  global $wpdb;

  $space_settings = SPACE__get_settings();
  $must_update_settings = false;

  ///$persistent_settings_table_name       = $wpdb->prefix . 'space_persistent_settings';
  ///$electrum_wallets_table_name          = $wpdb->prefix . 'space_electrum_wallets';
  $space_addresses_table_name             = $wpdb->prefix . 'space_addresses';

  if($wpdb->get_var("SHOW TABLES LIKE '$space_addresses_table_name'") != $space_addresses_table_name)
      $b_first_time = true;
  else
      $b_first_time = false;

 //----------------------------------------------------------
 // Create tables
  /// NOT NEEDED YET
  /// $query = "CREATE TABLE IF NOT EXISTS `$persistent_settings_table_name` (
  ///   `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
  ///   `settings` text,
  ///   PRIMARY KEY  (`id`)
  ///   );";
  /// $wpdb->query ($query);

  /// $query = "CREATE TABLE IF NOT EXISTS `$electrum_wallets_table_name` (
  ///   `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
  ///   `master_public_key` varchar(255) NOT NULL,
  ///   PRIMARY KEY  (`id`),
  ///   UNIQUE KEY  `master_public_key` (`master_public_key`)
  ///   );";
  /// $wpdb->query ($query);

  $query = "CREATE TABLE IF NOT EXISTS `$space_addresses_table_name` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
    `space_address` char(36) NOT NULL,
    `origin_id` char(128) NOT NULL DEFAULT '',
    `index_in_wallet` bigint(20) NOT NULL DEFAULT '0',
    `status` char(16)  NOT NULL DEFAULT 'unknown',
    `last_assigned_to_ip` char(16) NOT NULL DEFAULT '0.0.0.0',
    `assigned_at` bigint(20) NOT NULL DEFAULT '0',
    `total_received_funds` DECIMAL( 16, 8 ) NOT NULL DEFAULT '0.00000000',
    `received_funds_checked_at` bigint(20) NOT NULL DEFAULT '0',
    `address_meta` MEDIUMBLOB NULL,
    PRIMARY KEY (`id`),
    UNIQUE KEY `space_address` (`space_address`),
    KEY `index_in_wallet` (`index_in_wallet`),
    KEY `origin_id` (`origin_id`),
    KEY `status` (`status`)
    );";
  $wpdb->query ($query);
  //----------------------------------------------------------

	// upgrade space_addresses table, add additional indexes
  if (!$b_first_time)
  {
    $version = floatval($space_settings['database_schema_version']);

    if ($version < 1.1)
    {

      $query = "ALTER TABLE `$space_addresses_table_name` ADD INDEX `origin_id` (`origin_id` ASC) , ADD INDEX `status` (`status` ASC)";
      $wpdb->query ($query);
      $space_settings['database_schema_version'] = 1.1;
      $must_update_settings = true;
    }

    if ($version < 1.2)
    {

      $query = "ALTER TABLE `$space_addresses_table_name` DROP INDEX `index_in_wallet`, ADD INDEX `index_in_wallet` (`index_in_wallet` ASC)";
      $wpdb->query ($query);
      $space_settings['database_schema_version'] = 1.2;
      $must_update_settings = true;
    }

    if ($version < 1.3)
    {

      $query = "ALTER TABLE `$space_addresses_table_name` CHANGE COLUMN `origin_id` `origin_id` char(128)";
      $wpdb->query ($query);
      $space_settings['database_schema_version'] = 1.3;
      $must_update_settings = true;

      $mpk = @$space_settings['gateway_settings']['electrum_master_public_key'];
      if ($mpk)
      {
        // Replace hashed values of MPK in DB with real MPK values.
        $mpk_old_value = 'electrum.mpk.' . md5($mpk);
        // UPDATE table_name SET field = REPLACE(field, 'foo', 'bar') WHERE INSTR(field, 'foo') > 0;
        // UPDATE [table_name] SET [field_name] = REPLACE([field_name], "foo", "bar");
        $query = "UPDATE `$space_addresses_table_name` SET `origin_id` = '$mpk' WHERE `origin_id` = '$mpk_old_value'";
        $wpdb->query ($query);

        // Copy settings from old location to new, if new is empty.
        if (!@$space_settings['electrum_mpk_saved'])
        {
          $space_settings['electrum_mpk_saved'] = $mpk;
          // 'SPACE__update_settings()' will populate $space_settings['electrum_mpks'].
        }
      }
    }

    if ($version < 1.4)
    {

      $query = "ALTER TABLE `$space_addresses_table_name` MODIFY `address_meta` MEDIUMBLOB";
      $wpdb->query ($query);
      $space_settings['database_schema_version'] = 1.4;
      $must_update_settings = true;
    }

  }

  if ($must_update_settings)
  {
	  SPACE__update_settings ($space_settings);
	}

  //----------------------------------------------------------
  // Seed DB tables with initial set of data
  /* PERSISTENT SETTINGS CURRENTLY UNUNSED
  if ($b_first_time || !is_array(SPACE__get_persistent_settings()))
  {
    // Wipes table and then creates first record and populate it with defaults
    CM__reset_all_persistent_settings();
  }
  */
   //----------------------------------------------------------
}
//===========================================================================

//===========================================================================
// NOTE: Irreversibly deletes all plugin tables and data
function SPACE__delete_database_tables ()
{
  global $wpdb;

  ///$persistent_settings_table_name       = $wpdb->prefix . 'space_persistent_settings';
  ///$electrum_wallets_table_name          = $wpdb->prefix . 'space_electrum_wallets';
  $space_addresses_table_name    = $wpdb->prefix . 'space_addresses';

  ///$wpdb->query("DROP TABLE IF EXISTS `$persistent_settings_table_name`");
  ///$wpdb->query("DROP TABLE IF EXISTS `$electrum_wallets_table_name`");
  $wpdb->query("DROP TABLE IF EXISTS `$space_addresses_table_name`");
}
//===========================================================================