packets.go 28 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202
  1. // Go MySQL Driver - A MySQL-Driver for Go's database/sql package
  2. //
  3. // Copyright 2012 The Go-MySQL-Driver Authors. All rights reserved.
  4. //
  5. // This Source Code Form is subject to the terms of the Mozilla Public
  6. // License, v. 2.0. If a copy of the MPL was not distributed with this file,
  7. // You can obtain one at http://mozilla.org/MPL/2.0/.
  8. package mysql
  9. import (
  10. "bytes"
  11. "crypto/tls"
  12. "database/sql/driver"
  13. "encoding/binary"
  14. "fmt"
  15. "io"
  16. "math"
  17. "time"
  18. )
  19. // Packets documentation:
  20. // http://dev.mysql.com/doc/internals/en/client-server-protocol.html
  21. // Read packet to buffer 'data'
  22. func (mc *mysqlConn) readPacket() ([]byte, error) {
  23. // Read packet header
  24. data, err := mc.buf.readNext(4)
  25. if err != nil {
  26. errLog.Print(err.Error())
  27. mc.Close()
  28. return nil, driver.ErrBadConn
  29. }
  30. // Packet Length [24 bit]
  31. pktLen := int(uint32(data[0]) | uint32(data[1])<<8 | uint32(data[2])<<16)
  32. if pktLen < 1 {
  33. errLog.Print(errMalformPkt.Error())
  34. mc.Close()
  35. return nil, driver.ErrBadConn
  36. }
  37. // Check Packet Sync [8 bit]
  38. if data[3] != mc.sequence {
  39. if data[3] > mc.sequence {
  40. return nil, errPktSyncMul
  41. } else {
  42. return nil, errPktSync
  43. }
  44. }
  45. mc.sequence++
  46. // Read packet body [pktLen bytes]
  47. if data, err = mc.buf.readNext(pktLen); err == nil {
  48. if pktLen < maxPacketSize {
  49. return data, nil
  50. }
  51. // Make a copy since data becomes invalid with the next read
  52. buf := make([]byte, len(data))
  53. copy(buf, data)
  54. // More data
  55. data, err = mc.readPacket()
  56. if err == nil {
  57. return append(buf, data...), nil
  58. }
  59. }
  60. // err case
  61. mc.Close()
  62. errLog.Print(err.Error())
  63. return nil, driver.ErrBadConn
  64. }
  65. // Write packet buffer 'data'
  66. // The packet header must be already included
  67. func (mc *mysqlConn) writePacket(data []byte) error {
  68. if len(data)-4 <= mc.maxWriteSize { // Can send data at once
  69. // Write packet
  70. n, err := mc.netConn.Write(data)
  71. if err == nil && n == len(data) {
  72. mc.sequence++
  73. return nil
  74. }
  75. // Handle error
  76. if err == nil { // n != len(data)
  77. errLog.Print(errMalformPkt.Error())
  78. } else {
  79. errLog.Print(err.Error())
  80. }
  81. return driver.ErrBadConn
  82. }
  83. // Must split packet
  84. return mc.splitPacket(data)
  85. }
  86. func (mc *mysqlConn) splitPacket(data []byte) error {
  87. pktLen := len(data) - 4
  88. if pktLen > mc.maxPacketAllowed {
  89. return errPktTooLarge
  90. }
  91. for pktLen >= maxPacketSize {
  92. data[0] = 0xff
  93. data[1] = 0xff
  94. data[2] = 0xff
  95. data[3] = mc.sequence
  96. // Write packet
  97. n, err := mc.netConn.Write(data[:4+maxPacketSize])
  98. if err == nil && n == 4+maxPacketSize {
  99. mc.sequence++
  100. data = data[maxPacketSize:]
  101. pktLen -= maxPacketSize
  102. continue
  103. }
  104. // Handle error
  105. if err == nil { // n != len(data)
  106. errLog.Print(errMalformPkt.Error())
  107. } else {
  108. errLog.Print(err.Error())
  109. }
  110. return driver.ErrBadConn
  111. }
  112. data[0] = byte(pktLen)
  113. data[1] = byte(pktLen >> 8)
  114. data[2] = byte(pktLen >> 16)
  115. data[3] = mc.sequence
  116. return mc.writePacket(data)
  117. }
  118. /******************************************************************************
  119. * Initialisation Process *
  120. ******************************************************************************/
  121. // Handshake Initialization Packet
  122. // http://dev.mysql.com/doc/internals/en/connection-phase-packets.html#packet-Protocol::Handshake
  123. func (mc *mysqlConn) readInitPacket() ([]byte, error) {
  124. data, err := mc.readPacket()
  125. if err != nil {
  126. return nil, err
  127. }
  128. if data[0] == iERR {
  129. return nil, mc.handleErrorPacket(data)
  130. }
  131. // protocol version [1 byte]
  132. if data[0] < minProtocolVersion {
  133. return nil, fmt.Errorf(
  134. "Unsupported MySQL Protocol Version %d. Protocol Version %d or higher is required",
  135. data[0],
  136. minProtocolVersion,
  137. )
  138. }
  139. // server version [null terminated string]
  140. // connection id [4 bytes]
  141. pos := 1 + bytes.IndexByte(data[1:], 0x00) + 1 + 4
  142. // first part of the password cipher [8 bytes]
  143. cipher := data[pos : pos+8]
  144. // (filler) always 0x00 [1 byte]
  145. pos += 8 + 1
  146. // capability flags (lower 2 bytes) [2 bytes]
  147. mc.flags = clientFlag(binary.LittleEndian.Uint16(data[pos : pos+2]))
  148. if mc.flags&clientProtocol41 == 0 {
  149. return nil, errOldProtocol
  150. }
  151. if mc.flags&clientSSL == 0 && mc.cfg.tls != nil {
  152. return nil, errNoTLS
  153. }
  154. pos += 2
  155. if len(data) > pos {
  156. // character set [1 byte]
  157. // status flags [2 bytes]
  158. // capability flags (upper 2 bytes) [2 bytes]
  159. // length of auth-plugin-data [1 byte]
  160. // reserved (all [00]) [10 bytes]
  161. pos += 1 + 2 + 2 + 1 + 10
  162. // second part of the password cipher [12? bytes]
  163. // The documentation is ambiguous about the length.
  164. // The official Python library uses the fixed length 12
  165. // which is not documented but seems to work.
  166. cipher = append(cipher, data[pos:pos+12]...)
  167. // TODO: Verify string termination
  168. // EOF if version (>= 5.5.7 and < 5.5.10) or (>= 5.6.0 and < 5.6.2)
  169. // \NUL otherwise
  170. //
  171. //if data[len(data)-1] == 0 {
  172. // return
  173. //}
  174. //return errMalformPkt
  175. }
  176. return cipher, nil
  177. }
  178. // Client Authentication Packet
  179. // http://dev.mysql.com/doc/internals/en/connection-phase-packets.html#packet-Protocol::HandshakeResponse
  180. func (mc *mysqlConn) writeAuthPacket(cipher []byte) error {
  181. // Adjust client flags based on server support
  182. clientFlags := clientProtocol41 |
  183. clientSecureConn |
  184. clientLongPassword |
  185. clientTransactions |
  186. clientLocalFiles |
  187. mc.flags&clientLongFlag
  188. if mc.cfg.clientFoundRows {
  189. clientFlags |= clientFoundRows
  190. }
  191. // To enable TLS / SSL
  192. if mc.cfg.tls != nil {
  193. clientFlags |= clientSSL
  194. }
  195. // User Password
  196. scrambleBuff := scramblePassword(cipher, []byte(mc.cfg.passwd))
  197. pktLen := 4 + 4 + 1 + 23 + len(mc.cfg.user) + 1 + 1 + len(scrambleBuff)
  198. // To specify a db name
  199. if n := len(mc.cfg.dbname); n > 0 {
  200. clientFlags |= clientConnectWithDB
  201. pktLen += n + 1
  202. }
  203. // Calculate packet length and get buffer with that size
  204. data := mc.buf.takeSmallBuffer(pktLen + 4)
  205. if data == nil {
  206. // can not take the buffer. Something must be wrong with the connection
  207. errLog.Print("Busy buffer")
  208. return driver.ErrBadConn
  209. }
  210. // ClientFlags [32 bit]
  211. data[4] = byte(clientFlags)
  212. data[5] = byte(clientFlags >> 8)
  213. data[6] = byte(clientFlags >> 16)
  214. data[7] = byte(clientFlags >> 24)
  215. // MaxPacketSize [32 bit] (none)
  216. data[8] = 0x00
  217. data[9] = 0x00
  218. data[10] = 0x00
  219. data[11] = 0x00
  220. // Charset [1 byte]
  221. data[12] = collation_utf8_general_ci
  222. // SSL Connection Request Packet
  223. // http://dev.mysql.com/doc/internals/en/connection-phase-packets.html#packet-Protocol::SSLRequest
  224. if mc.cfg.tls != nil {
  225. // Packet header [24bit length + 1 byte sequence]
  226. data[0] = byte((4 + 4 + 1 + 23))
  227. data[1] = byte((4 + 4 + 1 + 23) >> 8)
  228. data[2] = byte((4 + 4 + 1 + 23) >> 16)
  229. data[3] = mc.sequence
  230. // Send TLS / SSL request packet
  231. if err := mc.writePacket(data[:(4+4+1+23)+4]); err != nil {
  232. return err
  233. }
  234. // Switch to TLS
  235. tlsConn := tls.Client(mc.netConn, mc.cfg.tls)
  236. if err := tlsConn.Handshake(); err != nil {
  237. return err
  238. }
  239. mc.netConn = tlsConn
  240. mc.buf.rd = tlsConn
  241. }
  242. // Add the packet header [24bit length + 1 byte sequence]
  243. data[0] = byte(pktLen)
  244. data[1] = byte(pktLen >> 8)
  245. data[2] = byte(pktLen >> 16)
  246. data[3] = mc.sequence
  247. // Filler [23 bytes] (all 0x00)
  248. pos := 13 + 23
  249. // User [null terminated string]
  250. if len(mc.cfg.user) > 0 {
  251. pos += copy(data[pos:], mc.cfg.user)
  252. }
  253. data[pos] = 0x00
  254. pos++
  255. // ScrambleBuffer [length encoded integer]
  256. data[pos] = byte(len(scrambleBuff))
  257. pos += 1 + copy(data[pos+1:], scrambleBuff)
  258. // Databasename [null terminated string]
  259. if len(mc.cfg.dbname) > 0 {
  260. pos += copy(data[pos:], mc.cfg.dbname)
  261. data[pos] = 0x00
  262. }
  263. // Send Auth packet
  264. return mc.writePacket(data)
  265. }
  266. // Client old authentication packet
  267. // http://dev.mysql.com/doc/internals/en/connection-phase-packets.html#packet-Protocol::AuthSwitchResponse
  268. func (mc *mysqlConn) writeOldAuthPacket(cipher []byte) error {
  269. // User password
  270. scrambleBuff := scrambleOldPassword(cipher, []byte(mc.cfg.passwd))
  271. // Calculate the packet lenght and add a tailing 0
  272. pktLen := len(scrambleBuff) + 1
  273. data := mc.buf.takeSmallBuffer(pktLen + 4)
  274. if data == nil {
  275. // can not take the buffer. Something must be wrong with the connection
  276. errLog.Print("Busy buffer")
  277. return driver.ErrBadConn
  278. }
  279. // Add the packet header [24bit length + 1 byte sequence]
  280. data[0] = byte(pktLen)
  281. data[1] = byte(pktLen >> 8)
  282. data[2] = byte(pktLen >> 16)
  283. data[3] = mc.sequence
  284. // Add the scrambled password [null terminated string]
  285. copy(data[4:], scrambleBuff)
  286. return mc.writePacket(data)
  287. }
  288. /******************************************************************************
  289. * Command Packets *
  290. ******************************************************************************/
  291. func (mc *mysqlConn) writeCommandPacket(command byte) error {
  292. // Reset Packet Sequence
  293. mc.sequence = 0
  294. data := mc.buf.takeSmallBuffer(4 + 1)
  295. if data == nil {
  296. // can not take the buffer. Something must be wrong with the connection
  297. errLog.Print("Busy buffer")
  298. return driver.ErrBadConn
  299. }
  300. // Add the packet header [24bit length + 1 byte sequence]
  301. data[0] = 0x01 // 1 byte long
  302. data[1] = 0x00
  303. data[2] = 0x00
  304. data[3] = 0x00 // new command, sequence id is always 0
  305. // Add command byte
  306. data[4] = command
  307. // Send CMD packet
  308. return mc.writePacket(data)
  309. }
  310. func (mc *mysqlConn) writeCommandPacketStr(command byte, arg string) error {
  311. // Reset Packet Sequence
  312. mc.sequence = 0
  313. pktLen := 1 + len(arg)
  314. data := mc.buf.takeBuffer(pktLen + 4)
  315. if data == nil {
  316. // can not take the buffer. Something must be wrong with the connection
  317. errLog.Print("Busy buffer")
  318. return driver.ErrBadConn
  319. }
  320. // Add the packet header [24bit length + 1 byte sequence]
  321. data[0] = byte(pktLen)
  322. data[1] = byte(pktLen >> 8)
  323. data[2] = byte(pktLen >> 16)
  324. data[3] = 0x00 // new command, sequence id is always 0
  325. // Add command byte
  326. data[4] = command
  327. // Add arg
  328. copy(data[5:], arg)
  329. // Send CMD packet
  330. return mc.writePacket(data)
  331. }
  332. func (mc *mysqlConn) writeCommandPacketUint32(command byte, arg uint32) error {
  333. // Reset Packet Sequence
  334. mc.sequence = 0
  335. data := mc.buf.takeSmallBuffer(4 + 1 + 4)
  336. if data == nil {
  337. // can not take the buffer. Something must be wrong with the connection
  338. errLog.Print("Busy buffer")
  339. return driver.ErrBadConn
  340. }
  341. // Add the packet header [24bit length + 1 byte sequence]
  342. data[0] = 0x05 // 5 bytes long
  343. data[1] = 0x00
  344. data[2] = 0x00
  345. data[3] = 0x00 // new command, sequence id is always 0
  346. // Add command byte
  347. data[4] = command
  348. // Add arg [32 bit]
  349. data[5] = byte(arg)
  350. data[6] = byte(arg >> 8)
  351. data[7] = byte(arg >> 16)
  352. data[8] = byte(arg >> 24)
  353. // Send CMD packet
  354. return mc.writePacket(data)
  355. }
  356. /******************************************************************************
  357. * Result Packets *
  358. ******************************************************************************/
  359. // Returns error if Packet is not an 'Result OK'-Packet
  360. func (mc *mysqlConn) readResultOK() error {
  361. data, err := mc.readPacket()
  362. if err == nil {
  363. // packet indicator
  364. switch data[0] {
  365. case iOK:
  366. return mc.handleOkPacket(data)
  367. case iEOF:
  368. // someone is using old_passwords
  369. return errOldPassword
  370. default: // Error otherwise
  371. return mc.handleErrorPacket(data)
  372. }
  373. }
  374. return err
  375. }
  376. // Result Set Header Packet
  377. // http://dev.mysql.com/doc/internals/en/com-query-response.html#packet-ProtocolText::Resultset
  378. func (mc *mysqlConn) readResultSetHeaderPacket() (int, error) {
  379. data, err := mc.readPacket()
  380. if err == nil {
  381. switch data[0] {
  382. case iOK:
  383. return 0, mc.handleOkPacket(data)
  384. case iERR:
  385. return 0, mc.handleErrorPacket(data)
  386. case iLocalInFile:
  387. return 0, mc.handleInFileRequest(string(data[1:]))
  388. }
  389. // column count
  390. num, _, n := readLengthEncodedInteger(data)
  391. if n-len(data) == 0 {
  392. return int(num), nil
  393. }
  394. return 0, errMalformPkt
  395. }
  396. return 0, err
  397. }
  398. // Error Packet
  399. // http://dev.mysql.com/doc/internals/en/generic-response-packets.html#packet-ERR_Packet
  400. func (mc *mysqlConn) handleErrorPacket(data []byte) error {
  401. if data[0] != iERR {
  402. return errMalformPkt
  403. }
  404. // 0xff [1 byte]
  405. // Error Number [16 bit uint]
  406. errno := binary.LittleEndian.Uint16(data[1:3])
  407. pos := 3
  408. // SQL State [optional: # + 5bytes string]
  409. if data[3] == 0x23 {
  410. //sqlstate := string(data[4 : 4+5])
  411. pos = 9
  412. }
  413. // Error Message [string]
  414. return &MySQLError{
  415. Number: errno,
  416. Message: string(data[pos:]),
  417. }
  418. }
  419. // Ok Packet
  420. // http://dev.mysql.com/doc/internals/en/generic-response-packets.html#packet-OK_Packet
  421. func (mc *mysqlConn) handleOkPacket(data []byte) error {
  422. var n, m int
  423. // 0x00 [1 byte]
  424. // Affected rows [Length Coded Binary]
  425. mc.affectedRows, _, n = readLengthEncodedInteger(data[1:])
  426. // Insert id [Length Coded Binary]
  427. mc.insertId, _, m = readLengthEncodedInteger(data[1+n:])
  428. // server_status [2 bytes]
  429. // warning count [2 bytes]
  430. if !mc.strict {
  431. return nil
  432. } else {
  433. pos := 1 + n + m + 2
  434. if binary.LittleEndian.Uint16(data[pos:pos+2]) > 0 {
  435. return mc.getWarnings()
  436. }
  437. return nil
  438. }
  439. }
  440. // Read Packets as Field Packets until EOF-Packet or an Error appears
  441. // http://dev.mysql.com/doc/internals/en/com-query-response.html#packet-Protocol::ColumnDefinition41
  442. func (mc *mysqlConn) readColumns(count int) ([]mysqlField, error) {
  443. columns := make([]mysqlField, count)
  444. for i := 0; ; i++ {
  445. data, err := mc.readPacket()
  446. if err != nil {
  447. return nil, err
  448. }
  449. // EOF Packet
  450. if data[0] == iEOF && (len(data) == 5 || len(data) == 1) {
  451. if i == count {
  452. return columns, nil
  453. }
  454. return nil, fmt.Errorf("ColumnsCount mismatch n:%d len:%d", count, len(columns))
  455. }
  456. // Catalog
  457. pos, err := skipLengthEnodedString(data)
  458. if err != nil {
  459. return nil, err
  460. }
  461. // Database [len coded string]
  462. n, err := skipLengthEnodedString(data[pos:])
  463. if err != nil {
  464. return nil, err
  465. }
  466. pos += n
  467. // Table [len coded string]
  468. n, err = skipLengthEnodedString(data[pos:])
  469. if err != nil {
  470. return nil, err
  471. }
  472. pos += n
  473. // Original table [len coded string]
  474. n, err = skipLengthEnodedString(data[pos:])
  475. if err != nil {
  476. return nil, err
  477. }
  478. pos += n
  479. // Name [len coded string]
  480. name, _, n, err := readLengthEnodedString(data[pos:])
  481. if err != nil {
  482. return nil, err
  483. }
  484. columns[i].name = string(name)
  485. pos += n
  486. // Original name [len coded string]
  487. n, err = skipLengthEnodedString(data[pos:])
  488. if err != nil {
  489. return nil, err
  490. }
  491. // Filler [1 byte]
  492. // Charset [16 bit uint]
  493. // Length [32 bit uint]
  494. pos += n + 1 + 2 + 4
  495. // Field type [byte]
  496. columns[i].fieldType = data[pos]
  497. pos++
  498. // Flags [16 bit uint]
  499. columns[i].flags = fieldFlag(binary.LittleEndian.Uint16(data[pos : pos+2]))
  500. //pos += 2
  501. // Decimals [8 bit uint]
  502. //pos++
  503. // Default value [len coded binary]
  504. //if pos < len(data) {
  505. // defaultVal, _, err = bytesToLengthCodedBinary(data[pos:])
  506. //}
  507. }
  508. }
  509. // Read Packets as Field Packets until EOF-Packet or an Error appears
  510. // http://dev.mysql.com/doc/internals/en/com-query-response.html#packet-ProtocolText::ResultsetRow
  511. func (rows *mysqlRows) readRow(dest []driver.Value) error {
  512. mc := rows.mc
  513. data, err := mc.readPacket()
  514. if err != nil {
  515. return err
  516. }
  517. // EOF Packet
  518. if data[0] == iEOF && len(data) == 5 {
  519. return io.EOF
  520. }
  521. // RowSet Packet
  522. var n int
  523. var isNull bool
  524. pos := 0
  525. for i := range dest {
  526. // Read bytes and convert to string
  527. dest[i], isNull, n, err = readLengthEnodedString(data[pos:])
  528. pos += n
  529. if err == nil {
  530. if !isNull {
  531. if !mc.parseTime {
  532. continue
  533. } else {
  534. switch rows.columns[i].fieldType {
  535. case fieldTypeTimestamp, fieldTypeDateTime,
  536. fieldTypeDate, fieldTypeNewDate:
  537. dest[i], err = parseDateTime(
  538. string(dest[i].([]byte)),
  539. mc.cfg.loc,
  540. )
  541. if err == nil {
  542. continue
  543. }
  544. default:
  545. continue
  546. }
  547. }
  548. } else {
  549. dest[i] = nil
  550. continue
  551. }
  552. }
  553. return err // err != nil
  554. }
  555. return nil
  556. }
  557. // Reads Packets until EOF-Packet or an Error appears. Returns count of Packets read
  558. func (mc *mysqlConn) readUntilEOF() error {
  559. for {
  560. data, err := mc.readPacket()
  561. // No Err and no EOF Packet
  562. if err == nil && data[0] != iEOF {
  563. continue
  564. }
  565. return err // Err or EOF
  566. }
  567. }
  568. /******************************************************************************
  569. * Prepared Statements *
  570. ******************************************************************************/
  571. // Prepare Result Packets
  572. // http://dev.mysql.com/doc/internals/en/com-stmt-prepare-response.html
  573. func (stmt *mysqlStmt) readPrepareResultPacket() (uint16, error) {
  574. data, err := stmt.mc.readPacket()
  575. if err == nil {
  576. // packet indicator [1 byte]
  577. if data[0] != iOK {
  578. return 0, stmt.mc.handleErrorPacket(data)
  579. }
  580. // statement id [4 bytes]
  581. stmt.id = binary.LittleEndian.Uint32(data[1:5])
  582. // Column count [16 bit uint]
  583. columnCount := binary.LittleEndian.Uint16(data[5:7])
  584. // Param count [16 bit uint]
  585. stmt.paramCount = int(binary.LittleEndian.Uint16(data[7:9]))
  586. // Reserved [8 bit]
  587. // Warning count [16 bit uint]
  588. if !stmt.mc.strict {
  589. return columnCount, nil
  590. } else {
  591. // Check for warnings count > 0, only available in MySQL > 4.1
  592. if len(data) >= 12 && binary.LittleEndian.Uint16(data[10:12]) > 0 {
  593. return columnCount, stmt.mc.getWarnings()
  594. }
  595. return columnCount, nil
  596. }
  597. }
  598. return 0, err
  599. }
  600. // http://dev.mysql.com/doc/internals/en/com-stmt-send-long-data.html
  601. func (stmt *mysqlStmt) writeCommandLongData(paramID int, arg []byte) error {
  602. maxLen := stmt.mc.maxPacketAllowed - 1
  603. pktLen := maxLen
  604. // After the header (bytes 0-3) follows before the data:
  605. // 1 byte command
  606. // 4 bytes stmtID
  607. // 2 bytes paramID
  608. const dataOffset = 1 + 4 + 2
  609. // Can not use the write buffer since
  610. // a) the buffer is too small
  611. // b) it is in use
  612. data := make([]byte, 4+1+4+2+len(arg))
  613. copy(data[4+dataOffset:], arg)
  614. for argLen := len(arg); argLen > 0; argLen -= pktLen - dataOffset {
  615. if dataOffset+argLen < maxLen {
  616. pktLen = dataOffset + argLen
  617. }
  618. // Add the packet header [24bit length + 1 byte sequence]
  619. data[0] = byte(pktLen)
  620. data[1] = byte(pktLen >> 8)
  621. data[2] = byte(pktLen >> 16)
  622. data[3] = 0x00 // mc.sequence
  623. // Add command byte [1 byte]
  624. data[4] = comStmtSendLongData
  625. // Add stmtID [32 bit]
  626. data[5] = byte(stmt.id)
  627. data[6] = byte(stmt.id >> 8)
  628. data[7] = byte(stmt.id >> 16)
  629. data[8] = byte(stmt.id >> 24)
  630. // Add paramID [16 bit]
  631. data[9] = byte(paramID)
  632. data[10] = byte(paramID >> 8)
  633. // Send CMD packet
  634. err := stmt.mc.writePacket(data[:4+pktLen])
  635. if err == nil {
  636. data = data[pktLen-dataOffset:]
  637. continue
  638. }
  639. return err
  640. }
  641. // Reset Packet Sequence
  642. stmt.mc.sequence = 0
  643. return nil
  644. }
  645. // Execute Prepared Statement
  646. // http://dev.mysql.com/doc/internals/en/com-stmt-execute.html
  647. func (stmt *mysqlStmt) writeExecutePacket(args []driver.Value) error {
  648. if len(args) != stmt.paramCount {
  649. return fmt.Errorf(
  650. "Arguments count mismatch (Got: %d Has: %d)",
  651. len(args),
  652. stmt.paramCount,
  653. )
  654. }
  655. mc := stmt.mc
  656. // Reset packet-sequence
  657. mc.sequence = 0
  658. var data []byte
  659. if len(args) == 0 {
  660. const pktLen = 1 + 4 + 1 + 4
  661. data = mc.buf.takeBuffer(4 + pktLen)
  662. if data == nil {
  663. // can not take the buffer. Something must be wrong with the connection
  664. errLog.Print("Busy buffer")
  665. return driver.ErrBadConn
  666. }
  667. // packet header [4 bytes]
  668. data[0] = byte(pktLen)
  669. data[1] = byte(pktLen >> 8)
  670. data[2] = byte(pktLen >> 16)
  671. data[3] = 0x00 // new command, sequence id is always 0
  672. } else {
  673. data = mc.buf.takeCompleteBuffer()
  674. if data == nil {
  675. // can not take the buffer. Something must be wrong with the connection
  676. errLog.Print("Busy buffer")
  677. return driver.ErrBadConn
  678. }
  679. // header (bytes 0-3) is added after we know the packet size
  680. }
  681. // command [1 byte]
  682. data[4] = comStmtExecute
  683. // statement_id [4 bytes]
  684. data[5] = byte(stmt.id)
  685. data[6] = byte(stmt.id >> 8)
  686. data[7] = byte(stmt.id >> 16)
  687. data[8] = byte(stmt.id >> 24)
  688. // flags (0: CURSOR_TYPE_NO_CURSOR) [1 byte]
  689. data[9] = 0x00
  690. // iteration_count (uint32(1)) [4 bytes]
  691. data[10] = 0x01
  692. data[11] = 0x00
  693. data[12] = 0x00
  694. data[13] = 0x00
  695. if len(args) > 0 {
  696. // NULL-bitmap [(len(args)+7)/8 bytes]
  697. nullMask := uint64(0)
  698. pos := 4 + 1 + 4 + 1 + 4 + ((len(args) + 7) >> 3)
  699. // newParameterBoundFlag 1 [1 byte]
  700. data[pos] = 0x01
  701. pos++
  702. // type of each parameter [len(args)*2 bytes]
  703. paramTypes := data[pos:]
  704. pos += (len(args) << 1)
  705. // value of each parameter [n bytes]
  706. paramValues := data[pos:pos]
  707. valuesCap := cap(paramValues)
  708. for i := range args {
  709. // build NULL-bitmap
  710. if args[i] == nil {
  711. nullMask |= 1 << uint(i)
  712. paramTypes[i+i] = fieldTypeNULL
  713. paramTypes[i+i+1] = 0x00
  714. continue
  715. }
  716. // cache types and values
  717. switch v := args[i].(type) {
  718. case int64:
  719. paramTypes[i+i] = fieldTypeLongLong
  720. paramTypes[i+i+1] = 0x00
  721. if cap(paramValues)-len(paramValues)-8 >= 0 {
  722. paramValues = paramValues[:len(paramValues)+8]
  723. binary.LittleEndian.PutUint64(
  724. paramValues[len(paramValues)-8:],
  725. uint64(v),
  726. )
  727. } else {
  728. paramValues = append(paramValues,
  729. uint64ToBytes(uint64(v))...,
  730. )
  731. }
  732. case float64:
  733. paramTypes[i+i] = fieldTypeDouble
  734. paramTypes[i+i+1] = 0x00
  735. if cap(paramValues)-len(paramValues)-8 >= 0 {
  736. paramValues = paramValues[:len(paramValues)+8]
  737. binary.LittleEndian.PutUint64(
  738. paramValues[len(paramValues)-8:],
  739. math.Float64bits(v),
  740. )
  741. } else {
  742. paramValues = append(paramValues,
  743. uint64ToBytes(math.Float64bits(v))...,
  744. )
  745. }
  746. case bool:
  747. paramTypes[i+i] = fieldTypeTiny
  748. paramTypes[i+i+1] = 0x00
  749. if v {
  750. paramValues = append(paramValues, 0x01)
  751. } else {
  752. paramValues = append(paramValues, 0x00)
  753. }
  754. case []byte:
  755. paramTypes[i+i] = fieldTypeString
  756. paramTypes[i+i+1] = 0x00
  757. if len(v) < mc.maxPacketAllowed-pos-len(paramValues)-(len(args)-(i+1))*64 {
  758. paramValues = appendLengthEncodedInteger(paramValues,
  759. uint64(len(v)),
  760. )
  761. paramValues = append(paramValues, v...)
  762. } else {
  763. if err := stmt.writeCommandLongData(i, v); err != nil {
  764. return err
  765. }
  766. }
  767. case string:
  768. paramTypes[i+i] = fieldTypeString
  769. paramTypes[i+i+1] = 0x00
  770. if len(v) < mc.maxPacketAllowed-pos-len(paramValues)-(len(args)-(i+1))*64 {
  771. paramValues = appendLengthEncodedInteger(paramValues,
  772. uint64(len(v)),
  773. )
  774. paramValues = append(paramValues, v...)
  775. } else {
  776. if err := stmt.writeCommandLongData(i, []byte(v)); err != nil {
  777. return err
  778. }
  779. }
  780. case time.Time:
  781. paramTypes[i+i] = fieldTypeString
  782. paramTypes[i+i+1] = 0x00
  783. var val []byte
  784. if v.IsZero() {
  785. val = []byte("0000-00-00")
  786. } else {
  787. val = []byte(v.In(mc.cfg.loc).Format(timeFormat))
  788. }
  789. paramValues = appendLengthEncodedInteger(paramValues,
  790. uint64(len(val)),
  791. )
  792. paramValues = append(paramValues, val...)
  793. default:
  794. return fmt.Errorf("Can't convert type: %T", args[i])
  795. }
  796. }
  797. // Check if param values exceeded the available buffer
  798. // In that case we must build the data packet with the new values buffer
  799. if valuesCap != cap(paramValues) {
  800. data = append(data[:pos], paramValues...)
  801. mc.buf.buf = data
  802. }
  803. pos += len(paramValues)
  804. data = data[:pos]
  805. pktLen := pos - 4
  806. // packet header [4 bytes]
  807. data[0] = byte(pktLen)
  808. data[1] = byte(pktLen >> 8)
  809. data[2] = byte(pktLen >> 16)
  810. data[3] = mc.sequence
  811. // Convert nullMask to bytes
  812. for i, max := 0, (stmt.paramCount+7)>>3; i < max; i++ {
  813. data[i+14] = byte(nullMask >> uint(i<<3))
  814. }
  815. }
  816. return mc.writePacket(data)
  817. }
  818. // http://dev.mysql.com/doc/internals/en/binary-protocol-resultset-row.html
  819. func (rows *mysqlRows) readBinaryRow(dest []driver.Value) error {
  820. data, err := rows.mc.readPacket()
  821. if err != nil {
  822. return err
  823. }
  824. // packet indicator [1 byte]
  825. if data[0] != iOK {
  826. // EOF Packet
  827. if data[0] == iEOF && len(data) == 5 {
  828. return io.EOF
  829. }
  830. // Error otherwise
  831. return rows.mc.handleErrorPacket(data)
  832. }
  833. // NULL-bitmap, [(column-count + 7 + 2) / 8 bytes]
  834. pos := 1 + (len(dest)+7+2)>>3
  835. nullMask := data[1:pos]
  836. for i := range dest {
  837. // Field is NULL
  838. // (byte >> bit-pos) % 2 == 1
  839. if ((nullMask[(i+2)>>3] >> uint((i+2)&7)) & 1) == 1 {
  840. dest[i] = nil
  841. continue
  842. }
  843. // Convert to byte-coded string
  844. switch rows.columns[i].fieldType {
  845. case fieldTypeNULL:
  846. dest[i] = nil
  847. continue
  848. // Numeric Types
  849. case fieldTypeTiny:
  850. if rows.columns[i].flags&flagUnsigned != 0 {
  851. dest[i] = int64(data[pos])
  852. } else {
  853. dest[i] = int64(int8(data[pos]))
  854. }
  855. pos++
  856. continue
  857. case fieldTypeShort, fieldTypeYear:
  858. if rows.columns[i].flags&flagUnsigned != 0 {
  859. dest[i] = int64(binary.LittleEndian.Uint16(data[pos : pos+2]))
  860. } else {
  861. dest[i] = int64(int16(binary.LittleEndian.Uint16(data[pos : pos+2])))
  862. }
  863. pos += 2
  864. continue
  865. case fieldTypeInt24, fieldTypeLong:
  866. if rows.columns[i].flags&flagUnsigned != 0 {
  867. dest[i] = int64(binary.LittleEndian.Uint32(data[pos : pos+4]))
  868. } else {
  869. dest[i] = int64(int32(binary.LittleEndian.Uint32(data[pos : pos+4])))
  870. }
  871. pos += 4
  872. continue
  873. case fieldTypeLongLong:
  874. if rows.columns[i].flags&flagUnsigned != 0 {
  875. val := binary.LittleEndian.Uint64(data[pos : pos+8])
  876. if val > math.MaxInt64 {
  877. dest[i] = uint64ToString(val)
  878. } else {
  879. dest[i] = int64(val)
  880. }
  881. } else {
  882. dest[i] = int64(binary.LittleEndian.Uint64(data[pos : pos+8]))
  883. }
  884. pos += 8
  885. continue
  886. case fieldTypeFloat:
  887. dest[i] = float64(math.Float32frombits(binary.LittleEndian.Uint32(data[pos : pos+4])))
  888. pos += 4
  889. continue
  890. case fieldTypeDouble:
  891. dest[i] = math.Float64frombits(binary.LittleEndian.Uint64(data[pos : pos+8]))
  892. pos += 8
  893. continue
  894. // Length coded Binary Strings
  895. case fieldTypeDecimal, fieldTypeNewDecimal, fieldTypeVarChar,
  896. fieldTypeBit, fieldTypeEnum, fieldTypeSet, fieldTypeTinyBLOB,
  897. fieldTypeMediumBLOB, fieldTypeLongBLOB, fieldTypeBLOB,
  898. fieldTypeVarString, fieldTypeString, fieldTypeGeometry:
  899. var isNull bool
  900. var n int
  901. dest[i], isNull, n, err = readLengthEnodedString(data[pos:])
  902. pos += n
  903. if err == nil {
  904. if !isNull {
  905. continue
  906. } else {
  907. dest[i] = nil
  908. continue
  909. }
  910. }
  911. return err
  912. // Date YYYY-MM-DD
  913. case fieldTypeDate, fieldTypeNewDate:
  914. num, isNull, n := readLengthEncodedInteger(data[pos:])
  915. pos += n
  916. if isNull {
  917. dest[i] = nil
  918. continue
  919. }
  920. if rows.mc.parseTime {
  921. dest[i], err = parseBinaryDateTime(num, data[pos:], rows.mc.cfg.loc)
  922. } else {
  923. dest[i], err = formatBinaryDate(num, data[pos:])
  924. }
  925. if err == nil {
  926. pos += int(num)
  927. continue
  928. } else {
  929. return err
  930. }
  931. // Time [-][H]HH:MM:SS[.fractal]
  932. case fieldTypeTime:
  933. num, isNull, n := readLengthEncodedInteger(data[pos:])
  934. pos += n
  935. if num == 0 {
  936. if isNull {
  937. dest[i] = nil
  938. continue
  939. } else {
  940. dest[i] = []byte("00:00:00")
  941. continue
  942. }
  943. }
  944. var sign byte
  945. if data[pos] == 1 {
  946. sign = byte('-')
  947. }
  948. switch num {
  949. case 8:
  950. dest[i] = []byte(fmt.Sprintf(
  951. "%c%02d:%02d:%02d",
  952. sign,
  953. uint16(data[pos+1])*24+uint16(data[pos+5]),
  954. data[pos+6],
  955. data[pos+7],
  956. ))
  957. pos += 8
  958. continue
  959. case 12:
  960. dest[i] = []byte(fmt.Sprintf(
  961. "%c%02d:%02d:%02d.%06d",
  962. sign,
  963. uint16(data[pos+1])*24+uint16(data[pos+5]),
  964. data[pos+6],
  965. data[pos+7],
  966. binary.LittleEndian.Uint32(data[pos+8:pos+12]),
  967. ))
  968. pos += 12
  969. continue
  970. default:
  971. return fmt.Errorf("Invalid TIME-packet length %d", num)
  972. }
  973. // Timestamp YYYY-MM-DD HH:MM:SS[.fractal]
  974. case fieldTypeTimestamp, fieldTypeDateTime:
  975. num, isNull, n := readLengthEncodedInteger(data[pos:])
  976. pos += n
  977. if isNull {
  978. dest[i] = nil
  979. continue
  980. }
  981. if rows.mc.parseTime {
  982. dest[i], err = parseBinaryDateTime(num, data[pos:], rows.mc.cfg.loc)
  983. } else {
  984. dest[i], err = formatBinaryDateTime(num, data[pos:])
  985. }
  986. if err == nil {
  987. pos += int(num)
  988. continue
  989. } else {
  990. return err
  991. }
  992. // Please report if this happens!
  993. default:
  994. return fmt.Errorf("Unknown FieldType %d", rows.columns[i].fieldType)
  995. }
  996. }
  997. return nil
  998. }