Documentation ¶
Index ¶
- Constants
- func AssignForm(form interface{}, data map[string]interface{})
- func CheckOAuthAccessToken(accessToken string) int64
- func GetInclude(field reflect.StructField) string
- func GetMaxSize(field reflect.StructField) string
- func GetMinSize(field reflect.StructField) string
- func GetSize(field reflect.StructField) string
- func IsAPIPath(url string) bool
- func SignedInID(ctx *macaron.Context, sess session.Store) int64
- func SignedInUser(ctx *macaron.Context, sess session.Store) (*models.User, bool)
- type AccessTokenForm
- type AddEmailForm
- type AddKeyForm
- type AddOpenIDForm
- type AddTimeManuallyForm
- type AdminCreateUserForm
- type AdminEditUserForm
- type AuthenticationForm
- type AuthorizationForm
- type AvatarForm
- type ChangePasswordForm
- type CodeCommentForm
- type ConnectOpenIDForm
- type CreateCommentForm
- type CreateIssueForm
- type CreateLabelForm
- type CreateMilestoneForm
- type CreateOrgForm
- type CreateRepoForm
- type CreateTeamForm
- type DeadlineForm
- type DeleteRepoFileForm
- type EditOAuth2ApplicationForm
- type EditPreviewDiffForm
- type EditReleaseForm
- type EditRepoFileForm
- type Form
- type GrantApplicationForm
- type InitializeLabelsForm
- type InstallForm
- type IssueLockForm
- type MergePullRequestForm
- type MigrateRepoForm
- type MustChangePasswordForm
- type NewAccessTokenForm
- type NewBranchForm
- type NewDingtalkHookForm
- type NewDiscordHookForm
- type NewGogshookForm
- type NewReleaseForm
- type NewSlackHookForm
- type NewWebhookForm
- type NewWikiForm
- type ProtectBranchForm
- type ReactionForm
- type RegisterForm
- type RemoveUploadFileForm
- type RepoSettingForm
- type SaveTopicForm
- type SignInForm
- type SignInOpenIDForm
- type SignUpOpenIDForm
- type SubmitReviewForm
- type TwoFactorAuthForm
- type TwoFactorScratchAuthForm
- type U2FDeleteForm
- type U2FRegistrationForm
- type UpdateOrgSettingForm
- type UpdateProfileForm
- type UpdateThemeForm
- type UploadRepoFileForm
- type WebhookForm
Constants ¶
const ( AvatarLocal string = "local" AvatarByMail string = "bymail" )
Avatar types
Variables ¶
This section is empty.
Functions ¶
func AssignForm ¶
func AssignForm(form interface{}, data map[string]interface{})
AssignForm assign form values back to the template data.
func CheckOAuthAccessToken ¶ added in v1.8.1
CheckOAuthAccessToken returns uid of user from oauth token token
func GetInclude ¶
func GetInclude(field reflect.StructField) string
GetInclude get include in form tag
func GetMaxSize ¶
func GetMaxSize(field reflect.StructField) string
GetMaxSize get max size in form tag
func GetMinSize ¶
func GetMinSize(field reflect.StructField) string
GetMinSize get minimal size in form tag
func SignedInID ¶
SignedInID returns the id of signed in user.
Types ¶
type AccessTokenForm ¶ added in v1.8.1
type AccessTokenForm struct { GrantType string `json:"grant_type"` ClientID string `json:"client_id"` ClientSecret string `json:"client_secret"` RedirectURI string `json:"redirect_uri"` Code string `json:"code"` RefreshToken string `json:"refresh_token"` // PKCE support CodeVerifier string `json:"code_verifier"` }
AccessTokenForm for issuing access tokens from authorization codes or refresh tokens
type AddEmailForm ¶
type AddEmailForm struct {
Email string `binding:"Required;Email;MaxSize(254)"`
}
AddEmailForm form for adding new email
type AddKeyForm ¶ added in v1.2.0
type AddKeyForm struct { Type string `binding:"OmitEmpty"` Title string `binding:"Required;MaxSize(50)"` Content string `binding:"Required"` IsWritable bool }
AddKeyForm form for adding SSH/GPG key
type AddOpenIDForm ¶ added in v1.2.0
type AddOpenIDForm struct {
Openid string `binding:"Required;MaxSize(256)"`
}
AddOpenIDForm is for changing openid uri
type AddTimeManuallyForm ¶ added in v1.3.1
type AddTimeManuallyForm struct { Hours int `binding:"Range(0,1000)"` Minutes int `binding:"Range(0,1000)"` }
AddTimeManuallyForm form that adds spent time manually.
type AdminCreateUserForm ¶ added in v1.0.0
type AdminCreateUserForm struct { LoginType string `binding:"Required"` LoginName string UserName string `binding:"Required;AlphaDashDot;MaxSize(40)"` Email string `binding:"Required;Email;MaxSize(254)"` Password string `binding:"MaxSize(255)"` SendNotify bool MustChangePassword bool }
AdminCreateUserForm form for admin to create user
type AdminEditUserForm ¶
type AdminEditUserForm struct { LoginType string `binding:"Required"` LoginName string FullName string `binding:"MaxSize(100)"` Email string `binding:"Required;Email;MaxSize(254)"` Password string `binding:"MaxSize(255)"` Website string `binding:"ValidUrl;MaxSize(255)"` Location string `binding:"MaxSize(50)"` MaxRepoCreation int Active bool Admin bool AllowGitHook bool AllowImportLocal bool AllowCreateOrganization bool ProhibitLogin bool }
AdminEditUserForm form for admin to create user
type AuthenticationForm ¶
type AuthenticationForm struct { ID int64 Type int `binding:"Range(2,6)"` Name string `binding:"Required;MaxSize(30)"` Host string Port int BindDN string BindPassword string UserBase string UserDN string AttributeUsername string AttributeName string AttributeSurname string AttributeMail string AttributeSSHPublicKey string AttributesInBind bool UsePagedSearch bool SearchPageSize int Filter string AdminFilter string IsActive bool IsSyncEnabled bool SMTPAuth string SMTPHost string SMTPPort int AllowedDomains string SecurityProtocol int `binding:"Range(0,2)"` TLS bool SkipVerify bool PAMServiceName string Oauth2Provider string Oauth2Key string Oauth2Secret string OpenIDConnectAutoDiscoveryURL string Oauth2UseCustomURL bool Oauth2TokenURL string Oauth2AuthURL string Oauth2ProfileURL string Oauth2EmailURL string }
AuthenticationForm form for authentication
type AuthorizationForm ¶ added in v1.8.1
type AuthorizationForm struct { ResponseType string `binding:"Required;In(code)"` ClientID string `binding:"Required"` RedirectURI string State string // PKCE support CodeChallengeMethod string // S256, plain CodeChallenge string }
AuthorizationForm form for authorizing oauth2 clients
type AvatarForm ¶
type AvatarForm struct { Source string Avatar *multipart.FileHeader Gravatar string `binding:"OmitEmpty;Email;MaxSize(254)"` Federavatar bool }
AvatarForm form for changing avatar
type ChangePasswordForm ¶
type ChangePasswordForm struct { OldPassword string `form:"old_password" binding:"MaxSize(255)"` Password string `form:"password" binding:"Required;MaxSize(255)"` Retype string `form:"retype"` }
ChangePasswordForm form for changing password
type CodeCommentForm ¶ added in v1.6.1
type CodeCommentForm struct { Content string `binding:"Required"` Side string `binding:"Required;In(previous,proposed)"` Line int64 TreePath string `form:"path" binding:"Required"` IsReview bool `form:"is_review"` Reply int64 `form:"reply"` }
CodeCommentForm form for adding code comments for PRs
type ConnectOpenIDForm ¶ added in v1.2.0
type ConnectOpenIDForm struct { UserName string `binding:"Required;MaxSize(254)"` Password string `binding:"Required;MaxSize(255)"` }
ConnectOpenIDForm form for connecting an existing account to an OpenID URI
type CreateCommentForm ¶
type CreateCommentForm struct { Content string Status string `binding:"OmitEmpty;In(reopen,close)"` Files []string }
CreateCommentForm form for creating comment
type CreateIssueForm ¶
type CreateIssueForm struct { Title string `binding:"Required;MaxSize(255)"` LabelIDs string `form:"label_ids"` AssigneeIDs string `form:"assignee_ids"` Ref string `form:"ref"` MilestoneID int64 AssigneeID int64 Content string Files []string }
CreateIssueForm form for creating issue
type CreateLabelForm ¶
type CreateLabelForm struct { ID int64 Title string `binding:"Required;MaxSize(50)" locale:"repo.issues.label_title"` Description string `binding:"MaxSize(200)" locale:"repo.issues.label_description"` Color string `binding:"Required;Size(7)" locale:"repo.issues.label_color"` }
CreateLabelForm form for creating label
type CreateMilestoneForm ¶
type CreateMilestoneForm struct { Title string `binding:"Required;MaxSize(50)"` Content string Deadline string }
CreateMilestoneForm form for creating milestone
type CreateOrgForm ¶
type CreateOrgForm struct { OrgName string `binding:"Required;AlphaDashDot;MaxSize(40)" locale:"org.org_name_holder"` Visibility structs.VisibleType }
CreateOrgForm form for creating organization
type CreateRepoForm ¶
type CreateRepoForm struct { UID int64 `binding:"Required"` RepoName string `binding:"Required;AlphaDashDot;MaxSize(100)"` Private bool Description string `binding:"MaxSize(255)"` AutoInit bool Gitignores string License string Readme string }
CreateRepoForm form for creating repository
type CreateTeamForm ¶
type CreateTeamForm struct { TeamName string `binding:"Required;AlphaDashDot;MaxSize(30)"` Description string `binding:"MaxSize(255)"` Permission string Units []models.UnitType }
CreateTeamForm form for creating team
type DeadlineForm ¶ added in v1.5.0
type DeadlineForm struct {
DateString string `form:"date" binding:"Required;Size(10)"`
}
DeadlineForm hold the validation rules for deadlines
type DeleteRepoFileForm ¶
type DeleteRepoFileForm struct { CommitSummary string `binding:"MaxSize(100)"` CommitMessage string CommitChoice string `binding:"Required;MaxSize(50)"` NewBranchName string `binding:"GitRefName;MaxSize(100)"` }
DeleteRepoFileForm form for deleting repository file
type EditOAuth2ApplicationForm ¶ added in v1.8.1
type EditOAuth2ApplicationForm struct { Name string `binding:"Required;MaxSize(255)" form:"application_name"` RedirectURI string `binding:"Required" form:"redirect_uri"` }
EditOAuth2ApplicationForm form for editing oauth2 applications
type EditPreviewDiffForm ¶
type EditPreviewDiffForm struct {
Content string
}
EditPreviewDiffForm form for changing preview diff
type EditReleaseForm ¶
type EditReleaseForm struct { Title string `form:"title" binding:"Required"` Content string `form:"content"` Draft string `form:"draft"` Prerelease bool `form:"prerelease"` Files []string }
EditReleaseForm form for changing release
type EditRepoFileForm ¶
type EditRepoFileForm struct { TreePath string `binding:"Required;MaxSize(500)"` Content string `binding:"Required"` CommitSummary string `binding:"MaxSize(100)"` CommitMessage string CommitChoice string `binding:"Required;MaxSize(50)"` NewBranchName string `binding:"GitRefName;MaxSize(100)"` LastCommit string }
EditRepoFileForm form for changing repository file
type GrantApplicationForm ¶ added in v1.8.1
type GrantApplicationForm struct { ClientID string `binding:"Required"` RedirectURI string State string }
GrantApplicationForm form for authorizing oauth2 clients
type InitializeLabelsForm ¶
type InitializeLabelsForm struct {
TemplateName string `binding:"Required"`
}
InitializeLabelsForm form for initializing labels
type InstallForm ¶
type InstallForm struct { DbType string `binding:"Required"` DbHost string DbUser string DbPasswd string DbName string SSLMode string DbPath string AppName string `binding:"Required" locale:"install.app_name"` RepoRootPath string `binding:"Required"` LFSRootPath string RunUser string `binding:"Required"` Domain string `binding:"Required"` SSHPort int HTTPPort string `binding:"Required"` AppURL string `binding:"Required"` LogRootPath string `binding:"Required"` SMTPHost string SMTPFrom string SMTPUser string `binding:"OmitEmpty;MaxSize(254)" locale:"install.mailer_user"` SMTPPasswd string RegisterConfirm bool MailNotify bool OfflineMode bool DisableGravatar bool EnableFederatedAvatar bool EnableOpenIDSignIn bool EnableOpenIDSignUp bool DisableRegistration bool AllowOnlyExternalRegistration bool EnableCaptcha bool RequireSignInView bool DefaultKeepEmailPrivate bool DefaultAllowCreateOrganization bool DefaultEnableTimetracking bool NoReplyAddress string AdminName string `binding:"OmitEmpty;AlphaDashDot;MaxSize(30)" locale:"install.admin_name"` AdminPasswd string `binding:"OmitEmpty;MaxSize(255)" locale:"install.admin_password"` AdminConfirmPasswd string AdminEmail string `binding:"OmitEmpty;MinSize(3);MaxSize(254);Include(@)" locale:"install.admin_email"` }
InstallForm form for installation page
type IssueLockForm ¶ added in v1.8.1
type IssueLockForm struct {
Reason string `binding:"Required"`
}
IssueLockForm form for locking an issue
func (IssueLockForm) HasValidReason ¶ added in v1.8.1
func (i IssueLockForm) HasValidReason() bool
HasValidReason checks to make sure that the reason submitted in the form matches any of the values in the config
type MergePullRequestForm ¶ added in v1.4.0
type MergePullRequestForm struct { // required: true // enum: merge,rebase,rebase-merge,squash Do string `binding:"Required;In(merge,rebase,rebase-merge,squash)"` MergeTitleField string MergeMessageField string }
MergePullRequestForm form for merging Pull Request swagger:model MergePullRequestOption
type MigrateRepoForm ¶
type MigrateRepoForm struct { // required: true CloneAddr string `json:"clone_addr" binding:"Required"` AuthUsername string `json:"auth_username"` AuthPassword string `json:"auth_password"` // required: true UID int64 `json:"uid" binding:"Required"` // required: true RepoName string `json:"repo_name" binding:"Required;AlphaDashDot;MaxSize(100)"` Mirror bool `json:"mirror"` Private bool `json:"private"` Description string `json:"description" binding:"MaxSize(255)"` }
MigrateRepoForm form for migrating repository
func (MigrateRepoForm) ParseRemoteAddr ¶
func (f MigrateRepoForm) ParseRemoteAddr(user *models.User) (string, error)
ParseRemoteAddr checks if given remote address is valid, and returns composed URL with needed username and password. It also checks if given user has permission when remote address is actually a local path.
type MustChangePasswordForm ¶ added in v1.6.1
type MustChangePasswordForm struct { Password string `binding:"Required;MaxSize(255)"` Retype string }
MustChangePasswordForm form for updating your password after account creation by an admin
type NewAccessTokenForm ¶
type NewAccessTokenForm struct {
Name string `binding:"Required;MaxSize(255)"`
}
NewAccessTokenForm form for creating access token
type NewBranchForm ¶ added in v1.3.1
type NewBranchForm struct {
NewBranchName string `binding:"Required;MaxSize(100);GitRefName"`
}
NewBranchForm form for creating a new branch
type NewDingtalkHookForm ¶ added in v1.4.0
type NewDingtalkHookForm struct { PayloadURL string `binding:"Required;ValidUrl"` WebhookForm }
NewDingtalkHookForm form for creating dingtalk hook
type NewDiscordHookForm ¶ added in v1.3.1
type NewDiscordHookForm struct { PayloadURL string `binding:"Required;ValidUrl"` Username string IconURL string WebhookForm }
NewDiscordHookForm form for creating discord hook
type NewGogshookForm ¶ added in v1.2.0
type NewGogshookForm struct { PayloadURL string `binding:"Required;ValidUrl"` ContentType int `binding:"Required"` Secret string WebhookForm }
NewGogshookForm form for creating gogs hook
type NewReleaseForm ¶
type NewReleaseForm struct { TagName string `binding:"Required;GitRefName"` Target string `form:"tag_target" binding:"Required"` Title string `binding:"Required"` Content string Draft string Prerelease bool Files []string }
NewReleaseForm form for creating release
type NewSlackHookForm ¶
type NewSlackHookForm struct { PayloadURL string `binding:"Required;ValidUrl"` Channel string `binding:"Required"` Username string IconURL string Color string WebhookForm }
NewSlackHookForm form for creating slack hook
func (NewSlackHookForm) HasInvalidChannel ¶ added in v1.6.1
func (f NewSlackHookForm) HasInvalidChannel() bool
HasInvalidChannel validates the channel name is in the right format
type NewWebhookForm ¶
type NewWebhookForm struct { PayloadURL string `binding:"Required;ValidUrl"` ContentType int `binding:"Required"` Secret string WebhookForm }
NewWebhookForm form for creating web hook
type NewWikiForm ¶
type NewWikiForm struct { Title string `binding:"Required"` Content string `binding:"Required"` Message string }
NewWikiForm form for creating wiki
type ProtectBranchForm ¶ added in v1.3.1
type ProtectBranchForm struct { Protected bool EnableWhitelist bool WhitelistUsers string WhitelistTeams string EnableMergeWhitelist bool MergeWhitelistUsers string MergeWhitelistTeams string RequiredApprovals int64 ApprovalsWhitelistUsers string ApprovalsWhitelistTeams string }
ProtectBranchForm form for changing protected branch settings
type ReactionForm ¶ added in v1.4.0
type ReactionForm struct {
Content string `binding:"Required;In(+1,-1,laugh,confused,heart,hooray)"`
}
ReactionForm form for adding and removing reaction
type RegisterForm ¶
type RegisterForm struct { UserName string `binding:"Required;AlphaDashDot;MaxSize(40)"` Email string `binding:"Required;Email;MaxSize(254)"` Password string `binding:"Required;MaxSize(255)"` Retype string GRecaptchaResponse string `form:"g-recaptcha-response"` }
RegisterForm form for registering
func (RegisterForm) IsEmailDomainWhitelisted ¶ added in v1.7.3
func (f RegisterForm) IsEmailDomainWhitelisted() bool
IsEmailDomainWhitelisted validates that the email address provided by the user matches what has been configured . If the domain whitelist from the config is empty, it marks the email as whitelisted
type RemoveUploadFileForm ¶
type RemoveUploadFileForm struct {
File string `binding:"Required;MaxSize(50)"`
}
RemoveUploadFileForm form for removing uploaded file
type RepoSettingForm ¶
type RepoSettingForm struct { RepoName string `binding:"Required;AlphaDashDot;MaxSize(100)"` Description string `binding:"MaxSize(255)"` Website string `binding:"ValidUrl;MaxSize(255)"` Interval string MirrorAddress string Private bool EnablePrune bool // Advanced settings EnableWiki bool EnableExternalWiki bool ExternalWikiURL string EnableIssues bool EnableExternalTracker bool ExternalTrackerURL string TrackerURLFormat string TrackerIssueStyle string EnablePulls bool PullsIgnoreWhitespace bool PullsAllowMerge bool PullsAllowRebase bool PullsAllowRebaseMerge bool PullsAllowSquash bool EnableTimetracker bool AllowOnlyContributorsToTrackTime bool EnableIssueDependencies bool IsArchived bool // Admin settings EnableHealthCheck bool EnableCloseIssuesViaCommitInAnyBranch bool }
RepoSettingForm form for changing repository settings
type SaveTopicForm ¶ added in v1.5.0
type SaveTopicForm struct {
Topics []string `binding:"topics;Required;"`
}
SaveTopicForm form for save topics for repository
type SignInForm ¶
type SignInForm struct { UserName string `binding:"Required;MaxSize(254)"` Password string `binding:"Required;MaxSize(255)"` Remember bool }
SignInForm form for signing in with user/password
type SignInOpenIDForm ¶ added in v1.2.0
SignInOpenIDForm form for signing in with OpenID
type SignUpOpenIDForm ¶ added in v1.2.0
type SignUpOpenIDForm struct { UserName string `binding:"Required;AlphaDashDot;MaxSize(40)"` Email string `binding:"Required;Email;MaxSize(254)"` GRecaptchaResponse string `form:"g-recaptcha-response"` }
SignUpOpenIDForm form for signin up with OpenID
type SubmitReviewForm ¶ added in v1.6.1
type SubmitReviewForm struct { Content string Type string `binding:"Required;In(approve,comment,reject)"` }
SubmitReviewForm for submitting a finished code review
func (SubmitReviewForm) HasEmptyContent ¶ added in v1.6.1
func (f SubmitReviewForm) HasEmptyContent() bool
HasEmptyContent checks if the content of the review form is empty.
func (SubmitReviewForm) ReviewType ¶ added in v1.6.1
func (f SubmitReviewForm) ReviewType() models.ReviewType
ReviewType will return the corresponding reviewtype for type
type TwoFactorAuthForm ¶ added in v1.1.0
type TwoFactorAuthForm struct {
Passcode string `binding:"Required"`
}
TwoFactorAuthForm for logging in with 2FA token.
type TwoFactorScratchAuthForm ¶ added in v1.1.0
type TwoFactorScratchAuthForm struct {
Token string `binding:"Required"`
}
TwoFactorScratchAuthForm for logging in with 2FA scratch token.
type U2FDeleteForm ¶ added in v1.5.0
type U2FDeleteForm struct {
ID int64 `binding:"Required"`
}
U2FDeleteForm for deleting U2F keys
type U2FRegistrationForm ¶ added in v1.5.0
type U2FRegistrationForm struct {
Name string `binding:"Required"`
}
U2FRegistrationForm for reserving an U2F name
type UpdateOrgSettingForm ¶
type UpdateOrgSettingForm struct { Name string `binding:"Required;AlphaDashDot;MaxSize(40)" locale:"org.org_name_holder"` FullName string `binding:"MaxSize(100)"` Description string `binding:"MaxSize(255)"` Website string `binding:"ValidUrl;MaxSize(255)"` Location string `binding:"MaxSize(50)"` Visibility structs.VisibleType MaxRepoCreation int }
UpdateOrgSettingForm form for updating organization settings
type UpdateProfileForm ¶
type UpdateProfileForm struct { Name string `binding:"AlphaDashDot;MaxSize(40)"` FullName string `binding:"MaxSize(100)"` Email string `binding:"Required;Email;MaxSize(254)"` KeepEmailPrivate bool Website string `binding:"ValidUrl;MaxSize(255)"` Location string `binding:"MaxSize(50)"` Language string `binding:"Size(5)"` }
UpdateProfileForm form for updating profile
type UpdateThemeForm ¶ added in v1.8.1
type UpdateThemeForm struct {
Theme string `binding:"Required;MaxSize(30)"`
}
UpdateThemeForm form for updating a users' theme
func (UpdateThemeForm) IsThemeExists ¶ added in v1.8.1
func (f UpdateThemeForm) IsThemeExists() bool
IsThemeExists checks if the theme is a theme available in the config.
type UploadRepoFileForm ¶
type UploadRepoFileForm struct { TreePath string `binding:"MaxSize(500)"` CommitSummary string `binding:"MaxSize(100)"` CommitMessage string CommitChoice string `binding:"Required;MaxSize(50)"` NewBranchName string `binding:"GitRefName;MaxSize(100)"` Files []string }
UploadRepoFileForm form for uploading repository file
type WebhookForm ¶
type WebhookForm struct { Events string Create bool Delete bool Fork bool Issues bool IssueComment bool Release bool Push bool PullRequest bool Repository bool Active bool }
WebhookForm form for changing web hook
func (WebhookForm) ChooseEvents ¶
func (f WebhookForm) ChooseEvents() bool
ChooseEvents if the hook will be triggered choose events
func (WebhookForm) PushOnly ¶
func (f WebhookForm) PushOnly() bool
PushOnly if the hook will be triggered when push
func (WebhookForm) SendEverything ¶
func (f WebhookForm) SendEverything() bool
SendEverything if the hook will be triggered any event
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
Package ldap provide functions & structure to query a LDAP ldap directory For now, it's mainly tested again an MS Active Directory service, see README.md for more information
|
Package ldap provide functions & structure to query a LDAP ldap directory For now, it's mainly tested again an MS Active Directory service, see README.md for more information |