/[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.3 by wakaba, Mon Jul 21 05:24:32 2008 UTC revision 1.15 by wakaba, Fri Aug 22 13:08:12 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    $out->start_tag ('dt', class => $class);    ## Line & column numbers (prepare values)
   my $has_location;  
   
   ## URL  
     
   if (defined $opt{url}) {  
     $out->url ($opt{url});  
     $has_location = 1;  
   }  
   
   ## Line & column number  
87    
88    my $line;    my $line;
89    my $column;    my $column;
# Line 72  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 97  sub add_error ($%) { Line 117  sub add_error ($%) {
117        $column = $opt{column};        $column = $opt{column};
118      }      }
119    }    }
120      $line = $line - 1 || 1
121          if defined $line and not (defined $column and $column > 0);
122    
123      $out->start_tag ('dt', class => $class,
124                       'data-type' => $opt{type},
125                       'data-level' => $error_level,
126                       'data-layer' => $error_layer,
127                       ($line ? ('data-line' => $line) : ()),
128                       ($column ? ('data-column' => $column) : ()));
129      my $has_location;
130    
131      ## URL
132      
133      if (defined $opt{url}) {
134        $out->url ($opt{url});
135        $has_location = 1;
136      }
137    
138      ## Line & column numbers (real output)
139    
140    if (defined $line) {    if (defined $line) {
141      if (defined $column and $column > 0) {      if (defined $column and $column > 0) {
142        $out->xref ('Line ' . $line, target => 'line-' . $line);        $out->xref ('Line #', text => $line, target => 'line-' . $line);
143        $out->text (' column ' . $column);        $out->text (' ');
144          $out->nl_text ('column #', text => $column);
145      } else {      } else {
146        $line = $line - 1 || 1;        $out->xref ('Line #', text => $line, target => 'line-' . $line);
       $out->xref ('Line ' . $line, target => 'line-' . $line);  
147      }      }
148      $has_location = 1;      $has_location = 1;
149    }    }
# Line 120  sub add_error ($%) { Line 159  sub add_error ($%) {
159    if (defined $opt{index}) {    if (defined $opt{index}) {
160      if ($opt{index_has_link}) {      if ($opt{index_has_link}) {
161        $out->html (' ');        $out->html (' ');
162        $out->xref ('Index ' . (0+$opt{index}),        $out->xref ('Index #', text => (0+$opt{index}),
163                    target => 'index-' . (0+$opt{index}));                    target => 'index-' . (0+$opt{index}));
164      } else {      } else {
165        $out->text (' Index ' . (0+$opt{index}));        $out->html (' ');
166          $out->nl_text ('Index #', text => (0+$opt{index}));
167      }      }
168      $has_location = 1;      $has_location = 1;
169    }    }
# Line 145  sub add_error ($%) { Line 185  sub add_error ($%) {
185        } elsif (defined $opt{input}->{request_uri}) {        } elsif (defined $opt{input}->{request_uri}) {
186          $out->url ($opt{input}->{request_uri});          $out->url ($opt{input}->{request_uri});
187          $has_location = 1;          $has_location = 1;
188        } elsif (defined $opt{input}->{uri}) {        } elsif (defined $opt{input}->url) {
189          $out->url ($opt{input}->{uri});          $out->url ($opt{input}->url);
190          $has_location = 1;          $has_location = 1;
191        }        }
192      }      }
193            
194      unless ($has_location) {      unless ($has_location) {
195        $out->text ('No location information available');        $out->nl_text ('Unknown location');
196      }      }
197    }    }
198    
199    $out->start_tag ('dd', class => $class);    $out->start_tag ('dd', class => $class);
   $out->text ($error_type_text);  
200    
201    if (defined $opt{text}) {    ## Error level
202      $out->html (' (<q>');    $out->nl_text ('Error level ' . $error_level);
203      $out->text ($opt{text});    $out->text (': ');
204      $out->html ('</q>)');    
205    }    ## Error message
206      my $error_type_text = $opt{type};
207      $out->nl_text ($error_type_text, node => $opt{node}, text => $opt{text},
208                     value => $opt{value});
209      
210      ## Link to a long description
211    
212    my $fragment = $opt{type};    my $fragment = $opt{type};
213    $fragment =~ tr/ /-/;    $fragment =~ tr/ /-/;
214    $fragment = $out->encode_url_component ($fragment);    $fragment = $out->encode_url_component ($fragment);
215    $out->text (' [');    $out->text (' [');
216    $out->link ('Description', url => '../error-description#' . $fragment);    $out->start_tag ('a', href => '../error-description#' . $fragment,
217                       rel => 'help');
218      $out->nl_text ('Description');
219      $out->end_tag ('a');
220    $out->text (']');    $out->text (']');
221    
222      if ($error_level eq 'm') {
223  #    my ($type, $cls, $msg) = main::get_text ($opt{type}, $opt{level});      $self->{layers}->{$error_layer}->{must}++;
224  #    $out->html (qq[<dt class="$cls">] . $result->get_error_label ($input, \%opt));      $self->{global_status} = 'non-conforming';
225      } elsif ($error_level eq 's') {
226    $error_layer = 'char'      $self->{layers}->{$error_layer}->{should}++;
227        if $error_layer eq 'charset' or $error_layer eq 'encode';      $self->{global_status} = 'should-error'
228    if ($error_level eq 's') {          unless {'non-conforming' => 1,
229      $self->{$error_layer}->{should}++;                  uncertain => 1}->{$self->{global_status}};
     $self->{$error_layer}->{score_min} -= 2;  
     $self->{conforming_min} = 0;  
230    } elsif ($error_level eq 'w') {    } elsif ($error_level eq 'w') {
231      $self->{$error_layer}->{warning}++;      $self->{layers}->{$error_layer}->{warning}++;
232    } elsif ($error_level eq 'u') {    } elsif ($error_level eq 'u') {
233      $self->{$error_layer}->{unsupported}++;      $self->{layers}->{$error_layer}->{uncertain}++;
234      $self->{unsupported} = 1;      $self->{global_status} = 'uncertain'
235            unless $self->{global_status} eq 'non-conforming';
236    } elsif ($error_level eq 'i') {    } elsif ($error_level eq 'i') {
237      #      $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;  
238    }    }
239  } # add_error  } # add_error
240    
241  sub generate_result_section ($) {  sub generate_result_section ($) {
242    my $result = shift;    my $self = shift;
243    
244      my $result = $self;
245    
246    my $out = $result->output;    my $out = $result->output;
247    
248    $out->start_section (id => 'result-summary',    $out->start_section (role => 'result');
                        title => 'Result');  
249    
250    if ($result->{unsupported} and $result->{conforming_max}) {      my $para_class = {
251      $out->html (qq[<p class=uncertain id=result-para>The conformance      'conforming' => 'result-para no-error',
252          checker cannot decide whether the document is conforming or      'should-error' => 'result-para should-errors',
253          not, since the document contains one or more unsupported      'non-conforming' => 'result-para must-errors',
254          features.  The document might or might not be conforming.</p>]);      'uncertain' => 'result-para uncertain',
255    } elsif ($result->{conforming_min}) {    }->{$self->{global_status}};
256      $out->html (qq[<p class=PASS id=result-para>No conformance-error is    $out->start_tag ('p', class => $para_class);
257          found in this document.</p>]);    $out->nl_text ('Conformance is ' . $self->{global_status});
258    } 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>]);  
   }  
259    
260    $out->html (qq[<table>    $out->html (qq[<table>
261  <colgroup><col><colgroup><col><col><col><colgroup><col>  <colgroup><col><col><colgroup><col><col><col><col><colgroup><col>
262  <thead>  <thead>
263  <tr><th scope=col></th>  <tr><th scope=col colspan=2>]);
264  <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',
265  Errors</a></th>         'Error level i', 'Score') {
266  <th scope=col><a href="../error-description#level-s"><em class=rfc2119>SHOULD</em>-level      $out->start_tag ('th');
267  Errors</a></th>      $out->nl_text ($_);
268  <th scope=col><a href="../error-description#level-w">Warnings</a></th>    }
269  <th scope=col>Score</th></tr></thead><tbody>]);  
270      my $maindoc_status = {must => 0, should => 0, warning => 0, info => 0,
271    ## TODO: Introduce "N/A" value (e.g. Character layer is not applicable                          uncertain => 0, applicable => 1};
272    ## to binary formats)    my $subdocs_status = {must => 0, should => 0, warning => 0, info => 0,
273                            uncertain => 0, applicable => 1};
274    my $must_error = 0;    my $global_status = {must => 0, should => 0, warning => 0, info => 0,
275    my $should_error = 0;                         uncertain => 0, applicable => 1};
276    my $warning = 0;  
277    my $score_min = 0;    my $score_unit = 2;
278    my $score_max = 0;  
279    my $score_base = 20;    my @row = (
280    my $score_unit = $score_base / 100;      sub {
281    for (        $out->start_tag ('tbody');
282      [Transfer => 'transfer', ''],        $out->start_tag ('tr');
283      [Character => 'char', ''],        $out->start_tag ('th', colspan => 7, scope => 'col');
284      [Syntax => 'syntax', '#parse-errors'],        $out->nl_text ('Main document');
285      [Structure => 'structure', '#document-errors'],      },
286    ) {        {label => 'Transfer L.', status => $self->{layers}->{transfer},
287      $must_error += ($result->{$_->[1]}->{must} += 0);         target => 'transfer-errors', score_base => 20,
288      $should_error += ($result->{$_->[1]}->{should} += 0);         parent_status => $maindoc_status},
289      $warning += ($result->{$_->[1]}->{warning} += 0);        {label => 'Encode L.', status => $self->{layers}->{encode},
290      $score_min += (($result->{$_->[1]}->{score_min} *= $score_unit) += $score_base);         target => 'parse-errors', score_base => 10,
291      $score_max += (($result->{$_->[1]}->{score_max} *= $score_unit) += $score_base);         parent_status => $maindoc_status},
292          {label => 'Char L.', status => $self->{layers}->{charset},
293      my $uncertain = $result->{$_->[1]}->{unsupported} ? '?' : '';         score_base => 10,
294      my $label = $_->[0];         parent_status => $maindoc_status},
295      if ($result->{$_->[1]}->{must} or        {label => 'Syntax L.', status => $self->{layers}->{syntax},
296          $result->{$_->[1]}->{should} or         target => 'parse-errors', score_base => 20,
297          $result->{$_->[1]}->{warning} or         parent_status => $maindoc_status},
298          $result->{$_->[1]}->{unsupported}) {        {label => 'Structure L.', status => $self->{layers}->{structure},
299        $label = qq[<a href="$_->[2]">$label</a>];         target => 'document-errors', score_base => 20,
300      }         parent_status => $maindoc_status},
301          {label => 'Semantics L.', status => $self->{layers}->{semantics},
302      $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>]);         score_base => 20,
303      if ($uncertain) {         parent_status => $maindoc_status},
304        $out->html (qq[<td class="@{[$result->{$_->[1]}->{must} ? 'FAIL' : $result->{$_->[1]}->{should} ? 'SEE-RESULT' : '']}">&#x2212;&#x221E;..$result->{$_->[1]}->{score_max}]);    );
305      } elsif ($result->{$_->[1]}->{score_min} != $result->{$_->[1]}->{score_max}) {  
306        $out->html (qq[<td class="@{[$result->{$_->[1]}->{must} ? 'FAIL' : 'SEE-RESULT']}">$result->{$_->[1]}->{score_min}..$result->{$_->[1]}->{score_max}]);    if (@{$self->{subdoc_results}}) {
307      } else {      push @row, {label => 'Subtotal', status => $maindoc_status,
308        $out->html (qq[<td class="@{[$result->{$_->[1]}->{must} ? 'FAIL' : '']}">$result->{$_->[1]}->{score_min}]);                  score_base => 100,
309                    parent_status => $global_status, is_total => 1};
310        push @row, sub {
311          $out->start_tag ('tbody');
312          $out->start_tag ('tr');
313          $out->start_tag ('th', colspan => 7, scope => 'col');
314          $out->nl_text ('Subdocuments');
315        };
316        for (@{$self->{subdoc_results}}) {
317          push @row, {label => '#' . $_->{input}->full_subdocument_index,
318                      status => $_,
319                      target => $_->{input}->id_prefix . 'result-summary',
320                      score_base => 100, parent_status => $subdocs_status};
321      }      }
322      $out->html (qq[ / 20]);      push @row, {label => 'Subtotal', status => $subdocs_status,
323                    score_base => 100 * @{$self->{subdoc_results}},
324                    parent_status => $global_status, is_total => 1};
325      } else {
326        $global_status = $maindoc_status;
327    }    }
328    
329    $score_max += $score_base;    push @row, sub {
330        $out->start_tag ('tfoot');
331      };
332      push @row, {label => 'Total', status => $global_status,
333                  score_base => 100 * (@{$self->{subdoc_results}} + 1),
334                  parent_status => {}, is_total => 1};
335    
336      for my $x (@row) {
337        if (ref $x eq 'CODE') {
338          $x->();
339          next;
340        }
341    
342    $out->html (qq[      $x->{parent_status}->{$_} += $x->{status}->{$_}
343  <tr class=uncertain><th scope=row>Semantics</th><td>0?</td><td>0?</td><td>0?</td><td>&#x2212;&#x221E;..$score_base / 20          for qw/must should warning info uncertain/;
 </tbody>  
 <tfoot><tr class=uncertain><th scope=row>Total</th>  
 <td class="@{[$must_error ? 'FAIL' : '']}">$must_error?</td>  
 <td class="@{[$should_error ? 'SEE-RESULT' : '']}">$should_error?</td>  
 <td>$warning?</td>  
 <td class="@{[$must_error ? 'FAIL' : $should_error ? 'SEE-RESULT' : '']}"><strong>&#x2212;&#x221E;..$score_max</strong> / 100  
 </table>  
344    
345  <p><strong>Important</strong>: This conformance checking service      my $row_class = $x->{status}->{uncertain} ? 'uncertain' : '';
346  is <em>under development</em>.  The result above might be <em>wrong</em>.</p>]);      $row_class .= ' total' if $x->{is_total};
347    $out->end_section;      $out->start_tag ('tr', class => $row_class);
348  } # generate_result_section      my $uncertain = $x->{status}->{uncertain} ? '?' : '';
349    
350        $out->start_tag ('td', class => 'subrow') unless $x->{is_total};
351    
352        ## Layer name
353        $out->start_tag ('th', colspan => $x->{is_total} ? 2 : 1,
354                         scope => 'row');
355        if (defined $x->{target} and
356            ($x->{status}->{must} or $x->{status}->{should} or
357             $x->{status}->{warning} or $x->{status}->{info} or
358             $x->{status}->{uncertain})) {
359          $out->xref ($x->{label}, target => $x->{target});
360        } else {
361          $out->nl_text ($x->{label});
362        }
363    
364  sub get_error_level_label ($) {      ## MUST-level errors
365    my $self = shift;      $out->start_tag ('td', class => $x->{status}->{must} ? 'must-errors' : '');
366    my $err = shift;      if ($x->{status}->{applicable}) {
367          $out->text (($x->{status}->{must} or 0) . $uncertain);
368        } else {
369          $out->nl_text ('N/A');
370        }
371    
372    my $r = '';      ## SHOULD-level errors
373        $out->start_tag ('td',
374                         class => $x->{status}->{should} ? 'should-errors' : '');
375        if ($x->{status}->{applicable}) {
376          $out->text (($x->{status}->{should} or 0) . $uncertain);
377        } else {
378          $out->nl_text ('N/A');
379        }
380    
381    if (not defined $err->{level} or $err->{level} eq 'm') {      ## Warnings
382      $r = qq[<strong><a href="../error-description#level-m"><em class=rfc2119>MUST</em>-level      $out->start_tag ('td', class => $x->{status}->{warning} ? 'warnings' : '');
383          error</a></strong>: ];      if ($x->{status}->{applicable}) {
384    } elsif ($err->{level} eq 's') {        $out->text (($x->{status}->{warning} or 0) . $uncertain);
385      $r = qq[<strong><a href="../error-description#level-s"><em class=rfc2119>SHOULD</em>-level      } else {
386          error</a></strong>: ];        $out->nl_text ('N/A');
387    } elsif ($err->{level} eq 'w') {      }
388      $r = qq[<strong><a href="../error-description#level-w">Warning</a></strong>:  
389          ];      ## Informations
390    } elsif ($err->{level} eq 'u' or $err->{level} eq 'unsupported') {      $out->start_tag ('td', class => $x->{status}->{info} ? 'infos' : '');
391      $r = qq[<strong><a href="../error-description#level-u">Not      if ($x->{status}->{applicable}) {
392          supported</a></strong>: ];        $out->text (($x->{status}->{info} or 0) . $uncertain);
393    } elsif ($err->{level} eq 'i') {      } else {
394      $r = qq[<strong><a href="../error-description#level-i">Information</a></strong>: ];        $out->nl_text ('N/A');
395    } else {      }
396      my $elevel = htescape ($err->{level});  
397      $r = qq[<strong><a href="../error-description#level-$elevel">$elevel</a></strong>:      ## Score
398          ];      $out->start_tag ('td',
399                         class => $x->{status}->{must} ? 'score must-errors' :
400                                  $x->{status}->{should} ? 'score should-errors' :
401                                  'score');
402        
403        my $max_score = $x->{score_base};
404        $max_score -= $x->{status}->{must} * $score_unit;
405        my $min_score = $max_score;
406        $min_score -= $x->{status}->{should} * $score_unit;
407    
408        $out->start_tag ('strong');
409        if ($x->{status}->{uncertain}) {
410          $out->html ('&#x2212;&#x221E; '); # negative inifinity
411          $out->nl_text ('...');
412          $out->html ($max_score < 0 ?
413                      ' &#x2212;' . substr ($max_score, 1) : ' ' . $max_score);
414        } elsif ($min_score != $max_score) {
415          $out->html ($min_score < 0 ?
416                      '&#x2212;' . substr ($min_score, 1) . ' ': $min_score . ' ');
417          $out->nl_text ('...');
418          $out->html ($max_score < 0 ?
419                      ' &#x2212;' . substr ($max_score, 1) : ' ' . $max_score);
420        } else {
421          $out->html ($max_score < 0 ?
422                      '&#x2212;' . substr ($max_score, 1) : $max_score);
423        }
424        $out->end_tag ('strong');
425    
426        $out->text (' / ' . $x->{score_base});
427    }    }
428      
429      $out->end_tag ('table');
430    
431    return $r;    my $parent = $self->parent_result;
432  } # get_error_level_label    if ($parent) {
433        $global_status->{input} = $out->input;
434        push @{$parent->{subdoc_results}}, $global_status;
435      }
436    
437      $out->nl_text ('This checker is work in progress.');
438      $out->end_section;
439    } # generate_result_section
440    
441  1;  1;
Legend:
Removed from v.1.3  
changed lines
  Added in v.1.15
admin@suikawiki.org
 ViewVC Help
Powered by ViewVC 1.1.24