lib/Frey/Web.pm

package Frey::Web;
use Moose::Role;

with 'Frey::Backtrace';

use Frey::Types;

use Continuity::Widget::DomNode;
use Data::Dump qw/dump/;
use Carp qw/confess cluck/;
use File::Slurp;

use Frey::Bookmarklet;
use Frey::ClassBrowser;
use Frey::SVK;

has 'head' => (
        is => 'rw',
        isa => 'ArrayRef[Str]',
        default => sub { [ 'static/frey.css' ] },
);

has 'request_url' => (
        is => 'rw',
        isa => 'Uri', coerce => 1,
        default => '/',
);

has 'title' => (
        is => 'rw',
        isa => 'Str',
        lazy => 1,
        default => sub {
                my ($self) = @_;
                ref($self);
        },
);

has 'content_type' => (
        is => 'rw',
        isa => 'Str',
        default => 'text/html',
        documentation => 'Content-type header',
);

has 'dump_max_bytes' => (
        is => 'rw',
        isa => 'Int',
        default => 4096,
        documentation => 'Maximum dump size sent to browser before truncation',
);

=head2 inline_smaller_than

Inline JavaScript and CSS smaller than this size into page reducing
round-trips to server.

=cut

has 'inline_smaller_than' => (
        is => 'rw',
        isa => 'Int',
        default => 10240,
);

sub dom2html {
#       warn "## dom2html ",dump( @_ );
        return Continuity::Widget::DomNode->create( @_ )->to_string;
}

sub _inline_path {
        my ( $self, $path ) = @_;
        -s $path < $self->inline_smaller_than;
}

sub _head_html {
        my $self = shift;
        my $out = '';
        foreach my $path ( @{ $self->head } ) {
                $path =~ s!^/!!;
                if ( $path =~ m/\.js$/ ) {
                        $out .= $self->_inline_path( $path ) ?
                                qq|<!-- $path --><script type="text/javascript">\n| . read_file($path) . qq|\n</script>| :
                                qq|<script type="text/javascript" src="/$path"></script>|;
                } elsif ( $path =~ m/\.css$/ ) {
                        $out .= $self->_inline_path( $path ) ?
                                qq|<!-- $path --><style type="text/css">\n| . read_file( $path ) . qq|\n</style>| :
                                qq|<link type="text/css" rel="stylesheet" href="/$path" media="screen">|;
                } elsif ( $path =~ m{<.+>}s ) {
                        $out .= $path;
                } else {
                        confess "don't know how to render $path";
                }
                $out .= "\n";
        }
        return $out;
}

=head2 add_head

  $o->add_head( 'path/to/external.js' );

  my $size = $o->add_head( 'path/to/external.css' );

  $o->add_head( '<!-- html content -->' );

=cut

sub add_head {
        my ( $self, $path ) = @_;
        return if ! defined $path || $path eq '';
        $path =~ s!^/!!;

        if ( $path =~ m{<.*>}s ) {
                push @{ $self->head }, $path;
        } elsif ( -e $path ) {
                if ( $path =~ m/\.(?:js|css)$/ ) {
                        push @{ $self->head }, $path;
                } else {
                        confess "can't add_head( $path ) it's not js or css";
                }
                return -s $path;
        } else {
                confess "can't find $path: $!";
        }

}

our $reload_counter = 0;


=head2 page

  $self->page(
        title => 'page title',
        head  => '<!-- optional head markup -->',
        body  => '<b>Page Body</b>',
  );

=cut

our @status;
sub status { @status };

our $icon_html;

sub page {
        my $self = shift;
        my $a = {@_};

        warn "## page ",dump($a);

        $reload_counter++;

        my $status_line = '';

        unshift @status, { 'ClassBrowser' => Frey::ClassBrowser->new( usage_on_top => 0 )->as_markup };
        unshift @status, { 'Bookmarklets' => Frey::Bookmarklet->new->as_markup };

        foreach my $part ( @status ) {
                foreach my $name ( keys %$part ) {
                        my $content = $part->{$name};
                        if ( ref($content) ) {
                                $content = '<code>' . dump($content) . '</code>';
                                my $l = length($content);
                                $content = qq|<span>$l bytes</span>| if $l > $self->dump_max_bytes;
                        } else {
                                $content = qq|<span>$content</span>|;
                        }
                        warn "### part [$name] = ", length( $content ), " bytes" if $self->debug;
                        $status_line .= qq|<span class="frey-popup">$name $content</span>\n|;
                }
        }

        my $url = $self->request_url;
        $url =~ s{\?reload=\d+}{};

        my $body = $a->{body};
        $body ||= $self->as_markup if $self->can('as_markup');
        if ( $self->content_type !~ m{html} ) {
                warn "# return only $self body ", $self->content_type;
                return $body
        } elsif ( ! defined $body ) {
                warn "# no body";
                $body = '<!-- no body -->';
        }

        my $warn_colors = {
                '#'  => '#444',
                '##' => '#888',
        };

        $status_line
                .= qq|<span class="frey-popup">warn<span>|
                . $self->editor_links(
                        join("", map {
                                warn "# $_";
                                my $style = '';
                                $style = $warn_colors->{$1}
                                        ? ' style="color:' . $warn_colors->{$1} . '"'
                                        : ''
                                        if m{^(#+)};
                                qq|<tt$style>$_</tt><br/>|; # XXX <tt> should be <code> but CSS hates me
                        } $self->warnings )
                )
                . qq|</span></span>|
                if $self->warnings;

        my      ($exit,$description) = ('exit','stop server');
                ($exit,$description) = ('restart','restart server')
                if $ENV{FREY_RESTART}; # tune labels on exit link

        my $right =
                qq|
                        <span class="right">
                        <a title="reload $url"  href="/reload$url">reload</a>
                        <a title="$description" href="/exit$url">$exit</a>
                        </span>
                |;

        my $info = Frey::SVK->info;
        my $revision = Frey::SVK->info->{Revision} || '';
        $revision = $1 if $info->{'Mirrored From'} =~ m{Rev\.\s+(\d+)};

        $self->add_icon unless $icon_html;

        my $html = join("\n",
                qq|<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"><html><head>|,
                $self->_head_html,
                '<title>' . ( $self->title || $a->{title} || ref($self) ) . '</title>',
                '<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">',
                ( $icon_html || '<!-- no icon -->' ),
                ( $a->{head} || '' ),
                qq|
                </head><body>
                $body
                <div class="frey-status-line">
                        <a href="/">Frey</a> $Frey::VERSION $revision
                        $status_line
                        $right
                </div>
            </body></html>
                |,
        );

        warn "## >>> page ",length($html), " bytes\n" if $self->debug;

        return $html;
}

=head2 editor

Create HTML editor link with optional line and title

  my $html = $self->editor( $class, $line, $title );

=cut

sub editor {
        my ( $self, $class, $line, $title ) = @_;
        confess "need class" unless $class;
        if ( ! defined $title ) {
                $title  = "edit $class";
                $title .= " line $line" if $line;
        }
        $line  ||= 1;
        qq|<a target="editor" href="/editor+$class+$line"| .
        ( $title ? qq| title="$title"| : '' ) .
        qq|>$class</a>|;
}

=head2 editor_links

Create HTML links to editor for perl error message

  my $html = $self->editor_links( $error )

=cut

sub editor_links {
        my ( $self, $error ) = @_;

        $error =~ s{at\s+(\S+)\s+line\s+(\d+)}
                {at <a target="editor" href="/editor+$1+$2">$1</a> line $2}gsm;

        $error =~ s{(via package ")([\w:]+)(")}
                {$1<a target="editor" href="/editor+$2+1">$2</a>$3}gsm;

        return $error;
}

sub error {
        my $self = shift;
        my $error = join(" ", @_);

        my @backtrace = $self->backtrace;
        $error .= "\n\t" . join( "\n\t", @backtrace ) if @backtrace;

        warn "ERROR: $error\n";
        return
                qq|<pre class="frey-error">|
                . $self->editor_links( $error ) .
                qq|</pre>|
                ;
}

sub add_status {
        my ( $self, $data ) = @_;
        push @status, $data;
}

sub clean_status {
        @status = ();
        $icon_html = '';
}

sub status_parts {
        warn "## status parts ", dump( map { keys %$_ } @status );
}

sub DEMOLISH {
        my ( $self ) = @_;
        cluck "## DEMOLISH status ", $#status + 1, " elements ", dump( map { keys %$_ } @status ) if @status;
}

=head2 add_icon

  Frey::Foo->add_icon;            # /static/icons/Frey/Foo.png
  Frey::Foo->add_icon('warning'); # /static/icons/Frey/Foo/warning.png

=cut

sub add_icon {
        my ($self,$name) = @_;
        my $icon = ref($self);
        $icon = $self->class if $self->can('class');
        $icon =~ s{::}{/}g;
        $icon .= "/$name" if $name;

        my $icon_path = "static/icons/$icon.png";

        if ( -e $icon_path ) {
                $icon_html .= qq|<link rel="icon" type="image/png" href="/$icon_path">|;
                warn "# using icon $icon_path";

=for later

                # FIXME http://en.wikipedia.org/wiki/Favicon suggest just rel="icon" but that doesn't seem to work!
                my $ico_path = $icon_path;
                $ico_path =~ s{png$}{ico};
                if ( ! -e $ico_path ) {
                        system "convert $icon_path $ico_path";
                        warn "# convert $icon_path $ico_path : $@";
                }
                $icon_html .= qq|<link rel="shortcut icon" type="image/x-icon" href="/$ico_path">| if -e $ico_path;

=cut

        } else {
                warn "TODO add $icon_path icon";
        }
}

1;
1	dpavlin	100	package Frey::Web;
2			use Moose::Role;
3
4	dpavlin	465	with 'Frey::Backtrace';
5
6	dpavlin	388	use Frey::Types;
7
8	dpavlin	100	use Continuity::Widget::DomNode;
9			use Data::Dump qw/dump/;
10	dpavlin	518	use Carp qw/confess cluck/;
11	dpavlin	161	use File::Slurp;
12	dpavlin	100
13	dpavlin	410	use Frey::Bookmarklet;
14			use Frey::ClassBrowser;
15	dpavlin	505	use Frey::SVK;
16	dpavlin	410
17	dpavlin	156	has 'head' => (
18	dpavlin	121	is => 'rw',
19			isa => 'ArrayRef[Str]',
20	dpavlin	160	default => sub { [ 'static/frey.css' ] },
21	dpavlin	121	);
22
23	dpavlin	392	has 'request_url' => (
24	dpavlin	388	is => 'rw',
25			isa => 'Uri', coerce => 1,
26			default => '/',
27			);
28
29	dpavlin	418	has 'title' => (
30			is => 'rw',
31			isa => 'Str',
32			lazy => 1,
33			default => sub {
34			my ($self) = @_;
35			ref($self);
36			},
37			);
38
39	dpavlin	448	has 'content_type' => (
40			is => 'rw',
41			isa => 'Str',
42			default => 'text/html',
43	dpavlin	476	documentation => 'Content-type header',
44	dpavlin	448	);
45
46	dpavlin	476	has 'dump_max_bytes' => (
47			is => 'rw',
48			isa => 'Int',
49			default => 4096,
50			documentation => 'Maximum dump size sent to browser before truncation',
51			);
52
53	dpavlin	206	=head2 inline_smaller_than
54
55			Inline JavaScript and CSS smaller than this size into page reducing
56			round-trips to server.
57
58			=cut
59
60	dpavlin	161	has 'inline_smaller_than' => (
61			is => 'rw',
62			isa => 'Int',
63			default => 10240,
64			);
65
66	dpavlin	100	sub dom2html {
67	dpavlin	106	# warn "## dom2html ",dump( @_ );
68	dpavlin	100	return Continuity::Widget::DomNode->create( @_ )->to_string;
69			}
70
71	dpavlin	161	sub _inline_path {
72			my ( $self, $path ) = @_;
73			-s $path < $self->inline_smaller_than;
74			}
75
76	dpavlin	156	sub _head_html {
77			my $self = shift;
78	dpavlin	121	my $out = '';
79	dpavlin	156	foreach my $path ( @{ $self->head } ) {
80	dpavlin	121	$path =~ s!^/!!;
81	dpavlin	156	if ( $path =~ m/\.js$/ ) {
82	dpavlin	161	$out .= $self->_inline_path( $path ) ?
83	dpavlin	163	qq\|<!-- $path --><script type="text/javascript">\n\| . read_file($path) . qq\|\n</script>\| :
84	dpavlin	161	qq\|<script type="text/javascript" src="/$path"></script>\|;
85	dpavlin	156	} elsif ( $path =~ m/\.css$/ ) {
86	dpavlin	161	$out .= $self->_inline_path( $path ) ?
87	dpavlin	163	qq\|<!-- $path --><style type="text/css">\n\| . read_file( $path ) . qq\|\n</style>\| :
88	dpavlin	161	qq\|<link type="text/css" rel="stylesheet" href="/$path" media="screen">\|;
89	dpavlin	446	} elsif ( $path =~ m{<.+>}s ) {
90	dpavlin	444	$out .= $path;
91	dpavlin	156	} else {
92			confess "don't know how to render $path";
93			}
94	dpavlin	163	$out .= "\n";
95	dpavlin	121	}
96			return $out;
97			}
98	dpavlin	100
99	dpavlin	154	=head2 add_head
100
101			$o->add_head( 'path/to/external.js' );
102
103			my $size = $o->add_head( 'path/to/external.css' );
104
105	dpavlin	445	$o->add_head( '<!-- html content -->' );
106
107	dpavlin	154	=cut
108
109			sub add_head {
110			my ( $self, $path ) = @_;
111			return if ! defined $path \|\| $path eq '';
112			$path =~ s!^/!!;
113
114	dpavlin	446	if ( $path =~ m{<.*>}s ) {
115	dpavlin	444	push @{ $self->head }, $path;
116			} elsif ( -e $path ) {
117	dpavlin	156	if ( $path =~ m/\.(?:js\|css)$/ ) {
118			push @{ $self->head }, $path;
119	dpavlin	154	} else {
120			confess "can't add_head( $path ) it's not js or css";
121			}
122	dpavlin	444	return -s $path;
123	dpavlin	154	} else {
124			confess "can't find $path: $!";
125			}
126
127			}
128
129	dpavlin	142	our $reload_counter = 0;
130
131	dpavlin	183
132			=head2 page
133
134			$self->page(
135			title => 'page title',
136			head => '<!-- optional head markup -->',
137			body => '<b>Page Body</b>',
138			);
139
140			=cut
141
142	dpavlin	519	our @status;
143			sub status { @status };
144
145	dpavlin	527	our $icon_html;
146
147	dpavlin	121	sub page {
148	dpavlin	100	my $self = shift;
149	dpavlin	121	my $a = {@_};
150	dpavlin	100
151	dpavlin	519	warn "## page ",dump($a);
152
153	dpavlin	142	$reload_counter++;
154
155	dpavlin	388	my $status_line = '';
156	dpavlin	519
157			unshift @status, { 'ClassBrowser' => Frey::ClassBrowser->new( usage_on_top => 0 )->as_markup };
158			unshift @status, { 'Bookmarklets' => Frey::Bookmarklet->new->as_markup };
159
160			foreach my $part ( @status ) {
161	dpavlin	388	foreach my $name ( keys %$part ) {
162	dpavlin	392	my $content = $part->{$name};
163			if ( ref($content) ) {
164	dpavlin	397	$content = '<code>' . dump($content) . '</code>';
165			my $l = length($content);
166	dpavlin	476	$content = qq\|<span>$l bytes</span>\| if $l > $self->dump_max_bytes;
167	dpavlin	392	} else {
168			$content = qq\|<span>$content</span>\|;
169			}
170			warn "### part [$name] = ", length( $content ), " bytes" if $self->debug;
171	dpavlin	397	$status_line .= qq\|<span class="frey-popup">$name $content</span>\n\|;
172	dpavlin	388	}
173			}
174
175	dpavlin	439	my $url = $self->request_url;
176			$url =~ s{\?reload=\d+}{};
177
178	dpavlin	460	my $body = $a->{body};
179			$body \|\|= $self->as_markup if $self->can('as_markup');
180			if ( $self->content_type !~ m{html} ) {
181			warn "# return only $self body ", $self->content_type;
182			return $body
183			} elsif ( ! defined $body ) {
184			warn "# no body";
185			$body = '<!-- no body -->';
186			}
187	dpavlin	448
188	dpavlin	482	my $warn_colors = {
189			'#' => '#444',
190			'##' => '#888',
191			};
192
193	dpavlin	468	$status_line
194	dpavlin	482	.= qq\|<span class="frey-popup">warn<span>\|
195			. $self->editor_links(
196			join("", map {
197			warn "# $_";
198			my $style = '';
199			$style = $warn_colors->{$1}
200			? ' style="color:' . $warn_colors->{$1} . '"'
201			: ''
202			if m{^(#+)};
203			qq\|<tt$style>$_</tt><br/>\|; # XXX <tt> should be <code> but CSS hates me
204			} $self->warnings )
205			)
206			. qq\|</span></span>\|
207	dpavlin	468	if $self->warnings;
208
209	dpavlin	477	my ($exit,$description) = ('exit','stop server');
210			($exit,$description) = ('restart','restart server')
211			if $ENV{FREY_RESTART}; # tune labels on exit link
212
213	dpavlin	473	my $right =
214			qq\|
215			<span class="right">
216	dpavlin	519	<a title="reload $url" href="/reload$url">reload</a>
217	dpavlin	477	<a title="$description" href="/exit$url">$exit</a>
218	dpavlin	473	</span>
219			\|;
220
221	dpavlin	516	my $info = Frey::SVK->info;
222	dpavlin	505	my $revision = Frey::SVK->info->{Revision} \|\| '';
223	dpavlin	516	$revision = $1 if $info->{'Mirrored From'} =~ m{Rev\.\s+(\d+)};
224	dpavlin	505
225	dpavlin	527	$self->add_icon unless $icon_html;
226	dpavlin	524
227	dpavlin	388	my $html = join("\n",
228			qq\|<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"><html><head>\|,
229			$self->_head_html,
230	dpavlin	418	'<title>' . ( $self->title \|\| $a->{title} \|\| ref($self) ) . '</title>',
231	dpavlin	388	'<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">',
232	dpavlin	527	( $icon_html \|\| '<!-- no icon -->' ),
233	dpavlin	388	( $a->{head} \|\| '' ),
234			qq\|
235	dpavlin	448	</head><body>
236			$body
237	dpavlin	388	<div class="frey-status-line">
238	dpavlin	505	<a href="/">Frey</a> $Frey::VERSION $revision
239	dpavlin	388	$status_line
240	dpavlin	473	$right
241	dpavlin	210	</div>
242			</body></html>
243	dpavlin	388	\|,
244			);
245	dpavlin	100
246	dpavlin	121	warn "## >>> page ",length($html), " bytes\n" if $self->debug;
247	dpavlin	100
248	dpavlin	121	return $html;
249	dpavlin	100	}
250
251	dpavlin	480	=head2 editor
252
253			Create HTML editor link with optional line and title
254
255			my $html = $self->editor( $class, $line, $title );
256
257			=cut
258
259			sub editor {
260			my ( $self, $class, $line, $title ) = @_;
261			confess "need class" unless $class;
262	dpavlin	519	if ( ! defined $title ) {
263			$title = "edit $class";
264			$title .= " line $line" if $line;
265			}
266			$line \|\|= 1;
267	dpavlin	480	qq\|<a target="editor" href="/editor+$class+$line"\| .
268			( $title ? qq\| title="$title"\| : '' ) .
269			qq\|>$class</a>\|;
270			}
271
272			=head2 editor_links
273
274			Create HTML links to editor for perl error message
275
276			my $html = $self->editor_links( $error )
277
278			=cut
279
280	dpavlin	468	sub editor_links {
281			my ( $self, $error ) = @_;
282
283			$error =~ s{at\s+(\S+)\s+line\s+(\d+)}
284			{at <a target="editor" href="/editor+$1+$2">$1</a> line $2}gsm;
285
286			$error =~ s{(via package ")([\w:]+)(")}
287			{$1<a target="editor" href="/editor+$2+1">$2</a>$3}gsm;
288
289			return $error;
290			}
291
292	dpavlin	350	sub error {
293	dpavlin	397	my $self = shift;
294			my $error = join(" ", @_);
295	dpavlin	460
296	dpavlin	465	my @backtrace = $self->backtrace;
297			$error .= "\n\t" . join( "\n\t", @backtrace ) if @backtrace;
298	dpavlin	460
299			warn "ERROR: $error\n";
300	dpavlin	468	return
301			qq\|<pre class="frey-error">\|
302			. $self->editor_links( $error ) .
303			qq\|</pre>\|
304			;
305	dpavlin	350	}
306
307	dpavlin	507	sub add_status {
308			my ( $self, $data ) = @_;
309	dpavlin	519	push @status, $data;
310	dpavlin	507	}
311
312	dpavlin	519	sub clean_status {
313			@status = ();
314	dpavlin	527	$icon_html = '';
315	dpavlin	519	}
316
317			sub status_parts {
318			warn "## status parts ", dump( map { keys %$_ } @status );
319			}
320
321	dpavlin	518	sub DEMOLISH {
322			my ( $self ) = @_;
323	dpavlin	519	cluck "## DEMOLISH status ", $#status + 1, " elements ", dump( map { keys %$_ } @status ) if @status;
324	dpavlin	518	}
325
326	dpavlin	527	=head2 add_icon
327
328			Frey::Foo->add_icon; # /static/icons/Frey/Foo.png
329			Frey::Foo->add_icon('warning'); # /static/icons/Frey/Foo/warning.png
330
331			=cut
332
333	dpavlin	524	sub add_icon {
334	dpavlin	527	my ($self,$name) = @_;
335	dpavlin	524	my $icon = ref($self);
336			$icon = $self->class if $self->can('class');
337			$icon =~ s{::}{/}g;
338	dpavlin	527	$icon .= "/$name" if $name;
339	dpavlin	524
340			my $icon_path = "static/icons/$icon.png";
341
342			if ( -e $icon_path ) {
343	dpavlin	527	$icon_html .= qq\|<link rel="icon" type="image/png" href="/$icon_path">\|;
344	dpavlin	524	warn "# using icon $icon_path";
345
346	dpavlin	527	=for later
347
348	dpavlin	524	# FIXME http://en.wikipedia.org/wiki/Favicon suggest just rel="icon" but that doesn't seem to work!
349			my $ico_path = $icon_path;
350			$ico_path =~ s{png$}{ico};
351			if ( ! -e $ico_path ) {
352			system "convert $icon_path $ico_path";
353			warn "# convert $icon_path $ico_path : $@";
354			}
355	dpavlin	527	$icon_html .= qq\|<link rel="shortcut icon" type="image/x-icon" href="/$ico_path">\| if -e $ico_path;
356	dpavlin	524
357	dpavlin	527	=cut
358
359	dpavlin	524	} else {
360	dpavlin	527	warn "TODO add $icon_path icon";
361	dpavlin	524	}
362			}
363
364	dpavlin	100	1;