-
Notifications
You must be signed in to change notification settings - Fork 5.3k
feat(backend): implement proxy cache repository filter API #23527
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
stonezdj
wants to merge
1
commit into
goharbor:main
Choose a base branch
from
stonezdj:feature/proxy-cache-filter-backend
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| // Copyright Project Harbor 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 pattern | ||
|
|
||
| import ( | ||
| "regexp" | ||
| "strings" | ||
|
|
||
| "github.com/bmatcuk/doublestar" | ||
|
|
||
| "github.com/goharbor/harbor/src/lib/errors" | ||
| ) | ||
|
|
||
| const ( | ||
| // KindRegex indicates regular expression pattern matching | ||
| KindRegex = "regex" | ||
| // KindDoublestar indicates doublestar (glob) pattern matching | ||
| KindDoublestar = "doublestar" | ||
| ) | ||
|
|
||
| // RepositoryFilter represents a repository filter configuration with pattern and kind | ||
| type RepositoryFilter struct { | ||
| // Filter is the pattern expression to match against | ||
| Filter string | ||
| // Kind is the type of pattern matching: "regex" or "doublestar" | ||
| Kind string | ||
| } | ||
|
|
||
| // NewRepositoryFilter creates a RepositoryFilter from separate pattern and kind strings. | ||
| // If kind is empty, it defaults to KindDoublestar. | ||
| func NewRepositoryFilter(filterPattern, kind string) *RepositoryFilter { | ||
| return &RepositoryFilter{ | ||
| Filter: strings.TrimSpace(filterPattern), | ||
| Kind: strings.TrimSpace(kind), | ||
| } | ||
| } | ||
|
|
||
| // Match returns true if the value matches the filter pattern. | ||
| // Returns true if the filter is empty. | ||
| func (rf *RepositoryFilter) Match(value string) (bool, error) { | ||
| if rf == nil || rf.Filter == "" { | ||
| return true, nil | ||
| } | ||
| matcher := NewMatcher(rf.Kind) | ||
| return matcher.Match(value, rf.Filter) | ||
| } | ||
|
|
||
| // ValidateRepositoryFilter validates the repository filter kind and pattern. | ||
| // Empty pattern is valid and means all repositories are allowed. | ||
| func ValidateRepositoryFilter(filterPattern, kind string) error { | ||
| rf := NewRepositoryFilter(filterPattern, kind) | ||
| if rf.Kind != "" && rf.Kind != KindRegex && rf.Kind != KindDoublestar { | ||
| return errors.Errorf("unsupported repository filter kind %q", kind) | ||
| } | ||
| _, err := rf.Match("") | ||
| return err | ||
| } | ||
|
|
||
| // Matcher is an interface for matching strings against patterns | ||
| type Matcher interface { | ||
| // Match returns true if the value matches the pattern | ||
| Match(value, pattern string) (bool, error) | ||
| } | ||
|
|
||
| // RegexMatcher implements Matcher using regular expressions | ||
| type RegexMatcher struct{} | ||
|
|
||
| // Match matches value against a regular expression pattern | ||
| func (r *RegexMatcher) Match(value, pattern string) (bool, error) { | ||
| pattern = strings.TrimSpace(pattern) | ||
| if pattern == "" { | ||
| return true, nil | ||
| } | ||
| re, err := regexp.Compile(pattern) | ||
| if err != nil { | ||
| return false, err | ||
| } | ||
| match := re.FindStringIndex(value) | ||
| return match != nil && match[0] == 0 && match[1] == len(value), nil | ||
| } | ||
|
|
||
| // DoublestarMatcher implements Matcher using doublestar (glob) patterns | ||
| type DoublestarMatcher struct{} | ||
|
|
||
| // Match matches value against a doublestar (glob) pattern | ||
| func (d *DoublestarMatcher) Match(value, pattern string) (bool, error) { | ||
| pattern = strings.TrimSpace(pattern) | ||
| if pattern == "" { | ||
| return true, nil | ||
| } | ||
| return doublestar.Match(pattern, value) | ||
| } | ||
|
|
||
| // NewMatcher creates a new Matcher based on the specified kind. | ||
| // Defaults to KindDoublestar when kind is empty or unrecognised. | ||
| func NewMatcher(kind string) Matcher { | ||
| switch kind { | ||
| case KindRegex: | ||
| return &RegexMatcher{} | ||
| case KindDoublestar: | ||
| fallthrough | ||
| default: | ||
| return &DoublestarMatcher{} | ||
| } | ||
| } | ||
|
Comment on lines
+1
to
+117
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FindStringIndexreturns the leftmost match, not necessarily a full-string match, so this can return false negatives.Example: pattern
a|abagainst valueab— the leftmost match isa([0,1]), so this returnsfalseeven though the pattern matches the whole string.