Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[stable26] SystemTags endpoint to return tags used by a user with meta data #38307

Merged
merged 6 commits into from
May 17, 2023
Merged

[stable26] SystemTags endpoint to return tags used by a user with meta data #38307

merged 6 commits into from
May 17, 2023

Conversation

blizzz
Copy link
Member

@blizzz blizzz commented May 16, 2023

backport of #37961

@blizzz
PoC: SystemTags endpoint to return tags used by a user with meta data
2ea872d 
Target case is photos app: when visiting the tags category, all systemtags
of the whole cloud are retrieved. In subequent steps the next tag is
requested until the browser view is filled with tag tiles (i.e. previews
are requested just as well).

With this approach, we incorpoate the dav search and look for user related
tags that are used by them, and already returns the statistics (number of
files tagged with the respective tag) as well as a file id for the purpose
to load the preview. This defaults to the file with the highest id.

Call:
curl -s -u 'user:password' \
  'https://my.nc.srv/remote.php/dav/systemtags-current' \
  -X PROPFIND -H 'Accept: text/plain' \
  -H 'Accept-Language: en-US,en;q=0.5'  -H 'Depth: 1' \
  -H 'Content-Type: text/plain;charset=UTF-8' \
  --data @/home/doe/request-systemtag-props.xml

With request-systemtag-props.xml:
<?xml version="1.0" encoding="UTF-8"?>
<d:propfind xmlns:d="DAV:">
        <d:prop xmlns:oc="http://owncloud.org/ns" xmlns:nc="http://nextcloud.org/ns">
                <oc:id/>
                <oc:display-name/>
                <oc:user-visible/>
                <oc:user-assignable/>
                <oc:can-assign/>
                <nc:files-assigned/>
                <nc:reference-fileid/>
        </d:prop>
</d:propfind>

Example output:
  …
  <d:response>
    <d:href>/master/remote.php/dav/systemtags/84</d:href>
    <d:propstat>
      <d:prop>
        <oc:id>84</oc:id>
        <oc:display-name>Computer</oc:display-name>
        <oc:user-visible>true</oc:user-visible>
        <oc:user-assignable>true</oc:user-assignable>
        <oc:can-assign>true</oc:can-assign>
        <nc:files-assigned>42</nc:files-assigned>
        <nc:reference-fileid>924022</nc:reference-fileid>
      </d:prop>
      <d:status>HTTP/1.1 200 OK</d:status>
    </d:propstat>
  </d:response>
  <d:response>
    <d:href>/remote.php/dav/systemtags/97</d:href>
    <d:propstat>
      <d:prop>
        <oc:id>97</oc:id>
        <oc:display-name>Bear</oc:display-name>
        <oc:user-visible>true</oc:user-visible>
        <oc:user-assignable>true</oc:user-assignable>
        <oc:can-assign>true</oc:can-assign>
        <nc:files-assigned>1</nc:files-assigned>
        <nc:reference-fileid>923422</nc:reference-fileid>
      </d:prop>
      <d:status>HTTP/1.1 200 OK</d:status>
    </d:propstat>
  </d:response>
  …

Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>
@blizzz
feat: specify media type via url path: systemtags-current/$mediaType
c0dbde5 
- only the media part of the mime type can be search, but not the full
  mime type. It can be added, should it become necessary.
- thus fixes previously hardcoded selector for image/ types
- also fixes a return type hint
- adds a return type hint

Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>
@blizzz
fix: improve naming of new systemtags endpoint to systemtags-assigned
b1c8fc3 
Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>
@blizzz
chore: polish SystemTagsInUseCollection
f50ce8b 
- DI SystemTagManager
- add some comments and doc
- catch NoUserException
- add return type hints

Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>
@blizzz
refactor: remove SystemTag logic from Folder into QuerySearchHelper
f2b5a07 
- adds OC\SystemTag\SystemTagsInFilesDetector where the search logic is
  moved to

Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>
@blizzz
refactor: remove where specification from SELECT getter
298af3c 
- search constraints are now fully in control of
  SystemTagsInFilesDetector::detectAssignedSystemTagsIn(), avoids
  duplication of a WHERE statement

Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>
@blizzz blizzz added the 3. to review Waiting for reviews label May 16, 2023
@blizzz blizzz added this to the Nextcloud 26.0.2 milestone May 16, 2023
@blizzz blizzz requested review from nickvergessen, marcelklehr, icewind1991, AndyScherzinger, a team, ArtificialOwl and Fenn-CS and removed request for a team May 16, 2023 10:54
@blizzz blizzz mentioned this pull request May 16, 2023
Merged
@AndyScherzinger AndyScherzinger merged commit 4bd2f33 into stable26 May 17, 2023
@AndyScherzinger AndyScherzinger deleted the backport/37961/stable26 branch May 17, 2023 16:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@icewind1991 icewind1991 icewind1991 approved these changes

@AndyScherzinger AndyScherzinger AndyScherzinger approved these changes

@nickvergessen nickvergessen Awaiting requested review from nickvergessen

@marcelklehr marcelklehr Awaiting requested review from marcelklehr

@ArtificialOwl ArtificialOwl Awaiting requested review from ArtificialOwl ArtificialOwl was automatically assigned from nextcloud/server-backend

@Fenn-CS Fenn-CS Awaiting requested review from Fenn-CS Fenn-CS was automatically assigned from nextcloud/server-backend

Assignees
No one assigned
Labels
3. to review Waiting for reviews
Projects
None yet
Milestone
Nextcloud 26.0.2
Development

Successfully merging this pull request may close these issues.
3 participants
@blizzz @icewind1991 @AndyScherzinger