├── versions.json ├── images └── icon.png ├── manifest.json ├── .gitignore ├── README.md ├── main.py └── LICENSE /versions.json: -------------------------------------------------------------------------------- 1 | [ 2 | {"required_api_version": "^2.0.0", "commit": "main"} 3 | ] 4 | -------------------------------------------------------------------------------- /images/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Rapha149/ulauncher-deepl/HEAD/images/icon.png -------------------------------------------------------------------------------- /manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "required_api_version": "^2.0.0", 3 | "name": "DeepL Translate", 4 | "description": "Translate text using DeepL", 5 | "developer_name": "Rapha149", 6 | "icon": "images/icon.png", 7 | "options": { 8 | "query_debounce": 0.1 9 | }, 10 | "preferences": [ 11 | { 12 | "id": "keyword", 13 | "type": "keyword", 14 | "name": "DeepL Translate", 15 | "default_value": "tr" 16 | }, 17 | { 18 | "id": "api_key", 19 | "type": "input", 20 | "name": "DeepL API key" 21 | }, 22 | { 23 | "id": "source_language", 24 | "type": "input", 25 | "name": "Source language", 26 | "description": "Specifies how to choose the source language. Options: \"select\", \"auto\" or a language keyword.", 27 | "default_value": "select" 28 | }, 29 | { 30 | "id": "target_language", 31 | "type": "input", 32 | "name": "Target language", 33 | "description": "Specifies how to choose the target language. Options: \"select\" or a language keyword.", 34 | "default_value": "select" 35 | }, 36 | { 37 | "id": "quick_access_languages", 38 | "type": "input", 39 | "name": "Number of quick access languages", 40 | "description": "Specifies how many languages to translate to are displayed for quick access.", 41 | "default_value": 3 42 | }, 43 | { 44 | "id": "languages_per_page", 45 | "type": "input", 46 | "name": "Number of languages per page", 47 | "description": "Specifies how many languages are displayed per page.", 48 | "default_value": 10 49 | }, 50 | { 51 | "id": "split_result", 52 | "type": "input", 53 | "name": "Split result in lines every n characters", 54 | "description": "Words won't be split. Set to 0 to disable splitting.", 55 | "default_value": 65 56 | }, 57 | { 58 | "id": "formality", 59 | "type": "input", 60 | "name": "Formality of translated text", 61 | "description": "Choose from \"default\", \"less\" or \"more\"", 62 | "default_value": "default" 63 | } 64 | ] 65 | } 66 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | 131 | .idea/ 132 | *.iml -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # DeepL for Ulauncher 2 | A powerful DeepL translator for Ulauncher. 3 | 4 | ## Features 5 | - Translate text (kinda obvious) 6 | - Quickly translate to the last used languages 7 | - Use `from:to` in front of the text to choose languages even quicker! (See [Quick Language Selection](#quick-language-selection)) 8 | - Many options to customize the translator! (See [Preferences](#preferences)) 9 | - Copy the result to clipboard, translate it into another language or use the same input text again by pressing one button! 10 | - Up to 500000 characters per month for free! (DeepL limitations) 11 | 12 | ![image](https://user-images.githubusercontent.com/49787110/204258768-28172c1f-0b50-442f-a742-1edb3c73aa7f.png) 13 | ![image](https://user-images.githubusercontent.com/49787110/204258777-8973375b-2a83-4057-8b77-33dae5792c85.png) 14 | ![image](https://user-images.githubusercontent.com/49787110/204258791-9f51eb3f-6643-40fe-8ff2-3b557e04d9bb.png) 15 | ![image](https://user-images.githubusercontent.com/49787110/212107654-d1bcd64b-215e-49bc-b636-e64d54b6fbeb.png) 16 | 17 | ## Requirements 18 | `pip install deepl` 19 | 20 | ## Get an API key 21 | You can get an DeepL API key for free at https://www.deepl.com/pro-api 22 | With free API keys you can translate up to 500000 characters per month. 23 | Of course you can also buy an API key and get more characters if needed. 24 | 25 | ## Quick Language Selection 26 | Using the pattern `from:to` in front of the to be translated text you can quickly select the languages. 27 | For example: `en:es` to translate from English to Spanish. 28 | 29 | You can also specify `auto` and `select` for the source language and `select` for the target language. 30 | If using `auto` the translator will automatically detect the source language. 31 | If using `select` you will be able to select the source/target language respectively. 32 | This is useful when you have selected languages in the preferences. Using this method you can temporarily "set" these settings to `auto` or `select`. 33 | 34 | If you don't know a language code you can specify anything. The extension will tell you it doesn't know that language code and offer you a list of codes. 35 | 36 | ## Preferences 37 | **Keyword** 38 | The keyword to use the extension. 39 | Defaults to `tr`. 40 | 41 | **API key** 42 | Your DeepL API key. See [Get an API key](#get-an-api-key). 43 | 44 | **Source language** 45 | The language you want to translate from. 46 | Set to `auto` to let DeepL detect the language automatically. 47 | Set to `select` to select the language manually each time. 48 | Set to a language code to always use that language. If you don't know the language code enter something else. 49 | Then the extension will tell you that it doesn't know that language code and offer you a list of codes. 50 | Defaults to `select`. 51 | 52 | **Target language** 53 | The language you want to translate to. 54 | Set to `select` to select the language manually each time. 55 | Set to a language code to always use that language. If you don't know the language code enter something else. 56 | Then the extension will tell you that it doesn't know that language code and offer you a list of codes. 57 | Defaults to `select`. 58 | 59 | **Number of quick access languages** 60 | Specifies how many languages to translate to are displayed for quick access. 61 | This setting applies only when `Target language` is set to `select`. 62 | Defaults to `3`. 63 | 64 | **Number of languages per page** 65 | Specifies how many languages are displayed per page. 66 | Defaults to `10`. 67 | 68 | **Split result in lines every `n` characters** 69 | Specifies after how many characters the result text is split into multiple lines. 70 | Words won't be split. 71 | Set to `0` to disable splitting. Warning: Large translated texts won't be displayed in full. 72 | Defaults to `65`. 73 | 74 | **Formality of translated text** 75 | Specifies the formality of the translated text if available for the target language. 76 | Available options: `default`, `less` and `more`. 77 | Defaults to `default`. 78 | -------------------------------------------------------------------------------- /main.py: -------------------------------------------------------------------------------- 1 | import json 2 | import logging 3 | import time 4 | import math 5 | import re 6 | from functools import cmp_to_key 7 | from pathlib import Path 8 | 9 | from deepl import Translator, DeepLException, Formality 10 | from ulauncher.api.client.EventListener import EventListener 11 | from ulauncher.api.client.Extension import Extension 12 | from ulauncher.api.shared.action.CopyToClipboardAction import CopyToClipboardAction 13 | from ulauncher.api.shared.action.DoNothingAction import DoNothingAction 14 | from ulauncher.api.shared.action.ExtensionCustomAction import ExtensionCustomAction 15 | from ulauncher.api.shared.action.HideWindowAction import HideWindowAction 16 | from ulauncher.api.shared.action.RenderResultListAction import RenderResultListAction 17 | from ulauncher.api.shared.action.SetUserQueryAction import SetUserQueryAction 18 | from ulauncher.api.shared.event import KeywordQueryEvent, ItemEnterEvent, SystemExitEvent, PreferencesUpdateEvent, \ 19 | PreferencesEvent 20 | from ulauncher.api.shared.item.ExtensionResultItem import ExtensionResultItem 21 | from xdg.BaseDirectory import xdg_data_home 22 | 23 | LOGGER = logging.getLogger(__name__) 24 | 25 | 26 | class DeepLExtension(Extension): 27 | 28 | def __init__(self): 29 | super().__init__() 30 | self.subscribe(SystemExitEvent, SystemExitEventListener()) 31 | self.subscribe(PreferencesEvent, PreferencesEventListener()) 32 | self.subscribe(PreferencesUpdateEvent, PreferencesUpdateEventListener()) 33 | self.subscribe(KeywordQueryEvent, KeywordQueryEventListener()) 34 | self.subscribe(ItemEnterEvent, ItemEnterListener()) 35 | 36 | data_folder = Path(xdg_data_home) / 'ulauncher-deepl' 37 | if data_folder.is_file(): 38 | raise IOError(f'"{str(data_folder)}" is a file.') 39 | if not data_folder.exists(): 40 | data_folder.mkdir() 41 | 42 | self.data_file = data_folder / 'data.json' 43 | self.data = json.load(self.data_file.open('r')) if self.data_file.exists() else {} 44 | self.translator = None 45 | 46 | self.source_languages = None 47 | self.target_languages = None 48 | self.last_source_language_fetch = 0 49 | self.last_target_language_fetch = 0 50 | 51 | self.usage = None 52 | self.last_usage_fetch = 0 53 | 54 | def get_last_source_languages(self): 55 | if 'last_source_languages' not in self.data: 56 | self.data['last_source_languages'] = [] 57 | return self.data['last_source_languages'] 58 | 59 | def get_last_target_languages(self): 60 | if 'last_target_languages' not in self.data: 61 | self.data['last_target_languages'] = [] 62 | return self.data['last_target_languages'] 63 | 64 | def set_last_source_language(self, lang): 65 | languages = self.get_last_source_languages() 66 | if lang in languages: 67 | languages.remove(lang) 68 | languages.insert(0, lang) 69 | json.dump(self.data, self.data_file.open('w')) 70 | 71 | def set_last_target_language(self, lang): 72 | languages = self.get_last_target_languages() 73 | if lang in languages: 74 | languages.remove(lang) 75 | languages.insert(0, lang) 76 | json.dump(self.data, self.data_file.open('w')) 77 | 78 | def get_source_languages(self): 79 | current = time.time() 80 | if current - self.last_source_language_fetch >= 3600: 81 | self.source_languages = self.translator.get_source_languages() 82 | self.last_source_language_fetch = current 83 | return self.source_languages 84 | 85 | def get_target_languages(self): 86 | current = time.time() 87 | if current - self.last_target_language_fetch >= 3600: 88 | self.target_languages = self.translator.get_target_languages() 89 | self.last_target_language_fetch = current 90 | return self.target_languages 91 | 92 | def get_source_language_name(self, lang_code): 93 | for language in self.get_source_languages(): 94 | if language.code == lang_code: 95 | return language.name 96 | return None 97 | 98 | def get_target_language_name(self, lang_code): 99 | for language in self.get_target_languages(): 100 | if language.code == lang_code: 101 | return language.name 102 | return None 103 | 104 | def get_usage(self): 105 | current = time.time() 106 | if current - self.last_usage_fetch >= 20: 107 | self.usage = self.translator.get_usage() 108 | self.last_usage_fetch = current 109 | return self.usage 110 | 111 | def on_input(self, keyword, arg): 112 | if not self.translator: 113 | return RenderResultListAction([ 114 | ExtensionResultItem(icon='images/icon.png', 115 | name='Translator could not be initialized', 116 | description='Please validate that your API key is correct.', 117 | highlightable=False, 118 | on_enter=HideWindowAction()) 119 | ]) 120 | 121 | try: 122 | usage = self.get_usage().character 123 | except DeepLException as error: 124 | LOGGER.error(error) 125 | return RenderResultListAction([ 126 | ExtensionResultItem(icon='images/icon.png', 127 | name='An error occured', 128 | description='Please validate that your API key is correct.', 129 | highlightable=False, 130 | on_enter=HideWindowAction()) 131 | ]) 132 | 133 | if usage.limit_reached: 134 | return RenderResultListAction([ 135 | ExtensionResultItem(icon='images/icon.png', 136 | name='DeepL API Usage exceeded', 137 | highlightable=False, 138 | on_enter=HideWindowAction()) 139 | ]) 140 | 141 | source_lang = self.preferences['source_language'].upper() 142 | if source_lang == 'AUTO': 143 | source_lang = None 144 | select_source_lang = False 145 | elif source_lang == 'SELECT': 146 | source_lang = None 147 | select_source_lang = True 148 | elif self.get_source_language_name(source_lang): 149 | select_source_lang = False 150 | else: 151 | return RenderResultListAction([ 152 | ExtensionResultItem(icon='images/icon.png', 153 | name=f'Source language "{source_lang}" not found (from preferences).', 154 | description='Press Alt+Enter for a list of source languages.', 155 | highlightable=False, 156 | on_enter=HideWindowAction(), 157 | on_alt_enter=ExtensionCustomAction({ 158 | 'keyword': keyword, 159 | 'action': 'source_languages'}, keep_app_open=True)) 160 | ]) 161 | 162 | target_lang = self.preferences['target_language'].upper() 163 | if target_lang == 'EN': 164 | target_lang = 'EN-US' 165 | if target_lang == 'SELECT': 166 | select_target_lang = True 167 | elif self.get_target_language_name(target_lang): 168 | select_target_lang = False 169 | else: 170 | return RenderResultListAction([ 171 | ExtensionResultItem(icon='images/icon.png', 172 | name=f'Target language "{target_lang}" not found (from preferences).', 173 | description='Press Alt+Enter for a list of target languages.', 174 | highlightable=False, 175 | on_enter=HideWindowAction(), 176 | on_alt_enter=ExtensionCustomAction({ 177 | 'keyword': keyword, 178 | 'action': 'target_languages'}, keep_app_open=True)) 179 | ]) 180 | 181 | usage_str = f'Usage: {usage.count}/{usage.limit} ({round(usage.count / usage.limit * 10000) / 100}%)' 182 | if not arg: 183 | return RenderResultListAction([ 184 | ExtensionResultItem(icon='images/icon.png', 185 | name='Enter text...', 186 | description=usage_str, 187 | highlightable=False, 188 | on_enter=DoNothingAction()) 189 | ]) 190 | 191 | original_arg = arg 192 | match = re.search('^(?Pselect|auto|[a-zA-Z]{2,4})?:(?Pselect|[a-zA-Z]{2,4}(-[a-zA-Z]{2,4})?)?(?P )?', arg, 193 | re.IGNORECASE) 194 | if match: 195 | if match['space']: 196 | if match['source']: 197 | source_lang = match['source'].upper() 198 | if source_lang == 'AUTO': 199 | source_lang = None 200 | select_source_lang = False 201 | elif source_lang == 'SELECT': 202 | source_lang = None 203 | select_source_lang = True 204 | elif self.get_source_language_name(source_lang): 205 | select_source_lang = False 206 | else: 207 | return RenderResultListAction([ 208 | ExtensionResultItem(icon='images/icon.png', 209 | name=f'Source language "{source_lang}" not found.', 210 | description='Press Alt+Enter for a list of source languages.', 211 | highlightable=False, 212 | on_enter=HideWindowAction(), 213 | on_alt_enter=ExtensionCustomAction({ 214 | 'keyword': keyword, 215 | 'action': 'source_languages'}, keep_app_open=True)) 216 | ]) 217 | 218 | if match['target']: 219 | target_lang = match['target'].upper() 220 | if target_lang == 'EN': 221 | target_lang = 'EN-US' 222 | if target_lang == 'SELECT': 223 | select_target_lang = True 224 | elif self.get_target_language_name(target_lang): 225 | select_target_lang = False 226 | else: 227 | return RenderResultListAction([ 228 | ExtensionResultItem(icon='images/icon.png', 229 | name=f'Target language "{target_lang}" not found.', 230 | description='Press Alt+Enter for a list of target languages.', 231 | highlightable=False, 232 | on_enter=HideWindowAction(), 233 | on_alt_enter=ExtensionCustomAction({ 234 | 'keyword': keyword, 235 | 'action': 'target_languages'}, keep_app_open=True)) 236 | ]) 237 | 238 | arg = arg[match.end():].strip() 239 | 240 | if not arg: 241 | return RenderResultListAction([ 242 | ExtensionResultItem(icon='images/icon.png', 243 | name='Enter text...', 244 | description=usage_str, 245 | highlightable=False, 246 | on_enter=DoNothingAction()) 247 | ]) 248 | 249 | if not match['space']: 250 | arg = original_arg 251 | 252 | if not select_target_lang: 253 | data = { 254 | 'keyword': keyword, 255 | 'text': arg, 256 | 'original_text': original_arg, 257 | 'target_lang': target_lang 258 | } 259 | if not select_source_lang: 260 | data['source_lang'] = source_lang 261 | data['translate_directly'] = False 262 | return self.on_enter(data) 263 | 264 | translate_data = { 265 | 'keyword': keyword, 266 | 'text': arg, 267 | 'original_text': original_arg 268 | } 269 | if not select_source_lang: 270 | translate_data['source_lang'] = source_lang 271 | items = [ 272 | ExtensionResultItem( 273 | icon='images/icon.png', 274 | name='Translate text', 275 | description='Alt+Enter to skip source language and detect it instead.' if select_source_lang else '', 276 | highlightable=False, 277 | on_enter=ExtensionCustomAction(translate_data, keep_app_open=True), 278 | on_alt_enter=ExtensionCustomAction(translate_data | {'source_lang': None}, 279 | keep_app_open=True) if select_source_lang else None) 280 | ] 281 | 282 | last_target_languages = self.get_last_target_languages() 283 | quick_access_languages = str(self.preferences['quick_access_languages']) 284 | for i in range(min(len(last_target_languages), 285 | int(quick_access_languages) if quick_access_languages.isnumeric() else 3)): 286 | lang = last_target_languages[i] 287 | items.append(ExtensionResultItem( 288 | icon='images/icon.png', 289 | name=f'Translate to {self.get_target_language_name(lang)}', 290 | description='Alt+Enter to choose source language.' if select_source_lang else '', 291 | highlightable=False, 292 | on_enter=ExtensionCustomAction(translate_data | {'source_lang': source_lang, 293 | 'target_lang': lang}, keep_app_open=True), 294 | on_alt_enter=ExtensionCustomAction(translate_data | {'target_lang': lang}, 295 | keep_app_open=True) if select_source_lang else None)) 296 | 297 | return RenderResultListAction(items) 298 | 299 | def on_enter(self, data): 300 | if 'reset' in data: 301 | return self.on_input(data['keyword'], data['reset']) 302 | 303 | languages_per_page_str = str(self.preferences['languages_per_page']) 304 | languages_per_page = int(languages_per_page_str) if languages_per_page_str.isnumeric() else 10 305 | 306 | if 'action' in data: 307 | if data['action'] == 'source_languages': 308 | languages = self.get_source_languages() 309 | elif data['action'] == 'target_languages': 310 | languages = self.get_target_languages() 311 | else: 312 | return RenderResultListAction([ 313 | ExtensionResultItem(icon='images/icon.png', 314 | name='An error occured', 315 | highlightable=False, 316 | on_enter=HideWindowAction()) 317 | ]) 318 | 319 | page = data['page'] if 'page' in data else 1 320 | total_page_count = math.ceil((len(languages) + 1) / languages_per_page) 321 | 322 | items = [] 323 | if total_page_count > 1: 324 | page_descriptions = [] 325 | next_page, previous_page = page < total_page_count, page > 1 326 | if next_page: 327 | page_descriptions.append('Enter for next page') 328 | if previous_page: 329 | page_descriptions.append('Alt+Enter for previous page') 330 | 331 | page_data = data.copy() 332 | page_data['page'] = page + 1 333 | page_alt_data = data.copy() 334 | page_alt_data['page'] = page - 1 335 | 336 | items.append( 337 | ExtensionResultItem( 338 | icon='images/icon.png', 339 | name=f'Page {page}/{total_page_count}', 340 | description=', '.join(page_descriptions), 341 | highlightable=False, 342 | on_enter=ExtensionCustomAction(page_data, keep_app_open=True) if next_page else None, 343 | on_alt_enter=ExtensionCustomAction(page_alt_data, 344 | keep_app_open=True) if previous_page else None) 345 | ) 346 | 347 | for i in range((page - 1) * languages_per_page, min(len(languages), page * languages_per_page)): 348 | language = languages[i] 349 | items.append(ExtensionResultItem(icon='images/icon.png', 350 | name=f'{language.code}: {language.name}', 351 | highlightable=False, 352 | on_enter=HideWindowAction())) 353 | 354 | return RenderResultListAction(items) 355 | 356 | def compare(last_languages, lang1, lang2): 357 | l1, l2 = lang1.code, lang2.code 358 | e1, e2 = l1 in last_languages, l2 in last_languages 359 | if not e1 and not e2: 360 | return 0 361 | if e1 and not e2: 362 | return -1 363 | if not e1 and e2: 364 | return 1 365 | return last_languages.index(l1) - last_languages.index(l2) 366 | 367 | last_source_languages = self.get_last_source_languages() 368 | last_target_languages = self.get_last_target_languages() 369 | 370 | if 'source_lang' not in data: 371 | last_target = last_target_languages[0] if last_target_languages else None 372 | last_target_name = self.get_target_language_name(last_target) if last_target else None 373 | 374 | languages = sorted(self.get_source_languages(), 375 | key=cmp_to_key(lambda lang1, lang2: compare(last_source_languages, lang1, lang2))) 376 | description = f'Alt+Enter to translate to {last_target_name}.' if last_target and 'target_lang' not in \ 377 | data else '' 378 | 379 | page = data['page'] if 'page' in data else 1 380 | total_page_count = math.ceil((len(languages) + 1) / languages_per_page) 381 | 382 | items = [] 383 | if total_page_count > 1: 384 | page_descriptions = [] 385 | next_page, previous_page = page < total_page_count, page > 1 386 | if next_page: 387 | page_descriptions.append('Enter for next page') 388 | if previous_page: 389 | page_descriptions.append('Alt+Enter for previous page') 390 | 391 | page_data = data.copy() 392 | page_data['page'] = page + 1 393 | page_alt_data = data.copy() 394 | page_alt_data['page'] = page - 1 395 | 396 | items.append( 397 | ExtensionResultItem( 398 | icon='images/icon.png', 399 | name=f'Page {page}/{total_page_count}', 400 | description=', '.join(page_descriptions), 401 | highlightable=False, 402 | on_enter=ExtensionCustomAction(page_data, keep_app_open=True) if next_page else None, 403 | on_alt_enter=ExtensionCustomAction(page_alt_data, 404 | keep_app_open=True) if previous_page else None) 405 | ) 406 | 407 | if page == 1: 408 | detect_data = data.copy() 409 | if 'page' in detect_data: 410 | del detect_data['page'] 411 | detect_data['source_lang'] = None 412 | detect_alt_data = detect_data.copy() 413 | if last_target and 'target_lang' not in data: 414 | detect_alt_data['target_lang'] = last_target 415 | items.append( 416 | ExtensionResultItem(icon='images/icon.png', 417 | name='Detect language', 418 | description=description, 419 | highlightable=False, 420 | on_enter=ExtensionCustomAction(detect_data, keep_app_open=True), 421 | on_alt_enter=ExtensionCustomAction(detect_alt_data, keep_app_open=True)) 422 | ) 423 | 424 | for i in range((page - 1) * languages_per_page - (1 if page != 1 else 0), 425 | min(len(languages), page * languages_per_page - 1)): 426 | language = languages[i] 427 | 428 | new_data = data.copy() 429 | if 'page' in new_data: 430 | del new_data['page'] 431 | new_data['source_lang'] = language.code 432 | new_alt_data = new_data.copy() 433 | if last_target and 'target_lang' not in data: 434 | new_alt_data['target_lang'] = last_target 435 | items.append(ExtensionResultItem(icon='images/icon.png', 436 | name=f'Translate from {language.name}', 437 | description=description, 438 | highlightable=False, 439 | on_enter=ExtensionCustomAction(new_data, keep_app_open=True), 440 | on_alt_enter=ExtensionCustomAction(new_alt_data, keep_app_open=True))) 441 | 442 | return RenderResultListAction(items) 443 | elif data['source_lang']: 444 | self.set_last_source_language(data['source_lang']) 445 | 446 | if 'target_lang' not in data: 447 | languages = sorted(self.get_target_languages(), 448 | key=cmp_to_key(lambda lang1, lang2: compare(last_target_languages, lang1, lang2))) 449 | 450 | page = data['page'] if 'page' in data else 1 451 | total_page_count = math.ceil((len(languages) + 1) / languages_per_page) 452 | 453 | items = [] 454 | if total_page_count > 1: 455 | page_descriptions = [] 456 | next_page, previous_page = page < total_page_count, page > 1 457 | if next_page: 458 | page_descriptions.append('Enter for next page') 459 | if previous_page: 460 | page_descriptions.append('Alt+Enter for previous page') 461 | 462 | page_data = data.copy() 463 | page_data['page'] = page + 1 464 | page_alt_data = data.copy() 465 | page_alt_data['page'] = page - 1 466 | 467 | items.append( 468 | ExtensionResultItem( 469 | icon='images/icon.png', 470 | name=f'Page {page}/{total_page_count}', 471 | description=', '.join(page_descriptions), 472 | highlightable=False, 473 | on_enter=ExtensionCustomAction(page_data, keep_app_open=True) if next_page else None, 474 | on_alt_enter=ExtensionCustomAction(page_alt_data, 475 | keep_app_open=True) if previous_page else None) 476 | ) 477 | 478 | for i in range((page - 1) * languages_per_page, min(len(languages), page * languages_per_page)): 479 | language = languages[i] 480 | 481 | new_data = data.copy() 482 | if 'page' in new_data: 483 | del new_data['page'] 484 | new_data['target_lang'] = language.code 485 | items.append(ExtensionResultItem(icon='images/icon.png', 486 | name=f'Translate to {language.name}', 487 | highlightable=False, 488 | on_enter=ExtensionCustomAction(new_data, keep_app_open=True))) 489 | 490 | return RenderResultListAction(items) 491 | if data['target_lang']: 492 | self.set_last_target_language(data['target_lang']) 493 | 494 | if 'translate_directly' in data and not data['translate_directly']: 495 | new_data = data.copy() 496 | new_data['translate_directly'] = True 497 | 498 | source_lang = data['source_lang'] 499 | target_lang = data['target_lang'] 500 | return RenderResultListAction([ 501 | ExtensionResultItem(icon='images/icon.png', 502 | name=f'Translate ' + 503 | (f'from {self.get_source_language_name(source_lang)} ' if source_lang else '') 504 | + f'to {self.get_target_language_name(target_lang)}', 505 | highlightable=False, 506 | on_enter=ExtensionCustomAction(new_data, keep_app_open=True)) 507 | ]) 508 | 509 | try: 510 | supports_formality = False 511 | for language in self.get_target_languages(): 512 | if language.code == data['target_lang']: 513 | supports_formality = language.supports_formality 514 | if supports_formality: 515 | try: 516 | formality = Formality[self.preferences['formality'].upper()] 517 | except KeyError: 518 | formality = Formality.DEFAULT 519 | else: 520 | formality = Formality.DEFAULT 521 | 522 | result = self.translator.translate_text(data['text'].strip(), 523 | source_lang=data['source_lang'], 524 | target_lang=data['target_lang'], 525 | formality=formality) 526 | source_lang, target_lang = data['source_lang'] or result.detected_source_lang, data['target_lang'] 527 | 528 | split_result = str(self.preferences['split_result']) 529 | shown_text = None 530 | if split_result.isnumeric(): 531 | split_result_int = int(split_result) 532 | if split_result_int is not 0: 533 | parts, current = [], None 534 | for word in result.text.split(' '): 535 | new_current = f'{current} {word}' if current else word 536 | if not current or len(new_current) <= split_result_int: 537 | current = new_current 538 | else: 539 | parts.append(current) 540 | current = word 541 | parts.append(current) 542 | shown_text = '\n'.join(parts) 543 | if not shown_text: 544 | shown_text = result.text 545 | 546 | keyword = data['keyword'] 547 | return RenderResultListAction([ 548 | ExtensionResultItem(icon='images/icon.png', 549 | name=f'Translation: {self.get_source_language_name(source_lang)} \u27A1 ' 550 | f'{self.get_target_language_name(target_lang)}', 551 | description=shown_text, 552 | highlightable=False, 553 | on_enter=CopyToClipboardAction(result.text), 554 | on_alt_enter=ExtensionCustomAction({'reset': result.text, 555 | 'keyword': keyword}, keep_app_open=True) 556 | if data['text'] == result.text else SetUserQueryAction( 557 | f'{keyword} {target_lang.lower().split("-")[0]}:select {result.text}')), 558 | ExtensionResultItem(icon='images/icon.png', 559 | name='Actions', 560 | description='Enter on the result item to copy the result.' 561 | '\nAlt+Enter on the result item to translate the result into another ' 562 | 'language.' 563 | '\nEnter on this item to translate again and reset the input text.' 564 | '\nAlt+Enter on this item to translate again and keep the input text.', 565 | highlightable=False, 566 | on_enter=SetUserQueryAction(f'{keyword} '), 567 | on_alt_enter=ExtensionCustomAction({'reset': data['original_text'], 568 | 'keyword': keyword}, 569 | keep_app_open=True)) 570 | ]) 571 | except DeepLException as error: 572 | LOGGER.error(error) 573 | return RenderResultListAction([ 574 | ExtensionResultItem(icon='images/icon.png', 575 | name='An error occured', 576 | highlightable=False, 577 | on_enter=HideWindowAction()) 578 | ]) 579 | 580 | 581 | class SystemExitEventListener(EventListener): 582 | 583 | def on_event(self, event: SystemExitEvent, extension: DeepLExtension): 584 | json.dump(extension.data, extension.data_file.open('w')) 585 | 586 | 587 | class PreferencesEventListener(EventListener): 588 | 589 | def on_event(self, event: PreferencesEvent, extension: DeepLExtension): 590 | api_key = event.preferences['api_key'] 591 | extension.translator = Translator(api_key) if api_key else None 592 | 593 | 594 | class PreferencesUpdateEventListener(EventListener): 595 | 596 | def on_event(self, event: PreferencesUpdateEvent, extension: DeepLExtension): 597 | if event.id == 'api_key': 598 | extension.translator = Translator(event.new_value) if event.new_value else None 599 | 600 | 601 | class KeywordQueryEventListener(EventListener): 602 | 603 | def on_event(self, event: KeywordQueryEvent, extension: DeepLExtension): 604 | return extension.on_input(event.get_keyword(), event.get_argument()) 605 | 606 | 607 | class ItemEnterListener(EventListener): 608 | 609 | def on_event(self, event: ItemEnterEvent, extension: DeepLExtension): 610 | return extension.on_enter(event.get_data()) 611 | 612 | 613 | if __name__ == '__main__': 614 | DeepLExtension().run() 615 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------