Implement shared ID for public links and shares

Author: jessegeens

share/model.go

@@ -30,33 +30,55 @@ func (i ItemType) String() string {
 	return string(i)
 }
 
+// ShareID only contains IDs of shares and public links. This is because OCIS requires
+// that shares and public links do not share an ID, so we need a shared table to make sure
+// that there are no duplicates.
+// This is implemented by having ShareID have an ID that is auto-increment, and shares and
+// public links will have their ID be a foreign key to ShareID
+// When creating a new share, we will then first create an ID entry and use this for the ID
+
+type ShareID struct {
+	ID uint `gorm:"primarykey"`
+}
+
+// We cannot use gorm.Model, because we want our ID to be a foreign key to ShareID
+type BaseModel struct {
+	// Id has to be called Id and not ID, otherwise the foreign key will not work
+	// ID is a special field in GORM, which it uses as the default Primary Key
+	Id        uint    `gorm:"uniqueIndex"`
+	ShareId   ShareID `gorm:"foreignKey:Id;references:ID;constraint:OnDelete:CASCADE"` //;references:ID
+	CreatedAt time.Time
+	UpdatedAt time.Time
+	DeletedAt gorm.DeletedAt `gorm:"index"`
+}
+
 // ProtoShare contains fields that are shared between PublicLinks and Shares.
 // Unfortunately, because these are shared, we cannot name our indexes
 // because then two indexes with the same name would be created
 type ProtoShare struct {
 	// Including gorm.Model will embed a number of gorm-default fields
-	gorm.Model
+	BaseModel
 	UIDOwner     string   `gorm:"size:64"`
 	UIDInitiator string   `gorm:"size:64"`
 	ItemType     ItemType `gorm:"size:16;index:"` // file | folder | reference | symlink
 	InitialPath  string
-	Inode        string `gorm:"size:32;index:"`
-	Instance     string `gorm:"size:32;index:"`
+	Inode        string `gorm:"primaryKey;size:32;index:"`
+	Instance     string `gorm:"primaryKey;size:32;index:"`
 	Permissions  uint8
 	Orphan       bool
 	Expiration   datatypes.NullTime
 }
 
 type Share struct {
 	ProtoShare
-	ShareWith         string `gorm:"size:255;index:i_share_with"` // 255 because this can be a lw account, which are mapped from email addresses / ...
+	ShareWith         string `gorm:"primaryKey;size:255;index:i_share_with"` // 255 because this can be a lw account, which are mapped from email addresses / ...
 	SharedWithIsGroup bool
 	Description       string `gorm:"size:1024"`
 }
 
 type PublicLink struct {
 	ProtoShare
-	Token string `gorm:"index:i_token"`
+	Token string `gorm:"primaryKey;index:i_token"`
 	// Enforce uniqueness in db re: Itemsource
 	Quicklink                    bool
 	NotifyUploads                bool
@@ -68,8 +90,8 @@ type PublicLink struct {
 
 type ShareState struct {
 	gorm.Model
-	ShareID uint  `gorm:"foreignKey:ShareID;references:ID;uniqueIndex:i_shareid_user"` // Define the foreign key field
-	Share   Share // Define the association
+	ShareID uint  `gorm:"uniqueIndex:i_shareid_user"`       // Define the foreign key field
+	Share   Share `gorm:"foreignKey:ShareID;references:Id"` // Define the association
 	// Can not be uid because of lw accs
 	User   string `gorm:"uniqueIndex:i_shareid_user;size:255"`
 	Synced bool
@@ -86,7 +108,7 @@ func (s *Share) AsCS3Share(granteeType userpb.UserType) *collaboration.Share {
 	}
 	return &collaboration.Share{
 		Id: &collaboration.ShareId{
-			OpaqueId: strconv.FormatUint(uint64(s.ID), 10),
+			OpaqueId: strconv.FormatUint(uint64(s.Id), 10),
 		},
 		//ResourceId:  &provider.Reference{StorageId: s.Prefix, NodeId: s.ItemSource},
 		ResourceId: &provider.ResourceId{
@@ -139,7 +161,7 @@ func (p *PublicLink) AsCS3PublicShare() *link.PublicShare {
 	}
 	return &link.PublicShare{
 		Id: &link.PublicShareId{
-			OpaqueId: strconv.Itoa(int(p.ID)),
+			OpaqueId: strconv.Itoa(int(p.Id)),
 		},
 		ResourceId: &provider.ResourceId{
 			StorageId: p.Instance,

share/sql/common.go

@@ -3,6 +3,7 @@ package sql
 import (
 	"fmt"
 
+	model "github.com/cernbox/reva-plugins/share"
 	"github.com/cs3org/reva"
 	"gorm.io/driver/mysql"
 	"gorm.io/driver/sqlite"
@@ -33,14 +34,28 @@ func init() {
 }
 
 func getDb(c config) (*gorm.DB, error) {
+	gormCfg := &gorm.Config{
+		DisableForeignKeyConstraintWhenMigrating: false,
+	}
 	switch c.Engine {
 	case "sqlite":
-		return gorm.Open(sqlite.Open(c.DBName), &gorm.Config{})
+		return gorm.Open(sqlite.Open(c.DBName), gormCfg)
 	case "mysql":
 		dsn := fmt.Sprintf("%s:%s@tcp(%s:%d)/%s?parseTime=true", c.DBUsername, c.DBPassword, c.DBHost, c.DBPort, c.DBName)
-		return gorm.Open(mysql.Open(dsn), &gorm.Config{})
+		return gorm.Open(mysql.Open(dsn), gormCfg)
 	default: // default is mysql
 		dsn := fmt.Sprintf("%s:%s@tcp(%s:%d)/%s?parseTime=true", c.DBUsername, c.DBPassword, c.DBHost, c.DBPort, c.DBName)
-		return gorm.Open(mysql.Open(dsn), &gorm.Config{})
+		return gorm.Open(mysql.Open(dsn), gormCfg)
+	}
+}
+
+func createID(db *gorm.DB) (uint, error) {
+	id := &model.ShareID{}
+
+	res := db.Create(&id)
+	if res.Error != nil {
+		return 0, res.Error
+	} else {
+		return id.ID, nil
 	}
 }

share/sql/public_link.go

@@ -106,6 +106,17 @@ func (m *publicShareMgr) CreatePublicShare(ctx context.Context, u *user.User, md
 		NotifyUploadsExtraRecipients: notifyUploadsExtraRecipients,
 	}
 
+	// Create Shared ID
+	id, err := createID(m.db)
+	if err != nil {
+		return nil, errors.Wrap(err, "failed to create id for PublicShare")
+	}
+
+	publiclink.BaseModel = model.BaseModel{
+		Id:      id,
+		ShareId: model.ShareID{ID: id},
+	}
+
 	publiclink.UIDOwner = conversions.FormatUserID(md.Owner)
 	publiclink.UIDInitiator = conversions.FormatUserID(user.Id)
 	publiclink.InitialPath = md.Path
@@ -375,8 +386,8 @@ func emptyLinkWithId(id string) (*model.PublicLink, error) {
 	}
 	share := &model.PublicLink{
 		ProtoShare: model.ProtoShare{
-			Model: gorm.Model{
-				ID: uint(intId),
+			BaseModel: model.BaseModel{
+				Id: uint(intId),
 			},
 		},
 	}

share/sql/share.go

@@ -75,12 +75,20 @@ func NewShareManager(ctx context.Context, m map[string]interface{}) (revashare.M
 	}
 
 	// Migrate schemas
-	err = db.AutoMigrate(&model.Share{}, &model.ShareState{})
-
+	err = db.AutoMigrate(&model.ShareID{}, &model.Share{}, &model.ShareState{})
 	if err != nil {
 		return nil, err
 	}
 
+	// err = db.Migrator().CreateConstraint(&model.ShareID{}, "ID")
+	// if err != nil {
+	// 	return nil, err
+	// }
+	// err = db.Migrator().CreateConstraint(&model.Share{}, "fk_shares_share_ids")
+	// if err != nil {
+	// 	return nil, err
+	// }
+
 	mgr := &shareMgr{
 		c:  &c,
 		db: db,
@@ -125,6 +133,18 @@ func (m *shareMgr) Share(ctx context.Context, md *provider.ResourceInfo, g *coll
 		ShareWith:         shareWith,
 		SharedWithIsGroup: g.Grantee.Type == provider.GranteeType_GRANTEE_TYPE_GROUP,
 	}
+
+	// Create Shared ID
+	id, err := createID(m.db)
+	if err != nil {
+		return nil, errors.Wrap(err, "failed to create id for PublicShare")
+	}
+
+	share.BaseModel = model.BaseModel{
+		Id:      id,
+		ShareId: model.ShareID{ID: id},
+	}
+
 	share.UIDOwner = conversions.FormatUserID(md.Owner)
 	share.UIDInitiator = conversions.FormatUserID(user.Id)
 	share.InitialPath = md.Path
@@ -390,7 +410,7 @@ func (m *shareMgr) ListReceivedShares(ctx context.Context, filters []*collaborat
 func (m *shareMgr) getShareState(ctx context.Context, share *model.Share, user *userpb.User) (*model.ShareState, error) {
 	var shareState model.ShareState
 	query := m.db.Model(&shareState).
-		Where("share_id = ?", share.ID).
+		Where("share_id = ?", share.Id).
 		Where("user = ?", user.Username)
 
 	res := query.First(&shareState)
@@ -415,8 +435,8 @@ func emptyShareWithId(id string) (*model.Share, error) {
 	}
 	share := &model.Share{
 		ProtoShare: model.ProtoShare{
-			Model: gorm.Model{
-				ID: uint(intId),
+			BaseModel: model.BaseModel{
+				Id: uint(intId),
 			},
 		},
 	}