Half fix channel sorting on Sony TVs

It's impossible for us to fully fix this, as soon as a new channel is added or
updated, it will be added at the end no matter what channel number it is.

This only proper fix for this can come from Sony.

In the meantime, Sony users must uninstall, reinstall, and resetup the app in
order to resort the channels

Fixes #92

Author: kiall

app/src/main/java/ie/macinnes/tvheadend/sync/EpgSyncTask.java

@@ -39,6 +39,8 @@
 import java.io.OutputStream;
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Collections;
+import java.util.Comparator;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Queue;
@@ -62,6 +64,8 @@ public class EpgSyncTask implements HtspMessage.Listener, Authenticator.Listener
             "eventAdd", "eventUpdate", "eventDelete",
             "initialSyncCompleted",
     }));
+    private static final boolean IS_BRAVIA = Build.MODEL.contains("BRAVIA");
+
     private static final String CHANNEL_ID_KEY = "channelId";
     private static final String CHANNEL_NUMBER_KEY = "channelNumber";
     private static final String CHANNEL_NUMBER_MINOR_KEY = "channelNumberMinor";
@@ -118,15 +122,27 @@ public interface Listener {
     private final SparseArray<Uri> mChannelUriMap;
     private final SparseArray<Uri> mProgramUriMap;
 
-    private final SparseArray<ContentProviderOperation> mPendingChannelOps = new SparseArray<>();
-    private final SparseArray<ContentProviderOperation> mPendingProgramOps = new SparseArray<>();
+    private final ArrayList<PendingChannelAddUpdate> mPendingChannelOps = new ArrayList<>();
+    private final ArrayList<PendingEventAddUpdate> mPendingProgramOps = new ArrayList<>();
 
     private final Queue<PendingChannelLogoFetch> mPendingChannelLogoFetches = new ConcurrentLinkedQueue<>();
     private final byte[] mImageBytes = new byte[102400];
 
     private Set<Integer> mSeenChannels = new HashSet<>();
     private Set<Integer> mSeenPrograms = new HashSet<>();
 
+    private final class PendingChannelAddUpdate {
+        public int channelId;
+        public int channelNumber;
+        public ContentProviderOperation operation;
+
+        public PendingChannelAddUpdate(int channelId, int channelNumber, ContentProviderOperation operation) {
+            this.channelId = channelId;
+            this.channelNumber = channelNumber;
+            this.operation = operation;
+        }
+    }
+
     private final class PendingChannelLogoFetch {
         public int channelId;
         public Uri logoUri;
@@ -137,6 +153,16 @@ public PendingChannelLogoFetch(int channelId, Uri logoUri) {
         }
     }
 
+    private final class PendingEventAddUpdate {
+        public int eventId;
+        public ContentProviderOperation operation;
+
+        public PendingEventAddUpdate(int eventId, ContentProviderOperation operation) {
+            this.eventId = eventId;
+            this.operation = operation;
+        }
+    }
+
     public EpgSyncTask(Context context, @NonNull HtspMessage.Dispatcher dispatcher, boolean quickSync) {
         this(context, dispatcher);
 
@@ -295,27 +321,32 @@ private void handleChannelAddUpdate(@NonNull HtspMessage message) {
             // Insert the channel
             if (Constants.DEBUG)
                 Log.v(TAG, "Insert channel " + channelId);
-            mPendingChannelOps.put(
-                    channelId,
+            final int channelNumber = message.getInteger(CHANNEL_NUMBER_KEY);
+            mPendingChannelOps.add(new PendingChannelAddUpdate(
+                    channelId, channelNumber,
                     ContentProviderOperation.newInsert(TvContract.Channels.CONTENT_URI)
-                            .withValues(values)
-                            .build()
-            );
+                        .withValues(values)
+                        .build()
+            ));
         } else {
             // Update the channel
             if (Constants.DEBUG)
                 Log.v(TAG, "Update channel " + channelId);
-            mPendingChannelOps.put(
-                    channelId,
+            mPendingChannelOps.add(new PendingChannelAddUpdate(
+                    channelId, -1,
                     ContentProviderOperation.newUpdate(channelUri)
                             .withValues(values)
                             .build()
-            );
+            ));
         }
 
-        // Throttle the batch operation not to cause TransactionTooLargeException. If the initial
-        // sync has already completed, flush for every message.
-        if (mInitialSyncCompleted || mPendingChannelOps.size() >= 500) {
+        if (mInitialSyncCompleted) {
+            flushPendingChannelOps();
+        } else if (!IS_BRAVIA && mPendingChannelOps.size() >= 100) {
+            // Throttle the batch operation not to cause TransactionTooLargeException. If the initial
+            // sync has already completed, flush for every message. Additionally, we have no choice
+            // on a Sony set but to not flush until we have all the channels, as sony's EPG view
+            // is buggy.
             flushPendingChannelOps();
         }
 
@@ -333,10 +364,31 @@ private void flushPendingChannelOps() {
 
         Log.d(TAG, "Flushing " + mPendingChannelOps.size() + " channel operations");
 
+        if (IS_BRAVIA) {
+            // Sort the Pending Add/Updates by their channel numbers as Sony fails to do this in
+            // their EPG view.
+            Collections.sort(mPendingChannelOps, new Comparator<PendingChannelAddUpdate>() {
+                @Override
+                public int compare(PendingChannelAddUpdate o1, PendingChannelAddUpdate o2) {
+                    if (o1.channelNumber == -1 || o2.channelNumber == -1) {
+                        // One of the events is a channelUpdate, no need (or ability) to sort it
+                        return 0;
+                    }
+                    if (o1.channelNumber > o2.channelNumber) {
+                        return 1;
+                    } else if (o1.channelNumber == o2.channelNumber) {
+                        return 0;
+                    }
+
+                    return -1;
+                }
+            });
+        }
+
         // Build out an ArrayList of Operations needed for applyBatch()
         ArrayList<ContentProviderOperation> operations = new ArrayList<>(mPendingChannelOps.size());
-        for (int i = 0; i < mPendingChannelOps.size(); i++) {
-            operations.add(mPendingChannelOps.valueAt(i));
+        for (PendingChannelAddUpdate pcau : mPendingChannelOps) {
+            operations.add(pcau.operation);
         }
 
         // Apply the batch of Operations
@@ -360,7 +412,7 @@ private void flushPendingChannelOps() {
 
         // Update the Channel Uri Map based on the results
         for (int i = 0; i < mPendingChannelOps.size(); i++) {
-            final int channelId = mPendingChannelOps.keyAt(i);
+            final int channelId = mPendingChannelOps.get(i).channelId;
             final ContentProviderResult result = results[i];
 
             mChannelUriMap.put(channelId, result.uri);
@@ -546,22 +598,22 @@ private void handleEventAddUpdate(@NonNull HtspMessage message) {
             // Insert the event
             if (Constants.DEBUG)
                 Log.v(TAG, "Insert event " + eventId + " on channel " + channelId);
-            mPendingProgramOps.put(
+            mPendingProgramOps.add(new PendingEventAddUpdate(
                     eventId,
                     ContentProviderOperation.newInsert(TvContract.Programs.CONTENT_URI)
                             .withValues(values)
                             .build()
-            );
+            ));
         } else {
             // Update the event
             if (Constants.DEBUG)
                 Log.v(TAG, "Update event " + eventId + " on channel " + channelId);
-            mPendingProgramOps.put(
+            mPendingProgramOps.add(new PendingEventAddUpdate(
                     eventId,
                     ContentProviderOperation.newUpdate(eventUri)
                             .withValues(values)
                             .build()
-            );
+            ));
         }
 
         // Throttle the batch operation not to cause TransactionTooLargeException. If the initial
@@ -582,8 +634,8 @@ private void flushPendingEventOps() {
 
         // Build out an ArrayList of Operations needed for applyBatch()
         ArrayList<ContentProviderOperation> operations = new ArrayList<>(mPendingProgramOps.size());
-        for (int i = 0; i < mPendingProgramOps.size(); i++) {
-            operations.add(mPendingProgramOps.valueAt(i));
+        for (PendingEventAddUpdate peau : mPendingProgramOps) {
+            operations.add(peau.operation);
         }
 
         // Apply the batch of Operations
@@ -608,7 +660,7 @@ private void flushPendingEventOps() {
 
         // Update the Event Uri Map based on the results
         for (int i = 0; i < mPendingProgramOps.size(); i++) {
-            final int eventId = mPendingProgramOps.keyAt(i);
+            final int eventId = mPendingProgramOps.get(i).eventId;
             final ContentProviderResult result = results[i];
 
             mProgramUriMap.put(eventId, result.uri);