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

  ViewVC Help
Powered by ViewVC 1.1.26