Adding dav resource for avatars #26872

DeepDiver1975 · 2016-12-23T11:13:03Z

Description

There is one root resource called /avatars/ - within this collection there is a list of all users (only enumerable in debug mode as usual).

Within this user node avatars can be loaded following the pattern
$size.$ext

where size is less then 1024 and ext is wither jppg or png.

A default child named 96.jpeg is listed.

To Decide:

allow any size or support only some like 32, 64, 96, 128, ...
- any
- list

ToDo:

unit tests
integration tests
think about unauthenticated requests - interesting for public share links

Motivation and Context

@dragotin wants to have some fun with the desktop client during the holidays and I happily support him

How Has This Been Tested?

Browser with sabre's browser plugin - see screeshot

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.

mention-bot · 2016-12-23T11:13:04Z

@DeepDiver1975, thanks for your PR! By analyzing the history of the files in this pull request, we identified @bartv2, @PVince81, @tanghus and @DeepDiver1975 to be potential reviewers.

PVince81 · 2016-12-23T11:14:56Z

Link to the spec for easier overview ?

SergioBertolinSG · 2016-12-23T12:17:06Z

This will be useful for mobile clients as well.

SergioBertolinSG · 2016-12-23T12:31:51Z

Using cadaver I can download the file correctly, but when listing collection there is an error:

dav:/remote.php/dav/avatars/tomas/> ls
Listing collection `/remote.php/dav/avatars/tomas/': succeeded.
Error: 96.jpeg 404 Not Found

DeepDiver1975 · 2016-12-23T12:36:26Z

Using cadaver I can download the file correctly, but when listing collection there is an error:

indeed - I'm having a look

DeepDiver1975 · 2016-12-23T12:44:56Z

Using cadaver I can download the file correctly, but when listing collection there is an error:

fixed

davivel · 2016-12-23T12:52:24Z

A wonderful 'if (server.version >= ... )' is coming to Android...

SergioBertolinSG · 2016-12-23T13:01:32Z

Works 👍

DeepDiver1975 · 2016-12-23T13:31:32Z

A wonderful 'if (server.version >= ... )' is coming to Android...

I would not do this based on the server version - with caldav and carddav a user's calendar/addressbook home is detected via a property on the current principal.

I did the same here

$ curl --request PROPFIND  --user admin:admin --header "Content-Type: text/xml"  --data "<D:propfind xmlns:D='DAV:' xmlns:oc='http://owncloud.org/ns'><D:prop><D:displayname/><oc:avatar-home/></D:prop></D:propfind>" http://localhost:8080/remote.php/dav/principals/users/admin
<?xml version="1.0"?>
<d:multistatus xmlns:d="DAV:" xmlns:s="http://sabredav.org/ns" xmlns:cal="urn:ietf:params:xml:ns:caldav" xmlns:cs="http://calendarserver.org/ns/" xmlns:card="urn:ietf:params:xml:ns:carddav" xmlns:oc="http://owncloud.org/ns">
 <d:response>
  <d:href>/remote.php/dav/principals/users/admin/</d:href>
  <d:propstat>
   <d:prop>
    <d:displayname>Mr. Admin</d:displayname>
    <oc:avatar-home>
     <d:href>/remote.php/dav/avatars/admin</d:href>
    </oc:avatar-home>
   </d:prop>
   <d:status>HTTP/1.1 200 OK</d:status>
  </d:propstat>
 </d:response>
</d:multistatus>

DeepDiver1975 · 2016-12-23T13:56:42Z

.... or we add a capability

@dragotin

DeepDiver1975 · 2017-01-16T22:08:32Z

ping @dragotin

dragotin · 2017-01-21T17:41:56Z

Just out of curiosity: If I do a request like

curl --request PROPFIND  --user kf:xxxxx --header "Content-Type: text/xml"  --data "<D:propfind xmlns:D='DAV:' xmlns:oc='http://owncloud.org/ns'><D:allprop/></D:propfind>" http://localhost/ocm/remote.php/dav/principals/users/kf

to get all the available properties of the resource, the result is

<?xml version="1.0"?>
<d:multistatus xmlns:d="DAV:" xmlns:s="http://sabredav.org/ns" xmlns:cal="urn:ietf:params:xml:ns:caldav" xmlns:cs="http://calendarserver.org/ns/" xmlns:card="urn:ietf:params:xml:ns:carddav" xmlns:oc="http://owncloud.org/ns">
 <d:response>
  <d:href>/ocm/remote.php/dav/principals/users/kf/</d:href>
  <d:propstat>
   <d:prop>
    <d:resourcetype>
     <d:collection/>
     <d:principal/>
    </d:resourcetype>
   </d:prop>
   <d:status>HTTP/1.1 200 OK</d:status>
  </d:propstat>
 </d:response>
</d:multistatus>

Is that correct? http://www.restpatterns.org/HTTP_Methods/PROPFIND describes different.

@DeepDiver1975 I am trying to find out which other props I can query from the principal.

The avatar image is fetched from the server async, thus connect a signal from the account if the avatar changes. Server feature owncloud/core#26872 is needed.

dragotin

Works for me to implement owncloud/client#5482 yet I can not comment too much on the php code :-)

Thanks!

dragotin · 2017-01-24T17:46:37Z

@DeepDiver1975 btw - I would appreciate if a client would not have to query the path to the avatar from the principals properties but if it just could always get principals/users/<username>/<size>.png and that either returns 200 with content or not.

The reason is if we use that API also to get avatars for the users in the activity stream, we would have to query first for the path, and than for the image itself, basically doubling the amount of queries... (even if the client caches the avatars for the users it saw...)

ogoffart · 2017-01-26T07:59:07Z

A capability would be nice.

DeepDiver1975 · 2017-01-26T10:04:01Z

A capability would be nice.

for?

DeepDiver1975 · 2017-01-26T10:05:29Z

@DeepDiver1975 btw - I would appreciate if a client would not have to query the path to the avatar from the principals properties but if it just could always get principals/users//.png and that either returns 200 with content or not.

querying the prop only works for the own user - one has no access to the principal of other users as far as I have been retesting this .....

Well - just use the url as is.

dragotin · 2017-01-26T10:15:28Z

Yes, ok. So if we want to extend usage of the avatar image it is important that

the avatar url stays stable
and that user a can read the avatar picture of user b

About the capability: In general it would be enough to know if the avatar image can be queried yes/no. However since there will be changes in time, maybe a capability that tells the 'capability api version' would be best.

DeepDiver1975 · 2017-01-26T10:17:08Z

the avatar url stays stable

yes

and that user a can read the avatar picture of user b

already possible

guruz · 2017-03-15T15:01:22Z

Client status: We have the PR for client but we'd like for the server to have this merged first
owncloud/client#5482

DeepDiver1975 · 2017-03-15T22:04:18Z

Client status: We have the PR for client but we'd like for the server to have this merged first

what us missing from your point of view - do we need a capability?
I for sure will remove the dav property - it only works for the currently logged in user - pointless

guruz · 2017-03-16T12:07:38Z

do we need a capability?

The current code works by just guessing the URL: https://github.com/owncloud/client/pull/5482/files#diff-4301a6735ca9b7817b27e8f2f1bd5615R596

From the client developer perspective this is completely fine, but you guys are usually not happy about too many requests on the server so if you want to avoid that then better supply a capability?
(although 1 request when connecting is not so bad)

@ogoffart Feel free to override my opinion

PVince81 · 2017-03-22T09:18:31Z

apps/dav/lib/Avatars/AvatarHome.php

+	function getChildren() {
+		try {
+			return [
+				$this->getChild('96.jpeg')


hardcoded just like that ? "jpeg" or "jpg" ?

we support jpeg and png - we have to choose on extension

"jpg" then ? 😉

Are real avatars really stored as "jpeg" and not "jpg" ?

I did choose jpeg all over the place - https://github.com/owncloud/core/pull/26872/files#diff-a35b648d0c28cd73c0a837606ddff51cR62

not stored - we convert on the fly - https://github.com/owncloud/core/pull/26872/files#diff-bd5bb24cc378d2ec7bc1b76759b3f975R66

PVince81 · 2017-03-22T10:36:27Z

Fine then, "jpeg" it is.

What else is missing ? Capability ? Integration tests ? (integration tests could be added later)

DeepDiver1975

What else is missing ? Capability ? Integration tests ? (integration tests could be added later)

fixing ui tests .... no capabilities required according to the client team

DeepDiver1975 · 2017-03-22T10:31:55Z

apps/dav/lib/Avatars/AvatarHome.php

+	function getChildren() {
+		try {
+			return [
+				$this->getChild('96.jpeg')


not stored - we convert on the fly - https://github.com/owncloud/core/pull/26872/files#diff-bd5bb24cc378d2ec7bc1b76759b3f975R66

individual-it · 2017-03-23T05:13:36Z

please get commit e5d1c36 into this branch to make the UI tests pass
I've branched off and cherry picked it, to make the test pass: https://travis-ci.org/owncloud/core/jobs/214116816

DeepDiver1975 · 2017-03-23T08:33:55Z

please get commit e5d1c36 into this branch to make the UI tests pass

I rebased this branch and the commit is in here - but I still observe the error ... strange ...

DeepDiver1975 · 2017-03-23T08:55:17Z

what - now green - are you kidding me?

@individual-it THX

DeepDiver1975 · 2017-03-23T11:23:27Z

jenkins green - https://jenkins.owncloud.org/job/owncloud-core/job/core/job/PR-26872/

DeepDiver1975 · 2017-03-23T13:17:16Z

@PVince81 objections in merging?

PVince81 · 2017-03-23T13:52:16Z

Please raise doc ticket with instructions how to use the endpoint.

And add this to the wiki page about new features

guruz · 2017-04-03T19:08:18Z

Added in https://github.com/owncloud/core/wiki/ownCloud-10.0-Features "For Developers"

lock · 2019-08-03T15:01:49Z

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

DeepDiver1975 added the 3 - To Review label Dec 23, 2016

DeepDiver1975 added this to the 10.0 milestone Dec 23, 2016

DeepDiver1975 requested a review from dragotin December 23, 2016 11:13

DeepDiver1975 added 2 - Developing and removed 3 - To Review labels Dec 23, 2016

dragotin mentioned this pull request Jan 22, 2017

Display Avatar pictures in the Settingsdialog owncloud/client#5482

Closed

dragotin approved these changes Jan 22, 2017

View reviewed changes

PVince81 mentioned this pull request Jan 27, 2017

Show remote user's avatar for server to server shares #14564

Closed

DeepDiver1975 force-pushed the dav-avatars branch from 1657932 to 0d750e8 Compare March 21, 2017 22:13

PVince81 reviewed Mar 22, 2017

View reviewed changes

DeepDiver1975 commented Mar 22, 2017

View reviewed changes

individual-it mentioned this pull request Mar 23, 2017

trying to fix tests in PR 26872 #27461

Closed

DeepDiver1975 added 4 commits March 23, 2017 09:20

Adding dav resource for avatars

cd5c9e7

Return last modification time to allow proper listing in cadaver

ce350b0

Adding AvatarHomeTest

f0f926a

Adding AvatarNodeTest

0fd7746

DeepDiver1975 force-pushed the dav-avatars branch from baa42d6 to 0fd7746 Compare March 23, 2017 08:21

DeepDiver1975 added 3 - To Review and removed 2 - Developing labels Mar 23, 2017

PVince81 merged commit 7115494 into master Mar 23, 2017

PVince81 deleted the dav-avatars branch March 23, 2017 13:51

MorrisJobke mentioned this pull request Mar 26, 2017

Adding dav resource for avatars nextcloud/server#4062

Merged

SamuAlfageme mentioned this pull request Feb 26, 2018

Object for User info owncloud/ios-sdk#4

Closed

lock bot locked as resolved and limited conversation to collaborators Aug 3, 2019

Adding dav resource for avatars #26872

Adding dav resource for avatars #26872

Conversation

DeepDiver1975 commented Dec 23, 2016 • edited Loading

Description

To Decide:

ToDo:

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

mention-bot commented Dec 23, 2016

PVince81 commented Dec 23, 2016

SergioBertolinSG commented Dec 23, 2016

SergioBertolinSG commented Dec 23, 2016

DeepDiver1975 commented Dec 23, 2016

DeepDiver1975 commented Dec 23, 2016

davivel commented Dec 23, 2016

SergioBertolinSG commented Dec 23, 2016

DeepDiver1975 commented Dec 23, 2016

DeepDiver1975 commented Dec 23, 2016

DeepDiver1975 commented Jan 16, 2017

dragotin commented Jan 21, 2017

dragotin left a comment

Choose a reason for hiding this comment

dragotin commented Jan 24, 2017

ogoffart commented Jan 26, 2017

DeepDiver1975 commented Jan 26, 2017

DeepDiver1975 commented Jan 26, 2017

dragotin commented Jan 26, 2017

DeepDiver1975 commented Jan 26, 2017

guruz commented Mar 15, 2017

DeepDiver1975 commented Mar 15, 2017

guruz commented Mar 16, 2017

PVince81 Mar 22, 2017

Choose a reason for hiding this comment

DeepDiver1975 Mar 22, 2017

Choose a reason for hiding this comment

PVince81 Mar 22, 2017

Choose a reason for hiding this comment

DeepDiver1975 Mar 22, 2017

Choose a reason for hiding this comment

DeepDiver1975 Mar 22, 2017

Choose a reason for hiding this comment

PVince81 commented Mar 22, 2017

DeepDiver1975 left a comment

Choose a reason for hiding this comment

DeepDiver1975 Mar 22, 2017

Choose a reason for hiding this comment

individual-it commented Mar 23, 2017

DeepDiver1975 commented Mar 23, 2017

DeepDiver1975 commented Mar 23, 2017

DeepDiver1975 commented Mar 23, 2017

DeepDiver1975 commented Mar 23, 2017

PVince81 commented Mar 23, 2017

guruz commented Apr 3, 2017

lock bot commented Aug 3, 2019

DeepDiver1975 commented Dec 23, 2016 •

edited

Loading