├── src ├── .DS_Store └── anki_ipa │ ├── .DS_Store │ ├── icons │ └── button.png │ ├── config.json │ ├── consts.py │ ├── config.md │ ├── config.py │ ├── utils.py │ ├── test_utils.py │ ├── test_parse_ipa_transcription.py │ ├── parse_ipa_transcription.py │ ├── main.py │ ├── __init__.py │ └── batch_adding.py ├── .github ├── FUNDING.yml └── ISSUE_TEMPLATE │ ├── feature_request.md │ └── bug_report.md ├── screenshots ├── screenshot.png ├── screenshot0.png ├── screenshot_1.png ├── screenshot_2.png ├── screenshot_3.png ├── new_screenshot_1.jpg ├── new_screenshot_2.jpg ├── screenshot_batch_adding.png ├── screenshot_config_button.png └── screenshot_configuration.png ├── addon.json ├── .gitignore ├── README.md ├── CODE_OF_CONDUCT.md └── LICENSE.md /src/.DS_Store: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/m-rtin/anki-ipa/HEAD/src/.DS_Store -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | ko_fi: martyngal 4 | -------------------------------------------------------------------------------- /src/anki_ipa/.DS_Store: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/m-rtin/anki-ipa/HEAD/src/anki_ipa/.DS_Store -------------------------------------------------------------------------------- /screenshots/screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/m-rtin/anki-ipa/HEAD/screenshots/screenshot.png -------------------------------------------------------------------------------- /screenshots/screenshot0.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/m-rtin/anki-ipa/HEAD/screenshots/screenshot0.png -------------------------------------------------------------------------------- /screenshots/screenshot_1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/m-rtin/anki-ipa/HEAD/screenshots/screenshot_1.png -------------------------------------------------------------------------------- /screenshots/screenshot_2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/m-rtin/anki-ipa/HEAD/screenshots/screenshot_2.png -------------------------------------------------------------------------------- /screenshots/screenshot_3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/m-rtin/anki-ipa/HEAD/screenshots/screenshot_3.png -------------------------------------------------------------------------------- /src/anki_ipa/icons/button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/m-rtin/anki-ipa/HEAD/src/anki_ipa/icons/button.png -------------------------------------------------------------------------------- /screenshots/new_screenshot_1.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/m-rtin/anki-ipa/HEAD/screenshots/new_screenshot_1.jpg -------------------------------------------------------------------------------- /screenshots/new_screenshot_2.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/m-rtin/anki-ipa/HEAD/screenshots/new_screenshot_2.jpg -------------------------------------------------------------------------------- /screenshots/screenshot_batch_adding.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/m-rtin/anki-ipa/HEAD/screenshots/screenshot_batch_adding.png -------------------------------------------------------------------------------- /screenshots/screenshot_config_button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/m-rtin/anki-ipa/HEAD/screenshots/screenshot_config_button.png -------------------------------------------------------------------------------- /screenshots/screenshot_configuration.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/m-rtin/anki-ipa/HEAD/screenshots/screenshot_configuration.png -------------------------------------------------------------------------------- /src/anki_ipa/config.json: -------------------------------------------------------------------------------- 1 | { 2 | "WORD_FIELD": "Front", 3 | "IPA_FIELD": "IPA", 4 | "KEYBOARD_SHORTCUT": "Ctrl+Shift+Z", 5 | "STRIP_SYLLABLE_SEPARATOR": true 6 | } 7 | -------------------------------------------------------------------------------- /addon.json: -------------------------------------------------------------------------------- 1 | { 2 | "display_name": "Anki IPA", 3 | "module_name": "anki_ipa", 4 | "repo_name": "anki-ipa", 5 | "ankiweb_id": "799647424", 6 | "author": "m-rtin", 7 | "homepage": "https://github.com/m-rtin/anki-ipa", 8 | "copyright_start": 2018, 9 | "tags": "IPA", 10 | "conflicts": [], 11 | "targets": [ 12 | "anki21" 13 | ] 14 | } -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: enhancement 6 | assignees: m-rtin 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: bug 6 | assignees: m-rtin 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **Screenshots** 14 | If applicable, add screenshots to help explain your problem. Make sure your selected language is visible! 15 | 16 | **Expected behavior** 17 | A clear and concise description of what you expected to happen. 18 | -------------------------------------------------------------------------------- /src/anki_ipa/consts.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | """ 4 | This file is part of the Anki IPA add-on for Anki. 5 | Global variables 6 | Copyright: (c) 2019 m-rtin 7 | License: GNU AGPLv3 8 | """ 9 | 10 | LANGUAGES_MAP = { 11 | 'eng_a': 'american', 12 | 'eng_b': 'british', 13 | 'ru': 'russian', 14 | 'fr': 'french', 15 | 'es': 'spanish', 16 | 'ger': 'german', 17 | 'pl': 'polish', 18 | 'nl': 'dutch', 19 | } 20 | 21 | 22 | -------------------------------------------------------------------------------- /src/anki_ipa/config.md: -------------------------------------------------------------------------------- 1 | Help for configuration options. 2 | 3 |   4 | 5 | - **`"WORD_FIELD"`**: Field which contains the word or words you would like to get an IPA transcription for. 6 | 7 |   8 | 9 | - **`"IPA_FIELD"`**: The field name where the IPA transcription should be written into. 10 |   11 | 12 | - **`"KEYBOAD_SHORTCUT"`**: Shortcut that can be used to execute the add on. 13 | 14 |   15 | 16 | - **`"STRIP_SYLLABLE_SEPARATOR"`**: IPA syntax includes a period (.) between two syllables when betweem two consecutive vowels in hiatus. For example `kre.entsa`. By default this is stripped out but if desired it can be retained. 17 | -------------------------------------------------------------------------------- /src/anki_ipa/config.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | """ 4 | This file is part of the Anki IPA add-on for Anki. 5 | Synchronize addon configuration. 6 | Copyright: (c) m-rtin 7 | License: GNU AGPLv3 8 | """ 9 | 10 | from aqt import mw 11 | 12 | 13 | def setup_synced_config() -> None: 14 | """Create new configuration if not already done.""" 15 | conf_name = "anki_ipa_conf" 16 | 17 | if conf_name not in mw.col.conf: 18 | mw.col.conf[conf_name] = { 19 | "defaultlangperdeck": 1, 20 | "deckdefaultlang": {}, # default addon language for specific decks 21 | "lang": "eng" 22 | } -------------------------------------------------------------------------------- /src/anki_ipa/utils.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | """ 4 | This file is part of the Anki IPA add-on for Anki. 5 | Miscellaneous 6 | Copyright: (c) m-rtin 7 | License: GNU AGPLv3 8 | """ 9 | 10 | import re 11 | 12 | from typing import List 13 | 14 | 15 | def get_words_from_field(field_text: str) -> List[str]: 16 | """ Get all the words in a given note field. 17 | 18 | :param field_text: text of the given field 19 | :return: words in the given field 20 | """ 21 | clean_regex = re.compile('<.*?>') 22 | cleaned_textfield = re.sub(clean_regex, '', field_text) 23 | cleaned_textfield = cleaned_textfield.replace(" ", " ") 24 | 25 | return cleaned_textfield.split() 26 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Anki 2 | src/*/manifest.json 3 | src/__pycache__ 4 | # Byte-compiled / optimized / DLL files 5 | __pycache__/ 6 | *.py[cod] 7 | 8 | # C extensions 9 | *.so 10 | 11 | # Distribution / packaging 12 | bin/ 13 | build/ 14 | develop-eggs/ 15 | dist/ 16 | eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | *.egg-info/ 23 | .installed.cfg 24 | *.egg 25 | 26 | # Installer logs 27 | pip-log.txt 28 | pip-delete-this-directory.txt 29 | 30 | # Unit test / coverage reports 31 | .tox/ 32 | .coverage 33 | .cache 34 | nosetests.xml 35 | coverage.xml 36 | 37 | # Translations 38 | *.mo 39 | 40 | # Mr Developer 41 | .mr.developer.cfg 42 | .project 43 | .pydevproject 44 | 45 | # Rope 46 | .ropeproject 47 | 48 | # Django stuff: 49 | *.log 50 | *.pot 51 | 52 | # Sphinx documentation 53 | docs/_build/ -------------------------------------------------------------------------------- /src/anki_ipa/test_utils.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | """ 4 | This file is part of the Anki IPA add-on for Anki. 5 | Test miscellaneous 6 | Copyright: (c) 2019 m-rtin 7 | License: GNU AGPLv3 8 | """ 9 | 10 | import unittest 11 | import utils 12 | 13 | 14 | class TestMisc(unittest.TestCase): 15 | 16 | def test_get_words_from_field(self): 17 | """Check that HTML codes get removed.""" 18 | test_str = "das ist ein     
Test
" 19 | expected = ["das", "ist", "ein", "Test"] 20 | self.assertEqual(utils.get_words_from_field(test_str), expected) 21 | 22 | test_str = ('diffusée   

lumière  

' 23 | 'latin
') 24 | expected = ["diffusée", "lumière", "latin"] 25 | self.assertEqual(utils.get_words_from_field(test_str), expected) 26 | 27 | 28 | if __name__ == "__main__": 29 | unittest.main() 30 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | 3 |

Anki IPA

4 |

5 | 6 |
7 |

8 | 9 | 10 | Allows you to insert IPA transcriptions into the spaced-repetition flashcard app [Anki](https://apps.ankiweb.net/). 11 | 12 | ### Installation 13 | 14 | The easiest way to install Anki IPA is through [AnkiWeb](https://ankiweb.net/shared/info/799647424). 15 | 16 | 17 | ### Testing 18 | 19 | To test the addon in Anki, navigate to Tools/Add-ons and press on the "View Files" button. The addons21 directory should open up in your file explorer. Copy your local `anki-ipa/src/anki_ipa/` folder into this directory and restart Anki. You are now able to test the addon. 20 | 21 | To run the unittests of this project, go to the anki-ipa/src/anki_ipa directory and run: 22 | 23 | `python3 -m test_parse_ipa_transcription` 24 | 25 | ### Contributing 26 | 27 | New languages can be added the [parse_ipa_transcription.py](https://github.com/m-rtin/anki-ipa/blob/master/src/anki_ipa/parse_ipa_transcription.py) file. The changes should be tested in the [test_parse_ipa_transcription.py](https://github.com/m-rtin/anki-ipa/blob/master/src/anki_ipa/test_parse_ipa_transcription.py) file. 28 | 29 | ### License and Credits 30 | 31 | *Anki IPA* is based on [*Syntax Highlighting for Code*](https://ankiweb.net/shared/info/1463041493) and [*Batch Editing*](https://ankiweb.net/shared/info/291119185) by [Glutanimate](https://github.com/glutanimate). 32 | 33 | Anki IPA is free and open-source software. The add-on code that runs within Anki is released under the GNU AGPLv3 license, extended by a number of additional terms. For more information please see the [LICENSE](https://github.com/m-rtin/anki-ipa/blob/master/LICENSE) file that accompanied this program. 34 | 35 | This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY. 36 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, sex characteristics, gender identity and expression, 9 | level of experience, education, socio-economic status, nationality, personal 10 | appearance, race, religion, or sexual identity and orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | * Using welcoming and inclusive language 18 | * Being respectful of differing viewpoints and experiences 19 | * Gracefully accepting constructive criticism 20 | * Focusing on what is best for the community 21 | * Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | * The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | * Trolling, insulting/derogatory comments, and personal or political attacks 28 | * Public or private harassment 29 | * Publishing others' private information, such as a physical or electronic 30 | address, without explicit permission 31 | * Other conduct which could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies both within project spaces and in public spaces 49 | when an individual is representing the project or its community. Examples of 50 | representing a project or community include using an official project e-mail 51 | address, posting via an official social media account, or acting as an appointed 52 | representative at an online or offline event. Representation of a project may be 53 | further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting the project team at m-rtin@gmx.net. All 59 | complaints will be reviewed and investigated and will result in a response that 60 | is deemed necessary and appropriate to the circumstances. The project team is 61 | obligated to maintain confidentiality with regard to the reporter of an incident. 62 | Further details of specific enforcement policies may be posted separately. 63 | 64 | Project maintainers who do not follow or enforce the Code of Conduct in good 65 | faith may face temporary or permanent repercussions as determined by other 66 | members of the project's leadership. 67 | 68 | ## Attribution 69 | 70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 71 | available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html 72 | 73 | [homepage]: https://www.contributor-covenant.org 74 | 75 | For answers to common questions about this code of conduct, see 76 | https://www.contributor-covenant.org/faq 77 | -------------------------------------------------------------------------------- /src/anki_ipa/test_parse_ipa_transcription.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | """ 4 | This file is part of the Anki IPA add-on for Anki. 5 | Test parsing methods 6 | Copyright: (c) 2019 m-rtin 7 | License: GNU AGPLv3 8 | """ 9 | 10 | import unittest 11 | import parse_ipa_transcription as parse_ipa 12 | 13 | 14 | class TestParseIpa(unittest.TestCase): 15 | 16 | def test_british(self): 17 | # * {{a|RP}} {{IPA|en|/ˈtʃɑː.kəʊl/}} 18 | self.assertEqual(parse_ipa.british("charcoal"), "ˈtʃɑːkəʊl") 19 | self.assertEqual(parse_ipa.british("dog"), "dɒɡ") 20 | self.assertEqual(parse_ipa.british("thumb"), "θʌm") 21 | self.assertEqual(parse_ipa.british("box"), "bɒks") 22 | # * {{a|UK}} {{IPA|en|/bɜːst/}} 23 | self.assertEqual(parse_ipa.british("burst"), "bɜːst") 24 | self.assertEqual(parse_ipa.british("hill"), "hɪl|hɪɫ") 25 | # {{a|RP|GA}} {{IPA|en|/bæk/|[bæk]|[bak]|[-k̚]|[-ˀk]}} 26 | self.assertEqual(parse_ipa.british("back"), "bæk|bæk|bak|-k̚|-ˀk") 27 | # {{a|RP}} {{IPA|en|/ɹɪˈɡɑːd/}} 28 | self.assertEqual(parse_ipa.british("regard"), "ɹɪˈɡɑːd") 29 | self.assertEqual(parse_ipa.british("out"), "aʊt") 30 | 31 | def test_american(self): 32 | # * {{a|GA}} {{IPA|en|/ˈt͡ʃɑɹ.koʊl/}} 33 | self.assertEqual(parse_ipa.american("charcoal"), "ˈt͡ʃɑɹkoʊl") 34 | self.assertEqual(parse_ipa.american("dog"), "dɒɡ") 35 | self.assertEqual(parse_ipa.american("thumb"), "θʌm") 36 | self.assertEqual(parse_ipa.american("box"), "bɑks") 37 | # * {{a|US}} {{IPA|en|/bɝst/}} 38 | self.assertEqual(parse_ipa.american("burst"), "bɚst") 39 | # {{enPR|hĭl}}, {{IPA|en|/hɪl/|[hɪɫ]}} 40 | self.assertEqual(parse_ipa.american("hill"), "hɪl|hɪɫ") 41 | # {{a|RP|GA}} {{IPA|en|/bæk/|[bæk]|[bak]|[-k̚]|[-ˀk]}} 42 | self.assertEqual(parse_ipa.american("back"), "bæk|bæk|bak|-k̚|-ˀk") 43 | # {{a|GenAm}} {{IPA|en|/ɹɪˈɡɑɹd/}} 44 | self.assertEqual(parse_ipa.american("regard"), "ɹɪˈɡɑɹd") 45 | self.assertEqual(parse_ipa.american("out"), "aʊt") 46 | 47 | def test_russian(self): 48 | self.assertEqual(parse_ipa.russian("спасибо"), "spɐˈsʲibə") 49 | 50 | def test_french(self): 51 | self.assertEqual(parse_ipa.french("occasion"), "ɔkazjɔ̃, əˈkeɪʒən") 52 | self.assertEqual(parse_ipa.french("rencontre"), "ʁɑ̃kɔ̃tʁ") 53 | 54 | def test_spanish(self): 55 | self.assertEqual(parse_ipa.spanish("eternidad"), "eteɾniˈðað") 56 | 57 | def test_german(self): 58 | self.assertEqual(parse_ipa.german("Land"), "lant") 59 | self.assertEqual(parse_ipa.german("blau"), "blaʊ̯") 60 | self.assertEqual(parse_ipa.german("Kind"), "kɪnt") 61 | self.assertEqual(parse_ipa.german("spielen"), "ˈʃpiːlən") 62 | self.assertEqual(parse_ipa.german("treffen"), "ˈtʁɛfn̩") 63 | self.assertEqual(parse_ipa.german("gelb"), "ɡɛlp") 64 | self.assertEqual(parse_ipa.german("Mensch"), "mɛnʃ") 65 | self.assertEqual(parse_ipa.german("Hund"), "hʊnt") 66 | self.assertEqual(parse_ipa.german("grün"), "ɡʁyːn") 67 | self.assertEqual(parse_ipa.german("rot"), "ʁoːt") 68 | self.assertEqual(parse_ipa.german("blau"), "blaʊ̯") 69 | self.assertEqual(parse_ipa.german("braun"), "bʁaʊ̯n") 70 | self.assertEqual(parse_ipa.german("Hilfe"), "ˈhɪlfə") 71 | self.assertEqual(parse_ipa.german("zwei"), "t͡svaɪ̯") 72 | self.assertEqual(parse_ipa.german("drei"), "dʁaɪ̯") 73 | self.assertEqual(parse_ipa.german("vier"), "fiːɐ̯") 74 | self.assertEqual(parse_ipa.german("zehn"), "t͡seːn") 75 | self.assertEqual(parse_ipa.german("acht"), "axt") 76 | self.assertEqual(parse_ipa.german("neun"), "nɔɪ̯n") 77 | self.assertEqual(parse_ipa.german("nein"), "naɪ̯n") 78 | self.assertEqual(parse_ipa.german("Fenster"), "ˈfɛnstɐ") 79 | self.assertEqual(parse_ipa.german("Ente"), "ˈɛntə") 80 | self.assertEqual(parse_ipa.german("Katze"), "ˈkat͡sə") 81 | self.assertEqual(parse_ipa.german("Buch"), "buːx") 82 | self.assertEqual(parse_ipa.german("Eintrag"), "ˈaɪ̯nˌtʁaːk") 83 | # :{{IPA}} ''standardsprachlich (gemeindeutsch):'' {{Lautschrift|ʃpɛːt}} 84 | self.assertEqual(parse_ipa.german("spät"), "ʃpɛːt") 85 | 86 | def test_polish(self): 87 | self.assertEqual(parse_ipa.polish("asteroida"), "ˌastɛˈrɔjda") 88 | self.assertEqual(parse_ipa.polish("mały"), "ˈmawɨ") 89 | 90 | def test_dutch(self): 91 | self.assertEqual(parse_ipa.dutch("wit"), "wit, wɪt, ʋɪt") 92 | self.assertEqual(parse_ipa.dutch("lucht"), "lʏxt") 93 | 94 | if __name__ == "__main__": 95 | unittest.main() 96 | -------------------------------------------------------------------------------- /src/anki_ipa/parse_ipa_transcription.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | """ 4 | This file is part of the Anki IPA add-on for Anki. 5 | Parsing methods 6 | Copyright: (c) 2019 m-rtin 7 | License: GNU AGPLv3 8 | """ 9 | 10 | import urllib 11 | import bs4 12 | import re 13 | import requests 14 | from typing import List 15 | 16 | # Create a dictionary for all transcription methods 17 | transcription_methods = {} 18 | transcription = lambda f: transcription_methods.setdefault(f.__name__, f) 19 | 20 | 21 | @transcription 22 | def british(word: str, strip_syllable_separator: bool) -> str: 23 | payload = {'action': 'parse', 'page': word, 'format': 'json', 'prop': 'wikitext'} 24 | r = requests.get('https://en.wiktionary.org/w/api.php', params=payload) 25 | try: 26 | wikitext = r.json()['parse']['wikitext']['*'] 27 | p = re.compile("{{a\|UK}} {{IPA\|en\|([^}]+)}}") 28 | m = p.search(wikitext) 29 | if m is None: 30 | p = re.compile("{{a\|RP}} {{IPA\|en\|([^}]+)}}") 31 | m = p.search(wikitext) 32 | if m is None: 33 | p = re.compile("{{IPA\|en\|([^}]+)}}") 34 | m = p.search(wikitext) 35 | if m is None: 36 | p = re.compile("{{IPA\|en\|([^}]+)\|([^}]+)}}") 37 | m = p.search(wikitext) 38 | 39 | ipa = m.group(1) 40 | return remove_special_chars(word=ipa, strip_syllable_separator=strip_syllable_separator) 41 | except (KeyError, AttributeError): 42 | return "" 43 | 44 | @transcription 45 | def american(word: str, strip_syllable_separator: bool) -> str: 46 | payload = {'action': 'parse', 'page': word, 'format': 'json', 'prop': 'wikitext'} 47 | r = requests.get('https://en.wiktionary.org/w/api.php', params=payload) 48 | try: 49 | wikitext = r.json()['parse']['wikitext']['*'] 50 | p = re.compile("{{a\|US}} {{IPA\|en\|([^}]+)}}") 51 | m = p.search(wikitext) 52 | if m is None: 53 | p = re.compile("{{a\|GA}}.*?{{IPA\|en\|([^}]+)}}") 54 | m = p.search(wikitext) 55 | if m is None: 56 | p = re.compile("{{a\|GenAm}}.*?{{IPA\|en\|([^}]+)}}") 57 | m = p.search(wikitext) 58 | if m is None: 59 | p = re.compile("{{IPA\|en\|([^}]+)}}") 60 | m = p.search(wikitext) 61 | if m is None: 62 | p = re.compile("{{IPA\|en\|([^}]+)\|([^}]+)}}") 63 | m = p.search(wikitext) 64 | 65 | ipa = m.group(1) 66 | return remove_special_chars(word=ipa, strip_syllable_separator=strip_syllable_separator) 67 | except (KeyError, AttributeError): 68 | return "" 69 | 70 | @transcription 71 | def french(word: str, strip_syllable_separator: bool) -> str: 72 | link = f"https://fr.wiktionary.org/wiki/{word}" 73 | return ", ".join(parse_website(link, {'title': 'Prononciation API'}, strip_syllable_separator)) 74 | 75 | 76 | @transcription 77 | def russian(word: str, strip_syllable_separator: bool) -> str: 78 | link = f"https://ru.wiktionary.org/wiki/{word}" 79 | return ", ".join(parse_website(link, {'class': 'IPA'}, strip_syllable_separator)) 80 | 81 | 82 | @transcription 83 | def spanish(word: str, strip_syllable_separator: bool) -> str: 84 | link = f"https://es.wiktionary.org/wiki/{word}" 85 | return ", ".join(parse_website(link, {'class': 'ipa'}, strip_syllable_separator)) 86 | 87 | 88 | @transcription 89 | def german(word: str, strip_syllable_separator: bool) -> str: 90 | payload = {'action': 'parse', 'page': word, 'format': 'json', 'prop': 'wikitext'} 91 | r = requests.get('https://de.wiktionary.org/w/api.php', params=payload) 92 | try: 93 | wikitext = r.json()['parse']['wikitext']['*'] 94 | p = re.compile("{{IPA}}.*?{{Lautschrift\|([^}]+)") 95 | m = p.search(wikitext) 96 | ipa = m.group(1) 97 | return ipa 98 | except (KeyError, AttributeError): 99 | return "" 100 | 101 | @transcription 102 | def polish(word: str, strip_syllable_separator: bool) -> str: 103 | link = f"https://pl.wiktionary.org/wiki/{word}" 104 | return ", ".join(parse_website( 105 | link, {'title': 'To jest wymowa w zapisie IPA; zobacz hasło IPA w Wikipedii'}, strip_syllable_separator)) 106 | 107 | 108 | @transcription 109 | def dutch(word: str, strip_syllable_separator: bool) -> str: 110 | link = f"https://nl.wiktionary.org/wiki/{word}" 111 | return ", ".join(parse_website(link, {"class": "IPAtekst"}, strip_syllable_separator)) 112 | 113 | def parse_website(link: str, css_code: dict, strip_syllable_separator: bool=True) -> List[str]: 114 | try: 115 | website = requests.get(link) 116 | except requests.exceptions.RequestException as e: 117 | return [""] 118 | soup = bs4.BeautifulSoup(website.text, "html.parser") 119 | results = soup.find_all('span', css_code) 120 | if strip_syllable_separator: 121 | transcriptions = map(lambda result: result.getText() 122 | .replace("/", "") 123 | .replace("]", "") 124 | .replace("[", "") 125 | .replace(".", "") 126 | .replace("\\", ""), results) 127 | else: 128 | transcriptions = map(lambda result: result.getText() 129 | .replace("/", "") 130 | .replace("]", "") 131 | .replace("[", "") 132 | .replace("\\", ""), results) 133 | _transcriptions = sorted(list(set(transcriptions))[0]) 134 | return _transcriptions 135 | 136 | 137 | def remove_special_chars(word: str, strip_syllable_separator: bool) -> str: 138 | word = word.replace("/", "").replace("]", "").replace("[", "").replace("\\", "").replace(".", "") 139 | if strip_syllable_separator: 140 | word = word.replace(".", "") 141 | return word 142 | 143 | 144 | def transcript(words: List[str], language: str, strip_syllable_separator: bool=True) -> str: 145 | transcription_method = transcription_methods[language] 146 | transcribed_words = [transcription_method(word, strip_syllable_separator) for word in words] 147 | return " ".join(transcribed_words) 148 | -------------------------------------------------------------------------------- /src/anki_ipa/main.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | """ 4 | This file is part of the Anki IPA add-on for Anki. 5 | Main Module, hooks add-on methods into Anki. 6 | Copyright: (c) m-rtin 7 | License: GNU AGPLv3 8 | """ 9 | 10 | import os 11 | import urllib 12 | import logging 13 | 14 | 15 | from anki.hooks import addHook, wrap 16 | from aqt import mw 17 | from aqt.editor import Editor 18 | from aqt.utils import showInfo 19 | 20 | from . import consts, parse_ipa_transcription, utils, batch_adding 21 | from .config import setup_synced_config 22 | from typing import List, Callable 23 | 24 | filename = os.path.join(os.path.dirname(os.path.realpath(__file__)), "app.log") 25 | logging.basicConfig(filename=filename, level=logging.DEBUG) 26 | 27 | ADDON_PATH = os.path.dirname(__file__) 28 | ICON_PATH = os.path.join(ADDON_PATH, "icons", "button.png") 29 | CONFIG = mw.addonManager.getConfig(__name__) 30 | 31 | select_elm = ("""""") 34 | 35 | 36 | def paste_ipa(editor: Editor) -> None: 37 | """ Paste IPA transcription into the IPA field of the Anki editor. 38 | 39 | :param editor: Anki editor window 40 | """ 41 | lang_alias = editor.ipa_lang_alias 42 | note = editor.note 43 | 44 | # Get content of text field 45 | try: 46 | field_text = note[CONFIG["WORD_FIELD"]] 47 | except KeyError: 48 | showInfo(f"Field '{CONFIG['WORD_FIELD']}' doesn't exist.") 49 | return 50 | logging.debug(f"Field text: {field_text}") 51 | 52 | field_text = field_text.lower() 53 | 54 | # get word list from text field 55 | words = utils.get_words_from_field(field_text) 56 | logging.debug(f"Word list: {words}") 57 | 58 | # parse IPA transcription for every word in word list 59 | try: 60 | ipa = parse_ipa_transcription.transcript(words=words, language=lang_alias) 61 | except (urllib.error.HTTPError, IndexError): 62 | showInfo("IPA not found.") 63 | return 64 | logging.debug(f"IPA transcription string: {ipa}") 65 | 66 | # paste IPA transcription of every word in IPA transcription field 67 | try: 68 | note[CONFIG["IPA_FIELD"]] = ipa 69 | except KeyError: 70 | showInfo(f"Field '{CONFIG['IPA_FIELD']}' doesn't exist.") 71 | return 72 | 73 | # update editor 74 | editor.loadNote() 75 | editor.web.setFocus() 76 | 77 | 78 | def get_deck_name(main_window: mw) -> str: 79 | """ Get the name of the current deck. 80 | 81 | :param main_window: main window of Anki 82 | :return: name of selected deck 83 | """ 84 | try: 85 | deck_name = main_window.col.decks.current()['name'] 86 | except AttributeError: 87 | # No deck opened? 88 | deck_name = None 89 | return deck_name 90 | 91 | 92 | def get_default_lang(main_window: mw) -> str: 93 | """ Get the IPA default language. 94 | 95 | :param main_window: main window of Anki 96 | :return: default IPA language for Anki or Anki deck 97 | """ 98 | config = mw.col.conf['anki_ipa_conf'] 99 | lang = config['lang'] 100 | if config['defaultlangperdeck']: 101 | deck_name = get_deck_name(main_window) 102 | if deck_name and deck_name in config['deckdefaultlang']: 103 | lang = config['deckdefaultlang'][deck_name] 104 | return lang 105 | 106 | 107 | def on_setup_buttons(buttons: List[str], editor: Editor) -> List[str]: 108 | """ Add Addon button and Addon combobox to card editor. 109 | 110 | :param buttons: HTML codes of the editor buttons (e.g. for bold, italic, ...) 111 | :param editor: card editor object 112 | :return: updated list of buttons 113 | """ 114 | # add HTML button 115 | button = editor.addButton(ICON_PATH, "IPA", paste_ipa) 116 | buttons.append(button) 117 | 118 | # create list of language options 119 | previous_lang = get_default_lang(mw) 120 | options = [f""""""] # first entry is the last selection 121 | 122 | options += [ 123 | f"""""" 124 | for language in sorted(consts.LANGUAGES_MAP.keys(), key=str.lower) 125 | if language != previous_lang 126 | ] 127 | 128 | # add HTML combobox 129 | combo = select_elm.format("".join(options)) 130 | buttons.append(combo) 131 | 132 | return buttons 133 | 134 | 135 | def set_default_lang(main_window: mw, lang: str) -> None: 136 | """ Set new IPA default language. 137 | 138 | :param main_window: main window of Anki 139 | :param lang: new default language 140 | """ 141 | config = mw.col.conf['anki_ipa_conf'] 142 | config['lang'] = lang # Always update the overall default 143 | if config['defaultlangperdeck']: 144 | deck_name = get_deck_name(main_window) 145 | if deck_name: 146 | config['deckdefaultlang'][deck_name] = lang 147 | 148 | 149 | def on_ipa_language_select(editor: Editor, lang: str) -> None: 150 | """ Set new default IPA language. 151 | 152 | :param editor: Anki editor window 153 | :param lang: name of selected language 154 | """ 155 | alias = consts.LANGUAGES_MAP[lang] 156 | set_default_lang(mw, lang) 157 | editor.ipa_lang_alias = alias 158 | 159 | 160 | def init_ipa(editor: Editor, *args, **kwargs) -> None: 161 | """ Get the last selected/default IPA language. 162 | 163 | :param editor: Anki editor window 164 | """ 165 | previous_lang = get_default_lang(mw) 166 | editor.ipa_lang_alias = consts.LANGUAGES_MAP.get(previous_lang, "") 167 | 168 | 169 | def on_bridge_cmd(editor: Editor, command: str, _old: Callable) -> None: 170 | """ React when new combobox selection is made. 171 | 172 | :param editor: Anki editor window 173 | :param command: editor command (e.g. own IPALang or focus, blur, key, ...) 174 | :param _old: old editor.onBridgeCmd method 175 | """ 176 | # old commands are executed like before 177 | if not command.startswith("IPALang"): 178 | _old(editor, command) 179 | # new language gets selected in the combobox 180 | else: 181 | _, lang = command.split(":") 182 | on_ipa_language_select(editor, lang) 183 | 184 | 185 | addHook("profileLoaded", setup_synced_config) 186 | # Overwrite Editor methods 187 | addHook("setupEditorButtons", on_setup_buttons) 188 | Editor.onBridgeCmd = wrap(Editor.onBridgeCmd, on_bridge_cmd, "around") 189 | Editor.__init__ = wrap(Editor.__init__, init_ipa) 190 | 191 | # Batch editing 192 | addHook("browser.setupMenus", batch_adding.setup_menu) 193 | -------------------------------------------------------------------------------- /src/anki_ipa/__init__.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | """ 4 | This file is part of the Anki IPA add-on for Anki. 5 | Main Module, hooks add-on methods into Anki. 6 | Copyright: (c) m-rtin 7 | License: GNU AGPLv3 8 | """ 9 | 10 | import os 11 | import urllib 12 | import logging 13 | 14 | 15 | from anki.hooks import addHook, wrap 16 | from aqt import mw 17 | from aqt.editor import Editor 18 | from aqt.utils import showInfo 19 | 20 | from . import consts, parse_ipa_transcription, utils, batch_adding 21 | from .config import setup_synced_config 22 | from typing import List, Callable 23 | 24 | filename = os.path.join(os.path.dirname(os.path.realpath(__file__)), "app.log") 25 | logging.basicConfig(filename=filename, level=logging.DEBUG) 26 | 27 | ADDON_PATH = os.path.dirname(__file__) 28 | ICON_PATH = os.path.join(ADDON_PATH, "icons", "button.png") 29 | CONFIG = mw.addonManager.getConfig(__name__) 30 | 31 | select_elm = ("""""") 34 | 35 | 36 | def paste_ipa(editor: Editor) -> None: 37 | """ Paste IPA transcription into the IPA field of the Anki editor. 38 | 39 | :param editor: Anki editor window 40 | """ 41 | lang_alias = editor.ipa_lang_alias 42 | note = editor.note 43 | 44 | # Get content of text field 45 | try: 46 | field_text = note[CONFIG["WORD_FIELD"]] 47 | except KeyError: 48 | showInfo(f"Field '{CONFIG['WORD_FIELD']}' doesn't exist.") 49 | return 50 | logging.debug(f"Field text: {field_text}") 51 | 52 | field_text = field_text.lower() 53 | 54 | # get word list from text field 55 | words = utils.get_words_from_field(field_text) 56 | logging.debug(f"Word list: {words}") 57 | 58 | # parse IPA transcription for every word in word list 59 | try: 60 | ipa = parse_ipa_transcription.transcript(words=words, language=lang_alias, strip_syllable_separator=CONFIG["STRIP_SYLLABLE_SEPARATOR"]) 61 | except (urllib.error.HTTPError, IndexError): 62 | showInfo("IPA not found.") 63 | return 64 | logging.debug(f"IPA transcription string: {ipa}") 65 | 66 | # paste IPA transcription of every word in IPA transcription field 67 | try: 68 | note[CONFIG["IPA_FIELD"]] = ipa 69 | except KeyError: 70 | showInfo(f"Field '{CONFIG['IPA_FIELD']}' doesn't exist.") 71 | return 72 | 73 | # update editor 74 | editor.loadNote() 75 | editor.web.setFocus() 76 | 77 | 78 | def get_deck_name(main_window: mw) -> str: 79 | """ Get the name of the current deck. 80 | 81 | :param main_window: main window of Anki 82 | :return: name of selected deck 83 | """ 84 | try: 85 | deck_name = main_window.col.decks.current()['name'] 86 | except AttributeError: 87 | # No deck opened? 88 | deck_name = None 89 | return deck_name 90 | 91 | 92 | def get_default_lang(main_window: mw) -> str: 93 | """ Get the IPA default language. 94 | 95 | :param main_window: main window of Anki 96 | :return: default IPA language for Anki or Anki deck 97 | """ 98 | config = mw.col.conf['anki_ipa_conf'] 99 | lang = config['lang'] 100 | if config['defaultlangperdeck']: 101 | deck_name = get_deck_name(main_window) 102 | if deck_name and deck_name in config['deckdefaultlang']: 103 | lang = config['deckdefaultlang'][deck_name] 104 | return lang 105 | 106 | 107 | def on_setup_buttons(buttons: List[str], editor: Editor) -> List[str]: 108 | """ Add Addon button and Addon combobox to card editor. 109 | 110 | :param buttons: HTML codes of the editor buttons (e.g. for bold, italic, ...) 111 | :param editor: card editor object 112 | :return: updated list of buttons 113 | """ 114 | shortcut_keys = CONFIG.get("KEYBOARD_SHORTCUT", "Ctrl+Shift+Z") 115 | 116 | # add HTML button 117 | button = editor.addButton( 118 | ICON_PATH, 119 | "IPA", 120 | paste_ipa, 121 | keys=shortcut_keys, 122 | tip=f"IPA transcription ({shortcut_keys})" 123 | ) 124 | buttons.append(button) 125 | 126 | # create list of language options 127 | previous_lang = get_default_lang(mw) 128 | options = [f""""""] # first entry is the last selection 129 | 130 | options += [ 131 | f"""""" 132 | for language in sorted(consts.LANGUAGES_MAP.keys(), key=str.lower) 133 | if language != previous_lang 134 | ] 135 | 136 | # add HTML combobox 137 | combo = select_elm.format("".join(options)) 138 | buttons.append(combo) 139 | 140 | return buttons 141 | 142 | 143 | def set_default_lang(main_window: mw, lang: str) -> None: 144 | """ Set new IPA default language. 145 | 146 | :param main_window: main window of Anki 147 | :param lang: new default language 148 | """ 149 | config = mw.col.conf['anki_ipa_conf'] 150 | config['lang'] = lang # Always update the overall default 151 | if config['defaultlangperdeck']: 152 | deck_name = get_deck_name(main_window) 153 | if deck_name: 154 | config['deckdefaultlang'][deck_name] = lang 155 | 156 | 157 | def on_ipa_language_select(editor: Editor, lang: str) -> None: 158 | """ Set new default IPA language. 159 | 160 | :param editor: Anki editor window 161 | :param lang: name of selected language 162 | """ 163 | alias = consts.LANGUAGES_MAP[lang] 164 | set_default_lang(mw, lang) 165 | editor.ipa_lang_alias = alias 166 | 167 | 168 | def init_ipa(editor: Editor, *args, **kwargs) -> None: 169 | """ Get the last selected/default IPA language. 170 | 171 | :param editor: Anki editor window 172 | """ 173 | previous_lang = get_default_lang(mw) 174 | editor.ipa_lang_alias = consts.LANGUAGES_MAP.get(previous_lang, "") 175 | 176 | 177 | def on_bridge_cmd(editor: Editor, command: str, _old: Callable) -> None: 178 | """ React when new combobox selection is made. 179 | 180 | :param editor: Anki editor window 181 | :param command: editor command (e.g. own IPALang or focus, blur, key, ...) 182 | :param _old: old editor.onBridgeCmd method 183 | """ 184 | # old commands are executed like before 185 | if not command.startswith("IPALang"): 186 | _old(editor, command) 187 | # new language gets selected in the combobox 188 | else: 189 | _, lang = command.split(":") 190 | on_ipa_language_select(editor, lang) 191 | 192 | 193 | addHook("profileLoaded", setup_synced_config) 194 | # Overwrite Editor methods 195 | addHook("setupEditorButtons", on_setup_buttons) 196 | Editor.onBridgeCmd = wrap(Editor.onBridgeCmd, on_bridge_cmd, "around") 197 | Editor.__init__ = wrap(Editor.__init__, init_ipa) 198 | 199 | # Batch editing 200 | addHook("browser.setupMenus", batch_adding.setup_menu) 201 | -------------------------------------------------------------------------------- /src/anki_ipa/batch_adding.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | """ 4 | This file is part of the Anki IPA add-on for Anki. 5 | Add IPA transcription in Anki browser. 6 | Copyright: (c) 2019 m-rtin 7 | License: GNU AGPLv3 8 | """ 9 | import urllib 10 | 11 | from aqt.browser import Browser 12 | from aqt.utils import tooltip, askUser 13 | import aqt.qt as qt 14 | import anki 15 | 16 | from aqt import mw 17 | CONFIG = mw.addonManager.getConfig(__name__) 18 | 19 | from typing import List, Dict 20 | from . import consts, parse_ipa_transcription, utils 21 | 22 | class AddIpaTranscriptDialog(qt.QDialog): 23 | """QDialog to add IPA transcription to multiple notes in Anki browser.""" 24 | 25 | def __init__(self, browser: Browser, selected_notes: List[int]) -> None: 26 | """ Initialize AddIpaTranscriptDialog and setup UI. 27 | 28 | :param browser: Anki browser 29 | :param selected_notes: IDs of selected notes in Anki browser 30 | """ 31 | qt.QDialog.__init__(self, parent=browser) 32 | self.thread = qt.QThread() 33 | self.browser = browser 34 | self.selected_notes = selected_notes 35 | self._setup_comboboxes() 36 | self._setup_form() 37 | self._setup_buttons() 38 | self._setup_progressbar() 39 | self._setup_main() 40 | 41 | def _setup_comboboxes(self) -> None: 42 | """Setup comboboxes for language, base field and target field.""" 43 | fields = self._get_fields() 44 | 45 | self.lang_combobox = qt.QComboBox() 46 | self.lang_combobox.addItems(consts.LANGUAGES_MAP.values()) 47 | if "LANGUAGE" in CONFIG.keys(): 48 | idx_language=self.lang_combobox.findText(CONFIG["LANGUAGE"]) 49 | if idx_language > 0: 50 | self.lang_combobox.setCurrentIndex(idx_language) 51 | self.base_combobox = qt.QComboBox() 52 | self.base_combobox.addItems(fields) 53 | if "WORD_FIELD" in CONFIG.keys(): 54 | idx_word=self.base_combobox.findText(CONFIG["WORD_FIELD"]) 55 | if idx_word > 0: 56 | self.base_combobox.setCurrentIndex(idx_word) 57 | self.field_combobox = qt.QComboBox() 58 | self.field_combobox.addItems(fields) 59 | if "IPA_FIELD" in CONFIG.keys(): 60 | idx_ipa=self.field_combobox.findText(CONFIG["IPA_FIELD"]) 61 | if idx_ipa > 0: 62 | self.field_combobox.setCurrentIndex(idx_ipa) 63 | 64 | def _setup_form(self) -> None: 65 | """Setup form for user interaction.""" 66 | self.form_group_box = qt.QGroupBox("Options") 67 | 68 | form_layout = qt.QFormLayout() 69 | form_layout.addRow(qt.QLabel("Language:"), self.lang_combobox) 70 | form_layout.addRow(qt.QLabel("Field of word:"), self.base_combobox) 71 | form_layout.addRow(qt.QLabel("Field of IPA transcription:"), self.field_combobox) 72 | 73 | self.form_group_box.setLayout(form_layout) 74 | 75 | def _setup_progressbar(self) -> None: 76 | """Setup progressbar which indicates how many IPA transcriptions already have been added.""" 77 | self.progress = qt.QProgressBar(self) 78 | self.progress.setMinimum(0) 79 | self.progress.setMaximum(len(self.selected_notes)) 80 | 81 | def _setup_buttons(self) -> None: 82 | """Setup add button.""" 83 | button_box = qt.QDialogButtonBox(qt.Qt.Horizontal, self) 84 | add_button = button_box.addButton("Add", qt.QDialogButtonBox.ActionRole) 85 | 86 | self.bottom_hbox = qt.QHBoxLayout() 87 | self.bottom_hbox.addWidget(button_box) 88 | 89 | add_button.clicked.connect(self.on_confirm) 90 | 91 | def _setup_main(self) -> None: 92 | """Setup diag window.""" 93 | main_layout = qt.QVBoxLayout() 94 | main_layout.addWidget(self.form_group_box) 95 | main_layout.addWidget(self.progress) 96 | main_layout.addLayout(self.bottom_hbox) 97 | self.setLayout(main_layout) 98 | self.setWindowTitle("Add IPA transcriptions") 99 | 100 | def _get_fields(self) -> None: 101 | """Get all fields of selected notes.""" 102 | selected_note = self.selected_notes[0] 103 | mw = self.browser.mw 104 | model = mw.col.get_note(selected_note).model() 105 | fields = mw.col.models.field_names(model) 106 | return fields 107 | 108 | @qt.pyqtSlot(int) 109 | def on_progress_changed(self, value) -> None: 110 | """ Update progress bar value. 111 | 112 | :param value: new progressbar value 113 | """ 114 | self.progress.setValue(value) 115 | 116 | def on_confirm(self) -> None: 117 | """Get IPA transcriptions for the selected notes. 118 | 119 | We get the IPA transcriptions by calling Worker in a different thread. 120 | Once it finishes we write the results into the right target fields of all the selected notes. 121 | We can't do this within the thread because SQLite doesn't support multi-threading. 122 | """ 123 | question = f"This will overwrite the current content of the IPA transcription field. Proceed?" 124 | if not askUser(question, parent=self): 125 | return 126 | 127 | notes = self._create_note_dictionary() 128 | 129 | self.worker = Worker(notes, self.lang_combobox.currentText(), self.base_combobox.currentText()) 130 | 131 | # connect methods 132 | self.worker.progress_changed.connect(self.on_progress_changed) 133 | self.worker.result.connect(self.add_ipa_transcription) 134 | self.worker.finished.connect(self.thread.quit) 135 | 136 | # thread management 137 | self.worker.moveToThread(qt.QThread.currentThread()) 138 | self.worker.moveToThread(self.thread) 139 | self.thread.started.connect(self.worker.run) 140 | self.thread.finished.connect(self.close) 141 | self.thread.start() 142 | 143 | def _create_note_dictionary(self) -> Dict[int, anki.notes.Note]: 144 | """Map each note id to the corresponding Anki note object.""" 145 | notes = { 146 | note: self.browser.mw.col.get_note(note) 147 | for note in self.selected_notes 148 | } 149 | return notes 150 | 151 | @qt.pyqtSlot(dict) 152 | def add_ipa_transcription(self, result_dict: Dict[int, str]) -> None: 153 | """ Add IPA transcriptions to the target fields of all selected notes. 154 | 155 | :param result_dict: dictionary of Anki notes and their IPA transcriptions 156 | """ 157 | mw = self.browser.mw 158 | mw.checkpoint("add ipa transcription") 159 | mw.progress.start() 160 | self.browser.model.beginReset() 161 | 162 | for note_id, ipa_transcription in result_dict.items(): 163 | note = mw.col.get_note(note_id) 164 | target_field = self.field_combobox.currentText() 165 | note[target_field] = ipa_transcription 166 | note.flush() 167 | 168 | self.browser.model.endReset() 169 | # mw.requireReset() 170 | mw.CollectionOp() 171 | mw.progress.finish() 172 | mw.reset() 173 | 174 | def closeEvent(self, event: qt.QCloseEvent) -> None: 175 | """ Stop worker and thread when window is closed by user. 176 | 177 | :param event: user wants to close window 178 | """ 179 | if hasattr(self, 'worker'): 180 | self.worker.stop() 181 | self.thread.quit() 182 | event.accept() 183 | self.thread.wait() 184 | 185 | 186 | class Worker(qt.QObject): 187 | """Worker to get the IPA transcriptions of the selected Anki notes.""" 188 | 189 | finished = qt.pyqtSignal() 190 | progress_changed = qt.pyqtSignal(int) 191 | result = qt.pyqtSignal(dict) 192 | 193 | def __init__(self, notes: Dict[int, anki.notes.Note], lang: str, base_field: str) -> None: 194 | """ Initialize Worker. 195 | 196 | :param notes: Anki notes we want to use 197 | :param lang: language of base field content 198 | :param base_field: field for which we want to get IPA transcriptions 199 | """ 200 | super().__init__() 201 | self.notes = notes 202 | self.lang = lang 203 | self.base_field = base_field 204 | self._isRunning = True 205 | 206 | @qt.pyqtSlot() 207 | def run(self) -> None: 208 | """Get IPA transcription for each note and save it into a dictionary.""" 209 | new_dict = dict() 210 | for index, key in enumerate(self.notes.keys()): 211 | try: 212 | words = utils.get_words_from_field(field_text=self.notes[key][self.base_field]) 213 | new_dict[key] = parse_ipa_transcription.transcript(words=words, language=self.lang) 214 | # IPA transcription not found 215 | except (urllib.error.HTTPError, IndexError): 216 | continue 217 | 218 | self.progress_changed.emit(index) 219 | 220 | self.result.emit(new_dict) 221 | self.finished.emit() 222 | 223 | def stop(self) -> None: 224 | """Stop worker.""" 225 | self._isRunning = False 226 | 227 | 228 | def on_batch_edit(browser: Browser) -> None: 229 | """ Open BatchEditDialog when menu entry is clicked. 230 | 231 | :param browser: Anki browser 232 | """ 233 | selected_notes = browser.selectedNotes() 234 | if not selected_notes: 235 | tooltip("No cards selected.") 236 | return 237 | dialog = AddIpaTranscriptDialog(browser, selected_notes) 238 | dialog.exec_() 239 | 240 | 241 | def setup_menu(browser: Browser) -> None: 242 | """ Add menu entry to Anki Browser. 243 | 244 | :param browser: Anki browser 245 | """ 246 | menu = browser.form.menuEdit 247 | menu.addSeparator() 248 | a = menu.addAction('Add IPA ...') 249 | 250 | # call on_batch_edit if entry is clicked 251 | a.triggered.connect(lambda _, b=browser: on_batch_edit(b)) 252 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | 2 | GNU AFFERO GENERAL PUBLIC LICENSE 3 | Version 3, 19 November 2007 4 | 5 | Copyright (C) 2007 Free Software Foundation, Inc. 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The GNU Affero General Public License is a free, copyleft license for 12 | software and other kinds of works, specifically designed to ensure 13 | cooperation with the community in the case of network server software. 14 | 15 | The licenses for most software and other practical works are designed 16 | to take away your freedom to share and change the works. By contrast, 17 | our General Public Licenses are intended to guarantee your freedom to 18 | share and change all versions of a program--to make sure it remains free 19 | software for all its users. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | them if you wish), that you receive source code or can get it if you 25 | want it, that you can change the software or use pieces of it in new 26 | free programs, and that you know you can do these things. 27 | 28 | Developers that use our General Public Licenses protect your rights 29 | with two steps: (1) assert copyright on the software, and (2) offer 30 | you this License which gives you legal permission to copy, distribute 31 | and/or modify the software. 32 | 33 | A secondary benefit of defending all users' freedom is that 34 | improvements made in alternate versions of the program, if they 35 | receive widespread use, become available for other developers to 36 | incorporate. Many developers of free software are heartened and 37 | encouraged by the resulting cooperation. However, in the case of 38 | software used on network servers, this result may fail to come about. 39 | The GNU General Public License permits making a modified version and 40 | letting the public access it on a server without ever releasing its 41 | source code to the public. 42 | 43 | The GNU Affero General Public License is designed specifically to 44 | ensure that, in such cases, the modified source code becomes available 45 | to the community. It requires the operator of a network server to 46 | provide the source code of the modified version running there to the 47 | users of that server. Therefore, public use of a modified version, on 48 | a publicly accessible server, gives the public access to the source 49 | code of the modified version. 50 | 51 | An older license, called the Affero General Public License and 52 | published by Affero, was designed to accomplish similar goals. This is 53 | a different license, not a version of the Affero GPL, but Affero has 54 | released a new version of the Affero GPL which permits relicensing under 55 | this license. 56 | 57 | The precise terms and conditions for copying, distribution and 58 | modification follow. 59 | 60 | TERMS AND CONDITIONS 61 | 62 | 0. Definitions. 63 | 64 | "This License" refers to version 3 of the GNU Affero General Public License. 65 | 66 | "Copyright" also means copyright-like laws that apply to other kinds of 67 | works, such as semiconductor masks. 68 | 69 | "The Program" refers to any copyrightable work licensed under this 70 | License. Each licensee is addressed as "you". "Licensees" and 71 | "recipients" may be individuals or organizations. 72 | 73 | To "modify" a work means to copy from or adapt all or part of the work 74 | in a fashion requiring copyright permission, other than the making of an 75 | exact copy. The resulting work is called a "modified version" of the 76 | earlier work or a work "based on" the earlier work. 77 | 78 | A "covered work" means either the unmodified Program or a work based 79 | on the Program. 80 | 81 | To "propagate" a work means to do anything with it that, without 82 | permission, would make you directly or secondarily liable for 83 | infringement under applicable copyright law, except executing it on a 84 | computer or modifying a private copy. Propagation includes copying, 85 | distribution (with or without modification), making available to the 86 | public, and in some countries other activities as well. 87 | 88 | To "convey" a work means any kind of propagation that enables other 89 | parties to make or receive copies. Mere interaction with a user through 90 | a computer network, with no transfer of a copy, is not conveying. 91 | 92 | An interactive user interface displays "Appropriate Legal Notices" 93 | to the extent that it includes a convenient and prominently visible 94 | feature that (1) displays an appropriate copyright notice, and (2) 95 | tells the user that there is no warranty for the work (except to the 96 | extent that warranties are provided), that licensees may convey the 97 | work under this License, and how to view a copy of this License. If 98 | the interface presents a list of user commands or options, such as a 99 | menu, a prominent item in the list meets this criterion. 100 | 101 | 1. Source Code. 102 | 103 | The "source code" for a work means the preferred form of the work 104 | for making modifications to it. "Object code" means any non-source 105 | form of a work. 106 | 107 | A "Standard Interface" means an interface that either is an official 108 | standard defined by a recognized standards body, or, in the case of 109 | interfaces specified for a particular programming language, one that 110 | is widely used among developers working in that language. 111 | 112 | The "System Libraries" of an executable work include anything, other 113 | than the work as a whole, that (a) is included in the normal form of 114 | packaging a Major Component, but which is not part of that Major 115 | Component, and (b) serves only to enable use of the work with that 116 | Major Component, or to implement a Standard Interface for which an 117 | implementation is available to the public in source code form. A 118 | "Major Component", in this context, means a major essential component 119 | (kernel, window system, and so on) of the specific operating system 120 | (if any) on which the executable work runs, or a compiler used to 121 | produce the work, or an object code interpreter used to run it. 122 | 123 | The "Corresponding Source" for a work in object code form means all 124 | the source code needed to generate, install, and (for an executable 125 | work) run the object code and to modify the work, including scripts to 126 | control those activities. However, it does not include the work's 127 | System Libraries, or general-purpose tools or generally available free 128 | programs which are used unmodified in performing those activities but 129 | which are not part of the work. For example, Corresponding Source 130 | includes interface definition files associated with source files for 131 | the work, and the source code for shared libraries and dynamically 132 | linked subprograms that the work is specifically designed to require, 133 | such as by intimate data communication or control flow between those 134 | subprograms and other parts of the work. 135 | 136 | The Corresponding Source need not include anything that users 137 | can regenerate automatically from other parts of the Corresponding 138 | Source. 139 | 140 | The Corresponding Source for a work in source code form is that 141 | same work. 142 | 143 | 2. Basic Permissions. 144 | 145 | All rights granted under this License are granted for the term of 146 | copyright on the Program, and are irrevocable provided the stated 147 | conditions are met. This License explicitly affirms your unlimited 148 | permission to run the unmodified Program. The output from running a 149 | covered work is covered by this License only if the output, given its 150 | content, constitutes a covered work. This License acknowledges your 151 | rights of fair use or other equivalent, as provided by copyright law. 152 | 153 | You may make, run and propagate covered works that you do not 154 | convey, without conditions so long as your license otherwise remains 155 | in force. You may convey covered works to others for the sole purpose 156 | of having them make modifications exclusively for you, or provide you 157 | with facilities for running those works, provided that you comply with 158 | the terms of this License in conveying all material for which you do 159 | not control copyright. Those thus making or running the covered works 160 | for you must do so exclusively on your behalf, under your direction 161 | and control, on terms that prohibit them from making any copies of 162 | your copyrighted material outside their relationship with you. 163 | 164 | Conveying under any other circumstances is permitted solely under 165 | the conditions stated below. Sublicensing is not allowed; section 10 166 | makes it unnecessary. 167 | 168 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 169 | 170 | No covered work shall be deemed part of an effective technological 171 | measure under any applicable law fulfilling obligations under article 172 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 173 | similar laws prohibiting or restricting circumvention of such 174 | measures. 175 | 176 | When you convey a covered work, you waive any legal power to forbid 177 | circumvention of technological measures to the extent such circumvention 178 | is effected by exercising rights under this License with respect to 179 | the covered work, and you disclaim any intention to limit operation or 180 | modification of the work as a means of enforcing, against the work's 181 | users, your or third parties' legal rights to forbid circumvention of 182 | technological measures. 183 | 184 | 4. Conveying Verbatim Copies. 185 | 186 | You may convey verbatim copies of the Program's source code as you 187 | receive it, in any medium, provided that you conspicuously and 188 | appropriately publish on each copy an appropriate copyright notice; 189 | keep intact all notices stating that this License and any 190 | non-permissive terms added in accord with section 7 apply to the code; 191 | keep intact all notices of the absence of any warranty; and give all 192 | recipients a copy of this License along with the Program. 193 | 194 | You may charge any price or no price for each copy that you convey, 195 | and you may offer support or warranty protection for a fee. 196 | 197 | 5. Conveying Modified Source Versions. 198 | 199 | You may convey a work based on the Program, or the modifications to 200 | produce it from the Program, in the form of source code under the 201 | terms of section 4, provided that you also meet all of these conditions: 202 | 203 | a) The work must carry prominent notices stating that you modified 204 | it, and giving a relevant date. 205 | 206 | b) The work must carry prominent notices stating that it is 207 | released under this License and any conditions added under section 208 | 7. This requirement modifies the requirement in section 4 to 209 | "keep intact all notices". 210 | 211 | c) You must license the entire work, as a whole, under this 212 | License to anyone who comes into possession of a copy. This 213 | License will therefore apply, along with any applicable section 7 214 | additional terms, to the whole of the work, and all its parts, 215 | regardless of how they are packaged. This License gives no 216 | permission to license the work in any other way, but it does not 217 | invalidate such permission if you have separately received it. 218 | 219 | d) If the work has interactive user interfaces, each must display 220 | Appropriate Legal Notices; however, if the Program has interactive 221 | interfaces that do not display Appropriate Legal Notices, your 222 | work need not make them do so. 223 | 224 | A compilation of a covered work with other separate and independent 225 | works, which are not by their nature extensions of the covered work, 226 | and which are not combined with it such as to form a larger program, 227 | in or on a volume of a storage or distribution medium, is called an 228 | "aggregate" if the compilation and its resulting copyright are not 229 | used to limit the access or legal rights of the compilation's users 230 | beyond what the individual works permit. Inclusion of a covered work 231 | in an aggregate does not cause this License to apply to the other 232 | parts of the aggregate. 233 | 234 | 6. Conveying Non-Source Forms. 235 | 236 | You may convey a covered work in object code form under the terms 237 | of sections 4 and 5, provided that you also convey the 238 | machine-readable Corresponding Source under the terms of this License, 239 | in one of these ways: 240 | 241 | a) Convey the object code in, or embodied in, a physical product 242 | (including a physical distribution medium), accompanied by the 243 | Corresponding Source fixed on a durable physical medium 244 | customarily used for software interchange. 245 | 246 | b) Convey the object code in, or embodied in, a physical product 247 | (including a physical distribution medium), accompanied by a 248 | written offer, valid for at least three years and valid for as 249 | long as you offer spare parts or customer support for that product 250 | model, to give anyone who possesses the object code either (1) a 251 | copy of the Corresponding Source for all the software in the 252 | product that is covered by this License, on a durable physical 253 | medium customarily used for software interchange, for a price no 254 | more than your reasonable cost of physically performing this 255 | conveying of source, or (2) access to copy the 256 | Corresponding Source from a network server at no charge. 257 | 258 | c) Convey individual copies of the object code with a copy of the 259 | written offer to provide the Corresponding Source. This 260 | alternative is allowed only occasionally and noncommercially, and 261 | only if you received the object code with such an offer, in accord 262 | with subsection 6b. 263 | 264 | d) Convey the object code by offering access from a designated 265 | place (gratis or for a charge), and offer equivalent access to the 266 | Corresponding Source in the same way through the same place at no 267 | further charge. You need not require recipients to copy the 268 | Corresponding Source along with the object code. If the place to 269 | copy the object code is a network server, the Corresponding Source 270 | may be on a different server (operated by you or a third party) 271 | that supports equivalent copying facilities, provided you maintain 272 | clear directions next to the object code saying where to find the 273 | Corresponding Source. Regardless of what server hosts the 274 | Corresponding Source, you remain obligated to ensure that it is 275 | available for as long as needed to satisfy these requirements. 276 | 277 | e) Convey the object code using peer-to-peer transmission, provided 278 | you inform other peers where the object code and Corresponding 279 | Source of the work are being offered to the general public at no 280 | charge under subsection 6d. 281 | 282 | A separable portion of the object code, whose source code is excluded 283 | from the Corresponding Source as a System Library, need not be 284 | included in conveying the object code work. 285 | 286 | A "User Product" is either (1) a "consumer product", which means any 287 | tangible personal property which is normally used for personal, family, 288 | or household purposes, or (2) anything designed or sold for incorporation 289 | into a dwelling. In determining whether a product is a consumer product, 290 | doubtful cases shall be resolved in favor of coverage. For a particular 291 | product received by a particular user, "normally used" refers to a 292 | typical or common use of that class of product, regardless of the status 293 | of the particular user or of the way in which the particular user 294 | actually uses, or expects or is expected to use, the product. A product 295 | is a consumer product regardless of whether the product has substantial 296 | commercial, industrial or non-consumer uses, unless such uses represent 297 | the only significant mode of use of the product. 298 | 299 | "Installation Information" for a User Product means any methods, 300 | procedures, authorization keys, or other information required to install 301 | and execute modified versions of a covered work in that User Product from 302 | a modified version of its Corresponding Source. The information must 303 | suffice to ensure that the continued functioning of the modified object 304 | code is in no case prevented or interfered with solely because 305 | modification has been made. 306 | 307 | If you convey an object code work under this section in, or with, or 308 | specifically for use in, a User Product, and the conveying occurs as 309 | part of a transaction in which the right of possession and use of the 310 | User Product is transferred to the recipient in perpetuity or for a 311 | fixed term (regardless of how the transaction is characterized), the 312 | Corresponding Source conveyed under this section must be accompanied 313 | by the Installation Information. But this requirement does not apply 314 | if neither you nor any third party retains the ability to install 315 | modified object code on the User Product (for example, the work has 316 | been installed in ROM). 317 | 318 | The requirement to provide Installation Information does not include a 319 | requirement to continue to provide support service, warranty, or updates 320 | for a work that has been modified or installed by the recipient, or for 321 | the User Product in which it has been modified or installed. Access to a 322 | network may be denied when the modification itself materially and 323 | adversely affects the operation of the network or violates the rules and 324 | protocols for communication across the network. 325 | 326 | Corresponding Source conveyed, and Installation Information provided, 327 | in accord with this section must be in a format that is publicly 328 | documented (and with an implementation available to the public in 329 | source code form), and must require no special password or key for 330 | unpacking, reading or copying. 331 | 332 | 7. Additional Terms. 333 | 334 | "Additional permissions" are terms that supplement the terms of this 335 | License by making exceptions from one or more of its conditions. 336 | Additional permissions that are applicable to the entire Program shall 337 | be treated as though they were included in this License, to the extent 338 | that they are valid under applicable law. If additional permissions 339 | apply only to part of the Program, that part may be used separately 340 | under those permissions, but the entire Program remains governed by 341 | this License without regard to the additional permissions. 342 | 343 | When you convey a copy of a covered work, you may at your option 344 | remove any additional permissions from that copy, or from any part of 345 | it. (Additional permissions may be written to require their own 346 | removal in certain cases when you modify the work.) You may place 347 | additional permissions on material, added by you to a covered work, 348 | for which you have or can give appropriate copyright permission. 349 | 350 | Notwithstanding any other provision of this License, for material you 351 | add to a covered work, you may (if authorized by the copyright holders of 352 | that material) supplement the terms of this License with terms: 353 | 354 | a) Disclaiming warranty or limiting liability differently from the 355 | terms of sections 15 and 16 of this License; or 356 | 357 | b) Requiring preservation of specified reasonable legal notices or 358 | author attributions in that material or in the Appropriate Legal 359 | Notices displayed by works containing it; or 360 | 361 | c) Prohibiting misrepresentation of the origin of that material, or 362 | requiring that modified versions of such material be marked in 363 | reasonable ways as different from the original version; or 364 | 365 | d) Limiting the use for publicity purposes of names of licensors or 366 | authors of the material; or 367 | 368 | e) Declining to grant rights under trademark law for use of some 369 | trade names, trademarks, or service marks; or 370 | 371 | f) Requiring indemnification of licensors and authors of that 372 | material by anyone who conveys the material (or modified versions of 373 | it) with contractual assumptions of liability to the recipient, for 374 | any liability that these contractual assumptions directly impose on 375 | those licensors and authors. 376 | 377 | All other non-permissive additional terms are considered "further 378 | restrictions" within the meaning of section 10. If the Program as you 379 | received it, or any part of it, contains a notice stating that it is 380 | governed by this License along with a term that is a further 381 | restriction, you may remove that term. If a license document contains 382 | a further restriction but permits relicensing or conveying under this 383 | License, you may add to a covered work material governed by the terms 384 | of that license document, provided that the further restriction does 385 | not survive such relicensing or conveying. 386 | 387 | If you add terms to a covered work in accord with this section, you 388 | must place, in the relevant source files, a statement of the 389 | additional terms that apply to those files, or a notice indicating 390 | where to find the applicable terms. 391 | 392 | Additional terms, permissive or non-permissive, may be stated in the 393 | form of a separately written license, or stated as exceptions; 394 | the above requirements apply either way. 395 | 396 | 8. Termination. 397 | 398 | You may not propagate or modify a covered work except as expressly 399 | provided under this License. Any attempt otherwise to propagate or 400 | modify it is void, and will automatically terminate your rights under 401 | this License (including any patent licenses granted under the third 402 | paragraph of section 11). 403 | 404 | However, if you cease all violation of this License, then your 405 | license from a particular copyright holder is reinstated (a) 406 | provisionally, unless and until the copyright holder explicitly and 407 | finally terminates your license, and (b) permanently, if the copyright 408 | holder fails to notify you of the violation by some reasonable means 409 | prior to 60 days after the cessation. 410 | 411 | Moreover, your license from a particular copyright holder is 412 | reinstated permanently if the copyright holder notifies you of the 413 | violation by some reasonable means, this is the first time you have 414 | received notice of violation of this License (for any work) from that 415 | copyright holder, and you cure the violation prior to 30 days after 416 | your receipt of the notice. 417 | 418 | Termination of your rights under this section does not terminate the 419 | licenses of parties who have received copies or rights from you under 420 | this License. If your rights have been terminated and not permanently 421 | reinstated, you do not qualify to receive new licenses for the same 422 | material under section 10. 423 | 424 | 9. Acceptance Not Required for Having Copies. 425 | 426 | You are not required to accept this License in order to receive or 427 | run a copy of the Program. Ancillary propagation of a covered work 428 | occurring solely as a consequence of using peer-to-peer transmission 429 | to receive a copy likewise does not require acceptance. However, 430 | nothing other than this License grants you permission to propagate or 431 | modify any covered work. These actions infringe copyright if you do 432 | not accept this License. Therefore, by modifying or propagating a 433 | covered work, you indicate your acceptance of this License to do so. 434 | 435 | 10. Automatic Licensing of Downstream Recipients. 436 | 437 | Each time you convey a covered work, the recipient automatically 438 | receives a license from the original licensors, to run, modify and 439 | propagate that work, subject to this License. You are not responsible 440 | for enforcing compliance by third parties with this License. 441 | 442 | An "entity transaction" is a transaction transferring control of an 443 | organization, or substantially all assets of one, or subdividing an 444 | organization, or merging organizations. If propagation of a covered 445 | work results from an entity transaction, each party to that 446 | transaction who receives a copy of the work also receives whatever 447 | licenses to the work the party's predecessor in interest had or could 448 | give under the previous paragraph, plus a right to possession of the 449 | Corresponding Source of the work from the predecessor in interest, if 450 | the predecessor has it or can get it with reasonable efforts. 451 | 452 | You may not impose any further restrictions on the exercise of the 453 | rights granted or affirmed under this License. For example, you may 454 | not impose a license fee, royalty, or other charge for exercise of 455 | rights granted under this License, and you may not initiate litigation 456 | (including a cross-claim or counterclaim in a lawsuit) alleging that 457 | any patent claim is infringed by making, using, selling, offering for 458 | sale, or importing the Program or any portion of it. 459 | 460 | 11. Patents. 461 | 462 | A "contributor" is a copyright holder who authorizes use under this 463 | License of the Program or a work on which the Program is based. The 464 | work thus licensed is called the contributor's "contributor version". 465 | 466 | A contributor's "essential patent claims" are all patent claims 467 | owned or controlled by the contributor, whether already acquired or 468 | hereafter acquired, that would be infringed by some manner, permitted 469 | by this License, of making, using, or selling its contributor version, 470 | but do not include claims that would be infringed only as a 471 | consequence of further modification of the contributor version. For 472 | purposes of this definition, "control" includes the right to grant 473 | patent sublicenses in a manner consistent with the requirements of 474 | this License. 475 | 476 | Each contributor grants you a non-exclusive, worldwide, royalty-free 477 | patent license under the contributor's essential patent claims, to 478 | make, use, sell, offer for sale, import and otherwise run, modify and 479 | propagate the contents of its contributor version. 480 | 481 | In the following three paragraphs, a "patent license" is any express 482 | agreement or commitment, however denominated, not to enforce a patent 483 | (such as an express permission to practice a patent or covenant not to 484 | sue for patent infringement). To "grant" such a patent license to a 485 | party means to make such an agreement or commitment not to enforce a 486 | patent against the party. 487 | 488 | If you convey a covered work, knowingly relying on a patent license, 489 | and the Corresponding Source of the work is not available for anyone 490 | to copy, free of charge and under the terms of this License, through a 491 | publicly available network server or other readily accessible means, 492 | then you must either (1) cause the Corresponding Source to be so 493 | available, or (2) arrange to deprive yourself of the benefit of the 494 | patent license for this particular work, or (3) arrange, in a manner 495 | consistent with the requirements of this License, to extend the patent 496 | license to downstream recipients. "Knowingly relying" means you have 497 | actual knowledge that, but for the patent license, your conveying the 498 | covered work in a country, or your recipient's use of the covered work 499 | in a country, would infringe one or more identifiable patents in that 500 | country that you have reason to believe are valid. 501 | 502 | If, pursuant to or in connection with a single transaction or 503 | arrangement, you convey, or propagate by procuring conveyance of, a 504 | covered work, and grant a patent license to some of the parties 505 | receiving the covered work authorizing them to use, propagate, modify 506 | or convey a specific copy of the covered work, then the patent license 507 | you grant is automatically extended to all recipients of the covered 508 | work and works based on it. 509 | 510 | A patent license is "discriminatory" if it does not include within 511 | the scope of its coverage, prohibits the exercise of, or is 512 | conditioned on the non-exercise of one or more of the rights that are 513 | specifically granted under this License. You may not convey a covered 514 | work if you are a party to an arrangement with a third party that is 515 | in the business of distributing software, under which you make payment 516 | to the third party based on the extent of your activity of conveying 517 | the work, and under which the third party grants, to any of the 518 | parties who would receive the covered work from you, a discriminatory 519 | patent license (a) in connection with copies of the covered work 520 | conveyed by you (or copies made from those copies), or (b) primarily 521 | for and in connection with specific products or compilations that 522 | contain the covered work, unless you entered into that arrangement, 523 | or that patent license was granted, prior to 28 March 2007. 524 | 525 | Nothing in this License shall be construed as excluding or limiting 526 | any implied license or other defenses to infringement that may 527 | otherwise be available to you under applicable patent law. 528 | 529 | 12. No Surrender of Others' Freedom. 530 | 531 | If conditions are imposed on you (whether by court order, agreement or 532 | otherwise) that contradict the conditions of this License, they do not 533 | excuse you from the conditions of this License. If you cannot convey a 534 | covered work so as to satisfy simultaneously your obligations under this 535 | License and any other pertinent obligations, then as a consequence you may 536 | not convey it at all. For example, if you agree to terms that obligate you 537 | to collect a royalty for further conveying from those to whom you convey 538 | the Program, the only way you could satisfy both those terms and this 539 | License would be to refrain entirely from conveying the Program. 540 | 541 | 13. Remote Network Interaction; Use with the GNU General Public License. 542 | 543 | Notwithstanding any other provision of this License, if you modify the 544 | Program, your modified version must prominently offer all users 545 | interacting with it remotely through a computer network (if your version 546 | supports such interaction) an opportunity to receive the Corresponding 547 | Source of your version by providing access to the Corresponding Source 548 | from a network server at no charge, through some standard or customary 549 | means of facilitating copying of software. This Corresponding Source 550 | shall include the Corresponding Source for any work covered by version 3 551 | of the GNU General Public License that is incorporated pursuant to the 552 | following paragraph. 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 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 work with which it is combined will remain governed by version 560 | 3 of the GNU General Public License. 561 | 562 | 14. Revised Versions of this License. 563 | 564 | The Free Software Foundation may publish revised and/or new versions of 565 | the GNU Affero General Public License from time to time. Such new versions 566 | will be similar in spirit to the present version, but may differ in detail to 567 | address new problems or concerns. 568 | 569 | Each version is given a distinguishing version number. If the 570 | Program specifies that a certain numbered version of the GNU Affero General 571 | Public License "or any later version" applies to it, you have the 572 | option of following the terms and conditions either of that numbered 573 | version or of any later version published by the Free Software 574 | Foundation. If the Program does not specify a version number of the 575 | GNU Affero General Public License, you may choose any version ever published 576 | by the Free Software Foundation. 577 | 578 | If the Program specifies that a proxy can decide which future 579 | versions of the GNU Affero General Public License can be used, that proxy's 580 | public statement of acceptance of a version permanently authorizes you 581 | to choose that version for the Program. 582 | 583 | Later license versions may give you additional or different 584 | permissions. However, no additional obligations are imposed on any 585 | author or copyright holder as a result of your choosing to follow a 586 | later version. 587 | 588 | 15. Disclaimer of Warranty. 589 | 590 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 591 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 592 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 593 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 594 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 595 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 596 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 597 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 598 | 599 | 16. Limitation of Liability. 600 | 601 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 602 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 603 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 604 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 605 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 606 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 607 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 608 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 609 | SUCH DAMAGES. 610 | 611 | 17. Interpretation of Sections 15 and 16. 612 | 613 | If the disclaimer of warranty and limitation of liability provided 614 | above cannot be given local legal effect according to their terms, 615 | reviewing courts shall apply local law that most closely approximates 616 | an absolute waiver of all civil liability in connection with the 617 | Program, unless a warranty or assumption of liability accompanies a 618 | copy of the Program in return for a fee. 619 | 620 | END OF TERMS AND CONDITIONS 621 | 622 | How to Apply These Terms to Your New Programs 623 | 624 | If you develop a new program, and you want it to be of the greatest 625 | possible use to the public, the best way to achieve this is to make it 626 | free software which everyone can redistribute and change under these terms. 627 | 628 | To do so, attach the following notices to the program. It is safest 629 | to attach them to the start of each source file to most effectively 630 | state the exclusion of warranty; and each file should have at least 631 | the "copyright" line and a pointer to where the full notice is found. 632 | 633 | 634 | Copyright (C) 635 | 636 | This program is free software: you can redistribute it and/or modify 637 | it under the terms of the GNU Affero General Public License as published 638 | by the Free Software Foundation, either version 3 of the License, or 639 | (at your option) any later version. 640 | 641 | This program is distributed in the hope that it will be useful, 642 | but WITHOUT ANY WARRANTY; without even the implied warranty of 643 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 644 | GNU Affero General Public License for more details. 645 | 646 | You should have received a copy of the GNU Affero General Public License 647 | along with this program. If not, see . 648 | 649 | Also add information on how to contact you by electronic and paper mail. 650 | 651 | If your software can interact with users remotely through a computer 652 | network, you should also make sure that it provides a way for users to 653 | get its source. For example, if your program is a web application, its 654 | interface could display a "Source" link that leads users to an archive 655 | of the code. There are many ways you could offer source, and different 656 | solutions will be better for different programs; see section 13 for the 657 | specific requirements. 658 | 659 | You should also get your employer (if you work as a programmer) or school, 660 | if any, to sign a "copyright disclaimer" for the program, if necessary. 661 | For more information on this, and how to apply and follow the GNU AGPL, see 662 | . 663 | --------------------------------------------------------------------------------