From e77d971259dc7ee448f47ad46594cb697c367a4a Mon Sep 17 00:00:00 2001 From: Patrick Pacher Date: Tue, 14 Apr 2020 11:23:15 +0200 Subject: [PATCH] Rename filterlist to filterlists --- intel/entity.go | 18 +++++++++--------- intel/{filterlist => filterlists}/bloom.go | 4 ++-- .../cache_version.go | 2 +- intel/{filterlist => filterlists}/database.go | 4 ++-- intel/{filterlist => filterlists}/decoder.go | 4 ++-- intel/{filterlist => filterlists}/index.go | 6 +++--- intel/{filterlist => filterlists}/keys.go | 6 +++--- intel/{filterlist => filterlists}/lookup.go | 6 +++--- .../{filterlist => filterlists}/lookup_map.go | 2 +- .../{filterlist => filterlists}/lookup_test.go | 4 ++-- intel/{filterlist => filterlists}/module.go | 4 ++-- .../{filterlist => filterlists}/module_test.go | 2 +- intel/{filterlist => filterlists}/record.go | 2 +- intel/{filterlist => filterlists}/updater.go | 8 ++++---- intel/module.go | 2 +- profile/config-update.go | 4 ++-- profile/profile.go | 4 ++-- 17 files changed, 41 insertions(+), 41 deletions(-) rename intel/{filterlist => filterlists}/bloom.go (97%) rename intel/{filterlist => filterlists}/cache_version.go (98%) rename intel/{filterlist => filterlists}/database.go (98%) rename intel/{filterlist => filterlists}/decoder.go (97%) rename intel/{filterlist => filterlists}/index.go (98%) rename intel/{filterlist => filterlists}/keys.go (82%) rename intel/{filterlist => filterlists}/lookup.go (94%) rename intel/{filterlist => filterlists}/lookup_map.go (96%) rename intel/{filterlist => filterlists}/lookup_test.go (96%) rename intel/{filterlist => filterlists}/module.go (95%) rename intel/{filterlist => filterlists}/module_test.go (98%) rename intel/{filterlist => filterlists}/record.go (96%) rename intel/{filterlist => filterlists}/updater.go (96%) diff --git a/intel/entity.go b/intel/entity.go index f4aba5f8..d1544676 100644 --- a/intel/entity.go +++ b/intel/entity.go @@ -8,7 +8,7 @@ import ( "sync" "github.com/safing/portbase/log" - "github.com/safing/portmaster/intel/filterlist" + "github.com/safing/portmaster/intel/filterlists" "github.com/safing/portmaster/intel/geoip" "github.com/safing/portmaster/network/netutils" "github.com/safing/portmaster/status" @@ -35,7 +35,7 @@ type Entity struct { fetchLocationOnce sync.Once Lists []string - ListsMap filterlist.LookupMap + ListsMap filterlists.LookupMap // we only load each data above at most once loadDomainListOnce sync.Once @@ -231,7 +231,7 @@ func (e *Entity) getDomainLists() { e.loadDomainListOnce.Do(func() { log.Debugf("intel: loading domain list for %s", domain) - list, err := filterlist.LookupDomain(domain) + list, err := filterlists.LookupDomain(domain) if err != nil { log.Errorf("intel: failed to get domain blocklists for %s: %s", domain, err) e.loadDomainListOnce = sync.Once{} @@ -255,7 +255,7 @@ func (e *Entity) getASNLists() { log.Debugf("intel: loading ASN list for %d", asn) e.loadAsnListOnce.Do(func() { - list, err := filterlist.LookupASNString(fmt.Sprintf("%d", asn)) + list, err := filterlists.LookupASNString(fmt.Sprintf("%d", asn)) if err != nil { log.Errorf("intel: failed to get ASN blocklist for %d: %s", asn, err) e.loadAsnListOnce = sync.Once{} @@ -279,7 +279,7 @@ func (e *Entity) getCountryLists() { log.Debugf("intel: loading country list for %s", country) e.loadCoutryListOnce.Do(func() { - list, err := filterlist.LookupCountry(country) + list, err := filterlists.LookupCountry(country) if err != nil { log.Errorf("intel: failed to load country blocklist for %s: %s", country, err) e.loadCoutryListOnce = sync.Once{} @@ -312,7 +312,7 @@ func (e *Entity) getIPLists() { log.Debugf("intel: loading IP list for %s", ip) e.loadIPListOnce.Do(func() { - list, err := filterlist.LookupIP(ip) + list, err := filterlists.LookupIP(ip) if err != nil { log.Errorf("intel: failed to get IP blocklist for %s: %s", ip.String(), err) @@ -335,7 +335,7 @@ func (e *Entity) GetLists() ([]string, bool) { } // GetListsMap is like GetLists but returns a lookup map for list IDs. -func (e *Entity) GetListsMap() (filterlist.LookupMap, bool) { +func (e *Entity) GetListsMap() (filterlists.LookupMap, bool) { e.getLists() if e.ListsMap == nil { @@ -361,8 +361,8 @@ func mergeStringList(a, b []string) []string { return res } -func buildLookupMap(l []string) filterlist.LookupMap { - m := make(filterlist.LookupMap, len(l)) +func buildLookupMap(l []string) filterlists.LookupMap { + m := make(filterlists.LookupMap, len(l)) for _, s := range l { m[s] = struct{}{} diff --git a/intel/filterlist/bloom.go b/intel/filterlists/bloom.go similarity index 97% rename from intel/filterlist/bloom.go rename to intel/filterlists/bloom.go index aa6e182b..4df4f70a 100644 --- a/intel/filterlist/bloom.go +++ b/intel/filterlists/bloom.go @@ -1,4 +1,4 @@ -package filterlist +package filterlists import ( "encoding/hex" @@ -59,7 +59,7 @@ func (bf *scopedBloom) getBloomForType(entityType string) (*ring.Ring, error) { case "country": r = bf.country default: - return nil, fmt.Errorf("unsupported filterlist entity type %q", entityType) + return nil, fmt.Errorf("unsupported filterlists entity type %q", entityType) } return r, nil diff --git a/intel/filterlist/cache_version.go b/intel/filterlists/cache_version.go similarity index 98% rename from intel/filterlist/cache_version.go rename to intel/filterlists/cache_version.go index cac9d9fd..c48d8bd4 100644 --- a/intel/filterlist/cache_version.go +++ b/intel/filterlists/cache_version.go @@ -1,4 +1,4 @@ -package filterlist +package filterlists import ( "fmt" diff --git a/intel/filterlist/database.go b/intel/filterlists/database.go similarity index 98% rename from intel/filterlist/database.go rename to intel/filterlists/database.go index c4915f4b..cee940f2 100644 --- a/intel/filterlist/database.go +++ b/intel/filterlists/database.go @@ -1,4 +1,4 @@ -package filterlist +package filterlists import ( "context" @@ -78,7 +78,7 @@ func isLoaded() bool { } // processListFile opens the latest version of f ile and decodes it's DSDL -// content. It calls processEntry for each decoded filterlist entry. +// content. It calls processEntry for each decoded filterlists entry. func processListFile(ctx context.Context, filter *scopedBloom, file *updater.File) error { f, err := os.Open(file.Path()) if err != nil { diff --git a/intel/filterlist/decoder.go b/intel/filterlists/decoder.go similarity index 97% rename from intel/filterlist/decoder.go rename to intel/filterlists/decoder.go index 566014b0..49133790 100644 --- a/intel/filterlist/decoder.go +++ b/intel/filterlists/decoder.go @@ -1,4 +1,4 @@ -package filterlist +package filterlists import ( "compress/gzip" @@ -17,7 +17,7 @@ type listEntry struct { Type string `json:"type"` } -// decodeFile decodes a DSDL filterlist file and sends decoded entities to +// decodeFile decodes a DSDL filterlists file and sends decoded entities to // ch. It blocks until all list entries have been consumed or ctx is cancelled. func decodeFile(ctx context.Context, r io.Reader, ch chan<- *listEntry) error { compressed, format, err := parseHeader(r) diff --git a/intel/filterlist/index.go b/intel/filterlists/index.go similarity index 98% rename from intel/filterlist/index.go rename to intel/filterlists/index.go index 67ac34f0..ae436494 100644 --- a/intel/filterlist/index.go +++ b/intel/filterlists/index.go @@ -1,4 +1,4 @@ -package filterlist +package filterlists import ( "fmt" @@ -37,7 +37,7 @@ type Category struct { Description string `json:"description,omitempty"` } -// Source defines an external filterlist source. +// Source defines an external filterlists source. type Source struct { // ID is a unique ID for the source. Entities always reference the // sources they have been observed in using this ID. Refer to the @@ -56,7 +56,7 @@ type Source struct { // to the Type definition for more information and well-known types. Type string `json:"type"` - // URL points to the filterlist file. + // URL points to the filterlists file. URL string `json:"url"` // Category holds the unique ID of a category the source belongs to. Since diff --git a/intel/filterlist/keys.go b/intel/filterlists/keys.go similarity index 82% rename from intel/filterlist/keys.go rename to intel/filterlists/keys.go index 635acb15..9ecffa46 100644 --- a/intel/filterlist/keys.go +++ b/intel/filterlists/keys.go @@ -1,15 +1,15 @@ -package filterlist +package filterlists const ( cacheDBPrefix = "cache:intel/filterlists" // filterListCacheVersionKey is used to store the highest version - // of a filterlist file (base, intermediate or urgent) in the + // of a filterlists file (base, intermediate or urgent) in the // cache database. It's used to decide if the cache database and // bloomfilters need to be resetted and rebuilt. filterListCacheVersionKey = cacheDBPrefix + "/version" - // filterListIndexKey is used to store the filterlist index. + // filterListIndexKey is used to store the filterlists index. filterListIndexKey = cacheDBPrefix + "/index" // filterListKeyPrefix is the prefix inside that cache database diff --git a/intel/filterlist/lookup.go b/intel/filterlists/lookup.go similarity index 94% rename from intel/filterlist/lookup.go rename to intel/filterlists/lookup.go index ee592eeb..8304efb3 100644 --- a/intel/filterlist/lookup.go +++ b/intel/filterlists/lookup.go @@ -1,4 +1,4 @@ -package filterlist +package filterlists import ( "errors" @@ -18,7 +18,7 @@ import ( func lookupBlockLists(entity, value string) ([]string, error) { key := makeListCacheKey(entity, value) if !isLoaded() { - log.Warningf("intel/filterlist: not searching for %s because filterlists not loaded", key) + log.Warningf("intel/filterlists: not searching for %s because filterlists not loaded", key) // filterLists have not yet been loaded so // there's no point querying into the cache // database. @@ -32,7 +32,7 @@ func lookupBlockLists(entity, value string) ([]string, error) { return nil, nil } - log.Debugf("intel/filterlist: searching for entries with %s", key) + log.Debugf("intel/filterlists: searching for entries with %s", key) entry, err := getEntityRecordByKey(key) if err != nil { if err == database.ErrNotFound { diff --git a/intel/filterlist/lookup_map.go b/intel/filterlists/lookup_map.go similarity index 96% rename from intel/filterlist/lookup_map.go rename to intel/filterlists/lookup_map.go index 0828e41e..5a161c91 100644 --- a/intel/filterlist/lookup_map.go +++ b/intel/filterlists/lookup_map.go @@ -1,4 +1,4 @@ -package filterlist +package filterlists import "strings" diff --git a/intel/filterlist/lookup_test.go b/intel/filterlists/lookup_test.go similarity index 96% rename from intel/filterlist/lookup_test.go rename to intel/filterlists/lookup_test.go index b975a57a..0a2e9220 100644 --- a/intel/filterlist/lookup_test.go +++ b/intel/filterlists/lookup_test.go @@ -1,4 +1,4 @@ -package filterlist +package filterlists /* @@ -63,7 +63,7 @@ func TestLookupDomain(t *testing.T) { } // testMarkNotLoaded ensures that functions believe -// filterlist are not yet loaded. It returns a +// filterlists are not yet loaded. It returns a // func that restores the previous state. func testMarkNotLoaded() func() { if isLoaded() { diff --git a/intel/filterlist/module.go b/intel/filterlists/module.go similarity index 95% rename from intel/filterlist/module.go rename to intel/filterlists/module.go index e6348723..14805f69 100644 --- a/intel/filterlist/module.go +++ b/intel/filterlists/module.go @@ -1,4 +1,4 @@ -package filterlist +package filterlists import ( "context" @@ -23,7 +23,7 @@ var ( ) func init() { - module = modules.Register("filterlist", prep, start, nil, "core", "netenv") + module = modules.Register("filterlists", prep, start, nil, "core", "netenv") } func prep() error { diff --git a/intel/filterlist/module_test.go b/intel/filterlists/module_test.go similarity index 98% rename from intel/filterlist/module_test.go rename to intel/filterlists/module_test.go index 956597e2..df157355 100644 --- a/intel/filterlist/module_test.go +++ b/intel/filterlists/module_test.go @@ -1,4 +1,4 @@ -package filterlist +package filterlists /* func TestMain(m *testing.M) { diff --git a/intel/filterlist/record.go b/intel/filterlists/record.go similarity index 96% rename from intel/filterlist/record.go rename to intel/filterlists/record.go index 23cd7cf9..8865ce9d 100644 --- a/intel/filterlist/record.go +++ b/intel/filterlists/record.go @@ -1,4 +1,4 @@ -package filterlist +package filterlists import ( "fmt" diff --git a/intel/filterlist/updater.go b/intel/filterlists/updater.go similarity index 96% rename from intel/filterlist/updater.go rename to intel/filterlists/updater.go index 8593730e..a9c0322b 100644 --- a/intel/filterlist/updater.go +++ b/intel/filterlists/updater.go @@ -1,4 +1,4 @@ -package filterlist +package filterlists import ( "context" @@ -97,11 +97,11 @@ func performUpdate(ctx context.Context) error { } // if we processed the base file we need to perform - // some cleanup on filterlist entities that have not + // some cleanup on filterlists entities that have not // been updated now. Once we are done, start a worker // for that purpose. if cleanupRequired { - defer module.StartWorker("filterlist:cleanup", removeAllObsoleteFilterEntries) + defer module.StartWorker("filterlists:cleanup", removeAllObsoleteFilterEntries) } // try to save the highest version of our files. @@ -166,7 +166,7 @@ func removeObsoleteFilterEntries(batchSize int) (bool, error) { return cnt < batchSize, nil } -// getUpgradableFiles returns a slice of filterlist files +// getUpgradableFiles returns a slice of filterlists files // that should be updated. The files MUST be updated and // processed in the returned order! func getUpgradableFiles() ([]*updater.File, error) { diff --git a/intel/module.go b/intel/module.go index aeb231e0..8c30985e 100644 --- a/intel/module.go +++ b/intel/module.go @@ -10,5 +10,5 @@ var ( ) func init() { - Module = modules.Register("intel", nil, nil, nil, "geoip", "filterlist") + Module = modules.Register("intel", nil, nil, nil, "geoip", "filterlists") } diff --git a/profile/config-update.go b/profile/config-update.go index 6d32fa1c..15e62b8e 100644 --- a/profile/config-update.go +++ b/profile/config-update.go @@ -5,7 +5,7 @@ import ( "fmt" "sync" - "github.com/safing/portmaster/intel/filterlist" + "github.com/safing/portmaster/intel/filterlists" "github.com/safing/portmaster/profile/endpoints" ) @@ -63,7 +63,7 @@ func updateGlobalConfigProfile(ctx context.Context, data interface{}) error { } list = cfgOptionFilterLists() - cfgFilterLists, err = filterlist.ResolveListIDs(list) + cfgFilterLists, err = filterlists.ResolveListIDs(list) if err != nil { lastErr = err } diff --git a/profile/profile.go b/profile/profile.go index 13ec36a7..46e3b447 100644 --- a/profile/profile.go +++ b/profile/profile.go @@ -14,7 +14,7 @@ import ( "github.com/safing/portbase/config" "github.com/safing/portbase/database/record" - "github.com/safing/portmaster/intel/filterlist" + "github.com/safing/portmaster/intel/filterlists" "github.com/safing/portmaster/profile/endpoints" ) @@ -144,7 +144,7 @@ func (profile *Profile) parseConfig() error { list, ok = profile.configPerspective.GetAsStringArray(CfgOptionFilterListKey) if ok { - profile.filterListIDs, err = filterlist.ResolveListIDs(list) + profile.filterListIDs, err = filterlists.ResolveListIDs(list) if err != nil { lastErr = err }