--- test/html-webhacc/WebHACC/Result.pm 2008/07/20 14:58:24 1.1
+++ test/html-webhacc/WebHACC/Result.pm 2008/08/15 16:03:46 1.13
@@ -2,30 +2,105 @@
use strict;
sub new ($) {
- return bless {}, shift;
+ return bless {
+ global_status => 'conforming',
+ # or, 'should-error', 'non-conforming', 'uncertain'
+ subdoc_results => [],
+ }, shift;
} # new
+sub output ($;$) {
+ if (@_ > 1) {
+ if (defined $_[1]) {
+ $_[0]->{output} = $_[1];
+ } else {
+ delete $_[0]->{output};
+ }
+ }
+
+ return $_[0]->{output};
+} # output
+
+sub parent_result ($;$) {
+ if (@_ > 1) {
+ if (defined $_[1]) {
+ $_[0]->{parent_result} = $_[1];
+ } else {
+ delete $_[0]->{parent_result};
+ }
+ }
-sub get_error_label ($$) {
+ return $_[0]->{parent_result};
+} # parent_result
+
+sub layer_applicable ($$) {
+ my $self = shift;
+ my $layer = shift;
+ $self->{layers}->{$layer}->{applicable} = 1;
+} # layer_applicable
+
+sub layer_uncertain ($$) {
my $self = shift;
- my ($input, $err) = @_;
+ my $layer = shift;
+ $self->{layers}->{$layer}->{uncertain} ||= 1;
+ $self->{layers}->{$layer}->{applicable} = 1;
+ $self->{global_status} = 'uncertain'
+ unless $self->{global_status} eq 'non-conforming';
+} # layer_uncertain
+
+sub add_error ($%) {
+ my ($self, %opt) = @_;
+
+ my $out = $self->output;
+ $out->has_error (1);
+
+ my $error_level = $opt{level};
+ if (not defined $error_level) {
+ $error_level = 'm'; ## NOTE: Unknown - an error of the implementation
+ } elsif ({
+ m => 1, s => 1, w => 1, i => 1, u => 1,
+ }->{$error_level}) {
+ #
+ } else {
+ $error_level = 'm'; ## NOTE: Unknown - an error of the implementation
+ }
- my $r = '';
+ my $error_layer = $opt{layer};
+ if (not defined $error_layer) {
+ $error_layer = 'syntax'; ## NOTE: Unknown - an error of the implementation
+ } elsif ({
+ transfer => 1,
+ encode => 1,
+ charset => 1,
+ syntax => 1,
+ structure => 1,
+ semantics => 1,
+ }->{$error_layer}) {
+ #
+ } else {
+ $error_layer = 'syntax'; ## NOTE: Unknown - an error of the implementation
+ }
+
+ my $class = qq[level-$error_level layer-$error_layer];
+
+ ## Line & column numbers (prepare values)
my $line;
my $column;
- if (defined $err->{node}) {
- $line = $err->{node}->get_user_data ('manakai_source_line');
+ if (defined $opt{node}) {
+ $line = $opt{node}->get_user_data ('manakai_source_line');
if (defined $line) {
- $column = $err->{node}->get_user_data ('manakai_source_column');
- } else {
- if ($err->{node}->node_type == $err->{node}->ATTRIBUTE_NODE) {
- my $owner = $err->{node}->owner_element;
- $line = $owner->get_user_data ('manakai_source_line');
- $column = $owner->get_user_data ('manakai_source_column');
+ $column = $opt{node}->get_user_data ('manakai_source_column');
+ } elsif ($opt{node}->isa ('Message::IF::Node')) {
+ if ($opt{node}->node_type == $opt{node}->ATTRIBUTE_NODE) {
+ my $owner = $opt{node}->owner_element;
+ if ($owner) {
+ $line = $owner->get_user_data ('manakai_source_line');
+ $column = $owner->get_user_data ('manakai_source_column');
+ }
} else {
- my $parent = $err->{node}->parent_node;
+ my $parent = $opt{node}->parent_node;
if ($parent) {
$line = $parent->get_user_data ('manakai_source_line');
$column = $parent->get_user_data ('manakai_source_column');
@@ -34,110 +109,338 @@
}
}
unless (defined $line) {
- if (defined $err->{token} and defined $err->{token}->{line}) {
- $line = $err->{token}->{line};
- $column = $err->{token}->{column};
- } elsif (defined $err->{line}) {
- $line = $err->{line};
- $column = $err->{column};
+ if (defined $opt{token} and defined $opt{token}->{line}) {
+ $line = $opt{token}->{line};
+ $column = $opt{token}->{column};
+ } elsif (defined $opt{line}) {
+ $line = $opt{line};
+ $column = $opt{column};
}
}
+ $line = $line - 1 || 1
+ if defined $line and not (defined $column and $column > 0);
+
+ $out->start_tag ('dt', class => $class,
+ 'data-type' => $opt{type},
+ 'data-level' => $error_level,
+ 'data-layer' => $error_layer,
+ ($line ? ('data-line' => $line) : ()),
+ ($column ? ('data-column' => $column) : ()));
+ my $has_location;
+
+ ## URL
+
+ if (defined $opt{url}) {
+ $out->url ($opt{url});
+ $has_location = 1;
+ }
+
+ ## Line & column numbers (real output)
if (defined $line) {
if (defined $column and $column > 0) {
- $r = qq[Line $line column $column];
+ $out->xref ('Line #', text => $line, target => 'line-' . $line);
+ $out->text (' ');
+ $out->nl_text ('column #', text => $column);
} else {
- $line = $line - 1 || 1;
- $r = qq[Line $line];
+ $out->xref ('Line #', text => $line, target => 'line-' . $line);
}
+ $has_location = 1;
}
- if (defined $err->{node}) {
- $r .= ' ' if length $r;
- $r .= $self->get_node_link ($input, $err->{node});
+ ## Node path
+
+ if (defined $opt{node}) {
+ $out->html (' ');
+ $out->node_link ($opt{node});
+ $has_location = 1;
}
- if (defined $err->{index}) {
- if (length $r) {
- $r .= ', Index ' . (0+$err->{index});
+ if (defined $opt{index}) {
+ if ($opt{index_has_link}) {
+ $out->html (' ');
+ $out->xref ('Index #', text => (0+$opt{index}),
+ target => 'index-' . (0+$opt{index}));
} else {
- $r .= "Index "
- . (0+$err->{index}) . '';
+ $out->html (' ');
+ $out->nl_text ('Index #', text => (0+$opt{index}));
}
+ $has_location = 1;
}
- if (defined $err->{value}) {
- $r .= ' ' if length $r; ## BUG: v must be escaped
- $r .= '
';
+ if (defined $opt{value}) {
+ $out->html (' ');
+ $out->code ($opt{value});
+ $has_location = 1;
}
- return $r;
-} # get_error_label
+ unless ($has_location) {
+ if (defined $opt{input}) {
+ if (defined $opt{input}->{container_node}) {
+ my $original_input = $out->input;
+ $out->input ($opt{input}->{parent_input});
+ $out->node_link ($opt{input}->{container_node});
+ $out->input ($original_input);
+ $has_location = 1;
+ } elsif (defined $opt{input}->{request_uri}) {
+ $out->url ($opt{input}->{request_uri});
+ $has_location = 1;
+ } elsif (defined $opt{input}->{uri}) {
+ $out->url ($opt{input}->{uri});
+ $has_location = 1;
+ }
+ }
+
+ unless ($has_location) {
+ $out->nl_text ('Unknown location');
+ }
+ }
+
+ $out->start_tag ('dd', class => $class);
+
+ ## Error level
+ $out->nl_text ('Error level ' . $error_level);
+ $out->text (': ');
+
+ ## Error message
+ my $error_type_text = $opt{type};
+ $out->nl_text ($error_type_text, node => $opt{node}, text => $opt{text},
+ value => $opt{value});
+
+ ## Additional error description
+ if (defined $opt{text}) { ## TODO: Remove this block once all errors are put into the catalog.
+ $out->html (' (' . ($err->{value}) . '
');
+ $out->text ($opt{text});
+ $out->html ('
)');
+ }
+
+ ## Link to a long description
-sub get_error_level_label ($) {
+ my $fragment = $opt{type};
+ $fragment =~ tr/ /-/;
+ $fragment = $out->encode_url_component ($fragment);
+ $out->text (' [');
+ $out->link ('Description', url => '../error-description#' . $fragment,
+ rel => 'help');
+ $out->text (']');
+
+ if ($error_level eq 'm') {
+ $self->{layers}->{$error_layer}->{must}++;
+ $self->{global_status} = 'non-conforming';
+ } elsif ($error_level eq 's') {
+ $self->{layers}->{$error_layer}->{should}++;
+ $self->{global_status} = 'should-error'
+ unless {'non-conforming' => 1,
+ uncertain => 1}->{$self->{global_status}};
+ } elsif ($error_level eq 'w') {
+ $self->{layers}->{$error_layer}->{warning}++;
+ } elsif ($error_level eq 'u') {
+ $self->{layers}->{$error_layer}->{uncertain}++;
+ $self->{global_status} = 'uncertain'
+ unless $self->{global_status} eq 'non-conforming';
+ } elsif ($error_level eq 'i') {
+ $self->{layers}->{$error_layer}->{info}++;
+ }
+} # add_error
+
+sub generate_result_section ($) {
my $self = shift;
- my $err = shift;
- my $r = '';
+ my $result = $self;
+
+ my $out = $result->output;
+
+ $out->start_section (role => 'result');
- if (not defined $err->{level} or $err->{level} eq 'm') {
- $r = qq[MUST-level
- error: ];
- } elsif ($err->{level} eq 's') {
- $r = qq[SHOULD-level
- error: ];
- } elsif ($err->{level} eq 'w') {
- $r = qq[Warning:
- ];
- } elsif ($err->{level} eq 'u' or $err->{level} eq 'unsupported') {
- $r = qq[Not
- supported: ];
- } elsif ($err->{level} eq 'i') {
- $r = qq[Information: ];
+ my $para_class = {
+ 'conforming' => 'result-para no-error',
+ 'should-error' => 'result-para should-errors',
+ 'non-conforming' => 'result-para must-errors',
+ 'uncertain' => 'result-para uncertain',
+ }->{$self->{global_status}};
+ $out->start_tag ('p', class => $para_class);
+ $out->nl_text ('Conformance is ' . $self->{global_status});
+ $out->end_tag ('p');
+
+ $out->html (qq[
]); + for ('Error level m', 'Error level s', 'Error level w', + 'Error level i', 'Score') { + $out->start_tag ('th'); + $out->nl_text ($_); + } + + my $maindoc_status = {must => 0, should => 0, warning => 0, info => 0, + uncertain => 0, applicable => 1}; + my $subdocs_status = {must => 0, should => 0, warning => 0, info => 0, + uncertain => 0, applicable => 1}; + my $global_status = {must => 0, should => 0, warning => 0, info => 0, + uncertain => 0, applicable => 1}; + + my $score_unit = 2; + + my @row = ( + sub { + $out->start_tag ('tbody'); + $out->start_tag ('tr'); + $out->start_tag ('th', colspan => 7, scope => 'col'); + $out->nl_text ('Main document'); + }, + {label => 'Transfer L.', status => $self->{layers}->{transfer}, + target => 'transfer-errors', score_base => 20, + parent_status => $maindoc_status}, + {label => 'Encode L.', status => $self->{layers}->{encode}, + target => 'parse-errors', score_base => 10, + parent_status => $maindoc_status}, + {label => 'Char L.', status => $self->{layers}->{charset}, + score_base => 10, + parent_status => $maindoc_status}, + {label => 'Syntax L.', status => $self->{layers}->{syntax}, + target => 'parse-errors', score_base => 20, + parent_status => $maindoc_status}, + {label => 'Structure L.', status => $self->{layers}->{structure}, + target => 'document-errors', score_base => 20, + parent_status => $maindoc_status}, + {label => 'Semantics L.', status => $self->{layers}->{semantics}, + score_base => 20, + parent_status => $maindoc_status}, + ); + + if (@{$self->{subdoc_results}}) { + push @row, {label => 'Subtotal', status => $maindoc_status, + score_base => 100, + parent_status => $global_status, is_total => 1}; + push @row, sub { + $out->start_tag ('tbody'); + $out->start_tag ('tr'); + $out->start_tag ('th', colspan => 7, scope => 'col'); + $out->nl_text ('Subdocuments'); + }; + for (@{$self->{subdoc_results}}) { + push @row, {label => '#' . $_->{input}->full_subdocument_index, + status => $_, + target => $_->{input}->id_prefix . 'result-summary', + score_base => 100, parent_status => $subdocs_status}; + } + push @row, {label => 'Subtotal', status => $subdocs_status, + score_base => 100 * @{$self->{subdoc_results}}, + parent_status => $global_status, is_total => 1}; } else { - my $elevel = htescape ($err->{level}); - $r = qq[$elevel: - ]; + $global_status = $maindoc_status; } - return $r; -} # get_error_level_label + push @row, sub { + $out->start_tag ('tfoot'); + }; + push @row, {label => 'Total', status => $global_status, + score_base => 100 * (@{$self->{subdoc_results}} + 1), + parent_status => {}, is_total => 1}; + + for my $x (@row) { + if (ref $x eq 'CODE') { + $x->(); + next; + } -sub get_node_path ($) { - my $self = shift; - my $node = shift; - my @r; - while (defined $node) { - my $rs; - if ($node->node_type == 1) { - $rs = $node->node_name; - $node = $node->parent_node; - } elsif ($node->node_type == 2) { - $rs = '@' . $node->node_name; - $node = $node->owner_element; - } elsif ($node->node_type == 3) { - $rs = '"' . $node->data . '"'; - $node = $node->parent_node; - } elsif ($node->node_type == 9) { - @r = ('') unless @r; - $rs = ''; - $node = $node->parent_node; - } else { - $rs = '#' . $node->node_type; - $node = $node->parent_node; + $x->{parent_status}->{$_} += $x->{status}->{$_} + for qw/must should warning info uncertain/; + + my $row_class = $x->{status}->{uncertain} ? 'uncertain' : ''; + $row_class .= ' total' if $x->{is_total}; + $out->start_tag ('tr', class => $row_class); + my $uncertain = $x->{status}->{uncertain} ? '?' : ''; + + $out->start_tag ('td', class => 'subrow') unless $x->{is_total}; + + ## Layer name + $out->start_tag ('th', colspan => $x->{is_total} ? 2 : 1, + scope => 'row'); + if (defined $x->{target} and + ($x->{status}->{must} or $x->{status}->{should} or + $x->{status}->{warning} or $x->{status}->{info} or + $x->{status}->{uncertain})) { + $out->xref ($x->{label}, target => $x->{target}); + } else { + $out->nl_text ($x->{label}); + } + + ## MUST-level errors + $out->start_tag ('td', class => $x->{status}->{must} ? 'must-errors' : ''); + if ($x->{status}->{applicable}) { + $out->text (($x->{status}->{must} or 0) . $uncertain); + } else { + $out->nl_text ('N/A'); + } + + ## SHOULD-level errors + $out->start_tag ('td', + class => $x->{status}->{should} ? 'should-errors' : ''); + if ($x->{status}->{applicable}) { + $out->text (($x->{status}->{should} or 0) . $uncertain); + } else { + $out->nl_text ('N/A'); + } + + ## Warnings + $out->start_tag ('td', class => $x->{status}->{warning} ? 'warnings' : ''); + if ($x->{status}->{applicable}) { + $out->text (($x->{status}->{warning} or 0) . $uncertain); + } else { + $out->nl_text ('N/A'); + } + + ## Informations + $out->start_tag ('td', class => $x->{status}->{info} ? 'infos' : ''); + if ($x->{status}->{applicable}) { + $out->text (($x->{status}->{info} or 0) . $uncertain); + } else { + $out->nl_text ('N/A'); } - unshift @r, $rs; + + ## Score + $out->start_tag ('td', + class => $x->{status}->{must} ? 'score must-errors' : + $x->{status}->{should} ? 'score should-errors' : + 'score'); + + my $max_score = $x->{score_base}; + $max_score -= $x->{status}->{must} * $score_unit; + my $min_score = $max_score; + $min_score -= $x->{status}->{should} * $score_unit; + + $out->start_tag ('strong'); + if ($x->{status}->{uncertain}) { + $out->html ('−∞ '); # negative inifinity + $out->nl_text ('...'); + $out->html ($max_score < 0 ? + ' −' . substr ($max_score, 1) : ' ' . $max_score); + } elsif ($min_score != $max_score) { + $out->html ($min_score < 0 ? + '−' . substr ($min_score, 1) . ' ': $min_score . ' '); + $out->nl_text ('...'); + $out->html ($max_score < 0 ? + ' −' . substr ($max_score, 1) : ' ' . $max_score); + } else { + $out->html ($max_score < 0 ? + '−' . substr ($max_score, 1) : $max_score); + } + $out->end_tag ('strong'); + + $out->text (' / ' . $x->{score_base}); } - return join '/', @r; -} # get_node_path + + $out->end_tag ('table'); -use Scalar::Util qw/refaddr/; + my $parent = $self->parent_result; + if ($parent) { + $global_status->{input} = $out->input; + push @{$parent->{subdoc_results}}, $global_status; + } -sub get_node_link ($$) { - my $self = shift; - return qq[] . - ($self->get_node_path ($_[1])) . qq[]; - ## BUG: ^ must be escaped -} # get_node_link + $out->nl_text ('This checker is work in progress.'); + $out->end_section; +} # generate_result_section 1; |
---|