Ensure backward compatibility with legacy EOF format

Author: tz70s

connection.go

@@ -180,16 +180,24 @@ func (mc *mysqlConn) Prepare(query string) (driver.Stmt, error) {
 
 	// Read Result
 	columnCount, err := stmt.readPrepareResultPacket()
-	if err != nil {
-		return stmt, err
-	}
-
-	if err := mc.readPackets(stmt.paramCount); err != nil {
-		return nil, err
-	}
+	if err == nil {
+		if stmt.paramCount > 0 {
+			// FIXME - seems like a bug in MySQL (or it's intended).
+			// There's no EOF return after parameters.
+			// However, this behavior isn't consistent to Maria DB.
+			if mc.flags&clientDeprecateEOF == 0 {
+				if err = mc.readUntilEOF(); err != nil {
+					return nil, err
+				}
+			}
+			if err = mc.readExactPackets(stmt.paramCount); err != nil {
+				return nil, err
+			}
+		}
 
-	if err := mc.readPackets(int(columnCount)); err != nil {
-		return nil, err
+		if columnCount > 0 {
+			err = mc.readUntilEOF()
+		}
 	}
 
 	return stmt, err
@@ -415,8 +423,11 @@ func (mc *mysqlConn) getSystemVar(name string) ([]byte, error) {
 		rows.mc = mc
 		rows.rs.columns = []mysqlField{{fieldType: fieldTypeVarChar}}
 
-		if err := mc.readPackets(resLen); err != nil {
-			return nil, err
+		if resLen > 0 {
+			// Columns
+			if err := mc.readUntilEOF(); err != nil {
+				return nil, err
+			}
 		}
 
 		dest := make([]driver.Value, resLen)

packets.go

@@ -238,12 +238,12 @@ func (mc *mysqlConn) readHandshakePacket() (data []byte, plugin string, err erro
 		pos += 1 + 2
 
 		// capability flags (upper 2 bytes) [2 bytes]
-		mc.flags += clientFlag(binary.LittleEndian.Uint16(data[pos:pos+2])) << 16
+		mc.flags |= clientFlag(binary.LittleEndian.Uint16(data[pos:pos+2])) << 16
 		pos += 2
 
 		// length of auth-plugin-data [1 byte]
 		// reserved (all [00]) [10 bytes]
-		pos += +1 + 10
+		pos += 1 + 10
 
 		// second part of the password cipher [mininum 13 bytes],
 		// where len=MAX(13, length of auth-plugin-data - 8)
@@ -614,7 +614,7 @@ func readStatus(b []byte) statusFlag {
 }
 
 // Ok Packet
-// http://dev.mysql.com/doc/internals/en/generic-response-packets.html#packet-OK_Packet
+// https://dev.mysql.com/doc/internals/en/packet-OK_Packet.html
 func (mc *mysqlConn) handleOkPacket(data []byte) error {
 	// 0x00 or 0xFE [1 byte]
 	n := 1
@@ -640,22 +640,34 @@ func (mc *mysqlConn) handleOkPacket(data []byte) error {
 
 // isEOFPacket will return true if the data is either a EOF-Packet or OK-Packet
 // acting as an EOF.
-func isEOFPacket(data []byte) bool {
-	return data[0] == iEOF && len(data) < 9
+func (mc *mysqlConn) isEOFPacket(data []byte) bool {
+	// Legacy EOF packet
+	if data[0] == iEOF && (len(data) == 5 || len(data) == 1) && mc.flags&clientDeprecateEOF == 0 {
+		return true
+	}
+	return data[0] == iEOF && len(data) < 9 && mc.flags&clientDeprecateEOF != 0
 }
 
 // Read Packets as Field Packets until EOF-Packet or an Error appears
 // http://dev.mysql.com/doc/internals/en/com-query-response.html#packet-Protocol::ColumnDefinition41
 func (mc *mysqlConn) readColumns(count int) ([]mysqlField, error) {
 	columns := make([]mysqlField, count)
 
-	for i := 0; i < count; i++ {
+	// If we set clientDeprecateEOF capability flag,
+	// the EOF will be no longer sent after all columns.
+	packets := count
+	if mc.flags&clientDeprecateEOF == 0 {
+		// Legacy way, read one more EOF packet.
+		packets += 1
+	}
+
+	for i := 0; i < packets; i++ {
 		data, err := mc.readPacket()
 		if err != nil {
 			return nil, err
 		}
 
-		if mc.flags&clientDeprecateEOF == 0 && isEOFPacket(data) {
+		if mc.isEOFPacket(data) {
 			if i == count {
 				return columns, nil
 			}
@@ -759,12 +771,13 @@ func (rows *textRows) readRow(dest []driver.Value) error {
 	}
 
 	// EOF Packet
-	if isEOFPacket(data) {
+	if mc.isEOFPacket(data) {
 		if mc.flags&clientDeprecateEOF == 0 {
 			// server_status [2 bytes]
 			rows.mc.status = readStatus(data[3:])
 		} else {
 			if err := mc.handleOkPacket(data); err != nil {
+				rows.mc = nil
 				return err
 			}
 		}
@@ -830,37 +843,22 @@ func (mc *mysqlConn) readUntilEOF() error {
 		switch {
 		case data[0] == iERR:
 			return mc.handleErrorPacket(data)
-		case isEOFPacket(data):
+		case mc.isEOFPacket(data):
 			if mc.flags&clientDeprecateEOF == 0 {
 				mc.status = readStatus(data[3:])
-			} else {
-				return mc.handleOkPacket(data)
+				return nil
 			}
-			return nil
+			return mc.handleOkPacket(data)
 		}
 	}
 }
 
-func (mc *mysqlConn) readPackets(num int) error {
-
-	// we need to read EOF as well
-	if mc.flags&clientDeprecateEOF == 0 {
-		num++
-	}
-
+func (mc *mysqlConn) readExactPackets(num int) error {
 	for i := 0; i < num; i++ {
-		data, err := mc.readPacket()
+		_, err := mc.readPacket()
 		if err != nil {
 			return err
 		}
-
-		switch {
-		case data[0] == iERR:
-			return mc.handleErrorPacket(data)
-		case mc.flags&clientDeprecateEOF == 0 && isEOFPacket(data):
-			mc.status = readStatus(data[3:])
-			return nil
-		}
 	}
 	return nil
 }
@@ -1223,11 +1221,12 @@ func (rows *binaryRows) readRow(dest []driver.Value) error {
 
 	// packet indicator [1 byte]
 	if data[0] != iOK {
-		if isEOFPacket(data) {
+		if rows.mc.isEOFPacket(data) {
 			if rows.mc.flags&clientDeprecateEOF == 0 {
 				rows.mc.status = readStatus(data[3:])
 			} else {
 				if err := rows.mc.handleOkPacket(data); err != nil {
+					rows.mc = nil
 					return err
 				}
 			}

rows.go

@@ -215,7 +215,6 @@ func (rows *textRows) Next(dest []driver.Value) error {
 		if err := mc.error(); err != nil {
 			return err
 		}
-
 		// Fetch next row from stream
 		return rows.readRow(dest)
 	}

statement.go

@@ -73,10 +73,9 @@ func (stmt *mysqlStmt) Exec(args []driver.Value) (driver.Result, error) {
 
 	if resLen > 0 {
 		// Columns
-		if err = mc.readUntilEOF(); err != nil {
+		if err = mc.readExactPackets(resLen); err != nil {
 			return nil, err
 		}
-
 		// Rows
 		if err := mc.readUntilEOF(); err != nil {
 			return nil, err