###----------------------------------------------------------------###
# See the perldoc in CGI/Ex/App.pod
-# Copyright 2006 - Paul Seamons #
+# Copyright 2007 - Paul Seamons #
# Distributed under the Perl Artistic License without warranty #
###----------------------------------------------------------------###
use vars qw($VERSION);
BEGIN {
- $VERSION = '2.00';
+ $VERSION = '2.11';
Time::HiRes->import('time') if eval {require Time::HiRes};
+ eval {require Scalar::Util};
}
sub croak {
sub init {}
+sub destroy {}
+
###----------------------------------------------------------------###
sub navigate {
$self->{'_time'} = time;
+ $self->destroy;
+
return $self;
}
### allow for becoming another package (allows for some steps in external files)
$self->morph($step);
- ### run the guts of the step
- my $status = $self->run_hook('run_step', $step);
+ ### allow for mapping path_info pieces to form elements
+ if (my $info = $ENV{'PATH_INFO'}) {
+ my $maps = $self->run_hook('path_info_map', $step) || [];
+ croak 'Usage: sub path_info_map { [[qr{/path_info/(\w+)}, "keyname"]] }'
+ if ! UNIVERSAL::isa($maps, 'ARRAY') || (@$maps && ! UNIVERSAL::isa($maps->[0], 'ARRAY'));
+ foreach my $map (@$maps) {
+ my @match = $info =~ $map->[0];
+ next if ! @match;
+ $self->form->{$map->[$_]} = $match[$_ - 1] foreach grep {! defined $self->form->{$map->[$_]}} 1 .. $#$map;
+ last;
+ }
+ }
- $self->unmorph($step);
+ ### run the guts of the step
+ my $handled = $self->run_hook('run_step', $step);
### Allow for the run_step to intercept.
### A true status means the run_step took over navigation.
- return if $status;
+ if ($handled) {
+ $self->unmorph($step);
+ return;
+ }
+
+ ### if there are no future steps - allow for this step to designate one to follow
+ my $is_at_end = $self->{'path_i'} >= $#$path ? 1 : 0;
+ $self->run_hook('refine_path', $step, $is_at_end);
+
+ $self->unmorph($step);
}
### allow for one exit point after the loop
if (! $self->{'path'}) {
my $path = $self->{'path'} = []; # empty path
- my $step = $self->form->{ $self->step_key };
- $step = lc($1) if ! $step && $ENV{'PATH_INFO'} && $ENV{'PATH_INFO'} =~ m|^/(\w+)|;
+ ### add initial items to the form hash from path_info
+ if (my $info = $ENV{'PATH_INFO'}) {
+ my $maps = $self->path_info_map_base || [];
+ croak 'Usage: sub path_info_map_base { [[qr{/path_info/(\w+)}, "keyname"]] }'
+ if ! UNIVERSAL::isa($maps, 'ARRAY') || (@$maps && ! UNIVERSAL::isa($maps->[0], 'ARRAY'));
+ foreach my $map (@$maps) {
+ my @match = $info =~ $map->[0];
+ next if ! @match;
+ $self->form->{$map->[$_]} = $match[$_ - 1] foreach grep {! defined $self->form->{$map->[$_]}} 1 .. $#$map;
+ last;
+ }
+ }
### make sure the step is valid
+ my $step = $self->form->{$self->step_key};
if (defined $step) {
if ($step =~ /^_/) { # can't begin with _
$self->stash->{'forbidden_step'} = $step;
return $self->{'path'};
}
+sub path_info_map_base {
+ my $self = shift;
+ return [[qr{/(\w+)}, $self->step_key]];
+}
+
sub set_path {
my $self = shift;
my $path = $self->{'path'} ||= [];
sub previous_step {
my $self = shift;
- croak "previous_step is readonly" if $#_ != -1;
return $self->step_by_path_index( ($self->{'path_i'} || 0) - 1 );
}
sub current_step {
my $self = shift;
- croak "current_step is readonly" if $#_ != -1;
return $self->step_by_path_index( ($self->{'path_i'} || 0) );
}
-sub next_step {
+sub next_step { # method and hook
my $self = shift;
- croak "next_step is readonly" if $#_ != -1;
return $self->step_by_path_index( ($self->{'path_i'} || 0) + 1 );
}
sub last_step {
my $self = shift;
- croak "last_step is readonly" if $#_ != -1;
return $self->step_by_path_index( $#{ $self->path } );
}
sub first_step {
my $self = shift;
- croak "first_step is readonly" if $#_ != -1;
return $self->step_by_path_index( 0 );
}
my ($code, $found) = @{ $self->find_hook($hook, $step) };
if (! $code) {
croak "Could not find a method named ${step}_${hook} or ${hook}";
+ } elsif (! UNIVERSAL::isa($code, 'CODE')) {
+ croak "Value for $hook ($found) is not a code ref ($code)";
}
-
### record history
my $hist = {
step => $step,
}
sub morph {
- my $self = shift;
- my $step = shift || return;
- return if ! (my $allow = $self->allow_morph($step));
+ my $self = shift;
+ my $step = shift || return;
+ my $allow = $self->allow_morph($step) || return;
### place to store the lineage
my $lin = $self->{'__morph_lineage'} ||= [];
meth => 'morph',
found => 'morph',
time => time,
- elapsed => 0,
+ elapsed => 0,
+ response => 0
};
push @{ $self->history }, $hist;
if (ref($allow) && ! $allow->{$step}) { # hash - but no step - record for unbless
$hist->{'found'} .= " (not allowed to morph to that step)";
- return;
+ return 0;
}
### make sure we haven't already been reblessed
|| (ref($allow) && ! $allow->{$step}) # hash - but no step
)) {
$hist->{'found'} .= $allow ? " (not allowed to nested_morph to that step)" : " (nested_morph disabled)";
- return; # just return - don't die so that we can morph early
+ return 0; # just return - don't die so that we can morph early
}
### if we are not already that package - bless us there
}
}
+ $hist->{'response'} = 1;
+ return 1;
}
sub unmorph {
meth => 'unmorph',
found => 'unmorph',
time => time,
- elapsed => 0,
+ elapsed => 0,
+ response => 0,
};
push @{ $self->history }, $hist;
$hist->{'found'} .= " (already isa $cur)";
}
+ $hist->{'response'} = 1;
return $self;
}
return $self->{'stash'} ||= {};
}
+sub clear_app {
+ my $self = shift;
+
+ delete @{ $self }{qw(
+ cgix
+ vob
+ form
+ cookies
+ stash
+ path
+ path_i
+ history
+ __morph_lineage_start_index
+ __morph_lineage
+ hash_errors
+ hash_fill
+ hash_swap
+ hash_common
+ )};
+
+ return $self;
+}
+
###----------------------------------------------------------------###
### default hook implementations
+sub path_info_map { }
+
sub run_step {
my $self = shift;
my $step = shift;
return 0;
}
+sub refine_path {
+ my ($self, $step, $is_at_end) = @_;
+ return 0 if ! $is_at_end; # if we aren't at the end of the path, don't do anything
+
+ my $next_step = $self->run_hook('next_step', $step) || return 0;
+ $self->run_hook('set_ready_validate', $step, 0);
+ $self->append_path($next_step);
+ return 1;
+}
+
sub prepared_print {
my $self = shift;
my $step = shift;
sub print_out {
my ($self, $step, $out) = @_;
- $self->cgix->print_content_type();
+ $self->cgix->print_content_type;
print $out;
}
sub swap_template {
my ($self, $step, $file, $swap) = @_;
- require CGI::Ex::Template;
my $args = $self->run_hook('template_args', $step);
- my $t = CGI::Ex::Template->new($args);
+ my $copy = $self;
+ eval {require Scalar::Util; Scalar::Util::weaken($copy)};
+ $args->{'INCLUDE_PATH'} ||= sub {
+ my $dir = $copy->base_dir_abs || die "Could not find base_dir_abs while looking for template INCLUDE_PATH on step \"$step\"";
+ $dir = $dir->() if UNIVERSAL::isa($dir, 'CODE');
+ return $dir;
+ };
+ my $t = $self->template_obj($args);
my $out = '';
+
$t->process($file, $swap, \$out) || die $t->error;
return $out;
}
-sub template_args {
- my $self = shift;
- my $step = shift;
- return {
- INCLUDE_PATH => sub { $self->base_dir_abs || die "Could not find base_dir_abs while looking for template INCLUDE_PATH on step \"$step\"" },
- };
+sub template_args { {} }
+
+sub template_obj {
+ my ($self, $args) = @_;
+
+ require CGI::Ex::Template;
+ my $t = CGI::Ex::Template->new($args);
}
sub fill_template {
sub skip { 0 } # success indicates to skip the step (and continue loop)
sub prepare { 1 } # failure means show step
sub finalize { 1 } # failure means show step
-sub post_print { 0 } # success indicates we handled step (don't continue loop)
+sub post_print { 0 }
sub post_step { 0 } # success indicates we handled step (don't continue step or loop)
-sub name_step {
- my ($self, $step) = @_;
- return $step;
-}
-
sub morph_package {
my $self = shift;
my $step = shift || '';
};
}
+sub name_step {
+ my ($self, $step) = @_;
+ return $step;
+}
+
sub file_print {
my $self = shift;
my $step = shift;
my $self = shift;
my $step = shift;
- my $abs = $self->base_dir_abs || return {};
+ ### determine the path to begin looking for files - allow for an arrayref
+ my $abs = $self->base_dir_abs || [];
+ $abs = $abs->() if UNIVERSAL::isa($abs, 'CODE');
+ $abs = [$abs] if ! UNIVERSAL::isa($abs, 'ARRAY');
+ return {} if @$abs == 0;
+
my $base_dir = $self->base_dir_rel;
my $module = $self->run_hook('name_module', $step);
- my $_step = $self->run_hook('name_step', $step);
+ my $_step = $self->run_hook('name_step', $step) || die "Missing name_step";
$_step .= '.'. $self->ext_val if $_step !~ /\.\w+$/;
- foreach ($abs, $base_dir, $module) { $_ .= '/' if length($_) && ! m|/$| }
+ foreach (@$abs, $base_dir, $module) { $_ .= '/' if length($_) && ! m|/$| }
+
+ if (@$abs > 1) {
+ foreach my $_abs (@$abs) {
+ my $path = $_abs . $base_dir . $module . $_step;
+ return $path if -e $path;
+ }
+ }
- return $abs . $base_dir . $module . $_step;
+ return $abs->[0] . $base_dir . $module . $_step;
}
sub info_complete {
- my $self = shift;
- my $step = shift;
-
+ my ($self, $step) = @_;
return 0 if ! $self->run_hook('ready_validate', $step);
- return 0 if ! $self->run_hook('validate', $step);
+ return 0 if ! $self->run_hook('validate', $step, $self->form);
return 1;
}
sub ready_validate {
- my $self = shift;
- my $step = shift;
-
+ my ($self, $step) = @_;
return ($ENV{'REQUEST_METHOD'} && $ENV{'REQUEST_METHOD'} eq 'POST') ? 1 : 0;
}
-sub set_ready_validate {
- my ($self, $ready) = @_;
- $ENV{'REQUEST_METHOD'} = ($ready) ? 'POST' : 'GET';
+sub set_ready_validate { # hook and method
+ my $self = shift;
+ my ($step, $is_ready) = (@_ == 2) ? @_ : (undef, shift);
+ $ENV{'REQUEST_METHOD'} = ($is_ready) ? 'POST' : 'GET';
+ return $is_ready;
}
sub validate {
- my $self = shift;
- my $step = shift;
- my $form = shift || $self->form;
+ my ($self, $step, $form) = @_;
+
my $hash = $self->run_hook('hash_validation', $step);
my $what_was_validated = [];
if (ref($file) && ! UNIVERSAL::isa($file, 'SCALAR')) {
$hash = $file;
- ### read the file - if it fails - errors should be in the webserver error logs
+ ### read the file - if it is not found, errors will be in the webserver logs (all else dies)
} elsif ($file) {
- $hash = eval { $self->vob->get_validation($file) } || {};
+ $hash = $self->vob->get_validation($file) || {};
} else {
$hash = {};
return $self->{'hash_base'} ||= do {
### create a weak copy of self to use in closures
- my $copy;
- if (eval {require Scalar::Util} && defined &Scalar::Util::weaken) {
- $copy = $self;
- Scalar::Util::weaken($copy);
- } else {
- $copy = bless {%$self}, ref($self); # hackish way to avoid circular refs on older perls (pre 5.8)
- }
-
+ my $copy = $self;
+ eval {require Scalar::Util; Scalar::Util::weaken($copy)};
my $hash = {
script_name => $ENV{'SCRIPT_NAME'} || $0,
path_info => $ENV{'PATH_INFO'} || '',
return $self->{'base_dir_abs'} || '';
}
-sub ext_val {
- my $self = shift;
- $self->{'ext_val'} = shift if $#_ != -1;
- return $self->{'ext_val'} || 'val';
-}
-
sub ext_print {
my $self = shift;
$self->{'ext_print'} = shift if $#_ != -1;
return $self->{'ext_print'} || 'html';
}
+sub ext_val {
+ my $self = shift;
+ $self->{'ext_val'} = shift if $#_ != -1;
+ return $self->{'ext_val'} || 'val';
+}
+
### where to find the javascript files
### default to using this script as a handler
sub js_uri_path {
projects / chaz / p5-CGI-Ex / blobdiff