Merge pull request #534 from Codeinwp/fix/issue-695

Add option to disable strip_metadata

Author: selul

assets/vue/components/compression.vue

@@ -80,6 +80,29 @@
       </div>
     </div>
     <hr/>
+    <!-- Use strip metadata toggle button -->
+    <div class="field  columns">
+      <label class="label column has-text-grey-dark optml-custom-label-margin">
+        {{ strings.strip_meta_title }}
+
+        <p class="optml-settings-desc-margin has-text-weight-normal">
+          {{ strings.strip_meta_desc }}
+        </p>
+      </label>
+
+      <div class="column is-1 ">
+        <toggle-button
+            v-model="stripMetadataStatus"
+            :class="'has-text-dark'"
+            :disabled="this.$store.state.loading"
+            :width="37"
+            :height="20"
+            color="#577BF9"
+        />
+      </div>
+    </div>
+    <hr/>
+    <!-- Use ML toggle button -->
     <div class="field  columns">
       <label class="label column has-text-grey-dark optml-custom-label-margin">
         {{ strings.quality_title }}
@@ -100,8 +123,8 @@
             color="#577BF9"
         />
       </div>
-
     </div>
+
     <div class="field  columns" v-if="showManualQuality">
 
       <div class="column">
@@ -333,6 +356,16 @@ export default {
         return !(this.site_settings.autoquality === 'disabled');
       }
     },
+    stripMetadataStatus: {
+      set: function (value) {
+        this.showSave = true;
+        this.new_data.strip_metadata = value ? 'enabled' : 'disabled';
+      },
+      get: function () {
+        return !(this.site_settings.strip_metadata === 'disabled');
+
+      }
+    },
     compressionRatio() {
       if (this.sample_images.optimized_size > this.sample_images.original_size) {
         return Math.floor(Math.random() * 60) + 10;

inc/admin.php

@@ -963,6 +963,8 @@ private function get_dashboard_strings() {
 				'quality_selected_value'            => __( 'Selected value', 'optimole-wp' ),
 				'quality_slider_desc'               => __( 'See one sample image which will help you choose the right quality of the compression.', 'optimole-wp' ),
 				'quality_title'                     => __( 'Enable Auto Quality powered by ML(Machine Learning)', 'optimole-wp' ),
+				'strip_meta_title'                  => __( 'Strip Image Metadata', 'optimole-wp' ),
+				'strip_meta_desc'                   => __( 'When enabled, Optimole will strip the metadata (EXIF, IPTC, etc.) from output images.', 'optimole-wp' ),
 				'replacer_desc'                     => __( 'Replace all the image urls from your website with the ones optimized by Optimole.', 'optimole-wp' ),
 				'sample_image_loading'              => __( 'Loading a sample image. ', 'optimole-wp' ),
 				'save_changes'                      => __( 'Save changes', 'optimole-wp' ),

inc/image.php

@@ -100,6 +100,10 @@ public function get_url( $params = [] ) {
 			$path = '/f:' . $params['format'] . '/' . $this->source_url;
 		}
 
+		if ( isset( $params['strip_metadata'] ) && '0' === $params['strip_metadata'] ) {
+			$path = '/sm:' . $params['strip_metadata'] . $path;
+		}
+
 		if ( apply_filters( 'optml_keep_copyright', false ) === true ) {
 			$path = '/keep_copyright:true' . $path;
 		}

inc/settings.php

@@ -86,6 +86,7 @@ class Optml_Settings {
 		'native_lazyload'      => 'disabled',
 		'offload_media'        => 'disabled',
 		'cloud_images'         => 'disabled',
+		'strip_metadata'       => 'enabled',
 		'skip_lazyload_images' => 3,
 		'defined_image_sizes'          => [ ],
 
@@ -243,6 +244,7 @@ public function parse_settings( $new_settings ) {
 				case 'css_minify':
 				case 'js_minify':
 				case 'native_lazyload':
+				case 'strip_metadata':
 				case 'no_script':
 					$sanitized_value = $this->to_map_values( $value, [ 'enabled', 'disabled' ], 'enabled' );
 					break;
@@ -443,6 +445,7 @@ public function get_site_settings() {
 			'autoquality'          => $this->get( 'autoquality' ),
 			'offload_media'        => $this->get( 'offload_media' ),
 			'cloud_images'         => $this->get( 'cloud_images' ),
+			'strip_metadata'       => $this->get( 'strip_metadata' ),
 			'whitelist_domains'    => $whitelist,
 		];
 	}

inc/url_replacer.php

@@ -256,6 +256,10 @@ private function normalize_image( $url, $original_url, $args, $is_uploaded = fal
 			$arguments['format'] = 'avif';
 		}
 
+		if ( $this->settings->get( 'strip_metadata' ) === 'disabled' ) {
+			$arguments['strip_metadata'] = '0';
+		}
+
 		return  ( new Optml_Image( $url, $args, $this->active_cache_buster ) )->get_url( $arguments );
 
 	}

tests/test-replacer.php

@@ -639,4 +639,16 @@ public function test_class_exclusion()
 		$this->assertStringNotContainsString('data-opt-src', $replaced_content);
 	}
 
+	public function test_strip_metadata() {
+		$replaced_content = Optml_Manager::instance()->replace_content( self::IMG_URLS );
+		$this->assertStringNotContainsString( '/sm:0/', $replaced_content );
+
+		// To do same check but after we've disabled the strip metadata option.
+		$settings = new Optml_Settings();
+		$settings->update( 'strip_metadata', 'disabled' );
+		Optml_Manager::instance()->init();
+		$replaced_content = Optml_Manager::instance()->replace_content( self::IMG_URLS );
+		$this->assertEquals( 27, substr_count( $replaced_content, '/sm:0/' ) );
+	}
+
 }