|
@@ -1,4 +1,5 @@
|
|
|
<?php
|
|
|
+declare(strict_types=1);
|
|
|
/**
|
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
|
|
* @copyright 2018 John Molakvoæ <skjnldsv@protonmail.com>
|
|
@@ -29,36 +30,22 @@
|
|
|
*
|
|
|
*/
|
|
|
|
|
|
-namespace OC;
|
|
|
+namespace OC\Avatar;
|
|
|
|
|
|
+use OC\Color;
|
|
|
use OCP\Files\NotFoundException;
|
|
|
-use OCP\Files\NotPermittedException;
|
|
|
-use OCP\Files\SimpleFS\ISimpleFile;
|
|
|
-use OCP\Files\SimpleFS\ISimpleFolder;
|
|
|
use OCP\IAvatar;
|
|
|
-use OCP\IConfig;
|
|
|
-use OCP\IImage;
|
|
|
-use OCP\IL10N;
|
|
|
use OCP\ILogger;
|
|
|
-use OC\User\User;
|
|
|
use OC_Image;
|
|
|
use Imagick;
|
|
|
|
|
|
/**
|
|
|
* This class gets and sets users avatars.
|
|
|
*/
|
|
|
+abstract class Avatar implements IAvatar {
|
|
|
|
|
|
-class Avatar implements IAvatar {
|
|
|
- /** @var ISimpleFolder */
|
|
|
- private $folder;
|
|
|
- /** @var IL10N */
|
|
|
- private $l;
|
|
|
- /** @var User */
|
|
|
- private $user;
|
|
|
/** @var ILogger */
|
|
|
- private $logger;
|
|
|
- /** @var IConfig */
|
|
|
- private $config;
|
|
|
+ protected $logger;
|
|
|
|
|
|
/**
|
|
|
* https://github.com/sebdesign/cap-height -- for 500px height
|
|
@@ -77,216 +64,50 @@ class Avatar implements IAvatar {
|
|
|
</svg>';
|
|
|
|
|
|
/**
|
|
|
- * constructor
|
|
|
+ * The base avatar constructor.
|
|
|
*
|
|
|
- * @param ISimpleFolder $folder The folder where the avatars are
|
|
|
- * @param IL10N $l
|
|
|
- * @param User $user
|
|
|
- * @param ILogger $logger
|
|
|
- * @param IConfig $config
|
|
|
+ * @param ILogger $logger The logger
|
|
|
*/
|
|
|
- public function __construct(ISimpleFolder $folder,
|
|
|
- IL10N $l,
|
|
|
- $user,
|
|
|
- ILogger $logger,
|
|
|
- IConfig $config) {
|
|
|
- $this->folder = $folder;
|
|
|
- $this->l = $l;
|
|
|
- $this->user = $user;
|
|
|
+ public function __construct(ILogger $logger) {
|
|
|
$this->logger = $logger;
|
|
|
- $this->config = $config;
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- * @inheritdoc
|
|
|
- */
|
|
|
- public function get($size = 64) {
|
|
|
- try {
|
|
|
- $file = $this->getFile($size);
|
|
|
- } catch (NotFoundException $e) {
|
|
|
- return false;
|
|
|
- }
|
|
|
-
|
|
|
- $avatar = new OC_Image();
|
|
|
- $avatar->loadFromData($file->getContent());
|
|
|
- return $avatar;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Check if an avatar exists for the user
|
|
|
+ * Returns the user display name.
|
|
|
*
|
|
|
- * @return bool
|
|
|
+ * @return string
|
|
|
*/
|
|
|
- public function exists() {
|
|
|
-
|
|
|
- return $this->folder->fileExists('avatar.jpg') || $this->folder->fileExists('avatar.png');
|
|
|
- }
|
|
|
+ abstract public function getDisplayName(): string;
|
|
|
|
|
|
/**
|
|
|
- * Check if the avatar of a user is a custom uploaded one
|
|
|
+ * Returns the first letter of the display name, or "?" if no name given.
|
|
|
*
|
|
|
- * @return bool
|
|
|
- */
|
|
|
- public function isCustomAvatar(): bool {
|
|
|
- return $this->config->getUserValue($this->user->getUID(), 'avatar', 'generated', 'false') !== 'true';
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * sets the users avatar
|
|
|
- * @param IImage|resource|string $data An image object, 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 NotSquareException if the image is not square
|
|
|
- * @return void
|
|
|
+ * @return string
|
|
|
*/
|
|
|
- public function set($data) {
|
|
|
-
|
|
|
- if ($data instanceof IImage) {
|
|
|
- $img = $data;
|
|
|
- $data = $img->data();
|
|
|
+ private function getAvatarLetter(): string {
|
|
|
+ $displayName = $this->getDisplayName();
|
|
|
+ if (empty($displayName) === true) {
|
|
|
+ return '?';
|
|
|
} else {
|
|
|
- $img = new OC_Image();
|
|
|
- if (is_resource($data) && get_resource_type($data) === "gd") {
|
|
|
- $img->setResource($data);
|
|
|
- } elseif (is_resource($data)) {
|
|
|
- $img->loadFromFileHandle($data);
|
|
|
- } else {
|
|
|
- try {
|
|
|
- // detect if it is a path or maybe the images as string
|
|
|
- $result = @realpath($data);
|
|
|
- if ($result === false || $result === null) {
|
|
|
- $img->loadFromData($data);
|
|
|
- } else {
|
|
|
- $img->loadFromFile($data);
|
|
|
- }
|
|
|
- } catch (\Error $e) {
|
|
|
- $img->loadFromData($data);
|
|
|
- }
|
|
|
- }
|
|
|
- }
|
|
|
- $type = substr($img->mimeType(), -3);
|
|
|
- if ($type === 'peg') {
|
|
|
- $type = 'jpg';
|
|
|
- }
|
|
|
- if ($type !== 'jpg' && $type !== 'png') {
|
|
|
- throw new \Exception($this->l->t('Unknown filetype'));
|
|
|
- }
|
|
|
-
|
|
|
- if (!$img->valid()) {
|
|
|
- throw new \Exception($this->l->t('Invalid image'));
|
|
|
- }
|
|
|
-
|
|
|
- if (!($img->height() === $img->width())) {
|
|
|
- throw new NotSquareException($this->l->t('Avatar image is not square'));
|
|
|
- }
|
|
|
-
|
|
|
- $this->remove();
|
|
|
- $file = $this->folder->newFile('avatar.' . $type);
|
|
|
- $file->putContent($data);
|
|
|
-
|
|
|
- try {
|
|
|
- $generated = $this->folder->getFile('generated');
|
|
|
- $this->config->setUserValue($this->user->getUID(), 'avatar', 'generated', 'false');
|
|
|
- $generated->delete();
|
|
|
- } catch (NotFoundException $e) {
|
|
|
- //
|
|
|
- }
|
|
|
- $this->user->triggerChange('avatar', $file);
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * remove the users avatar
|
|
|
- * @return void
|
|
|
- */
|
|
|
- public function remove() {
|
|
|
- $avatars = $this->folder->getDirectoryListing();
|
|
|
-
|
|
|
- $this->config->setUserValue($this->user->getUID(), 'avatar', 'version',
|
|
|
- (int) $this->config->getUserValue($this->user->getUID(), 'avatar', 'version', 0) + 1);
|
|
|
-
|
|
|
- foreach ($avatars as $avatar) {
|
|
|
- $avatar->delete();
|
|
|
+ return mb_strtoupper(mb_substr($displayName, 0, 1), 'UTF-8');
|
|
|
}
|
|
|
- $this->config->setUserValue($this->user->getUID(), 'avatar', 'generated', 'true');
|
|
|
- $this->user->triggerChange('avatar', '');
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
* @inheritdoc
|
|
|
*/
|
|
|
- public function getFile($size) {
|
|
|
- try {
|
|
|
- $ext = $this->getExtension();
|
|
|
- } catch (NotFoundException $e) {
|
|
|
- if (!$data = $this->generateAvatarFromSvg(1024)) {
|
|
|
- $data = $this->generateAvatar($this->user->getDisplayName(), 1024);
|
|
|
- }
|
|
|
- $avatar = $this->folder->newFile('avatar.png');
|
|
|
- $avatar->putContent($data);
|
|
|
- $ext = 'png';
|
|
|
-
|
|
|
- $this->folder->newFile('generated');
|
|
|
- $this->config->setUserValue($this->user->getUID(), 'avatar', 'generated', 'true');
|
|
|
- }
|
|
|
-
|
|
|
- if ($size === -1) {
|
|
|
- $path = 'avatar.' . $ext;
|
|
|
- } else {
|
|
|
- $path = 'avatar.' . $size . '.' . $ext;
|
|
|
- }
|
|
|
+ public function get($size = 64) {
|
|
|
+ $size = (int) $size;
|
|
|
|
|
|
try {
|
|
|
- $file = $this->folder->getFile($path);
|
|
|
+ $file = $this->getFile($size);
|
|
|
} catch (NotFoundException $e) {
|
|
|
- if ($size <= 0) {
|
|
|
- throw new NotFoundException;
|
|
|
- }
|
|
|
-
|
|
|
- if ($this->folder->fileExists('generated')) {
|
|
|
- if (!$data = $this->generateAvatarFromSvg($size)) {
|
|
|
- $data = $this->generateAvatar($this->user->getDisplayName(), $size);
|
|
|
- }
|
|
|
-
|
|
|
- } else {
|
|
|
- $avatar = new OC_Image();
|
|
|
- /** @var ISimpleFile $file */
|
|
|
- $file = $this->folder->getFile('avatar.' . $ext);
|
|
|
- $avatar->loadFromData($file->getContent());
|
|
|
- $avatar->resize($size);
|
|
|
- $data = $avatar->data();
|
|
|
- }
|
|
|
-
|
|
|
- try {
|
|
|
- $file = $this->folder->newFile($path);
|
|
|
- $file->putContent($data);
|
|
|
- } catch (NotPermittedException $e) {
|
|
|
- $this->logger->error('Failed to save avatar for ' . $this->user->getUID());
|
|
|
- throw new NotFoundException();
|
|
|
- }
|
|
|
-
|
|
|
- }
|
|
|
-
|
|
|
- if ($this->config->getUserValue($this->user->getUID(), 'avatar', 'generated', null) === null) {
|
|
|
- $generated = $this->folder->fileExists('generated') ? 'true' : 'false';
|
|
|
- $this->config->setUserValue($this->user->getUID(), 'avatar', 'generated', $generated);
|
|
|
+ return false;
|
|
|
}
|
|
|
|
|
|
- return $file;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Get the extension of the avatar. If there is no avatar throw Exception
|
|
|
- *
|
|
|
- * @return string
|
|
|
- * @throws NotFoundException
|
|
|
- */
|
|
|
- private function getExtension() {
|
|
|
- if ($this->folder->fileExists('avatar.jpg')) {
|
|
|
- return 'jpg';
|
|
|
- } elseif ($this->folder->fileExists('avatar.png')) {
|
|
|
- return 'png';
|
|
|
- }
|
|
|
- throw new NotFoundException;
|
|
|
+ $avatar = new OC_Image();
|
|
|
+ $avatar->loadFromData($file->getContent());
|
|
|
+ return $avatar;
|
|
|
}
|
|
|
|
|
|
/**
|
|
@@ -295,16 +116,16 @@ class Avatar implements IAvatar {
|
|
|
* {letter} = Letter to display
|
|
|
*
|
|
|
* Generate SVG avatar
|
|
|
+ *
|
|
|
+ * @param int $size The requested image size in pixel
|
|
|
* @return string
|
|
|
*
|
|
|
*/
|
|
|
- private function getAvatarVector(int $size): string {
|
|
|
- $userDisplayName = $this->user->getDisplayName();
|
|
|
-
|
|
|
+ protected function getAvatarVector(int $size): string {
|
|
|
+ $userDisplayName = $this->getDisplayName();
|
|
|
$bgRGB = $this->avatarBackgroundColor($userDisplayName);
|
|
|
$bgHEX = sprintf("%02x%02x%02x", $bgRGB->r, $bgRGB->g, $bgRGB->b);
|
|
|
- $letter = mb_strtoupper(mb_substr($userDisplayName, 0, 1), 'UTF-8');
|
|
|
-
|
|
|
+ $letter = $this->getAvatarLetter();
|
|
|
$toReplace = ['{size}', '{fill}', '{letter}'];
|
|
|
return str_replace($toReplace, [$size, $bgHEX, $letter], $this->svgTemplate);
|
|
|
}
|
|
@@ -315,7 +136,7 @@ class Avatar implements IAvatar {
|
|
|
* @param int $size
|
|
|
* @return string|boolean
|
|
|
*/
|
|
|
- private function generateAvatarFromSvg(int $size) {
|
|
|
+ protected function generateAvatarFromSvg(int $size) {
|
|
|
if (!extension_loaded('imagick')) {
|
|
|
return false;
|
|
|
}
|
|
@@ -341,22 +162,28 @@ class Avatar implements IAvatar {
|
|
|
* @param int $size
|
|
|
* @return string
|
|
|
*/
|
|
|
- private function generateAvatar($userDisplayName, $size) {
|
|
|
- $text = mb_strtoupper(mb_substr($userDisplayName, 0, 1), 'UTF-8');
|
|
|
+ protected function generateAvatar($userDisplayName, $size) {
|
|
|
+ $letter = $this->getAvatarLetter();
|
|
|
$backgroundColor = $this->avatarBackgroundColor($userDisplayName);
|
|
|
|
|
|
$im = imagecreatetruecolor($size, $size);
|
|
|
- $background = imagecolorallocate($im, $backgroundColor->r, $backgroundColor->g, $backgroundColor->b);
|
|
|
+ $background = imagecolorallocate(
|
|
|
+ $im,
|
|
|
+ $backgroundColor->r,
|
|
|
+ $backgroundColor->g,
|
|
|
+ $backgroundColor->b
|
|
|
+ );
|
|
|
$white = imagecolorallocate($im, 255, 255, 255);
|
|
|
imagefilledrectangle($im, 0, 0, $size, $size, $background);
|
|
|
|
|
|
- $font = __DIR__ . '/../../core/fonts/Nunito-Regular.ttf';
|
|
|
+ $font = __DIR__ . '/../../../core/fonts/Nunito-Regular.ttf';
|
|
|
|
|
|
$fontSize = $size * 0.4;
|
|
|
+ list($x, $y) = $this->imageTTFCenter(
|
|
|
+ $im, $letter, $font, (int)$fontSize
|
|
|
+ );
|
|
|
|
|
|
- list($x, $y) = $this->imageTTFCenter($im, $text, $font, $fontSize);
|
|
|
-
|
|
|
- imagettftext($im, $fontSize, 0, $x, $y, $white, $font, $text);
|
|
|
+ imagettftext($im, $fontSize, 0, $x, $y, $white, $font, $letter);
|
|
|
|
|
|
ob_start();
|
|
|
imagepng($im);
|
|
@@ -376,7 +203,13 @@ class Avatar implements IAvatar {
|
|
|
* @param int $angle
|
|
|
* @return array
|
|
|
*/
|
|
|
- protected function imageTTFCenter($image, string $text, string $font, int $size, $angle = 0): array {
|
|
|
+ protected function imageTTFCenter(
|
|
|
+ $image,
|
|
|
+ string $text,
|
|
|
+ string $font,
|
|
|
+ int $size,
|
|
|
+ $angle = 0
|
|
|
+ ): array {
|
|
|
// Image width & height
|
|
|
$xi = imagesx($image);
|
|
|
$yi = imagesy($image);
|
|
@@ -413,10 +246,9 @@ class Avatar implements IAvatar {
|
|
|
* Convert a string to an integer evenly
|
|
|
* @param string $hash the text to parse
|
|
|
* @param int $maximum the maximum range
|
|
|
- * @return int between 0 and $maximum
|
|
|
+ * @return int[] between 0 and $maximum
|
|
|
*/
|
|
|
private function mixPalette($steps, $color1, $color2) {
|
|
|
- $count = $steps + 1;
|
|
|
$palette = array($color1);
|
|
|
$step = $this->stepCalc($steps, [$color1, $color2]);
|
|
|
for ($i = 1; $i < $steps; $i++) {
|
|
@@ -483,19 +315,4 @@ class Avatar implements IAvatar {
|
|
|
|
|
|
return $finalPalette[$this->hashToInt($hash, $steps * 3)];
|
|
|
}
|
|
|
-
|
|
|
- public function userChanged($feature, $oldValue, $newValue) {
|
|
|
- // We only change the avatar on display name changes
|
|
|
- if ($feature !== 'displayName') {
|
|
|
- return;
|
|
|
- }
|
|
|
-
|
|
|
- // If the avatar is not generated (so an uploaded image) we skip this
|
|
|
- if (!$this->folder->fileExists('generated')) {
|
|
|
- return;
|
|
|
- }
|
|
|
-
|
|
|
- $this->remove();
|
|
|
- }
|
|
|
-
|
|
|
}
|