ui-tree: use render filters to display content

This allows applying filters to files in the repository, for example to
render Markdown or AsciiDoc as HTML.

Signed-off-by: John Keeping <john@keeping.me.uk>

diff --git a/cgit.css b/cgit.css
index 30c480a5d28ddbe4852c918359fd883a2fb37ded..1f581ec7b02846a7a6c400ad144538ff621eb23b 100644 (file)
--- a/cgit.css
+++ b/cgit.css
@@ -282,6 +282,11 @@ div#cgit div#blob {
        border: solid 1px black;
 }
 
+div#cgit iframe {
+       width: 100%;
+       height: 40em;
+}
+
 div#cgit div.error {
        color: red;
        font-weight: bold;

diff --git a/cmd.c b/cmd.c
index 56e21df1beb6f004ca6817ff3d0d1289c81a4cff..ca48b2feded8a8c84aba4d7f41e4b55dbe50ed14 100644 (file)
--- a/cmd.c
+++ b/cmd.c
@@ -140,7 +140,7 @@ static void refs_fn(void)
 
 static void source_fn(void)
 {
-       cgit_print_tree(ctx.qry.sha1, ctx.qry.path);
+       cgit_print_tree(ctx.qry.sha1, ctx.qry.path, false);
 }
 
 static void snapshot_fn(void)
@@ -166,7 +166,7 @@ static void tag_fn(void)
 
 static void tree_fn(void)
 {
-       cgit_print_tree(ctx.qry.sha1, ctx.qry.path);
+       cgit_print_tree(ctx.qry.sha1, ctx.qry.path, true);
 }
 
 #define def_cmd(name, want_repo, want_vpath, is_clone) \

diff --git a/ui-tree.c b/ui-tree.c
index d26e35e24fa8fa94152994d6538c02f148d27295..721c812203be971f2e1bde94a317ee44e2e0b61e 100644 (file)
--- a/ui-tree.c
+++ b/ui-tree.c
@@ -15,6 +15,7 @@ struct walk_tree_context {
        char *curr_rev;
        char *match_path;
        int state;
+       bool use_render;
 };
 
 static void print_text_buffer(const char *name, char *buf, unsigned long size)
@@ -98,10 +99,69 @@ static void print_buffer(const char *basename, char *buf, unsigned long size)
                print_text_buffer(basename, buf, size);
 }
 
-static void print_object(const struct object_id *oid, char *path, const char *basename, const char *rev)
+static void render_buffer(struct cgit_filter *render, const char *name,
+               char *buf, unsigned long size)
+{
+       char *filter_arg = xstrdup(name);
+
+       html("<div class='blob'>");
+       cgit_open_filter(render, filter_arg);
+       html_raw(buf, size);
+       cgit_close_filter(render);
+       html("</div>");
+
+       free(filter_arg);
+}
+
+static void include_file(const char *path, const char *mimetype)
+{
+       const char *delim = "?";
+
+       html("<div class='blob'>");
+
+       if (!strncmp(mimetype, "image/", 6)) {
+               html("<img alt='");
+               html_attr(path);
+               html("' src='");
+       } else {
+               html("<iframe sandbox='allow-scripts' src='");
+       }
+
+       if (ctx.cfg.virtual_root) {
+               html_url_path(ctx.cfg.virtual_root);
+               html_url_path(ctx.repo->url);
+               if (ctx.repo->url[strlen(ctx.repo->url) - 1] != '/')
+                       html("/");
+               html("plain/");
+               html_url_path(path);
+       } else {
+               html_url_path(ctx.cfg.script_name);
+               html("?url=");
+               html_url_arg(ctx.repo->url);
+               if (ctx.repo->url[strlen(ctx.repo->url) - 1] != '/')
+                       html("/");
+               html("plain/");
+               if (path)
+                       html_url_arg(path);
+               delim = "&";
+       }
+       if (ctx.qry.head && ctx.repo->defbranch &&
+           strcmp(ctx.qry.head, ctx.repo->defbranch)) {
+               html(delim);
+               html("h=");
+               html_url_arg(ctx.qry.head);
+               delim = "&";
+       }
+
+       html("'></div>");
+}
+
+static void print_object(const struct object_id *oid, char *path, const char *basename,
+                        const char *rev, bool use_render)
 {
        enum object_type type;
-       char *buf;
+       struct cgit_filter *render;
+       char *buf, *mimetype;
        unsigned long size;
 
        type = oid_object_info(the_repository, oid, &size);
@@ -118,22 +178,49 @@ static void print_object(const struct object_id *oid, char *path, const char *ba
                return;
        }
 
+       render = get_render_for_filename(path);
+       mimetype = render ? NULL : get_mimetype_for_filename(path);
+
        cgit_set_title_from_path(path);
 
+       /*
+        * If we don't have a render filter or a mimetype, we won't include the
+        * file in the page.
+        */
+       if (!render && !mimetype)
+               use_render = false;
+
        cgit_print_layout_start();
        htmlf("blob: %s (", oid_to_hex(oid));
        cgit_plain_link("plain", NULL, NULL, ctx.qry.head,
                        rev, path);
+
        if (ctx.cfg.enable_blame) {
                html(") (");
                cgit_blame_link("blame", NULL, NULL, ctx.qry.head,
                                rev, path);
        }
+       if (use_render) {
+               html(", ");
+               cgit_source_link("source", NULL, NULL, ctx.qry.head,
+                               rev, path);
+       } else if (render || mimetype) {
+               html(", ");
+               cgit_tree_link("render", NULL, NULL, ctx.qry.head,
+                              rev, path);
+       }
        html(")\n");
 
-       print_buffer(basename, buf, size);
-
+       if (use_render) {
+               if (render)
+                       render_buffer(render, basename, buf, size);
+               else
+                       include_file(path, mimetype);
+       } else
+               print_buffer(basename, buf, size);
+ 
        free(buf);
+       free(mimetype);
 }
 
 struct single_tree_ctx {
@@ -325,8 +412,10 @@ static int walk_tree(const struct object_id *oid, struct strbuf *base,
                        return READ_TREE_RECURSIVE;
                } else {
                        walk_tree_ctx->state = 2;
-                       print_object(oid, buffer.buf, pathname, walk_tree_ctx->curr_rev);
+                       print_object(oid, buffer.buf, pathname, walk_tree_ctx->curr_rev,
+                                    walk_tree_ctx->use_render);
                        strbuf_release(&buffer);
+
                        return 0;
                }
        }
@@ -339,7 +428,7 @@ static int walk_tree(const struct object_id *oid, struct strbuf *base,
  *   rev:  the commit pointing at the root tree object
  *   path: path to tree or blob
  */
-void cgit_print_tree(const char *rev, char *path)
+void cgit_print_tree(const char *rev, char *path, bool use_render)
 {
        struct object_id oid;
        struct commit *commit;
@@ -353,7 +442,8 @@ void cgit_print_tree(const char *rev, char *path)
        };
        struct walk_tree_context walk_tree_ctx = {
                .match_path = path,
-               .state = 0
+               .state = 0,
+               .use_render = use_render,
        };
 
        if (!rev)

diff --git a/ui-tree.h b/ui-tree.h
index bbd34e3566a528e4bfecb1b66ac4b391472648d7..a0fc8e2da79509141259407eb3c047cc0c2a16e3 100644 (file)
--- a/ui-tree.h
+++ b/ui-tree.h
@@ -1,6 +1,6 @@
 #ifndef UI_TREE_H
 #define UI_TREE_H
 
-extern void cgit_print_tree(const char *rev, char *path);
+extern void cgit_print_tree(const char *rev, char *path, bool use_render);
 
 #endif /* UI_TREE_H */