Search API based on webDAV report by jvillafanez · Pull Request #31873 · owncloud/core

jvillafanez · 2018-06-22T12:41:02Z

Description

Add support to search files through webDAV

Related Issue

Motivation and Context

Allow search file using the REPORT webDAV method. The request must be made to the base of the user's directory for files, usually "/remote.php/webdav/" or "/remote.php/dav/files/myuser/". Trying to search in inner directories will return an NotImplemented exception.

The minimum xml body request is:

<?xml version="1.0" encoding="utf-8" ?>
<oc:search-files xmlns:a="DAV:" xmlns:oc="http://owncloud.org/ns" >
        <oc:search>
                <oc:pattern>search-pattern</oc:pattern>
        </oc:search>
</oc:search-files>

The base xml body request must be:

<?xml version="1.0" encoding="utf-8" ?>
<oc:search-files xmlns:a="DAV:" xmlns:oc="http://owncloud.org/ns" >
        <a:prop>
                <oc:fileid/>
                <oc:permissions/>
                <a:getlastmodified/>
                <a:getetag/>
                <a:getcontenttype/>
                <oc:size/>
                <oc:owner-id/>
                <oc:owner-display-name/>
                <oc:size/>
        </a:prop>
        <oc:search>
                <oc:pattern>gif</oc:pattern>
                <oc:limit>5</oc:limit>
        </oc:search>
</oc:search-files>

The list of properties can be adjusted to get what you need as any PROPFIND request.
The base search limit is hardcoded to 30 results if no explicit limit is set in the request.

How Has This Been Tested?

Manually tested

Screenshots (if appropriate):

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed.

DeepDiver1975

looks good over app - please add tests- THX

DeepDiver1975 · 2018-06-22T14:15:59Z

+		$this->server->on('report', [$this, 'onReport']);
+	}
+
+		/**


Looks like this slipped by... I'll fix this during the squash

DeepDiver1975 · 2018-06-22T14:17:13Z

+
+	/**
+	 * @param string $filesUri the base uri for this user's files directory, usually /files/username
+	 * @param \OC\Search\Result\File[] $searchResults the results coming from the search service, within the files app


add use statement - 80 chars per line please

PVince81 · 2018-06-25T12:41:40Z

+			$limit = $searchInfo['limit'];
+		}
+
+		$searchResults = $this->searchService->searchPaged($searchInfo['pattern'], ['files'], 1, $limit);


is 1 page one ? strange that it doesn't start at zero...

According to the phpdocs in the function, it starts at 1. The default value is also 1. 🤷‍♂️

PVince81 · 2018-06-25T12:43:12Z

+	 */
+	private function getSearchResultIterator($filesUri, $searchResults, $requestedProps) {
+		$paths = \array_map(function ($searchResult) use ($filesUri) {
+			return $filesUri . $searchResult->path;


sad that the search result doesn't contain node ids as it would spare us a step

but for the sake of "keep it simple" and not touching too many things, this is ok

I'd vote for a new API for searches. Something that needs to be planned in any case.

codecov · 2018-06-27T10:43:18Z

Codecov Report

Merging #31873 into master will increase coverage by 0.01%.
The diff coverage is 70%.

@@             Coverage Diff              @@
##             master   #31873      +/-   ##
============================================
+ Coverage     63.44%   63.45%   +0.01%     
- Complexity    18502    18523      +21     
============================================
  Files          1165     1167       +2     
  Lines         69410    69499      +89     
  Branches       1264     1264              
============================================
+ Hits          44039    44104      +65     
- Misses        25002    25026      +24     
  Partials        369      369

Flag	Coverage Δ	Complexity Δ
#javascript	`52.58% <ø> (ø)`	`0 <ø> (ø)`	⬇️
#phpunit	`64.7% <70%> (+0.01%)`	`18523 <21> (+21)`	⬆️

Impacted Files	Coverage Δ	Complexity Δ
apps/dav/lib/Files/Xml/SearchRequest.php	`0% <0%> (ø)`	`8 <8> (?)`
apps/dav/lib/Server.php	`50.34% <0%> (-1.08%)`	`24 <0> (ø)`
apps/dav/lib/Connector/Sabre/ServerFactory.php	`94.36% <100%> (+0.24%)`	`11 <0> (ø)`	⬇️
...av/lib/Connector/Sabre/FilesSearchReportPlugin.php	`96.77% <96.77%> (ø)`	`13 <13> (?)`
lib/private/Search/Result/File.php	`0% <0%> (ø)`	`3% <0%> (ø)`	⬇️
lib/private/Server.php	`85.26% <0%> (+0.23%)`	`253% <0%> (ø)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a49adcc...7deb54c. Read the comment docs.

jvillafanez · 2018-06-27T10:44:04Z

squashed (with minor fixes)

PVince81

👍

PVince81 · 2018-06-28T09:07:06Z

@jvillafanez please backport

phil-davis · 2018-08-28T15:27:42Z

Backport PR #31946 has been merged.

This relates to owncloud/core#31873 and documents the search-files report of ownCloud's Search API.

jvillafanez added the 3 - To Review label Jun 22, 2018

jvillafanez added this to the development milestone Jun 22, 2018

jvillafanez self-assigned this Jun 22, 2018

jvillafanez mentioned this pull request Jun 22, 2018

Add search support on the REPORT method #25373

Closed

2 tasks

DeepDiver1975 requested changes Jun 22, 2018

View reviewed changes

PVince81 reviewed Jun 25, 2018

View reviewed changes

Search API based on webDAV report

7deb54c

jvillafanez force-pushed the search_api branch from 058e3d7 to 7deb54c Compare June 27, 2018 10:42

PVince81 approved these changes Jun 28, 2018

View reviewed changes

PVince81 added the backport-request label Jun 28, 2018

PVince81 merged commit 1e1718c into master Jun 28, 2018

PVince81 deleted the search_api branch June 28, 2018 09:07

jvillafanez mentioned this pull request Jun 29, 2018

[stable10] Search api stable10 #31946

Merged

9 tasks

ownclouders mentioned this pull request Jul 5, 2018

Extend Webdav files search API on REPORT #31993

Closed

phil-davis removed the backport-request label Aug 28, 2018

patrickjahns mentioned this pull request Sep 5, 2018

Acceptance tests for webDAV Report search API #32602

Closed

This was referenced Sep 21, 2018

Basic Acceptance Tests to ensure Functionality and Data segregration owncloud/search_elastic#26

Closed

API acceptance tests for WebDAV search #32816

Merged

settermjd added a commit to owncloud/docs that referenced this pull request Nov 13, 2018

Document the WebDAV search-files Search API endpoint

84215b1

This relates to owncloud/core#31873 and documents the search-files report of ownCloud's Search API.

settermjd mentioned this pull request Nov 13, 2018

Document WebDAV Search API owncloud/docs#224

Merged

settermjd added a commit to owncloud/docs that referenced this pull request Nov 13, 2018

Document the WebDAV search-files Search API endpoint

fc5f275

This relates to owncloud/core#31873 and documents the search-files report of ownCloud's Search API.

settermjd added a commit to owncloud/docs that referenced this pull request Nov 14, 2018

Document the WebDAV search-files Search API endpoint

730437c

This relates to owncloud/core#31873 and documents the search-files report of ownCloud's Search API.

settermjd added a commit to owncloud/docs that referenced this pull request Nov 14, 2018

Document the WebDAV search-files Search API endpoint

0fad8b3

This relates to owncloud/core#31873 and documents the search-files report of ownCloud's Search API.

settermjd added a commit to owncloud/docs that referenced this pull request Nov 15, 2018

Document the WebDAV search-files Search API endpoint

ddd2638

This relates to owncloud/core#31873 and documents the search-files report of ownCloud's Search API.

settermjd added a commit to owncloud/docs that referenced this pull request Nov 15, 2018

Document the WebDAV search-files Search API endpoint

5215337

This relates to owncloud/core#31873 and documents the search-files report of ownCloud's Search API.

settermjd added a commit to owncloud/docs that referenced this pull request Nov 16, 2018

Document the WebDAV search-files Search API endpoint

5725deb

This relates to owncloud/core#31873 and documents the search-files report of ownCloud's Search API.

settermjd added a commit to owncloud/docs that referenced this pull request Nov 19, 2018

Document the WebDAV search-files Search API endpoint

de4236c

This relates to owncloud/core#31873 and documents the search-files report of ownCloud's Search API.

jvillafanez mentioned this pull request Nov 19, 2018

Document new search API owncloud/docs#278

Closed

supportreq mentioned this pull request Feb 7, 2019

Search feature for the Android App owncloud/android#695

Open

lock Bot locked as resolved and limited conversation to collaborators Aug 28, 2019

Uh oh!

Conversation

jvillafanez commented Jun 22, 2018

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

Uh oh!

DeepDiver1975 left a comment

Choose a reason for hiding this comment

Uh oh!

DeepDiver1975 Jun 22, 2018

Choose a reason for hiding this comment

Uh oh!

jvillafanez Jun 27, 2018

Choose a reason for hiding this comment

Uh oh!

DeepDiver1975 Jun 22, 2018

Choose a reason for hiding this comment

Uh oh!

PVince81 Jun 25, 2018

Choose a reason for hiding this comment

Uh oh!

jvillafanez Jun 26, 2018

Choose a reason for hiding this comment

Uh oh!

PVince81 Jun 25, 2018

Choose a reason for hiding this comment

Uh oh!

jvillafanez Jun 26, 2018

Choose a reason for hiding this comment

Uh oh!

codecov Bot commented Jun 27, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

jvillafanez commented Jun 27, 2018

Uh oh!

PVince81 left a comment

Choose a reason for hiding this comment

Uh oh!

PVince81 commented Jun 28, 2018

Uh oh!

phil-davis commented Aug 28, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov Bot commented Jun 27, 2018 •

edited

Loading