flightsimulatorplatfrom/pilotclient
1
0
Fork 0
mirror of https://github.com/swift-project/pilotclient.git synced 2026-03-22 23:05:36 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
5e8ff1a4ca99213bacf109180e6ee2ab20e429e7
pilotclient/src/core/db/databasereader.cpp
Lars Toenning 5e8ff1a4ca refactor: Remove old comments
2024-11-30 16:27:36 +01:00

836 lines
37 KiB
C++
Raw Blame History

// SPDX-FileCopyrightText: Copyright (C) 2015 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
#include "core/db/databasereader.h"
#include <QByteArray>
#include <QFileInfo>
#include <QJsonDocument>
#include <QJsonObject>
#include <QJsonValueRef>
#include <QMetaObject>
#include <QNetworkReply>
#include <QPointer>
#include <QReadLocker>
#include <QStringBuilder>
#include <QUrl>
#include <QWriteLocker>
#include "core/application.h"
#include "core/db/databaseutils.h"
#include "core/db/infodatareader.h"
#include "core/webdataservices.h"
#include "misc/db/datastoreutility.h"
#include "misc/directoryutils.h"
#include "misc/logcategories.h"
#include "misc/logmessage.h"
#include "misc/network/entityflags.h"
#include "misc/network/networkutils.h"
#include "misc/swiftdirectories.h"
#include "misc/verify.h"
using namespace swift::misc;
using namespace swift::misc::db;
using namespace swift::misc::network;
using namespace swift::core;
using namespace swift::core::data;
using namespace swift::core::db;
namespace swift::core::db
{
CDatabaseReader::CDatabaseReader(QObject *owner, const CDatabaseReaderConfigList &config, const QString &name)
: CThreadedReader(owner, name), m_config(config)
{}
void CDatabaseReader::readInBackgroundThread(CEntityFlags::Entity entities, const QDateTime &newerThan)
{
if (!this->doWorkCheck()) { return; }
// we accept cached data
Q_ASSERT_X(!entities.testFlag(CEntityFlags::DbInfoObjectEntity), Q_FUNC_INFO, "Read info objects directly");
const bool hasDbInfoObjects =
this->hasDbInfoObjects(); // no info objects is not necessarily an error, but indicates a) either data not
// available (DB down) or b) only caches are used
// const bool hasSharedInfoObjects = this->hasSharedInfoObjects();
CEntityFlags::Entity allEntities = entities;
CEntityFlags::Entity cachedEntities = CEntityFlags::NoEntity;
CEntityFlags::Entity dbEntities = CEntityFlags::NoEntity;
CEntityFlags::Entity sharedEntities = CEntityFlags::NoEntity;
CEntityFlags::Entity currentEntity =
CEntityFlags::iterateDbEntities(allEntities); // CEntityFlags::InfoObjectEntity will be ignored
while (currentEntity)
{
const CDatabaseReaderConfig config(this->getConfigForEntity(currentEntity));
const QString currentEntityName = CEntityFlags::entitiesToString(currentEntity);
// retrieval mode
const CDbFlags::DataRetrievalMode rm = config.getRetrievalMode(); // DB reading, cache, shared
Q_ASSERT_X(!rm.testFlag(CDbFlags::Unspecified), Q_FUNC_INFO, "Missing retrieval mode");
const QString rmString = CDbFlags::flagToString(rm);
const CDbFlags::DataRetrievalModeFlag rmDbOrSharedFlag =
CDbFlags::modeToModeFlag(rm & CDbFlags::DbReadingOrShared);
const QString rmDbOrSharedFlagString = CDbFlags::flagToString(rmDbOrSharedFlag);
const bool rmDbReadingOrShared =
(rmDbOrSharedFlag == CDbFlags::DbReading || rmDbOrSharedFlag == CDbFlags::Shared);
const int currentEntityCount = this->getCacheCount(currentEntity);
if (rm.testFlag(CDbFlags::Ignore) || rm.testFlag(CDbFlags::Canceled))
{
// do not load
}
else if (rm.testFlag(CDbFlags::Cached))
{
//
// !!! info object comparisons only for: cache + shared or cache + DB data
//
if (hasDbInfoObjects && rmDbReadingOrShared)
{
// check mode here for consistency
Q_ASSERT_X(!getBaseUrl(rmDbOrSharedFlag).isEmpty(), Q_FUNC_INFO, "Wrong retrieval mode");
CUrl oldUrlInfo;
CUrl newUrlInfo;
const bool changedUrl = this->hasChangedUrl(currentEntity, oldUrlInfo, newUrlInfo);
const QDateTime cacheTs(this->getCacheTimestamp(currentEntity));
const QDateTime latestEntityTs(this->getLatestEntityTimestampFromDbInfoObjects(currentEntity));
const qint64 cacheTimestamp = cacheTs.isValid() ? cacheTs.toMSecsSinceEpoch() : -1;
const qint64 latestEntityTimestamp =
latestEntityTs.isValid() ? latestEntityTs.toMSecsSinceEpoch() : -1;
Q_ASSERT_X(latestEntityTimestamp >= 0, Q_FUNC_INFO, "Missing timestamp");
if (!changedUrl && cacheTimestamp >= latestEntityTimestamp && cacheTimestamp >= 0 &&
latestEntityTimestamp >= 0)
{
this->admitCaches(currentEntity);
cachedEntities |= currentEntity; // read from cache
CLogMessage(this).info(u"Using cache for '%1' (%2, %3)")
<< currentEntityName << cacheTs.toString() << cacheTimestamp;
}
else
{
Q_ASSERT_X(rmDbReadingOrShared, Q_FUNC_INFO, "Wrong retrieval mode");
if (rmDbOrSharedFlag == CDbFlags::DbReading) { dbEntities |= currentEntity; }
else if (rmDbOrSharedFlag == CDbFlags::Shared) { sharedEntities |= currentEntity; }
if (changedUrl)
{
CLogMessage(this).info(
u"Data location for '%1' changed ('%2'->'%3'), will override cache for reading '%4'")
<< currentEntityName << oldUrlInfo.toQString() << newUrlInfo.toQString()
<< rmDbOrSharedFlagString;
}
else
{
CLogMessage(this).info(u"Cache for '%1' outdated, latest entity (%2, %3), reading '%4'")
<< currentEntityName << latestEntityTs.toString() << latestEntityTimestamp
<< rmDbOrSharedFlagString;
}
}
}
else
{
if (!rmDbReadingOrShared)
{
CLogMessage(this).info(u"No DB or shared reading for '%1', read mode is: '%2'")
<< currentEntityName << rmString;
}
if (!hasDbInfoObjects)
{
CLogMessage(this).info(u"No DB info objects for '%1', read mode is: '%2'")
<< currentEntityName << rmString;
}
if (currentEntityCount > 0)
{
CLogMessage(this).info(u"Cache for '%1' already read, %2 entries")
<< currentEntityName << currentEntityCount;
}
else
{
// no info objects, server down or no shared/db read mode
this->admitCaches(currentEntity);
if (!rmDbReadingOrShared)
{
// intentionally we do not want to read from DB/shared
CLogMessage(this).info(u"Triggered reading cache for '%1', read mode: %2")
<< currentEntityName << rmString;
}
else
{
// we want to read from DB/shared, but have no info object
CLogMessage(this).info(u"No info object for '%1', triggered reading cache, read mode: %2")
<< currentEntityName << rmString;
}
}
cachedEntities |= currentEntity; // read from cache
}
}
else
{
// cache ignored
Q_ASSERT_X(rmDbReadingOrShared, Q_FUNC_INFO, "Wrong retrieval mode");
if (rmDbOrSharedFlag == CDbFlags::DbReading) { dbEntities |= currentEntity; }
else if (rmDbOrSharedFlag == CDbFlags::Shared) { sharedEntities |= currentEntity; }
}
currentEntity = CEntityFlags::iterateDbEntities(allEntities);
}
// signals for the cached entities
if (cachedEntities != CEntityFlags::NoEntity)
{
this->emitReadSignalPerSingleCachedEntity(cachedEntities, true);
}
// Real read from DB
if (dbEntities != CEntityFlags::NoEntity)
{
CLogMessage(this).info(u"Start reading DB entities: %1") << CEntityFlags::entitiesToString(dbEntities);
this->startReadFromBackendInBackgroundThread(dbEntities, CDbFlags::DbReading, newerThan);
}
// Real read from shared
if (sharedEntities != CEntityFlags::NoEntity)
{
CLogMessage(this).info(u"Start reading shared entities: %1")
<< CEntityFlags::entitiesToString(sharedEntities);
this->startReadFromBackendInBackgroundThread(dbEntities, CDbFlags::Shared, newerThan);
}
}
CEntityFlags::Entity CDatabaseReader::triggerLoadingDirectlyFromDb(CEntityFlags::Entity entities,
const QDateTime &newerThan)
{
this->startReadFromBackendInBackgroundThread(entities, CDbFlags::DbReading, newerThan);
return entities;
}
CEntityFlags::Entity CDatabaseReader::triggerLoadingDirectlyFromSharedFiles(CEntityFlags::Entity entities,
bool checkCacheTsUpfront)
{
if (entities == CEntityFlags::NoEntity) { return CEntityFlags::NoEntity; }
if (checkCacheTsUpfront)
{
CEntityFlags::Entity newerHeaderEntities = this->getEntitesWithNewerSharedInfoObject(entities);
if (newerHeaderEntities != entities)
{
const CEntityFlags::Entity validInCacheEntities = (entities ^ newerHeaderEntities) & entities;
CLogMessage(this).info(u"Reduced '%1' to '%2' before triggering load of shared files (still in cache)")
<< CEntityFlags::entitiesToString(entities) << CEntityFlags::entitiesToString(newerHeaderEntities);
// In case we have difference entities we treat them as they were loaded, they result from still being
// in the cache Using timer to first finish this function, then the resulting signal
if (validInCacheEntities != CEntityFlags::NoEntity)
{
QPointer<CDatabaseReader> myself(this);
QTimer::singleShot(0, this, [=] {
if (!myself) { return; }
if (!sApp || sApp->isShuttingDown()) { return; }
emit this->dataRead(validInCacheEntities, CEntityFlags::ReadFinished, 0, {});
});
}
if (newerHeaderEntities == CEntityFlags::NoEntity) { return CEntityFlags::NoEntity; }
entities = newerHeaderEntities;
}
}
this->startReadFromBackendInBackgroundThread(entities, CDbFlags::Shared);
return entities;
}
void CDatabaseReader::startReadFromBackendInBackgroundThread(CEntityFlags::Entity entities,
CDbFlags::DataRetrievalModeFlag mode,
const QDateTime &newerThan)
{
Q_ASSERT_X(mode == CDbFlags::DbReading || mode == CDbFlags::Shared, Q_FUNC_INFO, "Wrong mode");
// ps_read is implemented in the derived classes
if (entities == CEntityFlags::NoEntity) { return; }
QPointer<CDatabaseReader> myself(this);
QTimer::singleShot(0, this, [=] {
if (!sApp || sApp->isShuttingDown() || !myself) { return; }
this->read(entities, mode, newerThan);
});
}
CDatabaseReader::JsonDatastoreResponse
CDatabaseReader::transformReplyIntoDatastoreResponse(QNetworkReply *nwReply) const
{
Q_ASSERT_X(nwReply, Q_FUNC_INFO, "missing reply");
JsonDatastoreResponse datastoreResponse;
const bool ok = this->setHeaderInfoPart(datastoreResponse, nwReply);
if (ok)
{
const QString dataFileData = nwReply->readAll();
nwReply->close(); // close asap
datastoreResponse.setStringSize(dataFileData.size());
if (dataFileData.isEmpty())
{
datastoreResponse.setMessage(
CStatusMessage(this, CStatusMessage::SeverityError, u"Empty response, no data"));
}
else { CDatabaseReader::stringToDatastoreResponse(dataFileData, datastoreResponse); }
}
return datastoreResponse;
}
CDatabaseReader::HeaderResponse CDatabaseReader::transformReplyIntoHeaderResponse(QNetworkReply *nwReply) const
{
HeaderResponse headerResponse;
const bool success = this->setHeaderInfoPart(headerResponse, nwReply);
Q_UNUSED(success);
return headerResponse;
}
bool CDatabaseReader::setHeaderInfoPart(CDatabaseReader::HeaderResponse &headerResponse,
QNetworkReply *nwReply) const
{
Q_ASSERT_X(nwReply, Q_FUNC_INFO, "Missing reply");
this->threadAssertCheck();
if (!this->doWorkCheck())
{
nwReply->abort();
headerResponse.setMessage(
CStatusMessage(this, CStatusMessage::SeverityError, u"Terminated data parsing process"));
return false; // stop, terminate straight away, ending thread
}
headerResponse.setValues(nwReply);
if (nwReply->error() == QNetworkReply::NoError)
{
// do not close because of obtaining data
return true;
}
else
{
// no valid response
const QString error(nwReply->errorString());
const QString url(nwReply->url().toString());
nwReply->abort();
headerResponse.setMessage(
CStatusMessage(this, CStatusMessage::SeverityError, u"Reading data failed: '" % error % u"' " % url));
return false;
}
}
CDatabaseReader::JsonDatastoreResponse
CDatabaseReader::setStatusAndTransformReplyIntoDatastoreResponse(QNetworkReply *nwReply)
{
this->setReplyStatus(nwReply);
const CDatabaseReader::JsonDatastoreResponse dsr = this->transformReplyIntoDatastoreResponse(nwReply);
if (dsr.isSharedFile()) { this->receivedSharedFileHeaderNonClosing(nwReply); }
else
{
if (dsr.isLoadedFromDb())
{
const bool s = !dsr.hasErrorMessage();
emit this->swiftDbDataRead(s);
}
}
return dsr;
}
CDbInfoList CDatabaseReader::getDbInfoObjects() const
{
static const CDbInfoList e;
if (!sApp->hasWebDataServices()) { return e; }
if (!sApp->getWebDataServices()->getDbInfoDataReader()) { return e; }
return sApp->getWebDataServices()->getDbInfoDataReader()->getInfoObjects();
}
CDbInfoList CDatabaseReader::getSharedInfoObjects() const
{
static const CDbInfoList e;
if (!sApp->hasWebDataServices()) { return e; }
if (!sApp->getWebDataServices()->getSharedInfoDataReader()) { return e; }
return sApp->getWebDataServices()->getSharedInfoDataReader()->getInfoObjects();
}
bool CDatabaseReader::hasDbInfoObjects() const { return !getDbInfoObjects().isEmpty(); }
bool CDatabaseReader::hasSharedInfoObjects() const { return !getSharedInfoObjects().isEmpty(); }
bool CDatabaseReader::hasSharedFileHeader(const CEntityFlags::Entity entity) const
{
Q_ASSERT_X(CEntityFlags::isSingleEntity(entity), Q_FUNC_INFO, "need single entity");
return m_sharedFileResponses.contains(entity);
}
bool CDatabaseReader::hasSharedFileHeaders(const CEntityFlags::Entity entities) const
{
CEntityFlags::Entity myEntities = maskBySupportedEntities(entities);
CEntityFlags::Entity currentEntity = CEntityFlags::iterateDbEntities(myEntities);
while (currentEntity != CEntityFlags::NoEntity)
{
if (!hasSharedFileHeader(currentEntity)) { return false; }
currentEntity = CEntityFlags::iterateDbEntities(myEntities);
}
return true;
}
QDateTime CDatabaseReader::getLatestEntityTimestampFromDbInfoObjects(CEntityFlags::Entity entity) const
{
Q_ASSERT_X(CEntityFlags::isSingleEntity(entity), Q_FUNC_INFO, "need single entity");
static const QDateTime e;
const CDbInfoList il(getDbInfoObjects());
if (il.isEmpty() || entity == CEntityFlags::NoEntity) { return e; }
// for some entities there can be more than one entry because of the
// raw tables (see DB view last updates)
const CDbInfo info = il.findFirstByEntityOrDefault(entity);
if (!info.isValid()) { return e; }
return info.getUtcTimestamp();
}
QDateTime CDatabaseReader::getLatestEntityTimestampFromSharedInfoObjects(CEntityFlags::Entity entity) const
{
Q_ASSERT_X(CEntityFlags::isSingleEntity(entity), Q_FUNC_INFO, "need single entity");
static const QDateTime e;
const CDbInfoList il(this->getSharedInfoObjects());
if (il.isEmpty() || entity == CEntityFlags::NoEntity) { return e; }
const CDbInfo info = il.findFirstByEntityOrDefault(entity);
if (!info.isValid()) { return e; }
return info.getUtcTimestamp();
}
QDateTime CDatabaseReader::getLatestSharedFileHeaderTimestamp(CEntityFlags::Entity entity) const
{
Q_ASSERT_X(CEntityFlags::isSingleEntity(entity), Q_FUNC_INFO, "need single entity");
static const QDateTime e;
if (!this->hasSharedFileHeader(entity)) { return e; }
return m_sharedFileResponses[entity].getLastModifiedTimestamp();
}
bool CDatabaseReader::isSharedHeaderNewerThanCacheTimestamp(CEntityFlags::Entity entity) const
{
Q_ASSERT_X(CEntityFlags::isSingleEntity(entity), Q_FUNC_INFO, "need single entity");
const QDateTime cacheTs(this->getCacheTimestamp(entity));
if (!cacheTs.isValid()) { return true; } // we have no cache ts
const QDateTime headerTimestamp(this->getLatestSharedFileHeaderTimestamp(entity));
if (!headerTimestamp.isValid()) { return false; }
return headerTimestamp > cacheTs;
}
bool CDatabaseReader::isSharedInfoObjectNewerThanCacheTimestamp(CEntityFlags::Entity entity) const
{
Q_ASSERT_X(CEntityFlags::isSingleEntity(entity), Q_FUNC_INFO, "need single entity");
const QDateTime cacheTs(this->getCacheTimestamp(entity));
if (!cacheTs.isValid()) { return true; } // we have no cache ts
const QDateTime sharedInfoTimestamp(this->getLatestEntityTimestampFromSharedInfoObjects(entity));
if (!sharedInfoTimestamp.isValid()) { return false; }
return sharedInfoTimestamp > cacheTs;
}
CEntityFlags::Entity CDatabaseReader::getEntitesWithNewerHeaderTimestamp(CEntityFlags::Entity entities) const
{
entities &= CEntityFlags::AllDbEntitiesNoInfoObjects;
CEntityFlags::Entity currentEntity = CEntityFlags::iterateDbEntities(entities);
CEntityFlags::Entity newerEntities = CEntityFlags::NoEntity;
while (currentEntity != CEntityFlags::NoEntity)
{
if (this->isSharedHeaderNewerThanCacheTimestamp(currentEntity)) { newerEntities |= currentEntity; }
currentEntity = CEntityFlags::iterateDbEntities(entities);
}
return newerEntities;
}
CEntityFlags::Entity CDatabaseReader::getEntitesWithNewerSharedInfoObject(CEntityFlags::Entity entities) const
{
entities &= CEntityFlags::AllDbEntitiesNoInfoObjects;
CEntityFlags::Entity currentEntity = CEntityFlags::iterateDbEntities(entities);
CEntityFlags::Entity newerEntities = CEntityFlags::NoEntity;
while (currentEntity != CEntityFlags::NoEntity)
{
if (this->isSharedInfoObjectNewerThanCacheTimestamp(currentEntity)) { newerEntities |= currentEntity; }
currentEntity = CEntityFlags::iterateDbEntities(entities);
}
return newerEntities;
}
CDatabaseReaderConfig CDatabaseReader::getConfigForEntity(CEntityFlags::Entity entity) const
{
return m_config.findFirstOrDefaultForEntity(entity);
}
CEntityFlags::Entity CDatabaseReader::emitReadSignalPerSingleCachedEntity(CEntityFlags::Entity cachedEntities,
bool onlyIfHasData)
{
if (cachedEntities == CEntityFlags::NoEntity) { return CEntityFlags::NoEntity; }
CEntityFlags::Entity emitted = CEntityFlags::NoEntity;
CEntityFlags::Entity cachedEntitiesToEmit = cachedEntities;
CEntityFlags::Entity currentCachedEntity = CEntityFlags::iterateDbEntities(cachedEntitiesToEmit);
while (currentCachedEntity)
{
const int c = this->getCacheCount(currentCachedEntity);
if (!onlyIfHasData || c > 0)
{
emit this->dataRead(currentCachedEntity, CEntityFlags::ReadFinished, c, {});
emitted |= currentCachedEntity;
}
currentCachedEntity = CEntityFlags::iterateDbEntities(cachedEntitiesToEmit);
}
return emitted;
}
void CDatabaseReader::emitAndLogDataRead(CEntityFlags::Entity entity, int number, const JsonDatastoreResponse &res)
{
// never emit when lock is held, deadlock
Q_ASSERT_X(CEntityFlags::isSingleEntity(entity), Q_FUNC_INFO, "Expect single entity");
CLogMessage(this).info(u"Read %1 entities of '%2' from '%3' (%4)")
<< number << CEntityFlags::entitiesToString(entity) << res.getUrlString()
<< res.getLoadTimeStringWithStartedHint();
emit this->dataRead(entity,
res.isRestricted() ? CEntityFlags::ReadFinishedRestricted : CEntityFlags::ReadFinished,
number, res.getUrl());
}
void CDatabaseReader::logNoWorkingUrl(CEntityFlags::Entity entity)
{
const CStatusMessage msg = CStatusMessage(this, m_severityNoWorkingUrl, u"No working URL for '%1'")
<< CEntityFlags::entitiesToString(entity);
CLogMessage::preformatted(msg);
}
CUrl CDatabaseReader::getBaseUrl(CDbFlags::DataRetrievalModeFlag mode) const
{
if (!sApp || sApp->isShuttingDown()) { return CUrl(); }
switch (mode)
{
case CDbFlags::DbReading: return this->getDbServiceBaseUrl().withAppendedPath("/service");
case CDbFlags::SharedInfoOnly:
case CDbFlags::Shared: return sApp->getGlobalSetup().getSharedDbDataDirectoryUrl();
default: qFatal("Wrong mode"); break;
}
return CUrl();
}
bool CDatabaseReader::isChangedUrl(const CUrl &oldUrl, const CUrl &currentUrl)
{
if (oldUrl.isEmpty()) { return true; }
Q_ASSERT_X(!currentUrl.isEmpty(), Q_FUNC_INFO, "No base URL");
const QString old(oldUrl.getFullUrl(false));
const QString current(currentUrl.getFullUrl(false));
return old != current;
}
void CDatabaseReader::receivedSharedFileHeader(QNetworkReply *nwReplyPtr)
{
// wrap pointer, make sure any exit cleans up reply
// required to use delete later as object is created in a different thread
QScopedPointer<QNetworkReply, QScopedPointerDeleteLater> nwReply(nwReplyPtr);
if (!this->doWorkCheck()) { return; }
this->receivedSharedFileHeaderNonClosing(nwReplyPtr);
nwReply->close();
}
void CDatabaseReader::receivedSharedFileHeaderNonClosing(QNetworkReply *nwReplyPtr)
{
if (this->isAbandoned()) { return; }
const HeaderResponse headerResponse = this->transformReplyIntoHeaderResponse(nwReplyPtr);
const QString fileName = nwReplyPtr->url().fileName();
const CEntityFlags::Entity entity = CEntityFlags::singleEntityByName(fileName);
m_sharedFileResponses[entity] = headerResponse;
CLogMessage(this).info(u"Received header for shared file of '%1' from '%2'")
<< fileName << headerResponse.getUrl().toQString();
emit this->sharedFileHeaderRead(entity, fileName, !headerResponse.hasWarningOrAboveMessage());
}
bool CDatabaseReader::hasReceivedOkReply() const
{
QReadLocker rl(&m_statusLock);
return m_1stReplyReceived && m_1stReplyStatus == QNetworkReply::NoError;
}
bool CDatabaseReader::hasReceivedOkReply(QString &message) const
{
QReadLocker rl(&m_statusLock);
message = m_statusMessage;
return m_1stReplyReceived && m_1stReplyStatus == QNetworkReply::NoError;
}
bool CDatabaseReader::hasReceivedFirstReply() const
{
QReadLocker rl(&m_statusLock);
return m_1stReplyReceived;
}
QString CDatabaseReader::getSupportedEntitiesAsString() const
{
return CEntityFlags::entitiesToString(this->getSupportedEntities());
}
CEntityFlags::Entity CDatabaseReader::maskBySupportedEntities(CEntityFlags::Entity entities) const
{
return entities & this->getSupportedEntities();
}
bool CDatabaseReader::supportsAnyOfEntities(CEntityFlags::Entity entities) const
{
return static_cast<int>(this->maskBySupportedEntities(entities)) > 0;
}
bool CDatabaseReader::hasCacheTimestampNewerThan(CEntityFlags::Entity entity, const QDateTime &threshold) const
{
const QDateTime ts = this->getCacheTimestamp(entity);
if (!ts.isValid()) { return false; }
return ts > threshold;
}
const QString &CDatabaseReader::getStatusMessage() const { return m_statusMessage; }
CStatusMessageList CDatabaseReader::initFromLocalResourceFiles(bool inBackground)
{
return this->initFromLocalResourceFiles(this->getSupportedEntities(), inBackground);
}
//! \cond PRIVATE
CStatusMessageList CDatabaseReader::initFromLocalResourceFiles(CEntityFlags::Entity entities, bool inBackground)
{
const bool overrideNewerOnly = true;
entities = this->maskBySupportedEntities(entities);
if (inBackground || !CThreadUtils::isInThisThread(this))
{
const bool s = this->readFromJsonFilesInBackground(CSwiftDirectories::staticDbFilesDirectory(), entities,
overrideNewerOnly);
return s ? CStatusMessage(this).info(u"Started reading in background from '%1' of entities: '%2'")
<< CSwiftDirectories::staticDbFilesDirectory() << CEntityFlags::entitiesToString(entities) :
CStatusMessage(this).error(u"Starting reading in background from '%1' of entities: '%2' failed")
<< CSwiftDirectories::staticDbFilesDirectory() << CEntityFlags::entitiesToString(entities);
}
else
{
return this->readFromJsonFiles(CSwiftDirectories::staticDbFilesDirectory(), entities, overrideNewerOnly);
}
}
//! \endcond
void CDatabaseReader::setReplyStatus(QNetworkReply::NetworkError status, const QString &message)
{
QWriteLocker wl(&m_statusLock);
m_statusMessage = message;
m_1stReplyStatus = status;
m_1stReplyReceived = true;
}
void CDatabaseReader::setReplyStatus(QNetworkReply *nwReply)
{
Q_ASSERT_X(nwReply, Q_FUNC_INFO, "Missing network reply");
if (nwReply && nwReply->isFinished())
{
this->logNetworkReplyReceived(nwReply);
this->setReplyStatus(nwReply->error(), nwReply->errorString());
}
}
bool CDatabaseReader::overrideCacheFromFile(bool overrideNewerOnly, const QFileInfo &fileInfo,
CEntityFlags::Entity entity, CStatusMessageList &msgs) const
{
if (!fileInfo.birthTime().isValid()) { return false; }
if (!overrideNewerOnly) { return true; }
const qint64 fileTs = fileInfo.birthTime().toUTC().toMSecsSinceEpoch();
const QDateTime cacheDateTime(this->getCacheTimestamp(entity));
if (!cacheDateTime.isValid()) { return true; } // no cache
const qint64 cacheTs = cacheDateTime.toUTC().toMSecsSinceEpoch();
if (fileTs > cacheTs)
{
msgs.push_back(CStatusMessage(this).info(u"File '%1' is newer than cache (%2)")
<< fileInfo.absoluteFilePath() << cacheDateTime.toUTC().toString());
return true;
}
else
{
msgs.push_back(CStatusMessage(this).info(u"File '%1' is not newer than cache (%2)")
<< fileInfo.absoluteFilePath() << cacheDateTime.toUTC().toString());
return false;
}
}
void CDatabaseReader::logParseMessage(const QString &entity, int size, int msElapsed,
const CDatabaseReader::JsonDatastoreResponse &response) const
{
CLogMessage(this).info(u"Parsed %1 %2 in %3ms, thread %4 | '%5'")
<< size << entity << msElapsed << CThreadUtils::currentThreadInfo() << response.toQString();
}
void CDatabaseReader::networkReplyProgress(int logId, qint64 current, qint64 max, const QUrl &url)
{
CThreadedReader::networkReplyProgress(logId, current, max, url);
const QString fileName = url.fileName();
const CEntityFlags::Entity entity = CEntityFlags::singleEntityByName(fileName);
if (CEntityFlags::isSingleEntity(entity))
{
emit this->entityDownloadProgress(entity, logId, m_networkReplyProgress, m_networkReplyCurrent,
m_networkReplyNax, url);
}
}
QString CDatabaseReader::fileNameForMode(CEntityFlags::Entity entity, CDbFlags::DataRetrievalModeFlag mode)
{
Q_ASSERT_X(CEntityFlags::isSingleEntity(entity), Q_FUNC_INFO, "needs single entity");
switch (mode)
{
case CDbFlags::Shared: return CDbInfo::entityToSharedName(entity);
case CDbFlags::SharedInfoOnly: return CDbInfo::sharedInfoFileName();
default:
case CDbFlags::DbReading: return CDbInfo::entityToServiceName(entity);
}
}
QString CDatabaseReader::dateTimeToDbLatestTs(const QDateTime &ts)
{
if (!ts.isValid()) { return {}; }
return ts.toUTC().toString(Qt::ISODate);
}
const QStringList &CDatabaseReader::getLogCategories()
{
static const QStringList cats =
CThreadedReader::getLogCategories() +
QStringList { CLogCategories::swiftDbWebservice(), CLogCategories::webservice() };
return cats;
}
const QString &CDatabaseReader::parameterLatestTimestamp()
{
static const QString p("latestTimestamp");
return p;
}
QString CDatabaseReader::queryLatestTimestamp(const QDateTime &ts)
{
if (!ts.isValid()) return {};
const QString q = parameterLatestTimestamp() % u"=" % dateTimeToDbLatestTs(ts);
return q;
}
const CUrl &CDatabaseReader::getDbUrl()
{
static const CUrl dbUrl(sApp->getGlobalSetup().getDbRootDirectoryUrl());
return dbUrl;
}
void CDatabaseReader::cacheHasChanged(CEntityFlags::Entity entities)
{
this->emitReadSignalPerSingleCachedEntity(entities, false);
}
void CDatabaseReader::stringToDatastoreResponse(const QString &jsonContent,
JsonDatastoreResponse &datastoreResponse)
{
const int status = datastoreResponse.getHttpStatusCode();
if (jsonContent.isEmpty())
{
static const QString errorMsg = "Empty JSON string, status: %1, URL: '%2', load time: %3";
datastoreResponse.setMessage(
CStatusMessage(static_cast<CDatabaseReader *>(nullptr), CStatusMessage::SeverityError,
errorMsg.arg(status).arg(datastoreResponse.getUrlString(),
datastoreResponse.getLoadTimeStringWithStartedHint())));
return;
}
const QJsonDocument jsonResponse = CDatabaseUtils::databaseJsonToQJsonDocument(jsonContent);
if (jsonResponse.isEmpty())
{
if (CNetworkUtils::looksLikePhpErrorMessage(jsonContent))
{
static const QString errorMsg = "Looks like PHP errror, status %1, URL: '%2', msg: %3";
const QString phpErrorMessage = CNetworkUtils::removeHtmlPartsFromPhpErrorMessage(jsonContent);
datastoreResponse.setMessage(
CStatusMessage(static_cast<CDatabaseReader *>(nullptr), CStatusMessage::SeverityError,
errorMsg.arg(status).arg(datastoreResponse.getUrlString(), phpErrorMessage)));
}
else
{
static const QString errorMsg = "Empty JSON document, URL: '%1', load time: %2";
datastoreResponse.setMessage(
CStatusMessage(static_cast<CDatabaseReader *>(nullptr), CStatusMessage::SeverityError,
errorMsg.arg(datastoreResponse.getUrlString(),
datastoreResponse.getLoadTimeStringWithStartedHint())));
}
return;
}
if (jsonResponse.isArray())
{
// directly an array, no further info
datastoreResponse.setJsonArray(jsonResponse.array());
datastoreResponse.setLastModifiedTimestamp(QDateTime::currentDateTimeUtc());
}
else
{
const QJsonObject responseObject(jsonResponse.object());
datastoreResponse.setJsonArray(responseObject["data"].toArray());
const QString ts(responseObject["latest"].toString());
datastoreResponse.setLastModifiedTimestamp(ts.isEmpty() ? QDateTime::currentDateTimeUtc() :
CDatastoreUtility::parseTimestamp(ts));
datastoreResponse.setRestricted(responseObject["restricted"].toBool());
}
}
bool CDatabaseReader::JsonDatastoreResponse::isLoadedFromDb() const
{
return this->getUrl().getHost() == getDbUrl().getHost();
}
void CDatabaseReader::JsonDatastoreResponse::setJsonArray(const QJsonArray &value)
{
m_jsonArray = value;
m_arraySize = value.size();
}
QString CDatabaseReader::JsonDatastoreResponse::toQString() const
{
static const QString s("DB: %1 | restricted: %2 | array: %3 | string size: %4 | content: %5");
return s.arg(boolToYesNo(this->isLoadedFromDb()), boolToYesNo(this->isRestricted()))
.arg(this->getArraySize())
.arg(m_stringSize)
.arg(this->getContentLengthHeader());
}
bool CDatabaseReader::HeaderResponse::isSharedFile() const
{
const QString fn(getUrl().getFileName());
return CDbInfo::sharedFileNames().contains(fn, Qt::CaseInsensitive);
}
QString CDatabaseReader::HeaderResponse::getLoadTimeString() const
{
return QStringLiteral("%1ms").arg(getLoadTimeMs());
}
QString CDatabaseReader::HeaderResponse::getLoadTimeStringWithStartedHint() const
{
if (m_requestStarted < 0) { return this->getLoadTimeString(); }
const qint64 diff = QDateTime::currentMSecsSinceEpoch() - m_requestStarted;
static const QString s("%1 load time, started %2ms before now");
return s.arg(this->getLoadTimeString()).arg(diff);
}
void CDatabaseReader::HeaderResponse::setValues(const QNetworkReply *nwReply)
{
Q_ASSERT_X(nwReply, Q_FUNC_INFO, "Need valid reply");
this->setUrl(nwReply->url());
const QVariant started = nwReply->property("started");
if (started.isValid() && started.canConvert<qint64>())
{
const qint64 now = QDateTime::currentMSecsSinceEpoch();
const qint64 start = started.value<qint64>();
this->setLoadTimeMs(now - start);
m_requestStarted = start;
m_responseReceived = now;
}
const QVariant qvStatusCode = nwReply->attribute(QNetworkRequest::HttpStatusCodeAttribute);
if (qvStatusCode.isValid() && qvStatusCode.canConvert<int>()) { m_httpStatusCode = qvStatusCode.toInt(); }
const QDateTime lastModified = nwReply->header(QNetworkRequest::LastModifiedHeader).toDateTime();
const qulonglong size = nwReply->header(QNetworkRequest::ContentLengthHeader).toULongLong();
this->setLastModifiedTimestamp(lastModified);
this->setContentLengthHeader(size);
}
} // namespace swift::core::db
Reference in New Issue View Git Blame Copy Permalink