packets.go 28 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213
  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() (data []byte, err 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. var buf []byte
  52. buf = append(buf, data...)
  53. // More data
  54. data, err = mc.readPacket()
  55. if err == nil {
  56. return append(buf, data...), nil
  57. }
  58. }
  59. // err case
  60. mc.Close()
  61. errLog.Print(err.Error())
  62. return nil, driver.ErrBadConn
  63. }
  64. // Write packet buffer 'data'
  65. // The packet header must be already included
  66. func (mc *mysqlConn) writePacket(data []byte) error {
  67. if len(data)-4 <= mc.maxWriteSize { // Can send data at once
  68. // Write packet
  69. n, err := mc.netConn.Write(data)
  70. if err == nil && n == len(data) {
  71. mc.sequence++
  72. return nil
  73. }
  74. // Handle error
  75. if err == nil { // n != len(data)
  76. errLog.Print(errMalformPkt.Error())
  77. } else {
  78. errLog.Print(err.Error())
  79. }
  80. return driver.ErrBadConn
  81. }
  82. // Must split packet
  83. return mc.splitPacket(data)
  84. }
  85. func (mc *mysqlConn) splitPacket(data []byte) (err error) {
  86. pktLen := len(data) - 4
  87. if pktLen > mc.maxPacketAllowed {
  88. return errPktTooLarge
  89. }
  90. for pktLen >= maxPacketSize {
  91. data[0] = 0xff
  92. data[1] = 0xff
  93. data[2] = 0xff
  94. data[3] = mc.sequence
  95. // Write packet
  96. n, err := mc.netConn.Write(data[:4+maxPacketSize])
  97. if err == nil && n == 4+maxPacketSize {
  98. mc.sequence++
  99. data = data[maxPacketSize:]
  100. pktLen -= maxPacketSize
  101. continue
  102. }
  103. // Handle error
  104. if err == nil { // n != len(data)
  105. errLog.Print(errMalformPkt.Error())
  106. } else {
  107. errLog.Print(err.Error())
  108. }
  109. return driver.ErrBadConn
  110. }
  111. data[0] = byte(pktLen)
  112. data[1] = byte(pktLen >> 8)
  113. data[2] = byte(pktLen >> 16)
  114. data[3] = mc.sequence
  115. return mc.writePacket(data)
  116. }
  117. /******************************************************************************
  118. * Initialisation Process *
  119. ******************************************************************************/
  120. // Handshake Initialization Packet
  121. // http://dev.mysql.com/doc/internals/en/connection-phase.html#packet-Protocol::Handshake
  122. func (mc *mysqlConn) readInitPacket() (cipher []byte, err error) {
  123. data, err := mc.readPacket()
  124. if err != nil {
  125. return
  126. }
  127. if data[0] == iERR {
  128. return nil, mc.handleErrorPacket(data)
  129. }
  130. // protocol version [1 byte]
  131. if data[0] < minProtocolVersion {
  132. err = fmt.Errorf(
  133. "Unsupported MySQL Protocol Version %d. Protocol Version %d or higher is required",
  134. data[0],
  135. minProtocolVersion)
  136. return
  137. }
  138. // server version [null terminated string]
  139. // connection id [4 bytes]
  140. pos := 1 + bytes.IndexByte(data[1:], 0x00) + 1 + 4
  141. // first part of the password cipher [8 bytes]
  142. cipher = data[pos : pos+8]
  143. // (filler) always 0x00 [1 byte]
  144. pos += 8 + 1
  145. // capability flags (lower 2 bytes) [2 bytes]
  146. mc.flags = clientFlag(binary.LittleEndian.Uint16(data[pos : pos+2]))
  147. if mc.flags&clientProtocol41 == 0 {
  148. return nil, errOldProtocol
  149. }
  150. if mc.flags&clientSSL == 0 && mc.cfg.tls != nil {
  151. return nil, errNoTLS
  152. }
  153. pos += 2
  154. if len(data) > pos {
  155. // character set [1 byte]
  156. // status flags [2 bytes]
  157. // capability flags (upper 2 bytes) [2 bytes]
  158. // length of auth-plugin-data [1 byte]
  159. // reserved (all [00]) [10 bytes]
  160. pos += 1 + 2 + 2 + 1 + 10
  161. // second part of the password cipher [12? bytes]
  162. // The documentation is ambiguous about the length.
  163. // The official Python library uses the fixed length 12
  164. // which is not documented but seems to work.
  165. cipher = append(cipher, data[pos:pos+12]...)
  166. // TODO: Verify string termination
  167. // EOF if version (>= 5.5.7 and < 5.5.10) or (>= 5.6.0 and < 5.6.2)
  168. // \NUL otherwise
  169. // http://dev.mysql.com/doc/internals/en/connection-phase.html#packet-Protocol::Handshake
  170. //
  171. //if data[len(data)-1] == 0 {
  172. // return
  173. //}
  174. //return errMalformPkt
  175. }
  176. return
  177. }
  178. // Client Authentication Packet
  179. // http://dev.mysql.com/doc/internals/en/connection-phase.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.smallWriteBuffer(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.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.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.smallWriteBuffer(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.smallWriteBuffer(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 // sequence 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.writeBuffer(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 // sequence 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.smallWriteBuffer(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 // 1 bytes long
  343. data[1] = 0x00
  344. data[2] = 0x00
  345. data[3] = 0x00 // sequence 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/text-protocol.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/overview.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. //sqlstate := string(data[pos : pos+6])
  410. if data[pos] == 0x23 {
  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/overview.html#packet-OK_Packet
  421. func (mc *mysqlConn) handleOkPacket(data []byte) (err 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
  432. } else {
  433. pos := 1 + n + m + 2
  434. if binary.LittleEndian.Uint16(data[pos:pos+2]) > 0 {
  435. err = mc.getWarnings()
  436. }
  437. }
  438. // message [until end of packet]
  439. return
  440. }
  441. // Read Packets as Field Packets until EOF-Packet or an Error appears
  442. // http://dev.mysql.com/doc/internals/en/text-protocol.html#packet-Protocol::ColumnDefinition41
  443. func (mc *mysqlConn) readColumns(count int) (columns []mysqlField, err error) {
  444. var data []byte
  445. var i, pos, n int
  446. var name []byte
  447. columns = make([]mysqlField, count)
  448. for {
  449. data, err = mc.readPacket()
  450. if err != nil {
  451. return
  452. }
  453. // EOF Packet
  454. if data[0] == iEOF && (len(data) == 5 || len(data) == 1) {
  455. if i != count {
  456. err = fmt.Errorf("ColumnsCount mismatch n:%d len:%d", count, len(columns))
  457. }
  458. return
  459. }
  460. // Catalog
  461. pos, err = skipLengthEnodedString(data)
  462. if err != nil {
  463. return
  464. }
  465. // Database [len coded string]
  466. n, err = skipLengthEnodedString(data[pos:])
  467. if err != nil {
  468. return
  469. }
  470. pos += n
  471. // Table [len coded string]
  472. n, err = skipLengthEnodedString(data[pos:])
  473. if err != nil {
  474. return
  475. }
  476. pos += n
  477. // Original table [len coded string]
  478. n, err = skipLengthEnodedString(data[pos:])
  479. if err != nil {
  480. return
  481. }
  482. pos += n
  483. // Name [len coded string]
  484. name, _, n, err = readLengthEnodedString(data[pos:])
  485. if err != nil {
  486. return
  487. }
  488. columns[i].name = string(name)
  489. pos += n
  490. // Original name [len coded string]
  491. n, err = skipLengthEnodedString(data[pos:])
  492. if err != nil {
  493. return
  494. }
  495. // Filler [1 byte]
  496. // Charset [16 bit uint]
  497. // Length [32 bit uint]
  498. pos += n + 1 + 2 + 4
  499. // Field type [byte]
  500. columns[i].fieldType = data[pos]
  501. pos++
  502. // Flags [16 bit uint]
  503. columns[i].flags = fieldFlag(binary.LittleEndian.Uint16(data[pos : pos+2]))
  504. //pos += 2
  505. // Decimals [8 bit uint]
  506. //pos++
  507. // Default value [len coded binary]
  508. //if pos < len(data) {
  509. // defaultVal, _, err = bytesToLengthCodedBinary(data[pos:])
  510. //}
  511. i++
  512. }
  513. }
  514. // Read Packets as Field Packets until EOF-Packet or an Error appears
  515. // http://dev.mysql.com/doc/internals/en/text-protocol.html#packet-ProtocolText::ResultsetRow
  516. func (rows *mysqlRows) readRow(dest []driver.Value) error {
  517. data, err := rows.mc.readPacket()
  518. if err != nil {
  519. return err
  520. }
  521. // EOF Packet
  522. if data[0] == iEOF && len(data) == 5 {
  523. return io.EOF
  524. }
  525. // RowSet Packet
  526. var n int
  527. var isNull bool
  528. pos := 0
  529. for i := range dest {
  530. // Read bytes and convert to string
  531. dest[i], isNull, n, err = readLengthEnodedString(data[pos:])
  532. pos += n
  533. if err == nil {
  534. if !isNull {
  535. if !rows.mc.parseTime {
  536. continue
  537. } else {
  538. switch rows.columns[i].fieldType {
  539. case fieldTypeTimestamp, fieldTypeDateTime,
  540. fieldTypeDate, fieldTypeNewDate:
  541. dest[i], err = parseDateTime(string(dest[i].([]byte)), rows.mc.cfg.loc)
  542. if err == nil {
  543. continue
  544. }
  545. default:
  546. continue
  547. }
  548. }
  549. } else {
  550. dest[i] = nil
  551. continue
  552. }
  553. }
  554. return err // err != nil
  555. }
  556. return nil
  557. }
  558. // Reads Packets until EOF-Packet or an Error appears. Returns count of Packets read
  559. func (mc *mysqlConn) readUntilEOF() error {
  560. for {
  561. data, err := mc.readPacket()
  562. // No Err and no EOF Packet
  563. if err == nil && data[0] != iEOF {
  564. continue
  565. }
  566. return err // Err or EOF
  567. }
  568. }
  569. /******************************************************************************
  570. * Prepared Statements *
  571. ******************************************************************************/
  572. // Prepare Result Packets
  573. // http://dev.mysql.com/doc/internals/en/prepared-statements.html#com-stmt-prepare-response
  574. func (stmt *mysqlStmt) readPrepareResultPacket() (columnCount uint16, err error) {
  575. data, err := stmt.mc.readPacket()
  576. if err == nil {
  577. // Position
  578. pos := 0
  579. // packet indicator [1 byte]
  580. if data[pos] != iOK {
  581. err = stmt.mc.handleErrorPacket(data)
  582. return
  583. }
  584. pos++
  585. // statement id [4 bytes]
  586. stmt.id = binary.LittleEndian.Uint32(data[pos : pos+4])
  587. pos += 4
  588. // Column count [16 bit uint]
  589. columnCount = binary.LittleEndian.Uint16(data[pos : pos+2])
  590. pos += 2
  591. // Param count [16 bit uint]
  592. stmt.paramCount = int(binary.LittleEndian.Uint16(data[pos : pos+2]))
  593. pos += 2
  594. // Reserved [8 bit]
  595. pos++
  596. // Warning count [16 bit uint]
  597. if !stmt.mc.strict {
  598. return
  599. } else {
  600. // Check for warnings count > 0, only available in MySQL > 4.1
  601. if len(data) >= 12 && binary.LittleEndian.Uint16(data[pos:pos+2]) > 0 {
  602. err = stmt.mc.getWarnings()
  603. }
  604. }
  605. }
  606. return
  607. }
  608. // http://dev.mysql.com/doc/internals/en/prepared-statements.html#com-stmt-send-long-data
  609. func (stmt *mysqlStmt) writeCommandLongData(paramID int, arg []byte) error {
  610. maxLen := stmt.mc.maxPacketAllowed - 1
  611. pktLen := maxLen
  612. argLen := len(arg)
  613. // Can not use the write buffer since
  614. // a) the buffer is too small
  615. // b) it is in use
  616. data := make([]byte, 4+1+4+2+argLen)
  617. copy(data[4+1+4+2:], arg)
  618. for argLen > 0 {
  619. if 1+4+2+argLen < maxLen {
  620. pktLen = 1 + 4 + 2 + argLen
  621. }
  622. // Add the packet header [24bit length + 1 byte sequence]
  623. data[0] = byte(pktLen)
  624. data[1] = byte(pktLen >> 8)
  625. data[2] = byte(pktLen >> 16)
  626. data[3] = 0x00 // mc.sequence
  627. // Add command byte [1 byte]
  628. data[4] = comStmtSendLongData
  629. // Add stmtID [32 bit]
  630. data[5] = byte(stmt.id)
  631. data[6] = byte(stmt.id >> 8)
  632. data[7] = byte(stmt.id >> 16)
  633. data[8] = byte(stmt.id >> 24)
  634. // Add paramID [16 bit]
  635. data[9] = byte(paramID)
  636. data[10] = byte(paramID >> 8)
  637. // Send CMD packet
  638. err := stmt.mc.writePacket(data[:4+pktLen])
  639. if err == nil {
  640. argLen -= pktLen - (1 + 4 + 2)
  641. data = data[pktLen-(1+4+2):]
  642. continue
  643. }
  644. return err
  645. }
  646. // Reset Packet Sequence
  647. stmt.mc.sequence = 0
  648. return nil
  649. }
  650. // Execute Prepared Statement
  651. // http://dev.mysql.com/doc/internals/en/com-stmt-execute.html
  652. func (stmt *mysqlStmt) writeExecutePacket(args []driver.Value) error {
  653. if len(args) != stmt.paramCount {
  654. return fmt.Errorf(
  655. "Arguments count mismatch (Got: %d Has: %d)",
  656. len(args),
  657. stmt.paramCount)
  658. }
  659. // Reset packet-sequence
  660. stmt.mc.sequence = 0
  661. var data []byte
  662. if len(args) == 0 {
  663. const pktLen = 1 + 4 + 1 + 4
  664. data = stmt.mc.buf.writeBuffer(4 + pktLen)
  665. if data == nil {
  666. // can not take the buffer. Something must be wrong with the connection
  667. errLog.Print("Busy buffer")
  668. return driver.ErrBadConn
  669. }
  670. // packet header [4 bytes]
  671. data[0] = byte(pktLen)
  672. data[1] = byte(pktLen >> 8)
  673. data[2] = byte(pktLen >> 16)
  674. data[3] = 0x00 // sequence is always 0
  675. } else {
  676. data = stmt.mc.buf.takeCompleteBuffer()
  677. if data == nil {
  678. // can not take the buffer. Something must be wrong with the connection
  679. errLog.Print("Busy buffer")
  680. return driver.ErrBadConn
  681. }
  682. // header (bytes 0-3) is added after we know the packet size
  683. }
  684. // command [1 byte]
  685. data[4] = comStmtExecute
  686. // statement_id [4 bytes]
  687. data[5] = byte(stmt.id)
  688. data[6] = byte(stmt.id >> 8)
  689. data[7] = byte(stmt.id >> 16)
  690. data[8] = byte(stmt.id >> 24)
  691. // flags (0: CURSOR_TYPE_NO_CURSOR) [1 byte]
  692. data[9] = 0x00
  693. // iteration_count (uint32(1)) [4 bytes]
  694. data[10] = 0x01
  695. data[11] = 0x00
  696. data[12] = 0x00
  697. data[13] = 0x00
  698. if len(args) > 0 {
  699. // NULL-bitmap [(len(args)+7)/8 bytes]
  700. nullMask := uint64(0)
  701. pos := 4 + 1 + 4 + 1 + 4 + ((len(args) + 7) >> 3)
  702. // newParameterBoundFlag 1 [1 byte]
  703. data[pos] = 0x01
  704. pos++
  705. // type of each parameter [len(args)*2 bytes]
  706. paramTypes := data[pos:]
  707. pos += (len(args) << 1)
  708. // value of each parameter [n bytes]
  709. paramValues := data[pos:pos]
  710. valuesCap := cap(paramValues)
  711. for i := range args {
  712. // build NULL-bitmap
  713. if args[i] == nil {
  714. nullMask |= 1 << uint(i)
  715. paramTypes[i+i] = fieldTypeNULL
  716. paramTypes[i+i+1] = 0x00
  717. continue
  718. }
  719. // cache types and values
  720. switch v := args[i].(type) {
  721. case int64:
  722. paramTypes[i+i] = fieldTypeLongLong
  723. paramTypes[i+i+1] = 0x00
  724. if cap(paramValues)-len(paramValues)-8 >= 0 {
  725. paramValues = paramValues[:len(paramValues)+8]
  726. binary.LittleEndian.PutUint64(paramValues[len(paramValues)-8:], uint64(v))
  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(paramValues[len(paramValues)-8:], math.Float64bits(v))
  738. } else {
  739. paramValues = append(paramValues,
  740. uint64ToBytes(math.Float64bits(v))...,
  741. )
  742. }
  743. case bool:
  744. paramTypes[i+i] = fieldTypeTiny
  745. paramTypes[i+i+1] = 0x00
  746. if v {
  747. paramValues = append(paramValues, 0x01)
  748. } else {
  749. paramValues = append(paramValues, 0x00)
  750. }
  751. case []byte:
  752. paramTypes[i+i] = fieldTypeString
  753. paramTypes[i+i+1] = 0x00
  754. if len(v) < stmt.mc.maxPacketAllowed-pos-len(paramValues)-(len(args)-(i+1))*64 {
  755. paramValues = append(paramValues,
  756. lengthEncodedIntegerToBytes(uint64(len(v)))...,
  757. )
  758. paramValues = append(paramValues, v...)
  759. } else {
  760. if err := stmt.writeCommandLongData(i, v); err != nil {
  761. return err
  762. }
  763. }
  764. case string:
  765. paramTypes[i+i] = fieldTypeString
  766. paramTypes[i+i+1] = 0x00
  767. if len(v) < stmt.mc.maxPacketAllowed-pos-len(paramValues)-(len(args)-(i+1))*64 {
  768. paramValues = append(paramValues,
  769. lengthEncodedIntegerToBytes(uint64(len(v)))...,
  770. )
  771. paramValues = append(paramValues, v...)
  772. } else {
  773. if err := stmt.writeCommandLongData(i, []byte(v)); err != nil {
  774. return err
  775. }
  776. }
  777. case time.Time:
  778. paramTypes[i+i] = fieldTypeString
  779. paramTypes[i+i+1] = 0x00
  780. var val []byte
  781. if v.IsZero() {
  782. val = []byte("0000-00-00")
  783. } else {
  784. val = []byte(v.In(stmt.mc.cfg.loc).Format(timeFormat))
  785. }
  786. paramValues = append(paramValues,
  787. lengthEncodedIntegerToBytes(uint64(len(val)))...,
  788. )
  789. paramValues = append(paramValues, val...)
  790. default:
  791. return fmt.Errorf("Can't convert type: %T", args[i])
  792. }
  793. }
  794. // Check if param values exceeded the available buffer
  795. // In that case we must build the data packet with the new values buffer
  796. if valuesCap != cap(paramValues) {
  797. data = append(data[:pos], paramValues...)
  798. stmt.mc.buf.buf = data
  799. }
  800. pos += len(paramValues)
  801. data = data[:pos]
  802. pktLen := pos - 4
  803. // packet header [4 bytes]
  804. data[0] = byte(pktLen)
  805. data[1] = byte(pktLen >> 8)
  806. data[2] = byte(pktLen >> 16)
  807. data[3] = stmt.mc.sequence
  808. // Convert nullMask to bytes
  809. for i, max := 14, 14+((stmt.paramCount+7)>>3); i < max; i++ {
  810. data[i] = byte(nullMask >> uint((i-14)<<3))
  811. }
  812. }
  813. return stmt.mc.writePacket(data)
  814. }
  815. // http://dev.mysql.com/doc/internals/en/prepared-statements.html#packet-ProtocolBinary::ResultsetRow
  816. func (rows *mysqlRows) readBinaryRow(dest []driver.Value) (err error) {
  817. data, err := rows.mc.readPacket()
  818. if err != nil {
  819. return
  820. }
  821. // packet indicator [1 byte]
  822. if data[0] != iOK {
  823. // EOF Packet
  824. if data[0] == iEOF && len(data) == 5 {
  825. return io.EOF
  826. } else {
  827. // Error otherwise
  828. return rows.mc.handleErrorPacket(data)
  829. }
  830. }
  831. // NULL-bitmap, [(column-count + 7 + 2) / 8 bytes]
  832. pos := 1 + (len(dest)+7+2)>>3
  833. nullBitMap := data[1:pos]
  834. // values [rest]
  835. var n int
  836. var unsigned bool
  837. for i := range dest {
  838. // Field is NULL
  839. // (byte >> bit-pos) % 2 == 1
  840. if ((nullBitMap[(i+2)>>3] >> uint((i+2)&7)) & 1) == 1 {
  841. dest[i] = nil
  842. continue
  843. }
  844. unsigned = rows.columns[i].flags&flagUnsigned != 0
  845. // Convert to byte-coded string
  846. switch rows.columns[i].fieldType {
  847. case fieldTypeNULL:
  848. dest[i] = nil
  849. continue
  850. // Numeric Types
  851. case fieldTypeTiny:
  852. if unsigned {
  853. dest[i] = int64(data[pos])
  854. } else {
  855. dest[i] = int64(int8(data[pos]))
  856. }
  857. pos++
  858. continue
  859. case fieldTypeShort, fieldTypeYear:
  860. if unsigned {
  861. dest[i] = int64(binary.LittleEndian.Uint16(data[pos : pos+2]))
  862. } else {
  863. dest[i] = int64(int16(binary.LittleEndian.Uint16(data[pos : pos+2])))
  864. }
  865. pos += 2
  866. continue
  867. case fieldTypeInt24, fieldTypeLong:
  868. if unsigned {
  869. dest[i] = int64(binary.LittleEndian.Uint32(data[pos : pos+4]))
  870. } else {
  871. dest[i] = int64(int32(binary.LittleEndian.Uint32(data[pos : pos+4])))
  872. }
  873. pos += 4
  874. continue
  875. case fieldTypeLongLong:
  876. if unsigned {
  877. val := binary.LittleEndian.Uint64(data[pos : pos+8])
  878. if val > math.MaxInt64 {
  879. dest[i] = uint64ToString(val)
  880. } else {
  881. dest[i] = int64(val)
  882. }
  883. } else {
  884. dest[i] = int64(binary.LittleEndian.Uint64(data[pos : pos+8]))
  885. }
  886. pos += 8
  887. continue
  888. case fieldTypeFloat:
  889. dest[i] = float64(math.Float32frombits(binary.LittleEndian.Uint32(data[pos : pos+4])))
  890. pos += 4
  891. continue
  892. case fieldTypeDouble:
  893. dest[i] = math.Float64frombits(binary.LittleEndian.Uint64(data[pos : pos+8]))
  894. pos += 8
  895. continue
  896. // Length coded Binary Strings
  897. case fieldTypeDecimal, fieldTypeNewDecimal, fieldTypeVarChar,
  898. fieldTypeBit, fieldTypeEnum, fieldTypeSet, fieldTypeTinyBLOB,
  899. fieldTypeMediumBLOB, fieldTypeLongBLOB, fieldTypeBLOB,
  900. fieldTypeVarString, fieldTypeString, fieldTypeGeometry:
  901. var isNull bool
  902. dest[i], isNull, n, err = readLengthEnodedString(data[pos:])
  903. pos += n
  904. if err == nil {
  905. if !isNull {
  906. continue
  907. } else {
  908. dest[i] = nil
  909. continue
  910. }
  911. }
  912. return // err
  913. // Date YYYY-MM-DD
  914. case fieldTypeDate, fieldTypeNewDate:
  915. var num uint64
  916. var isNull bool
  917. num, isNull, n = readLengthEncodedInteger(data[pos:])
  918. pos += n
  919. if isNull {
  920. dest[i] = nil
  921. continue
  922. }
  923. if rows.mc.parseTime {
  924. dest[i], err = parseBinaryDateTime(num, data[pos:], rows.mc.cfg.loc)
  925. } else {
  926. dest[i], err = formatBinaryDate(num, data[pos:])
  927. }
  928. if err == nil {
  929. pos += int(num)
  930. continue
  931. } else {
  932. return err
  933. }
  934. // Time [-][H]HH:MM:SS[.fractal]
  935. case fieldTypeTime:
  936. var num uint64
  937. var isNull bool
  938. num, isNull, n = readLengthEncodedInteger(data[pos:])
  939. pos += n
  940. if num == 0 {
  941. if isNull {
  942. dest[i] = nil
  943. continue
  944. } else {
  945. dest[i] = []byte("00:00:00")
  946. continue
  947. }
  948. }
  949. var sign byte
  950. if data[pos] == 1 {
  951. sign = byte('-')
  952. }
  953. switch num {
  954. case 8:
  955. dest[i] = []byte(fmt.Sprintf(
  956. "%c%02d:%02d:%02d",
  957. sign,
  958. uint16(data[pos+1])*24+uint16(data[pos+5]),
  959. data[pos+6],
  960. data[pos+7],
  961. ))
  962. pos += 8
  963. continue
  964. case 12:
  965. dest[i] = []byte(fmt.Sprintf(
  966. "%c%02d:%02d:%02d.%06d",
  967. sign,
  968. uint16(data[pos+1])*24+uint16(data[pos+5]),
  969. data[pos+6],
  970. data[pos+7],
  971. binary.LittleEndian.Uint32(data[pos+8:pos+12]),
  972. ))
  973. pos += 12
  974. continue
  975. default:
  976. return fmt.Errorf("Invalid TIME-packet length %d", num)
  977. }
  978. // Timestamp YYYY-MM-DD HH:MM:SS[.fractal]
  979. case fieldTypeTimestamp, fieldTypeDateTime:
  980. var num uint64
  981. var isNull bool
  982. num, isNull, n = readLengthEncodedInteger(data[pos:])
  983. pos += n
  984. if isNull {
  985. dest[i] = nil
  986. continue
  987. }
  988. if rows.mc.parseTime {
  989. dest[i], err = parseBinaryDateTime(num, data[pos:], rows.mc.cfg.loc)
  990. } else {
  991. dest[i], err = formatBinaryDateTime(num, data[pos:])
  992. }
  993. if err == nil {
  994. pos += int(num)
  995. continue
  996. } else {
  997. return err
  998. }
  999. // Please report if this happens!
  1000. default:
  1001. return fmt.Errorf("Unknown FieldType %d", rows.columns[i].fieldType)
  1002. }
  1003. }
  1004. return
  1005. }