SL/Controller/Project.pm

   1 package SL::Controller::Project;
   2
   3 use strict;
   4
   5 use parent qw(SL::Controller::Base);
   6
   7 use Clone qw(clone);
   8
   9 use SL::Controller::Helper::GetModels;
  10 use SL::Controller::Helper::ParseFilter;
  11 use SL::Controller::Helper::ReportGenerator;
  12 use SL::CVar;
  13 use SL::DB::Customer;
  14 use SL::DB::DeliveryOrder;
  15 use SL::DB::Employee;
  16 use SL::DB::Invoice;
  17 use SL::DB::Order;
  18 use SL::DB::Project;
  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;
  25
  26 use Data::Dumper;
  27 use JSON;
  28 use Rose::DB::Object::Helpers qw(as_tree);
  29
  30 use Rose::Object::MakeMethods::Generic
  31 (
  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 );
  35
  36 __PACKAGE__->run_before('check_auth',   except => [ qw(ajax_autocomplete) ]);
  37 __PACKAGE__->run_before('load_project', only   => [ qw(edit update destroy) ]);
  38 __PACKAGE__->run_before('use_multiselect_js', only => [ qw(new create edit update) ]);
  39
  40 #
  41 # actions
  42 #
  43
  44 sub action_list {
  45   my ($self) = @_;
  46
  47   $self->setup_list_action_bar;
  48
  49   $self->make_filter_summary;
  50
  51   $self->prepare_report;
  52
  53   $self->report_generator_list_objects(report => $self->{report}, objects => $self->models->get);
  54 }
  55
  56 sub action_new {
  57   my ($self) = @_;
  58
  59   $self->project(SL::DB::Project->new);
  60   $self->display_form(title    => $::locale->text('Create a new project'),
  61                       callback => $::form->{callback} || $self->url_for(action => 'list'));
  62 }
  63
  64 sub action_edit {
  65   my ($self) = @_;
  66
  67   $self->display_form(title    => $::locale->text('Edit project #1', $self->project->projectnumber),
  68                       callback => $::form->{callback} || $self->url_for(action => 'list'));
  69 }
  70
  71 sub action_create {
  72   my ($self) = @_;
  73
  74   $self->project(SL::DB::Project->new);
  75   $self->create_or_update;
  76 }
  77
  78 sub action_update {
  79   my ($self) = @_;
  80   $self->create_or_update;
  81 }
  82
  83 sub action_destroy {
  84   my ($self) = @_;
  85
  86   if (eval { $self->project->delete; 1; }) {
  87     flash_later('info',  $::locale->text('The project has been deleted.'));
  88   } else {
  89     flash_later('error', $::locale->text('The project is in use and cannot be deleted.'));
  90   }
  91
  92   $self->redirect_to(action => 'search');
  93 }
  94
  95 sub action_ajax_autocomplete {
  96   my ($self, %params) = @_;
  97
  98   $::form->{filter}{'all:substr:multi::ilike'} =~ s{[\(\)]+}{}g;
  99
 100   # if someone types something, and hits enter, assume he entered the full name.
 101   # if something matches, treat that as sole match
 102   # unfortunately get_models can't do more than one per package atm, so we d it
 103   # the oldfashioned way.
 104   if ($::form->{prefer_exact}) {
 105     my $exact_matches;
 106     if (1 == scalar @{ $exact_matches = SL::DB::Manager::Project->get_all(
 107       query => [
 108         valid => 1,
 109         or => [
 110           description   => { ilike => $::form->{filter}{'all:substr:multi::ilike'} },
 111           projectnumber => { ilike => $::form->{filter}{'all:substr:multi::ilike'} },
 112         ]
 113       ],
 114       limit => 2,
 115     ) }) {
 116       $self->projects($exact_matches);
 117     }
 118   }
 119
 120   $::form->{sort_by} = 'customer_and_description';
 121
 122   my @hashes = map {
 123    +{
 124      value         => $_->full_description(style => 'full'),
 125      label         => $_->full_description(style => 'full'),
 126      id            => $_->id,
 127      projectnumber => $_->projectnumber,
 128      description   => $_->description,
 129      cvars         => { map { ($_->config->name => { value => $_->value_as_text, is_valid => $_->is_valid }) } @{ $_->cvars_by_config } },
 130     }
 131   } @{ $self->projects }; # neato: if exact match triggers we don't even need the init_projects
 132
 133   $self->render(\ SL::JSON::to_json(\@hashes), { layout => 0, type => 'json', process => 0 });
 134 }
 135
 136 sub action_test_page {
 137   $_[0]->render('project/test_page');
 138 }
 139
 140 #
 141 # filters
 142 #
 143
 144 sub check_auth {
 145   $::auth->assert('project_edit');
 146 }
 147
 148 #
 149 # helpers
 150 #
 151
 152 sub init_project_statuses { SL::DB::Manager::ProjectStatus->get_all_sorted }
 153 sub init_project_types    { SL::DB::Manager::ProjectType->get_all_sorted   }
 154 sub init_employees        { SL::DB::Manager::Employee->get_all_sorted   }
 155 sub init_may_edit_invoice_permissions { $::auth->assert('project_edit_view_invoices_permission', 1) }
 156
 157 sub init_linked_records {
 158   my ($self) = @_;
 159   return [
 160     map  { @{ $_ } }
 161     grep { $_      } (
 162       SL::DB::Manager::Invoice->        get_all(where        => [ invoice => 1, or => [ globalproject_id => $self->project->id, 'invoiceitems.project_id' => $self->project->id ] ],
 163                                                 with_objects => [ 'invoiceitems', 'customer' ],
 164                                                 distinct     => [ 'customer' ],
 165                                                 sort_by       => 'transdate ASC'),
 166       SL::DB::Manager::Invoice->        get_all(where        => [ invoice => 0, or => [ globalproject_id => $self->project->id, 'transactions.project_id' => $self->project->id ] ],
 167                                                 with_objects => [ 'transactions', 'customer' ],
 168                                                 distinct     => [ 'customer' ],
 169                                                 sort_by       => 'transdate ASC'),
 170       SL::DB::Manager::PurchaseInvoice->get_all(where => [ invoice => 1,
 171                                                            or => [ globalproject_id => $self->project->id, 'invoiceitems.project_id' => $self->project->id ]
 172                                                          ],
 173                                                 with_objects => [ 'invoiceitems', 'vendor' ],
 174                                                 distinct     => [ 'customer' ],
 175                                                 sort_by => 'transdate ASC'),
 176       SL::DB::Manager::PurchaseInvoice->get_all(where => [ invoice => 0,
 177                                                            or => [ globalproject_id => $self->project->id, 'transactions.project_id' => $self->project->id ]
 178                                                          ],
 179                                                 with_objects => [ 'transactions', 'vendor' ],
 180                                                 distinct     => [ 'customer' ],
 181                                                 sort_by => 'transdate ASC'),
 182       SL::DB::Manager::GLTransaction->  get_all(where => [ 'transactions.project_id' => $self->project->id ],
 183                                                 with_objects => [ 'transactions' ],
 184                                                 distinct     => 1,
 185                                                 sort_by => 'transdate ASC'),
 186       SL::DB::Manager::Order->          get_all(where => [ or => [ globalproject_id => $self->project->id, 'orderitems.project_id' => $self->project->id ] ],
 187                                                 with_objects => [ 'orderitems', 'customer', 'vendor' ],
 188                                                 distinct => [ 'customer', 'vendor' ],
 189                                                 sort_by => 'transdate ASC' ),
 190       SL::DB::Manager::DeliveryOrder->  get_all(where => [ or => [ globalproject_id => $self->project->id, 'orderitems.project_id' => $self->project->id ] ],
 191                                                 with_objects => [ 'orderitems', 'customer', 'vendor' ],
 192                                                 distinct => [ 'customer', 'vendor' ],
 193                                                 sort_by => 'transdate ASC'),
 194     )];
 195 }
 196
 197
 198 sub init_projects {
 199   if ($::form->{no_paginate}) {
 200     $_[0]->models->disable_plugin('paginated');
 201   }
 202
 203   $_[0]->models->get;
 204 }
 205
 206 sub init_customers {
 207   my ($self)      = @_;
 208   my @customer_id = $self->project && $self->project->customer_id ? (id => $self->project->customer_id) : ();
 209
 210   return SL::DB::Manager::Customer->get_all_sorted(where => [ or => [ obsolete => 0, obsolete => undef, @customer_id ]]);
 211 }
 212
 213 sub use_multiselect_js {
 214   $::request->layout->use_javascript("${_}.js") for qw(jquery.selectboxes jquery.multiselect2side);
 215 }
 216
 217 sub display_form {
 218   my ($self, %params) = @_;
 219
 220   $params{CUSTOM_VARIABLES}  = CVar->get_custom_variables(module => 'Projects', trans_id => $self->project->id);
 221
 222   if ($params{keep_cvars}) {
 223     for my $cvar (@{ $params{CUSTOM_VARIABLES} }) {
 224       $cvar->{value} = $::form->{"cvar_$cvar->{name}"} if $::form->{"cvar_$cvar->{name}"};
 225     }
 226   }
 227
 228   CVar->render_inputs(variables => $params{CUSTOM_VARIABLES}) if @{ $params{CUSTOM_VARIABLES} };
 229
 230   $self->setup_edit_action_bar(callback => $params{callback});
 231
 232   $self->render('project/form', %params);
 233 }
 234
 235 sub create_or_update {
 236   my $self   = shift;
 237   my $is_new = !$self->project->id;
 238   my $params = delete($::form->{project}) || { };
 239
 240   if (!$self->may_edit_invoice_permissions) {
 241     delete $params->{employee_invoice_permissions};
 242   } elsif (!$params->{employee_invoice_permissions}) {
 243     $params->{employee_invoice_permissions} = [];
 244   }
 245
 246   delete $params->{id};
 247   $self->project->assign_attributes(%{ $params });
 248
 249   my @errors = $self->project->validate;
 250
 251   if (@errors) {
 252     flash('error', @errors);
 253     $self->display_form(title    => $is_new ? $::locale->text('Create a new project') : $::locale->text('Edit project'),
 254                         callback => $::form->{callback},
 255                         keep_cvars => 1);
 256     return;
 257   }
 258
 259   $self->project->save;
 260
 261   CVar->save_custom_variables(
 262     dbh          => $self->project->db->dbh,
 263     module       => 'Projects',
 264     trans_id     => $self->project->id,
 265     variables    => $::form,
 266     always_valid => 1,
 267   );
 268
 269   flash_later('info', $is_new ? $::locale->text('The project has been created.') : $::locale->text('The project has been saved.'));
 270
 271   $self->redirect_to($::form->{callback} || (action => 'search'));
 272 }
 273
 274 sub load_project {
 275   my ($self) = @_;
 276   $self->project(SL::DB::Project->new(id => $::form->{id})->load);
 277 }
 278
 279
 280 sub prepare_report {
 281   my ($self)      = @_;
 282
 283   my $callback    = $self->models->get_callback;
 284
 285   my $report      = SL::ReportGenerator->new(\%::myconfig, $::form);
 286   $self->{report} = $report;
 287
 288   my @columns     = qw(project_status customer projectnumber description active valid project_type);
 289   my @sortable    = qw(projectnumber description customer              project_type project_status);
 290
 291   my %column_defs = (
 292     projectnumber => { obj_link => sub { $self->url_for(action => 'edit', id => $_[0]->id, callback => $callback) } },
 293     description   => { obj_link => sub { $self->url_for(action => 'edit', id => $_[0]->id, callback => $callback) } },
 294     project_type  => { sub  => sub { $_[0]->project_type->description } },
 295     project_status => { sub  => sub { $_[0]->project_status->description }, text => t8('Status') },
 296     customer      => { sub       => sub { !$_[0]->customer_id ? '' : $_[0]->customer->name },
 297                        raw_data  => sub { !$_[0]->customer_id ? '' : $_[0]->customer->presenter->customer(display => 'table-cell', callback => $callback) } },
 298     active        => { sub  => sub { $_[0]->active   ? $::locale->text('Active') : $::locale->text('Inactive') },
 299                        text => $::locale->text('Active') },
 300     valid         => { sub  => sub { $_[0]->valid    ? $::locale->text('Valid')  : $::locale->text('Invalid')  },
 301                        text => $::locale->text('Valid')  },
 302   );
 303
 304   map { $column_defs{$_}->{text} ||= $::locale->text( $self->models->get_sort_spec->{$_}->{title} ) } keys %column_defs;
 305
 306   $report->set_options(
 307     std_column_visibility => 1,
 308     controller_class      => 'Project',
 309     output_format         => 'HTML',
 310     title                 => $::locale->text('Projects'),
 311     allow_pdf_export      => 1,
 312     allow_csv_export      => 1,
 313   );
 314   $report->set_columns(%column_defs);
 315   $report->set_column_order(@columns);
 316   $report->set_export_options(qw(list filter));
 317   $report->set_options_from_form;
 318   $self->models->disable_plugin('paginated') if $report->{options}{output_format} =~ /^(pdf|csv)$/i;
 319   $self->models->set_report_generator_sort_options(report => $report, sortable_columns => \@sortable);
 320   $report->set_options(
 321     raw_top_info_text     => $self->render('project/report_top',    { output => 0 }),
 322     raw_bottom_info_text  => $self->render('project/report_bottom', { output => 0 }),
 323   );
 324 }
 325
 326 sub init_models {
 327   my ($self) = @_;
 328
 329   SL::Controller::Helper::GetModels->new(
 330     controller => $self,
 331     sorted => {
 332       _default => {
 333         by    => 'projectnumber',
 334         dir   => 1,
 335       },
 336       customer       => t8('Customer'),
 337       description    => t8('Description'),
 338       projectnumber  => t8('Project Number'),
 339       project_type   => t8('Project Type'),
 340       project_status => t8('Project Status'),
 341       customer_and_description => 1,
 342     },
 343     with_objects => [ 'customer', 'project_status', 'project_type' ],
 344   );
 345 }
 346
 347 sub make_filter_summary {
 348   my ($self) = @_;
 349
 350   my $filter = $::form->{filter} || {};
 351   my @filter_strings;
 352
 353   my @filters = (
 354     [ $filter->{"projectnumber:substr::ilike"},  t8('Project Number') ],
 355     [ $filter->{"description:substr::ilike"},    t8('Description')    ],
 356     [ $filter->{customer}{"name:substr::ilike"}, t8('Customer')       ],
 357     [ $filter->{"project_type_id"},              t8('Project Type'),    sub { SL::DB::Manager::ProjectType->find_by(id => $filter->{"project_type_id"})->description }   ],
 358     [ $filter->{"project_status_id"},            t8('Project Status'),  sub { SL::DB::Manager::ProjectStatus->find_by(id => $filter->{"project_status_id"})->description } ],
 359   );
 360
 361   my @flags = (
 362     [ $filter->{active} eq 'active',    $::locale->text('Active')      ],
 363     [ $filter->{active} eq 'inactive',  $::locale->text('Inactive')    ],
 364     [ $filter->{valid}  eq 'valid',     $::locale->text('Valid')       ],
 365     [ $filter->{valid}  eq 'invalid',   $::locale->text('Invalid')     ],
 366     [ $filter->{orphaned},              $::locale->text('Orphaned')    ],
 367   );
 368
 369   for (@flags) {
 370     push @filter_strings, "$_->[1]" if $_->[0];
 371   }
 372   for (@filters) {
 373     push @filter_strings, "$_->[1]: " . ($_->[2] ? $_->[2]->() : $_->[0]) if $_->[0];
 374   }
 375
 376   $self->{filter_summary} = join ', ', @filter_strings;
 377 }
 378
 379 sub setup_edit_action_bar {
 380   my ($self, %params) = @_;
 381
 382   my $is_new = !$self->project->id;
 383
 384   for my $bar ($::request->layout->get('actionbar')) {
 385     $bar->add(
 386       combobox => [
 387         action => [
 388           t8('Save'),
 389           submit    => [ '#form', { action => 'Project/' . ($is_new ? 'create' : 'update') } ],
 390           accesskey => 'enter',
 391         ],
 392         action => [
 393           t8('Save as new'),
 394           submit   => [ '#form', { action => 'Project/create' }],
 395           disabled => $is_new ? t8('The object has not been saved yet.') : undef,
 396         ],
 397       ], # end of combobox "Save"
 398
 399       action => [
 400         t8('Delete'),
 401         submit   => [ '#form', { action => 'Project/destroy' } ],
 402         confirm  => $::locale->text('Do you really want to delete this object?'),
 403         disabled => $is_new                 ? t8('This object has not been saved yet.')
 404                   : $self->project->is_used ? t8('This object has already been used.')
 405                   :                           undef,
 406       ],
 407
 408       link => [
 409         t8('Abort'),
 410         link => $params{callback} || $self->url_for(action => 'list'),
 411       ],
 412     );
 413   }
 414 }
 415
 416 sub setup_list_action_bar {
 417   my ($self, %params) = @_;
 418
 419   for my $bar ($::request->layout->get('actionbar')) {
 420     $bar->add(
 421       action => [
 422         t8('Update'),
 423         submit    => [ '#search_form', { action => 'Project/list' } ],
 424         accesskey => 'enter',
 425       ],
 426       link => [
 427         t8('Add'),
 428         link => $self->url_for(action => 'new'),
 429       ],
 430     );
 431   }
 432 }
 433
 434 1;