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 File::Spec ();
   9
  10 use SL::ClientJS;
  11 use SL::Common ();
  12 use SL::Controller::Helper::GetModels;
  13 use SL::Controller::Helper::Filtered;
  14 use SL::Controller::Helper::Paginated;
  15 use SL::Controller::Helper::Sorted;
  16 use SL::Controller::Helper::ParseFilter;
  17 use SL::Controller::Helper::ReportGenerator;
  18 use SL::Controller::Helper::RequirementSpec;
  19 use SL::DB::Customer;
  20 use SL::DB::Project;
  21 use SL::DB::RequirementSpecComplexity;
  22 use SL::DB::RequirementSpecRisk;
  23 use SL::DB::RequirementSpecStatus;
  24 use SL::DB::RequirementSpecType;
  25 use SL::DB::RequirementSpec;
  26 use SL::Helper::Flash;
  27 use SL::Locale::String;
  28 use SL::Template::LaTeX;
  29
  30 use Rose::Object::MakeMethods::Generic
  31 (
  32   scalar                  => [ qw(requirement_spec_item customers types statuses visible_item visible_section) ],
  33   'scalar --get_set_init' => [ qw(requirement_spec complexities risks projects copy_source js current_text_block_output_position) ],
  34 );
  35
  36 __PACKAGE__->run_before('setup');
  37 __PACKAGE__->run_before('load_select_options',  only => [ qw(new ajax_edit create update list) ]);
  38
  39 __PACKAGE__->make_filtered(
  40   MODEL      => 'RequirementSpec',
  41   LAUNDER_TO => 'filter'
  42 );
  43 __PACKAGE__->make_paginated(
  44   MODEL => 'RequirementSpec',
  45   ONLY  => [ qw(list) ],
  46 );
  47 __PACKAGE__->make_sorted(
  48   MODEL         => 'RequirementSpec',
  49   ONLY          => [ qw(list) ],
  50
  51   DEFAULT_BY    => 'customer',
  52   DEFAULT_DIR   => 1,
  53
  54   customer      => t8('Customer'),
  55   title         => t8('Title'),
  56   type          => t8('Requirement Spec Type'),
  57   status        => t8('Requirement Spec Status'),
  58   projectnumber => t8('Project Number'),
  59   version       => t8('Version'),
  60   mtime         => t8('Last modification'),
  61 );
  62
  63 #
  64 # actions
  65 #
  66
  67
  68 sub action_list {
  69   my ($self) = @_;
  70
  71   my $requirement_specs = $self->get_models(
  72     query => [
  73       and => [
  74         working_copy_id => undef,
  75         is_template     => $::form->{is_template} ? 1 : 0,
  76       ]],
  77     with_objects => [ 'customer', 'type', 'status', 'project' ],
  78   );
  79
  80   $self->prepare_report;
  81   $self->report_generator_list_objects(report => $self->{report}, objects => $requirement_specs);
  82 }
  83
  84 sub action_new {
  85   my ($self) = @_;
  86
  87   $self->requirement_spec(SL::DB::RequirementSpec->new(is_template => $::form->{is_template}));
  88
  89   if ($self->copy_source) {
  90     $self->requirement_spec->$_($self->copy_source->$_) for qw(type_id status_id customer_id title hourly_rate)
  91   }
  92
  93   $self->render('requirement_spec/new', title => $self->requirement_spec->is_template ? t8('Create a new requirement spec template') : t8('Create a new requirement spec'));
  94 }
  95
  96 sub action_ajax_show_basic_settings {
  97   my ($self) = @_;
  98
  99   $self->render('requirement_spec/_show_basic_settings', { layout => 0 });
 100 }
 101
 102 sub action_ajax_edit {
 103   my ($self) = @_;
 104
 105   my $html   = $self->render('requirement_spec/_form', { output => 0 }, submit_as => 'ajax');
 106
 107   $self->js
 108     ->hide('#basic_settings')
 109     ->after('#basic_settings', $html)
 110     ->render($self);
 111 }
 112
 113 sub action_ajax_show_time_and_cost_estimate {
 114   my ($self) = @_;
 115
 116   $self->render('requirement_spec/_show_time_and_cost_estimate', { layout => 0 });
 117 }
 118
 119 sub action_ajax_edit_time_and_cost_estimate {
 120   my ($self) = @_;
 121
 122   my $html   = $self->render('requirement_spec/_edit_time_and_cost_estimate', { output => 0 });
 123   my $first  = ($self->requirement_spec->sections_sorted || [])->[0];
 124   $first     = ($first->children_sorted || [])->[0] if $first;
 125
 126   $self->js
 127    ->hide('#time_cost_estimate')
 128    ->after('#time_cost_estimate', $html)
 129    ->on('#time_cost_estimate INPUT[type=text]', 'keydown', 'kivi.requirement_spec.time_cost_estimate_input_key_down')
 130    ->action_if($first && $first->id, 'focus', '#time_and_cost_estimate_form_complexity_id_' . $first->id)
 131    ->render($self);
 132 }
 133
 134 sub action_ajax_save_time_and_cost_estimate {
 135   my ($self) = @_;
 136
 137   $self->requirement_spec->db->do_transaction(sub {
 138     # Make Emacs happy
 139     1;
 140     foreach my $attributes (@{ $::form->{requirement_spec_items} || [] }) {
 141       SL::DB::RequirementSpecItem
 142         ->new(id => delete $attributes->{id})
 143         ->load
 144         ->update_attributes(%{ $attributes });
 145     }
 146
 147     1;
 148   });
 149
 150   $self->requirement_spec(SL::DB::RequirementSpec->new(id => $self->requirement_spec->id)->load);
 151
 152   my $html = $self->render('requirement_spec/_show_time_and_cost_estimate', { output => 0 }, initially_hidden => !!$::form->{keep_open});
 153   $self->js->replaceWith('#time_cost_estimate', $html);
 154
 155   return $self->js->render($self) if $::form->{keep_open};
 156
 157   $self->js->remove('#time_cost_estimate_form_container');
 158
 159   if ($self->visible_section) {
 160     $html = $self->render('requirement_spec_item/_section', { output => 0 }, requirement_spec_item => $self->visible_section);
 161     $self->js->html('#column-content', $html);
 162   }
 163
 164   $self->js->render($self);
 165 }
 166
 167 sub action_show {
 168   my ($self) = @_;
 169
 170   my $title  = $self->requirement_spec->is_template ? t8('Show requirement spec template') : t8('Show requirement spec');
 171   my $item   = $::form->{requirement_spec_item_id} ? SL::DB::RequirementSpecItem->new(id => $::form->{requirement_spec_item_id})->load : @{ $self->requirement_spec->sections }[0];
 172   $self->requirement_spec_item($item);
 173
 174   $self->render('requirement_spec/show', title => $title);
 175 }
 176
 177 sub action_create {
 178   my ($self) = @_;
 179
 180   $self->requirement_spec(SL::DB::RequirementSpec->new);
 181   $self->create_or_update;
 182 }
 183
 184 sub action_update {
 185   my ($self) = @_;
 186   $self->create_or_update;
 187 }
 188
 189 sub action_destroy {
 190   my ($self) = @_;
 191
 192   if (eval { $self->requirement_spec->delete; 1; }) {
 193     flash_later('info',  t8('The requirement spec has been deleted.'));
 194   } else {
 195     flash_later('error', t8('The requirement spec is in use and cannot be deleted.'));
 196   }
 197
 198   $self->redirect_to(action => 'list');
 199 }
 200
 201 sub action_revert_to {
 202   my ($self, %params) = @_;
 203
 204   return $self->js->error(t8('Cannot revert a versioned copy.'))->render($self) if $self->requirement_spec->working_copy_id;
 205
 206   my $versioned_copy = SL::DB::RequirementSpec->new(id => $::form->{versioned_copy_id})->load;
 207
 208   $self->requirement_spec->copy_from($versioned_copy);
 209   my $version = $versioned_copy->versions->[0];
 210   $version->update_attributes(working_copy_id => $self->requirement_spec->id);
 211
 212   flash_later('info', t8('The requirement spec has been reverted to version #1.', $self->requirement_spec->version->version_number));
 213   $self->js->redirect_to($self->url_for(action => 'show', id => $self->requirement_spec->id))->render($self);
 214 }
 215
 216 sub action_create_pdf {
 217   my ($self, %params) = @_;
 218
 219   my $base_name       = $self->requirement_spec->type->template_file_name || 'requirement_spec';
 220   my @pictures        = $self->prepare_pictures_for_printing;
 221   my %result          = SL::Template::LaTeX->parse_and_create_pdf("${base_name}.tex", SELF => $self, rspec => $self->requirement_spec);
 222
 223   unlink @pictures unless ($::lx_office_conf{debug} || {})->{keep_temp_files};
 224
 225   $::form->error(t8('Conversion to PDF failed: #1', $result{error})) if $result{error};
 226
 227   my $attachment_name  =  $self->requirement_spec->type->description . ' ' . ($self->requirement_spec->working_copy_id || $self->requirement_spec->id);
 228   $attachment_name    .=  ' (v' . $self->requirement_spec->version->version_number . ')' if $self->requirement_spec->version;
 229   $attachment_name    .=  '.pdf';
 230   $attachment_name     =~ s/[^\wäöüÄÖÜß \-\+\(\)\[\]\{\}\.,]+/_/g;
 231
 232   $self->send_file($result{file_name}, type => 'application/pdf', name => $attachment_name);
 233   unlink $result{file_name};
 234 }
 235
 236 sub action_select_template_to_paste {
 237   my ($self) = @_;
 238
 239   my @templates = grep { @{ $_->sections } || @{ $_->text_blocks } } @{ SL::DB::Manager::RequirementSpec->get_all(where => [ is_template => 1 ], sort_by => 'lower(title)') };
 240   $self->render('requirement_spec/select_template_to_paste', { layout => 0 }, TEMPLATES => \@templates);
 241 }
 242
 243 sub action_paste_template {
 244   my ($self, %params) = @_;
 245
 246   my $template = SL::DB::RequirementSpec->new(id => $::form->{template_id})->load;
 247   my %result   = $self->requirement_spec->paste_template($template);
 248
 249   return $self->js->error($self->requirement_spec->error)->render($self) if !%result;
 250
 251   $self->render_pasted_text_block($_) for sort { $a->position <=> $b->position } @{ $result{text_blocks} };
 252   $self->render_pasted_section($_)    for sort { $a->position <=> $b->position } @{ $result{sections}    };
 253
 254   if (@{ $result{sections} } && (($::form->{current_content_type} || 'sections') eq 'sections') && !$::form->{current_content_id}) {
 255     $self->render_first_pasted_section_as_list($result{sections}->[0]);
 256   }
 257
 258   $self->invalidate_version->render($self);
 259 }
 260
 261 #
 262 # filters
 263 #
 264
 265 sub setup {
 266   my ($self) = @_;
 267
 268   $::auth->assert('sales_quotation_edit');
 269   $::request->{layout}->use_stylesheet("${_}.css") for qw(jquery.contextMenu requirement_spec);
 270   $::request->{layout}->use_javascript("${_}.js")  for qw(jquery.jstree jquery/jquery.contextMenu jquery/jquery.hotkeys requirement_spec ckeditor/ckeditor ckeditor/adapters/jquery);
 271   $self->init_visible_section;
 272
 273   return 1;
 274 }
 275
 276 sub init_complexities {
 277   my ($self) = @_;
 278   return SL::DB::Manager::RequirementSpecComplexity->get_all_sorted;
 279 }
 280
 281 sub init_risks {
 282   my ($self) = @_;
 283   return SL::DB::Manager::RequirementSpecRisk->get_all_sorted;
 284 }
 285
 286 sub init_projects {
 287   my ($self) = @_;
 288   $self->projects(SL::DB::Manager::Project->get_all_sorted);
 289 }
 290
 291 sub init_requirement_spec {
 292   my ($self) = @_;
 293   $self->requirement_spec(SL::DB::RequirementSpec->new(id => $::form->{id})->load || die "No such requirement spec") if $::form->{id};
 294 }
 295
 296 sub init_copy_source {
 297   my ($self) = @_;
 298   $self->copy_source(SL::DB::RequirementSpec->new(id => $::form->{copy_source_id})->load) if $::form->{copy_source_id};
 299 }
 300
 301 sub init_js {
 302   my ($self) = @_;
 303   $self->js(SL::ClientJS->new);
 304 }
 305
 306 sub init_current_text_block_output_position {
 307   my ($self) = @_;
 308   $self->current_text_block_output_position($::form->{current_content_type} !~ m/^(?:text-blocks|tb)-(front|back)/ ? -1 : $1 eq 'front' ? 0 : 1);
 309 }
 310
 311 sub load_select_options {
 312   my ($self) = @_;
 313
 314   my @filter = ('!obsolete' => 1);
 315   @filter    = ( or => [ @filter, id => $self->requirement_spec->customer_id ] ) if $self->requirement_spec && $self->requirement_spec->customer_id;
 316
 317   $self->customers(SL::DB::Manager::Customer->get_all_sorted(where => \@filter));
 318   $self->statuses( SL::DB::Manager::RequirementSpecStatus->get_all_sorted);
 319   $self->types(    SL::DB::Manager::RequirementSpecType->get_all_sorted);
 320 }
 321
 322 #
 323 # helpers
 324 #
 325
 326 sub create_or_update {
 327   my $self   = shift;
 328   my $is_new = !$self->requirement_spec->id;
 329   my $params = delete($::form->{requirement_spec}) || { };
 330
 331   $self->requirement_spec->assign_attributes(%{ $params });
 332
 333   my $title  = $is_new && $self->requirement_spec->is_template ? t8('Create a new requirement spec template')
 334              : $is_new                                         ? t8('Create a new requirement spec')
 335              :            $self->requirement_spec->is_template ? t8('Edit requirement spec template')
 336              :                                                   t8('Edit requirement spec');
 337
 338   my @errors = $self->requirement_spec->validate;
 339
 340   if (@errors) {
 341     return $self->js->error(@errors)->render($self) if $::request->is_ajax;
 342
 343     flash('error', @errors);
 344     $self->render('requirement_spec/new', title => $title);
 345     return;
 346   }
 347
 348   my $db = $self->requirement_spec->db;
 349   if (!$db->do_transaction(sub {
 350     if ($self->copy_source) {
 351       $self->requirement_spec($self->copy_source->create_copy(%{ $params }));
 352     } else {
 353       $self->requirement_spec->save;
 354     }
 355   })) {
 356     $::lxdebug->message(LXDebug::WARN(), "Error: " . $db->error);
 357     @errors = ($::locale->text('Saving failed. Error message from the database: #1', $db->error));
 358     return $self->js->error(@errors)->render($self) if $::request->is_ajax;
 359
 360     $self->requirement_spec->id(undef) if $is_new;
 361     flash('error', @errors);
 362     return $self->render('requirement_spec/new', title => $title);
 363   }
 364
 365   my $info = $self->requirement_spec->is_template ? t8('The requirement spec template has been saved.') : t8('The requirement spec has been saved.');
 366
 367   if ($::request->is_ajax) {
 368     my $header_html = $self->render('requirement_spec/_header', { output => 0 });
 369     my $basics_html = $self->render('requirement_spec/_show_basic_settings', { output => 0 });
 370     return $self->invalidate_version
 371       ->replaceWith('#requirement-spec-header', $header_html)
 372       ->replaceWith('#basic_settings',          $basics_html)
 373       ->remove('#basic_settings_form')
 374       ->flash('info', $info)
 375       ->render($self);
 376   }
 377
 378   flash_later('info', $info);
 379   $self->redirect_to(action => 'show', id => $self->requirement_spec->id);
 380 }
 381
 382 sub prepare_report {
 383   my ($self)      = @_;
 384
 385   my $callback    = $self->get_callback;
 386
 387   my $is_template = $::form->{is_template};
 388   my $report      = SL::ReportGenerator->new(\%::myconfig, $::form);
 389   $self->{report} = $report;
 390
 391   my @columns     = $is_template ? qw(title mtime) : qw(title customer status type projectnumber mtime version);
 392   my @sortable    = $is_template ? qw(title mtime) : qw(title customer status type projectnumber mtime);
 393
 394   my %column_defs = (
 395     title         => { obj_link => sub { $self->url_for(action => 'show', id => $_[0]->id, callback => $callback) } },
 396     mtime         => { sub      => sub { ($_[0]->mtime || $_[0]->itime)->to_kivitendo(precision => 'minute') } },
 397   );
 398
 399   if (!$is_template) {
 400     %column_defs = (
 401       %column_defs,
 402       customer      => { raw_data => sub { $self->presenter->customer($_[0]->customer, display => 'table-cell', callback => $callback) },
 403                          sub      => sub { $_[0]->customer->name } },
 404       projectnumber => { raw_data => sub { $self->presenter->project($_[0]->project, display => 'table-cell', callback => $callback) },
 405                          sub      => sub { $_[0]->project_id ? $_[0]->project->projectnumber : '' } },
 406       status        => { sub      => sub { $_[0]->status->description } },
 407       type          => { sub      => sub { $_[0]->type->description } },
 408       version       => { sub      => sub { $_[0]->version ? $_[0]->version->version_number : t8('Working copy without version') } },
 409     );
 410   }
 411
 412   map { $column_defs{$_}->{text} ||= $::locale->text( $self->get_sort_spec->{$_}->{title} ) } keys %column_defs;
 413
 414   $report->set_options(
 415     std_column_visibility => 1,
 416     controller_class      => 'RequirementSpec',
 417     output_format         => 'HTML',
 418     raw_top_info_text     => $self->render('requirement_spec/report_top',    { output => 0 }, is_template => $is_template),
 419     raw_bottom_info_text  => $self->render('requirement_spec/report_bottom', { output => 0 }),
 420     title                 => $is_template ? t8('Requirement Spec Templates') : t8('Requirement Specs'),
 421     allow_pdf_export      => 1,
 422     allow_csv_export      => 1,
 423   );
 424   $report->set_columns(%column_defs);
 425   $report->set_column_order(@columns);
 426   $report->set_export_options(qw(list filter));
 427   $report->set_options_from_form;
 428   $self->set_report_generator_sort_options(report => $report, sortable_columns => \@sortable);
 429
 430   $self->disable_pagination if $report->{options}{output_format} =~ /^(pdf|csv)$/i;
 431 }
 432
 433 sub invalidate_version {
 434   my ($self) = @_;
 435
 436   my $rspec  = SL::DB::RequirementSpec->new(id => $self->requirement_spec->id)->load;
 437   return $self->js if $rspec->is_template;
 438
 439   $rspec->invalidate_version;
 440
 441   my $html = $self->render('requirement_spec/_version', { output => 0 }, requirement_spec => $rspec);
 442   return $self->js->html('#requirement_spec_version', $html);
 443 }
 444
 445 sub render_pasted_text_block {
 446   my ($self, $text_block, %params) = @_;
 447
 448   if ($self->current_text_block_output_position == $text_block->output_position) {
 449     my $html = $self->render('requirement_spec_text_block/_text_block', { output => 0 }, text_block => $text_block);
 450     $self->js
 451       ->appendTo($html, '#text-block-list')
 452       ->hide('#text-block-list-empty');
 453   }
 454
 455   my $node       = $self->presenter->requirement_spec_text_block_jstree_data($text_block);
 456   my $front_back = $text_block->output_position == 0 ? 'front' : 'back';
 457   $self->js
 458     ->jstree->create_node('#tree', "#tb-${front_back}", 'last', $node)
 459     ->jstree->open_node(  '#tree', "#tb-${front_back}");
 460 }
 461
 462 sub render_pasted_section {
 463   my ($self, $item, $parent_id) = @_;
 464
 465   my $node = $self->presenter->requirement_spec_item_jstree_data($item);
 466   $self->js
 467     ->jstree->create_node('#tree', $parent_id ? "#fb-${parent_id}" : '#sections', 'last', $node)
 468     ->jstree->open_node(  '#tree', $parent_id ? "#fb-${parent_id}" : '#sections');
 469
 470   $self->render_pasted_section($_, $item->id) for @{ $item->children_sorted };
 471 }
 472
 473 sub render_first_pasted_section_as_list {
 474   my ($self, $section, %params) = @_;
 475
 476   my $html = $self->render('requirement_spec_item/_section', { output => 0 }, requirement_spec_item => $section);
 477   $self->js
 478     ->html('#column-content', $html)
 479     ->val( '#current_content_type', $section->item_type)
 480     ->val( '#current_content_id',   $section->id)
 481     ->jstree->select_node('#tree', '#fb-' . $section->id);
 482 }
 483
 484 sub prepare_pictures_for_printing {
 485   my ($self) = @_;
 486
 487   my @files;
 488   my $userspath = File::Spec->rel2abs($::lx_office_conf{paths}->{userspath});
 489   my $target    =  "${userspath}/kivitendo-print-requirement-spec-picture-" . Common::unique_id() . '-';
 490
 491   foreach my $picture (map { @{ $_->pictures } } @{ $self->requirement_spec->text_blocks }) {
 492     my $output_file_name        = $target . $picture->id . '.' . $picture->get_default_file_name_extension;
 493     $picture->{print_file_name} = File::Spec->abs2rel($output_file_name, $userspath);
 494     my $out                     = IO::File->new($output_file_name, 'w') || die("Could not create file " . $output_file_name);
 495     $out->binmode;
 496     $out->print($picture->picture_content);
 497     $out->close;
 498
 499     push @files, $output_file_name;
 500   }
 501
 502   return @files;
 503 }
 504
 505 1;