Merge d3d35387b7 into 3fbe8634d9

add getTempFile api

cache/redis.go

@@ -2,9 +2,13 @@ package cache
 
 import (
 	"context"
+	"fmt"
+	"net"
+	"os"
 	"time"
 
 	"github.com/go-redis/redis/v8"
+	"golang.org/x/crypto/ssh"
 )
 
 // Redis .redis cache
@@ -16,11 +20,13 @@ type Redis struct {
 // RedisOpts redis 连接属性
 type RedisOpts struct {
 	Host        string `yml:"host" json:"host"`
+	Username    string `yaml:"username" json:"username"`
 	Password    string `yml:"password" json:"password"`
 	Database    int    `yml:"database" json:"database"`
 	MaxIdle     int    `yml:"max_idle" json:"max_idle"`
 	MaxActive   int    `yml:"max_active" json:"max_active"`
 	IdleTimeout int    `yml:"idle_timeout" json:"idle_timeout"` // second
+	Dialer      func(ctx context.Context, network, addr string) (net.Conn, error)
 }
 
 // NewRedis 实例化
@@ -28,9 +34,24 @@ func NewRedis(ctx context.Context, opts *RedisOpts) *Redis {
 	conn := redis.NewUniversalClient(&redis.UniversalOptions{
 		Addrs:        []string{opts.Host},
 		DB:           opts.Database,
+		Username:     opts.Username,
 		Password:     opts.Password,
 		IdleTimeout:  time.Second * time.Duration(opts.IdleTimeout),
 		MinIdleConns: opts.MaxIdle,
+		Dialer:       opts.Dialer,
+	})
+	return &Redis{ctx: ctx, conn: conn}
+}
+
+// NewRedisOverSSH 实例化（通过 SSH 代理连接 Redis ）
+func NewRedisOverSSH(ctx context.Context, opts *RedisOpts, overSSH *OverSSH) *Redis {
+	conn := redis.NewUniversalClient(&redis.UniversalOptions{
+		Addrs:        []string{opts.Host},
+		DB:           opts.Database,
+		Password:     opts.Password,
+		IdleTimeout:  time.Second * time.Duration(opts.IdleTimeout),
+		MinIdleConns: opts.MaxIdle,
+		Dialer:       overSSH.MakeDialer(),
 	})
 	return &Redis{ctx: ctx, conn: conn}
 }
@@ -90,3 +111,80 @@ func (r *Redis) Delete(key string) error {
 func (r *Redis) DeleteContext(ctx context.Context, key string) error {
 	return r.conn.Del(ctx, key).Err()
 }
+
+// SSHAuthMethod SSH认证方式
+type SSHAuthMethod uint8
+
+const (
+	// PubKeyAuth SSH公钥方式认证
+	PubKeyAuth SSHAuthMethod = 1
+	// PwdAuth SSH密码方式认证
+	PwdAuth SSHAuthMethod = 2
+)
+
+// OverSSH SSH 代理配置
+type OverSSH struct {
+	Host       string        `yml:"host" json:"host"`
+	Port       int           `yml:"port" json:"port"`
+	AuthMethod SSHAuthMethod `yml:"auth_method" json:"auth_method"`
+	Username   string        `yml:"username" json:"username"`
+	Password   string        `yml:"password" json:"password"`
+	KeyFile    string        `yml:"key_file" json:"key_file"`
+}
+
+// DialWithPassword 返回密码方式认证的 SSH 客户端
+func (s *OverSSH) DialWithPassword() (*ssh.Client, error) {
+	return ssh.Dial(
+		"tcp",
+		fmt.Sprintf("%s:%d", s.Host, s.Port),
+		&ssh.ClientConfig{
+			User: s.Username,
+			Auth: []ssh.AuthMethod{
+				ssh.Password(s.Password),
+			},
+			HostKeyCallback: ssh.InsecureIgnoreHostKey(),
+		},
+	)
+}
+
+// DialWithKeyFile 返回公钥方式认证的 SSH 客户端
+func (s *OverSSH) DialWithKeyFile() (*ssh.Client, error) {
+	k, err := os.ReadFile(s.KeyFile)
+	if err != nil {
+		return nil, err
+	}
+	signer, err := ssh.ParsePrivateKey(k)
+	if err != nil {
+		return nil, err
+	}
+
+	return ssh.Dial(
+		"tcp",
+		fmt.Sprintf("%s:%d", s.Host, s.Port),
+		&ssh.ClientConfig{
+			User: s.Username,
+			Auth: []ssh.AuthMethod{
+				ssh.PublicKeys(signer),
+			},
+			HostKeyCallback: ssh.InsecureIgnoreHostKey(),
+		},
+	)
+}
+
+// MakeDialer 创建 SSH 代理拨号器
+func (s *OverSSH) MakeDialer() func(ctx context.Context, network, addr string) (net.Conn, error) {
+	return func(ctx context.Context, network, addr string) (net.Conn, error) {
+		var err error
+		var sshclient *ssh.Client
+		switch s.AuthMethod {
+		case PwdAuth:
+			sshclient, err = s.DialWithPassword()
+		case PubKeyAuth:
+			sshclient, err = s.DialWithKeyFile()
+		}
+		if err != nil {
+			return nil, err
+		}
+		return sshclient.Dial(network, addr)
+	}
+}

go.sum

@@ -111,6 +111,7 @@ golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBc
 golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 h1:0A+M6Uqn+Eje4kHMK80dtF3JCXC4ykBgQG4Fe06QRhQ=
 golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1 h1:v+OssWQX+hTHEmOBgwxdZxK4zHq3yOs8F9J7mk0PY8E=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=

miniprogram/config/config.go

@@ -14,4 +14,5 @@ type Config struct {
 	Token          string `json:"token"`            // token
 	EncodingAESKey string `json:"encoding_aes_key"` // EncodingAESKey
 	Cache          cache.Cache
+	UseStableAK    bool // use the stable access_token
 }

miniprogram/miniprogram.go

@@ -34,7 +34,13 @@ type MiniProgram struct {
 
 // NewMiniProgram 实例化小程序 API
 func NewMiniProgram(cfg *config.Config) *MiniProgram {
-	defaultAkHandle := credential.NewDefaultAccessToken(cfg.AppID, cfg.AppSecret, credential.CacheKeyMiniProgramPrefix, cfg.Cache)
+	var defaultAkHandle credential.AccessTokenContextHandle
+	const cacheKeyPrefix = credential.CacheKeyMiniProgramPrefix
+	if cfg.UseStableAK {
+		defaultAkHandle = credential.NewStableAccessToken(cfg.AppID, cfg.AppSecret, cacheKeyPrefix, cfg.Cache)
+	} else {
+		defaultAkHandle = credential.NewDefaultAccessToken(cfg.AppID, cfg.AppSecret, cacheKeyPrefix, cfg.Cache)
+	}
 	ctx := &context.Context{
 		Config:            cfg,
 		AccessTokenHandle: defaultAkHandle,

miniprogram/qrcode/qrcode.go

@@ -54,6 +54,8 @@ type QRCoder struct {
 	IsHyaline bool `json:"is_hyaline,omitempty"`
 	// envVersion 要打开的小程序版本。正式版为 "release"，体验版为 "trial"，开发版为 "develop"
 	EnvVersion string `json:"env_version,omitempty"`
+	// ShowSplashAd 控制通过该小程序码进入小程序是否展示封面广告1、默认为true，展示封面广告2、传入为false时，不展示封面广告
+	ShowSplashAd bool `json:"show_splash_ad,omitempty"`
 }
 
 // fetchCode 请求并返回二维码二进制数据

officialaccount/config/config.go

@@ -11,4 +11,5 @@ type Config struct {
 	Token          string `json:"token"`            // token
 	EncodingAESKey string `json:"encoding_aes_key"` // EncodingAESKey
 	Cache          cache.Cache
+	UseStableAK    bool // use the stable access_token
 }

officialaccount/material/material.go

@@ -6,6 +6,7 @@ import (
 	"fmt"
 	"io"
 	"os"
+	"path"
 
 	"github.com/silenceper/wechat/v2/officialaccount/context"
 	"github.com/silenceper/wechat/v2/util"
@@ -163,7 +164,7 @@ type resAddMaterial struct {
 }
 
 // AddMaterialFromReader 上传永久性素材（处理视频需要单独上传），从 io.Reader 中读取
-func (material *Material) AddMaterialFromReader(mediaType MediaType, filename string, reader io.Reader) (mediaID string, url string, err error) {
+func (material *Material) AddMaterialFromReader(mediaType MediaType, filePath string, reader io.Reader) (mediaID string, url string, err error) {
 	if mediaType == MediaTypeVideo {
 		err = errors.New("永久视频素材上传使用 AddVideo 方法")
 		return
@@ -175,8 +176,10 @@ func (material *Material) AddMaterialFromReader(mediaType MediaType, filename st
 	}
 
 	uri := fmt.Sprintf("%s?access_token=%s&type=%s", addMaterialURL, accessToken, mediaType)
+	// 获取文件名
+	filename := path.Base(filePath)
 	var response []byte
-	response, err = util.PostFileFromReader("media", filename, uri, reader)
+	response, err = util.PostFileFromReader("media", filePath, filename, uri, reader)
 	if err != nil {
 		return
 	}
@@ -211,7 +214,7 @@ type reqVideo struct {
 }
 
 // AddVideoFromReader 永久视频素材文件上传，从 io.Reader 中读取
-func (material *Material) AddVideoFromReader(filename, title, introduction string, reader io.Reader) (mediaID string, url string, err error) {
+func (material *Material) AddVideoFromReader(filePath, title, introduction string, reader io.Reader) (mediaID string, url string, err error) {
 	var accessToken string
 	accessToken, err = material.GetAccessToken()
 	if err != nil {
@@ -229,17 +232,19 @@ func (material *Material) AddVideoFromReader(filename, title, introduction strin
 	if err != nil {
 		return
 	}
-
+	fileName := path.Base(filePath)
 	fields := []util.MultipartFormField{
 		{
 			IsFile:     true,
 			Fieldname:  "media",
-			Filename:   filename,
+			FilePath:   filePath,
+			Filename:   fileName,
 			FileReader: reader,
 		},
 		{
 			IsFile:    false,
 			Fieldname: "description",
+			Filename:  fileName,
 			Value:     fieldValue,
 		},
 	}
@@ -265,14 +270,14 @@ func (material *Material) AddVideoFromReader(filename, title, introduction strin
 }
 
 // AddVideo 永久视频素材文件上传
-func (material *Material) AddVideo(filename, title, introduction string) (mediaID string, url string, err error) {
-	f, err := os.Open(filename)
+func (material *Material) AddVideo(directory, title, introduction string) (mediaID string, url string, err error) {
+	f, err := os.Open(directory)
 	if err != nil {
 		return "", "", err
 	}
 	defer func() { _ = f.Close() }()
 
-	return material.AddVideoFromReader(filename, title, introduction, f)
+	return material.AddVideoFromReader(directory, title, introduction, f)
 }
 
 type reqDeleteMaterial struct {

officialaccount/material/media.go

@@ -3,6 +3,7 @@ package material
 import (
 	"encoding/json"
 	"fmt"
+	"io"
 
 	"github.com/silenceper/wechat/v2/util"
 )
@@ -62,6 +63,38 @@ func (material *Material) MediaUpload(mediaType MediaType, filename string) (med
 	return
 }
 
+// MediaUploadFromReader 临时素材上传
+func (material *Material) MediaUploadFromReader(mediaType MediaType, filename string, reader io.Reader) (media Media, err error) {
+	var accessToken string
+	accessToken, err = material.GetAccessToken()
+	if err != nil {
+		return
+	}
+
+	uri := fmt.Sprintf("%s?access_token=%s&type=%s", mediaUploadURL, accessToken, mediaType)
+
+	var byteData []byte
+	byteData, err = io.ReadAll(reader)
+	if err != nil {
+		return
+	}
+
+	var response []byte
+	response, err = util.PostFileByStream("media", filename, uri, byteData)
+	if err != nil {
+		return
+	}
+	err = json.Unmarshal(response, &media)
+	if err != nil {
+		return
+	}
+	if media.ErrCode != 0 {
+		err = fmt.Errorf("MediaUpload error : errcode=%v , errmsg=%v", media.ErrCode, media.ErrMsg)
+		return
+	}
+	return
+}
+
 // GetMediaURL 返回临时素材的下载地址供用户自己处理
 // NOTICE: URL 不可公开，因为含access_token 需要立即另存文件
 func (material *Material) GetMediaURL(mediaID string) (mediaURL string, err error) {

officialaccount/officialaccount.go

@@ -49,7 +49,13 @@ type OfficialAccount struct {
 
 // NewOfficialAccount 实例化公众号API
 func NewOfficialAccount(cfg *config.Config) *OfficialAccount {
-	defaultAkHandle := credential.NewDefaultAccessToken(cfg.AppID, cfg.AppSecret, credential.CacheKeyOfficialAccountPrefix, cfg.Cache)
+	var defaultAkHandle credential.AccessTokenContextHandle
+	const cacheKeyPrefix = credential.CacheKeyOfficialAccountPrefix
+	if cfg.UseStableAK {
+		defaultAkHandle = credential.NewStableAccessToken(cfg.AppID, cfg.AppSecret, cacheKeyPrefix, cfg.Cache)
+	} else {
+		defaultAkHandle = credential.NewDefaultAccessToken(cfg.AppID, cfg.AppSecret, cacheKeyPrefix, cfg.Cache)
+	}
 	ctx := &context.Context{
 		Config:            cfg,
 		AccessTokenHandle: defaultAkHandle,

util/http.go

@@ -146,24 +146,38 @@ func PostJSONWithRespContentType(uri string, obj interface{}) ([]byte, string, e
 	return responseData, contentType, err
 }
 
+// PostFileByStream 上传文件
+func PostFileByStream(fieldName, fileName, uri string, byteData []byte) ([]byte, error) {
+	fields := []MultipartFormField{
+		{
+			IsFile:    false,
+			Fieldname: fieldName,
+			Filename:  fileName,
+			Value:     byteData,
+		},
+	}
+	return PostMultipartForm(fields, uri)
+}
+
 // PostFile 上传文件
-func PostFile(fieldName, filename, uri string) ([]byte, error) {
+func PostFile(fieldName, filePath, uri string) ([]byte, error) {
 	fields := []MultipartFormField{
 		{
 			IsFile:    true,
 			Fieldname: fieldName,
-			Filename:  filename,
+			FilePath:  filePath,
 		},
 	}
 	return PostMultipartForm(fields, uri)
 }
 
 // PostFileFromReader 上传文件，从 io.Reader 中读取
-func PostFileFromReader(filedName, fileName, uri string, reader io.Reader) ([]byte, error) {
+func PostFileFromReader(filedName, filePath, fileName, uri string, reader io.Reader) ([]byte, error) {
 	fields := []MultipartFormField{
 		{
 			IsFile:     true,
 			Fieldname:  filedName,
+			FilePath:   filePath,
 			Filename:   fileName,
 			FileReader: reader,
 		},
@@ -176,6 +190,7 @@ type MultipartFormField struct {
 	IsFile     bool
 	Fieldname  string
 	Value      []byte
+	FilePath   string
 	Filename   string
 	FileReader io.Reader
 }
@@ -197,7 +212,7 @@ func PostMultipartForm(fields []MultipartFormField, uri string) (respBody []byte
 			}
 
 			if field.FileReader == nil {
-				fh, e := os.Open(field.Filename)
+				fh, e := os.Open(field.FilePath)
 				if e != nil {
 					err = fmt.Errorf("error opening file , err=%v", e)
 					return
@@ -213,7 +228,7 @@ func PostMultipartForm(fields []MultipartFormField, uri string) (respBody []byte
 				}
 			}
 		} else {
-			partWriter, e := bodyWriter.CreateFormField(field.Fieldname)
+			partWriter, e := bodyWriter.CreateFormFile(field.Fieldname, field.Filename)
 			if e != nil {
 				err = e
 				return

work/kf/servicer.go

@@ -18,20 +18,23 @@ const (
 
 // ReceptionistOptions 添加接待人员请求参数
 type ReceptionistOptions struct {
-	OpenKFID   string   `json:"open_kfid"`   // 客服帐号ID
-	UserIDList []string `json:"userid_list"` // 接待人员userid列表。第三方应用填密文userid，即open_userid 可填充个数：1 ~ 100。超过100个需分批调用。
+	OpenKFID         string   `json:"open_kfid"`          // 客服帐号ID
+	UserIDList       []string `json:"userid_list"`        // 接待人员userid列表。第三方应用填密文userid，即open_userid 可填充个数：1 ~ 100。超过100个需分批调用。
+	DepartmentIDList []int    `json:"department_id_list"` // 接待人员部门id列表 可填充个数：0 ~ 100。超过100个需分批调用。
 }
 
 // ReceptionistSchema 添加接待人员响应内容
 type ReceptionistSchema struct {
 	util.CommonError
 	ResultList []struct {
-		UserID string `json:"userid"`
+		UserID       string `json:"userid"`
+		DepartmentID int    `json:"department_id"`
 		util.CommonError
 	} `json:"result_list"`
 }
 
 // ReceptionistAdd 添加接待人员
+// @see https://developer.work.weixin.qq.com/document/path/94646
 func (r *Client) ReceptionistAdd(options ReceptionistOptions) (info ReceptionistSchema, err error) {
 	var (
 		accessToken string
@@ -49,10 +52,11 @@ func (r *Client) ReceptionistAdd(options ReceptionistOptions) (info Receptionist
 	if info.ErrCode != 0 {
 		return info, NewSDKErr(info.ErrCode, info.ErrMsg)
 	}
-	return info, nil
+	return
 }
 
 // ReceptionistDel 删除接待人员
+// @see https://developer.work.weixin.qq.com/document/path/94647
 func (r *Client) ReceptionistDel(options ReceptionistOptions) (info ReceptionistSchema, err error) {
 	var (
 		accessToken string
@@ -72,19 +76,22 @@ func (r *Client) ReceptionistDel(options ReceptionistOptions) (info Receptionist
 	if info.ErrCode != 0 {
 		return info, NewSDKErr(info.ErrCode, info.ErrMsg)
 	}
-	return info, nil
+	return
 }
 
 // ReceptionistListSchema 获取接待人员列表响应内容
 type ReceptionistListSchema struct {
 	util.CommonError
 	ReceptionistList []struct {
-		UserID string `json:"userid"` // 接待人员的userid。第三方应用获取到的为密文userid，即open_userid
-		Status int    `json:"status"` // 接待人员的接待状态。0:接待中,1:停止接待。第三方应用需具有“管理帐号、分配会话和收发消息”权限才可获取
+		UserID       string `json:"userid"`        // 接待人员的userid。第三方应用获取到的为密文userid，即open_userid
+		Status       int    `json:"status"`        // 接待人员的接待状态。0:接待中,1:停止接待。第三方应用需具有“管理帐号、分配会话和收发消息”权限才可获取
+		DepartmentID int    `json:"department_id"` // 接待人员部门的id
+		StopType     int    `json:"stop_type"`     // 接待人员的接待状态为「停止接待」的子类型。0:停止接待,1:暂时挂起
 	} `json:"servicer_list"`
 }
 
 // ReceptionistList 获取接待人员列表
+// @see https://developer.work.weixin.qq.com/document/path/94645
 func (r *Client) ReceptionistList(kfID string) (info ReceptionistListSchema, err error) {
 	var (
 		accessToken string
@@ -104,5 +111,5 @@ func (r *Client) ReceptionistList(kfID string) (info ReceptionistListSchema, err
 	if info.ErrCode != 0 {
 		return info, NewSDKErr(info.ErrCode, info.ErrMsg)
 	}
-	return info, nil
+	return
 }

work/material/media.go

@@ -2,6 +2,7 @@ package material
 
 import (
 	"fmt"
+	"io"
 
 	"github.com/silenceper/wechat/v2/util"
 )
@@ -13,6 +14,8 @@ const (
 	uploadTempFile = "https://qyapi.weixin.qq.com/cgi-bin/media/upload?access_token=%s&type=%s"
 	// uploadAttachment 上传附件资源
 	uploadAttachment = "https://qyapi.weixin.qq.com/cgi-bin/media/upload_attachment?access_token=%s&media_type=%s&attachment_type=%d"
+	// getTempFile 获取临时素材
+	getTempFile = "https://qyapi.weixin.qq.com/cgi-bin/media/get?access_token=%s&media_id=%s"
 )
 
 // UploadImgResponse 上传图片响应
@@ -96,3 +99,72 @@ func (r *Client) UploadAttachment(filename string, mediaType string, attachmentT
 	err = util.DecodeWithError(response, result, "UploadAttachment")
 	return result, err
 }
+
+// UploadTempFileFromReader 上传临时素材
+// @see https://developer.work.weixin.qq.com/document/path/90253
+// @mediaType 媒体文件类型，分别有图片（image）、语音（voice）、视频（video），普通文件（file）
+func (r *Client) UploadTempFileFromReader(filename, mediaType string, reader io.Reader) (*UploadTempFileResponse, error) {
+	var (
+		accessToken string
+		err         error
+	)
+	if accessToken, err = r.GetAccessToken(); err != nil {
+		return nil, err
+	}
+	var byteData []byte
+	byteData, err = io.ReadAll(reader)
+	if err != nil {
+		return nil, err
+	}
+	var response []byte
+	if response, err = util.PostFileByStream("media", filename, fmt.Sprintf(uploadTempFile, accessToken, mediaType), byteData); err != nil {
+		return nil, err
+	}
+	result := &UploadTempFileResponse{}
+	err = util.DecodeWithError(response, result, "UploadTempFile")
+	return result, err
+}
+
+// UploadAttachmentFromReader 上传附件资源
+// @see https://developer.work.weixin.qq.com/document/path/95098
+// @mediaType 媒体文件类型，分别有图片（image）、视频（video）、普通文件（file）
+// @attachment_type 附件类型，不同的附件类型用于不同的场景。1：朋友圈；2:商品图册
+func (r *Client) UploadAttachmentFromReader(filename, mediaType string, reader io.Reader, attachmentType int) (*UploadAttachmentResponse, error) {
+	var (
+		accessToken string
+		err         error
+	)
+	if accessToken, err = r.GetAccessToken(); err != nil {
+		return nil, err
+	}
+	var byteData []byte
+	byteData, err = io.ReadAll(reader)
+	if err != nil {
+		return nil, err
+	}
+	var response []byte
+	if response, err = util.PostFileByStream("media", filename, fmt.Sprintf(uploadAttachment, accessToken, mediaType, attachmentType), byteData); err != nil {
+		return nil, err
+	}
+	result := &UploadAttachmentResponse{}
+	err = util.DecodeWithError(response, result, "UploadAttachment")
+	return result, err
+}
+
+// GetTempFile 获取临时素材
+// @see https://developer.work.weixin.qq.com/document/path/90254
+func (r *Client) GetTempFile(mediaID string) ([]byte, error) {
+	var (
+		accessToken string
+		err         error
+	)
+	if accessToken, err = r.GetAccessToken(); err != nil {
+		return nil, err
+	}
+	url := fmt.Sprintf(getTempFile, accessToken, mediaID)
+	response, err := util.HTTPGet(url)
+	if err != nil {
+		return nil, err
+	}
+	return response, nil
+}