Code Overhaul

PHP 8.1 is now required

Author: SoftCreatR

.github/workflows/Test.yml

@@ -1,4 +1,3 @@
----
 name: Test
 
 on:
@@ -21,13 +20,13 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php: [ '7.2', '7.3', '7.4', '8.0', '8.1' ]
-    continue-on-error: ${{ matrix.php == '8.1' }}
+        php: [ '8.1', '8.2', '8.3', '8.4' ]
+    continue-on-error: ${{ matrix.php == '8.4' }}
     name: PHP ${{ matrix.php }} Test
 
     steps:
       - name: Git checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Checkout submodules
         run: git submodule update --init --recursive
@@ -47,10 +46,12 @@ jobs:
         run: composer update --prefer-dist --no-interaction
 
       - name: Run phpcs
-        run: composer cs-check -- -v
+        run: composer cs-check
 
       - name: Execute tests
-        run: composer test -- -v --coverage-clover=coverage.xml
+        run: composer test -- --coverage-clover=coverage.xml
 
       - name: Run codecov
-        uses: codecov/codecov-action@v1
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -4,5 +4,6 @@ composer.lock
 .idea
 phpunit.xml
 .phpunit.result.cache
+/.phpunit.cache
 .phpcs-cache
 .php_cs.cache

README.md

@@ -1,115 +1,97 @@
 # PHP Mime Detector
 
-Detecting the real type of (binary) files doesn't have to be hard. Checking a file's extension is not reliable and can cause serious security issues.
+Detecting the real type of (binary) files doesn't have to be difficult. Checking a file's extension is not reliable and can lead to serious security issues.
 
-This package helps you to determine the correct type of files, by reading it byte for byte (up to 4096) and check for [magic numbers](http://en.wikipedia.org/wiki/Magic_number_(programming)#Magic_numbers_in_files).
+This package helps you determine the correct type of files by reading them byte by byte (up to 4096 bytes) and checking for [magic numbers](http://en.wikipedia.org/wiki/Magic_number_(programming)#Magic_numbers_in_files).
 
-However, this package isn't a replacement for any security software. It just aims to produce less false positives, than a simple extension check would produce.
+However, this package isn't a replacement for any security software. It simply aims to produce fewer false positives than a simple extension check would.
 
 A list of supported file types can be found on [this Wiki page](https://github.com/SoftCreatR/php-mime-detector/wiki/Supported-file-types).
 
-__Why a separate class?__
+## Why a Separate Class?
 
-You may wonder why we don't just rely on extensions like [Fileinfo](https://secure.php.net/manual/en/book.fileinfo.php)? First off all, a short background story:
+You may wonder why we don't just rely on extensions like [Fileinfo](https://www.php.net/manual/en/book.fileinfo.php). Here's a brief background:
 
-We are building extensions and applications for an Open Source PHP Framework, thus we are creating web software for the masses. Many of our customers and/or users of our free products are on shared hosting without any possibility to install or manage installed PHP extensions. So our goal is to develop solutions with as few dependencies as necessary, but with as much functionality as possible.
+We develop extensions and applications for an Open Source PHP Framework, creating web software for the masses. Many of our customers and users of our free products are on shared hosting without any ability to install or manage PHP extensions. Therefore, our goal is to develop solutions with minimal dependencies while providing as much functionality as possible.
 
-While developing a solution, that allows people to convert HEIF/HEIC files to a more "standardized" format (using our own, external API), we had troubles detecting these files, because especially this format isn't known by most Webservers, yet. While checking the file extension isn't reliable, we had to find a reusable solution that works for most of our clients. So we started to build a magic number based check for these files. That was the birth of our Mime Detector.
-
-__Why are the unit tests so poorly written?__
-
-Short answer: I have just little experience in unit testing. This project was a good training and even if the unit tests could be better: I am proud of my progress :)
-
-## Demo
-
-A demo (based on [dev-master](https://github.com/SoftCreatR/php-mime-detector/archive/master.zip)) can be found at [WhatTheFile.info](https://www.whatthefile.info).
+When developing a solution that allows people to convert HEIF/HEIC files to a more "standardized" format (using our own external API), we had trouble detecting these files because this format isn't widely recognized by most web servers. Since checking the file extension isn't reliable, we needed to find a reusable solution that works for most of our clients. This led to the creation of our Mime Detector, based on magic number checks.
 
 ## Requirements
 
--   PHP 7.1 or newer
--   [Composer](https://getcomposer.org)
-
-If you are looking for a solution that works on older PHP versions (5.3.2+), head over to the [oldphp](https://github.com/SoftCreatR/php-mime-detector/tree/oldphp) branch.
+- PHP 8.1 or newer
+- [Composer](https://getcomposer.org)
 
 ## Installation
 
-Require this package using [Composer](https://getcomposer.org/), in the root directory of your project:
+Install this package using [Composer](https://getcomposer.org/) in the root directory of your project:
 
-``` bash
-$ composer require softcreatr/php-mime-detector
+```bash
+composer require softcreatr/php-mime-detector
 ```
 
 ## Usage
 
-Here is an example on how this package makes it very easy to determine the mime type (and it's corresponding file extension) of a given file:
+Here is an example of how this package makes it easy to determine the MIME type and corresponding file extension of a given file:
 
 ```php
-use SoftCreatR\MimeDetector\MimeDetector;
-use SoftCreatR\MimeDetector\MimeDetectorException;
-
-// create an instance of the MimeDetector
-$mimeDetector = new MimeDetector();
-
-// set our file to read
-try {
-    $mimeDetector->setFile('foo.bar');
-} catch (MimeDetectorException $e) {
-    die('An error occurred while trying to load the given file.');
-}
+<?php
 
-// try to determine it's mime type and the correct file extension
-$fileData = $mimeDetector->getFileType();
-
-// print the result
-echo '<pre>' . print_r($fileData, true) . '</pre>';
-```
-
-Or short:
-
-```php
 use SoftCreatR\MimeDetector\MimeDetector;
 use SoftCreatR\MimeDetector\MimeDetectorException;
 
+require 'vendor/autoload.php';
+
 try {
-    echo '<pre>' . print_r((new MimeDetector())->setFile('foo.bar')->getFileType(), true) . '</pre>';
+    // Create an instance of MimeDetector with the file path
+    $mimeDetector = new MimeDetector('foo.bar');
+
+    // Get the MIME type and file extension
+    $fileData = [
+        'mime_type' => $mimeDetector->getMimeType(),
+        'file_extension' => $mimeDetector->getFileExtension(),
+        'file_hash' => $mimeDetector->getFileHash(),
+    ];
+
+    // Print the result
+    echo '<pre>' . print_r($fileData, true) . '</pre>';
 } catch (MimeDetectorException $e) {
-    die('An error occurred while trying to load the given file.');
+    die('An error occurred while trying to load the given file: ' . $e->getMessage());
 }
 ```
 
 ## Testing
 
-Testing utilizes PHPUnit (what else?) by running this command:
+This project uses PHPUnit for testing. To run tests, use the following command:
 
-``` bash
-$ composer test
+```bash
+composer test
 ```
 
-However, you may check out a bunch of test files for a full test. Test files are no longer included in the composer package nor the Git repository itself, so you have to perform a checkout of this repository and install it's submodules:
+To run a full test suite, you can use a set of provided test files. These files are not included in the Composer package or Git repository, so you must clone this repository and initialize its submodules:
 
-``` bash
-$ git clone https://github.com/SoftCreatR/php-mime-detector
-$ cd php-mime-detector
-$ git submodule update --init --recursive
+```bash
+git clone https://github.com/SoftCreatR/php-mime-detector
+cd php-mime-detector
+git submodule update --init --recursive
 ```
 
-When done, perform a `composer install` and run PHPUnit as described above.
+After that, install the necessary dependencies with `composer install`, and run PHPUnit as described above.
 
 ## ToDo
 
--   Reduce method sizes, when possible
--   Add a method, that accepts a mime type and returns the corresponding file extension
--   Add a method, that accepts a file extension and returns a list of corresponding mime types
--   Add a method, that returns a list of all detectable mime types and their corresponding file extensions
+- Reduce method sizes where possible.
+- Add a method that accepts a MIME type and returns the corresponding file extension.
+- Add a method that accepts a file extension and returns a list of corresponding MIME types.
+- Add a method that returns a list of all detectable MIME types and their corresponding file extensions.
 
 ## Contributing
 
 Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
 
-When adding new detections, please make sure to provide at least one sample file.
+When adding new detections, please provide at least one sample file to ensure the detection works as expected.
 
 ## License
 
-[ISC](LICENSE.md)
+[ISC License](LICENSE.md)
 
 Free Software, Hell Yeah!

composer.json

@@ -8,7 +8,7 @@
     "Magic Number"
   ],
   "homepage": "https://1-2.dev",
-  "version": "3.2.1",
+  "version": "4.0.0",
   "license": "ISC",
   "authors": [
     {
@@ -21,12 +21,12 @@
     }
   ],
   "require": {
-    "php": ">=7.1.0"
+    "php": ">=8.1.0"
   },
   "require-dev": {
-    "phpunit/phpunit": ">=7.0",
-    "roave/security-advisories": "dev-master",
-    "squizlabs/php_codesniffer": "^3.5"
+    "phpunit/phpunit": ">=10.0",
+    "roave/security-advisories": "dev-latest",
+    "squizlabs/php_codesniffer": "^3.7"
   },
   "config": {
     "optimize-autoloader": true,

phpunit.xml.dist

@@ -1,17 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
-         bootstrap="vendor/autoload.php"
-         colors="true"
->
-    <testsuites>
-        <testsuite name="Unit">
-            <directory>./tests</directory>
-        </testsuite>
-    </testsuites>
-    <filter>
-        <whitelist>
-            <directory suffix=".php">./src/</directory>
-        </whitelist>
-    </filter>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd" bootstrap="vendor/autoload.php" colors="true" cacheDirectory=".phpunit.cache" displayDetailsOnTestsThatTriggerWarnings="true">
+  <testsuites>
+    <testsuite name="Unit">
+      <directory>./tests</directory>
+    </testsuite>
+  </testsuites>
+  <source>
+    <include>
+      <directory>./src/</directory>
+    </include>
+  </source>
 </phpunit>

src/SoftCreatR/MimeDetector/ByteCacheHandler.php

@@ -0,0 +1,119 @@
+<?php
+
+/**
+ * Mime Detector for PHP.
+ *
+ * @license https://github.com/SoftCreatR/php-mime-detector/blob/main/LICENSE  ISC License
+ */
+
+declare(strict_types=1);
+
+namespace SoftCreatR\MimeDetector;
+
+class ByteCacheHandler
+{
+    private array $byteCache = [];
+
+    private int $byteCacheLen = 0;
+
+    private int $maxByteCacheLen = 4096;
+
+    /**
+     * @throws MimeDetectorException
+     */
+    public function __construct(private readonly string $file)
+    {
+        $this->createByteCache();
+    }
+
+    public function getByteCache(): array
+    {
+        return $this->byteCache;
+    }
+
+    public function getByteCacheLen(): int
+    {
+        return $this->byteCacheLen;
+    }
+
+    /**
+     * @throws MimeDetectorException
+     */
+    public function setMaxByteCacheLen(int $maxLength): void
+    {
+        if ($maxLength < 4) {
+            throw new MimeDetectorException('Maximum byte cache length must not be smaller than 4.');
+        }
+        $this->maxByteCacheLen = $maxLength;
+    }
+
+    public function getMaxByteCacheLen(): int
+    {
+        return $this->maxByteCacheLen;
+    }
+
+    /**
+     * @throws MimeDetectorException
+     */
+    private function createByteCache(): void
+    {
+        if (empty($this->file)) {
+            throw new MimeDetectorException('No file provided.');
+        }
+
+        $handle = \fopen($this->file, 'rb');
+        $data = \fread($handle, $this->maxByteCacheLen);
+        \fclose($handle);
+
+        foreach (\str_split($data) as $i => $char) {
+            $this->byteCache[$i] = \ord($char);
+        }
+
+        $this->byteCacheLen = \count($this->byteCache);
+    }
+
+    public function checkForBytes(array $bytes, int $offset = 0, array $mask = []): bool
+    {
+        if (empty($bytes) || empty($this->byteCache)) {
+            return false;
+        }
+
+        foreach (\array_values($bytes) as $i => $byte) {
+            if (!empty($mask)) {
+                if (
+                    !isset($this->byteCache[$offset + $i], $mask[$i])
+                    || $byte !== ($mask[$i] & $this->byteCache[$offset + $i])
+                ) {
+                    return false;
+                }
+            } elseif (!isset($this->byteCache[$offset + $i]) || $this->byteCache[$offset + $i] !== $byte) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+    public function searchForBytes(array $bytes, int $offset = 0, array $mask = []): int
+    {
+        $limit = $this->byteCacheLen - \count($bytes);
+
+        for ($i = $offset; $i < $limit; $i++) {
+            if ($this->checkForBytes($bytes, $i, $mask)) {
+                return $i;
+            }
+        }
+
+        return -1;
+    }
+
+    public function checkString(string $str, int $offset = 0): bool
+    {
+        return $this->checkForBytes($this->toBytes($str), $offset);
+    }
+
+    public function toBytes(string $str): array
+    {
+        return \array_values(\unpack('C*', $str));
+    }
+}