├── .github ├── FUNDING.yml ├── ISSUE_TEMPLATE │ ├── 1_bug_report.md │ ├── 2_enhancement_request.md │ └── 3_question.md └── PULL_REQUEST_TEMPLATE.md ├── .gitignore ├── LICENSE ├── Notify.py ├── Notify ├── __init__.py └── apprise-theme │ ├── general │ ├── apprise-failure-128x128.ico │ ├── apprise-failure-128x128.png │ ├── apprise-failure-256x256.png │ ├── apprise-failure-32x32.png │ ├── apprise-failure-72x72.png │ ├── apprise-info-128x128.ico │ ├── apprise-info-128x128.png │ ├── apprise-info-256x256.png │ ├── apprise-info-32x32.png │ ├── apprise-info-72x72.png │ ├── apprise-success-128x128.ico │ ├── apprise-success-128x128.png │ ├── apprise-success-256x256.png │ ├── apprise-success-32x32.png │ ├── apprise-success-72x72.png │ ├── apprise-warning-128x128.ico │ ├── apprise-warning-128x128.png │ ├── apprise-warning-256x256.png │ ├── apprise-warning-32x32.png │ └── apprise-warning-72x72.png │ └── sabnzbd │ ├── apprise-failure-128x128.ico │ ├── apprise-failure-128x128.png │ ├── apprise-failure-256x256.png │ ├── apprise-failure-32x32.png │ ├── apprise-failure-72x72.png │ ├── apprise-info-128x128.ico │ ├── apprise-info-128x128.png │ ├── apprise-info-256x256.png │ ├── apprise-info-32x32.png │ ├── apprise-info-72x72.png │ ├── apprise-success-128x128.ico │ ├── apprise-success-128x128.png │ ├── apprise-success-256x256.png │ ├── apprise-success-32x32.png │ ├── apprise-success-72x72.png │ ├── apprise-warning-128x128.ico │ ├── apprise-warning-128x128.png │ ├── apprise-warning-256x256.png │ ├── apprise-warning-32x32.png │ └── apprise-warning-72x72.png ├── README.md ├── requirements.txt └── sabnzbd-notify.py /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | github: caronc 2 | custom: ['https://www.paypal.me/lead2gold', ] 3 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/1_bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: 🐛 Bug Report 3 | about: Report any errors and problems 4 | title: '' 5 | labels: 'bug' 6 | assignees: '' 7 | 8 | --- 9 | 10 | :beetle: **Describe the bug** 11 | 12 | 13 | :bulb: **Screenshots and Logs** 14 | 15 | 16 | 17 | :computer: **Your System Details:** 18 | - OS: [e.g. RedHat v8.0] 19 | - Python Version: [e.g. Python v2.7] 20 | 21 | :crystal_ball: **Additional context** 22 | Add any other context about the problem here. 23 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/2_enhancement_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: 💡 Enhancement Request 3 | about: Got a great idea? Let us know! 4 | title: '' 5 | labels: 'enhancement' 6 | assignees: '' 7 | 8 | --- 9 | 10 | :bulb: **The Idea** 11 | 12 | 13 | :hammer: **Breaking Feature** 14 | 16 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/3_question.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: ❓ Support Question 3 | about: Ask a question about NZB-Notify 4 | title: '' 5 | labels: 'question' 6 | assignees: '' 7 | 8 | --- 9 | 10 | :question: **Question** 11 | 12 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ## Description: 2 | **Related issue (if applicable):** # 3 | 4 | 5 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | 5 | # C extensions 6 | *.so 7 | 8 | # Distribution / packaging 9 | .Python 10 | env/ 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | lib/ 17 | lib64/ 18 | parts/ 19 | sdist/ 20 | var/ 21 | *.egg-info/ 22 | .installed.cfg 23 | *.egg 24 | 25 | # PyInstaller 26 | # Usually these files are written by a python script from a template 27 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 28 | *.manifest 29 | *.spec 30 | 31 | # Installer logs 32 | pip-log.txt 33 | pip-delete-this-directory.txt 34 | 35 | # Unit test / coverage reports 36 | htmlcov/ 37 | .tox/ 38 | .coverage 39 | .cache 40 | nosetests.xml 41 | coverage.xml 42 | 43 | # Translations 44 | *.mo 45 | *.pot 46 | 47 | # Django stuff: 48 | *.log 49 | 50 | # Sphinx documentation 51 | docs/_build/ 52 | 53 | # PyBuilder 54 | target/ 55 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /Notify.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- encoding: utf-8 -*- 3 | # 4 | # Notififications Core 5 | # 6 | # Copyright (C) 2014-2022 Chris Caron 7 | # 8 | # This file is part of NZB-Notify. 9 | # 10 | # NZB-Notify is free software: you can redistribute it and/or modify 11 | # it under the terms of the GNU General Public License as published by 12 | # the Free Software Foundation, either version 2 of the License, or 13 | # (at your option) any later version. 14 | # 15 | # NZB-Notify is distributed in the hope that it will be useful, 16 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 17 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 | # GNU General Public License for more details. 19 | # 20 | # You should have received a copy of the GNU General Public License 21 | # along with NZB-Notify. If not, see . 22 | 23 | ########################################################################### 24 | ### NZBGET QUEUE/POST-PROCESSING SCRIPT 25 | ### QUEUE EVENTS: NZB_ADDED 26 | 27 | # NZBGet Notifications. 28 | # 29 | # The script will send a Notification to the systems of choice identified 30 | # with the status of a download. 31 | # 32 | # Info about this Notify NZB Script: 33 | # Author: Chris Caron (lead2gold@gmail.com). 34 | # Date: Sun, Mar 13th, 2022. 35 | # License: GPLv2 (http://www.gnu.org/licenses/gpl.html). 36 | # Script Version: 1.0.1. 37 | # 38 | # Home: https://github.com/caronc/nzb-notify 39 | # Wiki: https://github.com/caronc/nzb-notify/wiki 40 | 41 | ########################################################################### 42 | ### OPTIONS 43 | 44 | # Servers. 45 | # 46 | # Specify the server(s) you wish to notify. If there is more than 47 | # one, simply use a comma and/or space to delimit the addresses. If the 48 | # server uses a non-standard port, use colon (:PORT) at the end of 49 | # the servers that this applies to. Some servers require a login and 50 | # password to work correctly, the user can also be specified in the 51 | # url as well. The following values are valid: 52 | # - service://user@host:port 53 | # - service://password@host:port 54 | # - service://user:password@host:port 55 | # - service://host:port 56 | # - service://host 57 | # 58 | # 59 | # The following services are currently supported: 60 | # - boxcar:// -> A Boxcar Notification 61 | # - boxcars:// -> A secure Boxcar Notification 62 | # - discord:// -> A Discord Notification 63 | # - d7sms:// -> A D7 Networks SMS Notification 64 | # - emby:// -> A Emby Notification 65 | # - faast:// -> A Faast Notification 66 | # - flock:// -> A Flock Notification 67 | # - gitter:// -> A Gitter Notification 68 | # - gnome:// -> A Gnome Notification 69 | # - growl:// -> A Growl Notification 70 | # - gotify:// -> A Gotify Notification 71 | # - ifttt:// -> A IFTTT (If This Than That) Notification 72 | # - join:// -> A Join Notification 73 | # - json:// -> A simple json query 74 | # - jsons:// -> A secure, simple json query 75 | # - kde:// -> A KDE Notification 76 | # - kodi:// -> A KODI Notification 77 | # - kodis:// -> A Secure KODI Notification 78 | # - mailgun:// -> An Mailgun Notification 79 | # - matrix:// -> A Matrix Notification 80 | # - matrixs:// -> A Secure Matrix Notification 81 | # - mailto:// -> An email Notification 82 | # - mailtos:// -> A secure email Notification 83 | # - mattermost:// -> A Mattermost Notification 84 | # - msteams:// -> A Microsoft Teams Notification 85 | # - nexmo:// -> A Nexmo Notification 86 | # - prowl:// -> A Prowl Server 87 | # - pbul:// -> A PushBullet Notification 88 | # - pover:// -> A Pushover Notification 89 | # - pjet:// -> A Pushjet Notification 90 | # - pushed:// -> A Pushed Notification 91 | # - rocket:// -> A Rocket.Chat Notification 92 | # - rockets:// -> A Secure Rocket.Chat Notification 93 | # - ryver:// -> A Ryver Notification 94 | # - slack:// -> A Slack Notification 95 | # - sns:// -> Amazon Web Service (AWS) - Simple Notificaation Service (SNS) 96 | # - tgram:// -> A Telegram Notification 97 | # - twilio:// -> A Twilio Notification 98 | # - twitter:// -> A Twitter Direct Message (DM) Notification 99 | # - twist:// -> A Twist Notification 100 | # - xml:// -> A simple xml (SOAP) Notification 101 | # - xmls:// -> A secure, simple xml (SOAP) Notification 102 | # - mmost:// -> A (Unsecure) MatterMost Notification 103 | # - mmosts:// -> A Secure MatterMost Notification 104 | # - xbmc:// -> An XBMC Notification (protocol v2) 105 | # - xmpp:// -> An XMPP Notification 106 | # - wxteams:// -> An Cisco Webex Teams Notification 107 | # - windows:// -> A Microsoft Windows Notification 108 | # - zulip:// -> An Zulip Chat Notification 109 | # 110 | # Note: For details on how to use each notification checkout this link: 111 | # https://github.com/caronc/apprise/wiki 112 | # 113 | # Note: You may specify as many servers as you wish so long as they're 114 | # separated by a comma and/or space. 115 | #Servers= 116 | 117 | # Send Notification when Queued (yes, no). 118 | # 119 | # Send a notification when a new entry is queued into NZBGet for 120 | # download. 121 | #OnQueue=yes 122 | 123 | # Send Notification on Failure (yes, no). 124 | # 125 | # Send a notification if the download failed. 126 | #OnFailure=yes 127 | 128 | # Send Notification on Success (yes, no). 129 | # 130 | # Send a notification if the download was successful. 131 | #OnSuccess=yes 132 | 133 | # Include Statistics (yes, no). 134 | # 135 | # Include statistics (if possible) in notification(s) 136 | #IncludeStats=yes 137 | 138 | # Include Files (yes, no). 139 | # 140 | # Include a file listing (if possible) of content retrieved. 141 | # Note: File listings are excempted if the download failed. 142 | #IncludeFiles=yes 143 | 144 | # Include Logs (yes, no, OnFailure). 145 | # 146 | # Include the log entries in the notification 147 | #IncludeLogs=OnFailure 148 | 149 | # Send a notification image when supported (yes, no). 150 | # 151 | # Instruct the script to include a supported image with the notification 152 | # if the protocol supports it. 153 | #IncludeImage=yes 154 | 155 | # Enable debugging mode (yes, no). 156 | # 157 | # Logging will be much more verbose, but if you are experiencing issues, 158 | # developers and support staff will only be able to help you much easier 159 | # if they have this extra bit of detail in your logging output. 160 | #Debug=no 161 | 162 | # You can test your server configuration here. 163 | #TestServers@Test Server Configuration 164 | 165 | ### NZBGET QUEUE/POST-PROCESSING SCRIPT 166 | ########################################################################### 167 | import logging 168 | import re 169 | import six 170 | from os.path import join 171 | from os.path import dirname 172 | 173 | # pip install nzbget 174 | from nzbget import SCRIPT_MODE 175 | from nzbget import PostProcessScript 176 | from nzbget import QueueScript 177 | from nzbget import QueueEvent 178 | 179 | # pip install apprise 180 | from apprise import Apprise 181 | from apprise import NotifyType 182 | from apprise import NOTIFY_TYPES 183 | from apprise import NotifyFormat 184 | from apprise import AppriseAsset 185 | 186 | # Used for character detection 187 | from chardet import detect as chardet_detect 188 | 189 | # HTML New Line Delimiter 190 | NOTIFY_NEWLINE = '\r\n' 191 | 192 | NOTIFY_THEMES_MAP = { 193 | # ideally this should be the id 'nzbget' but to be backwards 194 | # compatible with the previous version, we'll leave the directory 195 | # structure as it is. For this reason, we need the mapping this table 196 | # provides. 197 | 'nzbget': 'general', 198 | 'sabnzbd': 'sabnzbd', 199 | 200 | # Support our own lookup 201 | 'general': 'general', 202 | } 203 | 204 | 205 | class IncludeLogOption(object): 206 | YES = 'YES' 207 | NO = 'NO' 208 | ONFAILURE = 'ONFAILURE' 209 | 210 | 211 | INCLUDE_LOG_OPTIONS = ( 212 | IncludeLogOption.YES, 213 | IncludeLogOption.NO, 214 | IncludeLogOption.ONFAILURE, 215 | ) 216 | 217 | # Used to break a path list into parts 218 | PATHSPLIT_LIST_DELIM = re.compile(r'[ \t\r\n,\\/]+') 219 | 220 | 221 | def decode(str_data, encoding=None): 222 | """ 223 | Returns the unicode string of the data passed in 224 | otherwise it throws a ValueError() exception. This function makes 225 | use of the chardet library 226 | 227 | If encoding == None then it is attempted to be detected by chardet 228 | If encoding is a string, then only that encoding is used 229 | """ 230 | if six.PY3: 231 | # nothing to do for Python 3 232 | return str_data 233 | 234 | elif isinstance(str_data, unicode): 235 | return str_data 236 | 237 | default_encoding = 'utf-8' 238 | if encoding is None: 239 | decoded = chardet_detect(str_data) 240 | if decoded: 241 | encoding = decoded.get('encoding', default_encoding) 242 | else: 243 | encoding = default_encoding 244 | 245 | try: 246 | str_data = str_data.decode( 247 | encoding, 248 | errors='ignore', 249 | ) 250 | return str_data 251 | 252 | except UnicodeError: 253 | raise ValueError( 254 | '%s contains invalid characters' % ( 255 | str_data, 256 | )) 257 | except KeyError: 258 | raise ValueError( 259 | '%s encoding could not be detected ' % ( 260 | str_data, 261 | )) 262 | return None 263 | 264 | 265 | class NotifyScript(PostProcessScript, QueueScript): 266 | """Inheriting PostProcessScript grants you access to of the API defined 267 | throughout this wiki 268 | """ 269 | 270 | def notify(self, body, title, notify_type=NotifyType.INFO, servers=None, 271 | body_format=NotifyFormat.MARKDOWN, theme=None): 272 | """ 273 | processes list of servers specified 274 | """ 275 | 276 | # Decode our data 277 | body = decode(body) 278 | title = decode(title) 279 | 280 | # Apprise Asset Object 281 | asset = AppriseAsset() 282 | asset.app_id = 'NZB-Notify' 283 | asset.app_desc = 'NZB Notification' 284 | asset.app_url = 'https://github.com/caronc/nzb-notify' 285 | 286 | asset.image_path_mask = join( 287 | dirname(__file__), 288 | 'Notify', 'apprise-theme', '{THEME}', 289 | 'apprise-{TYPE}-{XY}.png') 290 | 291 | # Image URL Mask 292 | asset.image_url_mask = \ 293 | 'https://raw.githubusercontent.com/caronc/nzb-notify/master/' \ 294 | 'Notify/apprise-theme/{THEME}/' \ 295 | 'apprise-{TYPE}-{XY}{EXTENSION}' 296 | 297 | # Application Logo 298 | asset.image_url_logo = \ 299 | 'https://raw.githubusercontent.com/caronc/nzb-notify/master/' \ 300 | 'Notify/apprise-theme/{THEME}/' \ 301 | 'apprise-logo.png' 302 | 303 | # Assign theme 304 | asset.theme = 'general' if not theme else theme 305 | 306 | if not isinstance(servers, six.string_types): 307 | # servers can be a list of URLs, or it can be 308 | # a string which will be parsed into this list 309 | # we wanted. 310 | servers = self.get('Servers', '') 311 | 312 | # Create our apprise object 313 | a = Apprise(asset=asset) 314 | 315 | # Add our URL(s) 316 | a.add(servers) 317 | 318 | # Notify our servers 319 | a.notify(body=body, title=title, notify_type=notify_type, 320 | body_format=body_format) 321 | 322 | # Always return true 323 | return True 324 | 325 | def queue_main(self, *args, **kwargs): 326 | """Queue Script 327 | """ 328 | 329 | if not self.validate(keys=( 330 | 'Servers', 331 | 'IncludeImage', 332 | 'OnQueue', 333 | )): 334 | return False 335 | 336 | on_queue = self.parse_bool(self.get('OnQueue')) 337 | if not on_queue: 338 | return None 339 | 340 | if self.event != QueueEvent.NZB_ADDED: 341 | return None 342 | 343 | notify_type = NotifyType.INFO 344 | 345 | # Contents 346 | title = '' 347 | 348 | if self.health_check(): 349 | title = 'New File Queued for Download' 350 | else: 351 | # Do nothing; there is nothing queued now 352 | return None 353 | 354 | return self.notify( 355 | title=title, 356 | body=self.nzbname, 357 | notify_type=notify_type, 358 | ) 359 | 360 | def postprocess_main(self, *args, **kwargs): 361 | """Post Processing Script 362 | """ 363 | 364 | if not self.validate(keys=( 365 | 'Servers', 366 | 'IncludeImage', 367 | 'IncludeFiles', 368 | 'IncludeStats', 369 | 'IncludeLogs', 370 | 'OnFailure', 371 | 'OnSuccess', 372 | )): 373 | return False 374 | 375 | on_failure = self.parse_bool(self.get('OnFailure')) 376 | on_success = self.parse_bool(self.get('OnSuccess')) 377 | 378 | include_stats = self.parse_bool(self.get('IncludeStats')) 379 | include_files = self.parse_bool(self.get('IncludeFiles')) 380 | include_logs = self.get('IncludeLogs', 'NO').upper() 381 | 382 | health_okay = self.health_check() 383 | 384 | if include_logs not in INCLUDE_LOG_OPTIONS: 385 | # Default to being off 386 | include_logs = IncludeLogOption.NO 387 | 388 | # Contents 389 | title = '' 390 | body = '## %s ##' % self.nzbname 391 | body += NOTIFY_NEWLINE + 'Status: %s' % str(self.status) 392 | 393 | if health_okay: 394 | if not on_success: 395 | self.logger.debug('Success notifications supressed.') 396 | return None 397 | notify_type = NotifyType.SUCCESS 398 | title = 'Download Successful' 399 | else: 400 | if not on_failure: 401 | self.logger.debug('Failure notifications supressed.') 402 | return None 403 | notify_type = NotifyType.FAILURE 404 | title = 'Download Failed' 405 | 406 | def hhmmss(seconds): 407 | """ 408 | takes an integer and returns hh:mm:ss 409 | """ 410 | m, s = divmod(seconds, 60) 411 | h, m = divmod(m, 60) 412 | return "%02d:%02d:%02d" % (round(h), round(m), round(s)) 413 | 414 | # Get Statistics 415 | if include_stats: 416 | stats = self.get_statistics() 417 | if stats: 418 | # Build Printable List From Statistics 419 | statistics_core = [ 420 | ' * Download Size: %.2f MB' % stats['download_size_mb'], 421 | ' * Download Time: %s' % \ 422 | hhmmss(stats['download_time_sec']), 423 | ' * Transfer Speed: %.2f %s ' % ( 424 | stats['download_avg'], 425 | stats['download_avg_unit'], 426 | ), 427 | ] 428 | 429 | statistics_par = [ 430 | ' * Analyse Time: %s' % \ 431 | hhmmss(stats['par_prepare_time_sec']), 432 | ' * Repair Time: %s' % \ 433 | hhmmss(stats['par_repair_time_sec']), 434 | ] 435 | 436 | statistics_overall = [ 437 | ' * Total Archive Preparation Time: %s' % \ 438 | hhmmss(stats['par_total_time_sec']), 439 | ' * Unarchiving Time: %s' % \ 440 | hhmmss(stats['unpack_time_sec']), 441 | ' * Total Post-Process Time: %s' % \ 442 | hhmmss(stats['postprocess_time']), 443 | ' * Total Time: %s' % \ 444 | hhmmss(stats['total_time_sec']), 445 | ] 446 | 447 | body += NOTIFY_NEWLINE + NOTIFY_NEWLINE + \ 448 | '### Statistics ###' + \ 449 | NOTIFY_NEWLINE + NOTIFY_NEWLINE.join(statistics_core) + \ 450 | NOTIFY_NEWLINE + NOTIFY_NEWLINE.join(statistics_par) + \ 451 | NOTIFY_NEWLINE + NOTIFY_NEWLINE.join(statistics_overall) 452 | 453 | # Retrieve File listings (if possible) 454 | files = self.get_files( 455 | followlinks=True, fullstats=True, 456 | min_depth=None, max_depth=None, 457 | ) 458 | 459 | if include_files and health_okay: 460 | # Build printable file list from results 461 | files_downloaded = [] 462 | for _file, meta in files.items(): 463 | unit = 'B' 464 | val = float(meta['filesize']) 465 | if val >= 1024.0: 466 | val = val/1024.0 467 | unit = 'KB' 468 | if val >= 1024.0: 469 | val = val/1024.0 470 | unit = 'MB' 471 | if val >= 1024.0: 472 | val = val/1024.0 473 | unit = 'GB' 474 | if val >= 1024.0: 475 | val = val/1024.0 476 | unit = 'TB' 477 | 478 | files_downloaded.append( 479 | ' * ' + _file[len(self.directory)+1:] + ' (%.2f %s)' % ( 480 | val, unit 481 | )) 482 | 483 | if files_downloaded: 484 | body += NOTIFY_NEWLINE + NOTIFY_NEWLINE + '### File(s) ###' + \ 485 | NOTIFY_NEWLINE + \ 486 | NOTIFY_NEWLINE.join(sorted(files_downloaded)) 487 | 488 | if include_logs == IncludeLogOption.YES or \ 489 | (include_logs == IncludeLogOption.ONFAILURE \ 490 | and not health_okay): 491 | 492 | # Fetch logs 493 | logs = self.get_logs(25) 494 | if logs: 495 | body += NOTIFY_NEWLINE + NOTIFY_NEWLINE + '### Logs ###' + \ 496 | ('%s * ' % NOTIFY_NEWLINE) + \ 497 | ('%s * ' % NOTIFY_NEWLINE).join(logs) 498 | 499 | # Preform Notifications 500 | return self.notify( 501 | title=title, 502 | body=body, 503 | notify_type=notify_type, 504 | ) 505 | 506 | def action_testservers(self, *args, **kwargs): 507 | """ 508 | Execute the TestServers Test Action 509 | """ 510 | 511 | if not self.validate(keys=( 512 | 'Servers', 513 | 'IncludeImage', 514 | 'IncludeFiles', 515 | 'IncludeStats', 516 | 'IncludeLogs', 517 | 'OnFailure', 518 | 'OnSuccess', 519 | )): 520 | return False 521 | 522 | on_failure = self.parse_bool(self.get('OnFailure')) 523 | on_success = self.parse_bool(self.get('OnSuccess')) 524 | 525 | include_stats = self.parse_bool(self.get('IncludeStats')) 526 | include_files = self.parse_bool(self.get('IncludeFiles')) 527 | include_logs = self.get('IncludeLogs', 'NO').upper() 528 | 529 | # Prepare our Test Response 530 | notify_type = NotifyType.INFO 531 | title = 'NZBGet-Notify Configuration Test' 532 | body = '## NZBGet-Notify Configuration Test ##\r\n' 533 | body += '- **OnFailure**: %s\r\n' % ( 534 | 'Yes' if on_failure else 'No') 535 | body += '- **OnSuccess**: %s\r\n' % ( 536 | 'Yes' if on_success else 'No') 537 | body += '- **Include Statistics**: %s\r\n' % ( 538 | 'Yes' if include_stats else 'No') 539 | body += '- **Include File Listings**: %s\r\n' % ( 540 | 'Yes' if include_files else 'No') 541 | body += '- **Include Log Details**: %s\r\n' % ( 542 | 'Yes' if include_logs else 'No') 543 | 544 | # Preform Notifications 545 | return self.notify( 546 | title=title, 547 | body=body, 548 | notify_type=notify_type, 549 | ) 550 | 551 | def main(self, *args, **kwargs): 552 | """CLI 553 | """ 554 | 555 | # Environment 556 | servers = self.get('Servers', None) 557 | title = self.get('Title', 'Test Notify Title') 558 | body = self.get('Body', 'Test Notify Body') 559 | 560 | # Acquire our theme 561 | theme = NOTIFY_THEMES_MAP[self.get('Theme', 'general')] 562 | notify_type = self.get('NotificationType', 'info') 563 | if notify_type not in NOTIFY_TYPES: 564 | notify_type = 'info' 565 | self.logger.warning( 566 | "%s is an invalid notification type; using '%s'." % ( 567 | str(self.get('NotificationType', 'info')), notify_type)) 568 | 569 | if not servers: 570 | self.logger.info('No servers were specified --servers (-s)') 571 | return False 572 | 573 | # Preform Notifications 574 | return self.notify( 575 | title=title, 576 | body=body, 577 | servers=servers, 578 | body_format=NotifyFormat.TEXT, 579 | notify_type=notify_type, 580 | theme=theme, 581 | ) 582 | 583 | 584 | # Call your script as follows: 585 | if __name__ == "__main__": 586 | from optparse import OptionParser 587 | 588 | # Support running from the command line 589 | parser = OptionParser() 590 | parser.add_option( 591 | "-s", 592 | "--servers", 593 | dest="servers", 594 | help="Specify 1 or more servers in their URL format ie: " + 595 | "growl://mypass@localhost", 596 | metavar="URL(s)", 597 | ) 598 | parser.add_option( 599 | "-t", 600 | "--title", 601 | dest="title", 602 | help="Specify the title of the notification message.", 603 | metavar="TITLE", 604 | ) 605 | parser.add_option( 606 | "-b", 607 | "--body", 608 | dest="body", 609 | help="Specify the body of the notification message.", 610 | metavar="BODY", 611 | ) 612 | parser.add_option( 613 | "-i", 614 | "--include_image", 615 | action="store_true", 616 | dest="include_image", 617 | help="Include image in message if the protocol supports it.", 618 | ) 619 | parser.add_option( 620 | "-T", 621 | "--theme", 622 | dest="theme", 623 | help="Provide the theme to use (nzbget or sabnzbd)" 624 | ) 625 | parser.add_option( 626 | "-n", 627 | "--notification-type", 628 | dest="ntype", 629 | help="Provide the notification type to use (info, success, warning, or failure)" 630 | ) 631 | parser.add_option( 632 | "-L", 633 | "--logfile", 634 | dest="logfile", 635 | help="Send output to the specified logfile instead of stdout.", 636 | metavar="FILE", 637 | ) 638 | parser.add_option( 639 | "-D", 640 | "--debug", 641 | action="store_true", 642 | dest="debug", 643 | help="Debug Mode", 644 | ) 645 | options, _args = parser.parse_args() 646 | 647 | logger = options.logfile 648 | if not logger: 649 | # True = stdout 650 | logger = True 651 | debug = options.debug 652 | 653 | script_mode = None 654 | _servers = options.servers 655 | _body = options.body 656 | _title = options.title 657 | _include_image = options.include_image 658 | _theme = None if not options.theme else options.theme.lower().strip() 659 | _ntype = None if not options.ntype else options.ntype.lower().strip() 660 | 661 | if _servers: 662 | # By specifying a scandir, we know for sure the user is 663 | # running this as a standalone script, 664 | 665 | # Setting Script Mode to NONE forces main() to execute 666 | # which is where the code for the cli() is defined 667 | script_mode = SCRIPT_MODE.NONE 668 | 669 | # Initialize Script 670 | script = NotifyScript( 671 | logger=logger, 672 | debug=debug, 673 | script_mode=script_mode, 674 | ) 675 | 676 | # Initialize entries if any were specified 677 | if not script.get('Servers') and _servers: 678 | script.set('Servers', _servers) 679 | 680 | if not script.get('Title') and _title: 681 | script.set('Title', _title) 682 | 683 | if not script.get('Body') and _body: 684 | script.set('Body', _body) 685 | 686 | if not script.get('IncludeImage') and _include_image: 687 | script.set('IncludeImage', _include_image) 688 | 689 | if _theme: 690 | script.set('Theme', _theme) 691 | 692 | if _ntype: 693 | script.set('NotificationType', _ntype) 694 | 695 | if not script.script_mode and not script.get('Servers'): 696 | # Provide some CLI help when VideoPaths has been 697 | # detected as not being identified 698 | parser.print_help() 699 | exit(1) 700 | 701 | # Attach Apprise logging to output by connecting to its namespace 702 | logging.getLogger('apprise').\ 703 | addHandler(script.logger.handlers[0]) 704 | logging.getLogger('apprise').\ 705 | setLevel(script.logger.getEffectiveLevel()) 706 | 707 | # call run() and exit() using it's returned value 708 | exit(script.run()) 709 | -------------------------------------------------------------------------------- /Notify/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/__init__.py -------------------------------------------------------------------------------- /Notify/apprise-theme/general/apprise-failure-128x128.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/general/apprise-failure-128x128.ico -------------------------------------------------------------------------------- /Notify/apprise-theme/general/apprise-failure-128x128.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/general/apprise-failure-128x128.png -------------------------------------------------------------------------------- /Notify/apprise-theme/general/apprise-failure-256x256.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/general/apprise-failure-256x256.png -------------------------------------------------------------------------------- /Notify/apprise-theme/general/apprise-failure-32x32.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/general/apprise-failure-32x32.png -------------------------------------------------------------------------------- /Notify/apprise-theme/general/apprise-failure-72x72.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/general/apprise-failure-72x72.png -------------------------------------------------------------------------------- /Notify/apprise-theme/general/apprise-info-128x128.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/general/apprise-info-128x128.ico -------------------------------------------------------------------------------- /Notify/apprise-theme/general/apprise-info-128x128.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/general/apprise-info-128x128.png -------------------------------------------------------------------------------- /Notify/apprise-theme/general/apprise-info-256x256.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/general/apprise-info-256x256.png -------------------------------------------------------------------------------- /Notify/apprise-theme/general/apprise-info-32x32.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/general/apprise-info-32x32.png -------------------------------------------------------------------------------- /Notify/apprise-theme/general/apprise-info-72x72.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/general/apprise-info-72x72.png -------------------------------------------------------------------------------- /Notify/apprise-theme/general/apprise-success-128x128.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/general/apprise-success-128x128.ico -------------------------------------------------------------------------------- /Notify/apprise-theme/general/apprise-success-128x128.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/general/apprise-success-128x128.png -------------------------------------------------------------------------------- /Notify/apprise-theme/general/apprise-success-256x256.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/general/apprise-success-256x256.png -------------------------------------------------------------------------------- /Notify/apprise-theme/general/apprise-success-32x32.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/general/apprise-success-32x32.png -------------------------------------------------------------------------------- /Notify/apprise-theme/general/apprise-success-72x72.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/general/apprise-success-72x72.png -------------------------------------------------------------------------------- /Notify/apprise-theme/general/apprise-warning-128x128.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/general/apprise-warning-128x128.ico -------------------------------------------------------------------------------- /Notify/apprise-theme/general/apprise-warning-128x128.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/general/apprise-warning-128x128.png -------------------------------------------------------------------------------- /Notify/apprise-theme/general/apprise-warning-256x256.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/general/apprise-warning-256x256.png -------------------------------------------------------------------------------- /Notify/apprise-theme/general/apprise-warning-32x32.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/general/apprise-warning-32x32.png -------------------------------------------------------------------------------- /Notify/apprise-theme/general/apprise-warning-72x72.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/general/apprise-warning-72x72.png -------------------------------------------------------------------------------- /Notify/apprise-theme/sabnzbd/apprise-failure-128x128.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/sabnzbd/apprise-failure-128x128.ico -------------------------------------------------------------------------------- /Notify/apprise-theme/sabnzbd/apprise-failure-128x128.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/sabnzbd/apprise-failure-128x128.png -------------------------------------------------------------------------------- /Notify/apprise-theme/sabnzbd/apprise-failure-256x256.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/sabnzbd/apprise-failure-256x256.png -------------------------------------------------------------------------------- /Notify/apprise-theme/sabnzbd/apprise-failure-32x32.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/sabnzbd/apprise-failure-32x32.png -------------------------------------------------------------------------------- /Notify/apprise-theme/sabnzbd/apprise-failure-72x72.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/sabnzbd/apprise-failure-72x72.png -------------------------------------------------------------------------------- /Notify/apprise-theme/sabnzbd/apprise-info-128x128.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/sabnzbd/apprise-info-128x128.ico -------------------------------------------------------------------------------- /Notify/apprise-theme/sabnzbd/apprise-info-128x128.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/sabnzbd/apprise-info-128x128.png -------------------------------------------------------------------------------- /Notify/apprise-theme/sabnzbd/apprise-info-256x256.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/sabnzbd/apprise-info-256x256.png -------------------------------------------------------------------------------- /Notify/apprise-theme/sabnzbd/apprise-info-32x32.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/sabnzbd/apprise-info-32x32.png -------------------------------------------------------------------------------- /Notify/apprise-theme/sabnzbd/apprise-info-72x72.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/sabnzbd/apprise-info-72x72.png -------------------------------------------------------------------------------- /Notify/apprise-theme/sabnzbd/apprise-success-128x128.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/sabnzbd/apprise-success-128x128.ico -------------------------------------------------------------------------------- /Notify/apprise-theme/sabnzbd/apprise-success-128x128.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/sabnzbd/apprise-success-128x128.png -------------------------------------------------------------------------------- /Notify/apprise-theme/sabnzbd/apprise-success-256x256.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/sabnzbd/apprise-success-256x256.png -------------------------------------------------------------------------------- /Notify/apprise-theme/sabnzbd/apprise-success-32x32.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/sabnzbd/apprise-success-32x32.png -------------------------------------------------------------------------------- /Notify/apprise-theme/sabnzbd/apprise-success-72x72.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/sabnzbd/apprise-success-72x72.png -------------------------------------------------------------------------------- /Notify/apprise-theme/sabnzbd/apprise-warning-128x128.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/sabnzbd/apprise-warning-128x128.ico -------------------------------------------------------------------------------- /Notify/apprise-theme/sabnzbd/apprise-warning-128x128.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/sabnzbd/apprise-warning-128x128.png -------------------------------------------------------------------------------- /Notify/apprise-theme/sabnzbd/apprise-warning-256x256.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/sabnzbd/apprise-warning-256x256.png -------------------------------------------------------------------------------- /Notify/apprise-theme/sabnzbd/apprise-warning-32x32.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/sabnzbd/apprise-warning-32x32.png -------------------------------------------------------------------------------- /Notify/apprise-theme/sabnzbd/apprise-warning-72x72.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/caronc/nzb-notify/afc4375ccbb8b891a7dceebab5eca40c83cba19c/Notify/apprise-theme/sabnzbd/apprise-warning-72x72.png -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## Notify Processing Script 2 | 3 | [![Paypal](https://repo.nuxref.com/pub/img/paypaldonate.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=MHANV39UZNQ5E) 4 | 5 | Send notifications to all of the popular notification services (PushBullet, NotifyMyAndroid, XBMC, Email etc) from NZBGet or SABnzbd. 6 | You can chain as many notification services as you want and support most of the advance features each service offers you too. 7 | You can even run the tool from the command line for your own custom use. 8 | 9 | ## Built on Apprise 10 | 11 | This guts of this script have been recently extracted into it's own project called [Apprise](https://github.com/caronc/apprise) which allows others to build Notifications into their applications as well. 12 | Apprise was written in such a way that there wouldn't be a lot of effort to add more notification services either. Feel free to contact me if one you would like to use is missing. 13 | 14 | ## Supported Notifications 15 | 16 | For a complete list of supported notification services and examples on how to build their URLs [click here](https://github.com/caronc/apprise/wiki#notification-services). 17 | 18 | ## Installation and usage instructions 19 | 20 | 1. Ensure you have Python v2.7 or later installed onto your system. 21 | ```bash 22 | # Pull in dependencies: 23 | pip install -r requirements.txt 24 | ``` 25 | 2. Simply place the `Notify.py` and `Notify` directory together. 26 | * __NZBGet users__: you'll want to place these inside of your _nzbget/scripts_ directory. Please ensure you are running _(at least)_ NZBGet v11.0 or higher. You can acquire the latest version of of it from [here](https://nzbget.net/download). 27 | * __NZBGet users__: As one additional note; this script makes use of the RPC feature of NZBGet in order to retrive all of the status information it will notify you with. Its very important that this is configured correctly (in the 'Settings -> Security' area). The out of the box settings should work fine; but worth noting here should experience any issues. 28 | * __SABnzbd users__: You'll point your SABnzbd configuration to reference `sabnzbd-notify.py` via the _Script_ entry and _not_ `Notify.py`. However, please note that the `Notify.py` script is still required (as `sabnzbd-notify.py` is a wrapper to it). You will use the _Parameters_ section to provide the services you wish to notify (see below how they are constructed). 29 | 30 | See the __Command Line__ section below for more instructions on how to call the script from the command line. 31 | 32 | ## SABnzbd Users 33 | SABnzbd users can test that their script is working okay manually as well if they're having issues with it through their application. This is also a great way to test out that you've created the correct URL string. 34 | ```bash 35 | # Send a notification to XBMC (assuming its listening on 36 | # port 8080 at the ip 192.168.0.2 with respect to the example 37 | # below: 38 | python sabnzbd-notify.py complete 'Hello' 'World' xbmc://192.168.0.2 39 | ``` 40 | The syntax is very similar except SABnzbd expects 4 distinct arguments. 41 | 42 | | Arg # | Description | 43 | | ----- |:----------- | 44 | | 1 | The type of notification we are sending. This has an impact on the icon (for those that support it) that you will pass along with the message. 45 | | 2 | The title of the notification message. If this is an empty string, then there is enough information based on the notification type you passed in (argument 1) to generate a title. | 46 | | 3 | The message body. | 47 | | 4 | Comma delimited URL strings just like the ones already discussed above. 48 | 49 | ### SABnzbd Configuration 50 | First, make sure you've placed `sabnzb-notify.py`, `Notify.py`, and the `Notify` directory inside of the `/path/to/SABnzbd/scripts/` directory or the instructions below will not work. 51 | 52 | Once you know the _URL_(s) that work for you, you can set SABnzbd to automatically notify setting it up as follows. From within SABnzbd's web interface: 53 | 54 | - Click on __Settings__ 55 | - Click on __Notifications__ 56 | - Place a checkbox in the __Enable notification script__ option. 57 | - Choose `sabnzb-notify.py` from the Script dropdown menu. 58 | - Specify the URL such as `kodi://192.168.0.2` in the _Parameters_ section. You can specify more then one URL here by simply using a _comma_ (`,`) as a delimiter. 59 | 60 | CentOS/RedHat users can also refer to a [blog entry I prepared](https://nuxref.com/2016/10/20/sabnzbd-installation-centos-7/) for this which includes RPM packaging for both [SABnzbd](https://repo.nuxref.com/centos/7/en/x86_64/custom/repoview/sabnzbd.html) and [NZB-Notify](https://repo.nuxref.com/centos/7/en/x86_64/custom/repoview/sabnzbd-script-notify.html). These can be easily installed (with all required dependencies by just getting yourself set up with my repository [here](https://nuxref.com/nuxref-repository/). 61 | 62 | ## Command Line 63 | 64 | `Notify.py` has a built in command line interface that can be easily tied 65 | to a cron entry or can be easily called from the command line to automate 66 | the fetching of subtitles. 67 | 68 | Here are the switches available to you: 69 | ``` 70 | Usage: Notify.py [options] 71 | 72 | Options: 73 | -h, --help show this help message and exit 74 | -s URL(s), --servers=URL(s) 75 | Specify 1 or more servers in their URL format ie: 76 | growl://mypass@localhost 77 | -t TITLE, --title=TITLE 78 | Specify the title of the notification message. 79 | -b BODY, --body=BODY Specify the body of the notification message. 80 | -i, --include_image Include image in message if the protocol supports it. 81 | -u IMAGE_URL, --image_url=IMAGE_URL 82 | Provide url to image; should be either http://, 83 | https://, or file://. This option implies that 84 | --include_image (-i) is set automatically 85 | -L FILE, --logfile=FILE 86 | Send output to the specified logfile instead of 87 | stdout. 88 | -D, --debug Debug Mode 89 | ``` 90 | 91 | Here is simple example: 92 | ```bash 93 | # Send a notification to XBMC (assuming its listening on 94 | # port 8080 at the ip 192.168.0.2 with respect to the example 95 | # below: 96 | python Notify.py -s xbmc://192.168.0.2 -t "Hello" -b "World!" 97 | 98 | # you can also use it's new name (kodi) to achive the same 99 | # results: 100 | python Notify.py -s kodi://192.168.0.2 -t "Hello" -b "World!" 101 | ``` 102 | 103 | You can also mix and match as many servers as you want by separating 104 | your urls with a comma and/or space. 105 | ```bash 106 | # Send a notification to XBMC and a Growl Server 107 | python Notify.py \ 108 | -s growl://192.168.0.10,xbmc://user:pass@192.168.0.2 \ 109 | -t "Hello" -b "World!" 110 | ``` 111 | 112 | ## Donations 113 | If you like this script and feel like donating, you can do so through either [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=MHANV39UZNQ5E) or [sponsor me](https://github.com/sponsors/caronc)! Thank you so much to everyone who has donated in the past! 114 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | apprise >= 0.7.0 2 | setuptools 3 | pynzbget 4 | chardet 5 | six 6 | -------------------------------------------------------------------------------- /sabnzbd-notify.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- encoding: utf-8 -*- 3 | # 4 | # Notifification wrapper for SABnzbd 5 | # 6 | # Copyright (C) 2014-2022 Chris Caron 7 | # 8 | # This file adds support for SABnzbd v1.1.0 or higher 9 | # 10 | # NZB-Notify is free software: you can redistribute it and/or modify 11 | # it under the terms of the GNU General Public License as published by 12 | # the Free Software Foundation, either version 2 of the License, or 13 | # (at your option) any later version. 14 | # 15 | # NZB-Notify is distributed in the hope that it will be useful, 16 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 17 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 | # GNU General Public License for more details. 19 | # 20 | # You should have received a copy of the GNU General Public License 21 | # along with NZB-Notify. If not, see . 22 | import subprocess 23 | import sys 24 | import os 25 | 26 | try: 27 | from signal import SIGKILL 28 | 29 | except ImportError: 30 | # Windows 10 with 2.7.10 gave this error to a user for some reason 31 | # hopefully this will handle this situation 32 | SIGKILL = 9 33 | 34 | from os import getpid 35 | from os import kill 36 | from os.path import abspath 37 | from os.path import dirname 38 | from os.path import join 39 | 40 | from time import sleep 41 | from datetime import datetime 42 | from datetime import timedelta 43 | 44 | import logging 45 | import logging.handlers 46 | 47 | # Logging Support 48 | logger = logging.getLogger("sabnzbd-notify - %s" % getpid()) 49 | logging.raiseExceptions = 0 50 | logger.setLevel(logging.INFO) 51 | h1 = logging.StreamHandler(sys.stdout) 52 | h1.setFormatter(logging. \ 53 | Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")) 54 | logger.addHandler(h1) 55 | 56 | # Path to notify script 57 | NOTIFY_SCRIPT = join(abspath(dirname(__file__)), 'Notify.py') 58 | 59 | # Just some timeout value 60 | NOTIFY_MAX_WAIT_TIME_SEC = 300 61 | 62 | # This will be what I'll need you users to toggle if you thing you've 63 | # found a bug you need me to solve. Send your logs to lead2gold@gmail.com 64 | # or i'll really have no idea what's going on. 65 | DEBUG_MODE = False 66 | 67 | # A mapping of possible notifications to their respected image. This 68 | # is only referenced by notifications that support this feature. 69 | SABNZBD_NOTIFICATION_MAP = { 70 | # Startup/Shutdown 71 | 'startup': ( 72 | 'Startup/Shutdown', 73 | 'info', 74 | ), 75 | # Pause/Resume 76 | 'pause_resume': ( 77 | 'Pause/Resume', 78 | 'info', 79 | ), 80 | # Added NZB 81 | 'download': ( 82 | 'Added NZB', 83 | 'info', 84 | ), 85 | # Post-processing started 86 | 'pp': ( 87 | 'Post-Processing Started', 88 | 'info', 89 | ), 90 | # Job finished 91 | 'complete': ( 92 | 'Job Finished', 93 | 'success', 94 | ), 95 | # Job failed 96 | 'failed': ( 97 | 'Job Failed', 98 | 'failure', 99 | ), 100 | # Warning 101 | 'warning': ( 102 | 'Warning', 103 | 'warning', 104 | ), 105 | # Error 106 | 'error': ( 107 | 'Error', 108 | 'failure', 109 | ), 110 | # Disk full 111 | 'disk_full': ( 112 | 'Disk Full', 113 | 'warning', 114 | ), 115 | # Queue finished 116 | 'queue_done': ( 117 | 'Queue Finished', 118 | 'info', 119 | ), 120 | # User logged in 121 | 'new_login': ( 122 | 'User Logged In', 123 | 'info', 124 | ), 125 | # Other Messages 126 | 'other': ( 127 | 'Other Messages', 128 | 'info', 129 | ), 130 | } 131 | 132 | def syntax(): 133 | """ 134 | A simple script to print the syntax to the end user 135 | """ 136 | return 'Syntax: sabnzbd-notify.py <Message> '+\ 137 | 'url1[,url2[,urlN]]' +\ 138 | os.linesep + '* The <Type> can be one of the following:' +\ 139 | os.linesep + os.linesep.join(['\t%s: %s' % (k, v[0]) \ 140 | for (k,v) in SABNZBD_NOTIFICATION_MAP.items()]) +\ 141 | os.linesep + "* The <Title> and <Message> are self explanitory. "+\ 142 | "If the <Title> is however left" + os.linesep +"\tblank, then the "+\ 143 | "description of the <Type> is used instead." + os.linesep +\ 144 | "* All remaining arguments are treated as URLs. You can also " +\ 145 | "delimit multiple" + os.linesep + "\tURLs in a single " +\ 146 | "string/argument with the use of a comma (,)." + os.linesep +\ 147 | "\tURLs can also be provided as the SAB_NOTIFICATION_PARAMETERS " +\ 148 | "environment variable." 149 | 150 | 151 | def notify(ntype, title, body, urls, debug=None): 152 | """ 153 | A callable function so SABnzbd can import this file and just 154 | call the notifications through here if they wish. 155 | """ 156 | if debug is None: 157 | debug = DEBUG_MODE 158 | 159 | # We use the Python interpreter that was also used by 160 | # SABnzbd when it executed this script 161 | cmd = [ 162 | sys.executable if sys.executable else "python", 163 | NOTIFY_SCRIPT, 164 | '-t', title, 165 | '-b', body, 166 | '-T', 'sabnzbd', 167 | '-n', SABNZBD_NOTIFICATION_MAP[ntype][1], 168 | '-s', urls, 169 | ] 170 | 171 | if debug: 172 | # Debug Mode Enabled 173 | cmd.append('-D') 174 | 175 | # Execute our Process 176 | p1 = subprocess.Popen(cmd) 177 | 178 | ## Calculate Wait Time 179 | max_wait_time = datetime.utcnow() + \ 180 | timedelta(seconds=NOTIFY_MAX_WAIT_TIME_SEC) 181 | 182 | while p1.poll() == None: 183 | if datetime.utcnow() >= max_wait_time: 184 | logger.error("Process aborted (took too long)") 185 | try: 186 | kill(p1.pid, SIGKILL) 187 | except: 188 | pass 189 | ## CPU Throttle 190 | sleep(0.8) 191 | 192 | if p1.poll() == None: 193 | ## Safety 194 | try: 195 | kill(p1.pid, SIGKILL) 196 | except: 197 | pass 198 | 199 | ## Ensure execution leaves memory 200 | p1.wait() 201 | 202 | if p1.returncode not in (0, 93): 203 | # 93 is a return value recognized by NZBGet as 'good' 204 | # all systems okay; we want to translate this back to 205 | # standard shell scripting responses if we get anything 206 | # outside of what is identified above 207 | return False 208 | return True 209 | 210 | if __name__ == "__main__": 211 | # Simple parsing of the command line and env variable 212 | notify_urls_string = os.environ.get("SAB_NOTIFICATION_PARAMETERS", None) 213 | if len(sys.argv) <= 3 and not notify_urls_string: 214 | logger.error('Not enough arguments specified.') 215 | print(syntax()) 216 | exit(1) 217 | 218 | # Make sure our Notify.py script is available to us 219 | if not (os.path.isfile(NOTIFY_SCRIPT) and \ 220 | os.access(NOTIFY_SCRIPT, os.X_OK)): 221 | logger.error('The engine %s was not found!' % NOTIFY_SCRIPT) 222 | exit(1) 223 | 224 | # Parse our arguments to make sure they're valid 225 | notify_type = sys.argv[1].strip().lower() 226 | if notify_type not in SABNZBD_NOTIFICATION_MAP.keys(): 227 | logger.error('Invalid <Type> specified (argument 1)') 228 | print(syntax()) 229 | exit(1) 230 | 231 | # Take on specified title 232 | notify_title = sys.argv[2].strip() 233 | if not notify_title: 234 | notify_title = SABNZBD_NOTIFICATION_MAP[notify_type][0] 235 | 236 | # Store body (empty or not) 237 | notify_body = sys.argv[3].strip() 238 | 239 | # Environment variable takes precedence over the command line parameter 240 | # The URLs are complex and very depending on what we're notifying 241 | # so we'll let Notify.py take care of them at this point. 242 | if notify_urls_string: 243 | notify_urls = notify_urls_string.split() 244 | else: 245 | notify_urls = sys.argv[4:] 246 | notify_urls = ','.join([v.strip() for v in notify_urls]) 247 | 248 | # Perform Notification 249 | exit(int(not notify( 250 | ntype=notify_type, 251 | title=notify_title, 252 | body=notify_body, 253 | urls=notify_urls, 254 | ))) 255 | --------------------------------------------------------------------------------