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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 577 - (hide annotations)
Fri Nov 28 00:30:03 2008 UTC (15 years, 4 months ago) by dpavlin
Original Path: trunk/lib/Frey/Web.pm
File size: 11639 byte(s)
first try at refactoring

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

  ViewVC Help
Powered by ViewVC 1.1.26