OpenRCT2/src/openrct2-ui/UiContext.Linux.cpp

428 lines
16 KiB
C++

/*****************************************************************************
* Copyright (c) 2014-2024 OpenRCT2 developers
*
* For a complete list of all authors, please refer to contributors.md
* Interested in contributing? Visit https://github.com/OpenRCT2/OpenRCT2
*
* OpenRCT2 is licensed under the GNU General Public License version 3.
*****************************************************************************/
#if (defined(__unix__) || defined(__EMSCRIPTEN__)) && !defined(__ANDROID__) && !defined(__APPLE__)
# include "UiContext.h"
# include <SDL.h>
# include <dlfcn.h>
# include <openrct2/common.h>
# include <openrct2/core/Path.hpp>
# include <openrct2/core/String.hpp>
# include <openrct2/core/StringBuilder.h>
# include <openrct2/localisation/Localisation.h>
# include <openrct2/platform/Platform.h>
# include <openrct2/ui/UiContext.h>
# include <sstream>
# include <stdexcept>
# include <unistd.h>
namespace OpenRCT2::Ui
{
enum class DIALOG_TYPE
{
NONE,
KDIALOG,
ZENITY,
};
class LinuxContext final : public IPlatformUiContext
{
private:
mutable std::optional<bool> _hasFilePicker = std::nullopt;
public:
LinuxContext()
{
}
void SetWindowIcon(SDL_Window* window) override
{
}
bool IsSteamOverlayAttached() override
{
# ifdef __linux__
// See http://syprog.blogspot.ru/2011/12/listing-loaded-shared-objects-in-linux.html
struct lmap
{
void* base_address;
char* path;
void* unused;
lmap* next;
lmap* prev;
};
struct dummy
{
void* pointers[3];
dummy* ptr;
};
bool result = false;
void* processHandle = dlopen(nullptr, RTLD_NOW);
if (processHandle != nullptr)
{
dummy* p = (static_cast<dummy*>(processHandle))->ptr;
lmap* pl = reinterpret_cast<lmap*>(p->ptr);
while (pl != nullptr)
{
if (strstr(pl->path, "gameoverlayrenderer.so") != nullptr)
{
result = true;
break;
}
pl = pl->next;
}
dlclose(processHandle);
}
return result;
# else
return false; // Needed for OpenBSD, likely all other Unixes.
# endif
}
void ShowMessageBox(SDL_Window* window, const std::string& message) override
{
LOG_VERBOSE(message.c_str());
std::string executablePath;
DIALOG_TYPE dtype = GetDialogApp(&executablePath);
switch (dtype)
{
case DIALOG_TYPE::KDIALOG:
{
std::string cmd = String::StdFormat(
"%s --title \"OpenRCT2\" --msgbox \"%s\"", executablePath.c_str(), message.c_str());
Platform::Execute(cmd);
break;
}
case DIALOG_TYPE::ZENITY:
{
std::string cmd = String::StdFormat(
"%s --title=\"OpenRCT2\" --info --text=\"%s\"", executablePath.c_str(), message.c_str());
Platform::Execute(cmd);
break;
}
default:
SDL_ShowSimpleMessageBox(SDL_MESSAGEBOX_WARNING, "OpenRCT2", message.c_str(), window);
break;
}
}
void OpenFolder(const std::string& path) override
{
std::string cmd = String::StdFormat("xdg-open %s", EscapePathForShell(path).c_str());
Platform::Execute(cmd);
}
void OpenURL(const std::string& url) override
{
std::string cmd = String::StdFormat("xdg-open %s", url.c_str());
Platform::Execute(cmd);
}
std::string ShowFileDialog(SDL_Window* window, const FileDialogDesc& desc) override
{
std::string result;
std::string executablePath;
u8string directory = EscapePathForShell(desc.InitialDirectory + '/');
DIALOG_TYPE dtype = GetDialogApp(&executablePath);
switch (dtype)
{
case DIALOG_TYPE::KDIALOG:
{
std::string action = (desc.Type == FileDialogType::Open) ? "--getopenfilename" : "--getsavefilename";
std::string filter = GetKDialogFilterString(desc.Filters);
std::string cmd = String::StdFormat(
"%s --title '%s' %s %s '%s'", executablePath.c_str(), desc.Title.c_str(), action.c_str(),
directory.c_str(), filter.c_str());
std::string output;
if (Platform::Execute(cmd, &output) == 0)
{
result = output;
}
break;
}
case DIALOG_TYPE::ZENITY:
{
std::string action = "--file-selection";
std::string flags;
if (desc.Type == FileDialogType::Save)
{
flags = "--confirm-overwrite --save";
}
std::string filters = GetZenityFilterString(desc.Filters);
std::string cmd = String::StdFormat(
"%s %s --filename=%s %s --title='%s' / %s", executablePath.c_str(), action.c_str(), directory.c_str(),
flags.c_str(), desc.Title.c_str(), filters.c_str());
std::string output;
if (Platform::Execute(cmd, &output) == 0)
{
if (desc.Type == FileDialogType::Save)
{
// The default file extension is taken from the **first** available filter, since
// we cannot obtain it from zenity's output. This means that the FileDialogDesc::Filters
// array must be carefully populated, at least the first element.
std::string pattern = desc.Filters[0].Pattern;
std::string defaultExtension = pattern.substr(pattern.find_last_of('.'));
const auto filename = Path::GetFileName(output.c_str());
// If there is no extension, append the pattern
const auto extension = Path::GetExtension(filename);
result = output;
if (extension[0] == '\0' && !defaultExtension.empty())
{
result = output.append(defaultExtension);
}
}
else
{
result = output;
}
}
break;
}
default:
ThrowMissingDialogApp();
break;
}
if (!result.empty())
{
if (desc.Type == FileDialogType::Open && access(result.c_str(), F_OK) == -1)
{
std::string msg = String::StdFormat(
"\"%s\" not found: %s, please choose another file\n", result.c_str(), strerror(errno));
ShowMessageBox(window, msg);
return ShowFileDialog(window, desc);
}
if (desc.Type == FileDialogType::Save && access(result.c_str(), F_OK) != -1 && dtype == DIALOG_TYPE::KDIALOG)
{
std::string cmd = String::StdFormat("%s --yesno \"Overwrite %s?\"", executablePath.c_str(), result.c_str());
if (Platform::Execute(cmd) != 0)
{
result = std::string();
}
}
}
return result;
}
std::string ShowDirectoryDialog(SDL_Window* window, const std::string& title) override
{
std::string result;
std::string executablePath;
DIALOG_TYPE dtype = GetDialogApp(&executablePath);
switch (dtype)
{
case DIALOG_TYPE::KDIALOG:
{
std::string output;
std::string cmd = String::StdFormat(
"%s --title '%s' --getexistingdirectory /", executablePath.c_str(), title.c_str());
if (Platform::Execute(cmd, &output) == 0)
{
result = output;
}
break;
}
case DIALOG_TYPE::ZENITY:
{
std::string output;
std::string cmd = String::StdFormat(
"%s --title='%s' --file-selection --directory /", executablePath.c_str(), title.c_str());
if (Platform::Execute(cmd, &output) == 0)
{
result = output;
}
break;
}
default:
ThrowMissingDialogApp();
break;
}
return result;
}
bool HasFilePicker() const override
{
if (!_hasFilePicker.has_value())
{
std::string dummy;
_hasFilePicker = (GetDialogApp(&dummy) != DIALOG_TYPE::NONE);
}
return _hasFilePicker.value();
}
bool HasMenuSupport() override
{
std::string executablePath;
DIALOG_TYPE dtype = GetDialogApp(&executablePath);
return dtype != DIALOG_TYPE::NONE;
}
int32_t ShowMenuDialog(
const std::vector<std::string>& options, const std::string& title, const std::string& text) override
{
std::string executablePath;
DIALOG_TYPE dtype = GetDialogApp(&executablePath);
size_t longest_string = 0;
for (const auto& option : options)
{
if (option.size() > longest_string)
{
longest_string = option.size();
}
}
// zenity and kdialog don't support automatic scaling, this is an approximation
int width = (longest_string + 1) * 8;
int height = (options.size() + 1) * 8;
switch (dtype)
{
case DIALOG_TYPE::ZENITY:
{
auto sb = StringBuilder();
sb.Append(String::StdFormat("zenity --list --column '' --width=%d --height=%d", width, height));
for (const auto& option : options)
{
sb.Append(String::StdFormat(" '%s'", option.c_str()));
}
sb.Append(String::StdFormat(" --title '%s' --text '%s'", title.c_str(), text.c_str()));
std::string buff;
Platform::Execute(sb.GetBuffer(), &buff);
return std::find(options.begin(), options.end(), buff) - options.begin();
}
case DIALOG_TYPE::KDIALOG:
{
auto sb = StringBuilder();
sb.Append(String::StdFormat("kdialog --geometry %dx%d --title '%s' --menu ", width, height, title.c_str()));
sb.Append(String::StdFormat(" '%s'", text.c_str()));
for (const auto& option : options)
{
sb.Append(String::StdFormat(" '%s' '%s'", option.c_str(), option.c_str()));
}
std::string buff;
Platform::Execute(sb.GetBuffer(), &buff);
return std::find(options.begin(), options.end(), buff) - options.begin();
}
default:
{
break;
}
}
return options.size();
}
private:
static DIALOG_TYPE GetDialogApp(std::string* executablePath)
{
// Prefer zenity as it offers more required features, e.g., overwrite
// confirmation and selecting only existing files.
// Silence error output with 2> /dev/null to avoid confusion in the
// case where a user does not have zenity and/or kdialog.
// OpenRCT2 will fall back to an SDL pop-up if the user has neither.
if (Platform::FindApp("zenity", executablePath))
{
return DIALOG_TYPE::ZENITY;
}
if (Platform::FindApp("kdialog", executablePath))
{
return DIALOG_TYPE::KDIALOG;
}
return DIALOG_TYPE::NONE;
}
static std::string GetKDialogFilterString(const std::vector<FileDialogDesc::Filter> filters)
{
std::stringstream filtersb;
bool first = true;
for (const auto& filter : filters)
{
if (!first)
{
filtersb << "\\n";
}
first = false;
filtersb << filter.Name.c_str() << " (";
AddFilterCaseInsensitive(filtersb, filter.Pattern);
filtersb << ")";
}
return filtersb.str();
}
static std::string GetZenityFilterString(const std::vector<FileDialogDesc::Filter> filters)
{
std::stringstream filtersb;
for (const auto& filter : filters)
{
filtersb << " --file-filter='" << filter.Name << " | ";
AddFilterCaseInsensitive(filtersb, filter.Pattern);
filtersb << "'";
}
return filtersb.str();
}
static void AddFilterCaseInsensitive(std::stringstream& stream, u8string pattern)
{
for (char c : pattern)
{
if (c == ';')
{
stream << ' ';
}
else if (isalpha(static_cast<unsigned char>(c)))
{
auto uc = static_cast<unsigned char>(c);
stream << '[' << static_cast<char>(tolower(uc)) << static_cast<char>(toupper(uc)) << ']';
}
else
{
stream << c;
}
}
}
static void ThrowMissingDialogApp()
{
auto uiContext = GetContext()->GetUiContext();
std::string dialogMissingWarning = LanguageGetString(STR_MISSING_DIALOG_APPLICATION_ERROR);
uiContext->ShowMessageBox(dialogMissingWarning);
throw std::runtime_error(dialogMissingWarning);
}
static std::string EscapePathForShell(std::string path)
{
for (size_t index = 0; (index = path.find('"', index)) != std::string::npos; index += 2)
{
path.replace(index, 1, "\\\"");
}
return '"' + path + '"';
}
};
std::unique_ptr<IPlatformUiContext> CreatePlatformUiContext()
{
return std::make_unique<LinuxContext>();
}
} // namespace OpenRCT2::Ui
#endif // (defined(__unix__) || defined(__EMSCRIPTEN__)) && !defined(__ANDROID__) && !defined(__APPLE__)