1 package SL::Controller::RequirementSpec;
6 use parent qw(SL::Controller::Base);
12 use SL::Controller::Helper::GetModels;
13 use SL::Controller::Helper::ReportGenerator;
14 use SL::Controller::Helper::RequirementSpec;
17 use SL::DB::ProjectStatus;
18 use SL::DB::ProjectType;
19 use SL::DB::RequirementSpecComplexity;
20 use SL::DB::RequirementSpecRisk;
21 use SL::DB::RequirementSpecStatus;
22 use SL::DB::RequirementSpecType;
23 use SL::DB::RequirementSpec;
24 use SL::Helper::Flash;
25 use SL::Locale::String;
26 use SL::Template::LaTeX;
28 use Rose::Object::MakeMethods::Generic
30 scalar => [ qw(requirement_spec_item visible_item visible_section) ],
31 'scalar --get_set_init' => [ qw(requirement_spec customers types statuses complexities risks projects project_types project_statuses default_project_type default_project_status copy_source js
32 current_text_block_output_position models time_based_units) ],
35 __PACKAGE__->run_before('setup');
36 __PACKAGE__->run_before('set_default_filter_args', only => [ qw(list) ]);
39 customer => t8('Customer'),
41 type => t8('Requirement Spec Type'),
42 status => t8('Requirement Spec Status'),
43 projectnumber => t8('Project Number'),
44 version => t8('Version'),
45 mtime => t8('Last modification'),
56 $self->prepare_report;
57 $self->report_generator_list_objects(report => $self->{report}, objects => $self->models->get);
63 $self->requirement_spec(SL::DB::RequirementSpec->new(is_template => $::form->{is_template}));
65 if ($self->copy_source) {
66 $self->requirement_spec->$_($self->copy_source->$_) for qw(type_id status_id customer_id title hourly_rate is_template)
69 $self->render('requirement_spec/new', title => $self->requirement_spec->is_template ? t8('Create a new requirement spec template') : t8('Create a new requirement spec'));
72 sub action_ajax_show_basic_settings {
75 $self->render('requirement_spec/_show_basic_settings', { layout => 0 });
78 sub action_ajax_edit {
81 my $html = $self->render('requirement_spec/_form', { output => 0 }, submit_as => 'ajax');
84 ->hide('#basic_settings')
85 ->after('#basic_settings', $html)
89 sub action_ajax_edit_project_link {
92 my $html = $self->render('requirement_spec/_project_link_form', { output => 0 }, submit_as => 'ajax');
95 ->hide('#basic_settings')
96 ->after('#basic_settings', $html)
100 sub action_ajax_show_time_and_cost_estimate {
103 $self->render('requirement_spec/_show_time_and_cost_estimate', { layout => 0 });
106 sub action_ajax_edit_time_and_cost_estimate {
109 my $html = $self->render('requirement_spec/_edit_time_and_cost_estimate', { output => 0 });
110 my $first = ($self->requirement_spec->sections_sorted || [])->[0];
111 $first = ($first->children_sorted || [])->[0] if $first;
114 ->hide('#time_cost_estimate')
115 ->after('#time_cost_estimate', $html)
116 ->on('#time_cost_estimate INPUT[type=text]', 'keydown', 'kivi.requirement_spec.time_cost_estimate_input_key_down')
117 ->action_if($first && $first->id, 'focus', '#time_and_cost_estimate_form_complexity_id_' . $first->id)
121 sub action_ajax_save_time_and_cost_estimate {
124 $self->requirement_spec->db->do_transaction(sub {
127 foreach my $attributes (@{ $::form->{requirement_spec_items} || [] }) {
128 SL::DB::RequirementSpecItem
129 ->new(id => delete $attributes->{id})
131 ->update_attributes(%{ $attributes });
137 $self->requirement_spec(SL::DB::RequirementSpec->new(id => $self->requirement_spec->id)->load);
139 my $html = $self->render('requirement_spec/_show_time_and_cost_estimate', { output => 0 }, initially_hidden => !!$::form->{keep_open});
140 $self->js->replaceWith('#time_cost_estimate', $html);
142 return $self->js->render($self) if $::form->{keep_open};
144 $self->js->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_sorted }[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;
176 sub action_update_project_link {
178 my $action = delete($::form->{project_link_action}) || 'keep';
180 return $self->update_project_link_none_keep_existing($action) if $action =~ m{none|keep|existing};
181 return $self->update_project_link_new($action) if $action eq 'new';
182 return $self->update_project_link_create($action) if $action eq 'create';
184 die "Unknown project link action '$action'";
190 if (eval { $self->requirement_spec->delete; 1; }) {
191 flash_later('info', t8('The requirement spec has been deleted.'));
193 flash_later('error', t8('The requirement spec is in use and cannot be deleted.'));
196 $self->redirect_to(action => 'list');
199 sub action_revert_to {
200 my ($self, %params) = @_;
202 return $self->js->error(t8('Cannot revert a versioned copy.'))->render($self) if $self->requirement_spec->working_copy_id;
204 my $versioned_copy = SL::DB::RequirementSpec->new(id => $::form->{versioned_copy_id})->load;
206 $self->requirement_spec->copy_from($versioned_copy);
207 my $version = $versioned_copy->versions->[0];
208 $version->update_attributes(working_copy_id => $self->requirement_spec->id);
210 flash_later('info', t8('The requirement spec has been reverted to version #1.', $self->requirement_spec->version->version_number));
211 $self->js->redirect_to($self->url_for(action => 'show', id => $self->requirement_spec->id))->render($self);
214 sub action_create_pdf {
215 my ($self, %params) = @_;
217 my $base_name = $self->requirement_spec->type->template_file_name || 'requirement_spec';
218 my @pictures = $self->prepare_pictures_for_printing;
219 my %result = SL::Template::LaTeX->parse_and_create_pdf("${base_name}.tex", SELF => $self, rspec => $self->requirement_spec);
221 unlink @pictures unless ($::lx_office_conf{debug} || {})->{keep_temp_files};
223 $::form->error(t8('Conversion to PDF failed: #1', $result{error})) if $result{error};
225 my $attachment_name = $self->requirement_spec->type->description . ' ' . ($self->requirement_spec->working_copy_id || $self->requirement_spec->id);
226 $attachment_name .= ' (v' . $self->requirement_spec->version->version_number . ')' if $self->requirement_spec->version;
227 $attachment_name .= '.pdf';
228 $attachment_name =~ s/[^\wäöüÄÖÜß \-\+\(\)\[\]\{\}\.,]+/_/g;
230 $self->send_file($result{file_name}, type => 'application/pdf', name => $attachment_name);
231 unlink $result{file_name};
234 sub action_select_template_to_paste {
237 my @templates = @{ SL::DB::Manager::RequirementSpec->get_all(
238 where => [ is_template => 1, SL::DB::Manager::RequirementSpec->not_empty_filter ],
239 sort_by => 'lower(requirement_specs.title)',
241 $self->render('requirement_spec/select_template_to_paste', { layout => 0 }, TEMPLATES => \@templates);
244 sub action_paste_template {
245 my ($self, %params) = @_;
247 my $template = SL::DB::RequirementSpec->new(id => $::form->{template_id})->load;
248 my %result = $self->requirement_spec->paste_template($template);
250 return $self->js->error($self->requirement_spec->error)->render($self) if !%result;
252 $self->render_pasted_text_block($_) for sort { $a->position <=> $b->position } @{ $result{text_blocks} };
253 $self->render_pasted_section($_) for sort { $a->position <=> $b->position } @{ $result{sections} };
255 if (@{ $result{sections} } && (($::form->{current_content_type} || 'sections') eq 'sections') && !$::form->{current_content_id}) {
256 $self->render_first_pasted_section_as_list($result{sections}->[0]);
259 my $parts_list = $self->render('requirement_spec_part/show', { output => 0 });
261 ->replaceWith('#additional_parts_list_container', $parts_list)
262 ->show( '#additional_parts_list_container')
263 ->remove( '#additional_parts_form_container');
265 $self->invalidate_version->render($self);
275 $::auth->assert('requirement_spec_edit');
276 $::request->{layout}->use_stylesheet("${_}.css") for qw(jquery.contextMenu requirement_spec);
277 $::request->{layout}->use_javascript("${_}.js") for qw(jquery.jstree jquery/jquery.contextMenu jquery/jquery.hotkeys requirement_spec ckeditor/ckeditor ckeditor/adapters/jquery);
278 $self->init_visible_section;
283 sub init_js { SL::ClientJS->new }
284 sub init_complexities { SL::DB::Manager::RequirementSpecComplexity->get_all_sorted }
285 sub init_default_project_status { SL::DB::Manager::ProjectStatus->find_by(name => 'planning') }
286 sub init_default_project_type { SL::DB::ProjectType->new(id => 1)->load }
287 sub init_project_statuses { SL::DB::Manager::ProjectStatus->get_all_sorted }
288 sub init_project_types { SL::DB::Manager::ProjectType->get_all_sorted }
289 sub init_projects { SL::DB::Manager::Project->get_all_sorted }
290 sub init_risks { SL::DB::Manager::RequirementSpecRisk->get_all_sorted }
291 sub init_statuses { SL::DB::Manager::RequirementSpecStatus->get_all_sorted }
292 sub init_time_based_units { SL::DB::Manager::Unit->time_based_units }
293 sub init_types { SL::DB::Manager::RequirementSpecType->get_all_sorted }
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 return SL::DB::Manager::Customer->get_all_sorted(where => \@filter);
304 sub init_requirement_spec {
306 $self->requirement_spec(SL::DB::RequirementSpec->new(id => $::form->{id})->load || die "No such requirement spec") if $::form->{id};
309 sub init_copy_source {
311 $self->copy_source(SL::DB::RequirementSpec->new(id => $::form->{copy_source_id})->load) if $::form->{copy_source_id};
314 sub init_current_text_block_output_position {
316 $self->current_text_block_output_position($::form->{current_content_type} !~ m/^(?:text-blocks|tb)-(front|back)/ ? -1 : $1 eq 'front' ? 0 : 1);
323 sub create_or_update {
325 my $is_new = !$self->requirement_spec->id;
326 my $params = delete($::form->{requirement_spec}) || { };
328 $self->requirement_spec->assign_attributes(%{ $params });
330 my $title = $is_new && $self->requirement_spec->is_template ? t8('Create a new requirement spec template')
331 : $is_new ? t8('Create a new requirement spec')
332 : $self->requirement_spec->is_template ? t8('Edit requirement spec template')
333 : t8('Edit requirement spec');
335 my @errors = $self->requirement_spec->validate;
338 return $self->js->error(@errors)->render($self) if $::request->is_ajax;
340 flash('error', @errors);
341 $self->render('requirement_spec/new', title => $title);
345 my $db = $self->requirement_spec->db;
346 if (!$db->do_transaction(sub {
347 if ($self->copy_source) {
348 $self->requirement_spec($self->copy_source->create_copy(%{ $params }));
350 $self->requirement_spec->save;
353 $::lxdebug->message(LXDebug::WARN(), "Error: " . $db->error);
354 @errors = ($::locale->text('Saving failed. Error message from the database: #1', $db->error));
355 return $self->js->error(@errors)->render($self) if $::request->is_ajax;
357 $self->requirement_spec->id(undef) if $is_new;
358 flash('error', @errors);
359 return $self->render('requirement_spec/new', title => $title);
362 my $info = $self->requirement_spec->is_template ? t8('The requirement spec template has been saved.') : t8('The requirement spec has been saved.');
364 if ($::request->is_ajax) {
365 my $header_html = $self->render('requirement_spec/_header', { output => 0 });
366 my $basics_html = $self->render('requirement_spec/_show_basic_settings', { output => 0 });
367 return $self->invalidate_version
368 ->replaceWith('#requirement-spec-header', $header_html)
369 ->replaceWith('#basic_settings', $basics_html)
370 ->remove('#basic_settings_form')
371 ->flash('info', $info)
375 flash_later('info', $info);
376 $self->redirect_to(action => 'show', id => $self->requirement_spec->id);
382 my $is_template = $::form->{is_template};
383 my $report = SL::ReportGenerator->new(\%::myconfig, $::form);
385 $self->models->disable_plugin('paginated') if $report->{options}{output_format} =~ /^(pdf|csv)$/i;
386 $self->models->finalize; # for filter laundering
387 my $callback = $self->models->get_callback;
389 $self->{report} = $report;
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);
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') } },
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') } },
412 map { $column_defs{$_}->{text} ||= $::locale->text( $self->models->get_sort_spec->{$_}->{title} ) } keys %column_defs;
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 }, models => $self->models),
420 title => $is_template ? t8('Requirement Spec Templates') : t8('Requirement Specs'),
421 allow_pdf_export => 1,
422 allow_csv_export => 1,
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->models->set_report_generator_sort_options(report => $report, sortable_columns => \@sortable);
431 sub invalidate_version {
434 my $rspec = SL::DB::RequirementSpec->new(id => $self->requirement_spec->id)->load;
435 return $self->js if $rspec->is_template;
437 $rspec->invalidate_version;
439 my $html = $self->render('requirement_spec/_version', { output => 0 }, requirement_spec => $rspec);
440 return $self->js->html('#requirement_spec_version', $html);
443 sub render_pasted_text_block {
444 my ($self, $text_block, %params) = @_;
446 if ($self->current_text_block_output_position == $text_block->output_position) {
447 my $html = $self->render('requirement_spec_text_block/_text_block', { output => 0 }, text_block => $text_block);
449 ->appendTo($html, '#text-block-list')
450 ->hide('#text-block-list-empty');
453 my $node = $self->presenter->requirement_spec_text_block_jstree_data($text_block);
454 my $front_back = $text_block->output_position == 0 ? 'front' : 'back';
456 ->jstree->create_node('#tree', "#tb-${front_back}", 'last', $node)
457 ->jstree->open_node( '#tree', "#tb-${front_back}");
460 sub set_default_filter_args {
463 if (!$::form->{filter} && !$::form->{is_template}) {
464 $::form->{filter} = {
465 status_id => [ map { $_->{id} } grep { $_->name ne 'done' } @{ $self->statuses } ],
472 sub render_pasted_section {
473 my ($self, $item, $parent_id) = @_;
475 my $node = $self->presenter->requirement_spec_item_jstree_data($item);
477 ->jstree->create_node('#tree', $parent_id ? "#fb-${parent_id}" : '#sections', 'last', $node)
478 ->jstree->open_node( '#tree', $parent_id ? "#fb-${parent_id}" : '#sections');
480 $self->render_pasted_section($_, $item->id) for @{ $item->children_sorted };
483 sub render_first_pasted_section_as_list {
484 my ($self, $section, %params) = @_;
486 my $html = $self->render('requirement_spec_item/_section', { output => 0 }, requirement_spec_item => $section);
488 ->html('#column-content', $html)
489 ->val( '#current_content_type', $section->item_type)
490 ->val( '#current_content_id', $section->id)
491 ->jstree->select_node('#tree', '#fb-' . $section->id);
494 sub prepare_pictures_for_printing {
498 my $userspath = File::Spec->rel2abs($::lx_office_conf{paths}->{userspath});
499 my $target = "${userspath}/kivitendo-print-requirement-spec-picture-" . Common::unique_id() . '-';
501 foreach my $picture (map { @{ $_->pictures } } @{ $self->requirement_spec->text_blocks }) {
502 my $output_file_name = $target . $picture->id . '.' . $picture->get_default_file_name_extension;
503 $picture->{print_file_name} = File::Spec->abs2rel($output_file_name, $userspath);
504 my $out = IO::File->new($output_file_name, 'w') || die("Could not create file " . $output_file_name);
506 $out->print($picture->picture_content);
509 push @files, $output_file_name;
515 sub update_project_link_none_keep_existing {
516 my ($self, $action) = @_;
518 $self->requirement_spec->update_attributes(project_id => undef) if $action eq 'none';
519 $self->requirement_spec->update_attributes(project_id => $::form->{new_project_id}) if $action eq 'existing';
521 return $self->invalidate_version
522 ->replaceWith('#basic_settings', $self->render('requirement_spec/_show_basic_settings', { output => 0 }))
523 ->remove('#project_link_form')
524 ->flash('info', t8('The project link has been updated.'))
528 sub update_project_link_new {
532 ->replaceWith('#project_link_form', $self->render('requirement_spec/_new_project_form', { output => 0 }))
536 sub update_project_link_create {
538 my $params = delete($::form->{project}) || {};
539 my $project = SL::DB::Project->new(
545 my @errors = $project->validate;
547 return $self->js->error(@errors)->render($self) if @errors;
549 my $db = $self->requirement_spec->db;
550 if (!$db->do_transaction(sub {
552 $self->requirement_spec->update_attributes(project_id => $project->id);
555 $::lxdebug->message(LXDebug::WARN(), "Error: " . $db->error);
556 return $self->js->error(t8('Saving failed. Error message from the database: #1', $db->error))->render($self);
559 return $self->invalidate_version
560 ->replaceWith('#basic_settings', $self->render('requirement_spec/_show_basic_settings', { output => 0 }))
561 ->remove('#project_link_form')
562 ->flash('info', t8('The project has been created.'))
563 ->flash('info', t8('The project link has been updated.'))
570 SL::Controller::Helper::GetModels->new(
581 working_copy_id => undef,
582 is_template => $::form->{is_template} ? 1 : 0,
585 with_objects => [ 'customer', 'type', 'status', 'project' ],