git-gui: Correctly handle UTF-8 encoded commit messages

Uwe Kleine-König discovered git-gui mangled his surname and did
not send the proper UTF-8 byte sequence to git-commit-tree when
his name appeared in the commit message (e.g. Signed-Off-By line).

Turns out this was related to other trouble that I had in the past
with trying to use "fconfigure $fd -encoding $enc" to select the
stream encoding and let Tcl's IO engine do all of the encoding work
for us.  Other parts of git-gui were just always setting the file
channels to "-encoding binary" and then performing the encoding
work themselves using "encoding convertfrom" and "convertto", as
that was the only way I could make UTF-8 filenames work properly.

I found this same bug in the amend code path, and in the blame
display.  So its fixed in all three locations (commit creation,
reloading message for amend, viewing  message in blame).

Signed-off-by: Shawn O. Pearce <spearce@spearce.org>

diff --git a/git-gui.sh b/git-gui.sh
index 94067cc5f73388f33722d52ae02f44692bc07490..3f41bd72433d41dca0f568ca263d470efe615144 100755 (executable)
--- a/git-gui.sh
+++ b/git-gui.sh
@@ -1067,8 +1067,8 @@ You are currently in the middle of a merge that has not been fully completed.  Y
                                        set enc [string tolower [string range $line 9 end]]
                                }
                        }
                                        set enc [string tolower [string range $line 9 end]]
                                }
                        }

-                       fconfigure $fd -encoding $enc
-                       set msg [string trim [read $fd]]
+                       set msg [encoding convertfrom $enc [read $fd]]
+                       set msg [string trim $msg]

                        close $fd
                } err]} {
                error_popup "Error loading commit data for amend:\n\n$err"
                        close $fd
                } err]} {
                error_popup "Error loading commit data for amend:\n\n$err"


@@ -1291,8 +1291,8 @@ A rescan will be automatically started now.
        if {[catch {set enc $repo_config(i18n.commitencoding)}]} {
                set enc utf-8
        }
        if {[catch {set enc $repo_config(i18n.commitencoding)}]} {
                set enc utf-8
        }

-       fconfigure $msg_wt -encoding $enc -translation binary
-       puts -nonewline $msg_wt $msg
+       fconfigure $msg_wt -encoding binary -translation binary
+       puts -nonewline $msg_wt [encoding convertto $enc $msg]

        close $msg_wt
 
        # -- Create the commit.
        close $msg_wt
 
        # -- Create the commit.


@@ -3663,6 +3663,20 @@ proc blame_showcommit {w w_cmit w_line w_file lno} {
                        incr i
                }
 
                        incr i
                }
 

+               set author_name {}
+               set author_email {}
+               set author_time {}
+               catch {set author_name $blame_data($w,$cmit,author)}
+               catch {set author_email $blame_data($w,$cmit,author-mail)}
+               catch {set author_time [clock format $blame_data($w,$cmit,author-time)]}
+
+               set committer_name {}
+               set committer_email {}
+               set committer_time {}
+               catch {set committer_name $blame_data($w,$cmit,committer)}
+               catch {set committer_email $blame_data($w,$cmit,committer-mail)}
+               catch {set committer_time [clock format $blame_data($w,$cmit,committer-time)]}
+

                if {[catch {set msg $blame_data($w,$cmit,message)}]} {
                        set msg {}
                        catch {
                if {[catch {set msg $blame_data($w,$cmit,message)}]} {
                        set msg {}
                        catch {


@@ -3676,27 +3690,19 @@ proc blame_showcommit {w w_cmit w_line w_file lno} {
                                                set enc [string tolower [string range $line 9 end]]
                                        }
                                }
                                                set enc [string tolower [string range $line 9 end]]
                                        }
                                }

-                               fconfigure $fd -encoding $enc
-                               set msg [string trim [read $fd]]
+                               set msg [encoding convertfrom $enc [read $fd]]
+                               set msg [string trim $msg]

                                close $fd
                                close $fd

+
+                               set author_name [encoding convertfrom $enc $author_name]
+                               set committer_name [encoding convertfrom $enc $committer_name]
+
+                               set blame_data($w,$cmit,author) $author_name
+                               set blame_data($w,$cmit,committer) $committer_name

                        }
                        set blame_data($w,$cmit,message) $msg
                }
 
                        }
                        set blame_data($w,$cmit,message) $msg
                }
 

-               set author_name {}
-               set author_email {}
-               set author_time {}
-               catch {set author_name $blame_data($w,$cmit,author)}
-               catch {set author_email $blame_data($w,$cmit,author-mail)}
-               catch {set author_time [clock format $blame_data($w,$cmit,author-time)]}
-
-               set committer_name {}
-               set committer_email {}
-               set committer_time {}
-               catch {set committer_name $blame_data($w,$cmit,committer)}
-               catch {set committer_email $blame_data($w,$cmit,committer-mail)}
-               catch {set committer_time [clock format $blame_data($w,$cmit,committer-time)]}
-

                $w_cmit insert end "commit $cmit\n"
                $w_cmit insert end "Author: $author_name $author_email $author_time\n"
                $w_cmit insert end "Committer: $committer_name $committer_email $committer_time\n"
                $w_cmit insert end "commit $cmit\n"
                $w_cmit insert end "Author: $author_name $author_email $author_time\n"
                $w_cmit insert end "Committer: $committer_name $committer_email $committer_time\n"