You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

utils.go 21KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868
  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. "crypto/tls"
  11. "database/sql"
  12. "database/sql/driver"
  13. "encoding/binary"
  14. "errors"
  15. "fmt"
  16. "io"
  17. "strconv"
  18. "strings"
  19. "sync"
  20. "sync/atomic"
  21. "time"
  22. )
  23. // Registry for custom tls.Configs
  24. var (
  25. tlsConfigLock sync.RWMutex
  26. tlsConfigRegistry map[string]*tls.Config
  27. )
  28. // RegisterTLSConfig registers a custom tls.Config to be used with sql.Open.
  29. // Use the key as a value in the DSN where tls=value.
  30. //
  31. // Note: The provided tls.Config is exclusively owned by the driver after
  32. // registering it.
  33. //
  34. // rootCertPool := x509.NewCertPool()
  35. // pem, err := ioutil.ReadFile("/path/ca-cert.pem")
  36. // if err != nil {
  37. // log.Fatal(err)
  38. // }
  39. // if ok := rootCertPool.AppendCertsFromPEM(pem); !ok {
  40. // log.Fatal("Failed to append PEM.")
  41. // }
  42. // clientCert := make([]tls.Certificate, 0, 1)
  43. // certs, err := tls.LoadX509KeyPair("/path/client-cert.pem", "/path/client-key.pem")
  44. // if err != nil {
  45. // log.Fatal(err)
  46. // }
  47. // clientCert = append(clientCert, certs)
  48. // mysql.RegisterTLSConfig("custom", &tls.Config{
  49. // RootCAs: rootCertPool,
  50. // Certificates: clientCert,
  51. // })
  52. // db, err := sql.Open("mysql", "user@tcp(localhost:3306)/test?tls=custom")
  53. //
  54. func RegisterTLSConfig(key string, config *tls.Config) error {
  55. if _, isBool := readBool(key); isBool || strings.ToLower(key) == "skip-verify" || strings.ToLower(key) == "preferred" {
  56. return fmt.Errorf("key '%s' is reserved", key)
  57. }
  58. tlsConfigLock.Lock()
  59. if tlsConfigRegistry == nil {
  60. tlsConfigRegistry = make(map[string]*tls.Config)
  61. }
  62. tlsConfigRegistry[key] = config
  63. tlsConfigLock.Unlock()
  64. return nil
  65. }
  66. // DeregisterTLSConfig removes the tls.Config associated with key.
  67. func DeregisterTLSConfig(key string) {
  68. tlsConfigLock.Lock()
  69. if tlsConfigRegistry != nil {
  70. delete(tlsConfigRegistry, key)
  71. }
  72. tlsConfigLock.Unlock()
  73. }
  74. func getTLSConfigClone(key string) (config *tls.Config) {
  75. tlsConfigLock.RLock()
  76. if v, ok := tlsConfigRegistry[key]; ok {
  77. config = v.Clone()
  78. }
  79. tlsConfigLock.RUnlock()
  80. return
  81. }
  82. // Returns the bool value of the input.
  83. // The 2nd return value indicates if the input was a valid bool value
  84. func readBool(input string) (value bool, valid bool) {
  85. switch input {
  86. case "1", "true", "TRUE", "True":
  87. return true, true
  88. case "0", "false", "FALSE", "False":
  89. return false, true
  90. }
  91. // Not a valid bool value
  92. return
  93. }
  94. /******************************************************************************
  95. * Time related utils *
  96. ******************************************************************************/
  97. func parseDateTime(b []byte, loc *time.Location) (time.Time, error) {
  98. const base = "0000-00-00 00:00:00.000000"
  99. switch len(b) {
  100. case 10, 19, 21, 22, 23, 24, 25, 26: // up to "YYYY-MM-DD HH:MM:SS.MMMMMM"
  101. if string(b) == base[:len(b)] {
  102. return time.Time{}, nil
  103. }
  104. year, err := parseByteYear(b)
  105. if err != nil {
  106. return time.Time{}, err
  107. }
  108. if year <= 0 {
  109. year = 1
  110. }
  111. if b[4] != '-' {
  112. return time.Time{}, fmt.Errorf("bad value for field: `%c`", b[4])
  113. }
  114. m, err := parseByte2Digits(b[5], b[6])
  115. if err != nil {
  116. return time.Time{}, err
  117. }
  118. if m <= 0 {
  119. m = 1
  120. }
  121. month := time.Month(m)
  122. if b[7] != '-' {
  123. return time.Time{}, fmt.Errorf("bad value for field: `%c`", b[7])
  124. }
  125. day, err := parseByte2Digits(b[8], b[9])
  126. if err != nil {
  127. return time.Time{}, err
  128. }
  129. if day <= 0 {
  130. day = 1
  131. }
  132. if len(b) == 10 {
  133. return time.Date(year, month, day, 0, 0, 0, 0, loc), nil
  134. }
  135. if b[10] != ' ' {
  136. return time.Time{}, fmt.Errorf("bad value for field: `%c`", b[10])
  137. }
  138. hour, err := parseByte2Digits(b[11], b[12])
  139. if err != nil {
  140. return time.Time{}, err
  141. }
  142. if b[13] != ':' {
  143. return time.Time{}, fmt.Errorf("bad value for field: `%c`", b[13])
  144. }
  145. min, err := parseByte2Digits(b[14], b[15])
  146. if err != nil {
  147. return time.Time{}, err
  148. }
  149. if b[16] != ':' {
  150. return time.Time{}, fmt.Errorf("bad value for field: `%c`", b[16])
  151. }
  152. sec, err := parseByte2Digits(b[17], b[18])
  153. if err != nil {
  154. return time.Time{}, err
  155. }
  156. if len(b) == 19 {
  157. return time.Date(year, month, day, hour, min, sec, 0, loc), nil
  158. }
  159. if b[19] != '.' {
  160. return time.Time{}, fmt.Errorf("bad value for field: `%c`", b[19])
  161. }
  162. nsec, err := parseByteNanoSec(b[20:])
  163. if err != nil {
  164. return time.Time{}, err
  165. }
  166. return time.Date(year, month, day, hour, min, sec, nsec, loc), nil
  167. default:
  168. return time.Time{}, fmt.Errorf("invalid time bytes: %s", b)
  169. }
  170. }
  171. func parseByteYear(b []byte) (int, error) {
  172. year, n := 0, 1000
  173. for i := 0; i < 4; i++ {
  174. v, err := bToi(b[i])
  175. if err != nil {
  176. return 0, err
  177. }
  178. year += v * n
  179. n = n / 10
  180. }
  181. return year, nil
  182. }
  183. func parseByte2Digits(b1, b2 byte) (int, error) {
  184. d1, err := bToi(b1)
  185. if err != nil {
  186. return 0, err
  187. }
  188. d2, err := bToi(b2)
  189. if err != nil {
  190. return 0, err
  191. }
  192. return d1*10 + d2, nil
  193. }
  194. func parseByteNanoSec(b []byte) (int, error) {
  195. ns, digit := 0, 100000 // max is 6-digits
  196. for i := 0; i < len(b); i++ {
  197. v, err := bToi(b[i])
  198. if err != nil {
  199. return 0, err
  200. }
  201. ns += v * digit
  202. digit /= 10
  203. }
  204. // nanoseconds has 10-digits. (needs to scale digits)
  205. // 10 - 6 = 4, so we have to multiple 1000.
  206. return ns * 1000, nil
  207. }
  208. func bToi(b byte) (int, error) {
  209. if b < '0' || b > '9' {
  210. return 0, errors.New("not [0-9]")
  211. }
  212. return int(b - '0'), nil
  213. }
  214. func parseBinaryDateTime(num uint64, data []byte, loc *time.Location) (driver.Value, error) {
  215. switch num {
  216. case 0:
  217. return time.Time{}, nil
  218. case 4:
  219. return time.Date(
  220. int(binary.LittleEndian.Uint16(data[:2])), // year
  221. time.Month(data[2]), // month
  222. int(data[3]), // day
  223. 0, 0, 0, 0,
  224. loc,
  225. ), nil
  226. case 7:
  227. return time.Date(
  228. int(binary.LittleEndian.Uint16(data[:2])), // year
  229. time.Month(data[2]), // month
  230. int(data[3]), // day
  231. int(data[4]), // hour
  232. int(data[5]), // minutes
  233. int(data[6]), // seconds
  234. 0,
  235. loc,
  236. ), nil
  237. case 11:
  238. return time.Date(
  239. int(binary.LittleEndian.Uint16(data[:2])), // year
  240. time.Month(data[2]), // month
  241. int(data[3]), // day
  242. int(data[4]), // hour
  243. int(data[5]), // minutes
  244. int(data[6]), // seconds
  245. int(binary.LittleEndian.Uint32(data[7:11]))*1000, // nanoseconds
  246. loc,
  247. ), nil
  248. }
  249. return nil, fmt.Errorf("invalid DATETIME packet length %d", num)
  250. }
  251. func appendDateTime(buf []byte, t time.Time) ([]byte, error) {
  252. year, month, day := t.Date()
  253. hour, min, sec := t.Clock()
  254. nsec := t.Nanosecond()
  255. if year < 1 || year > 9999 {
  256. return buf, errors.New("year is not in the range [1, 9999]: " + strconv.Itoa(year)) // use errors.New instead of fmt.Errorf to avoid year escape to heap
  257. }
  258. year100 := year / 100
  259. year1 := year % 100
  260. var localBuf [len("2006-01-02T15:04:05.999999999")]byte // does not escape
  261. localBuf[0], localBuf[1], localBuf[2], localBuf[3] = digits10[year100], digits01[year100], digits10[year1], digits01[year1]
  262. localBuf[4] = '-'
  263. localBuf[5], localBuf[6] = digits10[month], digits01[month]
  264. localBuf[7] = '-'
  265. localBuf[8], localBuf[9] = digits10[day], digits01[day]
  266. if hour == 0 && min == 0 && sec == 0 && nsec == 0 {
  267. return append(buf, localBuf[:10]...), nil
  268. }
  269. localBuf[10] = ' '
  270. localBuf[11], localBuf[12] = digits10[hour], digits01[hour]
  271. localBuf[13] = ':'
  272. localBuf[14], localBuf[15] = digits10[min], digits01[min]
  273. localBuf[16] = ':'
  274. localBuf[17], localBuf[18] = digits10[sec], digits01[sec]
  275. if nsec == 0 {
  276. return append(buf, localBuf[:19]...), nil
  277. }
  278. nsec100000000 := nsec / 100000000
  279. nsec1000000 := (nsec / 1000000) % 100
  280. nsec10000 := (nsec / 10000) % 100
  281. nsec100 := (nsec / 100) % 100
  282. nsec1 := nsec % 100
  283. localBuf[19] = '.'
  284. // milli second
  285. localBuf[20], localBuf[21], localBuf[22] =
  286. digits01[nsec100000000], digits10[nsec1000000], digits01[nsec1000000]
  287. // micro second
  288. localBuf[23], localBuf[24], localBuf[25] =
  289. digits10[nsec10000], digits01[nsec10000], digits10[nsec100]
  290. // nano second
  291. localBuf[26], localBuf[27], localBuf[28] =
  292. digits01[nsec100], digits10[nsec1], digits01[nsec1]
  293. // trim trailing zeros
  294. n := len(localBuf)
  295. for n > 0 && localBuf[n-1] == '0' {
  296. n--
  297. }
  298. return append(buf, localBuf[:n]...), nil
  299. }
  300. // zeroDateTime is used in formatBinaryDateTime to avoid an allocation
  301. // if the DATE or DATETIME has the zero value.
  302. // It must never be changed.
  303. // The current behavior depends on database/sql copying the result.
  304. var zeroDateTime = []byte("0000-00-00 00:00:00.000000")
  305. const digits01 = "0123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789"
  306. const digits10 = "0000000000111111111122222222223333333333444444444455555555556666666666777777777788888888889999999999"
  307. func appendMicrosecs(dst, src []byte, decimals int) []byte {
  308. if decimals <= 0 {
  309. return dst
  310. }
  311. if len(src) == 0 {
  312. return append(dst, ".000000"[:decimals+1]...)
  313. }
  314. microsecs := binary.LittleEndian.Uint32(src[:4])
  315. p1 := byte(microsecs / 10000)
  316. microsecs -= 10000 * uint32(p1)
  317. p2 := byte(microsecs / 100)
  318. microsecs -= 100 * uint32(p2)
  319. p3 := byte(microsecs)
  320. switch decimals {
  321. default:
  322. return append(dst, '.',
  323. digits10[p1], digits01[p1],
  324. digits10[p2], digits01[p2],
  325. digits10[p3], digits01[p3],
  326. )
  327. case 1:
  328. return append(dst, '.',
  329. digits10[p1],
  330. )
  331. case 2:
  332. return append(dst, '.',
  333. digits10[p1], digits01[p1],
  334. )
  335. case 3:
  336. return append(dst, '.',
  337. digits10[p1], digits01[p1],
  338. digits10[p2],
  339. )
  340. case 4:
  341. return append(dst, '.',
  342. digits10[p1], digits01[p1],
  343. digits10[p2], digits01[p2],
  344. )
  345. case 5:
  346. return append(dst, '.',
  347. digits10[p1], digits01[p1],
  348. digits10[p2], digits01[p2],
  349. digits10[p3],
  350. )
  351. }
  352. }
  353. func formatBinaryDateTime(src []byte, length uint8) (driver.Value, error) {
  354. // length expects the deterministic length of the zero value,
  355. // negative time and 100+ hours are automatically added if needed
  356. if len(src) == 0 {
  357. return zeroDateTime[:length], nil
  358. }
  359. var dst []byte // return value
  360. var p1, p2, p3 byte // current digit pair
  361. switch length {
  362. case 10, 19, 21, 22, 23, 24, 25, 26:
  363. default:
  364. t := "DATE"
  365. if length > 10 {
  366. t += "TIME"
  367. }
  368. return nil, fmt.Errorf("illegal %s length %d", t, length)
  369. }
  370. switch len(src) {
  371. case 4, 7, 11:
  372. default:
  373. t := "DATE"
  374. if length > 10 {
  375. t += "TIME"
  376. }
  377. return nil, fmt.Errorf("illegal %s packet length %d", t, len(src))
  378. }
  379. dst = make([]byte, 0, length)
  380. // start with the date
  381. year := binary.LittleEndian.Uint16(src[:2])
  382. pt := year / 100
  383. p1 = byte(year - 100*uint16(pt))
  384. p2, p3 = src[2], src[3]
  385. dst = append(dst,
  386. digits10[pt], digits01[pt],
  387. digits10[p1], digits01[p1], '-',
  388. digits10[p2], digits01[p2], '-',
  389. digits10[p3], digits01[p3],
  390. )
  391. if length == 10 {
  392. return dst, nil
  393. }
  394. if len(src) == 4 {
  395. return append(dst, zeroDateTime[10:length]...), nil
  396. }
  397. dst = append(dst, ' ')
  398. p1 = src[4] // hour
  399. src = src[5:]
  400. // p1 is 2-digit hour, src is after hour
  401. p2, p3 = src[0], src[1]
  402. dst = append(dst,
  403. digits10[p1], digits01[p1], ':',
  404. digits10[p2], digits01[p2], ':',
  405. digits10[p3], digits01[p3],
  406. )
  407. return appendMicrosecs(dst, src[2:], int(length)-20), nil
  408. }
  409. func formatBinaryTime(src []byte, length uint8) (driver.Value, error) {
  410. // length expects the deterministic length of the zero value,
  411. // negative time and 100+ hours are automatically added if needed
  412. if len(src) == 0 {
  413. return zeroDateTime[11 : 11+length], nil
  414. }
  415. var dst []byte // return value
  416. switch length {
  417. case
  418. 8, // time (can be up to 10 when negative and 100+ hours)
  419. 10, 11, 12, 13, 14, 15: // time with fractional seconds
  420. default:
  421. return nil, fmt.Errorf("illegal TIME length %d", length)
  422. }
  423. switch len(src) {
  424. case 8, 12:
  425. default:
  426. return nil, fmt.Errorf("invalid TIME packet length %d", len(src))
  427. }
  428. // +2 to enable negative time and 100+ hours
  429. dst = make([]byte, 0, length+2)
  430. if src[0] == 1 {
  431. dst = append(dst, '-')
  432. }
  433. days := binary.LittleEndian.Uint32(src[1:5])
  434. hours := int64(days)*24 + int64(src[5])
  435. if hours >= 100 {
  436. dst = strconv.AppendInt(dst, hours, 10)
  437. } else {
  438. dst = append(dst, digits10[hours], digits01[hours])
  439. }
  440. min, sec := src[6], src[7]
  441. dst = append(dst, ':',
  442. digits10[min], digits01[min], ':',
  443. digits10[sec], digits01[sec],
  444. )
  445. return appendMicrosecs(dst, src[8:], int(length)-9), nil
  446. }
  447. /******************************************************************************
  448. * Convert from and to bytes *
  449. ******************************************************************************/
  450. func uint64ToBytes(n uint64) []byte {
  451. return []byte{
  452. byte(n),
  453. byte(n >> 8),
  454. byte(n >> 16),
  455. byte(n >> 24),
  456. byte(n >> 32),
  457. byte(n >> 40),
  458. byte(n >> 48),
  459. byte(n >> 56),
  460. }
  461. }
  462. func uint64ToString(n uint64) []byte {
  463. var a [20]byte
  464. i := 20
  465. // U+0030 = 0
  466. // ...
  467. // U+0039 = 9
  468. var q uint64
  469. for n >= 10 {
  470. i--
  471. q = n / 10
  472. a[i] = uint8(n-q*10) + 0x30
  473. n = q
  474. }
  475. i--
  476. a[i] = uint8(n) + 0x30
  477. return a[i:]
  478. }
  479. // treats string value as unsigned integer representation
  480. func stringToInt(b []byte) int {
  481. val := 0
  482. for i := range b {
  483. val *= 10
  484. val += int(b[i] - 0x30)
  485. }
  486. return val
  487. }
  488. // returns the string read as a bytes slice, wheter the value is NULL,
  489. // the number of bytes read and an error, in case the string is longer than
  490. // the input slice
  491. func readLengthEncodedString(b []byte) ([]byte, bool, int, error) {
  492. // Get length
  493. num, isNull, n := readLengthEncodedInteger(b)
  494. if num < 1 {
  495. return b[n:n], isNull, n, nil
  496. }
  497. n += int(num)
  498. // Check data length
  499. if len(b) >= n {
  500. return b[n-int(num) : n : n], false, n, nil
  501. }
  502. return nil, false, n, io.EOF
  503. }
  504. // returns the number of bytes skipped and an error, in case the string is
  505. // longer than the input slice
  506. func skipLengthEncodedString(b []byte) (int, error) {
  507. // Get length
  508. num, _, n := readLengthEncodedInteger(b)
  509. if num < 1 {
  510. return n, nil
  511. }
  512. n += int(num)
  513. // Check data length
  514. if len(b) >= n {
  515. return n, nil
  516. }
  517. return n, io.EOF
  518. }
  519. // returns the number read, whether the value is NULL and the number of bytes read
  520. func readLengthEncodedInteger(b []byte) (uint64, bool, int) {
  521. // See issue #349
  522. if len(b) == 0 {
  523. return 0, true, 1
  524. }
  525. switch b[0] {
  526. // 251: NULL
  527. case 0xfb:
  528. return 0, true, 1
  529. // 252: value of following 2
  530. case 0xfc:
  531. return uint64(b[1]) | uint64(b[2])<<8, false, 3
  532. // 253: value of following 3
  533. case 0xfd:
  534. return uint64(b[1]) | uint64(b[2])<<8 | uint64(b[3])<<16, false, 4
  535. // 254: value of following 8
  536. case 0xfe:
  537. return uint64(b[1]) | uint64(b[2])<<8 | uint64(b[3])<<16 |
  538. uint64(b[4])<<24 | uint64(b[5])<<32 | uint64(b[6])<<40 |
  539. uint64(b[7])<<48 | uint64(b[8])<<56,
  540. false, 9
  541. }
  542. // 0-250: value of first byte
  543. return uint64(b[0]), false, 1
  544. }
  545. // encodes a uint64 value and appends it to the given bytes slice
  546. func appendLengthEncodedInteger(b []byte, n uint64) []byte {
  547. switch {
  548. case n <= 250:
  549. return append(b, byte(n))
  550. case n <= 0xffff:
  551. return append(b, 0xfc, byte(n), byte(n>>8))
  552. case n <= 0xffffff:
  553. return append(b, 0xfd, byte(n), byte(n>>8), byte(n>>16))
  554. }
  555. return append(b, 0xfe, byte(n), byte(n>>8), byte(n>>16), byte(n>>24),
  556. byte(n>>32), byte(n>>40), byte(n>>48), byte(n>>56))
  557. }
  558. // reserveBuffer checks cap(buf) and expand buffer to len(buf) + appendSize.
  559. // If cap(buf) is not enough, reallocate new buffer.
  560. func reserveBuffer(buf []byte, appendSize int) []byte {
  561. newSize := len(buf) + appendSize
  562. if cap(buf) < newSize {
  563. // Grow buffer exponentially
  564. newBuf := make([]byte, len(buf)*2+appendSize)
  565. copy(newBuf, buf)
  566. buf = newBuf
  567. }
  568. return buf[:newSize]
  569. }
  570. // escapeBytesBackslash escapes []byte with backslashes (\)
  571. // This escapes the contents of a string (provided as []byte) by adding backslashes before special
  572. // characters, and turning others into specific escape sequences, such as
  573. // turning newlines into \n and null bytes into \0.
  574. // https://github.com/mysql/mysql-server/blob/mysql-5.7.5/mysys/charset.c#L823-L932
  575. func escapeBytesBackslash(buf, v []byte) []byte {
  576. pos := len(buf)
  577. buf = reserveBuffer(buf, len(v)*2)
  578. for _, c := range v {
  579. switch c {
  580. case '\x00':
  581. buf[pos] = '\\'
  582. buf[pos+1] = '0'
  583. pos += 2
  584. case '\n':
  585. buf[pos] = '\\'
  586. buf[pos+1] = 'n'
  587. pos += 2
  588. case '\r':
  589. buf[pos] = '\\'
  590. buf[pos+1] = 'r'
  591. pos += 2
  592. case '\x1a':
  593. buf[pos] = '\\'
  594. buf[pos+1] = 'Z'
  595. pos += 2
  596. case '\'':
  597. buf[pos] = '\\'
  598. buf[pos+1] = '\''
  599. pos += 2
  600. case '"':
  601. buf[pos] = '\\'
  602. buf[pos+1] = '"'
  603. pos += 2
  604. case '\\':
  605. buf[pos] = '\\'
  606. buf[pos+1] = '\\'
  607. pos += 2
  608. default:
  609. buf[pos] = c
  610. pos++
  611. }
  612. }
  613. return buf[:pos]
  614. }
  615. // escapeStringBackslash is similar to escapeBytesBackslash but for string.
  616. func escapeStringBackslash(buf []byte, v string) []byte {
  617. pos := len(buf)
  618. buf = reserveBuffer(buf, len(v)*2)
  619. for i := 0; i < len(v); i++ {
  620. c := v[i]
  621. switch c {
  622. case '\x00':
  623. buf[pos] = '\\'
  624. buf[pos+1] = '0'
  625. pos += 2
  626. case '\n':
  627. buf[pos] = '\\'
  628. buf[pos+1] = 'n'
  629. pos += 2
  630. case '\r':
  631. buf[pos] = '\\'
  632. buf[pos+1] = 'r'
  633. pos += 2
  634. case '\x1a':
  635. buf[pos] = '\\'
  636. buf[pos+1] = 'Z'
  637. pos += 2
  638. case '\'':
  639. buf[pos] = '\\'
  640. buf[pos+1] = '\''
  641. pos += 2
  642. case '"':
  643. buf[pos] = '\\'
  644. buf[pos+1] = '"'
  645. pos += 2
  646. case '\\':
  647. buf[pos] = '\\'
  648. buf[pos+1] = '\\'
  649. pos += 2
  650. default:
  651. buf[pos] = c
  652. pos++
  653. }
  654. }
  655. return buf[:pos]
  656. }
  657. // escapeBytesQuotes escapes apostrophes in []byte by doubling them up.
  658. // This escapes the contents of a string by doubling up any apostrophes that
  659. // it contains. This is used when the NO_BACKSLASH_ESCAPES SQL_MODE is in
  660. // effect on the server.
  661. // https://github.com/mysql/mysql-server/blob/mysql-5.7.5/mysys/charset.c#L963-L1038
  662. func escapeBytesQuotes(buf, v []byte) []byte {
  663. pos := len(buf)
  664. buf = reserveBuffer(buf, len(v)*2)
  665. for _, c := range v {
  666. if c == '\'' {
  667. buf[pos] = '\''
  668. buf[pos+1] = '\''
  669. pos += 2
  670. } else {
  671. buf[pos] = c
  672. pos++
  673. }
  674. }
  675. return buf[:pos]
  676. }
  677. // escapeStringQuotes is similar to escapeBytesQuotes but for string.
  678. func escapeStringQuotes(buf []byte, v string) []byte {
  679. pos := len(buf)
  680. buf = reserveBuffer(buf, len(v)*2)
  681. for i := 0; i < len(v); i++ {
  682. c := v[i]
  683. if c == '\'' {
  684. buf[pos] = '\''
  685. buf[pos+1] = '\''
  686. pos += 2
  687. } else {
  688. buf[pos] = c
  689. pos++
  690. }
  691. }
  692. return buf[:pos]
  693. }
  694. /******************************************************************************
  695. * Sync utils *
  696. ******************************************************************************/
  697. // noCopy may be embedded into structs which must not be copied
  698. // after the first use.
  699. //
  700. // See https://github.com/golang/go/issues/8005#issuecomment-190753527
  701. // for details.
  702. type noCopy struct{}
  703. // Lock is a no-op used by -copylocks checker from `go vet`.
  704. func (*noCopy) Lock() {}
  705. // atomicBool is a wrapper around uint32 for usage as a boolean value with
  706. // atomic access.
  707. type atomicBool struct {
  708. _noCopy noCopy
  709. value uint32
  710. }
  711. // IsSet returns whether the current boolean value is true
  712. func (ab *atomicBool) IsSet() bool {
  713. return atomic.LoadUint32(&ab.value) > 0
  714. }
  715. // Set sets the value of the bool regardless of the previous value
  716. func (ab *atomicBool) Set(value bool) {
  717. if value {
  718. atomic.StoreUint32(&ab.value, 1)
  719. } else {
  720. atomic.StoreUint32(&ab.value, 0)
  721. }
  722. }
  723. // TrySet sets the value of the bool and returns whether the value changed
  724. func (ab *atomicBool) TrySet(value bool) bool {
  725. if value {
  726. return atomic.SwapUint32(&ab.value, 1) == 0
  727. }
  728. return atomic.SwapUint32(&ab.value, 0) > 0
  729. }
  730. // atomicError is a wrapper for atomically accessed error values
  731. type atomicError struct {
  732. _noCopy noCopy
  733. value atomic.Value
  734. }
  735. // Set sets the error value regardless of the previous value.
  736. // The value must not be nil
  737. func (ae *atomicError) Set(value error) {
  738. ae.value.Store(value)
  739. }
  740. // Value returns the current error value
  741. func (ae *atomicError) Value() error {
  742. if v := ae.value.Load(); v != nil {
  743. // this will panic if the value doesn't implement the error interface
  744. return v.(error)
  745. }
  746. return nil
  747. }
  748. func namedValueToValue(named []driver.NamedValue) ([]driver.Value, error) {
  749. dargs := make([]driver.Value, len(named))
  750. for n, param := range named {
  751. if len(param.Name) > 0 {
  752. // TODO: support the use of Named Parameters #561
  753. return nil, errors.New("mysql: driver does not support the use of Named Parameters")
  754. }
  755. dargs[n] = param.Value
  756. }
  757. return dargs, nil
  758. }
  759. func mapIsolationLevel(level driver.IsolationLevel) (string, error) {
  760. switch sql.IsolationLevel(level) {
  761. case sql.LevelRepeatableRead:
  762. return "REPEATABLE READ", nil
  763. case sql.LevelReadCommitted:
  764. return "READ COMMITTED", nil
  765. case sql.LevelReadUncommitted:
  766. return "READ UNCOMMITTED", nil
  767. case sql.LevelSerializable:
  768. return "SERIALIZABLE", nil
  769. default:
  770. return "", fmt.Errorf("mysql: unsupported isolation level: %v", level)
  771. }
  772. }