feat/telnet-charset #122
Merged
feat/telnet-charset #122
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- added ENVIRONMENT environment flag that can be set to 'development' or 'production' (default) - added a rest endpoint via /api/info for further inspection of the server state - show telnet negotiations in the debug endpoint
- added CHARSET environment variable. supported values: utf-8, latin1 (ISO-8859-1), ascii (US-ASCII) - added charset subnegotiaton with fallback to utf-8
- negotiations are now optional since they need to be set one-by-one (server and client) - added TelnetOptionHandler to define seperate telnet options - re-implemented charset as handle-charset-option - re-implemented echo as handle-echo-option - all other options are answered with a negative DONT or WONT - refactored telnet-client
Closed
- removed environment variable - negotiate only utf-8 - if utf-8 is not supported, throw an error
|
After some testing it turns out that supporting multiple encodings just for unitopia alone is not sufficient. I'm pretty sure one can provide the missing implementation for different encodings with ease but I have no testing partner right now and most, if not all, MUDs should support utf-8 anyways. I changed the PR description. Main changes:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds support for multiple character encodings (charsets) in the Mud client and introduces a new ENVIRONMENT variable for enabling development-specific features.
Supported Charsets
The Mud client now supports the following charsets:
- latin1 (ISO-8859-1)- ascii (US-ASCII)Charset conversion on the client-side is handled through the functionmapToServerEncodings, which maps the client-used charsets to those supported by the server.How It Works
During the Telnet negotiation (TELOPT_CHARSET), the client checks which charsets are supported by the server.
The client's preferred charset (defined via the environment variable CHARSET)Only UTF-8 is compared against the charsets offered by the server. If the client's preferred charset is not supported,the client defaults to utf-8an error is thrown.Server-side Charset Check: During the Telnet charset negotiation, the client's preferred charset (e.g., utf-8, latin1, ascii) is checked against the charsets supported by the server.Fault Tolerance: If the server does not support the client's charset, the encoding defaults to utf-8, and a warning is logged.
New Environment Variable ENVIRONMENT
A new environment variable ENVIRONMENT has been introduced, which can be set to either "development" or "production" (default). This variable controls whether certain development-only features are enabled.
Validation: If ENVIRONMENT is set to anything other than "development" or "production", an error is thrown to ensure valid configuration.
Development Mode Debug Endpoints
When the environment is set to "development", debug REST endpoints are enabled. These endpoints provide information about the currently connected clients and their Telnet negotiations.
The /api/info endpoint provides a list of all active Telnet connections and their associated negotiation status.
This allows developers to monitor connected clients and inspect their negotiation status directly from the REST endpoint during development.
Fixes #111
Edit: The client is now fixed at "utf-8". The old CHARSET environment variable has been discarded.