CGI::Portal - MVC Framework for Multiuser Applications

CGI-Portal documentation Contained in the CGI-Portal distribution.

Index

Code Index:

NAME

Top

CGI::Portal - MVC Framework for Multiuser Applications

SYNOPSIS

Top

    use CGI::Portal;

    CGI::Portal::activate({'database_type'       => "mysql",

                           'database_name'       => "some_name",
                           'database_host'       => "localhost",
                           'database_user'       => "some_user",
                           'database_passw'      => "some_password",

                           'user_table'          => "users",
                           'user_index_field'    => "id",
                           'user_user_field'     => "user",
                           'user_passw_field'    => "passw",
                           'user_additional'     => ["email","first_name","middle_initial","last_name","city","state","country"],
                           # at least:              ["email"],

                           'session_table'       => "sessions",
                           'session_index_field' => "id",
                           'session_sid_field'   => "sid",
                           'session_user_field'  => "user",
                           'session_start_field' => "session_start",
                           'session_additional'  => "",




                           # Accessible classes, the first is the default action

                           'actions'             => ["logon", "logoff", "register", "profile", "changepw", "emailpw"],

                           'session_length'      => 7200,
                           'admin_email'         => "some_user\@some_host.com",

                           'template_dir'        => "templates/", # include trailing slash
                           'header_html'         => "header.html",
                           'footer_html'         => "footer.html",
                           'logon_success_html'  => "logon.html"});

DESCRIPTION

Top

CGI::Portal is a MVC framework for the design of extensible, plug-configure-and-play multiuser web applications based on preferred object oriented coding standards. It provides authentication, session management, internal redirects and a modular architecture to build complex applications.

It requires a database including a user and a sessions table, a collection of HTML::Template style templates and a properly configured startup script. To start with CGI::Portal you may want to install the provided templates at http://cgi-portal.sourceforge.net/

All requests access through the startup script, and are handled by the class in the CGI::Portal::Scripts and CGI::Portal::Controls namespace that corresponds to the desired action.

portal.cgi?action=foo calls CGI::Portal::Scripts::foo::launch()

portal.cgi?action=foo&Submit=1 calls CGI::Portal::Controls::foo::launch()

FUNCTIONS

Top

activate

CGI::Portal::activate($conf) takes a reference to the configuration hash, collects input parameters, creates a database object, and passes those on to your class for creating an object instance. It then runs your classes "launch" method and concludes by doing the printing for you. This function is called once from your startup script.

BUILDING APPLICATIONS

Top

See CGI::Portal::Scripts on Building Applications

INSTALLATION

Top

    perl Makefile.PL
    make
    make test
    make install

AUTHOR

Top

Alexander David P <cpanalpo@yahoo.com>

CGI-Portal documentation Contained in the CGI-Portal distribution. 
package CGI::Portal;
# Copyright (c) 2008 Alexander David P. All rights reserved.
#
# Create, run requested object and print

use strict;

use CGI;
use CGI::Portal::RDB;
use CGI::Portal::Scripts::Header;
use CGI::Portal::Scripts::Footer;
use HTML::Template;

use vars qw($VERSION);

$VERSION = "0.12";

1;

            # Create, run requested object and print
sub activate {
  my $conf = shift;
  my $e;
  my $cl;

  my $cgi = new CGI();

            # Get parameters
  my @v = $cgi->param;
  my %in;
  foreach my $f (@v){
    my $v = $cgi->param($f);
    $v =~ s/<.*\r*\n*.*>//g;
    $in{$f} = $v;
  }

            # Get a database handle
  my $rdb = CGI::Portal::RDB->new("DBI:$conf->{'database_type'}:database=$conf->{'database_name'};host=$conf->{'database_host'};", $conf->{'database_user'}, $conf->{'database_passw'});

            # Reference to parameters, database handle, config
  my $i = {'in',      \%in,
           'rdb',     $rdb,
           'conf',    $conf};

            # Get requested action or default
  my $c = $conf->{'actions'}[0];
  foreach my $a (@{$conf->{'actions'}}) {
    if ($in{'action'} eq $a) {
      $c = $a;
    }
  }

            # Use a control
  if ($in{'submit'} || $in{'Submit'}) {
    $cl = "CGI::Portal::Controls::$c";
    eval "use $cl;";
  } 
            # Use a script
  if ($@ || ! ($in{'submit'} || $in{'Submit'})) {
    $cl = "CGI::Portal::Scripts::$c";
    eval "use $cl;";
  }

            # Use default
  if ($@) {
    $cl = "CGI::Portal::Scripts::$conf->{'actions'}[0]";
    eval "use $cl;";
  } 
            # Create an object and run launch
  if (! $@) {
    $e = $cl->new($i);
    $e->launch;
  }

            # Create header object and run launch
  my $header = CGI::Portal::Scripts::Header->new({
           'in',      \%in,
           'rdb',     $rdb,
           'conf',    $conf});
  $header->launch($e);

            # Create footer object and run launch
  my $footer = CGI::Portal::Scripts::Footer->new({
           'in',      \%in,
           'rdb',     $rdb,
           'conf',    $conf});
  $footer->launch($e);

            # Print
  print $e->{'cookies'};
  print $cgi->header;
  print $header->{'out'};
  print $e->{'out'};
  print $footer->{'out'};
}