Release version 2.3.0 (#4)

Merge pull request #4 from short-pixel-optimizer/queue

Author: pdobrescu

build/shortpixel/PackageLoader.php

@@ -4,18 +4,30 @@
 class PackageLoader
 {
     public $dir;
+    public $composerFile  = false;
 
-    public function getComposerFile()
+    public function __construct()
     {
-        return json_decode(file_get_contents($this->dir."/composer.json"), 1);
+
+    }
+
+    public function setComposerFile($filePath)
+    {
+      $this->composerFile = json_decode(file_get_contents($filePath),1);
+    }
+
+    public function getComposerFile($filePath = false )
+    {
+      if (! $this->composerFile)
+        $this->composerFile = json_decode(file_get_contents($this->dir."/composer.json"), 1);
+
+        return $this->composerFile;
     }
 
     public function load($dir)
     {
         $this->dir = $dir;
         $composer = $this->getComposerFile();
-
-
         if(isset($composer["autoload"]["psr-4"])){
             $this->loadPSR4($composer['autoload']['psr-4']);
         }
@@ -49,11 +61,13 @@ public function loadPSR0($namespaces)
     public function loadPSR($namespaces, $psr4)
     {
         $dir = $this->dir;
+
         // Foreach namespace specified in the composer, load the given classes
         foreach ($namespaces as $namespace => $classpaths) {
             if (!is_array($classpaths)) {
                 $classpaths = array($classpaths);
             }
+
             spl_autoload_register(function ($classname) use ($namespace, $classpaths, $dir, $psr4) {
                 // Check if the namespace matches the class we are looking for
                 if (preg_match("#^".preg_quote($namespace)."#", $classname)) {
@@ -62,6 +76,7 @@ public function loadPSR($namespaces, $psr4)
                         $classname = str_replace($namespace, "", $classname);
                     }
 
+
                     //  $filename = preg_replace("#\\\\#", "", $classname).".php";
                     // This is fix for nested classes which were losing a /
                     $filename = ltrim($classname .'.php', '\\');

build/shortpixel/composer.json

@@ -1 +1 @@
-{"name":"ReThumbAdvanced\/shortpixelmodules","description":"ShortPixel submodules","type":"function","autoload":{"psr-4":{"ReThumbAdvanced\\ShortPixelLogger":"log\/src","ReThumbAdvanced\\Notices":"notices\/src"}}}
+{"name":"ReThumbAdvanced\/shortpixelmodules","description":"ShortPixel submodules","type":"function","autoload":{"psr-4":{"ReThumbAdvanced\\ShortPixelLogger":"log\/src","ReThumbAdvanced\\Notices":"notices\/src","ReThumbAdvanced\\ShortQ":"shortq\/src"}}}

build/shortpixel/log/src/ShortPixelLogger.php

@@ -250,6 +250,12 @@ public static function addDebug($message, $args = array())
      $log->addLog($message, $level, $args);
    }
 
+   /** These should be removed every release. They are temporary only for d'bugging the current release */
+   public static function addTemp($message, $args = array())
+   {
+     self::addDebug($message, $args);
+   }
+
    public static function logLevel($level)
    {
       $log = self::getInstance();

build/shortpixel/notices/composer.json

@@ -1,7 +1,7 @@
 {
     "name": "shortpixel/notices",
     "description": "ShortPixel WordPress Notice System",
-    "version": "1.3",
+    "version": "1.5",
     "type": "library",
     "license": "MIT",
     "authors": [

build/shortpixel/notices/src/NoticeController.php

@@ -65,8 +65,6 @@ protected function loadNotices()
   {
     $notices = get_option($this->notice_option, false);
     $cnotice = (is_array($notices)) ? count($notices) : 0;
-    if ($cnotice > 0)
-      Log::addDebug('Notice Control - #num notices' . $cnotice);
 
     if ($notices !== false && is_array($notices))
     {
@@ -90,7 +88,7 @@ protected function addNotice($message, $code, $unique)
         foreach(self::$notices as $nitem)
         {
           if ($nitem->message == $notice->message && $nitem->code == $notice->code) // same message.
-            return $notice; // return the notice with the same message.
+            return $nitem; // return the notice with the same message.
         }
       }
       self::$notices[] = $notice;
@@ -141,6 +139,7 @@ public function getNotices()
   public function getNoticesForDisplay()
   {
       $newNotices = array();
+
       foreach(self::$notices as $notice)
       {
           if ($notice->isDismissed()) // dismissed never displays.
@@ -266,7 +265,23 @@ public static function addSuccess($message, $unique = false)
 
   }
 
-  public static function makePersistent($notice, $key, $suppress = -1)
+  public static function addDetail($notice, $detail)
+  {
+    $noticeController = self::getInstance();
+    $notice->addDetail($detail);
+
+//   $notice_id = spl_object_id($notice);
+
+    $noticeController->update();
+  }
+
+  /** Make a regular notice persistent across multiple page loads
+  * @param $notice NoticeModel The Notice to make Persistent
+  * @param $key String Identifier of the persistent notice.
+  * @param $suppress Int  When dismissed, time to stay dismissed
+  * @param $callback Function Callable function
+  */
+  public static function makePersistent($notice, $key, $suppress = -1, $callback = null)
   {
      $noticeController = self::getInstance();
      $existing = $noticeController->getNoticeByID($key);
@@ -291,7 +306,7 @@ public static function makePersistent($notice, $key, $suppress = -1)
      }
      else
      {
-       $notice->setPersistent($key, $suppress); // set this notice persistent.
+       $notice->setPersistent($key, $suppress, $callback); // set this notice persistent.
      }
 
      $noticeController->update();

build/shortpixel/notices/src/NoticeModel.php

@@ -4,6 +4,7 @@
 class NoticeModel //extends ShortPixelModel
 {
   public $message; // The message we want to convey.
+  public $details = array(); // extra details, like the files involved. Something could be hideable in the future.
   public $code;
 
   private $id = null; // used for persistent messages.
@@ -16,6 +17,7 @@ class NoticeModel //extends ShortPixelModel
   public $messageType = self::NOTICE_NORMAL;
 
   public $notice_action; // empty unless for display. Ajax action to talk back to controller.
+  protected $callback; // empty unless callback is needed
 
   public static $icons = array();
 
@@ -82,16 +84,33 @@ public function setDismissedUntil($timestamp)
     $this->suppress_until = $timestamp;
   }
 
+  /** Support for extra information beyond the message.
+  * Can help to not overwhelm users w/ the same message but different file /circumstances.
+   */
+  public function addDetail($detail, $clean = false)
+  {
+      if ($clean)
+        $this->details = array();
+
+      if (! in_array($detail, $this->details) )
+        $this->details[] = $detail;
+  }
+
+
 
   /** Set a notice persistent. Meaning it shows every page load until dismissed.
   * @param $key Unique Key of this message. Required
   * @param $suppress When dismissed do not show this message again for X amount of time. When -1 it will just be dropped from the Notices and not suppressed
   */
-  public function setPersistent($key, $suppress = -1)
+  public function setPersistent($key, $suppress = -1, $callback = null)
   {
       $this->id = $key;
       $this->is_persistent = true;
       $this->suppress_period = $suppress;
+      if ( ! is_null($callback) && is_callable($callback))
+      {
+        $this->callback = $callback;
+      }
   }
 
   public static function setIcon($notice_type, $icon)
@@ -122,6 +141,13 @@ public function getForDisplay()
 
     $icon = '';
 
+    if ($this->callback)
+    {
+       $return = call_user_func($this->callback, $this);
+       if ($return === false) // don't display is callback returns false explicitly.
+        return;
+    }
+
     switch($this->messageType)
     {
       case self::NOTICE_ERROR:
@@ -158,9 +184,24 @@ public function getForDisplay()
       $class .= 'is-persistent ';
     }
 
-      $id = ! is_null($this->id) ? 'id="' . $this->id . '"' : '';
+    $id = ! is_null($this->id) ?  $this->id : uniqid();
+    //'id="' . $this->id . '"'
+    $output = "<div id='$id' class='$class'><span class='icon'> " . $icon . "</span> <span class='content'>" . $this->message;
+    if ($this->hasDetails())
+    {
+      $output .= '<div class="details-wrapper">
+      <input type="checkbox" name="detailhider" id="check-' . $id .'">
+      <label for="check-' . $id . '"  class="show-details"><span>' . __('See Details', 'shortpixel-image-optimiser')   . '</span>
+      </label>';
+
+      $output .= "<div class='detail-content-wrapper'><p class='detail-content'>" . $this->parseDetails() . "</p></div>";
+      $output .= '<label for="check-' . $id . '" class="hide-details"><span>' . __('Hide Details', 'shortpixel-image-optimiser') . '</span></label>';
+
+      $output .= '</div>'; // detail rapper
+
+    }
+    $output .= "</span></div>";
 
-    $output = "<div $id class='$class'><span class='icon'> " . $icon . "</span> <span class='content'>" . $this->message . "</span></div>";
     if ($this->is_persistent && $this->is_removable)
     {
         $output .= "<script type='text/javascript'>\n" . $this->getDismissJS() . "\n</script>";
@@ -169,6 +210,19 @@ public function getForDisplay()
 
   }
 
+  protected function hasDetails()
+  {
+     if (is_array($this->details) && count($this->details) > 0)
+      return true;
+    else
+      return false;
+  }
+
+  protected function parseDetails()
+  {
+      return implode('<BR>', $this->details);
+  }
+
   private function getDismissJS()
   {
      $url = wp_json_encode(admin_url('admin-ajax.php'));
@@ -179,7 +233,7 @@ private function getDismissJS()
 
   //  $data_string = "{action:'$this->notice_action'}";
 
-      $js = "jQuery(document).on('click','#$this->id button',
+      $js = "jQuery(document).on('click','#$this->id button.notice-dismiss',
          function() {
            var data = $data;
            var url = $url;

build/shortpixel/shortq/composer.json

@@ -0,0 +1,18 @@
+{
+    "name": "shortpixel/shortq",
+    "description": "Simple Queue",
+    "version": 0.5,
+    "type": "library",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Bas",
+            "email": "bas@weblogmechanic.com"
+        }
+    ],
+    "minimum-stability": "dev",
+    "require": {},
+    "autoload": {
+        "psr-4": { "ShortPixel\\ShortQ\\" : "src" }
+    }
+}

build/shortpixel/shortq/src/DataProvider/DataProvider.php

@@ -0,0 +1,27 @@
+<?php
+namespace ReThumbAdvanced\ShortQ\DataProvider;
+use ReThumbAdvanced\ShortQ\Item as Item;
+
+
+/* DataProvider handles where the data is stored, and retrieval upon queue request
+*
+* DataProvider is responsible for creating it's own environment, and cleanup when uninstall is being called.
+*
+*/
+interface DataProvider
+{
+  
+  function __construct($pluginSlug, $queueName);
+
+  //function add($items);
+  function enqueue($items);
+  function dequeue($args); // @return Items removed from queue and set to status. Returns Item Object
+  function alterqueue($args); // @return Item Count / Boolean . Mass alteration of queue.
+  function itemUpdate(Item $item, $new_status);
+
+  // Returns number of items left in Queue.
+  function itemCount($mode = 'waiting');
+
+  function install();
+  function uninstall();
+}