#! /usr/bin/python
#
#   rankmirrors : read a list of mirrors from a file and rank them by speed
#
#   Original Idea copyright (c) 2006 R.G. <chesercat>
#   Modified 2006 by Dan McGee <dan@archlinux.org>
#
#   This program is free software; you can redistribute it and/or modify
#   it under the terms of the GNU General Public License as published by
#   the Free Software Foundation; either version 2 of the License, or
#   (at your option) any later version.
#
#   This program is distributed in the hope that it will be useful,
#   but WITHOUT ANY WARRANTY; without even the implied warranty of
#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#   GNU General Public License for more details.
#
#   You should have received a copy of the GNU General Public License
#   along with this program; if not, write to the Free Software
#   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
#   USA.
#
import os, sys, datetime, time, socket, urllib2
from optparse import OptionParser

# TODO: handle KeyboardInterrupt better, print list of already timed
#       servers and then exit. Easier if program is function-ized.

def createOptParser():
    usage = "usage: %prog [options] MIRRORFILE | URL"
    description = "Ranks pacman mirrors by their connection and opening " \
            "speed. Pacman mirror files are located in /etc/pacman.d/. It " \
            "can also rank one mirror if the URL is provided."
    parser = OptionParser(usage = usage, description = description)
    parser.add_option("-n", type = "int", dest = "num", default = 0,
            help = "number of servers to output, 0 for all")
    parser.add_option("-t", "--times", action = "store_true",
            dest = "times", default = False,
            help = "only output mirrors and their response times")
    parser.add_option("-u", "--url", action = "store_true", dest = "url",
             default=False, help="test a specific url")
    parser.add_option("-v", "--verbose", action = "store_true",
            dest = "verbose", default = False, help ="be verbose in output")
    return parser

def timeCmd(cmd):
    before = time.time();
    try:
        cmd();
    except KeyboardInterrupt, ki:
        raise ki
    except socket.timeout, ioe:
        return 'timeout'
    except Exception, e:
        return 'unreachable'
    return time.time() - before;

def talkToServer(serverUrl):
    opener = urllib2.build_opener()
    tmp = opener.open(serverUrl).read()

def getFuncToTime(serverUrl):
    return lambda : talkToServer(serverUrl)

def cmpPairBySecond(p1, p2):
    if p1[1] == p2[1]: return 0
    if p1[1] < p2[1]: return -1
    return 1

if __name__ == "__main__":
    parser = createOptParser()
    (options, args) = parser.parse_args()

    if len(args) != 1:
        parser.print_help(sys.stderr)
        sys.exit(0)

    # allows connections to time out if they take too long
    socket.setdefaulttimeout(10)

    if options.url:
        if options.verbose:
            print 'Testing', args[0] + '...'
        serverToTime = timeCmd(getFuncToTime(args[0]))
        print args[0], ':', serverToTime
        sys.exit(0)

    if not os.path.isfile(args[0]):
        print 'file', args[0], 'does not exist.'
        sys.exit(1)

    fl = open(args[0], 'r')
    serverToTime = {}
    if options.times:
        print 'Querying servers, this may take some time...'
    else:
        print "# Server list generated by rankmirrors on",
        print datetime.date.today()
    for ln in fl.readlines():
        splitted = ln.split('=')
        if splitted[0].strip() != 'Server':
            if not options.times:
                print ln,
            continue

        serverUrl = splitted[1].strip()
        if serverUrl[-1] == '\n': serverUrl = serverUrl[0:-1]
        if options.verbose and options.times:
            print serverUrl,'...',
        elif options.verbose:
            print '#',serverUrl,'...',
        elif options.times:
            print ' * ',
        sys.stdout.flush()
        serverToTime[serverUrl] = timeCmd(getFuncToTime(serverUrl))
        if options.verbose:
            try:
                print "%.2f" % serverToTime[serverUrl]
            except:
                print serverToTime[serverUrl]

    items = serverToTime.items()
    items.sort(cmpPairBySecond)
    numToShow = int(options.num)
    if numToShow == 0: numToShow = len(items)
    if len(items) > 0:
        if options.times:
            print
            print ' Servers sorted by time (seconds):'
            for i in items[0:numToShow]:
                try:
                    print "%.2f" % i[1], ':', i[0]
                except:
                    print i[1], ':', i[0]
        else:
            for i in items[0:numToShow]:
                print 'Server =', i[0]

# vim: set ts=4 sw=4 et: