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 };

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+)};

        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;
        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 = ();
}

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;
}

1;
1	package Frey::Web;
2	use Moose::Role;
3
4	with 'Frey::Backtrace';
5
6	use Frey::Types;
7
8	use Continuity::Widget::DomNode;
9	use Data::Dump qw/dump/;
10	use Carp qw/confess cluck/;
11	use File::Slurp;
12
13	use Frey::Bookmarklet;
14	use Frey::ClassBrowser;
15	use Frey::SVK;
16
17	has 'head' => (
18	is => 'rw',
19	isa => 'ArrayRef[Str]',
20	default => sub { [ 'static/frey.css' ] },
21	);
22
23	has 'request_url' => (
24	is => 'rw',
25	isa => 'Uri', coerce => 1,
26	default => '/',
27	);
28
29	has 'title' => (
30	is => 'rw',
31	isa => 'Str',
32	lazy => 1,
33	default => sub {
34	my ($self) = @_;
35	ref($self);
36	},
37	);
38
39	has 'content_type' => (
40	is => 'rw',
41	isa => 'Str',
42	default => 'text/html',
43	documentation => 'Content-type header',
44	);
45
46	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	=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	has 'inline_smaller_than' => (
61	is => 'rw',
62	isa => 'Int',
63	default => 10240,
64	);
65
66	sub dom2html {
67	# warn "## dom2html ",dump( @_ );
68	return Continuity::Widget::DomNode->create( @_ )->to_string;
69	}
70
71	sub _inline_path {
72	my ( $self, $path ) = @_;
73	-s $path < $self->inline_smaller_than;
74	}
75
76	sub _head_html {
77	my $self = shift;
78	my $out = '';
79	foreach my $path ( @{ $self->head } ) {
80	$path =~ s!^/!!;
81	if ( $path =~ m/\.js$/ ) {
82	$out .= $self->_inline_path( $path ) ?
83	qq\|<!-- $path --><script type="text/javascript">\n\| . read_file($path) . qq\|\n</script>\| :
84	qq\|<script type="text/javascript" src="/$path"></script>\|;
85	} elsif ( $path =~ m/\.css$/ ) {
86	$out .= $self->_inline_path( $path ) ?
87	qq\|<!-- $path --><style type="text/css">\n\| . read_file( $path ) . qq\|\n</style>\| :
88	qq\|<link type="text/css" rel="stylesheet" href="/$path" media="screen">\|;
89	} elsif ( $path =~ m{<.+>}s ) {
90	$out .= $path;
91	} else {
92	confess "don't know how to render $path";
93	}
94	$out .= "\n";
95	}
96	return $out;
97	}
98
99	=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	$o->add_head( '<!-- html content -->' );
106
107	=cut
108
109	sub add_head {
110	my ( $self, $path ) = @_;
111	return if ! defined $path \|\| $path eq '';
112	$path =~ s!^/!!;
113
114	if ( $path =~ m{<.*>}s ) {
115	push @{ $self->head }, $path;
116	} elsif ( -e $path ) {
117	if ( $path =~ m/\.(?:js\|css)$/ ) {
118	push @{ $self->head }, $path;
119	} else {
120	confess "can't add_head( $path ) it's not js or css";
121	}
122	return -s $path;
123	} else {
124	confess "can't find $path: $!";
125	}
126
127	}
128
129	our $reload_counter = 0;
130
131
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	our @status;
143	sub status { @status };
144
145	sub page {
146	my $self = shift;
147	my $a = {@_};
148
149	warn "## page ",dump($a);
150
151	$reload_counter++;
152
153	my $status_line = '';
154
155	unshift @status, { 'ClassBrowser' => Frey::ClassBrowser->new( usage_on_top => 0 )->as_markup };
156	unshift @status, { 'Bookmarklets' => Frey::Bookmarklet->new->as_markup };
157
158	foreach my $part ( @status ) {
159	foreach my $name ( keys %$part ) {
160	my $content = $part->{$name};
161	if ( ref($content) ) {
162	$content = '<code>' . dump($content) . '</code>';
163	my $l = length($content);
164	$content = qq\|<span>$l bytes</span>\| if $l > $self->dump_max_bytes;
165	} else {
166	$content = qq\|<span>$content</span>\|;
167	}
168	warn "### part [$name] = ", length( $content ), " bytes" if $self->debug;
169	$status_line .= qq\|<span class="frey-popup">$name $content</span>\n\|;
170	}
171	}
172
173	my $url = $self->request_url;
174	$url =~ s{\?reload=\d+}{};
175
176	my $body = $a->{body};
177	$body \|\|= $self->as_markup if $self->can('as_markup');
178	if ( $self->content_type !~ m{html} ) {
179	warn "# return only $self body ", $self->content_type;
180	return $body
181	} elsif ( ! defined $body ) {
182	warn "# no body";
183	$body = '<!-- no body -->';
184	}
185
186	my $warn_colors = {
187	'#' => '#444',
188	'##' => '#888',
189	};
190
191	$status_line
192	.= qq\|<span class="frey-popup">warn<span>\|
193	. $self->editor_links(
194	join("", map {
195	warn "# $_";
196	my $style = '';
197	$style = $warn_colors->{$1}
198	? ' style="color:' . $warn_colors->{$1} . '"'
199	: ''
200	if m{^(#+)};
201	qq\|<tt$style>$_</tt><br/>\|; # XXX <tt> should be <code> but CSS hates me
202	} $self->warnings )
203	)
204	. qq\|</span></span>\|
205	if $self->warnings;
206
207	my ($exit,$description) = ('exit','stop server');
208	($exit,$description) = ('restart','restart server')
209	if $ENV{FREY_RESTART}; # tune labels on exit link
210
211	my $right =
212	qq\|
213	<span class="right">
214	<a title="reload $url" href="/reload$url">reload</a>
215	<a title="$description" href="/exit$url">$exit</a>
216	</span>
217	\|;
218
219	my $info = Frey::SVK->info;
220	my $revision = Frey::SVK->info->{Revision} \|\| '';
221	$revision = $1 if $info->{'Mirrored From'} =~ m{Rev\.\s+(\d+)};
222
223	my $html = join("\n",
224	qq\|<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"><html><head>\|,
225	$self->_head_html,
226	'<title>' . ( $self->title \|\| $a->{title} \|\| ref($self) ) . '</title>',
227	'<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">',
228	( $a->{head} \|\| '' ),
229	qq\|
230	</head><body>
231	$body
232	<div class="frey-status-line">
233	<a href="/">Frey</a> $Frey::VERSION $revision
234	$status_line
235	$right
236	</div>
237	</body></html>
238	\|,
239	);
240
241	warn "## >>> page ",length($html), " bytes\n" if $self->debug;
242
243	return $html;
244	}
245
246	=head2 editor
247
248	Create HTML editor link with optional line and title
249
250	my $html = $self->editor( $class, $line, $title );
251
252	=cut
253
254	sub editor {
255	my ( $self, $class, $line, $title ) = @_;
256	confess "need class" unless $class;
257	if ( ! defined $title ) {
258	$title = "edit $class";
259	$title .= " line $line" if $line;
260	}
261	$line \|\|= 1;
262	qq\|<a target="editor" href="/editor+$class+$line"\| .
263	( $title ? qq\| title="$title"\| : '' ) .
264	qq\|>$class</a>\|;
265	}
266
267	=head2 editor_links
268
269	Create HTML links to editor for perl error message
270
271	my $html = $self->editor_links( $error )
272
273	=cut
274
275	sub editor_links {
276	my ( $self, $error ) = @_;
277
278	$error =~ s{at\s+(\S+)\s+line\s+(\d+)}
279	{at <a target="editor" href="/editor+$1+$2">$1</a> line $2}gsm;
280
281	$error =~ s{(via package ")([\w:]+)(")}
282	{$1<a target="editor" href="/editor+$2+1">$2</a>$3}gsm;
283
284	return $error;
285	}
286
287	sub error {
288	my $self = shift;
289	my $error = join(" ", @_);
290
291	my @backtrace = $self->backtrace;
292	$error .= "\n\t" . join( "\n\t", @backtrace ) if @backtrace;
293
294	warn "ERROR: $error\n";
295	return
296	qq\|<pre class="frey-error">\|
297	. $self->editor_links( $error ) .
298	qq\|</pre>\|
299	;
300	}
301
302	sub add_status {
303	my ( $self, $data ) = @_;
304	push @status, $data;
305	}
306
307	sub clean_status {
308	@status = ();
309	}
310
311	sub status_parts {
312	warn "## status parts ", dump( map { keys %$_ } @status );
313	}
314
315	sub DEMOLISH {
316	my ( $self ) = @_;
317	cluck "## DEMOLISH status ", $#status + 1, " elements ", dump( map { keys %$_ } @status ) if @status;
318	}
319
320	1;