mirror of
https://github.com/mattermost/mattermost.git
synced 2026-02-03 20:40:00 -05:00
17f211c393
* clean up plugins GoDoc: - eliminate plugin.NewBlankContext() as unnecessary - export ValidIdRegex as a string vs. the less readable var - add/update various documentation strings - hide everything by default, except where used by client plugins or the mattermost-server. The exception to this rule are the `*(Args|Returns)` structs which must be public for go-plugin, but are now prefixed with `Z_` with a warning not to use. - include a top-level example to get plugin authors started This is not a breaking change for existing plugins compiled against plugins-v2. * remove commented out ServeHTTPResponseWriter * update examples to match developer docs * add missing plugin/doc.go license header
39 lines
888 B
Go
39 lines
888 B
Go
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
|
|
// See License.txt for license information.
|
|
|
|
package plugin
|
|
|
|
import (
|
|
"regexp"
|
|
"unicode/utf8"
|
|
)
|
|
|
|
const (
|
|
MinIdLength = 3
|
|
MaxIdLength = 190
|
|
ValidIdRegex = `^[a-zA-Z0-9-_\.]+$`
|
|
)
|
|
|
|
// ValidId constrains the set of valid plugin identifiers:
|
|
// ^[a-zA-Z0-9-_\.]+
|
|
var validId *regexp.Regexp
|
|
|
|
func init() {
|
|
validId = regexp.MustCompile(ValidIdRegex)
|
|
}
|
|
|
|
// IsValidId verifies that the plugin id has a minimum length of 3, maximum length of 190, and
|
|
// contains only alphanumeric characters, dashes, underscores and periods.
|
|
//
|
|
// These constraints are necessary since the plugin id is used as part of a filesystem path.
|
|
func IsValidId(id string) bool {
|
|
if utf8.RuneCountInString(id) < MinIdLength {
|
|
return false
|
|
}
|
|
|
|
if utf8.RuneCountInString(id) > MaxIdLength {
|
|
return false
|
|
}
|
|
|
|
return validId.MatchString(id)
|
|
}
|