From c6c365abf09403f5d6a88f78f943b68022d2dcd6 Mon Sep 17 00:00:00 2001
From: John Livingston <git@john-livingston.fr>
Date: Thu, 25 Jul 2024 15:34:27 +0200
Subject: [PATCH] Avatar set for anonymous users: new 'none' choice (that will
 fallback to Converse new colorized avatars).

---
 CHANGELOG.md                       |  1 +
 languages/en.yml                   |  1 +
 server/lib/external-auth/oidc.ts   | 12 ++++++------
 server/lib/prosody/config.ts       | 27 +++++++++++++++++++--------
 server/lib/prosody/config/paths.ts |  4 ++--
 server/lib/settings.ts             |  5 +++--
 6 files changed, 32 insertions(+), 18 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index c07af460..31697e68 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -8,6 +8,7 @@
 
 ### Minor changes and fixes
 
+* Avatar set for anonymous users: new 'none' choice (that will fallback to Converse new colorized avatars).
 * New translation: Albanian.
 * Translation updates: Crotian, Japanese.
 
diff --git a/languages/en.yml b/languages/en.yml
index 35c2d624..caa4808a 100644
--- a/languages/en.yml
+++ b/languages/en.yml
@@ -181,6 +181,7 @@ avatar_set_option_fenec: "Fenecs (Mobilizon mascot)"
 avatar_set_option_abstract: Abstract
 avatar_set_option_legacy: "Legacy Sepia avatars (those included in previous plugin
   versions)"
+avatar_set_option_none: None
 
 converse_theme_label: "ConverseJS theme"
 converse_theme_description: "Please choose the converseJS theme you want to use."
diff --git a/server/lib/external-auth/oidc.ts b/server/lib/external-auth/oidc.ts
index a694d00e..b2780450 100644
--- a/server/lib/external-auth/oidc.ts
+++ b/server/lib/external-auth/oidc.ts
@@ -87,8 +87,8 @@ class ExternalAuthOIDC {
   private readonly redirectUrl: string
   private readonly connectUrl: string
   private readonly externalVirtualhost: string
-  private readonly avatarsDir: string
-  private readonly avatarsFiles: string[]
+  private readonly avatarsDir: string | undefined
+  private readonly avatarsFiles: string[] | undefined
 
   private readonly encryptionOptions = {
     algorithm: 'aes256' as string,
@@ -129,8 +129,8 @@ class ExternalAuthOIDC {
     connectUrl: string
     redirectUrl: string
     externalVirtualhost: string
-    avatarsDir: string
-    avatarsFiles: string[]
+    avatarsDir?: string
+    avatarsFiles?: string[]
   }) {
     this.logger = {
       debug: (s) => params.logger.debug('[ExternalAuthOIDC] ' + s),
@@ -591,8 +591,8 @@ class ExternalAuthOIDC {
    */
   private async getRandomAvatar (): Promise<undefined | ExternalAccountInfos['avatar']> {
     try {
-      if (!this.avatarsDir || !this.avatarsFiles.length) {
-        throw new Error('Seems there is no default avatars')
+      if (!this.avatarsDir || !this.avatarsFiles?.length) {
+        return undefined
       }
 
       const file = this.avatarsFiles[Math.floor(Math.random() * this.avatarsFiles.length)]
diff --git a/server/lib/prosody/config.ts b/server/lib/prosody/config.ts
index 97cd17d0..9bf45d64 100644
--- a/server/lib/prosody/config.ts
+++ b/server/lib/prosody/config.ts
@@ -102,14 +102,23 @@ async function getProsodyFilePaths (options: RegisterServerOptions): Promise<Pro
   }
 
   let avatarSet: AvatarSet = (settings['avatar-set'] ?? 'sepia') as AvatarSet
-  if (!['sepia', 'cat', 'bird', 'fenec', 'abstract', 'legacy'].includes(avatarSet)) {
-    logger.error('Invalid avatar-set setting, using sepia as default')
-    avatarSet = 'sepia'
+  let avatarsDir
+  let avatarsFiles
+  let botAvatarsDir
+  let botAvatarsFiles
+  if (avatarSet === 'none') {
+    botAvatarsDir = path.resolve(__dirname, '../../bot_avatars/', 'sepia') // fallback to default avatars for the bot
+    botAvatarsFiles = await _listAvatars(botAvatarsDir)
+  } else {
+    if (!['sepia', 'cat', 'bird', 'fenec', 'abstract', 'legacy'].includes(avatarSet)) {
+      logger.error('Invalid avatar-set setting, using sepia as default')
+      avatarSet = 'sepia'
+    }
+    avatarsDir = path.resolve(__dirname, '../../avatars/', avatarSet)
+    avatarsFiles = await _listAvatars(avatarsDir)
+    botAvatarsDir = path.resolve(__dirname, '../../bot_avatars/', avatarSet)
+    botAvatarsFiles = await _listAvatars(botAvatarsDir)
   }
-  const avatarsDir = path.resolve(__dirname, '../../avatars/', avatarSet)
-  const avatarsFiles = await _listAvatars(avatarsDir)
-  const botAvatarsDir = path.resolve(__dirname, '../../bot_avatars/', avatarSet)
-  const botAvatarsFiles = await _listAvatars(botAvatarsDir)
 
   return {
     dir: dir,
@@ -356,7 +365,9 @@ async function getProsodyConfig (options: RegisterServerOptionsV5): Promise<Pros
 
   config.useManageRoomsApi(apikey)
   config.usePeertubeVCards(basePeertubeUrl)
-  config.useAnonymousRandomVCards(paths.avatars, paths.avatarsFiles)
+  if (paths.avatars && paths.avatarsFiles) {
+    config.useAnonymousRandomVCards(paths.avatars, paths.avatarsFiles)
+  }
 
   if (useBots) {
     config.useBotsVirtualHost(paths.botAvatars, paths.botAvatarsFiles)
diff --git a/server/lib/prosody/config/paths.ts b/server/lib/prosody/config/paths.ts
index 40b75bdf..f26a25b8 100644
--- a/server/lib/prosody/config/paths.ts
+++ b/server/lib/prosody/config/paths.ts
@@ -12,8 +12,8 @@ interface ProsodyFilePaths {
   certs?: string
   certsDirIsCustom: boolean
   modules: string
-  avatars: string
-  avatarsFiles: string[]
+  avatars?: string
+  avatarsFiles?: string[]
   botAvatars: string
   botAvatarsFiles: string[]
   exec?: string
diff --git a/server/lib/settings.ts b/server/lib/settings.ts
index 71bf1981..9ae2fe01 100644
--- a/server/lib/settings.ts
+++ b/server/lib/settings.ts
@@ -13,7 +13,7 @@ import { LivechatProsodyAuth } from './prosody/auth'
 import { loc } from './loc'
 const escapeHTML = require('escape-html')
 
-type AvatarSet = 'sepia' | 'cat' | 'bird' | 'fenec' | 'abstract' | 'legacy'
+type AvatarSet = 'sepia' | 'cat' | 'bird' | 'fenec' | 'abstract' | 'legacy' | 'none'
 
 async function initSettings (options: RegisterServerOptions): Promise<void> {
   const { peertubeHelpers, settingsManager } = options
@@ -510,7 +510,8 @@ function initThemingSettings ({ registerSetting }: RegisterServerOptions): void
       { value: 'bird', label: loc('avatar_set_option_bird') },
       { value: 'fenec', label: loc('avatar_set_option_fenec') },
       { value: 'abstract', label: loc('avatar_set_option_abstract') },
-      { value: 'legacy', label: loc('avatar_set_option_legacy') }
+      { value: 'legacy', label: loc('avatar_set_option_legacy') },
+      { value: 'none', label: loc('avatar_set_option_none') }
     ] as Array<{
       value: AvatarSet
       label: string