Changeset 1070

Timestamp:

06/12/07 22:47:03 (1 year ago)

Author:

dom

Message:

Add general validation framework, and add test for lat/long and os_x/os_y (closes #22)

Files:

• trunk/Changes (modified) (1 diff)
• trunk/lib/OpenGuides.pm (modified) (4 diffs)
• trunk/lib/OpenGuides/Utils.pm (modified) (1 diff)
• trunk/t/17_commit_node.t (modified) (2 diffs)
• trunk/templates/edit_form.tt (modified) (1 diff)

trunk/Changes

@@ -19 +19 @@
-        Added new div#nonexistent_node_message for displaying message when
-          someone tries to view a nonexistent node.
+        Validate input geodata (#22)
-
-0.60    13 May 2007

trunk/lib/OpenGuides.pm

@@ -460 +460 @@
-  $guide->display_edit_form(
-                             id => "Vivat Bacchus",
+                             vars => \%vars,
+                             content => $content,
+                             metadata => \%metadata,
+                             checksum => $checksum
-                           );
-
@@ -465 +469 @@
-C<return_output> parameter can be used to return the output instead of
-printing it to STDOUT.
+
+If this is to redisplay an existing edit, the content, metadata
+and checksum may be supplied in those arguments
+
+Extra template variables may be supplied in the vars argument
-
-=cut
@@ -500 +509 @@
-                    deter_robots    => 1,
-    );
+
+    # Override some things if we were supplied with them
+    $tt_vars{content} = $args{content} if $args{content};
+    $tt_vars{checksum} = $args{checksum} if $args{checksum};
+    if (defined $args{vars}) {
+        my %supplied_vars = %{$args{vars}};
+        foreach my $key ( keys %supplied_vars ) {
+            $tt_vars{$key} = $supplied_vars{$key};
+        }
+    }
+    if (defined $args{metadata}) {
+        my %supplied_metadata = %{$args{metadata}};
+        foreach my $key ( keys %supplied_metadata ) {
+            $tt_vars{$key} = $supplied_metadata{$key};
+        }
+    }
-
-    my $output = $self->process_template(
@@ -1341 +1366 @@
-                                    : 0;
-
+    # General validation
+    my $fails = OpenGuides::Utils->validate_edit(
+        cgi_obj  => $q
+    );
+
+    if ( scalar @{$fails} ) {
+        my %vars = (
+            validate_failed => $fails
+        );
+
+        my $output = $self->display_edit_form(
+                           id            => $node,
+                           content       => CGI->escapeHTML($content),
+                           metadata      => \%new_metadata,
+                           vars          => \%vars,
+                           checksum      => CGI->escapeHTML($checksum),
+                           return_output => 1
+        );
+
+        return $output if $return_output;
+        print $output;
+        return;
+    }
+
-    # If we can, check to see if this edit looks like spam.
-    my $spam_detector = $config->spam_detector_module;

trunk/lib/OpenGuides/Utils.pm

@@ -356 +356 @@
-}
-
+=item B<validate_edit>
+
+    my $fails = OpenGuides::Utils->validate_edit(
+        id       => $node,
+        cgi_obj  => $q
+    );
+
+Checks supplied content for general validity. If anything is invalid,
+returns an array ref of errors to report to the user.
+
+=cut
+
+sub validate_edit {
+    my ( $self, %args ) = @_;
+    my $q = $args{cgi_obj};
+    my @fails;
+    push @fails, "Content missing" unless $q;
+    return \@fails if @fails;
+
+    # Now do our real validation
+    # Numeric tests
+    foreach my $var (qw(os_x os_y)) {
+        if ($q->param($var) and $q->param($var) !~ /^-?\d+$/) {
+            push @fails, "$var must be integer, was: " . $q->param($var);
+        }
+    }
+
+    foreach my $var (qw(latitude longitude)) {
+        if ($q->param($var) and $q->param($var) !~ /^-?\d+\.?(\d+)?$/) {
+            push @fails, "$var must be numeric, was: " . $q->param($var);
+        }
+    }
+
+    return \@fails;
+
+};
+
-=back
-

trunk/t/17_commit_node.t

@@ -19 +19 @@
-
-
-5
+7
-
-# Clear out the database from any previous runs.
@@ -98 +98 @@
-is( $node{version}, 2, "First version" );
-is( $node{metadata}->{edit_type}[0], "Normal edit", "Right edit type" );
+
+# Now try to commit some invalid data, and make sure we get an edit form back
+$q = CGI->new;
+$q->param( -name => "content", -value => "foo" );
+$q->param( -name => "categories", -value => "" );
+$q->param( -name => "locales", -value => "" );
+$q->param( -name => "phone", -value => "" );
+$q->param( -name => "fax", -value => "" );
+$q->param( -name => "website", -value => "" );
+$q->param( -name => "hours_text", -value => "" );
+$q->param( -name => "address", -value => "" );
+$q->param( -name => "postcode", -value => "" );
+$q->param( -name => "map_link", -value => "" );
+$q->param( -name => "os_x", -value => "fooooo" );
+$q->param( -name => "os_y", -value => "" );
+$q->param( -name => "username", -value => "bob" );
+$q->param( -name => "comment", -value => "foo" );
+$q->param( -name => "node_image", -value => "image" );
+$q->param( -name => "edit_type", -value => "Minor tidying" );
+
+$output = $guide->commit_node(
+                                return_output => 1,
+                                id => "Wombats again",
+                                cgi_obj => $q,
+                             );
+
+like( $output, qr/Your input was invalid/,
+    "Edit form displayed and invalid input message shown if invalid input" );
+
+like( $output, qr/os_x must be integer/,
+    "Edit form displayed and os_x integer message displayed" );

trunk/templates/edit_form.tt

@@ -10 +10 @@
-      You will need to manually merge your changes into the new version.
-    </div>
+  [% END %]
+
+  [% IF validate_failed %]
+    <div class="warning_text">
+      <p>
+        Your input was invalid:
+      </p>
+      <ul>
+      [% FOREACH error = validate_failed %] 
+        <li>[% error %]</li>
+      [% END %]
+      </ul>
+      <p>
+        Please correct your input data and try again.
+      </p>
-  [% END %]
-