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 'status' => (
        is => 'rw',
        isa => 'ArrayRef[HashRef[Str]]',
        lazy => 1,
        default => sub { [
#               { 'ClassBrowser' => Frey::ClassBrowser->new( usage_on_top => 0 )->as_markup },
#               { 'Bookmarklets' => Frey::Bookmarklet->new->as_markup },
        ] },
);

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

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

        $reload_counter++;

        my $status_line = '';
        foreach my $part ( @{ $self->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"  href="/reload$url"><code>$url</code></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+)};

        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">',
                ( $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;
        $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 @{ $self->status }, $data;
}

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

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