Item13378: added selector for special encoding on .htpasswd file

foswiki · May 20, 2015 · 5b752fc · 5b752fc
1 parent b9f8746
commit 5b752fc
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 4 deletions.
diff --git a/core/lib/Foswiki.spec b/core/lib/Foswiki.spec
@@ -650,6 +650,13 @@ $Foswiki::cfg{MinPasswordLength} = 7;
 # email addresses from an existing file.
 $Foswiki::cfg{Htpasswd}{FileName} = '$Foswiki::cfg{DataDir}/.htpasswd';
 
+# **STRING LABEL="Password File Character Encodingname" DISPLAY_IF="/htpasswd/i.test({PasswordManager})" CHECK="iff:'{PasswordManager}=~/htpasswd/i'"**
+# Character encoding used in the password file. This will default to utf-8, which allows any unicode
+# character to be used in usernames, passwords and email addresses. The only time you should change it
+# is if you have an existing password file that uses a different encoding (and even then only if there
+# is at least one character in that file that has a codepoint that would conflict with utf-8).
+# $Foswiki::cfg{Htpasswd}{CharacterEncoding} = 'utf-8';
+
 # **PATH LABEL="Password Lock-Filename" EXPERT DISPLAY_IF="/htpasswd/i.test({PasswordManager})" CHECK="iff:'{PasswordManager}=~/htpasswd/i'"**
 # Path to the lockfile for the password file.  This normally does not need
 # to be changed; however if two Foswiki installations share and update a

diff --git a/core/lib/Foswiki/Users/HtPasswdUser.pm b/core/lib/Foswiki/Users/HtPasswdUser.pm
@@ -289,7 +289,8 @@ sub _readPasswd {
 
     local $/ = "\n";
 
-    open( $IN_FILE, '<:encoding(utf-8)', $Foswiki::cfg{Htpasswd}{FileName} )
+    my $enc = $Foswiki::cfg{Htpasswd}{CharacterEncoding} || 'utf-8';
+    open( $IN_FILE, "<:encoding($enc)", $Foswiki::cfg{Htpasswd}{FileName} )
       || throw Error::Simple(
         $Foswiki::cfg{Htpasswd}{FileName} . ' open failed: ' . $! );
     my $line = '';
@@ -467,8 +468,7 @@ sub _savePasswd {
     unless ( -e "$Foswiki::cfg{Htpasswd}{FileName}" ) {
 
        # Item4544: Document special format used in .htpasswd for email addresses
-        open( my $readme, '>:encoding(utf-8)',
-            "$Foswiki::cfg{Htpasswd}{FileName}.README" )
+        open( my $readme, '>', "$Foswiki::cfg{Htpasswd}{FileName}.README" )
           or throw Error::Simple(
             $Foswiki::cfg{Htpasswd}{FileName} . '.README open failed: ' . $! );
 
@@ -488,7 +488,8 @@ EoT
     my $oldMask = umask(077);    # Access only by owner
     my $fh;
 
-    open( $fh, '>:encoding(utf-8)', $Foswiki::cfg{Htpasswd}{FileName} )
+    my $enc = $Foswiki::cfg{Htpasswd}{CharacterEncoding} || 'utf-8';
+    open( $fh, ">:encoding($enc)", $Foswiki::cfg{Htpasswd}{FileName} )
       || throw Error::Simple(
         "$Foswiki::cfg{Htpasswd}{FileName} open failed: $!");
     print $fh $content;