summaryrefslogtreecommitdiffstats
path: root/Bugzilla/Quantum/CGI.pm
blob: 79fbcfde61ae9a34120d21c1ab53cc47cc324279 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
#
# This Source Code Form is "Incompatible With Secondary Licenses", as
# defined by the Mozilla Public License, v. 2.0.

package Bugzilla::Quantum::CGI;
use Mojo::Base 'Mojolicious::Controller';

use CGI::Compile;
use Try::Tiny;
use Taint::Util qw(untaint);
use Sys::Hostname;
use Sub::Quote 2.005000;
use Sub::Name;
use Socket qw(AF_INET inet_aton);
use File::Spec::Functions qw(catfile);
use File::Slurper qw(read_text);
use English qw(-no_match_vars);
use Bugzilla::Quantum::Stdout;
use Bugzilla::Constants qw(bz_locations USAGE_MODE_BROWSER);

our $C;
my %SEEN;

sub load_all {
  my ($class, $r) = @_;

  foreach my $file (glob '*.cgi') {
    my $name = _file_to_method($file);
    $class->load_one($name, $file);
    $r->any("/$file")->to("CGI#$name");
  }
}

sub load_one {
  my ($class, $name, $file) = @_;
  my $package = __PACKAGE__ . "::$name", my $inner_name = "_$name";
  my $content = read_text(catfile(bz_locations->{cgi_path}, $file));
  $content = "package $package; $content";
  untaint($content);
  my %options = (package => $package, file => $file, line => 1, no_defer => 1,);
  die "Tried to load $file more than once" if $SEEN{$file}++;
  my $inner = quote_sub $inner_name, $content, {}, \%options;
  my $wrapper = sub {
    my ($c) = @_;
    my $stdin = $c->_STDIN;
    local $C                           = $c;
    local %ENV                         = $c->_ENV($file);
    local $CGI::Compile::USE_REAL_EXIT = 0;
    local $PROGRAM_NAME                = $file;
    local *STDIN;    ## no critic (local)
    open STDIN, '<', $stdin->path
      or die "STDIN @{[$stdin->path]}: $!"
      if -s $stdin->path;
    tie *STDOUT, 'Bugzilla::Quantum::Stdout',
      controller => $c;    ## no critic (tie)

    # the finally block calls cleanup.
    $c->stash->{cleanup_guard}->dismiss;
    Bugzilla->usage_mode(USAGE_MODE_BROWSER);
    try {
      Bugzilla->init_page();
      $inner->();
    }
    catch {
      die $_ unless _is_exit($_);
    }
    finally {
      my $error = shift;
      untie *STDOUT;
      $c->finish if !$error || _is_exit($error);
      Bugzilla->cleanup;
      CGI::initialize_globals();
    };
  };

  no strict 'refs';    ## no critic (strict)
  *{$name} = subname($name, $wrapper);
  return 1;
}


sub _ENV {
  my ($c, $script_name) = @_;
  my $tx      = $c->tx;
  my $req     = $tx->req;
  my $headers = $req->headers;
  my $content_length
    = $req->content->is_multipart ? $req->body_size : $headers->content_length;
  my %env_headers = (HTTP_COOKIE => '', HTTP_REFERER => '');

  $headers->content_type('application/x-www-form-urlencoded; charset=utf-8')
    unless $headers->content_type;
  for my $name (@{$headers->names}) {
    my $key = uc "http_$name";
    $key =~ s/\W/_/g;
    $env_headers{$key} = $headers->header($name);
  }

  my $remote_user;
  if (my $userinfo = $req->url->to_abs->userinfo) {
    $remote_user = $userinfo =~ /([^:]+)/ ? $1 : '';
  }
  elsif (my $authenticate = $headers->authorization) {
    $remote_user = $authenticate =~ /Basic\s+(.*)/ ? b64_decode $1 : '';
    $remote_user = $remote_user =~ /([^:]+)/       ? $1            : '';
  }
  my $path_info = $c->stash->{'mojo.captures'}{'PATH_INFO'};
  my %captures = %{$c->stash->{'mojo.captures'} // {}};
  foreach my $key (keys %captures) {
    if ( $key eq 'controller'
      || $key eq 'action'
      || $key eq 'PATH_INFO'
      || $key =~ /^REWRITE_/)
    {
      delete $captures{$key};
    }
  }
  my $cgi_query = Mojo::Parameters->new(%captures);
  $cgi_query->append($req->url->query);
  my $prefix = $c->stash->{bmo_prefix} ? '/bmo/' : '/';

  return (
    %ENV,
    CONTENT_LENGTH => $content_length        || 0,
    CONTENT_TYPE   => $headers->content_type || '',
    GATEWAY_INTERFACE => 'CGI/1.1',
    HTTPS             => $req->is_secure ? 'on' : 'off',
    %env_headers,
    QUERY_STRING    => $cgi_query->to_string,
    PATH_INFO       => $path_info ? "/$path_info" : '',
    REMOTE_ADDR     => $tx->original_remote_address,
    REMOTE_HOST     => $tx->original_remote_address,
    REMOTE_PORT     => $tx->remote_port,
    REMOTE_USER     => $remote_user || '',
    REQUEST_METHOD  => $req->method,
    SCRIPT_NAME     => "$prefix$script_name",
    SERVER_NAME     => hostname,
    SERVER_PORT     => $tx->local_port,
    SERVER_PROTOCOL => $req->is_secure
    ? 'HTTPS'
    : 'HTTP',    # TODO: Version is missing
    SERVER_SOFTWARE => __PACKAGE__,
  );
}

sub _STDIN {
  my $c = shift;
  my $stdin;

  if ($c->req->content->is_multipart) {
    $stdin = Mojo::Asset::File->new;
    $stdin->add_chunk($c->req->build_body);
  }
  else {
    $stdin = $c->req->content->asset;
  }

  return $stdin if $stdin->isa('Mojo::Asset::File');
  return Mojo::Asset::File->new->add_chunk($stdin->slurp);
}

sub _file_to_method {
  my ($name) = @_;
  $name =~ s/\./_/s;
  $name =~ s/\W+/_/gs;
  return $name;
}

sub _is_exit {
  my ($error) = @_;
  return ref $error eq 'ARRAY' && $error->[0] eq "EXIT\n";
}

1;