├── .gitignore ├── aify.xpi ├── screenshots ├── example.png ├── example1.png └── example2.png ├── plugin ├── images │ ├── loading.png │ ├── warning.png │ ├── icon-16px.png │ ├── icon-32px.png │ └── icon-64px.png ├── background.js ├── html │ ├── actions.css │ ├── actions.html │ ├── draft.html │ ├── chat.html │ ├── chat.css │ ├── globals.js │ ├── API.js │ ├── draft.js │ ├── styles.css │ ├── actions.js │ ├── chat.js │ ├── settings.html │ └── settings.js ├── manifest.json └── content_scripts │ └── compose.js ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | *~ 2 | \#*\# 3 | plugin/*~ 4 | plugin/\#*\# -------------------------------------------------------------------------------- /aify.xpi: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ali-raheem/Aify/HEAD/aify.xpi -------------------------------------------------------------------------------- /screenshots/example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ali-raheem/Aify/HEAD/screenshots/example.png -------------------------------------------------------------------------------- /plugin/images/loading.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ali-raheem/Aify/HEAD/plugin/images/loading.png -------------------------------------------------------------------------------- /plugin/images/warning.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ali-raheem/Aify/HEAD/plugin/images/warning.png -------------------------------------------------------------------------------- /screenshots/example1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ali-raheem/Aify/HEAD/screenshots/example1.png -------------------------------------------------------------------------------- /screenshots/example2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ali-raheem/Aify/HEAD/screenshots/example2.png -------------------------------------------------------------------------------- /plugin/images/icon-16px.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ali-raheem/Aify/HEAD/plugin/images/icon-16px.png -------------------------------------------------------------------------------- /plugin/images/icon-32px.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ali-raheem/Aify/HEAD/plugin/images/icon-32px.png -------------------------------------------------------------------------------- /plugin/images/icon-64px.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ali-raheem/Aify/HEAD/plugin/images/icon-64px.png -------------------------------------------------------------------------------- /plugin/background.js: -------------------------------------------------------------------------------- 1 | browser.composeScripts.register({ 2 | js: [{file: "/content_scripts/compose.js"}] 3 | }); 4 | -------------------------------------------------------------------------------- /plugin/html/actions.css: -------------------------------------------------------------------------------- 1 | .button { 2 | color: white; 3 | padding: 12px 20px; 4 | border: none; 5 | border-radius: 4px; 6 | cursor: pointer; 7 | } 8 | .neutral { 9 | background-color: cadetblue; 10 | } 11 | .bad { 12 | background-color: crimson; 13 | } 14 | .good { 15 | background-color: #04aa6d; 16 | } 17 | .small-icon { 18 | height: 8px; 19 | width: 8px; 20 | } -------------------------------------------------------------------------------- /plugin/html/actions.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Actions 5 | 6 | 7 | 8 |
9 |
10 | Chat

11 | Settings 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /plugin/html/draft.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Aify 5 | 6 | 7 | 8 | 9 |
10 | 11 |
12 |
13 |
14 |
15 |
16 |
17 | 18 | 19 | -------------------------------------------------------------------------------- /plugin/html/chat.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Aify Chat 5 | 6 | 7 | 8 | 9 |
10 |
11 | 12 |
13 |
14 | 15 | 16 | 17 |
18 |
19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /plugin/html/chat.css: -------------------------------------------------------------------------------- 1 | body { 2 | margin: 0; 3 | padding: 0; 4 | font-family: Arial, sans-serif; 5 | } 6 | 7 | .chat-container { 8 | height: 100vh; 9 | display: flex; 10 | flex-direction: column; 11 | } 12 | 13 | .messages { 14 | flex-grow: 1; 15 | overflow-y: auto; 16 | padding: 10px; 17 | border-bottom: 1px solid #ccc; 18 | } 19 | 20 | .chat-input-area { 21 | display: flex; 22 | justify-content: space-between; 23 | align-items: center; 24 | padding: 10px; 25 | height: 15%; 26 | } 27 | 28 | #message-input { 29 | flex-grow: 1; 30 | margin-right: 10px; 31 | height: 80%; 32 | } 33 | 34 | .system-message { 35 | background-color:hotpink; 36 | } 37 | 38 | .user-message { 39 | background-color: blanchedalmond; 40 | } 41 | 42 | .assistant-message { 43 | background-color: cadetblue; 44 | } 45 | 46 | .message { 47 | padding: 10px; 48 | margin: 5px; 49 | border-radius: 4px; 50 | } -------------------------------------------------------------------------------- /plugin/manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "manifest_version": 2, 3 | "name": "Aify", 4 | "version": "1.19", 5 | "description": "A Thunderbird plugin to rewrite text based on user-selected actions using OpenAI's API.", 6 | "author": "Ali Raheem", 7 | "browser_specific_settings": { 8 | "gecko": { 9 | "id": "aify@shoryuken.me", 10 | "strict_min_version": "78.0" 11 | } 12 | }, 13 | "icons": { 14 | "64": "/images/icon-64px.png", 15 | "32": "/images/icon-32px.png", 16 | "16": "/images/icon-16px.png" 17 | }, 18 | "permissions": ["menus", "storage", "compose"], 19 | "options_ui": { 20 | "page": "/html/settings.html", 21 | "open_in_tab": true 22 | }, 23 | "compose_action": { 24 | "default_title": "Aify", 25 | "default_icon": "/images/icon-64px.png", 26 | "default_popup": "/html/actions.html" 27 | }, 28 | "background": { 29 | "scripts": ["/background.js"] 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /plugin/html/globals.js: -------------------------------------------------------------------------------- 1 | export const promptVersion = 2; 2 | export const defaultActions = [ 3 | { name: "Reply to this", prompt: "Reply to the following email." }, 4 | { name: "Rewrite Polite", prompt: "Rewrite the following text to be more polite. Reply with only the re-written text and no extra comments." }, 5 | { name: "Rewrite Formal", prompt: "Rewrite the following text to be more formal. Reply with only the re-written text and no extra comments." }, 6 | { name: "Classify", prompt: "Classify the following text in terms of Politeness, Warmth, Formality, Assertiveness, Offensiveness giving a percentage for each category. Reply with only the category and score and no extra text." }, 7 | { name: "Summerize this", prompt: "Summerize the following email into a bullet point list." }, 8 | { name: "Translate this", prompt: "Translate the following email in English." }, 9 | { name: "Prompt provided", prompt: "You are a helpful chatbot that will do their best to complete the following tasks with a single response." }, 10 | ]; 11 | export const chatPrompt = "You are a helpful chatbot, answer any questions the user has"; 12 | export const defaultModel = "gpt-3.5-turbo"; -------------------------------------------------------------------------------- /plugin/html/API.js: -------------------------------------------------------------------------------- 1 | export const fetchModels = async (apiKey) => { 2 | const response = await fetch("https://api.openai.com/v1/models", { 3 | method: "GET", 4 | headers: { 5 | "Content-Type": "application/json", 6 | Authorization: `Bearer ${apiKey}` 7 | }, 8 | }); 9 | 10 | if (!response.ok) { 11 | throw new Error(`API request failed: ${response.status}`); 12 | } 13 | 14 | return await response.json(); 15 | }; 16 | 17 | export const fetchResponse = async (apiKey, model, messages, maxTokens) => { 18 | const response = await fetch("https://api.openai.com/v1/chat/completions", { 19 | method: "POST", 20 | headers: { 21 | "Content-Type": "application/json", 22 | Authorization: `Bearer ${apiKey}` 23 | }, 24 | body: JSON.stringify({ 25 | model, 26 | messages: messages, 27 | ...(maxTokens > 0 ? { 'max_tokens': parseInt(maxTokens) } : {}) 28 | }), 29 | }); 30 | 31 | if (!response.ok) { 32 | const errorDetail = await response.text(); 33 | throw new Error(`API request failed: ${response.status}, Detail: ${errorDetail}`); 34 | } 35 | 36 | 37 | const responseData = await response.json(); 38 | return responseData.choices[0].message.content; 39 | } 40 | -------------------------------------------------------------------------------- /plugin/html/draft.js: -------------------------------------------------------------------------------- 1 | import { fetchResponse } from './API.js'; 2 | 3 | async function generate(draftContainer, messages, draftTitle) { 4 | const loadingIcon = document.createElement("img"); 5 | loadingIcon.src = "/images/loading.png"; 6 | loadingIcon.classList.add("rotate"); 7 | 8 | draftContainer.textContent = ""; 9 | draftContainer.appendChild(loadingIcon); 10 | 11 | try { 12 | const { apiKey, model, maxTokens } = await browser.storage.local.get( 13 | ["apiKey","model", "maxTokens"]); 14 | const response = await fetchResponse(apiKey, model, messages, maxTokens); 15 | draftContainer.innerText = response; 16 | messages.push({role: "assistant", content: response}); 17 | document.title = draftTitle; 18 | await browser.storage.local.set({messages}); 19 | } catch (error) { 20 | console.error(error); 21 | draftContainer.textContent = "Error: Unable to retrieve data"; 22 | } 23 | } 24 | 25 | document.addEventListener("DOMContentLoaded", async () => { 26 | const regenButton = document.getElementById('regenerate'); 27 | const chatButton = document.getElementById('chat-button'); 28 | const insertButton = document.getElementById('insert-button'); 29 | const draftContainer = document.getElementById("draft-container"); 30 | const { messages, draftTitle, tabId } = await browser.storage.local.get(["messages", "draftTitle", "tabId"]); 31 | regenButton.addEventListener("click", () => generate(draftContainer, messages, draftTitle)); 32 | chatButton.addEventListener("click", async () => { 33 | await browser.storage.local.set({messages}); 34 | await browser.windows.create({ url: "/html/chat.html", type: "popup", 35 | width: 600, height: 600 }); 36 | window.close(); 37 | }); 38 | insertButton.addEventListener("click", async () => { 39 | browser.tabs.sendMessage(tabId, { command: "replaceSelectedText", text: draftContainer.innerText }); 40 | browser.windows.getCurrent().then((w) => {browser.windows.remove(w.id)}) 41 | }); 42 | generate(draftContainer, messages, draftTitle); 43 | await browser.storage.local.set({ messages: "[]", draftTitle: "" }); 44 | }); 45 | -------------------------------------------------------------------------------- /plugin/content_scripts/compose.js: -------------------------------------------------------------------------------- 1 | (function () { 2 | 3 | const makeParagraphs = (text, func) => { 4 | const chunks = text.split(/\n{2,}/); 5 | if (chunks.length == 1) { 6 | return func(document.createTextNode(text)); 7 | } 8 | const paragraphs = chunks.map((t) => { 9 | const p = document.createElement("p"); 10 | p.innerText = t; 11 | return p; 12 | }); 13 | for (let i = paragraphs.length - 1; i >= 0; i--) { 14 | func(paragraphs[i]); 15 | } 16 | }; 17 | 18 | 19 | const insert = function (text) { 20 | const prefix = window.document.body.getElementsByClassName("moz-cite-prefix"); 21 | if (prefix.length > 0) { 22 | const divider = prefix[0]; 23 | let sibling = divider.previousSibling; 24 | while (sibling) { 25 | window.document.body.removeChild(sibling); 26 | sibling = divider.previousSibling; 27 | } 28 | } 29 | return makeParagraphs(text, function (p) { 30 | window.document.body.insertBefore(p, window.document.body.firstChild); 31 | }); 32 | } 33 | 34 | browser.runtime.onMessage.addListener((message) => { 35 | 36 | if (message.command === "getSelectedText") { 37 | return Promise.resolve(window.getSelection().toString()); 38 | } else if (message.command === "replaceSelectedText") { 39 | const selectedText = window.getSelection().toString(); 40 | if (!selectedText) { 41 | return insert(message.text); 42 | } 43 | const sel = window.getSelection(); 44 | if (!sel || sel.type !== "Range" || !sel.rangeCount) { 45 | return; 46 | } 47 | const r = sel.getRangeAt(0); 48 | r.deleteContents(); 49 | makeParagraphs(message.text, function (p) { 50 | r.insertNode(p); 51 | }); 52 | } else if (message.command === "getText") { 53 | let t = ''; 54 | const children = window.document.body.childNodes; 55 | for (const node of children) { 56 | if (node instanceof Element) { 57 | if (node.classList.contains('moz-signature')) { 58 | continue; 59 | } 60 | } 61 | t += node.textContent; 62 | } 63 | return Promise.resolve(t); 64 | } 65 | }); 66 | })(); -------------------------------------------------------------------------------- /plugin/html/styles.css: -------------------------------------------------------------------------------- 1 | /* Base Styles */ 2 | textarea { 3 | height: 100px; 4 | } 5 | 6 | input[type="text"], 7 | input[type="password"], 8 | select, 9 | textarea { 10 | width: 100%; 11 | padding: 12px; 12 | border: 1px solid #ccc; 13 | border-radius: 4px; 14 | box-sizing: border-box; 15 | resize: vertical; 16 | } 17 | 18 | label { 19 | padding: 12px 12px 12px 0; 20 | display: inline-block; 21 | } 22 | 23 | .container { 24 | border-radius: 5px; 25 | background-color: #f2f2f2; 26 | padding: 20px; 27 | } 28 | 29 | .button { 30 | color: #fff; 31 | padding: 12px 20px; 32 | border-radius: 4px; 33 | cursor: pointer; 34 | } 35 | 36 | /* Button Variations */ 37 | .neutral { 38 | background-color: #5f9ea0; 39 | } 40 | 41 | .bad { 42 | background-color: #dc143c; 43 | } 44 | 45 | .good { 46 | background-color: #04aa6d; 47 | } 48 | 49 | /* Layout */ 50 | .col-25, 51 | .col-75 { 52 | float: left; 53 | margin-top: 6px; 54 | } 55 | 56 | .col-25 { 57 | width: 25%; 58 | } 59 | 60 | .col-75 { 61 | width: 75%; 62 | } 63 | 64 | .row:after { 65 | content: ""; 66 | display: table; 67 | clear: both; 68 | } 69 | 70 | /* Utility Classes */ 71 | .flat { 72 | background-color: #fff; 73 | color: #000; 74 | cursor: pointer; 75 | text-decoration: none; 76 | } 77 | 78 | .rotate { 79 | width: 64px; 80 | animation: rotation 4s infinite linear; 81 | } 82 | 83 | @keyframes rotation { 84 | from { 85 | transform: rotate(0deg); 86 | } 87 | to { 88 | transform: rotate(719deg); 89 | } 90 | } 91 | 92 | /* Responsive Rules */ 93 | @media screen and (max-width: 600px) { 94 | .col-25, 95 | .col-75 { 96 | width: 100%; 97 | margin-top: 0; 98 | } 99 | } 100 | 101 | /* Page Specific Rules */ 102 | .draft-page { 103 | justify-content: space-between; 104 | flex-direction: column; 105 | height: 100vh; 106 | display: flex; 107 | } 108 | 109 | .draft-page .btns { 110 | justify-content: flex-end; 111 | display: flex; 112 | } 113 | -------------------------------------------------------------------------------- /plugin/html/actions.js: -------------------------------------------------------------------------------- 1 | import { promptVersion } from './globals.js'; 2 | 3 | const truncate = async (text) => { 4 | const { maxSize } = await browser.storage.local.get( 5 | ["maxSize"]); 6 | const max = parseInt(maxSize, 10); 7 | if (isNaN(max) || max <= 0) { 8 | return text; 9 | } 10 | const ret = text.substring(0, Math.min(text.length, max)); 11 | return ret; 12 | } 13 | 14 | 15 | const addAction = (name, prompt, actionsContainer) => { 16 | const actionDiv = document.createElement("div"); 17 | const nameInput = document.createElement("p"); 18 | nameInput.classList.add("flat"); 19 | nameInput.innerText = name; 20 | nameInput.classList.add("action-name"); 21 | 22 | const getHighlight = async () => { 23 | const tabs = await browser.tabs.query({ active: true, currentWindow: true }); 24 | return {tabId: tabs[0].id, 25 | selection: await browser.tabs.sendMessage(tabs[0].id, { command: "getSelectedText" }), 26 | text: await browser.tabs.sendMessage(tabs[0].id, { command: "getText" }) 27 | }; 28 | }; 29 | 30 | nameInput.onclick = async () => { 31 | const hl = await getHighlight(); 32 | const messages = [{role: "system", content: prompt}]; 33 | if (hl.selection) { 34 | messages.push({role: "user", content: await truncate(hl.selection)}); 35 | } else { 36 | messages.push({role: "user", content: await truncate(hl.text)}); 37 | } 38 | browser.storage.local.set({ messages, draftTitle: name, tabId: hl.tabId }).then( () => { 39 | browser.windows.create({ url: "/html/draft.html", type: "popup", 40 | width: 600, height: 512 }); 41 | }); 42 | }; 43 | actionDiv.appendChild(nameInput); 44 | actionsContainer.appendChild(actionDiv); 45 | }; 46 | 47 | document.addEventListener("DOMContentLoaded", () => { 48 | const actionsContainer = document.getElementById("actions-container"); 49 | browser.storage.local.get(["actions", "promptUpdated"], (data) => { 50 | const { actions, promptUpdated = 0 } = data; 51 | if (promptVersion > promptUpdated) { 52 | const warningIcon = document.createElement('img'); 53 | warningIcon.src = "/images/warning.png"; 54 | warningIcon.classList.add('small-icon'); 55 | const settingsLink = document.getElementById('settings-link'); 56 | settingsLink.appendChild(warningIcon); 57 | }; 58 | actions.forEach((action) => {addAction(action.name, action.prompt, actionsContainer)}); 59 | }); 60 | }); 61 | -------------------------------------------------------------------------------- /plugin/html/chat.js: -------------------------------------------------------------------------------- 1 | import { fetchResponse } from './API.js'; 2 | import { chatPrompt } from './globals.js'; 3 | 4 | document.addEventListener('DOMContentLoaded', async function () { 5 | var messageInput = document.getElementById('message-input'); 6 | var sendButton = document.getElementById('send-button'); 7 | // const clearButton = document.getElementById('clear-button'); 8 | var messagesContainer = document.getElementById('messages'); 9 | var loadingIcon = document.createElement('img'); 10 | 11 | loadingIcon.src = '/images/loading.png'; 12 | loadingIcon.classList.add('rotate'); 13 | 14 | var storage = await browser.storage.local.get(["messages"]); 15 | let messages = (storage.messages?.length)? storage.messages : [{role: "system", 16 | content: chatPrompt}]; 17 | 18 | messages.forEach(function(message) { 19 | displayMessage(message.role, message.content); 20 | }); 21 | 22 | //clearButton.addEventListener('click', async () => {messages = []; await browser.storage.local.set({messages}); window.close()}) 23 | sendButton.addEventListener('click', async function () { 24 | var messageText = messageInput.value.trim(); 25 | 26 | if (messageText) { 27 | messages.push({role: 'user', content: messageText}); 28 | displayMessage('user', messageText); 29 | 30 | sendButton.disabled = true; 31 | messagesContainer.appendChild(loadingIcon); 32 | 33 | try { 34 | const { apiKey, model, maxTokens } = await browser.storage.local.get( 35 | ["apiKey","model", "maxTokens"]); 36 | const response = await fetchResponse(apiKey, model, messages, maxTokens); 37 | // messagesContainer.innerText = response; 38 | // Remove loading icon and enable button when API call finishes 39 | loadingIcon.parentElement.removeChild(loadingIcon); 40 | sendButton.disabled = false; 41 | 42 | if (response) { 43 | // Display the response from the model 44 | displayMessage('assistant', response); 45 | messages.push({role: 'assistant', content: response}); 46 | 47 | // Save messages to local storage 48 | browser.storage.local.set({messages}); 49 | } 50 | } catch(error) { 51 | console.error(error); 52 | messagesContainer.textContent = "Error: Unable to retrieve data"; 53 | } 54 | 55 | messageInput.value = ''; 56 | } 57 | }); 58 | 59 | function displayMessage(role, text) { 60 | var messageDiv = document.createElement('div'); 61 | messageDiv.classList.add(role + '-message'); 62 | messageDiv.classList.add('message'); 63 | messageDiv.innerText = text; 64 | messagesContainer.appendChild(messageDiv); 65 | 66 | // Scroll to bottom 67 | messagesContainer.scrollTop = messagesContainer.scrollHeight; 68 | } 69 | }); 70 | 71 | window.addEventListener('unload', async function (event) { 72 | await browser.storage.local.set({ messages: "[]", draftTitle: "" }); 73 | }); 74 | 75 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Aify 2 | 3 | [Thunderbird addon](https://addons.thunderbird.net/en-GB/thunderbird/addon/aify/) to bring ChatGPT to your emails. 4 | 5 | Rewrite or generate text based on promps using OpenAI's API. 6 | Configure on settings page (make sure to save) and start to use when writing your emails! 7 | 8 | You must have API key for OpenAI (anyone can access GPT-3.5-turbo). But then you can use any model you have access to including finetuned ones. 9 | 10 | Aify comes with plenty of stock prompts, which you can add to, delete or customize as you need. 11 | 12 | ## Screenshots 13 | 14 | ![Configuration](/screenshots/example.png) 15 | 16 | Make sure to configure the addon before use. You must at least set an API key and save it. 17 | 18 | ![Expand short sentences into detailed text](/screenshots/example1.png) 19 | 20 | You can use Aify to turn sentences into detailed emails. 21 | 22 | ![Translate or interpret complex text](/screenshots/example2.png) 23 | 24 | Or even translate and understand complex text. 25 | 26 | ## Configuration and Usage 27 | 28 | ### Configuration 29 | 30 | 1. Set an API key below (obtainable from OpenAI). 31 | 2. (Optional) Once you've set an API key you can click Update Models to get the current list. 32 | 3. **Make sure you have access to the selected model (anyone can use gpt-3.5-turbo).** 33 | 4. (Optional) Add, remove or edit the available actions. 34 | 5. **Make sure to click save button to store settings.** 35 | 36 | ### Usage 37 | 38 | 1. Open a new compose window (Write, Reply or Forward). 39 | 2. Highlight some text to act one. 40 | 3. Click the Aify icon in the top right (near the lightbulb) and pick an action. 41 | 4. A popup will open and await the response from the API. This may take time at periods of high load. 42 | 5. (Optional) Click `Regenerate` to get a new response. 43 | 44 | ## Tips and Tricks 45 | 46 | You can add, edit and remove prompts from the `settings` page. 47 | 48 | `gpt-3.5-turbo` is faster and cheaper than `gpt-4`, but not as "smart". 49 | 50 | The prompt name (text box) is what is shown in the Aify context menu, and the prompt itself (the textarea) is prepended to the highlighted text separated by newline --- newline which makes it easy for the model to see whats what but isn't harmful if the prompt is empty. 51 | 52 | ## Building 53 | 54 | The contents of `plugin/` should be zipped into a file ending `.xpi`. 55 | 56 | ``` 57 | cd plugin 58 | zip -r ../aify.xpi * 59 | ``` 60 | 61 | ## Todo 62 | 63 | - ~~[HIGH] Use the API to identify available models.~~ 64 | - ~~[MOD] You should be able to specify a model name (useful for finetunings).~~ 65 | - ~~[HIGH] Limit length.~~ 66 | - [MOD] Model selection should be on a per-prompt basis. 67 | - [LOW] Model selection should be selectable from the context menu. 68 | - [MOD] Make it so any API could be used. 69 | - ~~[MOD] Styling and UX improvements.~~ 70 | - [LOW] Mask API key in settings once saved. 71 | 72 | ## Privacy and Data Retention 73 | 74 | This add-on interfaces with OpenAI's API but collects no data itself other than settings stored locally. 75 | The text is sent to OpenAI's server and managed by their data retention policy. 76 | 77 | - OpenAI's privacy policy can be found at https://openai.com/policies/privacy-policy 78 | - OpenAI's API data usage policy is here https://openai.com/policies/api-data-usage-policies 79 | 80 | ## License 81 | 82 | GPLv3 83 | 84 | ## Icons 85 | ### UXWing.com 86 | Licensing terms - https://uxwing.com/license 87 | - loading - https://uxwing.com/loader-line-icon 88 | - icon - https://uxwing.com/invention-icon 89 | - caution.png - https://uxwing.com/caution-icon 90 | 91 | -------------------------------------------------------------------------------- /plugin/html/settings.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Aify Settings 5 | 6 | 7 | 8 |
9 |
10 |
11 | Configuration 12 |
13 |
14 |
    15 |
  1. Set an API key below (obtainable from OpenAI).
  2. 16 |
  3. (Optional) Once you've set an API key you can click Update Models to get the current list.
  4. 17 |
  5. Make sure you have access to the selected model (anyone can use gpt-3.5-turbo).
  6. 18 |
  7. (Optional) Add, remove or edit the available actions.
  8. 19 |
  9. Make sure to click save to store setings.
  10. 20 |
21 |
22 |
23 |
24 |
25 | Usage 26 |
27 |
28 |
    29 |
  1. Open a new compose window (Write, Reply or Forward).
  2. 30 |
  3. Highlight some text to act one.
  4. 31 |
  5. Click the Aify icon in the top right (near the lightbulb) and pick an action.
  6. 32 |
  7. A popup will open and await the response from the API. This may take time at periods of high load.
  8. 33 |
  9. (Optional) click Regenerate to get a new response.
  10. 34 |
35 |
36 |
37 |
38 |
Support
39 |
Need more help? Email us aify@shoryuken.me.
40 |
41 |
42 |
43 |
44 |
45 |
46 | 48 |
49 |
50 |
51 |
52 |
53 |
54 |
55 |
56 |
57 | 63 |
64 |
65 |
66 |
67 |
68 |
69 |
70 |
71 |
72 |
73 | 74 | 75 | 76 |
77 |
78 |
79 |
80 |
81 |
82 |
83 |
84 |
85 | 86 |
87 |
88 | 89 | 90 | 91 | 92 | -------------------------------------------------------------------------------- /plugin/html/settings.js: -------------------------------------------------------------------------------- 1 | import { fetchModels } from './API.js'; 2 | import { promptVersion, defaultActions, defaultModel } from './globals.js'; 3 | 4 | const addAction = (name, prompt, actionsContainer) => { 5 | const actionDiv = document.createElement("div"); 6 | const nameInput = document.createElement("input"); 7 | const promptInput = document.createElement("textarea"); 8 | const deleteButton = document.createElement("button"); 9 | 10 | nameInput.type = "text"; 11 | nameInput.value = name; 12 | nameInput.classList.add("action-name"); 13 | 14 | promptInput.value = prompt; 15 | promptInput.classList.add("action-prompt"); 16 | 17 | deleteButton.innerText = "Delete Prompt"; 18 | deleteButton.classList.add("button", "bad"); 19 | deleteButton.addEventListener("click", () => actionDiv.remove()); 20 | 21 | const docFrag = document.createDocumentFragment(); 22 | docFrag.appendChild(nameInput); 23 | docFrag.appendChild(promptInput); 24 | docFrag.appendChild(deleteButton); 25 | 26 | actionDiv.appendChild(docFrag); 27 | actionsContainer.appendChild(actionDiv); 28 | }; 29 | 30 | 31 | const handleWarning = (promptUpdated, notesContainer) => { 32 | if (promptVersion > promptUpdated) { 33 | let warningContainer = document.createElement('div'); 34 | warningContainer.id = "warning-container"; 35 | warningContainer.classList.add('row') 36 | let warningDiv25 = document.createElement('div'); 37 | warningDiv25.classList.add('col-25'); 38 | let warningDiv75 = document.createElement('div'); 39 | warningDiv75.classList.add('col-75'); 40 | let warningIcon = document.createElement('img'); 41 | warningIcon.src = "/images/warning.png"; 42 | warningIcon.classList.add('small-icon'); 43 | let warningText = document.createElement('span'); 44 | warningText.innerText = "Prompts have been updated. Please backup custom prompts and click clear to load latest prompts. "; 45 | let ignoreButton = document.createElement('button'); 46 | ignoreButton.classList.add('button'); 47 | ignoreButton.classList.add('bad'); 48 | ignoreButton.innerText = "Ignore"; 49 | ignoreButton.addEventListener('click', function () { 50 | browser.storage.local.set({promptUpdated: promptVersion}); 51 | warningContainer.parentElement.removeChild(warningContainer); 52 | }); 53 | warningDiv25.innerText = "Warning " 54 | warningDiv25.appendChild(warningIcon); 55 | warningDiv75.appendChild(warningText); 56 | warningDiv75.appendChild(ignoreButton); 57 | warningContainer.appendChild(warningDiv25); 58 | warningContainer.appendChild(warningDiv75); 59 | notesContainer.appendChild(warningContainer); 60 | } 61 | }; 62 | 63 | const saveSettings = (actionsContainer, modelSelect, apiKeyInput, maxTokensInput, maxSizeInput) => { 64 | const actions = Array.from(actionsContainer.children).map(actionDiv => { 65 | const nameInput = actionDiv.querySelector(".action-name"); 66 | const promptInput = actionDiv.querySelector(".action-prompt"); 67 | return { name: nameInput.value, prompt: promptInput.value }; 68 | }); 69 | 70 | browser.storage.local.set({ 71 | model: modelSelect.value, 72 | apiKey: apiKeyInput.value, 73 | actions: actions, 74 | maxTokens: maxTokensInput.value, 75 | maxSize: maxSizeInput.value, 76 | promptUpdated: promptVersion 77 | }); 78 | }; 79 | 80 | const setDefaultSettings = (actionsContainer, modelSelect, apiKeyInput, maxTokensInput, maxSizeInput) => { 81 | while (actionsContainer.firstChild) { 82 | actionsContainer.firstChild.remove(); 83 | } 84 | modelSelect.value = defaultModel; 85 | apiKeyInput.value = ""; 86 | maxTokensInput.value = 0; 87 | maxSizeInput.value = 0; 88 | defaultActions.forEach(({ name, prompt }) => { 89 | addAction(name, prompt, actionsContainer); 90 | }); 91 | browser.storage.local.set({ 92 | model: defaultModel, 93 | apiKey: "", 94 | actions: defaultActions, 95 | promptUpdated: promptVersion 96 | }); 97 | }; 98 | 99 | const getModels = async (apiKey) => { 100 | const responseData = await fetchModels(apiKey); 101 | 102 | var selectElement = document.getElementById("model"); 103 | selectElement.remove(0); 104 | responseData.data.map(model => { 105 | let option = document.createElement("option"); 106 | let selectElement = document.getElementById("model"); 107 | option.value = model.id; 108 | option.text = model.id; 109 | selectElement.add(option); 110 | }); 111 | }; 112 | 113 | 114 | const addModelToSelect = (model, modelSelect) => { 115 | let option = document.createElement("option"); 116 | option.value = model; 117 | option.text = model; 118 | modelSelect.add(option); 119 | modelSelect.value = model; 120 | } 121 | 122 | document.addEventListener("DOMContentLoaded", () => { 123 | const modelSelect = document.getElementById("model"); 124 | const apiKeyInput = document.getElementById("api-key"); 125 | const actionsContainer = document.getElementById("actions-container"); 126 | const addActionButton = document.getElementById("add-action"); 127 | const saveButton = document.getElementById("save-settings"); 128 | const getModelsButton = document.getElementById("get-models"); 129 | const maxTokensInput = document.getElementById("max-tokens"); 130 | const maxSizeInput = document.getElementById("max-size"); 131 | const defaultButton = document.getElementById("default-settings"); 132 | const notesContainer = document.getElementById("notes-container"); 133 | 134 | browser.storage.local.get(["model", "apiKey", "actions", "maxTokens", "promptUpdated", "maxSize"], (data) => { 135 | const { model = defaultModel, apiKey = '', maxTokens = 0, promptUpdated = 0, maxSize = 0, actions = defaultActions } = data; 136 | 137 | apiKeyInput.value = apiKey; 138 | addModelToSelect(model, modelSelect); 139 | maxTokensInput.value = maxTokens; 140 | maxSizeInput.value = maxSize; 141 | handleWarning(promptUpdated, notesContainer); 142 | 143 | actions.forEach(({ name, prompt }) => addAction(name, prompt, actionsContainer)); 144 | 145 | addActionButton.addEventListener("click", () => addAction("", "", actionsContainer)); 146 | saveButton.addEventListener("click", () => saveSettings(actionsContainer, modelSelect, apiKeyInput, maxTokensInput, maxSizeInput)); 147 | defaultButton.addEventListener("click", () => setDefaultSettings(actionsContainer, modelSelect, apiKeyInput, maxTokensInput, maxSizeInput)); 148 | getModelsButton.addEventListener("click", () => getModels(apiKeyInput.value)); 149 | }); 150 | }); 151 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 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 General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------