Skip to content

Commit

Permalink
Merge pull request #26872 from owncloud/dav-avatars
Browse files Browse the repository at this point in the history
Adding dav resource for avatars
  • Loading branch information
Vincent Petry authored Mar 23, 2017
2 parents 82ee84e + 0fd7746 commit 7115494
Show file tree
Hide file tree
Showing 8 changed files with 425 additions and 3 deletions.
119 changes: 119 additions & 0 deletions apps/dav/lib/Avatars/AvatarHome.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
<?php
/**
* @author Thomas Müller <thomas.mueller@tmit.eu>
*
* @copyright Copyright (c) 2016, ownCloud GmbH
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/


namespace OCA\DAV\Avatars;


use OCP\IAvatarManager;
use Sabre\DAV\Exception\Forbidden;
use Sabre\DAV\Exception\MethodNotAllowed;
use Sabre\DAV\Exception\NotFound;
use Sabre\DAV\ICollection;
use Sabre\HTTP\URLUtil;

class AvatarHome implements ICollection {

/** @var array */
private $principalInfo;
/** @var IAvatarManager */
private $avatarManager;

/**
* AvatarHome constructor.
*
* @param array $principalInfo
*/
public function __construct($principalInfo, IAvatarManager $avatarManager) {
$this->principalInfo = $principalInfo;
$this->avatarManager = $avatarManager;
}

function createFile($name, $data = null) {
throw new Forbidden('Permission denied to create a file');
}

function createDirectory($name) {
throw new Forbidden('Permission denied to create a folder');
}

function getChild($name) {
$elements = pathinfo($name);
$ext = isset($elements['extension']) ? $elements['extension'] : '';
$size = intval(isset($elements['filename']) ? $elements['filename'] : '64');
if (!in_array($ext, ['jpeg', 'png'])) {
throw new MethodNotAllowed('File format not allowed');
}
if ($size <= 0 || $size > 1024) {
throw new MethodNotAllowed('Invalid image size');
}
$avatar = $this->avatarManager->getAvatar($this->getName());
if ($avatar === null || !$avatar->exists()) {
throw new NotFound();
}
return new AvatarNode($size, $ext, $avatar);
}

function getChildren() {
try {
return [
$this->getChild('96.jpeg')
];
} catch(NotFound $exception) {
return [];
}
}

function childExists($name) {
try {
$ret = $this->getChild($name);
return !is_null($ret);
} catch (NotFound $ex) {
return false;
} catch (MethodNotAllowed $ex) {
return false;
}
}

function delete() {
throw new Forbidden('Permission denied to delete this folder');
}

function getName() {
list(,$name) = URLUtil::splitPath($this->principalInfo['uri']);
return $name;
}

function setName($name) {
throw new Forbidden('Permission denied to rename this folder');
}

/**
* Returns the last modification time, as a unix timestamp
*
* @return int
*/
function getLastModified() {
return null;
}


}
97 changes: 97 additions & 0 deletions apps/dav/lib/Avatars/AvatarNode.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
<?php
/**
* @author Thomas Müller <thomas.mueller@tmit.eu>
*
* @copyright Copyright (c) 2016, ownCloud GmbH
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/


namespace OCA\DAV\Avatars;


use OCP\IAvatar;
use Sabre\DAV\File;

class AvatarNode extends File {
private $ext;
private $size;
private $avatar;

/**
* AvatarNode constructor.
*
* @param integer $size
* @param string $ext
* @param IAvatar $avatar
*/
public function __construct($size, $ext, $avatar) {
$this->size = $size;
$this->ext = $ext;
$this->avatar = $avatar;
}

/**
* Returns the name of the node.
*
* This is used to generate the url.
*
* @return string
*/
function getName() {
return "$this->size.$this->ext";
}

function get() {
$image = $this->avatar->get($this->size);
$res = $image->resource();

ob_start();
if ($this->ext === 'png') {
imagepng($res);
}
imagejpeg($res);

return ob_get_clean();
}

/**
* Returns the mime-type for a file
*
* If null is returned, we'll assume application/octet-stream
*
* @return string|null
*/
function getContentType() {
if ($this->ext === 'png') {
return 'image/png';
}
return 'image/jpeg';
}

function getETag() {
return $this->avatar->getFile($this->size)->getEtag();
}

function getLastModified() {
$timestamp = $this->avatar->getFile($this->size)->getMTime();
if (!empty($timestamp)) {
return (int)$timestamp;
}
return $timestamp;

}
}
29 changes: 29 additions & 0 deletions apps/dav/lib/Avatars/RootCollection.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<?php

namespace OCA\DAV\Avatars;

use Sabre\DAVACL\AbstractPrincipalCollection;
use Sabre\DAVACL\IPrincipal;

class RootCollection extends AbstractPrincipalCollection {

/**
* This method returns a node for a principal.
*
* The passed array contains principal information, and is guaranteed to
* at least contain a uri item. Other properties may or may not be
* supplied by the authentication backend.
*
* @param array $principalInfo
* @return AvatarHome
*/
function getChildForPrincipal(array $principalInfo) {
$avatarManager = \OC::$server->getAvatarManager();
return new AvatarHome($principalInfo, $avatarManager);
}

function getName() {
return 'avatars';
}

}
2 changes: 1 addition & 1 deletion apps/dav/lib/Connector/Sabre/Principal.php
Original file line number Diff line number Diff line change
Expand Up @@ -222,8 +222,8 @@ protected function userToPrincipal($user) {
$email = $user->getEMailAddress();
if (!empty($email)) {
$principal['{http://sabredav.org/ns}email-address'] = $email;
return $principal;
}

return $principal;
}

Expand Down
4 changes: 4 additions & 0 deletions apps/dav/lib/RootCollection.php
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,9 @@ public function __construct() {
$uploadCollection = new Upload\RootCollection($userPrincipalBackend, 'principals/users');
$uploadCollection->disableListing = $disableListing;

$avatarCollection = new Avatars\RootCollection($userPrincipalBackend, 'principals/users');
$avatarCollection->disableListing = $disableListing;

$children = [
new SimpleCollection('principals', [
$userPrincipals,
Expand All @@ -103,6 +106,7 @@ public function __construct() {
$systemTagCollection,
$systemTagRelationsCollection,
$uploadCollection,
$avatarCollection
];

parent::__construct('root', $children);
Expand Down
Loading

0 comments on commit 7115494

Please sign in to comment.