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

Legend:
Removed from v.100  
changed lines
  Added in v.564

  ViewVC Help
Powered by ViewVC 1.1.26