SABnzbd: A Web Interface for Managing Newsgroups

#!/usr/bin/env python
# Made by Deimos <xxx@mycompany.com>
# Under GPL2 licence

# Set Sabnzbd URL
sabnzbd_url = 'http://127.0.0.1:8080/sabnzbd'
# Set Sabnzbd API
sabnzbd_api = '2d872eb6257123a9579da906b487e1de'

#############################################################

# Load modules
import argparse
from urllib2 import Request, urlopen, URLError
from lxml import etree
import sys

def Debug(debug_text):
    """Debug function"""
    if debug_mode == True:
        print debug_text

def args():
    """Command line parameters"""
    # Define globla vars
    global sabnzbd_url, sabnzbd_api, debug_mode, mode, keep_history

    # Main informations
    parser = argparse.ArgumentParser(description="Sabnzbd API usage in python")
    subparsers = parser.add_subparsers(title='Available sub-commands', help='Choose a subcommand (-h for help)', description='Set a valid subcommand', dest="subcmd_name")
    # Default args
    parser.add_argument('-u', '--url', action='store', dest='url', type=str, default=sabnzbd_url, help='Set Sabnzbd URL (default : %(default)s)')
    parser.add_argument('-a', '--api', action='store', dest='api', type=str, default=sabnzbd_api, help='Set Sabnzbd API key')
    parser.add_argument('-v', '--version', action='version', version='v0.1 Licence GPLv2', help='Version 0.1')
    parser.add_argument('-d', '--debug', action='store_true', default=False, help='Debug mode')
    # Show XML API
    parser_xa = subparsers.add_parser('xa', help='Show XML Elements from API')
    # Delete history
    parser_dh = subparsers.add_parser('dh', help='Delete old history')
    parser_dh.add_argument('-k', '--keep', action='store', dest='num', type=int, default=150, help='Number of items to keep in history (default : %(default)s)')

    result = parser.parse_args()

    # Set debug to True if requested by command line
    if (result.debug == True):
        debug_mode=True
    else:
        debug_mode=False
    # Send debug informations
    Debug('Command line : ' + str(sys.argv))
    Debug('Command line vars : ' + str(parser.parse_args()))

    # Check defaults options
    if result.url != sabnzbd_url:
        sabnzbd_url = result.url
    elif result.api != sabnzbd_api:
        sabnzbd_api = result.api

    # Managing options
    mode=result.subcmd_name
    if (mode == 'dh'):
        keep_history=result.num

def GetSabUrl(sabnzbd_url, sabnzbd_api):
    """Concat Sabnzbd URL
    Check that the connection to URL is correct and TCP is OK"""
    # Concat
    sab_url = sabnzbd_url + '/api?mode=history&output=xml&apikey=' + sabnzbd_api
    Debug('Concatened Sabnzbd URL : ' + str(sab_url))

    # Connectivity test
    request = Request(sab_url)
    try:
        response = urlopen(request)
    except URLError, e:
        if hasattr(e, 'reason'):
            print 'Can\'t connect to server : ' + str(e.reason)
            sys.exit(1)
        elif hasattr(e, 'code'):
            print 'The server couldn\'t fulfill the request.' + str(e.code)
            sys.exit(1)
    else:
        Debug('Sabnzbd TCP connection OK')
    return sab_url

def GetXmlHistory(sab_url):
    """Get XML nzo_id entries"""
    xml_history =  []
    # Parse XML from given url
    xml_content = etree.parse(sab_url)
    # Select only the wished tag and push it in xml_history list
    for node in xml_content.xpath("///*"):
        if (node.tag == 'nzo_id'):
            # Reencode value to avoid errors
            tag_value = unicode(node.text).encode('utf8')
            #Debug(node.tag + ' : ' + tag_value)
            xml_history.append(tag_value)
    Debug('XML history has ' + str(len(xml_history)) + ' entries')

    # If there were no entry in the list, check if the API failed
    if len(xml_history) == 0:
        Debug('Checking why there is no datas')
        xml_content = etree.parse(sab_url)
        for node in xml_content.xpath("//*"):
            if (node.tag == 'error'):
                print 'Can\'t connect to server : ' + unicode(node.text).encode('utf8')
                sys.exit(1)

    return xml_history

def DeleteHistory(xml_history,keep_history):
    """Delete old history"""
    # Create a new list contaning elements to remove
    elements2delete = []
    element_number=1
    for element in xml_history:
        if element_number > keep_history:
            elements2delete.append(element)
        element_number += 1
    queue_elements2remove=','.join(elements2delete)
    Debug('Elements to delete (' + str(len(xml_history)) + ' - ' + str(keep_history)  + ' = ' + str(len(elements2delete))  + ')')

    # Concat URL with elements to remove and then remove
    sab_url_remove = sabnzbd_url + '/api?mode=history&name=delete&value=' + queue_elements2remove + '&apikey=' + sabnzbd_api
    urlopen(sab_url_remove)

def ShowXMLElements(sab_url):
    """Show XML code from URL"""
    xml_content = etree.parse(sab_url)
    for node in xml_content.xpath("//*"):
        print node.tag + ' : ' + unicode(node.text).encode('utf8')

def main():
    """Main function that launch all of them"""
    # Set args and get debug mode
    args()
    # Get Sabnzbd URL and check connectivity
    sab_url = GetSabUrl(sabnzbd_url, sabnzbd_api)
    # Delete old history
    if mode == 'dh':
        xml_history = GetXmlHistory(sab_url)
        DeleteHistory(xml_history,keep_history)
    elif mode == 'xa':
        ShowXMLElements(sab_url)

if __name__ == "__main__":
    main()