summaryrefslogtreecommitdiffstats
path: root/lib/public/Search
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/Search')
-rw-r--r--lib/public/Search/ASearchResultEntry.php102
-rw-r--r--lib/public/Search/IProvider.php83
-rw-r--r--lib/public/Search/ISearchQuery.php79
-rw-r--r--lib/public/Search/PagedProvider.php5
-rw-r--r--lib/public/Search/Provider.php7
-rw-r--r--lib/public/Search/Result.php6
-rw-r--r--lib/public/Search/SearchResult.php112
7 files changed, 394 insertions, 0 deletions
diff --git a/lib/public/Search/ASearchResultEntry.php b/lib/public/Search/ASearchResultEntry.php
new file mode 100644
index 00000000000..45d62525abd
--- /dev/null
+++ b/lib/public/Search/ASearchResultEntry.php
@@ -0,0 +1,102 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright 2020 Christoph Wurst <christoph@winzerhof-wurst.at>
+ *
+ * @author 2020 Christoph Wurst <christoph@winzerhof-wurst.at>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace OCP\Search;
+
+use JsonSerializable;
+
+/**
+ * Represents an entry in a list of results an app returns for a unified search
+ * query.
+ *
+ * The app providing the results has to extend this class for customization. In
+ * most cases apps do not have to add any additional code.
+ *
+ * @example ``class MailResultEntry extends ASearchResultEntry {}`
+ *
+ * This approach was chosen over a final class as it allows Nextcloud to later
+ * add new optional properties of an entry without having to break the usage of
+ * this class in apps.
+ *
+ * @since 20.0.0
+ */
+abstract class ASearchResultEntry implements JsonSerializable {
+
+ /**
+ * @var string
+ * @since 20.0.0
+ */
+ protected $thumbnailUrl;
+
+ /**
+ * @var string
+ * @since 20.0.0
+ */
+ protected $title;
+
+ /**
+ * @var string
+ * @since 20.0.0
+ */
+ protected $subline;
+
+ /**
+ * @var string
+ * @since 20.0.0
+ */
+ protected $resourceUrl;
+
+ /**
+ * @param string $thumbnailUrl a relative or absolute URL to the thumbnail or icon of the entry
+ * @param string $title a main title of the entry
+ * @param string $subline the secondary line of the entry
+ * @param string $resourceUrl the URL where the user can find the detail, like a deep link inside the app
+ *
+ * @since 20.0.0
+ */
+ public function __construct(string $thumbnailUrl,
+ string $title,
+ string $subline,
+ string $resourceUrl) {
+ $this->thumbnailUrl = $thumbnailUrl;
+ $this->title = $title;
+ $this->subline = $subline;
+ $this->resourceUrl = $resourceUrl;
+ }
+
+ /**
+ * @return array
+ *
+ * @since 20.0.0
+ */
+ public function jsonSerialize(): array {
+ return [
+ 'thumbnailUrl' => $this->thumbnailUrl,
+ 'title' => $this->title,
+ 'subline' => $this->subline,
+ 'resourceUrl' => $this->resourceUrl,
+ ];
+ }
+}
diff --git a/lib/public/Search/IProvider.php b/lib/public/Search/IProvider.php
new file mode 100644
index 00000000000..080f5089f1f
--- /dev/null
+++ b/lib/public/Search/IProvider.php
@@ -0,0 +1,83 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright 2020 Christoph Wurst <christoph@winzerhof-wurst.at>
+ *
+ * @author 2020 Christoph Wurst <christoph@winzerhof-wurst.at>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace OCP\Search;
+
+use OCP\IUser;
+
+/**
+ * Interface for search providers
+ *
+ * These providers will be implemented in apps, so they can participate in the
+ * global search results of Nextcloud. If an app provides more than one type of
+ * resource, e.g. contacts and address books in Nextcloud Contacts, it should
+ * register one provider per group.
+ *
+ * @since 20.0.0
+ */
+interface IProvider {
+
+ /**
+ * Get the unique ID of this search provider
+ *
+ * Ideally this should be the app name or an identifier identified with the
+ * app name, especially if the app registers more than one provider.
+ *
+ * Example: 'mail', 'mail_recipients', 'files_sharing'
+ *
+ * @return string
+ *
+ * @since 20.0.0
+ */
+ public function getId(): string;
+
+ /**
+ * Find matching search entries in an app
+ *
+ * Search results can either be a complete list of all the matches the app can
+ * find, or ideally a paginated result set where more data can be fetched on
+ * demand. To be able to tell where the next offset starts the search uses
+ * "cursors" which are a property of the last result entry. E.g. search results
+ * that show most recent entries first can look for entries older than the last
+ * one of the first result set. This approach was chosen over a numeric limit/
+ * offset approach as the offset moves as new data comes in. The cursor is
+ * resistant to these changes and will still show results without overlaps or
+ * gaps.
+ *
+ * See https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89
+ * for the concept of cursors.
+ *
+ * Implementations that return result pages have to adhere to the limit
+ * property of a search query.
+ *
+ * @param IUser $user
+ * @param ISearchQuery $query
+ *
+ * @return SearchResult
+ *
+ * @since 20.0.0
+ */
+ public function search(IUser $user, ISearchQuery $query): SearchResult;
+}
diff --git a/lib/public/Search/ISearchQuery.php b/lib/public/Search/ISearchQuery.php
new file mode 100644
index 00000000000..00d538050d4
--- /dev/null
+++ b/lib/public/Search/ISearchQuery.php
@@ -0,0 +1,79 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright 2020 Christoph Wurst <christoph@winzerhof-wurst.at>
+ *
+ * @author 2020 Christoph Wurst <christoph@winzerhof-wurst.at>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace OCP\Search;
+
+/**
+ * The query objected passed into \OCP\Search\IProvider::search
+ *
+ * This mainly wraps the search term, but will ensure that Nextcloud can add new
+ * optional properties to a search request without having break the interface of
+ * \OCP\Search\IProvider::search.
+ *
+ * @see \OCP\Search\IProvider::search
+ *
+ * @since 20.0.0
+ */
+interface ISearchQuery {
+
+ /**
+ * @since 20.0.0
+ */
+ public const SORT_DATE_DESC = 1;
+
+ /**
+ * Get the user-entered search term to find matches for
+ *
+ * @return string the search term
+ * @since 20.0.0
+ */
+ public function getTerm(): string;
+
+ /**
+ * Get the sort order of results as defined as SORT_* constants on this interface
+ *
+ * @return int
+ * @since 20.0.0
+ */
+ public function getSortOrder(): int;
+
+ /**
+ * Get the number of items to return for a paginated result
+ *
+ * @return int
+ * @see \OCP\Search\IProvider for details
+ * @since 20.0.0
+ */
+ public function getLimit(): int;
+
+ /**
+ * Get the app-specific cursor of the tail of the previous result entries
+ *
+ * @return int|string|null
+ * @see \OCP\Search\IProvider for details
+ * @since 20.0.0
+ */
+ public function getCursor();
+}
diff --git a/lib/public/Search/PagedProvider.php b/lib/public/Search/PagedProvider.php
index cbccc1abc0f..479214ad405 100644
--- a/lib/public/Search/PagedProvider.php
+++ b/lib/public/Search/PagedProvider.php
@@ -30,12 +30,14 @@ namespace OCP\Search;
/**
* Provides a template for search functionality throughout ownCloud;
* @since 8.0.0
+ * @deprecated 20.0.0
*/
abstract class PagedProvider extends Provider {
/**
* show all results
* @since 8.0.0
+ * @deprecated 20.0.0
*/
public const SIZE_ALL = 0;
@@ -43,6 +45,7 @@ abstract class PagedProvider extends Provider {
* Constructor
* @param array $options
* @since 8.0.0
+ * @deprecated 20.0.0
*/
public function __construct($options) {
parent::__construct($options);
@@ -53,6 +56,7 @@ abstract class PagedProvider extends Provider {
* @param string $query
* @return array An array of OCP\Search\Result's
* @since 8.0.0
+ * @deprecated 20.0.0
*/
public function search($query) {
// old apps might assume they get all results, so we use SIZE_ALL
@@ -66,6 +70,7 @@ abstract class PagedProvider extends Provider {
* @param int $size 0 = SIZE_ALL
* @return array An array of OCP\Search\Result's
* @since 8.0.0
+ * @deprecated 20.0.0
*/
abstract public function searchPaged($query, $page, $size);
}
diff --git a/lib/public/Search/Provider.php b/lib/public/Search/Provider.php
index 18594eefb8f..275a63c0056 100644
--- a/lib/public/Search/Provider.php
+++ b/lib/public/Search/Provider.php
@@ -30,11 +30,13 @@ namespace OCP\Search;
/**
* Provides a template for search functionality throughout ownCloud;
* @since 7.0.0
+ * @deprecated 20.0.0
*/
abstract class Provider {
/**
* @since 8.0.0
+ * @deprecated 20.0.0
*/
public const OPTION_APPS = 'apps';
@@ -42,6 +44,7 @@ abstract class Provider {
* List of options
* @var array
* @since 7.0.0
+ * @deprecated 20.0.0
*/
protected $options;
@@ -49,6 +52,7 @@ abstract class Provider {
* Constructor
* @param array $options as key => value
* @since 7.0.0 - default value for $options was added in 8.0.0
+ * @deprecated 20.0.0
*/
public function __construct($options = []) {
$this->options = $options;
@@ -59,6 +63,7 @@ abstract class Provider {
* @param string $key
* @return mixed
* @since 8.0.0
+ * @deprecated 20.0.0
*/
public function getOption($key) {
if (is_array($this->options) && isset($this->options[$key])) {
@@ -76,6 +81,7 @@ abstract class Provider {
* @param string[] $apps
* @return bool
* @since 8.0.0
+ * @deprecated 20.0.0
*/
public function providesResultsFor(array $apps = []) {
$forApps = $this->getOption(self::OPTION_APPS);
@@ -87,6 +93,7 @@ abstract class Provider {
* @param string $query
* @return array An array of OCP\Search\Result's
* @since 7.0.0
+ * @deprecated 20.0.0
*/
abstract public function search($query);
}
diff --git a/lib/public/Search/Result.php b/lib/public/Search/Result.php
index 33748cff375..a3a58a38cde 100644
--- a/lib/public/Search/Result.php
+++ b/lib/public/Search/Result.php
@@ -29,6 +29,7 @@ namespace OCP\Search;
/**
* The generic result of a search
* @since 7.0.0
+ * @deprecated 20.0.0
*/
class Result {
@@ -37,6 +38,7 @@ class Result {
* corresponding application.
* @var string
* @since 7.0.0
+ * @deprecated 20.0.0
*/
public $id;
@@ -45,6 +47,7 @@ class Result {
* results.
* @var string
* @since 7.0.0
+ * @deprecated 20.0.0
*/
public $name;
@@ -52,6 +55,7 @@ class Result {
* URL to the application item.
* @var string
* @since 7.0.0
+ * @deprecated 20.0.0
*/
public $link;
@@ -60,6 +64,7 @@ class Result {
* as the class name (e.g. \OC\Search\File -> 'file') in lowercase.
* @var string
* @since 7.0.0
+ * @deprecated 20.0.0
*/
public $type = 'generic';
@@ -69,6 +74,7 @@ class Result {
* @param string $name displayed text of result
* @param string $link URL to the result within its app
* @since 7.0.0
+ * @deprecated 20.0.0
*/
public function __construct($id = null, $name = null, $link = null) {
$this->id = $id;
diff --git a/lib/public/Search/SearchResult.php b/lib/public/Search/SearchResult.php
new file mode 100644
index 00000000000..7abb5b9f188
--- /dev/null
+++ b/lib/public/Search/SearchResult.php
@@ -0,0 +1,112 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright 2020 Christoph Wurst <christoph@winzerhof-wurst.at>
+ *
+ * @author 2020 Christoph Wurst <christoph@winzerhof-wurst.at>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace OCP\Search;
+
+use JsonSerializable;
+
+/**
+ * @since 20.0.0
+ */
+final class SearchResult implements JsonSerializable {
+
+ /** @var string */
+ private $name;
+
+ /** @var bool */
+ private $isPaginated;
+
+ /** @var ASearchResultEntry[] */
+ private $entries;
+
+ /** @var int|string|null */
+ private $cursor;
+
+ /**
+ * @param string $name the translated name of the result section or group, e.g. "Mail"
+ * @param bool $isPaginated
+ * @param ASearchResultEntry[] $entries
+ * @param null $cursor
+ *
+ * @since 20.0.0
+ */
+ private function __construct(string $name,
+ bool $isPaginated,
+ array $entries,
+ $cursor = null) {
+ $this->name = $name;
+ $this->isPaginated = $isPaginated;
+ $this->entries = $entries;
+ $this->cursor = $cursor;
+ }
+
+ /**
+ * @param ASearchResultEntry[] $entries
+ *
+ * @return static
+ *
+ * @since 20.0.0
+ */
+ public static function complete(string $name, array $entries): self {
+ return new self(
+ $name,
+ false,
+ $entries
+ );
+ }
+
+ /**
+ * @param ASearchResultEntry[] $entries
+ * @param int|string $cursor
+ *
+ * @return static
+ *
+ * @since 20.0.0
+ */
+ public static function paginated(string $name,
+ array $entries,
+ $cursor): self {
+ return new self(
+ $name,
+ true,
+ $entries,
+ $cursor
+ );
+ }
+
+ /**
+ * @return array
+ *
+ * @since 20.0.0
+ */
+ public function jsonSerialize(): array {
+ return [
+ 'name' => $this->name,
+ 'isPaginated' => $this->isPaginated,
+ 'entries' => $this->entries,
+ 'cursor' => $this->cursor,
+ ];
+ }
+}
generated by cgit v1.2.3 (git 2.39.1) at 2025-02-09 03:15:14 +0000