Bugzilla::CGI - CGI handling for Bugzilla
use Bugzilla::CGI; my $cgi = new Bugzilla::CGI();
This package inherits from the standard CGI module, to provide additional Bugzilla-specific functionality. In general, see the CGI.pm docs for documention.
Bugzilla::CGI has some differences from CGI.pm.
cgi_error is automatically checkedAfter creating the CGI object, Bugzilla::CGI automatically checks cgi_error, and throws a CodeError if a problem is detected.
Bugzilla::CGI also includes additional functions.
canonicalise_query(@exclude)This returns a sorted string of the parameters whose values are non-empty, suitable for use in a url.
Values in @exclude are not included in the result.
send_cookieThis routine is identical to the cookie generation part of CGI.pm's cookie routine, except that it knows about Bugzilla's cookie_path and cookie_domain parameters and takes them into account if necessary. This should be used by all Bugzilla code (instead of cookie or the -cookie argument to header), so that under mod_perl the headers can be sent correctly, using print or the mod_perl APIs as appropriate.
To remove (expire) a cookie, use remove_cookie.
remove_cookieThis is a wrapper around send_cookie, setting an expiry date in the past, effectively removing the cookie.
As its only argument, it takes the name of the cookie to expire.
redirect_to_httpsThis routine redirects the client to the https version of the page that they're looking at, using the sslbase parameter for the redirection.
Generally you should use "do_ssl_redirect_if_required" in Bugzilla::Util instead of calling this directly.
redirect_to_urlbaseRedirects from the current URL to one prefixed by the urlbase parameter.
multipart_startStarts a new part of the multipart document using the specified MIME type. If not specified, text/html is assumed.
close_standby_messageEnds a part of the multipart document, and starts another part.
set_dated_content_dispSets an appropriate date-dependent value for the Content Disposition header for a downloadable resource.