cli: update config file paths and plugin dirs on all OSes #3766

bastimeyer · 2021-06-01T16:54:20Z

According to the XDG base directory specification, only configuration files are supposed to be in the XDG_CONFIG_HOME directory. This means that Streamlink's custom plugin files directory should default to XDG_DATA_HOME and not to XDG_CONFIG_HOME, as plugin files are not configuration files.

The first commit therefore refactors the CLI's path constants and enables having a list of default plugin dirs.
The second commit adds XDG_DATA_HOME to the PLUGIN_DIRS on POSIX in addition to XDG_CONFIG_HOME for backwards compatibility.
I've also reformatted the CLI docs a bit for better readability (check the preview).

This also raises the question whether we should add %APPDATA%\streamlink\config to the CONFIG_FILES list on Windows, in addition to %APPDATA%\streamlink\streamlinkrc. The current config file name comes from the time when Livestreamer was still using the ~/.livestreamerrc config file, which is deprecated anyway (not officially flagged as deprecated, but we could do that too). Yes, these are technically "run command files", hence the "rc" suffix, but the primary/intended config file name on non-Windows systems is already "config" and this helps solving confusion, especially for the average Windows user.

Also not really sure about macOS. It has been treated as non-Windows the whole time (of course), but the XDG base dir spec doesn't really apply to it and they have other conventions (see the new log dir for example). This could also be corrected in another commit. Config path and plugin dir should be ${HOME}/Library/Application Support/streamlink/config and ${HOME}/Library/Application Support/streamlink/plugins respectively if I'm not mistaken.

Question 1:

Add %APPDATA%\streamlink\config in addition to %APPDATA%\streamlink\streamlinkrc (and update config file path in the installer)?

Question 2:

Use correct config and plugin paths on macOS?

Question 3:

Document ~/.streamlinkrc as deprecated in the docs and remove it in the next major release 3.0.0?

gravyboat · 2021-06-05T19:02:57Z

Changes look good, in regards to your questions:

Yes.
Yes.
Yes.

bastimeyer · 2021-06-05T21:22:23Z

Summary

Linux/BSD
Add ${XDG_DATA_HOME:-${HOME}/.local/share}/streamlink/plugins as first plugins dir,
but keep ${XDG_CONFIG_HOME:-${HOME}/.config}/streamlink/plugins as secondary plugins dir.
Windows
Add %APPDATA%\streamlink\config as first config file path,
but keep %APPDATA%\streamlink\streamlinkrc as secondary config file path.
macOS
- Add ${HOME}/Library/Application Support/streamlink/config as first config file path,
  but keep ${XDG_CONFIG_HOME:-${HOME}/.config}/streamlink/config as secondary
  and ${HOME}/.streamlinkrc as third config file paths.
- Add ${HOME}/Library/Application Support/streamlink/plugins as first plugins dir,
  but keep ${XDG_CONFIG_HOME:-${HOME}/.config}/streamlink/plugins as secondary plugins dir.

edit: deprecate in a separate PR after merging this one

Officially deprecate

Windows
- %APPDATA%\streamlink\streamlinkrc
macOS
- ${XDG_CONFIG_HOME:-${HOME}/.config}/streamlink/config
- ${HOME}/.streamlinkrc
- ${XDG_CONFIG_HOME:-${HOME}/.config}/streamlink/plugins
Linux/BSD
- ${HOME}/.streamlinkrc
- ${XDG_CONFIG_HOME:-${HOME}/.config}/streamlink/plugins

bastimeyer · 2021-06-05T21:28:22Z

Not sure if the OSes should be properly split up in the docs. I've added macOS as another row to the three tables, but kept the "Unix-like (POSIX)" rows, which implies that macOS is included. This avoids having redundant paths, but also doesn't show that the regular POSIX paths are deprecated on macOS. So should the "Unix-like (POSIX)" rows be renamed to "Linux/BSD" and those paths added to the macOS rows (as deprecated)?

gravyboat · 2021-06-05T22:36:36Z

So should the "Unix-like (POSIX)" rows be renamed to "Linux/BSD" and those paths added to the macOS rows (as deprecated)?

I'd say this is a good plan. It clarifies things further and leads to less confusion which is always a plus.

- use pathlib.Path instead of strings - rename PLUGINS_DIR to PLUGIN_DIRS and turn into list - call expanduser() for all `--plugin-dirs` dirs - reformat CLI docs - fix tests

Keep XDG_CONFIG_HOME for backwards compatibility

but keep "streamlinkrc" as secondary file for backwards compatiblity

Keep old paths for backwards compatiblity. Also fix logs dir (see --logfile). New default config path: ~/Library/Application Support/streamlink/config New default plugins dir: ~/Library/Application Support/streamlink/plugins

bastimeyer · 2021-06-06T00:05:44Z

Updated the docs (with additional stylesheet updates) and properly split up the path definitions between macOS and Linux/BSD, which also means that the new XDG_DATA_HOME plugins dir is not part of the macOS plugins dir list, only the old/deprecated XDG_CONFIG_HOME one. I've updated my previous comment accordingly.

bastimeyer · 2021-06-06T00:18:47Z

Do we need deprecation log messages when loading stuff from those paths?

gravyboat · 2021-06-06T03:27:16Z

@bastimeyer I feel like it's overkill but I've also learned people don't read the release notes and like to complain later. Will people read the CLI output noting as much? I'm not sure. If it's not too much work it's probably worth adding so we can point at release notes and CLI output when someone inevitably complains.

bastimeyer · 2021-06-06T13:23:31Z

I've added the deprecation log messages. See my updated commit and its message.

For some reason, logging a warning message still prints the message even while in json output mode, where loglevel should be none. That's why it's logging to info instead.
It only logs deprecated plugin paths when at least one plugin was successfully loaded. Load failures are being logged separately in all cases.
No tests, as there weren't any tests for load_plugins, setup_args and setup_config_args prior to my changes and I don't want to write them. The changes are simple enough though.
There's some optimization that can be done in the setup_args and setup_config_args. This can be done later and tests added as well.

bastimeyer · 2021-06-06T13:27:37Z

If you want, we can deprecate these paths in another PR. That would probably be better for transparency reasons.

gravyboat · 2021-06-06T18:38:09Z

@bastimeyer Should the deprecation message include information about where the new config directory is? Seems like just telling people the dir is deprecated without saying where to move things to might lead to some confusion.

If you want, we can deprecate these paths in another PR. That would probably be better for transparency reasons.

Agreed.

bastimeyer · 2021-06-06T18:48:11Z

I'll add a docs-reference to the log messages in the deprecation PR once this one has been merged. As you can see, I removed the deprecation commit, so this PR here should be good unless someone spots a mistake.

See streamlink/streamlink#3766

bastimeyer added the CLI label Jun 1, 2021

bastimeyer force-pushed the cli/config-files-and-plugin-dir branch from 5fccab6 to d37e4e5 Compare June 1, 2021 17:01

bastimeyer force-pushed the cli/config-files-and-plugin-dir branch from d37e4e5 to fb7814e Compare June 5, 2021 21:01

bastimeyer changed the title ~~cli: add XDG_DATA_HOME as first plugins dir~~ cli: update config file paths and plugin dirs on all OSes Jun 5, 2021

bastimeyer added 4 commits June 6, 2021 01:52

cli: refactor CONFIG_FILES and PLUGIN_DIRS

2570cc0

- use pathlib.Path instead of strings - rename PLUGINS_DIR to PLUGIN_DIRS and turn into list - call expanduser() for all `--plugin-dirs` dirs - reformat CLI docs - fix tests

cli: add XDG_DATA_HOME as first plugins dir

52c2d30

Keep XDG_CONFIG_HOME for backwards compatibility

cli: rename config file on Windows to "config"

51640f9

but keep "streamlinkrc" as secondary file for backwards compatiblity

cli: use correct config and plugins dir on macOS

7ec8a89

Keep old paths for backwards compatiblity. Also fix logs dir (see --logfile). New default config path: ~/Library/Application Support/streamlink/config New default plugins dir: ~/Library/Application Support/streamlink/plugins

bastimeyer force-pushed the cli/config-files-and-plugin-dir branch from fb7814e to ce06efd Compare June 6, 2021 00:00

bastimeyer force-pushed the cli/config-files-and-plugin-dir branch from ce06efd to 63fe719 Compare June 6, 2021 13:09

bastimeyer force-pushed the cli/config-files-and-plugin-dir branch from 63fe719 to 7ec8a89 Compare June 6, 2021 14:56

bastimeyer added the PR: rebase commits Commits can be included as is on the base branch via a rebase (will alter SHAs) label Jun 6, 2021

gravyboat merged commit 565397e into streamlink:master Jun 6, 2021

bastimeyer deleted the cli/config-files-and-plugin-dir branch June 6, 2021 18:50

404NetworkError added a commit to 404NetworkError/scoop-extras that referenced this pull request Jul 11, 2021

streamlink: Update 2.2.0 config path

6e9fcca

See streamlink/streamlink#3766

404NetworkError mentioned this pull request Jul 11, 2021

streamlink: Update 2.2.0 config path ScoopInstaller/Extras#6476

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

cli: update config file paths and plugin dirs on all OSes #3766

cli: update config file paths and plugin dirs on all OSes #3766

Uh oh!

bastimeyer commented Jun 1, 2021 •

edited

Loading

Uh oh!

gravyboat commented Jun 5, 2021

Uh oh!

bastimeyer commented Jun 5, 2021 •

edited

Loading

Uh oh!

bastimeyer commented Jun 5, 2021

Uh oh!

gravyboat commented Jun 5, 2021

Uh oh!

bastimeyer commented Jun 6, 2021 •

edited

Loading

Uh oh!

bastimeyer commented Jun 6, 2021

Uh oh!

gravyboat commented Jun 6, 2021 •

edited

Loading

Uh oh!

bastimeyer commented Jun 6, 2021 •

edited

Loading

Uh oh!

bastimeyer commented Jun 6, 2021

Uh oh!

gravyboat commented Jun 6, 2021 •

edited

Loading

Uh oh!

bastimeyer commented Jun 6, 2021

Uh oh!

Uh oh!

Uh oh!

cli: update config file paths and plugin dirs on all OSes #3766

cli: update config file paths and plugin dirs on all OSes #3766

Uh oh!

Conversation

bastimeyer commented Jun 1, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Question 1:

Question 2:

Question 3:

Uh oh!

gravyboat commented Jun 5, 2021

Uh oh!

bastimeyer commented Jun 5, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Officially deprecate

Uh oh!

bastimeyer commented Jun 5, 2021

Uh oh!

gravyboat commented Jun 5, 2021

Uh oh!

bastimeyer commented Jun 6, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bastimeyer commented Jun 6, 2021

Uh oh!

gravyboat commented Jun 6, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bastimeyer commented Jun 6, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bastimeyer commented Jun 6, 2021

Uh oh!

gravyboat commented Jun 6, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bastimeyer commented Jun 6, 2021

Uh oh!

Uh oh!

bastimeyer commented Jun 1, 2021 •

edited

Loading

bastimeyer commented Jun 5, 2021 •

edited

Loading

bastimeyer commented Jun 6, 2021 •

edited

Loading

gravyboat commented Jun 6, 2021 •

edited

Loading

bastimeyer commented Jun 6, 2021 •

edited

Loading

gravyboat commented Jun 6, 2021 •

edited

Loading