Release version 4.1.1 (#95)

Merge pull request #95 from short-pixel-optimizer/updates

Author: pdobrescu

build/shortpixel/filesystem/src/Model/File/FileModel.php

@@ -228,9 +228,15 @@ public function getFileDir()
 
   public function getFileSize()
   {
-    if ($this->exists())
+		if ($this->exists() && false === $this->is_virtual() )
+		{
       return filesize($this->fullpath);
-    else
+		}
+    elseif (true === $this->is_virtual())
+		{
+			 return -1;
+		}
+		else
       return 0;
   }
 

build/shortpixel/replacer/src/Replacer.php

@@ -190,7 +190,8 @@ public function replace($args = array())
 	       Log::addDebug('Running additional replace for : '. $component, $run);
 	       $updated += $this->doReplaceQuery($run['base_url'], $run['search_urls'], $run['replace_urls']);
 	    }
-	    //do_action('')
+
+			do_action('shortpixel/replacer/after_replacing', $base_url, $search_urls, $replace_urls);
 
 	    Log::addDebug("Updated Records : " . $updated);
 	    return $updated;
@@ -378,7 +379,7 @@ private function change_key($arr, $set) {
     	}
     	return $arr;
   }
-	
+
 	private function getRelativeURLS()
   {
       $dataArray = array(

classes/Controller/ReplaceController.php

@@ -40,6 +40,7 @@ class ReplaceController
 	protected $tmpUploadPath;
 
 	protected $lastError;
+	protected $lastErrorData; // optional extra data for last error.
 
 		public function __construct($post_id)
 		{
@@ -91,6 +92,15 @@ public function returnLastError()
 			 return $this->lastError;
 		}
 
+		public function returnLastErrorData()
+		{
+			 if (! is_null($this->lastErrorData))
+			 	return $this->lastErrorData;
+			 else {
+			 		return array();
+			 }
+		}
+
 		public function run()
 		{
 			do_action('wp_handle_replace', array('post_id' => $this->post_id));
@@ -104,6 +114,7 @@ public function run()
 			$targetFileObj = $this->fs()->getFile($this->targetFile);
 
 			$directoryObj = $targetFileObj->getFileDir();
+
 			$result = $directoryObj->check();
 
 			if ($result === false)
@@ -182,9 +193,9 @@ public function run()
 			do_action('emr/converter/prevent-offload', $this->post_id);
       $target_metadata = wp_generate_attachment_metadata( $this->post_id, $this->targetFile->getFullPath() );
 			do_action('emr/converter/prevent-offload-off', $this->post_id);
-
       wp_update_attachment_metadata( $this->post_id, $target_metadata );
 
+
 			$Replacer->setTargetMeta($target_metadata);
 			//$this->target_metadata = $metadata;
 
@@ -235,6 +246,7 @@ public function run()
 			$args = array(
           'thumbnails_only' => ($this->replaceType == self::MODE_SEARCHREPLACE) ? false : true,
       );
+
 			$Replacer->replace($args);
 
 			// Here Updatedata and a ffew others.
@@ -258,42 +270,64 @@ public function run()
 		protected function setupSource()
 		{
 				$source_file = false;
+
+				// The main image as registered in attached_file metadata.  This can be regular or -scaled.
+				$source_file_main = trim(get_attached_file($this->post_id, apply_filters( 'emr_unfiltered_get_attached_file', true )));
+
+				// If available it -needs- to use the main image when replacing since treating a -scaled images as main will create a resursion in the filename when not replacing that one . Ie image-scaled-scaled.jpg or image-scaled-100x100.jpg .
 				if (function_exists('wp_get_original_image_path')) // WP 5.3+
 				{
 						$source_file = wp_get_original_image_path($this->post_id, apply_filters( 'emr_unfiltered_get_attached_file', true ));
-						// For offload et al to change path if wrong.
+						// For offload et al to change path if wrong. Somehow this happens?
 						$source_file = apply_filters('emr/replace/original_image_path', $source_file, $this->post_id);
+
 			 }
 
-			 if (false === $source_file)
+			 if (false === $source_file) // If not scaled, use the main one.
 			 {
-				 $source_file = trim(get_attached_file($this->post_id, apply_filters( 'emr_unfiltered_get_attached_file', true )));
+				 	$source_file = $source_file_main;
 			 }
 
+
 				$sourceFileObj = $this->fs()->getFile($source_file);
+				$isVirtual = false;
 				if ($sourceFileObj->is_virtual())
 				{
+						$isVirtual = true;
+
+						/***
+						*** Either here the table should check scaled - non-scaled ** or ** the original_path should be updated.
+						***
+
+						*/
+
 						$this->sourceFileUntranslated = $this->fs()->getFile($source_file);
-						$sourcePath = apply_filters('emr/file/virtual/translate', $sourceFileObj->getFullPath(), $sourceFileObj);
+						$sourcePath = apply_filters('emr/file/virtual/translate', $sourceFileObj->getFullPath(), $sourceFileObj, $this->post_id);
 
-						if ($sourceFileObj->getFullPath() !== $sourcePath)
+						if (false !== $sourcePath && $sourceFileObj->getFullPath() !== $sourcePath)
 						{
 							 $sourceFileObj = $this->fs()->getFile($sourcePath);
 							 $source_file = $sourcePath;
 						}
+
 				}
+
+
 				/* It happens that the SourceFile returns relative / incomplete when something messes up get_upload_dir with an error something.
 					 This case shoudl be detected here and create a non-relative path anyhow..
 				*/
-
-				if (! file_exists($source_file) && $source_file && 0 !== strpos( $source_file, '/' ) && ! preg_match( '|^.:\\\|', $source_file ) )
+				if (
+					false === $isVirtual &&
+					false === file_exists($source_file) &&
+					$source_file && 0 !== strpos( $source_file, '/' )
+					&& ! preg_match( '|^.:\\\|', $source_file ) )
 				{
 					$file = get_post_meta( $this->post_id, '_wp_attached_file', true );
 					$uploads = wp_get_upload_dir();
 					$source_file = $uploads['basedir'] . "/$source_file";
 				}
 
-				Log::addDebug('SourceFile ' . $source_file);
+				Log::addDebug('SetupSource SourceFile Path ' . $source_file);
 				$this->sourceFile = $this->fs()->getFile($source_file);
 		}
 
@@ -505,11 +539,13 @@ protected function getNewTargetLocation()
 				$newPath = trailingslashit($uploadDir['basedir']) . $new_rel_location;
 
 				$realPath = realpath($newPath);
+				$basedir = realpath($uploadDir['basedir']); // both need to go to realpath, otherwise some servers will have issues with it.
 
 				// Detect traversal by making sure the canonical path starts with uploads' basedir.
-			 	if ( strpos($realPath, $uploadDir['basedir']) !== 0)
+			 	if ( strpos($realPath, $basedir) !== 0)
 			 	{
 					$this->lastError = self::ERROR_DIRECTORY_SECURITY;
+					$this->lastErrorData = array('path' => $realPath, 'basedir' => $basedir);
 					return false;
 				}
 

classes/ViewController.php

@@ -74,7 +74,7 @@ protected function loadView($template = null, $unique = true)
 				}
 		}
 
-		protected function viewError($errorCode)
+		protected function viewError($errorCode, $errorData = array())
 		{
 			 $message = $description = false;
 			 switch($errorCode)
@@ -114,6 +114,13 @@ protected function viewError($errorCode)
 					break;
 					case self::ERROR_DIRECTORY_SECURITY:
 						$message = __('Specificed directory is outside the upload directory. This is not allowed for security reasons', 'enable-media-replace');
+						$path = isset($errorData['path']) ? $errorData['path'] : false;
+						$basedir = isset($errorData['basedir']) ? $errorData['basedir'] : false;
+
+						if ($path !== false && $basedir !== false)
+						{
+							 $description  = sprintf(__('Path: %s is not within basedir reported as: %s', 'shortpixel-image-optimiser'), $path, $basedir);
+						}
 					break;
 					case self::ERROR_DIRECTORY_NOTEXIST:
 						$message = __('Specificed new directory does not exist. Path must be a relative path from the upload directory and exist', 'enable-media-replace');
@@ -137,6 +144,7 @@ protected function viewError($errorCode)
 			 if( false !== $message)
 			 	$this->view->errorMessage = $message;
 
+
 			 if (false !== $description)
 			 {
 				  $this->view->errorDescription = $description;

classes/ViewController/UploadViewController.php

@@ -80,7 +80,8 @@ public function load()
 		if (false === $check)
 		{
 			 $error = $replaceController->returnLastError();
-			 $this->viewError($error);
+			 $data = $replaceController->returnLastErrorData();
+			 $this->viewError($error, $data);
 		}
 
 		$result = $replaceController->run();
@@ -120,15 +121,7 @@ protected function getPost()
 		         Log::addDebug('Custom Date - ' . $custom_date . ' ' . $custom_hour . ':' . $custom_minute);
 		         $custom_date = \DateTime::createFromFormat('Y-m-d G:i', $custom_date . ' ' . $custom_hour . ':' . $custom_minute);
 		         if ($custom_date === false) {
-		             /*wp_safe_redirect($redirect_error);
-		             $errors = \DateTime::getLastErrors();
-		             $error = '';
-		             if (isset($errors['errors'])) {
-		                 $error = implode(',', $errors['errors']);
-		             } */
-		             //Notices::addError(sprintf(__('Invalid Custom Date. Please check the custom date values: (%s)', 'enable-media-replace'), $error));
 								 $this->viewError(self::ERROR_TIME);
-		             //exit();
 		         }
 		         $datetime  =  $custom_date->format("Y-m-d H:i:s");
 						 $is_custom_date = true;
@@ -201,7 +194,6 @@ protected function getUpload()
 				 }
 
 				 if ($filedata["ext"] == false && ! current_user_can('unfiltered_upload')) {
-//						 Log::addWarn('Uploaded File type does not meet security guidelines, aborting');
 						  $this->viewError(self::ERROR_SECURITY);
 				 }
 

classes/emr-plugin.php

@@ -332,6 +332,10 @@ public function admin_scripts()
         wp_localize_script('emr_admin', 'emr_options', $emr_options);
 
 				wp_register_script('emr_success', plugins_url('js/emr_success.js', EMR_ROOT_FILE), array(), EMR_VERSION, true);
+
+				wp_localize_script('emr_success', 'emr_success_options', array(
+					'timeout' => apply_filters('emr/success/timeout', 10),
+				));
     }
 
   /** Utility function for the Jquery UI Datepicker */

classes/external/wp-offload.php

@@ -18,12 +18,12 @@ class WPOffload
 
 		private static $offloadPrevented = array();
 
+		private $post_id; // source_id.  The plugin has this, so why so tricky checks.
+
 
 		public function __construct()
 		{
 			add_action('as3cf_init', array($this, 'init'));
-			add_filter('shortpixel/image/urltopath', array($this, 'checkIfOffloaded'), 10,2);
-
 
 			add_action('emr/converter/prevent-offload', array($this, 'preventOffload'), 10);
 			add_action('emr/converter/prevent-offload-off', array($this, 'preventOffloadOff'), 10);
@@ -60,11 +60,15 @@ public function init($as3cf)
 					return false;
 				}
 
+				add_filter('shortpixel/image/urltopath', array($this, 'checkIfOffloaded'), 10,2);
+
 				add_action('emr_after_remove_current', array($this, 'removeRemote'), 10, 5);
-				add_filter('emr/file/virtual/translate', array($this, 'getLocalPathByURL'));
+				add_filter('emr/file/virtual/translate', array($this, 'getLocalPath'), 10, 3);
 				add_filter('emr/replace/file_is_movable', array($this, 'isFileMovable'), 10, 2);
 
 				add_filter('emr/replace/original_image_path', array($this, 'checkScaledUrl'), 10,2);
+
+				add_action('enable-media-replace-upload-done', array($this, 'updateOriginalPath'), 10, 3);
 		}
 
 		/*
@@ -93,15 +97,22 @@ public function removeRemote($post_id, $meta, $backup_sizes, $sourceFile, $targe
 
 		// @param s3 based URL that which is needed for finding local path
 		// @return String Filepath.  Translated file path
-		public function getLocalPathByURL($url)
+		public function getLocalPath($url, $sourceFileObj, $source_id)
 		{
-			 $source_id = $this->getSourceIDByURL($url);
+			 $item = $this->getItemById($source_id);
+
+			 if ($item === false)
+			 {
+			 	$source_id = $this->getSourceIDByURL($url);
+				if (false !== $source_id)
+					$item = $this->getItemById($source_id);
+			 }
 
 			 if ($source_id == false)
 			 {
+				Log::addError('Get Local Path: No source id for URL (Offload) ' . $url);
 				return false;
 			}
-			 $item = $this->getItemById($source_id);
 
 			 $original_path = $item->original_source_path(); // $values['original_source_path'];
 
@@ -117,6 +128,8 @@ public function getLocalPathByURL($url)
 			 return $file;
 		}
 
+
+
 		public function isFileMovable($bool, $attach_id)
 		{
 				$item = $this->getItemById($attach_id);
@@ -138,7 +151,6 @@ public function checkIfOffloaded($bool, $url)
 
 			$source_id = $this->sourceCache($url);
 
-
 			if (false === $source_id)
 			{
 				$extension = substr($url, strrpos($url, '.') + 1);
@@ -172,6 +184,38 @@ public function preventOffloadOff($attach_id)
 				unset(self::$offloadPrevented[$attach_id]);
 		}
 
+		public function updateOriginalPath($source_url, $target_url, $post_id)
+		{
+				$item = $this->getItemById($post_id);
+
+				$original_path = $item->original_path(); // Original path (non-scaled-)
+				$original_source_path = $item->original_source_path();
+				$path = $item->path();
+				$source_path = $item->source_path();
+
+				$wp_original = wp_get_original_image_path($post_id, apply_filters( 'emr_unfiltered_get_attached_file', true ));
+				$wp_original = apply_filters('emr/replace/original_image_path', $wp_original, $post_id);
+				$wp_source = trim(get_attached_file($post_id, apply_filters( 'emr_unfiltered_get_attached_file', true )));
+
+				$updated = false;
+
+				// If image is replaced with another name, the original soruce path will not match.  This could also happen when an image is with -scaled as main is replaced by an image that doesn't have it.  In all cases update the table to reflect proper changes.
+				if (wp_basename($wp_original) !== wp_basename($original_path))
+				{
+
+					 $newpath = str_replace( wp_basename( $original_path ), wp_basename($wp_original), $original_path );
+
+					 $item->set_original_path($newpath);
+
+					 $newpath = str_replace( wp_basename( $original_source_path ), wp_basename($wp_original), $original_source_path );
+					 $updated = true;
+
+					 $item->set_original_source_path($newpath);
+
+					 $item->save();
+				}
+		}
+
 		// When Offload is not offloaded but is created during the process of generate metadata in WP, wp_create_image_subsizes fires an update metadata after just moving the upload, before making any thumbnails.  If this is the case and the file has an -scaled / original image setup, the original_source_path becomes the same as the source_path which creates issue later on when dealing with optimizing it, if the file is deleted on local server.  Prevent this, and lean on later update metadata.
 		public function preventUpdateMetaData($bool, $data, $post_id, $old_provider_object)
 		{
@@ -184,6 +228,8 @@ public function preventUpdateMetaData($bool, $data, $post_id, $old_provider_obje
 
 		}
 
+
+
 		// WP Offload -for some reason - returns the same result of get_attached_file and wp_get_original_image_path , which are different files (one scaled) which then causes a wrong copy action after optimizing the image ( wrong destination download of the remote file ).   This happens if offload with delete is on.  Attempt to fix the URL to reflect the differences between -scaled and not.
 		public function checkScaledUrl($filepath, $id)
 		{
@@ -226,6 +272,7 @@ protected function getSourceIDByURL($url)
 				}
 
       	$source = $class::get_item_source_by_remote_url($url);
+
 				$source_id = isset($source['id']) ? intval($source['id']) : false;
 			}
 

classes/uihelper.php

@@ -417,7 +417,7 @@ public function getPlaceHolder($args)
     $output = "<div class='image_placeholder $placeholder_class' $filetype style='width:" . $w . "px; height:". $h ."px'> ";
 		if (true === $args['is_upload'])
 		{
-			$output .= "<span class='upload-title'>" . __('New', 'enable-media-replacer') . "</span>";
+			$output .= "<span class='upload-title'>" . __('New', 'enable-media-replace') . "</span>";
 			$output .= '<input type="file" name="userfile" id="upload-file" />';
 				$output .= '<div class="drag-and-drop-title">
                               <span>' . __('Click here to upload or drop file in area', 'enable-media-replace') . '</span>