Migrating plugin to be hosted at GitHub (#15)

* fixing the global logger location and instantiation

* download testing validated

* updating version

Author: aguywithanidea

CHANGELOG.md

@@ -1,5 +1,13 @@
 ### Changelog
 
+#### 3.0.0
+* Released: 2020-07-03
+* Plugin is now hosted on [GitHub](https://github.com/HeyPublisher/amazon-book-store)
+* Fixed issue with call to function `split` not being found in PHP versions 7.0 and above.
+* Added an updater that will check GitHub for latest version and update locally.
+* Organized code around HeyPublisher/Base class
+* Validated plugin works up through WordPress 5.3
+
 #### 2.2.1
 * Released: 2017-05-27
 * Fixed an issue where affiliate code would not stick if changing from any international affiliate country back to US.
@@ -55,7 +63,7 @@
 
 #### 1.0.1
 * Updated screenshots to highlight the fact that users should change their Amazon Associate ID.
-* Plugin is now owned and maintained by [Loudlever, Inc.](http://www.loudlever.com)
+* Plugin is now owned and maintained by [Loudlever, Inc.](https://www.loudlever.com)
 * Update Release (03/26/2010)
 
 #### 1.0

README.md

@@ -1,16 +1,5 @@
 ## Amazon Book Store
 
-```
-Contributors: heypublisher, aguywithanidea, loudlever
-Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=Y8SL68GN5J2PL
-Tags: affiliate, amazon, product, book store, affiliate sales,ASIN, Amazon Associate, monetize, heypublisher
-Requires at least: 4.0
-Tested up to: 4.7.3
-Stable tag: 2.2.1
-License: GPLv2 or later
-License URI: http://www.gnu.org/licenses/gpl-2.0.html
-```
-
 Sell Amazon products in sidebar widgets, unique to the individual POST or generically from a default pool of products that you define.
 
 ### Description
@@ -31,7 +20,7 @@ Install the plugin, then activate it.  Once activated, configure the Widget:
 
 **Configure the ASIN pool**
 
-Navigate to 'Settings' -> 'Amazon Book Store'.  Input your Amazon Affiliate ID and country, the add the ASINs for the products you want to be displayed in the widget.  See [How to Find Amazon ASINs](http://askville.amazon.com/find-Amazon-ASIN-product-details-page/AnswerViewer.do?requestId=11106037) for more information.  There are two categorizations of settings:
+Navigate to 'Settings' -> 'Amazon Book Store'.  Input your Amazon Affiliate ID and country, the add the ASINs for the products you want to be displayed in the widget.  See [How to Find Amazon ASINs](https://www.amazon.com/gp/seller/asin-upc-isbn-info.html) for more information.  There are two categorizations of settings:
 
 * POST Specific:  When set, these products will be offered for sale when users read the associated POST.
 * Default: If the request is to a POST that does not have specific ASINs defined, the widget will display products from this group.

include/classes/AMZNBS/Admin.class.php

@@ -1,5 +1,6 @@
 <?php
 namespace AMZNBS;
+
 /*
   Admin Class
 
@@ -24,21 +25,22 @@ class Admin extends \HeyPublisher\Base {
   public function __construct() {
     parent::__construct();
     $this->options = get_option(SGW_PLUGIN_OPTTIONS);
-    $this->log(sprintf("in constructor\nopts = %s",print_r($this->options,true)));
+    $this->logger->debug(sprintf("in constructor\nopts = %s",print_r($this->options,true)));
     // $this->check_plugin_version();  // may need to reintroduce this
     $this->nav_slug = SGW_ADMIN_PAGE; // not 'amazon_bookstore' because this needs to map to dir name
     $this->slug = 'support-great-writers'; // not 'amazon_bookstore' because this needs to map to dir name
     // Sidebar configs
-    $this->plugin['home'] = 'https://wordpress.org/plugins/support-great-writers/';
-    $this->plugin['support'] = 'https://wordpress.org/support/plugin/support-great-writers';
+    $this->plugin['home'] = 'https://github.com/HeyPublisher/amazon-book-store';
+    $this->plugin['support'] = 'https://github.com/HeyPublisher/amazon-book-store/issues';
     $this->plugin['contact'] = 'mailto:wordpress@heypublisher.com';
+    $this->plugin['more'] = 'https://github.com/HeyPublisher/';
   }
 
   public function __destruct() {
     parent::__destruct();
   }
   public function activate_plugin() {
-    $this->log("in the activate_plugin()");
+    $this->logger->debug("in the activate_plugin()");
     $this->check_plugin_version();
   }
 
@@ -71,20 +73,20 @@ public function plugin_filter() {
   }
 
     public function check_plugin_version() {
-    $this->log("in check_plugin_version()");
+    $this->logger->debug("in check_plugin_version()");
 
     $opts = get_option(SGW_PLUGIN_OPTTIONS);
     // printf("<pre>In check_plugin_version()\n opts = %s</pre>",print_r($opts,1));
     if (!$opts || !$opts[plugin] || $opts[plugin][version_last] == false) {
-      $this->log("no old version - initializing");
+      $this->logger->debug("no old version - initializing");
       $this->init_plugin();
       // there is a possible upgrade path from old widget to this one - in which case we want to migrate data
       $this->migrate_old_widget();
       return;
     }
     // check for upgrade option here
     if ($opts[plugin][version_current] != SGW_PLUGIN_VERSION) {
-      $this->log("need to upgrade version");
+      $this->logger->debug("need to upgrade version");
       $this->upgrade_plugin($opts);
       return;
     }
@@ -182,7 +184,7 @@ private function normalize_asin_list($list) {
       // $this->error = 'You must input at least one ASIN'; return false;
     }
     $new = array();
-    $array = split(',',$list);
+    $array = explode(',',$list);
     foreach ($array as $asin) {
       $x = trim($asin);
       if (strlen($x) != 10) {

include/classes/HeyPublisher/Base.class.php

@@ -1,6 +1,10 @@
 <?php
 namespace HeyPublisher;
 
+if (!class_exists("\HeyPublisher\Base\Log")) {
+  require_once(SGW_PLUGIN_FULLPATH . '/include/classes/HeyPublisher/Base/Log.class.php');
+}
+
 if(preg_match('#' . basename(__FILE__) . '#', $_SERVER['PHP_SELF'])) { die('HeyPublisher: Illegal Page Call!'); }
 
 /**
@@ -9,9 +13,9 @@
 */
 class Base {
   var $debug = true;
+  var $logger = null;
   var $help = false;
   var $i18n = 'heypublisher';  // key for internationalization stubs
-  var $log_file = '';
   var $plugin = array(
     'url' => 'https://www.heypublisher.com',
     'home' => 'https://wordpress.org/plugins/',
@@ -22,9 +26,11 @@ class Base {
   var $slug = '';   // should be defined in constructor of any class that extends this class.
 
   public function __construct() {
+    global $HEYPUB_LOGGER;
     // this can't be instantiated in var declaration
     // $this->plugin['url'] = plugins_url('../../',__FILE__);
-    $this->log_file = dirname( __FILE__ ) . '/../../../error.log';
+    $this->logger = $HEYPUB_LOGGER;
+    $this->logger->debug("HeyPublisher::Base loaded");
   }
 
   public function __destruct() {
@@ -60,15 +66,6 @@ public function box_footer() {
     return $text;
 	}
 
-  /**
-   * Logging function
-   */
-  public function log($msg) {
-    if ($this->debug && $this->log_file) {
-      error_log(sprintf("%s\n",$msg),3,$this->log_file);
-    }
-  }
-
   /**
    * Style the side-bar link appropriately
    */

include/classes/HeyPublisher/Base/Log.class.php

@@ -0,0 +1,40 @@
+<?php
+// Generic logging class.
+// Should be instantiated: $this->logger = new \HeyPublisher\Base\Log('file.log');
+// Then send logs: $this->logger->debug("message"); and it will be written to 'file.log'
+
+namespace HeyPublisher\Base;
+
+if(preg_match('#' . basename(__FILE__) . '#', $_SERVER['PHP_SELF'])) { die('HeyPublisher: Illegal Page Call!'); }
+
+// Logging class for all HeyPublisher plugins.
+// This class is instantiated automatically when loaded and will be accessible
+// via the global $HEYPUB_LOGGER
+class Log {
+  var $enable = false;
+  var $log_file = '';
+
+  // Pass in fully pathed file if you want to override default
+  public function __construct($file='') {
+    if (!$file) { $file = '/tmp/heypub_plugin_error.log'; }
+    // this can't be instantiated in var declaration
+    $this->log_file = $file;
+    if (file_exists($this->log_file)) {
+      // can only turn on logging if server-side environment exists
+      $this->enable = (getenv('HEYPUB_DEBUG') === 'true');
+    }
+  }
+
+  // Logging function
+  public function debug($msg) {
+    if ($this->enable) {
+      error_log(sprintf("%s\n",$msg),3,$this->log_file);
+    }
+  }
+}
+// This class sets a global accessor
+if (!isset($HEYPUB_LOGGER)) {
+  $HEYPUB_LOGGER  = new \HeyPublisher\Base\Log();
+  $HEYPUB_LOGGER->debug("Instantiating HeyPublisher\Base\Log...");
+}
+?>