From 50704c45f19cb953ef91607b6768199337acdbcc Mon Sep 17 00:00:00 2001
From: vanitasvitae <vanitasvitae@fsfe.org>
Date: Tue, 22 Aug 2017 16:06:33 +0200
Subject: [PATCH] Improve progress listener

---
 .../component/JingleFileTransfer.java         | 37 +++++++++++++------
 .../component/JingleIncomingFileOffer.java    |  6 ++-
 .../component/JingleOutgoingFileOffer.java    |  7 +++-
 .../listener/ProgressListener.java            |  6 +--
 .../jingle/component/JingleContent.java       |  4 ++
 .../jingle/component/JingleDescription.java   |  3 ++
 .../jingle/component/JingleSession.java       | 20 +++++++++-
 .../JingleFileTransferIntegrationTest.java    | 25 +++++--------
 ...nsferTransportFallbackIntegrationTest.java | 25 +++++--------
 9 files changed, 85 insertions(+), 48 deletions(-)

diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/jingle_filetransfer/component/JingleFileTransfer.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/jingle_filetransfer/component/JingleFileTransfer.java
index 358ae8b23..c7dab6234 100644
--- a/smack-experimental/src/main/java/org/jivesoftware/smackx/jingle_filetransfer/component/JingleFileTransfer.java
+++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/jingle_filetransfer/component/JingleFileTransfer.java
@@ -40,6 +40,7 @@ public abstract class JingleFileTransfer extends JingleDescription<JingleFileTra
 
     protected State state;
     protected JingleFile metadata;
+    protected float percentage;
 
     private final List<ProgressListener> progressListeners = Collections.synchronizedList(new ArrayList<ProgressListener>());
 
@@ -83,29 +84,41 @@ public abstract class JingleFileTransfer extends JingleDescription<JingleFileTra
         getParent().onContentCancel();
     }
 
-    public void notifyProgressListeners(float progress) {
-        for (ProgressListener p : progressListeners) {
-            p.progress(progress);
-        }
-    }
-
-    public void notifyProgressListenersFinished() {
-        for (ProgressListener p : progressListeners) {
-            p.finished();
-        }
-    }
-
     public void notifyProgressListenersStarted() {
         for (ProgressListener p : progressListeners) {
             p.started();
         }
     }
 
+    public void notifyProgressListenersTerminated(JingleReasonElement.Reason reason) {
+        for (ProgressListener p : progressListeners) {
+            p.terminated(reason);
+        }
+    }
+
+    /**
+     * Return progress as a float value between 0 and 1.
+     * If the transmission has not yet started, return -1.
+     * @return -1 or percentage in [0,1]
+     */
+    public float getPercentage() {
+        if (state == State.pending || state == State.negotiating) {
+            return -1f;
+        }
+
+        return percentage;
+    }
+
     @Override
     public String getNamespace() {
         return JingleFileTransfer.NAMESPACE;
     }
 
+    @Override
+    public void handleContentTerminate(JingleReasonElement.Reason reason) {
+        notifyProgressListenersTerminated(reason);
+    }
+
     @Override
     public JingleFileTransferElement getElement() {
         return new JingleFileTransferElement(metadata.getElement());
diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/jingle_filetransfer/component/JingleIncomingFileOffer.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/jingle_filetransfer/component/JingleIncomingFileOffer.java
index fcf673785..fe08e6de8 100644
--- a/smack-experimental/src/main/java/org/jivesoftware/smackx/jingle_filetransfer/component/JingleIncomingFileOffer.java
+++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/jingle_filetransfer/component/JingleIncomingFileOffer.java
@@ -36,6 +36,7 @@ import org.jivesoftware.smackx.hashes.element.HashElement;
 import org.jivesoftware.smackx.jingle.component.JingleSession;
 import org.jivesoftware.smackx.jingle.element.JingleContentDescriptionInfoElement;
 import org.jivesoftware.smackx.jingle.element.JingleElement;
+import org.jivesoftware.smackx.jingle.element.JingleReasonElement;
 import org.jivesoftware.smackx.jingle_filetransfer.controller.IncomingFileOfferController;
 import org.jivesoftware.smackx.jingle_filetransfer.element.JingleFileTransferChildElement;
 
@@ -97,6 +98,9 @@ public class JingleIncomingFileOffer extends AbstractJingleFileOffer implements
                 target.write(bufbuf, 0, length);
                 read += length;
                 LOGGER.log(Level.INFO, "Read " + read + " (" + length + ") of " + metadata.getSize() + " bytes.");
+
+                percentage = ((float) read) / ((float) metadata.getSize());
+
                 if (read == (int) metadata.getSize()) {
                     break;
                 }
@@ -133,7 +137,7 @@ public class JingleIncomingFileOffer extends AbstractJingleFileOffer implements
                 LOGGER.log(Level.INFO, "CHECKSUM MATCHED :)");
             }
         }
-        notifyProgressListenersFinished();
+        notifyProgressListenersTerminated(JingleReasonElement.Reason.success);
         getParent().onContentFinished();
     }
 
diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/jingle_filetransfer/component/JingleOutgoingFileOffer.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/jingle_filetransfer/component/JingleOutgoingFileOffer.java
index 0ba627fa3..93a21cc18 100644
--- a/smack-experimental/src/main/java/org/jivesoftware/smackx/jingle_filetransfer/component/JingleOutgoingFileOffer.java
+++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/jingle_filetransfer/component/JingleOutgoingFileOffer.java
@@ -28,6 +28,7 @@ import java.util.logging.Logger;
 import org.jivesoftware.smackx.bytestreams.BytestreamSession;
 import org.jivesoftware.smackx.jingle.element.JingleContentDescriptionInfoElement;
 import org.jivesoftware.smackx.jingle.element.JingleElement;
+import org.jivesoftware.smackx.jingle.element.JingleReasonElement;
 import org.jivesoftware.smackx.jingle_filetransfer.controller.OutgoingFileOfferController;
 
 /**
@@ -66,6 +67,8 @@ public class JingleOutgoingFileOffer extends AbstractJingleFileOffer implements
 
             byte[] buf = new byte[8192];
 
+            int written = 0;
+
             while (true) {
                 if (getState() == State.cancelled) {
                     break;
@@ -75,6 +78,8 @@ public class JingleOutgoingFileOffer extends AbstractJingleFileOffer implements
                     break;
                 }
                 outputStream.write(buf, 0, r);
+                written += r;
+                percentage = ((float) getMetadata().getSize()) / ((float) written);
             }
 
             outputStream.flush();
@@ -91,7 +96,7 @@ public class JingleOutgoingFileOffer extends AbstractJingleFileOffer implements
             }
         }
 
-        notifyProgressListenersFinished();
+        notifyProgressListenersTerminated(JingleReasonElement.Reason.success);
     }
 
     @Override
diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/jingle_filetransfer/listener/ProgressListener.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/jingle_filetransfer/listener/ProgressListener.java
index 9ef8e2478..e3f3f613e 100644
--- a/smack-experimental/src/main/java/org/jivesoftware/smackx/jingle_filetransfer/listener/ProgressListener.java
+++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/jingle_filetransfer/listener/ProgressListener.java
@@ -16,6 +16,8 @@
  */
 package org.jivesoftware.smackx.jingle_filetransfer.listener;
 
+import org.jivesoftware.smackx.jingle.element.JingleReasonElement;
+
 /**
  * Created by vanitas on 27.07.17.
  */
@@ -23,7 +25,5 @@ public interface ProgressListener {
 
     void started();
 
-    void progress(float percent);
-
-    void finished();
+    void terminated(JingleReasonElement.Reason reason);
 }
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/jingle/component/JingleContent.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/jingle/component/JingleContent.java
index ccbf41f21..0a6fa65b5 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/jingle/component/JingleContent.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/jingle/component/JingleContent.java
@@ -480,6 +480,10 @@ public class JingleContent implements JingleTransportCallback, JingleSecurityCal
         session.onContentCancel(this);
     }
 
+    public void handleContentTerminate(JingleReasonElement.Reason reason) {
+        description.handleContentTerminate(reason);
+    }
+
     private void replaceTransport(Set<String> blacklist, XMPPConnection connection)
             throws SmackException.NotConnectedException, InterruptedException,
             XMPPException.XMPPErrorException, SmackException.NoResponseException {
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/jingle/component/JingleDescription.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/jingle/component/JingleDescription.java
index 5c6646c39..3255712c6 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/jingle/component/JingleDescription.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/jingle/component/JingleDescription.java
@@ -20,6 +20,7 @@ import org.jivesoftware.smackx.bytestreams.BytestreamSession;
 import org.jivesoftware.smackx.jingle.element.JingleContentDescriptionElement;
 import org.jivesoftware.smackx.jingle.element.JingleContentDescriptionInfoElement;
 import org.jivesoftware.smackx.jingle.element.JingleElement;
+import org.jivesoftware.smackx.jingle.element.JingleReasonElement;
 
 /**
  * Class that represents a contents description component.
@@ -45,4 +46,6 @@ public abstract class JingleDescription<D extends JingleContentDescriptionElemen
     public abstract void onBytestreamReady(BytestreamSession bytestreamSession);
 
     public abstract String getNamespace();
+
+    public abstract void handleContentTerminate(JingleReasonElement.Reason reason);
 }
diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/jingle/component/JingleSession.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/jingle/component/JingleSession.java
index bd7d1a565..b3da1f4d7 100644
--- a/smack-extensions/src/main/java/org/jivesoftware/smackx/jingle/component/JingleSession.java
+++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/jingle/component/JingleSession.java
@@ -145,6 +145,10 @@ public class JingleSession {
         return JingleElement.createSessionAccept(getInitiator(), getResponder(), getSessionId(), contentElements);
     }
 
+    /**
+     * Handle local content finished event. This includes terminating the session.
+     * @param jingleContent content which finished.
+     */
     void onContentFinished(JingleContent jingleContent) {
         if (contents.get(jingleContent.getName()) == null) {
             LOGGER.log(Level.WARNING, "Session does not contain content " + jingleContent.getName() + ". Ignore contentFinished.");
@@ -169,6 +173,11 @@ public class JingleSession {
         */
     }
 
+    /**
+     * Handle local content cancel event. This happens when the local user cancels a content.
+     * If there is only one content in the session, terminate the session, otherwise just cancel the one content.
+     * @param jingleContent content that gets cancelled.
+     */
     void onContentCancel(JingleContent jingleContent) {
         if (contents.get(jingleContent.getName()) == null) {
             LOGGER.log(Level.WARNING, "Session does not contain content " + jingleContent.getName() + ". Ignore onContentCancel.");
@@ -188,6 +197,10 @@ public class JingleSession {
         }
     }
 
+    /**
+     * Send a session terminate and remove the session from the list of active sessions.
+     * @param reason reason of termination.
+     */
     public void terminateSession(JingleReasonElement.Reason reason) {
         try {
             jingleManager.getConnection().createStanzaCollectorAndSend(JingleElement.createSessionTerminate(getPeer(), getSessionId(), reason));
@@ -285,7 +298,12 @@ public class JingleSession {
             throw new AssertionError("Reason MUST not be null! (I guess)...");
         }
 
-        //TODO: Inform client.
+        JingleReasonElement.Reason r = reason.asEnum();
+
+        for (JingleContent content : contents.values()) {
+            content.handleContentTerminate(r);
+        }
+
         jingleManager.removeSession(this);
 
         return IQ.createResultIQ(request);
diff --git a/smack-integration-test/src/main/java/org/jivesoftware/smackx/jingle_filetransfer/JingleFileTransferIntegrationTest.java b/smack-integration-test/src/main/java/org/jivesoftware/smackx/jingle_filetransfer/JingleFileTransferIntegrationTest.java
index 5a41968dc..65124c847 100644
--- a/smack-integration-test/src/main/java/org/jivesoftware/smackx/jingle_filetransfer/JingleFileTransferIntegrationTest.java
+++ b/smack-integration-test/src/main/java/org/jivesoftware/smackx/jingle_filetransfer/JingleFileTransferIntegrationTest.java
@@ -30,6 +30,7 @@ import java.util.logging.Level;
 import org.jivesoftware.smack.SmackException;
 import org.jivesoftware.smack.XMPPException;
 import org.jivesoftware.smackx.bytestreams.socks5.Socks5Proxy;
+import org.jivesoftware.smackx.jingle.element.JingleReasonElement;
 import org.jivesoftware.smackx.jingle.transport.jingle_ibb.JingleIBBTransportManager;
 import org.jivesoftware.smackx.jingle_filetransfer.controller.IncomingFileOfferController;
 import org.jivesoftware.smackx.jingle_filetransfer.controller.OutgoingFileOfferController;
@@ -96,13 +97,10 @@ public class JingleFileTransferIntegrationTest extends AbstractSmackIntegrationT
                     }
 
                     @Override
-                    public void progress(float percent) {
-
-                    }
-
-                    @Override
-                    public void finished() {
-                        resultSyncPoint2.signal();
+                    public void terminated(JingleReasonElement.Reason reason) {
+                        if (reason == JingleReasonElement.Reason.success) {
+                            resultSyncPoint2.signal();
+                        }
                     }
                 });
 
@@ -114,7 +112,7 @@ public class JingleFileTransferIntegrationTest extends AbstractSmackIntegrationT
             }
         });
 
-        OutgoingFileOfferController sending = aftm.sendFile(source, bob);
+        final OutgoingFileOfferController sending = aftm.sendFile(source, bob);
 
         sending.addProgressListener(new ProgressListener() {
             @Override
@@ -123,13 +121,10 @@ public class JingleFileTransferIntegrationTest extends AbstractSmackIntegrationT
             }
 
             @Override
-            public void progress(float percent) {
-
-            }
-
-            @Override
-            public void finished() {
-                resultSyncPoint1.signal();
+            public void terminated(JingleReasonElement.Reason reason) {
+                if (reason == JingleReasonElement.Reason.success) {
+                    resultSyncPoint1.signal();
+                }
             }
         });
 
diff --git a/smack-integration-test/src/main/java/org/jivesoftware/smackx/jingle_filetransfer/JingleFileTransferTransportFallbackIntegrationTest.java b/smack-integration-test/src/main/java/org/jivesoftware/smackx/jingle_filetransfer/JingleFileTransferTransportFallbackIntegrationTest.java
index 6f720ac4a..882df716b 100644
--- a/smack-integration-test/src/main/java/org/jivesoftware/smackx/jingle_filetransfer/JingleFileTransferTransportFallbackIntegrationTest.java
+++ b/smack-integration-test/src/main/java/org/jivesoftware/smackx/jingle_filetransfer/JingleFileTransferTransportFallbackIntegrationTest.java
@@ -28,6 +28,7 @@ import java.util.logging.Level;
 import org.jivesoftware.smack.SmackException;
 import org.jivesoftware.smack.XMPPException;
 import org.jivesoftware.smackx.bytestreams.socks5.Socks5Proxy;
+import org.jivesoftware.smackx.jingle.element.JingleReasonElement;
 import org.jivesoftware.smackx.jingle.transport.jingle_ibb.JingleIBBTransportManager;
 import org.jivesoftware.smackx.jingle.transport.jingle_s5b.JingleS5BTransportManager;
 import org.jivesoftware.smackx.jingle_filetransfer.controller.IncomingFileOfferController;
@@ -105,13 +106,10 @@ public class JingleFileTransferTransportFallbackIntegrationTest extends Abstract
                     }
 
                     @Override
-                    public void progress(float percent) {
-
-                    }
-
-                    @Override
-                    public void finished() {
-                        resultSyncPoint2.signal();
+                    public void terminated(JingleReasonElement.Reason reason) {
+                        if (reason == JingleReasonElement.Reason.success) {
+                            resultSyncPoint2.signal();
+                        }
                     }
                 });
 
@@ -123,7 +121,7 @@ public class JingleFileTransferTransportFallbackIntegrationTest extends Abstract
             }
         });
 
-        OutgoingFileOfferController sending = aftm.sendFile(source, bob);
+        final OutgoingFileOfferController sending = aftm.sendFile(source, bob);
 
         sending.addProgressListener(new ProgressListener() {
             @Override
@@ -132,13 +130,10 @@ public class JingleFileTransferTransportFallbackIntegrationTest extends Abstract
             }
 
             @Override
-            public void progress(float percent) {
-
-            }
-
-            @Override
-            public void finished() {
-                resultSyncPoint1.signal();
+            public void terminated(JingleReasonElement.Reason reason) {
+                if (reason == JingleReasonElement.Reason.success) {
+                    resultSyncPoint1.signal();
+                }
             }
         });