package SL::Controller::RequirementSpec;
use strict;
+use utf8;
use parent qw(SL::Controller::Base);
+use File::Spec ();
+
use SL::ClientJS;
+use SL::Common ();
use SL::Controller::Helper::GetModels;
+use SL::Controller::Helper::Filtered;
use SL::Controller::Helper::Paginated;
use SL::Controller::Helper::Sorted;
use SL::Controller::Helper::ParseFilter;
use SL::DB::RequirementSpec;
use SL::Helper::Flash;
use SL::Locale::String;
+use SL::Template::LaTeX;
use Rose::Object::MakeMethods::Generic
(
- scalar => [ qw(requirement_spec_item customers types statuses db_args flat_filter is_template visible_item visible_section) ],
- 'scalar --get_set_init' => [ qw(requirement_spec complexities risks projects) ],
+ scalar => [ qw(requirement_spec_item customers types statuses visible_item visible_section) ],
+ 'scalar --get_set_init' => [ qw(requirement_spec complexities risks projects copy_source js current_text_block_output_position) ],
);
__PACKAGE__->run_before('setup');
__PACKAGE__->run_before('load_select_options', only => [ qw(new ajax_edit create update list) ]);
-__PACKAGE__->get_models_url_params('flat_filter');
+__PACKAGE__->make_filtered(
+ MODEL => 'RequirementSpec',
+ LAUNDER_TO => 'filter'
+);
__PACKAGE__->make_paginated(
- MODEL => 'RequirementSpec',
- PAGINATE_ARGS => 'db_args',
- ONLY => [ qw(list) ],
+ MODEL => 'RequirementSpec',
+ ONLY => [ qw(list) ],
);
-
__PACKAGE__->make_sorted(
MODEL => 'RequirementSpec',
ONLY => [ qw(list) ],
type => t8('Requirement Spec Type'),
status => t8('Requirement Spec Status'),
projectnumber => t8('Project Number'),
+ version => t8('Version'),
+ mtime => t8('Last modification'),
);
#
sub action_list {
my ($self) = @_;
- $self->setup_db_args_from_filter;
- $self->flat_filter({ map { $_->{key} => $_->{value} } $::form->flatten_variables('filter') });
+ my $requirement_specs = $self->get_models(
+ query => [
+ and => [
+ working_copy_id => undef,
+ is_template => $::form->{is_template} ? 1 : 0,
+ ]],
+ with_objects => [ 'customer', 'type', 'status', 'project' ],
+ );
$self->prepare_report;
-
- my $requirement_specs = $self->get_models(%{ $self->db_args });
-
$self->report_generator_list_objects(report => $self->{report}, objects => $requirement_specs);
}
sub action_new {
my ($self) = @_;
- $self->requirement_spec(SL::DB::RequirementSpec->new);
- $self->render('requirement_spec/new', title => t8('Create a new requirement spec'));
-}
+ $self->requirement_spec(SL::DB::RequirementSpec->new(is_template => $::form->{is_template}));
-sub action_ajax_edit {
- my ($self) = @_;
+ if ($self->copy_source) {
+ $self->requirement_spec->$_($self->copy_source->$_) for qw(type_id status_id customer_id title hourly_rate)
+ }
- $self->render('requirement_spec/_form', { layout => 0 }, submit_as => 'ajax');
+ $self->render('requirement_spec/new', title => $self->requirement_spec->is_template ? t8('Create a new requirement spec template') : t8('Create a new requirement spec'));
}
-sub action_ajax_show_time_and_cost_estimate {
+sub action_ajax_show_basic_settings {
my ($self) = @_;
- $self->render('requirement_spec/_show_time_and_cost_estimate', { layout => 0 });
+ $self->render('requirement_spec/_show_basic_settings', { layout => 0 });
}
-sub action_ajax_cancel_time_and_cost_estimate {
+sub action_ajax_edit {
my ($self) = @_;
- my $html = $self->render('requirement_spec/_show_time_and_cost_estimate', { output => 0 });
+ my $html = $self->render('requirement_spec/_form', { output => 0 }, submit_as => 'ajax');
- SL::ClientJS->new
- ->replaceWith('#time_cost_estimate', $html)
+ $self->js
+ ->hide('#basic_settings')
+ ->after('#basic_settings', $html)
->render($self);
}
+sub action_ajax_show_time_and_cost_estimate {
+ my ($self) = @_;
+
+ $self->render('requirement_spec/_show_time_and_cost_estimate', { layout => 0 });
+}
+
sub action_ajax_edit_time_and_cost_estimate {
my ($self) = @_;
my $html = $self->render('requirement_spec/_edit_time_and_cost_estimate', { output => 0 });
-
- SL::ClientJS->new
- ->replaceWith('#time_cost_estimate', $html)
- ->render($self);
+ my $first = ($self->requirement_spec->sections_sorted || [])->[0];
+ $first = ($first->children_sorted || [])->[0] if $first;
+
+ $self->js
+ ->hide('#time_cost_estimate')
+ ->after('#time_cost_estimate', $html)
+ ->on('#time_cost_estimate INPUT[type=text]', 'keydown', 'kivi.requirement_spec.time_cost_estimate_input_key_down')
+ ->action_if($first && $first->id, 'focus', '#time_and_cost_estimate_form_complexity_id_' . $first->id)
+ ->render($self);
}
sub action_ajax_save_time_and_cost_estimate {
1;
});
- my $html = $self->render('requirement_spec/_show_time_and_cost_estimate', { output => 0 });
- my $js = SL::ClientJS->new->replaceWith('#time_cost_estimate', $html);
+ $self->requirement_spec(SL::DB::RequirementSpec->new(id => $self->requirement_spec->id)->load);
+
+ my $html = $self->render('requirement_spec/_show_time_and_cost_estimate', { output => 0 }, initially_hidden => !!$::form->{keep_open});
+ $self->js->replaceWith('#time_cost_estimate', $html);
+
+ return $self->js->render($self) if $::form->{keep_open};
+
+ $self->js->remove('#time_cost_estimate_form_container');
if ($self->visible_section) {
$html = $self->render('requirement_spec_item/_section', { output => 0 }, requirement_spec_item => $self->visible_section);
- $js->html('#column-content', $html);
+ $self->js->html('#column-content', $html);
}
- $js->render($self);
+ $self->js->render($self);
}
sub action_show {
my ($self) = @_;
- my $item = $::form->{requirement_spec_item_id} ? SL::DB::RequirementSpecItem->new(id => $::form->{requirement_spec_item_id})->load : @{ $self->requirement_spec->sections }[0];
+ my $title = $self->requirement_spec->is_template ? t8('Show requirement spec template') : t8('Show requirement spec');
+ my $item = $::form->{requirement_spec_item_id} ? SL::DB::RequirementSpecItem->new(id => $::form->{requirement_spec_item_id})->load : @{ $self->requirement_spec->sections }[0];
$self->requirement_spec_item($item);
- $self->render('requirement_spec/show', title => t8('Show requirement spec'));
+ $self->render('requirement_spec/show', title => $title);
}
sub action_create {
$self->redirect_to(action => 'list');
}
-sub action_reorder {
+sub action_revert_to {
+ my ($self, %params) = @_;
+
+ return $self->js->error(t8('Cannot revert a versioned copy.'))->render($self) if $self->requirement_spec->working_copy_id;
+
+ my $versioned_copy = SL::DB::RequirementSpec->new(id => $::form->{versioned_copy_id})->load;
+
+ $self->requirement_spec->copy_from($versioned_copy);
+ my $version = $versioned_copy->versions->[0];
+ $version->update_attributes(working_copy_id => $self->requirement_spec->id);
+
+ flash_later('info', t8('The requirement spec has been reverted to version #1.', $self->requirement_spec->version->version_number));
+ $self->js->redirect_to($self->url_for(action => 'show', id => $self->requirement_spec->id))->render($self);
+}
+
+sub action_create_pdf {
+ my ($self, %params) = @_;
+
+ my $base_name = $self->requirement_spec->type->template_file_name || 'requirement_spec';
+ my @pictures = $self->prepare_pictures_for_printing;
+ my %result = SL::Template::LaTeX->parse_and_create_pdf("${base_name}.tex", SELF => $self, rspec => $self->requirement_spec);
+
+ unlink @pictures unless ($::lx_office_conf{debug} || {})->{keep_temp_files};
+
+ $::form->error(t8('Conversion to PDF failed: #1', $result{error})) if $result{error};
+
+ my $attachment_name = $self->requirement_spec->type->description . ' ' . ($self->requirement_spec->working_copy_id || $self->requirement_spec->id);
+ $attachment_name .= ' (v' . $self->requirement_spec->version->version_number . ')' if $self->requirement_spec->version;
+ $attachment_name .= '.pdf';
+ $attachment_name =~ s/[^\wäöüÄÖÜß \-\+\(\)\[\]\{\}\.,]+/_/g;
+
+ $self->send_file($result{file_name}, type => 'application/pdf', name => $attachment_name);
+ unlink $result{file_name};
+}
+
+sub action_select_template_to_paste {
my ($self) = @_;
- SL::DB::RequirementSpec->reorder_list(@{ $::form->{requirement_spec_id} || [] });
+ my @templates = grep { @{ $_->sections } || @{ $_->text_blocks } } @{ SL::DB::Manager::RequirementSpec->get_all(where => [ is_template => 1 ], sort_by => 'lower(title)') };
+ $self->render('requirement_spec/select_template_to_paste', { layout => 0 }, TEMPLATES => \@templates);
+}
+
+sub action_paste_template {
+ my ($self, %params) = @_;
+
+ my $template = SL::DB::RequirementSpec->new(id => $::form->{template_id})->load;
+ my %result = $self->requirement_spec->paste_template($template);
- $self->render('1;', { type => 'js', inline => 1 });
+ return $self->js->error($self->requirement_spec->error)->render($self) if !%result;
+
+ $self->render_pasted_text_block($_) for sort { $a->position <=> $b->position } @{ $result{text_blocks} };
+ $self->render_pasted_section($_) for sort { $a->position <=> $b->position } @{ $result{sections} };
+
+ if (@{ $result{sections} } && (($::form->{current_content_type} || 'sections') eq 'sections') && !$::form->{current_content_id}) {
+ $self->render_first_pasted_section_as_list($result{sections}->[0]);
+ }
+
+ $self->invalidate_version->render($self);
}
#
sub setup {
my ($self) = @_;
- $::auth->assert('config');
+ $::auth->assert('sales_quotation_edit');
$::request->{layout}->use_stylesheet("${_}.css") for qw(jquery.contextMenu requirement_spec);
- $::request->{layout}->use_javascript("${_}.js") for qw(jquery.jstree jquery/jquery.contextMenu client_js requirement_spec);
- $self->is_template($::form->{is_template} ? 1 : 0);
+ $::request->{layout}->use_javascript("${_}.js") for qw(jquery.jstree jquery/jquery.contextMenu jquery/jquery.hotkeys requirement_spec);
$self->init_visible_section;
return 1;
$self->requirement_spec(SL::DB::RequirementSpec->new(id => $::form->{id})->load || die "No such requirement spec") if $::form->{id};
}
+sub init_copy_source {
+ my ($self) = @_;
+ $self->copy_source(SL::DB::RequirementSpec->new(id => $::form->{copy_source_id})->load) if $::form->{copy_source_id};
+}
+
+sub init_js {
+ my ($self) = @_;
+ $self->js(SL::ClientJS->new);
+}
+
+sub init_current_text_block_output_position {
+ my ($self) = @_;
+ $self->current_text_block_output_position($::form->{current_content_type} !~ m/^(?:text-blocks|tb)-(front|back)/ ? -1 : $1 eq 'front' ? 0 : 1);
+}
+
sub load_select_options {
my ($self) = @_;
my $self = shift;
my $is_new = !$self->requirement_spec->id;
my $params = delete($::form->{requirement_spec}) || { };
- my $title = $is_new ? t8('Create a new requirement spec') : t8('Edit requirement spec');
$self->requirement_spec->assign_attributes(%{ $params });
+ my $title = $is_new && $self->requirement_spec->is_template ? t8('Create a new requirement spec template')
+ : $is_new ? t8('Create a new requirement spec')
+ : $self->requirement_spec->is_template ? t8('Edit requirement spec template')
+ : t8('Edit requirement spec');
+
my @errors = $self->requirement_spec->validate;
if (@errors) {
- return SL::ClientJS->new->error(@errors)->render($self) if $::request->is_ajax;
+ return $self->js->error(@errors)->render($self) if $::request->is_ajax;
flash('error', @errors);
$self->render('requirement_spec/new', title => $title);
return;
}
- $self->requirement_spec->save;
+ my $db = $self->requirement_spec->db;
+ if (!$db->do_transaction(sub {
+ if ($self->copy_source) {
+ $self->requirement_spec($self->copy_source->create_copy(%{ $params }));
+ } else {
+ $self->requirement_spec->save;
+ }
+ })) {
+ $::lxdebug->message(LXDebug::WARN(), "Error: " . $db->error);
+ @errors = ($::locale->text('Saving failed. Error message from the database: #1', $db->error));
+ return $self->js->error(@errors)->render($self) if $::request->is_ajax;
+
+ $self->requirement_spec->id(undef) if $is_new;
+ flash('error', @errors);
+ return $self->render('requirement_spec/new', title => $title);
+ }
+
+ my $info = $self->requirement_spec->is_template ? t8('The requirement spec template has been saved.') : t8('The requirement spec has been saved.');
if ($::request->is_ajax) {
- my $html = $self->render('requirement_spec/_header', { output => 0 });
- return SL::ClientJS->new
- ->replaceWith('#requirement-spec-header', $html)
- ->flash('info', t8('The requirement spec has been saved.'))
+ my $header_html = $self->render('requirement_spec/_header', { output => 0 });
+ my $basics_html = $self->render('requirement_spec/_show_basic_settings', { output => 0 });
+ return $self->invalidate_version
+ ->replaceWith('#requirement-spec-header', $header_html)
+ ->replaceWith('#basic_settings', $basics_html)
+ ->remove('#basic_settings_form')
+ ->flash('info', $info)
->render($self);
}
- flash_later('info', $is_new ? t8('The requirement spec has been created.') : t8('The requirement spec has been saved.'));
+ flash_later('info', $info);
$self->redirect_to(action => 'show', id => $self->requirement_spec->id);
}
-sub setup_db_args_from_filter {
- my ($self) = @_;
-
- $self->{filter} = {};
- my %args = parse_filter(
- $::form->{filter},
- with_objects => [ 'customer', 'type', 'status', 'project' ],
- launder_to => $self->{filter},
- );
-
- $args{where} = [
- and => [
- @{ $args{where} || [] },
- is_template => $self->is_template
- ]];
-
- $self->db_args(\%args);
-}
-
sub prepare_report {
my ($self) = @_;
my $callback = $self->get_callback;
+ my $is_template = $::form->{is_template};
my $report = SL::ReportGenerator->new(\%::myconfig, $::form);
$self->{report} = $report;
- my @columns = qw(title customer status type projectnumber);
- my @sortable = qw(title customer status type projectnumber);
+ my @columns = $is_template ? qw(title mtime) : qw(title customer status type projectnumber mtime version);
+ my @sortable = $is_template ? qw(title mtime) : qw(title customer status type projectnumber mtime);
my %column_defs = (
title => { obj_link => sub { $self->url_for(action => 'show', id => $_[0]->id, callback => $callback) } },
- customer => { raw_data => sub { $self->presenter->customer($_[0]->customer, display => 'table-cell', callback => $callback) },
- sub => sub { $_[0]->customer->name } },
- projectnumber => { raw_data => sub { $self->presenter->project($_[0]->project, display => 'table-cell', callback => $callback) },
- sub => sub { $_[0]->project_id ? $_[0]->project->projectnumber : '' } },
- status => { sub => sub { $_[0]->status->description } },
- type => { sub => sub { $_[0]->type->description } },
+ mtime => { sub => sub { ($_[0]->mtime || $_[0]->itime)->to_kivitendo(precision => 'minute') } },
);
+ if (!$is_template) {
+ %column_defs = (
+ %column_defs,
+ customer => { raw_data => sub { $self->presenter->customer($_[0]->customer, display => 'table-cell', callback => $callback) },
+ sub => sub { $_[0]->customer->name } },
+ projectnumber => { raw_data => sub { $self->presenter->project($_[0]->project, display => 'table-cell', callback => $callback) },
+ sub => sub { $_[0]->project_id ? $_[0]->project->projectnumber : '' } },
+ status => { sub => sub { $_[0]->status->description } },
+ type => { sub => sub { $_[0]->type->description } },
+ version => { sub => sub { $_[0]->version ? $_[0]->version->version_number : t8('Working copy without version') } },
+ );
+ }
+
map { $column_defs{$_}->{text} ||= $::locale->text( $self->get_sort_spec->{$_}->{title} ) } keys %column_defs;
$report->set_options(
std_column_visibility => 1,
controller_class => 'RequirementSpec',
output_format => 'HTML',
- raw_top_info_text => $self->render('requirement_spec/report_top', { output => 0 }),
+ raw_top_info_text => $self->render('requirement_spec/report_top', { output => 0 }, is_template => $is_template),
raw_bottom_info_text => $self->render('requirement_spec/report_bottom', { output => 0 }),
- title => $::locale->text('Requirement Specs'),
+ title => $is_template ? t8('Requirement Spec Templates') : t8('Requirement Specs'),
allow_pdf_export => 1,
allow_csv_export => 1,
);
$self->disable_pagination if $report->{options}{output_format} =~ /^(pdf|csv)$/i;
}
+sub invalidate_version {
+ my ($self) = @_;
+
+ my $rspec = SL::DB::RequirementSpec->new(id => $self->requirement_spec->id)->load;
+ return $self->js if $rspec->is_template;
+
+ $rspec->invalidate_version;
+
+ my $html = $self->render('requirement_spec/_version', { output => 0 }, requirement_spec => $rspec);
+ return $self->js->html('#requirement_spec_version', $html);
+}
+
+sub render_pasted_text_block {
+ my ($self, $text_block, %params) = @_;
+
+ if ($self->current_text_block_output_position == $text_block->output_position) {
+ my $html = $self->render('requirement_spec_text_block/_text_block', { output => 0 }, text_block => $text_block);
+ $self->js
+ ->appendTo($html, '#text-block-list')
+ ->hide('#text-block-list-empty');
+ }
+
+ my $node = $self->presenter->requirement_spec_text_block_jstree_data($text_block);
+ my $front_back = $text_block->output_position == 0 ? 'front' : 'back';
+ $self->js
+ ->jstree->create_node('#tree', "#tb-${front_back}", 'last', $node)
+ ->jstree->open_node( '#tree', "#tb-${front_back}");
+}
+
+sub render_pasted_section {
+ my ($self, $item, $parent_id) = @_;
+
+ my $node = $self->presenter->requirement_spec_item_jstree_data($item);
+ $self->js
+ ->jstree->create_node('#tree', $parent_id ? "#fb-${parent_id}" : '#sections', 'last', $node)
+ ->jstree->open_node( '#tree', $parent_id ? "#fb-${parent_id}" : '#sections');
+
+ $self->render_pasted_section($_, $item->id) for @{ $item->children_sorted };
+}
+
+sub render_first_pasted_section_as_list {
+ my ($self, $section, %params) = @_;
+
+ my $html = $self->render('requirement_spec_item/_section', { output => 0 }, requirement_spec_item => $section);
+ $self->js
+ ->html('#column-content', $html)
+ ->val( '#current_content_type', $section->item_type)
+ ->val( '#current_content_id', $section->id)
+ ->jstree->select_node('#tree', '#fb-' . $section->id);
+}
+
+sub prepare_pictures_for_printing {
+ my ($self) = @_;
+
+ my @files;
+ my $userspath = File::Spec->rel2abs($::lx_office_conf{paths}->{userspath});
+ my $target = "${userspath}/kivitendo-print-requirement-spec-picture-" . Common::unique_id() . '-';
+
+ foreach my $picture (map { @{ $_->pictures } } @{ $self->requirement_spec->text_blocks }) {
+ my $output_file_name = $target . $picture->id . '.' . $picture->get_default_file_name_extension;
+ $picture->{print_file_name} = File::Spec->abs2rel($output_file_name, $userspath);
+ my $out = IO::File->new($output_file_name, 'w') || die("Could not create file " . $output_file_name);
+ $out->binmode;
+ $out->print($picture->picture_content);
+ $out->close;
+
+ push @files, $output_file_name;
+ }
+
+ return @files;
+}
+
1;