EntryProvider: Support broken .desktop files that don't start with [Desktop Entry]

Refactoring for 5.15 broke this (d9b0be5063),
so fix it.

TODO

@@ -1,4 +0,0 @@
- - Investigate memory leaks (relevant now that we have a single user mode,
- so qsrun may stay open after launch)
- - Provide --help
- - ESC/CTRL+Q close the app. May not be expected behaviour

entryprovider.cpp

@@ -13,6 +13,11 @@ EntryProvider::EntryProvider(QStringList userEntriesDirsPaths, QStringList syste
 					   << "%u";
 }
 
+bool EntryProvider::isSavable(const EntryConfig &config) const
+{
+	return ! config.entryPath.isEmpty() && (config.type == EntryType::USER || config.type == EntryType::INHERIT);
+}
+
 EntryConfig EntryProvider::readFromDesktopFile(const QString &path)
 {
 	EntryConfig result;
@@ -20,20 +25,22 @@ EntryConfig EntryProvider::readFromDesktopFile(const QString &path)
 	if(!file.open(QIODevice::ReadOnly | QIODevice::Text))
 	{
 		// TODO: better exception class
-		throw new std::runtime_error("Failed to open file");
+		throw std::runtime_error("Failed to open file");
 	}
 	QTextStream stream(&file);
 	// There should be nothing preceding this group in the desktop entry file but possibly one or more comments.
 	// https://standards.freedesktop.org/desktop-entry-spec/latest/ar01s03.html#group-header
-	QString firstLine;
+	// Ignore that as there some that violate that in the wild
+	const QString startSection = "[Desktop Entry]";
+	QString line;
 	do
 	{
-		firstLine = stream.readLine().trimmed();
-	} while(!stream.atEnd() && (firstLine.isEmpty() || firstLine[0] == '#'));
+		line = stream.readLine().trimmed();
+	} while(!stream.atEnd() && line != startSection);
 
-	if(firstLine != "[Desktop Entry]")
+	if(line != startSection)
 	{
-		throw ConfigFormatException(".desktop file does not start with [Desktop Entry]: " + path.toStdString());
+		throw ConfigFormatException(".desktop file does not contain [Desktop Entry] section: " + path.toStdString());
 	}
 
 	while(!stream.atEnd())
@@ -79,6 +86,10 @@ EntryConfig EntryProvider::readFromDesktopFile(const QString &path)
 		{
 			result.hidden = args == "true";
 		}
+		if(key == "terminal")
+		{
+			result.isTerminalCommand = args == "true";
+		}
 	}
 	result.type = EntryType::SYSTEM;
 	return result;
@@ -111,7 +122,7 @@ EntryConfig EntryProvider::readqsrunFile(const QString &path)
 	if(!file.open(QIODevice::ReadOnly | QIODevice::Text))
 	{
 		// TODO: better exception class
-		throw new std::runtime_error("Failed to open file");
+		throw std::runtime_error("Failed to open file");
 	}
 	QHash<QString, QString> map;
 	QTextStream stream(&file);
@@ -122,7 +133,7 @@ EntryConfig EntryProvider::readqsrunFile(const QString &path)
 		int spacePos = line.indexOf(' ');
 		if(spacePos == -1)
 		{
-			throw new ConfigFormatException("misformated line in .qsrun config file " + path.toStdString());
+			throw ConfigFormatException("misformated line in .qsrun config file " + path.toStdString());
 		}
 
 		QString key = line.mid(0, spacePos);
@@ -130,7 +141,7 @@ EntryConfig EntryProvider::readqsrunFile(const QString &path)
 
 		if(key == "" || value == "")
 		{
-			throw new ConfigFormatException("empty key or value in .qsrun config file " + path.toStdString());
+			throw ConfigFormatException("empty key or value in .qsrun config file " + path.toStdString());
 		}
 		map[key] = value;
 	}
@@ -145,7 +156,7 @@ EntryConfig EntryProvider::readqsrunFile(const QString &path)
 		}
 		else
 		{
-			throw new ConfigFormatException("Error attempting to read inherited entry");
+			throw ConfigFormatException("Error attempting to read inherited entry");
 		}
 	}
 	QString type = map["type"];
@@ -153,7 +164,7 @@ EntryConfig EntryProvider::readqsrunFile(const QString &path)
 	{
 		if(type == "system")
 		{
-			throw new ConfigFormatException(".qsrun files cannot be designated as system entries " +
+			throw ConfigFormatException(".qsrun files cannot be designated as system entries " +
 											path.toStdString());
 		}
 		else if(type == "inherit")
@@ -166,7 +177,7 @@ EntryConfig EntryProvider::readqsrunFile(const QString &path)
 		}
 		else
 		{
-			throw new ConfigFormatException("Invalid value for type provided in file: " + path.toStdString());
+			throw ConfigFormatException("Invalid value for type provided in file: " + path.toStdString());
 		}
 	}
 	else
@@ -219,6 +230,7 @@ EntryConfig EntryProvider::readqsrunFile(const QString &path)
 	}
 	result.col = map["col"].toInt();
 	result.row = map["row"].toInt();
+	result.isTerminalCommand = map["terminal"] == "true";
 	return result;
 }
 
@@ -280,7 +292,7 @@ QVector<EntryConfig> EntryProvider::getSystemEntries()
 
 void EntryProvider::saveUserEntry(const EntryConfig &config)
 {
-	if(config.type == EntryType::SYSTEM || config.entryPath.isEmpty())
+	if(!isSavable(config))
 	{
 		throw std::runtime_error("Only user/inherited entries can be saved");
 	}
@@ -291,32 +303,35 @@ void EntryProvider::saveUserEntry(const EntryConfig &config)
 		throw std::runtime_error("Error: Can not open file for writing");
 	}
 	QTextStream outStream(&file);
-	outStream << "type" << " " << ((config.type == EntryType::USER) ? "user" : "inherit") << endl;
+	outStream << "type" << " " << ((config.type == EntryType::USER) ? "user" : "inherit") << Qt::endl;
 	if(!config.inherit.isEmpty())
 	{
-		outStream << "inherit" << " " << config.inherit << endl;
+		outStream << "inherit" << " " << config.inherit << Qt::endl;
+	}
+	outStream << "row" << " " << config.row << Qt::endl;
+	outStream << "col" << " " << config.col << Qt::endl;
+	outStream << "hidden" << " " << config.hidden << Qt::endl;
+	if(!config.key.isEmpty())
+	{
+		outStream << "key" << " " << config.key << Qt::endl;
 	}
-	outStream << "row" << " " << config.row << endl;
-	outStream << "col" << " " << config.col << endl;
-	outStream << "hidden" << " " << config.hidden << endl;
-	outStream << "key" << " " << config.key << endl;
 	if(config.type == EntryType::USER)
 	{
 		if(!config.name.isEmpty())
 		{
-			outStream << "name" << " " << config.name << endl;
+			outStream << "name" << " " << config.name << Qt::endl;
 		}
 		if(!config.command.isEmpty())
 		{
-			outStream << "command" << " " << config.command << endl;
+			outStream << "command" << " " << config.command << Qt::endl;
 		}
 		if(!config.iconPath.isEmpty())
 		{
-			outStream << "icon" << " " << config.iconPath << endl;
+			outStream << "icon" << " " << config.iconPath << Qt::endl;
 		}
 		if(!config.arguments.empty())
 		{
-			outStream << "arguments" << " " << config.arguments.join(' ') << endl;
+			outStream << "arguments" << " " << config.arguments.join(' ') << Qt::endl;
 		}
 	}
 
@@ -334,7 +349,7 @@ void EntryProvider::saveUserEntry(const EntryConfig &config)
 
 bool EntryProvider::deleteUserEntry(const EntryConfig &config)
 {
-	if(config.type == EntryType::SYSTEM || config.entryPath.isEmpty())
+	if(!isSavable(config))
 	{
 		throw std::runtime_error("Only user/inherited entries can be deleted");
 	}

entryprovider.h

@@ -19,7 +19,8 @@ enum EntryType
 {
 	USER,
 	INHERIT,
-	SYSTEM
+	SYSTEM,
+	DYNAMIC
 };
 
 class EntryConfig
@@ -27,6 +28,7 @@ class EntryConfig
   public:
 	EntryType type = SYSTEM;
 	bool hidden = false;
+	bool isTerminalCommand = false;
 	QString entryPath;
 	QString key;
 	QString name;
@@ -54,6 +56,7 @@ class EntryProvider
 
   public:
 	EntryProvider(QStringList userEntriesDirsPaths, QStringList systemEntriesDirsPaths);
+	bool isSavable(const EntryConfig &config) const;
 	QVector<EntryConfig> getUserEntries();
 	QVector<EntryConfig> getSystemEntries();
 	void saveUserEntry(const EntryConfig &config);

entrypushbutton.cpp

@@ -23,21 +23,17 @@ EntryPushButton::EntryPushButton(const EntryConfig &config) : QPushButton()
 {
 	this->setText(config.name);
 	this->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
-	QIcon icon = resolveIcon(config.iconPath);
-	this->setIcon(icon);
-	if(!icon.availableSizes().isEmpty())
+	QIcon icon;
+	if(config.isTerminalCommand && config.iconPath.isEmpty())
 	{
-		auto sizes = icon.availableSizes();
-		QSize maxSize = sizes.first();
-		for(QSize &current : sizes)
-		{
-			if(current.width() > maxSize.width())
-			{
-				maxSize = current;
-			}
-		}
-		this->setIconSize(maxSize);
+		icon = resolveIcon("utilities-terminal");
 	}
+	else
+	{
+		icon = resolveIcon(config.iconPath);
+	}
+	this->setIcon(icon);
+	this->setIconSize(QSize{256, 256});
 	this->config = config;
 	connect(this, SIGNAL(clicked()), this, SLOT(emitOwnClicked()));
 
@@ -98,7 +94,7 @@ void EntryPushButton::mousePressEvent(QMouseEvent *event)
 		{
 			this->userEntryMenu.exec(QCursor::pos());
 		}
-		else
+		else if(this->config.type == EntryType::SYSTEM)
 		{
 			this->systemEntryMenu.exec(QCursor::pos());
 		}
@@ -108,7 +104,7 @@ void EntryPushButton::mousePressEvent(QMouseEvent *event)
 
 void EntryPushButton::mouseMoveEvent(QMouseEvent *event)
 {
-	if(this->config.type == EntryType::SYSTEM)
+	if(this->config.type == EntryType::SYSTEM || this->config.type == EntryType::DYNAMIC)
 	{
 		return;
 	}

main.cpp

@@ -14,6 +14,7 @@
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 #include <QApplication>
+#include <QCommandLineParser>
 #include <QFuture>
 #include <QFutureWatcher>
 #include <QtConcurrent/QtConcurrentRun>
@@ -30,56 +31,76 @@ int main(int argc, char *argv[])
 	QApplication app(argc, argv);
 	QString configDirectoryPath;
 	QDir dir;
+	bool newInstanceRequested = false;
 	if(argc >= 2)
 	{
-		configDirectoryPath = QCoreApplication::arguments().at(1);
-		if(!dir.exists(configDirectoryPath))
+		QCommandLineParser parser;
+		parser.addOptions({
+			{"new-instance", "Launch a new instance, ignoring any running ones"},
+			{"config", "Use supplied config dir instead of default"},
+		});
+		parser.addHelpOption();
+		parser.process(app.arguments());
+		configDirectoryPath = parser.value("config");
+		newInstanceRequested = parser.isSet("new-instance");
+
+		if(!configDirectoryPath.isEmpty() && !dir.exists(configDirectoryPath))
 		{
 			QMessageBox::warning(nullptr, "Directory not found", configDirectoryPath + " was not found");
 			return 1;
 		}
 	}
-	else
+	if(configDirectoryPath.isEmpty())
 	{
 		configDirectoryPath = QDir::homePath() + "/.config/qsrun/";
 	}
-	qRegisterMetaType<QVector<QString> >("QVector<QString>");
 
+	qRegisterMetaType<QVector<QString>>("QVector<QString>");
 
 	if(!dir.exists(configDirectoryPath))
 	{
 		if(!dir.mkdir(configDirectoryPath))
 		{
-			QMessageBox::warning(nullptr, "Failed to create dir", configDirectoryPath + " was not found and could not be created!");
+			QMessageBox::warning(nullptr, "Failed to create dir",
+								 configDirectoryPath + " was not found and could not be created!");
 			return 1;
 		}
 	}
 
 	QSettings settings(configDirectoryPath + "qsrun.config", QSettings::NativeFormat);
 
-	SettingsProvider settingsProvider { settings };
+	SettingsProvider settingsProvider{settings};
 	EntryProvider entryProvider(settingsProvider.userEntriesPaths(), settingsProvider.systemApplicationsEntriesPaths());
-	//TODO if setting single instance mode
-	QLocalSocket localSocket;
-	localSocket.connectToServer("/tmp/qsrun.socket");
-	SingleInstanceServer server;
-	if(localSocket.isOpen() && localSocket.isWritable())
+
+	SingleInstanceServer *server = nullptr;
+
+	bool singleInstanceMode = !newInstanceRequested && settingsProvider.singleInstanceMode();
+	if(singleInstanceMode)
 	{
-		QDataStream stream(&localSocket);
-		stream << (int)0x01; //maximize
-		localSocket.flush();
-		localSocket.waitForBytesWritten();
-		localSocket.disconnectFromServer();
-		return 0;
-	}
-	else
-	{
-		if(!server.listen("/tmp/qsrun.socket"))
+		QLocalSocket localSocket;
+		localSocket.connectToServer(settingsProvider.socketPath());
+		if(localSocket.isOpen() && localSocket.isWritable())
+		{
+			QDataStream stream(&localSocket);
+			stream << (int)0x01; // maximize
+			localSocket.flush();
+			localSocket.waitForBytesWritten();
+			localSocket.disconnectFromServer();
+			return 0;
+		}
+
+		server = new SingleInstanceServer();
+		if(!server->listen(settingsProvider.socketPath()))
 		{
 			qDebug() << "Failed to listen on socket!";
+			return 1;
 		}
-		Window *w = new Window { entryProvider, settingsProvider };
-		QObject::connect(&server, &SingleInstanceServer::receivedMaximizationRequest, [&w]{
+	}
+
+	Window *w = new Window{entryProvider, settingsProvider};
+	if(singleInstanceMode && server != nullptr)
+	{
+		QObject::connect(server, &SingleInstanceServer::receivedMaximizationRequest, [&w] {
 			if(w != nullptr)
 			{
 				qInfo() << "maximizing as requested by other instance";
@@ -89,12 +110,10 @@ int main(int argc, char *argv[])
 				w->focusInput();
 			}
 		});
-		w->showMaximized();
-		w->focusInput();
-
 	}
 
-
+	w->showMaximized();
+	w->focusInput();
 
 	return app.exec();
 }

settingsprovider.cpp

@@ -28,3 +28,13 @@ bool SettingsProvider::singleInstanceMode() const
 {
 	return settings->value("singleInstance", true).toBool();
 }
+
+QString SettingsProvider::getTerminalCommand() const
+{
+	return settings->value("terminal", "/usr/bin/x-terminal-emulator -e %c").toString();
+}
+
+QString SettingsProvider::socketPath() const
+{
+	return settings->value("singleInstanceSocket", "/tmp/qsrun").toString();
+}

settingsprovider.h

@@ -15,6 +15,8 @@ class SettingsProvider
 	virtual QStringList systemApplicationsEntriesPaths() const;
 	virtual int getMaxCols() const;
 	virtual bool singleInstanceMode() const;
+	QString getTerminalCommand() const;
+	QString socketPath() const;
 };
 
 #endif // SETTINGSPROVIDER_H

window.cpp

@@ -120,7 +120,17 @@ void Window::populateGrid(const QVector<EntryPushButton *> &list)
 
 void Window::executeConfig(const EntryConfig &config)
 {
-	QProcess::startDetached(config.command, config.arguments);
+	if(config.isTerminalCommand || QApplication::keyboardModifiers().testFlag(Qt::ShiftModifier))
+	{
+		QString cmd = settingsProvider->getTerminalCommand();
+		cmd.replace("%c", config.command);
+		QStringList args = QProcess::splitCommand(cmd);
+		QProcess::startDetached(args[0], args);
+	}
+	else
+	{
+		QProcess::startDetached(config.command, config.arguments);
+	}
 	this->closeWindow();
 }
 
@@ -157,6 +167,7 @@ void Window::addToFavourites(const EntryConfig &config)
 	when we add it to the favourites. the alternative would be to reload the whole config,
 	but that's probably overkill. */
 	userConfig.update(config);
+	userConfig.key = "";
 	userEntryButtons.append(createEntryButton(userConfig));
 }
 
@@ -256,6 +267,7 @@ void Window::addPATHSuggestion(const QString &text)
 		e.row = 0;
 		e.command = suggestions[0];
 		e.iconPath = suggestions[0];
+		e.type = EntryType::DYNAMIC;
 		EntryPushButton *button = createEntryButton(e);
 		clearGrid();
 		grid->addWidget(button, 0, 0);
@@ -333,6 +345,7 @@ void Window::lineEditTextChanged(QString text)
 			}
 			e.command = arguments[0];
 			e.iconPath = "utilities-terminal";
+			e.type = EntryType::DYNAMIC;
 
 			EntryPushButton *button = createEntryButton(e);
 			clearGrid();
@@ -372,7 +385,10 @@ void Window::keyPressEvent(QKeyEvent *event)
 
 		for(EntryPushButton *button : buttonsInGrid)
 		{
-			button->showShortcut();
+			if(!button->getEntryConfig().key.isEmpty())
+			{
+				button->showShortcut();
+			}
 		}
 
 		QKeySequence seq(event->key());
@@ -388,6 +404,27 @@ void Window::keyPressEvent(QKeyEvent *event)
 	QWidget::keyPressEvent(event);
 }
 
+int Window::rankConfig(const EntryConfig &config, QString filter) const
+{
+	if(config.name.startsWith(filter, Qt::CaseInsensitive))
+	{
+		return 0;
+	}
+	else if(config.command.startsWith(filter, Qt::CaseInsensitive))
+	{
+		return 1;
+	}
+	else if(config.name.contains(filter, Qt::CaseInsensitive))
+	{
+		return 2;
+	}
+	else if(config.command.contains(filter, Qt::CaseInsensitive))
+	{
+		return 3;
+	}
+	return -1;
+}
+
 void Window::filterGridFor(QString filter)
 {
 	if(filter.length() > 0)
@@ -396,7 +433,8 @@ void Window::filterGridFor(QString filter)
 		bool userEntryMatch = false;
 		for(EntryPushButton *button : this->userEntryButtons)
 		{
-			if(button->getName().contains(filter, Qt::CaseInsensitive))
+			if(button->getName().contains(filter, Qt::CaseInsensitive) ||
+			   button->getCommand().contains(filter, Qt::CaseInsensitive))
 			{
 				button->setVisible(true);
 				grid->addWidget(button, button->getRow(), button->getCol());
@@ -406,26 +444,38 @@ void Window::filterGridFor(QString filter)
 		}
 		if(!userEntryMatch)
 		{
+			QVector<RankedButton> rankedEntries;
 			int currow = 0;
 			int curcol = 0;
 			int i = 1;
 			const int MAX_COLS = this->settingsProvider->getMaxCols();
 			for(EntryPushButton *button : this->systemEntryButtons)
 			{
-				if(button->getName().contains(filter, Qt::CaseInsensitive))
+				int ranking = rankConfig(button->getEntryConfig(), filter);
+				if(ranking > -1)
 				{
-					button->setVisible(true);
-					if(i < 10)
-					{
-						button->setShortcutKey(QString::number(i++));
-					}
-					grid->addWidget(button, currow, curcol++);
-					this->buttonsInGrid.append(button);
-					if(curcol == MAX_COLS)
-					{
-						curcol = 0;
-						++currow;
-					}
+					RankedButton rb;
+					rb.button = button;
+					rb.ranking = ranking;
+					rankedEntries.append(rb);
+				}
+			}
+			std::sort(rankedEntries.begin(), rankedEntries.end(),
+					  [](const RankedButton &a, const RankedButton &b) -> bool { return a.ranking < b.ranking; });
+			for(RankedButton &rankedButton : rankedEntries)
+			{
+				EntryPushButton *button = rankedButton.button;
+				button->setVisible(true);
+				if(i < 10)
+				{
+					button->setShortcutKey(QString::number(i++));
+				}
+				grid->addWidget(button, currow, curcol++);
+				this->buttonsInGrid.append(button);
+				if(curcol == MAX_COLS)
+				{
+					curcol = 0;
+					++currow;
 				}
 			}
 		}

window.h

@@ -37,6 +37,13 @@
 #include "calculationengine.h"
 #include "settingsprovider.h"
 
+class RankedButton
+{
+  public:
+	EntryPushButton *button = nullptr;
+	int ranking;
+};
+
 class Window : public QWidget
 {
 	Q_OBJECT
@@ -77,7 +84,7 @@ class Window : public QWidget
 	QStringList generatePATHSuggestions(const QString &text);
 	void closeWindow();
 	std::pair<int, int> getNextFreeCell();
-
+	int rankConfig(const EntryConfig &config, QString filter) const;
   private slots:
 	void lineEditReturnPressed();
 	void showCalculationResultContextMenu(const QPoint &point);