Implement XEP-0184 delivery notifications

This patch provides three components required to implement XEP-0184:

 * DeliveryReceiptRequest is a PacketExtension to request a receipt
 * DeliveryReceipt is a PacketExtension that contains the receipt
 * DeliveryReceiptManager to handle sending/receiving of requests and
   receipts.

Implementation:

For requesting a receipt, just add a new DeliveryReceiptRequest() to
your message or use the helper function:

    DeliveryReceiptManager.addDeliveryReceiptRequest(packet);

Register a ReceiptReceivedListener to find out if your packet arrived:

    DeliveryReceiptManager.getInstanceFor(myConnection)
	.registerReceiptReceivedListener(new ReceiptReceivedListener() {
	    @Override public void onReceiptReceived(String fromJid,
				    String toJid, String receiptId) {
		// receipt received for packet id receiptId
	    }

To answer a receipt request, you can either check incoming packets
manually:

    if (DeliveryReceiptManager.hasDeliveryReceiptRequest(packet)) {
	// send receipt
    }

Or you can enable automatic receipt transmission with:

    DeliveryReceiptManager.getInstanceFor(myConnection)
	    .setAutoReceiptsEnabled(true);

Signed-Off-By: Georg Lukas <georg@op-co.de>

git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/trunk@13431 b35dd754-fafc-0310-a699-88a17e54d16e

test-unit/org/jivesoftware/smackx/receipts/DeliveryReceiptTest.java

@@ -0,0 +1,141 @@
+/**
+ * All rights reserved. Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.jivesoftware.smackx.receipts;
+
+import static org.junit.Assert.*;
+
+import java.io.IOException;
+import java.io.StringReader;
+import java.text.SimpleDateFormat;
+import java.util.Calendar;
+import java.util.Date;
+import java.util.GregorianCalendar;
+import java.util.Properties;
+import java.util.TimeZone;
+
+import org.jivesoftware.smack.DummyConnection;
+import org.jivesoftware.smack.packet.Message;
+import org.jivesoftware.smack.packet.Packet;
+import org.jivesoftware.smack.util.PacketParserUtils;
+import org.jivesoftware.smackx.ServiceDiscoveryManager;
+import org.junit.Test;
+import org.xmlpull.mxp1.MXParser;
+import org.xmlpull.v1.XmlPullParser;
+import org.xmlpull.v1.XmlPullParserException;
+
+import com.jamesmurty.utils.XMLBuilder;
+
+public class DeliveryReceiptTest {
+
+    private static Properties outputProperties = new Properties();
+    static {
+        outputProperties.put(javax.xml.transform.OutputKeys.OMIT_XML_DECLARATION, "yes");
+    }
+
+    @Test
+    public void receiptTest() throws Exception {
+        XmlPullParser parser;
+        String control;
+        
+        control = XMLBuilder.create("message")
+            .a("from", "romeo@montague.com")
+            .e("request")
+                .a("xmlns", "urn:xmpp:receipts")
+            .asString(outputProperties);
+        
+        parser = getParser(control, "message");
+        Packet p = PacketParserUtils.parseMessage(parser);
+
+        DeliveryReceiptRequest drr = (DeliveryReceiptRequest)p.getExtension(
+                        DeliveryReceiptRequest.ELEMENT, DeliveryReceipt.NAMESPACE);
+        assertNotNull(drr);
+
+        assertTrue(DeliveryReceiptManager.hasDeliveryReceiptRequest(p));
+
+        Message m = new Message("romeo@montague.com", Message.Type.normal);
+        assertFalse(DeliveryReceiptManager.hasDeliveryReceiptRequest(m));
+        DeliveryReceiptManager.addDeliveryReceiptRequest(m);
+        assertTrue(DeliveryReceiptManager.hasDeliveryReceiptRequest(m));
+    }
+
+    @Test
+    public void receiptManagerListenerTest() throws Exception {
+        DummyConnection c = new DummyConnection();
+        ServiceDiscoveryManager sdm = new ServiceDiscoveryManager(c);
+        DeliveryReceiptManager drm = DeliveryReceiptManager.getInstanceFor(c);
+
+        TestReceiptReceivedListener rrl = new TestReceiptReceivedListener();
+        drm.registerReceiptReceivedListener(rrl);
+
+        Message m = new Message("romeo@montague.com", Message.Type.normal);
+        m.setFrom("julia@capulet.com");
+        m.setPacketID("reply-id");
+        m.addExtension(new DeliveryReceipt("original-test-id"));
+        drm.processPacket(m);
+
+        // ensure the listener got called
+        assertEquals("original-test-id", rrl.receiptId);
+    }
+
+    private static class TestReceiptReceivedListener implements DeliveryReceiptManager.ReceiptReceivedListener {
+        public String receiptId = null;
+        @Override
+        public void onReceiptReceived(String fromJid, String toJid, String receiptId) {
+            assertEquals("julia@capulet.com", fromJid);
+            assertEquals("romeo@montague.com", toJid);
+            assertEquals("original-test-id", receiptId);
+            this.receiptId = receiptId;
+        }
+    }
+
+    @Test
+    public void receiptManagerAutoReplyTest() throws Exception {
+        DummyConnection c = new DummyConnection();
+        ServiceDiscoveryManager sdm = new ServiceDiscoveryManager(c);
+        DeliveryReceiptManager drm = DeliveryReceiptManager.getInstanceFor(c);
+
+        drm.enableAutoReceipts();
+        assertTrue(drm.getAutoReceiptsEnabled());
+
+        // test auto-receipts
+        Message m = new Message("julia@capulet.com", Message.Type.normal);
+        m.setFrom("romeo@montague.com");
+        m.setPacketID("test-receipt-request");
+        DeliveryReceiptManager.addDeliveryReceiptRequest(m);
+
+        // the DRM will send a reply-packet
+        assertEquals(0, c.getNumberOfSentPackets());
+        drm.processPacket(m);
+        assertEquals(1, c.getNumberOfSentPackets());
+
+        Packet reply = c.getSentPacket();
+        DeliveryReceipt r = (DeliveryReceipt)reply.getExtension("received", "urn:xmpp:receipts");
+        assertEquals("romeo@montague.com", reply.getTo());
+        assertEquals("test-receipt-request", r.getId());
+    }
+
+    private XmlPullParser getParser(String control, String startTag)
+                    throws XmlPullParserException, IOException {
+        XmlPullParser parser = new MXParser();
+        parser.setFeature(XmlPullParser.FEATURE_PROCESS_NAMESPACES, true);
+        parser.setInput(new StringReader(control));
+        while (true) {
+            if (parser.next() == XmlPullParser.START_TAG
+                            && parser.getName().equals(startTag)) {
+                break;
+            }
+        }
+        return parser;
+    }
+}