File Manager

<?php

namespace Imagely\NGG\DynamicThumbnails;

use Imagely\NGG\DataMappers\Image as ImageMapper;
use Imagely\NGG\Display\I18N;
use Imagely\NGG\Settings\Settings;

class Manager {

	protected static $instance;

	/**
	 * @return Manager
	 */
	static function get_instance() {
		if ( ! isset( self::$instance ) ) {
			self::$instance = new Manager();
		}
		return self::$instance;
	}

	/**
	 * @return string
	 */
	public function get_route_name() {
		return Settings::get_instance()->get( 'dynamic_thumbnail_slug' );
	}

	/**
	 * @param array $params
	 * @return array
	 */
	public function _get_params_sanitized( $params ) {
		if ( isset( $params['rotation'] ) ) {
			$rotation = intval( $params['rotation'] );

			if ( $rotation && in_array( abs( $rotation ), [ 90, 180, 270 ] ) ) {
				$rotation = $rotation % 360;

				if ( $rotation < 0 ) {
					$rotation = 360 - $rotation;
				}

				$params['rotation'] = $rotation;
			} else {
				unset( $params['rotation'] );
			}
		}

		if ( isset( $params['flip'] ) ) {
			$flip = strtolower( $params['flip'] );

			if ( in_array( $flip, [ 'h', 'v', 'hv' ] ) ) {
				$params['flip'] = $flip;
			} else {
				unset( $params['flip'] );
			}
		}

		return $params;
	}

	/**
	 * @param array $params
	 * @return string
	 */
	public function get_uri_from_params( $params ) {
		$params = $this->_get_params_sanitized( $params );

		$image = isset( $params['image'] ) ? $params['image'] : null;

		$image_id = ( is_scalar( $image ) || is_null( $image ) ) ? (int) $image : $image->pid;

		$image_width      = isset( $params['width'] ) ? $params['width'] : null;
		$image_height     = isset( $params['height'] ) ? $params['height'] : null;
		$image_quality    = isset( $params['quality'] ) ? $params['quality'] : null;
		$image_type       = isset( $params['type'] ) ? $params['type'] : null;
		$image_crop       = isset( $params['crop'] ) ? $params['crop'] : null;
		$image_watermark  = isset( $params['watermark'] ) ? $params['watermark'] : null;
		$image_rotation   = isset( $params['rotation'] ) ? $params['rotation'] : null;
		$image_flip       = isset( $params['flip'] ) ? $params['flip'] : null;
		$image_reflection = isset( $params['reflection'] ) ? $params['reflection'] : null;

		$uri  = '/' . $this->get_route_name() . '/';
		$uri .= strval( $image_id ) . '/';
		$uri .= strval( $image_width ) . 'x' . strval( $image_height );

		if ( $image_quality != null ) {
			$uri .= 'x' . strval( $image_quality );
		}

		$uri .= '/';

		if ( $image_type != null ) {
			$uri .= $image_type . '/';
		}

		if ( $image_crop ) {
			$uri .= 'crop/';
		}

		if ( $image_watermark ) {
			$uri .= 'watermark/';
		}

		if ( $image_rotation ) {
			$uri .= 'rotation-' . $image_rotation . '/';
		}

		if ( $image_flip ) {
			$uri .= 'flip-' . $image_flip . '/';
		}

		if ( $image_reflection ) {
			$uri .= 'reflection/';
		}

		return $uri;
	}

	/**
	 * @param \Imagely\NGG\DataTypes\Image $image
	 * @param array                        $params
	 * @return string
	 */
	public function get_image_uri( $image, $params ) {
		$params['image'] = $image;
		$uri             = $this->get_uri_from_params( $params );

		if ( substr( $uri, -1 ) != '/' ) {
			$uri .= '/';
		}

		$uri .= wp_hash( $uri ) . '/';

		return $uri;
	}

	/**
	 * @param string $uri
	 * @return array|null
	 */
	public function get_params_from_uri( $uri ) {
		$regex = '/\\/?' . $this->get_route_name() . '\\/(\\d+)(?:\\/(.*))?/';
		$match = null;

		$uri = preg_replace( '/\\/index.php\\//', '/', $uri, 1 );
		$uri = trim( $uri, '/' );

		if ( @preg_match( $regex, $uri, $match ) > 0 ) {
			$image_id = $match[1];
			$uri_args = isset( $match[2] ) ? explode( '/', $match[2] ) : [];
			$params   = [ 'image' => $image_id ];

			foreach ( $uri_args as $uri_arg ) {
				$uri_arg_set   = explode( '-', $uri_arg );
				$uri_arg_name  = array_shift( $uri_arg_set );
				$uri_arg_value = $uri_arg_set ? array_shift( $uri_arg_set ) : null;
				$size_match    = null;

				if ( $uri_arg == 'watermark' ) {
					$params['watermark'] = true;
				} elseif ( $uri_arg_name == 'rotation' ) {
					$params['rotation'] = $uri_arg_value;
				} elseif ( $uri_arg_name == 'flip' ) {
					$params['flip'] = $uri_arg_value;
				} elseif ( $uri_arg == 'reflection' ) {
					$params['reflection'] = true;
				} elseif ( $uri_arg == 'crop' ) {
					$params['crop'] = true;
				} elseif ( in_array( strtolower( $uri_arg ), apply_filters( 'ngg_allowed_file_types', NGG_DEFAULT_ALLOWED_FILE_TYPES ) ) ) {
					$params['type'] = $uri_arg;
				} elseif ( preg_match( '/(\\d+)x(\\d+)(?:x(\\d+))?/i', $uri_arg, $size_match ) > 0 ) {
					$params['width']  = $size_match[1];
					$params['height'] = $size_match[2];

					if ( isset( $size_match[3] ) ) {
						$params['quality'] = $size_match[3];
					}
				}
			}

			return $this->_get_params_sanitized( $params );
		}

		return null;
	}

	/**
	 * @return array
	 */
	public function _get_name_prefix_list() {
		// Note: max_value_Length can't be increased beyond 15, as a single hexadecimal character is used to encode the
		// value length in names. Increasing it over 15 requires changing the algorithm to use an arbitrary letter instead
		// of a hexadecimal digit (this would bump max length to 35, 9 numbers + 26 letters).
		return [
			'id'               => 'nggid0',
			'size'             => 'ngg0dyn-',
			'flags'            => '00f0',
			'flag'             => [
				'w0' => 'watermark',
				'c0' => 'crop',
				'r1' => 'rotation',
				'f1' => 'flip',
				'r0' => 'reflection',
				't0' => 'type',
			],
			'flag_len'         => 2,
			'max_value_length' => 15,
		];
	}

	/**
	 * @param array $params
	 * @param bool  $only_size_name
	 * @param bool  $id_in_name
	 * @return string
	 */
	public function get_name_from_params( $params, $only_size_name = false, $id_in_name = true ) {
		$prefix_list      = $this->_get_name_prefix_list();
		$id_prefix        = $prefix_list['id'];
		$size_prefix      = $prefix_list['size'];
		$flags_prefix     = $prefix_list['flags'];
		$flags            = $prefix_list['flag'];
		$max_value_length = $prefix_list['max_value_length'];

		$params        = $this->_get_params_sanitized( $params );
		$image         = isset( $params['image'] ) ? $params['image'] : null;
		$image_width   = isset( $params['width'] ) ? $params['width'] : null;
		$image_height  = isset( $params['height'] ) ? $params['height'] : null;
		$image_quality = isset( $params['quality'] ) ? $params['quality'] : null;

		$extension = null;
		$name      = null;

		// if $only_size_name is false then we include the file name and image id for the image.
		if ( ! $only_size_name ) {
			if ( is_int( $image ) ) {
				$imap  = ImageMapper::get_instance();
				$image = $imap->find( $image );
			}

			if ( $image != null ) {
				// this is used to remove the extension and then add it back at the end of the name.
				$extension = I18N::mb_pathinfo( $image->filename, PATHINFO_EXTENSION );

				if ( $extension != null ) {
					$extension = '.' . $extension;
				}

				$name .= I18N::mb_basename( $image->filename );
				$name .= '-';

				if ( $id_in_name ) {
					$image_id   = strval( $image->pid );
					$id_len     = min( $max_value_length, strlen( $image_id ) );
					$id_len_hex = dechex( $id_len );

					// sanity check, should never occurr if $max_value_length is not messed up, ensure only 1 character is used to encode length or else skip parameter.
					if ( strlen( $id_len_hex ) == 1 ) {
						$name .= $id_prefix . $id_len . substr( $image_id, 0, $id_len );
						$name .= '-';
					}
				}
			}
		}

		$name .= $size_prefix;
		$name .= strval( $image_width ) . 'x' . strval( $image_height );

		if ( $image_quality != null ) {
			$name .= 'x' . $image_quality;
		}

		$name .= '-';

		$name .= $flags_prefix;

		foreach ( $flags as $flag_prefix => $flag_name ) {
			$flag_value = 0;

			if ( isset( $params[ $flag_name ] ) ) {
				$flag_value = $params[ $flag_name ];

				if ( ! is_string( $flag_value ) ) {
					// only strings or ints allowed, sprintf is required because intval(0) returns '' and not '0'.
					$flag_value = intval( $flag_value );
					$flag_value = sprintf( '%d', $flag_value );
				}
			}

			$flag_value   = strval( $flag_value );
			$flag_len     = min( $max_value_length, strlen( $flag_value ) );
			$flag_len_hex = dechex( $flag_len );

			// sanity check, should never occurr if $max_value_length is not messed up, ensure only 1 character is used to encode length or else skip parameter.
			if ( strlen( $flag_len_hex ) == 1 ) {
				$name .= $flag_prefix . $flag_len . substr( $flag_value, 0, $flag_len );
			}
		}

		$name .= $extension;

		return $name;
	}

	/**
	 * @param array $params
	 * @return string
	 */
	public function get_size_name( $params ) {
		return $this->get_name_from_params( $params, true );
	}

	/**
	 * @param \Imagely\NGG\DataTypes\Image $image
	 * @param array                        $params
	 * @return string
	 */
	public function get_image_name( $image, $params ) {
		$params['image'] = $image;
		return $this->get_name_from_params( $params );
	}

	/**
	 * @param string $name
	 * @param bool   $is_only_size_name
	 * @return array
	 */
	public function get_params_from_name( $name, $is_only_size_name = false ) {
		$prefix_list      = $this->_get_name_prefix_list();
		$id_prefix        = $prefix_list['id'];
		$size_prefix      = $prefix_list['size'];
		$flags_prefix     = $prefix_list['flags'];
		$max_value_length = $prefix_list['max_value_length'];
		$size_name        = '';
		$id_name          = '';
		$params           = [];

		if ( ! $is_only_size_name ) {
			$name = I18N::mb_basename( $name );
		}

		$size_index = strrpos( $name, $size_prefix );

		// check if name contains dynamic size/params info by looking for prefix.
		if ( $size_index > 0 || $size_index === 0 ) {
			$size_name = substr( $name, $size_index );
		}

		if ( ! $is_only_size_name ) {
			// name should contain the image id, search for prefix.
			$id_index = strrpos( $name, $id_prefix );

			if ( $id_index > 0 || $id_index === 0 ) {
				if ( $size_index > 0 && $size_index > $id_index ) {
					$id_name = substr( $name, $id_index, ( $size_index - $id_index ) );
				} else {
					$id_name = substr( $name, $id_index );
				}
			}
		}

		// Double check we got a correct dynamic size/params string.
		if ( substr( $size_name, 0, strlen( $size_prefix ) ) == $size_prefix ) {
			$flags = $prefix_list['flag'];
			// get the length of the flag id (the key in the $flags array) in the string (how many characters to consume).
			$flag_id_len  = $prefix_list['flag_len'];
			$params_str   = substr( $size_name, strlen( $size_prefix ) );
			$params_parts = explode( '-', $params_str );

			// $param_part is a single param, separated by '-'
			foreach ( $params_parts as $param_part ) {
				// Parse WxHxQ - Q=quality.
				$param_size       = explode( 'x', $param_part );
				$param_size_count = count( $param_size );

				if ( substr( $param_part, 0, strlen( $flags_prefix ) ) == $flags_prefix ) {
					// Set flags, using $flags keys as prefixes.

					// move string pointer up (after the main flags prefix).
					$param_flags     = substr( $param_part, strlen( $flags_prefix ) );
					$param_flags_len = strlen( $param_flags );
					$flags_todo      = $flags;

					while ( true ) {
						// ensure we don't run into an infinite loop ;).
						if ( count( $flags_todo ) == 0 || strlen( $param_flags ) == 0 ) {
							break;
						}

						// get the flag prefix (a key in the $flags array) using flag id length.
						$flag_prefix = substr( $param_flags, 0, $flag_id_len );
						// move string pointer up (after the single flag prefix).
						$param_flags = substr( $param_flags, $flag_id_len );

						// get the length of the flag value in the string (how many characters to consume)
						// flag value length is stored in a single hexadecimal character next to the flag prefix.
						$flag_value_len = min( hexdec( substr( $param_flags, 0, 1 ) ), min( $max_value_length, strlen( $param_flags ) - 1 ) );
						// get the flag value.
						$flag_value = substr( $param_flags, 1, $flag_value_len );
						// move string pointer up (after the entire flag).
						$param_flags = substr( $param_flags, $flag_value_len + 1 );

						// make sure the flag is supported.
						if ( isset( $flags[ $flag_prefix ] ) ) {
							$flag_name = $flags[ $flag_prefix ];

							// convert numerical flags to integers.
							if ( is_numeric( $flag_value ) ) {
								$flag_value = intval( $flag_value );
							}

							$params[ $flag_name ] = $flag_value;

							if ( isset( $flags_todo[ $flag_prefix ] ) ) {
								unset( $flags_todo[ $flag_prefix ] );
							}
						}
					}
				} elseif ( $param_size_count == 2 || $param_size_count == 3 ) {
					// Set W H Q.
					$params['width']  = intval( $param_size[0] );
					$params['height'] = intval( $param_size[1] );

					if ( isset( $param_size[2] ) && intval( $param_size[2] ) > 0 ) {
						$params['quality'] = intval( $param_size[2] );
					}
				}
			}
		}

		// Double check we got a correct id string.
		if ( substr( $id_name, 0, strlen( $id_prefix ) ) == $id_prefix ) {
			// move string pointer up (after the prefix).
			$id_name = substr( $id_name, strlen( $id_prefix ) );
			// get the length of the image id in the string (how many characters to consume).
			$id_len = min( hexdec( substr( $id_name, 0, 1 ) ), min( $max_value_length, strlen( $id_name ) - 1 ) );
			// get the id based on old position and id length.
			$image_id = intval( substr( $id_name, 1, $id_len ) );

			if ( $image_id > 0 ) {
				$params['image'] = $image_id;
			}
		}

		return $this->_get_params_sanitized( $params );
	}

	/**
	 * @param string $name
	 * @param bool   $is_only_size_name
	 * @return bool
	 */
	public function is_size_dynamic( $name, $is_only_size_name = false ) {
		$params = $this->get_params_from_name( $name, $is_only_size_name );

		if ( isset( $params['width'] ) && isset( $params['height'] ) ) {
			return true;
		}

		return false;
	}
}