-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
views.py
626 lines (532 loc) · 20.2 KB
/
views.py
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
# -*- coding: UTF-8 -*-
import os
import traceback
from django.contrib.auth.decorators import permission_required
from django.contrib.auth.models import Group
from django.core.exceptions import PermissionDenied
from django.shortcuts import render, get_object_or_404
from django.http import HttpResponseRedirect, FileResponse, Http404
from django.urls import reverse
from django.conf import settings
from common.config import SysConfig
from sql.engines import get_engine, engine_map
from common.utils.permission import superuser_required
from common.utils.convert import Convert
from sql.utils.tasks import task_info
from .models import (
Users,
SqlWorkflow,
QueryPrivileges,
ResourceGroup,
QueryPrivilegesApply,
Config,
SQL_WORKFLOW_CHOICES,
InstanceTag,
Instance,
QueryLog,
ArchiveConfig,
AuditEntry,
TwoFactorAuthConfig,
)
from sql.utils.workflow_audit import Audit, AuditV2, AuditException
from sql.utils.sql_review import (
can_execute,
can_timingtask,
can_cancel,
can_view,
can_rollback,
)
from common.utils.const import Const, WorkflowType, WorkflowAction
from sql.utils.resource_group import user_groups, user_instances
import logging
logger = logging.getLogger("default")
def index(request):
index_path_url = SysConfig().get("index_path_url", "sqlworkflow")
return HttpResponseRedirect(f"/{index_path_url.strip('/')}/")
def login(request):
"""登录页面"""
if request.user and request.user.is_authenticated:
return HttpResponseRedirect("/")
return render(
request,
"login.html",
context={
"sign_up_enabled": SysConfig().get("sign_up_enabled"),
"oidc_enabled": settings.ENABLE_OIDC,
"dingding_enabled": settings.ENABLE_DINGDING,
"cas_enabled": settings.ENABLE_CAS,
"oidc_btn_name": SysConfig().get("oidc_btn_name", "以OIDC登录"),
},
)
def twofa(request):
"""2fa认证页面"""
if request.user.is_authenticated:
return HttpResponseRedirect("/")
username = request.session.get("user")
if username:
verify_mode = request.session.get("verify_mode")
twofa_enabled = TwoFactorAuthConfig.objects.filter(username=username)
user_auth_types = [twofa.auth_type for twofa in twofa_enabled]
auth_types = []
for user_auth_type in user_auth_types:
auth_type = {}
auth_type["code"] = user_auth_type
if user_auth_type == "totp":
auth_type["display"] = "Google身份验证器"
elif user_auth_type == "sms":
auth_type["display"] = "短信验证码"
auth_types.append(auth_type)
if "sms" in user_auth_types:
phone = TwoFactorAuthConfig.objects.get(
username=username, auth_type="sms"
).phone
else:
phone = 0
else:
return HttpResponseRedirect("/login/")
return render(
request,
"2fa.html",
context={
"verify_mode": verify_mode,
"auth_types": auth_types,
"username": username,
"phone": phone,
},
)
@permission_required("sql.menu_dashboard", raise_exception=True)
def dashboard(request):
"""dashboard页面"""
return render(request, "dashboard.html")
def sqlworkflow(request):
"""SQL上线工单列表页面"""
user = request.user
# 过滤筛选项的数据
filter_dict = dict()
# 管理员,可查看所有工单
if user.is_superuser or user.has_perm("sql.audit_user"):
pass
# 非管理员,拥有审核权限、资源组粒度执行权限的,可以查看组内所有工单
elif user.has_perm("sql.sql_review") or user.has_perm(
"sql.sql_execute_for_resource_group"
):
# 先获取用户所在资源组列表
group_list = user_groups(user)
group_ids = [group.group_id for group in group_list]
filter_dict["group_id__in"] = group_ids
# 其他人只能查看自己提交的工单
else:
filter_dict["engineer"] = user.username
instance_id = (
SqlWorkflow.objects.filter(**filter_dict).values("instance_id").distinct()
)
instance = Instance.objects.filter(pk__in=instance_id).order_by(
Convert("instance_name", "gbk").asc()
)
resource_group_id = (
SqlWorkflow.objects.filter(**filter_dict).values("group_id").distinct()
)
resource_group = ResourceGroup.objects.filter(group_id__in=resource_group_id)
return render(
request,
"sqlworkflow.html",
{
"status_list": SQL_WORKFLOW_CHOICES,
"instance": instance,
"resource_group": resource_group,
},
)
@permission_required("sql.sql_submit", raise_exception=True)
def submit_sql(request):
"""提交SQL的页面"""
user = request.user
# 获取组信息
group_list = user_groups(user)
# 获取系统配置
archer_config = SysConfig()
# 主动创建标签
InstanceTag.objects.get_or_create(
tag_code="can_write", defaults={"tag_name": "支持上线", "active": True}
)
context = {
"group_list": group_list,
"enable_backup_switch": archer_config.get("enable_backup_switch"),
"engines": engine_map,
}
return render(request, "sqlsubmit.html", context)
def detail(request, workflow_id):
"""展示SQL工单详细页面"""
workflow_detail = get_object_or_404(SqlWorkflow, pk=workflow_id)
audit_handler = AuditV2(workflow=workflow_detail)
if not can_view(request.user, workflow_id):
raise PermissionDenied
review_info = audit_handler.get_review_info()
# 自动审批不通过的不需要获取下列信息
if workflow_detail.status != "workflow_autoreviewwrong":
# 是否可审核
is_can_review = Audit.can_review(request.user, workflow_id, 2)
# 是否可执行 TODO 这几个判断方法入参都修改为workflow对象,可减少多次数据库交互
is_can_execute = can_execute(request.user, workflow_id)
# 是否可定时执行
is_can_timingtask = can_timingtask(request.user, workflow_id)
# 是否可取消
is_can_cancel = can_cancel(request.user, workflow_id)
# 是否可查看回滚信息
is_can_rollback = can_rollback(request.user, workflow_id)
# 获取审核日志
try:
audit_detail = Audit.detail_by_workflow_id(
workflow_id=workflow_id,
workflow_type=WorkflowType.SQL_REVIEW,
)
audit_id = audit_detail.audit_id
last_operation_info = (
Audit.logs(audit_id=audit_id).latest("id").operation_info
)
except Exception as e:
logger.debug(f"无审核日志记录,错误信息{e}")
last_operation_info = ""
else:
is_can_review = False
is_can_execute = False
is_can_timingtask = False
is_can_cancel = False
is_can_rollback = False
last_operation_info = None
# 获取定时执行任务信息
if workflow_detail.status == "workflow_timingtask":
job_id = Const.workflowJobprefix["sqlreview"] + "-" + str(workflow_id)
job = task_info(job_id)
if job:
run_date = job.next_run
else:
run_date = ""
else:
run_date = ""
# 获取是否开启手工执行确认
manual = SysConfig().get("manual")
context = {
"workflow_detail": workflow_detail,
"last_operation_info": last_operation_info,
"is_can_review": is_can_review,
"is_can_execute": is_can_execute,
"is_can_timingtask": is_can_timingtask,
"is_can_cancel": is_can_cancel,
"is_can_rollback": is_can_rollback,
"review_info": review_info,
"manual": manual,
"run_date": run_date,
}
return render(request, "detail.html", context)
def rollback(request):
"""展示回滚的SQL页面"""
workflow_id = request.GET.get("workflow_id")
if not can_rollback(request.user, workflow_id):
raise PermissionDenied
download = request.GET.get("download")
if workflow_id == "" or workflow_id is None:
context = {"errMsg": "workflow_id参数为空."}
return render(request, "error.html", context)
workflow = SqlWorkflow.objects.get(id=int(workflow_id))
# 直接下载回滚语句
if download:
try:
query_engine = get_engine(instance=workflow.instance)
list_backup_sql = query_engine.get_rollback(workflow=workflow)
except Exception as msg:
logger.error(traceback.format_exc())
context = {"errMsg": msg}
return render(request, "error.html", context)
# 获取数据,存入目录
path = os.path.join(settings.BASE_DIR, "downloads/rollback")
os.makedirs(path, exist_ok=True)
file_name = f"{path}/rollback_{workflow_id}.sql"
with open(file_name, "w") as f:
for sql in list_backup_sql:
f.write(f"/*{sql[0]}*/\n{sql[1]}\n")
# 返回
response = FileResponse(open(file_name, "rb"))
response["Content-Type"] = "application/octet-stream"
response["Content-Disposition"] = (
f'attachment;filename="rollback_{workflow_id}.sql"'
)
return response
# 异步获取,并在页面展示,如果数据量大加载会缓慢
else:
rollback_workflow_name = (
f"【回滚工单】原工单Id:{workflow_id} ,{workflow.workflow_name}"
)
context = {
"workflow_detail": workflow,
"rollback_workflow_name": rollback_workflow_name,
}
return render(request, "rollback.html", context)
@permission_required("sql.menu_sqlanalyze", raise_exception=True)
def sqlanalyze(request):
"""SQL分析页面"""
return render(request, "sqlanalyze.html")
@permission_required("sql.menu_query", raise_exception=True)
def sqlquery(request):
"""SQL在线查询页面"""
# 主动创建标签
InstanceTag.objects.get_or_create(
tag_code="can_read", defaults={"tag_name": "支持查询", "active": True}
)
# 收藏语句
user = request.user
favorites = QueryLog.objects.filter(username=user.username, favorite=True).values(
"id", "alias"
)
can_download = 1 if user.has_perm("sql.query_download") or user.is_superuser else 0
return render(
request,
"sqlquery.html",
{"favorites": favorites, "can_download": can_download, "engines": engine_map},
)
@permission_required("sql.menu_queryapplylist", raise_exception=True)
def queryapplylist(request):
"""查询权限申请列表页面"""
user = request.user
# 获取资源组
group_list = user_groups(user)
context = {"group_list": group_list, "engines": engine_map}
return render(request, "queryapplylist.html", context)
def queryapplydetail(request, apply_id):
"""查询权限申请详情页面"""
workflow_detail = QueryPrivilegesApply.objects.get(apply_id=apply_id)
# 获取当前审批和审批流程
audit_handler = AuditV2(workflow=workflow_detail)
review_info = audit_handler.get_review_info()
# 是否可审核
is_can_review = Audit.can_review(request.user, apply_id, 1)
# 获取审核日志
if workflow_detail.status == 2:
try:
audit_id = Audit.detail_by_workflow_id(
workflow_id=apply_id, workflow_type=1
).audit_id
last_operation_info = (
Audit.logs(audit_id=audit_id).latest("id").operation_info
)
except Exception as e:
logger.debug(f"无审核日志记录,错误信息{e}")
last_operation_info = ""
else:
last_operation_info = ""
context = {
"workflow_detail": workflow_detail,
"review_info": review_info,
"last_operation_info": last_operation_info,
"is_can_review": is_can_review,
}
return render(request, "queryapplydetail.html", context)
def queryuserprivileges(request):
"""查询权限管理页面"""
# 获取所有用户
user_list = (
QueryPrivileges.objects.filter(is_deleted=0).values("user_display").distinct()
)
context = {"user_list": user_list}
return render(request, "queryuserprivileges.html", context)
@permission_required("sql.menu_sqladvisor", raise_exception=True)
def sqladvisor(request):
"""SQL优化工具页面"""
return render(request, "sqladvisor.html")
@permission_required("sql.menu_slowquery", raise_exception=True)
def slowquery(request):
"""SQL慢日志页面"""
return render(request, "slowquery.html")
@permission_required("sql.menu_instance", raise_exception=True)
def instance(request):
"""实例管理页面"""
# 获取实例标签
tags = InstanceTag.objects.filter(active=True)
return render(request, "instance.html", {"tags": tags, "engines": engine_map})
@permission_required("sql.menu_instance_account", raise_exception=True)
def instanceaccount(request):
"""实例账号管理页面"""
return render(request, "instanceaccount.html")
@permission_required("sql.menu_database", raise_exception=True)
def database(request):
"""实例数据库管理页面"""
# 获取所有有效用户,通知对象
active_user = Users.objects.filter(is_active=1)
return render(request, "database.html", {"active_user": active_user})
@permission_required("sql.menu_dbdiagnostic", raise_exception=True)
def dbdiagnostic(request):
"""会话管理页面"""
return render(request, "dbdiagnostic.html")
@permission_required("sql.menu_data_dictionary", raise_exception=True)
def data_dictionary(request):
"""数据字典页面"""
return render(request, "data_dictionary.html", locals())
@permission_required("sql.menu_param", raise_exception=True)
def instance_param(request):
"""实例参数管理页面"""
return render(request, "param.html")
@permission_required("sql.menu_my2sql", raise_exception=True)
def my2sql(request):
"""my2sql页面"""
return render(request, "my2sql.html")
@permission_required("sql.menu_schemasync", raise_exception=True)
def schemasync(request):
"""数据库差异对比页面"""
return render(request, "schemasync.html")
@permission_required("sql.menu_archive", raise_exception=True)
def archive(request):
"""归档列表页面"""
# 获取资源组
group_list = user_groups(request.user)
ins_list = user_instances(request.user, db_type=["mysql"]).order_by(
Convert("instance_name", "gbk").asc()
)
return render(
request, "archive.html", {"group_list": group_list, "ins_list": ins_list}
)
def archive_detail(request, id):
"""归档详情页面"""
archive_config = ArchiveConfig.objects.get(pk=id)
# 获取当前审批和审批流程、是否可审核
audit_handler = AuditV2(
workflow=archive_config, resource_group=archive_config.resource_group
)
review_info = audit_handler.get_review_info()
try:
audit_handler.can_operate(WorkflowAction.PASS, request.user)
can_review = True
except AuditException:
can_review = False
# 获取审核日志
if archive_config.status == 2:
try:
audit_id = Audit.detail_by_workflow_id(
workflow_id=id, workflow_type=3
).audit_id
last_operation_info = (
Audit.logs(audit_id=audit_id).latest("id").operation_info
)
except Exception as e:
logger.debug(f"归档配置{id}无审核日志记录,错误信息{e}")
last_operation_info = ""
else:
last_operation_info = ""
context = {
"archive_config": archive_config,
"review_info": review_info,
"last_operation_info": last_operation_info,
"can_review": can_review,
}
return render(request, "archivedetail.html", context)
@superuser_required
def config(request):
"""配置管理页面"""
# 获取所有资源组名称
group_list = ResourceGroup.objects.all()
# 获取所有权限组
auth_group_list = Group.objects.all()
# 获取所有实例标签
instance_tags = InstanceTag.objects.all()
# 支持自动审核的数据库类型
db_type = ["mysql", "oracle", "mongo", "clickhouse", "redis", "doris"]
# 获取所有配置项
all_config = Config.objects.all().values("item", "value")
sys_config = {}
for items in all_config:
sys_config[items["item"]] = items["value"]
context = {
"group_list": group_list,
"auth_group_list": auth_group_list,
"instance_tags": instance_tags,
"db_type": db_type,
"config": sys_config,
"workflow_choices": WorkflowType,
}
return render(request, "config.html", context)
@superuser_required
def group(request):
"""资源组管理页面"""
return render(request, "group.html")
@superuser_required
def groupmgmt(request, group_id):
"""资源组组关系管理页面"""
group = ResourceGroup.objects.get(group_id=group_id)
return render(request, "groupmgmt.html", {"group": group})
def workflows(request):
"""待办列表页面"""
return render(request, "workflow.html")
def workflowsdetail(request, audit_id):
"""待办详情"""
# 按照不同的workflow_type返回不同的详情
audit_detail = Audit.detail(audit_id)
if not audit_detail:
raise Http404("不存在对应的工单记录")
if audit_detail.workflow_type == WorkflowType.QUERY:
return HttpResponseRedirect(
reverse("sql:queryapplydetail", args=(audit_detail.workflow_id,))
)
elif audit_detail.workflow_type == WorkflowType.SQL_REVIEW:
return HttpResponseRedirect(
reverse("sql:detail", args=(audit_detail.workflow_id,))
)
elif audit_detail.workflow_type == WorkflowType.ARCHIVE:
return HttpResponseRedirect(
reverse("sql:archive_detail", args=(audit_detail.workflow_id,))
)
@permission_required("sql.menu_document", raise_exception=True)
def dbaprinciples(request):
"""SQL文档页面"""
# 读取MD文件
file = os.path.join(settings.BASE_DIR, "docs/docs.md")
with open(file, "r", encoding="utf-8") as f:
md = f.read().replace("\n", "\\n")
return render(request, "dbaprinciples.html", {"md": md})
@permission_required("sql.audit_user", raise_exception=True)
def audit(request):
"""通用审计日志页面"""
_action_types = AuditEntry.objects.values_list("action").distinct()
action_types = [i[0] for i in _action_types]
return render(request, "audit.html", {"action_types": action_types})
@permission_required("sql.audit_user", raise_exception=True)
def audit_sqlquery(request):
"""SQL在线查询页面审计"""
user = request.user
favorites = QueryLog.objects.filter(username=user.username, favorite=True).values(
"id", "alias"
)
return render(request, "audit_sqlquery.html", {"favorites": favorites})
def audit_sqlworkflow(request):
"""SQL上线工单列表页面"""
user = request.user
# 过滤筛选项的数据
filter_dict = dict()
# 管理员,可查看所有工单
if user.is_superuser or user.has_perm("sql.audit_user"):
pass
# 非管理员,拥有审核权限、资源组粒度执行权限的,可以查看组内所有工单
elif user.has_perm("sql.sql_review") or user.has_perm(
"sql.sql_execute_for_resource_group"
):
# 先获取用户所在资源组列表
group_list = user_groups(user)
group_ids = [group.group_id for group in group_list]
filter_dict["group_id__in"] = group_ids
# 其他人只能查看自己提交的工单
else:
filter_dict["engineer"] = user.username
instance_id = (
SqlWorkflow.objects.filter(**filter_dict).values("instance_id").distinct()
)
instance = Instance.objects.filter(pk__in=instance_id)
resource_group_id = (
SqlWorkflow.objects.filter(**filter_dict).values("group_id").distinct()
)
resource_group = ResourceGroup.objects.filter(group_id__in=resource_group_id)
return render(
request,
"audit_sqlworkflow.html",
{
"status_list": SQL_WORKFLOW_CHOICES,
"instance": instance,
"resource_group": resource_group,
},
)