Compare commits
27 Commits
Author | SHA1 | Date |
---|---|---|
李光春 | 287d97868d | 2 years ago |
李光春 | 0f91db77f8 | 2 years ago |
李光春 | be6d856e9f | 2 years ago |
李光春 | 4b2e0d2db0 | 2 years ago |
李光春 | db0cf9519a | 2 years ago |
李光春 | 1ea602d1a3 | 2 years ago |
李光春 | 9e416bb384 | 2 years ago |
李光春 | 053e4c846f | 2 years ago |
李光春 | bca79a4ffb | 2 years ago |
李光春 | aded4ccadc | 2 years ago |
李光春 | 44190213b9 | 2 years ago |
李光春 | 3e4a1ded72 | 2 years ago |
李光春 | 020b08e9b3 | 2 years ago |
李光春 | df75d09be5 | 2 years ago |
李光春 | ef04e2d3d3 | 2 years ago |
李光春 | 37fa83aa9b | 2 years ago |
李光春 | 7a3d65f6bd | 2 years ago |
李光春 | 984546cfab | 2 years ago |
李光春 | 6b416f791d | 2 years ago |
李光春 | e477b71b71 | 2 years ago |
李光春 | b92d1f0b3b | 2 years ago |
李光春 | c545b98931 | 2 years ago |
李光春 | 2c8b9a0759 | 2 years ago |
李光春 | 338e5045b6 | 2 years ago |
李光春 | fea0a50e99 | 2 years ago |
李光春 | cf20a688b0 | 2 years ago |
李光春 | 4916b65089 | 2 years ago |
@ -0,0 +1,58 @@
|
|||||||
|
package wechatpayopen
|
||||||
|
|
||||||
|
import (
|
||||||
|
"go.dtapp.net/golog"
|
||||||
|
"go.dtapp.net/gorequest"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ClientConfig 实例配置
|
||||||
|
type ClientConfig struct {
|
||||||
|
SpAppid string // 服务商应用ID
|
||||||
|
SpMchId string // 服务商户号
|
||||||
|
ApiV2 string // APIv2密钥
|
||||||
|
ApiV3 string // APIv3密钥
|
||||||
|
SerialNo string // 序列号
|
||||||
|
MchSslSerialNo string // pem 证书号
|
||||||
|
MchSslCer string // pem 内容
|
||||||
|
MchSslKey string // pem key 内容
|
||||||
|
}
|
||||||
|
|
||||||
|
// Client 实例
|
||||||
|
type Client struct {
|
||||||
|
requestClient *gorequest.App // 请求服务
|
||||||
|
config struct {
|
||||||
|
spAppid string // 服务商应用ID
|
||||||
|
spMchId string // 服务商户号
|
||||||
|
subAppid string // 子商户应用ID
|
||||||
|
subMchId string // 子商户号
|
||||||
|
apiV2 string // APIv2密钥
|
||||||
|
apiV3 string // APIv3密钥
|
||||||
|
serialNo string // 序列号
|
||||||
|
mchSslSerialNo string // pem 证书号
|
||||||
|
mchSslCer string // pem 内容
|
||||||
|
mchSslKey string // pem key 内容
|
||||||
|
}
|
||||||
|
log struct {
|
||||||
|
status bool // 状态
|
||||||
|
client *golog.ApiClient // 日志服务
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewClient 创建实例化
|
||||||
|
func NewClient(config *ClientConfig) (*Client, error) {
|
||||||
|
|
||||||
|
c := &Client{}
|
||||||
|
|
||||||
|
c.config.spAppid = config.SpAppid
|
||||||
|
c.config.spMchId = config.SpMchId
|
||||||
|
c.config.apiV2 = config.ApiV2
|
||||||
|
c.config.apiV3 = config.ApiV3
|
||||||
|
c.config.serialNo = config.SerialNo
|
||||||
|
c.config.mchSslSerialNo = config.MchSslSerialNo
|
||||||
|
c.config.mchSslCer = config.MchSslCer
|
||||||
|
c.config.mchSslKey = config.MchSslKey
|
||||||
|
|
||||||
|
c.requestClient = gorequest.NewHttp()
|
||||||
|
|
||||||
|
return c, nil
|
||||||
|
}
|
@ -0,0 +1,14 @@
|
|||||||
|
package wechatpayopen
|
||||||
|
|
||||||
|
import (
|
||||||
|
"go.dtapp.net/golog"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ConfigApiClientFun 日志配置
|
||||||
|
func (c *Client) ConfigApiClientFun(apiClientFun golog.ApiClientFun) {
|
||||||
|
apiClient := apiClientFun()
|
||||||
|
if apiClient != nil {
|
||||||
|
c.log.client = apiClient
|
||||||
|
c.log.status = true
|
||||||
|
}
|
||||||
|
}
|
@ -0,0 +1,35 @@
|
|||||||
|
package wechatpayopen
|
||||||
|
|
||||||
|
import "go.dtapp.net/golog"
|
||||||
|
|
||||||
|
func (c *Client) GetSpAppid() string {
|
||||||
|
return c.config.spAppid
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Client) GetSpMchId() string {
|
||||||
|
return c.config.spMchId
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Client) GetSubAppid() string {
|
||||||
|
return c.config.subAppid
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Client) GetSubMchId() string {
|
||||||
|
return c.config.subMchId
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Client) GetMchSslKey() string {
|
||||||
|
return c.config.mchSslKey
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Client) GetMchSslSerialNo() string {
|
||||||
|
return c.config.mchSslSerialNo
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Client) GetApiV3() string {
|
||||||
|
return c.config.apiV3
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Client) GetLog() *golog.ApiClient {
|
||||||
|
return c.log.client
|
||||||
|
}
|
@ -1,32 +1,98 @@
|
|||||||
module go.dtapp.net/wechatpayopen
|
module go.dtapp.net/wechatpayopen
|
||||||
|
|
||||||
go 1.18
|
go 1.19
|
||||||
|
|
||||||
require (
|
require (
|
||||||
go.dtapp.net/gojson v1.0.0
|
github.com/gin-gonic/gin v1.8.1
|
||||||
go.dtapp.net/golog v1.0.14
|
go.dtapp.net/dorm v1.0.51
|
||||||
go.dtapp.net/gorandom v1.0.0
|
go.dtapp.net/golog v1.0.101
|
||||||
go.dtapp.net/gorequest v1.0.20
|
go.dtapp.net/gorandom v1.0.1
|
||||||
gorm.io/datatypes v1.0.6
|
go.dtapp.net/gorequest v1.0.33
|
||||||
gorm.io/gorm v1.23.6
|
|
||||||
)
|
)
|
||||||
|
|
||||||
require (
|
require (
|
||||||
|
github.com/basgys/goxml2json v1.1.0 // indirect
|
||||||
|
github.com/beego/beego/v2 v2.0.5 // indirect
|
||||||
|
github.com/cespare/xxhash/v2 v2.1.2 // indirect
|
||||||
|
github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f // indirect
|
||||||
|
github.com/gin-contrib/sse v0.1.0 // indirect
|
||||||
|
github.com/go-ole/go-ole v1.2.6 // indirect
|
||||||
|
github.com/go-playground/locales v0.14.0 // indirect
|
||||||
|
github.com/go-playground/universal-translator v0.18.0 // indirect
|
||||||
|
github.com/go-playground/validator/v10 v10.11.1 // indirect
|
||||||
|
github.com/go-redis/redis/v9 v9.0.0-rc.1 // indirect
|
||||||
github.com/go-sql-driver/mysql v1.6.0 // indirect
|
github.com/go-sql-driver/mysql v1.6.0 // indirect
|
||||||
|
github.com/goccy/go-json v0.9.11 // indirect
|
||||||
|
github.com/golang/snappy v0.0.4 // indirect
|
||||||
|
github.com/hashicorp/golang-lru v0.5.4 // indirect
|
||||||
|
github.com/jackc/chunkreader/v2 v2.0.1 // indirect
|
||||||
|
github.com/jackc/pgconn v1.13.0 // indirect
|
||||||
|
github.com/jackc/pgio v1.0.0 // indirect
|
||||||
|
github.com/jackc/pgpassfile v1.0.0 // indirect
|
||||||
|
github.com/jackc/pgproto3/v2 v2.3.1 // indirect
|
||||||
|
github.com/jackc/pgservicefile v0.0.0-20200714003250-2b9c44734f2b // indirect
|
||||||
|
github.com/jackc/pgtype v1.12.0 // indirect
|
||||||
|
github.com/jackc/pgx/v4 v4.17.2 // indirect
|
||||||
github.com/jinzhu/inflection v1.0.0 // indirect
|
github.com/jinzhu/inflection v1.0.0 // indirect
|
||||||
github.com/jinzhu/now v1.1.5 // indirect
|
github.com/jinzhu/now v1.1.5 // indirect
|
||||||
|
github.com/json-iterator/go v1.1.12 // indirect
|
||||||
|
github.com/klauspost/compress v1.15.11 // indirect
|
||||||
|
github.com/leodido/go-urn v1.2.1 // indirect
|
||||||
|
github.com/lib/pq v1.10.7 // indirect
|
||||||
|
github.com/mattn/go-isatty v0.0.16 // indirect
|
||||||
|
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
|
||||||
|
github.com/modern-go/reflect2 v1.0.2 // indirect
|
||||||
|
github.com/montanaflynn/stats v0.6.6 // indirect
|
||||||
github.com/natefinch/lumberjack v2.0.0+incompatible // indirect
|
github.com/natefinch/lumberjack v2.0.0+incompatible // indirect
|
||||||
|
github.com/oschwald/geoip2-golang v1.8.0 // indirect
|
||||||
|
github.com/oschwald/maxminddb-golang v1.10.0 // indirect
|
||||||
|
github.com/pelletier/go-toml/v2 v2.0.5 // indirect
|
||||||
github.com/pkg/errors v0.9.1 // indirect
|
github.com/pkg/errors v0.9.1 // indirect
|
||||||
github.com/saracen/go7z v0.0.0-20191010121135-9c09b6bd7fda // indirect
|
github.com/saracen/go7z v0.0.0-20191010121135-9c09b6bd7fda // indirect
|
||||||
github.com/saracen/solidblock v0.0.0-20190426153529-45df20abab6f // indirect
|
github.com/saracen/solidblock v0.0.0-20190426153529-45df20abab6f // indirect
|
||||||
|
github.com/segmentio/fasthash v1.0.3 // indirect
|
||||||
|
github.com/shiena/ansicolor v0.0.0-20200904210342-c7312218db18 // indirect
|
||||||
|
github.com/shirou/gopsutil v3.21.11+incompatible // indirect
|
||||||
|
github.com/sirupsen/logrus v1.9.0 // indirect
|
||||||
|
github.com/syndtr/goleveldb v1.0.0 // indirect
|
||||||
|
github.com/tklauser/go-sysconf v0.3.10 // indirect
|
||||||
|
github.com/tklauser/numcpus v0.5.0 // indirect
|
||||||
|
github.com/tmthrgd/go-hex v0.0.0-20190904060850-447a3041c3bc // indirect
|
||||||
|
github.com/ugorji/go/codec v1.2.7 // indirect
|
||||||
github.com/ulikunitz/xz v0.5.10 // indirect
|
github.com/ulikunitz/xz v0.5.10 // indirect
|
||||||
go.dtapp.net/goip v1.0.18 // indirect
|
github.com/upper/db/v4 v4.6.0 // indirect
|
||||||
go.dtapp.net/gostring v1.0.3 // indirect
|
github.com/uptrace/bun v1.1.8 // indirect
|
||||||
go.dtapp.net/gotime v1.0.2 // indirect
|
github.com/uptrace/bun/dialect/mysqldialect v1.1.8 // indirect
|
||||||
go.uber.org/atomic v1.9.0 // indirect
|
github.com/uptrace/bun/dialect/pgdialect v1.1.8 // indirect
|
||||||
|
github.com/uptrace/bun/driver/pgdriver v1.1.8 // indirect
|
||||||
|
github.com/vmihailenco/msgpack/v5 v5.3.5 // indirect
|
||||||
|
github.com/vmihailenco/tagparser/v2 v2.0.0 // indirect
|
||||||
|
github.com/xdg-go/pbkdf2 v1.0.0 // indirect
|
||||||
|
github.com/xdg-go/scram v1.1.1 // indirect
|
||||||
|
github.com/xdg-go/stringprep v1.0.3 // indirect
|
||||||
|
github.com/youmark/pkcs8 v0.0.0-20201027041543-1326539a0a0a // indirect
|
||||||
|
github.com/yusufpapurcu/wmi v1.2.2 // indirect
|
||||||
|
go.dtapp.net/goip v1.0.38 // indirect
|
||||||
|
go.dtapp.net/gostring v1.0.10 // indirect
|
||||||
|
go.dtapp.net/gotime v1.0.5 // indirect
|
||||||
|
go.dtapp.net/gotrace_id v1.0.6 // indirect
|
||||||
|
go.dtapp.net/gourl v1.0.0 // indirect
|
||||||
|
go.mongodb.org/mongo-driver v1.10.3 // indirect
|
||||||
|
go.uber.org/atomic v1.10.0 // indirect
|
||||||
go.uber.org/multierr v1.8.0 // indirect
|
go.uber.org/multierr v1.8.0 // indirect
|
||||||
go.uber.org/zap v1.21.0 // indirect
|
go.uber.org/zap v1.23.0 // indirect
|
||||||
golang.org/x/sys v0.0.0-20220610221304-9f5ed59c137d // indirect
|
golang.org/x/crypto v0.1.0 // indirect
|
||||||
golang.org/x/text v0.3.7 // indirect
|
golang.org/x/mod v0.6.0 // indirect
|
||||||
gorm.io/driver/mysql v1.3.4 // indirect
|
golang.org/x/net v0.1.0 // indirect
|
||||||
|
golang.org/x/sync v0.1.0 // indirect
|
||||||
|
golang.org/x/sys v0.1.0 // indirect
|
||||||
|
golang.org/x/text v0.4.0 // indirect
|
||||||
|
google.golang.org/protobuf v1.28.1 // indirect
|
||||||
|
gopkg.in/yaml.v2 v2.4.0 // indirect
|
||||||
|
gorm.io/driver/mysql v1.4.3 // indirect
|
||||||
|
gorm.io/driver/postgres v1.4.5 // indirect
|
||||||
|
gorm.io/gorm v1.24.1-0.20221019064659-5dd2bb482755 // indirect
|
||||||
|
mellium.im/sasl v0.3.0 // indirect
|
||||||
|
xorm.io/builder v0.3.12 // indirect
|
||||||
|
xorm.io/xorm v1.3.2 // indirect
|
||||||
)
|
)
|
||||||
|
@ -1,26 +0,0 @@
|
|||||||
package wechatpayopen
|
|
||||||
|
|
||||||
import (
|
|
||||||
"go.dtapp.net/gojson"
|
|
||||||
"go.dtapp.net/golog"
|
|
||||||
"go.dtapp.net/gorequest"
|
|
||||||
"gorm.io/datatypes"
|
|
||||||
)
|
|
||||||
|
|
||||||
// 记录日志
|
|
||||||
func (c *Client) postgresqlLog(request gorequest.Response) {
|
|
||||||
c.log.Record(golog.ApiPostgresqlLog{
|
|
||||||
RequestTime: golog.TimeString{Time: request.RequestTime}, //【请求】时间
|
|
||||||
RequestUri: request.RequestUri, //【请求】链接
|
|
||||||
RequestUrl: gorequest.UriParse(request.RequestUri).Url, //【请求】链接
|
|
||||||
RequestApi: gorequest.UriParse(request.RequestUri).Path, //【请求】接口
|
|
||||||
RequestMethod: request.RequestMethod, //【请求】方式
|
|
||||||
RequestParams: datatypes.JSON(gojson.JsonEncodeNoError(request.RequestParams)), //【请求】参数
|
|
||||||
RequestHeader: datatypes.JSON(gojson.JsonEncodeNoError(request.RequestHeader)), //【返回】头部
|
|
||||||
ResponseHeader: datatypes.JSON(gojson.JsonEncodeNoError(request.ResponseHeader)), //【返回】头部
|
|
||||||
ResponseStatusCode: request.ResponseStatusCode, //【返回】状态码
|
|
||||||
ResponseBody: request.ResponseBody, //【返回】内容
|
|
||||||
ResponseContentLength: request.ResponseContentLength, //【返回】大小
|
|
||||||
ResponseTime: golog.TimeString{Time: request.ResponseTime}, //【返回】时间
|
|
||||||
})
|
|
||||||
}
|
|
@ -0,0 +1,47 @@
|
|||||||
|
package wechatpayopen
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"go.dtapp.net/gorequest"
|
||||||
|
"net/http"
|
||||||
|
)
|
||||||
|
|
||||||
|
type PayPartnerTransactionsH5Response struct {
|
||||||
|
H5Url string `json:"h5_url"` // 支付跳转链接
|
||||||
|
}
|
||||||
|
|
||||||
|
type PayPartnerTransactionsH5Result struct {
|
||||||
|
Result PayPartnerTransactionsH5Response // 结果
|
||||||
|
Body []byte // 内容
|
||||||
|
Http gorequest.Response // 请求
|
||||||
|
Err error // 错误
|
||||||
|
ApiError ApiError // 接口错误
|
||||||
|
}
|
||||||
|
|
||||||
|
func newPayPartnerTransactionsH5Result(result PayPartnerTransactionsH5Response, body []byte, http gorequest.Response, err error, apiError ApiError) *PayPartnerTransactionsH5Result {
|
||||||
|
return &PayPartnerTransactionsH5Result{Result: result, Body: body, Http: http, Err: err, ApiError: apiError}
|
||||||
|
}
|
||||||
|
|
||||||
|
// PayPartnerTransactionsH5 H5下单API
|
||||||
|
// https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter4_3_1.shtml
|
||||||
|
func (c *Client) PayPartnerTransactionsH5(ctx context.Context, notMustParams ...gorequest.Params) *PayPartnerTransactionsH5Result {
|
||||||
|
// 参数
|
||||||
|
params := gorequest.NewParamsWith(notMustParams...)
|
||||||
|
params.Set("sp_appid", c.GetSpAppid()) // 服务商应用ID
|
||||||
|
params.Set("sp_mchid", c.GetSpMchId()) // 服务商户号
|
||||||
|
params.Set("sub_appid", c.GetSubAppid()) // 子商户应用ID
|
||||||
|
params.Set("sub_mchid", c.GetSubMchId()) // 子商户号
|
||||||
|
// 请求
|
||||||
|
request, err := c.request(ctx, apiUrl+"/v3/pay/partner/transactions/h5", params, http.MethodPost)
|
||||||
|
if err != nil {
|
||||||
|
return newPayPartnerTransactionsH5Result(PayPartnerTransactionsH5Response{}, request.ResponseBody, request, err, ApiError{})
|
||||||
|
}
|
||||||
|
// 结果
|
||||||
|
var response PayPartnerTransactionsH5Response
|
||||||
|
err = json.Unmarshal(request.ResponseBody, &response)
|
||||||
|
// 错误
|
||||||
|
var apiError ApiError
|
||||||
|
err = json.Unmarshal(request.ResponseBody, &apiError)
|
||||||
|
return newPayPartnerTransactionsH5Result(response, request.ResponseBody, request, err, apiError)
|
||||||
|
}
|
@ -0,0 +1,89 @@
|
|||||||
|
package wechatpayopen
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"github.com/gin-gonic/gin"
|
||||||
|
)
|
||||||
|
|
||||||
|
// PayPartnerTransactionsJsapiNotifyGinRequest JSAPI下单 - 回调通知 - 请求参数
|
||||||
|
type PayPartnerTransactionsJsapiNotifyGinRequest struct {
|
||||||
|
Id string `form:"id" json:"status" xml:"id" uri:"id" binding:"required"` // 通知ID
|
||||||
|
CreateTime string `form:"create_time" json:"create_time" xml:"create_time" uri:"create_time" binding:"required"` // 通知创建时间
|
||||||
|
EventType string `form:"event_type" json:"event_type" xml:"event_type" uri:"event_type" binding:"required"` // 通知类型
|
||||||
|
ResourceType string `form:"resource_type" json:"resource_type" xml:"resource_type" uri:"resource_type" binding:"required"` // 通知数据类型
|
||||||
|
Resource struct {
|
||||||
|
Algorithm string `form:"algorithm" json:"algorithm" xml:"algorithm" uri:"algorithm" binding:"required"` // 加密算法类型
|
||||||
|
Ciphertext string `form:"ciphertext" json:"ciphertext" xml:"ciphertext" uri:"ciphertext" binding:"required"` // 数据密文
|
||||||
|
AssociatedData string `form:"associated_data" json:"associated_data" xml:"associated_data" uri:"associated_data" binding:"omitempty"` // 附加数据
|
||||||
|
OriginalType string `form:"original_type" json:"original_type" xml:"original_type" uri:"original_type" binding:"required"` // 原始类型
|
||||||
|
Nonce string `form:"nonce" json:"nonce" xml:"nonce" uri:"nonce" binding:"required"` // 随机串
|
||||||
|
} `form:"resource" json:"resource" xml:"resource" uri:"resource" binding:"required"` // 通知数据
|
||||||
|
Summary string `form:"summary" json:"summary" xml:"summary" uri:"summary" binding:"required"` // 回调摘要
|
||||||
|
}
|
||||||
|
|
||||||
|
// PayPartnerTransactionsJsapiNotifyGin JSAPI下单 - 回调通知
|
||||||
|
// https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter4_1_5.shtml
|
||||||
|
func (c *Client) PayPartnerTransactionsJsapiNotifyGin(ctx context.Context, ginCtx *gin.Context) (validateJson PayPartnerTransactionsJsapiNotifyGinRequest, response PayPartnerTransactionsJsapiNotifyGinResponse, gcm []byte, err error) {
|
||||||
|
|
||||||
|
// 解析
|
||||||
|
err = ginCtx.ShouldBind(&validateJson)
|
||||||
|
|
||||||
|
gcm, err = c.decryptGCM(c.GetApiV3(), validateJson.Resource.Nonce, validateJson.Resource.Ciphertext, validateJson.Resource.AssociatedData)
|
||||||
|
if err != nil {
|
||||||
|
return validateJson, response, gcm, err
|
||||||
|
}
|
||||||
|
|
||||||
|
err = json.Unmarshal(gcm, &response)
|
||||||
|
|
||||||
|
return validateJson, response, gcm, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// PayPartnerTransactionsJsapiNotifyGinResponse JSAPI下单 - 回调通知 - 解密后数据
|
||||||
|
type PayPartnerTransactionsJsapiNotifyGinResponse struct {
|
||||||
|
SpAppid string `json:"sp_appid"` // 服务商应用ID
|
||||||
|
SpMchid string `json:"sp_mchid"` // 服务商户号
|
||||||
|
SubAppid string `json:"sub_appid,omitempty"` // 子商户应用ID
|
||||||
|
SubMchid string `json:"sub_mchid"` // 子商户号
|
||||||
|
OutTradeNo string `json:"out_trade_no"` // 商户订单号
|
||||||
|
TransactionId string `json:"transaction_id"` // 微信支付订单号
|
||||||
|
TradeType string `json:"trade_type"` // 交易类型
|
||||||
|
TradeState string `json:"trade_state"` // 交易状态
|
||||||
|
TradeStateDesc string `json:"trade_state_desc"` // 交易状态描述
|
||||||
|
BankType string `json:"bank_type"` // 付款银行
|
||||||
|
Attach string `json:"attach,omitempty"` // 附加数据
|
||||||
|
SuccessTime string `json:"success_time"` // 支付完成时间
|
||||||
|
Payer struct {
|
||||||
|
Openid string `json:"openid"` // 用户服务标识
|
||||||
|
SpOpenid string `json:"sp_openid,omitempty"` // 用户服务标识
|
||||||
|
SubOpenid string `json:"sub_openid,omitempty"` // 用户子标识
|
||||||
|
} `json:"payer"` // -支付者
|
||||||
|
Amount struct {
|
||||||
|
Total int `json:"total"` // 总金额
|
||||||
|
PayerTotal int `json:"payer_total"` // 用户支付金额
|
||||||
|
Currency string `json:"currency"` // 货币类型
|
||||||
|
PayerCurrency string `json:"payer_currency"` // 用户支付币种
|
||||||
|
} `json:"amount"` // 订单金额
|
||||||
|
SceneInfo struct {
|
||||||
|
DeviceId string `json:"device_id,omitempty"` //商户端设备号
|
||||||
|
} `json:"scene_info,omitempty"` // 场景信息
|
||||||
|
PromotionDetail []struct {
|
||||||
|
CouponId string `json:"coupon_id"` // 券ID
|
||||||
|
Name string `json:"name,omitempty"` // 优惠名称
|
||||||
|
Scope string `json:"scope,omitempty"` // 优惠范围
|
||||||
|
Type string `json:"type,omitempty"` // 优惠类型
|
||||||
|
Amount int `json:"amount"` // 优惠券面额
|
||||||
|
StockId string `json:"stock_id,omitempty"` // 活动ID
|
||||||
|
WechatpayContribute int `json:"wechatpay_contribute,omitempty"` // 微信出资
|
||||||
|
MerchantContribute int `json:"merchant_contribute,omitempty"` // 商户出资
|
||||||
|
OtherContribute int `json:"other_contribute,omitempty"` // 其他出资
|
||||||
|
Currency string `json:"currency,omitempty"` // 优惠币种
|
||||||
|
GoodsDetail []struct {
|
||||||
|
GoodsId string `json:"goods_id"` // 商品编码
|
||||||
|
Quantity int `json:"quantity"` // 商品数量
|
||||||
|
UnitPrice int `json:"unit_price"` // 商品单价
|
||||||
|
DiscountAmount int `json:"discount_amount"` // 商品优惠金额
|
||||||
|
GoodsRemark string `json:"goods_remark,omitempty"` // 商品备注
|
||||||
|
} `json:"goods_detail,omitempty"` // 单品列表
|
||||||
|
} `json:"promotion_detail,omitempty"` // 优惠功能
|
||||||
|
}
|
@ -0,0 +1,44 @@
|
|||||||
|
package wechatpayopen
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"go.dtapp.net/gorequest"
|
||||||
|
"net/http"
|
||||||
|
)
|
||||||
|
|
||||||
|
type ProfitSharingMerchantConfigsResponse struct {
|
||||||
|
SubMchid string `json:"sub_mchid"` // 子商户号
|
||||||
|
MaxRatio int `json:"max_ratio"` // 最大分账比例
|
||||||
|
}
|
||||||
|
|
||||||
|
type ProfitSharingMerchantConfigsResult struct {
|
||||||
|
Result ProfitSharingMerchantConfigsResponse // 结果
|
||||||
|
Body []byte // 内容
|
||||||
|
Http gorequest.Response // 请求
|
||||||
|
Err error // 错误
|
||||||
|
ApiError ApiError // 接口错误
|
||||||
|
}
|
||||||
|
|
||||||
|
func newProfitSharingMerchantConfigsResult(result ProfitSharingMerchantConfigsResponse, body []byte, http gorequest.Response, err error, apiError ApiError) *ProfitSharingMerchantConfigsResult {
|
||||||
|
return &ProfitSharingMerchantConfigsResult{Result: result, Body: body, Http: http, Err: err, ApiError: apiError}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ProfitSharingMerchantConfigs 查询最大分账比例API
|
||||||
|
// https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter8_1_7.shtml
|
||||||
|
func (c *Client) ProfitSharingMerchantConfigs(ctx context.Context) *ProfitSharingMerchantConfigsResult {
|
||||||
|
// 参数
|
||||||
|
params := gorequest.NewParams()
|
||||||
|
// 请求
|
||||||
|
request, err := c.request(ctx, apiUrl+"/v3/profitsharing/merchant-configs/"+c.GetSubMchId(), params, http.MethodGet)
|
||||||
|
if err != nil {
|
||||||
|
return newProfitSharingMerchantConfigsResult(ProfitSharingMerchantConfigsResponse{}, request.ResponseBody, request, err, ApiError{})
|
||||||
|
}
|
||||||
|
// 定义
|
||||||
|
var response ProfitSharingMerchantConfigsResponse
|
||||||
|
err = json.Unmarshal(request.ResponseBody, &response)
|
||||||
|
// 错误
|
||||||
|
var apiError ApiError
|
||||||
|
err = json.Unmarshal(request.ResponseBody, &apiError)
|
||||||
|
return newProfitSharingMerchantConfigsResult(response, request.ResponseBody, request, err, apiError)
|
||||||
|
}
|
@ -0,0 +1,61 @@
|
|||||||
|
package wechatpayopen
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"go.dtapp.net/gorequest"
|
||||||
|
"net/http"
|
||||||
|
)
|
||||||
|
|
||||||
|
type ProfitSharingOrdersResponse struct {
|
||||||
|
SubMchid string `json:"sub_mchid"` // 子商户号
|
||||||
|
TransactionId string `json:"transaction_id"` // 微信订单号
|
||||||
|
OutOrderNo string `json:"out_order_no"` // 商户分账单号
|
||||||
|
OrderId string `json:"order_id"` // 微信分账单号
|
||||||
|
State string `json:"state"` // 分账单状态
|
||||||
|
Receivers []struct {
|
||||||
|
Amount int `json:"amount"` // 分账金额
|
||||||
|
Description string `json:"description"` // 分账描述
|
||||||
|
Type string `json:"type"` // 分账接收方类型
|
||||||
|
Account string `json:"account"` // 分账接收方账号
|
||||||
|
Result string `json:"result"` // 分账结果
|
||||||
|
FailReason string `json:"fail_reason"` // 分账失败原因
|
||||||
|
DetailId string `json:"detail_id"` // 分账明细单号
|
||||||
|
CreateTime string `json:"create_time"` // 分账创建时间
|
||||||
|
FinishTime string `json:"finish_time"` // 分账完成时间
|
||||||
|
} `json:"receivers,omitempty"` // 分账接收方列表
|
||||||
|
}
|
||||||
|
|
||||||
|
type ProfitSharingOrdersResult struct {
|
||||||
|
Result ProfitSharingOrdersResponse // 结果
|
||||||
|
Body []byte // 内容
|
||||||
|
Http gorequest.Response // 请求
|
||||||
|
Err error // 错误
|
||||||
|
ApiError ApiError // 接口错误
|
||||||
|
}
|
||||||
|
|
||||||
|
func newProfitSharingOrdersResult(result ProfitSharingOrdersResponse, body []byte, http gorequest.Response, err error, apiError ApiError) *ProfitSharingOrdersResult {
|
||||||
|
return &ProfitSharingOrdersResult{Result: result, Body: body, Http: http, Err: err, ApiError: apiError}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ProfitSharingOrders 请求分账API
|
||||||
|
// https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter8_1_1.shtml
|
||||||
|
func (c *Client) ProfitSharingOrders(ctx context.Context, notMustParams ...gorequest.Params) *ProfitSharingOrdersResult {
|
||||||
|
// 参数
|
||||||
|
params := gorequest.NewParamsWith(notMustParams...)
|
||||||
|
params.Set("sub_mchid", c.GetSubMchId()) // 子商户号
|
||||||
|
params.Set("appid", c.GetSpAppid()) // 应用ID
|
||||||
|
params.Set("sub_appid", c.GetSubAppid()) // 子商户应用ID
|
||||||
|
// 请求
|
||||||
|
request, err := c.request(ctx, apiUrl+"/v3/profitsharing/orders", params, http.MethodPost)
|
||||||
|
if err != nil {
|
||||||
|
return newProfitSharingOrdersResult(ProfitSharingOrdersResponse{}, request.ResponseBody, request, err, ApiError{})
|
||||||
|
}
|
||||||
|
// 定义
|
||||||
|
var response ProfitSharingOrdersResponse
|
||||||
|
err = json.Unmarshal(request.ResponseBody, &response)
|
||||||
|
// 错误
|
||||||
|
var apiError ApiError
|
||||||
|
err = json.Unmarshal(request.ResponseBody, &apiError)
|
||||||
|
return newProfitSharingOrdersResult(response, request.ResponseBody, request, err, apiError)
|
||||||
|
}
|
@ -0,0 +1,61 @@
|
|||||||
|
package wechatpayopen
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"go.dtapp.net/gorequest"
|
||||||
|
"net/http"
|
||||||
|
)
|
||||||
|
|
||||||
|
type ProfitSharingOrdersOutOrderNoResponse struct {
|
||||||
|
SubMchid string `json:"sub_mchid"` // 子商户号
|
||||||
|
TransactionId string `json:"transaction_id"` // 微信订单号
|
||||||
|
OutOrderNo string `json:"out_order_no"` // 商户分账单号
|
||||||
|
OrderId string `json:"order_id"` // 微信分账单号
|
||||||
|
State string `json:"state"` // 分账单状态
|
||||||
|
Receivers []struct {
|
||||||
|
Amount int `json:"amount"` // 分账金额
|
||||||
|
Description string `json:"description"` // 分账描述
|
||||||
|
Type string `json:"type"` // 分账接收方类型
|
||||||
|
Account string `json:"account"` // 分账接收方账号
|
||||||
|
Result string `json:"result"` // 分账结果
|
||||||
|
FailReason string `json:"fail_reason"` // 分账失败原因
|
||||||
|
DetailId string `json:"detail_id"` // 分账明细单号
|
||||||
|
CreateTime string `json:"create_time"` // 分账创建时间
|
||||||
|
FinishTime string `json:"finish_time"` // 分账完成时间
|
||||||
|
} `json:"receivers,omitempty"` // 分账接收方列表
|
||||||
|
}
|
||||||
|
|
||||||
|
type ProfitSharingOrdersOutOrderNoResult struct {
|
||||||
|
Result ProfitSharingOrdersOutOrderNoResponse // 结果
|
||||||
|
Body []byte // 内容
|
||||||
|
Http gorequest.Response // 请求
|
||||||
|
Err error // 错误
|
||||||
|
ApiError ApiError // 接口错误
|
||||||
|
}
|
||||||
|
|
||||||
|
func newProfitSharingOrdersOutOrderNoResult(result ProfitSharingOrdersOutOrderNoResponse, body []byte, http gorequest.Response, err error, apiError ApiError) *ProfitSharingOrdersOutOrderNoResult {
|
||||||
|
return &ProfitSharingOrdersOutOrderNoResult{Result: result, Body: body, Http: http, Err: err, ApiError: apiError}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ProfitSharingOrdersOutOrderNo 查询分账结果API
|
||||||
|
// https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter8_1_2.shtml
|
||||||
|
func (c *Client) ProfitSharingOrdersOutOrderNo(ctx context.Context, transactionId, outOrderNo string) *ProfitSharingOrdersOutOrderNoResult {
|
||||||
|
// 参数
|
||||||
|
params := gorequest.NewParams()
|
||||||
|
params.Set("sub_mchid", c.GetSubMchId()) // 子商户号
|
||||||
|
params.Set("transaction_id", transactionId) // 微信订单号
|
||||||
|
params.Set("out_order_no", outOrderNo) // 商户分账单号
|
||||||
|
// 请求
|
||||||
|
request, err := c.request(ctx, apiUrl+"/v3/profitsharing/orders/"+outOrderNo, params, http.MethodGet)
|
||||||
|
if err != nil {
|
||||||
|
return newProfitSharingOrdersOutOrderNoResult(ProfitSharingOrdersOutOrderNoResponse{}, request.ResponseBody, request, err, ApiError{})
|
||||||
|
}
|
||||||
|
// 定义
|
||||||
|
var response ProfitSharingOrdersOutOrderNoResponse
|
||||||
|
err = json.Unmarshal(request.ResponseBody, &response)
|
||||||
|
// 错误
|
||||||
|
var apiError ApiError
|
||||||
|
err = json.Unmarshal(request.ResponseBody, &apiError)
|
||||||
|
return newProfitSharingOrdersOutOrderNoResult(response, request.ResponseBody, request, err, apiError)
|
||||||
|
}
|
@ -0,0 +1,62 @@
|
|||||||
|
package wechatpayopen
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"go.dtapp.net/gorequest"
|
||||||
|
"net/http"
|
||||||
|
)
|
||||||
|
|
||||||
|
type ProfitSharingOrdersUnfreezeResponse struct {
|
||||||
|
SubMchid string `json:"sub_mchid"` // 子商户号
|
||||||
|
TransactionId string `json:"transaction_id"` // 微信订单号
|
||||||
|
OutOrderNo string `json:"out_order_no"` // 商户分账单号
|
||||||
|
OrderId string `json:"order_id"` // 微信分账单号
|
||||||
|
State string `json:"state"` // 分账单状态
|
||||||
|
Receivers []struct {
|
||||||
|
Amount int `json:"amount"` // 分账金额
|
||||||
|
Description string `json:"description"` // 分账描述
|
||||||
|
Type string `json:"type"` // 分账接收方类型
|
||||||
|
Account string `json:"account"` // 分账接收方账号
|
||||||
|
Result string `json:"result"` // 分账结果
|
||||||
|
FailReason string `json:"fail_reason"` // 分账失败原因
|
||||||
|
DetailId string `json:"detail_id"` // 分账明细单号
|
||||||
|
CreateTime string `json:"create_time"` // 分账创建时间
|
||||||
|
FinishTime string `json:"finish_time"` // 分账完成时间
|
||||||
|
} `json:"receivers,omitempty"` // 分账接收方列表
|
||||||
|
}
|
||||||
|
|
||||||
|
type ProfitSharingOrdersUnfreezeResult struct {
|
||||||
|
Result ProfitSharingOrdersUnfreezeResponse // 结果
|
||||||
|
Body []byte // 内容
|
||||||
|
Http gorequest.Response // 请求
|
||||||
|
Err error // 错误
|
||||||
|
ApiError ApiError // 接口错误
|
||||||
|
}
|
||||||
|
|
||||||
|
func newProfitSharingOrdersUnfreezeResult(result ProfitSharingOrdersUnfreezeResponse, body []byte, http gorequest.Response, err error, apiError ApiError) *ProfitSharingOrdersUnfreezeResult {
|
||||||
|
return &ProfitSharingOrdersUnfreezeResult{Result: result, Body: body, Http: http, Err: err, ApiError: apiError}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ProfitSharingOrdersUnfreeze 解冻剩余资金API
|
||||||
|
// https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter8_1_5.shtml
|
||||||
|
func (c *Client) ProfitSharingOrdersUnfreeze(ctx context.Context, transactionId, outOrderNo, description string) *ProfitSharingOrdersUnfreezeResult {
|
||||||
|
// 参数
|
||||||
|
params := gorequest.NewParams()
|
||||||
|
params.Set("sub_mchid", c.GetSubMchId()) // 子商户号
|
||||||
|
params.Set("transaction_id", transactionId) // 微信订单号
|
||||||
|
params.Set("out_order_no", outOrderNo) // 商户分账单号
|
||||||
|
params.Set("description", description) // 分账描述
|
||||||
|
// 请求
|
||||||
|
request, err := c.request(ctx, apiUrl+"/v3/profitsharing/orders/unfreeze", params, http.MethodPost)
|
||||||
|
if err != nil {
|
||||||
|
return newProfitSharingOrdersUnfreezeResult(ProfitSharingOrdersUnfreezeResponse{}, request.ResponseBody, request, err, ApiError{})
|
||||||
|
}
|
||||||
|
// 定义
|
||||||
|
var response ProfitSharingOrdersUnfreezeResponse
|
||||||
|
err = json.Unmarshal(request.ResponseBody, &response)
|
||||||
|
// 错误
|
||||||
|
var apiError ApiError
|
||||||
|
err = json.Unmarshal(request.ResponseBody, &apiError)
|
||||||
|
return newProfitSharingOrdersUnfreezeResult(response, request.ResponseBody, request, err, apiError)
|
||||||
|
}
|
@ -0,0 +1,68 @@
|
|||||||
|
package wechatpayopen
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"go.dtapp.net/gorequest"
|
||||||
|
"net/http"
|
||||||
|
)
|
||||||
|
|
||||||
|
type ProfitSharingReceiversAddResponse struct {
|
||||||
|
SubMchid string `json:"sub_mchid"` // 子商户号
|
||||||
|
Type string `json:"type"` // 分账接收方类型
|
||||||
|
Account string `json:"account"` // 分账接收方账号
|
||||||
|
Name string `json:"name,omitempty"` // 分账接收方全称
|
||||||
|
RelationType string `json:"relation_type"` // 与分账方的关系类型
|
||||||
|
CustomRelation string `json:"custom_relation,omitempty"` // 自定义的分账关系
|
||||||
|
}
|
||||||
|
|
||||||
|
type ProfitSharingReceiversAddResult struct {
|
||||||
|
Result ProfitSharingReceiversAddResponse // 结果
|
||||||
|
Body []byte // 内容
|
||||||
|
Http gorequest.Response // 请求
|
||||||
|
Err error // 错误
|
||||||
|
ApiError ApiError // 接口错误
|
||||||
|
}
|
||||||
|
|
||||||
|
func newProfitSharingReceiversAddResult(result ProfitSharingReceiversAddResponse, body []byte, http gorequest.Response, err error, apiError ApiError) *ProfitSharingReceiversAddResult {
|
||||||
|
return &ProfitSharingReceiversAddResult{Result: result, Body: body, Http: http, Err: err, ApiError: apiError}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ProfitSharingReceiversAdd 添加分账接收方API
|
||||||
|
// https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter8_1_8.shtml
|
||||||
|
func (c *Client) ProfitSharingReceiversAdd(ctx context.Context, Type, account, name, relationType, customRelation string) *ProfitSharingReceiversAddResult {
|
||||||
|
// 参数
|
||||||
|
params := gorequest.NewParams()
|
||||||
|
params.Set("sub_mchid", c.GetSubMchId()) // 子商户号
|
||||||
|
params.Set("appid", c.GetSpAppid()) // 应用ID
|
||||||
|
params.Set("sub_appid", c.GetSubAppid()) // 子商户应用ID
|
||||||
|
params.Set("type", Type) // 分账接收方类型
|
||||||
|
if Type == MERCHANT_ID {
|
||||||
|
params.Set("account", account) // 商户号
|
||||||
|
params.Set("name", name) // 商户全称
|
||||||
|
}
|
||||||
|
if Type == PERSONAL_OPENID && name != "" {
|
||||||
|
params.Set("account", account) // 个人openid
|
||||||
|
params.Set("name", name) // 个人姓名
|
||||||
|
}
|
||||||
|
if Type == PERSONAL_SUB_OPENID && name != "" {
|
||||||
|
params.Set("account", account) // 个人sub_openid
|
||||||
|
params.Set("name", name) // 个人姓名
|
||||||
|
}
|
||||||
|
params.Set("relation_type", relationType) // 与分账方的关系类型
|
||||||
|
if relationType == "CUSTOM" {
|
||||||
|
params.Set("custom_relation", customRelation) // 自定义的分账关系
|
||||||
|
}
|
||||||
|
// 请求
|
||||||
|
request, err := c.request(ctx, apiUrl+"/v3/profitsharing/receivers/delete", params, http.MethodPost)
|
||||||
|
if err != nil {
|
||||||
|
return newProfitSharingReceiversAddResult(ProfitSharingReceiversAddResponse{}, request.ResponseBody, request, err, ApiError{})
|
||||||
|
}
|
||||||
|
// 定义
|
||||||
|
var response ProfitSharingReceiversAddResponse
|
||||||
|
err = json.Unmarshal(request.ResponseBody, &response)
|
||||||
|
// 错误
|
||||||
|
var apiError ApiError
|
||||||
|
err = json.Unmarshal(request.ResponseBody, &apiError)
|
||||||
|
return newProfitSharingReceiversAddResult(response, request.ResponseBody, request, err, apiError)
|
||||||
|
}
|
@ -0,0 +1,58 @@
|
|||||||
|
package wechatpayopen
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"go.dtapp.net/gorequest"
|
||||||
|
"net/http"
|
||||||
|
)
|
||||||
|
|
||||||
|
type ProfitSharingReceiversDeleteResponse struct {
|
||||||
|
SubMchid string `json:"sub_mchid"` // 子商户号
|
||||||
|
Type string `json:"type"` // 分账接收方类型
|
||||||
|
Account string `json:"account"` // 分账接收方账号
|
||||||
|
}
|
||||||
|
|
||||||
|
type ProfitSharingReceiversDeleteResult struct {
|
||||||
|
Result ProfitSharingReceiversDeleteResponse // 结果
|
||||||
|
Body []byte // 内容
|
||||||
|
Http gorequest.Response // 请求
|
||||||
|
Err error // 错误
|
||||||
|
ApiError ApiError // 接口错误
|
||||||
|
}
|
||||||
|
|
||||||
|
func newProfitSharingReceiversDeleteResult(result ProfitSharingReceiversDeleteResponse, body []byte, http gorequest.Response, err error, apiError ApiError) *ProfitSharingReceiversDeleteResult {
|
||||||
|
return &ProfitSharingReceiversDeleteResult{Result: result, Body: body, Http: http, Err: err, ApiError: apiError}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ProfitSharingReceiversDelete 删除分账接收方API
|
||||||
|
// https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter8_1_9.shtml
|
||||||
|
func (c *Client) ProfitSharingReceiversDelete(ctx context.Context, Type, account string) *ProfitSharingReceiversDeleteResult {
|
||||||
|
// 参数
|
||||||
|
params := gorequest.NewParams()
|
||||||
|
params.Set("sub_mchid", c.GetSubMchId()) // 子商户号
|
||||||
|
params.Set("appid", c.GetSpAppid()) // 应用ID
|
||||||
|
params.Set("sub_appid", c.GetSubAppid()) // 子商户应用ID
|
||||||
|
params.Set("type", Type) // 分账接收方类型
|
||||||
|
if Type == MERCHANT_ID {
|
||||||
|
params.Set("account", account) // 商户号
|
||||||
|
}
|
||||||
|
if Type == PERSONAL_OPENID {
|
||||||
|
params.Set("account", account) // 个人openid
|
||||||
|
}
|
||||||
|
if Type == PERSONAL_SUB_OPENID {
|
||||||
|
params.Set("account", account) // 个人sub_openid
|
||||||
|
}
|
||||||
|
// 请求
|
||||||
|
request, err := c.request(ctx, apiUrl+"/v3/profitsharing/receivers/delete", params, http.MethodPost)
|
||||||
|
if err != nil {
|
||||||
|
return newProfitSharingReceiversDeleteResult(ProfitSharingReceiversDeleteResponse{}, request.ResponseBody, request, err, ApiError{})
|
||||||
|
}
|
||||||
|
// 定义
|
||||||
|
var response ProfitSharingReceiversDeleteResponse
|
||||||
|
err = json.Unmarshal(request.ResponseBody, &response)
|
||||||
|
// 错误
|
||||||
|
var apiError ApiError
|
||||||
|
err = json.Unmarshal(request.ResponseBody, &apiError)
|
||||||
|
return newProfitSharingReceiversDeleteResult(response, request.ResponseBody, request, err, apiError)
|
||||||
|
}
|
@ -0,0 +1,56 @@
|
|||||||
|
package wechatpayopen
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"github.com/gin-gonic/gin"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ProfitSharingReceiversNotifyGinRequest 分账动账通知API - 回调通知 - 请求参数
|
||||||
|
type ProfitSharingReceiversNotifyGinRequest struct {
|
||||||
|
Id string `form:"id" json:"status" xml:"id" uri:"id" binding:"required"` // 通知ID
|
||||||
|
CreateTime string `form:"create_time" json:"create_time" xml:"create_time" uri:"create_time" binding:"required"` // 通知创建时间
|
||||||
|
EventType string `form:"event_type" json:"event_type" xml:"event_type" uri:"event_type" binding:"required"` // 通知类型
|
||||||
|
Summary string `form:"summary" json:"summary" xml:"summary" uri:"summary" binding:"required"` // 通知简要说明
|
||||||
|
ResourceType string `form:"resource_type" json:"resource_type" xml:"resource_type" uri:"resource_type" binding:"required"` // 通知数据类型
|
||||||
|
Resource struct {
|
||||||
|
Algorithm string `form:"algorithm" json:"algorithm" xml:"algorithm" uri:"algorithm" binding:"required"` // 加密算法类型
|
||||||
|
Ciphertext string `form:"ciphertext" json:"ciphertext" xml:"ciphertext" uri:"ciphertext" binding:"required"` // 数据密文
|
||||||
|
AssociatedData string `form:"associated_data" json:"associated_data" xml:"associated_data" uri:"associated_data" binding:"omitempty"` // 附加数据
|
||||||
|
OriginalType string `form:"original_type" json:"original_type" xml:"original_type" uri:"original_type" binding:"required"` // 原始类型
|
||||||
|
Nonce string `form:"nonce" json:"nonce" xml:"nonce" uri:"nonce" binding:"required"` // 随机串
|
||||||
|
} `form:"resource" json:"resource" xml:"resource" uri:"resource" binding:"required"` // 通知数据
|
||||||
|
}
|
||||||
|
|
||||||
|
// ProfitSharingReceiversNotifyGin 分账动账通知API - 回调通知
|
||||||
|
// https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter4_1_5.shtml
|
||||||
|
func (c *Client) ProfitSharingReceiversNotifyGin(ctx context.Context, ginCtx *gin.Context) (validateJson ProfitSharingReceiversNotifyGinRequest, response ProfitSharingReceiversNotifyGinResponse, gcm []byte, err error) {
|
||||||
|
|
||||||
|
// 解析
|
||||||
|
err = ginCtx.ShouldBind(&validateJson)
|
||||||
|
|
||||||
|
gcm, err = c.decryptGCM(c.GetApiV3(), validateJson.Resource.Nonce, validateJson.Resource.Ciphertext, validateJson.Resource.AssociatedData)
|
||||||
|
if err != nil {
|
||||||
|
return validateJson, response, gcm, err
|
||||||
|
}
|
||||||
|
|
||||||
|
err = json.Unmarshal(gcm, &response)
|
||||||
|
|
||||||
|
return validateJson, response, gcm, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// ProfitSharingReceiversNotifyGinResponse 分账动账通知API - 回调通知 - 解密后数据
|
||||||
|
type ProfitSharingReceiversNotifyGinResponse struct {
|
||||||
|
SpMchid string `json:"sp_mchid"` // 服务商商户号
|
||||||
|
SubMchid string `json:"sub_mchid"` // 子商户号
|
||||||
|
TransactionId string `json:"transaction_id"` // 微信订单号
|
||||||
|
OrderId string `json:"order_id"` // 微信分账/回退单号
|
||||||
|
OutOrderNo string `json:"out_order_no"` // 商户分账/回退单号
|
||||||
|
Receiver struct {
|
||||||
|
Type string `json:"type"` // 分账接收方类型
|
||||||
|
Account string `json:"account"` // 分账接收方账号
|
||||||
|
Amount int `json:"amount"` // 分账动账金额
|
||||||
|
Description string `json:"description"` // 分账/回退描述
|
||||||
|
} `json:"receiver"` // 分账接收方列表
|
||||||
|
SuccessTime string `json:"success_time"` // 成功时间
|
||||||
|
}
|
@ -0,0 +1,55 @@
|
|||||||
|
package wechatpayopen
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"go.dtapp.net/gorequest"
|
||||||
|
"net/http"
|
||||||
|
)
|
||||||
|
|
||||||
|
type ProfitSharingReturnOrdersResponse struct {
|
||||||
|
SubMchid string `json:"sub_mchid"` // 子商户号
|
||||||
|
OrderId string `json:"order_id"` // 微信分账单号
|
||||||
|
OutOrderNo string `json:"out_order_no"` // 商户分账单号
|
||||||
|
OutReturnNo string `json:"out_return_no"` // 商户回退单号
|
||||||
|
ReturnId string `json:"return_id"` // 微信回退单号
|
||||||
|
ReturnMchid string `json:"return_mchid"` // 回退商户号
|
||||||
|
Amount int `json:"amount"` // 回退金额
|
||||||
|
Description string `json:"description"` // 回退描述
|
||||||
|
Result string `json:"result"` // 回退结果
|
||||||
|
FailReason string `json:"fail_reason"` // 失败原因
|
||||||
|
CreateTime string `json:"create_time"` // 创建时间
|
||||||
|
FinishTime string `json:"finish_time"` // 完成时间
|
||||||
|
}
|
||||||
|
|
||||||
|
type ProfitSharingReturnOrdersResult struct {
|
||||||
|
Result ProfitSharingReturnOrdersResponse // 结果
|
||||||
|
Body []byte // 内容
|
||||||
|
Http gorequest.Response // 请求
|
||||||
|
Err error // 错误
|
||||||
|
ApiError ApiError // 接口错误
|
||||||
|
}
|
||||||
|
|
||||||
|
func newProfitSharingReturnOrdersResult(result ProfitSharingReturnOrdersResponse, body []byte, http gorequest.Response, err error, apiError ApiError) *ProfitSharingReturnOrdersResult {
|
||||||
|
return &ProfitSharingReturnOrdersResult{Result: result, Body: body, Http: http, Err: err, ApiError: apiError}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ProfitSharingReturnOrders 请求分账回退API
|
||||||
|
// https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter8_1_3.shtml
|
||||||
|
func (c *Client) ProfitSharingReturnOrders(ctx context.Context, notMustParams ...gorequest.Params) *ProfitSharingReturnOrdersResult {
|
||||||
|
// 参数
|
||||||
|
params := gorequest.NewParamsWith(notMustParams...)
|
||||||
|
params.Set("sub_mchid", c.GetSubMchId()) // 子商户号
|
||||||
|
// 请求
|
||||||
|
request, err := c.request(ctx, apiUrl+"/v3/profitsharing/return-orders", params, http.MethodPost)
|
||||||
|
if err != nil {
|
||||||
|
return newProfitSharingReturnOrdersResult(ProfitSharingReturnOrdersResponse{}, request.ResponseBody, request, err, ApiError{})
|
||||||
|
}
|
||||||
|
// 定义
|
||||||
|
var response ProfitSharingReturnOrdersResponse
|
||||||
|
err = json.Unmarshal(request.ResponseBody, &response)
|
||||||
|
// 错误
|
||||||
|
var apiError ApiError
|
||||||
|
err = json.Unmarshal(request.ResponseBody, &apiError)
|
||||||
|
return newProfitSharingReturnOrdersResult(response, request.ResponseBody, request, err, apiError)
|
||||||
|
}
|
@ -0,0 +1,57 @@
|
|||||||
|
package wechatpayopen
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"go.dtapp.net/gorequest"
|
||||||
|
"net/http"
|
||||||
|
)
|
||||||
|
|
||||||
|
type ProfitSharingReturnOrdersOutReturnNoResponse struct {
|
||||||
|
SubMchid string `json:"sub_mchid"` // 子商户号
|
||||||
|
OrderId string `json:"order_id"` // 微信分账单号
|
||||||
|
OutOrderNo string `json:"out_order_no"` // 商户分账单号
|
||||||
|
OutReturnNo string `json:"out_return_no"` // 商户回退单号
|
||||||
|
ReturnId string `json:"return_id"` // 微信回退单号
|
||||||
|
ReturnMchid string `json:"return_mchid"` // 回退商户号
|
||||||
|
Amount int `json:"amount"` // 回退金额
|
||||||
|
Description string `json:"description"` // 回退描述
|
||||||
|
Result string `json:"result"` // 回退结果
|
||||||
|
FailReason string `json:"fail_reason"` // 失败原因
|
||||||
|
CreateTime string `json:"create_time"` // 创建时间
|
||||||
|
FinishTime string `json:"finish_time"` // 完成时间
|
||||||
|
}
|
||||||
|
|
||||||
|
type ProfitSharingReturnOrdersOutReturnNoResult struct {
|
||||||
|
Result ProfitSharingReturnOrdersOutReturnNoResponse // 结果
|
||||||
|
Body []byte // 内容
|
||||||
|
Http gorequest.Response // 请求
|
||||||
|
Err error // 错误
|
||||||
|
ApiError ApiError // 接口错误
|
||||||
|
}
|
||||||
|
|
||||||
|
func newProfitSharingReturnOrdersOutReturnNoResult(result ProfitSharingReturnOrdersOutReturnNoResponse, body []byte, http gorequest.Response, err error, apiError ApiError) *ProfitSharingReturnOrdersOutReturnNoResult {
|
||||||
|
return &ProfitSharingReturnOrdersOutReturnNoResult{Result: result, Body: body, Http: http, Err: err, ApiError: apiError}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ProfitSharingReturnOrdersOutReturnNo 查询分账回退结果API
|
||||||
|
// https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter8_1_4.shtml
|
||||||
|
func (c *Client) ProfitSharingReturnOrdersOutReturnNo(ctx context.Context, outReturnNo, outOrderNo string) *ProfitSharingReturnOrdersOutReturnNoResult {
|
||||||
|
// 参数
|
||||||
|
params := gorequest.NewParams()
|
||||||
|
params.Set("sub_mchid", c.GetSubMchId()) // 子商户号
|
||||||
|
params.Set("out_return_no", outReturnNo) // 商户回退单号
|
||||||
|
params.Set("out_order_no", outOrderNo) // 商户分账单号
|
||||||
|
// 请求
|
||||||
|
request, err := c.request(ctx, apiUrl+"/v3/profitsharing/return-orders/"+outReturnNo, params, http.MethodGet)
|
||||||
|
if err != nil {
|
||||||
|
return newProfitSharingReturnOrdersOutReturnNoResult(ProfitSharingReturnOrdersOutReturnNoResponse{}, request.ResponseBody, request, err, ApiError{})
|
||||||
|
}
|
||||||
|
// 定义
|
||||||
|
var response ProfitSharingReturnOrdersOutReturnNoResponse
|
||||||
|
err = json.Unmarshal(request.ResponseBody, &response)
|
||||||
|
// 错误
|
||||||
|
var apiError ApiError
|
||||||
|
err = json.Unmarshal(request.ResponseBody, &apiError)
|
||||||
|
return newProfitSharingReturnOrdersOutReturnNoResult(response, request.ResponseBody, request, err, apiError)
|
||||||
|
}
|
@ -0,0 +1,44 @@
|
|||||||
|
package wechatpayopen
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"go.dtapp.net/gorequest"
|
||||||
|
"net/http"
|
||||||
|
)
|
||||||
|
|
||||||
|
type ProfitSharingTransactionsAmountsResponse struct {
|
||||||
|
TransactionId string `json:"transaction_id"` // 微信订单号
|
||||||
|
UnsplitAmount int `json:"unsplit_amount"` // 订单剩余待分金额
|
||||||
|
}
|
||||||
|
|
||||||
|
type ProfitSharingTransactionsAmountsResult struct {
|
||||||
|
Result ProfitSharingTransactionsAmountsResponse // 结果
|
||||||
|
Body []byte // 内容
|
||||||
|
Http gorequest.Response // 请求
|
||||||
|
Err error // 错误
|
||||||
|
ApiError ApiError // 接口错误
|
||||||
|
}
|
||||||
|
|
||||||
|
func newProfitSharingTransactionsAmountsResult(result ProfitSharingTransactionsAmountsResponse, body []byte, http gorequest.Response, err error, apiError ApiError) *ProfitSharingTransactionsAmountsResult {
|
||||||
|
return &ProfitSharingTransactionsAmountsResult{Result: result, Body: body, Http: http, Err: err, ApiError: apiError}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ProfitSharingTransactionsAmounts 查询剩余待分金额API
|
||||||
|
// https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter8_1_6.shtml
|
||||||
|
func (c *Client) ProfitSharingTransactionsAmounts(ctx context.Context, transactionId string) *ProfitSharingTransactionsAmountsResult {
|
||||||
|
// 参数
|
||||||
|
params := gorequest.NewParams()
|
||||||
|
// 请求
|
||||||
|
request, err := c.request(ctx, apiUrl+"/v3/profitsharing/transactions/"+transactionId, params, http.MethodGet)
|
||||||
|
if err != nil {
|
||||||
|
return newProfitSharingTransactionsAmountsResult(ProfitSharingTransactionsAmountsResponse{}, request.ResponseBody, request, err, ApiError{})
|
||||||
|
}
|
||||||
|
// 定义
|
||||||
|
var response ProfitSharingTransactionsAmountsResponse
|
||||||
|
err = json.Unmarshal(request.ResponseBody, &response)
|
||||||
|
// 错误
|
||||||
|
var apiError ApiError
|
||||||
|
err = json.Unmarshal(request.ResponseBody, &apiError)
|
||||||
|
return newProfitSharingTransactionsAmountsResult(response, request.ResponseBody, request, err, apiError)
|
||||||
|
}
|
@ -0,0 +1,59 @@
|
|||||||
|
package wechatpayopen
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"github.com/gin-gonic/gin"
|
||||||
|
)
|
||||||
|
|
||||||
|
// RefundDomesticRefundsNoNotifyGinRequest 申请退款API - 回调通知 - 请求参数
|
||||||
|
type RefundDomesticRefundsNoNotifyGinRequest struct {
|
||||||
|
Id string `form:"id" json:"status" xml:"id" uri:"id" binding:"required"` // 通知ID
|
||||||
|
CreateTime string `form:"create_time" json:"create_time" xml:"create_time" uri:"create_time" binding:"required"` // 通知创建时间
|
||||||
|
EventType string `form:"event_type" json:"event_type" xml:"event_type" uri:"event_type" binding:"required"` // 通知类型
|
||||||
|
Summary string `form:"summary" json:"summary" xml:"summary" uri:"summary" binding:"required"` // 通知简要说明
|
||||||
|
ResourceType string `form:"resource_type" json:"resource_type" xml:"resource_type" uri:"resource_type" binding:"required"` // 通知数据类型
|
||||||
|
Resource struct {
|
||||||
|
Algorithm string `form:"algorithm" json:"algorithm" xml:"algorithm" uri:"algorithm" binding:"required"` // 加密算法类型
|
||||||
|
Ciphertext string `form:"ciphertext" json:"ciphertext" xml:"ciphertext" uri:"ciphertext" binding:"required"` // 数据密文
|
||||||
|
AssociatedData string `form:"associated_data" json:"associated_data" xml:"associated_data" uri:"associated_data" binding:"omitempty"` // 附加数据
|
||||||
|
OriginalType string `form:"original_type" json:"original_type" xml:"original_type" uri:"original_type" binding:"required"` // 原始类型
|
||||||
|
Nonce string `form:"nonce" json:"nonce" xml:"nonce" uri:"nonce" binding:"required"` // 随机串
|
||||||
|
} `form:"resource" json:"resource" xml:"resource" uri:"resource" binding:"required"` // 通知数据
|
||||||
|
}
|
||||||
|
|
||||||
|
// RefundDomesticRefundsNoNotifyGin 申请退款API - 回调通知
|
||||||
|
// https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter4_1_11.shtml
|
||||||
|
func (c *Client) RefundDomesticRefundsNoNotifyGin(ctx context.Context, ginCtx *gin.Context) (validateJson RefundDomesticRefundsNoNotifyGinRequest, response RefundDomesticRefundsNoNotifyGinResponse, gcm []byte, err error) {
|
||||||
|
|
||||||
|
// 解析
|
||||||
|
err = ginCtx.ShouldBind(&validateJson)
|
||||||
|
|
||||||
|
gcm, err = c.decryptGCM(c.GetApiV3(), validateJson.Resource.Nonce, validateJson.Resource.Ciphertext, validateJson.Resource.AssociatedData)
|
||||||
|
if err != nil {
|
||||||
|
return validateJson, response, gcm, err
|
||||||
|
}
|
||||||
|
|
||||||
|
err = json.Unmarshal(gcm, &response)
|
||||||
|
|
||||||
|
return validateJson, response, gcm, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// RefundDomesticRefundsNoNotifyGinResponse 申请退款API - 回调通知 - 解密后数据
|
||||||
|
type RefundDomesticRefundsNoNotifyGinResponse struct {
|
||||||
|
SpMchid string `json:"sp_mchid"` // 服务商户号
|
||||||
|
SubMchid string `json:"sub_mchid"` // 子商户号
|
||||||
|
OutTradeNo string `json:"out_trade_no"` // 商户订单号
|
||||||
|
TransactionId string `json:"transaction_id"` // 微信支付订单号
|
||||||
|
OutRefundNo string `json:"out_refund_no"` // 商户退款单号
|
||||||
|
RefundId string `json:"refund_id"` // 微信支付退款单号
|
||||||
|
RefundStatus string `json:"refund_status"` // 退款状态
|
||||||
|
SuccessTime string `json:"success_time"` // 退款成功时间
|
||||||
|
UserReceivedAccount string `json:"user_received_account"` // 退款入账账户
|
||||||
|
Amount struct {
|
||||||
|
Total int `json:"total"` // 订单金额
|
||||||
|
Refund int `json:"refund"` // 退款金额
|
||||||
|
PayerTotal int `json:"payer_total"` // 用户支付金额
|
||||||
|
PayerRefund int `json:"payer_refund"` // 用户退款金额
|
||||||
|
} `json:"amount"` // 金额信息
|
||||||
|
}
|
@ -0,0 +1,50 @@
|
|||||||
|
package wechatpayopen
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"go.dtapp.net/gorequest"
|
||||||
|
)
|
||||||
|
|
||||||
|
func (c *Client) request(ctx context.Context, url string, params map[string]interface{}, method string) (gorequest.Response, error) {
|
||||||
|
|
||||||
|
// 认证
|
||||||
|
authorization, err := c.authorization(method, params, url)
|
||||||
|
if err != nil {
|
||||||
|
return gorequest.Response{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// 创建请求
|
||||||
|
client := c.requestClient
|
||||||
|
|
||||||
|
// 设置请求地址
|
||||||
|
client.SetUri(url)
|
||||||
|
|
||||||
|
// 设置方式
|
||||||
|
client.SetMethod(method)
|
||||||
|
|
||||||
|
// 设置JSON格式
|
||||||
|
client.SetContentTypeJson()
|
||||||
|
|
||||||
|
// 设置参数
|
||||||
|
client.SetParams(params)
|
||||||
|
|
||||||
|
// 设置用户代理
|
||||||
|
client.SetUserAgent(gorequest.GetRandomUserAgentSystem())
|
||||||
|
|
||||||
|
// 设置头部
|
||||||
|
client.SetHeader("Authorization", authorization)
|
||||||
|
client.SetHeader("Accept", "application/json")
|
||||||
|
client.SetHeader("Accept-Language", "zh-CN")
|
||||||
|
|
||||||
|
// 发起请求
|
||||||
|
request, err := client.Request(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return gorequest.Response{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// 记录日志
|
||||||
|
if c.log.status {
|
||||||
|
go c.log.client.Middleware(ctx, request, Version)
|
||||||
|
}
|
||||||
|
return request, err
|
||||||
|
}
|
@ -0,0 +1,8 @@
|
|||||||
|
package wechatpayopen
|
||||||
|
|
||||||
|
// SubConfig 子商户配置
|
||||||
|
func (c *Client) SubConfig(subAppid, subMchId string) *Client {
|
||||||
|
c.config.subAppid = subAppid
|
||||||
|
c.config.subMchId = subMchId
|
||||||
|
return c
|
||||||
|
}
|
@ -0,0 +1,5 @@
|
|||||||
|
package wechatpayopen
|
||||||
|
|
||||||
|
func (c *Client) SignDecrypt(aesKey, associatedData, nonce, ciphertext string) ([]byte, error) {
|
||||||
|
return c.decryptGCM(aesKey, nonce, ciphertext, associatedData)
|
||||||
|
}
|
@ -1,9 +0,0 @@
|
|||||||
.DS_Store
|
|
||||||
.DS_Store?
|
|
||||||
._*
|
|
||||||
.Spotlight-V100
|
|
||||||
.Trashes
|
|
||||||
Icon?
|
|
||||||
ehthumbs.db
|
|
||||||
Thumbs.db
|
|
||||||
.idea
|
|
@ -1,117 +0,0 @@
|
|||||||
# This is the official list of Go-MySQL-Driver authors for copyright purposes.
|
|
||||||
|
|
||||||
# If you are submitting a patch, please add your name or the name of the
|
|
||||||
# organization which holds the copyright to this list in alphabetical order.
|
|
||||||
|
|
||||||
# Names should be added to this file as
|
|
||||||
# Name <email address>
|
|
||||||
# The email address is not required for organizations.
|
|
||||||
# Please keep the list sorted.
|
|
||||||
|
|
||||||
|
|
||||||
# Individual Persons
|
|
||||||
|
|
||||||
Aaron Hopkins <go-sql-driver at die.net>
|
|
||||||
Achille Roussel <achille.roussel at gmail.com>
|
|
||||||
Alex Snast <alexsn at fb.com>
|
|
||||||
Alexey Palazhchenko <alexey.palazhchenko at gmail.com>
|
|
||||||
Andrew Reid <andrew.reid at tixtrack.com>
|
|
||||||
Animesh Ray <mail.rayanimesh at gmail.com>
|
|
||||||
Arne Hormann <arnehormann at gmail.com>
|
|
||||||
Ariel Mashraki <ariel at mashraki.co.il>
|
|
||||||
Asta Xie <xiemengjun at gmail.com>
|
|
||||||
Bulat Gaifullin <gaifullinbf at gmail.com>
|
|
||||||
Caine Jette <jette at alum.mit.edu>
|
|
||||||
Carlos Nieto <jose.carlos at menteslibres.net>
|
|
||||||
Chris Moos <chris at tech9computers.com>
|
|
||||||
Craig Wilson <craiggwilson at gmail.com>
|
|
||||||
Daniel Montoya <dsmontoyam at gmail.com>
|
|
||||||
Daniel Nichter <nil at codenode.com>
|
|
||||||
Daniël van Eeden <git at myname.nl>
|
|
||||||
Dave Protasowski <dprotaso at gmail.com>
|
|
||||||
DisposaBoy <disposaboy at dby.me>
|
|
||||||
Egor Smolyakov <egorsmkv at gmail.com>
|
|
||||||
Erwan Martin <hello at erwan.io>
|
|
||||||
Evan Shaw <evan at vendhq.com>
|
|
||||||
Frederick Mayle <frederickmayle at gmail.com>
|
|
||||||
Gustavo Kristic <gkristic at gmail.com>
|
|
||||||
Hajime Nakagami <nakagami at gmail.com>
|
|
||||||
Hanno Braun <mail at hannobraun.com>
|
|
||||||
Henri Yandell <flamefew at gmail.com>
|
|
||||||
Hirotaka Yamamoto <ymmt2005 at gmail.com>
|
|
||||||
Huyiguang <hyg at webterren.com>
|
|
||||||
ICHINOSE Shogo <shogo82148 at gmail.com>
|
|
||||||
Ilia Cimpoes <ichimpoesh at gmail.com>
|
|
||||||
INADA Naoki <songofacandy at gmail.com>
|
|
||||||
Jacek Szwec <szwec.jacek at gmail.com>
|
|
||||||
James Harr <james.harr at gmail.com>
|
|
||||||
Jeff Hodges <jeff at somethingsimilar.com>
|
|
||||||
Jeffrey Charles <jeffreycharles at gmail.com>
|
|
||||||
Jerome Meyer <jxmeyer at gmail.com>
|
|
||||||
Jiajia Zhong <zhong2plus at gmail.com>
|
|
||||||
Jian Zhen <zhenjl at gmail.com>
|
|
||||||
Joshua Prunier <joshua.prunier at gmail.com>
|
|
||||||
Julien Lefevre <julien.lefevr at gmail.com>
|
|
||||||
Julien Schmidt <go-sql-driver at julienschmidt.com>
|
|
||||||
Justin Li <jli at j-li.net>
|
|
||||||
Justin Nuß <nuss.justin at gmail.com>
|
|
||||||
Kamil Dziedzic <kamil at klecza.pl>
|
|
||||||
Kei Kamikawa <x00.x7f.x86 at gmail.com>
|
|
||||||
Kevin Malachowski <kevin at chowski.com>
|
|
||||||
Kieron Woodhouse <kieron.woodhouse at infosum.com>
|
|
||||||
Lennart Rudolph <lrudolph at hmc.edu>
|
|
||||||
Leonardo YongUk Kim <dalinaum at gmail.com>
|
|
||||||
Linh Tran Tuan <linhduonggnu at gmail.com>
|
|
||||||
Lion Yang <lion at aosc.xyz>
|
|
||||||
Luca Looz <luca.looz92 at gmail.com>
|
|
||||||
Lucas Liu <extrafliu at gmail.com>
|
|
||||||
Luke Scott <luke at webconnex.com>
|
|
||||||
Maciej Zimnoch <maciej.zimnoch at codilime.com>
|
|
||||||
Michael Woolnough <michael.woolnough at gmail.com>
|
|
||||||
Nathanial Murphy <nathanial.murphy at gmail.com>
|
|
||||||
Nicola Peduzzi <thenikso at gmail.com>
|
|
||||||
Olivier Mengué <dolmen at cpan.org>
|
|
||||||
oscarzhao <oscarzhaosl at gmail.com>
|
|
||||||
Paul Bonser <misterpib at gmail.com>
|
|
||||||
Peter Schultz <peter.schultz at classmarkets.com>
|
|
||||||
Rebecca Chin <rchin at pivotal.io>
|
|
||||||
Reed Allman <rdallman10 at gmail.com>
|
|
||||||
Richard Wilkes <wilkes at me.com>
|
|
||||||
Robert Russell <robert at rrbrussell.com>
|
|
||||||
Runrioter Wung <runrioter at gmail.com>
|
|
||||||
Sho Iizuka <sho.i518 at gmail.com>
|
|
||||||
Sho Ikeda <suicaicoca at gmail.com>
|
|
||||||
Shuode Li <elemount at qq.com>
|
|
||||||
Simon J Mudd <sjmudd at pobox.com>
|
|
||||||
Soroush Pour <me at soroushjp.com>
|
|
||||||
Stan Putrya <root.vagner at gmail.com>
|
|
||||||
Stanley Gunawan <gunawan.stanley at gmail.com>
|
|
||||||
Steven Hartland <steven.hartland at multiplay.co.uk>
|
|
||||||
Tan Jinhua <312841925 at qq.com>
|
|
||||||
Thomas Wodarek <wodarekwebpage at gmail.com>
|
|
||||||
Tim Ruffles <timruffles at gmail.com>
|
|
||||||
Tom Jenkinson <tom at tjenkinson.me>
|
|
||||||
Vladimir Kovpak <cn007b at gmail.com>
|
|
||||||
Vladyslav Zhelezniak <zhvladi at gmail.com>
|
|
||||||
Xiangyu Hu <xiangyu.hu at outlook.com>
|
|
||||||
Xiaobing Jiang <s7v7nislands at gmail.com>
|
|
||||||
Xiuming Chen <cc at cxm.cc>
|
|
||||||
Xuehong Chan <chanxuehong at gmail.com>
|
|
||||||
Zhenye Xie <xiezhenye at gmail.com>
|
|
||||||
Zhixin Wen <john.wenzhixin at gmail.com>
|
|
||||||
|
|
||||||
# Organizations
|
|
||||||
|
|
||||||
Barracuda Networks, Inc.
|
|
||||||
Counting Ltd.
|
|
||||||
DigitalOcean Inc.
|
|
||||||
Facebook Inc.
|
|
||||||
GitHub Inc.
|
|
||||||
Google Inc.
|
|
||||||
InfoSum Ltd.
|
|
||||||
Keybase Inc.
|
|
||||||
Multiplay Ltd.
|
|
||||||
Percona LLC
|
|
||||||
Pivotal Inc.
|
|
||||||
Stripe Inc.
|
|
||||||
Zendesk Inc.
|
|
@ -1,232 +0,0 @@
|
|||||||
## Version 1.6 (2021-04-01)
|
|
||||||
|
|
||||||
Changes:
|
|
||||||
|
|
||||||
- Migrate the CI service from travis-ci to GitHub Actions (#1176, #1183, #1190)
|
|
||||||
- `NullTime` is deprecated (#960, #1144)
|
|
||||||
- Reduce allocations when building SET command (#1111)
|
|
||||||
- Performance improvement for time formatting (#1118)
|
|
||||||
- Performance improvement for time parsing (#1098, #1113)
|
|
||||||
|
|
||||||
New Features:
|
|
||||||
|
|
||||||
- Implement `driver.Validator` interface (#1106, #1174)
|
|
||||||
- Support returning `uint64` from `Valuer` in `ConvertValue` (#1143)
|
|
||||||
- Add `json.RawMessage` for converter and prepared statement (#1059)
|
|
||||||
- Interpolate `json.RawMessage` as `string` (#1058)
|
|
||||||
- Implements `CheckNamedValue` (#1090)
|
|
||||||
|
|
||||||
Bugfixes:
|
|
||||||
|
|
||||||
- Stop rounding times (#1121, #1172)
|
|
||||||
- Put zero filler into the SSL handshake packet (#1066)
|
|
||||||
- Fix checking cancelled connections back into the connection pool (#1095)
|
|
||||||
- Fix remove last 0 byte for mysql_old_password when password is empty (#1133)
|
|
||||||
|
|
||||||
|
|
||||||
## Version 1.5 (2020-01-07)
|
|
||||||
|
|
||||||
Changes:
|
|
||||||
|
|
||||||
- Dropped support Go 1.9 and lower (#823, #829, #886, #1016, #1017)
|
|
||||||
- Improve buffer handling (#890)
|
|
||||||
- Document potentially insecure TLS configs (#901)
|
|
||||||
- Use a double-buffering scheme to prevent data races (#943)
|
|
||||||
- Pass uint64 values without converting them to string (#838, #955)
|
|
||||||
- Update collations and make utf8mb4 default (#877, #1054)
|
|
||||||
- Make NullTime compatible with sql.NullTime in Go 1.13+ (#995)
|
|
||||||
- Removed CloudSQL support (#993, #1007)
|
|
||||||
- Add Go Module support (#1003)
|
|
||||||
|
|
||||||
New Features:
|
|
||||||
|
|
||||||
- Implement support of optional TLS (#900)
|
|
||||||
- Check connection liveness (#934, #964, #997, #1048, #1051, #1052)
|
|
||||||
- Implement Connector Interface (#941, #958, #1020, #1035)
|
|
||||||
|
|
||||||
Bugfixes:
|
|
||||||
|
|
||||||
- Mark connections as bad on error during ping (#875)
|
|
||||||
- Mark connections as bad on error during dial (#867)
|
|
||||||
- Fix connection leak caused by rapid context cancellation (#1024)
|
|
||||||
- Mark connections as bad on error during Conn.Prepare (#1030)
|
|
||||||
|
|
||||||
|
|
||||||
## Version 1.4.1 (2018-11-14)
|
|
||||||
|
|
||||||
Bugfixes:
|
|
||||||
|
|
||||||
- Fix TIME format for binary columns (#818)
|
|
||||||
- Fix handling of empty auth plugin names (#835)
|
|
||||||
- Fix caching_sha2_password with empty password (#826)
|
|
||||||
- Fix canceled context broke mysqlConn (#862)
|
|
||||||
- Fix OldAuthSwitchRequest support (#870)
|
|
||||||
- Fix Auth Response packet for cleartext password (#887)
|
|
||||||
|
|
||||||
## Version 1.4 (2018-06-03)
|
|
||||||
|
|
||||||
Changes:
|
|
||||||
|
|
||||||
- Documentation fixes (#530, #535, #567)
|
|
||||||
- Refactoring (#575, #579, #580, #581, #603, #615, #704)
|
|
||||||
- Cache column names (#444)
|
|
||||||
- Sort the DSN parameters in DSNs generated from a config (#637)
|
|
||||||
- Allow native password authentication by default (#644)
|
|
||||||
- Use the default port if it is missing in the DSN (#668)
|
|
||||||
- Removed the `strict` mode (#676)
|
|
||||||
- Do not query `max_allowed_packet` by default (#680)
|
|
||||||
- Dropped support Go 1.6 and lower (#696)
|
|
||||||
- Updated `ConvertValue()` to match the database/sql/driver implementation (#760)
|
|
||||||
- Document the usage of `0000-00-00T00:00:00` as the time.Time zero value (#783)
|
|
||||||
- Improved the compatibility of the authentication system (#807)
|
|
||||||
|
|
||||||
New Features:
|
|
||||||
|
|
||||||
- Multi-Results support (#537)
|
|
||||||
- `rejectReadOnly` DSN option (#604)
|
|
||||||
- `context.Context` support (#608, #612, #627, #761)
|
|
||||||
- Transaction isolation level support (#619, #744)
|
|
||||||
- Read-Only transactions support (#618, #634)
|
|
||||||
- `NewConfig` function which initializes a config with default values (#679)
|
|
||||||
- Implemented the `ColumnType` interfaces (#667, #724)
|
|
||||||
- Support for custom string types in `ConvertValue` (#623)
|
|
||||||
- Implemented `NamedValueChecker`, improving support for uint64 with high bit set (#690, #709, #710)
|
|
||||||
- `caching_sha2_password` authentication plugin support (#794, #800, #801, #802)
|
|
||||||
- Implemented `driver.SessionResetter` (#779)
|
|
||||||
- `sha256_password` authentication plugin support (#808)
|
|
||||||
|
|
||||||
Bugfixes:
|
|
||||||
|
|
||||||
- Use the DSN hostname as TLS default ServerName if `tls=true` (#564, #718)
|
|
||||||
- Fixed LOAD LOCAL DATA INFILE for empty files (#590)
|
|
||||||
- Removed columns definition cache since it sometimes cached invalid data (#592)
|
|
||||||
- Don't mutate registered TLS configs (#600)
|
|
||||||
- Make RegisterTLSConfig concurrency-safe (#613)
|
|
||||||
- Handle missing auth data in the handshake packet correctly (#646)
|
|
||||||
- Do not retry queries when data was written to avoid data corruption (#302, #736)
|
|
||||||
- Cache the connection pointer for error handling before invalidating it (#678)
|
|
||||||
- Fixed imports for appengine/cloudsql (#700)
|
|
||||||
- Fix sending STMT_LONG_DATA for 0 byte data (#734)
|
|
||||||
- Set correct capacity for []bytes read from length-encoded strings (#766)
|
|
||||||
- Make RegisterDial concurrency-safe (#773)
|
|
||||||
|
|
||||||
|
|
||||||
## Version 1.3 (2016-12-01)
|
|
||||||
|
|
||||||
Changes:
|
|
||||||
|
|
||||||
- Go 1.1 is no longer supported
|
|
||||||
- Use decimals fields in MySQL to format time types (#249)
|
|
||||||
- Buffer optimizations (#269)
|
|
||||||
- TLS ServerName defaults to the host (#283)
|
|
||||||
- Refactoring (#400, #410, #437)
|
|
||||||
- Adjusted documentation for second generation CloudSQL (#485)
|
|
||||||
- Documented DSN system var quoting rules (#502)
|
|
||||||
- Made statement.Close() calls idempotent to avoid errors in Go 1.6+ (#512)
|
|
||||||
|
|
||||||
New Features:
|
|
||||||
|
|
||||||
- Enable microsecond resolution on TIME, DATETIME and TIMESTAMP (#249)
|
|
||||||
- Support for returning table alias on Columns() (#289, #359, #382)
|
|
||||||
- Placeholder interpolation, can be actived with the DSN parameter `interpolateParams=true` (#309, #318, #490)
|
|
||||||
- Support for uint64 parameters with high bit set (#332, #345)
|
|
||||||
- Cleartext authentication plugin support (#327)
|
|
||||||
- Exported ParseDSN function and the Config struct (#403, #419, #429)
|
|
||||||
- Read / Write timeouts (#401)
|
|
||||||
- Support for JSON field type (#414)
|
|
||||||
- Support for multi-statements and multi-results (#411, #431)
|
|
||||||
- DSN parameter to set the driver-side max_allowed_packet value manually (#489)
|
|
||||||
- Native password authentication plugin support (#494, #524)
|
|
||||||
|
|
||||||
Bugfixes:
|
|
||||||
|
|
||||||
- Fixed handling of queries without columns and rows (#255)
|
|
||||||
- Fixed a panic when SetKeepAlive() failed (#298)
|
|
||||||
- Handle ERR packets while reading rows (#321)
|
|
||||||
- Fixed reading NULL length-encoded integers in MySQL 5.6+ (#349)
|
|
||||||
- Fixed absolute paths support in LOAD LOCAL DATA INFILE (#356)
|
|
||||||
- Actually zero out bytes in handshake response (#378)
|
|
||||||
- Fixed race condition in registering LOAD DATA INFILE handler (#383)
|
|
||||||
- Fixed tests with MySQL 5.7.9+ (#380)
|
|
||||||
- QueryUnescape TLS config names (#397)
|
|
||||||
- Fixed "broken pipe" error by writing to closed socket (#390)
|
|
||||||
- Fixed LOAD LOCAL DATA INFILE buffering (#424)
|
|
||||||
- Fixed parsing of floats into float64 when placeholders are used (#434)
|
|
||||||
- Fixed DSN tests with Go 1.7+ (#459)
|
|
||||||
- Handle ERR packets while waiting for EOF (#473)
|
|
||||||
- Invalidate connection on error while discarding additional results (#513)
|
|
||||||
- Allow terminating packets of length 0 (#516)
|
|
||||||
|
|
||||||
|
|
||||||
## Version 1.2 (2014-06-03)
|
|
||||||
|
|
||||||
Changes:
|
|
||||||
|
|
||||||
- We switched back to a "rolling release". `go get` installs the current master branch again
|
|
||||||
- Version v1 of the driver will not be maintained anymore. Go 1.0 is no longer supported by this driver
|
|
||||||
- Exported errors to allow easy checking from application code
|
|
||||||
- Enabled TCP Keepalives on TCP connections
|
|
||||||
- Optimized INFILE handling (better buffer size calculation, lazy init, ...)
|
|
||||||
- The DSN parser also checks for a missing separating slash
|
|
||||||
- Faster binary date / datetime to string formatting
|
|
||||||
- Also exported the MySQLWarning type
|
|
||||||
- mysqlConn.Close returns the first error encountered instead of ignoring all errors
|
|
||||||
- writePacket() automatically writes the packet size to the header
|
|
||||||
- readPacket() uses an iterative approach instead of the recursive approach to merge splitted packets
|
|
||||||
|
|
||||||
New Features:
|
|
||||||
|
|
||||||
- `RegisterDial` allows the usage of a custom dial function to establish the network connection
|
|
||||||
- Setting the connection collation is possible with the `collation` DSN parameter. This parameter should be preferred over the `charset` parameter
|
|
||||||
- Logging of critical errors is configurable with `SetLogger`
|
|
||||||
- Google CloudSQL support
|
|
||||||
|
|
||||||
Bugfixes:
|
|
||||||
|
|
||||||
- Allow more than 32 parameters in prepared statements
|
|
||||||
- Various old_password fixes
|
|
||||||
- Fixed TestConcurrent test to pass Go's race detection
|
|
||||||
- Fixed appendLengthEncodedInteger for large numbers
|
|
||||||
- Renamed readLengthEnodedString to readLengthEncodedString and skipLengthEnodedString to skipLengthEncodedString (fixed typo)
|
|
||||||
|
|
||||||
|
|
||||||
## Version 1.1 (2013-11-02)
|
|
||||||
|
|
||||||
Changes:
|
|
||||||
|
|
||||||
- Go-MySQL-Driver now requires Go 1.1
|
|
||||||
- Connections now use the collation `utf8_general_ci` by default. Adding `&charset=UTF8` to the DSN should not be necessary anymore
|
|
||||||
- Made closing rows and connections error tolerant. This allows for example deferring rows.Close() without checking for errors
|
|
||||||
- `[]byte(nil)` is now treated as a NULL value. Before, it was treated like an empty string / `[]byte("")`
|
|
||||||
- DSN parameter values must now be url.QueryEscape'ed. This allows text values to contain special characters, such as '&'.
|
|
||||||
- Use the IO buffer also for writing. This results in zero allocations (by the driver) for most queries
|
|
||||||
- Optimized the buffer for reading
|
|
||||||
- stmt.Query now caches column metadata
|
|
||||||
- New Logo
|
|
||||||
- Changed the copyright header to include all contributors
|
|
||||||
- Improved the LOAD INFILE documentation
|
|
||||||
- The driver struct is now exported to make the driver directly accessible
|
|
||||||
- Refactored the driver tests
|
|
||||||
- Added more benchmarks and moved all to a separate file
|
|
||||||
- Other small refactoring
|
|
||||||
|
|
||||||
New Features:
|
|
||||||
|
|
||||||
- Added *old_passwords* support: Required in some cases, but must be enabled by adding `allowOldPasswords=true` to the DSN since it is insecure
|
|
||||||
- Added a `clientFoundRows` parameter: Return the number of matching rows instead of the number of rows changed on UPDATEs
|
|
||||||
- Added TLS/SSL support: Use a TLS/SSL encrypted connection to the server. Custom TLS configs can be registered and used
|
|
||||||
|
|
||||||
Bugfixes:
|
|
||||||
|
|
||||||
- Fixed MySQL 4.1 support: MySQL 4.1 sends packets with lengths which differ from the specification
|
|
||||||
- Convert to DB timezone when inserting `time.Time`
|
|
||||||
- Splitted packets (more than 16MB) are now merged correctly
|
|
||||||
- Fixed false positive `io.EOF` errors when the data was fully read
|
|
||||||
- Avoid panics on reuse of closed connections
|
|
||||||
- Fixed empty string producing false nil values
|
|
||||||
- Fixed sign byte for positive TIME fields
|
|
||||||
|
|
||||||
|
|
||||||
## Version 1.0 (2013-05-14)
|
|
||||||
|
|
||||||
Initial Release
|
|
@ -1,373 +0,0 @@
|
|||||||
Mozilla Public License Version 2.0
|
|
||||||
==================================
|
|
||||||
|
|
||||||
1. Definitions
|
|
||||||
--------------
|
|
||||||
|
|
||||||
1.1. "Contributor"
|
|
||||||
means each individual or legal entity that creates, contributes to
|
|
||||||
the creation of, or owns Covered Software.
|
|
||||||
|
|
||||||
1.2. "Contributor Version"
|
|
||||||
means the combination of the Contributions of others (if any) used
|
|
||||||
by a Contributor and that particular Contributor's Contribution.
|
|
||||||
|
|
||||||
1.3. "Contribution"
|
|
||||||
means Covered Software of a particular Contributor.
|
|
||||||
|
|
||||||
1.4. "Covered Software"
|
|
||||||
means Source Code Form to which the initial Contributor has attached
|
|
||||||
the notice in Exhibit A, the Executable Form of such Source Code
|
|
||||||
Form, and Modifications of such Source Code Form, in each case
|
|
||||||
including portions thereof.
|
|
||||||
|
|
||||||
1.5. "Incompatible With Secondary Licenses"
|
|
||||||
means
|
|
||||||
|
|
||||||
(a) that the initial Contributor has attached the notice described
|
|
||||||
in Exhibit B to the Covered Software; or
|
|
||||||
|
|
||||||
(b) that the Covered Software was made available under the terms of
|
|
||||||
version 1.1 or earlier of the License, but not also under the
|
|
||||||
terms of a Secondary License.
|
|
||||||
|
|
||||||
1.6. "Executable Form"
|
|
||||||
means any form of the work other than Source Code Form.
|
|
||||||
|
|
||||||
1.7. "Larger Work"
|
|
||||||
means a work that combines Covered Software with other material, in
|
|
||||||
a separate file or files, that is not Covered Software.
|
|
||||||
|
|
||||||
1.8. "License"
|
|
||||||
means this document.
|
|
||||||
|
|
||||||
1.9. "Licensable"
|
|
||||||
means having the right to grant, to the maximum extent possible,
|
|
||||||
whether at the time of the initial grant or subsequently, any and
|
|
||||||
all of the rights conveyed by this License.
|
|
||||||
|
|
||||||
1.10. "Modifications"
|
|
||||||
means any of the following:
|
|
||||||
|
|
||||||
(a) any file in Source Code Form that results from an addition to,
|
|
||||||
deletion from, or modification of the contents of Covered
|
|
||||||
Software; or
|
|
||||||
|
|
||||||
(b) any new file in Source Code Form that contains any Covered
|
|
||||||
Software.
|
|
||||||
|
|
||||||
1.11. "Patent Claims" of a Contributor
|
|
||||||
means any patent claim(s), including without limitation, method,
|
|
||||||
process, and apparatus claims, in any patent Licensable by such
|
|
||||||
Contributor that would be infringed, but for the grant of the
|
|
||||||
License, by the making, using, selling, offering for sale, having
|
|
||||||
made, import, or transfer of either its Contributions or its
|
|
||||||
Contributor Version.
|
|
||||||
|
|
||||||
1.12. "Secondary License"
|
|
||||||
means either the GNU General Public License, Version 2.0, the GNU
|
|
||||||
Lesser General Public License, Version 2.1, the GNU Affero General
|
|
||||||
Public License, Version 3.0, or any later versions of those
|
|
||||||
licenses.
|
|
||||||
|
|
||||||
1.13. "Source Code Form"
|
|
||||||
means the form of the work preferred for making modifications.
|
|
||||||
|
|
||||||
1.14. "You" (or "Your")
|
|
||||||
means an individual or a legal entity exercising rights under this
|
|
||||||
License. For legal entities, "You" includes any entity that
|
|
||||||
controls, is controlled by, or is under common control with You. For
|
|
||||||
purposes of this definition, "control" means (a) the power, direct
|
|
||||||
or indirect, to cause the direction or management of such entity,
|
|
||||||
whether by contract or otherwise, or (b) ownership of more than
|
|
||||||
fifty percent (50%) of the outstanding shares or beneficial
|
|
||||||
ownership of such entity.
|
|
||||||
|
|
||||||
2. License Grants and Conditions
|
|
||||||
--------------------------------
|
|
||||||
|
|
||||||
2.1. Grants
|
|
||||||
|
|
||||||
Each Contributor hereby grants You a world-wide, royalty-free,
|
|
||||||
non-exclusive license:
|
|
||||||
|
|
||||||
(a) under intellectual property rights (other than patent or trademark)
|
|
||||||
Licensable by such Contributor to use, reproduce, make available,
|
|
||||||
modify, display, perform, distribute, and otherwise exploit its
|
|
||||||
Contributions, either on an unmodified basis, with Modifications, or
|
|
||||||
as part of a Larger Work; and
|
|
||||||
|
|
||||||
(b) under Patent Claims of such Contributor to make, use, sell, offer
|
|
||||||
for sale, have made, import, and otherwise transfer either its
|
|
||||||
Contributions or its Contributor Version.
|
|
||||||
|
|
||||||
2.2. Effective Date
|
|
||||||
|
|
||||||
The licenses granted in Section 2.1 with respect to any Contribution
|
|
||||||
become effective for each Contribution on the date the Contributor first
|
|
||||||
distributes such Contribution.
|
|
||||||
|
|
||||||
2.3. Limitations on Grant Scope
|
|
||||||
|
|
||||||
The licenses granted in this Section 2 are the only rights granted under
|
|
||||||
this License. No additional rights or licenses will be implied from the
|
|
||||||
distribution or licensing of Covered Software under this License.
|
|
||||||
Notwithstanding Section 2.1(b) above, no patent license is granted by a
|
|
||||||
Contributor:
|
|
||||||
|
|
||||||
(a) for any code that a Contributor has removed from Covered Software;
|
|
||||||
or
|
|
||||||
|
|
||||||
(b) for infringements caused by: (i) Your and any other third party's
|
|
||||||
modifications of Covered Software, or (ii) the combination of its
|
|
||||||
Contributions with other software (except as part of its Contributor
|
|
||||||
Version); or
|
|
||||||
|
|
||||||
(c) under Patent Claims infringed by Covered Software in the absence of
|
|
||||||
its Contributions.
|
|
||||||
|
|
||||||
This License does not grant any rights in the trademarks, service marks,
|
|
||||||
or logos of any Contributor (except as may be necessary to comply with
|
|
||||||
the notice requirements in Section 3.4).
|
|
||||||
|
|
||||||
2.4. Subsequent Licenses
|
|
||||||
|
|
||||||
No Contributor makes additional grants as a result of Your choice to
|
|
||||||
distribute the Covered Software under a subsequent version of this
|
|
||||||
License (see Section 10.2) or under the terms of a Secondary License (if
|
|
||||||
permitted under the terms of Section 3.3).
|
|
||||||
|
|
||||||
2.5. Representation
|
|
||||||
|
|
||||||
Each Contributor represents that the Contributor believes its
|
|
||||||
Contributions are its original creation(s) or it has sufficient rights
|
|
||||||
to grant the rights to its Contributions conveyed by this License.
|
|
||||||
|
|
||||||
2.6. Fair Use
|
|
||||||
|
|
||||||
This License is not intended to limit any rights You have under
|
|
||||||
applicable copyright doctrines of fair use, fair dealing, or other
|
|
||||||
equivalents.
|
|
||||||
|
|
||||||
2.7. Conditions
|
|
||||||
|
|
||||||
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
|
|
||||||
in Section 2.1.
|
|
||||||
|
|
||||||
3. Responsibilities
|
|
||||||
-------------------
|
|
||||||
|
|
||||||
3.1. Distribution of Source Form
|
|
||||||
|
|
||||||
All distribution of Covered Software in Source Code Form, including any
|
|
||||||
Modifications that You create or to which You contribute, must be under
|
|
||||||
the terms of this License. You must inform recipients that the Source
|
|
||||||
Code Form of the Covered Software is governed by the terms of this
|
|
||||||
License, and how they can obtain a copy of this License. You may not
|
|
||||||
attempt to alter or restrict the recipients' rights in the Source Code
|
|
||||||
Form.
|
|
||||||
|
|
||||||
3.2. Distribution of Executable Form
|
|
||||||
|
|
||||||
If You distribute Covered Software in Executable Form then:
|
|
||||||
|
|
||||||
(a) such Covered Software must also be made available in Source Code
|
|
||||||
Form, as described in Section 3.1, and You must inform recipients of
|
|
||||||
the Executable Form how they can obtain a copy of such Source Code
|
|
||||||
Form by reasonable means in a timely manner, at a charge no more
|
|
||||||
than the cost of distribution to the recipient; and
|
|
||||||
|
|
||||||
(b) You may distribute such Executable Form under the terms of this
|
|
||||||
License, or sublicense it under different terms, provided that the
|
|
||||||
license for the Executable Form does not attempt to limit or alter
|
|
||||||
the recipients' rights in the Source Code Form under this License.
|
|
||||||
|
|
||||||
3.3. Distribution of a Larger Work
|
|
||||||
|
|
||||||
You may create and distribute a Larger Work under terms of Your choice,
|
|
||||||
provided that You also comply with the requirements of this License for
|
|
||||||
the Covered Software. If the Larger Work is a combination of Covered
|
|
||||||
Software with a work governed by one or more Secondary Licenses, and the
|
|
||||||
Covered Software is not Incompatible With Secondary Licenses, this
|
|
||||||
License permits You to additionally distribute such Covered Software
|
|
||||||
under the terms of such Secondary License(s), so that the recipient of
|
|
||||||
the Larger Work may, at their option, further distribute the Covered
|
|
||||||
Software under the terms of either this License or such Secondary
|
|
||||||
License(s).
|
|
||||||
|
|
||||||
3.4. Notices
|
|
||||||
|
|
||||||
You may not remove or alter the substance of any license notices
|
|
||||||
(including copyright notices, patent notices, disclaimers of warranty,
|
|
||||||
or limitations of liability) contained within the Source Code Form of
|
|
||||||
the Covered Software, except that You may alter any license notices to
|
|
||||||
the extent required to remedy known factual inaccuracies.
|
|
||||||
|
|
||||||
3.5. Application of Additional Terms
|
|
||||||
|
|
||||||
You may choose to offer, and to charge a fee for, warranty, support,
|
|
||||||
indemnity or liability obligations to one or more recipients of Covered
|
|
||||||
Software. However, You may do so only on Your own behalf, and not on
|
|
||||||
behalf of any Contributor. You must make it absolutely clear that any
|
|
||||||
such warranty, support, indemnity, or liability obligation is offered by
|
|
||||||
You alone, and You hereby agree to indemnify every Contributor for any
|
|
||||||
liability incurred by such Contributor as a result of warranty, support,
|
|
||||||
indemnity or liability terms You offer. You may include additional
|
|
||||||
disclaimers of warranty and limitations of liability specific to any
|
|
||||||
jurisdiction.
|
|
||||||
|
|
||||||
4. Inability to Comply Due to Statute or Regulation
|
|
||||||
---------------------------------------------------
|
|
||||||
|
|
||||||
If it is impossible for You to comply with any of the terms of this
|
|
||||||
License with respect to some or all of the Covered Software due to
|
|
||||||
statute, judicial order, or regulation then You must: (a) comply with
|
|
||||||
the terms of this License to the maximum extent possible; and (b)
|
|
||||||
describe the limitations and the code they affect. Such description must
|
|
||||||
be placed in a text file included with all distributions of the Covered
|
|
||||||
Software under this License. Except to the extent prohibited by statute
|
|
||||||
or regulation, such description must be sufficiently detailed for a
|
|
||||||
recipient of ordinary skill to be able to understand it.
|
|
||||||
|
|
||||||
5. Termination
|
|
||||||
--------------
|
|
||||||
|
|
||||||
5.1. The rights granted under this License will terminate automatically
|
|
||||||
if You fail to comply with any of its terms. However, if You become
|
|
||||||
compliant, then the rights granted under this License from a particular
|
|
||||||
Contributor are reinstated (a) provisionally, unless and until such
|
|
||||||
Contributor explicitly and finally terminates Your grants, and (b) on an
|
|
||||||
ongoing basis, if such Contributor fails to notify You of the
|
|
||||||
non-compliance by some reasonable means prior to 60 days after You have
|
|
||||||
come back into compliance. Moreover, Your grants from a particular
|
|
||||||
Contributor are reinstated on an ongoing basis if such Contributor
|
|
||||||
notifies You of the non-compliance by some reasonable means, this is the
|
|
||||||
first time You have received notice of non-compliance with this License
|
|
||||||
from such Contributor, and You become compliant prior to 30 days after
|
|
||||||
Your receipt of the notice.
|
|
||||||
|
|
||||||
5.2. If You initiate litigation against any entity by asserting a patent
|
|
||||||
infringement claim (excluding declaratory judgment actions,
|
|
||||||
counter-claims, and cross-claims) alleging that a Contributor Version
|
|
||||||
directly or indirectly infringes any patent, then the rights granted to
|
|
||||||
You by any and all Contributors for the Covered Software under Section
|
|
||||||
2.1 of this License shall terminate.
|
|
||||||
|
|
||||||
5.3. In the event of termination under Sections 5.1 or 5.2 above, all
|
|
||||||
end user license agreements (excluding distributors and resellers) which
|
|
||||||
have been validly granted by You or Your distributors under this License
|
|
||||||
prior to termination shall survive termination.
|
|
||||||
|
|
||||||
************************************************************************
|
|
||||||
* *
|
|
||||||
* 6. Disclaimer of Warranty *
|
|
||||||
* ------------------------- *
|
|
||||||
* *
|
|
||||||
* Covered Software is provided under this License on an "as is" *
|
|
||||||
* basis, without warranty of any kind, either expressed, implied, or *
|
|
||||||
* statutory, including, without limitation, warranties that the *
|
|
||||||
* Covered Software is free of defects, merchantable, fit for a *
|
|
||||||
* particular purpose or non-infringing. The entire risk as to the *
|
|
||||||
* quality and performance of the Covered Software is with You. *
|
|
||||||
* Should any Covered Software prove defective in any respect, You *
|
|
||||||
* (not any Contributor) assume the cost of any necessary servicing, *
|
|
||||||
* repair, or correction. This disclaimer of warranty constitutes an *
|
|
||||||
* essential part of this License. No use of any Covered Software is *
|
|
||||||
* authorized under this License except under this disclaimer. *
|
|
||||||
* *
|
|
||||||
************************************************************************
|
|
||||||
|
|
||||||
************************************************************************
|
|
||||||
* *
|
|
||||||
* 7. Limitation of Liability *
|
|
||||||
* -------------------------- *
|
|
||||||
* *
|
|
||||||
* Under no circumstances and under no legal theory, whether tort *
|
|
||||||
* (including negligence), contract, or otherwise, shall any *
|
|
||||||
* Contributor, or anyone who distributes Covered Software as *
|
|
||||||
* permitted above, be liable to You for any direct, indirect, *
|
|
||||||
* special, incidental, or consequential damages of any character *
|
|
||||||
* including, without limitation, damages for lost profits, loss of *
|
|
||||||
* goodwill, work stoppage, computer failure or malfunction, or any *
|
|
||||||
* and all other commercial damages or losses, even if such party *
|
|
||||||
* shall have been informed of the possibility of such damages. This *
|
|
||||||
* limitation of liability shall not apply to liability for death or *
|
|
||||||
* personal injury resulting from such party's negligence to the *
|
|
||||||
* extent applicable law prohibits such limitation. Some *
|
|
||||||
* jurisdictions do not allow the exclusion or limitation of *
|
|
||||||
* incidental or consequential damages, so this exclusion and *
|
|
||||||
* limitation may not apply to You. *
|
|
||||||
* *
|
|
||||||
************************************************************************
|
|
||||||
|
|
||||||
8. Litigation
|
|
||||||
-------------
|
|
||||||
|
|
||||||
Any litigation relating to this License may be brought only in the
|
|
||||||
courts of a jurisdiction where the defendant maintains its principal
|
|
||||||
place of business and such litigation shall be governed by laws of that
|
|
||||||
jurisdiction, without reference to its conflict-of-law provisions.
|
|
||||||
Nothing in this Section shall prevent a party's ability to bring
|
|
||||||
cross-claims or counter-claims.
|
|
||||||
|
|
||||||
9. Miscellaneous
|
|
||||||
----------------
|
|
||||||
|
|
||||||
This License represents the complete agreement concerning the subject
|
|
||||||
matter hereof. If any provision of this License is held to be
|
|
||||||
unenforceable, such provision shall be reformed only to the extent
|
|
||||||
necessary to make it enforceable. Any law or regulation which provides
|
|
||||||
that the language of a contract shall be construed against the drafter
|
|
||||||
shall not be used to construe this License against a Contributor.
|
|
||||||
|
|
||||||
10. Versions of the License
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
10.1. New Versions
|
|
||||||
|
|
||||||
Mozilla Foundation is the license steward. Except as provided in Section
|
|
||||||
10.3, no one other than the license steward has the right to modify or
|
|
||||||
publish new versions of this License. Each version will be given a
|
|
||||||
distinguishing version number.
|
|
||||||
|
|
||||||
10.2. Effect of New Versions
|
|
||||||
|
|
||||||
You may distribute the Covered Software under the terms of the version
|
|
||||||
of the License under which You originally received the Covered Software,
|
|
||||||
or under the terms of any subsequent version published by the license
|
|
||||||
steward.
|
|
||||||
|
|
||||||
10.3. Modified Versions
|
|
||||||
|
|
||||||
If you create software not governed by this License, and you want to
|
|
||||||
create a new license for such software, you may create and use a
|
|
||||||
modified version of this License if you rename the license and remove
|
|
||||||
any references to the name of the license steward (except to note that
|
|
||||||
such modified license differs from this License).
|
|
||||||
|
|
||||||
10.4. Distributing Source Code Form that is Incompatible With Secondary
|
|
||||||
Licenses
|
|
||||||
|
|
||||||
If You choose to distribute Source Code Form that is Incompatible With
|
|
||||||
Secondary Licenses under the terms of this version of the License, the
|
|
||||||
notice described in Exhibit B of this License must be attached.
|
|
||||||
|
|
||||||
Exhibit A - Source Code Form License Notice
|
|
||||||
-------------------------------------------
|
|
||||||
|
|
||||||
This Source Code Form is subject to the terms of the Mozilla Public
|
|
||||||
License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
||||||
file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
||||||
|
|
||||||
If it is not possible or desirable to put the notice in a particular
|
|
||||||
file, then You may include the notice in a location (such as a LICENSE
|
|
||||||
file in a relevant directory) where a recipient would be likely to look
|
|
||||||
for such a notice.
|
|
||||||
|
|
||||||
You may add additional accurate notices of copyright ownership.
|
|
||||||
|
|
||||||
Exhibit B - "Incompatible With Secondary Licenses" Notice
|
|
||||||
---------------------------------------------------------
|
|
||||||
|
|
||||||
This Source Code Form is "Incompatible With Secondary Licenses", as
|
|
||||||
defined by the Mozilla Public License, v. 2.0.
|
|
@ -1,520 +0,0 @@
|
|||||||
# Go-MySQL-Driver
|
|
||||||
|
|
||||||
A MySQL-Driver for Go's [database/sql](https://golang.org/pkg/database/sql/) package
|
|
||||||
|
|
||||||
![Go-MySQL-Driver logo](https://raw.github.com/wiki/go-sql-driver/mysql/gomysql_m.png "Golang Gopher holding the MySQL Dolphin")
|
|
||||||
|
|
||||||
---------------------------------------
|
|
||||||
* [Features](#features)
|
|
||||||
* [Requirements](#requirements)
|
|
||||||
* [Installation](#installation)
|
|
||||||
* [Usage](#usage)
|
|
||||||
* [DSN (Data Source Name)](#dsn-data-source-name)
|
|
||||||
* [Password](#password)
|
|
||||||
* [Protocol](#protocol)
|
|
||||||
* [Address](#address)
|
|
||||||
* [Parameters](#parameters)
|
|
||||||
* [Examples](#examples)
|
|
||||||
* [Connection pool and timeouts](#connection-pool-and-timeouts)
|
|
||||||
* [context.Context Support](#contextcontext-support)
|
|
||||||
* [ColumnType Support](#columntype-support)
|
|
||||||
* [LOAD DATA LOCAL INFILE support](#load-data-local-infile-support)
|
|
||||||
* [time.Time support](#timetime-support)
|
|
||||||
* [Unicode support](#unicode-support)
|
|
||||||
* [Testing / Development](#testing--development)
|
|
||||||
* [License](#license)
|
|
||||||
|
|
||||||
---------------------------------------
|
|
||||||
|
|
||||||
## Features
|
|
||||||
* Lightweight and [fast](https://github.com/go-sql-driver/sql-benchmark "golang MySQL-Driver performance")
|
|
||||||
* Native Go implementation. No C-bindings, just pure Go
|
|
||||||
* Connections over TCP/IPv4, TCP/IPv6, Unix domain sockets or [custom protocols](https://godoc.org/github.com/go-sql-driver/mysql#DialFunc)
|
|
||||||
* Automatic handling of broken connections
|
|
||||||
* Automatic Connection Pooling *(by database/sql package)*
|
|
||||||
* Supports queries larger than 16MB
|
|
||||||
* Full [`sql.RawBytes`](https://golang.org/pkg/database/sql/#RawBytes) support.
|
|
||||||
* Intelligent `LONG DATA` handling in prepared statements
|
|
||||||
* Secure `LOAD DATA LOCAL INFILE` support with file allowlisting and `io.Reader` support
|
|
||||||
* Optional `time.Time` parsing
|
|
||||||
* Optional placeholder interpolation
|
|
||||||
|
|
||||||
## Requirements
|
|
||||||
* Go 1.10 or higher. We aim to support the 3 latest versions of Go.
|
|
||||||
* MySQL (4.1+), MariaDB, Percona Server, Google CloudSQL or Sphinx (2.2.3+)
|
|
||||||
|
|
||||||
---------------------------------------
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
Simple install the package to your [$GOPATH](https://github.com/golang/go/wiki/GOPATH "GOPATH") with the [go tool](https://golang.org/cmd/go/ "go command") from shell:
|
|
||||||
```bash
|
|
||||||
$ go get -u github.com/go-sql-driver/mysql
|
|
||||||
```
|
|
||||||
Make sure [Git is installed](https://git-scm.com/downloads) on your machine and in your system's `PATH`.
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
_Go MySQL Driver_ is an implementation of Go's `database/sql/driver` interface. You only need to import the driver and can use the full [`database/sql`](https://golang.org/pkg/database/sql/) API then.
|
|
||||||
|
|
||||||
Use `mysql` as `driverName` and a valid [DSN](#dsn-data-source-name) as `dataSourceName`:
|
|
||||||
|
|
||||||
```go
|
|
||||||
import (
|
|
||||||
"database/sql"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
_ "github.com/go-sql-driver/mysql"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ...
|
|
||||||
|
|
||||||
db, err := sql.Open("mysql", "user:password@/dbname")
|
|
||||||
if err != nil {
|
|
||||||
panic(err)
|
|
||||||
}
|
|
||||||
// See "Important settings" section.
|
|
||||||
db.SetConnMaxLifetime(time.Minute * 3)
|
|
||||||
db.SetMaxOpenConns(10)
|
|
||||||
db.SetMaxIdleConns(10)
|
|
||||||
```
|
|
||||||
|
|
||||||
[Examples are available in our Wiki](https://github.com/go-sql-driver/mysql/wiki/Examples "Go-MySQL-Driver Examples").
|
|
||||||
|
|
||||||
### Important settings
|
|
||||||
|
|
||||||
`db.SetConnMaxLifetime()` is required to ensure connections are closed by the driver safely before connection is closed by MySQL server, OS, or other middlewares. Since some middlewares close idle connections by 5 minutes, we recommend timeout shorter than 5 minutes. This setting helps load balancing and changing system variables too.
|
|
||||||
|
|
||||||
`db.SetMaxOpenConns()` is highly recommended to limit the number of connection used by the application. There is no recommended limit number because it depends on application and MySQL server.
|
|
||||||
|
|
||||||
`db.SetMaxIdleConns()` is recommended to be set same to (or greater than) `db.SetMaxOpenConns()`. When it is smaller than `SetMaxOpenConns()`, connections can be opened and closed very frequently than you expect. Idle connections can be closed by the `db.SetConnMaxLifetime()`. If you want to close idle connections more rapidly, you can use `db.SetConnMaxIdleTime()` since Go 1.15.
|
|
||||||
|
|
||||||
|
|
||||||
### DSN (Data Source Name)
|
|
||||||
|
|
||||||
The Data Source Name has a common format, like e.g. [PEAR DB](http://pear.php.net/manual/en/package.database.db.intro-dsn.php) uses it, but without type-prefix (optional parts marked by squared brackets):
|
|
||||||
```
|
|
||||||
[username[:password]@][protocol[(address)]]/dbname[?param1=value1&...¶mN=valueN]
|
|
||||||
```
|
|
||||||
|
|
||||||
A DSN in its fullest form:
|
|
||||||
```
|
|
||||||
username:password@protocol(address)/dbname?param=value
|
|
||||||
```
|
|
||||||
|
|
||||||
Except for the databasename, all values are optional. So the minimal DSN is:
|
|
||||||
```
|
|
||||||
/dbname
|
|
||||||
```
|
|
||||||
|
|
||||||
If you do not want to preselect a database, leave `dbname` empty:
|
|
||||||
```
|
|
||||||
/
|
|
||||||
```
|
|
||||||
This has the same effect as an empty DSN string:
|
|
||||||
```
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
Alternatively, [Config.FormatDSN](https://godoc.org/github.com/go-sql-driver/mysql#Config.FormatDSN) can be used to create a DSN string by filling a struct.
|
|
||||||
|
|
||||||
#### Password
|
|
||||||
Passwords can consist of any character. Escaping is **not** necessary.
|
|
||||||
|
|
||||||
#### Protocol
|
|
||||||
See [net.Dial](https://golang.org/pkg/net/#Dial) for more information which networks are available.
|
|
||||||
In general you should use an Unix domain socket if available and TCP otherwise for best performance.
|
|
||||||
|
|
||||||
#### Address
|
|
||||||
For TCP and UDP networks, addresses have the form `host[:port]`.
|
|
||||||
If `port` is omitted, the default port will be used.
|
|
||||||
If `host` is a literal IPv6 address, it must be enclosed in square brackets.
|
|
||||||
The functions [net.JoinHostPort](https://golang.org/pkg/net/#JoinHostPort) and [net.SplitHostPort](https://golang.org/pkg/net/#SplitHostPort) manipulate addresses in this form.
|
|
||||||
|
|
||||||
For Unix domain sockets the address is the absolute path to the MySQL-Server-socket, e.g. `/var/run/mysqld/mysqld.sock` or `/tmp/mysql.sock`.
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
*Parameters are case-sensitive!*
|
|
||||||
|
|
||||||
Notice that any of `true`, `TRUE`, `True` or `1` is accepted to stand for a true boolean value. Not surprisingly, false can be specified as any of: `false`, `FALSE`, `False` or `0`.
|
|
||||||
|
|
||||||
##### `allowAllFiles`
|
|
||||||
|
|
||||||
```
|
|
||||||
Type: bool
|
|
||||||
Valid Values: true, false
|
|
||||||
Default: false
|
|
||||||
```
|
|
||||||
|
|
||||||
`allowAllFiles=true` disables the file allowlist for `LOAD DATA LOCAL INFILE` and allows *all* files.
|
|
||||||
[*Might be insecure!*](http://dev.mysql.com/doc/refman/5.7/en/load-data-local.html)
|
|
||||||
|
|
||||||
##### `allowCleartextPasswords`
|
|
||||||
|
|
||||||
```
|
|
||||||
Type: bool
|
|
||||||
Valid Values: true, false
|
|
||||||
Default: false
|
|
||||||
```
|
|
||||||
|
|
||||||
`allowCleartextPasswords=true` allows using the [cleartext client side plugin](https://dev.mysql.com/doc/en/cleartext-pluggable-authentication.html) if required by an account, such as one defined with the [PAM authentication plugin](http://dev.mysql.com/doc/en/pam-authentication-plugin.html). Sending passwords in clear text may be a security problem in some configurations. To avoid problems if there is any possibility that the password would be intercepted, clients should connect to MySQL Server using a method that protects the password. Possibilities include [TLS / SSL](#tls), IPsec, or a private network.
|
|
||||||
|
|
||||||
##### `allowNativePasswords`
|
|
||||||
|
|
||||||
```
|
|
||||||
Type: bool
|
|
||||||
Valid Values: true, false
|
|
||||||
Default: true
|
|
||||||
```
|
|
||||||
`allowNativePasswords=false` disallows the usage of MySQL native password method.
|
|
||||||
|
|
||||||
##### `allowOldPasswords`
|
|
||||||
|
|
||||||
```
|
|
||||||
Type: bool
|
|
||||||
Valid Values: true, false
|
|
||||||
Default: false
|
|
||||||
```
|
|
||||||
`allowOldPasswords=true` allows the usage of the insecure old password method. This should be avoided, but is necessary in some cases. See also [the old_passwords wiki page](https://github.com/go-sql-driver/mysql/wiki/old_passwords).
|
|
||||||
|
|
||||||
##### `charset`
|
|
||||||
|
|
||||||
```
|
|
||||||
Type: string
|
|
||||||
Valid Values: <name>
|
|
||||||
Default: none
|
|
||||||
```
|
|
||||||
|
|
||||||
Sets the charset used for client-server interaction (`"SET NAMES <value>"`). If multiple charsets are set (separated by a comma), the following charset is used if setting the charset failes. This enables for example support for `utf8mb4` ([introduced in MySQL 5.5.3](http://dev.mysql.com/doc/refman/5.5/en/charset-unicode-utf8mb4.html)) with fallback to `utf8` for older servers (`charset=utf8mb4,utf8`).
|
|
||||||
|
|
||||||
Usage of the `charset` parameter is discouraged because it issues additional queries to the server.
|
|
||||||
Unless you need the fallback behavior, please use `collation` instead.
|
|
||||||
|
|
||||||
##### `checkConnLiveness`
|
|
||||||
|
|
||||||
```
|
|
||||||
Type: bool
|
|
||||||
Valid Values: true, false
|
|
||||||
Default: true
|
|
||||||
```
|
|
||||||
|
|
||||||
On supported platforms connections retrieved from the connection pool are checked for liveness before using them. If the check fails, the respective connection is marked as bad and the query retried with another connection.
|
|
||||||
`checkConnLiveness=false` disables this liveness check of connections.
|
|
||||||
|
|
||||||
##### `collation`
|
|
||||||
|
|
||||||
```
|
|
||||||
Type: string
|
|
||||||
Valid Values: <name>
|
|
||||||
Default: utf8mb4_general_ci
|
|
||||||
```
|
|
||||||
|
|
||||||
Sets the collation used for client-server interaction on connection. In contrast to `charset`, `collation` does not issue additional queries. If the specified collation is unavailable on the target server, the connection will fail.
|
|
||||||
|
|
||||||
A list of valid charsets for a server is retrievable with `SHOW COLLATION`.
|
|
||||||
|
|
||||||
The default collation (`utf8mb4_general_ci`) is supported from MySQL 5.5. You should use an older collation (e.g. `utf8_general_ci`) for older MySQL.
|
|
||||||
|
|
||||||
Collations for charset "ucs2", "utf16", "utf16le", and "utf32" can not be used ([ref](https://dev.mysql.com/doc/refman/5.7/en/charset-connection.html#charset-connection-impermissible-client-charset)).
|
|
||||||
|
|
||||||
|
|
||||||
##### `clientFoundRows`
|
|
||||||
|
|
||||||
```
|
|
||||||
Type: bool
|
|
||||||
Valid Values: true, false
|
|
||||||
Default: false
|
|
||||||
```
|
|
||||||
|
|
||||||
`clientFoundRows=true` causes an UPDATE to return the number of matching rows instead of the number of rows changed.
|
|
||||||
|
|
||||||
##### `columnsWithAlias`
|
|
||||||
|
|
||||||
```
|
|
||||||
Type: bool
|
|
||||||
Valid Values: true, false
|
|
||||||
Default: false
|
|
||||||
```
|
|
||||||
|
|
||||||
When `columnsWithAlias` is true, calls to `sql.Rows.Columns()` will return the table alias and the column name separated by a dot. For example:
|
|
||||||
|
|
||||||
```
|
|
||||||
SELECT u.id FROM users as u
|
|
||||||
```
|
|
||||||
|
|
||||||
will return `u.id` instead of just `id` if `columnsWithAlias=true`.
|
|
||||||
|
|
||||||
##### `interpolateParams`
|
|
||||||
|
|
||||||
```
|
|
||||||
Type: bool
|
|
||||||
Valid Values: true, false
|
|
||||||
Default: false
|
|
||||||
```
|
|
||||||
|
|
||||||
If `interpolateParams` is true, placeholders (`?`) in calls to `db.Query()` and `db.Exec()` are interpolated into a single query string with given parameters. This reduces the number of roundtrips, since the driver has to prepare a statement, execute it with given parameters and close the statement again with `interpolateParams=false`.
|
|
||||||
|
|
||||||
*This can not be used together with the multibyte encodings BIG5, CP932, GB2312, GBK or SJIS. These are rejected as they may [introduce a SQL injection vulnerability](http://stackoverflow.com/a/12118602/3430118)!*
|
|
||||||
|
|
||||||
##### `loc`
|
|
||||||
|
|
||||||
```
|
|
||||||
Type: string
|
|
||||||
Valid Values: <escaped name>
|
|
||||||
Default: UTC
|
|
||||||
```
|
|
||||||
|
|
||||||
Sets the location for time.Time values (when using `parseTime=true`). *"Local"* sets the system's location. See [time.LoadLocation](https://golang.org/pkg/time/#LoadLocation) for details.
|
|
||||||
|
|
||||||
Note that this sets the location for time.Time values but does not change MySQL's [time_zone setting](https://dev.mysql.com/doc/refman/5.5/en/time-zone-support.html). For that see the [time_zone system variable](#system-variables), which can also be set as a DSN parameter.
|
|
||||||
|
|
||||||
Please keep in mind, that param values must be [url.QueryEscape](https://golang.org/pkg/net/url/#QueryEscape)'ed. Alternatively you can manually replace the `/` with `%2F`. For example `US/Pacific` would be `loc=US%2FPacific`.
|
|
||||||
|
|
||||||
##### `maxAllowedPacket`
|
|
||||||
```
|
|
||||||
Type: decimal number
|
|
||||||
Default: 4194304
|
|
||||||
```
|
|
||||||
|
|
||||||
Max packet size allowed in bytes. The default value is 4 MiB and should be adjusted to match the server settings. `maxAllowedPacket=0` can be used to automatically fetch the `max_allowed_packet` variable from server *on every connection*.
|
|
||||||
|
|
||||||
##### `multiStatements`
|
|
||||||
|
|
||||||
```
|
|
||||||
Type: bool
|
|
||||||
Valid Values: true, false
|
|
||||||
Default: false
|
|
||||||
```
|
|
||||||
|
|
||||||
Allow multiple statements in one query. While this allows batch queries, it also greatly increases the risk of SQL injections. Only the result of the first query is returned, all other results are silently discarded.
|
|
||||||
|
|
||||||
When `multiStatements` is used, `?` parameters must only be used in the first statement.
|
|
||||||
|
|
||||||
##### `parseTime`
|
|
||||||
|
|
||||||
```
|
|
||||||
Type: bool
|
|
||||||
Valid Values: true, false
|
|
||||||
Default: false
|
|
||||||
```
|
|
||||||
|
|
||||||
`parseTime=true` changes the output type of `DATE` and `DATETIME` values to `time.Time` instead of `[]byte` / `string`
|
|
||||||
The date or datetime like `0000-00-00 00:00:00` is converted into zero value of `time.Time`.
|
|
||||||
|
|
||||||
|
|
||||||
##### `readTimeout`
|
|
||||||
|
|
||||||
```
|
|
||||||
Type: duration
|
|
||||||
Default: 0
|
|
||||||
```
|
|
||||||
|
|
||||||
I/O read timeout. The value must be a decimal number with a unit suffix (*"ms"*, *"s"*, *"m"*, *"h"*), such as *"30s"*, *"0.5m"* or *"1m30s"*.
|
|
||||||
|
|
||||||
##### `rejectReadOnly`
|
|
||||||
|
|
||||||
```
|
|
||||||
Type: bool
|
|
||||||
Valid Values: true, false
|
|
||||||
Default: false
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
`rejectReadOnly=true` causes the driver to reject read-only connections. This
|
|
||||||
is for a possible race condition during an automatic failover, where the mysql
|
|
||||||
client gets connected to a read-only replica after the failover.
|
|
||||||
|
|
||||||
Note that this should be a fairly rare case, as an automatic failover normally
|
|
||||||
happens when the primary is down, and the race condition shouldn't happen
|
|
||||||
unless it comes back up online as soon as the failover is kicked off. On the
|
|
||||||
other hand, when this happens, a MySQL application can get stuck on a
|
|
||||||
read-only connection until restarted. It is however fairly easy to reproduce,
|
|
||||||
for example, using a manual failover on AWS Aurora's MySQL-compatible cluster.
|
|
||||||
|
|
||||||
If you are not relying on read-only transactions to reject writes that aren't
|
|
||||||
supposed to happen, setting this on some MySQL providers (such as AWS Aurora)
|
|
||||||
is safer for failovers.
|
|
||||||
|
|
||||||
Note that ERROR 1290 can be returned for a `read-only` server and this option will
|
|
||||||
cause a retry for that error. However the same error number is used for some
|
|
||||||
other cases. You should ensure your application will never cause an ERROR 1290
|
|
||||||
except for `read-only` mode when enabling this option.
|
|
||||||
|
|
||||||
|
|
||||||
##### `serverPubKey`
|
|
||||||
|
|
||||||
```
|
|
||||||
Type: string
|
|
||||||
Valid Values: <name>
|
|
||||||
Default: none
|
|
||||||
```
|
|
||||||
|
|
||||||
Server public keys can be registered with [`mysql.RegisterServerPubKey`](https://godoc.org/github.com/go-sql-driver/mysql#RegisterServerPubKey), which can then be used by the assigned name in the DSN.
|
|
||||||
Public keys are used to transmit encrypted data, e.g. for authentication.
|
|
||||||
If the server's public key is known, it should be set manually to avoid expensive and potentially insecure transmissions of the public key from the server to the client each time it is required.
|
|
||||||
|
|
||||||
|
|
||||||
##### `timeout`
|
|
||||||
|
|
||||||
```
|
|
||||||
Type: duration
|
|
||||||
Default: OS default
|
|
||||||
```
|
|
||||||
|
|
||||||
Timeout for establishing connections, aka dial timeout. The value must be a decimal number with a unit suffix (*"ms"*, *"s"*, *"m"*, *"h"*), such as *"30s"*, *"0.5m"* or *"1m30s"*.
|
|
||||||
|
|
||||||
|
|
||||||
##### `tls`
|
|
||||||
|
|
||||||
```
|
|
||||||
Type: bool / string
|
|
||||||
Valid Values: true, false, skip-verify, preferred, <name>
|
|
||||||
Default: false
|
|
||||||
```
|
|
||||||
|
|
||||||
`tls=true` enables TLS / SSL encrypted connection to the server. Use `skip-verify` if you want to use a self-signed or invalid certificate (server side) or use `preferred` to use TLS only when advertised by the server. This is similar to `skip-verify`, but additionally allows a fallback to a connection which is not encrypted. Neither `skip-verify` nor `preferred` add any reliable security. You can use a custom TLS config after registering it with [`mysql.RegisterTLSConfig`](https://godoc.org/github.com/go-sql-driver/mysql#RegisterTLSConfig).
|
|
||||||
|
|
||||||
|
|
||||||
##### `writeTimeout`
|
|
||||||
|
|
||||||
```
|
|
||||||
Type: duration
|
|
||||||
Default: 0
|
|
||||||
```
|
|
||||||
|
|
||||||
I/O write timeout. The value must be a decimal number with a unit suffix (*"ms"*, *"s"*, *"m"*, *"h"*), such as *"30s"*, *"0.5m"* or *"1m30s"*.
|
|
||||||
|
|
||||||
|
|
||||||
##### System Variables
|
|
||||||
|
|
||||||
Any other parameters are interpreted as system variables:
|
|
||||||
* `<boolean_var>=<value>`: `SET <boolean_var>=<value>`
|
|
||||||
* `<enum_var>=<value>`: `SET <enum_var>=<value>`
|
|
||||||
* `<string_var>=%27<value>%27`: `SET <string_var>='<value>'`
|
|
||||||
|
|
||||||
Rules:
|
|
||||||
* The values for string variables must be quoted with `'`.
|
|
||||||
* The values must also be [url.QueryEscape](http://golang.org/pkg/net/url/#QueryEscape)'ed!
|
|
||||||
(which implies values of string variables must be wrapped with `%27`).
|
|
||||||
|
|
||||||
Examples:
|
|
||||||
* `autocommit=1`: `SET autocommit=1`
|
|
||||||
* [`time_zone=%27Europe%2FParis%27`](https://dev.mysql.com/doc/refman/5.5/en/time-zone-support.html): `SET time_zone='Europe/Paris'`
|
|
||||||
* [`transaction_isolation=%27REPEATABLE-READ%27`](https://dev.mysql.com/doc/refman/5.7/en/server-system-variables.html#sysvar_transaction_isolation): `SET transaction_isolation='REPEATABLE-READ'`
|
|
||||||
|
|
||||||
|
|
||||||
#### Examples
|
|
||||||
```
|
|
||||||
user@unix(/path/to/socket)/dbname
|
|
||||||
```
|
|
||||||
|
|
||||||
```
|
|
||||||
root:pw@unix(/tmp/mysql.sock)/myDatabase?loc=Local
|
|
||||||
```
|
|
||||||
|
|
||||||
```
|
|
||||||
user:password@tcp(localhost:5555)/dbname?tls=skip-verify&autocommit=true
|
|
||||||
```
|
|
||||||
|
|
||||||
Treat warnings as errors by setting the system variable [`sql_mode`](https://dev.mysql.com/doc/refman/5.7/en/sql-mode.html):
|
|
||||||
```
|
|
||||||
user:password@/dbname?sql_mode=TRADITIONAL
|
|
||||||
```
|
|
||||||
|
|
||||||
TCP via IPv6:
|
|
||||||
```
|
|
||||||
user:password@tcp([de:ad:be:ef::ca:fe]:80)/dbname?timeout=90s&collation=utf8mb4_unicode_ci
|
|
||||||
```
|
|
||||||
|
|
||||||
TCP on a remote host, e.g. Amazon RDS:
|
|
||||||
```
|
|
||||||
id:password@tcp(your-amazonaws-uri.com:3306)/dbname
|
|
||||||
```
|
|
||||||
|
|
||||||
Google Cloud SQL on App Engine:
|
|
||||||
```
|
|
||||||
user:password@unix(/cloudsql/project-id:region-name:instance-name)/dbname
|
|
||||||
```
|
|
||||||
|
|
||||||
TCP using default port (3306) on localhost:
|
|
||||||
```
|
|
||||||
user:password@tcp/dbname?charset=utf8mb4,utf8&sys_var=esc%40ped
|
|
||||||
```
|
|
||||||
|
|
||||||
Use the default protocol (tcp) and host (localhost:3306):
|
|
||||||
```
|
|
||||||
user:password@/dbname
|
|
||||||
```
|
|
||||||
|
|
||||||
No Database preselected:
|
|
||||||
```
|
|
||||||
user:password@/
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
### Connection pool and timeouts
|
|
||||||
The connection pool is managed by Go's database/sql package. For details on how to configure the size of the pool and how long connections stay in the pool see `*DB.SetMaxOpenConns`, `*DB.SetMaxIdleConns`, and `*DB.SetConnMaxLifetime` in the [database/sql documentation](https://golang.org/pkg/database/sql/). The read, write, and dial timeouts for each individual connection are configured with the DSN parameters [`readTimeout`](#readtimeout), [`writeTimeout`](#writetimeout), and [`timeout`](#timeout), respectively.
|
|
||||||
|
|
||||||
## `ColumnType` Support
|
|
||||||
This driver supports the [`ColumnType` interface](https://golang.org/pkg/database/sql/#ColumnType) introduced in Go 1.8, with the exception of [`ColumnType.Length()`](https://golang.org/pkg/database/sql/#ColumnType.Length), which is currently not supported.
|
|
||||||
|
|
||||||
## `context.Context` Support
|
|
||||||
Go 1.8 added `database/sql` support for `context.Context`. This driver supports query timeouts and cancellation via contexts.
|
|
||||||
See [context support in the database/sql package](https://golang.org/doc/go1.8#database_sql) for more details.
|
|
||||||
|
|
||||||
|
|
||||||
### `LOAD DATA LOCAL INFILE` support
|
|
||||||
For this feature you need direct access to the package. Therefore you must change the import path (no `_`):
|
|
||||||
```go
|
|
||||||
import "github.com/go-sql-driver/mysql"
|
|
||||||
```
|
|
||||||
|
|
||||||
Files must be explicitly allowed by registering them with `mysql.RegisterLocalFile(filepath)` (recommended) or the allowlist check must be deactivated by using the DSN parameter `allowAllFiles=true` ([*Might be insecure!*](http://dev.mysql.com/doc/refman/5.7/en/load-data-local.html)).
|
|
||||||
|
|
||||||
To use a `io.Reader` a handler function must be registered with `mysql.RegisterReaderHandler(name, handler)` which returns a `io.Reader` or `io.ReadCloser`. The Reader is available with the filepath `Reader::<name>` then. Choose different names for different handlers and `DeregisterReaderHandler` when you don't need it anymore.
|
|
||||||
|
|
||||||
See the [godoc of Go-MySQL-Driver](https://godoc.org/github.com/go-sql-driver/mysql "golang mysql driver documentation") for details.
|
|
||||||
|
|
||||||
|
|
||||||
### `time.Time` support
|
|
||||||
The default internal output type of MySQL `DATE` and `DATETIME` values is `[]byte` which allows you to scan the value into a `[]byte`, `string` or `sql.RawBytes` variable in your program.
|
|
||||||
|
|
||||||
However, many want to scan MySQL `DATE` and `DATETIME` values into `time.Time` variables, which is the logical equivalent in Go to `DATE` and `DATETIME` in MySQL. You can do that by changing the internal output type from `[]byte` to `time.Time` with the DSN parameter `parseTime=true`. You can set the default [`time.Time` location](https://golang.org/pkg/time/#Location) with the `loc` DSN parameter.
|
|
||||||
|
|
||||||
**Caution:** As of Go 1.1, this makes `time.Time` the only variable type you can scan `DATE` and `DATETIME` values into. This breaks for example [`sql.RawBytes` support](https://github.com/go-sql-driver/mysql/wiki/Examples#rawbytes).
|
|
||||||
|
|
||||||
|
|
||||||
### Unicode support
|
|
||||||
Since version 1.5 Go-MySQL-Driver automatically uses the collation ` utf8mb4_general_ci` by default.
|
|
||||||
|
|
||||||
Other collations / charsets can be set using the [`collation`](#collation) DSN parameter.
|
|
||||||
|
|
||||||
Version 1.0 of the driver recommended adding `&charset=utf8` (alias for `SET NAMES utf8`) to the DSN to enable proper UTF-8 support. This is not necessary anymore. The [`collation`](#collation) parameter should be preferred to set another collation / charset than the default.
|
|
||||||
|
|
||||||
See http://dev.mysql.com/doc/refman/8.0/en/charset-unicode.html for more details on MySQL's Unicode support.
|
|
||||||
|
|
||||||
## Testing / Development
|
|
||||||
To run the driver tests you may need to adjust the configuration. See the [Testing Wiki-Page](https://github.com/go-sql-driver/mysql/wiki/Testing "Testing") for details.
|
|
||||||
|
|
||||||
Go-MySQL-Driver is not feature-complete yet. Your help is very appreciated.
|
|
||||||
If you want to contribute, you can work on an [open issue](https://github.com/go-sql-driver/mysql/issues?state=open) or review a [pull request](https://github.com/go-sql-driver/mysql/pulls).
|
|
||||||
|
|
||||||
See the [Contribution Guidelines](https://github.com/go-sql-driver/mysql/blob/master/.github/CONTRIBUTING.md) for details.
|
|
||||||
|
|
||||||
---------------------------------------
|
|
||||||
|
|
||||||
## License
|
|
||||||
Go-MySQL-Driver is licensed under the [Mozilla Public License Version 2.0](https://raw.github.com/go-sql-driver/mysql/master/LICENSE)
|
|
||||||
|
|
||||||
Mozilla summarizes the license scope as follows:
|
|
||||||
> MPL: The copyleft applies to any files containing MPLed code.
|
|
||||||
|
|
||||||
|
|
||||||
That means:
|
|
||||||
* You can **use** the **unchanged** source code both in private and commercially.
|
|
||||||
* When distributing, you **must publish** the source code of any **changed files** licensed under the MPL 2.0 under a) the MPL 2.0 itself or b) a compatible license (e.g. GPL 3.0 or Apache License 2.0).
|
|
||||||
* You **needn't publish** the source code of your library as long as the files licensed under the MPL 2.0 are **unchanged**.
|
|
||||||
|
|
||||||
Please read the [MPL 2.0 FAQ](https://www.mozilla.org/en-US/MPL/2.0/FAQ/) if you have further questions regarding the license.
|
|
||||||
|
|
||||||
You can read the full terms here: [LICENSE](https://raw.github.com/go-sql-driver/mysql/master/LICENSE).
|
|
||||||
|
|
||||||
![Go Gopher and MySQL Dolphin](https://raw.github.com/wiki/go-sql-driver/mysql/go-mysql-driver_m.jpg "Golang Gopher transporting the MySQL Dolphin in a wheelbarrow")
|
|
@ -1,425 +0,0 @@
|
|||||||
// Go MySQL Driver - A MySQL-Driver for Go's database/sql package
|
|
||||||
//
|
|
||||||
// Copyright 2018 The Go-MySQL-Driver Authors. All rights reserved.
|
|
||||||
//
|
|
||||||
// This Source Code Form is subject to the terms of the Mozilla Public
|
|
||||||
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
||||||
// You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
||||||
|
|
||||||
package mysql
|
|
||||||
|
|
||||||
import (
|
|
||||||
"crypto/rand"
|
|
||||||
"crypto/rsa"
|
|
||||||
"crypto/sha1"
|
|
||||||
"crypto/sha256"
|
|
||||||
"crypto/x509"
|
|
||||||
"encoding/pem"
|
|
||||||
"fmt"
|
|
||||||
"sync"
|
|
||||||
)
|
|
||||||
|
|
||||||
// server pub keys registry
|
|
||||||
var (
|
|
||||||
serverPubKeyLock sync.RWMutex
|
|
||||||
serverPubKeyRegistry map[string]*rsa.PublicKey
|
|
||||||
)
|
|
||||||
|
|
||||||
// RegisterServerPubKey registers a server RSA public key which can be used to
|
|
||||||
// send data in a secure manner to the server without receiving the public key
|
|
||||||
// in a potentially insecure way from the server first.
|
|
||||||
// Registered keys can afterwards be used adding serverPubKey=<name> to the DSN.
|
|
||||||
//
|
|
||||||
// Note: The provided rsa.PublicKey instance is exclusively owned by the driver
|
|
||||||
// after registering it and may not be modified.
|
|
||||||
//
|
|
||||||
// data, err := ioutil.ReadFile("mykey.pem")
|
|
||||||
// if err != nil {
|
|
||||||
// log.Fatal(err)
|
|
||||||
// }
|
|
||||||
//
|
|
||||||
// block, _ := pem.Decode(data)
|
|
||||||
// if block == nil || block.Type != "PUBLIC KEY" {
|
|
||||||
// log.Fatal("failed to decode PEM block containing public key")
|
|
||||||
// }
|
|
||||||
//
|
|
||||||
// pub, err := x509.ParsePKIXPublicKey(block.Bytes)
|
|
||||||
// if err != nil {
|
|
||||||
// log.Fatal(err)
|
|
||||||
// }
|
|
||||||
//
|
|
||||||
// if rsaPubKey, ok := pub.(*rsa.PublicKey); ok {
|
|
||||||
// mysql.RegisterServerPubKey("mykey", rsaPubKey)
|
|
||||||
// } else {
|
|
||||||
// log.Fatal("not a RSA public key")
|
|
||||||
// }
|
|
||||||
//
|
|
||||||
func RegisterServerPubKey(name string, pubKey *rsa.PublicKey) {
|
|
||||||
serverPubKeyLock.Lock()
|
|
||||||
if serverPubKeyRegistry == nil {
|
|
||||||
serverPubKeyRegistry = make(map[string]*rsa.PublicKey)
|
|
||||||
}
|
|
||||||
|
|
||||||
serverPubKeyRegistry[name] = pubKey
|
|
||||||
serverPubKeyLock.Unlock()
|
|
||||||
}
|
|
||||||
|
|
||||||
// DeregisterServerPubKey removes the public key registered with the given name.
|
|
||||||
func DeregisterServerPubKey(name string) {
|
|
||||||
serverPubKeyLock.Lock()
|
|
||||||
if serverPubKeyRegistry != nil {
|
|
||||||
delete(serverPubKeyRegistry, name)
|
|
||||||
}
|
|
||||||
serverPubKeyLock.Unlock()
|
|
||||||
}
|
|
||||||
|
|
||||||
func getServerPubKey(name string) (pubKey *rsa.PublicKey) {
|
|
||||||
serverPubKeyLock.RLock()
|
|
||||||
if v, ok := serverPubKeyRegistry[name]; ok {
|
|
||||||
pubKey = v
|
|
||||||
}
|
|
||||||
serverPubKeyLock.RUnlock()
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// Hash password using pre 4.1 (old password) method
|
|
||||||
// https://github.com/atcurtis/mariadb/blob/master/mysys/my_rnd.c
|
|
||||||
type myRnd struct {
|
|
||||||
seed1, seed2 uint32
|
|
||||||
}
|
|
||||||
|
|
||||||
const myRndMaxVal = 0x3FFFFFFF
|
|
||||||
|
|
||||||
// Pseudo random number generator
|
|
||||||
func newMyRnd(seed1, seed2 uint32) *myRnd {
|
|
||||||
return &myRnd{
|
|
||||||
seed1: seed1 % myRndMaxVal,
|
|
||||||
seed2: seed2 % myRndMaxVal,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Tested to be equivalent to MariaDB's floating point variant
|
|
||||||
// http://play.golang.org/p/QHvhd4qved
|
|
||||||
// http://play.golang.org/p/RG0q4ElWDx
|
|
||||||
func (r *myRnd) NextByte() byte {
|
|
||||||
r.seed1 = (r.seed1*3 + r.seed2) % myRndMaxVal
|
|
||||||
r.seed2 = (r.seed1 + r.seed2 + 33) % myRndMaxVal
|
|
||||||
|
|
||||||
return byte(uint64(r.seed1) * 31 / myRndMaxVal)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Generate binary hash from byte string using insecure pre 4.1 method
|
|
||||||
func pwHash(password []byte) (result [2]uint32) {
|
|
||||||
var add uint32 = 7
|
|
||||||
var tmp uint32
|
|
||||||
|
|
||||||
result[0] = 1345345333
|
|
||||||
result[1] = 0x12345671
|
|
||||||
|
|
||||||
for _, c := range password {
|
|
||||||
// skip spaces and tabs in password
|
|
||||||
if c == ' ' || c == '\t' {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
tmp = uint32(c)
|
|
||||||
result[0] ^= (((result[0] & 63) + add) * tmp) + (result[0] << 8)
|
|
||||||
result[1] += (result[1] << 8) ^ result[0]
|
|
||||||
add += tmp
|
|
||||||
}
|
|
||||||
|
|
||||||
// Remove sign bit (1<<31)-1)
|
|
||||||
result[0] &= 0x7FFFFFFF
|
|
||||||
result[1] &= 0x7FFFFFFF
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// Hash password using insecure pre 4.1 method
|
|
||||||
func scrambleOldPassword(scramble []byte, password string) []byte {
|
|
||||||
scramble = scramble[:8]
|
|
||||||
|
|
||||||
hashPw := pwHash([]byte(password))
|
|
||||||
hashSc := pwHash(scramble)
|
|
||||||
|
|
||||||
r := newMyRnd(hashPw[0]^hashSc[0], hashPw[1]^hashSc[1])
|
|
||||||
|
|
||||||
var out [8]byte
|
|
||||||
for i := range out {
|
|
||||||
out[i] = r.NextByte() + 64
|
|
||||||
}
|
|
||||||
|
|
||||||
mask := r.NextByte()
|
|
||||||
for i := range out {
|
|
||||||
out[i] ^= mask
|
|
||||||
}
|
|
||||||
|
|
||||||
return out[:]
|
|
||||||
}
|
|
||||||
|
|
||||||
// Hash password using 4.1+ method (SHA1)
|
|
||||||
func scramblePassword(scramble []byte, password string) []byte {
|
|
||||||
if len(password) == 0 {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// stage1Hash = SHA1(password)
|
|
||||||
crypt := sha1.New()
|
|
||||||
crypt.Write([]byte(password))
|
|
||||||
stage1 := crypt.Sum(nil)
|
|
||||||
|
|
||||||
// scrambleHash = SHA1(scramble + SHA1(stage1Hash))
|
|
||||||
// inner Hash
|
|
||||||
crypt.Reset()
|
|
||||||
crypt.Write(stage1)
|
|
||||||
hash := crypt.Sum(nil)
|
|
||||||
|
|
||||||
// outer Hash
|
|
||||||
crypt.Reset()
|
|
||||||
crypt.Write(scramble)
|
|
||||||
crypt.Write(hash)
|
|
||||||
scramble = crypt.Sum(nil)
|
|
||||||
|
|
||||||
// token = scrambleHash XOR stage1Hash
|
|
||||||
for i := range scramble {
|
|
||||||
scramble[i] ^= stage1[i]
|
|
||||||
}
|
|
||||||
return scramble
|
|
||||||
}
|
|
||||||
|
|
||||||
// Hash password using MySQL 8+ method (SHA256)
|
|
||||||
func scrambleSHA256Password(scramble []byte, password string) []byte {
|
|
||||||
if len(password) == 0 {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// XOR(SHA256(password), SHA256(SHA256(SHA256(password)), scramble))
|
|
||||||
|
|
||||||
crypt := sha256.New()
|
|
||||||
crypt.Write([]byte(password))
|
|
||||||
message1 := crypt.Sum(nil)
|
|
||||||
|
|
||||||
crypt.Reset()
|
|
||||||
crypt.Write(message1)
|
|
||||||
message1Hash := crypt.Sum(nil)
|
|
||||||
|
|
||||||
crypt.Reset()
|
|
||||||
crypt.Write(message1Hash)
|
|
||||||
crypt.Write(scramble)
|
|
||||||
message2 := crypt.Sum(nil)
|
|
||||||
|
|
||||||
for i := range message1 {
|
|
||||||
message1[i] ^= message2[i]
|
|
||||||
}
|
|
||||||
|
|
||||||
return message1
|
|
||||||
}
|
|
||||||
|
|
||||||
func encryptPassword(password string, seed []byte, pub *rsa.PublicKey) ([]byte, error) {
|
|
||||||
plain := make([]byte, len(password)+1)
|
|
||||||
copy(plain, password)
|
|
||||||
for i := range plain {
|
|
||||||
j := i % len(seed)
|
|
||||||
plain[i] ^= seed[j]
|
|
||||||
}
|
|
||||||
sha1 := sha1.New()
|
|
||||||
return rsa.EncryptOAEP(sha1, rand.Reader, pub, plain, nil)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (mc *mysqlConn) sendEncryptedPassword(seed []byte, pub *rsa.PublicKey) error {
|
|
||||||
enc, err := encryptPassword(mc.cfg.Passwd, seed, pub)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return mc.writeAuthSwitchPacket(enc)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (mc *mysqlConn) auth(authData []byte, plugin string) ([]byte, error) {
|
|
||||||
switch plugin {
|
|
||||||
case "caching_sha2_password":
|
|
||||||
authResp := scrambleSHA256Password(authData, mc.cfg.Passwd)
|
|
||||||
return authResp, nil
|
|
||||||
|
|
||||||
case "mysql_old_password":
|
|
||||||
if !mc.cfg.AllowOldPasswords {
|
|
||||||
return nil, ErrOldPassword
|
|
||||||
}
|
|
||||||
if len(mc.cfg.Passwd) == 0 {
|
|
||||||
return nil, nil
|
|
||||||
}
|
|
||||||
// Note: there are edge cases where this should work but doesn't;
|
|
||||||
// this is currently "wontfix":
|
|
||||||
// https://github.com/go-sql-driver/mysql/issues/184
|
|
||||||
authResp := append(scrambleOldPassword(authData[:8], mc.cfg.Passwd), 0)
|
|
||||||
return authResp, nil
|
|
||||||
|
|
||||||
case "mysql_clear_password":
|
|
||||||
if !mc.cfg.AllowCleartextPasswords {
|
|
||||||
return nil, ErrCleartextPassword
|
|
||||||
}
|
|
||||||
// http://dev.mysql.com/doc/refman/5.7/en/cleartext-authentication-plugin.html
|
|
||||||
// http://dev.mysql.com/doc/refman/5.7/en/pam-authentication-plugin.html
|
|
||||||
return append([]byte(mc.cfg.Passwd), 0), nil
|
|
||||||
|
|
||||||
case "mysql_native_password":
|
|
||||||
if !mc.cfg.AllowNativePasswords {
|
|
||||||
return nil, ErrNativePassword
|
|
||||||
}
|
|
||||||
// https://dev.mysql.com/doc/internals/en/secure-password-authentication.html
|
|
||||||
// Native password authentication only need and will need 20-byte challenge.
|
|
||||||
authResp := scramblePassword(authData[:20], mc.cfg.Passwd)
|
|
||||||
return authResp, nil
|
|
||||||
|
|
||||||
case "sha256_password":
|
|
||||||
if len(mc.cfg.Passwd) == 0 {
|
|
||||||
return []byte{0}, nil
|
|
||||||
}
|
|
||||||
if mc.cfg.tls != nil || mc.cfg.Net == "unix" {
|
|
||||||
// write cleartext auth packet
|
|
||||||
return append([]byte(mc.cfg.Passwd), 0), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
pubKey := mc.cfg.pubKey
|
|
||||||
if pubKey == nil {
|
|
||||||
// request public key from server
|
|
||||||
return []byte{1}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// encrypted password
|
|
||||||
enc, err := encryptPassword(mc.cfg.Passwd, authData, pubKey)
|
|
||||||
return enc, err
|
|
||||||
|
|
||||||
default:
|
|
||||||
errLog.Print("unknown auth plugin:", plugin)
|
|
||||||
return nil, ErrUnknownPlugin
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (mc *mysqlConn) handleAuthResult(oldAuthData []byte, plugin string) error {
|
|
||||||
// Read Result Packet
|
|
||||||
authData, newPlugin, err := mc.readAuthResult()
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
// handle auth plugin switch, if requested
|
|
||||||
if newPlugin != "" {
|
|
||||||
// If CLIENT_PLUGIN_AUTH capability is not supported, no new cipher is
|
|
||||||
// sent and we have to keep using the cipher sent in the init packet.
|
|
||||||
if authData == nil {
|
|
||||||
authData = oldAuthData
|
|
||||||
} else {
|
|
||||||
// copy data from read buffer to owned slice
|
|
||||||
copy(oldAuthData, authData)
|
|
||||||
}
|
|
||||||
|
|
||||||
plugin = newPlugin
|
|
||||||
|
|
||||||
authResp, err := mc.auth(authData, plugin)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if err = mc.writeAuthSwitchPacket(authResp); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Read Result Packet
|
|
||||||
authData, newPlugin, err = mc.readAuthResult()
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Do not allow to change the auth plugin more than once
|
|
||||||
if newPlugin != "" {
|
|
||||||
return ErrMalformPkt
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
switch plugin {
|
|
||||||
|
|
||||||
// https://insidemysql.com/preparing-your-community-connector-for-mysql-8-part-2-sha256/
|
|
||||||
case "caching_sha2_password":
|
|
||||||
switch len(authData) {
|
|
||||||
case 0:
|
|
||||||
return nil // auth successful
|
|
||||||
case 1:
|
|
||||||
switch authData[0] {
|
|
||||||
case cachingSha2PasswordFastAuthSuccess:
|
|
||||||
if err = mc.readResultOK(); err == nil {
|
|
||||||
return nil // auth successful
|
|
||||||
}
|
|
||||||
|
|
||||||
case cachingSha2PasswordPerformFullAuthentication:
|
|
||||||
if mc.cfg.tls != nil || mc.cfg.Net == "unix" {
|
|
||||||
// write cleartext auth packet
|
|
||||||
err = mc.writeAuthSwitchPacket(append([]byte(mc.cfg.Passwd), 0))
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
pubKey := mc.cfg.pubKey
|
|
||||||
if pubKey == nil {
|
|
||||||
// request public key from server
|
|
||||||
data, err := mc.buf.takeSmallBuffer(4 + 1)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
data[4] = cachingSha2PasswordRequestPublicKey
|
|
||||||
mc.writePacket(data)
|
|
||||||
|
|
||||||
// parse public key
|
|
||||||
if data, err = mc.readPacket(); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
block, rest := pem.Decode(data[1:])
|
|
||||||
if block == nil {
|
|
||||||
return fmt.Errorf("No Pem data found, data: %s", rest)
|
|
||||||
}
|
|
||||||
pkix, err := x509.ParsePKIXPublicKey(block.Bytes)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
pubKey = pkix.(*rsa.PublicKey)
|
|
||||||
}
|
|
||||||
|
|
||||||
// send encrypted password
|
|
||||||
err = mc.sendEncryptedPassword(oldAuthData, pubKey)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return mc.readResultOK()
|
|
||||||
|
|
||||||
default:
|
|
||||||
return ErrMalformPkt
|
|
||||||
}
|
|
||||||
default:
|
|
||||||
return ErrMalformPkt
|
|
||||||
}
|
|
||||||
|
|
||||||
case "sha256_password":
|
|
||||||
switch len(authData) {
|
|
||||||
case 0:
|
|
||||||
return nil // auth successful
|
|
||||||
default:
|
|
||||||
block, _ := pem.Decode(authData)
|
|
||||||
pub, err := x509.ParsePKIXPublicKey(block.Bytes)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
// send encrypted password
|
|
||||||
err = mc.sendEncryptedPassword(oldAuthData, pub.(*rsa.PublicKey))
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return mc.readResultOK()
|
|
||||||
}
|
|
||||||
|
|
||||||
default:
|
|
||||||
return nil // auth successful
|
|
||||||
}
|
|
||||||
|
|
||||||
return err
|
|
||||||
}
|
|
@ -1,182 +0,0 @@
|
|||||||
// Go MySQL Driver - A MySQL-Driver for Go's database/sql package
|
|
||||||
//
|
|
||||||
// Copyright 2013 The Go-MySQL-Driver Authors. All rights reserved.
|
|
||||||
//
|
|
||||||
// This Source Code Form is subject to the terms of the Mozilla Public
|
|
||||||
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
||||||
// You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
||||||
|
|
||||||
package mysql
|
|
||||||
|
|
||||||
import (
|
|
||||||
"io"
|
|
||||||
"net"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
const defaultBufSize = 4096
|
|
||||||
const maxCachedBufSize = 256 * 1024
|
|
||||||
|
|
||||||
// A buffer which is used for both reading and writing.
|
|
||||||
// This is possible since communication on each connection is synchronous.
|
|
||||||
// In other words, we can't write and read simultaneously on the same connection.
|
|
||||||
// The buffer is similar to bufio.Reader / Writer but zero-copy-ish
|
|
||||||
// Also highly optimized for this particular use case.
|
|
||||||
// This buffer is backed by two byte slices in a double-buffering scheme
|
|
||||||
type buffer struct {
|
|
||||||
buf []byte // buf is a byte buffer who's length and capacity are equal.
|
|
||||||
nc net.Conn
|
|
||||||
idx int
|
|
||||||
length int
|
|
||||||
timeout time.Duration
|
|
||||||
dbuf [2][]byte // dbuf is an array with the two byte slices that back this buffer
|
|
||||||
flipcnt uint // flipccnt is the current buffer counter for double-buffering
|
|
||||||
}
|
|
||||||
|
|
||||||
// newBuffer allocates and returns a new buffer.
|
|
||||||
func newBuffer(nc net.Conn) buffer {
|
|
||||||
fg := make([]byte, defaultBufSize)
|
|
||||||
return buffer{
|
|
||||||
buf: fg,
|
|
||||||
nc: nc,
|
|
||||||
dbuf: [2][]byte{fg, nil},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// flip replaces the active buffer with the background buffer
|
|
||||||
// this is a delayed flip that simply increases the buffer counter;
|
|
||||||
// the actual flip will be performed the next time we call `buffer.fill`
|
|
||||||
func (b *buffer) flip() {
|
|
||||||
b.flipcnt += 1
|
|
||||||
}
|
|
||||||
|
|
||||||
// fill reads into the buffer until at least _need_ bytes are in it
|
|
||||||
func (b *buffer) fill(need int) error {
|
|
||||||
n := b.length
|
|
||||||
// fill data into its double-buffering target: if we've called
|
|
||||||
// flip on this buffer, we'll be copying to the background buffer,
|
|
||||||
// and then filling it with network data; otherwise we'll just move
|
|
||||||
// the contents of the current buffer to the front before filling it
|
|
||||||
dest := b.dbuf[b.flipcnt&1]
|
|
||||||
|
|
||||||
// grow buffer if necessary to fit the whole packet.
|
|
||||||
if need > len(dest) {
|
|
||||||
// Round up to the next multiple of the default size
|
|
||||||
dest = make([]byte, ((need/defaultBufSize)+1)*defaultBufSize)
|
|
||||||
|
|
||||||
// if the allocated buffer is not too large, move it to backing storage
|
|
||||||
// to prevent extra allocations on applications that perform large reads
|
|
||||||
if len(dest) <= maxCachedBufSize {
|
|
||||||
b.dbuf[b.flipcnt&1] = dest
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// if we're filling the fg buffer, move the existing data to the start of it.
|
|
||||||
// if we're filling the bg buffer, copy over the data
|
|
||||||
if n > 0 {
|
|
||||||
copy(dest[:n], b.buf[b.idx:])
|
|
||||||
}
|
|
||||||
|
|
||||||
b.buf = dest
|
|
||||||
b.idx = 0
|
|
||||||
|
|
||||||
for {
|
|
||||||
if b.timeout > 0 {
|
|
||||||
if err := b.nc.SetReadDeadline(time.Now().Add(b.timeout)); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
nn, err := b.nc.Read(b.buf[n:])
|
|
||||||
n += nn
|
|
||||||
|
|
||||||
switch err {
|
|
||||||
case nil:
|
|
||||||
if n < need {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
b.length = n
|
|
||||||
return nil
|
|
||||||
|
|
||||||
case io.EOF:
|
|
||||||
if n >= need {
|
|
||||||
b.length = n
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
return io.ErrUnexpectedEOF
|
|
||||||
|
|
||||||
default:
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// returns next N bytes from buffer.
|
|
||||||
// The returned slice is only guaranteed to be valid until the next read
|
|
||||||
func (b *buffer) readNext(need int) ([]byte, error) {
|
|
||||||
if b.length < need {
|
|
||||||
// refill
|
|
||||||
if err := b.fill(need); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
offset := b.idx
|
|
||||||
b.idx += need
|
|
||||||
b.length -= need
|
|
||||||
return b.buf[offset:b.idx], nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// takeBuffer returns a buffer with the requested size.
|
|
||||||
// If possible, a slice from the existing buffer is returned.
|
|
||||||
// Otherwise a bigger buffer is made.
|
|
||||||
// Only one buffer (total) can be used at a time.
|
|
||||||
func (b *buffer) takeBuffer(length int) ([]byte, error) {
|
|
||||||
if b.length > 0 {
|
|
||||||
return nil, ErrBusyBuffer
|
|
||||||
}
|
|
||||||
|
|
||||||
// test (cheap) general case first
|
|
||||||
if length <= cap(b.buf) {
|
|
||||||
return b.buf[:length], nil
|
|
||||||
}
|
|
||||||
|
|
||||||
if length < maxPacketSize {
|
|
||||||
b.buf = make([]byte, length)
|
|
||||||
return b.buf, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// buffer is larger than we want to store.
|
|
||||||
return make([]byte, length), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// takeSmallBuffer is shortcut which can be used if length is
|
|
||||||
// known to be smaller than defaultBufSize.
|
|
||||||
// Only one buffer (total) can be used at a time.
|
|
||||||
func (b *buffer) takeSmallBuffer(length int) ([]byte, error) {
|
|
||||||
if b.length > 0 {
|
|
||||||
return nil, ErrBusyBuffer
|
|
||||||
}
|
|
||||||
return b.buf[:length], nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// takeCompleteBuffer returns the complete existing buffer.
|
|
||||||
// This can be used if the necessary buffer size is unknown.
|
|
||||||
// cap and len of the returned buffer will be equal.
|
|
||||||
// Only one buffer (total) can be used at a time.
|
|
||||||
func (b *buffer) takeCompleteBuffer() ([]byte, error) {
|
|
||||||
if b.length > 0 {
|
|
||||||
return nil, ErrBusyBuffer
|
|
||||||
}
|
|
||||||
return b.buf, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// store stores buf, an updated buffer, if its suitable to do so.
|
|
||||||
func (b *buffer) store(buf []byte) error {
|
|
||||||
if b.length > 0 {
|
|
||||||
return ErrBusyBuffer
|
|
||||||
} else if cap(buf) <= maxPacketSize && cap(buf) > cap(b.buf) {
|
|
||||||
b.buf = buf[:cap(buf)]
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
@ -1,265 +0,0 @@
|
|||||||
// Go MySQL Driver - A MySQL-Driver for Go's database/sql package
|
|
||||||
//
|
|
||||||
// Copyright 2014 The Go-MySQL-Driver Authors. All rights reserved.
|
|
||||||
//
|
|
||||||
// This Source Code Form is subject to the terms of the Mozilla Public
|
|
||||||
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
||||||
// You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
||||||
|
|
||||||
package mysql
|
|
||||||
|
|
||||||
const defaultCollation = "utf8mb4_general_ci"
|
|
||||||
const binaryCollation = "binary"
|
|
||||||
|
|
||||||
// A list of available collations mapped to the internal ID.
|
|
||||||
// To update this map use the following MySQL query:
|
|
||||||
// SELECT COLLATION_NAME, ID FROM information_schema.COLLATIONS WHERE ID<256 ORDER BY ID
|
|
||||||
//
|
|
||||||
// Handshake packet have only 1 byte for collation_id. So we can't use collations with ID > 255.
|
|
||||||
//
|
|
||||||
// ucs2, utf16, and utf32 can't be used for connection charset.
|
|
||||||
// https://dev.mysql.com/doc/refman/5.7/en/charset-connection.html#charset-connection-impermissible-client-charset
|
|
||||||
// They are commented out to reduce this map.
|
|
||||||
var collations = map[string]byte{
|
|
||||||
"big5_chinese_ci": 1,
|
|
||||||
"latin2_czech_cs": 2,
|
|
||||||
"dec8_swedish_ci": 3,
|
|
||||||
"cp850_general_ci": 4,
|
|
||||||
"latin1_german1_ci": 5,
|
|
||||||
"hp8_english_ci": 6,
|
|
||||||
"koi8r_general_ci": 7,
|
|
||||||
"latin1_swedish_ci": 8,
|
|
||||||
"latin2_general_ci": 9,
|
|
||||||
"swe7_swedish_ci": 10,
|
|
||||||
"ascii_general_ci": 11,
|
|
||||||
"ujis_japanese_ci": 12,
|
|
||||||
"sjis_japanese_ci": 13,
|
|
||||||
"cp1251_bulgarian_ci": 14,
|
|
||||||
"latin1_danish_ci": 15,
|
|
||||||
"hebrew_general_ci": 16,
|
|
||||||
"tis620_thai_ci": 18,
|
|
||||||
"euckr_korean_ci": 19,
|
|
||||||
"latin7_estonian_cs": 20,
|
|
||||||
"latin2_hungarian_ci": 21,
|
|
||||||
"koi8u_general_ci": 22,
|
|
||||||
"cp1251_ukrainian_ci": 23,
|
|
||||||
"gb2312_chinese_ci": 24,
|
|
||||||
"greek_general_ci": 25,
|
|
||||||
"cp1250_general_ci": 26,
|
|
||||||
"latin2_croatian_ci": 27,
|
|
||||||
"gbk_chinese_ci": 28,
|
|
||||||
"cp1257_lithuanian_ci": 29,
|
|
||||||
"latin5_turkish_ci": 30,
|
|
||||||
"latin1_german2_ci": 31,
|
|
||||||
"armscii8_general_ci": 32,
|
|
||||||
"utf8_general_ci": 33,
|
|
||||||
"cp1250_czech_cs": 34,
|
|
||||||
//"ucs2_general_ci": 35,
|
|
||||||
"cp866_general_ci": 36,
|
|
||||||
"keybcs2_general_ci": 37,
|
|
||||||
"macce_general_ci": 38,
|
|
||||||
"macroman_general_ci": 39,
|
|
||||||
"cp852_general_ci": 40,
|
|
||||||
"latin7_general_ci": 41,
|
|
||||||
"latin7_general_cs": 42,
|
|
||||||
"macce_bin": 43,
|
|
||||||
"cp1250_croatian_ci": 44,
|
|
||||||
"utf8mb4_general_ci": 45,
|
|
||||||
"utf8mb4_bin": 46,
|
|
||||||
"latin1_bin": 47,
|
|
||||||
"latin1_general_ci": 48,
|
|
||||||
"latin1_general_cs": 49,
|
|
||||||
"cp1251_bin": 50,
|
|
||||||
"cp1251_general_ci": 51,
|
|
||||||
"cp1251_general_cs": 52,
|
|
||||||
"macroman_bin": 53,
|
|
||||||
//"utf16_general_ci": 54,
|
|
||||||
//"utf16_bin": 55,
|
|
||||||
//"utf16le_general_ci": 56,
|
|
||||||
"cp1256_general_ci": 57,
|
|
||||||
"cp1257_bin": 58,
|
|
||||||
"cp1257_general_ci": 59,
|
|
||||||
//"utf32_general_ci": 60,
|
|
||||||
//"utf32_bin": 61,
|
|
||||||
//"utf16le_bin": 62,
|
|
||||||
"binary": 63,
|
|
||||||
"armscii8_bin": 64,
|
|
||||||
"ascii_bin": 65,
|
|
||||||
"cp1250_bin": 66,
|
|
||||||
"cp1256_bin": 67,
|
|
||||||
"cp866_bin": 68,
|
|
||||||
"dec8_bin": 69,
|
|
||||||
"greek_bin": 70,
|
|
||||||
"hebrew_bin": 71,
|
|
||||||
"hp8_bin": 72,
|
|
||||||
"keybcs2_bin": 73,
|
|
||||||
"koi8r_bin": 74,
|
|
||||||
"koi8u_bin": 75,
|
|
||||||
"utf8_tolower_ci": 76,
|
|
||||||
"latin2_bin": 77,
|
|
||||||
"latin5_bin": 78,
|
|
||||||
"latin7_bin": 79,
|
|
||||||
"cp850_bin": 80,
|
|
||||||
"cp852_bin": 81,
|
|
||||||
"swe7_bin": 82,
|
|
||||||
"utf8_bin": 83,
|
|
||||||
"big5_bin": 84,
|
|
||||||
"euckr_bin": 85,
|
|
||||||
"gb2312_bin": 86,
|
|
||||||
"gbk_bin": 87,
|
|
||||||
"sjis_bin": 88,
|
|
||||||
"tis620_bin": 89,
|
|
||||||
//"ucs2_bin": 90,
|
|
||||||
"ujis_bin": 91,
|
|
||||||
"geostd8_general_ci": 92,
|
|
||||||
"geostd8_bin": 93,
|
|
||||||
"latin1_spanish_ci": 94,
|
|
||||||
"cp932_japanese_ci": 95,
|
|
||||||
"cp932_bin": 96,
|
|
||||||
"eucjpms_japanese_ci": 97,
|
|
||||||
"eucjpms_bin": 98,
|
|
||||||
"cp1250_polish_ci": 99,
|
|
||||||
//"utf16_unicode_ci": 101,
|
|
||||||
//"utf16_icelandic_ci": 102,
|
|
||||||
//"utf16_latvian_ci": 103,
|
|
||||||
//"utf16_romanian_ci": 104,
|
|
||||||
//"utf16_slovenian_ci": 105,
|
|
||||||
//"utf16_polish_ci": 106,
|
|
||||||
//"utf16_estonian_ci": 107,
|
|
||||||
//"utf16_spanish_ci": 108,
|
|
||||||
//"utf16_swedish_ci": 109,
|
|
||||||
//"utf16_turkish_ci": 110,
|
|
||||||
//"utf16_czech_ci": 111,
|
|
||||||
//"utf16_danish_ci": 112,
|
|
||||||
//"utf16_lithuanian_ci": 113,
|
|
||||||
//"utf16_slovak_ci": 114,
|
|
||||||
//"utf16_spanish2_ci": 115,
|
|
||||||
//"utf16_roman_ci": 116,
|
|
||||||
//"utf16_persian_ci": 117,
|
|
||||||
//"utf16_esperanto_ci": 118,
|
|
||||||
//"utf16_hungarian_ci": 119,
|
|
||||||
//"utf16_sinhala_ci": 120,
|
|
||||||
//"utf16_german2_ci": 121,
|
|
||||||
//"utf16_croatian_ci": 122,
|
|
||||||
//"utf16_unicode_520_ci": 123,
|
|
||||||
//"utf16_vietnamese_ci": 124,
|
|
||||||
//"ucs2_unicode_ci": 128,
|
|
||||||
//"ucs2_icelandic_ci": 129,
|
|
||||||
//"ucs2_latvian_ci": 130,
|
|
||||||
//"ucs2_romanian_ci": 131,
|
|
||||||
//"ucs2_slovenian_ci": 132,
|
|
||||||
//"ucs2_polish_ci": 133,
|
|
||||||
//"ucs2_estonian_ci": 134,
|
|
||||||
//"ucs2_spanish_ci": 135,
|
|
||||||
//"ucs2_swedish_ci": 136,
|
|
||||||
//"ucs2_turkish_ci": 137,
|
|
||||||
//"ucs2_czech_ci": 138,
|
|
||||||
//"ucs2_danish_ci": 139,
|
|
||||||
//"ucs2_lithuanian_ci": 140,
|
|
||||||
//"ucs2_slovak_ci": 141,
|
|
||||||
//"ucs2_spanish2_ci": 142,
|
|
||||||
//"ucs2_roman_ci": 143,
|
|
||||||
//"ucs2_persian_ci": 144,
|
|
||||||
//"ucs2_esperanto_ci": 145,
|
|
||||||
//"ucs2_hungarian_ci": 146,
|
|
||||||
//"ucs2_sinhala_ci": 147,
|
|
||||||
//"ucs2_german2_ci": 148,
|
|
||||||
//"ucs2_croatian_ci": 149,
|
|
||||||
//"ucs2_unicode_520_ci": 150,
|
|
||||||
//"ucs2_vietnamese_ci": 151,
|
|
||||||
//"ucs2_general_mysql500_ci": 159,
|
|
||||||
//"utf32_unicode_ci": 160,
|
|
||||||
//"utf32_icelandic_ci": 161,
|
|
||||||
//"utf32_latvian_ci": 162,
|
|
||||||
//"utf32_romanian_ci": 163,
|
|
||||||
//"utf32_slovenian_ci": 164,
|
|
||||||
//"utf32_polish_ci": 165,
|
|
||||||
//"utf32_estonian_ci": 166,
|
|
||||||
//"utf32_spanish_ci": 167,
|
|
||||||
//"utf32_swedish_ci": 168,
|
|
||||||
//"utf32_turkish_ci": 169,
|
|
||||||
//"utf32_czech_ci": 170,
|
|
||||||
//"utf32_danish_ci": 171,
|
|
||||||
//"utf32_lithuanian_ci": 172,
|
|
||||||
//"utf32_slovak_ci": 173,
|
|
||||||
//"utf32_spanish2_ci": 174,
|
|
||||||
//"utf32_roman_ci": 175,
|
|
||||||
//"utf32_persian_ci": 176,
|
|
||||||
//"utf32_esperanto_ci": 177,
|
|
||||||
//"utf32_hungarian_ci": 178,
|
|
||||||
//"utf32_sinhala_ci": 179,
|
|
||||||
//"utf32_german2_ci": 180,
|
|
||||||
//"utf32_croatian_ci": 181,
|
|
||||||
//"utf32_unicode_520_ci": 182,
|
|
||||||
//"utf32_vietnamese_ci": 183,
|
|
||||||
"utf8_unicode_ci": 192,
|
|
||||||
"utf8_icelandic_ci": 193,
|
|
||||||
"utf8_latvian_ci": 194,
|
|
||||||
"utf8_romanian_ci": 195,
|
|
||||||
"utf8_slovenian_ci": 196,
|
|
||||||
"utf8_polish_ci": 197,
|
|
||||||
"utf8_estonian_ci": 198,
|
|
||||||
"utf8_spanish_ci": 199,
|
|
||||||
"utf8_swedish_ci": 200,
|
|
||||||
"utf8_turkish_ci": 201,
|
|
||||||
"utf8_czech_ci": 202,
|
|
||||||
"utf8_danish_ci": 203,
|
|
||||||
"utf8_lithuanian_ci": 204,
|
|
||||||
"utf8_slovak_ci": 205,
|
|
||||||
"utf8_spanish2_ci": 206,
|
|
||||||
"utf8_roman_ci": 207,
|
|
||||||
"utf8_persian_ci": 208,
|
|
||||||
"utf8_esperanto_ci": 209,
|
|
||||||
"utf8_hungarian_ci": 210,
|
|
||||||
"utf8_sinhala_ci": 211,
|
|
||||||
"utf8_german2_ci": 212,
|
|
||||||
"utf8_croatian_ci": 213,
|
|
||||||
"utf8_unicode_520_ci": 214,
|
|
||||||
"utf8_vietnamese_ci": 215,
|
|
||||||
"utf8_general_mysql500_ci": 223,
|
|
||||||
"utf8mb4_unicode_ci": 224,
|
|
||||||
"utf8mb4_icelandic_ci": 225,
|
|
||||||
"utf8mb4_latvian_ci": 226,
|
|
||||||
"utf8mb4_romanian_ci": 227,
|
|
||||||
"utf8mb4_slovenian_ci": 228,
|
|
||||||
"utf8mb4_polish_ci": 229,
|
|
||||||
"utf8mb4_estonian_ci": 230,
|
|
||||||
"utf8mb4_spanish_ci": 231,
|
|
||||||
"utf8mb4_swedish_ci": 232,
|
|
||||||
"utf8mb4_turkish_ci": 233,
|
|
||||||
"utf8mb4_czech_ci": 234,
|
|
||||||
"utf8mb4_danish_ci": 235,
|
|
||||||
"utf8mb4_lithuanian_ci": 236,
|
|
||||||
"utf8mb4_slovak_ci": 237,
|
|
||||||
"utf8mb4_spanish2_ci": 238,
|
|
||||||
"utf8mb4_roman_ci": 239,
|
|
||||||
"utf8mb4_persian_ci": 240,
|
|
||||||
"utf8mb4_esperanto_ci": 241,
|
|
||||||
"utf8mb4_hungarian_ci": 242,
|
|
||||||
"utf8mb4_sinhala_ci": 243,
|
|
||||||
"utf8mb4_german2_ci": 244,
|
|
||||||
"utf8mb4_croatian_ci": 245,
|
|
||||||
"utf8mb4_unicode_520_ci": 246,
|
|
||||||
"utf8mb4_vietnamese_ci": 247,
|
|
||||||
"gb18030_chinese_ci": 248,
|
|
||||||
"gb18030_bin": 249,
|
|
||||||
"gb18030_unicode_520_ci": 250,
|
|
||||||
"utf8mb4_0900_ai_ci": 255,
|
|
||||||
}
|
|
||||||
|
|
||||||
// A denylist of collations which is unsafe to interpolate parameters.
|
|
||||||
// These multibyte encodings may contains 0x5c (`\`) in their trailing bytes.
|
|
||||||
var unsafeCollations = map[string]bool{
|
|
||||||
"big5_chinese_ci": true,
|
|
||||||
"sjis_japanese_ci": true,
|
|
||||||
"gbk_chinese_ci": true,
|
|
||||||
"big5_bin": true,
|
|
||||||
"gb2312_bin": true,
|
|
||||||
"gbk_bin": true,
|
|
||||||
"sjis_bin": true,
|
|
||||||
"cp932_japanese_ci": true,
|
|
||||||
"cp932_bin": true,
|
|
||||||
"gb18030_chinese_ci": true,
|
|
||||||
"gb18030_bin": true,
|
|
||||||
"gb18030_unicode_520_ci": true,
|
|
||||||
}
|
|
@ -1,54 +0,0 @@
|
|||||||
// Go MySQL Driver - A MySQL-Driver for Go's database/sql package
|
|
||||||
//
|
|
||||||
// Copyright 2019 The Go-MySQL-Driver Authors. All rights reserved.
|
|
||||||
//
|
|
||||||
// This Source Code Form is subject to the terms of the Mozilla Public
|
|
||||||
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
||||||
// You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
||||||
|
|
||||||
// +build linux darwin dragonfly freebsd netbsd openbsd solaris illumos
|
|
||||||
|
|
||||||
package mysql
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"io"
|
|
||||||
"net"
|
|
||||||
"syscall"
|
|
||||||
)
|
|
||||||
|
|
||||||
var errUnexpectedRead = errors.New("unexpected read from socket")
|
|
||||||
|
|
||||||
func connCheck(conn net.Conn) error {
|
|
||||||
var sysErr error
|
|
||||||
|
|
||||||
sysConn, ok := conn.(syscall.Conn)
|
|
||||||
if !ok {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
rawConn, err := sysConn.SyscallConn()
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
err = rawConn.Read(func(fd uintptr) bool {
|
|
||||||
var buf [1]byte
|
|
||||||
n, err := syscall.Read(int(fd), buf[:])
|
|
||||||
switch {
|
|
||||||
case n == 0 && err == nil:
|
|
||||||
sysErr = io.EOF
|
|
||||||
case n > 0:
|
|
||||||
sysErr = errUnexpectedRead
|
|
||||||
case err == syscall.EAGAIN || err == syscall.EWOULDBLOCK:
|
|
||||||
sysErr = nil
|
|
||||||
default:
|
|
||||||
sysErr = err
|
|
||||||
}
|
|
||||||
return true
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
return sysErr
|
|
||||||
}
|
|
@ -1,17 +0,0 @@
|
|||||||
// Go MySQL Driver - A MySQL-Driver for Go's database/sql package
|
|
||||||
//
|
|
||||||
// Copyright 2019 The Go-MySQL-Driver Authors. All rights reserved.
|
|
||||||
//
|
|
||||||
// This Source Code Form is subject to the terms of the Mozilla Public
|
|
||||||
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
||||||
// You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
||||||
|
|
||||||
// +build !linux,!darwin,!dragonfly,!freebsd,!netbsd,!openbsd,!solaris,!illumos
|
|
||||||
|
|
||||||
package mysql
|
|
||||||
|
|
||||||
import "net"
|
|
||||||
|
|
||||||
func connCheck(conn net.Conn) error {
|
|
||||||
return nil
|
|
||||||
}
|
|
@ -1,650 +0,0 @@
|
|||||||
// Go MySQL Driver - A MySQL-Driver for Go's database/sql package
|
|
||||||
//
|
|
||||||
// Copyright 2012 The Go-MySQL-Driver Authors. All rights reserved.
|
|
||||||
//
|
|
||||||
// This Source Code Form is subject to the terms of the Mozilla Public
|
|
||||||
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
||||||
// You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
||||||
|
|
||||||
package mysql
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"database/sql"
|
|
||||||
"database/sql/driver"
|
|
||||||
"encoding/json"
|
|
||||||
"io"
|
|
||||||
"net"
|
|
||||||
"strconv"
|
|
||||||
"strings"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
type mysqlConn struct {
|
|
||||||
buf buffer
|
|
||||||
netConn net.Conn
|
|
||||||
rawConn net.Conn // underlying connection when netConn is TLS connection.
|
|
||||||
affectedRows uint64
|
|
||||||
insertId uint64
|
|
||||||
cfg *Config
|
|
||||||
maxAllowedPacket int
|
|
||||||
maxWriteSize int
|
|
||||||
writeTimeout time.Duration
|
|
||||||
flags clientFlag
|
|
||||||
status statusFlag
|
|
||||||
sequence uint8
|
|
||||||
parseTime bool
|
|
||||||
reset bool // set when the Go SQL package calls ResetSession
|
|
||||||
|
|
||||||
// for context support (Go 1.8+)
|
|
||||||
watching bool
|
|
||||||
watcher chan<- context.Context
|
|
||||||
closech chan struct{}
|
|
||||||
finished chan<- struct{}
|
|
||||||
canceled atomicError // set non-nil if conn is canceled
|
|
||||||
closed atomicBool // set when conn is closed, before closech is closed
|
|
||||||
}
|
|
||||||
|
|
||||||
// Handles parameters set in DSN after the connection is established
|
|
||||||
func (mc *mysqlConn) handleParams() (err error) {
|
|
||||||
var cmdSet strings.Builder
|
|
||||||
for param, val := range mc.cfg.Params {
|
|
||||||
switch param {
|
|
||||||
// Charset: character_set_connection, character_set_client, character_set_results
|
|
||||||
case "charset":
|
|
||||||
charsets := strings.Split(val, ",")
|
|
||||||
for i := range charsets {
|
|
||||||
// ignore errors here - a charset may not exist
|
|
||||||
err = mc.exec("SET NAMES " + charsets[i])
|
|
||||||
if err == nil {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// Other system vars accumulated in a single SET command
|
|
||||||
default:
|
|
||||||
if cmdSet.Len() == 0 {
|
|
||||||
// Heuristic: 29 chars for each other key=value to reduce reallocations
|
|
||||||
cmdSet.Grow(4 + len(param) + 1 + len(val) + 30*(len(mc.cfg.Params)-1))
|
|
||||||
cmdSet.WriteString("SET ")
|
|
||||||
} else {
|
|
||||||
cmdSet.WriteByte(',')
|
|
||||||
}
|
|
||||||
cmdSet.WriteString(param)
|
|
||||||
cmdSet.WriteByte('=')
|
|
||||||
cmdSet.WriteString(val)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if cmdSet.Len() > 0 {
|
|
||||||
err = mc.exec(cmdSet.String())
|
|
||||||
if err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
func (mc *mysqlConn) markBadConn(err error) error {
|
|
||||||
if mc == nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if err != errBadConnNoWrite {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return driver.ErrBadConn
|
|
||||||
}
|
|
||||||
|
|
||||||
func (mc *mysqlConn) Begin() (driver.Tx, error) {
|
|
||||||
return mc.begin(false)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (mc *mysqlConn) begin(readOnly bool) (driver.Tx, error) {
|
|
||||||
if mc.closed.IsSet() {
|
|
||||||
errLog.Print(ErrInvalidConn)
|
|
||||||
return nil, driver.ErrBadConn
|
|
||||||
}
|
|
||||||
var q string
|
|
||||||
if readOnly {
|
|
||||||
q = "START TRANSACTION READ ONLY"
|
|
||||||
} else {
|
|
||||||
q = "START TRANSACTION"
|
|
||||||
}
|
|
||||||
err := mc.exec(q)
|
|
||||||
if err == nil {
|
|
||||||
return &mysqlTx{mc}, err
|
|
||||||
}
|
|
||||||
return nil, mc.markBadConn(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (mc *mysqlConn) Close() (err error) {
|
|
||||||
// Makes Close idempotent
|
|
||||||
if !mc.closed.IsSet() {
|
|
||||||
err = mc.writeCommandPacket(comQuit)
|
|
||||||
}
|
|
||||||
|
|
||||||
mc.cleanup()
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// Closes the network connection and unsets internal variables. Do not call this
|
|
||||||
// function after successfully authentication, call Close instead. This function
|
|
||||||
// is called before auth or on auth failure because MySQL will have already
|
|
||||||
// closed the network connection.
|
|
||||||
func (mc *mysqlConn) cleanup() {
|
|
||||||
if !mc.closed.TrySet(true) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// Makes cleanup idempotent
|
|
||||||
close(mc.closech)
|
|
||||||
if mc.netConn == nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
if err := mc.netConn.Close(); err != nil {
|
|
||||||
errLog.Print(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (mc *mysqlConn) error() error {
|
|
||||||
if mc.closed.IsSet() {
|
|
||||||
if err := mc.canceled.Value(); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return ErrInvalidConn
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (mc *mysqlConn) Prepare(query string) (driver.Stmt, error) {
|
|
||||||
if mc.closed.IsSet() {
|
|
||||||
errLog.Print(ErrInvalidConn)
|
|
||||||
return nil, driver.ErrBadConn
|
|
||||||
}
|
|
||||||
// Send command
|
|
||||||
err := mc.writeCommandPacketStr(comStmtPrepare, query)
|
|
||||||
if err != nil {
|
|
||||||
// STMT_PREPARE is safe to retry. So we can return ErrBadConn here.
|
|
||||||
errLog.Print(err)
|
|
||||||
return nil, driver.ErrBadConn
|
|
||||||
}
|
|
||||||
|
|
||||||
stmt := &mysqlStmt{
|
|
||||||
mc: mc,
|
|
||||||
}
|
|
||||||
|
|
||||||
// Read Result
|
|
||||||
columnCount, err := stmt.readPrepareResultPacket()
|
|
||||||
if err == nil {
|
|
||||||
if stmt.paramCount > 0 {
|
|
||||||
if err = mc.readUntilEOF(); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if columnCount > 0 {
|
|
||||||
err = mc.readUntilEOF()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return stmt, err
|
|
||||||
}
|
|
||||||
|
|
||||||
func (mc *mysqlConn) interpolateParams(query string, args []driver.Value) (string, error) {
|
|
||||||
// Number of ? should be same to len(args)
|
|
||||||
if strings.Count(query, "?") != len(args) {
|
|
||||||
return "", driver.ErrSkip
|
|
||||||
}
|
|
||||||
|
|
||||||
buf, err := mc.buf.takeCompleteBuffer()
|
|
||||||
if err != nil {
|
|
||||||
// can not take the buffer. Something must be wrong with the connection
|
|
||||||
errLog.Print(err)
|
|
||||||
return "", ErrInvalidConn
|
|
||||||
}
|
|
||||||
buf = buf[:0]
|
|
||||||
argPos := 0
|
|
||||||
|
|
||||||
for i := 0; i < len(query); i++ {
|
|
||||||
q := strings.IndexByte(query[i:], '?')
|
|
||||||
if q == -1 {
|
|
||||||
buf = append(buf, query[i:]...)
|
|
||||||
break
|
|
||||||
}
|
|
||||||
buf = append(buf, query[i:i+q]...)
|
|
||||||
i += q
|
|
||||||
|
|
||||||
arg := args[argPos]
|
|
||||||
argPos++
|
|
||||||
|
|
||||||
if arg == nil {
|
|
||||||
buf = append(buf, "NULL"...)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
switch v := arg.(type) {
|
|
||||||
case int64:
|
|
||||||
buf = strconv.AppendInt(buf, v, 10)
|
|
||||||
case uint64:
|
|
||||||
// Handle uint64 explicitly because our custom ConvertValue emits unsigned values
|
|
||||||
buf = strconv.AppendUint(buf, v, 10)
|
|
||||||
case float64:
|
|
||||||
buf = strconv.AppendFloat(buf, v, 'g', -1, 64)
|
|
||||||
case bool:
|
|
||||||
if v {
|
|
||||||
buf = append(buf, '1')
|
|
||||||
} else {
|
|
||||||
buf = append(buf, '0')
|
|
||||||
}
|
|
||||||
case time.Time:
|
|
||||||
if v.IsZero() {
|
|
||||||
buf = append(buf, "'0000-00-00'"...)
|
|
||||||
} else {
|
|
||||||
buf = append(buf, '\'')
|
|
||||||
buf, err = appendDateTime(buf, v.In(mc.cfg.Loc))
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
buf = append(buf, '\'')
|
|
||||||
}
|
|
||||||
case json.RawMessage:
|
|
||||||
buf = append(buf, '\'')
|
|
||||||
if mc.status&statusNoBackslashEscapes == 0 {
|
|
||||||
buf = escapeBytesBackslash(buf, v)
|
|
||||||
} else {
|
|
||||||
buf = escapeBytesQuotes(buf, v)
|
|
||||||
}
|
|
||||||
buf = append(buf, '\'')
|
|
||||||
case []byte:
|
|
||||||
if v == nil {
|
|
||||||
buf = append(buf, "NULL"...)
|
|
||||||
} else {
|
|
||||||
buf = append(buf, "_binary'"...)
|
|
||||||
if mc.status&statusNoBackslashEscapes == 0 {
|
|
||||||
buf = escapeBytesBackslash(buf, v)
|
|
||||||
} else {
|
|
||||||
buf = escapeBytesQuotes(buf, v)
|
|
||||||
}
|
|
||||||
buf = append(buf, '\'')
|
|
||||||
}
|
|
||||||
case string:
|
|
||||||
buf = append(buf, '\'')
|
|
||||||
if mc.status&statusNoBackslashEscapes == 0 {
|
|
||||||
buf = escapeStringBackslash(buf, v)
|
|
||||||
} else {
|
|
||||||
buf = escapeStringQuotes(buf, v)
|
|
||||||
}
|
|
||||||
buf = append(buf, '\'')
|
|
||||||
default:
|
|
||||||
return "", driver.ErrSkip
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(buf)+4 > mc.maxAllowedPacket {
|
|
||||||
return "", driver.ErrSkip
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if argPos != len(args) {
|
|
||||||
return "", driver.ErrSkip
|
|
||||||
}
|
|
||||||
return string(buf), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (mc *mysqlConn) Exec(query string, args []driver.Value) (driver.Result, error) {
|
|
||||||
if mc.closed.IsSet() {
|
|
||||||
errLog.Print(ErrInvalidConn)
|
|
||||||
return nil, driver.ErrBadConn
|
|
||||||
}
|
|
||||||
if len(args) != 0 {
|
|
||||||
if !mc.cfg.InterpolateParams {
|
|
||||||
return nil, driver.ErrSkip
|
|
||||||
}
|
|
||||||
// try to interpolate the parameters to save extra roundtrips for preparing and closing a statement
|
|
||||||
prepared, err := mc.interpolateParams(query, args)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
query = prepared
|
|
||||||
}
|
|
||||||
mc.affectedRows = 0
|
|
||||||
mc.insertId = 0
|
|
||||||
|
|
||||||
err := mc.exec(query)
|
|
||||||
if err == nil {
|
|
||||||
return &mysqlResult{
|
|
||||||
affectedRows: int64(mc.affectedRows),
|
|
||||||
insertId: int64(mc.insertId),
|
|
||||||
}, err
|
|
||||||
}
|
|
||||||
return nil, mc.markBadConn(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Internal function to execute commands
|
|
||||||
func (mc *mysqlConn) exec(query string) error {
|
|
||||||
// Send command
|
|
||||||
if err := mc.writeCommandPacketStr(comQuery, query); err != nil {
|
|
||||||
return mc.markBadConn(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Read Result
|
|
||||||
resLen, err := mc.readResultSetHeaderPacket()
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
if resLen > 0 {
|
|
||||||
// columns
|
|
||||||
if err := mc.readUntilEOF(); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
// rows
|
|
||||||
if err := mc.readUntilEOF(); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return mc.discardResults()
|
|
||||||
}
|
|
||||||
|
|
||||||
func (mc *mysqlConn) Query(query string, args []driver.Value) (driver.Rows, error) {
|
|
||||||
return mc.query(query, args)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (mc *mysqlConn) query(query string, args []driver.Value) (*textRows, error) {
|
|
||||||
if mc.closed.IsSet() {
|
|
||||||
errLog.Print(ErrInvalidConn)
|
|
||||||
return nil, driver.ErrBadConn
|
|
||||||
}
|
|
||||||
if len(args) != 0 {
|
|
||||||
if !mc.cfg.InterpolateParams {
|
|
||||||
return nil, driver.ErrSkip
|
|
||||||
}
|
|
||||||
// try client-side prepare to reduce roundtrip
|
|
||||||
prepared, err := mc.interpolateParams(query, args)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
query = prepared
|
|
||||||
}
|
|
||||||
// Send command
|
|
||||||
err := mc.writeCommandPacketStr(comQuery, query)
|
|
||||||
if err == nil {
|
|
||||||
// Read Result
|
|
||||||
var resLen int
|
|
||||||
resLen, err = mc.readResultSetHeaderPacket()
|
|
||||||
if err == nil {
|
|
||||||
rows := new(textRows)
|
|
||||||
rows.mc = mc
|
|
||||||
|
|
||||||
if resLen == 0 {
|
|
||||||
rows.rs.done = true
|
|
||||||
|
|
||||||
switch err := rows.NextResultSet(); err {
|
|
||||||
case nil, io.EOF:
|
|
||||||
return rows, nil
|
|
||||||
default:
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Columns
|
|
||||||
rows.rs.columns, err = mc.readColumns(resLen)
|
|
||||||
return rows, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return nil, mc.markBadConn(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Gets the value of the given MySQL System Variable
|
|
||||||
// The returned byte slice is only valid until the next read
|
|
||||||
func (mc *mysqlConn) getSystemVar(name string) ([]byte, error) {
|
|
||||||
// Send command
|
|
||||||
if err := mc.writeCommandPacketStr(comQuery, "SELECT @@"+name); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Read Result
|
|
||||||
resLen, err := mc.readResultSetHeaderPacket()
|
|
||||||
if err == nil {
|
|
||||||
rows := new(textRows)
|
|
||||||
rows.mc = mc
|
|
||||||
rows.rs.columns = []mysqlField{{fieldType: fieldTypeVarChar}}
|
|
||||||
|
|
||||||
if resLen > 0 {
|
|
||||||
// Columns
|
|
||||||
if err := mc.readUntilEOF(); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
dest := make([]driver.Value, resLen)
|
|
||||||
if err = rows.readRow(dest); err == nil {
|
|
||||||
return dest[0].([]byte), mc.readUntilEOF()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// finish is called when the query has canceled.
|
|
||||||
func (mc *mysqlConn) cancel(err error) {
|
|
||||||
mc.canceled.Set(err)
|
|
||||||
mc.cleanup()
|
|
||||||
}
|
|
||||||
|
|
||||||
// finish is called when the query has succeeded.
|
|
||||||
func (mc *mysqlConn) finish() {
|
|
||||||
if !mc.watching || mc.finished == nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
select {
|
|
||||||
case mc.finished <- struct{}{}:
|
|
||||||
mc.watching = false
|
|
||||||
case <-mc.closech:
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Ping implements driver.Pinger interface
|
|
||||||
func (mc *mysqlConn) Ping(ctx context.Context) (err error) {
|
|
||||||
if mc.closed.IsSet() {
|
|
||||||
errLog.Print(ErrInvalidConn)
|
|
||||||
return driver.ErrBadConn
|
|
||||||
}
|
|
||||||
|
|
||||||
if err = mc.watchCancel(ctx); err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
defer mc.finish()
|
|
||||||
|
|
||||||
if err = mc.writeCommandPacket(comPing); err != nil {
|
|
||||||
return mc.markBadConn(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return mc.readResultOK()
|
|
||||||
}
|
|
||||||
|
|
||||||
// BeginTx implements driver.ConnBeginTx interface
|
|
||||||
func (mc *mysqlConn) BeginTx(ctx context.Context, opts driver.TxOptions) (driver.Tx, error) {
|
|
||||||
if mc.closed.IsSet() {
|
|
||||||
return nil, driver.ErrBadConn
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := mc.watchCancel(ctx); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
defer mc.finish()
|
|
||||||
|
|
||||||
if sql.IsolationLevel(opts.Isolation) != sql.LevelDefault {
|
|
||||||
level, err := mapIsolationLevel(opts.Isolation)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
err = mc.exec("SET TRANSACTION ISOLATION LEVEL " + level)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return mc.begin(opts.ReadOnly)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (mc *mysqlConn) QueryContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Rows, error) {
|
|
||||||
dargs, err := namedValueToValue(args)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := mc.watchCancel(ctx); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
rows, err := mc.query(query, dargs)
|
|
||||||
if err != nil {
|
|
||||||
mc.finish()
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
rows.finish = mc.finish
|
|
||||||
return rows, err
|
|
||||||
}
|
|
||||||
|
|
||||||
func (mc *mysqlConn) ExecContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Result, error) {
|
|
||||||
dargs, err := namedValueToValue(args)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := mc.watchCancel(ctx); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
defer mc.finish()
|
|
||||||
|
|
||||||
return mc.Exec(query, dargs)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (mc *mysqlConn) PrepareContext(ctx context.Context, query string) (driver.Stmt, error) {
|
|
||||||
if err := mc.watchCancel(ctx); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
stmt, err := mc.Prepare(query)
|
|
||||||
mc.finish()
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
select {
|
|
||||||
default:
|
|
||||||
case <-ctx.Done():
|
|
||||||
stmt.Close()
|
|
||||||
return nil, ctx.Err()
|
|
||||||
}
|
|
||||||
return stmt, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (stmt *mysqlStmt) QueryContext(ctx context.Context, args []driver.NamedValue) (driver.Rows, error) {
|
|
||||||
dargs, err := namedValueToValue(args)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := stmt.mc.watchCancel(ctx); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
rows, err := stmt.query(dargs)
|
|
||||||
if err != nil {
|
|
||||||
stmt.mc.finish()
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
rows.finish = stmt.mc.finish
|
|
||||||
return rows, err
|
|
||||||
}
|
|
||||||
|
|
||||||
func (stmt *mysqlStmt) ExecContext(ctx context.Context, args []driver.NamedValue) (driver.Result, error) {
|
|
||||||
dargs, err := namedValueToValue(args)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := stmt.mc.watchCancel(ctx); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
defer stmt.mc.finish()
|
|
||||||
|
|
||||||
return stmt.Exec(dargs)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (mc *mysqlConn) watchCancel(ctx context.Context) error {
|
|
||||||
if mc.watching {
|
|
||||||
// Reach here if canceled,
|
|
||||||
// so the connection is already invalid
|
|
||||||
mc.cleanup()
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
// When ctx is already cancelled, don't watch it.
|
|
||||||
if err := ctx.Err(); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
// When ctx is not cancellable, don't watch it.
|
|
||||||
if ctx.Done() == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
// When watcher is not alive, can't watch it.
|
|
||||||
if mc.watcher == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
mc.watching = true
|
|
||||||
mc.watcher <- ctx
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (mc *mysqlConn) startWatcher() {
|
|
||||||
watcher := make(chan context.Context, 1)
|
|
||||||
mc.watcher = watcher
|
|
||||||
finished := make(chan struct{})
|
|
||||||
mc.finished = finished
|
|
||||||
go func() {
|
|
||||||
for {
|
|
||||||
var ctx context.Context
|
|
||||||
select {
|
|
||||||
case ctx = <-watcher:
|
|
||||||
case <-mc.closech:
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
select {
|
|
||||||
case <-ctx.Done():
|
|
||||||
mc.cancel(ctx.Err())
|
|
||||||
case <-finished:
|
|
||||||
case <-mc.closech:
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
}
|
|
||||||
|
|
||||||
func (mc *mysqlConn) CheckNamedValue(nv *driver.NamedValue) (err error) {
|
|
||||||
nv.Value, err = converter{}.ConvertValue(nv.Value)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// ResetSession implements driver.SessionResetter.
|
|
||||||
// (From Go 1.10)
|
|
||||||
func (mc *mysqlConn) ResetSession(ctx context.Context) error {
|
|
||||||
if mc.closed.IsSet() {
|
|
||||||
return driver.ErrBadConn
|
|
||||||
}
|
|
||||||
mc.reset = true
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// IsValid implements driver.Validator interface
|
|
||||||
// (From Go 1.15)
|
|
||||||
func (mc *mysqlConn) IsValid() bool {
|
|
||||||
return !mc.closed.IsSet()
|
|
||||||
}
|
|
@ -1,146 +0,0 @@
|
|||||||
// Go MySQL Driver - A MySQL-Driver for Go's database/sql package
|
|
||||||
//
|
|
||||||
// Copyright 2018 The Go-MySQL-Driver Authors. All rights reserved.
|
|
||||||
//
|
|
||||||
// This Source Code Form is subject to the terms of the Mozilla Public
|
|
||||||
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
||||||
// You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
||||||
|
|
||||||
package mysql
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"database/sql/driver"
|
|
||||||
"net"
|
|
||||||
)
|
|
||||||
|
|
||||||
type connector struct {
|
|
||||||
cfg *Config // immutable private copy.
|
|
||||||
}
|
|
||||||
|
|
||||||
// Connect implements driver.Connector interface.
|
|
||||||
// Connect returns a connection to the database.
|
|
||||||
func (c *connector) Connect(ctx context.Context) (driver.Conn, error) {
|
|
||||||
var err error
|
|
||||||
|
|
||||||
// New mysqlConn
|
|
||||||
mc := &mysqlConn{
|
|
||||||
maxAllowedPacket: maxPacketSize,
|
|
||||||
maxWriteSize: maxPacketSize - 1,
|
|
||||||
closech: make(chan struct{}),
|
|
||||||
cfg: c.cfg,
|
|
||||||
}
|
|
||||||
mc.parseTime = mc.cfg.ParseTime
|
|
||||||
|
|
||||||
// Connect to Server
|
|
||||||
dialsLock.RLock()
|
|
||||||
dial, ok := dials[mc.cfg.Net]
|
|
||||||
dialsLock.RUnlock()
|
|
||||||
if ok {
|
|
||||||
dctx := ctx
|
|
||||||
if mc.cfg.Timeout > 0 {
|
|
||||||
var cancel context.CancelFunc
|
|
||||||
dctx, cancel = context.WithTimeout(ctx, c.cfg.Timeout)
|
|
||||||
defer cancel()
|
|
||||||
}
|
|
||||||
mc.netConn, err = dial(dctx, mc.cfg.Addr)
|
|
||||||
} else {
|
|
||||||
nd := net.Dialer{Timeout: mc.cfg.Timeout}
|
|
||||||
mc.netConn, err = nd.DialContext(ctx, mc.cfg.Net, mc.cfg.Addr)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Enable TCP Keepalives on TCP connections
|
|
||||||
if tc, ok := mc.netConn.(*net.TCPConn); ok {
|
|
||||||
if err := tc.SetKeepAlive(true); err != nil {
|
|
||||||
// Don't send COM_QUIT before handshake.
|
|
||||||
mc.netConn.Close()
|
|
||||||
mc.netConn = nil
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Call startWatcher for context support (From Go 1.8)
|
|
||||||
mc.startWatcher()
|
|
||||||
if err := mc.watchCancel(ctx); err != nil {
|
|
||||||
mc.cleanup()
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
defer mc.finish()
|
|
||||||
|
|
||||||
mc.buf = newBuffer(mc.netConn)
|
|
||||||
|
|
||||||
// Set I/O timeouts
|
|
||||||
mc.buf.timeout = mc.cfg.ReadTimeout
|
|
||||||
mc.writeTimeout = mc.cfg.WriteTimeout
|
|
||||||
|
|
||||||
// Reading Handshake Initialization Packet
|
|
||||||
authData, plugin, err := mc.readHandshakePacket()
|
|
||||||
if err != nil {
|
|
||||||
mc.cleanup()
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
if plugin == "" {
|
|
||||||
plugin = defaultAuthPlugin
|
|
||||||
}
|
|
||||||
|
|
||||||
// Send Client Authentication Packet
|
|
||||||
authResp, err := mc.auth(authData, plugin)
|
|
||||||
if err != nil {
|
|
||||||
// try the default auth plugin, if using the requested plugin failed
|
|
||||||
errLog.Print("could not use requested auth plugin '"+plugin+"': ", err.Error())
|
|
||||||
plugin = defaultAuthPlugin
|
|
||||||
authResp, err = mc.auth(authData, plugin)
|
|
||||||
if err != nil {
|
|
||||||
mc.cleanup()
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if err = mc.writeHandshakeResponsePacket(authResp, plugin); err != nil {
|
|
||||||
mc.cleanup()
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Handle response to auth packet, switch methods if possible
|
|
||||||
if err = mc.handleAuthResult(authData, plugin); err != nil {
|
|
||||||
// Authentication failed and MySQL has already closed the connection
|
|
||||||
// (https://dev.mysql.com/doc/internals/en/authentication-fails.html).
|
|
||||||
// Do not send COM_QUIT, just cleanup and return the error.
|
|
||||||
mc.cleanup()
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
if mc.cfg.MaxAllowedPacket > 0 {
|
|
||||||
mc.maxAllowedPacket = mc.cfg.MaxAllowedPacket
|
|
||||||
} else {
|
|
||||||
// Get max allowed packet size
|
|
||||||
maxap, err := mc.getSystemVar("max_allowed_packet")
|
|
||||||
if err != nil {
|
|
||||||
mc.Close()
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
mc.maxAllowedPacket = stringToInt(maxap) - 1
|
|
||||||
}
|
|
||||||
if mc.maxAllowedPacket < maxPacketSize {
|
|
||||||
mc.maxWriteSize = mc.maxAllowedPacket
|
|
||||||
}
|
|
||||||
|
|
||||||
// Handle DSN Params
|
|
||||||
err = mc.handleParams()
|
|
||||||
if err != nil {
|
|
||||||
mc.Close()
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
return mc, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Driver implements driver.Connector interface.
|
|
||||||
// Driver returns &MySQLDriver{}.
|
|
||||||
func (c *connector) Driver() driver.Driver {
|
|
||||||
return &MySQLDriver{}
|
|
||||||
}
|
|
@ -1,174 +0,0 @@
|
|||||||
// Go MySQL Driver - A MySQL-Driver for Go's database/sql package
|
|
||||||
//
|
|
||||||
// Copyright 2012 The Go-MySQL-Driver Authors. All rights reserved.
|
|
||||||
//
|
|
||||||
// This Source Code Form is subject to the terms of the Mozilla Public
|
|
||||||
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
||||||
// You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
||||||
|
|
||||||
package mysql
|
|
||||||
|
|
||||||
const (
|
|
||||||
defaultAuthPlugin = "mysql_native_password"
|
|
||||||
defaultMaxAllowedPacket = 4 << 20 // 4 MiB
|
|
||||||
minProtocolVersion = 10
|
|
||||||
maxPacketSize = 1<<24 - 1
|
|
||||||
timeFormat = "2006-01-02 15:04:05.999999"
|
|
||||||
)
|
|
||||||
|
|
||||||
// MySQL constants documentation:
|
|
||||||
// http://dev.mysql.com/doc/internals/en/client-server-protocol.html
|
|
||||||
|
|
||||||
const (
|
|
||||||
iOK byte = 0x00
|
|
||||||
iAuthMoreData byte = 0x01
|
|
||||||
iLocalInFile byte = 0xfb
|
|
||||||
iEOF byte = 0xfe
|
|
||||||
iERR byte = 0xff
|
|
||||||
)
|
|
||||||
|
|
||||||
// https://dev.mysql.com/doc/internals/en/capability-flags.html#packet-Protocol::CapabilityFlags
|
|
||||||
type clientFlag uint32
|
|
||||||
|
|
||||||
const (
|
|
||||||
clientLongPassword clientFlag = 1 << iota
|
|
||||||
clientFoundRows
|
|
||||||
clientLongFlag
|
|
||||||
clientConnectWithDB
|
|
||||||
clientNoSchema
|
|
||||||
clientCompress
|
|
||||||
clientODBC
|
|
||||||
clientLocalFiles
|
|
||||||
clientIgnoreSpace
|
|
||||||
clientProtocol41
|
|
||||||
clientInteractive
|
|
||||||
clientSSL
|
|
||||||
clientIgnoreSIGPIPE
|
|
||||||
clientTransactions
|
|
||||||
clientReserved
|
|
||||||
clientSecureConn
|
|
||||||
clientMultiStatements
|
|
||||||
clientMultiResults
|
|
||||||
clientPSMultiResults
|
|
||||||
clientPluginAuth
|
|
||||||
clientConnectAttrs
|
|
||||||
clientPluginAuthLenEncClientData
|
|
||||||
clientCanHandleExpiredPasswords
|
|
||||||
clientSessionTrack
|
|
||||||
clientDeprecateEOF
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
|
||||||
comQuit byte = iota + 1
|
|
||||||
comInitDB
|
|
||||||
comQuery
|
|
||||||
comFieldList
|
|
||||||
comCreateDB
|
|
||||||
comDropDB
|
|
||||||
comRefresh
|
|
||||||
comShutdown
|
|
||||||
comStatistics
|
|
||||||
comProcessInfo
|
|
||||||
comConnect
|
|
||||||
comProcessKill
|
|
||||||
comDebug
|
|
||||||
comPing
|
|
||||||
comTime
|
|
||||||
comDelayedInsert
|
|
||||||
comChangeUser
|
|
||||||
comBinlogDump
|
|
||||||
comTableDump
|
|
||||||
comConnectOut
|
|
||||||
comRegisterSlave
|
|
||||||
comStmtPrepare
|
|
||||||
comStmtExecute
|
|
||||||
comStmtSendLongData
|
|
||||||
comStmtClose
|
|
||||||
comStmtReset
|
|
||||||
comSetOption
|
|
||||||
comStmtFetch
|
|
||||||
)
|
|
||||||
|
|
||||||
// https://dev.mysql.com/doc/internals/en/com-query-response.html#packet-Protocol::ColumnType
|
|
||||||
type fieldType byte
|
|
||||||
|
|
||||||
const (
|
|
||||||
fieldTypeDecimal fieldType = iota
|
|
||||||
fieldTypeTiny
|
|
||||||
fieldTypeShort
|
|
||||||
fieldTypeLong
|
|
||||||
fieldTypeFloat
|
|
||||||
fieldTypeDouble
|
|
||||||
fieldTypeNULL
|
|
||||||
fieldTypeTimestamp
|
|
||||||
fieldTypeLongLong
|
|
||||||
fieldTypeInt24
|
|
||||||
fieldTypeDate
|
|
||||||
fieldTypeTime
|
|
||||||
fieldTypeDateTime
|
|
||||||
fieldTypeYear
|
|
||||||
fieldTypeNewDate
|
|
||||||
fieldTypeVarChar
|
|
||||||
fieldTypeBit
|
|
||||||
)
|
|
||||||
const (
|
|
||||||
fieldTypeJSON fieldType = iota + 0xf5
|
|
||||||
fieldTypeNewDecimal
|
|
||||||
fieldTypeEnum
|
|
||||||
fieldTypeSet
|
|
||||||
fieldTypeTinyBLOB
|
|
||||||
fieldTypeMediumBLOB
|
|
||||||
fieldTypeLongBLOB
|
|
||||||
fieldTypeBLOB
|
|
||||||
fieldTypeVarString
|
|
||||||
fieldTypeString
|
|
||||||
fieldTypeGeometry
|
|
||||||
)
|
|
||||||
|
|
||||||
type fieldFlag uint16
|
|
||||||
|
|
||||||
const (
|
|
||||||
flagNotNULL fieldFlag = 1 << iota
|
|
||||||
flagPriKey
|
|
||||||
flagUniqueKey
|
|
||||||
flagMultipleKey
|
|
||||||
flagBLOB
|
|
||||||
flagUnsigned
|
|
||||||
flagZeroFill
|
|
||||||
flagBinary
|
|
||||||
flagEnum
|
|
||||||
flagAutoIncrement
|
|
||||||
flagTimestamp
|
|
||||||
flagSet
|
|
||||||
flagUnknown1
|
|
||||||
flagUnknown2
|
|
||||||
flagUnknown3
|
|
||||||
flagUnknown4
|
|
||||||
)
|
|
||||||
|
|
||||||
// http://dev.mysql.com/doc/internals/en/status-flags.html
|
|
||||||
type statusFlag uint16
|
|
||||||
|
|
||||||
const (
|
|
||||||
statusInTrans statusFlag = 1 << iota
|
|
||||||
statusInAutocommit
|
|
||||||
statusReserved // Not in documentation
|
|
||||||
statusMoreResultsExists
|
|
||||||
statusNoGoodIndexUsed
|
|
||||||
statusNoIndexUsed
|
|
||||||
statusCursorExists
|
|
||||||
statusLastRowSent
|
|
||||||
statusDbDropped
|
|
||||||
statusNoBackslashEscapes
|
|
||||||
statusMetadataChanged
|
|
||||||
statusQueryWasSlow
|
|
||||||
statusPsOutParams
|
|
||||||
statusInTransReadonly
|
|
||||||
statusSessionStateChanged
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
|
||||||
cachingSha2PasswordRequestPublicKey = 2
|
|
||||||
cachingSha2PasswordFastAuthSuccess = 3
|
|
||||||
cachingSha2PasswordPerformFullAuthentication = 4
|
|
||||||
)
|
|
@ -1,107 +0,0 @@
|
|||||||
// Copyright 2012 The Go-MySQL-Driver Authors. All rights reserved.
|
|
||||||
//
|
|
||||||
// This Source Code Form is subject to the terms of the Mozilla Public
|
|
||||||
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
||||||
// You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
||||||
|
|
||||||
// Package mysql provides a MySQL driver for Go's database/sql package.
|
|
||||||
//
|
|
||||||
// The driver should be used via the database/sql package:
|
|
||||||
//
|
|
||||||
// import "database/sql"
|
|
||||||
// import _ "github.com/go-sql-driver/mysql"
|
|
||||||
//
|
|
||||||
// db, err := sql.Open("mysql", "user:password@/dbname")
|
|
||||||
//
|
|
||||||
// See https://github.com/go-sql-driver/mysql#usage for details
|
|
||||||
package mysql
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"database/sql"
|
|
||||||
"database/sql/driver"
|
|
||||||
"net"
|
|
||||||
"sync"
|
|
||||||
)
|
|
||||||
|
|
||||||
// MySQLDriver is exported to make the driver directly accessible.
|
|
||||||
// In general the driver is used via the database/sql package.
|
|
||||||
type MySQLDriver struct{}
|
|
||||||
|
|
||||||
// DialFunc is a function which can be used to establish the network connection.
|
|
||||||
// Custom dial functions must be registered with RegisterDial
|
|
||||||
//
|
|
||||||
// Deprecated: users should register a DialContextFunc instead
|
|
||||||
type DialFunc func(addr string) (net.Conn, error)
|
|
||||||
|
|
||||||
// DialContextFunc is a function which can be used to establish the network connection.
|
|
||||||
// Custom dial functions must be registered with RegisterDialContext
|
|
||||||
type DialContextFunc func(ctx context.Context, addr string) (net.Conn, error)
|
|
||||||
|
|
||||||
var (
|
|
||||||
dialsLock sync.RWMutex
|
|
||||||
dials map[string]DialContextFunc
|
|
||||||
)
|
|
||||||
|
|
||||||
// RegisterDialContext registers a custom dial function. It can then be used by the
|
|
||||||
// network address mynet(addr), where mynet is the registered new network.
|
|
||||||
// The current context for the connection and its address is passed to the dial function.
|
|
||||||
func RegisterDialContext(net string, dial DialContextFunc) {
|
|
||||||
dialsLock.Lock()
|
|
||||||
defer dialsLock.Unlock()
|
|
||||||
if dials == nil {
|
|
||||||
dials = make(map[string]DialContextFunc)
|
|
||||||
}
|
|
||||||
dials[net] = dial
|
|
||||||
}
|
|
||||||
|
|
||||||
// RegisterDial registers a custom dial function. It can then be used by the
|
|
||||||
// network address mynet(addr), where mynet is the registered new network.
|
|
||||||
// addr is passed as a parameter to the dial function.
|
|
||||||
//
|
|
||||||
// Deprecated: users should call RegisterDialContext instead
|
|
||||||
func RegisterDial(network string, dial DialFunc) {
|
|
||||||
RegisterDialContext(network, func(_ context.Context, addr string) (net.Conn, error) {
|
|
||||||
return dial(addr)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// Open new Connection.
|
|
||||||
// See https://github.com/go-sql-driver/mysql#dsn-data-source-name for how
|
|
||||||
// the DSN string is formatted
|
|
||||||
func (d MySQLDriver) Open(dsn string) (driver.Conn, error) {
|
|
||||||
cfg, err := ParseDSN(dsn)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
c := &connector{
|
|
||||||
cfg: cfg,
|
|
||||||
}
|
|
||||||
return c.Connect(context.Background())
|
|
||||||
}
|
|
||||||
|
|
||||||
func init() {
|
|
||||||
sql.Register("mysql", &MySQLDriver{})
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewConnector returns new driver.Connector.
|
|
||||||
func NewConnector(cfg *Config) (driver.Connector, error) {
|
|
||||||
cfg = cfg.Clone()
|
|
||||||
// normalize the contents of cfg so calls to NewConnector have the same
|
|
||||||
// behavior as MySQLDriver.OpenConnector
|
|
||||||
if err := cfg.normalize(); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return &connector{cfg: cfg}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// OpenConnector implements driver.DriverContext.
|
|
||||||
func (d MySQLDriver) OpenConnector(dsn string) (driver.Connector, error) {
|
|
||||||
cfg, err := ParseDSN(dsn)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return &connector{
|
|
||||||
cfg: cfg,
|
|
||||||
}, nil
|
|
||||||
}
|
|
@ -1,560 +0,0 @@
|
|||||||
// Go MySQL Driver - A MySQL-Driver for Go's database/sql package
|
|
||||||
//
|
|
||||||
// Copyright 2016 The Go-MySQL-Driver Authors. All rights reserved.
|
|
||||||
//
|
|
||||||
// This Source Code Form is subject to the terms of the Mozilla Public
|
|
||||||
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
||||||
// You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
||||||
|
|
||||||
package mysql
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"crypto/rsa"
|
|
||||||
"crypto/tls"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"math/big"
|
|
||||||
"net"
|
|
||||||
"net/url"
|
|
||||||
"sort"
|
|
||||||
"strconv"
|
|
||||||
"strings"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
errInvalidDSNUnescaped = errors.New("invalid DSN: did you forget to escape a param value?")
|
|
||||||
errInvalidDSNAddr = errors.New("invalid DSN: network address not terminated (missing closing brace)")
|
|
||||||
errInvalidDSNNoSlash = errors.New("invalid DSN: missing the slash separating the database name")
|
|
||||||
errInvalidDSNUnsafeCollation = errors.New("invalid DSN: interpolateParams can not be used with unsafe collations")
|
|
||||||
)
|
|
||||||
|
|
||||||
// Config is a configuration parsed from a DSN string.
|
|
||||||
// If a new Config is created instead of being parsed from a DSN string,
|
|
||||||
// the NewConfig function should be used, which sets default values.
|
|
||||||
type Config struct {
|
|
||||||
User string // Username
|
|
||||||
Passwd string // Password (requires User)
|
|
||||||
Net string // Network type
|
|
||||||
Addr string // Network address (requires Net)
|
|
||||||
DBName string // Database name
|
|
||||||
Params map[string]string // Connection parameters
|
|
||||||
Collation string // Connection collation
|
|
||||||
Loc *time.Location // Location for time.Time values
|
|
||||||
MaxAllowedPacket int // Max packet size allowed
|
|
||||||
ServerPubKey string // Server public key name
|
|
||||||
pubKey *rsa.PublicKey // Server public key
|
|
||||||
TLSConfig string // TLS configuration name
|
|
||||||
tls *tls.Config // TLS configuration
|
|
||||||
Timeout time.Duration // Dial timeout
|
|
||||||
ReadTimeout time.Duration // I/O read timeout
|
|
||||||
WriteTimeout time.Duration // I/O write timeout
|
|
||||||
|
|
||||||
AllowAllFiles bool // Allow all files to be used with LOAD DATA LOCAL INFILE
|
|
||||||
AllowCleartextPasswords bool // Allows the cleartext client side plugin
|
|
||||||
AllowNativePasswords bool // Allows the native password authentication method
|
|
||||||
AllowOldPasswords bool // Allows the old insecure password method
|
|
||||||
CheckConnLiveness bool // Check connections for liveness before using them
|
|
||||||
ClientFoundRows bool // Return number of matching rows instead of rows changed
|
|
||||||
ColumnsWithAlias bool // Prepend table alias to column names
|
|
||||||
InterpolateParams bool // Interpolate placeholders into query string
|
|
||||||
MultiStatements bool // Allow multiple statements in one query
|
|
||||||
ParseTime bool // Parse time values to time.Time
|
|
||||||
RejectReadOnly bool // Reject read-only connections
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewConfig creates a new Config and sets default values.
|
|
||||||
func NewConfig() *Config {
|
|
||||||
return &Config{
|
|
||||||
Collation: defaultCollation,
|
|
||||||
Loc: time.UTC,
|
|
||||||
MaxAllowedPacket: defaultMaxAllowedPacket,
|
|
||||||
AllowNativePasswords: true,
|
|
||||||
CheckConnLiveness: true,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (cfg *Config) Clone() *Config {
|
|
||||||
cp := *cfg
|
|
||||||
if cp.tls != nil {
|
|
||||||
cp.tls = cfg.tls.Clone()
|
|
||||||
}
|
|
||||||
if len(cp.Params) > 0 {
|
|
||||||
cp.Params = make(map[string]string, len(cfg.Params))
|
|
||||||
for k, v := range cfg.Params {
|
|
||||||
cp.Params[k] = v
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if cfg.pubKey != nil {
|
|
||||||
cp.pubKey = &rsa.PublicKey{
|
|
||||||
N: new(big.Int).Set(cfg.pubKey.N),
|
|
||||||
E: cfg.pubKey.E,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return &cp
|
|
||||||
}
|
|
||||||
|
|
||||||
func (cfg *Config) normalize() error {
|
|
||||||
if cfg.InterpolateParams && unsafeCollations[cfg.Collation] {
|
|
||||||
return errInvalidDSNUnsafeCollation
|
|
||||||
}
|
|
||||||
|
|
||||||
// Set default network if empty
|
|
||||||
if cfg.Net == "" {
|
|
||||||
cfg.Net = "tcp"
|
|
||||||
}
|
|
||||||
|
|
||||||
// Set default address if empty
|
|
||||||
if cfg.Addr == "" {
|
|
||||||
switch cfg.Net {
|
|
||||||
case "tcp":
|
|
||||||
cfg.Addr = "127.0.0.1:3306"
|
|
||||||
case "unix":
|
|
||||||
cfg.Addr = "/tmp/mysql.sock"
|
|
||||||
default:
|
|
||||||
return errors.New("default addr for network '" + cfg.Net + "' unknown")
|
|
||||||
}
|
|
||||||
} else if cfg.Net == "tcp" {
|
|
||||||
cfg.Addr = ensureHavePort(cfg.Addr)
|
|
||||||
}
|
|
||||||
|
|
||||||
switch cfg.TLSConfig {
|
|
||||||
case "false", "":
|
|
||||||
// don't set anything
|
|
||||||
case "true":
|
|
||||||
cfg.tls = &tls.Config{}
|
|
||||||
case "skip-verify", "preferred":
|
|
||||||
cfg.tls = &tls.Config{InsecureSkipVerify: true}
|
|
||||||
default:
|
|
||||||
cfg.tls = getTLSConfigClone(cfg.TLSConfig)
|
|
||||||
if cfg.tls == nil {
|
|
||||||
return errors.New("invalid value / unknown config name: " + cfg.TLSConfig)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if cfg.tls != nil && cfg.tls.ServerName == "" && !cfg.tls.InsecureSkipVerify {
|
|
||||||
host, _, err := net.SplitHostPort(cfg.Addr)
|
|
||||||
if err == nil {
|
|
||||||
cfg.tls.ServerName = host
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if cfg.ServerPubKey != "" {
|
|
||||||
cfg.pubKey = getServerPubKey(cfg.ServerPubKey)
|
|
||||||
if cfg.pubKey == nil {
|
|
||||||
return errors.New("invalid value / unknown server pub key name: " + cfg.ServerPubKey)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func writeDSNParam(buf *bytes.Buffer, hasParam *bool, name, value string) {
|
|
||||||
buf.Grow(1 + len(name) + 1 + len(value))
|
|
||||||
if !*hasParam {
|
|
||||||
*hasParam = true
|
|
||||||
buf.WriteByte('?')
|
|
||||||
} else {
|
|
||||||
buf.WriteByte('&')
|
|
||||||
}
|
|
||||||
buf.WriteString(name)
|
|
||||||
buf.WriteByte('=')
|
|
||||||
buf.WriteString(value)
|
|
||||||
}
|
|
||||||
|
|
||||||
// FormatDSN formats the given Config into a DSN string which can be passed to
|
|
||||||
// the driver.
|
|
||||||
func (cfg *Config) FormatDSN() string {
|
|
||||||
var buf bytes.Buffer
|
|
||||||
|
|
||||||
// [username[:password]@]
|
|
||||||
if len(cfg.User) > 0 {
|
|
||||||
buf.WriteString(cfg.User)
|
|
||||||
if len(cfg.Passwd) > 0 {
|
|
||||||
buf.WriteByte(':')
|
|
||||||
buf.WriteString(cfg.Passwd)
|
|
||||||
}
|
|
||||||
buf.WriteByte('@')
|
|
||||||
}
|
|
||||||
|
|
||||||
// [protocol[(address)]]
|
|
||||||
if len(cfg.Net) > 0 {
|
|
||||||
buf.WriteString(cfg.Net)
|
|
||||||
if len(cfg.Addr) > 0 {
|
|
||||||
buf.WriteByte('(')
|
|
||||||
buf.WriteString(cfg.Addr)
|
|
||||||
buf.WriteByte(')')
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// /dbname
|
|
||||||
buf.WriteByte('/')
|
|
||||||
buf.WriteString(cfg.DBName)
|
|
||||||
|
|
||||||
// [?param1=value1&...¶mN=valueN]
|
|
||||||
hasParam := false
|
|
||||||
|
|
||||||
if cfg.AllowAllFiles {
|
|
||||||
hasParam = true
|
|
||||||
buf.WriteString("?allowAllFiles=true")
|
|
||||||
}
|
|
||||||
|
|
||||||
if cfg.AllowCleartextPasswords {
|
|
||||||
writeDSNParam(&buf, &hasParam, "allowCleartextPasswords", "true")
|
|
||||||
}
|
|
||||||
|
|
||||||
if !cfg.AllowNativePasswords {
|
|
||||||
writeDSNParam(&buf, &hasParam, "allowNativePasswords", "false")
|
|
||||||
}
|
|
||||||
|
|
||||||
if cfg.AllowOldPasswords {
|
|
||||||
writeDSNParam(&buf, &hasParam, "allowOldPasswords", "true")
|
|
||||||
}
|
|
||||||
|
|
||||||
if !cfg.CheckConnLiveness {
|
|
||||||
writeDSNParam(&buf, &hasParam, "checkConnLiveness", "false")
|
|
||||||
}
|
|
||||||
|
|
||||||
if cfg.ClientFoundRows {
|
|
||||||
writeDSNParam(&buf, &hasParam, "clientFoundRows", "true")
|
|
||||||
}
|
|
||||||
|
|
||||||
if col := cfg.Collation; col != defaultCollation && len(col) > 0 {
|
|
||||||
writeDSNParam(&buf, &hasParam, "collation", col)
|
|
||||||
}
|
|
||||||
|
|
||||||
if cfg.ColumnsWithAlias {
|
|
||||||
writeDSNParam(&buf, &hasParam, "columnsWithAlias", "true")
|
|
||||||
}
|
|
||||||
|
|
||||||
if cfg.InterpolateParams {
|
|
||||||
writeDSNParam(&buf, &hasParam, "interpolateParams", "true")
|
|
||||||
}
|
|
||||||
|
|
||||||
if cfg.Loc != time.UTC && cfg.Loc != nil {
|
|
||||||
writeDSNParam(&buf, &hasParam, "loc", url.QueryEscape(cfg.Loc.String()))
|
|
||||||
}
|
|
||||||
|
|
||||||
if cfg.MultiStatements {
|
|
||||||
writeDSNParam(&buf, &hasParam, "multiStatements", "true")
|
|
||||||
}
|
|
||||||
|
|
||||||
if cfg.ParseTime {
|
|
||||||
writeDSNParam(&buf, &hasParam, "parseTime", "true")
|
|
||||||
}
|
|
||||||
|
|
||||||
if cfg.ReadTimeout > 0 {
|
|
||||||
writeDSNParam(&buf, &hasParam, "readTimeout", cfg.ReadTimeout.String())
|
|
||||||
}
|
|
||||||
|
|
||||||
if cfg.RejectReadOnly {
|
|
||||||
writeDSNParam(&buf, &hasParam, "rejectReadOnly", "true")
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(cfg.ServerPubKey) > 0 {
|
|
||||||
writeDSNParam(&buf, &hasParam, "serverPubKey", url.QueryEscape(cfg.ServerPubKey))
|
|
||||||
}
|
|
||||||
|
|
||||||
if cfg.Timeout > 0 {
|
|
||||||
writeDSNParam(&buf, &hasParam, "timeout", cfg.Timeout.String())
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(cfg.TLSConfig) > 0 {
|
|
||||||
writeDSNParam(&buf, &hasParam, "tls", url.QueryEscape(cfg.TLSConfig))
|
|
||||||
}
|
|
||||||
|
|
||||||
if cfg.WriteTimeout > 0 {
|
|
||||||
writeDSNParam(&buf, &hasParam, "writeTimeout", cfg.WriteTimeout.String())
|
|
||||||
}
|
|
||||||
|
|
||||||
if cfg.MaxAllowedPacket != defaultMaxAllowedPacket {
|
|
||||||
writeDSNParam(&buf, &hasParam, "maxAllowedPacket", strconv.Itoa(cfg.MaxAllowedPacket))
|
|
||||||
}
|
|
||||||
|
|
||||||
// other params
|
|
||||||
if cfg.Params != nil {
|
|
||||||
var params []string
|
|
||||||
for param := range cfg.Params {
|
|
||||||
params = append(params, param)
|
|
||||||
}
|
|
||||||
sort.Strings(params)
|
|
||||||
for _, param := range params {
|
|
||||||
writeDSNParam(&buf, &hasParam, param, url.QueryEscape(cfg.Params[param]))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return buf.String()
|
|
||||||
}
|
|
||||||
|
|
||||||
// ParseDSN parses the DSN string to a Config
|
|
||||||
func ParseDSN(dsn string) (cfg *Config, err error) {
|
|
||||||
// New config with some default values
|
|
||||||
cfg = NewConfig()
|
|
||||||
|
|
||||||
// [user[:password]@][net[(addr)]]/dbname[?param1=value1¶mN=valueN]
|
|
||||||
// Find the last '/' (since the password or the net addr might contain a '/')
|
|
||||||
foundSlash := false
|
|
||||||
for i := len(dsn) - 1; i >= 0; i-- {
|
|
||||||
if dsn[i] == '/' {
|
|
||||||
foundSlash = true
|
|
||||||
var j, k int
|
|
||||||
|
|
||||||
// left part is empty if i <= 0
|
|
||||||
if i > 0 {
|
|
||||||
// [username[:password]@][protocol[(address)]]
|
|
||||||
// Find the last '@' in dsn[:i]
|
|
||||||
for j = i; j >= 0; j-- {
|
|
||||||
if dsn[j] == '@' {
|
|
||||||
// username[:password]
|
|
||||||
// Find the first ':' in dsn[:j]
|
|
||||||
for k = 0; k < j; k++ {
|
|
||||||
if dsn[k] == ':' {
|
|
||||||
cfg.Passwd = dsn[k+1 : j]
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
cfg.User = dsn[:k]
|
|
||||||
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// [protocol[(address)]]
|
|
||||||
// Find the first '(' in dsn[j+1:i]
|
|
||||||
for k = j + 1; k < i; k++ {
|
|
||||||
if dsn[k] == '(' {
|
|
||||||
// dsn[i-1] must be == ')' if an address is specified
|
|
||||||
if dsn[i-1] != ')' {
|
|
||||||
if strings.ContainsRune(dsn[k+1:i], ')') {
|
|
||||||
return nil, errInvalidDSNUnescaped
|
|
||||||
}
|
|
||||||
return nil, errInvalidDSNAddr
|
|
||||||
}
|
|
||||||
cfg.Addr = dsn[k+1 : i-1]
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
cfg.Net = dsn[j+1 : k]
|
|
||||||
}
|
|
||||||
|
|
||||||
// dbname[?param1=value1&...¶mN=valueN]
|
|
||||||
// Find the first '?' in dsn[i+1:]
|
|
||||||
for j = i + 1; j < len(dsn); j++ {
|
|
||||||
if dsn[j] == '?' {
|
|
||||||
if err = parseDSNParams(cfg, dsn[j+1:]); err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
cfg.DBName = dsn[i+1 : j]
|
|
||||||
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if !foundSlash && len(dsn) > 0 {
|
|
||||||
return nil, errInvalidDSNNoSlash
|
|
||||||
}
|
|
||||||
|
|
||||||
if err = cfg.normalize(); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// parseDSNParams parses the DSN "query string"
|
|
||||||
// Values must be url.QueryEscape'ed
|
|
||||||
func parseDSNParams(cfg *Config, params string) (err error) {
|
|
||||||
for _, v := range strings.Split(params, "&") {
|
|
||||||
param := strings.SplitN(v, "=", 2)
|
|
||||||
if len(param) != 2 {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
// cfg params
|
|
||||||
switch value := param[1]; param[0] {
|
|
||||||
// Disable INFILE allowlist / enable all files
|
|
||||||
case "allowAllFiles":
|
|
||||||
var isBool bool
|
|
||||||
cfg.AllowAllFiles, isBool = readBool(value)
|
|
||||||
if !isBool {
|
|
||||||
return errors.New("invalid bool value: " + value)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Use cleartext authentication mode (MySQL 5.5.10+)
|
|
||||||
case "allowCleartextPasswords":
|
|
||||||
var isBool bool
|
|
||||||
cfg.AllowCleartextPasswords, isBool = readBool(value)
|
|
||||||
if !isBool {
|
|
||||||
return errors.New("invalid bool value: " + value)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Use native password authentication
|
|
||||||
case "allowNativePasswords":
|
|
||||||
var isBool bool
|
|
||||||
cfg.AllowNativePasswords, isBool = readBool(value)
|
|
||||||
if !isBool {
|
|
||||||
return errors.New("invalid bool value: " + value)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Use old authentication mode (pre MySQL 4.1)
|
|
||||||
case "allowOldPasswords":
|
|
||||||
var isBool bool
|
|
||||||
cfg.AllowOldPasswords, isBool = readBool(value)
|
|
||||||
if !isBool {
|
|
||||||
return errors.New("invalid bool value: " + value)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Check connections for Liveness before using them
|
|
||||||
case "checkConnLiveness":
|
|
||||||
var isBool bool
|
|
||||||
cfg.CheckConnLiveness, isBool = readBool(value)
|
|
||||||
if !isBool {
|
|
||||||
return errors.New("invalid bool value: " + value)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Switch "rowsAffected" mode
|
|
||||||
case "clientFoundRows":
|
|
||||||
var isBool bool
|
|
||||||
cfg.ClientFoundRows, isBool = readBool(value)
|
|
||||||
if !isBool {
|
|
||||||
return errors.New("invalid bool value: " + value)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Collation
|
|
||||||
case "collation":
|
|
||||||
cfg.Collation = value
|
|
||||||
break
|
|
||||||
|
|
||||||
case "columnsWithAlias":
|
|
||||||
var isBool bool
|
|
||||||
cfg.ColumnsWithAlias, isBool = readBool(value)
|
|
||||||
if !isBool {
|
|
||||||
return errors.New("invalid bool value: " + value)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Compression
|
|
||||||
case "compress":
|
|
||||||
return errors.New("compression not implemented yet")
|
|
||||||
|
|
||||||
// Enable client side placeholder substitution
|
|
||||||
case "interpolateParams":
|
|
||||||
var isBool bool
|
|
||||||
cfg.InterpolateParams, isBool = readBool(value)
|
|
||||||
if !isBool {
|
|
||||||
return errors.New("invalid bool value: " + value)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Time Location
|
|
||||||
case "loc":
|
|
||||||
if value, err = url.QueryUnescape(value); err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
cfg.Loc, err = time.LoadLocation(value)
|
|
||||||
if err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// multiple statements in one query
|
|
||||||
case "multiStatements":
|
|
||||||
var isBool bool
|
|
||||||
cfg.MultiStatements, isBool = readBool(value)
|
|
||||||
if !isBool {
|
|
||||||
return errors.New("invalid bool value: " + value)
|
|
||||||
}
|
|
||||||
|
|
||||||
// time.Time parsing
|
|
||||||
case "parseTime":
|
|
||||||
var isBool bool
|
|
||||||
cfg.ParseTime, isBool = readBool(value)
|
|
||||||
if !isBool {
|
|
||||||
return errors.New("invalid bool value: " + value)
|
|
||||||
}
|
|
||||||
|
|
||||||
// I/O read Timeout
|
|
||||||
case "readTimeout":
|
|
||||||
cfg.ReadTimeout, err = time.ParseDuration(value)
|
|
||||||
if err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// Reject read-only connections
|
|
||||||
case "rejectReadOnly":
|
|
||||||
var isBool bool
|
|
||||||
cfg.RejectReadOnly, isBool = readBool(value)
|
|
||||||
if !isBool {
|
|
||||||
return errors.New("invalid bool value: " + value)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Server public key
|
|
||||||
case "serverPubKey":
|
|
||||||
name, err := url.QueryUnescape(value)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("invalid value for server pub key name: %v", err)
|
|
||||||
}
|
|
||||||
cfg.ServerPubKey = name
|
|
||||||
|
|
||||||
// Strict mode
|
|
||||||
case "strict":
|
|
||||||
panic("strict mode has been removed. See https://github.com/go-sql-driver/mysql/wiki/strict-mode")
|
|
||||||
|
|
||||||
// Dial Timeout
|
|
||||||
case "timeout":
|
|
||||||
cfg.Timeout, err = time.ParseDuration(value)
|
|
||||||
if err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// TLS-Encryption
|
|
||||||
case "tls":
|
|
||||||
boolValue, isBool := readBool(value)
|
|
||||||
if isBool {
|
|
||||||
if boolValue {
|
|
||||||
cfg.TLSConfig = "true"
|
|
||||||
} else {
|
|
||||||
cfg.TLSConfig = "false"
|
|
||||||
}
|
|
||||||
} else if vl := strings.ToLower(value); vl == "skip-verify" || vl == "preferred" {
|
|
||||||
cfg.TLSConfig = vl
|
|
||||||
} else {
|
|
||||||
name, err := url.QueryUnescape(value)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("invalid value for TLS config name: %v", err)
|
|
||||||
}
|
|
||||||
cfg.TLSConfig = name
|
|
||||||
}
|
|
||||||
|
|
||||||
// I/O write Timeout
|
|
||||||
case "writeTimeout":
|
|
||||||
cfg.WriteTimeout, err = time.ParseDuration(value)
|
|
||||||
if err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
case "maxAllowedPacket":
|
|
||||||
cfg.MaxAllowedPacket, err = strconv.Atoi(value)
|
|
||||||
if err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
default:
|
|
||||||
// lazy init
|
|
||||||
if cfg.Params == nil {
|
|
||||||
cfg.Params = make(map[string]string)
|
|
||||||
}
|
|
||||||
|
|
||||||
if cfg.Params[param[0]], err = url.QueryUnescape(value); err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
func ensureHavePort(addr string) string {
|
|
||||||
if _, _, err := net.SplitHostPort(addr); err != nil {
|
|
||||||
return net.JoinHostPort(addr, "3306")
|
|
||||||
}
|
|
||||||
return addr
|
|
||||||
}
|
|
@ -1,65 +0,0 @@
|
|||||||
// Go MySQL Driver - A MySQL-Driver for Go's database/sql package
|
|
||||||
//
|
|
||||||
// Copyright 2013 The Go-MySQL-Driver Authors. All rights reserved.
|
|
||||||
//
|
|
||||||
// This Source Code Form is subject to the terms of the Mozilla Public
|
|
||||||
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
||||||
// You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
||||||
|
|
||||||
package mysql
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"log"
|
|
||||||
"os"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Various errors the driver might return. Can change between driver versions.
|
|
||||||
var (
|
|
||||||
ErrInvalidConn = errors.New("invalid connection")
|
|
||||||
ErrMalformPkt = errors.New("malformed packet")
|
|
||||||
ErrNoTLS = errors.New("TLS requested but server does not support TLS")
|
|
||||||
ErrCleartextPassword = errors.New("this user requires clear text authentication. If you still want to use it, please add 'allowCleartextPasswords=1' to your DSN")
|
|
||||||
ErrNativePassword = errors.New("this user requires mysql native password authentication.")
|
|
||||||
ErrOldPassword = errors.New("this user requires old password authentication. If you still want to use it, please add 'allowOldPasswords=1' to your DSN. See also https://github.com/go-sql-driver/mysql/wiki/old_passwords")
|
|
||||||
ErrUnknownPlugin = errors.New("this authentication plugin is not supported")
|
|
||||||
ErrOldProtocol = errors.New("MySQL server does not support required protocol 41+")
|
|
||||||
ErrPktSync = errors.New("commands out of sync. You can't run this command now")
|
|
||||||
ErrPktSyncMul = errors.New("commands out of sync. Did you run multiple statements at once?")
|
|
||||||
ErrPktTooLarge = errors.New("packet for query is too large. Try adjusting the 'max_allowed_packet' variable on the server")
|
|
||||||
ErrBusyBuffer = errors.New("busy buffer")
|
|
||||||
|
|
||||||
// errBadConnNoWrite is used for connection errors where nothing was sent to the database yet.
|
|
||||||
// If this happens first in a function starting a database interaction, it should be replaced by driver.ErrBadConn
|
|
||||||
// to trigger a resend.
|
|
||||||
// See https://github.com/go-sql-driver/mysql/pull/302
|
|
||||||
errBadConnNoWrite = errors.New("bad connection")
|
|
||||||
)
|
|
||||||
|
|
||||||
var errLog = Logger(log.New(os.Stderr, "[mysql] ", log.Ldate|log.Ltime|log.Lshortfile))
|
|
||||||
|
|
||||||
// Logger is used to log critical error messages.
|
|
||||||
type Logger interface {
|
|
||||||
Print(v ...interface{})
|
|
||||||
}
|
|
||||||
|
|
||||||
// SetLogger is used to set the logger for critical errors.
|
|
||||||
// The initial logger is os.Stderr.
|
|
||||||
func SetLogger(logger Logger) error {
|
|
||||||
if logger == nil {
|
|
||||||
return errors.New("logger is nil")
|
|
||||||
}
|
|
||||||
errLog = logger
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// MySQLError is an error type which represents a single MySQL error
|
|
||||||
type MySQLError struct {
|
|
||||||
Number uint16
|
|
||||||
Message string
|
|
||||||
}
|
|
||||||
|
|
||||||
func (me *MySQLError) Error() string {
|
|
||||||
return fmt.Sprintf("Error %d: %s", me.Number, me.Message)
|
|
||||||
}
|
|
@ -1,194 +0,0 @@
|
|||||||
// Go MySQL Driver - A MySQL-Driver for Go's database/sql package
|
|
||||||
//
|
|
||||||
// Copyright 2017 The Go-MySQL-Driver Authors. All rights reserved.
|
|
||||||
//
|
|
||||||
// This Source Code Form is subject to the terms of the Mozilla Public
|
|
||||||
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
||||||
// You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
||||||
|
|
||||||
package mysql
|
|
||||||
|
|
||||||
import (
|
|
||||||
"database/sql"
|
|
||||||
"reflect"
|
|
||||||
)
|
|
||||||
|
|
||||||
func (mf *mysqlField) typeDatabaseName() string {
|
|
||||||
switch mf.fieldType {
|
|
||||||
case fieldTypeBit:
|
|
||||||
return "BIT"
|
|
||||||
case fieldTypeBLOB:
|
|
||||||
if mf.charSet != collations[binaryCollation] {
|
|
||||||
return "TEXT"
|
|
||||||
}
|
|
||||||
return "BLOB"
|
|
||||||
case fieldTypeDate:
|
|
||||||
return "DATE"
|
|
||||||
case fieldTypeDateTime:
|
|
||||||
return "DATETIME"
|
|
||||||
case fieldTypeDecimal:
|
|
||||||
return "DECIMAL"
|
|
||||||
case fieldTypeDouble:
|
|
||||||
return "DOUBLE"
|
|
||||||
case fieldTypeEnum:
|
|
||||||
return "ENUM"
|
|
||||||
case fieldTypeFloat:
|
|
||||||
return "FLOAT"
|
|
||||||
case fieldTypeGeometry:
|
|
||||||
return "GEOMETRY"
|
|
||||||
case fieldTypeInt24:
|
|
||||||
return "MEDIUMINT"
|
|
||||||
case fieldTypeJSON:
|
|
||||||
return "JSON"
|
|
||||||
case fieldTypeLong:
|
|
||||||
return "INT"
|
|
||||||
case fieldTypeLongBLOB:
|
|
||||||
if mf.charSet != collations[binaryCollation] {
|
|
||||||
return "LONGTEXT"
|
|
||||||
}
|
|
||||||
return "LONGBLOB"
|
|
||||||
case fieldTypeLongLong:
|
|
||||||
return "BIGINT"
|
|
||||||
case fieldTypeMediumBLOB:
|
|
||||||
if mf.charSet != collations[binaryCollation] {
|
|
||||||
return "MEDIUMTEXT"
|
|
||||||
}
|
|
||||||
return "MEDIUMBLOB"
|
|
||||||
case fieldTypeNewDate:
|
|
||||||
return "DATE"
|
|
||||||
case fieldTypeNewDecimal:
|
|
||||||
return "DECIMAL"
|
|
||||||
case fieldTypeNULL:
|
|
||||||
return "NULL"
|
|
||||||
case fieldTypeSet:
|
|
||||||
return "SET"
|
|
||||||
case fieldTypeShort:
|
|
||||||
return "SMALLINT"
|
|
||||||
case fieldTypeString:
|
|
||||||
if mf.charSet == collations[binaryCollation] {
|
|
||||||
return "BINARY"
|
|
||||||
}
|
|
||||||
return "CHAR"
|
|
||||||
case fieldTypeTime:
|
|
||||||
return "TIME"
|
|
||||||
case fieldTypeTimestamp:
|
|
||||||
return "TIMESTAMP"
|
|
||||||
case fieldTypeTiny:
|
|
||||||
return "TINYINT"
|
|
||||||
case fieldTypeTinyBLOB:
|
|
||||||
if mf.charSet != collations[binaryCollation] {
|
|
||||||
return "TINYTEXT"
|
|
||||||
}
|
|
||||||
return "TINYBLOB"
|
|
||||||
case fieldTypeVarChar:
|
|
||||||
if mf.charSet == collations[binaryCollation] {
|
|
||||||
return "VARBINARY"
|
|
||||||
}
|
|
||||||
return "VARCHAR"
|
|
||||||
case fieldTypeVarString:
|
|
||||||
if mf.charSet == collations[binaryCollation] {
|
|
||||||
return "VARBINARY"
|
|
||||||
}
|
|
||||||
return "VARCHAR"
|
|
||||||
case fieldTypeYear:
|
|
||||||
return "YEAR"
|
|
||||||
default:
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
var (
|
|
||||||
scanTypeFloat32 = reflect.TypeOf(float32(0))
|
|
||||||
scanTypeFloat64 = reflect.TypeOf(float64(0))
|
|
||||||
scanTypeInt8 = reflect.TypeOf(int8(0))
|
|
||||||
scanTypeInt16 = reflect.TypeOf(int16(0))
|
|
||||||
scanTypeInt32 = reflect.TypeOf(int32(0))
|
|
||||||
scanTypeInt64 = reflect.TypeOf(int64(0))
|
|
||||||
scanTypeNullFloat = reflect.TypeOf(sql.NullFloat64{})
|
|
||||||
scanTypeNullInt = reflect.TypeOf(sql.NullInt64{})
|
|
||||||
scanTypeNullTime = reflect.TypeOf(nullTime{})
|
|
||||||
scanTypeUint8 = reflect.TypeOf(uint8(0))
|
|
||||||
scanTypeUint16 = reflect.TypeOf(uint16(0))
|
|
||||||
scanTypeUint32 = reflect.TypeOf(uint32(0))
|
|
||||||
scanTypeUint64 = reflect.TypeOf(uint64(0))
|
|
||||||
scanTypeRawBytes = reflect.TypeOf(sql.RawBytes{})
|
|
||||||
scanTypeUnknown = reflect.TypeOf(new(interface{}))
|
|
||||||
)
|
|
||||||
|
|
||||||
type mysqlField struct {
|
|
||||||
tableName string
|
|
||||||
name string
|
|
||||||
length uint32
|
|
||||||
flags fieldFlag
|
|
||||||
fieldType fieldType
|
|
||||||
decimals byte
|
|
||||||
charSet uint8
|
|
||||||
}
|
|
||||||
|
|
||||||
func (mf *mysqlField) scanType() reflect.Type {
|
|
||||||
switch mf.fieldType {
|
|
||||||
case fieldTypeTiny:
|
|
||||||
if mf.flags&flagNotNULL != 0 {
|
|
||||||
if mf.flags&flagUnsigned != 0 {
|
|
||||||
return scanTypeUint8
|
|
||||||
}
|
|
||||||
return scanTypeInt8
|
|
||||||
}
|
|
||||||
return scanTypeNullInt
|
|
||||||
|
|
||||||
case fieldTypeShort, fieldTypeYear:
|
|
||||||
if mf.flags&flagNotNULL != 0 {
|
|
||||||
if mf.flags&flagUnsigned != 0 {
|
|
||||||
return scanTypeUint16
|
|
||||||
}
|
|
||||||
return scanTypeInt16
|
|
||||||
}
|
|
||||||
return scanTypeNullInt
|
|
||||||
|
|
||||||
case fieldTypeInt24, fieldTypeLong:
|
|
||||||
if mf.flags&flagNotNULL != 0 {
|
|
||||||
if mf.flags&flagUnsigned != 0 {
|
|
||||||
return scanTypeUint32
|
|
||||||
}
|
|
||||||
return scanTypeInt32
|
|
||||||
}
|
|
||||||
return scanTypeNullInt
|
|
||||||
|
|
||||||
case fieldTypeLongLong:
|
|
||||||
if mf.flags&flagNotNULL != 0 {
|
|
||||||
if mf.flags&flagUnsigned != 0 {
|
|
||||||
return scanTypeUint64
|
|
||||||
}
|
|
||||||
return scanTypeInt64
|
|
||||||
}
|
|
||||||
return scanTypeNullInt
|
|
||||||
|
|
||||||
case fieldTypeFloat:
|
|
||||||
if mf.flags&flagNotNULL != 0 {
|
|
||||||
return scanTypeFloat32
|
|
||||||
}
|
|
||||||
return scanTypeNullFloat
|
|
||||||
|
|
||||||
case fieldTypeDouble:
|
|
||||||
if mf.flags&flagNotNULL != 0 {
|
|
||||||
return scanTypeFloat64
|
|
||||||
}
|
|
||||||
return scanTypeNullFloat
|
|
||||||
|
|
||||||
case fieldTypeDecimal, fieldTypeNewDecimal, fieldTypeVarChar,
|
|
||||||
fieldTypeBit, fieldTypeEnum, fieldTypeSet, fieldTypeTinyBLOB,
|
|
||||||
fieldTypeMediumBLOB, fieldTypeLongBLOB, fieldTypeBLOB,
|
|
||||||
fieldTypeVarString, fieldTypeString, fieldTypeGeometry, fieldTypeJSON,
|
|
||||||
fieldTypeTime:
|
|
||||||
return scanTypeRawBytes
|
|
||||||
|
|
||||||
case fieldTypeDate, fieldTypeNewDate,
|
|
||||||
fieldTypeTimestamp, fieldTypeDateTime:
|
|
||||||
// NullTime is always returned for more consistent behavior as it can
|
|
||||||
// handle both cases of parseTime regardless if the field is nullable.
|
|
||||||
return scanTypeNullTime
|
|
||||||
|
|
||||||
default:
|
|
||||||
return scanTypeUnknown
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,24 +0,0 @@
|
|||||||
// Go MySQL Driver - A MySQL-Driver for Go's database/sql package.
|
|
||||||
//
|
|
||||||
// Copyright 2020 The Go-MySQL-Driver Authors. All rights reserved.
|
|
||||||
//
|
|
||||||
// This Source Code Form is subject to the terms of the Mozilla Public
|
|
||||||
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
||||||
// You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
||||||
|
|
||||||
// +build gofuzz
|
|
||||||
|
|
||||||
package mysql
|
|
||||||
|
|
||||||
import (
|
|
||||||
"database/sql"
|
|
||||||
)
|
|
||||||
|
|
||||||
func Fuzz(data []byte) int {
|
|
||||||
db, err := sql.Open("mysql", string(data))
|
|
||||||
if err != nil {
|
|
||||||
return 0
|
|
||||||
}
|
|
||||||
db.Close()
|
|
||||||
return 1
|
|
||||||
}
|
|
@ -1,182 +0,0 @@
|
|||||||
// Go MySQL Driver - A MySQL-Driver for Go's database/sql package
|
|
||||||
//
|
|
||||||
// Copyright 2013 The Go-MySQL-Driver Authors. All rights reserved.
|
|
||||||
//
|
|
||||||
// This Source Code Form is subject to the terms of the Mozilla Public
|
|
||||||
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
||||||
// You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
||||||
|
|
||||||
package mysql
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"os"
|
|
||||||
"strings"
|
|
||||||
"sync"
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
fileRegister map[string]bool
|
|
||||||
fileRegisterLock sync.RWMutex
|
|
||||||
readerRegister map[string]func() io.Reader
|
|
||||||
readerRegisterLock sync.RWMutex
|
|
||||||
)
|
|
||||||
|
|
||||||
// RegisterLocalFile adds the given file to the file allowlist,
|
|
||||||
// so that it can be used by "LOAD DATA LOCAL INFILE <filepath>".
|
|
||||||
// Alternatively you can allow the use of all local files with
|
|
||||||
// the DSN parameter 'allowAllFiles=true'
|
|
||||||
//
|
|
||||||
// filePath := "/home/gopher/data.csv"
|
|
||||||
// mysql.RegisterLocalFile(filePath)
|
|
||||||
// err := db.Exec("LOAD DATA LOCAL INFILE '" + filePath + "' INTO TABLE foo")
|
|
||||||
// if err != nil {
|
|
||||||
// ...
|
|
||||||
//
|
|
||||||
func RegisterLocalFile(filePath string) {
|
|
||||||
fileRegisterLock.Lock()
|
|
||||||
// lazy map init
|
|
||||||
if fileRegister == nil {
|
|
||||||
fileRegister = make(map[string]bool)
|
|
||||||
}
|
|
||||||
|
|
||||||
fileRegister[strings.Trim(filePath, `"`)] = true
|
|
||||||
fileRegisterLock.Unlock()
|
|
||||||
}
|
|
||||||
|
|
||||||
// DeregisterLocalFile removes the given filepath from the allowlist.
|
|
||||||
func DeregisterLocalFile(filePath string) {
|
|
||||||
fileRegisterLock.Lock()
|
|
||||||
delete(fileRegister, strings.Trim(filePath, `"`))
|
|
||||||
fileRegisterLock.Unlock()
|
|
||||||
}
|
|
||||||
|
|
||||||
// RegisterReaderHandler registers a handler function which is used
|
|
||||||
// to receive a io.Reader.
|
|
||||||
// The Reader can be used by "LOAD DATA LOCAL INFILE Reader::<name>".
|
|
||||||
// If the handler returns a io.ReadCloser Close() is called when the
|
|
||||||
// request is finished.
|
|
||||||
//
|
|
||||||
// mysql.RegisterReaderHandler("data", func() io.Reader {
|
|
||||||
// var csvReader io.Reader // Some Reader that returns CSV data
|
|
||||||
// ... // Open Reader here
|
|
||||||
// return csvReader
|
|
||||||
// })
|
|
||||||
// err := db.Exec("LOAD DATA LOCAL INFILE 'Reader::data' INTO TABLE foo")
|
|
||||||
// if err != nil {
|
|
||||||
// ...
|
|
||||||
//
|
|
||||||
func RegisterReaderHandler(name string, handler func() io.Reader) {
|
|
||||||
readerRegisterLock.Lock()
|
|
||||||
// lazy map init
|
|
||||||
if readerRegister == nil {
|
|
||||||
readerRegister = make(map[string]func() io.Reader)
|
|
||||||
}
|
|
||||||
|
|
||||||
readerRegister[name] = handler
|
|
||||||
readerRegisterLock.Unlock()
|
|
||||||
}
|
|
||||||
|
|
||||||
// DeregisterReaderHandler removes the ReaderHandler function with
|
|
||||||
// the given name from the registry.
|
|
||||||
func DeregisterReaderHandler(name string) {
|
|
||||||
readerRegisterLock.Lock()
|
|
||||||
delete(readerRegister, name)
|
|
||||||
readerRegisterLock.Unlock()
|
|
||||||
}
|
|
||||||
|
|
||||||
func deferredClose(err *error, closer io.Closer) {
|
|
||||||
closeErr := closer.Close()
|
|
||||||
if *err == nil {
|
|
||||||
*err = closeErr
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (mc *mysqlConn) handleInFileRequest(name string) (err error) {
|
|
||||||
var rdr io.Reader
|
|
||||||
var data []byte
|
|
||||||
packetSize := 16 * 1024 // 16KB is small enough for disk readahead and large enough for TCP
|
|
||||||
if mc.maxWriteSize < packetSize {
|
|
||||||
packetSize = mc.maxWriteSize
|
|
||||||
}
|
|
||||||
|
|
||||||
if idx := strings.Index(name, "Reader::"); idx == 0 || (idx > 0 && name[idx-1] == '/') { // io.Reader
|
|
||||||
// The server might return an an absolute path. See issue #355.
|
|
||||||
name = name[idx+8:]
|
|
||||||
|
|
||||||
readerRegisterLock.RLock()
|
|
||||||
handler, inMap := readerRegister[name]
|
|
||||||
readerRegisterLock.RUnlock()
|
|
||||||
|
|
||||||
if inMap {
|
|
||||||
rdr = handler()
|
|
||||||
if rdr != nil {
|
|
||||||
if cl, ok := rdr.(io.Closer); ok {
|
|
||||||
defer deferredClose(&err, cl)
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
err = fmt.Errorf("Reader '%s' is <nil>", name)
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
err = fmt.Errorf("Reader '%s' is not registered", name)
|
|
||||||
}
|
|
||||||
} else { // File
|
|
||||||
name = strings.Trim(name, `"`)
|
|
||||||
fileRegisterLock.RLock()
|
|
||||||
fr := fileRegister[name]
|
|
||||||
fileRegisterLock.RUnlock()
|
|
||||||
if mc.cfg.AllowAllFiles || fr {
|
|
||||||
var file *os.File
|
|
||||||
var fi os.FileInfo
|
|
||||||
|
|
||||||
if file, err = os.Open(name); err == nil {
|
|
||||||
defer deferredClose(&err, file)
|
|
||||||
|
|
||||||
// get file size
|
|
||||||
if fi, err = file.Stat(); err == nil {
|
|
||||||
rdr = file
|
|
||||||
if fileSize := int(fi.Size()); fileSize < packetSize {
|
|
||||||
packetSize = fileSize
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
err = fmt.Errorf("local file '%s' is not registered", name)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// send content packets
|
|
||||||
// if packetSize == 0, the Reader contains no data
|
|
||||||
if err == nil && packetSize > 0 {
|
|
||||||
data := make([]byte, 4+packetSize)
|
|
||||||
var n int
|
|
||||||
for err == nil {
|
|
||||||
n, err = rdr.Read(data[4:])
|
|
||||||
if n > 0 {
|
|
||||||
if ioErr := mc.writePacket(data[:4+n]); ioErr != nil {
|
|
||||||
return ioErr
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if err == io.EOF {
|
|
||||||
err = nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// send empty packet (termination)
|
|
||||||
if data == nil {
|
|
||||||
data = make([]byte, 4)
|
|
||||||
}
|
|
||||||
if ioErr := mc.writePacket(data[:4]); ioErr != nil {
|
|
||||||
return ioErr
|
|
||||||
}
|
|
||||||
|
|
||||||
// read OK packet
|
|
||||||
if err == nil {
|
|
||||||
return mc.readResultOK()
|
|
||||||
}
|
|
||||||
|
|
||||||
mc.readPacket()
|
|
||||||
return err
|
|
||||||
}
|
|
@ -1,50 +0,0 @@
|
|||||||
// Go MySQL Driver - A MySQL-Driver for Go's database/sql package
|
|
||||||
//
|
|
||||||
// Copyright 2013 The Go-MySQL-Driver Authors. All rights reserved.
|
|
||||||
//
|
|
||||||
// This Source Code Form is subject to the terms of the Mozilla Public
|
|
||||||
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
||||||
// You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
||||||
|
|
||||||
package mysql
|
|
||||||
|
|
||||||
import (
|
|
||||||
"database/sql/driver"
|
|
||||||
"fmt"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Scan implements the Scanner interface.
|
|
||||||
// The value type must be time.Time or string / []byte (formatted time-string),
|
|
||||||
// otherwise Scan fails.
|
|
||||||
func (nt *NullTime) Scan(value interface{}) (err error) {
|
|
||||||
if value == nil {
|
|
||||||
nt.Time, nt.Valid = time.Time{}, false
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
switch v := value.(type) {
|
|
||||||
case time.Time:
|
|
||||||
nt.Time, nt.Valid = v, true
|
|
||||||
return
|
|
||||||
case []byte:
|
|
||||||
nt.Time, err = parseDateTime(v, time.UTC)
|
|
||||||
nt.Valid = (err == nil)
|
|
||||||
return
|
|
||||||
case string:
|
|
||||||
nt.Time, err = parseDateTime([]byte(v), time.UTC)
|
|
||||||
nt.Valid = (err == nil)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
nt.Valid = false
|
|
||||||
return fmt.Errorf("Can't convert %T to time.Time", value)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Value implements the driver Valuer interface.
|
|
||||||
func (nt NullTime) Value() (driver.Value, error) {
|
|
||||||
if !nt.Valid {
|
|
||||||
return nil, nil
|
|
||||||
}
|
|
||||||
return nt.Time, nil
|
|
||||||
}
|
|
@ -1,40 +0,0 @@
|
|||||||
// Go MySQL Driver - A MySQL-Driver for Go's database/sql package
|
|
||||||
//
|
|
||||||
// Copyright 2013 The Go-MySQL-Driver Authors. All rights reserved.
|
|
||||||
//
|
|
||||||
// This Source Code Form is subject to the terms of the Mozilla Public
|
|
||||||
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
||||||
// You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
||||||
|
|
||||||
// +build go1.13
|
|
||||||
|
|
||||||
package mysql
|
|
||||||
|
|
||||||
import (
|
|
||||||
"database/sql"
|
|
||||||
)
|
|
||||||
|
|
||||||
// NullTime represents a time.Time that may be NULL.
|
|
||||||
// NullTime implements the Scanner interface so
|
|
||||||
// it can be used as a scan destination:
|
|
||||||
//
|
|
||||||
// var nt NullTime
|
|
||||||
// err := db.QueryRow("SELECT time FROM foo WHERE id=?", id).Scan(&nt)
|
|
||||||
// ...
|
|
||||||
// if nt.Valid {
|
|
||||||
// // use nt.Time
|
|
||||||
// } else {
|
|
||||||
// // NULL value
|
|
||||||
// }
|
|
||||||
//
|
|
||||||
// This NullTime implementation is not driver-specific
|
|
||||||
//
|
|
||||||
// Deprecated: NullTime doesn't honor the loc DSN parameter.
|
|
||||||
// NullTime.Scan interprets a time as UTC, not the loc DSN parameter.
|
|
||||||
// Use sql.NullTime instead.
|
|
||||||
type NullTime sql.NullTime
|
|
||||||
|
|
||||||
// for internal use.
|
|
||||||
// the mysql package uses sql.NullTime if it is available.
|
|
||||||
// if not, the package uses mysql.NullTime.
|
|
||||||
type nullTime = sql.NullTime // sql.NullTime is available
|
|
@ -1,39 +0,0 @@
|
|||||||
// Go MySQL Driver - A MySQL-Driver for Go's database/sql package
|
|
||||||
//
|
|
||||||
// Copyright 2013 The Go-MySQL-Driver Authors. All rights reserved.
|
|
||||||
//
|
|
||||||
// This Source Code Form is subject to the terms of the Mozilla Public
|
|
||||||
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
||||||
// You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
||||||
|
|
||||||
// +build !go1.13
|
|
||||||
|
|
||||||
package mysql
|
|
||||||
|
|
||||||
import (
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
// NullTime represents a time.Time that may be NULL.
|
|
||||||
// NullTime implements the Scanner interface so
|
|
||||||
// it can be used as a scan destination:
|
|
||||||
//
|
|
||||||
// var nt NullTime
|
|
||||||
// err := db.QueryRow("SELECT time FROM foo WHERE id=?", id).Scan(&nt)
|
|
||||||
// ...
|
|
||||||
// if nt.Valid {
|
|
||||||
// // use nt.Time
|
|
||||||
// } else {
|
|
||||||
// // NULL value
|
|
||||||
// }
|
|
||||||
//
|
|
||||||
// This NullTime implementation is not driver-specific
|
|
||||||
type NullTime struct {
|
|
||||||
Time time.Time
|
|
||||||
Valid bool // Valid is true if Time is not NULL
|
|
||||||
}
|
|
||||||
|
|
||||||
// for internal use.
|
|
||||||
// the mysql package uses sql.NullTime if it is available.
|
|
||||||
// if not, the package uses mysql.NullTime.
|
|
||||||
type nullTime = NullTime // sql.NullTime is not available
|
|
File diff suppressed because it is too large
Load Diff
@ -1,22 +0,0 @@
|
|||||||
// Go MySQL Driver - A MySQL-Driver for Go's database/sql package
|
|
||||||
//
|
|
||||||
// Copyright 2012 The Go-MySQL-Driver Authors. All rights reserved.
|
|
||||||
//
|
|
||||||
// This Source Code Form is subject to the terms of the Mozilla Public
|
|
||||||
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
||||||
// You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
||||||
|
|
||||||
package mysql
|
|
||||||
|
|
||||||
type mysqlResult struct {
|
|
||||||
affectedRows int64
|
|
||||||
insertId int64
|
|
||||||
}
|
|
||||||
|
|
||||||
func (res *mysqlResult) LastInsertId() (int64, error) {
|
|
||||||
return res.insertId, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (res *mysqlResult) RowsAffected() (int64, error) {
|
|
||||||
return res.affectedRows, nil
|
|
||||||
}
|
|
@ -1,223 +0,0 @@
|
|||||||
// Go MySQL Driver - A MySQL-Driver for Go's database/sql package
|
|
||||||
//
|
|
||||||
// Copyright 2012 The Go-MySQL-Driver Authors. All rights reserved.
|
|
||||||
//
|
|
||||||
// This Source Code Form is subject to the terms of the Mozilla Public
|
|
||||||
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
||||||
// You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
||||||
|
|
||||||
package mysql
|
|
||||||
|
|
||||||
import (
|
|
||||||
"database/sql/driver"
|
|
||||||
"io"
|
|
||||||
"math"
|
|
||||||
"reflect"
|
|
||||||
)
|
|
||||||
|
|
||||||
type resultSet struct {
|
|
||||||
columns []mysqlField
|
|
||||||
columnNames []string
|
|
||||||
done bool
|
|
||||||
}
|
|
||||||
|
|
||||||
type mysqlRows struct {
|
|
||||||
mc *mysqlConn
|
|
||||||
rs resultSet
|
|
||||||
finish func()
|
|
||||||
}
|
|
||||||
|
|
||||||
type binaryRows struct {
|
|
||||||
mysqlRows
|
|
||||||
}
|
|
||||||
|
|
||||||
type textRows struct {
|
|
||||||
mysqlRows
|
|
||||||
}
|
|
||||||
|
|
||||||
func (rows *mysqlRows) Columns() []string {
|
|
||||||
if rows.rs.columnNames != nil {
|
|
||||||
return rows.rs.columnNames
|
|
||||||
}
|
|
||||||
|
|
||||||
columns := make([]string, len(rows.rs.columns))
|
|
||||||
if rows.mc != nil && rows.mc.cfg.ColumnsWithAlias {
|
|
||||||
for i := range columns {
|
|
||||||
if tableName := rows.rs.columns[i].tableName; len(tableName) > 0 {
|
|
||||||
columns[i] = tableName + "." + rows.rs.columns[i].name
|
|
||||||
} else {
|
|
||||||
columns[i] = rows.rs.columns[i].name
|
|
||||||
}
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
for i := range columns {
|
|
||||||
columns[i] = rows.rs.columns[i].name
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
rows.rs.columnNames = columns
|
|
||||||
return columns
|
|
||||||
}
|
|
||||||
|
|
||||||
func (rows *mysqlRows) ColumnTypeDatabaseTypeName(i int) string {
|
|
||||||
return rows.rs.columns[i].typeDatabaseName()
|
|
||||||
}
|
|
||||||
|
|
||||||
// func (rows *mysqlRows) ColumnTypeLength(i int) (length int64, ok bool) {
|
|
||||||
// return int64(rows.rs.columns[i].length), true
|
|
||||||
// }
|
|
||||||
|
|
||||||
func (rows *mysqlRows) ColumnTypeNullable(i int) (nullable, ok bool) {
|
|
||||||
return rows.rs.columns[i].flags&flagNotNULL == 0, true
|
|
||||||
}
|
|
||||||
|
|
||||||
func (rows *mysqlRows) ColumnTypePrecisionScale(i int) (int64, int64, bool) {
|
|
||||||
column := rows.rs.columns[i]
|
|
||||||
decimals := int64(column.decimals)
|
|
||||||
|
|
||||||
switch column.fieldType {
|
|
||||||
case fieldTypeDecimal, fieldTypeNewDecimal:
|
|
||||||
if decimals > 0 {
|
|
||||||
return int64(column.length) - 2, decimals, true
|
|
||||||
}
|
|
||||||
return int64(column.length) - 1, decimals, true
|
|
||||||
case fieldTypeTimestamp, fieldTypeDateTime, fieldTypeTime:
|
|
||||||
return decimals, decimals, true
|
|
||||||
case fieldTypeFloat, fieldTypeDouble:
|
|
||||||
if decimals == 0x1f {
|
|
||||||
return math.MaxInt64, math.MaxInt64, true
|
|
||||||
}
|
|
||||||
return math.MaxInt64, decimals, true
|
|
||||||
}
|
|
||||||
|
|
||||||
return 0, 0, false
|
|
||||||
}
|
|
||||||
|
|
||||||
func (rows *mysqlRows) ColumnTypeScanType(i int) reflect.Type {
|
|
||||||
return rows.rs.columns[i].scanType()
|
|
||||||
}
|
|
||||||
|
|
||||||
func (rows *mysqlRows) Close() (err error) {
|
|
||||||
if f := rows.finish; f != nil {
|
|
||||||
f()
|
|
||||||
rows.finish = nil
|
|
||||||
}
|
|
||||||
|
|
||||||
mc := rows.mc
|
|
||||||
if mc == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
if err := mc.error(); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
// flip the buffer for this connection if we need to drain it.
|
|
||||||
// note that for a successful query (i.e. one where rows.next()
|
|
||||||
// has been called until it returns false), `rows.mc` will be nil
|
|
||||||
// by the time the user calls `(*Rows).Close`, so we won't reach this
|
|
||||||
// see: https://github.com/golang/go/commit/651ddbdb5056ded455f47f9c494c67b389622a47
|
|
||||||
mc.buf.flip()
|
|
||||||
|
|
||||||
// Remove unread packets from stream
|
|
||||||
if !rows.rs.done {
|
|
||||||
err = mc.readUntilEOF()
|
|
||||||
}
|
|
||||||
if err == nil {
|
|
||||||
if err = mc.discardResults(); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
rows.mc = nil
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
func (rows *mysqlRows) HasNextResultSet() (b bool) {
|
|
||||||
if rows.mc == nil {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
return rows.mc.status&statusMoreResultsExists != 0
|
|
||||||
}
|
|
||||||
|
|
||||||
func (rows *mysqlRows) nextResultSet() (int, error) {
|
|
||||||
if rows.mc == nil {
|
|
||||||
return 0, io.EOF
|
|
||||||
}
|
|
||||||
if err := rows.mc.error(); err != nil {
|
|
||||||
return 0, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Remove unread packets from stream
|
|
||||||
if !rows.rs.done {
|
|
||||||
if err := rows.mc.readUntilEOF(); err != nil {
|
|
||||||
return 0, err
|
|
||||||
}
|
|
||||||
rows.rs.done = true
|
|
||||||
}
|
|
||||||
|
|
||||||
if !rows.HasNextResultSet() {
|
|
||||||
rows.mc = nil
|
|
||||||
return 0, io.EOF
|
|
||||||
}
|
|
||||||
rows.rs = resultSet{}
|
|
||||||
return rows.mc.readResultSetHeaderPacket()
|
|
||||||
}
|
|
||||||
|
|
||||||
func (rows *mysqlRows) nextNotEmptyResultSet() (int, error) {
|
|
||||||
for {
|
|
||||||
resLen, err := rows.nextResultSet()
|
|
||||||
if err != nil {
|
|
||||||
return 0, err
|
|
||||||
}
|
|
||||||
|
|
||||||
if resLen > 0 {
|
|
||||||
return resLen, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
rows.rs.done = true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (rows *binaryRows) NextResultSet() error {
|
|
||||||
resLen, err := rows.nextNotEmptyResultSet()
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
rows.rs.columns, err = rows.mc.readColumns(resLen)
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
func (rows *binaryRows) Next(dest []driver.Value) error {
|
|
||||||
if mc := rows.mc; mc != nil {
|
|
||||||
if err := mc.error(); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Fetch next row from stream
|
|
||||||
return rows.readRow(dest)
|
|
||||||
}
|
|
||||||
return io.EOF
|
|
||||||
}
|
|
||||||
|
|
||||||
func (rows *textRows) NextResultSet() (err error) {
|
|
||||||
resLen, err := rows.nextNotEmptyResultSet()
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
rows.rs.columns, err = rows.mc.readColumns(resLen)
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
func (rows *textRows) Next(dest []driver.Value) error {
|
|
||||||
if mc := rows.mc; mc != nil {
|
|
||||||
if err := mc.error(); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Fetch next row from stream
|
|
||||||
return rows.readRow(dest)
|
|
||||||
}
|
|
||||||
return io.EOF
|
|
||||||
}
|
|
@ -1,220 +0,0 @@
|
|||||||
// Go MySQL Driver - A MySQL-Driver for Go's database/sql package
|
|
||||||
//
|
|
||||||
// Copyright 2012 The Go-MySQL-Driver Authors. All rights reserved.
|
|
||||||
//
|
|
||||||
// This Source Code Form is subject to the terms of the Mozilla Public
|
|
||||||
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
||||||
// You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
||||||
|
|
||||||
package mysql
|
|
||||||
|
|
||||||
import (
|
|
||||||
"database/sql/driver"
|
|
||||||
"encoding/json"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"reflect"
|
|
||||||
)
|
|
||||||
|
|
||||||
type mysqlStmt struct {
|
|
||||||
mc *mysqlConn
|
|
||||||
id uint32
|
|
||||||
paramCount int
|
|
||||||
}
|
|
||||||
|
|
||||||
func (stmt *mysqlStmt) Close() error {
|
|
||||||
if stmt.mc == nil || stmt.mc.closed.IsSet() {
|
|
||||||
// driver.Stmt.Close can be called more than once, thus this function
|
|
||||||
// has to be idempotent.
|
|
||||||
// See also Issue #450 and golang/go#16019.
|
|
||||||
//errLog.Print(ErrInvalidConn)
|
|
||||||
return driver.ErrBadConn
|
|
||||||
}
|
|
||||||
|
|
||||||
err := stmt.mc.writeCommandPacketUint32(comStmtClose, stmt.id)
|
|
||||||
stmt.mc = nil
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
func (stmt *mysqlStmt) NumInput() int {
|
|
||||||
return stmt.paramCount
|
|
||||||
}
|
|
||||||
|
|
||||||
func (stmt *mysqlStmt) ColumnConverter(idx int) driver.ValueConverter {
|
|
||||||
return converter{}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (stmt *mysqlStmt) CheckNamedValue(nv *driver.NamedValue) (err error) {
|
|
||||||
nv.Value, err = converter{}.ConvertValue(nv.Value)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
func (stmt *mysqlStmt) Exec(args []driver.Value) (driver.Result, error) {
|
|
||||||
if stmt.mc.closed.IsSet() {
|
|
||||||
errLog.Print(ErrInvalidConn)
|
|
||||||
return nil, driver.ErrBadConn
|
|
||||||
}
|
|
||||||
// Send command
|
|
||||||
err := stmt.writeExecutePacket(args)
|
|
||||||
if err != nil {
|
|
||||||
return nil, stmt.mc.markBadConn(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
mc := stmt.mc
|
|
||||||
|
|
||||||
mc.affectedRows = 0
|
|
||||||
mc.insertId = 0
|
|
||||||
|
|
||||||
// Read Result
|
|
||||||
resLen, err := mc.readResultSetHeaderPacket()
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
if resLen > 0 {
|
|
||||||
// Columns
|
|
||||||
if err = mc.readUntilEOF(); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Rows
|
|
||||||
if err := mc.readUntilEOF(); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := mc.discardResults(); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
return &mysqlResult{
|
|
||||||
affectedRows: int64(mc.affectedRows),
|
|
||||||
insertId: int64(mc.insertId),
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (stmt *mysqlStmt) Query(args []driver.Value) (driver.Rows, error) {
|
|
||||||
return stmt.query(args)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (stmt *mysqlStmt) query(args []driver.Value) (*binaryRows, error) {
|
|
||||||
if stmt.mc.closed.IsSet() {
|
|
||||||
errLog.Print(ErrInvalidConn)
|
|
||||||
return nil, driver.ErrBadConn
|
|
||||||
}
|
|
||||||
// Send command
|
|
||||||
err := stmt.writeExecutePacket(args)
|
|
||||||
if err != nil {
|
|
||||||
return nil, stmt.mc.markBadConn(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
mc := stmt.mc
|
|
||||||
|
|
||||||
// Read Result
|
|
||||||
resLen, err := mc.readResultSetHeaderPacket()
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
rows := new(binaryRows)
|
|
||||||
|
|
||||||
if resLen > 0 {
|
|
||||||
rows.mc = mc
|
|
||||||
rows.rs.columns, err = mc.readColumns(resLen)
|
|
||||||
} else {
|
|
||||||
rows.rs.done = true
|
|
||||||
|
|
||||||
switch err := rows.NextResultSet(); err {
|
|
||||||
case nil, io.EOF:
|
|
||||||
return rows, nil
|
|
||||||
default:
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return rows, err
|
|
||||||
}
|
|
||||||
|
|
||||||
var jsonType = reflect.TypeOf(json.RawMessage{})
|
|
||||||
|
|
||||||
type converter struct{}
|
|
||||||
|
|
||||||
// ConvertValue mirrors the reference/default converter in database/sql/driver
|
|
||||||
// with _one_ exception. We support uint64 with their high bit and the default
|
|
||||||
// implementation does not. This function should be kept in sync with
|
|
||||||
// database/sql/driver defaultConverter.ConvertValue() except for that
|
|
||||||
// deliberate difference.
|
|
||||||
func (c converter) ConvertValue(v interface{}) (driver.Value, error) {
|
|
||||||
if driver.IsValue(v) {
|
|
||||||
return v, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
if vr, ok := v.(driver.Valuer); ok {
|
|
||||||
sv, err := callValuerValue(vr)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
if driver.IsValue(sv) {
|
|
||||||
return sv, nil
|
|
||||||
}
|
|
||||||
// A value returend from the Valuer interface can be "a type handled by
|
|
||||||
// a database driver's NamedValueChecker interface" so we should accept
|
|
||||||
// uint64 here as well.
|
|
||||||
if u, ok := sv.(uint64); ok {
|
|
||||||
return u, nil
|
|
||||||
}
|
|
||||||
return nil, fmt.Errorf("non-Value type %T returned from Value", sv)
|
|
||||||
}
|
|
||||||
rv := reflect.ValueOf(v)
|
|
||||||
switch rv.Kind() {
|
|
||||||
case reflect.Ptr:
|
|
||||||
// indirect pointers
|
|
||||||
if rv.IsNil() {
|
|
||||||
return nil, nil
|
|
||||||
} else {
|
|
||||||
return c.ConvertValue(rv.Elem().Interface())
|
|
||||||
}
|
|
||||||
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
|
|
||||||
return rv.Int(), nil
|
|
||||||
case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
|
|
||||||
return rv.Uint(), nil
|
|
||||||
case reflect.Float32, reflect.Float64:
|
|
||||||
return rv.Float(), nil
|
|
||||||
case reflect.Bool:
|
|
||||||
return rv.Bool(), nil
|
|
||||||
case reflect.Slice:
|
|
||||||
switch t := rv.Type(); {
|
|
||||||
case t == jsonType:
|
|
||||||
return v, nil
|
|
||||||
case t.Elem().Kind() == reflect.Uint8:
|
|
||||||
return rv.Bytes(), nil
|
|
||||||
default:
|
|
||||||
return nil, fmt.Errorf("unsupported type %T, a slice of %s", v, t.Elem().Kind())
|
|
||||||
}
|
|
||||||
case reflect.String:
|
|
||||||
return rv.String(), nil
|
|
||||||
}
|
|
||||||
return nil, fmt.Errorf("unsupported type %T, a %s", v, rv.Kind())
|
|
||||||
}
|
|
||||||
|
|
||||||
var valuerReflectType = reflect.TypeOf((*driver.Valuer)(nil)).Elem()
|
|
||||||
|
|
||||||
// callValuerValue returns vr.Value(), with one exception:
|
|
||||||
// If vr.Value is an auto-generated method on a pointer type and the
|
|
||||||
// pointer is nil, it would panic at runtime in the panicwrap
|
|
||||||
// method. Treat it like nil instead.
|
|
||||||
//
|
|
||||||
// This is so people can implement driver.Value on value types and
|
|
||||||
// still use nil pointers to those types to mean nil/NULL, just like
|
|
||||||
// string/*string.
|
|
||||||
//
|
|
||||||
// This is an exact copy of the same-named unexported function from the
|
|
||||||
// database/sql package.
|
|
||||||
func callValuerValue(vr driver.Valuer) (v driver.Value, err error) {
|
|
||||||
if rv := reflect.ValueOf(vr); rv.Kind() == reflect.Ptr &&
|
|
||||||
rv.IsNil() &&
|
|
||||||
rv.Type().Elem().Implements(valuerReflectType) {
|
|
||||||
return nil, nil
|
|
||||||
}
|
|
||||||
return vr.Value()
|
|
||||||
}
|
|
@ -1,31 +0,0 @@
|
|||||||
// Go MySQL Driver - A MySQL-Driver for Go's database/sql package
|
|
||||||
//
|
|
||||||
// Copyright 2012 The Go-MySQL-Driver Authors. All rights reserved.
|
|
||||||
//
|
|
||||||
// This Source Code Form is subject to the terms of the Mozilla Public
|
|
||||||
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
||||||
// You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
||||||
|
|
||||||
package mysql
|
|
||||||
|
|
||||||
type mysqlTx struct {
|
|
||||||
mc *mysqlConn
|
|
||||||
}
|
|
||||||
|
|
||||||
func (tx *mysqlTx) Commit() (err error) {
|
|
||||||
if tx.mc == nil || tx.mc.closed.IsSet() {
|
|
||||||
return ErrInvalidConn
|
|
||||||
}
|
|
||||||
err = tx.mc.exec("COMMIT")
|
|
||||||
tx.mc = nil
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
func (tx *mysqlTx) Rollback() (err error) {
|
|
||||||
if tx.mc == nil || tx.mc.closed.IsSet() {
|
|
||||||
return ErrInvalidConn
|
|
||||||
}
|
|
||||||
err = tx.mc.exec("ROLLBACK")
|
|
||||||
tx.mc = nil
|
|
||||||
return
|
|
||||||
}
|
|
@ -1,868 +0,0 @@
|
|||||||
// Go MySQL Driver - A MySQL-Driver for Go's database/sql package
|
|
||||||
//
|
|
||||||
// Copyright 2012 The Go-MySQL-Driver Authors. All rights reserved.
|
|
||||||
//
|
|
||||||
// This Source Code Form is subject to the terms of the Mozilla Public
|
|
||||||
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
||||||
// You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
||||||
|
|
||||||
package mysql
|
|
||||||
|
|
||||||
import (
|
|
||||||
"crypto/tls"
|
|
||||||
"database/sql"
|
|
||||||
"database/sql/driver"
|
|
||||||
"encoding/binary"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"strconv"
|
|
||||||
"strings"
|
|
||||||
"sync"
|
|
||||||
"sync/atomic"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Registry for custom tls.Configs
|
|
||||||
var (
|
|
||||||
tlsConfigLock sync.RWMutex
|
|
||||||
tlsConfigRegistry map[string]*tls.Config
|
|
||||||
)
|
|
||||||
|
|
||||||
// RegisterTLSConfig registers a custom tls.Config to be used with sql.Open.
|
|
||||||
// Use the key as a value in the DSN where tls=value.
|
|
||||||
//
|
|
||||||
// Note: The provided tls.Config is exclusively owned by the driver after
|
|
||||||
// registering it.
|
|
||||||
//
|
|
||||||
// rootCertPool := x509.NewCertPool()
|
|
||||||
// pem, err := ioutil.ReadFile("/path/ca-cert.pem")
|
|
||||||
// if err != nil {
|
|
||||||
// log.Fatal(err)
|
|
||||||
// }
|
|
||||||
// if ok := rootCertPool.AppendCertsFromPEM(pem); !ok {
|
|
||||||
// log.Fatal("Failed to append PEM.")
|
|
||||||
// }
|
|
||||||
// clientCert := make([]tls.Certificate, 0, 1)
|
|
||||||
// certs, err := tls.LoadX509KeyPair("/path/client-cert.pem", "/path/client-key.pem")
|
|
||||||
// if err != nil {
|
|
||||||
// log.Fatal(err)
|
|
||||||
// }
|
|
||||||
// clientCert = append(clientCert, certs)
|
|
||||||
// mysql.RegisterTLSConfig("custom", &tls.Config{
|
|
||||||
// RootCAs: rootCertPool,
|
|
||||||
// Certificates: clientCert,
|
|
||||||
// })
|
|
||||||
// db, err := sql.Open("mysql", "user@tcp(localhost:3306)/test?tls=custom")
|
|
||||||
//
|
|
||||||
func RegisterTLSConfig(key string, config *tls.Config) error {
|
|
||||||
if _, isBool := readBool(key); isBool || strings.ToLower(key) == "skip-verify" || strings.ToLower(key) == "preferred" {
|
|
||||||
return fmt.Errorf("key '%s' is reserved", key)
|
|
||||||
}
|
|
||||||
|
|
||||||
tlsConfigLock.Lock()
|
|
||||||
if tlsConfigRegistry == nil {
|
|
||||||
tlsConfigRegistry = make(map[string]*tls.Config)
|
|
||||||
}
|
|
||||||
|
|
||||||
tlsConfigRegistry[key] = config
|
|
||||||
tlsConfigLock.Unlock()
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// DeregisterTLSConfig removes the tls.Config associated with key.
|
|
||||||
func DeregisterTLSConfig(key string) {
|
|
||||||
tlsConfigLock.Lock()
|
|
||||||
if tlsConfigRegistry != nil {
|
|
||||||
delete(tlsConfigRegistry, key)
|
|
||||||
}
|
|
||||||
tlsConfigLock.Unlock()
|
|
||||||
}
|
|
||||||
|
|
||||||
func getTLSConfigClone(key string) (config *tls.Config) {
|
|
||||||
tlsConfigLock.RLock()
|
|
||||||
if v, ok := tlsConfigRegistry[key]; ok {
|
|
||||||
config = v.Clone()
|
|
||||||
}
|
|
||||||
tlsConfigLock.RUnlock()
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// Returns the bool value of the input.
|
|
||||||
// The 2nd return value indicates if the input was a valid bool value
|
|
||||||
func readBool(input string) (value bool, valid bool) {
|
|
||||||
switch input {
|
|
||||||
case "1", "true", "TRUE", "True":
|
|
||||||
return true, true
|
|
||||||
case "0", "false", "FALSE", "False":
|
|
||||||
return false, true
|
|
||||||
}
|
|
||||||
|
|
||||||
// Not a valid bool value
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
/******************************************************************************
|
|
||||||
* Time related utils *
|
|
||||||
******************************************************************************/
|
|
||||||
|
|
||||||
func parseDateTime(b []byte, loc *time.Location) (time.Time, error) {
|
|
||||||
const base = "0000-00-00 00:00:00.000000"
|
|
||||||
switch len(b) {
|
|
||||||
case 10, 19, 21, 22, 23, 24, 25, 26: // up to "YYYY-MM-DD HH:MM:SS.MMMMMM"
|
|
||||||
if string(b) == base[:len(b)] {
|
|
||||||
return time.Time{}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
year, err := parseByteYear(b)
|
|
||||||
if err != nil {
|
|
||||||
return time.Time{}, err
|
|
||||||
}
|
|
||||||
if year <= 0 {
|
|
||||||
year = 1
|
|
||||||
}
|
|
||||||
|
|
||||||
if b[4] != '-' {
|
|
||||||
return time.Time{}, fmt.Errorf("bad value for field: `%c`", b[4])
|
|
||||||
}
|
|
||||||
|
|
||||||
m, err := parseByte2Digits(b[5], b[6])
|
|
||||||
if err != nil {
|
|
||||||
return time.Time{}, err
|
|
||||||
}
|
|
||||||
if m <= 0 {
|
|
||||||
m = 1
|
|
||||||
}
|
|
||||||
month := time.Month(m)
|
|
||||||
|
|
||||||
if b[7] != '-' {
|
|
||||||
return time.Time{}, fmt.Errorf("bad value for field: `%c`", b[7])
|
|
||||||
}
|
|
||||||
|
|
||||||
day, err := parseByte2Digits(b[8], b[9])
|
|
||||||
if err != nil {
|
|
||||||
return time.Time{}, err
|
|
||||||
}
|
|
||||||
if day <= 0 {
|
|
||||||
day = 1
|
|
||||||
}
|
|
||||||
if len(b) == 10 {
|
|
||||||
return time.Date(year, month, day, 0, 0, 0, 0, loc), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
if b[10] != ' ' {
|
|
||||||
return time.Time{}, fmt.Errorf("bad value for field: `%c`", b[10])
|
|
||||||
}
|
|
||||||
|
|
||||||
hour, err := parseByte2Digits(b[11], b[12])
|
|
||||||
if err != nil {
|
|
||||||
return time.Time{}, err
|
|
||||||
}
|
|
||||||
if b[13] != ':' {
|
|
||||||
return time.Time{}, fmt.Errorf("bad value for field: `%c`", b[13])
|
|
||||||
}
|
|
||||||
|
|
||||||
min, err := parseByte2Digits(b[14], b[15])
|
|
||||||
if err != nil {
|
|
||||||
return time.Time{}, err
|
|
||||||
}
|
|
||||||
if b[16] != ':' {
|
|
||||||
return time.Time{}, fmt.Errorf("bad value for field: `%c`", b[16])
|
|
||||||
}
|
|
||||||
|
|
||||||
sec, err := parseByte2Digits(b[17], b[18])
|
|
||||||
if err != nil {
|
|
||||||
return time.Time{}, err
|
|
||||||
}
|
|
||||||
if len(b) == 19 {
|
|
||||||
return time.Date(year, month, day, hour, min, sec, 0, loc), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
if b[19] != '.' {
|
|
||||||
return time.Time{}, fmt.Errorf("bad value for field: `%c`", b[19])
|
|
||||||
}
|
|
||||||
nsec, err := parseByteNanoSec(b[20:])
|
|
||||||
if err != nil {
|
|
||||||
return time.Time{}, err
|
|
||||||
}
|
|
||||||
return time.Date(year, month, day, hour, min, sec, nsec, loc), nil
|
|
||||||
default:
|
|
||||||
return time.Time{}, fmt.Errorf("invalid time bytes: %s", b)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func parseByteYear(b []byte) (int, error) {
|
|
||||||
year, n := 0, 1000
|
|
||||||
for i := 0; i < 4; i++ {
|
|
||||||
v, err := bToi(b[i])
|
|
||||||
if err != nil {
|
|
||||||
return 0, err
|
|
||||||
}
|
|
||||||
year += v * n
|
|
||||||
n = n / 10
|
|
||||||
}
|
|
||||||
return year, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func parseByte2Digits(b1, b2 byte) (int, error) {
|
|
||||||
d1, err := bToi(b1)
|
|
||||||
if err != nil {
|
|
||||||
return 0, err
|
|
||||||
}
|
|
||||||
d2, err := bToi(b2)
|
|
||||||
if err != nil {
|
|
||||||
return 0, err
|
|
||||||
}
|
|
||||||
return d1*10 + d2, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func parseByteNanoSec(b []byte) (int, error) {
|
|
||||||
ns, digit := 0, 100000 // max is 6-digits
|
|
||||||
for i := 0; i < len(b); i++ {
|
|
||||||
v, err := bToi(b[i])
|
|
||||||
if err != nil {
|
|
||||||
return 0, err
|
|
||||||
}
|
|
||||||
ns += v * digit
|
|
||||||
digit /= 10
|
|
||||||
}
|
|
||||||
// nanoseconds has 10-digits. (needs to scale digits)
|
|
||||||
// 10 - 6 = 4, so we have to multiple 1000.
|
|
||||||
return ns * 1000, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func bToi(b byte) (int, error) {
|
|
||||||
if b < '0' || b > '9' {
|
|
||||||
return 0, errors.New("not [0-9]")
|
|
||||||
}
|
|
||||||
return int(b - '0'), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func parseBinaryDateTime(num uint64, data []byte, loc *time.Location) (driver.Value, error) {
|
|
||||||
switch num {
|
|
||||||
case 0:
|
|
||||||
return time.Time{}, nil
|
|
||||||
case 4:
|
|
||||||
return time.Date(
|
|
||||||
int(binary.LittleEndian.Uint16(data[:2])), // year
|
|
||||||
time.Month(data[2]), // month
|
|
||||||
int(data[3]), // day
|
|
||||||
0, 0, 0, 0,
|
|
||||||
loc,
|
|
||||||
), nil
|
|
||||||
case 7:
|
|
||||||
return time.Date(
|
|
||||||
int(binary.LittleEndian.Uint16(data[:2])), // year
|
|
||||||
time.Month(data[2]), // month
|
|
||||||
int(data[3]), // day
|
|
||||||
int(data[4]), // hour
|
|
||||||
int(data[5]), // minutes
|
|
||||||
int(data[6]), // seconds
|
|
||||||
0,
|
|
||||||
loc,
|
|
||||||
), nil
|
|
||||||
case 11:
|
|
||||||
return time.Date(
|
|
||||||
int(binary.LittleEndian.Uint16(data[:2])), // year
|
|
||||||
time.Month(data[2]), // month
|
|
||||||
int(data[3]), // day
|
|
||||||
int(data[4]), // hour
|
|
||||||
int(data[5]), // minutes
|
|
||||||
int(data[6]), // seconds
|
|
||||||
int(binary.LittleEndian.Uint32(data[7:11]))*1000, // nanoseconds
|
|
||||||
loc,
|
|
||||||
), nil
|
|
||||||
}
|
|
||||||
return nil, fmt.Errorf("invalid DATETIME packet length %d", num)
|
|
||||||
}
|
|
||||||
|
|
||||||
func appendDateTime(buf []byte, t time.Time) ([]byte, error) {
|
|
||||||
year, month, day := t.Date()
|
|
||||||
hour, min, sec := t.Clock()
|
|
||||||
nsec := t.Nanosecond()
|
|
||||||
|
|
||||||
if year < 1 || year > 9999 {
|
|
||||||
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
|
|
||||||
}
|
|
||||||
year100 := year / 100
|
|
||||||
year1 := year % 100
|
|
||||||
|
|
||||||
var localBuf [len("2006-01-02T15:04:05.999999999")]byte // does not escape
|
|
||||||
localBuf[0], localBuf[1], localBuf[2], localBuf[3] = digits10[year100], digits01[year100], digits10[year1], digits01[year1]
|
|
||||||
localBuf[4] = '-'
|
|
||||||
localBuf[5], localBuf[6] = digits10[month], digits01[month]
|
|
||||||
localBuf[7] = '-'
|
|
||||||
localBuf[8], localBuf[9] = digits10[day], digits01[day]
|
|
||||||
|
|
||||||
if hour == 0 && min == 0 && sec == 0 && nsec == 0 {
|
|
||||||
return append(buf, localBuf[:10]...), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
localBuf[10] = ' '
|
|
||||||
localBuf[11], localBuf[12] = digits10[hour], digits01[hour]
|
|
||||||
localBuf[13] = ':'
|
|
||||||
localBuf[14], localBuf[15] = digits10[min], digits01[min]
|
|
||||||
localBuf[16] = ':'
|
|
||||||
localBuf[17], localBuf[18] = digits10[sec], digits01[sec]
|
|
||||||
|
|
||||||
if nsec == 0 {
|
|
||||||
return append(buf, localBuf[:19]...), nil
|
|
||||||
}
|
|
||||||
nsec100000000 := nsec / 100000000
|
|
||||||
nsec1000000 := (nsec / 1000000) % 100
|
|
||||||
nsec10000 := (nsec / 10000) % 100
|
|
||||||
nsec100 := (nsec / 100) % 100
|
|
||||||
nsec1 := nsec % 100
|
|
||||||
localBuf[19] = '.'
|
|
||||||
|
|
||||||
// milli second
|
|
||||||
localBuf[20], localBuf[21], localBuf[22] =
|
|
||||||
digits01[nsec100000000], digits10[nsec1000000], digits01[nsec1000000]
|
|
||||||
// micro second
|
|
||||||
localBuf[23], localBuf[24], localBuf[25] =
|
|
||||||
digits10[nsec10000], digits01[nsec10000], digits10[nsec100]
|
|
||||||
// nano second
|
|
||||||
localBuf[26], localBuf[27], localBuf[28] =
|
|
||||||
digits01[nsec100], digits10[nsec1], digits01[nsec1]
|
|
||||||
|
|
||||||
// trim trailing zeros
|
|
||||||
n := len(localBuf)
|
|
||||||
for n > 0 && localBuf[n-1] == '0' {
|
|
||||||
n--
|
|
||||||
}
|
|
||||||
|
|
||||||
return append(buf, localBuf[:n]...), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// zeroDateTime is used in formatBinaryDateTime to avoid an allocation
|
|
||||||
// if the DATE or DATETIME has the zero value.
|
|
||||||
// It must never be changed.
|
|
||||||
// The current behavior depends on database/sql copying the result.
|
|
||||||
var zeroDateTime = []byte("0000-00-00 00:00:00.000000")
|
|
||||||
|
|
||||||
const digits01 = "0123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789"
|
|
||||||
const digits10 = "0000000000111111111122222222223333333333444444444455555555556666666666777777777788888888889999999999"
|
|
||||||
|
|
||||||
func appendMicrosecs(dst, src []byte, decimals int) []byte {
|
|
||||||
if decimals <= 0 {
|
|
||||||
return dst
|
|
||||||
}
|
|
||||||
if len(src) == 0 {
|
|
||||||
return append(dst, ".000000"[:decimals+1]...)
|
|
||||||
}
|
|
||||||
|
|
||||||
microsecs := binary.LittleEndian.Uint32(src[:4])
|
|
||||||
p1 := byte(microsecs / 10000)
|
|
||||||
microsecs -= 10000 * uint32(p1)
|
|
||||||
p2 := byte(microsecs / 100)
|
|
||||||
microsecs -= 100 * uint32(p2)
|
|
||||||
p3 := byte(microsecs)
|
|
||||||
|
|
||||||
switch decimals {
|
|
||||||
default:
|
|
||||||
return append(dst, '.',
|
|
||||||
digits10[p1], digits01[p1],
|
|
||||||
digits10[p2], digits01[p2],
|
|
||||||
digits10[p3], digits01[p3],
|
|
||||||
)
|
|
||||||
case 1:
|
|
||||||
return append(dst, '.',
|
|
||||||
digits10[p1],
|
|
||||||
)
|
|
||||||
case 2:
|
|
||||||
return append(dst, '.',
|
|
||||||
digits10[p1], digits01[p1],
|
|
||||||
)
|
|
||||||
case 3:
|
|
||||||
return append(dst, '.',
|
|
||||||
digits10[p1], digits01[p1],
|
|
||||||
digits10[p2],
|
|
||||||
)
|
|
||||||
case 4:
|
|
||||||
return append(dst, '.',
|
|
||||||
digits10[p1], digits01[p1],
|
|
||||||
digits10[p2], digits01[p2],
|
|
||||||
)
|
|
||||||
case 5:
|
|
||||||
return append(dst, '.',
|
|
||||||
digits10[p1], digits01[p1],
|
|
||||||
digits10[p2], digits01[p2],
|
|
||||||
digits10[p3],
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func formatBinaryDateTime(src []byte, length uint8) (driver.Value, error) {
|
|
||||||
// length expects the deterministic length of the zero value,
|
|
||||||
// negative time and 100+ hours are automatically added if needed
|
|
||||||
if len(src) == 0 {
|
|
||||||
return zeroDateTime[:length], nil
|
|
||||||
}
|
|
||||||
var dst []byte // return value
|
|
||||||
var p1, p2, p3 byte // current digit pair
|
|
||||||
|
|
||||||
switch length {
|
|
||||||
case 10, 19, 21, 22, 23, 24, 25, 26:
|
|
||||||
default:
|
|
||||||
t := "DATE"
|
|
||||||
if length > 10 {
|
|
||||||
t += "TIME"
|
|
||||||
}
|
|
||||||
return nil, fmt.Errorf("illegal %s length %d", t, length)
|
|
||||||
}
|
|
||||||
switch len(src) {
|
|
||||||
case 4, 7, 11:
|
|
||||||
default:
|
|
||||||
t := "DATE"
|
|
||||||
if length > 10 {
|
|
||||||
t += "TIME"
|
|
||||||
}
|
|
||||||
return nil, fmt.Errorf("illegal %s packet length %d", t, len(src))
|
|
||||||
}
|
|
||||||
dst = make([]byte, 0, length)
|
|
||||||
// start with the date
|
|
||||||
year := binary.LittleEndian.Uint16(src[:2])
|
|
||||||
pt := year / 100
|
|
||||||
p1 = byte(year - 100*uint16(pt))
|
|
||||||
p2, p3 = src[2], src[3]
|
|
||||||
dst = append(dst,
|
|
||||||
digits10[pt], digits01[pt],
|
|
||||||
digits10[p1], digits01[p1], '-',
|
|
||||||
digits10[p2], digits01[p2], '-',
|
|
||||||
digits10[p3], digits01[p3],
|
|
||||||
)
|
|
||||||
if length == 10 {
|
|
||||||
return dst, nil
|
|
||||||
}
|
|
||||||
if len(src) == 4 {
|
|
||||||
return append(dst, zeroDateTime[10:length]...), nil
|
|
||||||
}
|
|
||||||
dst = append(dst, ' ')
|
|
||||||
p1 = src[4] // hour
|
|
||||||
src = src[5:]
|
|
||||||
|
|
||||||
// p1 is 2-digit hour, src is after hour
|
|
||||||
p2, p3 = src[0], src[1]
|
|
||||||
dst = append(dst,
|
|
||||||
digits10[p1], digits01[p1], ':',
|
|
||||||
digits10[p2], digits01[p2], ':',
|
|
||||||
digits10[p3], digits01[p3],
|
|
||||||
)
|
|
||||||
return appendMicrosecs(dst, src[2:], int(length)-20), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func formatBinaryTime(src []byte, length uint8) (driver.Value, error) {
|
|
||||||
// length expects the deterministic length of the zero value,
|
|
||||||
// negative time and 100+ hours are automatically added if needed
|
|
||||||
if len(src) == 0 {
|
|
||||||
return zeroDateTime[11 : 11+length], nil
|
|
||||||
}
|
|
||||||
var dst []byte // return value
|
|
||||||
|
|
||||||
switch length {
|
|
||||||
case
|
|
||||||
8, // time (can be up to 10 when negative and 100+ hours)
|
|
||||||
10, 11, 12, 13, 14, 15: // time with fractional seconds
|
|
||||||
default:
|
|
||||||
return nil, fmt.Errorf("illegal TIME length %d", length)
|
|
||||||
}
|
|
||||||
switch len(src) {
|
|
||||||
case 8, 12:
|
|
||||||
default:
|
|
||||||
return nil, fmt.Errorf("invalid TIME packet length %d", len(src))
|
|
||||||
}
|
|
||||||
// +2 to enable negative time and 100+ hours
|
|
||||||
dst = make([]byte, 0, length+2)
|
|
||||||
if src[0] == 1 {
|
|
||||||
dst = append(dst, '-')
|
|
||||||
}
|
|
||||||
days := binary.LittleEndian.Uint32(src[1:5])
|
|
||||||
hours := int64(days)*24 + int64(src[5])
|
|
||||||
|
|
||||||
if hours >= 100 {
|
|
||||||
dst = strconv.AppendInt(dst, hours, 10)
|
|
||||||
} else {
|
|
||||||
dst = append(dst, digits10[hours], digits01[hours])
|
|
||||||
}
|
|
||||||
|
|
||||||
min, sec := src[6], src[7]
|
|
||||||
dst = append(dst, ':',
|
|
||||||
digits10[min], digits01[min], ':',
|
|
||||||
digits10[sec], digits01[sec],
|
|
||||||
)
|
|
||||||
return appendMicrosecs(dst, src[8:], int(length)-9), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
/******************************************************************************
|
|
||||||
* Convert from and to bytes *
|
|
||||||
******************************************************************************/
|
|
||||||
|
|
||||||
func uint64ToBytes(n uint64) []byte {
|
|
||||||
return []byte{
|
|
||||||
byte(n),
|
|
||||||
byte(n >> 8),
|
|
||||||
byte(n >> 16),
|
|
||||||
byte(n >> 24),
|
|
||||||
byte(n >> 32),
|
|
||||||
byte(n >> 40),
|
|
||||||
byte(n >> 48),
|
|
||||||
byte(n >> 56),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func uint64ToString(n uint64) []byte {
|
|
||||||
var a [20]byte
|
|
||||||
i := 20
|
|
||||||
|
|
||||||
// U+0030 = 0
|
|
||||||
// ...
|
|
||||||
// U+0039 = 9
|
|
||||||
|
|
||||||
var q uint64
|
|
||||||
for n >= 10 {
|
|
||||||
i--
|
|
||||||
q = n / 10
|
|
||||||
a[i] = uint8(n-q*10) + 0x30
|
|
||||||
n = q
|
|
||||||
}
|
|
||||||
|
|
||||||
i--
|
|
||||||
a[i] = uint8(n) + 0x30
|
|
||||||
|
|
||||||
return a[i:]
|
|
||||||
}
|
|
||||||
|
|
||||||
// treats string value as unsigned integer representation
|
|
||||||
func stringToInt(b []byte) int {
|
|
||||||
val := 0
|
|
||||||
for i := range b {
|
|
||||||
val *= 10
|
|
||||||
val += int(b[i] - 0x30)
|
|
||||||
}
|
|
||||||
return val
|
|
||||||
}
|
|
||||||
|
|
||||||
// returns the string read as a bytes slice, wheter the value is NULL,
|
|
||||||
// the number of bytes read and an error, in case the string is longer than
|
|
||||||
// the input slice
|
|
||||||
func readLengthEncodedString(b []byte) ([]byte, bool, int, error) {
|
|
||||||
// Get length
|
|
||||||
num, isNull, n := readLengthEncodedInteger(b)
|
|
||||||
if num < 1 {
|
|
||||||
return b[n:n], isNull, n, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
n += int(num)
|
|
||||||
|
|
||||||
// Check data length
|
|
||||||
if len(b) >= n {
|
|
||||||
return b[n-int(num) : n : n], false, n, nil
|
|
||||||
}
|
|
||||||
return nil, false, n, io.EOF
|
|
||||||
}
|
|
||||||
|
|
||||||
// returns the number of bytes skipped and an error, in case the string is
|
|
||||||
// longer than the input slice
|
|
||||||
func skipLengthEncodedString(b []byte) (int, error) {
|
|
||||||
// Get length
|
|
||||||
num, _, n := readLengthEncodedInteger(b)
|
|
||||||
if num < 1 {
|
|
||||||
return n, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
n += int(num)
|
|
||||||
|
|
||||||
// Check data length
|
|
||||||
if len(b) >= n {
|
|
||||||
return n, nil
|
|
||||||
}
|
|
||||||
return n, io.EOF
|
|
||||||
}
|
|
||||||
|
|
||||||
// returns the number read, whether the value is NULL and the number of bytes read
|
|
||||||
func readLengthEncodedInteger(b []byte) (uint64, bool, int) {
|
|
||||||
// See issue #349
|
|
||||||
if len(b) == 0 {
|
|
||||||
return 0, true, 1
|
|
||||||
}
|
|
||||||
|
|
||||||
switch b[0] {
|
|
||||||
// 251: NULL
|
|
||||||
case 0xfb:
|
|
||||||
return 0, true, 1
|
|
||||||
|
|
||||||
// 252: value of following 2
|
|
||||||
case 0xfc:
|
|
||||||
return uint64(b[1]) | uint64(b[2])<<8, false, 3
|
|
||||||
|
|
||||||
// 253: value of following 3
|
|
||||||
case 0xfd:
|
|
||||||
return uint64(b[1]) | uint64(b[2])<<8 | uint64(b[3])<<16, false, 4
|
|
||||||
|
|
||||||
// 254: value of following 8
|
|
||||||
case 0xfe:
|
|
||||||
return uint64(b[1]) | uint64(b[2])<<8 | uint64(b[3])<<16 |
|
|
||||||
uint64(b[4])<<24 | uint64(b[5])<<32 | uint64(b[6])<<40 |
|
|
||||||
uint64(b[7])<<48 | uint64(b[8])<<56,
|
|
||||||
false, 9
|
|
||||||
}
|
|
||||||
|
|
||||||
// 0-250: value of first byte
|
|
||||||
return uint64(b[0]), false, 1
|
|
||||||
}
|
|
||||||
|
|
||||||
// encodes a uint64 value and appends it to the given bytes slice
|
|
||||||
func appendLengthEncodedInteger(b []byte, n uint64) []byte {
|
|
||||||
switch {
|
|
||||||
case n <= 250:
|
|
||||||
return append(b, byte(n))
|
|
||||||
|
|
||||||
case n <= 0xffff:
|
|
||||||
return append(b, 0xfc, byte(n), byte(n>>8))
|
|
||||||
|
|
||||||
case n <= 0xffffff:
|
|
||||||
return append(b, 0xfd, byte(n), byte(n>>8), byte(n>>16))
|
|
||||||
}
|
|
||||||
return append(b, 0xfe, byte(n), byte(n>>8), byte(n>>16), byte(n>>24),
|
|
||||||
byte(n>>32), byte(n>>40), byte(n>>48), byte(n>>56))
|
|
||||||
}
|
|
||||||
|
|
||||||
// reserveBuffer checks cap(buf) and expand buffer to len(buf) + appendSize.
|
|
||||||
// If cap(buf) is not enough, reallocate new buffer.
|
|
||||||
func reserveBuffer(buf []byte, appendSize int) []byte {
|
|
||||||
newSize := len(buf) + appendSize
|
|
||||||
if cap(buf) < newSize {
|
|
||||||
// Grow buffer exponentially
|
|
||||||
newBuf := make([]byte, len(buf)*2+appendSize)
|
|
||||||
copy(newBuf, buf)
|
|
||||||
buf = newBuf
|
|
||||||
}
|
|
||||||
return buf[:newSize]
|
|
||||||
}
|
|
||||||
|
|
||||||
// escapeBytesBackslash escapes []byte with backslashes (\)
|
|
||||||
// This escapes the contents of a string (provided as []byte) by adding backslashes before special
|
|
||||||
// characters, and turning others into specific escape sequences, such as
|
|
||||||
// turning newlines into \n and null bytes into \0.
|
|
||||||
// https://github.com/mysql/mysql-server/blob/mysql-5.7.5/mysys/charset.c#L823-L932
|
|
||||||
func escapeBytesBackslash(buf, v []byte) []byte {
|
|
||||||
pos := len(buf)
|
|
||||||
buf = reserveBuffer(buf, len(v)*2)
|
|
||||||
|
|
||||||
for _, c := range v {
|
|
||||||
switch c {
|
|
||||||
case '\x00':
|
|
||||||
buf[pos] = '\\'
|
|
||||||
buf[pos+1] = '0'
|
|
||||||
pos += 2
|
|
||||||
case '\n':
|
|
||||||
buf[pos] = '\\'
|
|
||||||
buf[pos+1] = 'n'
|
|
||||||
pos += 2
|
|
||||||
case '\r':
|
|
||||||
buf[pos] = '\\'
|
|
||||||
buf[pos+1] = 'r'
|
|
||||||
pos += 2
|
|
||||||
case '\x1a':
|
|
||||||
buf[pos] = '\\'
|
|
||||||
buf[pos+1] = 'Z'
|
|
||||||
pos += 2
|
|
||||||
case '\'':
|
|
||||||
buf[pos] = '\\'
|
|
||||||
buf[pos+1] = '\''
|
|
||||||
pos += 2
|
|
||||||
case '"':
|
|
||||||
buf[pos] = '\\'
|
|
||||||
buf[pos+1] = '"'
|
|
||||||
pos += 2
|
|
||||||
case '\\':
|
|
||||||
buf[pos] = '\\'
|
|
||||||
buf[pos+1] = '\\'
|
|
||||||
pos += 2
|
|
||||||
default:
|
|
||||||
buf[pos] = c
|
|
||||||
pos++
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return buf[:pos]
|
|
||||||
}
|
|
||||||
|
|
||||||
// escapeStringBackslash is similar to escapeBytesBackslash but for string.
|
|
||||||
func escapeStringBackslash(buf []byte, v string) []byte {
|
|
||||||
pos := len(buf)
|
|
||||||
buf = reserveBuffer(buf, len(v)*2)
|
|
||||||
|
|
||||||
for i := 0; i < len(v); i++ {
|
|
||||||
c := v[i]
|
|
||||||
switch c {
|
|
||||||
case '\x00':
|
|
||||||
buf[pos] = '\\'
|
|
||||||
buf[pos+1] = '0'
|
|
||||||
pos += 2
|
|
||||||
case '\n':
|
|
||||||
buf[pos] = '\\'
|
|
||||||
buf[pos+1] = 'n'
|
|
||||||
pos += 2
|
|
||||||
case '\r':
|
|
||||||
buf[pos] = '\\'
|
|
||||||
buf[pos+1] = 'r'
|
|
||||||
pos += 2
|
|
||||||
case '\x1a':
|
|
||||||
buf[pos] = '\\'
|
|
||||||
buf[pos+1] = 'Z'
|
|
||||||
pos += 2
|
|
||||||
case '\'':
|
|
||||||
buf[pos] = '\\'
|
|
||||||
buf[pos+1] = '\''
|
|
||||||
pos += 2
|
|
||||||
case '"':
|
|
||||||
buf[pos] = '\\'
|
|
||||||
buf[pos+1] = '"'
|
|
||||||
pos += 2
|
|
||||||
case '\\':
|
|
||||||
buf[pos] = '\\'
|
|
||||||
buf[pos+1] = '\\'
|
|
||||||
pos += 2
|
|
||||||
default:
|
|
||||||
buf[pos] = c
|
|
||||||
pos++
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return buf[:pos]
|
|
||||||
}
|
|
||||||
|
|
||||||
// escapeBytesQuotes escapes apostrophes in []byte by doubling them up.
|
|
||||||
// This escapes the contents of a string by doubling up any apostrophes that
|
|
||||||
// it contains. This is used when the NO_BACKSLASH_ESCAPES SQL_MODE is in
|
|
||||||
// effect on the server.
|
|
||||||
// https://github.com/mysql/mysql-server/blob/mysql-5.7.5/mysys/charset.c#L963-L1038
|
|
||||||
func escapeBytesQuotes(buf, v []byte) []byte {
|
|
||||||
pos := len(buf)
|
|
||||||
buf = reserveBuffer(buf, len(v)*2)
|
|
||||||
|
|
||||||
for _, c := range v {
|
|
||||||
if c == '\'' {
|
|
||||||
buf[pos] = '\''
|
|
||||||
buf[pos+1] = '\''
|
|
||||||
pos += 2
|
|
||||||
} else {
|
|
||||||
buf[pos] = c
|
|
||||||
pos++
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return buf[:pos]
|
|
||||||
}
|
|
||||||
|
|
||||||
// escapeStringQuotes is similar to escapeBytesQuotes but for string.
|
|
||||||
func escapeStringQuotes(buf []byte, v string) []byte {
|
|
||||||
pos := len(buf)
|
|
||||||
buf = reserveBuffer(buf, len(v)*2)
|
|
||||||
|
|
||||||
for i := 0; i < len(v); i++ {
|
|
||||||
c := v[i]
|
|
||||||
if c == '\'' {
|
|
||||||
buf[pos] = '\''
|
|
||||||
buf[pos+1] = '\''
|
|
||||||
pos += 2
|
|
||||||
} else {
|
|
||||||
buf[pos] = c
|
|
||||||
pos++
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return buf[:pos]
|
|
||||||
}
|
|
||||||
|
|
||||||
/******************************************************************************
|
|
||||||
* Sync utils *
|
|
||||||
******************************************************************************/
|
|
||||||
|
|
||||||
// noCopy may be embedded into structs which must not be copied
|
|
||||||
// after the first use.
|
|
||||||
//
|
|
||||||
// See https://github.com/golang/go/issues/8005#issuecomment-190753527
|
|
||||||
// for details.
|
|
||||||
type noCopy struct{}
|
|
||||||
|
|
||||||
// Lock is a no-op used by -copylocks checker from `go vet`.
|
|
||||||
func (*noCopy) Lock() {}
|
|
||||||
|
|
||||||
// atomicBool is a wrapper around uint32 for usage as a boolean value with
|
|
||||||
// atomic access.
|
|
||||||
type atomicBool struct {
|
|
||||||
_noCopy noCopy
|
|
||||||
value uint32
|
|
||||||
}
|
|
||||||
|
|
||||||
// IsSet returns whether the current boolean value is true
|
|
||||||
func (ab *atomicBool) IsSet() bool {
|
|
||||||
return atomic.LoadUint32(&ab.value) > 0
|
|
||||||
}
|
|
||||||
|
|
||||||
// Set sets the value of the bool regardless of the previous value
|
|
||||||
func (ab *atomicBool) Set(value bool) {
|
|
||||||
if value {
|
|
||||||
atomic.StoreUint32(&ab.value, 1)
|
|
||||||
} else {
|
|
||||||
atomic.StoreUint32(&ab.value, 0)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TrySet sets the value of the bool and returns whether the value changed
|
|
||||||
func (ab *atomicBool) TrySet(value bool) bool {
|
|
||||||
if value {
|
|
||||||
return atomic.SwapUint32(&ab.value, 1) == 0
|
|
||||||
}
|
|
||||||
return atomic.SwapUint32(&ab.value, 0) > 0
|
|
||||||
}
|
|
||||||
|
|
||||||
// atomicError is a wrapper for atomically accessed error values
|
|
||||||
type atomicError struct {
|
|
||||||
_noCopy noCopy
|
|
||||||
value atomic.Value
|
|
||||||
}
|
|
||||||
|
|
||||||
// Set sets the error value regardless of the previous value.
|
|
||||||
// The value must not be nil
|
|
||||||
func (ae *atomicError) Set(value error) {
|
|
||||||
ae.value.Store(value)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Value returns the current error value
|
|
||||||
func (ae *atomicError) Value() error {
|
|
||||||
if v := ae.value.Load(); v != nil {
|
|
||||||
// this will panic if the value doesn't implement the error interface
|
|
||||||
return v.(error)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func namedValueToValue(named []driver.NamedValue) ([]driver.Value, error) {
|
|
||||||
dargs := make([]driver.Value, len(named))
|
|
||||||
for n, param := range named {
|
|
||||||
if len(param.Name) > 0 {
|
|
||||||
// TODO: support the use of Named Parameters #561
|
|
||||||
return nil, errors.New("mysql: driver does not support the use of Named Parameters")
|
|
||||||
}
|
|
||||||
dargs[n] = param.Value
|
|
||||||
}
|
|
||||||
return dargs, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func mapIsolationLevel(level driver.IsolationLevel) (string, error) {
|
|
||||||
switch sql.IsolationLevel(level) {
|
|
||||||
case sql.LevelRepeatableRead:
|
|
||||||
return "REPEATABLE READ", nil
|
|
||||||
case sql.LevelReadCommitted:
|
|
||||||
return "READ COMMITTED", nil
|
|
||||||
case sql.LevelReadUncommitted:
|
|
||||||
return "READ UNCOMMITTED", nil
|
|
||||||
case sql.LevelSerializable:
|
|
||||||
return "SERIALIZABLE", nil
|
|
||||||
default:
|
|
||||||
return "", fmt.Errorf("mysql: unsupported isolation level: %v", level)
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,21 +0,0 @@
|
|||||||
The MIT License (MIT)
|
|
||||||
|
|
||||||
Copyright (c) 2015 - Jinzhu
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
|
||||||
copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
||||||
SOFTWARE.
|
|
@ -1,55 +0,0 @@
|
|||||||
# Inflection
|
|
||||||
|
|
||||||
Inflection pluralizes and singularizes English nouns
|
|
||||||
|
|
||||||
[![wercker status](https://app.wercker.com/status/f8c7432b097d1f4ce636879670be0930/s/master "wercker status")](https://app.wercker.com/project/byKey/f8c7432b097d1f4ce636879670be0930)
|
|
||||||
|
|
||||||
## Basic Usage
|
|
||||||
|
|
||||||
```go
|
|
||||||
inflection.Plural("person") => "people"
|
|
||||||
inflection.Plural("Person") => "People"
|
|
||||||
inflection.Plural("PERSON") => "PEOPLE"
|
|
||||||
inflection.Plural("bus") => "buses"
|
|
||||||
inflection.Plural("BUS") => "BUSES"
|
|
||||||
inflection.Plural("Bus") => "Buses"
|
|
||||||
|
|
||||||
inflection.Singular("people") => "person"
|
|
||||||
inflection.Singular("People") => "Person"
|
|
||||||
inflection.Singular("PEOPLE") => "PERSON"
|
|
||||||
inflection.Singular("buses") => "bus"
|
|
||||||
inflection.Singular("BUSES") => "BUS"
|
|
||||||
inflection.Singular("Buses") => "Bus"
|
|
||||||
|
|
||||||
inflection.Plural("FancyPerson") => "FancyPeople"
|
|
||||||
inflection.Singular("FancyPeople") => "FancyPerson"
|
|
||||||
```
|
|
||||||
|
|
||||||
## Register Rules
|
|
||||||
|
|
||||||
Standard rules are from Rails's ActiveSupport (https://github.com/rails/rails/blob/master/activesupport/lib/active_support/inflections.rb)
|
|
||||||
|
|
||||||
If you want to register more rules, follow:
|
|
||||||
|
|
||||||
```
|
|
||||||
inflection.AddUncountable("fish")
|
|
||||||
inflection.AddIrregular("person", "people")
|
|
||||||
inflection.AddPlural("(bu)s$", "${1}ses") # "bus" => "buses" / "BUS" => "BUSES" / "Bus" => "Buses"
|
|
||||||
inflection.AddSingular("(bus)(es)?$", "${1}") # "buses" => "bus" / "Buses" => "Bus" / "BUSES" => "BUS"
|
|
||||||
```
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
You can help to make the project better, check out [http://gorm.io/contribute.html](http://gorm.io/contribute.html) for things you can do.
|
|
||||||
|
|
||||||
## Author
|
|
||||||
|
|
||||||
**jinzhu**
|
|
||||||
|
|
||||||
* <http://github.com/jinzhu>
|
|
||||||
* <wosmvp@gmail.com>
|
|
||||||
* <http://twitter.com/zhangjinzhu>
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
Released under the [MIT License](http://www.opensource.org/licenses/MIT).
|
|
@ -1,273 +0,0 @@
|
|||||||
/*
|
|
||||||
Package inflection pluralizes and singularizes English nouns.
|
|
||||||
|
|
||||||
inflection.Plural("person") => "people"
|
|
||||||
inflection.Plural("Person") => "People"
|
|
||||||
inflection.Plural("PERSON") => "PEOPLE"
|
|
||||||
|
|
||||||
inflection.Singular("people") => "person"
|
|
||||||
inflection.Singular("People") => "Person"
|
|
||||||
inflection.Singular("PEOPLE") => "PERSON"
|
|
||||||
|
|
||||||
inflection.Plural("FancyPerson") => "FancydPeople"
|
|
||||||
inflection.Singular("FancyPeople") => "FancydPerson"
|
|
||||||
|
|
||||||
Standard rules are from Rails's ActiveSupport (https://github.com/rails/rails/blob/master/activesupport/lib/active_support/inflections.rb)
|
|
||||||
|
|
||||||
If you want to register more rules, follow:
|
|
||||||
|
|
||||||
inflection.AddUncountable("fish")
|
|
||||||
inflection.AddIrregular("person", "people")
|
|
||||||
inflection.AddPlural("(bu)s$", "${1}ses") # "bus" => "buses" / "BUS" => "BUSES" / "Bus" => "Buses"
|
|
||||||
inflection.AddSingular("(bus)(es)?$", "${1}") # "buses" => "bus" / "Buses" => "Bus" / "BUSES" => "BUS"
|
|
||||||
*/
|
|
||||||
package inflection
|
|
||||||
|
|
||||||
import (
|
|
||||||
"regexp"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
type inflection struct {
|
|
||||||
regexp *regexp.Regexp
|
|
||||||
replace string
|
|
||||||
}
|
|
||||||
|
|
||||||
// Regular is a regexp find replace inflection
|
|
||||||
type Regular struct {
|
|
||||||
find string
|
|
||||||
replace string
|
|
||||||
}
|
|
||||||
|
|
||||||
// Irregular is a hard replace inflection,
|
|
||||||
// containing both singular and plural forms
|
|
||||||
type Irregular struct {
|
|
||||||
singular string
|
|
||||||
plural string
|
|
||||||
}
|
|
||||||
|
|
||||||
// RegularSlice is a slice of Regular inflections
|
|
||||||
type RegularSlice []Regular
|
|
||||||
|
|
||||||
// IrregularSlice is a slice of Irregular inflections
|
|
||||||
type IrregularSlice []Irregular
|
|
||||||
|
|
||||||
var pluralInflections = RegularSlice{
|
|
||||||
{"([a-z])$", "${1}s"},
|
|
||||||
{"s$", "s"},
|
|
||||||
{"^(ax|test)is$", "${1}es"},
|
|
||||||
{"(octop|vir)us$", "${1}i"},
|
|
||||||
{"(octop|vir)i$", "${1}i"},
|
|
||||||
{"(alias|status)$", "${1}es"},
|
|
||||||
{"(bu)s$", "${1}ses"},
|
|
||||||
{"(buffal|tomat)o$", "${1}oes"},
|
|
||||||
{"([ti])um$", "${1}a"},
|
|
||||||
{"([ti])a$", "${1}a"},
|
|
||||||
{"sis$", "ses"},
|
|
||||||
{"(?:([^f])fe|([lr])f)$", "${1}${2}ves"},
|
|
||||||
{"(hive)$", "${1}s"},
|
|
||||||
{"([^aeiouy]|qu)y$", "${1}ies"},
|
|
||||||
{"(x|ch|ss|sh)$", "${1}es"},
|
|
||||||
{"(matr|vert|ind)(?:ix|ex)$", "${1}ices"},
|
|
||||||
{"^(m|l)ouse$", "${1}ice"},
|
|
||||||
{"^(m|l)ice$", "${1}ice"},
|
|
||||||
{"^(ox)$", "${1}en"},
|
|
||||||
{"^(oxen)$", "${1}"},
|
|
||||||
{"(quiz)$", "${1}zes"},
|
|
||||||
}
|
|
||||||
|
|
||||||
var singularInflections = RegularSlice{
|
|
||||||
{"s$", ""},
|
|
||||||
{"(ss)$", "${1}"},
|
|
||||||
{"(n)ews$", "${1}ews"},
|
|
||||||
{"([ti])a$", "${1}um"},
|
|
||||||
{"((a)naly|(b)a|(d)iagno|(p)arenthe|(p)rogno|(s)ynop|(t)he)(sis|ses)$", "${1}sis"},
|
|
||||||
{"(^analy)(sis|ses)$", "${1}sis"},
|
|
||||||
{"([^f])ves$", "${1}fe"},
|
|
||||||
{"(hive)s$", "${1}"},
|
|
||||||
{"(tive)s$", "${1}"},
|
|
||||||
{"([lr])ves$", "${1}f"},
|
|
||||||
{"([^aeiouy]|qu)ies$", "${1}y"},
|
|
||||||
{"(s)eries$", "${1}eries"},
|
|
||||||
{"(m)ovies$", "${1}ovie"},
|
|
||||||
{"(c)ookies$", "${1}ookie"},
|
|
||||||
{"(x|ch|ss|sh)es$", "${1}"},
|
|
||||||
{"^(m|l)ice$", "${1}ouse"},
|
|
||||||
{"(bus)(es)?$", "${1}"},
|
|
||||||
{"(o)es$", "${1}"},
|
|
||||||
{"(shoe)s$", "${1}"},
|
|
||||||
{"(cris|test)(is|es)$", "${1}is"},
|
|
||||||
{"^(a)x[ie]s$", "${1}xis"},
|
|
||||||
{"(octop|vir)(us|i)$", "${1}us"},
|
|
||||||
{"(alias|status)(es)?$", "${1}"},
|
|
||||||
{"^(ox)en", "${1}"},
|
|
||||||
{"(vert|ind)ices$", "${1}ex"},
|
|
||||||
{"(matr)ices$", "${1}ix"},
|
|
||||||
{"(quiz)zes$", "${1}"},
|
|
||||||
{"(database)s$", "${1}"},
|
|
||||||
}
|
|
||||||
|
|
||||||
var irregularInflections = IrregularSlice{
|
|
||||||
{"person", "people"},
|
|
||||||
{"man", "men"},
|
|
||||||
{"child", "children"},
|
|
||||||
{"sex", "sexes"},
|
|
||||||
{"move", "moves"},
|
|
||||||
{"mombie", "mombies"},
|
|
||||||
}
|
|
||||||
|
|
||||||
var uncountableInflections = []string{"equipment", "information", "rice", "money", "species", "series", "fish", "sheep", "jeans", "police"}
|
|
||||||
|
|
||||||
var compiledPluralMaps []inflection
|
|
||||||
var compiledSingularMaps []inflection
|
|
||||||
|
|
||||||
func compile() {
|
|
||||||
compiledPluralMaps = []inflection{}
|
|
||||||
compiledSingularMaps = []inflection{}
|
|
||||||
for _, uncountable := range uncountableInflections {
|
|
||||||
inf := inflection{
|
|
||||||
regexp: regexp.MustCompile("^(?i)(" + uncountable + ")$"),
|
|
||||||
replace: "${1}",
|
|
||||||
}
|
|
||||||
compiledPluralMaps = append(compiledPluralMaps, inf)
|
|
||||||
compiledSingularMaps = append(compiledSingularMaps, inf)
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, value := range irregularInflections {
|
|
||||||
infs := []inflection{
|
|
||||||
inflection{regexp: regexp.MustCompile(strings.ToUpper(value.singular) + "$"), replace: strings.ToUpper(value.plural)},
|
|
||||||
inflection{regexp: regexp.MustCompile(strings.Title(value.singular) + "$"), replace: strings.Title(value.plural)},
|
|
||||||
inflection{regexp: regexp.MustCompile(value.singular + "$"), replace: value.plural},
|
|
||||||
}
|
|
||||||
compiledPluralMaps = append(compiledPluralMaps, infs...)
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, value := range irregularInflections {
|
|
||||||
infs := []inflection{
|
|
||||||
inflection{regexp: regexp.MustCompile(strings.ToUpper(value.plural) + "$"), replace: strings.ToUpper(value.singular)},
|
|
||||||
inflection{regexp: regexp.MustCompile(strings.Title(value.plural) + "$"), replace: strings.Title(value.singular)},
|
|
||||||
inflection{regexp: regexp.MustCompile(value.plural + "$"), replace: value.singular},
|
|
||||||
}
|
|
||||||
compiledSingularMaps = append(compiledSingularMaps, infs...)
|
|
||||||
}
|
|
||||||
|
|
||||||
for i := len(pluralInflections) - 1; i >= 0; i-- {
|
|
||||||
value := pluralInflections[i]
|
|
||||||
infs := []inflection{
|
|
||||||
inflection{regexp: regexp.MustCompile(strings.ToUpper(value.find)), replace: strings.ToUpper(value.replace)},
|
|
||||||
inflection{regexp: regexp.MustCompile(value.find), replace: value.replace},
|
|
||||||
inflection{regexp: regexp.MustCompile("(?i)" + value.find), replace: value.replace},
|
|
||||||
}
|
|
||||||
compiledPluralMaps = append(compiledPluralMaps, infs...)
|
|
||||||
}
|
|
||||||
|
|
||||||
for i := len(singularInflections) - 1; i >= 0; i-- {
|
|
||||||
value := singularInflections[i]
|
|
||||||
infs := []inflection{
|
|
||||||
inflection{regexp: regexp.MustCompile(strings.ToUpper(value.find)), replace: strings.ToUpper(value.replace)},
|
|
||||||
inflection{regexp: regexp.MustCompile(value.find), replace: value.replace},
|
|
||||||
inflection{regexp: regexp.MustCompile("(?i)" + value.find), replace: value.replace},
|
|
||||||
}
|
|
||||||
compiledSingularMaps = append(compiledSingularMaps, infs...)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func init() {
|
|
||||||
compile()
|
|
||||||
}
|
|
||||||
|
|
||||||
// AddPlural adds a plural inflection
|
|
||||||
func AddPlural(find, replace string) {
|
|
||||||
pluralInflections = append(pluralInflections, Regular{find, replace})
|
|
||||||
compile()
|
|
||||||
}
|
|
||||||
|
|
||||||
// AddSingular adds a singular inflection
|
|
||||||
func AddSingular(find, replace string) {
|
|
||||||
singularInflections = append(singularInflections, Regular{find, replace})
|
|
||||||
compile()
|
|
||||||
}
|
|
||||||
|
|
||||||
// AddIrregular adds an irregular inflection
|
|
||||||
func AddIrregular(singular, plural string) {
|
|
||||||
irregularInflections = append(irregularInflections, Irregular{singular, plural})
|
|
||||||
compile()
|
|
||||||
}
|
|
||||||
|
|
||||||
// AddUncountable adds an uncountable inflection
|
|
||||||
func AddUncountable(values ...string) {
|
|
||||||
uncountableInflections = append(uncountableInflections, values...)
|
|
||||||
compile()
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetPlural retrieves the plural inflection values
|
|
||||||
func GetPlural() RegularSlice {
|
|
||||||
plurals := make(RegularSlice, len(pluralInflections))
|
|
||||||
copy(plurals, pluralInflections)
|
|
||||||
return plurals
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetSingular retrieves the singular inflection values
|
|
||||||
func GetSingular() RegularSlice {
|
|
||||||
singulars := make(RegularSlice, len(singularInflections))
|
|
||||||
copy(singulars, singularInflections)
|
|
||||||
return singulars
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetIrregular retrieves the irregular inflection values
|
|
||||||
func GetIrregular() IrregularSlice {
|
|
||||||
irregular := make(IrregularSlice, len(irregularInflections))
|
|
||||||
copy(irregular, irregularInflections)
|
|
||||||
return irregular
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetUncountable retrieves the uncountable inflection values
|
|
||||||
func GetUncountable() []string {
|
|
||||||
uncountables := make([]string, len(uncountableInflections))
|
|
||||||
copy(uncountables, uncountableInflections)
|
|
||||||
return uncountables
|
|
||||||
}
|
|
||||||
|
|
||||||
// SetPlural sets the plural inflections slice
|
|
||||||
func SetPlural(inflections RegularSlice) {
|
|
||||||
pluralInflections = inflections
|
|
||||||
compile()
|
|
||||||
}
|
|
||||||
|
|
||||||
// SetSingular sets the singular inflections slice
|
|
||||||
func SetSingular(inflections RegularSlice) {
|
|
||||||
singularInflections = inflections
|
|
||||||
compile()
|
|
||||||
}
|
|
||||||
|
|
||||||
// SetIrregular sets the irregular inflections slice
|
|
||||||
func SetIrregular(inflections IrregularSlice) {
|
|
||||||
irregularInflections = inflections
|
|
||||||
compile()
|
|
||||||
}
|
|
||||||
|
|
||||||
// SetUncountable sets the uncountable inflections slice
|
|
||||||
func SetUncountable(inflections []string) {
|
|
||||||
uncountableInflections = inflections
|
|
||||||
compile()
|
|
||||||
}
|
|
||||||
|
|
||||||
// Plural converts a word to its plural form
|
|
||||||
func Plural(str string) string {
|
|
||||||
for _, inflection := range compiledPluralMaps {
|
|
||||||
if inflection.regexp.MatchString(str) {
|
|
||||||
return inflection.regexp.ReplaceAllString(str, inflection.replace)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return str
|
|
||||||
}
|
|
||||||
|
|
||||||
// Singular converts a word to its singular form
|
|
||||||
func Singular(str string) string {
|
|
||||||
for _, inflection := range compiledSingularMaps {
|
|
||||||
if inflection.regexp.MatchString(str) {
|
|
||||||
return inflection.regexp.ReplaceAllString(str, inflection.replace)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return str
|
|
||||||
}
|
|
@ -1,23 +0,0 @@
|
|||||||
box: golang
|
|
||||||
|
|
||||||
build:
|
|
||||||
steps:
|
|
||||||
- setup-go-workspace
|
|
||||||
|
|
||||||
# Gets the dependencies
|
|
||||||
- script:
|
|
||||||
name: go get
|
|
||||||
code: |
|
|
||||||
go get
|
|
||||||
|
|
||||||
# Build the project
|
|
||||||
- script:
|
|
||||||
name: go build
|
|
||||||
code: |
|
|
||||||
go build ./...
|
|
||||||
|
|
||||||
# Test the project
|
|
||||||
- script:
|
|
||||||
name: go test
|
|
||||||
code: |
|
|
||||||
go test ./...
|
|
@ -1,3 +0,0 @@
|
|||||||
guard 'gotest' do
|
|
||||||
watch(%r{\.go$})
|
|
||||||
end
|
|
@ -1,21 +0,0 @@
|
|||||||
The MIT License (MIT)
|
|
||||||
|
|
||||||
Copyright (c) 2013-NOW Jinzhu <wosmvp@gmail.com>
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in
|
|
||||||
all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
||||||
THE SOFTWARE.
|
|
@ -1,137 +0,0 @@
|
|||||||
## Now
|
|
||||||
|
|
||||||
Now is a time toolkit for golang
|
|
||||||
|
|
||||||
[![go report card](https://goreportcard.com/badge/github.com/jinzhu/now "go report card")](https://goreportcard.com/report/github.com/jinzhu/now)
|
|
||||||
[![test status](https://github.com/jinzhu/now/workflows/tests/badge.svg?branch=master "test status")](https://github.com/jinzhu/now/actions)
|
|
||||||
[![MIT license](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
|
|
||||||
|
|
||||||
## Install
|
|
||||||
|
|
||||||
```
|
|
||||||
go get -u github.com/jinzhu/now
|
|
||||||
```
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
Calculating time based on current time
|
|
||||||
|
|
||||||
```go
|
|
||||||
import "github.com/jinzhu/now"
|
|
||||||
|
|
||||||
time.Now() // 2013-11-18 17:51:49.123456789 Mon
|
|
||||||
|
|
||||||
now.BeginningOfMinute() // 2013-11-18 17:51:00 Mon
|
|
||||||
now.BeginningOfHour() // 2013-11-18 17:00:00 Mon
|
|
||||||
now.BeginningOfDay() // 2013-11-18 00:00:00 Mon
|
|
||||||
now.BeginningOfWeek() // 2013-11-17 00:00:00 Sun
|
|
||||||
now.BeginningOfMonth() // 2013-11-01 00:00:00 Fri
|
|
||||||
now.BeginningOfQuarter() // 2013-10-01 00:00:00 Tue
|
|
||||||
now.BeginningOfYear() // 2013-01-01 00:00:00 Tue
|
|
||||||
|
|
||||||
now.EndOfMinute() // 2013-11-18 17:51:59.999999999 Mon
|
|
||||||
now.EndOfHour() // 2013-11-18 17:59:59.999999999 Mon
|
|
||||||
now.EndOfDay() // 2013-11-18 23:59:59.999999999 Mon
|
|
||||||
now.EndOfWeek() // 2013-11-23 23:59:59.999999999 Sat
|
|
||||||
now.EndOfMonth() // 2013-11-30 23:59:59.999999999 Sat
|
|
||||||
now.EndOfQuarter() // 2013-12-31 23:59:59.999999999 Tue
|
|
||||||
now.EndOfYear() // 2013-12-31 23:59:59.999999999 Tue
|
|
||||||
|
|
||||||
now.WeekStartDay = time.Monday // Set Monday as first day, default is Sunday
|
|
||||||
now.EndOfWeek() // 2013-11-24 23:59:59.999999999 Sun
|
|
||||||
```
|
|
||||||
|
|
||||||
Calculating time based on another time
|
|
||||||
|
|
||||||
```go
|
|
||||||
t := time.Date(2013, 02, 18, 17, 51, 49, 123456789, time.Now().Location())
|
|
||||||
now.With(t).EndOfMonth() // 2013-02-28 23:59:59.999999999 Thu
|
|
||||||
```
|
|
||||||
|
|
||||||
Calculating time based on configuration
|
|
||||||
|
|
||||||
```go
|
|
||||||
location, err := time.LoadLocation("Asia/Shanghai")
|
|
||||||
|
|
||||||
myConfig := &now.Config{
|
|
||||||
WeekStartDay: time.Monday,
|
|
||||||
TimeLocation: location,
|
|
||||||
TimeFormats: []string{"2006-01-02 15:04:05"},
|
|
||||||
}
|
|
||||||
|
|
||||||
t := time.Date(2013, 11, 18, 17, 51, 49, 123456789, time.Now().Location()) // // 2013-11-18 17:51:49.123456789 Mon
|
|
||||||
myConfig.With(t).BeginningOfWeek() // 2013-11-18 00:00:00 Mon
|
|
||||||
|
|
||||||
myConfig.Parse("2002-10-12 22:14:01") // 2002-10-12 22:14:01
|
|
||||||
myConfig.Parse("2002-10-12 22:14") // returns error 'can't parse string as time: 2002-10-12 22:14'
|
|
||||||
```
|
|
||||||
|
|
||||||
### Monday/Sunday
|
|
||||||
|
|
||||||
Don't be bothered with the `WeekStartDay` setting, you can use `Monday`, `Sunday`
|
|
||||||
|
|
||||||
```go
|
|
||||||
now.Monday() // 2013-11-18 00:00:00 Mon
|
|
||||||
now.Monday("17:44") // 2013-11-18 17:44:00 Mon
|
|
||||||
now.Sunday() // 2013-11-24 00:00:00 Sun (Next Sunday)
|
|
||||||
now.Sunday("18:19:24") // 2013-11-24 18:19:24 Sun (Next Sunday)
|
|
||||||
now.EndOfSunday() // 2013-11-24 23:59:59.999999999 Sun (End of next Sunday)
|
|
||||||
|
|
||||||
t := time.Date(2013, 11, 24, 17, 51, 49, 123456789, time.Now().Location()) // 2013-11-24 17:51:49.123456789 Sun
|
|
||||||
now.With(t).Monday() // 2013-11-18 00:00:00 Mon (Last Monday if today is Sunday)
|
|
||||||
now.With(t).Monday("17:44") // 2013-11-18 17:44:00 Mon (Last Monday if today is Sunday)
|
|
||||||
now.With(t).Sunday() // 2013-11-24 00:00:00 Sun (Beginning Of Today if today is Sunday)
|
|
||||||
now.With(t).Sunday("18:19:24") // 2013-11-24 18:19:24 Sun (Beginning Of Today if today is Sunday)
|
|
||||||
now.With(t).EndOfSunday() // 2013-11-24 23:59:59.999999999 Sun (End of Today if today is Sunday)
|
|
||||||
```
|
|
||||||
|
|
||||||
### Parse String to Time
|
|
||||||
|
|
||||||
```go
|
|
||||||
time.Now() // 2013-11-18 17:51:49.123456789 Mon
|
|
||||||
|
|
||||||
// Parse(string) (time.Time, error)
|
|
||||||
t, err := now.Parse("2017") // 2017-01-01 00:00:00, nil
|
|
||||||
t, err := now.Parse("2017-10") // 2017-10-01 00:00:00, nil
|
|
||||||
t, err := now.Parse("2017-10-13") // 2017-10-13 00:00:00, nil
|
|
||||||
t, err := now.Parse("1999-12-12 12") // 1999-12-12 12:00:00, nil
|
|
||||||
t, err := now.Parse("1999-12-12 12:20") // 1999-12-12 12:20:00, nil
|
|
||||||
t, err := now.Parse("1999-12-12 12:20:21") // 1999-12-12 12:20:21, nil
|
|
||||||
t, err := now.Parse("10-13") // 2013-10-13 00:00:00, nil
|
|
||||||
t, err := now.Parse("12:20") // 2013-11-18 12:20:00, nil
|
|
||||||
t, err := now.Parse("12:20:13") // 2013-11-18 12:20:13, nil
|
|
||||||
t, err := now.Parse("14") // 2013-11-18 14:00:00, nil
|
|
||||||
t, err := now.Parse("99:99") // 2013-11-18 12:20:00, Can't parse string as time: 99:99
|
|
||||||
|
|
||||||
// MustParse must parse string to time or it will panic
|
|
||||||
now.MustParse("2013-01-13") // 2013-01-13 00:00:00
|
|
||||||
now.MustParse("02-17") // 2013-02-17 00:00:00
|
|
||||||
now.MustParse("2-17") // 2013-02-17 00:00:00
|
|
||||||
now.MustParse("8") // 2013-11-18 08:00:00
|
|
||||||
now.MustParse("2002-10-12 22:14") // 2002-10-12 22:14:00
|
|
||||||
now.MustParse("99:99") // panic: Can't parse string as time: 99:99
|
|
||||||
```
|
|
||||||
|
|
||||||
Extend `now` to support more formats is quite easy, just update `now.TimeFormats` with other time layouts, e.g:
|
|
||||||
|
|
||||||
```go
|
|
||||||
now.TimeFormats = append(now.TimeFormats, "02 Jan 2006 15:04")
|
|
||||||
```
|
|
||||||
|
|
||||||
Please send me pull requests if you want a format to be supported officially
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
You can help to make the project better, check out [http://gorm.io/contribute.html](http://gorm.io/contribute.html) for things you can do.
|
|
||||||
|
|
||||||
# Author
|
|
||||||
|
|
||||||
**jinzhu**
|
|
||||||
|
|
||||||
* <http://github.com/jinzhu>
|
|
||||||
* <wosmvp@gmail.com>
|
|
||||||
* <http://twitter.com/zhangjinzhu>
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
Released under the [MIT License](http://www.opensource.org/licenses/MIT).
|
|
@ -1,200 +0,0 @@
|
|||||||
// Package now is a time toolkit for golang.
|
|
||||||
//
|
|
||||||
// More details README here: https://github.com/jinzhu/now
|
|
||||||
//
|
|
||||||
// import "github.com/jinzhu/now"
|
|
||||||
//
|
|
||||||
// now.BeginningOfMinute() // 2013-11-18 17:51:00 Mon
|
|
||||||
// now.BeginningOfDay() // 2013-11-18 00:00:00 Mon
|
|
||||||
// now.EndOfDay() // 2013-11-18 23:59:59.999999999 Mon
|
|
||||||
package now
|
|
||||||
|
|
||||||
import "time"
|
|
||||||
|
|
||||||
// WeekStartDay set week start day, default is sunday
|
|
||||||
var WeekStartDay = time.Sunday
|
|
||||||
|
|
||||||
// TimeFormats default time formats will be parsed as
|
|
||||||
var TimeFormats = []string{
|
|
||||||
"2006", "2006-1", "2006-1-2", "2006-1-2 15", "2006-1-2 15:4", "2006-1-2 15:4:5", "1-2",
|
|
||||||
"15:4:5", "15:4", "15",
|
|
||||||
"15:4:5 Jan 2, 2006 MST", "2006-01-02 15:04:05.999999999 -0700 MST", "2006-01-02T15:04:05Z0700", "2006-01-02T15:04:05Z07",
|
|
||||||
"2006.1.2", "2006.1.2 15:04:05", "2006.01.02", "2006.01.02 15:04:05", "2006.01.02 15:04:05.999999999",
|
|
||||||
"1/2/2006", "1/2/2006 15:4:5", "2006/01/02", "20060102", "2006/01/02 15:04:05",
|
|
||||||
time.ANSIC, time.UnixDate, time.RubyDate, time.RFC822, time.RFC822Z, time.RFC850,
|
|
||||||
time.RFC1123, time.RFC1123Z, time.RFC3339, time.RFC3339Nano,
|
|
||||||
time.Kitchen, time.Stamp, time.StampMilli, time.StampMicro, time.StampNano,
|
|
||||||
}
|
|
||||||
|
|
||||||
// Config configuration for now package
|
|
||||||
type Config struct {
|
|
||||||
WeekStartDay time.Weekday
|
|
||||||
TimeLocation *time.Location
|
|
||||||
TimeFormats []string
|
|
||||||
}
|
|
||||||
|
|
||||||
// DefaultConfig default config
|
|
||||||
var DefaultConfig *Config
|
|
||||||
|
|
||||||
// New initialize Now based on configuration
|
|
||||||
func (config *Config) With(t time.Time) *Now {
|
|
||||||
return &Now{Time: t, Config: config}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Parse parse string to time based on configuration
|
|
||||||
func (config *Config) Parse(strs ...string) (time.Time, error) {
|
|
||||||
if config.TimeLocation == nil {
|
|
||||||
return config.With(time.Now()).Parse(strs...)
|
|
||||||
} else {
|
|
||||||
return config.With(time.Now().In(config.TimeLocation)).Parse(strs...)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// MustParse must parse string to time or will panic
|
|
||||||
func (config *Config) MustParse(strs ...string) time.Time {
|
|
||||||
if config.TimeLocation == nil {
|
|
||||||
return config.With(time.Now()).MustParse(strs...)
|
|
||||||
} else {
|
|
||||||
return config.With(time.Now().In(config.TimeLocation)).MustParse(strs...)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Now now struct
|
|
||||||
type Now struct {
|
|
||||||
time.Time
|
|
||||||
*Config
|
|
||||||
}
|
|
||||||
|
|
||||||
// With initialize Now with time
|
|
||||||
func With(t time.Time) *Now {
|
|
||||||
config := DefaultConfig
|
|
||||||
if config == nil {
|
|
||||||
config = &Config{
|
|
||||||
WeekStartDay: WeekStartDay,
|
|
||||||
TimeFormats: TimeFormats,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return &Now{Time: t, Config: config}
|
|
||||||
}
|
|
||||||
|
|
||||||
// New initialize Now with time
|
|
||||||
func New(t time.Time) *Now {
|
|
||||||
return With(t)
|
|
||||||
}
|
|
||||||
|
|
||||||
// BeginningOfMinute beginning of minute
|
|
||||||
func BeginningOfMinute() time.Time {
|
|
||||||
return With(time.Now()).BeginningOfMinute()
|
|
||||||
}
|
|
||||||
|
|
||||||
// BeginningOfHour beginning of hour
|
|
||||||
func BeginningOfHour() time.Time {
|
|
||||||
return With(time.Now()).BeginningOfHour()
|
|
||||||
}
|
|
||||||
|
|
||||||
// BeginningOfDay beginning of day
|
|
||||||
func BeginningOfDay() time.Time {
|
|
||||||
return With(time.Now()).BeginningOfDay()
|
|
||||||
}
|
|
||||||
|
|
||||||
// BeginningOfWeek beginning of week
|
|
||||||
func BeginningOfWeek() time.Time {
|
|
||||||
return With(time.Now()).BeginningOfWeek()
|
|
||||||
}
|
|
||||||
|
|
||||||
// BeginningOfMonth beginning of month
|
|
||||||
func BeginningOfMonth() time.Time {
|
|
||||||
return With(time.Now()).BeginningOfMonth()
|
|
||||||
}
|
|
||||||
|
|
||||||
// BeginningOfQuarter beginning of quarter
|
|
||||||
func BeginningOfQuarter() time.Time {
|
|
||||||
return With(time.Now()).BeginningOfQuarter()
|
|
||||||
}
|
|
||||||
|
|
||||||
// BeginningOfYear beginning of year
|
|
||||||
func BeginningOfYear() time.Time {
|
|
||||||
return With(time.Now()).BeginningOfYear()
|
|
||||||
}
|
|
||||||
|
|
||||||
// EndOfMinute end of minute
|
|
||||||
func EndOfMinute() time.Time {
|
|
||||||
return With(time.Now()).EndOfMinute()
|
|
||||||
}
|
|
||||||
|
|
||||||
// EndOfHour end of hour
|
|
||||||
func EndOfHour() time.Time {
|
|
||||||
return With(time.Now()).EndOfHour()
|
|
||||||
}
|
|
||||||
|
|
||||||
// EndOfDay end of day
|
|
||||||
func EndOfDay() time.Time {
|
|
||||||
return With(time.Now()).EndOfDay()
|
|
||||||
}
|
|
||||||
|
|
||||||
// EndOfWeek end of week
|
|
||||||
func EndOfWeek() time.Time {
|
|
||||||
return With(time.Now()).EndOfWeek()
|
|
||||||
}
|
|
||||||
|
|
||||||
// EndOfMonth end of month
|
|
||||||
func EndOfMonth() time.Time {
|
|
||||||
return With(time.Now()).EndOfMonth()
|
|
||||||
}
|
|
||||||
|
|
||||||
// EndOfQuarter end of quarter
|
|
||||||
func EndOfQuarter() time.Time {
|
|
||||||
return With(time.Now()).EndOfQuarter()
|
|
||||||
}
|
|
||||||
|
|
||||||
// EndOfYear end of year
|
|
||||||
func EndOfYear() time.Time {
|
|
||||||
return With(time.Now()).EndOfYear()
|
|
||||||
}
|
|
||||||
|
|
||||||
// Monday monday
|
|
||||||
|
|
||||||
func Monday(strs ...string) time.Time {
|
|
||||||
return With(time.Now()).Monday(strs...)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sunday sunday
|
|
||||||
func Sunday(strs ...string) time.Time {
|
|
||||||
return With(time.Now()).Sunday(strs...)
|
|
||||||
}
|
|
||||||
|
|
||||||
// EndOfSunday end of sunday
|
|
||||||
func EndOfSunday() time.Time {
|
|
||||||
return With(time.Now()).EndOfSunday()
|
|
||||||
}
|
|
||||||
|
|
||||||
// Quarter returns the yearly quarter
|
|
||||||
func Quarter() uint {
|
|
||||||
return With(time.Now()).Quarter()
|
|
||||||
}
|
|
||||||
|
|
||||||
// Parse parse string to time
|
|
||||||
func Parse(strs ...string) (time.Time, error) {
|
|
||||||
return With(time.Now()).Parse(strs...)
|
|
||||||
}
|
|
||||||
|
|
||||||
// ParseInLocation parse string to time in location
|
|
||||||
func ParseInLocation(loc *time.Location, strs ...string) (time.Time, error) {
|
|
||||||
return With(time.Now().In(loc)).Parse(strs...)
|
|
||||||
}
|
|
||||||
|
|
||||||
// MustParse must parse string to time or will panic
|
|
||||||
func MustParse(strs ...string) time.Time {
|
|
||||||
return With(time.Now()).MustParse(strs...)
|
|
||||||
}
|
|
||||||
|
|
||||||
// MustParseInLocation must parse string to time in location or will panic
|
|
||||||
func MustParseInLocation(loc *time.Location, strs ...string) time.Time {
|
|
||||||
return With(time.Now().In(loc)).MustParse(strs...)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Between check now between the begin, end time or not
|
|
||||||
func Between(time1, time2 string) bool {
|
|
||||||
return With(time.Now()).Between(time1, time2)
|
|
||||||
}
|
|
@ -1,245 +0,0 @@
|
|||||||
package now
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"regexp"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
// BeginningOfMinute beginning of minute
|
|
||||||
func (now *Now) BeginningOfMinute() time.Time {
|
|
||||||
return now.Truncate(time.Minute)
|
|
||||||
}
|
|
||||||
|
|
||||||
// BeginningOfHour beginning of hour
|
|
||||||
func (now *Now) BeginningOfHour() time.Time {
|
|
||||||
y, m, d := now.Date()
|
|
||||||
return time.Date(y, m, d, now.Time.Hour(), 0, 0, 0, now.Time.Location())
|
|
||||||
}
|
|
||||||
|
|
||||||
// BeginningOfDay beginning of day
|
|
||||||
func (now *Now) BeginningOfDay() time.Time {
|
|
||||||
y, m, d := now.Date()
|
|
||||||
return time.Date(y, m, d, 0, 0, 0, 0, now.Time.Location())
|
|
||||||
}
|
|
||||||
|
|
||||||
// BeginningOfWeek beginning of week
|
|
||||||
func (now *Now) BeginningOfWeek() time.Time {
|
|
||||||
t := now.BeginningOfDay()
|
|
||||||
weekday := int(t.Weekday())
|
|
||||||
|
|
||||||
if now.WeekStartDay != time.Sunday {
|
|
||||||
weekStartDayInt := int(now.WeekStartDay)
|
|
||||||
|
|
||||||
if weekday < weekStartDayInt {
|
|
||||||
weekday = weekday + 7 - weekStartDayInt
|
|
||||||
} else {
|
|
||||||
weekday = weekday - weekStartDayInt
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return t.AddDate(0, 0, -weekday)
|
|
||||||
}
|
|
||||||
|
|
||||||
// BeginningOfMonth beginning of month
|
|
||||||
func (now *Now) BeginningOfMonth() time.Time {
|
|
||||||
y, m, _ := now.Date()
|
|
||||||
return time.Date(y, m, 1, 0, 0, 0, 0, now.Location())
|
|
||||||
}
|
|
||||||
|
|
||||||
// BeginningOfQuarter beginning of quarter
|
|
||||||
func (now *Now) BeginningOfQuarter() time.Time {
|
|
||||||
month := now.BeginningOfMonth()
|
|
||||||
offset := (int(month.Month()) - 1) % 3
|
|
||||||
return month.AddDate(0, -offset, 0)
|
|
||||||
}
|
|
||||||
|
|
||||||
// BeginningOfHalf beginning of half year
|
|
||||||
func (now *Now) BeginningOfHalf() time.Time {
|
|
||||||
month := now.BeginningOfMonth()
|
|
||||||
offset := (int(month.Month()) - 1) % 6
|
|
||||||
return month.AddDate(0, -offset, 0)
|
|
||||||
}
|
|
||||||
|
|
||||||
// BeginningOfYear BeginningOfYear beginning of year
|
|
||||||
func (now *Now) BeginningOfYear() time.Time {
|
|
||||||
y, _, _ := now.Date()
|
|
||||||
return time.Date(y, time.January, 1, 0, 0, 0, 0, now.Location())
|
|
||||||
}
|
|
||||||
|
|
||||||
// EndOfMinute end of minute
|
|
||||||
func (now *Now) EndOfMinute() time.Time {
|
|
||||||
return now.BeginningOfMinute().Add(time.Minute - time.Nanosecond)
|
|
||||||
}
|
|
||||||
|
|
||||||
// EndOfHour end of hour
|
|
||||||
func (now *Now) EndOfHour() time.Time {
|
|
||||||
return now.BeginningOfHour().Add(time.Hour - time.Nanosecond)
|
|
||||||
}
|
|
||||||
|
|
||||||
// EndOfDay end of day
|
|
||||||
func (now *Now) EndOfDay() time.Time {
|
|
||||||
y, m, d := now.Date()
|
|
||||||
return time.Date(y, m, d, 23, 59, 59, int(time.Second-time.Nanosecond), now.Location())
|
|
||||||
}
|
|
||||||
|
|
||||||
// EndOfWeek end of week
|
|
||||||
func (now *Now) EndOfWeek() time.Time {
|
|
||||||
return now.BeginningOfWeek().AddDate(0, 0, 7).Add(-time.Nanosecond)
|
|
||||||
}
|
|
||||||
|
|
||||||
// EndOfMonth end of month
|
|
||||||
func (now *Now) EndOfMonth() time.Time {
|
|
||||||
return now.BeginningOfMonth().AddDate(0, 1, 0).Add(-time.Nanosecond)
|
|
||||||
}
|
|
||||||
|
|
||||||
// EndOfQuarter end of quarter
|
|
||||||
func (now *Now) EndOfQuarter() time.Time {
|
|
||||||
return now.BeginningOfQuarter().AddDate(0, 3, 0).Add(-time.Nanosecond)
|
|
||||||
}
|
|
||||||
|
|
||||||
// EndOfHalf end of half year
|
|
||||||
func (now *Now) EndOfHalf() time.Time {
|
|
||||||
return now.BeginningOfHalf().AddDate(0, 6, 0).Add(-time.Nanosecond)
|
|
||||||
}
|
|
||||||
|
|
||||||
// EndOfYear end of year
|
|
||||||
func (now *Now) EndOfYear() time.Time {
|
|
||||||
return now.BeginningOfYear().AddDate(1, 0, 0).Add(-time.Nanosecond)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Monday monday
|
|
||||||
/*
|
|
||||||
func (now *Now) Monday() time.Time {
|
|
||||||
t := now.BeginningOfDay()
|
|
||||||
weekday := int(t.Weekday())
|
|
||||||
if weekday == 0 {
|
|
||||||
weekday = 7
|
|
||||||
}
|
|
||||||
return t.AddDate(0, 0, -weekday+1)
|
|
||||||
}
|
|
||||||
*/
|
|
||||||
|
|
||||||
func (now *Now) Monday(strs ...string) time.Time {
|
|
||||||
var parseTime time.Time
|
|
||||||
var err error
|
|
||||||
if len(strs) > 0 {
|
|
||||||
parseTime, err = now.Parse(strs...)
|
|
||||||
if err != nil {
|
|
||||||
panic(err)
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
parseTime = now.BeginningOfDay()
|
|
||||||
}
|
|
||||||
weekday := int(parseTime.Weekday())
|
|
||||||
if weekday == 0 {
|
|
||||||
weekday = 7
|
|
||||||
}
|
|
||||||
return parseTime.AddDate(0, 0, -weekday+1)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (now *Now) Sunday(strs ...string) time.Time {
|
|
||||||
var parseTime time.Time
|
|
||||||
var err error
|
|
||||||
if len(strs) > 0 {
|
|
||||||
parseTime, err = now.Parse(strs...)
|
|
||||||
if err != nil {
|
|
||||||
panic(err)
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
parseTime = now.BeginningOfDay()
|
|
||||||
}
|
|
||||||
weekday := int(parseTime.Weekday())
|
|
||||||
if weekday == 0 {
|
|
||||||
weekday = 7
|
|
||||||
}
|
|
||||||
return parseTime.AddDate(0, 0, (7 - weekday))
|
|
||||||
}
|
|
||||||
|
|
||||||
// EndOfSunday end of sunday
|
|
||||||
func (now *Now) EndOfSunday() time.Time {
|
|
||||||
return New(now.Sunday()).EndOfDay()
|
|
||||||
}
|
|
||||||
|
|
||||||
// Quarter returns the yearly quarter
|
|
||||||
func (now *Now) Quarter() uint {
|
|
||||||
return (uint(now.Month())-1)/3 + 1
|
|
||||||
}
|
|
||||||
|
|
||||||
func (now *Now) parseWithFormat(str string, location *time.Location) (t time.Time, err error) {
|
|
||||||
for _, format := range now.TimeFormats {
|
|
||||||
t, err = time.ParseInLocation(format, str, location)
|
|
||||||
|
|
||||||
if err == nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
err = errors.New("Can't parse string as time: " + str)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
var hasTimeRegexp = regexp.MustCompile(`(\s+|^\s*|T)\d{1,2}((:\d{1,2})*|((:\d{1,2}){2}\.(\d{3}|\d{6}|\d{9})))(\s*$|[Z+-])`) // match 15:04:05, 15:04:05.000, 15:04:05.000000 15, 2017-01-01 15:04, 2021-07-20T00:59:10Z, 2021-07-20T00:59:10+08:00, 2021-07-20T00:00:10-07:00 etc
|
|
||||||
var onlyTimeRegexp = regexp.MustCompile(`^\s*\d{1,2}((:\d{1,2})*|((:\d{1,2}){2}\.(\d{3}|\d{6}|\d{9})))\s*$`) // match 15:04:05, 15, 15:04:05.000, 15:04:05.000000, etc
|
|
||||||
|
|
||||||
// Parse parse string to time
|
|
||||||
func (now *Now) Parse(strs ...string) (t time.Time, err error) {
|
|
||||||
var (
|
|
||||||
setCurrentTime bool
|
|
||||||
parseTime []int
|
|
||||||
currentLocation = now.Location()
|
|
||||||
onlyTimeInStr = true
|
|
||||||
currentTime = formatTimeToList(now.Time)
|
|
||||||
)
|
|
||||||
|
|
||||||
for _, str := range strs {
|
|
||||||
hasTimeInStr := hasTimeRegexp.MatchString(str) // match 15:04:05, 15
|
|
||||||
onlyTimeInStr = hasTimeInStr && onlyTimeInStr && onlyTimeRegexp.MatchString(str)
|
|
||||||
if t, err = now.parseWithFormat(str, currentLocation); err == nil {
|
|
||||||
location := t.Location()
|
|
||||||
parseTime = formatTimeToList(t)
|
|
||||||
|
|
||||||
for i, v := range parseTime {
|
|
||||||
// Don't reset hour, minute, second if current time str including time
|
|
||||||
if hasTimeInStr && i <= 3 {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
// If value is zero, replace it with current time
|
|
||||||
if v == 0 {
|
|
||||||
if setCurrentTime {
|
|
||||||
parseTime[i] = currentTime[i]
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
setCurrentTime = true
|
|
||||||
}
|
|
||||||
|
|
||||||
// if current time only includes time, should change day, month to current time
|
|
||||||
if onlyTimeInStr {
|
|
||||||
if i == 4 || i == 5 {
|
|
||||||
parseTime[i] = currentTime[i]
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
t = time.Date(parseTime[6], time.Month(parseTime[5]), parseTime[4], parseTime[3], parseTime[2], parseTime[1], parseTime[0], location)
|
|
||||||
currentTime = formatTimeToList(t)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// MustParse must parse string to time or it will panic
|
|
||||||
func (now *Now) MustParse(strs ...string) (t time.Time) {
|
|
||||||
t, err := now.Parse(strs...)
|
|
||||||
if err != nil {
|
|
||||||
panic(err)
|
|
||||||
}
|
|
||||||
return t
|
|
||||||
}
|
|
||||||
|
|
||||||
// Between check time between the begin, end time or not
|
|
||||||
func (now *Now) Between(begin, end string) bool {
|
|
||||||
beginTime := now.MustParse(begin)
|
|
||||||
endTime := now.MustParse(end)
|
|
||||||
return now.After(beginTime) && now.Before(endTime)
|
|
||||||
}
|
|
@ -1,9 +0,0 @@
|
|||||||
package now
|
|
||||||
|
|
||||||
import "time"
|
|
||||||
|
|
||||||
func formatTimeToList(t time.Time) []int {
|
|
||||||
hour, min, sec := t.Clock()
|
|
||||||
year, month, day := t.Date()
|
|
||||||
return []int{t.Nanosecond(), sec, min, hour, day, int(month), year}
|
|
||||||
}
|
|
@ -1,23 +0,0 @@
|
|||||||
# Compiled Object files, Static and Dynamic libs (Shared Objects)
|
|
||||||
*.o
|
|
||||||
*.a
|
|
||||||
*.so
|
|
||||||
|
|
||||||
# Folders
|
|
||||||
_obj
|
|
||||||
_test
|
|
||||||
|
|
||||||
# Architecture specific extensions/prefixes
|
|
||||||
*.[568vq]
|
|
||||||
[568vq].out
|
|
||||||
|
|
||||||
*.cgo1.go
|
|
||||||
*.cgo2.c
|
|
||||||
_cgo_defun.c
|
|
||||||
_cgo_gotypes.go
|
|
||||||
_cgo_export.*
|
|
||||||
|
|
||||||
_testmain.go
|
|
||||||
|
|
||||||
*.exe
|
|
||||||
*.test
|
|
@ -1,6 +0,0 @@
|
|||||||
language: go
|
|
||||||
|
|
||||||
go:
|
|
||||||
- 1.8
|
|
||||||
- 1.7
|
|
||||||
- 1.6
|
|
@ -1,21 +0,0 @@
|
|||||||
The MIT License (MIT)
|
|
||||||
|
|
||||||
Copyright (c) 2014 Nate Finch
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
|
||||||
copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
||||||
SOFTWARE.
|
|
@ -1,179 +0,0 @@
|
|||||||
# lumberjack [![GoDoc](https://godoc.org/gopkg.in/natefinch/lumberjack.v2?status.png)](https://godoc.org/gopkg.in/natefinch/lumberjack.v2) [![Build Status](https://travis-ci.org/natefinch/lumberjack.svg?branch=v2.0)](https://travis-ci.org/natefinch/lumberjack) [![Build status](https://ci.appveyor.com/api/projects/status/00gchpxtg4gkrt5d)](https://ci.appveyor.com/project/natefinch/lumberjack) [![Coverage Status](https://coveralls.io/repos/natefinch/lumberjack/badge.svg?branch=v2.0)](https://coveralls.io/r/natefinch/lumberjack?branch=v2.0)
|
|
||||||
|
|
||||||
### Lumberjack is a Go package for writing logs to rolling files.
|
|
||||||
|
|
||||||
Package lumberjack provides a rolling logger.
|
|
||||||
|
|
||||||
Note that this is v2.0 of lumberjack, and should be imported using gopkg.in
|
|
||||||
thusly:
|
|
||||||
|
|
||||||
import "gopkg.in/natefinch/lumberjack.v2"
|
|
||||||
|
|
||||||
The package name remains simply lumberjack, and the code resides at
|
|
||||||
https://github.com/natefinch/lumberjack under the v2.0 branch.
|
|
||||||
|
|
||||||
Lumberjack is intended to be one part of a logging infrastructure.
|
|
||||||
It is not an all-in-one solution, but instead is a pluggable
|
|
||||||
component at the bottom of the logging stack that simply controls the files
|
|
||||||
to which logs are written.
|
|
||||||
|
|
||||||
Lumberjack plays well with any logging package that can write to an
|
|
||||||
io.Writer, including the standard library's log package.
|
|
||||||
|
|
||||||
Lumberjack assumes that only one process is writing to the output files.
|
|
||||||
Using the same lumberjack configuration from multiple processes on the same
|
|
||||||
machine will result in improper behavior.
|
|
||||||
|
|
||||||
|
|
||||||
**Example**
|
|
||||||
|
|
||||||
To use lumberjack with the standard library's log package, just pass it into the SetOutput function when your application starts.
|
|
||||||
|
|
||||||
Code:
|
|
||||||
|
|
||||||
```go
|
|
||||||
log.SetOutput(&lumberjack.Logger{
|
|
||||||
Filename: "/var/log/myapp/foo.log",
|
|
||||||
MaxSize: 500, // megabytes
|
|
||||||
MaxBackups: 3,
|
|
||||||
MaxAge: 28, //days
|
|
||||||
Compress: true, // disabled by default
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## type Logger
|
|
||||||
``` go
|
|
||||||
type Logger struct {
|
|
||||||
// Filename is the file to write logs to. Backup log files will be retained
|
|
||||||
// in the same directory. It uses <processname>-lumberjack.log in
|
|
||||||
// os.TempDir() if empty.
|
|
||||||
Filename string `json:"filename" yaml:"filename"`
|
|
||||||
|
|
||||||
// MaxSize is the maximum size in megabytes of the log file before it gets
|
|
||||||
// rotated. It defaults to 100 megabytes.
|
|
||||||
MaxSize int `json:"maxsize" yaml:"maxsize"`
|
|
||||||
|
|
||||||
// MaxAge is the maximum number of days to retain old log files based on the
|
|
||||||
// timestamp encoded in their filename. Note that a day is defined as 24
|
|
||||||
// hours and may not exactly correspond to calendar days due to daylight
|
|
||||||
// savings, leap seconds, etc. The default is not to remove old log files
|
|
||||||
// based on age.
|
|
||||||
MaxAge int `json:"maxage" yaml:"maxage"`
|
|
||||||
|
|
||||||
// MaxBackups is the maximum number of old log files to retain. The default
|
|
||||||
// is to retain all old log files (though MaxAge may still cause them to get
|
|
||||||
// deleted.)
|
|
||||||
MaxBackups int `json:"maxbackups" yaml:"maxbackups"`
|
|
||||||
|
|
||||||
// LocalTime determines if the time used for formatting the timestamps in
|
|
||||||
// backup files is the computer's local time. The default is to use UTC
|
|
||||||
// time.
|
|
||||||
LocalTime bool `json:"localtime" yaml:"localtime"`
|
|
||||||
|
|
||||||
// Compress determines if the rotated log files should be compressed
|
|
||||||
// using gzip. The default is not to perform compression.
|
|
||||||
Compress bool `json:"compress" yaml:"compress"`
|
|
||||||
// contains filtered or unexported fields
|
|
||||||
}
|
|
||||||
```
|
|
||||||
Logger is an io.WriteCloser that writes to the specified filename.
|
|
||||||
|
|
||||||
Logger opens or creates the logfile on first Write. If the file exists and
|
|
||||||
is less than MaxSize megabytes, lumberjack will open and append to that file.
|
|
||||||
If the file exists and its size is >= MaxSize megabytes, the file is renamed
|
|
||||||
by putting the current time in a timestamp in the name immediately before the
|
|
||||||
file's extension (or the end of the filename if there's no extension). A new
|
|
||||||
log file is then created using original filename.
|
|
||||||
|
|
||||||
Whenever a write would cause the current log file exceed MaxSize megabytes,
|
|
||||||
the current file is closed, renamed, and a new log file created with the
|
|
||||||
original name. Thus, the filename you give Logger is always the "current" log
|
|
||||||
file.
|
|
||||||
|
|
||||||
Backups use the log file name given to Logger, in the form `name-timestamp.ext`
|
|
||||||
where name is the filename without the extension, timestamp is the time at which
|
|
||||||
the log was rotated formatted with the time.Time format of
|
|
||||||
`2006-01-02T15-04-05.000` and the extension is the original extension. For
|
|
||||||
example, if your Logger.Filename is `/var/log/foo/server.log`, a backup created
|
|
||||||
at 6:30pm on Nov 11 2016 would use the filename
|
|
||||||
`/var/log/foo/server-2016-11-04T18-30-00.000.log`
|
|
||||||
|
|
||||||
### Cleaning Up Old Log Files
|
|
||||||
Whenever a new logfile gets created, old log files may be deleted. The most
|
|
||||||
recent files according to the encoded timestamp will be retained, up to a
|
|
||||||
number equal to MaxBackups (or all of them if MaxBackups is 0). Any files
|
|
||||||
with an encoded timestamp older than MaxAge days are deleted, regardless of
|
|
||||||
MaxBackups. Note that the time encoded in the timestamp is the rotation
|
|
||||||
time, which may differ from the last time that file was written to.
|
|
||||||
|
|
||||||
If MaxBackups and MaxAge are both 0, no old log files will be deleted.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### func (\*Logger) Close
|
|
||||||
``` go
|
|
||||||
func (l *Logger) Close() error
|
|
||||||
```
|
|
||||||
Close implements io.Closer, and closes the current logfile.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### func (\*Logger) Rotate
|
|
||||||
``` go
|
|
||||||
func (l *Logger) Rotate() error
|
|
||||||
```
|
|
||||||
Rotate causes Logger to close the existing log file and immediately create a
|
|
||||||
new one. This is a helper function for applications that want to initiate
|
|
||||||
rotations outside of the normal rotation rules, such as in response to
|
|
||||||
SIGHUP. After rotating, this initiates a cleanup of old log files according
|
|
||||||
to the normal rules.
|
|
||||||
|
|
||||||
**Example**
|
|
||||||
|
|
||||||
Example of how to rotate in response to SIGHUP.
|
|
||||||
|
|
||||||
Code:
|
|
||||||
|
|
||||||
```go
|
|
||||||
l := &lumberjack.Logger{}
|
|
||||||
log.SetOutput(l)
|
|
||||||
c := make(chan os.Signal, 1)
|
|
||||||
signal.Notify(c, syscall.SIGHUP)
|
|
||||||
|
|
||||||
go func() {
|
|
||||||
for {
|
|
||||||
<-c
|
|
||||||
l.Rotate()
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
```
|
|
||||||
|
|
||||||
### func (\*Logger) Write
|
|
||||||
``` go
|
|
||||||
func (l *Logger) Write(p []byte) (n int, err error)
|
|
||||||
```
|
|
||||||
Write implements io.Writer. If a write would cause the log file to be larger
|
|
||||||
than MaxSize, the file is closed, renamed to include a timestamp of the
|
|
||||||
current time, and a new log file is created using the original log file name.
|
|
||||||
If the length of the write is greater than MaxSize, an error is returned.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
- - -
|
|
||||||
Generated by [godoc2md](http://godoc.org/github.com/davecheney/godoc2md)
|
|
@ -1,11 +0,0 @@
|
|||||||
// +build !linux
|
|
||||||
|
|
||||||
package lumberjack
|
|
||||||
|
|
||||||
import (
|
|
||||||
"os"
|
|
||||||
)
|
|
||||||
|
|
||||||
func chown(_ string, _ os.FileInfo) error {
|
|
||||||
return nil
|
|
||||||
}
|
|
@ -1,19 +0,0 @@
|
|||||||
package lumberjack
|
|
||||||
|
|
||||||
import (
|
|
||||||
"os"
|
|
||||||
"syscall"
|
|
||||||
)
|
|
||||||
|
|
||||||
// os_Chown is a var so we can mock it out during tests.
|
|
||||||
var os_Chown = os.Chown
|
|
||||||
|
|
||||||
func chown(name string, info os.FileInfo) error {
|
|
||||||
f, err := os.OpenFile(name, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, info.Mode())
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
f.Close()
|
|
||||||
stat := info.Sys().(*syscall.Stat_t)
|
|
||||||
return os_Chown(name, int(stat.Uid), int(stat.Gid))
|
|
||||||
}
|
|
@ -1,541 +0,0 @@
|
|||||||
// Package lumberjack provides a rolling logger.
|
|
||||||
//
|
|
||||||
// Note that this is v2.0 of lumberjack, and should be imported using gopkg.in
|
|
||||||
// thusly:
|
|
||||||
//
|
|
||||||
// import "gopkg.in/natefinch/lumberjack.v2"
|
|
||||||
//
|
|
||||||
// The package name remains simply lumberjack, and the code resides at
|
|
||||||
// https://github.com/natefinch/lumberjack under the v2.0 branch.
|
|
||||||
//
|
|
||||||
// Lumberjack is intended to be one part of a logging infrastructure.
|
|
||||||
// It is not an all-in-one solution, but instead is a pluggable
|
|
||||||
// component at the bottom of the logging stack that simply controls the files
|
|
||||||
// to which logs are written.
|
|
||||||
//
|
|
||||||
// Lumberjack plays well with any logging package that can write to an
|
|
||||||
// io.Writer, including the standard library's log package.
|
|
||||||
//
|
|
||||||
// Lumberjack assumes that only one process is writing to the output files.
|
|
||||||
// Using the same lumberjack configuration from multiple processes on the same
|
|
||||||
// machine will result in improper behavior.
|
|
||||||
package lumberjack
|
|
||||||
|
|
||||||
import (
|
|
||||||
"compress/gzip"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"io/ioutil"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"sort"
|
|
||||||
"strings"
|
|
||||||
"sync"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
|
||||||
backupTimeFormat = "2006-01-02T15-04-05.000"
|
|
||||||
compressSuffix = ".gz"
|
|
||||||
defaultMaxSize = 100
|
|
||||||
)
|
|
||||||
|
|
||||||
// ensure we always implement io.WriteCloser
|
|
||||||
var _ io.WriteCloser = (*Logger)(nil)
|
|
||||||
|
|
||||||
// Logger is an io.WriteCloser that writes to the specified filename.
|
|
||||||
//
|
|
||||||
// Logger opens or creates the logfile on first Write. If the file exists and
|
|
||||||
// is less than MaxSize megabytes, lumberjack will open and append to that file.
|
|
||||||
// If the file exists and its size is >= MaxSize megabytes, the file is renamed
|
|
||||||
// by putting the current time in a timestamp in the name immediately before the
|
|
||||||
// file's extension (or the end of the filename if there's no extension). A new
|
|
||||||
// log file is then created using original filename.
|
|
||||||
//
|
|
||||||
// Whenever a write would cause the current log file exceed MaxSize megabytes,
|
|
||||||
// the current file is closed, renamed, and a new log file created with the
|
|
||||||
// original name. Thus, the filename you give Logger is always the "current" log
|
|
||||||
// file.
|
|
||||||
//
|
|
||||||
// Backups use the log file name given to Logger, in the form
|
|
||||||
// `name-timestamp.ext` where name is the filename without the extension,
|
|
||||||
// timestamp is the time at which the log was rotated formatted with the
|
|
||||||
// time.Time format of `2006-01-02T15-04-05.000` and the extension is the
|
|
||||||
// original extension. For example, if your Logger.Filename is
|
|
||||||
// `/var/log/foo/server.log`, a backup created at 6:30pm on Nov 11 2016 would
|
|
||||||
// use the filename `/var/log/foo/server-2016-11-04T18-30-00.000.log`
|
|
||||||
//
|
|
||||||
// Cleaning Up Old Log Files
|
|
||||||
//
|
|
||||||
// Whenever a new logfile gets created, old log files may be deleted. The most
|
|
||||||
// recent files according to the encoded timestamp will be retained, up to a
|
|
||||||
// number equal to MaxBackups (or all of them if MaxBackups is 0). Any files
|
|
||||||
// with an encoded timestamp older than MaxAge days are deleted, regardless of
|
|
||||||
// MaxBackups. Note that the time encoded in the timestamp is the rotation
|
|
||||||
// time, which may differ from the last time that file was written to.
|
|
||||||
//
|
|
||||||
// If MaxBackups and MaxAge are both 0, no old log files will be deleted.
|
|
||||||
type Logger struct {
|
|
||||||
// Filename is the file to write logs to. Backup log files will be retained
|
|
||||||
// in the same directory. It uses <processname>-lumberjack.log in
|
|
||||||
// os.TempDir() if empty.
|
|
||||||
Filename string `json:"filename" yaml:"filename"`
|
|
||||||
|
|
||||||
// MaxSize is the maximum size in megabytes of the log file before it gets
|
|
||||||
// rotated. It defaults to 100 megabytes.
|
|
||||||
MaxSize int `json:"maxsize" yaml:"maxsize"`
|
|
||||||
|
|
||||||
// MaxAge is the maximum number of days to retain old log files based on the
|
|
||||||
// timestamp encoded in their filename. Note that a day is defined as 24
|
|
||||||
// hours and may not exactly correspond to calendar days due to daylight
|
|
||||||
// savings, leap seconds, etc. The default is not to remove old log files
|
|
||||||
// based on age.
|
|
||||||
MaxAge int `json:"maxage" yaml:"maxage"`
|
|
||||||
|
|
||||||
// MaxBackups is the maximum number of old log files to retain. The default
|
|
||||||
// is to retain all old log files (though MaxAge may still cause them to get
|
|
||||||
// deleted.)
|
|
||||||
MaxBackups int `json:"maxbackups" yaml:"maxbackups"`
|
|
||||||
|
|
||||||
// LocalTime determines if the time used for formatting the timestamps in
|
|
||||||
// backup files is the computer's local time. The default is to use UTC
|
|
||||||
// time.
|
|
||||||
LocalTime bool `json:"localtime" yaml:"localtime"`
|
|
||||||
|
|
||||||
// Compress determines if the rotated log files should be compressed
|
|
||||||
// using gzip. The default is not to perform compression.
|
|
||||||
Compress bool `json:"compress" yaml:"compress"`
|
|
||||||
|
|
||||||
size int64
|
|
||||||
file *os.File
|
|
||||||
mu sync.Mutex
|
|
||||||
|
|
||||||
millCh chan bool
|
|
||||||
startMill sync.Once
|
|
||||||
}
|
|
||||||
|
|
||||||
var (
|
|
||||||
// currentTime exists so it can be mocked out by tests.
|
|
||||||
currentTime = time.Now
|
|
||||||
|
|
||||||
// os_Stat exists so it can be mocked out by tests.
|
|
||||||
os_Stat = os.Stat
|
|
||||||
|
|
||||||
// megabyte is the conversion factor between MaxSize and bytes. It is a
|
|
||||||
// variable so tests can mock it out and not need to write megabytes of data
|
|
||||||
// to disk.
|
|
||||||
megabyte = 1024 * 1024
|
|
||||||
)
|
|
||||||
|
|
||||||
// Write implements io.Writer. If a write would cause the log file to be larger
|
|
||||||
// than MaxSize, the file is closed, renamed to include a timestamp of the
|
|
||||||
// current time, and a new log file is created using the original log file name.
|
|
||||||
// If the length of the write is greater than MaxSize, an error is returned.
|
|
||||||
func (l *Logger) Write(p []byte) (n int, err error) {
|
|
||||||
l.mu.Lock()
|
|
||||||
defer l.mu.Unlock()
|
|
||||||
|
|
||||||
writeLen := int64(len(p))
|
|
||||||
if writeLen > l.max() {
|
|
||||||
return 0, fmt.Errorf(
|
|
||||||
"write length %d exceeds maximum file size %d", writeLen, l.max(),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
if l.file == nil {
|
|
||||||
if err = l.openExistingOrNew(len(p)); err != nil {
|
|
||||||
return 0, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if l.size+writeLen > l.max() {
|
|
||||||
if err := l.rotate(); err != nil {
|
|
||||||
return 0, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
n, err = l.file.Write(p)
|
|
||||||
l.size += int64(n)
|
|
||||||
|
|
||||||
return n, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Close implements io.Closer, and closes the current logfile.
|
|
||||||
func (l *Logger) Close() error {
|
|
||||||
l.mu.Lock()
|
|
||||||
defer l.mu.Unlock()
|
|
||||||
return l.close()
|
|
||||||
}
|
|
||||||
|
|
||||||
// close closes the file if it is open.
|
|
||||||
func (l *Logger) close() error {
|
|
||||||
if l.file == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
err := l.file.Close()
|
|
||||||
l.file = nil
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Rotate causes Logger to close the existing log file and immediately create a
|
|
||||||
// new one. This is a helper function for applications that want to initiate
|
|
||||||
// rotations outside of the normal rotation rules, such as in response to
|
|
||||||
// SIGHUP. After rotating, this initiates compression and removal of old log
|
|
||||||
// files according to the configuration.
|
|
||||||
func (l *Logger) Rotate() error {
|
|
||||||
l.mu.Lock()
|
|
||||||
defer l.mu.Unlock()
|
|
||||||
return l.rotate()
|
|
||||||
}
|
|
||||||
|
|
||||||
// rotate closes the current file, moves it aside with a timestamp in the name,
|
|
||||||
// (if it exists), opens a new file with the original filename, and then runs
|
|
||||||
// post-rotation processing and removal.
|
|
||||||
func (l *Logger) rotate() error {
|
|
||||||
if err := l.close(); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if err := l.openNew(); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
l.mill()
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// openNew opens a new log file for writing, moving any old log file out of the
|
|
||||||
// way. This methods assumes the file has already been closed.
|
|
||||||
func (l *Logger) openNew() error {
|
|
||||||
err := os.MkdirAll(l.dir(), 0744)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("can't make directories for new logfile: %s", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
name := l.filename()
|
|
||||||
mode := os.FileMode(0644)
|
|
||||||
info, err := os_Stat(name)
|
|
||||||
if err == nil {
|
|
||||||
// Copy the mode off the old logfile.
|
|
||||||
mode = info.Mode()
|
|
||||||
// move the existing file
|
|
||||||
newname := backupName(name, l.LocalTime)
|
|
||||||
if err := os.Rename(name, newname); err != nil {
|
|
||||||
return fmt.Errorf("can't rename log file: %s", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// this is a no-op anywhere but linux
|
|
||||||
if err := chown(name, info); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// we use truncate here because this should only get called when we've moved
|
|
||||||
// the file ourselves. if someone else creates the file in the meantime,
|
|
||||||
// just wipe out the contents.
|
|
||||||
f, err := os.OpenFile(name, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, mode)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("can't open new logfile: %s", err)
|
|
||||||
}
|
|
||||||
l.file = f
|
|
||||||
l.size = 0
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// backupName creates a new filename from the given name, inserting a timestamp
|
|
||||||
// between the filename and the extension, using the local time if requested
|
|
||||||
// (otherwise UTC).
|
|
||||||
func backupName(name string, local bool) string {
|
|
||||||
dir := filepath.Dir(name)
|
|
||||||
filename := filepath.Base(name)
|
|
||||||
ext := filepath.Ext(filename)
|
|
||||||
prefix := filename[:len(filename)-len(ext)]
|
|
||||||
t := currentTime()
|
|
||||||
if !local {
|
|
||||||
t = t.UTC()
|
|
||||||
}
|
|
||||||
|
|
||||||
timestamp := t.Format(backupTimeFormat)
|
|
||||||
return filepath.Join(dir, fmt.Sprintf("%s-%s%s", prefix, timestamp, ext))
|
|
||||||
}
|
|
||||||
|
|
||||||
// openExistingOrNew opens the logfile if it exists and if the current write
|
|
||||||
// would not put it over MaxSize. If there is no such file or the write would
|
|
||||||
// put it over the MaxSize, a new file is created.
|
|
||||||
func (l *Logger) openExistingOrNew(writeLen int) error {
|
|
||||||
l.mill()
|
|
||||||
|
|
||||||
filename := l.filename()
|
|
||||||
info, err := os_Stat(filename)
|
|
||||||
if os.IsNotExist(err) {
|
|
||||||
return l.openNew()
|
|
||||||
}
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("error getting log file info: %s", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if info.Size()+int64(writeLen) >= l.max() {
|
|
||||||
return l.rotate()
|
|
||||||
}
|
|
||||||
|
|
||||||
file, err := os.OpenFile(filename, os.O_APPEND|os.O_WRONLY, 0644)
|
|
||||||
if err != nil {
|
|
||||||
// if we fail to open the old log file for some reason, just ignore
|
|
||||||
// it and open a new log file.
|
|
||||||
return l.openNew()
|
|
||||||
}
|
|
||||||
l.file = file
|
|
||||||
l.size = info.Size()
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// genFilename generates the name of the logfile from the current time.
|
|
||||||
func (l *Logger) filename() string {
|
|
||||||
if l.Filename != "" {
|
|
||||||
return l.Filename
|
|
||||||
}
|
|
||||||
name := filepath.Base(os.Args[0]) + "-lumberjack.log"
|
|
||||||
return filepath.Join(os.TempDir(), name)
|
|
||||||
}
|
|
||||||
|
|
||||||
// millRunOnce performs compression and removal of stale log files.
|
|
||||||
// Log files are compressed if enabled via configuration and old log
|
|
||||||
// files are removed, keeping at most l.MaxBackups files, as long as
|
|
||||||
// none of them are older than MaxAge.
|
|
||||||
func (l *Logger) millRunOnce() error {
|
|
||||||
if l.MaxBackups == 0 && l.MaxAge == 0 && !l.Compress {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
files, err := l.oldLogFiles()
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
var compress, remove []logInfo
|
|
||||||
|
|
||||||
if l.MaxBackups > 0 && l.MaxBackups < len(files) {
|
|
||||||
preserved := make(map[string]bool)
|
|
||||||
var remaining []logInfo
|
|
||||||
for _, f := range files {
|
|
||||||
// Only count the uncompressed log file or the
|
|
||||||
// compressed log file, not both.
|
|
||||||
fn := f.Name()
|
|
||||||
if strings.HasSuffix(fn, compressSuffix) {
|
|
||||||
fn = fn[:len(fn)-len(compressSuffix)]
|
|
||||||
}
|
|
||||||
preserved[fn] = true
|
|
||||||
|
|
||||||
if len(preserved) > l.MaxBackups {
|
|
||||||
remove = append(remove, f)
|
|
||||||
} else {
|
|
||||||
remaining = append(remaining, f)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
files = remaining
|
|
||||||
}
|
|
||||||
if l.MaxAge > 0 {
|
|
||||||
diff := time.Duration(int64(24*time.Hour) * int64(l.MaxAge))
|
|
||||||
cutoff := currentTime().Add(-1 * diff)
|
|
||||||
|
|
||||||
var remaining []logInfo
|
|
||||||
for _, f := range files {
|
|
||||||
if f.timestamp.Before(cutoff) {
|
|
||||||
remove = append(remove, f)
|
|
||||||
} else {
|
|
||||||
remaining = append(remaining, f)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
files = remaining
|
|
||||||
}
|
|
||||||
|
|
||||||
if l.Compress {
|
|
||||||
for _, f := range files {
|
|
||||||
if !strings.HasSuffix(f.Name(), compressSuffix) {
|
|
||||||
compress = append(compress, f)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, f := range remove {
|
|
||||||
errRemove := os.Remove(filepath.Join(l.dir(), f.Name()))
|
|
||||||
if err == nil && errRemove != nil {
|
|
||||||
err = errRemove
|
|
||||||
}
|
|
||||||
}
|
|
||||||
for _, f := range compress {
|
|
||||||
fn := filepath.Join(l.dir(), f.Name())
|
|
||||||
errCompress := compressLogFile(fn, fn+compressSuffix)
|
|
||||||
if err == nil && errCompress != nil {
|
|
||||||
err = errCompress
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
// millRun runs in a goroutine to manage post-rotation compression and removal
|
|
||||||
// of old log files.
|
|
||||||
func (l *Logger) millRun() {
|
|
||||||
for _ = range l.millCh {
|
|
||||||
// what am I going to do, log this?
|
|
||||||
_ = l.millRunOnce()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// mill performs post-rotation compression and removal of stale log files,
|
|
||||||
// starting the mill goroutine if necessary.
|
|
||||||
func (l *Logger) mill() {
|
|
||||||
l.startMill.Do(func() {
|
|
||||||
l.millCh = make(chan bool, 1)
|
|
||||||
go l.millRun()
|
|
||||||
})
|
|
||||||
select {
|
|
||||||
case l.millCh <- true:
|
|
||||||
default:
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// oldLogFiles returns the list of backup log files stored in the same
|
|
||||||
// directory as the current log file, sorted by ModTime
|
|
||||||
func (l *Logger) oldLogFiles() ([]logInfo, error) {
|
|
||||||
files, err := ioutil.ReadDir(l.dir())
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("can't read log file directory: %s", err)
|
|
||||||
}
|
|
||||||
logFiles := []logInfo{}
|
|
||||||
|
|
||||||
prefix, ext := l.prefixAndExt()
|
|
||||||
|
|
||||||
for _, f := range files {
|
|
||||||
if f.IsDir() {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
if t, err := l.timeFromName(f.Name(), prefix, ext); err == nil {
|
|
||||||
logFiles = append(logFiles, logInfo{t, f})
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
if t, err := l.timeFromName(f.Name(), prefix, ext+compressSuffix); err == nil {
|
|
||||||
logFiles = append(logFiles, logInfo{t, f})
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
// error parsing means that the suffix at the end was not generated
|
|
||||||
// by lumberjack, and therefore it's not a backup file.
|
|
||||||
}
|
|
||||||
|
|
||||||
sort.Sort(byFormatTime(logFiles))
|
|
||||||
|
|
||||||
return logFiles, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// timeFromName extracts the formatted time from the filename by stripping off
|
|
||||||
// the filename's prefix and extension. This prevents someone's filename from
|
|
||||||
// confusing time.parse.
|
|
||||||
func (l *Logger) timeFromName(filename, prefix, ext string) (time.Time, error) {
|
|
||||||
if !strings.HasPrefix(filename, prefix) {
|
|
||||||
return time.Time{}, errors.New("mismatched prefix")
|
|
||||||
}
|
|
||||||
if !strings.HasSuffix(filename, ext) {
|
|
||||||
return time.Time{}, errors.New("mismatched extension")
|
|
||||||
}
|
|
||||||
ts := filename[len(prefix) : len(filename)-len(ext)]
|
|
||||||
return time.Parse(backupTimeFormat, ts)
|
|
||||||
}
|
|
||||||
|
|
||||||
// max returns the maximum size in bytes of log files before rolling.
|
|
||||||
func (l *Logger) max() int64 {
|
|
||||||
if l.MaxSize == 0 {
|
|
||||||
return int64(defaultMaxSize * megabyte)
|
|
||||||
}
|
|
||||||
return int64(l.MaxSize) * int64(megabyte)
|
|
||||||
}
|
|
||||||
|
|
||||||
// dir returns the directory for the current filename.
|
|
||||||
func (l *Logger) dir() string {
|
|
||||||
return filepath.Dir(l.filename())
|
|
||||||
}
|
|
||||||
|
|
||||||
// prefixAndExt returns the filename part and extension part from the Logger's
|
|
||||||
// filename.
|
|
||||||
func (l *Logger) prefixAndExt() (prefix, ext string) {
|
|
||||||
filename := filepath.Base(l.filename())
|
|
||||||
ext = filepath.Ext(filename)
|
|
||||||
prefix = filename[:len(filename)-len(ext)] + "-"
|
|
||||||
return prefix, ext
|
|
||||||
}
|
|
||||||
|
|
||||||
// compressLogFile compresses the given log file, removing the
|
|
||||||
// uncompressed log file if successful.
|
|
||||||
func compressLogFile(src, dst string) (err error) {
|
|
||||||
f, err := os.Open(src)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("failed to open log file: %v", err)
|
|
||||||
}
|
|
||||||
defer f.Close()
|
|
||||||
|
|
||||||
fi, err := os_Stat(src)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("failed to stat log file: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := chown(dst, fi); err != nil {
|
|
||||||
return fmt.Errorf("failed to chown compressed log file: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// If this file already exists, we presume it was created by
|
|
||||||
// a previous attempt to compress the log file.
|
|
||||||
gzf, err := os.OpenFile(dst, os.O_CREATE|os.O_TRUNC|os.O_WRONLY, fi.Mode())
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("failed to open compressed log file: %v", err)
|
|
||||||
}
|
|
||||||
defer gzf.Close()
|
|
||||||
|
|
||||||
gz := gzip.NewWriter(gzf)
|
|
||||||
|
|
||||||
defer func() {
|
|
||||||
if err != nil {
|
|
||||||
os.Remove(dst)
|
|
||||||
err = fmt.Errorf("failed to compress log file: %v", err)
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
|
|
||||||
if _, err := io.Copy(gz, f); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if err := gz.Close(); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if err := gzf.Close(); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := f.Close(); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if err := os.Remove(src); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// logInfo is a convenience struct to return the filename and its embedded
|
|
||||||
// timestamp.
|
|
||||||
type logInfo struct {
|
|
||||||
timestamp time.Time
|
|
||||||
os.FileInfo
|
|
||||||
}
|
|
||||||
|
|
||||||
// byFormatTime sorts by newest time formatted in the name.
|
|
||||||
type byFormatTime []logInfo
|
|
||||||
|
|
||||||
func (b byFormatTime) Less(i, j int) bool {
|
|
||||||
return b[i].timestamp.After(b[j].timestamp)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (b byFormatTime) Swap(i, j int) {
|
|
||||||
b[i], b[j] = b[j], b[i]
|
|
||||||
}
|
|
||||||
|
|
||||||
func (b byFormatTime) Len() int {
|
|
||||||
return len(b)
|
|
||||||
}
|
|
@ -1,21 +0,0 @@
|
|||||||
MIT License
|
|
||||||
|
|
||||||
Copyright (c) 2018 Arran Walker
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
|
||||||
copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
||||||
SOFTWARE.
|
|
@ -1,68 +0,0 @@
|
|||||||
# go7z
|
|
||||||
|
|
||||||
A native Go 7z archive reader.
|
|
||||||
|
|
||||||
Features:
|
|
||||||
- Development in early stages.
|
|
||||||
- Very little tests.
|
|
||||||
- Medium probability of crashes.
|
|
||||||
- Medium probability of using all memory.
|
|
||||||
- Decompresses:
|
|
||||||
- [LZMA](https://github.com/ulikunitz/xz)
|
|
||||||
- [LZMA2](https://github.com/ulikunitz/xz)
|
|
||||||
- Delta
|
|
||||||
- BCJ2
|
|
||||||
- bzip2
|
|
||||||
- deflate
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
Extracting an archive:
|
|
||||||
|
|
||||||
```
|
|
||||||
package main
|
|
||||||
|
|
||||||
import (
|
|
||||||
"io"
|
|
||||||
"os"
|
|
||||||
|
|
||||||
"github.com/saracen/go7z"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
sz, err := go7z.OpenReader("hello.7z")
|
|
||||||
if err != nil {
|
|
||||||
panic(err)
|
|
||||||
}
|
|
||||||
defer sz.Close()
|
|
||||||
|
|
||||||
for {
|
|
||||||
hdr, err := sz.Next()
|
|
||||||
if err == io.EOF {
|
|
||||||
break // End of archive
|
|
||||||
}
|
|
||||||
if err != nil {
|
|
||||||
panic(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// If empty stream (no contents) and isn't specifically an empty file...
|
|
||||||
// then it's a directory.
|
|
||||||
if hdr.IsEmptyStream && !hdr.IsEmptyFile {
|
|
||||||
if err := os.MkdirAll(hdr.Name, os.ModePerm); err != nil {
|
|
||||||
panic(err)
|
|
||||||
}
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
// Create file
|
|
||||||
f, err := os.Create(hdr.Name)
|
|
||||||
if err != nil {
|
|
||||||
panic(err)
|
|
||||||
}
|
|
||||||
defer f.Close()
|
|
||||||
|
|
||||||
if _, err := io.Copy(f, sz); err != nil {
|
|
||||||
panic(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
@ -1,132 +0,0 @@
|
|||||||
package filters
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"crypto/aes"
|
|
||||||
"crypto/cipher"
|
|
||||||
"crypto/sha256"
|
|
||||||
"encoding/binary"
|
|
||||||
"hash"
|
|
||||||
"io"
|
|
||||||
"strings"
|
|
||||||
"unicode/utf16"
|
|
||||||
)
|
|
||||||
|
|
||||||
var km keyManager
|
|
||||||
|
|
||||||
func init() {
|
|
||||||
km.cache = make(map[string][]byte)
|
|
||||||
km.hasher = sha256.New()
|
|
||||||
}
|
|
||||||
|
|
||||||
// AESDecrypter is an AES-256 decryptor.
|
|
||||||
type AESDecrypter struct {
|
|
||||||
r io.Reader
|
|
||||||
rbuf bytes.Buffer
|
|
||||||
cbc cipher.BlockMode
|
|
||||||
buf [aes.BlockSize]byte
|
|
||||||
}
|
|
||||||
|
|
||||||
type keyManager struct {
|
|
||||||
hasher hash.Hash
|
|
||||||
cache map[string][]byte
|
|
||||||
}
|
|
||||||
|
|
||||||
func (km *keyManager) Key(power int, salt []byte, password string) []byte {
|
|
||||||
var cacheKey strings.Builder
|
|
||||||
cacheKey.WriteString(password)
|
|
||||||
cacheKey.Write(salt)
|
|
||||||
cacheKey.WriteByte(byte(power))
|
|
||||||
|
|
||||||
key, ok := km.cache[cacheKey.String()]
|
|
||||||
if ok {
|
|
||||||
return key
|
|
||||||
}
|
|
||||||
|
|
||||||
b := bytes.NewBuffer(nil)
|
|
||||||
for _, p := range utf16.Encode([]rune(password)) {
|
|
||||||
binary.Write(b, binary.LittleEndian, p)
|
|
||||||
}
|
|
||||||
|
|
||||||
if power == 0x3f {
|
|
||||||
key = km.stretch(salt, b.Bytes())
|
|
||||||
} else {
|
|
||||||
key = km.sha256Stretch(power, salt, b.Bytes())
|
|
||||||
}
|
|
||||||
|
|
||||||
km.cache[cacheKey.String()] = key
|
|
||||||
return key
|
|
||||||
}
|
|
||||||
|
|
||||||
func (km *keyManager) stretch(salt, password []byte) []byte {
|
|
||||||
var key [aes.BlockSize]byte
|
|
||||||
|
|
||||||
var pos int
|
|
||||||
for pos = 0; pos < len(salt); pos++ {
|
|
||||||
key[pos] = salt[pos]
|
|
||||||
}
|
|
||||||
for i := 0; i < len(password) && pos < len(key); i++ {
|
|
||||||
key[pos] = password[i]
|
|
||||||
pos++
|
|
||||||
}
|
|
||||||
for ; pos < len(key); pos++ {
|
|
||||||
key[pos] = 0
|
|
||||||
}
|
|
||||||
return key[:]
|
|
||||||
}
|
|
||||||
|
|
||||||
func (km *keyManager) sha256Stretch(power int, salt, password []byte) []byte {
|
|
||||||
var temp [8]byte
|
|
||||||
for round := 0; round < 1<<power; round++ {
|
|
||||||
km.hasher.Write(salt)
|
|
||||||
km.hasher.Write(password)
|
|
||||||
km.hasher.Write(temp[:])
|
|
||||||
|
|
||||||
for i := 0; i < 8; i++ {
|
|
||||||
temp[i]++
|
|
||||||
if temp[i] != 0 {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
defer km.hasher.Reset()
|
|
||||||
return km.hasher.Sum(nil)
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewAESDecrypter returns a new AES-256 decryptor.
|
|
||||||
func NewAESDecrypter(r io.Reader, power int, salt, iv []byte, password string) (*AESDecrypter, error) {
|
|
||||||
key := km.Key(power, salt, password)
|
|
||||||
|
|
||||||
cb, err := aes.NewCipher(key)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
var aesiv [aes.BlockSize]byte
|
|
||||||
copy(aesiv[:], iv)
|
|
||||||
|
|
||||||
return &AESDecrypter{
|
|
||||||
r: r,
|
|
||||||
cbc: cipher.NewCBCDecrypter(cb, aesiv[:]),
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (d *AESDecrypter) Read(p []byte) (int, error) {
|
|
||||||
for d.rbuf.Len() < len(p) {
|
|
||||||
_, err := d.r.Read(d.buf[:])
|
|
||||||
if err != nil {
|
|
||||||
return 0, err
|
|
||||||
}
|
|
||||||
|
|
||||||
d.cbc.CryptBlocks(d.buf[:], d.buf[:])
|
|
||||||
|
|
||||||
_, err = d.rbuf.Write(d.buf[:])
|
|
||||||
if err != nil {
|
|
||||||
return 0, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
n, err := d.rbuf.Read(p)
|
|
||||||
return n, err
|
|
||||||
}
|
|
@ -1,210 +0,0 @@
|
|||||||
package filters
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bufio"
|
|
||||||
"bytes"
|
|
||||||
"encoding/binary"
|
|
||||||
"io"
|
|
||||||
)
|
|
||||||
|
|
||||||
type rangeDecoder struct {
|
|
||||||
r io.Reader
|
|
||||||
nrange uint
|
|
||||||
code uint
|
|
||||||
}
|
|
||||||
|
|
||||||
func newRangeDecoder(r io.Reader) (*rangeDecoder, error) {
|
|
||||||
rd := &rangeDecoder{
|
|
||||||
r: r,
|
|
||||||
nrange: 0xffffffff,
|
|
||||||
}
|
|
||||||
|
|
||||||
for i := 0; i < 5; i++ {
|
|
||||||
b, err := rd.ReadByte()
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
rd.code = (rd.code << 8) | uint(b)
|
|
||||||
}
|
|
||||||
return rd, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (rd *rangeDecoder) ReadByte() (byte, error) {
|
|
||||||
var b [1]byte
|
|
||||||
_, err := rd.r.Read(b[:])
|
|
||||||
return b[0], err
|
|
||||||
}
|
|
||||||
|
|
||||||
const (
|
|
||||||
numMoveBits = 5
|
|
||||||
numbitModelTotalBits = 11
|
|
||||||
bitModelTotal = uint(1) << numbitModelTotalBits
|
|
||||||
|
|
||||||
numTopBits = 24
|
|
||||||
topValue = uint(1 << numTopBits)
|
|
||||||
)
|
|
||||||
|
|
||||||
type statusDecoder struct {
|
|
||||||
prob uint
|
|
||||||
}
|
|
||||||
|
|
||||||
func newStatusDecoder() *statusDecoder {
|
|
||||||
return &statusDecoder{prob: bitModelTotal / 2}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (sd *statusDecoder) Decode(decoder *rangeDecoder) (uint, error) {
|
|
||||||
var err error
|
|
||||||
var b byte
|
|
||||||
|
|
||||||
newBound := (decoder.nrange >> numbitModelTotalBits) * sd.prob
|
|
||||||
if decoder.code < newBound {
|
|
||||||
decoder.nrange = newBound
|
|
||||||
sd.prob += (bitModelTotal - sd.prob) >> numMoveBits
|
|
||||||
if decoder.nrange < topValue {
|
|
||||||
if b, err = decoder.ReadByte(); err != nil {
|
|
||||||
return 0, err
|
|
||||||
}
|
|
||||||
decoder.code = (decoder.code << 8) | uint(b)
|
|
||||||
decoder.nrange <<= 8
|
|
||||||
}
|
|
||||||
return 0, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
decoder.nrange -= newBound
|
|
||||||
decoder.code -= newBound
|
|
||||||
sd.prob -= sd.prob >> numMoveBits
|
|
||||||
if decoder.nrange < topValue {
|
|
||||||
if b, err = decoder.ReadByte(); err != nil {
|
|
||||||
return 0, err
|
|
||||||
}
|
|
||||||
decoder.code = (decoder.code << 8) | uint(b)
|
|
||||||
decoder.nrange <<= 8
|
|
||||||
}
|
|
||||||
return 1, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// BCJ2Decoder is a BCJ2 decoder.
|
|
||||||
type BCJ2Decoder struct {
|
|
||||||
main *bufio.Reader
|
|
||||||
call io.Reader
|
|
||||||
jump io.Reader
|
|
||||||
|
|
||||||
rangeDecoder *rangeDecoder
|
|
||||||
statusDecoder []*statusDecoder
|
|
||||||
|
|
||||||
written int64
|
|
||||||
finished bool
|
|
||||||
|
|
||||||
prevByte byte
|
|
||||||
|
|
||||||
buf *bytes.Buffer
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewBCJ2Decoder returns a new BCJ2 decoder.
|
|
||||||
func NewBCJ2Decoder(main, call, jump, rangedecoder io.Reader, limit int64) (*BCJ2Decoder, error) {
|
|
||||||
rd, err := newRangeDecoder(rangedecoder)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
decoder := &BCJ2Decoder{
|
|
||||||
main: bufio.NewReader(main),
|
|
||||||
call: call,
|
|
||||||
jump: jump,
|
|
||||||
rangeDecoder: rd,
|
|
||||||
statusDecoder: make([]*statusDecoder, 256+2),
|
|
||||||
buf: new(bytes.Buffer),
|
|
||||||
}
|
|
||||||
decoder.buf.Grow(1 << 16)
|
|
||||||
|
|
||||||
for i := range decoder.statusDecoder {
|
|
||||||
decoder.statusDecoder[i] = newStatusDecoder()
|
|
||||||
}
|
|
||||||
|
|
||||||
return decoder, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (d *BCJ2Decoder) isJcc(b0, b1 byte) bool {
|
|
||||||
return b0 == 0x0f && (b1&0xf0) == 0x80
|
|
||||||
}
|
|
||||||
|
|
||||||
func (d *BCJ2Decoder) isJ(b0, b1 byte) bool {
|
|
||||||
return (b1&0xfe) == 0xe8 || d.isJcc(b0, b1)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (d *BCJ2Decoder) index(b0, b1 byte) int {
|
|
||||||
switch b1 {
|
|
||||||
case 0xe8:
|
|
||||||
return int(b0)
|
|
||||||
case 0xe9:
|
|
||||||
return 256
|
|
||||||
}
|
|
||||||
return 257
|
|
||||||
}
|
|
||||||
|
|
||||||
func (d *BCJ2Decoder) Read(p []byte) (int, error) {
|
|
||||||
err := d.read()
|
|
||||||
if err != nil && err != io.EOF {
|
|
||||||
return 0, err
|
|
||||||
}
|
|
||||||
|
|
||||||
return d.buf.Read(p)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (d *BCJ2Decoder) read() error {
|
|
||||||
b := byte(0)
|
|
||||||
|
|
||||||
var err error
|
|
||||||
for i := 0; i < d.buf.Cap(); i++ {
|
|
||||||
b, err = d.main.ReadByte()
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
d.written++
|
|
||||||
if err = d.buf.WriteByte(b); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
if d.isJ(d.prevByte, b) {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
d.prevByte = b
|
|
||||||
}
|
|
||||||
|
|
||||||
if d.buf.Len() == d.buf.Cap() {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
bit, err := d.statusDecoder[d.index(d.prevByte, b)].Decode(d.rangeDecoder)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
if bit == 1 {
|
|
||||||
var r io.Reader
|
|
||||||
if b == 0xe8 {
|
|
||||||
r = d.call
|
|
||||||
} else {
|
|
||||||
r = d.jump
|
|
||||||
}
|
|
||||||
|
|
||||||
var dest uint32
|
|
||||||
if err = binary.Read(r, binary.BigEndian, &dest); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
dest -= uint32(d.written + 4)
|
|
||||||
if err = binary.Write(d.buf, binary.LittleEndian, dest); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
d.prevByte = byte(dest >> 24)
|
|
||||||
d.written += 4
|
|
||||||
} else {
|
|
||||||
d.prevByte = b
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
@ -1,45 +0,0 @@
|
|||||||
package filters
|
|
||||||
|
|
||||||
import "io"
|
|
||||||
|
|
||||||
const deltaStateSize = 256
|
|
||||||
|
|
||||||
// DeltaDecoder is a Delta decoder.
|
|
||||||
type DeltaDecoder struct {
|
|
||||||
state [deltaStateSize]byte
|
|
||||||
r io.Reader
|
|
||||||
delta uint
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewDeltaDecoder returns a new Delta decoder.
|
|
||||||
func NewDeltaDecoder(r io.Reader, delta uint, limit int64) (*DeltaDecoder, error) {
|
|
||||||
return &DeltaDecoder{r: r, delta: delta}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (d *DeltaDecoder) Read(p []byte) (int, error) {
|
|
||||||
n, err := d.r.Read(p)
|
|
||||||
if err != nil {
|
|
||||||
return n, err
|
|
||||||
}
|
|
||||||
|
|
||||||
var buf [deltaStateSize]byte
|
|
||||||
copy(buf[:], d.state[:d.delta])
|
|
||||||
|
|
||||||
var i, j uint
|
|
||||||
for i = 0; i < uint(n); {
|
|
||||||
for j = 0; j < d.delta && i < uint(n); i++ {
|
|
||||||
p[i] = buf[j] + p[i]
|
|
||||||
buf[j] = p[i]
|
|
||||||
j++
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if j == d.delta {
|
|
||||||
j = 0
|
|
||||||
}
|
|
||||||
|
|
||||||
copy(d.state[:], buf[j:d.delta])
|
|
||||||
copy(d.state[d.delta-j:], buf[:j])
|
|
||||||
|
|
||||||
return n, err
|
|
||||||
}
|
|
@ -1,32 +0,0 @@
|
|||||||
// +build gofuzz
|
|
||||||
|
|
||||||
package go7z
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"io"
|
|
||||||
"io/ioutil"
|
|
||||||
)
|
|
||||||
|
|
||||||
func Fuzz(data []byte) int {
|
|
||||||
sz := new(Reader)
|
|
||||||
if err := sz.init(bytes.NewReader(data), int64(len(data)), true); err != nil {
|
|
||||||
return 0
|
|
||||||
}
|
|
||||||
|
|
||||||
for {
|
|
||||||
_, err := sz.Next()
|
|
||||||
if err == io.EOF {
|
|
||||||
return 0
|
|
||||||
}
|
|
||||||
if err != nil {
|
|
||||||
return 0
|
|
||||||
}
|
|
||||||
|
|
||||||
if _, err = io.Copy(ioutil.Discard, sz); err != nil {
|
|
||||||
return 0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return 1
|
|
||||||
}
|
|
@ -1,25 +0,0 @@
|
|||||||
package headers
|
|
||||||
|
|
||||||
import (
|
|
||||||
"encoding/binary"
|
|
||||||
"io"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ReadDigests reads an array of uint32 CRCs.
|
|
||||||
func ReadDigests(r io.Reader, length int) ([]uint32, error) {
|
|
||||||
defined, _, err := ReadOptionalBoolVector(r, length)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
crcs := make([]uint32, length)
|
|
||||||
for i := range defined {
|
|
||||||
if defined[i] {
|
|
||||||
if err := binary.Read(r, binary.LittleEndian, &crcs[i]); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return crcs, nil
|
|
||||||
}
|
|
@ -1,159 +0,0 @@
|
|||||||
package headers
|
|
||||||
|
|
||||||
import (
|
|
||||||
"encoding/binary"
|
|
||||||
"errors"
|
|
||||||
"io"
|
|
||||||
"time"
|
|
||||||
"unicode/utf16"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ErrInvalidFileCount is returned when the file count read from the stream
|
|
||||||
// exceeds the caller supplied maxFileCount.
|
|
||||||
var ErrInvalidFileCount = errors.New("invalid file count")
|
|
||||||
|
|
||||||
// FileInfo is a structure containing the information of an archived file.
|
|
||||||
type FileInfo struct {
|
|
||||||
Name string
|
|
||||||
Attrib uint32
|
|
||||||
|
|
||||||
IsEmptyStream bool
|
|
||||||
IsEmptyFile bool
|
|
||||||
|
|
||||||
// Flag indicating a file should be removed upon extraction.
|
|
||||||
IsAntiFile bool
|
|
||||||
|
|
||||||
CreatedAt time.Time
|
|
||||||
AccessedAt time.Time
|
|
||||||
ModifiedAt time.Time
|
|
||||||
}
|
|
||||||
|
|
||||||
// ReadFilesInfo reads the files info structure.
|
|
||||||
func ReadFilesInfo(r io.Reader, maxFileCount int) ([]*FileInfo, error) {
|
|
||||||
numFiles, err := ReadNumberInt(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
if numFiles > maxFileCount {
|
|
||||||
return nil, ErrInvalidFileCount
|
|
||||||
}
|
|
||||||
|
|
||||||
fileInfo := make([]*FileInfo, numFiles)
|
|
||||||
for i := range fileInfo {
|
|
||||||
fileInfo[i] = &FileInfo{}
|
|
||||||
}
|
|
||||||
|
|
||||||
var numEmptyStreams int
|
|
||||||
for {
|
|
||||||
id, err := ReadByte(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
if id == k7zEnd {
|
|
||||||
return fileInfo, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
size, err := ReadNumber(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
switch id {
|
|
||||||
case k7zEmptyStream:
|
|
||||||
var emptyStreams []bool
|
|
||||||
emptyStreams, numEmptyStreams, err = ReadBoolVector(r, numFiles)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
for i, fi := range fileInfo {
|
|
||||||
fi.IsEmptyStream = emptyStreams[i]
|
|
||||||
}
|
|
||||||
|
|
||||||
case k7zEmptyFile, k7zAnti:
|
|
||||||
files, _, err := ReadBoolVector(r, numEmptyStreams)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
idx := 0
|
|
||||||
for _, fi := range fileInfo {
|
|
||||||
if fi.IsEmptyStream {
|
|
||||||
switch id {
|
|
||||||
case k7zEmptyFile:
|
|
||||||
fi.IsEmptyFile = files[idx]
|
|
||||||
case k7zAnti:
|
|
||||||
fi.IsAntiFile = files[idx]
|
|
||||||
}
|
|
||||||
idx++
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
case k7zStartPos:
|
|
||||||
return nil, ErrUnexpectedPropertyID
|
|
||||||
|
|
||||||
case k7zCTime, k7zATime, k7zMTime:
|
|
||||||
times, err := ReadDateTimeVector(r, numFiles)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
for i, fi := range fileInfo {
|
|
||||||
switch id {
|
|
||||||
case k7zCTime:
|
|
||||||
fi.CreatedAt = times[i]
|
|
||||||
case k7zATime:
|
|
||||||
fi.AccessedAt = times[i]
|
|
||||||
case k7zMTime:
|
|
||||||
fi.ModifiedAt = times[i]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
case k7zName:
|
|
||||||
external, err := ReadByte(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
switch external {
|
|
||||||
case 0:
|
|
||||||
for _, fi := range fileInfo {
|
|
||||||
var rune uint16
|
|
||||||
var name []uint16
|
|
||||||
for {
|
|
||||||
if err = binary.Read(r, binary.LittleEndian, &rune); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
if rune == 0 {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
name = append(name, rune)
|
|
||||||
}
|
|
||||||
fi.Name = string(utf16.Decode(name))
|
|
||||||
}
|
|
||||||
|
|
||||||
default:
|
|
||||||
return nil, ErrAdditionalStreamsNotImplemented
|
|
||||||
}
|
|
||||||
|
|
||||||
case k7zWinAttributes:
|
|
||||||
attributes, err := ReadAttributeVector(r, numFiles)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
for i, fi := range fileInfo {
|
|
||||||
fi.Attrib = attributes[i]
|
|
||||||
}
|
|
||||||
|
|
||||||
case k7zDummy:
|
|
||||||
for i := uint64(0); i < size; i++ {
|
|
||||||
if _, err = ReadByte(r); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
default:
|
|
||||||
return nil, ErrUnexpectedPropertyID
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,240 +0,0 @@
|
|||||||
package headers
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"io"
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
|
||||||
// MaxInOutStreams is the maximum allowed stream inputs/outputs into/out
|
|
||||||
// of a coder.
|
|
||||||
MaxInOutStreams = 4
|
|
||||||
|
|
||||||
// MaxPropertyDataSize is the size in bytes supported for coder property data.
|
|
||||||
MaxPropertyDataSize = 128
|
|
||||||
|
|
||||||
// MaxCodersInFolder is the maximum number of coders allowed to be
|
|
||||||
// specified in a folder.
|
|
||||||
MaxCodersInFolder = 4
|
|
||||||
|
|
||||||
// MaxPackedStreamsInFolder is the maximum number of packed streams allowed
|
|
||||||
// to be in a folder.
|
|
||||||
MaxPackedStreamsInFolder = 4
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
// ErrInvalidStreamCount is the error returned when the input/output stream
|
|
||||||
// count for a coder is <= 0 || > MaxInOutStreams.
|
|
||||||
ErrInvalidStreamCount = errors.New("invalid in/out stream count")
|
|
||||||
|
|
||||||
// ErrInvalidPropertyDataSize is the error returned when the property data
|
|
||||||
// size is <= 0 || > MaxInOutStreams.
|
|
||||||
ErrInvalidPropertyDataSize = errors.New("invalid property data size")
|
|
||||||
|
|
||||||
// ErrInvalidCoderInFolderCount is the error returned when the number of
|
|
||||||
// coders in a folder is <= 0 || > MaxCodersInFolder.
|
|
||||||
ErrInvalidCoderInFolderCount = errors.New("invalid coder in folder count")
|
|
||||||
|
|
||||||
// ErrInvalidPackedStreamsCount is the error returned when the number of
|
|
||||||
// packed streams exceeds MaxPackedStreamsInFolder
|
|
||||||
ErrInvalidPackedStreamsCount = errors.New("invalid packed streams count")
|
|
||||||
)
|
|
||||||
|
|
||||||
// Folder is a structure containing information on how a solid block was
|
|
||||||
// constructed.
|
|
||||||
type Folder struct {
|
|
||||||
CoderInfo []*CoderInfo
|
|
||||||
BindPairsInfo []*BindPairsInfo
|
|
||||||
PackedIndices []int
|
|
||||||
UnpackSizes []uint64
|
|
||||||
UnpackCRC uint32
|
|
||||||
}
|
|
||||||
|
|
||||||
// NumInStreamsTotal is the sum of inputs required by all codecs.
|
|
||||||
func (f *Folder) NumInStreamsTotal() int {
|
|
||||||
var count int
|
|
||||||
for i := range f.CoderInfo {
|
|
||||||
count += f.CoderInfo[i].NumInStreams
|
|
||||||
}
|
|
||||||
return count
|
|
||||||
}
|
|
||||||
|
|
||||||
// NumOutStreamsTotal is the sum of outputs required by all codecs.
|
|
||||||
func (f *Folder) NumOutStreamsTotal() int {
|
|
||||||
var count int
|
|
||||||
for i := range f.CoderInfo {
|
|
||||||
count += f.CoderInfo[i].NumOutStreams
|
|
||||||
}
|
|
||||||
return count
|
|
||||||
}
|
|
||||||
|
|
||||||
// FindBindPairForInStream returns the index of a bindpair by an in index.
|
|
||||||
func (f *Folder) FindBindPairForInStream(inStreamIndex int) int {
|
|
||||||
for i := range f.BindPairsInfo {
|
|
||||||
if f.BindPairsInfo[i].InIndex == inStreamIndex {
|
|
||||||
return i
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return -1
|
|
||||||
}
|
|
||||||
|
|
||||||
// FindBindPairForOutStream returns the index of a bindpair by an out index.
|
|
||||||
func (f *Folder) FindBindPairForOutStream(outStreamIndex int) int {
|
|
||||||
for i := range f.BindPairsInfo {
|
|
||||||
if f.BindPairsInfo[i].OutIndex == outStreamIndex {
|
|
||||||
return i
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return -1
|
|
||||||
}
|
|
||||||
|
|
||||||
// UnpackSize returns the final unpacked size of the folder.
|
|
||||||
func (f *Folder) UnpackSize() uint64 {
|
|
||||||
for i := range f.UnpackSizes {
|
|
||||||
if f.FindBindPairForOutStream(i) < 0 {
|
|
||||||
return f.UnpackSizes[i]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return 0
|
|
||||||
}
|
|
||||||
|
|
||||||
// ReadFolder reads a folder structure.
|
|
||||||
func ReadFolder(r io.Reader) (*Folder, error) {
|
|
||||||
var err error
|
|
||||||
|
|
||||||
folder := &Folder{}
|
|
||||||
|
|
||||||
numCoders, err := ReadNumberInt(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
if numCoders == 0 || numCoders > MaxCodersInFolder {
|
|
||||||
return nil, ErrInvalidCoderInFolderCount
|
|
||||||
}
|
|
||||||
|
|
||||||
folder.CoderInfo = make([]*CoderInfo, numCoders)
|
|
||||||
for i := range folder.CoderInfo {
|
|
||||||
if folder.CoderInfo[i], err = ReadCoderInfo(r); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
folder.BindPairsInfo = make([]*BindPairsInfo, numCoders-1)
|
|
||||||
for i := range folder.BindPairsInfo {
|
|
||||||
if folder.BindPairsInfo[i], err = ReadBindPairsInfo(r); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
numInStreamsTotal := folder.NumInStreamsTotal()
|
|
||||||
numPackedStreams := numInStreamsTotal - len(folder.BindPairsInfo)
|
|
||||||
if numPackedStreams > 1 {
|
|
||||||
if numPackedStreams > MaxPackedStreamsInFolder {
|
|
||||||
return nil, ErrInvalidPackedStreamsCount
|
|
||||||
}
|
|
||||||
|
|
||||||
folder.PackedIndices = make([]int, numPackedStreams)
|
|
||||||
for i := range folder.PackedIndices {
|
|
||||||
if folder.PackedIndices[i], err = ReadNumberInt(r); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
} else if numPackedStreams == 1 {
|
|
||||||
for i := 0; i < numInStreamsTotal; i++ {
|
|
||||||
if folder.FindBindPairForInStream(i) < 0 {
|
|
||||||
folder.PackedIndices = []int{i}
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return folder, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// CoderInfo is a structure holding information about a codec.
|
|
||||||
type CoderInfo struct {
|
|
||||||
CodecID uint32
|
|
||||||
Properties []byte
|
|
||||||
NumInStreams int
|
|
||||||
NumOutStreams int
|
|
||||||
}
|
|
||||||
|
|
||||||
// ReadCoderInfo reads a coder info structure.
|
|
||||||
func ReadCoderInfo(r io.Reader) (*CoderInfo, error) {
|
|
||||||
attributes, err := ReadByte(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
coderInfo := &CoderInfo{}
|
|
||||||
|
|
||||||
codecIDSize := attributes & 0x0f
|
|
||||||
isComplexCoder := attributes&0x10 > 0
|
|
||||||
hasAttributes := attributes&0x20 > 0
|
|
||||||
|
|
||||||
if codecIDSize > 0 {
|
|
||||||
b := make([]byte, codecIDSize)
|
|
||||||
if _, err = r.Read(b); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
for i := codecIDSize; i > 0; i-- {
|
|
||||||
coderInfo.CodecID |= uint32(b[i-1]) << ((codecIDSize - i) * 8)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
coderInfo.NumInStreams = 1
|
|
||||||
coderInfo.NumOutStreams = 1
|
|
||||||
if isComplexCoder {
|
|
||||||
if coderInfo.NumInStreams, err = ReadNumberInt(r); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
if coderInfo.NumInStreams == 0 || coderInfo.NumInStreams > MaxInOutStreams {
|
|
||||||
return nil, ErrInvalidStreamCount
|
|
||||||
}
|
|
||||||
|
|
||||||
if coderInfo.NumOutStreams, err = ReadNumberInt(r); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
if coderInfo.NumOutStreams == 0 || coderInfo.NumOutStreams > MaxInOutStreams {
|
|
||||||
return nil, ErrInvalidStreamCount
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if hasAttributes {
|
|
||||||
size, err := ReadNumberInt(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
if size <= 0 || size > MaxPropertyDataSize {
|
|
||||||
return nil, ErrInvalidPropertyDataSize
|
|
||||||
}
|
|
||||||
|
|
||||||
coderInfo.Properties = make([]byte, size)
|
|
||||||
if _, err = r.Read(coderInfo.Properties); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return coderInfo, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// BindPairsInfo is a structure that binds the in and out indexes of a codec.
|
|
||||||
type BindPairsInfo struct {
|
|
||||||
InIndex int
|
|
||||||
OutIndex int
|
|
||||||
}
|
|
||||||
|
|
||||||
// ReadBindPairsInfo reads a bindpairs info structure.
|
|
||||||
func ReadBindPairsInfo(r io.Reader) (*BindPairsInfo, error) {
|
|
||||||
bindPairsInfo := &BindPairsInfo{}
|
|
||||||
|
|
||||||
var err error
|
|
||||||
if bindPairsInfo.InIndex, err = ReadNumberInt(r); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
if bindPairsInfo.OutIndex, err = ReadNumberInt(r); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
return bindPairsInfo, nil
|
|
||||||
}
|
|
@ -1,152 +0,0 @@
|
|||||||
package headers
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"encoding/binary"
|
|
||||||
"errors"
|
|
||||||
"hash/crc32"
|
|
||||||
"io"
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
|
||||||
// SignatureHeader size is the size of the signature header.
|
|
||||||
SignatureHeaderSize = 32
|
|
||||||
|
|
||||||
// MaxHeaderSize is the maximum header size.
|
|
||||||
MaxHeaderSize = int64(1 << 62) // 4 exbibyte
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
// MagicBytes is the magic bytes used in the 7z signature.
|
|
||||||
MagicBytes = [6]byte{0x37, 0x7A, 0xBC, 0xAF, 0x27, 0x1C}
|
|
||||||
|
|
||||||
// ErrInvalidSignatureHeader is returned when signature header is invalid.
|
|
||||||
ErrInvalidSignatureHeader = errors.New("invalid signature header")
|
|
||||||
)
|
|
||||||
|
|
||||||
// SignatureHeader is the structure found at the top of 7z files.
|
|
||||||
type SignatureHeader struct {
|
|
||||||
Signature [6]byte
|
|
||||||
|
|
||||||
ArchiveVersion struct {
|
|
||||||
Major byte
|
|
||||||
Minor byte
|
|
||||||
}
|
|
||||||
|
|
||||||
StartHeaderCRC uint32
|
|
||||||
|
|
||||||
StartHeader struct {
|
|
||||||
NextHeaderOffset int64
|
|
||||||
NextHeaderSize int64
|
|
||||||
NextHeaderCRC uint32
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// ReadSignatureHeader reads the signature header.
|
|
||||||
func ReadSignatureHeader(r io.Reader) (*SignatureHeader, error) {
|
|
||||||
var raw [SignatureHeaderSize]byte
|
|
||||||
_, err := r.Read(raw[:])
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
var header SignatureHeader
|
|
||||||
copy(header.Signature[:], raw[:6])
|
|
||||||
if bytes.Compare(header.Signature[:], MagicBytes[:]) != 0 {
|
|
||||||
return nil, ErrInvalidSignatureHeader
|
|
||||||
}
|
|
||||||
|
|
||||||
header.ArchiveVersion.Major = raw[6]
|
|
||||||
header.ArchiveVersion.Minor = raw[7]
|
|
||||||
header.StartHeaderCRC = binary.LittleEndian.Uint32(raw[8:])
|
|
||||||
header.StartHeader.NextHeaderOffset = int64(binary.LittleEndian.Uint64(raw[12:]))
|
|
||||||
header.StartHeader.NextHeaderSize = int64(binary.LittleEndian.Uint64(raw[20:]))
|
|
||||||
header.StartHeader.NextHeaderCRC = binary.LittleEndian.Uint32(raw[28:])
|
|
||||||
|
|
||||||
if header.StartHeader.NextHeaderSize < 0 || header.StartHeader.NextHeaderSize > MaxHeaderSize {
|
|
||||||
return &header, ErrInvalidSignatureHeader
|
|
||||||
}
|
|
||||||
if crc32.ChecksumIEEE(raw[12:]) != header.StartHeaderCRC {
|
|
||||||
err = ErrChecksumMismatch
|
|
||||||
}
|
|
||||||
return &header, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Header is structure containing file and stream information.
|
|
||||||
type Header struct {
|
|
||||||
MainStreamsInfo *StreamsInfo
|
|
||||||
FilesInfo []*FileInfo
|
|
||||||
}
|
|
||||||
|
|
||||||
// ReadPackedStreamsForHeaders reads either a header or encoded header structure.
|
|
||||||
func ReadPackedStreamsForHeaders(r *io.LimitedReader) (header *Header, encodedHeader *StreamsInfo, err error) {
|
|
||||||
id, err := ReadByte(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
switch id {
|
|
||||||
case k7zHeader:
|
|
||||||
if header, err = ReadHeader(r); err != nil && err != io.EOF {
|
|
||||||
return nil, nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
case k7zEncodedHeader:
|
|
||||||
if encodedHeader, err = ReadStreamsInfo(r); err != nil {
|
|
||||||
return nil, nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
case k7zEnd:
|
|
||||||
if header == nil && encodedHeader == nil {
|
|
||||||
return nil, nil, ErrUnexpectedPropertyID
|
|
||||||
}
|
|
||||||
break
|
|
||||||
|
|
||||||
default:
|
|
||||||
return nil, nil, ErrUnexpectedPropertyID
|
|
||||||
}
|
|
||||||
|
|
||||||
return header, encodedHeader, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ReadHeader reads a header structure.
|
|
||||||
func ReadHeader(r *io.LimitedReader) (*Header, error) {
|
|
||||||
header := &Header{}
|
|
||||||
|
|
||||||
for {
|
|
||||||
id, err := ReadByte(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
switch id {
|
|
||||||
case k7zArchiveProperties:
|
|
||||||
return nil, ErrArchivePropertiesNotImplemented
|
|
||||||
|
|
||||||
case k7zAdditionalStreamsInfo:
|
|
||||||
return nil, ErrAdditionalStreamsNotImplemented
|
|
||||||
|
|
||||||
case k7zMainStreamsInfo:
|
|
||||||
if header.MainStreamsInfo, err = ReadStreamsInfo(r); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
case k7zFilesInfo:
|
|
||||||
// Limit the maximum amount of FileInfos that get allocated to size
|
|
||||||
// of the remaining header / 3
|
|
||||||
if header.FilesInfo, err = ReadFilesInfo(r, int(r.N)/3); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
case k7zEnd:
|
|
||||||
if header.MainStreamsInfo == nil {
|
|
||||||
return nil, ErrUnexpectedPropertyID
|
|
||||||
}
|
|
||||||
|
|
||||||
return header, nil
|
|
||||||
|
|
||||||
default:
|
|
||||||
return nil, ErrUnexpectedPropertyID
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,51 +0,0 @@
|
|||||||
package headers
|
|
||||||
|
|
||||||
import "io"
|
|
||||||
|
|
||||||
// PackInfo contains the pack stream sizes of the folders.
|
|
||||||
type PackInfo struct {
|
|
||||||
PackPos uint64
|
|
||||||
PackSizes []uint64
|
|
||||||
}
|
|
||||||
|
|
||||||
// ReadPackInfo reads a pack info structure.
|
|
||||||
func ReadPackInfo(r io.Reader) (*PackInfo, error) {
|
|
||||||
packInfo := &PackInfo{}
|
|
||||||
|
|
||||||
var err error
|
|
||||||
if packInfo.PackPos, err = ReadNumber(r); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
numPackStreams, err := ReadNumberInt(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
for {
|
|
||||||
id, err := ReadByte(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
switch id {
|
|
||||||
case k7zSize:
|
|
||||||
packInfo.PackSizes = make([]uint64, numPackStreams+1)
|
|
||||||
for i := 0; i < numPackStreams; i++ {
|
|
||||||
packInfo.PackSizes[i], err = ReadNumber(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
case k7zCRC:
|
|
||||||
return nil, ErrPackInfoCRCsNotImplemented
|
|
||||||
|
|
||||||
case k7zEnd:
|
|
||||||
return packInfo, nil
|
|
||||||
|
|
||||||
default:
|
|
||||||
return nil, ErrUnexpectedPropertyID
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,262 +0,0 @@
|
|||||||
package headers
|
|
||||||
|
|
||||||
import (
|
|
||||||
"encoding/binary"
|
|
||||||
"errors"
|
|
||||||
"io"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
|
||||||
k7zEnd = iota
|
|
||||||
k7zHeader
|
|
||||||
k7zArchiveProperties
|
|
||||||
k7zAdditionalStreamsInfo
|
|
||||||
k7zMainStreamsInfo
|
|
||||||
k7zFilesInfo
|
|
||||||
k7zPackInfo
|
|
||||||
k7zUnpackInfo
|
|
||||||
k7zSubStreamsInfo
|
|
||||||
k7zSize
|
|
||||||
k7zCRC
|
|
||||||
k7zFolder
|
|
||||||
k7zCodersUnpackSize
|
|
||||||
k7zNumUnpackStream
|
|
||||||
k7zEmptyStream
|
|
||||||
k7zEmptyFile
|
|
||||||
k7zAnti
|
|
||||||
k7zName
|
|
||||||
k7zCTime
|
|
||||||
k7zATime
|
|
||||||
k7zMTime
|
|
||||||
k7zWinAttributes
|
|
||||||
k7zComment
|
|
||||||
k7zEncodedHeader
|
|
||||||
k7zStartPos
|
|
||||||
k7zDummy
|
|
||||||
)
|
|
||||||
|
|
||||||
const MaxNumber = 0x7FFFFFFF
|
|
||||||
|
|
||||||
var (
|
|
||||||
// ErrUnexpectedPropertyID is returned when we read a property id that was
|
|
||||||
// either unexpected, or we don't support.
|
|
||||||
ErrUnexpectedPropertyID = errors.New("unexpected property id")
|
|
||||||
|
|
||||||
// ErrAdditionalStreamsNotImplemented is returned for archives using
|
|
||||||
// additional streams. These were apparently used in older versions of 7zip.
|
|
||||||
ErrAdditionalStreamsNotImplemented = errors.New("additional streams are not implemented")
|
|
||||||
|
|
||||||
// ErrArchivePropertiesNotImplemented is returned if archive properties
|
|
||||||
// structure is found. So far, this hasn't been used in any verison of 7zip.
|
|
||||||
ErrArchivePropertiesNotImplemented = errors.New("archive properties are not implemented")
|
|
||||||
|
|
||||||
// ErrChecksumMismatch is returned when a CRC check fails.
|
|
||||||
ErrChecksumMismatch = errors.New("checksum mismatch")
|
|
||||||
|
|
||||||
// ErrPackInfoCRCsNotImplemented is returned if a CRC property id is
|
|
||||||
// encountered whilst reading packinfo.
|
|
||||||
ErrPackInfoCRCsNotImplemented = errors.New("packinfo crcs are not implemented")
|
|
||||||
|
|
||||||
// ErrInvalidNumber is returned when a number read exceeds 0x7FFFFFFF
|
|
||||||
ErrInvalidNumber = errors.New("invalid number")
|
|
||||||
)
|
|
||||||
|
|
||||||
// ReadByte reads a single byte.
|
|
||||||
func ReadByte(r io.Reader) (byte, error) {
|
|
||||||
var val [1]byte
|
|
||||||
_, err := r.Read(val[:])
|
|
||||||
return val[0], err
|
|
||||||
}
|
|
||||||
|
|
||||||
// ReadByteExpect reads a byte to be expected, errors if unexpected.
|
|
||||||
func ReadByteExpect(r io.Reader, val byte) error {
|
|
||||||
value, err := ReadByte(r)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if value != val {
|
|
||||||
return ErrUnexpectedPropertyID
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ReadNumber reads a 7z encoded uint64.
|
|
||||||
func ReadNumber(r io.Reader) (uint64, error) {
|
|
||||||
first, err := ReadByte(r)
|
|
||||||
if err != nil {
|
|
||||||
return 0, err
|
|
||||||
}
|
|
||||||
|
|
||||||
var value uint64
|
|
||||||
mask := byte(0x80)
|
|
||||||
for i := uint64(0); i < 8; i++ {
|
|
||||||
if first&mask == 0 {
|
|
||||||
hp := uint64(first) & (uint64(mask) - 1)
|
|
||||||
value += hp << (i * 8)
|
|
||||||
return value, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
val, err := ReadByte(r)
|
|
||||||
if err != nil {
|
|
||||||
return 0, err
|
|
||||||
}
|
|
||||||
|
|
||||||
value |= uint64(val) << (8 * i)
|
|
||||||
mask >>= 1
|
|
||||||
}
|
|
||||||
|
|
||||||
return value, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ReadNumberInt is the same as ReadNumber, but cast to int.
|
|
||||||
func ReadNumberInt(r io.Reader) (int, error) {
|
|
||||||
u64, err := ReadNumber(r)
|
|
||||||
if u64 > MaxNumber {
|
|
||||||
return 0, ErrInvalidNumber
|
|
||||||
}
|
|
||||||
|
|
||||||
return int(u64), err
|
|
||||||
}
|
|
||||||
|
|
||||||
// ReadUint32 reads a uint32.
|
|
||||||
func ReadUint32(r io.Reader) (uint32, error) {
|
|
||||||
var v uint32
|
|
||||||
return v, binary.Read(r, binary.LittleEndian, &v)
|
|
||||||
}
|
|
||||||
|
|
||||||
// ReadUint64 reads a uint64.
|
|
||||||
func ReadUint64(r io.Reader) (uint64, error) {
|
|
||||||
var v uint64
|
|
||||||
return v, binary.Read(r, binary.LittleEndian, &v)
|
|
||||||
}
|
|
||||||
|
|
||||||
// ReadBoolVector reads a vector of boolean values.
|
|
||||||
func ReadBoolVector(r io.Reader, length int) ([]bool, int, error) {
|
|
||||||
var b byte
|
|
||||||
var mask byte
|
|
||||||
var err error
|
|
||||||
v := make([]bool, length)
|
|
||||||
|
|
||||||
count := 0
|
|
||||||
for i := range v {
|
|
||||||
if mask == 0 {
|
|
||||||
b, err = ReadByte(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, 0, err
|
|
||||||
}
|
|
||||||
mask = 0x80
|
|
||||||
}
|
|
||||||
v[i] = (b & mask) != 0
|
|
||||||
mask >>= 1
|
|
||||||
if v[i] {
|
|
||||||
count++
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return v, count, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ReadOptionalBoolVector reads a vector of boolean values if they're available,
|
|
||||||
// otherwise it returns an array of booleans all being true.
|
|
||||||
func ReadOptionalBoolVector(r io.Reader, length int) ([]bool, int, error) {
|
|
||||||
allDefined, err := ReadByte(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, 0, err
|
|
||||||
}
|
|
||||||
|
|
||||||
if allDefined == 0 {
|
|
||||||
return ReadBoolVector(r, length)
|
|
||||||
}
|
|
||||||
|
|
||||||
defined := make([]bool, length)
|
|
||||||
for i := range defined {
|
|
||||||
defined[i] = true
|
|
||||||
}
|
|
||||||
|
|
||||||
return defined, length, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ReadNumberVector returns a vector of 7z encoded int64s.
|
|
||||||
func ReadNumberVector(r io.Reader, numFiles int) ([]*int64, error) {
|
|
||||||
defined, _, err := ReadOptionalBoolVector(r, numFiles)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
external, err := ReadByte(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
if external != 0 {
|
|
||||||
return nil, ErrAdditionalStreamsNotImplemented
|
|
||||||
}
|
|
||||||
|
|
||||||
numbers := make([]*int64, numFiles)
|
|
||||||
for i := 0; i < numFiles; i++ {
|
|
||||||
if defined[i] {
|
|
||||||
num, err := ReadUint64(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
val := int64(num)
|
|
||||||
numbers[i] = &val
|
|
||||||
} else {
|
|
||||||
numbers[i] = nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return numbers, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// ReadDateTimeVector reads a vector of datetime values.
|
|
||||||
func ReadDateTimeVector(r io.Reader, numFiles int) ([]time.Time, error) {
|
|
||||||
timestamps, err := ReadNumberVector(r, numFiles)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
times := make([]time.Time, len(timestamps))
|
|
||||||
for i := range times {
|
|
||||||
if timestamps[i] != nil {
|
|
||||||
nsec := *timestamps[i]
|
|
||||||
nsec -= 116444736000000000
|
|
||||||
nsec *= 100
|
|
||||||
|
|
||||||
times[i] = time.Unix(0, nsec)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return times, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ReadAttributeVector reads a vector of uint32s.
|
|
||||||
func ReadAttributeVector(r io.Reader, numFiles int) ([]uint32, error) {
|
|
||||||
defined, _, err := ReadOptionalBoolVector(r, numFiles)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
external, err := ReadByte(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
if external != 0 {
|
|
||||||
return nil, ErrAdditionalStreamsNotImplemented
|
|
||||||
}
|
|
||||||
|
|
||||||
attributes := make([]uint32, numFiles)
|
|
||||||
for i := range attributes {
|
|
||||||
if defined[i] {
|
|
||||||
val, err := ReadUint32(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
attributes[i] = val
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return attributes, nil
|
|
||||||
}
|
|
@ -1,143 +0,0 @@
|
|||||||
package headers
|
|
||||||
|
|
||||||
import (
|
|
||||||
"io"
|
|
||||||
)
|
|
||||||
|
|
||||||
// StreamsInfo is a top-level structure of the 7z format.
|
|
||||||
type StreamsInfo struct {
|
|
||||||
PackInfo *PackInfo
|
|
||||||
UnpackInfo *UnpackInfo
|
|
||||||
SubStreamsInfo *SubStreamsInfo
|
|
||||||
}
|
|
||||||
|
|
||||||
// ReadStreamsInfo reads the streams info structure.
|
|
||||||
func ReadStreamsInfo(r io.Reader) (*StreamsInfo, error) {
|
|
||||||
streamsInfo := &StreamsInfo{}
|
|
||||||
|
|
||||||
for {
|
|
||||||
id, err := ReadByte(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
switch id {
|
|
||||||
case k7zPackInfo:
|
|
||||||
if streamsInfo.PackInfo, err = ReadPackInfo(r); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
case k7zUnpackInfo:
|
|
||||||
if streamsInfo.UnpackInfo, err = ReadUnpackInfo(r); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
case k7zSubStreamsInfo:
|
|
||||||
if streamsInfo.UnpackInfo == nil {
|
|
||||||
return nil, ErrUnexpectedPropertyID
|
|
||||||
}
|
|
||||||
|
|
||||||
if streamsInfo.SubStreamsInfo, err = ReadSubStreamsInfo(r, streamsInfo.UnpackInfo); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
case k7zEnd:
|
|
||||||
if streamsInfo.PackInfo == nil || streamsInfo.UnpackInfo == nil {
|
|
||||||
return nil, ErrUnexpectedPropertyID
|
|
||||||
}
|
|
||||||
|
|
||||||
return streamsInfo, nil
|
|
||||||
|
|
||||||
default:
|
|
||||||
return nil, ErrUnexpectedPropertyID
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// SubStreamsInfo is a structure found within the StreamsInfo structure.
|
|
||||||
type SubStreamsInfo struct {
|
|
||||||
NumUnpackStreamsInFolders []int
|
|
||||||
UnpackSizes []uint64
|
|
||||||
Digests []uint32
|
|
||||||
}
|
|
||||||
|
|
||||||
// ReadSubStreamsInfo reads the substreams info structure.
|
|
||||||
func ReadSubStreamsInfo(r io.Reader, unpackInfo *UnpackInfo) (*SubStreamsInfo, error) {
|
|
||||||
id, err := ReadByte(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
subStreamInfo := &SubStreamsInfo{}
|
|
||||||
subStreamInfo.NumUnpackStreamsInFolders = make([]int, len(unpackInfo.Folders))
|
|
||||||
for i := range subStreamInfo.NumUnpackStreamsInFolders {
|
|
||||||
subStreamInfo.NumUnpackStreamsInFolders[i] = 1
|
|
||||||
}
|
|
||||||
|
|
||||||
if id == k7zNumUnpackStream {
|
|
||||||
for i := range subStreamInfo.NumUnpackStreamsInFolders {
|
|
||||||
if subStreamInfo.NumUnpackStreamsInFolders[i], err = ReadNumberInt(r); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
id, err = ReadByte(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
for i := range unpackInfo.Folders {
|
|
||||||
if subStreamInfo.NumUnpackStreamsInFolders[i] == 0 {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
var sum uint64
|
|
||||||
if id == k7zSize {
|
|
||||||
for j := 1; j < subStreamInfo.NumUnpackStreamsInFolders[i]; j++ {
|
|
||||||
size, err := ReadNumber(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
sum += size
|
|
||||||
subStreamInfo.UnpackSizes = append(subStreamInfo.UnpackSizes, size)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
subStreamInfo.UnpackSizes = append(subStreamInfo.UnpackSizes, unpackInfo.Folders[i].UnpackSize()-uint64(sum))
|
|
||||||
}
|
|
||||||
|
|
||||||
if id == k7zSize {
|
|
||||||
id, err = ReadByte(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
numDigests := 0
|
|
||||||
for i := range unpackInfo.Folders {
|
|
||||||
numSubStreams := subStreamInfo.NumUnpackStreamsInFolders[i]
|
|
||||||
if numSubStreams > 1 || unpackInfo.Folders[i].UnpackCRC == 0 {
|
|
||||||
numDigests += int(numSubStreams)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if id == k7zCRC {
|
|
||||||
subStreamInfo.Digests, err = ReadDigests(r, numDigests)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
id, err = ReadByte(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if id != k7zEnd {
|
|
||||||
return nil, ErrUnexpectedPropertyID
|
|
||||||
}
|
|
||||||
|
|
||||||
return subStreamInfo, nil
|
|
||||||
}
|
|
@ -1,89 +0,0 @@
|
|||||||
package headers
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"io"
|
|
||||||
)
|
|
||||||
|
|
||||||
const MaxFolderCount = 1 << 30
|
|
||||||
|
|
||||||
// ErrInvalidCountExceeded is returned when the folder count is
|
|
||||||
// < 0 || > MaxFolderCount
|
|
||||||
var ErrInvalidCountExceeded = errors.New("invalid folder count")
|
|
||||||
|
|
||||||
// UnpackInfo is a structure containing folders.
|
|
||||||
type UnpackInfo struct {
|
|
||||||
Folders []*Folder
|
|
||||||
}
|
|
||||||
|
|
||||||
// ReadUnpackInfo reads unpack info structures.
|
|
||||||
func ReadUnpackInfo(r io.Reader) (*UnpackInfo, error) {
|
|
||||||
err := ReadByteExpect(r, k7zFolder)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
numFolders, err := ReadNumberInt(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
if numFolders > MaxFolderCount {
|
|
||||||
return nil, ErrInvalidCountExceeded
|
|
||||||
}
|
|
||||||
|
|
||||||
unpackInfo := &UnpackInfo{}
|
|
||||||
external, err := ReadByte(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
switch external {
|
|
||||||
case 0:
|
|
||||||
unpackInfo.Folders = make([]*Folder, numFolders)
|
|
||||||
for i := range unpackInfo.Folders {
|
|
||||||
if unpackInfo.Folders[i], err = ReadFolder(r); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
default:
|
|
||||||
return nil, ErrAdditionalStreamsNotImplemented
|
|
||||||
}
|
|
||||||
|
|
||||||
if err = ReadByteExpect(r, k7zCodersUnpackSize); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
for _, folder := range unpackInfo.Folders {
|
|
||||||
folder.UnpackSizes = make([]uint64, folder.NumOutStreamsTotal())
|
|
||||||
for i := range folder.UnpackSizes {
|
|
||||||
if folder.UnpackSizes[i], err = ReadNumber(r); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
id, err := ReadByte(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
if id == k7zCRC {
|
|
||||||
crcs, err := ReadDigests(r, len(unpackInfo.Folders))
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
for i := range unpackInfo.Folders {
|
|
||||||
unpackInfo.Folders[i].UnpackCRC = crcs[i]
|
|
||||||
}
|
|
||||||
|
|
||||||
id, err = ReadByte(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if id != k7zEnd {
|
|
||||||
return nil, ErrUnexpectedPropertyID
|
|
||||||
}
|
|
||||||
|
|
||||||
return unpackInfo, nil
|
|
||||||
}
|
|
@ -1,377 +0,0 @@
|
|||||||
package go7z
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bufio"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"hash/crc32"
|
|
||||||
"io"
|
|
||||||
"os"
|
|
||||||
"sync"
|
|
||||||
|
|
||||||
"github.com/saracen/go7z/headers"
|
|
||||||
"github.com/saracen/solidblock"
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
// ErrNotSupported is returned when an unrecognized archive format is
|
|
||||||
// encountered.
|
|
||||||
ErrNotSupported = errors.New("not supported")
|
|
||||||
|
|
||||||
// ErrDecompressorNotFound is returned when a requested decompressor has not
|
|
||||||
// been registered.
|
|
||||||
ErrDecompressorNotFound = errors.New("decompressor not found")
|
|
||||||
)
|
|
||||||
|
|
||||||
// Reader is a 7z archive reader.
|
|
||||||
type Reader struct {
|
|
||||||
r *io.SectionReader
|
|
||||||
err error
|
|
||||||
|
|
||||||
header *headers.Header
|
|
||||||
|
|
||||||
folderIndex int
|
|
||||||
fileIndex int
|
|
||||||
emptyStream bool
|
|
||||||
|
|
||||||
folders []*folderReader
|
|
||||||
|
|
||||||
Options ReaderOptions
|
|
||||||
}
|
|
||||||
|
|
||||||
// ReaderOptions are optional options to configure a 7z archive reader.
|
|
||||||
type ReaderOptions struct {
|
|
||||||
password string
|
|
||||||
cb func() string
|
|
||||||
}
|
|
||||||
|
|
||||||
// SetPassword sets the password used for extraction.
|
|
||||||
func (o *ReaderOptions) SetPassword(password string) {
|
|
||||||
o.password = password
|
|
||||||
}
|
|
||||||
|
|
||||||
// SetPasswordCallback sets the callback thats used if a password is required,
|
|
||||||
// but wasn't supplied with SetPassword()
|
|
||||||
func (o *ReaderOptions) SetPasswordCallback(cb func() string) {
|
|
||||||
o.cb = cb
|
|
||||||
}
|
|
||||||
|
|
||||||
// Password returns the set password. This will call the password callback
|
|
||||||
// supplied to SetPasswordCallback() if no password is set.
|
|
||||||
func (o *ReaderOptions) Password() string {
|
|
||||||
if o.password != "" {
|
|
||||||
return o.password
|
|
||||||
}
|
|
||||||
if o.cb != nil {
|
|
||||||
o.password = o.cb()
|
|
||||||
}
|
|
||||||
return o.password
|
|
||||||
}
|
|
||||||
|
|
||||||
// ReadCloser provides an io.ReadCloser for the archive when opened with
|
|
||||||
// OpenReader.
|
|
||||||
type ReadCloser struct {
|
|
||||||
f *os.File
|
|
||||||
Reader
|
|
||||||
}
|
|
||||||
|
|
||||||
// Close closes the 7z file, rendering it unusable for I/O.
|
|
||||||
func (rc *ReadCloser) Close() error {
|
|
||||||
return rc.f.Close()
|
|
||||||
}
|
|
||||||
|
|
||||||
// OpenReader will open the 7z file specified by name and return a ReadCloser.
|
|
||||||
func OpenReader(name string) (*ReadCloser, error) {
|
|
||||||
f, err := os.Open(name)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
fi, err := f.Stat()
|
|
||||||
if err != nil {
|
|
||||||
f.Close()
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
r := new(ReadCloser)
|
|
||||||
if err := r.init(f, fi.Size(), false); err != nil {
|
|
||||||
f.Close()
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
r.f = f
|
|
||||||
|
|
||||||
return r, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewReader returns a new Reader reading from r, which is assumed to
|
|
||||||
// have the given size in bytes.
|
|
||||||
func NewReader(r io.ReaderAt, size int64) (*Reader, error) {
|
|
||||||
szr := new(Reader)
|
|
||||||
if err := szr.init(r, size, false); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return szr, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (sz *Reader) init(r io.ReaderAt, size int64, ignoreChecksumError bool) error {
|
|
||||||
sz.r = io.NewSectionReader(r, 0, size)
|
|
||||||
signatureHeader, err := headers.ReadSignatureHeader(sz.r)
|
|
||||||
if err != nil {
|
|
||||||
if !(ignoreChecksumError && err == headers.ErrChecksumMismatch) {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if _, err := sz.r.Seek(signatureHeader.StartHeader.NextHeaderOffset, io.SeekCurrent); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
if signatureHeader.StartHeader.NextHeaderSize > size-headers.SignatureHeaderSize {
|
|
||||||
return io.ErrUnexpectedEOF
|
|
||||||
}
|
|
||||||
|
|
||||||
crc := crc32.NewIEEE()
|
|
||||||
tee := io.TeeReader(bufio.NewReader(io.LimitReader(sz.r, signatureHeader.StartHeader.NextHeaderSize)), crc)
|
|
||||||
|
|
||||||
header, encoded, err := headers.ReadPackedStreamsForHeaders(&io.LimitedReader{tee, signatureHeader.StartHeader.NextHeaderSize})
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if crc.Sum32() != signatureHeader.StartHeader.NextHeaderCRC {
|
|
||||||
if !ignoreChecksumError {
|
|
||||||
return headers.ErrChecksumMismatch
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if encoded != nil {
|
|
||||||
folders, err := sz.extract(encoded)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if len(folders) != 1 {
|
|
||||||
return ErrNotSupported
|
|
||||||
}
|
|
||||||
if err = folders[0].Next(); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
header, _, err = headers.ReadPackedStreamsForHeaders(&io.LimitedReader{folders[0].sb, folders[0].sb.Size()})
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
if err = folders[0].Next(); err != io.EOF {
|
|
||||||
return ErrNotSupported
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if header == nil {
|
|
||||||
return ErrNotSupported
|
|
||||||
}
|
|
||||||
sz.header = header
|
|
||||||
sz.folders, err = sz.extract(sz.header.MainStreamsInfo)
|
|
||||||
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Next advances to the next entry in the 7z archive.
|
|
||||||
//
|
|
||||||
// io.EOF is returned at the end of the input.
|
|
||||||
func (sz *Reader) Next() (*headers.FileInfo, error) {
|
|
||||||
if sz.err != nil {
|
|
||||||
return nil, sz.err
|
|
||||||
}
|
|
||||||
hdr, err := sz.next()
|
|
||||||
sz.err = err
|
|
||||||
return hdr, err
|
|
||||||
}
|
|
||||||
|
|
||||||
func (sz *Reader) nextFileInfo() *headers.FileInfo {
|
|
||||||
var fileInfo *headers.FileInfo
|
|
||||||
if sz.fileIndex < len(sz.header.FilesInfo) {
|
|
||||||
fileInfo = sz.header.FilesInfo[sz.fileIndex]
|
|
||||||
sz.fileIndex++
|
|
||||||
return fileInfo
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (sz *Reader) extract(streamsInfo *headers.StreamsInfo) ([]*folderReader, error) {
|
|
||||||
var sizes []uint64
|
|
||||||
var crcs []uint32
|
|
||||||
if streamsInfo.SubStreamsInfo != nil {
|
|
||||||
sizes = streamsInfo.SubStreamsInfo.UnpackSizes
|
|
||||||
crcs = streamsInfo.SubStreamsInfo.Digests
|
|
||||||
}
|
|
||||||
|
|
||||||
offset := int64(headers.SignatureHeaderSize)
|
|
||||||
offset += int64(streamsInfo.PackInfo.PackPos)
|
|
||||||
packedIndicesOffset := 0
|
|
||||||
|
|
||||||
var folders []*folderReader
|
|
||||||
for i, folder := range streamsInfo.UnpackInfo.Folders {
|
|
||||||
if len(folder.PackedIndices) == 0 {
|
|
||||||
folder.PackedIndices = []int{0}
|
|
||||||
}
|
|
||||||
|
|
||||||
fr := &folderReader{}
|
|
||||||
fr.inputs = make(map[int]io.Reader)
|
|
||||||
fr.binder = solidblock.Binder{}
|
|
||||||
|
|
||||||
// setup codecs
|
|
||||||
for j := range folder.CoderInfo {
|
|
||||||
coderInfo := folder.CoderInfo[j]
|
|
||||||
size := folder.UnpackSizes[j]
|
|
||||||
|
|
||||||
d := decompressor(coderInfo.CodecID)
|
|
||||||
if d == nil {
|
|
||||||
return folders, ErrDecompressorNotFound
|
|
||||||
}
|
|
||||||
|
|
||||||
fn := func(in []io.Reader) ([]io.Reader, error) {
|
|
||||||
r, err := d(in, coderInfo.Properties, size, &sz.Options)
|
|
||||||
|
|
||||||
return []io.Reader{r}, err
|
|
||||||
}
|
|
||||||
|
|
||||||
fr.binder.AddCodec(fn, coderInfo.NumInStreams, coderInfo.NumOutStreams)
|
|
||||||
}
|
|
||||||
|
|
||||||
// setup initial inputs
|
|
||||||
for index, input := range folder.PackedIndices {
|
|
||||||
if packedIndicesOffset+index >= len(streamsInfo.PackInfo.PackSizes) {
|
|
||||||
return nil, fmt.Errorf("folder references invalid packinfo")
|
|
||||||
}
|
|
||||||
|
|
||||||
size := int64(streamsInfo.PackInfo.PackSizes[packedIndicesOffset+index])
|
|
||||||
fr.inputs[input] = io.NewSectionReader(sz.r, offset, size)
|
|
||||||
offset += size
|
|
||||||
}
|
|
||||||
packedIndicesOffset += len(folder.PackedIndices)
|
|
||||||
|
|
||||||
// setup pairs
|
|
||||||
for _, bindPairsInfo := range folder.BindPairsInfo {
|
|
||||||
fr.binder.Pair(bindPairsInfo.InIndex, bindPairsInfo.OutIndex)
|
|
||||||
}
|
|
||||||
|
|
||||||
if streamsInfo.SubStreamsInfo != nil {
|
|
||||||
numUnpackStreamsInFolders := streamsInfo.SubStreamsInfo.NumUnpackStreamsInFolders
|
|
||||||
if i >= len(numUnpackStreamsInFolders) {
|
|
||||||
return nil, fmt.Errorf("folder references invalid unpack stream")
|
|
||||||
}
|
|
||||||
|
|
||||||
off := numUnpackStreamsInFolders[i]
|
|
||||||
if off > len(sizes) || off > len(crcs) {
|
|
||||||
return nil, fmt.Errorf("folder references invalid unpack size or digest")
|
|
||||||
}
|
|
||||||
|
|
||||||
fr.sizes = sizes[:off]
|
|
||||||
fr.crcs = crcs[:off]
|
|
||||||
sizes = sizes[len(fr.sizes):]
|
|
||||||
crcs = crcs[len(fr.crcs):]
|
|
||||||
} else {
|
|
||||||
fr.sizes = []uint64{folder.UnpackSize()}
|
|
||||||
fr.crcs = []uint32{folder.UnpackCRC}
|
|
||||||
}
|
|
||||||
|
|
||||||
folders = append(folders, fr)
|
|
||||||
}
|
|
||||||
|
|
||||||
return folders, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
type folderReader struct {
|
|
||||||
binder solidblock.Binder
|
|
||||||
sizes []uint64
|
|
||||||
crcs []uint32
|
|
||||||
|
|
||||||
inputs map[int]io.Reader
|
|
||||||
|
|
||||||
bufs []*bufio.Reader
|
|
||||||
|
|
||||||
sb *solidblock.Solidblock
|
|
||||||
}
|
|
||||||
|
|
||||||
var bufioReaderPool = sync.Pool{
|
|
||||||
New: func() interface{} {
|
|
||||||
return bufio.NewReaderSize(nil, 32*1024)
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
func (fr *folderReader) Next() error {
|
|
||||||
if fr.sb == nil {
|
|
||||||
|
|
||||||
fr.bufs = make([]*bufio.Reader, 0, len(fr.inputs))
|
|
||||||
for in, r := range fr.inputs {
|
|
||||||
br := bufioReaderPool.Get().(*bufio.Reader)
|
|
||||||
br.Reset(r)
|
|
||||||
fr.bufs = append(fr.bufs, br)
|
|
||||||
|
|
||||||
fr.binder.Reader(br, in)
|
|
||||||
}
|
|
||||||
|
|
||||||
outputs, err := fr.binder.Outputs()
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if len(outputs) != 1 {
|
|
||||||
return ErrNotSupported
|
|
||||||
}
|
|
||||||
if outputs[0] == nil {
|
|
||||||
return ErrNotSupported
|
|
||||||
}
|
|
||||||
|
|
||||||
fr.sb = solidblock.New(outputs[0], fr.sizes, fr.crcs)
|
|
||||||
}
|
|
||||||
|
|
||||||
return fr.sb.Next()
|
|
||||||
}
|
|
||||||
|
|
||||||
func (fr *folderReader) Close() error {
|
|
||||||
for _, buf := range fr.bufs {
|
|
||||||
bufioReaderPool.Put(buf)
|
|
||||||
}
|
|
||||||
fr.bufs = nil
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (sz *Reader) next() (*headers.FileInfo, error) {
|
|
||||||
fileInfo := sz.nextFileInfo()
|
|
||||||
if fileInfo == nil {
|
|
||||||
return nil, io.EOF
|
|
||||||
}
|
|
||||||
|
|
||||||
sz.emptyStream = fileInfo.IsEmptyStream
|
|
||||||
if sz.emptyStream {
|
|
||||||
return fileInfo, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
if sz.folders[sz.folderIndex].Next() == io.EOF {
|
|
||||||
sz.folders[sz.folderIndex].Close()
|
|
||||||
sz.folderIndex++
|
|
||||||
if sz.folderIndex >= len(sz.folders) {
|
|
||||||
return nil, io.EOF
|
|
||||||
}
|
|
||||||
sz.folders[sz.folderIndex].Next()
|
|
||||||
}
|
|
||||||
|
|
||||||
return fileInfo, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Read reads from the current file in the 7z archive.
|
|
||||||
// It returns (0, io.EOF) when it reaches the end of that file,
|
|
||||||
// until Next is called to advance to the next file.
|
|
||||||
func (sz *Reader) Read(p []byte) (int, error) {
|
|
||||||
if sz.err != nil {
|
|
||||||
return 0, sz.err
|
|
||||||
}
|
|
||||||
if sz.emptyStream {
|
|
||||||
return 0, io.EOF
|
|
||||||
}
|
|
||||||
|
|
||||||
n, err := sz.folders[sz.folderIndex].sb.Read(p)
|
|
||||||
if err != nil && err != io.EOF {
|
|
||||||
sz.err = err
|
|
||||||
}
|
|
||||||
return n, err
|
|
||||||
}
|
|
@ -1,129 +0,0 @@
|
|||||||
package go7z
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"compress/bzip2"
|
|
||||||
"compress/flate"
|
|
||||||
"encoding/binary"
|
|
||||||
"io"
|
|
||||||
"sync"
|
|
||||||
|
|
||||||
"github.com/saracen/go7z/filters"
|
|
||||||
"github.com/ulikunitz/xz/lzma"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Decompressor is a handler function called when a registered decompressor is
|
|
||||||
// initialized.
|
|
||||||
type Decompressor func(r []io.Reader, options []byte, unpackSize uint64, ro *ReaderOptions) (io.Reader, error)
|
|
||||||
|
|
||||||
var (
|
|
||||||
decompressors sync.Map // map[uint32]Decompressor
|
|
||||||
)
|
|
||||||
|
|
||||||
func init() {
|
|
||||||
// copy
|
|
||||||
RegisterDecompressor(0x00, Decompressor(func(r []io.Reader, options []byte, unpackSize uint64, ro *ReaderOptions) (io.Reader, error) {
|
|
||||||
if len(r) != 1 {
|
|
||||||
return nil, ErrNotSupported
|
|
||||||
}
|
|
||||||
return r[0], nil
|
|
||||||
}))
|
|
||||||
|
|
||||||
// delta
|
|
||||||
RegisterDecompressor(0x03, Decompressor(func(r []io.Reader, options []byte, unpackSize uint64, ro *ReaderOptions) (io.Reader, error) {
|
|
||||||
if len(r) != 1 || len(options) == 0 || len(options) > 1 {
|
|
||||||
return nil, ErrNotSupported
|
|
||||||
}
|
|
||||||
|
|
||||||
return filters.NewDeltaDecoder(r[0], uint(options[0])+1, int64(unpackSize))
|
|
||||||
}))
|
|
||||||
|
|
||||||
// lzma
|
|
||||||
RegisterDecompressor(0x030101, Decompressor(func(r []io.Reader, options []byte, unpackSize uint64, ro *ReaderOptions) (io.Reader, error) {
|
|
||||||
if len(r) != 1 {
|
|
||||||
return nil, ErrNotSupported
|
|
||||||
}
|
|
||||||
|
|
||||||
// We can't set options in the lzma decoder library, so instead we add
|
|
||||||
// a fake header
|
|
||||||
header := bytes.NewBuffer(options)
|
|
||||||
binary.Write(header, binary.LittleEndian, unpackSize)
|
|
||||||
|
|
||||||
return lzma.NewReader(io.MultiReader(header, r[0]))
|
|
||||||
}))
|
|
||||||
|
|
||||||
// lzma2
|
|
||||||
RegisterDecompressor(0x21, Decompressor(func(r []io.Reader, options []byte, unpackSize uint64, ro *ReaderOptions) (io.Reader, error) {
|
|
||||||
if len(r) != 1 {
|
|
||||||
return nil, ErrNotSupported
|
|
||||||
}
|
|
||||||
|
|
||||||
config := lzma.Reader2Config{}
|
|
||||||
if len(options) > 0 {
|
|
||||||
config.DictCap = int(2 | (options[0] & 1))
|
|
||||||
config.DictCap <<= (options[0] >> 1) + 11
|
|
||||||
}
|
|
||||||
|
|
||||||
return config.NewReader2(r[0])
|
|
||||||
}))
|
|
||||||
|
|
||||||
// bcj2
|
|
||||||
RegisterDecompressor(0x303011b, Decompressor(func(r []io.Reader, options []byte, unpackSize uint64, ro *ReaderOptions) (io.Reader, error) {
|
|
||||||
if len(r) != 4 {
|
|
||||||
return nil, ErrNotSupported
|
|
||||||
}
|
|
||||||
return filters.NewBCJ2Decoder(r[0], r[1], r[2], r[3], int64(unpackSize))
|
|
||||||
}))
|
|
||||||
|
|
||||||
// deflate
|
|
||||||
RegisterDecompressor(0x40108, Decompressor(func(r []io.Reader, options []byte, unpackSize uint64, ro *ReaderOptions) (io.Reader, error) {
|
|
||||||
if len(r) != 1 {
|
|
||||||
return nil, ErrNotSupported
|
|
||||||
}
|
|
||||||
return flate.NewReader(r[0]), nil
|
|
||||||
}))
|
|
||||||
|
|
||||||
// bzip2
|
|
||||||
RegisterDecompressor(0x40202, Decompressor(func(r []io.Reader, options []byte, unpackSize uint64, ro *ReaderOptions) (io.Reader, error) {
|
|
||||||
if len(r) != 1 {
|
|
||||||
return nil, ErrNotSupported
|
|
||||||
}
|
|
||||||
|
|
||||||
return bzip2.NewReader(r[0]), nil
|
|
||||||
}))
|
|
||||||
|
|
||||||
// AES
|
|
||||||
RegisterDecompressor(0x6f10701, Decompressor(func(r []io.Reader, options []byte, unpackSize uint64, ro *ReaderOptions) (io.Reader, error) {
|
|
||||||
if len(r) != 1 {
|
|
||||||
return nil, ErrNotSupported
|
|
||||||
}
|
|
||||||
if len(options) < 2 {
|
|
||||||
return nil, ErrNotSupported
|
|
||||||
}
|
|
||||||
|
|
||||||
saltSize := ((options[0] >> 7) & 1) + (options[1] >> 4)
|
|
||||||
ivSize := ((options[0] >> 6) & 1) + (options[1] & 0x0F)
|
|
||||||
power := int(options[0]) & 0x3f
|
|
||||||
|
|
||||||
options = options[2:]
|
|
||||||
salt := options[:saltSize]
|
|
||||||
iv := options[saltSize : saltSize+ivSize]
|
|
||||||
|
|
||||||
return filters.NewAESDecrypter(r[0], power, salt, iv, ro.Password())
|
|
||||||
}))
|
|
||||||
}
|
|
||||||
|
|
||||||
// RegisterDecompressor registers a decompressor.
|
|
||||||
func RegisterDecompressor(method uint32, dcomp Decompressor) {
|
|
||||||
if _, dup := decompressors.LoadOrStore(method, dcomp); dup {
|
|
||||||
panic("decompressor already registered")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func decompressor(method uint32) Decompressor {
|
|
||||||
di, ok := decompressors.Load(method)
|
|
||||||
if !ok {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
return di.(Decompressor)
|
|
||||||
}
|
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue