/[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.13 by wakaba, Fri Aug 15 16:03:46 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 = $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        $r = qq[<a href="#$input->{id_prefix}line-$line">Line $line</a> column $column];        $out->xref ('Line #', text => $line, target => 'line-' . $line);
143          $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);
       $r = qq[<a href="#$input->{id_prefix}line-$line">Line $line</a>];  
147      }      }
148        $has_location = 1;
149    }    }
150    
151    if (defined $err->{node}) {    ## Node path
152      $r .= ' ' if length $r;  
153      $r .= $self->get_node_link ($input, $err->{node});    if (defined $opt{node}) {
154        $out->html (' ');
155        $out->node_link ($opt{node});
156        $has_location = 1;
157    }    }
158    
159    if (defined $err->{index}) {    if (defined $opt{index}) {
160      if (length $r) {      if ($opt{index_has_link}) {
161        $r .= ', Index ' . (0+$err->{index});        $out->html (' ');
162          $out->xref ('Index #', text => (0+$opt{index}),
163                      target => 'index-' . (0+$opt{index}));
164      } else {      } else {
165        $r .= "<a href='#$input->{id_prefix}index-@{[0+$err->{index}]}'>Index "        $out->html (' ');
166            . (0+$err->{index}) . '</a>';        $out->nl_text ('Index #', text => (0+$opt{index}));
167      }      }
168        $has_location = 1;
169    }    }
170    
171    if (defined $err->{value}) {    if (defined $opt{value}) {
172      $r .= ' ' if length $r; ## BUG: v must be escaped      $out->html (' ');
173      $r .= '<q><code>' . ($err->{value}) . '</code></q>';      $out->code ($opt{value});
174        $has_location = 1;
175    }    }
176    
177    return $r;    unless ($has_location) {
178  } # get_error_label      if (defined $opt{input}) {
179          if (defined $opt{input}->{container_node}) {
180            my $original_input = $out->input;
181            $out->input ($opt{input}->{parent_input});
182            $out->node_link ($opt{input}->{container_node});
183            $out->input ($original_input);
184            $has_location = 1;
185          } elsif (defined $opt{input}->{request_uri}) {
186            $out->url ($opt{input}->{request_uri});
187            $has_location = 1;
188          } elsif (defined $opt{input}->{uri}) {
189            $out->url ($opt{input}->{uri});
190            $has_location = 1;
191          }
192        }
193        
194        unless ($has_location) {
195          $out->nl_text ('Unknown location');
196        }
197      }
198    
199      $out->start_tag ('dd', class => $class);
200    
201      ## Error level
202      $out->nl_text ('Error level ' . $error_level);
203      $out->text (': ');
204      
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      ## Additional error description
211      if (defined $opt{text}) { ## TODO: Remove this block once all errors are put into the catalog.
212        $out->html (' (<q>');
213        $out->text ($opt{text});
214        $out->html ('</q>)');
215      }
216      
217      ## Link to a long description
218    
219  sub get_error_level_label ($) {    my $fragment = $opt{type};
220      $fragment =~ tr/ /-/;
221      $fragment = $out->encode_url_component ($fragment);
222      $out->text (' [');
223      $out->link ('Description', url => '../error-description#' . $fragment,
224                  rel => 'help');
225      $out->text (']');
226    
227      if ($error_level eq 'm') {
228        $self->{layers}->{$error_layer}->{must}++;
229        $self->{global_status} = 'non-conforming';
230      } elsif ($error_level eq 's') {
231        $self->{layers}->{$error_layer}->{should}++;
232        $self->{global_status} = 'should-error'
233            unless {'non-conforming' => 1,
234                    uncertain => 1}->{$self->{global_status}};
235      } elsif ($error_level eq 'w') {
236        $self->{layers}->{$error_layer}->{warning}++;
237      } elsif ($error_level eq 'u') {
238        $self->{layers}->{$error_layer}->{uncertain}++;
239        $self->{global_status} = 'uncertain'
240            unless $self->{global_status} eq 'non-conforming';
241      } elsif ($error_level eq 'i') {
242        $self->{layers}->{$error_layer}->{info}++;
243      }
244    } # add_error
245    
246    sub generate_result_section ($) {
247    my $self = shift;    my $self = shift;
   my $err = shift;  
248    
249    my $r = '';    my $result = $self;
250    
251      my $out = $result->output;
252    
253      $out->start_section (role => 'result');
254    
255    if (not defined $err->{level} or $err->{level} eq 'm') {    my $para_class = {
256      $r = qq[<strong><a href="../error-description#level-m"><em class=rfc2119>MUST</em>-level      'conforming' => 'result-para no-error',
257          error</a></strong>: ];      'should-error' => 'result-para should-errors',
258    } elsif ($err->{level} eq 's') {      'non-conforming' => 'result-para must-errors',
259      $r = qq[<strong><a href="../error-description#level-s"><em class=rfc2119>SHOULD</em>-level      'uncertain' => 'result-para uncertain',
260          error</a></strong>: ];    }->{$self->{global_status}};
261    } elsif ($err->{level} eq 'w') {    $out->start_tag ('p', class => $para_class);
262      $r = qq[<strong><a href="../error-description#level-w">Warning</a></strong>:    $out->nl_text ('Conformance is ' . $self->{global_status});
263          ];    $out->end_tag ('p');
264    } elsif ($err->{level} eq 'u' or $err->{level} eq 'unsupported') {  
265      $r = qq[<strong><a href="../error-description#level-u">Not    $out->html (qq[<table>
266          supported</a></strong>: ];  <colgroup><col><col><colgroup><col><col><col><col><colgroup><col>
267    } elsif ($err->{level} eq 'i') {  <thead>
268      $r = qq[<strong><a href="../error-description#level-i">Information</a></strong>: ];  <tr><th scope=col colspan=2>]);
269      for ('Error level m', 'Error level s', 'Error level w',
270           'Error level i', 'Score') {
271        $out->start_tag ('th');
272        $out->nl_text ($_);
273      }
274    
275      my $maindoc_status = {must => 0, should => 0, warning => 0, info => 0,
276                            uncertain => 0, applicable => 1};
277      my $subdocs_status = {must => 0, should => 0, warning => 0, info => 0,
278                            uncertain => 0, applicable => 1};
279      my $global_status = {must => 0, should => 0, warning => 0, info => 0,
280                           uncertain => 0, applicable => 1};
281    
282      my $score_unit = 2;
283    
284      my @row = (
285        sub {
286          $out->start_tag ('tbody');
287          $out->start_tag ('tr');
288          $out->start_tag ('th', colspan => 7, scope => 'col');
289          $out->nl_text ('Main document');
290        },
291          {label => 'Transfer L.', status => $self->{layers}->{transfer},
292           target => 'transfer-errors', score_base => 20,
293           parent_status => $maindoc_status},
294          {label => 'Encode L.', status => $self->{layers}->{encode},
295           target => 'parse-errors', score_base => 10,
296           parent_status => $maindoc_status},
297          {label => 'Char L.', status => $self->{layers}->{charset},
298           score_base => 10,
299           parent_status => $maindoc_status},
300          {label => 'Syntax L.', status => $self->{layers}->{syntax},
301           target => 'parse-errors', score_base => 20,
302           parent_status => $maindoc_status},
303          {label => 'Structure L.', status => $self->{layers}->{structure},
304           target => 'document-errors', score_base => 20,
305           parent_status => $maindoc_status},
306          {label => 'Semantics L.', status => $self->{layers}->{semantics},
307           score_base => 20,
308           parent_status => $maindoc_status},
309      );
310    
311      if (@{$self->{subdoc_results}}) {
312        push @row, {label => 'Subtotal', status => $maindoc_status,
313                    score_base => 100,
314                    parent_status => $global_status, is_total => 1};
315        push @row, sub {
316          $out->start_tag ('tbody');
317          $out->start_tag ('tr');
318          $out->start_tag ('th', colspan => 7, scope => 'col');
319          $out->nl_text ('Subdocuments');
320        };
321        for (@{$self->{subdoc_results}}) {
322          push @row, {label => '#' . $_->{input}->full_subdocument_index,
323                      status => $_,
324                      target => $_->{input}->id_prefix . 'result-summary',
325                      score_base => 100, parent_status => $subdocs_status};
326        }
327        push @row, {label => 'Subtotal', status => $subdocs_status,
328                    score_base => 100 * @{$self->{subdoc_results}},
329                    parent_status => $global_status, is_total => 1};
330    } else {    } else {
331      my $elevel = htescape ($err->{level});      $global_status = $maindoc_status;
     $r = qq[<strong><a href="../error-description#level-$elevel">$elevel</a></strong>:  
         ];  
332    }    }
333    
334    return $r;    push @row, sub {
335  } # get_error_level_label      $out->start_tag ('tfoot');
336      };
337      push @row, {label => 'Total', status => $global_status,
338                  score_base => 100 * (@{$self->{subdoc_results}} + 1),
339                  parent_status => {}, is_total => 1};
340    
341      for my $x (@row) {
342        if (ref $x eq 'CODE') {
343          $x->();
344          next;
345        }
346    
347  sub get_node_path ($) {      $x->{parent_status}->{$_} += $x->{status}->{$_}
348    my $self = shift;          for qw/must should warning info uncertain/;
349    my $node = shift;  
350    my @r;      my $row_class = $x->{status}->{uncertain} ? 'uncertain' : '';
351    while (defined $node) {      $row_class .= ' total' if $x->{is_total};
352      my $rs;      $out->start_tag ('tr', class => $row_class);
353      if ($node->node_type == 1) {      my $uncertain = $x->{status}->{uncertain} ? '?' : '';
354        $rs = $node->node_name;  
355        $node = $node->parent_node;      $out->start_tag ('td', class => 'subrow') unless $x->{is_total};
356      } elsif ($node->node_type == 2) {  
357        $rs = '@' . $node->node_name;      ## Layer name
358        $node = $node->owner_element;      $out->start_tag ('th', colspan => $x->{is_total} ? 2 : 1,
359      } elsif ($node->node_type == 3) {                       scope => 'row');
360        $rs = '"' . $node->data . '"';      if (defined $x->{target} and
361        $node = $node->parent_node;          ($x->{status}->{must} or $x->{status}->{should} or
362      } elsif ($node->node_type == 9) {           $x->{status}->{warning} or $x->{status}->{info} or
363        @r = ('') unless @r;           $x->{status}->{uncertain})) {
364        $rs = '';        $out->xref ($x->{label}, target => $x->{target});
365        $node = $node->parent_node;      } else {
366      } else {        $out->nl_text ($x->{label});
367        $rs = '#' . $node->node_type;      }
368        $node = $node->parent_node;  
369        ## MUST-level errors
370        $out->start_tag ('td', class => $x->{status}->{must} ? 'must-errors' : '');
371        if ($x->{status}->{applicable}) {
372          $out->text (($x->{status}->{must} or 0) . $uncertain);
373        } else {
374          $out->nl_text ('N/A');
375        }
376    
377        ## SHOULD-level errors
378        $out->start_tag ('td',
379                         class => $x->{status}->{should} ? 'should-errors' : '');
380        if ($x->{status}->{applicable}) {
381          $out->text (($x->{status}->{should} or 0) . $uncertain);
382        } else {
383          $out->nl_text ('N/A');
384        }
385    
386        ## Warnings
387        $out->start_tag ('td', class => $x->{status}->{warning} ? 'warnings' : '');
388        if ($x->{status}->{applicable}) {
389          $out->text (($x->{status}->{warning} or 0) . $uncertain);
390        } else {
391          $out->nl_text ('N/A');
392        }
393    
394        ## Informations
395        $out->start_tag ('td', class => $x->{status}->{info} ? 'infos' : '');
396        if ($x->{status}->{applicable}) {
397          $out->text (($x->{status}->{info} or 0) . $uncertain);
398        } else {
399          $out->nl_text ('N/A');
400      }      }
401      unshift @r, $rs;  
402        ## Score
403        $out->start_tag ('td',
404                         class => $x->{status}->{must} ? 'score must-errors' :
405                                  $x->{status}->{should} ? 'score should-errors' :
406                                  'score');
407        
408        my $max_score = $x->{score_base};
409        $max_score -= $x->{status}->{must} * $score_unit;
410        my $min_score = $max_score;
411        $min_score -= $x->{status}->{should} * $score_unit;
412    
413        $out->start_tag ('strong');
414        if ($x->{status}->{uncertain}) {
415          $out->html ('&#x2212;&#x221E; '); # negative inifinity
416          $out->nl_text ('...');
417          $out->html ($max_score < 0 ?
418                      ' &#x2212;' . substr ($max_score, 1) : ' ' . $max_score);
419        } elsif ($min_score != $max_score) {
420          $out->html ($min_score < 0 ?
421                      '&#x2212;' . substr ($min_score, 1) . ' ': $min_score . ' ');
422          $out->nl_text ('...');
423          $out->html ($max_score < 0 ?
424                      ' &#x2212;' . substr ($max_score, 1) : ' ' . $max_score);
425        } else {
426          $out->html ($max_score < 0 ?
427                      '&#x2212;' . substr ($max_score, 1) : $max_score);
428        }
429        $out->end_tag ('strong');
430    
431        $out->text (' / ' . $x->{score_base});
432    }    }
433    return join '/', @r;    
434  } # get_node_path    $out->end_tag ('table');
435    
436  use Scalar::Util qw/refaddr/;    my $parent = $self->parent_result;
437      if ($parent) {
438        $global_status->{input} = $out->input;
439        push @{$parent->{subdoc_results}}, $global_status;
440      }
441    
442  sub get_node_link ($$) {    $out->nl_text ('This checker is work in progress.');
443    my $self = shift;    $out->end_section;
444    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  
445    
446  1;  1;

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

admin@suikawiki.org
ViewVC Help
Powered by ViewVC 1.1.24