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