156 lines
6 KiB
C++
156 lines
6 KiB
C++
/**
|
|
* SPDX-FileCopyrightText: 2013 Albert Vaca <albertvaka@gmail.com>
|
|
* SPDX-FileCopyrightText: 2018 Simon Redman <simon@ergotech.com>
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL
|
|
*/
|
|
|
|
#ifndef SMSPLUGIN_H
|
|
#define SMSPLUGIN_H
|
|
|
|
#include <QObject>
|
|
|
|
#include <core/kdeconnectplugin.h>
|
|
|
|
#include "conversationsdbusinterface.h"
|
|
#include "interfaces/conversationmessage.h"
|
|
|
|
/**
|
|
* Packet used to indicate a batch of messages has been pushed from the remote device
|
|
*
|
|
* The body should contain the key "messages" mapping to an array of messages
|
|
*
|
|
* For example:
|
|
* {
|
|
* "version": 2 // This is the second version of this packet type and
|
|
* // version 1 packets (which did not carry this flag)
|
|
* // are incompatible with the new format
|
|
* "messages" : [
|
|
* { "event" : 1, // 32-bit field containing a bitwise-or of event flags
|
|
* // See constants declared in SMSHelper.Message for defined
|
|
* // values and explanations
|
|
* "body" : "Hello", // Text message body
|
|
* "addresses": <List<Address>> // List of Address objects, one for each participant of the conversation
|
|
* // The user's Address is excluded so:
|
|
* // If this is a single-target message, there will only be one
|
|
* // Address (the other party)
|
|
* // If this is an incoming multi-target message, the first Address is the
|
|
* // sender and all other addresses are other parties to the conversation
|
|
* // If this is an outgoing multi-target message, the sender is implicit
|
|
* // (the user's phone number) and all Addresses are recipients
|
|
* "date" : "1518846484880", // Timestamp of the message
|
|
* "type" : "2", // Compare with Android's
|
|
* // Telephony.TextBasedSmsColumns.MESSAGE_TYPE_*
|
|
* "thread_id" : 132 // Thread to which the message belongs
|
|
* "read" : true // Boolean representing whether a message is read or unread
|
|
* },
|
|
* { ... },
|
|
* ...
|
|
* ]
|
|
*
|
|
* The following optional fields of a message object may be defined
|
|
* "sub_id": <int> // Android's subscriber ID, which is basically used to determine which SIM card the message
|
|
* // belongs to. This is mostly useful when attempting to reply to an SMS with the correct
|
|
* // SIM card using PACKET_TYPE_SMS_REQUEST.
|
|
* // If this value is not defined or if it does not match a valid subscriber_id known by
|
|
* // Android, we will use whatever subscriber ID Android gives us as the default
|
|
*
|
|
* "attachments": <List<Attachment>> // List of Attachment objects, one for each attached file in the message.
|
|
*
|
|
* An Attachment object looks like:
|
|
* {
|
|
* "part_id": <long> // part_id of the attachment used to read the file from MMS database
|
|
* "mime_type": <int> // contains the mime type of the file (image, video, audio, etc.)
|
|
* "encoded_thumbnail": <String> // Optional base64-encoded thumbnail preview of the content for types which support it
|
|
* "unique_identifier": <String> // Unique name of te file
|
|
* }
|
|
*
|
|
* An Address object looks like:
|
|
* {
|
|
* "address": <String> // Address (phone number, email address, etc.) of this object
|
|
* }
|
|
*/
|
|
#define PACKET_TYPE_SMS_MESSAGES QStringLiteral("kdeconnect.sms.messages")
|
|
|
|
/**
|
|
* Packet sent to request a message be sent
|
|
*
|
|
* This will almost certainly need to be replaced or augmented to support MMS,
|
|
* but be sure the Android side remains compatible with old desktop apps!
|
|
*
|
|
* The body should look like so:
|
|
* { "sendSms": true,
|
|
* "addresses": <List of Addresses>
|
|
* "messageBody": "Hi mom!",
|
|
* "sub_id": "3859358340534"
|
|
* }
|
|
*/
|
|
#define PACKET_TYPE_SMS_REQUEST QStringLiteral("kdeconnect.sms.request")
|
|
|
|
/**
|
|
* Packet sent to request the most-recent message in each conversations on the device
|
|
*
|
|
* The request packet shall contain no body
|
|
*/
|
|
#define PACKET_TYPE_SMS_REQUEST_CONVERSATIONS QStringLiteral("kdeconnect.sms.request_conversations")
|
|
|
|
/**
|
|
* Packet sent to request all the messages in a particular conversation
|
|
*
|
|
* The body should contain the key "threadID" mapping to the threadID being requested
|
|
* For example:
|
|
* { "threadID": 203 }
|
|
*/
|
|
#define PACKET_TYPE_SMS_REQUEST_CONVERSATION QStringLiteral("kdeconnect.sms.request_conversation")
|
|
|
|
Q_DECLARE_LOGGING_CATEGORY(KDECONNECT_PLUGIN_SMS)
|
|
|
|
class Q_DECL_EXPORT SmsPlugin
|
|
: public KdeConnectPlugin
|
|
{
|
|
Q_OBJECT
|
|
Q_CLASSINFO("D-Bus Interface", "org.kde.kdeconnect.device.sms")
|
|
|
|
public:
|
|
explicit SmsPlugin(QObject* parent, const QVariantList& args);
|
|
~SmsPlugin() override;
|
|
|
|
bool receivePacket(const NetworkPacket& np) override;
|
|
void connected() override {}
|
|
|
|
QString dbusPath() const override;
|
|
|
|
public Q_SLOTS:
|
|
Q_SCRIPTABLE void sendSms(const QVariantList& addresses, const QString& messageBody, const qint64 subID = -1);
|
|
|
|
/**
|
|
* Send a request to the remote for all of its conversations
|
|
*/
|
|
Q_SCRIPTABLE void requestAllConversations();
|
|
|
|
/**
|
|
* Send a request to the remote for a particular conversation
|
|
*
|
|
* TODO: Make interface capable of requesting limited window of messages
|
|
*/
|
|
Q_SCRIPTABLE void requestConversation(const qint64& conversationID) const;
|
|
|
|
Q_SCRIPTABLE void launchApp();
|
|
|
|
private:
|
|
|
|
/**
|
|
* Send to the telepathy plugin if it is available
|
|
*/
|
|
void forwardToTelepathy(const ConversationMessage& message);
|
|
|
|
/**
|
|
* Handle a packet which contains many messages, such as PACKET_TYPE_TELEPHONY_MESSAGE
|
|
*/
|
|
bool handleBatchMessages(const NetworkPacket& np);
|
|
|
|
QDBusInterface m_telepathyInterface;
|
|
ConversationsDbusInterface* m_conversationInterface;
|
|
};
|
|
|
|
#endif
|