Release v0.8.1

The cached order position introduced in 42e9ac5 is incorrect
as it does not consider the case when we are viewing any
other result page than the first.

Fix this by considering which page we are in when calculating
the offset

CHANGELOG.md

@@ -1,4 +1,21 @@
 # looqs: Release notes
+
+## 2022-11-19 - v0.8.1
+
+CHANGES:
+ - Fix regression causing previews in second (and higher) result page to not render
+ - Minor improvements
+
+## 2022-10-22 - v0.8
+
+CHANGES:
+ - For new, not previously indexed files, start creating an additional index using sqlite's experimental trigram tokenizer. Thanks to that, we can now match substrings >= 3 of an unicode sequence. Results of the usual index are prioritized.
+ - GUI: Ensure order of previews matches ranking exactly. Previously, it depended simply on the time preview generators took, i. e. it was more or less a race.
+ - Report progress more often during indexing, so users don't get the impression that it's stuck when processing dirs with large documents.
+ - Fix a regression that caused phrase queries to be broken
+ - Minor improvements
+ - Add packages: Ubuntu 22.10.
+
 ## 2022-09-10 - v0.7
 
 CHANGES:

README.md

@@ -28,11 +28,12 @@ There is no need to write the long form of filters. There are also booleans avai
 The screenshots in this section may occasionally be slightly outdated, but they are usually recent enough to get an overall impression of the current state of the GUI.
 
 ## Current status
-Latest version: 2022-09-10, v0.7
+Latest version: 2022-11-19, v0.8.1
 
 Please keep in mind: looqs is still at an early stage and may exhibit some weirdness and contain bugs.
 
-Please see [Changelog](CHANGELOG.md) for a human readable list of changes.
+Please see [Changelog](CHANGELOG.md) for a human readable list of changes. For download instructions, see
+further down this document.
 
 
 ## Goals and principles
@@ -96,7 +97,7 @@ The GUI is located in `gui/looqs-gui`, the binary for the CLI is in `cli/looqs`
 ## Packages
 At this point, looqs is not in any official distro package repo, but I maintain some packages.
 
-### Ubuntu 22.04
+### Ubuntu 22.04, 22.10
 Latest release can be installed using apt from the repo.
 ```
 # First, obtain key, assume it's trusted.

gui/mainwindow.cpp

@@ -643,7 +643,6 @@ void MainWindow::previewReceived(QSharedPointer<PreviewResult> preview, unsigned
 	{
 		QString docPath = preview->getDocumentPath();
 		auto previewPage = preview->getPage();
-
 		ClickLabel *headerLabel = new ClickLabel();
 		headerLabel->setText(QString("Path: ") + preview->getDocumentPath());
 
@@ -685,7 +684,24 @@ void MainWindow::previewReceived(QSharedPointer<PreviewResult> preview, unsigned
 
 		previewWidget->setLayout(previewLayout);
 
-		ui->scrollAreaWidgetContents->layout()->addWidget(previewWidget);
+		QBoxLayout *layout = static_cast<QBoxLayout *>(ui->scrollAreaWidgetContents->layout());
+		int pos = previewOrder[docPath + QString::number(previewPage)];
+		if(pos <= layout->count())
+		{
+			layout->insertWidget(pos, previewWidget);
+			for(auto it = previewWidgetOrderCache.constKeyValueBegin();
+				it != previewWidgetOrderCache.constKeyValueEnd(); it++)
+			{
+				if(it->first <= layout->count())
+				{
+					layout->insertWidget(it->first, it->second);
+				}
+			}
+		}
+		else
+		{
+			previewWidgetOrderCache[pos] = previewWidget;
+		}
 	}
 }
 
@@ -924,12 +940,12 @@ void MainWindow::makePreviews(int page)
 			}
 		}
 	}
-	int end = previewsPerPage;
-	int begin = page * previewsPerPage - previewsPerPage;
-	if(begin < 0)
+	int length = previewsPerPage;
+	int beginOffset = page * previewsPerPage - previewsPerPage;
+	if(beginOffset < 0)
 	{
 		// Should not happen actually
-		begin = 0;
+		beginOffset = 0;
 	}
 
 	int currentScale = currentSelectedScale();
@@ -938,6 +954,10 @@ void MainWindow::makePreviews(int page)
 	renderConfig.scaleY = QGuiApplication::primaryScreen()->physicalDotsPerInchY() * (currentScale / 100.);
 	renderConfig.wordsToHighlight = wordsToHighlight;
 
+	this->previewOrder.clear();
+	this->previewWidgetOrderCache.clear();
+
+	int previewPos = 0;
 	QVector<RenderTarget> targets;
 	for(SearchResult &sr : this->previewableSearchResults)
 	{
@@ -952,10 +972,14 @@ void MainWindow::makePreviews(int page)
 		renderTarget.path = sr.fileData.absPath;
 		renderTarget.page = (int)sr.page;
 		targets.append(renderTarget);
+
+		int pos = previewPos - beginOffset;
+		this->previewOrder[renderTarget.path + QString::number(renderTarget.page)] = pos;
+		++previewPos;
 	}
 	int numpages = ceil(static_cast<double>(targets.size()) / previewsPerPage);
 	ui->spinPreviewPage->setMaximum(numpages);
-	targets = targets.mid(begin, end);
+	targets = targets.mid(beginOffset, length);
 
 	ui->lblTotalPreviewPagesCount->setText(QString::number(numpages));
 	ui->previewProcessBar->setMaximum(targets.count());

gui/mainwindow.h

@@ -23,16 +23,6 @@ class MainWindow : public QMainWindow
 {
 	Q_OBJECT
 
-  public:
-	explicit MainWindow(QWidget *parent, QString socketPath);
-	~MainWindow();
-  signals:
-	void beginSearch(const QString &query);
-	void startPdfPreviewGeneration(QVector<SearchResult> paths, double scalefactor);
-
-  protected:
-	void closeEvent(QCloseEvent *event) override;
-
   private:
 	DatabaseFactory *dbFactory;
 	SqliteDbService *dbService;
@@ -40,37 +30,40 @@ class MainWindow : public QMainWindow
 	IPCPreviewClient ipcPreviewClient;
 	QThread ipcClientThread;
 	QThread syncerThread;
+	Indexer *indexer;
 	IndexSyncer *indexSyncer;
 	QProgressDialog progressDialog;
-
-	Indexer *indexer;
 	QFileIconProvider iconProvider;
-	bool previewDirty;
 	QSqlDatabase db;
 	QFutureWatcher<QVector<SearchResult>> searchWatcher;
-	void add(QString path, unsigned int page);
 	QVector<SearchResult> previewableSearchResults;
+	LooqsQuery contentSearchQuery;
+	QVector<QString> searchHistory;
+	int currentSearchHistoryIndex = 0;
+	QString currentSavedSearchText;
+	QHash<QString, int> previewOrder; /* Quick lookup for the order a preview should have */
+	QMap<int, QWidget *>
+		previewWidgetOrderCache /* Saves those that arrived out of order to be inserted later at the correct pos */;
+	bool previewDirty = false;
+	int previewsPerPage = 20;
+	unsigned int processedPdfPreviews = 0;
+	unsigned int currentPreviewGeneration = 1;
+
 	void connectSignals();
 	void makePreviews(int page);
 	bool previewTabActive();
 	bool indexerTabActive();
 	void keyPressEvent(QKeyEvent *event) override;
-	unsigned int processedPdfPreviews;
 	void handleSearchResults(const QVector<SearchResult> &results);
 	void handleSearchError(QString error);
-	LooqsQuery contentSearchQuery;
-	int previewsPerPage;
 	void createSearchResutlMenu(QMenu &menu, const QFileInfo &fileInfo);
 	void openDocument(QString path, int num);
 	void openFile(QString path);
-	unsigned int currentPreviewGeneration = 1;
 	void initSettingsTabs();
 	int currentSelectedScale();
 	void processShortcut(int key);
 	bool eventFilter(QObject *object, QEvent *event);
-	QVector<QString> searchHistory;
-	int currentSearchHistoryIndex = 0;
-	QString currentSavedSearchText;
+
   private slots:
 	void lineEditReturnPressed();
 	void treeSearchItemActivated(QTreeWidgetItem *item, int i);
@@ -90,6 +83,16 @@ class MainWindow : public QMainWindow
 	void startIpcPreviews(RenderConfig config, const QVector<RenderTarget> &targets);
 	void stopIpcPreviews();
 	void beginIndexSync();
+
+  public:
+	explicit MainWindow(QWidget *parent, QString socketPath);
+	~MainWindow();
+  signals:
+	void beginSearch(const QString &query);
+	void startPdfPreviewGeneration(QVector<SearchResult> paths, double scalefactor);
+
+  protected:
+	void closeEvent(QCloseEvent *event) override;
 };
 
 #endif // MAINWINDOW_H

gui/previewgenerator.cpp

@@ -1,20 +1,24 @@
 #include "../shared/common.h"
 #include "previewgenerator.h"
+#include <QMutexLocker>
 #include "previewgeneratorpdf.h"
 #include "previewgeneratorplaintext.h"
 #include "previewgeneratorodt.h"
 
 static PreviewGenerator *plainTextGenerator = new PreviewGeneratorPlainText();
 
-static QMap<QString, PreviewGenerator *> generators{
+static QHash<QString, PreviewGenerator *> generators{
 	{"pdf", new PreviewGeneratorPdf()}, {"txt", plainTextGenerator},  {"md", plainTextGenerator},
 	{"py", plainTextGenerator},			{"java", plainTextGenerator}, {"js", plainTextGenerator},
 	{"cpp", plainTextGenerator},		{"c", plainTextGenerator},	  {"sql", plainTextGenerator},
 	{"odt", new PreviewGeneratorOdt()}};
 
+static QMutex generatorsMutex;
 PreviewGenerator *PreviewGenerator::get(QFileInfo &info)
 {
+	QMutexLocker locker(&generatorsMutex);
 	PreviewGenerator *result = generators.value(info.suffix(), nullptr);
+	locker.unlock();
 	if(result == nullptr)
 	{
 		if(Common::isTextFile(info))

gui/previewgeneratorpdf.cpp

@@ -7,10 +7,12 @@ static QMutex cacheMutex;
 
 Poppler::Document *PreviewGeneratorPdf::document(QString path)
 {
+	QMutexLocker locker(&cacheMutex);
 	if(documentcache.contains(path))
 	{
 		return documentcache.value(path);
 	}
+	locker.unlock();
 	Poppler::Document *result = Poppler::Document::load(path);
 	if(result == nullptr)
 	{
@@ -19,7 +21,7 @@ Poppler::Document *PreviewGeneratorPdf::document(QString path)
 	}
 	result->setRenderHint(Poppler::Document::TextAntialiasing);
 
-	QMutexLocker locker(&cacheMutex);
+	locker.relock();
 	documentcache.insert(path, result);
 	locker.unlock();
 	return result;

gui/previewgeneratorplaintext.cpp

@@ -103,7 +103,7 @@ QString PreviewGeneratorPlainText::generateLineBasedPreviewText(QTextStream &in,
 		int foundWordsCount = 0;
 		for(QString &word : config.wordsToHighlight)
 		{
-			QRegularExpression searchRegex("\\b" + word + "\\b");
+			QRegularExpression searchRegex("\\b" + QRegularExpression::escape(word) + "\\b");
 			bool containsRegex = line.contains(searchRegex);
 			bool contains = false;
 			if(!containsRegex)

gui/previewresultpdf.cpp

@@ -30,7 +30,7 @@ QByteArray PreviewResultPdf::serialize() const
 
 QSharedPointer<PreviewResultPdf> PreviewResultPdf::deserialize(QByteArray &ba)
 {
-	PreviewResultPdf *result = new PreviewResultPdf();
+	QSharedPointer<PreviewResultPdf> result(new PreviewResultPdf());
 	PreviewResultType type;
 
 	QDataStream stream{&ba, QIODevice::ReadOnly};
@@ -40,5 +40,5 @@ QSharedPointer<PreviewResultPdf> PreviewResultPdf::deserialize(QByteArray &ba)
 		throw std::runtime_error("Invalid byte array: Not a pdf preview");
 	}
 	stream >> result->documentPath >> result->page >> result->previewImage;
-	return QSharedPointer<PreviewResultPdf>(result);
+	return result;
 }

gui/previewresultplaintext.cpp

@@ -40,7 +40,8 @@ QByteArray PreviewResultPlainText::serialize() const
 
 QSharedPointer<PreviewResultPlainText> PreviewResultPlainText::deserialize(QByteArray &ba)
 {
-	PreviewResultPlainText *result = new PreviewResultPlainText();
+	QSharedPointer<PreviewResultPlainText> result(new PreviewResultPlainText());
+
 	PreviewResultType type;
 
 	QDataStream stream{&ba, QIODevice::ReadOnly};
@@ -50,5 +51,5 @@ QSharedPointer<PreviewResultPlainText> PreviewResultPlainText::deserialize(QByte
 		throw std::runtime_error("Invalid byte array: Not a pdf preview");
 	}
 	stream >> result->documentPath >> result->page >> result->text;
-	return QSharedPointer<PreviewResultPlainText>(result);
+	return result;
 }

shared/sqlitesearch.cpp

@@ -157,7 +157,6 @@ QSqlQuery SqliteSearch::makeSqlQuery(const LooqsQuery &query)
 		throw LooqsGeneralException("Nothing to search for supplied");
 	}
 
-	bool ftsAlreadyJoined = false;
 	auto tokens = query.getTokens();
 	for(const Token &token : tokens)
 	{