feat: add ParserConfig.DisableExternalChecks

Author: bfabio

fields.go

@@ -50,8 +50,11 @@ func validateFieldsV0(publiccode PublicCode, parser Parser, network bool) error
 	if publiccodev0.Logo != "" {
 		if _, err := isRelativePathOrURL(publiccodev0.Logo, "logo"); err != nil {
 			vr = append(vr, err)
-		} else if validLogo, err := parser.validLogo(toCodeHostingURL(publiccodev0.Logo, parser.currentBaseURL), network); !validLogo {
-			vr = append(vr, newValidationError("logo", err.Error()))
+		} else if !parser.disableExternalChecks {
+			validLogo, err := parser.validLogo(toCodeHostingURL(publiccodev0.Logo, parser.currentBaseURL), network)
+			if !validLogo {
+				vr = append(vr, newValidationError("logo", err.Error()))
+			}
 		}
 	}
 
@@ -60,8 +63,11 @@ func validateFieldsV0(publiccode PublicCode, parser Parser, network bool) error
 
 		if _, err := isRelativePathOrURL(publiccodev0.MonochromeLogo, "monochromeLogo"); err != nil {
 			vr = append(vr, err)
-		} else if validLogo, err := parser.validLogo(toCodeHostingURL(publiccodev0.MonochromeLogo, parser.currentBaseURL), network); !validLogo {
-			vr = append(vr, newValidationError("monochromeLogo", err.Error()))
+		} else if !parser.disableExternalChecks {
+			validLogo, err := parser.validLogo(toCodeHostingURL(publiccodev0.MonochromeLogo, parser.currentBaseURL), network)
+			if !validLogo {
+				vr = append(vr, newValidationError("monochromeLogo", err.Error()))
+			}
 		}
 	}
 
@@ -70,10 +76,13 @@ func validateFieldsV0(publiccode PublicCode, parser Parser, network bool) error
 
 		if _, err := isRelativePathOrURL(*publiccodev0.Legal.AuthorsFile, "legal.authorsFile"); err != nil {
 			vr = append(vr, err)
-		} else if exists, err := parser.fileExists(toCodeHostingURL(*publiccodev0.Legal.AuthorsFile, parser.currentBaseURL), network); !exists {
-			u := toCodeHostingURL(*publiccodev0.Legal.AuthorsFile, parser.currentBaseURL)
+		} else if !parser.disableExternalChecks {
+			exists, err := parser.fileExists(toCodeHostingURL(*publiccodev0.Legal.AuthorsFile, parser.currentBaseURL), network)
+			if !exists {
+				u := toCodeHostingURL(*publiccodev0.Legal.AuthorsFile, parser.currentBaseURL)
 
-			vr = append(vr, newValidationError("legal.authorsFile", "'%s' does not exist: %s", urlutil.DisplayURL(&u), err.Error()))
+				vr = append(vr, newValidationError("legal.authorsFile", "'%s' does not exist: %s", urlutil.DisplayURL(&u), err.Error()))
+			}
 		}
 	}
 
@@ -97,7 +106,7 @@ func validateFieldsV0(publiccode PublicCode, parser Parser, network bool) error
 			})
 		}
 
-		if network && desc.Documentation != nil {
+		if !parser.disableExternalChecks && network && desc.Documentation != nil {
 			if reachable, err := parser.isReachable(*(*url.URL)(desc.Documentation), network); !reachable {
 				vr = append(vr, newValidationError(
 					fmt.Sprintf("description.%s.documentation", lang),
@@ -106,7 +115,7 @@ func validateFieldsV0(publiccode PublicCode, parser Parser, network bool) error
 			}
 		}
 
-		if network && desc.APIDocumentation != nil {
+		if !parser.disableExternalChecks && network && desc.APIDocumentation != nil {
 			if reachable, err := parser.isReachable(*(*url.URL)(desc.APIDocumentation), network); !reachable {
 				vr = append(vr, newValidationError(
 					fmt.Sprintf("description.%s.apiDocumentation", lang),
@@ -119,11 +128,14 @@ func validateFieldsV0(publiccode PublicCode, parser Parser, network bool) error
 			keyName := fmt.Sprintf("description.%s.screenshots[%d]", lang, i)
 			if _, err := isRelativePathOrURL(v, keyName); err != nil {
 				vr = append(vr, err)
-			} else if isImage, err := parser.isImageFile(toCodeHostingURL(v, parser.currentBaseURL), network); !isImage {
-				vr = append(vr, newValidationError(
-					keyName,
-					"'%s' is not an image: %s", v, err.Error(),
-				))
+			} else if !parser.disableExternalChecks {
+				isImage, err := parser.isImageFile(toCodeHostingURL(v, parser.currentBaseURL), network)
+				if !isImage {
+					vr = append(vr, newValidationError(
+						keyName,
+						"'%s' is not an image: %s", v, err.Error(),
+					))
+				}
 			}
 		}
 

parser.go

@@ -26,10 +26,16 @@ import (
 )
 
 type ParserConfig struct {
-	// DisableNetwork disables all network tests (URL existence and Oembed). This
+	// DisableNetwork disables all network tests (eg. URL existence). This
 	// results in much faster parsing.
 	DisableNetwork bool
 
+	// DisableExternalChecks disables ALL the additional checks on external files
+	// and resources, local or remote (eg. existence, images actually being images, etc.).
+	//
+	// It implies DisableNetwork = true.
+	DisableExternalChecks bool
+
 	// Domain will have domain specific settings, including basic auth if provided
 	// this will avoid strong quota limit imposed by code hosting platform
 	Domain Domain
@@ -45,11 +51,12 @@ type ParserConfig struct {
 
 // Parser is a helper class for parsing publiccode.yml files.
 type Parser struct {
-	disableNetwork bool
-	domain         Domain
-	branch         string
-	baseURL        *url.URL
-	fileURL        *url.URL
+	disableNetwork        bool
+	disableExternalChecks bool
+	domain                Domain
+	branch                string
+	baseURL               *url.URL
+	fileURL               *url.URL
 
 	// This is the baseURL we'll try to compute and use between
 	// Parse{,Stream)() calls.
@@ -70,10 +77,15 @@ type Domain struct {
 // NewParser initializes and returns a new Parser object following the settings in
 // ParserConfig.
 func NewParser(config ParserConfig) (*Parser, error) {
+	if config.DisableExternalChecks {
+		config.DisableNetwork = true
+	}
+
 	parser := Parser{
-		disableNetwork: config.DisableNetwork,
-		domain:         config.Domain,
-		branch:         config.Branch,
+		disableNetwork:        config.DisableNetwork,
+		disableExternalChecks: config.DisableExternalChecks,
+		domain:                config.Domain,
+		branch:                config.Branch,
 	}
 
 	if config.BaseURL != "" {

publiccode-parser/publiccode_parser.go

@@ -37,6 +37,7 @@ func main() {
 	}
 	localBasePathPtr := flag.String("path", "", "Use this local directory as base path when checking for files existence instead of using the `url` key in publiccode.yml")
 	disableNetworkPtr := flag.Bool("no-network", false, "Disables checks that require network connections (URL existence and oEmbed). This makes validation much faster.")
+	disableExternalChecksPtr := flag.Bool("no-external-checks", false, "Disables ALL checks that reference external resources such as remote URLs or local file existence. Implies --no-network")
 	_ = flag.String("export", "", "(DEPRECATED) Provided for backward compatibility only")
 	jsonOutputPtr := flag.Bool("json", false, "Output the validation errors as a JSON list.")
 	helpPtr := flag.Bool("help", false, "Display command line usage.")
@@ -67,6 +68,7 @@ func main() {
 
 	config := publiccode.ParserConfig{BaseURL: *localBasePathPtr}
 	config.DisableNetwork = *disableNetworkPtr
+	config.DisableExternalChecks = *disableExternalChecksPtr
 
 	p, err := publiccode.NewParser(config)
 	if err != nil {