aboutsummaryrefslogtreecommitdiffstats
path: root/lib/private/Avatar/Avatar.php
diff options
context:
space:
mode:
authorMichael Weimann <mail@michael-weimann.eu>2019-01-20 11:13:41 +0100
committerMorris Jobke <hey@morrisjobke.de>2019-02-07 14:23:16 +0100
commitbf1253cb49a4931244a6bbde4dfa44bf084f4377 (patch)
tree6faacd5110c029778ed56554e27a5d73c4e888db /lib/private/Avatar/Avatar.php
parentb69b17f29fd518495a6495e0f90f60c70ef0fc73 (diff)
downloadnextcloud-server-bf1253cb49a4931244a6bbde4dfa44bf084f4377.tar.gz
nextcloud-server-bf1253cb49a4931244a6bbde4dfa44bf084f4377.zip
Implement guest avatar endpoint
Signed-off-by: Michael Weimann <mail@michael-weimann.eu>
Diffstat (limited to 'lib/private/Avatar/Avatar.php')
-rw-r--r--lib/private/Avatar/Avatar.php318
1 files changed, 318 insertions, 0 deletions
diff --git a/lib/private/Avatar/Avatar.php b/lib/private/Avatar/Avatar.php
new file mode 100644
index 00000000000..4468af82053
--- /dev/null
+++ b/lib/private/Avatar/Avatar.php
@@ -0,0 +1,318 @@
+<?php
+declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @copyright 2018 John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
+ * @author Christopher Schäpers <kondou@ts.unde.re>
+ * @author Lukas Reschke <lukas@statuscode.ch>
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @author Olivier Mehani <shtrom@ssji.net>
+ * @author Robin Appelman <robin@icewind.nl>
+ * @author Roeland Jago Douma <roeland@famdouma.nl>
+ * @author Thomas Müller <thomas.mueller@tmit.eu>
+ * @author John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @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\Avatar;
+
+use OC\Color;
+use OCP\Files\NotFoundException;
+use OCP\IAvatar;
+use OCP\ILogger;
+use OC_Image;
+use Imagick;
+
+/**
+ * This class gets and sets users avatars.
+ */
+abstract class Avatar implements IAvatar {
+
+ /** @var ILogger */
+ protected $logger;
+
+ /**
+ * https://github.com/sebdesign/cap-height -- for 500px height
+ * Automated check: https://codepen.io/skjnldsv/pen/PydLBK/
+ * Nunito cap-height is 0.716 and we want a 200px caps height size
+ * (0.4 letter-to-total-height ratio, 500*0.4=200), so: 200/0.716 = 279px.
+ * Since we start from the baseline (text-anchor) we need to
+ * shift the y axis by 100px (half the caps height): 500/2+100=350
+ *
+ * @var string
+ */
+ private $svgTemplate = '<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+ <svg width="{size}" height="{size}" version="1.1" viewBox="0 0 500 500" xmlns="http://www.w3.org/2000/svg">
+ <rect width="100%" height="100%" fill="#{fill}"></rect>
+ <text x="50%" y="350" style="font-weight:normal;font-size:279px;font-family:\'Nunito\';text-anchor:middle;fill:#fff">{letter}</text>
+ </svg>';
+
+ /**
+ * The base avatar constructor.
+ *
+ * @param ILogger $logger The logger
+ */
+ public function __construct(ILogger $logger) {
+ $this->logger = $logger;
+ }
+
+ /**
+ * Returns the user display name.
+ *
+ * @return string
+ */
+ abstract public function getDisplayName(): string;
+
+ /**
+ * Returns the first letter of the display name, or "?" if no name given.
+ *
+ * @return string
+ */
+ private function getAvatarLetter(): string {
+ $displayName = $this->getDisplayName();
+ if (empty($displayName) === true) {
+ return '?';
+ } else {
+ return mb_strtoupper(mb_substr($displayName, 0, 1), 'UTF-8');
+ }
+ }
+
+ /**
+ * @inheritdoc
+ */
+ public function get($size = 64) {
+ $size = (int) $size;
+
+ try {
+ $file = $this->getFile($size);
+ } catch (NotFoundException $e) {
+ return false;
+ }
+
+ $avatar = new OC_Image();
+ $avatar->loadFromData($file->getContent());
+ return $avatar;
+ }
+
+ /**
+ * {size} = 500
+ * {fill} = hex color to fill
+ * {letter} = Letter to display
+ *
+ * Generate SVG avatar
+ *
+ * @param int $size The requested image size in pixel
+ * @return string
+ *
+ */
+ 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 = $this->getAvatarLetter();
+ $toReplace = ['{size}', '{fill}', '{letter}'];
+ return str_replace($toReplace, [$size, $bgHEX, $letter], $this->svgTemplate);
+ }
+
+ /**
+ * Generate png avatar from svg with Imagick
+ *
+ * @param int $size
+ * @return string|boolean
+ */
+ protected function generateAvatarFromSvg(int $size) {
+ if (!extension_loaded('imagick')) {
+ return false;
+ }
+ try {
+ $font = __DIR__ . '/../../core/fonts/Nunito-Regular.ttf';
+ $svg = $this->getAvatarVector($size);
+ $avatar = new Imagick();
+ $avatar->setFont($font);
+ $avatar->readImageBlob($svg);
+ $avatar->setImageFormat('png');
+ $image = new OC_Image();
+ $image->loadFromData($avatar);
+ return $image->data();
+ } catch (\Exception $e) {
+ return false;
+ }
+ }
+
+ /**
+ * Generate png avatar with GD
+ *
+ * @param string $userDisplayName
+ * @param int $size
+ * @return string
+ */
+ 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
+ );
+ $white = imagecolorallocate($im, 255, 255, 255);
+ imagefilledrectangle($im, 0, 0, $size, $size, $background);
+
+ $font = __DIR__ . '/../../../core/fonts/Nunito-Regular.ttf';
+
+ $fontSize = $size * 0.4;
+ list($x, $y) = $this->imageTTFCenter(
+ $im, $letter, $font, (int)$fontSize
+ );
+
+ imagettftext($im, $fontSize, 0, $x, $y, $white, $font, $letter);
+
+ ob_start();
+ imagepng($im);
+ $data = ob_get_contents();
+ ob_end_clean();
+
+ return $data;
+ }
+
+ /**
+ * Calculate real image ttf center
+ *
+ * @param resource $image
+ * @param string $text text string
+ * @param string $font font path
+ * @param int $size font size
+ * @param int $angle
+ * @return array
+ */
+ protected function imageTTFCenter(
+ $image,
+ string $text,
+ string $font,
+ int $size,
+ $angle = 0
+ ): array {
+ // Image width & height
+ $xi = imagesx($image);
+ $yi = imagesy($image);
+
+ // bounding box
+ $box = imagettfbbox($size, $angle, $font, $text);
+
+ // imagettfbbox can return negative int
+ $xr = abs(max($box[2], $box[4]));
+ $yr = abs(max($box[5], $box[7]));
+
+ // calculate bottom left placement
+ $x = intval(($xi - $xr) / 2);
+ $y = intval(($yi + $yr) / 2);
+
+ return array($x, $y);
+ }
+
+ /**
+ * Calculate steps between two Colors
+ * @param object Color $steps start color
+ * @param object Color $ends end color
+ * @return array [r,g,b] steps for each color to go from $steps to $ends
+ */
+ private function stepCalc($steps, $ends) {
+ $step = array();
+ $step[0] = ($ends[1]->r - $ends[0]->r) / $steps;
+ $step[1] = ($ends[1]->g - $ends[0]->g) / $steps;
+ $step[2] = ($ends[1]->b - $ends[0]->b) / $steps;
+ return $step;
+ }
+
+ /**
+ * 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
+ */
+ private function mixPalette($steps, $color1, $color2) {
+ $palette = array($color1);
+ $step = $this->stepCalc($steps, [$color1, $color2]);
+ for ($i = 1; $i < $steps; $i++) {
+ $r = intval($color1->r + ($step[0] * $i));
+ $g = intval($color1->g + ($step[1] * $i));
+ $b = intval($color1->b + ($step[2] * $i));
+ $palette[] = new Color($r, $g, $b);
+ }
+ return $palette;
+ }
+
+ /**
+ * 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
+ */
+ private function hashToInt($hash, $maximum) {
+ $final = 0;
+ $result = array();
+
+ // Splitting evenly the string
+ for ($i = 0; $i < strlen($hash); $i++) {
+ // chars in md5 goes up to f, hex:16
+ $result[] = intval(substr($hash, $i, 1), 16) % 16;
+ }
+ // Adds up all results
+ foreach ($result as $value) {
+ $final += $value;
+ }
+ // chars in md5 goes up to f, hex:16
+ return intval($final % $maximum);
+ }
+
+ /**
+ * @param string $hash
+ * @return Color Object containting r g b int in the range [0, 255]
+ */
+ public function avatarBackgroundColor(string $hash) {
+ // Normalize hash
+ $hash = strtolower($hash);
+
+ // Already a md5 hash?
+ if( preg_match('/^([0-9a-f]{4}-?){8}$/', $hash, $matches) !== 1 ) {
+ $hash = md5($hash);
+ }
+
+ // Remove unwanted char
+ $hash = preg_replace('/[^0-9a-f]+/', '', $hash);
+
+ $red = new Color(182, 70, 157);
+ $yellow = new Color(221, 203, 85);
+ $blue = new Color(0, 130, 201); // Nextcloud blue
+
+ // Number of steps to go from a color to another
+ // 3 colors * 6 will result in 18 generated colors
+ $steps = 6;
+
+ $palette1 = $this->mixPalette($steps, $red, $yellow);
+ $palette2 = $this->mixPalette($steps, $yellow, $blue);
+ $palette3 = $this->mixPalette($steps, $blue, $red);
+
+ $finalPalette = array_merge($palette1, $palette2, $palette3);
+
+ return $finalPalette[$this->hashToInt($hash, $steps * 3)];
+ }
+}