Merge branch 'master' of github.com:kivitendo/kivitendo-erp
[kivitendo-erp.git] / SL / Common.pm
index 8cf4e85..dc1cc04 100644 (file)
@@ -13,7 +13,6 @@ use strict;
 
 use Time::HiRes qw(gettimeofday);
 use Data::Dumper;
-use File::Copy;
 
 use SL::DBUtils;
 
@@ -44,7 +43,22 @@ sub unique_id {
 }
 
 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 {
@@ -71,7 +85,7 @@ sub retrieve_parts {
   }
 
   if ($form->{no_services}) {
-    $filter .= qq| AND (inventory_accno_id is not NULL or assembly=TRUE)|; # @mb hier nochmal optimieren ... nach kurzer ruecksprache alles i.o.
+    $filter .= qq| AND (inventory_accno_id is not NULL or assembly=TRUE)|;
   }
 
   substr($filter, 1, 3) = "WHERE" if ($filter);
@@ -80,7 +94,8 @@ sub retrieve_parts {
   $order_dir = $order_dir ? "ASC" : "DESC";
 
   my $query =
-    qq|SELECT id, partnumber, description, ean | .
+    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);
@@ -331,10 +346,6 @@ sub mkdir_with_parents {
   $main::lxdebug->leave_sub();
 }
 
-#
-# Legt ein entsprechendes Webdav-Verzeichnis an, falls
-# Webdav als Option konfiguriert ist
-#
 sub webdav_folder {
   $main::lxdebug->enter_sub();
 
@@ -343,19 +354,42 @@ sub webdav_folder {
   return $main::lxdebug->leave_sub()
     unless ($::lx_office_conf{features}->{webdav} && $form->{id});
 
-  my $path = get_webdav_folder($form); # ausgelagert, wg. D.R.Y.
+  my ($path, $number);
 
   $form->{WEBDAV} = [];
 
-  return $main::lxdebug->leave_sub() unless ($path);
+  if ($form->{type} eq "sales_quotation") {
+    ($path, $number) = ("angebote", $form->{quonumber});
+  } elsif ($form->{type} eq "sales_order") {
+    ($path, $number) = ("bestellungen", $form->{ordnumber});
+  } elsif ($form->{type} eq "request_quotation") {
+    ($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") {
+    ($path, $number) = ("rechnungen", $form->{invnumber});
+  } else {
+    ($path, $number) = ("einkaufsrechnungen", $form->{invnumber});
+  }
+
+  return $main::lxdebug->leave_sub() unless ($path && $number);
+
+  $number =~ s|[/\\]|_|g;
+
+  $path = "webdav/${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|/$||;
     # wo kommt der wert für dir her? es wird doch gar nichts übergeben? fix für strict my $dir jb 21.2.
     if (opendir my $dir, $path) {
       foreach my $file (sort { lc $a cmp lc $b } readdir $dir) {
@@ -371,7 +405,7 @@ sub webdav_folder {
 
         push @{ $form->{WEBDAV} }, {
           'name' => $fname,
-          'link' => "$base_path/$file",
+          'link' => $base_path . $file,
           'type' => $is_directory ? $main::locale->text('Directory') : $main::locale->text('File'),
         };
       }
@@ -423,6 +457,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();
@@ -465,6 +502,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});
@@ -478,8 +517,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"
@@ -554,105 +593,47 @@ sub check_params_x {
   }
 }
 
-#
-# Diese Routine baut aus dem Masken-Typ und der
-# Beleg-Nummer, das entsprechende Webdav-Verzeichnis zusammen
-# Nimmt leider noch die ganze Form entgegen und den if-elsif-Block
-# sollte man schöner "dispatchen"
-# Ergänzung 6.5.2011, den else-Zweig defensiver gestaltet und mit
-# -1 als n.i.O. Rückgabewert versehen
-#
-sub get_webdav_folder {
-  $main::lxdebug->enter_sub();
+1;
+__END__
 
-  my ($form) = @_;
+=pod
 
-  # TODO Ergänzung um check_params
+=encoding utf8
 
-  my ($path, $number);
+=head1 NAME
 
+Common - Common routines used in a lot of places.
 
-  if ($form->{type} eq "sales_quotation") {
-    ($path, $number) = ("angebote", $form->{quonumber});
-  } elsif ($form->{type} eq "sales_order") {
-    ($path, $number) = ("bestellungen", $form->{ordnumber});
-  } elsif ($form->{type} eq "request_quotation") {
-    ($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") {
-    ($path, $number) = ("rechnungen", $form->{invnumber});
-  } elsif ($form->{vc} eq "vendor") {
-    ($path, $number) = ("einkaufsrechnungen", $form->{invnumber});
-  } else {
-    # wir befinden uns nicht in einer belegmaske
-    # scheinbar wird diese routine auch bspw. bei waren
-    # aufgerufen - naja, steuerung über Form.pm halt ...
-    $main::lxdebug->leave_sub();
-    return undef;
-  }
+=head1 SYNOPSIS
 
-  return $main::lxdebug->leave_sub() unless ($path && $number);
+  my $short_text = Common::truncate($long_text, at => 10);
 
-  $number =~ s|[/\\]|_|g;
+=head1 FUNCTIONS
 
-  $path = "webdav/${path}/${number}";
+=over 4
 
-  $main::lxdebug->leave_sub();
+=item C<truncate $text, %params>
 
-  return $path;
+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).
 
-#
-# Falls Webdav aktiviert ist, auch den generierten Beleg in das
-# Webdav-Verzeichnis kopieren
-#
-#
-sub copy_file_to_webdav_folder {
-  $main::lxdebug->enter_sub();
-  
-  my ($form) = @_;  
-  # leider die ganze form
-  # da get_webdav_folder die auch noch benötigt
-  # aber hier ein paar checks:
-  # OFFEN: check_params kann ich ja nicht eine
-  # abgespeckte $form übergeben, oder?
-  $form->{type} = ''; 
-  foreach my $item (qw(tmpdir tmpfile type)){
-    if (!$form->{$item}){  # wahr, bei undef oder ''
-      $main::lxdebug->message(0, 'Missing parameter'); 
-      $main::form->error($main::locale->text("Missing parameter for webdav file copy"));
-    }
-  }
+=back
 
-  # Den Webdav-Ordner ÜBER exakt denselben Mechanismus wie beim
-  # Anlegen bestimmen
-  # leider ist das auch das Kriterium, ob überhaupt ein "Anlegen"
-  # erlaubt ist
-  my $webdav_folder =  get_webdav_folder($form);
+=head1 BUGS
 
-  # hier auch nochmal prüfen
-  if (! $webdav_folder){
-    $main::lxdebug->leave_sub();
-    return undef; # s.o. erstmal so ...
-    $main::form->error($main::locale->text("Cannot check correct webdav folder"));
-  }
+Nothing here yet.
 
-  if(!copy(join('/', $form->{tmpdir}, $form->{tmpfile}), join('/', $form->{cwd},  $webdav_folder))){ 
-    my $j = join('/', $form->{tmpdir}, $form->{tmpfile});
-    my $k = join('/', $form->{cwd},  $webdav_folder);
-    $main::lxdebug->message(0, "Copy file from $j to $k failed");
-    $main::form->error($main::locale->text("Copy file from #1 to #2 failed", $j, $k));
-  }
+=head1 AUTHOR
 
-  $main::lxdebug->leave_sub();
-}
+Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>,
+Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>
 
-1;
+=cut