9108a224e623abfd0841a5cc6ceb23f1799c49d2
[kivitendo-erp.git] / SL / Helper / PrintOptions.pm
1 package SL::Helper::PrintOptions;
2
3 use strict;
4
5 use List::MoreUtils qw(any);
6
7 sub opthash { +{ value => shift, selected => shift, oname => shift } }
8
9 # generate the printing options displayed at the bottom of oe and is forms.
10 # this function will attempt to guess what type of form is displayed, and will generate according options
11 #
12 # about the coding:
13 # this version builds the arrays of options pretty directly. if you have trouble understanding how,
14 # the opthash function builds hashrefs which are then pieced together for the template arrays.
15 # unneeded options are "undef"ed out, and then grepped out.
16 #
17 # the inline options is untested, but intended to be used later in metatemplating
18 sub get_print_options {
19   my ($class, %params) = @_;
20
21   no warnings 'once';
22
23   my $form     = $params{form}     || $::form;
24   my $myconfig = $params{myconfig} || \%::myconfig;
25   my $locale   = $params{locale}   || $::locale;
26   my $options  = $params{options};
27
28   use warnings 'once';
29
30   my $prefix = $options->{dialog_name_prefix} || '';
31
32   # names 3 parameters and returns a hashref, for use in templates
33   my (@FORMNAME, @LANGUAGE_ID, @FORMAT, @SENDMODE, @MEDIA, @PRINTER_ID, @SELECTS) = ();
34
35   # note: "||"-selection is only correct for values where "0" is _not_ a correct entry
36   $form->{sendmode}   = "attachment";
37   $form->{format}     = $form->{format} || $myconfig->{template_format} || "pdf";
38   $form->{copies}     = $form->{copies} || $myconfig->{copies}          || 3;
39   $form->{media}      = $form->{media}  || $myconfig->{default_media}   || "screen";
40   $form->{printer_id} = defined $form->{printer_id}           ? $form->{printer_id} :
41                         defined $myconfig->{default_printer_id} ? $myconfig->{default_printer_id} : "";
42
43   $form->{PD}{ $form->{formname} } = "selected";
44   $form->{DF}{ $form->{format} }   = "selected";
45   $form->{OP}{ $form->{media} }    = "selected";
46   $form->{SM}{ $form->{sendmode} } = "selected";
47
48   push @FORMNAME, grep $_,
49     ($form->{type} eq 'purchase_order') ? (
50       opthash("purchase_order",      $form->{PD}{purchase_order},      $locale->text('Purchase Order')),
51       opthash("bin_list",            $form->{PD}{bin_list},            $locale->text('Bin List'))
52     ) : undef,
53     ($form->{type} eq 'credit_note') ?
54       opthash("credit_note",         $form->{PD}{credit_note},         $locale->text('Credit Note')) : undef,
55     ($form->{type} eq 'sales_order') ? (
56       opthash("sales_order",         $form->{PD}{sales_order},         $locale->text('Confirmation')),
57       opthash("proforma",            $form->{PD}{proforma},            $locale->text('Proforma Invoice')),
58       opthash("ic_supply",           $form->{PD}{ic_supply},            $locale->text('Intra-Community supply')),
59     ) : undef,
60     ($form->{type} =~ /sales_quotation$/) ?
61       opthash('sales_quotation',     $form->{PD}{sales_quotation},     $locale->text('Quotation')) : undef,
62     ($form->{type} =~ /request_quotation$/) ?
63       opthash('request_quotation',   $form->{PD}{request_quotation},   $locale->text('Request for Quotation')) : undef,
64     ($form->{type} eq 'invoice') ? (
65       opthash("invoice",             $form->{PD}{invoice},             $locale->text('Invoice')),
66       opthash("proforma",            $form->{PD}{proforma},            $locale->text('Proforma Invoice')),
67       opthash("invoice_copy",        $form->{PD}{invoice_copy},        $locale->text('Invoice Copy')),
68     ) : undef,
69     ($form->{type} eq 'invoice' && $form->{storno}) ? (
70       opthash("storno_invoice",      $form->{PD}{storno_invoice},      $locale->text('Storno Invoice')),
71     ) : undef,
72     ($form->{type} eq 'invoice_for_advance_payment') ? (
73       opthash("invoice_for_advance_payment", $form->{PD}{invoice_for_advance_payment},      $locale->text('Invoice for Advance Payment')),
74     ) : undef,
75     ($form->{type} eq 'final_invoice') ? (
76       opthash("final_invoice", $form->{PD}{final_invoice},             $locale->text('Final Invoice')),
77     ) : undef,
78     ($form->{type} =~ /^supplier_delivery_order$/) ? (
79       opthash('supplier_delivery_order', $form->{PD}{supplier_delivery_order},  $locale->text('Supplier Delivery Order')),
80     ) : undef,
81     ($form->{type} =~ /(sales|purchase)_delivery_order$/) ? (
82       opthash($form->{type},         $form->{PD}{$form->{type}},       $locale->text('Delivery Order')),
83       opthash('pick_list',           $form->{PD}{pick_list},           $locale->text('Pick List')),
84     ) : undef,
85     ($form->{type} =~ /^letter$/) ? (
86       opthash('letter',              $form->{PD}{letter},              $locale->text('Letter')),
87     ) : undef;
88
89   push @SENDMODE,
90     opthash("attachment",            $form->{SM}{attachment},          $locale->text('Attachment')),
91     opthash("inline",                $form->{SM}{inline},              $locale->text('In-line'))
92       if ($form->{media} eq 'email');
93
94   my $printable_templates = any { $::lx_office_conf{print_templates}->{$_} } qw(latex opendocument);
95   push @MEDIA, grep $_,
96       opthash("screen",              $form->{OP}{screen},              $locale->text('Screen')),
97     ($printable_templates && $form->{printers} && scalar @{ $form->{printers} }) ?
98       opthash("printer",             $form->{OP}{printer},             $locale->text('Printer')) : undef,
99     ($printable_templates && !$options->{no_queue}) ?
100       opthash("queue",               $form->{OP}{queue},               $locale->text('Queue')) : undef
101         if ($form->{media} ne 'email');
102
103   push @FORMAT, grep $_,
104     ($::lx_office_conf{print_templates}->{opendocument} &&     $::lx_office_conf{applications}->{openofficeorg_writer}  &&     $::lx_office_conf{applications}->{xvfb}
105                                                         && (-x $::lx_office_conf{applications}->{openofficeorg_writer}) && (-x $::lx_office_conf{applications}->{xvfb})
106      && !$options->{no_opendocument_pdf}) ?
107       opthash("opendocument_pdf",    $form->{DF}{"opendocument_pdf"},  $locale->text("PDF (OpenDocument/OASIS)")) : undef,
108     ($::lx_office_conf{print_templates}->{latex}) ?
109       opthash("pdf",                 $form->{DF}{pdf},                 $locale->text('PDF')) : undef,
110     ($::lx_office_conf{print_templates}->{latex} && !$options->{no_postscript}) ?
111       opthash("postscript",          $form->{DF}{postscript},          $locale->text('Postscript')) : undef,
112     (!$options->{no_html}) ?
113       opthash("html", $form->{DF}{html}, "HTML") : undef,
114     ($::lx_office_conf{print_templates}->{opendocument} && !$options->{no_opendocument}) ?
115       opthash("opendocument",        $form->{DF}{opendocument},        $locale->text("OpenDocument/OASIS")) : undef,
116     ($::lx_office_conf{print_templates}->{excel} && !$options->{no_excel}) ?
117       opthash("excel",               $form->{DF}{excel},               $locale->text("Excel")) : undef;
118
119   push @LANGUAGE_ID,
120     map { opthash($_->{id}, ($_->{id} eq $form->{language_id} ? 'selected' : ''), $_->{description}) } +{}, @{ $form->{languages} }
121       if (ref $form->{languages} eq 'ARRAY');
122
123   push @PRINTER_ID,
124     map { opthash($_->{id}, ($_->{id} eq $form->{printer_id} ? 'selected' : ''), $_->{printer_description}) } +{}, @{ $form->{printers} }
125       if ((ref $form->{printers} eq 'ARRAY') && scalar @{ $form->{printers } });
126
127   @SELECTS = map {
128     sname  => $_->[1],
129     DATA   => $_->[0],
130     show   => !$options->{"hide_" . $_->[1]} && scalar @{ $_->[0]},
131     hname  => $locale->text($_->[2])
132   },
133   [ \@FORMNAME,    'formname',    'Formname' ],
134   [ \@LANGUAGE_ID, 'language_id', 'Language' ],
135   [ \@FORMAT,      'format',      'Format'   ],
136   [ \@SENDMODE,    'sendmode',    'Sendmode' ],
137   [ \@MEDIA,       'media',       'Media'    ],
138   [ \@PRINTER_ID,  'printer_id',  'Printer'  ];
139
140   my %dont_display_groupitems = (
141     'dunning' => 1,
142     );
143
144   my %template_vars = (
145     name_prefix          => $prefix || '',
146     show_headers         => $options->{show_headers},
147     display_copies       => scalar @{ $form->{printers} || [] } && $::lx_office_conf{print_templates}->{latex} && $form->{media} ne 'email',
148     display_remove_draft => (!$form->{id} && $form->{draft_id}),
149     display_groupitems   => !$dont_display_groupitems{$form->{type}},
150     display_bothsided    => $options->{show_bothsided},
151     groupitems_checked   => $form->{groupitems} ? "checked" : '',
152     bothsided_checked    => $form->{bothsided}  ? "checked" : '',
153     remove_draft_checked => $form->{remove_draft} ? "checked" : ''
154   );
155
156   return $form->parse_html_template("generic/print_options", { SELECTS  => \@SELECTS, %template_vars } );
157 }
158
159 1;
160
161 __END__
162
163 =pod
164
165 =encoding utf8
166
167 =head1 NAME
168
169 SL::Helper::PrintOptions - A helper for generating the print options for
170 templates
171
172 =head1 SYNOPSIS
173
174   # render your template with print_options
175   $self->render('letter/edit',
176     %params,
177     letter        => $letter,
178     print_options => SL::Helper::PrintOptions->get_print_options (
179       options => { no_postscript   => 1,
180                    no_opendocument => 1,
181                    no_html         => 1,
182                    no_queue        => 1 }),
183
184   );
185
186 Then, in the template, you can render the options with
187     C<[% print_options %]>. Look at the template
188     C<generic/print_options> to see, which variables you get back.
189
190 =head1 FUNCTIONS
191
192 =over 4
193
194 =item C<get_print_options %params>
195
196 Parses the template C<generic/print_options>. It does some guessings
197     and settings according to the params, (namely C<form>).
198
199
200 The recognized parameters are:
201
202 =over 2
203
204 =item * C<form>: defaults to $::form if not given. There are several
205     keys in C<form> which control the output of the options,
206     e.g. C<format>, C<media>, C<copies>, C<printers>, C<printer_id>,
207     C<type>, C<formname>, ...
208
209 =item * C<myconfig>: defaults to %::myconfig
210
211 =item * C<locale>: defaults to $::locale
212
213 =item * C<options>: Options can be:
214
215 * C<dialog_name_prefix>: a string prefixed to the template
216     variables. E.g. if prefix is C<mypref_> the value for copies
217     returned from the user is in $::form->{mypref_copies}
218
219 * C<show_header>: render headings for the input elements
220
221 * C<no_queue>: if set, do not show option for printing to queue
222
223 * C<no_opendocument>: if set, do not show option for printing
224     opendocument format
225
226 * C<no_postscript>: if set, do not show option for printing
227     postscript format
228
229 * C<no_html>: if set, do not show option for printing
230     html format
231
232 * C<no_opendocument_pdf>
233
234 * C<no_excel>
235
236 * and some more
237
238 =back
239
240 =back
241
242 =head1 AUTHOR
243
244 ?
245
246 Bernd Bleßmann E<lt>bernd@kivitendo-premium.deE<gt> (I just moved
247     it from io.pl to here and did some minor changes)
248
249 =head1 BUGS
250
251 incomplete documentation
252
253 =cut