Changeset 858

Timestamp:

11/23/08 00:47:55 (3 years ago)

Author:

ArthurClemens

Message:

Item244: improve code for checking nonwikiword flags; added code to apply this check for copying a topic as introduced with Item1873

Location:

trunk/core

Files:

• lib/Foswiki/UI/Manage.pm (modified) (9 diffs)
• templates/messages.tmpl (modified) (1 diff)
• templates/oopsmore.tmpl (modified) (1 diff)
• test/unit/ManageDotPmTests.pm (added)

trunk/core/lib/Foswiki/UI/Manage.pm

@@ -61 +61 @@
     elsif ( $action eq 'restoreRevision' ) {
         _restoreRevision($session);
+    }
+    elsif ( $action eq 'copy' ) {
+        _copyTopic($session);
     }
     elsif ($action) {
@@ -297 +300 @@
     my $breakLock   = $query->param('breaklock');
 
-    my $confirm            = $query->param('confirm');
-    my $doAllowNonWikiWord = $query->param('nonwikiword') || '';
-    my $store              = $session->{store};
+    my $confirm          = $query->param('confirm');
+    my $nonWikiWordParam = $query->param('nonwikiword') || '';
+    my $store            = $session->{store};
 
     $newTopic =~ s/\s//go;
@@ -324 +327 @@
     }
 
-    if ( $newTopic && !Foswiki::isValidWikiWord($newTopic) ) {
-        unless ($doAllowNonWikiWord) {
+    if ($newTopic) {
+        if ( !_isValidTopicName( $newTopic, $nonWikiWordParam ) ) {
             throw Foswiki::OopsException(
                 'attention',
@@ -334 +337 @@
             );
         }
-
-        # Filter out dangerous characters (. and / may cause
-        # issues with pathnames
-        $newTopic =~ s![./]!_!g;
-        $newTopic =~ s/($Foswiki::cfg{NameFilter})//go;
+        $newTopic = _safeTopicName($newTopic);
     }
 
@@ -408 +407 @@
             $session->{user} );
         _newTopicScreen( $session, $oldWeb, $oldTopic, $newWeb, $newTopic,
-            $attachment, $confirm, $doAllowNonWikiWord );
+            $attachment, $confirm, $nonWikiWordParam );
         return;
     }
@@ -468 +467 @@
     #follow redirectto=
     $session->redirect( $new_url, undef, 1 );
+}
+
+=pod
+
+---++ StaticMethod _isValidTopicName( $topic, $nonWikiWordParam ) -> $boolean
+
+Checks whether a topic name is valid. This may depend on the setting of session param 'nonwikiword'.
+
+Usage:
+        my $isValidName = _isValidTopicName( $newTopic, $query->param('nonwikiword') );
+
+=cut
+
+sub _isValidTopicName {
+    my ( $topic, $nonWikiWordParam ) = @_;
+
+    my $nonWikiWord = $nonWikiWordParam || 0;
+    my $doAllowNonWikiWord = Foswiki::isTrue($nonWikiWord);
+
+    return 0 if !$topic;
+    return 0 if ( !Foswiki::isValidTopicName($topic) && !$doAllowNonWikiWord );
+    return 1 if ( Foswiki::isValidTopicName($topic) );
+
+    return 1;
+}
+
+=pod
+
+---++ StaticMethod _safeTopicName( $topic ) -> $topic
+
+Filter out dangerous characters . and / may cause issues with pathnames.
+        
+=cut
+
+sub _safeTopicName {
+    my ($topic) = @_;
+
+    $topic =~ s/\s//go;
+    $topic = ucfirst $topic;    # Item3270
+    $topic =~ s![./]!_!g;
+    $topic =~ s/($Foswiki::cfg{NameFilter})//go;
+
+    return $topic;
+}
+
+=pod
+
+---++ StaticMethod _copyTopic()
+
+Copies a topic to new topic with name passed in query param 'newtopic'.
+Redirects to edit screen.
+
+=cut
+
+
+sub _copyTopic {
+    my ($session) = @_;
+
+    my $query = $session->{request};
+    my $newTopic = $query->param('newtopic') || '';
+
+    # topic must not be empty
+    if ( !$newTopic ) {
+        throw Foswiki::OopsException(
+            'attention',
+            web    => undef,
+            topic  => $newTopic,
+            def    => 'empty_topic_name',
+            params => undef
+        );
+    }
+
+    my $oldWeb           = $session->{webName};
+    my $oldTopic         = $session->{topicName};
+    my $nonWikiWordParam = $query->param('nonwikiword') || '';
+
+    if ($newTopic) {
+        # topic must be valid
+        if ( !_isValidTopicName( $newTopic, $nonWikiWordParam ) ) {
+            throw Foswiki::OopsException(
+                'attention',
+                web    => $oldWeb,
+                topic  => $oldTopic,
+                def    => 'not_wikiword',
+                params => [$newTopic]
+            );
+        }
+        $newTopic = _safeTopicName($newTopic);
+    }
+    
+    # untaint new topic name
+    use Foswiki::Sandbox;
+    $session->{topicName} = Foswiki::Sandbox::untaintUnchecked($newTopic);
+
+    require Foswiki::UI::Edit;
+    Foswiki::UI::Edit::edit($session);
 }
 
@@ -1225 +1320 @@
 
     $tmpl =
-      $session->handleCommonTags( $tmpl, $oldWeb, $Foswiki::cfg{HomeTopicName} );
+      $session->handleCommonTags( $tmpl, $oldWeb,
+        $Foswiki::cfg{HomeTopicName} );
     $tmpl =
       $session->renderer->getRenderedVersion( $tmpl, $oldWeb,
@@ -1341 +1437 @@
                     \&Foswiki::Render::replaceTopicReferences, $options );
                 $meta->forEachSelectedValue(
-                    qw/^(FIELD|FORM|TOPICPARENT)$/,          undef,
+                    qw/^(FIELD|FORM|TOPICPARENT)$/,            undef,
                     \&Foswiki::Render::replaceTopicReferences, $options
                 );
@@ -1386 +1482 @@
                     \&Foswiki::Render::replaceWebReferences, $options );
                 $meta->forEachSelectedValue(
-                    qw/^(FIELD|FORM|TOPICPARENT)$/,        undef,
+                    qw/^(FIELD|FORM|TOPICPARENT)$/,          undef,
                     \&Foswiki::Render::replaceWebReferences, $options
                 );

trunk/core/templates/messages.tmpl

@@ -88 +88 @@
 %MAKETEXT{"Please go back in your browser and choose a topic name that is a [_1].WikiWord or check the allow non-Wiki Word box" args="%SYSTEMWEB%"}%
 %TMPL:END%
+
+%TMPL:DEF{"empty_topic_name"}%
+---++ %MAKETEXT{"You must pass a topic name."}%
+%MAKETEXT{"The name of the topic must not be empty." args="%PARAM1%"}%
+
+%MAKETEXT{"Please go back in your browser and try again."}%
+%TMPL:END%
+
 %TMPL:DEF{"rename_err"}%
 %MAKETEXT{"During rename of topic [_1] to [_2] an error ([_3]) was found. Please notify your [_4] administrator."  args="<nop>%WEB%.<nop>%TOPIC%,<nop>%PARAM2%,%PARAM1%,%WIKITOOLNAME%"}%

trunk/core/templates/oopsmore.tmpl

@@ -20 +20 @@
 %MAKETEXT{"Copy text and form data to a new topic (no attachments will be copied though)."}%
 
-<form action="%SCRIPTURL{edit}%/%WEB%/">
-%MAKETEXT{"Name of copy:"}% <input type="text" name="topic" class="twikiInputField" value="%TOPIC%Copy" size="30"> <input type="submit" class="twikiButton" value="Clone" /> <span class="twikiGrayText">%MAKETEXT{"You will be able to review the copied topic before saving"}%</span>
+<form action="%SCRIPTURL{manage}%/%WEB%/">
+%MAKETEXT{"Name of copy:"}% <input type="text" name="newtopic" class="twikiInputField" value="%TOPIC%Copy" size="30"> <input type="submit" class="twikiButton" value="Clone" /> <span class="twikiGrayText">%MAKETEXT{"You will be able to review the copied topic before saving"}%</span>
+%TMPL:P{"nonwikiword"}%
+<input type="hidden" name="action" value="copy" />
 <input type="hidden" name="onlynewtopic" value="on" />
 <input type="hidden" name="templatetopic" value="%TOPIC%" />