gronod/OpenTTD
1
0
Fork 0
mirror of https://github.com/OpenTTD/OpenTTD.git synced 2025-03-09 15:41:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix #10438: [GS] Validate story page element type for ScriptStoryPage::NewElement (#11888)

Browse Source 
Fixes a crash that happens if an invalid StoryPageElementType is passed to ScriptStoryPage::NewElement.

Adds an enforced precondition that tests the validity of StoryPageElementType.

Adds GSStoryPage::IsValidStoryPageElementType to the API.
This commit is contained in:
SamuXarick 2024-01-27 21:11:02 +00:00 committed by GitHub
parent 6d276698b6
commit 76f0f9e386
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/script/api/game_changelog.hpp
View File

@ -81,6 +81,7 @@
* \li GSGoal::SetDestination * \li GSGoal::SetDestination
* \li GSIndustry::GetProductionLevel * \li GSIndustry::GetProductionLevel
* \li GSIndustry::SetProductionLevel * \li GSIndustry::SetProductionLevel
* \li GSStoryPage::IsValidStoryPageElementType
* *
* API removals: * API removals:
* \li GSError::ERR_PRECONDITION_TOO_MANY_PARAMETERS, that error is never returned anymore. * \li GSError::ERR_PRECONDITION_TOO_MANY_PARAMETERS, that error is never returned anymore.

6
src/script/api/script_story_page.cpp
View File

@ -38,6 +38,11 @@ static inline bool StoryPageElementTypeRequiresText(StoryPageElementType type)
return ::StoryPageElement::IsValidID(story_page_element_id); return ::StoryPageElement::IsValidID(story_page_element_id);
} }
/* static */ bool ScriptStoryPage::IsValidStoryPageElementType(StoryPageElementType type)
{
return type == SPET_TEXT || type == SPET_LOCATION || type == SPET_GOAL || type == SPET_BUTTON_PUSH || type == SPET_BUTTON_TILE || type == SPET_BUTTON_VEHICLE;
}
/* static */ ScriptStoryPage::StoryPageID ScriptStoryPage::New(ScriptCompany::CompanyID company, Text *title) /* static */ ScriptStoryPage::StoryPageID ScriptStoryPage::New(ScriptCompany::CompanyID company, Text *title)
{ {
CCountedPtr<Text> counter(title); CCountedPtr<Text> counter(title);
@ -63,6 +68,7 @@ static inline bool StoryPageElementTypeRequiresText(StoryPageElementType type)
EnforceDeityMode(STORY_PAGE_ELEMENT_INVALID); EnforceDeityMode(STORY_PAGE_ELEMENT_INVALID);
EnforcePrecondition(STORY_PAGE_ELEMENT_INVALID, IsValidStoryPage(story_page_id)); EnforcePrecondition(STORY_PAGE_ELEMENT_INVALID, IsValidStoryPage(story_page_id));
EnforcePrecondition(STORY_PAGE_ELEMENT_INVALID, IsValidStoryPageElementType(type));
std::string encoded_text; std::string encoded_text;
if (StoryPageElementTypeRequiresText(btype)) { if (StoryPageElementTypeRequiresText(btype)) {
EnforcePrecondition(STORY_PAGE_ELEMENT_INVALID, text != nullptr); EnforcePrecondition(STORY_PAGE_ELEMENT_INVALID, text != nullptr);

8
src/script/api/script_story_page.hpp
View File

@ -179,6 +179,13 @@ public:
*/ */
static bool IsValidStoryPageElement(StoryPageElementID story_page_element_id); static bool IsValidStoryPageElement(StoryPageElementID story_page_element_id);
/**
* Check whether this is a valid story page element type.
* @param type The StoryPageElementType to check.
* @return True if and only if this story page element type is valid.
*/
static bool IsValidStoryPageElementType(StoryPageElementType type);
/** /**
* Create a new story page. * Create a new story page.
* @param company The company to create the story page for, or ScriptCompany::COMPANY_INVALID for all. * @param company The company to create the story page for, or ScriptCompany::COMPANY_INVALID for all.
@ -202,6 +209,7 @@ public:
* @return The new StoryPageElementID, or STORY_PAGE_ELEMENT_INVALID if it failed. * @return The new StoryPageElementID, or STORY_PAGE_ELEMENT_INVALID if it failed.
* @pre ScriptCompanyMode::IsDeity(). * @pre ScriptCompanyMode::IsDeity().
* @pre IsValidStoryPage(story_page). * @pre IsValidStoryPage(story_page).
* @pre IsValidStoryPageElementType(type).
* @pre (type != SPET_TEXT && type != SPET_LOCATION) || (text != null && len(text) != 0). * @pre (type != SPET_TEXT && type != SPET_LOCATION) || (text != null && len(text) != 0).
* @pre type != SPET_LOCATION || ScriptMap::IsValidTile(reference). * @pre type != SPET_LOCATION || ScriptMap::IsValidTile(reference).
* @pre type != SPET_GOAL || ScriptGoal::IsValidGoal(reference). * @pre type != SPET_GOAL || ScriptGoal::IsValidGoal(reference).