Skins support #3475
Merged
Skins support #3475
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
…o the client skinName must be a single string (no directory separators in it) pointing to an existing directory under /src/static/skins. In case these conditions are not met, its value is rewritten to "no-skin". Also, the value of skinName if sent to the client via clientVars for allowing its use it in the browser.
…scripts.
Currently, an Etherpad skin requires the existence of 6 files:
- index.{css,js}
- pad.{css,js}
- timeslider.{css,js}
In the default empty skin (in static/custom), there were 2 small placeholders
({js,css}.template) to be copied in place by the startup script in case no skin
was in use.
Now that we are moving to multiple directories (see #3471) we can simply commit
the example files and remove the copying code from the startup script.
The old empty skin created by the startup scripts becomes the default: no-skin.
"colibris" does not exist yet, but let's mention it anyway.
The old "static/custom" directory is replaced by "static/skins/<skinName>", where <skinName> is taken from settings.json. When no value is found, a default of "no-skin" is assumed, so that backward compatibility is maintained. The most evident security concerns have been addressed. Closes #3471.
|
One more commit updating the documentation, moving from a single Merging. |
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 is the implementation proposal for #3471.
The old
static/customdirectory is replaced bystatic/skins/<skinName>, where<skinName>is taken fromsettings.json.When no value is found, a default of
no-skinis assumed, so that backward compatibility is maintained.In case of
settings.jsonmissing the new parameter, a WARN is generated in the logs.<skinName>is checked against directory traversals on the host file system and XSS in the browser.Tested with the deafult skin and with the new one (colibris, #3441).