1 /***************************************************************************
2 * Copyright (C) 2005-2019 by the Quassel Project *
3 * devel@quassel-irc.org *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) version 3. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
19 ***************************************************************************/
26 #include <QSqlDatabase>
32 class AbstractSqlMigrationReader;
33 class AbstractSqlMigrationWriter;
35 class AbstractSqlStorage : public Storage
40 AbstractSqlStorage(QObject* parent = nullptr);
41 ~AbstractSqlStorage() override;
43 virtual std::unique_ptr<AbstractSqlMigrationReader> createMigrationReader() { return {}; }
44 virtual std::unique_ptr<AbstractSqlMigrationWriter> createMigrationWriter() { return {}; }
47 * An SQL query with associated resource filename
49 struct SqlQueryResource {
50 QString queryString; ///< SQL query string
51 QString queryFilename; ///< Path to the resource file providing this query
53 SqlQueryResource(const QString& queryString, const QString& queryFilename)
54 : queryString(std::move(queryString)),
55 queryFilename(std::move(queryFilename)) {}
59 State init(const QVariantMap& settings = QVariantMap(),
60 const QProcessEnvironment& environment = {},
61 bool loadFromEnvironment = false) override;
62 bool setup(const QVariantMap& settings = QVariantMap(),
63 const QProcessEnvironment& environment = {},
64 bool loadFromEnvironment = false) override;
67 inline void sync() override{};
72 * Fetch an SQL query string by name and optional schema version
74 * Loads the named SQL query from the built-in SQL resource collection, returning it as a
75 * string. If a version is specified, it'll be loaded from the schema version-specific folder
78 * @see schemaVersion()
80 * @param[in] queryName File name of the SQL query, minus the .sql extension
83 * SQL schema version; if 0, fetches from current version, otherwise loads from the specified
84 * schema version instead of the current schema files.
86 * @return String with the requested SQL query, ready for parameter substitution
88 QString queryString(const QString& queryName, int version = 0);
91 * Gets the collection of SQL setup queries and filenames to create a new database
93 * @return List of SQL query strings and filenames
95 QList<SqlQueryResource> setupQueries();
98 * Gets the collection of SQL upgrade queries and filenames for a given schema version
100 * @param ver SQL schema version
101 * @return List of SQL query strings and filenames
103 QList<SqlQueryResource> upgradeQueries(int ver);
106 bool watchQuery(QSqlQuery& query);
109 virtual int installedSchemaVersion() { return -1; };
112 * Update the stored schema version number, optionally clearing the record of mid-schema steps
114 * @param newVersion New schema version number
115 * @param clearUpgradeStep If true, clear the record of any in-progress schema upgrades
118 virtual bool updateSchemaVersion(int newVersion, bool clearUpgradeStep = true) = 0;
120 virtual bool setupSchemaVersion(int version) = 0;
123 * Gets the last successful schema upgrade step, or an empty string if no upgrade is in progress
125 * @return Filename of last successful schema upgrade query, or empty string if not upgrading
127 virtual QString schemaVersionUpgradeStep();
130 * Sets the last successful schema upgrade step
132 * @param upgradeQuery The filename of the last successful schema upgrade query
133 * @return True if successfully set, otherwise false
135 virtual bool setSchemaVersionUpgradeStep(QString upgradeQuery) = 0;
137 virtual void setConnectionProperties(const QVariantMap& properties, const QProcessEnvironment& environment, bool loadFromEnvironment) = 0;
138 virtual QString driverName() = 0;
139 inline virtual QString hostName() { return QString(); }
140 inline virtual int port() { return -1; }
141 virtual QString databaseName() = 0;
142 inline virtual QString userName() { return QString(); }
143 inline virtual QString password() { return QString(); }
145 //! Initialize db specific features on connect
146 /** This is called every time a connection to a specific SQL backend is established
147 * the default implementation does nothing.
149 * When reimplementing this method, don't use logDB() inside this function as
150 * this would cause as we're just about to initialize that DB connection.
152 inline virtual bool initDbSession(QSqlDatabase& /* db */) { return true; }
155 void connectionDestroyed();
158 void addConnectionToPool();
159 void dbConnect(QSqlDatabase& db);
161 int _schemaVersion{0};
164 static int _nextConnectionId;
165 QMutex _connectionPoolMutex;
166 // we let a Connection Object manage each actual db connection
167 // those objects reside in the thread the connection belongs to
168 // which allows us thread safe termination of a connection
170 QHash<QThread*, Connection*> _connectionPool;
179 friend uint qHash(const SenderData& key);
180 friend bool operator==(const SenderData& a, const SenderData& b);
183 // ========================================
184 // AbstractSqlStorage::Connection
185 // ========================================
186 class AbstractSqlStorage::Connection : public QObject
191 Connection(const QString& name, QObject* parent = nullptr);
192 ~Connection() override;
194 inline QLatin1String name() const { return QLatin1String(_name); }
200 // ========================================
201 // AbstractSqlMigrator
202 // ========================================
203 class AbstractSqlMigrator
213 QString authenticator;
228 QString identityname;
231 bool awayNickEnabled;
233 bool awayReasonEnabled;
234 bool autoAwayEnabled;
236 QString autoAwayReason;
237 bool autoAwayReasonEnabled;
238 bool detachAwayEnabled;
239 QString detachAwayReason;
240 bool detachAwayReasonEnabled;
249 struct IdentityNickMO
252 IdentityId identityId;
261 QString autoidentifyservice;
262 QString autoidentifypassword;
264 QString saslpassword;
266 QString encodingcodec;
267 QString decodingcodec;
270 QString attachperform;
271 QString detachperform;
273 IdentityId identityid;
274 int messagerateburstsize;
275 int messageratedelay;
276 int autoreconnectinterval;
277 int autoreconnectretries;
279 bool userandomserver;
280 bool useautoidentify;
282 bool useautoreconnect;
283 bool unlimitedconnectretries;
284 bool usecustommessagerate;
285 bool unlimitedmessagerate;
299 qint64 lastseenmsgid;
300 qint64 markerlinemsgid;
311 QDateTime time; // has to be in UTC!
316 QString senderprefixes;
329 bool sslverify; /// If true, validate SSL certificates
343 QByteArray settingvalue;
366 virtual ~AbstractSqlMigrator() = default;
368 static QString migrationObject(MigrationObject moType);
371 void newQuery(const QString& query, QSqlDatabase db);
372 virtual void resetQuery();
373 virtual bool prepareQuery(MigrationObject mo) = 0;
375 inline bool next() { return _query->next(); }
376 inline QVariant value(int index) { return _query->value(index); }
377 inline void bindValue(const QString& placeholder, const QVariant& val) { _query->bindValue(placeholder, val); }
378 inline void bindValue(int pos, const QVariant& val) { _query->bindValue(pos, val); }
380 inline QSqlError lastError() { return _query ? _query->lastError() : QSqlError(); }
382 inline QString executedQuery() { return _query ? _query->executedQuery() : QString(); }
383 inline QVariantList boundValues();
385 virtual bool transaction() = 0;
386 virtual void rollback() = 0;
387 virtual bool commit() = 0;
390 QSqlQuery* _query{nullptr};
393 class AbstractSqlMigrationReader : public AbstractSqlMigrator
396 AbstractSqlMigrationReader();
398 virtual bool readMo(QuasselUserMO& user) = 0;
399 virtual bool readMo(IdentityMO& identity) = 0;
400 virtual bool readMo(IdentityNickMO& identityNick) = 0;
401 virtual bool readMo(NetworkMO& network) = 0;
402 virtual bool readMo(BufferMO& buffer) = 0;
403 virtual bool readMo(SenderMO& sender) = 0;
404 virtual bool readMo(BacklogMO& backlog) = 0;
405 virtual bool readMo(IrcServerMO& ircserver) = 0;
406 virtual bool readMo(UserSettingMO& userSetting) = 0;
407 virtual bool readMo(CoreStateMO& coreState) = 0;
409 bool migrateTo(AbstractSqlMigrationWriter* writer);
412 void abortMigration(const QString& errorMsg = QString());
413 bool finalizeMigration();
416 bool transferMo(MigrationObject moType, T& mo);
418 AbstractSqlMigrationWriter* _writer{nullptr};
421 class AbstractSqlMigrationWriter : public AbstractSqlMigrator
424 virtual bool writeMo(const QuasselUserMO& user) = 0;
425 virtual bool writeMo(const IdentityMO& identity) = 0;
426 virtual bool writeMo(const IdentityNickMO& identityNick) = 0;
427 virtual bool writeMo(const NetworkMO& network) = 0;
428 virtual bool writeMo(const BufferMO& buffer) = 0;
429 virtual bool writeMo(const SenderMO& sender) = 0;
430 virtual bool writeMo(const BacklogMO& backlog) = 0;
431 virtual bool writeMo(const IrcServerMO& ircserver) = 0;
432 virtual bool writeMo(const UserSettingMO& userSetting) = 0;
433 virtual bool writeMo(const CoreStateMO& coreState) = 0;
435 inline bool migrateFrom(AbstractSqlMigrationReader* reader) { return reader->migrateTo(this); }
437 // called after migration process
438 virtual inline bool postProcess() { return true; }
439 friend class AbstractSqlMigrationReader;