epic-ts
[kivitendo-erp.git] / SL / Common.pm
index c0be296..126a30e 100644 (file)
@@ -12,13 +12,20 @@ use utf8;
 use strict;
 
 use Carp;
+use English qw(-no_match_vars);
 use Time::HiRes qw(gettimeofday);
 use Data::Dumper;
-use File::Copy;
+use File::Copy ();
 use File::stat;
 use File::Slurp;
+use File::Spec;
+use List::MoreUtils qw(apply);
+use POSIX ();
+use Encode qw(decode);
 
 use SL::DBUtils;
+use SL::DB;
+use SL::HTML::Util;
 
 sub unique_id {
   my ($a, $b) = gettimeofday();
@@ -49,7 +56,7 @@ sub retrieve_parts {
 
   my ($self, $myconfig, $form, $order_by, $order_dir) = @_;
 
-  my $dbh = $form->dbconnect($myconfig);
+  my $dbh = SL::DB->client->dbh;
 
   my (@filter_values, $filter);
 
@@ -57,18 +64,18 @@ sub retrieve_parts {
     next unless $form->{$_};
 
     $filter .= qq| AND ($_ ILIKE ?)|;
-    push @filter_values, '%' . $form->{$_} . '%';
+    push @filter_values, like($form->{$_});
   }
 
   if ($form->{no_assemblies}) {
-    $filter .= qq| AND (NOT COALESCE(assembly, FALSE))|;
+    $filter .= qq| AND (NOT part_type = 'assembly')|;
   }
   if ($form->{assemblies}) {
-    $filter .= qq| AND assembly=TRUE|;
+    $filter .= qq| AND part_type = 'assembly'|;
   }
 
   if ($form->{no_services}) {
-    $filter .= qq| AND (inventory_accno_id is not NULL or assembly=TRUE)|;
+    $filter .= qq| AND NOT (part_type = 'service' OR part_type = 'assembly')|;
   }
 
   substr($filter, 1, 3) = "WHERE" if ($filter);
@@ -88,98 +95,23 @@ sub retrieve_parts {
     push(@{$parts}, $ref);
   }
   $sth->finish();
-  $dbh->disconnect();
 
   $main::lxdebug->leave_sub();
 
   return $parts;
 }
 
-sub retrieve_projects {
-  $main::lxdebug->enter_sub();
-
-  my ($self, $myconfig, $form, $order_by, $order_dir) = @_;
-
-  my $dbh = $form->dbconnect($myconfig);
-
-  my (@filter_values, $filter);
-  if ($form->{"projectnumber"}) {
-    $filter .= qq| AND (projectnumber ILIKE ?)|;
-    push(@filter_values, '%' . $form->{"projectnumber"} . '%');
-  }
-  if ($form->{"description"}) {
-    $filter .= qq| AND (description ILIKE ?)|;
-    push(@filter_values, '%' . $form->{"description"} . '%');
-  }
-  substr($filter, 1, 3) = "WHERE" if ($filter);
-
-  $order_by =~ s/[^a-zA-Z_]//g;
-  $order_dir = $order_dir ? "ASC" : "DESC";
-
-  my $query =
-    qq|SELECT id, projectnumber, description | .
-    qq|FROM project $filter | .
-    qq|ORDER BY $order_by $order_dir|;
-  my $sth = $dbh->prepare($query);
-  $sth->execute(@filter_values) || $form->dberror($query . " (" . join(", ", @filter_values) . ")");
-  my $projects = [];
-  while (my $ref = $sth->fetchrow_hashref()) {
-    push(@{$projects}, $ref);
-  }
-  $sth->finish();
-  $dbh->disconnect();
-
-  $main::lxdebug->leave_sub();
-
-  return $projects;
-}
-
-sub retrieve_employees {
-  $main::lxdebug->enter_sub();
-
-  my ($self, $myconfig, $form, $order_by, $order_dir) = @_;
-
-  my $dbh = $form->dbconnect($myconfig);
-
-  my (@filter_values, $filter);
-  if ($form->{"name"}) {
-    $filter .= qq| AND (name ILIKE ?)|;
-    push(@filter_values, '%' . $form->{"name"} . '%');
-  }
-  substr($filter, 1, 3) = "WHERE" if ($filter);
-
-  $order_by =~ s/[^a-zA-Z_]//g;
-  $order_dir = $order_dir ? "ASC" : "DESC";
-
-  my $query =
-    qq|SELECT id, name | .
-    qq|FROM employee $filter | .
-    qq|ORDER BY $order_by $order_dir|;
-  my $sth = $dbh->prepare($query);
-  $sth->execute(@filter_values) || $form->dberror($query . " (" . join(", ", @filter_values) . ")");
-  my $employees = [];
-  while (my $ref = $sth->fetchrow_hashref()) {
-    push(@{$employees}, $ref);
-  }
-  $sth->finish();
-  $dbh->disconnect();
-
-  $main::lxdebug->leave_sub();
-
-  return $employees;
-}
-
 sub retrieve_customers_or_vendors {
   $main::lxdebug->enter_sub();
 
   my ($self, $myconfig, $form, $order_by, $order_dir, $is_vendor, $allow_both) = @_;
 
-  my $dbh = $form->dbconnect($myconfig);
+  my $dbh = SL::DB->client->dbh;
 
   my (@filter_values, $filter);
   if ($form->{"name"}) {
     $filter .= " AND (TABLE.name ILIKE ?)";
-    push(@filter_values, '%' . $form->{"name"} . '%');
+    push(@filter_values, like($form->{"name"}));
   }
   if (!$form->{"obsolete"}) {
     $filter .= " AND NOT TABLE.obsolete";
@@ -225,7 +157,6 @@ sub retrieve_customers_or_vendors {
     push(@{$customers}, $ref);
   }
   $sth->finish();
-  $dbh->disconnect();
 
   $main::lxdebug->leave_sub();
 
@@ -237,12 +168,12 @@ sub retrieve_delivery_customer {
 
   my ($self, $myconfig, $form, $order_by, $order_dir) = @_;
 
-  my $dbh = $form->dbconnect($myconfig);
+  my $dbh = SL::DB->client->dbh;
 
   my (@filter_values, $filter);
   if ($form->{"name"}) {
     $filter .= qq| (name ILIKE ?) AND|;
-    push(@filter_values, '%' . $form->{"name"} . '%');
+    push(@filter_values, like($form->{"name"}));
   }
 
   $order_by =~ s/[^a-zA-Z_]//g;
@@ -261,7 +192,6 @@ sub retrieve_delivery_customer {
     push(@{$delivery_customers}, $ref);
   }
   $sth->finish();
-  $dbh->disconnect();
 
   $main::lxdebug->leave_sub();
 
@@ -273,12 +203,12 @@ sub retrieve_vendor {
 
   my ($self, $myconfig, $form, $order_by, $order_dir) = @_;
 
-  my $dbh = $form->dbconnect($myconfig);
+  my $dbh = SL::DB->client->dbh;
 
   my (@filter_values, $filter);
   if ($form->{"name"}) {
     $filter .= qq| (name ILIKE ?) AND|;
-    push(@filter_values, '%' . $form->{"name"} . '%');
+    push(@filter_values, like($form->{"name"}));
   }
 
   $order_by =~ s/[^a-zA-Z_]//g;
@@ -297,7 +227,6 @@ sub retrieve_vendor {
     push(@{$vendors}, $ref);
   }
   $sth->finish();
-  $dbh->disconnect();
 
   $main::lxdebug->leave_sub();
 
@@ -351,7 +280,7 @@ sub webdav_folder {
     my $base_path = $ENV{'SCRIPT_NAME'};
     $base_path =~ s|[^/]+$||;
     if (opendir my $dir, $path) {
-      foreach my $file (sort { lc $a cmp lc $b } readdir $dir) {
+      foreach my $file (sort { lc $a cmp lc $b } map { decode("UTF-8", $_) } readdir $dir) {
         next if (($file eq '.') || ($file eq '..'));
 
         my $fname = $file;
@@ -383,7 +312,7 @@ sub get_vc_details {
 
   $vc = $vc eq "customer" ? "customer" : "vendor";
 
-  my $dbh = $form->dbconnect($myconfig);
+  my $dbh = SL::DB->client->dbh;
 
   my $query;
 
@@ -392,16 +321,17 @@ sub get_vc_details {
          vc.*,
          pt.description AS payment_terms,
          b.description AS business,
-         l.description AS language
+         l.description AS language,
+         dt.description AS delivery_terms
        FROM ${vc} vc
        LEFT JOIN payment_terms pt ON (vc.payment_id = pt.id)
        LEFT JOIN business b ON (vc.business_id = b.id)
        LEFT JOIN language l ON (vc.language_id = l.id)
+       LEFT JOIN delivery_terms dt ON (vc.delivery_term_id = dt.id)
        WHERE vc.id = ?|;
   my $ref = selectfirst_hashref_query($form, $dbh, $query, $vc_id);
 
   if (!$ref) {
-    $dbh->disconnect();
     $main::lxdebug->leave_sub();
     return 0;
   }
@@ -413,13 +343,16 @@ sub get_vc_details {
   $query = qq|SELECT * FROM shipto WHERE (trans_id = ?)|;
   $form->{SHIPTO} = selectall_hashref_query($form, $dbh, $query, $vc_id);
 
+  if ($vc eq 'customer') {
+    $query = qq|SELECT * FROM additional_billing_addresses WHERE (customer_id = ?)|;
+    $form->{ADDITIONAL_BILLING_ADDRESSES} = selectall_hashref_query($form, $dbh, $query, $vc_id);
+  }
+
   $query = qq|SELECT * FROM contacts WHERE (cp_cv_id = ?)|;
   $form->{CONTACTS} = selectall_hashref_query($form, $dbh, $query, $vc_id);
 
   # Only show default pricegroup for customer, not vendor, which is why this is outside the main query
-  ($form->{pricegroup}) = selectrow_query($form, $dbh, qq|SELECT pricegroup FROM pricegroup WHERE id = ?|, $form->{klass});
-
-  $dbh->disconnect();
+  ($form->{pricegroup}) = selectrow_query($form, $dbh, qq|SELECT pricegroup FROM pricegroup WHERE id = ?|, $form->{pricegroup_id});
 
   $main::lxdebug->leave_sub();
 
@@ -433,14 +366,19 @@ sub get_shipto_by_id {
 
   $prefix ||= "";
 
-  my $dbh = $form->dbconnect($myconfig);
+  my $dbh = SL::DB->client->dbh;
 
   my $query = qq|SELECT * FROM shipto WHERE shipto_id = ?|;
   my $ref   = selectfirst_hashref_query($form, $dbh, $query, $shipto_id);
 
   map { $form->{"${prefix}${_}"} = $ref->{$_} } keys %{ $ref } if $ref;
 
-  $dbh->disconnect();
+  my $cvars = CVar->get_custom_variables(
+    dbh      => $dbh,
+    module   => 'ShipTo',
+    trans_id => $shipto_id,
+  );
+  $form->{"${prefix}shiptocvar_$_->{name}"} = $_->{value} for @{ $cvars };
 
   $main::lxdebug->leave_sub();
 }
@@ -450,6 +388,8 @@ sub save_email_status {
 
   my ($self, $myconfig, $form) = @_;
 
+  return unless ($::instance_conf->get_email_journal);
+
   my ($table, $query, $dbh);
 
   if ($form->{script} eq 'oe.pl') {
@@ -467,33 +407,34 @@ sub save_email_status {
 
   return $main::lxdebug->leave_sub() if (!$form->{id} || !$table || !$form->{formname});
 
-  $dbh = $form->get_standard_dbh($myconfig);
+  SL::DB->client->with_transaction(sub {
+    $dbh = SL::DB->client->dbh;
 
-  my ($intnotes) = selectrow_query($form, $dbh, qq|SELECT intnotes FROM $table WHERE id = ?|, $form->{id});
+    my ($intnotes) = selectrow_query($form, $dbh, qq|SELECT intnotes FROM $table WHERE id = ?|, $form->{id});
 
-  $intnotes =~ s|\r||g;
-  $intnotes =~ s|\n$||;
+    $intnotes =~ s|\r||g;
+    $intnotes =~ s|\n$||;
 
-  $intnotes .= "\n\n" if ($intnotes);
+    $intnotes .= "\n\n" if ($intnotes);
 
-  my $cc  = $form->{cc}  ? $main::locale->text('Cc') . ": $form->{cc}\n"   : '';
-  my $bcc = $form->{bcc} ? $main::locale->text('Bcc') . ": $form->{bcc}\n" : '';
-  my $now = scalar localtime;
+    my $cc  = $form->{cc}  ? $main::locale->text('Cc') . ": $form->{cc}\n"   : '';
+    my $bcc = $form->{bcc} ? $main::locale->text('Bcc') . ": $form->{bcc}\n" : '';
+    my $now = scalar localtime;
 
-  $intnotes .= $main::locale->text('[email]') . "\n"
-    . $main::locale->text('Date') . ": $now\n"
-    . $main::locale->text('To (email)') . ": $form->{email}\n"
-    . "${cc}${bcc}"
-    . $main::locale->text('Subject') . ": $form->{subject}\n\n"
-    . $main::locale->text('Message') . ": $form->{message}";
+    $intnotes .= $main::locale->text('[email]') . "\n"
+      . $main::locale->text('Date') . ": $now\n"
+      . $main::locale->text('To (email)') . ": $form->{email}\n"
+      . "${cc}${bcc}"
+      . $main::locale->text('Subject') . ": $form->{subject}\n\n"
+      . $main::locale->text('Message') . ": " . SL::HTML::Util->strip($form->{message});
 
-  $intnotes =~ s|\r||g;
+    $intnotes =~ s|\r||g;
 
-  do_query($form, $dbh, qq|UPDATE $table SET intnotes = ? WHERE id = ?|, $intnotes, $form->{id});
+    do_query($form, $dbh, qq|UPDATE $table SET intnotes = ? WHERE id = ?|, $intnotes, $form->{id});
 
-  $form->save_status($dbh);
-
-  $dbh->commit();
+    $form->save_status($dbh);
+    1;
+  }) or do { die SL::DB->client->error };
 
   $main::lxdebug->leave_sub();
 }
@@ -576,6 +517,8 @@ sub get_webdav_folder {
     ($path, $number) = ("einkaufslieferscheine", $form->{donumber});
   } elsif ($form->{type} eq "credit_note") {
     ($path, $number) = ("gutschriften", $form->{invnumber});
+  } elsif ($form->{type} eq "letter") {
+    ($path, $number) = ("briefe", $form->{letternumber} );
   } elsif ($form->{vc} eq "customer") {
     ($path, $number) = ("rechnungen", $form->{invnumber});
   } elsif ($form->{vc} eq "vendor") {
@@ -603,20 +546,35 @@ sub copy_file_to_webdav_folder {
   # checks
   foreach my $item (qw(tmpdir tmpfile type)){
     next if $form->{$item};
-    $::lxdebug->message(LXDebug::WARN(), 'Missing parameter');
-    $::form->error($::locale->text("Missing parameter for webdav file copy"));
+    $::lxdebug->message(LXDebug::WARN(), 'Missing parameter:' . $item);
+    $::lxdebug->leave_sub();
+    return $::locale->text("Missing parameter for WebDAV file copy");
   }
 
   my ($webdav_folder, $document_name) =  get_webdav_folder($form);
 
   if (! $webdav_folder){
+    $::lxdebug->message(LXDebug::WARN(), 'Cannot check correct WebDAV folder');
     $::lxdebug->leave_sub();
-    $::form->error($::locale->text("Cannot check correct webdav folder"));
-    return undef;
+    return $::locale->text("Cannot check correct WebDAV folder")
   }
 
-  $complete_path =  join('/', $form->{cwd},  $webdav_folder);
-  opendir my $dh, $complete_path or die "Could not open $complete_path: $!";
+  $complete_path =  File::Spec->catfile($form->{cwd},  $webdav_folder);
+
+  # maybe the path does not exist (automatic printing), see #2446
+  if (!-d $complete_path) {
+    # we need a chdir and restore old dir
+    my $current_dir = POSIX::getcwd();
+    chdir("$form->{cwd}");
+    mkdir_with_parents($webdav_folder);
+    chdir($current_dir);
+  }
+
+  my $dh;
+  if (!opendir $dh, $complete_path) {
+    $::lxdebug->leave_sub();
+    return "Could not open $complete_path: $!";
+  }
 
   my ($newest_name, $newest_time);
   while ( defined( my $file = readdir( $dh ) ) ) {
@@ -627,11 +585,10 @@ sub copy_file_to_webdav_folder {
 
   closedir $dh;
 
-  $latest_file_name    = $complete_path .'/' . $newest_name;
+  $latest_file_name    = File::Spec->catfile($complete_path, $newest_name);
   my $filesize         = stat($latest_file_name)->size;
 
-  my ($ext)            = $form->{tmpfile} =~ /(\.[^.]+)$/;
-  my $current_file     = join('/', $form->{tmpdir}, $form->{tmpfile});
+  my $current_file     = File::Spec->catfile($form->{tmpdir}, apply { s:.*/:: } $form->{tmpfile});
   my $current_filesize = -f $current_file ? stat($current_file)->size : 0;
 
   if ($current_filesize == $filesize) {
@@ -639,28 +596,24 @@ sub copy_file_to_webdav_folder {
     return;
   }
 
-  my $timestamp  =  get_current_formatted_time();
-  my $myfilename =  $form->generate_attachment_filename();
-  $myfilename    =~ s/\./$timestamp\./;
+  $form->{attachment_filename} ||= $form->generate_attachment_filename;
+
+  my $timestamp =  get_current_formatted_time();
+  my $new_file  =  File::Spec->catfile($form->{cwd}, $webdav_folder, $form->{attachment_filename});
+  $new_file =~ s{(.*)\.}{$1$timestamp\.};
 
-  if (!copy(join('/', $form->{tmpdir}, $form->{tmpfile}), join('/', $form->{cwd}, $webdav_folder, $myfilename))) {
-    my $from = join('/', $form->{tmpdir}, $form->{tmpfile});
-    my $to   = join('/', $form->{cwd},    $webdav_folder);
-    $::lxdebug->message(LXDebug::WARN(), "Copy file from $from to $to failed");
-    $::form->error($::locale->text("Copy file from #1 to #2 failed", $from, $to));
+  if (!File::Copy::copy($current_file, $new_file)) {
+    $::lxdebug->message(LXDebug::WARN(), "Copy file from $current_file to $new_file failed: $ERRNO");
+    $::lxdebug->leave_sub();
+    return $::locale->text("Copy file from #1 to #2 failed: #3", $current_file, $new_file, $ERRNO);
   }
 
+  return;
   $::lxdebug->leave_sub();
 }
-sub get_current_formatted_time {
-  $main::lxdebug->enter_sub();
-
-  my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst)=localtime(time);
-  my $formatted_current_time = sprintf ( "_%04d%02d%02d_%02d%02d%02d",
-                                   $year+1900,$mon+1,$mday,$hour,$min,$sec);
 
-  $main::lxdebug->leave_sub();
-  return $formatted_current_time;
+sub get_current_formatted_time {
+  return POSIX::strftime('_%Y%m%d_%H%M%S', localtime());
 }
 
 1;
@@ -695,6 +648,11 @@ C<full> (replace consecutive line feed/carriage return characters in
 the middle by a single space and remove tailing line feed/carriage
 return characters).
 
+=item C<save_email_status>
+
+Adds sending information to internal notes.
+Does nothing if the client config email_journal is enabled.
+
 =back
 
 =head1 BUGS