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::Order;
16 use SL::Presenter::Part;
17 use SL::Presenter::Project;
18 use SL::Presenter::Record;
19 use SL::Presenter::RequirementSpec;
20 use SL::Presenter::RequirementSpecItem;
21 use SL::Presenter::RequirementSpecTextBlock;
22 use SL::Presenter::SepaExport;
23 use SL::Presenter::Text;
24 use SL::Presenter::Tag;
26 use Rose::Object::MakeMethods::Generic (
27 scalar => [ qw(need_reinit_widgets) ],
31 return $::request->presenter;
37 my ($options, %locals) = (@_ && ref($_[0])) ? @_ : ({ }, @_);
39 # Set defaults for all available options.
44 $options->{$_} //= $defaults{$_} for keys %defaults;
45 $options->{type} = lc $options->{type};
47 # Check supplied options for validity.
48 foreach (keys %{ $options }) {
49 croak "Unsupported option: $_" unless $defaults{$_};
52 # Only certain types are supported.
53 croak "Unsupported type: " . $options->{type} unless $options->{type} =~ m/^(?:html|js|json|text)$/;
55 # The "template" argument must be a string or a reference to one.
56 $template = ${ $template } if ((ref($template) || '') eq 'REF') && (ref(${ $template }) eq 'SL::Presenter::EscapedText');
57 croak "Unsupported 'template' reference type: " . ref($template) if ref($template) && (ref($template) !~ m/^(?:SCALAR|SL::Presenter::EscapedText)$/);
59 # Look for the file given by $template if $template is not a reference.
62 my $ext = $options->{type} eq 'text' ? 'txt' : $options->{type};
63 $source = "templates/webpages/${template}.${ext}";
64 croak "Template file ${source} not found" unless -f $source;
66 } elsif (ref($template) eq 'SCALAR') {
67 # Normal scalar reference: hand over to Template
71 # Instance of SL::Presenter::EscapedText. Get reference to its content.
72 $source = \$template->{text};
75 # If no processing is requested then return the content.
76 if (!$options->{process}) {
77 # If $template is a reference then don't try to read a file.
78 my $ref = ref $template;
79 return $template if $ref eq 'SL::Presenter::EscapedText';
80 return SL::Presenter::EscapedText->new(text => ${ $template }, is_escaped => 1) if $ref eq 'SCALAR';
82 # Otherwise return the file's content.
83 my $file = IO::File->new($source, "r") || croak("Template file ${source} could not be read");
84 my $content = do { local $/ = ''; <$file> };
87 return SL::Presenter::EscapedText->new(text => $content, is_escaped => 1);
90 # Processing was requested. Set up all variables.
91 my %params = ( %locals,
93 FLASH => $::form->{FLASH},
95 INSTANCE_CONF => $::instance_conf,
97 LXCONFIG => \%::lx_office_conf,
98 LXDEBUG => $::lxdebug,
99 MYCONFIG => \%::myconfig,
104 my $parser = $self->get_template;
105 $parser->process($source, \%params, \$output) || croak $parser->error;
107 return SL::Presenter::EscapedText->new(text => $output, is_escaped => 1);
113 $self->{template} ||=
114 Template->new({ INTERPOLATE => 0,
118 PLUGIN_BASE => 'SL::Template::Plugin',
119 INCLUDE_PATH => '.:templates/webpages',
120 COMPILE_EXT => '.tcc',
121 COMPILE_DIR => $::lx_office_conf{paths}->{userspath} . '/templates-cache',
122 ERROR => 'templates/webpages/generic/exception.html',
126 return $self->{template};
130 my ($self, $text) = @_;
132 return SL::Presenter::EscapedText->new(text => $text);
136 my ($self, $text) = @_;
138 return SL::Presenter::EscapedText->new(text => $text, is_escaped => 1);
142 my ($self, $text) = @_;
144 $text =~ s|\\|\\\\|g;
145 $text =~ s|\"|\\\"|g;
148 return SL::Presenter::EscapedText->new(text => $text, is_escaped => 1);
157 SL::Presenter - presentation layer class
162 my $presenter = SL::Presenter->get;
164 # Lower-level template parsing:
165 my $html = $presenter->render(
166 'presenter/dir/template.html',
170 # Higher-level rendering of certain objects:
171 use SL::DB::Customer;
173 my $linked_customer_name = $presenter->customer($customer, display => 'table-cell');
175 # Render a list of links to sales/purchase records:
178 my $quotation = SL::DB::Manager::Order->get_first(where => { quotation => 1 });
179 my $records = $quotation->linked_records(direction => 'to');
180 my $html = $presenter->grouped_record_list($records);
182 =head1 CLASS FUNCTIONS
188 Returns the global presenter object and creates it if it doesn't exist
193 =head1 INSTANCE FUNCTIONS
197 =item C<render $template, [ $options, ] %locals>
199 Renders the template C<$template>. Provides other variables than
200 C<Form::parse_html_template> does.
202 C<$options>, if present, must be a hash reference. All remaining
203 parameters are slurped into C<%locals>.
205 This is the backend function that L<SL::Controller::Base/render>
206 calls. The big difference is that the presenter's L<render> function
207 always returns the input and never sends anything to the browser while
208 the controller's function usually sends the result to the
209 controller. Therefore the presenter's L<render> function does not use
210 all of the parameters for controlling the output that the controller's
213 What is rendered and how C<$template> is interpreted is determined
214 both by C<$template>'s reference type and by the supplied options.
216 If C<$template> is a normal scalar (not a reference) then it is meant
217 to be a template file name relative to the C<templates/webpages>
218 directory. The file name to use is determined by the C<type> option.
220 If C<$template> is a reference to a scalar then the referenced
221 scalar's content is used as the content to process. The C<type> option
222 is not considered in this case.
224 C<$template> can also be an instance of L<SL::Presenter::EscapedText>
225 or a reference to such an instance. Both of these cases are handled
226 the same way as if C<$template> were a reference to a scalar: its
227 content is processed, and C<type> is not considered.
229 Other reference types, unknown options and unknown arguments to the
230 C<type> option cause the function to L<croak>.
232 The following options are available:
238 The template type. Can be C<html> (the default), C<js> for JavaScript,
239 C<json> for JSON and C<text> for plain text content. Affects only the
240 extension that's added to the file name given with a non-reference
241 C<$template> argument.
245 If trueish (which is also the default) it causes the template/content
246 to be processed by the Template toolkit. Otherwise the
247 template/content is returned as-is.
251 If template processing is requested then the template has access to
252 the following variables:
256 =item * C<AUTH> -- C<$::auth>
258 =item * C<FLASH> -- the flash instance (C<$::form-E<gt>{FLASH}>)
260 =item * C<FORM> -- C<$::form>
262 =item * C<INSTANCE_CONF> -- C<$::instance_conf>
264 =item * C<LOCALE> -- C<$::locale>
266 =item * C<LXCONFIG> -- all parameters from C<config/kivitendo.conf>
267 with the same name they appear in the file (first level is the
268 section, second the actual variable, e.g. C<system.language>,
269 C<features.webdav> etc)
271 =item * C<LXDEBUG> -- C<$::lxdebug>
273 =item * C<MYCONFIG> -- C<%::myconfig>
275 =item * C<SELF> -- the controller instance
277 =item * C<PRESENTER> -- the presenter instance the template is
280 =item * All items from C<%locals>
284 The function will always return the output and never send anything to
287 Example: Render a HTML template with a certain title and a few locals
289 $presenter->render('todo/list',
290 title => 'List TODO items',
291 TODO_ITEMS => SL::DB::Manager::Todo->get_all_sorted);
293 Example: Render a string and return its content for further processing
294 by the calling function.
296 my $content = $presenter->render(\'[% USE JavaScript %][% JavaScript.replace_with("#someid", "js/something") %]');
298 Example: Return the content of a JSON template file without processing
301 my $template_content = $presenter->render(
303 { type => 'json', process => 0 }
306 =item C<escape $text>
308 Returns an HTML-escaped version of C<$text>. Instead of a string an
309 instance of the thin proxy-object L<SL::Presenter::EscapedText> is
312 It is safe to call C<escape> on an instance of
313 L<SL::Presenter::EscapedText>. This is a no-op (the same instance will
316 =item C<escaped_text $text>
318 Returns an instance of L<SL::Presenter::EscapedText>. C<$text> is
319 assumed to be a string that has already been HTML-escaped.
321 It is safe to call C<escaped_text> on an instance of
322 L<SL::Presenter::EscapedText>. This is a no-op (the same instance will
325 =item C<escape_js $text>
327 Returns a JavaScript-escaped version of C<$text>. Instead of a string
328 an instance of the thin proxy-object L<SL::Presenter::EscapedText> is
331 It is safe to call C<escape> on an instance of
332 L<SL::Presenter::EscapedText>. This is a no-op (the same instance will
335 =item C<get_template>
337 Returns the global instance of L<Template> and creates it if it
338 doesn't exist already.
344 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>