cgit/ui-atom.c
June McEnroe 4e4b30effb ui-atom: generate valid Atom feeds
Fixes several RFC 4287 violations:

> 4.1.1. The "atom:feed" Element
>    o  atom:feed elements MUST contain exactly one atom:id element.
>    o  atom:feed elements SHOULD contain one atom:link element with a rel
>       attribute value of "self".  This is the preferred URI for
>       retrieving Atom Feed Documents representing this Atom feed.
>    o  atom:feed elements MUST contain exactly one atom:updated element.

An atom:id element is generated from cgit_currentfullurl(), and an
atom:link element with a rel attribute of "self" is generated with
the same URL. An atom:updated element is generated from the date
of the first commit in the revision walk.

> 4.1.2.  The "atom:entry" Element
>    o  atom:entry elements MUST NOT contain more than one atom:content
>       element.

The second atom:content element with the type of "xhtml" is removed.

> 4.2.6.  The "atom:id" Element
>    Its content MUST be an IRI, as defined by [RFC3987].  Note that the
>    definition of "IRI" excludes relative references.  Though the IRI
>    might use a dereferencable scheme, Atom Processors MUST NOT assume it
>    can be dereferenced.

The atom:id elements for commits now use URNs in the "sha1" or
"sha256" namespaces. Although these are not registered URN namespaces,
they see use in the wild, for instance as part of magnet URIs.

Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
2022-12-19 16:13:58 +01:00

159 lines
3.7 KiB
C

/* ui-atom.c: functions for atom feeds
*
* Copyright (C) 2006-2014 cgit Development Team <cgit@lists.zx2c4.com>
*
* Licensed under GNU General Public License v2
* (see COPYING for full license text)
*/
#include "cgit.h"
#include "ui-atom.h"
#include "html.h"
#include "ui-shared.h"
static void add_entry(struct commit *commit, const char *host)
{
char delim = '&';
char *hex;
char *mail, *t, *t2;
struct commitinfo *info;
info = cgit_parse_commit(commit);
hex = oid_to_hex(&commit->object.oid);
html("<entry>\n");
html("<title>");
html_txt(info->subject);
html("</title>\n");
html("<updated>");
html_txt(show_date(info->committer_date, 0,
date_mode_from_type(DATE_ISO8601_STRICT)));
html("</updated>\n");
html("<author>\n");
if (info->author) {
html("<name>");
html_txt(info->author);
html("</name>\n");
}
if (info->author_email && !ctx.cfg.noplainemail) {
mail = xstrdup(info->author_email);
t = strchr(mail, '<');
if (t)
t++;
else
t = mail;
t2 = strchr(t, '>');
if (t2)
*t2 = '\0';
html("<email>");
html_txt(t);
html("</email>\n");
free(mail);
}
html("</author>\n");
html("<published>");
html_txt(show_date(info->author_date, 0,
date_mode_from_type(DATE_ISO8601_STRICT)));
html("</published>\n");
if (host) {
char *pageurl;
html("<link rel='alternate' type='text/html' href='");
html(cgit_httpscheme());
html_attr(host);
pageurl = cgit_pageurl(ctx.repo->url, "commit", NULL);
html_attr(pageurl);
if (ctx.cfg.virtual_root)
delim = '?';
html_attrf("%cid=%s", delim, hex);
html("'/>\n");
free(pageurl);
}
html("<id>");
html_txtf("urn:%s:%s", the_hash_algo->name, hex);
html("</id>\n");
html("<content type='text'>\n");
html_txt(info->msg);
html("</content>\n");
html("</entry>\n");
cgit_free_commitinfo(info);
}
void cgit_print_atom(char *tip, const char *path, int max_count)
{
char *host;
const char *argv[] = {NULL, tip, NULL, NULL, NULL};
struct commit *commit;
struct rev_info rev;
int argc = 2;
bool first = true;
if (ctx.qry.show_all)
argv[1] = "--all";
else if (!tip)
argv[1] = ctx.qry.head;
if (path) {
argv[argc++] = "--";
argv[argc++] = path;
}
init_revisions(&rev, NULL);
rev.abbrev = DEFAULT_ABBREV;
rev.commit_format = CMIT_FMT_DEFAULT;
rev.verbose_header = 1;
rev.show_root_diff = 0;
rev.max_count = max_count;
setup_revisions(argc, argv, &rev, NULL);
prepare_revision_walk(&rev);
host = cgit_hosturl();
ctx.page.mimetype = "text/xml";
ctx.page.charset = "utf-8";
cgit_print_http_headers();
html("<feed xmlns='http://www.w3.org/2005/Atom'>\n");
html("<title>");
html_txt(ctx.repo->name);
if (path) {
html("/");
html_txt(path);
}
if (tip && !ctx.qry.show_all) {
html(", branch ");
html_txt(tip);
}
html("</title>\n");
html("<subtitle>");
html_txt(ctx.repo->desc);
html("</subtitle>\n");
if (host) {
char *fullurl = cgit_currentfullurl();
char *repourl = cgit_repourl(ctx.repo->url);
html("<id>");
html_txtf("%s%s%s", cgit_httpscheme(), host, fullurl);
html("</id>\n");
html("<link rel='self' href='");
html_attrf("%s%s%s", cgit_httpscheme(), host, fullurl);
html("'/>\n");
html("<link rel='alternate' type='text/html' href='");
html_attrf("%s%s%s", cgit_httpscheme(), host, repourl);
html("'/>\n");
free(fullurl);
free(repourl);
}
while ((commit = get_revision(&rev)) != NULL) {
if (first) {
html("<updated>");
html_txt(show_date(commit->date, 0,
date_mode_from_type(DATE_ISO8601_STRICT)));
html("</updated>\n");
first = false;
}
add_entry(commit, host);
free_commit_buffer(the_repository->parsed_objects, commit);
free_commit_list(commit->parents);
commit->parents = NULL;
}
html("</feed>\n");
free(host);
}