Merge pull request #381 from JLG-WOCFR-DEV/codex/introduce-services-in-scanner-directory

Refactor image URL normalization services

Author: JLG-WOCFR-DEV

liens-morts-detector-jlg/includes/Scanner/ImageHostPolicy.php

@@ -0,0 +1,97 @@
+<?php
+
+if (!class_exists('BlcImageHostPolicyResult')) {
+    class BlcImageHostPolicyResult {
+        /**
+         * @var string
+         */
+        private $host;
+
+        /**
+         * @var bool
+         */
+        private $matchesSite;
+
+        /**
+         * @var bool
+         */
+        private $matchesUpload;
+
+        public function __construct($host, $matches_site, $matches_upload) {
+            $this->host = (string) $host;
+            $this->matchesSite = (bool) $matches_site;
+            $this->matchesUpload = (bool) $matches_upload;
+        }
+
+        /**
+         * @return bool
+         */
+        public function isValid() {
+            return $this->host !== '';
+        }
+
+        /**
+         * @return string
+         */
+        public function getHost() {
+            return $this->host;
+        }
+
+        /**
+         * @return bool
+         */
+        public function isSiteHost() {
+            return $this->matchesSite;
+        }
+
+        /**
+         * @return bool
+         */
+        public function isUploadHost() {
+            return $this->matchesUpload;
+        }
+
+        /**
+         * @return bool
+         */
+        public function isRemoteHost() {
+            return $this->isValid() && !$this->matchesSite && !$this->matchesUpload;
+        }
+    }
+}
+
+if (!class_exists('BlcImageHostPolicy')) {
+    class BlcImageHostPolicy {
+        /**
+         * @var string
+         */
+        private $normalizedSiteHost;
+
+        /**
+         * @var string
+         */
+        private $uploadBaseurlHost;
+
+        public function __construct($normalized_site_host, $upload_baseurl_host) {
+            $this->normalizedSiteHost = (string) $normalized_site_host;
+            $this->uploadBaseurlHost = (string) $upload_baseurl_host;
+        }
+
+        /**
+         * Analyse a normalized URL and classify its host.
+         *
+         * @param string $normalized_url
+         *
+         * @return BlcImageHostPolicyResult
+         */
+        public function analyzeUrl($normalized_url) {
+            $host_raw = parse_url((string) $normalized_url, PHP_URL_HOST);
+            $host = is_string($host_raw) ? blc_normalize_remote_host($host_raw) : '';
+
+            $matches_site = ($host !== '' && $this->normalizedSiteHost !== '' && $host === $this->normalizedSiteHost);
+            $matches_upload = ($host !== '' && $this->uploadBaseurlHost !== '' && $host === $this->uploadBaseurlHost);
+
+            return new BlcImageHostPolicyResult($host, $matches_site, $matches_upload);
+        }
+    }
+}

liens-morts-detector-jlg/includes/Scanner/ImageNormalizationResult.php

@@ -0,0 +1,123 @@
+<?php
+
+if (!class_exists('BlcImageNormalizationResult')) {
+    class BlcImageNormalizationResult {
+        /**
+         * @var bool
+         */
+        private $successful;
+
+        /**
+         * @var string
+         */
+        private $reason;
+
+        /**
+         * @var string
+         */
+        private $originalUrl;
+
+        /**
+         * @var string
+         */
+        private $normalizedUrl;
+
+        /**
+         * @var string
+         */
+        private $filePath;
+
+        /**
+         * @var string
+         */
+        private $decodedRelativePath;
+
+        /**
+         * @var bool
+         */
+        private $remoteUploadCandidate;
+
+        private function __construct($successful, $reason, $original_url, $normalized_url, $file_path, $decoded_relative_path, $remote_upload_candidate) {
+            $this->successful = (bool) $successful;
+            $this->reason = (string) $reason;
+            $this->originalUrl = (string) $original_url;
+            $this->normalizedUrl = (string) $normalized_url;
+            $this->filePath = (string) $file_path;
+            $this->decodedRelativePath = (string) $decoded_relative_path;
+            $this->remoteUploadCandidate = (bool) $remote_upload_candidate;
+        }
+
+        /**
+         * @param string $original_url
+         * @param string $normalized_url
+         * @param string $file_path
+         * @param string $decoded_relative_path
+         * @param bool   $remote_upload_candidate
+         *
+         * @return self
+         */
+        public static function success($original_url, $normalized_url, $file_path, $decoded_relative_path, $remote_upload_candidate) {
+            return new self(true, '', $original_url, $normalized_url, $file_path, $decoded_relative_path, $remote_upload_candidate);
+        }
+
+        /**
+         * @param string $reason
+         * @param string $original_url
+         * @param string $normalized_url
+         *
+         * @return self
+         */
+        public static function failure($reason, $original_url = '', $normalized_url = '') {
+            return new self(false, $reason, $original_url, $normalized_url, '', '', false);
+        }
+
+        /**
+         * @return bool
+         */
+        public function isSuccessful() {
+            return $this->successful;
+        }
+
+        /**
+         * @return string
+         */
+        public function getReason() {
+            return $this->reason;
+        }
+
+        /**
+         * @return string
+         */
+        public function getOriginalUrl() {
+            return $this->originalUrl;
+        }
+
+        /**
+         * @return string
+         */
+        public function getNormalizedUrl() {
+            return $this->normalizedUrl;
+        }
+
+        /**
+         * @return string
+         */
+        public function getFilePath() {
+            return $this->filePath;
+        }
+
+        /**
+         * @return string
+         */
+        public function getDecodedRelativePath() {
+            return $this->decodedRelativePath;
+        }
+
+        /**
+         * @return bool
+         */
+        public function isRemoteUploadCandidate() {
+            return $this->remoteUploadCandidate;
+        }
+    }
+}