/* * Copyright (C) by Duncan Mac-Vicar P. * Copyright (C) by Klaas Freitag * * 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 "mirall/csyncthread.h" #include "mirall/mirallconfigfile.h" #include "mirall/theme.h" #include "mirall/logger.h" #include "mirall/owncloudinfo.h" #include "owncloudpropagator.h" #include "progressdatabase.h" #include "syncjournaldb.h" #include "syncjournalfilerecord.h" #include "creds/abstractcredentials.h" #ifdef Q_OS_WIN #include #else #include #endif #include #include #include #include #include #include #include #include #include #include #include #include namespace Mirall { void csyncLogCatcher(int /*verbosity*/, const char */*function*/, const char *buffer, void */*userdata*/) { Logger::instance()->csyncLog( QString::fromUtf8(buffer) ); } /* static variables to hold the credentials */ QMutex CSyncThread::_mutex; QMutex CSyncThread::_syncMutex; CSyncThread::CSyncThread(CSYNC *csync, const QString &localPath, const QString &remotePath, SyncJournalDb *journal) { _mutex.lock(); _localPath = localPath; _remotePath = remotePath; _csync_ctx = csync; _journal = journal; _mutex.unlock(); qRegisterMetaType("SyncFileItem"); qRegisterMetaType("CSYNC_STATUS"); } CSyncThread::~CSyncThread() { } //Convert an error code from csync to a user readable string. // Keep that function thread safe as it can be called from the sync thread or the main thread QString CSyncThread::csyncErrorToString(CSYNC_STATUS err) { QString errStr; switch( err ) { case CSYNC_STATUS_OK: errStr = tr("Success."); break; case CSYNC_STATUS_NO_LOCK: errStr = tr("CSync failed to create a lock file."); break; case CSYNC_STATUS_STATEDB_LOAD_ERROR: errStr = tr("CSync failed to load the state db."); break; case CSYNC_STATUS_STATEDB_WRITE_ERROR: errStr = tr("CSync failed to write the state db."); break; case CSYNC_STATUS_NO_MODULE: errStr = tr("

The %1 plugin for csync could not be loaded.
Please verify the installation!

").arg(Theme::instance()->appNameGUI()); break; case CSYNC_STATUS_TIMESKEW: errStr = tr("The system time on this client is different than the system time on the server. " "Please use a time synchronization service (NTP) on the server and client machines " "so that the times remain the same."); break; case CSYNC_STATUS_FILESYSTEM_UNKNOWN: errStr = tr("CSync could not detect the filesystem type."); break; case CSYNC_STATUS_TREE_ERROR: errStr = tr("CSync got an error while processing internal trees."); break; case CSYNC_STATUS_MEMORY_ERROR: errStr = tr("CSync failed to reserve memory."); break; case CSYNC_STATUS_PARAM_ERROR: errStr = tr("CSync fatal parameter error."); break; case CSYNC_STATUS_UPDATE_ERROR: errStr = tr("CSync processing step update failed."); break; case CSYNC_STATUS_RECONCILE_ERROR: errStr = tr("CSync processing step reconcile failed."); break; case CSYNC_STATUS_PROPAGATE_ERROR: errStr = tr("CSync processing step propagate failed."); break; case CSYNC_STATUS_REMOTE_ACCESS_ERROR: errStr = tr("

The target directory does not exist.

Please check the sync setup.

"); break; case CSYNC_STATUS_REMOTE_CREATE_ERROR: case CSYNC_STATUS_REMOTE_STAT_ERROR: errStr = tr("A remote file can not be written. Please check the remote access."); break; case CSYNC_STATUS_LOCAL_CREATE_ERROR: case CSYNC_STATUS_LOCAL_STAT_ERROR: errStr = tr("The local filesystem can not be written. Please check permissions."); break; case CSYNC_STATUS_PROXY_ERROR: errStr = tr("CSync failed to connect through a proxy."); break; case CSYNC_STATUS_PROXY_AUTH_ERROR: errStr = tr("CSync could not authenticate at the proxy."); break; case CSYNC_STATUS_LOOKUP_ERROR: errStr = tr("CSync failed to lookup proxy or server."); break; case CSYNC_STATUS_SERVER_AUTH_ERROR: errStr = tr("CSync failed to authenticate at the %1 server.").arg(Theme::instance()->appNameGUI()); break; case CSYNC_STATUS_CONNECT_ERROR: errStr = tr("CSync failed to connect to the network."); break; case CSYNC_STATUS_TIMEOUT: errStr = tr("A network connection timeout happend."); break; case CSYNC_STATUS_HTTP_ERROR: errStr = tr("A HTTP transmission error happened."); break; case CSYNC_STATUS_PERMISSION_DENIED: errStr = tr("CSync failed due to not handled permission deniend."); break; case CSYNC_STATUS_NOT_FOUND: errStr = tr("CSync failed to find a specific file."); break; case CSYNC_STATUS_FILE_EXISTS: errStr = tr("CSync tried to create a directory that already exists."); break; case CSYNC_STATUS_OUT_OF_SPACE: errStr = tr("CSync: No space on %1 server available.").arg(Theme::instance()->appNameGUI()); break; case CSYNC_STATUS_QUOTA_EXCEEDED: errStr = tr("CSync: No space on %1 server available.").arg(Theme::instance()->appNameGUI()); break; case CSYNC_STATUS_UNSUCCESSFUL: errStr = tr("CSync unspecified error."); break; case CSYNC_STATUS_ABORTED: errStr = tr("Aborted by the user"); break; default: errStr = tr("An internal error number %1 happend.").arg( (int) err ); } return errStr; } int CSyncThread::treewalkLocal( TREE_WALK_FILE* file, void *data ) { return static_cast(data)->treewalkFile( file, false ); } int CSyncThread::treewalkRemote( TREE_WALK_FILE* file, void *data ) { return static_cast(data)->treewalkFile( file, true ); } int CSyncThread::treewalkFile( TREE_WALK_FILE *file, bool remote ) { if( ! file ) return -1; SyncFileItem item; item._file = QString::fromUtf8( file->path ); item._originalFile = file->path; item._instruction = file->instruction; item._dir = SyncFileItem::None; if(file->error_string) { item._errorString = QString::fromUtf8(file->error_string); } item._isDirectory = file->type == CSYNC_FTW_TYPE_DIR; item._modtime = file->modtime; item._etag = file->md5; item._size = file->size; SyncFileItem::Direction dir; int re = 0; if (file->instruction != CSYNC_INSTRUCTION_IGNORE && file->instruction != CSYNC_INSTRUCTION_REMOVE) { _hasFiles = true; } switch(file->instruction) { case CSYNC_INSTRUCTION_NONE: case CSYNC_INSTRUCTION_IGNORE: break; case CSYNC_INSTRUCTION_NEW: case CSYNC_INSTRUCTION_SYNC: case CSYNC_INSTRUCTION_CONFLICT: _progressInfo.overall_file_count++; _progressInfo.overall_transmission_size += file->size; //fall trough default: _needsUpdate = true; } switch(file->instruction) { case CSYNC_INSTRUCTION_NONE: if (item._isDirectory && remote) { // Because we want still to update etags of directories dir = SyncFileItem::None; } else { // No need to do anything. return re; } break; case CSYNC_INSTRUCTION_RENAME: dir = !remote ? SyncFileItem::Down : SyncFileItem::Up; item._renameTarget = QString::fromUtf8( file->rename_path ); if (item._isDirectory) _renamedFolders.insert(item._file, item._renameTarget); break; case CSYNC_INSTRUCTION_REMOVE: dir = !remote ? SyncFileItem::Down : SyncFileItem::Up; break; case CSYNC_INSTRUCTION_CONFLICT: case CSYNC_INSTRUCTION_IGNORE: case CSYNC_INSTRUCTION_ERROR: dir = SyncFileItem::None; break; case CSYNC_INSTRUCTION_EVAL: case CSYNC_INSTRUCTION_NEW: case CSYNC_INSTRUCTION_SYNC: case CSYNC_INSTRUCTION_STAT_ERROR: case CSYNC_INSTRUCTION_DELETED: case CSYNC_INSTRUCTION_UPDATED: default: dir = remote ? SyncFileItem::Down : SyncFileItem::Up; break; } switch( file->type ) { case CSYNC_FTW_TYPE_DIR: item._type = SyncFileItem::Directory; break; case CSYNC_FTW_TYPE_FILE: item._type = SyncFileItem::File; break; case CSYNC_FTW_TYPE_SLINK: item._type = SyncFileItem::SoftLink; break; default: item._type = SyncFileItem::UnknownType; } item._dir = dir; _syncedItems.append(item); return re; } void CSyncThread::handleSyncError(CSYNC *ctx, const char *state) { CSYNC_STATUS err = CSYNC_STATUS(csync_get_status( ctx )); const char *errMsg = csync_get_status_string( ctx ); QString errStr = csyncErrorToString(err); if( errMsg ) { errStr += QLatin1String("
"); errStr += QString::fromUtf8(errMsg); } qDebug() << " #### ERROR during "<< state << ": " << errStr; if( CSYNC_STATUS_IS_EQUAL( err, CSYNC_STATUS_SERVICE_UNAVAILABLE ) || CSYNC_STATUS_IS_EQUAL( err, CSYNC_STATUS_CONNECT_ERROR )) { emit csyncUnavailable(); } else { emit csyncError(errStr); } csync_commit(_csync_ctx); emit finished(); _syncMutex.unlock(); thread()->quit(); } void CSyncThread::startSync() { if (!_syncMutex.tryLock()) { qDebug() << Q_FUNC_INFO << "WARNING: Another sync seems to be running. Not starting a new one."; return; } if( ! _csync_ctx ) { qDebug() << "XXXXXXXXXXXXXXXX FAIL: do not have csync_ctx!"; } qDebug() << Q_FUNC_INFO << "Sync started"; qDebug() << "starting to sync " << qApp->thread() << QThread::currentThread(); _syncedItems.clear(); _mutex.lock(); _needsUpdate = false; if (!_abortRequested.fetchAndAddRelease(0)) { csync_resume(_csync_ctx); } _mutex.unlock(); // maybe move this somewhere else where it can influence a running sync? MirallConfigFile cfg; int fileRecordCount = 0; if (!_journal->exists()) { qDebug() << "=====sync looks new (no DB exists), activating recursive PROPFIND if csync supports it"; bool no_recursive_propfind = false; csync_set_module_property(_csync_ctx, "no_recursive_propfind", &no_recursive_propfind); } else if ((fileRecordCount = _journal->getFileRecordCount()) < 50) { qDebug() << "=====sync DB has only" << fileRecordCount << "items, enable recursive PROPFIND if csync supports it"; bool no_recursive_propfind = false; csync_set_module_property(_csync_ctx, "no_recursive_propfind", &no_recursive_propfind); } else { qDebug() << "=====sync with existing DB"; } csync_set_module_property(_csync_ctx, "csync_context", _csync_ctx); csync_set_userdata(_csync_ctx, this); // TODO: This should be a part of this method, but we don't have // any way to get "session_key" module property from csync. Had we // have it, then we could keep this code and remove it from // AbstractCredentials implementations. cfg.getCredentials()->syncContextPreStart(_csync_ctx); // if (_lastAuthCookies.length() > 0) { // // Stuff cookies inside csync, then we can avoid the intermediate HTTP 401 reply // // when https://github.com/owncloud/core/pull/4042 is merged. // QString cookiesAsString; // foreach(QNetworkCookie c, _lastAuthCookies) { // cookiesAsString += c.name(); // cookiesAsString += '='; // cookiesAsString += c.value(); // cookiesAsString += "; "; // } // csync_set_module_property(_csync_ctx, "session_key", cookiesAsString.to // } // csync_set_auth_callback( _csync_ctx, getauth ); csync_set_log_callback( csyncLogCatcher ); csync_set_log_level( 11 ); _syncTime.start(); QElapsedTimer updateTime; updateTime.start(); qDebug() << "#### Update start #################################################### >>"; if( csync_update(_csync_ctx) < 0 ) { handleSyncError(_csync_ctx, "csync_update"); return; } qDebug() << "<<#### Update end #################################################### " << updateTime.elapsed(); if( csync_reconcile(_csync_ctx) < 0 ) { handleSyncError(_csync_ctx, "csync_reconcile"); return; } _progressInfo = Progress::Info(); _hasFiles = false; bool walkOk = true; if( csync_walk_local_tree(_csync_ctx, &treewalkLocal, 0) < 0 ) { qDebug() << "Error in local treewalk."; walkOk = false; } if( walkOk && csync_walk_remote_tree(_csync_ctx, &treewalkRemote, 0) < 0 ) { qDebug() << "Error in remote treewalk."; } // Adjust the paths for the renames. for (SyncFileItemVector::iterator it = _syncedItems.begin(); it != _syncedItems.end(); ++it) { it->_file = adjustRenamedPath(it->_file); } qSort(_syncedItems); if (!_hasFiles && !_syncedItems.isEmpty()) { qDebug() << Q_FUNC_INFO << "All the files are going to be removed, asking the user"; bool cancel = false; emit aboutToRemoveAllFiles(_syncedItems.first()._dir, &cancel); if (cancel) { qDebug() << Q_FUNC_INFO << "Abort sync"; return; } } if (_needsUpdate) emit(started()); ne_session_s *session = 0; // that call to set property actually is a get which will return the session csync_set_module_property(_csync_ctx, "get_dav_session", &session); Q_ASSERT(session); _progressDataBase.load(_localPath); _propagator.reset(new OwncloudPropagator (session, _localPath, _remotePath, &_progressDataBase, &_abortRequested)); connect(_propagator.data(), SIGNAL(completed(SyncFileItem)), this, SLOT(transferCompleted(SyncFileItem)), Qt::QueuedConnection); connect(_propagator.data(), SIGNAL(progress(Progress::Kind,QString,quint64,quint64)), this, SLOT(slotProgress(Progress::Kind,QString,quint64,quint64))); _iterator = 0; int downloadLimit = 0; if (cfg.useDownloadLimit()) { downloadLimit = cfg.downloadLimit() * 1000; } _propagator->_downloadLimit = downloadLimit; int uploadLimit = -75; // 75% int useUpLimit = cfg.useUploadLimit(); if ( useUpLimit >= 1) { uploadLimit = cfg.uploadLimit() * 1000; } else if (useUpLimit == 0) { uploadLimit = 0; } _propagator->_uploadLimit = uploadLimit; slotProgress(Progress::StartSync, QString(), 0, 0); startNextTransfer(); } void CSyncThread::transferCompleted(const SyncFileItem &item) { qDebug() << Q_FUNC_INFO << item._file << item._status << item._errorString; /* Update the _syncedItems vector */ // Search for the item in the starting from _iterator because it should be a bit before it. // This works because SyncFileItem::operator== only compare the file name; int idx = _syncedItems.lastIndexOf(item, _iterator); if (idx >= 0) { _syncedItems[idx]._instruction = item._instruction; _syncedItems[idx]._errorString = item._errorString; _syncedItems[idx]._status = item._status; } /* Remember deleted directory */ if (item._isDirectory && item._instruction == CSYNC_INSTRUCTION_DELETED) { _lastDeleted = item._file; } else { _lastDeleted.clear(); } /* Update the database */ if (item._instruction == CSYNC_INSTRUCTION_DELETED) { _journal->deleteFileRecord(item._file); if (!item._renameTarget.isEmpty()) { SyncJournalFileRecord record(item, _localPath + item._renameTarget); record._path = item._renameTarget; _journal->setFileRecord(record); } } else if(item._instruction == CSYNC_INSTRUCTION_ERROR) { // Don't update parents directories _directoriesToUpdate.clear(); } else if (item._isDirectory) { // directory must not be saved to the db before we finished processing them. SyncJournalFileRecord record(item, _localPath + item._file); _directoriesToUpdate.push(record); } else if(item._instruction == CSYNC_INSTRUCTION_UPDATED) { SyncJournalFileRecord record(item, _localPath + item._file); _journal->setFileRecord(record); slotProgress((item._dir != SyncFileItem::Up) ? Progress::EndDownload : Progress::EndUpload, item._file, item._size, item._size); _progressInfo.current_file_no++; _progressInfo.overall_current_bytes += item._size; } /* Start the transfer of the next file or abort if there is an error */ if (item._status != SyncFileItem::FatalError) { startNextTransfer(); } else { emit treeWalkResult(_syncedItems); emit csyncError(item._errorString); emit finished(); csync_commit(_csync_ctx); _syncMutex.unlock(); thread()->quit(); } } void CSyncThread::startNextTransfer() { while (_iterator < _syncedItems.size()) { const SyncFileItem &item = _syncedItems.at(_iterator); ++_iterator; while (!_directoriesToUpdate.isEmpty() && !item._file.startsWith(_directoriesToUpdate.last()._path)) { _journal->setFileRecord(_directoriesToUpdate.pop()); } if (!_lastDeleted.isEmpty() && item._file.startsWith(_lastDeleted) && item._instruction == CSYNC_INSTRUCTION_REMOVE) { // If the item's name starts with the name of the previously deleted directory, we // can assume this file was already destroyed by the previous recursive call. _journal->deleteFileRecord(item._file); continue; } if (item._instruction == CSYNC_INSTRUCTION_SYNC || item._instruction == CSYNC_INSTRUCTION_NEW || item._instruction == CSYNC_INSTRUCTION_CONFLICT) { slotProgress((item._dir != SyncFileItem::Up) ? Progress::StartDownload : Progress::StartUpload, item._file, 0, item._size); } _propagator->propagate(item); return; //propagate is async. } while (!_directoriesToUpdate.isEmpty()) { _journal->setFileRecord(_directoriesToUpdate.pop()); } // Everything is finished. _progressDataBase.save(_localPath); // emit the treewalk results. emit treeWalkResult(_syncedItems); csync_commit(_csync_ctx); qDebug() << "CSync run took " << _syncTime.elapsed() << " Milliseconds"; slotProgress(Progress::EndSync,QString(), 0 , 0); emit finished(); _propagator.reset(0); _syncMutex.unlock(); thread()->quit(); } Progress::Kind CSyncThread::csyncToProgressKind( enum csync_notify_type_e kind ) { Progress::Kind pKind = Progress::Invalid; switch(kind) { case CSYNC_NOTIFY_INVALID: pKind = Progress::Invalid; break; case CSYNC_NOTIFY_START_SYNC_SEQUENCE: pKind = Progress::StartSync; break; case CSYNC_NOTIFY_START_DOWNLOAD: pKind = Progress::StartDownload; break; case CSYNC_NOTIFY_START_UPLOAD: pKind = Progress::StartUpload; break; case CSYNC_NOTIFY_PROGRESS: pKind = Progress::Context; break; case CSYNC_NOTIFY_FINISHED_DOWNLOAD: pKind = Progress::EndDownload; break; case CSYNC_NOTIFY_FINISHED_UPLOAD: pKind = Progress::EndUpload; break; case CSYNC_NOTIFY_FINISHED_SYNC_SEQUENCE: pKind = Progress::EndSync; break; case CSYNC_NOTIFY_START_DELETE: pKind = Progress::StartDelete; break; case CSYNC_NOTIFY_END_DELETE: pKind = Progress::EndDelete; break; case CSYNC_NOTIFY_ERROR: pKind = Progress::Error; break; default: pKind = Progress::Invalid; break; } return pKind; } void CSyncThread::slotProgress(Progress::Kind kind, const QString &file, quint64 curr, quint64 total) { Progress::Info pInfo = _progressInfo; pInfo.kind = kind; pInfo.current_file = file; pInfo.file_size = total; pInfo.current_file_bytes = curr; pInfo.overall_current_bytes += curr; pInfo.timestamp = QDateTime::currentDateTime(); // Connect to something in folder! transmissionProgress( pInfo ); } /* Given a path on the remote, give the path as it is when the rename is done */ QString CSyncThread::adjustRenamedPath(const QString& original) { int slashPos = original.size(); while ((slashPos = original.lastIndexOf('/' , slashPos - 1)) > 0) { QHash< QString, QString >::const_iterator it = _renamedFolders.constFind(original.left(slashPos)); if (it != _renamedFolders.constEnd()) { return *it + original.mid(slashPos); } } return original; } void CSyncThread::abort() { QMutexLocker locker(&_mutex); csync_request_abort(_csync_ctx); _abortRequested = true; } } // ns Mirall