Merge pull request #9253 from owncloud/collaboration_multiple_fileinfo

feat: explicit provider for WOPI apps to handle fileinfo
This commit is contained in:
Michael Barz
2024-06-24 11:28:08 +02:00
committed by GitHub
15 changed files with 817 additions and 330 deletions
+1 -1
View File
@@ -162,7 +162,7 @@ type WopiApp struct {
}
type Collaboration struct {
WopiApp WopiApp `yaml:"wopiapp"`
WopiApp WopiApp `yaml:"wopi"`
}
type Nats struct {
@@ -5,8 +5,7 @@ package mocks
import (
context "context"
connector "github.com/owncloud/ocis/v2/services/collaboration/pkg/connector"
fileinfo "github.com/owncloud/ocis/v2/services/collaboration/pkg/connector/fileinfo"
mock "github.com/stretchr/testify/mock"
)
@@ -24,22 +23,24 @@ func (_m *FileConnectorService) EXPECT() *FileConnectorService_Expecter {
}
// CheckFileInfo provides a mock function with given fields: ctx
func (_m *FileConnectorService) CheckFileInfo(ctx context.Context) (connector.FileInfo, error) {
func (_m *FileConnectorService) CheckFileInfo(ctx context.Context) (fileinfo.FileInfo, error) {
ret := _m.Called(ctx)
if len(ret) == 0 {
panic("no return value specified for CheckFileInfo")
}
var r0 connector.FileInfo
var r0 fileinfo.FileInfo
var r1 error
if rf, ok := ret.Get(0).(func(context.Context) (connector.FileInfo, error)); ok {
if rf, ok := ret.Get(0).(func(context.Context) (fileinfo.FileInfo, error)); ok {
return rf(ctx)
}
if rf, ok := ret.Get(0).(func(context.Context) connector.FileInfo); ok {
if rf, ok := ret.Get(0).(func(context.Context) fileinfo.FileInfo); ok {
r0 = rf(ctx)
} else {
r0 = ret.Get(0).(connector.FileInfo)
if ret.Get(0) != nil {
r0 = ret.Get(0).(fileinfo.FileInfo)
}
}
if rf, ok := ret.Get(1).(func(context.Context) error); ok {
@@ -69,12 +70,12 @@ func (_c *FileConnectorService_CheckFileInfo_Call) Run(run func(ctx context.Cont
return _c
}
func (_c *FileConnectorService_CheckFileInfo_Call) Return(_a0 connector.FileInfo, _a1 error) *FileConnectorService_CheckFileInfo_Call {
func (_c *FileConnectorService_CheckFileInfo_Call) Return(_a0 fileinfo.FileInfo, _a1 error) *FileConnectorService_CheckFileInfo_Call {
_c.Call.Return(_a0, _a1)
return _c
}
func (_c *FileConnectorService_CheckFileInfo_Call) RunAndReturn(run func(context.Context) (connector.FileInfo, error)) *FileConnectorService_CheckFileInfo_Call {
func (_c *FileConnectorService_CheckFileInfo_Call) RunAndReturn(run func(context.Context) (fileinfo.FileInfo, error)) *FileConnectorService_CheckFileInfo_Call {
_c.Call.Return(run)
return _c
}
@@ -24,14 +24,14 @@ func Version(cfg *config.Config) *cli.Command {
fmt.Println("")
reg := registry.GetRegistry()
services, err := reg.GetService(cfg.HTTP.Namespace + "." + cfg.Service.Name)
services, err := reg.GetService(cfg.HTTP.Namespace + "." + cfg.Service.Name + "." + cfg.App.Name)
if err != nil {
fmt.Println(fmt.Errorf("could not get %s services from the registry: %v", cfg.Service.Name, err))
fmt.Println(fmt.Errorf("could not get %s services from the registry: %v", cfg.Service.Name+"."+cfg.App.Name, err))
return err
}
if len(services) == 0 {
fmt.Println("No running " + cfg.Service.Name + " service found.")
fmt.Println("No running " + cfg.Service.Name + "." + cfg.App.Name + " service found.")
return nil
}
+1 -1
View File
@@ -2,7 +2,7 @@ package config
// App defines the available app configuration.
type App struct {
Name string `yaml:"name" env:"COLLABORATION_APP_NAME" desc:"The name of the app" introductionVersion:"6.0.0"`
Name string `yaml:"name" env:"COLLABORATION_APP_NAME" desc:"The name of the app, either Collabora, OnlyOffice or Microsoft365" introductionVersion:"6.0.0"`
Description string `yaml:"description" env:"COLLABORATION_APP_DESCRIPTION" desc:"App description" introductionVersion:"6.0.0"`
Icon string `yaml:"icon" env:"COLLABORATION_APP_ICON" desc:"Icon for the app" introductionVersion:"6.0.0"`
LockName string `yaml:"lockname" env:"COLLABORATION_APP_LOCKNAME" desc:"Name for the app lock" introductionVersion:"6.0.0"`
@@ -17,6 +17,7 @@ import (
"github.com/cs3org/reva/v2/pkg/utils"
"github.com/google/uuid"
"github.com/owncloud/ocis/v2/services/collaboration/pkg/config"
"github.com/owncloud/ocis/v2/services/collaboration/pkg/connector/fileinfo"
"github.com/owncloud/ocis/v2/services/collaboration/pkg/middleware"
"github.com/rs/zerolog"
)
@@ -50,7 +51,7 @@ type FileConnectorService interface {
// The current lockID will be returned if a conflict happens
UnLock(ctx context.Context, lockID string) (string, error)
// CheckFileInfo will return the file information of the target file
CheckFileInfo(ctx context.Context) (FileInfo, error)
CheckFileInfo(ctx context.Context) (fileinfo.FileInfo, error)
}
// FileConnector implements the "File" endpoint.
@@ -160,7 +161,7 @@ func (f *FileConnector) Lock(ctx context.Context, lockID, oldLockID string) (str
Ref: &wopiContext.FileReference,
Lock: &providerv1beta1.Lock{
LockId: lockID,
AppName: f.cfg.App.LockName,
AppName: f.cfg.App.LockName + "." + f.cfg.App.Name,
Type: providerv1beta1.LockType_LOCK_TYPE_WRITE,
Expiration: &typesv1beta1.Timestamp{
Seconds: uint64(time.Now().Add(lockDuration).Unix()),
@@ -181,7 +182,7 @@ func (f *FileConnector) Lock(ctx context.Context, lockID, oldLockID string) (str
Ref: &wopiContext.FileReference,
Lock: &providerv1beta1.Lock{
LockId: lockID,
AppName: f.cfg.App.LockName,
AppName: f.cfg.App.LockName + "." + f.cfg.App.Name,
Type: providerv1beta1.LockType_LOCK_TYPE_WRITE,
Expiration: &typesv1beta1.Timestamp{
Seconds: uint64(time.Now().Add(lockDuration).Unix()),
@@ -294,7 +295,7 @@ func (f *FileConnector) RefreshLock(ctx context.Context, lockID string) (string,
Ref: &wopiContext.FileReference,
Lock: &providerv1beta1.Lock{
LockId: lockID,
AppName: f.cfg.App.LockName,
AppName: f.cfg.App.LockName + "." + f.cfg.App.Name,
Type: providerv1beta1.LockType_LOCK_TYPE_WRITE,
Expiration: &typesv1beta1.Timestamp{
Seconds: uint64(time.Now().Add(lockDuration).Unix()),
@@ -402,7 +403,7 @@ func (f *FileConnector) UnLock(ctx context.Context, lockID string) (string, erro
Ref: &wopiContext.FileReference,
Lock: &providerv1beta1.Lock{
LockId: lockID,
AppName: f.cfg.App.LockName,
AppName: f.cfg.App.LockName + "." + f.cfg.App.Name,
},
}
@@ -475,10 +476,10 @@ func (f *FileConnector) UnLock(ctx context.Context, lockID string) (string, erro
//
// If the operation is successful, a "FileInfo" instance will be returned,
// otherwise the "FileInfo" will be empty and an error will be returned.
func (f *FileConnector) CheckFileInfo(ctx context.Context) (FileInfo, error) {
func (f *FileConnector) CheckFileInfo(ctx context.Context) (fileinfo.FileInfo, error) {
wopiContext, err := middleware.WopiContextFromCtx(ctx)
if err != nil {
return FileInfo{}, err
return nil, err
}
logger := zerolog.Ctx(ctx)
@@ -488,7 +489,7 @@ func (f *FileConnector) CheckFileInfo(ctx context.Context) (FileInfo, error) {
})
if err != nil {
logger.Error().Err(err).Msg("CheckFileInfo: stat failed")
return FileInfo{}, err
return nil, err
}
if statRes.GetStatus().GetCode() != rpcv1beta1.Code_CODE_OK {
@@ -496,76 +497,90 @@ func (f *FileConnector) CheckFileInfo(ctx context.Context) (FileInfo, error) {
Str("StatusCode", statRes.GetStatus().GetCode().String()).
Str("StatusMsg", statRes.GetStatus().GetMessage()).
Msg("CheckFileInfo: stat failed with unexpected status")
return FileInfo{}, NewConnectorError(500, statRes.GetStatus().GetCode().String()+" "+statRes.GetStatus().GetMessage())
return nil, NewConnectorError(500, statRes.GetStatus().GetCode().String()+" "+statRes.GetStatus().GetMessage())
}
fileInfo := FileInfo{
// OwnerId must use only alphanumeric chars (https://learn.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/rest/files/checkfileinfo/checkfileinfo-response#requirements-for-user-identity-properties)
OwnerId: hex.EncodeToString([]byte(statRes.GetInfo().GetOwner().GetOpaqueId() + "@" + statRes.GetInfo().GetOwner().GetIdp())),
Size: int64(statRes.GetInfo().GetSize()),
Version: strconv.FormatUint(statRes.GetInfo().GetMtime().GetSeconds(), 10) + "." + strconv.FormatUint(uint64(statRes.GetInfo().GetMtime().GetNanos()), 10),
BaseFileName: path.Base(statRes.GetInfo().GetPath()),
BreadcrumbDocName: path.Base(statRes.GetInfo().GetPath()),
// If a not known app name is used, consider "Microsoft" as default.
// This will help with the CI because we're using a "FakeOffice" app
// for the wopi validator, which requires a Microsoft fileinfo
var info fileinfo.FileInfo
switch strings.ToLower(f.cfg.App.Name) {
case "collabora":
info = &fileinfo.Collabora{}
case "onlyoffice":
info = &fileinfo.OnlyOffice{}
default:
info = &fileinfo.Microsoft{}
}
hexEncodedOwnerId := hex.EncodeToString([]byte(statRes.GetInfo().GetOwner().GetOpaqueId() + "@" + statRes.GetInfo().GetOwner().GetIdp()))
version := strconv.FormatUint(statRes.GetInfo().GetMtime().GetSeconds(), 10) + "." + strconv.FormatUint(uint64(statRes.GetInfo().GetMtime().GetNanos()), 10)
// UserId must use only alphanumeric chars (https://learn.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/rest/files/checkfileinfo/checkfileinfo-response#requirements-for-user-identity-properties)
// assign userId, userFriendlyName and isAnonymousUser
// assume we don't have a wopiContext.User
randomID, _ := uuid.NewUUID()
userId := hex.EncodeToString([]byte("guest-" + randomID.String()))
userFriendlyName := "Guest " + randomID.String()
isAnonymousUser := true
isPublicShare := false
if wopiContext.User != nil {
// if we have a wopiContext.User
isPublicShare = utils.ExistsInOpaque(wopiContext.User.GetOpaque(), "public-share-role")
if !isPublicShare {
hexEncodedWopiUserId := hex.EncodeToString([]byte(wopiContext.User.GetId().GetOpaqueId() + "@" + wopiContext.User.GetId().GetIdp()))
isAnonymousUser = false
userFriendlyName = wopiContext.User.GetDisplayName()
userId = hexEncodedWopiUserId
}
}
// fileinfo map
infoMap := map[string]interface{}{
fileinfo.KeyOwnerID: hexEncodedOwnerId,
fileinfo.KeySize: int64(statRes.GetInfo().GetSize()),
fileinfo.KeyVersion: version,
fileinfo.KeyBaseFileName: path.Base(statRes.GetInfo().GetPath()),
fileinfo.KeyBreadcrumbDocName: path.Base(statRes.GetInfo().GetPath()),
// to get the folder we actually need to do a GetPath() request
//BreadcrumbFolderName: path.Dir(statRes.Info.Path),
UserCanNotWriteRelative: true,
fileinfo.KeyHostViewURL: wopiContext.ViewAppUrl,
fileinfo.KeyHostEditURL: wopiContext.EditAppUrl,
HostViewUrl: wopiContext.ViewAppUrl,
HostEditUrl: wopiContext.EditAppUrl,
fileinfo.KeyEnableOwnerTermination: true, // only for collabora
fileinfo.KeySupportsExtendedLockLength: true,
fileinfo.KeySupportsGetLock: true,
fileinfo.KeySupportsLocks: true,
fileinfo.KeySupportsUpdate: true,
//EnableOwnerTermination: true, // enable only for collabora? wopivalidator is complaining
EnableOwnerTermination: false,
SupportsExtendedLockLength: true,
SupportsGetLock: true,
SupportsLocks: true,
}
// user logic from reva wopi driver #TODO: refactor
var isPublicShare bool = false
if wopiContext.User != nil {
// UserId must use only alphanumeric chars (https://learn.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/rest/files/checkfileinfo/checkfileinfo-response#requirements-for-user-identity-properties)
if wopiContext.User.GetId().GetType() == userv1beta1.UserType_USER_TYPE_LIGHTWEIGHT {
fileInfo.UserId = hex.EncodeToString([]byte(statRes.GetInfo().GetOwner().GetOpaqueId() + "@" + statRes.GetInfo().GetOwner().GetIdp()))
} else {
fileInfo.UserId = hex.EncodeToString([]byte(wopiContext.User.GetId().GetOpaqueId() + "@" + wopiContext.User.GetId().GetIdp()))
}
isPublicShare = utils.ExistsInOpaque(wopiContext.User.GetOpaque(), "public-share-role")
if !isPublicShare {
fileInfo.UserFriendlyName = wopiContext.User.GetDisplayName()
fileInfo.UserId = hex.EncodeToString([]byte(wopiContext.User.GetId().GetOpaqueId() + "@" + wopiContext.User.GetId().GetIdp()))
}
}
if wopiContext.User == nil || isPublicShare {
randomID, _ := uuid.NewUUID()
fileInfo.UserId = hex.EncodeToString([]byte("guest-" + randomID.String()))
fileInfo.UserFriendlyName = "Guest " + randomID.String()
fileInfo.IsAnonymousUser = true
fileinfo.KeyUserCanNotWriteRelative: true,
fileinfo.KeyIsAnonymousUser: isAnonymousUser,
fileinfo.KeyUserFriendlyName: userFriendlyName,
fileinfo.KeyUserID: userId,
}
switch wopiContext.ViewMode {
case appproviderv1beta1.ViewMode_VIEW_MODE_READ_WRITE:
fileInfo.SupportsUpdate = true
fileInfo.UserCanWrite = true
infoMap[fileinfo.KeyUserCanWrite] = true
case appproviderv1beta1.ViewMode_VIEW_MODE_READ_ONLY:
// nothing special to do here for now
case appproviderv1beta1.ViewMode_VIEW_MODE_VIEW_ONLY:
fileInfo.DisableExport = true
fileInfo.DisableCopy = true
fileInfo.DisablePrint = true
infoMap[fileinfo.KeyDisableExport] = true // only for collabora
infoMap[fileinfo.KeyDisableCopy] = true // only for collabora
infoMap[fileinfo.KeyDisablePrint] = true
if !isPublicShare {
// the fileInfo.WatermarkText supported by Collabora only
fileInfo.WatermarkText = f.watermarkText(wopiContext.User)
infoMap[fileinfo.KeyWatermarkText] = f.watermarkText(wopiContext.User) // only for collabora
}
}
info.SetProperties(infoMap)
logger.Debug().Msg("CheckFileInfo: success")
return fileInfo, nil
return info, nil
}
func (f *FileConnector) watermarkText(user *userv1beta1.User) string {
@@ -15,6 +15,7 @@ import (
. "github.com/onsi/gomega"
"github.com/owncloud/ocis/v2/services/collaboration/pkg/config"
"github.com/owncloud/ocis/v2/services/collaboration/pkg/connector"
"github.com/owncloud/ocis/v2/services/collaboration/pkg/connector/fileinfo"
"github.com/owncloud/ocis/v2/services/collaboration/pkg/middleware"
"github.com/stretchr/testify/mock"
)
@@ -732,7 +733,7 @@ var _ = Describe("FileConnector", func() {
ctx := context.Background()
newFileInfo, err := fc.CheckFileInfo(ctx)
Expect(err).To(HaveOccurred())
Expect(newFileInfo).To(Equal(connector.FileInfo{}))
Expect(newFileInfo).To(BeNil())
})
It("Stat fails", func() {
@@ -746,7 +747,7 @@ var _ = Describe("FileConnector", func() {
newFileInfo, err := fc.CheckFileInfo(ctx)
Expect(err).To(HaveOccurred())
Expect(err).To(Equal(targetErr))
Expect(newFileInfo).To(Equal(connector.FileInfo{}))
Expect(newFileInfo).To(BeNil())
})
It("Stat fails status not ok", func() {
@@ -760,7 +761,7 @@ var _ = Describe("FileConnector", func() {
Expect(err).To(HaveOccurred())
conErr := err.(*connector.ConnectorError)
Expect(conErr.HttpCodeOut).To(Equal(500))
Expect(newFileInfo).To(Equal(connector.FileInfo{}))
Expect(newFileInfo).To(BeNil())
})
It("Stat success", func() {
@@ -783,28 +784,27 @@ var _ = Describe("FileConnector", func() {
},
}, nil)
expectedFileInfo := connector.FileInfo{
OwnerId: "61616262636340637573746f6d496470", // hex of aabbcc@customIdp
expectedFileInfo := &fileinfo.Microsoft{
OwnerID: "61616262636340637573746f6d496470", // hex of aabbcc@customIdp
Size: int64(998877),
Version: "16273849.0",
BaseFileName: "test.txt",
BreadcrumbDocName: "test.txt",
UserCanNotWriteRelative: true,
HostViewUrl: "http://test.ex.prv/view",
HostEditUrl: "http://test.ex.prv/edit",
EnableOwnerTermination: false,
HostViewURL: "http://test.ex.prv/view",
HostEditURL: "http://test.ex.prv/edit",
SupportsExtendedLockLength: true,
SupportsGetLock: true,
SupportsLocks: true,
SupportsUpdate: true,
UserCanWrite: true,
UserId: "6f7061717565496440696e6d656d6f7279", // hex of opaqueId@inmemory
UserID: "6f7061717565496440696e6d656d6f7279", // hex of opaqueId@inmemory
UserFriendlyName: "Pet Shaft",
}
newFileInfo, err := fc.CheckFileInfo(ctx)
Expect(err).To(Succeed())
Expect(newFileInfo).To(Equal(expectedFileInfo))
Expect(newFileInfo.(*fileinfo.Microsoft)).To(Equal(expectedFileInfo))
})
It("Stat success guests", func() {
@@ -839,39 +839,36 @@ var _ = Describe("FileConnector", func() {
},
}, nil)
expectedFileInfo := connector.FileInfo{
OwnerId: "61616262636340637573746f6d496470", // hex of aabbcc@customIdp
Size: int64(998877),
Version: "16273849.0",
BaseFileName: "test.txt",
BreadcrumbDocName: "test.txt",
UserCanNotWriteRelative: true,
HostViewUrl: "http://test.ex.prv/view",
HostEditUrl: "http://test.ex.prv/edit",
EnableOwnerTermination: false,
SupportsExtendedLockLength: true,
SupportsGetLock: true,
SupportsLocks: true,
DisableExport: true,
DisableCopy: true,
DisablePrint: true,
IsAnonymousUser: true,
UserId: "guest-zzz000",
UserFriendlyName: "guest zzz000",
// change wopi app provider
cfg.App.Name = "Collabora"
expectedFileInfo := &fileinfo.Collabora{
OwnerID: "61616262636340637573746f6d496470", // hex of aabbcc@customIdp
Size: int64(998877),
BaseFileName: "test.txt",
UserCanNotWriteRelative: true,
DisableExport: true,
DisableCopy: true,
DisablePrint: true,
UserID: "guest-zzz000",
UserFriendlyName: "guest zzz000",
EnableOwnerTermination: true,
SupportsLocks: true,
BreadcrumbDocName: "test.txt",
}
newFileInfo, err := fc.CheckFileInfo(ctx)
// UserId and UserFriendlyName have random Ids generated which are impossible to guess
// UserID and UserFriendlyName have random Ids generated which are impossible to guess
// Check both separately
Expect(newFileInfo.UserId).To(HavePrefix(hex.EncodeToString([]byte("guest-"))))
Expect(newFileInfo.UserFriendlyName).To(HavePrefix("Guest "))
// overwrite UserId and UserFriendlyName here for easier matching
newFileInfo.UserId = "guest-zzz000"
newFileInfo.UserFriendlyName = "guest zzz000"
Expect(newFileInfo.(*fileinfo.Collabora).UserID).To(HavePrefix(hex.EncodeToString([]byte("guest-"))))
Expect(newFileInfo.(*fileinfo.Collabora).UserFriendlyName).To(HavePrefix("Guest "))
// overwrite UserID and UserFriendlyName here for easier matching
newFileInfo.(*fileinfo.Collabora).UserID = "guest-zzz000"
newFileInfo.(*fileinfo.Collabora).UserFriendlyName = "guest zzz000"
Expect(err).To(Succeed())
Expect(newFileInfo).To(Equal(expectedFileInfo))
Expect(newFileInfo.(*fileinfo.Collabora)).To(Equal(expectedFileInfo))
})
It("Stat success authenticated user", func() {
@@ -897,32 +894,29 @@ var _ = Describe("FileConnector", func() {
},
}, nil)
expectedFileInfo := connector.FileInfo{
OwnerId: "61616262636340637573746f6d496470", // hex of aabbcc@customIdp
Size: int64(998877),
Version: "16273849.0",
BaseFileName: "test.txt",
BreadcrumbDocName: "test.txt",
UserCanNotWriteRelative: true,
HostViewUrl: "http://test.ex.prv/view",
HostEditUrl: "http://test.ex.prv/edit",
EnableOwnerTermination: false,
SupportsExtendedLockLength: true,
SupportsGetLock: true,
SupportsLocks: true,
DisableExport: true,
DisableCopy: true,
DisablePrint: true,
IsAnonymousUser: false,
UserId: hex.EncodeToString([]byte("opaqueId@inmemory")),
UserFriendlyName: "Pet Shaft",
WatermarkText: "Pet Shaft shaft@example.com",
// change wopi app provider
cfg.App.Name = "Collabora"
expectedFileInfo := &fileinfo.Collabora{
OwnerID: "61616262636340637573746f6d496470", // hex of aabbcc@customIdp
Size: int64(998877),
BaseFileName: "test.txt",
UserCanNotWriteRelative: true,
DisableExport: true,
DisableCopy: true,
DisablePrint: true,
UserID: hex.EncodeToString([]byte("opaqueId@inmemory")),
UserFriendlyName: "Pet Shaft",
EnableOwnerTermination: true,
WatermarkText: "Pet Shaft shaft@example.com",
SupportsLocks: true,
BreadcrumbDocName: "test.txt",
}
newFileInfo, err := fc.CheckFileInfo(ctx)
Expect(err).To(Succeed())
Expect(newFileInfo).To(Equal(expectedFileInfo))
Expect(newFileInfo.(*fileinfo.Collabora)).To(Equal(expectedFileInfo))
})
})
})
@@ -0,0 +1,154 @@
package fileinfo
// Collabora fileInfo properties
//
// Collabora WOPI check file info specification:
// https://sdk.collaboraonline.com/docs/advanced_integration.html
type Collabora struct {
//
// Response properties
//
// Copied from MS WOPI
BaseFileName string `json:"BaseFileName,omitempty"`
// Copied from MS WOPI
DisablePrint bool `json:"DisablePrint"`
// Copied from MS WOPI
OwnerID string `json:"OwnerId,omitempty"`
// A string for the domain the host page sends/receives PostMessages from, we only listen to messages from this domain.
PostMessageOrigin string `json:"PostMessageOrigin,omitempty"`
// copied from MS WOPI
Size int64 `json:"Size"`
// The ID of file (like the wopi/files/ID) can be a non-existing file. In that case, the file will be created from a template when the template (eg. an OTT file) is specified as TemplateSource in the CheckFileInfo response. The TemplateSource is supposed to be an URL like https://somewhere/accessible/file.ott that is accessible by the Online. For the actual saving of the content, normal PutFile mechanism will be used.
TemplateSource string `json:"TemplateSource,omitempty"`
// copied from MS WOPI
UserCanWrite bool `json:"UserCanWrite"`
// copied from MS WOPI
UserCanNotWriteRelative bool `json:"UserCanNotWriteRelative"`
// copied from MS WOPI
UserID string `json:"UserId,omitempty"`
// copied from MS WOPI
UserFriendlyName string `json:"UserFriendlyName,omitempty"`
//
// Extended response properties
//
// If set to true, this will enable the insertion of images chosen from the WOPI storage. A UI_InsertGraphic postMessage will be send to the WOPI host to request the UI to select the file.
EnableInsertRemoteImage bool `json:"EnableInsertRemoteImage,omitempty"`
// If set to true, this will disable the insertion of image chosen from the local device. If EnableInsertRemoteImage is not set to true, then inserting images files is not possible.
DisableInsertLocalImage bool `json:"DisableInsertLocalImage,omitempty"`
// If set to true, hides the print option from the file menu bar in the UI.
HidePrintOption bool `json:"HidePrintOption,omitempty"`
// If set to true, hides the save button from the toolbar and file menubar in the UI.
HideSaveOption bool `json:"HideSaveOption,omitempty"`
// Hides Download as option in the file menubar.
HideExportOption bool `json:"HideExportOption,omitempty"`
// Disables export functionality in backend. If set to true, HideExportOption is assumed to be true
DisableExport bool `json:"DisableExport,omitempty"`
// Disables copying from the document in libreoffice online backend. Pasting into the document would still be possible. However, it is still possible to do an “internal” cut/copy/paste.
DisableCopy bool `json:"DisableCopy,omitempty"`
// Disables displaying of the explanation text on the overlay when the document becomes inactive or killed. With this, the JS integration must provide the user with appropriate message when it gets Session_Closed or User_Idle postMessages.
DisableInactiveMessages bool `json:"DisableInactiveMessages,omitempty"`
// Indicate that the integration wants to handle the downloading of pdf for printing or svg for slideshows or exported document, because it cannot rely on browsers support for downloading.
DownloadAsPostMessage bool `json:"DownloadAsPostMessage,omitempty"`
// Similar to download as, doctype extensions can be provided for save-as. In this case the new file is loaded in the integration instead of downloaded.
SaveAsPostmessage bool `json:"SaveAsPostmessage,omitempty"`
// If set to true, it allows the document owner (the one with OwnerId =UserId) to send a closedocument message (see protocol.txt)
EnableOwnerTermination bool `json:"EnableOwnerTermination,omitempty"`
// JSON object that contains additional info about the user, namely the avatar image.
//UserExtraInfo -> requires definition, currently not used
// JSON object that contains additional info about the user, but unlike the UserExtraInfo it is not shared among the views in collaborative editing sessions.
//UserPrivateInfo -> requires definition, currently not used
// If set to a non-empty string, is used for rendering a watermark-like text on each tile of the document.
WatermarkText string `json:"WatermarkText,omitempty"`
//
// Undocumented (from source code)
//
EnableShare bool `json:"EnableShare,omitempty"`
// If set to "true", user list on the status bar will be hidden
// If set to "mobile" | "tablet" | "desktop", will be hidden on a specified device
// (may be joint, delimited by commas eg. "mobile,tablet")
HideUserList string `json:"HideUserList,omitempty"`
SupportsLocks bool `json:"SupportsLocks"`
SupportsRename bool `json:"SupportsRename"`
UserCanRename bool `json:"UserCanRename"`
BreadcrumbDocName string `json:"BreadcrumbDocName,omitempty"`
}
// SetProperties will set the file properties for the Collabora implementation.
func (cinfo *Collabora) SetProperties(props map[string]interface{}) {
for key, value := range props {
switch key {
case KeyBaseFileName:
cinfo.BaseFileName = value.(string)
case KeyDisablePrint:
cinfo.DisablePrint = value.(bool)
case KeyOwnerID:
cinfo.OwnerID = value.(string)
case KeyPostMessageOrigin:
cinfo.PostMessageOrigin = value.(string)
case KeySize:
cinfo.Size = value.(int64)
case KeyTemplateSource:
cinfo.TemplateSource = value.(string)
case KeyUserCanWrite:
cinfo.UserCanWrite = value.(bool)
case KeyUserCanNotWriteRelative:
cinfo.UserCanNotWriteRelative = value.(bool)
case KeyUserID:
cinfo.UserID = value.(string)
case KeyUserFriendlyName:
cinfo.UserFriendlyName = value.(string)
case KeyEnableInsertRemoteImage:
cinfo.EnableInsertRemoteImage = value.(bool)
case KeyDisableInsertLocalImage:
cinfo.DisableInsertLocalImage = value.(bool)
case KeyHidePrintOption:
cinfo.HidePrintOption = value.(bool)
case KeyHideSaveOption:
cinfo.HideSaveOption = value.(bool)
case KeyHideExportOption:
cinfo.HideExportOption = value.(bool)
case KeyDisableExport:
cinfo.DisableExport = value.(bool)
case KeyDisableCopy:
cinfo.DisableCopy = value.(bool)
case KeyDisableInactiveMessages:
cinfo.DisableInactiveMessages = value.(bool)
case KeyDownloadAsPostMessage:
cinfo.DownloadAsPostMessage = value.(bool)
case KeySaveAsPostmessage:
cinfo.SaveAsPostmessage = value.(bool)
case KeyEnableOwnerTermination:
cinfo.EnableOwnerTermination = value.(bool)
//UserExtraInfo -> requires definition, currently not used
//UserPrivateInfo -> requires definition, currently not used
case KeyWatermarkText:
cinfo.WatermarkText = value.(string)
case KeyEnableShare:
cinfo.EnableShare = value.(bool)
case KeyHideUserList:
cinfo.HideUserList = value.(string)
case KeySupportsLocks:
cinfo.SupportsLocks = value.(bool)
case KeySupportsRename:
cinfo.SupportsRename = value.(bool)
case KeyUserCanRename:
cinfo.UserCanRename = value.(bool)
case KeyBreadcrumbDocName:
cinfo.BreadcrumbDocName = value.(string)
}
}
}
// GetTarget will always return "Collabora"
func (cinfo *Collabora) GetTarget() string {
return "Collabora"
}
@@ -0,0 +1,132 @@
package fileinfo
// FileInfo contains the properties of the file.
// Some properties refer to capabilities in the WOPI client, and capabilities
// that the WOPI server has.
//
// Specific implementations must allow json-encoding of their relevant
// properties because the object will be marshalled directly
type FileInfo interface {
// SetProperties will set the properties of this FileInfo.
// Keys should match any valid property that the FileInfo implementation
// has. If a key doesn't match any property, it must be ignored.
// The values must have its matching type for the target property,
// otherwise panics might happen.
//
// This method should help to reduce the friction of using different
// implementations with different properties. You can use the same map
// for all the implementations knowing that the relevant properties for
// each implementation will be set.
SetProperties(props map[string]interface{})
// GetTarget will return the target implementation (OnlyOffice, Collabora...).
// This will help to identify the implementation we're using in an easy way.
// Note that the returned value must be unique among all the implementations
GetTarget() string
}
// constants that can be used to refer the fileinfo properties for the
// SetProperties method of the FileInfo interface
const (
KeyBaseFileName = "BaseFileName"
KeyOwnerID = "OwnerId"
KeySize = "Size"
KeyUserID = "UserID"
KeyVersion = "Version"
KeySupportedShareURLTypes = "SupportedShareURLTypes"
KeySupportsCobalt = "SupportsCobalt"
KeySupportsContainers = "SupportsContainers"
KeySupportsDeleteFile = "SupportsDeleteFile"
KeySupportsEcosystem = "SupportsEcosystem"
KeySupportsExtendedLockLength = "SupportsExtendedLockLength"
KeySupportsFolders = "SupportsFolders"
//KeySupportsGetFileWopiSrc = "SupportsGetFileWopiSrc" // wopivalidator is complaining and the property isn't used for now -> commented
KeySupportsGetLock = "SupportsGetLock"
KeySupportsLocks = "SupportsLocks"
KeySupportsRename = "SupportsRename"
KeySupportsUpdate = "SupportsUpdate"
KeySupportsUserInfo = "SupportsUserInfo"
KeyIsAnonymousUser = "IsAnonymousUser"
KeyIsEduUser = "IsEduUser"
KeyLicenseCheckForEditIsEnabled = "LicenseCheckForEditIsEnabled"
KeyUserFriendlyName = "UserFriendlyName"
KeyUserInfo = "UserInfo"
KeyReadOnly = "ReadOnly"
KeyRestrictedWebViewOnly = "RestrictedWebViewOnly"
KeyUserCanAttend = "UserCanAttend"
KeyUserCanNotWriteRelative = "UserCanNotWriteRelative"
KeyUserCanPresent = "UserCanPresent"
KeyUserCanRename = "UserCanRename"
KeyUserCanWrite = "UserCanWrite"
KeyCloseURL = "CloseURL"
KeyDownloadURL = "DownloadURL"
KeyFileEmbedCommandURL = "FileEmbedCommandURL"
KeyFileSharingURL = "FileSharingURL"
KeyFileURL = "FileURL"
KeyFileVersionURL = "FileVersionURL"
KeyHostEditURL = "HostEditURL"
KeyHostEmbeddedViewURL = "HostEmbeddedViewURL"
KeyHostViewURL = "HostViewURL"
KeySignoutURL = "SignoutURL"
KeyAllowAdditionalMicrosoftServices = "AllowAdditionalMicrosoftServices"
KeyAllowErrorReportPrompt = "AllowErrorReportPrompt"
KeyAllowExternalMarketplace = "AllowExternalMarketplace"
KeyClientThrottlingProtection = "ClientThrottlingProtection"
KeyCloseButtonClosesWindow = "CloseButtonClosesWindow"
KeyCopyPasteRestrictions = "CopyPasteRestrictions"
KeyDisablePrint = "DisablePrint"
KeyDisableTranslation = "DisableTranslation"
KeyFileExtension = "FileExtension"
KeyFileNameMaxLength = "FileNameMaxLength"
KeyLastModifiedTime = "LastModifiedTime"
KeyRequestedCallThrottling = "RequestedCallThrottling"
KeySHA256 = "SHA256"
KeySharingStatus = "SharingStatus"
KeyTemporarilyNotWritable = "TemporarilyNotWritable"
//KeyUniqueContentId = "UniqueContentId" // From microsoft docs: Not supported in CSPP -> commented
KeyBreadcrumbBrandName = "BreadcrumbBrandName"
KeyBreadcrumbBrandURL = "BreadcrumbBrandURL"
KeyBreadcrumbDocName = "BreadcrumbDocName"
KeyBreadcrumbFolderName = "BreadcrumbFolderName"
KeyBreadcrumbFolderURL = "BreadcrumbFolderUrl"
// Collabora (non-dupped) properties below
KeyPostMessageOrigin = "PostMessageOrigin"
KeyTemplateSource = "TemplateSource"
KeyEnableInsertRemoteImage = "EnableInsertRemoteImage"
KeyDisableInsertLocalImage = "DisableInsertLocalImage"
KeyHidePrintOption = "HidePrintOption"
KeyHideSaveOption = "HideSaveOption"
KeyHideExportOption = "HideExportOption"
KeyDisableExport = "DisableExport"
KeyDisableCopy = "DisableCopy"
KeyDisableInactiveMessages = "DisableInactiveMessages"
KeyDownloadAsPostMessage = "DownloadAsPostMessage"
KeySaveAsPostmessage = "SaveAsPostmessage"
KeyEnableOwnerTermination = "EnableOwnerTermination"
//KeyUserExtraInfo -> requires definition, currently not used
//KeyUserPrivateInfo -> requires definition, currently not used
KeyWatermarkText = "WatermarkText"
KeyEnableShare = "EnableShare"
KeyHideUserList = "HideUserList"
// OnlyOffice (non-dupped) properties below
KeyClosePostMessage = "ClosePostMessage"
KeyEditModePostMessage = "EditModePostMessage"
KeyEditNotificationPostMessage = "EditNotificationPostMessage"
KeyFileSharingPostMessage = "FileSharingPostMessage"
KeyFileVersionPostMessage = "FileVersionPostMessage"
KeyUserCanReview = "UserCanReview"
KeySupportsReviewing = "SupportsReviewing"
)
@@ -1,17 +1,10 @@
package connector
package fileinfo
// FileInfo contains the properties of the file.
// Some properties refer to capabilities in the WOPI client, and capabilities
// that the WOPI server has.
// Microsoft fileInfo properties
//
// For now, the FileInfo contains data for Microsoft, Collabora and OnlyOffice.
// Not all the properties are supported by every system.
type FileInfo struct {
// ------------
// Microsoft WOPI check file info specification:
// https://docs.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/rest/files/checkfileinfo
// ------------
// Microsoft WOPI check file info specification:
// https://docs.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/rest/files/checkfileinfo
type Microsoft struct {
//
// Required response properties
//
@@ -19,11 +12,11 @@ type FileInfo struct {
// The string name of the file, including extension, without a path. Used for display in user interface (UI), and determining the extension of the file.
BaseFileName string `json:"BaseFileName,omitempty"`
//A string that uniquely identifies the owner of the file. In most cases, the user who uploaded or created the file should be considered the owner.
OwnerId string `json:"OwnerId,omitempty"`
OwnerID string `json:"OwnerId,omitempty"`
// The size of the file in bytes, expressed as a long, a 64-bit signed integer.
Size int64 `json:"Size"`
// A string value uniquely identifying the user currently accessing the file.
UserId string `json:"UserId,omitempty"`
UserID string `json:"UserId,omitempty"`
// The current version of the file based on the servers file version schema, as a string. This value must change when the file changes, and version values must never repeat for a given file.
Version string `json:"Version,omitempty"`
@@ -32,7 +25,7 @@ type FileInfo struct {
//
// An array of strings containing the Share URL types supported by the host.
SupportedShareUrlTypes []string `json:"SupportedShareUrlTypes,omitempty"`
SupportedShareURLTypes []string `json:"SupportedShareUrlTypes,omitempty"`
// A Boolean value that indicates that the host supports the following WOPI operations: ExecuteCellStorageRequest, ExecuteCellStorageRelativeRequest
SupportsCobalt bool `json:"SupportsCobalt"`
// A Boolean value that indicates that the host supports the following WOPI operations: CheckContainerInfo, CreateChildContainer, CreateChildFile, DeleteContainer, DeleteFile, EnumerateAncestors (containers), EnumerateAncestors (files), EnumerateChildren (containers), GetEcosystem (containers), RenameContainer
@@ -97,25 +90,25 @@ type FileInfo struct {
//
// A URI to a web page that the WOPI client should navigate to when the application closes, or in the event of an unrecoverable error.
CloseUrl string `json:"CloseUrl,omitempty"`
CloseURL string `json:"CloseUrl,omitempty"`
// A user-accessible URI to the file intended to allow the user to download a copy of the file.
DownloadUrl string `json:"DownloadUrl,omitempty"`
DownloadURL string `json:"DownloadUrl,omitempty"`
// A URI to a location that allows the user to create an embeddable URI to the file.
FileEmbedCommandUrl string `json:"FileEmbedCommandUrl,omitempty"`
FileEmbedCommandURL string `json:"FileEmbedCommandUrl,omitempty"`
// A URI to a location that allows the user to share the file.
FileSharingUrl string `json:"FileSharingUrl,omitempty"`
FileSharingURL string `json:"FileSharingUrl,omitempty"`
// A URI to the file location that the WOPI client uses to get the file. If this is provided, the WOPI client may use this URI to get the file instead of a GetFile request. A host might set this property if it is easier or provides better performance to serve files from a different domain than the one handling standard WOPI requests. WOPI clients must not add or remove parameters from the URL; no other parameters, including the access token, should be appended to the FileUrl before it is used.
FileUrl string `json:"FileUrl,omitempty"`
FileURL string `json:"FileUrl,omitempty"`
// A URI to a location that allows the user to view the version history for the file.
FileVersionUrl string `json:"FileVersionUrl,omitempty"`
FileVersionURL string `json:"FileVersionUrl,omitempty"`
// A URI to a host page that loads the edit WOPI action.
HostEditUrl string `json:"HostEditUrl,omitempty"`
HostEditURL string `json:"HostEditUrl,omitempty"`
// A URI to a web page that provides access to a viewing experience for the file that can be embedded in another HTML page. This is typically a URI to a host page that loads the embedview WOPI action.
HostEmbeddedViewUrl string `json:"HostEmbeddedViewUrl,omitempty"`
HostEmbeddedViewURL string `json:"HostEmbeddedViewUrl,omitempty"`
// A URI to a host page that loads the view WOPI action. This URL is used by Office Online to navigate between view and edit mode.
HostViewUrl string `json:"HostViewUrl,omitempty"`
HostViewURL string `json:"HostViewUrl,omitempty"`
// A URI that will sign the current user out of the hosts authentication system.
SignoutUrl string `json:"SignoutUrl,omitempty"`
SignoutURL string `json:"SignoutUrl,omitempty"`
//
// Miscellaneous properties
@@ -161,173 +154,149 @@ type FileInfo struct {
// A string that indicates the brand name of the host.
BreadcrumbBrandName string `json:"BreadcrumbBrandName,omitempty"`
// A URI to a web page that the WOPI client should navigate to when the user clicks on UI that displays BreadcrumbBrandName.
BreadcrumbBrandUrl string `json:"BreadcrumbBrandUrl,omitempty"`
BreadcrumbBrandURL string `json:"BreadcrumbBrandUrl,omitempty"`
// A string that indicates the name of the file. If this is not provided, WOPI clients may use the BaseFileName value.
BreadcrumbDocName string `json:"BreadcrumbDocName,omitempty"`
// A string that indicates the name of the container that contains the file.
BreadcrumbFolderName string `json:"BreadcrumbFolderName,omitempty"`
// A URI to a web page that the WOPI client should navigate to when the user clicks on UI that displays BreadcrumbFolderName.
BreadcrumbFolderUrl string `json:"BreadcrumbFolderUrl,omitempty"`
// ------------
// Collabora WOPI check file info specification:
// https://sdk.collaboraonline.com/docs/advanced_integration.html
// ------------
//
// Response properties
//
//BaseFileName -> already in MS WOPI
//DisablePrint -> already in MS WOPI
//OwnerID -> already in MS WOPI
// A string for the domain the host page sends/receives PostMessages from, we only listen to messages from this domain.
PostMessageOrigin string `json:"PostMessageOrigin,omitempty"`
//Size -> already in MS WOPI
// The ID of file (like the wopi/files/ID) can be a non-existing file. In that case, the file will be created from a template when the template (eg. an OTT file) is specified as TemplateSource in the CheckFileInfo response. The TemplateSource is supposed to be an URL like https://somewhere/accessible/file.ott that is accessible by the Online. For the actual saving of the content, normal PutFile mechanism will be used.
TemplateSource string `json:"TemplateSource,omitempty"`
//UserCanWrite -> already in MS WOPI
//UserCanNotWriteRelative -> already in MS WOPI
//UserId -> already in MS WOPI
//UserFriendlyName -> already in MS WOPI
//
// Extended response properties
//
// If set to true, this will enable the insertion of images chosen from the WOPI storage. A UI_InsertGraphic postMessage will be send to the WOPI host to request the UI to select the file.
EnableInsertRemoteImage bool `json:"EnableInsertRemoteImage,omitempty"`
// If set to true, this will disable the insertion of image chosen from the local device. If EnableInsertRemoteImage is not set to true, then inserting images files is not possible.
DisableInsertLocalImage bool `json:"DisableInsertLocalImage,omitempty"`
// If set to true, hides the print option from the file menu bar in the UI.
HidePrintOption bool `json:"HidePrintOption,omitempty"`
// If set to true, hides the save button from the toolbar and file menubar in the UI.
HideSaveOption bool `json:"HideSaveOption,omitempty"`
// Hides Download as option in the file menubar.
HideExportOption bool `json:"HideExportOption,omitempty"`
// Disables export functionality in backend. If set to true, HideExportOption is assumed to be true
DisableExport bool `json:"DisableExport,omitempty"`
// Disables copying from the document in libreoffice online backend. Pasting into the document would still be possible. However, it is still possible to do an “internal” cut/copy/paste.
DisableCopy bool `json:"DisableCopy,omitempty"`
// Disables displaying of the explanation text on the overlay when the document becomes inactive or killed. With this, the JS integration must provide the user with appropriate message when it gets Session_Closed or User_Idle postMessages.
DisableInactiveMessages bool `json:"DisableInactiveMessages,omitempty"`
// Indicate that the integration wants to handle the downloading of pdf for printing or svg for slideshows or exported document, because it cannot rely on browsers support for downloading.
DownloadAsPostMessage bool `json:"DownloadAsPostMessage,omitempty"`
// Similar to download as, doctype extensions can be provided for save-as. In this case the new file is loaded in the integration instead of downloaded.
SaveAsPostmessage bool `json:"SaveAsPostmessage,omitempty"`
// If set to true, it allows the document owner (the one with OwnerId =UserId) to send a closedocument message (see protocol.txt)
EnableOwnerTermination bool `json:"EnableOwnerTermination,omitempty"`
// JSON object that contains additional info about the user, namely the avatar image.
//UserExtraInfo -> requires definition, currently not used
// JSON object that contains additional info about the user, but unlike the UserExtraInfo it is not shared among the views in collaborative editing sessions.
//UserPrivateInfo -> requires definition, currently not used
// If set to a non-empty string, is used for rendering a watermark-like text on each tile of the document.
WatermarkText string `json:"WatermarkText,omitempty"`
// ------------
// OnlyOffice WOPI check file info specification:
// https://api.onlyoffice.com/editors/wopi/restapi/checkfileinfo
// ------------
//
// Required response properties
//
//BaseFileName -> already in MS WOPI
//Version -> already in MS WOPI
//
// Breadcrumb properties
//
//BreadcrumbBrandName -> already in MS WOPI
//BreadcrumbBrandUrl -> already in MS WOPI
//BreadcrumbDocName -> already in MS WOPI
//BreadcrumbFolderName -> already in MS WOPI
//BreadcrumbFolderUrl -> already in MS WOPI
//
// PostMessage properties
//
// Specifies if the WOPI client should notify the WOPI server in case the user closes the rendering or editing client currently using this file. The host expects to receive the UI_Close PostMessage when the Close UI in the online office is activated.
ClosePostMessage bool `json:"ClosePostMessage,omitempty"`
// Specifies if the WOPI client should notify the WOPI server in case the user tries to edit a file. The host expects to receive the UI_Edit PostMessage when the Edit UI in the online office is activated.
EditModePostMessage bool `json:"EditModePostMessage,omitempty"`
// Specifies if the WOPI client should notify the WOPI server in case the user tries to edit a file. The host expects to receive the Edit_Notification PostMessage.
EditNotificationPostMessage bool `json:"EditNotificationPostMessage,omitempty"`
// Specifies if the WOPI client should notify the WOPI server in case the user tries to share a file. The host expects to receive the UI_Sharing PostMessage when the Share UI in the online office is activated.
FileSharingPostMessage bool `json:"FileSharingPostMessage,omitempty"`
// Specifies if the WOPI client will notify the WOPI server in case the user tries to navigate to the previous file version. The host expects to receive the UI_FileVersions PostMessage when the Previous Versions UI in the online office is activated.
FileVersionPostMessage bool `json:"FileVersionPostMessage,omitempty"`
// A domain that the WOPI client must use as the targetOrigin parameter when sending messages as described in [W3C-HTML5WEBMSG].
//PostMessageOrigin -> already in collabora WOPI
//
// File URL properties
//
//CloseUrl -> already in MS WOPI
//FileSharingUrl -> already in MS WOPI
//FileVersionUrl -> already in MS WOPI
//HostEditUrl -> already in MS WOPI
//
// Miscellaneous properties
//
// Specifies if the WOPI client must disable the Copy and Paste functionality within the application. By default, all Copy and Paste functionality is enabled, i.e. the setting has no effect. Possible property values:
// BlockAll - the Copy and Paste functionality is completely disabled within the application;
// CurrentDocumentOnly - the Copy and Paste functionality is enabled but content can only be copied and pasted within the file currently open in the application.
//CopyPasteRestrictions -> already in MS WOPI
//DisablePrint -> already in MS WOPI
//FileExtension -> already in MS WOPI
//FileNameMaxLength -> already in MS WOPI
//LastModifiedTime -> already in MS WOPI
//
// User metadata properties
//
//IsAnonymousUser -> already in MS WOPI
//UserFriendlyName -> already in MS WOPI
//UserId -> already in MS WOPI
//
// User permissions properties
//
//ReadOnly -> already in MS WOPI
//UserCanNotWriteRelative -> already in MS WOPI
//UserCanRename -> already in MS WOPI
// Specifies if the user has permissions to review a file.
UserCanReview bool `json:"UserCanReview,omitempty"`
//UserCanWrite -> already in MS WOPI
//
// Host capabilities properties
//
//SupportsLocks -> already in MS WOPI
//SupportsRename -> already in MS WOPI
// Specifies if the WOPI server supports the review permission.
SupportsReviewing bool `json:"SupportsReviewing,omitempty"`
//SupportsUpdate -> already in MS WOPI
//
// Other properties
//
//EnableInsertRemoteImage -> already in collabora WOPI
//HidePrintOption -> already in collabora WOPI
BreadcrumbFolderURL string `json:"BreadcrumbFolderUrl,omitempty"`
}
// SetProperties will set the file properties for the Microsoft implementation.
func (minfo *Microsoft) SetProperties(props map[string]interface{}) {
for key, value := range props {
switch key {
case KeyBaseFileName:
minfo.BaseFileName = value.(string)
case KeyOwnerID:
minfo.OwnerID = value.(string)
case KeySize:
minfo.Size = value.(int64)
case KeyUserID:
minfo.UserID = value.(string)
case KeyVersion:
minfo.Version = value.(string)
case KeySupportedShareURLTypes:
minfo.SupportedShareURLTypes = value.([]string)
case KeySupportsCobalt:
minfo.SupportsCobalt = value.(bool)
case KeySupportsContainers:
minfo.SupportsContainers = value.(bool)
case KeySupportsDeleteFile:
minfo.SupportsDeleteFile = value.(bool)
case KeySupportsEcosystem:
minfo.SupportsEcosystem = value.(bool)
case KeySupportsExtendedLockLength:
minfo.SupportsExtendedLockLength = value.(bool)
case KeySupportsFolders:
minfo.SupportsFolders = value.(bool)
//SupportsGetFileWopiSrc bool `json:"SupportsGetFileWopiSrc"` // wopivalidator is complaining and the property isn't used for now -> commented
case KeySupportsGetLock:
minfo.SupportsGetLock = value.(bool)
case KeySupportsLocks:
minfo.SupportsLocks = value.(bool)
case KeySupportsRename:
minfo.SupportsRename = value.(bool)
case KeySupportsUpdate:
minfo.SupportsUpdate = value.(bool)
case KeySupportsUserInfo:
minfo.SupportsUserInfo = value.(bool)
case KeyIsAnonymousUser:
minfo.IsAnonymousUser = value.(bool)
case KeyIsEduUser:
minfo.IsEduUser = value.(bool)
case KeyLicenseCheckForEditIsEnabled:
minfo.LicenseCheckForEditIsEnabled = value.(bool)
case KeyUserFriendlyName:
minfo.UserFriendlyName = value.(string)
case KeyUserInfo:
minfo.UserInfo = value.(string)
case KeyReadOnly:
minfo.ReadOnly = value.(bool)
case KeyRestrictedWebViewOnly:
minfo.RestrictedWebViewOnly = value.(bool)
case KeyUserCanAttend:
minfo.UserCanAttend = value.(bool)
case KeyUserCanNotWriteRelative:
minfo.UserCanNotWriteRelative = value.(bool)
case KeyUserCanPresent:
minfo.UserCanPresent = value.(bool)
case KeyUserCanRename:
minfo.UserCanRename = value.(bool)
case KeyUserCanWrite:
minfo.UserCanWrite = value.(bool)
case KeyCloseURL:
minfo.CloseURL = value.(string)
case KeyDownloadURL:
minfo.DownloadURL = value.(string)
case KeyFileEmbedCommandURL:
minfo.FileEmbedCommandURL = value.(string)
case KeyFileSharingURL:
minfo.FileSharingURL = value.(string)
case KeyFileURL:
minfo.FileURL = value.(string)
case KeyFileVersionURL:
minfo.FileVersionURL = value.(string)
case KeyHostEditURL:
minfo.HostEditURL = value.(string)
case KeyHostEmbeddedViewURL:
minfo.HostEmbeddedViewURL = value.(string)
case KeyHostViewURL:
minfo.HostViewURL = value.(string)
case KeySignoutURL:
minfo.SignoutURL = value.(string)
case KeyAllowAdditionalMicrosoftServices:
minfo.AllowAdditionalMicrosoftServices = value.(bool)
case KeyAllowErrorReportPrompt:
minfo.AllowErrorReportPrompt = value.(bool)
case KeyAllowExternalMarketplace:
minfo.AllowExternalMarketplace = value.(bool)
case KeyClientThrottlingProtection:
minfo.ClientThrottlingProtection = value.(string)
case KeyCloseButtonClosesWindow:
minfo.CloseButtonClosesWindow = value.(bool)
case KeyCopyPasteRestrictions:
minfo.CopyPasteRestrictions = value.(string)
case KeyDisablePrint:
minfo.DisablePrint = value.(bool)
case KeyDisableTranslation:
minfo.DisableTranslation = value.(bool)
case KeyFileExtension:
minfo.FileExtension = value.(string)
case KeyFileNameMaxLength:
minfo.FileNameMaxLength = value.(int)
case KeyLastModifiedTime:
minfo.LastModifiedTime = value.(string)
case KeyRequestedCallThrottling:
minfo.RequestedCallThrottling = value.(string)
case KeySHA256:
minfo.SHA256 = value.(string)
case KeySharingStatus:
minfo.SharingStatus = value.(string)
case KeyTemporarilyNotWritable:
minfo.TemporarilyNotWritable = value.(bool)
case KeyBreadcrumbBrandName:
minfo.BreadcrumbBrandName = value.(string)
case KeyBreadcrumbBrandURL:
minfo.BreadcrumbBrandURL = value.(string)
case KeyBreadcrumbDocName:
minfo.BreadcrumbDocName = value.(string)
case KeyBreadcrumbFolderName:
minfo.BreadcrumbFolderName = value.(string)
case KeyBreadcrumbFolderURL:
minfo.BreadcrumbFolderURL = value.(string)
}
}
}
// GetTarget will always return "Microsoft"
func (minfo *Microsoft) GetTarget() string {
return "Microsoft"
}
@@ -0,0 +1,221 @@
package fileinfo
// OnlyOffice fileInfo properties
//
// OnlyOffice WOPI check file info specification:
// https://api.onlyoffice.com/editors/wopi/restapi/checkfileinfo
type OnlyOffice struct {
//
// Required response properties
//
// copied from MS WOPI
BaseFileName string `json:"BaseFileName,omitempty"`
// copied from MS WOPI
Version string `json:"Version,omitempty"`
//
// Breadcrumb properties
//
// copied from MS WOPI
BreadcrumbBrandName string `json:"BreadcrumbBrandName,omitempty"`
// copied from MS WOPI
BreadcrumbBrandURL string `json:"BreadcrumbBrandUrl,omitempty"`
// copied from MS WOPI
BreadcrumbDocName string `json:"BreadcrumbDocName,omitempty"`
// copied from MS WOPI
BreadcrumbFolderName string `json:"BreadcrumbFolderName,omitempty"`
// copied from MS WOPI
BreadcrumbFolderURL string `json:"BreadcrumbFolderUrl,omitempty"`
//
// PostMessage properties
//
// Specifies if the WOPI client should notify the WOPI server in case the user closes the rendering or editing client currently using this file. The host expects to receive the UI_Close PostMessage when the Close UI in the online office is activated.
ClosePostMessage bool `json:"ClosePostMessage,omitempty"`
// Specifies if the WOPI client should notify the WOPI server in case the user tries to edit a file. The host expects to receive the UI_Edit PostMessage when the Edit UI in the online office is activated.
EditModePostMessage bool `json:"EditModePostMessage,omitempty"`
// Specifies if the WOPI client should notify the WOPI server in case the user tries to edit a file. The host expects to receive the Edit_Notification PostMessage.
EditNotificationPostMessage bool `json:"EditNotificationPostMessage,omitempty"`
// Specifies if the WOPI client should notify the WOPI server in case the user tries to share a file. The host expects to receive the UI_Sharing PostMessage when the Share UI in the online office is activated.
FileSharingPostMessage bool `json:"FileSharingPostMessage,omitempty"`
// Specifies if the WOPI client will notify the WOPI server in case the user tries to navigate to the previous file version. The host expects to receive the UI_FileVersions PostMessage when the Previous Versions UI in the online office is activated.
FileVersionPostMessage bool `json:"FileVersionPostMessage,omitempty"`
// A domain that the WOPI client must use as the targetOrigin parameter when sending messages as described in [W3C-HTML5WEBMSG].
// copied from collabora WOPI
PostMessageOrigin string `json:"PostMessageOrigin,omitempty"`
//
// File URL properties
//
// copied from MS WOPI
CloseURL string `json:"CloseUrl,omitempty"`
// copied from MS WOPI
FileSharingURL string `json:"FileSharingUrl,omitempty"`
// copied from MS WOPI
FileVersionURL string `json:"FileVersionUrl,omitempty"`
// copied from MS WOPI
HostEditURL string `json:"HostEditUrl,omitempty"`
//
// Miscellaneous properties
//
// Specifies if the WOPI client must disable the Copy and Paste functionality within the application. By default, all Copy and Paste functionality is enabled, i.e. the setting has no effect. Possible property values:
// BlockAll - the Copy and Paste functionality is completely disabled within the application;
// CurrentDocumentOnly - the Copy and Paste functionality is enabled but content can only be copied and pasted within the file currently open in the application.
// copied from MS WOPI
CopyPasteRestrictions string `json:"CopyPasteRestrictions,omitempty"`
// copied from MS WOPI
DisablePrint bool `json:"DisablePrint"`
// copied from MS WOPI
FileExtension string `json:"FileExtension,omitempty"`
// copied from MS WOPI
FileNameMaxLength int `json:"FileNameMaxLength,omitempty"`
// copied from MS WOPI
LastModifiedTime string `json:"LastModifiedTime,omitempty"`
//
// User metadata properties
//
// copied from MS WOPI
IsAnonymousUser bool `json:"IsAnonymousUser,omitempty"`
// copied from MS WOPI
UserFriendlyName string `json:"UserFriendlyName,omitempty"`
// copied from MS WOPI
UserID string `json:"UserId,omitempty"`
//
// User permissions properties
//
// copied from MS WOPI
ReadOnly bool `json:"ReadOnly"`
// copied from MS WOPI
UserCanNotWriteRelative bool `json:"UserCanNotWriteRelative"`
// copied from MS WOPI
UserCanRename bool `json:"UserCanRename"`
// Specifies if the user has permissions to review a file.
UserCanReview bool `json:"UserCanReview,omitempty"`
// copied from MS WOPI
UserCanWrite bool `json:"UserCanWrite"`
//
// Host capabilities properties
//
// copied from MS WOPI
SupportsLocks bool `json:"SupportsLocks"`
// copied from MS WOPI
SupportsRename bool `json:"SupportsRename"`
// Specifies if the WOPI server supports the review permission.
SupportsReviewing bool `json:"SupportsReviewing,omitempty"`
// copied from MS WOPI
SupportsUpdate bool `json:"SupportsUpdate"` // whether "Putfile" and "PutRelativeFile" work
//
// Other properties
//
// copied from collabora WOPI
EnableInsertRemoteImage bool `json:"EnableInsertRemoteImage,omitempty"`
// copied from collabora WOPI
HidePrintOption bool `json:"HidePrintOption,omitempty"`
}
// SetProperties will set the file properties for the OnlyOffice implementation.
func (oinfo *OnlyOffice) SetProperties(props map[string]interface{}) {
for key, value := range props {
switch key {
case KeyBaseFileName:
oinfo.BaseFileName = value.(string)
case KeyVersion:
oinfo.Version = value.(string)
case KeyBreadcrumbBrandName:
oinfo.BreadcrumbBrandName = value.(string)
case KeyBreadcrumbBrandURL:
oinfo.BreadcrumbBrandURL = value.(string)
case KeyBreadcrumbDocName:
oinfo.BreadcrumbDocName = value.(string)
case KeyBreadcrumbFolderName:
oinfo.BreadcrumbFolderName = value.(string)
case KeyBreadcrumbFolderURL:
oinfo.BreadcrumbFolderURL = value.(string)
case KeyClosePostMessage:
oinfo.ClosePostMessage = value.(bool)
case KeyEditModePostMessage:
oinfo.EditModePostMessage = value.(bool)
case KeyEditNotificationPostMessage:
oinfo.EditNotificationPostMessage = value.(bool)
case KeyFileSharingPostMessage:
oinfo.FileSharingPostMessage = value.(bool)
case KeyFileVersionPostMessage:
oinfo.FileVersionPostMessage = value.(bool)
case KeyPostMessageOrigin:
oinfo.PostMessageOrigin = value.(string)
case KeyCloseURL:
oinfo.CloseURL = value.(string)
case KeyFileSharingURL:
oinfo.FileSharingURL = value.(string)
case KeyFileVersionURL:
oinfo.FileVersionURL = value.(string)
case KeyHostEditURL:
oinfo.HostEditURL = value.(string)
case KeyCopyPasteRestrictions:
oinfo.CopyPasteRestrictions = value.(string)
case KeyDisablePrint:
oinfo.DisablePrint = value.(bool)
case KeyFileExtension:
oinfo.FileExtension = value.(string)
case KeyFileNameMaxLength:
oinfo.FileNameMaxLength = value.(int)
case KeyLastModifiedTime:
oinfo.LastModifiedTime = value.(string)
case KeyIsAnonymousUser:
oinfo.IsAnonymousUser = value.(bool)
case KeyUserFriendlyName:
oinfo.UserFriendlyName = value.(string)
case KeyUserID:
oinfo.UserID = value.(string)
case KeyReadOnly:
oinfo.ReadOnly = value.(bool)
case KeyUserCanNotWriteRelative:
oinfo.UserCanNotWriteRelative = value.(bool)
case KeyUserCanRename:
oinfo.UserCanRename = value.(bool)
case KeyUserCanReview:
oinfo.UserCanReview = value.(bool)
case KeyUserCanWrite:
oinfo.UserCanWrite = value.(bool)
case KeySupportsLocks:
oinfo.SupportsLocks = value.(bool)
case KeySupportsRename:
oinfo.SupportsRename = value.(bool)
case KeySupportsReviewing:
oinfo.SupportsReviewing = value.(bool)
case KeySupportsUpdate:
oinfo.SupportsUpdate = value.(bool)
case KeyEnableInsertRemoteImage:
oinfo.EnableInsertRemoteImage = value.(bool)
case KeyHidePrintOption:
oinfo.HidePrintOption = value.(bool)
}
}
}
// GetTarget will always return "OnlyOffice"
func (oinfo *OnlyOffice) GetTarget() string {
return "OnlyOffice"
}
@@ -11,6 +11,7 @@ import (
. "github.com/onsi/gomega"
"github.com/owncloud/ocis/v2/services/collaboration/mocks"
"github.com/owncloud/ocis/v2/services/collaboration/pkg/connector"
"github.com/owncloud/ocis/v2/services/collaboration/pkg/connector/fileinfo"
"github.com/stretchr/testify/mock"
)
@@ -337,7 +338,7 @@ var _ = Describe("HttpAdapter", func() {
w := httptest.NewRecorder()
fc.On("CheckFileInfo", mock.Anything).Times(1).Return(connector.FileInfo{}, errors.New("Something happened"))
fc.On("CheckFileInfo", mock.Anything).Times(1).Return(&fileinfo.Microsoft{}, errors.New("Something happened"))
httpAdapter.CheckFileInfo(w, req)
resp := w.Result()
@@ -351,7 +352,7 @@ var _ = Describe("HttpAdapter", func() {
w := httptest.NewRecorder()
fc.On("CheckFileInfo", mock.Anything).Times(1).Return(connector.FileInfo{}, connector.NewConnectorError(404, "Not found"))
fc.On("CheckFileInfo", mock.Anything).Times(1).Return(&fileinfo.Microsoft{}, connector.NewConnectorError(404, "Not found"))
httpAdapter.CheckFileInfo(w, req)
resp := w.Result()
@@ -364,11 +365,11 @@ var _ = Describe("HttpAdapter", func() {
w := httptest.NewRecorder()
// might need more info, but should be enough for the test
fileinfo := connector.FileInfo{
finfo := &fileinfo.Microsoft{
Size: 123456789,
BreadcrumbDocName: "testy.docx",
}
fc.On("CheckFileInfo", mock.Anything).Times(1).Return(fileinfo, nil)
fc.On("CheckFileInfo", mock.Anything).Times(1).Return(finfo, nil)
httpAdapter.CheckFileInfo(w, req)
resp := w.Result()
@@ -376,9 +377,9 @@ var _ = Describe("HttpAdapter", func() {
jsonInfo, _ := io.ReadAll(resp.Body)
var responseInfo connector.FileInfo
var responseInfo *fileinfo.Microsoft
json.Unmarshal(jsonInfo, &responseInfo)
Expect(responseInfo).To(Equal(fileinfo))
Expect(responseInfo).To(Equal(finfo))
})
})
@@ -19,7 +19,7 @@ import (
// There are no explicit requirements for the context, and it will be passed
// without changes to the underlying RegisterService method.
func RegisterOcisService(ctx context.Context, cfg *config.Config, logger log.Logger) error {
svc := registry.BuildGRPCService(cfg.GRPC.Namespace+"."+cfg.Service.Name, uuid.Must(uuid.NewV4()).String(), cfg.GRPC.Addr, version.GetString())
svc := registry.BuildGRPCService(cfg.GRPC.Namespace+"."+cfg.Service.Name+"."+cfg.App.Name, uuid.Must(uuid.NewV4()).String(), cfg.GRPC.Addr, version.GetString())
return registry.RegisterService(ctx, svc, logger)
}
@@ -62,7 +62,7 @@ func RegisterAppProvider(
Name: cfg.App.Name,
Description: cfg.App.Description,
Icon: cfg.App.Icon,
Address: cfg.GRPC.Namespace + "." + cfg.Service.Name,
Address: cfg.GRPC.Namespace + "." + cfg.Service.Name + "." + cfg.App.Name,
MimeTypes: mimeTypes,
},
}
@@ -15,7 +15,7 @@ func Server(opts ...Option) (*http.Server, error) {
return debug.NewService(
debug.Logger(options.Logger),
debug.Name(options.Config.Service.Name),
debug.Name(options.Config.Service.Name+"."+options.Config.App.Name),
debug.Version(version.GetString()),
debug.Address(options.Config.Debug.Addr),
debug.Token(options.Config.Debug.Token),
@@ -25,7 +25,7 @@ func Server(opts ...Option) (http.Service, error) {
http.TLSConfig(options.Config.HTTP.TLS),
http.Logger(options.Logger),
http.Namespace(options.Config.HTTP.Namespace),
http.Name(options.Config.Service.Name),
http.Name(options.Config.Service.Name+"."+options.Config.App.Name),
http.Version(version.GetString()),
http.Address(options.Config.HTTP.Addr),
http.Context(options.Context),
@@ -41,7 +41,7 @@ func Server(opts ...Option) (http.Service, error) {
middlewares := []func(stdhttp.Handler) stdhttp.Handler{
chimiddleware.RequestID,
middleware.Version(
options.Config.Service.Name,
options.Config.Service.Name+"."+options.Config.App.Name,
version.GetString(),
),
middleware.Logger(
@@ -69,7 +69,7 @@ func Server(opts ...Option) (http.Service, error) {
mux.Use(
otelchi.Middleware(
options.Config.Service.Name,
options.Config.Service.Name+"."+options.Config.App.Name,
otelchi.WithChiRoutes(mux),
otelchi.WithTracerProvider(options.TracerProvider),
otelchi.WithPropagators(tracing.GetPropagator()),
@@ -38,7 +38,7 @@ func NewHandler(opts ...Option) (*Service, func(), error) {
}
return &Service{
id: options.Config.GRPC.Namespace + "." + options.Config.Service.Name,
id: options.Config.GRPC.Namespace + "." + options.Config.Service.Name + "." + options.Config.App.Name,
appURLs: options.AppURLs,
logger: options.Logger,
config: options.Config,