use Carp;
use IO::File;
use List::Util qw(first);
+use MIME::Base64;
use SL::Request qw(flatten);
use SL::MoreCommon qw(uri_encode);
use SL::Presenter;
use Rose::Object::MakeMethods::Generic
(
- scalar => [ qw(action_name) ],
+ scalar => [ qw(action_name) ],
+ 'scalar --get_set_init' => [ qw(js p) ],
);
#
my %params = ref($_[0]) eq 'HASH' ? %{ $_[0] } : @_;
my $controller = delete($params{controller}) || $self->controller_name;
my $action = $params{action} || 'dispatch';
+ my $fragment = delete $params{fragment};
my $script;
if ($controller =~ m/\.pl$/) {
my $query = join '&', map { uri_encode($_->[0]) . '=' . uri_encode($_->[1]) } @{ flatten(\%params) };
- return "${script}?${query}";
+ return "${script}?${query}" . (defined $fragment ? "#$fragment" : '');
}
sub redirect_to {
SL::Helper::Flash::delay_flash();
}
+ return $self->render(SL::ClientJS->new->redirect_to($url)) if $::request->is_ajax;
+
print $::request->{cgi}->redirect($url);
}
header => 1,
layout => 1,
process => 1,
+ status => '200 ok',
);
$options->{$_} //= $defaults{$_} for keys %defaults;
$options->{type} = lc $options->{type};
}
# Only certain types are supported.
- croak "Unsupported type: " . $options->{type} unless $options->{type} =~ m/^(?:html|js|json)$/;
+ croak "Unsupported type: " . $options->{type} unless $options->{type} =~ m/^(?:html|js|json|text)$/;
# The "template" argument must be a string or a reference to one.
$template = ${ $template } if ((ref($template) || '') eq 'REF') && (ref(${ $template }) eq 'SL::Presenter::EscapedText');
$options->{layout} = 0 if $options->{type} ne 'html';
}
+ # Let the presenter do the rest of the work.
+ my $output;
+ {
+ local $::form->{title} = $locals{title} if $locals{title};
+ $output = $self->presenter->render(
+ $template,
+ { type => $options->{type}, process => $options->{process} },
+ %locals,
+ SELF => $self,
+ );
+ }
+
if ($options->{header}) {
# Output the HTTP response and the layout in case of HTML output.
$::form->{header} = 1;
my $content_type = $options->{type} eq 'html' ? 'text/html'
: $options->{type} eq 'js' ? 'text/javascript'
+ : $options->{type} eq 'text' ? 'text/plain'
: 'application/json';
print $::form->create_http_response(content_type => $content_type,
- charset => $::lx_office_conf{system}->{dbcharset} || Common::DEFAULT_CHARSET());
+ charset => 'UTF-8',
+ (status => $options->{status}) x !!$options->{status});
}
}
- # Let the presenter do the rest of the work.
- my $output = $self->presenter->render(
- $template,
- { type => $options->{type}, process => $options->{process} },
- %locals,
- SELF => $self,
- );
-
# Print the output if wanted.
print $output if $options->{output};
}
sub send_file {
- my ($self, $file_name, %params) = @_;
+ my ($self, $file_name_or_content, %params) = @_;
+
+ my ($file, $size);
+
+ if (!ref $file_name_or_content) {
+ $file = IO::File->new($file_name_or_content, 'r') || croak("Cannot open file '${file_name_or_content}'");
+ $size = -s $file_name_or_content;
+ } else {
+ $size = length $$file_name_or_content;
+ }
- my $file = IO::File->new($file_name, 'r') || croak("Cannot open file '${file_name}'");
my $content_type = $params{type} || 'application/octet_stream';
- my $attachment_name = $params{name} || $file_name;
+ my $attachment_name = $params{name} || (!ref($file_name_or_content) ? $file_name_or_content : '');
$attachment_name =~ s:.*//::g;
- print $::form->create_http_response(content_type => $content_type,
- content_disposition => 'attachment; filename="' . $attachment_name . '"',
- content_length => -s $file);
+ if ($::request->is_ajax || $params{ajax}) {
+ my $octets = ref $file_name_or_content ? $file_name_or_content : \ do { local $/ = undef; <$file> };
+ $self->js->save_file(MIME::Base64::encode_base64($$octets), $content_type, $size, $attachment_name);
+ $self->js->render unless $params{js_no_render};
+ } else {
+ print $::form->create_http_response(content_type => $content_type,
+ content_disposition => 'attachment; filename="' . $attachment_name . '"',
+ content_length => $size);
+
+ if (!ref $file_name_or_content) {
+ $::locale->with_raw_io(\*STDOUT, sub { print while <$file> });
+ $file->close;
+ unlink $file_name_or_content if $params{unlink};
+ } else {
+ $::locale->with_raw_io(\*STDOUT, sub { print $$file_name_or_content });
+ }
+ }
- $::locale->with_raw_io(\*STDOUT, sub { print while <$file> });
- $file->close;
+ return 1;
}
sub presenter {
return SL::Presenter->get;
}
+sub init_p {
+ return SL::Presenter->get;
+}
+
sub controller_name {
my $class = ref($_[0]) || $_[0];
$class =~ s/^SL::Controller:://;
return $class;
}
+sub init_js {
+ SL::ClientJS->new(controller => $_[0])
+}
+
#
# Before/after run hooks
#
=item C<type>
-The template type. Can be C<html> (the default), C<js> for JavaScript
-or C<json> for JSON content. Affects the extension that's added to the
-file name given with a non-reference C<$template> argument, the
-content type HTTP header that is output and whether or not the layout
-will be output as well (see description of C<layout> below).
+The template type. Can be C<html> (the default), C<js> for JavaScript,
+C<json> for JSON and C<text> for plain text content. Affects the
+extension that's added to the file name given with a non-reference
+C<$template> argument, the content type HTTP header that is output and
+whether or not the layout will be output as well (see description of
+C<layout> below).
=item C<process>
$self->render('todo/single_item', { type => 'js' },
item => $employee->most_important_todo_item);
-=item C<send_file $file_name, [%params]>
+=item C<send_file $file_name_or_content, [%params]>
+
+Sends the file C<$file_name_or_content> to the browser including
+appropriate HTTP headers for a download. If C<$file_name_or_content>
+is a scalar then it is interpreted as a file name which is opened and
+whose content is sent. Otherwise (C<$file_name_or_content> being a
+reference) the referenced scalar's data itself is sent.
-Sends the file C<$file_name> to the browser including appropriate HTTP
-headers for a download. C<%params> can include the following:
+C<%params> can include the following:
=over 2
'application/octet_stream'
=item * C<name> -- the name presented to the browser; defaults to
-C<$file_name>
+C<$file_name>; mandatory if C<$file_name_or_content> is a reference
+
+=item * C<unlink> -- if trueish and C<$file_name_or_content> refers to
+a file name then unlink the file after it has been sent to the browser
+(e.g. for temporary files)
=back
The action to call is given by C<$params{action}>. It defaults to
C<dispatch>.
+If C<$params{fragment}> is present, it's used as the fragment of the resulting
+URL.
+
All other key/value pairs in C<%params> are appended as GET parameters
to the URL.
=item C<redirect_to %url_params>
-Redirects the browser to a new URL by outputting a HTTP redirect
-header. The URL is generated by calling L</url_for> with
-C<%url_params>.
+Redirects the browser to a new URL. The URL is generated by calling
+L</url_for> with C<%url_params>.
+
+This function implements the redirection depending on whether or not
+the current request is an AJAX request as determined by
+L<SL::Request/is_ajax>. If it is a normal request then it outputs a
+standard HTTP redirect header (HTTP code 302). If it is an AJAX
+request then it outputs an AJAX response suitable for the
+C<kivi.eval_json_result> function from the L<SL::ClientJS> module.
=item C<run_before $sub, %params>
future value C<none> (which would require no authentication but is not
yet implemented).
-=item C<keep_auth_vars_in_form>
+=item C<keep_auth_vars_in_form %params>
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.
+C<$params{action}> contains the action name that the request will be
+dispatched to.
+
=item C<controller_name>
Returns the name of the curernt controller package without the
Returns the global presenter object by calling
L<SL::Presenter/get>.
+=item C<js>
+
+Returns an L<SL::ClientJS> instance for this controller.
+
=back
=head2 PRIVATE FUNCTIONS
projects / kivitendo-erp.git / blobdiff