Merge pull request #88 from fbeutel/carbons

* Implemented XEP-0280: Message Carbons

7 files changed, 233 insertions, 1 deletions

diff --git a/src/base/QXmppConstants.cpp b/src/base/QXmppConstants.cpp
index 76098d58..85b02fba 100644
--- a/src/base/QXmppConstants.cpp
+++ b/src/base/QXmppConstants.cpp
@@ -114,5 +114,7 @@ const char* ns_attention = "urn:xmpp:attention:0";
 const char* ns_bob = "urn:xmpp:bob";
 // XEP-0249: Direct MUC Invitations
 const char* ns_conference = "jabber:x:conference";
+// XEP-0280: Message Carbons
+const char* ns_carbons = "urn:xmpp:carbons:2";
 // XEP-0333: Chat Markers
 const char* ns_chat_markers = "urn:xmpp:chat-markers:0";
diff --git a/src/base/QXmppConstants.h b/src/base/QXmppConstants.h
index bf544159..210f8319 100644
--- a/src/base/QXmppConstants.h
+++ b/src/base/QXmppConstants.h
@@ -115,6 +115,8 @@ extern const char* ns_attention;
 extern const char* ns_bob;
 // XEP-0249: Direct MUC Invitations
 extern const char* ns_conference;
+// XEP-0280: Message Carbons
+extern const char* ns_carbons;
 // XEP-0333: Char Markers
 extern const char* ns_chat_markers;
 
diff --git a/src/base/QXmppMessage.cpp b/src/base/QXmppMessage.cpp
index 0ee4be20..b7e83ddf 100644
--- a/src/base/QXmppMessage.cpp
+++ b/src/base/QXmppMessage.cpp
@@ -93,6 +93,9 @@ public:
     QXmppMessage::Marker marker;
     QString markedId;
     QString markedThread;
+
+    // XEP-0280: Message Carbons
+    bool privatemsg;
 };
 
 /// Constructs a QXmppMessage.
@@ -117,6 +120,8 @@ QXmppMessage::QXmppMessage(const QString& from, const QString& to, const
 
     d->markable = false;
     d->marker = NoMarker;
+
+    d->privatemsg = false;
 }
 
 /// Constructs a copy of \a other.
@@ -372,7 +377,8 @@ namespace
                << qMakePair(QString("request"), QString())
                << qMakePair(QString("delay"), QString())
                << qMakePair(QString("attention"), QString())
-               << qMakePair(QString("addresses"), QString());
+               << qMakePair(QString("addresses"), QString())
+               << qMakePair(QString("private"), QString(ns_carbons));
         for (int i = QXmppMessage::Active; i <= QXmppMessage::Paused; i++)
             result << qMakePair(QString(chat_states[i]), QString());
         return result;
@@ -443,6 +449,24 @@ void QXmppMessage::setMarker(const Marker marker)
     d->marker = marker;
 }
 
+/// Returns if the message is marked with a <private> tag,
+/// in which case it will not be forwarded to other resources
+/// according to XEP-0280: Message Carbons.
+
+bool QXmppMessage::isPrivate() const
+{
+    return d->privatemsg;
+}
+
+/// If true is passed, the message is marked with a <private> tag,
+/// in which case it will not be forwarded to other resources
+/// according to XEP-0280: Message Carbons.
+
+void QXmppMessage::setPrivate(const bool priv)
+{
+    d->privatemsg = priv;
+}
+
 /// \cond
 void QXmppMessage::parse(const QDomElement &element)
 {
@@ -543,6 +567,11 @@ void QXmppMessage::parse(const QDomElement &element)
         }
     }
 
+    // XEP-0280: Message Carbons
+    QDomElement privateElement = element.firstChildElement("private");
+    if (!privateElement.isNull())
+        d->privatemsg = true;
+
     const QList<QPair<QString, QString> > &knownElems = knownMessageSubelems();
 
     QXmppElementList extensions;
@@ -685,6 +714,13 @@ void QXmppMessage::toXml(QXmlStreamWriter *xmlWriter) const
         xmlWriter->writeEndElement();
     }
 
+    // XEP-0280: Message Carbons
+    if (d->privatemsg) {
+        xmlWriter->writeStartElement("private");
+        xmlWriter->writeAttribute("xmlns", ns_carbons);
+        xmlWriter->writeEndElement();
+    }
+
     // other extensions
     QXmppStanza::extensionsToXml(xmlWriter);
 
diff --git a/src/base/QXmppMessage.h b/src/base/QXmppMessage.h
index 03c4a408..cff04250 100644
--- a/src/base/QXmppMessage.h
+++ b/src/base/QXmppMessage.h
@@ -129,6 +129,10 @@ public:
     Marker marker() const;
     void setMarker(const Marker);
 
+    // XEP-0280: Message Carbons
+    bool isPrivate() const;
+    void setPrivate(const bool);
+
     /// \cond
     void parse(const QDomElement &element);
     void toXml(QXmlStreamWriter *writer) const;
diff --git a/src/client/QXmppCarbonsManager.cpp b/src/client/QXmppCarbonsManager.cpp
new file mode 100644
index 00000000..f09e149c
--- /dev/null
+++ b/src/client/QXmppCarbonsManager.cpp
@@ -0,0 +1,115 @@
+/*
+ * Copyright (C) 2008-2014 The QXmpp developers
+ *
+ * Author:
+ *  Manjeet Dahiya
+ *
+ * Source:
+ *  https://github.com/qxmpp-project/qxmpp
+ *
+ * This file is a part of QXmpp library.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ */
+
+#include <QDomElement>
+
+#include "QXmppCarbonsManager.h"
+#include "QXmppConstants.h"
+#include "QXmppClient.h"
+#include "QXmppDiscoveryManager.h"
+#include "QXmppMessage.h"
+#include "QXmppUtils.h"
+
+
+QXmppCarbonsManager::QXmppCarbonsManager()
+    : m_carbonsEnabled(false)
+{
+
+}
+
+QXmppCarbonsManager::~QXmppCarbonsManager()
+{
+
+}
+
+/// Returns whether message carbons are currently enabled
+
+bool QXmppCarbonsManager::carbonsEnabled() const
+{
+    return m_carbonsEnabled;
+}
+
+/// Enable or disable message carbons.
+/// This function does not check whether the server supports
+/// message carbons, but just sends the corresponding stanza
+/// to the server, so one must check in advance by using the
+/// discovery manager.
+///
+/// By default, carbon copies are disabled.
+
+void QXmppCarbonsManager::setCarbonsEnabled(bool enabled)
+{
+    if(m_carbonsEnabled == enabled)
+        return;
+
+    m_carbonsEnabled = enabled;
+
+    if(client()) {
+        QXmppIq iq(QXmppIq::Set);
+        QXmppElement carbonselement;
+        carbonselement.setTagName(m_carbonsEnabled ? "enable" : "disable");
+        carbonselement.setAttribute("xmlns", ns_carbons);
+
+        iq.setExtensions(QXmppElementList() << carbonselement);
+        client()->sendPacket(iq);
+    }
+}
+
+QStringList QXmppCarbonsManager::discoveryFeatures() const
+{
+    return QStringList() << ns_carbons;
+}
+
+bool QXmppCarbonsManager::handleStanza(const QDomElement &element)
+{
+    if(element.tagName() != "message")
+        return false;
+
+    bool sent = true;
+    QDomElement carbon = element.firstChildElement("sent");
+    if(carbon.isNull()) {
+        carbon = element.firstChildElement("received");
+        sent = false;
+    }
+
+    if(carbon.isNull() || carbon.namespaceURI() != ns_carbons)
+        return false;   // Neither sent nor received -> no carbon message
+
+    QDomElement forwarded = carbon.firstChildElement("forwarded");
+    if(forwarded.isNull())
+        return false;
+
+    QDomElement messageelement = forwarded.firstChildElement("message");
+    if(messageelement.isNull())
+        return false;
+
+    QXmppMessage message;
+    message.parse(messageelement);
+
+    if(sent)
+        emit messageSent(message);
+    else
+        emit messageReceived(message);
+
+    return true;
+}
diff --git a/src/client/QXmppCarbonsManager.h b/src/client/QXmppCarbonsManager.h
new file mode 100644
index 00000000..c3852e66
--- /dev/null
+++ b/src/client/QXmppCarbonsManager.h
@@ -0,0 +1,71 @@
+/*
+ * Copyright (C) 2008-2014 The QXmpp developers
+ *
+ * Author:
+ *  Manjeet Dahiya
+ *
+ * Source:
+ *  https://github.com/qxmpp-project/qxmpp
+ *
+ * This file is a part of QXmpp library.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ */
+
+
+#ifndef QXMPPCARBONSMANAGER_H
+#define QXMPPCARBONSMANAGER_H
+
+#include "QXmppClientExtension.h"
+
+class QXmppMessage;
+
+/// \brief The QXmppCarbonsManager class handles message carbons
+/// as described in xep-0280.
+///
+/// This class emits signals whenever another resource of the
+/// currently connected client account sent or received a message.
+///
+/// \ingroup Managers
+
+class QXMPP_EXPORT QXmppCarbonsManager : public QXmppClientExtension
+{
+    Q_OBJECT
+
+public:
+    QXmppCarbonsManager();
+    ~QXmppCarbonsManager();
+
+    bool carbonsEnabled() const;
+    void setCarbonsEnabled(bool enabled);
+
+    /// \cond
+    QStringList discoveryFeatures() const;
+    bool handleStanza(const QDomElement &element);
+    /// \endcond
+
+signals:
+    /// \brief Emitted when a message was received from someone else
+    /// and directed to another resource.
+    /// If you connect this signal to the \s QXmppClient::messageReceived
+    /// signal, they will appear as normal messages.
+    void messageReceived(const QXmppMessage&);
+
+    /// \brief Emitted when another resource sent a message to
+    /// someone else
+    void messageSent(const QXmppMessage&);
+
+private:
+    bool m_carbonsEnabled;
+};
+
+#endif // QXMPPCARBONSMANAGER_H
diff --git a/src/client/client.pri b/src/client/client.pri
index 82d46cc6..6479a81f 100644
--- a/src/client/client.pri
+++ b/src/client/client.pri
@@ -3,6 +3,7 @@ INSTALL_HEADERS += \
     client/QXmppArchiveManager.h \
     client/QXmppBookmarkManager.h \
     client/QXmppCallManager.h \
+    client/QXmppCarbonsManager.h \
     client/QXmppClient.h \
     client/QXmppClientExtension.h \
     client/QXmppConfiguration.h \
@@ -26,6 +27,7 @@ SOURCES += \
     client/QXmppArchiveManager.cpp \
     client/QXmppBookmarkManager.cpp \
     client/QXmppCallManager.cpp \
+    client/QXmppCarbonsManager.cpp \
     client/QXmppClient.cpp \
     client/QXmppClientExtension.cpp \
     client/QXmppConfiguration.cpp \