Merge branch 'master' of github.com:kivitendo/kivitendo-erp
[kivitendo-erp.git] / SL / Common.pm
index 8bc0d14..e63b698 100644 (file)
@@ -8,38 +8,37 @@
 
 package Common;
 
+use utf8;
+use strict;
+
+use Carp;
 use Time::HiRes qw(gettimeofday);
+use Data::Dumper;
 
 use SL::DBUtils;
 
-use vars qw(@db_encodings %db_encoding_to_charset);
-
-@db_encodings = (
-  { "label" => "ASCII",          "dbencoding" => "SQL_ASCII", "charset" => "ASCII" },
-  { "label" => "UTF-8 Unicode",  "dbencoding" => "UNICODE",   "charset" => "UTF-8" },
-  { "label" => "ISO 8859-1",     "dbencoding" => "LATIN1",    "charset" => "ISO-8859-1" },
-  { "label" => "ISO 8859-2",     "dbencoding" => "LATIN2",    "charset" => "ISO-8859-2" },
-  { "label" => "ISO 8859-3",     "dbencoding" => "LATIN3",    "charset" => "ISO-8859-3" },
-  { "label" => "ISO 8859-4",     "dbencoding" => "LATIN4",    "charset" => "ISO-8859-4" },
-  { "label" => "ISO 8859-5",     "dbencoding" => "LATIN5",    "charset" => "ISO-8859-5" },
-  { "label" => "ISO 8859-15",    "dbencoding" => "LATIN9",    "charset" => "ISO-8859-15" },
-  { "label" => "KOI8-R",         "dbencoding" => "KOI8",      "charset" => "KOI8-R" },
-  { "label" => "Windows CP1251", "dbencoding" => "WIN",       "charset" => "CP1251" },
-  { "label" => "Windows CP866",  "dbencoding" => "ALT",       "charset" => "CP866" },
-);
-
-%db_encoding_to_charset = map { $_->{dbencoding}, $_->{charset} } @db_encodings;
-%charset_to_db_encoding = map { $_->{charset}, $_->{dbencoding} } @db_encodings;
-
-use constant DEFAULT_CHARSET => 'ISO-8859-15';
-
 sub unique_id {
   my ($a, $b) = gettimeofday();
   return "${a}-${b}-${$}";
 }
 
 sub tmpname {
-  return "/tmp/lx-office-tmp-" . unique_id();
+  return "/tmp/kivitendo-tmp-" . unique_id();
+}
+
+sub truncate {
+  my ($text, %params) = @_;
+
+  $params{at}       //= 50;
+  $params{at}         =  3 if 3 > $params{at};
+
+  $params{strip}    //= '';
+
+  $text =~ s/[\r\n]+$//g if $params{strip} =~ m/^(?: 1 | newlines? | full )$/x;
+  $text =~ s/[\r\n]+/ /g if $params{strip} =~ m/^(?:     newlines? | full )$/x;
+
+  return $text if length($text) <= $params{at};
+  return substr($text, 0, $params{at} - 3) . '...';
 }
 
 sub retrieve_parts {
@@ -51,7 +50,7 @@ sub retrieve_parts {
 
   my (@filter_values, $filter);
 
-  foreach (qw(partnumber description)) {
+  foreach (qw(partnumber description ean)) {
     next unless $form->{$_};
 
     $filter .= qq| AND ($_ ILIKE ?)|;
@@ -59,11 +58,14 @@ sub retrieve_parts {
   }
 
   if ($form->{no_assemblies}) {
-    $filter .= qq| AND (NOT COALESCE(assembly, 'f'))|;
+    $filter .= qq| AND (NOT COALESCE(assembly, FALSE))|;
+  }
+  if ($form->{assemblies}) {
+    $filter .= qq| AND assembly=TRUE|;
   }
 
   if ($form->{no_services}) {
-    $filter .= qq| AND (COALESCE(inventory_accno_id, 0) > 0)|;
+    $filter .= qq| AND (inventory_accno_id is not NULL or assembly=TRUE)|;
   }
 
   substr($filter, 1, 3) = "WHERE" if ($filter);
@@ -72,7 +74,8 @@ sub retrieve_parts {
   $order_dir = $order_dir ? "ASC" : "DESC";
 
   my $query =
-    qq|SELECT id, partnumber, description | .
+    qq|SELECT id, partnumber, description, ean, | .
+    qq|       warehouse_id, bin_id | .
     qq|FROM parts $filter | .
     qq|ORDER BY $order_by $order_dir|;
   my $sth = $dbh->prepare($query);
@@ -191,7 +194,7 @@ sub retrieve_customers_or_vendors {
     push(@queries, qq|SELECT
                         c.id, c.name, 0 AS customer_is_vendor,
                         c.street, c.zipcode, c.city,
-                        ct.cp_greeting, ct.cp_title, ct.cp_givenname, ct.cp_name
+                        ct.cp_gender, ct.cp_title, ct.cp_givenname, ct.cp_name
                       FROM customer c
                       LEFT JOIN contacts ct ON (c.id = ct.cp_cv_id)
                       $c_filter|);
@@ -204,7 +207,7 @@ sub retrieve_customers_or_vendors {
     push(@queries, qq|SELECT
                         v.id, v.name, 1 AS customer_is_vendor,
                         v.street, v.zipcode, v.city,
-                        ct.cp_greeting, ct.cp_title, ct.cp_givenname, ct.cp_name
+                        ct.cp_gender, ct.cp_title, ct.cp_givenname, ct.cp_name
                       FROM vendor v
                       LEFT JOIN contacts ct ON (v.id = ct.cp_cv_id)
                       $v_filter|);
@@ -280,8 +283,9 @@ sub retrieve_vendor {
 
   my $query =
     qq!SELECT id, name, customernumber, (street || ', ' || zipcode || city) AS address FROM customer ! .
-    qq!WHERE $filter business_id = (SELECT id FROM business WHERE description = 'Händler') ! .
+    qq!WHERE $filter business_id = (SELECT id FROM business WHERE description = ?') ! .
     qq!ORDER BY $order_by $order_dir!;
+  push @filter_values, $::locale->{iconv_utf8}->convert('Händler');
   my $sth = $dbh->prepare($query);
   $sth->execute(@filter_values) ||
     $form->dberror($query . " (" . join(", ", @filter_values) . ")");
@@ -328,7 +332,9 @@ sub webdav_folder {
   my ($form) = @_;
 
   return $main::lxdebug->leave_sub()
-    unless ($main::webdav && $form->{id});
+    unless ($::lx_office_conf{features}->{webdav} && $form->{id});
+
+  croak "No client set in \$::auth" unless $::auth->client;
 
   my ($path, $number);
 
@@ -342,6 +348,10 @@ sub webdav_folder {
     ($path, $number) = ("anfragen", $form->{quonumber});
   } elsif ($form->{type} eq "purchase_order") {
     ($path, $number) = ("lieferantenbestellungen", $form->{ordnumber});
+  } elsif ($form->{type} eq "sales_delivery_order") {
+    ($path, $number) = ("verkaufslieferscheine", $form->{donumber});
+  } elsif ($form->{type} eq "purchase_delivery_order") {
+    ($path, $number) = ("einkaufslieferscheine", $form->{donumber});
   } elsif ($form->{type} eq "credit_note") {
     ($path, $number) = ("gutschriften", $form->{invnumber});
   } elsif ($form->{vc} eq "customer") {
@@ -354,17 +364,15 @@ sub webdav_folder {
 
   $number =~ s|[/\\]|_|g;
 
-  $path = "webdav/${path}/${number}";
+  $path = "webdav/" . $::auth->client->{id} . "/${path}/${number}";
 
   if (!-d $path) {
     mkdir_with_parents($path);
 
   } else {
-    my $base_path = substr($ENV{'SCRIPT_NAME'}, 1);
+    my $base_path = $ENV{'SCRIPT_NAME'};
     $base_path =~ s|[^/]+$||;
-    $base_path =~ s|/$||;
-
-    if (opendir $dir, $path) {
+    if (opendir my $dir, $path) {
       foreach my $file (sort { lc $a cmp lc $b } readdir $dir) {
         next if (($file eq '.') || ($file eq '..'));
 
@@ -378,7 +386,7 @@ sub webdav_folder {
 
         push @{ $form->{WEBDAV} }, {
           'name' => $fname,
-          'link' => ($ENV{"HTTPS"} ? "https://" : "http://") . $ENV{'SERVER_NAME'} . "/$base_path/$file",
+          'link' => $base_path . $file,
           'type' => $is_directory ? $main::locale->text('Directory') : $main::locale->text('File'),
         };
       }
@@ -430,6 +438,9 @@ sub get_vc_details {
   $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();
 
   $main::lxdebug->leave_sub();
@@ -472,6 +483,8 @@ sub save_email_status {
   } elsif ($form->{script} eq 'ir.pl') {
     $table = 'ap';
 
+  } elsif ($form->{script} eq 'do.pl') {
+    $table = 'delivery_orders';
   }
 
   return $main::lxdebug->leave_sub() if (!$form->{id} || !$table || !$form->{formname});
@@ -485,8 +498,8 @@ sub save_email_status {
 
   $intnotes .= "\n\n" if ($intnotes);
 
-  my $cc  = $main::locale->text('Cc') . ": $form->{cc}\n"   if $form->{cc};
-  my $bcc = $main::locale->text('Bcc') . ": $form->{bcc}\n" if $form->{bcc};
+  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"
@@ -511,9 +524,27 @@ sub check_params {
   my $params = shift;
 
   foreach my $key (@_) {
-    if (!defined $params->{$key}) {
+    if ((ref $key eq '') && !defined $params->{$key}) {
       my $subroutine = (caller(1))[3];
+      $main::lxdebug->message(LXDebug->BACKTRACE_ON_ERROR, "[Common::check_params] failed, params object dumped below");
+      $main::lxdebug->message(LXDebug->BACKTRACE_ON_ERROR, Dumper($params));
       $main::form->error($main::locale->text("Missing parameter #1 in call to sub #2.", $key, $subroutine));
+
+    } elsif (ref $key eq 'ARRAY') {
+      my $found = 0;
+      foreach my $subkey (@{ $key }) {
+        if (defined $params->{$subkey}) {
+          $found = 1;
+          last;
+        }
+      }
+
+      if (!$found) {
+        my $subroutine = (caller(1))[3];
+        $main::lxdebug->message(LXDebug->BACKTRACE_ON_ERROR, "[Common::check_params] failed, params object dumped below");
+        $main::lxdebug->message(LXDebug->BACKTRACE_ON_ERROR, Dumper($params));
+        $main::form->error($main::locale->text("Missing parameter (at least one of #1) in call to sub #2.", join(', ', @{ $key }), $subroutine));
+      }
     }
   }
 }
@@ -522,11 +553,68 @@ sub check_params_x {
   my $params = shift;
 
   foreach my $key (@_) {
-    if (!exists $params->{$key}) {
+    if ((ref $key eq '') && !exists $params->{$key}) {
       my $subroutine = (caller(1))[3];
       $main::form->error($main::locale->text("Missing parameter #1 in call to sub #2.", $key, $subroutine));
+
+    } elsif (ref $key eq 'ARRAY') {
+      my $found = 0;
+      foreach my $subkey (@{ $key }) {
+        if (exists $params->{$subkey}) {
+          $found = 1;
+          last;
+        }
+      }
+
+      if (!$found) {
+        my $subroutine = (caller(1))[3];
+        $main::form->error($main::locale->text("Missing parameter (at least one of #1) in call to sub #2.", join(', ', @{ $key }), $subroutine));
+      }
     }
   }
 }
 
 1;
+__END__
+
+=pod
+
+=encoding utf8
+
+=head1 NAME
+
+Common - Common routines used in a lot of places.
+
+=head1 SYNOPSIS
+
+  my $short_text = Common::truncate($long_text, at => 10);
+
+=head1 FUNCTIONS
+
+=over 4
+
+=item C<truncate $text, %params>
+
+Truncates C<$text> at a position and insert an ellipsis if the text is
+longer. The maximum number of characters to return is given with the
+paramter C<at> which defaults to 50.
+
+The optional parameter C<strip> can be used to remove unwanted line
+feed/carriage return characters from the text before truncation. It
+can be set to C<1> (only strip those at the end of C<$text>) or
+C<full> (replace consecutive line feed/carriage return characters in
+the middle by a single space and remove tailing line feed/carriage
+return characters).
+
+=back
+
+=head1 BUGS
+
+Nothing here yet.
+
+=head1 AUTHOR
+
+Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>,
+Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>
+
+=cut