Release v0.9, Update docs

CHANGELOG.md

@@ -1,5 +1,24 @@
 # looqs: Release notes
 
+## 2023-05-07 - v0.9
+Highlights: Tag support. Also begin new index mode to only index metadata (currently only path + file size, more to come).
+
+Note: Upgrading can take some time as new column indexes will be added
+
+CHANGES:
+
+ - gui: Improve font rendering in previews
+ - gui: Allow indexing only metadata
+ - gui: Allow adding content for files which only had metadata indexed before
+ - gui: Allow assigning tags by right clicking on paths
+ - cli: "add" command: Implement --verbose (-v)
+ - cli: "add" command: Implement --no-content and --fill-content
+ - cli: Add "tag" command which allows managing tags for paths.
+ - search: Add "tag:()", "t:()" filters
+ - Minor improvements and refactorings under the hood
+ - Add packages: Ubuntu 23.04.
+
+
 ## 2022-11-19 - v0.8.1
 
 CHANGES:

README.md

@@ -28,7 +28,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-11-19, v0.8.1
+Latest version: 2023-05-07, v0.9
 
 Please keep in mind: looqs is still at an early stage and may exhibit some weirdness and contain bugs.
 
@@ -76,7 +76,7 @@ To build on Ubuntu and Debian, clone the repo and then run:
 ```
 git submodule init
 git submodule update
-sudo apt install build-essential qtbase5-dev libpoppler-qt5-dev libuchardet-dev libquazip5-dev
+sudo apt install build-essential qtbase5-dev libqt5sql5-sqlite libpoppler-qt5-dev libuchardet-dev libquazip5-dev
 qmake
 make
 ```
@@ -97,7 +97,9 @@ 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, 22.10
+
+
+### Ubuntu 23.04, 22.10, 22.04
 Latest release can be installed using apt from the repo.
 ```
 # First, obtain key, assume it's trusted.
@@ -108,6 +110,8 @@ echo "deb [arch=amd64 signed-by=/usr/share/keyrings/repo.quitesimple.org.gpg] ht
 sudo apt-get update
 sudo apt-get install looqs
 ```
+### Gentoo (EXPERIMENTAL)
+Available in this overlay: https://github.com/quitesimpleorg/quitesimple-overlay
 
 ### Prebuilt tarball (distro-agnostic) (EXPERIMENTAL)
 looqs is also distributed as a tarball containing prebuilt binaries and its library dependencies. The tarball is
@@ -134,7 +138,7 @@ An AppImage may accompany the tarball in the future.
 
 
 ### Other distros
-I'll probably add a package for voidlinux at some point and maybe will provide a Gentoo ebuild. However, I would appreciate help for others distros. If you create a package, let me know!
+I appreciate help for others distros. If you create a package, let me know!
 
 
 ### Signature verification

USAGE.md

@@ -165,6 +165,8 @@ A number of search filters are available.
 | path.begins:(term) | pb:(term) |  Filters path beginning with the specified term |
 | 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 |
+| tag:(tagname) | t:(tagname) | Filter for files that have been tagged with the corresponding tag |
+
 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.
 
@@ -177,11 +179,5 @@ Examples:
 |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".|
-|c:("invoice") Downloads|This query is equivalent to c:("invoice") p:("Downloads")|
+|c:("invoice") Downloads|Equivalent to c:("invoice") p:("Downloads")|
-
+|p:(Downloads) invoice|Equivalent to c:("invoice") p:("Downloads")|
-
-
-
-
-
-

cli/commandadd.cpp

@@ -41,13 +41,13 @@ int CommandAdd::handle(QStringList arguments)
 {
 	QCommandLineParser parser;
 	parser.addOptions({{{"c", "continue"},
-						"Continue adding files, don't exit on first error. If this option is not given, looqs will "
+						"Continue adding files, don't exit on first error. Exit code will be 0. If this option is not "
-						"exit asap, but it's possible that a few files will still be processed. "
+						"given, looqs will "
+						"exit asap, but it's possible that a few files will still be processed."
 						"Set -t 1 to avoid this behavior, but processing will be slower. "},
 					   {{"n", "no-content"}, "Only add paths to database. Do not index content"},
 					   {{"v", "verbose"}, "Print paths of files being processed"},
 					   {{"f", "fill-content"}, "Index content for files previously indexed with -n"},
-					   {"tags", "Comma-separated list of tags to assign"},
 					   {{"t", "threads"}, "Number of threads to use.", "threads"}});
 	parser.addHelpOption();
 	parser.addPositionalArgument("add", "Add paths to the index",
@@ -111,10 +111,9 @@ int CommandAdd::handle(QStringList arguments)
 				{
 					IndexResult indexResult = indexer->getResult();
 					int newlyAdded = indexResult.results.count() - currentResult.results.count();
-					int newOffset = 0;
 					if(newlyAdded > 0)
 					{
-						newOffset = indexResult.results.count() - newlyAdded;
+						int newOffset = indexResult.results.count() - newlyAdded;
 						for(int i = newOffset; i < indexResult.results.count(); i++)
 						{
 							auto result = indexResult.results.at(i);

cli/commandtag.cpp

@@ -3,14 +3,39 @@
 #include "logger.h"
 #include "tagmanager.h"
 
+bool CommandTag::ensureAbsolutePaths(const QVector<QString> &paths, QVector<QString> &absolutePaths)
+{
+	for(const QString &path : paths)
+	{
+		QFileInfo info{path};
+		if(!info.exists())
+		{
+			Logger::error() << "Can't add tag for file  " + info.absoluteFilePath() + " because it does not exist"
+							<< Qt::endl;
+			return false;
+		}
+		QString absolutePath = info.absoluteFilePath();
+		if(!this->dbService->fileExistsInDatabase(absolutePath))
+		{
+			Logger::error() << "Only files that have been indexed can be tagged. File not in index: " + absolutePath
+							<< Qt::endl;
+			return false;
+		}
+		absolutePaths.append(absolutePath);
+	}
+	return true;
+}
+
 int CommandTag::handle(QStringList arguments)
 {
 	QCommandLineParser parser;
 	parser.addPositionalArgument("add", "Adds a tag to a file",
 								 "add [tag] [paths...]. Adds the tag to the specified paths");
-	parser.addPositionalArgument("remove", "Removes a file associated to tag", "remove [tag] [file]");
+	parser.addPositionalArgument("remove", "Removes a path associated to a tag", "remove [tag] [path]");
 	parser.addPositionalArgument("delete", "Deletes a tag", "delete [tag]");
 	parser.addPositionalArgument("list", "Lists paths associated with a tag, or all tags", "list [tag]");
+	parser.addPositionalArgument("show", "Lists tags associated with a path", "show [path]");
+
 	parser.addHelpOption();
 
 	parser.parse(arguments);
@@ -21,9 +46,8 @@ int CommandTag::handle(QStringList arguments)
 		parser.showHelp(EXIT_FAILURE);
 		return EXIT_FAILURE;
 	}
-
+	TagManager tagManager{*this->dbService};
 	QString cmd = args[0];
-	qDebug() << cmd;
 	if(cmd == "add")
 	{
 		if(args.length() < 3)
@@ -33,28 +57,14 @@ int CommandTag::handle(QStringList arguments)
 			return EXIT_FAILURE;
 		}
 		QString tag = args[1];
-		auto paths = args.mid(2).toVector();
+		QVector<QString> paths = args.mid(2).toVector();
-		for(int i = 0; i < paths.size(); i++)
-		{
-			QFileInfo info{paths[i]};
-			if(!info.exists())
-			{
-				Logger::error() << "Can't add tag for file  " + info.absoluteFilePath() + " because it does not exist"
-								<< Qt::endl;
-				return EXIT_FAILURE;
-			}
-			QString absolutePath = info.absoluteFilePath();
-			if(!this->dbService->fileExistsInDatabase(absolutePath))
-			{
-				Logger::error() << "Only files that have been indexed can be tagged. File not in index: " + absolutePath
-								<< Qt::endl;
-				return EXIT_FAILURE;
-			}
-			paths[i] = absolutePath;
-		}
 
-		TagManager tagManager{*this->dbService};
+		QVector<QString> absolutePaths;
-		bool result = tagManager.addPathsToTag(tag, paths);
+		if(!ensureAbsolutePaths(paths, absolutePaths))
+		{
+			return EXIT_FAILURE;
+		}
+		bool result = tagManager.addPathsToTag(tag, absolutePaths);
 		if(!result)
 		{
 			Logger::error() << "Failed to assign tags" << Qt::endl;
@@ -62,6 +72,82 @@ int CommandTag::handle(QStringList arguments)
 		}
 		return EXIT_SUCCESS;
 	}
+	if(cmd == "list")
+	{
 
-	return 0;
+		QString tag;
+		if(args.length() >= 2)
+		{
+			tag = args[1];
+		}
+		QVector<QString> entries;
+		if(tag.isEmpty())
+		{
+			entries = tagManager.getTags();
+		}
+		else
+		{
+			entries = tagManager.getPaths(tag);
+		}
+		for(const QString &entry : entries)
+		{
+			Logger::info() << entry << Qt::endl;
+		}
+	}
+	if(cmd == "remove")
+	{
+		if(args.length() < 3)
+		{
+			Logger::error() << "Not enough arguments provided. 'remove' requires a tag followed by at least one path"
+							<< Qt::endl;
+			return EXIT_FAILURE;
+		}
+		QString tag = args[1];
+		QVector<QString> paths = args.mid(2).toVector();
+
+		QVector<QString> absolutePaths;
+		if(!ensureAbsolutePaths(paths, absolutePaths))
+		{
+			return EXIT_FAILURE;
+		}
+
+		if(!tagManager.removePathsForTag(tag, absolutePaths))
+		{
+			Logger::error() << "Failed to remove path assignments" << Qt::endl;
+			return EXIT_FAILURE;
+		}
+	}
+	if(cmd == "delete")
+	{
+		if(args.length() != 2)
+		{
+			Logger::error() << "The 'delete' command requires the tag to delete" << Qt::endl;
+			return EXIT_FAILURE;
+		}
+		if(!tagManager.deleteTag(args[1]))
+		{
+			Logger::error() << "Failed to delete tag" << Qt::endl;
+			return EXIT_FAILURE;
+		}
+	}
+	if(cmd == "show")
+	{
+		if(args.length() != 2)
+		{
+			Logger::error() << "The 'show' command requires a path to show the assigned tags" << Qt::endl;
+			return EXIT_FAILURE;
+		}
+		QString path = args[1];
+		QVector<QString> absolutePaths;
+		if(!ensureAbsolutePaths({path}, absolutePaths))
+		{
+			return EXIT_FAILURE;
+		}
+		QVector<QString> tags = tagManager.getTags(absolutePaths.at(0));
+		for(const QString &entry : tags)
+		{
+			Logger::info() << entry << Qt::endl;
+		}
+	}
+	return EXIT_SUCCESS;
 }

cli/commandtag.h

@@ -4,6 +4,9 @@
 
 class CommandTag : public Command
 {
+  protected:
+	bool ensureAbsolutePaths(const QVector<QString> &paths, QVector<QString> &absolutePaths);
+
   public:
 	using Command::Command;
 

gui/previewgeneratorplaintext.cpp

@@ -246,17 +246,21 @@ QString PreviewGeneratorPlainText::generateLineBasedPreviewText(QTextStream &in,
 			totalWordCountMap[it->first] = totalWordCountMap.value(it->first, 0) + it->second;
 		}
 	}
-	if(isTruncated)
+	if(!resultText.isEmpty())
 	{
-		header += "(truncated) ";
+		if(isTruncated)
-	}
+		{
-	for(QString &word : config.wordsToHighlight)
+			header += "(truncated) ";
-	{
+		}
-		header += word + ": " + QString::number(totalWordCountMap[word]) + " ";
+		for(QString &word : config.wordsToHighlight)
-	}
+		{
-	header += "<hr>";
+			header += word + ": " + QString::number(totalWordCountMap[word]) + " ";
+		}
+		header += "<hr>";
 
-	return header + resultText;
+		resultText = header + resultText;
+	}
+	return resultText;
 }
 
 QSharedPointer<PreviewResult> PreviewGeneratorPlainText::generate(RenderConfig config, QString documentPath,

shared/sqlitedbservice.cpp

@@ -142,6 +142,27 @@ QVector<QString> SqliteDbService::getTagsForPath(QString path)
 	return result;
 }
 
+QVector<QString> SqliteDbService::getPathsForTag(QString tag)
+{
+	QVector<QString> result;
+	auto query = QSqlQuery(dbFactory->forCurrentThread());
+	query.prepare(
+		"SELECT file.path FROM tag INNER JOIN filetag ON tag.id = filetag.tagid INNER JOIN file ON filetag.fileid "
+		"= file.id WHERE tag.name = ?");
+	query.addBindValue(tag.toLower());
+	query.setForwardOnly(true);
+	if(!query.exec())
+	{
+		throw LooqsGeneralException("Error while trying to retrieve paths from database: " + query.lastError().text());
+	}
+	while(query.next())
+	{
+		QString path = query.value(0).toString();
+		result.append(path);
+	}
+	return result;
+}
+
 bool SqliteDbService::setTags(QString path, const QSet<QString> &tags)
 {
 	QSqlDatabase db = dbFactory->forCurrentThread();
@@ -379,3 +400,68 @@ bool SqliteDbService::addTag(QString tag, const QVector<QString> &paths)
 
 	return true;
 }
+
+bool SqliteDbService::removePathsForTag(QString tag, const QVector<QString> &paths)
+{
+	QSqlDatabase db = dbFactory->forCurrentThread();
+	QSqlQuery tagQuery(db);
+	QSqlQuery fileTagQuery(db);
+
+	tag = tag.toLower();
+
+	fileTagQuery.prepare(
+		"DELETE FROM filetag WHERE fileid = (SELECT id FROM file WHERE path = ?) AND tagid = (SELECT id "
+		"FROM tag WHERE name = ?)");
+
+	fileTagQuery.bindValue(1, tag);
+	for(const QString &path : paths)
+	{
+		fileTagQuery.bindValue(0, path);
+		if(!fileTagQuery.exec())
+		{
+			Logger::error() << "An error occured while trying to remove paths from tag assignment" << Qt::endl;
+			return false;
+		}
+	}
+	return true;
+}
+
+bool SqliteDbService::deleteTag(QString tag)
+{
+	QSqlDatabase db = dbFactory->forCurrentThread();
+	if(!db.transaction())
+	{
+		Logger::error() << "Failed to open transaction while trying to delete tag " << tag << " : " << db.lastError()
+						<< Qt::endl;
+		return false;
+	}
+
+	tag = tag.toLower();
+	QSqlQuery assignmentDeleteQuery(db);
+	assignmentDeleteQuery.prepare("DELETE FROM filetag WHERE tagid = (SELECT id FROM tag WHERE name = ?)");
+	assignmentDeleteQuery.addBindValue(tag);
+	if(!assignmentDeleteQuery.exec())
+	{
+		db.rollback();
+		Logger::error() << "Error while trying to delete tag: " << db.lastError() << Qt::endl;
+		return false;
+	}
+
+	QSqlQuery deleteTagQuery(db);
+	deleteTagQuery.prepare("DELETE FROM tag WHERE name = ?");
+	deleteTagQuery.addBindValue(tag);
+	if(!deleteTagQuery.exec())
+	{
+		db.rollback();
+		Logger::error() << "Error while trying to delete tag: " << db.lastError() << Qt::endl;
+		return false;
+	}
+
+	if(!db.commit())
+	{
+		db.rollback();
+		Logger::error() << "Error while trying to delete tag: " << db.lastError() << Qt::endl;
+		return false;
+	}
+	return true;
+}

shared/sqlitedbservice.h

@@ -34,7 +34,10 @@ class SqliteDbService
 	bool addTag(QString tag, const QVector<QString> &paths);
 	QVector<QString> getTags();
 	QVector<QString> getTagsForPath(QString path);
+	QVector<QString> getPathsForTag(QString path);
 	bool setTags(QString path, const QSet<QString> &tags);
+	bool removePathsForTag(QString tag, const QVector<QString> &paths);
+	bool deleteTag(QString tag);
 
 	QVector<SearchResult> search(const LooqsQuery &query);
 

shared/tagmanager.cpp

@@ -28,6 +28,31 @@ bool TagManager::removeTagsForPath(QString path, const QSet<QString> &tags)
 	return this->dbService->setTags(path, newTags);
 }
 
+bool TagManager::removePathsForTag(QString tag, const QVector<QString> &paths)
+{
+	return this->dbService->removePathsForTag(tag, paths);
+}
+
+bool TagManager::deleteTag(QString tag)
+{
+	return this->dbService->deleteTag(tag);
+}
+
+QVector<QString> TagManager::getTags(QString path)
+{
+	return this->dbService->getTagsForPath(path);
+}
+
+QVector<QString> TagManager::getTags()
+{
+	return this->dbService->getTags();
+}
+
+QVector<QString> TagManager::getPaths(QString tag)
+{
+	return this->dbService->getPathsForTag(tag);
+}
+
 bool TagManager::addTagsToPath(QString path, QString tagstring, QChar delim)
 {
 	auto splitted = tagstring.split(delim);

shared/tagmanager.h

@@ -17,9 +17,11 @@ class TagManager
 	bool addPathsToTag(QString tag, const QVector<QString> &paths);
 	bool removeTagsForPath(QString path, const QSet<QString> &tags);
 
+	bool removePathsForTag(QString tag, const QVector<QString> &paths);
 	bool deleteTag(QString tag);
 
 	QVector<QString> getTags(QString path);
+	QVector<QString> getTags();
 	QVector<QString> getPaths(QString tag);
 };
 

shared/token.h

@@ -19,10 +19,10 @@ enum TokenType
 	FILTER_PATH_SIZE,
 	FILTER_PATH_ENDS,
 	FILTER_PATH_STARTS,
-	FILTER_CONTENT = 512,
+	FILTER_TAG_ASSIGNED,
+	FILTER_CONTENT = 512, /* Everything below here is content search (except LIMIT) */
 	FILTER_CONTENT_CONTAINS,
 	FILTER_CONTENT_PAGE,
-	FILTER_TAG_ASSIGNED,
 	LIMIT = 1024
 };