-
Notifications
You must be signed in to change notification settings - Fork 671
/
Copy pathsocketapi.cpp
1226 lines (1060 loc) · 47 KB
/
socketapi.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (C) by Dominik Schmidt <dev@dominik-schmidt.de>
* Copyright (C) by Klaas Freitag <freitag@owncloud.com>
* Copyright (C) by Roeland Jago Douma <roeland@famdouma.nl>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License
* for more details.
*/
#include "socketapi.h"
#include "scheduling/syncscheduler.h"
#include "socketapi_p.h"
#include "gui/commonstrings.h"
#include "accountmanager.h"
#include "common/asserts.h"
#include "common/depreaction.h"
#include "common/syncjournalfilerecord.h"
#include "common/version.h"
#include "filesystem.h"
#include "folder.h"
#include "folderman.h"
#include "guiutility.h"
#include "sharemanager.h"
#include "syncengine.h"
#include "syncfileitem.h"
#include "theme.h"
#include <array>
#include <QBitArray>
#include <QUrl>
#include <QMetaMethod>
#include <QMetaObject>
#include <QStringList>
#include <QScopedPointer>
#include <QFile>
#include <QDir>
#include <QApplication>
#include <QLocalSocket>
#include <QStringBuilder>
#include <QMessageBox>
#include <QFileDialog>
#include <QAction>
#include <QJsonArray>
#include <QJsonDocument>
#include <QJsonObject>
#include <QWidget>
#include <QBuffer>
#include <QClipboard>
#include <QProcess>
#include <QStandardPaths>
#ifdef Q_OS_MAC
#include <CoreFoundation/CoreFoundation.h>
#endif
// This is the version that is returned when the client asks for the VERSION.
// The first number should be changed if there is an incompatible change that breaks old clients.
// The second number should be changed when there are new features.
#define MIRALL_SOCKET_API_VERSION "1.1"
namespace {
const QString unregisterpathMessageC()
{
return QStringLiteral("UNREGISTER_PATH");
}
const QLatin1Char RecordSeparator()
{
return QLatin1Char('\x1e');
}
QStringList split(const QString &data)
{
// TODO: string ref?
return data.split(RecordSeparator());
}
static QString buildMessage(const QString &verb, const QString &path, const QString &status = QString())
{
QString msg(verb);
if (!status.isEmpty()) {
msg += QLatin1Char(':') + status;
}
if (!path.isEmpty()) {
const QFileInfo fi(path);
msg += QLatin1Char(':') + QDir::toNativeSeparators(fi.absoluteFilePath());
}
return msg;
}
}
namespace OCC {
Q_LOGGING_CATEGORY(lcSocketApi, "gui.socketapi", QtInfoMsg)
Q_LOGGING_CATEGORY(lcPublicLink, "gui.socketapi.publiclink", QtInfoMsg)
void SocketListener::sendMessage(const QString &message, bool doWait) const
{
if (!socket) {
qCInfo(lcSocketApi) << "Not sending message to dead socket:" << message;
return;
}
qCInfo(lcSocketApi) << "Sending SocketAPI message -->" << message << "to" << socket;
QString localMessage = message;
if (!localMessage.endsWith(QLatin1Char('\n'))) {
localMessage.append(QLatin1Char('\n'));
}
QByteArray bytesToSend = localMessage.toUtf8();
qint64 sent = socket->write(bytesToSend);
if (doWait) {
socket->waitForBytesWritten(1000);
}
if (sent != bytesToSend.length()) {
qCWarning(lcSocketApi) << "Could not send all data on socket for " << localMessage;
}
}
SocketApi::SocketApi(QObject *parent)
: QObject(parent)
{
qRegisterMetaType<SocketListener *>("SocketListener*");
qRegisterMetaType<QSharedPointer<SocketApiJob>>("QSharedPointer<SocketApiJob>");
qRegisterMetaType<QSharedPointer<SocketApiJobV2>>("QSharedPointer<SocketApiJobV2>");
_socketPath = Utility::socketApiSocketPath();
// Remove any old socket that might be lying around:
SocketApiServer::removeServer(_socketPath);
// Create the socket path:
if (!Utility::isMac() && !Utility::isWindows()) {
// Not on macOS: there the directory is there, and created for us by the sandboxing
// environment, because we belong to an App Group.
QFileInfo info(_socketPath);
if (!info.dir().exists()) {
bool result = info.dir().mkpath(QStringLiteral("."));
qCDebug(lcSocketApi) << "creating" << info.dir().path() << result;
if (result) {
QFile::setPermissions(_socketPath, QFile::Permissions(QFile::ReadOwner | QFile::WriteOwner | QFile::ExeOwner));
}
}
}
// Wire up the server instance to us, so we can accept new connections:
connect(&_localServer, &SocketApiServer::newConnection, this, &SocketApi::slotNewConnection);
connect(AccountManager::instance(), &AccountManager::accountRemoved, this, [this](const auto &accountState) {
if (_registeredAccounts.contains(accountState->account())) {
unregisterAccount(accountState->account());
}
});
}
SocketApi::~SocketApi()
{
qCDebug(lcSocketApi) << "dtor";
_localServer.close();
// All remaining sockets will be destroyed with _localServer, their parent
OC_ASSERT(_listeners.isEmpty() || _listeners.first()->socket->parent() == &_localServer);
_listeners.clear();
}
void SocketApi::startShellIntegration()
{
// Start listeneing:
if (_localServer.listen(_socketPath)) {
qCInfo(lcSocketApi) << "server started, listening at " << _socketPath;
} else {
qCWarning(lcSocketApi) << "can't start server" << _socketPath;
}
// Now we're ready to start the native shell integration:
Utility::startShellIntegration();
}
void SocketApi::slotNewConnection()
{
// Note that on macOS this is not actually a line-based QIODevice, it's a SocketApiSocket which is our
// custom message based macOS IPC.
SocketApiSocket *socket = _localServer.nextPendingConnection();
if (!socket) {
return;
}
qCInfo(lcSocketApi) << "New connection" << socket;
connect(socket, &SocketApiSocket::readyRead, this, &SocketApi::slotReadSocket);
connect(socket, &SocketApiSocket::disconnected, this, [socket] {
qCInfo(lcSocketApi) << "Lost connection " << socket;
// will trigger destroyed in the next execution of the main loop
// a direct removal can cause issues when iterating on _listeners
socket->deleteLater();
});
connect(socket, &SocketApiSocket::destroyed, this, [socket, this] {
_listeners.remove(socket);
});
OC_ASSERT(socket->readAll().isEmpty());
auto listener = QSharedPointer<SocketListener>::create(socket);
_listeners.insert(socket, listener);
for (const auto &a : qAsConst(_registeredAccounts)) {
if (a->hasDefaultSyncRoot()) {
broadcastMessage(buildRegisterPathMessage(Utility::stripTrailingSlash(a->defaultSyncRoot())));
}
}
for (Folder *f : FolderMan::instance()->folders()) {
if (f->canSync()) {
QString message = buildRegisterPathMessage(Utility::stripTrailingSlash(f->path()));
listener->sendMessage(message);
}
}
}
void SocketApi::slotReadSocket()
{
SocketApiSocket *socket = qobject_cast<SocketApiSocket *>(sender());
OC_ENFORCE(socket);
// Find the SocketListener
//
// It's possible for the disconnected() signal to be triggered before
// the readyRead() signals are received - in that case there won't be a
// valid listener. We execute the handler anyway, but it will work with
// a SocketListener that doesn't send any messages.
static auto invalidListener = QSharedPointer<SocketListener>::create(nullptr);
const auto listener = _listeners.value(socket, invalidListener);
while (socket->canReadLine()) {
// Make sure to normalize the input from the socket to
// make sure that the path will match, especially on OS X.
QString line = QString::fromUtf8(socket->readLine()).normalized(QString::NormalizationForm_C);
// Note: do NOT use QString::trimmed() here! That will also remove any trailing spaces (which _are_ part of the filename)!
line.chop(1); // remove the '\n'
qCInfo(lcSocketApi) << "Received SocketAPI message <--" << line << "from" << socket;
const int argPos = line.indexOf(QLatin1Char(':'));
const QString command = line.mid(0, argPos).toUpper();
const int indexOfMethod = [&] {
QByteArray functionWithArguments = QByteArrayLiteral("command_");
if (command.startsWith(QLatin1String("ASYNC_"))) {
functionWithArguments += command.toUtf8() + QByteArrayLiteral("(QSharedPointer<SocketApiJob>)");
} else if (command.startsWith(QLatin1String("V2/"))) {
functionWithArguments += QByteArrayLiteral("V2_") + command.mid(3).toUtf8() + QByteArrayLiteral("(QSharedPointer<SocketApiJobV2>)");
} else {
functionWithArguments += command.toUtf8() + QByteArrayLiteral("(QString,SocketListener*)");
}
Q_ASSERT(staticMetaObject.normalizedSignature(functionWithArguments.constData()) == functionWithArguments);
const auto out = staticMetaObject.indexOfMethod(functionWithArguments.constData());
if (out == -1) {
listener->sendError(QStringLiteral("Function %1 not found").arg(QString::fromUtf8(functionWithArguments)));
}
OC_ASSERT(out != -1);
return out;
}();
const auto argument = argPos != -1 ? line.mid(argPos + 1) : QString();
if (command.startsWith(QLatin1String("ASYNC_"))) {
auto arguments = argument.split(QLatin1Char('|'));
if (arguments.size() != 2) {
listener->sendError(QStringLiteral("argument count is wrong"));
return;
}
auto json = QJsonDocument::fromJson(arguments[1].toUtf8()).object();
auto jobId = arguments[0];
auto socketApiJob = QSharedPointer<SocketApiJob>(new SocketApiJob(jobId, listener, json), &QObject::deleteLater);
if (indexOfMethod != -1) {
staticMetaObject.method(indexOfMethod)
.invoke(this, Qt::QueuedConnection,
Q_ARG(QSharedPointer<SocketApiJob>, socketApiJob));
} else {
qCWarning(lcSocketApi) << "The command is not supported by this version of the client:" << command
<< "with argument:" << argument;
socketApiJob->reject(QStringLiteral("command not found"));
}
} else if (command.startsWith(QLatin1String("V2/"))) {
QJsonParseError error;
const auto json = QJsonDocument::fromJson(argument.toUtf8(), &error).object();
if (error.error != QJsonParseError::NoError) {
qCWarning(lcSocketApi()) << "Invalid json" << argument << error.errorString();
listener->sendError(error.errorString());
return;
}
auto socketApiJob = QSharedPointer<SocketApiJobV2>::create(listener, command, json);
if (indexOfMethod != -1) {
staticMetaObject.method(indexOfMethod)
.invoke(this, Qt::QueuedConnection,
Q_ARG(QSharedPointer<SocketApiJobV2>, socketApiJob));
} else {
qCWarning(lcSocketApi) << "The command is not supported by this version of the client:" << command
<< "with argument:" << argument;
socketApiJob->failure(QStringLiteral("command not found"));
}
} else {
if (indexOfMethod != -1) {
// to ensure that listener is still valid we need to call it with Qt::DirectConnection
OC_ASSERT(thread() == QThread::currentThread())
staticMetaObject.method(indexOfMethod).invoke(this, Qt::DirectConnection, Q_ARG(QString, argument), Q_ARG(SocketListener *, listener.data()));
}
}
}
}
void SocketApi::registerAccount(const AccountPtr &a)
{
// Make sure not to register twice to each connected client
if (_registeredAccounts.contains(a)) {
return;
}
if (a->hasDefaultSyncRoot()) {
broadcastMessage(buildRegisterPathMessage(Utility::stripTrailingSlash(a->defaultSyncRoot())));
}
_registeredAccounts.insert(a);
}
void SocketApi::unregisterAccount(const AccountPtr &a)
{
if (!_registeredAccounts.contains(a)) {
return;
}
if (a->hasDefaultSyncRoot()) {
broadcastMessage(buildMessage(unregisterpathMessageC(), Utility::stripTrailingSlash(a->defaultSyncRoot())));
}
_registeredAccounts.remove(a);
}
void SocketApi::slotRegisterPath(Folder *folder)
{
// Make sure not to register twice to each connected client
if (_registeredFolders.contains(folder))
return;
broadcastMessage(buildRegisterPathMessage(Utility::stripTrailingSlash(folder->path())));
_registeredFolders.insert(folder);
}
void SocketApi::slotUnregisterPath(Folder *folder)
{
if (!_registeredFolders.contains(folder))
return;
broadcastMessage(buildMessage(unregisterpathMessageC(), Utility::stripTrailingSlash(folder->path()), QString()), true);
_registeredFolders.remove(folder);
}
void SocketApi::slotUpdateFolderView(Folder *f)
{
if (_listeners.isEmpty()) {
return;
}
if (f) {
// do only send UPDATE_VIEW for a couple of status
switch (f->syncResult().status()) {
case SyncResult::SyncPrepare:
Q_FALLTHROUGH();
case SyncResult::Success:
Q_FALLTHROUGH();
case SyncResult::Paused:
Q_FALLTHROUGH();
case SyncResult::Problem:
Q_FALLTHROUGH();
case SyncResult::Error: {
const QString rootPath = Utility::stripTrailingSlash(f->path());
broadcastStatusPushMessage(rootPath, f->syncEngine().syncFileStatusTracker().fileStatus(QString()));
broadcastMessage(buildMessage(QStringLiteral("UPDATE_VIEW"), rootPath));
break;
}
case SyncResult::SetupError:
[[fallthrough]];
case OCC::SyncResult::Undefined:
Q_FALLTHROUGH();
case OCC::SyncResult::NotYetStarted:
Q_FALLTHROUGH();
case OCC::SyncResult::SyncRunning:
Q_FALLTHROUGH();
case OCC::SyncResult::SyncAbortRequested:
[[fallthrough]];
case OCC::SyncResult::Offline:
qCDebug(lcSocketApi) << "Not sending UPDATE_VIEW for" << f->path() << "because status() is" << f->syncResult().status();
}
}
}
void SocketApi::broadcastMessage(const QString &msg, bool doWait)
{
for (const auto &listener : qAsConst(_listeners)) {
listener->sendMessage(msg, doWait);
}
}
void SocketApi::processShareRequest(const QString &localFile, SocketListener *listener, ShareDialogStartPage startPage)
{
auto theme = Theme::instance();
auto fileData = FileData::get(localFile);
auto shareFolder = fileData.folder;
if (!shareFolder) {
const QString message = QLatin1String("SHARE:NOP:") + QDir::toNativeSeparators(localFile);
// files that are not within a sync folder are not synced.
listener->sendMessage(message);
} else if (!shareFolder->accountState()->isConnected()) {
const QString message = QLatin1String("SHARE:NOTCONNECTED:") + QDir::toNativeSeparators(localFile);
// if the folder isn't connected, don't open the share dialog
listener->sendMessage(message);
} else if (!theme->linkSharing() && !theme->userGroupSharing()) {
const QString message = QLatin1String("SHARE:NOP:") + QDir::toNativeSeparators(localFile);
listener->sendMessage(message);
} else {
// If the file doesn't have a journal record, it might not be uploaded yet
if (!fileData.journalRecord().isValid()) {
const QString message = QLatin1String("SHARE:NOTSYNCED:") + QDir::toNativeSeparators(localFile);
listener->sendMessage(message);
return;
}
auto &remotePath = fileData.serverRelativePath;
// Can't share root folder
if (remotePath == QLatin1String("/")) {
const QString message = QLatin1String("SHARE:CANNOTSHAREROOT:") + QDir::toNativeSeparators(localFile);
listener->sendMessage(message);
return;
}
const QString message = QLatin1String("SHARE:OK:") + QDir::toNativeSeparators(localFile);
listener->sendMessage(message);
emit shareCommandReceived(remotePath, fileData.localPath, startPage);
}
}
void SocketApi::broadcastStatusPushMessage(const QString &systemPath, SyncFileStatus fileStatus)
{
QString msg = buildMessage(QStringLiteral("STATUS"), systemPath, fileStatus.toSocketAPIString());
Q_ASSERT(!systemPath.endsWith(QLatin1Char('/')));
auto directoryHash = qHash(systemPath.left(systemPath.lastIndexOf(QLatin1Char('/'))));
for (const auto &listener : qAsConst(_listeners)) {
listener->sendMessageIfDirectoryMonitored(msg, directoryHash);
}
}
void SocketApi::command_RETRIEVE_FOLDER_STATUS(const QString &argument, SocketListener *listener)
{
// This command is the same as RETRIEVE_FILE_STATUS
command_RETRIEVE_FILE_STATUS(argument, listener);
}
void SocketApi::command_RETRIEVE_FILE_STATUS(const QString &argument, SocketListener *listener)
{
QString statusString;
auto fileData = FileData::get(argument);
if (!fileData.folder) {
// this can happen in offline mode e.g.: nothing to worry about
statusString = SyncFileStatus(SyncFileStatus::StatusNone).toSocketAPIString();
} else {
// The user probably visited this directory in the file shell.
// Let the listener know that it should now send status pushes for sibblings of this file.
QString directory = fileData.localPath.left(fileData.localPath.lastIndexOf(QLatin1Char('/')));
listener->registerMonitoredDirectory(qHash(directory));
statusString = fileData.syncFileStatus().toSocketAPIString();
}
const QString message = QStringLiteral("STATUS:") % statusString % QLatin1Char(':') % QDir::toNativeSeparators(argument);
listener->sendMessage(message);
}
void SocketApi::command_SHARE(const QString &localFile, SocketListener *listener)
{
processShareRequest(localFile, listener, ShareDialogStartPage::UsersAndGroups);
}
void SocketApi::command_MANAGE_PUBLIC_LINKS(const QString &localFile, SocketListener *listener)
{
processShareRequest(localFile, listener, ShareDialogStartPage::PublicLinks);
}
void SocketApi::command_VERSION(const QString &, SocketListener *listener)
{
listener->sendMessage(QStringLiteral("VERSION:%1:%2").arg(OCC::Version::versionWithBuildNumber().toString(), QStringLiteral(MIRALL_SOCKET_API_VERSION)));
}
void SocketApi::command_SHARE_MENU_TITLE(const QString &, SocketListener *listener)
{
listener->sendMessage(QLatin1String("SHARE_MENU_TITLE:") + tr("Share with %1", "parameter is ownCloud").arg(Theme::instance()->appNameGUI()));
}
class GetOrCreatePublicLinkShare : public QObject
{
Q_OBJECT
public:
GetOrCreatePublicLinkShare(const AccountPtr &account,
const QString &serverPath, QObject *parent)
: QObject(parent)
, _account(account)
, _shareManager(account)
, _serverPath(serverPath)
{
connect(&_shareManager, &ShareManager::sharesFetched,
this, &GetOrCreatePublicLinkShare::sharesFetched);
connect(&_shareManager, &ShareManager::linkShareCreated,
this, &GetOrCreatePublicLinkShare::linkShareCreated);
connect(&_shareManager, &ShareManager::linkShareCreationForbidden,
this, &GetOrCreatePublicLinkShare::linkShareCreationForbidden);
connect(&_shareManager, &ShareManager::serverError,
this, &GetOrCreatePublicLinkShare::serverError);
}
void run()
{
qCDebug(lcPublicLink) << "Fetching shares";
_shareManager.fetchShares(_serverPath);
}
private slots:
void sharesFetched(const QList<QSharedPointer<Share>> &shares)
{
auto shareName = SocketApi::tr("Context menu share");
// If shares will expire, create a new one every day.
QDate expireDate;
if (_account->capabilities().sharePublicLinkDefaultExpire()) {
shareName = SocketApi::tr("Context menu share %1").arg(QDate::currentDate().toString(Qt::ISODate));
expireDate = QDate::currentDate().addDays(
_account->capabilities().sharePublicLinkDefaultExpireDateDays());
}
// If there already is a context menu share, reuse it
for (const auto &share : shares) {
const auto linkShare = qSharedPointerDynamicCast<LinkShare>(share);
if (!linkShare)
continue;
if (linkShare->getName() == shareName) {
qCDebug(lcPublicLink) << "Found existing share, reusing";
return success(linkShare->getLink().toString());
}
}
// otherwise create a new one
qCDebug(lcPublicLink) << "Creating new share";
QString noPassword;
_shareManager.createLinkShare(_serverPath, shareName, noPassword, expireDate);
}
void linkShareCreated(const QSharedPointer<LinkShare> &share)
{
qCDebug(lcPublicLink) << "New share created";
success(share->getLink().toString());
}
void linkShareCreationForbidden(const QString &message)
{
qCInfo(lcPublicLink) << "Could not create link share:" << message;
emit error(message);
deleteLater();
}
void serverError(int code, const QString &message)
{
qCWarning(lcPublicLink) << "Share fetch/create error" << code << message;
emit error(message);
deleteLater();
}
signals:
void done(const QString &link);
void error(const QString &message);
private:
void success(const QString &link)
{
emit done(link);
deleteLater();
}
AccountPtr _account;
ShareManager _shareManager;
QString _serverPath;
};
void SocketApi::command_COPY_PUBLIC_LINK(const QString &localFile, SocketListener *)
{
auto fileData = FileData::get(localFile);
if (!fileData.folder)
return;
AccountPtr account = fileData.folder->accountState()->account();
auto job = new GetOrCreatePublicLinkShare(account, fileData.serverRelativePath, this);
connect(job, &GetOrCreatePublicLinkShare::done, this,
[](const QString &url) { copyUrlToClipboard(QUrl(url)); });
connect(job, &GetOrCreatePublicLinkShare::error, this,
[=]() { emit shareCommandReceived(fileData.serverRelativePath, fileData.localPath, ShareDialogStartPage::PublicLinks); });
job->run();
}
// Fetches the private link url asynchronously and then calls the target slot
void SocketApi::fetchPrivateLinkUrlHelper(const QString &localFile, const std::function<void(const QUrl &url)> &targetFun)
{
auto fileData = FileData::get(localFile);
if (!fileData.folder) {
qCWarning(lcSocketApi) << "Unknown path" << localFile;
return;
}
if (!fileData.isSyncFolder()) {
auto record = fileData.journalRecord();
if (!record.isValid())
return;
}
fetchPrivateLinkUrl(
fileData.folder->accountState()->account(),
fileData.folder->webDavUrl(),
fileData.serverRelativePath,
this,
targetFun);
}
void SocketApi::command_COPY_PRIVATE_LINK(const QString &localFile, SocketListener *)
{
fetchPrivateLinkUrlHelper(localFile, &SocketApi::copyUrlToClipboard);
}
void SocketApi::command_EMAIL_PRIVATE_LINK(const QString &localFile, SocketListener *)
{
fetchPrivateLinkUrlHelper(localFile, &SocketApi::emailPrivateLink);
}
void SocketApi::command_OPEN_PRIVATE_LINK(const QString &localFile, SocketListener *)
{
fetchPrivateLinkUrlHelper(localFile, &SocketApi::openPrivateLink);
}
void SocketApi::command_OPEN_PRIVATE_LINK_VERSIONS(const QString &localFile, SocketListener *)
{
const auto fileData = FileData::get(localFile);
if (fileData.isValid() && fileData.folder->accountState()->account()->capabilities().filesSharing().sharing_roles) {
fetchPrivateLinkUrl(fileData.folder->accountState()->account(), fileData.folder->webDavUrl(), fileData.serverRelativePath, this, [](const QUrl &url) {
const auto queryUrl = Utility::concatUrlPath(url, QString(), {{QStringLiteral("details"), QStringLiteral("versions")}});
Utility::openBrowser(queryUrl, nullptr);
});
} else {
fetchPrivateLinkUrlHelper(localFile, [this](const QUrl &link) {
Utility::openBrowser(Utility::concatUrlPath(link, {}, {{QStringLiteral("details"), QStringLiteral("versionsTabView")}}), nullptr);
});
}
}
void SocketApi::copyUrlToClipboard(const QUrl &link)
{
QApplication::clipboard()->setText(link.toString());
}
void SocketApi::command_MAKE_AVAILABLE_LOCALLY(const QString &filesArg, SocketListener *)
{
const QStringList files = split(filesArg);
for (const auto &file : files) {
auto data = FileData::get(file);
if (!data.folder || !data.folder->isReady())
continue;
// Update the pin state on all items
std::ignore = data.folder->vfs().setPinState(data.folderRelativePath, PinState::AlwaysLocal);
// Trigger sync
data.folder->schedulePathForLocalDiscovery(data.folderRelativePath);
FolderMan::instance()->scheduler()->enqueueFolder(data.folder, SyncScheduler::Priority::Medium);
}
}
/* Go over all the files and replace them by a virtual file */
void SocketApi::command_MAKE_ONLINE_ONLY(const QString &filesArg, SocketListener *)
{
const QStringList files = split(filesArg);
for (const auto &file : files) {
auto data = FileData::get(file);
if (!data.folder || !data.folder->isReady())
continue;
// Update the pin state on all items
std::ignore = data.folder->vfs().setPinState(data.folderRelativePath, PinState::OnlineOnly);
// Trigger sync
data.folder->schedulePathForLocalDiscovery(data.folderRelativePath);
FolderMan::instance()->scheduler()->enqueueFolder(data.folder, SyncScheduler::Priority::Medium);
}
}
void SocketApi::command_DELETE_ITEM(const QString &localFile, SocketListener *)
{
QFileInfo info(localFile);
auto result = QMessageBox::question(
nullptr, tr("Confirm deletion"),
info.isDir()
? tr("Do you want to delete the directory <i>%1</i> and all its contents permanently?").arg(info.dir().dirName())
: tr("Do you want to delete the file <i>%1</i> permanently?").arg(info.fileName()),
QMessageBox::Yes, QMessageBox::No);
if (result != QMessageBox::Yes)
return;
if (info.isDir()) {
FileSystem::RemoveEntryList removed;
FileSystem::RemoveEntryList locked;
FileSystem::RemoveErrorList errors;
FileSystem::removeRecursively(localFile, &removed, &locked, &errors);
} else {
QFile(localFile).remove();
}
}
void SocketApi::command_MOVE_ITEM(const QString &localFile, SocketListener *)
{
auto fileData = FileData::get(localFile);
auto parentDir = fileData.parentFolder();
if (!fileData.folder)
return; // should not have shown menu item
QString defaultDirAndName = fileData.folderRelativePath;
// If it's a conflict, we want to save it under the base name by default
if (Utility::isConflictFile(defaultDirAndName)) {
defaultDirAndName = QString::fromUtf8(fileData.folder->journalDb()->conflictFileBaseName(fileData.folderRelativePath.toUtf8()));
}
// If the parent doesn't accept new files, go to the root of the sync folder
QFileInfo fileInfo(localFile);
auto parentRecord = parentDir.journalRecord();
if ((fileInfo.isFile() && !parentRecord._remotePerm.hasPermission(RemotePermissions::CanAddFile))
|| (fileInfo.isDir() && !parentRecord._remotePerm.hasPermission(RemotePermissions::CanAddSubDirectories))) {
defaultDirAndName = QFileInfo(defaultDirAndName).fileName();
}
// Add back the folder path
defaultDirAndName = QDir(fileData.folder->path()).filePath(defaultDirAndName);
auto target = QFileDialog::getSaveFileName(
nullptr,
tr("Select new location..."),
defaultDirAndName,
QString(), nullptr, QFileDialog::HideNameFilterDetails);
if (target.isEmpty())
return;
QString error;
if (!FileSystem::uncheckedRenameReplace(localFile, target, &error)) {
qCWarning(lcSocketApi) << "Rename error:" << error;
QMessageBox::warning(
nullptr, tr("Error"),
tr("Moving file failed:\n\n%1").arg(error));
}
}
Q_INVOKABLE void OCC::SocketApi::command_OPEN_APP_LINK(const QString &localFile, [[maybe_unused]] SocketListener *listener)
{
const auto data = FileData::get(localFile);
if (OC_ENSURE(data.folder)) {
const auto &provider = data.folder->accountState()->account()->appProvider();
const auto record = data.journalRecord();
if (record.isValid()) {
provider.open(data.folder->accountState()->account(), localFile, record._fileId);
}
}
}
void SocketApi::command_V2_GET_CLIENT_ICON(const QSharedPointer<SocketApiJobV2> &job) const
{
if (!OC_ENSURE_NOT(job.isNull())) {
return;
}
const auto &arguments = job->arguments();
const auto size = arguments.value(QStringLiteral("size"));
if (size.isUndefined()) {
qCWarning(lcSocketApi) << "Icon size not given in " << Q_FUNC_INFO;
job->failure(QStringLiteral("cannot get client icon"));
return;
}
QByteArray data;
const Theme *theme = Theme::instance();
// return an empty answer if the end point was disabled
if (theme->enableSocketApiIconSupport()) {
const QIcon appIcon = theme->applicationIcon();
qCDebug(lcSocketApi) << Q_FUNC_INFO << " got icon from theme: " << appIcon;
// convert to pixmap (might be smaller if size is not available)
const QPixmap pixmap = appIcon.pixmap(QSize(size.toInt(), size.toInt()));
// Convert pixmap to in-memory PNG
QByteArray png;
QBuffer pngBuffer(&png);
auto success = pngBuffer.open(QIODevice::WriteOnly);
if (!success) {
qCWarning(lcSocketApi) << "Error opening buffer for png in " << Q_FUNC_INFO;
job->failure(QStringLiteral("cannot get client icon"));
return;
}
success = pixmap.save(&pngBuffer, "PNG");
if (!success) {
qCWarning(lcSocketApi) << "Error saving client icon as png in " << Q_FUNC_INFO;
job->failure(QStringLiteral("cannot get client icon"));
return;
}
data = pngBuffer.data().toBase64();
}
job->success({{QStringLiteral("png"), QString::fromUtf8(data)}});
}
void SocketApi::command_V2_RETRIEVE_FILE_STATUS(const QSharedPointer<SocketApiJobV2> &job)
{
if (!OC_ENSURE_NOT(job.isNull())) {
return;
}
const auto &arguments = job->arguments();
SyncFileStatus status = SyncFileStatus::StatusNone;
auto fileData = FileData::get(arguments.value(QStringLiteral("path")).toString());
if (fileData.folder) {
// The user probably visited this directory in the file shell.
// Let the listener know that it should now send status pushes for sibblings of this file.
// TODO:
// QString directory = fileData.localPath.left(fileData.localPath.lastIndexOf(QLatin1Char('/')));
// listener->registerMonitoredDirectory(qHash(directory));
status = fileData.syncFileStatus();
}
job->success({{QStringLiteral("status"), SyncFileStatus(status).toSocketAPIString()}});
}
void SocketApi::emailPrivateLink(const QUrl &link)
{
Utility::openEmailComposer(
tr("I shared something with you"),
link.toString(),
nullptr);
}
void OCC::SocketApi::openPrivateLink(const QUrl &link)
{
Utility::openBrowser(link, nullptr);
}
void SocketApi::command_GET_STRINGS(const QString &argument, SocketListener *listener)
{
static std::array<std::pair<QString, QString>, 5> strings { {
{ QStringLiteral("SHARE_MENU_TITLE"), tr("Share...") },
{ QStringLiteral("CONTEXT_MENU_TITLE"), Theme::instance()->appNameGUI() },
{ QStringLiteral("COPY_PRIVATE_LINK_MENU_TITLE"), tr("Copy private link to clipboard") },
{ QStringLiteral("EMAIL_PRIVATE_LINK_MENU_TITLE"), tr("Send private link by email...") },
} };
listener->sendMessage(QStringLiteral("GET_STRINGS:BEGIN"));
for (auto key_value : strings) {
if (argument.isEmpty() || argument == key_value.first) {
listener->sendMessage(QStringLiteral("STRING:%1:%2").arg(key_value.first, key_value.second));
}
}
listener->sendMessage(QStringLiteral("GET_STRINGS:END"));
}
void SocketApi::sendSharingContextMenuOptions(const FileData &fileData, SocketListener *listener)
{
auto record = fileData.journalRecord();
bool isOnTheServer = record.isValid();
auto flagString = isOnTheServer ? QStringLiteral("::") : QStringLiteral(":d:");
auto capabilities = fileData.folder->accountState()->account()->capabilities();
auto theme = Theme::instance();
if (!capabilities.shareAPI() || !(theme->userGroupSharing() || (theme->linkSharing() && capabilities.sharePublicLink())))
return;
// If sharing is globally disabled, do not show any sharing entries.
// If there is no permission to share for this file, add a disabled entry saying so
if (isOnTheServer && !record._remotePerm.isNull() && !record._remotePerm.hasPermission(RemotePermissions::CanReshare)) {
listener->sendMessage(QStringLiteral("MENU_ITEM:DISABLED:d:") + (!record.isDirectory() ? tr("Resharing this file is not allowed") : tr("Resharing this folder is not allowed")));
} else {
listener->sendMessage(QStringLiteral("MENU_ITEM:SHARE") + flagString + tr("Share..."));
// Do we have public links?
bool publicLinksEnabled = theme->linkSharing() && capabilities.sharePublicLink();
// Is is possible to create a public link without user choices?
bool canCreateDefaultPublicLink = publicLinksEnabled
&& !capabilities.sharePublicLinkEnforcePasswordForReadOnly();
if (canCreateDefaultPublicLink) {
if (fileData.folder->accountState()->supportsSpaces()) {
// TODO: See https://github.com/owncloud/client/issues/10845 : oCIS is getting a new sharing API, waiting for that before implementing a
// temporary solution.
} else {
listener->sendMessage(QStringLiteral("MENU_ITEM:COPY_PUBLIC_LINK") + flagString + tr("Create and copy public link to clipboard"));
}
} else if (publicLinksEnabled) {
listener->sendMessage(QStringLiteral("MENU_ITEM:MANAGE_PUBLIC_LINKS") + flagString + tr("Copy public link to clipboard"));
}
}
if (capabilities.privateLinkPropertyAvailable()) {
listener->sendMessage(QStringLiteral("MENU_ITEM:COPY_PRIVATE_LINK") + flagString + tr("Copy private link to clipboard"));
}
}
SocketApi::FileData SocketApi::FileData::get(const QString &localFile)
{
FileData data;
data.localPath = QDir::cleanPath(localFile);
if (data.localPath.endsWith(QLatin1Char('/')))
data.localPath.chop(1);
data.folder = FolderMan::instance()->folderForPath(data.localPath, &data.folderRelativePath);
if (!data.folder)
return data;
data.serverRelativePath = QDir(data.folder->remotePath()).filePath(data.folderRelativePath);
if (data.folder->isReady()) {
data.serverRelativePath = data.folder->vfs().underlyingFileName(data.serverRelativePath);
}
return data;
}
QString SocketApi::FileData::folderRelativePathNoVfsSuffix() const
{
if (folder->isReady()) {
return folder->vfs().underlyingFileName(folderRelativePath);
}
return folderRelativePath;
}
bool OCC::SocketApi::FileData::isSyncFolder() const
{
return folderRelativePath.isEmpty();
}
SyncFileStatus SocketApi::FileData::syncFileStatus() const
{
if (!folder)
return SyncFileStatus::StatusNone;
return folder->syncEngine().syncFileStatusTracker().fileStatus(folderRelativePath);
}
SyncJournalFileRecord SocketApi::FileData::journalRecord() const
{
SyncJournalFileRecord record;
if (!folder)
return record;
folder->journalDb()->getFileRecord(folderRelativePath, &record);
return record;
}
SocketApi::FileData SocketApi::FileData::parentFolder() const
{
return FileData::get(QFileInfo(localPath).dir().path());
}
bool SocketApi::FileData::isValid() const
{
return folder;
}
void SocketApi::command_GET_MENU_ITEMS(const QString &argument, OCC::SocketListener *listener)
{
listener->sendMessage(QStringLiteral("GET_MENU_ITEMS:BEGIN"));
const QStringList files = split(argument);
// Some options only show for single files
if (files.size() == 1) {
const FileData fileData = FileData::get(files.first());
if (fileData.isValid() && fileData.folder->accountState()->isConnected()) {
const auto &capabilities = fileData.folder->accountState()->account()->capabilities();
if (!fileData.isSyncFolder()) {