filebrowser/filemanager.go

242 lines
6.0 KiB
Go
Raw Normal View History

2017-06-20 10:40:52 +00:00
package filemanager
2017-06-24 11:12:15 +00:00
import (
2017-06-25 10:40:23 +00:00
"errors"
2017-06-24 11:12:15 +00:00
"net/http"
"regexp"
"strings"
rice "github.com/GeertJohan/go.rice"
"golang.org/x/net/webdav"
)
2017-06-25 11:53:49 +00:00
var (
// ErrDuplicated occurs when you try to create a user that already exists.
ErrDuplicated = errors.New("Duplicated user")
)
2017-06-24 11:12:15 +00:00
// FileManager is a file manager instance.
type FileManager struct {
2017-06-25 10:40:23 +00:00
*user
Assets *assets
2017-06-24 11:12:15 +00:00
// BaseURL is the path where the GUI will be accessible. It musn't end with
// a trailing slash and mustn't contain PrefixURL, if set.
2017-06-25 12:09:49 +00:00
baseURL string
2017-06-24 11:12:15 +00:00
// WebDavURL is the path where the WebDAV will be accessible. It can be set to ""
// in order to override the GUI and only use the WebDAV. It musn't end with
// a trailing slash.
2017-06-25 12:09:49 +00:00
webDavURL string
// PrefixURL is a part of the URL that is trimmed from the http.Request.URL before
// it arrives to our handlers. It may be useful when using FileManager as a middleware
// such as in caddy-filemanager plugin. It musn't end with a trailing slash.
PrefixURL string
2017-06-24 11:12:15 +00:00
// Users is a map with the different configurations for each user.
2017-06-25 10:40:23 +00:00
Users map[string]*user
2017-06-24 11:12:15 +00:00
// TODO: event-based?
BeforeSave CommandFunc
AfterSave CommandFunc
2017-06-24 11:12:15 +00:00
}
2017-06-25 10:40:23 +00:00
// user contains the configuration for each user.
type user struct {
// scope is the physical path the user has access to.
2017-06-25 10:40:23 +00:00
scope string
// fileSystem is the virtual file system the user has access.
fileSystem webdav.FileSystem
// handler handles incoming requests to the WebDAV backend.
handler *webdav.Handler
// Rules is an array of access and deny rules.
Rules []*Rule `json:"-"`
// TODO: this MUST be done in another way
StyleSheet string `json:"-"`
// These indicate if the user can perform certain actions.
AllowNew bool // Create files and folders
AllowEdit bool // Edit/rename files
AllowCommands bool // Execute commands
// Commands is the list of commands the user can execute.
Commands []string
2017-06-24 11:12:15 +00:00
}
// assets are the static and front-end assets, such as JS, CSS and HTML templates.
type assets struct {
2017-06-25 08:11:25 +00:00
requiredJS *rice.Box // JS that is always required to have in order to be usable.
Templates *rice.Box
CSS *rice.Box
JS *rice.Box
2017-06-24 11:12:15 +00:00
}
// Rule is a dissalow/allow rule.
type Rule struct {
// Regex indicates if this rule uses Regular Expressions or not.
Regex bool
// Allow indicates if this is an allow rule. Set 'false' to be a disallow rule.
Allow bool
// Path is the corresponding URL path for this rule.
Path string
// Regexp is the regular expression. Only use this when 'Regex' was set to true.
2017-06-24 11:12:15 +00:00
Regexp *regexp.Regexp
}
2017-06-25 10:40:23 +00:00
type CommandFunc func(r *http.Request, c *FileManager, u *user) error
2017-06-24 11:12:15 +00:00
2017-06-25 11:53:49 +00:00
func New(scope string) *FileManager {
2017-06-25 08:11:25 +00:00
m := &FileManager{
2017-06-25 10:40:23 +00:00
user: &user{
2017-06-25 08:11:25 +00:00
AllowCommands: true,
AllowEdit: true,
AllowNew: true,
Commands: []string{"git", "svn", "hg"},
Rules: []*Rule{{
Regex: true,
Allow: false,
Regexp: regexp.MustCompile("\\/\\..+"),
}},
},
2017-06-25 10:40:23 +00:00
Users: map[string]*user{},
BeforeSave: func(r *http.Request, c *FileManager, u *user) error { return nil },
AfterSave: func(r *http.Request, c *FileManager, u *user) error { return nil },
Assets: &assets{
2017-06-25 08:11:25 +00:00
Templates: rice.MustFindBox("./_assets/templates"),
CSS: rice.MustFindBox("./_assets/css"),
requiredJS: rice.MustFindBox("./_assets/js"),
},
}
2017-06-25 11:53:49 +00:00
m.SetScope(scope, "")
2017-06-25 08:11:25 +00:00
m.SetBaseURL("/")
m.SetWebDavURL("/webdav")
return m
}
// AbsoluteURL returns the actual URL where
// File Manager interface can be accessed.
2017-06-24 11:12:15 +00:00
func (m FileManager) AbsoluteURL() string {
2017-06-25 12:09:49 +00:00
return m.PrefixURL + m.baseURL
2017-06-24 11:12:15 +00:00
}
// AbsoluteWebDavURL returns the actual URL
// where WebDAV can be accessed.
func (m FileManager) AbsoluteWebDavURL() string {
2017-06-25 12:09:49 +00:00
return m.PrefixURL + m.webDavURL
2017-06-24 11:12:15 +00:00
}
// SetBaseURL updates the BaseURL of a File Manager
// object.
2017-06-25 08:11:25 +00:00
func (m *FileManager) SetBaseURL(url string) {
url = strings.TrimPrefix(url, "/")
url = strings.TrimSuffix(url, "/")
url = "/" + url
2017-06-25 12:09:49 +00:00
m.baseURL = strings.TrimSuffix(url, "/")
2017-06-25 08:11:25 +00:00
}
// SetWebDavURL updates the WebDavURL of a File Manager
// object and updates it's main handler.
2017-06-25 08:11:25 +00:00
func (m *FileManager) SetWebDavURL(url string) {
url = strings.TrimPrefix(url, "/")
url = strings.TrimSuffix(url, "/")
2017-06-25 12:09:49 +00:00
m.webDavURL = m.baseURL + "/" + url
2017-06-25 10:40:23 +00:00
// update base user webdav handler
m.handler = &webdav.Handler{
2017-06-25 12:09:49 +00:00
Prefix: m.webDavURL,
FileSystem: m.fileSystem,
2017-06-25 08:11:25 +00:00
LockSystem: webdav.NewMemLS(),
}
2017-06-25 10:40:23 +00:00
// update other users' handlers to match
// the new URL
for _, u := range m.Users {
u.handler = &webdav.Handler{
2017-06-25 12:09:49 +00:00
Prefix: m.webDavURL,
2017-06-25 10:40:23 +00:00
FileSystem: u.fileSystem,
LockSystem: webdav.NewMemLS(),
}
}
2017-06-25 08:11:25 +00:00
}
2017-06-25 10:21:42 +00:00
// SetScope updates a user scope and its virtual file system.
2017-06-25 10:40:23 +00:00
// If the user string is blank, it will change the base scope.
func (m *FileManager) SetScope(scope string, username string) error {
var u *user
if username == "" {
u = m.user
} else {
var ok bool
u, ok = m.Users[username]
if !ok {
return errors.New("Inexistent user")
}
}
u.scope = strings.TrimSuffix(scope, "/")
u.fileSystem = webdav.Dir(u.scope)
u.handler = &webdav.Handler{
2017-06-25 12:09:49 +00:00
Prefix: m.webDavURL,
2017-06-25 10:40:23 +00:00
FileSystem: u.fileSystem,
LockSystem: webdav.NewMemLS(),
}
return nil
}
2017-06-25 11:53:49 +00:00
// NewUser creates a new user on a File Manager struct
// which inherits its configuration from the main user.
func (m *FileManager) NewUser(username string) error {
if _, ok := m.Users[username]; ok {
return ErrDuplicated
}
m.Users[username] = &user{
scope: m.user.scope,
fileSystem: m.user.fileSystem,
handler: m.user.handler,
Rules: m.user.Rules,
AllowNew: m.user.AllowNew,
AllowEdit: m.user.AllowEdit,
AllowCommands: m.user.AllowCommands,
Commands: m.user.Commands,
}
2017-06-25 10:40:23 +00:00
2017-06-25 11:53:49 +00:00
return nil
2017-06-25 08:11:25 +00:00
}
2017-06-24 11:12:15 +00:00
// Allowed checks if the user has permission to access a directory/file.
2017-06-25 10:40:23 +00:00
func (u user) Allowed(url string) bool {
2017-06-24 11:12:15 +00:00
var rule *Rule
i := len(u.Rules) - 1
for i >= 0 {
rule = u.Rules[i]
if rule.Regex {
if rule.Regexp.MatchString(url) {
return rule.Allow
}
} else if strings.HasPrefix(url, rule.Path) {
return rule.Allow
}
i--
}
return true
}