Select converted images via .htaccess

src/class-tiny-apache-rewrite.php

@@ -0,0 +1,166 @@
+<?php
+/*
+* Tiny Compress Images - WordPress plugin.
+* Copyright (C) 2015-2018 Tinify B.V.
+*
+* This program is free software; you can redistribute it and/or modify it
+* under the terms of the GNU General Public License as published by the Free
+* Software Foundation; either version 2 of the License, or (at your option)
+* any later version.
+*
+* This program is distributed in the hope that it will be useful, but WITHOUT
+* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+* more details.
+*
+* You should have received a copy of the GNU General Public License along
+* with this program; if not, write to the Free Software Foundation, Inc., 51
+* Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n*/
+
+/**
+ * Tiny_Apache_Rewrite
+ * class responsible for the apache rules for image delivery.
+ * - toggling the rules when saving settings
+ * - inserting/removing rules from htaccess
+ *
+ * We are only updating rules when:
+ * - updating the option convert_format
+ * - uninstalling the plug-in
+ */
+class Tiny_Apache_Rewrite extends Tiny_WP_Base {
+
+	/**
+	 * seperator when rules are inserted
+	 * @var string
+	 */
+	const MARKER = 'tiny-compress-images';
+
+	/**
+	 * Installs or uninstalls the htaccess rules
+	 * hooked into `update_option_tinypng_convert_format`
+	 * https://developer.wordpress.org/reference/hooks/update_option_option/
+	 *
+	 *
+	 * @param mixed $old_value
+	 * @param mixed $value
+	 * @param string $option
+	 * @return void
+	 */
+	public static function toggle_rules( $old_value, $value, $option ) {
+		$old_delivery = isset( $old_value['delivery_method'] ) ?
+			$old_value['delivery_method'] : null;
+		$new_delivery = isset( $value['delivery_method'] ) ?
+			$value['delivery_method'] : null;
+
+		if ( $old_delivery === $new_delivery ) {
+			return;
+		}
+
+		if ( 'htaccess' === $new_delivery ) {
+			self::install_rules();
+			Tiny_Logger::debug( 'Installed image delivery rules' );
+			return;
+		}
+
+		// We only uninstall if we were previously using htaccess
+		if ( 'htaccess' === $old_delivery ) {
+			self::uninstall_rules();
+			Tiny_Logger::debug( 'Uninstalled image delivery rules' );
+		}
+	}
+
+	/**
+	 * Generate .htaccess rewrite rules for serving WebP and AVIF images.
+	 *
+	 * @return string The .htaccess rules
+	 */
+	private static function get_rewrite_rules() {
+		$rules   = array();
+		$rules[] = '<IfModule mod_rewrite.c>';
+		$rules[] = 'RewriteEngine On';
+		$rules[] = 'RewriteOptions Inherit';
+
+		$rules = array_merge( $rules, self::get_avif_rules() );
+		$rules = array_merge( $rules, self::get_webp_rules() );
+
+		$rules[] = '</IfModule>';
+
+		$rules[] = '<IfModule mod_headers.c>';
+		$rules[] = '<FilesMatch "\.(jpe?g|png|gif)$">';
+		$rules[] = 'Header append Vary Accept';
+		$rules[] = '</FilesMatch>';
+		$rules[] = '</IfModule>';
+
+		$rules[] = '<IfModule mod_mime.c>';
+		$rules[] = 'AddType image/webp .webp';
+		$rules[] = 'AddType image/avif .avif';
+		$rules[] = '</IfModule>';
+
+		return implode( "\n", $rules );
+	}
+
+	/**
+	 * Generate AVIF rewrite rules.
+	 *
+	 * @return array[] AVIF rewrite rules
+	 */
+	private static function get_avif_rules() {
+		$rules   = array();
+		$rules[] = 'RewriteCond %{HTTP_ACCEPT} image/avif';
+		$rules[] = 'RewriteCond %{REQUEST_URI} ^(.+)\.(?:jpe?g|png|gif)$';
+		$rules[] = 'RewriteCond %{DOCUMENT_ROOT}/%1.avif -f';
+		$rules[] = 'RewriteCond %{QUERY_STRING} !type=original';
+		$rules[] = 'RewriteRule (.+)\.(?:jpe?g|png|gif)$ $1.avif [T=image/avif,L]';
+		return $rules;
+	}
+
+	/**
+	 * Generate WebP rewrite rules.
+	 *
+	 * @return array[] WebP rewrite rules
+	 */
+	private static function get_webp_rules() {
+		$rules   = array();
+		$rules[] = 'RewriteCond %{HTTP_ACCEPT} image/webp';
+		$rules[] = 'RewriteCond %{REQUEST_URI} ^(.+)\.(?:jpe?g|png|gif)$';
+		$rules[] = 'RewriteCond %{DOCUMENT_ROOT}/%1.webp -f';
+		$rules[] = 'RewriteCond %{QUERY_STRING} !type=original';
+		$rules[] = 'RewriteRule (.+)\.(?:jpe?g|png|gif)$ $1.webp [T=image/webp,L]';
+
+		return $rules;
+	}
+
+	/**
+	 * Install rewrite rules to .htaccess files.
+	 *
+	 * @return bool True on success, false otherwise
+	 */
+	private static function install_rules() {
+		$rules = self::get_rewrite_rules();
+
+		$upload_dir = wp_upload_dir();
+		if ( isset( $upload_dir['basedir'] ) && is_writable( $upload_dir['basedir'] ) ) {
+			$htaccess_file = $upload_dir['basedir'] . '/.htaccess';
+			insert_with_markers( $htaccess_file, self::MARKER, $rules );
+		}
+
+		return true;
+	}
+
+	/**
+	 * Remove rewrite rules from .htaccess files.
+	 *
+	 * @return bool True on success, false otherwise
+	 */
+	public static function uninstall_rules() {
+		$upload_dir = wp_upload_dir();
+		if (
+			file_exists( $upload_dir['basedir'] . '/.htaccess' )
+		) {
+			$htaccess_file = $upload_dir['basedir'] . '/.htaccess';
+			insert_with_markers( $htaccess_file, self::MARKER, '' );
+		}
+
+		return true;
+	}
+}

src/class-tiny-conversion.php

@@ -0,0 +1,87 @@
+<?php
+/*
+* Tiny Compress Images - WordPress plugin.
+* Copyright (C) 2015-2018 Tinify B.V.
+*
+* This program is free software; you can redistribute it and/or modify it
+* under the terms of the GNU General Public License as published by the Free
+* Software Foundation; either version 2 of the License, or (at your option)
+* any later version.
+*
+* This program is distributed in the hope that it will be useful, but WITHOUT
+* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+* more details.
+*
+* You should have received a copy of the GNU General Public License along
+* with this program; if not, write to the Free Software Foundation, Inc., 51
+* Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+*/
+
+/**
+ * class managing conversion delivery method
+ */
+class Tiny_Conversion extends Tiny_WP_Base {
+
+	/**
+	 * @var Tiny_Settings plug-in settings
+	 */
+	private $settings;
+
+	/**
+	 * @param Tiny_Settings $settings
+	 */
+	public function __construct( $settings ) {
+		parent::__construct();
+		$this->settings = $settings;
+	}
+
+	/**
+	 * will check if conversion is enabled,
+	 * if true:
+	 * - will enable the delivery method
+	 * - will add hook to toggle rules
+	 *
+	 * hooked into `init`
+	 */
+	public function init() {
+		if ( ! $this->settings->get_conversion_enabled() ) {
+			return;
+		}
+
+		add_action(
+			'update_option_tinypng_convert_format',
+			'Tiny_Apache_Rewrite::toggle_rules',
+			20,
+			3
+		);
+
+		$delivery_method = $this->settings->get_conversion_delivery_method();
+
+		$this->init_image_delivery( $delivery_method );
+	}
+
+	/**
+	 * Initializes the method of delivery for optimised images
+	 *
+	 * @param string $delivery_method 'picture' or 'htaccess'
+	 * @return void
+	 */
+	private function init_image_delivery( $delivery_method ) {
+		/**
+		 * Controls wether the page should replace <img> with <picture> elements
+		 * converted sources.
+		 *
+		 * @since 3.7.0
+		 */
+		if ( 'htaccess' === $delivery_method && Tiny_Server_Capabilities::is_apache() ) {
+			new Tiny_Apache_Rewrite();
+			return;
+		}
+
+		if ( apply_filters( 'tiny_replace_with_picture', 'picture' === $delivery_method ) ) {
+			new Tiny_Picture( $this->settings, ABSPATH, array( get_site_url() ) );
+			return;
+		}
+	}
+}

src/class-tiny-plugin.php

@@ -40,6 +40,7 @@ public static function version() {
 	public function __construct() {
 		parent::__construct();
 		$this->settings = new Tiny_Settings();
+		new Tiny_Conversion( $this->settings );
 	}
 
 	public function set_compressor( $compressor ) {
@@ -72,7 +73,6 @@ public function init() {
 			dirname( plugin_basename( __FILE__ ) ) . '/languages'
 		);
 
-		new Tiny_Picture( $this->settings, ABSPATH, array( get_site_url() ) );
 		$this->tiny_compatibility();
 	}
 

src/class-tiny-server-capabilities.php

@@ -0,0 +1,116 @@
+<?php
+/*
+* Tiny Compress Images - WordPress plugin.
+* Copyright (C) 2015-2018 Tinify B.V.
+*
+* This program is free software; you can redistribute it and/or modify it
+* under the terms of the GNU General Public License as published by the Free
+* Software Foundation; either version 2 of the License, or (at your option)
+* any later version.
+*
+* This program is distributed in the hope that it will be useful, but WITHOUT
+* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+* more details.
+*
+* You should have received a copy of the GNU General Public License along
+* with this program; if not, write to the Free Software Foundation, Inc., 51
+* Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+*/
+
+/**
+ * class responsible for checking and managing server capabilities
+ */
+class Tiny_Server_Capabilities {
+
+	/**
+	 * Detect the web server software using WordPress globals.
+	 * WordPress sets $is_apache, $is_IIS, $is_iis7, and $is_nginx in wp-includes/vars.php
+	 *
+	 * @return string The server type: 'apache', 'nginx', 'iis', or 'unknown'
+	 */
+	private static function get_server_type() {
+		global $is_apache, $is_iis7, $is_nginx;
+
+		if ( $is_apache ) {
+			return 'apache';
+		}
+
+		if ( $is_nginx ) {
+			return 'nginx';
+		}
+
+		if ( $is_iis7 ) {
+			return 'iis';
+		}
+
+		return 'unknown';
+	}
+
+	/**
+	 * Check if the server is Apache.
+	 *
+	 * @return bool True if running on Apache
+	 */
+	public static function is_apache() {
+		return self::get_server_type() === 'apache';
+	}
+
+	/**
+	 * Check if mod_rewrite is available on Apache.
+	 *
+	 * @return bool True if mod_rewrite is available
+	 */
+	public static function has_mod_rewrite() {
+		if ( ! self::is_apache() ) {
+			return false;
+		}
+
+		if ( function_exists( 'apache_mod_loaded' ) ) {
+			return apache_mod_loaded( 'mod_rewrite' );
+		}
+
+		if ( function_exists( 'apache_get_modules' ) ) {
+			$modules = apache_get_modules();
+			return in_array( 'mod_rewrite', $modules, true );
+		}
+
+		if ( function_exists( 'insert_with_markers' ) ) {
+			$htaccess = wp_upload_dir() . '.htaccess';
+			return is_writable( dirname( $htaccess ) );
+		}
+
+		return false;
+	}
+
+	/**
+	 * Check if the /uploads directory is writable for .htaccess.
+	 *
+	 * @return bool True if uploads directory is writable, false otherwise
+	 */
+	public static function uploads_htaccess_writable() {
+		$upload_dir = wp_upload_dir();
+		if ( isset( $upload_dir['basedir'] ) ) {
+			return is_writable( $upload_dir['basedir'] );
+		}
+		return false;
+	}
+
+	/**
+	 * Get a detailed capabilities object.
+	 *
+	 * @return array Array with properties: server, is_apache, has_mod_rewrite,
+	 * uploads_writable, htaccess_available
+	 */
+	public static function get_capabilities() {
+		return array(
+			'server'             => self::get_server_type(),
+			'is_apache'          => self::is_apache(),
+			'has_mod_rewrite'    => self::has_mod_rewrite(),
+			'uploads_writable'   => self::uploads_htaccess_writable(),
+			'htaccess_available' => self::is_apache() &&
+				self::has_mod_rewrite() &&
+				self::uploads_htaccess_writable(),
+		);
+	}
+}