Implement XEP-0231: Bits of Binary: IQ

This implements parsing and serialization of the BoB IQ from
XEP-0231: Bits of Binary in version 1.0.

4 files changed, 364 insertions, 0 deletions

diff --git a/src/base/QXmppBitsOfBinaryData.cpp b/src/base/QXmppBitsOfBinaryData.cpp
new file mode 100644
index 00000000..c36ded3b
--- /dev/null
+++ b/src/base/QXmppBitsOfBinaryData.cpp
@@ -0,0 +1,168 @@
+/*
+ * Copyright (C) 2008-2019 The QXmpp developers
+ *
+ * Author:
+ *  Linus Jahn
+ *
+ * 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 "QXmppBitsOfBinaryData.h"
+
+#include <QDomElement>
+#include <QSharedData>
+#include <QMimeType>
+#include <QMimeDatabase>
+#include <QXmlStreamWriter>
+
+#include "QXmppBitsOfBinaryContentId.h"
+#include "QXmppConstants_p.h"
+#include "QXmppUtils.h"
+
+class QXmppBitsOfBinaryDataPrivate : public QSharedData
+{
+public:
+    QXmppBitsOfBinaryDataPrivate();
+
+    QXmppBitsOfBinaryContentId cid;
+    int maxAge;
+    QMimeType contentType;
+    QByteArray data;
+};
+
+QXmppBitsOfBinaryDataPrivate::QXmppBitsOfBinaryDataPrivate()
+    : maxAge(-1)
+{
+}
+
+QXmppBitsOfBinaryData::QXmppBitsOfBinaryData()
+    : d(new QXmppBitsOfBinaryDataPrivate)
+{
+}
+
+QXmppBitsOfBinaryData::QXmppBitsOfBinaryData(const QXmppBitsOfBinaryData &) = default;
+
+QXmppBitsOfBinaryData::~QXmppBitsOfBinaryData() = default;
+
+QXmppBitsOfBinaryData &QXmppBitsOfBinaryData::operator=(const QXmppBitsOfBinaryData &) = default;
+
+/// Returns the content id of the data
+
+QXmppBitsOfBinaryContentId QXmppBitsOfBinaryData::cid() const
+{
+    return d->cid;
+}
+
+/// Sets the content id of the data
+
+void QXmppBitsOfBinaryData::setCid(const QXmppBitsOfBinaryContentId &cid)
+{
+    d->cid = cid;
+}
+
+/// Returns the time in seconds the data should be cached
+///
+/// A value of 0 means that the data should not be cached, while a value of -1
+/// means that nothing was set.
+///
+/// The default value is -1.
+
+int QXmppBitsOfBinaryData::maxAge() const
+{
+    return d->maxAge;
+}
+
+/// Sets the time in seconds the data should be cached
+///
+/// A value of 0 means that the data should not be cached, while a value of -1
+/// means that nothing was set.
+///
+/// The default value is -1.
+
+void QXmppBitsOfBinaryData::setMaxAge(int maxAge)
+{
+    d->maxAge = maxAge;
+}
+
+/// Returns the content type of the data
+///
+/// \note This is the advertised content type and may differ from the actual
+/// content type of the data.
+
+QMimeType QXmppBitsOfBinaryData::contentType() const
+{
+    return d->contentType;
+}
+
+/// Sets the content type of the data
+
+void QXmppBitsOfBinaryData::setContentType(const QMimeType &contentType)
+{
+    d->contentType = contentType;
+}
+
+/// Returns the included data in binary form
+
+QByteArray QXmppBitsOfBinaryData::data() const
+{
+    return d->data;
+}
+
+/// Sets the data in binary form
+
+void QXmppBitsOfBinaryData::setData(const QByteArray &data)
+{
+    d->data = data;
+}
+
+/// Returns true, if \c element is a XEP-0231: Bits of Binary data element
+
+bool QXmppBitsOfBinaryData::isBitsOfBinaryData(const QDomElement &element)
+{
+    return element.tagName() == QStringLiteral("data") && element.namespaceURI() == ns_bob;
+}
+
+/// \cond
+void QXmppBitsOfBinaryData::parseElementFromChild(const QDomElement &dataElement)
+{
+    d->cid = QXmppBitsOfBinaryContentId::fromContentId(dataElement.attribute("cid"));
+    d->maxAge = dataElement.attribute("max-age", "-1").toInt();
+    d->contentType = QMimeDatabase().mimeTypeForName(dataElement.attribute("type"));
+    d->data = QByteArray::fromBase64(dataElement.text().toUtf8());
+}
+
+void QXmppBitsOfBinaryData::toXmlElementFromChild(QXmlStreamWriter *writer) const
+{
+    writer->writeStartElement("data");
+    writer->writeAttribute("xmlns", ns_bob);
+    helperToXmlAddAttribute(writer, "cid", d->cid.toContentId());
+    if (d->maxAge > -1)
+        helperToXmlAddAttribute(writer, "max-age", QString::number(d->maxAge));
+    helperToXmlAddAttribute(writer, "type", d->contentType.name());
+    writer->writeCharacters(d->data.toBase64());
+    writer->writeEndElement();
+}
+/// \endcond
+
+bool QXmppBitsOfBinaryData::operator==(const QXmppBitsOfBinaryData &other) const
+{
+    return d->cid == other.cid() &&
+           d->maxAge == other.maxAge() &&
+           d->contentType == other.contentType() &&
+           d->data == other.data();
+}
+
diff --git a/src/base/QXmppBitsOfBinaryData.h b/src/base/QXmppBitsOfBinaryData.h
new file mode 100644
index 00000000..38f5475d
--- /dev/null
+++ b/src/base/QXmppBitsOfBinaryData.h
@@ -0,0 +1,78 @@
+/*
+ * Copyright (C) 2008-2019 The QXmpp developers
+ *
+ * Author:
+ *  Linus Jahn
+ *
+ * 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 QXMPPBITSOFBINARYDATA_H
+#define QXMPPBITSOFBINARYDATA_H
+
+#include <QSharedDataPointer>
+
+#include "QXmppGlobal.h"
+
+class QDomElement;
+class QMimeType;
+class QXmlStreamWriter;
+class QXmppBitsOfBinaryDataPrivate;
+class QXmppBitsOfBinaryContentId;
+
+/// \class QXmppBitsOfBinaryData represents a data element for XEP-0231: Bits
+/// of Binary. It can be used as an extension in other stanzas.
+///
+/// \see QXmppBitsOfBinaryIq, QXmppBitsOfBinaryDataList
+///
+/// \since QXmpp 1.2
+
+class QXMPP_EXPORT QXmppBitsOfBinaryData
+{
+public:
+    QXmppBitsOfBinaryData();
+    QXmppBitsOfBinaryData(const QXmppBitsOfBinaryData &);
+    ~QXmppBitsOfBinaryData();
+
+    QXmppBitsOfBinaryData &operator=(const QXmppBitsOfBinaryData &);
+
+    QXmppBitsOfBinaryContentId cid() const;
+    void setCid(const QXmppBitsOfBinaryContentId &cid);
+
+    int maxAge() const;
+    void setMaxAge(int maxAge);
+
+    QMimeType contentType() const;
+    void setContentType(const QMimeType &contentType);
+
+    QByteArray data() const;
+    void setData(const QByteArray &data);
+
+    bool static isBitsOfBinaryData(const QDomElement &element);
+
+    /// \cond
+    void parseElementFromChild(const QDomElement &dataElement);
+    void toXmlElementFromChild(QXmlStreamWriter *writer) const;
+    /// \endcond
+    
+    bool operator==(const QXmppBitsOfBinaryData &other) const;
+
+private:
+    QSharedDataPointer<QXmppBitsOfBinaryDataPrivate> d;
+};
+
+#endif // QXMPPBITSOFBINARYDATA_H
diff --git a/src/base/QXmppBitsOfBinaryIq.cpp b/src/base/QXmppBitsOfBinaryIq.cpp
new file mode 100644
index 00000000..21b1cb2a
--- /dev/null
+++ b/src/base/QXmppBitsOfBinaryIq.cpp
@@ -0,0 +1,68 @@
+/*
+ * Copyright (C) 2008-2019 The QXmpp developers
+ *
+ * Author:
+ *  Linus Jahn
+ *
+ * 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 "QXmppBitsOfBinaryIq.h"
+
+#include "QXmppConstants_p.h"
+
+#include <QDomElement>
+#include <QSharedData>
+
+QXmppBitsOfBinaryIq::QXmppBitsOfBinaryIq() = default;
+
+QXmppBitsOfBinaryIq::~QXmppBitsOfBinaryIq() = default;
+
+/// Returns true, if \c element is a XEP-0231: Bits of Binary IQ
+///
+/// \note This may also return true, if the IQ is not a Bits of Binary IQ in
+/// first place, but only contains a Bits of Binary data element.
+
+bool QXmppBitsOfBinaryIq::isBitsOfBinaryIq(const QDomElement &element)
+{
+    QDomElement child = element.firstChildElement();
+    while (!child.isNull()) {
+        if (QXmppBitsOfBinaryData::isBitsOfBinaryData(child))
+            return true;
+        child = child.nextSiblingElement();
+    }
+    return false;
+}
+
+/// \cond
+void QXmppBitsOfBinaryIq::parseElementFromChild(const QDomElement &element)
+{
+    QDomElement child = element.firstChildElement();
+    while (!child.isNull()) {
+        if (QXmppBitsOfBinaryData::isBitsOfBinaryData(child)) {
+            QXmppBitsOfBinaryData::parseElementFromChild(child);
+            break;
+        }
+        child = child.nextSiblingElement();
+    }
+}
+
+void QXmppBitsOfBinaryIq::toXmlElementFromChild(QXmlStreamWriter *writer) const
+{
+    QXmppBitsOfBinaryData::toXmlElementFromChild(writer);
+}
+/// \endcond
diff --git a/src/base/QXmppBitsOfBinaryIq.h b/src/base/QXmppBitsOfBinaryIq.h
new file mode 100644
index 00000000..be6a4150
--- /dev/null
+++ b/src/base/QXmppBitsOfBinaryIq.h
@@ -0,0 +1,50 @@
+/*
+ * Copyright (C) 2008-2019 The QXmpp developers
+ *
+ * Author:
+ *  Linus Jahn
+ *
+ * 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 QXMPPBITSOFBINARYIQ_H
+#define QXMPPBITSOFBINARYIQ_H
+
+#include "QXmppIq.h"
+#include "QXmppBitsOfBinaryData.h"
+
+/// \class QXmppBitsOfBinaryIq represents a XEP-0231: Bits of Binary IQ to
+/// request and transmit Bits of Binary data elements.
+///
+/// \since QXmpp 1.2
+
+class QXMPP_EXPORT QXmppBitsOfBinaryIq : public QXmppIq, public QXmppBitsOfBinaryData
+{
+public:
+    QXmppBitsOfBinaryIq();
+    ~QXmppBitsOfBinaryIq();
+
+    static bool isBitsOfBinaryIq(const QDomElement &element);
+
+protected:
+    /// \cond
+    void parseElementFromChild(const QDomElement &element) override;
+    void toXmlElementFromChild(QXmlStreamWriter *writer) const override;
+    /// \endcond
+};
+
+#endif // QXMPPBITSOFBINARYIQ_H