-
Notifications
You must be signed in to change notification settings - Fork 175
Expand file tree
/
Copy pathvfolder.py
More file actions
1795 lines (1606 loc) · 74 KB
/
vfolder.py
File metadata and controls
1795 lines (1606 loc) · 74 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
import asyncio
import logging
import math
import uuid
from pathlib import Path, PurePosixPath
from typing import (
Any,
cast,
)
import aiohttp
import msgpack
import yarl
from aiohttp import hdrs, web
from sqlalchemy import exc as sa_exc
from ai.backend.common.bgtask.bgtask import BackgroundTaskManager
from ai.backend.common.clients.valkey_client.valkey_stat.client import ValkeyStatClient
from ai.backend.common.contexts.user import current_user
from ai.backend.common.defs import VFOLDER_GROUP_PERMISSION_MODE
from ai.backend.common.etcd import AsyncEtcd
from ai.backend.common.exception import UnreachableError
from ai.backend.common.types import (
QuotaScopeID,
QuotaScopeType,
VFolderHostPermission,
VFolderHostPermissionMap,
VFolderID,
VFolderUsageMode,
)
from ai.backend.logging.utils import BraceStyleAdapter
from ai.backend.manager.config.provider import ManagerConfigProvider
from ai.backend.manager.data.vfolder.dto import UserIdentity
from ai.backend.manager.data.vfolder.types import (
VFolderCreateParams,
VFolderData,
VFolderMountPermission,
)
from ai.backend.manager.errors.common import Forbidden, InternalServerError, ObjectNotFound
from ai.backend.manager.errors.kernel import BackendAgentError
from ai.backend.manager.errors.resource import ProjectNotFound
from ai.backend.manager.errors.storage import (
TooManyVFoldersFound,
UnexpectedStorageProxyResponseError,
VFolderAlreadyExists,
VFolderBadRequest,
VFolderCreationFailure,
VFolderFilterStatusFailed,
VFolderFilterStatusNotAvailable,
VFolderGone,
VFolderInvalidParameter,
VFolderNotFound,
VFolderOperationFailed,
)
from ai.backend.manager.errors.user import UserNotFound
from ai.backend.manager.models.group import ProjectType
from ai.backend.manager.models.storage import StorageSessionManager
from ai.backend.manager.models.user import UserRole
from ai.backend.manager.models.vfolder import (
VFolderCloneInfo,
VFolderOperationStatus,
VFolderOwnershipType,
VFolderPermission,
VFolderRow,
VFolderStatusSet,
is_unmanaged,
verify_vfolder_name,
vfolder_status_map,
)
from ai.backend.manager.repositories.user.repository import UserRepository
from ai.backend.manager.repositories.vfolder.repository import VfolderRepository
from ai.backend.manager.repositories.vfolder.updaters import VFolderAttributeUpdaterSpec
from ai.backend.manager.services.vfolder.actions.base import (
CloneVFolderAction,
CloneVFolderActionResult,
CreateVFolderAction,
CreateVFolderActionResult,
DeleteForeverVFolderAction,
DeleteForeverVFolderActionResult,
ForceDeleteVFolderAction,
ForceDeleteVFolderActionResult,
GetAccessibleVFolderAction,
GetAccessibleVFolderActionResult,
GetTaskLogsAction,
GetTaskLogsActionResult,
GetVFolderAction,
GetVFolderActionResult,
ListVFolderAction,
ListVFolderActionResult,
MoveToTrashVFolderAction,
MoveToTrashVFolderActionResult,
PurgeVFolderAction,
PurgeVFolderActionResult,
RestoreVFolderFromTrashAction,
RestoreVFolderFromTrashActionResult,
UpdateVFolderAttributeAction,
UpdateVFolderAttributeActionResult,
)
from ai.backend.manager.services.vfolder.actions.batch_load_by_ids import (
BatchLoadVFoldersByIdsAction,
BatchLoadVFoldersByIdsActionResult,
)
from ai.backend.manager.services.vfolder.actions.create_v2 import (
CreateVFolderV2Action,
CreateVFolderV2ActionResult,
)
from ai.backend.manager.services.vfolder.actions.file_v2 import (
CloneVFolderV2Action,
CloneVFolderV2ActionResult,
)
from ai.backend.manager.services.vfolder.actions.get_my_storage_host_permissions import (
GetMyStorageHostPermissionsAction,
GetMyStorageHostPermissionsActionResult,
StorageHostPermissionEntry,
)
from ai.backend.manager.services.vfolder.actions.get_v2 import (
GetVFolderV2Action,
GetVFolderV2ActionResult,
)
from ai.backend.manager.services.vfolder.actions.search_in_project import (
SearchVFoldersInProjectAction,
SearchVFoldersInProjectActionResult,
)
from ai.backend.manager.services.vfolder.actions.search_user_vfolders import (
SearchUserVFoldersAction,
SearchUserVFoldersActionResult,
)
from ai.backend.manager.services.vfolder.actions.storage_ops import (
ChangeVFolderOwnershipAction,
ChangeVFolderOwnershipActionResult,
GetFstabContentsAction,
GetFstabContentsActionResult,
GetQuotaAction,
GetQuotaActionResult,
GetVFolderUsageAction,
GetVFolderUsageActionResult,
GetVFolderUsedBytesAction,
GetVFolderUsedBytesActionResult,
GetVolumePerfMetricAction,
GetVolumePerfMetricActionResult,
ListAllHostsAction,
ListAllHostsActionResult,
ListAllowedTypesAction,
ListAllowedTypesActionResult,
ListHostsAction,
ListHostsActionResult,
ListMountsAction,
ListMountsActionResult,
MountHostAction,
MountHostActionResult,
MountResultData,
UmountHostAction,
UmountHostActionResult,
UpdateQuotaAction,
UpdateQuotaActionResult,
)
from ai.backend.manager.services.vfolder.actions.upload_session_v2 import (
CreateUploadSessionV2Action,
CreateUploadSessionV2ActionResult,
)
from ai.backend.manager.services.vfolder.actions.vfolder_v2 import (
DeleteVFolderV2Action,
DeleteVFolderV2ActionResult,
PurgeVFolderV2Action,
PurgeVFolderV2ActionResult,
)
from ai.backend.manager.services.vfolder.types import (
VFolderBaseInfo,
VFolderOwnershipInfo,
VFolderUsageInfo,
)
log = BraceStyleAdapter(logging.getLogger(__spec__.name))
async def _check_vfolder_status(
vfolder_status: VFolderOperationStatus,
status: VFolderStatusSet,
) -> None:
"""
Checks if the target vfolder status matches one of the status sets aliased by `status` VFolderStatusSet,
"""
available_vf_statuses = vfolder_status_map.get(status)
if not available_vf_statuses:
raise VFolderFilterStatusNotAvailable
if vfolder_status not in available_vf_statuses:
raise VFolderFilterStatusFailed
class VFolderService:
_config_provider: ManagerConfigProvider
_etcd: AsyncEtcd
_storage_manager: StorageSessionManager
_background_task_manager: BackgroundTaskManager
_vfolder_repository: VfolderRepository
_user_repository: UserRepository
_valkey_stat_client: ValkeyStatClient
def __init__(
self,
config_provider: ManagerConfigProvider,
etcd: AsyncEtcd,
storage_manager: StorageSessionManager,
background_task_manager: BackgroundTaskManager,
vfolder_repository: VfolderRepository,
user_repository: UserRepository,
valkey_stat_client: ValkeyStatClient,
) -> None:
self._config_provider = config_provider
self._etcd = etcd
self._storage_manager = storage_manager
self._vfolder_repository = vfolder_repository
self._user_repository = user_repository
self._background_task_manager = background_task_manager
self._valkey_stat_client = valkey_stat_client
async def batch_load_by_ids(
self, action: BatchLoadVFoldersByIdsAction
) -> BatchLoadVFoldersByIdsActionResult:
"""Batch fetch vfolders by IDs for cross-entity reference resolution.
Audit log records this as ``vfolder.GET`` (not as a search).
"""
data = await self._vfolder_repository.batch_load_by_ids(action.ids)
return BatchLoadVFoldersByIdsActionResult(data=data)
async def create(self, action: CreateVFolderAction) -> CreateVFolderActionResult:
user_role = action.user_role
user_uuid = action.user_uuid
keypair_resource_policy = action.keypair_resource_policy
domain_name = action.domain_name
group_id_or_name = action.group_id_or_name
folder_host = action.folder_host
unmanaged_path = action.unmanaged_path
# Resolve host for the new virtual folder.
if not folder_host:
folder_host = self._config_provider.config.volumes.default_host
if not folder_host:
raise VFolderInvalidParameter(
"You must specify the vfolder host because the default host is not configured."
)
# Check if user is trying to created unmanaged vFolder
if unmanaged_path:
# Approve only if user is Admin or Superadmin
if user_role not in (UserRole.ADMIN, UserRole.SUPERADMIN):
raise Forbidden("Insufficient permission")
# Assign ghost host to unmanaged vfolder
allowed_vfolder_types = (
await self._config_provider.legacy_etcd_config_loader.get_vfolder_types()
)
if action.name.startswith(".") and action.name != ".local":
if action.group_id_or_name is not None:
raise VFolderInvalidParameter("dot-prefixed vfolders cannot be a group folder.")
group_uuid: uuid.UUID | None = None
group_type: ProjectType | None = None
max_vfolder_count: int
max_quota_scope_size: int
container_uid: int | None = None
# Get resource information using repository
match group_id_or_name:
case str() | uuid.UUID():
group_info = await self._vfolder_repository.get_group_resource_info(
group_id_or_name, domain_name
)
if not group_info:
raise ProjectNotFound(f"Project with {group_id_or_name} not found.")
group_uuid, max_vfolder_count, max_quota_scope_size, group_type = group_info
container_uid = None
case None:
user_info = await self._vfolder_repository.get_user_resource_info(user_uuid)
if not user_info:
raise ObjectNotFound(object_name="User")
max_vfolder_count, max_quota_scope_size, container_uid = user_info
group_uuid = None
group_type = None
case _:
raise ProjectNotFound(f"Project with {group_id_or_name} not found.")
vfolder_permission_mode = (
VFOLDER_GROUP_PERMISSION_MODE if container_uid is not None else None
)
# Check if group exists when it's given a non-empty value.
if group_id_or_name and group_uuid is None:
raise ProjectNotFound(f"Project with {group_id_or_name} not found.")
# Determine the ownership type and the quota scope ID.
if group_uuid is not None:
ownership_type = "group"
quota_scope_id = QuotaScopeID(QuotaScopeType.PROJECT, group_uuid)
if (
user_role not in (UserRole.SUPERADMIN, UserRole.ADMIN)
and group_type != ProjectType.MODEL_STORE
):
raise Forbidden("no permission")
else:
ownership_type = "user"
quota_scope_id = QuotaScopeID(QuotaScopeType.USER, user_uuid)
if ownership_type not in allowed_vfolder_types:
raise VFolderInvalidParameter(
f"{ownership_type}-owned vfolder is not allowed in this cluster"
)
if group_type == ProjectType.MODEL_STORE:
if action.usage_mode != VFolderUsageMode.MODEL:
raise VFolderInvalidParameter(
"Only Model VFolder can be created under the model store project"
)
# Check host permissions
await self._vfolder_repository.ensure_host_permission_allowed(
folder_host,
permission=VFolderHostPermission.CREATE,
allowed_vfolder_types=allowed_vfolder_types,
user_uuid=user_uuid,
resource_policy=keypair_resource_policy,
domain_name=domain_name,
group_id=group_uuid,
)
# Check resource policy's max_vfolder_count using repository
if max_vfolder_count > 0:
if ownership_type == "user":
current_count = await self._vfolder_repository.count_vfolders_by_user(user_uuid)
else:
if group_uuid is None:
raise VFolderInvalidParameter("Group UUID is required for group-owned vfolders")
current_count = await self._vfolder_repository.count_vfolders_by_group(group_uuid)
if current_count >= max_vfolder_count:
raise VFolderInvalidParameter("You cannot create more vfolders.")
# Check for duplicate vfolder names using repository
name_exists = await self._vfolder_repository.check_vfolder_name_exists(
action.name,
user_uuid,
user_role,
domain_name,
list(allowed_vfolder_types),
)
if name_exists:
raise VFolderAlreadyExists(
f"VFolder with the given name already exists. ({action.name})"
)
folder_id = uuid.uuid4()
try:
vfid = VFolderID(quota_scope_id, folder_id)
if not unmanaged_path:
proxy_name, volume_name = self._storage_manager.get_proxy_and_volume(
folder_host, is_unmanaged(unmanaged_path)
)
manager_client = self._storage_manager.get_manager_facing_client(proxy_name)
await manager_client.create_folder(
volume_name,
str(vfid),
max_quota_scope_size,
vfolder_permission_mode,
)
except aiohttp.ClientResponseError as e:
raise VFolderCreationFailure from e
# By default model store VFolder should be considered as read only for every users but without the creator
if group_type == ProjectType.MODEL_STORE:
action.mount_permission = VFolderPermission.READ_ONLY
# Use repository to create VFolder
params = VFolderCreateParams(
id=folder_id,
name=action.name,
domain_name=domain_name,
quota_scope_id=str(quota_scope_id),
usage_mode=action.usage_mode,
permission=action.mount_permission,
host=folder_host,
creator=action.creator_email,
creator_id=action.user_uuid,
ownership_type=VFolderOwnershipType(ownership_type),
user=user_uuid if ownership_type == "user" else None,
group=group_uuid if ownership_type == "group" else None,
unmanaged_path=unmanaged_path,
cloneable=action.cloneable,
status=VFolderOperationStatus.READY,
)
try:
# Create with permission if it's a model store
create_owner_permission = group_type == ProjectType.MODEL_STORE
await self._vfolder_repository.create_vfolder_with_permission(
params, create_owner_permission=create_owner_permission
)
except sa_exc.DataError as e:
raise VFolderInvalidParameter from e
return CreateVFolderActionResult(
id=folder_id,
name=action.name,
quota_scope_id=quota_scope_id,
host=folder_host,
unmanaged_path=unmanaged_path,
usage_mode=action.usage_mode,
mount_permission=action.mount_permission,
user_uuid=user_uuid if ownership_type == "user" else None,
group_uuid=group_uuid if ownership_type == "group" else None,
creator_email=action.creator_email,
ownership_type=VFolderOwnershipType(ownership_type),
cloneable=action.cloneable,
status=VFolderOperationStatus.READY,
)
async def update_attribute(
self, action: UpdateVFolderAttributeAction
) -> UpdateVFolderAttributeActionResult:
spec = cast(VFolderAttributeUpdaterSpec, action.updater.spec)
allowed_vfolder_types = (
await self._config_provider.legacy_etcd_config_loader.get_vfolder_types()
)
# Get user info using repository
user_info = await self._vfolder_repository.get_user_info(action.user_uuid)
if not user_info:
raise ObjectNotFound(object_name="User")
user_role, user_domain_name = user_info
# Get all accessible vfolders to check for name conflicts
vfolder_list_result = await self._vfolder_repository.list_accessible_vfolders(
user_id=action.user_uuid,
user_role=user_role,
domain_name=user_domain_name,
allowed_vfolder_types=list(allowed_vfolder_types),
)
if not vfolder_list_result.vfolders:
raise VFolderNotFound()
# Check for name conflicts if name is being updated
try:
new_name = spec.name.value()
except ValueError:
pass
else:
for access_info in vfolder_list_result.vfolders:
if access_info.vfolder_data.name == new_name:
raise VFolderInvalidParameter(
"One of your accessible vfolders already has the name you requested."
)
# Update the vfolder using repository
await self._vfolder_repository.update_vfolder_attribute(action.updater)
return UpdateVFolderAttributeActionResult(vfolder_uuid=action.vfolder_uuid)
async def get(self, action: GetVFolderAction) -> GetVFolderActionResult:
allowed_vfolder_types = (
await self._config_provider.legacy_etcd_config_loader.get_vfolder_types()
)
# Get user info using repository
user_info = await self._vfolder_repository.get_user_info(action.user_uuid)
if not user_info:
raise ObjectNotFound(object_name="User")
user_role, user_domain_name = user_info
# Use repository to get accessible vfolders
vfolder_list_result = await self._vfolder_repository.list_accessible_vfolders(
user_id=action.user_uuid,
user_role=user_role,
domain_name=user_domain_name,
allowed_vfolder_types=list(allowed_vfolder_types),
extra_conditions=(VFolderRow.id == action.vfolder_uuid),
)
if not vfolder_list_result.vfolders:
raise VFolderNotFound()
vfolder_access_info = vfolder_list_result.vfolders[0]
vfolder_data = vfolder_access_info.vfolder_data
if vfolder_access_info.effective_permission is None:
is_owner = True
permission = VFolderPermission.OWNER_PERM
else:
is_owner = vfolder_access_info.is_owner
permission = vfolder_access_info.effective_permission
proxy_name, volume_name = self._storage_manager.get_proxy_and_volume(
vfolder_data.host, is_unmanaged(vfolder_data.unmanaged_path)
)
manager_client = self._storage_manager.get_manager_facing_client(proxy_name)
usage = await manager_client.get_folder_usage(
volume_name,
str(VFolderID(vfolder_data.quota_scope_id, vfolder_data.id)),
)
usage_info = VFolderUsageInfo(
used_bytes=usage["used_bytes"],
num_files=usage["file_count"],
)
return GetVFolderActionResult(
user_uuid=action.user_uuid,
base_info=VFolderBaseInfo(
id=vfolder_data.id,
quota_scope_id=vfolder_data.quota_scope_id,
name=vfolder_data.name,
host=vfolder_data.host,
status=vfolder_data.status,
unmanaged_path=vfolder_data.unmanaged_path,
mount_permission=permission,
usage_mode=vfolder_data.usage_mode,
created_at=vfolder_data.created_at,
cloneable=vfolder_data.cloneable,
),
ownership_info=VFolderOwnershipInfo(
creator_email=vfolder_data.creator,
ownership_type=vfolder_data.ownership_type,
is_owner=is_owner,
user_uuid=vfolder_data.user,
group_uuid=vfolder_data.group,
),
usage_info=usage_info,
)
async def list(self, action: ListVFolderAction) -> ListVFolderActionResult:
allowed_vfolder_types = (
await self._config_provider.legacy_etcd_config_loader.get_vfolder_types()
)
# Get user info using repository
user_info = await self._vfolder_repository.get_user_info(action.user_uuid)
if not user_info:
raise ObjectNotFound(object_name="User")
user_role, user_domain_name = user_info
# Use repository to get accessible vfolders
vfolder_list_result = await self._vfolder_repository.list_accessible_vfolders(
user_id=action.user_uuid,
user_role=user_role,
domain_name=user_domain_name,
allowed_vfolder_types=list(allowed_vfolder_types),
)
vfolders = [
(
VFolderBaseInfo(
id=access_info.vfolder_data.id,
quota_scope_id=access_info.vfolder_data.quota_scope_id,
name=access_info.vfolder_data.name,
host=access_info.vfolder_data.host,
status=access_info.vfolder_data.status,
unmanaged_path=access_info.vfolder_data.unmanaged_path,
# None means owner, who has full permissions
mount_permission=access_info.effective_permission
or VFolderMountPermission.RW_DELETE,
usage_mode=access_info.vfolder_data.usage_mode,
created_at=access_info.vfolder_data.created_at,
cloneable=access_info.vfolder_data.cloneable,
),
VFolderOwnershipInfo(
creator_email=access_info.vfolder_data.creator,
ownership_type=access_info.vfolder_data.ownership_type,
is_owner=access_info.is_owner,
user_uuid=access_info.vfolder_data.user,
group_uuid=access_info.vfolder_data.group,
),
)
for access_info in vfolder_list_result.vfolders
]
return ListVFolderActionResult(
user_uuid=action.user_uuid,
vfolders=vfolders,
_scope_type=action.scope_type(),
_scope_id=action.scope_id(),
)
async def search_in_project(
self, action: SearchVFoldersInProjectAction
) -> SearchVFoldersInProjectActionResult:
"""Search vfolders scoped to a project."""
result = await self._vfolder_repository.search_in_project(action.querier, action.scope)
return SearchVFoldersInProjectActionResult(
project_id=action.scope.project_id,
data=result.items,
total_count=result.total_count,
has_next_page=result.has_next_page,
has_previous_page=result.has_previous_page,
)
async def search_user_vfolders(
self, action: SearchUserVFoldersAction
) -> SearchUserVFoldersActionResult:
"""Search vfolders owned by a specific user."""
result = await self._vfolder_repository.search_user_vfolders(
querier=action.querier, scope=action.scope
)
return SearchUserVFoldersActionResult(
user_id=action.scope.user_id,
data=result.items,
total_count=result.total_count,
has_next_page=result.has_next_page,
has_previous_page=result.has_previous_page,
)
async def move_to_trash(
self, action: MoveToTrashVFolderAction
) -> MoveToTrashVFolderActionResult:
# TODO: Implement proper permission checking and business logic
# For now, use admin repository for the operation
user = await self._user_repository.get_user_by_uuid(action.user_uuid)
if not user.domain_name:
raise VFolderInvalidParameter("User has no domain assigned")
vfolder_data = await self._vfolder_repository.get_by_id_validated(
action.vfolder_uuid, user.id, user.domain_name
)
await self._vfolder_repository.move_vfolders_to_trash([vfolder_data.id])
return MoveToTrashVFolderActionResult(vfolder_uuid=action.vfolder_uuid)
async def restore(
self, action: RestoreVFolderFromTrashAction
) -> RestoreVFolderFromTrashActionResult:
# TODO: Implement proper permission checking and business logic
# For now, use admin repository for the operation
user = await self._user_repository.get_user_by_uuid(action.user_uuid)
if not user.domain_name:
raise VFolderInvalidParameter("User has no domain assigned")
vfolder_data = await self._vfolder_repository.get_by_id_validated(
action.vfolder_uuid, user.id, user.domain_name
)
await self._vfolder_repository.restore_vfolders_from_trash([vfolder_data.id])
return RestoreVFolderFromTrashActionResult(vfolder_uuid=action.vfolder_uuid)
async def _remove_vfolder_from_storage(self, vfolder_data: VFolderData) -> None:
proxy_name, volume_name = self._storage_manager.get_proxy_and_volume(
vfolder_data.host, is_unmanaged(vfolder_data.unmanaged_path)
)
try:
manager_client = self._storage_manager.get_manager_facing_client(proxy_name)
await manager_client.delete_folder(
volume_name,
str(VFolderID(vfolder_data.quota_scope_id, vfolder_data.id)),
)
except VFolderGone as e:
# If the vfolder is already gone, just delete it from the repository
log.warning("VFolder {} is already gone: {}", vfolder_data.id, e)
except VFolderNotFound as e:
# If the vfolder is not found, just delete it from the repository
log.warning("VFolder {} not found: {}", vfolder_data.id, e)
async def delete_forever(
self, action: DeleteForeverVFolderAction
) -> DeleteForeverVFolderActionResult:
# TODO: Implement proper permission checking and business logic
# For now, use admin repository for the operation
user = await self._user_repository.get_user_by_uuid(action.user_uuid)
if not user.domain_name:
raise VFolderInvalidParameter("User has no domain assigned")
vfolder_data = await self._vfolder_repository.get_by_id_validated(
action.vfolder_uuid, user.id, user.domain_name
)
await self._vfolder_repository.delete_vfolders_forever([action.vfolder_uuid])
await self._remove_vfolder_from_storage(vfolder_data)
return DeleteForeverVFolderActionResult(vfolder_uuid=action.vfolder_uuid)
async def purge(self, action: PurgeVFolderAction) -> PurgeVFolderActionResult:
"""Purge a DELETE_COMPLETE vfolder from DB (admin only)."""
data = await self._vfolder_repository.purge_vfolder(action.purger)
return PurgeVFolderActionResult(vfolder_uuid=data.id)
async def force_delete(
self, action: ForceDeleteVFolderAction
) -> ForceDeleteVFolderActionResult:
# TODO: Implement proper permission checking and business logic
# For now, use admin repository for the operation
user = await self._user_repository.get_user_by_uuid(action.user_uuid)
if not user.domain_name:
raise VFolderInvalidParameter("User has no domain assigned")
vfolder_data = await self._vfolder_repository.get_by_id_validated(
action.vfolder_uuid, user.id, user.domain_name
)
await self._vfolder_repository.delete_vfolders_forever([action.vfolder_uuid])
await self._remove_vfolder_from_storage(vfolder_data)
return ForceDeleteVFolderActionResult(vfolder_uuid=action.vfolder_uuid)
async def clone(self, action: CloneVFolderAction) -> CloneVFolderActionResult:
allowed_vfolder_types = (
await self._config_provider.legacy_etcd_config_loader.get_vfolder_types()
)
if "user" not in allowed_vfolder_types:
raise VFolderInvalidParameter("user vfolder cannot be created in this host")
# Get requester user info
user_info = await self._vfolder_repository.get_user_info(action.requester_user_uuid)
if not user_info:
raise VFolderInvalidParameter("No such user.")
user_role, user_domain_name = user_info
# Get accessible vfolders to find the source folder
vfolder_list_result = await self._vfolder_repository.list_accessible_vfolders(
user_id=action.requester_user_uuid,
user_role=user_role,
domain_name=user_domain_name,
allowed_vfolder_types=list(allowed_vfolder_types),
extra_conditions=(VFolderRow.id == action.source_vfolder_uuid),
)
if not vfolder_list_result.vfolders:
raise VFolderInvalidParameter("No such vfolder.")
source_vfolder_access_info = vfolder_list_result.vfolders[0]
source_vfolder_data = source_vfolder_access_info.vfolder_data
# Check if the source vfolder is allowed to be cloned
if not source_vfolder_data.cloneable:
raise Forbidden("The source vfolder is not permitted to be cloned.")
if action.target_name.startswith("."):
for entry in vfolder_list_result.vfolders:
if entry.vfolder_data.name == action.target_name:
raise VFolderAlreadyExists
# Get target host
target_folder_host = (
action.target_host
or source_vfolder_data.host
or self._config_provider.config.volumes.default_host
)
if not target_folder_host:
raise VFolderInvalidParameter(
"You must specify the vfolder host because the default host is not configured."
)
# Verify target vfolder name
if not verify_vfolder_name(action.target_name):
raise VFolderInvalidParameter(
f"{action.target_name} is reserved for internal operations."
)
# Check for duplicate vfolder names
duplication_exists = await self._vfolder_repository.check_vfolder_name_exists(
action.target_name,
action.requester_user_uuid,
user_role,
user_domain_name,
list(allowed_vfolder_types),
)
if duplication_exists:
raise VFolderAlreadyExists(
f"VFolder with the given name already exists. ({action.target_name})"
)
allowed_vfolder_hosts = await self._vfolder_repository.get_allowed_vfolder_hosts(
action.requester_user_uuid, None
)
# Check host permissions using the user's actual resource policy
await self._vfolder_repository.ensure_host_permission_allowed(
target_folder_host,
permission=VFolderHostPermission.CREATE,
allowed_vfolder_types=allowed_vfolder_types,
user_uuid=action.requester_user_uuid,
resource_policy={"allowed_vfolder_hosts": allowed_vfolder_hosts},
domain_name=user_domain_name,
group_id=None,
)
max_vfolder_count = await self._vfolder_repository.get_max_vfolder_count(
action.requester_user_uuid, None
)
# Check resource policy's max_vfolder_count
if max_vfolder_count > 0:
current_count = await self._vfolder_repository.count_vfolders_by_user(
action.requester_user_uuid
)
if current_count >= max_vfolder_count:
raise VFolderInvalidParameter("You cannot create more vfolders.")
# Get user email for creator field
requester_email = await self._vfolder_repository.get_user_email_by_id(
action.requester_user_uuid
)
if not requester_email:
raise VFolderInvalidParameter("No such user.")
# Create source and target VFolderID
source_folder_id = VFolderID(source_vfolder_data.quota_scope_id, source_vfolder_data.id)
# Resolve target quota scope: use the provided one or default to requester's user scope
if action.target_quota_scope_id is not None:
target_quota_scope_id = action.target_quota_scope_id
# TODO: Support cloning to project quota scope.
# Project quota scopes exist and project vfolders can be cloned,
# but cloning *into* a project folder is not yet supported
# the clone result is always created as a user-owned vfolder
if target_quota_scope_id.scope_type != QuotaScopeType.USER:
raise VFolderInvalidParameter("Clone target must be a user quota scope.")
await self._vfolder_repository.validate_quota_scope_access(
target_quota_scope_id,
UserIdentity(
user_uuid=action.requester_user_uuid,
user_role=user_role,
user_email=requester_email,
domain_name=user_domain_name,
),
)
else:
target_quota_scope_id = QuotaScopeID(QuotaScopeType.USER, action.requester_user_uuid)
# Create VFolderCloneInfo for the cloning operation
vfolder_clone_info = VFolderCloneInfo(
source_vfolder_id=source_folder_id,
source_host=source_vfolder_data.host,
unmanaged_path=source_vfolder_data.unmanaged_path,
domain_name=user_domain_name,
target_quota_scope_id=target_quota_scope_id,
target_vfolder_name=action.target_name,
target_host=target_folder_host,
usage_mode=action.usage_mode,
permission=action.mount_permission,
email=requester_email,
user_id=action.requester_user_uuid,
cloneable=action.cloneable,
)
# Initiate the actual vfolder cloning process using repository
task_id, target_folder_id = await self._vfolder_repository.initiate_vfolder_clone(
vfolder_clone_info,
self._storage_manager,
self._background_task_manager,
)
# Return the information about the destination vfolder
return CloneVFolderActionResult(
vfolder_uuid=action.source_vfolder_uuid,
target_vfolder_id=target_folder_id,
target_vfolder_name=action.target_name,
target_vfolder_host=target_folder_host,
usage_mode=action.usage_mode,
mount_permission=action.mount_permission,
creator_email=requester_email,
ownership_type=VFolderOwnershipType.USER,
owner_user_uuid=action.requester_user_uuid,
owner_group_uuid=None,
cloneable=action.cloneable,
bgtask_id=task_id,
)
async def get_task_logs(self, action: GetTaskLogsAction) -> GetTaskLogsActionResult:
user_uuid = action.user_id
user_role = action.user_role
kernel_id_str = action.kernel_id.hex
# Get user info using repository
user_info = await self._vfolder_repository.get_user_info(user_uuid)
if not user_info:
raise UserNotFound(object_name="User")
user_role, user_domain_name = user_info
# Get the .logs vfolder using repository
log_vfolder_data = await self._vfolder_repository.get_logs_vfolder(
user_uuid, user_role, user_domain_name
)
if not log_vfolder_data:
raise VFolderNotFound(
extra_data={"vfolder_name": ".logs"},
)
proxy_name, volume_name = self._storage_manager.get_proxy_and_volume(
log_vfolder_data.host, is_unmanaged(log_vfolder_data.unmanaged_path)
)
response = web.StreamResponse(status=200)
response.headers[hdrs.CONTENT_TYPE] = "text/plain"
prepared = False
try:
vfid = str(VFolderID(log_vfolder_data.quota_scope_id, log_vfolder_data.id))
relpath = str(
PurePosixPath("task")
/ kernel_id_str[:2]
/ kernel_id_str[2:4]
/ f"{kernel_id_str[4:]}.log",
)
storage_proxy_client = self._storage_manager.get_manager_facing_client(proxy_name)
async for chunk in storage_proxy_client.fetch_file_content_streaming(
volume_name, vfid, relpath
):
if not prepared:
await response.prepare(action.request)
prepared = True
await response.write(chunk)
except aiohttp.ClientResponseError as e:
raise UnexpectedStorageProxyResponseError(status=e.status, extra_msg=e.message) from e
finally:
if prepared:
await response.write_eof()
return GetTaskLogsActionResult(response=response, vfolder_data=log_vfolder_data)
async def list_allowed_types(
self, action: ListAllowedTypesAction
) -> ListAllowedTypesActionResult:
allowed_vfolder_types = (
await self._config_provider.legacy_etcd_config_loader.get_vfolder_types()
)
return ListAllowedTypesActionResult(allowed_types=list(allowed_vfolder_types))
async def list_all_hosts(self, action: ListAllHostsAction) -> ListAllHostsActionResult:
all_volumes = await self._storage_manager.get_all_volumes()
all_hosts = {
f"{proxy_name}:{volume_data['name']}" for proxy_name, volume_data in all_volumes
}
default_host = self._config_provider.config.volumes.default_host
if default_host not in all_hosts:
default_host = None
return ListAllHostsActionResult(default=default_host, allowed=sorted(all_hosts))
async def get_volume_perf_metric(
self, action: GetVolumePerfMetricAction
) -> GetVolumePerfMetricActionResult:
proxy_name, volume_name = self._storage_manager.get_proxy_and_volume(action.folder_host)
manager_client = self._storage_manager.get_manager_facing_client(proxy_name)
storage_reply = await manager_client.get_volume_performance_metric(volume_name)
return GetVolumePerfMetricActionResult(data=dict(storage_reply))
async def get_usage(self, action: GetVFolderUsageAction) -> GetVFolderUsageActionResult:
proxy_name, volume_name = self._storage_manager.get_proxy_and_volume(
action.folder_host, is_unmanaged(action.unmanaged_path)
)
client = self._storage_manager.get_manager_facing_client(proxy_name)
usage = await client.get_folder_usage(volume_name, action.vfolder_id)
return GetVFolderUsageActionResult(data=dict(usage))
async def get_used_bytes(
self, action: GetVFolderUsedBytesAction
) -> GetVFolderUsedBytesActionResult:
proxy_name, volume_name = self._storage_manager.get_proxy_and_volume(
action.folder_host, is_unmanaged(action.unmanaged_path)
)
client = self._storage_manager.get_manager_facing_client(proxy_name)
usage = await client.get_used_bytes(volume_name, action.vfolder_id)
return GetVFolderUsedBytesActionResult(data=dict(usage))
async def list_hosts(self, action: ListHostsAction) -> ListHostsActionResult:
allowed_vfolder_types = (
await self._config_provider.legacy_etcd_config_loader.get_vfolder_types()
)
allowed_hosts = await self._vfolder_repository.get_allowed_hosts_for_listing(
user_uuid=action.user_uuid,
domain_name=action.domain_name,
group_id=action.group_id,
resource_policy=action.resource_policy,
allowed_vfolder_types=list(allowed_vfolder_types),
)
all_volumes = await self._storage_manager.get_all_volumes()
all_hosts = {
f"{proxy_name}:{volume_data['name']}" for proxy_name, volume_data in all_volumes
}
allowed_hosts = VFolderHostPermissionMap({
host: perms for host, perms in allowed_hosts.items() if host in all_hosts
})
default_host = self._config_provider.config.volumes.default_host
if default_host not in allowed_hosts:
default_host = None
volumes = [
(proxy_name, volume_data)
for proxy_name, volume_data in all_volumes
if f"{proxy_name}:{volume_data['name']}" in allowed_hosts
]
fetch_volume_tasks = [
self._fetch_exposed_volume_fields(proxy_name, volume_data["name"])
for proxy_name, volume_data in volumes
]
get_sftp_tasks = [
self._storage_manager.get_sftp_scaling_groups(proxy_name)
for proxy_name, volume_data in volumes
]
fetch_results, sftp_results = await asyncio.gather(
asyncio.gather(*fetch_volume_tasks),
asyncio.gather(*get_sftp_tasks),
)
volume_info: dict[str, Any] = {}
for (proxy_name, volume_data), usage, sftp_scaling_groups in zip(
volumes,
fetch_results,
sftp_results,
strict=True,
):
host_key = f"{proxy_name}:{volume_data['name']}"
volume_info[host_key] = {