Changeset 974

Timestamp:

11/26/08 12:42:53 (3 years ago)

Author:

CrawfordCurrie

Message:

Item175: detox various environment variables, constants, and the cookie name

Location:

trunk

Files:

• ActionTrackerPlugin/lib/TWiki/Plugins/ActionTrackerPlugin.pm (modified) (1 diff)
• PublishContrib/lib/TWiki/Contrib/Publish.pm (modified) (2 diffs)
• TestFixturePlugin/lib/TWiki/Plugins/TestFixturePlugin.pm (modified) (1 diff)
• UnitTestContrib/test/unit/FoswikiSuite.pm (modified) (1 diff)
• UnitTestContrib/test/unit/FoswikiTestCase.pm (modified) (3 diffs)
• UnitTestContrib/test/unit/RequestTests.pm (modified) (1 diff)
• UnitTestContrib/test/unit/ResponseTests.pm (modified) (3 diffs)
• WysiwygPlugin/test/unit/WysiwygPlugin/TranslatorTests.pm (modified) (1 diff)
• core/lib/Assert.pm (modified) (3 diffs)
• core/lib/Foswiki.pm (modified) (2 diffs)
• core/lib/Foswiki/Configure/UI.pm (modified) (1 diff)
• core/lib/Foswiki/Engine/CGI.pm (modified) (1 diff)
• core/lib/Foswiki/Engine/CLI.pm (modified) (1 diff)
• core/lib/Foswiki/LoginManager.pm (modified) (2 diffs)
• core/lib/Foswiki/Request.pm (modified) (1 diff)
• core/lib/Monitor.pm (modified) (3 diffs)

trunk/ActionTrackerPlugin/lib/TWiki/Plugins/ActionTrackerPlugin.pm

@@ -65 +65 @@
     return unless _lazyInit($web, $topic);
 
-    my $debug = $ENV{TWIKI_ASSERTS} ? '_src' : '';
+    my $debug = '';
+    $debug = '_src' if DEBUG;
 
     TWiki::Func::addToHEAD('ACTIONTRACKERPLUGIN_CSS', <<HERE);

trunk/PublishContrib/lib/TWiki/Contrib/Publish.pm

@@ -478 +478 @@
     $header = TWiki::Func::renderText( $header, $this->{web} );
     $header =~ s/<nop>//go;
-    TWiki::Func::writeHeader($query);
+    TWiki::Func::writeHeader();
     _display $header;
 
@@ -600 +600 @@
     $query->param('topic', "$this->{web}.$topic");
 
-    # Create a new TWiki so that the contexts are correct. This is really,
-    # really inefficient, but is essential at the moment to maintain correct
-    # prefs
-    my $twiki = new TWiki($this->{publisher}, $query);
-    $TWiki::Plugins::SESSION = $twiki;
+    if (defined &TWiki::Func::pushTopicContext) {
+        TWiki::Func::pushTopicContext($this->{web}, $topic);
+    } else {
+        # Create a new TWiki so that the contexts are correct. This is really,
+        # really inefficient, but is essential to maintain correct prefs if
+        # we don't have a modern Func
+        my $twiki = new TWiki($this->{publisher}, $query);
+        $TWiki::Plugins::SESSION = $twiki;
+    }
 
     # Because of Item5388, we have to re-read the topic to get the

trunk/TestFixturePlugin/lib/TWiki/Plugins/TestFixturePlugin.pm

@@ -33 +33 @@
 #
 # DO NOT USE THIS PLUGIN IN A USER INSTALLATION. IT IS DESIGNED FOR
-# TWIKI CORE TESTING ONLY!!!
+# FOSWIKI CORE TESTING ONLY!!!
 #
 # The idea is that topics contain blocks marked by <!-- expected -->

trunk/UnitTestContrib/test/unit/FoswikiSuite.pm

@@ -30 +30 @@
     my $home = "../..";
     unless (-e "$home/lib/MANIFEST") {
-        $home = $ENV{TWIKI_HOME};
+        $home = $ENV{FOSWIKI_HOME};
     }
     require Cwd;

trunk/UnitTestContrib/test/unit/FoswikiTestCase.pm

@@ -20 +20 @@
 
 BEGIN {
-    push( @INC, "$ENV{TWIKI_HOME}/lib" ) if defined($ENV{TWIKI_HOME});
+    push( @INC, "$ENV{FOSWIKI_HOME}/lib" ) if defined($ENV{FOSWIKI_HOME});
     unshift @INC, '../../bin'; # SMELL: dodgy
     require 'setlib.cfg';
@@ -30 +30 @@
 # Temporary directory to store work files in (sessions, logs etc).
 # Will be cleaned up after running the tests unless the environment
-# variable TWIKI_DEBUG_KEEP is true
+# variable FOSWIKI_DEBUG_KEEP is true
 use File::Temp;
-my $cleanup  =  $ENV{TWIKI_DEBUG_KEEP} ? 0 : 1;
+my $cleanup  =  $ENV{FOSWIKI_DEBUG_KEEP} ? 0 : 1;
 
 sub new {
@@ -130 +130 @@
     }
     # then reenable only those listed in MANIFEST
-    if ($ENV{TWIKI_HOME} && -e "$ENV{TWIKI_HOME}/lib/MANIFEST") {
-        open(F, "$ENV{TWIKI_HOME}/lib/MANIFEST") || die $!;
+    if ($ENV{FOSWIKI_HOME} && -e "$ENV{FOSWIKI_HOME}/lib/MANIFEST") {
+        open(F, "$ENV{FOSWIKI_HOME}/lib/MANIFEST") || die $!;
     } else {
         open(F, "../../lib/MANIFEST") || die $!;

trunk/UnitTestContrib/test/unit/RequestTests.pm

@@ -99 +99 @@
         $req->action($_);
         $this->assert_str_equals($_, $req->action, 'Wrong action value');
-        $this->assert_str_equals($_, $ENV{TWIKI_ACTION}, 'Wrong TWIKI_ACTION environment');
+        $this->assert_str_equals($_, $ENV{FOSWIKI_ACTION}, 'Wrong FOSWIKI_ACTION environment');
     }
 }

trunk/UnitTestContrib/test/unit/ResponseTests.pm

@@ -56 +56 @@
         'f-o-o-bar'    => 'baz',
         'Set-COOKIe'   => [
-            'TWIKISID=4ed0fb8647881e17852dff882f0cfaa7; path=/',
+            'FOSWIKISID=4ed0fb8647881e17852dff882f0cfaa7; path=/',
             'SID=8f3d9cb028e4f7dabe435bcfc4905cda; path=/'
         ],
@@ -89 +89 @@
     $this->assert_deep_equals(
         [
-            'TWIKISID=4ed0fb8647881e17852dff882f0cfaa7; path=/',
+            'FOSWIKISID=4ed0fb8647881e17852dff882f0cfaa7; path=/',
             'SID=8f3d9cb028e4f7dabe435bcfc4905cda; path=/'
         ],
@@ -130 +130 @@
     require CGI::Cookie;
     my $c1 = new CGI::Cookie(
-        -name   => 'TWIKISID',
+        -name   => 'FOSWIKISID',
         -value  => '80eaee753351a6d4d050320ce4d60822',
         -domain => 'localhost'

trunk/WysiwygPlugin/test/unit/WysiwygPlugin/TranslatorTests.pm

@@ -21 +21 @@
 # Readers are invited to add more testcases.
 #
-# The tests require TWIKI_LIBS to include a pointer to the lib
+# The tests require FOSWIKI_LIBS to include a pointer to the lib
 # directory of a TWiki installation, so it can pick up the bits
 # of TWiki it needs to include.

trunk/core/lib/Assert.pm

@@ -14 +14 @@
 #
 # Usage is as for Carp::Assert except that you have to explicitly
-# enable asserts using the environment variable "TWIKI_ASSERTS"
-# add ENV{TWIKI_ASSERTS} = 1; to you bin/setlib.cfg or bin/LocalLib.cfg
+# enable asserts using the environment variable ENV{FOSWIKI_ASSERTS}
+# (or ENV{TWIKI_ASSERTS})
+# add ENV{FOSWIKI_ASSERTS} = 1; to you bin/setlib.cfg or bin/LocalLib.cfg
 
 use strict;
@@ -33 +34 @@
 sub ASSERTS_OFF() { 0 }    # CONSTANT
 
-# Export the proper DEBUG flag if TWIKI_ASSERTS is set,
+# Export the proper DEBUG flag if FOSWIKI_ASSERTS is set,
 # otherwise export noop versions of our routines
 sub noop { }
@@ -40 +41 @@
     no warnings 'redefine';
     no strict 'refs';
-    if ( $ENV{TWIKI_ASSERTS} ) {
+    if ( $ENV{FOSWIKI_ASSERTS} || $ENV{TWIKI_ASSERTS} ) {
         *DEBUG = *ASSERTS_ON;
         Assert->export_to_level( 1, @_ );

trunk/core/lib/Foswiki.pm

@@ -171 +171 @@
         # ASSERTs
         # ASSERTS are turned on by defining the environment variable
-        # TWIKI_ASSERTS. If ASSERTs are off, this is assumed to be a
+        # FOSWIKI_ASSERTS. If ASSERTs are off, this is assumed to be a
         # production environment, and no stack traces or paths are
         # output to the browser.
@@ -331 +331 @@
     $functionTags{WIKIWEBMASTERNAME} = sub { $Foswiki::cfg{WebMasterName} };
 
-    # Compatibility synonyms, deprecated in 4.2 but still used throughout
-    # the documentation.
-    $functionTags{MAINWEB}  = $functionTags{USERSWEB};
-    $functionTags{TWIKIWEB} = $functionTags{SYSTEMWEB};
-
     # locale setup
     #

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

@@ -40 +40 @@
         $replist .= $Foswiki::cfg{ExtensionsRepositories}
           if defined $Foswiki::cfg{ExtensionsRepositories};
-        $replist .= "$ENV{TWIKI_REPOSITORIES};"    # DEPRECATED
-          if defined $ENV{TWIKI_REPOSITORIES};     # DEPRECATED
         $replist = ";$replist;";
         while (

trunk/core/lib/Foswiki/Engine/CGI.pm

@@ -95 +95 @@
 
     my $action;
-    if ( exists $ENV{TWIKI_ACTION} ) {
-
-        # This handles scripts that have set $TWIKI_ACTION
-        $action = $ENV{TWIKI_ACTION};
+    if ( exists $ENV{FOSWIKI_ACTION} ) {
+
+        # This handles scripts that have set $FOSWIKI_ACTION
+        $action = $ENV{FOSWIKI_ACTION};
     }
     elsif ( exists $Foswiki::cfg{SwitchBoard}{$cgiScriptName} ) {
 
         # This handles other named CGI scripts that have a switchboard entry
-        # but haven't set $TWIKI_ACTION (old-style run scripts)
+        # but haven't set $FOSWIKI_ACTION (old-style run scripts)
         $action = $cgiScriptName;
     }

trunk/core/lib/Foswiki/Engine/CLI.pm

@@ -76 +76 @@
 sub preparePath {
     my ( $this, $req ) = @_;
-    $req->action( $ENV{TWIKI_ACTION} );
-    delete $ENV{TWIKI_ACTION};
+    $req->action( $ENV{FOSWIKI_ACTION} );
+    delete $ENV{FOSWIKI_ACTION};
     if ( exists $this->{path_info} ) {
         $req->pathInfo( $this->{path_info} );

trunk/core/lib/Foswiki/LoginManager.pm

@@ -32 +32 @@
       * Foswiki::LoginManager::ApacheLogin looks at REMOTE_USER (only for authenticated scripts)
       * Foswiki::LoginManager::TemplateLogin just returns undef
-   1 reads the TWIKISID cookie to get the SID (or the TWIKISID parameters in the CGI query if cookies aren't available, or IP2SID mapping if that's enabled).
+   1 reads the FOSWIKISID cookie to get the SID (or the FOSWIKISID parameters in the CGI query if cookies aren't available, or IP2SID mapping if that's enabled).
    1 Creates the CGI::Session object, and the session is thereby read.
    1 If the username still isn't known, reads it from the cookie. Thus Foswiki::LoginManager::ApacheLogin overrides the cookie using REMOTE_USER, and Foswiki::LoginManager::TemplateLogin *always* uses the session.
@@ -95 +95 @@
 
             # 4.10 is broken; see Item1989
-            $Foswiki::LoginManager::Session::NAME = 'TWIKISID';
+            $Foswiki::LoginManager::Session::NAME = 'FOSWIKISID';
         }
         else {
-            Foswiki::LoginManager::Session->name('TWIKISID');
+            Foswiki::LoginManager::Session->name('FOSWIKISID');
         }
     }

trunk/core/lib/Foswiki/Request.pm

@@ -124 +124 @@
     return @_ == 1
       ? $_[0]->{action}
-      : ( $ENV{TWIKI_ACTION} = $_[0]->{action} = $_[1] );
+      : ( $ENV{FOSWIKI_ACTION} = $_[0]->{action} = $_[1] );
 }
 

trunk/core/lib/Monitor.pm

@@ -18 +18 @@
 Monitor::MonitorMethod('Foswiki::Users', 'getCanonicalUserID');
 
-Then set the environment variable TWIKI_MONITOR to a perl true value, and
+Then set the environment variable FOSWIKI_MONITOR to a perl true value, and
 run the script from the command line e.g:
 $ cd bin
@@ -71 +71 @@
 BEGIN {
     my $caller = caller;
-    if ( $ENV{TWIKI_MONITOR} ) {
+    if ( $ENV{FOSWIKI_MONITOR} ) {
         require Benchmark;
         import Benchmark ':hireswallclock';
@@ -94 +94 @@
 
 sub END {
-    return unless ( $ENV{TWIKI_MONITOR} );
+    return unless ( $ENV{FOSWIKI_MONITOR} );
     MARK('END');
     my $lastbm;