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',
  "Christmas2011","EndOfYearHolidays"
); );
   
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'; // christmas special cases
case 6: $ymd = date('Ymd', $date);
return 'saturday'; $dow = date('w', $date);
default: if ($ymd == "20111225") {
return 'weekday'; return "Christmas2011";
} } if ($ymd == "20111228" || $ymd == "20111229" || $ymd == "20111230") {
} return "EndOfYearHolidays";
function midnight_seconds($time = "") } else if (intval($ymd) < "20120203" && $dow != 0 && $dow != 6) {
{ return "Weekday-SchoolVacation";
// from http://www.perturb.org/display/Perlfunc__Seconds_Since_Midnight.html } else {
if ($time != "") { switch ($dow) {
return (date("G", $time) * 3600) + (date("i", $time) * 60) + date("s", $time); case 0:
} return 'sunday';
if (isset($_SESSION['time'])) { case 6:
$time = strtotime($_SESSION['time']); return 'saturday';
return (date("G", $time) * 3600) + (date("i", $time) * 60) + date("s", $time); default:
} return 'weekday';
return (date("G") * 3600) + (date("i") * 60) + date("s"); }
} }
function midnight_seconds_to_time($seconds) }
{  
if ($seconds > 0) { function service_ids($service_period) {
$midnight = mktime(0, 0, 0, date("n") , date("j") , date("Y")); switch ($service_period) {
return date("h:ia", $midnight + $seconds); case 'sunday':
} return Array("Sunday", "Sunday");
else { case 'saturday':
return ""; return Array("Saturday", "Saturday");
} case "Christmas2011":
} return Array("Christmas2011", "Christmas2011");
  case "EndOfYearHolidays":
$serviceAlertCause = Array( return Array("Weekday-EndOfYearHolidays", "Weekday-EndOfYearHolidays");
UNKNOWN_CAUSE case "Weekday-SchoolVacation":
OTHER_CAUSE return Array("Weekday", "Weekday-SchoolVacation");
TECHNICAL_PROBLEM default:
STRIKE //return 'weekday';
DEMONSTRATION return Array("Weekday", "Weekday");
ACCIDENT }
HOLIDAY }
WEATHER  
MAINTENANCE function valid_service_ids() {
CONSTRUCTION return array_merge(service_ids(""), service_ids('saturday'), service_ids('sunday'),
POLICE_ACTIVITY Array("Christmas2011","Weekday-EndOfYearHolidays","Weekday-SchoolVacation"));
MEDICAL_EMERGENCY }
   
Unknown cause function midnight_seconds($time = "") {
Other cause (not represented by any of these options) // from http://www.perturb.org/display/Perlfunc__Seconds_Since_Midnight.html
Technical problem if ($time != "") {
Strike return (date("G", $time) * 3600) + (date("i", $time) * 60) + date("s", $time);
Demonstration }
Accident if (isset($_SESSION['time'])) {
Holiday $time = strtotime($_SESSION['time']);
Weather return (date("G", $time) * 3600) + (date("i", $time) * 60) + date("s", $time);
Maintenance }
Construction return (date("G") * 3600) + (date("i") * 60) + date("s");
Police activity }
Medical emergency  
); function midnight_seconds_to_time($seconds) {
$serviceAlertEffect = Array( if ($seconds > 0) {
NO_SERVICE $midnight = mktime(0, 0, 0, date("n"), date("j"), date("Y"));
REDUCED_SERVICE return date("h:ia", $midnight + $seconds);
SIGNIFICANT_DELAYS } else {
DETOUR return "";
ADDITIONAL_SERVICE }
MODIFIED_SERVICE }
OTHER_EFFECT  
UNKNOWN_EFFECT if ($GTFSREnabled) {
STOP_MOVED $serviceAlertCause = Array(
  "UNKNOWN_CAUSE" => "Unknown cause",
No service "OTHER_CAUSE" => "Other cause",
Reduced service "TECHNICAL_PROBLEM" => "Technical problem",
Significant delays (insignificant delays should only be provided through Trip updates). "STRIKE" => "Strike",
Detour "DEMONSTRATION" => "Demonstration",
Additional service "ACCIDENT" => "Accident",
Modified service "HOLIDAY" => "Holiday",
Stop moved "WEATHER" => "Weather",
Other effect (not represented by any of these options) "MAINTENANCE" => "Maintenance",
Unknown effect); "CONSTRUCTION" => "Construction",
  "POLICE_ACTIVITY" => "Police activity",
function getServiceAlerts($filter_class, $filter_id) { "MEDICAL_EMERGENCY" => "Medical emergency"
/* );
  $serviceAlertEffect = Array(
also need last modified epoch of client gtfs "NO_SERVICE" => "No service",
  "REDUCED_SERVICE" => "Reduced service",
- add,remove,patch,inform (null) "SIGNIFICANT_DELAYS" => "Significant delays",
- stop "DETOUR" => "Detour",
- trip "ADDITIONAL_SERVICE" => "Additional service",
- network "MODIFIED_SERVICE" => "Modified service",
  "OTHER_EFFECT" => "Other effect",
  "UNKNOWN_EFFECT" => "Unknown effect",
  "STOP_MOVED" => "Stop moved");
   
  set_include_path(get_include_path() . PATH_SEPARATOR . ($basePath . "lib/Protobuf-PHP/library/DrSlump/"));
   
  include_once("Protobuf.php");
  include_once("Protobuf/Message.php");
  include_once("Protobuf/Registry.php");
  include_once("Protobuf/Descriptor.php");
  include_once("Protobuf/Field.php");
   
  include_once($basePath . "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(); $fm = new transit_realtime\FeedMessage();
$return['header']['gtfs_realtime_version'] = "1"; $fh = new transit_realtime\FeedHeader();
$return['header']['timestamp'] = time(); $fh->setGtfsRealtimeVersion(1);
$return['header']['incrementality'] = "FULL_DATASET"; $fh->setTimestamp(time());
$return['entities'] = Array(); $fm->setHeader($fh);
foreach(getCurrentAlerts() as $alert) { foreach (getCurrentAlerts() as $alert) {
$informedEntities = getInformedAlerts($alert['id'],$_REQUEST['filter_class'],$_REQUEST['filter_id']); $fe = new transit_realtime\FeedEntity();
if (sizeof($informedEntities) >0) { $fe->setId($alert['id']);
$entity = Array(); $fe->setIsDeleted(false);
$entity['id'] = $alert['id']; $alert = new transit_realtime\Alert();
$entity['alert']['active_period']['start'] = $alert['start']; $tr = new transit_realtime\TimeRange();
$entity['alert']['active_period']['end'] = $alert['end']; $tr->setStart($alert['start']);
$entity['alert']['url']['translation']['text'] = $alert['url']; $tr->setEnd($alert['end']);
$entity['alert']['url']['translation']['language'] = 'en'; $alert->addActivePeriod($tr);
$entity['alert']['header_text']['translation']['text'] = $alert['header']; $informedEntities = getInformedAlerts($alert['id'], $_REQUEST['filter_class'], $_REQUEST['filter_id']);
$entity['alert']['header_text']['translation']['language'] = 'en'; if (sizeof($informedEntities) > 0) {
$entity['alert']['description_text']['translation']['text'] = $alert['description']; $informed = Array();
$entity['alert']['description_text']['translation']['language'] = 'en'; $es = new transit_realtime\EntitySelector();
  if ($informedEntity['informed_class'] == "agency") {
foreach ($informedEntities as $informedEntity) { $es->setAgencyId($informedEntity['informed_id']);
$informed = Array(); }
$informed[$informedEntity['informed_class']."_id"] = $informedEntity['informed_id']; if ($informedEntity['informed_class'] == "stop") {
if ($informedEntity['informed_action'] != "") $informed["x-action"] = $informedEntity['informed_action']; $es->setStopId($informedEntity['informed_id']);
$informed[$informedEntity['class']."_type"] = $informedEntity['type']; }
$entity['informed'][] = $informed; if ($informedEntity['informed_class'] == "route") {
} $es->setRouteId($informedEntity['informed_id']);
$return['entities'][] = $entity; }
} if ($informedEntity['informed_class'] == "trip") {
} $td = new transit_realtime\TripDescriptor();
return $return; $td->setTripId($informedEntity['informed_id']);
} $es->setTrip($td);
function getServiceAlertsByClass() { }
$return = Array(); $alert->addInformedEntity($es);
$alerts = getServiceAlerts("",""); }
foreach ($alerts['entities'] as $entity) { $alert->setCause(constant("transit_realtime\Alert\Cause::" . $alert['cause']));
foreach ($entity['informed'] as $informed) { $alert->setEffect(constant("transit_realtime\Alert\Effect::" . $alert['effect']));
foreach($informed as $key => $value){ $tsUrl = new transit_realtime\TranslatedString();
if (strpos("_id",$key) > 0) { $tUrl = new transit_realtime\TranslatedString\Translation();
$parts = explode($key); $tUrl->setText($alert['url']);
$class = $parts[0]; $tUrl->setLanguage("en");
$id = $value; $tsUrl->addTranslation($tUrl);
} $alert->setUrl($tsUrl);
} $tsHeaderText = new transit_realtime\TranslatedString();
$return[$class][$id][]['entity'] = $entity; $tHeaderText = new transit_realtime\TranslatedString\Translation();
$return[$class][$id][]['action'] = $informed["x-action"]; $tHeaderText->setText($alert['header']);
} $tHeaderText->setLanguage("en");
} $tsHeaderText->addTranslation($tHeaderText);
  $alert->setHeaderText($tsHeaderText);
  $tsDescriptionText = new transit_realtime\TranslatedString();
  $tDescriptionText = new transit_realtime\TranslatedString\Translation();
  $tDescriptionText->setText($alert['description']);
  $tDescriptionText->setLanguage("en");
  $tsDescriptionText->addTranslation($tDescriptionText);
  $alert->setDescriptionText($tsDescriptionText);
  $fe->setAlert($alert);
  $fm->addEntity($fe);
  }
  return $fm;
  }
   
  function getServiceAlertsAsArray($filter_class = "", $filter_id = "") {
  $codec = new DrSlump\Protobuf\Codec\PhpArray();
  return $codec->encode(getServiceAlerts($filter_class, $filter_id));
  }
   
  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();
  return $codec->encode(getTripUpdates($filter_class, $filter_id));
  }
   
  function getTripUpdatesAsJSON($filter_class = "", $filter_id = "") {
  $codec = new DrSlump\Protobuf\Codec\Json();
  return $codec->encode(getTripUpdates($filter_class, $filter_id));
  }
   
} }
?> ?>