--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # SillyTavern Extension - ChatBridge
2 |
3 | 一个用于SillyTavern的API桥接扩展，让外部应用（如qq机器人）能够复用SillyTavern的对话功能，像调用api一样在SillyTavern中聊天。
4 |
5 | An API bridging extension for SillyTavern that allows external applications to reuse SillyTavern's conversation functionality, enabling chat in SillyTavern as if calling an API.
6 |
7 | ## 简介 / Introduction
8 | > *我很高兴地宣布我写完了此项目的主要功能，这是最新的更新，和之前的版本完全不同了，重构了基本功能并且实现了向外部开设Openai格式的api，适用于任何openai应用程序调用SillyTavern的强大功能。*
9 |
10 | > *I'm pleased to announce that I have completed the main features of this project. This is the latest update, completely different from previous versions. I've restructured the basic functionality and implemented an OpenAI-format API for external use, suitable for any OpenAI application to leverage SillyTavern's powerful capabilities.*
11 |
12 | 本项目是一个SillyTavern扩展，通过WebSocket和API转发的方式，实现了将SillyTavern作为中间件服务的功能。它包含以下组件：
13 |
14 | This project is a SillyTavern extension that turns SillyTavern into a middleware service through WebSocket and API forwarding. It consists of the following components:
15 |
16 | - SillyTavern UI Extension: 负责与WebSocket服务器通信
17 | - ChatBridge_APIHijackForwarder.py: 核心服务器组件，提供WebSocket和API接口
18 | - 配置文件：用于设置各类连接参数
19 |
20 | - SillyTavern UI Extension: Responsible for communication with the WebSocket server
21 | - ChatBridge_APIHijackForwarder.py: Core server component, providing WebSocket and API interfaces
22 | - Configuration files: Used to set various connection parameters
23 |
24 | 该扩展可以让任何支持OpenAI API格式的外部应用通过SillyTavern的对话管理系统与LLM进行交互。
25 |
26 | This extension allows any external application that supports the OpenAI API format to interact with LLMs through SillyTavern's conversation management system.
27 |
28 | ## 使用说明 / Usage Instructions
29 |
30 | ### 1. 安装扩展 / Install the Extension
31 |
32 | 1. 复制项目文件到SillyTavern扩展目录:
33 | Copy the project files to the SillyTavern extension directory:
34 | ```bash
35 | /public/scripts/extensions/third-party/SillyTavern-Extension-ChatBridge/
36 | ```
37 |
38 | ### 2. 启动服务 / Start the Service
39 |
40 | 0. 你可能需要配置settings.json文件中的各api的base_url和apikey。
41 |
42 | You may need to configure the base_url and apikey for various APIs in the settings.json file.
43 |
44 | 1. 启动Python服务器:
45 | Start the Python server:
46 | ```bash
47 | python ChatBridge_APIHijackForwarder.py
48 | ```
49 |
50 | 2. 在SillyTavern扩展设置中配置并连接WebSocket:
51 | Configure and connect to WebSocket in SillyTavern extension settings:
52 | - 设置服务器地址(默认localhost)
53 | - 设置端口(默认8001)
54 | - 点击"连接"按钮
55 |
56 | - Set the server address (default: localhost)
57 | - Set the port (default: 8001)
58 | - Click the "Connect" button
59 |
60 | ### 3. 外部应用调用 / External Application Calls
61 |
62 | 配置外部应用的API设置， 如:
63 | Configure the API settings for external applications, for example:
64 | ```python
65 | client = OpenAI(
66 | api_key="your-user-api-key",
67 | base_url="http://localhost:8003/v1"
68 | )
69 | ```
70 |
71 | ## 内部逻辑 / Internal Logic
72 |
73 | 请求流程:
74 | Request flow:
75 | 1. 外部应用 → 用户API(8003) → WebSocket(8001)
76 | 2. WebSocket → SillyTavern UI Extension
77 | 3. SillyTavern处理 → ST API(8002)
78 | 4. ST API → LLM API → 获取响应
79 | 5. 响应同时返回给ST和用户API
80 |
81 | 1. External App → User API(8003) → WebSocket(8001)
82 | 2. WebSocket → SillyTavern UI Extension
83 | 3. SillyTavern processing → ST API(8002)
84 | 4. ST API → LLM API → Get response
85 | 5. Response returned to both ST and User API
86 |
87 | ```mermaid
88 | sequenceDiagram
89 | User->>UserAPI: 1.调用API
90 | UserAPI->>WebSocket: 2.转发请求
91 | WebSocket->>ST: 3.通知处理
92 | ST->>STAPI: 4.调用接口
93 | STAPI->>LLM: 5.请求响应
94 | LLM-->>STAPI: 6.返回结果
95 | STAPI-->>ST: 7a.发送响应
96 | LLMAPI-->>UserAPI: 7b.同步发送响应
97 | UserAPI-->>User: 8.返回结果
98 | ```
99 |
100 | ### 重要说明 / Important Notes
101 |
102 | - 需要SillyTavern最新版本支持`context.clearChat()`和`context.printMessages()`
103 | - 所有API采用OpenAI格式
104 | - 支持流式和非流式响应， **但必须保证ST的设置和应用程序的设置都保持流式/非流式一致**
105 | - 支持多个LLM API密钥轮询
106 |
107 | - Requires the latest version of SillyTavern with support for `context.clearChat()` and `context.printMessages()`
108 | - All APIs use OpenAI format
109 | - Supports both streaming and non-streaming responses, **but ensure that ST settings and application settings are consistent for streaming/non-streaming**
110 | - Supports multiple LLM API keys rotation
111 |
112 | ## 依赖要求 / Dependencies
113 |
114 | - Python 3.7+
115 | - SillyTavern最新版本 / Latest version of SillyTavern
116 | - aiohttp
117 | - websockets
118 |
119 | ## 许可证 / License
120 |
121 | 本项目采用AGPL-3.0许可证
122 | This project is licensed under AGPL-3.0
123 |
124 | ## 已知问题
125 |
126 | - 若对UserApi的请求在上一条信息响应未完全结束时，发送另一条请求，有大概率会得到相同的回复。即转发器设计bug使得UserApi对短时间的请求将会给出相同的复制的响应，将在未来的版本修复，此Bug不影响单机串行使用。
--------------------------------------------------------------------------------
/style.css:
--------------------------------------------------------------------------------
1 | .chat-bridge-container {
2 | display: flex;
3 | flex-direction: column;
4 | gap: 10px;
5 | padding: 10px;
6 | }
7 |
8 | .chat-bridge-messages {
9 | height: 400px;
10 | overflow-y: auto;
11 | border: 1px solid var(--accent-color);
12 | border-radius: 5px;
13 | padding: 10px;
14 | background-color: var(--shadow-color);
15 | }
16 |
17 | .chat-bridge-message {
18 | margin-bottom: 8px;
19 | padding: 8px;
20 | border-radius: 5px;
21 | background-color: var(--background-color);
22 | }
23 |
24 | .chat-bridge-message.user {
25 | background-color: var(--accent-color);
26 | color: var(--text-color);
27 | margin-left: 20px;
28 | }
29 |
30 | .chat-bridge-message.assistant {
31 | background-color: var(--secondary-color);
32 | margin-right: 20px;
33 | }
34 |
35 | .chat-bridge-input-area {
36 | display: flex;
37 | gap: 10px;
38 | }
39 |
40 | .chat-bridge-input {
41 | flex: 1;
42 | min-height: 60px;
43 | padding: 8px;
44 | border-radius: 5px;
45 | border: 1px solid var(--accent-color);
46 | background-color: var(--background-color);
47 | color: var(--text-color);
48 | resize: vertical;
49 | }
50 |
51 | .chat-bridge-settings {
52 | display: flex;
53 | align-items: center;
54 | gap: 10px;
55 | margin-top: 5px;
56 | }
57 |
58 | .message-name {
59 | font-weight: bold;
60 | margin-bottom: 5px;
61 | display: block;
62 | }
63 |
64 | .message-content {
65 | word-break: break-word;
66 | }
67 |
68 | .message-content a {
69 | color: var(--accent-color);
70 | text-decoration: none;
71 | }
72 |
73 | .message-content a:hover {
74 | text-decoration: underline;
75 | }
76 |
77 | .message-content code {
78 | background-color: var(--shadow-color);
79 | padding: 2px 4px;
80 | border-radius: 3px;
81 | }
82 |
83 | .message-content ul,
84 | .message-content ol {
85 | margin: 10px 0;
86 | padding-left: 20px;
87 | }
88 |
89 | .message-content h3 {
90 | margin: 15px 0 10px 0;
91 | }
92 |
93 | .ChatBridgeExtension_connection {
94 | display: flex;
95 | flex-direction: column;
96 | gap: 10px;
97 | margin-bottom: 10px;
98 | align-items: center;
99 | }
100 | .ChatBridgeExtension_server_settings {
101 | display: flex;
102 | gap: 10px;
103 | align-items: center;
104 | }
105 |
106 | .ChatBridgeExtension_controls {
107 | display: flex;
108 | gap: 10px;
109 | align-items: center;
110 | }
111 |
112 | .ChatBridgeExtension_port_input input{
113 | background-color: var(--background-color);
114 | color: var(--text-color);
115 | border: 1px solid var(--accent-color);
116 | border-radius: 4px;
117 | padding: 4px 8px;
118 | }
119 |
120 | .ChatBridgeExtension_url_input input {
121 | background-color: var(--background-color);
122 | color: var(--text-color);
123 | border: 1px solid var(--accent-color);
124 | border-radius: 4px;
125 | padding: 4px 8px;
126 | }
127 |
128 | .ChatBridgeExtension_controls input[type="button"] {
129 | background-color: var(--secondary-color);
130 | color: var(--text-color);
131 | border: 1px solid var(--accent-color);
132 | border-radius: 4px;
133 | padding: 4px 12px;
134 | cursor: pointer;
135 | transition: background-color 0.2s;
136 | }
137 |
138 | .ChatBridgeExtension_controls input[type="button"]:hover {
139 | background-color: var(--accent-color);
140 | }
141 |
142 | .ChatBridgeExtension_controls input[type="button"]:disabled {
143 | background-color: var(--shadow-color);
144 | border-color: var(--shadow-color);
145 | cursor: not-allowed;
146 | opacity: 0.7;
147 | }
148 |
149 | .ChatBridgeExtension_controls label {
150 | display: flex;
151 | align-items: center;
152 | gap: 5px;
153 | }
154 |
155 | #debug_log {
156 | background-color: var(--background-color);
157 | color: var(--text-color);
158 | border: 1px solid var(--accent-color);
159 | border-radius: 4px;
160 | padding: 8px;
161 | font-family: monospace;
162 | }
163 |
164 | /* 状态显示样式 */
165 | .ChatBridgeExtension_status {
166 | margin: 10px 0;
167 | }
168 |
169 | #ws_status {
170 | display: inline-block;
171 | margin-left: 8px;
172 | }
173 |
174 | /* 标签样式 */
175 | .ChatBridgeExtension_connection label {
176 | color: var(--text-color);
177 | }
178 |
179 | #debug_log {
180 | width: 100%;
181 | min-height: 150px;
182 | background-color: var(--background-color);
183 | color: var(--text-color);
184 | border: 1px solid var(--accent-color);
185 | border-radius: 4px;
186 | padding: 8px;
187 | font-family: monospace;
188 | font-size: 12px;
189 | margin-top: 8px;
190 | resize: vertical;
191 | }
192 |
193 | .ChatBridgeExtension_debug {
194 | margin-top: 10px;
195 | padding: 8px;
196 | background-color: var(--hover-color);
197 | border-radius: 4px;
198 | }
199 |
200 | .ChatBridgeExtension_debug label {
201 | display: block;
202 | margin-bottom: 5px;
203 | color: var(--text-color);
204 | font-weight: bold;
205 | }
--------------------------------------------------------------------------------
/index.js:
--------------------------------------------------------------------------------
1 | import { extension_settings, getContext } from "../../../extensions.js";
2 | import { saveSettingsDebounced } from "../../../../script.js";
3 | import { chat } from "../../../../script.js";
4 |
5 | const extensionName = "SillyTavern-Extension-ChatBridge";
6 | const defaultSettings = {
7 | wsPort: 8001,
8 | autoConnect: false
9 | };
10 |
11 | if (!extension_settings[extensionName]) {
12 | extension_settings[extensionName] = {};
13 | }
14 |
15 | Object.assign(extension_settings[extensionName], defaultSettings);
16 |
17 | let ws;
18 |
19 | function updateDebugLog(message) {
20 | const debugLog = $('#debug_log');
21 | if (debugLog.length === 0) {
22 | console.warn('找不到调试日志元素');
23 | return;
24 | }
25 | const timestamp = new Date().toLocaleTimeString();
26 | const currentContent = debugLog.val();
27 | const newLine = `[${timestamp}] ${message}\n`;
28 | debugLog.val(currentContent + newLine);
29 | debugLog.scrollTop(debugLog[0].scrollHeight);
30 | // 同时在控制台输出，方便调试
31 | console.log(`[${extensionName}] ${message}`);
32 | }
33 |
34 | function updateWSStatus(connected) {
35 | const status = $('#ws_status');
36 | if (connected) {
37 | status.text('已连接').css('color', 'green');
38 | } else {
39 | status.text('未连接').css('color', 'red');
40 | }
41 | }
42 | function convertOpenAIToSTMessage(msg) {
43 | const isUser = msg.role === 'user';
44 | const currentTime = new Date().toLocaleString();
45 |
46 | return {
47 | name: isUser ? 'user' : 'Assistant', // 注意：用户名要小写
48 | is_user: isUser,
49 | is_system: false,
50 | send_date: currentTime,
51 | mes: msg.content,
52 | extra: {
53 | isSmallSys: false,
54 | token_count: 0,
55 | reasoning: ''
56 | },
57 | force_avatar: isUser ? "User Avatars/1739777502672-user.png" : null
58 | };
59 | }
60 |
61 | function setupWebSocket() {
62 | const wsUrl = $('#ws_url').val();
63 | const wsPort = $('#ws_port').val();
64 | updateDebugLog(`尝试连接WebSocket服务器: ws://${wsUrl}:${wsPort}`);
65 |
66 | ws = new WebSocket(`ws://${wsUrl}:${wsPort}`);
67 |
68 | ws.onopen = () => {
69 | updateWSStatus(true);
70 | updateConnectionButtons(true);
71 | updateDebugLog('WebSocket连接已建立');
72 | //sendChatHistory();
73 | };
74 | ws.onmessage = async (event) => {
75 | try {
76 | const data = JSON.parse(event.data);
77 | updateDebugLog(`收到消息: ${JSON.stringify(data)}`);
78 |
79 | if (data.type === 'user_request') {
80 | updateDebugLog('收到用户请求');
81 | if (data.content?.messages) {
82 | const context = getContext();
83 | const newChat = data.content.messages
84 | .filter(msg => msg.role === 'user' || msg.role === 'assistant')
85 | .map(msg => convertOpenAIToSTMessage(msg));
86 |
87 | chat.splice(0, chat.length, ...newChat);
88 | context.clearChat();
89 | context.printMessages();
90 | context.eventSource.emit(context.eventTypes.CHAT_CHANGED, context.getCurrentChatId());
91 | updateDebugLog(`已更新聊天内容，共${context.chat.length}条消息`);
92 | $('#send_but').click();
93 | } else {
94 | updateDebugLog('错误：消息格式不正确');
95 | }
96 | }
97 | } catch (error) {
98 | updateDebugLog(`处理消息时出错: ${error.message}`);
99 | console.error(error); // 输出完整错误信息
100 | }
101 | };
102 | ws.onclose = () => {
103 | updateWSStatus(false);
104 | updateConnectionButtons(false);
105 | updateDebugLog('WebSocket连接已关闭');
106 | };
107 |
108 | ws.onerror = (error) => {
109 | updateWSStatus(false);
110 | updateDebugLog(`WebSocket错误: ${error}`);
111 | };
112 | }
113 |
114 | function updateConnectionButtons(connected) {
115 | $('#ws_connect').prop('disabled', connected);
116 | $('#ws_disconnect').prop('disabled', !connected);
117 | $('#ws_url').prop('disabled', connected);
118 | $('#ws_port').prop('disabled', connected);
119 | }
120 |
121 | function disconnectWebSocket() {
122 | if (ws) {
123 | ws.close();
124 | }
125 | updateWSStatus(false);
126 | updateConnectionButtons(false);
127 | updateDebugLog('已断开WebSocket连接');
128 | // 如果启用了自动尝试连接，立即开始计时
129 | if (extension_settings[extensionName].autoConnect) {
130 | startAutoConnect();
131 | }
132 | }
133 |
134 | //自动尝试连接
135 | let autoConnectTimer = null;
136 | //自动尝试连接功能
137 | function startAutoConnect() {
138 | if (autoConnectTimer) {
139 | clearInterval(autoConnectTimer);
140 | }
141 |
142 | autoConnectTimer = setInterval(() => {
143 | if (!ws || ws.readyState === WebSocket.CLOSED) {
144 | updateDebugLog('自动尝试连接尝试中...');
145 | setupWebSocket();
146 | }
147 | }, 5000);
148 | }
149 |
150 | function stopAutoConnect() {
151 | if (autoConnectTimer) {
152 | clearInterval(autoConnectTimer);
153 | autoConnectTimer = null;
154 | }
155 | }
156 |
157 |
158 |
159 | jQuery(async () => {
160 |
161 | // // 事件系统测试代码
162 | // const context = getContext();
163 | // updateDebugLog('=== 可用事件类型 ===');
164 | // for (const eventType in context.eventTypes) {
165 | // updateDebugLog(`${eventType}: ${context.eventTypes[eventType]}`);
166 | // }
167 |
168 | const template = await $.get(`/scripts/extensions/third-party/${extensionName}/index.html`);
169 | $('#extensions_settings').append(template);
170 |
171 | $('#ws_connect').on('click', setupWebSocket);
172 | $('#ws_disconnect').on('click', disconnectWebSocket);
173 | $('#ws_port').val(extension_settings[extensionName].wsPort);
174 |
175 | $('#ws_port').on('change', function () {
176 | extension_settings[extensionName].wsPort = $(this).val();
177 | saveSettingsDebounced();
178 | });
179 | setupWebSocket();
180 |
181 | //自动尝试连接
182 | $('#ws_auto_connect').prop('checked', extension_settings[extensionName].autoConnect);
183 | // 添加自动尝试连接复选框的事件处理
184 | $('#ws_auto_connect').on('change', function() {
185 | const isChecked = $(this).prop('checked');
186 | extension_settings[extensionName].autoConnect = isChecked;
187 | saveSettingsDebounced();
188 |
189 | if (isChecked) {
190 | updateDebugLog('已启用自动尝试连接');
191 | startAutoConnect();
192 | } else {
193 | updateDebugLog('已禁用自动尝试连接');
194 | stopAutoConnect();
195 | }
196 | });
197 |
198 | // 如果启用了自动尝试连接，则启动定时器
199 | if (extension_settings[extensionName].autoConnect) {
200 | startAutoConnect();
201 | }
202 |
203 | updateDebugLog('扩展初始化完成');
204 |
205 | // 以下为测试代码
206 | // $('#show_chat').on('click', () => {
207 | // const context = getContext();
208 |
209 | // updateDebugLog('=== 当前聊天状态 ===');
210 | // updateDebugLog('name1: ' + context.name1);
211 | // updateDebugLog('name2: ' + context.name2);
212 | // updateDebugLog('characterId: ' + context.characterId);
213 | // updateDebugLog('当前聊天内容:');
214 | // updateDebugLog(JSON.stringify(context.chat, null, 2));
215 | // updateDebugLog('当前聊天元数据:');
216 | // updateDebugLog(JSON.stringify(context.chatMetadata, null, 2));
217 | // });
218 |
219 | // $('#replace_chat').on('click', () => {
220 | // const context = getContext();
221 |
222 | // const nativeChat = [
223 | // {
224 | // "name": "user",
225 | // "is_user": true,
226 | // "is_system": false,
227 | // "send_date": "February 26, 2025 2:09pm",
228 | // "mes": "？",
229 | // "extra": {
230 | // "isSmallSys": false,
231 | // "token_count": 2,
232 | // "reasoning": ""
233 | // },
234 | // "force_avatar": "User Avatars/1739777502672-user.png"
235 | // },
236 | // {
237 | // "extra": {
238 | // "api": "custom",
239 | // "model": "gemini-2.0-flash-exp",
240 | // "reasoning": "",
241 | // "reasoning_duration": null,
242 | // "token_count": 64
243 | // },
244 | // "name": "测试",
245 | // "is_user": false,
246 | // "send_date": "February 26, 2025 2:09pm",
247 | // "mes": "我不太确定你在问什么。你可以更详细地说明你的问题吗？",
248 | // "title": "",
249 | // "gen_started": "2025-02-26T06:09:43.173Z",
250 | // "gen_finished": "2025-02-26T06:09:45.338Z",
251 | // "swipe_id": 0,
252 | // "swipes": ["我不太确定你在问什么。你可以更详细地说明你的问题吗？"],
253 | // "swipe_info": [{
254 | // "send_date": "February 26, 2025 2:09pm",
255 | // "gen_started": "2025-02-26T06:09:43.173Z",
256 | // "gen_finished": "2025-02-26T06:09:45.338Z",
257 | // "extra": {
258 | // "api": "custom",
259 | // "model": "gemini-2.0-flash-exp",
260 | // "reasoning": "",
261 | // "reasoning_duration": null,
262 | // "token_count": 64
263 | // }
264 | // }]
265 | // }
266 | // ];
267 |
268 | // const nativeChat2 = [
269 | // {
270 | // "name": "user",
271 | // "is_user": true,
272 | // "is_system": false,
273 | // "send_date": "February 28, 2025 12:43am",
274 | // "mes": "?",
275 | // "extra": {
276 | // "isSmallSys": false,
277 | // "token_count": 2,
278 | // "reasoning": ""
279 | // },
280 | // "force_avatar": "User Avatars/1739777502672-user.png"
281 | // },
282 | // {
283 | // "extra": {
284 | // "api": "custom",
285 | // "model": "gemini-2.0-flash-exp",
286 | // "reasoning": "",
287 | // "reasoning_duration": null,
288 | // "token_count": 3
289 | // },
290 | // "name": "测试",
291 | // "is_user": false,
292 | // "send_date": "February 28, 2025 12:43am",
293 | // "mes": "Hello!?",
294 | // "title": "",
295 | // "gen_started": "2025-02-27T16:43:43.214Z",
296 | // "gen_finished": "2025-02-27T16:43:45.973Z",
297 | // "swipe_id": 0,
298 | // "swipes": [
299 | // "Hello!?"
300 | // ],
301 | // "swipe_info": [
302 | // {
303 | // "send_date": "February 28, 2025 12:43am",
304 | // "gen_started": "2025-02-27T16:43:43.214Z",
305 | // "gen_finished": "2025-02-27T16:43:45.973Z",
306 | // "extra": {
307 | // "api": "custom",
308 | // "model": "gemini-2.0-flash-exp",
309 | // "reasoning": "",
310 | // "reasoning_duration": null,
311 | // "token_count": 3
312 | // }
313 | // }
314 | // ]
315 | // }
316 | // ];
317 |
318 |
319 | // try {
320 | // //必须先启用新对话
321 | // //先清空再添加
322 | // chat.splice(0, chat.length, ...nativeChat);
323 | // //chat.splice(0, chat.length, ...nativeChat2);
324 | // context.clearChat();
325 | // context.printMessages();
326 | // context.eventSource.emit(context.eventTypes.CHAT_CHANGED, context.getCurrentChatId());
327 |
328 | // } catch (error) {
329 | // updateDebugLog(`替换聊天时出错: ${error.message}`);
330 | // console.error(error);
331 | // }
332 | // });
333 |
334 | // updateDebugLog('测试功能已初始化');
335 | });
--------------------------------------------------------------------------------
/ChatBridge_APIHijackForwarder.py:
--------------------------------------------------------------------------------
1 | """
2 | sequenceDiagram
3 | participant User as 外部应用
4 | participant UserAPI as 用户接口
5 | participant WS as WebSocket
6 | participant ST as SillyTavern
7 | participant STAPI as ST接口
8 | participant LLMAPI as LLM接口
9 | participant LLM as 外部LLM
10 |
11 | USER,ST,LLM均属外部逻辑,此脚本不应包含具体实现
12 |
13 | User->>UserAPI: 1.调用API(OpenAI格式)
14 | UserAPI->>WS: 2.转发请求到WebSocket
15 | WS->>ST: 3.通知ST处理请求
16 | ST->>STAPI: 4.处理后调用ST接口
17 | STAPI->>LLMAPI: 5.转发到LLM接口
18 | LLMAPI->>LLM: 6.调用外部LLM
19 | LLM-->>LLMAPI: 7.返回响应
20 | LLMAPI-┬->>STAPI: 8a.转发响应
21 | └->>UserAPI: 8b.同时转发响应
22 | STAPI-->ST: 9a.返回给ST
23 | UserAPI-->>User: 9b.返回给用户
24 | """
25 | # "REMOVED",
26 | # "base_url": "https://api.aiuvdt.top",
27 | #
28 | #"base_url": "https://generativelanguage.googleapis.com/v1beta/openai",
29 | import json
30 | import asyncio
31 | import websockets
32 | import aiohttp
33 | import logging
34 | import os
35 | from collections import deque
36 | import uuid
37 | from aiohttp import web
38 | from typing import List, Dict, Any
39 |
40 | logging.basicConfig(level=logging.INFO)
41 | logger = logging.getLogger(__name__)
42 |
43 | class APIKeyRotator:
44 | def __init__(self, api_keys: List[str]):
45 | self.api_keys = deque(api_keys)
46 |
47 | def get_next_key(self) -> str:
48 | current_key = self.api_keys[0]
49 | self.api_keys.rotate(-1)
50 | return current_key
51 |
52 | class ChatBridgeForwarder:
53 | def __init__(self, settings_path: str):
54 | with open(settings_path, 'r') as f:
55 | self.settings = json.load(f)
56 |
57 | self.ws_clients = set()
58 | self.key_rotator = APIKeyRotator(self.settings['llm_api']['api_keys'])
59 | self.response_futures = {}
60 |
61 | async def start(self):
62 | # 启动WebSocket服务器
63 | ws_server = websockets.serve(
64 | self.handle_websocket,
65 | self.settings['websocket']['host'],
66 | self.settings['websocket']['port']
67 | )
68 |
69 | # 创建ST API服务器
70 | st_app = web.Application()
71 | # 修改路由处理
72 | st_app.router.add_get('/models', self.handle_models)
73 | st_app.router.add_get('/v1/models', self.handle_models)
74 | st_app.router.add_post('/chat/completions', self.handle_chat_completions)
75 | st_app.router.add_post('/v1/chat/completions', self.handle_chat_completions)
76 |
77 | #初始化ST API服务器
78 | st_runner = web.AppRunner(st_app)
79 | await st_runner.setup()
80 | st_site = web.TCPSite(
81 | st_runner,
82 | self.settings['st_api']['host'],
83 | self.settings['st_api']['port']
84 | )
85 |
86 | # 创建用户API服务器
87 | user_app = web.Application()
88 | user_app.router.add_post('/v1/chat/completions', self.handle_user_api)
89 | user_runner = web.AppRunner(user_app)
90 | await user_runner.setup()
91 | user_site = web.TCPSite(
92 | user_runner,
93 | self.settings['user_api']['host'],
94 | self.settings['user_api']['port']
95 | )
96 |
97 | # 启动所有服务器
98 | await asyncio.gather(
99 | ws_server,
100 | st_site.start(),
101 | user_site.start()
102 | )
103 |
104 | logger.info(f"WebSocket服务器运行在 ws://{self.settings['websocket']['host']}:{self.settings['websocket']['port']}")
105 | logger.info(f"ST API服务器运行在 http://{self.settings['st_api']['host']}:{self.settings['st_api']['port']}")
106 | logger.info(f"用户API服务器运行在 http://{self.settings['user_api']['host']}:{self.settings['user_api']['port']}")
107 |
108 | async def handle_websocket(self, websocket):
109 | self.ws_clients.add(websocket)
110 | try:
111 | async for message in websocket:
112 | try:
113 | data = json.loads(message)
114 | logger.info(f"收到WebSocket消息: {data}")
115 |
116 | # 处理ST的响应
117 | if data.get('type') == 'st_response':
118 | request_id = data.get('id')
119 | if request_id in self.response_futures:
120 | future = self.response_futures[request_id]
121 | if not future.done():
122 | future.set_result(data.get('content'))
123 |
124 | except json.JSONDecodeError:
125 | logger.error("无效的WebSocket消息格式")
126 | finally:
127 | self.ws_clients.remove(websocket)
128 |
129 | async def handle_user_api(self, request: web.Request) -> web.Response:
130 | """处理来自用户的API请求"""
131 | if request.headers.get('Authorization') != f"Bearer {self.settings['user_api']['api_key']}":
132 | return web.Response(status=401)
133 |
134 | try:
135 | request_data = await request.json()
136 | request_id = str(uuid.uuid4())
137 | is_stream = request_data.get('stream', False)
138 | logger.info(f"用户API请求 ID={request_id}, stream={is_stream}")
139 |
140 | if is_stream:
141 | # 创建流式响应
142 | stream_response = web.StreamResponse(
143 | status=200,
144 | headers={
145 | 'Content-Type': 'text/event-stream',
146 | 'Cache-Control': 'no-cache',
147 | 'Connection': 'keep-alive'
148 | }
149 | )
150 | await stream_response.prepare(request)
151 |
152 | # 创建事件队列
153 | queue = asyncio.Queue()
154 | self.response_futures[request_id] = queue
155 |
156 | try:
157 | # 发送WebSocket消息
158 | ws_message = {
159 | 'type': 'user_request',
160 | 'id': request_id,
161 | 'content': request_data
162 | }
163 |
164 | if not self.ws_clients:
165 | return web.Response(status=503, text="No WebSocket clients connected")
166 |
167 | for ws in self.ws_clients:
168 | try:
169 | await ws.send(json.dumps(ws_message))
170 | logger.info(f"已发送请求到WebSocket: ID={request_id}")
171 | break
172 | except Exception as e:
173 | logger.error(f"发送WebSocket消息失败: {e}")
174 | continue
175 |
176 | # 等待并转发响应块
177 | received_chunks = []
178 | while True:
179 | try:
180 | chunk = await asyncio.wait_for(queue.get(), timeout=60.0)
181 |
182 | # 只处理非空的有效数据
183 | if chunk and isinstance(chunk, str):
184 | chunk = chunk.strip()
185 | if not chunk:
186 | continue
187 |
188 | if chunk == '[DONE]':
189 | await stream_response.write(b'data: [DONE]\n\n')
190 | logger.info(f"发送流式响应结束标记: ID={request_id}")
191 | break
192 |
193 | # 确保响应格式正确
194 | if not chunk.startswith('data: '):
195 | chunk = f'data: {chunk}'
196 | if not chunk.endswith('\n\n'):
197 | chunk = f'{chunk}\n\n'
198 |
199 | logger.debug(f"发送响应块: {chunk.strip()}")
200 | await stream_response.write(chunk.encode())
201 |
202 | except asyncio.TimeoutError:
203 | logger.warning(f"等待响应块超时: ID={request_id}")
204 | await stream_response.write(b'data: [DONE]\n\n')
205 | break
206 |
207 | return stream_response
208 |
209 | finally:
210 | # 清理队列
211 | self.response_futures.pop(request_id, None)
212 | else:
213 | # 处理非流式请求
214 | future = asyncio.Future()
215 | self.response_futures[request_id] = future
216 |
217 | # 发送WebSocket消息
218 | ws_message = {
219 | 'type': 'user_request',
220 | 'id': request_id,
221 | 'content': request_data
222 | }
223 |
224 | if not self.ws_clients:
225 | return web.Response(status=503, text="No WebSocket clients connected")
226 |
227 | for ws in self.ws_clients:
228 | try:
229 | await ws.send(json.dumps(ws_message))
230 | logger.info(f"已发送请求到WebSocket: ID={request_id}")
231 | break
232 | except Exception as e:
233 | logger.error(f"发送WebSocket消息失败: {e}")
234 | continue
235 |
236 | try:
237 | # 等待响应
238 | response = await asyncio.wait_for(future, timeout=60.0)
239 | return web.json_response(response)
240 | finally:
241 | self.response_futures.pop(request_id, None)
242 |
243 | except Exception as e:
244 | logger.error(f"处理用户API请求失败: {str(e)}", exc_info=True)
245 | return web.Response(status=500, text=f"Internal Server Error: {str(e)}")
246 |
247 | async def handle_models(self, request: web.Request) -> web.Response:
248 | """处理模型列表请求"""
249 | logger.info(f"收到models请求: {request.path}")
250 | api_key = self.key_rotator.get_next_key()
251 | headers = {
252 | 'Authorization': f'Bearer {api_key}',
253 | 'Content-Type': 'application/json'
254 | }
255 |
256 | try:
257 | async with aiohttp.ClientSession() as session:
258 | #remove v1/ of llm_api
259 | target_url = f"{self.settings['llm_api']['base_url']}/models"
260 | logger.info(f"转发请求到: {target_url}")
261 | async with session.get(target_url, headers=headers) as response:
262 | response_data = await response.json()
263 | logger.info(f"模型列表响应: {response_data}")
264 | return web.json_response(response_data)
265 | except Exception as e:
266 | logger.error(f"获取模型列表失败: {str(e)}")
267 | return web.Response(status=500, text=str(e))
268 |
269 | async def handle_chat_completions(self, request: web.Request) -> web.Response:
270 | try:
271 | request_data = await request.json()
272 | is_stream = request_data.get('stream', False)
273 | logger.info(f"收到chat completion请求: PATH={request.path}, STREAM={is_stream}")
274 |
275 | # 找到活跃的用户请求
276 | active_user_futures = {
277 | rid: future for rid, future in self.response_futures.items()
278 | if not getattr(future, 'done', lambda: True)()
279 | }
280 |
281 | if active_user_futures:
282 | logger.info(f"找到 {len(active_user_futures)} 个活跃的用户请求")
283 | else:
284 | logger.warning("没有找到活跃的用户请求")
285 |
286 | api_key = self.key_rotator.get_next_key()
287 | headers = {
288 | 'Authorization': f'Bearer {api_key}',
289 | 'Content-Type': 'application/json'
290 | }
291 | target_url = f"{self.settings['llm_api']['base_url']}/chat/completions"
292 |
293 | async with aiohttp.ClientSession() as session:
294 | async with session.post(target_url, json=request_data, headers=headers) as llm_response:
295 | if llm_response.headers.get('content-type') == 'text/event-stream':
296 | logger.info("处理流式响应")
297 | st_response = web.StreamResponse(
298 | status=llm_response.status,
299 | headers={'Content-Type': 'text/event-stream'}
300 | )
301 | await st_response.prepare(request)
302 |
303 | active_user_queues = {
304 | rid: queue for rid, queue in self.response_futures.items()
305 | if isinstance(queue, asyncio.Queue)
306 | }
307 |
308 | async for chunk in llm_response.content:
309 | if chunk:
310 | chunk_str = chunk.decode()
311 | logger.debug(f"收到数据块: {chunk_str[:100]}...")
312 |
313 | # 发送到ST
314 | await st_response.write(chunk)
315 |
316 | # 转发到用户队列
317 | if active_user_queues:
318 | for queue_id, queue in active_user_queues.items():
319 | try:
320 | await queue.put(chunk_str)
321 | logger.debug(f"转发数据块到用户队列 {queue_id}")
322 | except Exception as e:
323 | logger.error(f"转发到用户队列失败 {queue_id}: {e}")
324 |
325 | # 发送结束标记
326 | if active_user_queues:
327 | for queue_id, queue in active_user_queues.items():
328 | try:
329 | await queue.put('[DONE]')
330 | logger.info(f"发送结束标记到用户队列 {queue_id}")
331 | except Exception as e:
332 | logger.error(f"发送结束标记失败 {queue_id}: {e}")
333 |
334 | return st_response
335 |
336 | else:
337 | logger.info("处理非流式响应")
338 | response_data = await llm_response.json()
339 | logger.info(f"收到LLM响应: {str(response_data)[:200]}...")
340 |
341 | # 转发到所有等待的用户请求
342 | futures_updated = False
343 | for request_id, future in list(active_user_futures.items()):
344 | try:
345 | if isinstance(future, asyncio.Future) and not future.done():
346 | future.set_result(response_data)
347 | logger.info(f"成功设置用户请求结果: ID={request_id}")
348 | futures_updated = True
349 | except Exception as e:
350 | logger.error(f"设置用户请求结果失败 {request_id}: {e}")
351 |
352 | if not futures_updated:
353 | logger.warning("没有成功更新任何用户请求的结果")
354 |
355 | return web.json_response(response_data, status=llm_response.status)
356 |
357 | except Exception as e:
358 | error_msg = f"处理聊天完成请求失败: {str(e)}"
359 | logger.error(error_msg, exc_info=True)
360 | return web.Response(status=500, text=error_msg)
361 |
362 | async def main():
363 | settings_path = os.path.join(os.path.dirname(__file__), 'settings.json')
364 | forwarder = ChatBridgeForwarder(settings_path)
365 | await forwarder.start()
366 | try:
367 | await asyncio.Future() # 保持服务器运行
368 | except KeyboardInterrupt:
369 | pass
370 |
371 | if __name__ == "__main__":
372 | asyncio.run(main())
373 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU AFFERO GENERAL PUBLIC LICENSE
2 | Version 3, 19 November 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU Affero General Public License is a free, copyleft license for
11 | software and other kinds of works, specifically designed to ensure
12 | cooperation with the community in the case of network server software.
13 |
14 | The licenses for most software and other practical works are designed
15 | to take away your freedom to share and change the works. By contrast,
16 | our General Public Licenses are intended to guarantee your freedom to
17 | share and change all versions of a program--to make sure it remains free
18 | software for all its users.
19 |
20 | When we speak of free software, we are referring to freedom, not
21 | price. Our General Public Licenses are designed to make sure that you
22 | have the freedom to distribute copies of free software (and charge for
23 | them if you wish), that you receive source code or can get it if you
24 | want it, that you can change the software or use pieces of it in new
25 | free programs, and that you know you can do these things.
26 |
27 | Developers that use our General Public Licenses protect your rights
28 | with two steps: (1) assert copyright on the software, and (2) offer
29 | you this License which gives you legal permission to copy, distribute
30 | and/or modify the software.
31 |
32 | A secondary benefit of defending all users' freedom is that
33 | improvements made in alternate versions of the program, if they
34 | receive widespread use, become available for other developers to
35 | incorporate. Many developers of free software are heartened and
36 | encouraged by the resulting cooperation. However, in the case of
37 | software used on network servers, this result may fail to come about.
38 | The GNU General Public License permits making a modified version and
39 | letting the public access it on a server without ever releasing its
40 | source code to the public.
41 |
42 | The GNU Affero General Public License is designed specifically to
43 | ensure that, in such cases, the modified source code becomes available
44 | to the community. It requires the operator of a network server to
45 | provide the source code of the modified version running there to the
46 | users of that server. Therefore, public use of a modified version, on
47 | a publicly accessible server, gives the public access to the source
48 | code of the modified version.
49 |
50 | An older license, called the Affero General Public License and
51 | published by Affero, was designed to accomplish similar goals. This is
52 | a different license, not a version of the Affero GPL, but Affero has
53 | released a new version of the Affero GPL which permits relicensing under
54 | this license.
55 |
56 | The precise terms and conditions for copying, distribution and
57 | modification follow.
58 |
59 | TERMS AND CONDITIONS
60 |
61 | 0. Definitions.
62 |
63 | "This License" refers to version 3 of the GNU Affero General Public License.
64 |
65 | "Copyright" also means copyright-like laws that apply to other kinds of
66 | works, such as semiconductor masks.
67 |
68 | "The Program" refers to any copyrightable work licensed under this
69 | License. Each licensee is addressed as "you". "Licensees" and
70 | "recipients" may be individuals or organizations.
71 |
72 | To "modify" a work means to copy from or adapt all or part of the work
73 | in a fashion requiring copyright permission, other than the making of an
74 | exact copy. The resulting work is called a "modified version" of the
75 | earlier work or a work "based on" the earlier work.
76 |
77 | A "covered work" means either the unmodified Program or a work based
78 | on the Program.
79 |
80 | To "propagate" a work means to do anything with it that, without
81 | permission, would make you directly or secondarily liable for
82 | infringement under applicable copyright law, except executing it on a
83 | computer or modifying a private copy. Propagation includes copying,
84 | distribution (with or without modification), making available to the
85 | public, and in some countries other activities as well.
86 |
87 | To "convey" a work means any kind of propagation that enables other
88 | parties to make or receive copies. Mere interaction with a user through
89 | a computer network, with no transfer of a copy, is not conveying.
90 |
91 | An interactive user interface displays "Appropriate Legal Notices"
92 | to the extent that it includes a convenient and prominently visible
93 | feature that (1) displays an appropriate copyright notice, and (2)
94 | tells the user that there is no warranty for the work (except to the
95 | extent that warranties are provided), that licensees may convey the
96 | work under this License, and how to view a copy of this License. If
97 | the interface presents a list of user commands or options, such as a
98 | menu, a prominent item in the list meets this criterion.
99 |
100 | 1. Source Code.
101 |
102 | The "source code" for a work means the preferred form of the work
103 | for making modifications to it. "Object code" means any non-source
104 | form of a work.
105 |
106 | A "Standard Interface" means an interface that either is an official
107 | standard defined by a recognized standards body, or, in the case of
108 | interfaces specified for a particular programming language, one that
109 | is widely used among developers working in that language.
110 |
111 | The "System Libraries" of an executable work include anything, other
112 | than the work as a whole, that (a) is included in the normal form of
113 | packaging a Major Component, but which is not part of that Major
114 | Component, and (b) serves only to enable use of the work with that
115 | Major Component, or to implement a Standard Interface for which an
116 | implementation is available to the public in source code form. A
117 | "Major Component", in this context, means a major essential component
118 | (kernel, window system, and so on) of the specific operating system
119 | (if any) on which the executable work runs, or a compiler used to
120 | produce the work, or an object code interpreter used to run it.
121 |
122 | The "Corresponding Source" for a work in object code form means all
123 | the source code needed to generate, install, and (for an executable
124 | work) run the object code and to modify the work, including scripts to
125 | control those activities. However, it does not include the work's
126 | System Libraries, or general-purpose tools or generally available free
127 | programs which are used unmodified in performing those activities but
128 | which are not part of the work. For example, Corresponding Source
129 | includes interface definition files associated with source files for
130 | the work, and the source code for shared libraries and dynamically
131 | linked subprograms that the work is specifically designed to require,
132 | such as by intimate data communication or control flow between those
133 | subprograms and other parts of the work.
134 |
135 | The Corresponding Source need not include anything that users
136 | can regenerate automatically from other parts of the Corresponding
137 | Source.
138 |
139 | The Corresponding Source for a work in source code form is that
140 | same work.
141 |
142 | 2. Basic Permissions.
143 |
144 | All rights granted under this License are granted for the term of
145 | copyright on the Program, and are irrevocable provided the stated
146 | conditions are met. This License explicitly affirms your unlimited
147 | permission to run the unmodified Program. The output from running a
148 | covered work is covered by this License only if the output, given its
149 | content, constitutes a covered work. This License acknowledges your
150 | rights of fair use or other equivalent, as provided by copyright law.
151 |
152 | You may make, run and propagate covered works that you do not
153 | convey, without conditions so long as your license otherwise remains
154 | in force. You may convey covered works to others for the sole purpose
155 | of having them make modifications exclusively for you, or provide you
156 | with facilities for running those works, provided that you comply with
157 | the terms of this License in conveying all material for which you do
158 | not control copyright. Those thus making or running the covered works
159 | for you must do so exclusively on your behalf, under your direction
160 | and control, on terms that prohibit them from making any copies of
161 | your copyrighted material outside their relationship with you.
162 |
163 | Conveying under any other circumstances is permitted solely under
164 | the conditions stated below. Sublicensing is not allowed; section 10
165 | makes it unnecessary.
166 |
167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
168 |
169 | No covered work shall be deemed part of an effective technological
170 | measure under any applicable law fulfilling obligations under article
171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
172 | similar laws prohibiting or restricting circumvention of such
173 | measures.
174 |
175 | When you convey a covered work, you waive any legal power to forbid
176 | circumvention of technological measures to the extent such circumvention
177 | is effected by exercising rights under this License with respect to
178 | the covered work, and you disclaim any intention to limit operation or
179 | modification of the work as a means of enforcing, against the work's
180 | users, your or third parties' legal rights to forbid circumvention of
181 | technological measures.
182 |
183 | 4. Conveying Verbatim Copies.
184 |
185 | You may convey verbatim copies of the Program's source code as you
186 | receive it, in any medium, provided that you conspicuously and
187 | appropriately publish on each copy an appropriate copyright notice;
188 | keep intact all notices stating that this License and any
189 | non-permissive terms added in accord with section 7 apply to the code;
190 | keep intact all notices of the absence of any warranty; and give all
191 | recipients a copy of this License along with the Program.
192 |
193 | You may charge any price or no price for each copy that you convey,
194 | and you may offer support or warranty protection for a fee.
195 |
196 | 5. Conveying Modified Source Versions.
197 |
198 | You may convey a work based on the Program, or the modifications to
199 | produce it from the Program, in the form of source code under the
200 | terms of section 4, provided that you also meet all of these conditions:
201 |
202 | a) The work must carry prominent notices stating that you modified
203 | it, and giving a relevant date.
204 |
205 | b) The work must carry prominent notices stating that it is
206 | released under this License and any conditions added under section
207 | 7. This requirement modifies the requirement in section 4 to
208 | "keep intact all notices".
209 |
210 | c) You must license the entire work, as a whole, under this
211 | License to anyone who comes into possession of a copy. This
212 | License will therefore apply, along with any applicable section 7
213 | additional terms, to the whole of the work, and all its parts,
214 | regardless of how they are packaged. This License gives no
215 | permission to license the work in any other way, but it does not
216 | invalidate such permission if you have separately received it.
217 |
218 | d) If the work has interactive user interfaces, each must display
219 | Appropriate Legal Notices; however, if the Program has interactive
220 | interfaces that do not display Appropriate Legal Notices, your
221 | work need not make them do so.
222 |
223 | A compilation of a covered work with other separate and independent
224 | works, which are not by their nature extensions of the covered work,
225 | and which are not combined with it such as to form a larger program,
226 | in or on a volume of a storage or distribution medium, is called an
227 | "aggregate" if the compilation and its resulting copyright are not
228 | used to limit the access or legal rights of the compilation's users
229 | beyond what the individual works permit. Inclusion of a covered work
230 | in an aggregate does not cause this License to apply to the other
231 | parts of the aggregate.
232 |
233 | 6. Conveying Non-Source Forms.
234 |
235 | You may convey a covered work in object code form under the terms
236 | of sections 4 and 5, provided that you also convey the
237 | machine-readable Corresponding Source under the terms of this License,
238 | in one of these ways:
239 |
240 | a) Convey the object code in, or embodied in, a physical product
241 | (including a physical distribution medium), accompanied by the
242 | Corresponding Source fixed on a durable physical medium
243 | customarily used for software interchange.
244 |
245 | b) Convey the object code in, or embodied in, a physical product
246 | (including a physical distribution medium), accompanied by a
247 | written offer, valid for at least three years and valid for as
248 | long as you offer spare parts or customer support for that product
249 | model, to give anyone who possesses the object code either (1) a
250 | copy of the Corresponding Source for all the software in the
251 | product that is covered by this License, on a durable physical
252 | medium customarily used for software interchange, for a price no
253 | more than your reasonable cost of physically performing this
254 | conveying of source, or (2) access to copy the
255 | Corresponding Source from a network server at no charge.
256 |
257 | c) Convey individual copies of the object code with a copy of the
258 | written offer to provide the Corresponding Source. This
259 | alternative is allowed only occasionally and noncommercially, and
260 | only if you received the object code with such an offer, in accord
261 | with subsection 6b.
262 |
263 | d) Convey the object code by offering access from a designated
264 | place (gratis or for a charge), and offer equivalent access to the
265 | Corresponding Source in the same way through the same place at no
266 | further charge. You need not require recipients to copy the
267 | Corresponding Source along with the object code. If the place to
268 | copy the object code is a network server, the Corresponding Source
269 | may be on a different server (operated by you or a third party)
270 | that supports equivalent copying facilities, provided you maintain
271 | clear directions next to the object code saying where to find the
272 | Corresponding Source. Regardless of what server hosts the
273 | Corresponding Source, you remain obligated to ensure that it is
274 | available for as long as needed to satisfy these requirements.
275 |
276 | e) Convey the object code using peer-to-peer transmission, provided
277 | you inform other peers where the object code and Corresponding
278 | Source of the work are being offered to the general public at no
279 | charge under subsection 6d.
280 |
281 | A separable portion of the object code, whose source code is excluded
282 | from the Corresponding Source as a System Library, need not be
283 | included in conveying the object code work.
284 |
285 | A "User Product" is either (1) a "consumer product", which means any
286 | tangible personal property which is normally used for personal, family,
287 | or household purposes, or (2) anything designed or sold for incorporation
288 | into a dwelling. In determining whether a product is a consumer product,
289 | doubtful cases shall be resolved in favor of coverage. For a particular
290 | product received by a particular user, "normally used" refers to a
291 | typical or common use of that class of product, regardless of the status
292 | of the particular user or of the way in which the particular user
293 | actually uses, or expects or is expected to use, the product. A product
294 | is a consumer product regardless of whether the product has substantial
295 | commercial, industrial or non-consumer uses, unless such uses represent
296 | the only significant mode of use of the product.
297 |
298 | "Installation Information" for a User Product means any methods,
299 | procedures, authorization keys, or other information required to install
300 | and execute modified versions of a covered work in that User Product from
301 | a modified version of its Corresponding Source. The information must
302 | suffice to ensure that the continued functioning of the modified object
303 | code is in no case prevented or interfered with solely because
304 | modification has been made.
305 |
306 | If you convey an object code work under this section in, or with, or
307 | specifically for use in, a User Product, and the conveying occurs as
308 | part of a transaction in which the right of possession and use of the
309 | User Product is transferred to the recipient in perpetuity or for a
310 | fixed term (regardless of how the transaction is characterized), the
311 | Corresponding Source conveyed under this section must be accompanied
312 | by the Installation Information. But this requirement does not apply
313 | if neither you nor any third party retains the ability to install
314 | modified object code on the User Product (for example, the work has
315 | been installed in ROM).
316 |
317 | The requirement to provide Installation Information does not include a
318 | requirement to continue to provide support service, warranty, or updates
319 | for a work that has been modified or installed by the recipient, or for
320 | the User Product in which it has been modified or installed. Access to a
321 | network may be denied when the modification itself materially and
322 | adversely affects the operation of the network or violates the rules and
323 | protocols for communication across the network.
324 |
325 | Corresponding Source conveyed, and Installation Information provided,
326 | in accord with this section must be in a format that is publicly
327 | documented (and with an implementation available to the public in
328 | source code form), and must require no special password or key for
329 | unpacking, reading or copying.
330 |
331 | 7. Additional Terms.
332 |
333 | "Additional permissions" are terms that supplement the terms of this
334 | License by making exceptions from one or more of its conditions.
335 | Additional permissions that are applicable to the entire Program shall
336 | be treated as though they were included in this License, to the extent
337 | that they are valid under applicable law. If additional permissions
338 | apply only to part of the Program, that part may be used separately
339 | under those permissions, but the entire Program remains governed by
340 | this License without regard to the additional permissions.
341 |
342 | When you convey a copy of a covered work, you may at your option
343 | remove any additional permissions from that copy, or from any part of
344 | it. (Additional permissions may be written to require their own
345 | removal in certain cases when you modify the work.) You may place
346 | additional permissions on material, added by you to a covered work,
347 | for which you have or can give appropriate copyright permission.
348 |
349 | Notwithstanding any other provision of this License, for material you
350 | add to a covered work, you may (if authorized by the copyright holders of
351 | that material) supplement the terms of this License with terms:
352 |
353 | a) Disclaiming warranty or limiting liability differently from the
354 | terms of sections 15 and 16 of this License; or
355 |
356 | b) Requiring preservation of specified reasonable legal notices or
357 | author attributions in that material or in the Appropriate Legal
358 | Notices displayed by works containing it; or
359 |
360 | c) Prohibiting misrepresentation of the origin of that material, or
361 | requiring that modified versions of such material be marked in
362 | reasonable ways as different from the original version; or
363 |
364 | d) Limiting the use for publicity purposes of names of licensors or
365 | authors of the material; or
366 |
367 | e) Declining to grant rights under trademark law for use of some
368 | trade names, trademarks, or service marks; or
369 |
370 | f) Requiring indemnification of licensors and authors of that
371 | material by anyone who conveys the material (or modified versions of
372 | it) with contractual assumptions of liability to the recipient, for
373 | any liability that these contractual assumptions directly impose on
374 | those licensors and authors.
375 |
376 | All other non-permissive additional terms are considered "further
377 | restrictions" within the meaning of section 10. If the Program as you
378 | received it, or any part of it, contains a notice stating that it is
379 | governed by this License along with a term that is a further
380 | restriction, you may remove that term. If a license document contains
381 | a further restriction but permits relicensing or conveying under this
382 | License, you may add to a covered work material governed by the terms
383 | of that license document, provided that the further restriction does
384 | not survive such relicensing or conveying.
385 |
386 | If you add terms to a covered work in accord with this section, you
387 | must place, in the relevant source files, a statement of the
388 | additional terms that apply to those files, or a notice indicating
389 | where to find the applicable terms.
390 |
391 | Additional terms, permissive or non-permissive, may be stated in the
392 | form of a separately written license, or stated as exceptions;
393 | the above requirements apply either way.
394 |
395 | 8. Termination.
396 |
397 | You may not propagate or modify a covered work except as expressly
398 | provided under this License. Any attempt otherwise to propagate or
399 | modify it is void, and will automatically terminate your rights under
400 | this License (including any patent licenses granted under the third
401 | paragraph of section 11).
402 |
403 | However, if you cease all violation of this License, then your
404 | license from a particular copyright holder is reinstated (a)
405 | provisionally, unless and until the copyright holder explicitly and
406 | finally terminates your license, and (b) permanently, if the copyright
407 | holder fails to notify you of the violation by some reasonable means
408 | prior to 60 days after the cessation.
409 |
410 | Moreover, your license from a particular copyright holder is
411 | reinstated permanently if the copyright holder notifies you of the
412 | violation by some reasonable means, this is the first time you have
413 | received notice of violation of this License (for any work) from that
414 | copyright holder, and you cure the violation prior to 30 days after
415 | your receipt of the notice.
416 |
417 | Termination of your rights under this section does not terminate the
418 | licenses of parties who have received copies or rights from you under
419 | this License. If your rights have been terminated and not permanently
420 | reinstated, you do not qualify to receive new licenses for the same
421 | material under section 10.
422 |
423 | 9. Acceptance Not Required for Having Copies.
424 |
425 | You are not required to accept this License in order to receive or
426 | run a copy of the Program. Ancillary propagation of a covered work
427 | occurring solely as a consequence of using peer-to-peer transmission
428 | to receive a copy likewise does not require acceptance. However,
429 | nothing other than this License grants you permission to propagate or
430 | modify any covered work. These actions infringe copyright if you do
431 | not accept this License. Therefore, by modifying or propagating a
432 | covered work, you indicate your acceptance of this License to do so.
433 |
434 | 10. Automatic Licensing of Downstream Recipients.
435 |
436 | Each time you convey a covered work, the recipient automatically
437 | receives a license from the original licensors, to run, modify and
438 | propagate that work, subject to this License. You are not responsible
439 | for enforcing compliance by third parties with this License.
440 |
441 | An "entity transaction" is a transaction transferring control of an
442 | organization, or substantially all assets of one, or subdividing an
443 | organization, or merging organizations. If propagation of a covered
444 | work results from an entity transaction, each party to that
445 | transaction who receives a copy of the work also receives whatever
446 | licenses to the work the party's predecessor in interest had or could
447 | give under the previous paragraph, plus a right to possession of the
448 | Corresponding Source of the work from the predecessor in interest, if
449 | the predecessor has it or can get it with reasonable efforts.
450 |
451 | You may not impose any further restrictions on the exercise of the
452 | rights granted or affirmed under this License. For example, you may
453 | not impose a license fee, royalty, or other charge for exercise of
454 | rights granted under this License, and you may not initiate litigation
455 | (including a cross-claim or counterclaim in a lawsuit) alleging that
456 | any patent claim is infringed by making, using, selling, offering for
457 | sale, or importing the Program or any portion of it.
458 |
459 | 11. Patents.
460 |
461 | A "contributor" is a copyright holder who authorizes use under this
462 | License of the Program or a work on which the Program is based. The
463 | work thus licensed is called the contributor's "contributor version".
464 |
465 | A contributor's "essential patent claims" are all patent claims
466 | owned or controlled by the contributor, whether already acquired or
467 | hereafter acquired, that would be infringed by some manner, permitted
468 | by this License, of making, using, or selling its contributor version,
469 | but do not include claims that would be infringed only as a
470 | consequence of further modification of the contributor version. For
471 | purposes of this definition, "control" includes the right to grant
472 | patent sublicenses in a manner consistent with the requirements of
473 | this License.
474 |
475 | Each contributor grants you a non-exclusive, worldwide, royalty-free
476 | patent license under the contributor's essential patent claims, to
477 | make, use, sell, offer for sale, import and otherwise run, modify and
478 | propagate the contents of its contributor version.
479 |
480 | In the following three paragraphs, a "patent license" is any express
481 | agreement or commitment, however denominated, not to enforce a patent
482 | (such as an express permission to practice a patent or covenant not to
483 | sue for patent infringement). To "grant" such a patent license to a
484 | party means to make such an agreement or commitment not to enforce a
485 | patent against the party.
486 |
487 | If you convey a covered work, knowingly relying on a patent license,
488 | and the Corresponding Source of the work is not available for anyone
489 | to copy, free of charge and under the terms of this License, through a
490 | publicly available network server or other readily accessible means,
491 | then you must either (1) cause the Corresponding Source to be so
492 | available, or (2) arrange to deprive yourself of the benefit of the
493 | patent license for this particular work, or (3) arrange, in a manner
494 | consistent with the requirements of this License, to extend the patent
495 | license to downstream recipients. "Knowingly relying" means you have
496 | actual knowledge that, but for the patent license, your conveying the
497 | covered work in a country, or your recipient's use of the covered work
498 | in a country, would infringe one or more identifiable patents in that
499 | country that you have reason to believe are valid.
500 |
501 | If, pursuant to or in connection with a single transaction or
502 | arrangement, you convey, or propagate by procuring conveyance of, a
503 | covered work, and grant a patent license to some of the parties
504 | receiving the covered work authorizing them to use, propagate, modify
505 | or convey a specific copy of the covered work, then the patent license
506 | you grant is automatically extended to all recipients of the covered
507 | work and works based on it.
508 |
509 | A patent license is "discriminatory" if it does not include within
510 | the scope of its coverage, prohibits the exercise of, or is
511 | conditioned on the non-exercise of one or more of the rights that are
512 | specifically granted under this License. You may not convey a covered
513 | work if you are a party to an arrangement with a third party that is
514 | in the business of distributing software, under which you make payment
515 | to the third party based on the extent of your activity of conveying
516 | the work, and under which the third party grants, to any of the
517 | parties who would receive the covered work from you, a discriminatory
518 | patent license (a) in connection with copies of the covered work
519 | conveyed by you (or copies made from those copies), or (b) primarily
520 | for and in connection with specific products or compilations that
521 | contain the covered work, unless you entered into that arrangement,
522 | or that patent license was granted, prior to 28 March 2007.
523 |
524 | Nothing in this License shall be construed as excluding or limiting
525 | any implied license or other defenses to infringement that may
526 | otherwise be available to you under applicable patent law.
527 |
528 | 12. No Surrender of Others' Freedom.
529 |
530 | If conditions are imposed on you (whether by court order, agreement or
531 | otherwise) that contradict the conditions of this License, they do not
532 | excuse you from the conditions of this License. If you cannot convey a
533 | covered work so as to satisfy simultaneously your obligations under this
534 | License and any other pertinent obligations, then as a consequence you may
535 | not convey it at all. For example, if you agree to terms that obligate you
536 | to collect a royalty for further conveying from those to whom you convey
537 | the Program, the only way you could satisfy both those terms and this
538 | License would be to refrain entirely from conveying the Program.
539 |
540 | 13. Remote Network Interaction; Use with the GNU General Public License.
541 |
542 | Notwithstanding any other provision of this License, if you modify the
543 | Program, your modified version must prominently offer all users
544 | interacting with it remotely through a computer network (if your version
545 | supports such interaction) an opportunity to receive the Corresponding
546 | Source of your version by providing access to the Corresponding Source
547 | from a network server at no charge, through some standard or customary
548 | means of facilitating copying of software. This Corresponding Source
549 | shall include the Corresponding Source for any work covered by version 3
550 | of the GNU General Public License that is incorporated pursuant to the
551 | following paragraph.
552 |
553 | Notwithstanding any other provision of this License, you have
554 | permission to link or combine any covered work with a work licensed
555 | under version 3 of the GNU General Public License into a single
556 | combined work, and to convey the resulting work. The terms of this
557 | License will continue to apply to the part which is the covered work,
558 | but the work with which it is combined will remain governed by version
559 | 3 of the GNU General Public License.
560 |
561 | 14. Revised Versions of this License.
562 |
563 | The Free Software Foundation may publish revised and/or new versions of
564 | the GNU Affero General Public License from time to time. Such new versions
565 | will be similar in spirit to the present version, but may differ in detail to
566 | address new problems or concerns.
567 |
568 | Each version is given a distinguishing version number. If the
569 | Program specifies that a certain numbered version of the GNU Affero General
570 | Public License "or any later version" applies to it, you have the
571 | option of following the terms and conditions either of that numbered
572 | version or of any later version published by the Free Software
573 | Foundation. If the Program does not specify a version number of the
574 | GNU Affero General Public License, you may choose any version ever published
575 | by the Free Software Foundation.
576 |
577 | If the Program specifies that a proxy can decide which future
578 | versions of the GNU Affero General Public License can be used, that proxy's
579 | public statement of acceptance of a version permanently authorizes you
580 | to choose that version for the Program.
581 |
582 | Later license versions may give you additional or different
583 | permissions. However, no additional obligations are imposed on any
584 | author or copyright holder as a result of your choosing to follow a
585 | later version.
586 |
587 | 15. Disclaimer of Warranty.
588 |
589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
597 |
598 | 16. Limitation of Liability.
599 |
600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
608 | SUCH DAMAGES.
609 |
610 | 17. Interpretation of Sections 15 and 16.
611 |
612 | If the disclaimer of warranty and limitation of liability provided
613 | above cannot be given local legal effect according to their terms,
614 | reviewing courts shall apply local law that most closely approximates
615 | an absolute waiver of all civil liability in connection with the
616 | Program, unless a warranty or assumption of liability accompanies a
617 | copy of the Program in return for a fee.
618 |
619 | END OF TERMS AND CONDITIONS
620 |
621 | How to Apply These Terms to Your New Programs
622 |
623 | If you develop a new program, and you want it to be of the greatest
624 | possible use to the public, the best way to achieve this is to make it
625 | free software which everyone can redistribute and change under these terms.
626 |
627 | To do so, attach the following notices to the program. It is safest
628 | to attach them to the start of each source file to most effectively
629 | state the exclusion of warranty; and each file should have at least
630 | the "copyright" line and a pointer to where the full notice is found.
631 |
632 |
633 | Copyright (C)
634 |
635 | This program is free software: you can redistribute it and/or modify
636 | it under the terms of the GNU Affero General Public License as published
637 | by the Free Software Foundation, either version 3 of the License, or
638 | (at your option) any later version.
639 |
640 | This program is distributed in the hope that it will be useful,
641 | but WITHOUT ANY WARRANTY; without even the implied warranty of
642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
643 | GNU Affero General Public License for more details.
644 |
645 | You should have received a copy of the GNU Affero General Public License
646 | along with this program. If not, see .
647 |
648 | Also add information on how to contact you by electronic and paper mail.
649 |
650 | If your software can interact with users remotely through a computer
651 | network, you should also make sure that it provides a way for users to
652 | get its source. For example, if your program is a web application, its
653 | interface could display a "Source" link that leads users to an archive
654 | of the code. There are many ways you could offer source, and different
655 | solutions will be better for different programs; see section 13 for the
656 | specific requirements.
657 |
658 | You should also get your employer (if you work as a programmer) or school,
659 | if any, to sign a "copyright disclaimer" for the program, if necessary.
660 | For more information on this, and how to apply and follow the GNU AGPL, see
661 | .
662 |
--------------------------------------------------------------------------------