X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FLayout%2FBase.pm;h=c64a99ab06d3860e0969845e9a43c144aa59dec0;hb=eaa42caeb03b5213754334a930b08407a0e74c53;hp=18ef133e920b2e23cd92c8ea67c28914fa4ab4d4;hpb=4e7776aa3fa5ba3c1fd932c79ce741a4eb8d89fd;p=kivitendo-erp.git diff --git a/SL/Layout/Base.pm b/SL/Layout/Base.pm index 18ef133e9..c64a99ab0 100644 --- a/SL/Layout/Base.pm +++ b/SL/Layout/Base.pm @@ -1,22 +1,26 @@ package SL::Layout::Base; use strict; -use parent qw(SL::Controller::Base); +use parent qw(Rose::Object); +use File::Slurp qw(read_file); use List::MoreUtils qw(uniq); +use Time::HiRes qw(); use Rose::Object::MakeMethods::Generic ( - 'scalar --get_set_init' => qw(menu), + 'scalar --get_set_init' => [ qw(menu auto_reload_resources_param sub_layouts_by_name) ], 'scalar' => qw(focus), 'array' => [ 'add_stylesheets_inline' => { interface => 'add', hash_key => 'stylesheets_inline' }, 'add_javascripts_inline' => { interface => 'add', hash_key => 'javascripts_inline' }, - 'sub_layouts', - 'add_sub_layouts' => { interface => 'add', hash_key => 'sub_layouts' }, + 'sub_layouts', => { interface => 'get_set_init' }, + 'add_sub_layouts' => { interface => 'add', hash_key => 'sub_layouts' }, ], ); use SL::Menu; +use SL::Presenter; +use SL::System::Process; my %menu_cache; @@ -27,7 +31,44 @@ sub new { } sub init_menu { - Menu->new('menu.ini'); + SL::Menu->new('user'); +} + +sub init_sublayouts_by_name { + {} +} + +sub webpages_path { + "templates/webpages"; +} + +sub get { + $_[0]->sub_layouts; + return grep { $_ } ($_[0]->sub_layouts_by_name->{$_[1]}); +} + +sub init_auto_reload_resources_param { + if ($::lx_office_conf{debug}->{auto_reload_resources}) { + return sprintf('?rand=%d-%d-%d', Time::HiRes::gettimeofday(), int(rand 1000000000000)); + } + + if ($::lx_office_conf{debug}{git_commit_reload_resources}) { + my $git_dir = SL::System::Process::exe_dir() . '/.git'; + + return '' unless -d $git_dir; + + my $content = eval { scalar(read_file($git_dir . '/HEAD')) }; + + return '' unless ($content // '') =~ m{\Aref: ([^\r\n]+)}; + + $content = eval { scalar(read_file($git_dir . '/' . $1)) }; + + return '' unless ($content // '') =~ m{\A([0-9a-fA-F]+)}; + + return '?rand=' . $1; + } + + return ''; } ########################################## @@ -60,11 +101,18 @@ sub javascripts_inline { @{ $_[0]->{javascripts_inline} || [] }; } +sub init_sub_layouts { [] } + +sub init_sub_layouts_by_name { +{} } + ######################################### -# Interface +# Stylesheets ######################################## +# override in sub layouts +sub static_stylesheets {} + sub add_stylesheets { &use_stylesheet; } @@ -72,7 +120,7 @@ sub add_stylesheets { sub use_stylesheet { my $self = shift; push @{ $self->{stylesheets} ||= [] }, @_ if @_; - @{ $self->{stylesheets} ||= [] }; + (map { $_->use_stylesheet } $self->sub_layouts), $self->static_stylesheets, @{ $self->{stylesheets} ||= [] }; } sub stylesheets { @@ -80,7 +128,7 @@ sub stylesheets { my $css_path = $self->get_stylesheet_for_user; return uniq grep { $_ } map { $self->_find_stylesheet($_, $css_path) } - $self->use_stylesheet, map { $_->stylesheets } $self->sub_layouts; + $self->use_stylesheet; } sub _find_stylesheet { @@ -89,26 +137,33 @@ sub _find_stylesheet { return "$css_path/$stylesheet" if -f "$css_path/$stylesheet"; return "css/$stylesheet" if -f "css/$stylesheet"; return $stylesheet if -f $stylesheet; + return $stylesheet if $stylesheet =~ /^http/; # external } sub get_stylesheet_for_user { my $css_path = 'css'; if (my $user_style = $::myconfig{stylesheet}) { - $user_style =~ s/\.css$//; # nuke trailing .css, this is a remnand of pre 2.7.0 stylesheet handling + $user_style =~ s/\.css$//; # nuke trailing .css, this is a remnant of pre 2.7.0 stylesheet handling if (-d "$css_path/$user_style" && -f "$css_path/$user_style/main.css") { $css_path = "$css_path/$user_style"; } else { - $css_path = "$css_path/lx-office-erp"; + $css_path = "$css_path/kivitendo"; } } else { - $css_path = "$css_path/lx-office-erp"; + $css_path = "$css_path/kivitendo"; } - $::myconfig{css_path} = $css_path; # needed for menunew, FIXME: don't do this here return $css_path; } +######################################### +# Javascripts +######################################## + +# override in sub layouts +sub static_javascripts {} + sub add_javascripts { &use_javascript } @@ -116,14 +171,14 @@ sub add_javascripts { sub use_javascript { my $self = shift; push @{ $self->{javascripts} ||= [] }, @_ if @_; - @{ $self->{javascripts} ||= [] }; + map({ $_->use_javascript } $self->sub_layouts), $self->static_javascripts, @{ $self->{javascripts} ||= [] }; } sub javascripts { my ($self) = @_; - return uniq map { $self->_find_javascript($_) } - $self->use_javascript, map { $_->javascripts } $self->sub_layouts; + return uniq grep { $_ } map { $self->_find_javascript($_) } + $self->use_javascript; } sub _find_javascript { @@ -131,6 +186,7 @@ sub _find_javascript { return "js/$javascript" if -f "js/$javascript"; return $javascript if -f $javascript; + return $javascript if $javascript =~ /^http/; } @@ -146,4 +202,198 @@ sub need_footer { $_[0]{_header_done}; } +sub presenter { + SL::Presenter->get; +} + 1; + +__END__ + +=encoding utf-8 + +=head1 NAME + +SL::Layout::Base - Base class for layouts + +=head1 SYNOPSIS + + package SL::Layout::MyLayout; + + use parent qw(SL::Layout::Base); + +=head1 DESCRIPTION + +For a description of the external interface of layouts in general see +L. + +This is a base class for layouts in general. It provides the basic interface +and some capabilities to extend and cascade layouts. + + +=head1 IMPLEMENTING LAYOUT CALLBACKS + +There are eight callbacks (C, C, C, +C, C, C, C, +C) which are documented in L. If +you are writing a new simple layout, you can just override some of them like +this: + + package SL::Layout::MyEvilLayout; + + sub pre_content { + '

This is MY page now

' + } + + sub post_content { + '

Brought to you by my own layout class

' + } + + +To preserve the sanitizing effects of C and C you should instead do the following: + + sub stylesheets { + $_[0]->add_stylesheets(qw(mystyle1.css mystyle2.css); + $_[0]->SUPER::stylesheets; + } + +If you want to add something to a different layout, you should write a sub +layout and add it to the other layouts. + + +=head1 SUB LAYOUTS + +Layouts can be aggregated, so that common elements can be used in different +layouts. Currently this is used for the L sub layout, +which contains a lot of the stylesheets and javascripts necessary. Another +example is the L layout, which is used to generate a +common top bar for all menu types. + +To add a sub layout to your layout just overwrite the sub_layout method: + + package SL::Layout::MyFinalLayout; + + sub init_sub_layout { + [ + SL::Layout::None->new, + SL::Layout::MyEvilLayout->new, + ] + } + +You can also add a sublayout at runtime: + + $layout->add_sub_layout(SL::Layout::SideBar->new); + +The standard implementation for the callbacks will see to it that the contents +of all sub layouts will get rendered. + + +=head1 COMBINING SUB LAYOUTS AND OWN BEHAVIOUR + +This is still somewhat rough, and improvements are welcome. + +For the C<*_content> callbacks this works if you just remember to dispatch to the base method: + + sub post_content { + return $_[0]->render_status_bar . + $_[0]->SUPER::post_content + } + + +Stylesheets and Javascripts can be added to every layout and sub-layout at +runtime with L and +L (C and +C are aliases for backwards compatibility): + + $layout->add_stylesheets("custom.css"); + $layout->add_javascripts("app.js", "widget.js"); + +Or they can be overwritten in sub layouts with the calls +L and +L: + + sub static_stylesheets { + "custom.css" + } + + sub static_javascripts { + qw(app.css widget.js) + } + +Note how these are relative to the base dirs of the currently selected +stylesheets. Javascripts are resolved relative to the C basedir. + +Setting directly with C and C is eprecated. + + +=head1 GORY DETAILS ABOUT JAVASCRIPT AND STYLESHEET OVERLOADING + +The original code used to store one stylesheet in C<< $form->{stylesheet} >> and +allowed/expected authors of potential C controllers to change +that into their own modified stylesheet. + +This was at some point cleaned up into a method C which took a +string of space separated stylesheets and processed them into the response. + +A lot of controllers are still using this method so the layout interface +supports it to change as little controller code as possible, while providing the +more intuitive C method. + +At the same time the following things need to be possible: + +=over 4 + +=item 1. + +Runtime additions. + + $layout->add_stylesheets(...) + +Since add_stylesheets adds to C<< $self->{stylesheets} >> there must be a way to read +from it. Currently this is the deprecated C. + +=item 2. + +Overriding Callbacks + +A leaf layout should be able to override a callback to return a list. + +=item 3. + +Sanitizing + +C needs to retain its sanitizing behaviour. + +=item 4. + +Aggregation + +The standard implementation should be able to collect from sub layouts. + +=item 5. + +Preserving Inclusion Order + +Since there is currently no standard way of mixing own content and including +sub layouts, this has to be done manually. Certain things like jquery get added +in L so that they get rendered first. + +=back + +The current implementation provides no good candidate for overriding in sub +classes, which should be changed. The other points work pretty well. + +=head1 BUGS + +* stylesheet/javascript interface is a horrible mess. + +* It's currently not possible to do compositor layouts without assupmtions +about the position of the content. That's because the content will return +control to the actual controller, so the layouts need to know where to split +pre- and post-content. + +=head1 AUTHOR + +Sven Schöling Es.schoeling@linet-services.deE + +=cut