PrismLauncher/launcher/ui/pages/instance/ServersPage.cpp

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

842 lines
22 KiB
C++
Raw Normal View History

2022-03-20 19:01:08 +00:00
// SPDX-License-Identifier: GPL-3.0-only
/*
* Prism Launcher - Minecraft Launcher
2022-03-20 19:01:08 +00:00
* Copyright (c) 2022 Jamie Mansfield <jmansfield@cadixdev.org>
2022-06-12 12:50:58 +01:00
* Copyright (C) 2022 Sefa Eyeoglu <contact@scrumplex.net>
* Copyright (C) 2023 TheKodeToad <TheKodeToad@proton.me>
2022-03-20 19:01:08 +00:00
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, version 3.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Copyright 2013-2021 MultiMC Contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "ServersPage.h"
#include "ui/dialogs/CustomMessageBox.h"
#include "ui_ServersPage.h"
#include <FileSystem.h>
#include <sstream>
#include <io/stream_reader.h>
#include <tag_string.h>
#include <tag_primitive.h>
#include <tag_list.h>
#include <tag_compound.h>
#include <minecraft/MinecraftInstance.h>
#include <QFileSystemWatcher>
#include <QMenu>
#include <QTimer>
static const int COLUMN_COUNT = 2; // 3 , TBD: latency and other nice things.
struct Server
{
// Types
enum class AcceptsTextures : int
{
ASK = 0,
ALWAYS = 1,
NEVER = 2
};
2018-07-15 13:51:05 +01:00
// Methods
Server()
{
m_name = QObject::tr("Minecraft Server");
}
Server(const QString & name, const QString & address)
{
m_name = name;
m_address = address;
}
Server(nbt::tag_compound& server)
{
std::string addressStr(server["ip"]);
2019-03-29 15:25:37 +00:00
m_address = QString::fromUtf8(addressStr.c_str());
2018-07-15 13:51:05 +01:00
std::string nameStr(server["name"]);
2019-03-29 15:25:37 +00:00
m_name = QString::fromUtf8(nameStr.c_str());
2018-07-15 13:51:05 +01:00
if(server["icon"])
{
std::string base64str(server["icon"]);
m_icon = QByteArray::fromBase64(base64str.c_str());
}
2018-07-15 13:51:05 +01:00
if(server.has_key("acceptTextures", nbt::tag_type::Byte))
{
bool value = server["acceptTextures"].as<nbt::tag_byte>().get();
if(value)
{
m_acceptsTextures = AcceptsTextures::ALWAYS;
}
else
{
m_acceptsTextures = AcceptsTextures::NEVER;
}
}
}
2018-07-15 13:51:05 +01:00
void serialize(nbt::tag_compound& server)
{
2019-03-29 15:25:37 +00:00
server.insert("name", m_name.trimmed().toUtf8().toStdString());
server.insert("ip", m_address.trimmed().toUtf8().toStdString());
if(m_icon.size())
{
server.insert("icon", m_icon.toBase64().toStdString());
}
if(m_acceptsTextures != AcceptsTextures::ASK)
{
server.insert("acceptTextures", nbt::tag_byte(m_acceptsTextures == AcceptsTextures::ALWAYS));
}
}
2018-07-15 13:51:05 +01:00
// Data - persistent and user changeable
QString m_name;
QString m_address;
AcceptsTextures m_acceptsTextures = AcceptsTextures::ASK;
2018-07-15 13:51:05 +01:00
// Data - persistent and automatically updated
QByteArray m_icon;
2018-07-15 13:51:05 +01:00
// Data - temporary
bool m_checked = false;
bool m_up = false;
QString m_motd; // https://mctools.org/motd-creator
int m_ping = 0;
int m_currentPlayers = 0;
int m_maxPlayers = 0;
};
static std::unique_ptr <nbt::tag_compound> parseServersDat(const QString& filename)
{
try
{
QByteArray input = FS::read(filename);
std::istringstream foo(std::string(input.constData(), input.size()));
auto pair = nbt::io::read_compound(foo);
2018-07-15 13:51:05 +01:00
if(pair.first != "")
return nullptr;
2018-07-15 13:51:05 +01:00
if(pair.second == nullptr)
return nullptr;
2018-07-15 13:51:05 +01:00
return std::move(pair.second);
}
catch (...)
{
return nullptr;
}
}
static bool serializeServerDat(const QString& filename, nbt::tag_compound * levelInfo)
{
try
{
if(!FS::ensureFilePathExists(filename))
{
return false;
}
std::ostringstream s;
nbt::io::write_tag("", *levelInfo, s);
QByteArray val(s.str().data(), (int) s.str().size() );
FS::write(filename, val);
return true;
}
catch (...)
{
return false;
}
}
class ServersModel: public QAbstractListModel
{
Q_OBJECT
public:
enum Roles
{
ServerPtrRole = Qt::UserRole,
};
explicit ServersModel(const QString &path, QObject *parent = 0)
: QAbstractListModel(parent)
{
m_path = path;
m_watcher = new QFileSystemWatcher(this);
connect(m_watcher, &QFileSystemWatcher::fileChanged, this, &ServersModel::fileChanged);
connect(m_watcher, &QFileSystemWatcher::directoryChanged, this, &ServersModel::dirChanged);
m_saveTimer.setSingleShot(true);
m_saveTimer.setInterval(5000);
connect(&m_saveTimer, &QTimer::timeout, this, &ServersModel::save_internal);
}
virtual ~ServersModel() {};
2018-07-15 13:51:05 +01:00
void observe()
{
if(m_observed)
{
return;
}
m_observed = true;
2018-07-15 13:51:05 +01:00
if(!m_loaded)
{
load();
}
2018-07-15 13:51:05 +01:00
updateFSObserver();
}
2018-07-15 13:51:05 +01:00
void unobserve()
{
if(!m_observed)
{
return;
}
m_observed = false;
2018-07-15 13:51:05 +01:00
updateFSObserver();
}
2018-07-15 13:51:05 +01:00
void lock()
{
if(m_locked)
{
return;
}
saveNow();
2018-07-15 13:51:05 +01:00
m_locked = true;
updateFSObserver();
}
2018-07-15 13:51:05 +01:00
void unlock()
{
if(!m_locked)
{
return;
}
m_locked = false;
2018-07-15 13:51:05 +01:00
updateFSObserver();
}
2018-07-15 13:51:05 +01:00
int addEmptyRow(int position)
{
if(m_locked)
{
return -1;
}
if(position < 0 || position >= rowCount())
{
position = rowCount();
}
beginInsertRows(QModelIndex(), position, position);
m_servers.insert(position, Server());
endInsertRows();
scheduleSave();
return position;
}
2018-07-15 13:51:05 +01:00
bool removeRow(int row)
{
if(m_locked)
{
return false;
}
if(row < 0 || row >= rowCount())
{
return false;
}
beginRemoveRows(QModelIndex(), row, row);
m_servers.removeAt(row);
endRemoveRows(); // does absolutely nothing, the selected server stays as the next line...
scheduleSave();
return true;
}
2018-07-15 13:51:05 +01:00
bool moveUp(int row)
{
if(m_locked)
{
return false;
}
if(row <= 0)
{
return false;
}
beginMoveRows(QModelIndex(), row, row, QModelIndex(), row - 1);
#if QT_VERSION >= QT_VERSION_CHECK(5, 13, 0)
m_servers.swapItemsAt(row-1, row);
#else
m_servers.swap(row-1, row);
#endif
endMoveRows();
scheduleSave();
return true;
}
2018-07-15 13:51:05 +01:00
bool moveDown(int row)
{
if(m_locked)
{
return false;
}
int count = rowCount();
if(row + 1 >= count)
{
return false;
}
beginMoveRows(QModelIndex(), row, row, QModelIndex(), row + 2);
#if QT_VERSION >= QT_VERSION_CHECK(5, 13, 0)
m_servers.swapItemsAt(row+1, row);
#else
m_servers.swap(row+1, row);
#endif
endMoveRows();
scheduleSave();
return true;
}
2018-07-15 13:51:05 +01:00
QVariant headerData(int section, Qt::Orientation orientation, int role) const override
{
if (section < 0 || section >= COLUMN_COUNT)
return QVariant();
2018-07-15 13:51:05 +01:00
if(role == Qt::DisplayRole)
{
switch(section)
{
case 0:
return tr("Name");
case 1:
return tr("Address");
case 2:
return tr("Latency");
}
}
2018-07-15 13:51:05 +01:00
return QAbstractListModel::headerData(section, orientation, role);
}
2018-07-15 13:51:05 +01:00
virtual QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override
{
if (!index.isValid())
return QVariant();
2018-07-15 13:51:05 +01:00
int row = index.row();
int column = index.column();
if(column < 0 || column >= COLUMN_COUNT)
return QVariant();
2018-07-15 13:51:05 +01:00
if (row < 0 || row >= m_servers.size())
return QVariant();
2018-07-15 13:51:05 +01:00
switch(column)
{
case 0:
switch (role)
{
case Qt::DecorationRole:
{
auto & bytes = m_servers[row].m_icon;
if(bytes.size())
{
QPixmap px;
if(px.loadFromData(bytes))
return QIcon(px);
}
2021-11-20 15:22:22 +00:00
return APPLICATION->getThemedIcon("unknown_server");
}
case Qt::DisplayRole:
return m_servers[row].m_name;
case ServerPtrRole:
return QVariant::fromValue<void *>((void *)&m_servers[row]);
default:
return QVariant();
}
case 1:
switch (role)
{
case Qt::DisplayRole:
return m_servers[row].m_address;
default:
return QVariant();
}
case 2:
switch (role)
{
case Qt::DisplayRole:
return m_servers[row].m_ping;
default:
return QVariant();
}
default:
return QVariant();
}
}
2018-07-15 13:51:05 +01:00
virtual int rowCount(const QModelIndex &parent = QModelIndex()) const override
{
return parent.isValid() ? 0 : m_servers.size();
}
int columnCount(const QModelIndex & parent) const override
{
return parent.isValid() ? 0 : COLUMN_COUNT;
}
2018-07-15 13:51:05 +01:00
Server * at(int index)
{
if(index < 0 || index >= rowCount())
{
return nullptr;
}
return &m_servers[index];
}
2018-07-15 13:51:05 +01:00
void setName(int row, const QString & name)
{
if(m_locked)
{
return;
}
auto server = at(row);
if(!server || server->m_name == name)
{
return;
}
server->m_name = name;
emit dataChanged(index(row, 0), index(row, COLUMN_COUNT - 1));
scheduleSave();
}
2018-07-15 13:51:05 +01:00
void setAddress(int row, const QString & address)
{
if(m_locked)
{
return;
}
auto server = at(row);
if(!server || server->m_address == address)
{
return;
}
server->m_address = address;
emit dataChanged(index(row, 0), index(row, COLUMN_COUNT - 1));
scheduleSave();
}
2018-07-15 13:51:05 +01:00
void setAcceptsTextures(int row, Server::AcceptsTextures textures)
{
if(m_locked)
{
return;
}
auto server = at(row);
if(!server || server->m_acceptsTextures == textures)
{
return;
}
server->m_acceptsTextures = textures;
emit dataChanged(index(row, 0), index(row, COLUMN_COUNT - 1));
scheduleSave();
}
2018-07-15 13:51:05 +01:00
void load()
{
cancelSave();
beginResetModel();
QList<Server> servers;
auto serversDat = parseServersDat(serversPath());
if(serversDat)
{
auto &serversList = serversDat->at("servers").as<nbt::tag_list>();
for(auto iter = serversList.begin(); iter != serversList.end(); iter++)
{
auto & serverTag = (*iter).as<nbt::tag_compound>();
Server s(serverTag);
servers.append(s);
}
}
m_servers.swap(servers);
m_loaded = true;
endResetModel();
}
2018-07-15 13:51:05 +01:00
void saveNow()
{
if(saveIsScheduled())
{
save_internal();
}
}
public slots:
void dirChanged(const QString& path)
{
qDebug() << "Changed:" << path;
load();
}
void fileChanged(const QString& path)
{
qDebug() << "Changed:" << path;
}
private slots:
void save_internal()
{
cancelSave();
QString path = serversPath();
qDebug() << "Server list about to be saved to" << path;
2018-07-15 13:51:05 +01:00
nbt::tag_compound out;
nbt::tag_list list;
for(auto & server: m_servers)
{
nbt::tag_compound serverNbt;
server.serialize(serverNbt);
list.push_back(std::move(serverNbt));
}
out.insert("servers", nbt::value(std::move(list)));
2018-07-15 13:51:05 +01:00
if(!serializeServerDat(path, &out))
{
qDebug() << "Failed to save server list:" << path << "Will try again.";
scheduleSave();
}
}
private:
void scheduleSave()
{
if(!m_loaded)
{
qDebug() << "Server list should never save if it didn't successfully load, path:" << m_path;
return;
}
if(!m_dirty)
{
m_dirty = true;
qDebug() << "Server list save is scheduled for" << m_path;
}
m_saveTimer.start();
}
2018-07-15 13:51:05 +01:00
void cancelSave()
{
m_dirty = false;
m_saveTimer.stop();
}
2018-07-15 13:51:05 +01:00
bool saveIsScheduled() const
{
return m_dirty;
}
2018-07-15 13:51:05 +01:00
void updateFSObserver()
{
bool observingFS = m_watcher->directories().contains(m_path);
if(m_observed && m_locked)
{
if(!observingFS)
{
qWarning() << "Will watch" << m_path;
if(!m_watcher->addPath(m_path))
{
qWarning() << "Failed to start watching" << m_path;
}
}
}
else
{
if(observingFS)
{
qWarning() << "Will stop watching" << m_path;
if(!m_watcher->removePath(m_path))
{
qWarning() << "Failed to stop watching" << m_path;
}
}
}
}
2018-07-15 13:51:05 +01:00
QString serversPath()
{
QFileInfo foo(FS::PathCombine(m_path, "servers.dat"));
return foo.filePath();
}
private:
bool m_loaded = false;
bool m_locked = false;
bool m_observed = false;
bool m_dirty = false;
QString m_path;
QList<Server> m_servers;
QFileSystemWatcher *m_watcher = nullptr;
QTimer m_saveTimer;
};
ServersPage::ServersPage(InstancePtr inst, QWidget* parent)
: QMainWindow(parent), ui(new Ui::ServersPage)
{
ui->setupUi(this);
m_inst = inst;
m_model = new ServersModel(inst->gameRoot(), this);
ui->serversView->setIconSize(QSize(64,64));
ui->serversView->setModel(m_model);
ui->serversView->setContextMenuPolicy(Qt::CustomContextMenu);
connect(ui->serversView, &QTreeView::customContextMenuRequested, this, &ServersPage::ShowContextMenu);
auto head = ui->serversView->header();
if(head->count())
{
head->setSectionResizeMode(0, QHeaderView::Stretch);
for(int i = 1; i < head->count(); i++)
{
head->setSectionResizeMode(i, QHeaderView::ResizeToContents);
}
}
2018-07-15 13:51:05 +01:00
auto selectionModel = ui->serversView->selectionModel();
connect(selectionModel, &QItemSelectionModel::currentChanged, this, &ServersPage::currentChanged);
connect(m_inst.get(), &MinecraftInstance::runningStatusChanged, this, &ServersPage::runningStateChanged);
connect(ui->nameLine, &QLineEdit::textEdited, this, &ServersPage::nameEdited);
connect(ui->addressLine, &QLineEdit::textEdited, this, &ServersPage::addressEdited);
connect(ui->resourceComboBox, SIGNAL(currentIndexChanged(int)), this, SLOT(resourceIndexChanged(int)));
connect(m_model, &QAbstractItemModel::rowsRemoved, this, &ServersPage::rowsRemoved);
2018-07-15 13:51:05 +01:00
m_locked = m_inst->isRunning();
if(m_locked)
{
m_model->lock();
}
2018-07-15 13:51:05 +01:00
updateState();
}
ServersPage::~ServersPage()
{
m_model->saveNow();
2019-08-10 18:58:58 +01:00
delete ui;
}
void ServersPage::retranslate()
{
ui->retranslateUi(this);
}
void ServersPage::ShowContextMenu(const QPoint& pos)
{
auto menu = ui->toolBar->createContextMenu(this, tr("Context menu"));
menu->exec(ui->serversView->mapToGlobal(pos));
delete menu;
}
QMenu * ServersPage::createPopupMenu()
{
QMenu* filteredMenu = QMainWindow::createPopupMenu();
filteredMenu->removeAction( ui->toolBar->toggleViewAction() );
return filteredMenu;
}
void ServersPage::runningStateChanged(bool running)
{
if(m_locked == running)
{
return;
}
m_locked = running;
if(m_locked)
{
m_model->lock();
}
else
{
m_model->unlock();
}
updateState();
}
void ServersPage::currentChanged(const QModelIndex &current, const QModelIndex &previous)
{
int nextServer = -1;
if (!current.isValid())
{
nextServer = -1;
}
else
{
nextServer = current.row();
}
currentServer = nextServer;
updateState();
}
// WARNING: this is here because currentChanged is not accurate when removing rows. the current item needs to be fixed up after removal.
void ServersPage::rowsRemoved(const QModelIndex& parent, int first, int last)
{
if(currentServer < first)
{
// current was before the removal
return;
}
else if(currentServer >= first && currentServer <= last)
{
// current got removed...
return;
}
else
{
// current was past the removal
int count = last - first + 1;
currentServer -= count;
}
}
void ServersPage::nameEdited(const QString& name)
{
m_model->setName(currentServer, name);
}
void ServersPage::addressEdited(const QString& address)
{
m_model->setAddress(currentServer, address);
}
void ServersPage::resourceIndexChanged(int index)
{
auto acceptsTextures = Server::AcceptsTextures(index);
m_model->setAcceptsTextures(currentServer, acceptsTextures);
}
void ServersPage::updateState()
{
auto server = m_model->at(currentServer);
2018-07-15 13:51:05 +01:00
bool serverEditEnabled = server && !m_locked;
ui->addressLine->setEnabled(serverEditEnabled);
ui->nameLine->setEnabled(serverEditEnabled);
ui->resourceComboBox->setEnabled(serverEditEnabled);
ui->actionMove_Down->setEnabled(serverEditEnabled);
ui->actionMove_Up->setEnabled(serverEditEnabled);
ui->actionRemove->setEnabled(serverEditEnabled);
ui->actionJoin->setEnabled(serverEditEnabled);
2018-07-15 13:51:05 +01:00
if(server)
{
ui->addressLine->setText(server->m_address);
ui->nameLine->setText(server->m_name);
ui->resourceComboBox->setCurrentIndex(int(server->m_acceptsTextures));
}
else
{
ui->addressLine->setText(QString());
ui->nameLine->setText(QString());
ui->resourceComboBox->setCurrentIndex(0);
}
2018-07-15 13:51:05 +01:00
ui->actionAdd->setDisabled(m_locked);
}
void ServersPage::openedImpl()
{
m_model->observe();
auto const setting_name = QString("WideBarVisibility_%1").arg(id());
if (!APPLICATION->settings()->contains(setting_name))
m_wide_bar_setting = APPLICATION->settings()->registerSetting(setting_name);
else
m_wide_bar_setting = APPLICATION->settings()->getSetting(setting_name);
ui->toolBar->setVisibilityState(m_wide_bar_setting->get().toByteArray());
}
void ServersPage::closedImpl()
{
m_model->unobserve();
m_wide_bar_setting->set(ui->toolBar->getVisibilityState());
}
void ServersPage::on_actionAdd_triggered()
{
int position = m_model->addEmptyRow(currentServer + 1);
if(position < 0)
{
return;
}
// select the new row
ui->serversView->selectionModel()->setCurrentIndex(
m_model->index(position),
QItemSelectionModel::SelectCurrent | QItemSelectionModel::Clear | QItemSelectionModel::Rows
);
currentServer = position;
}
void ServersPage::on_actionRemove_triggered()
{
auto response = CustomMessageBox::selectable(this, tr("Confirm Removal"),
tr("You are about to remove \"%1\".\n"
"This is permanent and the server will be gone from your list forever (A LONG TIME).\n\n"
"Are you sure?")
.arg(m_model->at(currentServer)->m_name),
QMessageBox::Warning, QMessageBox::Yes | QMessageBox::No, QMessageBox::No)
->exec();
if (response != QMessageBox::Yes)
return;
m_model->removeRow(currentServer);
}
void ServersPage::on_actionMove_Up_triggered()
{
if(m_model->moveUp(currentServer))
{
currentServer --;
}
}
void ServersPage::on_actionMove_Down_triggered()
{
if(m_model->moveDown(currentServer))
{
currentServer ++;
}
}
void ServersPage::on_actionJoin_triggered()
{
const auto &address = m_model->at(currentServer)->m_address;
APPLICATION->launch(m_inst, true, false, std::make_shared<MinecraftServerTarget>(MinecraftServerTarget::parse(address)));
}
#include "ServersPage.moc"