2013-07-26 10:20:11 +00:00
|
|
|
<?php
|
|
|
|
/**
|
2015-03-26 10:44:34 +00:00
|
|
|
* @author Arthur Schiwon <blizzz@owncloud.com>
|
|
|
|
* @author Christopher Schäpers <kondou@ts.unde.re>
|
2015-06-25 09:43:55 +00:00
|
|
|
* @author Lukas Reschke <lukas@owncloud.com>
|
2015-03-26 10:44:34 +00:00
|
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
|
|
|
* @author Robin Appelman <icewind@owncloud.com>
|
2015-10-26 12:54:55 +00:00
|
|
|
* @author Roeland Jago Douma <rullzer@owncloud.com>
|
2015-03-26 10:44:34 +00:00
|
|
|
* @author Thomas Müller <thomas.mueller@tmit.eu>
|
|
|
|
*
|
2016-01-12 14:02:16 +00:00
|
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
2015-03-26 10:44:34 +00:00
|
|
|
* @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/>
|
|
|
|
*
|
2013-07-26 10:20:11 +00:00
|
|
|
*/
|
2015-02-26 10:37:37 +00:00
|
|
|
|
2015-04-28 14:57:23 +00:00
|
|
|
namespace OC;
|
2015-03-03 11:52:27 +00:00
|
|
|
|
2016-01-22 10:34:49 +00:00
|
|
|
use OC\User\User;
|
2015-12-01 21:08:42 +00:00
|
|
|
use OCP\Files\Folder;
|
|
|
|
use OCP\Files\File;
|
2015-12-16 19:26:00 +00:00
|
|
|
use OCP\Files\NotFoundException;
|
2016-01-22 10:34:49 +00:00
|
|
|
use OCP\IAvatar;
|
|
|
|
use OCP\IImage;
|
2015-12-01 21:08:42 +00:00
|
|
|
use OCP\IL10N;
|
2015-04-28 14:57:23 +00:00
|
|
|
use OC_Image;
|
2015-03-03 11:52:27 +00:00
|
|
|
|
2015-02-26 10:37:37 +00:00
|
|
|
/**
|
|
|
|
* This class gets and sets users avatars.
|
|
|
|
*/
|
|
|
|
|
2016-01-22 10:34:49 +00:00
|
|
|
class Avatar implements IAvatar {
|
2015-12-01 21:08:42 +00:00
|
|
|
/** @var Folder */
|
|
|
|
private $folder;
|
|
|
|
/** @var IL10N */
|
|
|
|
private $l;
|
2016-01-22 10:34:49 +00:00
|
|
|
/** @var User */
|
|
|
|
private $user;
|
2013-09-09 14:57:46 +00:00
|
|
|
|
|
|
|
/**
|
2014-05-19 15:50:53 +00:00
|
|
|
* constructor
|
2015-12-01 21:08:42 +00:00
|
|
|
*
|
|
|
|
* @param Folder $folder The folder where the avatars are
|
|
|
|
* @param IL10N $l
|
2016-01-22 10:34:49 +00:00
|
|
|
* @param User $user
|
2015-04-28 14:57:23 +00:00
|
|
|
*/
|
2016-01-22 10:34:49 +00:00
|
|
|
public function __construct (Folder $folder, IL10N $l, $user) {
|
2015-12-01 21:08:42 +00:00
|
|
|
$this->folder = $folder;
|
|
|
|
$this->l = $l;
|
2016-01-22 10:34:49 +00:00
|
|
|
$this->user = $user;
|
2013-09-09 14:57:46 +00:00
|
|
|
}
|
|
|
|
|
2013-07-26 10:20:11 +00:00
|
|
|
/**
|
2016-01-25 12:24:56 +00:00
|
|
|
* @inheritdoc
|
|
|
|
*/
|
2013-09-09 14:57:46 +00:00
|
|
|
public function get ($size = 64) {
|
2015-12-16 19:26:00 +00:00
|
|
|
try {
|
|
|
|
$file = $this->getFile($size);
|
|
|
|
} catch (NotFoundException $e) {
|
2013-08-19 10:38:39 +00:00
|
|
|
return false;
|
2013-08-23 22:35:32 +00:00
|
|
|
}
|
2013-08-19 10:15:48 +00:00
|
|
|
|
2013-09-01 19:17:48 +00:00
|
|
|
$avatar = new OC_Image();
|
2015-12-16 19:26:00 +00:00
|
|
|
$avatar->loadFromData($file->getContent());
|
2013-08-19 10:38:39 +00:00
|
|
|
return $avatar;
|
|
|
|
}
|
2013-07-26 10:20:11 +00:00
|
|
|
|
2015-02-03 13:54:06 +00:00
|
|
|
/**
|
|
|
|
* Check if an avatar exists for the user
|
|
|
|
*
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function exists() {
|
2015-12-01 21:08:42 +00:00
|
|
|
return $this->folder->nodeExists('avatar.jpg') || $this->folder->nodeExists('avatar.png');
|
2015-02-03 13:54:06 +00:00
|
|
|
}
|
|
|
|
|
2013-07-26 10:20:11 +00:00
|
|
|
/**
|
2014-05-19 15:50:53 +00:00
|
|
|
* sets the users avatar
|
2016-01-22 10:34:49 +00:00
|
|
|
* @param IImage|resource|string $data An image object, imagedata or path to set a new avatar
|
2015-03-03 11:52:27 +00:00
|
|
|
* @throws \Exception if the provided file is not a jpg or png image
|
|
|
|
* @throws \Exception if the provided image is not valid
|
2016-01-22 10:34:49 +00:00
|
|
|
* @throws NotSquareException if the image is not square
|
2013-08-30 07:00:37 +00:00
|
|
|
* @return void
|
2013-07-26 10:20:11 +00:00
|
|
|
*/
|
2013-09-09 14:57:46 +00:00
|
|
|
public function set ($data) {
|
2015-06-15 15:54:48 +00:00
|
|
|
|
2016-01-22 10:34:49 +00:00
|
|
|
if($data instanceOf IImage) {
|
2013-11-22 22:57:23 +00:00
|
|
|
$img = $data;
|
|
|
|
$data = $img->data();
|
|
|
|
} else {
|
|
|
|
$img = new OC_Image($data);
|
|
|
|
}
|
2013-08-19 10:38:39 +00:00
|
|
|
$type = substr($img->mimeType(), -3);
|
2013-11-22 11:34:37 +00:00
|
|
|
if ($type === 'peg') {
|
|
|
|
$type = 'jpg';
|
|
|
|
}
|
2013-08-19 10:38:39 +00:00
|
|
|
if ($type !== 'jpg' && $type !== 'png') {
|
2015-12-01 21:08:42 +00:00
|
|
|
throw new \Exception($this->l->t("Unknown filetype"));
|
2013-08-19 10:38:39 +00:00
|
|
|
}
|
2013-07-29 09:34:38 +00:00
|
|
|
|
2013-08-23 22:35:32 +00:00
|
|
|
if (!$img->valid()) {
|
2015-12-01 21:08:42 +00:00
|
|
|
throw new \Exception($this->l->t("Invalid image"));
|
2013-08-23 22:35:32 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if (!($img->height() === $img->width())) {
|
2016-01-22 10:34:49 +00:00
|
|
|
throw new NotSquareException();
|
2013-07-29 09:34:38 +00:00
|
|
|
}
|
2013-08-19 10:38:39 +00:00
|
|
|
|
2015-12-01 21:08:42 +00:00
|
|
|
$this->remove();
|
|
|
|
$this->folder->newFile('avatar.'.$type)->putContent($data);
|
2016-02-09 16:44:49 +00:00
|
|
|
$this->user->triggerChange('avatar');
|
2013-07-29 09:34:38 +00:00
|
|
|
}
|
|
|
|
|
2013-07-26 10:20:11 +00:00
|
|
|
/**
|
2014-05-19 15:50:53 +00:00
|
|
|
* remove the users avatar
|
2013-08-19 10:38:39 +00:00
|
|
|
* @return void
|
2013-07-29 09:34:38 +00:00
|
|
|
*/
|
2013-09-09 14:57:46 +00:00
|
|
|
public function remove () {
|
2016-01-07 19:51:18 +00:00
|
|
|
$regex = '/^avatar\.([0-9]+\.)?(jpg|png)$/';
|
|
|
|
$avatars = $this->folder->search('avatar');
|
|
|
|
|
|
|
|
foreach ($avatars as $avatar) {
|
|
|
|
if (preg_match($regex, $avatar->getName())) {
|
|
|
|
$avatar->delete();
|
|
|
|
}
|
|
|
|
}
|
2016-02-09 16:44:49 +00:00
|
|
|
$this->user->triggerChange('avatar');
|
2013-07-26 10:20:11 +00:00
|
|
|
}
|
2015-12-16 19:26:00 +00:00
|
|
|
|
|
|
|
/**
|
2016-01-25 12:24:56 +00:00
|
|
|
* @inheritdoc
|
2015-12-16 19:26:00 +00:00
|
|
|
*/
|
|
|
|
public function getFile($size) {
|
2016-01-22 10:34:49 +00:00
|
|
|
$ext = $this->getExtension();
|
2015-12-16 19:26:00 +00:00
|
|
|
|
2016-01-25 12:24:56 +00:00
|
|
|
if ($size === -1) {
|
|
|
|
$path = 'avatar.' . $ext;
|
|
|
|
} else {
|
|
|
|
$path = 'avatar.' . $size . '.' . $ext;
|
|
|
|
}
|
2015-12-16 19:26:00 +00:00
|
|
|
|
|
|
|
try {
|
|
|
|
$file = $this->folder->get($path);
|
|
|
|
} catch (NotFoundException $e) {
|
|
|
|
if ($size <= 0) {
|
|
|
|
throw new NotFoundException;
|
|
|
|
}
|
|
|
|
|
|
|
|
$avatar = new OC_Image();
|
|
|
|
/** @var File $file */
|
|
|
|
$file = $this->folder->get('avatar.' . $ext);
|
|
|
|
$avatar->loadFromData($file->getContent());
|
2016-01-25 12:24:56 +00:00
|
|
|
if ($size !== -1) {
|
|
|
|
$avatar->resize($size);
|
|
|
|
}
|
2015-12-16 19:26:00 +00:00
|
|
|
$file = $this->folder->newFile($path);
|
|
|
|
$file->putContent($avatar->data());
|
|
|
|
}
|
|
|
|
|
|
|
|
return $file;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2016-01-22 10:34:49 +00:00
|
|
|
* Get the extension of the avatar. If there is no avatar throw Exception
|
2015-12-16 19:26:00 +00:00
|
|
|
*
|
|
|
|
* @return string
|
|
|
|
* @throws NotFoundException
|
|
|
|
*/
|
2016-01-22 10:34:49 +00:00
|
|
|
private function getExtension() {
|
2015-12-16 19:26:00 +00:00
|
|
|
if ($this->folder->nodeExists('avatar.jpg')) {
|
|
|
|
return 'jpg';
|
|
|
|
} elseif ($this->folder->nodeExists('avatar.png')) {
|
|
|
|
return 'png';
|
|
|
|
}
|
|
|
|
throw new NotFoundException;
|
|
|
|
}
|
2013-07-26 10:20:11 +00:00
|
|
|
}
|