/[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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 106 by dpavlin, Sun Jul 13 12:22:14 2008 UTC revision 674 by dpavlin, Tue Dec 2 01:49:49 2008 UTC
# Line 1  Line 1 
1  package Frey::Web;  package Frey::Web;
2  use Moose::Role;  use Moose::Role;
3    
4  use Continuity::Widget::DomNode;  with 'Frey::Session';
5    
6    use Frey::Types;
7    
8    #use Continuity::Widget::DomNode;
9  use Data::Dump qw/dump/;  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->editor_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 dom2html {  sub add_css {
177  #       warn "## dom2html ",dump( @_ );          my ($self,$css) = @_;
178          return Continuity::Widget::DomNode->create( @_ )->to_string;          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 @javascript = ( qw'  our $reload_counter = 0;
 ../lib/Joose.js  
 ');  
188    
189  sub head_javascript {  
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;          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 editor_links
308    
309    Create HTML links to editor for perl error message
310    
311      my $html = $self->editor_links( $error )
312    
313    =cut
314    
315    sub editor_links {
316            my ( $self, $error ) = @_;
317    
318    #       $error =~ s[(bless\({\s+.+?\s+},\s+)("[^"]+")(\) at)][<span class="frey-dropdown">$1<code>$2</code>$3</span>]gs; # FIXME insert bless hiding back
319    
320            # perl's backtrace
321            $error =~ s{at\s+(\S+)\s+line\s+(\d+)}
322                    {at <a target="editor" href="/editor+$1+$2">$1</a> line $2}gsm;
323    
324            $error =~ s{(via (?:package)\s+"?)([\w:]+)("?)}
325                    {$1<a target="$2" href="/$2">$2</a>$3}gsm;
326    
327            # method error messages
328    #       $error =~ s{(method ")(\w+)"}
329    #               {$1<a target="/Frey::Shell::Grep?pattern=$2">$2</a>"}gsm; # FIXME replace with link to Frey::Introspect data
330    
331            # anything that looks like "Class::Name"
332            $error =~ s{"(\w+(?:::\w+)+)"}
333                    {"<a target="$1" href="/$1">$1</a>"}gsm;
334    
335            return $error;
336    }
337    
338    =head2 error
339    
340    This method will return error to browser and backtrace unless
341    error message ends with LF C<\n> just like L<warn>
342    
343    =cut
344    
345    sub error {
346            my $self = shift;
347            my $error = join(" ", @_);
348    
349            my $fatal = '';
350    
351            if ( $error !~ m{\n$} ) {
352                    if ( my @backtrace = $self->backtrace ) {
353                            $error .= "\n\t" . join( "\n\t", @backtrace );
354                            $fatal = qq| class="fatal"|;
355                    }
356            }
357    
358            warn "ERROR: $error\n";
359            return
360                    qq|<pre class="frey-error$fatal">|
361                    . $self->editor_links( $error ) .
362                    qq|</pre>|
363                    ;
364    }
365    
366    =head1 Status line
367    
368    =head2 add_status
369    
370      $self->add_status( { name => { some => 'data' } } );
371    
372      $self->add_status( "append to last status popup" );
373    
374    =cut
375    
376    sub add_status {
377            my ( $self, $data ) = @_;
378            push @status, { 'X' => [ $self->backtrace ] };
379            if ( ref($data) ) {
380                    push @status, $data;
381            } else {
382                    if ( defined $status[ $#status ] ) {
383                            $status[ $#status ]->{ '+' } = $data;
384                    } else {
385                            push @status, { '+' => $data };
386                    }
387            }
388    }
389    
390    =head2 clean_status
391    
392    Called at beginning of each request
393    
394      $self->clean_status;
395    
396    =cut
397    
398    sub clean_status {
399            my ($self) = shift;
400            @head = ( 'static/frey.css' );
401            @status = (
402                    { 'ClassBrowser' => Frey::ClassBrowser->new( usage_on_top => 0 )->as_markup },
403                    { 'Bookmarklets' => Frey::Bookmarklet->new->as_markup },
404                    { 'INC' => Frey::INC->new->as_markup },
405            );
406            $icon_html = '';
407    }
408    
409    =head2 status_parts
410    
411    Dump all status line parts
412    
413      $self->status_parts
414    
415    =cut
416    
417    sub status_parts {
418            warn "## status parts ", dump( map { keys %$_ } @status );
419    }
420    
421    =for debug
422    
423    sub DEMOLISH {
424            my ( $self ) = @_;
425            warn "## $self DEMOLISH status ", $#status + 1, " elements ", dump( map { keys %$_ } @status ) if @status;
426    }
427    
428    =cut
429    
430    =head2 add_icon
431    
432      Frey::Foo->add_icon;            # /static/icons/Frey/Foo.png
433      Frey::Foo->add_icon('warning'); # /static/icons/Frey/Foo/warning.png
434    
435    =cut
436    
437    sub icon_path {
438            my ($self,$class,$variant) = @_;
439            my $icon = $class;
440            $icon =~ s{::}{/}g;
441            $icon .= "/$variant" if $variant;
442            my $path = 'static/icons/' . $icon . '.png';
443            if ( -e $path ) {
444                    warn "# $class from $self icon_path $path" if $self->debug;
445                    return $path;
446            } else {
447                    $self->TODO( "add $path icon for $class" );
448                    return undef;
449            }
450    }
451    
452    sub add_icon {
453            my ($self,$variant) = @_;
454    
455            my $class = ref($self);
456            $class = $self->class if $self->can('class');
457            my $icon_path = $self->icon_path( $class, $variant ) || return;
458    
459            $icon_html .= qq|<link rel="icon" type="image/png" href="/$icon_path">|;
460            warn "# using icon $icon_path";
461    
462    =for later
463    
464            # FIXME http://en.wikipedia.org/wiki/Favicon suggest just rel="icon" but that doesn't seem to work!
465            my $ico_path = $icon_path;
466            $ico_path =~ s{png$}{ico};
467            if ( ! -e $ico_path ) {
468                    system "convert $icon_path $ico_path";
469                    warn "# convert $icon_path $ico_path : $@";
470            }
471            $icon_html .= qq|<link rel="shortcut icon" type="image/x-icon" href="/$ico_path">| if -e $ico_path;
472    
473    =cut
474    
475    }
476    
477    my $warn_colors = {
478            '#'  => '#444',
479            '##' => '#888',
480    };
481    
482    my $multiline_markers = {
483            '(' => ')',
484            '{' => '}',
485            '[' => ']',
486            '"' => '"',
487    };
488    
489    =for later
490    
491    my $multiline_re = '[\\' . join('\\', keys %$multiline_markers ) . ']';
492    warn "## multiline markers ", dump( $multiline_markers ), " -> $multiline_re";
493    
494    =cut
495    
496    sub log_path {
497            $Frey::Bootstrap::log_path || die "no log_path?";
498    }
499    
500    our $last_log_pos  = 0;
501    our $last_log_line = 0;
502    
503    our $pwd = `pwd`;
504    chomp $pwd;
505    
506    sub warnings_html {
507            my ($self,$level) = shift;
508            $level ||= $self->debug,
509            my $path = $self->log_path;
510    
511            my $max = 30;
512            my $pos = 0;
513            my @warnings = ( '' x $max ); # XXX circualar buffer for 50 lines
514            my $line = $last_log_line;
515            my $multiline_end;
516    
517            # XXX do we really want to do this every time?
518            my $css = qq|/* short css classes for levels */\n|;
519            my $level_to_class;
520            foreach ( keys %$warn_colors ) {
521                    my $l = length($_);
522                    my $class = 'l' . $l;
523                    $css .= qq|.$class { color: $warn_colors->{$_} }\n|;
524                    $level_to_class->{ $_ } = $class;
525            }
526            $self->add_css( $css );
527    
528            open(my $log, '<', $path)    || die "can't open $path: $!";
529            seek($log, $last_log_pos, 0) || warn "can't seek: $!";
530            while(<$log>) {
531                    chomp;
532                    $line++;
533    
534                    next if m{^\s+(Mojo|Class::MOP|Moose)::};
535    
536                    my $style = '';
537    
538    =for filter
539    
540                    if ( $multiline_end ) {
541                            if ( m{^\Q$multiline_end\E} || m{^\s.+\Q$multiline_end\E;$} ) {
542    #                               warn "## $line end of $multiline_end in '$_'\n";
543                                    undef $multiline_end;
544                            } else {
545    #                               warn "## $line skipped\n";
546                            }
547                    } elsif ( m{^(#*)\s+} ) {
548                            my $l = $1 ? length($1) : 0;
549                            if ( $l > $level ) {
550                                    undef $multiline_end;
551                                    $multiline_end = $multiline_markers->{$1} if m{($multiline_re)$};
552    #                               warn "## $line start $1 .. $multiline_end level $l > $level for '$_'\n" if $multiline_end;
553                                    next;
554                            }
555    
556    =cut
557                    if ( m{^(#*)} ) {
558    
559                            my $level = $1;
560                            my $msg = $_;
561    
562                            # Mojo seems to expand warn messages to full path which is annoying
563                            $msg =~ s{/[^/]+/\.\./}{/}gs;
564                            $msg =~ s{$pwd/*}{}gs;
565    
566                            my $spacer = ' ';
567                            my $real_msg = expand( $msg );
568                            if ( length($real_msg) > $self->html_dump_width ) {
569                                    
570                                    $real_msg = substr( $msg, 0, $self->html_dump_width );
571                                    $msg = unexpand( $real_msg );
572                                    $spacer = '&hellip;'
573                            }
574    
575                            $msg = $self->html_escape( $msg );
576    
577                            if ( my $class = $level_to_class->{ $level } ) {
578                                    $msg = qq|<span class="$class">$msg</span>|;
579                            }
580    
581                            #$msg .= $spacer . qq|<a target="editor" href="/editor+$path+$line" style="float: right;">$line</a>\n|;
582                            $msg = qq|<a target="editor" href="/editor+$path+$line" style="float: right;">$line</a>$msg|
583                                    . ( $spacer ? $spacer : '' )
584                                    . "\n"; # XXX <pre> needs this
585    
586                            $warnings[ $pos++ % $max ] = $msg;
587                    }
588            }
589            $last_log_pos = tell($log);
590            $last_log_line = $line;
591            warn "log has $line lines tell position $last_log_pos";
592            close($log) || die "can't close $path: $!";
593    
594            my $size = -s $path;
595    
596            my $warnings = join("",
597                    map { $warnings[ ( $pos + $_ ) % $max ] || '' } 0 .. ( $max - 1 )
598            );
599    
600            my $s = length($warnings);
601    
602            return
603                    # need to wrap editor link into span so we can have links in warnings
604                      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>|
605                    . $self->editor_links( $warnings )
606                    . qq|</code></span>|
607                    ;
608    }
609    
610    
611    =head2 backtrace
612    
613    Show backtrace with links to editor
614    
615      my @backtrace = $self->backtrace;
616    
617    =cut
618    
619          my $js = Continuity::Widget::DomNode->create(  sub backtrace {
620                  map {          my ($self) = @_;
                         ( script => { type => 'text/javascript', src => $_ } )  
                 } @javascript  
         )->to_string;  
621    
622          warn "# >>> js\n$js\n" if $self->debug;          my @backtrace;
623            foreach ( 0 .. 5 ) {
624                    my (
625                            $package,$path,$line
626                            # subroutine hasargs
627                            # wantarray evaltext is_require
628                            # hints bitmask hinthash
629                    ) = caller($_) or last;
630    
631          return $js;                  push @backtrace,
632                            qq|via "$package" at $path line $line|;
633            }
634            #warn "# backtrace: ", dump( @backtrace ) if @backtrace;
635            return @backtrace;
636  }  }
637    
638  1;  1;

Legend:
Removed from v.106  
changed lines
  Added in v.674

  ViewVC Help
Powered by ViewVC 1.1.26