Differential D9691 Diff 32908 plugins/contacts/contactsplugin.cpp

Changeset View

Standalone View

View Options

plugins/contacts/contactsplugin.cpp

  • This file was added.
1​/**
2​ * Copyright 2018 Simon Redman <simon@ergotech.com>
3​ *
4​ * This program is free software; you can redistribute it and/or
5​ * modify it under the terms of the GNU General Public License as
6​ * published by the Free Software Foundation; either version 2 of
7​ * the License or (at your option) version 3 or any later version
8​ * accepted by the membership of KDE e.V. (or its successor approved
9​ * by the membership of KDE e.V.), which shall act as a proxy
10​ * defined in Section 14 of version 3 of the license.
11​ *
12​ * This program is distributed in the hope that it will be useful,
13​ * but WITHOUT ANY WARRANTY; without even the implied warranty of
14​ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15​ * GNU General Public License for more details.
16​ *
17​ * You should have received a copy of the GNU General Public License
18​ * along with this program. If not, see <http://www.gnu.org/licenses/>.
19​ */
20​
21​#include <contactsplugin.h>
22​
23​#include <KLocalizedString>
24​#include <KPluginFactory>
25​
26​#include <QDebug>
27​#include <QDBusConnection>
28​#include <QtDBus>
29​#include <QEventLoop>
30​#include <QLoggingCategory>
31​#include <QFile>
32​#include <QDir>
33​#include <QIODevice>
34​
35​#include <core/device.h>
36​
37​K_PLUGIN_FACTORY_WITH_JSON(KdeConnectPluginFactory, "kdeconnect_contacts.json",
38​ registerPlugin<ContactsPlugin>(); )
39​
40​Q_LOGGING_CATEGORY(KDECONNECT_PLUGIN_CONTACTS, "kdeconnect.plugin.contacts")
41​
42​ContactsPlugin::ContactsPlugin (QObject* parent, const QVariantList& args) :
43​ KdeConnectPlugin(parent, args) {
44​ vcardsPath = QString(*vcardsLocation).append("/kdeconnect-").append(device()->id());
45​
46​ // Register custom types with dbus
47​ qRegisterMetaType<uID>("uID");
48​ qDBusRegisterMetaType<uID>();
49​
50​ qRegisterMetaType<uIDList_t>("uIDList_t");
51​ qDBusRegisterMetaType<uIDList_t>();
52​
53​ // Create the storage directory if it doesn't exist
54​ if (!QDir().mkpath(vcardsPath)) {
55​ qCWarning(KDECONNECT_PLUGIN_CONTACTS) << "handleResponseVCards:" << "Unable to create VCard directory";
56​ }
57​
58​ this->synchronizeRemoteWithLocal();
59​
60​ qCDebug(KDECONNECT_PLUGIN_CONTACTS) << "Contacts constructor for device " << device()->name();
61​}
62​
63​ContactsPlugin::~ContactsPlugin () {
64​ QDBusConnection::sessionBus().unregisterObject(dbusPath(), QDBusConnection::UnregisterTree);
65​// qCDebug(KDECONNECT_PLUGIN_CONTACTS) << "Contacts plugin destructor for device" << device()->name();
66​}
67​
68​bool ContactsPlugin::receivePacket (const NetworkPacket& np) {
69​ qCDebug(KDECONNECT_PLUGIN_CONTACTS) << "Packet Received for device " << device()->name();
70​ qCDebug(KDECONNECT_PLUGIN_CONTACTS) << np.body();
71​
mtijinkUnsubmitted
Done

It's not really common in C++ to write this->.

mtijink: It's not really common in C++ to write `this->`.
sredmanAuthorUnsubmitted
Done

Does it do any harm? It's a habit from writing too much Python (which I'd rather keep so I can still writing Python) and being overly clear never hurt anybody

sredman: Does it do any harm? It's a habit from writing too much Python (which I'd rather keep so I can…
72​ if (np.type() == PACKAGE_TYPE_CONTACTS_RESPONSE_UIDS_TIMESTAMPS) {
apolUnsubmitted
Done

in KDE Connect we don't add a new line after the if:
} else if () {

Fix others too.

apol: in KDE Connect we don't add a new line after the if: `} else if () {` Fix others too.
73​ return this->handleResponseUIDsTimestamps(np);
74​ } else if (np.type() == PACKET_TYPE_CONTACTS_RESPONSE_VCARDS) {
75​ return this->handleResponseVCards(np);
76​ } else {
77​ // Is this check necessary?
78​ qCDebug(KDECONNECT_PLUGIN_CONTACTS) << "Unknown package type received from device: "
79​ << device()->name() << ". Maybe you need to upgrade KDE Connect?";
80​ return false;
81​ }
82​}
83​
84​void ContactsPlugin::synchronizeRemoteWithLocal () {
85​ this->sendRequest(PACKET_TYPE_CONTACTS_REQUEST_ALL_UIDS_TIMESTAMP);
86​}
87​
88​bool ContactsPlugin::handleResponseUIDsTimestamps (const NetworkPacket& np) {
89​ if (!np.has("uids")) {
90​ qCDebug(KDECONNECT_PLUGIN_CONTACTS) << "handleResponseUIDsTimestamps:"
91​ << "Malformed packet does not have uids key";
92​ return false;
93​ }
94​ uIDList_t uIDsToUpdate;
95​ QDir vcardsDir(vcardsPath);
96​
97​ // Get a list of all file info in this directory
98​ // Clean out IDs returned from the remote. Anything leftover should be deleted
99​ QFileInfoList localVCards = vcardsDir.entryInfoList( { "*.vcard", "*.vcf" });
100​
101​ const QStringList& uIDs = np.get<QStringList>("uids");
102​
103​ // Check local storage for the contacts:
apolUnsubmitted
Done

mark uIDs const

apol: mark uIDs const
104​ // If the contact is not found in local storage, request its vcard be sent
105​ // If the contact is in local storage but not reported, delete it
106​ // If the contact is in local storage, compare its timestamp. If different, request the contact
107​ for (const QString& ID : uIDs) {
108​ QString filename = vcardsDir.filePath(ID + VCARD_EXTENSION);
109​ QFile vcardFile(filename);
110​
apolUnsubmitted
Done

const QString & ID

apol: const QString & ID
111​ if (!QFile().exists(filename)) {
112​ // We do not have a vcard for this contact. Request it.
113​ uIDsToUpdate.push_back(ID);
114​ continue;
115​ }
116​
117​ // Remove this file from the list of known files
118​ QFileInfo fileInfo(vcardFile);
119​ bool success = localVCards.removeOne(fileInfo);
120​ Q_ASSERT(success); // We should have always been able to remove the existing file from our listing
121​
122​ // Check if the vcard needs to be updated
123​ if (!vcardFile.open(QIODevice::ReadOnly)) {
124​ qCWarning(KDECONNECT_PLUGIN_CONTACTS) << "handleResponseUIDsTimestamps:"
125​ << "Unable to open" << filename << "to read even though it was reported to exist";
126​ continue;
127​ }
128​
129​ QTextStream fileReadStream(&vcardFile);
130​ QString line;
131​ while (!fileReadStream.atEnd()) {
132​ fileReadStream >> line;
133​ // TODO: Check that the saved ID is the same as the one we were expecting. This requires parsing the VCard
134​ if (!line.startsWith("X-KDECONNECT-TIMESTAMP:")) {
135​ continue;
136​ }
137​ QStringList parts = line.split(":");
138​ QString timestamp = parts[1];
139​
140​ qint32 remoteTimestamp = np.get<qint32>(ID);
141​ qint32 localTimestamp = timestamp.toInt();
142​
143​ if (!(localTimestamp == remoteTimestamp)) {
144​ uIDsToUpdate.push_back(ID);
145​ }
146​ }
147​ }
148​
149​ // Delete all locally-known files which were not reported by the remote device
150​ for (const QFileInfo& unknownFile : localVCards) {
151​ QFile toDelete(unknownFile.filePath());
152​ toDelete.remove();
153​ }
154​
155​ this->sendRequestWithIDs(PACKET_TYPE_CONTACTS_REQUEST_VCARDS_BY_UIDS, uIDsToUpdate);
156​
157​ return true;
158​}
159​
160​bool ContactsPlugin::handleResponseVCards (const NetworkPacket& np) {
161​ if (!np.has("uids")) {
162​ qCDebug(KDECONNECT_PLUGIN_CONTACTS)
163​ << "handleResponseVCards:" << "Malformed packet does not have uids key";
164​ return false;
165​ }
166​
167​ QDir vcardsDir(vcardsPath);
168​ const QStringList& uIDs = np.get<QStringList>("uids");
169​
170​ // Loop over all IDs, extract the VCard from the packet and write the file
171​ for (const auto& ID : uIDs) {
172​ qCDebug(KDECONNECT_PLUGIN_CONTACTS) << "Got VCard:" << np.get<QString>(ID);
173​ QString filename = vcardsDir.filePath(ID + VCARD_EXTENSION);
174​ QFile vcardFile(filename);
175​ bool vcardFileOpened = vcardFile.open(QIODevice::WriteOnly); // Want to smash anything that might have already been there
176​ if (!vcardFileOpened) {
177​ qCWarning(KDECONNECT_PLUGIN_CONTACTS) << "handleResponseVCards:" << "Unable to open" << filename;
178​ continue;
179​ }
180​
181​ QTextStream fileWriteStream(&vcardFile);
apolUnsubmitted
Done

auto &

apol: auto &
182​ const QString& vcard = np.get<QString>(ID);
183​ fileWriteStream << vcard;
184​ }
185​ qCDebug(KDECONNECT_PLUGIN_CONTACTS) << "handleResponseVCards:" << "Got" << uIDs.size() << "VCards";
186​ Q_EMIT localCacheSynchronized(uIDs);
187​ return true;
188​}
189​
190​bool ContactsPlugin::sendRequest (const QString& packetType) {
191​ NetworkPacket np(packetType);
192​ bool success = sendPacket(np);
193​ qCDebug(KDECONNECT_PLUGIN_CONTACTS) << "sendRequest: Sending " << packetType << success;
194​
195​ return success;
196​}
197​
198​bool ContactsPlugin::sendRequestWithIDs (const QString& packetType, const uIDList_t& uIDs) {
199​ NetworkPacket np(packetType);
200​
201​ np.set<uIDList_t>("uids", uIDs);
202​ bool success = sendPacket(np);
203​ return success;
204​}
205​
206​QString ContactsPlugin::dbusPath () const {
207​ return "/modules/kdeconnect/devices/" + device()->id() + "/contacts";
208​}
209​
210​#include "contactsplugin.moc"
211​