merge upstream and reconcile

.github/workflows/codespell.yml

@@ -0,0 +1,25 @@
+# Codespell configuration is within pyproject.toml
+---
+name: Codespell
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  codespell:
+    name: Check for spelling errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Annotate locations with typos
+        uses: codespell-project/codespell-problem-matcher@v1
+      - name: Codespell
+        uses: codespell-project/actions-codespell@v2

CODE_OF_CONDUCT.md

@@ -2,7 +2,7 @@
 
 ## Our Pledge
 
-As members, contributors, and leaders of this community, we pledge to make participation in our open-source project a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+As members, contributors, and leaders of this community, we pledge to make participation in our open-source project a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socioeconomic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
 
 We are committed to creating and maintaining an open, respectful, and professional environment where positive contributions and meaningful discussions can flourish. By participating in this project, you agree to uphold these values and align your behavior to the standards outlined in this Code of Conduct.
 

backend/open_webui/config.py

@@ -1211,6 +1211,9 @@ if VECTOR_DB == "pgvector" and not PGVECTOR_DB_URL.startswith("postgres"):
     raise ValueError(
         "Pgvector requires setting PGVECTOR_DB_URL or using Postgres with vector extension as the primary database."
     )
+PGVECTOR_INITIALIZE_MAX_VECTOR_LENGTH = int(
+    os.environ.get("PGVECTOR_INITIALIZE_MAX_VECTOR_LENGTH", "1536")
+)
 
 ####################################
 # Information Retrieval (RAG)

backend/open_webui/retrieval/vector/dbs/pgvector.py

@@ -5,6 +5,7 @@ from sqlalchemy import (
     create_engine,
     Column,
     Integer,
+    MetaData,
     select,
     text,
     Text,
@@ -19,9 +20,9 @@ from pgvector.sqlalchemy import Vector
 from sqlalchemy.ext.mutable import MutableDict
 
 from open_webui.retrieval.vector.main import VectorItem, SearchResult, GetResult
-from open_webui.config import PGVECTOR_DB_URL
+from open_webui.config import PGVECTOR_DB_URL, PGVECTOR_INITIALIZE_MAX_VECTOR_LENGTH
 
-VECTOR_LENGTH = 1536
+VECTOR_LENGTH = PGVECTOR_INITIALIZE_MAX_VECTOR_LENGTH
 Base = declarative_base()
 
 
@@ -56,6 +57,9 @@ class PgvectorClient:
             # Ensure the pgvector extension is available
             self.session.execute(text("CREATE EXTENSION IF NOT EXISTS vector;"))
 
+            # Check vector length consistency
+            self.check_vector_length()
+
             # Create the tables if they do not exist
             # Base.metadata.create_all requires a bind (engine or connection)
             # Get the connection from the session
@@ -82,6 +86,38 @@ class PgvectorClient:
             print(f"Error during initialization: {e}")
             raise
 
+    def check_vector_length(self) -> None:
+        """
+        Check if the VECTOR_LENGTH matches the existing vector column dimension in the database.
+        Raises an exception if there is a mismatch.
+        """
+        metadata = MetaData()
+        metadata.reflect(bind=self.session.bind, only=["document_chunk"])
+
+        if "document_chunk" in metadata.tables:
+            document_chunk_table = metadata.tables["document_chunk"]
+            if "vector" in document_chunk_table.columns:
+                vector_column = document_chunk_table.columns["vector"]
+                vector_type = vector_column.type
+                if isinstance(vector_type, Vector):
+                    db_vector_length = vector_type.dim
+                    if db_vector_length != VECTOR_LENGTH:
+                        raise Exception(
+                            f"VECTOR_LENGTH {VECTOR_LENGTH} does not match existing vector column dimension {db_vector_length}. "
+                            "Cannot change vector size after initialization without migrating the data."
+                        )
+                else:
+                    raise Exception(
+                        "The 'vector' column exists but is not of type 'Vector'."
+                    )
+            else:
+                raise Exception(
+                    "The 'vector' column does not exist in the 'document_chunk' table."
+                )
+        else:
+            # Table does not exist yet; no action needed
+            pass
+
     def adjust_vector_length(self, vector: List[float]) -> List[float]:
         # Adjust vector to have length VECTOR_LENGTH
         current_length = len(vector)

backend/open_webui/retrieval/web/testdata/brave.json

@@ -683,7 +683,7 @@
 				"age": "October 29, 2022",
 				"extra_snippets": [
 					"You can pass many options to the configure script; run ./configure --help to find out more. On macOS case-insensitive file systems and on Cygwin, the executable is called python.exe; elsewhere it's just python.",
-					"Building a complete Python installation requires the use of various additional third-party libraries, depending on your build platform and configure options. Not all standard library modules are buildable or useable on all platforms. Refer to the Install dependencies section of the Developer Guide for current detailed information on dependencies for various Linux distributions and macOS.",
+					"Building a complete Python installation requires the use of various additional third-party libraries, depending on your build platform and configure options. Not all standard library modules are buildable or usable on all platforms. Refer to the Install dependencies section of the Developer Guide for current detailed information on dependencies for various Linux distributions and macOS.",
 					"To get an optimized build of Python, configure --enable-optimizations before you run make. This sets the default make targets up to enable Profile Guided Optimization (PGO) and may be used to auto-enable Link Time Optimization (LTO) on some platforms. For more details, see the sections below.",
 					"Copyright © 2001-2024 Python Software Foundation. All rights reserved."
 				]

backend/open_webui/utils/auth.py

@@ -99,9 +99,9 @@ def get_current_user(
         if request.app.state.config.ENABLE_API_KEY_ENDPOINT_RESTRICTIONS:
             allowed_paths = [
                 path.strip()
-                for path in str(request.app.state.config.API_KEY_ALLOWED_PATHS).split(
-                    ","
-                )
+                for path in str(
+                    request.app.state.config.API_KEY_ALLOWED_ENDPOINTS
+                ).split(",")
             ]
 
             if request.url.path not in allowed_paths:

backend/open_webui/utils/chat.py

@@ -315,6 +315,7 @@ async def chat_action(request: Request, action_id: str, form_data: dict, user: A
             "chat_id": data["chat_id"],
             "message_id": data["id"],
             "session_id": data["session_id"],
+            "user_id": user.id,
         }
     )
     __event_call__ = get_event_call(
@@ -322,6 +323,7 @@ async def chat_action(request: Request, action_id: str, form_data: dict, user: A
             "chat_id": data["chat_id"],
             "message_id": data["id"],
             "session_id": data["session_id"],
+            "user_id": user.id,
         }
     )
 

backend/requirements.txt

@@ -106,4 +106,4 @@ googleapis-common-protos==1.63.2
 ldap3==2.9.1
 
 gnupg
-huggingface_hub
+huggingface_hub

pyproject.toml

@@ -151,3 +151,10 @@ exclude = [
     "chroma.sqlite3",
 ]
 force-include = { "CHANGELOG.md" = "open_webui/CHANGELOG.md", build = "open_webui/frontend" }
+
+[tool.codespell]
+# Ref: https://github.com/codespell-project/codespell#using-a-config-file
+skip = '.git*,*.svg,package-lock.json,i18n,*.lock,*.css,*-bundle.js,locales,example-doc.txt,emoji-shortcodes.json'
+check-hidden = true
+# ignore-regex = ''
+ignore-words-list = 'ans'

src/lib/components/NotificationToast.svelte

@@ -1,5 +1,5 @@
 <script lang="ts">
-	import { settings } from '$lib/stores';
+	import { settings, playingNotificationSound, isLastActiveTab } from '$lib/stores';
 	import DOMPurify from 'dompurify';
 
 	import { marked } from 'marked';
@@ -17,8 +17,15 @@
 		}
 
 		if ($settings?.notificationSound ?? true) {
-			const audio = new Audio(`/audio/notification.mp3`);
-			audio.play();
+			if (!$playingNotificationSound && $isLastActiveTab) {
+				playingNotificationSound.set(true);
+
+				const audio = new Audio(`/audio/notification.mp3`);
+				audio.play().finally(() => {
+					// Ensure the global state is reset after the sound finishes
+					playingNotificationSound.set(false);
+				});
+			}
 		}
 	});
 </script>

src/lib/components/common/Textarea.svelte

@@ -56,7 +56,7 @@
 
 <style>
 	.placeholder::before {
-		/* abolute */
+		/* absolute */
 		position: absolute;
 		content: attr(data-placeholder);
 		color: #adb5bd;

src/lib/components/layout/Sidebar.svelte

@@ -558,19 +558,6 @@
 				on:input={searchDebounceHandler}
 				placeholder={$i18n.t('Search')}
 			/>
-
-			<div class="absolute z-40 right-3.5 top-1">
-				<Tooltip content={$i18n.t('New folder')}>
-					<button
-						class="p-1 rounded-lg bg-gray-50 hover:bg-gray-100 dark:bg-gray-950 dark:hover:bg-gray-900 text-gray-500 dark:text-gray-500 transition"
-						on:click={() => {
-							createFolder();
-						}}
-					>
-						<Plus className=" size-3" strokeWidth="2.5" />
-					</button>
-				</Tooltip>
-			</div>
 		</div>
 
 		<div
@@ -605,6 +592,10 @@
 				collapsible={!search}
 				className="px-2 mt-0.5"
 				name={$i18n.t('Chats')}
+				onAdd={() => {
+					createFolder();
+				}}
+				onAddLabel={$i18n.t('New Folder')}
 				on:import={(e) => {
 					importChatHandler(e.detail);
 				}}
@@ -631,7 +622,7 @@
 							}
 
 							if (chat.pinned) {
-								const res = await toggleChatPinnedStatusById(localStorage.token, chat, id);
+								const res = await toggleChatPinnedStatusById(localStorage.token, chat.id);
 							}
 
 							initChatList();
@@ -661,7 +652,7 @@
 				{#if !search && $pinnedChats.length > 0}
 					<div class="flex flex-col space-y-1 rounded-xl">
 						<Folder
-							className="px-2"
+							className=""
 							bind:open={showPinnedChat}
 							on:change={(e) => {
 								localStorage.setItem('showPinnedChat', e.detail);

src/lib/components/layout/Sidebar/Folders.svelte

@@ -19,7 +19,7 @@
 
 {#each folderList as folderId (folderId)}
 	<RecursiveFolder
-		className="px-2"
+		className=""
 		{folders}
 		{folderId}
 		on:import={(e) => {

src/lib/stores/index.ts

@@ -69,6 +69,9 @@ export const temporaryChatEnabled = writable(false);
 export const scrollPaginationEnabled = writable(false);
 export const currentChatPage = writable(1);
 
+export const isLastActiveTab = writable(true);
+export const playingNotificationSound = writable(false);
+
 export type Model = OpenAIModel | OllamaModel;
 
 type BaseModel = {

src/routes/+layout.js

@@ -10,7 +10,7 @@
 export const ssr = false;
 
 // How to manage the trailing slashes in the URLs
-// the URL for about page witll be /about with 'ignore' (default)
-// the URL for about page witll be /about/ with 'always'
+// the URL for about page will be /about with 'ignore' (default)
+// the URL for about page will be /about/ with 'always'
 // https://kit.svelte.dev/docs/page-options#trailingslash
 export const trailingSlash = 'ignore';

src/routes/+layout.svelte

@@ -10,6 +10,7 @@
 	import {
 		config,
 		user,
+		settings,
 		theme,
 		WEBUI_NAME,
 		mobile,
@@ -20,7 +21,8 @@
 		chats,
 		currentChatPage,
 		tags,
-		temporaryChatEnabled
+		temporaryChatEnabled,
+		isLastActiveTab
 	} from '$lib/stores';
 	import { goto } from '$app/navigation';
 	import { page } from '$app/stores';
@@ -42,7 +44,10 @@
 
 	setContext('i18n', i18n);
 
+	const bc = new BroadcastChannel('active-tab-channel');
+
 	let loaded = false;
+
 	const BREAKPOINT = 768;
 
 	const setupSocket = async (enableWebsocket) => {
@@ -107,6 +112,15 @@
 				const { done, content, title } = data;
 
 				if (done) {
+					if ($isLastActiveTab) {
+						if ($settings?.notificationEnabled ?? false) {
+							new Notification(`${title} | Open WebUI`, {
+								body: content,
+								icon: `${WEBUI_BASE_URL}/static/favicon.png`
+							});
+						}
+					}
+
 					toast.custom(NotificationToast, {
 						componentProps: {
 							onClick: () => {
@@ -138,6 +152,15 @@
 			const data = event?.data?.data ?? null;
 
 			if (type === 'message') {
+				if ($isLastActiveTab) {
+					if ($settings?.notificationEnabled ?? false) {
+						new Notification(`${data?.user?.name} (#${event?.channel?.name}) | Open WebUI`, {
+							body: data?.content,
+							icon: data?.user?.profile_image_url ?? `${WEBUI_BASE_URL}/static/favicon.png`
+						});
+					}
+				}
+
 				toast.custom(NotificationToast, {
 					componentProps: {
 						onClick: () => {
@@ -154,6 +177,27 @@
 	};
 
 	onMount(async () => {
+		// Listen for messages on the BroadcastChannel
+		bc.onmessage = (event) => {
+			if (event.data === 'active') {
+				isLastActiveTab.set(false); // Another tab became active
+			}
+		};
+
+		// Set yourself as the last active tab when this tab is focused
+		const handleVisibilityChange = () => {
+			if (document.visibilityState === 'visible') {
+				isLastActiveTab.set(true); // This tab is now the active tab
+				bc.postMessage('active'); // Notify other tabs that this tab is active
+			}
+		};
+
+		// Add event listener for visibility state changes
+		document.addEventListener('visibilitychange', handleVisibilityChange);
+
+		// Call visibility change handler initially to set state on load
+		handleVisibilityChange();
+
 		theme.set(localStorage.theme);
 
 		mobile.set(window.innerWidth < BREAKPOINT);