├── __init__.py ├── .github └── workflows │ └── build.yml ├── config.json ├── README.md ├── More_Overview_Stats_2_1.py ├── .gitignore ├── config.py ├── data.py ├── table.py └── LICENSE /__init__.py: -------------------------------------------------------------------------------- 1 | from . import More_Overview_Stats_2_1 2 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: Package add-on 2 | 3 | on: 4 | push: 5 | workflow_dispatch: 6 | 7 | jobs: 8 | zip_job: 9 | runs-on: ubuntu-latest 10 | steps: 11 | - name: Checkout code 12 | uses: actions/checkout@v2 13 | 14 | - name: Make build script executable 15 | run: chmod +x ./build.sh 16 | 17 | - name: Run build script 18 | run: ./build.sh 19 | 20 | - name: Upload artifact 21 | uses: actions/upload-artifact@v4 22 | with: 23 | name: MoreOverviewStats 24 | path: MoreOverviewStats.ankiaddon -------------------------------------------------------------------------------- /config.json: -------------------------------------------------------------------------------- 1 | { 2 | "Date Format": "eu", 3 | "Stat Colors": { 4 | "New": "#0051ff", 5 | "Learning": "#a00", 6 | "Review": "#080", 7 | "Percent": "#888", 8 | "Mature": "#0051ff", 9 | "Young": "#0051ff", 10 | "Learned": "#080", 11 | "Unseen": "#a00", 12 | "Buried": "#e7a100", 13 | "Suspended": "#e7a100", 14 | "Done on Date": "#ddd", 15 | "Days until done": "#ddd", 16 | "Total": "#ddd" 17 | }, 18 | "Show table for finished decks": true, 19 | "Note Correction Factors": { 20 | "Spanish": 1, 21 | "Turkish::Word Pool": 1 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Anki More Overview Stats 2.1 2 | 3 | [![Ko-fi](https://img.shields.io/badge/Ko--fi-F16061?logo=ko-fi&logoColor=white)](https://ko-fi.com/P5P0DF3FQ) 4 | [![contributors](https://img.shields.io/github/contributors/patrick-mahnkopf/Anki_More_Overview_Stats)](https://github.com/patrick-mahnkopf/Anki_More_Overview_Stats/graphs/contributors) 5 | [![forks](https://img.shields.io/github/forks/patrick-mahnkopf/Anki_More_Overview_Stats)](https://github.com/patrick-mahnkopf/Anki_More_Overview_Stats/network/members) 6 | [![stars](https://img.shields.io/github/stars/patrick-mahnkopf/Anki_More_Overview_Stats)](https://github.com/patrick-mahnkopf/Anki_More_Overview_Stats/stargazers) 7 | [![license](https://img.shields.io/github/license/patrick-mahnkopf/Anki_More_Overview_Stats)](./LICENSE) 8 | [![issues](https://img.shields.io/github/issues/patrick-mahnkopf/Anki_More_Overview_Stats)](https://github.com/patrick-mahnkopf/Anki_More_Overview_Stats/issues) 9 | [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=patrick-mahnkopf_Anki_More_Overview_Stats&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=patrick-mahnkopf_Anki_More_Overview_Stats) 10 | 11 | This is the More Overview Stats 2.1 Add-on for Anki. 12 | 13 | It improves Anki's default Overview screen by adding valuable information otherwise hidden behind multiple menus or not available at all. 14 | It also calculates a forecast for when the current deck will be finished, based on the remaining unknown cards and the deck's "New cards/day" setting. 15 | The date format and all colors are fully customizable through the built-in config manager. 16 | 17 | ![More Overview Stats 2.1](https://user-images.githubusercontent.com/69430023/147789088-67975f64-ab4c-49ec-89e8-9301b7f13ef3.png) 18 | 19 | ## Installation 20 | 21 | - Open Anki 22 | - Go to "Tools" and then "Add-ons" 23 | 24 | ![Anki Menu](https://user-images.githubusercontent.com/69430023/147789375-bac9427b-c3cb-4e97-92ea-572b7b600b17.png) 25 | 26 | - Click on "Get Add-ons..." 27 | 28 | ![Get Add-ons](https://user-images.githubusercontent.com/69430023/147789940-eb7e006d-7c44-4b0f-a671-b66b7489ab56.png) 29 | 30 | 31 | - Paste the Add-on's code into the menu: 32 | 33 | ``` 34 | 738807903 35 | ``` 36 | 37 | ![Get Add-ons Dialog](https://user-images.githubusercontent.com/69430023/147789503-7b93f3bd-bf1f-47fd-a1f6-f6c5d001ec53.png) 38 | 39 | 40 | 41 | For more information and details on customization options, please see the Add-on page at: https://ankiweb.net/shared/info/738807903 42 | 43 | ## Support my work 44 | 45 | Creating and maintaining add-ons takes a lot of time, so if you like my work, please consider supporting me by buying me a coffee on Ko-fi. 46 | 47 | [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/P5P0DF3FQ) 48 | -------------------------------------------------------------------------------- /More_Overview_Stats_2_1.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | """ 4 | More Overview Stats 2.1 5 | ===================== 6 | Statistics add-on for Anki 2.1 -- based on "More Overview Stats 2" by 7 | Martin Zuther (http://www.mzuther.de/) which is based on 8 | "More Overview Stats" by Calumks 9 | 10 | Copyright (c) 2021 Kazuwuqt 11 | 12 | This program is free software: you can redistribute it and/or modify 13 | it under the terms of the GNU General Public License as published by 14 | the Free Software Foundation, either version 3 of the License, or 15 | (at your option) any later version. 16 | 17 | This program is distributed in the hope that it will be useful, 18 | but WITHOUT ANY WARRANTY; without even the implied warranty of 19 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 20 | GNU General Public License for more details. 21 | 22 | You should have received a copy of the GNU General Public License 23 | along with this program. If not, see . 24 | 25 | Thank you for using free software! 26 | """ 27 | 28 | import os 29 | 30 | from aqt import gui_hooks 31 | from aqt.overview import Overview 32 | from aqt.webview import AnkiWebView 33 | 34 | from .config import AddonConfig 35 | from .data import DeckData 36 | from .table import Table 37 | 38 | 39 | def overview_table(self) -> str: 40 | """Generate the table for Anki's overview page. 41 | 42 | Fetches data of the currently active deck and presents it in a formatted 43 | table. 44 | 45 | Returns 46 | ------- 47 | str 48 | The formatted overview table or an error string if the deck doesn't 49 | contain cards. 50 | """ 51 | 52 | deck_data.refresh() 53 | 54 | if deck_data.is_empty_deck(): 55 | return "

No cards found.

" 56 | 57 | return table.get_html() 58 | 59 | 60 | def prepend_table(web: AnkiWebView) -> None: 61 | """Prepend the overview table to Anki's congrats dialog.""" 62 | 63 | page_uri: str = os.path.basename(web.page().url().path()) 64 | if page_uri != "congrats.html" and page_uri != "congrats": 65 | return None 66 | 67 | html_style: str = """ 68 | 71 | """ 72 | 73 | # Need to check if id "table" already exists to avoid adding the table 74 | # multiple times because Anki can call the hook more than once 75 | web.eval( 76 | """ 77 | if (document.getElementById("table") == null) { 78 | div = document.createElement("div"); 79 | div.id = "table"; 80 | div.innerHTML = `""" 81 | + html_style 82 | + overview_table(Overview) 83 | + """`; 84 | document.body.prepend(div); 85 | } 86 | """ 87 | ) 88 | 89 | 90 | # Load addon config 91 | config = AddonConfig() 92 | # Initialize data manager 93 | deck_data = DeckData(config=config) 94 | # Initialize table manager 95 | table = Table(config=config, deck_data=deck_data) 96 | 97 | # Overwrite Anki's stats table 98 | Overview._table = overview_table 99 | # Inject overview table into Anki's congrats webview 100 | try: 101 | gui_hooks.webview_did_inject_style_into_page.append(prepend_table) 102 | except Exception as excp: 103 | print(excp) 104 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Created by https://www.toptal.com/developers/gitignore/api/visualstudiocode,python,windows,macos 2 | # Edit at https://www.toptal.com/developers/gitignore?templates=visualstudiocode,python,windows,macos 3 | 4 | ### macOS ### 5 | # General 6 | .DS_Store 7 | .AppleDouble 8 | .LSOverride 9 | 10 | # Icon must end with two \r 11 | Icon 12 | 13 | 14 | # Thumbnails 15 | ._* 16 | 17 | # Files that might appear in the root of a volume 18 | .DocumentRevisions-V100 19 | .fseventsd 20 | .Spotlight-V100 21 | .TemporaryItems 22 | .Trashes 23 | .VolumeIcon.icns 24 | .com.apple.timemachine.donotpresent 25 | 26 | # Directories potentially created on remote AFP share 27 | .AppleDB 28 | .AppleDesktop 29 | Network Trash Folder 30 | Temporary Items 31 | .apdisk 32 | 33 | ### macOS Patch ### 34 | # iCloud generated files 35 | *.icloud 36 | 37 | ### Python ### 38 | # Byte-compiled / optimized / DLL files 39 | __pycache__/ 40 | *.py[cod] 41 | *$py.class 42 | 43 | # C extensions 44 | *.so 45 | 46 | # Distribution / packaging 47 | .Python 48 | build/ 49 | develop-eggs/ 50 | dist/ 51 | downloads/ 52 | eggs/ 53 | .eggs/ 54 | lib/ 55 | lib64/ 56 | parts/ 57 | sdist/ 58 | var/ 59 | wheels/ 60 | share/python-wheels/ 61 | *.egg-info/ 62 | .installed.cfg 63 | *.egg 64 | MANIFEST 65 | 66 | # PyInstaller 67 | # Usually these files are written by a python script from a template 68 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 69 | *.manifest 70 | *.spec 71 | 72 | # Installer logs 73 | pip-log.txt 74 | pip-delete-this-directory.txt 75 | 76 | # Unit test / coverage reports 77 | htmlcov/ 78 | .tox/ 79 | .nox/ 80 | .coverage 81 | .coverage.* 82 | .cache 83 | nosetests.xml 84 | coverage.xml 85 | *.cover 86 | *.py,cover 87 | .hypothesis/ 88 | .pytest_cache/ 89 | cover/ 90 | 91 | # Translations 92 | *.mo 93 | *.pot 94 | 95 | # Django stuff: 96 | *.log 97 | local_settings.py 98 | db.sqlite3 99 | db.sqlite3-journal 100 | 101 | # Flask stuff: 102 | instance/ 103 | .webassets-cache 104 | 105 | # Scrapy stuff: 106 | .scrapy 107 | 108 | # Sphinx documentation 109 | docs/_build/ 110 | 111 | # PyBuilder 112 | .pybuilder/ 113 | target/ 114 | 115 | # Jupyter Notebook 116 | .ipynb_checkpoints 117 | 118 | # IPython 119 | profile_default/ 120 | ipython_config.py 121 | 122 | # pyenv 123 | # For a library or package, you might want to ignore these files since the code is 124 | # intended to run in multiple environments; otherwise, check them in: 125 | # .python-version 126 | 127 | # pipenv 128 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 129 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 130 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 131 | # install all needed dependencies. 132 | #Pipfile.lock 133 | 134 | # poetry 135 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 136 | # This is especially recommended for binary packages to ensure reproducibility, and is more 137 | # commonly ignored for libraries. 138 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 139 | #poetry.lock 140 | 141 | # pdm 142 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 143 | #pdm.lock 144 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 145 | # in version control. 146 | # https://pdm.fming.dev/#use-with-ide 147 | .pdm.toml 148 | 149 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 150 | __pypackages__/ 151 | 152 | # Celery stuff 153 | celerybeat-schedule 154 | celerybeat.pid 155 | 156 | # SageMath parsed files 157 | *.sage.py 158 | 159 | # Environments 160 | .env 161 | .venv 162 | env/ 163 | venv/ 164 | ENV/ 165 | env.bak/ 166 | venv.bak/ 167 | 168 | # Spyder project settings 169 | .spyderproject 170 | .spyproject 171 | 172 | # Rope project settings 173 | .ropeproject 174 | 175 | # mkdocs documentation 176 | /site 177 | 178 | # mypy 179 | .mypy_cache/ 180 | .dmypy.json 181 | dmypy.json 182 | 183 | # Pyre type checker 184 | .pyre/ 185 | 186 | # pytype static type analyzer 187 | .pytype/ 188 | 189 | # Cython debug symbols 190 | cython_debug/ 191 | 192 | # PyCharm 193 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 194 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 195 | # and can be added to the global gitignore or merged into this file. For a more nuclear 196 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 197 | #.idea/ 198 | 199 | ### Python Patch ### 200 | # Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration 201 | poetry.toml 202 | 203 | # ruff 204 | .ruff_cache/ 205 | 206 | # LSP config files 207 | pyrightconfig.json 208 | 209 | ### VisualStudioCode ### 210 | .vscode/* 211 | !.vscode/settings.json 212 | !.vscode/tasks.json 213 | !.vscode/launch.json 214 | !.vscode/extensions.json 215 | !.vscode/*.code-snippets 216 | 217 | # Local History for Visual Studio Code 218 | .history/ 219 | 220 | # Built Visual Studio Code Extensions 221 | *.vsix 222 | 223 | ### VisualStudioCode Patch ### 224 | # Ignore all local history of files 225 | .history 226 | .ionide 227 | 228 | ### Windows ### 229 | # Windows thumbnail cache files 230 | Thumbs.db 231 | Thumbs.db:encryptable 232 | ehthumbs.db 233 | ehthumbs_vista.db 234 | 235 | # Dump file 236 | *.stackdump 237 | 238 | # Folder config file 239 | [Dd]esktop.ini 240 | 241 | # Recycle Bin used on file shares 242 | $RECYCLE.BIN/ 243 | 244 | # Windows Installer files 245 | *.cab 246 | *.msi 247 | *.msix 248 | *.msm 249 | *.msp 250 | 251 | # Windows shortcuts 252 | *.lnk 253 | 254 | # End of https://www.toptal.com/developers/gitignore/api/visualstudiocode,python,windows,macos 255 | 256 | # Anki add-on metadata file 257 | meta.json 258 | 259 | # Anki add-on file to be uploaded to AnkiWeb 260 | *.ankiaddon -------------------------------------------------------------------------------- /config.py: -------------------------------------------------------------------------------- 1 | from typing import Any, Dict 2 | 3 | from aqt import mw 4 | 5 | 6 | class AddonConfig: 7 | """The AddonConfig object loads the user configurations. 8 | 9 | Attributes 10 | ---------- 11 | stat_colors : Dict[str, str] 12 | The colors for all entries in the overview table. 13 | date_format : str 14 | The format used for dates. Default: "%d.%m.%Y" 15 | correction_for_notes : int 16 | The number of note types in the deck. Counts will be divided by 17 | this number. Default: 1 18 | learn_per_day : int 19 | The amount of cards to be learned per day. Read from the deck's 20 | settings. 21 | show_table_for_finished_decks : bool 22 | Whether to show the table for finished decks. Default: True 23 | config: Dict[str, Any] 24 | Anki's config object. Used to load user configurations. 25 | """ 26 | 27 | def __init__(self) -> None: 28 | self._initialize_default_values() 29 | self._refresh_date_format() 30 | self._refresh_stat_colors() 31 | 32 | def refresh(self) -> None: 33 | """Refreshes this object with the data in the config. 34 | 35 | Has to be called before assembling the table to guarantee using the 36 | correct settings. Fetches the user's config and updates this object's 37 | public attributes. 38 | """ 39 | 40 | self.config = mw.addonManager.getConfig(__name__) 41 | if self.config is None: 42 | return None 43 | 44 | self._refresh_note_correction_factors() 45 | self._refresh_date_format() 46 | self._refresh_stat_colors() 47 | self._refresh_learn_per_day() 48 | self._refresh_show_table_for_finished_decks() 49 | 50 | # Initialize this object's attributes to their default values 51 | def _initialize_default_values(self) -> None: 52 | self.stat_colors: Dict[str, str] = { 53 | "New": "#00a", 54 | "Learning": "#a00", 55 | "Review": "#080", 56 | "Percent": "#888", 57 | "Mature": "#0051ff", 58 | "Young": "#0051ff", 59 | "Learned": "#080", 60 | "Unseen": "#a00", 61 | "Buried": "#e7a100", 62 | "Suspended": "#e7a100", 63 | "Done on Date": "#ddd", 64 | "Days until done": "#ddd", 65 | "Total": "#ddd", 66 | } 67 | self.date_format: str = "%d.%m.%Y" 68 | self.correction_for_notes: int = 1 69 | self.learn_per_day: int = 0 70 | self.show_table_for_finished_decks: bool = True 71 | 72 | self.config: Dict[str, Any] = mw.addonManager.getConfig(__name__) 73 | 74 | # Load the date format from the config 75 | def _refresh_date_format(self) -> None: 76 | date_format_map: Dict[str, str] = { 77 | "us": "%m/%d/%Y", 78 | "asia": "%Y/%m/%d", 79 | "eu": "%d.%m.%Y", 80 | "iso": "%Y-%m-%d" 81 | } 82 | 83 | if "Date Format" in self.config: 84 | date_format: str = self.config["Date Format"].strip() 85 | self.date_format = date_format_map.get( 86 | date_format.lower(), 87 | date_format 88 | ) 89 | else: 90 | self.date_format = date_format_map["eu"] 91 | 92 | # Load the stat colors from the config 93 | def _refresh_stat_colors(self) -> None: 94 | if "Stat Colors" not in self.config: 95 | return None 96 | 97 | for stat, color in self.config["Stat Colors"].items(): 98 | if stat in self.stat_colors: 99 | self.stat_colors[stat] = color 100 | 101 | # Load the note correction factors from the config 102 | def _refresh_note_correction_factors(self) -> None: 103 | if "Note Correction Factors" not in self.config: 104 | return None 105 | 106 | current_deck_name: str = mw.col.decks.current()["name"] 107 | last_match_length: int = 0 108 | 109 | for fragment, factor in self.config["Note Correction Factors"].items(): 110 | if ( 111 | current_deck_name.startswith(fragment) 112 | and len(fragment) > last_match_length 113 | ): 114 | self.correction_for_notes = int(factor) 115 | last_match_length = len(fragment) 116 | 117 | # Prevent division by zero and negative results 118 | if self.correction_for_notes <= 0: 119 | self.correction_for_notes = 1 120 | 121 | # Load the learn per day count from the deck's settings 122 | def _refresh_learn_per_day(self) -> None: 123 | current_deck = mw.col.decks.current() 124 | 125 | # Check if the deck has a deck-specific new card limit for today 126 | if "newLimitToday" in current_deck and current_deck["newLimitToday"]: 127 | new_limit_today = current_deck["newLimitToday"] 128 | # Use the limit if 'today' is set to 2, meaning the limit is active 129 | if ( 130 | "limit" in new_limit_today 131 | and new_limit_today["limit"] 132 | and "today" in new_limit_today 133 | and new_limit_today["today"] == 2 134 | ): 135 | self.learn_per_day = new_limit_today["limit"] 136 | return 137 | 138 | # Check if the deck has a deck-specific new card limit 139 | if "newLimit" in current_deck and current_deck["newLimit"]: 140 | self.learn_per_day = current_deck["newLimit"] 141 | return 142 | 143 | # Use the deck preset's new card limit 144 | deck_config = mw.col.decks.config_dict_for_deck_id(current_deck["id"]) 145 | 146 | if ( 147 | "new" in deck_config 148 | and deck_config["new"] 149 | and "perDay" in deck_config["new"] 150 | and deck_config["new"]["perDay"] 151 | ): 152 | self.learn_per_day = deck_config["new"]["perDay"] 153 | return 154 | 155 | # Reset to 0 if no settings are found 156 | self.learn_per_day = 0 157 | 158 | # Load the "Show table for finished decks" flag from the config 159 | def _refresh_show_table_for_finished_decks(self) -> None: 160 | flag_entry: str = "Show table for finished decks" 161 | 162 | config_has_flag: bool = flag_entry in self.config 163 | flag_is_true: bool = self.config.get(flag_entry, True) 164 | 165 | self.show_table_for_finished_decks = config_has_flag and flag_is_true 166 | -------------------------------------------------------------------------------- /data.py: -------------------------------------------------------------------------------- 1 | import math 2 | import time 3 | from datetime import date, timedelta 4 | from typing import Dict, List 5 | 6 | from aqt import mw 7 | from aqt.utils import showInfo 8 | 9 | from .config import AddonConfig 10 | 11 | 12 | class DeckData: 13 | """The DeckData object assembles the active deck's data. 14 | 15 | Parameters 16 | ---------- 17 | config : AddonConfig 18 | Object used to load the addon's user configuration. 19 | 20 | Attributes 21 | ---------- 22 | labels : Dict[str, str] 23 | The labels for all entries in the overview table. 24 | stats : Dict[str, int] 25 | The counts of the respective card states returned by Anki's db. 26 | dates : Dict[str, str] 27 | The approximate number of days left and the date the deck will be finished on. 28 | percentages : Dict[str, float] 29 | The relative counts of the respective card states returned by Anki's db. 30 | percentages_without_suspended : Dict[str, float] 31 | The percentages when excluding suspended cards from all counts. 32 | """ 33 | 34 | def __init__(self, config: AddonConfig) -> None: 35 | self._config = config 36 | 37 | self.labels: Dict[str, str] = self._get_labels() 38 | self.stats: Dict[str, int] = {} 39 | self.dates: Dict[str, str] = {} 40 | self.percentages: Dict[str, float] = {} 41 | self.percentages_without_suspended: Dict[str, float] = {} 42 | 43 | def refresh(self) -> None: 44 | """Refreshes this object with the current deck's data. 45 | 46 | Has to be called before assembling the table to guarantee using the 47 | correct data. Fetches the active deck's data and updates this 48 | object's public attributes. 49 | """ 50 | 51 | self._config.refresh() 52 | self._refresh_stats() 53 | self._refresh_percentages() 54 | self._refresh_percentages_without_suspended() 55 | 56 | def is_finished(self) -> bool: 57 | """Whether the currently active deck is done for today. 58 | 59 | Has to be called before assembling the table to guarantee using the 60 | correct data. Fetches the active deck's data and updates this 61 | object's public attributes. 62 | 63 | Returns 64 | ------- 65 | bool 66 | True if deck is done, False otherwise. 67 | """ 68 | 69 | return not sum(self._get_scheduled_counts()) 70 | 71 | def is_empty_deck(self) -> bool: 72 | """Whether the currently active deck is empty. 73 | 74 | Returns 75 | ------- 76 | bool 77 | True if deck is empty, False otherwise. 78 | """ 79 | 80 | return not self.stats["total"] 81 | 82 | # Return the table entry labels 83 | def _get_labels(self) -> Dict[str, str]: 84 | labels: Dict[str, str] = {} 85 | 86 | labels["mature"] = "Mature" 87 | labels["young"] = "Young" 88 | labels["unseen"] = "Unseen" 89 | labels["buried"] = "Buried" 90 | labels["suspended"] = "Suspended" 91 | 92 | labels["total"] = "Total" 93 | labels["learned"] = "Learned" 94 | labels["unlearned"] = "Unlearned" 95 | 96 | labels["new"] = "New" 97 | labels["learning"] = "Learning" 98 | labels["review"] = "Review" 99 | labels["due"] = "Due" 100 | 101 | labels["doneDate"] = "Done in" 102 | 103 | for key in labels: 104 | labels[key] = "{:s}:".format(labels[key]) 105 | 106 | return labels 107 | 108 | # Refresh counts of all card states 109 | def _refresh_stats(self) -> None: 110 | total, mature, young, unseen, buried, suspended, due = self._query_db() 111 | new, learning, review = self._get_scheduled_counts() 112 | 113 | self.stats["mature"] = mature // self._config.correction_for_notes 114 | self.stats["young"] = young // self._config.correction_for_notes 115 | self.stats["unseen"] = unseen // self._config.correction_for_notes 116 | self.stats["buried"] = buried // self._config.correction_for_notes 117 | self.stats["suspended"] = suspended // self._config.correction_for_notes 118 | 119 | self.stats["total"] = total // self._config.correction_for_notes 120 | self.stats["learned"] = self.stats["mature"] + self.stats["young"] 121 | self.stats["unlearned"] = self.stats["total"] - self.stats["learned"] 122 | 123 | self.stats["new"] = new 124 | self.stats["learning"] = learning 125 | self.stats["review"] = review 126 | self.stats["due"] = due + self.stats["review"] 127 | 128 | try: 129 | days_until_done: int 130 | if self._config.learn_per_day == 0: 131 | days_until_done = 0 132 | else: 133 | days_until_done = math.ceil( 134 | self.stats["unseen"] / self._config.learn_per_day 135 | ) 136 | except Exception as e: 137 | print(e) 138 | days_until_done: int = 0 139 | 140 | try: 141 | self.dates["doneDate"] = ( 142 | date.today() + timedelta(days=days_until_done) 143 | ).strftime(self._config.date_format) 144 | except Exception as e: 145 | print(e) 146 | showInfo( 147 | 'Unsupported date format. Defaulting to Day.Month.Year instead. Use one of the shorthands: "us", "asia" or "eu", or specify the date like "\%d.\%m.\%Y", "\%m/\%d/\%Y" etc.\n For more information check the table at: https://docs.python.org/2/library/datetime.html#strftime-and-strptime-behavior', 148 | type="warning", 149 | title="More Overview Stats 2.1 Warning", 150 | ) 151 | self.dates["doneDate"] = ( 152 | date.today() + timedelta(days=days_until_done) 153 | ).strftime("%d.%m.%Y") 154 | 155 | if days_until_done == 1: 156 | self.dates["daysLeft"] = "{} day".format(days_until_done) 157 | else: 158 | self.dates["daysLeft"] = "{} days".format(days_until_done) 159 | 160 | # Query Anki's db for the current deck's card states 161 | def _query_db(self) -> List[int]: 162 | values: List[int] = mw.col.db.first( 163 | f""" 164 | select 165 | -- total 166 | count(id), 167 | -- mature 168 | sum(case when queue = 2 and ivl >= 21 169 | then 1 else 0 end), 170 | -- young / learning 171 | sum(case when queue in (1, 3) or (queue = 2 and ivl < 21) 172 | then 1 else 0 end), 173 | -- unseen 174 | sum(case when queue = 0 175 | then 1 else 0 end), 176 | -- buried 177 | sum(case when queue in (-2, -3) 178 | then 1 else 0 end), 179 | -- suspended 180 | sum(case when queue = -1 181 | then 1 else 0 end), 182 | -- due 183 | sum(case when queue = 1 and due <= ? 184 | then 1 else 0 end) 185 | from cards where did in {mw.col.sched._deck_limit():s} 186 | """, 187 | round(time.time()), 188 | ) 189 | 190 | # Empty filtered decks can return None => set all values 0 191 | if None in values: 192 | values = [0] * len(values) 193 | 194 | return values 195 | 196 | # Get card state counts from Anki's scheduler (new, learning, review) 197 | def _get_scheduled_counts(self) -> List[int]: 198 | return list(mw.col.sched.counts()) 199 | 200 | # Refresh percentages of all card states 201 | def _refresh_percentages(self) -> None: 202 | total: int = self.stats["total"] 203 | 204 | # Avoid division by zero for empty decks 205 | if total == 0: 206 | self.percentages = {key: 0.0 for key in self.stats} 207 | else: 208 | self.percentages = { 209 | key: (value / total) for key, value in self.stats.items() 210 | } 211 | 212 | self.percentages["total"] = 1.0 213 | 214 | # Refresh percentages of all card states ignoring suspended cards 215 | def _refresh_percentages_without_suspended(self) -> None: 216 | total_without_suspended: int = self.stats["total"] - self.stats["suspended"] 217 | 218 | # Avoid division by zero for empty decks 219 | if total_without_suspended == 0: 220 | self.percentages_without_suspended = {key: 0.0 for key in self.stats} 221 | else: 222 | self.percentages_without_suspended = { 223 | key: (value / total_without_suspended) 224 | for key, value in self.stats.items() 225 | } 226 | 227 | self.percentages_without_suspended["total"] = 1.0 228 | -------------------------------------------------------------------------------- /table.py: -------------------------------------------------------------------------------- 1 | from aqt import mw 2 | 3 | from .config import AddonConfig 4 | from .data import DeckData 5 | 6 | 7 | class Table: 8 | """The Table object assembles the overview table html. 9 | 10 | Parameters 11 | ---------- 12 | config : AddonConfig 13 | Object used to load the addon's user configuration. 14 | deck_data : DeckData 15 | Object used to load the currently active deck's data. 16 | """ 17 | 18 | def __init__(self, config: AddonConfig, deck_data: DeckData) -> None: 19 | self._config: AddonConfig = config 20 | self._deck_data: DeckData = deck_data 21 | 22 | def get_html(self) -> str: 23 | """Assemble the complete overview table in HTML code. 24 | 25 | The table contains additional stats and a "Study Now" button for 26 | unfinished decks. For finished decks the deck name is added above 27 | the table. Additional options can be set using the `AddonConfig` 28 | object. 29 | 30 | Returns 31 | ------- 32 | str 33 | HTML code of the assembled overview table. 34 | """ 35 | 36 | return f""" 37 | {self._get_style()} 38 | {self._get_start()} 39 | {self._get_study_stats()} 40 | {self._get_deck_stats()} 41 | {self._get_end()} 42 | """ 43 | 44 | # Return the table's style css 45 | def _get_style(self) -> str: 46 | return ( 47 | """ 48 | """ 172 | ) 173 | 174 | # Return start of the table's HTML 175 | def _get_start(self) -> str: 176 | return f""" 177 | {self._get_deck_name()} 178 | 179 | """ 180 | 181 | # Return HTML of the deck name for unfinished decks 182 | def _get_deck_name(self) -> str: 183 | if not self._deck_data.is_finished(): 184 | return "" 185 | 186 | deck_name: str = mw.col.decks.current()["name"] 187 | 188 | return f""" 189 |
190 |

{deck_name}

191 | """ 192 | 193 | # Return HTML of the study stats for unfinished decks 194 | def _get_study_stats(self) -> str: 195 | if self._deck_data.is_finished(): 196 | return "" 197 | 198 | return """ 199 |
200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 209 | 210 | 211 | 212 | 213 | 214 | 215 | 216 | 217 | 218 | 219 | 220 | """.format( 221 | labels=self._deck_data.labels, 222 | deck_stats=self._deck_data.stats, 223 | deck_percentages=self._deck_data.percentages, 224 | deck_percentages_without_suspended=self._deck_data.percentages_without_suspended, 225 | ) 226 | 227 | # Return HTML of the deck stats for unfinished decks 228 | def _get_deck_stats(self) -> str: 229 | return """ 230 | 231 | 232 | 233 | 234 | 235 | 236 | 237 | 238 | 239 | 240 | 241 | 242 | 243 | 244 | 245 | 246 | 247 | 248 | 249 | 250 | 251 | 252 | 253 | 254 | 255 | 256 | 257 | 258 | 259 | 260 | 261 | 262 | 263 | 264 | 265 | 266 | 267 | 268 | 269 | 270 | 271 | 272 | 273 | 274 | 275 | 276 | 277 | 278 | 279 | 280 | 281 | 282 | 283 | 284 | 285 | """.format( 286 | labels=self._deck_data.labels, 287 | deck_stats=self._deck_data.stats, 288 | deck_dates=self._deck_data.dates, 289 | deck_percentages=self._deck_data.percentages, 290 | deck_percentages_without_suspended=self._deck_data.percentages_without_suspended, 291 | ) 292 | 293 | # Return end of the table's HTML 294 | def _get_end(self): 295 | return f""" 296 | {self._get_study_button()} 297 |
{labels[new]:s}{deck_stats[new]:d}{deck_percentages[new]:.0%}{deck_percentages_without_suspended[new]:.0%}
{labels[learning]:s}{deck_stats[learning]:d}{deck_percentages[learning]:.0%}{deck_percentages_without_suspended[learning]:.0%}
{labels[review]:s}{deck_stats[review]:d}{deck_percentages[review]:.0%}{deck_percentages_without_suspended[review]:.0%}
{labels[mature]:s}{deck_stats[mature]:d}{deck_percentages[mature]:.0%}{deck_percentages_without_suspended[mature]:.0%}
{labels[young]:s}{deck_stats[young]:d}{deck_percentages[young]:.0%}{deck_percentages_without_suspended[young]:.0%}
{labels[learned]:s}{deck_stats[learned]:d}{deck_percentages[learned]:.0%}{deck_percentages_without_suspended[learned]:.0%}
{labels[unseen]:s}{deck_stats[unseen]:d}{deck_percentages[unseen]:.0%}{deck_percentages_without_suspended[unseen]:.0%}
{labels[buried]:s}{deck_stats[buried]:d}{deck_percentages[buried]:.0%}{deck_percentages_without_suspended[buried]:.0%}
{labels[suspended]:s}{deck_stats[suspended]:d}{deck_percentages[suspended]:.0%}ignored
{labels[total]:s}{deck_stats[total]:d}{deck_percentages[total]:.0%}{deck_percentages_without_suspended[total]:.0%}
{labels[doneDate]:s}{deck_dates[daysLeft]:s}on:{deck_dates[doneDate]:s}
298 |
299 | """ 300 | 301 | # Return HTML of the study button for unfinished decks 302 | def _get_study_button(self) -> str: 303 | if self._deck_data.is_finished(): 304 | return "" 305 | 306 | return f""" 307 | 308 | {mw.button("study", "Study Now", id="study", extra="autofocus")} 309 | 310 | """ 311 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------