Convert changelog to TGUI (tgstation#58593)

This pull request converts the changelog to TGUI. 
Note: Old unused changelog files will be automatically removed on the next changelog run
Why It's Good For The Game

More consistent UI, ability to view all historic logs.
Changelog

cl Celotajs
refactor: Converted the changelog popup to TGUI
/cl

.gitattributes

@@ -42,5 +42,3 @@
 ## Force tab indents on dm files
 *.dm whitespace=indent-with-non-tab
 
-## Force changelog merging to use union
-html/changelog.html text eol=lf merge=union

.github/workflows/compile_changelogs.yml

@@ -36,7 +36,7 @@ jobs:
  - name: "Compile"
  if: steps.value_holder.outputs.CL_ENABLED
  run: |
- python tools/ss13_genchangelog.py html/changelog.html html/changelogs
+ python tools/ss13_genchangelog.py html/changelogs
  - name: "Convert Lineendings"
  if: steps.value_holder.outputs.CL_ENABLED
  run: |

code/_globalvars/tgui.dm

@@ -1 +1,2 @@
 GLOBAL_DATUM(crew_manifest_tgui, /datum/crew_manifest)
+GLOBAL_DATUM(changelog_tgui, /datum/changelog)

code/datums/changelog/changelog.dm

@@ -0,0 +1,32 @@
+/datum/changelog
+ var/static/list/changelog_items = list()
+
+/datum/changelog/ui_state()
+ return GLOB.always_state
+
+/datum/changelog/ui_interact(mob/user, datum/tgui/ui)
+ ui = SStgui.try_update_ui(user, src, ui)
+ if (!ui)
+ ui = new(user, src, "Changelog")
+ ui.open()
+
+/datum/changelog/ui_act(action, list/params, datum/tgui/ui, datum/ui_state/state)
+ . = ..()
+ if(.)
+ return
+ if(action == "get_month")
+ var/datum/asset/changelog_item/changelog_item = changelog_items[params["date"]]
+ if (!changelog_item)
+ changelog_item = new /datum/asset/changelog_item(params["date"])
+ changelog_items[params["date"]] = changelog_item
+ return ui.send_asset(changelog_item)
+
+/datum/changelog/ui_static_data()
+ var/list/data = list( "dates" = list() )
+ var/regex/ymlRegex = regex(@"\.yml", "g")
+
+ for(var/archive_file in flist("[global.config.directory]/../html/changelogs/archive/"))
+ var/archive_date = ymlRegex.Replace(archive_file, "")
+ data["dates"] = list(archive_date) + data["dates"]
+
+ return data

code/game/world.dm

@@ -165,7 +165,8 @@ GLOBAL_VAR(restart_counter)
  start_log(GLOB.tgui_log)
  start_log(GLOB.world_shuttle_log)
 
- GLOB.changelog_hash = md5('html/changelog.html') //for telling if the changelog has changed recently
+ var/latest_changelog = file("[global.config.directory]/../html/changelogs/archive/" + time2text(world.timeofday, "YYYY-MM") + ".yml")
+ GLOB.changelog_hash = fexists(latest_changelog) ? md5(latest_changelog) : 0 //for telling if the changelog has changed recently
  if(fexists(GLOB.config_error_log))
  fcopy(GLOB.config_error_log, "[GLOB.log_directory]/config_error.log")
  fdel(GLOB.config_error_log)

code/modules/asset_cache/asset_list.dm

@@ -248,6 +248,24 @@ GLOBAL_LIST_EMPTY(asset_datums)
 #undef SPRSZ_STRIPPED
 
 
+/datum/asset/changelog_item
+ _abstract = /datum/asset/changelog_item
+ var/item_filename
+
+/datum/asset/changelog_item/New(date)
+ item_filename = sanitize_filename("[date].yml")
+ SSassets.transport.register_asset(item_filename, file("html/changelogs/archive/" + item_filename))
+
+/datum/asset/changelog_item/send(client)
+ if (!item_filename)
+ return
+ . = SSassets.transport.send_assets(client, item_filename)
+
+/datum/asset/changelog_item/get_url_mappings()
+ if (!item_filename)
+ return
+ . = list("[item_filename]" = SSassets.transport.get_asset_url(item_filename))
+
 /datum/asset/spritesheet/simple
  _abstract = /datum/asset/spritesheet/simple
  var/list/assets

code/modules/asset_cache/asset_list_items.dm

@@ -125,31 +125,6 @@
  /datum/asset/simple/irv
  )
 
-/datum/asset/simple/namespaced/changelog
- assets = list(
- "88x31.png" = 'html/88x31.png',
- "bug-minus.png" = 'html/bug-minus.png',
- "cross-circle.png" = 'html/cross-circle.png',
- "hard-hat-exclamation.png" = 'html/hard-hat-exclamation.png',
- "image-minus.png" = 'html/image-minus.png',
- "image-plus.png" = 'html/image-plus.png',
- "music-minus.png" = 'html/music-minus.png',
- "music-plus.png" = 'html/music-plus.png',
- "tick-circle.png" = 'html/tick-circle.png',
- "wrench-screwdriver.png" = 'html/wrench-screwdriver.png',
- "spell-check.png" = 'html/spell-check.png',
- "burn-exclamation.png" = 'html/burn-exclamation.png',
- "chevron.png" = 'html/chevron.png',
- "chevron-expand.png" = 'html/chevron-expand.png',
- "scales.png" = 'html/scales.png',
- "coding.png" = 'html/coding.png',
- "ban.png" = 'html/ban.png',
- "chrome-wrench.png" = 'html/chrome-wrench.png',
- "changelog.css" = 'html/changelog.css'
- )
- parents = list("changelog.html" = 'html/changelog.html')
-
-
 /datum/asset/simple/jquery
  legacy = TRUE
  assets = list(

code/modules/mob/dead/crew_manifest.dm

@@ -13,7 +13,8 @@
  ui.open()
 
 /datum/crew_manifest/ui_act(action, list/params, datum/tgui/ui, datum/ui_state/state)
- if (..())
+ . = ..()
+ if(.)
  return
 
 /datum/crew_manifest/ui_data(mob/user)

html/changelogs/example.yml

@@ -6,20 +6,20 @@
 # Your changelog will be merged with a master changelog. (New stuff added only, and only on the date entry for the day it was merged.)
 # When it is, any changes listed below will disappear.
 #
-# Valid Prefixes: 
+# Valid Prefixes:
 # bugfix
 # - (fixes bugs)
 # wip
 # - (work in progress)
-# tweak
-# - (tweaks something)
+# qol
+# - (quality of life)
 # soundadd
 # - (adds a sound)
 # sounddel
 # - (removes a sound)
-# rscdel
-# - (adds a feature)
 # rscadd
+# - (adds a feature)
+# rscdel
 # - (removes a feature)
 # imageadd
 # - (adds an image or sprite)
@@ -29,8 +29,6 @@
 # - (fixes spelling or grammar)
 # experiment
 # - (experimental change)
-# tgs
-# - (TGS change)
 # balance
 # - (balance changes)
 # code_imp
@@ -45,7 +43,7 @@
 # - (miscellaneous changes to server)
 #################################
 
-# Your name. 
+# Your name.
 author: "
 
 # Optional: Remove this file after generating master changelog. Useful for PR changelogs that won't get used again.
@@ -56,6 +54,6 @@ delete-after: True
 # SCREW THIS UP AND IT WON'T WORK.
 # Also, this gets changed to [] after reading. Just remove the brackets when you add new shit.
 # Please surround your changes in double quotes ("). It works without them, but if you use certain characters it screws up compiling. The quotes will not show up in the changelog.
-changes: 
+changes:
  - rscadd: "Added a changelog editing system that should cause fewer conflicts and more accurate timestamps."
  - rscdel: "Killed innocent kittens."

interface/interface.dm

@@ -101,9 +101,10 @@
 /client/verb/changelog()
  set name = "Changelog"
  set category = "OOC"
- var/datum/asset/simple/namespaced/changelog = get_asset_datum(/datum/asset/simple/namespaced/changelog)
- changelog.send(src)
- src << browse(changelog.get_htmlloader("changelog.html"), "window=changes;size=675x650")
+ if(!GLOB.changelog_tgui)
+ GLOB.changelog_tgui = new /datum/changelog()
+
+ GLOB.changelog_tgui.ui_interact(usr)
  if(prefs.lastchangelog != GLOB.changelog_hash)
  prefs.lastchangelog = GLOB.changelog_hash
  prefs.save_preferences()

tgstation.dme

@@ -467,6 +467,7 @@
 #include "code\datums\brain_damage\severe.dm"
 #include "code\datums\brain_damage\special.dm"
 #include "code\datums\brain_damage\split_personality.dm"
+#include "code\datums\changelog\changelog.dm"
 #include "code\datums\components\_component.dm"
 #include "code\datums\components\acid.dm"
 #include "code\datums\components\anti_magic.dm"