├── .gitignore ├── LICENSE ├── README.md └── signalcli ├── __init__.py └── signalcli.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # signal-cli-python-api 2 | Python library to interact with signal-cli, a commanline client for Signal Messenger. The library supports programmatic sending/receiving of messages and attachments to direct recipients and group chats. Suitable for making Signal Messenger bots. 3 | 4 | signal-cli is a java application implementing the official Signal Messenger java library, and can be found here: 5 | https://github.com/AsamK/signal-cli 6 | 7 | HOWEVER: This python library currently requires a forked version of this client that has the "jsonEventLoop" functionality, and that is available here: 8 | https://github.com/kbin76/signal-cli 9 | 10 | For the example to work, you must first use the signal-cli command line client to either register a new identity or link it to an already existing identity. 11 | 12 | The example below is not complete, and it does not actually do any logging although it says it does in it's replies. 13 | 14 | ## EXAMPLE 15 | 16 | ```python 17 | 18 | import signalcli 19 | import re 20 | 21 | 22 | my_name = "sigbot" 23 | my_state = { 24 | "logging": False 25 | } 26 | 27 | def on_message( sigcli_obj, event_name, msg, state): 28 | print(str(msg)) 29 | re_m = re.match('/(\w+)', msg.message_body) 30 | if re_m: 31 | command = re_m.group(1) 32 | if command == "log": 33 | if state['logging']: 34 | sigcli_obj.reply( msg, my_name + ": Logging is OFF", reply_to_sent_messages=True) 35 | state['logging'] = False 36 | else: 37 | sigcli_obj.reply( msg, my_name + ": Logging is ON", reply_to_sent_messages=True) 38 | state['logging'] = True 39 | else: 40 | sigcli_obj.reply( msg, my_name + ": Unknown command '" + command + "'", reply_to_sent_messages=True) 41 | 42 | ## create new signal-cli object (will automatically start signal-cli in the background) 43 | sig = signalcli.Signalcli(debug=True, user_name="+46123456789") 44 | 45 | ## register event callbacks that are triggered whenever something happens 46 | k = sig.on('message', on_message, my_state) 47 | 48 | ## start the asyncio event loop 49 | sig.run() 50 | 51 | 52 | ``` 53 | 54 | ## TODO 55 | 56 | Create documentation for the library 57 | 58 | 59 | -------------------------------------------------------------------------------- /signalcli/__init__.py: -------------------------------------------------------------------------------- 1 | 2 | from .signalcli import Signalcli 3 | 4 | -------------------------------------------------------------------------------- /signalcli/signalcli.py: -------------------------------------------------------------------------------- 1 | 2 | import sys 3 | import os 4 | import asyncio 5 | import json 6 | import time 7 | import datetime 8 | 9 | class Signalcli: 10 | 11 | 12 | class Message: 13 | """ 14 | Object that represents an incoming/sent message 15 | This object is not supposed to be created manually, 16 | it's created automatically and sent to the on('message') callback. 17 | 18 | Attributes 19 | type incoming_message|sent_message 20 | timestamp Timestamp of message in epoch ms format 21 | timestamp_iso8601 Timestamp of message in IS8601 format 22 | sender_identity Identity of sender (phone-number) 23 | sender_device Identity of sender device (integer) 24 | sender_contact Sender Contact object (if present in contact list) 25 | recipient_identity Identity of recipient (phone-number or groupId or "__MYSELF__") 26 | recipient_group Recipient Group object (if sent to group chat and that group is present in the group list) 27 | recipient_contact Recipient Contact objet (if direct user-to-user message and present in contact list) 28 | recipient_type direct|group 29 | message_body The message text itself 30 | attachments List of attachments 31 | 32 | """ 33 | 34 | 35 | class MessageParsingFailure(Exception): 36 | pass 37 | 38 | 39 | @staticmethod 40 | def __epochms_to_iso8601(ms): 41 | return datetime.datetime.fromtimestamp((ms / 1000.0)).strftime('%Y-%m-%dT%H:%M:%S.%f') 42 | 43 | 44 | def __str__(self): 45 | s = "Message (" + self.type +") From: " + self.sender_identity + "/" + str(self.sender_device) + " [" + self.timestamp_iso8601 + "]\n" 46 | if self.sender_contact: 47 | s += " Sender: " + str(self.sender_contact) + "\n" 48 | if self.recipient_contact: 49 | s += " Recipient: " + str(self.__contact_list[self.recipient_identity]) + "\n" 50 | else: 51 | s += " Recipient: " + self.recipient_identity + " (" + self.recipient_type + ")\n" 52 | if self.recipient_group: 53 | s += " Group: " + str(self.recipient_group) + "\n" 54 | for a in self.attachments: 55 | s += " Attachment: Filename='" + str(a['filename']) + "', contentType='" + str(a['contentType']) + "', storagePath='" + str(a['storagePath']) + "'\n" 56 | s += " Message: " + self.message_body 57 | return s 58 | 59 | 60 | def __init__(self, envelope, group_list=None, contact_list=None, attachmentsPath=None): 61 | self.__group_list = group_list 62 | self.__contact_list = contact_list 63 | self.timestamp = envelope['timestamp'] 64 | self.timestamp_iso8601 = Signalcli.Message.__epochms_to_iso8601(self.timestamp) 65 | self.sender_identity = envelope['source'] 66 | self.sender_device = envelope['sourceDevice'] 67 | if contact_list and self.sender_identity in contact_list: 68 | self.sender_contact = contact_list[self.sender_identity] 69 | else: 70 | self.sender_contact = None 71 | self.recipient_contact = None 72 | self.recipient_group = None 73 | if envelope['dataMessage']: 74 | self.type = "incoming_message" 75 | self.message_body = envelope['dataMessage']['message'] 76 | self.attachments = envelope['dataMessage']['attachments'] 77 | if envelope['dataMessage']['groupInfo']: 78 | self.recipient_type = "group" 79 | self.recipient_identity = envelope['dataMessage']['groupInfo']['groupId'] 80 | if group_list and self.recipient_identity in group_list: 81 | self.recipient_group = group_list[self.recipient_identity] 82 | else: 83 | self.recipient_type = "direct" 84 | self.recipient_identity = "__MYSELF__" 85 | elif envelope['syncMessage']: 86 | self.type = "sent_message" 87 | if envelope['syncMessage']['sentMessage']: 88 | self.message_body = envelope['syncMessage']['sentMessage']['message'] 89 | self.attachments = envelope['syncMessage']['sentMessage']['attachments'] 90 | if envelope['syncMessage']['sentMessage']['groupInfo']: 91 | self.recipient_type = "group" 92 | self.recipient_identity = envelope['syncMessage']['sentMessage']['groupInfo']['groupId'] 93 | if group_list and self.recipient_identity in group_list: 94 | self.recipient_group = group_list[self.recipient_identity] 95 | else: 96 | self.recipient_type = "direct" 97 | self.recipient_identity = envelope['syncMessage']['sentMessage']['destination'] 98 | if contact_list and self.recipient_identity in contact_list: 99 | self.recipient_contact = contact_list[self.recipient_identity] 100 | else: 101 | raise Signalcli.Message.MessageParsingFailure() 102 | else: 103 | ## unsupported message-type 104 | raise Signalcli.Message.MessageParsingFailure() 105 | 106 | ## prepend attachmentsPath to attachment filename 107 | if self.attachments and attachmentsPath: 108 | for a in self.attachments: 109 | a['storagePath'] = os.path.join(attachmentsPath,a['id']) 110 | 111 | 112 | 113 | class Contact: 114 | """ 115 | Object that represents a Contact record from the synced Signal Address Book 116 | 117 | Attributes 118 | name Name of contact 119 | identity Identity (typically phone-number in intl. format) 120 | color Color (name of the color) 121 | profile_key Identity of the user's profile (currently not used) 122 | blocked Wether the user is blocked or not 123 | """ 124 | 125 | def __str__(self): 126 | return self.name + " (" + self.identity + ")" 127 | 128 | def __init__(self, contact_entry): 129 | if contact_entry: 130 | self.name = contact_entry['name'] 131 | self.identity = contact_entry['number'] 132 | self.color = contact_entry['color'] 133 | self.profile_key = contact_entry['profileKey'] 134 | self.blocked = contact_entry['blocked'] 135 | else: 136 | self.name = "unknown" 137 | self.identity = "unknown" 138 | self.color = "" 139 | self.profile_key = None 140 | self.blocked = False 141 | 142 | 143 | class Group: 144 | """ 145 | Object that represents a Group chat 146 | 147 | Attributes 148 | name Name of the group chat 149 | identity Identity of the chat (groupId) 150 | color Color (name of the color) 151 | blocked Wether the group is blocked 152 | active Wether the group is active 153 | members List of Contact objects of members 154 | members_id_list List of all member identities (phone-numbers) 155 | """ 156 | 157 | def __str__(self): 158 | self.__member_resolve_contacts() 159 | member_list = list(map( lambda c: str(c), self.members)) 160 | return self.name + " [" + str(member_list) + "]" 161 | 162 | 163 | def __member_resolve_contacts(self): 164 | self.members.clear() 165 | for member_identity in self.members_id_list: 166 | if member_identity in self.__contact_list: 167 | self.members.append(self.__contact_list[member_identity]) 168 | else: 169 | new_contact = Signalcli.Contact( None) 170 | new_contact.identity = member_identity 171 | new_contact.name = member_identity 172 | self.members.append(new_contact) 173 | 174 | 175 | def __init__(self, group_entry, contact_list): 176 | self.__contact_list = contact_list 177 | if group_entry: 178 | self.name = group_entry['name'] 179 | self.identity = group_entry['groupId'] 180 | self.color = group_entry['color'] 181 | self.blocked = group_entry['blocked'] 182 | self.active = group_entry['active'] 183 | self.members = [] 184 | self.members_id_list = group_entry['members'] 185 | 186 | 187 | class SignalcliUsernameError(Exception): 188 | pass 189 | 190 | 191 | class SignalcliSendError(Exception): 192 | pass 193 | 194 | 195 | def exit_program(self): 196 | """ Exit the program (nicely), may be called from the event listener callbacks """ 197 | self.__debug_out("exit_program") 198 | self.signalcli_api_ping_task.cancel() 199 | if self.incoming_json_queue: 200 | self.incoming_json_queue.join() 201 | self.async_loop.stop() 202 | #self.async_loop.close() 203 | if self.signal_cli_proc: 204 | self.signal_cli_proc.terminate() 205 | self.__debug_out("exit_program2") 206 | 207 | 208 | def __error_exit(self, msg): 209 | print( "Signalcli::ERROR(exiting): " + msg, file=sys.stderr) 210 | if self.signal_cli_proc: 211 | self.signal_cli_proc.terminate() 212 | sys.exit(-1) 213 | 214 | 215 | def __error_out(self, msg): 216 | print( "Signalcli::ERROR: " + msg, file=sys.stderr) 217 | 218 | 219 | def __debug_out(self, msg): 220 | if self.debug: 221 | print( "Signalcli::DEBUG: " + msg, file=sys.stderr) 222 | 223 | 224 | def __process_group_list(self, new_group_list): 225 | for group_list_entry in new_group_list: 226 | self.group_list[group_list_entry['groupId']] = Signalcli.Group(group_list_entry, self.contact_list) 227 | 228 | 229 | def __process_contact_list(self, new_contact_list): 230 | for contact_list_entry in new_contact_list: 231 | self.contact_list[contact_list_entry['number']] = Signalcli.Contact(contact_list_entry) 232 | 233 | 234 | async def __signalcli_api_ping( self): 235 | while True: 236 | await asyncio.sleep(2) 237 | await self.__send_json({ "reqType": "alive"}) 238 | 239 | 240 | def __get_reqID(self): 241 | self.reqID_counter += 1 242 | return self.reqID_counter 243 | 244 | 245 | def reply( self, original_message, message_body, attachments = [], reply_to_sent_messages=False): 246 | """ Reply to a message 247 | Parameters 248 | original_message Message object we want to reply to 249 | message_body Text to reply with 250 | attachments List of attachments to send with the reply 251 | reply_to_sent_messages Wether to reply also to sent_messages (our own messages) or just someone elses messages 252 | """ 253 | if original_message.type == "incoming_message" or (reply_to_sent_messages and original_message.type == "sent_message"): 254 | if original_message.recipient_type == "group": 255 | self.send_message(original_message.recipient_identity, message_body, recipient_type="group", attachments=attachments) 256 | elif original_message.recipient_type == "direct": 257 | if original_message.type == "sent_message": 258 | self.send_message(original_message.recipient_identity, message_body, recipient_type="direct", attachments=attachments) 259 | else: 260 | self.send_message(original_message.sender_identity, message_body, recipient_type="direct", attachments=attachments) 261 | 262 | 263 | def send_message( self, recipient_identity, message_body, recipient_type="direct", attachments = []): 264 | """ Send a message 265 | 266 | Parameters 267 | recipient_type direct|group 268 | recipient_identity If recipient is group, this is the groupId, if it's direct message, the recipients phone-number 269 | message_body The text message to send 270 | attachments List of filenames to attach to the message 271 | """ 272 | attachmentsList = [] 273 | for a in attachments: 274 | attachmentsList.appen({ 'filename': a}) 275 | req = { 276 | "reqID": self.__get_reqID(), 277 | "reqType": "send_message", 278 | "dataMessage": { 279 | "message": message_body, 280 | "attachments": attachmentsList 281 | } 282 | } 283 | if recipient_type == "group": 284 | req['dataMessage']['groupInfo'] = { 285 | "groupId": recipient_identity 286 | } 287 | elif recipient_type == "direct": 288 | req['recipient'] = { 289 | "number": recipient_identity 290 | } 291 | else: 292 | raise Signalcli.SignalcliSendError('recipient_type must be either "group" or "direct"') 293 | self.outgoing_json_queue.put_nowait(req) 294 | 295 | 296 | async def __send_json( self, data_object): 297 | json_str = json.dumps(data_object) 298 | if self.debug_io: 299 | print( "send_json: " + json_str, file=sys.stderr) 300 | json_str += "\n" 301 | self.signal_cli_proc.stdin.write(json_str.encode('utf8')) 302 | await self.signal_cli_proc.stdin.drain() 303 | 304 | 305 | async def __outgoing_json_queue_worker(self): 306 | while True: 307 | data_object = await self.outgoing_json_queue.get() 308 | await self.__send_json(data_object) 309 | 310 | 311 | async def __incoming_json_queue_worker(self): 312 | while True: 313 | data_object = await self.incoming_json_queue.get() 314 | respType = data_object['respType'] 315 | self.alive_timestamp = time.time() 316 | if respType == "alive": 317 | pass 318 | elif respType == "metadata": 319 | if data_object['apiVer'] != 2: 320 | self.__error_exit( "Signalcli::__incoming_json_queue_worker: Unknown apiVer: '" + data_object['apiVer'] + "'") 321 | if data_object['attachmentsPath'] != "": 322 | self.attachmentsPath = data_object['attachmentsPath'] 323 | await self.__request_groups_and_contacts() 324 | elif respType == "envelope": 325 | if data_object['envelope']['dataMessage'] or data_object['envelope']['syncMessage']: 326 | try: 327 | m = Signalcli.Message( data_object['envelope'], contact_list = self.contact_list, group_list = self.group_list, attachmentsPath = self.attachmentsPath) 328 | self.__call_event_callback( 'message', m) 329 | except Signalcli.Message.MessageParsingFailure: 330 | pass 331 | elif respType == "list_groups": 332 | self.__process_group_list(data_object['data']) 333 | elif respType == "list_contacts": 334 | self.__process_contact_list(data_object['data']) 335 | elif respType == "send_message": 336 | pass 337 | else: 338 | self.__error_out( 'Signalcli::incoming_json_queue_worker: Unknown respType="{0}"'.format(respType)) 339 | 340 | 341 | async def __stdout_stream_reader(self): 342 | while True: 343 | data_bytes = await self.signal_cli_proc.stdout.readline() 344 | if len(data_bytes): 345 | data_string = data_bytes.decode('utf8') 346 | if self.debug_io: 347 | print("stdout_stream_reader: " + data_string, end=None) 348 | try: 349 | data_object = json.loads(data_string) 350 | except json.JSONDecodeError as e: 351 | self.__error_out( "Signalcli::stdout_stream_reader: JSONDecodeError: " + str(e)) 352 | if data_object: 353 | await self.incoming_json_queue.put(data_object) 354 | else: 355 | self.__error_debug("stdout_stream_reader: EOF", file=sys.stderr) 356 | break 357 | self.exit_program() 358 | 359 | 360 | async def __stderr_stream_reader(self): 361 | while True: 362 | data_bytes = await self.signal_cli_proc.stderr.readline() 363 | if len(data_bytes): 364 | data_string = data_bytes.decode('utf8') 365 | self.__error_out("signal-cli STDERR: " + data_string) 366 | else: 367 | self.__error_out("signal-cli STDERR: EOF") 368 | break 369 | 370 | 371 | async def __request_groups_and_contacts(self): 372 | await self.__send_json({ "reqType": "list_contacts" }) 373 | await self.__send_json({ "reqType": "list_groups" }) 374 | 375 | 376 | async def __start_signal_cli_subprocess(self): 377 | self.signal_cli_proc = await asyncio.create_subprocess_exec( 378 | self.bin_path, 379 | "-u", self.user_name, "jsonEventLoop", 380 | stderr=asyncio.subprocess.PIPE, 381 | stdin=asyncio.subprocess.PIPE, 382 | stdout=asyncio.subprocess.PIPE, 383 | universal_newlines=False) 384 | self.async_loop.create_task(self.__stdout_stream_reader()) 385 | self.async_loop.create_task(self.__stderr_stream_reader()) 386 | if self.alive_check: 387 | self.signalcli_api_ping_task = self.async_loop.create_task(self.__signalcli_api_ping()) 388 | 389 | 390 | def __call_event_callback( self, event_name, event_obj): 391 | if event_name in self.callbacks: 392 | for cb in self.callbacks[event_name]: 393 | if cb['callback']: 394 | cb['callback']( self, event_name, event_obj, *(cb['callback_data'])) 395 | 396 | 397 | def on( self, event_name, callback, *callback_data): 398 | """ Add event subscriber callback and optional callback_data arguments that will be passed to the called callback function 399 | 400 | Signature of the callback function: 401 | callback(sigcli_object, event_name, event_object[, ]) 402 | 403 | Return: 404 | callback_record object that can later be used to remove the callback. 405 | 406 | Events: 407 | message On incoming messages 408 | error On errors (currently not implemented!) 409 | """ 410 | if event_name in ['message','error']: 411 | if not event_name in self.callbacks: 412 | self.callbacks[event_name] = [] 413 | new_callback_record = { 'callback': callback, 'callback_data': callback_data } 414 | self.callbacks[event_name].append(new_callback_record) 415 | return new_callback_record 416 | else: 417 | self.__error_exit("Tried to subscribe to unknown event '" + event_name + "'") 418 | return None 419 | 420 | 421 | def remove_callback( self, callback_record): 422 | """ Remove callback provided the callback_record as returned by the "on('event_name', cb)" call """ 423 | for k_event_name,v_cb_list in self.callbacks.items(): 424 | try: 425 | v_cb_list.remove(callback_record) 426 | except ValueError: 427 | pass 428 | 429 | 430 | def get_event_loop(self): 431 | """ Get the asyncio event loop object, for creating custom tasks etc """ 432 | return self.async_loop 433 | 434 | 435 | def run(self): 436 | """ Starts the asyncio event loop with run_forever(), mandatory to call when all is setup to get the application working """ 437 | self.async_loop.run_forever() 438 | 439 | 440 | def __init__(self, debug=False, event_loop=None, bin_path="signal-cli", user_name=None, alive_check=False): 441 | """ Create new Signalcli object 442 | Parameters: 443 | debug=(True/False) 444 | event_loop= Provide custom asyncio eventloop (otherwise will retrieve standard eventloop) 445 | bin_path= Full path to signal-cli executable 446 | user_name= (MANDATORY)Username to provide to signal-cli, usually phone number in international dialling format ('+XXYYYY..') 447 | alive_check=(True/False) Whether we should regularly check if signal-cli is still running 448 | """ 449 | if not event_loop: 450 | self.async_loop = asyncio.get_event_loop() 451 | else: 452 | self.async_loop = event_loop 453 | self.debug = debug 454 | if debug: 455 | self.debug_io = True 456 | else: 457 | self.debug_io = False 458 | if not user_name: 459 | raise Signalcli.SignalcliUsernameError('user_name not defined') 460 | self.reqID_counter = 0 461 | self.alive_check = alive_check 462 | self.user_name = user_name 463 | self.bin_path = bin_path 464 | self.contact_list = {} 465 | self.group_list = {} 466 | self.async_loop.run_until_complete(self.__start_signal_cli_subprocess()) 467 | self.incoming_json_queue = asyncio.Queue( loop=self.async_loop) 468 | self.outgoing_json_queue = asyncio.Queue( loop=self.async_loop) 469 | self.async_loop.create_task(self.__incoming_json_queue_worker()) 470 | self.async_loop.create_task(self.__outgoing_json_queue_worker()) 471 | self.callbacks = {} 472 | self.attachmentsPath = None 473 | 474 | 475 | --------------------------------------------------------------------------------