[GSoC][PATCH v4 3/4] credential-cache: use XDG_CACHE_HOME for socket
- From
Devin Lehmacher <lehmacdj@gmail.com>
- Date
- Mar 16, 2017, 05:18 UTC
- Message-ID
- <20170316051827.97198-4-lehmacdj@gmail.com>
- In-Reply-To
- <20170316051827.97198-1-lehmacdj@gmail.com>
Make git-credential-cache follow the XDG base path specification by default. This increases consistency with other applications and helps keep clutter out of users' home directories.
Check the old socket location, ~/.git-credential-cache/, and use ~/.git-credential-cache/socket if that directory exists rather than forcing users who have used `git credential-cache` before to migrate to the new XDG compliant location. Otherwise use the socket $XDG_CACHE_HOME/git/credential/socket following XDG base path specification. Use the subdirectory credential/ in case other files are cached under $XDG_CACHE_HOME/git/ in the future and to make the socket's purpose clear.
Signed-off-by: Devin Lehmacher <lehmacdj@gmail.com> --- Documentation/git-credential-cache.txt | 11 +++++++---- credential-cache.c | 15 ++++++++++++++- 2 files changed, 21 insertions(+), 5 deletions(-)
diff --git a/Documentation/git-credential-cache.txt b/Documentation/git-credential-cache.txt index 96208f822..2b8582639 100644 --- a/Documentation/git-credential-cache.txt +++ b/Documentation/git-credential-cache.txt @@ -33,10 +33,13 @@ OPTIONS --socket <path>:: Use `<path>` to contact a running cache daemon (or start a new - cache daemon if one is not started). Defaults to - `~/.git-credential-cache/socket`. If your home directory is on a - network-mounted filesystem, you may need to change this to a - local filesystem. You must specify an absolute path. + cache daemon if one is not started). + Defaults to `$XDG_CACHE_HOME/git/credential/socket` unless + `~/.git-credential-cache/` exists in which case + `~/.git-credential-cache/socket` is used instead. + If your home directory is on a network-mounted filesystem, you + may need to change this to a local filesystem. You must specify + an absolute path. CONTROLLING THE DAEMON ---------------------- diff --git a/credential-cache.c b/credential-cache.c index cc8a6ee19..1fd800775 100644 --- a/credential-cache.c +++ b/credential-cache.c @@ -1,5 +1,6 @@ #include "cache.h" #include "credential.h" +#include "dir.h" #include "string-list.h" #include "parse-options.h" #include "unix-socket.h" @@ -83,6 +84,18 @@ static void do_cache(const char *socket, const char *action, int timeout, strbuf_release(&buf); } +static char *get_socket_path(void) +{ + char *old_credential_dir, *socket; + old_credential_dir = expand_user_path("~/.git-credential-cache"); + if (old_credential_dir && directory_exists(old_credential_dir)) + socket = expand_user_path("~/.git-credential-cache/socket"); + else + socket = xdg_cache_home("credential/socket"); + free(old_credential_dir); + return socket; +} + int cmd_main(int argc, const char **argv) { char *socket_path = NULL; @@ -106,7 +119,7 @@ int cmd_main(int argc, const char **argv) op = argv[0]; if (!socket_path) - socket_path = expand_user_path("~/.git-credential-cache/socket"); + socket_path = get_socket_path(); if (!socket_path) die("unable to find a suitable socket path; use --socket");
-- 2.11.0