method.pm

codestriker is a develop useful tool to review code on web user interface.

###############################################################################
# Codestriker: Copyright (c) 2001, 2002 David Sitsky.  All rights reserved.
# [e-mail]
#
# This program is free software; you can redistribute it and modify it under
# the terms of the GPL.

# Base object for all HTTP methods present in the system.
package Codestriker::Http::Method;

use strict;
use CGI;
use CGI::Carp qw(fatalsToBrowser);

# The optional $cgi_style parameter indicates whether the old-style
# CGI URLs are to be generated.  Default is for old-style URLs.
sub new {
    my ($type, $query, $cgi_style) = @_;

    my $self = {};
    $self->{query} = $query;

    # Determine what style URLs are being used.
    if (defined $cgi_style) {
        $self->{cgi_style} = $cgi_style;
    } else {
        $self->{cgi_style} = $query->url() =~ /codestriker.pl/ ? 1 : 0;
    }

    $self->{url_prefix} = $query->url();

    return bless $self, $type;
}

# Generate a URL for this method.
sub url {
    my ($self, %args) = @_;

    return undef;
}

# Indicates that this method requires authentication.  If an admin
# user has been specified in codestriker.conf, then assume
# authentication is required.
sub requires_authentication {
    return defined $Codestriker::admin_users;
}

# Indicates that this method can only be executed by an admin.
sub requires_admin {
    return 0;
}

# If this query type is recognised, extract the parameters and store them into
# $http_input and return true, otherwise return false.
sub extract_parameters {
    my ($self, $http_input) = @_;

    return 0;
}

# Return the handler for this method.
sub execute {
    my ($self, $http_input, $http_output) = @_;

    die "execute() method is not implemented";
}

# Utility method for extracting the specified parameter from a URL if it exists.
sub _extract_nice_parameters {
    my ($self, $http_input, %parameters) = @_;

    $http_input->extract_cgi_parameters();

    my $path_info = $http_input->{query}->path_info();
    foreach my $nice_parameter (keys %parameters) {
        if ($path_info =~ m{/$nice_parameter/([^/#]+)}) {
            $http_input->{$parameters{$nice_parameter}} = CGI::unescape($1);
        }
    }
}

1;