332 lines
13 KiB
C++
332 lines
13 KiB
C++
/*
|
|
* Copyright (C) by Klaas Freitag <freitag@owncloud.com>
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
*
|
|
* This library 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
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*/
|
|
|
|
#ifndef SYNCJOURNALDB_H
|
|
#define SYNCJOURNALDB_H
|
|
|
|
#include <QObject>
|
|
#include <qmutex.h>
|
|
#include <QDateTime>
|
|
#include <QHash>
|
|
#include <functional>
|
|
|
|
#include "common/utility.h"
|
|
#include "common/ownsql.h"
|
|
#include "common/syncjournalfilerecord.h"
|
|
|
|
namespace OCC {
|
|
class SyncJournalFileRecord;
|
|
|
|
/**
|
|
* @brief Class that handles the sync database
|
|
*
|
|
* This class is thread safe. All public functions lock the mutex.
|
|
* @ingroup libsync
|
|
*/
|
|
class OCSYNC_EXPORT SyncJournalDb : public QObject
|
|
{
|
|
Q_OBJECT
|
|
public:
|
|
explicit SyncJournalDb(const QString &dbFilePath, QObject *parent = nullptr);
|
|
virtual ~SyncJournalDb();
|
|
|
|
/// Create a journal path for a specific configuration
|
|
static QString makeDbName(const QString &localPath,
|
|
const QUrl &remoteUrl,
|
|
const QString &remotePath,
|
|
const QString &user);
|
|
|
|
/// Migrate a csync_journal to the new path, if necessary. Returns false on error
|
|
static bool maybeMigrateDb(const QString &localPath, const QString &absoluteJournalPath);
|
|
|
|
// To verify that the record could be found check with SyncJournalFileRecord::isValid()
|
|
bool getFileRecord(const QString &filename, SyncJournalFileRecord *rec) { return getFileRecord(filename.toUtf8(), rec); }
|
|
bool getFileRecord(const QByteArray &filename, SyncJournalFileRecord *rec);
|
|
bool getFileRecordByE2eMangledName(const QString &mangledName, SyncJournalFileRecord *rec);
|
|
bool getFileRecordByInode(quint64 inode, SyncJournalFileRecord *rec);
|
|
bool getFileRecordsByFileId(const QByteArray &fileId, const std::function<void(const SyncJournalFileRecord &)> &rowCallback);
|
|
bool getFilesBelowPath(const QByteArray &path, const std::function<void(const SyncJournalFileRecord&)> &rowCallback);
|
|
bool setFileRecord(const SyncJournalFileRecord &record);
|
|
|
|
/// Like setFileRecord, but preserves checksums
|
|
bool setFileRecordMetadata(const SyncJournalFileRecord &record);
|
|
|
|
bool deleteFileRecord(const QString &filename, bool recursively = false);
|
|
bool updateFileRecordChecksum(const QString &filename,
|
|
const QByteArray &contentChecksum,
|
|
const QByteArray &contentChecksumType);
|
|
bool updateLocalMetadata(const QString &filename,
|
|
qint64 modtime, quint64 size, quint64 inode);
|
|
bool exists();
|
|
void walCheckpoint();
|
|
|
|
QString databaseFilePath() const;
|
|
|
|
static qint64 getPHash(const QByteArray &);
|
|
|
|
void setErrorBlacklistEntry(const SyncJournalErrorBlacklistRecord &item);
|
|
void wipeErrorBlacklistEntry(const QString &file);
|
|
void wipeErrorBlacklistCategory(SyncJournalErrorBlacklistRecord::Category category);
|
|
int wipeErrorBlacklist();
|
|
int errorBlackListEntryCount();
|
|
|
|
struct DownloadInfo
|
|
{
|
|
QString _tmpfile;
|
|
QByteArray _etag;
|
|
int _errorCount = 0;
|
|
bool _valid = false;
|
|
};
|
|
struct UploadInfo
|
|
{
|
|
int _chunk = 0;
|
|
quint64 _transferid = 0;
|
|
quint64 _size = 0; //currently unused
|
|
qint64 _modtime = 0;
|
|
int _errorCount = 0;
|
|
bool _valid = false;
|
|
QByteArray _contentChecksum;
|
|
/**
|
|
* Returns true if this entry refers to a chunked upload that can be continued.
|
|
* (As opposed to a small file transfer which is stored in the db so we can detect the case
|
|
* when the upload succeeded, but the connection was dropped before we got the answer)
|
|
*/
|
|
bool isChunked() const { return _transferid != 0; }
|
|
};
|
|
|
|
struct PollInfo
|
|
{
|
|
QString _file;
|
|
QString _url;
|
|
qint64 _modtime;
|
|
};
|
|
|
|
DownloadInfo getDownloadInfo(const QString &file);
|
|
void setDownloadInfo(const QString &file, const DownloadInfo &i);
|
|
QVector<DownloadInfo> getAndDeleteStaleDownloadInfos(const QSet<QString> &keep);
|
|
int downloadInfoCount();
|
|
|
|
UploadInfo getUploadInfo(const QString &file);
|
|
void setUploadInfo(const QString &file, const UploadInfo &i);
|
|
// Return the list of transfer ids that were removed.
|
|
QVector<uint> deleteStaleUploadInfos(const QSet<QString> &keep);
|
|
|
|
SyncJournalErrorBlacklistRecord errorBlacklistEntry(const QString &);
|
|
bool deleteStaleErrorBlacklistEntries(const QSet<QString> &keep);
|
|
|
|
void avoidRenamesOnNextSync(const QString &path) { avoidRenamesOnNextSync(path.toUtf8()); }
|
|
void avoidRenamesOnNextSync(const QByteArray &path);
|
|
void setPollInfo(const PollInfo &);
|
|
|
|
QVector<PollInfo> getPollInfos();
|
|
|
|
enum SelectiveSyncListType {
|
|
/** The black list is the list of folders that are unselected in the selective sync dialog.
|
|
* For the sync engine, those folders are considered as if they were not there, so the local
|
|
* folders will be deleted */
|
|
SelectiveSyncBlackList = 1,
|
|
/** When a shared folder has a size bigger than a configured size, it is by default not sync'ed
|
|
* Unless it is in the white list, in which case the folder is sync'ed and all its children.
|
|
* If a folder is both on the black and the white list, the black list wins */
|
|
SelectiveSyncWhiteList = 2,
|
|
/** List of big sync folders that have not been confirmed by the user yet and that the UI
|
|
* should notify about */
|
|
SelectiveSyncUndecidedList = 3
|
|
};
|
|
/* return the specified list from the database */
|
|
QStringList getSelectiveSyncList(SelectiveSyncListType type, bool *ok);
|
|
/* Write the selective sync list (remove all other entries of that list */
|
|
void setSelectiveSyncList(SelectiveSyncListType type, const QStringList &list);
|
|
|
|
/**
|
|
* Make sure that on the next sync fileName and its parents are discovered from the server.
|
|
*
|
|
* That means its metadata and, if it's a directory, its direct contents.
|
|
*
|
|
* Specifically, etag (md5 field) of fileName and all its parents are set to _invalid_.
|
|
* That causes a metadata difference and a resulting discovery from the remote for the
|
|
* affected folders.
|
|
*
|
|
* Since folders in the selective sync list will not be rediscovered (csync_ftw,
|
|
* _csync_detect_update skip them), the _invalid_ marker will stay. And any
|
|
* child items in the db will be ignored when reading a remote tree from the database.
|
|
*
|
|
* Any setFileRecord() call to affected directories before the next sync run will be
|
|
* adjusted to retain the invalid etag via _etagStorageFilter.
|
|
*/
|
|
void avoidReadFromDbOnNextSync(const QString &fileName) { avoidReadFromDbOnNextSync(fileName.toUtf8()); }
|
|
void avoidReadFromDbOnNextSync(const QByteArray &fileName);
|
|
|
|
/**
|
|
* Wipe _etagStorageFilter. Also done implicitly on close().
|
|
*/
|
|
void clearEtagStorageFilter();
|
|
|
|
/**
|
|
* Ensures full remote discovery happens on the next sync.
|
|
*
|
|
* Equivalent to calling avoidReadFromDbOnNextSync() for all files.
|
|
*/
|
|
void forceRemoteDiscoveryNextSync();
|
|
|
|
bool postSyncCleanup(const QSet<QString> &filepathsToKeep,
|
|
const QSet<QString> &prefixesToKeep);
|
|
|
|
/* Because sqlite transactions are really slow, we encapsulate everything in big transactions
|
|
* Commit will actually commit the transaction and create a new one.
|
|
*/
|
|
void commit(const QString &context, bool startTrans = true);
|
|
void commitIfNeededAndStartNewTransaction(const QString &context);
|
|
|
|
void close();
|
|
|
|
/**
|
|
* return true if everything is correct
|
|
*/
|
|
bool isConnected();
|
|
|
|
/**
|
|
* Returns the checksum type for an id.
|
|
*/
|
|
QByteArray getChecksumType(int checksumTypeId);
|
|
|
|
/**
|
|
* The data-fingerprint used to detect backup
|
|
*/
|
|
void setDataFingerprint(const QByteArray &dataFingerprint);
|
|
QByteArray dataFingerprint();
|
|
|
|
|
|
// Conflict record functions
|
|
|
|
/// Store a new or updated record in the database
|
|
void setConflictRecord(const ConflictRecord &record);
|
|
|
|
/// Retrieve a conflict record by path of the file with the conflict tag
|
|
ConflictRecord conflictRecord(const QByteArray &path);
|
|
|
|
/// Delete a conflict record by path of the file with the conflict tag
|
|
void deleteConflictRecord(const QByteArray &path);
|
|
|
|
/// Return all paths of files with a conflict tag in the name and records in the db
|
|
QByteArrayList conflictRecordPaths();
|
|
|
|
/** Find the base name for a conflict file name, using journal or name pattern
|
|
*
|
|
* The path must be sync-folder relative.
|
|
*
|
|
* Will return an empty string if it's not even a conflict file by pattern.
|
|
*/
|
|
QByteArray conflictFileBaseName(const QByteArray &conflictName);
|
|
|
|
/**
|
|
* Delete any file entry. This will force the next sync to re-sync everything as if it was new,
|
|
* restoring everyfile on every remote. If a file is there both on the client and server side,
|
|
* it will be a conflict that will be automatically resolved if the file is the same.
|
|
*/
|
|
void clearFileTable();
|
|
|
|
private:
|
|
int getFileRecordCount();
|
|
bool updateDatabaseStructure();
|
|
bool updateMetadataTableStructure();
|
|
bool updateErrorBlacklistTableStructure();
|
|
bool sqlFail(const QString &log, const SqlQuery &query);
|
|
void commitInternal(const QString &context, bool startTrans = true);
|
|
void startTransaction();
|
|
void commitTransaction();
|
|
QVector<QByteArray> tableColumns(const QByteArray &table);
|
|
bool checkConnect();
|
|
|
|
// Same as forceRemoteDiscoveryNextSync but without acquiring the lock
|
|
void forceRemoteDiscoveryNextSyncLocked();
|
|
|
|
// Returns the integer id of the checksum type
|
|
//
|
|
// Returns 0 on failure and for empty checksum types.
|
|
int mapChecksumType(const QByteArray &checksumType);
|
|
|
|
SqlDatabase _db;
|
|
QString _dbFile;
|
|
QMutex _mutex; // Public functions are protected with the mutex.
|
|
int _transaction;
|
|
bool _metadataTableIsEmpty;
|
|
|
|
SqlQuery _getFileRecordQuery;
|
|
SqlQuery _getFileRecordQueryByMangledName;
|
|
SqlQuery _getFileRecordQueryByInode;
|
|
SqlQuery _getFileRecordQueryByFileId;
|
|
SqlQuery _getFilesBelowPathQuery;
|
|
SqlQuery _getAllFilesQuery;
|
|
SqlQuery _setFileRecordQuery;
|
|
SqlQuery _setFileRecordChecksumQuery;
|
|
SqlQuery _setFileRecordLocalMetadataQuery;
|
|
SqlQuery _getDownloadInfoQuery;
|
|
SqlQuery _setDownloadInfoQuery;
|
|
SqlQuery _deleteDownloadInfoQuery;
|
|
SqlQuery _getUploadInfoQuery;
|
|
SqlQuery _setUploadInfoQuery;
|
|
SqlQuery _deleteUploadInfoQuery;
|
|
SqlQuery _deleteFileRecordPhash;
|
|
SqlQuery _deleteFileRecordRecursively;
|
|
SqlQuery _getErrorBlacklistQuery;
|
|
SqlQuery _setErrorBlacklistQuery;
|
|
SqlQuery _getSelectiveSyncListQuery;
|
|
SqlQuery _getChecksumTypeIdQuery;
|
|
SqlQuery _getChecksumTypeQuery;
|
|
SqlQuery _insertChecksumTypeQuery;
|
|
SqlQuery _getDataFingerprintQuery;
|
|
SqlQuery _setDataFingerprintQuery1;
|
|
SqlQuery _setDataFingerprintQuery2;
|
|
SqlQuery _getConflictRecordQuery;
|
|
SqlQuery _setConflictRecordQuery;
|
|
SqlQuery _deleteConflictRecordQuery;
|
|
|
|
/* Storing etags to these folders, or their parent folders, is filtered out.
|
|
*
|
|
* When avoidReadFromDbOnNextSync() is called some etags to _invalid_ in the
|
|
* database. If this is done during a sync run, a later propagation job might
|
|
* undo that by writing the correct etag to the database instead. This filter
|
|
* will prevent this write and instead guarantee the _invalid_ etag stays in
|
|
* place.
|
|
*
|
|
* The list is cleared on close() (end of sync run) and explicitly with
|
|
* clearEtagStorageFilter() (start of sync run).
|
|
*
|
|
* The contained paths have a trailing /.
|
|
*/
|
|
QList<QByteArray> _etagStorageFilter;
|
|
|
|
/** The journal mode to use for the db.
|
|
*
|
|
* Typically WAL initially, but may be set to other modes via environment
|
|
* variable, for specific filesystems, or when WAL fails in a particular way.
|
|
*/
|
|
QByteArray _journalMode;
|
|
};
|
|
|
|
bool OCSYNC_EXPORT
|
|
operator==(const SyncJournalDb::DownloadInfo &lhs,
|
|
const SyncJournalDb::DownloadInfo &rhs);
|
|
bool OCSYNC_EXPORT
|
|
operator==(const SyncJournalDb::UploadInfo &lhs,
|
|
const SyncJournalDb::UploadInfo &rhs);
|
|
|
|
} // namespace OCC
|
|
#endif // SYNCJOURNALDB_H
|