import collections, re, time from datetime import datetime import Utils from suds.client import Client from collections import Counter # Note that this module requires the open *Staff Version* of the Darwin API # You can register for an API key here: http://openldbsv.nationalrail.co.uk/ # We use this instead of the 'regular' version because it offers a *lot* more # information. URL = 'https://lite.realtime.nationalrail.co.uk/OpenLDBSVWS/wsdl.aspx?ver=2016-02-16' class Module(object): _name = "NR" def __init__(self, bot): self.bot = bot bot.events.on("received").on("command").on("nrtrains" ).hook(self.arrivals, min_args=1, help="Get train information for a station (Powered by NRE)", usage="") bot.events.on("received").on("command").on("nrservice" ).hook(self.service, min_args=1, help="Get train service information for a UID, headcode or RID (Powered by NRE)", usage="") bot.events.on("received").on("command").on("nrhead" ).hook(self.head, min_args=1, help="Get information for a given headcode/UID/RID (Powered by NRE)", usage="") def time_compare(self, one, two): return (one.hour - two.hour) * 60 + (one.minute - two.minute) def span(self, gen, std, etd, human=True): expected = std if etd.replace(":", "").isdigit(): expected = etd elif etd != "On time": return etd time_due = datetime.datetime.strptime(expected, "%H:%M") time_until = self.time_compare(time_due.time(), gen.time()) if time_until == 0: human_time = "due" else: human_time = "in %s min" % time_until if human: return human_time else: return time_until def arrivals(self, event): colours = [Utils.COLOR_LIGHTBLUE, Utils.COLOR_GREEN, Utils.COLOR_RED] location_code = event["args_split"][0].upper() token = self.bot.config["nre-api-key"] client = Client(URL) header_token = client.factory.create('ns2:AccessToken') header_token.TokenValue = token client.set_options(soapheaders=header_token) method = client.service.GetDepartureBoardByCRS if len(location_code) == 3 else client.service.GetDepartureBoardByTIPLOC query = method(50, location_code, datetime.now().isoformat().split(".")[0], 240, client.factory.create("filterList"), "to", '', "PBS", False) if not "trainServices" in query: event["stdout"].write("%s (%s): No services for the next 240 minutes" % (query["locationName"], query["crs"])) return trains = [] for t in query["trainServices"][0]: parsed = { "scheduled" : datetime.strptime(t["std"], "%Y-%m-%dT%H:%M:%S"), "called" : "atd" in t, "rid" : t["rid"], "uid" : t["uid"], "head" : t["trainid"], "via": '' if not "via" in t["destination"][0][0] else t["destination"][0][0]["via"], "platform": "?" if not "platform" in t else t["platform"] } parsed["destinations"] = [{"name": a["locationName"], "tiploc": a["tiploc"], "crs": a["crs"] if "crs" in a else '', "code": a["crs"] if "crs" in a else a["tiploc"], "via": a["via"] if "via" in a else ''} for a in t["destination"][0]] parsed["origins"] = [{"name": a["locationName"], "tiploc": a["tiploc"], "crs": a["crs"] if "crs" in a else '', "code": a["crs"] if "crs" in a else a["tiploc"], "via": a["via"] if "via" in a else ''} for a in t["origin"][0]] if "etd" in t or "atd" in t: parsed["departure"] = datetime.strptime(t["etd"] if "etd" in t else t["atd"], "%Y-%m-%dT%H:%M:%S") parsed["time"] = parsed["departure"].strftime("%H%M") elif "isCancelled" in t and t["isCancelled"]: parsed["departure"] = "Cancelled" parsed["time"] = "Cancelled" else: parsed["departure"] = t["departureType"] parsed["time"] = t["departureType"] parsed["on_time"] = parsed["scheduled"] == parsed["departure"] parsed["status"] = 1 if parsed["on_time"] else 2 if parsed["called"]: parsed["status"] = 0 trains.append(parsed) for t in trains: t["dest_summary"] = "/".join(["%s%s" %(a["name"], " " + a["via"] if a["via"] else '') for a in t["destinations"]]) trains = sorted(trains, key=lambda t: t["scheduled"]) trains_filtered = [] train_dest_plat = [] for train in trains: if (train["destinations"], train["platform"]) in train_dest_plat: continue train_dest_plat.append((train["destinations"], train["platform"])) trains_filtered.append(train) trains_string = ", ".join(["%s (%s, %s, %s%s%s)" % (t["dest_summary"], t["uid"], t["platform"], Utils.color(colours[t["status"]]), t["time"], Utils.color(Utils.FONT_RESET) ) for t in trains_filtered]) event["stdout"].write("%s (%s): %s" % (query["locationName"], query["crs"], trains_string)) def service(self, event): colours = [Utils.COLOR_LIGHTBLUE, Utils.COLOR_GREEN, Utils.COLOR_RED, Utils.COLOR_CYAN] service_id = event["args_split"][0] filter = event["args_split"][1] if len(event["args_split"]) > 1 else "" token = self.bot.config["nre-api-key"] client = Client(URL) header_token = client.factory.create('ns2:AccessToken') header_token.TokenValue = token client.set_options(soapheaders=header_token) rid = service_id if len(service_id) <= 8: query = client.service.QueryServices(service_id, datetime.utcnow().date().isoformat(), datetime.utcnow().time().strftime("%H:%M:%S+0000")) if not query: event["stdout"].write("No service information is available for this identifier.") return if len(query["serviceList"][0]) > 1: event["stdout"].write("Identifier refers to multiple services: " + ", ".join(["%s (%s->%s)" % (a["rid"], a["originCrs"], a["destinationCrs"]) for a in query["serviceList"][0]])) return rid = query["serviceList"][0][0]["rid"] query = client.service.GetServiceDetailsByRID(rid) disruptions = [] if "cancelReason" in query: disruptions.append("Cancelled (%s at %s)" % (query["cancelReason"]["value"], query["cancelReason"]["_tiploc"])) if "delayReason" in query: disruptions.append("Delayed (%s at %s)" % (query["delayReason"]["value"], query["delayReason"]["_tiploc"])) if disruptions: disruptions = Utils.color(Utils.COLOR_RED) + ", ".join(disruptions) + Utils.color(Utils.FONT_RESET) + " " else: disruptions = "" stations = [] for station in query["locations"][0]: parsed = {"name": station["locationName"], "crs": (station["crs"] if "crs" in station else station["tiploc"]).rstrip(), "scheduled": datetime.strptime(station["sta"] if "sta" in station else station["std"], "%Y-%m-%dT%H:%M:%S"), "scheduled_type" : "arrival" if "sta" in station else "departure", "scheduled_short": '' if "sta" in station else "d", "called": "atd" in station or "ata" in station, "passing": station["isPass"] if "isPass" in station else False, "prediction": "eta" in station or "etd" in station and not "atd" in station, "first": len(stations) == 0, "last" : False, "cancelled" : station["isCancelled"] if "isCancelled" in station else False } parsed["arrival"] = datetime.strptime(station["eta"] if "eta" in station else station["ata"], "%Y-%m-%dT%H:%M:%S") if "eta" in station or "ata" in station else None parsed["departure"] = datetime.strptime(station["etd"] if "etd" in station else station["atd"], "%Y-%m-%dT%H:%M:%S") if "etd" in station or "atd" in station else None parsed["time"], parsed["timeprefix"] = [a for a in [(parsed["arrival"], ''), (parsed["departure"], "d"), (parsed["scheduled"], parsed["scheduled_short"] + "s")] if a[0] != None][0] parsed["datetime"] = parsed["time"] if parsed["cancelled"]: parsed["time"], parsed["timeprefix"], parsed["prediction"] = ("Cancelled", '', False) else: parsed["time"] = parsed["time"].strftime("%H%M") parsed["on_time"] = parsed["datetime"] == parsed["scheduled"] and not parsed["cancelled"] stations.append(parsed) [a for a in stations if a["called"] or a["first"]][-1]["last"] = True for station in stations[0:[k for k,v in enumerate(stations) if v["last"]][0]]: if not station["first"]: station["called"] = True for station in stations: station["status"] = 1 if station["on_time"] else 2 if station["called"]: station["status"] = 0 if station["passing"]: station["status"] = 3 station["summary"] = "%s%s(%s, %s%s%s%s)" % ( "*" if station["passing"] else '', station["name"] + " " if station["name"] != station["crs"] else '', station["crs"], ("~" if station["prediction"] else '') + station["timeprefix"], Utils.color(colours[station["status"]]), station["time"], Utils.color(Utils.FONT_RESET) ) stations_filtered = [] for station in stations: if station["passing"] and filter != "*": continue if station["called"] and filter != "*": if not station["first"] and not station["last"]: continue stations_filtered.append(station) if station["first"] and not station["last"]: stations_filtered.append({"summary": "(...)"}) done_count = len([s for s in stations if s["called"]]) total_count = len(stations) event["stdout"].write("%s%s train (%s%s%s/%s/%s): %s" % (disruptions, query["operator"], Utils.color(Utils.COLOR_LIGHTBLUE), done_count, Utils.color(Utils.FONT_RESET), len(stations_filtered), total_count, ", ".join([s["summary"] for s in stations_filtered]))) def head(self, event): service_id = event["args_split"][0] token = self.bot.config["nre-api-key"] client = Client(URL) header_token = client.factory.create('ns2:AccessToken') header_token.TokenValue = token client.set_options(soapheaders=header_token) query = client.service.QueryServices(service_id, datetime.utcnow().date().isoformat(), datetime.utcnow().time().strftime("%H:%M:%S+0000")) event["stdout"].write(", ".join(["h/%s r/%s u/%s rs/%s %s (%s) -> %s (%s)" % (a["trainid"], a["rid"], a["uid"], a["rsid"], a["originName"], a["originCrs"], a["destinationName"], a["destinationCrs"]) for a in query["serviceList"][0]]))