/[Frey]/branches/zimbardo/lib/Frey/Web.pm
This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!
ViewVC logotype

Contents of /branches/zimbardo/lib/Frey/Web.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 865 - (show annotations)
Tue Dec 16 21:09:32 2008 UTC (15 years, 4 months ago) by dpavlin
Original Path: trunk/lib/Frey/Web.pm
File size: 17261 byte(s)
cleanup inline warnings
1 package Frey::Web;
2 use Moose::Role;
3
4 with 'Frey::Session';
5
6 #use Continuity::Widget::DomNode;
7 use Data::Dump qw/dump/;
8 use Carp qw/confess cluck carp/;
9 use File::Slurp;
10 use Text::Tabs; # expand, unexpand
11
12 use lib 'lib';
13
14 use Frey::Types;
15
16 use Frey::Bookmarklet;
17 use Frey::Class::Browser;
18 use Frey::INC;
19
20 use Frey::SVK;
21
22 our @head;
23 sub head { @head }
24
25 has 'request_url' => (
26 is => 'rw',
27 isa => 'Uri', coerce => 1,
28 required => 1,
29 default => sub {
30 carp "undefined request_url";
31 '/';
32 },
33 );
34
35 has 'title' => (
36 is => 'rw',
37 isa => 'Str',
38 lazy => 1,
39 default => sub {
40 my ($self) = @_;
41 ref($self);
42 },
43 );
44
45 has 'content_type' => (
46 is => 'rw',
47 isa => 'Str',
48 default => 'text/html',
49 documentation => 'Content-type header',
50 );
51
52 has 'dump_max_bytes' => (
53 is => 'rw',
54 isa => 'Int',
55 default => 4096,
56 documentation => 'maximum dump size sent to browser before truncation',
57 );
58
59 has 'inline_smaller_than' => (
60 is => 'rw',
61 isa => 'Int',
62 default => 10240,
63 documentation => 'inline JavaScript and CSS to reduce round-trips',
64 );
65
66 has 'html_dump_width' => (
67 documentation => 'crop longer lines in dumps',
68 is => 'rw',
69 isa => 'Int',
70 # required => 1, # FIXME we can't have required fields with defaults because Frey::Action isn't smart enough and asks for them
71 default => 250,
72 );
73
74 my %escape = ('<'=>'&lt;', '>'=>'&gt;', '&'=>'&amp;', '"'=>'&quot;');
75 my $escape_re = join '|' => keys %escape;
76
77 sub html_escape {
78 my ( $self, $html ) = @_;
79 $html =~ s/($escape_re)/$escape{$1}/g;
80 return $html;
81 }
82
83 sub html_dump {
84 my ( $self, $dump ) = @_;
85 $dump = dump( $dump ) if ref($dump);
86 my $width = $self->html_dump_width;
87 $dump =~ s{(\n[^\n]{$width})([^\n]+?)([^\n]{5})}{\n$1...$3}gs;
88 $dump = $self->html_escape( $dump );
89 $dump =~ s{\Q...\E}{&hellip;}gs;
90 # $dump =~ $self->html_links( $dump ); # FIXME include this
91 return "<code>$dump</code>";
92 }
93
94 sub popup { my $self = shift; $self->popup_dropdown('popup', @_); }
95 sub dropdown { my $self = shift; $self->popup_dropdown('dropdown', @_); }
96
97 our $re_html = qr{<(?:!--|(\w+)|[^>]+)/?>}s; # relaxed html check for one semi-valid tag
98
99 sub popup_dropdown {
100 my ( $self, $type, $name, $content, $full ) = @_;
101
102 $content = $self->html_dump($content) if ref $content;
103
104 $content = qq|<span>$content</span>| unless $content =~ m{^\s*<(span|a|code).+?/\1>\s*};
105
106 $content =~ s{<span>(<code>[^<]+</code>)</span>}{$1} && $self->TODO("code wrapped in span");
107
108 warn "## $type [$name] = ", length( $content ), " bytes"; # if $self->debug; # FIXME
109
110 if ( $name =~ m{::} && $name !~ $re_html ) {
111 return qq|<a class="frey-$type" target="$name" href="/$name">$name $content</a>\n|;
112 } elsif ( $name =~ s{^\s*(<a)\s+}{$1 class="frey-$type"} ) {
113 return qq|$name $content\n|;
114 } else {
115 return qq|<span class="frey-$type">$name $content</span>\n|;
116 }
117 }
118
119 sub _inline {
120 my ( $self, $path ) = @_;
121 warn "# _inline $path";
122 -e $path && -s $path < $self->inline_smaller_than && -s $path;
123 }
124
125 sub _head_html {
126 my $self = shift;
127 my $out = '';
128 foreach my $path ( @head ) {
129 $path =~ s!^/!!;
130 if ( $path =~ m/\.js$/ ) {
131 my $size;
132 $out .= $size = _inline( $path ) ?
133 qq|<script type="text/javascript">\n/* inline $path $size bytes */\n\n| . read_file($path) . qq|\n</script>| :
134 qq|<script type="text/javascript" src="/$path"></script>|;
135 } elsif ( $path =~ m/\.css$/ ) {
136 my $size;
137 $out .= $size = _inline( $path ) ?
138 qq|<style type="text/css">\n/* inline $path $size bytes */\n\n| . read_file( $path ) . qq|\n</style>| :
139 qq|<link type="text/css" rel="stylesheet" href="/$path" media="screen">|;
140 } elsif ( $path =~ m{<.+>}s ) {
141 $out .= $path;
142 } else {
143 confess "don't know how to render $path";
144 }
145 $out .= "\n";
146 }
147 return $out;
148 }
149
150 =head2 add_head
151
152 $o->add_head( 'path/to/external.js' );
153
154 my $size = $o->add_head( 'path/to/external.css' );
155
156 $o->add_head( '<!-- html content -->' );
157
158 =cut
159
160 sub add_head {
161 my ( $self, $path ) = @_;
162 return if ! defined $path || $path eq '';
163 $path =~ s!^/!!;
164
165 if ( $path =~ $re_html ) {
166 push @head, $path;
167 } elsif ( -e $path ) {
168 if ( $path =~ m/\.(?:js|css)$/ ) {
169 push @head, $path;
170 } else {
171 confess "can't add_head( $path ) it's not js or css";
172 }
173 return -s $path;
174 } else {
175 confess "can't find $path: $!";
176 }
177
178 }
179
180 sub _add_css_js {
181 my ( $self, $what, $content ) = @_;
182
183 my $tag = $what eq 'css' ? 'style' : 'script';
184 my $type = $what eq 'css' ? 'text/css' : 'text/javascript';
185 my $head;
186
187 my ( $package, $path, $line ) = caller(1);
188
189 if ( $content =~ m{\.(js|css)} ) {
190 $content = "/$content" if -e $content;
191 if ( $content =~ $re_html ) {
192 $head = qq|
193 $content
194 <!-- $type via $package at $path line $line -->
195 |;
196 } elsif ( $what eq 'js' ) {
197 $head = qq|
198 <$tag type="$type" src="$content">
199 /* $what via $package at $path line $line */
200 </$tag>
201 |;
202 } else {
203 $head = qq|
204 <link rel="stylesheet" type="$type" href="$content">
205 <!-- $what via $package at $path line $line -->
206 |;
207 }
208 } else {
209 $head = qq|
210 <$tag type="$type">
211 /* via $package at $path line $line */
212 $content
213 </$tag>
214 |;
215 };
216 $self->add_head( $head );
217 }
218
219 sub add_css {
220 my ($self,$css) = @_;
221 $self->_add_css_js( 'css', $css );
222 }
223
224 sub add_js {
225 my ($self,$js) = @_;
226 $self->_add_css_js( 'js', $js );
227 }
228
229 our $reload_counter = 0;
230
231
232 =head2 page
233
234 $self->page(
235 title => 'page title',
236 head => '<!-- optional head markup -->',
237 body => '<b>Page Body</b>',
238 );
239
240 =cut
241
242 our @status;
243 sub status { @status };
244
245 our $icon_html;
246
247 sub page {
248 my $self = shift;
249 my $a = {@_};
250
251 warn "## page ",dump($a);
252
253 $reload_counter++;
254
255 my $status_line = '';
256
257 foreach my $part ( @status ) {
258 foreach my $name ( keys %$part ) {
259 $status_line .= $self->popup( $name, $part->{$name} );
260 }
261 }
262
263 my $url = $self->request_url;
264 $url =~ s{\?reload=\d+}{};
265
266 my $body = $a->{body};
267 if ( ! $body ) {
268 my $run = $a->{run} || 'as_markup';
269 warn "# no body, invoke $self->$run on ", ref($self);
270 $body = $self->$run;
271 }
272 if ( $self->content_type !~ m{html} ) {
273 warn "# return only $self body ", $self->content_type;
274 return $body
275 } elsif ( ! defined $body ) {
276 warn "# no body";
277 $body = '<!-- no body -->';
278 }
279
280 $status_line .= $self->warnings_html;
281
282 my ($exit,$description) = ('exit','stop server');
283 ($exit,$description) = ('restart','restart server')
284 if $ENV{FREY_RESTART}; # tune labels on exit link
285
286 my $right =
287 qq|
288 <span class="right">
289 <a title="reload $url" href="/reload$url">reload</a>
290 <a title="$description" href="/exit$url" target="exit">$exit</a>
291 </span>
292 |;
293
294 my $svk = Frey::SVK->new;
295 my $info = $svk->info;
296 my $revision = $svk->info->{Revision} || '';
297 $revision = $1 if $info->{'Mirrored From'} =~ m{Rev\.\s+(\d+)};
298
299 $self->add_icon unless $icon_html;
300
301 my $html = join("\n",
302 qq|<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"><html><head>|,
303 $self->_head_html,
304 '<title>' . ( $self->title || $a->{title} || ref($self) ) . '</title>',
305 '<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">',
306 ( $icon_html || '<!-- no icon -->' ),
307 ( $a->{head} || '' ),
308 qq|
309 </head><body>
310 $body
311 <div class="frey-status-line">
312 <a href="/">Frey</a> $Frey::VERSION $revision
313 $status_line
314 $right
315 </div>
316 </body></html>
317 |,
318 );
319
320 warn "## >>> page ",length($html), " bytes\n" if $self->debug;
321
322 return $html;
323 }
324
325 =head2 editor
326
327 Create HTML editor link with optional line and title
328
329 my $html = $self->editor( $class, $line, $title );
330
331 =cut
332
333 sub editor {
334 my ( $self, $class, $line, $title ) = @_;
335 confess "need class" unless $class;
336 if ( ! defined $title ) {
337 $title = "edit $class";
338 $title .= " line $line" if $line;
339 }
340 $line ||= 1;
341 qq|<a target="editor" href="/editor+$class+$line"| .
342 ( $title ? qq| title="$title"| : '' ) .
343 qq|>$class</a>|;
344 }
345
346 =head2 html_links
347
348 Create HTML links to editor for perl error message
349
350 my $html = $self->html_links( $error )
351
352 =cut
353
354 sub html_links {
355 my ( $self, $error ) = @_;
356
357 $error = $self->strip_full_path( $error );
358
359 # $error =~ s[(bless\({\s+.+?\s+},\s+)("[^"]+")(\) at)][<span class="frey-dropdown">$1<code>$2</code>$3</span>]gs; # FIXME insert bless hiding back
360
361 # perl's backtrace
362 $error =~ s{at\s+(\S+)\s+line\s+(\d+)}
363 {at <a target="editor" href="/editor+$1+$2" title="vi $1 +$2">$1</a> line $2}gsm;
364
365 $error =~ s{(via (?:package)\s+"?)([\w:]+)("?)}
366 {$1<a target="$2" href="/$2" title="introspect $2">$2</a>$3}gsm
367 || # or anything that looks like "Class::Name"
368 $error =~ s{"(\w+(?:::\w+)+)"}
369 {"<a target="$1" href="/$1" title="introspect $1">$1</a>"}gsm;
370
371 # method error messages
372 # FIXME replace with link to Frey::Introspect data
373 $error =~ s{(method ")(\w+)(" via)}
374 {$1<a target="$2" href="/Frey::Shell::Grep/as_markup?pattern=$2" title="grep $2">$2</a>$3}gsm;
375
376 # link paths to editor
377 $error =~ s{((?:lib|t)/[\S]+)\s+(\d+\s+bytes)}
378 {<a target="editor" href="/editor+$1+1" title="vi $1 [$2]">$1</a>}gsm;
379
380 $error =~ s{(class ")([\w:]+)(")}
381 {$1<a target="$2" href="/$2" title="introspect $2">$2</a>$3}gsm;
382
383 return $error;
384 }
385
386 sub html_self {
387 my $self = shift;
388 my $html = $self;
389 $html =~ s{([\w:]+)=}{<a target="$1" href="/$1" title="introspect $1">$1</a>=}gsm;
390 return $html;
391 }
392
393 =head2 error
394
395 This method will return error to browser and backtrace unless
396 error message ends with LF C<\n> just like L<warn>
397
398 =cut
399
400 sub error {
401 my $self = shift;
402 my $error = join(" ", @_);
403
404 my $fatal = '';
405 my $backtrace = '';
406
407 if ( $error !~ m{\n$} ) {
408 if ( my @backtrace = $self->backtrace ) {
409 $backtrace =
410 "\n" . $self->html_self . "->error backtrace\n\t"
411 . $self->html_links( join( "\n\t", @backtrace ) )
412 ;
413 $fatal = qq| frey-fatal|;
414 }
415 }
416
417 warn "ERROR: $error\n";
418 $self->add_icon('error');
419 $error = $self->html_links( $error );
420 return qq|<pre class="frey-error$fatal">$error $backtrace</pre>| ;
421 }
422
423 =head1 Status line
424
425 =head2 add_status
426
427 $self->add_status( { name => { some => 'data' } } );
428
429 $self->add_status( "append to last status popup" );
430
431 =cut
432
433 sub add_status {
434 my ( $self, $data ) = @_;
435 push @status, { 'X' => [ $self->backtrace ] };
436 if ( ref($data) ) {
437 push @status, $data;
438 } else {
439 if ( defined $status[ $#status ] ) {
440 $status[ $#status ]->{ '+' } = $data;
441 } else {
442 push @status, { '+' => $data };
443 }
444 }
445 }
446
447 =head2 clean_status
448
449 Called at beginning of each request
450
451 $self->clean_status;
452
453 =cut
454
455 sub clean_status {
456 my ($self) = shift;
457 @head = ( 'static/frey.css' );
458 @status = (
459 { 'ClassBrowser' => Frey::Class::Browser->new( usage_sort => 1, usage_on_top => 0 )->as_markup },
460 { 'Bookmarklets' => Frey::Bookmarklet->new->as_markup },
461 { 'INC' => Frey::INC->new->as_markup },
462 );
463 $icon_html = '';
464 }
465
466 =head2 status_parts
467
468 Dump all status line parts
469
470 $self->status_parts
471
472 =cut
473
474 sub status_parts {
475 warn "## status parts ", dump( map { keys %$_ } @status );
476 }
477
478 =for debug
479
480 sub DEMOLISH {
481 my ( $self ) = @_;
482 warn "## $self DEMOLISH status ", $#status + 1, " elements ", dump( map { keys %$_ } @status ) if @status;
483 }
484
485 =cut
486
487 =head2 add_icon
488
489 Frey::Foo->add_icon; # /static/icons/Frey/Foo.png
490 Frey::Foo->add_icon('warning'); # /static/icons/Frey/Foo/warning.png
491
492 =cut
493
494 sub icon_path {
495 my ($self,$class,$variant) = @_;
496
497 sub icon_exists {
498 my $class = shift;
499 $class =~ s{::}{/}g;
500 $class .= "/$variant" if $variant;
501 my $icon_path = 'static/icons/' . $class . '.png';
502 return $icon_path if -e $icon_path;
503 return;
504 }
505
506 my $path = icon_exists( $class );
507 if ( ! $path ) {
508 my $super_class = $class;
509 while ( $super_class =~ s{::[^:]+$}{} && ! $path ) {
510 $path = icon_exists( $super_class ) unless $super_class eq 'Frey'; # don't default on Frey icon
511 }
512 }
513
514 if ( ! $path ) {
515 $self->TODO( "add icon for $class" . ( $variant ? " variant $variant" : '' ) );
516 return undef;
517 }
518
519 warn "# $class from $self icon_path $path" if $self->debug;
520 return $path;
521 }
522
523 sub add_icon {
524 my ($self,$variant) = @_;
525
526 my $class = $self->class if $self->can('class');
527 #$class ||= $self->title;
528 $class ||= ref($self);
529 my $icon_path = $self->icon_path( $class, $variant ) || return;
530
531 $icon_html .= qq|<link rel="icon" type="image/png" href="/$icon_path">|;
532 warn "# using icon $icon_path";
533
534 =for later
535
536 # FIXME http://en.wikipedia.org/wiki/Favicon suggest just rel="icon" but that doesn't seem to work!
537 my $ico_path = $icon_path;
538 $ico_path =~ s{png$}{ico};
539 if ( ! -e $ico_path ) {
540 system "convert $icon_path $ico_path";
541 warn "# convert $icon_path $ico_path : $@";
542 }
543 $icon_html .= qq|<link rel="shortcut icon" type="image/x-icon" href="/$ico_path">| if -e $ico_path;
544
545 =cut
546
547 }
548
549 my $warn_colors = {
550 '#' => '#444',
551 '##' => '#888',
552 };
553
554 my $multiline_markers = {
555 '(' => ')',
556 '{' => '}',
557 '[' => ']',
558 '"' => '"',
559 };
560
561 =for later
562
563 my $multiline_re = '[\\' . join('\\', keys %$multiline_markers ) . ']';
564 warn "## multiline markers ", dump( $multiline_markers ), " -> $multiline_re";
565
566 =cut
567
568 sub log_path {
569 $Frey::Bootstrap::log_path || die "no log_path?";
570 }
571
572 our $pwd = `pwd`;
573 chomp $pwd;
574
575 sub strip_full_path {
576 my ($self, $msg) = @_;
577 # Mojo seems to expand warn messages to full path which is annoying
578 $msg =~ s{/[^/]+/\.\./}{/}gs;
579 $msg =~ s{$pwd/*}{}gs;
580 return $msg;
581 }
582
583 our $last_log_pos = 0;
584 our $last_log_line = 0;
585
586 sub warnings_html {
587 my ($self,$level) = shift;
588 $level ||= $self->debug,
589 my $path = $self->log_path;
590
591 my $max = 30;
592 my $pos = 0;
593 my @warnings = ( '' x $max ); # XXX circualar buffer for 50 lines
594 my $line = $last_log_line;
595 my $multiline_end;
596
597 # XXX do we really want to do this every time?
598 my $css = qq|/* short css classes for levels */\n|;
599 my $level_to_class;
600 foreach ( keys %$warn_colors ) {
601 my $l = length($_);
602 my $class = 'l' . $l;
603 $css .= qq|.$class { color: $warn_colors->{$_} }\n|;
604 $level_to_class->{ $_ } = $class;
605 }
606 $self->add_css( $css );
607
608 open(my $log, '<', $path) || die "can't open $path: $!";
609 seek($log, $last_log_pos, 0) || warn "can't seek: $!";
610 while(<$log>) {
611 chomp;
612 $line++;
613
614 next if m{^\s+(Mojo|Class::MOP|Moose)::};
615
616 my $style = '';
617
618 =for filter
619
620 if ( $multiline_end ) {
621 if ( m{^\Q$multiline_end\E} || m{^\s.+\Q$multiline_end\E;$} ) {
622 # warn "## $line end of $multiline_end in '$_'\n";
623 undef $multiline_end;
624 } else {
625 # warn "## $line skipped\n";
626 }
627 } elsif ( m{^(#*)\s+} ) {
628 my $l = $1 ? length($1) : 0;
629 if ( $l > $level ) {
630 undef $multiline_end;
631 $multiline_end = $multiline_markers->{$1} if m{($multiline_re)$};
632 # warn "## $line start $1 .. $multiline_end level $l > $level for '$_'\n" if $multiline_end;
633 next;
634 }
635
636 =cut
637 if ( m{^(#*)} ) {
638
639 my $level = $1;
640 my $msg = $self->strip_full_path( $_ );
641
642 my $spacer = ' ';
643 my $real_msg = expand( $msg );
644 if ( length($real_msg) > $self->html_dump_width ) {
645
646 $real_msg = substr( $msg, 0, $self->html_dump_width );
647 $msg = unexpand( $real_msg );
648 $spacer = '&hellip;'
649 }
650
651 $msg = $self->html_escape( $msg );
652
653 if ( my $class = $level_to_class->{ $level } ) {
654 $msg = qq|<span class="$class">$msg</span>|;
655 }
656
657 #$msg .= $spacer . qq|<a target="editor" href="/editor+$path+$line" style="float: right;">$line</a>\n|;
658 $msg = qq|<a target="editor" href="/editor+$path+$line" style="float: right;">$line</a>$msg|
659 . ( $spacer ? $spacer : '' )
660 . "\n"; # XXX <pre> needs this
661
662 $warnings[ $pos++ % $max ] = $msg;
663 }
664 }
665 $last_log_pos = tell($log);
666 $last_log_line = $line;
667 warn "log has $line lines tell position $last_log_pos";
668 close($log) || die "can't close $path: $!";
669
670 my $size = -s $path;
671
672 my $warnings = join("",
673 map { $warnings[ ( $pos + $_ ) % $max ] || '' } 0 .. ( $max - 1 )
674 );
675
676 my $s = length($warnings);
677
678 return
679 # need to wrap editor link into span so we can have links in warnings
680 qq|<span class="frey-popup"><a target="editor" href="/editor+$path+$line" title="$path \| $size -> $s bytes \| $line -> $pos lines \| level $level">warn</a><code>|
681 . $self->html_links( $warnings )
682 . qq|</code></span>|
683 ;
684 }
685
686
687 =head2 backtrace
688
689 Show backtrace with links to editor
690
691 my @backtrace = $self->backtrace;
692
693 =cut
694
695 sub backtrace {
696 my ($self) = @_;
697
698 my @backtrace;
699 foreach ( 1 .. 5 ) { # 0 = backtrace
700 my (
701 $package,$path,$line
702 # subroutine hasargs
703 # wantarray evaltext is_require
704 # hints bitmask hinthash
705 ) = caller($_) or last;
706
707 push @backtrace,
708 qq|via "$package" at $path line $line|;
709 }
710 #warn "# backtrace: ", dump( @backtrace ) if @backtrace;
711 return @backtrace;
712 }
713
714 =head2 checkbox
715
716 Generate checkbox html markup from some attribute
717
718 my $html = $self->checkbox('attribute_name', $value);
719
720 =cut
721
722 sub checkbox {
723 my ($self,$name,$value) = @_;
724 my $checked = '';
725 my $all_checkboxes = eval { $self->$name };
726 warn "ERROR tried to get checkbox value for '$name' which is unknown: $@" if $@;
727 $all_checkboxes = [ $all_checkboxes ] unless ref($all_checkboxes) eq 'ARRAY'; # sigh, too chatty
728 $checked = ' checked' if grep { defined $_ && $_ eq $value } @$all_checkboxes;
729 warn "# checkbox $name $value $checked\t", $self->dump( $self->$name );
730 qq|<input name="$name" value="$value" type="checkbox"$checked>|;
731 }
732
733 =head2 strip
734
735 Strip whitespace around content
736
737 my $stripped = strip(' no more whitespace around this ');
738
739 =cut
740
741 sub strip {
742 my $t = shift;
743 $t =~ s{^\s+}{}gs;
744 $t =~ s{>\s+<}{><}gs;
745 $t =~ s{\s+$}{}gs;
746 return $t;
747 }
748
749 1;

  ViewVC Help
Powered by ViewVC 1.1.26