projekt kivitendo

  'scalar --get_set_init' => [ qw(controller _actions _error) ],

  # flash

  flash                  => -2, # kivi.Flash.display_flash.apply({}, action.slice(1, action.length))

  clear_flash            => 0,  # kivi.Flash.clear_flash()

  show_flash             => 0,  # kivi.Flash.show()

  hide_flash             => 0,  # kivi.Flash.hide()

  return SL::JSON::to_json({ eval_actions => $self->_actions });

  $_[0]; # noop for compatibility

=item C<flash $type, $message [, $details [, timestamp ]]>

Display a C<$message> in the flash of type C<$type> with optional

C<$details>.

package SL::Controller::Flash;

use strict;

use parent qw(SL::Controller::Base);

use SL::Helper::Flash;

sub action_reload {

  my ($self) = @_;

  $self->js->clear_flash;

  $self->js->flash(@$_) for SL::Helper::Flash::flash_contents;

  $self->js->show_flash;

  $self->js->render;

}

1;

__END__

=encoding utf-8

=head1 NAME

SL::Controller::Flash - Flash actions

=head1 DESCRIPTION

This controller contains actions that can be used to reload and control client

side flash messages

=head1 BUGS

None yet :)

=head1 AUTHOR

Sven Schöling E<lt>sven.schoeling@opendynamic.deE<gt>

=cut

our @EXPORT_OK = qw(delay_flash);

sub flash_contents {

  return unless $::form;

  return unless $::form->{FLASH};

  return unless 'ARRAY' eq ref $::form->{FLASH};

  @{ $::form->{FLASH} }

sub delay_flash {

  my $store = $::form->{FLASH} || [];

  flash_later(@{ $_ || [] }) for @$store;

  my ($store, $type, $message, $details, $timestamp) = @_;

  $store     //= [ ];

  $timestamp //= time();

  my $category = _check_category($type);

  push @{ $store }, [ $type, $message, $details, $timestamp ];

  use SL::Helper::Flash qw(flash flash_later delay_flash);

  # display in this request

  flash('info', 'Customer saved!');

  flash('error', 'Something went wrong', "details about what went wrong");

  flash('warning', 'this might not be a good idea');

  # display after a redirect

  flash_later('info', 'Customer saved!');

  flash_later('error', 'Something went wrong', "details about what went wrong");

  flash_later('warning', 'this might not be a good idea');

  # delay flash() calls to next request:

  delay_flash();

=head1 DESCRIPTION

Messages are rendered by including the L<SL::Layout::Flash> sub layout.

=item C<flash $category, $message [, $details ]>

Store a message with optional details for the given category. The category can

be either C<information>, C<warning> or C<error>. C<info> can also be used as

an alias for C<information>.

=item C<flash_later $category, $message [, $details ]>

Store a message with optional details for the given category for the next

request. The category can be either C<information>, C<warning> or C<error>.

C<info> can also be used as an alias for C<information>.

The message is stored in the user's session and restored upon the

=item C<flash_contents>

The contents of the current flash accumulator.

use SL::Layout::Flash;

  $_[0]->sub_layouts_by_name->{flash}     = SL::Layout::Flash->new;

    $_[0]->sub_layouts_by_name->{flash},

use SL::Layout::Flash;

  $_[0]->sub_layouts_by_name->{flash}     = SL::Layout::Flash->new;

      right => [

        $_[0]->sub_layouts_by_name->{actionbar},

        $_[0]->sub_layouts_by_name->{flash},

        SL::Layout::Content->new,

      ],

package SL::Layout::Flash;

use strict;

use parent qw(SL::Layout::Base);

use SL::Presenter::EscapedText qw(escape_js);

use SL::Helper::Flash;

sub pre_content {

  '<div style="position:relative"><div id="layout_flash_container"></div></div>'

}

sub javascripts_inline {

  my ($self) = @_;

  my $js = '';

  for (SL::Helper::Flash::flash_contents()) {

    next if $_->[3] + 60 < time(); # ignore entries from more than one minute ago

    $js .= defined $_->[2]

      ? sprintf("kivi.Flash.display_flash('%s', '%s', '%s');", map { escape_js($_) } @$_[0,1,2] )

      : sprintf("kivi.Flash.display_flash('%s', '%s');", map { escape_js($_) } @$_[0,1] );

  }

  $js;

}

sub static_javascripts {

  'kivi.Flash.js'

}

1;

use SL::Layout::Flash;

  $_[0]->sub_layouts_by_name->{flash}     = SL::Layout::Flash->new;

    $_[0]->sub_layouts_by_name->{flash},

use SL::Layout::Flash;

    SL::Layout::Flash->new,

use SL::Layout::Flash;

  $_[0]->sub_layouts_by_name->{flash}     = SL::Layout::Flash->new;

    $_[0]->sub_layouts_by_name->{flash},

/* Flash message */

#layout_flash_container {

  position: absolute;

  z-index: 200;

  right: 20px;

  min-width: 30%;

  animation: fadein .5s;

}

@keyframes hop {

  to  { transform: scale(1.01); }

}

@keyframes flash {

  from  { background-color: black }

}

@keyframes fadein {

  from  { opacity: 0; }

  to  { opacity: 1; }

}

.layout-flash-message {

  margin-top: 5px;

  margin-bottom: 5px;

  padding: 5px;

  border-width: 1px;

  border-style: solid;

 /* animation: .5s ease-out .2s 1 normal none running flash;*/

}

.layout-flash-body{

  padding-top:5px;

  margin-top:5px;

  border-top: 1px dotted black;

}

.layout-flash-timestamp{

  opacity: 0.75;

}

.layout-flash-details::before {

  content: ': ';

}

.layout-flash-type {

  font-weight: bold;

  float: right;

}

.layout-flash-error {

  background-color: #FFD6D6;

  border-color: #AE0014;

}

.layout-flash-ok {

  background-color: #ADFFB6;

  border-color: #007F0F;

}

.layout-flash-warning {

  background-color: #FFE8C7;

  border-color: #FF6600;

}

.layout-flash-info {

  background-color: #DCF2FF;

  border-color: #4690FF;

}

.layout-flash-title {

  font-weight: bold;

}

.layout-flash-remove {

  padding-right: 4px;

}

  if (data.error && ns.Flash)

    return ns.Flash.display_flash('error', data.error);

      // flash

      else if (action[0] == 'flash')                kivi.Flash.display_flash.apply({}, action.slice(1, action.length));

      else if (action[0] == 'clear_flash')          kivi.Flash.clear_flash();

      else if (action[0] == 'show_flash')           kivi.Flash.show();

      else if (action[0] == 'hide_flash')           kivi.Flash.hide();

namespace("kivi.Flash", function(ns) {

  "use strict";

  ns.type_to_title = {

    error:   kivi.t8('Error'),

    warning: kivi.t8('Warning'),

    info:    kivi.t8('Information'),

    ok:      kivi.t8('Ok')

  };

  ns.display_flash = function(type, message, details, timestamp) {

    let $dom = $('<div>');

    $dom.addClass('layout-flash-' + type);

    $dom.addClass('layout-flash-message');

    let $header = $('<div>');

    $header.addClass('layout-flash-header');

    let $remove = $('<span>✘</span>');

    $remove.addClass('layout-flash-remove').addClass('cursor-pointer');

    $remove.attr('alt', kivi.t8('Close Flash'));

    $header.append($remove);

    if (timestamp === undefined) {

      timestamp = new Date();

    } else if (timestamp > 0) {

      timestamp = new Date(timestamp * 1000);

    }

    let $time = $('<span>');

    $time.addClass('layout-flash-timestamp');

    $time.text(kivi.format_time(timestamp));

    $header.append($time);

    let $type = $('<span>');

    $type.addClass('layout-flash-type');

    $type.text(ns.type_to_title[type]);

    $header.append($type);

    let $body = $('<div>');

    $body.addClass('layout-flash-body');

    if (message !== undefined && message !== null) {

      let $message =  $('<span>');

      $message.addClass('layout-flash-content');

      $message.html(message);

      $body.append($message);

    }

    if (details !== undefined && details !== null) {

      let $details =  $('<span>');

      $details.addClass('layout-flash-details');

      $details.html(details);

      $body.append($details);

    }

    $dom.append($header);

    $dom.append($body);

    $("#layout_flash_container").append($dom);

    // fadeout after 1min

    $dom.delay(60000).fadeOut('slow');

    ns.show();

  };

  ns.display_flash_detail = function(type, message) {

    $('#flash_' + type + '_disp').show();

  };

  ns.clear_flash = function(category, timeout) {

    if (timeout === undefined) {

      ns.clear_flash_now(category);

    } else {

      window.setTimeout(function(){

        ns.clear_flash_now(category);

      }, timeout);

    }

  };

  ns.clear_flash_now = function(category) {

    if (category) {

      $('div.layout-flash-' + category).remove();

    } else {

      $('div.layout-flash-message').remove();

    }

  };

  ns.remove_entry = function(e) {

    $(e.target).closest('div.layout-flash-message').remove();

  };

  ns.toggle = function() {

    $('#layout_flash_container').toggle();

  };

  ns.show = function() {

    $('#layout_flash_container').show();

  };

  ns.hide = function() {

    $('#layout_flash_container').hide();

  };

  ns.reload_flash = function() {

    $.get("controller.pl", { action: "Flash/reload" }, kivi.eval_json_result);

  };

  ns.reinit_widgets = function() {

  };

});

$(function() {

  "use strict";

  // dispatch to kivi.Flash for compatibility

  kivi.display_flash        = kivi.Flash.display_flash;

  kivi.display_flash_detail = kivi.Flash.display_flash_detail;

  kivi.empty_flash          = kivi.Flash.empty_flash;

  kivi.clear_flash          = kivi.Flash.clear_flash;

  $('.layout-flash-toggle').click(kivi.Flash.toggle);

  $('#layout_flash_container').on('click', '.layout-flash-remove', kivi.Flash.remove_entry);

});

    return ns.Flash.display_flash('error', data.error);

use strict;

use lib 't';

use Support::Files;

use Support::TestSetup;

use File::Spec;

use File::Slurp;

use Template;

use Template::Provider;

use Test::More;

my @deprecated_calls_perl = (

  qr/render_flash/,

  qr/flash_detail/,

  qr{common/flash},

  qr/flash (?:_later)? \( \s* ' (?: error | warning | information ) ' \s* , \s* \@ /x,

);

my @deprecated_calls_js = (

  qr/kivi\.display_flash/,

  qr/kivi\.clear_flash/,

);

for my $file (@Support::Files::files) {

  open my $fh, '<', $file or die "can't open $file";

  while (my $line = <$fh>) {

    for my $re (@deprecated_calls_perl) {

      if ($line =~ $re) {

        ok 0, "$file contains '$&', most likely due to incomplete merge of the layout flash feature. Consult the documentation in this test script";

      }

    }

  }

  ok 1, $file;

}

for my $file (@Support::Files::javascript_files) {

  next if $file eq 'js/kivi.Flash.js';

  open my $fh, '<', $file or die "can't open $file";

  while (my $line = <$fh>) {

    for my $re (@deprecated_calls_js) {

      if ($line =~ $re) {

        TODO: { local $TODO = 'clean up compatibility kivi.display_flash and kivi.clear_flash';

          ok 0, "$file contains '$&', most likely due to incomplete merge of the layout flash feature. Consult the documentation in this test script";

        }

      }

    }

  }

  ok 1, $file;

}

done_testing();

__END__

=encoding utf-8

=head1 NAME

t/flash_migration&deprecated_calls.t

=head1 DESCRIPTION

Okay, if this script triggers, this is what needs to be done:

In Javascript:

- all javascript calls to "kivi.display_flash" and "kivi.clear_flash" need to

  be redirected to "kivi.Flash"

- kivi.display_flash_details doesn't exist any more, instead details can now be

  passed as a third argument to kivi.Flash.display_flash

In html:

- There is no common/flash.html template any more, since the layout handles

  that now. Any attempt to render it needs to be removed.

In Perl:

- flash_detail doesn't exist any more, instead flash() and flash_later() take a

  third argument for details

- render_flash doesn't exist anymore and is now handled by the layout.

- flash('error', @errrs) and similar must be called in a loop: flash('error', $_) for @errors

=cut