SL/Controller/RequirementSpec.pm

   1 package SL::Controller::RequirementSpec;
   2
   3 use strict;
   4 use utf8;
   5
   6 use parent qw(SL::Controller::Base);
   7
   8 use SL::ClientJS;
   9 use SL::Controller::Helper::GetModels;
  10 use SL::Controller::Helper::Paginated;
  11 use SL::Controller::Helper::Sorted;
  12 use SL::Controller::Helper::ParseFilter;
  13 use SL::Controller::Helper::ReportGenerator;
  14 use SL::Controller::Helper::RequirementSpec;
  15 use SL::DB::Customer;
  16 use SL::DB::Project;
  17 use SL::DB::RequirementSpecComplexity;
  18 use SL::DB::RequirementSpecRisk;
  19 use SL::DB::RequirementSpecStatus;
  20 use SL::DB::RequirementSpecType;
  21 use SL::DB::RequirementSpec;
  22 use SL::Helper::Flash;
  23 use SL::Locale::String;
  24 use SL::Template::LaTeX;
  25
  26 use Rose::Object::MakeMethods::Generic
  27 (
  28   scalar                  => [ qw(requirement_spec_item customers types statuses db_args flat_filter visible_item visible_section) ],
  29   'scalar --get_set_init' => [ qw(requirement_spec complexities risks projects copy_source js) ],
  30 );
  31
  32 __PACKAGE__->run_before('setup');
  33 __PACKAGE__->run_before('load_select_options',  only => [ qw(new ajax_edit create update list) ]);
  34
  35
  36 __PACKAGE__->get_models_url_params('flat_filter');
  37 __PACKAGE__->make_paginated(
  38   MODEL         => 'RequirementSpec',
  39   PAGINATE_ARGS => 'db_args',
  40   ONLY          => [ qw(list) ],
  41 );
  42
  43 __PACKAGE__->make_sorted(
  44   MODEL         => 'RequirementSpec',
  45   ONLY          => [ qw(list) ],
  46
  47   DEFAULT_BY    => 'customer',
  48   DEFAULT_DIR   => 1,
  49
  50   customer      => t8('Customer'),
  51   title         => t8('Title'),
  52   type          => t8('Requirement Spec Type'),
  53   status        => t8('Requirement Spec Status'),
  54   projectnumber => t8('Project Number'),
  55   version       => t8('Version'),
  56   mtime         => t8('Last modification'),
  57 );
  58
  59 #
  60 # actions
  61 #
  62
  63
  64 sub action_list {
  65   my ($self) = @_;
  66
  67   $self->setup_db_args_from_filter;
  68   $self->flat_filter({ map { $_->{key} => $_->{value} } $::form->flatten_variables('filter') });
  69
  70   $self->prepare_report;
  71
  72   my $requirement_specs = $self->get_models(%{ $self->db_args });
  73
  74   $self->report_generator_list_objects(report => $self->{report}, objects => $requirement_specs);
  75 }
  76
  77 sub action_new {
  78   my ($self) = @_;
  79
  80   $self->requirement_spec(SL::DB::RequirementSpec->new(is_template => $::form->{is_template}));
  81
  82   if ($self->copy_source) {
  83     $self->requirement_spec->$_($self->copy_source->$_) for qw(type_id status_id customer_id title hourly_rate)
  84   }
  85
  86   $self->render('requirement_spec/new', title => $self->requirement_spec->is_template ? t8('Create a new requirement spec template') : t8('Create a new requirement spec'));
  87 }
  88
  89 sub action_ajax_edit {
  90   my ($self) = @_;
  91
  92   $self->render('requirement_spec/_form', { layout => 0 }, submit_as => 'ajax');
  93 }
  94
  95 sub action_ajax_show_time_and_cost_estimate {
  96   my ($self) = @_;
  97
  98   $self->render('requirement_spec/_show_time_and_cost_estimate', { layout => 0 });
  99 }
 100
 101 sub action_ajax_cancel_time_and_cost_estimate {
 102   my ($self) = @_;
 103
 104   my $html   = $self->render('requirement_spec/_show_time_and_cost_estimate', { output => 0 });
 105
 106   $self->js
 107    ->replaceWith('#time_cost_estimate', $html)
 108    ->render($self);
 109 }
 110
 111 sub action_ajax_edit_time_and_cost_estimate {
 112   my ($self) = @_;
 113
 114   my $html   = $self->render('requirement_spec/_edit_time_and_cost_estimate', { output => 0 });
 115
 116   $self->js
 117    ->replaceWith('#time_cost_estimate', $html)
 118    ->render($self);
 119 }
 120
 121 sub action_ajax_save_time_and_cost_estimate {
 122   my ($self) = @_;
 123
 124   $self->requirement_spec->db->do_transaction(sub {
 125     # Make Emacs happy
 126     1;
 127     foreach my $attributes (@{ $::form->{requirement_spec_items} || [] }) {
 128       SL::DB::RequirementSpecItem
 129         ->new(id => delete $attributes->{id})
 130         ->load
 131         ->update_attributes(%{ $attributes });
 132     }
 133
 134     1;
 135   });
 136
 137   my $html = $self->render('requirement_spec/_show_time_and_cost_estimate', { output => 0 });
 138   $self->js->replaceWith('#time_cost_estimate', $html);
 139
 140   if ($self->visible_section) {
 141     $html = $self->render('requirement_spec_item/_section', { output => 0 }, requirement_spec_item => $self->visible_section);
 142     $self->js->html('#column-content', $html);
 143   }
 144
 145   $self->js->render($self);
 146 }
 147
 148 sub action_show {
 149   my ($self) = @_;
 150
 151   my $item = $::form->{requirement_spec_item_id} ? SL::DB::RequirementSpecItem->new(id => $::form->{requirement_spec_item_id})->load : @{ $self->requirement_spec->sections }[0];
 152   $self->requirement_spec_item($item);
 153
 154   $self->render('requirement_spec/show', title => t8('Show requirement spec'));
 155 }
 156
 157 sub action_create {
 158   my ($self) = @_;
 159
 160   $self->requirement_spec(SL::DB::RequirementSpec->new);
 161   $self->create_or_update;
 162 }
 163
 164 sub action_update {
 165   my ($self) = @_;
 166   $self->create_or_update;
 167 }
 168
 169 sub action_destroy {
 170   my ($self) = @_;
 171
 172   if (eval { $self->requirement_spec->delete; 1; }) {
 173     flash_later('info',  t8('The requirement spec has been deleted.'));
 174   } else {
 175     flash_later('error', t8('The requirement spec is in use and cannot be deleted.'));
 176   }
 177
 178   $self->redirect_to(action => 'list');
 179 }
 180
 181 sub action_revert_to {
 182   my ($self, %params) = @_;
 183
 184   return $self->js->error(t8('Cannot revert a versioned copy.'))->render($self) if $self->requirement_spec->working_copy_id;
 185
 186   my $versioned_copy = SL::DB::RequirementSpec->new(id => $::form->{versioned_copy_id})->load;
 187
 188   $self->requirement_spec->copy_from(
 189     $versioned_copy,
 190     version_id => $versioned_copy->version_id,
 191   );
 192
 193   flash_later('info', t8('The requirement spec has been reverted to version #1.', $self->requirement_spec->version->version_number));
 194   $self->js->redirect_to($self->url_for(action => 'show', id => $self->requirement_spec->id))->render($self);
 195 }
 196
 197 sub action_create_pdf {
 198   my ($self, %params) = @_;
 199
 200   my %result = SL::Template::LaTeX->parse_and_create_pdf('requirement_spec.tex', SELF => $self, rspec => $self->requirement_spec);
 201
 202   $::form->error(t8('Conversion to PDF failed: #1', $result{error})) if $result{error};
 203
 204   my $attachment_name  =  $self->requirement_spec->type->description . ' ' . ($self->requirement_spec->working_copy_id || $self->requirement_spec->id);
 205   $attachment_name    .=  ' (v' . $self->requirement_spec->version->version_number . ')' if $self->requirement_spec->version;
 206   $attachment_name    .=  '.pdf';
 207   $attachment_name     =~ s/[^\wäöüÄÖÜß \-\+\(\)\[\]\{\}\.,]+/_/g;
 208
 209   $self->send_file($result{file_name}, type => 'application/pdf', name => $attachment_name);
 210   unlink $result{file_name};
 211 }
 212
 213 #
 214 # filters
 215 #
 216
 217 sub setup {
 218   my ($self) = @_;
 219
 220   $::auth->assert('sales_quotation_edit');
 221   $::request->{layout}->use_stylesheet("${_}.css") for qw(jquery.contextMenu requirement_spec);
 222   $::request->{layout}->use_javascript("${_}.js") for qw(jquery.jstree jquery/jquery.contextMenu client_js requirement_spec);
 223   $self->init_visible_section;
 224
 225   return 1;
 226 }
 227
 228 sub init_complexities {
 229   my ($self) = @_;
 230   return SL::DB::Manager::RequirementSpecComplexity->get_all_sorted;
 231 }
 232
 233 sub init_risks {
 234   my ($self) = @_;
 235   return SL::DB::Manager::RequirementSpecRisk->get_all_sorted;
 236 }
 237
 238 sub init_projects {
 239   my ($self) = @_;
 240   $self->projects(SL::DB::Manager::Project->get_all_sorted);
 241 }
 242
 243 sub init_requirement_spec {
 244   my ($self) = @_;
 245   $self->requirement_spec(SL::DB::RequirementSpec->new(id => $::form->{id})->load || die "No such requirement spec") if $::form->{id};
 246 }
 247
 248 sub init_copy_source {
 249   my ($self) = @_;
 250   $self->copy_source(SL::DB::RequirementSpec->new(id => $::form->{copy_source_id})->load) if $::form->{copy_source_id};
 251 }
 252
 253 sub init_js {
 254   my ($self) = @_;
 255   $self->js(SL::ClientJS->new);
 256 }
 257
 258 sub load_select_options {
 259   my ($self) = @_;
 260
 261   my @filter = ('!obsolete' => 1);
 262   @filter    = ( or => [ @filter, id => $self->requirement_spec->customer_id ] ) if $self->requirement_spec && $self->requirement_spec->customer_id;
 263
 264   $self->customers(SL::DB::Manager::Customer->get_all_sorted(where => \@filter));
 265   $self->statuses( SL::DB::Manager::RequirementSpecStatus->get_all_sorted);
 266   $self->types(    SL::DB::Manager::RequirementSpecType->get_all_sorted);
 267 }
 268
 269 #
 270 # helpers
 271 #
 272
 273 sub create_or_update {
 274   my $self   = shift;
 275   my $is_new = !$self->requirement_spec->id;
 276   my $params = delete($::form->{requirement_spec}) || { };
 277
 278   $self->requirement_spec->assign_attributes(%{ $params });
 279
 280   my $title  = $is_new && $self->requirement_spec->is_template ? t8('Create a new requirement spec template')
 281              : $is_new                                         ? t8('Create a new requirement spec')
 282              :            $self->requirement_spec->is_template ? t8('Edit requirement spec template')
 283              :                                                   t8('Edit requirement spec');
 284
 285   my @errors = $self->requirement_spec->validate;
 286
 287   if (@errors) {
 288     return $self->js->error(@errors)->render($self) if $::request->is_ajax;
 289
 290     flash('error', @errors);
 291     $self->render('requirement_spec/new', title => $title);
 292     return;
 293   }
 294
 295   my $db = $self->requirement_spec->db;
 296   if (!$db->do_transaction(sub {
 297     if ($self->copy_source) {
 298       $self->requirement_spec($self->copy_source->create_copy(%{ $params }));
 299     } else {
 300       $self->requirement_spec->save;
 301     }
 302   })) {
 303     $::lxdebug->message(LXDebug::WARN(), "Error: " . $db->error);
 304     @errors = ($::locale->text('Saving failed. Error message from the database: #1'), $db->error);
 305     return $self->js->error(@errors)->render($self) if $::request->is_ajax;
 306
 307     $self->requirement_spec->id(undef) if $is_new;
 308     flash('error', @errors);
 309     return $self->render('requirement_spec/new', title => $title);
 310   }
 311
 312   my $info = $self->requirement_spec->is_template ? t8('The requirement spec template has been saved.') : t8('The requirement spec has been saved.');
 313
 314   if ($::request->is_ajax) {
 315     my $html = $self->render('requirement_spec/_header', { output => 0 });
 316     return $self->invalidate_version
 317       ->replaceWith('#requirement-spec-header', $html)
 318       ->flash('info', $info)
 319       ->render($self);
 320   }
 321
 322   flash_later('info', $info);
 323   $self->redirect_to(action => 'show', id => $self->requirement_spec->id);
 324 }
 325
 326 sub setup_db_args_from_filter {
 327   my ($self) = @_;
 328
 329   $self->{filter} = {};
 330   my %args = parse_filter(
 331     $::form->{filter},
 332     with_objects => [ 'customer', 'type', 'status', 'project' ],
 333     launder_to   => $self->{filter},
 334   );
 335
 336   $args{where} = [
 337     and => [
 338       @{ $args{where} || [] },
 339       working_copy_id => undef,
 340       is_template     => $::form->{is_template} ? 1 : 0,
 341     ]];
 342
 343   $self->db_args(\%args);
 344 }
 345
 346 sub prepare_report {
 347   my ($self)      = @_;
 348
 349   my $callback    = $self->get_callback;
 350
 351   my $is_template = $::form->{is_template};
 352   my $report      = SL::ReportGenerator->new(\%::myconfig, $::form);
 353   $self->{report} = $report;
 354
 355   my @columns     = $is_template ? qw(title mtime) : qw(title customer status type projectnumber mtime version);
 356   my @sortable    = $is_template ? qw(title mtime) : qw(title customer status type projectnumber mtime);
 357
 358   my %column_defs = (
 359     title         => { obj_link => sub { $self->url_for(action => 'show', id => $_[0]->id, callback => $callback) } },
 360     mtime         => { sub      => sub { ($_[0]->mtime || $_[0]->itime)->to_kivitendo(precision => 'minute') } },
 361   );
 362
 363   if (!$is_template) {
 364     %column_defs = (
 365       %column_defs,
 366       customer      => { raw_data => sub { $self->presenter->customer($_[0]->customer, display => 'table-cell', callback => $callback) },
 367                          sub      => sub { $_[0]->customer->name } },
 368       projectnumber => { raw_data => sub { $self->presenter->project($_[0]->project, display => 'table-cell', callback => $callback) },
 369                          sub      => sub { $_[0]->project_id ? $_[0]->project->projectnumber : '' } },
 370       status        => { sub      => sub { $_[0]->status->description } },
 371       type          => { sub      => sub { $_[0]->type->description } },
 372       version       => { sub      => sub { $_[0]->version_id ? $_[0]->version->version_number : t8('Working copy without version') } },
 373     );
 374   }
 375
 376   map { $column_defs{$_}->{text} ||= $::locale->text( $self->get_sort_spec->{$_}->{title} ) } keys %column_defs;
 377
 378   $report->set_options(
 379     std_column_visibility => 1,
 380     controller_class      => 'RequirementSpec',
 381     output_format         => 'HTML',
 382     raw_top_info_text     => $self->render('requirement_spec/report_top',    { output => 0 }, is_template => $is_template),
 383     raw_bottom_info_text  => $self->render('requirement_spec/report_bottom', { output => 0 }),
 384     title                 => $is_template ? t8('Requirement Spec Templates') : t8('Requirement Specs'),
 385     allow_pdf_export      => 1,
 386     allow_csv_export      => 1,
 387   );
 388   $report->set_columns(%column_defs);
 389   $report->set_column_order(@columns);
 390   $report->set_export_options(qw(list filter));
 391   $report->set_options_from_form;
 392   $self->set_report_generator_sort_options(report => $report, sortable_columns => \@sortable);
 393
 394   $self->disable_pagination if $report->{options}{output_format} =~ /^(pdf|csv)$/i;
 395 }
 396
 397 sub invalidate_version {
 398   my ($self) = @_;
 399
 400   my $rspec  = SL::DB::RequirementSpec->new(id => $self->requirement_spec->id)->load;
 401   return $self->js if $rspec->is_template;
 402
 403   $rspec->invalidate_version;
 404
 405   my $html = $self->render('requirement_spec/_version', { output => 0 }, requirement_spec => $rspec);
 406   return $self->js->html('#requirement_spec_version', $html);
 407 }
 408
 409 1;