wkloucek / cs3-wopi-server Goto Github PK

View Code? Open in Web Editor NEW

0.0 0.0 2.0 158 KB

License: Apache License 2.0

Dockerfile 0.83% Go 99.17%

cs3-wopi-server's People

Contributors

Watchers

Forkers

deepdiver1975 owncloud

cs3-wopi-server's Issues

rename

cs3-wopi-server/pkg/internal/app/http.go

Lines 55 to 57 in 77cd0ec

 case "RENAME_FILE": 

 // https://docs.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/rest/files/renamefile 

 http.Error(w, http.StatusText(http.StatusNotImplemented), http.StatusNotImplemented)

run the wopi validator

secure defaults

cs3-wopi-server/pkg/internal/app/app.go

Lines 84 to 87 in 77cd0ec

 CS3api: CS3api{ 

 GatewayServiceName: "com.owncloud.api.gateway", 

 CS3DataGatewayInsecure: true, // TODO: this should have a secure default 

 },

cs3-wopi-server/pkg/internal/app/app.go

Lines 99 to 102 in 77cd0ec

 WopiApp: WopiApp{ 

 Addr: "https://127.0.0.1:8080", 

 Insecure: true, // TODO: this should have a secure default 

 },

investigate in cs3api upload while file is locked

cs3-wopi-server/pkg/internal/helpers/upload.go

Lines 72 to 78 in 77cd0ec

 // TODO: the access token shouldn't be needed 

 httpReq.Header.Add("x-access-token", token) 

 // TODO: better mechanism for the upload while locked, relies on patch in REVA 

 //if lockID, ok := ctxpkg.ContextGetLockID(ctx); ok { 

 // httpReq.Header.Add("X-Lock-Id", lockID) 

 //}

un- and relock

cs3-wopi-server/pkg/internal/app/wopilocking.go

Lines 51 to 58 in 77cd0ec

 // Lock returns a WOPI lock or performs an unlock and relock 

 // https://docs.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/rest/files/lock 

 // https://docs.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/rest/files/unlockandrelock 

 func Lock(app *demoApp, w http.ResponseWriter, r *http.Request) { 

 ctx := r.Context() 

 wopiContext, _ := WopiContextFromCtx(ctx) 

 // TODO: handle un- and relock

add tests

refresh lock logic

cs3-wopi-server/pkg/internal/app/wopilocking.go

Lines 138 to 143 in 77cd0ec

 // RefreshLock refreshes a provided lock for 30 minutes 

 // https://docs.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/rest/files/refreshlock 

 func RefreshLock(app *demoApp, w http.ResponseWriter, r *http.Request) { 

 // TODO: implement 

 http.Error(w, http.StatusText(http.StatusNotImplemented), http.StatusNotImplemented) 

 }

configurable log levels

cs3-wopi-server/pkg/internal/logging/logging.go

Lines 7 to 16 in 77cd0ec

 // LoggerFromConfig initializes a service-specific logger instance. 

 func Configure(name string) log.Logger { 

 return log.NewLogger( 

 log.Name(name), 

 log.Level("debug"), // TODO: this should be configurable 

 log.Pretty(true), // TODO: this should be configurable 

 log.Color(true), // TODO: this should be configurable 

 log.File(""), // TODO: this should be configurable 

 ) 

 }

investigate in download without x-access-token

cs3-wopi-server/pkg/internal/helpers/download.go

Lines 81 to 82 in 77cd0ec

 // TODO: the access token shouldn't be needed 

 httpReq.Header.Add("x-access-token", token)

put relative

cs3-wopi-server/pkg/internal/app/http.go

Lines 52 to 54 in 77cd0ec

 case "PUT_RELATIVE": 

 // https://docs.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/rest/files/putrelativefile 

 http.Error(w, http.StatusText(http.StatusNotImplemented), http.StatusNotImplemented)

file ids in logs

Every WOPI requests is based on a file. We should therefore always include file ids in our logs. That would be really helpful for debugging purposes / log investigation on production systems.

lock used as refreshlock

cs3-wopi-server/pkg/internal/app/wopilocking.go

Lines 114 to 125 in 77cd0ec

 if resp.Lock != nil { 

 if resp.Lock.LockId != lockID { 

 w.Header().Set(HeaderWopiLock, resp.Lock.LockId) 

 http.Error(w, http.StatusText(http.StatusConflict), http.StatusConflict) 

 return 

 } 

 // TODO: according to the spec we need to treat this as a RefreshLock 

 http.Error(w, http.StatusText(http.StatusOK), http.StatusOK) 

 return 

 }

investigate if if-match should be used for uploads

cs3-wopi-server/pkg/internal/helpers/upload.go

Lines 18 to 25 in 77cd0ec

 req := &providerv1beta1.InitiateFileUploadRequest{ 

 Ref: ref, 

 LockId: lockID, 

 // TODO: if-match 

 //Options: &providerv1beta1.InitiateFileUploadRequest_IfMatch{ 

 // IfMatch: "", 

 //}, 

 }

OnlyOffice specific settings

OnlyOffice has some specific settings. We should support them.

disable chat https://github.com/cs3org/reva/blob/b9486a8e3668a6e105fa11b33d0411e068017f27/pkg/app/provider/wopi/wopi.go#L261-L263
language / locale https://github.com/cs3org/reva/blob/b9486a8e3668a6e105fa11b33d0411e068017f27/pkg/app/provider/wopi/wopi.go#L256-L260
force Desktop mode https://github.com/owncloud/enterprise/issues/6131
remove back button: https://api.onlyoffice.com/editors/wopi/restapi/checkfileinfo#BreadcrumbFolderUrl should be removed / empty (from https://github.com/owncloud/enterprise/issues/5923#issuecomment-1693263419)

support wopi proxy

Support for wopi proxy, see

https://github.com/cs3org/wopiserver/blob/40f2abba523a553b4791a3b3a4a23b5f2c0c1041/src/core/wopiutils.py#L173-L176

check user logic

cs3-wopi-server/pkg/internal/app/wopiinfo.go

Lines 76 to 100 in 77cd0ec

 // user logic from reva wopi driver #TODO: refactor 

 var isPublicShare bool = false 

 if wopiContext.User != nil { 

 if wopiContext.User.Id.Type == userv1beta1.UserType_USER_TYPE_LIGHTWEIGHT { 

 fileInfo.UserID = statRes.Info.Owner.OpaqueId + "@" + statRes.Info.Owner.Idp 

 } else { 

 fileInfo.UserID = wopiContext.User.Id.OpaqueId + "@" + wopiContext.User.Id.Idp 

 } 

 if wopiContext.User.Opaque != nil { 

 if _, ok := wopiContext.User.Opaque.Map["public-share-role"]; ok { 

 isPublicShare = true 

 } 

 } 

 if !isPublicShare { 

 fileInfo.UserFriendlyName = wopiContext.User.Username 

 fileInfo.UserID = wopiContext.User.Id.OpaqueId + "@" + wopiContext.User.Id.Idp 

 } 

 } 

 if wopiContext.User == nil || isPublicShare { 

 randomID, _ := uuid.NewUUID() 

 fileInfo.UserID = "guest-" + randomID.String() 

 fileInfo.UserFriendlyName = "Guest " + randomID.String() 

 fileInfo.IsAnonymousUser = true 

 }

	case "RENAME_FILE":
	// https://docs.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/rest/files/renamefile
	http.Error(w, http.StatusText(http.StatusNotImplemented), http.StatusNotImplemented)

	CS3api: CS3api{
	GatewayServiceName: "com.owncloud.api.gateway",
	CS3DataGatewayInsecure: true, // TODO: this should have a secure default
	},

	WopiApp: WopiApp{
	Addr: "https://127.0.0.1:8080",
	Insecure: true, // TODO: this should have a secure default
	},

	// TODO: the access token shouldn't be needed
	httpReq.Header.Add("x-access-token", token)

	// TODO: better mechanism for the upload while locked, relies on patch in REVA
	//if lockID, ok := ctxpkg.ContextGetLockID(ctx); ok {
	// httpReq.Header.Add("X-Lock-Id", lockID)
	//}

	// Lock returns a WOPI lock or performs an unlock and relock
	// https://docs.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/rest/files/lock
	// https://docs.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/rest/files/unlockandrelock
	func Lock(app demoApp, w http.ResponseWriter, r http.Request) {
	ctx := r.Context()
	wopiContext, _ := WopiContextFromCtx(ctx)

	// TODO: handle un- and relock

	// RefreshLock refreshes a provided lock for 30 minutes
	// https://docs.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/rest/files/refreshlock
	func RefreshLock(app demoApp, w http.ResponseWriter, r http.Request) {
	// TODO: implement
	http.Error(w, http.StatusText(http.StatusNotImplemented), http.StatusNotImplemented)
	}

	// LoggerFromConfig initializes a service-specific logger instance.
	func Configure(name string) log.Logger {
	return log.NewLogger(
	log.Name(name),
	log.Level("debug"), // TODO: this should be configurable
	log.Pretty(true), // TODO: this should be configurable
	log.Color(true), // TODO: this should be configurable
	log.File(""), // TODO: this should be configurable
	)
	}

	case "PUT_RELATIVE":
	// https://docs.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/rest/files/putrelativefile
	http.Error(w, http.StatusText(http.StatusNotImplemented), http.StatusNotImplemented)

	if resp.Lock != nil {
	if resp.Lock.LockId != lockID {
	w.Header().Set(HeaderWopiLock, resp.Lock.LockId)
	http.Error(w, http.StatusText(http.StatusConflict), http.StatusConflict)
	return
	}

	// TODO: according to the spec we need to treat this as a RefreshLock

	http.Error(w, http.StatusText(http.StatusOK), http.StatusOK)
	return
	}

	req := &providerv1beta1.InitiateFileUploadRequest{
	Ref: ref,
	LockId: lockID,
	// TODO: if-match
	//Options: &providerv1beta1.InitiateFileUploadRequest_IfMatch{
	// IfMatch: "",
	//},
	}

	// user logic from reva wopi driver #TODO: refactor
	var isPublicShare bool = false
	if wopiContext.User != nil {
	if wopiContext.User.Id.Type == userv1beta1.UserType_USER_TYPE_LIGHTWEIGHT {
	fileInfo.UserID = statRes.Info.Owner.OpaqueId + "@" + statRes.Info.Owner.Idp
	} else {
	fileInfo.UserID = wopiContext.User.Id.OpaqueId + "@" + wopiContext.User.Id.Idp
	}

	if wopiContext.User.Opaque != nil {
	if _, ok := wopiContext.User.Opaque.Map["public-share-role"]; ok {
	isPublicShare = true
	}
	}
	if !isPublicShare {
	fileInfo.UserFriendlyName = wopiContext.User.Username
	fileInfo.UserID = wopiContext.User.Id.OpaqueId + "@" + wopiContext.User.Id.Idp
	}
	}
	if wopiContext.User == nil \|\| isPublicShare {
	randomID, _ := uuid.NewUUID()
	fileInfo.UserID = "guest-" + randomID.String()
	fileInfo.UserFriendlyName = "Guest " + randomID.String()
	fileInfo.IsAnonymousUser = true
	}

wkloucek / cs3-wopi-server Goto Github PK

cs3-wopi-server's People

Contributors

Watchers

Forkers

cs3-wopi-server's Issues

Recommend Projects

Recommend Topics

Recommend Org