Merge branch 'master' of vc.linet-services.de:public/lx-office-erp

[kivitendo-erp.git] / SL / Controller / Base.pm

diff --git a/SL/Controller/Base.pm b/SL/Controller/Base.pm
index f8eee88..1ba9358 100644 (file)
--- a/SL/Controller/Base.pm
+++ b/SL/Controller/Base.pm
@@ -7,6 +7,13 @@ use parent qw(Rose::Object);
 use Carp;
 use IO::File;
 use List::Util qw(first);
 use Carp;
 use IO::File;
 use List::Util qw(first);

+use SL::Request qw(flatten);
+use SL::MoreCommon qw(uri_encode);
+
+use Rose::Object::MakeMethods::Generic
+(
+  scalar => [ qw(action_name) ],
+);

 
 #
 # public/helper functions
 
 #
 # public/helper functions


@@ -18,19 +25,33 @@ sub url_for {
   return $_[0] if (scalar(@_) == 1) && !ref($_[0]);
 
   my %params      = ref($_[0]) eq 'HASH' ? %{ $_[0] } : @_;
   return $_[0] if (scalar(@_) == 1) && !ref($_[0]);
 
   my %params      = ref($_[0]) eq 'HASH' ? %{ $_[0] } : @_;

-  my $controller  = delete($params{controller}) || $self->_controller_name;
-  my $action      = delete($params{action})     || 'dispatch';
-  $params{action} = "${controller}/${action}";
-  my $query       = join('&', map { $::form->escape($_) . '=' . $::form->escape($params{$_}) } keys %params);
+  my $controller  = delete($params{controller}) || $self->controller_name;
+  my $action      = $params{action}             || 'dispatch';
+
+  my $script;
+  if ($controller =~ m/\.pl$/) {
+    # Old-style controller
+    $script = $controller;
+  } else {
+    $params{action} = "${controller}/${action}";
+    $script         = "controller.pl";
+  }
+
+  my $query       = join '&', map { uri_encode($_->[0]) . '=' . uri_encode($_->[1]) } @{ flatten(\%params) };

 
 

-  return "controller.pl?${query}";
+  return "${script}?${query}";

 }
 
 sub redirect_to {
   my $self = shift;
   my $url  = $self->url_for(@_);
 
 }
 
 sub redirect_to {
   my $self = shift;
   my $url  = $self->url_for(@_);
 

-  print $::cgi->redirect($url);
+  if ($self->delay_flash_on_redirect) {
+    require SL::Helper::Flash;
+    SL::Helper::Flash::delay_flash();
+  }
+
+  print $::request->{cgi}->redirect($url);

 }
 
 sub render {
 }
 
 sub render {


@@ -45,6 +66,9 @@ sub render {
   if ($options->{inline}) {
     $source = \$template;
 
   if ($options->{inline}) {
     $source = \$template;
 

+  } elsif($options->{raw}) {
+    $source =  $template;
+

   } else {
     $source = "templates/webpages/${template}." . $options->{type};
     croak "Template file ${source} not found" unless -f $source;
   } else {
     $source = "templates/webpages/${template}." . $options->{type};
     croak "Template file ${source} not found" unless -f $source;


@@ -60,7 +84,7 @@ sub render {
 
     } else {
       $::form->{title} = $locals{title} if $locals{title};
 
     } else {
       $::form->{title} = $locals{title} if $locals{title};

-      $::form->header;
+      $::form->header(no_menu => $options->{no_menu});

     }
   }
 
     }
   }
 


@@ -77,8 +101,12 @@ sub render {
                );
 
   my $output;
                );
 
   my $output;

-  my $parser = $self->_template_obj;
-  $parser->process($source, \%params, \$output) || croak $parser->error;
+  if (!$options->{raw}) {
+    my $parser = $self->_template_obj;
+    $parser->process($source, \%params, \$output) || croak $parser->error;
+  } else {
+    $output = $$source;
+  }

 
   print $output unless $options->{inline} || $options->{no_output};
 
 
   print $output unless $options->{inline} || $options->{no_output};
 


@@ -101,6 +129,12 @@ sub send_file {
   $file->close;
 }
 
   $file->close;
 }
 

+sub controller_name {
+  my $class = ref($_[0]) || $_[0];
+  $class    =~ s/^SL::Controller:://;
+  return $class;
+}
+

 #
 # Before/after run hooks
 #
 #
 # Before/after run hooks
 #


@@ -137,14 +171,31 @@ sub _run_hooks {
          || ($hook->{except} &&  $hook->{except}->{$action});
 
     if (ref($hook->{code}) eq 'CODE') {
          || ($hook->{except} &&  $hook->{except}->{$action});
 
     if (ref($hook->{code}) eq 'CODE') {

-      $hook->{code}->($self);
+      $hook->{code}->($self, $action);

     } else {
       my $sub = $hook->{code};
     } else {
       my $sub = $hook->{code};

-      $self->$sub;
+      $self->$sub($action);

     }
   }
 }
 
     }
   }
 }
 

+#
+#  behaviour. override these
+#
+
+sub delay_flash_on_redirect {
+  0;
+}
+
+sub get_auth_level {
+  # Ignore the 'action' parameter.
+  return 'user';
+}
+
+sub keep_auth_vars_in_form {
+  return 0;
+}
+

 #
 # private functions -- for use in Base only
 #
 #
 # private functions -- for use in Base only
 #


@@ -158,15 +209,12 @@ sub _run_action {
 
   $::form->error("Invalid action '${action}' for controller " . ref($self)) if !$self->can($sub);
 
 
   $::form->error("Invalid action '${action}' for controller " . ref($self)) if !$self->can($sub);
 

+  $self->action_name($action);

   $self->_run_hooks('before', $action);
   $self->$sub(@_);
   $self->_run_hooks('after', $action);
 }
 
   $self->_run_hooks('before', $action);
   $self->$sub(@_);
   $self->_run_hooks('after', $action);
 }
 

-sub _controller_name {
-  return (split(/::/, ref($_[0])))[-1];
-}
-

 sub _dispatch {
   my $self    = shift;
 
 sub _dispatch {
   my $self    = shift;
 


@@ -176,6 +224,7 @@ sub _dispatch {
   my $sub     = "action_${action}";
 
   if ($self->can($sub)) {
   my $sub     = "action_${action}";
 
   if ($self->can($sub)) {

+    $self->action_name($action);

     $self->_run_hooks('before', $action);
     $self->$sub(@_);
     $self->_run_hooks('after', $action);
     $self->_run_hooks('before', $action);
     $self->$sub(@_);
     $self->_run_hooks('after', $action);


@@ -196,6 +245,7 @@ sub _template_obj {
                     INCLUDE_PATH => '.:templates/webpages',
                     COMPILE_EXT  => '.tcc',
                     COMPILE_DIR  => $::lx_office_conf{paths}->{userspath} . '/templates-cache',
                     INCLUDE_PATH => '.:templates/webpages',
                     COMPILE_EXT  => '.tcc',
                     COMPILE_DIR  => $::lx_office_conf{paths}->{userspath} . '/templates-cache',

+                    ERROR        => 'templates/webpages/generic/exception.html',

                   }) || croak;
 
   return $self->{__basepriv_template_obj};
                   }) || croak;
 
   return $self->{__basepriv_template_obj};


@@ -288,6 +338,10 @@ hooks themselves are run as instance methods.
 
 Hooks are run in the order they're added.
 
 
 Hooks are run in the order they're added.
 

+The hooks receive a single parameter: the name of the action that is
+about to be called (for C<before> hooks) / was called (for C<after>
+hooks).
+

 The return value of the hooks is discarded.
 
 Hooks can be defined to run for all actions, for only specific actions
 The return value of the hooks is discarded.
 
 Hooks can be defined to run for all actions, for only specific actions


@@ -322,6 +376,10 @@ containing the template code to interprete. Additionally the output
 will not be sent to the browser. Instead it is only returned to the
 caller.
 
 will not be sent to the browser. Instead it is only returned to the
 caller.
 

+If C<< $options->{raw} >> is trueish, the function will treat the input as
+already parsed, and will not filter the input through Template. Unlike
+C<inline>, the input is taked as a reference.
+

 If C<< $options->{inline} >> is falsish then C<$template> is
 interpreted as the name of a template file. It is prefixed with
 "templates/webpages/" and postfixed with a file extension based on
 If C<< $options->{inline} >> is falsish then C<$template> is
 interpreted as the name of a template file. It is prefixed with
 "templates/webpages/" and postfixed with a file extension based on


@@ -352,7 +410,7 @@ The template itself has access to the following variables:
 
 =item * C<LOCALE> -- C<$::locale>
 
 
 =item * C<LOCALE> -- C<$::locale>
 

-=item * C<LXCONFIG> -- all parameters from C<config/lx_office.conf>
+=item * C<LXCONFIG> -- all parameters from C<config/kivitendo.conf>

 with the same name they appear in the file (first level is the
 section, second the actual variable, e.g. C<system.dbcharset>,
 C<features.webdav> etc)
 with the same name they appear in the file (first level is the
 section, second the actual variable, e.g. C<system.dbcharset>,
 C<features.webdav> etc)


@@ -420,7 +478,7 @@ parameter or as a normal hash.
 
 The controller to call is given by C<$params{controller}>. It defaults
 to the current controller as returned by
 
 The controller to call is given by C<$params{controller}>. It defaults
 to the current controller as returned by

-L</_controller_name>.
+L</controller_name>.

 
 The action to call is given by C<$params{action}>. It defaults to
 C<dispatch>.
 
 The action to call is given by C<$params{action}>. It defaults to
 C<dispatch>.


@@ -471,6 +529,40 @@ action.
 
 The hook's return values are discarded.
 
 
 The hook's return values are discarded.
 

+=item C<delay_flash_on_redirect>
+
+May be overridden by a controller. If this method returns true, redirect_to
+will delay all flash messages for the current request. Defaults to false for
+compatibility reasons.
+
+=item C<get_auth_level $action>
+
+May be overridden by a controller. Determines what kind of
+authentication is required for a particular action. Must return either
+C<admin> (which means that authentication as an admin is required),
+C<user> (authentication as a normal user suffices) with a possible
+future value C<none> (which would require no authentication but is not
+yet implemented).
+
+=item C<keep_auth_vars_in_form>
+
+May be overridden by a controller. If falsish (the default) all form
+variables whose name starts with C<{AUTH}> are removed before the
+request is routed. Only controllers that handle login requests
+themselves should return trueish for this function.
+
+=item C<controller_name>
+
+Returns the name of the curernt controller package without the
+C<SL::Controller::> prefix. This method can be called both as a class
+method and an instance method.
+
+=item C<action_name>
+
+Returns the name of the currently executing action. If the dispatcher
+mechanism was used then this is not C<dispatch> but the actual method
+name the dispatching resolved to.
+

 =back
 
 =head2 PRIVATE FUNCTIONS
 =back
 
 =head2 PRIVATE FUNCTIONS


@@ -479,11 +571,6 @@ These functions are supposed to be used from this base class only.
 
 =over 4
 
 
 =over 4
 

-=item C<_controller_name>
-
-Returns the name of the curernt controller package without the
-C<SL::Controller::> prefix.
-

 =item C<_dispatch>
 
 Implements the method lookup for indirect dispatching mentioned in the
 =item C<_dispatch>
 
 Implements the method lookup for indirect dispatching mentioned in the