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

  ViewVC Help
Powered by ViewVC 1.1.26