Convert strict_search to wildcard property and add psalm docs

Signed-off-by: Joas Schilling <coding@schilljs.com>

diff --git a/apps/dav/lib/CardDAV/AddressBookImpl.php b/apps/dav/lib/CardDAV/AddressBookImpl.php
index 1b74f329f1fa9a4515ea94528078a2ccafb19f1c..3db20cb4220a3f117f29111a888a97559ddcae86 100644 (file)
--- a/apps/dav/lib/CardDAV/AddressBookImpl.php
+++ b/apps/dav/lib/CardDAV/AddressBookImpl.php
@@ -108,6 +108,7 @@ class AddressBookImpl implements IAddressBook {
         *      - 'limit' - Set a numeric limit for the search results
         *      - 'offset' - Set the offset for the limited search results
         *      - 'wildcard' - Whether the search should use wildcards
+        * @psalm-param array{types?: bool, escape_like_param?: bool, limit?: int, offset?: int, wildcard?: bool} $options
         * @return array an array of contacts which are arrays of key-value-pairs
         *  example result:
         *  [

diff --git a/apps/dav/lib/CardDAV/CardDavBackend.php b/apps/dav/lib/CardDAV/CardDavBackend.php
index 403c4646e4784f788bff3223d390e9996159f2f5..3e360fb2e414dddd14569de61dc43eab478144dc 100644 (file)
--- a/apps/dav/lib/CardDAV/CardDavBackend.php
+++ b/apps/dav/lib/CardDAV/CardDavBackend.php
@@ -1025,6 +1025,7 @@ class CardDavBackend implements BackendInterface, SyncSupport {
         *    - 'limit' - Set a numeric limit for the search results
         *    - 'offset' - Set the offset for the limited search results
         *    - 'wildcard' - Whether the search should use wildcards
+        * @psalm-param array{escape_like_param?: bool, limit?: int, offset?: int, wildcard?: bool} $options
         * @return array an array of contacts which are arrays of key-value-pairs
         */
        public function search($addressBookId, $pattern, $searchProperties, $options = []): array {
@@ -1056,6 +1057,7 @@ class CardDavBackend implements BackendInterface, SyncSupport {
         * @param string $pattern
         * @param array $searchProperties
         * @param array $options
+        * @psalm-param array{types?: bool, escape_like_param?: bool, limit?: int, offset?: int, wildcard?: bool} $options
         * @return array
         */
        private function searchByAddressBookIds(array $addressBookIds,

diff --git a/lib/private/ContactsManager.php b/lib/private/ContactsManager.php
index 557cf98c66b4024bd14494a9d8f6b9ea51c7d04c..937fb94a09ac66cae1f6409ad9705f392e6a8f1d 100644 (file)
--- a/lib/private/ContactsManager.php
+++ b/lib/private/ContactsManager.php
@@ -42,8 +42,10 @@ class ContactsManager implements IManager {
         *      - 'escape_like_param' - If set to false wildcards _ and % are not escaped
         *      - 'limit' - Set a numeric limit for the search results
         *      - 'offset' - Set the offset for the limited search results
-        *      - 'enumeration' - Whether user enumeration on system address book is allowed
-        *      - 'fullmatch' - Whether matching on full detail in system address book is allowed
+        *      - 'enumeration' - (since 23.0.0) Whether user enumeration on system address book is allowed
+        *      - 'fullmatch' - (since 23.0.0) Whether matching on full detail in system address book is allowed
+        *      - 'strict_search' - (since 23.0.0) Whether the search pattern is full string or partial search
+        * @psalm-param array{escape_like_param?: bool, limit?: int, offset?: int, enumeration?: bool, fullmatch?: bool, strict_search?: bool} $options
         * @return array an array of contacts which are arrays of key-value-pairs
         */
        public function search($pattern, $searchProperties = [], $options = []) {
@@ -51,6 +53,7 @@ class ContactsManager implements IManager {
                $result = [];
                foreach ($this->addressBooks as $addressBook) {
                        $searchOptions = $options;
+                       $strictSearch = array_key_exists('strict_search', $options) && $options['strict_search'] === true;
 
                        if ($addressBook->isSystemAddressBook()) {
                                $fullMatch = !\array_key_exists('fullmatch', $options) || $options['fullmatch'] !== false;
@@ -58,7 +61,13 @@ class ContactsManager implements IManager {
                                        // Neither full match is allowed, so skip the system address book
                                        continue;
                                }
-                               $searchOptions['wildcard'] = !\array_key_exists('enumeration', $options) || $options['enumeration'] !== false;
+                               if ($strictSearch) {
+                                       $searchOptions['wildcard'] = false;
+                               } else {
+                                       $searchOptions['wildcard'] = !\array_key_exists('enumeration', $options) || $options['enumeration'] !== false;
+                               }
+                       } else {
+                               $searchOptions['wildcard'] = !$strictSearch;
                        }
 
                        $r = $addressBook->search($pattern, $searchProperties, $searchOptions);

diff --git a/lib/public/Contacts/IManager.php b/lib/public/Contacts/IManager.php
index 6d5f318cfa8d1cebac7f5267d59fe7e84bdf39a5..e9bdc01c060cbf73725bc55beead8e2a57a21be7 100644 (file)
--- a/lib/public/Contacts/IManager.php
+++ b/lib/public/Contacts/IManager.php
@@ -93,8 +93,10 @@ interface IManager {
         *      - 'escape_like_param' - If set to false wildcards _ and % are not escaped
         *      - 'limit' - Set a numeric limit for the search results
         *      - 'offset' - Set the offset for the limited search results
-        *      - 'enumeration' - Whether user enumeration on system address book is allowed
-        *      - 'fullmatch' - Whether matching on full detail in system addresss book is allowed
+        *      - 'enumeration' - (since 23.0.0) Whether user enumeration on system address book is allowed
+        *      - 'fullmatch' - (since 23.0.0) Whether matching on full detail in system addresss book is allowed
+        *      - 'strict_search' - (since 23.0.0) Whether the search pattern is full string or partial search
+        * @psalm-param array{escape_like_param?: bool, limit?: int, offset?: int, enumeration?: bool, fullmatch?: bool, strict_search?: bool} $options
         * @return array an array of contacts which are arrays of key-value-pairs
         * @since 6.0.0
         */

diff --git a/lib/public/IAddressBook.php b/lib/public/IAddressBook.php
index 738745376d3e1ebcea948fb412e457c80fa2095f..4bb632ae070996c0e38d3ec5f12c85525f48c970 100644 (file)
--- a/lib/public/IAddressBook.php
+++ b/lib/public/IAddressBook.php
@@ -67,7 +67,8 @@ namespace OCP {
                 *      - 'escape_like_param' - If set to false wildcards _ and % are not escaped
                 *      - 'limit' - Set a numeric limit for the search results
                 *      - 'offset' - Set the offset for the limited search results
-                *      - 'wildcard' - Whether the search should use wildcards
+                *      - 'wildcard' - (since 23.0.0) Whether the search should use wildcards
+                * @psalm-param array{types?: bool, escape_like_param?: bool, limit?: int, offset?: int, wildcard?: bool} $options
                 * @return array an array of contacts which are arrays of key-value-pairs
                 *  example result:
                 *  [