Порівняти коміти

..

25 Коміти

Автор SHA1 Повідомлення Дата
052f169ef2 Release v0.5 2022-07-29 10:17:04 +02:00
ffdb326045 USAGE.md: Update 2022-07-29 10:17:04 +02:00
7c5c91ef10 gui: search: Avoid double results + minor improvements
Avoid double results in search by distinguishing whether
a filter was explicitly given. Previously, we could not
discern this.

Furthermore, if a content search is given, lone words will be
considered path searches. If a path search is given, we consider
lone words implicit content search filters. This simplifies
queries for the user
2022-07-29 10:17:04 +02:00
076c3c4c7f shared: LooqsQuery: Add implicit AND also for lone words 2022-07-29 10:17:04 +02:00
c11fd1a9ff shared: LooqsQuery: Allow constructing from tokens and sort conditions 2022-07-29 10:17:04 +02:00
1849eba190 shared: sqlitesearch: Escape FTS arguments
Most users are not to be expected to be familiar with
sqlite's FTS syntax. It also leads to unnnecessary
arrows in some instances.

So wrap every space separated word in quotes, unless
it's already in quotes. Then we just escape those with
double-quotes.
2022-07-28 17:49:40 +02:00
1188e51c35 cli: Run migrations if necessary 2022-07-28 14:28:45 +02:00
1da8344295 shared: Adjust queries to db revision 2 2022-07-28 14:00:46 +02:00
78f38fa418 shared: migrations: Add 2.sql: Change to contentless FTS
We never used the content copy we stored. It only wasted space.

Update scheme so we do not store the content anymore. Switch
to contentless FTS approach
2022-07-28 14:00:46 +02:00
7fa266e5e8 gui: main: Execute migrations. Show migration progress dialog
We don't do silent upgrades anymore because they might take considerable
time.
2022-07-28 13:43:02 +02:00
c03d7da821 shared: common: Remove migration logic from ensureConfigured()
Running migrations is okay for initialization. However, doing
it here might take ages, so the GUI simply would not show up.

Therefore, migration must be done by the CLI or GUI and they
should show that migrations are running
2022-07-28 13:31:13 +02:00
49b57e1740 shared: DBMigrator: Take DatabaseFactory, run vacuum, add error() sig, start() slot 2022-07-28 13:27:37 +02:00
5996971195 shared: common: setPdfViewer(): Fix misplaced QSettings 2022-07-24 23:57:38 +02:00
bf1265fe3a shared: Retire Common::findInPath() for builtin Qt function 2022-07-24 18:19:38 +02:00
43a0f08579 gui: PreviewGeneratorPlainText: Fix case of empty preview when word found on pos 0 2022-07-24 12:25:38 +02:00
1aa5ae0ccc gui: Introduce PreviewGeneratorOdt for basic previews of .odt files 2022-07-24 11:43:00 +02:00
20d42a66a6 gui: Begin PreviewResultOdt 2022-07-24 11:41:25 +02:00
cba4df3eac gui: previews: Add label with file path below every preview 2022-07-24 11:40:38 +02:00
fdbf3a7358 gui: PreviewGeneratorPlainText: Move snippet gen to own function for reuse 2022-07-24 11:34:52 +02:00
ac4d7dd0a5 gui: mainwindow: Obey scale settings for plaintext previews too 2022-07-23 20:21:45 +02:00
ab064c3e3b gui: mainwindow: Add menu action to open web user manual 2022-07-23 20:16:19 +02:00
a33c7f1859 gui: MainWindow: Move all connect() calls from constructor to connectSignals() 2022-07-16 23:35:40 +02:00
4ce14a7284 README.md: Remove Ubuntu 21.10 as it is EOL so we won't care anymore about it 2022-07-15 16:31:12 +02:00
cc9dae37e5 shared: Indexer: Use isErrorSaveFileResult() to check for non-successful results 2022-07-11 17:14:45 +02:00
64a9638d1e shared: SaveFileResult: Introduce isErrorSaveFileResult() 2022-07-11 17:13:58 +02:00
29 змінених файлів з 521 додано та 179 видалено

@ -1,4 +1,30 @@
# looqs: Release notes
## 2022-07-29 - v0.5
This release features multiple fixes and enhancements.
It changes the database to drop an unused content column. Dropping it allows us
to change to a contentless sqlite FTS index which frees up space.
Upgrading might take a few seconds to a few minutes as looqs will recreate the whole index.
How long this will take depends on the size of your database.
The other major highlight is preview support for .odt files (unformatted, like plaintext).
List of changes:
- General: As Ubuntu 21.10 is EOL, no looqs package will be provided for it any longer
- General: Update database scheme to drop unused content column and free up space
- General: Properly escape FTS arguments passed to sqlite to avoid query errors on some terms
- GUI: Fix double searches and results when explicit content search filters are provided
- GUI: Previews: Plaintext previews now obey scale selection too
- GUI: Previews: Begin basic, unformatted previews of .odt files
- GUI: Previews: Add file path below every preview for convenience (hovering unnecessary now).
- GUI: Previews: Fix bug causing an empty preview if a plaintext file started with a searched word
- GUI: Add menu option to open user manual
- GUI: Show progress dialog during database upgrade
- General: Correct error count in some conditions for failed paths
- General: Update user manual
- Minor improvements
## 2022-06-29 - v0.4
This release makes several minor improvements and begins prebuilt binaries of looqs that (should) run

@ -29,7 +29,7 @@ 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-06-29, v0.4
Latest version: 2022-07-29, v0.5
Please see [Changelog](CHANGELOG.md) for a human readable list of changes.
@ -46,7 +46,7 @@ Please see [Changelog](CHANGELOG.md) for a human readable list of changes.
- GUI, CLI interface
- Indexing of file path and some metadata.
- Indexing of file file content for FTS search. Currently: .pdf, odt, docx, plaintext.
- Preview of file formats: Currently: .pdf, plaintext
- Preview of file formats: Currently: .pdf, .odt, plaintext
- Highlight searched terms.
- Quickly open PDF viewer or text editor at location of preview
- Search filters
@ -68,7 +68,7 @@ Please see [USAGE.md](USAGE.md) for the user manual. There is also [HACKING.md](
## Build
### Ubuntu 21.10/22.04
### Debian/Ubuntu
To build on Ubuntu and Debian, clone the repo and then run:
```
@ -95,7 +95,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 21.10/22.04
### Ubuntu 22.04
Latest release can be installed using apt from the repo.
```
# First, obtain key, assume it's trusted.

@ -9,15 +9,11 @@ looqs is still at an early stage and may exhibit some weirdness and contain bugs
## Current Limitations and things to know
You should be aware of the following:
- It may seem natural, but the GUI and CLI operate on the same database, so if you add files using the CLI, the GUI will search them too.
- It may seem natural, but the GUI and CLI operate on the same database, so if you add files using the CLI, the GUI will know about them too.
- If a file is listed in the "Search results" tab, it does not imply that a preview will be available in the "Previews" tab, as looqs can search more file formats than it can generate previews for currently.
- Database paths are stored inefficiently, not deduplicated to simplify queries. This may add up quickly. Also, each PDF text is stored twice. Each page separately + the whole document to simplify queries.
To give you some idea: At the time this section was written, 167874 files were in my index. A FTS index was built for 14280 of those, of which 4146 were PDF documents. The PDFs take around 10GB storage space on the filesystem. All files for which an FTS has been built are around 7GB in size on the filesystem. The looqs database had a size of 1.6 GB.
- Existing files are considered modified when the mtime has changed. looqs currently does not check whether the content
has changed.
- Existing files are considered modified when the modification time has changed. looqs currently does not check whether the content has changed.
## Config
The config file is in `$HOME/.config/quitesimple.org/looqs.conf`. It will be created on first execution of the CLI or GUI interface. Generally, you should not edit this file directly. Instead, use the "Settings" tab in the GUI.
@ -34,21 +30,21 @@ For large directories the progress bar is essentially just decoration. As long a
increase, everything is fine even if it seems the progress bar is stuck.
The indexing can be stopped. If you run it again you do not start from scratch, because looqs knows
which files have been modified or not since they have been added to the index. Thus, files will
only be reprocedded when necessary. Note that cancellation itself may take a moment as files finish processing.
which files have been modified since they have been added to the index. Thus, files will
only be reprocessed when necessary. Note that cancellation itself may take a moment as files finish processing.
### Search
The text field at the top is where you type your query. It can be selected quickly using **CTRL + L**. Filters are avalable,
see this document at the end. By default, both the full path and the content are searched. Path names take precedence.
The text field at the top is where you type your query. It can be selected quickly using **CTRL + L**. Filters are available, see this document at the end. By default, both the full path and the content are searched. Path names take precedence, i. e. they will appear the top of the list.
### Configuring PDF viewer
It's most convenient if, when you click on a preview, the PDF reader opens the page you clicked. For that, looqs needs to know which viewer you want to launch.
It tries to auto detect some common viewers. You must set the value in the "Settings" tab yourself if it doesn't do something you like, such as not opening your favorite viewer. In the command line options, "%f" represents the filepath, "%p" the page number.
It tries to auto detect some common viewers. You must set the value in the "Settings" tab yourself if the
default does not work for you. In the command line options, "%f" represents the filepath, "%p" the page number.
### Preview tab
The preview tab shows previews. It marks your search keywords too. Click on a preview to open the file.
A right click on a preview allows you to copy the file path, or to open the containing folder. Hovering tells you which file the preview originates from.
A right click on a preview allows you to copy the file path, or to open the containing folder.
### Syncing index
Over time, files get deleted or their content changes. Go to **looqs** -> **Sync index**. looqs will reindex the content of files which have been changed. Files that cannot be found anymore will be removed from the index.
@ -81,12 +77,11 @@ There is an implicit "AND" condition, meaning if you search for "photo" and "mou
will be shown containing both terms, but not either alone.
### Deletion and Fixing Out of sync index
You sometimes delete files, to get rid of those from the index too, run:
To get rid of deleted files from the index, run:
```
looqs delete --deleted --dry-run
```
This commands lists all files which are indexed, but which cannot be found anymore.
Remove them using:
@ -122,13 +117,13 @@ looqs update
```
This will not add new files, you must run ```looqs add``` for this. For this reason, most users
will probably seldomly use the 'update' command alone.
will probably seldom use the 'update' command alone.
## Tips
### Keeping index up to date
The most obvious way is to use the GUI and add your favorite paths in the "Index" tab. Then occasionally, just rescan. This works for me personally, looqs quickly picks up new files. This however may not be good enough for some users.
The most obvious way is to use the GUI to add your favorite paths in the "Index" tab. Then occasionally, just rescan. This works for me personally, looqs quickly picks up new files. This however may not be good enough for some users.
Some users may prefer setting up cronjobs or wire up the CLI interface with file system monitoring tools such as [adhocify](https://github.com/quitesimpleorg/adhocify).
@ -140,20 +135,20 @@ are indexed by looqs, you may find the lh (look here) alias useful:
alias lh='looqs search $(pwd)'
```
So typing "lh recipes" searchs the current dir and its subdirs for a file containing 'recipes'.
So typing "lh recipes" searches the current dir and its subdirs for a file containing 'recipes'. Alternatively, a "lh c:(rice)" may be a quick grep alternative.
## Query syntax / Search filters
A number of search filters are available.
| Filter (long) | Filter (short) | Explanation |
| ----------- | ----------- |----------- |
| path.contains:(term) | p:(term) | Pretty much a SQL LIKE '%term%' conditions, just searches the path string |
| path.contains:(term) | p:(term) | Pretty much a SQL LIKE '%term%' condition, just searches the path string |
| path.ends:(term) | pe:(term) | Filters path ending with the specified term, e. g.: pe:(.ogg) |
| path.begins:(term) | pb:(term) | Filters path beginning with the specified term |
| contains:(terms) | c:(terms) | ull-text search, also understands quotes |
Filters can be combined. The booleans AND and OR are supported. Negations can be applied too, except for c:().
The AND boolean is implicit and thus entering it strictly optional.
| contains:(terms) | c:(terms) | Full-text search, also understands quotes |
| limit:(integer) | - | Limits the number of results. The default is 1000. Say "limit:0" to see all results |
Filters can be combined. The booleans AND and OR are supported. Negations can be applied too, except for c:(). Negations are specified with "!".
The AND boolean is implicit and thus entering it strictly optional.
Examples:
@ -162,8 +157,10 @@ Examples:
|pe:(.ogg) p:(marley)| Finds paths that end with .ogg and contain 'marley' (case-insensitive)
|p:(slides) support vector machine           |Performs a content search for 'support vector machine' in all paths containing 'slides'|
|p:(notes) (pe:(odt) OR pe:(docx))          |Finds files such as notes.docx, notes.odt but also any .docs and .odt when the path contains the string 'notes'|
|memcpy !(pe:(.c) OR pe:(.cpp))| Performs a FTS search for 'memcpy' but excludes .cpp and .c files.
|c:("I think, therefore")|Performs a FTS search for the phrase "I think, therefore".
|memcpy !(pe:(.c) OR pe:(.cpp))| Performs a FTS search for 'memcpy' but excludes .cpp and .c files.|
|c:("I think, therefore")|Performs a FTS search for the phrase "I think, therefore".|
|c:("invoice") Downloads|This query is equivalent to c:("invoice") p:("Downloads")|

@ -26,6 +26,7 @@
#include "sandboxedprocessor.h"
#include "../shared/common.h"
#include "../shared/filescanworker.h"
#include "../shared/dbmigrator.h"
void printUsage(QString argv0)
{
@ -75,6 +76,27 @@ int main(int argc, char *argv[])
try
{
Common::ensureConfigured();
DatabaseFactory factory{Common::databasePath()};
DBMigrator migrator{factory};
if(migrator.migrationNeeded())
{
Logger::info() << "Database is being upgraded, please be patient..." << Qt::endl;
QObject::connect(&migrator, &DBMigrator::migrationDone,
[&](uint32_t migration)
{ Logger::info() << "Progress: Successfully migrated to: " << migration << Qt::endl; });
QObject::connect(&migrator, &DBMigrator::done,
[]() { Logger::info() << "Database upgrade successful" << Qt::endl; });
QObject::connect(&migrator, &DBMigrator::error,
[&](QString error)
{
Logger::error() << error << Qt::endl;
qApp->quit();
});
migrator.performMigrations();
}
}
catch(LooqsGeneralException &e)
{

@ -36,9 +36,11 @@ SOURCES += \
clicklabel.cpp \
previewgenerator.cpp \
previewgeneratormapfunctor.cpp \
previewgeneratorodt.cpp \
previewgeneratorpdf.cpp \
previewgeneratorplaintext.cpp \
previewresult.cpp \
previewresultodt.cpp \
previewresultpdf.cpp \
previewresultplaintext.cpp \
renderconfig.cpp \
@ -54,9 +56,11 @@ HEADERS += \
clicklabel.h \
previewgenerator.h \
previewgeneratormapfunctor.h \
previewgeneratorodt.h \
previewgeneratorpdf.h \
previewgeneratorplaintext.h \
previewresult.h \
previewresultodt.h \
previewresultpdf.h \
previewresultplaintext.h \
renderconfig.h \
@ -66,6 +70,7 @@ FORMS += \
mainwindow.ui
INCLUDEPATH += /usr/include/poppler/qt5/
INCLUDEPATH += /usr/include/quazip5
QT += widgets sql

@ -12,6 +12,8 @@
#include "previewresultpdf.h"
#include "../shared/common.h"
#include "../shared/sandboxedprocessor.h"
#include "../shared/dbmigrator.h"
#include "../shared/logger.h"
#include "../submodules/exile.h/exile.h"
#include "ipcserver.h"
@ -153,6 +155,63 @@ int main(int argc, char *argv[])
try
{
Common::ensureConfigured();
DatabaseFactory factory{Common::databasePath()};
DBMigrator migrator{factory};
if(migrator.migrationNeeded())
{
auto answer = QMessageBox::question(nullptr, "Proceed with upgrade?",
"A database upgrade is required. This might take a few minutes. Say "
"'yes' to start upgrade, 'no' to exit.");
if(answer == QMessageBox::No)
{
a.quit();
return 0;
}
QFile out;
out.open(stderr, QIODevice::WriteOnly);
Logger migrationLogger{&out};
migrationLogger << "Database is being upgraded, please be patient..." << Qt::endl;
QThread migratorThread;
migrator.moveToThread(&migratorThread);
migratorThread.start();
QProgressDialog progressDialog;
QObject::connect(&migrator, &DBMigrator::migrationDone,
[&migrationLogger](uint32_t migration)
{ migrationLogger << "Progress: Successfully migrated to: " << migration << Qt::endl; });
QObject::connect(&migrator, &DBMigrator::done, &progressDialog, &QProgressDialog::reset);
QObject::connect(&migrator, &DBMigrator::error,
[&](QString error)
{
QMetaObject::invokeMethod(qApp,
[error]
{
Logger::error() << error << Qt::endl;
QMessageBox::critical(nullptr, "Error during upgrade",
error);
qApp->quit();
}
);
});
QTimer::singleShot(0, &migrator, &DBMigrator::start);
progressDialog.setWindowTitle("Upgrading database");
progressDialog.setLabelText("Upgrading database - this might take several minutes, please wait");
progressDialog.setWindowModality(Qt::ApplicationModal);
progressDialog.setMinimum(0);
progressDialog.setMaximum(0);
progressDialog.setValue(0);
progressDialog.setCancelButton(nullptr);
progressDialog.exec();
migrationLogger << "Database has been successfully upgraded" << Qt::endl;
migratorThread.quit();
}
}
catch(LooqsGeneralException &e)
{

@ -33,28 +33,6 @@ MainWindow::MainWindow(QWidget *parent, QString socketPath)
setWindowTitle(QCoreApplication::applicationName());
this->ipcPreviewClient.moveToThread(&this->ipcClientThread);
this->ipcPreviewClient.setSocketPath(socketPath);
connect(&ipcPreviewClient, &IPCPreviewClient::previewReceived, this, &MainWindow::previewReceived,
Qt::QueuedConnection);
connect(&ipcPreviewClient, &IPCPreviewClient::finished, this,
[&]
{
this->ui->previewProcessBar->setValue(this->ui->previewProcessBar->maximum());
this->ui->spinPreviewPage->setEnabled(true);
this->ui->comboPreviewFiles->setEnabled(true);
});
connect(&ipcPreviewClient, &IPCPreviewClient::error, this,
[this](QString msg)
{
qCritical() << msg << Qt::endl;
QMessageBox::critical(this, "IPC error", msg);
});
connect(this, &MainWindow::startIpcPreviews, &ipcPreviewClient, &IPCPreviewClient::startGeneration,
Qt::QueuedConnection);
connect(this, &MainWindow::stopIpcPreviews, &ipcPreviewClient, &IPCPreviewClient::stopGeneration,
Qt::QueuedConnection);
this->ipcClientThread.start();
QSettings settings;
this->dbFactory = new DatabaseFactory(Common::databasePath());
@ -91,6 +69,8 @@ MainWindow::MainWindow(QWidget *parent, QString socketPath)
auto policy = ui->btnOpenFailed->sizePolicy();
policy.setRetainSizeWhenHidden(true);
ui->btnOpenFailed->setSizePolicy(policy);
this->ipcClientThread.start();
}
void MainWindow::addPathToIndex()
@ -191,6 +171,9 @@ void MainWindow::connectSignals()
connect(ui->menuAboutQtAction, &QAction::triggered, this,
[this](bool checked) { QMessageBox::aboutQt(this, "About Qt"); });
connect(ui->menuSyncIndexAction, &QAction::triggered, this, &MainWindow::startIndexSync);
connect(ui->menuOpenUserManualAction, &QAction::triggered, this,
[this]() { QDesktopServices::openUrl(Common::userManualUrl()); });
connect(indexSyncer, &IndexSyncer::finished, this,
[&](unsigned int totalUpdated, unsigned int totalDeleted, unsigned int totalErrored)
{
@ -210,6 +193,26 @@ void MainWindow::connectSignals()
connect(
ui->comboPreviewFiles, qOverload<int>(&QComboBox::currentIndexChanged), this, [&]() { makePreviews(1); },
Qt::QueuedConnection);
connect(&ipcPreviewClient, &IPCPreviewClient::previewReceived, this, &MainWindow::previewReceived,
Qt::QueuedConnection);
connect(&ipcPreviewClient, &IPCPreviewClient::finished, this,
[&]
{
this->ui->previewProcessBar->setValue(this->ui->previewProcessBar->maximum());
this->ui->spinPreviewPage->setEnabled(true);
this->ui->comboPreviewFiles->setEnabled(true);
});
connect(&ipcPreviewClient, &IPCPreviewClient::error, this,
[this](QString msg)
{
qCritical() << msg << Qt::endl;
QMessageBox::critical(this, "IPC error", msg);
});
connect(this, &MainWindow::startIpcPreviews, &ipcPreviewClient, &IPCPreviewClient::startGeneration,
Qt::QueuedConnection);
connect(this, &MainWindow::stopIpcPreviews, &ipcPreviewClient, &IPCPreviewClient::stopGeneration,
Qt::QueuedConnection);
}
void MainWindow::exportFailedPaths()
@ -436,19 +439,46 @@ 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());
ClickLabel *label = dynamic_cast<ClickLabel *>(preview->createPreviewWidget());
ui->scrollAreaWidgetContents->layout()->addWidget(label);
connect(label, &ClickLabel::leftClick, [this, docPath, previewPage]() { openDocument(docPath, previewPage); });
connect(label, &ClickLabel::rightClick,
[this, docPath, previewPage]()
{
QFileInfo fileInfo{docPath};
QMenu menu("labeRightClick", this);
createSearchResutlMenu(menu, fileInfo);
menu.addAction("Copy page number", [previewPage]
{ QGuiApplication::clipboard()->setText(QString::number(previewPage)); });
menu.exec(QCursor::pos());
});
QVBoxLayout *previewLayout = new QVBoxLayout();
QFont font = label->font();
font.setPointSize(QApplication::font().pointSize() * currentSelectedScale() / 100);
label->setFont(font);
headerLabel->setFont(font);
auto leftClickHandler = [this, docPath, previewPage]() { openDocument(docPath, previewPage); };
auto rightClickhandler = [this, docPath, previewPage]()
{
QFileInfo fileInfo{docPath};
QMenu menu("labeRightClick", this);
createSearchResutlMenu(menu, fileInfo);
menu.addAction("Copy page number",
[previewPage] { QGuiApplication::clipboard()->setText(QString::number(previewPage)); });
menu.exec(QCursor::pos());
};
connect(label, &ClickLabel::leftClick, leftClickHandler);
connect(label, &ClickLabel::rightClick, rightClickhandler);
connect(headerLabel, &ClickLabel::rightClick, rightClickhandler);
previewLayout->addWidget(label);
previewLayout->addWidget(headerLabel);
previewLayout->setMargin(0);
previewLayout->insertStretch(0, 1);
previewLayout->insertStretch(-1, 1);
QWidget *previewWidget = new QWidget();
previewWidget->setLayout(previewLayout);
ui->scrollAreaWidgetContents->layout()->addWidget(previewWidget);
}
}
@ -473,21 +503,74 @@ void MainWindow::lineEditReturnPressed()
{
SqliteSearch searcher(db);
QVector<SearchResult> results;
this->contentSearchQuery = LooqsQuery::build(q, TokenType::FILTER_CONTENT_CONTAINS, true);
LooqsQuery tmpQuery = LooqsQuery::build(q, TokenType::WORD, true);
/* We can have a path search in contentsearch too (if given explicitly), so no need to do it twice.
Make sure path results are listed first. */
bool addContentSearch = this->contentSearchQuery.hasContentSearch();
bool addPathSearch = !this->contentSearchQuery.hasPathSearch() || !addContentSearch;
LooqsQuery pathsQuery = tmpQuery;
this->contentSearchQuery = tmpQuery;
this->contentSearchQuery.setTokens({});
bool addContentSearch = false;
bool addPathSearch = false;
auto createFinalTokens = [&tmpQuery](TokenType replacementToken)
{
QVector<Token> tokens = tmpQuery.getTokens();
for(Token &token : tokens)
{
if(token.type == TokenType::WORD)
{
token.type = replacementToken;
}
}
return tokens;
};
/* An explicit search, we just pass it on */
if(!(tmpQuery.getTokensMask() & TokenType::WORD))
{
if(tmpQuery.hasContentSearch())
{
this->contentSearchQuery.setTokens(createFinalTokens(TokenType::FILTER_CONTENT_CONTAINS));
addContentSearch = true;
}
else
{
this->contentSearchQuery.setTokens(createFinalTokens(TokenType::FILTER_PATH_CONTAINS));
addPathSearch = true;
}
}
/* A path search, and lone words, e. g. p:("docs") invoice */
else if(tmpQuery.hasPathSearch() && (tmpQuery.getTokensMask() & TokenType::WORD))
{
this->contentSearchQuery = tmpQuery;
this->contentSearchQuery.setTokens(createFinalTokens(TokenType::FILTER_CONTENT_CONTAINS));
addContentSearch = true;
addPathSearch = false;
}
/* A content search and lone words, e. g. c:("to be or not") ebooks */
else if(tmpQuery.hasContentSearch() && (tmpQuery.getTokensMask() & TokenType::WORD))
{
this->contentSearchQuery = tmpQuery;
this->contentSearchQuery.setTokens(createFinalTokens(TokenType::FILTER_PATH_CONTAINS));
addContentSearch = true;
addPathSearch = false;
}
/* "Simply lone words, so search both" */
else if(!tmpQuery.hasPathSearch() && !tmpQuery.hasContentSearch())
{
this->contentSearchQuery.setTokens(createFinalTokens(TokenType::FILTER_CONTENT_CONTAINS));
pathsQuery.setTokens(createFinalTokens(TokenType::FILTER_PATH_CONTAINS));
addContentSearch = true;
addPathSearch = true;
}
if(addPathSearch)
{
LooqsQuery filesQuery = LooqsQuery::build(q, TokenType::FILTER_PATH_CONTAINS, false);
if(filesQuery.getLimit() == -1)
if(pathsQuery.getLimit() == -1)
{
filesQuery.setLimit(1000);
pathsQuery.setLimit(1000);
}
results.append(searcher.search(filesQuery));
results.append(searcher.search(pathsQuery));
}
if(addContentSearch)
{
@ -495,7 +578,6 @@ void MainWindow::lineEditReturnPressed()
{
this->contentSearchQuery.setLimit(1000);
}
results.append(searcher.search(this->contentSearchQuery));
}
return results;
@ -567,6 +649,13 @@ void MainWindow::handleSearchResults(const QVector<SearchResult> &results)
ui->lblSearchResults->setText(statusText);
}
int MainWindow::currentSelectedScale()
{
QString scaleText = ui->comboScale->currentText();
scaleText.chop(1);
return scaleText.toInt();
}
void MainWindow::makePreviews(int page)
{
if(this->previewableSearchResults.empty())
@ -578,8 +667,6 @@ void MainWindow::makePreviews(int page)
ui->scrollAreaWidgetContents->setLayout(new QHBoxLayout());
ui->previewProcessBar->setMaximum(this->previewableSearchResults.size());
processedPdfPreviews = 0;
QString scaleText = ui->comboScale->currentText();
scaleText.chop(1);
QVector<QString> wordsToHighlight;
QRegularExpression extractor(R"#("([^"]*)"|((\p{L}|\p{N})+))#");
@ -608,9 +695,10 @@ void MainWindow::makePreviews(int page)
begin = 0;
}
int currentScale = currentSelectedScale();
RenderConfig renderConfig;
renderConfig.scaleX = QGuiApplication::primaryScreen()->physicalDotsPerInchX() * (scaleText.toInt() / 100.);
renderConfig.scaleY = QGuiApplication::primaryScreen()->physicalDotsPerInchY() * (scaleText.toInt() / 100.);
renderConfig.scaleX = QGuiApplication::primaryScreen()->physicalDotsPerInchX() * (currentScale / 100.);
renderConfig.scaleY = QGuiApplication::primaryScreen()->physicalDotsPerInchY() * (currentScale / 100.);
renderConfig.wordsToHighlight = wordsToHighlight;
QVector<RenderTarget> targets;

@ -62,6 +62,7 @@ class MainWindow : public QMainWindow
void openFile(QString path);
unsigned int currentPreviewGeneration = 1;
void initSettingsTabs();
int currentSelectedScale();
private slots:
void lineEditReturnPressed();
void treeSearchItemActivated(QTreeWidgetItem *item, int i);

@ -626,6 +626,7 @@
<string>looqs</string>
</property>
<addaction name="menuSyncIndexAction"/>
<addaction name="menuOpenUserManualAction"/>
<addaction name="menuAboutAction"/>
<addaction name="menuAboutQtAction"/>
<addaction name="separator"/>
@ -647,6 +648,11 @@
<string>Sync index (remove deleted, update existing files)</string>
</property>
</action>
<action name="menuOpenUserManualAction">
<property name="text">
<string>Open user manual</string>
</property>
</action>
</widget>
<layoutdefault spacing="6" margin="11"/>
<resources/>

@ -2,13 +2,15 @@
#include "previewgenerator.h"
#include "previewgeneratorpdf.h"
#include "previewgeneratorplaintext.h"
#include "previewgeneratorodt.h"
static PreviewGenerator *plainTextGenerator = new PreviewGeneratorPlainText();
static QMap<QString, PreviewGenerator *> generators{
{"pdf", new PreviewGeneratorPdf()}, {"txt", plainTextGenerator}, {"md", plainTextGenerator},
{"py", plainTextGenerator}, {"java", plainTextGenerator}, {"js", plainTextGenerator},
{"cpp", plainTextGenerator}, {"c", plainTextGenerator}, {"sql", plainTextGenerator}};
{"cpp", plainTextGenerator}, {"c", plainTextGenerator}, {"sql", plainTextGenerator},
{"odt", new PreviewGeneratorOdt()}};
PreviewGenerator *PreviewGenerator::get(QFileInfo &info)
{

@ -0,0 +1,32 @@
#include <quazip.h>
#include <quazipfile.h>
#include "previewgeneratorplaintext.h"
#include "previewgeneratorodt.h"
#include "previewresultodt.h"
#include "../shared/tagstripperprocessor.h"
QSharedPointer<PreviewResult> PreviewGeneratorOdt::generate(RenderConfig config, QString documentPath,
unsigned int page)
{
PreviewResultOdt *result = new PreviewResultOdt(documentPath, page);
QFileInfo info{documentPath};
QuaZipFile zipFile(documentPath);
zipFile.setFileName("content.xml");
if(!zipFile.open(QIODevice::ReadOnly))
{
return QSharedPointer<PreviewResult>(result);
}
QByteArray entireContent = zipFile.readAll();
if(entireContent.isEmpty())
{
throw LooqsGeneralException("Error while reading content.xml of " + documentPath);
}
TagStripperProcessor tsp;
QString content = tsp.process(entireContent).first().content;
PreviewGeneratorPlainText plainTextGenerator;
result->setText(plainTextGenerator.generatePreviewText(content, config, info.fileName()));
return QSharedPointer<PreviewResult>(result);
}

12
gui/previewgeneratorodt.h Normal file

@ -0,0 +1,12 @@
#ifndef PREVIEWGENERATORODT_H
#define PREVIEWGENERATORODT_H
#include "previewgenerator.h"
class PreviewGeneratorOdt : public PreviewGenerator
{
public:
using PreviewGenerator::PreviewGenerator;
QSharedPointer<PreviewResult> generate(RenderConfig config, QString documentPath, unsigned int page);
};
#endif // PREVIEWGENERATORODT_H

@ -3,24 +3,15 @@
#include "previewgeneratorplaintext.h"
#include "previewresultplaintext.h"
QSharedPointer<PreviewResult> PreviewGeneratorPlainText::generate(RenderConfig config, QString documentPath,
unsigned int page)
QString PreviewGeneratorPlainText::generatePreviewText(QString content, RenderConfig config, QString fileName)
{
PreviewResultPlainText *result = new PreviewResultPlainText(documentPath, page);
QFile file(documentPath);
if(!file.open(QFile::ReadOnly | QFile::Text))
{
return QSharedPointer<PreviewResultPlainText>(result);
}
QTextStream in(&file);
QString resulText = "";
QString content = in.readAll();
QMap<int, QString> snippet;
int coveredRange = 0;
int coveredRange = -1;
int lastWordPos = -1;
int lastWordPos = 0;
QHash<QString, int> countmap;
const unsigned int maxSnippets = 7;
@ -71,9 +62,7 @@ QSharedPointer<PreviewResult> PreviewGeneratorPlainText::generate(RenderConfig c
resulText.replace(word, "<span style=\"background-color: yellow;\">" + word + "</span>", Qt::CaseInsensitive);
}
QFileInfo info{documentPath};
QString header = "<b>" + info.fileName() + "</b> ";
QString header = "<b>" + fileName + "</b> ";
for(QString &word : config.wordsToHighlight)
{
header += word + ": " + QString::number(countmap[word]) + " ";
@ -85,6 +74,22 @@ QSharedPointer<PreviewResult> PreviewGeneratorPlainText::generate(RenderConfig c
header += "<hr>";
result->setText(header + resulText.replace("\n", "<br>").mid(0, 1000));
return header + resulText.replace("\n", "<br>").mid(0, 1000);
}
QSharedPointer<PreviewResult> PreviewGeneratorPlainText::generate(RenderConfig config, QString documentPath,
unsigned int page)
{
PreviewResultPlainText *result = new PreviewResultPlainText(documentPath, page);
QFile file(documentPath);
if(!file.open(QFile::ReadOnly | QFile::Text))
{
return QSharedPointer<PreviewResultPlainText>(result);
}
QTextStream in(&file);
QString content = in.readAll();
QFileInfo info{documentPath};
result->setText(generatePreviewText(content, config, info.fileName()));
return QSharedPointer<PreviewResultPlainText>(result);
}

@ -6,6 +6,7 @@ class PreviewGeneratorPlainText : public PreviewGenerator
{
public:
using PreviewGenerator::PreviewGenerator;
QString generatePreviewText(QString content, RenderConfig config, QString fileName);
QSharedPointer<PreviewResult> generate(RenderConfig config, QString documentPath, unsigned int page);
};

1
gui/previewresultodt.cpp Normal file

@ -0,0 +1 @@
#include "previewresultodt.h"

10
gui/previewresultodt.h Normal file

@ -0,0 +1,10 @@
#ifndef PREVIEWRESULTODT_H
#define PREVIEWRESULTODT_H
#include "previewresultplaintext.h"
class PreviewResultOdt : public PreviewResultPlainText
{
using PreviewResultPlainText::PreviewResultPlainText;
};
#endif // PREVIEWRESULTODT_H

@ -22,46 +22,29 @@ inline void initResources()
bool Common::initSqliteDatabase(QString path)
{
QSqlDatabase db = QSqlDatabase::addDatabase("QSQLITE");
db.setDatabaseName(path);
if(!db.open())
try
{
qDebug() << "failed to open database: " << path;
initResources();
DatabaseFactory factory(path);
DBMigrator migrator{factory};
migrator.performMigrations();
}
catch(std::exception &ex)
{
Logger::error() << "Failed to init dabase: " << ex.what();
return false;
}
initResources();
DBMigrator migrator{db};
migrator.performMigrations();
db.close();
return true;
}
QString Common::findInPath(QString needle)
{
QStringList results;
QString pathVar = QProcessEnvironment::systemEnvironment().value("PATH", "/usr/bin/:/bin/:");
QStringList paths = pathVar.split(":");
for(const QString &path : paths)
{
// TODO: can pass ../ but so be it for now.
QFileInfo info{path + "/" + needle};
if(info.exists())
{
return info.absoluteFilePath();
}
}
return "";
}
void Common::setPdfViewer()
{
QString value;
/* TODO: well, we should query this probably from xdg*/
QString okularPath = findInPath("okular");
QString evincePath = findInPath("evince");
QString qpdfviewPath = findInPath("qpdfview");
QString okularPath = QStandardPaths::findExecutable("okular");
QString evincePath = QStandardPaths::findExecutable("evince");
QString qpdfviewPath = QStandardPaths::findExecutable("qpdfview");
if(okularPath != "")
{
@ -76,9 +59,9 @@ void Common::setPdfViewer()
value = qpdfviewPath + " %f#%p";
}
QSettings settings;
if(value != "")
{
QSettings settings;
settings.setValue(SETTINGS_KEY_PDFVIEWER, value);
}
}
@ -107,21 +90,6 @@ void Common::ensureConfigured()
}
settings.setValue(SETTINGS_KEY_DBPATH, dbpath);
}
DatabaseFactory factory{dbpath};
auto db = factory.forCurrentThread();
DBMigrator migrator{db};
if(migrator.migrationNeeded())
{
QFile out;
out.open(stderr, QIODevice::WriteOnly);
Logger migrationLogger{&out};
migrationLogger << "Database is being upgraded, please be patient..." << Qt::endl;
QObject::connect(&migrator, &DBMigrator::migrationDone,
[&migrationLogger](uint32_t migration)
{ migrationLogger << "Progress: Successfully migrated to: " << migration << Qt::endl; });
migrator.performMigrations();
migrationLogger << "Database upgraded successfully" << Qt::endl;
}
QVariant pdfViewer = settings.value(SETTINGS_KEY_PDFVIEWER);
if(!pdfViewer.isValid())
{
@ -234,3 +202,8 @@ QString Common::versionText()
QString tag = GIT_TAG;
return tag + " (" + commitid + ") built " + __DATE__ + " " + __TIME__;
}
QString Common::userManualUrl()
{
return QString("https://github.com/quitesimpleorg/looqs/blob/%1/USAGE.md").arg(QString(GIT_COMMIT_ID));
}

@ -16,7 +16,6 @@ void setupAppInfo();
QString databasePath();
QString ipcSocketPath();
void setPdfViewer();
QString findInPath(QString needle);
bool initSqliteDatabase(QString path);
void ensureConfigured();
QStringList excludedPaths();
@ -25,5 +24,6 @@ bool isTextFile(QFileInfo fileInfo);
bool isMountPath(QString path);
bool noSandboxModeRequested();
QString versionText();
QString userManualUrl();
} // namespace Common
#endif

@ -6,10 +6,10 @@
#include "dbmigrator.h"
#include "looqsgeneralexception.h"
DBMigrator::DBMigrator(QSqlDatabase &db)
DBMigrator::DBMigrator(DatabaseFactory &factory)
{
Q_INIT_RESOURCE(migrations);
this->db = &db;
this->dbFactory = &factory;
}
DBMigrator::~DBMigrator()
@ -30,7 +30,8 @@ QStringList DBMigrator::getMigrationFilenames()
uint32_t DBMigrator::currentRevision()
{
QSqlQuery dbquery(*db);
QSqlDatabase db = dbFactory->forCurrentThread();
QSqlQuery dbquery(db);
dbquery.exec("PRAGMA user_version;");
if(!dbquery.next())
{
@ -48,38 +49,56 @@ bool DBMigrator::migrationNeeded()
return currentRev < static_cast<uint32_t>(migrations.size());
}
void DBMigrator::start()
{
performMigrations();
}
void DBMigrator::performMigrations()
{
QStringList migrations = getMigrationFilenames();
uint32_t currentRev = currentRevision();
uint32_t targetRev = (migrations.size());
for(uint32_t i = currentRev + 1; i <= targetRev; i++)
{
QString fileName = QString(":/looqs-migrations/%1.sql").arg(i);
QFile file{fileName};
if(!file.open(QIODevice::ReadOnly))
{
throw LooqsGeneralException("Migration: Failed to find required revision file");
}
QTextStream stream(&file);
db->transaction();
while(!stream.atEnd())
{
QString sql = stream.readLine();
QSqlQuery sqlQuery{*db};
if(!sqlQuery.exec(sql))
{
QSqlDatabase db = dbFactory->forCurrentThread();
db->rollback();
throw LooqsGeneralException("Failed to execute sql statement while initializing database: " +
sqlQuery.lastError().text());
try
{
for(uint32_t i = currentRev + 1; i <= targetRev; i++)
{
QString fileName = QString(":/looqs-migrations/%1.sql").arg(i);
QFile file{fileName};
if(!file.open(QIODevice::ReadOnly))
{
throw LooqsGeneralException("Migration: Failed to find required revision file");
}
QTextStream stream(&file);
db.transaction();
while(!stream.atEnd())
{
QString sql = stream.readLine();
QSqlQuery sqlQuery{db};
if(!sqlQuery.exec(sql))
{
db.rollback();
throw LooqsGeneralException("Failed to execute sql statement while initializing database: " +
sqlQuery.lastError().text());
}
}
QSqlQuery updateVersion{db};
updateVersion.exec(QString("PRAGMA user_version=%1;").arg(i));
db.commit();
QSqlQuery vacuumQuery{db};
vacuumQuery.exec("VACUUM;");
emit migrationDone(i);
}
QSqlQuery updateVersion{*db};
updateVersion.exec(QString("PRAGMA user_version=%1;").arg(i));
db->commit();
emit migrationDone(i);
emit done();
}
catch(LooqsGeneralException &e)
{
emit error(e.message);
}
emit done();
}

@ -3,14 +3,15 @@
#include <QStringList>
#include <QSqlDatabase>
#include <QObject>
#include "databasefactory.h"
class DBMigrator : public QObject
{
Q_OBJECT
private:
QSqlDatabase *db;
DatabaseFactory *dbFactory;
public:
DBMigrator(QSqlDatabase &db);
DBMigrator(DatabaseFactory &dbFactory);
~DBMigrator();
uint32_t currentRevision();
void performMigrations();
@ -19,6 +20,9 @@ class DBMigrator : public QObject
signals:
void migrationDone(uint32_t);
void done();
void error(QString e);
public slots:
void start();
};
#endif // DBMIGRATOR_H

@ -120,7 +120,7 @@ void Indexer::dirScanProgress(int current, int total)
void Indexer::processFileScanResult(FileScanResult result)
{
if(result.second != OK || result.second != OK_WASEMPTY || result.second != SKIPPED)
if(isErrorSaveFileResult(result.second))
{
this->currentIndexResult.results.append(result);
if(!keepGoing)

@ -320,7 +320,7 @@ LooqsQuery LooqsQuery::build(QString expression, TokenType loneWordsTokenType, b
QVector<Token> newTokens;
TokenType prevType = BOOL_AND;
int needsBoolean = FILTER_CONTENT | FILTER_PATH | NEGATION;
int needsBoolean = FILTER_CONTENT | FILTER_PATH | NEGATION | WORD;
for(Token &t : result.tokens)
{
if(t.type == BRACKET_OPEN || t.type & needsBoolean)

@ -44,6 +44,13 @@ class LooqsQuery
QVector<Token> tokens;
QVector<SortCondition> sortConditions;
void addToken(Token t);
void updateTokensMask()
{
for(const Token &t : tokens)
{
this->tokensMask |= t.type;
}
}
public:
const QVector<Token> &getTokens() const;
@ -65,8 +72,34 @@ class LooqsQuery
bool hasPathSearch() const;
void addSortCondition(SortCondition sc);
void setTokens(const QVector<Token> &tokens)
{
this->tokens = tokens;
updateTokensMask();
}
static bool checkParanthesis(QString query);
static LooqsQuery build(QString query, TokenType loneWordsTokenType, bool mergeLoneWords);
LooqsQuery()
{
}
LooqsQuery(const QVector<Token> &tokens, const QVector<SortCondition> &sortConditions)
{
this->tokens = tokens;
this->sortConditions = sortConditions;
updateTokensMask();
}
LooqsQuery(const LooqsQuery &o)
{
this->tokens = o.tokens;
this->sortConditions = o.sortConditions;
this->tokensMask = o.tokensMask;
this->limit = o.limit;
}
};
#endif // LOOQSQUERY_H

14
shared/migrations/2.sql Normal file

@ -0,0 +1,14 @@
ALTER TABLE content ADD ftsid integer;
CREATE VIRTUAL TABLE fts USING fts5(content, content='');
DROP TRIGGER contents_ai;
DROP TRIGGER contents_au;
DROP TRIGGER contents_ad;
CREATE TEMP TABLE contentstemp(id INTEGER PRIMARY KEY, content text);
CREATE TRIGGER contentstemp_ai AFTER INSERT ON contentstemp BEGIN INSERT INTO fts(content) VALUES (new.content); UPDATE content SET ftsid=last_insert_rowid() WHERE id = new.id; END;
INSERT INTO contentstemp(id, content) SELECT id, content FROM content;
DROP TRIGGER contentstemp_ai;
DROP TABLE contentstemp;
DROP TABLE content_fts;
ALTER TABLE content DROP COLUMN content;
CREATE INDEX content_ftsid ON content (ftsid);
CREATE TRIGGER content_ad AFTER DELETE ON content BEGIN INSERT INTO fts(fts, rowid) VALUES('delete', old.ftsid); END;

@ -1,5 +1,6 @@
<RCC>
<qresource prefix="/looqs-migrations">
<file>1.sql</file>
<file>2.sql</file>
</qresource>
</RCC>

@ -30,4 +30,9 @@ static inline QString SaveFileResultToString(SaveFileResult sfr)
return SaveFileResultStr[(int)sfr];
}
static inline bool isErrorSaveFileResult(SaveFileResult result)
{
return result == DBFAIL || result == PROCESSFAIL || result == NOTFOUND || result == NOACCESS;
}
#endif // SAVEFILERESULT_H

@ -151,11 +151,14 @@ SaveFileResult SqliteDbService::saveFile(QFileInfo fileInfo, QVector<PageData> &
int lastid = inserterQuery.lastInsertId().toInt();
for(const PageData &data : pageData)
{
QSqlQuery ftsQuery(db);
ftsQuery.prepare("INSERT INTO fts(content) VALUES(?)");
ftsQuery.addBindValue(data.content);
ftsQuery.exec();
QSqlQuery contentQuery(db);
contentQuery.prepare("INSERT INTO content(fileid, page, content) VALUES(?, ?, ?)");
contentQuery.prepare("INSERT INTO content(fileid, page, ftsid) VALUES(?, ?, last_insert_rowid())");
contentQuery.addBindValue(lastid);
contentQuery.addBindValue(data.pagenumber);
contentQuery.addBindValue(data.content);
if(!contentQuery.exec())
{
db.rollback();

@ -66,6 +66,28 @@ QString SqliteSearch::createSortSql(const QVector<SortCondition> sortConditions)
return "";
}
QString SqliteSearch::escapeFtsArgument(QString ftsArg)
{
QString result;
QRegularExpression extractor(R"#("([^"]*)"|([^\s]+))#");
QRegularExpressionMatchIterator i = extractor.globalMatch(ftsArg);
while(i.hasNext())
{
QRegularExpressionMatch m = i.next();
QString value = m.captured(1);
if(value.isEmpty())
{
value = m.captured(2);
}
else
{
value = "\"\"" + value + "\"\"";
}
result += "\"" + value + "\" ";
}
return result;
}
QPair<QString, QVector<QString>> createNonArgPair(QString key)
{
return {" " + key + " ", QVector<QString>()};
@ -115,9 +137,9 @@ QPair<QString, QVector<QString>> SqliteSearch::createSql(const Token &token)
}
if(token.type == FILTER_CONTENT_CONTAINS)
{
return {" content.id IN (SELECT content_fts.ROWID FROM content_fts WHERE content_fts.content MATCH ? ORDER BY "
return {" content.id IN (SELECT fts.ROWID FROM fts WHERE fts.content MATCH ? ORDER BY "
"rank) ",
{value}};
{escapeFtsArgument(value)}};
}
throw LooqsGeneralException("Unknown token passed (should not happen)");
}
@ -141,11 +163,11 @@ QSqlQuery SqliteSearch::makeSqlQuery(const LooqsQuery &query)
{
if(!ftsAlreadyJoined)
{
joinSql += " INNER JOIN content_fts ON content.id = content_fts.ROWID ";
joinSql += " INNER JOIN fts ON content.ftsid = fts.ROWID ";
ftsAlreadyJoined = true;
}
whereSql += " content_fts.content MATCH ? ";
bindValues.append(token.value);
whereSql += " fts.content MATCH ? ";
bindValues.append(escapeFtsArgument(token.value));
}
else
{

@ -18,6 +18,7 @@ class SqliteSearch
QString fieldToColumn(QueryField field);
QPair<QString, QVector<QString>> createSql(const Token &token);
QString createSortSql(const QVector<SortCondition> sortConditions);
QString escapeFtsArgument(QString ftsArg);
};
#endif // SQLITESEARCH_H