Skip to content

Keep cancelled trips & skipped stop times from GTFS-RT Trip Updates #99

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mmathieum merged 7 commits into from
Mar 23, 2026
Merged

Keep cancelled trips & skipped stop times from GTFS-RT Trip Updates #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a221af2
Initial plan
Copilot Mar 23, 2026
dc69d1e
Add cancelled trip & skipped stop support in GTFS-RT Trip Updates
Copilot Mar 23, 2026
7dcdd67
Use optBoolean in ScheduleStatusFilter.fromJSON for safer JSON parsing
Copilot Mar 23, 2026
61e9bf3
Remove accidentally committed gradle wrapper files
Copilot Mar 23, 2026
ba0513d
cleanup
mmathieum Mar 23, 2026
368145f
missing part
mmathieum Mar 23, 2026
fbafc2e
wip
mmathieum Mar 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 61 additions & 26 deletions src/main/java/org/mtransit/android/commons/data/Schedule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
import java.util.TimeZone;
import java.util.concurrent.TimeUnit;

@SuppressWarnings({"unused", "WeakerAccess"})
@SuppressWarnings("WeakerAccess")
public class Schedule extends POIStatus implements MTLog.Loggable {

private static final String LOG_TAG = Schedule.class.getSimpleName();
Expand Down Expand Up @@ -189,6 +189,7 @@ public void setNoPickup(boolean noPickup) {
this.noPickup = noPickup;
}

@SuppressWarnings("unused")
public void setNoPickupTimestamps(boolean noPickup) {
for (Timestamp timestamp : this.timestamps) {
if (noPickup) {
Expand Down Expand Up @@ -318,6 +319,7 @@ public int compare(Frequency lhs, Frequency rhs) {
}
}

@SuppressWarnings("unused")
public static class Frequency implements MTLog.Loggable {

private static final String LOG_TAG = Frequency.class.getSimpleName();
Expand Down Expand Up @@ -452,6 +454,8 @@ public String getLogTag() {
@Nullable
private Integer accessible = null;
@Nullable
private Boolean cancelled = null;
@Nullable
private String tripId = null; // cleaned trip ID (string) // initial used to store trip id INT but replaced after
private int stopSequence = -1;
@Nullable
Expand Down Expand Up @@ -550,6 +554,7 @@ public boolean hasHeadsign() {
return this.headsignType != Direction.HEADSIGN_TYPE_NONE && !TextUtils.isEmpty(this.headsignValue);
}

@SuppressWarnings("unused") // main app
@NonNull
public String getUIHeading(@NonNull Context context, boolean small) {
final String headSignUC = getHeading(context);
Expand Down Expand Up @@ -620,15 +625,12 @@ public void setRealTime(@Nullable Boolean realTime) {
this.realTime = realTime;
}

@SuppressWarnings("unused") // kotlin var
@Nullable
public Boolean getRealTime() {
return this.realTime;
}

boolean hasRealTime() {
return this.realTime != null;
}

public boolean isRealTime() {
return Boolean.TRUE.equals(this.realTime);
}
Expand All @@ -637,15 +639,12 @@ public void setOldSchedule(@Nullable Boolean oldSchedule) {
this.oldSchedule = oldSchedule;
}

@SuppressWarnings("unused") // kotlin var
@Nullable
public Boolean getOldSchedule() {
return this.oldSchedule;
}

boolean hasOldSchedule() {
return this.oldSchedule != null;
}

public boolean isOldSchedule() {
return Boolean.TRUE.equals(this.oldSchedule);
}
Expand All @@ -659,14 +658,24 @@ public Integer getAccessible() {
return accessible;
}

public boolean hasAccessible() {
return this.accessible != null;
}

@SuppressWarnings("unused") // main app
public int getAccessibleOrDefault() {
return this.accessible == null ? Accessibility.DEFAULT : this.accessible;
}

public void setCancelled(@Nullable Boolean cancelled) {
this.cancelled = cancelled;
}

@Nullable
public Boolean getCancelled() {
return cancelled;
}

public boolean isCancelled() {
return Boolean.TRUE.equals(this.cancelled);
}

public void setTripId(@Nullable String tripId) {
this.tripId = tripId;
}
Expand Down Expand Up @@ -701,6 +710,7 @@ public boolean equals(Object o) {
if (!Objects.equals(realTime, timestamp.realTime)) return false;
if (!Objects.equals(oldSchedule, timestamp.oldSchedule)) return false;
if (!Objects.equals(accessible, timestamp.accessible)) return false;
if (!Objects.equals(cancelled, timestamp.cancelled)) return false;
if (!Objects.equals(tripId, timestamp.tripId)) return false;
if (stopSequence != timestamp.stopSequence) return false;
if (!Objects.equals(arrivalDiffMs, timestamp.arrivalDiffMs)) return false;
Expand All @@ -719,6 +729,7 @@ public int hashCode() {
result = 31 * result + (realTime != null ? realTime.hashCode() : 0);
result = 31 * result + (oldSchedule != null ? oldSchedule.hashCode() : 0);
result = 31 * result + (accessible != null ? accessible : 0);
result = 31 * result + (cancelled != null ? cancelled.hashCode() : 0);
result = 31 * result + (tripId != null ? tripId.hashCode() : 0);
result = 31 * result + stopSequence;
result = 31 * result + (arrivalDiffMs != null ? arrivalDiffMs.hashCode() : 0);
Expand Down Expand Up @@ -766,6 +777,9 @@ public String toString() {
if (accessible != null) {
sb.append(", a11y:").append(accessible);
}
if (cancelled != null) {
sb.append(", cancelled:").append(cancelled);
}
sb.append('}');
return sb.toString();
}
Expand All @@ -782,6 +796,7 @@ public String toString() {
private static final String JSON_REAL_TIME = "rt";
private static final String JSON_OLD_SCHEDULE = "old";
private static final String JSON_ACCESSIBLE = "a11y";
private static final String JSON_CANCELLED = "cancelled";

@Nullable
static Timestamp parseJSON(@NonNull JSONObject jTimestamp) {
Expand Down Expand Up @@ -827,6 +842,9 @@ static Timestamp parseJSON(@NonNull JSONObject jTimestamp) {
if (jTimestamp.has(JSON_ACCESSIBLE)) {
timestamp.setAccessible(jTimestamp.optInt(JSON_ACCESSIBLE, Accessibility.DEFAULT));
}
if (jTimestamp.has(JSON_CANCELLED)) {
timestamp.setCancelled(jTimestamp.optBoolean(JSON_CANCELLED, false));
}
return timestamp;
} catch (JSONException jsone) {
MTLog.w(LOG_TAG, jsone, "Error while parsing JSON object '%s'!", jTimestamp);
Expand Down Expand Up @@ -870,15 +888,18 @@ public static JSONObject toJSON(@NonNull Timestamp timestamp) {
if (timestamp.localTimeZoneId != null) {
jTimestamp.put(JSON_LOCAL_TIME_ZONE, timestamp.localTimeZoneId);
}
if (timestamp.hasRealTime()) {
if (timestamp.realTime != null) {
jTimestamp.put(JSON_REAL_TIME, timestamp.realTime);
}
if (timestamp.hasOldSchedule()) {
if (timestamp.oldSchedule != null) {
jTimestamp.put(JSON_OLD_SCHEDULE, timestamp.oldSchedule);
}
if (timestamp.hasAccessible()) {
if (timestamp.accessible != null) {
jTimestamp.put(JSON_ACCESSIBLE, timestamp.accessible);
}
if (timestamp.cancelled != null) {
jTimestamp.put(JSON_CANCELLED, timestamp.cancelled);
}
return jTimestamp;
} catch (Exception e) {
MTLog.w(LOG_TAG, e, "Error while converting object '%s' to JSON!", timestamp);
Expand All @@ -897,6 +918,7 @@ public String getLogTag() {
return LOG_TAG;
}

@SuppressWarnings("unused") // main app
public static final int DATA_REQUEST_MONTHS = 62;
@SuppressWarnings("unused")
public static final int DATA_REQUEST_YEAR = 365;
Expand All @@ -916,10 +938,8 @@ public String getLogTag() {
private Integer minUsefulResults = null;
@Nullable
private Integer maxDataRequests = null;

public ScheduleStatusFilter(@NonNull String targetUUID, @NonNull RouteDirectionStop rds) {
this(rds);
}
@Nullable
private Boolean includeCancelledTimestamps = null;

public ScheduleStatusFilter(@NonNull RouteDirectionStop rds) {
super(POI.ITEM_STATUS_TYPE_SCHEDULE, rds.getUUID());
Expand Down Expand Up @@ -982,6 +1002,15 @@ public void setMaxDataRequests(@Nullable Integer maxDataRequests) {
this.maxDataRequests = maxDataRequests;
}

public boolean isIncludeCancelledTimestampsOrDefault() {
return Boolean.TRUE.equals(this.includeCancelledTimestamps);
}

@SuppressWarnings("unused") // main app
public void setIncludeCancelledTimestamps(@Nullable Boolean includeCancelledTimestamps) {
this.includeCancelledTimestamps = includeCancelledTimestamps;
}

private static long getNewDefaultTimestamp() {
return TimeUtils.currentTimeToTheMinuteMillis();
}
Expand All @@ -1007,22 +1036,24 @@ public static StatusProviderContract.Filter fromJSONString(@Nullable String json
private static final String JSON_MAX_DATA_REQUESTS = "maxDataRequests";
private static final String JSON_ROUTE_DIRECTION_STOP = "routeTripStop"; // do not change to avoid breaking compat w/ old modules
private static final String JSON_LOOK_BEHIND_IN_MS = "lookBehindInMs";
private static final String JSON_INCLUDE_CANCELLED_TIMESTAMPS = "includeCancelledTimestamps";

@Nullable
public static StatusProviderContract.Filter fromJSON(@NonNull JSONObject json) {
try {
String targetUUID = StatusProviderContract.Filter.getTargetUUIDFromJSON(json);
RouteDirectionStop routeDirectionStop = RouteDirectionStop.fromJSONStatic(json.getJSONObject(JSON_ROUTE_DIRECTION_STOP));
final RouteDirectionStop routeDirectionStop = RouteDirectionStop.fromJSONStatic(json.getJSONObject(JSON_ROUTE_DIRECTION_STOP));
if (routeDirectionStop == null) {
return null;
}
ScheduleStatusFilter scheduleStatusFilter = new ScheduleStatusFilter(targetUUID, routeDirectionStop);
final ScheduleStatusFilter scheduleStatusFilter = new ScheduleStatusFilter(routeDirectionStop);
StatusProviderContract.Filter.fromJSON(scheduleStatusFilter, json);
scheduleStatusFilter.lookBehindInMs = json.has(JSON_LOOK_BEHIND_IN_MS) ? json.getLong(JSON_LOOK_BEHIND_IN_MS) : null;
scheduleStatusFilter.minUsefulDurationCoveredInMs =
json.has(JSON_MIN_USEFUL_DURATION_COVERED_IN_MS) ? json.getLong(JSON_MIN_USEFUL_DURATION_COVERED_IN_MS) : null;
scheduleStatusFilter.minUsefulResults = json.has(JSON_MIN_USEFUL_RESULTS) ? json.getInt(JSON_MIN_USEFUL_RESULTS) : null;
scheduleStatusFilter.maxDataRequests = json.has(JSON_MAX_DATA_REQUESTS) ? json.getInt(JSON_MAX_DATA_REQUESTS) : null;
scheduleStatusFilter.includeCancelledTimestamps =
json.has(JSON_INCLUDE_CANCELLED_TIMESTAMPS) ? json.optBoolean(JSON_INCLUDE_CANCELLED_TIMESTAMPS, false) : null;
return scheduleStatusFilter;
} catch (JSONException jsone) {
MTLog.w(LOG_TAG, jsone, "Error while parsing JSON object '%s'", json);
Expand All @@ -1038,17 +1069,17 @@ public String toJSONStringStatic(@NonNull StatusProviderContract.Filter statusFi

@Nullable
static String toJSONString(@NonNull StatusProviderContract.Filter statusFilter) {
JSONObject json = toJSON(statusFilter);
final JSONObject json = toJSON(statusFilter);
return json == null ? null : json.toString();
}

@Nullable
public static JSONObject toJSON(@NonNull StatusProviderContract.Filter statusFilter) {
try {
JSONObject json = new JSONObject();
final JSONObject json = new JSONObject();
StatusProviderContract.Filter.toJSON(statusFilter, json);
if (statusFilter instanceof ScheduleStatusFilter) {
ScheduleStatusFilter scheduleFilter = (ScheduleStatusFilter) statusFilter;
final ScheduleStatusFilter scheduleFilter = (ScheduleStatusFilter) statusFilter;
json.put(JSON_ROUTE_DIRECTION_STOP, scheduleFilter.routeDirectionStop.toJSON());
if (scheduleFilter.lookBehindInMs != null) {
json.put(JSON_LOOK_BEHIND_IN_MS, scheduleFilter.lookBehindInMs);
Expand All @@ -1062,6 +1093,9 @@ public static JSONObject toJSON(@NonNull StatusProviderContract.Filter statusFil
if (scheduleFilter.maxDataRequests != null) {
json.put(JSON_MAX_DATA_REQUESTS, scheduleFilter.maxDataRequests);
}
if (scheduleFilter.includeCancelledTimestamps != null) {
json.put(JSON_INCLUDE_CANCELLED_TIMESTAMPS, scheduleFilter.includeCancelledTimestamps);
}
}
return json;
} catch (JSONException jsone) {
Expand All @@ -1080,6 +1114,7 @@ public String toString() {
", minUsefulDurationCoveredInMs=" + minUsefulDurationCoveredInMs +
", minUsefulResults=" + minUsefulResults +
", maxDataRequests=" + maxDataRequests +
", includeCancelledTimestamps=" + includeCancelledTimestamps +
'}';
}
}
Expand Down
5 changes: 4 additions & 1 deletion src/main/java/org/mtransit/android/commons/provider/gtfs/GtfsStatusProviderExt.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,15 @@ import kotlin.time.Duration.Companion.hours
fun Context.getRDSSchedule(
authority: String,
rdsList: Iterable<RouteDirectionStop>,
includeCancelledTimestamps: Boolean = false,
) = rdsList.mapNotNull {
getRDSSchedule(authority, it)
getRDSSchedule(authority, it, includeCancelledTimestamps)
}

fun Context.getRDSSchedule(
authority: String,
rds: RouteDirectionStop,
includeCancelledTimestamps: Boolean = false,
): Schedule? = try {
contentResolver.query(
Uri.withAppendedPath(
Expand All @@ -29,6 +31,7 @@ fun Context.getRDSSchedule(
Schedule.ScheduleStatusFilter(rds).apply {
setLookBehindInMs(1.hours.inWholeMilliseconds)
setMaxDataRequests(3) // yesterday service ending + today + tomorrow?
setIncludeCancelledTimestamps(includeCancelledTimestamps)
}.let { it.toJSONStringStatic(it) },
null,
null
Expand Down
4 changes: 2 additions & 2 deletions ...main/java/org/mtransit/android/commons/provider/status/GTFSRealTimeTripUpdatesProvider.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,13 +155,13 @@ object GTFSRealTimeTripUpdatesProvider : MTLog.Loggable {
uuidSchedule = sortedRDS
?.let { rdsList ->
context
.getRDSSchedule(targetAuthority, rdsList)
.getRDSSchedule(targetAuthority, rdsList, filter.isIncludeCancelledTimestampsOrDefault)
.associateBy { it.targetUUID }
}
}
uuidSchedule ?: return null
sortedRDS ?: return null
processRDTripUpdates(rdTripUpdates, uuidSchedule, sortedRDS)
processRDTripUpdates(rdTripUpdates, uuidSchedule, sortedRDS, filter.isIncludeCancelledTimestampsOrDefault)
val tripsWithRealTime = uuidSchedule.values
.asSequence()
.mapNotNull { it?.timestamps }.flatten()
Expand Down
Loading