SL/Controller/TimeRecording.pm

   1 package SL::Controller::TimeRecording;
   2
   3 use strict;
   4 use parent qw(SL::Controller::Base);
   5
   6 use DateTime;
   7 use English qw(-no_match_vars);
   8 use List::Util qw(sum0);
   9 use POSIX qw(strftime);
  10
  11 use SL::Controller::Helper::GetModels;
  12 use SL::Controller::Helper::ReportGenerator;
  13 use SL::Controller::Helper::ReportGenerator::ControlRow qw(make_control_row);
  14 use SL::DB::Customer;
  15 use SL::DB::Employee;
  16 use SL::DB::Order;
  17 use SL::DB::Part;
  18 use SL::DB::Project;
  19 use SL::DB::TimeRecording;
  20 use SL::DB::TimeRecordingArticle;
  21 use SL::Helper::Flash qw(flash);
  22 use SL::Helper::Number qw(_round_number _parse_number _round_total);
  23 use SL::Helper::UserPreferences::TimeRecording;
  24 use SL::Locale::String qw(t8);
  25 use SL::ReportGenerator;
  26
  27 use Rose::Object::MakeMethods::Generic
  28 (
  29 # scalar                  => [ qw() ],
  30  'scalar --get_set_init' => [ qw(time_recording models all_employees all_time_recording_articles all_orders can_view_all can_edit_all use_duration) ],
  31 );
  32
  33
  34 # safety
  35 __PACKAGE__->run_before('check_auth');
  36 __PACKAGE__->run_before('check_auth_edit', only => [ qw(edit save delete) ]);
  37
  38 my %sort_columns = (
  39   date         => t8('Date'),
  40   start_time   => t8('Start'),
  41   end_time     => t8('End'),
  42   order        => t8('Sales Order'),
  43   customer     => t8('Customer'),
  44   part         => t8('Article'),
  45   project      => t8('Project'),
  46   description  => t8('Description'),
  47   staff_member => t8('Mitarbeiter'),
  48   duration     => t8('Duration'),
  49   booked       => t8('Booked'),
  50 );
  51
  52 #
  53 # actions
  54 #
  55
  56 sub action_list {
  57   my ($self, %params) = @_;
  58
  59   $::form->{filter} //=  {
  60     staff_member_id => SL::DB::Manager::Employee->current->id,
  61     "date:date::ge" => DateTime->today_local->add(weeks => -2)->to_kivitendo,
  62   };
  63
  64   $self->setup_list_action_bar;
  65   $self->make_filter_summary;
  66   $self->prepare_report;
  67
  68   my $objects = $self->models->get;
  69
  70   my $total   = sum0 map { _round_total($_->duration_in_hours) } @$objects;
  71   my $total_h = int($total);
  72   my $total_m = int($total * 60.0 + 0.5) % 60;
  73   my $total_s = sprintf('%d:%02d', $total_h, $total_m);
  74
  75   push @$objects, make_control_row("separator");
  76   push @$objects, make_control_row("data",
  77                                    row => {
  78                                      map( { $_ => {class => 'listtotal'} } keys %{$self->{report}->{columns}} ),
  79                                      description => {data => t8('Total'), class => 'listtotal'},
  80                                      duration    => {data => $total_s,    class => 'listtotal'}
  81                                    });
  82
  83   $self->report_generator_list_objects(report => $self->{report}, objects => $objects);
  84 }
  85
  86 sub action_edit {
  87   my ($self) = @_;
  88
  89   $::request->{layout}->use_javascript("${_}.js") for qw(kivi.TimeRecording ckeditor/ckeditor ckeditor/adapters/jquery kivi.Validator);
  90
  91   if ($self->use_duration) {
  92     flash('warning', t8('This entry is using start and end time. This information will be overwritten on saving.')) if !$self->time_recording->is_duration_used;
  93   } else {
  94     flash('warning', t8('This entry is using date and duration. This information will be overwritten on saving.'))  if $self->time_recording->is_duration_used;
  95   }
  96
  97   if ($self->time_recording->start_time) {
  98     $self->{start_date} = $self->time_recording->start_time->to_kivitendo;
  99     $self->{start_time} = $self->time_recording->start_time->to_kivitendo_time;
 100   }
 101   if ($self->time_recording->end_time) {
 102     $self->{end_date}   = $self->time_recording->end_time->to_kivitendo;
 103     $self->{end_time}   = $self->time_recording->end_time->to_kivitendo_time;
 104   }
 105
 106   my $inputs_to_disable = $self->get_inputs_to_disable;
 107
 108   $self->setup_edit_action_bar;
 109
 110   $self->render('time_recording/form',
 111                 title             => t8('Time Recording'),
 112                 inputs_to_disable => $inputs_to_disable,
 113   );
 114 }
 115
 116 sub action_save {
 117   my ($self) = @_;
 118
 119   if ($self->use_duration) {
 120     $self->time_recording->start_time(undef);
 121     $self->time_recording->end_time(undef);
 122   }
 123
 124   my @errors = $self->time_recording->validate;
 125   if (@errors) {
 126     $::form->error(t8('Saving the time recording entry failed: #1', join '<br>', @errors));
 127     return;
 128   }
 129
 130   if ( !eval { $self->time_recording->save; 1; } ) {
 131     $::form->error(t8('Saving the time recording entry failed: #1', $EVAL_ERROR));
 132     return;
 133   }
 134
 135   $self->redirect_to(safe_callback());
 136 }
 137
 138 sub action_delete {
 139   my ($self) = @_;
 140
 141   $self->time_recording->delete;
 142
 143   $self->redirect_to(safe_callback());
 144 }
 145
 146 sub action_ajaj_get_order_info {
 147
 148   my $order = SL::DB::Order->new(id => $::form->{id})->load;
 149   my $data  = { customer => { id    => $order->customer_id,
 150                               value => $order->customer->displayable_name,
 151                               type  => 'customer'
 152                 },
 153                 project => { id     =>  $order->globalproject_id,
 154                              value  => ($order->globalproject_id ? $order->globalproject->displayable_name : undef),
 155                 },
 156   };
 157
 158   $_[0]->render(\SL::JSON::to_json($data), { type => 'json', process => 0 });
 159 }
 160
 161 sub action_ajaj_get_project_info {
 162
 163   my $project = SL::DB::Project->new(id => $::form->{id})->load;
 164
 165   my $data;
 166   if ($project->customer_id) {
 167     $data = { customer => { id    => $project->customer_id,
 168                             value => $project->customer->displayable_name,
 169                             type  => 'customer'
 170                           },
 171     };
 172   }
 173
 174   $_[0]->render(\SL::JSON::to_json($data), { type => 'json', process => 0 });
 175 }
 176
 177 sub init_time_recording {
 178   my ($self) = @_;
 179
 180   my $is_new         = !$::form->{id};
 181   my $time_recording = !$is_new            ? SL::DB::TimeRecording->new(id => $::form->{id})->load
 182                      : $self->use_duration ? SL::DB::TimeRecording->new(date => DateTime->today_local)
 183                      :                       SL::DB::TimeRecording->new(start_time => DateTime->now_local);
 184
 185   my %attributes = %{ $::form->{time_recording} || {} };
 186
 187   if ($self->use_duration) {
 188     if (exists $::form->{duration_h} || exists $::form->{duration_m}) {
 189       $attributes{duration} = _round_number(_parse_number($::form->{duration_h}) * 60 + _parse_number($::form->{duration_m}), 0);
 190     }
 191
 192   } else {
 193     foreach my $type (qw(start end)) {
 194       if ($::form->{$type . '_date'}) {
 195         my $date = DateTime->from_kivitendo($::form->{$type . '_date'});
 196         $attributes{$type . '_time'} = $date->clone;
 197         if ($::form->{$type . '_time'}) {
 198           my ($hour, $min) = split ':', $::form->{$type . '_time'};
 199           $attributes{$type . '_time'}->set_hour($hour)  if $hour;
 200           $attributes{$type . '_time'}->set_minute($min) if $min;
 201         }
 202       }
 203     }
 204   }
 205
 206   # do not overwrite staff member if you do not have the right
 207   delete $attributes{staff_member_id}                                     if !$_[0]->can_edit_all;
 208   $attributes{staff_member_id} ||= SL::DB::Manager::Employee->current->id if $is_new;
 209
 210   $attributes{employee_id}       = SL::DB::Manager::Employee->current->id;
 211
 212   $time_recording->assign_attributes(%attributes);
 213
 214   return $time_recording;
 215 }
 216
 217 sub init_can_view_all {
 218   $::auth->assert('time_recording_show_all', 1) || $::auth->assert('time_recording_edit_all', 1)
 219 }
 220
 221 sub init_can_edit_all {
 222   $::auth->assert('time_recording_edit_all', 1)
 223 }
 224
 225 sub init_models {
 226   my ($self) = @_;
 227
 228   my @where;
 229   push @where, (staff_member_id => SL::DB::Manager::Employee->current->id) if !$self->can_view_all;
 230
 231   SL::Controller::Helper::GetModels->new(
 232     controller     => $_[0],
 233     sorted         => \%sort_columns,
 234     disable_plugin => 'paginated',
 235     query          => \@where,
 236     with_objects   => [ 'customer', 'part', 'project', 'staff_member', 'employee', 'order' ],
 237   );
 238 }
 239
 240 sub init_all_employees {
 241   SL::DB::Manager::Employee->get_all_sorted(query => [ deleted => 0 ]);
 242 }
 243
 244 sub init_all_time_recording_articles {
 245   my $selectable_parts = SL::DB::Manager::TimeRecordingArticle->get_all_sorted(
 246     query        => [or => [ 'part.obsolete' => 0, 'part.obsolete' => undef ]],
 247     with_objects => ['part']);
 248
 249   my $res              = [ map { {id => $_->part_id, description => $_->part->displayable_name} } @$selectable_parts];
 250   my $curr_id          = $_[0]->time_recording->part_id;
 251
 252   if ($curr_id && !grep { $curr_id == $_->{id} } @$res) {
 253     unshift @$res, {id => $curr_id, description => $_[0]->time_recording->part->displayable_name};
 254   }
 255
 256   return $res;
 257 }
 258
 259 sub init_all_orders {
 260   my $orders = SL::DB::Manager::Order->get_all(query => [or             => [ closed    => 0, closed    => undef ],
 261                                                          or             => [ quotation => 0, quotation => undef ],
 262                                                          '!customer_id' => undef]);
 263   return [ map { [$_->id, sprintf("%s %s", $_->number, $_->customervendor->name) ] } sort { $a->number <=> $b->number } @{$orders||[]} ];
 264 }
 265
 266 sub init_use_duration {
 267   return SL::Helper::UserPreferences::TimeRecording->new()->get_use_duration();
 268 }
 269
 270 sub check_auth {
 271   $::auth->assert('time_recording');
 272 }
 273
 274 sub check_auth_edit {
 275   my ($self) = @_;
 276
 277   if (!$self->can_edit_all && ($self->time_recording->staff_member_id != SL::DB::Manager::Employee->current->id)) {
 278     $::form->error(t8('You do not have permission to access this entry.'));
 279   }
 280 }
 281
 282 sub prepare_report {
 283   my ($self) = @_;
 284
 285   my $report      = SL::ReportGenerator->new(\%::myconfig, $::form);
 286   $self->{report} = $report;
 287
 288   my @columns  = qw(date start_time end_time order customer project part description staff_member duration booked);
 289
 290   my %column_defs = (
 291     date         => { text => t8('Date'),         sub => sub { $_[0]->date_as_date },
 292                       obj_link => sub { $self->url_for(action => 'edit', 'id' => $_[0]->id, callback => $self->models->get_callback) }  },
 293     start_time   => { text => t8('Start'),        sub => sub { $_[0]->start_time_as_timestamp },
 294                       obj_link => sub { $self->url_for(action => 'edit', 'id' => $_[0]->id, callback => $self->models->get_callback) }  },
 295     end_time     => { text => t8('End'),          sub => sub { $_[0]->end_time_as_timestamp },
 296                       obj_link => sub { $self->url_for(action => 'edit', 'id' => $_[0]->id, callback => $self->models->get_callback) }  },
 297     order        => { text => t8('Sales Order'),  sub => sub { $_[0]->order && $_[0]->order->number } },
 298     customer     => { text => t8('Customer'),     sub => sub { $_[0]->customer->displayable_name } },
 299     part         => { text => t8('Article'),      sub => sub { $_[0]->part && $_[0]->part->displayable_name } },
 300     project      => { text => t8('Project'),      sub => sub { $_[0]->project && $_[0]->project->full_description(sytle => 'both') } },
 301     description  => { text => t8('Description'),  sub => sub { $_[0]->description_as_stripped_html },
 302                       raw_data => sub { $_[0]->description_as_restricted_html }, # raw_data only used for html(?)
 303                       obj_link => sub { $self->url_for(action => 'edit', 'id' => $_[0]->id, callback => $self->models->get_callback) }  },
 304     staff_member => { text => t8('Mitarbeiter'),  sub => sub { $_[0]->staff_member->safe_name } },
 305     duration     => { text => t8('Duration'),     sub => sub { $_[0]->duration_as_duration_string },
 306                       align => 'right'},
 307     booked       => { text => t8('Booked'),       sub => sub { $_[0]->booked ? t8('Yes') : t8('No') } },
 308   );
 309
 310   my $title        = t8('Time Recordings');
 311   $report->{title} = $title;    # for browser titlebar (title-tag)
 312
 313   $report->set_options(
 314     controller_class      => 'TimeRecording',
 315     std_column_visibility => 1,
 316     output_format         => 'HTML',
 317     title                 => $title, # for heading
 318     allow_pdf_export      => 1,
 319     allow_csv_export      => 1,
 320   );
 321
 322   $report->set_columns(%column_defs);
 323   $report->set_column_order(@columns);
 324   $report->set_export_options(qw(list filter));
 325   $report->set_options_from_form;
 326
 327   $self->models->disable_plugin('paginated') if $report->{options}{output_format} =~ /^(pdf|csv)$/i;
 328   $self->models->add_additional_url_params(filter => $::form->{filter});
 329   $self->models->finalize;
 330   $self->models->set_report_generator_sort_options(report => $report, sortable_columns => [keys %sort_columns]);
 331
 332   $report->set_options(
 333     raw_top_info_text    => $self->render('time_recording/report_top',    { output => 0 }),
 334     raw_bottom_info_text => $self->render('time_recording/report_bottom', { output => 0 }, models => $self->models),
 335     attachment_basename  => t8('time_recordings') . strftime('_%Y%m%d', localtime time),
 336   );
 337 }
 338
 339 sub make_filter_summary {
 340   my ($self) = @_;
 341
 342   my $filter = $::form->{filter} || {};
 343   my @filter_strings;
 344
 345   my $staff_member = $filter->{staff_member_id} ? SL::DB::Employee->new(id => $filter->{staff_member_id})->load->safe_name                         : '';
 346   my $project      = $filter->{project_id}      ? SL::DB::Project->new (id => $filter->{project_id})     ->load->full_description(sytle => 'both') : '';
 347
 348   my @filters = (
 349     [ $filter->{"date:date::ge"},                              t8('From Date')       ],
 350     [ $filter->{"date:date::le"},                              t8('To Date')         ],
 351     [ $filter->{"customer"}->{"name:substr::ilike"},           t8('Customer')        ],
 352     [ $filter->{"customer"}->{"customernumber:substr::ilike"}, t8('Customer Number') ],
 353     [ $filter->{"order"}->{"ordnumber:substr::ilike"},         t8('Order Number')    ],
 354     [ $project,                                                t8('Project')         ],
 355     [ $filter->{"description:substr::ilike"},                  t8('Description')     ],
 356     [ $staff_member,                                           t8('Mitarbeiter')     ],
 357   );
 358
 359   for (@filters) {
 360     push @filter_strings, "$_->[1]: $_->[0]" if $_->[0];
 361   }
 362
 363   $self->{filter_summary} = join ', ', @filter_strings;
 364 }
 365
 366 sub setup_list_action_bar {
 367   my ($self) = @_;
 368
 369   for my $bar ($::request->layout->get('actionbar')) {
 370     $bar->add(
 371       action => [
 372         t8('Update'),
 373         submit    => [ '#filter_form', { action => 'TimeRecording/list' } ],
 374         accesskey => 'enter',
 375       ],
 376       action => [
 377         t8('Add'),
 378         link => $self->url_for(action => 'edit', callback => $self->models->get_callback),
 379       ],
 380     );
 381   }
 382 }
 383
 384 sub setup_edit_action_bar {
 385   my ($self) = @_;
 386
 387   for my $bar ($::request->layout->get('actionbar')) {
 388     $bar->add(
 389       action => [
 390         t8('Save'),
 391         submit => [ '#form', { action => 'TimeRecording/save' } ],
 392         checks => [ 'kivi.validate_form' ],
 393       ],
 394       action => [
 395         t8('Delete'),
 396         submit  => [ '#form', { action => 'TimeRecording/delete' } ],
 397         only_if => $self->time_recording->id,
 398       ],
 399       action => [
 400         t8('Cancel'),
 401         link  => $self->url_for(safe_callback()),
 402       ],
 403     );
 404   }
 405 }
 406
 407 sub safe_callback {
 408   $::form->{callback} || (action => 'list')
 409 }
 410
 411 sub get_inputs_to_disable {
 412   my ($self) = @_;
 413
 414   return [qw(customer project)]  if $self->time_recording->order_id;
 415   return [qw(customer)]          if $self->time_recording->project_id && $self->time_recording->project->customer_id;
 416 }
 417
 418
 419 1;