Comments about return values.
[emufront] / src / db / dbfile.cpp
1 // EmuFront
2 // Copyright 2010 Mikko Keinänen
3 //
4 // This file is part of EmuFront.
5 //
6 //
7 // EmuFront is free software: you can redistribute it and/or modify
8 // it under the terms of the GNU General Public License version 2 as published by
9 // the Free Software Foundation and appearing in the file gpl.txt included in the
10 // packaging of this file.
11 //
12 // EmuFront is distributed in the hope that it will be useful,
13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 // GNU General Public License for more details.
16 //
17 // You should have received a copy of the GNU General Public License
18 // along with EmuFront.  If not, see <http://www.gnu.org/licenses/>.
19
20 #include <QDebug>
21 #include <QSqlRecord>
22 #include <QSqlQuery>
23 #include <QSqlRelationalTableModel>
24 #include "dbfile.h"
25
26
27 DbFile::DbFile(QObject *parent) : DbQueryModelManager(parent)
28 {
29     tableName = DbFile::DB_TABLE_NAME_FILE;
30     type = -1;
31 }
32
33 EmuFrontObject* DbFile::recordToDataObject(const QSqlRecord *record)
34 {
35     int id = record->value(File_Id).toInt();
36     QString name = record->value(File_Name).toString();
37     QString checksum = record->value(File_CheckSum).toString();
38     int size = record->value(File_FileSize).toInt();
39     int type = record->value(File_FileType).toInt();
40     return new EmuFrontFile(id, name, checksum, size, type);
41 }
42
43 bool DbFile::updateDataObjectToModel(const EmuFrontObject *ob)
44 {
45     const EmuFrontFile *plf = dynamic_cast<const EmuFrontFile*>(ob);
46     bool ret = false;
47
48     QSqlQuery query;
49     query.prepare(QString("UPDATE file SET"
50                           "name=:name, "
51                           "type=:type, "
52                           "checksum=:checksum, "
53                           "size=:size, "
54                           "updatetime:=updatetime "
55                           "WHERE id=:id"));
56     query.bindValue(":name", plf->getName());
57     query.bindValue(":type", plf->getType());
58     query.bindValue(":checksum", plf->getCheckSum());
59     query.bindValue(":size", plf->getSize());
60     query.bindValue(":updatetime", getCurrentTimeStamp());
61     ret = query.exec();
62     if (ret) resetModel();
63     return ret;
64 }
65
66 /* Returns id of inserted data item after succesful insert, -1 if insert failed */
67 int DbFile::insertDataObjectToModel(const EmuFrontObject *ob)
68 {
69     const EmuFrontFile *fi = dynamic_cast<const EmuFrontFile*>(ob);
70     QSqlQuery q;
71     q.prepare("INSERT INTO file "
72               "(id, name, type, checksum, size, updatetime) "
73               "VALUES (NULL, :name, :type, :checksum, :size, :updatetime)");
74     q.bindValue(":name", fi->getName());
75     q.bindValue(":type", fi->getType());
76     q.bindValue(":checksum", fi->getCheckSum());
77     q.bindValue(":size", fi->getSize());
78     q.bindValue(":updatetime", DatabaseManager::getCurrentTimeStamp());
79     int id = -1;
80     if (q.exec())
81         id = q.lastInsertId().toInt();
82     return id;
83 }
84
85 // WARNING: this will delete also all the databindings to selected platform
86 // the delete must be confirmed in the UI
87 bool DbFile::deleteDataObjectFromModel(QModelIndex *index)
88 {
89     return false;
90 }
91
92 bool DbFile::deleteDataObject(int id) const
93 {
94     if (countDataObjectRefs(id) > 0)
95         // TODO
96         return false;
97     QSqlQuery q;
98     q.prepare(QString("DELETE FROM file WHERE id=:id"));
99     q.bindValue(":id", id);
100     return q.exec();
101 }
102
103 QString DbFile::constructSelect(QString where) const
104 {
105     return QString("SELECT file.id AS FileId, "
106                    "file.name AS Name, "
107                    "file.type AS FileType, "
108                    "file.checksum AS Checksum, "
109                    "file.size AS FileSize, "
110                    "file.updatetime AS UpdateTime "
111                    "FROM file "
112                    "%1 "
113                    "ORDER BY Name").arg(where);
114 }
115
116 QString DbFile::constructFilterById(int id) const
117 {
118     return QString("file.id = %1").arg(id);
119 }
120
121 QString DbFile::constructSelectById(int id) const
122 {
123     return constructSelect(QString("WHERE %1").arg(constructFilterById(id)));
124 }
125
126 QSqlQueryModel* DbFile::getData()
127 {
128     QSqlQueryModel *model = new QSqlQueryModel(this);
129     model->setQuery(constructSelect());
130     model->setHeaderData(File_Name, Qt::Horizontal, tr("Name"));
131     model->setHeaderData(File_FileType, Qt::Horizontal, tr("Type"));
132     model->setHeaderData(File_CheckSum, Qt::Horizontal, tr("Checksum"));
133     model->setHeaderData(File_FileSize, Qt::Horizontal, tr("Size"));
134     model->setHeaderData(File_UpdateTime, Qt::Horizontal, tr("Updated"));
135     return model;
136 }
137
138 /* Throws EmuFrontException */
139 EmuFrontObject* DbFile::getFileByChecksum(QString checksum)
140 {
141     return getDataObject(QString("checksum LIKE '%1'").arg(checksum));
142 }
143
144 QString DbFile::getCountRefsSelect(int id) const
145 {
146     /* files are referenced from platform, mediatype, mediaimagecontainer_mediaimage and mediaimagecontainer. */
147     return QString("SELECT count(*) FROM ("
148               "SELECT file.id FROM file "
149               "INNER JOIN platform ON file.id=platform.fileid "
150               "WHERE file.id=%1 "
151               "UNION ALL "
152               "SELECT file.id FROM file "
153               "INNER JOIN mediatype ON file.id=mediatype.fileid "
154               "WHERE file.id=%1 "
155               "UNION ALL "
156               "SELECT file.id FROM file "
157               "INNER JOIN mediaimagecontainer_mediaimage "
158               "ON (mediaimagecontainerid=file.id OR mediaimageid=file.id) "
159               "WHERE file.id=%1 "
160               ")").arg(id);
161 }