coordinates.py

'''
Created on Mar 4, 2011

@author: shirchen
'''
import datetime
import logging
import math
import time
from schedule import schedule_pull
from analyze_data import Output
from gps import mongodb_connector

class Coordinates():
    
    def __init__(self, 
                 a_cur_time, 
                 a_bus_id, 
                 a_float_lat,
                 a_float_lon, 
                 a_dir_tag,
                 a_route,
                 a_speed):
        self.route = a_route
        self.cur_time = a_cur_time
        self.bus_id = a_bus_id
        self.float_lat = a_float_lat
        self.float_lon = a_float_lon
        self.dir_tag = a_dir_tag
        self.speed = a_speed
        
    
    def __str__(self):
        return "route: %s, "\
            "cur_time: %s, "\
            "bus_id: %s, "\
            "lat: %s, "\
            "lon: %s, "\
            "dir_tag: %s, "\
            "speed: %s"\
            % (self.route,
               self.cur_time,
               self.bus_id,
               self.float_lat,
               self.float_lon,
               self.dir_tag,
               self.speed)
        
import Geohash
        
class CheckCoordinate(object):
    
    def __init__(self):
        """
        needs to be pulled
        contains a list of of trip_ids given a geohash of a (lat, lon)
        """
        self.start_point_to_trips = {} #Could hardcode for 22
        """
        needs to be pulled
        contains a hash of trip_id to [departure, arrival]
        """
        self.trip_to_dep_arr_times = {} #Done
        """
        contains a hash of active bus ids to our best guess of their trip ids
        """
        self.active_bus_to_trip_id = {} #Local
        """
        needs to be pulled
        contains a hash of trip_id to its end point
        """
        self.trip_to_end_point = {} #Could hardcode for 22
        """
        set of all active bus_ids
        """
        self.set_active_bus_ids = set() #Local
        """
        Dictionary of starting trip candidates to previous location
            and time when started
        """
        self.cand_bus_id_to_time_gps = {}
        LOG_FILENAME = '/tmp/Muni.out'
        logging.basicConfig(filename=LOG_FILENAME,level=logging.INFO)

    """
    Input: Route_name eg '22'
    Output: Dictionary which maps all of the trips associated with that route 
        to a gps coordinate where the trips end  
    Discussion: This guy is needed so that we when we check if a certain bus_id
        has come to its destination. So, upon receiving a new coordinate object,
        we see if the we have reached the end
    TODO:
        This should live in schedule puller class
    """
    def setup_trips_to_end_points(self):
        for trip_id in self.trip_to_dep_arr_times.keys():
            self.trip_to_end_point[trip_id] = [37.80241, -122.4364]
            
    def setup_start_points_to_trip(self):
        """
        Input: Route_name eg '22'
        Output: Dictionary which maps all of the trips associated with that route 
            to a gps coordinate where the trips start  
        Discussion: 
        TODO:
            This should live in schedule puller class
    
        """
        for trip_id in self.trip_to_dep_arr_times.keys():
            self.start_point_to_trips[trip_id] = Geohash.encode(37.76048,
                                                                 -122.38895)
            pass
#            self.trip_to_end_point[trip_id] = [37.80241, -122.4364]
    
    
    def setup_dicts(self):
        """
        Input:
        Output:
        Discussion:
            Lotsa mysql data pulling, hopefully will be just unpickling of objects
        """
        schd_pull = schedule_pull.Schedule_Pull('22')
        schd_pull.setup_route_info()
        self.trip_to_dep_arr_times = schd_pull.retrieve_pysql_schedule()
    
    
    def deal_with_tracked_bus(self, coord):
        """
        if our bus_id is on the move to the end
        """        
        logging.info('Checking an active coordinate in list of trips: %s'\
        % (str(coord)))
        lat = coord.float_lat
        lon = coord.float_lon
        trip_id = self.active_bus_to_trip_id[coord.bus_id][0]
        print "After getting trip_id"
        # TDOO: how to compare?
        (end_lat, end_lon) = self.trip_to_end_point[trip_id]
        print 'Right before checking if near end'
        ### TODO: relax exact location
#            if end_lat == lat and end_lon == lon:
        if self.check_if_point_is_nearby(lat, lon, end_lat, end_lon):
            print 'Trip ended and adding summary line'
            self.upload_summary_to_mongo(coord)
            self.expire_trip(coord.bus_id)
            logging.info('Finished with coordinate: %s'\
            % (coord))
        else:
            print 'Trip not nearby'
            logging.info('Trip not nearby')
                

    def deal_with_untracked_bus(self, coord):
        """
        First check if we are starting a trip
        """
        if self.check_if_starting_trip(coord):
            """
            Then we look for a trip id associated with it
            """
            trip_id = self.find_trip_id(coord)
            self.add_to_queue(coord, trip_id)
            logging.info('Adding trip %s to queue for coord %s'\
            % (trip_id, str(coord)))
        else:
            logging.info('Not starting a trip for coordinate: %s'\
            % (str(coord)))
    
    
    def check_point(self, coord):
        """
        Input: Coordinates object
        Output: A decision on whether or not the trip ended, then we add a line to 
        summary, 
        or we are starting the trip, then we add bus to list of actives, 
        or do nothing if we are in the middle of a route or at the end of the stop
        Discussion:
        """
        
        if coord.bus_id in self.active_bus_to_trip_id:
            print "=" * 20 + 'active bus'
            logging.info('========== Active bus ==========')
            self.deal_with_tracked_bus(coord)
        else:
            self.deal_with_untracked_bus(coord)
    
    def find_trip_id(self, coord):
        """
        Input: Coordinates object
        Output: Trip_id which best approximates the trip bus is starting 
        Discussion:
            Finds the best match for a trip id, given time
            
            - We look through all active buses, and subtract the trip ids which
                are active from the list of all of them scheduled for the day
            - Then we sort all of the remaining trips by departing time
                (need to make sure that the list is actually sorted by the
                departure times)
            - Then we are going through the entire sorted list
            - Skip those with just one time
            - Get departure and arrival times
            - Convert departure to epoch 
            - Then we pick the first trip that satisfies the following
                * t_i = trip i
                * x_i = scheduled departure time for trip i
                * y = actual departure time
                Then find first i such that y > x_i-120 
        """
#        passive_trips = self.active_bus_to_trip_id.keys()
        passive_trips = self.active_bus_to_trip_id.values() 
        all_trips = self.trip_to_dep_arr_times.keys()
        outstanding_trips = list(set(all_trips).difference(set(passive_trips)))
        # sort these by time, assuming we already took care of 25:00:00
        #     awesomeness earlier
        outstanding_trips = sorted(outstanding_trips,
                key=lambda trip_id: self.trip_to_dep_arr_times[trip_id])
        outstanding_in_epoch = []
        actual_start_time = self.cand_bus_id_to_time_gps[coord.bus_id][0]
        for i, trip_id in enumerate(outstanding_trips):
            trip_times = self.trip_to_dep_arr_times[trip_id]
            if len(trip_times) < 2:
                print trip_times
                continue
#            print trip_times
            (dep, arr) = trip_times
            # Now, we need to convert the schedule time into epoch time today
            # Same ole....
            # Note: we should store this, so not to have to do this every time
#            outstanding_in_epoch.append(self.convert_time(dep))
            schd_dep_epoch = self.convert_time(dep)
            # Using the starting time, because we only know that a trip started
            #    after the fact
            if actual_start_time - 120 < schd_dep_epoch:
                """
                Returning the previous trip, but need to make sure that 
                    previous is a trip with both starting and ending times.
                """
                trip_id = outstanding_trips[i-1]
                return trip_id

#        outstanding_in_epoch.sort()
#        print outstanding_in_epoch
        """
            - Allowing buses leave up to 2 minutes early
        """
#        for i, schd_dep_epoch in enumerate(outstanding_in_epoch):
#            if actual_start_time - 120 < schd_dep_epoch:
#                print "returning: %s" % outstanding_in_epoch[i-1]
#                return outstanding_in_epoch[i-1]
            
        
        logging.info('No trip found for coordinate: %s'\
        % (str(coord)))
    
    def expire_trip(self, bus_id):
        """
        Discussion:
            This function cleans up all expired trip_ids after the next day has 
            started, like keeping at most 12 bus_ids to trip_ids at a time, to
            let us know that a trip_id has already completed.
            Maybe need a separate list of all trip_ids that have already happened
            in the past 12 hours.
        """
        if bus_id in self.active_bus_to_trip_id:
            del self.active_bus_to_trip_id[bus_id]
            return True
        else:
            logging.info('%s not in list of active buses' % (bus_id))
            return False
    
    def add_to_queue(self, coord, trip_id):
        if coord.bus_id in self.set_active_bus_ids:
            return False
        else:
            start_time = self.cand_bus_id_to_time_gps[coord.bus_id][0]
            self.set_active_bus_ids.add(coord.bus_id)
            self.active_bus_to_trip_id[coord.bus_id] = [trip_id, start_time]
            # Clear the candidate dictionary
            del self.cand_bus_id_to_time_gps[coord.bus_id]
            return True
    
    # Helpers
    def convert_time(self, a_time):
        """
        Input: Time in format HH:MM:SS
        Output: That time converted into current time epoch in secs
        """
        time_now = time.time()
        tm_year, tm_mon, tm_mday = self.approx_date(time_now)
        return self.convert_to_epoch_time(a_time, tm_year, tm_mon, tm_mday)
    
    def convert_to_epoch_time(self, a_time, tm_year, tm_mon, tm_mday):
        new_datetime = datetime.datetime(*time.strptime(a_time,
                                                         '%H:%M:%S')[0:5])
        tuple = new_datetime.replace(year=tm_year, 
                                 month=tm_mon, 
                                 day=tm_mday).timetuple()
        epoch = time.mktime(tuple)
        return epoch
    
    def approx_date(self, epoch_secs):
        tme = time.localtime(epoch_secs)
        return tme.tm_year, tme.tm_mon, tme.tm_mday
    
    def check_if_point_is_nearby(self, lat, lon, end_lat, end_lon):
        """
        Checking to see if we are within the square. Maybe we should make this into 
            a circle.
        """
        lat = float(lat)
        lon = float(lon)
        end_lat = float(end_lat)
        end_lon = float(end_lon)
        if end_lat-0.001 < lat < end_lat+0.001\
        and end_lon-0.001 < lon < end_lon+0.001:
#            logging.info('Point with (%d, %d) is near (%d, %d)',
#            (lat, lon, end_lat, end_lon))
            print 'Point is nearby'
            return True
        else:
#            logging.info('Point with (%d, %d) is far away from (%d, %d)',
#            (lat, lon, end_lat, end_lon))
            print 'Point is far away'
            return False
    
    def check_if_starting_trip(self, coord):
        """
        What can we use here? This is kinda fun. We could check to see if the
             bus has a velocity, and it is in a square which we drew.
        
        Then, the quesiton of how to hash the coordinates and pull them out 
            again. For now, we are gonna hack it with hardcoded values for the 
            '22'.
            
        New attempt:
        - create a list of candidates
        - if 
        """
        if coord.bus_id in self.cand_bus_id_to_time_gps:
            start_time, [lat, lon] = self.cand_bus_id_to_time_gps[coord.bus_id]
            if self.distance(lat, lon, coord.float_lat, coord.float_lon) > 0.0005:
                logging.info("Trip for coord %s has already started" % coord)
                return True
            else:
                logging.info("Trip for coord %s is a candidate but not far enough "
                             "from starting point" % coord )
                return False
        else:
            (lat, lon) = (37.76048, -122.38895)
            if lat-0.001 < coord.float_lat < lat+0.001\
             and lon-0.001 < coord.float_lon < lon+0.001:
                self.cand_bus_id_to_time_gps[coord.bus_id] =\
                [time.time(), [coord.float_lat, coord.float_lon]]
                logging.info("Adding coord to a list of candidates: %s"\
                              % (coord))
                return False
            logging.info("Trip not near start")
            return False
        
    def distance(self, lat1, lon1, lat2, lon2):
        return math.sqrt((lat1-lat2)**2+(lon1-lon2)**2)
        
    def upload_summary_to_mongo(self, coord):
        # need to define
        if coord.bus_id in self.active_bus_to_trip_id:
            (trip_id, start_time) = self.active_bus_to_trip_id[coord.bus_id]
        else:
            print 'Error, bus_id not in list of active buses:', coord.bus_id
            raise
        if trip_id in self.trip_to_dep_arr_times:
            times_list = self.trip_to_dep_arr_times[trip_id]
            print times_list
            if len(times_list) > 1:
                (schd_start, schd_end) = times_list
            else:
                print 'ERROR: No ending time found'
                raise
        else:
            print 'Error, trip_id not in list of active buses:', trip_id
            raise
        print 'In upload step 3'
        schd_start = self.convert_time(schd_start)
        schd_end = self.convert_time(schd_end)
        end_time = coord.cur_time
#        end_time = time.time()
        out = Output(coord.route,
                     trip_id,
                     coord.bus_id,
                     start_time,
                     end_time,  #end time is now
                     end_time-schd_end,
                     schd_start,
                     schd_end,
                     start_time-schd_start
                     )
        print str(out)
        try:
            conn = mongodb_connector.connect_to_mongo()
        except:
            print 'Could not establish connection: ', sys.exc_info()[0]
        db = conn.muni
        summary_new = db.summary_new
        summary_new.insert(out.to_mongo())
        logging.info("Adding output %s to db" % str(out))

def tests():
    start_time = time.time()
    end_time = start_time+40*60
    co = CheckCoordinate()
    first_coord = Coordinates(start_time, 5432, 37.76048, -122.38895, "22_IB2", "22", '20.988')
    second_coord = Coordinates(start_time+15*60, 5432, 37.761826,-122.388983, "22_IB2", "22", '20.988')
    last_coord = Coordinates(end_time, 5432, 37.80241, -122.4364, "22_IB2", "22", '10.988')
    print co.distance(37.76048, -122.38895, 37.761826,-122.388983)
#    assert float(co.distance(37.76048, -122.38895, 37.761826,-122.388983)) == float(0.00134640447117) 
    co.setup_dicts()
    co.setup_trips_to_end_points()
    co.check_point(first_coord)
    co.check_point(second_coord)
    co.check_point(last_coord)
    """
    Then throw a point which is almost finished in a few seconds for same
        object
    """
        
if __name__=="__main__":
    tests()