cgi/version.cgi

   1 #!/usr/bin/perl
   2
   3 use warnings;
   4 use strict;
   5
   6 # Hack to work on merkel where suexec is in place
   7 BEGIN{
   8      if (defined $ENV{HTTP_HOST} and $ENV{HTTP_HOST} eq 'merkel.debian.org') {
   9           unshift @INC, qw(/home/don/perl/usr/share/perl5 /home/don/perl/usr/lib/perl5 /home/don/source);
  10           $ENV{DEBBUGS_CONFIG_FILE}="/home/don/config_internal";
  11      }
  12 }
  13
  14 # if we're running out of git, we want to use the git base directory as the
  15 # first INC directory. If you're not running out of git, don't do that.
  16 use File::Basename qw(dirname);
  17 use Cwd qw(abs_path);
  18 our $debbugs_dir;
  19 BEGIN {
  20     $debbugs_dir =
  21         abs_path(dirname(abs_path(__FILE__)) . '/../');
  22     # clear the taint; we'll assume that the absolute path to __FILE__ is the
  23     # right path if there's a .git directory there
  24     ($debbugs_dir) = $debbugs_dir =~ /([[:print:]]+)/;
  25     if (defined $debbugs_dir and
  26         -d $debbugs_dir . '/.git/') {
  27     } else {
  28         undef $debbugs_dir;
  29     }
  30     # if the first directory in @INC is not an absolute directory, assume that
  31     # someone has overridden us via -I.
  32     if ($INC[0] !~ /^\//) {
  33     }
  34 }
  35 use if defined $debbugs_dir, lib => $debbugs_dir;
  36
  37 use CGI::Simple;
  38
  39 # by default send this message nowhere
  40 # use CGI::Alert q(nobody@example.com);
  41
  42 use Debbugs::Config qw(:config);
  43
  44 our $VERSION=1;
  45
  46 use Debbugs::CGI qw(htmlize_packagelinks html_escape cgi_parameters munge_url :cache);
  47 use Debbugs::Versions;
  48 use Debbugs::Versions::Dpkg;
  49 use Debbugs::Packages qw(get_versions makesourceversions);
  50 use HTML::Entities qw(encode_entities);
  51 use File::Temp qw(tempdir);
  52 use IO::File;
  53 use IO::Handle;
  54
  55
  56 my %img_types = (svg => 'image/svg+xml',
  57                  png => 'image/png',
  58                 );
  59
  60 my $q = CGI::Simple->new();
  61
  62 my %cgi_var = cgi_parameters(query   => $q,
  63                              single  => [qw(package format ignore_boring width height collapse info)],
  64                              default => {package       => 'spamass-milter',
  65                                          found         => [],
  66                                          fixed         => [],
  67                                          ignore_boring => 1,
  68                                          collapse      => 0,
  69                                          format        => 'png',
  70                                          width         => undef,
  71                                          height        => undef,
  72                                          info          => 0,
  73                                         },
  74                             );
  75 my $this = munge_url('version.cgi?',
  76                      %cgi_var,
  77                     );
  78
  79 if (defined $cgi_var{width}) {
  80      $cgi_var{width} =~ /(\d+)/;
  81      $cgi_var{width} = $1;
  82 }
  83 if (defined $cgi_var{height}) {
  84      $cgi_var{height} =~ /(\d+)/;
  85      $cgi_var{height} = $1;
  86 }
  87
  88 if (defined $cgi_var{format}) {
  89      $cgi_var{format} =~ /(png|svg|jpg|gif)/;
  90      $cgi_var{format} = $1 || 'png';
  91 }
  92 else {
  93      $cgi_var{format} = 'png';
  94 }
  95
  96 my $etag;
  97 if ($cgi_var{info} and not defined $cgi_var{dot}) {
  98     $etag = etag_does_not_match(cgi=>$q,
  99                                 additional_data=>[grep {defined $_ ? $_ : ()}
 100                                                   @cgi_var{(qw(package ignore_boring),
 101                                                             qw(collapse))
 102                                                        },
 103                                                   $this,
 104                                                   $VERSION],
 105                                );
 106     if (not $etag) {
 107         print $q->header(-status => 304);
 108         print "304: Not modified\n";
 109         exit 0;
 110     }
 111     print $q->header(-status => 200,
 112                      -cache_control => 'public, max-age=86400',
 113                      -etag => $etag,
 114                      -content_type => 'text/html',
 115                     );
 116     print <<END;
 117 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 118 <html>
 119 END
 120      print '<head><title>'.html_escape($cgi_var{package}).' Version Graph</title></head>'."\n";
 121      print "<body>\n";
 122      print '<a href="'.html_escape(munge_url($this,ignore_boring=>$cgi_var{ignore_boring}?0:1)).
 123           '">['.($cgi_var{ignore_boring}?"Don't i":'I').'gnore boring]</a> ';
 124      print '<a href="'.html_escape(munge_url($this,collapse=>$cgi_var{collapse}?0:1)).
 125           '">['.($cgi_var{collapse}?"Don't c":'C').'ollapse]</a> ';
 126      print '<a href="'.html_escape(munge_url($this,dot=>1)).
 127           '">[Dot]</a><br>';
 128      print '<img src="'.html_escape(munge_url($this,info=>0)).'">';
 129      print <<END;
 130 </body>
 131 </html>
 132 END
 133           exit 0;
 134 }
 135
 136 # we want to first load the appropriate file,
 137 # then figure out which versions are there in which architectures,
 138 my %versions;
 139 my %version_to_dist;
 140 for my $dist (@{$config{distributions}}) {
 141      $versions{$dist} = [get_versions(package => [split /\s*,\s*/, $cgi_var{package}],
 142                                       dist => $dist,
 143                                       source => 1,
 144                                      )];
 145      # make version_to_dist
 146      foreach my $version (@{$versions{$dist}}){
 147           push @{$version_to_dist{$version}}, $dist;
 148      }
 149 }
 150
 151 # then figure out which are affected.
 152 # turn found and fixed into full versions
 153 @{$cgi_var{found}} = map {makesourceversions($_,undef,@{$cgi_var{found}})} split/\s*,\s*/, $cgi_var{package};
 154 @{$cgi_var{fixed}} = map {makesourceversions($_,undef,@{$cgi_var{fixed}})} split/\s*,\s*/, $cgi_var{package};
 155 my @interesting_versions = map {makesourceversions($_,undef,keys %version_to_dist)} split/\s*,\s*/, $cgi_var{package};
 156
 157 # We need to be able to rip out leaves which the versions that do not affect the current versions of unstable/testing
 158 my %sources;
 159 @sources{map {m{(.+)/}; $1} @{$cgi_var{found}}} = (1) x @{$cgi_var{found}};
 160 @sources{map {m{(.+)/}; $1} @{$cgi_var{fixed}}} = (1) x @{$cgi_var{fixed}};
 161 @sources{map {m{(.+)/}; $1} @interesting_versions} = (1) x @interesting_versions;
 162
 163 # at this point, we know enough to calculate the etag.
 164
 165 my @versions_files;
 166 foreach my $source (keys %sources) {
 167     my $srchash = substr $source, 0, 1;
 168     next unless -e "$config{version_packages_dir}/$srchash/$source";
 169     push @versions_files, "$config{version_packages_dir}/$srchash/$source";
 170 }
 171
 172 $etag = etag_does_not_match(cgi=>$q,
 173                             additional_data=>[@cgi_var{(qw(package ignore_boring),
 174                                                         qw(collapse))
 175                                                    },
 176                                               $this,
 177                                               $VERSION],
 178                             files => [@versions_files
 179                                      ],
 180                            );
 181 if (not $etag) {
 182     print $q->header(-status => 304);
 183     print "304: Not modified\n";
 184     exit 0;
 185 }
 186
 187 my $version = Debbugs::Versions->new(\&Debbugs::Versions::Dpkg::vercmp);
 188 for my $version_fn (@versions_files) {
 189     my $version_fh = IO::File->new($version_fn, 'r') or
 190         warn "Unable to open $version_fn for reading: $!";
 191     $version->load($version_fh);
 192 }
 193 # Here, we need to generate a short version to full version map
 194 my %version_map;
 195 foreach my $key (keys %{$version->{parent}}) {
 196      my ($short_version) = $key =~ m{/(.+)$};
 197      next unless length $short_version;
 198      # we let the first short version have presidence.
 199      $version_map{$short_version} = $key if not exists $version_map{$short_version};
 200 }
 201 # Turn all short versions into long versions
 202 for my $found_fixed (qw(found fixed)) {
 203      $cgi_var{$found_fixed} =
 204           [
 205            map {
 206                 if ($_ !~ m{/}) { # short version
 207                      ($version_map{$_});
 208                 }
 209                 else { # long version
 210                      ($_);
 211                 }
 212            } @{$cgi_var{$found_fixed}}
 213           ];
 214 }
 215 my %all_states = $version->allstates($cgi_var{found},$cgi_var{fixed});
 216
 217 my $dot = "digraph G {\n";
 218 if (defined $cgi_var{width} and defined $cgi_var{height}) {
 219      $dot .= qq(size="$cgi_var{width},$cgi_var{height}";\n);
 220 }
 221 my %state = (found  => ['fillcolor="salmon"',
 222                         'style="filled"',
 223                         'shape="ellipse"',
 224                        ],
 225              absent => ['fillcolor="grey"',
 226                         'style="filled"',
 227                         'shape="trapezium"',
 228                        ],
 229              fixed  => ['fillcolor="chartreuse"',
 230                         'style="filled"',
 231                         'shape="rect"',
 232                        ],
 233             );
 234 # TODO: Allow collapsing versions which are at the same state and not
 235 # in a suite.
 236 my %collapsed_nodes;
 237 my %group_nodes;
 238 if ($cgi_var{collapse}) {
 239      my %reversed_nodes;
 240      foreach my $key (keys %{$version->{parent}}) {
 241           next if $cgi_var{ignore_boring} and (not defined $all_states{$key}
 242                                                or $all_states{$key} eq 'absent');
 243           next if $cgi_var{ignore_boring} and not version_relevant($version,$key,\@interesting_versions);
 244           if (defined $version->{parent}{$key}) {
 245                next if $cgi_var{ignore_boring} and (not defined $all_states{$version->{parent}{$key}}
 246                                                     or $all_states{$version->{parent}{$key}} eq 'absent');
 247                next if $cgi_var{ignore_boring} and not version_relevant($version,$version->{parent}{$key},\@interesting_versions);
 248                push @{$reversed_nodes{$version->{parent}{$key}}},$key;
 249           }
 250           else {
 251                $reversed_nodes{$key} ||=[];
 252           }
 253      }
 254      # nodes that can be collapsed are those that have one child
 255      # are in the same state as their parent, and are not in a suite
 256      foreach my $key (keys %reversed_nodes) {
 257           if (not exists $version_to_dist{$key}
 258               and @{$reversed_nodes{$key}} <= 1
 259               and defined $version->{parent}{$key}
 260               and $all_states{$key} eq $all_states{$version->{parent}{$key}}
 261              ) {
 262                # check to see if there is an entry for the parent or child of this node
 263                my $group_node;
 264                if ((@{$reversed_nodes{$key}} and exists $collapsed_nodes{$reversed_nodes{$key}[0]})) {
 265                     $group_node = $collapsed_nodes{$reversed_nodes{$key}[0]};
 266                     if ($group_nodes{$group_node}{parent} eq $key) {
 267                          $group_nodes{$group_node}{parent} = $version->{parent}{$key};
 268                     }
 269                }
 270                if (defined $version->{parent}{$key} and exists $collapsed_nodes{$version->{parent}{$key}}) {
 271                     if (defined $group_node) {
 272                          #MWHAHAHAHAHA
 273                          my $collapser = $group_nodes{$collapsed_nodes{$version->{parent}{$key}}};
 274                          push @{$collapser->{collapsed_nodes}},@{$group_nodes{$group_node}{collapsed_nodes}},$group_node;
 275                          foreach (@{$collapser->{collapsed_nodes}}) {
 276                               if (exists $group_nodes{$_}) {
 277                                    $group_nodes{$_} = $collapser;
 278                               }
 279                          }
 280                     }
 281                     $group_node = $collapsed_nodes{$version->{parent}{$key}};
 282                }
 283                if (not defined $group_node) {
 284                     $group_node = "group_$key";
 285                     $group_nodes{$group_node} = {attr => qq("$group_node" [).join(',','label="some versions"',
 286                                                                                   @{$state{$all_states{$key}}},
 287                                                                                   'style="bold,filled"',
 288                                                                                  ).qq(]\n),
 289                                                  name => $group_node,
 290                                                  parent => $version->{parent}{$key},
 291                                                  collapsed_nodes => [],
 292                                                 };
 293                }
 294                $collapsed_nodes{$key} = $group_node;
 295           }
 296      }
 297      my %used_node;
 298      foreach my $group (values %group_nodes) {
 299           next if $used_node{$group->{name}};
 300           $used_node{$group->{name}} = 1;
 301           $dot .= $group->{attr};
 302      }
 303 }
 304
 305 foreach my $key (keys %all_states) {
 306      next if exists $collapsed_nodes{$key};
 307      next if $cgi_var{ignore_boring} and (not defined $all_states{$key}
 308                                           or $all_states{$key} eq 'absent');
 309      next if $cgi_var{ignore_boring} and not version_relevant($version,$key,\@interesting_versions);
 310      my @attributes = @{$state{$all_states{$key}}};
 311      if (exists $version_to_dist{$key}) {
 312           push @attributes, 'label="'.$key.'\n'."(".join(', ',@{$version_to_dist{$key}}).")\"";
 313      }
 314      my $node_attributes = qq("$key" [).join(',',@attributes).qq(]\n);
 315      $dot .= $node_attributes;
 316 }
 317
 318 foreach my $key (keys %{$version->{parent}}) {
 319      next if not defined $version->{parent}{$key};
 320      next if $cgi_var{ignore_boring} and $all_states{$key} eq 'absent';
 321      next if $cgi_var{ignore_boring} and (not defined $all_states{$version->{parent}{$key}}
 322                                           or $all_states{$version->{parent}{$key}} eq 'absent');
 323      # Ignore branches which are not ancestors of a currently distributed version
 324      next if $cgi_var{ignore_boring} and not version_relevant($version,$key,\@interesting_versions);
 325      next if exists $collapsed_nodes{$key};
 326      $dot .= qq("$key").'->'.q(").
 327           (exists $collapsed_nodes{$version->{parent}{$key}}?
 328            $group_nodes{$collapsed_nodes{$version->{parent}{$key}}}{name}:$version->{parent}{$key}).
 329                 qq(" [dir="back"])."\n" if defined $version->{parent}{$key};
 330 }
 331 if ($cgi_var{collapse}) {
 332      my %used_node;
 333      foreach my $group (values %group_nodes) {
 334           next if $used_node{$group->{name}};
 335           next if not defined $group->{parent};
 336           $used_node{$group->{name}} = 1;
 337           $dot .= qq("$group->{name}").'->'.q(").
 338                (exists $collapsed_nodes{$group->{parent}}?
 339                 $group_nodes{$collapsed_nodes{$group->{parent}}}{name}:$group->{parent}).
 340                     qq(" [dir="back"])."\n";
 341      }
 342 }
 343 $dot .= "}\n";
 344
 345 my $temp_dir = tempdir(CLEANUP => 1);
 346
 347 if (not defined $cgi_var{dot}) {
 348      my $dot_fh = IO::File->new("$temp_dir/temp.dot",'w') or
 349           die "Unable to open $temp_dir/temp.dot for writing: $!";
 350      print {$dot_fh} $dot or die "Unable to print output to the dot file: $!";
 351      close $dot_fh or die "Unable to close the dot file: $!";
 352      system('dot','-T'.$cgi_var{format},"$temp_dir/temp.dot",'-o',"$temp_dir/temp.$cgi_var{format}") == 0
 353           or print "Content-Type: text\n\nDot failed." and die "Dot failed: $?";
 354      my $img_fh = IO::File->new("$temp_dir/temp.$cgi_var{format}", 'r') or
 355           die "Unable to open $temp_dir/temp.$cgi_var{format} for reading: $!";
 356     print $q->header(-status => 200,
 357                      -cache_control => 'public, max-age=300',
 358                      -etag => $etag,
 359                      -content_type => $img_types{$cgi_var{format}},
 360                     );
 361      print <$img_fh>;
 362      close $img_fh;
 363 }
 364 else {
 365     print $q->header(-status => 200,
 366                      -cache_control => 'public, max-age=300',
 367                      -etag => $etag,
 368                      -content_type => 'text',
 369                     );
 370      print $dot;
 371 }
 372
 373
 374 our %_version_relevant_cache;
 375 sub version_relevant {
 376      my ($version,$test_version,$relevant_versions) = @_;
 377      for my $dist_version (@{$relevant_versions}) {
 378           if (exists $_version_relevant_cache{$dist_version}{$test_version}{$version}) {
 379                return 1 if $_version_relevant_cache{$dist_version}{$test_version}{$version};
 380           }
 381           else {
 382                my $rel = $version->isancestor($test_version,$dist_version);
 383                $_version_relevant_cache{$dist_version}{$test_version}{$version} = $rel;
 384                return 1 if $rel;
 385           }
 386      }
 387      return 0;
 388 }
 389
 390