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

  ViewVC Help
Powered by ViewVC 1.1.26