1 package SL::Controller::RequirementSpec;
6 use parent qw(SL::Controller::Base);
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;
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;
26 use Rose::Object::MakeMethods::Generic
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 current_text_block_output_position) ],
32 __PACKAGE__->run_before('setup');
33 __PACKAGE__->run_before('load_select_options', only => [ qw(new ajax_edit create update list) ]);
36 __PACKAGE__->get_models_url_params('flat_filter');
37 __PACKAGE__->make_paginated(
38 MODEL => 'RequirementSpec',
39 PAGINATE_ARGS => 'db_args',
43 __PACKAGE__->make_sorted(
44 MODEL => 'RequirementSpec',
47 DEFAULT_BY => 'customer',
50 customer => t8('Customer'),
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'),
67 $self->setup_db_args_from_filter;
68 $self->flat_filter({ map { $_->{key} => $_->{value} } $::form->flatten_variables('filter') });
70 $self->prepare_report;
72 my $requirement_specs = $self->get_models(%{ $self->db_args });
74 $self->report_generator_list_objects(report => $self->{report}, objects => $requirement_specs);
80 $self->requirement_spec(SL::DB::RequirementSpec->new(is_template => $::form->{is_template}));
82 if ($self->copy_source) {
83 $self->requirement_spec->$_($self->copy_source->$_) for qw(type_id status_id customer_id title hourly_rate)
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'));
89 sub action_ajax_show_basic_settings {
92 $self->render('requirement_spec/_show_basic_settings', { layout => 0 });
95 sub action_ajax_edit {
98 my $html = $self->render('requirement_spec/_form', { output => 0 }, submit_as => 'ajax');
101 ->hide('#basic_settings')
102 ->after('#basic_settings', $html)
106 sub action_ajax_show_time_and_cost_estimate {
109 $self->render('requirement_spec/_show_time_and_cost_estimate', { layout => 0 });
112 sub action_ajax_edit_time_and_cost_estimate {
115 my $html = $self->render('requirement_spec/_edit_time_and_cost_estimate', { output => 0 });
118 ->hide('#time_cost_estimate')
119 ->after('#time_cost_estimate', $html)
120 ->on('#time_cost_estimate INPUT[type=text]', 'keydown', 'kivi.requirement_spec.time_cost_estimate_input_key_down')
124 sub action_ajax_save_time_and_cost_estimate {
127 $self->requirement_spec->db->do_transaction(sub {
130 foreach my $attributes (@{ $::form->{requirement_spec_items} || [] }) {
131 SL::DB::RequirementSpecItem
132 ->new(id => delete $attributes->{id})
134 ->update_attributes(%{ $attributes });
140 $self->requirement_spec(SL::DB::RequirementSpec->new(id => $self->requirement_spec->id)->load);
142 my $html = $self->render('requirement_spec/_show_time_and_cost_estimate', { output => 0 });
143 $self->js->replaceWith('#time_cost_estimate', $html)
144 ->remove('#time_cost_estimate_form_container');
146 if ($self->visible_section) {
147 $html = $self->render('requirement_spec_item/_section', { output => 0 }, requirement_spec_item => $self->visible_section);
148 $self->js->html('#column-content', $html);
151 $self->js->render($self);
157 my $title = $self->requirement_spec->is_template ? t8('Show requirement spec template') : t8('Show requirement spec');
158 my $item = $::form->{requirement_spec_item_id} ? SL::DB::RequirementSpecItem->new(id => $::form->{requirement_spec_item_id})->load : @{ $self->requirement_spec->sections }[0];
159 $self->requirement_spec_item($item);
161 $self->render('requirement_spec/show', title => $title);
167 $self->requirement_spec(SL::DB::RequirementSpec->new);
168 $self->create_or_update;
173 $self->create_or_update;
179 if (eval { $self->requirement_spec->delete; 1; }) {
180 flash_later('info', t8('The requirement spec has been deleted.'));
182 flash_later('error', t8('The requirement spec is in use and cannot be deleted.'));
185 $self->redirect_to(action => 'list');
188 sub action_revert_to {
189 my ($self, %params) = @_;
191 return $self->js->error(t8('Cannot revert a versioned copy.'))->render($self) if $self->requirement_spec->working_copy_id;
193 my $versioned_copy = SL::DB::RequirementSpec->new(id => $::form->{versioned_copy_id})->load;
195 $self->requirement_spec->copy_from(
197 version_id => $versioned_copy->version_id,
200 flash_later('info', t8('The requirement spec has been reverted to version #1.', $self->requirement_spec->version->version_number));
201 $self->js->redirect_to($self->url_for(action => 'show', id => $self->requirement_spec->id))->render($self);
204 sub action_create_pdf {
205 my ($self, %params) = @_;
207 my %result = SL::Template::LaTeX->parse_and_create_pdf('requirement_spec.tex', SELF => $self, rspec => $self->requirement_spec);
209 $::form->error(t8('Conversion to PDF failed: #1', $result{error})) if $result{error};
211 my $attachment_name = $self->requirement_spec->type->description . ' ' . ($self->requirement_spec->working_copy_id || $self->requirement_spec->id);
212 $attachment_name .= ' (v' . $self->requirement_spec->version->version_number . ')' if $self->requirement_spec->version;
213 $attachment_name .= '.pdf';
214 $attachment_name =~ s/[^\wäöüÄÖÜß \-\+\(\)\[\]\{\}\.,]+/_/g;
216 $self->send_file($result{file_name}, type => 'application/pdf', name => $attachment_name);
217 unlink $result{file_name};
220 sub action_select_template_to_paste {
223 my @templates = grep { @{ $_->sections } || @{ $_->text_blocks } } @{ SL::DB::Manager::RequirementSpec->get_all(where => [ is_template => 1 ], sort_by => 'lower(title)') };
224 $self->render('requirement_spec/select_template_to_paste', { layout => 0 }, TEMPLATES => \@templates);
227 sub action_paste_template {
228 my ($self, %params) = @_;
230 my $template = SL::DB::RequirementSpec->new(id => $::form->{template_id})->load;
231 my %result = $self->requirement_spec->paste_template($template);
233 return $self->js->error($self->requirement_spec->error)->render($self) if !%result;
235 $self->render_pasted_text_block($_) for sort { $a->position <=> $b->position } @{ $result{text_blocks} };
236 $self->render_pasted_section($_) for sort { $a->position <=> $b->position } @{ $result{sections} };
238 if (@{ $result{sections} } && (($::form->{current_content_type} || 'sections') eq 'sections') && !$::form->{current_content_id}) {
239 $self->render_first_pasted_section_as_list($result{sections}->[0]);
242 $self->invalidate_version->render($self);
252 $::auth->assert('sales_quotation_edit');
253 $::request->{layout}->use_stylesheet("${_}.css") for qw(jquery.contextMenu requirement_spec);
254 $::request->{layout}->use_javascript("${_}.js") for qw(jquery.jstree jquery/jquery.contextMenu client_js requirement_spec);
255 $self->init_visible_section;
260 sub init_complexities {
262 return SL::DB::Manager::RequirementSpecComplexity->get_all_sorted;
267 return SL::DB::Manager::RequirementSpecRisk->get_all_sorted;
272 $self->projects(SL::DB::Manager::Project->get_all_sorted);
275 sub init_requirement_spec {
277 $self->requirement_spec(SL::DB::RequirementSpec->new(id => $::form->{id})->load || die "No such requirement spec") if $::form->{id};
280 sub init_copy_source {
282 $self->copy_source(SL::DB::RequirementSpec->new(id => $::form->{copy_source_id})->load) if $::form->{copy_source_id};
287 $self->js(SL::ClientJS->new);
290 sub init_current_text_block_output_position {
292 $self->current_text_block_output_position($::form->{current_content_type} !~ m/^(?:text-blocks|tb)-(front|back)/ ? -1 : $1 eq 'front' ? 0 : 1);
295 sub load_select_options {
298 my @filter = ('!obsolete' => 1);
299 @filter = ( or => [ @filter, id => $self->requirement_spec->customer_id ] ) if $self->requirement_spec && $self->requirement_spec->customer_id;
301 $self->customers(SL::DB::Manager::Customer->get_all_sorted(where => \@filter));
302 $self->statuses( SL::DB::Manager::RequirementSpecStatus->get_all_sorted);
303 $self->types( SL::DB::Manager::RequirementSpecType->get_all_sorted);
310 sub create_or_update {
312 my $is_new = !$self->requirement_spec->id;
313 my $params = delete($::form->{requirement_spec}) || { };
315 $self->requirement_spec->assign_attributes(%{ $params });
317 my $title = $is_new && $self->requirement_spec->is_template ? t8('Create a new requirement spec template')
318 : $is_new ? t8('Create a new requirement spec')
319 : $self->requirement_spec->is_template ? t8('Edit requirement spec template')
320 : t8('Edit requirement spec');
322 my @errors = $self->requirement_spec->validate;
325 return $self->js->error(@errors)->render($self) if $::request->is_ajax;
327 flash('error', @errors);
328 $self->render('requirement_spec/new', title => $title);
332 my $db = $self->requirement_spec->db;
333 if (!$db->do_transaction(sub {
334 if ($self->copy_source) {
335 $self->requirement_spec($self->copy_source->create_copy(%{ $params }));
337 $self->requirement_spec->save;
340 $::lxdebug->message(LXDebug::WARN(), "Error: " . $db->error);
341 @errors = ($::locale->text('Saving failed. Error message from the database: #1'), $db->error);
342 return $self->js->error(@errors)->render($self) if $::request->is_ajax;
344 $self->requirement_spec->id(undef) if $is_new;
345 flash('error', @errors);
346 return $self->render('requirement_spec/new', title => $title);
349 my $info = $self->requirement_spec->is_template ? t8('The requirement spec template has been saved.') : t8('The requirement spec has been saved.');
351 if ($::request->is_ajax) {
352 my $header_html = $self->render('requirement_spec/_header', { output => 0 });
353 my $basics_html = $self->render('requirement_spec/_show_basic_settings', { output => 0 });
354 return $self->invalidate_version
355 ->replaceWith('#requirement-spec-header', $header_html)
356 ->replaceWith('#basic_settings', $basics_html)
357 ->remove('#basic_settings_form')
358 ->flash('info', $info)
362 flash_later('info', $info);
363 $self->redirect_to(action => 'show', id => $self->requirement_spec->id);
366 sub setup_db_args_from_filter {
369 $self->{filter} = {};
370 my %args = parse_filter(
372 with_objects => [ 'customer', 'type', 'status', 'project' ],
373 launder_to => $self->{filter},
378 @{ $args{where} || [] },
379 working_copy_id => undef,
380 is_template => $::form->{is_template} ? 1 : 0,
383 $self->db_args(\%args);
389 my $callback = $self->get_callback;
391 my $is_template = $::form->{is_template};
392 my $report = SL::ReportGenerator->new(\%::myconfig, $::form);
393 $self->{report} = $report;
395 my @columns = $is_template ? qw(title mtime) : qw(title customer status type projectnumber mtime version);
396 my @sortable = $is_template ? qw(title mtime) : qw(title customer status type projectnumber mtime);
399 title => { obj_link => sub { $self->url_for(action => 'show', id => $_[0]->id, callback => $callback) } },
400 mtime => { sub => sub { ($_[0]->mtime || $_[0]->itime)->to_kivitendo(precision => 'minute') } },
406 customer => { raw_data => sub { $self->presenter->customer($_[0]->customer, display => 'table-cell', callback => $callback) },
407 sub => sub { $_[0]->customer->name } },
408 projectnumber => { raw_data => sub { $self->presenter->project($_[0]->project, display => 'table-cell', callback => $callback) },
409 sub => sub { $_[0]->project_id ? $_[0]->project->projectnumber : '' } },
410 status => { sub => sub { $_[0]->status->description } },
411 type => { sub => sub { $_[0]->type->description } },
412 version => { sub => sub { $_[0]->version_id ? $_[0]->version->version_number : t8('Working copy without version') } },
416 map { $column_defs{$_}->{text} ||= $::locale->text( $self->get_sort_spec->{$_}->{title} ) } keys %column_defs;
418 $report->set_options(
419 std_column_visibility => 1,
420 controller_class => 'RequirementSpec',
421 output_format => 'HTML',
422 raw_top_info_text => $self->render('requirement_spec/report_top', { output => 0 }, is_template => $is_template),
423 raw_bottom_info_text => $self->render('requirement_spec/report_bottom', { output => 0 }),
424 title => $is_template ? t8('Requirement Spec Templates') : t8('Requirement Specs'),
425 allow_pdf_export => 1,
426 allow_csv_export => 1,
428 $report->set_columns(%column_defs);
429 $report->set_column_order(@columns);
430 $report->set_export_options(qw(list filter));
431 $report->set_options_from_form;
432 $self->set_report_generator_sort_options(report => $report, sortable_columns => \@sortable);
434 $self->disable_pagination if $report->{options}{output_format} =~ /^(pdf|csv)$/i;
437 sub invalidate_version {
440 my $rspec = SL::DB::RequirementSpec->new(id => $self->requirement_spec->id)->load;
441 return $self->js if $rspec->is_template;
443 $rspec->invalidate_version;
445 my $html = $self->render('requirement_spec/_version', { output => 0 }, requirement_spec => $rspec);
446 return $self->js->html('#requirement_spec_version', $html);
449 sub render_pasted_text_block {
450 my ($self, $text_block, %params) = @_;
452 if ($self->current_text_block_output_position == $text_block->output_position) {
453 my $html = $self->render('requirement_spec_text_block/_text_block', { output => 0 }, text_block => $text_block);
455 ->appendTo($html, '#text-block-list')
456 ->hide('#text-block-list-empty');
459 my $node = $self->presenter->requirement_spec_text_block_jstree_data($text_block);
460 my $front_back = $text_block->output_position == 0 ? 'front' : 'back';
462 ->jstree->create_node('#tree', "#tb-${front_back}", 'last', $node)
463 ->jstree->open_node( '#tree', "#tb-${front_back}");
466 sub render_pasted_section {
467 my ($self, $item, $parent_id) = @_;
469 my $node = $self->presenter->requirement_spec_item_jstree_data($item);
471 ->jstree->create_node('#tree', $parent_id ? "#fb-${parent_id}" : '#sections', 'last', $node)
472 ->jstree->open_node( '#tree', $parent_id ? "#fb-${parent_id}" : '#sections');
474 $self->render_pasted_section($_, $item->id) for @{ $item->children_sorted };
477 sub render_first_pasted_section_as_list {
478 my ($self, $section, %params) = @_;
480 my $html = $self->render('requirement_spec_item/_section', { output => 0 }, requirement_spec_item => $section);
482 ->html('#column-content', $html)
483 ->val( '#current_content_type', $section->item_type)
484 ->val( '#current_content_id', $section->id)
485 ->jstree->select_node('#tree', '#fb-' . $section->id);