mirrors/mostlymatter
1
0
Форкнуть 0
Код Задачи Запросы на слияние Действия Пакеты Проекты Релизы Вики Активность

Cleanup model/utils.go (#17945)

Просмотр исходного кода 
* Cleanup model/utils.go

- Removed some functions which were unsued. (The unused linter was somehow failing to catch this).
- Moved some functions inside other packages.
- Removed two duplicate instances of the same function - RemoveDuplicateStrings and UniqueStrings.
- Moved some regexes to global vars to prevent compilation every time.

```release-note
NONE
```

* fix lint

```release-note
NONE
```

* bring back unused exception

```release-note
NONE
```

* fix tests

```release-note
NONE
```

* Address review comments

```release-note
NONE
```
Этот коммит содержится в:
Agniva De Sarker
2021-07-21 13:15:29 +05:30
коммит произвёл Claudio Costa
родитель 77f9620997
Коммит 7454680be5
11 изменённых файлов: 182 добавлений и 231 удалений
Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

80
model/config.go
Просмотреть файл

@@ -1768,7 +1768,7 @@ type SupportSettings struct {
}
func (s *SupportSettings) SetDefaults() {
if !IsSafeLink(s.TermsOfServiceLink) {
if !isSafeLink(s.TermsOfServiceLink) {
*s.TermsOfServiceLink = SupportSettingsDefaultTermsOfServiceLink
}
@@ -1776,7 +1776,7 @@ func (s *SupportSettings) SetDefaults() {
s.TermsOfServiceLink = NewString(SupportSettingsDefaultTermsOfServiceLink)
}
if !IsSafeLink(s.PrivacyPolicyLink) {
if !isSafeLink(s.PrivacyPolicyLink) {
*s.PrivacyPolicyLink = ""
}
@@ -1784,7 +1784,7 @@ func (s *SupportSettings) SetDefaults() {
s.PrivacyPolicyLink = NewString(SupportSettingsDefaultPrivacyPolicyLink)
}
if !IsSafeLink(s.AboutLink) {
if !isSafeLink(s.AboutLink) {
*s.AboutLink = ""
}
@@ -1792,7 +1792,7 @@ func (s *SupportSettings) SetDefaults() {
s.AboutLink = NewString(SupportSettingsDefaultAboutLink)
}
if !IsSafeLink(s.HelpLink) {
if !isSafeLink(s.HelpLink) {
*s.HelpLink = ""
}
@@ -1800,7 +1800,7 @@ func (s *SupportSettings) SetDefaults() {
s.HelpLink = NewString(SupportSettingsDefaultHelpLink)
}
if !IsSafeLink(s.ReportAProblemLink) {
if !isSafeLink(s.ReportAProblemLink) {
*s.ReportAProblemLink = ""
}
@@ -3669,7 +3669,7 @@ func (s *ServiceSettings) isValid() *AppError {
if host == "" {
isValidHost = true
} else {
isValidHost = (net.ParseIP(host) != nil) || IsDomainName(host)
isValidHost = (net.ParseIP(host) != nil) || isDomainName(host)
}
portInt, err := strconv.Atoi(port)
if err != nil || !isValidHost || portInt < 0 || portInt > math.MaxUint16 {
@@ -3974,3 +3974,71 @@ func isTagPresent(tag string, tags []string) bool {
return false
}
// Copied from https://golang.org/src/net/dnsclient.go#L119
func isDomainName(s string) bool {
// See RFC 1035, RFC 3696.
// Presentation format has dots before every label except the first, and the
// terminal empty label is optional here because we assume fully-qualified
// (absolute) input. We must therefore reserve space for the first and last
// labels' length octets in wire format, where they are necessary and the
// maximum total length is 255.
// So our _effective_ maximum is 253, but 254 is not rejected if the last
// character is a dot.
l := len(s)
if l == 0 || l > 254 || l == 254 && s[l-1] != '.' {
return false
}
last := byte('.')
ok := false // Ok once we've seen a letter.
partlen := 0
for i := 0; i < len(s); i++ {
c := s[i]
switch {
default:
return false
case 'a' <= c && c <= 'z' || 'A' <= c && c <= 'Z' || c == '_':
ok = true
partlen++
case '0' <= c && c <= '9':
// fine
partlen++
case c == '-':
// Byte before dash cannot be dot.
if last == '.' {
return false
}
partlen++
case c == '.':
// Byte before dot cannot be dot, dash.
if last == '.' || last == '-' {
return false
}
if partlen > 63 || partlen == 0 {
return false
}
partlen = 0
}
last = c
}
if last == '-' || partlen > 63 {
return false
}
return ok
}
func isSafeLink(link *string) bool {
if link != nil {
if IsValidHttpUrl(*link) {
return true
} else if strings.HasPrefix(*link, "/") {
return true
} else {
return false
}
}
return true
}

12
model/role.go
Просмотреть файл

@@ -443,8 +443,8 @@ func (r *Role) Patch(patch *RolePatch) {
func (r *Role) MergeChannelHigherScopedPermissions(higherScopedPermissions *RolePermissions) {
mergedPermissions := []string{}
higherScopedPermissionsMap := AsStringBoolMap(higherScopedPermissions.Permissions)
rolePermissionsMap := AsStringBoolMap(r.Permissions)
higherScopedPermissionsMap := asStringBoolMap(higherScopedPermissions.Permissions)
rolePermissionsMap := asStringBoolMap(r.Permissions)
for _, cp := range AllPermissions {
if cp.Scope != PermissionScopeChannel {
@@ -950,3 +950,11 @@ func AddAncillaryPermissions(permissions []string) []string {
}
return permissions
}
func asStringBoolMap(list []string) map[string]bool {
listMap := make(map[string]bool, len(list))
for _, p := range list {
listMap[p] = true
}
return listMap
}

2
model/team.go
Просмотреть файл

@@ -235,7 +235,7 @@ func IsReservedTeamName(s string) bool {
}
func IsValidTeamName(s string) bool {
if !IsValidAlphaNum(s) {
if !isValidAlphaNum(s) {
return false
}

24
model/user.go
Просмотреть файл

@@ -931,30 +931,6 @@ func CleanUsername(username string) string {
return s
}
func IsValidUserNotifyLevel(notifyLevel string) bool {
return notifyLevel == ChannelNotifyAll ||
notifyLevel == ChannelNotifyMention ||
notifyLevel == ChannelNotifyNone
}
func IsValidPushStatusNotifyLevel(notifyLevel string) bool {
return notifyLevel == StatusOnline ||
notifyLevel == StatusAway ||
notifyLevel == StatusOffline
}
func IsValidCommentsNotifyLevel(notifyLevel string) bool {
return notifyLevel == CommentsNotifyAny ||
notifyLevel == CommentsNotifyRoot ||
notifyLevel == CommentsNotifyNever
}
func IsValidEmailBatchingInterval(emailInterval string) bool {
return emailInterval == PreferenceEmailIntervalImmediately ||
emailInterval == PreferenceEmailIntervalFifteen ||
emailInterval == PreferenceEmailIntervalHour
}
func IsValidLocale(locale string) bool {
if locale != "" {
if len(locale) > UserLocaleMaxLength {

206
model/utils.go
Просмотреть файл

@@ -16,7 +16,7 @@ import (
"net/mail"
"net/url"
"regexp"
"strconv"
"sort"
"strings"
"sync"
"time"
@@ -227,7 +227,7 @@ func GetEndOfDayMillis(thisTime time.Time, timeZoneOffset int) int64 {
}
func CopyStringMap(originalMap map[string]string) map[string]string {
copyMap := make(map[string]string)
copyMap := make(map[string]string, len(originalMap))
for k, v := range originalMap {
copyMap[k] = v
}
@@ -315,21 +315,6 @@ func StringInterfaceFromJson(data io.Reader) map[string]interface{} {
return objmap
}
func StringToJson(s string) string {
b, _ := json.Marshal(s)
return string(b)
}
func StringFromJson(data io.Reader) string {
decoder := json.NewDecoder(data)
var s string
if err := decoder.Decode(&s); err != nil {
return ""
}
return s
}
// ToJson serializes an arbitrary data type to JSON, discarding the error.
func ToJson(v interface{}) []byte {
b, _ := json.Marshal(v)
@@ -372,12 +357,12 @@ func GetServerIpAddress(iface string) string {
return ""
}
func IsLower(s string) bool {
func isLower(s string) bool {
return strings.ToLower(s) == s
}
func IsValidEmail(email string) bool {
if !IsLower(email) {
if !isLower(email) {
return false
}
@@ -422,25 +407,25 @@ func IsValidChannelIdentifier(s string) bool {
return true
}
func IsValidAlphaNum(s string) bool {
validAlphaNum := regexp.MustCompile(`^[a-z0-9]+([a-z\-0-9]+|(__)?)[a-z0-9]+$`)
var (
validAlphaNum = regexp.MustCompile(`^[a-z0-9]+([a-z\-0-9]+|(__)?)[a-z0-9]+$`)
validAlphaNumHyphenUnderscore = regexp.MustCompile(`^[a-z0-9]+([a-z\-\_0-9]+|(__)?)[a-z0-9]+$`)
validSimpleAlphaNumHyphenUnderscore = regexp.MustCompile(`^[a-zA-Z0-9\-_]+$`)
validSimpleAlphaNumHyphenUnderscorePlus = regexp.MustCompile(`^[a-zA-Z0-9+_-]+$`)
)
func isValidAlphaNum(s string) bool {
return validAlphaNum.MatchString(s)
}
func IsValidAlphaNumHyphenUnderscore(s string, withFormat bool) bool {
if withFormat {
validAlphaNumHyphenUnderscore := regexp.MustCompile(`^[a-z0-9]+([a-z\-\_0-9]+|(__)?)[a-z0-9]+$`)
return validAlphaNumHyphenUnderscore.MatchString(s)
}
validSimpleAlphaNumHyphenUnderscore := regexp.MustCompile(`^[a-zA-Z0-9\-_]+$`)
return validSimpleAlphaNumHyphenUnderscore.MatchString(s)
}
func IsValidAlphaNumHyphenUnderscorePlus(s string) bool {
validSimpleAlphaNumHyphenUnderscorePlus := regexp.MustCompile(`^[a-zA-Z0-9+_-]+$`)
return validSimpleAlphaNumHyphenUnderscorePlus.MatchString(s)
}
@@ -455,10 +440,12 @@ func Etag(parts ...interface{}) string {
return etag
}
var validHashtag = regexp.MustCompile(`^(#\pL[\pL\d\-_.]*[\pL\d])$`)
var puncStart = regexp.MustCompile(`^[^\pL\d\s#]+`)
var hashtagStart = regexp.MustCompile(`^#{2,}`)
var puncEnd = regexp.MustCompile(`[^\pL\d\s]+$`)
var (
validHashtag = regexp.MustCompile(`^(#\pL[\pL\d\-_.]*[\pL\d])$`)
puncStart = regexp.MustCompile(`^[^\pL\d\s#]+`)
hashtagStart = regexp.MustCompile(`^#{2,}`)
puncEnd = regexp.MustCompile(`[^\pL\d\s]+$`)
)
func ParseHashtags(text string) (string, string) {
words := strings.Fields(text)
@@ -511,56 +498,6 @@ func IsValidHttpUrl(rawUrl string) bool {
return true
}
func IsValidTurnOrStunServer(rawUri string) bool {
if strings.Index(rawUri, "turn:") != 0 && strings.Index(rawUri, "stun:") != 0 {
return false
}
if _, err := url.ParseRequestURI(rawUri); err != nil {
return false
}
return true
}
func IsSafeLink(link *string) bool {
if link != nil {
if IsValidHttpUrl(*link) {
return true
} else if strings.HasPrefix(*link, "/") {
return true
} else {
return false
}
}
return true
}
func IsValidWebsocketUrl(rawUrl string) bool {
if strings.Index(rawUrl, "ws://") != 0 && strings.Index(rawUrl, "wss://") != 0 {
return false
}
if _, err := url.ParseRequestURI(rawUrl); err != nil {
return false
}
return true
}
func IsValidTrueOrFalseString(value string) bool {
return value == "true" || value == "false"
}
func IsValidNumberString(value string) bool {
if _, err := strconv.Atoi(value); err != nil {
return false
}
return true
}
func IsValidId(value string) bool {
if len(value) != 26 {
return false
@@ -575,73 +512,24 @@ func IsValidId(value string) bool {
return true
}
// Copied from https://golang.org/src/net/dnsclient.go#L119
func IsDomainName(s string) bool {
// See RFC 1035, RFC 3696.
// Presentation format has dots before every label except the first, and the
// terminal empty label is optional here because we assume fully-qualified
// (absolute) input. We must therefore reserve space for the first and last
// labels' length octets in wire format, where they are necessary and the
// maximum total length is 255.
// So our _effective_ maximum is 253, but 254 is not rejected if the last
// character is a dot.
l := len(s)
if l == 0 || l > 254 || l == 254 && s[l-1] != '.' {
return false
}
last := byte('.')
ok := false // Ok once we've seen a letter.
partlen := 0
for i := 0; i < len(s); i++ {
c := s[i]
switch {
default:
return false
case 'a' <= c && c <= 'z' || 'A' <= c && c <= 'Z' || c == '_':
ok = true
partlen++
case '0' <= c && c <= '9':
// fine
partlen++
case c == '-':
// Byte before dash cannot be dot.
if last == '.' {
return false
}
partlen++
case c == '.':
// Byte before dot cannot be dot, dash.
if last == '.' || last == '-' {
return false
}
if partlen > 63 || partlen == 0 {
return false
}
partlen = 0
}
last = c
}
if last == '-' || partlen > 63 {
return false
}
return ok
}
// RemoveDuplicateStrings does an in-place removal of duplicate strings
// from the input slice. The original slice gets modified.
func RemoveDuplicateStrings(in []string) []string {
out := []string{}
seen := make(map[string]bool, len(in))
for _, item := range in {
if !seen[item] {
out = append(out, item)
seen[item] = true
}
// In-place de-dup.
// Copied from https://github.com/golang/go/wiki/SliceTricks#in-place-deduplicate-comparable
if len(in) == 0 {
return in
}
return out
sort.Strings(in)
j := 0
for i := 1; i < len(in); i++ {
if in[j] == in[i] {
continue
}
j++
in[j] = in[i]
}
return in[:j+1]
}
func GetPreferredTimezone(timezone StringMap) string {
@@ -652,19 +540,6 @@ func GetPreferredTimezone(timezone StringMap) string {
return timezone["manualTimezone"]
}
// IsSamlFile checks if filename is a SAML file.
func IsSamlFile(saml *SamlSettings, filename string) bool {
return filename == *saml.PublicCertificateFile || filename == *saml.PrivateKeyFile || filename == *saml.IdpCertificateFile
}
func AsStringBoolMap(list []string) map[string]bool {
listMap := map[string]bool{}
for _, p := range list {
listMap[p] = true
}
return listMap
}
// SanitizeUnicode will remove undesirable Unicode characters from a string.
func SanitizeUnicode(s string) string {
return strings.Map(filterBlocklist, s)
@@ -709,18 +584,3 @@ func filterBlocklist(r rune) rune {
return r
}
// UniqueStrings returns a unique subset of the string slice provided.
func UniqueStrings(input []string) []string {
u := make([]string, 0, len(input))
m := make(map[string]bool)
for _, val := range input {
if _, ok := m[val]; !ok {
m[val] = true
u = append(u, val)
}
}
return u
}

6
model/utils_test.go
Просмотреть файл

@@ -338,7 +338,7 @@ func TestIsValidAlphaNum(t *testing.T) {
}
for _, tc := range cases {
actual := IsValidAlphaNum(tc.Input)
actual := isValidAlphaNum(tc.Input)
require.Equalf(t, actual, tc.Result, "case: %v\tshould returned: %#v", tc, tc.Result)
}
}
@@ -945,7 +945,7 @@ func TestIsValidHttpUrl(t *testing.T) {
}
}
func TestUniqueStrings(t *testing.T) {
func TestRemoveDuplicateStrings(t *testing.T) {
cases := []struct {
Input []string
Result []string
@@ -973,7 +973,7 @@ func TestUniqueStrings(t *testing.T) {
}
for _, tc := range cases {
actual := UniqueStrings(tc.Input)
actual := RemoveDuplicateStrings(tc.Input)
require.Equalf(t, actual, tc.Result, "case: %v\tshould returned: %#v", tc, tc.Result)
}
}