add pretty/canonical path functions

diff --git a/mutt/path.c b/mutt/path.c
index 43be8e191782a820ce2408052561ea9e0d991c6f..16fb312d0680f296c462749301427a3c96b90248 100644 (file)
--- a/mutt/path.c
+++ b/mutt/path.c
@@ -161,3 +161,100 @@ bool mutt_path_tidy(char *buf)
 
   return mutt_path_tidy_dotdot(buf);
 }
+
+/**
+ * mutt_path_pretty - Tidy a filesystem path
+ * @param buf    Path to modify
+ * @param buflen Length of the buffer
+ * @param homedir Home directory for '~' substitution
+ * @retval true Success
+ *
+ * Tidy a path and replace a home directory with '~'
+ */
+bool mutt_path_pretty(char *buf, size_t buflen, const char *homedir)
+{
+  if (!buf)
+    return false;
+
+  mutt_path_tidy(buf);
+
+  size_t len = mutt_str_strlen(homedir);
+  if ((len == 0) || (len >= buflen))
+    return false;
+
+  char end = buf[len];
+  if ((end != '/') && (end != '\0'))
+    return false;
+
+  if (mutt_str_strncmp(buf, homedir, len) != 0)
+    return false;
+
+  buf[0] = '~';
+  if (end == '\0')
+  {
+    buf[1] = '\0';
+    return true;
+  }
+
+  mutt_str_strfcpy(buf + 1, buf + len, buflen - len);
+  return true;
+}
+
+/**
+ * mutt_path_canon - Create the canonical version of a path
+ * @param buf     Path to modify
+ * @param buflen  Length of the buffer
+ * @param homedir Home directory for '~' substitution
+ * @retval true Success
+ *
+ * Remove unnecessary dots and slashes from a path and expand shell '~'
+ * abbreviations:
+ * - ~/dir (~ expanded)
+ * - ~realuser/dir (~realuser expanded)
+ * - ~nonuser/dir (~nonuser not changed)
+ */
+bool mutt_path_canon(char *buf, size_t buflen, const char *homedir)
+{
+  if (!buf || (buf[0] != '~'))
+    return false;
+
+  char result[PATH_MAX] = { 0 };
+  char *dir = NULL;
+  size_t len = 0;
+
+  if ((buf[1] == '/') || (buf[1] == '\0'))
+  {
+    if (!homedir)
+      return false;
+
+    len = mutt_str_strfcpy(result, homedir, sizeof(result));
+    dir = buf + 1;
+  }
+  else
+  {
+    char user[SHORT_STRING];
+    dir = strchr(buf + 1, '/');
+    if (dir)
+      mutt_str_strfcpy(user, buf + 1, MIN(dir - buf, (unsigned) sizeof(user)));
+    else
+      mutt_str_strfcpy(user, buf + 1, sizeof(user));
+
+    struct passwd *pw = getpwnam(user);
+    if (!pw || !pw->pw_dir)
+      return false;
+
+    len = mutt_str_strfcpy(result, pw->pw_dir, sizeof(result));
+  }
+
+  len += mutt_str_strfcpy(result + len, dir, sizeof(result) - len);
+
+  if (len >= buflen)
+    return false;
+
+  mutt_str_strfcpy(buf, result, buflen);
+
+  if (!mutt_path_tidy(buf))
+    return false;
+
+  return true;
+}

diff --git a/mutt/path.h b/mutt/path.h
index df52e97a48c183cc7f294aa65c511f13e7e5b7e8..42b3404c3a400004bd3f59253f75f2d8d70fe8c3 100644 (file)
--- a/mutt/path.h
+++ b/mutt/path.h
@@ -30,4 +30,7 @@ bool mutt_path_tidy       (char *buf);
 bool mutt_path_tidy_dotdot(char *buf);
 bool mutt_path_tidy_slash (char *buf);
 
+bool mutt_path_canon (char *buf, size_t buflen, const char *homedir);
+bool mutt_path_pretty(char *buf, size_t buflen, const char *homedir);
+
 #endif /* _MUTT_PATH_H */