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