Zeiterfassung: Konvertierung: Artikel/Projekt: override- und default-Parameter

[mfinanz.git] / SL / BackgroundJob / ConvertTimeRecordings.pm

diff --git a/SL/BackgroundJob/ConvertTimeRecordings.pm b/SL/BackgroundJob/ConvertTimeRecordings.pm
index 1b2e53824608eed75ac201461b7e63d6bb1416a3..ff8c79b6137d97d8f381b3175ae91b5fb0eacad7 100644 (file)
--- a/SL/BackgroundJob/ConvertTimeRecordings.pm
+++ b/SL/BackgroundJob/ConvertTimeRecordings.pm
@@ -38,14 +38,13 @@ sub run {
   my %customer_where;
   %customer_where = ('customer_id' => $self->params->{customer_ids}) if scalar @{ $self->params->{customer_ids} };
 
   my %customer_where;
   %customer_where = ('customer_id' => $self->params->{customer_ids}) if scalar @{ $self->params->{customer_ids} };
 

-  my $time_recordings = SL::DB::Manager::TimeRecording->get_all(where        => [date => { ge_lt => [ $self->params->{from_date}, $self->params->{to_date} ]},
-                                                                                 or   => [booked => 0, booked => undef],
-                                                                                 '!duration' => 0,
-                                                                                 '!duration' => undef,
-                                                                                 %customer_where]);
+  my $time_recordings = SL::DB::Manager::TimeRecording->get_all(where => [date        => { ge_lt => [ $self->params->{from_date}, $self->params->{to_date} ]},
+                                                                          or          => [booked => 0, booked => undef],
+                                                                          '!duration' => 0,
+                                                                          '!duration' => undef,
+                                                                          %customer_where]);

 
 

-  # no time recordings at all ? -> better exit here before iterating a empty hash
-  # return undef or message unless ref $time_recordings->[0] eq SL::DB::Manager::TimeRecording;
+  return t8('No time recordings to convert') if scalar @$time_recordings == 0;

 
   my @donumbers;
 
 
   my @donumbers;
 


@@ -86,13 +85,15 @@ sub initialize_params {
 
   # valid parameters with default values
   my %valid_params = (
 
   # valid parameters with default values
   my %valid_params = (

-    from_date       => DateTime->new( day => 1,    month => DateTime->today_local->month, year => DateTime->today_local->year)->subtract(months => 1)->to_kivitendo,
-    to_date         => DateTime->last_day_of_month(month => DateTime->today_local->month, year => DateTime->today_local->year)->subtract(months => 1)->to_kivitendo,
-    customernumbers => [],
-    part_id         => undef,
-    project_id      => undef,
-    rounding        => 1,
-    link_order      => 0,
+    from_date           => DateTime->new( day => 1,    month => DateTime->today_local->month, year => DateTime->today_local->year)->subtract(months => 1)->to_kivitendo,
+    to_date             => DateTime->last_day_of_month(month => DateTime->today_local->month, year => DateTime->today_local->year)->subtract(months => 1)->to_kivitendo,
+    customernumbers     => [],
+    override_part_id    => undef,
+    default_part_id     => undef,
+    override_project_id => undef,
+    default_project_id  => undef,
+    rounding            => 1,
+    link_order          => 0,

   );
 
 
   );
 
 


@@ -101,6 +102,7 @@ sub initialize_params {
     die "Not a valid parameter: $param" unless exists $valid_params{$param};
   }
 
     die "Not a valid parameter: $param" unless exists $valid_params{$param};
   }
 

+  # set defaults

   $self->params(
     { map { ($_ => $data->{$_} // $valid_params{$_}) } keys %valid_params }
   );
   $self->params(
     { map { ($_ => $data->{$_} // $valid_params{$_}) } keys %valid_params }
   );


@@ -136,16 +138,24 @@ sub initialize_params {
 
 
   # check part
 
 
   # check part

-  if ($self->params->{part_id} && !SL::DB::Manager::Part->find_by(id => $self->params->{part_id},
-                                                                  or => [obsolete => undef, obsolete => 0])) {
-    die 'No valid part found by given part id';
+  if ($self->params->{override_part_id} && !SL::DB::Manager::Part->find_by(id => $self->params->{override_part_id},
+                                                                           or => [obsolete => undef, obsolete => 0])) {
+    die 'No valid part found by given override part id';
+  }
+  if ($self->params->{default_part_id} && !SL::DB::Manager::Part->find_by(id => $self->params->{default_part_id},
+                                                                           or => [obsolete => undef, obsolete => 0])) {
+    die 'No valid part found by given default part id';

   }
 
 
   # check project
   }
 
 
   # check project

-  if ($self->params->{project_id} && !SL::DB::Manager::Project->find_by(id => $self->params->{project_id},
-                                                                        active => 1, valid => 1)) {
-    die 'No valid project found by given project id';
+  if ($self->params->{override_project_id} && !SL::DB::Manager::Project->find_by(id => $self->params->{override_project_id},
+                                                                                 active => 1, valid => 1)) {
+    die 'No valid project found by given override project id';
+  }
+  if ($self->params->{default_project_id} && !SL::DB::Manager::Project->find_by(id => $self->params->{default_project_id},
+                                                                                active => 1, valid => 1)) {
+    die 'No valid project found by given default project id';

   }
 
   return $self->params;
   }
 
   return $self->params;


@@ -157,8 +167,11 @@ sub convert_without_linking {
   my %time_recordings_by_customer_id;
   push @{ $time_recordings_by_customer_id{$_->customer_id} }, $_ for @$time_recordings;
 
   my %time_recordings_by_customer_id;
   push @{ $time_recordings_by_customer_id{$_->customer_id} }, $_ for @$time_recordings;
 

-  my %convert_params = map { $_ => $self->params->{$_} } qw(rounding link_order project_id);
-  $convert_params{default_part_id} = $self->params->{part_id};
+  my %convert_params = (
+    rounding         => $self->params->{rounding},
+    override_part_id => $self->params->{override_part_id},
+    default_part_id  => $self->params->{default_part_id},
+  );

 
   my @donumbers;
   foreach my $customer_id (keys %time_recordings_by_customer_id) {
 
   my @donumbers;
   foreach my $customer_id (keys %time_recordings_by_customer_id) {


@@ -167,10 +180,7 @@ sub convert_without_linking {
       $do = SL::DB::DeliveryOrder->new_from_time_recordings($time_recordings_by_customer_id{$customer_id}, %convert_params);
       1;
     }) {
       $do = SL::DB::DeliveryOrder->new_from_time_recordings($time_recordings_by_customer_id{$customer_id}, %convert_params);
       1;
     }) {

-      $::lxdebug->message(LXDebug->WARN(),
-                          "ConvertTimeRecordings: creating delivery order failed ($@) for time recording ids " . join ', ', map { $_->id } @{$time_recordings_by_customer_id{$customer_id}});
-      push @{ $self->{job_errors} }, "ConvertTimeRecordings: creating delivery order failed ($@) for time recording ids " . join ', ', map { $_->id } @{$time_recordings_by_customer_id{$customer_id}};
-
+      $self->log_error("creating delivery order failed ($@) for time recording ids " . join ', ', map { $_->id } @{$time_recordings_by_customer_id{$customer_id}});

     }
 
     if ($do) {
     }
 
     if ($do) {


@@ -179,9 +189,7 @@ sub convert_without_linking {
         $_->update_attributes(booked => 1) for @{$time_recordings_by_customer_id{$customer_id}};
         1;
       })) {
         $_->update_attributes(booked => 1) for @{$time_recordings_by_customer_id{$customer_id}};
         1;
       })) {

-        $::lxdebug->message(LXDebug->WARN(),
-                            "ConvertTimeRecordings: saving delivery order failed for time recording ids " . join ', ', map { $_->id } @{$time_recordings_by_customer_id{$customer_id}});
-        push @{ $self->{job_errors} }, "ConvertTimeRecordings: saving delivery order failed for time recording ids " . join ', ', map { $_->id } @{$time_recordings_by_customer_id{$customer_id}};
+        $self->log_error('saving delivery order failed for time recording ids ' . join ', ', map { $_->id } @{$time_recordings_by_customer_id{$customer_id}});

       } else {
         push @donumbers, $do->donumber;
       }
       } else {
         push @donumbers, $do->donumber;
       }


@@ -194,8 +202,11 @@ sub convert_without_linking {
 sub convert_with_linking {
   my ($self, $time_recordings_by_order_id, $orders_by_order_id) = @_;
 
 sub convert_with_linking {
   my ($self, $time_recordings_by_order_id, $orders_by_order_id) = @_;
 

-  my %convert_params = map { $_ => $self->params->{$_} } qw(rounding link_order project_id);
-  $convert_params{default_part_id} = $self->params->{part_id};
+  my %convert_params = (
+    rounding        => $self->params->{rounding},
+    override_part_id => $self->params->{override_part_id},
+    default_part_id  => $self->params->{default_part_id},
+  );

 
   my @donumbers;
   foreach my $related_order_id (keys %$time_recordings_by_order_id) {
 
   my @donumbers;
   foreach my $related_order_id (keys %$time_recordings_by_order_id) {


@@ -205,9 +216,7 @@ sub convert_with_linking {
       $do = SL::DB::DeliveryOrder->new_from_time_recordings($time_recordings_by_order_id->{$related_order_id}, related_order => $related_order, %convert_params);
       1;
     }) {
       $do = SL::DB::DeliveryOrder->new_from_time_recordings($time_recordings_by_order_id->{$related_order_id}, related_order => $related_order, %convert_params);
       1;
     }) {

-      $::lxdebug->message(LXDebug->WARN(),
-                          "ConvertTimeRecordings: creating delivery order failed ($@) for time recording ids " . join ', ', map { $_->id } @{$time_recordings_by_order_id->{$related_order_id}});
-      push @{ $self->{job_errors} }, "ConvertTimeRecordings: creating delivery order failed ($@) for time recording ids " . join ', ', map { $_->id } @{$time_recordings_by_order_id->{$related_order_id}};
+      $self->log_error("creating delivery order failed ($@) for time recording ids " . join ', ', map { $_->id } @{$time_recordings_by_order_id->{$related_order_id}});

     }
 
     if ($do) {
     }
 
     if ($do) {


@@ -241,9 +250,8 @@ sub convert_with_linking {
 
         1;
       })) {
 
         1;
       })) {

-        $::lxdebug->message(LXDebug->WARN(),
-                            "ConvertTimeRecordings: saving delivery order failed for time recording ids " . join ', ', map { $_->id } @{$time_recordings_by_order_id->{$related_order_id}});
-        push @{ $self->{job_errors} }, "ConvertTimeRecordings: saving delivery order failed for time recording ids " . join ', ', map { $_->id } @{$time_recordings_by_order_id->{$related_order_id}};
+        $self->log_error('saving delivery order failed for time recording ids ' . join ', ', map { $_->id } @{$time_recordings_by_order_id->{$related_order_id}});
+

       } else {
         push @donumbers, $do->donumber;
       }
       } else {
         push @donumbers, $do->donumber;
       }


@@ -261,36 +269,27 @@ sub get_order_for_time_recording {
   if (!$tr->order_id) {
     # check project
     my $project_id;
   if (!$tr->order_id) {
     # check project
     my $project_id;

-    #$project_id   = $self->overide_project_id;
-    $project_id   = $self->params->{project_id};
+    $project_id   = $self->params->{override_project_id};

     $project_id ||= $tr->project_id;
     $project_id ||= $tr->project_id;

-    #$project_id ||= $self->default_project_id;
+    $project_id ||= $self->params->{default_project_id};

 
     if (!$project_id) {
 
     if (!$project_id) {

-      my $err_msg = 'ConvertTimeRecordings: searching related order failed for time recording id ' . $tr->id . ' : no project id';
-      $::lxdebug->message(LXDebug->WARN(), $err_msg);
-      push @{ $self->{job_errors} }, $err_msg;
+      $self->log_error('searching related order failed for time recording id ' . $tr->id . ' : no project id');

       return;
     }
 
     my $project = SL::DB::Project->load_cached($project_id);
 
     if (!$project) {
       return;
     }
 
     my $project = SL::DB::Project->load_cached($project_id);
 
     if (!$project) {

-      my $err_msg = 'ConvertTimeRecordings: searching related order failed for time recording id ' . $tr->id . ' : project not found';
-      $::lxdebug->message(LXDebug->WARN(), $err_msg);
-      push @{ $self->{job_errors} }, $err_msg;
+      $self->log_error('searching related order failed for time recording id ' . $tr->id . ' : project not found');

       return;
     }
     if (!$project->active || !$project->valid) {
       return;
     }
     if (!$project->active || !$project->valid) {

-      my $err_msg = 'ConvertTimeRecordings: searching related order failed for time recording id ' . $tr->id . ' : project not active or not valid';
-      $::lxdebug->message(LXDebug->WARN(), $err_msg);
-      push @{ $self->{job_errors} }, $err_msg;
+      $self->log_error('searching related order failed for time recording id ' . $tr->id . ' : project not active or not valid');

       return;
     }
     if ($project->customer_id && $project->customer_id != $tr->customer_id) {
       return;
     }
     if ($project->customer_id && $project->customer_id != $tr->customer_id) {

-      my $err_msg = 'ConvertTimeRecordings: searching related order failed for time recording id ' . $tr->id . ' : project customer does not match customer of time recording';
-      $::lxdebug->message(LXDebug->WARN(), $err_msg);
-      push @{ $self->{job_errors} }, $err_msg;
+      $self->log_error('searching related order failed for time recording id ' . $tr->id . ' : project customer does not match customer of time recording');

       return;
     }
 
       return;
     }
 


@@ -306,30 +305,23 @@ sub get_order_for_time_recording {
   }
 
   if (!scalar @$orders) {
   }
 
   if (!scalar @$orders) {

-    my $err_msg = 'ConvertTimeRecordings: searching related order failed for time recording id ' . $tr->id . ' : no order found';
-    $::lxdebug->message(LXDebug->WARN(), $err_msg);
-    push @{ $self->{job_errors} }, $err_msg;
+    $self->log_error('searching related order failed for time recording id ' . $tr->id . ' : no order found');

     return;
   }
 
   # check part
   my $part_id;
     return;
   }
 
   # check part
   my $part_id;

-  #$part_id   = $self->overide_part_id;
+  $part_id   = $self->params->{override_part_id};

   $part_id ||= $tr->part_id;
   $part_id ||= $tr->part_id;

-  #$part_id ||= $self->default_part_id;
-  $part_id ||= $self->params->{part_id};
+  $part_id ||= $self->params->{default_part_id};

 
   if (!$part_id) {
 
   if (!$part_id) {

-    my $err_msg = 'ConvertTimeRecordings: searching related order failed for time recording id ' . $tr->id . ' : no part id';
-    $::lxdebug->message(LXDebug->WARN(), $err_msg);
-    push @{ $self->{job_errors} }, $err_msg;
+    $self->log_error('searching related order failed for time recording id ' . $tr->id . ' : no part id');

     return;
   }
   my $part = SL::DB::Part->load_cached($part_id);
   if (!$part->unit_obj->is_time_based) {
     return;
   }
   my $part = SL::DB::Part->load_cached($part_id);
   if (!$part->unit_obj->is_time_based) {

-    my $err_msg = 'ConvertTimeRecordings: searching related order failed for time recording id ' . $tr->id . ' : part unit is not time based';
-    $::lxdebug->message(LXDebug->WARN(), $err_msg);
-    push @{ $self->{job_errors} }, $err_msg;
+    $self->log_error('searching related order failed for time recording id ' . $tr->id . ' : part unit is not time based');

     return;
   }
 
     return;
   }
 


@@ -341,44 +333,41 @@ sub get_order_for_time_recording {
   }
 
   if (1 != scalar @matching_orders) {
   }
 
   if (1 != scalar @matching_orders) {

-    my $err_msg = 'ConvertTimeRecordings: searching related order failed for time recording id ' . $tr->id . ' : no or more than one orders do match';
-    $::lxdebug->message(LXDebug->WARN(), $err_msg);
-    push @{ $self->{job_errors} }, $err_msg;
+    $self->log_error('searching related order failed for time recording id ' . $tr->id . ' : no or more than one orders do match');

     return;
   }
 
   my $matching_order = $matching_orders[0];
 
   if (!$matching_order->is_sales) {
     return;
   }
 
   my $matching_order = $matching_orders[0];
 
   if (!$matching_order->is_sales) {

-    my $err_msg = 'ConvertTimeRecordings: searching related order failed for time recording id ' . $tr->id . ' : found order is not a sales order';
-    $::lxdebug->message(LXDebug->WARN(), $err_msg);
-    push @{ $self->{job_errors} }, $err_msg;
+    $self->log_error('searching related order failed for time recording id ' . $tr->id . ' : found order is not a sales order');

     return;
   }
 
   if ($matching_order->customer_id != $tr->customer_id) {
     return;
   }
 
   if ($matching_order->customer_id != $tr->customer_id) {

-    my $err_msg = 'ConvertTimeRecordings: searching related order failed for time recording id ' . $tr->id . ' : customer of order does not match customer of time recording';
-    $::lxdebug->message(LXDebug->WARN(), $err_msg);
-    push @{ $self->{job_errors} }, $err_msg;
+    $self->log_error('searching related order failed for time recording id ' . $tr->id . ' : customer of order does not match customer of time recording');

     return;
   }
 
     return;
   }
 

-  if ($tr->project_id && $tr->project_id != ($matching_order->globalproject_id || 0)) {
-    my $err_msg = 'ConvertTimeRecordings: searching related order failed for time recording id ' . $tr->id . ' : project of order does not match project of time recording';
-    $::lxdebug->message(LXDebug->WARN(), $err_msg);
-    push @{ $self->{job_errors} }, $err_msg;
+  if ($tr->project_id && !$self->params->{override_project_id} && $tr->project_id != ($matching_order->globalproject_id || 0)) {
+    $self->log_error('searching related order failed for time recording id ' . $tr->id . ' : project of order does not match project of time recording');

     return;
   }
 
   return $matching_order;
 }
 
     return;
   }
 
   return $matching_order;
 }
 

+sub log_error {
+  my ($self, $msg) = @_;
+
+  my $dbg = 0;
+
+  push @{ $self->{job_errors} }, $msg;
+  $::lxdebug->message(LXDebug->WARN(), 'ConvertTimeRecordings: ' . $msg) if $dbg;
+}
+

 1;
 
 1;
 

-# possible data
-# from_date: 01.12.2020
-# to_date: 15.12.2020
-# customernumbers: [1,2,3]

 __END__
 
 =pod
 __END__
 
 =pod


@@ -400,7 +389,13 @@ C<SL::DB::DeliveryOrder-E<gt>new_from_time_recordings>).
 
 Some data can be provided to configure this backgroung job.
 If there is user data and it cannot be validated the background job
 
 Some data can be provided to configure this backgroung job.
 If there is user data and it cannot be validated the background job

-returns a error messages.
+fails.
+
+Example:
+
+  from_date: 01.12.2020
+  to_date: 15.12.2020
+  customernumbers: [1,2,3]

 
 =over 4
 
 
 =over 4
 


@@ -425,29 +420,35 @@ to_date: 15.12.2020
 =item C<customernumbers>
 
 An array with the customer numbers for which time recordings should
 =item C<customernumbers>
 
 An array with the customer numbers for which time recordings should

-be collected. If not given, time recordings for customers are
-collected. This is the default.
+be collected. If not given, time recordings for all customers are
+collected.

 
 customernumbers: [c1,22332,334343]
 
 
 customernumbers: [c1,22332,334343]
 

-=item C<part_id>
+=item C<override_part_id>

 
 The part id of a time based service which should be used to
 
 The part id of a time based service which should be used to

-book the times. If not set the clients config defaults is used.
+book the times instead of the parts which are set in the time
+recordings.
+
+=item C<default_part_id>
+
+The part id of a time based service which should be used to
+book the times if no part is set in the time recording entry.

 
 =item C<rounding>
 
 If set the 0 no rounding of the times will be done otherwise
 
 =item C<rounding>
 
 If set the 0 no rounding of the times will be done otherwise

-the times will be rounded up to th full quarters of an hour,
+the times will be rounded up to the full quarters of an hour,

 ie. 0.25h 0.5h 0.75h 1.25h ...
 Defaults to rounding true (1).
 
 =item C<link_order>
 
 ie. 0.25h 0.5h 0.75h 1.25h ...
 Defaults to rounding true (1).
 
 =item C<link_order>
 

-If set the job links the created delivery order with with the order
+If set the job links the created delivery order with the order

 given in the time recording entry. If there is no order given, then
 given in the time recording entry. If there is no order given, then

-it tries to find an order with with the current customer and project
-number and tries to do as much automatic workflow processing as the
+it tries to find an order with the current customer and project
+number. It tries to do as much automatic workflow processing as the

 UI.
 Defaults to off. If set to true (1) the job will fail if there
 is no sales order which qualifies as a predecessor.
 UI.
 Defaults to off. If set to true (1) the job will fail if there
 is no sales order which qualifies as a predecessor.


@@ -467,10 +468,28 @@ the services are not yet fully delivered (simple case: 'Payment in advance').
 Hint: take a look or extend the job CloseProjectsBelongingToClosedSalesOrder for
 further automatisation of your organisational needs.
 
 Hint: take a look or extend the job CloseProjectsBelongingToClosedSalesOrder for
 further automatisation of your organisational needs.
 

+=item C<override_project_id>
+
+Use this project id instead of the project id in the time recordings to find
+a related order. This is only used if C<link_order> is true.
+
+=item C<default_project_id>
+
+Use this project id if no project id is set in the time recording
+entry. This is only used if C<link_order> is true.
+
+=back
+
+=head1 TODO
+
+=over 4
+
+=item * part and project parameters as numbers

 
 

-=item C<project_id>
+Add parameters to give part and project not with their ids, but with their
+numbers. E.g. (default_/override_)part_number,
+(default_/override_)project_number.

 
 

-Use this project_id instead of the project_id in the time recordings.

 
 =back
 
 
 =back