From 1a0f9c375be12502d9b016c6bdb4c898ec765bbd Mon Sep 17 00:00:00 2001
From: Roeland Jago Douma <roeland@famdouma.nl>
Date: Tue, 3 Mar 2015 12:52:27 +0100
Subject: [PATCH] Avatar controller moved to AppFrameWork
* Original avatarcontroller migrated to the appframework
* Added DataDisplayResponse that show data inline in the browser (used
to retrun the image)
* Removed some unneeded code
* Added unit tests for the avatarcontroller
---
core/application.php | 23 ++
core/avatar/avatarcontroller.php | 261 +++++++++++++
core/avatar/controller.php | 164 --------
core/routes.php | 36 +-
core/templates/layout.user.php | 2 +-
lib/private/avatar.php | 10 +-
lib/private/avatarmanager.php | 5 +-
lib/private/helper.php | 2 +-
.../appframework/http/datadisplayresponse.php | 77 ++++
lib/public/iavatar.php | 2 +-
settings/templates/personal.php | 2 +-
tests/core/avatar/avatarcontrollertest.php | 360 ++++++++++++++++++
tests/lib/avatar.php | 5 +-
13 files changed, 752 insertions(+), 197 deletions(-)
create mode 100644 core/avatar/avatarcontroller.php
delete mode 100644 core/avatar/controller.php
create mode 100644 lib/public/appframework/http/datadisplayresponse.php
create mode 100644 tests/core/avatar/avatarcontrollertest.php
diff --git a/core/application.php b/core/application.php
index c36ab559c2..568fc34db7 100644
--- a/core/application.php
+++ b/core/application.php
@@ -14,6 +14,7 @@ use OC\AppFramework\Utility\SimpleContainer;
use \OCP\AppFramework\App;
use OC\Core\LostPassword\Controller\LostController;
use OC\Core\User\UserController;
+use OC\Core\Avatar\AvatarController;
use \OCP\Util;
/**
@@ -56,6 +57,17 @@ class Application extends App {
$c->query('Defaults')
);
});
+ $container->registerService('AvatarController', function(SimpleContainer $c) {
+ return new AvatarController(
+ $c->query('AppName'),
+ $c->query('Request'),
+ $c->query('AvatarManager'),
+ $c->query('Cache'),
+ $c->query('L10N'),
+ $c->query('UserManager'),
+ $c->query('UserSession')
+ );
+ });
/**
* Core class wrappers
@@ -78,6 +90,17 @@ class Application extends App {
$container->registerService('SecureRandom', function(SimpleContainer $c) {
return $c->query('ServerContainer')->getSecureRandom();
});
+ $container->registerService('AvatarManager', function(SimpleContainer $c) {
+ return $c->query('ServerContainer')->getAvatarManager();
+ });
+ $container->registerService('UserSession', function(SimpleContainer $c) {
+ return $c->query('ServerContainer')->getUserSession();
+ });
+ $container->registerService('Cache', function(SimpleContainer $c) {
+ return $c->query('ServerContainer')->getCache();
+ });
+
+
$container->registerService('Defaults', function() {
return new \OC_Defaults;
});
diff --git a/core/avatar/avatarcontroller.php b/core/avatar/avatarcontroller.php
new file mode 100644
index 0000000000..dd6e8fdc71
--- /dev/null
+++ b/core/avatar/avatarcontroller.php
@@ -0,0 +1,261 @@
+<?php
+/**
+ * @author Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @copyright Copyright (c) 2015, ownCloud, Inc.
+ * @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 OC\Core\Avatar;
+
+use OCP\AppFramework\Controller;
+use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\DataResponse;
+use OCP\AppFramework\Http\DataDisplayResponse;
+use OCP\IAvatarManager;
+use OCP\ICache;
+use OCP\IL10N;
+use OCP\IRequest;
+use OCP\IUserManager;
+use OCP\IUserSession;
+
+/**
+ * Class AvatarController
+ *
+ * @package OC\Core\Avatar
+ */
+class AvatarController extends Controller {
+
+ /** @var IAvatarManager */
+ protected $avatarManager;
+
+ /** @var ICache */
+ protected $cache;
+
+ /** @var IL10N */
+ protected $l;
+
+ /** @var IUserManager */
+ protected $userManager;
+
+ /** @var IUserSession */
+ protected $userSession;
+
+ /**
+ * @param string $appName
+ * @param IRequest $request
+ * @param IAvatarManager $avatarManager
+ * @param ICache $cache
+ * @param IL10N $l10n
+ * @param IUserManager $userManager
+ * @param IUserSession $userSession
+ */
+ public function __construct($appName,
+ IRequest $request,
+ IAvatarManager $avatarManager,
+ ICache $cache,
+ IL10N $l10n,
+ IUserManager $userManager,
+ IUserSession $userSession) {
+ parent::__construct($appName, $request);
+
+ $this->avatarManager = $avatarManager;
+ $this->cache = $cache;
+ $this->l = $l10n;
+ $this->userManager = $userManager;
+ $this->userSession = $userSession;
+ }
+
+ /**
+ * @NoAdminRequired
+ *
+ * @param string $userId
+ * @param int $size
+ * @return DataResponse|DataDisplayResponse
+ */
+ public function getAvatar($userId, $size) {
+ if ($size > 2048) {
+ $size = 2048;
+ } elseif ($size <= 0) {
+ $size = 64;
+ }
+
+ $avatar = $this->avatarManager->getAvatar($userId);
+ $image = $avatar->get($size);
+
+ if ($image instanceof \OC_Image) {
+ $resp = new DataDisplayResponse($image->data(),
+ Http::STATUS_OK,
+ ['Content-Type' => $image->mimeType()]);
+ $resp->setETag(crc32($image->data()));
+ } else {
+ $resp = new DataResponse(
+ ['data' => [
+ 'displayname' => $this->userManager->get($userId)->getDisplayName()
+ ]
+ ]);
+ }
+
+ $resp->addHeader('Pragma', 'public');
+ $resp->cacheFor(0);
+ $resp->setLastModified(new \DateTime('now', new \DateTimeZone('GMT')));
+
+ return $resp;
+ }
+
+ /**
+ * @NoAdminRequired
+ *
+ * @param string $path
+ * @return DataResponse
+ */
+ public function postAvatar($path) {
+ $userId = $this->userSession->getUser()->getUID();
+ $files = $this->request->getUploadedFile('files');
+
+ if (isset($path)) {
+ $path = stripslashes($path);
+ $view = new \OC\Files\View('/'.$userId.'/files');
+ $fileName = $view->getLocalFile($path);
+ } elseif (!is_null($files)) {
+ if (
+ $files['error'][0] === 0 &&
+ is_uploaded_file($files['tmp_name'][0]) &&
+ !\OC\Files\Filesystem::isFileBlacklisted($files['tmp_name'][0])
+ ) {
+ $this->cache->set('avatar_upload', file_get_contents($files['tmp_name'][0]), 7200);
+ $view = new \OC\Files\View('/'.$userId.'/cache');
+ $fileName = $view->getLocalFile('avatar_upload');
+ unlink($files['tmp_name'][0]);
+ } else {
+ return new DataResponse(['data' => ['message' => $this->l->t('Invalid file provided')]],
+ Http::STATUS_BAD_REQUEST);
+ }
+ } else {
+ //Add imgfile
+ return new DataResponse(['data' => ['message' => $this->l->t('No image or file provided')]],
+ Http::STATUS_BAD_REQUEST);
+ }
+
+ try {
+ $image = new \OC_Image();
+ $image->loadFromFile($fileName);
+ $image->fixOrientation();
+
+ if ($image->valid()) {
+ $mimeType = $image->mimeType();
+ if ($mimeType !== 'image/jpeg' && $mimeType !== 'image/png') {
+ return new DataResponse(['data' => ['message' => $this->l->t('Unknown filetype')]]);
+ }
+
+ $this->cache->set('tmpAvatar', $image->data(), 7200);
+ return new DataResponse(['data' => 'notsquare']);
+ } else {
+ return new DataResponse(['data' => ['message' => $this->l->t('Invalid image')]]);
+ }
+ } catch (\Exception $e) {
+ return new DataResponse(['data' => ['message' => $e->getMessage()]]);
+ }
+ }
+
+ /**
+ * @NoAdminRequired
+ *
+ * @return DataResponse
+ */
+ public function deleteAvatar() {
+ $userId = $this->userSession->getUser()->getUID();
+
+ try {
+ $avatar = $this->avatarManager->getAvatar($userId);
+ $avatar->remove();
+ return new DataResponse();
+ } catch (\Exception $e) {
+ return new DataResponse(['data' => ['message' => $e->getMessage()]], Http::STATUS_BAD_REQUEST);
+ }
+ }
+
+ /**
+ * @NoAdminRequired
+ *
+ * @return DataResponse|DataDisplayResponse
+ */
+ public function getTmpAvatar() {
+ $tmpAvatar = $this->cache->get('tmpAvatar');
+ if (is_null($tmpAvatar)) {
+ return new DataResponse(['data' => [
+ 'message' => $this->l->t("No temporary profile picture available, try again")
+ ]],
+ Http::STATUS_NOT_FOUND);
+ }
+
+ $image = new \OC_Image($tmpAvatar);
+
+ $resp = new DataDisplayResponse($image->data(),
+ Http::STATUS_OK,
+ ['Content-Type' => $image->mimeType(),
+ 'Pragma' => 'public']);
+
+ $resp->setETag(crc32($image->data()));
+ $resp->cacheFor(0);
+ $resp->setLastModified(new \DateTime('now', new \DateTimeZone('GMT')));
+ return $resp;
+ }
+
+ /**
+ * @NoAdminRequired
+ *
+ * @param array $crop
+ * @return DataResponse
+ */
+ public function postCroppedAvatar($crop) {
+ $userId = $this->userSession->getUser()->getUID();
+
+ if (is_null($crop)) {
+ return new DataResponse(['data' => ['message' => $this->l->t("No crop data provided")]],
+ Http::STATUS_BAD_REQUEST);
+ }
+
+ if (!isset($crop['x'], $crop['y'], $crop['w'], $crop['h'])) {
+ return new DataResponse(['data' => ['message' => $this->l->t("No valid crop data provided")]],
+ Http::STATUS_BAD_REQUEST);
+ }
+
+ $tmpAvatar = $this->cache->get('tmpAvatar');
+ if (is_null($tmpAvatar)) {
+ return new DataResponse(['data' => [
+ 'message' => $this->l->t("No temporary profile picture available, try again")
+ ]],
+ Http::STATUS_BAD_REQUEST);
+ }
+
+ $image = new \OC_Image($tmpAvatar);
+ $image->crop($crop['x'], $crop['y'], $crop['w'], $crop['h']);
+ try {
+ $avatar = $this->avatarManager->getAvatar($userId);
+ $avatar->set($image);
+ // Clean up
+ $this->cache->remove('tmpAvatar');
+ return new DataResponse(['status' => 'success']);
+ } catch (\OC\NotSquareException $e) {
+ return new DataResponse(['data' => ['message' => $this->l->t('Crop is not square')]],
+ Http::STATUS_BAD_REQUEST);
+
+ }catch (\Exception $e) {
+ return new DataResponse(['data' => ['message' => $e->getMessage()]],
+ Http::STATUS_BAD_REQUEST);
+ }
+ }
+}
diff --git a/core/avatar/controller.php b/core/avatar/controller.php
deleted file mode 100644
index ca055f5fd7..0000000000
--- a/core/avatar/controller.php
+++ /dev/null
@@ -1,164 +0,0 @@
-<?php
-/**
- * Copyright (c) 2013 Christopher Schäpers <christopher@schaepers.it>
- * This file is licensed under the Affero General Public License version 3 or
- * later.
- * See the COPYING-README file.
- */
-
-namespace OC\Core\Avatar;
-
-class Controller {
- public static function getAvatar($args) {
- \OC_JSON::checkLoggedIn();
- \OC_JSON::callCheck();
- \OC::$server->getSession()->close();
-
- $user = stripslashes($args['user']);
- $size = (int)$args['size'];
- if ($size > 2048) {
- $size = 2048;
- }
- // Undefined size
- elseif ($size === 0) {
- $size = 64;
- }
-
- $avatar = new \OC_Avatar($user);
- $image = $avatar->get($size);
-
- \OC_Response::disableCaching();
- \OC_Response::setLastModifiedHeader(time());
- if ($image instanceof \OC_Image) {
- \OC_Response::setETagHeader(crc32($image->data()));
- $image->show();
- } else {
- // Signalizes $.avatar() to display a defaultavatar
- \OC_JSON::success(array("data"=> array("displayname"=> \OC_User::getDisplayName($user)) ));
- }
- }
-
- public static function postAvatar($args) {
- \OC_JSON::checkLoggedIn();
- \OC_JSON::callCheck();
-
- $user = \OC_User::getUser();
-
- if (isset($_POST['path'])) {
- $path = stripslashes($_POST['path']);
- $view = new \OC\Files\View('/'.$user.'/files');
- $fileInfo = $view->getFileInfo($path);
- if($fileInfo['encrypted'] === true) {
- $fileName = $view->toTmpFile($path);
- } else {
- $fileName = $view->getLocalFile($path);
- }
- } elseif (!empty($_FILES)) {
- $files = $_FILES['files'];
- if (
- $files['error'][0] === 0 &&
- is_uploaded_file($files['tmp_name'][0]) &&
- !\OC\Files\Filesystem::isFileBlacklisted($files['tmp_name'][0])
- ) {
- \OC\Cache::set('avatar_upload', file_get_contents($files['tmp_name'][0]), 7200);
- $view = new \OC\Files\View('/'.$user.'/cache');
- $fileName = $view->getLocalFile('avatar_upload');
- unlink($files['tmp_name'][0]);
- }
- } else {
- $l = new \OC_L10n('core');
- \OC_JSON::error(array("data" => array("message" => $l->t("No image or file provided")) ));
- return;
- }
-
- try {
- $image = new \OC_Image();
- $image->loadFromFile($fileName);
- $image->fixOrientation();
-
- if ($image->valid()) {
- \OC\Cache::set('tmpavatar', $image->data(), 7200);
- \OC_JSON::error(array("data" => "notsquare"));
- } else {
- $l = new \OC_L10n('core');
-
- $mimeType = $image->mimeType();
- if ($mimeType !== 'image/jpeg' && $mimeType !== 'image/png') {
- \OC_JSON::error(array("data" => array("message" => $l->t("Unknown filetype")) ));
- }
-
- if (!$image->valid()) {
- \OC_JSON::error(array("data" => array("message" => $l->t("Invalid image")) ));
- }
- }
- } catch (\Exception $e) {
- \OC_JSON::error(array("data" => array("message" => $e->getMessage()) ));
- }
- }
-
- public static function deleteAvatar($args) {
- \OC_JSON::checkLoggedIn();
- \OC_JSON::callCheck();
-
- $user = \OC_User::getUser();
-
- try {
- $avatar = new \OC_Avatar($user);
- $avatar->remove();
- \OC_JSON::success();
- } catch (\Exception $e) {
- \OC_JSON::error(array("data" => array("message" => $e->getMessage()) ));
- }
- }
-
- public static function getTmpAvatar($args) {
- \OC_JSON::checkLoggedIn();
- \OC_JSON::callCheck();
-
- $tmpavatar = \OC\Cache::get('tmpavatar');
- if (is_null($tmpavatar)) {
- $l = new \OC_L10n('core');
- \OC_JSON::error(array("data" => array("message" => $l->t("No temporary profile picture available, try again")) ));
- return;
- }
-
- $image = new \OC_Image($tmpavatar);
- \OC_Response::disableCaching();
- \OC_Response::setLastModifiedHeader(time());
- \OC_Response::setETagHeader(crc32($image->data()));
- $image->show();
- }
-
- public static function postCroppedAvatar($args) {
- \OC_JSON::checkLoggedIn();
- \OC_JSON::callCheck();
-
- $user = \OC_User::getUser();
- if (isset($_POST['crop'])) {
- $crop = $_POST['crop'];
- } else {
- $l = new \OC_L10n('core');
- \OC_JSON::error(array("data" => array("message" => $l->t("No crop data provided")) ));
- return;
- }
-
- $tmpavatar = \OC\Cache::get('tmpavatar');
- if (is_null($tmpavatar)) {
- $l = new \OC_L10n('core');
- \OC_JSON::error(array("data" => array("message" => $l->t("No temporary profile picture available, try again")) ));
- return;
- }
-
- $image = new \OC_Image($tmpavatar);
- $image->crop($crop['x'], $crop['y'], $crop['w'], $crop['h']);
- try {
- $avatar = new \OC_Avatar($user);
- $avatar->set($image->data());
- // Clean up
- \OC\Cache::remove('tmpavatar');
- \OC_JSON::success();
- } catch (\Exception $e) {
- \OC_JSON::error(array("data" => array("message" => $e->getMessage()) ));
- }
- }
-}
diff --git a/core/routes.php b/core/routes.php
index defbb695a7..afa2768e60 100644
--- a/core/routes.php
+++ b/core/routes.php
@@ -9,13 +9,19 @@
use OC\Core\Application;
$application = new Application();
-$application->registerRoutes($this, array('routes' => array(
- array('name' => 'lost#email', 'url' => '/lostpassword/email', 'verb' => 'POST'),
- array('name' => 'lost#resetform', 'url' => '/lostpassword/reset/form/{token}/{userId}', 'verb' => 'GET'),
- array('name' => 'lost#setPassword', 'url' => '/lostpassword/set/{token}/{userId}', 'verb' => 'POST'),
- array('name' => 'user#getDisplayNames', 'url' => '/displaynames', 'verb' => 'POST'),
- )
-));
+$application->registerRoutes($this, [
+ 'routes' => [
+ ['name' => 'lost#email', 'url' => '/lostpassword/email', 'verb' => 'POST'],
+ ['name' => 'lost#resetform', 'url' => '/lostpassword/reset/form/{token}/{userId}', 'verb' => 'GET'],
+ ['name' => 'lost#setPassword', 'url' => '/lostpassword/set/{token}/{userId}', 'verb' => 'POST'],
+ ['name' => 'user#getDisplayNames', 'url' => '/displaynames', 'verb' => 'POST'],
+ ['name' => 'avatar#getAvatar', 'url' => '/avatar/{userId}/{size}', 'verb' => 'GET'],
+ ['name' => 'avatar#deleteAvatar', 'url' => '/avatar/', 'verb' => 'DELETE'],
+ ['name' => 'avatar#postCroppedAvatar', 'url' => '/avatar/cropped', 'verb' => 'POST'],
+ ['name' => 'avatar#getTmpAvatar', 'url' => '/avatar/tmp', 'verb' => 'GET'],
+ ['name' => 'avatar#postAvatar', 'url' => '/avatar/', 'verb' => 'POST'],
+ ]
+]);
// Post installation check
@@ -77,22 +83,6 @@ $this->create('core_ajax_preview', '/core/preview.png')
->actionInclude('core/ajax/preview.php');
$this->create('core_ajax_update', '/core/ajax/update.php')
->actionInclude('core/ajax/update.php');
-// Avatar routes
-$this->create('core_avatar_get_tmp', '/avatar/tmp')
- ->get()
- ->action('OC\Core\Avatar\Controller', 'getTmpAvatar');
-$this->create('core_avatar_get', '/avatar/{user}/{size}')
- ->get()
- ->action('OC\Core\Avatar\Controller', 'getAvatar');
-$this->create('core_avatar_post', '/avatar/')
- ->post()
- ->action('OC\Core\Avatar\Controller', 'postAvatar');
-$this->create('core_avatar_delete', '/avatar/')
- ->delete()
- ->action('OC\Core\Avatar\Controller', 'deleteAvatar');
-$this->create('core_avatar_post_cropped', '/avatar/cropped')
- ->post()
- ->action('OC\Core\Avatar\Controller', 'postCroppedAvatar');
// Sharing routes
$this->create('files_sharing.sharecontroller.showShare', '/s/{token}')->action(function($urlParams) {
diff --git a/core/templates/layout.user.php b/core/templates/layout.user.php
index f7c81140d1..7ae4b2e3df 100644
--- a/core/templates/layout.user.php
+++ b/core/templates/layout.user.php
@@ -68,7 +68,7 @@
<?php if ($_['enableAvatars']): ?>
<div class="avatardiv<?php if ($_['userAvatarSet']) { print_unescaped(' avatardiv-shown"'); } else { print_unescaped('" style="display: none"'); } ?>>
<?php if ($_['userAvatarSet']): ?>
- <img src="<?php p(\OC::$server->getURLGenerator()->linkToRoute('core_avatar_get', ['user' => $_['user_uid'], 'size' => 32]));?>?requesttoken=<?php p(urlencode($_['requesttoken'])); ?>"
+ <img src="<?php p(\OC::$server->getURLGenerator()->linkToRoute('core.avatar.getAvatar', ['userId' => $_['user_uid'], 'size' => 32]));?>?requesttoken=<?php p(urlencode($_['requesttoken'])); ?>"
alt="" />
<?php endif; ?>
</div>
diff --git a/lib/private/avatar.php b/lib/private/avatar.php
index 5e234d77bb..23b3c82771 100644
--- a/lib/private/avatar.php
+++ b/lib/private/avatar.php
@@ -6,11 +6,15 @@
* See the COPYING-README file.
*/
+ namespace OC;
+
+ use OC_Image;
+
/**
* This class gets and sets users avatars.
*/
-class OC_Avatar implements \OCP\IAvatar {
+class Avatar implements \OCP\IAvatar {
private $view;
@@ -54,8 +58,8 @@ class OC_Avatar implements \OCP\IAvatar {
/**
* sets the users avatar
* @param \OC_Image|resource|string $data OC_Image, imagedata or path to set a new avatar
- * @throws Exception if the provided file is not a jpg or png image
- * @throws Exception if the provided image is not valid
+ * @throws \Exception if the provided file is not a jpg or png image
+ * @throws \Exception if the provided image is not valid
* @throws \OC\NotSquareException if the image is not square
* @return void
*/
diff --git a/lib/private/avatarmanager.php b/lib/private/avatarmanager.php
index 6abe87c4f4..8dc20a5240 100644
--- a/lib/private/avatarmanager.php
+++ b/lib/private/avatarmanager.php
@@ -8,8 +8,9 @@
namespace OC;
use OCP\IAvatarManager;
+use OC\Avatar;
-/*
+/**
* This class implements methods to access Avatar functionality
*/
class AvatarManager implements IAvatarManager {
@@ -21,6 +22,6 @@ class AvatarManager implements IAvatarManager {
* @return \OCP\IAvatar
*/
function getAvatar($user) {
- return new \OC_Avatar($user);
+ return new Avatar($user);
}
}
diff --git a/lib/private/helper.php b/lib/private/helper.php
index fb7049854b..ebc30395a6 100644
--- a/lib/private/helper.php
+++ b/lib/private/helper.php
@@ -288,7 +288,7 @@ class OC_Helper {
* @return bool avatar set or not
**/
public static function userAvatarSet($user) {
- $avatar = new \OC_Avatar($user);
+ $avatar = new \OC\Avatar($user);
return $avatar->exists();
}
diff --git a/lib/public/appframework/http/datadisplayresponse.php b/lib/public/appframework/http/datadisplayresponse.php
new file mode 100644
index 0000000000..ebb77950c9
--- /dev/null
+++ b/lib/public/appframework/http/datadisplayresponse.php
@@ -0,0 +1,77 @@
+<?php
+/**
+ * @author Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @copyright Copyright (c) 2015, ownCloud, Inc.
+ * @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 OCP\AppFramework\Http;
+
+use OCP\AppFramework\Http;
+
+class DataDisplayResponse extends Response {
+
+ /**
+ * response data
+ * @var string;
+ */
+ protected $data;
+
+
+ /**
+ * @param string $data the data to display
+ * @param int $statusCode the Http status code, defaults to 200
+ * @param array $headers additional key value based headers
+ */
+ public function __construct($data="", $statusCode=Http::STATUS_OK,
+ $headers=[]) {
+ $this->data = $data;
+ $this->setStatus($statusCode);
+ $this->setHeaders(array_merge($this->getHeaders(), $headers));
+ $this->addHeader('Content-Disposition', 'inline; filename=""');
+ }
+
+ /**
+ * Outputs data. No processing is done.
+ * @return string
+ */
+ public function render() {
+ return $this->data;
+ }
+
+
+ /**
+ * Sets values in the data
+ * @param string $data the data to display
+ * @return DataDisplayResponse Reference to this object
+ */
+ public function setData($data){
+ $this->data = $data;
+
+ return $this;
+ }
+
+
+ /**
+ * Used to get the set parameters
+ * @return string the data
+ */
+ public function getData(){
+ return $this->data;
+ }
+
+}
diff --git a/lib/public/iavatar.php b/lib/public/iavatar.php
index fdb044f9e5..8f432c23fb 100644
--- a/lib/public/iavatar.php
+++ b/lib/public/iavatar.php
@@ -29,7 +29,7 @@ interface IAvatar {
/**
* sets the users avatar
- * @param Image $data mixed imagedata or path to set a new avatar
+ * @param \OC_Image|resource|string $data OC_Image, imagedata or path to set a new avatar
* @throws \Exception if the provided file is not a jpg or png image
* @throws \Exception if the provided image is not valid
* @throws \OC\NotSquareException if the image is not square
diff --git a/settings/templates/personal.php b/settings/templates/personal.php
index 5c737f8441..cb153447b9 100644
--- a/settings/templates/personal.php
+++ b/settings/templates/personal.php
@@ -146,7 +146,7 @@ if($_['passwordChangeSupported']) {
</div>
<?php if ($_['enableAvatars']): ?>
-<form id="avatar" class="section" method="post" action="<?php p(\OC_Helper::linkToRoute('core_avatar_post')); ?>">
+<form id="avatar" class="section" method="post" action="<?php p(\OC_Helper::linkToRoute('core.avatar.postAvatar')); ?>">
<h2><?php p($l->t('Profile picture')); ?></h2>
<div id="displayavatar">
<div class="avatardiv"></div><br>
diff --git a/tests/core/avatar/avatarcontrollertest.php b/tests/core/avatar/avatarcontrollertest.php
new file mode 100644
index 0000000000..1cd621b070
--- /dev/null
+++ b/tests/core/avatar/avatarcontrollertest.php
@@ -0,0 +1,360 @@
+<?php
+/**
+ * @author Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @copyright Copyright (c) 2015, ownCloud, Inc.
+ * @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 OC\Core\Avatar;
+
+use OC;
+use OC\Core\Application;
+use OCP\AppFramework\IAppContainer;
+use OCP\Security\ISecureRandom;
+use OC\Files\Filesystem;
+use OCP\AppFramework\Http;
+use OCP\Image;
+
+/**
+ * Overwrite is_uploaded_file in this namespace to allow proper unit testing of
+ * the postAvatar call.
+ */
+function is_uploaded_file($filename) {
+ return file_exists($filename);
+}
+
+/**
+ * Class AvatarControllerTest
+ *
+ * @package OC\Core\Avatar
+ */
+class AvatarControllerTest extends \Test\TestCase {
+
+ /** @var IAppContainer */
+ private $container;
+ /** @var string */
+ private $user;
+ /** @var string */
+ private $oldUser;
+ /** @var AvatarController */
+ private $avatarController;
+
+ private $avatarMock;
+
+ private $userMock;
+
+ protected function setUp() {
+ $app = new Application;
+ $this->container = $app->getContainer();
+ $this->container['AppName'] = 'core';
+ $this->container['AvatarManager'] = $this->getMockBuilder('OCP\IAvatarManager')
+ ->disableOriginalConstructor()->getMock();
+ $this->container['Cache'] = $this->getMockBuilder('OCP\ICache')
+ ->disableOriginalConstructor()->getMock();
+ $this->container['L10N'] = $this->getMockBuilder('OCP\IL10N')
+ ->disableOriginalConstructor()->getMock();
+ $this->container['L10N']->method('t')->will($this->returnArgument(0));
+ $this->container['UserManager'] = $this->getMockBuilder('OCP\IUserManager')
+ ->disableOriginalConstructor()->getMock();
+ $this->container['UserSession'] = $this->getMockBuilder('OCP\IUserSession')
+ ->disableOriginalConstructor()->getMock();
+ $this->container['Request'] = $this->getMockBuilder('OCP\IRequest')
+ ->disableOriginalConstructor()->getMock();
+
+
+ $this->avatarMock = $this->getMockBuilder('OCP\IAvatar')
+ ->disableOriginalConstructor()->getMock();
+ $this->userMock = $this->getMockBuilder('OCP\IUser')
+ ->disableOriginalConstructor()->getMock();
+
+ $this->avatarController = $this->container['AvatarController'];
+
+ // Store current User
+ $this->oldUser = \OC_User::getUser();
+
+ // Create a dummy user
+ $this->user = \OC::$server->getSecureRandom()->getLowStrengthGenerator()->generate(12, ISecureRandom::CHAR_LOWER);
+
+ OC::$server->getUserManager()->createUser($this->user, $this->user);
+ \OC_Util::tearDownFS();
+ \OC_User::setUserId('');
+ Filesystem::tearDown();
+ \OC_User::setUserId($this->user);
+ \OC_Util::setupFS($this->user);
+
+ // Configure userMock
+ $this->userMock->method('getDisplayName')->willReturn($this->user);
+ $this->userMock->method('getUID')->willReturn($this->user);
+ $this->container['UserManager']->method('get')->willReturn($this->userMock);
+ $this->container['UserSession']->method('getUser')->willReturn($this->userMock);
+
+ }
+
+ public function tearDown() {
+ \OC_Util::tearDownFS();
+ \OC_User::setUserId('');
+ Filesystem::tearDown();
+ OC::$server->getUserManager()->get($this->user)->delete();
+ \OC_User::setIncognitoMode(false);
+
+ \OC::$server->getSession()->set('public_link_authenticated', '');
+
+ // Set old user
+ \OC_User::setUserId($this->oldUser);
+ \OC_Util::setupFS($this->oldUser);
+ }
+
+ /**
+ * Fetch an avatar if a user has no avatar
+ */
+ public function testGetAvatarNoAvatar() {
+ $this->container['AvatarManager']->method('getAvatar')->willReturn($this->avatarMock);
+ $response = $this->avatarController->getAvatar($this->user, 32);
+
+ //Comment out unitl JS is fixed
+ //$this->assertEquals($response->getStatus(), Http::STATUS_NOT_FOUND);
+ $this->assertEquals($response->getData()['data']['displayname'], $this->user);
+ }
+
+ /**
+ * Fetch the users avatar
+ */
+ public function testGetAvatar() {
+ $image = new Image(OC::$SERVERROOT.'/tests/data/testimage.jpg');
+ $this->avatarMock->method('get')->willReturn($image);
+ $this->container['AvatarManager']->method('getAvatar')->willReturn($this->avatarMock);
+
+ $response = $this->avatarController->getAvatar($this->user, 32);
+
+ $this->assertEquals($response->getStatus(), Http::STATUS_OK);
+
+ $image2 = new Image($response->getData());
+ $this->assertEquals($image->mimeType(), $image2->mimeType());
+ $this->assertEquals(crc32($response->getData()), $response->getEtag());
+ }
+
+ /**
+ * Make sure we get the correct size
+ */
+ public function testGetAvatarSize() {
+ $this->avatarMock->expects($this->once())
+ ->method('get')
+ ->with($this->equalTo(32));
+
+ $this->container['AvatarManager']->method('getAvatar')->willReturn($this->avatarMock);
+
+ $this->avatarController->getAvatar($this->user, 32);
+ }
+
+ /**
+ * We cannot get avatars that are 0 or negative
+ */
+ public function testGetAvatarSizeMin() {
+ $this->avatarMock->expects($this->once())
+ ->method('get')
+ ->with($this->equalTo(64));
+
+ $this->container['AvatarManager']->method('getAvatar')->willReturn($this->avatarMock);
+
+ $this->avatarController->getAvatar($this->user, 0);
+ }
+
+ /**
+ * We do not support avatars larger than 2048*2048
+ */
+ public function testGetAvatarSizeMax() {
+ $this->avatarMock->expects($this->once())
+ ->method('get')
+ ->with($this->equalTo(2048));
+
+ $this->container['AvatarManager']->method('getAvatar')->willReturn($this->avatarMock);
+
+ $this->avatarController->getAvatar($this->user, 2049);
+ }
+
+ /**
+ * Remove an avatar
+ */
+ public function testDeleteAvatar() {
+ $this->container['AvatarManager']->method('getAvatar')->willReturn($this->avatarMock);
+
+ $response = $this->avatarController->deleteAvatar();
+ $this->assertEquals($response->getStatus(), Http::STATUS_OK);
+ }
+
+ /**
+ * Test what happens if the removing of the avatar fails
+ */
+ public function testDeleteAvatarException() {
+ $this->avatarMock->method('remove')->will($this->throwException(new \Exception("foo")));
+ $this->container['AvatarManager']->method('getAvatar')->willReturn($this->avatarMock);
+
+ $response = $this->avatarController->deleteAvatar();
+ $this->assertEquals($response->getStatus(), Http::STATUS_BAD_REQUEST);
+ }
+
+ /**
+ * Trying to get a tmp avatar when it is not available. 404
+ */
+ public function testTmpAvatarNoTmp() {
+ $response = $this->avatarController->getTmpAvatar();
+ $this->assertEquals($response->getStatus(), Http::STATUS_NOT_FOUND);
+ }
+
+ /**
+ * Fetch tmp avatar
+ */
+ public function testTmpAvatarValid() {
+ $this->container['Cache']->method('get')->willReturn(file_get_contents(OC::$SERVERROOT.'/tests/data/testimage.jpg'));
+
+ $response = $this->avatarController->getTmpAvatar();
+ $this->assertEquals($response->getStatus(), Http::STATUS_OK);
+ }
+
+
+ /**
+ * When trying to post a new avatar a path or image should be posted.
+ */
+ public function testPostAvatarNoPathOrImage() {
+ $response = $this->avatarController->postAvatar(null);
+
+ $this->assertEquals($response->getStatus(), Http::STATUS_BAD_REQUEST);
+ }
+
+ /**
+ * Test a correct post of an avatar using POST
+ */
+ public function testPostAvatarFile() {
+ //Create temp file
+ $fileName = tempnam(null, "avatarTest");
+ $copyRes = copy(OC::$SERVERROOT.'/tests/data/testimage.jpg', $fileName);
+ $this->assertTrue($copyRes);
+
+ //Create file in cache
+ $view = new \OC\Files\View('/'.$this->user.'/cache');
+ $view->file_put_contents('avatar_upload', file_get_contents(OC::$SERVERROOT.'/tests/data/testimage.jpg'));
+
+ //Create request return
+ $reqRet = ['error' => [0], 'tmp_name' => [$fileName]];
+ $this->container['Request']->method('getUploadedFile')->willReturn($reqRet);
+
+ $response = $this->avatarController->postAvatar(null);
+
+ //On correct upload always respond with the notsquare message
+ $this->assertEquals($response->getData()['data'], 'notsquare');
+
+ //File should be deleted
+ $this->assertFalse(file_exists($fileName));
+ }
+
+ /**
+ * Test invalid post os an avatar using POST
+ */
+ public function testPostAvatarInvalidFile() {
+ //Create request return
+ $reqRet = ['error' => [1], 'tmp_name' => ['foo']];
+ $this->container['Request']->method('getUploadedFile')->willReturn($reqRet);
+
+ $response = $this->avatarController->postAvatar(null);
+
+ $this->assertEquals($response->getStatus(), Http::STATUS_BAD_REQUEST);
+ }
+
+ /**
+ * Check what happens when we upload a GIF
+ * TODO: Finish
+ */
+ public function testPostAvatarFileGif() {
+ //Create temp file
+ $fileName = tempnam(null, "avatarTest");
+ $copyRes = copy(OC::$SERVERROOT.'/tests/data/testimage.gif', $fileName);
+ $this->assertTrue($copyRes);
+
+ //Create file in cache
+ $view = new \OC\Files\View('/'.$this->user.'/cache');
+ $view->file_put_contents('avatar_upload', file_get_contents(OC::$SERVERROOT.'/tests/data/testimage.gif'));
+
+ //Create request return
+ $reqRet = ['error' => [0], 'tmp_name' => [$fileName]];
+ $this->container['Request']->method('getUploadedFile')->willReturn($reqRet);
+
+ $response = $this->avatarController->postAvatar(null);
+
+ $this->assertEquals($response->getData()['data']['message'], 'Unknown filetype');
+
+ //File should be deleted
+ $this->assertFalse(file_exists($fileName));
+ }
+
+ /**
+ * Test posting avatar from existing file
+ */
+ public function testPostAvatarFromFile() {
+ //Create file in cache
+ $view = new \OC\Files\View('/'.$this->user.'/files');
+ $view->file_put_contents('avatar.jpg', file_get_contents(OC::$SERVERROOT.'/tests/data/testimage.jpg'));
+
+ //Create request return
+ $response = $this->avatarController->postAvatar('avatar.jpg');
+
+ //On correct upload always respond with the notsquare message
+ $this->assertEquals($response->getData()['data'], 'notsquare');
+ }
+
+ /**
+ * Test invalid crop argment
+ */
+ public function testPostCroppedAvatarInvalidCrop() {
+ $response = $this->avatarController->postCroppedAvatar([]);
+
+ $this->assertEquals($response->getStatus(), Http::STATUS_BAD_REQUEST);
+ }
+
+ /**
+ * Test no tmp avatar to crop
+ */
+ public function testPostCroppedAvatarNoTmpAvatar() {
+ $response = $this->avatarController->postCroppedAvatar(['x' => 0, 'y' => 0, 'w' => 10, 'h' => 10]);
+
+ $this->assertEquals($response->getStatus(), Http::STATUS_BAD_REQUEST);
+ }
+
+ /**
+ * Test with non square crop
+ */
+ public function testPostCroppedAvatarNoSquareCrop() {
+ $this->container['Cache']->method('get')->willReturn(file_get_contents(OC::$SERVERROOT.'/tests/data/testimage.jpg'));
+
+ $this->avatarMock->method('set')->will($this->throwException(new \OC\NotSquareException));
+ $this->container['AvatarManager']->method('getAvatar')->willReturn($this->avatarMock);
+ $response = $this->avatarController->postCroppedAvatar(['x' => 0, 'y' => 0, 'w' => 10, 'h' => 11]);
+
+ $this->assertEquals($response->getStatus(), Http::STATUS_BAD_REQUEST);
+ }
+
+ /**
+ * Check for proper reply on proper crop argument
+ */
+ public function testPostCroppedAvatarValidCrop() {
+ $this->container['Cache']->method('get')->willReturn(file_get_contents(OC::$SERVERROOT.'/tests/data/testimage.jpg'));
+ $this->container['AvatarManager']->method('getAvatar')->willReturn($this->avatarMock);
+ $response = $this->avatarController->postCroppedAvatar(['x' => 0, 'y' => 0, 'w' => 10, 'h' => 10]);
+
+ $this->assertEquals($response->getStatus(), Http::STATUS_OK);
+ $this->assertEquals($response->getData()['status'], 'success');
+ }
+
+}
diff --git a/tests/lib/avatar.php b/tests/lib/avatar.php
index 421be155d1..e852a7fc6f 100644
--- a/tests/lib/avatar.php
+++ b/tests/lib/avatar.php
@@ -6,6 +6,9 @@
* later.
* See the COPYING-README file.
*/
+
+use OC\Avatar;
+
class Test_Avatar extends \Test\TestCase {
private $user;
@@ -20,7 +23,7 @@ class Test_Avatar extends \Test\TestCase {
public function testAvatar() {
- $avatar = new \OC_Avatar($this->user);
+ $avatar = new Avatar($this->user);
$this->assertEquals(false, $avatar->get());
--
GitLab