├── screenshots
└── e1.png
├── arcanechat_tui
├── __main__.py
├── __init__.py
├── welcome_widget.py
├── logger.py
├── cards_widget.py
├── container.py
├── lazylistwaker.py
├── eventcenter.py
├── main.py
├── util.py
├── composer.py
├── chatlist.py
├── conversation.py
├── cli.py
└── application.py
├── pylama.ini
├── .gitignore
├── .github
└── workflows
│ └── python-ci.yml
├── pyproject.toml
├── docs
└── user-guide.md
├── README.md
└── LICENSE
/screenshots/e1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ArcaneChat/arcanechat-tui/HEAD/screenshots/e1.png
--------------------------------------------------------------------------------
/arcanechat_tui/__main__.py:
--------------------------------------------------------------------------------
1 | """Support for python module excecution"""
2 |
3 | from .main import main
4 |
5 | main()
6 |
--------------------------------------------------------------------------------
/arcanechat_tui/__init__.py:
--------------------------------------------------------------------------------
1 | """ArcaneChat TUI, a Delta Chat client for the command line"""
2 |
3 | APP_NAME = "ArcaneChat"
4 |
--------------------------------------------------------------------------------
/pylama.ini:
--------------------------------------------------------------------------------
1 | [pylama]
2 | linters=mccabe,pyflakes,pylint,isort,mypy
3 | ignore=C0116,R0902,R0913,W1203,W0718,R0903
4 | skip=.*,build/*,tests/*,*/flycheck_*,*/_version.py
5 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | .pytest_cache
2 | *.pyc
3 | __pycache__
4 | .mypy_cache
5 | muacrypt.egg-info
6 | doc/_build
7 | .cache
8 | *.swp
9 | .tox
10 | build
11 | dist
12 | *.egg-info
13 | .eggs
14 | *~
15 | .#*
16 | *#
17 | _version.py
--------------------------------------------------------------------------------
/arcanechat_tui/welcome_widget.py:
--------------------------------------------------------------------------------
1 | """Welcome screen widget displayed when no chat is selected"""
2 |
3 | import urwid
4 |
5 |
6 | class WelcomeWidget(urwid.Filler):
7 | """Welcome screen widget displayed when no chat is selected"""
8 |
9 | def __init__(self) -> None:
10 | super().__init__(urwid.Text("(No chat selected)", align="center"))
11 |
--------------------------------------------------------------------------------
/arcanechat_tui/logger.py:
--------------------------------------------------------------------------------
1 | """Logging to log files"""
2 |
3 | import logging
4 | from logging.handlers import RotatingFileHandler
5 | from pathlib import Path
6 |
7 | from . import APP_NAME
8 |
9 |
10 | def create_logger(level: str, folder: Path) -> logging.Logger:
11 | logger = logging.Logger(APP_NAME)
12 | logger.parent = None
13 |
14 | if level == "disabled":
15 | logger.disabled = True
16 | return logger
17 |
18 | formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
19 |
20 | log_path = folder / "logs"
21 | log_path.mkdir(parents=True, exist_ok=True)
22 | log_path /= "log.txt"
23 |
24 | fhandler = RotatingFileHandler(log_path, backupCount=3, maxBytes=2000000)
25 | fhandler.setLevel(level.upper())
26 | fhandler.setFormatter(formatter)
27 | logger.addHandler(fhandler)
28 |
29 | return logger
30 |
--------------------------------------------------------------------------------
/arcanechat_tui/cards_widget.py:
--------------------------------------------------------------------------------
1 | """Cards layout widget, a stack of widgets, only one is visible at a time"""
2 |
3 | from typing import Dict
4 |
5 | import urwid
6 |
7 | EMPTY = urwid.Widget()
8 |
9 |
10 | class CardsWidget(urwid.WidgetPlaceholder):
11 | """Cards layout widget, a stack of widgets, only one of them is visible at a time"""
12 |
13 | original_widget: urwid.Widget
14 |
15 | def __init__(self) -> None:
16 | super().__init__(EMPTY)
17 | self.cards: Dict[str, urwid.Widget] = {}
18 |
19 | def add(self, name: str, widget: urwid.Widget) -> None:
20 | """Add a new widget to the stack.
21 |
22 | The name must be an unique string ID to identify the item.
23 | """
24 | self.cards[name] = widget
25 |
26 | def remove(self, name: str) -> urwid.Widget:
27 | """Remove an item from the stack corresponding to the given name."""
28 | widget = self.cards.pop(name)
29 | if widget is self.original_widget:
30 | self.original_widget = EMPTY
31 | return widget
32 |
33 | def show(self, name: str) -> None:
34 | """Show the widget corresponding to the given name."""
35 | self.original_widget = self.cards[name]
36 |
--------------------------------------------------------------------------------
/arcanechat_tui/container.py:
--------------------------------------------------------------------------------
1 | """Widget container that handles key presses in the contained widget."""
2 |
3 | from typing import Callable, Optional
4 |
5 | import urwid
6 |
7 |
8 | class Container(urwid.WidgetPlaceholder):
9 | """Widget container that handles key presses in the contained widget."""
10 |
11 | def __init__(
12 | self,
13 | widget: urwid.Widget,
14 | callback: Callable[[list, str], Optional[str]],
15 | unhandled_only: bool = True,
16 | ) -> None:
17 | """
18 | :param widget: the contained widget
19 | :param callback: the callback to call on key presses unhandled by the contained widget
20 | :param unhandled_only: if set to False call callback first and if it didn't handle
21 | the key press then pass it to the contained widget. If set to True
22 | only call callback on unhandled key presses
23 | """
24 | self._callback = callback
25 | self._unhandled_only = unhandled_only
26 | super().__init__(widget)
27 |
28 | def keypress(self, size: list, key: str) -> Optional[str]:
29 | if self._unhandled_only:
30 | return super().keypress(size, key) and self._callback(size, key)
31 | return self._callback(size, key) and super().keypress(size, key)
32 |
--------------------------------------------------------------------------------
/arcanechat_tui/lazylistwaker.py:
--------------------------------------------------------------------------------
1 | """A ListWalker that creates the widgets dynamically as needed."""
2 |
3 | from functools import lru_cache
4 | from typing import Any, Callable, Iterable, NoReturn
5 |
6 | import urwid
7 |
8 |
9 | class LazyListWalker(urwid.SimpleListWalker):
10 | """A ListWalker that creates the widgets dynamically as needed."""
11 |
12 | def __init__(
13 | self,
14 | contents: Iterable,
15 | widget_factory: Callable[[Any], urwid.Widget],
16 | cache_size=1000,
17 | wrap_around: bool = False,
18 | ) -> None:
19 | self.cache_size = cache_size
20 | self._widget_factory = widget_factory
21 | self.widget_factory = lru_cache(maxsize=cache_size)(widget_factory)
22 | super().__init__(contents, wrap_around)
23 |
24 | def clear_cache(self) -> None:
25 | self.widget_factory = lru_cache(maxsize=self.cache_size)(self._widget_factory)
26 |
27 | def __getitem__(self, position: int) -> urwid.Widget:
28 | """return widget at position or raise an IndexError or KeyError"""
29 | return self.widget_factory(super().__getitem__(position))
30 |
31 | def set_modified_callback(self, callback: Callable[[], Any]) -> NoReturn:
32 | """Ignore this, just copied from SimpleListWalker to avoid pylint warning"""
33 | raise NotImplementedError('Use connect_signal(list_walker, "modified", ...) instead.')
34 |
--------------------------------------------------------------------------------
/.github/workflows/python-ci.yml:
--------------------------------------------------------------------------------
1 | name: CI
2 |
3 | on:
4 | push:
5 | branches: [ main, master ]
6 | tags:
7 | - 'v*.*.*'
8 | pull_request:
9 | branches: [ main, master ]
10 |
11 | jobs:
12 | test:
13 | runs-on: ubuntu-latest
14 | strategy:
15 | matrix:
16 | python-version: ["3.8", "3.12"]
17 | steps:
18 | - uses: actions/checkout@v2
19 | - name: Set up Python ${{ matrix.python-version }}
20 | uses: actions/setup-python@v2
21 | with:
22 | python-version: ${{ matrix.python-version }}
23 | - name: Install dependencies
24 | run: |
25 | python -m pip install --upgrade pip setuptools
26 | python -m pip install '.[dev]'
27 | - name: Check code with black
28 | run: |
29 | black --check .
30 | - name: Lint code with pylama
31 | run: |
32 | pylama
33 | - name: Test with pytest
34 | run: |
35 | # pytest
36 |
37 | deploy:
38 | needs: test
39 | runs-on: ubuntu-latest
40 | steps:
41 | - uses: actions/checkout@v2
42 | - uses: actions/setup-python@v2
43 | with:
44 | python-version: '3.x'
45 | - id: check-tag
46 | run: |
47 | if [[ "${{ github.event.ref }}" =~ ^refs/tags/v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
48 | echo ::set-output name=match::true
49 | fi
50 | - name: Create PyPI release
51 | uses: casperdcl/deploy-pypi@v2
52 | with:
53 | password: ${{ secrets.PYPI_TOKEN }}
54 | build: true
55 | # only upload if a tag is pushed (otherwise just build & check)
56 | upload: ${{ github.event_name == 'push' && steps.check-tag.outputs.match == 'true' }}
57 |
--------------------------------------------------------------------------------
/pyproject.toml:
--------------------------------------------------------------------------------
1 | [build-system]
2 | requires = ["setuptools>=69", "setuptools_scm>=8"]
3 | build-backend = "setuptools.build_meta"
4 |
5 | [project]
6 | name = "arcanechat-tui"
7 | description = "ArcaneChat client for the command line"
8 | dynamic = ["version"]
9 | readme = "README.md"
10 | requires-python = ">=3.8"
11 | keywords = ["deltachat", "ncurses", "tui", "arcanechat"]
12 | authors = [
13 | {name = "adbenitez", email = "adb@merlinux.eu"},
14 | ]
15 | classifiers = [
16 | "Development Status :: 4 - Beta",
17 | "Intended Audience :: End Users/Desktop",
18 | "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
19 | "Operating System :: POSIX",
20 | "Programming Language :: Python :: 3",
21 | ]
22 | dependencies = [
23 | "deltachat2>=0.8.0",
24 | "urwid>=2.6.10",
25 | "urwid-readline>=0.14",
26 | "appdirs>=1.4.4",
27 | ]
28 |
29 | [project.urls]
30 | Homepage = "https://github.com/ArcaneChat/arcanechat-tui"
31 | Issues = "https://github.com/ArcaneChat/arcanechat-tui/issues"
32 |
33 | [project.optional-dependencies]
34 | full = [
35 | "deltachat-rpc-server>=2.22.0",
36 | ]
37 | dev = [
38 | "deltachat-rpc-server",
39 | "black",
40 | "mypy",
41 | "isort",
42 | "pylint",
43 | "pylama",
44 | "pytest",
45 | ]
46 |
47 | [project.scripts]
48 | arcanechat-tui = "arcanechat_tui.main:main"
49 | arcanechat = "arcanechat_tui.main:main"
50 |
51 | [tool.setuptools]
52 | packages = ["arcanechat_tui"]
53 |
54 | [tool.setuptools_scm]
55 | # can be empty if no extra settings are needed, presence enables setuptools_scm
56 | version_file = "arcanechat_tui/_version.py"
57 |
58 | [tool.black]
59 | line-length = 100
60 |
61 | [tool.isort]
62 | profile = "black"
63 |
64 | [tool.mypy]
65 | ignore_missing_imports = "True"
66 |
--------------------------------------------------------------------------------
/docs/user-guide.md:
--------------------------------------------------------------------------------
1 | # User Guide
2 |
3 | ## Installation
4 |
5 | Install ArcaneChat TUI with pip:
6 |
7 | ```
8 | $ pip install -U arcanechat-tui
9 | ```
10 |
11 | ## Usage
12 |
13 | After installation the command `arcanechat` should be available, or you can use
14 | `python3 -m arcanechat-tui`. You can check if it is installed running the command
15 | `arcanechat --version` or `arcanechat --help` to see all the options
16 |
17 | ### Creating new account
18 |
19 | The first time you use ArcaneChat TUI you need to configure your account:
20 |
21 | ```
22 | $ arcanechat init me@example.com MyPassword
23 | ```
24 |
25 | Then run `arcanechat` command to start the application with your configured account.
26 |
27 | ### Opening accounts from other Delta Chat clients
28 |
29 | If you want to use an already existent account, for example to open an account from
30 | the official Delta Chat client:
31 |
32 | ```
33 | $ arcanechat -f ~/.config/DeltaChat/
34 | ```
35 |
36 | ## Tips
37 |
38 | - The message timestamp will be gray if the message is encrypted, or red it is not encrypted.
39 | - You will see `→` in your message if it is not sent yet, `✓` if it was send,
40 | `✓✓` when the message was read, or a red `!` if the message was not delivered to some of
41 | the recipients.
42 | - If you like to use the mouse, you can use the mouse to select chats in the chat list,
43 | select the draft area or scroll in the message history.
44 |
45 | ## Default Shortcuts
46 |
47 | - Press Esc in the draft/composer area to close the chat and go to the chat list.
48 | - Press q to quit the program.
49 | - Use Meta + Enter to enter new line.
50 | - For shortcuts in the draft/composer area see: [urwid_readline](https://github.com/rr-/urwid_readline)
51 |
--------------------------------------------------------------------------------
/arcanechat_tui/eventcenter.py:
--------------------------------------------------------------------------------
1 | """Event center"""
2 |
3 | import urwid
4 | from deltachat2 import Client, CoreEvent, EventType
5 |
6 | CHATLIST_CHANGED = "chatlist_changed"
7 | CHAT_CHANGED = "chat_changed"
8 | MESSAGES_CHANGED = "msgs_changed"
9 |
10 |
11 | class EventCenter:
12 | """Event center dispatching Delta Chat core events"""
13 |
14 | signals = [CHATLIST_CHANGED, CHAT_CHANGED, MESSAGES_CHANGED]
15 |
16 | def __init__(self) -> None:
17 | urwid.register_signal(self.__class__, self.signals)
18 |
19 | def process_core_event(self, client: Client, accid: int, event: CoreEvent) -> None:
20 | if event.kind == EventType.CHAT_MODIFIED:
21 | urwid.emit_signal(self, CHAT_CHANGED, client, accid, event.chat_id)
22 | urwid.emit_signal(self, CHATLIST_CHANGED, client, accid)
23 |
24 | elif event.kind == EventType.CONTACTS_CHANGED:
25 | urwid.emit_signal(self, CHATLIST_CHANGED, client, accid)
26 |
27 | elif event.kind == EventType.INCOMING_MSG:
28 | urwid.emit_signal(self, MESSAGES_CHANGED, client, accid, event.chat_id, event.msg_id)
29 | urwid.emit_signal(self, CHATLIST_CHANGED, client, accid)
30 |
31 | elif event.kind == EventType.MSGS_CHANGED:
32 | urwid.emit_signal(self, MESSAGES_CHANGED, client, accid, event.chat_id, event.msg_id)
33 | urwid.emit_signal(self, CHATLIST_CHANGED, client, accid)
34 |
35 | elif event.kind == EventType.MSGS_NOTICED:
36 | urwid.emit_signal(self, CHATLIST_CHANGED, client, accid)
37 |
38 | elif event.kind == EventType.MSG_DELIVERED:
39 | urwid.emit_signal(self, MESSAGES_CHANGED, client, accid, event.chat_id, event.msg_id)
40 |
41 | elif event.kind == EventType.MSG_FAILED:
42 | urwid.emit_signal(self, MESSAGES_CHANGED, client, accid, event.chat_id, event.msg_id)
43 |
44 | elif event.kind == EventType.MSG_READ:
45 | urwid.emit_signal(self, MESSAGES_CHANGED, client, accid, event.chat_id, event.msg_id)
46 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # ArcaneChat TUI
2 |
3 | [](https://pypi.org/project/arcanechat-tui)
4 | [](https://pypi.org/project/arcanechat-tui)
5 | [](https://github.com/ArcaneChat/arcanechat-tui/actions/workflows/python-ci.yml)
6 | [](https://github.com/psf/black)
7 |
8 | > a lightweight ArcaneChat client for the command line
9 |
10 |
11 |
12 |
13 |
14 | ArcaneChat TUI is a ncurses Delta Chat client developed in Python with the urwid library.
15 |
16 | #### Features
17 |
18 | - [X] Create accounts
19 | - [X] Tweak account configuration (ex. set display name and status)
20 | - [X] Ability to send text messages :)
21 | - [X] Read receipts ✓✓
22 | - [X] Display quoted messages
23 | - [ ] Account switcher
24 | - [ ] Chat operations: delete, pin/unpin, mute/unmute, archive/unarchive, add/remove members, etc.
25 | - [ ] Message operations: reply, delete, open attachment/links, see info, jump to quote
26 | - [ ] Import/export keys and backups
27 | - [ ] Ability to send files
28 | - [ ] Notifications
29 | - [ ] Support for contact verification and group invitations links
30 | - [ ] Block/unblock contacts and see the list of blocked contacts
31 | - [ ] See contact list
32 | - [ ] Search messages and chats
33 | - [ ] Open HTML messages
34 | - [ ] View archived chats
35 |
36 | ## Installing
37 |
38 | #### With pip
39 |
40 | This program depends on the `deltachat-rpc-server` program to be installed in your system,
41 | if you want to try to install it using pip run:
42 |
43 | ```
44 | $ pip install -U "arcanechat-tui[full]"
45 | ```
46 |
47 | If you will manually install the `deltachat-rpc-server` program in
48 | your PATH on your own, then run:
49 |
50 | ```
51 | $ pip install -U arcanechat-tui
52 | ```
53 |
54 | #### With pipx
55 |
56 | To install ArcaneChat TUI with [pipx](https://pipx.pypa.io):
57 |
58 | ```
59 | $ pipx install arcanechat-tui deltachat-rpc-server
60 | ```
61 |
62 | ## Using
63 |
64 | After installation the command `arcanechat-tui`
65 | (and `arcanechat` alias) should be available.
66 |
67 | For more tips and info check [the user guide](https://github.com/ArcaneChat/arcanechat-tui/blob/main/docs/user-guide.md)
68 |
--------------------------------------------------------------------------------
/arcanechat_tui/main.py:
--------------------------------------------------------------------------------
1 | """Program's entry point"""
2 |
3 | import logging
4 | import subprocess
5 |
6 | from deltachat2 import Client, CoreEvent, EventType, IOTransport, Rpc, events
7 |
8 | from .application import Application
9 | from .cli import Cli
10 | from .logger import create_logger
11 | from .util import get_account
12 |
13 | FG_COLOR = "white"
14 | BG_COLOR = "g11"
15 | dtheme = {
16 | "background": ["", "", "", FG_COLOR, BG_COLOR],
17 | "status_bar": ["", "", "", "white", "g23"],
18 | "focused_item": ["", "", "", "white", "g23"],
19 | "separator": ["", "", "", "g15", "g15"],
20 | "date": ["", "", "", "#6f0", BG_COLOR],
21 | "encrypted": ["", "", "", "dark gray", BG_COLOR],
22 | "unencrypted": ["", "", "", "dark red", BG_COLOR],
23 | "failed": ["", "", "", "white", "dark red"],
24 | "selected_chat": ["", "", "", "black", "light blue"],
25 | "unread_badge": ["", "", "", "#000", "#6f0"],
26 | "unread_badge_muted": ["", "", "", "#000", "dark gray"],
27 | "reversed": ["", "", "", BG_COLOR, FG_COLOR],
28 | "quote": ["", "", "", "dark gray", BG_COLOR],
29 | "mention": ["", "", "", "bold, light red", BG_COLOR],
30 | "system_msg": ["", "", "", "dark gray", BG_COLOR],
31 | "self_msg": ["", "", "", "dark green", BG_COLOR],
32 | }
33 | dkeymap = {
34 | "quit": "q",
35 | "send_msg": "enter",
36 | "insert_new_line": "meta enter",
37 | "next_chat": "meta up",
38 | "prev_chat": "meta down",
39 | }
40 | hooks = events.HookCollection()
41 |
42 |
43 | @hooks.on(events.RawEvent)
44 | def log_event(client: Client, accid: int, event: CoreEvent) -> None:
45 | if event.kind == EventType.INFO:
46 | client.logger.debug("[acc=%s] %s", accid, event.msg)
47 | elif event.kind == EventType.WARNING:
48 | client.logger.warning("[acc=%s] %s", accid, event.msg)
49 | elif event.kind == EventType.ERROR:
50 | client.logger.error("[acc=%s] %s", accid, event.msg)
51 |
52 |
53 | def main() -> None:
54 | args = Cli().parse_args()
55 | args.program_folder.mkdir(parents=True, exist_ok=True)
56 | accounts_dir = args.program_folder / "accounts"
57 | logging.getLogger("deltachat2.IOTransport").disabled = True
58 | with IOTransport(accounts_dir=accounts_dir, stderr=subprocess.DEVNULL) as trans:
59 | client = Client(Rpc(trans), hooks, create_logger(args.log, args.program_folder))
60 | if "cmd" in args:
61 | args.cmd(client, args)
62 | else:
63 | accid = get_account(client.rpc, args.account)
64 | Application(client, keymap=dkeymap, theme=dtheme).run(accid)
65 |
--------------------------------------------------------------------------------
/arcanechat_tui/util.py:
--------------------------------------------------------------------------------
1 | """Utilities"""
2 |
3 | from pathlib import Path
4 | from typing import Any
5 |
6 | from deltachat2 import ChatType, Rpc
7 |
8 |
9 | def shorten_text(text: str, width: int, placeholder: str = "…") -> str:
10 | text = " ".join(text.split())
11 | if len(text) > width:
12 | width -= len(placeholder)
13 | assert width > 0, "placeholder can't be bigger than width"
14 | text = text[:width].strip() + placeholder
15 | return text
16 |
17 |
18 | def get_subtitle(rpc: Rpc, accid: int, chat: Any) -> str:
19 | if chat.is_self_talk:
20 | return "Messages I sent to myself"
21 | if chat.is_device_chat:
22 | return "Locally generated messages"
23 | if chat.chat_type == ChatType.MAILINGLIST:
24 | return "Mailing List"
25 |
26 | members = rpc.get_chat_contacts(accid, chat.id)
27 | if chat.chat_type == ChatType.SINGLE:
28 | subtitle = rpc.get_contact(accid, members[0]).address
29 | elif chat.chat_type == ChatType.BROADCAST:
30 | count = len(members)
31 | subtitle = "1 recipient" if count == 1 else f"{count} recipients"
32 | else:
33 | count = len(members)
34 | subtitle = "1 member" if count == 1 else f"{count} members"
35 |
36 | return subtitle
37 |
38 |
39 | def abspath(path: str) -> Path:
40 | try:
41 | return Path(path).expanduser().absolute()
42 | except RuntimeError:
43 | return Path(path).absolute()
44 |
45 |
46 | def parse_docstring(txt) -> tuple:
47 | """parse docstring, returning a tuple with short and long description"""
48 | description = txt
49 | i = txt.find(".")
50 | if i == -1:
51 | help_ = txt
52 | else:
53 | help_ = txt[: i + 1]
54 | return help_, description
55 |
56 |
57 | def get_or_create_account(rpc: Rpc, addr: str) -> int:
58 | """Get account for address, if no account exists create a new one."""
59 | accid = get_account(rpc, addr)
60 | if not accid:
61 | accid = rpc.add_account()
62 | rpc.set_config(accid, "addr", addr)
63 | return accid
64 |
65 |
66 | def get_account(rpc: Rpc, addr: str) -> int:
67 | """Get account id for address.
68 | If no account exists with the given address, zero is returned.
69 | """
70 | if not addr:
71 | return 0
72 |
73 | try:
74 | return int(addr)
75 | except ValueError:
76 | for accid in rpc.get_all_account_ids():
77 | if addr == get_address(rpc, accid):
78 | return accid
79 |
80 | return 0
81 |
82 |
83 | def get_address(rpc: Rpc, accid: int) -> str:
84 | if rpc.is_configured(accid):
85 | return rpc.get_config(accid, "configured_addr")
86 | return rpc.get_config(accid, "addr")
87 |
--------------------------------------------------------------------------------
/arcanechat_tui/composer.py:
--------------------------------------------------------------------------------
1 | """Composer area widget"""
2 |
3 | from typing import Dict, Optional, Tuple
4 |
5 | import urwid
6 | import urwid_readline
7 | from deltachat2 import Client, JsonRpcError, MsgData
8 |
9 | from ._version import __version__
10 | from .util import get_subtitle, shorten_text
11 |
12 | SENDING_MSG_FAILED = "sending_msg_failed"
13 |
14 |
15 | class ReadlineEdit2(urwid_readline.ReadlineEdit):
16 | """Edit widget"""
17 |
18 | def __init__(self, insert_new_line_key: str) -> None:
19 | super().__init__(multiline=True)
20 | del self.keymap["enter"]
21 | self.keymap[insert_new_line_key] = self.insert_new_line
22 |
23 | def previous_line(self):
24 | """Patch bug: https://github.com/rr-/urwid_readline/issues/24"""
25 | x, y = self.get_cursor_coords(self.size)
26 | return self.move_cursor_to_coords(self.size, x, y - 1)
27 |
28 |
29 | class ComposerWidget(urwid.Filler):
30 | """Composer area and chat status bar"""
31 |
32 | signals = [SENDING_MSG_FAILED]
33 |
34 | def __init__(self, client: Client, keymap: Dict[str, str]) -> None:
35 | self.client = client
36 | self.keymap = keymap
37 | self.chat: Optional[Tuple[int, int]] = None
38 | self.status_bar = urwid.Text(("status_bar", ""), align="left")
39 | self.edit_widget = ReadlineEdit2(keymap["insert_new_line"])
40 | prompt = urwid.Columns([(urwid.PACK, urwid.Text("> ")), self.edit_widget])
41 | super().__init__(urwid.Pile([urwid.AttrMap(self.status_bar, "status_bar"), prompt]))
42 | self._update_status_bar(None)
43 |
44 | def set_chat(self, chat: Optional[Tuple[int, int]]) -> None:
45 | self.chat = chat
46 | self.edit_widget.set_edit_text("")
47 | self.edit_widget.set_edit_pos(0)
48 | self._update_status_bar(chat)
49 |
50 | def _send_message(self, text) -> None:
51 | accid, chatid = self.chat or (0, 0)
52 | if accid:
53 | chat = self.client.rpc.get_basic_chat_info(accid, chatid)
54 | if chat.is_contact_request:
55 | # accept contact requests automatically on sending
56 | self.client.rpc.accept_chat(accid, chatid)
57 | try:
58 | self.client.rpc.send_msg(accid, chatid, MsgData(text=text))
59 | except JsonRpcError:
60 | errmsg = "Message could not be sent, are you a member of the chat?"
61 | urwid.emit_signal(self, SENDING_MSG_FAILED, errmsg)
62 | else:
63 | urwid.emit_signal(self, SENDING_MSG_FAILED, "No chat selected")
64 |
65 | def _update_status_bar(self, chat: Optional[Tuple[int, int]]) -> None:
66 | if chat:
67 | info = self.client.rpc.get_basic_chat_info(*chat)
68 | verified = "✓ " if info.is_self_talk or info.is_device_chat else ""
69 | muted = " (muted)" if info.is_muted else ""
70 | name = shorten_text(info.name, 40)
71 |
72 | subtitle = shorten_text(get_subtitle(self.client.rpc, chat[0], info), 40)
73 | text = f" {verified}[ {name} ]{muted} -- {subtitle}"
74 | else:
75 | text = f" ArcaneChat {__version__}"
76 |
77 | self.status_bar.set_text(text)
78 |
79 | def keypress(self, size: list, key: str) -> Optional[str]:
80 | if key == self.keymap["send_msg"]:
81 | text = self.edit_widget.get_edit_text().strip()
82 | if text:
83 | self.edit_widget.set_edit_text("")
84 | self._send_message(text)
85 | return None
86 | return super().keypress(size, key)
87 |
--------------------------------------------------------------------------------
/arcanechat_tui/chatlist.py:
--------------------------------------------------------------------------------
1 | """Chat list widget"""
2 |
3 | from typing import Any, Callable, Optional, Tuple
4 |
5 | import urwid
6 | from deltachat2 import ChatlistFlag, Client
7 |
8 | from .lazylistwaker import LazyListWalker
9 | from .util import shorten_text
10 |
11 | CHAT_SELECTED = "chat_selected"
12 |
13 |
14 | class ChatListItem(urwid.Button):
15 | """A single chatlist item"""
16 |
17 | def __init__(
18 | self,
19 | accid: int,
20 | item: Any,
21 | selected: bool,
22 | callback: Callable[["ChatListItem"], None],
23 | ) -> None:
24 | super().__init__("", callback)
25 | self.accid = accid
26 | self.id = item.id
27 | elements: list = []
28 |
29 | if item.is_self_talk:
30 | color = "#0af"
31 | icon = "*"
32 | elif item.is_device_talk:
33 | color = "#888"
34 | icon = "i"
35 | else:
36 | color = item.color
37 | icon = "@" if item.dm_chat_contact else "#"
38 | elements.append((urwid.AttrSpec("#fff", color), f" {icon} "))
39 |
40 | if item.is_pinned:
41 | elements.append("*")
42 | else:
43 | elements.append(" ")
44 |
45 | name = shorten_text(item.name, 40)
46 | elements.append(("selected_chat", name) if selected else name)
47 |
48 | if item.fresh_message_counter > 0:
49 | elements.append(" ")
50 | style = "unread_badge_muted" if item.is_muted else "unread_badge"
51 | elements.append((style, f"({item.fresh_message_counter})"))
52 |
53 | self._w = urwid.AttrMap(urwid.SelectableIcon(elements, 3), None, focus_map="focused_item")
54 |
55 |
56 | class ChatListWidget(urwid.ListBox):
57 | """Display a list of chats"""
58 |
59 | signals = [CHAT_SELECTED]
60 |
61 | def __init__(self, client: Client) -> None:
62 | self.client = client
63 | self.accid: Optional[int] = None
64 | self.selected_chat: Optional[Tuple[int, int]] = None
65 | super().__init__(LazyListWalker([], self._create_chatlist_item))
66 |
67 | def set_account(self, accid: Optional[int]) -> None:
68 | self.accid = accid
69 | if self.selected_chat and accid != self.selected_chat[0]:
70 | self._select_chat(None)
71 | self.chatlist_changed(self.client, accid)
72 |
73 | def select_chat(self, chat: Optional[Tuple[int, int]]) -> None:
74 | self._select_chat(chat)
75 | self.chatlist_changed(self.client, self.accid)
76 |
77 | def chatlist_changed(self, client: Client, accid: Optional[int]) -> None:
78 | if not self.accid:
79 | self.body.clear_cache()
80 | self.body.clear()
81 | elif accid == self.accid:
82 | entries = client.rpc.get_chatlist_entries(accid, ChatlistFlag.NO_SPECIALS, None, None)
83 | item = self.focus
84 | self.body.clear_cache()
85 | self.body[:] = [(accid, chatid) for chatid in entries]
86 | try:
87 | index = max(entries.index(item.id), 0) if item else 0
88 | except ValueError:
89 | pass
90 | else:
91 | if entries:
92 | self.set_focus(index)
93 |
94 | def _create_chatlist_item(self, chat: Tuple[int, int]) -> urwid.Widget:
95 | item = self.client.rpc.get_chatlist_items_by_entries(chat[0], [chat[1]])[str(chat[1])]
96 | return ChatListItem(chat[0], item, self.selected_chat == chat, self._on_item_clicked)
97 |
98 | def _on_item_clicked(self, item: ChatListItem) -> None:
99 | self._select_chat((item.accid, item.id))
100 | self.chatlist_changed(self.client, self.accid) # so the selected chat widget is updated
101 |
102 | def _select_chat(self, chat: Optional[Tuple[int, int]]) -> None:
103 | self.selected_chat = chat
104 | urwid.emit_signal(self, CHAT_SELECTED, self.selected_chat)
105 |
--------------------------------------------------------------------------------
/arcanechat_tui/conversation.py:
--------------------------------------------------------------------------------
1 | """Conversation area widget"""
2 |
3 | from datetime import datetime
4 | from typing import Any, Optional, Tuple
5 |
6 | import urwid
7 | from deltachat2 import (
8 | Client,
9 | Message,
10 | MessageState,
11 | SpecialContactId,
12 | SystemMessageType,
13 | )
14 |
15 | from .lazylistwaker import LazyListWalker
16 | from .util import shorten_text
17 |
18 |
19 | class DayMarker(urwid.Columns):
20 | """Day marker separating messages by day"""
21 |
22 | def __init__(self, timestamp: int):
23 | date = datetime.utcfromtimestamp(timestamp) # timestamp is in local time already
24 | date_format = "%b %d, %Y"
25 | date_label = urwid.Text(("date", date.strftime(f"\n {date_format} ")))
26 | divider = urwid.AttrMap(urwid.Divider("─", top=1, bottom=1), "date")
27 | date_wgt = urwid.Columns([divider, ("flow", date_label), divider])
28 | margin = ("fixed", 1, urwid.Text(" "))
29 | super().__init__([margin, date_wgt, margin])
30 |
31 |
32 | class MessageItem(urwid.AttrMap):
33 | """A single message item"""
34 |
35 | def __init__(self, msg: Any, nickbg: str) -> None:
36 | sender = msg.sender
37 | sent_date = datetime.fromtimestamp(msg.timestamp)
38 | if (
39 | msg.show_padlock
40 | or (sender.id <= SpecialContactId.LAST_SPECIAL and sender.id != SpecialContactId.SELF)
41 | or msg.system_message_type == SystemMessageType.WEBXDC_INFO_MESSAGE
42 | ):
43 | timestamp = sent_date.strftime(" %H:%M ")
44 | date_wgt = (len(timestamp), urwid.SelectableIcon(("encrypted", timestamp)))
45 | else:
46 | timestamp = sent_date.strftime("!%H:%M ")
47 | date_wgt = (len(timestamp), urwid.SelectableIcon(("unencrypted", timestamp)))
48 |
49 | header_wgt = get_sender_label(msg, nickbg)
50 |
51 | lines = []
52 | if msg.quote:
53 | if msg.quote.kind == "WithMessage":
54 | quote_sender = msg.quote.override_sender_name or msg.quote.author_display_name
55 | quote_color = urwid.AttrSpec(msg.quote.author_display_color, nickbg)
56 | lines.append((quote_color, f"│ {quote_sender}\n"))
57 | else:
58 | quote_color = "quote"
59 | lines.append((quote_color, "│ "))
60 | lines.append(("quote", f"{shorten_text(msg.quote.text, 150, placeholder='[…]')}\n"))
61 | text = msg.text
62 | if msg.file_name:
63 | text = f"[{msg.file_name}]{' – ' if text else ''}{text}"
64 | if msg.is_info:
65 | lines.append(("system_msg", text))
66 | else:
67 | if sender.id == SpecialContactId.SELF:
68 | lines.append(("self_msg", text))
69 | else:
70 | lines.append(text)
71 | body_wgt = urwid.Text(lines or "")
72 |
73 | cols = urwid.Columns([date_wgt, urwid.Pile([header_wgt, body_wgt])])
74 | super().__init__(cols, None, focus_map="focused_item")
75 |
76 |
77 | class ConversationWidget(urwid.ListBox):
78 | """Display a list of messages"""
79 |
80 | def __init__(self, client: Client, nickbg: str) -> None:
81 | self.client = client
82 | self.nickbg = nickbg
83 | self.chat: Optional[Tuple[int, int]] = None
84 | super().__init__(LazyListWalker([], self._create_message_item))
85 |
86 | def set_chat(self, chat: Optional[Tuple[int, int]]) -> None:
87 | self.chat = chat
88 | if chat:
89 | self.client.rpc.marknoticed_chat(*chat)
90 | self._update_conversation()
91 |
92 | def messages_changed(self, _client: Client, accid: int, chatid: int, _msgid: int) -> None:
93 | if self.chat and accid == self.chat[0] and chatid in (self.chat[1], 0):
94 | self._update_conversation()
95 |
96 | def _update_conversation(self) -> None:
97 | self.body.clear_cache()
98 | if self.chat:
99 | items = self.client.rpc.get_message_list_items(*self.chat, False, True)
100 | self.body[:] = [
101 | (self.chat[0], item.kind, item.msg_id if item.kind == "message" else item.timestamp)
102 | for item in items
103 | ]
104 | if items:
105 | self.set_focus(len(items) - 1)
106 | else:
107 | self.body.clear()
108 |
109 | def _create_message_item(self, item: Tuple[int, str, int]) -> urwid.Widget:
110 | if item[1] == "message":
111 | self.client.rpc.markseen_msgs(item[0], [item[2]])
112 | return MessageItem(self.client.rpc.get_message(item[0], item[2]), self.nickbg)
113 | return DayMarker(item[2])
114 |
115 |
116 | def get_sender_label(msg: Message, nickbg: str) -> urwid.Text:
117 | name = shorten_text(msg.override_sender_name or msg.sender.display_name, 50)
118 | components: list = [(urwid.AttrSpec(msg.sender.color, nickbg), name)]
119 | if msg.state == MessageState.OUT_MDN_RCVD:
120 | components.append(" ✓✓")
121 | elif msg.state == MessageState.OUT_DELIVERED:
122 | components.append(" ✓")
123 | elif msg.state == MessageState.OUT_PENDING:
124 | components.append(" →")
125 | elif msg.state == MessageState.OUT_FAILED:
126 | components.extend([" ", ("failed", " ! ")])
127 | return urwid.Text(components)
128 |
--------------------------------------------------------------------------------
/arcanechat_tui/cli.py:
--------------------------------------------------------------------------------
1 | """Command line arguments parsing"""
2 |
3 | import sys
4 | from argparse import ArgumentParser, Namespace
5 | from typing import Callable
6 |
7 | from appdirs import user_config_dir
8 | from deltachat2 import Client, JsonRpcError
9 |
10 | from . import APP_NAME
11 | from ._version import __version__
12 | from .util import abspath, get_account, get_or_create_account, parse_docstring
13 |
14 |
15 | class Cli:
16 | """Command line argument parser"""
17 |
18 | def __init__(self) -> None:
19 | self._parser = ArgumentParser()
20 | self._subcommands = self._parser.add_subparsers(title="subcommands")
21 |
22 | self._parser.add_argument("-v", "--version", action="version", version=__version__)
23 |
24 | self._parser.add_argument(
25 | "--program-folder",
26 | "-f",
27 | help="program configuration folder (default: %(default)s)",
28 | metavar="PATH",
29 | default=user_config_dir(APP_NAME),
30 | type=abspath,
31 | )
32 |
33 | self._parser.add_argument(
34 | "--account",
35 | "-a",
36 | help="operate only over the given account when running any subcommand",
37 | metavar="ADDR",
38 | )
39 |
40 | self._parser.add_argument(
41 | "--log",
42 | help=(
43 | "set the severity level of what should be saved in the log file"
44 | " (default: %(default)s)"
45 | ),
46 | choices=["debug", "info", "warning", "error", "disabled"],
47 | default="warning",
48 | type=str.lower,
49 | )
50 |
51 | init_parser = self.add_subcommand(init_cmd, name="init")
52 | init_parser.add_argument("addr", help="your e-mail address")
53 | init_parser.add_argument("password", help="your password")
54 |
55 | import_parser = self.add_subcommand(import_cmd, name="import")
56 | import_parser.add_argument("path", help="path to the backup file to import")
57 |
58 | config_parser = self.add_subcommand(config_cmd, name="config")
59 | config_parser.add_argument("option", help="option name", nargs="?")
60 | config_parser.add_argument("value", help="option value to set", nargs="?")
61 |
62 | def add_subcommand(
63 | self,
64 | func: Callable[["Cli", Namespace], None],
65 | **kwargs,
66 | ) -> ArgumentParser:
67 | """Add a subcommand to the CLI."""
68 | if not kwargs.get("name"):
69 | kwargs["name"] = func.__name__
70 | if not kwargs.get("help") and not kwargs.get("description"):
71 | kwargs["help"], kwargs["description"] = parse_docstring(func.__doc__)
72 | subparser = self._subcommands.add_parser(**kwargs)
73 | subparser.set_defaults(cmd=func)
74 | return subparser
75 |
76 | def parse_args(self) -> Namespace:
77 | """Parse command line arguments"""
78 | return self._parser.parse_args()
79 |
80 |
81 | def init_cmd(client: Client, args: Namespace) -> None:
82 | """initialize an account"""
83 | if args.account:
84 | accid = get_account(client.rpc, args.account)
85 | if not accid or accid not in client.rpc.get_all_account_ids():
86 | print(f"Error: unknown account: {args.account!r}")
87 | sys.exit(1)
88 | else:
89 | accid = get_or_create_account(client.rpc, args.addr)
90 |
91 | try:
92 | client.configure(accid, email=args.addr, password=args.password)
93 | print("Account configured successfully.")
94 | except JsonRpcError as err:
95 | print("ERROR: Configuration failed:", err)
96 | sys.exit(1)
97 |
98 |
99 | def import_cmd(client: Client, args: Namespace) -> None:
100 | """import account from backup file"""
101 | if args.account:
102 | print("Error: -a/--account can't be used with this subcommand")
103 | sys.exit(1)
104 |
105 | try:
106 | client.rpc.import_backup(client.rpc.add_account(), args.path, None)
107 | print("Backup imported successfully.")
108 | except JsonRpcError as err:
109 | print("ERROR: Failed to import backup:", err)
110 | sys.exit(1)
111 |
112 |
113 | def config_cmd(client: Client, args: Namespace) -> None:
114 | """set or get account configuration values"""
115 | accounts = client.rpc.get_all_account_ids()
116 | if not args.account and len(accounts) == 1:
117 | args.account = accounts[0]
118 |
119 | if args.account:
120 | accid = get_account(client.rpc, args.account)
121 | if not accid or accid not in accounts:
122 | print(f"Error: unknown account: {args.account!r}")
123 | sys.exit(1)
124 |
125 | keys = (client.rpc.get_config(accid, "sys.config_keys") or "").split()
126 | if args.option and not args.option.startswith("ui.") and args.option not in keys:
127 | print(f"Error: unknown configuration option: {args.option}")
128 | sys.exit(1)
129 |
130 | if args.value:
131 | client.rpc.set_config(accid, args.option, args.value)
132 |
133 | if args.option:
134 | try:
135 | value = client.rpc.get_config(accid, args.option)
136 | print(f"{args.option}={value!r}")
137 | except JsonRpcError:
138 | print(f"Error: unknown configuration option: {args.option}")
139 | sys.exit(1)
140 | else:
141 | for key in keys:
142 | value = client.rpc.get_config(accid, key)
143 | print(f"{key}={value!r}")
144 | else:
145 | print(
146 | "Error: you must use --account option to set what account to set/get"
147 | " configuration values"
148 | )
149 | sys.exit(1)
150 |
--------------------------------------------------------------------------------
/arcanechat_tui/application.py:
--------------------------------------------------------------------------------
1 | """Main UI program"""
2 |
3 | import sys
4 | from threading import Thread
5 | from typing import Optional, Tuple
6 |
7 | import urwid
8 | from deltachat2 import Client
9 |
10 | from .cards_widget import CardsWidget
11 | from .chatlist import CHAT_SELECTED, ChatListWidget
12 | from .composer import SENDING_MSG_FAILED, ComposerWidget
13 | from .container import Container
14 | from .conversation import ConversationWidget
15 | from .eventcenter import CHATLIST_CHANGED, MESSAGES_CHANGED, EventCenter
16 | from .util import shorten_text
17 | from .welcome_widget import WelcomeWidget
18 |
19 |
20 | class Application:
21 | """Main application UI"""
22 |
23 | def __init__(self, client: Client, keymap: dict, theme: dict) -> None:
24 | self.client = client
25 | self.keymap = keymap
26 | self.accid: Optional[int] = None
27 | eventcenter = EventCenter()
28 |
29 | self.chatlist = ChatListWidget(client)
30 | urwid.connect_signal(eventcenter, CHATLIST_CHANGED, self.chatlist.chatlist_changed)
31 | chatlist_cont = Container(self.chatlist, self._chatlist_keypress)
32 |
33 | conversation = ConversationWidget(client, theme["background"][-1])
34 | urwid.connect_signal(self.chatlist, CHAT_SELECTED, conversation.set_chat)
35 | urwid.connect_signal(eventcenter, MESSAGES_CHANGED, conversation.messages_changed)
36 | conversation_cont = Container(conversation, self._conversation_keypress)
37 |
38 | composer = ComposerWidget(client, keymap)
39 | urwid.connect_signal(self.chatlist, CHAT_SELECTED, composer.set_chat)
40 | composer_cont = Container(composer, self._composer_keypress)
41 |
42 | self.cards = CardsWidget()
43 | self.cards.add("welcome", WelcomeWidget())
44 | self.cards.add("conversation", conversation_cont)
45 | self.cards.show("welcome")
46 |
47 | self.right_side = urwid.Pile([self.cards, (urwid.PACK, composer_cont)])
48 |
49 | vsep = urwid.AttrMap(urwid.Filler(urwid.Columns([])), "separator")
50 |
51 | # layout root
52 | self.main_columns = urwid.Columns(
53 | [("weight", 1, chatlist_cont), (1, vsep), ("weight", 4, self.right_side)]
54 | )
55 | self.frame = urwid.Frame(self.main_columns)
56 |
57 | self.loop = urwid.MainLoop(
58 | urwid.AttrMap(self.frame, "background"),
59 | [(key, *value) for key, value in theme.items()],
60 | unhandled_input=self._unhandled_keypress,
61 | )
62 | self.loop.screen.set_terminal_properties(colors=256)
63 |
64 | urwid.connect_signal(self.chatlist, CHAT_SELECTED, self.chat_selected)
65 | urwid.connect_signal(composer, SENDING_MSG_FAILED, self.sending_msg_failed)
66 | urwid.connect_signal(eventcenter, CHATLIST_CHANGED, self.chatlist_changed)
67 | urwid.connect_signal(eventcenter, MESSAGES_CHANGED, self.messages_changed)
68 | client.add_hook(eventcenter.process_core_event)
69 |
70 | def _print_title(self) -> None:
71 | badge = 0
72 | for acc in self.client.rpc.get_all_account_ids():
73 | badge += len(self.client.rpc.get_fresh_msgs(acc))
74 | name = self.client.rpc.get_config(self.accid, "displayname")
75 | if not name:
76 | name = self.client.rpc.get_config(self.accid, "configured_addr")
77 | name = shorten_text(name, 30)
78 | if badge > 0:
79 | text = f"\x1b]2;({badge if badge < 999 else '+999'}) {name}\x07"
80 | else:
81 | text = f"\x1b]2;{name}\x07"
82 | sys.stdout.write(text)
83 |
84 | def exit(self) -> None:
85 | sys.stdout.write("\x1b]2;\x07")
86 | raise urwid.ExitMainLoop
87 |
88 | def chat_selected(self, chat: Optional[Tuple[int, int]]) -> None:
89 | if chat:
90 | self.cards.show("conversation")
91 | # focus composer
92 | self.main_columns.focus_position = 2
93 | self.right_side.focus_position = 1
94 | else:
95 | self.cards.show("welcome")
96 | # focus chatlist
97 | self.main_columns.focus_position = 0
98 |
99 | def messages_changed(self, _client: Client, accid: int, chatid: int, _msgid: int) -> None:
100 | chat = self.chatlist.selected_chat
101 | if accid == self.accid and chat and chatid in (chat[1], 0):
102 | self.loop.draw_screen()
103 |
104 | def chatlist_changed(self, _client: Client, accid: int) -> None:
105 | self._print_title()
106 | if accid == self.accid:
107 | self.loop.draw_screen()
108 |
109 | def sending_msg_failed(self, error: str) -> None:
110 | self.toast(urwid.AttrMap(urwid.Text([" Error: ", error]), "failed"), 5)
111 |
112 | def toast(self, element: urwid.Widget, duration: int) -> None:
113 | def reset_footer(*_) -> None:
114 | if self.frame.footer == element:
115 | self.frame.footer = None
116 |
117 | self.frame.footer = element
118 | self.loop.set_alarm_in(duration, reset_footer)
119 |
120 | def _unhandled_keypress(self, key: str) -> None:
121 | if key == self.keymap["quit"]:
122 | self.exit()
123 |
124 | def _chatlist_keypress(self, _size: list, key: str) -> Optional[str]:
125 | if key in ("right", "tab"):
126 | # give focus to the composer area
127 | self.main_columns.focus_position = 2
128 | self.right_side.focus_position = 1
129 | return None
130 | return key
131 |
132 | def _conversation_keypress(self, _size: list, key: str) -> Optional[str]:
133 | if key in ("tab", "esc"):
134 | # give focus to the composer area
135 | self.right_side.focus_position = 1
136 | return None
137 | return key
138 |
139 | def _composer_keypress(self, _size: list, key: str) -> Optional[str]:
140 | if key == "esc":
141 | self.chatlist.select_chat(None)
142 | return None
143 | return key
144 |
145 | def run(self, accid: int = 0) -> None:
146 | rpc = self.client.rpc
147 | self.accid = accid or self.client.rpc.get_selected_account_id()
148 | if not self.accid:
149 | accounts = [rpc.is_configured(accid) for accid in rpc.get_all_account_ids()]
150 | if accounts:
151 | self.accid = accounts[0]
152 | else:
153 | print("Error: No account configured yet")
154 | sys.exit(1)
155 | elif not rpc.is_configured(self.accid):
156 | print("Error: Account configured yet")
157 | sys.exit(1)
158 |
159 | self.chatlist.set_account(self.accid)
160 | self._print_title()
161 | Thread(target=self.client.run_forever, daemon=True).start()
162 | try:
163 | self.loop.run()
164 | except KeyboardInterrupt:
165 | pass
166 |
--------------------------------------------------------------------------------
/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 | {one line to give the program's name and a brief idea of what it does.}
635 | Copyright (C) {year} {name of author}
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 | {project} Copyright (C) {year} {fullname}
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 |
--------------------------------------------------------------------------------