Merge branch '3.5' into 3

MNT Revert erroneous dependency changes

.github/workflows/ci.yml

@@ -0,0 +1,11 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  ci:
+    name: CI
+    uses: silverstripe/gha-ci/.github/workflows/ci.yml@v1

.github/workflows/dispatch-ci.yml

@@ -0,0 +1,16 @@
+name: Dispatch CI
+
+on:
+  # At 12:20 PM UTC, only on Saturday and Sunday
+  schedule:
+    - cron: '20 12 * * 6,0'
+
+jobs:
+  dispatch-ci:
+    name: Dispatch CI
+    # Only run cron on the silverstripe account
+    if: (github.event_name == 'schedule' && github.repository_owner == 'silverstripe') || (github.event_name != 'schedule')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Dispatch CI
+        uses: silverstripe/gha-dispatch-ci@v1

.github/workflows/keepalive.yml

@@ -0,0 +1,17 @@
+name: Keepalive
+
+on:
+  workflow_dispatch:
+  # The 4th of every month at 10:50am UTC
+  schedule:
+    - cron: '50 10 4 * *'
+
+jobs:
+  keepalive:
+    name: Keepalive
+    # Only run cron on the silverstripe account
+    if: (github.event_name == 'schedule' && github.repository_owner == 'silverstripe') || (github.event_name != 'schedule')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Keepalive
+        uses: silverstripe/gha-keepalive@v1

.scrutinizer.yml

@@ -1,13 +0,0 @@
-inherit: true
-
-checks:
-  php: true
-
-build:
-  nodes:
-    analysis:
-      tests:
-        override: [php-scrutinizer-run]
-
-filter:
-  paths: [src/*, tests/*]

.travis.yml

@@ -1,51 +0,0 @@
-language: php
-
-dist: trusty
-
-addons:
-  apt:
-    packages:
-      - poppler-utils
-
-env:
-  global:
-    - COMPOSER_ROOT_VERSION=3.1.x-dev
-    - SS_TIKA_ENDPOINT="http://localhost:9998/"
-
-matrix:
-  include:
-    - php: 5.6
-      env: DB=MYSQL RECIPE_VERSION=4.3.x-dev PHPCS_TEST=1 PHPUNIT_TEST=1
-    - php: 7.0
-      env: DB=MYSQL RECIPE_VERSION=4.3.x-dev PHPUNIT_TEST=1
-    - php: 7.1
-      env: DB=PGSQL RECIPE_VERSION=4.4.x-dev PHPUNIT_COVERAGE_TEST=1
-    - php: 7.2
-      env: DB=MYSQL RECIPE_VERSION=4.4.x-dev PHPUNIT_TEST=1
-    - php: 7.3
-      env: DB=MYSQL RECIPE_VERSION=4.x-dev PHPUNIT_TEST=1
-
-before_script:
-  # Init PHP
-  - phpenv rehash
-  - phpenv config-rm xdebug.ini
-
-  # Configure Tika bin
-  - mkdir -p $HOME/bin
-  - export PATH=$PATH:$HOME/bin
-  - ./.travis/install_tika.sh
-  - ($HOME/bin/tika-rest-server &) &> /dev/null
-
-  # Install composer dependencies
-  - composer validate
-  - composer require --no-update silverstripe/recipe-cms:"$RECIPE_VERSION"
-  - if [[ $DB == PGSQL ]]; then composer require --no-update silverstripe/postgresql 2.1.x-dev; fi
-  - composer install --prefer-dist --no-interaction --no-progress --no-suggest --optimize-autoloader --verbose --profile
-
-script:
-  - if [[ $PHPUNIT_TEST ]]; then vendor/bin/phpunit; fi
-  - if [[ $PHPUNIT_COVERAGE_TEST ]]; then phpdbg -qrr vendor/bin/phpunit --coverage-clover=coverage.xml; fi
-  - if [[ $PHPCS_TEST ]]; then vendor/bin/phpcs src/ tests/; fi
-
-after_success:
-  - if [[ $PHPUNIT_COVERAGE_TEST ]]; then bash <(curl -s https://codecov.io/bash) -f coverage.xml; fi

README.md

@@ -1,9 +1,7 @@
 # Text extraction module
 
-[![Build Status](https://travis-ci.org/silverstripe/silverstripe-textextraction.svg?branch=master)](https://travis-ci.org/silverstripe/silverstripe-textextraction)
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/silverstripe/silverstripe-textextraction/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/silverstripe/silverstripe-textextraction/?branch=master)
-[![codecov](https://codecov.io/gh/silverstripe/silverstripe-textextraction/branch/master/graph/badge.svg)](https://codecov.io/gh/silverstripe/silverstripe-textextraction)
-[![SilverStripe supported module](https://img.shields.io/badge/silverstripe-supported-0071C4.svg)](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/)
+[![CI](https://github.com/silverstripe/silverstripe-textextraction/actions/workflows/ci.yml/badge.svg)](https://github.com/silverstripe/silverstripe-textextraction/actions/workflows/ci.yml)
+[![Silverstripe supported module](https://img.shields.io/badge/silverstripe-supported-0071C4.svg)](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/)
 
 Provides a text extraction API for file content, that can hook into different extractor
 engines based on availability and the parsed file format. The output returned is always a string of the file content.
@@ -24,7 +22,7 @@ The module supports text extraction on the following file formats:
 
 ## Requirements
 
- * SilverStripe ^4.0
+ * Silverstripe ^4.0
  * (optional) [XPDF](http://www.foolabs.com/xpdf/) (`pdftotext` utility)
  * (optional) [Apache Solr with ExtracingRequestHandler](http://wiki.apache.org/solr/ExtractingRequestHandler)
  * (optional) [Apache Tika](http://tika.apache.org/)
@@ -54,8 +52,8 @@ If the issue does look like a new bug:
  - Create a new issue
  - Describe the steps required to reproduce your issue, and the expected outcome. Unit tests, screenshots
   and screencasts can help here.
- - Describe your environment as detailed as possible: SilverStripe version, Browser, PHP version,
- Operating System, any installed SilverStripe modules.
+ - Describe your environment as detailed as possible: Silverstripe version, Browser, PHP version,
+ Operating System, any installed Silverstripe modules.
 
 Please report security issues to security@silverstripe.org directly. Please don't file security issues in the bugtracker.
 

composer.json

@@ -20,14 +20,15 @@
         }
     ],
     "require": {
-        "silverstripe/framework": "^4",
+        "php": "^7.4 || ^8.0",
+        "silverstripe/framework": "^4.10",
         "silverstripe/assets": "^1",
         "silverstripe/versioned": "^1",
-        "guzzlehttp/guzzle": "~6.3.0"
+        "guzzlehttp/guzzle": "^6.3 || ^7.0"
     },
     "require-dev": {
         "squizlabs/php_codesniffer": "^3",
-        "phpunit/phpunit": "^5.7"
+        "phpunit/phpunit": "^9.5"
     },
     "autoload": {
         "psr-4": {
@@ -38,11 +39,7 @@
     "suggest": {
         "ext-fileinfo": "Improved support for file mime detection"
     },
-    "extra": {
-        "branch-alias": {
-            "dev-master": "3.x-dev"
-        }
-    },
+    "extra": [],
     "minimum-stability": "dev",
     "prefer-stable": true
-}
+}

docs/en/configuration.md

@@ -30,7 +30,7 @@ SilverStripe\Core\Injector\Injector:
   SilverStripe\TextExtraction\Cache\FileTextCache:
     class: SilverStripe\TextExtraction\Cache\FileTextCache\Cache
 
-SilverStripe\TextExtraction\Cache\FileTextCache\Database:
+SilverStripe\TextExtraction\Cache\FileTextCache\Cache:
   lifetime: 3600 # Number of seconds to cache content for
 ```
 

phpcs.xml.dist

@@ -2,6 +2,9 @@
 <ruleset name="SilverStripe">
     <description>CodeSniffer ruleset for SilverStripe coding conventions.</description>
 
+    <file>src</file>
+    <file>tests</file>
+
     <!-- base rules are PSR-2 -->
     <rule ref="PSR2" >
         <!-- Current exclusions -->

phpunit.xml.dist

@@ -1,7 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
 <phpunit bootstrap="vendor/silverstripe/framework/tests/bootstrap.php" colors="true">
-    <testsuite name="Default">
-        <directory>tests/</directory>
-    </testsuite>
+    <testsuites>
+        <testsuite name="Default">
+            <directory>tests/</directory>
+        </testsuite>
+    </testsuites>
 
     <filter>
         <whitelist addUncoveredFilesFromWhitelist="true">

src/Cache/FileTextCache/Cache.php

@@ -18,7 +18,7 @@ class Cache implements FileTextCache, Flushable
 
     /**
      * Lifetime of cache in seconds
-     * Null is indefinite
+     * Null defaults to 3600 (1 hour)
      *
      * @var int|null
      * @config
@@ -42,7 +42,7 @@ class Cache implements FileTextCache, Flushable
      */
     protected function getKey(File $file)
     {
-        return md5($file->getFilename());
+        return md5($file->getFilename() ?? '');
     }
 
     /**

src/Extractor/FileTextExtractor.php

@@ -58,7 +58,7 @@ abstract class FileTextExtractor
         arsort($classPriorities);
 
         // Save classes
-        $sortedClasses = array_keys($classPriorities);
+        $sortedClasses = array_keys($classPriorities ?? []);
         return self::$sorted_extractor_classes = $sortedClasses;
     }
 
@@ -81,7 +81,7 @@ abstract class FileTextExtractor
      */
     public static function for_file($file)
     {
-        if (!$file || (is_string($file) && !file_exists($file))) {
+        if (!$file || (is_string($file) && !file_exists($file ?? ''))) {
             return null;
         }
 
@@ -137,11 +137,11 @@ abstract class FileTextExtractor
         }
 
         // Remove any existing temp files with this name
-        if (file_exists($path)) {
-            unlink($path);
+        if (file_exists($path ?? '')) {
+            unlink($path ?? '');
         }
 
-        $bytesWritten = file_put_contents($path, $file->getStream());
+        $bytesWritten = file_put_contents($path ?? '', $file->getStream());
         if (false === $bytesWritten) {
             throw new Exception(static::class . '->getPathFromFile() failed to write temporary file');
         }

src/Extractor/HTMLTextExtractor.php

@@ -34,7 +34,7 @@ class HTMLTextExtractor extends FileTextExtractor
      */
     public function supportsExtension($extension)
     {
-        return in_array(strtolower($extension), ["html", "htm", "xhtml"]);
+        return in_array(strtolower($extension ?? ''), ["html", "htm", "xhtml"]);
     }
 
     /**
@@ -43,7 +43,7 @@ class HTMLTextExtractor extends FileTextExtractor
      */
     public function supportsMime($mime)
     {
-        return strtolower($mime) === 'text/html';
+        return strtolower($mime ?? '') === 'text/html';
     }
 
     /**
@@ -56,7 +56,7 @@ class HTMLTextExtractor extends FileTextExtractor
      */
     public function getContent($file)
     {
-        $content = $file instanceof File ? $file->getString() : file_get_contents($file);
+        $content = $file instanceof File ? $file->getString() : file_get_contents($file ?? '');
 
         // Yes, yes, regex'ing HTML is evil.
         // Since we don't care about well-formedness or markup here, it does the job.
@@ -82,9 +82,9 @@ class HTMLTextExtractor extends FileTextExtractor
                 '@</?((frameset)|(frame)|(iframe))@iu',
             ],
             [' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', "$0", "$0", "$0", "$0", "$0", "$0", "$0", "$0"],
-            $content
+            $content ?? ''
         );
 
-        return strip_tags($content);
+        return strip_tags($content ?? '');
     }
 }

src/Extractor/PDFTextExtractor.php

@@ -33,18 +33,18 @@ class PDFTextExtractor extends FileTextExtractor
     public function isAvailable()
     {
         $bin = $this->bin('pdftotext');
-        return $bin && file_exists($bin) && is_executable($bin);
+        return $bin && file_exists($bin ?? '') && is_executable($bin ?? '');
     }
 
     public function supportsExtension($extension)
     {
-        return strtolower($extension) === 'pdf';
+        return strtolower($extension ?? '') === 'pdf';
     }
 
     public function supportsMime($mime)
     {
         return in_array(
-            strtolower($mime),
+            strtolower($mime ?? ''),
             [
                 'application/pdf',
                 'application/x-pdf',
@@ -72,7 +72,7 @@ class PDFTextExtractor extends FileTextExtractor
         // Find program in each path
         foreach ($locations as $location) {
             $path = "{$location}/{$program}";
-            if (file_exists($path)) {
+            if (file_exists($path ?? '')) {
                 return $path;
             }
             if (file_exists($path . '.exe')) {
@@ -86,7 +86,7 @@ class PDFTextExtractor extends FileTextExtractor
 
     public function getContent($file)
     {
-        if (!$file || (is_string($file) && !file_exists($file))) {
+        if (!$file || (is_string($file) && !file_exists($file ?? ''))) {
             // no file
             return '';
         }
@@ -108,7 +108,7 @@ class PDFTextExtractor extends FileTextExtractor
         }
 
         $path = $file instanceof File ? $this->getPathFromFile($file) : $file;
-        exec(sprintf('%s %s - 2>&1', $this->bin('pdftotext'), escapeshellarg($path)), $content, $err);
+        exec(sprintf('%s %s - 2>&1', $this->bin('pdftotext'), escapeshellarg($path ?? '')), $content, $err);
 
         if ($err) {
             throw new Exception(sprintf(
@@ -141,6 +141,6 @@ class PDFTextExtractor extends FileTextExtractor
             'st' => 'st'
         ];
 
-        return str_replace(array_keys($mapping), array_values($mapping), $input);
+        return str_replace(array_keys($mapping ?? []), array_values($mapping ?? []), $input ?? '');
     }
 }

src/Extractor/SolrCellTextExtractor.php

@@ -80,7 +80,7 @@ class SolrCellTextExtractor extends FileTextExtractor
     public function supportsExtension($extension)
     {
         return in_array(
-            strtolower($extension),
+            strtolower($extension ?? ''),
             [
                 'pdf', 'doc', 'docx', 'xls', 'xlsx',
                 'epub', 'rtf', 'odt', 'fodt', 'ods', 'fods',
@@ -106,12 +106,12 @@ class SolrCellTextExtractor extends FileTextExtractor
      */
     public function getContent($file)
     {
-        if (!$file || (is_string($file) && !file_exists($file))) {
+        if (!$file || (is_string($file) && !file_exists($file ?? ''))) {
             // no file
             return '';
         }
 
-        $fileName = $file instanceof File ? $file->getFilename() : basename($file);
+        $fileName = $file instanceof File ? $file->getFilename() : basename($file ?? '');
         $client = $this->getHttpClient();
 
         // Get and validate base URL
@@ -121,7 +121,7 @@ class SolrCellTextExtractor extends FileTextExtractor
         }
 
         try {
-            $stream = $file instanceof File ? $file->getStream() : fopen($file, 'r');
+            $stream = $file instanceof File ? $file->getStream() : fopen($file ?? '', 'r');
             /** @var Response $response */
             $response = $client
                 ->post($baseUrl, [
@@ -154,7 +154,7 @@ class SolrCellTextExtractor extends FileTextExtractor
         $matches = [];
         // Use preg match to avoid SimpleXML running out of memory on large text nodes
         preg_match(
-            sprintf('/\<str name\="%s"\>(.*?)\<\/str\>/s', preg_quote($fileName)),
+            sprintf('/\<str name\="%s"\>(.*?)\<\/str\>/s', preg_quote($fileName ?? '')),
             (string)$response->getBody(),
             $matches
         );

src/Extractor/TikaServerTextExtractor.php

@@ -86,7 +86,7 @@ class TikaServerTextExtractor extends FileTextExtractor
     {
         return $this->getServerEndpoint()
             && $this->getClient()->isAvailable()
-            && version_compare($this->getVersion(), '1.7') >= 0;
+            && version_compare($this->getVersion() ?? '', '1.7') >= 0;
     }
 
     /**
@@ -116,7 +116,7 @@ class TikaServerTextExtractor extends FileTextExtractor
 
         // Check aliases
         foreach ($this->supportedMimes as $info) {
-            if (isset($info['alias']) && in_array($mime, $info['alias'])) {
+            if (isset($info['alias']) && in_array($mime, $info['alias'] ?? [])) {
                 return true;
             }
         }
@@ -130,7 +130,7 @@ class TikaServerTextExtractor extends FileTextExtractor
         $content = $this->getClient()->tika($tempFile);
         //Cleanup temp file
         if ($file instanceof File) {
-            unlink($tempFile);
+            unlink($tempFile ?? '');
         }
         return $content;
     }

src/Extractor/TikaTextExtractor.php

@@ -29,7 +29,7 @@ class TikaTextExtractor extends FileTextExtractor
         $code = $this->runShell('tika --version', $stdout);
 
         // Parse output
-        if (!$code && preg_match('/Apache Tika (?<version>[\.\d]+)/', $stdout, $matches)) {
+        if (!$code && preg_match('/Apache Tika (?<version>[\.\d]+)/', $stdout ?? '', $matches)) {
             return $matches['version'];
         }
 
@@ -54,14 +54,14 @@ class TikaTextExtractor extends FileTextExtractor
         ];
         // Invoke command
         $pipes = [];
-        $proc = proc_open($command, $descriptorSpecs, $pipes);
+        $proc = proc_open($command ?? '', $descriptorSpecs ?? [], $pipes);
 
         if (!is_resource($proc)) {
             return 255;
         }
 
         // Send content as input
-        fwrite($pipes[0], $input);
+        fwrite($pipes[0], $input ?? '');
         fclose($pipes[0]);
 
         // Get output
@@ -78,11 +78,11 @@ class TikaTextExtractor extends FileTextExtractor
     {
         $mode = $this->config()->get('output_mode');
         $path = $file instanceof File ? $this->getPathFromFile($file) : $file;
-        $command = sprintf('tika %s %s', $mode, escapeshellarg($path));
+        $command = sprintf('tika %s %s', $mode, escapeshellarg($path ?? ''));
         $code = $this->runShell($command, $output);
         //Cleanup temp file
         if ($file instanceof File) {
-            unlink($path);
+            unlink($path ?? '');
         }
 
         if ($code == 0) {
@@ -123,8 +123,8 @@ class TikaTextExtractor extends FileTextExtractor
         }
 
         // Check if the mime type is inside the result
-        $pattern = sprintf('/\b(%s)\b/', preg_quote($mime, '/'));
+        $pattern = sprintf('/\b(%s)\b/', preg_quote($mime ?? '', '/'));
 
-        return (bool)preg_match($pattern, $supportedTypes);
+        return (bool)preg_match($pattern ?? '', $supportedTypes ?? '');
     }
 }

src/Rest/TikaRestClient.php

@@ -80,7 +80,7 @@ class TikaRestClient extends Client
 
         // Parse output
         if ($response->getStatusCode() == 200
-            && preg_match('/Apache Tika (?<version>[\.\d]+)/', $response->getBody(), $matches)
+            && preg_match('/Apache Tika (?<version>[\.\d]+)/', $response->getBody() ?? '', $matches)
         ) {
             $version = $matches['version'];
         }
@@ -108,7 +108,7 @@ class TikaRestClient extends Client
             ])
         );
 
-        return $this->mimes = Convert::json2array($response->getBody());
+        return $this->mimes = json_decode($response->getBody(), true);
     }
 
     /**
@@ -129,7 +129,7 @@ class TikaRestClient extends Client
                     'headers' => [
                         'Accept' => 'text/plain',
                     ],
-                    'body' => file_get_contents($file),
+                    'body' => file_get_contents($file ?? ''),
                 ])
             );
             $text = $response->getBody();

tests/FileTextExtractableTest.php

@@ -18,7 +18,7 @@ class FileTextExtractableTest extends SapphireTest
         ],
     ];
 
-    protected function setUp()
+    protected function setUp(): void
     {
         parent::setUp();
 
@@ -33,7 +33,7 @@ class FileTextExtractableTest extends SapphireTest
         );
     }
 
-    protected function tearDown()
+    protected function tearDown(): void
     {
         if (file_exists(dirname(__FILE__) . '/fixtures/test1-copy.html')) {
             unlink(dirname(__FILE__) . '/fixtures/test1-copy.html');
@@ -53,8 +53,8 @@ class FileTextExtractableTest extends SapphireTest
 
         $content = $file->extractFileAsText();
         $this->assertNotNull($content);
-        $this->assertContains('Test Headline', $content);
-        $this->assertContains('Test Text', $content);
+        $this->assertStringContainsString('Test Headline', $content);
+        $this->assertStringContainsString('Test Text', $content);
         $this->assertEquals($content, $file->FileContentCache);
     }
 }

tests/HTMLTextExtractorTest.php

@@ -11,7 +11,7 @@ class HTMLTextExtractorTest extends SapphireTest
 {
     protected $usesDatabase = true;
 
-    protected function setUp()
+    protected function setUp(): void
     {
         parent::setUp();
 
@@ -28,9 +28,9 @@ class HTMLTextExtractorTest extends SapphireTest
 
         $content = $extractor->getContent($file);
 
-        $this->assertContains('Test Headline', $content);
-        $this->assertNotContains('Test Comment', $content, 'Strips HTML comments');
-        $this->assertNotContains('Test Style', $content, 'Strips non-content style tags');
-        $this->assertNotContains('Test Script', $content, 'Strips non-content script tags');
+        $this->assertStringContainsString('Test Headline', $content);
+        $this->assertStringNotContainsString('Test Comment', $content, 'Strips HTML comments');
+        $this->assertStringNotContainsString('Test Style', $content, 'Strips non-content style tags');
+        $this->assertStringNotContainsString('Test Script', $content, 'Strips non-content script tags');
     }
 }

tests/PDFTextExtractorTest.php

@@ -24,6 +24,6 @@ class PDFTextExtractorTest extends SapphireTest
         $file->write();
 
         $content = $extractor->getContent($file);
-        $this->assertContains('This is a test file with a link', $content);
+        $this->assertStringContainsString('This is a test file with a link', $content);
     }
 }

tests/TikaServerTextExtractorTest.php

@@ -2,7 +2,7 @@
 
 namespace SilverStripe\TextExtraction\Tests;
 
-use PHPUnit_Framework_MockObject_MockObject;
+use PHPUnit\Framework\MockObject\MockObject;
 use SilverStripe\Assets\File;
 use SilverStripe\Dev\SapphireTest;
 use SilverStripe\TextExtraction\Extractor\TikaServerTextExtractor;
@@ -28,7 +28,7 @@ class TikaServerTextExtractorTest extends SapphireTest
         $file->write();
 
         $content = $extractor->getContent($file);
-        $this->assertContains('This is a test file with a link', $content);
+        $this->assertStringContainsString('This is a test file with a link', $content);
 
         // Check mime validation
         $this->assertTrue($extractor->supportsMime('application/pdf'));
@@ -43,7 +43,7 @@ class TikaServerTextExtractorTest extends SapphireTest
      */
     public function testIsAvailable($version, $expected)
     {
-        /** @var PHPUnit_Framework_MockObject_MockObject|TikaServerTextExtractor $extractor */
+        /** @var MockObject|TikaServerTextExtractor $extractor */
         $extractor = $this->getMockBuilder(TikaServerTextExtractor::class)
             ->setMethods(['getClient', 'getServerEndpoint'])
             ->getMock();

tests/TikaTextExtractorTest.php

@@ -28,7 +28,7 @@ class TikaTextExtractorTest extends SapphireTest
         $file->write();
 
         $content = $extractor->getContent($file);
-        $this->assertContains('This is a test file with a link', $content);
+        $this->assertStringContainsString('This is a test file with a link', $content);
 
         // Check mime validation
         $this->assertTrue($extractor->supportsMime('application/pdf'));