/[suikacvs]/test/html-webhacc/WebHACC/Result.pm
Suika

Diff of /test/html-webhacc/WebHACC/Result.pm

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

revision 1.1 by wakaba, Sun Jul 20 14:58:24 2008 UTC revision 1.20 by wakaba, Sun Sep 14 06:33:27 2008 UTC
# Line 2  package WebHACC::Result; Line 2  package WebHACC::Result;
2  use strict;  use strict;
3    
4  sub new ($) {  sub new ($) {
5    return bless {}, shift;    return bless {
6        global_status => 'conforming',
7            # or, 'should-error', 'non-conforming', 'uncertain'
8        subdoc_results => [],
9      }, shift;
10  } # new  } # new
11    
12    sub output ($;$) {
13      if (@_ > 1) {
14        if (defined $_[1]) {
15          $_[0]->{output} = $_[1];
16        } else {
17          delete $_[0]->{output};
18        }
19      }
20    
21      return $_[0]->{output};
22    } # output
23    
24    sub parent_result ($;$) {
25      if (@_ > 1) {
26        if (defined $_[1]) {
27          $_[0]->{parent_result} = $_[1];
28        } else {
29          delete $_[0]->{parent_result};
30        }
31      }
32    
33  sub get_error_label ($$) {    return $_[0]->{parent_result};
34    } # parent_result
35    
36    sub layer_applicable ($$) {
37      my $self = shift;
38      my $layer = shift;
39      $self->{layers}->{$layer}->{applicable} = 1;
40    } # layer_applicable
41    
42    sub layer_uncertain ($$) {
43    my $self = shift;    my $self = shift;
44    my ($input, $err) = @_;    my $layer = shift;
45      $self->{layers}->{$layer}->{uncertain} ||= 1;
46      $self->{layers}->{$layer}->{applicable} = 1;
47      $self->{global_status} = 'uncertain'
48          unless $self->{global_status} eq 'non-conforming';
49    } # layer_uncertain
50    
51    sub add_error ($%) {
52      my ($self, %opt) = @_;
53    
54      my $out = $self->output;
55      $out->has_error (1);
56    
57      my $error_level = $opt{level};
58      if (not defined $error_level) {
59        $error_level = 'm'; ## NOTE: Unknown - an error of the implementation
60      } elsif ({
61        m => 1, s => 1, w => 1, i => 1, u => 1,
62      }->{$error_level}) {
63        #
64      } else {
65        $error_level = 'm'; ## NOTE: Unknown - an error of the implementation
66      }
67    
68    my $r = '';    my $error_layer = $opt{layer};
69      if (not defined $error_layer) {
70        $error_layer = 'syntax'; ## NOTE: Unknown - an error of the implementation
71      } elsif ({
72        transfer => 1,
73        encode => 1,
74        charset => 1,
75        syntax => 1,
76        structure => 1,
77        semantics => 1,
78      }->{$error_layer}) {
79        #
80      } else {
81        $error_layer = 'syntax'; ## NOTE: Unknown - an error of the implementation
82      }
83    
84      my $class = qq[level-$error_level layer-$error_layer];
85    
86      ## Line & column numbers (prepare values)
87    
88    my $line;    my $line;
89    my $column;    my $column;
90            
91    if (defined $err->{node}) {    if (defined $opt{node}) {
92      $line = $err->{node}->get_user_data ('manakai_source_line');      $line = $opt{node}->get_user_data ('manakai_source_line');
93      if (defined $line) {      if (defined $line) {
94        $column = $err->{node}->get_user_data ('manakai_source_column');        $column = $opt{node}->get_user_data ('manakai_source_column');
95      } else {      } elsif ($opt{node}->isa ('Message::IF::Node')) {
96        if ($err->{node}->node_type == $err->{node}->ATTRIBUTE_NODE) {        if ($opt{node}->node_type == $opt{node}->ATTRIBUTE_NODE) {
97          my $owner = $err->{node}->owner_element;          my $owner = $opt{node}->owner_element;
98          $line = $owner->get_user_data ('manakai_source_line');          if ($owner) {
99          $column = $owner->get_user_data ('manakai_source_column');            $line = $owner->get_user_data ('manakai_source_line');
100              $column = $owner->get_user_data ('manakai_source_column');
101            }
102        } else {        } else {
103          my $parent = $err->{node}->parent_node;          my $parent = $opt{node}->parent_node;
104          if ($parent) {          if ($parent) {
105            $line = $parent->get_user_data ('manakai_source_line');            $line = $parent->get_user_data ('manakai_source_line');
106            $column = $parent->get_user_data ('manakai_source_column');            $column = $parent->get_user_data ('manakai_source_column');
# Line 34  sub get_error_label ($$) { Line 109  sub get_error_label ($$) {
109      }      }
110    }    }
111    unless (defined $line) {    unless (defined $line) {
112      if (defined $err->{token} and defined $err->{token}->{line}) {      if (defined $opt{token} and defined $opt{token}->{line}) {
113        $line = $err->{token}->{line};        $line = $opt{token}->{line};
114        $column = $err->{token}->{column};        $column = $opt{token}->{column};
115      } elsif (defined $err->{line}) {      } elsif (defined $opt{line}) {
116        $line = $err->{line};        $line = $opt{line};
117        $column = $err->{column};        $column = $opt{column};
118      }      }
119    }    }
120      $line += $opt{line_diff} || 0 if defined $line;
121      $column += $opt{column_diff} || 0 if defined $column;
122      $line = $line - 1 || 1
123          if defined $line and not (defined $column and $column > 0);
124    
125      $out->start_tag ('dt', class => $class,
126                       'data-type' => $opt{type},
127                       'data-level' => $error_level,
128                       'data-layer' => $error_layer,
129                       ($line ? ('data-line' => $line) : ()),
130                       ($column ? ('data-column' => $column) : ()));
131      my $has_location;
132    
133      ## URL
134      
135      if (defined $opt{url}) {
136        $out->url ($opt{url});
137        $has_location = 1;
138      }
139    
140      ## Line & column numbers (real output)
141    
142    if (defined $line) {    if (defined $line) {
143      if (defined $column and $column > 0) {      if (defined $column and $column > 0) {
144        $r = qq[<a href="#$input->{id_prefix}line-$line">Line $line</a> column $column];        $out->xref ('Line #', text => $line, target => 'line-' . $line);
145          $out->text (' ');
146          $out->nl_text ('column #', text => $column);
147      } else {      } else {
148        $line = $line - 1 || 1;        $out->xref ('Line #', text => $line, target => 'line-' . $line);
       $r = qq[<a href="#$input->{id_prefix}line-$line">Line $line</a>];  
149      }      }
150        $has_location = 1;
151    }    }
152    
153    if (defined $err->{node}) {    ## Node path
154      $r .= ' ' if length $r;  
155      $r .= $self->get_node_link ($input, $err->{node});    if (defined $opt{node}) {
156        $out->html (' ');
157        $out->node_link ($opt{node});
158        $has_location = 1;
159    }    }
160    
161    if (defined $err->{index}) {    if (defined $opt{index}) {
162      if (length $r) {      if ($opt{index_has_link}) {
163        $r .= ', Index ' . (0+$err->{index});        $out->html (' ');
164          $out->xref ('Index #', text => (0+$opt{index}),
165                      target => 'index-' . (0+$opt{index}));
166      } else {      } else {
167        $r .= "<a href='#$input->{id_prefix}index-@{[0+$err->{index}]}'>Index "        $out->html (' ');
168            . (0+$err->{index}) . '</a>';        $out->nl_text ('Index #', text => (0+$opt{index}));
169      }      }
170        $has_location = 1;
171    }    }
172    
173    if (defined $err->{value}) {    if (defined $opt{value}) {
174      $r .= ' ' if length $r; ## BUG: v must be escaped      $out->html (' ');
175      $r .= '<q><code>' . ($err->{value}) . '</code></q>';      if (defined $opt{pos_start}) {
176          $out->start_tag ('code');
177          $out->text (substr $opt{value}, 0, $opt{pos_start});
178          $out->start_tag ('mark');
179          $out->text (substr $opt{value}, $opt{pos_start},
180                          $opt{pos_end} - $opt{pos_start} + 1);
181          $out->end_tag ('mark');
182          $out->text (substr $opt{value}, $opt{pos_end} + 1)
183              if $opt{pos_end} < length $opt{value};
184          $out->end_tag ('code');
185        } elsif ($opt{value_mark_end}) {
186          $out->start_tag ('code');
187          $out->text ($opt{value});
188          $out->start_tag ('mark');
189          $out->end_tag ('mark');
190          $out->end_tag ('code');
191        } elsif (defined $opt{value_mark}) {
192          $out->start_tag ('code');
193          for (split /($opt{value_mark})/, $opt{value}) {
194            if (/$opt{value_mark}/) {
195              $out->start_tag ('mark');
196              $out->text ($_);
197              $out->end_tag ('mark');
198            } else {
199              $out->text ($_);
200            }
201          }
202          $out->end_tag ('code');
203        } else {
204          $out->code ($opt{value});
205        }
206        $has_location = 1;
207      }
208    
209      unless ($has_location) {
210        if (defined $opt{input}) {
211          if (defined $opt{input}->{container_node}) {
212            my $original_input = $out->input;
213            $out->input ($opt{input}->{parent_input});
214            $out->node_link ($opt{input}->{container_node});
215            $out->input ($original_input);
216            $has_location = 1;
217          } elsif (defined $opt{input}->{request_uri}) {
218            $out->url ($opt{input}->{request_uri});
219            $has_location = 1;
220          } elsif (defined $opt{input}->url) {
221            $out->url ($opt{input}->url);
222            $has_location = 1;
223          }
224        }
225        
226        unless ($has_location) {
227          $out->nl_text ('Unknown location');
228        }
229    }    }
230    
231      $out->start_tag ('dd', class => $class);
232    
233    return $r;    ## Error level
234  } # get_error_label    $out->nl_text ('Error level ' . $error_level);
235      $out->text (': ');
236      
237      ## Error message
238      my $error_type_text = $opt{type};
239      $out->nl_text ($error_type_text, node => $opt{node}, text => $opt{text},
240                     value => $opt{value}, char => $opt{char},
241                     octets => $opt{octets});
242      
243      ## Link to a long description
244    
245      my $fragment = $opt{type};
246      $fragment =~ tr/ /-/;
247      $fragment = $out->encode_url_component ($fragment);
248      $out->text (' [');
249      $out->start_tag ('a', href => '../error-description#' . $fragment,
250                       rel => 'help');
251      $out->nl_text ('Description');
252      $out->end_tag ('a');
253      $out->text (']');
254    
255      if ($error_level eq 'm') {
256        $self->{layers}->{$error_layer}->{must}++;
257        $self->{global_status} = 'non-conforming';
258      } elsif ($error_level eq 's') {
259        $self->{layers}->{$error_layer}->{should}++;
260        $self->{global_status} = 'should-error'
261            unless {'non-conforming' => 1,
262                    uncertain => 1}->{$self->{global_status}};
263      } elsif ($error_level eq 'w') {
264        $self->{layers}->{$error_layer}->{warning}++;
265      } elsif ($error_level eq 'u') {
266        $self->{layers}->{$error_layer}->{uncertain}++;
267        $self->{global_status} = 'uncertain'
268            unless $self->{global_status} eq 'non-conforming';
269      } elsif ($error_level eq 'i') {
270        $self->{layers}->{$error_layer}->{info}++;
271      }
272    } # add_error
273    
274  sub get_error_level_label ($) {  sub generate_result_section ($) {
275    my $self = shift;    my $self = shift;
   my $err = shift;  
276    
277    my $r = '';    my $result = $self;
278    
279      my $out = $result->output;
280    
281    if (not defined $err->{level} or $err->{level} eq 'm') {    $out->start_section (role => 'result');
282      $r = qq[<strong><a href="../error-description#level-m"><em class=rfc2119>MUST</em>-level  
283          error</a></strong>: ];    my $para_class = {
284    } elsif ($err->{level} eq 's') {      'conforming' => 'result-para no-error',
285      $r = qq[<strong><a href="../error-description#level-s"><em class=rfc2119>SHOULD</em>-level      'should-error' => 'result-para should-errors',
286          error</a></strong>: ];      'non-conforming' => 'result-para must-errors',
287    } elsif ($err->{level} eq 'w') {      'uncertain' => 'result-para uncertain',
288      $r = qq[<strong><a href="../error-description#level-w">Warning</a></strong>:    }->{$self->{global_status}};
289          ];    $out->start_tag ('p', class => $para_class);
290    } elsif ($err->{level} eq 'u' or $err->{level} eq 'unsupported') {    $out->nl_text ('Conformance is ' . $self->{global_status});
291      $r = qq[<strong><a href="../error-description#level-u">Not    $out->end_tag ('p');
292          supported</a></strong>: ];  
293    } elsif ($err->{level} eq 'i') {    $out->html (qq[<table>
294      $r = qq[<strong><a href="../error-description#level-i">Information</a></strong>: ];  <colgroup><col><col><colgroup><col><col><col><col><colgroup><col>
295    <thead>
296    <tr><th scope=col colspan=2>]);
297      for ('Error level m', 'Error level s', 'Error level w',
298           'Error level i', 'Score') {
299        $out->start_tag ('th');
300        $out->nl_text ($_);
301      }
302    
303      my $maindoc_status = {must => 0, should => 0, warning => 0, info => 0,
304                            uncertain => 0, applicable => 1};
305      my $subdocs_status = {must => 0, should => 0, warning => 0, info => 0,
306                            uncertain => 0, applicable => 1};
307      my $global_status = {must => 0, should => 0, warning => 0, info => 0,
308                           uncertain => 0, applicable => 1};
309    
310      my $score_unit = 2;
311    
312      my @row = (
313        sub {
314          $out->start_tag ('tbody');
315          $out->start_tag ('tr');
316          $out->start_tag ('th', colspan => 7, scope => 'col');
317          $out->nl_text ('Main document');
318        },
319          {label => 'Transfer L.', status => $self->{layers}->{transfer},
320           target => 'transfer-errors', score_base => 20,
321           parent_status => $maindoc_status},
322          {label => 'Encode L.', status => $self->{layers}->{encode},
323           target => 'parse-errors', score_base => 10,
324           parent_status => $maindoc_status},
325          {label => 'Char L.', status => $self->{layers}->{charset},
326           target => 'parse-errors', score_base => 10,
327           parent_status => $maindoc_status},
328          ## TODO: char semantics layer
329          {label => 'Syntax L.', status => $self->{layers}->{syntax},
330           target => 'parse-errors', score_base => 20,
331           parent_status => $maindoc_status},
332          {label => 'Structure L.', status => $self->{layers}->{structure},
333           target => 'document-errors', score_base => 20,
334           parent_status => $maindoc_status},
335          {label => 'Semantics L.', status => $self->{layers}->{semantics},
336           score_base => 20,
337           parent_status => $maindoc_status},
338      );
339    
340      if (@{$self->{subdoc_results}}) {
341        push @row, {label => 'Subtotal', status => $maindoc_status,
342                    score_base => 100,
343                    parent_status => $global_status, is_total => 1};
344        push @row, sub {
345          $out->start_tag ('tbody');
346          $out->start_tag ('tr');
347          $out->start_tag ('th', colspan => 7, scope => 'col');
348          $out->nl_text ('Subdocuments');
349        };
350        for (@{$self->{subdoc_results}}) {
351          push @row, {label => '#' . $_->{input}->full_subdocument_index,
352                      status => $_,
353                      target => $_->{input}->id_prefix . 'result-summary',
354                      score_base => 100, parent_status => $subdocs_status};
355        }
356        push @row, {label => 'Subtotal', status => $subdocs_status,
357                    score_base => 100 * @{$self->{subdoc_results}},
358                    parent_status => $global_status, is_total => 1};
359    } else {    } else {
360      my $elevel = htescape ($err->{level});      $global_status = $maindoc_status;
     $r = qq[<strong><a href="../error-description#level-$elevel">$elevel</a></strong>:  
         ];  
361    }    }
362    
363    return $r;    push @row, sub {
364  } # get_error_level_label      $out->start_tag ('tfoot');
365      };
366      push @row, {label => 'Total', status => $global_status,
367                  score_base => 100 * (@{$self->{subdoc_results}} + 1),
368                  parent_status => {}, is_total => 1};
369    
370      for my $x (@row) {
371        if (ref $x eq 'CODE') {
372          $x->();
373          next;
374        }
375    
376  sub get_node_path ($) {      $x->{parent_status}->{$_} += $x->{status}->{$_}
377    my $self = shift;          for qw/must should warning info uncertain/;
378    my $node = shift;  
379    my @r;      my $row_class = $x->{status}->{uncertain} ? 'uncertain' : '';
380    while (defined $node) {      $row_class .= ' total' if $x->{is_total};
381      my $rs;      $out->start_tag ('tr', class => $row_class);
382      if ($node->node_type == 1) {      my $uncertain = $x->{status}->{uncertain} ? '?' : '';
383        $rs = $node->node_name;  
384        $node = $node->parent_node;      $out->start_tag ('td', class => 'subrow') unless $x->{is_total};
385      } elsif ($node->node_type == 2) {  
386        $rs = '@' . $node->node_name;      ## Layer name
387        $node = $node->owner_element;      $out->start_tag ('th', colspan => $x->{is_total} ? 2 : 1,
388      } elsif ($node->node_type == 3) {                       scope => 'row');
389        $rs = '"' . $node->data . '"';      if (defined $x->{target} and
390        $node = $node->parent_node;          ($x->{status}->{must} or $x->{status}->{should} or
391      } elsif ($node->node_type == 9) {           $x->{status}->{warning} or $x->{status}->{info} or
392        @r = ('') unless @r;           $x->{status}->{uncertain})) {
393        $rs = '';        $out->xref ($x->{label}, target => $x->{target});
394        $node = $node->parent_node;      } else {
395      } else {        $out->nl_text ($x->{label});
       $rs = '#' . $node->node_type;  
       $node = $node->parent_node;  
396      }      }
397      unshift @r, $rs;  
398        ## MUST-level errors
399        $out->start_tag ('td', class => $x->{status}->{must} ? 'must-errors' : '');
400        if ($x->{status}->{applicable}) {
401          $out->text (($x->{status}->{must} or 0) . $uncertain);
402        } else {
403          $out->nl_text ('N/A');
404        }
405    
406        ## SHOULD-level errors
407        $out->start_tag ('td',
408                         class => $x->{status}->{should} ? 'should-errors' : '');
409        if ($x->{status}->{applicable}) {
410          $out->text (($x->{status}->{should} or 0) . $uncertain);
411        } else {
412          $out->nl_text ('N/A');
413        }
414    
415        ## Warnings
416        $out->start_tag ('td', class => $x->{status}->{warning} ? 'warnings' : '');
417        if ($x->{status}->{applicable}) {
418          $out->text (($x->{status}->{warning} or 0) . $uncertain);
419        } else {
420          $out->nl_text ('N/A');
421        }
422    
423        ## Informations
424        $out->start_tag ('td', class => $x->{status}->{info} ? 'infos' : '');
425        if ($x->{status}->{applicable}) {
426          $out->text (($x->{status}->{info} or 0) . $uncertain);
427        } else {
428          $out->nl_text ('N/A');
429        }
430    
431        ## Score
432        $out->start_tag ('td',
433                         class => $x->{status}->{must} ? 'score must-errors' :
434                                  $x->{status}->{should} ? 'score should-errors' :
435                                  'score');
436        
437        my $max_score = $x->{score_base};
438        $max_score -= $x->{status}->{must} * $score_unit;
439        my $min_score = $max_score;
440        $min_score -= $x->{status}->{should} * $score_unit;
441    
442        $out->start_tag ('strong');
443        if ($x->{status}->{uncertain}) {
444          $out->html ('&#x2212;&#x221E; '); # negative inifinity
445          $out->nl_text ('...');
446          $out->html ($max_score < 0 ?
447                      ' &#x2212;' . substr ($max_score, 1) : ' ' . $max_score);
448        } elsif ($min_score != $max_score) {
449          $out->html ($min_score < 0 ?
450                      '&#x2212;' . substr ($min_score, 1) . ' ': $min_score . ' ');
451          $out->nl_text ('...');
452          $out->html ($max_score < 0 ?
453                      ' &#x2212;' . substr ($max_score, 1) : ' ' . $max_score);
454        } else {
455          $out->html ($max_score < 0 ?
456                      '&#x2212;' . substr ($max_score, 1) : $max_score);
457        }
458        $out->end_tag ('strong');
459    
460        $out->text (' / ' . $x->{score_base});
461    }    }
462    return join '/', @r;    
463  } # get_node_path    $out->end_tag ('table');
464    
465  use Scalar::Util qw/refaddr/;    my $parent = $self->parent_result;
466      if ($parent) {
467        $global_status->{input} = $out->input;
468        push @{$parent->{subdoc_results}}, $global_status;
469      }
470    
471  sub get_node_link ($$) {    $out->nl_text ('This checker is work in progress.');
472    my $self = shift;    $out->end_section;
473    return qq[<a href="#$_[0]->{id_prefix}node-@{[refaddr $_[1]]}">] .  } # generate_result_section
        ($self->get_node_path ($_[1])) . qq[</a>];  
         ## BUG: ^ must be escaped  
 } # get_node_link  
474    
475  1;  1;

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.20

admin@suikawiki.org
ViewVC Help
Powered by ViewVC 1.1.24