attendeesrv

package
v0.1.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 27, 2024 License: MIT Imports: 20 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	SameStatusError          = errors.New("old and new status are the same")
	InsufficientPaymentError = errors.New("payment amount not sufficient")
	HasPaymentBalanceError   = errors.New("there is a non-zero payment balance, please use partially paid, or refund")
	CannotDeleteError        = errors.New("cannot delete attendee for legal reasons (there were payments or invoices)")
	GoToApprovedFirst        = errors.New("please change status to approved, this will automatically advance to (partially) paid as appropriate")
	UnknownStatusError       = errors.New("unknown status value - this is a programming error")
	BanCandidateError        = errors.New("this attendee matches a ban rule and cannot be approved, please review and either cancel or set the skip_ban_check admin flag to allow approval")
)
View Source 
var DuplicateBanError = errors.New("duplicate ban rule")

Functions

This section is empty.

Types

type AttendeeService 

type AttendeeService interface {
	// NewAttendee creates an empty (unsaved) attendee, without an assigned badge number (aka. ID).
	//
	// Mostly useful for filling in values and passing it to RegisterNewAttendee.
	NewAttendee(ctx context.Context) *entity.Attendee

	// RegisterNewAttendee saves a previously unsaved attendee, assigning them a badge number.
	RegisterNewAttendee(ctx context.Context, attendee *entity.Attendee) (uint, error)
	GetAttendee(ctx context.Context, id uint) (*entity.Attendee, error)
	UpdateAttendee(ctx context.Context, attendee *entity.Attendee, suppressMinorUpdateEmails bool) error

	// GetAttendeeMaxId returns the highest assigned badge number.
	GetAttendeeMaxId(ctx context.Context) (uint, error)

	CanRegisterAtThisTime(ctx context.Context) error

	CanChangeEmailTo(ctx context.Context, originalEmail string, newEmail string) error

	CanChangeChoiceTo(ctx context.Context, what string, originalChoiceStr string, newChoiceStr string, configuration map[string]config.ChoiceConfig) error
	CanChangeChoiceToCurrentStatus(ctx context.Context, what string, originalChoiceStr string, newChoiceStr string, configuration map[string]config.ChoiceConfig, currentStatus status.Status) error

	GetAdminInfo(ctx context.Context, attendeeId uint) (*entity.AdminInfo, error)
	UpdateAdminInfo(ctx context.Context, attendee *entity.Attendee, adminInfo *entity.AdminInfo, suppressMinorUpdateEmail bool) error

	GetFullStatusHistory(ctx context.Context, attendee *entity.Attendee) ([]entity.StatusChange, error)
	// UpdateDuesAndDoStatusChangeIfNeeded updates dues (depending on newStatus) and records a status change if appropriate.
	//
	// If newStatus is one of approved/partially paid/paid, the actual status value written may be any of these three.
	// This is because depending on package and flag changes (guests attend for free!), the dues may change, and
	// so paid may turn into partially paid etc.
	UpdateDuesAndDoStatusChangeIfNeeded(ctx context.Context, attendee *entity.Attendee, oldStatus status.Status, newStatus status.Status, statusComment string, overrideDuesComment string, suppressMinorUpdateEmail bool) error
	StatusChangeAllowed(ctx context.Context, attendee *entity.Attendee, oldStatus status.Status, newStatus status.Status) error
	StatusChangePossible(ctx context.Context, attendee *entity.Attendee, oldStatus status.Status, newStatus status.Status) error
	// ResendStatusMail resends the current status mail, but with dues recalculated
	ResendStatusMail(ctx context.Context, attendee *entity.Attendee, currentStatus status.Status, currentStatusComment string) error

	// IsOwnerFor returns the list of attendees (registrations) that are owned by the currently logged
	// in user account.
	//
	// Unless an admin has made changes to the database, this essentially means their registration was made
	// using this account.
	IsOwnerFor(ctx context.Context) ([]*entity.Attendee, error)

	// FindAttendees runs the search by criteria in the database, then filters and converts the result.
	FindAttendees(ctx context.Context, criteria *attendee.AttendeeSearchCriteria) (*attendee.AttendeeSearchResultList, error)

	// NewBan creates an empty (unsaved) ban.
	NewBan(ctx context.Context) *entity.Ban
	CreateBan(ctx context.Context, ban *entity.Ban) (uint, error)
	UpdateBan(ctx context.Context, ban *entity.Ban) error
	DeleteBan(ctx context.Context, ban *entity.Ban) error
	GetBan(ctx context.Context, id uint) (*entity.Ban, error)
	GetAllBans(ctx context.Context) ([]*entity.Ban, error)

	// GetAdditionalInfo obtains additional info for a given attendeeId and area.
	//
	// If this returns an empty string, then no value existed.
	GetAdditionalInfo(ctx context.Context, attendeeId uint, area string) (string, error)

	// WriteAdditionalInfo writes additional info for a given attendeeId and area.
	//
	// If value is the empty string, the entry is deleted instead.
	WriteAdditionalInfo(ctx context.Context, attendeeId uint, area string, value string) error

	// CanAccessAdditionalInfoArea checks permission to access additional info for a whole area.
	//
	// Normal users (loaded by identity) need a matching permissions entry in their admin info.
	// Admins and Api Token can see all areas.
	CanAccessAdditionalInfoArea(ctx context.Context, area ...string) (bool, error)

	// CanAccessOwnAdditionalInfoArea checks permission to access ones own additional info for a given area
	//
	// This is only allowed for areas which have self_read or self_write configured.
	CanAccessOwnAdditionalInfoArea(ctx context.Context, attendeeId uint, wantWriteAccess bool, area string) (bool, error)

	// GenerateFakeRegistrations creates the specified number of fake registrations in the database.
	//
	// Only for use on test systems.
	GenerateFakeRegistrations(ctx context.Context, count uint) error

	// SendFakeRegistrationToAPI sends a fake registration via the API.
	//
	// Only for use on test systems.
	//
	// Must configure identity_anonymize on the receiver.
	SendFakeRegistrationToAPI(ctx context.Context) (string, error)
}

func New 

func New() AttendeeService

type AttendeeServiceImplData 

type AttendeeServiceImplData struct {
	Now func() time.Time
}

func (*AttendeeServiceImplData) CanAccessAdditionalInfoArea 

func (s *AttendeeServiceImplData) CanAccessAdditionalInfoArea(ctx context.Context, area ...string) (bool, error)

func (*AttendeeServiceImplData) CanAccessOwnAdditionalInfoArea 

func (s *AttendeeServiceImplData) CanAccessOwnAdditionalInfoArea(ctx context.Context, attendeeId uint, wantWriteAccess bool, area string) (bool, error)

func (*AttendeeServiceImplData) CanChangeChoiceTo 

func (s *AttendeeServiceImplData) CanChangeChoiceTo(ctx context.Context, what string, originalChoiceStr string, newChoiceStr string, configuration map[string]config.ChoiceConfig) error

func (*AttendeeServiceImplData) CanChangeChoiceToCurrentStatus 

func (s *AttendeeServiceImplData) CanChangeChoiceToCurrentStatus(ctx context.Context, what string, originalChoiceStr string, newChoiceStr string, configuration map[string]config.ChoiceConfig, currentStatus status.Status) error

func (*AttendeeServiceImplData) CanChangeEmailTo 

func (s *AttendeeServiceImplData) CanChangeEmailTo(ctx context.Context, originalEmail string, newEmail string) error

func (*AttendeeServiceImplData) CanRegisterAtThisTime 

func (s *AttendeeServiceImplData) CanRegisterAtThisTime(ctx context.Context) error

func (*AttendeeServiceImplData) CreateBan 

func (s *AttendeeServiceImplData) CreateBan(ctx context.Context, ban *entity.Ban) (uint, error)

func (*AttendeeServiceImplData) DeleteBan 

func (s *AttendeeServiceImplData) DeleteBan(ctx context.Context, ban *entity.Ban) error

func (*AttendeeServiceImplData) FindAttendees 

func (s *AttendeeServiceImplData) FindAttendees(ctx context.Context, criteria *attendee.AttendeeSearchCriteria) (*attendee.AttendeeSearchResultList, error)

func (*AttendeeServiceImplData) GenerateFakeRegistrations 

func (s *AttendeeServiceImplData) GenerateFakeRegistrations(ctx context.Context, count uint) error

func (*AttendeeServiceImplData) GetAdditionalInfo 

func (s *AttendeeServiceImplData) GetAdditionalInfo(ctx context.Context, attendeeId uint, area string) (string, error)

func (*AttendeeServiceImplData) GetAdminInfo 

func (s *AttendeeServiceImplData) GetAdminInfo(ctx context.Context, attendeeId uint) (*entity.AdminInfo, error)

func (*AttendeeServiceImplData) GetAllBans 

func (s *AttendeeServiceImplData) GetAllBans(ctx context.Context) ([]*entity.Ban, error)

func (*AttendeeServiceImplData) GetAttendee 

func (s *AttendeeServiceImplData) GetAttendee(ctx context.Context, id uint) (*entity.Attendee, error)

func (*AttendeeServiceImplData) GetAttendeeMaxId 

func (s *AttendeeServiceImplData) GetAttendeeMaxId(ctx context.Context) (uint, error)

func (*AttendeeServiceImplData) GetBan 

func (s *AttendeeServiceImplData) GetBan(ctx context.Context, id uint) (*entity.Ban, error)

func (*AttendeeServiceImplData) GetFullStatusHistory 

func (s *AttendeeServiceImplData) GetFullStatusHistory(ctx context.Context, attendee *entity.Attendee) ([]entity.StatusChange, error)

func (*AttendeeServiceImplData) IsOwnerFor 

func (s *AttendeeServiceImplData) IsOwnerFor(ctx context.Context) ([]*entity.Attendee, error)

func (*AttendeeServiceImplData) NewAttendee 

func (s *AttendeeServiceImplData) NewAttendee(ctx context.Context) *entity.Attendee

func (*AttendeeServiceImplData) NewBan 

func (s *AttendeeServiceImplData) NewBan(ctx context.Context) *entity.Ban

func (*AttendeeServiceImplData) RegisterNewAttendee 

func (s *AttendeeServiceImplData) RegisterNewAttendee(ctx context.Context, attendee *entity.Attendee) (uint, error)

func (*AttendeeServiceImplData) ResendStatusMail 

func (s *AttendeeServiceImplData) ResendStatusMail(ctx context.Context, attendee *entity.Attendee, currentStatus status.Status, currentStatusComment string) error

func (*AttendeeServiceImplData) SendFakeRegistrationToAPI added in v0.1.1 

func (s *AttendeeServiceImplData) SendFakeRegistrationToAPI(ctx context.Context) (string, error)

func (*AttendeeServiceImplData) StatusChangeAllowed 

func (s *AttendeeServiceImplData) StatusChangeAllowed(ctx context.Context, attendee *entity.Attendee, oldStatus status.Status, newStatus status.Status) error

func (*AttendeeServiceImplData) StatusChangePossible 

func (s *AttendeeServiceImplData) StatusChangePossible(ctx context.Context, attendee *entity.Attendee, oldStatus status.Status, newStatus status.Status) error

func (*AttendeeServiceImplData) UpdateAdminInfo 

func (s *AttendeeServiceImplData) UpdateAdminInfo(ctx context.Context, attendee *entity.Attendee, adminInfo *entity.AdminInfo, suppressMinorUpdateEmail bool) error

func (*AttendeeServiceImplData) UpdateAttendee 

func (s *AttendeeServiceImplData) UpdateAttendee(ctx context.Context, attendee *entity.Attendee, suppressMinorUpdateEmails bool) error

func (*AttendeeServiceImplData) UpdateAttendeeCacheAndCalculateResultingStatus 

func (s *AttendeeServiceImplData) UpdateAttendeeCacheAndCalculateResultingStatus(ctx context.Context, attendee *entity.Attendee, updatedTransactionHistory []paymentservice.Transaction, newStatus status.Status) (status.Status, bool, error)

func (*AttendeeServiceImplData) UpdateBan 

func (s *AttendeeServiceImplData) UpdateBan(ctx context.Context, ban *entity.Ban) error

func (*AttendeeServiceImplData) UpdateDuesAndDoStatusChangeIfNeeded 

func (s *AttendeeServiceImplData) UpdateDuesAndDoStatusChangeIfNeeded(ctx context.Context, attendee *entity.Attendee, oldStatus status.Status, newStatus status.Status, statusComment string, overrideDuesComment string, suppressMinorUpdateEmail bool) error

func (*AttendeeServiceImplData) UpdateDuesTransactions 

func (s *AttendeeServiceImplData) UpdateDuesTransactions(ctx context.Context, attendee *entity.Attendee, newStatus status.Status, commentOverride string) ([]paymentservice.Transaction, *entity.AdminInfo, error)

func (*AttendeeServiceImplData) WriteAdditionalInfo 

func (s *AttendeeServiceImplData) WriteAdditionalInfo(ctx context.Context, attendeeId uint, area string, value string) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.