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

  ViewVC Help
Powered by ViewVC 1.1.26