| // Licensed to Apache Software Foundation (ASF) under one or more contributor |
| // license agreements. See the NOTICE file distributed with |
| // this work for additional information regarding copyright |
| // ownership. Apache Software Foundation (ASF) licenses this file to you 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 header |
| |
| import ( |
| "bufio" |
| "fmt" |
| "os" |
| "regexp" |
| "strconv" |
| "strings" |
| "time" |
| |
| assets "github.com/apache/skywalking-eyes/license-eye" |
| "github.com/apache/skywalking-eyes/license-eye/internal/logger" |
| "github.com/apache/skywalking-eyes/license-eye/pkg/license" |
| |
| "github.com/bmatcuk/doublestar/v2" |
| ) |
| |
| type CommentOption string |
| |
| var ( |
| Always CommentOption = "always" |
| Never CommentOption = "never" |
| OnFailure CommentOption = "on-failure" |
| |
| ASFNames = regexp.MustCompile("(?i)(the )?(Apache Software Foundation|ASF)") |
| ) |
| |
| type LicenseConfig struct { |
| SpdxID string `yaml:"spdx-id"` |
| CopyrightOwner string `yaml:"copyright-owner"` |
| Content string `yaml:"content"` |
| Pattern string `yaml:"pattern"` |
| } |
| |
| type ConfigHeader struct { |
| License LicenseConfig `yaml:"license"` |
| Pattern string `yaml:"pattern"` |
| Paths []string `yaml:"paths"` |
| PathsIgnore []string `yaml:"paths-ignore"` |
| Comment CommentOption `yaml:"comment"` |
| } |
| |
| // NormalizedLicense returns the normalized string of the license content, |
| // "normalized" means the linebreaks and Punctuations are all trimmed. |
| func (config *ConfigHeader) NormalizedLicense() string { |
| return license.Normalize(config.GetLicenseContent()) |
| } |
| |
| func (config *ConfigHeader) NormalizedPattern() *regexp.Regexp { |
| pattern := config.Pattern |
| |
| if pattern == "" || strings.TrimSpace(pattern) == "" { |
| return nil |
| } |
| |
| pattern = license.NormalizePattern(pattern) |
| |
| return regexp.MustCompile("(?i).*" + pattern + ".*") |
| } |
| |
| func (config *ConfigHeader) ShouldIgnore(path string) (bool, error) { |
| for _, ignorePattern := range config.PathsIgnore { |
| if matched, err := doublestar.Match(ignorePattern, path); matched || err != nil { |
| return matched, err |
| } |
| } |
| |
| if stat, err := os.Stat(path); err == nil { |
| for _, ignorePattern := range config.PathsIgnore { |
| ignorePattern = strings.TrimRight(ignorePattern, "/") |
| if strings.HasPrefix(path, ignorePattern+"/") || stat.Name() == ignorePattern { |
| return true, nil |
| } |
| } |
| } |
| |
| return false, nil |
| } |
| |
| func (config *ConfigHeader) Finalize() error { |
| if len(config.Paths) == 0 { |
| config.Paths = []string{"**"} |
| } |
| |
| config.PathsIgnore = append(config.PathsIgnore, ".git", "**/*.txt") |
| |
| if file, err := os.Open(".gitignore"); err == nil { |
| defer func() { _ = file.Close() }() |
| |
| for scanner := bufio.NewScanner(file); scanner.Scan(); { |
| line := scanner.Text() |
| if strings.HasPrefix(line, "#") || strings.TrimSpace(line) == "" { |
| continue |
| } |
| logger.Log.Debugln("Add ignore path from .gitignore:", line) |
| config.PathsIgnore = append(config.PathsIgnore, strings.TrimSpace(line)) |
| } |
| } |
| |
| logger.Log.Debugln("License header is:", config.NormalizedLicense()) |
| if p := config.NormalizedPattern(); p != nil { |
| logger.Log.Debugln("Pattern is:", p) |
| } |
| |
| return nil |
| } |
| |
| func (config *ConfigHeader) GetLicenseContent() string { |
| if c := strings.TrimSpace(config.License.Content); c != "" { |
| return c |
| } |
| c, err := readLicenseFromSpdx(config) |
| if err != nil { |
| logger.Log.Warnln(err) |
| return "" |
| } |
| return c |
| } |
| |
| func readLicenseFromSpdx(config *ConfigHeader) (string, error) { |
| spdxID, owner := config.License.SpdxID, config.License.CopyrightOwner |
| filename := fmt.Sprintf("assets/header-templates/%v.txt", spdxID) |
| |
| if spdxID == "Apache-2.0" && ASFNames.MatchString(owner) { |
| // Note that the Apache Software Foundation uses a different source header that is related to our use of a CLA. |
| // Our instructions for our project's source headers are here (https://www.apache.org/legal/src-headers.html#headers). |
| filename = "assets/header-templates/Apache-2.0-ASF.txt" |
| } |
| |
| content, err := assets.Asset(filename) |
| if err != nil { |
| return "", fmt.Errorf("failed to find a license template for spdx id %v, %w", spdxID, err) |
| } |
| template := string(content) |
| template = strings.Replace(template, "[year]", strconv.Itoa(time.Now().Year()), 1) |
| template = strings.Replace(template, "[owner]", owner, 1) |
| |
| return template, nil |
| } |