Return user paths relative to effective user's homedir #105
Conversation
This file contains hidden or 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
Since `os.path.expanduser()` is used to expand the `~` to the home directory, paths which use `~` will always return a path relative to the home directory of the user under which the python process is running. However, if the euid has been changed, this means that these paths will be incorrect, leading to problems when the non-privleged user tries to write to these paths. This commit fixes that issue by attempting to get the username matching the euid, and using that username (e.g. `~user/.cache`) when invoking `os.path.expanduser()`.
Kriskras99
suggested changes
May 3, 2018
appdirs.py
Outdated
| @@ -41,6 +46,12 @@ | |||
| system = sys.platform | |||
|
|
|||
|
|
|||
| def _effective_user(): | |||
There was a problem hiding this comment.
This function should probably be placed at the bottom of the file, because all the support functions are located there.
appdirs.py
Outdated
| path = os.getenv('XDG_CACHE_HOME', os.path.expanduser('~/.cache')) | ||
| if appname: | ||
| path = os.path.join(path, appname) | ||
| user = _effective_user() |
appdirs.py
Outdated
| path = os.getenv('XDG_CONFIG_HOME', os.path.expanduser("~/.config")) | ||
| if appname: | ||
| path = os.path.join(path, appname) | ||
| user = _effective_user() |
There was a problem hiding this comment.
I think it's cleaner to have _effective_user() inside the format just like you did in user_state_dir() and user_log_dir()
appdirs.py
Outdated
| @@ -395,7 +426,7 @@ def user_log_dir(appname=None, appauthor=None, version=None, opinion=True): | |||
| """ | |||
| if system == "darwin": | |||
| path = os.path.join( | |||
| os.path.expanduser('~/Library/Logs'), | |||
| os.path.expanduser('~{0}/Library/Logs'.format(_effective_user())), | |||
| appname) | |||
There was a problem hiding this comment.
Can you put the round bracket on a new line to match what you did in the other functions, or in the other functions don't put the round bracket on a new line.
|
@Kriskras99 Thanks for the review, I've made the requested changes. |
|
Looks great. Now it's up to @zoofood. |
|
Thanks guys, definitely time to get these merged and a new release out. Appreciate all the efforts! |
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.
Since
os.path.expanduser()is used to expand the~to the home directory, paths which use~will always return a path relative to the home directory of the user under which the python process is running. However, if the euid has been changed, this means that these paths will be incorrect, leading to problems when the non-privleged user tries to write to these paths. For example:This PR fixes that issue by attempting to get the username matching the euid, and using that username (e.g.
~user/.cache) when invokingos.path.expanduser(). With the fix, the funcs now return the correct paths relative to the effective user's homedir: