Commit 618818dcb7ada52e64b694d00806d18d063b77e0
2011-01-23T16:15:11
Added git_prettify_file_path().
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
diff --git a/src/fileops.c b/src/fileops.c
index 00eb4fc..d23246d 100644
--- a/src/fileops.c
+++ b/src/fileops.c
@@ -456,3 +456,30 @@ int git_prettify_dir_path(char *buffer_out, const char *path)
return GIT_SUCCESS;
}
+
+int git_prettify_file_path(char *buffer_out, const char *path)
+{
+ int error, path_len, i;
+ const char* pattern = "/..";
+
+ path_len = strlen(path);
+
+ /* Let's make sure the filename doesn't end with "/", "/." or "/.." */
+ for (i = 1; path_len > i && i < 4; i++) {
+ if (!strncmp(path + path_len - i, pattern, i))
+ return GIT_ERROR;
+ }
+
+ error = git_prettify_dir_path(buffer_out, path);
+ if (error < GIT_SUCCESS)
+ return error;
+
+ path_len = strlen(buffer_out);
+ if (path_len < 2)
+ return GIT_ERROR;
+
+ /* Remove the trailing slash */
+ buffer_out[path_len - 1] = '\0';
+
+ return GIT_SUCCESS;
+}
diff --git a/src/fileops.h b/src/fileops.h
index d562dc7..1f17960 100644
--- a/src/fileops.h
+++ b/src/fileops.h
@@ -155,4 +155,26 @@ extern int gitfo_close_cached(gitfo_cache *ioc);
*/
GIT_EXTERN(int) git_prettify_dir_path(char *buffer_out, const char *path);
+/**
+ * Clean up a provided absolute or relative file path.
+ *
+ * This prettification relies on basic operations such as coalescing
+ * multiple forward slashes into a single slash, removing '.' and
+ * './' current directory segments, and removing parent directory
+ * whenever '..' is encountered.
+ *
+ * For instance, this will turn "d1/s1///s2/..//../s3" into "d1/s3".
+ *
+ * This only performs a string based analysis of the path.
+ * No checks are done to make sure the path actually makes sense from
+ * the file system perspective.
+ *
+ * @param buffer_out buffer to populate with the normalized path.
+ * @param path file path to clean up.
+ * @return
+ * - GIT_SUCCESS on success;
+ * - GIT_ERROR when the input path is invalid or escapes the current directory.
+ */
+GIT_EXTERN(int) git_prettify_file_path(char *buffer_out, const char *path);
+
#endif /* INCLUDE_fileops_h__ */
diff --git a/tests/t0005-path.c b/tests/t0005-path.c
index dc2ccc9..087373c 100644
--- a/tests/t0005-path.c
+++ b/tests/t0005-path.c
@@ -1,12 +1,14 @@
#include "test_lib.h"
#include "fileops.h"
-static int ensure_normalized(const char *input_path, const char *expected_path)
+typedef int (normalize_path)(char *, const char *);
+
+static int ensure_normalized(const char *input_path, const char *expected_path, normalize_path normalizer)
{
int error = GIT_SUCCESS;
char buffer_out[GIT_PATH_MAX];
- error = git_prettify_dir_path(buffer_out, input_path);
+ error = normalizer(buffer_out, input_path);
if (error < GIT_SUCCESS)
return error;
@@ -19,75 +21,165 @@ static int ensure_normalized(const char *input_path, const char *expected_path)
return error;
}
-BEGIN_TEST(path_prettifying)
- must_pass(ensure_normalized("./testrepo.git", "testrepo.git/"));
- must_pass(ensure_normalized("./.git", ".git/"));
- must_pass(ensure_normalized("./git.", "git./"));
- must_pass(ensure_normalized("git./", "git./"));
- must_pass(ensure_normalized("", ""));
- must_pass(ensure_normalized(".", ""));
- must_pass(ensure_normalized("./", ""));
- must_pass(ensure_normalized("./.", ""));
- must_fail(ensure_normalized("./..", NULL));
- must_fail(ensure_normalized("../.", NULL));
- must_fail(ensure_normalized("./.././/", NULL));
- must_pass(ensure_normalized("dir/..", ""));
- must_pass(ensure_normalized("dir/sub/../..", ""));
- must_pass(ensure_normalized("dir/sub/..///..", ""));
- must_pass(ensure_normalized("dir/sub///../..", ""));
- must_pass(ensure_normalized("dir/sub///..///..", ""));
- must_fail(ensure_normalized("dir/sub/../../..", NULL));
- must_pass(ensure_normalized("dir", "dir/"));
- must_pass(ensure_normalized("dir//", "dir/"));
- must_pass(ensure_normalized("./dir", "dir/"));
- must_pass(ensure_normalized("dir/.", "dir/"));
- must_pass(ensure_normalized("dir///./", "dir/"));
- must_pass(ensure_normalized("dir/sub/..", "dir/"));
- must_pass(ensure_normalized("dir//sub/..", "dir/"));
- must_pass(ensure_normalized("dir//sub/../", "dir/"));
- must_pass(ensure_normalized("dir/sub/../", "dir/"));
- must_pass(ensure_normalized("dir/sub/../.", "dir/"));
- must_pass(ensure_normalized("dir/s1/../s2/", "dir/s2/"));
- must_pass(ensure_normalized("d1/s1///s2/..//../s3/", "d1/s3/"));
- must_pass(ensure_normalized("d1/s1//../s2/../../d2", "d2/"));
- must_pass(ensure_normalized("dir/sub/../", "dir/"));
- must_fail(ensure_normalized("....", NULL));
- must_fail(ensure_normalized("...", NULL));
- must_fail(ensure_normalized("./...", NULL));
- must_fail(ensure_normalized("d1/...", NULL));
- must_fail(ensure_normalized("d1/.../", NULL));
- must_fail(ensure_normalized("d1/.../d2", NULL));
+static int ensure_dir_path_normalized(const char *input_path, const char *expected_path)
+{
+ return ensure_normalized(input_path, expected_path, git_prettify_dir_path);
+}
+
+static int ensure_file_path_normalized(const char *input_path, const char *expected_path)
+{
+ return ensure_normalized(input_path, expected_path, git_prettify_file_path);
+}
+
+BEGIN_TEST(file_path_prettifying)
+ must_pass(ensure_file_path_normalized("a", "a"));
+ must_pass(ensure_file_path_normalized("./testrepo.git", "testrepo.git"));
+ must_pass(ensure_file_path_normalized("./.git", ".git"));
+ must_pass(ensure_file_path_normalized("./git.", "git."));
+ must_fail(ensure_file_path_normalized("git./", NULL));
+ must_fail(ensure_file_path_normalized("", NULL));
+ must_fail(ensure_file_path_normalized(".", NULL));
+ must_fail(ensure_file_path_normalized("./", NULL));
+ must_fail(ensure_file_path_normalized("./.", NULL));
+ must_fail(ensure_file_path_normalized("./..", NULL));
+ must_fail(ensure_file_path_normalized("../.", NULL));
+ must_fail(ensure_file_path_normalized("./.././/", NULL));
+ must_fail(ensure_file_path_normalized("dir/..", NULL));
+ must_fail(ensure_file_path_normalized("dir/sub/../..", NULL));
+ must_fail(ensure_file_path_normalized("dir/sub/..///..", NULL));
+ must_fail(ensure_file_path_normalized("dir/sub///../..", NULL));
+ must_fail(ensure_file_path_normalized("dir/sub///..///..", NULL));
+ must_fail(ensure_file_path_normalized("dir/sub/../../..", NULL));
+ must_pass(ensure_file_path_normalized("dir", "dir"));
+ must_fail(ensure_file_path_normalized("dir//", NULL));
+ must_pass(ensure_file_path_normalized("./dir", "dir"));
+ must_fail(ensure_file_path_normalized("dir/.", NULL));
+ must_fail(ensure_file_path_normalized("dir///./", NULL));
+ must_fail(ensure_file_path_normalized("dir/sub/..", NULL));
+ must_fail(ensure_file_path_normalized("dir//sub/..",NULL));
+ must_fail(ensure_file_path_normalized("dir//sub/../", NULL));
+ must_fail(ensure_file_path_normalized("dir/sub/../", NULL));
+ must_fail(ensure_file_path_normalized("dir/sub/../.", NULL));
+ must_fail(ensure_file_path_normalized("dir/s1/../s2/", NULL));
+ must_fail(ensure_file_path_normalized("d1/s1///s2/..//../s3/", NULL));
+ must_pass(ensure_file_path_normalized("d1/s1//../s2/../../d2", "d2"));
+ must_fail(ensure_file_path_normalized("dir/sub/../", NULL));
+ must_fail(ensure_file_path_normalized("....", NULL));
+ must_fail(ensure_file_path_normalized("...", NULL));
+ must_fail(ensure_file_path_normalized("./...", NULL));
+ must_fail(ensure_file_path_normalized("d1/...", NULL));
+ must_fail(ensure_file_path_normalized("d1/.../", NULL));
+ must_fail(ensure_file_path_normalized("d1/.../d2", NULL));
+
+ must_pass(ensure_file_path_normalized("/a", "/a"));
+ must_pass(ensure_file_path_normalized("/./testrepo.git", "/testrepo.git"));
+ must_pass(ensure_file_path_normalized("/./.git", "/.git"));
+ must_pass(ensure_file_path_normalized("/./git.", "/git."));
+ must_fail(ensure_file_path_normalized("/git./", NULL));
+ must_fail(ensure_file_path_normalized("/", NULL));
+ must_fail(ensure_file_path_normalized("/.", NULL));
+ must_fail(ensure_file_path_normalized("/./", NULL));
+ must_fail(ensure_file_path_normalized("/./.", NULL));
+ must_fail(ensure_file_path_normalized("/./..", NULL));
+ must_fail(ensure_file_path_normalized("/../.", NULL));
+ must_fail(ensure_file_path_normalized("/./.././/", NULL));
+ must_fail(ensure_file_path_normalized("/dir/..", NULL));
+ must_fail(ensure_file_path_normalized("/dir/sub/../..", NULL));
+ must_fail(ensure_file_path_normalized("/dir/sub/..///..", NULL));
+ must_fail(ensure_file_path_normalized("/dir/sub///../..", NULL));
+ must_fail(ensure_file_path_normalized("/dir/sub///..///..", NULL));
+ must_fail(ensure_file_path_normalized("/dir/sub/../../..", NULL));
+ must_pass(ensure_file_path_normalized("/dir", "/dir"));
+ must_fail(ensure_file_path_normalized("/dir//", NULL));
+ must_pass(ensure_file_path_normalized("/./dir", "/dir"));
+ must_fail(ensure_file_path_normalized("/dir/.", NULL));
+ must_fail(ensure_file_path_normalized("/dir///./", NULL));
+ must_fail(ensure_file_path_normalized("/dir/sub/..", NULL));
+ must_fail(ensure_file_path_normalized("/dir//sub/..",NULL));
+ must_fail(ensure_file_path_normalized("/dir//sub/../", NULL));
+ must_fail(ensure_file_path_normalized("/dir/sub/../", NULL));
+ must_fail(ensure_file_path_normalized("/dir/sub/../.", NULL));
+ must_fail(ensure_file_path_normalized("/dir/s1/../s2/", NULL));
+ must_fail(ensure_file_path_normalized("/d1/s1///s2/..//../s3/", NULL));
+ must_pass(ensure_file_path_normalized("/d1/s1//../s2/../../d2", "/d2"));
+ must_fail(ensure_file_path_normalized("/dir/sub/../", NULL));
+ must_fail(ensure_file_path_normalized("/....", NULL));
+ must_fail(ensure_file_path_normalized("/...", NULL));
+ must_fail(ensure_file_path_normalized("/./...", NULL));
+ must_fail(ensure_file_path_normalized("/d1/...", NULL));
+ must_fail(ensure_file_path_normalized("/d1/.../", NULL));
+ must_fail(ensure_file_path_normalized("/d1/.../d2", NULL));
+END_TEST
+
+BEGIN_TEST(dir_path_prettifying)
+ must_pass(ensure_dir_path_normalized("./testrepo.git", "testrepo.git/"));
+ must_pass(ensure_dir_path_normalized("./.git", ".git/"));
+ must_pass(ensure_dir_path_normalized("./git.", "git./"));
+ must_pass(ensure_dir_path_normalized("git./", "git./"));
+ must_pass(ensure_dir_path_normalized("", ""));
+ must_pass(ensure_dir_path_normalized(".", ""));
+ must_pass(ensure_dir_path_normalized("./", ""));
+ must_pass(ensure_dir_path_normalized("./.", ""));
+ must_fail(ensure_dir_path_normalized("./..", NULL));
+ must_fail(ensure_dir_path_normalized("../.", NULL));
+ must_fail(ensure_dir_path_normalized("./.././/", NULL));
+ must_pass(ensure_dir_path_normalized("dir/..", ""));
+ must_pass(ensure_dir_path_normalized("dir/sub/../..", ""));
+ must_pass(ensure_dir_path_normalized("dir/sub/..///..", ""));
+ must_pass(ensure_dir_path_normalized("dir/sub///../..", ""));
+ must_pass(ensure_dir_path_normalized("dir/sub///..///..", ""));
+ must_fail(ensure_dir_path_normalized("dir/sub/../../..", NULL));
+ must_pass(ensure_dir_path_normalized("dir", "dir/"));
+ must_pass(ensure_dir_path_normalized("dir//", "dir/"));
+ must_pass(ensure_dir_path_normalized("./dir", "dir/"));
+ must_pass(ensure_dir_path_normalized("dir/.", "dir/"));
+ must_pass(ensure_dir_path_normalized("dir///./", "dir/"));
+ must_pass(ensure_dir_path_normalized("dir/sub/..", "dir/"));
+ must_pass(ensure_dir_path_normalized("dir//sub/..", "dir/"));
+ must_pass(ensure_dir_path_normalized("dir//sub/../", "dir/"));
+ must_pass(ensure_dir_path_normalized("dir/sub/../", "dir/"));
+ must_pass(ensure_dir_path_normalized("dir/sub/../.", "dir/"));
+ must_pass(ensure_dir_path_normalized("dir/s1/../s2/", "dir/s2/"));
+ must_pass(ensure_dir_path_normalized("d1/s1///s2/..//../s3/", "d1/s3/"));
+ must_pass(ensure_dir_path_normalized("d1/s1//../s2/../../d2", "d2/"));
+ must_pass(ensure_dir_path_normalized("dir/sub/../", "dir/"));
+ must_fail(ensure_dir_path_normalized("....", NULL));
+ must_fail(ensure_dir_path_normalized("...", NULL));
+ must_fail(ensure_dir_path_normalized("./...", NULL));
+ must_fail(ensure_dir_path_normalized("d1/...", NULL));
+ must_fail(ensure_dir_path_normalized("d1/.../", NULL));
+ must_fail(ensure_dir_path_normalized("d1/.../d2", NULL));
- must_pass(ensure_normalized("/./testrepo.git", "/testrepo.git/"));
- must_pass(ensure_normalized("/./.git", "/.git/"));
- must_pass(ensure_normalized("/./git.", "/git./"));
- must_pass(ensure_normalized("/git./", "/git./"));
- must_pass(ensure_normalized("/", "/"));
- must_pass(ensure_normalized("//", "/"));
- must_pass(ensure_normalized("///", "/"));
- must_pass(ensure_normalized("/.", "/"));
- must_pass(ensure_normalized("/./", "/"));
- must_fail(ensure_normalized("/./..", NULL));
- must_fail(ensure_normalized("/../.", NULL));
- must_fail(ensure_normalized("/./.././/", NULL));
- must_pass(ensure_normalized("/dir/..", "/"));
- must_pass(ensure_normalized("/dir/sub/../..", "/"));
- must_fail(ensure_normalized("/dir/sub/../../..", NULL));
- must_pass(ensure_normalized("/dir", "/dir/"));
- must_pass(ensure_normalized("/dir//", "/dir/"));
- must_pass(ensure_normalized("/./dir", "/dir/"));
- must_pass(ensure_normalized("/dir/.", "/dir/"));
- must_pass(ensure_normalized("/dir///./", "/dir/"));
- must_pass(ensure_normalized("/dir//sub/..", "/dir/"));
- must_pass(ensure_normalized("/dir/sub/../", "/dir/"));
- must_pass(ensure_normalized("//dir/sub/../.", "/dir/"));
- must_pass(ensure_normalized("/dir/s1/../s2/", "/dir/s2/"));
- must_pass(ensure_normalized("/d1/s1///s2/..//../s3/", "/d1/s3/"));
- must_pass(ensure_normalized("/d1/s1//../s2/../../d2", "/d2/"));
- must_fail(ensure_normalized("/....", NULL));
- must_fail(ensure_normalized("/...", NULL));
- must_fail(ensure_normalized("/./...", NULL));
- must_fail(ensure_normalized("/d1/...", NULL));
- must_fail(ensure_normalized("/d1/.../", NULL));
- must_fail(ensure_normalized("/d1/.../d2", NULL));
+ must_pass(ensure_dir_path_normalized("/./testrepo.git", "/testrepo.git/"));
+ must_pass(ensure_dir_path_normalized("/./.git", "/.git/"));
+ must_pass(ensure_dir_path_normalized("/./git.", "/git./"));
+ must_pass(ensure_dir_path_normalized("/git./", "/git./"));
+ must_pass(ensure_dir_path_normalized("/", "/"));
+ must_pass(ensure_dir_path_normalized("//", "/"));
+ must_pass(ensure_dir_path_normalized("///", "/"));
+ must_pass(ensure_dir_path_normalized("/.", "/"));
+ must_pass(ensure_dir_path_normalized("/./", "/"));
+ must_fail(ensure_dir_path_normalized("/./..", NULL));
+ must_fail(ensure_dir_path_normalized("/../.", NULL));
+ must_fail(ensure_dir_path_normalized("/./.././/", NULL));
+ must_pass(ensure_dir_path_normalized("/dir/..", "/"));
+ must_pass(ensure_dir_path_normalized("/dir/sub/../..", "/"));
+ must_fail(ensure_dir_path_normalized("/dir/sub/../../..", NULL));
+ must_pass(ensure_dir_path_normalized("/dir", "/dir/"));
+ must_pass(ensure_dir_path_normalized("/dir//", "/dir/"));
+ must_pass(ensure_dir_path_normalized("/./dir", "/dir/"));
+ must_pass(ensure_dir_path_normalized("/dir/.", "/dir/"));
+ must_pass(ensure_dir_path_normalized("/dir///./", "/dir/"));
+ must_pass(ensure_dir_path_normalized("/dir//sub/..", "/dir/"));
+ must_pass(ensure_dir_path_normalized("/dir/sub/../", "/dir/"));
+ must_pass(ensure_dir_path_normalized("//dir/sub/../.", "/dir/"));
+ must_pass(ensure_dir_path_normalized("/dir/s1/../s2/", "/dir/s2/"));
+ must_pass(ensure_dir_path_normalized("/d1/s1///s2/..//../s3/", "/d1/s3/"));
+ must_pass(ensure_dir_path_normalized("/d1/s1//../s2/../../d2", "/d2/"));
+ must_fail(ensure_dir_path_normalized("/....", NULL));
+ must_fail(ensure_dir_path_normalized("/...", NULL));
+ must_fail(ensure_dir_path_normalized("/./...", NULL));
+ must_fail(ensure_dir_path_normalized("/d1/...", NULL));
+ must_fail(ensure_dir_path_normalized("/d1/.../", NULL));
+ must_fail(ensure_dir_path_normalized("/d1/.../d2", NULL));
END_TEST