Changeset 413

Timestamp:

11/03/08 13:48:54 (3 years ago)

Author:

CrawfordCurrie

Message:

Item67: a missing form definition would make a topic uneditable

Location:

branches/Release04x02

Files:

• lib/TWiki/Form.pm (modified) (4 diffs)
• lib/TWiki/Form/FieldDefinition.pm (modified) (1 diff)
• lib/TWiki/Meta.pm (modified) (1 diff)
• lib/TWiki/UI/Edit.pm (modified) (1 diff)
• lib/TWiki/UI/Save.pm (modified) (1 diff)
• twikiplugins/UnitTestContrib/test/unit/FormDefTests.pm (modified) (1 diff)

branches/Release04x02/lib/TWiki/Form.pm

@@ -44 +44 @@
 =pod
 
----++ ClassMethod new ( $session, $web, $form, $def )
+---++ ClassMethod new ( $session, $web, $form, \@def )
 
 Looks up a form in the session object or, if it hasn't been read yet,
 reads it frm the form definition topic on disc.
-   * $web - default web to recover form from, if $form doesn't specify a web
-   * =$form= - topic name to read form definition from
-   * =$def= - optional. a reference to a list of field definitions. if present,
-              these definitions will be used, rather than those in =$form=.
+   * =$web= - default web to recover form from, if =$form= doesn't
+     specify a web
+   * =$form= - name of the form
+   * =\@def= - optional. A reference to a list of field definitions.
+     If present, these definitions will be used, rather than any read from
+     the form definition topic. Note that this array should not be modified
+     again after being passed into this constructor (it is not copied).
 
 May throw TWiki::OopsException
@@ -81 +84 @@
 
             # Read topic that defines the form
-            unless ( $store->topicExists( $web, $form ) ) {
+            if ( $store->topicExists( $web, $form ) ) {
+                my ( $meta, $text ) =
+                  $store->readTopic( $session->{user}, $web, $form, undef );
+
+                $this->{fields} = _parseFormDefinition( $this, $meta, $text );
+            }
+            else {
+                delete $session->{forms}->{"$web.$form"};
                 return undef;
             }
-            my ( $meta, $text ) =
-              $store->readTopic( $session->{user}, $web, $form, undef );
-
-            $this->{fields} = _parseFormDefinition( $this, $meta, $text );
-
+        }
+        elsif ( ref($def) eq 'ARRAY' ) {
+            $this->{fields} = $def;
         }
         else {
 
-            $this->{fields} = $def;
-
+            # TWiki::Meta object
+            $this->{fields} = $this->_extractPseudoFieldDefs($def);
         }
     }
@@ -182 +190 @@
             $vals =~ s/^\s+//g;
             $vals =~ s/\s+$//g;
-
-            # SMELL: This expansion of $users is undocumented, AFAICT not
-            # used, and downright *dangerous* (it won't work with a non-TWiki
-            # user mapping for example) so in the interests of good hygiene,
-            # I have removed it (CC, 30 Jun 07).
-            #if( $vals eq '$users' ) {
-            #    $vals = $TWiki::cfg{UsersWebName} . '.' .
-            #      join( ", ${TWiki::cfg{UsersWebName}}.",
-            #        ( $store->getTopicNames( $TWiki::cfg{UsersWebName} )));
-            #}
 
             $tooltip ||= '';
@@ -566 +564 @@
 }
 
+# extractPseudoFieldDefs( $meta ) -> $fieldDefs
+# Examine the FIELDs in $meta and reverse-engineer a set of field
+# definitions that can be used to construct a new "pseudo-form". This
+# fake form can be used to support editing of topics that have an attached
+# form that has no definition topic.
+sub _extractPseudoFieldDefs {
+    my ( $this, $meta ) = @_;
+    my @fields = $meta->find('FIELD');
+    my @fieldDefs;
+    require TWiki::Form::FieldDefinition;
+    foreach my $field (@fields) {
+
+        # Fields are name, value, title, but there is no other type
+        # information so we have to treat them all as "text" :-(
+        my $fieldDef = new TWiki::Form::FieldDefinition(
+            session    => $this->{session},
+            name       => $field->{name},
+            title      => $field->{title} || $field->{name},
+            attributes => $field->{attributes} || ''
+        );
+        push( @fieldDefs, $fieldDef );
+    }
+    return \@fieldDefs;
+}
+
 1;
 

branches/Release04x02/lib/TWiki/Form/FieldDefinition.pm

@@ -36 +36 @@
     $attrs{attributes} ||= '';
     $attrs{type}       ||= '';    # default
+    $attrs{size}       ||= '';
     $attrs{size} =~ s/^\s*//;
     $attrs{size} =~ s/\s*$//;

branches/Release04x02/lib/TWiki/Meta.pm

@@ -628 +628 @@
     }
     else {
-        return CGI::span( { class => 'twikiAlert' },
-            "Form definition '$fname' not found" );
+
+        # Make pseudo-form from field data
+        $form =
+          new TWiki::Form( $this->{_session}, $this->{_web}, $fname, $this );
+        return CGI::span(
+            { class => 'twikiAlert' },
+            "%MAKETEXT{\"Form definition '[_1]' not found\" args=\"$fname\"}%"
+        ) . $form->renderForDisplay($this);
     }
 }

branches/Release04x02/lib/TWiki/UI/Edit.pm

@@ -351 +351 @@
         require TWiki::Form;
         my $formDef = new TWiki::Form( $session, $templateWeb, $form );
-        unless ($formDef) {
-            throw TWiki::OopsException(
-                'attention',
-                def    => 'no_form_def',
-                web    => $session->{webName},
-                topic  => $session->{topicName},
-                params => [ $templateWeb, $form ]
-            );
-        }
+        if ( !$formDef ) {
+
+            # Reverse-engineer a form definition from the meta-data.
+            $formDef = new TWiki::Form( $session, $templateWeb, $form, $meta );
+        }
+        # Update with field values from the query
+
         $formDef->getFieldValuesFromQuery( $session->{cgiQuery}, $meta );
 

branches/Release04x02/lib/TWiki/UI/Save.pm

@@ -226 +226 @@
         $formDef = new TWiki::Form( $session, $webName, $formName );
         unless ($formDef) {
-            throw TWiki::OopsException(
-                'attention',
-                def    => 'no_form_def',
-                web    => $session->{webName},
-                topic  => $session->{topicName},
-                params => [ $webName, $formName ]
-            );
+            unless ($prevMeta) {
+                throw TWiki::OopsException(
+                    'attention',
+                    def    => 'no_form_def',
+                    web    => $session->{webName},
+                    topic  => $session->{topicName},
+                    params => [ $webName, $formName ]
+                );
+            }
+
+            # Recreate the form fields from the previous rev of the topic.
+            $formDef =
+              new TWiki::Form( $session, $webName, $formName, $prevMeta );
         }
         $newMeta->put( 'FORM', { name => $formName } );

branches/Release04x02/twikiplugins/UnitTestContrib/test/unit/FormDefTests.pm

@@ -179 +179 @@
 }
 
+sub test_makeFromMeta {
+    my $this = shift;
+    $this->{twiki}->{store}->saveTopic(
+        $this->{twiki}->{user}, $this->{test_web}, 'SplodgeOne', <<FORM);
+%META:FORM{name="NonExistantForm"}%
+%META:FIELD{name="Ecks" attributes="" title="X" value="Blah"}%
+FORM
+    my ($meta, $text) =
+      $this->{twiki}->{store}->readTopic(
+          undef, $this->{test_web}, 'SplodgeOne');
+    my $form = new TWiki::Form(
+        $this->{twiki}, $this->{test_web}, 'NonExistantForm', $meta);
+    my $f = $form->getField('Ecks');
+    $this->assert_str_equals('', $f->getDefaultValue());
+    $this->assert_str_equals('Ecks', $f->{name});
+    $this->assert_str_equals('X', $f->{title});
+    $this->assert_str_equals('', $f->{size});
+}
+
 1;