source: src/sql/sqlengine.cpp @ f0f9fdc

Last change on this file since f0f9fdc was f0f9fdc, checked in by Philipp Spitzer <philipp@…>, 5 years ago

Avoid duplicate code when inserting/updating a conference.

  • Property mode set to 100644
File size: 16.4 KB
Line 
1/*
2 * Copyright (C) 2010 Ixonos Plc.
3 * Copyright (C) 2011-2017 Philipp Spitzer, gregor herrmann, Stefan Stahl
4 *
5 * This file is part of ConfClerk.
6 *
7 * ConfClerk is free software: you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the Free
9 * Software Foundation, either version 2 of the License, or (at your option)
10 * any later version.
11 *
12 * ConfClerk is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
14 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
15 * more details.
16 *
17 * You should have received a copy of the GNU General Public License along with
18 * ConfClerk.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21#include <QSqlError>
22#include <QSqlQuery>
23#include <QSqlRecord>
24#include <QVariant>
25#include <QDateTime>
26#include "qglobal.h"
27#if QT_VERSION >= 0x050000
28#include <QStandardPaths>
29#else
30#include <QDesktopServices>
31#endif
32
33#include <QDir>
34#include "sqlengine.h"
35#include "track.h"
36#include "conference.h"
37
38#include <QDebug>
39
40const QString DATE_FORMAT ("yyyy-MM-dd");
41const QString TIME_FORMAT ("hh:mm");
42
43SqlEngine::SqlEngine(QObject *aParent): QObject(aParent) {
44#if QT_VERSION >= 0x050000
45    QDir dbPath(QStandardPaths::writableLocation(QStandardPaths::DataLocation));
46#else
47    QDir dbPath(QDesktopServices::storageLocation(QDesktopServices::DataLocation));
48#endif
49    dbFilename = dbPath.absoluteFilePath("ConfClerk.sqlite");
50}
51
52
53SqlEngine::~SqlEngine() {
54}
55
56
57void SqlEngine::open() {
58    // we may have to create the directory of the database
59    QFileInfo dbFilenameInfo(dbFilename);
60    QDir cwd;
61    cwd.mkpath(dbFilenameInfo.absolutePath());
62    // We don't have to handle errors because in worst case, opening the database will fail
63    // and db.isOpen() returns false.
64    db = QSqlDatabase::addDatabase("QSQLITE");
65    db.setDatabaseName(dbFilename);
66    db.open();
67}
68
69
70int SqlEngine::dbSchemaVersion() {
71    QSqlQuery query(db);
72    if (!query.exec("PRAGMA user_version")) {
73        emitSqlQueryError(query);
74        return -2;
75    }
76    query.first();
77    int version = query.value(0).toInt();
78    if (version == 0) {
79        // check whether the tables are existing
80        if (!query.exec("select count(*) from sqlite_master where name='CONFERENCE'")) {
81            emitSqlQueryError(query);
82            return -2;
83        }
84        query.first();
85        if (query.value(0).toInt() == 1) return 0; // tables are existing
86        return -1; // database seems to be empty (or has other tables)
87    }
88    return version;
89}
90
91
92bool SqlEngine::updateDbSchemaVersion000To001() {
93    return applySqlFile(":/dbschema000to001.sql");
94}
95
96
97bool SqlEngine::createCurrentDbSchema() {
98    return applySqlFile(":/dbschema001.sql");
99}
100
101
102bool SqlEngine::createOrUpdateDbSchema() {
103    int version = dbSchemaVersion();
104    switch (version) {
105    case -2:
106        // the error has already been emitted by the previous function
107        return false;
108    case -1:
109        // empty database
110        return createCurrentDbSchema();
111    case 0:
112        // db schema version 0
113        return updateDbSchemaVersion000To001();
114    case 1:
115        // current schema
116        return true;
117    default:
118        // unsupported schema
119        emit dbError(tr("Unsupported database schema version %1.").arg(version));
120    }
121    return false;
122}
123
124
125bool SqlEngine::applySqlFile(const QString sqlFile) {
126    QFile file(sqlFile);
127    file.open(QIODevice::ReadOnly | QIODevice::Text);
128    QString allSqlStatements = file.readAll();
129    QSqlQuery query(db);
130    foreach(QString sql, allSqlStatements.split(";")) {
131        if (sql.trimmed().isEmpty())  // do not execute empty queries like the last character from create_tables.sql
132            continue;
133        if (!query.exec(sql)) {
134            emitSqlQueryError(query);
135            return false;
136        }
137    }
138    return true;
139}
140
141
142void SqlEngine::addConferenceToDB(QHash<QString,QString> &aConference, int conferenceId) {
143    QSqlQuery query(db);
144    bool insert = conferenceId <= 0;
145    if (insert) { // insert conference
146        query.prepare("INSERT INTO CONFERENCE (title,url,subtitle,venue,city,start,end,"
147                                                "day_change,timeslot_duration,active) "
148                        " VALUES (:title,:url,:subtitle,:venue,:city,:start,:end,"
149                                                ":day_change,:timeslot_duration,:active)");
150    } else { // update conference
151        query.prepare("UPDATE CONFERENCE set title=:title, url=:url, subtitle=:subtitle, venue=:venue, city=:city, start=:start, end=:end,"
152                                            "day_change=:day_change, timeslot_duration=:timeslot_duration, active=:active "
153                      "WHERE id=:id");
154    }
155    foreach (QString prop_name, (QList<QString>() << "title" << "url" << "subtitle" << "venue" << "city")) {
156        query.bindValue(QString(":") + prop_name, aConference[prop_name]);
157    }
158    query.bindValue(":start", QDateTime(QDate::fromString(aConference["start"],DATE_FORMAT),QTime(0,0),Qt::UTC).toTime_t());
159    query.bindValue(":end", QDateTime(QDate::fromString(aConference["end"],DATE_FORMAT),QTime(0,0),Qt::UTC).toTime_t());
160    query.bindValue(":day_change", -QTime::fromString(aConference["day_change"],TIME_FORMAT).secsTo(QTime(0,0)));
161    query.bindValue(":timeslot_duration", -QTime::fromString(aConference["timeslot_duration"],TIME_FORMAT).secsTo(QTime(0,0)));
162    query.bindValue(":active", 1);
163    if (!insert) query.bindValue(":id", conferenceId);
164    query.exec();
165    emitSqlQueryError(query);
166    if (insert) {
167        aConference["id"] = query.lastInsertId().toString(); // 'id' is assigned automatically
168    } else {
169        aConference["id"] = QVariant(conferenceId).toString();
170    }
171}
172
173
174void SqlEngine::addEventToDB(QHash<QString,QString> &aEvent) {
175    int conferenceId = aEvent["conference_id"].toInt();
176    Conference conference = Conference::getById(conferenceId);
177
178    // insert event track to table and get track id
179    Track track;
180    int trackId;
181    QString trackName = aEvent["track"];
182    if (trackName.isEmpty()) trackName = tr("No track");
183    try
184    {
185        track = Track::retrieveByName(conferenceId, trackName);
186        trackId = track.id();
187    }
188    catch (OrmNoObjectException &e) {
189        track.setConference(conferenceId);
190        track.setName(trackName);
191        trackId = track.insert();
192    }
193    QDate startDate = QDate::fromString(aEvent["date"], DATE_FORMAT);
194    QTime startTime = QTime::fromString(aEvent["start"], TIME_FORMAT);
195    // consider day_change (note that if day_change is e.g. at 04:00 AM, an event starting at 02:00 AM has the previous date in the XML file)
196    if (startTime < conference.dayChangeTime()) startDate = startDate.addDays(1);
197    QDateTime startDateTime;
198    startDateTime.setTimeSpec(Qt::UTC);
199    startDateTime = QDateTime(startDate, startTime, Qt::UTC);
200
201    bool event_exists = false;
202    {
203        QSqlQuery check_event_query;
204        check_event_query.prepare("SELECT * FROM EVENT WHERE xid_conference = :xid_conference AND id = :id");
205        check_event_query.bindValue(":xid_conference", aEvent["conference_id"]);
206        check_event_query.bindValue(":id", aEvent["id"]);
207        if (!check_event_query.exec()) {
208            qWarning() << "check event failed, conference id:" << aEvent["xid_conference"]
209                    << "event id:" << aEvent["id"]
210                    << "error:" << check_event_query.lastError()
211                    ;
212            return;
213        }
214        if (check_event_query.isActive() and check_event_query.isSelect() and check_event_query.next()) {
215            event_exists = true;
216        }
217    }
218
219    QSqlQuery result;
220    if (event_exists) {
221        result.prepare("UPDATE EVENT SET"
222                        " start = :start"
223                        ", duration = :duration"
224                        ", xid_track = :xid_track"
225                        ", type = :type"
226                        ", language = :language"
227                        ", tag = :tag"
228                        ", title = :title"
229                        ", subtitle = :subtitle"
230                        ", abstract = :abstract"
231                        ", description = :description"
232                            " WHERE id = :id AND xid_conference = :xid_conference");
233    } else {
234        result.prepare("INSERT INTO EVENT "
235                        " (xid_conference, id, start, duration, xid_track, type, "
236                            " language, tag, title, subtitle, abstract, description) "
237                        " VALUES (:xid_conference, :id, :start, :duration, :xid_track, :type, "
238                            ":language, :tag, :title, :subtitle, :abstract, :description)");
239    }
240    result.bindValue(":xid_conference", aEvent["conference_id"]);
241    result.bindValue(":start", QString::number(startDateTime.toTime_t()));
242    result.bindValue(":duration", -QTime::fromString(aEvent["duration"],TIME_FORMAT).secsTo(QTime(0,0)));
243    result.bindValue(":xid_track", trackId);
244    static const QList<QString> props = QList<QString>()
245        << "id" << "type" << "language" << "tag" << "title" << "subtitle" << "abstract" << "description";
246    foreach (QString prop_name, props) {
247        result.bindValue(QString(":") + prop_name, aEvent[prop_name]);
248    }
249    if (!result.exec()) {
250        qWarning() << "event insert/update failed:" << result.lastError();
251    }
252}
253
254
255void SqlEngine::addPersonToDB(QHash<QString,QString> &aPerson) {
256    QSqlQuery query(db);
257    query.prepare("INSERT INTO PERSON (xid_conference,id,name) VALUES (:xid_conference, :id, :name)");
258    query.bindValue(":xid_conference", aPerson["conference_id"]);
259    query.bindValue(":id", aPerson["id"]);
260    query.bindValue(":name", aPerson["name"]);
261    query.exec(); // TODO some queries fail due to the unique key constraint
262    // if (!query.exec()) qDebug() << "SQL query 'insert into person' failed: " << query.lastError();
263
264    query = QSqlQuery(db);
265    query.prepare("INSERT INTO EVENT_PERSON (xid_conference,xid_event,xid_person) VALUES (:xid_conference, :xid_event, :xid_person)");
266    query.bindValue(":xid_conference", aPerson["conference_id"]);
267    query.bindValue(":xid_event", aPerson["event_id"]);
268    query.bindValue(":xid_person", aPerson["id"]);
269    query.exec(); // TODO some queries fail due to the unique key constraint
270    // if (!query.exec()) qDebug() << "SQL query 'insert into event_person' failed: " << query.lastError();
271}
272
273
274void SqlEngine::addRoomToDB(QHash<QString,QString> &aRoom) {
275    QSqlQuery query(db);
276    query.prepare("SELECT id FROM ROOM WHERE xid_conference=:conference_id and name=:name");
277    query.bindValue(":conference_id", aRoom["conference_id"]);
278    query.bindValue(":name", aRoom["name"]);
279    query.exec();
280    emitSqlQueryError(query);
281    // now we have to check whether ROOM record with 'name' exists or not,
282    // - if it doesn't exist yet, then we have to add that record to 'ROOM' table
283    //   and assign autoincremented 'id' to aRoom
284    // - if it exists, then we need to get its 'id' and assign it to aRoom
285    aRoom["id"] = "";
286    if(query.next()) // ROOM record with 'name' already exists: we need to get its 'id'
287    {
288        aRoom["id"] = query.value(0).toString();
289    }
290    else // ROOM record doesn't exist yet, need to create it
291    {
292        query = QSqlQuery(db);
293        query.prepare("INSERT INTO ROOM (xid_conference,name) VALUES (:xid_conference, :name)");
294        query.bindValue(":xid_conference", aRoom["conference_id"]);
295        query.bindValue(":name", aRoom["name"]);
296        query.exec();
297        emitSqlQueryError(query);
298        aRoom["id"]= query.lastInsertId().toString(); // 'id' is assigned automatically
299        //LOG_AUTOTEST(query);
300    }
301
302    // remove previous conference/room records; room names might have changed
303    query = QSqlQuery(db);
304    query.prepare("DELETE FROM EVENT_ROOM WHERE xid_conference=:conference_id AND xid_event=:event_id");
305    query.bindValue(":conference_id", aRoom["conference_id"]);
306    query.bindValue(":event_id", aRoom["event_id"]);
307    query.exec();
308    emitSqlQueryError(query);
309    // and insert new ones
310    query = QSqlQuery(db);
311    query.prepare("INSERT INTO EVENT_ROOM (xid_conference,xid_event,xid_room) VALUES (:conference_id, :event_id, :room_id)");
312    query.bindValue(":conference_id", aRoom["conference_id"]);
313    query.bindValue(":event_id", aRoom["event_id"]);
314    query.bindValue(":room_id", aRoom["id"]);
315    query.exec();
316    emitSqlQueryError(query);
317}
318
319
320void SqlEngine::addLinkToDB(QHash<QString,QString> &aLink) {
321    //TODO: check if the link doesn't exist before inserting
322    QSqlQuery query(db);
323    query.prepare("INSERT INTO LINK (xid_event, xid_conference, name, url) VALUES (:xid_event, :xid_conference, :name, :url)");
324    query.bindValue(":xid_event", aLink["event_id"]);
325    query.bindValue(":xid_conference", aLink["conference_id"]);
326    query.bindValue(":name", aLink["name"]);
327    query.bindValue(":url", aLink["url"]);
328    query.exec();
329    emitSqlQueryError(query);
330}
331
332
333bool SqlEngine::searchEvent(int aConferenceId, const QHash<QString,QString> &aColumns, const QString &aKeyword) {
334    if (aColumns.empty()) return false;
335
336    // DROP
337    QSqlQuery query(db);
338    query.exec("DROP TABLE IF EXISTS SEARCH_EVENT");
339    emitSqlQueryError(query);
340
341    // CREATE
342    query.exec("CREATE TEMP TABLE SEARCH_EVENT ( xid_conference INTEGER  NOT NULL, id INTEGER NOT NULL )");
343    emitSqlQueryError(query);
344
345    // INSERT
346    QString sql = QString("INSERT INTO SEARCH_EVENT ( xid_conference, id ) "
347                "SELECT DISTINCT EVENT.xid_conference, EVENT.id FROM EVENT ");
348    if( aColumns.contains("ROOM") ){
349        sql += "LEFT JOIN EVENT_ROOM ON ( EVENT.xid_conference = EVENT_ROOM.xid_conference AND EVENT.id = EVENT_ROOM.xid_event ) ";
350        sql += "LEFT JOIN ROOM ON ( EVENT_ROOM.xid_room = ROOM.id ) ";
351    }
352    if( aColumns.contains("PERSON") ){
353        sql += "LEFT JOIN EVENT_PERSON ON ( EVENT.xid_conference = EVENT_PERSON.xid_conference AND EVENT.id = EVENT_PERSON.xid_event ) ";
354        sql += "LEFT JOIN PERSON ON ( EVENT_PERSON.xid_person = PERSON.id ) ";
355    }
356    sql += QString("WHERE EVENT.xid_conference = %1 AND (").arg( aConferenceId );
357
358    QStringList searchKeywords = aKeyword.trimmed().split(QRegExp("\\s+"));
359    QStringList whereAnd;
360    for (int i=0; i < searchKeywords.count(); i++) {
361        QStringList whereOr;
362        foreach (QString table, aColumns.uniqueKeys()) {
363            foreach (QString column, aColumns.values(table)){
364                 whereOr.append(QString("%1.%2 LIKE '\%' || :%1%2%3 || '\%'").arg(table).arg(column).arg(i));
365            }
366        }
367        whereAnd.append(whereOr.join(" OR "));
368    }
369    sql += whereAnd.join(") AND (");
370    sql += QString(")");
371
372    query.prepare(sql);
373    for (int i = 0; i != searchKeywords.size(); ++i) {
374        QString keyword = searchKeywords[i];
375        foreach (QString table, aColumns.uniqueKeys()) {
376            foreach (QString column, aColumns.values(table)) {
377                query.bindValue(QString(":%1%2%3").arg(table).arg(column).arg(i), keyword );
378            }
379        }
380    }
381
382    bool success = query.exec();
383    emitSqlQueryError(query);
384    return success;
385}
386
387
388bool SqlEngine::beginTransaction() {
389    QSqlQuery query(db);
390    bool success = query.exec("BEGIN IMMEDIATE TRANSACTION");
391    emitSqlQueryError(query);
392    return success;
393}
394
395
396bool SqlEngine::commitTransaction() {
397    QSqlQuery query(db);
398    bool success = query.exec("COMMIT");
399    emitSqlQueryError(query);
400    return success;
401}
402
403
404bool SqlEngine::deleteConference(int id) {
405    QSqlQuery query(db);
406    bool success = query.exec("BEGIN IMMEDIATE TRANSACTION");
407    emitSqlQueryError(query);
408
409    QStringList sqlList;
410    sqlList << "DELETE FROM LINK WHERE xid_conference = ?"
411            << "DELETE FROM EVENT_ROOM WHERE xid_conference = ?"
412            << "DELETE FROM EVENT_PERSON WHERE xid_conference = ?"
413            << "DELETE FROM EVENT WHERE xid_conference = ?"
414            << "DELETE FROM ROOM WHERE xid_conference = ?"
415            << "DELETE FROM PERSON WHERE xid_conference = ?"
416            << "DELETE FROM TRACK WHERE xid_conference = ?"
417            << "DELETE FROM CONFERENCE WHERE id = ?";
418
419    foreach (const QString& sql, sqlList) {
420        query.prepare(sql);
421        query.bindValue(0, id);
422        success &= query.exec();
423        emitSqlQueryError(query);
424    }
425
426    success &= query.exec("COMMIT");
427    emitSqlQueryError(query);
428
429    return success;
430}
431
432
433void SqlEngine::emitSqlQueryError(const QSqlQuery &query) {
434    QSqlError error = query.lastError();
435    if (error.type() == QSqlError::NoError) return;
436    emit dbError(error.text());
437}
438
Note: See TracBrowser for help on using the repository browser.