Refactor the storage provider interface.

controllers/account.go

@@ -256,9 +256,9 @@ func (c *ApiController) UploadAvatar() {
 	}
 
 	dist, _ := base64.StdEncoding.DecodeString(avatarBase64[index+1:])
-	msg := object.UploadAvatar(provider, user.GetId(), dist)
+	err := object.UploadAvatar(provider, user.GetId(), dist)
-	if msg != "" {
+	if err != nil {
-		c.ResponseError(msg)
+		c.ResponseError(err.Error())
 		return
 	}
 

object/storage.go

@@ -17,113 +17,22 @@ package object
 import (
 	"bytes"
 	"fmt"
-
+	"github.com/casbin/casdoor/storage"
-	awss3 "github.com/aws/aws-sdk-go/service/s3"
 	"github.com/casbin/casdoor/util"
-	"github.com/qor/oss"
-	"github.com/qor/oss/aliyun"
-	//"github.com/qor/oss/qiniu"
-	"github.com/qor/oss/s3"
 )
 
-func getAliyunClient(provider *Provider) oss.StorageInterface {
+func UploadAvatar(provider *Provider, username string, avatar []byte) error {
-	if util.IsStrsEmpty(
+	storageProvider := storage.GetStorageProvider(provider.Type, provider.ClientId, provider.ClientSecret, provider.RegionId, provider.Bucket, provider.Endpoint)
-		provider.Endpoint,
+	if storageProvider == nil {
-		provider.ClientId,
+		return fmt.Errorf("the provider type: %s is not supported", provider.Type)
-		provider.ClientSecret,
-		provider.Bucket) {
-		return nil
 	}
 
-	ret := aliyun.New(&aliyun.Config{
+	if provider.Domain == "" {
-		AccessID:  provider.ClientId,
+		provider.Domain = storageProvider.GetEndpoint()
-		AccessKey: provider.ClientSecret,
-		Bucket:    provider.Bucket,
-		Endpoint:  provider.Endpoint,
-	})
-
-	if len(provider.Domain) == 0 {
-		provider.Domain = ret.GetEndpoint()
 		UpdateProvider(provider.GetId(), provider)
 	}
-	return ret
-}
-
-func getQiniuClient(provider *Provider) oss.StorageInterface {
-	fmt.Println("Casdoor does not support Qiniu now.")
-	return nil
-	//	endpoint := section.Key("endpoint").String()
-	//	accessId := section.Key("accessId").String()
-	//	accessKey := section.Key("accessKey").String()
-	//  domain = section.Key("domain").String()
-	//	bucket := section.Key("bucket").String()
-	//	region := section.Key("region").String()
-	//	if accessId == "" || accessKey == "" || bucket == "" || endpoint == "" || region == "" {
-	//		return "Config oss.conf wrong"
-	//	}
-	//	storage = qiniu.New(&qiniu.Config{
-	//		AccessID: accessId,
-	//		AccessKey: accessKey,
-	//		Bucket: bucket,
-	//		Region: region,
-	//		Endpoint: endpoint,
-	//	})
-	//	return ""
-}
-
-func getAwss3Client(provider *Provider) oss.StorageInterface {
-	if util.IsStrsEmpty(
-		provider.Endpoint,
-		provider.ClientId,
-		provider.ClientSecret,
-		provider.Bucket,
-		provider.RegionId) {
-		return nil
-	}
-
-	ret := s3.New(&s3.Config{
-		AccessID:  provider.ClientId,
-		AccessKey: provider.ClientSecret,
-		Region:    provider.RegionId,
-		Bucket:    provider.Bucket,
-		Endpoint:  provider.Endpoint,
-		ACL:       awss3.BucketCannedACLPublicRead,
-	})
-
-	if len(provider.Domain) == 0 {
-		provider.Domain = ret.GetEndpoint()
-		UpdateProvider(provider.GetId(), provider)
-	}
-	return ret
-}
-
-func getStorageClient(provider *Provider) oss.StorageInterface {
-	if provider == nil || provider.Category != "Storage" {
-		return nil
-	}
-
-	switch provider.Type {
-	case "Aliyun OSS":
-		return getAliyunClient(provider)
-	case "Qiniu":
-		return getQiniuClient(provider)
-	case "AWS S3":
-		return getAwss3Client(provider)
-	}
-
-	return nil
-}
-
-func UploadAvatar(provider *Provider, username string, avatar []byte) string {
-	storage := getStorageClient(provider)
-	if storage == nil {
-		return fmt.Sprintf("Provider type: %s is not supported", provider.Type)
-	}
 
 	path := fmt.Sprintf("%s/%s.png", util.UrlJoin(util.GetUrlPath(provider.Domain), "/avatar"), username)
-	_, err := storage.Put(path, bytes.NewReader(avatar))
+	_, err := storageProvider.Put(path, bytes.NewReader(avatar))
-	if err != nil {
+	return err
-		return err.Error()
-	}
-	return ""
 }

storage/aliyun.go

@@ -0,0 +1,31 @@
+// Copyright 2021 The casbin Authors. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package storage
+
+import (
+	"github.com/qor/oss"
+	"github.com/qor/oss/aliyun"
+)
+
+func NewAliyunStorageProvider(clientId string, clientSecret string, region string, bucket string, endpoint string) oss.StorageInterface {
+	sp := aliyun.New(&aliyun.Config{
+		AccessID:  clientId,
+		AccessKey: clientSecret,
+		Bucket:    bucket,
+		Endpoint:  endpoint,
+	})
+
+	return sp
+}

storage/aws_s3.go

@@ -0,0 +1,34 @@
+// Copyright 2021 The casbin Authors. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package storage
+
+import (
+	awss3 "github.com/aws/aws-sdk-go/service/s3"
+	"github.com/qor/oss"
+	"github.com/qor/oss/s3"
+)
+
+func NewAwsS3StorageProvider(clientId string, clientSecret string, region string, bucket string, endpoint string) oss.StorageInterface {
+	sp := s3.New(&s3.Config{
+		AccessID:  clientId,
+		AccessKey: clientSecret,
+		Region:    region,
+		Bucket:    bucket,
+		Endpoint:  endpoint,
+		ACL:       awss3.BucketCannedACLPublicRead,
+	})
+
+	return sp
+}

storage/storage.go

@@ -0,0 +1,28 @@
+// Copyright 2021 The casbin Authors. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package storage
+
+import "github.com/qor/oss"
+
+func GetStorageProvider(providerType string, clientId string, clientSecret string, region string, bucket string, endpoint string) oss.StorageInterface {
+	switch providerType {
+	case "AWS S3":
+		return NewAwsS3StorageProvider(clientId, clientSecret, region, bucket, endpoint)
+	case "Aliyun OSS":
+		return NewAliyunStorageProvider(clientId, clientSecret, region, bucket, endpoint)
+	}
+
+	return nil
+}