Merge branch 'f-customer-vendor-rights'
[kivitendo-erp.git] / bin / mozilla / ct.pl
1 #=====================================================================
2 # LX-Office ERP
3 # Copyright (C) 2004
4 # Based on SQL-Ledger Version 2.1.9
5 # Web http://www.lx-office.org
6 #
7 #=====================================================================
8 # SQL-Ledger Accounting
9 # Copyright (c) 1998-2002
10 #
11 #  Author: Dieter Simader
12 #   Email: dsimader@sql-ledger.org
13 #     Web: http://www.sql-ledger.org
14 #
15 #  Contributors: Reed White <alta@alta-research.com>
16 #
17 # This program is free software; you can redistribute it and/or modify
18 # it under the terms of the GNU General Public License as published by
19 # the Free Software Foundation; either version 2 of the License, or
20 # (at your option) any later version.
21 #
22 # This program is distributed in the hope that it will be useful,
23 # but WITHOUT ANY WARRANTY; without even the implied warranty of
24 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25 # GNU General Public License for more details.
26 # You should have received a copy of the GNU General Public License
27 # along with this program; if not, write to the Free Software
28 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
29 # MA 02110-1335, USA.
30 #======================================================================
31 #
32 # customer/vendor module
33 #
34 #======================================================================
35
36 # $locale->text('Customers')
37 # $locale->text('Vendors')
38 # $locale->text('Add Customer')
39 # $locale->text('Add Vendor')
40 # $locale->text('Edit Customer')
41 # $locale->text('Edit Vendor')
42 # $locale->text('Customer saved!')
43 # $locale->text('Vendor saved!')
44 # $locale->text('Customer deleted!')
45 # $locale->text('Cannot delete customer!')
46 # $locale->text('Vendor deleted!')
47 # $locale->text('Cannot delete vendor!')
48
49 use POSIX qw(strftime);
50
51 use SL::CT;
52 use SL::CTI;
53 use SL::CVar;
54 use SL::Request qw(flatten);
55 use SL::DB::Business;
56 use SL::DB::Default;
57 use SL::DB::DeliveryTerm;
58 use SL::ReportGenerator;
59 use SL::Locale::String qw(t8);
60 use SL::MoreCommon qw(uri_encode);
61 use SL::ZUGFeRD;
62
63 require "bin/mozilla/common.pl";
64 require "bin/mozilla/reportgenerator.pl";
65
66 use strict;
67 1;
68
69 # end of main
70
71 sub _zugferd_settings {
72   return ([ -1, $::locale->text('Use settings from client configuration') ],
73           @SL::ZUGFeRD::customer_settings);
74 }
75
76 sub search {
77   $main::lxdebug->enter_sub();
78
79   my $form     = $main::form;
80   my $locale   = $main::locale;
81
82   $form->{IS_CUSTOMER} = $form->{db} eq 'customer';
83
84   $form->get_lists("business_types" => "ALL_BUSINESS_TYPES",
85                    "salesmen"       => "ALL_SALESMEN");
86   $form->{SHOW_BUSINESS_TYPES} = scalar @{ $form->{ALL_BUSINESS_TYPES} } > 0;
87
88   $form->{CUSTOM_VARIABLES}                  = CVar->get_configs('module' => 'CT');
89   ($form->{CUSTOM_VARIABLES_FILTER_CODE},
90    $form->{CUSTOM_VARIABLES_INCLUSION_CODE}) = CVar->render_search_options('variables'      => $form->{CUSTOM_VARIABLES},
91                                                                            'include_prefix' => 'l_',
92                                                                            'include_value'  => 'Y');
93
94   $form->{title}    = $form->{IS_CUSTOMER} ? $locale->text('Customers') : $locale->text('Vendors');
95
96   $form->{ZUGFERD_SETTINGS} = [ _zugferd_settings() ];
97
98   setup_ct_search_action_bar();
99
100   $form->header();
101   print $form->parse_html_template('ct/search');
102
103   $main::lxdebug->leave_sub();
104 }
105
106 sub search_contact {
107   $::lxdebug->enter_sub;
108
109   $::form->{CUSTOM_VARIABLES}                  = CVar->get_configs('module' => 'Contacts');
110   ($::form->{CUSTOM_VARIABLES_FILTER_CODE},
111    $::form->{CUSTOM_VARIABLES_INCLUSION_CODE}) = CVar->render_search_options('variables'    => $::form->{CUSTOM_VARIABLES},
112                                                                            'include_prefix' => 'l.',
113                                                                            'filter_prefix'  => 'filter.',
114                                                                            'include_value'  => 'Y');
115
116   $::form->{title} = $::locale->text('Search contacts');
117
118   setup_ct_search_contact_action_bar();
119   $::form->header;
120   print $::form->parse_html_template('ct/search_contact');
121
122   $::lxdebug->leave_sub;
123 }
124
125 sub list_names {
126   $main::lxdebug->enter_sub();
127
128   my $form     = $main::form;
129   my %myconfig = %main::myconfig;
130   my $locale   = $main::locale;
131
132   $form->{IS_CUSTOMER} = $form->{db} eq 'customer';
133
134   report_generator_set_default_sort('name', 1);
135
136   CT->search(\%myconfig, \%$form);
137
138   my $cvar_configs = CVar->get_configs('module' => 'CT');
139
140   my @options;
141   if ($form->{status} eq 'all') {
142     push @options, $locale->text('All');
143   } elsif ($form->{status} eq 'orphaned') {
144     push @options, $locale->text('Orphaned');
145   }
146
147   my @zugferd_settings_list = _zugferd_settings();
148   my $zugferd_filter        = $form->{create_zugferd_invoices} eq '' ? undef : $zugferd_settings_list[$form->{create_zugferd_invoices} + 1]->[1];
149
150   push @options, $locale->text('Name') . " : $form->{name}"                                       if $form->{name};
151   push @options, $locale->text('Contact') . " : $form->{contact}"                                 if $form->{contact};
152   push @options, $locale->text('Number') . qq| : $form->{"$form->{db}number"}|                    if $form->{"$form->{db}number"};
153   push @options, $locale->text('E-mail') . " : $form->{email}"                                    if $form->{email};
154   push @options, $locale->text('Contact person (surname)')           . " : $form->{cp_name}"      if $form->{cp_name};
155   push @options, $locale->text('Billing/shipping address (city)')    . " : $form->{addr_city}"    if $form->{addr_city};
156   push @options, $locale->text('Billing/shipping address (zipcode)') . " : $form->{addr_zipcode}" if $form->{addr_zipcode};
157   push @options, $locale->text('Billing/shipping address (street)')  . " : $form->{addr_street}"  if $form->{addr_street};
158   push @options, $locale->text('Billing/shipping address (country)') . " : $form->{addr_country}" if $form->{addr_country};
159   push @options, $locale->text('Billing/shipping address (GLN)')     . " : $form->{addr_gln}"     if $form->{addr_gln};
160   push @options, $locale->text('Quick Search')                       . " : $form->{all}"          if $form->{all};
161   push @options, $locale->text('Factur-X/ZUGFeRD settings')          . " : $zugferd_filter"       if $zugferd_filter;
162
163   if ($form->{business_id}) {
164     my $business = SL::DB::Manager::Business->find_by(id => $form->{business_id});
165     if ($business) {
166       my $label = $form->{IS_CUSTOMER} ? $::locale->text('Customer type') : $::locale->text('Vendor type');
167       push @options, $label . " : " . $business->description;
168     }
169   }
170   if ($form->{salesman_id}) {
171     my $salesman = SL::DB::Manager::Employee->find_by(id => $form->{salesman_id});
172     if ($salesman) {
173       push @options, $locale->text('Salesman') . " : " . $salesman->name;
174     }
175   }
176
177   if ( $form->{insertdatefrom} or $form->{insertdateto} ) {
178     push @options, $locale->text('Insert Date');
179     push @options, $locale->text('From') . " " . $locale->date(\%myconfig, $form->{insertdatefrom}, 1) if $form->{insertdatefrom};
180     push @options, $locale->text('Bis')  . " " . $locale->date(\%myconfig, $form->{insertdateto},   1) if $form->{insertdateto};
181   };
182
183   my @columns = (
184     'id',        'name',    "$form->{db}number",   'contact', 'main_contact_person',
185     'phone',    'discount',
186     'fax',       'email',   'taxnumber',           'street',    'zipcode' , 'city',
187     'business',  'payment', 'invnumber', 'ordnumber',           'quonumber', 'salesman',
188     'country',   'gln',     'insertdate',           'pricegroup', 'contact_origin', 'invoice_mail',
189     'creditlimit', 'ustid', 'commercial_court', 'delivery_order_mail'
190   );
191
192   my @includeable_custom_variables = grep { $_->{includeable} } @{ $cvar_configs };
193   my @searchable_custom_variables  = grep { $_->{searchable} }  @{ $cvar_configs };
194   my %column_defs_cvars            = map { +"cvar_$_->{name}" => { 'text' => $_->{description} } } @includeable_custom_variables;
195
196   push @columns, map { "cvar_$_->{name}" } @includeable_custom_variables;
197
198   my %column_defs = (
199     'id'                => { 'text' => $locale->text('ID'), },
200     "$form->{db}number" => { 'text' => $locale->text('Number'), },
201     'name'              => { 'text' => $form->{IS_CUSTOMER} ? $::locale->text('Customer Name') : $::locale->text('Vendor Name'), },
202     'contact'           => { 'text' => $locale->text('Contact'), },
203     'main_contact_person'  => { 'text' => $locale->text('Main Contact Person'), },
204     'phone'             => { 'text' => $locale->text('Phone'), },
205     'fax'               => { 'text' => $locale->text('Fax'), },
206     'email'             => { 'text' => $locale->text('E-mail'), },
207     'cc'                => { 'text' => $locale->text('Cc'), },
208     'taxnumber'         => { 'text' => $locale->text('Tax Number'), },
209     'business'          => { 'text' => $locale->text('Type of Business'), },
210     'invnumber'         => { 'text' => $locale->text('Invoice'), },
211     'ordnumber'         => { 'text' => $form->{IS_CUSTOMER} ? $locale->text('Sales Order') : $locale->text('Purchase Order'), },
212     'quonumber'         => { 'text' => $form->{IS_CUSTOMER} ? $locale->text('Quotation')   : $locale->text('Request for Quotation'), },
213     'street'            => { 'text' => $locale->text('Street'), },
214     'zipcode'           => { 'text' => $locale->text('Zipcode'), },
215     'city'              => { 'text' => $locale->text('City'), },
216     'country'           => { 'text' => $locale->text('Country'), },
217     'gln'               => { 'text' => $locale->text('GLN'), },
218     'salesman'          => { 'text' => $locale->text('Salesman'), },
219     'discount'          => { 'text' => $locale->text('Discount'), },
220     'payment'           => { 'text' => $locale->text('Payment Terms'), },
221     'insertdate'        => { 'text' => $locale->text('Insert Date'), },
222     'pricegroup'        => { 'text' => $locale->text('Pricegroup'), },
223     'invoice_mail'      => { 'text' => $locale->text('Email of the invoice recipient'), },
224     'delivery_order_mail' => { 'text' => $locale->text('Email of the delivery order recipient'), },
225     'contact_origin'    => { 'text' => $locale->text('Origin of personal data'), },
226     'creditlimit'       => { 'text' => $locale->text('Credit Limit'), },
227     'ustid'             => { 'text' => $locale->text('VAT ID'), },
228     'commercial_court'  => { 'text' => $locale->text('Commercial court'), },
229     create_zugferd_invoices => { text => $locale->text('Factur-X/ZUGFeRD settings'), },
230     %column_defs_cvars,
231   );
232
233   map { $column_defs{$_}->{visible} = $form->{"l_$_"} eq 'Y' } @columns;
234
235   my @hidden_variables  = ( qw(
236       db status obsolete name contact email cp_name addr_street addr_zipcode
237       addr_city addr_country addr_gln business_id salesman_id insertdateto insertdatefrom all
238     ), "$form->{db}number",
239     map({ "cvar_$_->{name}" } @searchable_custom_variables),
240     map({'cvar_'. $_->{name} .'_from'} grep({$_->{type} eq 'date'} @searchable_custom_variables)),
241     map({'cvar_'. $_->{name} .'_to'}   grep({$_->{type} eq 'date'} @searchable_custom_variables)),
242     map({'cvar_'. $_->{name} .'_qtyop'} grep({$_->{type} eq 'number'} @searchable_custom_variables)),
243     map({ "l_$_" } @columns),
244   );
245
246   my @hidden_nondefault = grep({ $form->{$_} } @hidden_variables);
247   my $callback          = build_std_url('action=list_names', grep { $form->{$_} } @hidden_nondefault);
248   $form->{callback}     = "$callback&sort=" . E($form->{sort}) . "&sortdir=" . E($form->{sortdir});
249
250   foreach (@columns) {
251     my $sortdir              = $form->{sort} eq $_ ? 1 - $form->{sortdir} : $form->{sortdir};
252     $column_defs{$_}->{link} = "${callback}&sort=${_}&sortdir=${sortdir}";
253   }
254
255   my ($ordertype, $quotationtype, $attachment_basename);
256   if ($form->{IS_CUSTOMER}) {
257     $form->{title}       = $locale->text('Customers');
258     $ordertype           = 'sales_order';
259     $quotationtype       = 'sales_quotation';
260     $attachment_basename = $locale->text('customer_list');
261
262   } else {
263     $form->{title}       = $locale->text('Vendors');
264     $ordertype           = 'purchase_order';
265     $quotationtype       = 'request_quotation';
266     $attachment_basename = $locale->text('vendor_list');
267   }
268
269   my $report = SL::ReportGenerator->new(\%myconfig, $form);
270
271   $report->set_options('top_info_text'         => join("\n", @options),
272                        'raw_bottom_info_text'  => $form->parse_html_template('ct/list_names_bottom'),
273                        'output_format'         => 'HTML',
274                        'title'                 => $form->{title},
275                        'attachment_basename'   => $attachment_basename . strftime('_%Y%m%d', localtime time),
276     );
277   $report->set_options_from_form();
278   $locale->set_numberformat_wo_thousands_separator(\%myconfig) if lc($report->{options}->{output_format}) eq 'csv';
279
280   $report->set_columns(%column_defs);
281   $report->set_column_order(@columns);
282
283   $report->set_export_options('list_names', @hidden_variables, qw(sort sortdir));
284
285   $report->set_sort_indicator($form->{sort}, $form->{sortdir});
286
287   CVar->add_custom_variables_to_report('module'         => 'CT',
288                                        'trans_id_field' => 'id',
289                                        'configs'        => $cvar_configs,
290                                        'column_defs'    => \%column_defs,
291                                        'data'           => $form->{CT});
292
293   my $previous_id;
294
295   foreach my $ref (@{ $form->{CT} }) {
296     my $row = { map { $_ => { 'data' => '' } } @columns };
297
298     if ($ref->{id} ne $previous_id) {
299       $previous_id = $ref->{id};
300       $ref->{discount} = $form->format_amount(\%myconfig, $ref->{discount} * 100.0, 2);
301       $ref->{creditlimit} = $form->format_amount(\%myconfig, $ref->{creditlimit}, 2);
302       map { $row->{$_}->{data} = $ref->{$_} } @columns;
303
304       $row->{name}->{link}  = build_std_url('script=controller.pl', 'action=CustomerVendor/edit', 'id=' . E($ref->{id}), 'callback', @hidden_nondefault);
305       $row->{email}->{link} = 'mailto:' . E($ref->{email});
306     }
307
308     my $base_url              = build_std_url("script=$ref->{module}.pl", 'action=edit', 'id=' . E($ref->{invid}), 'callback', @hidden_nondefault);
309     if ($::instance_conf->get_feature_experimental_order) {
310       if ('oe' eq $ref->{module}) {
311         $base_url             = build_std_url("script=controller.pl", 'action=Order/edit', 'id=' . E($ref->{invid}), 'callback', @hidden_nondefault);
312       }
313     }
314
315     $row->{invnumber}->{link} = $base_url;
316     $row->{ordnumber}->{link} = $base_url . "&type=${ordertype}";
317     $row->{quonumber}->{link} = $base_url . "&type=${quotationtype}";
318     my $column                = $ref->{formtype} eq 'invoice' ? 'invnumber' : $ref->{formtype} eq 'order' ? 'ordnumber' : 'quonumber';
319     $row->{$column}->{data}   = $ref->{$column};
320
321     if (my $number = SL::CTI->sanitize_number(number => $ref->{phone})) {
322       $row->{phone}->{link}       = SL::CTI->call_link(number => $number);
323       $row->{phone}->{link_class} = 'cti_call_action';
324     }
325
326     $report->add_data($row);
327   }
328
329   setup_ct_list_names_action_bar();
330   $report->generate_with_headers();
331
332   $main::lxdebug->leave_sub();
333 }
334
335 sub list_contacts {
336   $::lxdebug->enter_sub;
337
338   $::form->{sortdir} = 1 unless defined $::form->{sortdir};
339
340   my @contacts     = CT->search_contacts(
341     search_term => $::form->{search_term},
342     filter      => $::form->{filter},
343   );
344
345   my $cvar_configs = CVar->get_configs('module' => 'Contacts');
346
347   my @columns      = qw(
348     cp_id vcname vcnumber cp_name cp_givenname cp_street cp_zipcode cp_city cp_phone1 cp_phone2 cp_privatphone
349     cp_mobile1 cp_mobile2 cp_fax cp_email cp_privatemail cp_abteilung cp_position cp_birthday cp_gender
350   );
351
352   my @includeable_custom_variables = grep { $_->{includeable} } @{ $cvar_configs };
353   my @searchable_custom_variables  = grep { $_->{searchable} }  @{ $cvar_configs };
354   my %column_defs_cvars            = map { +"cvar_$_->{name}" => { 'text' => $_->{description} } } @includeable_custom_variables;
355
356   push @columns, map { "cvar_$_->{name}" } @includeable_custom_variables;
357
358   my @visible_columns;
359   if ($::form->{l}) {
360     @visible_columns = grep { $::form->{l}{$_} } @columns;
361     push @visible_columns, qw(cp_phone1 cp_phone2)   if $::form->{l}{cp_phone};
362     push @visible_columns, qw(cp_mobile1 cp_mobile2) if $::form->{l}{cp_mobile};
363   } else {
364    @visible_columns = qw(vcname vcnumber cp_name cp_givenname cp_phone1 cp_phone2 cp_mobile1 cp_email);
365   }
366
367   my %column_defs  = (
368     'cp_id'        => { 'text' => $::locale->text('ID'), },
369     'vcname'       => { 'text' => $::locale->text('Customer/Vendor'), },
370     'vcnumber'     => { 'text' => $::locale->text('Customer/Vendor Number'), },
371     'cp_name'      => { 'text' => $::locale->text('Name'), },
372     'cp_givenname' => { 'text' => $::locale->text('Given Name'), },
373     'cp_street'    => { 'text' => $::locale->text('Street'), },
374     'cp_zipcode'   => { 'text' => $::locale->text('Zipcode'), },
375     'cp_city'      => { 'text' => $::locale->text('City'), },
376     'cp_phone1'    => { 'text' => $::locale->text('Phone1'), },
377     'cp_phone2'    => { 'text' => $::locale->text('Phone2'), },
378     'cp_mobile1'   => { 'text' => $::locale->text('Mobile1'), },
379     'cp_mobile2'   => { 'text' => $::locale->text('Mobile2'), },
380     'cp_email'     => { 'text' => $::locale->text('E-mail'), },
381     'cp_abteilung' => { 'text' => $::locale->text('Department'), },
382     'cp_position'  => { 'text' => $::locale->text('Function/position'), },
383     'cp_birthday'  => { 'text' => $::locale->text('Birthday'), },
384     'cp_gender'    => { 'text' => $::locale->text('Gender'), },
385     'cp_fax'       => { 'text' => $::locale->text('Fax'), },
386     'cp_privatphone' => { 'text' => $::locale->text('Private Phone') },
387     'cp_privatemail' => { 'text' => $::locale->text('Private E-mail') },
388     %column_defs_cvars,
389   );
390
391   map { $column_defs{$_}->{visible} = 1 } @visible_columns;
392
393   my @hidden_variables  = (qw(search_term filter l));
394   my $hide_vars         = { map { $_ => $::form->{$_} } @hidden_variables };
395   my @hidden_nondefault = grep({ $::form->{$_} } @hidden_variables);
396   my $callback          = build_std_url('action=list_contacts', join '&', map { E($_->[0]) . '=' . E($_->[1]) } @{ flatten($hide_vars) });
397   $::form->{callback}     = "$callback&sort=" . E($::form->{sort});
398
399   map { $column_defs{$_}->{link} = "${callback}&sort=${_}&sortdir=" . ($::form->{sort} eq $_ ? 1 - $::form->{sortdir} : $::form->{sortdir}) } @columns;
400
401   $::form->{title} = $::locale->text('Contacts');
402
403   my $report     = SL::ReportGenerator->new(\%::myconfig, $::form);
404
405   my @options;
406   push @options, $::locale->text('Search term') . ': ' . $::form->{search_term} if $::form->{search_term};
407   for (qw(cp_name cp_givenname cp_title cp_email cp_abteilung cp_project)) {
408     push @options, $column_defs{$_}{text} . ': ' . $::form->{filter}{$_} if $::form->{filter}{$_};
409   }
410   if ($::form->{filter}{status}) {
411     push @options, $::locale->text('Status') . ': ' . (
412       $::form->{filter}{status} =~ /active/   ? $::locale->text('Active')   :
413       $::form->{filter}{status} =~ /orphaned/ ? $::locale->text('Orphaned') :
414       $::form->{filter}{status} =~ /all/      ? $::locale->text('All')      : ''
415     );
416   }
417
418
419   $report->set_options('top_info_text'       => join("\n", @options),
420                        'output_format'       => 'HTML',
421                        'title'               => $::form->{title},
422                        'attachment_basename' => $::locale->text('contact_list') . strftime('_%Y%m%d', localtime time),
423     );
424   $report->set_options_from_form;
425
426   $report->set_columns(%column_defs);
427   $report->set_column_order(@columns);
428
429   $report->set_export_options('list_contacts', @hidden_variables);
430
431   $report->set_sort_indicator($::form->{sort}, $::form->{sortdir});
432
433   CVar->add_custom_variables_to_report('module'         => 'Contacts',
434                                        'trans_id_field' => 'cp_id',
435                                        'configs'        => $cvar_configs,
436                                        'column_defs'    => \%column_defs,
437                                        'data'           => \@contacts);
438
439
440   foreach my $ref (@contacts) {
441     my $row = { map { $_ => { 'data' => $ref->{$_} } } @columns };
442
443     $row->{vcname}->{link}   = build_std_url('script=controller.pl', 'action=CustomerVendor/edit', 'id=' . E($ref->{vcid}), 'db=' . E($ref->{db}), 'callback', @hidden_nondefault);
444     $row->{vcnumber}->{link} = $row->{vcname}->{link};
445
446     for (qw(cp_email cp_privatemail)) {
447       $row->{$_}->{link} = 'mailto:' . E($ref->{$_}) if $ref->{$_};
448     }
449
450     for (qw(cp_phone1 cp_phone2 cp_mobile1)) {
451       next unless my $number = SL::CTI->sanitize_number(number => $ref->{$_});
452
453       $row->{$_}->{link}       = SL::CTI->call_link(number => $number);
454       $row->{$_}->{link_class} = 'cti_call_action';
455     }
456
457     $report->add_data($row);
458   }
459
460   $report->generate_with_headers();
461
462   $::lxdebug->leave_sub;
463 }
464
465 sub setup_ct_search_action_bar {
466   my %params = @_;
467
468   for my $bar ($::request->layout->get('actionbar')) {
469     $bar->add(
470       action => [
471         t8('Search'),
472         submit    => [ '#form', { action => 'list_names' } ],
473         accesskey => 'enter',
474       ],
475     );
476   }
477 }
478
479 sub setup_ct_list_names_action_bar {
480   my %params = @_;
481
482   for my $bar ($::request->layout->get('actionbar')) {
483     $bar->add(
484       action => [
485         t8('Add'),
486         submit    => [ '#new_form', { action => 'CustomerVendor/add' } ],
487         accesskey => 'enter',
488       ],
489     );
490   }
491 }
492
493 sub setup_ct_search_contact_action_bar {
494   my %params = @_;
495
496   for my $bar ($::request->layout->get('actionbar')) {
497     $bar->add(
498       action => [
499         t8('Search'),
500         submit    => [ '#form', { action => 'list_contacts' } ],
501         accesskey => 'enter',
502       ],
503     );
504   }
505 }
506
507 sub continue { call_sub($main::form->{nextsub}); }