core/siri_estimated_timetable_request_broadcaster.go
package core
import (
"strings"
"bitbucket.org/enroute-mobi/ara/audit"
"bitbucket.org/enroute-mobi/ara/core/idgen"
"bitbucket.org/enroute-mobi/ara/logger"
"bitbucket.org/enroute-mobi/ara/model"
"bitbucket.org/enroute-mobi/ara/siri/siri"
"bitbucket.org/enroute-mobi/ara/siri/sxml"
"bitbucket.org/enroute-mobi/ara/state"
)
type EstimatedTimetableRequestBroadcaster interface {
RequestLine(*sxml.XMLGetEstimatedTimetable, *audit.BigQueryMessage) *siri.SIRIEstimatedTimetableResponse
}
type SIRIEstimatedTimetableRequestBroadcaster struct {
state.Startable
connector
useVisitNumber bool
vjRemoteCodeSpaces []string
}
type SIRIEstimatedTimetableRequestBroadcasterFactory struct{}
func NewSIRIEstimatedTimetableRequestBroadcaster(partner *Partner) *SIRIEstimatedTimetableRequestBroadcaster {
connector := &SIRIEstimatedTimetableRequestBroadcaster{}
connector.partner = partner
return connector
}
func (connector *SIRIEstimatedTimetableRequestBroadcaster) Start() {
connector.remoteCodeSpace = connector.partner.RemoteCodeSpace(SIRI_ESTIMATED_TIMETABLE_REQUEST_BROADCASTER)
connector.vjRemoteCodeSpaces = connector.partner.VehicleJourneyRemoteCodeSpaceWithFallback(SIRI_ESTIMATED_TIMETABLE_REQUEST_BROADCASTER)
switch connector.partner.PartnerSettings.SIRIPassageOrder() {
case "visit_number":
connector.useVisitNumber = true
default:
connector.useVisitNumber = false
}
}
func (connector *SIRIEstimatedTimetableRequestBroadcaster) RequestLine(request *sxml.XMLGetEstimatedTimetable, message *audit.BigQueryMessage) *siri.SIRIEstimatedTimetableResponse {
response := &siri.SIRIEstimatedTimetableResponse{
Address: connector.Partner().Address(),
ProducerRef: connector.Partner().ProducerRef(),
ResponseMessageIdentifier: connector.Partner().NewResponseMessageIdentifier(),
}
response.SIRIEstimatedTimetableDelivery = connector.getEstimatedTimetableDelivery(&request.XMLEstimatedTimetableRequest)
if !response.SIRIEstimatedTimetableDelivery.Status {
message.Status = "Error"
message.ErrorDetails = response.SIRIEstimatedTimetableDelivery.ErrorString()
}
message.Lines = request.Lines()
message.StopAreas = GetModelReferenceSlice(response.MonitoringRefs)
message.VehicleJourneys = GetModelReferenceSlice(response.VehicleJourneyRefs)
message.RequestIdentifier = request.MessageIdentifier()
message.ResponseIdentifier = response.ResponseMessageIdentifier
return response
}
func (connector *SIRIEstimatedTimetableRequestBroadcaster) getEstimatedTimetableDelivery(request *sxml.XMLEstimatedTimetableRequest) siri.SIRIEstimatedTimetableDelivery {
currentTime := connector.Clock().Now()
delivery := siri.SIRIEstimatedTimetableDelivery{
RequestMessageRef: request.MessageIdentifier(),
ResponseTimestamp: currentTime,
Status: true,
VehicleJourneyRefs: make(map[string]struct{}),
MonitoringRefs: make(map[string]struct{}),
}
selectors := []model.StopVisitSelector{}
if request.PreviewInterval() != 0 {
duration := request.PreviewInterval()
now := connector.Clock().Now()
if !request.StartTime().IsZero() {
now = request.StartTime()
}
selectors = append(selectors, model.StopVisitSelectorByTime(now, now.Add(duration)))
}
selector := model.CompositeStopVisitSelector(selectors)
// SIRIEstimatedJourneyVersionFrame
for _, lineId := range request.Lines() {
lineCode := model.NewCode(connector.remoteCodeSpace, lineId)
line, ok := connector.partner.Model().Lines().FindByCode(lineCode)
if !ok {
logger.Log.Debugf("Cannot find requested line Estimated Time Table with id %v at %v", lineCode.String(), connector.Clock().Now())
continue
}
journeyFrame := &siri.SIRIEstimatedJourneyVersionFrame{
RecordedAtTime: currentTime,
}
lineIds := connector.partner.Model().Lines().FindFamily(line.Id())
for i := range lineIds {
// SIRIEstimatedVehicleJourney
vjs := connector.partner.Model().VehicleJourneys().FindByLineId(lineIds[i])
for i := range vjs {
// Handle vehicleJourney Code
vehicleJourneyId, ok := vjs[i].CodeWithFallback(connector.vjRemoteCodeSpaces)
var datedVehicleJourneyRef string
if ok {
datedVehicleJourneyRef = vehicleJourneyId.Value()
} else {
defaultCode, ok := vjs[i].Code("_default")
if !ok {
logger.Log.Debugf("Vehicle journey with id %v does not have a proper code at %v", vehicleJourneyId, connector.Clock().Now())
continue
}
datedVehicleJourneyRef = connector.partner.NewIdentifier(idgen.IdentifierAttributes{Type: "VehicleJourney", Id: defaultCode.Value()})
}
estimatedVehicleJourney := &siri.SIRIEstimatedVehicleJourney{
LineRef: lineCode.Value(),
DirectionType: vjs[i].DirectionType,
DatedVehicleJourneyRef: datedVehicleJourneyRef,
DataFrameRef: connector.dataFrameRef(),
PublishedLineName: connector.publishedLineName(line),
Attributes: make(map[string]string),
References: make(map[string]string),
}
estimatedVehicleJourney.References = connector.getEstimatedVehicleJourneyReferences(vjs[i], vjs[i].Origin)
estimatedVehicleJourney.Attributes = vjs[i].Attributes
// SIRIEstimatedCall
connector.Partner().RecordedCallsDuration()
svs := connector.partner.Model().StopVisits().FindByVehicleJourneyIdAfter(vjs[i].Id(), connector.Clock().Now().Add(-connector.Partner().RecordedCallsDuration()))
for i := range svs {
if !selector(svs[i]) {
continue
}
// Handle StopPointRef
stopArea, stopAreaId, ok := connector.stopPointRef(svs[i].StopAreaId)
if !ok {
logger.Log.Printf("Ignore Stopvisit %v without StopArea or with StopArea without correct Code", svs[i].Id())
continue
}
connector.resolveOperatorRef(estimatedVehicleJourney.References, svs[i])
if svs[i].IsRecordable(connector.Clock().Now()) && connector.Partner().RecordedCallsDuration() != 0 {
// recordedCall
recordedCall := &siri.SIRIRecordedCall{
ArrivalStatus: string(svs[i].ArrivalStatus),
DepartureStatus: string(svs[i].DepartureStatus),
AimedArrivalTime: svs[i].Schedules.Schedule("aimed").ArrivalTime(),
ExpectedArrivalTime: svs[i].Schedules.Schedule("expected").ArrivalTime(),
AimedDepartureTime: svs[i].Schedules.Schedule("aimed").DepartureTime(),
ExpectedDepartureTime: svs[i].Schedules.Schedule("expected").DepartureTime(),
Order: svs[i].PassageOrder,
StopPointRef: stopAreaId,
StopPointName: stopArea.Name,
DestinationDisplay: svs[i].Attributes["DestinationDisplay"],
}
recordedCall.UseVisitNumber = connector.useVisitNumber
estimatedVehicleJourney.RecordedCalls = append(estimatedVehicleJourney.RecordedCalls, recordedCall)
} else {
estimatedCall := &siri.SIRIEstimatedCall{
ArrivalStatus: string(svs[i].ArrivalStatus),
DepartureStatus: string(svs[i].DepartureStatus),
AimedArrivalTime: svs[i].Schedules.Schedule("aimed").ArrivalTime(),
AimedDepartureTime: svs[i].Schedules.Schedule("aimed").DepartureTime(),
Order: svs[i].PassageOrder,
StopPointRef: stopAreaId,
StopPointName: stopArea.Name,
DestinationDisplay: svs[i].Attributes["DestinationDisplay"],
VehicleAtStop: svs[i].VehicleAtStop,
}
estimatedCall.UseVisitNumber = connector.useVisitNumber
if stopArea.Monitored {
estimatedCall.ExpectedArrivalTime = svs[i].Schedules.Schedule("expected").ArrivalTime()
estimatedCall.ExpectedDepartureTime = svs[i].Schedules.Schedule("expected").DepartureTime()
}
estimatedVehicleJourney.EstimatedCalls = append(estimatedVehicleJourney.EstimatedCalls, estimatedCall)
}
delivery.MonitoringRefs[stopAreaId] = struct{}{}
}
if len(estimatedVehicleJourney.EstimatedCalls) != 0 || len(estimatedVehicleJourney.RecordedCalls) != 0 {
journeyFrame.EstimatedVehicleJourneys = append(journeyFrame.EstimatedVehicleJourneys, estimatedVehicleJourney)
delivery.VehicleJourneyRefs[datedVehicleJourneyRef] = struct{}{}
}
}
}
if len(journeyFrame.EstimatedVehicleJourneys) != 0 {
delivery.EstimatedJourneyVersionFrames = append(delivery.EstimatedJourneyVersionFrames, journeyFrame)
}
}
return delivery
}
func (connector *SIRIEstimatedTimetableRequestBroadcaster) stopPointRef(stopAreaId model.StopAreaId) (*model.StopArea, string, bool) {
stopPointRef, ok := connector.partner.Model().StopAreas().Find(stopAreaId)
if !ok {
return &model.StopArea{}, "", false
}
if connector.partner.PreferReferentStopArea() {
referent, ok := stopPointRef.Referent()
if ok {
referentCode, ok := referent.Code(connector.remoteCodeSpace)
if ok {
return referent, referentCode.Value(), true
}
}
}
stopPointRefCode, ok := stopPointRef.Code(connector.remoteCodeSpace)
if ok {
return stopPointRef, stopPointRefCode.Value(), true
}
referent, ok := stopPointRef.Referent()
if ok {
referentCode, ok := referent.Code(connector.remoteCodeSpace)
if ok {
return referent, referentCode.Value(), true
}
}
return &model.StopArea{}, "", false
}
func (connector *SIRIEstimatedTimetableRequestBroadcaster) publishedLineName(line *model.Line) string {
var pln string
switch connector.partner.PartnerSettings.SIRILinePublishedName() {
case "number":
if line.Number != "" {
pln = line.Number
} else {
pln = line.Name
}
default:
pln = line.Name
}
return pln
}
func (connector *SIRIEstimatedTimetableRequestBroadcaster) getEstimatedVehicleJourneyReferences(vehicleJourney *model.VehicleJourney, origin string) map[string]string {
references := make(map[string]string)
for _, refType := range []string{"OriginRef", "DestinationRef"} {
ref, ok := vehicleJourney.Reference(refType)
if !ok || ref == (model.Reference{}) || ref.Code == nil {
continue
}
if refType == "DestinationRef" && connector.noDestinationRefRewrite(origin) {
references[refType] = ref.Code.Value()
continue
}
if foundStopArea, ok := connector.partner.Model().StopAreas().FindByCode(*ref.Code); ok {
obj, ok := foundStopArea.ReferentOrSelfCode(connector.remoteCodeSpace)
if ok {
references[refType] = obj.Value()
continue
}
}
defaultCode := model.NewCode(connector.remoteCodeSpace, connector.partner.NewIdentifier(idgen.IdentifierAttributes{Type: "StopArea", Id: ref.GetSha1()}))
references[refType] = defaultCode.Value()
}
return references
}
func (connector *SIRIEstimatedTimetableRequestBroadcaster) noDestinationRefRewrite(origin string) bool {
for _, o := range connector.Partner().NoDestinationRefRewritingFrom() {
if origin == strings.TrimSpace(o) {
return true
}
}
return false
}
func (connector *SIRIEstimatedTimetableRequestBroadcaster) dataFrameRef() string {
modelDate := connector.partner.Model().Date()
return connector.partner.NewIdentifier(idgen.IdentifierAttributes{Type: "DataFrame", Id: modelDate.String()})
}
func (connector *SIRIEstimatedTimetableRequestBroadcaster) resolveOperatorRef(refs map[string]string, stopVisit *model.StopVisit) {
if _, ok := refs["OperatorRef"]; ok {
return
}
operatorRef, ok := stopVisit.Reference("OperatorRef")
if !ok || operatorRef == (model.Reference{}) || operatorRef.Code == nil {
return
}
operator, ok := connector.partner.Model().Operators().FindByCode(*operatorRef.Code)
if !ok {
refs["OperatorRef"] = operatorRef.Code.Value()
return
}
obj, ok := operator.Code(connector.remoteCodeSpace)
if !ok {
refs["OperatorRef"] = operatorRef.Code.Value()
return
}
refs["OperatorRef"] = obj.Value()
}
func (factory *SIRIEstimatedTimetableRequestBroadcasterFactory) Validate(apiPartner *APIPartner) {
apiPartner.ValidatePresenceOfRemoteCodeSpace()
apiPartner.ValidatePresenceOfLocalCredentials()
}
func (factory *SIRIEstimatedTimetableRequestBroadcasterFactory) CreateConnector(partner *Partner) Connector {
return NewSIRIEstimatedTimetableRequestBroadcaster(partner)
}