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

2 files changed, 261 insertions, 164 deletions

diff --git a/core/avatar/avatarcontroller.php b/core/avatar/avatarcontroller.php
new file mode 100644
index 00000000000..dd6e8fdc71d
--- /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 ca055f5fd75..00000000000
--- 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()) ));
-		}
-	}
-}