Differential D15277 Diff 42685 mtp/kiod_module/mtpstorage.h

Changeset View

Standalone View

mtp/kiod_module/mtpstorage.h

This file was added.

1		/*
2		This file is part of the MTP KIOD module, part of the KDE project.
3
4		Copyright (C) 2018 Andreas Krutzler <andreas.krutzler@gmx.net>
5
6		This program is free software: you can redistribute it and/or modify
7		it under the terms of the GNU General Public License as published by
8		the Free Software Foundation, either version 2 of the License, or
9		(at your option) any later version.
10
11		This program is distributed in the hope that it will be useful,
12		but WITHOUT ANY WARRANTY; without even the implied warranty of
13		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14		GNU General Public License for more details.
15
16		You should have received a copy of the GNU General Public License
17		along with this program. If not, see <http://www.gnu.org/licenses/>.
18		*/
19
20		#ifndef MTPSTORAGE_H
21		#define MTPSTORAGE_H
22
23		#include <QObject>
24
25		#include <libmtp.h>
26		#include <kmtpfile.h>
27
28		class MTPDevice;
29
30		/**
31		* @brief This D-Bus interface is used to access a single MTP storage.
32		*
33		* This includes storage management like file-, folder- and object-access.
34		*
35		* As a performance optimization to reduce hardware interaction,
36		* a time based cache for file ids, mapping their path to their ID is used.
37		*/
38		class MTPStorage : public QObject
39		{
40		Q_OBJECT
41		Q_PROPERTY(QString description READ description)
42		Q_PROPERTY(quint64 maxCapacity READ maxCapacity)
43		Q_PROPERTY(quint64 freeSpaceInBytes READ freeSpaceInBytes)
44
45		public:
46		explicit MTPStorage(const QString &dbusObjectPath, const LIBMTP_devicestorage_t mtpStorage, MTPDevice parent);
47
48		QString dbusObjectPath() const;
49
50		// D-Bus properties
51		QString description() const;
52		quint64 maxCapacity() const;
53		quint64 freeSpaceInBytes();
54
55		private:
56		Q_DISABLE_COPY(MTPStorage)
57
58		void setStorageProperties(const LIBMTP_devicestorage_t *storage);
59		void updateStorageInfo();
60
61		LIBMTP_mtpdevice_t *getDevice() const;
62
63		/**
64		* @brief Get the correct file/folder from the device.
65		*
66		* @param path
67		* @return
68		*/
69		KMTPFile getFileFromPath(const QString &path);
70
71		/**
72		* @brief Get all children files/folders of @a parentId and cache them.
73		*
74		* @param path parent path, used for caching
75		* @param parentId
76		* @return
77		*/
78		KMTPFileList getFilesAndFoldersCached(const QString &path, quint32 parentId);
79
80		/**
81		* @brief Returns the ID of the item at the given path, else 0.
82		*
83		* Automatically discards old items.
84		*
85		* @param path The Path to query the cache for
86		* @return The ID of the Item if it exists, else 0
87		*/
88		quint32 queryPath(const QString &path, int timeToLive = 60);
89
90		/**
91		* @brief Adds a Path to the Cache with the given id and ttl.
92		*
93		* @param path The path of the file/folder
94		* @param id The file ID on the storage
95		* @param timeToLive The time in seconds the entry should be valid
96		*/
97		void addPath(const QString &path, quint32 id, int timeToLive = 60);
98
99		/**
100		* @brief Remove the given path from the cache, i.e. if it got deleted
101		*
102		* @param path The path that should be removed
103		*/
104		void removePath(const QString &path);
105
106		const QString m_dbusObjectPath;
107
108		// LIBMTP_devicestorage_t properties
109		quint32 m_id; /*< Unique ID for this storage /
110		quint64 m_maxCapacity; /*< Maximum capability /
111		quint64 m_freeSpaceInBytes; /*< Free space in bytes /
112		QString m_description; /*< A brief description of this storage /
113
114		QHash<QString, QPair<QDateTime, uint32_t> > m_cache;
115
116		public slots:
117		// D-Bus methods
	dfaureUnsubmitted Done you know what I think of private class-static methods ;-) dfaure: you know what I think of private class-static methods ;-)
118
119		// file management
120		KMTPFileList getFilesAndFolders(const QString &path, int &result);
121		KMTPFile getFileMetadata(const QString &path);
122
123		int getFileToHandler(const QString &path);
124		int getFileToFileDescriptor(const QDBusUnixFileDescriptor &descriptor, const QString &sourcePath);
125
126		int sendFileFromFileDescriptor(const QDBusUnixFileDescriptor &descriptor, const QString &destinationPath);
127		int setFileName(const QString &path, const QString &newName);
128
129		// folder management
130		quint32 createFolder(const QString &path);
131
132		// object management
133		int deleteObject(const QString &path);
134
135		signals:
136		// D-Bus signals
137		void dataReady(const QByteArray &data);
138		void copyProgress(qulonglong transferredBytes, qulonglong totalBytes);
139		void copyFinished(int result);
140		};
141
142		#endif // MTPSTORAGE_H