-
Notifications
You must be signed in to change notification settings - Fork 6
Expand file tree
/
Copy pathsql_workbench_service.go
More file actions
1762 lines (1514 loc) · 64.4 KB
/
sql_workbench_service.go
File metadata and controls
1762 lines (1514 loc) · 64.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package sql_workbench
import (
"bytes"
"compress/gzip"
"context"
"encoding/base64"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"net/url"
"strings"
"sync"
"time"
"github.com/actiontech/dms/internal/pkg/cloudbeaver"
"github.com/actiontech/dms/internal/pkg/utils"
dmsV1 "github.com/actiontech/dms/api/dms/service/v1"
"github.com/actiontech/dms/internal/apiserver/conf"
"github.com/actiontech/dms/internal/dms/biz"
pkgConst "github.com/actiontech/dms/internal/dms/pkg/constant"
"github.com/actiontech/dms/internal/dms/storage"
"github.com/actiontech/dms/internal/pkg/locale"
dbmodel "github.com/actiontech/dms/internal/dms/storage/model"
"github.com/actiontech/dms/internal/sql_workbench/client"
config "github.com/actiontech/dms/internal/sql_workbench/config"
"github.com/actiontech/dms/pkg/dms-common/api/jwt"
"github.com/actiontech/dms/pkg/dms-common/i18nPkg"
_const "github.com/actiontech/dms/pkg/dms-common/pkg/const"
pkgHttp "github.com/actiontech/dms/pkg/dms-common/pkg/http"
utilLog "github.com/actiontech/dms/pkg/dms-common/pkg/log"
pkgRand "github.com/actiontech/dms/pkg/rand"
"github.com/labstack/echo/v4"
"github.com/labstack/echo/v4/middleware"
"golang.org/x/text/language"
)
const SQL_WORKBENCH_URL = "/odc_query"
const SQL_WORKBENCH_PREFIX = "DMS-"
const SQL_WORKBENCH_DEFAULT_PASSWORD = "DMS123__"
const SQL_WORKBENCH_REAL_PASSWORD = "DMS123__@"
const INDIVIDUAL_SPACE = 4
// ODC 会话相关的 cookie 名称
const (
ODCSessionCookieName = "JSESSIONID"
ODCXsrfTokenCookieName = "XSRF-TOKEN"
)
// odcSession ODC 会话缓存结构
type odcSession struct {
dmsToken string
jsessionID string
xsrfToken string
}
var (
dmsUserIdODCSessionMap = make(map[string]odcSession)
odcSessionMutex = &sync.Mutex{}
)
// generateSqlWorkbenchUsername 生成 SQL Workbench 用户名
func (s *SqlWorkbenchService) generateSqlWorkbenchUsername(dmsUserName string) string {
return SQL_WORKBENCH_PREFIX + dmsUserName
}
// TempDBAccount 临时数据库账号
type TempDBAccount struct {
DBAccountUid string `json:"db_account_uid"`
AccountInfo AccountInfo `json:"account_info"`
Explanation string `json:"explanation"`
ExpiredTime string `json:"expired_time"`
DbService dmsV1.UidWithName `json:"db_service"`
}
// AccountInfo 账号信息
type AccountInfo struct {
User string `json:"user"`
Hostname string `json:"hostname"`
Password string `json:"password"`
}
// ListDBAccountReply 数据库账号列表响应
type ListDBAccountReply struct {
Data []*TempDBAccount `json:"data"`
Code int `json:"code"`
Message string `json:"message"`
}
type SqlWorkbenchService struct {
cfg *config.SqlWorkbenchOpts
log *utilLog.Helper
client *client.SqlWorkbenchClient
userUsecase *biz.UserUsecase
dbServiceUsecase *biz.DBServiceUsecase
projectUsecase *biz.ProjectUsecase
opPermissionVerifyUsecase *biz.OpPermissionVerifyUsecase
sqlWorkbenchUserRepo biz.SqlWorkbenchUserRepo
sqlWorkbenchDatasourceRepo biz.SqlWorkbenchDatasourceRepo
proxyTargetRepo biz.ProxyTargetRepo
cbOperationLogUsecase *biz.CbOperationLogUsecase
}
func NewAndInitSqlWorkbenchService(logger utilLog.Logger, opts *conf.DMSOptions) (*SqlWorkbenchService, error) {
var sqlWorkbenchClient *client.SqlWorkbenchClient
if opts.SqlWorkBenchOpts != nil {
sqlWorkbenchClient = client.NewSqlWorkbenchClient(opts.SqlWorkBenchOpts, logger)
}
// 初始化存储层
st, err := storage.NewStorage(logger, &storage.StorageConfig{
User: opts.ServiceOpts.Database.UserName,
Password: opts.ServiceOpts.Database.Password,
Host: opts.ServiceOpts.Database.Host,
Port: opts.ServiceOpts.Database.Port,
Schema: opts.ServiceOpts.Database.Database,
Debug: opts.ServiceOpts.Database.Debug,
AutoMigrate: opts.ServiceOpts.Database.AutoMigrate,
})
if err != nil {
return nil, fmt.Errorf("failed to initialize storage: %v", err)
}
// 初始化事务生成器
tx := storage.NewTXGenerator()
// 初始化基础存储层
opPermissionVerifyRepo := storage.NewOpPermissionVerifyRepo(logger, st)
opPermissionVerifyUsecase := biz.NewOpPermissionVerifyUsecase(logger, tx, opPermissionVerifyRepo)
// 初始化用户相关
userRepo := storage.NewUserRepo(logger, st)
userGroupRepo := storage.NewUserGroupRepo(logger, st)
pluginRepo := storage.NewPluginRepo(logger, st)
pluginUsecase, err := biz.NewDMSPluginUsecase(logger, pluginRepo)
if err != nil {
return nil, fmt.Errorf("failed to new dms plugin usecase: %v", err)
}
opPermissionRepo := storage.NewOpPermissionRepo(logger, st)
opPermissionUsecase := biz.NewOpPermissionUsecase(logger, tx, opPermissionRepo, pluginUsecase)
cloudbeaverRepo := storage.NewCloudbeaverRepo(logger, st)
loginConfigurationRepo := storage.NewLoginConfigurationRepo(logger, st)
loginConfigurationUsecase := biz.NewLoginConfigurationUsecase(logger, tx, loginConfigurationRepo)
ldapConfigurationRepo := storage.NewLDAPConfigurationRepo(logger, st)
ldapConfigurationUsecase := biz.NewLDAPConfigurationUsecase(logger, tx, ldapConfigurationRepo)
userUsecase := biz.NewUserUsecase(logger, tx, userRepo, userGroupRepo, pluginUsecase, opPermissionUsecase, opPermissionVerifyUsecase, loginConfigurationUsecase, ldapConfigurationUsecase, cloudbeaverRepo, nil)
// 初始化项目相关
memberUsecase := &biz.MemberUsecase{}
environmentTagUsecase := biz.EnvironmentTagUsecase{}
businessTagUsecase := biz.NewBusinessTagUsecase(storage.NewBusinessTagRepo(logger, st), logger)
projectRepo := storage.NewProjectRepo(logger, st)
projectUsecase := biz.NewProjectUsecase(logger, tx, projectRepo, memberUsecase, opPermissionVerifyUsecase, pluginUsecase, businessTagUsecase, &environmentTagUsecase)
// 初始化数据源相关
dbServiceRepo := storage.NewDBServiceRepo(logger, st)
environmentTagUsecase = *biz.NewEnvironmentTagUsecase(storage.NewEnvironmentTagRepo(logger, st), logger, projectUsecase, opPermissionVerifyUsecase)
proxyTargetRepo := storage.NewProxyTargetRepo(logger, st)
dbServiceUsecase := biz.NewDBServiceUsecase(logger, dbServiceRepo, pluginUsecase, opPermissionVerifyUsecase, projectUsecase, proxyTargetRepo, &environmentTagUsecase)
// 初始化SqlWorkbench相关的存储层
sqlWorkbenchUserRepo := storage.NewSqlWorkbenchRepo(logger, st)
sqlWorkbenchDatasourceRepo := storage.NewSqlWorkbenchDatasourceRepo(logger, st)
// 初始化操作日志相关
cbOperationLogRepo := storage.NewCbOperationLogRepo(logger, st)
cbOperationLogUsecase := biz.NewCbOperationLogUsecase(logger, cbOperationLogRepo, opPermissionVerifyUsecase, proxyTargetRepo, biz.NewSystemVariableUsecase(logger, storage.NewSystemVariableRepo(logger, st)))
return &SqlWorkbenchService{
cfg: opts.SqlWorkBenchOpts,
log: utilLog.NewHelper(logger, utilLog.WithMessageKey("sql_workbench.service")),
client: sqlWorkbenchClient,
userUsecase: userUsecase,
dbServiceUsecase: dbServiceUsecase,
projectUsecase: projectUsecase,
opPermissionVerifyUsecase: opPermissionVerifyUsecase,
sqlWorkbenchUserRepo: sqlWorkbenchUserRepo,
sqlWorkbenchDatasourceRepo: sqlWorkbenchDatasourceRepo,
proxyTargetRepo: proxyTargetRepo,
cbOperationLogUsecase: cbOperationLogUsecase,
}, nil
}
func (sqlWorkbenchService *SqlWorkbenchService) IsConfigured() bool {
if sqlWorkbenchService.cfg == nil {
return false
}
return sqlWorkbenchService.cfg != nil && sqlWorkbenchService.cfg.Host != "" && sqlWorkbenchService.cfg.Port != ""
}
func (sqlWorkbenchService *SqlWorkbenchService) GetOdcProxyTarget() ([]*middleware.ProxyTarget, error) {
cfg := sqlWorkbenchService.cfg
rawUrl, err := url.Parse(fmt.Sprintf("http://%v:%v", cfg.Host, cfg.Port))
if err != nil {
return nil, err
}
sqlWorkbenchService.log.Infof("ODC proxy target URL: %s", rawUrl.String())
return []*middleware.ProxyTarget{
{
URL: rawUrl,
},
}, nil
}
func (sqlWorkbenchService *SqlWorkbenchService) GetRootUri() string {
return SQL_WORKBENCH_URL
}
func (sqlWorkbenchService *SqlWorkbenchService) Login() echo.MiddlewareFunc {
return func(next echo.HandlerFunc) echo.HandlerFunc {
return func(c echo.Context) error {
// 从Cookie中获取DMS token
var dmsToken string
for _, cookie := range c.Cookies() {
if cookie.Name == pkgConst.DMSToken {
dmsToken = cookie.Value
break
}
}
if dmsToken == "" {
sqlWorkbenchService.log.Errorf("dmsToken is empty")
return fmt.Errorf("dms user token is empty")
}
dmsUserId, err := jwt.ParseUidFromJwtTokenStr(dmsToken)
if err != nil {
sqlWorkbenchService.log.Errorf("ParseUidFromJwtTokenStr err: %v", err)
return fmt.Errorf("parse dms user uid from token err: %v", err)
}
// 检查缓存中是否有有效的 ODC 会话
odcSession := sqlWorkbenchService.getODCSession(dmsUserId, dmsToken)
if odcSession != nil {
// 验证会话是否有效
if sqlWorkbenchService.validateODCSession(odcSession.jsessionID, odcSession.xsrfToken) {
// 会话有效,设置 cookie 到请求中
sqlWorkbenchService.setODCCookiesToRequest(c, odcSession.jsessionID, odcSession.xsrfToken)
sqlWorkbenchService.log.Debugf("Using cached ODC session for user: %s", dmsUserId)
return next(c)
}
// 会话无效,清除缓存
sqlWorkbenchService.log.Debugf("Cached ODC session invalid, clearing cache for user: %s", dmsUserId)
sqlWorkbenchService.clearODCSession(dmsUserId)
}
// 缓存不存在或会话无效,需要重新登录
sqlWorkbenchService.log.Debugf("No valid cached ODC session, performing login for user: %s", dmsUserId)
// 1. 根据dmsUserId从数据库获取用户信息
user, err := sqlWorkbenchService.userUsecase.GetUser(c.Request().Context(), dmsUserId)
if err != nil {
sqlWorkbenchService.log.Errorf("Failed to get user by dmsUserId %s: %v", dmsUserId, err)
return err
}
// 2. 从数据库表SqlWorkbenchUserCache中判断sqlworkbench中是否存在该用户
sqlWorkbenchUser, exists, err := sqlWorkbenchService.sqlWorkbenchUserRepo.GetSqlWorkbenchUserByDMSUserID(c.Request().Context(), dmsUserId)
if err != nil {
sqlWorkbenchService.log.Errorf("Failed to get sql workbench user cache: %v", err)
return err
}
// 3. 如果用户不存在,调用sqlworkbench创建用户接口进行创建
if !exists {
err = sqlWorkbenchService.createSqlWorkbenchUser(c.Request().Context(), user)
if err != nil {
sqlWorkbenchService.log.Errorf("Failed to create sql workbench user: %v", err)
return err
}
// 重新获取创建后的用户信息
sqlWorkbenchUser, _, err = sqlWorkbenchService.sqlWorkbenchUserRepo.GetSqlWorkbenchUserByDMSUserID(c.Request().Context(), dmsUserId)
if err != nil {
sqlWorkbenchService.log.Errorf("Failed to get created sql workbench user: %v", err)
return err
}
}
// 4. 将DMS中的数据源同步给SqlWorkbench
err = sqlWorkbenchService.syncDatasources(c.Request().Context(), user, sqlWorkbenchUser)
if err != nil {
sqlWorkbenchService.log.Errorf("Failed to sync datasources: %v", err)
return err
}
// 5. 调用登录接口进行登录,并且从登录接口的返回值中获取Cookie设置到c echo.Context的上下文中
jsessionID, xsrfToken, err := sqlWorkbenchService.loginSqlWorkbenchUser(c, user, dmsUserId, dmsToken)
if err != nil {
sqlWorkbenchService.log.Errorf("Failed to login sql workbench user: %v", err)
return err
}
// 将新会话设置到请求中
sqlWorkbenchService.setODCCookiesToRequest(c, jsessionID, xsrfToken)
return next(c)
}
}
}
// createSqlWorkbenchUser 创建SqlWorkbench用户
func (sqlWorkbenchService *SqlWorkbenchService) createSqlWorkbenchUser(ctx context.Context, dmsUser *biz.User) error {
cookie, _, publicKey, err := sqlWorkbenchService.getUserCookie(sqlWorkbenchService.cfg.AdminUser, sqlWorkbenchService.cfg.AdminPassword)
if err != nil {
return err
}
// 创建用户请求
sqlWorkbenchUsername := sqlWorkbenchService.generateSqlWorkbenchUsername(dmsUser.Name)
createUserReq := []client.CreateUserRequest{
{
AccountName: sqlWorkbenchUsername,
Name: dmsUser.Name,
Password: SQL_WORKBENCH_DEFAULT_PASSWORD,
Enabled: true,
RoleIDs: []int64{INDIVIDUAL_SPACE},
},
}
// 调用创建用户接口
createUserResp, err := sqlWorkbenchService.client.CreateUsers(createUserReq, publicKey, cookie)
if err != nil {
return fmt.Errorf("failed to create user in sql workbench: %v", err)
}
if len(createUserResp.Data.Contents) == 0 {
return fmt.Errorf("no user created in sql workbench")
}
// 激活用户
activateUserResp, err := sqlWorkbenchService.client.ActivateUser(
sqlWorkbenchService.generateSqlWorkbenchUsername(dmsUser.Name),
SQL_WORKBENCH_DEFAULT_PASSWORD,
SQL_WORKBENCH_REAL_PASSWORD,
publicKey,
cookie,
)
if err != nil {
return fmt.Errorf("failed to activate user in sql workbench: %v", err)
}
// 保存用户缓存
sqlWorkbenchUser := &biz.SqlWorkbenchUser{
SqlWorkbenchUsername: sqlWorkbenchService.generateSqlWorkbenchUsername(dmsUser.Name),
DMSUserID: dmsUser.UID,
SqlWorkbenchUserId: activateUserResp.Data.ID,
}
err = sqlWorkbenchService.sqlWorkbenchUserRepo.SaveSqlWorkbenchUserCache(ctx, sqlWorkbenchUser)
if err != nil {
return fmt.Errorf("failed to save sql workbench user cache: %v", err)
}
sqlWorkbenchService.log.Infof("Successfully created and activated sql workbench user for DMS user %s (ID: %d)", dmsUser.Name, activateUserResp.Data.ID)
return nil
}
// loginSqlWorkbenchUser 使用SqlWorkbench用户登录并设置Cookie
// 返回 jsessionID 和 xsrfToken,并缓存会话
func (sqlWorkbenchService *SqlWorkbenchService) loginSqlWorkbenchUser(c echo.Context, dmsUser *biz.User, dmsUserId, dmsToken string) (string, string, error) {
// 获取公钥
publicKey, err := sqlWorkbenchService.client.GetPublicKey()
if err != nil {
return "", "", fmt.Errorf("failed to get public key: %v", err)
}
// 使用SqlWorkbench用户登录
loginResp, err := sqlWorkbenchService.client.Login(sqlWorkbenchService.generateSqlWorkbenchUsername(dmsUser.Name), SQL_WORKBENCH_REAL_PASSWORD, publicKey)
if err != nil {
return "", "", fmt.Errorf("failed to login sql workbench user: %v", err)
}
// 获取组织信息
orgResp, err := sqlWorkbenchService.client.GetOrganizations(loginResp.Cookie)
if err != nil {
return "", "", fmt.Errorf("failed to get organizations: %v", err)
}
// 提取cookie值
jsessionID := sqlWorkbenchService.client.ExtractCookieValue(loginResp.Cookie, ODCSessionCookieName)
xsrfToken := sqlWorkbenchService.client.ExtractCookieValue(orgResp.XsrfToken, ODCXsrfTokenCookieName)
// 设置Cookie到echo.Context中
c.SetCookie(&http.Cookie{
Name: ODCSessionCookieName,
Value: jsessionID,
Path: "/",
HttpOnly: true,
Secure: false,
})
c.SetCookie(&http.Cookie{
Name: ODCXsrfTokenCookieName,
Value: xsrfToken,
Path: "/",
HttpOnly: false, // XSRF-TOKEN通常需要JavaScript访问
Secure: false,
})
// 缓存会话
sqlWorkbenchService.setODCSession(dmsUserId, dmsToken, jsessionID, xsrfToken)
sqlWorkbenchService.log.Infof("Successfully logged in sql workbench user %s", dmsUser.Name)
return jsessionID, xsrfToken, nil
}
// getODCSession 获取缓存的 ODC 会话
func (sqlWorkbenchService *SqlWorkbenchService) getODCSession(dmsUserId, dmsToken string) *odcSession {
odcSessionMutex.Lock()
defer odcSessionMutex.Unlock()
if item, ok := dmsUserIdODCSessionMap[dmsUserId]; ok {
if dmsToken == item.dmsToken {
// 返回副本以避免并发安全问题
session := item
return &session
}
}
return nil
}
// setODCSession 设置 ODC 会话缓存
func (sqlWorkbenchService *SqlWorkbenchService) setODCSession(dmsUserId, dmsToken, jsessionID, xsrfToken string) {
odcSessionMutex.Lock()
defer odcSessionMutex.Unlock()
dmsUserIdODCSessionMap[dmsUserId] = odcSession{
dmsToken: dmsToken,
jsessionID: jsessionID,
xsrfToken: xsrfToken,
}
}
// clearODCSession 清除 ODC 会话缓存
func (sqlWorkbenchService *SqlWorkbenchService) clearODCSession(dmsUserId string) {
odcSessionMutex.Lock()
defer odcSessionMutex.Unlock()
delete(dmsUserIdODCSessionMap, dmsUserId)
}
// validateODCSession 验证 ODC 会话是否有效
// 通过调用 GetOrganizations API 来验证会话
func (sqlWorkbenchService *SqlWorkbenchService) validateODCSession(jsessionID, xsrfToken string) bool {
cookie := fmt.Sprintf("%s=%s; %s=%s", ODCSessionCookieName, jsessionID, ODCXsrfTokenCookieName, xsrfToken)
_, err := sqlWorkbenchService.client.GetOrganizations(cookie)
if err != nil {
sqlWorkbenchService.log.Debugf("ODC session validation failed: %v", err)
return false
}
return true
}
// setODCCookiesToRequest 将 ODC cookies 设置到请求中
func (sqlWorkbenchService *SqlWorkbenchService) setODCCookiesToRequest(c echo.Context, jsessionID, xsrfToken string) {
// 更新请求的 Cookie header
// 获取请求中现有的 Cookie header,用于保留客户端已有的 cookies
currentCookies := c.Request().Header.Get("Cookie")
cookieMap := make(map[string]string)
// 解析现有 Cookie 字符串为 map,避免覆盖客户端已有的 cookies
// Cookie 格式为 "key1=value1; key2=value2",使用分号分隔
if currentCookies != "" {
existingCookies := strings.Split(currentCookies, ";")
for _, cookie := range existingCookies {
cookie = strings.TrimSpace(cookie)
if cookie != "" {
// 使用 SplitN 限制分割次数为 2,防止 cookie 值中包含 "=" 时被错误分割
parts := strings.SplitN(cookie, "=", 2)
if len(parts) == 2 {
cookieMap[parts[0]] = parts[1]
}
}
}
}
// 设置 ODC cookies
cookieMap[ODCSessionCookieName] = jsessionID
cookieMap[ODCXsrfTokenCookieName] = xsrfToken
// 构建新的 Cookie header
var cookieStrings []string
for name, value := range cookieMap {
cookieStrings = append(cookieStrings, fmt.Sprintf("%s=%s", name, value))
}
if len(cookieStrings) > 0 {
c.Request().Header.Set("Cookie", strings.Join(cookieStrings, "; "))
}
// 更新请求 header 中的 X-XSRF-TOKEN
c.Request().Header.Set("X-XSRF-TOKEN", xsrfToken)
}
// syncDatasources 同步DMS数据源到SqlWorkbench
func (sqlWorkbenchService *SqlWorkbenchService) syncDatasources(ctx context.Context, dmsUser *biz.User, sqlWorkbenchUser *biz.SqlWorkbenchUser) error {
// 获取用户有权限访问的数据源
activeDBServices, err := sqlWorkbenchService.getUserAccessibleDBServices(ctx, dmsUser)
if err != nil {
return fmt.Errorf("failed to get user accessible db services: %v", err)
}
// 获取当前用户Cookie
userCookie, organizationId, _, err := sqlWorkbenchService.getUserCookie(sqlWorkbenchService.generateSqlWorkbenchUsername(dmsUser.Name), SQL_WORKBENCH_REAL_PASSWORD)
if err != nil {
return fmt.Errorf("failed to get user cookie: %v", err)
}
// 同步数据源
return sqlWorkbenchService.syncDBServicesToSqlWorkbench(ctx, activeDBServices, sqlWorkbenchUser, userCookie, organizationId)
}
// getUserAccessibleDBServices 获取用户有权限访问的数据源
func (sqlWorkbenchService *SqlWorkbenchService) getUserAccessibleDBServices(ctx context.Context, dmsUser *biz.User) ([]*biz.DBService, error) {
// 获取所有活跃的数据源
activeDBServices, err := sqlWorkbenchService.dbServiceUsecase.GetActiveDBServices(ctx, nil)
if err != nil {
return nil, fmt.Errorf("failed to get active db services: %v", err)
}
// 检查用户是否有全局权限
hasGlobalOpPermission, err := sqlWorkbenchService.opPermissionVerifyUsecase.CanOpGlobal(ctx, dmsUser.UID)
if err != nil {
return nil, fmt.Errorf("failed to check global op permission: %v", err)
}
if hasGlobalOpPermission {
return activeDBServices, nil
}
// 获取用户的项目和数据源权限
opPermissions, err := sqlWorkbenchService.opPermissionVerifyUsecase.GetUserOpPermission(ctx, dmsUser.UID)
if err != nil {
return nil, fmt.Errorf("failed to get user op permissions: %v", err)
}
// 过滤有权限的数据源
activeDBServices, err = sqlWorkbenchService.filterDBServicesByPermissions(ctx, activeDBServices, opPermissions)
if err != nil {
return nil, fmt.Errorf("failed to filter db services by permissions: %v", err)
}
// 根据 provision “账号管理” 功能配置的权限进行过滤、修改连接用户
activeDBServices, err = sqlWorkbenchService.ResetDbServiceByAuth(ctx, activeDBServices, dmsUser.UID)
if err != nil {
return nil, fmt.Errorf("failed to reset db service by auth: %v", err)
}
return activeDBServices, nil
}
// filterDBServicesByPermissions 根据权限过滤数据源
func (sqlWorkbenchService *SqlWorkbenchService) filterDBServicesByPermissions(ctx context.Context, dbServices []*biz.DBService, opPermissions []biz.OpPermissionWithOpRange) ([]*biz.DBService, error) {
projectIdMap := make(map[string]struct{})
dbServiceIdMap := make(map[string]struct{})
for _, opPermission := range opPermissions {
// 项目权限
if opPermission.OpRangeType == biz.OpRangeTypeProject && opPermission.OpPermissionUID == pkgConst.UIDOfOpPermissionProjectAdmin {
for _, rangeUid := range opPermission.RangeUIDs {
projectIdMap[rangeUid] = struct{}{}
}
}
// 数据源权限
if opPermission.OpRangeType == biz.OpRangeTypeDBService && opPermission.OpPermissionUID == pkgConst.UIDOfOpPermissionSQLQuery {
for _, rangeUid := range opPermission.RangeUIDs {
dbServiceIdMap[rangeUid] = struct{}{}
}
}
}
var filteredDBServices []*biz.DBService
for _, dbService := range dbServices {
// 检查项目权限
if _, hasProjectPermission := projectIdMap[dbService.ProjectUID]; hasProjectPermission {
filteredDBServices = append(filteredDBServices, dbService)
continue
}
// 检查数据源权限
if _, hasDBServicePermission := dbServiceIdMap[dbService.UID]; hasDBServicePermission {
filteredDBServices = append(filteredDBServices, dbService)
}
}
return filteredDBServices, nil
}
// getUserCookie 获取当前用户Cookie
func (sqlWorkbenchService *SqlWorkbenchService) getUserCookie(dmsUsername string, dmsUserPassword string) (string, int64, string, error) {
// 获取公钥
publicKey, err := sqlWorkbenchService.client.GetPublicKey()
if err != nil {
return "", 0, "", fmt.Errorf("failed to get public key: %v", err)
}
// 使用当前用户账号登录
loginResp, err := sqlWorkbenchService.client.Login(dmsUsername, dmsUserPassword, publicKey)
if err != nil {
return "", 0, publicKey, fmt.Errorf("failed to login as user: %v", err)
}
// 获取组织信息
orgResp, err := sqlWorkbenchService.client.GetOrganizations(loginResp.Cookie)
if err != nil {
return "", 0, publicKey, fmt.Errorf("failed to get organizations: %v", err)
}
// 检查是否有足够的组织
if len(orgResp.Data.Contents) < 2 {
return "", 0, publicKey, fmt.Errorf("insufficient organizations, expected at least 2, got %d", len(orgResp.Data.Contents))
}
// 合并Cookie
return sqlWorkbenchService.client.MergeCookies(orgResp.XsrfToken, loginResp.Cookie), orgResp.Data.Contents[1].ID, publicKey, nil
}
// getEnvironmentID 获取环境ID
func (sqlWorkbenchService *SqlWorkbenchService) getEnvironmentID(organizationID int64, cookie string) (int64, error) {
// 调用GetEnvironments接口获取环境信息
envResp, err := sqlWorkbenchService.client.GetEnvironments(organizationID, cookie)
if err != nil {
return 0, fmt.Errorf("failed to get environments: %v", err)
}
// 检查是否有环境
if len(envResp.Data.Contents) == 0 {
return 0, fmt.Errorf("no environments found")
}
// 优先选择"默认"环境,如果没有则选择第一个
for _, env := range envResp.Data.Contents {
if env.Name == "默认" {
return env.ID, nil
}
}
// 如果没有找到"默认"环境,返回第一个环境的ID
return envResp.Data.Contents[0].ID, nil
}
// syncDBServicesToSqlWorkbench 同步数据源到SqlWorkbench
func (sqlWorkbenchService *SqlWorkbenchService) syncDBServicesToSqlWorkbench(ctx context.Context, dbServices []*biz.DBService, sqlWorkbenchUser *biz.SqlWorkbenchUser, userCookie string, organizationID int64) error {
// 获取公钥
publicKey, err := sqlWorkbenchService.client.GetPublicKey()
if err != nil {
return fmt.Errorf("failed to get public key: %v", err)
}
// 获取环境ID
environmentID, err := sqlWorkbenchService.getEnvironmentID(organizationID, userCookie)
if err != nil {
return fmt.Errorf("failed to get environment id: %v", err)
}
// 获取用户现有的数据源缓存
existingDatasources, err := sqlWorkbenchService.sqlWorkbenchDatasourceRepo.GetSqlWorkbenchDatasourcesByUserID(ctx, sqlWorkbenchUser.DMSUserID)
if err != nil {
return fmt.Errorf("failed to get existing datasources: %v", err)
}
// 创建数据源映射
existingDatasourceMap := make(map[string]*biz.SqlWorkbenchDatasource)
for _, ds := range existingDatasources {
key := sqlWorkbenchService.getDatasourceKey(ds.DMSDBServiceID, ds.Purpose)
existingDatasourceMap[key] = ds
}
if len(dbServices) == 0 {
sqlWorkbenchService.log.Infof("No accessible db services for user, cleaning up all existing datasources")
return sqlWorkbenchService.cleanupObsoleteDatasources(ctx, dbServices, existingDatasourceMap, userCookie, organizationID)
}
// 处理每个数据源
for _, dbService := range dbServices {
key := sqlWorkbenchService.getDatasourceKey(dbService.UID, dbService.AccountPurpose)
if existingDatasource, exists := existingDatasourceMap[key]; exists {
// 检查是否需要更新
if sqlWorkbenchService.shouldUpdateDatasource(dbService, existingDatasource) {
err = sqlWorkbenchService.updateDatasourceInSqlWorkbench(ctx, dbService, existingDatasource, publicKey, userCookie, organizationID, environmentID)
if err != nil {
sqlWorkbenchService.log.Errorf("Failed to update datasource %s: %v", dbService.Name, err)
}
}
} else {
// 创建新数据源
err = sqlWorkbenchService.createDatasourceInSqlWorkbench(ctx, dbService, sqlWorkbenchUser, publicKey, userCookie, organizationID, environmentID)
if err != nil {
sqlWorkbenchService.log.Errorf("Failed to create datasource %s: %v", dbService.Name, err)
}
}
}
// 删除不再需要的数据源
return sqlWorkbenchService.cleanupObsoleteDatasources(ctx, dbServices, existingDatasourceMap, userCookie, organizationID)
}
// getDatasourceKey 获取数据源唯一键
func (sqlWorkbenchService *SqlWorkbenchService) getDatasourceKey(dmsDBServiceID, purpose string) string {
return fmt.Sprintf("%s:%s", dmsDBServiceID, purpose)
}
// shouldUpdateDatasource 判断是否需要更新数据源
func (sqlWorkbenchService *SqlWorkbenchService) shouldUpdateDatasource(dbService *biz.DBService, existingDatasource *biz.SqlWorkbenchDatasource) bool {
// 比较数据源指纹,如果指纹不同则需要更新
currentFingerprint := sqlWorkbenchService.dbServiceUsecase.GetDBServiceFingerprint(dbService)
return existingDatasource.DMSDBServiceFingerprint != currentFingerprint
}
// createDatasourceInSqlWorkbench 在SqlWorkbench中创建数据源
func (sqlWorkbenchService *SqlWorkbenchService) createDatasourceInSqlWorkbench(ctx context.Context, dbService *biz.DBService, sqlWorkbenchUser *biz.SqlWorkbenchUser, publicKey, userCookie string, organizationID, environmentID int64) error {
// 构建创建数据源请求
createReq, err := sqlWorkbenchService.buildCreateDatasourceRequest(ctx, dbService, sqlWorkbenchUser, environmentID)
if err != nil {
return fmt.Errorf("failed to build create datasource request: %v", err)
}
// 调用创建接口
createResp, err := sqlWorkbenchService.client.CreateDatasources(createReq, publicKey, userCookie, organizationID)
if err != nil {
return fmt.Errorf("failed to create datasource: %v", err)
}
// 保存缓存
datasourceCache := &biz.SqlWorkbenchDatasource{
DMSDBServiceID: dbService.UID,
DMSUserID: sqlWorkbenchUser.DMSUserID,
DMSDBServiceFingerprint: sqlWorkbenchService.dbServiceUsecase.GetDBServiceFingerprint(dbService),
SqlWorkbenchDatasourceID: createResp.Data.ID,
Purpose: dbService.AccountPurpose,
}
err = sqlWorkbenchService.sqlWorkbenchDatasourceRepo.SaveSqlWorkbenchDatasourceCache(ctx, datasourceCache)
if err != nil {
return fmt.Errorf("failed to save datasource cache: %v", err)
}
sqlWorkbenchService.log.Infof("Successfully created datasource %s (ID: %d)", dbService.Name, createResp.Data.ID)
return nil
}
// updateDatasourceInSqlWorkbench 在SqlWorkbench中更新数据源
func (sqlWorkbenchService *SqlWorkbenchService) updateDatasourceInSqlWorkbench(ctx context.Context, dbService *biz.DBService, existingDatasource *biz.SqlWorkbenchDatasource, publicKey, userCookie string, organizationID, environmentID int64) error {
// 构建更新数据源请求
updateReq, err := sqlWorkbenchService.buildUpdateDatasourceRequest(ctx, dbService, environmentID)
if err != nil {
return fmt.Errorf("failed to build update datasource request: %v", err)
}
// 调用更新接口
_, err = sqlWorkbenchService.client.UpdateDatasource(existingDatasource.SqlWorkbenchDatasourceID, updateReq, publicKey, userCookie, organizationID)
if err != nil {
return fmt.Errorf("failed to update datasource: %v", err)
}
// 更新缓存中的指纹
updatedDatasourceCache := &biz.SqlWorkbenchDatasource{
DMSDBServiceID: dbService.UID,
DMSUserID: existingDatasource.DMSUserID,
DMSDBServiceFingerprint: sqlWorkbenchService.dbServiceUsecase.GetDBServiceFingerprint(dbService),
SqlWorkbenchDatasourceID: existingDatasource.SqlWorkbenchDatasourceID,
Purpose: dbService.AccountPurpose,
}
err = sqlWorkbenchService.sqlWorkbenchDatasourceRepo.SaveSqlWorkbenchDatasourceCache(ctx, updatedDatasourceCache)
if err != nil {
return fmt.Errorf("failed to update datasource cache: %v", err)
}
sqlWorkbenchService.log.Infof("Successfully updated datasource %s (ID: %d)", dbService.Name, existingDatasource.SqlWorkbenchDatasourceID)
return nil
}
// cleanupObsoleteDatasources 清理过时的数据源
func (sqlWorkbenchService *SqlWorkbenchService) cleanupObsoleteDatasources(ctx context.Context, currentDBServices []*biz.DBService, existingDatasourceMap map[string]*biz.SqlWorkbenchDatasource, userCookie string, organizationID int64) error {
currentKeys := make(map[string]bool)
for _, dbService := range currentDBServices {
key := sqlWorkbenchService.getDatasourceKey(dbService.UID, dbService.AccountPurpose)
currentKeys[key] = true
}
for key, existingDatasource := range existingDatasourceMap {
if !currentKeys[key] {
// 删除数据源
_, err := sqlWorkbenchService.client.DeleteDatasource(existingDatasource.SqlWorkbenchDatasourceID, userCookie, organizationID)
if err != nil {
sqlWorkbenchService.log.Errorf("Failed to delete datasource %d: %v", existingDatasource.SqlWorkbenchDatasourceID, err)
continue
}
// 删除缓存
err = sqlWorkbenchService.sqlWorkbenchDatasourceRepo.DeleteSqlWorkbenchDatasourceCache(ctx, existingDatasource.DMSDBServiceID, existingDatasource.DMSUserID, existingDatasource.Purpose)
if err != nil {
sqlWorkbenchService.log.Errorf("Failed to delete datasource cache: %v", err)
}
sqlWorkbenchService.log.Infof("Successfully deleted obsolete datasource %d", existingDatasource.SqlWorkbenchDatasourceID)
}
}
return nil
}
// getProjectName 获取项目名称
func (sqlWorkbenchService *SqlWorkbenchService) getProjectName(ctx context.Context, projectUID string) (string, error) {
project, err := sqlWorkbenchService.projectUsecase.GetProject(ctx, projectUID)
if err != nil {
return "", fmt.Errorf("failed to get project: %v", err)
}
return project.Name, nil
}
// buildDatasourceName 构建数据源名称,格式为项目名:数据源名
func (sqlWorkbenchService *SqlWorkbenchService) buildDatasourceName(ctx context.Context, dbService *biz.DBService) (string, error) {
projectName, err := sqlWorkbenchService.getProjectName(ctx, dbService.ProjectUID)
if err != nil {
return "", fmt.Errorf("failed to get project name: %v", err)
}
return fmt.Sprintf("%s:%s", projectName, dbService.Name), nil
}
// datasourceBaseInfo 数据源基础信息
type datasourceBaseInfo struct {
Name string
Type string
Username string
Password string
Host string
Port string
ServiceName *string
EnvironmentID int64
}
// buildDatasourceBaseInfo 构建数据源基础信息
func (sqlWorkbenchService *SqlWorkbenchService) buildDatasourceBaseInfo(ctx context.Context, dbService *biz.DBService, environmentID int64) (*datasourceBaseInfo, error) {
datasourceName, err := sqlWorkbenchService.buildDatasourceName(ctx, dbService)
if err != nil {
return nil, err
}
baseInfo := &datasourceBaseInfo{
Name: datasourceName,
Type: sqlWorkbenchService.convertDBType(dbService.DBType),
Username: dbService.User,
Password: dbService.Password,
Host: dbService.Host,
Port: dbService.Port,
EnvironmentID: environmentID,
}
// Oracle 特殊处理
if dbService.DBType == "Oracle" {
serviceName := dbService.AdditionalParams.GetParam("service_name").Value
baseInfo.ServiceName = &serviceName
}
return baseInfo, nil
}
// buildCreateDatasourceRequest 构建创建数据源请求
func (sqlWorkbenchService *SqlWorkbenchService) buildCreateDatasourceRequest(ctx context.Context, dbService *biz.DBService, sqlWorkbenchUser *biz.SqlWorkbenchUser, environmentID int64) (client.CreateDatasourceRequest, error) {
baseInfo, err := sqlWorkbenchService.buildDatasourceBaseInfo(ctx, dbService, environmentID)
if err != nil {
return client.CreateDatasourceRequest{}, err
}
return client.CreateDatasourceRequest{
CreatorID: sqlWorkbenchUser.SqlWorkbenchUserId,
Type: baseInfo.Type,
Name: baseInfo.Name,
Username: baseInfo.Username,
Password: baseInfo.Password,
Host: baseInfo.Host,
Port: baseInfo.Port,
ServiceName: baseInfo.ServiceName,
SSLConfig: client.SSLConfig{Enabled: false},
EnvironmentID: baseInfo.EnvironmentID,
}, nil
}
// buildUpdateDatasourceRequest 构建更新数据源请求
func (sqlWorkbenchService *SqlWorkbenchService) buildUpdateDatasourceRequest(ctx context.Context, dbService *biz.DBService, environmentID int64) (client.UpdateDatasourceRequest, error) {
baseInfo, err := sqlWorkbenchService.buildDatasourceBaseInfo(ctx, dbService, environmentID)
if err != nil {
return client.UpdateDatasourceRequest{}, err
}
return client.UpdateDatasourceRequest{
Type: baseInfo.Type,
Name: &baseInfo.Name,
Username: baseInfo.Username,
Password: &baseInfo.Password,
Host: baseInfo.Host,
Port: baseInfo.Port,
ServiceName: baseInfo.ServiceName,
SSLConfig: client.SSLConfig{Enabled: false},
EnvironmentID: baseInfo.EnvironmentID,
}, nil
}
// convertDBType 转换数据库类型
func (sqlWorkbenchService *SqlWorkbenchService) convertDBType(dmsDBType string) string {
// 这里需要根据实际的数据库类型映射关系进行转换
// ODC目前支持的数据源有: OB_MYSQL, OB_ORACLE, ORACLE, MYSQL, ODP_SHARDING_OB_MYSQL, DORIS, POSTGRESQL
// 其余调用创建数据源接口会直接失败
switch dmsDBType {
case "MySQL":
return "MYSQL"
case "PostgreSQL":
return "POSTGRESQL"
case "Oracle":
return "ORACLE"
case "SQL Server":
return "SQL_SERVER"
case "OceanBase For Oracle":
return "OB_ORACLE"
case "OceanBase For MySQL":
return "OB_MYSQL"
default:
return dmsDBType
}
}
func (sqlWorkbenchService *SqlWorkbenchService) SupportDBType(dbType pkgConst.DBType) bool {
return dbType == pkgConst.DBTypeMySQL || dbType == pkgConst.DBTypeOracle || dbType == pkgConst.DBTypeOceanBaseMySQL
}
// buildDatabaseUser 当是ob-mysql时需要给账号管理的账号附加租户名集群名等字符: root@oms_mysql#oms_resource_4250
func buildDatabaseUser(account string, dbServiceUser string, dbType string) string {
if dbType == string(pkgConst.DBTypeOceanBaseMySQL) {
index := strings.Index(dbServiceUser, "@")
if index == -1 {
return account
}
return account + dbServiceUser[index:]
}
return account
}
func ListAuthDbAccount(ctx context.Context, baseURL, projectUid, userId string) ([]*TempDBAccount, error) {
// Generate token
token, err := generateAuthToken(userId)
if err != nil {
return nil, fmt.Errorf("failed to generate auth token for user %s: %w", userId, err)
}
// Prepare request headers
header := map[string]string{
"Authorization": fmt.Sprintf("Bearer %s", token),
}
// Build request URL
u, err := url.Parse(baseURL)
if err != nil {
return nil, fmt.Errorf("invalid base URL: %w", err)
}
// Set the path for the endpoint
u.Path = fmt.Sprintf("/provision/v1/auth/projects/%s/db_accounts", projectUid)
// Add query parameters
query := u.Query()
query.Set("page_size", "999")
query.Set("page_index", "1")
query.Set("filter_by_password_managed", "true")
query.Set("filter_by_status", "unlock")
query.Set("filter_by_users", userId)
u.RawQuery = query.Encode()
requestURL := u.String()
// Execute request
reply := &ListDBAccountReply{}
if err := makeHttpRequest(ctx, requestURL, header, reply); err != nil {
return nil, err
}
// Validate response
if reply.Code != 0 {
return nil, fmt.Errorf("unexpected HTTP reply code (%v): %v", reply.Code, reply.Message)
}
return reply.Data, nil
}
// Helper function: Generate JWT token
func generateAuthToken(userId string) (string, error) {
token, err := jwt.GenJwtToken(jwt.WithUserId(userId))
if err != nil {
return "", fmt.Errorf("failed to generate JWT token: %w", err)
}
return token, nil