Add php protobuffer support for transition to GTFS-realtime
[busui.git] / include / common-transit.inc.php
blob:a/include/common-transit.inc.php -> blob:b/include/common-transit.inc.php
<?php <?php
   
  /*
  * Copyright 2010,2011 Alexander Sadleir
   
  Licensed under the Apache License, Version 2.0 (the 'License');
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at
   
  http://www.apache.org/licenses/LICENSE-2.0
   
  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an 'AS IS' BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
  */
$service_periods = Array( $service_periods = Array(
'sunday', 'sunday',
'saturday', 'saturday',
'weekday' 'weekday'
); );
   
function service_period($date = "") function service_period($date = '') {
{  
  if (isset($_REQUEST['service_period'])) {
if (isset($_SESSION['service_period'])) return $_SESSION['service_period']; return $_REQUEST['service_period'];
$override = getServiceOverride($date); }
if ($override['service_id']){  
return $override['service_id']; $override = getServiceOverride($date);
} if (isset($override['service_id'])) {
  return strtolower($override['service_id']);
switch (date('w',($date != "" ? $date : time()))) { }
case 0: $date = ($date != '' ? $date : time());
return 'sunday'; $dow = date('w', $date);
case 6:  
return 'saturday'; switch ($dow) {
default: case 0:
return 'weekday'; return 'sunday';
} case 6:
} return 'saturday';
function midnight_seconds($time = "") default:
{ return 'weekday';
// from http://www.perturb.org/display/Perlfunc__Seconds_Since_Midnight.html }
if ($time != "") { }
return (date("G", $time) * 3600) + (date("i", $time) * 60) + date("s", $time);  
} function service_ids($service_period, $date = '') {
if (isset($_SESSION['time'])) { switch ($service_period) {
$time = strtotime($_SESSION['time']); case 'sunday':
return (date("G", $time) * 3600) + (date("i", $time) * 60) + date("s", $time); return Array('Sunday', 'Sunday');
} case 'saturday':
return (date("G") * 3600) + (date("i") * 60) + date("s"); return Array('Saturday', 'Saturday');
} default:
function midnight_seconds_to_time($seconds) $date = ($date != '' ? $date : time());
{ // school holidays
if ($seconds > 0) { $ymd = date('Ymd', $date);
$midnight = mktime(0, 0, 0, date("n") , date("j") , date("Y")); $dow = date('w', $date);
return date("h:ia", $midnight + $seconds); if (intval($ymd) < '20120427' && $dow != 0 && $dow != 6) {
} return Array('Weekday-SchoolVacation', 'Weekday-SchoolVacation');
else { } else {
return ""; return Array('Weekday', 'Weekday');
} }
} }
  }
$serviceAlertCause = Array(  
UNKNOWN_CAUSE function valid_service_ids() {
OTHER_CAUSE return array_merge(service_ids(''), service_ids('saturday'), service_ids('sunday'));
TECHNICAL_PROBLEM }
STRIKE  
DEMONSTRATION function midnight_seconds($time = '') {
ACCIDENT // from http://www.perturb.org/display/Perlfunc__Seconds_Since_Midnight.html
HOLIDAY if ($time != '') {
WEATHER return (date('G', $time) * 3600) + (date('i', $time) * 60) + date('s', $time);
MAINTENANCE }
CONSTRUCTION if (isset($_SESSION['time'])) {
POLICE_ACTIVITY $time = strtotime($_SESSION['time']);
MEDICAL_EMERGENCY return (date('G', $time) * 3600) + (date('i', $time) * 60) + date('s', $time);
  }
Unknown cause return (date('G') * 3600) + (date('i') * 60) + date('s');
Other cause (not represented by any of these options) }
Technical problem  
Strike function midnight_seconds_to_time($seconds) {
Demonstration if ($seconds > 0) {
Accident $midnight = mktime(0, 0, 0, date('n'), date('j'), date('Y'));
Holiday return date('h:ia', $midnight + $seconds);
Weather } else {
Maintenance return '';
Construction }
Police activity }
Medical emergency  
); if ($GTFSREnabled) {
$serviceAlertEffect = Array( $serviceAlertCause = Array(
NO_SERVICE 'UNKNOWN_CAUSE' => 'Unknown cause',
REDUCED_SERVICE 'OTHER_CAUSE' => 'Other cause',
SIGNIFICANT_DELAYS 'TECHNICAL_PROBLEM' => 'Technical problem',
DETOUR 'STRIKE' => 'Strike',
ADDITIONAL_SERVICE 'DEMONSTRATION' => 'Demonstration',
MODIFIED_SERVICE 'ACCIDENT' => 'Accident',
OTHER_EFFECT 'HOLIDAY' => 'Holiday',
UNKNOWN_EFFECT 'WEATHER' => 'Weather',
STOP_MOVED 'MAINTENANCE' => 'Maintenance',
  'CONSTRUCTION' => 'Construction',
No service 'POLICE_ACTIVITY' => 'Police activity',
Reduced service 'MEDICAL_EMERGENCY' => 'Medical emergency'
Significant delays (insignificant delays should only be provided through Trip updates). );
Detour $serviceAlertEffect = Array(
Additional service 'NO_SERVICE' => 'No service',
Modified service 'REDUCED_SERVICE' => 'Reduced service',
Stop moved 'SIGNIFICANT_DELAYS' => 'Significant delays',
Other effect (not represented by any of these options) 'DETOUR' => 'Detour',
Unknown effect); 'ADDITIONAL_SERVICE' => 'Additional service',
  'MODIFIED_SERVICE' => 'Modified service',
function getServiceAlerts($filter_class, $filter_id) { 'OTHER_EFFECT' => 'Other effect',
/* 'UNKNOWN_EFFECT' => 'Unknown effect',
  'STOP_MOVED' => 'Stop moved');
also need last modified epoch of client gtfs  
  set_include_path(get_include_path() . PATH_SEPARATOR . (ROOT. '/../lib/Protobuf-PHP/library/DrSlump/'));
- add,remove,patch,inform (null)  
- stop include_once('Protobuf.php');
- trip include_once('Protobuf/Message.php');
- network include_once('Protobuf/Registry.php');
  include_once('Protobuf/Descriptor.php');
  include_once('Protobuf/Field.php');
   
  include_once(ROOT. '/../lib/Protobuf-PHP/gtfs-realtime.php');
  include_once('Protobuf/CodecInterface.php');
  include_once('Protobuf/Codec/PhpArray.php');
  include_once('Protobuf/Codec/Binary.php');
  include_once('Protobuf/Codec/Binary/Writer.php');
  include_once('Protobuf/Codec/Json.php');
   
  function getServiceAlerts($filter_class = '', $filter_id = '') {
  /*
   
  also need last modified epoch of client gtfs
   
  - add,remove,patch,inform (null)
  - stop
  - trip
  - network
- classes (WHERE=) - classes (WHERE=)
- route (short_name or route_id) - route (short_name or route_id)
- street - street
- stop - stop
- trip - trip
Currently support: Currently support:
network inform network inform
trip patch: stop remove trip patch: stop remove
street inform: route inform, trip inform, stop inform street inform: route inform, trip inform, stop inform
route patch: trip remove route patch: trip remove
*/ */
$return = Array(); $current_alerts = getCurrentAlerts();
$return['header']['gtfs_realtime_version'] = "1"; $informed_count = 0;
$return['header']['timestamp'] = time(); if (sizeof($current_alerts) > 0) {
$return['header']['incrementality'] = "FULL_DATASET";  
$return['entities'] = Array(); $fm = new transit_realtime\FeedMessage();
foreach(getCurrentAlerts() as $alert) { $fh = new transit_realtime\FeedHeader();
$informedEntities = getInformedAlerts($alert['id'],$_REQUEST['filter_class'],$_REQUEST['filter_id']); $fh->setGtfsRealtimeVersion(1);
if (sizeof($informedEntities) >0) { $fh->setTimestamp(time());
$entity = Array(); $fm->setHeader($fh);
$entity['id'] = $alert['id']; foreach ($current_alerts as $current_alert) {
$entity['alert']['active_period']['start'] = $alert['start']; $affectsFilteredEntities = false;
$entity['alert']['active_period']['end'] = $alert['end']; $fe = new transit_realtime\FeedEntity();
$entity['alert']['url']['translation']['text'] = $alert['url']; $fe->setId($current_alert['id']);
$entity['alert']['url']['translation']['language'] = 'en'; $fe->setIsDeleted(false);
$entity['alert']['header_text']['translation']['text'] = $alert['header']; $alert = new transit_realtime\Alert();
$entity['alert']['header_text']['translation']['language'] = 'en'; $tr = new transit_realtime\TimeRange();
$entity['alert']['description_text']['translation']['text'] = $alert['description']; $tr->setStart($current_alert['start']);
$entity['alert']['description_text']['translation']['language'] = 'en'; $tr->setEnd($current_alert['end']);
  $alert->addActivePeriod($tr);
foreach ($informedEntities as $informedEntity) { $informedEntities = getInformedAlerts($current_alert['id'], $filter_class, $filter_id);
$informed = Array(); if (sizeof($informedEntities) > 0) {
$informed[$informedEntity['informed_class']."_id"] = $informedEntity['informed_id'];  
if ($informedEntity['informed_action'] != "") $informed["x-action"] = $informedEntity['informed_action']; $affectsFilteredEntities = true;
$informed[$informedEntity['class']."_type"] = $informedEntity['type']; foreach ($informedEntities as $informedEntity) {
$entity['informed'][] = $informed; $informed_count++;
} $informed = Array();
$return['entities'][] = $entity; $es = new transit_realtime\EntitySelector();
} if ($informedEntity['informed_class'] == 'agency') {
} $es->setAgencyId($informedEntity['informed_id']);
return $return; }
} if ($informedEntity['informed_class'] == 'stop') {
function getServiceAlertsByClass() { $es->setStopId($informedEntity['informed_id']);
$return = Array(); }
$alerts = getServiceAlerts("",""); if ($informedEntity['informed_class'] == 'route') {
foreach ($alerts['entities'] as $entity) { $es->setRouteId($informedEntity['informed_id']);
foreach ($entity['informed'] as $informed) { }
foreach($informed as $key => $value){ if ($informedEntity['informed_class'] == 'trip') {
if (strpos("_id",$key) > 0) { $td = new transit_realtime\TripDescriptor();
$parts = explode($key); $td->setTripId($informedEntity['informed_id']);
$class = $parts[0]; $es->setTrip($td);
$id = $value; }
} $alert->addInformedEntity($es);
} }
$return[$class][$id][]['entity'] = $entity; }
$return[$class][$id][]['action'] = $informed["x-action"]; if ($current_alert['cause'] != '') {
} $alert->setCause(constant('transit_realtime\Alert\Cause::' . $current_alert['cause']));
} }
} if ($current_alert['effect'] != '') {
?> $alert->setEffect(constant('transit_realtime\Alert\Effect::' . $current_alert['effect']));
  }
  if ($current_alert['url'] != '') {
  $tsUrl = new transit_realtime\TranslatedString();
  $tUrl = new transit_realtime\TranslatedString\Translation();
  $tUrl->setText($current_alert['url']);
  $tUrl->setLanguage('en');
  $tsUrl->addTranslation($tUrl);
  $alert->setUrl($tsUrl);
  }
  if ($current_alert['header'] != '') {
  $tsHeaderText = new transit_realtime\TranslatedString();
  $tHeaderText = new transit_realtime\TranslatedString\Translation();
  $tHeaderText->setText($current_alert['header']);
  $tHeaderText->setLanguage('en');
  $tsHeaderText->addTranslation($tHeaderText);
  $alert->setHeaderText($tsHeaderText);
  }
  if ($current_alert['description'] != '') {
  $tsDescriptionText = new transit_realtime\TranslatedString();
  $tDescriptionText = new transit_realtime\TranslatedString\Translation();
  $tDescriptionText->setText(trim($current_alert['description']));
  $tDescriptionText->setLanguage('en');
  $tsDescriptionText->addTranslation($tDescriptionText);
  $alert->setDescriptionText($tsDescriptionText);
  }
  $fe->setAlert($alert);
  if ($affectsFilteredEntities) {
  $fm->addEntity($fe);
  }
  }
  if ($informed_count > 0) {
  return $fm;
  } else {
  return null;
  }
  } else
  return null;
  }
   
  function getServiceAlertsAsArray($filter_class = '', $filter_id = '') {
   
  $alerts = getServiceAlerts($filter_class, $filter_id);
  if ($alerts != null) {
  $codec = new DrSlump\Protobuf\Codec\PhpArray();
   
  return $codec->encode($alerts);
  } else {
  return null;
  }
  }
   
  function getServiceAlertsAsBinary($filter_class = '', $filter_id = '') {
  $codec = new DrSlump\Protobuf\Codec\Binary();
  return $codec->encode(getServiceAlerts($filter_class, $filter_id));
  }
   
  function getServiceAlertsAsJSON($filter_class = '', $filter_id = '') {
  $codec = new DrSlump\Protobuf\Codec\Json();
  return $codec->encode(getServiceAlerts($filter_class, $filter_id));
  }
   
  function getServiceAlertsByClass() {
  $return = Array();
  $alerts = getServiceAlertsAsArray('', '');
  foreach ($alerts['entities'] as $entity) {
  foreach ($entity['informed'] as $informed) {
  foreach ($informed as $key => $value) {
  if (strpos('_id', $key) > 0) {
  $parts = explode($key);
  $class = $parts[0];
  $id = $value;
  }
  }
  $return[$class][$id][] = $entity;
  }
  }
  }
   
  function getTripUpdates($filter_class = '', $filter_id = '') {
  $fm = new transit_realtime\FeedMessage();
  $fh = new transit_realtime\FeedHeader();
  $fh->setGtfsRealtimeVersion(1);
  $fh->setTimestamp(time());
  $fm->setHeader($fh);
  foreach (getCurrentAlerts() as $alert) {
  $informedEntities = getInformedAlerts($alert['id'], $_REQUEST['filter_class'], $_REQUEST['filter_id']);
  $stops = Array();
  $routestrips = Array();
  if (sizeof($informedEntities) > 0) {
  if ($informedEntity['informed_class'] == 'stop' && $informed['x-action'] == 'remove') {
  $stops[] = $informedEntity['informed_id'];
  }
  if (($informedEntity['informed_class'] == 'route' || $informedEntity['informed_class'] == 'trip') && $informed['x-action'] == 'patch') {
  $routestrips[] = Array('id' => $informedEntity['informed_id'],
  'type' => $informedEntity['informed_class']);
  }
  }
  foreach ($routestrips as $routetrip) {
  $fe = new transit_realtime\FeedEntity();
  $fe->setId($alert['id'] . $routetrip['id']);
  $fe->setIsDeleted(false);
  $tu = new transit_realtime\TripUpdate();
  $td = new transit_realtime\TripDescriptor();
  if ($routetrip['type'] == 'route') {
  $td->setRouteId($routetrip['id']);
  } else if ($routetrip['type'] == 'trip') {
  $td->setTripId($routetrip['id']);
  }
  $tu->setTrip($td);
  foreach ($stops as $stop) {
  $stu = new transit_realtime\TripUpdate\StopTimeUpdate();
  $stu->setStopId($stop);
  $stu->setScheduleRelationship(transit_realtime\TripUpdate\StopTimeUpdate\ScheduleRelationship::SKIPPED);
  $tu->addStopTimeUpdate($stu);
  }
  $fe->setTripUpdate($tu);
  $fm->addEntity($fe);
  }
  }
  return $fm;
  }
   
  function getTripUpdatesAsArray($filter_class = '', $filter_id = '') {
  $codec = new DrSlump\Protobuf\Codec\PhpArray();
  return $codec->encode(getTripUpdates($filter_class, $filter_id));
  }
   
  function getTripUpdatesAsBinary($filter_class = '', $filter_id = '') {
  $codec = new DrSlump\Protobuf\Codec\Binary();