struct cgit_cmd: Differentiate between various usages of ctx.qry.path

For many commands/pages (e.g. 'tree', 'diff', 'plain', etc.), the
ctx.qry.path argument is interpreted as a path within the "virtual" project
directory structure. However, for some other commands (notably 'refs', and
the clone-related commands) ctx.qry.path is used in a different context (as
a more or less "real" path within the '.git' directory).

This patch differentiates between these two usages of ctx.qry.path, by
introducing a new variable - ctx.qry.vpath - which is equal to ctx.qry.path
in the former case, and NULL in the latter.

This will become useful in future patches when we want various pages and the
links between them to preserve existing in-project paths.

Signed-off-by: Johan Herland <johan@herland.net>
Signed-off-by: Lars Hjemli <hjemli@gmail.com>

4 files changed, 30 insertions, 22 deletions

diff --git a/cgit.c b/cgit.c
index 9305d0a..2c3ad73 100644
--- a/cgit.c
+++ b/cgit.c
@@ -331,192 +331,198 @@ int find_current_ref(const char *refname, const unsigned char *sha1,
         struct refmatch *info;
 
         info = (struct refmatch *)cb_data;
         if (!strcmp(refname, info->req_ref))
                 info->match = 1;
         if (!info->first_ref)
                 info->first_ref = xstrdup(refname);
         return info->match;
 }
 
 char *find_default_branch(struct cgit_repo *repo)
 {
         struct refmatch info;
         char *ref;
 
         info.req_ref = repo->defbranch;
         info.first_ref = NULL;
         info.match = 0;
         for_each_branch_ref(find_current_ref, &info);
         if (info.match)
                 ref = info.req_ref;
         else
                 ref = info.first_ref;
         if (ref)
                 ref = xstrdup(ref);
         return ref;
 }
 
 static int prepare_repo_cmd(struct cgit_context *ctx)
 {
         char *tmp;
         unsigned char sha1[20];
         int nongit = 0;
 
         setenv("GIT_DIR", ctx->repo->path, 1);
         setup_git_directory_gently(&nongit);
         if (nongit) {
                 ctx->page.title = fmt("%s - %s", ctx->cfg.root_title,
                                       "config error");
                 tmp = fmt("Not a git repository: '%s'", ctx->repo->path);
                 ctx->repo = NULL;
                 cgit_print_http_headers(ctx);
                 cgit_print_docstart(ctx);
                 cgit_print_pageheader(ctx);
                 cgit_print_error(tmp);
                 cgit_print_docend();
                 return 1;
         }
         ctx->page.title = fmt("%s - %s", ctx->repo->name, ctx->repo->desc);
 
         if (!ctx->qry.head) {
                 ctx->qry.nohead = 1;
                 ctx->qry.head = find_default_branch(ctx->repo);
                 ctx->repo->defbranch = ctx->qry.head;
         }
 
         if (!ctx->qry.head) {
                 cgit_print_http_headers(ctx);
                 cgit_print_docstart(ctx);
                 cgit_print_pageheader(ctx);
                 cgit_print_error("Repository seems to be empty");
                 cgit_print_docend();
                 return 1;
         }
 
         if (get_sha1(ctx->qry.head, sha1)) {
                 tmp = xstrdup(ctx->qry.head);
                 ctx->qry.head = ctx->repo->defbranch;
                 ctx->page.status = 404;
                 ctx->page.statusmsg = "not found";
                 cgit_print_http_headers(ctx);
                 cgit_print_docstart(ctx);
                 cgit_print_pageheader(ctx);
                 cgit_print_error(fmt("Invalid branch: %s", tmp));
                 cgit_print_docend();
                 return 1;
         }
         return 0;
 }
 
 static void process_request(void *cbdata)
 {
         struct cgit_context *ctx = cbdata;
         struct cgit_cmd *cmd;
 
         cmd = cgit_get_cmd(ctx);
         if (!cmd) {
                 ctx->page.title = "cgit error";
                 cgit_print_http_headers(ctx);
                 cgit_print_docstart(ctx);
                 cgit_print_pageheader(ctx);
                 cgit_print_error("Invalid request");
                 cgit_print_docend();
                 return;
         }
 
+        /* If cmd->want_vpath is set, assume ctx->qry.path contains a "virtual"
+         * in-project path limit to be made available at ctx->qry.vpath.
+         * Otherwise, no path limit is in effect (ctx->qry.vpath = NULL).
+         */
+        ctx->qry.vpath = cmd->want_vpath ? ctx->qry.path : NULL;
+
         if (cmd->want_repo && !ctx->repo) {
                 cgit_print_http_headers(ctx);
                 cgit_print_docstart(ctx);
                 cgit_print_pageheader(ctx);
                 cgit_print_error(fmt("No repository selected"));
                 cgit_print_docend();
                 return;
         }
 
         if (ctx->repo && prepare_repo_cmd(ctx))
                 return;
 
         if (cmd->want_layout) {
                 cgit_print_http_headers(ctx);
                 cgit_print_docstart(ctx);
                 cgit_print_pageheader(ctx);
         }
 
         cmd->fn(ctx);
 
         if (cmd->want_layout)
                 cgit_print_docend();
 }
 
 int cmp_repos(const void *a, const void *b)
 {
         const struct cgit_repo *ra = a, *rb = b;
         return strcmp(ra->url, rb->url);
 }
 
 char *build_snapshot_setting(int bitmap)
 {
         const struct cgit_snapshot_format *f;
         char *result = xstrdup("");
         char *tmp;
         int len;
 
         for (f = cgit_snapshot_formats; f->suffix; f++) {
                 if (f->bit & bitmap) {
                         tmp = result;
                         result = xstrdup(fmt("%s%s ", tmp, f->suffix));
                         free(tmp);
                 }
         }
         len = strlen(result);
         if (len)
                 result[len - 1] = '\0';
         return result;
 }
 
 char *get_first_line(char *txt)
 {
         char *t = xstrdup(txt);
         char *p = strchr(t, '\n');
         if (p)
                 *p = '\0';
         return t;
 }
 
 void print_repo(FILE *f, struct cgit_repo *repo)
 {
         fprintf(f, "repo.url=%s\n", repo->url);
         fprintf(f, "repo.name=%s\n", repo->name);
         fprintf(f, "repo.path=%s\n", repo->path);
         if (repo->owner)
                 fprintf(f, "repo.owner=%s\n", repo->owner);
         if (repo->desc) {
                 char *tmp = get_first_line(repo->desc);
                 fprintf(f, "repo.desc=%s\n", tmp);
                 free(tmp);
         }
         if (repo->readme)
                 fprintf(f, "repo.readme=%s\n", repo->readme);
         if (repo->defbranch)
                 fprintf(f, "repo.defbranch=%s\n", repo->defbranch);
         if (repo->module_link)
                 fprintf(f, "repo.module-link=%s\n", repo->module_link);
         if (repo->section)
                 fprintf(f, "repo.section=%s\n", repo->section);
         if (repo->clone_url)
                 fprintf(f, "repo.clone-url=%s\n", repo->clone_url);
         fprintf(f, "repo.enable-log-filecount=%d\n",
                 repo->enable_log_filecount);
         fprintf(f, "repo.enable-log-linecount=%d\n",
                 repo->enable_log_linecount);
         if (repo->about_filter && repo->about_filter != ctx.cfg.about_filter)
                 fprintf(f, "repo.about-filter=%s\n", repo->about_filter->cmd);
         if (repo->commit_filter && repo->commit_filter != ctx.cfg.commit_filter)
                 fprintf(f, "repo.commit-filter=%s\n", repo->commit_filter->cmd);
         if (repo->source_filter && repo->source_filter != ctx.cfg.source_filter)
                 fprintf(f, "repo.source-filter=%s\n", repo->source_filter->cmd);
         if (repo->snapshots != ctx.cfg.snapshots) {
                 char *tmp = build_snapshot_setting(repo->snapshots);
                 fprintf(f, "repo.snapshots=%s\n", tmp);
                 free(tmp);
         }
diff --git a/cgit.h b/cgit.h
index cd4af72..f990b15 100644
--- a/cgit.h
+++ b/cgit.h
@@ -52,192 +52,193 @@ typedef void (*linediff_fn)(char *line, int len);
 struct cgit_filter {
         char *cmd;
         char **argv;
         int old_stdout;
         int pipe_fh[2];
         int pid;
         int exitstatus;
 };
 
 struct cgit_repo {
         char *url;
         char *name;
         char *path;
         char *desc;
         char *owner;
         char *defbranch;
         char *module_link;
         char *readme;
         char *section;
         char *clone_url;
         int snapshots;
         int enable_log_filecount;
         int enable_log_linecount;
         int enable_remote_branches;
         int max_stats;
         time_t mtime;
         struct cgit_filter *about_filter;
         struct cgit_filter *commit_filter;
         struct cgit_filter *source_filter;
 };
 
 typedef void (*repo_config_fn)(struct cgit_repo *repo, const char *name,
               const char *value);
 
 struct cgit_repolist {
         int length;
         int count;
         struct cgit_repo *repos;
 };
 
 struct commitinfo {
         struct commit *commit;
         char *author;
         char *author_email;
         unsigned long author_date;
         char *committer;
         char *committer_email;
         unsigned long committer_date;
         char *subject;
         char *msg;
         char *msg_encoding;
 };
 
 struct taginfo {
         char *tagger;
         char *tagger_email;
         unsigned long tagger_date;
         char *msg;
 };
 
 struct refinfo {
         const char *refname;
         struct object *object;
         union {
                 struct taginfo *tag;
                 struct commitinfo *commit;
         };
 };
 
 struct reflist {
         struct refinfo **refs;
         int alloc;
         int count;
 };
 
 struct cgit_query {
         int has_symref;
         int has_sha1;
         char *raw;
         char *repo;
         char *page;
         char *search;
         char *grep;
         char *head;
         char *sha1;
         char *sha2;
         char *path;
         char *name;
         char *mimetype;
         char *url;
         char *period;
         int   ofs;
         int nohead;
         char *sort;
         int showmsg;
         int ssdiff;
+        char *vpath;
 };
 
 struct cgit_config {
         char *agefile;
         char *cache_root;
         char *clone_prefix;
         char *css;
         char *favicon;
         char *footer;
         char *head_include;
         char *header;
         char *index_header;
         char *index_info;
         char *logo;
         char *logo_link;
         char *module_link;
         char *robots;
         char *root_title;
         char *root_desc;
         char *root_readme;
         char *script_name;
         char *section;
         char *virtual_root;
         int cache_size;
         int cache_dynamic_ttl;
         int cache_max_create_time;
         int cache_repo_ttl;
         int cache_root_ttl;
         int cache_scanrc_ttl;
         int cache_static_ttl;
         int embedded;
         int enable_filter_overrides;
         int enable_index_links;
         int enable_log_filecount;
         int enable_log_linecount;
         int enable_remote_branches;
         int enable_tree_linenumbers;
         int local_time;
         int max_repo_count;
         int max_commit_count;
         int max_lock_attempts;
         int max_msg_len;
         int max_repodesc_len;
         int max_blob_size;
         int max_stats;
         int nocache;
         int noplainemail;
         int noheader;
         int renamelimit;
         int snapshots;
         int summary_branches;
         int summary_log;
         int summary_tags;
         int ssdiff;
         struct string_list mimetypes;
         struct cgit_filter *about_filter;
         struct cgit_filter *commit_filter;
         struct cgit_filter *source_filter;
 };
 
 struct cgit_page {
         time_t modified;
         time_t expires;
         size_t size;
         char *mimetype;
         char *charset;
         char *filename;
         char *etag;
         char *title;
         int status;
         char *statusmsg;
 };
 
 struct cgit_environment {
         char *cgit_config;
         char *http_host;
         char *https;
         char *no_http;
         char *path_info;
         char *query_string;
         char *request_method;
         char *script_name;
         char *server_name;
         char *server_port;
 };
 
 struct cgit_context {
         struct cgit_environment env;
         struct cgit_query qry;
         struct cgit_config cfg;
         struct cgit_repo *repo;
         struct cgit_page page;
 };
 
 struct cgit_snapshot_format {
         const char *suffix;
diff --git a/cmd.c b/cmd.c
index 766f903..a9e426a 100644
--- a/cmd.c
+++ b/cmd.c
@@ -36,136 +36,136 @@ static void atom_fn(struct cgit_context *ctx)
         cgit_print_atom(ctx->qry.head, ctx->qry.path, 10);
 }
 
 static void about_fn(struct cgit_context *ctx)
 {
         if (ctx->repo)
                 cgit_print_repo_readme(ctx->qry.path);
         else
                 cgit_print_site_readme();
 }
 
 static void blob_fn(struct cgit_context *ctx)
 {
         cgit_print_blob(ctx->qry.sha1, ctx->qry.path, ctx->qry.head);
 }
 
 static void commit_fn(struct cgit_context *ctx)
 {
         cgit_print_commit(ctx->qry.sha1);
 }
 
 static void diff_fn(struct cgit_context *ctx)
 {
         cgit_print_diff(ctx->qry.sha1, ctx->qry.sha2, ctx->qry.path);
 }
 
 static void info_fn(struct cgit_context *ctx)
 {
         cgit_clone_info(ctx);
 }
 
 static void log_fn(struct cgit_context *ctx)
 {
         cgit_print_log(ctx->qry.sha1, ctx->qry.ofs, ctx->cfg.max_commit_count,
                        ctx->qry.grep, ctx->qry.search, ctx->qry.path, 1);
 }
 
 static void ls_cache_fn(struct cgit_context *ctx)
 {
         ctx->page.mimetype = "text/plain";
         ctx->page.filename = "ls-cache.txt";
         cgit_print_http_headers(ctx);
         cache_ls(ctx->cfg.cache_root);
 }
 
 static void objects_fn(struct cgit_context *ctx)
 {
         cgit_clone_objects(ctx);
 }
 
 static void repolist_fn(struct cgit_context *ctx)
 {
         cgit_print_repolist();
 }
 
 static void patch_fn(struct cgit_context *ctx)
 {
         cgit_print_patch(ctx->qry.sha1);
 }
 
 static void plain_fn(struct cgit_context *ctx)
 {
         cgit_print_plain(ctx);
 }
 
 static void refs_fn(struct cgit_context *ctx)
 {
         cgit_print_refs();
 }
 
 static void snapshot_fn(struct cgit_context *ctx)
 {
         cgit_print_snapshot(ctx->qry.head, ctx->qry.sha1, ctx->qry.path,
                             ctx->repo->snapshots, ctx->qry.nohead);
 }
 
 static void stats_fn(struct cgit_context *ctx)
 {
         cgit_show_stats(ctx);
 }
 
 static void summary_fn(struct cgit_context *ctx)
 {
         cgit_print_summary();
 }
 
 static void tag_fn(struct cgit_context *ctx)
 {
         cgit_print_tag(ctx->qry.sha1);
 }
 
 static void tree_fn(struct cgit_context *ctx)
 {
         cgit_print_tree(ctx->qry.sha1, ctx->qry.path);
 }
 
-#define def_cmd(name, want_repo, want_layout) \
-        {#name, name##_fn, want_repo, want_layout}
+#define def_cmd(name, want_repo, want_layout, want_vpath) \
+        {#name, name##_fn, want_repo, want_layout, want_vpath}
 
 struct cgit_cmd *cgit_get_cmd(struct cgit_context *ctx)
 {
         static struct cgit_cmd cmds[] = {
-                def_cmd(HEAD, 1, 0),
-                def_cmd(atom, 1, 0),
-                def_cmd(about, 0, 1),
-                def_cmd(blob, 1, 0),
-                def_cmd(commit, 1, 1),
-                def_cmd(diff, 1, 1),
-                def_cmd(info, 1, 0),
-                def_cmd(log, 1, 1),
-                def_cmd(ls_cache, 0, 0),
-                def_cmd(objects, 1, 0),
-                def_cmd(patch, 1, 0),
-                def_cmd(plain, 1, 0),
-                def_cmd(refs, 1, 1),
-                def_cmd(repolist, 0, 0),
-                def_cmd(snapshot, 1, 0),
-                def_cmd(stats, 1, 1),
-                def_cmd(summary, 1, 1),
-                def_cmd(tag, 1, 1),
-                def_cmd(tree, 1, 1),
+                def_cmd(HEAD, 1, 0, 0),
+                def_cmd(atom, 1, 0, 0),
+                def_cmd(about, 0, 1, 0),
+                def_cmd(blob, 1, 0, 0),
+                def_cmd(commit, 1, 1, 1),
+                def_cmd(diff, 1, 1, 1),
+                def_cmd(info, 1, 0, 0),
+                def_cmd(log, 1, 1, 1),
+                def_cmd(ls_cache, 0, 0, 0),
+                def_cmd(objects, 1, 0, 0),
+                def_cmd(patch, 1, 0, 1),
+                def_cmd(plain, 1, 0, 0),
+                def_cmd(refs, 1, 1, 0),
+                def_cmd(repolist, 0, 0, 0),
+                def_cmd(snapshot, 1, 0, 0),
+                def_cmd(stats, 1, 1, 1),
+                def_cmd(summary, 1, 1, 0),
+                def_cmd(tag, 1, 1, 0),
+                def_cmd(tree, 1, 1, 1),
         };
         int i;
 
         if (ctx->qry.page == NULL) {
                 if (ctx->repo)
                         ctx->qry.page = "summary";
                 else
                         ctx->qry.page = "repolist";
         }
 
         for(i = 0; i < sizeof(cmds)/sizeof(*cmds); i++)
                 if (!strcmp(ctx->qry.page, cmds[i].name))
                         return &cmds[i];
         return NULL;
 }
diff --git a/cmd.h b/cmd.h
index ec9e691..8dc01bd 100644
--- a/cmd.h
+++ b/cmd.h
@@ -1,15 +1,16 @@
 #ifndef CMD_H
 #define CMD_H
 
 typedef void (*cgit_cmd_fn)(struct cgit_context *ctx);
 
 struct cgit_cmd {
         const char *name;
         cgit_cmd_fn fn;
         unsigned int want_repo:1,
-                want_layout:1;
+                want_layout:1,
+                want_vpath:1;
 };
 
 extern struct cgit_cmd *cgit_get_cmd(struct cgit_context *ctx);
 
 #endif /* CMD_H */