Display generated bg in the bg block. Add ability to copy chat bg to system list.

public/css/mobile-styles.css

@@ -293,7 +293,7 @@
         display: none;
     }
 
-    #bg_menu_content {
+    .bg_list {
         width: unset;
     }
 }

public/index.html

@@ -3243,10 +3243,10 @@
                             Auto-select
                         </div>
                     </div>
-                    <h3 data-i18n="System Backgrounds" class="justifyCenter">
+                    <h3 data-i18n="System Backgrounds" class="wide100p textAlignCenter">
                         System Backgrounds
                     </h3>
-                    <div id="bg_menu_content">
+                    <div id="bg_menu_content" class="bg_list">
                         <form id="form_bg_download" class="bg_example no-border no-shadow" action="javascript:void(null);" method="post" enctype="multipart/form-data">
                             <label class="input-file">
                                 <input type="file" id="add_bg_button" name="avatar" accept="image/png, image/jpeg, image/jpg, image/gif, image/bmp">
@@ -3254,6 +3254,14 @@
                             </label>
                         </form>
                     </div>
+                    <h3 data-i18n="Chat Backgrounds" class="wide100p textAlignCenter">
+                        Chat Backgrounds
+                    </h3>
+                    <div id="bg_chat_hint" class="wide100p textAlignCenter">
+                        Chat backgrounds generated with the <code><i class="fa-solid fa-paintbrush"></i>&nbsp;Stable Diffusion</code> extension will appear here.
+                    </div>
+                    <div id="bg_custom_content" class="bg_list">
+                    </div>
                 </div>
             </div>
         </div>
@@ -3894,6 +3902,7 @@
 
     <div id="background_template" class="template_element">
         <div class="bg_example flex-container" bgfile="" class="bg_example_img" title="">
+            <div title="Copy to system backgrounds" class="bg_button bg_example_copy fa-solid fa-file-arrow-up"></div>
             <div title="Rename background" class="bg_button bg_example_edit fa-solid fa-pencil"></div>
             <div title="Lock" class="bg_button bg_example_lock fa-solid fa-lock"></div>
             <div title="Unlock" class="bg_button bg_example_unlock fa-solid fa-lock-open"></div>

public/script.js

@@ -7721,6 +7721,7 @@ jQuery(async function () {
                 $("#rm_button_selected_ch").children("h2").text('');
                 select_rm_characters();
                 sendSystemMessage(system_message_types.WELCOME);
+                eventSource.emit(event_types.CHAT_CHANGED, getCurrentChatId());
             } else {
                 toastr.info("Please stop the message generation first.");
             }

public/scripts/backgrounds.js

@@ -3,14 +3,24 @@ import { saveMetadataDebounced } from "./extensions.js";
 import { registerSlashCommand } from "./slash-commands.js";
 import { stringFormat } from "./utils.js";
 
-const METADATA_KEY = 'custom_background';
+const BG_METADATA_KEY = 'custom_background';
+const LIST_METADATA_KEY = 'chat_backgrounds';
 
 /**
- * @param {string} background
+ * Sets the background for the current chat and adds it to the list of custom backgrounds.
+ * @param {{url: string, path:string}} backgroundInfo
  */
-function forceSetBackground(background) {
+function forceSetBackground(backgroundInfo) {
-    saveBackgroundMetadata(background);
+    saveBackgroundMetadata(backgroundInfo.url);
     setCustomBackground();
+
+    const list = chat_metadata[LIST_METADATA_KEY] || [];
+    const bg = backgroundInfo.path;
+    list.push(bg);
+    chat_metadata[LIST_METADATA_KEY] = list;
+    saveMetadataDebounced();
+    getChatBackgroundsList();
+    highlightNewBackground(bg);
     highlightLockedBackground();
 }
 
@@ -22,9 +32,27 @@ async function onChatChanged() {
         unsetCustomBackground();
     }
 
+    getChatBackgroundsList();
     highlightLockedBackground();
 }
 
+function getChatBackgroundsList() {
+    const list = chat_metadata[LIST_METADATA_KEY];
+    const listEmpty = !Array.isArray(list) || list.length === 0;
+
+    $('#bg_custom_content').empty();
+    $('#bg_chat_hint').toggle(listEmpty);
+
+    if (listEmpty) {
+        return;
+    }
+
+    for (const bg of list) {
+        const template = getBackgroundFromTemplate(bg, true);
+        $('#bg_custom_content').append(template);
+    }
+}
+
 function getBackgroundPath(fileUrl) {
     return `backgrounds/${fileUrl}`;
 }
@@ -32,7 +60,7 @@ function getBackgroundPath(fileUrl) {
 function highlightLockedBackground() {
     $('.bg_example').removeClass('locked');
 
-    const lockedBackground = chat_metadata[METADATA_KEY];
+    const lockedBackground = chat_metadata[BG_METADATA_KEY];
 
     if (!lockedBackground) {
         return;
@@ -71,21 +99,21 @@ function onUnlockBackgroundClick(e) {
 }
 
 function hasCustomBackground() {
-    return chat_metadata[METADATA_KEY];
+    return chat_metadata[BG_METADATA_KEY];
 }
 
 function saveBackgroundMetadata(file) {
-    chat_metadata[METADATA_KEY] = file;
+    chat_metadata[BG_METADATA_KEY] = file;
     saveMetadataDebounced();
 }
 
 function removeBackgroundMetadata() {
-    delete chat_metadata[METADATA_KEY];
+    delete chat_metadata[BG_METADATA_KEY];
     saveMetadataDebounced();
 }
 
 function setCustomBackground() {
-    const file = chat_metadata[METADATA_KEY];
+    const file = chat_metadata[BG_METADATA_KEY];
 
     // bg already set
     if (document.getElementById("bg_custom").style.backgroundImage == file) {
@@ -100,6 +128,7 @@ function unsetCustomBackground() {
 }
 
 function onSelectBackgroundClick() {
+    const isCustom = $(this).attr('custom') === 'true';
     const relativeBgImage = getUrlParameter(this);
 
     // if clicked on upload button
@@ -107,15 +136,18 @@ function onSelectBackgroundClick() {
         return;
     }
 
-    if (hasCustomBackground()) {
+    // Automatically lock the background if it's custom or other background is locked
+    if (hasCustomBackground() || isCustom) {
         saveBackgroundMetadata(relativeBgImage);
         setCustomBackground();
+        highlightLockedBackground();
+    } else {
+        highlightLockedBackground();
     }
 
-    highlightLockedBackground();
     const customBg = window.getComputedStyle(document.getElementById('bg_custom')).backgroundImage;
 
-    // custom background is set. Do not override the layer below
+    // Custom background is set. Do not override the layer below
     if (customBg !== 'none') {
         return;
     }
@@ -123,7 +155,7 @@ function onSelectBackgroundClick() {
     const bgFile = $(this).attr("bgfile");
     const backgroundUrl = getBackgroundPath(bgFile);
 
-    // fetching to browser memory to reduce flicker
+    // Fetching to browser memory to reduce flicker
     fetch(backgroundUrl).then(() => {
         $("#bg1").css("background-image", relativeBgImage);
         setBackground(bgFile);
@@ -132,32 +164,80 @@ function onSelectBackgroundClick() {
     });
 }
 
-async function onRenameBackgroundClick(e) {
+async function onCopyToSystemBackgroundClick(e) {
     e.stopPropagation();
-    const old_bg = $(this).closest('.bg_example').attr('bgfile');
+    const bgNames = await getNewBackgroundName(this);
 
-    if (!old_bg) {
+    if (!bgNames) {
+        return;
+    }
+
+    const bgFile = await fetch(bgNames.oldBg);
+
+    if (!bgFile.ok) {
+        toastr.warning('Failed to copy background');
+        return;
+    }
+
+    const blob = await bgFile.blob();
+    const file = new File([blob], bgNames.newBg);
+    const formData = new FormData();
+    formData.set('avatar', file);
+
+    uploadBackground(formData);
+
+    const list = chat_metadata[LIST_METADATA_KEY] || [];
+    const index = list.indexOf(bgNames.oldBg);
+    list.splice(index, 1);
+    saveMetadataDebounced();
+    getChatBackgroundsList();
+}
+
+/**
+ * Gets the new background name from the user.
+ * @param {Element} referenceElement
+ * @returns {Promise<{oldBg: string, newBg: string}>}
+ * */
+async function getNewBackgroundName(referenceElement) {
+    const exampleBlock = $(referenceElement).closest('.bg_example');
+    const isCustom = exampleBlock.attr('custom') === 'true';
+    const oldBg = exampleBlock.attr('bgfile');
+
+    if (!oldBg) {
         console.debug('no bgfile');
         return;
     }
 
-    const fileExtension = old_bg.split('.').pop();
+    const fileExtension = oldBg.split('.').pop();
-    const old_bg_extensionless = old_bg.replace(`.${fileExtension}`, '');
+    const fileNameBase = isCustom ? oldBg.split('/').pop() : oldBg;
-    const new_bg_extensionless = await callPopup('<h3>Enter new background name:</h3>', 'input', old_bg_extensionless);
+    const oldBgExtensionless = fileNameBase.replace(`.${fileExtension}`, '');
+    const newBgExtensionless = await callPopup('<h3>Enter new background name:</h3>', 'input', oldBgExtensionless);
 
-    if (!new_bg_extensionless) {
+    if (!newBgExtensionless) {
         console.debug('no new_bg_extensionless');
         return;
     }
 
-    const new_bg = `${new_bg_extensionless}.${fileExtension}`;
+    const newBg = `${newBgExtensionless}.${fileExtension}`;
 
-    if (old_bg_extensionless === new_bg_extensionless) {
+    if (oldBgExtensionless === newBgExtensionless) {
         console.debug('new_bg === old_bg');
         return;
     }
 
-    const data = { old_bg, new_bg };
+    return { oldBg, newBg };
+}
+
+async function onRenameBackgroundClick(e) {
+    e.stopPropagation();
+
+    const bgNames = await getNewBackgroundName(this);
+
+    if (!bgNames) {
+        return;
+    }
+
+    const data = { old_bg: bgNames.oldBg, new_bg: bgNames.newBg };
     const response = await fetch('/renamebackground', {
         method: 'POST',
         headers: getRequestHeaders(),
@@ -167,7 +247,7 @@ async function onRenameBackgroundClick(e) {
 
     if (response.ok) {
         await getBackgrounds();
-        highlightNewBackground(new_bg);
+        highlightNewBackground(bgNames.newBg);
     } else {
         toastr.warning('Failed to rename background');
     }
@@ -177,28 +257,45 @@ async function onDeleteBackgroundClick(e) {
     e.stopPropagation();
     const bgToDelete = $(this).closest('.bg_example');
     const url = bgToDelete.data('url');
+    const isCustom = bgToDelete.attr('custom') === 'true';
     const confirm = await callPopup("<h3>Delete the background?</h3>", 'confirm');
+    const bg = bgToDelete.attr('bgfile');
 
     if (confirm) {
-        delBackground(bgToDelete.attr("bgfile"));
+        // If it's not custom, it's a built-in background. Delete it from the server
+        if (!isCustom) {
+            delBackground(bg);
+        } else {
+            const list = chat_metadata[LIST_METADATA_KEY] || [];
+            const index = list.indexOf(bg);
+            list.splice(index, 1);
+        }
 
         const siblingSelector = '.bg_example:not(#form_bg_download)';
         const nextBg = bgToDelete.next(siblingSelector);
         const prevBg = bgToDelete.prev(siblingSelector);
+        const anyBg = $(siblingSelector);
 
         if (nextBg.length > 0) {
             nextBg.trigger('click');
-        } else {
+        } else if (prevBg.length > 0) {
             prevBg.trigger('click');
+        } else {
+            $(anyBg[Math.floor(Math.random() * anyBg.length)]).trigger('click');
         }
 
         bgToDelete.remove();
 
-        if (url === chat_metadata[METADATA_KEY]) {
+        if (url === chat_metadata[BG_METADATA_KEY]) {
             removeBackgroundMetadata();
             unsetCustomBackground();
             highlightLockedBackground();
         }
+
+        if (isCustom) {
+            getChatBackgroundsList();
+            saveMetadataDebounced();
+        }
     }
 }
 
@@ -259,18 +356,20 @@ function getUrlParameter(block) {
  * Instantiates a background template
  * @param {string} bg Path to background
  * @param {boolean} isCustom Whether the background is custom
- * @returns
+ * @returns {JQuery<HTMLElement>} Background template
  */
 function getBackgroundFromTemplate(bg, isCustom) {
-    const thumbPath = getThumbnailUrl('bg', bg);
     const template = $('#background_template .bg_example').clone();
-    const url = isCustom ? `url("${bg}")` : `url("${getBackgroundPath(bg)}")`;
+    const thumbPath = isCustom ? bg : getThumbnailUrl('bg', bg);
-    template.attr('title', bg);
+    const url = isCustom ? `url("${encodeURI(bg)}")` : `url("${getBackgroundPath(bg)}")`;
+    const title = isCustom ? bg.split('/').pop() : bg;
+    const friendlyTitle = title.slice(0, title.lastIndexOf('.'));
+    template.attr('title', title);
     template.attr('bgfile', bg);
     template.attr('custom', String(isCustom));
     template.data('url', url);
     template.css('background-image', `url('${thumbPath}')`);
-    template.find('.BGSampleTitle').text(bg.slice(0, bg.lastIndexOf('.')));
+    template.find('.BGSampleTitle').text(friendlyTitle);
     return template;
 }
 
@@ -307,12 +406,6 @@ async function delBackground(bg) {
 }
 
 function onBackgroundUploadSelected() {
-    const input = this;
-
-    if (input.files && input.files[0]) {
-        const reader = new FileReader();
-
-        reader.onload = function (e) {
     const form = $("#form_bg_download").get(0);
 
     if (!(form instanceof HTMLFormElement)) {
@@ -321,35 +414,35 @@ function onBackgroundUploadSelected() {
     }
 
     const formData = new FormData(form);
+    uploadBackground(formData);
+    form.reset();
+}
 
-            //console.log(formData);
+/**
+ * Uploads a background to the server
+ * @param {FormData} formData
+ */
+function uploadBackground(formData) {
     jQuery.ajax({
         type: "POST",
         url: "/downloadbackground",
         data: formData,
         beforeSend: function () {
-
         },
         cache: false,
         contentType: false,
         processData: false,
         success: async function (bg) {
-                    form.reset();
             setBackground(bg);
             $("#bg1").css("background-image", `url("${getBackgroundPath(bg)}"`);
             await getBackgrounds();
             highlightNewBackground(bg);
         },
         error: function (jqXHR, exception) {
-                    form.reset();
             console.log(exception);
             console.log(jqXHR);
         },
     });
-        };
-
-        reader.readAsDataURL(input.files[0]);
-    }
 }
 
 /**
@@ -378,11 +471,12 @@ function onBackgroundFilterInput() {
 export function initBackgrounds() {
     eventSource.on(event_types.CHAT_CHANGED, onChatChanged);
     eventSource.on(event_types.FORCE_SET_BACKGROUND, forceSetBackground);
-    $(document).on("click", ".bg_example", onSelectBackgroundClick);
+    $(document).on("click", '.bg_example', onSelectBackgroundClick);
     $(document).on('click', '.bg_example_lock', onLockBackgroundClick);
     $(document).on('click', '.bg_example_unlock', onUnlockBackgroundClick);
     $(document).on('click', '.bg_example_edit', onRenameBackgroundClick);
-    $(document).on("click", ".bg_example_cross", onDeleteBackgroundClick);
+    $(document).on("click", '.bg_example_cross', onDeleteBackgroundClick);
+    $(document).on("click", '.bg_example_copy', onCopyToSystemBackgroundClick);
     $('#auto_background').on("click", autoBackgroundCommand);
     $("#add_bg_button").on('change', onBackgroundUploadSelected);
     $("#bg-filter").on("input", onBackgroundFilterInput);

public/scripts/extensions/stable-diffusion/index.js

@@ -1116,10 +1116,9 @@ async function generatePicture(_, trigger, message, callback) {
             extension_settings.sd.width = Math.round(extension_settings.sd.height * 1.8 / 64) * 64;
         }
         const callbackOriginal = callback;
-        callback = async function (prompt, base64Image) {
+        callback = async function (prompt, imagePath) {
-            const imagePath = base64Image;
+            const imgUrl = `url("${encodeURI(imagePath)}")`;
-            const imgUrl = `url("${encodeURI(base64Image)}")`;
+            eventSource.emit(event_types.FORCE_SET_BACKGROUND, { url: imgUrl, path: imagePath });
-            eventSource.emit(event_types.FORCE_SET_BACKGROUND, imgUrl);
 
             if (typeof callbackOriginal === 'function') {
                 callbackOriginal(prompt, imagePath);

public/scripts/utils.js

@@ -870,7 +870,7 @@ export async function saveBase64AsFile(base64Data, characterName, filename = "",
     // If the response is successful, get the saved image path from the server's response
     if (response.ok) {
         const responseData = await response.json();
-        return responseData.path;
+        return responseData.path.replace(/\\/g, '/'); // Replace backslashes with forward slashes
     } else {
         const errorData = await response.json();
         throw new Error(errorData.error || 'Failed to upload the image to the server');

public/style.css

@@ -1506,7 +1506,7 @@ input[type=search]:focus::-webkit-search-cancel-button {
     z-index: 3001;
 }
 
-#bg_menu_content {
+.bg_list {
     display: flex;
     flex-wrap: wrap;
     width: calc(var(--sheldWidth) - 10px);
@@ -1543,6 +1543,14 @@ input[type=search]:focus::-webkit-search-cancel-button {
     display: none;
 }
 
+.bg_example:hover[custom="true"] .bg_example_edit {
+    display: none;
+}
+
+.bg_example:hover[custom="false"] .bg_example_copy {
+    display: none;
+}
+
 .BGSampleTitle {
     display: flex;
     width: 100%;
@@ -1591,6 +1599,10 @@ input[type=search]:focus::-webkit-search-cancel-button {
     left: 10px;
 }
 
+.bg_example_copy {
+    left: 10px;
+}
+
 .bg_example_lock,
 .bg_example_unlock {
     left: 50%;