GeezerVison is showing github.com — sqlitebrowser/src/RowLoader.cpp at master · sqlitebrowser/sqlitebrowser

Expand file tree

RowLoader.cpp

Copy path

More file actions

Latest commit

History

283 lines (238 loc) · 8.8 KB

RowLoader.cpp

Copy path

File metadata and controls

283 lines (238 loc) · 8.8 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

#include <QDebug>

#include <QRegularExpression>

#include "RowLoader.h"

#include "sqlite.h"

namespace {

QString rtrimChar(const QString& s, QChar c)

{

QString r = s.trimmed();

while(r.endsWith(c))

r.chop(1);

return r;

}

} // anon ns

RowLoader::RowLoader (std::function<std::shared_ptr<sqlite3>(void)> db_getter_,

std::function<void(QString)> statement_logger_,

std::vector<std::string> & headers_,

std::mutex & cache_mutex_,

Cache & cache_data_

)

: db_getter(db_getter_), statement_logger(statement_logger_)

, headers(headers_)

, cache_mutex(cache_mutex_), cache_data(cache_data_)

, query()

, countQuery()

, first_chunk_loaded(false)

, num_tasks(0)

, pDb(nullptr)

, stop_requested(false)

, current_task(nullptr)

, next_task(nullptr)

{

}

void RowLoader::setQuery (const QString& new_query, const QString& newCountQuery)

{

std::lock_guard<std::mutex> lk(m);

query = new_query;

first_chunk_loaded = false;

if (newCountQuery.isEmpty())

// If it is a normal query - hopefully starting with SELECT - just do a COUNT on it and return the results

countQuery = QString("SELECT COUNT(*) FROM (%1);").arg(rtrimChar(query, ';'));

else

countQuery = newCountQuery;

}

void RowLoader::triggerRowCountDetermination(int token)

{

std::unique_lock<std::mutex> lk(m);

num_tasks++;

nosync_ensureDbAccess();

// do a count query to get the full row count in a fast manner

row_counter = std::async(std::launch::async, [this, token]() {

auto nrows = countRows();

if(nrows >= 0)

emit rowCountComplete(token, nrows);

std::lock_guard<std::mutex> lk2(m);

nosync_taskDone();

});

}

void RowLoader::nosync_ensureDbAccess ()

{

if(!pDb)

pDb = db_getter();

}

std::shared_ptr<sqlite3> RowLoader::getDb () const

{

std::lock_guard<std::mutex> lk(m);

return pDb;

}

int RowLoader::countRows() const

{

int retval = -1;

// Use a different approach of determining the row count when a EXPLAIN or a PRAGMA statement is used because a COUNT fails on these queries

if(query.startsWith("EXPLAIN", Qt::CaseInsensitive) || query.startsWith("PRAGMA", Qt::CaseInsensitive))

{

// So just execute the statement as it is and fetch all results counting the rows

sqlite3_stmt* stmt;

QByteArray utf8Query = query.toUtf8();

if(sqlite3_prepare_v2(pDb.get(), utf8Query, utf8Query.size(), &stmt, nullptr) == SQLITE_OK)

{

retval = 0;

while(sqlite3_step(stmt) == SQLITE_ROW)

retval++;

sqlite3_finalize(stmt);

return retval;

}

} else {

statement_logger(countQuery);

QByteArray utf8Query = countQuery.toUtf8();

sqlite3_stmt* stmt;

if(sqlite3_prepare_v2(pDb.get(), utf8Query, utf8Query.size(), &stmt, nullptr) == SQLITE_OK)

{

if(sqlite3_step(stmt) == SQLITE_ROW)

retval = sqlite3_column_int(stmt, 0);

sqlite3_finalize(stmt);

} else {

qWarning() << "Count query failed: " << countQuery;

}

return retval;

}

void RowLoader::triggerFetch (int token, size_t row_begin, size_t row_end)

{

std::unique_lock<std::mutex> lk(m);

if(pDb) {

if(!row_counter.valid() || row_counter.wait_for(std::chrono::seconds(0)) == std::future_status::ready) {

// only if row count is complete, we can safely interrupt SQLite to speed up cancellation

sqlite3_interrupt(pDb.get());

}

if(current_task)

current_task->cancel = true;

nosync_ensureDbAccess();

// (forget a possibly already existing "next task")

next_task.reset(new Task{ *this, token, row_begin, row_end });

lk.unlock();

cv.notify_all();

}

void RowLoader::nosync_taskDone()

{

if(--num_tasks == 0) {

pDb = nullptr;

}

void RowLoader::cancel ()

{

std::unique_lock<std::mutex> lk(m);

if(pDb)

sqlite3_interrupt(pDb.get());

if(current_task)

current_task->cancel = true;

next_task = nullptr;

cv.notify_all();

}

void RowLoader::stop ()

{

cancel();

std::unique_lock<std::mutex> lk(m);

stop_requested = true;

cv.notify_all();

}

bool RowLoader::readingData () const

{

std::unique_lock<std::mutex> lk(m);

return pDb != nullptr;

}

void RowLoader::waitUntilIdle () const

{

if(row_counter.valid())

row_counter.wait();

std::unique_lock<std::mutex> lk(m);

cv.wait(lk, [this](){ return stop_requested || (!current_task && !next_task); });

}

void RowLoader::run ()

{

for(;;)

{

std::unique_lock<std::mutex> lk(m);

current_task = nullptr;

cv.notify_all();

cv.wait(lk, [this](){ return stop_requested || next_task; });

if(stop_requested)

return;

current_task = std::move(next_task);

lk.unlock();

process(*current_task);

}

void RowLoader::process (Task & t)

{

QString sLimitQuery;

if(query.startsWith("PRAGMA", Qt::CaseInsensitive) || query.startsWith("EXPLAIN", Qt::CaseInsensitive) ||

// With RETURNING keyword DELETE,INSERT,UPDATE can return rows

// https://www.sqlite.org/lang_returning.html

query.startsWith("DELETE", Qt::CaseInsensitive) || query.startsWith("INSERT", Qt::CaseInsensitive) ||

query.startsWith("UPDATE", Qt::CaseInsensitive))

{

sLimitQuery = query;

} else {

// Remove trailing trailing semicolon

QString queryTemp = rtrimChar(query, ';');

// If the query ends with a LIMIT statement or contains a compound operator take it as it is,

// if not append our own LIMIT part for lazy population. The compound operator test is a very

// weak check and does not detect whether the keyword is in a string or similar. This means

// that lazy population is disabled for more queries than necessary. We should fix this once

// we have a parser for SELECT statements but until then it is better to disable lazy population

// for more statements than required instead of failing to run some statements entirely.

if(queryTemp.contains(QRegularExpression("LIMIT\\s+.+\\s*((,|\\b(OFFSET)\\b)\\s*.+\\s*)?$", QRegularExpression::CaseInsensitiveOption)) ||

queryTemp.contains(QRegularExpression("\\s(UNION)|(INTERSECT)|(EXCEPT)\\s", QRegularExpression::CaseInsensitiveOption)))

sLimitQuery = queryTemp;

else

sLimitQuery = queryTemp + QString(" LIMIT %1 OFFSET %2;").arg(t.row_end-t.row_begin).arg(t.row_begin);

}

statement_logger(sLimitQuery);

QByteArray utf8Query = sLimitQuery.toUtf8();

sqlite3_stmt *stmt;

auto row = t.row_begin;

if(sqlite3_prepare_v2(pDb.get(), utf8Query, utf8Query.size(), &stmt, nullptr) == SQLITE_OK)

{

int step_result = SQLITE_OK;

while(!t.cancel && (step_result = sqlite3_step(stmt)) == SQLITE_ROW)

{

size_t num_columns = static_cast<size_t>(sqlite3_data_count(stmt));

// Construct a new row object with the right number of columns

Cache::value_type rowdata(num_columns);

for(size_t i=0;i<num_columns;++i)

{

// No need to do anything for NULL values because we can just use the already default constructed value

if(sqlite3_column_type(stmt, static_cast<int>(i)) != SQLITE_NULL)

{

int bytes = sqlite3_column_bytes(stmt, static_cast<int>(i));

if(bytes)

rowdata[i] = QByteArray(static_cast<const char*>(sqlite3_column_blob(stmt, static_cast<int>(i))), bytes);

else

rowdata[i] = "";

}

std::lock_guard<std::mutex> lk(cache_mutex);

cache_data.set(row++, std::move(rowdata));

}

if (step_result != SQLITE_ROW && step_result != SQLITE_DONE && step_result != SQLITE_OK && !t.cancel) {

QString errorMsg = QString::fromUtf8(sqlite3_errmsg(pDb.get()));

emit error(t.token, errorMsg);

}

sqlite3_finalize(stmt);

// Query the total row count if and only if:

// - this is the first batch of data we load for this query

// - we got exactly the number of rows back we queried (which indicates there might be more rows)

// If there is no need to query the row count this means the number of rows we just got is the total row count.

if(!first_chunk_loaded)

{

first_chunk_loaded = true;

if(row == t.row_end)

triggerRowCountDetermination(t.token);

else

emit rowCountComplete(t.token, static_cast<int>(row-t.row_begin));

}

emit fetched(t.token, t.row_begin, row);

}