Merge pull request #27 from silverstripeltd/feature/AOS-295-large-document-report-visibility-cms6

AOS-295: CMS6 large document report visibility

Author: HeyImPhil

README.md

@@ -110,10 +110,12 @@ SilverStripe\Forager\Service\IndexConfiguration:
 
 ### File attachments for content extraction
 
-Firstly, you will need to set this environment variable. This will apply an extension to the `File` class, and allow you to use the `_attachment` field (detailed below).
+Firstly, you will need to apply the FileExtension extension onto Files. This extension will allow you to use the `_attachment` field (detailed below).
 
 ```yaml
-SEARCH_INDEX_FILES=1
+SilverStripe\Assets\File:
+    extensions:
+        ForagerBifrostFileExtension: SilverStripe\ForagerBifrost\Extensions\FileExtension
 ```
 
 Silverstripe Search supports content extraction for many different file types. These can be attached to your Documents using an `_attachment` field of type `binary`.

_config/extensions.yml

@@ -1,12 +1,6 @@
 ---
 Name: forager-bifrost-extensions
-Only:
-  envvarset: SEARCH_INDEX_FILES
 ---
-SilverStripe\Assets\File:
-  extensions:
-    ForagerBifrostFileExtension: SilverStripe\ForagerBifrost\Extensions\FileExtension
-
 SilverStripe\AssetAdmin\Forms\FileFormFactory:
   extensions:
     ForagerBifrostFileFormExtension: SilverStripe\ForagerBifrost\Extensions\FileFormExtension

src/Extensions/FileFormExtension.php

@@ -6,6 +6,7 @@
 use SilverStripe\Assets\Image;
 use SilverStripe\Control\RequestHandler;
 use SilverStripe\Core\Extension;
+use SilverStripe\Core\Injector\Injector;
 use SilverStripe\ForagerBifrost\Constants\SearchFile;
 use SilverStripe\Forms\FieldList;
 use SilverStripe\Forms\Form;
@@ -27,6 +28,12 @@ public function updateForm(
         string $name = FormFactory::DEFAULT_NAME,
         array $context = []
     ): void {
+        $fileClass = Injector::inst()->get(File::class);
+
+        if (!$fileClass->hasExtension(FileExtension::class)) {
+            return;
+        }
+
         /** @var FieldList $fields */
         $fields = $form->Fields()->fieldByName('Editor.Details');
         $file = $context['Record'] ?? null;
@@ -79,7 +86,7 @@ private function createLargeFileWarning(File $file): ?LiteralField
                     _t(
                         self::class . '.LARGE_FILE_WARNING',
                         'Text contained within this {size} file cannot be indexed for search. '
-                            . 'The file size limit for text extraction is {limit}.',
+                        . 'The file size limit for text extraction is {limit}.',
                         [
                             'size' => $file->getSize(),
                             'limit' => SearchFile::sizeLimit(),

src/Reports/LargeDocumentReport.php

@@ -3,7 +3,9 @@
 namespace SilverStripe\ForagerBifrost\Reports;
 
 use SilverStripe\Assets\File;
+use SilverStripe\Core\Injector\Injector;
 use SilverStripe\ForagerBifrost\Constants\SearchFile;
+use SilverStripe\ForagerBifrost\Extensions\FileExtension;
 use SilverStripe\Model\List\SS_List;
 use SilverStripe\Reports\Report;
 
@@ -21,6 +23,10 @@ class LargeDocumentReport extends Report
 
     public function description(): string
     {
+        if (!$this->isReportActive()) {
+            return 'This report requires the FileExtension being applied to Files.';
+        }
+
         return sprintf(
             $this->description,
             SearchFile::sizeLimit()
@@ -44,4 +50,22 @@ public function sourceRecords(array $params = []): SS_List
             ->sort(['Created' => 'DESC']);
     }
 
+    /**
+     * @inheritDoc
+     */
+    public function canView($member = null): bool
+    {
+        return $this->isReportActive();
+    }
+
+    /**
+     * This report can only be active if the required extension is enabled
+     */
+    private function isReportActive(): bool
+    {
+        $fileClass = Injector::inst()->get(File::class);
+
+        return $fileClass->has_extension(FileExtension::class);
+    }
+
 }

tests/Extensions/FileExtensionTest.php

@@ -5,7 +5,6 @@
 use SilverStripe\Assets\Dev\TestAssetStore;
 use SilverStripe\Assets\File;
 use SilverStripe\Assets\Folder;
-use SilverStripe\Core\Environment;
 use SilverStripe\Dev\SapphireTest;
 use SilverStripe\Forager\Extensions\SearchServiceExtension;
 use SilverStripe\ForagerBifrost\Extensions\FileExtension;
@@ -102,7 +101,6 @@ protected function setUp(): void
         parent::setUp();
 
         TestAssetStore::activate('SearchFileTest');
-        Environment::setEnv('SEARCH_INDEX_FILES', 1);
     }
 
     protected function tearDown(): void

tests/Reports/LargeDocumentReportTest.php

@@ -4,7 +4,6 @@
 
 use SilverStripe\Assets\Dev\TestAssetStore;
 use SilverStripe\Assets\File;
-use SilverStripe\Core\Environment;
 use SilverStripe\Dev\SapphireTest;
 use SilverStripe\Forager\Extensions\SearchServiceExtension;
 use SilverStripe\ForagerBifrost\Extensions\FileExtension;
@@ -34,6 +33,25 @@ public function testDescription(): void
             'Documents excluded for content ingestion in Silverstripe Search which exceeds 15 MB',
             $report->description()
         );
+
+        // Removing extension should result in a new description
+        $this->removeFileExtension();
+        $this->assertEquals(
+            'This report requires the FileExtension being applied to Files.',
+            $report->description()
+        );
+
+    }
+
+    public function testCanView(): void
+    {
+        $report = new LargeDocumentReport();
+
+        $this->assertTrue($report->canView());
+
+        // When the extension is not present on the File then the report should not be viewable
+        $this->removeFileExtension();
+        $this->assertfalse($report->canView());
     }
 
     public function testColumns(): void
@@ -70,12 +88,16 @@ public function testSourceRecords(): void
         $this->assertEquals($file21MbId, $files->first()->ID);
     }
 
+    protected function removeFileExtension(): void
+    {
+        File::remove_extension(FileExtension::class);
+    }
+
     protected function setUp(): void
     {
         parent::setUp();
 
         TestAssetStore::activate('SearchFileTest');
-        Environment::setEnv('SEARCH_INDEX_FILES', 1);
     }
 
     protected function tearDown(): void