mirror of
https://github.com/Cockatrice/Cockatrice.git
synced 2026-06-12 19:11:31 -07:00
seavor
371b74732e
Adds OS-level URL-scheme handlers so users can click a link in a browser,
chat client, or third-party tool to launch Cockatrice straight into a
server / game / Oracle update.
Supported URL forms:
cockatrice://joingame?hostname=H&port=P&roomid=R&gameid=G[&spectate=1]
cockatrice-oracle://update[?spoilers=1]
Credentials passed via URL (username/password query params) are deliberately
ignored — URLs leak through shell history, browser history, EDR capture, etc.
If the target server requires auth and no saved credentials match, the Connect
dialog opens pre-filled with the URL's host/port so the user types their
password locally.
OS integration
- Linux: MimeType=x-scheme-handler/cockatrice (and -oracle) added to the
.desktop files; Exec=cockatrice %u passes the URL through.
- Windows: NSIS installer writes HKCR\cockatrice and HKCR\cockatrice-oracle
registry entries; uninstaller removes them.
- macOS: per-app Info.cockatrice.plist / Info.oracle.plist declare
CFBundleURLTypes; a QFileOpenEvent filter is installed on QApplication
before any nested event loop so cold-start URLs aren't lost.
New abstractions
- Intent (libcockatrice_utility/libcockatrice/utility/intent.h): abstract base
for chained async actions. Guarantees finished() fires at most once,
execute() is idempotent, self-deletes via deleteLater, and
startTimeoutSafetyNet() arms a configurable per-stage deadline. Concrete
intents (IntentConnectToServer, IntentLogin, IntentJoinServerRoom,
IntentJoinServerGame) compose the joingame flow via UrlParser.
- SingleInstanceManager: async per-user local-socket primary/secondary
handshake; URL forwarded from secondary to primary with QDataStream framing
both ways. shared_ptr-backed resolved flag survives every lambda capture.
- UrlSchemeEventFilter (new libcockatrice_utility_gui sibling library): QObject
event filter that translates macOS QFileOpenEvent into a urlReceived(QString)
signal. Lives in its own Gui-bearing lib so libcockatrice_utility stays
Core+Network only and doesn't drag Qt::Gui into servatrice.
- UrlUtils (header-only): pure URL parsing, fully unit-tested.
Wiring
- MainWindow::handleUrl(QString) — single entry point for any URL source.
- DlgConnect::prefillNewHost(host, port) — pre-fills new-host inputs.
- ServersSettings::findSavedCredsByHostPort — case-insensitive saved-creds
lookup.
- TabSupervisor::requestJoinRoom + roomJoinedById / roomJoinFailedById signals,
TabServer::roomAlreadyJoined for the short-circuit "already in this room"
path — single source of truth for duplicate-join handling.
Tests
- 36 new unit tests across four single-purpose targets in tests/:
- url_utils_test (22 tests) — scheme matching, port/room/game validation,
spectator flag, credentials ignored, case-insensitivity.
- url_scheme_event_filter_test (3 tests) — QFileOpenEvent capture.
- intent_test (7 tests) — self-delete, abort propagation, parent-destruction-
mid-flight, finish-once gate, execute() idempotence.
- single_instance_manager_test (4 tests) — per-user socket naming, becoming-
primary alone, forwarding to an existing primary, single-emission of
roleResolved.
Build tooling (incidental)
- Dockerfile.format, docker-compose.format.yml, Makefile — a docker-based
runner for format.sh that mirrors CI's desktop-lint step.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
188 lines
6.8 KiB
C++
188 lines
6.8 KiB
C++
#include "gtest/gtest.h"
|
|
#include <QCoreApplication>
|
|
#include <libcockatrice/utility/url_utils.h>
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// UrlUtils::findUrlArgument
|
|
// ---------------------------------------------------------------------------
|
|
|
|
TEST(UrlUtilsTest, FindsMatchingArgument)
|
|
{
|
|
const QStringList args{QStringLiteral("--debug"),
|
|
QStringLiteral("cockatrice://joingame?hostname=example.com&port=4748")};
|
|
ASSERT_EQ(UrlUtils::findUrlArgument(args, QStringLiteral("cockatrice://")),
|
|
QStringLiteral("cockatrice://joingame?hostname=example.com&port=4748"));
|
|
}
|
|
|
|
TEST(UrlUtilsTest, ReturnsEmptyStringWhenNoMatch)
|
|
{
|
|
const QStringList args{QStringLiteral("--debug"), QStringLiteral("foo"), QStringLiteral("bar")};
|
|
ASSERT_TRUE(UrlUtils::findUrlArgument(args, QStringLiteral("cockatrice://")).isEmpty());
|
|
}
|
|
|
|
TEST(UrlUtilsTest, FindsArgumentCaseInsensitively)
|
|
{
|
|
const QStringList args{QStringLiteral("Cockatrice://joingame?hostname=example.com&port=4748")};
|
|
ASSERT_EQ(UrlUtils::findUrlArgument(args, QStringLiteral("cockatrice://")),
|
|
QStringLiteral("Cockatrice://joingame?hostname=example.com&port=4748"));
|
|
}
|
|
|
|
TEST(UrlUtilsTest, ReturnsFirstMatchOnly)
|
|
{
|
|
const QStringList args{QStringLiteral("cockatrice://joingame?first=1"),
|
|
QStringLiteral("cockatrice://joingame?second=2")};
|
|
ASSERT_EQ(UrlUtils::findUrlArgument(args, QStringLiteral("cockatrice://")),
|
|
QStringLiteral("cockatrice://joingame?first=1"));
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// UrlUtils::parseOracleUrl
|
|
// ---------------------------------------------------------------------------
|
|
|
|
TEST(ParseOracleUrlTest, RecognisesUpdate)
|
|
{
|
|
const auto action = UrlUtils::parseOracleUrl(QStringLiteral("cockatrice-oracle://update"));
|
|
ASSERT_TRUE(action.isUpdate);
|
|
ASSERT_FALSE(action.spoilersOnly);
|
|
}
|
|
|
|
TEST(ParseOracleUrlTest, RecognisesUpdateWithSpoilers)
|
|
{
|
|
const auto action = UrlUtils::parseOracleUrl(QStringLiteral("cockatrice-oracle://update?spoilers=1"));
|
|
ASSERT_TRUE(action.isUpdate);
|
|
ASSERT_TRUE(action.spoilersOnly);
|
|
}
|
|
|
|
TEST(ParseOracleUrlTest, IgnoresUnknownHost)
|
|
{
|
|
const auto action = UrlUtils::parseOracleUrl(QStringLiteral("cockatrice-oracle://unrelated"));
|
|
ASSERT_FALSE(action.isUpdate);
|
|
}
|
|
|
|
TEST(ParseOracleUrlTest, MatchesHostCaseInsensitively)
|
|
{
|
|
const auto action = UrlUtils::parseOracleUrl(QStringLiteral("cockatrice-oracle://UPDATE"));
|
|
ASSERT_TRUE(action.isUpdate);
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// UrlUtils::parseJoinGameUrl
|
|
// ---------------------------------------------------------------------------
|
|
|
|
namespace
|
|
{
|
|
const QString kValidUrl = QStringLiteral("cockatrice://joingame?hostname=example.com&port=4748&roomid=1&gameid=42");
|
|
}
|
|
|
|
TEST(ParseJoinGameUrlTest, ParsesHappyPath)
|
|
{
|
|
const auto parsed = UrlUtils::parseJoinGameUrl(kValidUrl);
|
|
ASSERT_TRUE(parsed.has_value());
|
|
ASSERT_EQ(parsed->hostname, QStringLiteral("example.com"));
|
|
ASSERT_EQ(parsed->port, 4748);
|
|
ASSERT_EQ(parsed->roomId, 1);
|
|
ASSERT_EQ(parsed->gameId, 42);
|
|
ASSERT_FALSE(parsed->spectator);
|
|
}
|
|
|
|
TEST(ParseJoinGameUrlTest, AcceptsSpectateFlag)
|
|
{
|
|
const auto parsed = UrlUtils::parseJoinGameUrl(kValidUrl + QStringLiteral("&spectate=1"));
|
|
ASSERT_TRUE(parsed.has_value());
|
|
ASSERT_TRUE(parsed->spectator);
|
|
}
|
|
|
|
TEST(ParseJoinGameUrlTest, SpectateZeroIsNotSpectator)
|
|
{
|
|
const auto parsed = UrlUtils::parseJoinGameUrl(kValidUrl + QStringLiteral("&spectate=0"));
|
|
ASSERT_TRUE(parsed.has_value());
|
|
ASSERT_FALSE(parsed->spectator);
|
|
}
|
|
|
|
TEST(ParseJoinGameUrlTest, MatchesSchemeCaseInsensitively)
|
|
{
|
|
const auto parsed = UrlUtils::parseJoinGameUrl(
|
|
QStringLiteral("Cockatrice://joingame?hostname=example.com&port=4748&roomid=1&gameid=42"));
|
|
ASSERT_TRUE(parsed.has_value());
|
|
}
|
|
|
|
TEST(ParseJoinGameUrlTest, RejectsInvalidScheme)
|
|
{
|
|
const auto parsed =
|
|
UrlUtils::parseJoinGameUrl(QStringLiteral("http://joingame?hostname=example.com&port=4748&roomid=1&gameid=42"));
|
|
ASSERT_FALSE(parsed.has_value());
|
|
}
|
|
|
|
TEST(ParseJoinGameUrlTest, RejectsUnsupportedHost)
|
|
{
|
|
const auto parsed = UrlUtils::parseJoinGameUrl(
|
|
QStringLiteral("cockatrice://something?hostname=example.com&port=4748&roomid=1&gameid=42"));
|
|
ASSERT_FALSE(parsed.has_value());
|
|
}
|
|
|
|
TEST(ParseJoinGameUrlTest, RejectsMissingHostname)
|
|
{
|
|
const auto parsed =
|
|
UrlUtils::parseJoinGameUrl(QStringLiteral("cockatrice://joingame?port=4748&roomid=1&gameid=42"));
|
|
ASSERT_FALSE(parsed.has_value());
|
|
}
|
|
|
|
TEST(ParseJoinGameUrlTest, RejectsZeroPort)
|
|
{
|
|
const auto parsed = UrlUtils::parseJoinGameUrl(
|
|
QStringLiteral("cockatrice://joingame?hostname=example.com&port=0&roomid=1&gameid=42"));
|
|
ASSERT_FALSE(parsed.has_value());
|
|
}
|
|
|
|
TEST(ParseJoinGameUrlTest, RejectsOutOfRangePort)
|
|
{
|
|
const auto parsed = UrlUtils::parseJoinGameUrl(
|
|
QStringLiteral("cockatrice://joingame?hostname=example.com&port=99999&roomid=1&gameid=42"));
|
|
ASSERT_FALSE(parsed.has_value());
|
|
}
|
|
|
|
TEST(ParseJoinGameUrlTest, RejectsNonNumericPort)
|
|
{
|
|
const auto parsed = UrlUtils::parseJoinGameUrl(
|
|
QStringLiteral("cockatrice://joingame?hostname=example.com&port=abc&roomid=1&gameid=42"));
|
|
ASSERT_FALSE(parsed.has_value());
|
|
}
|
|
|
|
TEST(ParseJoinGameUrlTest, RejectsNegativeRoomId)
|
|
{
|
|
const auto parsed = UrlUtils::parseJoinGameUrl(
|
|
QStringLiteral("cockatrice://joingame?hostname=example.com&port=4748&roomid=-1&gameid=42"));
|
|
ASSERT_FALSE(parsed.has_value());
|
|
}
|
|
|
|
TEST(ParseJoinGameUrlTest, RejectsNegativeGameId)
|
|
{
|
|
const auto parsed = UrlUtils::parseJoinGameUrl(
|
|
QStringLiteral("cockatrice://joingame?hostname=example.com&port=4748&roomid=1&gameid=-1"));
|
|
ASSERT_FALSE(parsed.has_value());
|
|
}
|
|
|
|
TEST(ParseJoinGameUrlTest, IgnoresCredentialQueryParams)
|
|
{
|
|
// Regression test for the security blocker: even if username/password are
|
|
// present in the URL (e.g. legacy bookmark), they must not surface in the
|
|
// parsed output. Parsing should succeed and yield the same params as the
|
|
// equivalent URL without those fields.
|
|
const auto withCreds = UrlUtils::parseJoinGameUrl(kValidUrl + QStringLiteral("&username=alice&password=hunter2"));
|
|
const auto withoutCreds = UrlUtils::parseJoinGameUrl(kValidUrl);
|
|
ASSERT_TRUE(withCreds.has_value());
|
|
ASSERT_TRUE(withoutCreds.has_value());
|
|
ASSERT_EQ(withCreds->hostname, withoutCreds->hostname);
|
|
ASSERT_EQ(withCreds->port, withoutCreds->port);
|
|
ASSERT_EQ(withCreds->roomId, withoutCreds->roomId);
|
|
ASSERT_EQ(withCreds->gameId, withoutCreds->gameId);
|
|
ASSERT_EQ(withCreds->spectator, withoutCreds->spectator);
|
|
}
|
|
|
|
int main(int argc, char **argv)
|
|
{
|
|
QCoreApplication app(argc, argv);
|
|
::testing::InitGoogleTest(&argc, argv);
|
|
return RUN_ALL_TESTS();
|
|
}
|