use File::Spec ();
-use SL::ClientJS;
use SL::Common ();
use SL::Controller::Helper::GetModels;
use SL::Controller::Helper::ReportGenerator;
use SL::Helper::CreatePDF qw();
use SL::Helper::Flash;
use SL::Locale::String;
+use SL::System::Process;
use SL::Template::LaTeX;
use Rose::Object::MakeMethods::Generic
(
scalar => [ qw(requirement_spec_item visible_item visible_section) ],
- '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
- current_text_block_output_position models time_based_units html_template) ],
+ '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
+ current_text_block_output_position models time_based_units html_template cvar_configs includeable_cvar_configs include_cvars) ],
);
__PACKAGE__->run_before('setup');
sub action_list {
my ($self) = @_;
+ $self->_setup_search_action_bar;
$self->prepare_report;
$self->report_generator_list_objects(report => $self->{report}, objects => $self->models->get);
}
$self->requirement_spec->$_($self->copy_source->$_) for qw(type_id status_id customer_id title hourly_rate is_template)
}
+ $self->_setup_form_action_bar;
+
$self->render('requirement_spec/new', title => $self->requirement_spec->is_template ? t8('Create a new requirement spec template') : t8('Create a new requirement spec'));
}
$self->js
->hide('#basic_settings')
->after('#basic_settings', $html)
- ->render($self);
+ ->reinit_widgets
+ ->render;
}
sub action_ajax_edit_project_link {
$self->js
->hide('#basic_settings')
->after('#basic_settings', $html)
- ->render($self);
+ ->render;
}
sub action_ajax_show_time_and_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);
+ ->render;
}
sub action_ajax_save_time_and_cost_estimate {
my ($self) = @_;
- $self->requirement_spec->db->do_transaction(sub {
+ $self->requirement_spec->db->with_transaction(sub {
# Make Emacs happy
1;
foreach my $attributes (@{ $::form->{requirement_spec_items} || [] }) {
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};
+ return $self->js->render if $::form->{keep_open};
$self->js->remove('#time_cost_estimate_form_container');
$self->js->html('#column-content', $html);
}
- $self->js->render($self);
+ $self->js->render;
}
sub action_show {
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;
+ return $self->js->error(t8('Cannot revert a versioned copy.'))->render if $self->requirement_spec->working_copy_id;
my $versioned_copy = SL::DB::RequirementSpec->new(id => $::form->{versioned_copy_id})->load;
$version->update_attributes(working_copy_id => $self->requirement_spec->id);
flash_later('info', t8('The requirement spec has been reverted to version #1.', $versioned_copy->version->version_number));
- $self->js->redirect_to($self->url_for(action => 'show', id => $self->requirement_spec->id))->render($self);
+ $self->js->redirect_to($self->url_for(action => 'show', id => $self->requirement_spec->id))->render;
}
sub action_create_pdf {
my ($self, %params) = @_;
+ my $keep_temp_files = $::lx_office_conf{debug} && $::lx_office_conf{debug}->{keep_temp_files};
+ my $temp_dir = File::Temp->newdir(
+ "kivitendo-print-XXXXXX",
+ DIR => SL::System::Process::exe_dir() . "/" . $::lx_office_conf{paths}->{userspath},
+ CLEANUP => !$keep_temp_files,
+ );
+
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);
+ my @pictures = $self->prepare_pictures_for_printing($temp_dir->dirname);
+ my %result = SL::Template::LaTeX->parse_and_create_pdf("${base_name}.tex", SELF => $self, rspec => $self->requirement_spec, userspath => $temp_dir->dirname);
unlink @pictures unless ($::lx_office_conf{debug} || {})->{keep_temp_files};
my $template = SL::DB::RequirementSpec->new(id => $::form->{template_id})->load;
my %result = $self->requirement_spec->paste_template($template);
- return $self->js->error($self->requirement_spec->error)->render($self) if !%result;
+ return $self->js->error($self->requirement_spec->error)->render 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} };
->show( '#additional_parts_list_container')
->remove( '#additional_parts_form_container');
- $self->invalidate_version->render($self);
+ $self->invalidate_version->render;
}
sub action_renumber_sections {
$::auth->assert('requirement_spec_edit');
$::request->{layout}->use_stylesheet("${_}.css") for qw(jquery.contextMenu requirement_spec);
- $::request->{layout}->use_javascript("${_}.js") for qw(jquery.jstree jquery/jquery.contextMenu jquery/jquery.hotkeys requirement_spec ckeditor/ckeditor ckeditor/adapters/jquery autocomplete_part);
+ $::request->{layout}->use_javascript("${_}.js") for qw(jquery.jstree jquery/jquery.contextMenu jquery/jquery.hotkeys requirement_spec ckeditor/ckeditor ckeditor/adapters/jquery kivi.Part kivi.CustomerVendor
+ ckeditor/ckeditor ckeditor/adapters/jquery);
$self->init_visible_section;
return 1;
}
-sub init_js { SL::ClientJS->new }
sub init_complexities { SL::DB::Manager::RequirementSpecComplexity->get_all_sorted }
sub init_default_project_status { SL::DB::Manager::ProjectStatus->find_by(name => 'planning') }
sub init_default_project_type { SL::DB::ProjectType->new(id => 1)->load }
sub init_statuses { SL::DB::Manager::RequirementSpecStatus->get_all_sorted }
sub init_time_based_units { SL::DB::Manager::Unit->time_based_units }
sub init_types { SL::DB::Manager::RequirementSpecType->get_all_sorted }
+sub init_cvar_configs { SL::DB::Manager::CustomVariableConfig->get_all_sorted(where => [ module => 'RequirementSpecs' ]) }
sub init_customers {
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 init_includeable_cvar_configs {
+ my ($self) = @_;
+ return [ grep { $_->includeable } @{ $self->cvar_configs } ];
+}
+
+sub init_include_cvars {
+ my ($self) = @_;
+ return { map { ($_->name => $::form->{"include_cvars_" . $_->name}) } @{ $self->cvar_configs } } if $::form->{_include_cvars_from_form};
+ return { map { ($_->name => ($_->includeable && $_->included_by_default)) } @{ $self->cvar_configs } };
+}
+
#
# helpers
#
sub create_or_update {
- my $self = shift;
- my $is_new = !$self->requirement_spec->id;
- my $params = delete($::form->{requirement_spec}) || { };
+ my $self = shift;
+ my $is_new = !$self->requirement_spec->id;
+ my $previous_customer_id = $self->requirement_spec->customer_id;
+ my $params = delete($::form->{requirement_spec}) || { };
+ my $cvars = delete($::form->{cvars}) || { };
+
+ # Forcefully make it clear to Rose which custom_variables exist (or don't), so that the ones added with »add_custom_variables« are visible when calling »custom_variables«.
+ if ($is_new) {
+ $params->{custom_variables} = [];
+ } else {
+ $self->requirement_spec->custom_variables;
+ }
$self->requirement_spec->assign_attributes(%{ $params });
+ foreach my $var (@{ $self->requirement_spec->cvars_by_config }) {
+ my $value = $cvars->{ $var->config->name };
+ $value = $::form->parse_amount(\%::myconfig, $value) if $var->config->type eq 'number';
+
+ $var->value($value);
+ }
+
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')
my @errors = $self->requirement_spec->validate;
if (@errors) {
- return $self->js->error(@errors)->render($self) if $::request->is_ajax;
+ return $self->js->error(@errors)->render if $::request->is_ajax;
flash('error', @errors);
$self->render('requirement_spec/new', title => $title);
}
my $db = $self->requirement_spec->db;
- if (!$db->do_transaction(sub {
+ if (!$db->with_transaction(sub {
if ($self->copy_source) {
$self->requirement_spec($self->copy_source->create_copy(%{ $params }));
} else {
- $self->requirement_spec->save;
+ $self->requirement_spec->save(cascade => 1);
+
+ # If the current requirement spec has versions and the
+ # customer's been changed, then the customer of all the versions
+ # has to be changed, too.
+ if ( !$is_new
+ && !$self->requirement_spec->is_template
+ && ($previous_customer_id != $self->requirement_spec->customer_id)) {
+ SL::DB::Manager::RequirementSpec->update_all(
+ set => { customer_id => $self->requirement_spec->customer_id },
+ where => [ working_copy_id => $self->requirement_spec->id ],
+ );
+ }
}
+ 1;
})) {
$::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;
+ return $self->js->error(@errors)->render if $::request->is_ajax;
$self->requirement_spec->id(undef) if $is_new;
flash('error', @errors);
->replaceWith('#basic_settings', $basics_html)
->remove('#basic_settings_form')
->flash('info', $info)
- ->render($self);
+ ->render;
}
flash_later('info', $info);
if (!$is_template) {
%column_defs = (
%column_defs,
- customer => { raw_data => sub { $self->presenter->customer($_[0]->customer, display => 'table-cell', callback => $callback) },
+ customer => { raw_data => sub { $_[0]->customer->presenter->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) },
+ projectnumber => { raw_data => sub { $_[0]->project ? $_[0]->project->presenter->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 } },
);
}
- map { $column_defs{$_}->{text} ||= $::locale->text( $self->models->get_sort_spec->{$_}->{title} ) } keys %column_defs;
+ $column_defs{$_}->{text} ||= $::locale->text( $self->models->get_sort_spec->{$_}->{title} ) for keys %column_defs;
+
+ if (!$is_template) {
+ my %cvar_column_defs = map {
+ my $cfg = $_;
+ (('cvar_' . $cfg->name) => {
+ sub => sub { my $var = $_[0]->cvar_by_name($cfg->name); $var ? $var->value_as_text : '' },
+ text => $cfg->description,
+ visible => $self->include_cvars->{ $cfg->name } ? 1 : 0,
+ })
+ } @{ $self->includeable_cvar_configs };
+
+ push @columns, map { 'cvar_' . $_->name } @{ $self->includeable_cvar_configs };
+ %column_defs = (%column_defs, %cvar_column_defs);
+ }
+
+ my @cvar_column_form_names = ('_include_cvars_from_form', map { "include_cvars_" . $_->name } @{ $self->includeable_cvar_configs });
$report->set_options(
std_column_visibility => 1,
);
$report->set_columns(%column_defs);
$report->set_column_order(@columns);
- $report->set_export_options(qw(list filter));
+ $report->set_export_options(qw(list filter), @cvar_column_form_names);
$report->set_options_from_form;
$self->models->set_report_generator_sort_options(report => $report, sortable_columns => \@sortable);
}
->hide('#text-block-list-empty');
}
- my $node = $self->presenter->requirement_spec_text_block_jstree_data($text_block);
+ my $node = $text_block->presenter->jstree_data;
my $front_back = $text_block->output_position == 0 ? 'front' : 'back';
$self->js
->jstree->create_node('#tree', "#tb-${front_back}", 'last', $node)
sub render_pasted_section {
my ($self, $item, $parent_id) = @_;
- my $node = $self->presenter->requirement_spec_item_jstree_data($item);
+ my $node = $item->presenter->jstree_data;
$self->js
->jstree->create_node('#tree', $parent_id ? "#fb-${parent_id}" : '#sections', 'last', $node)
->jstree->open_node( '#tree', $parent_id ? "#fb-${parent_id}" : '#sections');
}
sub prepare_pictures_for_printing {
- my ($self) = @_;
+ my ($self, $userspath) = @_;
my @files;
- my $userspath = File::Spec->rel2abs($::lx_office_conf{paths}->{userspath});
- my $target = "${userspath}/kivitendo-print-requirement-spec-picture-" . Common::unique_id() . '-';
+ $userspath ||= SL::System::Process::exe_dir() . "/" . $::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;
->replaceWith('#basic_settings', $self->render('requirement_spec/_show_basic_settings', { output => 0 }))
->remove('#project_link_form')
->flash('info', t8('The project link has been updated.'))
- ->render($self);
+ ->render;
}
sub update_project_link_new {
return $self->js
->replaceWith('#project_link_form', $self->render('requirement_spec/_new_project_form', { output => 0 }))
- ->render($self);
+ ->render;
}
sub update_project_link_create {
my @errors = $project->validate;
- return $self->js->error(@errors)->render($self) if @errors;
+ return $self->js->error(@errors)->render if @errors;
my $db = $self->requirement_spec->db;
- if (!$db->do_transaction(sub {
+ if (!$db->with_transaction(sub {
$project->save;
$self->requirement_spec->update_attributes(project_id => $project->id);
})) {
$::lxdebug->message(LXDebug::WARN(), "Error: " . $db->error);
- return $self->js->error(t8('Saving failed. Error message from the database: #1', $db->error))->render($self);
+ return $self->js->error(t8('Saving failed. Error message from the database: #1', $db->error))->render;
}
return $self->invalidate_version
->remove('#project_link_form')
->flash('info', t8('The project has been created.'))
->flash('info', t8('The project link has been updated.'))
- ->render($self);
+ ->render;
}
sub init_models {
return !!$template;
}
+sub _setup_form_action_bar {
+ my ($self) = @_;
+
+ for my $bar ($::request->layout->get('actionbar')) {
+ $bar->add(
+ action => [
+ t8('Save'),
+ submit => [ '#basic_settings_form', { action => 'RequirementSpec/' . ($self->requirement_spec->id ? 'update' : 'create') } ],
+ accesskey => 'enter',
+ ],
+
+ link => [
+ t8('Abort'),
+ link => $self->url_for(action => 'list', is_template => $self->requirement_spec->is_template),
+ ],
+ );
+ }
+}
+
+sub _setup_search_action_bar {
+ my ($self, %params) = @_;
+
+ for my $bar ($::request->layout->get('actionbar')) {
+ $bar->add(
+ action => [
+ t8('Update'),
+ submit => [ '#search_form', { action => 'RequirementSpec/list' } ],
+ accesskey => 'enter',
+ ],
+ link => [
+ t8('Add'),
+ link => $self->url_for(action => 'new', is_template => $::form->{is_template}),
+ ],
+ );
+ }
+}
+
1;