diff options
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/Travel/Status/DE/IRIS.pm | 533 | ||||
| -rw-r--r-- | lib/Travel/Status/DE/IRIS/Result.pm | 770 | ||||
| -rw-r--r-- | lib/Travel/Status/DE/IRIS/Stations.pm.PL | 66 |
3 files changed, 834 insertions, 535 deletions
diff --git a/lib/Travel/Status/DE/IRIS.pm b/lib/Travel/Status/DE/IRIS.pm index 689800b..2815a17 100644 --- a/lib/Travel/Status/DE/IRIS.pm +++ b/lib/Travel/Status/DE/IRIS.pm @@ -4,16 +4,14 @@ use strict; use warnings; use 5.014; -no if $] >= 5.018, warnings => 'experimental::smartmatch'; - -our $VERSION = '1.51'; +our $VERSION = '1.97'; use Carp qw(confess cluck); use DateTime; use DateTime::Format::Strptime; -use List::Util qw(first); +use List::Util qw(none first); use List::MoreUtils qw(uniq); -use List::UtilsBy qw(uniq_by); +use List::UtilsBy qw(uniq_by); use LWP::UserAgent; use Travel::Status::DE::IRIS::Result; use XML::LibXML; @@ -31,6 +29,153 @@ sub try_load_xml { return ( $tree, undef ); } +# "station" parameter must be an EVA or DS100 ID. +sub new_p { + my ( $class, %opt ) = @_; + my $promise = $opt{promise}->new; + + if ( not $opt{station} ) { + return $promise->reject('station flag must be passed'); + } + + my $self = $class->new( %opt, async => 1 ); + $self->{promise} = $opt{promise}; + + my $lookahead_steps = int( $self->{lookahead} / 60 ); + if ( ( 60 - $self->{datetime}->minute ) < ( $self->{lookahead} % 60 ) ) { + $lookahead_steps++; + } + my $lookbehind_steps = int( $self->{lookbehind} / 60 ); + if ( $self->{datetime}->minute < ( $self->{lookbehind} % 60 ) ) { + $lookbehind_steps++; + } + + my @candidates = $opt{get_station}( $opt{station} ); + + if ( @candidates != 1 and $opt{station} =~ m{^\d+$} ) { + @candidates = ( + [ + "D$opt{station}", "Betriebsstelle nicht bekannt $opt{station}", + $opt{station} + ] + ); + } + + if ( @candidates == 0 ) { + return $promise->reject('station not found'); + } + if ( @candidates >= 2 ) { + return $promise->reject('station identifier is ambiguous'); + } + + # "uic" is deprecated + $self->{station} = { + ds100 => $candidates[0][0], + eva => $candidates[0][2], + name => $candidates[0][1], + uic => $candidates[0][2], + }; + $self->{related_stations} = []; + + my @queue = ( $self->{station}{eva} ); + my @related_reqs; + my @related_stations; + my %seen = ( $self->{station}{eva} => 1 ); + my $iter_depth = 0; + + while ( @queue and $iter_depth < 12 and $opt{with_related} ) { + my $eva = shift(@queue); + $iter_depth++; + for my $ref ( @{ $opt{meta}{$eva} // [] } ) { + if ( not $seen{$ref} ) { + push( @related_stations, $ref ); + $seen{$ref} = 1; + push( @queue, $ref ); + } + } + } + + for my $eva (@related_stations) { + @candidates = $opt{get_station}($eva); + + if ( @candidates == 1 ) { + + # "uic" is deprecated + push( + @{ $self->{related_stations} }, + { + ds100 => $candidates[0][0], + eva => $candidates[0][2], + name => $candidates[0][1], + uic => $candidates[0][2], + } + ); + } + } + + my $dt_req = $self->{datetime}->clone; + my @timetable_reqs + = ( $self->get_timetable_p( $self->{station}{eva}, $dt_req ) ); + + for my $eva (@related_stations) { + push( @timetable_reqs, $self->get_timetable_p( $eva, $dt_req ) ); + } + + for ( 1 .. $lookahead_steps ) { + $dt_req->add( hours => 1 ); + push( @timetable_reqs, + $self->get_timetable_p( $self->{station}{eva}, $dt_req ) ); + for my $eva (@related_stations) { + push( @timetable_reqs, $self->get_timetable_p( $eva, $dt_req ) ); + } + } + + $dt_req = $self->{datetime}->clone; + for ( 1 .. $lookbehind_steps ) { + $dt_req->subtract( hours => 1 ); + push( @timetable_reqs, + $self->get_timetable_p( $self->{station}{eva}, $dt_req ) ); + for my $eva (@related_stations) { + push( @timetable_reqs, $self->get_timetable_p( $eva, $dt_req ) ); + } + } + + $self->{promise}->all(@timetable_reqs)->then( + sub { + my @realtime_reqs + = ( $self->get_realtime_p( $self->{station}{eva} ) ); + for my $eva (@related_stations) { + push( @realtime_reqs, $self->get_realtime_p( $eva, $dt_req ) ); + } + return $self->{promise}->all_settled(@realtime_reqs); + } + )->then( + sub { + my @realtime_results = @_; + + for my $realtime_result (@realtime_results) { + if ( $realtime_result->{status} eq 'rejected' ) { + $self->{warnstr} //= q{}; + $self->{warnstr} + .= "Realtime data request failed: $realtime_result->{reason}. "; + } + } + + $self->postprocess_results; + $promise->resolve($self); + return; + } + )->catch( + sub { + my ($err) = @_; + $promise->reject($err); + return; + } + )->wait; + + return $promise; +} + sub new { my ( $class, %opt ) = @_; @@ -45,7 +190,7 @@ sub new { iris_base => $opt{iris_base} // 'https://iris.noncd.db.de/iris-tts/timetable', keep_transfers => $opt{keep_transfers}, - lookahead => $opt{lookahead} // ( 2 * 60 ), + lookahead => $opt{lookahead} // ( 2 * 60 ), lookbehind => $opt{lookbehind} // ( 0 * 60 ), main_cache => $opt{main_cache}, rt_cache => $opt{realtime_cache}, @@ -65,6 +210,19 @@ sub new { bless( $self, $class ); + my $lookahead_steps = int( $self->{lookahead} / 60 ); + if ( ( 60 - $self->{datetime}->minute ) < ( $self->{lookahead} % 60 ) ) { + $lookahead_steps++; + } + my $lookbehind_steps = int( $self->{lookbehind} / 60 ); + if ( $self->{datetime}->minute < ( $self->{lookbehind} % 60 ) ) { + $lookbehind_steps++; + } + + if ( $opt{async} ) { + return $self; + } + if ( not $self->{user_agent} ) { my %lwp_options = %{ $opt{lwp_options} // { timeout => 10 } }; $self->{user_agent} = LWP::UserAgent->new(%lwp_options); @@ -81,17 +239,24 @@ sub new { $self->{related_stations} = \@related_stations; for my $ref (@related_stations) { + + # We (the parent) perform transfer processing, so child requests must not + # do it themselves. Otherwise, trains from child requests will be + # processed twice and may be lost. + # Similarly, child requests must not perform requests to related + # stations -- we're already doing that right now. my $ref_status = Travel::Status::DE::IRIS->new( datetime => $self->{datetime}, developer_mode => $self->{developer_mode}, - keep_transfers => $self->{keep_transfers}, + iris_base => $self->{iris_base}, lookahead => $self->{lookahead}, lookbehind => $self->{lookbehind}, - station => $ref->{uic}, + station => $ref->{eva}, main_cache => $self->{main_cache}, realtime_cache => $self->{rt_cache}, strptime_obj => $self->{strptime_obj}, user_agent => $self->{user_agent}, + keep_transfers => 1, with_related => 0, ); if ( not $ref_status->errstr ) { @@ -103,29 +268,27 @@ sub new { return $self; } - my $lookahead_steps = int( $self->{lookahead} / 60 ); - if ( ( 60 - $self->{datetime}->minute ) < ( $self->{lookahead} % 60 ) ) { - $lookahead_steps++; - } - my $lookbehind_steps = int( $self->{lookbehind} / 60 ); - if ( $self->{datetime}->minute < ( $self->{lookbehind} % 60 ) ) { - $lookbehind_steps++; - } - my $dt_req = $self->{datetime}->clone; - $self->get_timetable( $self->{station}{uic}, $dt_req ); + $self->get_timetable( $self->{station}{eva}, $dt_req ); for ( 1 .. $lookahead_steps ) { $dt_req->add( hours => 1 ); - $self->get_timetable( $self->{station}{uic}, $dt_req ); + $self->get_timetable( $self->{station}{eva}, $dt_req ); } $dt_req = $self->{datetime}->clone; for ( 1 .. $lookbehind_steps ) { $dt_req->subtract( hours => 1 ); - $self->get_timetable( $self->{station}{uic}, $dt_req ); + $self->get_timetable( $self->{station}{eva}, $dt_req ); } $self->get_realtime; + $self->postprocess_results; + + return $self; +} + +sub postprocess_results { + my ($self) = @_; if ( not $self->{keep_transfers} ) { # tra (transfer?) indicates a train changing its ID, so there are two @@ -142,7 +305,7 @@ sub new { for my $transfer (@merge_candidates) { my $result = first { $_->transfer and $_->transfer eq $transfer->train_id } - @{ $self->{results} }; + @{ $self->{results} }; if ($result) { $result->merge_with_departure($transfer); } @@ -166,8 +329,55 @@ sub new { # same goes for replacement refs (the <ref> tag in the fchg document) $self->create_replacement_refs; +} - return $self; +sub get_with_cache_p { + my ( $self, $cache, $url ) = @_; + + if ( $self->{developer_mode} ) { + say "GET $url"; + } + + my $promise = $self->{promise}->new; + + if ($cache) { + my $content = $cache->thaw($url); + if ($content) { + if ( $self->{developer_mode} ) { + say ' cache hit'; + } + return $promise->resolve($content); + } + } + + if ( $self->{developer_mode} ) { + say ' cache miss'; + } + + my $res = $self->{user_agent}->get_p($url)->then( + sub { + my ($tx) = @_; + if ( my $err = $tx->error ) { + $promise->reject( + "GET $url returned HTTP $err->{code} $err->{message}"); + return; + } + my $content = $tx->res->body; + if ($cache) { + $cache->freeze( $url, \$content ); + } + $promise->resolve($content); + return; + } + )->catch( + sub { + my ($err) = @_; + $promise->reject($err); + return; + } + )->wait; + + return $promise; } sub get_with_cache { @@ -206,6 +416,49 @@ sub get_with_cache { return ( $content, undef ); } +sub get_station_p { + my ( $self, %opt ) = @_; + + my $promise = $self->{promise}->new; + my $station = $opt{name}; + + $self->get_with_cache_p( $self->{main_cache}, + $self->{iris_base} . '/station/' . $station )->then( + sub { + my ($raw) = @_; + my ( $xml_st, $xml_err ) = try_load_xml($raw); + if ($xml_err) { + $promise->reject('Failed to parse station data: Invalid XML'); + return; + } + my $station_node = ( $xml_st->findnodes('//station') )[0]; + + if ( not $station_node ) { + $promise->reject( + "Station '$station' has no associated timetable"); + return; + } + $promise->resolve( + { + ds100 => $station_node->getAttribute('ds100'), + eva => $station_node->getAttribute('eva'), + name => $station_node->getAttribute('name'), + uic => $station_node->getAttribute('eva'), + } + ); + return; + } + )->catch( + sub { + my ($err) = @_; + $promise->reject($err); + return; + } + )->wait; + + return $promise; +} + sub get_station { my ( $self, %opt ) = @_; @@ -215,14 +468,15 @@ sub get_station { # @seen holds station IDs which were already seen during recursive # 'meta' descent. This avoids infinite loops of 'meta' references. - # As Norddeich and Norddeich Mole are illegaly coupled in the backend - # (they are different stations with different departure times), we pre-seed - # @seen with their eva IDs. - my @seen = ( 8007768, 8004449 ); + # Additionally, we use it to skip stations shat should not be referenced. + # This includes Norddeich / Norddeich Mole (different stations commonly used + # by identical trains with different departure times), and Essen-Dellwig / + # Essen-Dellwig Ost (different stations used by different trains, but with + # identical platform numbers). + my @seen = ( 8007768, 8004449, 8001903, 8001904 ); while ( @queue and $iter_depth < 12 ) { my $station = shift(@queue); - push( @seen, $station ); $iter_depth++; my ( $raw, $err ) @@ -249,6 +503,9 @@ sub get_station { my $station_node = ( $xml_st->findnodes('//station') )[0]; if ( not $station_node ) { + if ( $self->{developer_mode} ) { + say ' no timetable'; + } if ( $opt{root} ) { $self->{errstr} = "Station '$station' has no associated timetable"; @@ -273,30 +530,40 @@ sub get_station { if ( $station_node->getAttribute('ds100') =~ m{ ^ D \d+ $ }x ) { - # This is an invalid DS100 code, at least from DB perspective. - # So far it seems to refer to subway stations which do not have - # IRIS departures. - next; + # This used to indicate an invalid DS100 code, at least from DB + # perspective. It typically referred to subway stations which do not + # have IRIS departures. + # However, since Fahrplanwechsel 2022 / 2023, this does not seem + # to be the case anymore. There are some stations whose DS100 code + # IRIS does not know, for whatever reason. So for now, accept these + # stations as well. + + #next; } push( @ret, { - uic => $station_node->getAttribute('eva'), - name => $station_node->getAttribute('name'), ds100 => $station_node->getAttribute('ds100'), + eva => $station_node->getAttribute('eva'), + name => $station_node->getAttribute('name'), + uic => $station_node->getAttribute('eva'), } ); if ( $self->{developer_mode} ) { - printf( " -> %s (%s / %s)\n", @{ $ret[-1] }{qw{name uic ds100}} ); + printf( " -> %s (%s / %s)\n", @{ $ret[-1] }{qw{name eva ds100}} ); } if ( $opt{recursive} and defined $station_node->getAttribute('meta') ) { my @refs = uniq( split( m{ \| }x, $station_node->getAttribute('meta') ) ); - @refs = grep { not( $_ ~~ \@seen or $_ ~~ \@queue ) } @refs; - push( @queue, @refs ); + for my $ref (@refs) { + if ( none { $_ == $ref } @seen and none { $_ == $ref } @queue ) + { + push( @queue, $ref ); + } + } $opt{root} = 0; } } @@ -306,13 +573,13 @@ sub get_station { . "This is probably a bug" ); } - @ret = uniq_by { $_->{uic} } @ret; + @ret = uniq_by { $_->{eva} } @ret; return @ret; } sub add_result { - my ( $self, $station_name, $station_uic, $s ) = @_; + my ( $self, $station_name, $station_eva, $s ) = @_; my $id = $s->getAttribute('id'); my $e_tl = ( $s->findnodes( $self->{xp_tl} ) )[0]; @@ -330,7 +597,8 @@ sub add_result { train_no => $e_tl->getAttribute('n'), # dep number type => $e_tl->getAttribute('c'), # S/ICE/ERB/... station => $station_name, - station_uic => $station_uic + 0, # UIC IDs are numbers + station_eva => $station_eva + 0, # EVA IDs are numbers + station_uic => $station_eva + 0, # deprecated strptime_obj => $self->{strptime_obj}, #unknown_t => $e_tl->getAttribute('t'), # p @@ -343,9 +611,8 @@ sub add_result { $data{route_pre} = $e_ar->getAttribute('ppth'); $data{route_start} = $e_ar->getAttribute('pde'); $data{transfer} = $e_ar->getAttribute('tra'); + $data{arrival_hidden} = $e_ar->getAttribute('hi'); $data{arrival_wing_ids} = $e_ar->getAttribute('wings'); - - #$data{unk_ar_hi} = $e_ar->getAttribute('hi'); } if ($e_dp) { @@ -355,9 +622,8 @@ sub add_result { $data{route_post} = $e_dp->getAttribute('ppth'); $data{route_end} = $e_dp->getAttribute('pde'); $data{transfer} = $e_dp->getAttribute('tra'); + $data{departure_hidden} = $e_dp->getAttribute('hi'); $data{departure_wing_ids} = $e_dp->getAttribute('wings'); - - #$data{unk_dp_hi} = $e_dp->getAttribute('hi'); } if ( $data{arrival_wing_ids} ) { @@ -381,6 +647,41 @@ sub add_result { return $result; } +sub get_timetable_p { + my ( $self, $eva, $dt ) = @_; + + my $promise = $self->{promise}->new; + + $self->get_with_cache_p( $self->{main_cache}, + $dt->strftime( $self->{iris_base} . "/plan/${eva}/%y%m%d/%H" ) )->then( + sub { + my ($raw) = @_; + my ( $xml, $xml_err ) = try_load_xml($raw); + if ($xml_err) { + $promise->reject( + 'Failed to parse a schedule part: Invalid XML'); + return; + } + my $station + = ( $xml->findnodes('/timetable') )[0]->getAttribute('station'); + + for my $s ( $xml->findnodes('/timetable/s') ) { + + $self->add_result( $station, $eva, $s ); + } + $promise->resolve; + return; + } + )->catch( + sub { + my ($err) = @_; + $promise->reject($err); + return; + } + )->wait; + return $promise; +} + sub get_timetable { my ( $self, $eva, $dt ) = @_; @@ -407,13 +708,48 @@ sub get_timetable { $self->add_result( $station, $eva, $s ); } + if ( $self->{developer_mode} + and not scalar $xml->findnodes('/timetable/s') ) + { + say ' no scheduled trains'; + } + return $self; } +sub get_realtime_p { + my ( $self, $eva ) = @_; + + my $promise = $self->{promise}->new; + + $self->get_with_cache_p( $self->{rt_cache}, + $self->{iris_base} . "/fchg/${eva}" )->then( + sub { + my ($raw) = @_; + my ( $xml, $xml_err ) = try_load_xml($raw); + if ($xml_err) { + $promise->reject( + 'Failed to parse a schedule part: Invalid XML'); + return; + } + $self->parse_realtime( $eva, $xml ); + $promise->resolve; + return; + } + )->catch( + sub { + my ($err) = @_; + $promise->reject("Failed to fetch realtime data: $err"); + return; + } + )->wait; + return $promise; +} + sub get_realtime { my ($self) = @_; - my $eva = $self->{station}{uic}; + my $eva = $self->{station}{eva}; my ( $raw, $err ) = $self->get_with_cache( $self->{rt_cache}, @@ -431,6 +767,11 @@ sub get_realtime { return $self; } + $self->parse_realtime( $eva, $xml ); +} + +sub parse_realtime { + my ( $self, $eva, $xml ) = @_; my $station = ( $xml->findnodes('/timetable') )[0]->getAttribute('station'); for my $s ( $xml->findnodes('/timetable/s') ) { @@ -466,13 +807,13 @@ sub get_realtime { my $msgid = $e_m->getAttribute('id'); my $ts = $e_m->getAttribute('ts'); - # 0 and 1 (with key "f") are related to canceled trains and - # do not appear to hold information (or at least none we can access). - # All observed cases of message ID 900 were related to bus - # connections ("Anschlussbus wartet"). We can't access which bus - # it refers to, so we don't show that either. - # ID 1000 is a generic free text message, which (as we lack access - # to the text itself) is not helpful either. + # 0 and 1 (with key "f") are related to canceled trains and + # do not appear to hold information (or at least none we can access). + # All observed cases of message ID 900 were related to bus + # connections ("Anschlussbus wartet"). We can't access which bus + # it refers to, so we don't show that either. + # ID 1000 is a generic free text message, which (as we lack access + # to the text itself) is not helpful either. if ( defined $value and $value > 1 and $value < 100 ) { $messages{$msgid} = [ $ts, $type, $value ]; } @@ -492,9 +833,9 @@ sub get_realtime { type => $e_ref->getAttribute('c'), # S/ICE/ERB/... line_no => $e_ref->getAttribute('l'), # 1 -> S1, ... - #unknown_t => $e_ref->getAttribute('t'), # p - #unknown_o => $e_ref->getAttribute('o'), # owner: 03/80/R2/... - # TODO ps='a' -> rerouted and normally unscheduled train? + #unknown_t => $e_ref->getAttribute('t'), # p + #unknown_o => $e_ref->getAttribute('o'), # owner: 03/80/R2/... + # TODO ps='a' -> rerouted and normally unscheduled train? ); } if ($e_ar) { @@ -506,6 +847,7 @@ sub get_realtime { sched_route_pre => $e_ar->getAttribute('ppth'), status => $e_ar->getAttribute('cs'), status_since => $e_ar->getAttribute('clt'), + arrival_hidden => $e_ar->getAttribute('hi'), # TODO ps='a' -> rerouted and normally unscheduled train? ); @@ -518,6 +860,7 @@ sub get_realtime { route_post => $e_dp->getAttribute('cpth'), sched_route_post => $e_dp->getAttribute('ppth'), status => $e_dp->getAttribute('cs'), + departure_hidden => $e_dp->getAttribute('hi'), ); } @@ -537,7 +880,7 @@ sub get_result_by_train { my ( $self, $type, $train_no ) = @_; my $res = first { $_->type eq $type and $_->train_no eq $train_no } - @{ $self->{results} }; + @{ $self->{results} }; return $res; } @@ -619,14 +962,11 @@ Travel::Status::DE::IRIS - Interface to IRIS based web departure monitors. =head1 SYNOPSIS - use Travel::Status::DE::IRIS; - use Travel::Status::DE::IRIS::Stations; +Blocking variant: - # Get station code for "Essen Hbf" (-> "EE") - my $station = (Travel::Status::DE::IRIS::Stations::get_station_by_name( - 'Essen Hbf'))[0][0]; + use Travel::Status::DE::IRIS; - my $status = Travel::Status::DE::IRIS->new(station => $station); + my $status = Travel::Status::DE::IRIS->new(station => "Essen Hbf"); for my $r ($status->results) { printf( "%s %s +%-3d %10s -> %s\n", @@ -634,9 +974,40 @@ Travel::Status::DE::IRIS - Interface to IRIS based web departure monitors. ); } +Non-blocking variant (EXPERIMENTAL): + + use Mojo::Promise; + use Mojo::UserAgent; + use Travel::Status::DE::IRIS; + use Travel::Status::DE::IRIS::Stations; + + Travel::Status::DE::IRIS->new_p(station => "Essen Hbf", + promise => 'Mojo::Promise', user_agent => Mojo::UserAgent->new, + get_station => \&Travel::Status::DE::IRIS::Stations::get_station, + meta => Travel::Status::DE::IRIS::Stations::get_meta())->then(sub { + my ($status) = @_; + for my $r ($status->results) { + printf( + "%s %s +%-3d %10s -> %s\n", + $r->date, $r->time, $r->delay || 0, $r->line, $r->destination + ); + } + })->wait; + =head1 VERSION -version 1.51 +version 1.97 + +=head1 DEPRECATION NOTICE + +As of May 2024, the backend service that this module relies on is deprecated +and may cease operation in the near future. There is no immediate successor. +Hence, Travel::Status::DE::IRIS is no longer actively maintained. There is no +promise that issues and merge requests will be reviewed or merged. + +The Travel::Status::DE::HAFAS(3pm) module provides similar features. However, +its default "DB" backend is also deprecated. There is no migration path to a +Deutsche Bahn departure monitor that is not deprecated at the moment. =head1 DESCRIPTION @@ -691,7 +1062,7 @@ backend data will be reported as-is and transfer trains will not be merged. Compute only results which are scheduled less than I<int> minutes in the future. -Default: 180 (3 hours). +Default: 120 (2 hours). Note that the DeutscheBahn IRIS backend only provides schedules up to four to five hours into the future. So in most cases, setting this to a value above 240 @@ -746,6 +1117,38 @@ departures for all related stations. =back +=item my $promise = Travel::Status::DE::IRIS->new_p(I<%opt>) (B<EXPERIMENTAL>) + +Return a promise yielding a Travel::Status::DE::IRIS instance (C<< $status >>) +on success, or an error message (same as C<< $status->errstr >>) on failure. +This function is experimental and may be changed or remove without warning. + +In addition to the arguments of B<new>, the following mandatory arguments must +be set: + +=over + +=item B<promise> => I<promises module> + +Promises implementation to use for internal promises as well as B<new_p> return +value. Recommended: Mojo::Promise(3pm). + +=item B<get_station> => I<get_station ref> + +Reference to Travel::Status::DE::IRIS::Stations::get_station(). + +=item B<meta> => I<meta dict> + +The dictionary returned by Travel::Status::DE::IRIS::Stations::get_meta(). + +=item B<user_agent> => I<user agent> + +User agent instance to use for asynchronous requests. The object must support +promises (i.e., it must implement a C<< get_p >> function). Recommended: +Mojo::UserAgent(3pm). + +=back + =item $status->errstr In case of a fatal HTTP request or IRIS error, returns a string describing it. @@ -757,7 +1160,7 @@ Returns a list of hashes describing related stations whose arrivals/departures are included in B<results>. Only useful when setting B<with_related> to a true value, see its documentation above for details. -Each hash contains the keys B<uic> (EVA number; often same as UIC station ID), +Each hash contains the keys B<eva> (EVA number; often same as UIC station ID), B<name> (station name), and B<ds100> (station code). Note that stations returned by B<related_stations> are not necessarily known to Travel::Status::DE::IRIS::Stations(3pm). @@ -807,7 +1210,7 @@ L<https://github.com/derf/Travel-Status-DE-IRIS> =head1 AUTHOR -Copyright (C) 2013-2020 by Daniel Friesel E<lt>derf@finalrewind.orgE<gt> +Copyright (C) 2013-2024 by Birte Kristina Friesel E<lt>derf@finalrewind.orgE<gt> =head1 LICENSE diff --git a/lib/Travel/Status/DE/IRIS/Result.pm b/lib/Travel/Status/DE/IRIS/Result.pm index abccea0..27dd7b0 100644 --- a/lib/Travel/Status/DE/IRIS/Result.pm +++ b/lib/Travel/Status/DE/IRIS/Result.pm @@ -5,101 +5,133 @@ use warnings; use 5.014; use utf8; -no if $] >= 5.018, warnings => 'experimental::smartmatch'; - use parent 'Class::Accessor'; use Carp qw(cluck); use DateTime; use DateTime::Format::Strptime; use List::Compare; -use List::MoreUtils qw(none uniq firstval); -use Scalar::Util qw(weaken); +use List::Util qw(any); +use List::MoreUtils qw(uniq lastval); +use Scalar::Util qw(weaken); + +our $VERSION = '1.97'; + +Travel::Status::DE::IRIS::Result->mk_ro_accessors( + qw(arrival arrival_delay arrival_has_realtime arrival_is_additional arrival_is_cancelled arrival_hidden + date datetime delay + departure departure_delay departure_has_realtime departure_is_additional departure_is_cancelled departure_hidden + ds100 has_realtime is_transfer is_unscheduled is_wing + line_no old_train_id old_train_no operator platform raw_id + realtime_xml route_start route_end + sched_arrival sched_departure sched_platform sched_route_start + sched_route_end start + station station_eva station_uic + stop_no time train_id train_no transfer type + unknown_t unknown_o wing_id wing_of) +); -our $VERSION = '1.51'; +# {{{ Data (message codes, station fixups) my %translation = ( - 2 => 'Polizeiliche Ermittlung', - 3 => 'Feuerwehreinsatz neben der Strecke', - 4 => 'Kurzfristiger Personalausfall', + 1 => 'Nähere Informationen in Kürze', + 2 => 'Polizeieinsatz', + 3 => 'Feuerwehreinsatz auf der Strecke', + 4 => 'Kurzfristiger Personalausfall', # xlsx: missing 5 => 'Ärztliche Versorgung eines Fahrgastes', - 6 => 'Betätigen der Notbremse', - 7 => 'Personen im Gleis', - 8 => 'Notarzteinsatz am Gleis', + 6 => 'Betätigen der Notbremse', # xlsx: "Unbefugtes Ziehen der Notbremse" + 7 => 'Unbefugte Personen auf der Strecke', + 8 => 'Notarzteinsatz auf der Strecke', 9 => 'Streikauswirkungen', - 10 => 'Ausgebrochene Tiere im Gleis', + 10 => 'Tiere auf der Strecke', 11 => 'Unwetter', - 12 => 'Warten auf Fahrgäste aus einem Schiff', + 12 => 'Warten auf ein verspätetes Schiff', 13 => 'Pass- und Zollkontrolle', - 14 => 'Technische Störung am Bahnhof', + 14 => 'Defekt am Bahnhof', # xlsx: "Technischer Defekt am Bahnhof" 15 => 'Beeinträchtigung durch Vandalismus', 16 => 'Entschärfung einer Fliegerbombe', 17 => 'Beschädigung einer Brücke', - 18 => 'Umgestürzter Baum im Gleis', + 18 => 'Umgestürzter Baum auf der Strecke', 19 => 'Unfall an einem Bahnübergang', - 20 => 'Tiere im Gleis', - 21 => 'Warten auf weitere Reisende', - 22 => 'Witterungsbedingte Störung', - 23 => 'Feuerwehreinsatz auf Bahngelände', - 24 => 'Verspätung aus dem Ausland', - 25 => 'Warten auf verspätete Zugteile', - 28 => 'Gegenstände im Gleis', + 20 => 'Tiere im Gleis', # xlsx: missing + 21 => 'Warten auf Anschlussreisende', + 22 => 'Witterungsbedingte Beeinträchtigung', + 23 => 'Betriebsstabilisierung', + 24 => 'Verspätung im Ausland', + 25 => 'Bereitstellung weiterer Wagen', + 26 => 'Abhängen von Wagen', + 28 => 'Gegenstände auf der Strecke', + 29 => 'Ersatzverkehr mit Bus ist eingerichtet', 31 => 'Bauarbeiten', - 32 => 'Verzögerung beim Ein-/Ausstieg', - 33 => 'Oberleitungsstörung', - 34 => 'Signalstörung', + 32 => 'Längere Haltezeit am Bahnhof', + 33 => 'Defekt an der Oberleitung', # xlsx: "Reparatur an der Oberleitung" + 34 => 'Defekt an einem Signal', # xlsx: "Reparatur an einem Signal" 35 => 'Streckensperrung', 36 => 'Technische Störung am Zug', - 37 => 'Technische Störung am Wagen', - 38 => 'Technische Störung an der Strecke', - 39 => 'Anhängen von zusätzlichen Wagen', - 40 => 'Stellwerksstörung/-ausfall', - 41 => 'Störung an einem Bahnübergang', - 42 => 'Außerplanmäßige Geschwindigkeitsbeschränkung', + 37 => 'Kurzfristiger Fahrzeugausfall', + 38 => 'Defekt an der Strecke', # xlsx: "Reparatur an der Strecke" + 39 => 'Stau / Hohes Verkehrsaufkommen', + 40 => 'Defektes Stellwerk', + 41 => 'Defekt an einem Bahnübergang' + , # xlsx: "Technischer Defekt an einem Bahnüburgang" + 42 => 'Außerplanmäßige Geschwindigkeitsbeschränkung' + , # xlsx: "Vorübergehend verminderte Geschwindigkeit auf der Strecke" 43 => 'Verspätung eines vorausfahrenden Zuges', 44 => 'Warten auf einen entgegenkommenden Zug', - 45 => 'Überholung durch anderen Zug', - 46 => 'Warten auf freie Einfahrt', + 45 => 'Vorfahrt eines anderen Zuges', + 46 => 'Vorfahrt eines anderen Zuges', + 47 => 'Verspätete Bereitstellung', 48 => 'Verspätung aus vorheriger Fahrt', - 55 => 'Technische Störung an einem anderen Zug', # ? - 56 => 'Warten auf Fahrgäste aus einem Bus', - 57 => 'Zusätzlicher Halt', - 58 => 'Umleitung', # ? + 49 => 'Kurzfristiger Personalausfall', + 50 => 'Kurzfristige Erkrankung von Personal', + 51 => 'Verspätetes Personal aus vorheriger Fahrt', + 52 => 'Streik', + 53 => 'Unwetterauswirkungen', + 54 => 'Verfügbarkeit der Gleise derzeit eingeschränkt', + 55 => 'Technischer Defekt an einem anderen Zug', + 56 => 'Warten auf Anschlussreisende', # aus einem Bus + 57 => 'Zusätzlicher Halt', # xslx: "Zusätzlicher Halt zum Ein- und Ausstieg" + 58 => 'Umleitung', # xlsx: "Umleitung des Zuges" 59 => 'Schnee und Eis', - 60 => 'Reduzierte Geschwindigkeit wegen Sturm', - 61 => 'Türstörung', - 62 => 'Behobene technische Störung am Zug', + 60 => 'Witterungsbedingt verminderte Geschwindigkeit', + 61 => 'Defekte Tür', + 62 => 'Behobener Defekt am Zug', 63 => 'Technische Untersuchung am Zug', - 64 => 'Weichenstörung', + 64 => 'Defekt an einer Weiche', 65 => 'Erdrutsch', 66 => 'Hochwasser', - 67 => 'Behördliche Anordnung', + 67 => 'Behördliche Maßnahme', + 68 => 'Hohes Fahrgastaufkommen' + , # xlsx: "Hohes Fahrgastaufkommen verlängert Ein- und Ausstieg" + 69 => 'Zug verkehrt mit verminderter Geschwindigeit', 70 => 'WLAN nicht verfügbar', 71 => 'WLAN in einzelnen Wagen nicht verfügbar', 72 => 'Info/Entertainment nicht verfügbar', - 73 => 'Mehrzweckabteil vorne', - 74 => 'Mehrzweckabteil hinten', - 75 => '1. Klasse vorne', - 76 => '1. Klasse hinten', - 77 => 'Ohne 1. Klasse', - 79 => 'Ohne Mehrzweckabteil', + 73 => 'Heute: Mehrzweckabteil vorne', + 74 => 'Heute: Mehrzweckabteil hinten', + 75 => 'Heute: 1. Klasse vorne', + 76 => 'Heute: 1. Klasse hinten', + 77 => '1. Klasse fehlt', + 78 => 'Ersatzverkehr mit Bus ist eingerichtet', + 79 => 'Mehrzweckabteil fehlt', 80 => 'Abweichende Wagenreihung', + 81 => 'Fahrzeugtausch', 82 => 'Mehrere Wagen fehlen', - 83 => 'Störung der fahrzeuggebundenen Einstiegshilfe', - 84 => 'Zug verkehrt richtig gereiht', # r 80 82 85 + 83 => 'Defekte fahrzeuggebundene Einstiegshilfe', + 84 => 'Zug verkehrt richtig gereiht', 85 => 'Ein Wagen fehlt', - 86 => 'Keine Reservierungsanzeige', - 87 => 'Einzelne Wagen ohne Reservierungsanzeige', - 88 => 'Keine Qualitätsmängel', # r 80 82 83 85 86 87 90 91 92 93 96 97 98 - 89 => 'Reservierungen sind wieder vorhanden', # -> 86 87 + 86 => 'Gesamter Zug ohne Reservierung', + 87 => 'Einzelne Wagen ohne Reservierung', + 88 => 'Keine Qualitätsmängel', + 89 => 'Reservierungen sind wieder vorhanden', 90 => 'Kein gastronomisches Angebot', - 91 => 'Keine Fahrradbeförderung', + 91 => 'Fahrradmitnahme nicht möglich', 92 => 'Eingeschränkte Fahrradbeförderung', - 93 => 'Fehlende oder gestörte behindertengerechte Einrichtung', + 93 => 'Behindertengerechte Einrichtung fehlt', 94 => 'Ersatzbewirtschaftung', - 95 => 'Ohne behindertengerechtes WC', - 96 => 'Der Zug ist stark überbesetzt', # r 97 - 97 => 'Der Zug ist überbesetzt', # r 96 + 95 => 'Universal-WC fehlt', + 96 => 'Überbesetzung mit Kulanzleistungen', + 97 => 'Überbesetzung ohne Kulanzleistungen', 98 => 'Sonstige Qualitätsmängel', 99 => 'Verzögerungen im Betriebsablauf', @@ -108,57 +140,17 @@ my %translation = ( # it refers to, we don't show it to users. ); -Travel::Status::DE::IRIS::Result->mk_ro_accessors( - qw(arrival arrival_delay arrival_is_additional arrival_is_cancelled - date datetime delay - departure departure_delay departure_is_additional departure_is_cancelled - ds100 is_transfer is_unscheduled is_wing - line_no old_train_id old_train_no operator platform raw_id - realtime_xml route_start route_end - sched_arrival sched_departure sched_platform sched_route_start - sched_route_end start - station station_uic - stop_no time train_id train_no transfer type - unknown_t unknown_o wing_id wing_of) +# IRIS may return "Betriebsstelle nicht bekannt" for some recently added +# stations. Fix those manually. +my %fixup = ( + 8002795 => 'Herten(Westf)', + 8003983 => 'Merklingen - Schwäbische Alb', + 8005493 => 'Schwetzingen-Hirschacker', + 8070678 => 'Metzingen-Neuhausen', ); -sub is_additional { - my ($self) = @_; - - if ( $self->{arrival_is_additional} and $self->{departure_is_additional} ) { - return 1; - } - if ( $self->{arrival_is_additional} - and not defined $self->{departure_is_additional} ) - { - return 1; - } - if ( not defined $self->{arrival_is_additional} - and $self->{departure_is_additional} ) - { - return 1; - } - return 0; -} - -sub is_cancelled { - my ($self) = @_; - - if ( $self->{arrival_is_cancelled} and $self->{departure_is_cancelled} ) { - return 1; - } - if ( $self->{arrival_is_cancelled} - and not defined $self->{departure_is_cancelled} ) - { - return 1; - } - if ( not defined $self->{arrival_is_cancelled} - and $self->{departure_is_cancelled} ) - { - return 1; - } - return 0; -} +# }}} +# {{{ Constructor sub new { my ( $obj, %opt ) = @_; @@ -215,6 +207,9 @@ sub new { $ref->{route_post} = $ref->{sched_route_post} = [ split( qr{[|]}, $ref->{route_post} // q{} ) ]; + $ref->fixup_route( $ref->{route_pre} ); + $ref->fixup_route( $ref->{route_post} ); + $ref->{route_pre_incomplete} = $ref->{route_end} ? 1 : 0; $ref->{route_post_incomplete} = $ref->{route_post} ? 1 : 0; @@ -233,6 +228,20 @@ sub new { return $ref; } +# }}} +# {{{ Internal Helpers + +sub fixup_route { + my ( $self, $route ) = @_; + for my $stop ( @{$route} ) { + if ( $stop =~ m{^Betriebsstelle nicht bekannt (\d+)$} ) { + if ( $fixup{$1} ) { + $stop = $fixup{$1}; + } + } + } +} + sub parse_ts { my ( $self, $string ) = @_; @@ -242,10 +251,51 @@ sub parse_ts { return; } +# List::Compare does not keep the order of its arguments (even with unsorted). +# So we need to re-sort all stops to maintain their original order. +sub sorted_sublist { + my ( $self, $list, $sublist ) = @_; + my %pos; + + if ( not $sublist or not @{$sublist} ) { + return; + } + + for my $i ( 0 .. $#{$list} ) { + $pos{ $list->[$i] } = $i; + } + + my @sorted = sort { $pos{$a} <=> $pos{$b} } @{$sublist}; + + return @sorted; +} + +sub superseded_messages { + my ( $self, $msg ) = @_; + my %superseded = ( + 62 => [36], + 73 => [74], + 74 => [73], + 75 => [76], + 76 => [75], + 84 => [ 73, 74, 75, 76, 80 ], + 88 => [ + 70, 71, 72, 77, 79, 82, 83, 85, 90, 91, 92, 93, 94, 95, 96, 97, 98 + ], + 89 => [ 86, 87 ], + ); + + return @{ $superseded{$msg} // [] }; +} + +# }}} +# {{{ Internal Setters for IRIS.pm + sub set_ar { my ( $self, %attrib ) = @_; if ( $attrib{status} and $attrib{status} eq 'c' ) { + $self->{has_realtime} = $self->{arrival_has_realtime} = 1; $self->{arrival_is_cancelled} = 1; } elsif ( $attrib{status} and $attrib{status} eq 'a' ) { @@ -256,6 +306,10 @@ sub set_ar { $self->{arrival_is_cancelled} = 0; } + if ( $attrib{arrival_hidden} ) { + $self->{arrival_hidden} = $attrib{arrival_hidden}; + } + # unscheduled arrivals may not appear in the plan, but we do need to # know their planned arrival time if ( $attrib{plan_arrival_ts} ) { @@ -264,7 +318,8 @@ sub set_ar { } if ( $attrib{arrival_ts} ) { - $self->{arrival} = $self->parse_ts( $attrib{arrival_ts} ); + $self->{has_realtime} = $self->{arrival_has_realtime} = 1; + $self->{arrival} = $self->parse_ts( $attrib{arrival_ts} ); if ( not $self->{arrival_is_cancelled} ) { $self->{delay} = $self->{arrival_delay} = $self->arrival->subtract_datetime( $self->sched_arrival ) @@ -286,6 +341,7 @@ sub set_ar { if ( defined $attrib{route_pre} ) { $self->{route_pre} = [ split( qr{[|]}, $attrib{route_pre} // q{} ) ]; + $self->fixup_route( $self->{route_pre} ); if ( @{ $self->{route_pre} } ) { $self->{route_start} = $self->{route_pre}[0]; } @@ -299,6 +355,7 @@ sub set_ar { if ( $attrib{sched_route_pre} ) { $self->{sched_route_pre} = [ split( qr{[|]}, $attrib{sched_route_pre} // q{} ) ]; + $self->fixup_route( $self->{sched_route_pre} ); $self->{sched_route_start} = $self->{sched_route_pre}[0]; } @@ -309,6 +366,7 @@ sub set_dp { my ( $self, %attrib ) = @_; if ( $attrib{status} and $attrib{status} eq 'c' ) { + $self->{has_realtime} = $self->{arrival_has_realtime} = 1; $self->{departure_is_cancelled} = 1; } elsif ( $attrib{status} and $attrib{status} eq 'a' ) { @@ -319,6 +377,10 @@ sub set_dp { $self->{departure_is_cancelled} = 0; } + if ( $attrib{departure_hidden} ) { + $self->{departure_hidden} = $attrib{departure_hidden}; + } + # unscheduled arrivals may not appear in the plan, but we do need to # know their planned arrival time if ( $attrib{plan_departure_ts} ) { @@ -327,7 +389,8 @@ sub set_dp { } if ( $attrib{departure_ts} ) { - $self->{departure} = $self->parse_ts( $attrib{departure_ts} ); + $self->{has_realtime} = $self->{departure_has_realtime} = 1; + $self->{departure} = $self->parse_ts( $attrib{departure_ts} ); if ( not $self->{departure_is_cancelled} ) { $self->{delay} = $self->{departure_delay} = $self->departure->subtract_datetime( $self->sched_departure ) @@ -349,6 +412,7 @@ sub set_dp { if ( defined $attrib{route_post} ) { $self->{route_post} = [ split( qr{[|]}, $attrib{route_post} // q{} ) ]; + $self->fixup_route( $self->{route_post} ); if ( @{ $self->{route_post} } ) { $self->{route_end} = $self->{route_post}[-1]; } @@ -362,6 +426,7 @@ sub set_dp { if ( $attrib{sched_route_post} ) { $self->{sched_route_post} = [ split( qr{[|]}, $attrib{sched_route_post} // q{} ) ]; + $self->fixup_route( $self->{sched_route_post} ); $self->{sched_route_end} = $self->{sched_route_post}[-1]; } @@ -396,6 +461,8 @@ sub set_unscheduled { my ( $self, $unscheduled ) = @_; $self->{is_unscheduled} = $unscheduled; + + return $self; } sub add_arrival_wingref { @@ -406,7 +473,7 @@ sub add_arrival_wingref { weaken($ref); weaken($backref); $ref->{is_wing} = 1; - $ref->{wing_of} = $self; + $ref->{wing_of} = $backref; push( @{ $self->{arrival_wings} }, $ref ); return $self; } @@ -419,7 +486,7 @@ sub add_departure_wingref { weaken($ref); weaken($backref); $ref->{is_wing} = 1; - $ref->{wing_of} = $self; + $ref->{wing_of} = $backref; push( @{ $self->{departure_wings} }, $ref ); return $self; } @@ -433,7 +500,37 @@ sub add_reference { return $self; } -# never called externally +sub merge_with_departure { + my ( $self, $result ) = @_; + + # result must be departure-only + + $self->{is_transfer} = 1; + + $self->{old_train_id} = $self->{train_id}; + $self->{old_train_no} = $self->{train_no}; + + # departure is preferred over arrival, so overwrite default values + $self->{date} = $result->{date}; + $self->{time} = $result->{time}; + $self->{epoch} = $result->{epoch}; + $self->{datetime} = $result->{datetime}; + $self->{train_id} = $result->{train_id}; + $self->{train_no} = $result->{train_no}; + + $self->{departure} = $result->{departure}; + $self->{departure_wings} = $result->{departure_wings}; + $self->{route_end} = $result->{route_end}; + $self->{route_post} = $result->{route_post}; + $self->{sched_departure} = $result->{sched_departure}; + $self->{sched_route_post} = $result->{sched_route_post}; + + # update realtime info only if applicable + $self->{is_cancelled} ||= $result->{is_cancelled}; + + return $self; +} + sub add_inverse_reference { my ( $self, $ref ) = @_; @@ -442,23 +539,45 @@ sub add_inverse_reference { return $self; } -# List::Compare does not keep the order of its arguments (even with unsorted). -# So we need to re-sort all stops to maintain their original order. -sub sorted_sublist { - my ( $self, $list, $sublist ) = @_; - my %pos; +# }}} +# {{{ Public Accessors - if ( not $sublist or not @{$sublist} ) { - return; - } +sub is_additional { + my ($self) = @_; - for my $i ( 0 .. $#{$list} ) { - $pos{ $list->[$i] } = $i; + if ( $self->{arrival_is_additional} and $self->{departure_is_additional} ) { + return 1; + } + if ( $self->{arrival_is_additional} + and not defined $self->{departure_is_additional} ) + { + return 1; } + if ( not defined $self->{arrival_is_additional} + and $self->{departure_is_additional} ) + { + return 1; + } + return 0; +} - my @sorted = sort { $pos{$a} <=> $pos{$b} } @{$sublist}; +sub is_cancelled { + my ($self) = @_; - return @sorted; + if ( $self->{arrival_is_cancelled} and $self->{departure_is_cancelled} ) { + return 1; + } + if ( $self->{arrival_is_cancelled} + and not defined $self->{departure_is_cancelled} ) + { + return 1; + } + if ( not defined $self->{arrival_is_cancelled} + and $self->{departure_is_cancelled} ) + { + return 1; + } + return 0; } sub additional_stops { @@ -497,37 +616,6 @@ sub classes { return @classes; } -sub merge_with_departure { - my ( $self, $result ) = @_; - - # result must be departure-only - - $self->{is_transfer} = 1; - - $self->{old_train_id} = $self->{train_id}; - $self->{old_train_no} = $self->{train_no}; - - # departure is preferred over arrival, so overwrite default values - $self->{date} = $result->{date}; - $self->{time} = $result->{time}; - $self->{epoch} = $result->{epoch}; - $self->{datetime} = $result->{datetime}; - $self->{train_id} = $result->{train_id}; - $self->{train_no} = $result->{train_no}; - - $self->{departure} = $result->{departure}; - $self->{departure_wings} = $result->{departure_wings}; - $self->{route_end} = $result->{route_end}; - $self->{route_post} = $result->{route_post}; - $self->{sched_departure} = $result->{sched_departure}; - $self->{sched_route_post} = $result->{sched_route_post}; - - # update realtime info only if applicable - $self->{is_cancelled} ||= $result->{is_cancelled}; - - return $self; -} - sub origin { my ($self) = @_; @@ -543,17 +631,23 @@ sub destination { sub delay_messages { my ($self) = @_; - my @keys = reverse sort keys %{ $self->{messages} }; + my @keys = sort keys %{ $self->{messages} }; my @msgs = grep { $_->[1] eq 'd' } map { $self->{messages}{$_} } @keys; my @msgids = uniq( map { $_->[2] } @msgs ); my @ret; for my $id (@msgids) { - my $msg = firstval { $_->[2] == $id } @msgs; - push( @ret, - [ $self->parse_ts( $msg->[0] ), $self->translate_msg($id) ] ); + for my $superseded ( $self->superseded_messages($id) ) { + @ret = grep { not( $_->[2] == $superseded ) } @ret; + } + my $msg = lastval { $_->[2] == $id } @msgs; + push( @ret, $msg ); } + @ret = reverse + map { [ $self->parse_ts( $_->[0] ), $self->translate_msg( $_->[2] ) ] } + @ret; + return @ret; } @@ -593,23 +687,17 @@ sub replacement_for { return; } -sub dump_message_codes { - my ($self) = @_; - - return %translation; -} - sub qos_messages { my ($self) = @_; my @keys = sort keys %{ $self->{messages} }; my @msgs - = grep { $_->[1] ~~ [qw[f q]] } map { $self->{messages}{$_} } @keys; + = grep { $_->[1] =~ m{^[fq]$} } map { $self->{messages}{$_} } @keys; my @ret; for my $msg (@msgs) { - if ( my @superseded = $self->superseded_messages( $msg->[2] ) ) { - @ret = grep { not( $_->[2] ~~ \@superseded ) } @ret; + for my $superseded ( $self->superseded_messages( $msg->[2] ) ) { + @ret = grep { not( $_->[2] == $superseded ) } @ret; } @ret = grep { $_->[2] != $msg->[2] } @ret; @@ -741,7 +829,7 @@ sub route_interesting { while ( @via_show < $max_parts and @via_main ) { my $stop = shift(@via_main); - if ( $stop ~~ \@via_show or $stop eq $last_stop ) { + if ( any { $stop eq $_ } @via_show or $stop eq $last_stop ) { next; } push( @via_show, $stop ); @@ -775,20 +863,6 @@ sub sched_route { $self->sched_route_post ); } -sub superseded_messages { - my ( $self, $msg ) = @_; - - my %superseded = ( - 84 => [ 80, 82, 85 ], - 88 => [ 80, 82, 83, 85, 86, 87, 90, 91, 92, 93, 96, 97, 98 ], - 89 => [ 86, 87 ], - 96 => [97], - 97 => [96], - ); - - return @{ $superseded{$msg} // [] }; -} - sub translate_msg { my ( $self, $msg ) = @_; @@ -799,13 +873,35 @@ sub TO_JSON { my ($self) = @_; my %copy = %{$self}; - delete $copy{arrival_wings}; - delete $copy{departure_wings}; delete $copy{realtime_xml}; - delete $copy{replaced_by}; - delete $copy{replacement_for}; delete $copy{strptime_obj}; + + for my $ref_key ( + qw(arrival_wings departure_wings replaced_by replacement_for)) + { + delete $copy{$ref_key}; + for my $train_ref ( @{ $self->{$ref_key} // [] } ) { + push( + @{ $copy{$ref_key} }, + { + raw_id => $train_ref->raw_id, + train => $train_ref->train, + train_no => $train_ref->train_no, + type => $train_ref->type, + } + ); + } + } + delete $copy{wing_of}; + if ( my $train_ref = $self->wing_of ) { + $copy{wing_of} = { + raw_id => $train_ref->raw_id, + train => $train_ref->train, + train_no => $train_ref->train_no, + type => $train_ref->type, + }; + } for my $datetime_key ( qw(arrival departure sched_arrival sched_departure start datetime)) @@ -818,6 +914,8 @@ sub TO_JSON { return {%copy}; } +# }}} + 1; __END__ @@ -841,7 +939,7 @@ arrival/departure received by Travel::Status::DE::IRIS =head1 VERSION -version 1.51 +version 1.97 =head1 DESCRIPTION @@ -872,6 +970,15 @@ Estimated arrival delay in minutes (integer number). undef if no realtime data is available, the train starts at the specified station, or there is no scheduled arrival time (e.g. due to diversions). May be negative. +=item $result->arrival_has_realtime + +True if "arrival" is based on real-time data. + +=item $result->arrival_hidden + +True if arrival should not be displayed to customers. +This often indicates an entry-only stop near the beginning of a train's journey. + =item $result->arrival_is_additional True if the arrival at this stop is an additional (unscheduled) event, i.e., @@ -941,6 +1048,15 @@ Estimated departure delay in minutes (integer number). undef if no realtime data is available, the train terminates at the specified station, or there is no scheduled departure time (e.g. due to diversions). May be negative. +=item $result->departure_has_realtime + +True if "departure" is based on real-time data. + +=item $result->departure_hidden + +True if departure should not be displayed to customers. +This often indicates an exit-only stop near the end of a train's journey. + =item $result->departure_is_additional True if the train's departure at this stop is unscheduled (additional), i.e., @@ -961,6 +1077,14 @@ empty list) otherwise. Alias for route_end. +=item $result->has_realtime + +True if arrival or departure time are based on real-time data. Note that this +is different from C<< defined($esult->delay) >>. If delay is defined, some kind +of realtime information for the train is available, but not necessarily its +arrival/departure time. If has_realtime is true, arrival/departure time are +available. This behaviour may change in the future. + =item $result->info List of information strings. Contains both reasons for delays (which may or @@ -1077,15 +1201,15 @@ This is a developer option. It may be removed without prior warning. =item $result->replaced_by -Returns a list of references to Travel::Status::DE::IRIS::Result(3pm) objects -which replace the (usually cancelled) arrival/departure of this train. +Returns a list of weakened references to Travel::Status::DE::IRIS::Result(3pm) +objects which replace the (usually cancelled) arrival/departure of this train. Returns nothing (false / empty list) otherwise. =item $result->replacement_for -Returns a list of references to Travel::Status::DE::IRIS::Result(3pm) objects -which this (usually unplanned) train is meant to replace. -Returns nothing (false / empty list) otherwise. +Returns a list of weakened references to Travel::Status::DE::IRIS::Result(3pm) +objects which this (usually unplanned) train is meant to replace. Returns +nothing (false / empty list) otherwise. =item $result->route @@ -1121,7 +1245,7 @@ train starts here. =item $result->sched_departure -DateTime(3pm) object for the scehduled departure date and time. undef if the +DateTime(3pm) object for the scheduled departure date and time. undef if the train ends here. =item $result->sched_platform @@ -1160,7 +1284,7 @@ DateTime(3pm) object for the scheduled start of the train on its route Name of the station this train result belongs to. -=item $result->station_uic +=item $result->station_eva EVA number of the station this train result belongs to. This is often, but not always, identical with the UIC station number. @@ -1215,258 +1339,6 @@ You usually do not need to call this. =back -=head1 MESSAGES - -A dump of all messages entered for the result is available. Each message -consists of a timestamp (when it was entered), a type (d for delay reasons, -q for other train-related information) and a value (numeric ID). - -At the time of this writing, the following messages are known: - -=over - -=item d 2 : "Polizeiliche Ermittlung" - -=item d 3 : "Feuerwehreinsatz neben der Strecke" - -=item d 5 : "E<Auml>rztliche Versorgung eines Fahrgastes" - -=item d 6 : "BetE<auml>tigen der Notbremse" - -Source: Correlation between IRIS and DB RIS (bahn.de). - -=item d 7 : "Personen im Gleis" - -=item d 8 : "Notarzteinsatz am Gleis" - -=item d 9 : "Streikauswirkungen" - -=item d 10 : "Ausgebrochene Tiere im Gleis" - -=item d 11 : "Unwetter" - -=item d 13 : "Pass- und Zollkontrolle" - -Source: Correlation between IRIS and DB RIS (bahn.de). - -=item d 15 : "BeeintrE<auml>chtigung durch Vandalismus" - -=item d 16 : "EntschE<auml>rfung einer Fliegerbombe" - -=item d 17 : "BeschE<auml>digung einer BrE<uuml>cke" - -=item d 18 : "UmgestE<uuml>rzter Baum im Gleis" - -=item d 19 : "Unfall an einem BahnE<uuml>bergang" - -=item d 20 : "Tiere im Gleis" - -=item d 21 : "Warten auf weitere Reisende" - -=item d 22 : "Witterungsbedingte StE<ouml>rung" - -=item d 23 : "Feuerwehreinsatz auf BahngelE<auml>nde" - -=item d 24 : "VerspE<auml>tung aus dem Ausland" - -=item d 25 : "Warten auf verspE<auml>tete Zugteile" - -=item d 28 : "GegenstE<auml>nde im Gleis" - -=item d 31 : "Bauarbeiten" - -=item d 32 : "VerzE<ouml>gerung beim Ein-/Ausstieg" - -=item d 33 : "OberleitungsstE<ouml>rung" - -=item d 34 : "SignalstE<ouml>rung" - -=item d 35 : "Streckensperrung" - -=item d 36 : "Technische StE<ouml>rung am Zug" - -=item d 37 : "Technische StE<ouml>rung am Wagen" - -=item d 38 : "Technische StE<ouml>rung an der Strecke" - -=item d 39 : "AnhE<auml>ngen von zusE<auml>tzlichen Wagen" - -=item d 40 : "StellwerksstE<ouml>rung/-ausfall" - -=item d 41 : "StE<ouml>rung an einem BahnE<uuml>bergang" - -=item d 42 : "AuE<szlig>erplanmE<auml>E<szlig>ige GeschwindigkeitsbeschrE<auml>nkung" - -=item d 43 : "VerspE<auml>tung eines vorausfahrenden Zuges" - -=item d 44 : "Warten auf einen entgegenkommenden Zug" - -=item d 45 : "E<Uuml>berholung durch anderen Zug" - -=item d 46 : "Warten auf freie Einfahrt" - -=item d 47 : "VerspE<auml>tete Bereitstellung" - -=item d 48 : "VerspE<auml>tung aus vorheriger Fahrt" - -=item d 55 : "Technische StE<ouml>rung an einem anderen Zug" - -Source: Correlation between IRIS and DB RIS (bahn.de). - -=item d 56 : "Warten auf FahrgE<auml>ste aus einem Bus" - -Source: Correlation between IRIS and DB RIS (bahn.de). - -=item d 57 : "ZusE<auml>tzlicher Halt" - -Source: Correlation between IRIS and DB RIS (bahn.de). - -=item d 58 : "Umleitung" - -Source: Correlation between IRIS and DB RIS (bahn.de). Several entries, related -to "Notarzteinsatz am Gleis". - -=item d 59 : "Schnee und Eis" - -Source: Correlation between IRIS and DB RIS (bahn.de). - -=item d 60 : "Reduzierte Geschwindigkeit wegen Sturm" - -Source: Correlation between IRIS and DB RIS (bahn.de). - -=item d 61 : "TE<uuml>rstE<ouml>rung" - -Source: Correlation between IRIS and DB RIS (bahn.de). - -=item d 62 : "Behobene technische StE<ouml>rung am Zug" - -Source: Correlation between IRIS and DB RIS (bahn.de). - -=item d 63 : "Technische Untersuchung am Zug" - -=item d 64 : "WeichenstE<ouml>rung" - -Source: correlation between IRIS and DB RIS (bahn.de). - -=item d 65 : "Erdrutsch" - -Source: correlation between IRIS and DB RIS (bahn.de). - -=item d 66 : "Hochwasser" - -Source: correlation between IRIS and DB RIS (bahn.de). - -=item f 67 : "BehE<ouml>rdliche Anordnung" - -Source: L<https://twitter.com/DodoMedia/status/1238816272240070659>. - -=item q 70 : "WLAN nicht verfE<uuml>gbar" - -Source: correlation between IRIS and DB RIS (bahn.de). - -=item q 71 : "WLAN in einzelnen Wagen nicht verfE<uuml>gbar" - -=item q 72 : "Info/Entertainment nicht verfE<uuml>gbar" - -=item q 73 : "Mehrzweckabteil vorne" - -Source: correlation between IRIS and DB RIS (bahn.de). - -=item q 74 : "Mehrzweckabteil hinten" - -Source: correlation between IRIS and DB RIS (bahn.de). - -=item q 75 : "1. Klasse vorne" - -Source: correlation between IRIS and DB RIS (bahn.de). - -=item q 76 : "1. Klasse hinten" - -Source: correlation between IRIS and DB RIS (bahn.de). - -=item q 77 : "Ohne 1. Klasse" - -Source: correlation between IRIS and DB RIS (bahn.de). - -=item q 79 : "Ohne Mehrzweckabteil" - -Source: correlation between IRIS and DB RIS (bahn.de). - -=item q 80 : "Abweichende Wagenreihung" - -Verified by L<https://iris.noncd.db.de/irisWebclient/Configuration>. - -=item q 82 : "Mehrere Wagen fehlen" - -Verified by L<https://iris.noncd.db.de/irisWebclient/Configuration>. - -=item q 83 : "StE<ouml>rung der fahrzeuggebundenen Einstiegshilfe" - -=item q 84 : "Zug verkehrt richtig gereiht" - -Obsoletes messages 80, 82, 85. -Verified by L<https://iris.noncd.db.de/irisWebclient/Configuration>. - -=item q 85 : "Ein Wagen fehlt" - -Verified by L<https://iris.noncd.db.de/irisWebclient/Configuration>. - -=item q 86 : "Keine Reservierungsanzeige" - -Verified by L<https://iris.noncd.db.de/irisWebclient/Configuration>. - -=item q 87 : "Einzelne Wagen ohne Reservierungsanzeige" - -Verified by L<https://iris.noncd.db.de/irisWebclient/Configuration>. - -=item q 88 : "Keine QualitE<auml>tsmE<auml>ngel" - -Obsoletes messages 80, 82, 83, 85, 86, 87, 90, 91, 92, 93, 96, 97, 98. -Verified by L<https://iris.noncd.db.de/irisWebclient/Configuration>. - -=item q 89 : "Reservierungen sind wieder vorhanden" - -Obsoletes messages 86, 87. -Verified by L<https://iris.noncd.db.de/irisWebclient/Configuration>. - -=item q 90 : "Kein gastronomisches Angebot" - -Verified by L<https://iris.noncd.db.de/irisWebclient/Configuration>. - -=item q 91 : "EingeschrE<auml>nkte FahrradbefE<ouml>rderung" - -=item q 92 : "Keine FahrradbefE<ouml>rderung" - -=item q 93 : "Fehlende oder gestE<ouml>rte behindertengerechte Einrichtung" - -Verified by L<https://iris.noncd.db.de/irisWebclient/Configuration>. -Might also mean "Kein rollstuhlgerechtes WC" (source: frubi). - -=item q 94 : "Ersatzbewirtschaftung" - -Estimated from a comparison with bahn.de/ris messages. Needs to be verified. - -=item q 95 : "Ohne behindertengerechtes WC" - -Estimated from a comparison with bahn.de/iris messages. - -=item q 96 : "Der Zug ist stark E<uuml>berbesetzt" - -Verified by L<https://iris.noncd.db.de/irisWebclient/Configuration>. - -=item q 97 : "Der Zug ist E<uuml>berbesetzt" - -Verified by L<https://iris.noncd.db.de/irisWebclient/Configuration>. - -=item q 98 : "Sonstige QualitE<auml>tsmE<auml>ngel" - -Verified by L<https://iris.noncd.db.de/irisWebclient/Configuration>. -Might also mean "Kein rollstuhlgerechter Wagen" (source: frubi). - -=item d 99 : "VerzE<ouml>gerungen im Betriebsablauf" - -=back - =head1 DIAGNOSTICS None. @@ -1489,7 +1361,7 @@ Travel::Status::DE::IRIS(3pm). =head1 AUTHOR -Copyright (C) 2013-2020 by Daniel Friesel E<lt>derf@finalrewind.orgE<gt> +Copyright (C) 2013-2024 by Birte Kristina Friesel E<lt>derf@finalrewind.orgE<gt> =head1 LICENSE diff --git a/lib/Travel/Status/DE/IRIS/Stations.pm.PL b/lib/Travel/Status/DE/IRIS/Stations.pm.PL index 3547448..bbb1299 100644 --- a/lib/Travel/Status/DE/IRIS/Stations.pm.PL +++ b/lib/Travel/Status/DE/IRIS/Stations.pm.PL @@ -10,6 +10,9 @@ use JSON; my $json_str = read_file('share/stations.json'); my $stations = JSON->new->utf8->decode($json_str); +my $meta_str = read_file('share/meta.json'); +my $meta = JSON->new->utf8->decode($meta_str); + my $buf = <<'EOF'; package Travel::Status::DE::IRIS::Stations; @@ -23,19 +26,15 @@ use warnings; use 5.014; use utf8; -use Geo::Distance; +use GIS::Distance; use List::Util qw(min); use List::UtilsBy qw(uniq_by); use List::MoreUtils qw(firstval pairwise); use Text::LevenshteinXS qw(distance); -# TODO Geo::Distance is kinda deprecated, it is recommended to use GIS::Distance -# instead. However, since GIS::Distance is not packaged for Debian, I'll stick -# with Geo::Distance for now (which works fine enough here) - # TODO switch to Text::Levenshtein::XS once AUR/Debian packages become available -our $VERSION = '1.51'; +our $VERSION = '1.97'; # Automatically generated, see share/stations.json my @stations = ( @@ -59,10 +58,25 @@ for my $station ( @{$stations} ) { $buf .= <<'EOF'; ); +# Automatically generated, see share/meta.json +my $meta = { +EOF + +for my $eva ( keys %{$meta} ) { + $buf .= sprintf( "%s => [%s],\n", $eva, join( q{,}, @{ $meta->{$eva} } ) ); +} + +$buf .= <<'EOF'; +}; + sub get_stations { return @stations; } +sub get_meta { + return $meta; +} + sub normalize { my ($val) = @_; @@ -80,6 +94,10 @@ sub normalize { sub get_station { my ($name) = @_; + if (not $name) { + return; + } + my $ds100_match = firstval { $name eq $_->[0] } @stations; if ($ds100_match) { @@ -100,7 +118,7 @@ sub get_station_by_location { $num_matches //= 10; - my $geo = Geo::Distance->new(); + my $dist = GIS::Distance->new(); # we only use geolocations inside germany. # For these, this fast preprocessing step will let through all @@ -111,9 +129,8 @@ sub get_station_by_location { and abs( $_->[4] - $lat ) < 1 } @stations; - my @distances - = map { $geo->distance( 'kilometer', $lon, $lat, $_->[3], $_->[4] ) } - @candidates; + my @distances = map + { $dist->distance_metal( $lat, $lon, $_->[4], $_->[3] ) } @candidates; my @station_map = pairwise { [ $a, $b ] } @candidates, @distances; @station_map = sort { $a->[1] <=> $b->[1] } @station_map; @@ -125,6 +142,10 @@ sub get_station_by_location { sub get_station_by_name { my ($name) = @_; + if (not $name) { + return; + } + my $nname = lc($name); my $actual_match = firstval { $nname eq lc( $_->[1] ) } @stations; @@ -183,7 +204,7 @@ Travel::Status::DE::IRIS::Stations - Station name to station code mapping =head1 VERSION -version 1.51 +version 1.97 =head1 DESCRIPTION @@ -212,6 +233,10 @@ that it may contain space characters. =back +Note that station names are not unique. +A single station may be present multiple times with different EVA numbers and DS100 codes. +At the moment, EVA numbers and DS100 codes are unique. + =head1 METHODS =over @@ -224,7 +249,7 @@ Returns a list of all known stations, lexically sorted by station name. Returns a list of stations matching I<$in>. -If a I<$in> is a valid station (either DS100 code or EVA number), +If a I<$in> is a valid station identifier (either DS100 code or EVA number), a single array reference describing the station is returned. Otherwise, I<$in> is passed to get_station_by_name(I<$in>) (see below). @@ -237,18 +262,17 @@ returns the closest I<$num_matches> (defaults to 10) matches. Note that stations which are located more than 70 kilometers away from I<$lon>/I<$lat> may be ignored when computing the closest matches. -Note that location-based lookup is only supported for stations inside Germany, -since the station list data source does not provide geolocation data for -non-german stations. - =item Travel::Status::DE::IRIS::Stations::get_station_by_name(I<$name>) Returns a list of stations where the station name matches I<$name>. Matching happens in two steps: If a case-insensitive exact match exists, only -this one is returned. Otherwise, all stations whose name contains I<$name> as -a substring (also case-insensitive) and all stations whose name has a low -Levenshtein distance to I<$name> are returned. +this one is returned. For station names that correspond to several EVA/DS100 +codes, the match with the lowest EVA number is returned. + +Otherwise, all stations whose name contains I<$name> as a substring (also +case-insensitive) and all stations whose name has a low Levenshtein distance to +I<$name> are returned. This two-step behaviour makes sure that not-prefix-free stations can still be matched directly. For instance, both "Essen-Steele" and "Essen-Steele Ost" @@ -264,7 +288,7 @@ None. =over -=item * Geo::Distance(3pm) +=item * GIS::Distance(3pm) =item * List::MoreUtils(3pm) @@ -287,7 +311,7 @@ Travel::Status::DE::IRIS(3pm). Station data: Copyright (C) 2016 by DB Station&Service AG, Europaplatz 1, 10557 Berlin, Germany -Lookup code: Copyright (C) 2014-2020 by Daniel Friesel E<lt>derf@finalrewind.orgE<gt> +Lookup code: Copyright (C) 2014-2024 by Birte Kristina Friesel E<lt>derf@finalrewind.orgE<gt> =head1 LICENSE |