SABnzbd support

[Safihre]

Hi, it's me again!

Would it be possible to maybe also include a script that can be used as SABnzbd post processing script?
https://sabnzbd.org/wiki/scripts/post-processing-scripts
I know ist basically a 1 line script, but it would make it easier for users.
We can then also list this extension on our website.
It worked great for NZB-notify, users love it :)

[mystik1]

Would very much appreciate it if you could make the Subliminal subtitle script built for NZBGet compatible with SABnzbd. Thanks much in advance.

[caronc]

Sure, the only issue i can see is the configuration side of things. Subliminal has many, many, many options. SABnzbd users might have to manage a config file for this to work... i could generate one with default values if one isn't present.

Alternatively, i don't know how far you're planning to go with the development of post-process scripting. Were you considering adding ability to dynamically define configuration entries depending on what the script is (kind of like NZBGet does in within comments at the top)? I noticed SABnzbd (from the wiki link) is also using environment variables now. That's cool! I could almost add you as a supported script type in pynzbget as another supported post processing type.

A meet in the middle approach might be to allow users to enter a key/value pair (and add them per script as environment variables). So for example... Lets say someone defines a 'language' as a key and 'fr,en' as it's value. Well that would generate an environment variable like SAB_CONFIG_SUBLIMINAL_LANGUAGE=fr,en. Where SAB_CONFIG is just fixed, SUBLIMINAL is the capitalized script name and LANGUAGE was the capitalized key that was defined. The value would be set as is.

Anyway... I'm okay with the configuration file approach too. I just wanted to bounce more ideas off of you. What are your thoughts?

[Safihre]

SABnzbd users that use Notification Scripts should not be complete noobs 🤣
Maybe a .cfg or default-settings.py file would be nice, or at the top of the Subliminal-sabnzbd.py script you could have the variables listed where they can change it there? But that would delete their settings in case they update.
So probably a config-file (that's also added to .gitignore, in case they cloned the repo) is the best way to go?

And maybe a rename from nzbget-subliminal to nzb-subliminal so I can list it on the SABnzbd website 😇 (hence the donation 😉).
From Google Analytics I see a number of users clicking to nzb-notify from our wiki page.

---

Completely off topic, but how did you get your donation page to look so nice on PayPal? Ours look 100 years old and I can't find where to change it. Can also email me about that 👍

[caronc]

Thank you so kindly for the donation! 😄 I sent you an email about PayPal.

As per Subliminal, I'll play a bit around with a wrapper this weekend. Renaming the tool won't be a problem.

With regards to the post-processing part of SABnzbd: If i send content straight to stdout, will that get picked up in your logs? Or should i be managing my own log file as well? It will be important to me for debugging issues when/if they should arise with your followers.

[Safihre]

We indeed capture the whole stdout to show in the log.
The last line of the output is shown prominently in the interface History section.

[caronc]

The last push doesn't work yet, I'm getting closer though! Do you know if there an easy way to just re-post process my script from within SABnzbd without having to re-download something each time?

I'm trying to grasp what the environment variables all are and examples of what they might be set to (such as SAB_PP_STATUS). Some answers are on your wiki I realize, but not all. Although, I suppose I could just grep through the SABnzbd code and see for myself...

Anyway, I'll see where I get too tomorrow. 😉

[Safihre]

There's no easy way to execute it, only to download a tiny NZB.

[caronc]

Okay... it's working for me; but it doesn't mean it will necessary work for you 😉.

I'm using the SABnzbd Environment Variables to drive the entire operation. By doing this SABnzbd can literally just point to the same Subliminal.py* that NZBGet does. Just copy the Subliminal directory and Subliminal.py into sabnzbd/scripts/ and you're good to go (assuming you configure SABnzbd to call it too). I really love this approach because i made this possible through my backend framework. I can easily tailor post process scripts i write to work for both NZBGet and SABnzbd with almost no effort at all.

At this time, this feature is in a different branch; so those who want to test it out in your community need to reference this link which pulls from the SABnzbd_support branch.

I added some basic support for a configuration files too; its a bit messy though so I'll probably start tidying/refactoring this up a bit going forward - not sure yet.

For now, Subliminal resorts to the same defaults that NZBGet does (in it's untouched state). But if you want to over-ride anything, just create a Subliminal.ini file and place it in the same directory as the Subliminal.py file (so... sabnzbd/scripts/).

The syntax looks like this:

# this is Subliminal.ini which resides in the same directory as Subliminal.py
[main]
Languages: en, fr, es
ForceEncoding: No
TvCategories: tv, tv2, Series
Addic7edUser: somedude
Addic7edPass: hispassword

# If subtitles of your specified language was already detected in the video
# do you want to ignore this and keep going anyway? Setting this to no
# causes a bit more overhead (because the video needs to be scanned
# to see if it has subtitles already in it), but it can be worth it as it will
# prevent going off and fetching more subs later on.
IgnoreEmbedded: no

# Setting this to yes before creating a ticket would 'really' help me debug
# any strange issues you have.
Debug: no

# The providers you want to explicilty reference.  By default all of them are
# checked... but here you can filter the list if you choose:
Providers: opensubtitles, tvsubtitles, podnapisi, addic7ed, thesubdb

# My version of subliminal is significantly forked/altered from the original one
# so you can also help the filtering and accuracy of your response by telling
# the tool what to use when the nzb is detected to be either a movie or tv show
# by default these are not set (but it's really worth doing!) :)
MovieProviders: opensubtitles, podnapisi, thesubdb
TVShowProviders: tvsubtitles, addic7ed

If you don't define a special directive (e.g. Languages, ForceEncoding, ...) then they're defaults will be used instead. I'll have to take some time and pull all these defaults out for people and document them accordingly They're all defined in the header of Subliminal.py (in comments) for those who are interested. I tried to put some of the main options that people would most likely want to set/over-ride above in my example.

[Safihre]

@mystik1 Is it working for you? Then @caronc can merge it in 👍

[caronc]

@Safihre maybe there is someone else in your community we could ask?

Just on a side note, since this is a post-process script for SABnzbd (only running once after a download): Brand new stuff won't have subs simply because they haven't been created by other communities yet. Therefore this script works best if it's also periodically called against your media library and/or video downloads every so often (through a cron, or windows schedule) too. That way it will pull in the subs when they become available.