1 package SL::Layout::Base;
4 use parent qw(Rose::Object);
6 use List::MoreUtils qw(uniq);
9 use Rose::Object::MakeMethods::Generic (
10 'scalar --get_set_init' => [ qw(menu auto_reload_resources_param) ],
11 'scalar' => qw(focus),
13 'add_stylesheets_inline' => { interface => 'add', hash_key => 'stylesheets_inline' },
14 'add_javascripts_inline' => { interface => 'add', hash_key => 'javascripts_inline' },
15 'sub_layouts', => { interface => 'get_set_init' },
16 'add_sub_layouts' => { interface => 'add', hash_key => 'sub_layouts' },
26 my ($class, @slurp) = @_;
28 my $self = $class->SUPER::new(@slurp);
32 my @menu_files = qw(menus/erp.ini);
33 unshift @menu_files, 'menus/crm.ini' if $::instance_conf->crm_installed;
34 Menu->new(@menu_files);
37 sub init_auto_reload_resources_param {
38 return '' unless $::lx_office_conf{debug}->{auto_reload_resources};
39 return sprintf('?rand=%d-%d-%d', Time::HiRes::gettimeofday(), int(rand 1000000000000));
42 ##########################################
43 # inheritable/overridable
44 ##########################################
47 join '', map { $_->pre_content } $_[0]->sub_layouts;
51 join '', map { $_->start_content } $_[0]->sub_layouts;
55 join '', map { $_->end_content } $_[0]->sub_layouts;
59 join '', map { $_->post_content } $_[0]->sub_layouts;
62 sub stylesheets_inline {
63 uniq ( map { $_->stylesheets_inline } $_[0]->sub_layouts ),
64 @{ $_[0]->{stylesheets_inline} || [] };
67 sub javascripts_inline {
68 uniq ( map { $_->javascripts_inline } $_[0]->sub_layouts ),
69 @{ $_[0]->{javascripts_inline} || [] };
72 sub init_sub_layouts { [] }
75 #########################################
77 ########################################
85 push @{ $self->{stylesheets} ||= [] }, @_ if @_;
86 @{ $self->{stylesheets} ||= [] };
91 my $css_path = $self->get_stylesheet_for_user;
93 return uniq grep { $_ } map { $self->_find_stylesheet($_, $css_path) }
94 $self->use_stylesheet, map { $_->stylesheets } $self->sub_layouts;
97 sub _find_stylesheet {
98 my ($self, $stylesheet, $css_path) = @_;
100 return "$css_path/$stylesheet" if -f "$css_path/$stylesheet";
101 return "css/$stylesheet" if -f "css/$stylesheet";
102 return $stylesheet if -f $stylesheet;
105 sub get_stylesheet_for_user {
106 my $css_path = 'css';
107 if (my $user_style = $::myconfig{stylesheet}) {
108 $user_style =~ s/\.css$//; # nuke trailing .css, this is a remnant of pre 2.7.0 stylesheet handling
109 if (-d "$css_path/$user_style" &&
110 -f "$css_path/$user_style/main.css") {
111 $css_path = "$css_path/$user_style";
113 $css_path = "$css_path/kivitendo";
116 $css_path = "$css_path/kivitendo";
122 sub add_javascripts {
128 push @{ $self->{javascripts} ||= [] }, @_ if @_;
129 @{ $self->{javascripts} ||= [] };
135 return uniq grep { $_ } map { $self->_find_javascript($_) }
136 map({ $_->javascripts } $self->sub_layouts), $self->use_javascript;
139 sub _find_javascript {
140 my ($self, $javascript) = @_;
142 return "js/$javascript" if -f "js/$javascript";
143 return $javascript if -f $javascript;
147 ############################################
148 # track state of form header
149 ############################################
152 $_[0]{_header_done} = 1;
171 SL::Layout::Base - Base class for layouts
175 package SL::Layout::MyLayout;
177 use parent qw(SL::Layout::Base);
181 For a description of the external interface of layouts in general see
182 L<SL::Layout::Dispatcher>.
184 This is a base class for layouts in general. It provides the basic interface
185 and some capabilities to extend and cascade layouts.
188 =head1 IMPLEMENTING LAYOUT CALLBACKS
190 There are eight callbacks (C<pre_content>, C<post_content>, C<start_content>,
191 C<end_content>, C<stylesheets>, C<stylesheets_inline>, C<javascripts>,
192 C<javascripts_inline>) which are documented in L<SL::Layout::Dispatcher>. If
193 you are writing a new simple layout, you can just override some of them like
196 package SL::Layout::MyEvilLayout;
199 '<h1>This is MY page now</h1>'
203 '<p align="right"><small><em>Brought to you by my own layout class</em></small></p>'
207 To preserve the sanitizing effects of C<stylesheets> and C<javascripts> you should instead do the following:
210 $_[0]->add_stylesheets(qw(mystyle1.css mystyle2.css);
211 $_[0]->SUPER::stylesheets;
214 If you want to add something to a different layout, you should write a sub
215 layout and add it to the other layouts.
220 Layouts can be aggregated, so that common elements can be used in different
221 layouts. Currently this is used for the L<None|SL::Layout::None> sub layout,
222 which contains a lot of the stylesheets and javascripts necessary. Another
223 example is the L<Top|SL::Layout::Top> layout, which is used to generate a
224 common top bar for all menu types.
226 To add a sub layout to your layout just overwrite the sub_layout method:
228 package SL::Layout::MyFinalLayout;
230 sub init_sub_layout {
232 SL::Layout::None->new,
233 SL::Layout::MyEvilLayout->new,
237 You can also add a sublayout at runtime:
239 $layout->add_sub_layout(SL::Layout::SideBar->new);
241 The standard implementation for the callbacks will see to it that the contents
242 of all sub layouts will get rendered.
245 =head1 COMBINING SUB LAYOUTS AND OWN BEHAVIOUR
247 This is still somewhat rough, and improvements are welcome.
249 For the C<*_content> callbacks this works if you just remember to dispatch to the base method:
252 return $_[0]->render_status_bar .
253 $_[0]->SUPER::post_content
256 For the stylesheet and javascript callbacks things are hard, because of the
257 backwards compatibility, and the built-in sanity checks. The best way currently
258 is to just add your content and dispatch to the base method.
261 $_[0]->add_stylesheets(qw(mystyle1.css mystyle2.css);
262 $_[0]->SUPER::stylesheets;
265 =head1 GORY DETAILS ABOUT JAVASCRIPT AND STYLESHEET OVERLOADING
267 The original code used to store one stylesheet in C<< $form->{stylesheet} >> and
268 allowed/expected authors of potential C<bin/mozilla/> controllers to change
269 that into their own modified stylesheet.
271 This was at some point cleaned up into a method C<use stylesheet> which took a
272 string of space separated stylesheets and processed them into the response.
274 A lot of controllers are still using this method so the layout interface
275 supports it to change as little controller code as possible, while providing the
276 more intuitive C<add_stylesheets> method.
278 At the same time the following things need to be possible:
286 $layout->add_stylesheets(...)
288 Since add_stylesheets adds to C<< $self->{stylesheets} >> there must be a way to read
289 from it. Currently this is the deprecated C<use_stylesheet>.
295 A leaf layout should be able to override a callback to return a list.
301 C<stylesheets> needs to retain its sanitizing behaviour.
307 The standard implementation should be able to collect from sub layouts.
311 Preserving Inclusion Order
313 Since there is currently no standard way of mixing own content and including
314 sub layouts, this has to be done manually. Certain things like jquery get added
315 in L<SL::Layout::None> so that they get rendered first.
319 The current implementation provides no good candidate for overriding in sub
320 classes, which should be changed. The other points work pretty well.
324 None yet, if you don't count the horrible stylesheet/javascript interface.
328 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>