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::Invoice;
  16 use SL::DB::Order;
  17 use SL::DB::Project;
  18 use SL::DB::PurchaseInvoice;
  19 use SL::DB::ProjectType;
  20 use SL::Helper::Flash;
  21 use SL::Locale::String;
  22
  23 use Rose::Object::MakeMethods::Generic
  24 (
  25  scalar => [ qw(project linked_records) ],
  26  'scalar --get_set_init' => [ qw(models) ],
  27 );
  28
  29 __PACKAGE__->run_before('check_auth');
  30 __PACKAGE__->run_before('load_project',       only => [ qw(edit update destroy) ]);
  31
  32 #
  33 # actions
  34 #
  35
  36 sub action_search {
  37   my ($self) = @_;
  38
  39   my %params;
  40
  41   $params{ALL_PROJECT_TYPES} = SL::DB::Manager::ProjectType->get_all_sorted;
  42   $params{CUSTOM_VARIABLES}  = CVar->get_configs(module => 'Projects');
  43   ($params{CUSTOM_VARIABLES_FILTER_CODE}, $params{CUSTOM_VARIABLES_INCLUSION_CODE})
  44     = CVar->render_search_options(variables      => $params{CUSTOM_VARIABLES},
  45                                   include_prefix => 'l_',
  46                                   include_value  => 'Y');
  47
  48   $self->render('project/search', %params);
  49 }
  50
  51 sub action_list {
  52   my ($self) = @_;
  53
  54   # $self->make_filter_summary;
  55
  56   my $projects = $self->models->get;
  57
  58   $self->prepare_report;
  59
  60   $self->report_generator_list_objects(report => $self->{report}, objects => $projects);
  61 }
  62
  63 sub action_new {
  64   my ($self) = @_;
  65
  66   $self->project(SL::DB::Project->new);
  67   $self->display_form(title    => $::locale->text('Create a new project'),
  68                       callback => $::form->{callback} || $self->url_for(action => 'new'));
  69 }
  70
  71 sub action_edit {
  72   my ($self) = @_;
  73
  74   $self->get_linked_records;
  75   $self->display_form(title    => $::locale->text('Edit project #1', $self->project->projectnumber),
  76                       callback => $::form->{callback} || $self->url_for(action => 'edit', id => $self->project->id));
  77 }
  78
  79 sub action_create {
  80   my ($self) = @_;
  81
  82   $self->project(SL::DB::Project->new);
  83   $self->create_or_update;
  84 }
  85
  86 sub action_update {
  87   my ($self) = @_;
  88   $self->create_or_update;
  89 }
  90
  91 sub action_destroy {
  92   my ($self) = @_;
  93
  94   if (eval { $self->project->delete; 1; }) {
  95     flash_later('info',  $::locale->text('The project has been deleted.'));
  96   } else {
  97     flash_later('error', $::locale->text('The project is in use and cannot be deleted.'));
  98   }
  99
 100   $self->redirect_to(action => 'search');
 101 }
 102
 103 #
 104 # filters
 105 #
 106
 107 sub check_auth {
 108   $::auth->assert('project_edit');
 109 }
 110
 111 #
 112 # helpers
 113 #
 114
 115 sub display_form {
 116   my ($self, %params) = @_;
 117
 118   $params{ALL_CUSTOMERS}     = SL::DB::Manager::Customer->get_all_sorted(where => [ or => [ obsolete => 0, obsolete => undef, id => $self->project->customer_id ]]);
 119   $params{ALL_PROJECT_TYPES} = SL::DB::Manager::ProjectType->get_all_sorted;
 120   $params{CUSTOM_VARIABLES}  = CVar->get_custom_variables(module => 'Projects', trans_id => $self->project->id);
 121
 122   if ($params{keep_cvars}) {
 123     for my $cvar (@{ $params{CUSTOM_VARIABLES} }) {
 124       $cvar->{value} = $::form->{"cvar_$cvar->{name}"} if $::form->{"cvar_$cvar->{name}"};
 125     }
 126   }
 127
 128   CVar->render_inputs(variables => $params{CUSTOM_VARIABLES}) if @{ $params{CUSTOM_VARIABLES} };
 129
 130   $self->render('project/form', %params);
 131 }
 132
 133 sub create_or_update {
 134   my $self   = shift;
 135   my $is_new = !$self->project->id;
 136   my $params = delete($::form->{project}) || { };
 137
 138   delete $params->{id};
 139   $self->project->assign_attributes(%{ $params });
 140
 141   my @errors = $self->project->validate;
 142
 143   if (@errors) {
 144     flash('error', @errors);
 145     $self->display_form(title    => $is_new ? $::locale->text('Create a new project') : $::locale->text('Edit project'),
 146                         callback => $::form->{callback},
 147                         keep_cvars => 1);
 148     return;
 149   }
 150
 151   $self->project->save;
 152
 153   CVar->save_custom_variables(
 154     dbh          => $self->project->db->dbh,
 155     module       => 'Projects',
 156     trans_id     => $self->project->id,
 157     variables    => $::form,
 158     always_valid => 1,
 159   );
 160
 161   flash_later('info', $is_new ? $::locale->text('The project has been created.') : $::locale->text('The project has been saved.'));
 162
 163   $self->redirect_to($::form->{callback} || (action => 'search'));
 164 }
 165
 166 sub load_project {
 167   my ($self) = @_;
 168   $self->project(SL::DB::Project->new(id => $::form->{id})->load);
 169 }
 170
 171 sub get_linked_records {
 172   my ($self) = @_;
 173
 174   $self->linked_records([
 175     map  { @{ $_ } }
 176     grep { $_      } (
 177       SL::DB::Manager::Order->          get_all(where => [ globalproject_id => $self->project->id ], with_objects => [ 'customer', 'vendor' ], sort_by => 'transdate ASC'),
 178       SL::DB::Manager::DeliveryOrder->  get_all(where => [ globalproject_id => $self->project->id ], with_objects => [ 'customer', 'vendor' ], sort_by => 'transdate ASC'),
 179       SL::DB::Manager::Invoice->        get_all(where => [ globalproject_id => $self->project->id ], with_objects => [ 'customer'           ], sort_by => 'transdate ASC'),
 180       SL::DB::Manager::PurchaseInvoice->get_all(where => [ globalproject_id => $self->project->id ], with_objects => [             'vendor' ], sort_by => 'transdate ASC'),
 181     )]);
 182 }
 183
 184 sub setup_db_args_from_filter {
 185   my ($self) = @_;
 186
 187   $self->{filter} = {};
 188   my %args = parse_filter(
 189     $self->_pre_parse_filter($::form->{filter}, $self->{filter}),
 190     with_objects => [ 'customer', 'project_type' ],
 191     launder_to   => $self->{filter},
 192   );
 193
 194   $self->db_args(\%args);
 195 }
 196
 197 sub prepare_report {
 198   my ($self)      = @_;
 199
 200   my $callback    = $self->models->get_callback;
 201
 202   my $report      = SL::ReportGenerator->new(\%::myconfig, $::form);
 203   $self->{report} = $report;
 204
 205   my @columns     = qw(projectnumber description customer active valid project_type);
 206   my @sortable    = qw(projectnumber description customer              project_type);
 207
 208   my %column_defs = (
 209     projectnumber => { obj_link => sub { $self->url_for(action => 'edit', id => $_[0]->id, callback => $callback) } },
 210     description   => { obj_link => sub { $self->url_for(action => 'edit', id => $_[0]->id, callback => $callback) } },
 211     project_type  => { sub  => sub { $_[0]->project_type->description } },
 212     customer      => { sub  => sub { $_[0]->customer ? $_[0]->customer->name     : '' } },
 213     active        => { sub  => sub { $_[0]->active   ? $::locale->text('Active') : $::locale->text('Inactive') },
 214                        text => $::locale->text('Active') },
 215     valid         => { sub  => sub { $_[0]->valid    ? $::locale->text('Valid')  : $::locale->text('Invalid')  },
 216                        text => $::locale->text('Valid')  },
 217   );
 218
 219   map { $column_defs{$_}->{text} ||= $::locale->text( $self->models->get_sort_spec->{$_}->{title} ) } keys %column_defs;
 220
 221   if ( $report->{options}{output_format} =~ /^(pdf|csv)$/i ) {
 222     $self->models->disable_plugin('paginated');
 223   }
 224   $report->set_options(
 225     std_column_visibility => 1,
 226     controller_class      => 'Project',
 227     output_format         => 'HTML',
 228     top_info_text         => $::locale->text('Projects'),
 229     title                 => $::locale->text('Projects'),
 230     allow_pdf_export      => 1,
 231     allow_csv_export      => 1,
 232   );
 233   $report->set_columns(%column_defs);
 234   $report->set_column_order(@columns);
 235   $report->set_export_options(qw(list filter));
 236   $report->set_options_from_form;
 237   $self->models->set_report_generator_sort_options(report => $report, sortable_columns => \@sortable);
 238   $report->set_options(
 239     raw_bottom_info_text  => $self->render('project/report_bottom', { output => 0 }),
 240   );
 241 }
 242
 243 sub init_models {
 244   my ($self) = @_;
 245
 246   SL::Controller::Helper::GetModels->new(
 247     controller => $self,
 248     sorted => {
 249       _default => {
 250         by    => 'projectnumber',
 251         dir   => 1,
 252       },
 253       customer      => t8('Customer'),
 254       description   => t8('Description'),
 255       projectnumber => t8('Project Number'),
 256       project_type  => t8('Project Type'),
 257     },
 258     with_objects => [ 'customer' ],
 259   );
 260 }
 261
 262 1;