├── .gitignore ├── .gitmodules ├── example.cfg ├── navi ├── __init__.py ├── config.py ├── cli.py └── core.py ├── navi.py ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | 3 | .vimsession 4 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "navi/matrix-python-sdk"] 2 | path = navi/matrix-python-sdk 3 | url = https://github.com/matrix-org/matrix-python-sdk.git 4 | -------------------------------------------------------------------------------- /example.cfg: -------------------------------------------------------------------------------- 1 | [Server] 2 | # Protocol, homeserver, port 3 | HostUrl = https://homeserver.org 4 | 5 | [Client] 6 | # Bot credentials 7 | UserId = @bot_id:homeserver.org 8 | UserPassword = b0t_p4ssw0rd 9 | 10 | [Notification] 11 | # Users to get notified 12 | Users = @my_user_id:homeserver.org 13 | Rooms = !OnEeXaMpLeRoOmHaSh:matrix.org 14 | -------------------------------------------------------------------------------- /navi/__init__.py: -------------------------------------------------------------------------------- 1 | import os, sys, inspect 2 | 3 | # Add matrix-sdk submodule to path 4 | __this_dir = os.path.split(inspect.getfile(inspect.currentframe()))[0] 5 | __this_dir = os.path.realpath(os.path.abspath(__this_dir)) 6 | __matrix_dir = os.path.join(__this_dir, "matrix-python-sdk") 7 | if __matrix_dir not in sys.path: 8 | sys.path.insert(0, __matrix_dir) 9 | -------------------------------------------------------------------------------- /navi/config.py: -------------------------------------------------------------------------------- 1 | import configparser 2 | from collections import namedtuple 3 | 4 | 5 | class NaviConfig: 6 | 7 | def __init__(self, config_file): 8 | config = configparser.ConfigParser() 9 | config.read(config_file) 10 | 11 | self.sanity_check(config) 12 | self.parse(config) 13 | 14 | def parse(self, config): 15 | self.server_host_url = config.get("Server", "HostUrl") 16 | 17 | self.client_user_id = config.get("Client", "UserId") 18 | self.client_user_password = config.get("Client", "UserPassword") 19 | 20 | try: 21 | self.notification_users = set(config.get("Notification", "Users").split()) 22 | except: 23 | self.notification_users = set() 24 | 25 | try: 26 | self.notification_rooms = set(config.get("Notification", "Rooms").split()) 27 | except: 28 | self.notification_rooms = set() 29 | 30 | def sanity_check(self, config): 31 | # TODO 32 | pass 33 | -------------------------------------------------------------------------------- /navi.py: -------------------------------------------------------------------------------- 1 | #!env python 2 | 3 | import sys 4 | import select 5 | import requests 6 | 7 | from navi.core import Navi 8 | from navi.config import NaviConfig 9 | from navi.cli import NaviCli 10 | 11 | args = NaviCli() 12 | 13 | msg = None 14 | if args.message: 15 | msg = args.message 16 | elif select.select([sys.stdin], [], [], 0)[0]: 17 | msg = sys.stdin.read() 18 | elif args.media is None: 19 | sys.stderr.write("No message specified and nothing found standard input\n") 20 | sys.exit(-1) 21 | 22 | config = NaviConfig(args.config_file) 23 | try: 24 | navi = Navi( 25 | config.server_host_url, 26 | config.client_user_id, 27 | config.client_user_password, 28 | config.notification_users, 29 | config.notification_rooms, 30 | quiet=args.quiet 31 | ) 32 | 33 | if args.media is not None: 34 | for med in args.media: 35 | navi.push_media(str(med)) 36 | 37 | if msg is not None: 38 | navi.push_msg(msg) 39 | 40 | navi.shutdown() 41 | except requests.ConnectionError: 42 | sys.stderr.write("Connection problem\n") 43 | sys.exit(-1) 44 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Navi - A minimal Matrix notification bot 2 | ======================================== 3 | 4 | Navi is a tiny bot for [Matrix][1] that sends notifications to users. It is build upon the [Matrix Python SDK][2]. 5 | 6 | The motivation behind Navi is to send notifications from anywhere to everywhere. This includes the push services GCM and APNs that [Riot][4] bridges to, without having to rely on services such as Pushbullet or Pushover. 7 | 8 | The first time you use it, Navi creates a new room and invites your user to it. The room will be reused afterwards. If you leave the room, so will Navi, and invite you to a new room. 9 | You can also specify room ids that Navi should join and push to directly. If a private room is specified, make sure that you have invited Navi to that room. 10 | 11 | Usage 12 | ===== 13 | 14 | ```Shell 15 | $ navi -q -m "Hey, listen" 16 | $ tail -10 some.log | navi 17 | Connecting to https://matrix.org... 18 | Current rooms: 19 | !sjgkDaSSBKduHRADCe:matrix.org 20 | Pushing message... 21 | Connection closed. 22 | ``` 23 | 24 | Installation 25 | ============ 26 | 27 | 1. Initialize the Matrix SDK submodule: `git submodule update --init` 28 | 2. Link it into your path (e.g. `ln -s /path/to/navi.py /usr/local/bin/navi`) 29 | 3. Set up a matrix account for Navi 30 | 4. Create a [configuration][3] in `~/.navi.cfg`: 31 | 32 | Dependencies 33 | ------------ 34 | 35 | The Matrix Python SDK requires [requests][5]. Install it with `pip install requests`. 36 | Navi uses filetype. Install it with `pip install filetype`. 37 | 38 | [1]: https://matrix.org 39 | [2]: https://github.com/matrix-org/matrix-python-sdk 40 | [3]: ./example.cfg 41 | [4]: https://riot.im 42 | [5]: https://pypi.python.org/pypi/requests 43 | -------------------------------------------------------------------------------- /navi/cli.py: -------------------------------------------------------------------------------- 1 | import os 2 | import sys 3 | from argparse import ArgumentParser, RawDescriptionHelpFormatter 4 | import filetype 5 | 6 | class NaviCli: 7 | 8 | _desc = """\ 9 | Navi -- a matrix notification bot.""" 10 | 11 | _epilog = """\ 12 | Navi sends notifications to matrix users. Messages are given with the '-m' 13 | option. If none is specified, Navi will read the message from standard input. 14 | Its default configuration file is ~/.navi.cfg. Other files can be used with the 15 | '-c' option.""" 16 | 17 | def __init__(self): 18 | # print("this dir is {}".format(__init__.__this_dir)) 19 | self._parse_cli_args() 20 | 21 | @staticmethod 22 | def _default_config_file(): 23 | return os.path.expanduser("~/.navi.cfg") 24 | 25 | def _parse_cli_args(self): 26 | parser = ArgumentParser(description=self._desc, 27 | epilog=self._epilog, 28 | formatter_class=RawDescriptionHelpFormatter) 29 | 30 | parser.add_argument('-m', default=None, metavar='', dest='message', help='message') 31 | parser.add_argument('-f', default=None, metavar='', dest='media', help='media', action='append') 32 | parser.add_argument('-c', default=NaviCli._default_config_file(), 33 | metavar='', dest='config_file', help='config file\ 34 | (default: ~/.navi.cfg)') 35 | parser.add_argument('-q', action='store_true', dest='quiet', help='Stay quiet') 36 | 37 | parser.parse_args(namespace=self) 38 | 39 | # Verify args 40 | if not (os.path.exists(self.config_file) and os.path.isfile(self.config_file)): 41 | sys.stderr.write("Config file doesn't exist: {}\n".format(self.config_file)) 42 | sys.exit(-1) 43 | 44 | if self.media: 45 | for med in self.media: 46 | if not (os.path.exists(med) and os.path.isfile(med)): 47 | sys.stderr.write("File doesn't exist: {}\n".format(med)) 48 | sys.exit(-1) 49 | else: 50 | mime = filetype.guess(med) 51 | if mime is None or ("image" not in mime.mime and "video" not in mime.mime): 52 | sys.stderr.write("Not an image/video file: {}\n".format(med)) 53 | sys.exit(-1) 54 | -------------------------------------------------------------------------------- /navi/core.py: -------------------------------------------------------------------------------- 1 | import sys 2 | import os 3 | import filetype 4 | 5 | from matrix_client.client import MatrixClient 6 | from matrix_client.errors import * 7 | 8 | class Navi: 9 | """ 10 | The Navi API 11 | """ 12 | 13 | def __init__( 14 | self, 15 | host_url, 16 | user_id, 17 | password, 18 | target_users, 19 | target_rooms, 20 | quiet=False 21 | ): 22 | """ Starts up the bot. Connects to the homeserver and logs in. 23 | 24 | Args: 25 | base_url: Server url, e.g. https://example.com:8448 26 | user_id: @user:example.com 27 | password: p4ssw0rd 28 | target_users: List of users (@user_id:example.com) to push messages 29 | to 30 | """ 31 | self.quiet = quiet 32 | self.target_users = target_users 33 | self.target_rooms = target_rooms 34 | self.host_url = host_url 35 | self.user_id = user_id 36 | self.password = password 37 | 38 | try: 39 | self.client = MatrixClient(self.host_url) 40 | self._log("Connecting to {}...".format(self.host_url)) 41 | self.token = self.client.login_with_password(self.user_id, self.password) 42 | except MatrixRequestError as e: 43 | Navi._handle_matrix_exception(e) 44 | 45 | self._fetch_rooms() 46 | self._log("Current rooms:\n\t{}".format("\n\t".join(self.rooms.keys()))) 47 | 48 | def shutdown(self): 49 | """ Stops the bot """ 50 | self.client.logout() 51 | self._log("Connection closed.") 52 | 53 | def push_msg(self, msg): 54 | """ Push a message 55 | 56 | Args: 57 | msg: The message to push 58 | """ 59 | self._cleanup_rooms() 60 | self._create_rooms() 61 | self._join_rooms() 62 | 63 | self._log("Pushing message...") 64 | for r in self.rooms.values(): r.send_text(msg) 65 | 66 | def push_media(self, filepath): 67 | """ Push an image or video 68 | 69 | Args: 70 | filepath: The file path 71 | """ 72 | self._cleanup_rooms() 73 | self._create_rooms() 74 | self._join_rooms() 75 | 76 | self._log("Pushing media...") 77 | 78 | mime = filetype.guess(filepath).mime 79 | if "image" in mime: 80 | media_type = "image" 81 | elif "video" in mime: 82 | media_type = "video" 83 | else: 84 | return 85 | 86 | with open(filepath, "rb") as fld: 87 | contents = fld.read() 88 | mxc = self.client.upload(contents, mime) 89 | if media_type == "image": 90 | for r in self.rooms.values(): r.send_image(mxc, os.path.basename(filepath)) 91 | elif media_type == "video": 92 | for r in self.rooms.values(): r.send_video(mxc, os.path.basename(filepath)) 93 | 94 | def leave_all_rooms(self): 95 | """ Leaves all rooms """ 96 | self._log("Leaving all rooms..") 97 | for r in self.rooms.values(): r.leave() 98 | self._log("Left {} rooms".format(len(rooms))) 99 | 100 | def _cleanup_rooms(self): 101 | """ Leaves rooms that no target user is in """ 102 | for room_id in list(self.rooms.keys()): 103 | if room_id in self.target_rooms: continue 104 | room = self.rooms[room_id] 105 | users = map(lambda m: m.user_id, room.get_joined_members()) 106 | if any(u in users for u in self.target_users): continue 107 | self._log("Leaving room {} (Name: {})".format(room_id, room.name)) 108 | room.leave() 109 | self._fetch_rooms() 110 | 111 | def _create_rooms(self): 112 | """ Create rooms for users not found in any current room """ 113 | # Compile list of all users 114 | current_users = set() 115 | for room_id in self.rooms.keys(): 116 | room = self.rooms[room_id] 117 | room_users = map(lambda m: m.user_id, room.get_joined_members()) 118 | current_users = current_users.union(set(room_users)) 119 | missing_users = self.target_users - current_users 120 | for u in missing_users: 121 | try: 122 | self._log("Creating room for user {}...".format(u)) 123 | self.client.create_room(invitees=[u]) 124 | except MatrixRequestError as e: 125 | Navi._handle_matrix_exception(e) 126 | 127 | def _join_rooms(self): 128 | """ Join target rooms """ 129 | dirty = False 130 | for target_room_id in self.target_rooms: 131 | if not target_room_id in self.rooms.keys(): 132 | self._log("Joining room {}".format(target_room_id)) 133 | self.client.join_room(target_room_id) 134 | dirty = True 135 | if dirty: 136 | self._fetch_rooms() 137 | 138 | 139 | def _fetch_rooms(self): 140 | """ Fetches list of rooms """ 141 | self.rooms = self.client.get_rooms() 142 | 143 | def _log(self, msg): 144 | if not self.quiet: 145 | print(msg) 146 | 147 | @staticmethod 148 | def _handle_matrix_exception(e): 149 | """ Print exception and quit """ 150 | sys.stderr.write("Server Error {}: {}\n".format(e.code, e.content)) 151 | sys.exit(-1) 152 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------