Support setting roundcube's default addressbook to an addressbook fro…

…m a preset (Fixes #440)

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 - Allow to hide contacts without email also for user-defined addressbooks (Fixes #429)
 - Re-introduced option `preemptive_basic_auth` to send HTTP basic Authorization header with every request (Fixes #407)
+- Support setting roundcube's default addressbook to an addressbook from a preset (Fixes #440)
 
 ## Version 5.0.1 (to 5.0.0)
 

config.inc.php.dist

@@ -29,8 +29,8 @@
 $prefs['_GLOBAL']['loglevel'] = \Psr\Log\LogLevel::WARNING;
 $prefs['_GLOBAL']['loglevel_http'] = \Psr\Log\LogLevel::ERROR;
 
-// Select addressbook from preset to use as Roundcube's collected recipients or collected/trusted senders addressbook,
-// corresponding to the roundcube options of the same name available since roundcube 1.5.
+// Select addressbook from preset to use as Roundcube's collected recipients, collected/trusted senders or default
+// addressbook, corresponding to the roundcube options of the same name available since roundcube 1.5.
 // Note that only writeable addressbooks can be used for this. If you do not want to use these options, simply do not
 // define them
 // If no/several addressbooks match, the roundcube setting will not be changed
@@ -50,6 +50,14 @@ $prefs['_GLOBAL']['loglevel_http'] = \Psr\Log\LogLevel::ERROR;
 //    'matchname' => '/collected recipients/i',
 //    'matchurl' => '#http://carddav.example.com/abooks/%u/CollectedRecipients#',
 //];
+//$prefs['_GLOBAL']['default_addressbook'] = [
+//    // Key of the preset, i.e. whatever is used for <Presetname> in the template below
+//    'preset'  => '<Presetname>',
+//    // The placeholders that can be used in the url attribute can also be used inside these regular rexpressions
+//    // If both matchname and matchurl are given, both need to match for the addressbook to be used
+//    'matchname' => '/collected recipients/i',
+//    'matchurl' => '#http://carddav.example.com/abooks/%u/CollectedRecipients#',
+//];
 
 //// ** ACCOUNT PRESETS
 

doc/ADMIN-SETTINGS.md

@@ -304,15 +304,16 @@ Preconfigured addressbooks are processed when the user logs into roundcube.
 - If the user has addressbooks created from a preset that no longer exists (identified by the Presetname), the
   addressbooks are deleted from the database.
 
-### Using presets for the roundcube trusted senders/collected recipients addressbooks
+### Using presets for the roundcube trusted senders/collected recipients addressbooks and default addressbook
 
 Roundcube 1.5 and newer has two special internal addressbooks to automatically collect all addresses the user previously
 sent mail to (roundcube config option: `collected_recipients`) and to collect addresses of trusted senders (roundcube
 config option: `collected_senders`).
 
-It is possible for a user to manually select CardDAV addressbooks for these two special purpose addressbooks using
-the roundcube settings interface. When using preconfigured CardDAV addressbooks, the admin may want to also set these
-special addressbooks by configuration, which is possible using the following configuration options:
+It is possible for a user to manually select CardDAV addressbooks for these two special purpose addressbooks and the
+roundcube default addressbook using the roundcube settings interface. When using preconfigured CardDAV addressbooks, the
+admin may want to also set these special addressbooks or the default addressbook by configuration, which is possible
+using the following configuration options:
 
 ```php
 $prefs['_GLOBAL']['collected_recipients'] = [
@@ -325,6 +326,9 @@ $prefs['_GLOBAL']['collected_recipients'] = [
 $prefs['_GLOBAL']['collected_senders'] = [
     // Configuration analog to collected recipients
 ];
+$prefs['_GLOBAL']['default_addressbook'] = [
+    // Configuration analog to collected recipients
+];
 ```
 
 Each of the above RCMCardDAV settings will cause the roundcube setting of the same name to be overridden in case a
@@ -355,7 +359,7 @@ Configuration of these addressbooks by the user can be disabled using the follow
 roundcube (not RCMCardDAV) configuration:
 
 ```php
-$config['dont_override'] = ['collected_recipients', 'collected_senders'];
+$config['dont_override'] = ['collected_recipients', 'collected_senders', 'default_addressbook'];
 ```
 
 When using the trusted senders addressbook, please also configure the roundcube options `show_images` and `mdn_requests`

src/Frontend/AdminSettings.php

@@ -44,7 +44,7 @@
  * @psalm-type ConfigurablePresetAttr = 'accountname'|'discovery_url'|'username'|'password'|'rediscover_time'|
  *                                      'active'|'refresh_time'|'use_categories'|'readonly'|'require_always_email'|
  *                                      'name'|'preemptive_basic_auth'|'ssl_noverify'
- * @psalm-type SpecialAbookType = 'collected_recipients'|'collected_senders'
+ * @psalm-type SpecialAbookType = 'collected_recipients'|'collected_senders'|'default_addressbook'
  * @psalm-type SpecialAbookMatch = array{preset: string, matchname?: string, matchurl?: string}
  *
  * @psalm-type PresetExtraAbook = array{
@@ -258,7 +258,7 @@ public function __construct(string $configfile, LoggerInterface $logger, LoggerI
         }
 
         // Extract filter for special addressbooks
-        foreach ([ 'collected_recipients', 'collected_senders' ] as $setting) {
+        foreach ([ 'collected_recipients', 'collected_senders', 'default_addressbook' ] as $setting) {
             if (isset($gprefs[$setting]) && is_array($gprefs[$setting])) {
                 $matchSettings = $gprefs[$setting];
 

tests/Unit/AdminSettingsWithDataTest.php

@@ -56,35 +56,38 @@ public function tearDown(): void
     }
 
     /**
-     * @return array<string, list{string, list{?string,?string}}>
+     * @return array<string, list{string, list{?string,?string, ?string}}>
      */
     public function specialAbookTestProvider(): array
     {
         $base = 'tests/Unit/data/adminSettingsWithDataTest';
 
         return [
-            'Two matchers, one match' => [ "$base/matchBoth.php", ['43', '43'] ],
+            'Two matchers, one match' => [ "$base/matchBoth.php", ['43', '43', '43'] ],
             'No matches (invalid preset, AND condition eval)' => [
                 "$base/noMatch.php",
                 [
                     'Setting for collected_recipients must include a valid preset attribute',
-                    'Cannot set special addressbook collected_senders, there are 0 candidates (need: 1)'
+                    'Cannot set special addressbook collected_senders, there are 0 candidates (need: 1)',
+                    'Cannot set special addressbook default_addressbook, there are 0 candidates (need: 1)'
                 ]
             ],
             'Multiple matches' => [
                 "$base/matchMultiple.php",
                 [
                     'Cannot set special addressbook collected_recipients, there are 2 candidates (need: 1)',
-                    'Cannot set special addressbook collected_senders, there are 2 candidates (need: 1)'
+                    'Cannot set special addressbook collected_senders, there are 2 candidates (need: 1)',
+                    'Cannot set special addressbook default_addressbook, there are 2 candidates (need: 1)'
                 ]
             ],
-            'Preset not yet in DB' => [ "$base/presetNotInDbYet.php", [null, null] ],
+            'Preset not yet in DB' => [ "$base/presetNotInDbYet.php", [null, null, null] ],
         ];
     }
 
     /**
      * @param string $admSettingsPath Path name of config.inc.php file
-     * @param list{?string,?string} $expIds Expected abook IDs for 0: collected_recipients, 1: collected_senders
+     * @param list{?string,?string,?string} $expIds Expected abook IDs for 0: collected_recipients,
+     *                                              1: collected_senders, 2: default_addressbook
      * @dataProvider specialAbookTestProvider
      */
     public function testSpecialAddressbooksReturnedCorrectly(string $admSettingsPath, array $expIds): void
@@ -100,7 +103,7 @@ public function testSpecialAddressbooksReturnedCorrectly(string $admSettingsPath
         $specialAbooks = $admPrefs->getSpecialAddressbooks($abMgr, $infra);
 
         $i = 0;
-        foreach (['collected_recipients', 'collected_senders'] as $abookType) {
+        foreach (['collected_recipients', 'collected_senders', 'default_addressbook'] as $abookType) {
             if (isset($expIds[$i])) {
                 if (strpos($expIds[$i], ' ') === false) {
                     $this->assertArrayHasKey($abookType, $specialAbooks);
@@ -113,7 +116,7 @@ public function testSpecialAddressbooksReturnedCorrectly(string $admSettingsPath
                 $this->assertArrayNotHasKey($abookType, $specialAbooks);
             }
 
-            $i = 1;
+            $i++;
         }
     }
 
@@ -194,33 +197,6 @@ public function testTemplateAddressbookProvidedCorrectly(): void
         $this->assertArrayNotHasKey('template', $tmpl);
     }
 
-    /**
-     * @return array<string, list{string, list{?string,?string}}>
-     */
-    public function initPresetDataProvider(): array
-    {
-        $base = 'tests/Unit/data/adminSettingsWithDataTest';
-
-        return [
-            'Two matchers, one match' => [ "$base/matchBoth.php", ['43', '43'] ],
-            'No matches (invalid preset, AND condition eval)' => [
-                "$base/noMatch.php",
-                [
-                    'Setting for collected_recipients must include a valid preset attribute',
-                    'Cannot set special addressbook collected_senders, there are 0 candidates (need: 1)'
-                ]
-            ],
-            'Multiple matches' => [
-                "$base/matchMultiple.php",
-                [
-                    'Cannot set special addressbook collected_recipients, there are 2 candidates (need: 1)',
-                    'Cannot set special addressbook collected_senders, there are 2 candidates (need: 1)'
-                ]
-            ],
-            'Preset not yet in DB' => [ "$base/presetNotInDbYet.php", [null, null] ],
-        ];
-    }
-
     /**
      * Tests that presets are initialized and updated properly by AdminSettings::initPresets().
      *

tests/Unit/data/adminSettingsTest/fullconfig.inc.php

@@ -16,6 +16,10 @@
     'preset'  => 'OnlyShared',
     'matchname' => '/shared %d addressbook/i',
 ];
+$prefs['_GLOBAL']['default_addressbook'] = [
+    'preset'  => 'Preset1',
+    'matchurl' => '#.*\.example\.com/%d/%l/%u#',
+];
 
 $prefs['Preset1'] = [
     'accountname'         =>  'First Preset',

tests/Unit/data/adminSettingsTest/fullconfig.json

@@ -12,6 +12,10 @@
 		"collected_senders": {
 			"preset": "OnlyShared",
 			"matchname": "/shared example\\.com addressbook/i"
+		},
+		"default_addressbook": {
+			"preset": "Preset1",
+			"matchurl": "#.*\\.example\\.com/example\\.com/user/user@example\\.com#"
 		}
 	},
 	"presets": {

tests/Unit/data/adminSettingsWithDataTest/matchBoth.php

@@ -15,6 +15,13 @@
     'matchurl' => '#^https://carddav.example.com/books/%l/book43/$#',
 ];
 
+$prefs['_GLOBAL']['default_addressbook'] = [
+    'preset'  => 'AdmPreset',
+    'matchname' => '/Add/i',
+    'matchurl' => '#^https://carddav.example.com/books/%l/book43/$#',
+];
+
+
 $prefs['AdmPreset'] = [
     'accountname'         =>  'Admin Preset',
     'discovery_url'       =>  'https://carddav.example.com/',

tests/Unit/data/adminSettingsWithDataTest/matchMultiple.php

@@ -12,6 +12,11 @@
     'matchurl' => '/%u/',
 ];
 
+$prefs['_GLOBAL']['default_addressbook'] = [
+    'preset'  => 'AdmPreset',
+    'matchname' => '/Add/',
+];
+
 $prefs['AdmPreset'] = [
     'accountname'         =>  'Admin Preset',
     'discovery_url'       =>  'https://carddav.example.com/',

tests/Unit/data/adminSettingsWithDataTest/noMatch.php

@@ -13,6 +13,12 @@
     'matchurl' => '#^https://carddav.example.com/books/%l/book43/$#',
 ];
 
+$prefs['_GLOBAL']['default_addressbook'] = [
+    'preset'  => 'AdmPreset',
+    'matchname' => '/Addr/i',
+    'matchurl' => '#^https://carddav.example.com/books/%l/book43/$#',
+];
+
 $prefs['AdmPreset'] = [
     'accountname'         =>  'Admin Preset',
     'discovery_url'       =>  'https://carddav.example.com/',