1 package SL::Controller::Project;
5 use parent qw(SL::Controller::Base);
9 use SL::Controller::Helper::GetModels;
10 use SL::Controller::Helper::ParseFilter;
11 use SL::Controller::Helper::ReportGenerator;
14 use SL::DB::DeliveryOrder;
19 use SL::DB::ProjectType;
20 use SL::DB::ProjectStatus;
21 use SL::DB::PurchaseInvoice;
22 use SL::DB::ProjectType;
23 use SL::Helper::Flash;
24 use SL::Locale::String;
28 use Rose::DB::Object::Helpers qw(as_tree);
30 use Rose::Object::MakeMethods::Generic
32 scalar => [ qw(project) ],
33 'scalar --get_set_init' => [ qw(models customers project_types project_statuses projects linked_records employees may_edit_invoice_permissions
34 cvar_configs includeable_cvar_configs include_cvars) ],
37 __PACKAGE__->run_before('check_auth', except => [ qw(ajax_autocomplete) ]);
38 __PACKAGE__->run_before('load_project', only => [ qw(edit update destroy) ]);
39 __PACKAGE__->run_before('use_multiselect_js', only => [ qw(new create edit update) ]);
48 $self->setup_list_action_bar;
50 $self->make_filter_summary;
52 $self->prepare_report;
54 $self->report_generator_list_objects(report => $self->{report}, objects => $self->models->get);
60 $self->project(SL::DB::Project->new);
61 $self->display_form(title => $::locale->text('Create a new project'),
62 callback => $::form->{callback} || $self->url_for(action => 'list'));
68 $self->display_form(title => $::locale->text('Edit project #1', $self->project->projectnumber),
69 callback => $::form->{callback} || $self->url_for(action => 'list'));
75 $self->project(SL::DB::Project->new);
76 $self->create_or_update;
81 $self->create_or_update;
87 if (eval { $self->project->delete; 1; }) {
88 flash_later('info', $::locale->text('The project has been deleted.'));
90 flash_later('error', $::locale->text('The project is in use and cannot be deleted.'));
93 $self->redirect_to(action => 'list');
96 sub action_ajax_autocomplete {
97 my ($self, %params) = @_;
99 $::form->{filter}{'all:substr:multi::ilike'} =~ s{[\(\)]+}{}g;
101 # if someone types something, and hits enter, assume he entered the full name.
102 # if something matches, treat that as the sole match
103 # since we need a second get models instance with different filters for that,
104 # we only modify the original filter temporarily in place
105 if ($::form->{prefer_exact}) {
106 local $::form->{filter}{'all::ilike'} = delete local $::form->{filter}{'all:substr:multi::ilike'};
107 # active and valid filters are use as they are
109 my $exact_models = SL::Controller::Helper::GetModels->new(
112 paginated => { per_page => 2 },
113 with_objects => [ 'customer', 'project_status', 'project_type' ],
116 if (1 == scalar @{ $exact_matches = $exact_models->get }) {
117 $self->project($exact_matches);
121 $::form->{sort_by} = 'customer_and_description';
125 value => $_->full_description(style => 'full'),
126 label => $_->full_description(style => 'full'),
128 projectnumber => $_->projectnumber,
129 description => $_->description,
130 cvars => { map { ($_->config->name => { value => $_->value_as_text, is_valid => $_->is_valid }) } @{ $_->cvars_by_config } },
132 } @{ $self->projects }; # neato: if exact match triggers we don't even need the init_projects
134 $self->render(\ SL::JSON::to_json(\@hashes), { layout => 0, type => 'json', process => 0 });
137 sub action_test_page {
138 $_[0]->render('project/test_page');
141 sub action_project_picker_search {
142 $_[0]->render('project/project_picker_search', { layout => 0 });
145 sub action_project_picker_result {
146 $_[0]->render('project/_project_picker_result', { layout => 0 });
154 $::auth->assert('project_edit');
161 sub init_project_statuses { SL::DB::Manager::ProjectStatus->get_all_sorted }
162 sub init_project_types { SL::DB::Manager::ProjectType->get_all_sorted }
163 sub init_employees { SL::DB::Manager::Employee->get_all_sorted }
164 sub init_may_edit_invoice_permissions { $::auth->assert('project_edit_view_invoices_permission', 1) }
165 sub init_cvar_configs { SL::DB::Manager::CustomVariableConfig->get_all_sorted(where => [ module => 'Projects' ]) }
166 sub init_includeable_cvar_configs { [ grep { $_->includeable } @{ $_[0]->cvar_configs } ] };
168 sub init_include_cvars {
170 return { map { ($_->name => $::form->{"include_cvars_" . $_->name}) } @{ $self->cvar_configs } } if $::form->{_include_cvars_from_form};
171 return { map { ($_->name => ($_->includeable && $_->included_by_default)) } @{ $self->cvar_configs } };
174 sub init_linked_records {
179 SL::DB::Manager::Invoice-> get_all(where => [ invoice => 1, or => [ globalproject_id => $self->project->id, 'invoiceitems.project_id' => $self->project->id ] ],
180 with_objects => [ 'invoiceitems', 'customer' ],
181 distinct => [ 'customer' ],
182 sort_by => 'transdate ASC'),
183 SL::DB::Manager::Invoice-> get_all(where => [ invoice => 0, or => [ globalproject_id => $self->project->id, 'transactions.project_id' => $self->project->id ] ],
184 with_objects => [ 'transactions', 'customer' ],
185 distinct => [ 'customer' ],
186 sort_by => 'transdate ASC'),
187 SL::DB::Manager::PurchaseInvoice->get_all(where => [ invoice => 1,
188 or => [ globalproject_id => $self->project->id, 'invoiceitems.project_id' => $self->project->id ]
190 with_objects => [ 'invoiceitems', 'vendor' ],
191 distinct => [ 'customer' ],
192 sort_by => 'transdate ASC'),
193 SL::DB::Manager::PurchaseInvoice->get_all(where => [ invoice => 0,
194 or => [ globalproject_id => $self->project->id, 'transactions.project_id' => $self->project->id ]
196 with_objects => [ 'transactions', 'vendor' ],
197 distinct => [ 'customer' ],
198 sort_by => 'transdate ASC'),
199 SL::DB::Manager::GLTransaction-> get_all(where => [ 'transactions.project_id' => $self->project->id ],
200 with_objects => [ 'transactions' ],
202 sort_by => 'transdate ASC'),
203 SL::DB::Manager::Order-> get_all(where => [ or => [ globalproject_id => $self->project->id, 'orderitems.project_id' => $self->project->id ] ],
204 with_objects => [ 'orderitems', 'customer', 'vendor' ],
205 distinct => [ 'customer', 'vendor' ],
206 sort_by => 'transdate ASC' ),
207 SL::DB::Manager::DeliveryOrder-> get_all(where => [ or => [ globalproject_id => $self->project->id, 'orderitems.project_id' => $self->project->id ] ],
208 with_objects => [ 'orderitems', 'customer', 'vendor' ],
209 distinct => [ 'customer', 'vendor' ],
210 sort_by => 'transdate ASC'),
216 if ($::form->{no_paginate}) {
217 $_[0]->models->disable_plugin('paginated');
225 my @customer_id = $self->project && $self->project->customer_id ? (id => $self->project->customer_id) : ();
227 return SL::DB::Manager::Customer->get_all_sorted(where => [ or => [ obsolete => 0, obsolete => undef, @customer_id ]]);
230 sub use_multiselect_js {
231 $::request->layout->use_javascript("${_}.js") for qw(jquery.selectboxes jquery.multiselect2side);
235 my ($self, %params) = @_;
237 $params{CUSTOM_VARIABLES} = CVar->get_custom_variables(module => 'Projects', trans_id => $self->project->id);
239 if ($params{keep_cvars}) {
240 for my $cvar (@{ $params{CUSTOM_VARIABLES} }) {
241 $cvar->{value} = $::form->{"cvar_$cvar->{name}"} if $::form->{"cvar_$cvar->{name}"};
245 CVar->render_inputs(variables => $params{CUSTOM_VARIABLES}) if @{ $params{CUSTOM_VARIABLES} };
247 $self->setup_edit_action_bar(callback => $params{callback});
249 $self->render('project/form', %params);
252 sub create_or_update {
254 my $is_new = !$self->project->id;
255 my $params = delete($::form->{project}) || { };
257 if (!$self->may_edit_invoice_permissions) {
258 delete $params->{employee_invoice_permissions};
259 } elsif (!$params->{employee_invoice_permissions}) {
260 $params->{employee_invoice_permissions} = [];
263 delete $params->{id};
264 $self->project->assign_attributes(%{ $params });
266 my @errors = $self->project->validate;
269 flash('error', @errors);
270 $self->display_form(title => $is_new ? $::locale->text('Create a new project') : $::locale->text('Edit project'),
271 callback => $::form->{callback},
276 $self->project->save;
278 CVar->save_custom_variables(
279 dbh => $self->project->db->dbh,
280 module => 'Projects',
281 trans_id => $self->project->id,
282 variables => $::form,
286 flash_later('info', $is_new ? $::locale->text('The project has been created.') : $::locale->text('The project has been saved.'));
288 $self->redirect_to($::form->{callback} || (action => 'search'));
293 $self->project(SL::DB::Project->new(id => $::form->{id})->load);
300 my $callback = $self->models->get_callback;
302 my $report = SL::ReportGenerator->new(\%::myconfig, $::form);
303 $self->{report} = $report;
305 my @columns = qw(project_status customer projectnumber description active valid project_type);
306 my @sortable = qw(projectnumber description customer project_type project_status);
309 projectnumber => { obj_link => sub { $self->url_for(action => 'edit', id => $_[0]->id, callback => $callback) } },
310 description => { obj_link => sub { $self->url_for(action => 'edit', id => $_[0]->id, callback => $callback) } },
311 project_type => { sub => sub { $_[0]->project_type->description } },
312 project_status => { sub => sub { $_[0]->project_status->description }, text => t8('Status') },
313 customer => { sub => sub { !$_[0]->customer_id ? '' : $_[0]->customer->name },
314 raw_data => sub { !$_[0]->customer_id ? '' : $_[0]->customer->presenter->customer(display => 'table-cell', callback => $callback) } },
315 active => { sub => sub { $_[0]->active ? $::locale->text('Active') : $::locale->text('Inactive') },
316 text => $::locale->text('Active') },
317 valid => { sub => sub { $_[0]->valid ? $::locale->text('Valid') : $::locale->text('Invalid') },
318 text => $::locale->text('Valid') },
321 map { $column_defs{$_}->{text} ||= $::locale->text( $self->models->get_sort_spec->{$_}->{title} ) } keys %column_defs;
324 my %cvar_column_defs = map {
326 (('cvar_' . $cfg->name) => {
327 sub => sub { my $var = $_[0]->cvar_by_name($cfg->name); $var ? $var->value_as_text : '' },
328 text => $cfg->description,
329 visible => $self->include_cvars->{ $cfg->name } ? 1 : 0,
331 } @{ $self->includeable_cvar_configs };
333 push @columns, map { 'cvar_' . $_->name } @{ $self->includeable_cvar_configs };
334 %column_defs = (%column_defs, %cvar_column_defs);
336 my @cvar_column_form_names = ('_include_cvars_from_form', map { "include_cvars_" . $_->name } @{ $self->includeable_cvar_configs });
338 $report->set_options(
339 std_column_visibility => 1,
340 controller_class => 'Project',
341 output_format => 'HTML',
342 title => $::locale->text('Projects'),
343 allow_pdf_export => 1,
344 allow_csv_export => 1,
346 $report->set_columns(%column_defs);
347 $report->set_column_order(@columns);
348 $report->set_export_options(qw(list filter), @cvar_column_form_names);
349 $report->set_options_from_form;
350 $self->models->disable_plugin('paginated') if $report->{options}{output_format} =~ /^(pdf|csv)$/i;
351 $self->models->set_report_generator_sort_options(report => $report, sortable_columns => \@sortable);
352 $report->set_options(
353 raw_top_info_text => $self->render('project/report_top', { output => 0 }),
354 raw_bottom_info_text => $self->render('project/report_bottom', { output => 0 }),
361 SL::Controller::Helper::GetModels->new(
365 by => 'projectnumber',
368 customer => t8('Customer'),
369 description => t8('Description'),
370 projectnumber => t8('Project Number'),
371 project_type => t8('Project Type'),
372 project_status => t8('Project Status'),
373 customer_and_description => 1,
375 with_objects => [ 'customer', 'project_status', 'project_type' ],
379 sub make_filter_summary {
382 my $filter = $::form->{filter} || {};
386 [ $filter->{"projectnumber:substr::ilike"}, t8('Project Number') ],
387 [ $filter->{"description:substr::ilike"}, t8('Description') ],
388 [ $filter->{customer}{"name:substr::ilike"}, t8('Customer') ],
389 [ $filter->{"project_type_id"}, t8('Project Type'), sub { SL::DB::Manager::ProjectType->find_by(id => $filter->{"project_type_id"})->description } ],
390 [ $filter->{"project_status_id"}, t8('Project Status'), sub { SL::DB::Manager::ProjectStatus->find_by(id => $filter->{"project_status_id"})->description } ],
394 [ $filter->{active} eq 'active', $::locale->text('Active') ],
395 [ $filter->{active} eq 'inactive', $::locale->text('Inactive') ],
396 [ $filter->{valid} eq 'valid', $::locale->text('Valid') ],
397 [ $filter->{valid} eq 'invalid', $::locale->text('Invalid') ],
398 [ $filter->{orphaned}, $::locale->text('Orphaned') ],
402 push @filter_strings, "$_->[1]" if $_->[0];
405 push @filter_strings, "$_->[1]: " . ($_->[2] ? $_->[2]->() : $_->[0]) if $_->[0];
408 $self->{filter_summary} = join ', ', @filter_strings;
411 sub setup_edit_action_bar {
412 my ($self, %params) = @_;
414 my $is_new = !$self->project->id;
416 for my $bar ($::request->layout->get('actionbar')) {
421 submit => [ '#form', { action => 'Project/' . ($is_new ? 'create' : 'update') } ],
422 accesskey => 'enter',
426 submit => [ '#form', { action => 'Project/create' }],
427 disabled => $is_new ? t8('The object has not been saved yet.') : undef,
429 ], # end of combobox "Save"
433 submit => [ '#form', { action => 'Project/destroy' } ],
434 confirm => $::locale->text('Do you really want to delete this object?'),
435 disabled => $is_new ? t8('This object has not been saved yet.')
436 : $self->project->is_used ? t8('This object has already been used.')
442 link => $params{callback} || $self->url_for(action => 'list'),
448 sub setup_list_action_bar {
449 my ($self, %params) = @_;
451 for my $bar ($::request->layout->get('actionbar')) {
455 submit => [ '#search_form', { action => 'Project/list' } ],
456 accesskey => 'enter',
460 link => $self->url_for(action => 'new'),