5 use parent qw(Rose::Object);
10 use SL::Presenter::Chart;
11 use SL::Presenter::CustomerVendor;
12 use SL::Presenter::DeliveryOrder;
13 use SL::Presenter::EscapedText;
14 use SL::Presenter::Invoice;
15 use SL::Presenter::GL;
16 use SL::Presenter::Letter;
17 use SL::Presenter::Order;
18 use SL::Presenter::Part;
19 use SL::Presenter::Project;
20 use SL::Presenter::Record;
21 use SL::Presenter::RequirementSpec;
22 use SL::Presenter::RequirementSpecItem;
23 use SL::Presenter::RequirementSpecTextBlock;
24 use SL::Presenter::SepaExport;
25 use SL::Presenter::Text;
26 use SL::Presenter::Tag;
27 use SL::Presenter::BankAccount;
29 use Rose::Object::MakeMethods::Generic (
30 scalar => [ qw(need_reinit_widgets) ],
34 return $::request->presenter;
40 my ($options, %locals) = (@_ && ref($_[0])) ? @_ : ({ }, @_);
42 # Set defaults for all available options.
47 $options->{$_} //= $defaults{$_} for keys %defaults;
48 $options->{type} = lc $options->{type};
50 # Check supplied options for validity.
51 foreach (keys %{ $options }) {
52 croak "Unsupported option: $_" unless $defaults{$_};
55 # Only certain types are supported.
56 croak "Unsupported type: " . $options->{type} unless $options->{type} =~ m/^(?:html|js|json|text)$/;
58 # The "template" argument must be a string or a reference to one.
59 $template = ${ $template } if ((ref($template) || '') eq 'REF') && (ref(${ $template }) eq 'SL::Presenter::EscapedText');
60 croak "Unsupported 'template' reference type: " . ref($template) if ref($template) && (ref($template) !~ m/^(?:SCALAR|SL::Presenter::EscapedText)$/);
62 # Look for the file given by $template if $template is not a reference.
65 my $ext = $options->{type} eq 'text' ? 'txt' : $options->{type};
66 $source = "templates/webpages/${template}.${ext}";
67 croak "Template file ${source} not found" unless -f $source;
69 } elsif (ref($template) eq 'SCALAR') {
70 # Normal scalar reference: hand over to Template
74 # Instance of SL::Presenter::EscapedText. Get reference to its content.
75 $source = \$template->{text};
78 # If no processing is requested then return the content.
79 if (!$options->{process}) {
80 # If $template is a reference then don't try to read a file.
81 my $ref = ref $template;
82 return $template if $ref eq 'SL::Presenter::EscapedText';
83 return SL::Presenter::EscapedText->new(text => ${ $template }, is_escaped => 1) if $ref eq 'SCALAR';
85 # Otherwise return the file's content.
86 my $file = IO::File->new($source, "r") || croak("Template file ${source} could not be read");
87 my $content = do { local $/ = ''; <$file> };
90 return SL::Presenter::EscapedText->new(text => $content, is_escaped => 1);
93 # Processing was requested. Set up all variables.
94 my %params = ( %locals,
96 FLASH => $::form->{FLASH},
98 INSTANCE_CONF => $::instance_conf,
100 LXCONFIG => \%::lx_office_conf,
101 LXDEBUG => $::lxdebug,
102 MYCONFIG => \%::myconfig,
107 my $parser = $self->get_template;
108 $parser->process($source, \%params, \$output) || croak $parser->error;
110 return SL::Presenter::EscapedText->new(text => $output, is_escaped => 1);
116 # Make locales.pl parse generic/exception.html, too:
117 # $::form->parse_html_template("generic/exception")
118 $self->{template} ||=
119 Template->new({ INTERPOLATE => 0,
123 PLUGIN_BASE => 'SL::Template::Plugin',
124 INCLUDE_PATH => '.:templates/webpages',
125 COMPILE_EXT => '.tcc',
126 COMPILE_DIR => $::lx_office_conf{paths}->{userspath} . '/templates-cache',
127 ERROR => 'templates/webpages/generic/exception.html',
131 return $self->{template};
135 my ($self, $text) = @_;
137 return SL::Presenter::EscapedText->new(text => $text);
141 my ($self, $text) = @_;
143 return SL::Presenter::EscapedText->new(text => $text, is_escaped => 1);
147 my ($self, $text) = @_;
149 $text =~ s|\\|\\\\|g;
150 $text =~ s|\"|\\\"|g;
153 return SL::Presenter::EscapedText->new(text => $text, is_escaped => 1);
162 SL::Presenter - presentation layer class
167 my $presenter = SL::Presenter->get;
169 # Lower-level template parsing:
170 my $html = $presenter->render(
171 'presenter/dir/template.html',
175 # Higher-level rendering of certain objects:
176 use SL::DB::Customer;
178 my $linked_customer_name = $presenter->customer($customer, display => 'table-cell');
180 # Render a list of links to sales/purchase records:
183 my $quotation = SL::DB::Manager::Order->get_first(where => { quotation => 1 });
184 my $records = $quotation->linked_records(direction => 'to');
185 my $html = $presenter->grouped_record_list($records);
187 =head1 CLASS FUNCTIONS
193 Returns the global presenter object and creates it if it doesn't exist
198 =head1 INSTANCE FUNCTIONS
202 =item C<render $template, [ $options, ] %locals>
204 Renders the template C<$template>. Provides other variables than
205 C<Form::parse_html_template> does.
207 C<$options>, if present, must be a hash reference. All remaining
208 parameters are slurped into C<%locals>.
210 This is the backend function that L<SL::Controller::Base/render>
211 calls. The big difference is that the presenter's L<render> function
212 always returns the input and never sends anything to the browser while
213 the controller's function usually sends the result to the
214 controller. Therefore the presenter's L<render> function does not use
215 all of the parameters for controlling the output that the controller's
218 What is rendered and how C<$template> is interpreted is determined
219 both by C<$template>'s reference type and by the supplied options.
221 If C<$template> is a normal scalar (not a reference) then it is meant
222 to be a template file name relative to the C<templates/webpages>
223 directory. The file name to use is determined by the C<type> option.
225 If C<$template> is a reference to a scalar then the referenced
226 scalar's content is used as the content to process. The C<type> option
227 is not considered in this case.
229 C<$template> can also be an instance of L<SL::Presenter::EscapedText>
230 or a reference to such an instance. Both of these cases are handled
231 the same way as if C<$template> were a reference to a scalar: its
232 content is processed, and C<type> is not considered.
234 Other reference types, unknown options and unknown arguments to the
235 C<type> option cause the function to L<croak>.
237 The following options are available:
243 The template type. Can be C<html> (the default), C<js> for JavaScript,
244 C<json> for JSON and C<text> for plain text content. Affects only the
245 extension that's added to the file name given with a non-reference
246 C<$template> argument.
250 If trueish (which is also the default) it causes the template/content
251 to be processed by the Template toolkit. Otherwise the
252 template/content is returned as-is.
256 If template processing is requested then the template has access to
257 the following variables:
261 =item * C<AUTH> -- C<$::auth>
263 =item * C<FLASH> -- the flash instance (C<$::form-E<gt>{FLASH}>)
265 =item * C<FORM> -- C<$::form>
267 =item * C<INSTANCE_CONF> -- C<$::instance_conf>
269 =item * C<LOCALE> -- C<$::locale>
271 =item * C<LXCONFIG> -- all parameters from C<config/kivitendo.conf>
272 with the same name they appear in the file (first level is the
273 section, second the actual variable, e.g. C<system.language>,
274 C<features.webdav> etc)
276 =item * C<LXDEBUG> -- C<$::lxdebug>
278 =item * C<MYCONFIG> -- C<%::myconfig>
280 =item * C<SELF> -- the controller instance
282 =item * C<PRESENTER> -- the presenter instance the template is
285 =item * All items from C<%locals>
289 The function will always return the output and never send anything to
292 Example: Render a HTML template with a certain title and a few locals
294 $presenter->render('todo/list',
295 title => 'List TODO items',
296 TODO_ITEMS => SL::DB::Manager::Todo->get_all_sorted);
298 Example: Render a string and return its content for further processing
299 by the calling function.
301 my $content = $presenter->render(\'[% USE JavaScript %][% JavaScript.replace_with("#someid", "js/something") %]');
303 Example: Return the content of a JSON template file without processing
306 my $template_content = $presenter->render(
308 { type => 'json', process => 0 }
311 =item C<escape $text>
313 Returns an HTML-escaped version of C<$text>. Instead of a string an
314 instance of the thin proxy-object L<SL::Presenter::EscapedText> is
317 It is safe to call C<escape> on an instance of
318 L<SL::Presenter::EscapedText>. This is a no-op (the same instance will
321 =item C<escaped_text $text>
323 Returns an instance of L<SL::Presenter::EscapedText>. C<$text> is
324 assumed to be a string that has already been HTML-escaped.
326 It is safe to call C<escaped_text> on an instance of
327 L<SL::Presenter::EscapedText>. This is a no-op (the same instance will
330 =item C<escape_js $text>
332 Returns a JavaScript-escaped version of C<$text>. Instead of a string
333 an instance of the thin proxy-object L<SL::Presenter::EscapedText> is
336 It is safe to call C<escape> on an instance of
337 L<SL::Presenter::EscapedText>. This is a no-op (the same instance will
340 =item C<get_template>
342 Returns the global instance of L<Template> and creates it if it
343 doesn't exist already.
349 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>