nzbrefresh

README

NZB Refresh

Proof of concept for a cmd line tool to re-upload articles that are missing from providers with low retention.

The cmd line tool analyses the NZB file specified as positional argument and checks the availability of the individual articles at all Usenet providers listed in the provider.json. If an article is missing from one or more providers, but is still available from at least another provider, the tool will download the article from one of the providers where the article is still available and attempt to re-upload the article using the POST command. It will first try to re-upload the article to one of the providers where the article is not available and, if this is not successful (e.g. due to missing POST capability), it will also try to re-upload the article to one of the other providers. However, the providers already haveing the article might refuse to accept the re-upload of the same article. So for best results, all usenet accounts used for this tool should have POST capability.

The article is re-uploaded completely unchanged (same message ID, same subject), with the exception of the date header, which is updated to the current date. Once the article has been uploaded to one provider, it should then propagate to all other providers.

As a result, the upload should become available again at all providers and be able to be downloaded with the identical / original NZB file that was used for the refresh.

PLEASE NOTE: This is a very early alpha version, intended for initial testing only.

Bug reports are very welcome. Please open an issue for this. If possible, add a link to the NZB file that was used when the error occurred.

Installation

1. Download the executable file for your system from the release page.
2. Extract the archive.
3. Edit the provider.json according to your requirements.

Running the program

Run the program in a cmd line with the following argument:

nzbrefresh [--check] [--provider PROVIDER] [--debug] NZBFILE

Positional arguments:

 NZBFILE                path to the NZB file to be checked (required)

Options:

 --check, -c            only check availability - don't re-upload (optional)
 
 --provider PROVIDER, -p PROVIDER
                        path to the provider JSON config file (optional / default is: './provider.json')
 
 --debug, -d            logs additional output to log file (optional, log file will be named NZBFILENAME.log)

 --csv                  writes statistic about available segements to a csv file (optional, csv file will be named NZBFILENAME.csv)
 
 --help, -h             display this help and exit
 
 --version              display version and exit

provider.json options

"Name": "Provider 1", arbitrary name of the provider, used in the debug text/output

"Host": "", usenet server host name or IP address

"Port": 119, usenet server port number

"SSL": false, if true, secure SSL connections will be used

"SkipSslCheck": true, if true, certificate errors will be ignored

"Username": "", usenet account username

"Password": "", usenet account password

"ConnWaitTime": 10, waiting time until reconnection after connection errors

"MaxConns": 50, maximum number of connections to be used

"IdleTimeout": 30, time after a connection is closed

"HealthCheck": false, if true, will check health of connection before using it (will reduce speed)

"MaxTooManyConnsErrors": 3, maximum number of consecutive "too manny connections error" after which MaxConns is automatically reduced

"MaxConnErrors": 3 maximum number of consecutive fatal connection errors after which the connection with the provider is deemed to have failed

TODOs

• option to set the priority for the providers to be used for re-uploading
• option to use either the STAT, HEAD or BODY command for the check
• option to use the IHAVE command for re-uploading (not implemented with most providers, however)
• folder monitoring with automatic checking
• ...?

This is a Proof of Concept with the minimum necessary features. The TODOs is what I currently plan to implement but there is certainly also a lot of other things left to do.

Version history

alpha 3

• fix for panic errors (should fix all errors in issue #1)
• added --csv switch for csv output of available segements per file per provider
• use STAT instead of HEAD (should improve speed)
• a lot of refactoring

alpha 2

• highly improved version with parallel processing

alpha 1

• first public version

Credits

This software is built using golang (License).

This software uses the following external libraries:

• github.com/alexflint/go-arg (License)
• github.com/alexflint/go-scalar (License)
• github.com/fatih/color (License)
• github.com/mattn/go-colorable (License)
• github.com/mattn/go-isatty (License)
• github.com/nu11ptr/cmpb (License)