use strict;
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 auto_reload_resources_param) ],
+ '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' },
use SL::Menu;
use SL::Presenter;
+use SL::System::Process;
my %menu_cache;
}
sub init_menu {
- Menu->new('crm/update/menu.ini', 'menus/erp.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 {
- return '' unless $::lx_office_conf{debug}->{auto_reload_resources};
- return sprintf('?rand=%d-%d-%d', Time::HiRes::gettimeofday(), int(rand 1000000000000));
+ 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 '';
}
##########################################
sub init_sub_layouts { [] }
+sub init_sub_layouts_by_name { +{} }
+
#########################################
-# Interface
+# Stylesheets
########################################
+# override in sub layouts
+sub static_stylesheets {}
+
sub add_stylesheets {
&use_stylesheet;
}
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 {
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 {
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/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
}
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 grep { $_ } map { $self->_find_javascript($_) }
- map({ $_->javascripts } $self->sub_layouts), $self->use_javascript;
+ $self->use_javascript;
}
sub _find_javascript {
return "js/$javascript" if -f "js/$javascript";
return $javascript if -f $javascript;
+ return $javascript if $javascript =~ /^http/;
}
=head1 DESCRIPTION
-For a description about the external interface of layouts in general see
+For a description of the external interface of layouts in general see
L<SL::Layout::Dispatcher>.
This is a base class for layouts in general. It provides the basic interface
=head1 IMPLEMENTING LAYOUT CALLBACKS
There are eight callbacks (C<pre_content>, C<post_content>, C<start_content>,
-C<end_content>, C<stylesheets>, C<stylesheets_inline>, C<javscripts>,
+C<end_content>, C<stylesheets>, C<stylesheets_inline>, C<javascripts>,
C<javascripts_inline>) which are documented in L<SL::Layout::Dispatcher>. If
you are writing a new simple layout, you can just override some of them like
this:
$_[0]->SUPER::post_content
}
-For the stylesheet and javascript callbacks things are hard, because of the
-backwards compatibility, and the built-in sanity checks. The best way currently
-is to just add your content and dispatch to the base method.
- sub stylesheets {
- $_[0]->add_stylesheets(qw(mystyle1.css mystyle2.css);
- $_[0]->SUPER::stylesheets;
+Stylesheets and Javascripts can be added to every layout and sub-layout at
+runtime with L<SL::Layout::Dispatcher/add_stylesheets> and
+L<SL::Layout::Dispatcher/add_javascripts> (C<use_stylesheets> and
+C<use_javascripts> 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<SL::Layout::Displatcher/static_stylesheets> and
+L<SL::Layout::Dispatcher/static_javascripts>:
+
+ 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<js/> basedir.
+
+Setting directly with C<stylesheets> and C<javascripts> is eprecated.
+
+
=head1 GORY DETAILS ABOUT JAVASCRIPT AND STYLESHEET OVERLOADING
-The original code used to store one stylehsheet in C<< $form->{stylesheet} >> and
+The original code used to store one stylesheet in C<< $form->{stylesheet} >> and
allowed/expected authors of potential C<bin/mozilla/> controllers to change
that into their own modified stylesheet.
This was at some point cleaned up into a method C<use stylesheet> which took a
string of space separated stylesheets and processed them into the response.
-A lot of controllers are still using this methods so the layout interface
-supports it to change as few controller code as possible, while providing the
+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<add_stylesheets> method.
At the same time the following things need to be possible:
Sanitizing
-C<stylesheets> needs to retain it's sanitizing behaviour.
+C<stylesheets> needs to retain its sanitizing behaviour.
=item 4.
=item 5.
-Preserving of Inclusion Order
+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
=head1 BUGS
-None yet, if you don't count the horrible stylesheet/javascript interface.
+* 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
projects / kivitendo-erp.git / blobdiff