| Filename | /usr/lib/perl5/Template/Service.pm |
| Statements | Executed 80 statements in 1.82ms |
| Calls | P | F | Exclusive Time |
Inclusive Time |
Subroutine |
|---|---|---|---|---|---|
| 1 | 1 | 1 | 586µs | 880µs | Template::Service::BEGIN@27 |
| 1 | 1 | 1 | 293µs | 830ms | Template::Service::process |
| 1 | 1 | 1 | 43µs | 23.3ms | Template::Service::_init |
| 1 | 1 | 1 | 23µs | 30µs | Template::Service::BEGIN@23 |
| 1 | 1 | 1 | 17µs | 55µs | Template::Service::BEGIN@29 |
| 1 | 1 | 1 | 15µs | 110µs | Template::Service::BEGIN@25 |
| 1 | 1 | 1 | 15µs | 39µs | Template::Service::BEGIN@24 |
| 1 | 1 | 1 | 14µs | 52µs | Template::Service::BEGIN@31 |
| 1 | 1 | 1 | 14µs | 54µs | Template::Service::BEGIN@28 |
| 1 | 1 | 1 | 9µs | 9µs | Template::Service::BEGIN@26 |
| 0 | 0 | 0 | 0s | 0s | Template::Service::_dump |
| 0 | 0 | 0 | 0s | 0s | Template::Service::_recover |
| 0 | 0 | 0 | 0s | 0s | Template::Service::context |
| Line | State ments |
Time on line |
Calls | Time in subs |
Code |
|---|---|---|---|---|---|
| 1 | #============================================================= -*-Perl-*- | ||||
| 2 | # | ||||
| 3 | # Template::Service | ||||
| 4 | # | ||||
| 5 | # DESCRIPTION | ||||
| 6 | # Module implementing a template processing service which wraps a | ||||
| 7 | # template within PRE_PROCESS and POST_PROCESS templates and offers | ||||
| 8 | # ERROR recovery. | ||||
| 9 | # | ||||
| 10 | # AUTHOR | ||||
| 11 | # Andy Wardley <abw@wardley.org> | ||||
| 12 | # | ||||
| 13 | # COPYRIGHT | ||||
| 14 | # Copyright (C) 1996-2007 Andy Wardley. All Rights Reserved. | ||||
| 15 | # | ||||
| 16 | # This module is free software; you can redistribute it and/or | ||||
| 17 | # modify it under the same terms as Perl itself. | ||||
| 18 | # | ||||
| 19 | #============================================================================ | ||||
| 20 | |||||
| 21 | package Template::Service; | ||||
| 22 | |||||
| 23 | 3 | 36µs | 2 | 36µs | # spent 30µs (23+6) within Template::Service::BEGIN@23 which was called:
# once (23µs+6µs) by Template::BEGIN@30 at line 23 # spent 30µs making 1 call to Template::Service::BEGIN@23
# spent 6µs making 1 call to strict::import |
| 24 | 3 | 62µs | 2 | 64µs | # spent 39µs (15+25) within Template::Service::BEGIN@24 which was called:
# once (15µs+25µs) by Template::BEGIN@30 at line 24 # spent 39µs making 1 call to Template::Service::BEGIN@24
# spent 25µs making 1 call to warnings::import |
| 25 | 3 | 45µs | 2 | 205µs | # spent 110µs (15+95) within Template::Service::BEGIN@25 which was called:
# once (15µs+95µs) by Template::BEGIN@30 at line 25 # spent 110µs making 1 call to Template::Service::BEGIN@25
# spent 95µs making 1 call to base::import |
| 26 | 3 | 27µs | 1 | 9µs | # spent 9µs within Template::Service::BEGIN@26 which was called:
# once (9µs+0s) by Template::BEGIN@30 at line 26 # spent 9µs making 1 call to Template::Service::BEGIN@26 |
| 27 | 3 | 130µs | 1 | 880µs | # spent 880µs (586+294) within Template::Service::BEGIN@27 which was called:
# once (586µs+294µs) by Template::BEGIN@30 at line 27 # spent 880µs making 1 call to Template::Service::BEGIN@27 |
| 28 | 3 | 34µs | 2 | 95µs | # spent 54µs (14+40) within Template::Service::BEGIN@28 which was called:
# once (14µs+40µs) by Template::BEGIN@30 at line 28 # spent 54µs making 1 call to Template::Service::BEGIN@28
# spent 40µs making 1 call to Exporter::import |
| 29 | 3 | 43µs | 2 | 93µs | # spent 55µs (17+38) within Template::Service::BEGIN@29 which was called:
# once (17µs+38µs) by Template::BEGIN@30 at line 29 # spent 55µs making 1 call to Template::Service::BEGIN@29
# spent 38µs making 1 call to Exporter::import |
| 30 | |||||
| 31 | 3 | 1.05ms | 2 | 90µs | # spent 52µs (14+38) within Template::Service::BEGIN@31 which was called:
# once (14µs+38µs) by Template::BEGIN@30 at line 31 # spent 52µs making 1 call to Template::Service::BEGIN@31
# spent 38µs making 1 call to constant::import |
| 32 | |||||
| 33 | 1 | 400ns | our $VERSION = 2.80; | ||
| 34 | 1 | 600ns | our $DEBUG = 0 unless defined $DEBUG; | ||
| 35 | 1 | 500ns | our $ERROR = ''; | ||
| 36 | |||||
| 37 | |||||
| 38 | #======================================================================== | ||||
| 39 | # ----- PUBLIC METHODS ----- | ||||
| 40 | #======================================================================== | ||||
| 41 | |||||
| 42 | #------------------------------------------------------------------------ | ||||
| 43 | # process($template, \%params) | ||||
| 44 | # | ||||
| 45 | # Process a template within a service framework. A service may encompass | ||||
| 46 | # PRE_PROCESS and POST_PROCESS templates and an ERROR hash which names | ||||
| 47 | # templates to be substituted for the main template document in case of | ||||
| 48 | # error. Each service invocation begins by resetting the state of the | ||||
| 49 | # context object via a call to reset(). The AUTO_RESET option may be set | ||||
| 50 | # to 0 (default: 1) to bypass this step. | ||||
| 51 | #------------------------------------------------------------------------ | ||||
| 52 | |||||
| 53 | # spent 830ms (293µs+830) within Template::Service::process which was called:
# once (293µs+830ms) by Template::process at line 66 of Template.pm | ||||
| 54 | 1 | 4µs | my ($self, $template, $params) = @_; | ||
| 55 | 1 | 2µs | my $context = $self->{ CONTEXT }; | ||
| 56 | 1 | 1µs | my ($name, $output, $procout, $error); | ||
| 57 | 1 | 1µs | $output = ''; | ||
| 58 | |||||
| 59 | $self->debug("process($template, ", | ||||
| 60 | defined $params ? $params : '<no params>', | ||||
| 61 | 1 | 2µs | ')') if $self->{ DEBUG }; | ||
| 62 | |||||
| 63 | $context->reset() | ||||
| 64 | 1 | 7µs | 1 | 14µs | if $self->{ AUTO_RESET }; # spent 14µs making 1 call to Template::Context::reset |
| 65 | |||||
| 66 | # pre-request compiled template from context so that we can alias it | ||||
| 67 | # in the stash for pre-processed templates to reference | ||||
| 68 | 2 | 10µs | 1 | 464ms | eval { $template = $context->template($template) }; # spent 464ms making 1 call to Template::Context::template |
| 69 | 1 | 600ns | return $self->error($@) | ||
| 70 | if $@; | ||||
| 71 | |||||
| 72 | # localise the variable stash with any parameters passed | ||||
| 73 | # and set the 'template' variable | ||||
| 74 | 1 | 700ns | $params ||= { }; | ||
| 75 | # TODO: change this to C<||=> so we can use a template parameter | ||||
| 76 | 1 | 6µs | $params->{ template } = $template | ||
| 77 | unless ref $template eq 'CODE'; | ||||
| 78 | 1 | 8µs | 1 | 301µs | $context->localise($params); # spent 301µs making 1 call to Template::Context::localise |
| 79 | |||||
| 80 | SERVICE: { | ||||
| 81 | # PRE_PROCESS | ||||
| 82 | 2 | 3µs | eval { | ||
| 83 | 1 | 5µs | foreach $name (@{ $self->{ PRE_PROCESS } }) { | ||
| 84 | $self->debug("PRE_PROCESS: $name") if $self->{ DEBUG }; | ||||
| 85 | $output .= $context->process($name); | ||||
| 86 | } | ||||
| 87 | }; | ||||
| 88 | 1 | 3µs | last SERVICE if ($error = $@); | ||
| 89 | |||||
| 90 | # PROCESS | ||||
| 91 | 1 | 2µs | eval { | ||
| 92 | 1 | 4µs | foreach $name (@{ $self->{ PROCESS } || [ $template ] }) { | ||
| 93 | 1 | 1µs | $self->debug("PROCESS: $name") if $self->{ DEBUG }; | ||
| 94 | 1 | 76µs | 1 | 365ms | $procout .= $context->process($name); # spent 365ms making 1 call to Template::Context::process |
| 95 | } | ||||
| 96 | }; | ||||
| 97 | 1 | 1µs | if ($error = $@) { | ||
| 98 | last SERVICE | ||||
| 99 | unless defined ($procout = $self->_recover(\$error)); | ||||
| 100 | } | ||||
| 101 | |||||
| 102 | 1 | 2µs | if (defined $procout) { | ||
| 103 | # WRAPPER | ||||
| 104 | 1 | 1µs | eval { | ||
| 105 | 1 | 4µs | foreach $name (reverse @{ $self->{ WRAPPER } }) { | ||
| 106 | $self->debug("WRAPPER: $name") if $self->{ DEBUG }; | ||||
| 107 | $procout = $context->process($name, { content => $procout }); | ||||
| 108 | } | ||||
| 109 | }; | ||||
| 110 | 1 | 800ns | last SERVICE if ($error = $@); | ||
| 111 | 1 | 12µs | $output .= $procout; | ||
| 112 | } | ||||
| 113 | |||||
| 114 | # POST_PROCESS | ||||
| 115 | 1 | 800ns | eval { | ||
| 116 | 1 | 3µs | foreach $name (@{ $self->{ POST_PROCESS } }) { | ||
| 117 | $self->debug("POST_PROCESS: $name") if $self->{ DEBUG }; | ||||
| 118 | $output .= $context->process($name); | ||||
| 119 | } | ||||
| 120 | }; | ||||
| 121 | 1 | 700ns | last SERVICE if ($error = $@); | ||
| 122 | } | ||||
| 123 | |||||
| 124 | 1 | 77µs | 1 | 92µs | $context->delocalise(); # spent 92µs making 1 call to Template::Context::delocalise |
| 125 | 1 | 26µs | 1 | 2µs | delete $params->{ template }; # spent 2µs making 1 call to Template::Stash::XS::DESTROY |
| 126 | |||||
| 127 | 1 | 700ns | if ($error) { | ||
| 128 | # $error = $error->as_string if ref $error; | ||||
| 129 | return $self->error($error); | ||||
| 130 | } | ||||
| 131 | |||||
| 132 | 1 | 80µs | return $output; | ||
| 133 | } | ||||
| 134 | |||||
| 135 | |||||
| 136 | #------------------------------------------------------------------------ | ||||
| 137 | # context() | ||||
| 138 | # | ||||
| 139 | # Returns the internal CONTEXT reference. | ||||
| 140 | #------------------------------------------------------------------------ | ||||
| 141 | |||||
| 142 | sub context { | ||||
| 143 | return $_[0]->{ CONTEXT }; | ||||
| 144 | } | ||||
| 145 | |||||
| 146 | |||||
| 147 | #======================================================================== | ||||
| 148 | # -- PRIVATE METHODS -- | ||||
| 149 | #======================================================================== | ||||
| 150 | |||||
| 151 | # spent 23.3ms (43µs+23.3) within Template::Service::_init which was called:
# once (43µs+23.3ms) by Template::Base::new at line 65 of Template/Base.pm | ||||
| 152 | 1 | 2µs | my ($self, $config) = @_; | ||
| 153 | 1 | 1µs | my ($item, $data, $context, $block, $blocks); | ||
| 154 | 1 | 1µs | my $delim = $config->{ DELIMITER }; | ||
| 155 | 1 | 1µs | $delim = ':' unless defined $delim; | ||
| 156 | |||||
| 157 | # coerce PRE_PROCESS, PROCESS and POST_PROCESS to arrays if necessary, | ||||
| 158 | # by splitting on non-word characters | ||||
| 159 | 1 | 3µs | foreach $item (qw( PRE_PROCESS PROCESS POST_PROCESS WRAPPER )) { | ||
| 160 | 4 | 2µs | $data = $config->{ $item }; | ||
| 161 | 4 | 6µs | $self->{ $item } = [ ], next unless (defined $data); | ||
| 162 | $data = [ split($delim, $data || '') ] | ||||
| 163 | unless ref $data eq 'ARRAY'; | ||||
| 164 | $self->{ $item } = $data; | ||||
| 165 | } | ||||
| 166 | # unset PROCESS option unless explicitly specified in config | ||||
| 167 | $self->{ PROCESS } = undef | ||||
| 168 | 1 | 2µs | unless defined $config->{ PROCESS }; | ||
| 169 | |||||
| 170 | 1 | 2µs | $self->{ ERROR } = $config->{ ERROR } || $config->{ ERRORS }; | ||
| 171 | $self->{ AUTO_RESET } = defined $config->{ AUTO_RESET } | ||||
| 172 | 1 | 2µs | ? $config->{ AUTO_RESET } : 1; | ||
| 173 | 1 | 2µs | $self->{ DEBUG } = ( $config->{ DEBUG } || 0 ) | ||
| 174 | & Template::Constants::DEBUG_SERVICE; | ||||
| 175 | |||||
| 176 | $context = $self->{ CONTEXT } = $config->{ CONTEXT } | ||||
| 177 | 1 | 9µs | 1 | 23.3ms | || Template::Config->context($config) # spent 23.3ms making 1 call to Template::Config::context |
| 178 | || return $self->error(Template::Config->error); | ||||
| 179 | |||||
| 180 | 1 | 5µs | return $self; | ||
| 181 | } | ||||
| 182 | |||||
| 183 | |||||
| 184 | #------------------------------------------------------------------------ | ||||
| 185 | # _recover(\$exception) | ||||
| 186 | # | ||||
| 187 | # Examines the internal ERROR hash array to find a handler suitable | ||||
| 188 | # for the exception object passed by reference. Selecting the handler | ||||
| 189 | # is done by delegation to the exception's select_handler() method, | ||||
| 190 | # passing the set of handler keys as arguments. A 'default' handler | ||||
| 191 | # may also be provided. The handler value represents the name of a | ||||
| 192 | # template which should be processed. | ||||
| 193 | #------------------------------------------------------------------------ | ||||
| 194 | |||||
| 195 | sub _recover { | ||||
| 196 | my ($self, $error) = @_; | ||||
| 197 | my $context = $self->{ CONTEXT }; | ||||
| 198 | my ($hkey, $handler, $output); | ||||
| 199 | |||||
| 200 | # there shouldn't ever be a non-exception object received at this | ||||
| 201 | # point... unless a module like CGI::Carp messes around with the | ||||
| 202 | # DIE handler. | ||||
| 203 | return undef | ||||
| 204 | unless blessed($$error) && $$error->isa(EXCEPTION); | ||||
| 205 | |||||
| 206 | # a 'stop' exception is thrown by [% STOP %] - we return the output | ||||
| 207 | # buffer stored in the exception object | ||||
| 208 | return $$error->text() | ||||
| 209 | if $$error->type() eq 'stop'; | ||||
| 210 | |||||
| 211 | my $handlers = $self->{ ERROR } | ||||
| 212 | || return undef; ## RETURN | ||||
| 213 | |||||
| 214 | if (ref $handlers eq 'HASH') { | ||||
| 215 | if ($hkey = $$error->select_handler(keys %$handlers)) { | ||||
| 216 | $handler = $handlers->{ $hkey }; | ||||
| 217 | $self->debug("using error handler for $hkey") if $self->{ DEBUG }; | ||||
| 218 | } | ||||
| 219 | elsif ($handler = $handlers->{ default }) { | ||||
| 220 | # use default handler | ||||
| 221 | $self->debug("using default error handler") if $self->{ DEBUG }; | ||||
| 222 | } | ||||
| 223 | else { | ||||
| 224 | return undef; ## RETURN | ||||
| 225 | } | ||||
| 226 | } | ||||
| 227 | else { | ||||
| 228 | $handler = $handlers; | ||||
| 229 | $self->debug("using default error handler") if $self->{ DEBUG }; | ||||
| 230 | } | ||||
| 231 | |||||
| 232 | eval { $handler = $context->template($handler) }; | ||||
| 233 | if ($@) { | ||||
| 234 | $$error = $@; | ||||
| 235 | return undef; ## RETURN | ||||
| 236 | }; | ||||
| 237 | |||||
| 238 | $context->stash->set('error', $$error); | ||||
| 239 | eval { | ||||
| 240 | $output .= $context->process($handler); | ||||
| 241 | }; | ||||
| 242 | if ($@) { | ||||
| 243 | $$error = $@; | ||||
| 244 | return undef; ## RETURN | ||||
| 245 | } | ||||
| 246 | |||||
| 247 | return $output; | ||||
| 248 | } | ||||
| 249 | |||||
| - - | |||||
| 252 | #------------------------------------------------------------------------ | ||||
| 253 | # _dump() | ||||
| 254 | # | ||||
| 255 | # Debug method which return a string representing the internal object | ||||
| 256 | # state. | ||||
| 257 | #------------------------------------------------------------------------ | ||||
| 258 | |||||
| 259 | sub _dump { | ||||
| 260 | my $self = shift; | ||||
| 261 | my $context = $self->{ CONTEXT }->_dump(); | ||||
| 262 | $context =~ s/\n/\n /gm; | ||||
| 263 | |||||
| 264 | my $error = $self->{ ERROR }; | ||||
| 265 | $error = join('', | ||||
| 266 | "{\n", | ||||
| 267 | (map { " $_ => $error->{ $_ }\n" } | ||||
| 268 | keys %$error), | ||||
| 269 | "}\n") | ||||
| 270 | if ref $error; | ||||
| 271 | |||||
| 272 | local $" = ', '; | ||||
| 273 | return <<EOF; | ||||
| 274 | $self | ||||
| 275 | PRE_PROCESS => [ @{ $self->{ PRE_PROCESS } } ] | ||||
| 276 | POST_PROCESS => [ @{ $self->{ POST_PROCESS } } ] | ||||
| 277 | ERROR => $error | ||||
| 278 | CONTEXT => $context | ||||
| 279 | EOF | ||||
| 280 | } | ||||
| 281 | |||||
| 282 | |||||
| 283 | 1 | 4µs | 1; | ||
| 284 | |||||
| 285 | __END__ |