forked from ss220-space/Paradise
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Changelog Overhaul * SQL Update * This is why I hate merge conflicts * Comment Correction * Farie Fixes + Tested with blank DB * Colours + Titles * Colour tweaks * I fell victim to my own CI Chains! * Cleans up the remains of the old changelogs * Fixes formatting * Kyet Changes * Date
- Loading branch information
1 parent
b2b12c3
commit 7ea6f19
Showing
62 changed files
with
15,167 additions
and
14,542 deletions.
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| #Updating the SQL from version 11 to version 12. -AffectedArc07 | ||
| #Creating a table for the new changelog system | ||
|
|
||
| DROP TABLE IF EXISTS `changelog`; | ||
| CREATE TABLE IF NOT EXISTS `changelog` ( | ||
| `id` INT(11) NOT NULL AUTO_INCREMENT, | ||
| `pr_number` INT(11) NOT NULL, | ||
| `date_merged` TIMESTAMP NOT NULL DEFAULT current_timestamp(), | ||
| `author` VARCHAR(32) NOT NULL, | ||
| `cl_type` ENUM('FIX','WIP','TWEAK','SOUNDADD','SOUNDDEL','CODEADD','CODEDEL','IMAGEADD','IMAGEDEL','SPELLCHECK','EXPERIMENT') NOT NULL, | ||
| `cl_entry` TEXT NOT NULL, | ||
| PRIMARY KEY (`id`) | ||
| ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4; |
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,230 @@ | ||
| /* | ||
| Subsystem core for ParadiseSS13 changelogs | ||
| Author: AffectedArc07 | ||
| Basically this SS extracts changelogs from the past 30 days from the database, and cleanly formats them into HTML that the players can see | ||
| It only runs the extraction on initialize to ensure that the changelog doesnt change mid round, and to reduce the amount of DB calls that need to be done | ||
| The changelog entries are generated from the PHP scripts in tools/githubChangelogProcessor.php | ||
| This SS also handles the checking of player CL dates and informing them if it has changed | ||
| */ | ||
|
|
||
| SUBSYSTEM_DEF(changelog) | ||
| name = "Changelog" | ||
| flags = SS_NO_FIRE | ||
| var/current_cl_timestamp = "0" // Timestamp is seconds since UNIX epoch (1st January 1970). ITs also a string because BYOND doesnt like big numbers. | ||
| var/ss_ready = FALSE // Is the SS ready? We dont want to run procs if we have not generated yet | ||
| var/list/startup_clients_button = list() // Clients who connected before initialization who need their button color updating | ||
| var/list/startup_clients_open = list() // Clients who connected before initialization who need the CL opening | ||
| var/changelogHTML = "" // HTML that the changelog will use to display | ||
|
|
||
| /datum/controller/subsystem/changelog/Initialize() | ||
| // This entire subsystem relies on SQL being here. | ||
| if(!GLOB.dbcon.IsConnected()) | ||
| return ..() | ||
|
|
||
| var/DBQuery/latest_cl_date = GLOB.dbcon.NewQuery("SELECT UNIX_TIMESTAMP(date_merged) AS ut FROM [format_table_name("changelog")] ORDER BY date_merged DESC LIMIT 1") | ||
| if(!latest_cl_date.Execute()) | ||
| var/err = latest_cl_date.ErrorMsg() | ||
| log_game("SQL ERROR during SSchangelog initialization L24. Error: \[[err]\]\n") | ||
| message_admins("SQL ERROR during SSchangelog initialization L24. Error: \[[err]\]\n") | ||
| // Abort if we cant do this | ||
| return ..() | ||
|
|
||
| while(latest_cl_date.NextRow()) | ||
| current_cl_timestamp = latest_cl_date.item[1] | ||
|
|
||
| if(!GenerateChangelogHTML()) // if this failed to generate | ||
| to_chat(world, "<span class='alert'>WARNING: Changelog failed to generate. Please inform a coder/server dev</span>") | ||
| return ..() | ||
|
|
||
| ss_ready = TRUE | ||
| // Now we can alert anyone who wanted to check the changelog | ||
| for(var/x in startup_clients_button) | ||
| var/client/C = x | ||
| UpdatePlayerChangelogButton(C) | ||
|
|
||
| // Now we can alert anyone who wanted to check the changelog | ||
| for(var/client/C in startup_clients_open) | ||
| OpenChangelog(C) | ||
|
|
||
| return ..() | ||
|
|
||
|
|
||
| /datum/controller/subsystem/changelog/proc/UpdatePlayerChangelogDate(client/C) | ||
| if(!ss_ready) | ||
| return // Only return here, we dont have to worry about a queue list because this will be called from ShowChangelog() | ||
| // Technically this is only for the date but we can also do the UI button at the same time | ||
| var/datum/preferences/P = GLOB.preferences_datums[C.ckey] | ||
| if(P.toggles & UI_DARKMODE) | ||
| winset(C, "rpane.changelog", "background-color=#40628a;font-color=#ffffff;font-style=none") | ||
| else | ||
| winset(C, "rpane.changelog", "background-color=none;font-style=none") | ||
| C.prefs.lastchangelog = current_cl_timestamp | ||
| var/DBQuery/updatePlayerCLTime = GLOB.dbcon.NewQuery("UPDATE [format_table_name("player")] SET lastchangelog='[sanitizeSQL(current_cl_timestamp)]' WHERE ckey='[C.ckey]'") | ||
| if(!updatePlayerCLTime.Execute()) | ||
| var/err = updatePlayerCLTime.ErrorMsg() | ||
| log_game("SQL ERROR during lastchangelog updating. Error: \[[err]\]\n") | ||
| message_admins("SQL ERROR during lastchangelog updating. Error: \[[err]\]\n") | ||
| to_chat(C, "Couldn't update your last seen changelog, please try again later.") | ||
| return FALSE | ||
| return TRUE | ||
|
|
||
| /datum/controller/subsystem/changelog/proc/UpdatePlayerChangelogButton(client/C) | ||
| // If SQL aint even enabled, just set the button to default style | ||
| if(!GLOB.dbcon.IsConnected()) | ||
| if(C.prefs.toggles & UI_DARKMODE) | ||
| winset(C, "rpane.changelog", "background-color=#40628a;text-color=#FFFFFF") | ||
| else | ||
| winset(C, "rpane.changelog", "background-color=none;text-color=#000000") | ||
| return | ||
|
|
||
| // If SQL is enabled but we aint ready, queue them up, and use the default style | ||
| if(!ss_ready) | ||
| startup_clients_button |= C | ||
| if(C.prefs.toggles & UI_DARKMODE) | ||
| winset(C, "rpane.changelog", "background-color=#40628a;text-color=#FFFFFF") | ||
| else | ||
| winset(C, "rpane.changelog", "background-color=none;text-color=#000000") | ||
| return | ||
|
|
||
| // If we are ready, process the button style | ||
| if(C.prefs.lastchangelog != current_cl_timestamp) | ||
| winset(C, "rpane.changelog", "background-color=#bb7700;text-color=#FFFFFF;font-style=bold") | ||
| to_chat(C, "<span class='info'>Changelog has changed since your last visit.</span>") | ||
| else | ||
| if(C.prefs.toggles & UI_DARKMODE) | ||
| winset(C, "rpane.changelog", "background-color=#40628a;text-color=#FFFFFF") | ||
| else | ||
| winset(C, "rpane.changelog", "background-color=none;text-color=#000000") | ||
|
|
||
|
|
||
| /datum/controller/subsystem/changelog/proc/OpenChangelog(client/C) | ||
| // If SQL isnt enabled, dont even queue them, just tell them it wont work | ||
| if(!GLOB.dbcon.IsConnected()) | ||
| to_chat(C, "<span class='notice'>This server is not running with an SQL backend. Changelog is unavailable.</span>") | ||
| return | ||
|
|
||
| // If SQL is enabled but we aint ready, queue them up | ||
| if(!ss_ready) | ||
| startup_clients_open |= C | ||
| to_chat(C, "<span class='notice'>The changelog system is still initializing. The changelog will open for you once it has initialized.</span>") | ||
| return | ||
|
|
||
| UpdatePlayerChangelogDate(C) | ||
| UpdatePlayerChangelogButton(C) | ||
|
|
||
| var/datum/browser/cl_popup = new(C.mob, "changelog", "Changelog", 700, 800) | ||
| cl_popup.set_content(changelogHTML) | ||
| cl_popup.open() | ||
|
|
||
| /client/verb/changes() | ||
| set name = "Changelog" | ||
| set desc = "View the changelog." | ||
| set category = "OOC" | ||
| // Just invoke the actual CL thing | ||
| SSchangelog.OpenChangelog(src) | ||
|
|
||
| // Helper to turn CL types into a fontawesome icon instead of an image | ||
| // The colors are #28a745 for green, #fd7e14 for orange, and #dc3545 for red. | ||
| // These colours are from bootstrap and look good with black and white | ||
| /datum/controller/subsystem/changelog/proc/Text2Icon(text) | ||
| switch(text) | ||
| if("FIX") | ||
| return "<i title='Fix' class='fas fa-tools'></i></span>" // Fixes are white because while they are good, they have no negative coutnerpart | ||
| if("WIP") | ||
| return "<span style='color: #fd7e14;'><i title='Work In Progress' class='fas fa-hard-hat'></i></span>" // WIP stuff is orange because new code is good but its not done yet | ||
| if("TWEAK") | ||
| return "<i title='Tweak' class='fas fa-sliders-h'></i>" // Tweaks are white because they could be good or bad, and theres no specific add or remove | ||
| if("SOUNDADD") | ||
| return "<span style='color: #28a745;'><i title='Sound Added' class='fas fa-volume-up'></i></span>" // Sound additions are green because its something new | ||
| if("SOUNDDEL") | ||
| return "<span style='color: #dc3545;'><i title='Sound Removed' class='fas fa-volume-mute'></i></span>" // Sound removals are red because something has been removed | ||
| if("CODEADD") | ||
| return "<span style='color: #28a745;'><i title='Code Addition' class='fas fa-plus'></i></span>" // Code additions are green because its something new | ||
| if("CODEDEL") | ||
| return "<span style='color: #dc3545;'><i title='Code Removal' class='fas fa-minus'></i></span>" // Code removals are red becuase someting has been removed | ||
| if("IMAGEADD") | ||
| return "<span style='color: #28a745;'><i title='Image/Sprite Addition' class='fas fa-folder-plus'></i></span>" // Image additions are green because something has been added | ||
| if("IMAGEDEL") | ||
| return "<span style='color: #dc3545;'><i title='Image/Sprite Removal' class='fas fa-folder-minus'></i></span>" // Image removals are red because something has been removed | ||
| if("SPELLCHECK") | ||
| return "<i title='Spelling/Grammar Fix' class='fas fa-font'></i>" // Spellcheck is white because theres no dedicated negative to it, so theres no red for it to collate with | ||
| if("EXPERIMENT") | ||
| return "<span style='color: #fd7e14;'><i title='Experimental' class='fas fa-exclamation-triangle'></i></span>" // Experimental stuff is orange because while its a new feature, its unstable | ||
| else // Just incase the DB somehow breaks | ||
| return "<span style='color: #28a745;'><i title='Code Addition' class='fas fa-plus'></i></span>" // Same here | ||
|
|
||
| // This proc is the star of the show | ||
| /datum/controller/subsystem/changelog/proc/GenerateChangelogHTML() | ||
| // Modify the code below to modify the header of the changelog | ||
| var/changelog_header = {" | ||
| <link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" rel="stylesheet"> | ||
| <title>ParadiseSS13 Changelog</title> | ||
| <base target='_blank' /> | ||
| <link rel='styelsheet' href='fontawesome.min.css'> | ||
| <center> | ||
| <p style='font-size: 20px'><b>Paradise Station Changelog</b></p> | ||
| <p><a href='[config.forum_link_url]'>Forum</a> - <a href='[config.wikiurl]'>Wiki</a> - <a href='[config.githuburl]'>GitHub</a></p> | ||
| </center> | ||
| "} | ||
|
|
||
| var/list/prs_to_process = list() | ||
| // Grab all from last 30 days | ||
| var/DBQuery/pr_list_query = GLOB.dbcon.NewQuery("SELECT DISTINCT pr_number FROM changelog WHERE date_merged BETWEEN NOW() - INTERVAL 30 DAY AND NOW() ORDER BY date_merged DESC") | ||
| if(!pr_list_query.Execute()) | ||
| var/err = pr_list_query.ErrorMsg() | ||
| log_game("SQL ERROR during CL generation L143. Error: \[[err]\]\n") | ||
| message_admins("SQL ERROR during CL generation L143. Error: \[[err]\]\n") | ||
| return FALSE | ||
|
|
||
| while(pr_list_query.NextRow()) | ||
| prs_to_process += text2num(pr_list_query.item[1]) | ||
|
|
||
| // Load in the header | ||
| changelogHTML += changelog_header | ||
|
|
||
| // Make blocks for all the PRs | ||
| for(var/pr_number in prs_to_process) | ||
| // Initial declarations | ||
| var/pr_block = "" // HTML for the changelog section | ||
| var/author = "" // Author of the PR | ||
| var/merge_date = "" // Timestamp of when the PR was merged | ||
|
|
||
| // Now we gather the data from the DB | ||
| // Also we probably dont need to sanitize the PR number but you never know | ||
| var/DBQuery/pr_meta = GLOB.dbcon.NewQuery("SELECT author,DATE(date_merged) AS date FROM changelog WHERE pr_number = [sanitizeSQL(pr_number)] LIMIT 1") | ||
| if(!pr_meta.Execute()) | ||
| var/err = pr_meta.ErrorMsg() | ||
| log_game("SQL ERROR during CL generation L190. Error: \[[err]\]\n") | ||
| message_admins("SQL ERROR during CL generation L190. Error: \[[err]\]\n") | ||
| return FALSE | ||
|
|
||
| while(pr_meta.NextRow()) | ||
| author = pr_meta.item[1] | ||
| merge_date = pr_meta.item[2] | ||
|
|
||
| // Now for each actual entry | ||
| var/DBQuery/db_entries = GLOB.dbcon.NewQuery("SELECT cl_type, cl_entry FROM changelog WHERE pr_number = [sanitizeSQL(pr_number)]") | ||
| if(!db_entries.Execute()) | ||
| var/err = db_entries.ErrorMsg() | ||
| log_game("SQL ERROR during CL generation L204. Error: \[[err]\]\n") | ||
| message_admins("SQL ERROR during CL generation L204. Error: \[[err]\]\n") | ||
| return FALSE | ||
|
|
||
|
|
||
| // Now we make a changelog block | ||
| pr_block += "<div class='statusDisplay'>" | ||
| // If the github URL in the config has a trailing slash, it doesnt matter here, thankfully github accepts having a double slash: https://github.com/org/repo//pull/1 | ||
| pr_block += "<p class='white'><a href='[config.githuburl]/pull/[pr_number]'>#[pr_number]</a> by <b>[author]</b> (Merged on [merge_date])</span>" | ||
|
|
||
| while(db_entries.NextRow()) | ||
| pr_block += "<p>[Text2Icon(db_entries.item[1])] [db_entries.item[2]]</p>" | ||
|
|
||
| pr_block += "</div><br>" | ||
|
|
||
| changelogHTML += pr_block | ||
|
|
||
| // Make sure we return TRUE so we know it worked | ||
| return TRUE |
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
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
Oops, something went wrong.