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

Legend:
Removed from v.142  
changed lines
  Added in v.588

  ViewVC Help
Powered by ViewVC 1.1.26