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_day ($spid) {
function service_period($date = "") $idParts = explode("-",$spid);
{ return strtolower($idParts[2]);
  }
if (isset($_SESSION['service_period'])) return $_SESSION['service_period']; function service_period($date = "") {
$override = getServiceOverride($date);  
if ($override['service_id']){ if (isset($_REQUEST['service_period']))
return $override['service_id']; return $_REQUEST['service_period'];
} $override = getServiceOverride($date);
  if ($override['service_id']) {
switch (date('w',($date != "" ? $date : time()))) { return service_period_day ($override['service_id']);
case 0: }
return 'sunday';  
case 6: switch (date('w', ($date != "" ? $date : time()))) {
return 'saturday'; case 0:
default: return 'sunday';
return 'weekday'; case 6:
} return 'saturday';
} default:
function midnight_seconds($time = "") return 'weekday';
{ }
// from http://www.perturb.org/display/Perlfunc__Seconds_Since_Midnight.html }
if ($time != "") { function service_ids($service_period) {
return (date("G", $time) * 3600) + (date("i", $time) * 60) + date("s", $time); switch ($service_period) {
} case 'sunday':
if (isset($_SESSION['time'])) { return Array("2010-TUGGSUN-Sunday-20","2010-BELCSUN-Sunday-19");
$time = strtotime($_SESSION['time']); case 'saturday':
return (date("G", $time) * 3600) + (date("i", $time) * 60) + date("s", $time); return Array("2010-BELCSAT-Saturday-19","2010-TUGGSAT-Saturday-19");
} default:
return (date("G") * 3600) + (date("i") * 60) + date("s"); //return 'weekday';
} return Array("2010-BELCMAST-Weekday-15","2010-TUGGMAST-Weekday-14");
function midnight_seconds_to_time($seconds) }
{ }
if ($seconds > 0) { function valid_service_ids() {
$midnight = mktime(0, 0, 0, date("n") , date("j") , date("Y")); return array_merge(service_ids(""),service_ids('saturday'),service_ids('sunday'));
return date("h:ia", $midnight + $seconds); }
}  
else { function midnight_seconds($time = "") {
return ""; // 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);
  }
$serviceAlertCause = Array( if (isset($_SESSION['time'])) {
UNKNOWN_CAUSE $time = strtotime($_SESSION['time']);
OTHER_CAUSE return (date("G", $time) * 3600) + (date("i", $time) * 60) + date("s", $time);
TECHNICAL_PROBLEM }
STRIKE return (date("G") * 3600) + (date("i") * 60) + date("s");
DEMONSTRATION }
ACCIDENT  
HOLIDAY function midnight_seconds_to_time($seconds) {
WEATHER if ($seconds > 0) {
MAINTENANCE $midnight = mktime(0, 0, 0, date("n"), date("j"), date("Y"));
CONSTRUCTION return date("h:ia", $midnight + $seconds);
POLICE_ACTIVITY } else {
MEDICAL_EMERGENCY return "";
  }
Unknown cause }
Other cause (not represented by any of these options)  
Technical problem if ($GTFSREnabled) {
Strike $serviceAlertCause = Array(
Demonstration "UNKNOWN_CAUSE" => "Unknown cause",
Accident "OTHER_CAUSE" => "Other cause",
Holiday "TECHNICAL_PROBLEM" => "Technical problem",
Weather "STRIKE" => "Strike",
Maintenance "DEMONSTRATION" => "Demonstration",
Construction "ACCIDENT" => "Accident",
Police activity "HOLIDAY" => "Holiday",
Medical emergency "WEATHER" => "Weather",
); "MAINTENANCE" => "Maintenance",
$serviceAlertEffect = Array( "CONSTRUCTION" => "Construction",
NO_SERVICE "POLICE_ACTIVITY" => "Police activity",
REDUCED_SERVICE "MEDICAL_EMERGENCY" => "Medical emergency"
SIGNIFICANT_DELAYS );
DETOUR $serviceAlertEffect = Array(
ADDITIONAL_SERVICE "NO_SERVICE" => "No service",
MODIFIED_SERVICE "REDUCED_SERVICE" => "Reduced service",
OTHER_EFFECT "SIGNIFICANT_DELAYS" => "Significant delays",
UNKNOWN_EFFECT "DETOUR" => "Detour",
STOP_MOVED "ADDITIONAL_SERVICE" => "Additional service",
  "MODIFIED_SERVICE" => "Modified service",
No service "OTHER_EFFECT" => "Other effect",
Reduced service "UNKNOWN_EFFECT" => "Unknown effect",
Significant delays (insignificant delays should only be provided through Trip updates). "STOP_MOVED" => "Stop moved");
Detour  
Additional service set_include_path(get_include_path() . PATH_SEPARATOR . ($basePath . "lib/Protobuf-PHP/library/DrSlump/"));
Modified service  
Stop moved include_once("Protobuf.php");
Other effect (not represented by any of these options) include_once("Protobuf/Message.php");
Unknown effect); include_once("Protobuf/Registry.php");
  include_once("Protobuf/Descriptor.php");
function getServiceAlerts($filter_class, $filter_id) { include_once("Protobuf/Field.php");
/*  
  include_once($basePath . "lib/Protobuf-PHP/gtfs-realtime.php");
also need last modified epoch of client gtfs include_once("Protobuf/CodecInterface.php");
  include_once("Protobuf/Codec/PhpArray.php");
- add,remove,patch,inform (null) include_once("Protobuf/Codec/Binary.php");
- stop include_once("Protobuf/Codec/Binary/Writer.php");
- trip include_once("Protobuf/Codec/Json.php");
- network  
  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));
  }
   
} }
?> ?>