[FEATURE] Add include keys list

Add option for a list of keys who should be the only ones to be
logged. Exclude keys are ignored if include keys are defined.

Change-Id: I517d7020258a057193f5133eeffe3f7f3d89ebe9
Resolves: #3053
Releases: 3.0
Reviewed-on: https://review.typo3.org/50444
Reviewed-by: Francois Suter <[email protected]>
Tested-by: Francois Suter <[email protected]>

Author: Francois Suter

ChangeLog

@@ -1,6 +1,7 @@
 2016-10-30 Francois Suter <[email protected]>
 
 	* Restored and improved log clearing feature, resolves #76972
+	* Added configuration option to restrict logging to certain keys, resolves #3053
 
 2016-09-04 Francois Suter <[email protected]>
 

Classes/Domain/Model/ExtensionConfiguration.php

@@ -47,6 +47,13 @@ class ExtensionConfiguration implements SingletonInterface
      */
     protected $excludeKeys = '';
 
+    /**
+     * Include Keys
+     *
+     * @var string
+     */
+    protected $includeKeys = '';
+
     /**
      * Ip Filter
      *
@@ -168,6 +175,27 @@ public function setExcludeKeys($excludeKeys)
         $this->excludeKeys = (string)$excludeKeys;
     }
 
+    /**
+     * Returns the includeKeys.
+     *
+     * @return string $includeKeys
+     */
+    public function getIncludeKeys()
+    {
+        return $this->includeKeys;
+    }
+
+    /**
+     * Sets the includeKeys.
+     *
+     * @param string $includeKeys
+     * @return void
+     */
+    public function setIncludeKeys($includeKeys)
+    {
+        $this->includeKeys = (string)$includeKeys;
+    }
+
     /**
      * Returns the ipFilter.
      *

Classes/Utility/Logger.php

@@ -178,9 +178,17 @@ public function isEntryAccepted($logData)
         if ($logData['severity'] < $this->extensionConfiguration->getMinimumLogLevel()) {
             return false;
         }
-        // Skip entry if key is in excluded list
-        if (GeneralUtility::inList($this->extensionConfiguration->getExcludeKeys(), $logData['extKey'])) {
-            return false;
+        // Check excluded list only if included list is empty
+        // (if included list is defined, it supersedes excluded list)
+        $includedList = $this->extensionConfiguration->getIncludeKeys();
+        if ($includedList === '') {
+            if (GeneralUtility::inList($this->extensionConfiguration->getExcludeKeys(), $logData['extKey'])) {
+                return false;
+            }
+        } else {
+            if (!GeneralUtility::inList($includedList, $logData['extKey'])) {
+                return false;
+            }
         }
         // Skip entry if referrer does not match IP mask
         if (!$this->isIpAddressAccepted($logData['ip'])) {

Resources/Private/Language/Configuration.xlf

@@ -27,6 +27,9 @@
 			<trans-unit id="excluded_keys">
 				<source>Excluded keys: Comma-separated list of (extension) keys whose entries should not be written to the logs.</source>
 			</trans-unit>
+			<trans-unit id="included_keys">
+				<source>Included keys: Comma-separated list of (extension) keys whose entries should be the only ones written to the logs (supersedes excluded keys, if also defined).</source>
+			</trans-unit>
 			<trans-unit id="ip_filter">
 				<source>Restricted IP addresses: Only requests coming from the given IP addresses will be logged. An empty value will block everything, a "*" will allow everything. Use "devIPmask" (not case-sensitive) to reuse devIPmask value.</source>
 			</trans-unit>

Tests/Unit/Domain/Model/ExtensionConfigurationTest.php

@@ -97,6 +97,30 @@ public function setExcludeKeysSetsKeys()
         );
     }
 
+    /**
+     * @test
+     */
+    public function getIncludeKeysInitiallyReturnsEmptryString()
+    {
+        self::assertSame(
+                '',
+                $this->subject->getIncludeKeys()
+        );
+    }
+
+    /**
+     * @test
+     */
+    public function setIncludeKeysSetsKeys()
+    {
+        $keys = 'core,extbase';
+        $this->subject->setIncludeKeys($keys);
+        self::assertSame(
+                $keys,
+                $this->subject->getIncludeKeys()
+        );
+    }
+
     /**
      * @test
      */

Tests/Unit/Utility/LoggerTest.php

@@ -63,41 +63,78 @@ protected function tearDown()
         unset($this->extensionConfiguration, $this->subject);
     }
 
-    /**
-     * @test
-     * @covers \Devlog\Devlog\Utility\Logger::isEntryAccepted
-     */
-    public function entryIsAccepted()
+    public function validEntriesProvider()
     {
-        self::assertTrue(
-                $this->subject->isEntryAccepted(
+        return array(
+                'Valid entry without included keys list' => array(
+                        '',
                         array(
                                 'severity' => 2,
                                 'extKey' => 'whatever',
                                 'ip' => '127.0.0.1'
                         )
+                ),
+                'Valid entry with included keys list' => array(
+                        'foo',
+                        array(
+                                'severity' => 2,
+                                'extKey' => 'foo',
+                                'ip' => '127.0.0.1'
+                        )
                 )
         );
     }
 
-    public function validEntriesProvider()
+    /**
+     * @param string $includeKeys Comma-separated list of keys to include
+     * @param array $entry Entry data
+     * @test
+     * @dataProvider validEntriesProvider
+     * @covers \Devlog\Devlog\Utility\Logger::isEntryAccepted
+     */
+    public function entryIsAccepted($includeKeys, $entry)
+    {
+        $this->extensionConfiguration->setIncludeKeys($includeKeys);
+        $this->subject->setExtensionConfiguration($this->extensionConfiguration);
+        self::assertTrue(
+                $this->subject->isEntryAccepted($entry)
+        );
+    }
+
+    /**
+     * Provides a list of log entries that will be refused given the predefined configuration.
+     *
+     * @return array
+     */
+    public function invalidEntriesProvider()
     {
         return array(
                 'Severity too low' => array(
+                        '',
                         array(
                                 'severity' => 0,
                                 'extKey' => 'whatever',
                                 'ip' => '127.0.0.1'
                         )
                 ),
                 'Excluded extension key' => array(
+                        '',
                         array(
                                 'severity' => 3,
                                 'extKey' => 'foo',
                                 'ip' => '127.0.0.1'
                         )
                 ),
+                'Not in included key list' => array(
+                        'baz',
+                        array(
+                                'severity' => 3,
+                                'extKey' => 'whatever',
+                                'ip' => '127.0.0.1'
+                        )
+                ),
                 'IP does not match' => array(
+                        '',
                         array(
                                 'severity' => 3,
                                 'extKey' => 'whatever',
@@ -108,13 +145,16 @@ public function validEntriesProvider()
     }
 
     /**
+     * @param string $includeKeys Comma-separated list of keys to include
      * @param array $entry Log entry data
      * @test
-     * @dataProvider validEntriesProvider
+     * @dataProvider invalidEntriesProvider
      * @covers \Devlog\Devlog\Utility\Logger::isEntryAccepted
      */
-    public function entryIsRefused($entry)
+    public function entryIsRefused($includeKeys, $entry)
     {
+        $this->extensionConfiguration->setIncludeKeys($includeKeys);
+        $this->subject->setExtensionConfiguration($this->extensionConfiguration);
         self::assertFalse(
                 $this->subject->isEntryAccepted(
                         $entry

ext_conf_template.txt

@@ -12,6 +12,9 @@ minimumLogLevel = -1
 # cat=general/filtering/b; type=string; label=LLL:EXT:devlog/Resources/Private/Language/Configuration.xlf:excluded_keys
 excludeKeys =
 
+# cat=general/filtering/b; type=string; label=LLL:EXT:devlog/Resources/Private/Language/Configuration.xlf:included_keys
+includeKeys =
+
 # cat=general/filtering/c; type=string; label=LLL:EXT:devlog/Resources/Private/Language/Configuration.xlf:ip_filter
 ipFilter =