Pflichtenhefte: Druckvorlagendateinamen bei Pflicthenhefttypen festlegen können
[kivitendo-erp.git] / 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 current_text_block_output_position) ],
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_show_basic_settings {
90   my ($self) = @_;
91
92   $self->render('requirement_spec/_show_basic_settings', { layout => 0 });
93 }
94
95 sub action_ajax_edit {
96   my ($self) = @_;
97
98   my $html   = $self->render('requirement_spec/_form', { output => 0 }, submit_as => 'ajax');
99
100   $self->js
101     ->hide('#basic_settings')
102     ->after('#basic_settings', $html)
103     ->render($self);
104 }
105
106 sub action_ajax_show_time_and_cost_estimate {
107   my ($self) = @_;
108
109   $self->render('requirement_spec/_show_time_and_cost_estimate', { layout => 0 });
110 }
111
112 sub action_ajax_edit_time_and_cost_estimate {
113   my ($self) = @_;
114
115   my $html   = $self->render('requirement_spec/_edit_time_and_cost_estimate', { output => 0 });
116
117   $self->js
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')
121    ->render($self);
122 }
123
124 sub action_ajax_save_time_and_cost_estimate {
125   my ($self) = @_;
126
127   $self->requirement_spec->db->do_transaction(sub {
128     # Make Emacs happy
129     1;
130     foreach my $attributes (@{ $::form->{requirement_spec_items} || [] }) {
131       SL::DB::RequirementSpecItem
132         ->new(id => delete $attributes->{id})
133         ->load
134         ->update_attributes(%{ $attributes });
135     }
136
137     1;
138   });
139
140   $self->requirement_spec(SL::DB::RequirementSpec->new(id => $self->requirement_spec->id)->load);
141
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');
145
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);
149   }
150
151   $self->js->render($self);
152 }
153
154 sub action_show {
155   my ($self) = @_;
156
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);
160
161   $self->render('requirement_spec/show', title => $title);
162 }
163
164 sub action_create {
165   my ($self) = @_;
166
167   $self->requirement_spec(SL::DB::RequirementSpec->new);
168   $self->create_or_update;
169 }
170
171 sub action_update {
172   my ($self) = @_;
173   $self->create_or_update;
174 }
175
176 sub action_destroy {
177   my ($self) = @_;
178
179   if (eval { $self->requirement_spec->delete; 1; }) {
180     flash_later('info',  t8('The requirement spec has been deleted.'));
181   } else {
182     flash_later('error', t8('The requirement spec is in use and cannot be deleted.'));
183   }
184
185   $self->redirect_to(action => 'list');
186 }
187
188 sub action_revert_to {
189   my ($self, %params) = @_;
190
191   return $self->js->error(t8('Cannot revert a versioned copy.'))->render($self) if $self->requirement_spec->working_copy_id;
192
193   my $versioned_copy = SL::DB::RequirementSpec->new(id => $::form->{versioned_copy_id})->load;
194
195   $self->requirement_spec->copy_from(
196     $versioned_copy,
197     version_id => $versioned_copy->version_id,
198   );
199
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);
202 }
203
204 sub action_create_pdf {
205   my ($self, %params) = @_;
206
207   my $base_name       = $self->requirement_spec->type->template_file_name || 'requirement_spec';
208   my %result          = SL::Template::LaTeX->parse_and_create_pdf("${base_name}.tex", SELF => $self, rspec => $self->requirement_spec);
209
210   $::form->error(t8('Conversion to PDF failed: #1', $result{error})) if $result{error};
211
212   my $attachment_name  =  $self->requirement_spec->type->description . ' ' . ($self->requirement_spec->working_copy_id || $self->requirement_spec->id);
213   $attachment_name    .=  ' (v' . $self->requirement_spec->version->version_number . ')' if $self->requirement_spec->version;
214   $attachment_name    .=  '.pdf';
215   $attachment_name     =~ s/[^\wäöüÄÖÜß \-\+\(\)\[\]\{\}\.,]+/_/g;
216
217   $self->send_file($result{file_name}, type => 'application/pdf', name => $attachment_name);
218   unlink $result{file_name};
219 }
220
221 sub action_select_template_to_paste {
222   my ($self) = @_;
223
224   my @templates = grep { @{ $_->sections } || @{ $_->text_blocks } } @{ SL::DB::Manager::RequirementSpec->get_all(where => [ is_template => 1 ], sort_by => 'lower(title)') };
225   $self->render('requirement_spec/select_template_to_paste', { layout => 0 }, TEMPLATES => \@templates);
226 }
227
228 sub action_paste_template {
229   my ($self, %params) = @_;
230
231   my $template = SL::DB::RequirementSpec->new(id => $::form->{template_id})->load;
232   my %result   = $self->requirement_spec->paste_template($template);
233
234   return $self->js->error($self->requirement_spec->error)->render($self) if !%result;
235
236   $self->render_pasted_text_block($_) for sort { $a->position <=> $b->position } @{ $result{text_blocks} };
237   $self->render_pasted_section($_)    for sort { $a->position <=> $b->position } @{ $result{sections}    };
238
239   if (@{ $result{sections} } && (($::form->{current_content_type} || 'sections') eq 'sections') && !$::form->{current_content_id}) {
240     $self->render_first_pasted_section_as_list($result{sections}->[0]);
241   }
242
243   $self->invalidate_version->render($self);
244 }
245
246 #
247 # filters
248 #
249
250 sub setup {
251   my ($self) = @_;
252
253   $::auth->assert('sales_quotation_edit');
254   $::request->{layout}->use_stylesheet("${_}.css") for qw(jquery.contextMenu requirement_spec);
255   $::request->{layout}->use_javascript("${_}.js") for qw(jquery.jstree jquery/jquery.contextMenu client_js requirement_spec);
256   $self->init_visible_section;
257
258   return 1;
259 }
260
261 sub init_complexities {
262   my ($self) = @_;
263   return SL::DB::Manager::RequirementSpecComplexity->get_all_sorted;
264 }
265
266 sub init_risks {
267   my ($self) = @_;
268   return SL::DB::Manager::RequirementSpecRisk->get_all_sorted;
269 }
270
271 sub init_projects {
272   my ($self) = @_;
273   $self->projects(SL::DB::Manager::Project->get_all_sorted);
274 }
275
276 sub init_requirement_spec {
277   my ($self) = @_;
278   $self->requirement_spec(SL::DB::RequirementSpec->new(id => $::form->{id})->load || die "No such requirement spec") if $::form->{id};
279 }
280
281 sub init_copy_source {
282   my ($self) = @_;
283   $self->copy_source(SL::DB::RequirementSpec->new(id => $::form->{copy_source_id})->load) if $::form->{copy_source_id};
284 }
285
286 sub init_js {
287   my ($self) = @_;
288   $self->js(SL::ClientJS->new);
289 }
290
291 sub init_current_text_block_output_position {
292   my ($self) = @_;
293   $self->current_text_block_output_position($::form->{current_content_type} !~ m/^(?:text-blocks|tb)-(front|back)/ ? -1 : $1 eq 'front' ? 0 : 1);
294 }
295
296 sub load_select_options {
297   my ($self) = @_;
298
299   my @filter = ('!obsolete' => 1);
300   @filter    = ( or => [ @filter, id => $self->requirement_spec->customer_id ] ) if $self->requirement_spec && $self->requirement_spec->customer_id;
301
302   $self->customers(SL::DB::Manager::Customer->get_all_sorted(where => \@filter));
303   $self->statuses( SL::DB::Manager::RequirementSpecStatus->get_all_sorted);
304   $self->types(    SL::DB::Manager::RequirementSpecType->get_all_sorted);
305 }
306
307 #
308 # helpers
309 #
310
311 sub create_or_update {
312   my $self   = shift;
313   my $is_new = !$self->requirement_spec->id;
314   my $params = delete($::form->{requirement_spec}) || { };
315
316   $self->requirement_spec->assign_attributes(%{ $params });
317
318   my $title  = $is_new && $self->requirement_spec->is_template ? t8('Create a new requirement spec template')
319              : $is_new                                         ? t8('Create a new requirement spec')
320              :            $self->requirement_spec->is_template ? t8('Edit requirement spec template')
321              :                                                   t8('Edit requirement spec');
322
323   my @errors = $self->requirement_spec->validate;
324
325   if (@errors) {
326     return $self->js->error(@errors)->render($self) if $::request->is_ajax;
327
328     flash('error', @errors);
329     $self->render('requirement_spec/new', title => $title);
330     return;
331   }
332
333   my $db = $self->requirement_spec->db;
334   if (!$db->do_transaction(sub {
335     if ($self->copy_source) {
336       $self->requirement_spec($self->copy_source->create_copy(%{ $params }));
337     } else {
338       $self->requirement_spec->save;
339     }
340   })) {
341     $::lxdebug->message(LXDebug::WARN(), "Error: " . $db->error);
342     @errors = ($::locale->text('Saving failed. Error message from the database: #1'), $db->error);
343     return $self->js->error(@errors)->render($self) if $::request->is_ajax;
344
345     $self->requirement_spec->id(undef) if $is_new;
346     flash('error', @errors);
347     return $self->render('requirement_spec/new', title => $title);
348   }
349
350   my $info = $self->requirement_spec->is_template ? t8('The requirement spec template has been saved.') : t8('The requirement spec has been saved.');
351
352   if ($::request->is_ajax) {
353     my $header_html = $self->render('requirement_spec/_header', { output => 0 });
354     my $basics_html = $self->render('requirement_spec/_show_basic_settings', { output => 0 });
355     return $self->invalidate_version
356       ->replaceWith('#requirement-spec-header', $header_html)
357       ->replaceWith('#basic_settings',          $basics_html)
358       ->remove('#basic_settings_form')
359       ->flash('info', $info)
360       ->render($self);
361   }
362
363   flash_later('info', $info);
364   $self->redirect_to(action => 'show', id => $self->requirement_spec->id);
365 }
366
367 sub setup_db_args_from_filter {
368   my ($self) = @_;
369
370   $self->{filter} = {};
371   my %args = parse_filter(
372     $::form->{filter},
373     with_objects => [ 'customer', 'type', 'status', 'project' ],
374     launder_to   => $self->{filter},
375   );
376
377   $args{where} = [
378     and => [
379       @{ $args{where} || [] },
380       working_copy_id => undef,
381       is_template     => $::form->{is_template} ? 1 : 0,
382     ]];
383
384   $self->db_args(\%args);
385 }
386
387 sub prepare_report {
388   my ($self)      = @_;
389
390   my $callback    = $self->get_callback;
391
392   my $is_template = $::form->{is_template};
393   my $report      = SL::ReportGenerator->new(\%::myconfig, $::form);
394   $self->{report} = $report;
395
396   my @columns     = $is_template ? qw(title mtime) : qw(title customer status type projectnumber mtime version);
397   my @sortable    = $is_template ? qw(title mtime) : qw(title customer status type projectnumber mtime);
398
399   my %column_defs = (
400     title         => { obj_link => sub { $self->url_for(action => 'show', id => $_[0]->id, callback => $callback) } },
401     mtime         => { sub      => sub { ($_[0]->mtime || $_[0]->itime)->to_kivitendo(precision => 'minute') } },
402   );
403
404   if (!$is_template) {
405     %column_defs = (
406       %column_defs,
407       customer      => { raw_data => sub { $self->presenter->customer($_[0]->customer, display => 'table-cell', callback => $callback) },
408                          sub      => sub { $_[0]->customer->name } },
409       projectnumber => { raw_data => sub { $self->presenter->project($_[0]->project, display => 'table-cell', callback => $callback) },
410                          sub      => sub { $_[0]->project_id ? $_[0]->project->projectnumber : '' } },
411       status        => { sub      => sub { $_[0]->status->description } },
412       type          => { sub      => sub { $_[0]->type->description } },
413       version       => { sub      => sub { $_[0]->version_id ? $_[0]->version->version_number : t8('Working copy without version') } },
414     );
415   }
416
417   map { $column_defs{$_}->{text} ||= $::locale->text( $self->get_sort_spec->{$_}->{title} ) } keys %column_defs;
418
419   $report->set_options(
420     std_column_visibility => 1,
421     controller_class      => 'RequirementSpec',
422     output_format         => 'HTML',
423     raw_top_info_text     => $self->render('requirement_spec/report_top',    { output => 0 }, is_template => $is_template),
424     raw_bottom_info_text  => $self->render('requirement_spec/report_bottom', { output => 0 }),
425     title                 => $is_template ? t8('Requirement Spec Templates') : t8('Requirement Specs'),
426     allow_pdf_export      => 1,
427     allow_csv_export      => 1,
428   );
429   $report->set_columns(%column_defs);
430   $report->set_column_order(@columns);
431   $report->set_export_options(qw(list filter));
432   $report->set_options_from_form;
433   $self->set_report_generator_sort_options(report => $report, sortable_columns => \@sortable);
434
435   $self->disable_pagination if $report->{options}{output_format} =~ /^(pdf|csv)$/i;
436 }
437
438 sub invalidate_version {
439   my ($self) = @_;
440
441   my $rspec  = SL::DB::RequirementSpec->new(id => $self->requirement_spec->id)->load;
442   return $self->js if $rspec->is_template;
443
444   $rspec->invalidate_version;
445
446   my $html = $self->render('requirement_spec/_version', { output => 0 }, requirement_spec => $rspec);
447   return $self->js->html('#requirement_spec_version', $html);
448 }
449
450 sub render_pasted_text_block {
451   my ($self, $text_block, %params) = @_;
452
453   if ($self->current_text_block_output_position == $text_block->output_position) {
454     my $html = $self->render('requirement_spec_text_block/_text_block', { output => 0 }, text_block => $text_block);
455     $self->js
456       ->appendTo($html, '#text-block-list')
457       ->hide('#text-block-list-empty');
458   }
459
460   my $node       = $self->presenter->requirement_spec_text_block_jstree_data($text_block);
461   my $front_back = $text_block->output_position == 0 ? 'front' : 'back';
462   $self->js
463     ->jstree->create_node('#tree', "#tb-${front_back}", 'last', $node)
464     ->jstree->open_node(  '#tree', "#tb-${front_back}");
465 }
466
467 sub render_pasted_section {
468   my ($self, $item, $parent_id) = @_;
469
470   my $node = $self->presenter->requirement_spec_item_jstree_data($item);
471   $self->js
472     ->jstree->create_node('#tree', $parent_id ? "#fb-${parent_id}" : '#sections', 'last', $node)
473     ->jstree->open_node(  '#tree', $parent_id ? "#fb-${parent_id}" : '#sections');
474
475   $self->render_pasted_section($_, $item->id) for @{ $item->children_sorted };
476 }
477
478 sub render_first_pasted_section_as_list {
479   my ($self, $section, %params) = @_;
480
481   my $html = $self->render('requirement_spec_item/_section', { output => 0 }, requirement_spec_item => $section);
482   $self->js
483     ->html('#column-content', $html)
484     ->val( '#current_content_type', $section->item_type)
485     ->val( '#current_content_id',   $section->id)
486     ->jstree->select_node('#tree', '#fb-' . $section->id);
487 }
488
489 1;