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 is_template visible_item visible_section) ],
29 'scalar --get_set_init' => [ qw(requirement_spec complexities risks projects copy_source js) ],
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);
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 => t8('Create a new requirement spec'));
89 sub action_ajax_edit {
92 $self->render('requirement_spec/_form', { layout => 0 }, submit_as => 'ajax');
95 sub action_ajax_show_time_and_cost_estimate {
98 $self->render('requirement_spec/_show_time_and_cost_estimate', { layout => 0 });
101 sub action_ajax_cancel_time_and_cost_estimate {
104 my $html = $self->render('requirement_spec/_show_time_and_cost_estimate', { output => 0 });
107 ->replaceWith('#time_cost_estimate', $html)
111 sub action_ajax_edit_time_and_cost_estimate {
114 my $html = $self->render('requirement_spec/_edit_time_and_cost_estimate', { output => 0 });
117 ->replaceWith('#time_cost_estimate', $html)
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 my $html = $self->render('requirement_spec/_show_time_and_cost_estimate', { output => 0 });
138 $self->js->replaceWith('#time_cost_estimate', $html);
140 if ($self->visible_section) {
141 $html = $self->render('requirement_spec_item/_section', { output => 0 }, requirement_spec_item => $self->visible_section);
142 $self->js->html('#column-content', $html);
145 $self->js->render($self);
151 my $item = $::form->{requirement_spec_item_id} ? SL::DB::RequirementSpecItem->new(id => $::form->{requirement_spec_item_id})->load : @{ $self->requirement_spec->sections }[0];
152 $self->requirement_spec_item($item);
154 $self->render('requirement_spec/show', title => t8('Show requirement spec'));
160 $self->requirement_spec(SL::DB::RequirementSpec->new);
161 $self->create_or_update;
166 $self->create_or_update;
172 if (eval { $self->requirement_spec->delete; 1; }) {
173 flash_later('info', t8('The requirement spec has been deleted.'));
175 flash_later('error', t8('The requirement spec is in use and cannot be deleted.'));
178 $self->redirect_to(action => 'list');
181 sub action_revert_to {
182 my ($self, %params) = @_;
184 return $self->js->error(t8('Cannot revert a versioned copy.'))->render($self) if $self->requirement_spec->working_copy_id;
186 my $versioned_copy = SL::DB::RequirementSpec->new(id => $::form->{versioned_copy_id})->load;
188 $self->requirement_spec->copy_from(
190 version_id => $versioned_copy->version_id,
193 flash_later('info', t8('The requirement spec has been reverted to version #1.', $self->requirement_spec->version->version_number));
194 $self->js->redirect_to($self->url_for(action => 'show', id => $self->requirement_spec->id))->render($self);
197 sub action_create_pdf {
198 my ($self, %params) = @_;
200 my %result = SL::Template::LaTeX->parse_and_create_pdf('requirement_spec.tex', SELF => $self, rspec => $self->requirement_spec);
202 $::form->error(t8('Conversion to PDF failed: #1', $result{error})) if $result{error};
204 my $attachment_name = $self->requirement_spec->type->description . ' ' . ($self->requirement_spec->working_copy_id || $self->requirement_spec->id);
205 $attachment_name .= ' (v' . $self->requirement_spec->version->version_number . ')' if $self->requirement_spec->version;
206 $attachment_name .= '.pdf';
207 $attachment_name =~ s/[^\wäöüÄÖÜß \-\+\(\)\[\]\{\}\.,]+/_/g;
209 $self->send_file($result{file_name}, type => 'application/pdf', name => $attachment_name);
210 unlink $result{file_name};
220 $::auth->assert('sales_quotation_edit');
221 $::request->{layout}->use_stylesheet("${_}.css") for qw(jquery.contextMenu requirement_spec);
222 $::request->{layout}->use_javascript("${_}.js") for qw(jquery.jstree jquery/jquery.contextMenu client_js requirement_spec);
223 $self->is_template($::form->{is_template} ? 1 : 0);
224 $self->init_visible_section;
229 sub init_complexities {
231 return SL::DB::Manager::RequirementSpecComplexity->get_all_sorted;
236 return SL::DB::Manager::RequirementSpecRisk->get_all_sorted;
241 $self->projects(SL::DB::Manager::Project->get_all_sorted);
244 sub init_requirement_spec {
246 $self->requirement_spec(SL::DB::RequirementSpec->new(id => $::form->{id})->load || die "No such requirement spec") if $::form->{id};
249 sub init_copy_source {
251 $self->copy_source(SL::DB::RequirementSpec->new(id => $::form->{copy_source_id})->load) if $::form->{copy_source_id};
256 $self->js(SL::ClientJS->new);
259 sub load_select_options {
262 my @filter = ('!obsolete' => 1);
263 @filter = ( or => [ @filter, id => $self->requirement_spec->customer_id ] ) if $self->requirement_spec && $self->requirement_spec->customer_id;
265 $self->customers(SL::DB::Manager::Customer->get_all_sorted(where => \@filter));
266 $self->statuses( SL::DB::Manager::RequirementSpecStatus->get_all_sorted);
267 $self->types( SL::DB::Manager::RequirementSpecType->get_all_sorted);
274 sub create_or_update {
276 my $is_new = !$self->requirement_spec->id;
277 my $params = delete($::form->{requirement_spec}) || { };
278 my $title = $is_new ? t8('Create a new requirement spec') : t8('Edit requirement spec');
280 $self->requirement_spec->assign_attributes(%{ $params });
282 my @errors = $self->requirement_spec->validate;
285 return $self->js->error(@errors)->render($self) if $::request->is_ajax;
287 flash('error', @errors);
288 $self->render('requirement_spec/new', title => $title);
292 my $db = $self->requirement_spec->db;
293 if (!$db->do_transaction(sub {
294 if ($self->copy_source) {
295 $self->requirement_spec($self->copy_source->create_copy(%{ $params }));
297 $self->requirement_spec->save;
300 $::lxdebug->message(LXDebug::WARN(), "Error: " . $db->error);
301 @errors = ($::locale->text('Saving failed. Error message from the database: #1'), $db->error);
302 return $self->js->error(@errors)->render($self) if $::request->is_ajax;
304 $self->requirement_spec->id(undef) if $is_new;
305 flash('error', @errors);
306 return $self->render('requirement_spec/new', title => $title);
309 if ($::request->is_ajax) {
310 my $html = $self->render('requirement_spec/_header', { output => 0 });
311 return $self->invalidate_version
312 ->replaceWith('#requirement-spec-header', $html)
313 ->flash('info', t8('The requirement spec has been saved.'))
317 flash_later('info', $is_new ? t8('The requirement spec has been created.') : t8('The requirement spec has been saved.'));
318 $self->redirect_to(action => 'show', id => $self->requirement_spec->id);
321 sub setup_db_args_from_filter {
324 $self->{filter} = {};
325 my %args = parse_filter(
327 with_objects => [ 'customer', 'type', 'status', 'project' ],
328 launder_to => $self->{filter},
333 @{ $args{where} || [] },
334 working_copy_id => undef,
335 is_template => $self->is_template
338 $self->db_args(\%args);
344 my $callback = $self->get_callback;
346 my $report = SL::ReportGenerator->new(\%::myconfig, $::form);
347 $self->{report} = $report;
349 my @columns = qw(title customer status type projectnumber mtime version);
350 my @sortable = qw(title customer status type projectnumber mtime);
353 title => { obj_link => sub { $self->url_for(action => 'show', id => $_[0]->id, callback => $callback) } },
354 customer => { raw_data => sub { $self->presenter->customer($_[0]->customer, display => 'table-cell', callback => $callback) },
355 sub => sub { $_[0]->customer->name } },
356 projectnumber => { raw_data => sub { $self->presenter->project($_[0]->project, display => 'table-cell', callback => $callback) },
357 sub => sub { $_[0]->project_id ? $_[0]->project->projectnumber : '' } },
358 status => { sub => sub { $_[0]->status->description } },
359 type => { sub => sub { $_[0]->type->description } },
360 version => { sub => sub { $_[0]->version_id ? $_[0]->version->version_number : t8('Working copy without version') } },
361 mtime => { sub => sub { ($_[0]->mtime || $_[0]->itime)->to_kivitendo(precision => 'minute') } },
364 map { $column_defs{$_}->{text} ||= $::locale->text( $self->get_sort_spec->{$_}->{title} ) } keys %column_defs;
366 $report->set_options(
367 std_column_visibility => 1,
368 controller_class => 'RequirementSpec',
369 output_format => 'HTML',
370 raw_top_info_text => $self->render('requirement_spec/report_top', { output => 0 }),
371 raw_bottom_info_text => $self->render('requirement_spec/report_bottom', { output => 0 }),
372 title => $::locale->text('Requirement Specs'),
373 allow_pdf_export => 1,
374 allow_csv_export => 1,
376 $report->set_columns(%column_defs);
377 $report->set_column_order(@columns);
378 $report->set_export_options(qw(list filter));
379 $report->set_options_from_form;
380 $self->set_report_generator_sort_options(report => $report, sortable_columns => \@sortable);
382 $self->disable_pagination if $report->{options}{output_format} =~ /^(pdf|csv)$/i;
385 sub invalidate_version {
388 my $rspec = SL::DB::RequirementSpec->new(id => $self->requirement_spec->id)->load;
389 $rspec->invalidate_version;
391 my $html = $self->render('requirement_spec/_version', { output => 0 }, requirement_spec => $rspec);
392 return $self->js->html('#requirement_spec_version', $html);