Merge lp:~marco-gallotta/ibid/flight into lp:~ibid-core/ibid/old-trunk-1.6

[marcog]

[marcog (marco-gallotta)]

I think the flight plugin is mature enough for some reviews. It's quite possible some gaping bugs are still out there, but it seems to be robust enough.

[Stefano Rivera (stefanor)]

Whoops, conflicts in the diff.

[Stefano Rivera (stefanor)]

+from xml.etree import ElementTree

unused

Query: airport for cape town
Response: Airport code must be 3 or 4 characters
^ You should allow "for" as well as "in"

assume lenght 4
^ comment typo

One way flights?

Query: airports in london
Response: Found the following airports: London (YXU/CYXU), Luton (LTN/EGGW), Gatwick (LGW/EGKK), City (LCY/EGLC), Heathrow (LHR/EGLL), Stansted (STN/EGSS), East London (ELS/FAEL) and Groton New London (GON/KGON)

^ names like "city" are going to be a problem here. Does travelocity have an "all london airports" meta-airport? Most flight search engines I've used do.

Query: cheapest flight from cape town to lhr from 15th to 20th
Response: Departing flight: South African Airways Flight 220 departing 8:10pm from Capetown, South Africa (CPT), arriving 6:55am Sat, Jan 16 at (LHR) (flight time 12hrs 45min, Nonstop) costs $1,421 per person
Response: Returning flight: United Flight 8818 operated by Lufthansa / 9248 operated by Lufthansa departing 5:05pm from London, Great Britain (LHR), arriving 11:20am Thu, Jan 21 at (CPT) (flight time 16hrs 15min, 1 Stop) costs $4,124 per person
Response: Full results: http://travel.travelocity.com/flights/AirSearch.do;jsessionid=37871D566EEB62B4EEA856665138C410.p0263?SEQ=1262869510635072010

^ Don't return 3 responses, do it in one.

Yeah results in local currency would also be awesome, but that can happen in phase 2 :)

review: Needs Fixing

[lp:~marco-gallotta/ibid/flight]

860. By marcog on 2010-01-07

Fix typos; allow "airport *for* cape town

861. By marcog on 2010-01-07

Condense responses into one

862. By marcog on 2010-01-07

Remove unused imports

[marcog (marco-gallotta)]

> +from xml.etree import ElementTree
>
> unused
>
> Query: airport for cape town
> Response: Airport code must be 3 or 4 characters
> ^ You should allow "for" as well as "in"
>
> assume lenght 4
> ^ comment typo

Fixed all the above

> One way flights?

This is going to add more to an already complex query syntax, so I'd prefer to leave this for phase 2.

> Query: airports in london
> Response: Found the following airports: London (YXU/CYXU), Luton (LTN/EGGW),
> Gatwick (LGW/EGKK), City (LCY/EGLC), Heathrow (LHR/EGLL), Stansted (STN/EGSS),
> East London (ELS/FAEL) and Groton New London (GON/KGON)
>
> ^ names like "city" are going to be a problem here. Does travelocity have an
> "all london airports" meta-airport? Most flight search engines I've used do.

I want to grok on how best to handle this. I'm currently considering that if it matches he entire city name or entire airport name, then return that airport only. However, this could cause problems if it matches but isn't the expected result. I'm currently contemplating putting this on hold for phase 2.

Related to this, we should probably find a working method of matching unicode names with ascii queries (like you and I originally attempted).

> Query: cheapest flight from cape town to lhr from 15th to 20th
> Response: Departing flight: South African Airways Flight 220 departing 8:10pm
> from Capetown, South Africa (CPT), arriving 6:55am Sat, Jan 16 at (LHR)
> (flight time 12hrs 45min, Nonstop) costs $1,421 per person
> Response: Returning flight: United Flight 8818 operated
> by Lufthansa / 9248 operated by Lufthansa departing 5:05pm from London, Great
> Britain (LHR), arriving 11:20am Thu, Jan 21 at (CPT) (flight time
> 16hrs 15min, 1 Stop) costs $4,124 per person
> Response: Full results: http://travel.travelocity.com/flights/AirSearch.do;jse
> ssionid=37871D566EEB62B4EEA856665138C410.p0263?SEQ=1262869510635072010
>
> ^ Don't return 3 responses, do it in one.

Done!

> Yeah results in local currency would also be awesome, but that can happen in
> phase 2 :)

Yep, phase 2. Would be nice to use the currency stuff in the lookup plugin.

[lp:~marco-gallotta/ibid/flight]

863. By marcog on 2010-01-07

Make use of etree's findtext and path querying

[Stefano Rivera (stefanor)]

I'd merge the airport and flight features.

Otherwise I'm happy

review: Approve

[lp:~marco-gallotta/ibid/flight]

864. By marcog on 2010-01-08

Merge flight and airport features

865. By marcog on 2010-01-08

Use dict substitutions for responses

[marcog (marco-gallotta)]

> I'd merge the airport and flight features.

Done.

[Michael Gorven (mgorven)]

> + date = parse(date)

parse() will throw a ValueError if the date is invalid -- you should catch
this and return a suitable error.

 review approve

review: Approve

[lp:~marco-gallotta/ibid/flight]

866. By marcog on 2010-01-09

Catch ValueError thrown by parse() when the date is invalid

[marcog (marco-gallotta)]

> > + date = parse(date)
>
> parse() will throw a ValueError if the date is invalid -- you should catch
> this and return a suitable error.

Done

[Jonathan Hitchcock (vhata)]

Line 76:

  query = [unicode(q) for q in query.lower().split(' ') if q]

That can just be:

  query = [unicode(q) for q in query.lower().split()]

(This note brought to you from the Minor Quibbles Now, Proper Reviews Later Dept.)

[Stefano Rivera (stefanor)]

If Vhata is being pedantic, here are some more pedantisms:

> query = [unicode(q) for q in query.lower().split(' ') if q]

There are a few more of those. Also, that probably doesn't need to be unicode()d.

While you are at it, convert all the unicode-touching string to u'string'

> [d for d in etree.getiterator('div') if d.get(u'class') == 'e_content']

that can be etree.findAll('div', attrs={'class': u'e_content'})

> for td in tr.getiterator('td'):
> if td.get(u'class').strip() in ['tfPrice', 'tfPriceOrButton']:

another very similar one

> table = [t for t in etree.getiterator('table') if t.get(u'id') == 'tfGrid'][0]
> trs = [t for t in table.getiterator('tr')]

and again. and 223

> if priority == 'cheapest':

priority.lower()

[lp:~marco-gallotta/ibid/flight]

867. By marcog on 2010-01-12

Make strings unicode in places where they weren't; split(' ') if s -> string.split()

[marcog (marco-gallotta)]

> > query = [unicode(q) for q in query.lower().split(' ') if q]
>
> There are a few more of those. Also, that probably doesn't need to be
> unicode()d.
>
> While you are at it, convert all the unicode-touching string to u'string'

Done

> > [d for d in etree.getiterator('div') if d.get(u'class') == 'e_content']
>
> that can be etree.findAll('div', attrs={'class': u'e_content'})
>
> > for td in tr.getiterator('td'):
> > if td.get(u'class').strip() in ['tfPrice', 'tfPriceOrButton']:
>
> another very similar one
>
> > table = [t for t in etree.getiterator('table') if t.get(u'id') ==
> 'tfGrid'][0]
> > trs = [t for t in table.getiterator('tr')]
>
> and again. and 223

As we discussed, etree doesn't a findall that takes an attrs arg.

> > if priority == 'cheapest':
>
> priority.lower()

Done

[lp:~marco-gallotta/ibid/flight]

868. By marcog on 2010-01-14

Make parsing a little more resiliant

869. By marcog on 2010-01-14

strftime needs an ascii string for pre-2.6

[Jonathan Hitchcock (vhata)]

Please merge trunk's plugin-reorg into this branch, and then merge your plugin into the geography plugin (preserving as much history as you can, please).

review: Needs Fixing

[marcog (marco-gallotta)]

> Please merge trunk's plugin-reorg into this branch, and then merge your plugin
> into the geography plugin (preserving as much history as you can, please).

Merged

[lp:~marco-gallotta/ibid/flight]

870. By marcog on 2010-01-18

Merge trunk and move flight into geography

[Jonathan Hitchcock (vhata)]

review: Approve

=== modified file 'ibid/plugins/geography.py'
--- ibid/plugins/geography.py	2010-01-18 18:38:39 +0000
+++ ibid/plugins/geography.py	2010-01-18 22:43:10 +0000
@@ -1,5 +1,5 @@
 from math import acos, sin, cos, radians
-from urllib import quote
+from urllib import quote, urlencode
 from urlparse import urljoin
 import re
 import logging
@@ -8,11 +8,15 @@
 from os import walk
 from dateutil.parser import parse
 from dateutil.tz import gettz, tzlocal, tzoffset
+import csv
+from sys import maxint
+
+from dateutil.parser import parse
 
 from ibid.plugins import Processor, match
-from ibid.utils import json_webservice, human_join, format_date
+from ibid.utils import json_webservice, human_join, format_date, cacheable_download
 from ibid.utils.html import get_html_parse_tree
-from ibid.config import Option, DictOption
+from ibid.config import Option, DictOption, IntOption
 from ibid.compat import defaultdict
 
 log = logging.getLogger('plugins.geography')
@@ -349,4 +353,298 @@
     def time(self, event, place):
         self.convert(event, None, None, place)
 
+help['flight'] = u'Search for flights on travelocity'
+class Flight:
+    def __init__(self):
+        self.flight, self.depart_time, self.depart_ap, self.arrive_time, \
+                self.arrive_ap, self.duration, self.stops, self.price = \
+                [], None, None, None, None, None, None, None
+
+    def int_price(self):
+        try:
+            return int(self.price[1:])
+        except ValueError:
+            return maxint
+
+    def int_duration(self):
+        hours, minutes = 0, 0
+        match = re.search(r'(\d+)hr', self.duration)
+        if match:
+            hours = int(match.group(1))
+        match = re.search(r'(\d+)min', self.duration)
+        if match:
+            minutes = int(match.group(1))
+        return int(hours)*60 + int(minutes)
+
+MONTH_SHORT = ('Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec')
+MONTH_LONG = ('January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December')
+OTHER_STUFF = ('am', 'pm', 'st', 'nd', 'rd', 'th', 'morning', 'afternoon', 'evening', 'anytime')
+DATE = r'(?:[0-9.:/hT -]|%s)+' % '|'.join(MONTH_SHORT+MONTH_LONG+OTHER_STUFF)
+
+class FlightException(Exception):
+    pass
+
+class FlightSearch(Processor):
+    """airport [in] <name|location|code>
+    [<cheapest|quickest>] flight from <departure> to <destination> from <depart_date> [anytime|morning|afternoon|evening|<time>] to <return_date> [anytime|morning|afternoon|evening|<time>]"""
+
+    feature = 'flight'
+
+    airports_url = u'http://openflights.svn.sourceforge.net/viewvc/openflights/openflights/data/airports.dat'
+    max_results = IntOption('max_results', 'Maximum number of results to list', 5)
+
+    airports = {}
+
+    def read_airport_data(self):
+        # File is listed as ISO 8859-1 (Latin-1) encoded on
+        # http://openflights.org/data.html, but from decoding it appears to
+        # actually be UTF8
+        filename = cacheable_download(self.airports_url, u'flight/airports.dat')
+        reader = csv.reader(open(filename), delimiter=',', quotechar='"')
+        for row in reader:
+            self.airports[int(row[0])] = [unicode(r, u'utf-8') for r in row[1:]]
+
+    def _airport_search(self, query, search_loc = True):
+        if not self.airports:
+            self.read_airport_data()
+        if search_loc:
+            ids = self._airport_search(query, False)
+            if len(ids) == 1:
+                return ids
+            query = [q for q in query.lower().split()]
+        else:
+            query = [query.lower()]
+        ids = []
+        for id, airport in self.airports.items():
+            if search_loc:
+                data = (u' '.join(c.lower() for c in airport[:5])).split()
+            elif len(query[0]) == 3:
+                data = [airport[3].lower()]
+            else: # assume length 4 (won't break if not)
+                data = [airport[4].lower()]
+            if len(filter(lambda q: q in data, query)) == len(query):
+                ids.append(id)
+        return ids
+
+    def repr_airport(self, id):
+        airport = self.airports[id]
+        code = u''
+        if airport[3] or airport[4]:
+            code = u' (%s)' % u'/'.join(filter(lambda c: c, airport[3:5]))
+        return u'%s%s' % (airport[0], code)
+
+    @match(r'^airports?\s+((?:in|for)\s+)?(.+)$')
+    def airport_search(self, event, search_loc, query):
+        search_loc = search_loc is not None
+        if not search_loc and not 3 <= len(query) <= 4:
+            event.addresponse(u'Airport code must be 3 or 4 characters')
+            return
+        ids = self._airport_search(query, search_loc)
+        if len(ids) == 0:
+            event.addresponse(u"Sorry, I don't know that airport")
+        elif len(ids) == 1:
+            id = ids[0]
+            airport = self.airports[id]
+            code = u'unknown code'
+            if airport[3] and airport[4]:
+                code = u'codes %s and %s' % (airport[3], airport[4])
+            elif airport[3]:
+                code = u'code %s' % airport[3]
+            elif airport[4]:
+                code = u'code %s' % airport[4]
+            event.addresponse(u'%(airport)s in %(city)s, %(country)s has %(code)s', {
+                u'airport': airport[0],
+                u'city': airport[1],
+                u'country': airport[2],
+                u'code': code,
+            })
+        else:
+            event.addresponse(u'Found the following airports: %s', human_join(self.repr_airport(id) for id in ids)[:480])
+
+    def _flight_search(self, event, dpt, to, dep_date, ret_date):
+        airport_dpt = self._airport_search(dpt)
+        airport_to = self._airport_search(to)
+        if len(airport_dpt) == 0:
+            event.addresponse(u"Sorry, I don't know the airport you want to leave from")
+            return
+        if len(airport_to) == 0:
+            event.addresponse(u"Sorry, I don't know the airport you want to fly to")
+            return
+        if len(airport_dpt) > 1:
+            event.addresponse(u'The following airports match the departure: %s', human_join(self.repr_airport(id) for id in airport_dpt)[:480])
+            return
+        if len(airport_to) > 1:
+            event.addresponse(u'The following airports match the destination: %s', human_join(self.repr_airport(id) for id in airport_to)[:480])
+            return
+
+        dpt = airport_dpt[0]
+        to = airport_to[0]
+
+        def to_travelocity_date(date):
+            date = date.lower()
+            time = None
+            for period in [u'anytime', u'morning', u'afternoon', u'evening']:
+                if period in date:
+                    time = period.title()
+                    date = date.replace(period, u'')
+                    break
+            try:
+                date = parse(date)
+            except ValueError:
+                raise FlightException(u"Sorry, I can't understand the date %s" % date)
+            if time is None:
+                if date.hour == 0 and date.minute == 0:
+                    time = u'Anytime'
+                else:
+                    time = date.strftime('%I:00')
+                    if time[0] == u'0':
+                        time = time[1:]
+                    if date.hour < 12:
+                        time += u'am'
+                    else:
+                        time += u'pm'
+            date = date.strftime('%m/%d/%Y')
+            return (date, time)
+
+        (dep_date, dep_time) = to_travelocity_date(dep_date)
+        (ret_date, ret_time) = to_travelocity_date(ret_date)
+
+        params = {}
+        params[u'leavingFrom'] = self.airports[dpt][3]
+        params[u'goingTo'] = self.airports[to][3]
+        params[u'leavingDate'] = dep_date
+        params[u'dateLeavingTime'] = dep_time
+        params[u'returningDate'] = ret_date
+        params[u'dateReturningTime'] = ret_time
+        etree = get_html_parse_tree('http://travel.travelocity.com/flights/InitialSearch.do', data=urlencode(params), treetype='etree')
+        while True:
+            script = [script for script in etree.getiterator(u'script')][1]
+            matches = script.text and re.search(r'var finurl = "(.*)"', script.text)
+            if matches:
+                url = u'http://travel.travelocity.com/flights/%s' % matches.group(1)
+                etree = get_html_parse_tree(url, treetype=u'etree')
+            else:
+                break
+
+        # Handle error
+        div = [d for d in etree.getiterator(u'div') if d.get(u'class') == u'e_content']
+        if len(div):
+            error = div[0].find(u'h3').text
+            raise FlightException(error)
+
+        departing_flights = self._parse_travelocity(etree)
+        return_url = None
+        table = [t for t in etree.getiterator(u'table') if t.get(u'id') == u'tfGrid'][0]
+        for tr in table.getiterator(u'tr'):
+            for td in tr.getiterator(u'td'):
+                if td.get(u'class').strip() in [u'tfPrice', u'tfPriceOrButton']:
+                    onclick = td.find(u'div/button').get(u'onclick')
+                    match = re.search(r"location.href='\.\./flights/(.+)'", onclick)
+                    url_page = match.group(1)
+                    match = re.search(r'^(.*?)[^/]*$', url)
+                    url_base = match.group(1)
+                    return_url = url_base + url_page
+
+        etree = get_html_parse_tree(return_url, treetype=u'etree')
+        returning_flights = self._parse_travelocity(etree)
+
+        return (departing_flights, returning_flights, url)
+
+    def _parse_travelocity(self, etree):
+        flights = []
+        table = [t for t in etree.getiterator(u'table') if t.get(u'id') == u'tfGrid'][0]
+        trs = [t for t in table.getiterator(u'tr')]
+        tr_index = 1
+        while tr_index < len(trs):
+            tds = []
+            while True:
+                new_tds = [t for t in trs[tr_index].getiterator(u'td')]
+                tds.extend(new_tds)
+                tr_index += 1
+                if len(filter(lambda t: t.get(u'class').strip() == u'tfAirlineSeatsMR', new_tds)):
+                    break
+            flight = Flight()
+            for td in tds:
+                if td.get(u'class').strip() == u'tfAirline':
+                    anchor = td.find(u'a')
+                    if anchor is not None:
+                        airline = anchor.text.strip()
+                    else:
+                        airline = td.text.split(u'\n')[0].strip()
+                    flight.flight.append(u'%s %s' % (airline, td.findtext(u'div').strip()))
+                if td.get(u'class').strip() == u'tfDepart' and td.text:
+                    flight.depart_time = td.text.split(u'\n')[0].strip()
+                    flight.depart_ap = u'%s %s' % (td.findtext(u'div').strip(),
+                            td.findtext(u'div/span').strip())
+                if td.get(u'class').strip() == u'tfArrive' and td.text:
+                    flight.arrive_time = td.text.split(u'\n')[0].strip()
+                    span = td.find(u'span')
+                    if span is not None and span.get(u'class').strip() == u'tfNextDayDate':
+                        flight.arrive_time = u'%s %s' % (flight.arrive_time, span.text.strip()[2:])
+                        span = [s for s in td.find(u'div').getiterator(u'span')][1]
+                        flight.arrive_ap = u'%s %s' % (td.findtext(u'div').strip(),
+                                span.text.strip())
+                    else:
+                        flight.arrive_ap = u'%s %s' % (td.findtext(u'div').strip(),
+                                td.findtext(u'div/span').strip())
+                if td.get(u'class').strip() == u'tfTime' and td.text:
+                    flight.duration = td.text.strip()
+                    flight.stops = td.findtext(u'span/a').strip()
+                if td.get(u'class').strip() in [u'tfPrice', u'tfPriceOr'] and td.text:
+                    flight.price = td.text.strip()
+            flight.flight = human_join(flight.flight)
+            flights.append(flight)
+
+        return flights
+
+    @match(r'^(?:(cheapest|quickest)\s+)?flights?\s+from\s+(.+)\s+to\s+(.+)\s+from\s+(%s)\s+to\s+(%s)$' % (DATE, DATE))
+    def flight_search(self, event, priority, dpt, to, dep_date, ret_date):
+        try:
+            flights = self._flight_search(event, dpt, to, dep_date, ret_date)
+        except FlightException, e:
+            event.addresponse(unicode(e))
+            return
+        if flights is None:
+            return
+        if len(flights[0]) == 0:
+            event.addresponse(u'No matching departure flights found')
+            return
+        if len(flights[1]) == 0:
+            event.addresponse(u'No matching return flights found')
+            return
+
+        cmp = None
+        if priority is not None:
+            priority = priority.lower()
+        if priority == u'cheapest':
+            cmp = lambda a, b: a.int_price() < b.int_price()
+        elif priority == u'quickest':
+            cmp = lambda a, b: a.int_duration() < b.int_duration()
+        if cmp:
+            # select best flight based on priority
+            for i in xrange(2):
+                flights[i].sort(cmp=cmp)
+                del flights[i][1:]
+        response = []
+        for i, flight_type in zip(xrange(2), [u'Departing', u'Returning']):
+            if len(flights[i]) > 1:
+                response.append(u'%s flights:' % flight_type)
+            for flight in flights[i][:self.max_results]:
+                leading = u''
+                if len(flights[i]) == 1:
+                    leading = u'%s flight: ' % flight_type
+                response.append(u'%(leading)s%(flight)s departing %(depart_time)s from %(depart_airport)s, arriving %(arrive_time)s at %(arrive_airport)s (flight time %(duration)s, %(stops)s) costs %(price)s per person' % {
+                    'leading': leading,
+                    'flight': flight.flight,
+                    'depart_time': flight.depart_time,
+                    'depart_airport': flight.depart_ap,
+                    'arrive_time': flight.arrive_time,
+                    'arrive_airport': flight.arrive_ap,
+                    'duration': flight.duration,
+                    'stops': flight.stops,
+                    'price': flight.price or 'unknown'
+                })
+        response.append(u'Full results: %s' % flights[2])
+        event.addresponse(u'\n'.join(response), conflate=False)
+
 # vi: set et sta sw=4 ts=4:

=== modified file 'ibid/utils/__init__.py'
--- ibid/utils/__init__.py	2010-01-06 23:19:42 +0000
+++ ibid/utils/__init__.py	2010-01-18 22:43:10 +0000
@@ -80,9 +80,14 @@
         req.add_header('User-Agent', 'Ibid/' + (ibid_version() or 'dev'))
 
     if exists:
-        modified = os.path.getmtime(cachefile)
-        modified = time.strftime("%a, %d %b %Y %H:%M:%S GMT", time.gmtime(modified))
-        req.add_header("If-Modified-Since", modified)
+        if os.path.isfile(cachefile + '.etag'):
+            f = file(cachefile + '.etag', 'r')
+            req.add_header("If-None-Match", f.readline().strip())
+            f.close()
+        else:
+            modified = os.path.getmtime(cachefile)
+            modified = time.strftime("%a, %d %b %Y %H:%M:%S GMT", time.gmtime(modified))
+            req.add_header("If-Modified-Since", modified)
 
     try:
         connection = urllib2.urlopen(req)
@@ -106,6 +111,12 @@
             gzipper = GzipFile(fileobj=compressedstream)
             data = gzipper.read()
 
+    etag = connection.headers.get('etag')
+    if etag:
+        f = file(cachefile + '.etag', 'w')
+        f.write(etag + '\n')
+        f.close()
+
     outfile = file(cachefile, 'wb')
     outfile.write(data)
     outfile.close()