patches/gitweb/q/gitweb-support-automatic-readme-generation.diff

   1 Subject: [PATCH] gitweb: support automatic readme generation
   2
   3 If enabled by setting $git_automatic_readme_html to an executable
   4 that takes a .git directory as its argument, then if README.html
   5 insertion is enabled and README.html does not exist or is zero
   6 length, then the output of the $git_automatic_readme_html utility
   7 will be inserted instead if it is non-empty.
   8
   9 It's still possible to prevent display of any readme by creating
  10 a README.html file that consists of only XML <!-- comments -->.
  11
  12 Signed-off-by: Kyle J. McKay <mackyle@gmail.com>
  13 ---
  14  gitweb/gitweb.perl       | 52 +++++++++++++++++++++++++++++++++++++++++++-----
  15  gitweb/static/gitweb.css | 48 ++++++++++++++++++++++++++++++++++++++------
  16  2 files changed, 89 insertions(+), 11 deletions(-)
  17
  18 diff --git a/gitweb/gitweb.perl b/gitweb/gitweb.perl
  19 index 1cca889c..08691a75 100755
  20 --- a/gitweb/gitweb.perl
  21 +++ b/gitweb/gitweb.perl
  22 @@ -200,6 +200,13 @@ our $fallback_encoding = 'latin1';
  23  # - one might want to include '-B' option, e.g. '-B', '-M'
  24  our @diff_opts = ('-M'); # taken from git_commit
  25
  26 +# utility to automatically produce a default README.html if README.html is
  27 +# enabled and it does not exist or is 0 bytes in length.  If this is set to an
  28 +# executable utility that takes an absolute path to a .git directory as its
  29 +# first argument and outputs an HTML fragment to use for README.html, then
  30 +# it will be called when README.html is enabled but empty or missing.
  31 +our $git_automatic_readme_html = undef;
  32 +
  33  # Disables features that would allow repository owners to inject script into
  34  # the gitweb domain.
  35  our $prevent_xss = 0;
  36 @@ -4220,6 +4227,33 @@ sub insert_file {
  37         close $fd;
  38  }
  39
  40 +# return undef on failure
  41 +sub collect_output {
  42 +       defined(my $fd = cmd_pipe @_) or return undef;
  43 +       if (eof $fd) {
  44 +               close $fd;
  45 +               return undef;
  46 +       }
  47 +       my $result = join('', map({ to_utf8($_) } <$fd>));
  48 +       close $fd or return undef;
  49 +       return $result;
  50 +}
  51 +
  52 +# return undef on failure
  53 +# return '' if only comments
  54 +sub collect_html_file {
  55 +       my $filename = shift;
  56 +
  57 +       open my $fd, '<', $filename or return undef;
  58 +       my $result = join('', map({ to_utf8($_) } <$fd>));
  59 +       close $fd or return undef;
  60 +       return undef unless defined($result);
  61 +       my $test = $result;
  62 +       $test =~ s/<!--(?:[^-]|(?:-(?!-)))*-->//gs;
  63 +       $test =~ s/\s+//s;
  64 +       return $test eq '' ? '' : $result;
  65 +}
  66 +
  67  ## ......................................................................
  68  ## mimetype related functions
  69
  70 @@ -7386,11 +7420,19 @@ sub git_summary {
  71
  72         # If XSS prevention is on, we don't include README.html.
  73         # TODO: Allow a readme in some safe format.
  74 -       if (!$prevent_xss && -s "$projectroot/$project/README.html") {
  75 -               print "<div class=\"title\">readme</div>\n" .
  76 -                     "<div class=\"readme\">\n";
  77 -               insert_file("$projectroot/$project/README.html");
  78 -               print "\n</div>\n"; # class="readme"
  79 +       if (!$prevent_xss) {
  80 +               my $readme = -s "$projectroot/$project/README.html"
  81 +                       ? collect_html_file("$projectroot/$project/README.html")
  82 +                       : collect_output($git_automatic_readme_html, "$projectroot/$project");
  83 +               if (defined($readme)) {
  84 +                       $readme =~ s/^\s+//s;
  85 +                       $readme =~ s/\s+$//s;
  86 +                       print "<div class=\"title\">readme</div>\n",
  87 +                             "<div class=\"readme\">\n",
  88 +                             $readme,
  89 +                             "\n</div>\n"
  90 +                       if $readme ne '';
  91 +               }
  92         }
  93
  94         # we need to request one more than 16 (0..15) to check if
  95 diff --git a/gitweb/static/gitweb.css b/gitweb/static/gitweb.css
  96 index 3e4c4a93..d4567df7 100644
  97 --- a/gitweb/static/gitweb.css
  98 +++ b/gitweb/static/gitweb.css
  99 @@ -8,11 +8,15 @@ body {
 100         color: #000000;
 101  }
 102
 103 -a {
 104 +a, a:hover, a:visited, a:active {
 105 +       color: #000000;
 106 +}
 107 +
 108 +a[href] {
 109         color: #0000cc;
 110  }
 111
 112 -a:hover, a:visited, a:active {
 113 +a[href]:hover, a[href]:visited, a[href]:active {
 114         color: #880000;
 115  }
 116
 117 @@ -37,6 +41,10 @@ img.blob {
 118         max-width: 100%;
 119  }
 120
 121 +div.header, div.title {
 122 +       clear: both;
 123 +}
 124 +
 125  a.list img.avatar {
 126         border-style: none;
 127  }
 128 @@ -131,14 +139,42 @@ span.title {
 129         display: block;
 130  }
 131
 132 -div.readme {
 133 -       padding: 8px;
 134 -}
 135 -
 136  span.title:hover {
 137         background-color: #d9d8d1;
 138  }
 139
 140 +div.readme {
 141 +       padding: 8px;
 142 +}
 143 +
 144 +div.readme h1 {
 145 +       font-size: 150%;
 146 +}
 147 +
 148 +div.readme h2 {
 149 +       font-size: 125%;
 150 +}
 151 +
 152 +div.readme h3 {
 153 +       font-size: 110%;
 154 +}
 155 +
 156 +div.readme h4 {
 157 +       font-size: 100%;
 158 +}
 159 +
 160 +div.readme pre {
 161 +       margin: 0 3ex;
 162 +       padding: 1ex;
 163 +       background-color: #eee;
 164 +}
 165 +
 166 +div.readme pre.plaintext {
 167 +       margin: 0;
 168 +       padding: 0;
 169 +       background-color: inherit;
 170 +}
 171 +
 172  div.title_text {
 173         padding: 6px 0px;
 174         border: solid #d9d8d1;
 175 ---