summaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authorJörn Friedrich Dreyer <jfd@butonic.de>2014-12-11 12:58:22 +0100
committerJörn Friedrich Dreyer <jfd@butonic.de>2015-01-02 10:28:41 +0100
commitc738359a111445aac90518db39b5d5883e44892d (patch)
tree7e12571398068d79f9df6c54ae651232d7cb7f87 /lib
parent088323aad5de7b2fadd3c26a10cf4bdf51b5ae73 (diff)
downloadnextcloud-server-c738359a111445aac90518db39b5d5883e44892d.tar.gz
nextcloud-server-c738359a111445aac90518db39b5d5883e44892d.zip
add paged provider
Diffstat (limited to 'lib')
-rw-r--r--lib/private/files/storage/common.php1
-rw-r--r--lib/private/search.php27
-rw-r--r--lib/public/isearch.php10
-rw-r--r--lib/public/search/pagedprovider.php58
4 files changed, 94 insertions, 2 deletions
diff --git a/lib/private/files/storage/common.php b/lib/private/files/storage/common.php
index fe6aefbb42e..b2bf41f751c 100644
--- a/lib/private/files/storage/common.php
+++ b/lib/private/files/storage/common.php
@@ -278,6 +278,7 @@ abstract class Common implements \OC\Files\Storage\Storage {
}
}
}
+ closedir($dh);
return $files;
}
diff --git a/lib/private/search.php b/lib/private/search.php
index 8f04aa8360b..4629d52b40e 100644
--- a/lib/private/search.php
+++ b/lib/private/search.php
@@ -21,6 +21,7 @@
*/
namespace OC;
+use OCP\Search\PagedProvider;
use OCP\Search\Provider;
use OCP\ISearch;
@@ -39,12 +40,34 @@ class Search implements ISearch {
* @return array An array of OC\Search\Result's
*/
public function search($query, array $inApps = array()) {
+ return $this->searchPaged($query, $inApps, 0, 0);
+ }
+
+ /**
+ * Search all providers for $query
+ * @param string $query
+ * @param int $page
+ * @param int $size, 0 = all
+ * @return array An array of OC\Search\Result's
+ */
+ public function searchPaged($query, $page = 0, $size = 30) {
$this->initProviders();
$results = array();
foreach($this->providers as $provider) {
/** @var $provider Provider */
- if ($provider->providesResultsFor($inApps)) {
- $results = array_merge($results, $provider->search($query));
+ if ( ! $provider->providesResultsFor($inApps) ) {
+ continue;
+ }
+ if ($provider instanceof PagedProvider) {
+ $results = array_merge($results, $provider->searchPaged($query, $page, $size));
+ } else if ($provider instanceof Provider) {
+ $providerResults = $provider->search($query);
+ if ($size > 0) {
+ $slicedResults = array_slice($providerResults, $page * $size, $size);
+ }
+ $results = array_merge($results, $slicedResults);
+ } else {
+ \OC::$server->getLogger()->warning('Ignoring Unknown search provider', array('provider' => $provider));
}
}
return $results;
diff --git a/lib/public/isearch.php b/lib/public/isearch.php
index 229376ed3ae..84e450afe6f 100644
--- a/lib/public/isearch.php
+++ b/lib/public/isearch.php
@@ -34,10 +34,20 @@ interface ISearch {
* @param string $query
* @param string[] $inApps optionally limit results to the given apps
* @return array An array of OCP\Search\Result's
+ * @deprecated use searchPaged() with page and size
*/
public function search($query, array $inApps = array());
/**
+ * Search all providers for $query
+ * @param string $query
+ * @param int $page
+ * @param int $size
+ * @return array An array of OCP\Search\Result's
+ */
+ public function searchPaged($query, $page = 0, $size = 30);
+
+ /**
* Register a new search provider to search with
* @param string $class class name of a OCP\Search\Provider
* @param array $options optional
diff --git a/lib/public/search/pagedprovider.php b/lib/public/search/pagedprovider.php
new file mode 100644
index 00000000000..97da1dd2c85
--- /dev/null
+++ b/lib/public/search/pagedprovider.php
@@ -0,0 +1,58 @@
+<?php
+/**
+ * ownCloud
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or any later version.
+ *
+ * This library 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 library. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCP\Search;
+
+/**
+ * Provides a template for search functionality throughout ownCloud;
+ */
+abstract class PagedProvider extends Provider {
+
+ /**
+ * List of options (currently unused)
+ * @var array
+ */
+ private $options;
+
+ /**
+ * Constructor
+ * @param array $options
+ */
+ public function __construct($options) {
+ $this->options = $options;
+ }
+
+ /**
+ * Search for $query
+ * @param string $query
+ * @return array An array of OCP\Search\Result's
+ */
+ public function search($query) {
+ $this->searchPaged($query, 0, 0);
+ }
+
+ /**
+ * Search for $query
+ * @param string $query
+ * @param int $limit, 0 = unlimited
+ * @param int $offset
+ * @return array An array of OCP\Search\Result's
+ */
+ abstract public function searchPaged($query, $limit, $offset);
+}