Refactor mtaserver.conf.template #3857

Fernando-A-Rocha · 2024-11-14T23:44:22Z

Context

The mtaserver.conf.template file is a copy of mtaserver.conf without the <module> and <resource> nodes, that devs have been maintaining manually. Default config already comes in mtaserver.conf. Without this PR, the script looks for mtaserver.conf.template, and if it finds it, it will scan for missing config nodes in the existing mtaserver.conf config, and then after it's done with the changes, it deletes the .template file. So it's only ever used once. The problem is that real MTA servers never get their hands on the .template file, so it is never used. Mtaserver.conf.template file is not shipped with the server via the installer or zip provided by mtasa.com. Devs compiling MTA:SA also don't need this template ever, because the default config is already in the mtaserver.conf file... Also, the note in the beginning of the mtaserver.conf.template file is false <!-- This file is compiled into the server binary. This file is never compiled in the server binary, it gets deleted after use. So, it has zero practical use.

What I changed

Deleted mtaserver.conf.template from files
Edited buildaction install_data.lua to automatically duplicate mtaserver.conf => mtaserver.conf.template
Also updated compose_files.lua to do this
Added mtaserver.conf.template to be included by the Installer (nightly.nsi)
Refactored AddMissingSettings():
- Will not delete mtaserver.conf.template after running
- Removed hungarian notation
- Made the function not add missing resource/module nodes

Why?

We no longer need to duplicate every new/changed config setting to mtaserver.conf.template.
By shipping mtaserver.conf.template with the installer (overwrites existing mtaserver.conf.template of the server), the server will receive new settings added by newer server builds, which will be added to the server's mtaserver.conf

…e into conf-template

Fernando-A-Rocha · 2024-11-15T11:35:12Z

Why not use the template file if you already have existing logic for it? I think it's unnecessary to embed the entire config in the code and use it for every reinstallation, instead this should be done from one file, which is this template file

Hmm, check out what I did.

Server/mods/deathmatch/logic/CMainConfig.cpp

Nico8340

It looks good, although I recommend inserting a comment at the beginning of the template file to let the user know that they shouldn't change it

Dutchman101 · 2024-11-21T23:16:02Z

Please resolve conflicts, @Fernando-A-Rocha

Didn't this appear for you?

Fernando-A-Rocha · 2024-11-22T10:43:11Z

@Dutchman101 Merge conflict resolved. I will apply Nico's suggestion now.

Fernando-A-Rocha · 2024-11-22T11:07:51Z

@Nico8340 All good now?

Nico8340

LGTM

Fernando-A-Rocha · 2024-11-22T16:35:12Z

Future Work

I believe that later we should refactor the config system removing the need to have 2 separate files local.conf and editor.conf (as well as editor_acl.xml) for the configuration of Host-Game and Map-Editor servers. It's bad practice that we are duplicating all config values to those files, while in reality all that is happening is some values changing when these servers are started (like startup resources and server name etc). This could be hardcoded in C++, and for Host-Game, the values of the last used preferred settings can be cached to core client config.

I volunteer to do this refactoring if you guys agree.

->feedback, @Dutchman101

FileEX · 2024-12-23T23:25:59Z

Server/mods/deathmatch/logic/CMainConfig.cpp

@@ -855,44 +855,53 @@ bool CMainConfig::AddMissingSettings()
    if (!g_pGame->IsUsingMtaServerConf())
        return false;

-    SString strTemplateFilename = PathJoin(g_pServerInterface->GetServerModPath(), "mtaserver.conf.template");
+    const std::string templateFileName = PathJoin(g_pServerInterface->GetServerModPath(), SETTINGS_TEMPLATE_PATH);


std::string_view here and below?

std::string_view isn't the best choice here because PathJoin returns a temporal object.

Yes, but this object is no longer needed outside the function. Until the function completes and "exits", there should be a guarantee that the object created by PathJoin will exist, right?

The lifetime of a temporary object may be extended by binding to a reference, yes. But here is not the case. The result of PathJoin will be invalidated and std::string_view will deal with a dangling pointer.

tederis · 2024-12-24T05:11:38Z

Server/mods/deathmatch/logic/CMainConfig.cpp

-            pNode->SetCommentText(strNodeComment, true);
-            bChanged = true;
+            const std::string templateNodeValue = templateNode->GetTagContent();
+            const std::string templateNodeComment = templateNode->GetCommentText();


GetCommentText returns SString. This triggers an unnecessary string copying. It is recommended to use matching types for a variable and a function's return type.

tederis · 2024-12-24T05:13:28Z

Server/mods/deathmatch/logic/CMainConfig.cpp

+            foundNode->SetTagContent(templateNodeValue.c_str());
+            foundNode->SetCommentText(templateNodeComment.c_str(), true);
+
+            CLogger::LogPrintf("Added missing '%s' setting to mtaserver.conf\n", &templateNodeName);


Did you mean templateNodeName.c_str()?

Fernando-A-Rocha and others added 4 commits November 14, 2024 23:40

remove mtaserver.conf.template

525f43d

Merge branch 'master' into conf-template

85292af

.

899dd52

Merge branch 'conf-template' of github.com:Fernando-A-Rocha/mtasa-blu…

ce676de

…e into conf-template

This comment was marked as outdated.

Sign in to view

dont remove the template

f0195c7

Fernando-A-Rocha changed the title ~~Remove mtaserver.conf.template~~ Refactor mtaserver.conf.template Nov 15, 2024

Fernando-A-Rocha added 2 commits November 15, 2024 11:44

include mtaserver.conf.template in installer

d3bb1ea

compose_files

2796ea0

Nico8340 suggested changes Nov 16, 2024

View reviewed changes

Server/mods/deathmatch/logic/CMainConfig.cpp Outdated Show resolved Hide resolved

Server/mods/deathmatch/logic/CMainConfig.cpp Outdated Show resolved Hide resolved

TheNormalnij added enhancement New feature or request refactor labels Nov 17, 2024

Fernando-A-Rocha and others added 2 commits November 18, 2024 14:41

Merge branch 'master' into conf-template

6c98bd3

more refactoring

8d3da29

Fernando-A-Rocha requested a review from Nico8340 November 18, 2024 15:08

Nico8340 approved these changes Nov 21, 2024

View reviewed changes

Merge branch 'master' into conf-template

5748061

resolve merge conflict

620e1d7

mtaserver.conf.template add header comment

d3d5740

Fernando-A-Rocha requested a review from Nico8340 November 22, 2024 11:07

rename func

37e9254

Nico8340 approved these changes Nov 22, 2024

View reviewed changes

Fernando-A-Rocha and others added 2 commits November 22, 2024 22:04

Merge branch 'master' into conf-template

7e67221

Merge branch 'master' into conf-template

e0c698e

FileEX reviewed Dec 23, 2024

View reviewed changes

tederis reviewed Dec 24, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor mtaserver.conf.template #3857

Refactor mtaserver.conf.template #3857

Fernando-A-Rocha commented Nov 14, 2024 •

edited

Loading

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

Fernando-A-Rocha commented Nov 15, 2024 •

edited

Loading

Nico8340 left a comment

Dutchman101 commented Nov 21, 2024 •

edited

Loading

Fernando-A-Rocha commented Nov 22, 2024 •

edited

Loading

Fernando-A-Rocha commented Nov 22, 2024

Nico8340 left a comment

Fernando-A-Rocha commented Nov 22, 2024 •

edited

Loading

FileEX Dec 23, 2024 •

edited

Loading

tederis Dec 24, 2024

FileEX Dec 24, 2024

tederis Dec 25, 2024

tederis Dec 24, 2024

tederis Dec 24, 2024 •

edited

Loading

Refactor mtaserver.conf.template #3857

Are you sure you want to change the base?

Refactor mtaserver.conf.template #3857

Conversation

Fernando-A-Rocha commented Nov 14, 2024 • edited Loading

Context

What I changed

Why?

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

Fernando-A-Rocha commented Nov 15, 2024 • edited Loading

Nico8340 left a comment

Choose a reason for hiding this comment

Dutchman101 commented Nov 21, 2024 • edited Loading

Fernando-A-Rocha commented Nov 22, 2024 • edited Loading

Fernando-A-Rocha commented Nov 22, 2024

Nico8340 left a comment

Choose a reason for hiding this comment

Fernando-A-Rocha commented Nov 22, 2024 • edited Loading

Future Work

FileEX Dec 23, 2024 • edited Loading

Choose a reason for hiding this comment

tederis Dec 24, 2024

Choose a reason for hiding this comment

FileEX Dec 24, 2024

Choose a reason for hiding this comment

tederis Dec 25, 2024

Choose a reason for hiding this comment

tederis Dec 24, 2024

Choose a reason for hiding this comment

tederis Dec 24, 2024 • edited Loading

Choose a reason for hiding this comment

Fernando-A-Rocha commented Nov 14, 2024 •

edited

Loading

Fernando-A-Rocha commented Nov 15, 2024 •

edited

Loading

Dutchman101 commented Nov 21, 2024 •

edited

Loading

Fernando-A-Rocha commented Nov 22, 2024 •

edited

Loading

Fernando-A-Rocha commented Nov 22, 2024 •

edited

Loading

FileEX Dec 23, 2024 •

edited

Loading

tederis Dec 24, 2024 •

edited

Loading