Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

[インデックス 17309] ファイルの概要

このコミットは、Go言語の標準ライブラリnet/textprotoパッケージにおけるバグ修正です。具体的には、存在しないReadDotAll関数への参照を、正しいReadDotBytes関数に修正しています。

コミット

commit df7b93c1757cd15c861657190c8cdf4932f64c97
Author: Emil Hessman <c.emil.hessman@gmail.com>
Date:   Sun Aug 18 08:11:34 2013 +1000

    net/textproto: use ReadDotBytes instead of non-existent ReadDotAll.
    
    Fixes #5893.
    
    R=golang-dev, r
    CC=golang-dev
    https://golang.org/cl/13086043

GitHub上でのコミットページへのリンク

https://github.com/golang/go/commit/df7b93c1757cd15c861657190c8cdf4932f64c97

元コミット内容

このコミットの元々のメッセージは以下の通りです。

"net/textproto: use ReadDotBytes instead of non-existent ReadDotAll.

Fixes #5893."

これは、net/textprotoパッケージにおいて、存在しないReadDotAll関数ではなく、正しいReadDotBytes関数を使用するように修正したことを示しています。また、この変更がIssue #5893を修正するものであることも明記されています。

変更の背景

この変更の背景には、net/textprotoパッケージのAPIの進化と、それに関連するコーディングミスがあります。net/textprotoパッケージは、SMTP、NNTP、HTTPなどのテキストベースのプロトコルを扱うための汎用的な機能を提供します。これらのプロトコルでは、メッセージの本文がピリオド（.）で始まる行で終了することを示す「ドットスタッフィング」というメカニズムがよく使われます。

Go言語の初期のバージョンでは、textprotoパッケージ内でドットスタッフィングされたデータを読み取るための関数がいくつか存在しました。コミットメッセージにあるReadDotAllは、おそらく開発中に検討されたか、あるいは一時的に存在したものの、最終的にReadDotBytesという名前に落ち着いた関数であったと考えられます。

Issue #5893は、このReadDotAllという存在しない関数がコード内で誤って参照されていることによって発生したバグを報告しています。これは、おそらくリファクタリングやAPI変更の際に、古い関数名が残ってしまったか、あるいはタイプミスによって引き起こされたものと推測されます。このバグは、net/textprotoパッケージを使用するアプリケーションが、ドットスタッフィングされたデータを正しく処理できない原因となっていました。

前提知識の解説

net/textprotoパッケージ

net/textprotoパッケージは、Go言語の標準ライブラリの一部であり、テキストベースのネットワークプロトコル（例: HTTP、SMTP、NNTP、POP3、IMAP）を解析および生成するための低レベルなプリミティブを提供します。これらのプロトコルは、多くの場合、ヘッダーとボディから構成され、特定の行終端文字（CRLF）や、ドットスタッフィングなどの特殊なエンコーディングルールを使用します。

このパッケージの主要なコンポーネントには以下のようなものがあります。

  • Reader: bufio.Readerをラップし、テキストプロトコルに特化した読み取りメソッド（例: ReadLine、ReadMIMEHeader）を提供します。
  • Writer: bufio.Writerをラップし、テキストプロトコルに特化した書き込みメソッド（例: PrintfLine）を提供します。
  • Conn: net.Connをラップし、ReaderとWriterを組み合わせて、より高レベルなプロトコル操作（例: 応答コードの読み取り）を可能にします。

ドットスタッフィング (Dot-stuffing)

ドットスタッフィングは、SMTPやNNTPなどのプロトコルで、メッセージの本文がピリオド（.）のみの行で終了することを示すために使用されるメカニズムです。もしメッセージ本文中にピリオドのみの行が含まれている場合、それがメッセージの終端と誤解されないように、その行の先頭に余分なピリオドを追加します。例えば、本文中に「.Hello」という行がある場合、送信時には「..Hello」とエンコードされ、受信側でデコードされます。

ReadDotBytes関数

net/textprotoパッケージにおけるReadDotBytes関数は、ドットスタッフィングされたデータを読み取るための関数です。この関数は、入力ストリームからドットスタッフィングされたバイト列を読み取り、デスタッフィング（余分なピリオドの除去）を行って、元のバイト列を返します。この関数は、メッセージの終端を示すピリオドのみの行に遭遇するまで読み取りを続けます。

ReadDotAll関数 (非存在)

コミットメッセージにあるReadDotAllは、このコミットの時点ではnet/textprotoパッケージに存在しない関数でした。これは、開発過程での名前の変更や、単なるコーディングミスによって参照されてしまったものと考えられます。

技術的詳細

このコミットは、src/pkg/net/textproto/textproto.goファイル内の1行の変更に過ぎませんが、その影響は重要です。

変更前のコードは、コメントアウトされた行の中にc.ReadDotAll()という呼び出しを含んでいました。このReadDotAllは、前述の通り、net/textprotoパッケージのConn型には定義されていないメソッドです。もしこのコメントアウトされたコードが有効化された場合、コンパイルエラーが発生するか、あるいは実行時に未定義のメソッド呼び出しによるパニックが発生する可能性がありました。

変更後のコードでは、c.ReadDotAll()がc.ReadDotBytes()に修正されています。ReadDotBytesは、net/textproto.Conn型に実際に存在するメソッドであり、ドットスタッフィングされたデータをバイトスライスとして読み取る役割を担います。

この修正は、単なるタイプミスや古いAPI参照の修正であり、net/textprotoパッケージの機能自体に大きな変更を加えるものではありません。しかし、これにより、将来的にこのコメントアウトされたコードが有効化された際に、正しく動作することが保証されます。また、これはGo言語の標準ライブラリの品質と堅牢性を維持するための、細かながらも重要な修正と言えます。

コアとなるコードの変更箇所

変更はsrc/pkg/net/textproto/textproto.goファイル内の1箇所です。

--- a/src/pkg/net/textproto/textproto.go
+++ b/src/pkg/net/textproto/textproto.go
@@ -105,7 +105,7 @@ func Dial(network, addr string) (*Conn, error) {
 //	if _, _, err = c.ReadCodeLine(110); err != nil {
 //		return nil, err
 //	}
-//	text, err := c.ReadDotAll()
+//	text, err := c.ReadDotBytes()
 //	if err != nil {
 //		return nil, err
 //	}

コアとなるコードの解説

変更された行は、コメントアウトされたコードブロックの一部です。

元の行: // text, err := c.ReadDotAll() 修正後の行: // text, err := c.ReadDotBytes()

この変更は、Conn型のメソッド呼び出しをReadDotAllからReadDotBytesに変更しています。これは、ReadDotAllというメソッドがnet/textproto.Conn型に存在しないため、コンパイルエラーや実行時エラーを避けるための修正です。ReadDotBytesは、ドットスタッフィングされたデータをバイトスライスとして読み取るための正しいメソッドです。

このコードブロック全体がコメントアウトされているため、この修正が直接的に実行時の動作に影響を与えることはありません。しかし、これはコードベースの健全性を保つ上で重要です。コメントアウトされたコードであっても、それが有効なGoの構文であり、存在しない関数を参照していないことは、将来的な開発やデバッグにおいて混乱を避けるために不可欠です。この修正により、もし将来的にこのコードブロックがコメント解除された場合でも、正しくコンパイルされ、意図した通りに動作することが保証されます。

関連リンク

参考にした情報源リンク