Merge branch 'custom-avatar-provider' of git://github.com/Vinrobot/BookStack into Vinrobot-custom-avatar-provider

ssddanbrown · ssddanbrown · commit d673bf61c221 · 2018-12-22T18:18:14.000Z
diff --git a/.env.example b/.env.example
@@ -62,6 +62,11 @@ DISCORD_APP_SECRET=false
 
 # External services such as Gravatar and Draw.IO
 DISABLE_EXTERNAL_SERVICES=false
+# Default GRAVATAR_URL set to Gravatar service
+GRAVATAR_URL=false
+# To use a different service to get user's avatar like libravatar
+# Possible placeholders: %{hash} %{size} %{email}
+#GRAVATAR_URL=https://seccdn.libravatar.org/avatar/%{hash}?s=%{size}&d=identicon
 
 # LDAP Settings
 LDAP_SERVER=false
diff --git a/app/Auth/UserRepo.php b/app/Auth/UserRepo.php
@@ -251,7 +251,7 @@ public function downloadGravatarToUserAvatar(User $user)
         }
 
         try {
-            $avatar = Images::saveUserGravatar($user);
+            $avatar = Images::saveUserGravatar($user, config('services.gravatar_url'));
             $user->avatar()->associate($avatar);
             $user->save();
             return true;
diff --git a/app/Uploads/ImageService.php b/app/Uploads/ImageService.php
@@ -281,16 +281,22 @@ protected function destroyImagesFromPath(string $path)
     /**
      * Save a gravatar image and set a the profile image for a user.
      * @param \BookStack\Auth\User $user
+     * @param null|string $gravatarUrl
      * @param int $size
      * @return mixed
      * @throws Exception
      */
-    public function saveUserGravatar(User $user, $size = 500)
+    public function saveUserGravatar(User $user, $gravatarUrl, $size = 500)
     {
-        $emailHash = md5(strtolower(trim($user->email)));
-        $url = 'https://www.gravatar.com/avatar/' . $emailHash . '?s=' . $size . '&d=identicon';
+        if (!is_string($gravatarUrl) || empty($gravatarUrl)) {
+            $gravatarUrl = 'https://www.gravatar.com/avatar/%{hash}?s=%{size}&d=identicon';
+        }
+        $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($url, 'user', $imageName);
+        $image = $this->saveNewFromUrl($gravatarUrl, 'user', $imageName);
         $image->created_by = $user->id;
         $image->updated_by = $user->id;
         $image->save();
diff --git a/config/services.php b/config/services.php
@@ -19,6 +19,7 @@
     'gravatar' => env('GRAVATAR', !env('DISABLE_EXTERNAL_SERVICES', false)),
     'drawio' => env('DRAWIO', !env('DISABLE_EXTERNAL_SERVICES', false)),
 
+    'gravatar_url' => env('GRAVATAR_URL', false),
 
     'callback_url' => env('APP_URL', false),
 

Original file line number	Diff line number	Diff line change
`@@ -251,7 +251,7 @@ public function downloadGravatarToUserAvatar(User $user)`
`251`	`251`	`}`
`252`	`252`
`253`	`253`	`try {`
`254`		`- $avatar = Images::saveUserGravatar($user);`
	`254`	`+ $avatar = Images::saveUserGravatar($user, config('services.gravatar_url'));`
`255`	`255`	`$user->avatar()->associate($avatar);`
`256`	`256`	`$user->save();`
`257`	`257`	`return true;`