qsrun/entryprovider.cpp

384 rader
8.8 KiB
C++
Normal vy Historik

#include "entryprovider.h"
2018-01-03 09:52:05 +01:00
#include <QDebug>
#include <QDirIterator>
2018-01-03 09:52:05 +01:00
#include <QTextStream>
EntryProvider::EntryProvider(QStringList userEntriesDirsPaths, QStringList systemEntriesDirsPaths)
2018-01-03 09:52:05 +01:00
{
this->userEntriesDirsPaths = userEntriesDirsPaths;
this->systemEntriesDirsPaths = systemEntriesDirsPaths;
_desktopIgnoreArgs << "%F"
<< "%f"
<< "%U"
<< "%u";
2018-01-03 09:52:05 +01:00
}
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)
2018-01-03 09:52:05 +01:00
{
EntryConfig result;
QFile file(path);
if(!file.open(QIODevice::ReadOnly | QIODevice::Text))
2018-01-03 09:52:05 +01:00
{
// TODO: better exception class
throw std::runtime_error("Failed to open file");
2018-01-03 09:52:05 +01:00
}
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;
do
2018-01-03 09:52:05 +01:00
{
firstLine = stream.readLine().trimmed();
} while(!stream.atEnd() && (firstLine.isEmpty() || firstLine[0] == '#'));
if(firstLine != "[Desktop Entry]")
2018-01-03 09:52:05 +01:00
{
throw ConfigFormatException(".desktop file does not start with [Desktop Entry]: " + path.toStdString());
2018-01-03 09:52:05 +01:00
}
while(!stream.atEnd())
{
QString line = stream.readLine();
// new group, so we are finished with [Desktop Entry]
if(line.startsWith("[") && line.endsWith("]"))
{
return result;
}
QString key = line.section('=', 0, 0).toLower();
QString args = line.section('=', 1);
if(key == "name")
2018-01-03 09:52:05 +01:00
{
if(result.name.length() == 0)
2018-01-03 09:52:05 +01:00
{
result.name = args;
2018-01-03 09:52:05 +01:00
}
}
if(key == "icon")
{
result.iconPath = args;
}
if(key == "exec")
{
QStringList arguments = args.split(" ");
2018-01-03 09:52:05 +01:00
result.command = arguments[0];
arguments = arguments.mid(1);
if(arguments.length() > 1)
{
for(QString &arg : arguments)
2018-01-03 09:52:05 +01:00
{
if(!_desktopIgnoreArgs.contains(arg))
{
result.arguments.append(arg);
}
2018-01-03 09:52:05 +01:00
}
}
}
if(key == "nodisplay")
{
result.hidden = args == "true";
}
if(key == "terminal")
{
result.isTerminalCommand = args == "true";
}
2018-01-03 09:52:05 +01:00
}
result.type = EntryType::SYSTEM;
2018-01-03 09:52:05 +01:00
return result;
}
std::optional<EntryConfig> EntryProvider::readEntryFromPath(const QString &path)
{
QFileInfo info(path);
if(info.isFile())
{
QString suffix = info.suffix();
if(suffix == "desktop")
{
return readFromDesktopFile(path);
}
if(suffix == "qsrun")
{
return readqsrunFile(path);
}
}
return {};
}
/* qsrun's own format */
EntryConfig EntryProvider::readqsrunFile(const QString &path)
2018-01-03 09:52:05 +01:00
{
EntryConfig result;
EntryConfig inheritedConfig;
2018-01-03 09:52:05 +01:00
QFile file(path);
if(!file.open(QIODevice::ReadOnly | QIODevice::Text))
2018-01-03 09:52:05 +01:00
{
// TODO: better exception class
throw std::runtime_error("Failed to open file");
2018-01-03 09:52:05 +01:00
}
QHash<QString, QString> map;
2018-01-03 09:52:05 +01:00
QTextStream stream(&file);
while(!stream.atEnd())
{
QString line = stream.readLine();
int spacePos = line.indexOf(' ');
if(spacePos == -1)
2018-01-03 09:52:05 +01:00
{
throw ConfigFormatException("misformated line in .qsrun config file " + path.toStdString());
2018-01-03 09:52:05 +01:00
}
QString key = line.mid(0, spacePos);
QString value = line.mid(spacePos + 1);
if(key == "" || value == "")
{
throw ConfigFormatException("empty key or value in .qsrun config file " + path.toStdString());
}
map[key] = value;
}
if(map.contains("inherit"))
{
auto entry = readEntryFromPath(map["inherit"]);
if(entry)
{
result = entry.value();
result.inherit = map["inherit"];
}
else
{
throw ConfigFormatException("Error attempting to read inherited entry");
}
}
QString type = map["type"];
if(!type.isEmpty())
{
if(type == "system")
2018-01-03 09:52:05 +01:00
{
throw ConfigFormatException(".qsrun files cannot be designated as system entries " +
path.toStdString());
}
else if(type == "inherit")
{
result.type = EntryType::INHERIT;
}
else if(type == "user")
{
result.type = EntryType::USER;
}
else
{
throw ConfigFormatException("Invalid value for type provided in file: " + path.toStdString());
}
}
else
{
result.type = EntryType::USER;
}
if(result.type != EntryType::INHERIT)
{
if(map.contains("arguments"))
{
auto args = map["arguments"].split(' ');
QString merged;
for(QString &str : args)
{
if(str.startsWith('"') && !str.endsWith("'"))
{
merged += str.mid(1) + " ";
}
else if(str.endsWith('"'))
{
str.chop(1);
merged += str;
result.arguments.append(merged);
merged = "";
}
else if(merged != "")
{
merged += str + " ";
}
else
{
result.arguments.append(str);
}
}
if(merged != "")
{
throw ConfigFormatException("non-closed \" in config file " + path.toStdString());
}
}
auto assignIfSourceNotEmpty = [](QString source, QString &val) {
if(!source.isEmpty())
{
val = source;
}
};
assignIfSourceNotEmpty(map["key"].toLower(), result.key);
assignIfSourceNotEmpty(map["command"], result.command);
assignIfSourceNotEmpty(map["icon"], result.iconPath);
assignIfSourceNotEmpty(map["name"], result.name);
}
result.col = map["col"].toInt();
result.row = map["row"].toInt();
result.isTerminalCommand = map["terminal"] == "true";
return result;
2018-01-03 09:52:05 +01:00
}
QString EntryProvider::resolveEntryPath(QString path)
{
if(path.trimmed().isEmpty())
{
return {};
}
if(path[0] == '/')
{
return path;
}
QStringList paths = this->userEntriesDirsPaths + this->systemEntriesDirsPaths;
for(QString &configPath : paths)
{
QDir dir(configPath);
QString desktopFilePath = dir.absoluteFilePath(path);
if(QFileInfo::exists(desktopFilePath))
{
return desktopFilePath;
}
}
return {};
}
QVector<EntryConfig> EntryProvider::readConfig(QStringList paths)
2018-01-03 09:52:05 +01:00
{
QVector<EntryConfig> result;
for(QString &configPath : paths)
2018-01-03 09:52:05 +01:00
{
QDirIterator it(configPath, QDirIterator::Subdirectories);
2019-05-30 10:57:33 +02:00
while(it.hasNext())
2018-01-03 09:52:05 +01:00
{
2019-05-30 10:57:33 +02:00
QString path = it.next();
std::optional<EntryConfig> entry = readEntryFromPath(path);
if(entry)
2018-01-03 09:52:05 +01:00
{
if(!entry->hidden)
{
entry->entryPath = path;
result.append(*entry);
2019-05-30 10:57:33 +02:00
}
2018-01-03 09:52:05 +01:00
}
}
}
return result;
}
QVector<EntryConfig> EntryProvider::getUserEntries()
{
return readConfig(this->userEntriesDirsPaths);
}
QVector<EntryConfig> EntryProvider::getSystemEntries()
{
return readConfig(this->systemEntriesDirsPaths);
}
void EntryProvider::saveUserEntry(const EntryConfig &config)
{
if(!isSavable(config))
{
throw std::runtime_error("Only user/inherited entries can be saved");
}
QString transitPath = config.entryPath + ".transit";
QFile file{transitPath};
if(!file.open(QIODevice::WriteOnly))
{
throw std::runtime_error("Error: Can not open file for writing");
}
QTextStream outStream(&file);
2021-04-29 09:33:54 +02:00
outStream << "type" << " " << ((config.type == EntryType::USER) ? "user" : "inherit") << Qt::endl;
if(!config.inherit.isEmpty())
{
2021-04-29 09:33:54 +02:00
outStream << "inherit" << " " << config.inherit << Qt::endl;
}
2021-04-29 09:33:54 +02:00
outStream << "row" << " " << config.row << Qt::endl;
outStream << "col" << " " << config.col << Qt::endl;
outStream << "hidden" << " " << config.hidden << Qt::endl;
if(!config.key.isEmpty())
{
2021-04-29 09:33:54 +02:00
outStream << "key" << " " << config.key << Qt::endl;
}
if(config.type == EntryType::USER)
{
if(!config.name.isEmpty())
{
2021-04-29 09:33:54 +02:00
outStream << "name" << " " << config.name << Qt::endl;
}
if(!config.command.isEmpty())
{
2021-04-29 09:33:54 +02:00
outStream << "command" << " " << config.command << Qt::endl;
}
if(!config.iconPath.isEmpty())
{
2021-04-29 09:33:54 +02:00
outStream << "icon" << " " << config.iconPath << Qt::endl;
}
if(!config.arguments.empty())
{
2021-04-29 09:33:54 +02:00
outStream << "arguments" << " " << config.arguments.join(' ') << Qt::endl;
}
}
outStream.flush();
file.close();
// Qts don't work if file already exists and c++17... don't want to pull in the fs lib yet
int ret = rename(transitPath.toStdString().c_str(), config.entryPath.toStdString().c_str());
if(ret != 0)
{
qDebug() << strerror(errno);
throw std::runtime_error("Failed to save entry file: Error during rename");
}
}
2020-09-27 22:28:16 +02:00
bool EntryProvider::deleteUserEntry(const EntryConfig &config)
{
if(!isSavable(config))
2020-09-27 22:28:16 +02:00
{
throw std::runtime_error("Only user/inherited entries can be deleted");
2020-09-27 22:28:16 +02:00
}
QFile file{config.entryPath};
2020-09-27 22:28:16 +02:00
return file.remove();
}
template <class T> void assignIfDestDefault(T &dest, const T &source)
{
if(dest == T())
{
dest = source;
}
}
EntryConfig &EntryConfig::update(const EntryConfig &o)
{
assignIfDestDefault(this->arguments, o.arguments);
assignIfDestDefault(this->col, o.col);
assignIfDestDefault(this->command, o.command);
if(this->iconPath.isEmpty())
{
this->iconPath = o.iconPath;
}
assignIfDestDefault(this->key, o.key);
assignIfDestDefault(this->name, o.name);
assignIfDestDefault(this->row, o.row);
assignIfDestDefault(this->hidden, o.hidden);
assignIfDestDefault(this->inherit, o.inherit);
assignIfDestDefault(this->entryPath, o.entryPath);
assignIfDestDefault(this->type, o.type);
return *this;
}