webapp/bookstack
1
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2025-08-07 23:03:00 +03:00
Code Activity

Abstracted user avatar fetching away from gravatar

Browse Source 
Still uses gravatar as a default.
Updated URL placeholders to follow LDAP format.
Potential breaking config change: `GRAVATAR=false` replaced by `AVATAR_URL=false`
Builds upon #1111
This commit is contained in:
Dan Brown
2018-12-22 19:29:19 +00:00
parent d673bf61c2
commit b56fc21aaf
6 changed files with 55 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
app/Auth/UserRepo.php
View File

@@ -85,9 +85,7 @@ class UserRepo
{
$user = $this->create($data, $verifyEmail);
$this->attachDefaultRole($user);
// Get avatar from gravatar and save
$this->downloadGravatarToUserAvatar($user);
$this->downloadAndAssignUserAvatar($user);
return $user;
}
@@ -238,25 +236,24 @@ class UserRepo
}
/**
* Get a gravatar image for a user and set it as their avatar.
* Does not run if gravatar disabled in config.
* Get an avatar image for a user and set it as their avatar.
* Returns early if avatars disabled or not set in config.
* @param User $user
* @return bool
*/
public function downloadGravatarToUserAvatar(User $user)
public function downloadAndAssignUserAvatar(User $user)
{
// Get avatar from gravatar and save
if (!config('services.gravatar')) {
if (!Images::avatarFetchEnabled()) {
return false;
}
try {
$avatar = Images::saveUserGravatar($user, config('services.gravatar_url'));
$avatar = Images::saveUserAvatar($user);
$user->avatar()->associate($avatar);
$user->save();
return true;
} catch (Exception $e) {
\Log::error('Failed to save user gravatar image');
\Log::error('Failed to save user avatar image');
return false;
}
}

2
app/Console/Commands/CreateAdmin.php
View File

@@ -76,7 +76,7 @@ class CreateAdmin extends Command
$user = $this->userRepo->create(['email' => $email, 'name' => $name, 'password' => $password]);
$this->userRepo->attachSystemRole($user, 'admin');
$this->userRepo->downloadGravatarToUserAvatar($user);
$this->userRepo->downloadAndAssignUserAvatar($user);
$user->email_confirmed = true;
$user->save();

2
app/Http/Controllers/UserController.php
View File

@@ -92,7 +92,7 @@ class UserController extends Controller
$user->roles()->sync($roles);
}
$this->userRepo->downloadGravatarToUserAvatar($user);
$this->userRepo->downloadAndAssignUserAvatar($user);
return redirect('/settings/users');
}

45
app/Uploads/ImageService.php
View File

@@ -279,30 +279,51 @@ class ImageService extends UploadService
}
/**
* Save a gravatar image and set a the profile image for a user.
* Save an avatar image from an external service.
* @param \BookStack\Auth\User $user
* @param null|string $gravatarUrl
* @param int $size
* @return mixed
* @return Image
* @throws Exception
*/
public function saveUserGravatar(User $user, $gravatarUrl, $size = 500)
public function saveUserAvatar(User $user, $size = 500)
{
if (!is_string($gravatarUrl) || empty($gravatarUrl)) {
$gravatarUrl = 'https://www.gravatar.com/avatar/%{hash}?s=%{size}&d=identicon';
}
$avatarUrl = $this->getAvatarUrl();
$email = strtolower(trim($user->email));
$gravatarUrl = str_replace('%{hash}', md5($email), $gravatarUrl);
$gravatarUrl = str_replace('%{size}', $size, $gravatarUrl);
$gravatarUrl = str_replace('%{email}', urlencode($email), $gravatarUrl);
$imageName = str_replace(' ', '-', $user->name . '-gravatar.png');
$image = $this->saveNewFromUrl($gravatarUrl, 'user', $imageName);
$replacements = [
'${hash}' => md5($email),
'${size}' => $size,
'${email}' => urlencode($email),
];
$userAvatarUrl = strtr($avatarUrl, $replacements);
$imageName = str_replace(' ', '-', $user->name . '-avatar.png');
$image = $this->saveNewFromUrl($userAvatarUrl, 'user', $imageName);
$image->created_by = $user->id;
$image->updated_by = $user->id;
$image->save();
return $image;
}
/**
* Check if fetching external avatars is enabled.
* @return bool
*/
public function avatarFetchEnabled()
{
$fetchUrl = $this->getAvatarUrl();
return is_string($fetchUrl) && strpos($fetchUrl, 'http') === 0;
}
/**
* Get the URL to fetch avatars from.
* @return string|mixed
*/
protected function getAvatarUrl()
{
return trim(config('services.avatar_url'));
}
/**
* Delete gallery and drawings that are not within HTML content of pages or page revisions.