mirror of
				https://codeberg.org/forgejo/forgejo.git
				synced 2025-11-04 08:21:11 +00:00 
			
		
		
		
	This PR is part of #4767. It contains * a refactoring of validation error messages * adds the ability to send user-activities to distant federated servers Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/8792 Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org> Co-authored-by: Michael Jerger <michael.jerger@meissa-gmbh.de> Co-committed-by: Michael Jerger <michael.jerger@meissa-gmbh.de>
		
			
				
	
	
		
			96 lines
		
	
	
	
		
			2 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			96 lines
		
	
	
	
		
			2 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
// Copyright 2023, 2024, 2025 The Forgejo Authors. All rights reserved.
 | 
						|
// SPDX-License-Identifier: MIT
 | 
						|
 | 
						|
package validation
 | 
						|
 | 
						|
import (
 | 
						|
	"fmt"
 | 
						|
	"reflect"
 | 
						|
	"strings"
 | 
						|
	"unicode/utf8"
 | 
						|
 | 
						|
	"forgejo.org/modules/timeutil"
 | 
						|
 | 
						|
	ap "github.com/go-ap/activitypub"
 | 
						|
)
 | 
						|
 | 
						|
// ErrNotValid represents an validation error
 | 
						|
type ErrNotValid struct {
 | 
						|
	Message string
 | 
						|
}
 | 
						|
 | 
						|
func (err ErrNotValid) Error() string {
 | 
						|
	return fmt.Sprintf("Validation Error: %v", err.Message)
 | 
						|
}
 | 
						|
 | 
						|
// IsErrNotValid checks if an error is a ErrNotValid.
 | 
						|
func IsErrNotValid(err error) bool {
 | 
						|
	_, ok := err.(ErrNotValid)
 | 
						|
	return ok
 | 
						|
}
 | 
						|
 | 
						|
type Validateable interface {
 | 
						|
	Validate() []string
 | 
						|
}
 | 
						|
 | 
						|
func IsValid(v Validateable) (bool, error) {
 | 
						|
	if valdationErrors := v.Validate(); len(valdationErrors) > 0 {
 | 
						|
		typeof := reflect.TypeOf(v)
 | 
						|
		errString := strings.Join(valdationErrors, "\n")
 | 
						|
		return false, ErrNotValid{fmt.Sprint(typeof, ": ", errString)}
 | 
						|
	}
 | 
						|
 | 
						|
	return true, nil
 | 
						|
}
 | 
						|
 | 
						|
func ValidateIDExists(value ap.Item, name string) []string {
 | 
						|
	if value == nil {
 | 
						|
		return []string{fmt.Sprintf("Field %v must not be nil", name)}
 | 
						|
	}
 | 
						|
	return ValidateNotEmpty(value.GetID().String(), name)
 | 
						|
}
 | 
						|
 | 
						|
func ValidateNotEmpty(value any, name string) []string {
 | 
						|
	isValid := true
 | 
						|
	switch v := value.(type) {
 | 
						|
	case string:
 | 
						|
		if v == "" {
 | 
						|
			isValid = false
 | 
						|
		}
 | 
						|
	case timeutil.TimeStamp:
 | 
						|
		if v.IsZero() {
 | 
						|
			isValid = false
 | 
						|
		}
 | 
						|
	case uint16:
 | 
						|
		if v == 0 {
 | 
						|
			isValid = false
 | 
						|
		}
 | 
						|
	case int64:
 | 
						|
		if v == 0 {
 | 
						|
			isValid = false
 | 
						|
		}
 | 
						|
	default:
 | 
						|
		isValid = false
 | 
						|
	}
 | 
						|
 | 
						|
	if isValid {
 | 
						|
		return []string{}
 | 
						|
	}
 | 
						|
	return []string{fmt.Sprintf("Value %v should not be empty", name)}
 | 
						|
}
 | 
						|
 | 
						|
func ValidateMaxLen(value string, maxLen int, name string) []string {
 | 
						|
	if utf8.RuneCountInString(value) > maxLen {
 | 
						|
		return []string{fmt.Sprintf("Value %v is longer than expected length %v", name, maxLen)}
 | 
						|
	}
 | 
						|
	return []string{}
 | 
						|
}
 | 
						|
 | 
						|
func ValidateOneOf(value any, allowed []any, name string) []string {
 | 
						|
	for _, allowedElem := range allowed {
 | 
						|
		if value == allowedElem {
 | 
						|
			return []string{}
 | 
						|
		}
 | 
						|
	}
 | 
						|
	return []string{fmt.Sprintf("Field %s contains the value %v, which is not in allowed subset %v", name, value, allowed)}
 | 
						|
}
 |