| /* |
| Copyright 2015 The Kubernetes Authors. |
| |
| Licensed under the Apache License, Version 2.0 (the "License"); |
| you may not use this file except in compliance with the License. |
| You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| */ |
| |
| package path |
| |
| import ( |
| "fmt" |
| "strings" |
| ) |
| |
| // NameMayNotBe specifies strings that cannot be used as names specified as path segments (like the REST API or etcd store) |
| var NameMayNotBe = []string{".", ".."} |
| |
| // NameMayNotContain specifies substrings that cannot be used in names specified as path segments (like the REST API or etcd store) |
| var NameMayNotContain = []string{"/", "%"} |
| |
| // IsValidPathSegmentName validates the name can be safely encoded as a path segment |
| func IsValidPathSegmentName(name string) []string { |
| for _, illegalName := range NameMayNotBe { |
| if name == illegalName { |
| return []string{fmt.Sprintf(`may not be '%s'`, illegalName)} |
| } |
| } |
| |
| var errors []string |
| for _, illegalContent := range NameMayNotContain { |
| if strings.Contains(name, illegalContent) { |
| errors = append(errors, fmt.Sprintf(`may not contain '%s'`, illegalContent)) |
| } |
| } |
| |
| return errors |
| } |
| |
| // IsValidPathSegmentPrefix validates the name can be used as a prefix for a name which will be encoded as a path segment |
| // It does not check for exact matches with disallowed names, since an arbitrary suffix might make the name valid |
| func IsValidPathSegmentPrefix(name string) []string { |
| var errors []string |
| for _, illegalContent := range NameMayNotContain { |
| if strings.Contains(name, illegalContent) { |
| errors = append(errors, fmt.Sprintf(`may not contain '%s'`, illegalContent)) |
| } |
| } |
| |
| return errors |
| } |
| |
| // ValidatePathSegmentName validates the name can be safely encoded as a path segment |
| func ValidatePathSegmentName(name string, prefix bool) []string { |
| if prefix { |
| return IsValidPathSegmentPrefix(name) |
| } else { |
| return IsValidPathSegmentName(name) |
| } |
| } |