kdeconnect-kde/plugins/sftp/sftpplugin.cpp
Antonio Larrosa 1d36164230 Use ecm_qt_declare_logging_category to declare the logging categories
This automatizes the generation of logging categories so a
kdeconnect-kde.categories is generated and installed to
/usr/share/qlogging-categories5/ so kdebugsettings can use it.

Also, sets the default logging level to Warning. So now the logs
of users won't be filled with debug messages but they can
modify the configuration easily with kdebugsettings.
2020-05-26 18:55:47 +02:00

199 lines
5.4 KiB
C++

/**
* Copyright 2014 Samoilenko Yuri<kinnalru@gmail.com>
*
* 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) version 3 or any later version
* accepted by the membership of KDE e.V. (or its successor approved
* by the membership of KDE e.V.), which shall act as a proxy
* defined in Section 14 of version 3 of the license.
*
* 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.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#include "sftpplugin.h"
#include <QDBusConnection>
#include <QDir>
#include <QDebug>
#include <QStandardPaths>
#include <KLocalizedString>
#include <KNotification>
#include <KRun>
#include <KFilePlacesModel>
#include <KPluginFactory>
#include "mounter.h"
#include "plugin_sftp_debug.h"
K_PLUGIN_CLASS_WITH_JSON(SftpPlugin, "kdeconnect_sftp.json")
static const QSet<QString> fields_c = QSet<QString>() << QStringLiteral("ip") << QStringLiteral("port") << QStringLiteral("user") << QStringLiteral("port") << QStringLiteral("path");
struct SftpPlugin::Pimpl
{
Pimpl() : m_mounter(nullptr) {}
//Add KIO entry to Dolphin's Places
KFilePlacesModel m_placesModel;
Mounter* m_mounter;
};
SftpPlugin::SftpPlugin(QObject* parent, const QVariantList& args)
: KdeConnectPlugin(parent, args)
, d(new Pimpl())
{
deviceId = device()->id();
addToDolphin();
qCDebug(KDECONNECT_PLUGIN_SFTP) << "Created device:" << device()->name();
}
SftpPlugin::~SftpPlugin()
{
removeFromDolphin();
unmount();
}
void SftpPlugin::addToDolphin()
{
removeFromDolphin();
QUrl kioUrl(QStringLiteral("kdeconnect://") + deviceId + QStringLiteral("/"));
d->m_placesModel.addPlace(device()->name(), kioUrl, QStringLiteral("kdeconnect"));
qCDebug(KDECONNECT_PLUGIN_SFTP) << "add to dolphin";
}
void SftpPlugin::removeFromDolphin()
{
QUrl kioUrl(QStringLiteral("kdeconnect://") + deviceId + QStringLiteral("/"));
QModelIndex index = d->m_placesModel.closestItem(kioUrl);
while (index.row() != -1) {
d->m_placesModel.removePlace(index);
index = d->m_placesModel.closestItem(kioUrl);
}
}
void SftpPlugin::mount()
{
qCDebug(KDECONNECT_PLUGIN_SFTP) << "Mount device:" << device()->name();
if (d->m_mounter) {
return;
}
d->m_mounter = new Mounter(this);
connect(d->m_mounter, &Mounter::mounted, this, &SftpPlugin::onMounted);
connect(d->m_mounter, &Mounter::unmounted, this, &SftpPlugin::onUnmounted);
connect(d->m_mounter, &Mounter::failed, this, &SftpPlugin::onFailed);
}
void SftpPlugin::unmount()
{
if (d->m_mounter)
{
d->m_mounter->deleteLater();
d->m_mounter = nullptr;
}
}
bool SftpPlugin::mountAndWait()
{
mount();
return d->m_mounter->wait();
}
bool SftpPlugin::isMounted() const
{
return d->m_mounter && d->m_mounter->isMounted();
}
QString SftpPlugin::getMountError()
{
if (!mountError.isEmpty()) {
return mountError;
}
return QString();
}
bool SftpPlugin::startBrowsing()
{
if (mountAndWait()) {
//return new KRun(QUrl::fromLocalFile(mountPoint()), 0);
return new KRun(QUrl(QStringLiteral("kdeconnect://") + deviceId), nullptr);
}
return false;
}
bool SftpPlugin::receivePacket(const NetworkPacket& np)
{
if (!(fields_c - np.body().keys().toSet()).isEmpty() && !np.has(QStringLiteral("errorMessage"))) {
// packet is invalid
return false;
}
Q_EMIT packetReceived(np);
remoteDirectories.clear();
if (np.has(QStringLiteral("multiPaths"))) {
QStringList paths = np.get<QStringList>(QStringLiteral("multiPaths"),QStringList());
QStringList names = np.get<QStringList>(QStringLiteral("pathNames"),QStringList());
int size = qMin<int>(names.size(), paths.size());
for (int i = 0; i < size; i++) {
remoteDirectories.insert(mountPoint() + paths.at(i), names.at(i));
}
} else {
remoteDirectories.insert(mountPoint(), i18n("All files"));
remoteDirectories.insert(mountPoint() + QStringLiteral("/DCIM/Camera"), i18n("Camera pictures"));
}
return true;
}
QString SftpPlugin::mountPoint()
{
QString runtimePath = QStandardPaths::writableLocation(QStandardPaths::RuntimeLocation);
if (runtimePath.isEmpty()) {
runtimePath = QStandardPaths::writableLocation(QStandardPaths::TempLocation);
}
return QDir(runtimePath).absoluteFilePath(deviceId);
}
void SftpPlugin::onMounted()
{
qCDebug(KDECONNECT_PLUGIN_SFTP) << device()->name() << QStringLiteral("Remote filesystem mounted at %1").arg(mountPoint());
Q_EMIT mounted();
}
void SftpPlugin::onUnmounted()
{
qCDebug(KDECONNECT_PLUGIN_SFTP) << device()->name() << "Remote filesystem unmounted";
unmount();
Q_EMIT unmounted();
}
void SftpPlugin::onFailed(const QString& message)
{
mountError = message;
KNotification::event(KNotification::Error, device()->name(), message);
unmount();
Q_EMIT unmounted();
}
QVariantMap SftpPlugin::getDirectories()
{
return remoteDirectories;
}
#include "sftpplugin.moc"