BruebachL b4e24f958a [Network] Do not format discarded debug messages, parse without memmove (#7606)
* [Network] Do not format discarded debug messages, parse without memmove

Protocol debug logging gets the full protobuf message rendered through
TextFormat and reflection. On the server this happened before every
session/room/game/moderator/admin/developer command, even though the
default Server_ProtocolHandler::logDebugMessage() is a no-op and even
when servatrice has no log file configured. On the clients the same
string was built as an argument to qCDebug(), which evaluates its
arguments regardless of whether the category is enabled.

Server_ProtocolHandler now exposes a virtual logsDebugMessages() hook.
The base implementation returns false, so handlers without a log
destination spend nothing. AbstractServerSocketInterface overrides it
with ServerLogger::isLoggingEnabled(), which checks the log file and the
server/writelog setting that logMessage() itself consults. All debug
message call sites check the hook before formatting. The client
send/receive paths check QLoggingCategory::isDebugEnabled() first, the
same pattern AbstractClient already uses for its slow-command warning.
ISL message decoding does the same.

Byte stream decoding called inputBuffer.remove(0, n) for the length
header and then again for every message. Each call shifts all remaining
bytes, so a read carrying k messages cost O(k * bytes remaining). The
three receive loops (remote client, TCP server interface, ISL interface)
now parse at a read offset and compact the consumed prefix once, when
they stop because a full message is not buffered yet. No buffering or
size-limit behavior changes.

Also in this batch:
- Server_ProtocolHandler::processGameCommandContainer() copied the whole
  games map under gameListMutex just to look up one game id. A new
  getGameInfo() performs the single lookup and returns the room/player
  ids.
- The TCP receive loop's `ok` flag is initialized, so a ParseFromArray
  exception can no longer leave it indeterminate before `if (ok)`.
- The exception log prints only the message being parsed instead of
  hex-dumping the entire pending buffer.

Full build and ctest (628 tests) pass, including the server tests.

* [Network] Address review comments

- Move getGameInfo() out of the header into server_abstractuserinterface.cpp.
- Drop the consumed prefix once after the parse loop instead of on every
  early return: the two "not enough data" exits now break out of the loop.
  Applied to the remote client, TCP server and ISL receive loops.

---------

Co-authored-by: Lukas Brübach <Bruebach.Lukas@bdosecurity.de>
2026-10-25 12:49:24 +01:00
2026-10-25 12:30:17 +01:00
2026-10-22 20:13:43 +02:00


Cockatrice | Download | Related | Community | Contribute | Build | Run



To get started with Cockatrice ⇢ view our webpage To get support, or suggest changes to the app ⇢ file an issue (How?)
To learn about the app and its code ⇢ read our code documentation To help with development ⇢ learn how to contribute


Cockatrice

Cockatrice is an open-source, multiplatform application for playing tabletop card games over a network. The program's server design prevents users from manipulating the game for unfair advantage. The client also provides a single-player mode, which allows users to brew while offline.

This project uses C++ and the Qt libraries.

Download Cockatrice Eternal Download Count

Downloads are available for stable releases and the current beta version in development.
There is no strict release schedule for either of them.

Latest stable release:
Download Stable Release  
Latest beta version:
Download Beta Release   
While incorporating the latest fixes and features, beta builds may not be stable or contain new bugs!
Please report any findings and open new issues when testing them!

Related Repositories

Community Resources Discord

Join our Discord community to connect with other project contributors (#dev channel) or fellow users of the app. Come here to talk about the application, features, or just to hang out.

Important

For support regarding specific servers, please contact that server's admin/mods and use their dedicated communication channels rather than contacting the team building the software.

Contribute

Code | Documentation | Translation

Repository Activity

Cockatrice Repo Analytics

Kudos to all our amazing contributors ❤️

Made with contrib.rocks

Code

To commit code to the project, please review our Contribution Guidelines first.
We maintain two tags for contributors to easier find issues to potentially work on:

  • Good first issue
    Issues tagged in this way provide a simple way to get started. They don't require much experience to be worked on.
  • Help wanted
    This tag is used for issues that we are looking for somebody to pick up. Often this is for feature suggestions we support, but don't have the time to work on ourselves.

For both tags, we're willing to provide help to contributors in showing them where and how they can make changes, as well as code reviews for submitted changes.
We'll happily advice on how best to implement a feature, or we can show you where the codebase is doing something similar before you get too far along - put a note on an issue you want to discuss more on!

You can also have a look at our Todo List in our Code Documentation or search the repo for \todo comments.

Documentation CI Docs

There are various places where useful information for different needs are maintained:

Cockatrice tries to use the Google Developer Documentation Style Guide to ensure consistent documentation.
We encourage everybody to improve the documentation by suggesting edits based on this guide.

Translation Transifex Project

Cockatrice uses Transifex to manage translations. You can help us bring Cockatrice and Oracle to your language and just adjust single wordings right from within your browser by visiting our Transifex project page. The Webatrice web client manages its own translations in its repo.

Check out our Translator FAQ for more information about getting involved, and join a group of hundreds of others!

Build CI Desktop CI Docker

Dependencies: (for minimum versions search our CMake file)

Oracle can optionally use some packages to load compressed card files:


Basic compilation steps:

mkdir build
cd build
cmake ..
make

You can then

  • Create a Cockatrice installation inside the release folder:
    make install
    
  • Or make an installation package specific to your system:
    make package
    

Note

Detailed compiling instructions can be found in the Cockatrice wiki at Compiling Cockatrice


The following flags (with their non-default values) can be passed to cmake:

Flag Description
-DWITH_SERVER=1 Build Servatrice server
-DWITH_CLIENT=0 Don't build Cockatrice client
-DWITH_ORACLE=0 Don't build Oracle card database tool
-DCMAKE_BUILD_TYPE=Debug Compile in debug mode
Enables extra logging output, debug symbols, and much more verbose compiler warnings
-DWARNING_AS_ERROR=0 Don't treat compilation warnings as errors in debug mode
-DUPDATE_TRANSLATIONS=1 Configure make to update the translation .ts files for new strings in the source code
Note: make clean will remove the .ts files
-DTEST=1 Enable regression tests
Note: make test to run tests, googletest will be downloaded if not available

Tip

Build code documentation (Doxygen) according to our configuration into /docs:

doxygen Doxyfile

Run

Cockatrice is the game client
Oracle fetches card data
Servatrice is the server

Docker

You can build an image & deploy a Servatrice (Cockatrice server) container using Docker and our Dockerfile yourself.

For more details, look into our wiki section on Setting up Servatrice.
You'll also find more hints on our pre-build image there, or the docker-compose file which will configure and run both a MySQL server and Servatrice.

License GPLv2 License

Cockatrice is free software, licensed under the GPLv2.

Description
Languages
C++ 95.1%
CMake 2.3%
Shell 1%
C 0.8%
Python 0.3%
Other 0.3%