Refactoring of the GORM model for shares

Author: glpatcern

changelog/unreleased/ocm-model-refactor.md

@@ -0,0 +1,16 @@
+Enhancement: refactoring of the GORM model for shares
+
+With this PR we introduce new constraints and rename
+some fields for better consistency:
+
+* Types used by OCM structures only are prefixed with
+  `Ocm`, and `AccessMethod` and `Protocol` were
+  consolidated into `OcmProtocol`
+* ItemType is used in OCM shares as well
+* Unique indexes have been created for all shares
+* The `(FileIdPrefix, ItemSource)` tuple is now
+  `(StorageId, FileId)` in `OcmShare`, and it was
+  removed from `OcmReceivedShare` as unused
+
+https://github.com/cs3org/reva/pull/5402
+

pkg/share/manager/sql/conversions.go

@@ -32,35 +32,35 @@ import (
 	model "github.com/cs3org/reva/v3/pkg/share/manager/sql/model"
 )
 
-func convertFromCS3OCMShareType(shareType ocm.ShareType) model.ShareType {
+func convertFromCS3OCMShareType(shareType ocm.ShareType) model.OcmShareType {
 	switch shareType {
 	case ocm.ShareType_SHARE_TYPE_USER:
-		return model.ShareTypeUser
+		return model.OcmShareTypeUser
 	case ocm.ShareType_SHARE_TYPE_GROUP:
-		return model.ShareTypeGroup
+		return model.OcmShareTypeGroup
 	}
 	return -1
 }
 
 func convertFromCS3OCMShareState(shareState ocm.ShareState) model.OcmShareState {
 	switch shareState {
 	case ocm.ShareState_SHARE_STATE_ACCEPTED:
-		return model.ShareStateAccepted
+		return model.OcmShareStateAccepted
 	case ocm.ShareState_SHARE_STATE_PENDING:
-		return model.ShareStatePending
+		return model.OcmShareStatePending
 	case ocm.ShareState_SHARE_STATE_REJECTED:
-		return model.ShareStateRejected
+		return model.OcmShareStateRejected
 	}
 	return -1
 }
 
 func convertToCS3OCMShareState(state model.OcmShareState) ocm.ShareState {
 	switch state {
-	case model.ShareStateAccepted:
+	case model.OcmShareStateAccepted:
 		return ocm.ShareState_SHARE_STATE_ACCEPTED
-	case model.ShareStatePending:
+	case model.OcmShareStatePending:
 		return ocm.ShareState_SHARE_STATE_PENDING
-	case model.ShareStateRejected:
+	case model.OcmShareStateRejected:
 		return ocm.ShareState_SHARE_STATE_REJECTED
 	}
 	return ocm.ShareState_SHARE_STATE_INVALID
@@ -73,8 +73,8 @@ func convertToCS3OCMShare(s *model.OcmShare, am []*ocm.AccessMethod) *ocm.Share
 			OpaqueId: strconv.Itoa(int(s.Id)),
 		},
 		ResourceId: &provider.ResourceId{
-			StorageId: s.FileidPrefix,
-			OpaqueId:  s.ItemSource,
+			StorageId: s.StorageId,
+			OpaqueId:  s.FileId,
 		},
 		Name:  s.Name,
 		Token: s.Token,
@@ -161,15 +161,15 @@ func viewModeToInt(v appprovider.ViewMode) int {
 	return -1
 }
 
-func convertToCS3AccessMethod(m *model.OcmSharesAccessMethod) *ocm.AccessMethod {
+func convertToCS3AccessMethod(m *model.OcmShareProtocol) *ocm.AccessMethod {
 	switch m.Type {
-	case model.WebDAVAccessMethod:
+	case model.WebDAVProtocol:
 		return share.NewWebDavAccessMethod(
 			conversions.RoleFromOCSPermissions(conversions.Permissions(m.Permissions)).CS3ResourcePermissions(),
 			[]string{}) // TODO persist requirements
-	case model.WebappAccessMethod:
+	case model.WebappProtocol:
 		return share.NewWebappAccessMethod(appprovider.ViewMode(m.Permissions))
-	case model.TransferAccessMethod:
+	case model.TransferProtocol:
 		return share.NewTransferAccessMethod()
 	}
 	return nil
@@ -189,22 +189,22 @@ func convertToCS3Protocol(p *model.OcmReceivedShareProtocol) *ocm.Protocol {
 	return nil
 }
 
-func convertToCS3ResourceType(t model.OcmItemType) provider.ResourceType {
+func convertToCS3ResourceType(t model.ItemType) provider.ResourceType {
 	switch t {
-	case model.OcmItemTypeFile:
+	case model.ItemTypeFile:
 		return provider.ResourceType_RESOURCE_TYPE_FILE
-	case model.OcmItemTypeFolder:
+	case model.ItemTypeFolder:
 		return provider.ResourceType_RESOURCE_TYPE_CONTAINER
 	}
 	return provider.ResourceType_RESOURCE_TYPE_INVALID
 }
 
-func convertFromCS3ResourceType(t provider.ResourceType) model.OcmItemType {
+func convertFromCS3ResourceType(t provider.ResourceType) model.ItemType {
 	switch t {
 	case provider.ResourceType_RESOURCE_TYPE_FILE:
-		return model.OcmItemTypeFile
+		return model.ItemTypeFile
 	case provider.ResourceType_RESOURCE_TYPE_CONTAINER:
-		return model.OcmItemTypeFolder
+		return model.ItemTypeFolder
 	}
-	return -1
+	return model.ItemTypeFile
 }