/[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.6 by wakaba, Mon Jul 21 12:56:34 2008 UTC revision 1.21 by wakaba, Thu Dec 11 03:22:57 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 ($;$) {  sub output ($;$) {
# Line 17  sub output ($;$) { Line 21  sub output ($;$) {
21    return $_[0]->{output};    return $_[0]->{output};
22  } # output  } # 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      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;
44      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 ($%) {  sub add_error ($%) {
52    my ($self, %opt) = @_;    my ($self, %opt) = @_;
53    
54    my $out = $self->output;    my $out = $self->output;
55      $out->has_error (1);
56    
57    my $error_level = $opt{level};    my $error_level = $opt{level};
58    if (not defined $error_level) {    if (not defined $error_level) {
# Line 49  sub add_error ($%) { Line 81  sub add_error ($%) {
81      $error_layer = 'syntax'; ## NOTE: Unknown - an error of the implementation      $error_layer = 'syntax'; ## NOTE: Unknown - an error of the implementation
82    }    }
83    
   my $error_type_text = $opt{type};  
   
84    my $class = qq[level-$error_level layer-$error_layer];    my $class = qq[level-$error_level layer-$error_layer];
85    
86    ## Line & column numbers (prepare values)    ## Line & column numbers (prepare values)
# Line 62  sub add_error ($%) { Line 92  sub add_error ($%) {
92      $line = $opt{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 = $opt{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 ($opt{node}->node_type == $opt{node}->ATTRIBUTE_NODE) {        if ($opt{node}->node_type == $opt{node}->ATTRIBUTE_NODE) {
97          my $owner = $opt{node}->owner_element;          my $owner = $opt{node}->owner_element;
98          if ($owner) {          if ($owner) {
# Line 87  sub add_error ($%) { Line 117  sub add_error ($%) {
117        $column = $opt{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    $line = $line - 1 || 1
123        if defined $line and not (defined $column and $column > 0);        if defined $line and not (defined $column and $column > 0);
124    
# Line 138  sub add_error ($%) { Line 170  sub add_error ($%) {
170      $has_location = 1;      $has_location = 1;
171    }    }
172    
173    if (defined $opt{value}) {    if (not defined $opt{valueref} and defined $opt{value}) {
174        $opt{valueref} = \($opt{value});
175      }
176    
177      if (defined $opt{valueref}) {
178      $out->html (' ');      $out->html (' ');
179      $out->code ($opt{value});      if (defined $opt{pos_start}) {
180          $out->start_tag ('code');
181          $out->text (substr ${$opt{valueref}}, 0, $opt{pos_start});
182          $out->start_tag ('mark');
183          $out->text (substr ${$opt{valueref}}, $opt{pos_start},
184                          $opt{pos_end} - $opt{pos_start});
185          $out->end_tag ('mark');
186          $out->text (substr ${$opt{valueref}}, $opt{pos_end})
187              if $opt{pos_end} < length ${$opt{valueref}};
188          $out->end_tag ('code');
189        } elsif ($opt{value_mark_end}) {
190          $out->start_tag ('code');
191          $out->text (${$opt{valueref}});
192          $out->start_tag ('mark');
193          $out->end_tag ('mark');
194          $out->end_tag ('code');
195        } elsif (defined $opt{value_mark}) {
196          $out->start_tag ('code');
197          for (split /($opt{value_mark})/, ${$opt{valueref}}) {
198            if (/$opt{value_mark}/) {
199              $out->start_tag ('mark');
200              $out->text ($_);
201              $out->end_tag ('mark');
202            } else {
203              $out->text ($_);
204            }
205          }
206          $out->end_tag ('code');
207        } else {
208          $out->code (${$opt{valueref}});
209        }
210      $has_location = 1;      $has_location = 1;
211    }    }
212    
# Line 155  sub add_error ($%) { Line 221  sub add_error ($%) {
221        } elsif (defined $opt{input}->{request_uri}) {        } elsif (defined $opt{input}->{request_uri}) {
222          $out->url ($opt{input}->{request_uri});          $out->url ($opt{input}->{request_uri});
223          $has_location = 1;          $has_location = 1;
224        } elsif (defined $opt{input}->{uri}) {        } elsif (defined $opt{input}->url) {
225          $out->url ($opt{input}->{uri});          $out->url ($opt{input}->url);
226          $has_location = 1;          $has_location = 1;
227        }        }
228      }      }
229            
230      unless ($has_location) {      unless ($has_location) {
231        $out->text ('Unknown location');        $out->nl_text ('Unknown location');
232      }      }
233    }    }
234    
235    $out->start_tag ('dd', class => $class);    $out->start_tag ('dd', class => $class);
236    
237    ## Error level    ## Error level
238      $out->nl_text ('Error level ' . $error_level);
239      $out->text (': ');
240        
   if ($error_level eq 'm') {  
     $out->html (qq[<strong><a href="../error-description#level-m"><em class=rfc2119>MUST</em>-level  
         error</a></strong>: ]);  
   } elsif ($error_level eq 's') {  
     $out->html (qq[<strong><a href="../error-description#level-s"><em class=rfc2119>SHOULD</em>-level  
         error</a></strong>: ]);  
   } elsif ($error_level eq 'w') {  
     $out->html (qq[<strong><a href="../error-description#level-w">Warning</a></strong>: ]);  
   } elsif ($error_level eq 'u') {  
     $out->html (qq[<strong><a href="../error-description#level-u">Not  
         supported</a></strong>: ]);  
   } elsif ($error_level eq 'i') {  
     $out->html (qq[<strong><a href="../error-description#level-i">Information</a></strong>: ]);  
   }  
   
241    ## Error message    ## Error message
242      my $error_type_text = $opt{type};
243    $out->nl_text ($error_type_text, node => $opt{node}, text => $opt{text});    $out->nl_text ($error_type_text, node => $opt{node}, text => $opt{text},
244                     value => ${$opt{valueref} or \''}, char => $opt{char},
245    ## Additional error description                   octets => $opt{octets});
   
   if (defined $opt{text}) {  
     $out->html (' (<q>');  
     $out->text ($opt{text});  
     $out->html ('</q>)');  
   }  
246        
247    ## Link to a long description    ## Link to a long description
248    
# Line 203  sub add_error ($%) { Line 250  sub add_error ($%) {
250    $fragment =~ tr/ /-/;    $fragment =~ tr/ /-/;
251    $fragment = $out->encode_url_component ($fragment);    $fragment = $out->encode_url_component ($fragment);
252    $out->text (' [');    $out->text (' [');
253    $out->link ('Description', url => '../error-description#' . $fragment,    $out->start_tag ('a', href => '../error-description#' . $fragment,
254                rel => 'help');                     rel => 'help');
255      $out->nl_text ('Description');
256      $out->end_tag ('a');
257    $out->text (']');    $out->text (']');
258    
259      if ($error_level eq 'm') {
260  #    my ($type, $cls, $msg) = main::get_text ($opt{type}, $opt{level});      $self->{layers}->{$error_layer}->{must}++;
261  #    $out->html (qq[<dt class="$cls">] . $result->get_error_label ($input, \%opt));      $self->{global_status} = 'non-conforming';
262      } elsif ($error_level eq 's') {
263    $error_layer = 'char'      $self->{layers}->{$error_layer}->{should}++;
264        if $error_layer eq 'charset' or $error_layer eq 'encode';      $self->{global_status} = 'should-error'
265    if ($error_level eq 's') {          unless {'non-conforming' => 1,
266      $self->{$error_layer}->{should}++;                  uncertain => 1}->{$self->{global_status}};
     $self->{$error_layer}->{score_min} -= 2;  
     $self->{conforming_min} = 0;  
267    } elsif ($error_level eq 'w') {    } elsif ($error_level eq 'w') {
268      $self->{$error_layer}->{warning}++;      $self->{layers}->{$error_layer}->{warning}++;
269    } elsif ($error_level eq 'u') {    } elsif ($error_level eq 'u') {
270      $self->{$error_layer}->{unsupported}++;      $self->{layers}->{$error_layer}->{uncertain}++;
271      $self->{unsupported} = 1;      $self->{global_status} = 'uncertain'
272            unless $self->{global_status} eq 'non-conforming';
273    } elsif ($error_level eq 'i') {    } elsif ($error_level eq 'i') {
274      #      $self->{layers}->{$error_layer}->{info}++;
   } else {  
     $self->{$error_layer}->{must}++;  
     $self->{$error_layer}->{score_max} -= 2;  
     $self->{$error_layer}->{score_min} -= 2;  
     $self->{conforming_min} = 0;  
     $self->{conforming_max} = 0;  
275    }    }
276  } # add_error  } # add_error
277    
278  sub generate_result_section ($) {  sub generate_result_section ($) {
279    my $result = shift;    my $self = shift;
280    
281      my $result = $self;
282    
283    my $out = $result->output;    my $out = $result->output;
284    
285    $out->start_section (id => 'result-summary',    $out->start_section (role => 'result');
                        title => 'Result');  
286    
287    if ($result->{unsupported} and $result->{conforming_max}) {      my $para_class = {
288      $out->html (qq[<p class=uncertain id=result-para>The conformance      'conforming' => 'result-para no-error',
289          checker cannot decide whether the document is conforming or      'should-error' => 'result-para should-errors',
290          not, since the document contains one or more unsupported      'non-conforming' => 'result-para must-errors',
291          features.  The document might or might not be conforming.</p>]);      'uncertain' => 'result-para uncertain',
292    } elsif ($result->{conforming_min}) {    }->{$self->{global_status}};
293      $out->html (qq[<p class=PASS id=result-para>No conformance-error is    $out->start_tag ('p', class => $para_class);
294          found in this document.</p>]);    $out->nl_text ('Conformance is ' . $self->{global_status});
295    } elsif ($result->{conforming_max}) {    $out->end_tag ('p');
     $out->html (qq[<p class=SEE-RESULT id=result-para>This document  
         is <strong>likely <em>non</em>-conforming</strong>, but in rare case  
         it might be conforming.</p>]);  
   } else {  
     $out->html (qq[<p class=FAIL id=result-para>This document is  
         <strong><em>non</em>-conforming</strong>.</p>]);  
   }  
296    
297    $out->html (qq[<table>    $out->html (qq[<table>
298  <colgroup><col><colgroup><col><col><col><colgroup><col>  <colgroup><col><col><colgroup><col><col><col><col><colgroup><col>
299  <thead>  <thead>
300  <tr><th scope=col></th>  <tr><th scope=col colspan=2>]);
301  <th scope=col><a href="../error-description#level-m"><em class=rfc2119>MUST</em>-level    for ('Error level m', 'Error level s', 'Error level w',
302  Errors</a></th>         'Error level i', 'Score') {
303  <th scope=col><a href="../error-description#level-s"><em class=rfc2119>SHOULD</em>-level      $out->start_tag ('th');
304  Errors</a></th>      $out->nl_text ($_);
305  <th scope=col><a href="../error-description#level-w">Warnings</a></th>    }
306  <th scope=col>Score</th></tr></thead><tbody>]);  
307      my $maindoc_status = {must => 0, should => 0, warning => 0, info => 0,
308    ## TODO: Introduce "N/A" value (e.g. Character layer is not applicable                          uncertain => 0, applicable => 1};
309    ## to binary formats)    my $subdocs_status = {must => 0, should => 0, warning => 0, info => 0,
310                            uncertain => 0, applicable => 1};
311    my $must_error = 0;    my $global_status = {must => 0, should => 0, warning => 0, info => 0,
312    my $should_error = 0;                         uncertain => 0, applicable => 1};
313    my $warning = 0;  
314    my $score_min = 0;    my $score_unit = 2;
315    my $score_max = 0;  
316    my $score_base = 20;    my @row = (
317    my $score_unit = $score_base / 100;      sub {
318    for (        $out->start_tag ('tbody');
319      [Transfer => 'transfer', ''],        $out->start_tag ('tr');
320      [Character => 'char', ''],        $out->start_tag ('th', colspan => 7, scope => 'col');
321      [Syntax => 'syntax', '#parse-errors'],        $out->nl_text ('Main document');
322      [Structure => 'structure', '#document-errors'],      },
323    ) {        {label => 'Transfer L.', status => $self->{layers}->{transfer},
324      $must_error += ($result->{$_->[1]}->{must} += 0);         target => 'transfer-errors', score_base => 20,
325      $should_error += ($result->{$_->[1]}->{should} += 0);         parent_status => $maindoc_status},
326      $warning += ($result->{$_->[1]}->{warning} += 0);        {label => 'Encode L.', status => $self->{layers}->{encode},
327      $score_min += (($result->{$_->[1]}->{score_min} *= $score_unit) += $score_base);         target => 'parse-errors', score_base => 10,
328      $score_max += (($result->{$_->[1]}->{score_max} *= $score_unit) += $score_base);         parent_status => $maindoc_status},
329          {label => 'Char L.', status => $self->{layers}->{charset},
330      my $uncertain = $result->{$_->[1]}->{unsupported} ? '?' : '';         target => 'parse-errors', score_base => 10,
331      my $label = $_->[0];         parent_status => $maindoc_status},
332      if ($result->{$_->[1]}->{must} or        ## TODO: char semantics layer
333          $result->{$_->[1]}->{should} or        {label => 'Syntax L.', status => $self->{layers}->{syntax},
334          $result->{$_->[1]}->{warning} or         target => 'parse-errors', score_base => 20,
335          $result->{$_->[1]}->{unsupported}) {         parent_status => $maindoc_status},
336        $label = qq[<a href="$_->[2]">$label</a>];        {label => 'Structure L.', status => $self->{layers}->{structure},
337      }         target => 'document-errors', score_base => 20,
338           parent_status => $maindoc_status},
339      $out->html (qq[<tr class="@{[$uncertain ? 'uncertain' : '']}"><th scope=row>$label</th><td class="@{[$result->{$_->[1]}->{must} ? 'FAIL' : '']}">$result->{$_->[1]}->{must}$uncertain</td><td class="@{[$result->{$_->[1]}->{should} ? 'SEE-RESULT' : '']}">$result->{$_->[1]}->{should}$uncertain</td><td>$result->{$_->[1]}->{warning}$uncertain</td>]);        {label => 'Semantics L.', status => $self->{layers}->{semantics},
340      if ($uncertain) {         score_base => 20,
341        $out->html (qq[<td class="@{[$result->{$_->[1]}->{must} ? 'FAIL' : $result->{$_->[1]}->{should} ? 'SEE-RESULT' : '']}">&#x2212;&#x221E;..$result->{$_->[1]}->{score_max}]);         parent_status => $maindoc_status},
342      } elsif ($result->{$_->[1]}->{score_min} != $result->{$_->[1]}->{score_max}) {    );
343        $out->html (qq[<td class="@{[$result->{$_->[1]}->{must} ? 'FAIL' : 'SEE-RESULT']}">$result->{$_->[1]}->{score_min}..$result->{$_->[1]}->{score_max}]);  
344      } else {    if (@{$self->{subdoc_results}}) {
345        $out->html (qq[<td class="@{[$result->{$_->[1]}->{must} ? 'FAIL' : '']}">$result->{$_->[1]}->{score_min}]);      push @row, {label => 'Subtotal', status => $maindoc_status,
346      }                  score_base => 100,
347      $out->html (qq[ / 20]);                  parent_status => $global_status, is_total => 1};
348    }      push @row, sub {
349          $out->start_tag ('tbody');
350    $score_max += $score_base;        $out->start_tag ('tr');
351          $out->start_tag ('th', colspan => 7, scope => 'col');
352    $out->html (qq[        $out->nl_text ('Subdocuments');
353  <tr class=uncertain><th scope=row>Semantics</th><td>0?</td><td>0?</td><td>0?</td><td>&#x2212;&#x221E;..$score_base / 20      };
354  </tbody>      for (@{$self->{subdoc_results}}) {
355  <tfoot><tr class=uncertain><th scope=row>Total</th>        push @row, {label => '#' . $_->{input}->full_subdocument_index,
356  <td class="@{[$must_error ? 'FAIL' : '']}">$must_error?</td>                    status => $_,
357  <td class="@{[$should_error ? 'SEE-RESULT' : '']}">$should_error?</td>                    target => $_->{input}->id_prefix . 'result-summary',
358  <td>$warning?</td>                    score_base => 100, parent_status => $subdocs_status};
359  <td class="@{[$must_error ? 'FAIL' : $should_error ? 'SEE-RESULT' : '']}"><strong>&#x2212;&#x221E;..$score_max</strong> / 100      }
360  </table>      push @row, {label => 'Subtotal', status => $subdocs_status,
361                    score_base => 100 * @{$self->{subdoc_results}},
362                    parent_status => $global_status, is_total => 1};
363      } else {
364        $global_status = $maindoc_status;
365      }
366    
367      push @row, sub {
368        $out->start_tag ('tfoot');
369      };
370      push @row, {label => 'Total', status => $global_status,
371                  score_base => 100 * (@{$self->{subdoc_results}} + 1),
372                  parent_status => {}, is_total => 1};
373    
374      for my $x (@row) {
375        if (ref $x eq 'CODE') {
376          $x->();
377          next;
378        }
379    
380        $x->{parent_status}->{$_} += $x->{status}->{$_}
381            for qw/must should warning info uncertain/;
382    
383        my $row_class = $x->{status}->{uncertain} ? 'uncertain' : '';
384        $row_class .= ' total' if $x->{is_total};
385        $out->start_tag ('tr', class => $row_class);
386        my $uncertain = $x->{status}->{uncertain} ? '?' : '';
387    
388        $out->start_tag ('td', class => 'subrow') unless $x->{is_total};
389    
390        ## Layer name
391        $out->start_tag ('th', colspan => $x->{is_total} ? 2 : 1,
392                         scope => 'row');
393        if (defined $x->{target} and
394            ($x->{status}->{must} or $x->{status}->{should} or
395             $x->{status}->{warning} or $x->{status}->{info} or
396             $x->{status}->{uncertain})) {
397          $out->xref ($x->{label}, target => $x->{target});
398        } else {
399          $out->nl_text ($x->{label});
400        }
401    
402        ## MUST-level errors
403        $out->start_tag ('td', class => $x->{status}->{must} ? 'must-errors' : '');
404        if ($x->{status}->{applicable}) {
405          $out->text (($x->{status}->{must} or 0) . $uncertain);
406        } else {
407          $out->nl_text ('N/A');
408        }
409    
410        ## SHOULD-level errors
411        $out->start_tag ('td',
412                         class => $x->{status}->{should} ? 'should-errors' : '');
413        if ($x->{status}->{applicable}) {
414          $out->text (($x->{status}->{should} or 0) . $uncertain);
415        } else {
416          $out->nl_text ('N/A');
417        }
418    
419        ## Warnings
420        $out->start_tag ('td', class => $x->{status}->{warning} ? 'warnings' : '');
421        if ($x->{status}->{applicable}) {
422          $out->text (($x->{status}->{warning} or 0) . $uncertain);
423        } else {
424          $out->nl_text ('N/A');
425        }
426    
427        ## Informations
428        $out->start_tag ('td', class => $x->{status}->{info} ? 'infos' : '');
429        if ($x->{status}->{applicable}) {
430          $out->text (($x->{status}->{info} or 0) . $uncertain);
431        } else {
432          $out->nl_text ('N/A');
433        }
434    
435        ## Score
436        $out->start_tag ('td',
437                         class => $x->{status}->{must} ? 'score must-errors' :
438                                  $x->{status}->{should} ? 'score should-errors' :
439                                  'score');
440        
441        my $max_score = $x->{score_base};
442        $max_score -= $x->{status}->{must} * $score_unit;
443        my $min_score = $max_score;
444        $min_score -= $x->{status}->{should} * $score_unit;
445    
446        $out->start_tag ('strong');
447        if ($x->{status}->{uncertain}) {
448          $out->html ('&#x2212;&#x221E; '); # negative inifinity
449          $out->nl_text ('...');
450          $out->html ($max_score < 0 ?
451                      ' &#x2212;' . substr ($max_score, 1) : ' ' . $max_score);
452        } elsif ($min_score != $max_score) {
453          $out->html ($min_score < 0 ?
454                      '&#x2212;' . substr ($min_score, 1) . ' ': $min_score . ' ');
455          $out->nl_text ('...');
456          $out->html ($max_score < 0 ?
457                      ' &#x2212;' . substr ($max_score, 1) : ' ' . $max_score);
458        } else {
459          $out->html ($max_score < 0 ?
460                      '&#x2212;' . substr ($max_score, 1) : $max_score);
461        }
462        $out->end_tag ('strong');
463    
464        $out->text (' / ' . $x->{score_base});
465      }
466      
467      $out->end_tag ('table');
468    
469      my $parent = $self->parent_result;
470      if ($parent) {
471        $global_status->{input} = $out->input;
472        push @{$parent->{subdoc_results}}, $global_status;
473      }
474    
475  <p><strong>Important</strong>: This conformance checking service    $out->nl_text ('This checker is work in progress.');
 is <em>under development</em>.  The result above might be <em>wrong</em>.</p>]);  
476    $out->end_section;    $out->end_section;
477  } # generate_result_section  } # generate_result_section
478    
Legend:
Removed from v.1.6  
changed lines
  Added in v.1.21
admin@suikawiki.org
 ViewVC Help
Powered by ViewVC 1.1.24