db

package
v0.0.0-...-2ad639e Latest Latest
Warning

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

Go to latest
Published: Jul 6, 2021 License: MIT Imports: 81 Imported by: 0

Documentation

Overview

FIXME: Put this file into its own package and separate into different files based on login sources.

Index

Constants

View Source
const (
	SMTPPlain = "PLAIN"
	SMTPLogin = "LOGIN"
)
View Source
const (
	ENV_AUTH_USER_ID           = "GOGS_AUTH_USER_ID"
	ENV_AUTH_USER_NAME         = "GOGS_AUTH_USER_NAME"
	ENV_AUTH_USER_EMAIL        = "GOGS_AUTH_USER_EMAIL"
	ENV_REPO_OWNER_NAME        = "GOGS_REPO_OWNER_NAME"
	ENV_REPO_OWNER_SALT_MD5    = "GOGS_REPO_OWNER_SALT_MD5"
	ENV_REPO_ID                = "GOGS_REPO_ID"
	ENV_REPO_NAME              = "GOGS_REPO_NAME"
	ENV_REPO_CUSTOM_HOOKS_PATH = "GOGS_REPO_CUSTOM_HOOKS_PATH"
)
View Source
const (
	KEY_TYPE_USER = iota + 1
	KEY_TYPE_DEPLOY
)
View Source
const (
	HOOK_STATUS_NONE = iota
	HOOK_STATUS_SUCCEED
	HOOK_STATUS_FAILED
)
View Source
const (
	DingtalkNotificationTitle = "Gogs Notification"
)
View Source
const OWNER_TEAM = "Owners"
View Source
const REPO_AVATAR_URL_PREFIX = "repo-avatars"

REPO_AVATAR_URL_PREFIX is used to identify a URL is to access repository avatar.

View Source
const USER_AVATAR_URL_PREFIX = "avatars"

USER_AVATAR_URL_PREFIX is used to identify a URL is to access user avatar.

Variables

View Source
var (
	// Same as Github. See https://help.github.com/articles/closing-issues-via-commit-messages
	IssueCloseKeywords  = []string{"close", "closes", "closed", "fix", "fixes", "fixed", "resolve", "resolves", "resolved"}
	IssueReopenKeywords = []string{"reopen", "reopens", "reopened"}

	IssueCloseKeywordsPat  = lazyregexp.New(assembleKeywordsPattern(IssueCloseKeywords))
	IssueReopenKeywordsPat = lazyregexp.New(assembleKeywordsPattern(IssueReopenKeywords))
)
View Source
var (
	Gitignores, Licenses, Readmes, LabelTemplates []string

	// Maximum items per page in forks, watchers and stars of a repo
	ItemsPerPage = 40
)
View Source
var (
	ErrMissingIssueNumber = errors.New("No issue number specified")
)
View Source
var (
	ErrOrgNotExist = errors.New("Organization does not exist")
)
View Source
var (
	HasEngine bool
)
View Source
var HookQueue = sync.NewUniqueQueue(1000)
View Source
var LoginNames = map[LoginType]string{
	LoginLDAP:   "LDAP (via BindDN)",
	LoginDLDAP:  "LDAP (simple auth)",
	LoginSMTP:   "SMTP",
	LoginPAM:    "PAM",
	LoginGitHub: "GitHub",
}
View Source
var MirrorQueue = sync.NewUniqueQueue(1000)
View Source
var PullRequestQueue = sync.NewUniqueQueue(1000)
View Source
var SMTPAuths = []string{SMTPPlain, SMTPLogin}
View Source
var SecurityProtocolNames = map[ldap.SecurityProtocol]string{
	ldap.SecurityProtocolUnencrypted: "Unencrypted",
	ldap.SecurityProtocolLDAPS:       "LDAPS",
	ldap.SecurityProtocolStartTLS:    "StartTLS",
}

Functions

func AddEmailAddress

func AddEmailAddress(email *EmailAddress) error

func AddEmailAddresses

func AddEmailAddresses(emails []*EmailAddress) error

func AddOrgUser

func AddOrgUser(orgID, uid int64) error

AddOrgUser adds new user to given organization.

func AddTeamMember

func AddTeamMember(orgID, teamID, userID int64) error

AddTeamMember adds new membership of given team to given organization, the user will have membership to given organization automatically when needed.

func AddTeamRepo

func AddTeamRepo(orgID, teamID, repoID int64) error

AddTeamRepo adds new repository relation to team.

func AddTestPullRequestTask

func AddTestPullRequestTask(doer *User, repoID int64, branch string, isSync bool)

AddTestPullRequestTask adds new test tasks by given head/base repository and head/base branch, and generate new patch for testing as needed.

func AttachmentLocalPath

func AttachmentLocalPath(uuid string) string

AttachmentLocalPath returns where attachment is stored in local file system based on given UUID.

func ChangeMilestoneAssign

func ChangeMilestoneAssign(doer *User, issue *Issue, oldMilestoneID int64) (err error)

ChangeMilestoneAssign changes assignment of milestone for issue.

func ChangeMilestoneIssueStats

func ChangeMilestoneIssueStats(issue *Issue) (err error)

ChangeMilestoneIssueStats updates the open/closed issues counter and progress for the milestone associated with the given issue.

func ChangeMilestoneStatus

func ChangeMilestoneStatus(m *Milestone, isClosed bool) (err error)

ChangeMilestoneStatus changes the milestone open/closed status. If milestone passes with changed values, those values will be updated to database as well.

func ChangeOrgUserStatus

func ChangeOrgUserStatus(orgID, uid int64, public bool) error

ChangeOrgUserStatus changes public or private membership status.

func ChangeRepositoryName

func ChangeRepositoryName(u *User, oldRepoName, newRepoName string) (err error)

ChangeRepositoryName changes all corresponding setting from old repository name to new one.

func ChangeUserName

func ChangeUserName(u *User, newUserName string) (err error)

ChangeUserName changes all corresponding setting from old user name to new one.

func ChangeUsernameInPullRequests

func ChangeUsernameInPullRequests(oldUserName, newUserName string) error

func CheckPublicKeyString

func CheckPublicKeyString(content string) (_ string, err error)

CheckPublicKeyString checks if the given public key string is recognized by SSH. It returns the actual public key line on success.

func CheckRepoStats

func CheckRepoStats()

func CommentHashTag

func CommentHashTag(id int64) string

func CommitRepoAction

func CommitRepoAction(opts CommitRepoActionOptions) error

CommitRepoAction adds new commit action to the repository, and prepare corresponding webhooks.

func ComposeHTTPSCloneURL

func ComposeHTTPSCloneURL(owner, repo string) string

ComposeHTTPSCloneURL returns HTTPS clone URL based on given owner and repository name.

func ComposeHookEnvs

func ComposeHookEnvs(opts ComposeHookEnvsOptions) []string

func CountNotices

func CountNotices() int64

CountNotices returns number of notices.

func CountOrganizations

func CountOrganizations() int64

CountOrganizations returns number of organizations.

func CountRepoClosedMilestones

func CountRepoClosedMilestones(repoID int64) int64

CountRepoClosedMilestones returns number of closed milestones in given repository.

func CountRepoMilestones

func CountRepoMilestones(repoID int64) int64

CountRepoMilestones returns number of milestones in given repository.

func CountRepositories

func CountRepositories(private bool) int64

CountRepositories returns number of repositories. Argument private only takes effect when it is false, set it true to count all repositories.

func CountUserRepositories

func CountUserRepositories(userID int64, private bool) int64

CountUserRepositories returns number of repositories user owns. Argument private only takes effect when it is false, set it true to count all repositories.

func CountUsers

func CountUsers() int64

CountUsers returns number of users.

func CreateNotice

func CreateNotice(tp NoticeType, desc string) error

CreateNotice creates new system notice.

func CreateOrganization

func CreateOrganization(org, owner *User) (err error)

CreateOrganization creates record of a new organization.

func CreateRefComment

func CreateRefComment(doer *User, repo *Repository, issue *Issue, content, commitSHA string) error

CreateRefComment creates a commit reference comment to issue.

func CreateRepositoryNotice

func CreateRepositoryNotice(desc string) error

CreateRepositoryNotice creates new system notice with type NOTICE_REPOSITORY.

func CreateUser

func CreateUser(u *User) (err error)

CreateUser creates record of a new user. Deprecated: Use Users.Create instead.

func CreateWebhook

func CreateWebhook(w *Webhook) error

CreateWebhook creates a new web hook.

func DeleteAttachment

func DeleteAttachment(a *Attachment, remove bool) error

DeleteAttachment deletes the given attachment and optionally the associated file.

func DeleteAttachments

func DeleteAttachments(attachments []*Attachment, remove bool) (int, error)

DeleteAttachments deletes the given attachments and optionally the associated files.

func DeleteAttachmentsByComment

func DeleteAttachmentsByComment(commentId int64, remove bool) (int, error)

DeleteAttachmentsByComment deletes all attachments associated with the given comment.

func DeleteAttachmentsByIssue

func DeleteAttachmentsByIssue(issueId int64, remove bool) (int, error)

DeleteAttachmentsByIssue deletes all attachments associated with the given issue.

func DeleteCollaboration

func DeleteCollaboration(repo *Repository, userID int64) (err error)

DeleteCollaboration removes collaboration relation between the user and repository.

func DeleteCommentByID

func DeleteCommentByID(doer *User, id int64) error

DeleteCommentByID deletes the comment by given ID.

func DeleteDeployKey

func DeleteDeployKey(doer *User, id int64) error

DeleteDeployKey deletes deploy key from its repository authorized_keys file if needed.

func DeleteEmailAddress

func DeleteEmailAddress(email *EmailAddress) (err error)

func DeleteEmailAddresses

func DeleteEmailAddresses(emails []*EmailAddress) (err error)

func DeleteInactivateUsers

func DeleteInactivateUsers() (err error)

DeleteInactivateUsers deletes all inactivate users and email addresses.

func DeleteIssueLabel

func DeleteIssueLabel(issue *Issue, label *Label) (err error)

DeleteIssueLabel deletes issue-label relation.

func DeleteLabel

func DeleteLabel(repoID, labelID int64) error

DeleteLabel delete a label of given repository.

func DeleteMilestoneOfRepoByID

func DeleteMilestoneOfRepoByID(repoID, id int64) error

DeleteMilestoneOfRepoByID deletes a milestone from a repository.

func DeleteMirrorByRepoID

func DeleteMirrorByRepoID(repoID int64) error

func DeleteMissingRepositories

func DeleteMissingRepositories() error

DeleteMissingRepositories deletes all repository records that lost Git files.

func DeleteNotice

func DeleteNotice(id int64) error

DeleteNotice deletes a system notice by given ID.

func DeleteNotices

func DeleteNotices(start, end int64) error

DeleteNotices deletes all notices with ID from start to end (inclusive).

func DeleteNoticesByIDs

func DeleteNoticesByIDs(ids []int64) error

DeleteNoticesByIDs deletes notices by given IDs.

func DeleteOldRepositoryArchives

func DeleteOldRepositoryArchives()

func DeleteOrganization

func DeleteOrganization(org *User) (err error)

DeleteOrganization completely and permanently deletes everything of organization.

func DeletePublicKey

func DeletePublicKey(doer *User, id int64) (err error)

DeletePublicKey deletes SSH key information both in database and authorized_keys file.

func DeleteReleaseOfRepoByID

func DeleteReleaseOfRepoByID(repoID, id int64) error

DeleteReleaseOfRepoByID deletes a release and corresponding Git tag by given ID.

func DeleteRepository

func DeleteRepository(ownerID, repoID int64) error

DeleteRepository deletes a repository for a user or organization.

func DeleteRepositoryArchives

func DeleteRepositoryArchives() error

DeleteRepositoryArchives deletes all repositories' archives.

func DeleteTeam

func DeleteTeam(t *Team) error

DeleteTeam deletes given team. It's caller's responsibility to assign organization ID.

func DeleteTwoFactor

func DeleteTwoFactor(userID int64) (err error)

DeleteTwoFactor removes two-factor authentication token and recovery codes of given user.

func DeleteUpload

func DeleteUpload(u *Upload) error

func DeleteUploadByUUID

func DeleteUploadByUUID(uuid string) error

func DeleteUploads

func DeleteUploads(uploads ...*Upload) (err error)

func DeleteUser

func DeleteUser(u *User) (err error)

DeleteUser completely and permanently deletes everything of a user, but issues/comments/pulls will be kept and shown as someone has been deleted.

func DeleteWebhookOfOrgByID

func DeleteWebhookOfOrgByID(orgID, id int64) error

DeleteWebhookOfOrgByID deletes webhook of organization by given ID.

func DeleteWebhookOfRepoByID

func DeleteWebhookOfRepoByID(repoID, id int64) error

DeleteWebhookOfRepoByID deletes webhook of repository by given ID.

func DeliverHooks

func DeliverHooks()

DeliverHooks checks and delivers undelivered hooks. TODO: shoot more hooks at same time.

func DiscordLinkFormatter

func DiscordLinkFormatter(url string, text string) string

func DiscordSHALinkFormatter

func DiscordSHALinkFormatter(url string, text string) string

func DiscordTextFormatter

func DiscordTextFormatter(s string) string

func DumpDatabase

func DumpDatabase(db *gorm.DB, dirPath string, verbose bool) error

DumpDatabase dumps all data from database to file system in JSON Lines format.

func FilterRepositoryWithIssues

func FilterRepositoryWithIssues(repoIDs []int64) ([]int64, error)

FilterRepositoryWithIssues selects repositories that are using interal issue tracker and has disabled external tracker from given set. It returns nil if result set is empty.

func FollowUser

func FollowUser(userID, followID int64) (err error)

FollowUser marks someone be another's follower.

func GetLabelTemplateFile

func GetLabelTemplateFile(name string) ([][2]string, error)

GetLabelTemplateFile loads the label template file by given name, then parses and returns a list of name-color pairs.

func GetOrgIDsByUserID

func GetOrgIDsByUserID(userID int64, showPrivate bool) ([]int64, error)

GetOrgIDsByUserID returns a list of organization IDs that user belongs to. The showPrivate indicates whether to include private memberships.

func GetRepoIssueStats

func GetRepoIssueStats(repoID, userID int64, filterMode FilterMode, isPull bool) (numOpen int64, numClosed int64)

GetRepoIssueStats returns number of open and closed repository issues by given filter mode.

func GetRepositoryCount

func GetRepositoryCount(u *User) (int64, error)

GetRepositoryCount returns the total number of repositories of user.

func GetUserEmailsByNames

func GetUserEmailsByNames(names []string) []string

GetUserEmailsByNames returns a list of e-mails corresponds to names.

func GetUserIDsByNames

func GetUserIDsByNames(names []string) []int64

GetUserIDsByNames returns a slice of ids corresponds to names.

func GetUserSalt

func GetUserSalt() (string, error)

GetUserSalt returns a random user salt token.

func GitFsck

func GitFsck()

GitFsck calls 'git fsck' to check repository health.

func GitGcRepos

func GitGcRepos() error

func HandleMirrorCredentials

func HandleMirrorCredentials(url string, mosaics bool) string

HandleMirrorCredentials replaces user credentials from HTTP/HTTPS URL with placeholder <credentials>. It returns original string if protocol is not HTTP/HTTPS. TODO(unknwon): Use url.Parse.

func HasAccess

func HasAccess(userID int64, repo *Repository, testMode AccessMode) (bool, error)

HasAccess returns true if someone has the request access level. User can be nil! Deprecated: Use Perms.Authorize instead.

func HasDeployKey

func HasDeployKey(keyID, repoID int64) bool

HasDeployKey returns true if public key is a deploy key of given repository.

func HasIssueLabel

func HasIssueLabel(issueID, labelID int64) bool

HasIssueLabel returns true if issue has been labeled.

func HasTeamRepo

func HasTeamRepo(orgID, teamID, repoID int64) bool

HasTeamRepo returns true if given team has access to the repository of the organization.

func ImportDatabase

func ImportDatabase(db *gorm.DB, dirPath string, verbose bool) error

ImportDatabase imports data from backup archive in JSON Lines format.

func Init

func Init(w io.Writer) (*gorm.DB, error)

func InitDeliverHooks

func InitDeliverHooks()

func InitSyncMirrors

func InitSyncMirrors()

func InitTestPullRequests

func InitTestPullRequests()

func IsBranchOfRepoRequirePullRequest

func IsBranchOfRepoRequirePullRequest(repoID int64, name string) bool

IsBranchOfRepoRequirePullRequest returns true if branch requires pull request in given repository.

func IsCollaborator

func IsCollaborator(repoID, userID int64) bool

IsCollaborator returns true if the user is a collaborator of the repository.

func IsEmailUsed

func IsEmailUsed(email string) (bool, error)

IsEmailUsed returns true if the email has been used.

func IsErrAccessTokenAlreadyExist

func IsErrAccessTokenAlreadyExist(err error) bool

func IsErrAccessTokenNotExist

func IsErrAccessTokenNotExist(err error) bool

func IsErrAttachmentNotExist

func IsErrAttachmentNotExist(err error) bool

func IsErrBranchNotExist

func IsErrBranchNotExist(err error) bool

func IsErrCommentNotExist

func IsErrCommentNotExist(err error) bool

func IsErrDeployKeyAlreadyExist

func IsErrDeployKeyAlreadyExist(err error) bool

func IsErrDeployKeyNameAlreadyUsed

func IsErrDeployKeyNameAlreadyUsed(err error) bool

func IsErrDeployKeyNotExist

func IsErrDeployKeyNotExist(err error) bool

func IsErrEmailAlreadyUsed

func IsErrEmailAlreadyUsed(err error) bool

func IsErrInvalidCloneAddr

func IsErrInvalidCloneAddr(err error) bool

func IsErrInvalidTagName

func IsErrInvalidTagName(err error) bool

func IsErrIssueNotExist

func IsErrIssueNotExist(err error) bool

func IsErrKeyAccessDenied

func IsErrKeyAccessDenied(err error) bool

func IsErrKeyAlreadyExist

func IsErrKeyAlreadyExist(err error) bool

func IsErrKeyNameAlreadyUsed

func IsErrKeyNameAlreadyUsed(err error) bool

func IsErrKeyNotExist

func IsErrKeyNotExist(err error) bool

func IsErrKeyUnableVerify

func IsErrKeyUnableVerify(err error) bool

func IsErrLFSObjectNotExist

func IsErrLFSObjectNotExist(err error) bool

func IsErrLabelNotExist

func IsErrLabelNotExist(err error) bool

func IsErrLastOrgOwner

func IsErrLastOrgOwner(err error) bool

func IsErrLoginSourceAlreadyExist

func IsErrLoginSourceAlreadyExist(err error) bool

func IsErrLoginSourceInUse

func IsErrLoginSourceInUse(err error) bool

func IsErrLoginSourceNotExist

func IsErrLoginSourceNotExist(err error) bool

func IsErrMilestoneNotExist

func IsErrMilestoneNotExist(err error) bool

func IsErrNameNotAllowed

func IsErrNameNotAllowed(err error) bool

func IsErrPullRequestNotExist

func IsErrPullRequestNotExist(err error) bool

func IsErrReachLimitOfRepo

func IsErrReachLimitOfRepo(err error) bool

func IsErrReleaseAlreadyExist

func IsErrReleaseAlreadyExist(err error) bool

func IsErrReleaseNotExist

func IsErrReleaseNotExist(err error) bool

func IsErrRepoAlreadyExist

func IsErrRepoAlreadyExist(err error) bool

func IsErrRepoFileAlreadyExist

func IsErrRepoFileAlreadyExist(err error) bool

func IsErrRepoNotExist

func IsErrRepoNotExist(err error) bool

func IsErrTeamAlreadyExist

func IsErrTeamAlreadyExist(err error) bool

func IsErrTeamNotExist

func IsErrTeamNotExist(err error) bool

func IsErrTwoFactorNotFound

func IsErrTwoFactorNotFound(err error) bool

func IsErrUpdateTaskNotExist

func IsErrUpdateTaskNotExist(err error) bool

func IsErrUploadNotExist

func IsErrUploadNotExist(err error) bool

func IsErrUserAlreadyExist

func IsErrUserAlreadyExist(err error) bool

func IsErrUserHasOrgs

func IsErrUserHasOrgs(err error) bool

func IsErrUserNotExist

func IsErrUserNotExist(err error) bool

func IsErrUserOwnRepos

func IsErrUserOwnRepos(err error) bool

func IsErrWebhookNotExist

func IsErrWebhookNotExist(err error) bool

func IsErrWikiAlreadyExist

func IsErrWikiAlreadyExist(err error) bool

func IsFollowing

func IsFollowing(userID, followID int64) bool

func IsHookTaskNotExist

func IsHookTaskNotExist(err error) bool

func IsOrganizationMember

func IsOrganizationMember(orgId, uid int64) bool

IsOrganizationMember returns true if given user is member of organization.

func IsOrganizationOwner

func IsOrganizationOwner(orgID, userID int64) bool

IsOrganizationOwner returns true if given user is in the owner team.

func IsPublicMembership

func IsPublicMembership(orgId, uid int64) bool

IsPublicMembership returns true if given user public his/her membership.

func IsReleaseExist

func IsReleaseExist(repoID int64, tagName string) (bool, error)

IsReleaseExist returns true if release with given tag name already exists.

func IsRepositoryExist

func IsRepositoryExist(u *User, repoName string) (bool, error)

IsRepositoryExist returns true if the repository with given name under user has already existed.

func IsStaring

func IsStaring(userID, repoID int64) bool

IsStaring checks if user has starred given repository.

func IsTeamMember

func IsTeamMember(orgID, teamID, uid int64) bool

IsTeamMember returns true if given user is a member of team.

func IsTwoFactorRecoveryCodeNotFound

func IsTwoFactorRecoveryCodeNotFound(err error) bool

func IsUsableTeamName

func IsUsableTeamName(name string) error

IsUsableTeamName return an error if given name is a reserved name or pattern.

func IsUserExist

func IsUserExist(uid int64, name string) (bool, error)

IsUserExist checks if given user name exist, the user name should be noncased unique. If uid is presented, then check will rule out that one, it is used when update a user name in settings page.

func IsUserInProtectBranchWhitelist

func IsUserInProtectBranchWhitelist(repoID, userID int64, branch string) bool

IsUserInProtectBranchWhitelist returns true if given user is in the whitelist of a branch in a repository.

func IsValidHookContentType

func IsValidHookContentType(name string) bool

IsValidHookContentType returns true if given name is a valid hook content type.

func IsValidHookTaskType

func IsValidHookTaskType(name string) bool

IsValidHookTaskType returns true if given name is a valid hook task type.

func IsWatching

func IsWatching(userID, repoID int64) bool

IsWatching checks if user has watched given repository.

func IssuesCount

func IssuesCount(opts *IssuesOptions) (int64, error)

IssuesCount returns the number of issues by given conditions.

func LoadRepoConfig

func LoadRepoConfig()

func MakeEmailPrimary

func MakeEmailPrimary(userID int64, email *EmailAddress) error

func MarkdownLinkFormatter

func MarkdownLinkFormatter(link, text string) string

Format link addr and title into markdown style

func MergePullRequestAction

func MergePullRequestAction(actUser *User, repo *Repository, pull *Issue) error

MergePullRequestAction adds new action for merging pull request.

func MilestoneStats

func MilestoneStats(repoID int64) (open int64, closed int64)

MilestoneStats returns number of open and closed milestones of given repository.

func MirrorSyncCreateAction

func MirrorSyncCreateAction(repo *Repository, refName string) error

MirrorSyncCreateAction adds new action for mirror synchronization of new reference.

func MirrorSyncDeleteAction

func MirrorSyncDeleteAction(repo *Repository, refName string) error

MirrorSyncCreateAction adds new action for mirror synchronization of delete reference.

func MirrorSyncPushAction

func MirrorSyncPushAction(repo *Repository, opts MirrorSyncPushActionOptions) error

MirrorSyncPushAction adds new action for mirror synchronization of pushed commits.

func MirrorUpdate

func MirrorUpdate()

MirrorUpdate checks and updates mirror repositories.

func NewEngine

func NewEngine() (err error)

func NewIssue

func NewIssue(repo *Repository, issue *Issue, labelIDs []int64, uuids []string) (err error)

NewIssue creates new issue with labels and attachments for repository.

func NewIssueLabel

func NewIssueLabel(issue *Issue, label *Label) (err error)

NewIssueLabel creates a new issue-label relation.

func NewIssueLabels

func NewIssueLabels(issue *Issue, labels []*Label) (err error)

NewIssueLabels creates a list of issue-label relations.

func NewIssueUsers

func NewIssueUsers(repo *Repository, issue *Issue) (err error)

NewIssueUsers adds new issue-user relations for new issue of repository.

func NewLabels

func NewLabels(labels ...*Label) error

NewLabels creates new label(s) for a repository.

func NewMailerIssue

func NewMailerIssue(issue *Issue) email.Issue

func NewMailerRepo

func NewMailerRepo(repo *Repository) email.Repository

func NewMailerUser

func NewMailerUser(u *User) email.User

func NewMilestone

func NewMilestone(m *Milestone) (err error)

NewMilestone creates new milestone of repository.

func NewPullRequest

func NewPullRequest(repo *Repository, pull *Issue, labelIDs []int64, uuids []string, pr *PullRequest, patch []byte) (err error)

NewPullRequest creates new pull request with labels for repository.

func NewRelease

func NewRelease(gitRepo *git.Repository, r *Release, uuids []string) error

NewRelease creates a new release with attachments for repository.

func NewRepoAction

func NewRepoAction(doer, owner *User, repo *Repository) (err error)

NewRepoAction adds new action for creating repository.

func NewRepoContext

func NewRepoContext()

func NewTeam

func NewTeam(t *Team) error

NewTeam creates a record of new team. It's caller's responsibility to assign organization ID.

func NewTestEngine

func NewTestEngine() error

func NotifyWatchers

func NotifyWatchers(act *Action) error

NotifyWatchers creates batch of actions for every watcher.

func PairsContains

func PairsContains(ius []*IssueUser, issueId, uid int64) int

PairsContains returns true when pairs list contains given issue.

func Ping

func Ping() error

func PrepareWebhooks

func PrepareWebhooks(repo *Repository, event HookEventType, p api.Payloader) error

PrepareWebhooks adds all active webhooks to task queue.

func PushUpdate

func PushUpdate(opts PushUpdateOptions) (err error)

PushUpdate must be called for any push actions in order to generates necessary push action history feeds.

func RegenerateRecoveryCodes

func RegenerateRecoveryCodes(userID int64) error

RegenerateRecoveryCodes regenerates new set of recovery codes for given user.

func ReinitMissingRepositories

func ReinitMissingRepositories() error

ReinitMissingRepositories reinitializes all repository records that lost Git files.

func RemoveAllWithNotice

func RemoveAllWithNotice(title, path string)

RemoveAllWithNotice removes all directories in given path and creates a system notice when error occurs.

func RemoveOrgRepo

func RemoveOrgRepo(orgID, repoID int64) error

RemoveOrgRepo removes all team-repository relations of given organization.

func RemoveOrgUser

func RemoveOrgUser(orgID, userID int64) error

RemoveOrgUser removes user from given organization.

func RemoveTeamMember

func RemoveTeamMember(orgID, teamID, uid int64) error

RemoveTeamMember removes member from given team of given organization.

func RemoveTeamRepo

func RemoveTeamRepo(teamID, repoID int64) error

RemoveTeamRepo deletes repository relation to team.

func RenameRepoAction

func RenameRepoAction(actUser *User, oldRepoName string, repo *Repository) error

RenameRepoAction adds new action for renaming a repository.

func RepoPath

func RepoPath(userName, repoName string) string

RepoPath returns repository path by given user and repository name.

func RewriteAuthorizedKeys

func RewriteAuthorizedKeys() error

RewriteAuthorizedKeys removes any authorized key and rewrite all keys from database again. Note: x.Iterate does not get latest data after insert/delete, so we have to call this function outsite any session scope independently.

func SMTPAuth

func SMTPAuth(a smtp.Auth, cfg *SMTPConfig) error

func SSHKeyGenParsePublicKey

func SSHKeyGenParsePublicKey(key string) (string, int, error)

SSHKeyGenParsePublicKey extracts key type and length using ssh-keygen.

func SSHNativeParsePublicKey

func SSHNativeParsePublicKey(keyLine string) (string, int, error)

SSHNativeParsePublicKey extracts the key type and length using the golang SSH library.

func SetEngine

func SetEngine() (*gorm.DB, error)

func SetMockAccessTokensStore

func SetMockAccessTokensStore(t *testing.T, mock AccessTokensStore)

func SetMockLFSStore

func SetMockLFSStore(t *testing.T, mock LFSStore)

func SetMockPermsStore

func SetMockPermsStore(t *testing.T, mock PermsStore)

func SetMockReposStore

func SetMockReposStore(t *testing.T, mock ReposStore)

func SetMockTwoFactorsStore

func SetMockTwoFactorsStore(t *testing.T, mock TwoFactorsStore)

func SetMockUsersStore

func SetMockUsersStore(t *testing.T, mock UsersStore)

func SlackLinkFormatter

func SlackLinkFormatter(url string, text string) string

func SlackShortTextFormatter

func SlackShortTextFormatter(s string) string

func SortReleases

func SortReleases(rels []*Release)

SortReleases sorts releases by number of commits and created time.

func StarRepo

func StarRepo(userID, repoID int64, star bool) (err error)

Star or unstar repository.

func SyncMirrors

func SyncMirrors()

SyncMirrors checks and syncs mirrors. TODO: sync more mirrors at same time.

func SyncRepositoryHooks

func SyncRepositoryHooks() error

SyncRepositoryHooks rewrites all repositories' pre-receive, update and post-receive hooks to make sure the binary and custom conf path are up-to-date.

func TestPullRequests

func TestPullRequests()

TestPullRequests checks and tests untested patches of pull requests. TODO: test more pull requests at same time.

func TestWebhook

func TestWebhook(repo *Repository, event HookEventType, p api.Payloader, webhookID int64) error

TestWebhook adds the test webhook matches the ID to task queue.

func ToWikiPageName

func ToWikiPageName(urlString string) string

ToWikiPageName formats a URL back to corresponding wiki page name, and removes leading characters './' to prevent changing files that are not belong to wiki repository.

func ToWikiPageURL

func ToWikiPageURL(name string) string

ToWikiPageURL formats a string to corresponding wiki URL name.

func TransferOwnership

func TransferOwnership(doer *User, newOwnerName string, repo *Repository) error

TransferOwnership transfers all corresponding setting from old user to new one.

func TransferRepoAction

func TransferRepoAction(doer, oldOwner *User, repo *Repository) error

TransferRepoAction adds new action for transferring repository, the Owner field of repository is assumed to be new owner.

func UnfollowUser

func UnfollowUser(userID, followID int64) (err error)

UnfollowUser unmarks someone be another's follower.

func UpdateComment

func UpdateComment(doer *User, c *Comment, oldContent string) (err error)

UpdateComment updates information of comment.

func UpdateDeployKey

func UpdateDeployKey(key *DeployKey) error

UpdateDeployKey updates deploy key information.

func UpdateHookTask

func UpdateHookTask(t *HookTask) error

UpdateHookTask updates information of hook task.

func UpdateIssue

func UpdateIssue(issue *Issue) error

UpdateIssue updates all fields of given issue.

func UpdateIssueCols

func UpdateIssueCols(issue *Issue, cols ...string) error

UpdateIssueCols only updates values of specific columns for given issue.

func UpdateIssueUserByAssignee

func UpdateIssueUserByAssignee(issue *Issue) (err error)

UpdateIssueUserByAssignee updates issue-user relation for assignee.

func UpdateIssueUserByRead

func UpdateIssueUserByRead(uid, issueID int64) error

UpdateIssueUserByRead updates issue-user relation for reading.

func UpdateIssueUsersByStatus

func UpdateIssueUsersByStatus(issueID int64, isClosed bool) error

UpdateIssueUsersByStatus updates issue-user relations by issue status.

func UpdateIssuesCommit

func UpdateIssuesCommit(doer *User, repo *Repository, commits []*PushCommit) error

UpdateIssuesCommit checks if issues are manipulated by commit message.

func UpdateLabel

func UpdateLabel(l *Label) error

UpdateLabel updates label information.

func UpdateLocalCopyBranch

func UpdateLocalCopyBranch(repoPath, localPath, branch string, isWiki bool) (err error)

UpdateLocalCopy fetches latest changes of given branch from repoPath to localPath. It creates a new clone if local copy does not exist, but does not checks out to a specific branch if the local copy belongs to a wiki. For existing local copy, it checks out to target branch by default, and safe to assume subsequent operations are against target branch when caller has confidence about no race condition.

func UpdateMilestone

func UpdateMilestone(m *Milestone) error

UpdateMilestone updates information of given milestone.

func UpdateMirror

func UpdateMirror(m *Mirror) error

func UpdateOrgProtectBranch

func UpdateOrgProtectBranch(repo *Repository, protectBranch *ProtectBranch, whitelistUserIDs, whitelistTeamIDs string) (err error)

UpdateOrgProtectBranch saves branch protection options of organizational repository. If ID is 0, it creates a new record. Otherwise, updates existing record. This function also performs check if whitelist user and team's IDs have been changed to avoid unnecessary whitelist delete and regenerate.

func UpdateProtectBranch

func UpdateProtectBranch(protectBranch *ProtectBranch) (err error)

UpdateProtectBranch saves branch protection options. If ID is 0, it creates a new record. Otherwise, updates existing record.

func UpdatePublicKey

func UpdatePublicKey(key *PublicKey) error

UpdatePublicKey updates given public key.

func UpdateRelease

func UpdateRelease(doer *User, gitRepo *git.Repository, r *Release, isPublish bool, uuids []string) (err error)

UpdateRelease updates information of a release.

func UpdateRepository

func UpdateRepository(repo *Repository, visibilityChanged bool) (err error)

func UpdateTeam

func UpdateTeam(t *Team, authChanged bool) (err error)

UpdateTeam updates information of team.

func UpdateUser

func UpdateUser(u *User) error

UpdateUser updates user's information.

func UpdateWebhook

func UpdateWebhook(w *Webhook) error

UpdateWebhook updates information of webhook.

func UploadLocalPath

func UploadLocalPath(uuid string) string

UploadLocalPath returns where uploads is stored in local file system based on given UUID.

func UseRecoveryCode

func UseRecoveryCode(userID int64, code string) error

UseRecoveryCode validates recovery code of given user and marks it is used if valid.

func UserPath

func UserPath(username string) string

UserPath returns the path absolute path of user repositories.

func WatchRepo

func WatchRepo(userID, repoID int64, watch bool) (err error)

Watch or unwatch repository.

func WikiPath

func WikiPath(userName, repoName string) string

WikiPath returns wiki data path by given user and repository name.

Types

type Access

type Access struct {
	ID     int64
	UserID int64 `xorm:"UNIQUE(s)"`
	RepoID int64 `xorm:"UNIQUE(s)"`
	Mode   AccessMode
}

Access represents the highest access level of a user to a repository. The only access type that is not in this table is the real owner of a repository. In case of an organization repository, the members of the owners team are in this table.

type AccessMode

type AccessMode int
const (
	AccessModeNone  AccessMode = iota // 0
	AccessModeRead                    // 1
	AccessModeWrite                   // 2
	AccessModeAdmin                   // 3
	AccessModeOwner                   // 4
)

func ParseAccessMode

func ParseAccessMode(permission string) AccessMode

ParseAccessMode returns corresponding access mode to given permission string.

func UserAccessMode

func UserAccessMode(userID int64, repo *Repository) (AccessMode, error)

UserAccessMode returns the access mode of given user to the repository.

func (AccessMode) String

func (mode AccessMode) String() string

type AccessToken

type AccessToken struct {
	ID     int64
	UserID int64 `xorm:"uid INDEX" gorm:"COLUMN:uid;INDEX"`
	Name   string
	Sha1   string `xorm:"UNIQUE VARCHAR(40)" gorm:"TYPE:VARCHAR(40);UNIQUE"`

	Created           time.Time `xorm:"-" gorm:"-" json:"-"`
	CreatedUnix       int64
	Updated           time.Time `xorm:"-" gorm:"-" json:"-"`
	UpdatedUnix       int64
	HasRecentActivity bool `xorm:"-" gorm:"-" json:"-"`
	HasUsed           bool `xorm:"-" gorm:"-" json:"-"`
}

AccessToken is a personal access token.

func (*AccessToken) AfterFind

func (t *AccessToken) AfterFind()

NOTE: This is a GORM query hook.

func (*AccessToken) BeforeCreate

func (t *AccessToken) BeforeCreate()

NOTE: This is a GORM create hook.

func (*AccessToken) BeforeUpdate

func (t *AccessToken) BeforeUpdate()

NOTE: This is a GORM update hook.

type AccessTokensStore

type AccessTokensStore interface {
	// Create creates a new access token and persist to database.
	// It returns ErrAccessTokenAlreadyExist when an access token
	// with same name already exists for the user.
	Create(userID int64, name string) (*AccessToken, error)
	// DeleteByID deletes the access token by given ID.
	// 🚨 SECURITY: The "userID" is required to prevent attacker
	// deletes arbitrary access token that belongs to another user.
	DeleteByID(userID, id int64) error
	// GetBySHA returns the access token with given SHA1.
	// It returns ErrAccessTokenNotExist when not found.
	GetBySHA(sha string) (*AccessToken, error)
	// List returns all access tokens belongs to given user.
	List(userID int64) ([]*AccessToken, error)
	// Save persists all values of given access token.
	// The Updated field is set to current time automatically.
	Save(t *AccessToken) error
}

AccessTokensStore is the persistent interface for access tokens.

NOTE: All methods are sorted in alphabetical order.

var AccessTokens AccessTokensStore

type Action

type Action struct {
	ID           int64
	UserID       int64 // Receiver user ID
	OpType       ActionType
	ActUserID    int64  // Doer user ID
	ActUserName  string // Doer user name
	ActAvatar    string `xorm:"-" json:"-"`
	RepoID       int64  `xorm:"INDEX"`
	RepoUserName string
	RepoName     string
	RefName      string
	IsPrivate    bool      `xorm:"NOT NULL DEFAULT false"`
	Content      string    `xorm:"TEXT"`
	Created      time.Time `xorm:"-" json:"-"`
	CreatedUnix  int64
}

Action represents user operation type and other information to repository, it implemented interface base.Actioner so that can be used in template render.

func GetFeeds

func GetFeeds(ctxUser *User, actorID, afterID int64, isProfile bool) ([]*Action, error)

GetFeeds returns action list of given user in given context. actorID is the user who's requesting, ctxUserID is the user/org that is requested. actorID can be -1 when isProfile is true or to skip the permission check.

func (*Action) AfterSet

func (a *Action) AfterSet(colName string, _ xorm.Cell)

func (*Action) BeforeInsert

func (a *Action) BeforeInsert()

func (*Action) GetActUserName

func (a *Action) GetActUserName() string

func (*Action) GetBranch

func (a *Action) GetBranch() string

func (*Action) GetContent

func (a *Action) GetContent() string

func (*Action) GetCreate

func (a *Action) GetCreate() time.Time

func (*Action) GetIssueContent

func (a *Action) GetIssueContent() string

func (*Action) GetIssueInfos

func (a *Action) GetIssueInfos() []string

func (*Action) GetIssueTitle

func (a *Action) GetIssueTitle() string

func (*Action) GetOpType

func (a *Action) GetOpType() int
func (a *Action) GetRepoLink() string

func (*Action) GetRepoName

func (a *Action) GetRepoName() string

func (*Action) GetRepoPath

func (a *Action) GetRepoPath() string

func (*Action) GetRepoUserName

func (a *Action) GetRepoUserName() string

func (*Action) ShortActUserName

func (a *Action) ShortActUserName() string

func (*Action) ShortRepoName

func (a *Action) ShortRepoName() string

func (*Action) ShortRepoPath

func (a *Action) ShortRepoPath() string

func (*Action) ShortRepoUserName

func (a *Action) ShortRepoUserName() string

type ActionType

type ActionType int
const (
	ACTION_CREATE_REPO         ActionType = iota + 1 // 1
	ACTION_RENAME_REPO                               // 2
	ACTION_STAR_REPO                                 // 3
	ACTION_WATCH_REPO                                // 4
	ACTION_COMMIT_REPO                               // 5
	ACTION_CREATE_ISSUE                              // 6
	ACTION_CREATE_PULL_REQUEST                       // 7
	ACTION_TRANSFER_REPO                             // 8
	ACTION_PUSH_TAG                                  // 9
	ACTION_COMMENT_ISSUE                             // 10
	ACTION_MERGE_PULL_REQUEST                        // 11
	ACTION_CLOSE_ISSUE                               // 12
	ACTION_REOPEN_ISSUE                              // 13
	ACTION_CLOSE_PULL_REQUEST                        // 14
	ACTION_REOPEN_PULL_REQUEST                       // 15
	ACTION_CREATE_BRANCH                             // 16
	ACTION_DELETE_BRANCH                             // 17
	ACTION_DELETE_TAG                                // 18
	ACTION_FORK_REPO                                 // 19
	ACTION_MIRROR_SYNC_PUSH                          // 20
	ACTION_MIRROR_SYNC_CREATE                        // 21
	ACTION_MIRROR_SYNC_DELETE                        // 22
)

Note: To maintain backward compatibility only append to the end of list

type Attachment

type Attachment struct {
	ID        int64
	UUID      string `xorm:"uuid UNIQUE"`
	IssueID   int64  `xorm:"INDEX"`
	CommentID int64
	ReleaseID int64 `xorm:"INDEX"`
	Name      string

	Created     time.Time `xorm:"-" json:"-"`
	CreatedUnix int64
}

Attachment represent a attachment of issue/comment/release.

func GetAttachmentByUUID

func GetAttachmentByUUID(uuid string) (*Attachment, error)

GetAttachmentByUUID returns attachment by given UUID.

func GetAttachmentsByCommentID

func GetAttachmentsByCommentID(commentID int64) ([]*Attachment, error)

GetAttachmentsByCommentID returns all attachments of a comment.

func GetAttachmentsByIssueID

func GetAttachmentsByIssueID(issueID int64) ([]*Attachment, error)

GetAttachmentsByIssueID returns all attachments of an issue.

func GetAttachmentsByReleaseID

func GetAttachmentsByReleaseID(releaseID int64) ([]*Attachment, error)

GetAttachmentsByReleaseID returns all attachments of a release.

func NewAttachment

func NewAttachment(name string, buf []byte, file multipart.File) (_ *Attachment, err error)

NewAttachment creates a new attachment object.

func (*Attachment) AfterSet

func (a *Attachment) AfterSet(colName string, _ xorm.Cell)

func (*Attachment) BeforeInsert

func (a *Attachment) BeforeInsert()

func (*Attachment) LocalPath

func (attach *Attachment) LocalPath() string

LocalPath returns where attachment is stored in local file system.

type Branch

type Branch struct {
	RepoPath string
	Name     string

	IsProtected bool
	Commit      *git.Commit
}

func GetBranchesByPath

func GetBranchesByPath(path string) ([]*Branch, error)

func (*Branch) GetCommit

func (br *Branch) GetCommit() (*git.Commit, error)
type CloneLink struct {
	SSH   string
	HTTPS string
	Git   string
}

CloneLink represents different types of clone URLs of repository.

type Collaboration

type Collaboration struct {
	ID     int64
	RepoID int64      `xorm:"UNIQUE(s) INDEX NOT NULL"`
	UserID int64      `xorm:"UNIQUE(s) INDEX NOT NULL"`
	Mode   AccessMode `xorm:"DEFAULT 2 NOT NULL"`
}

Collaboration represent the relation between an individual and a repository.

func (*Collaboration) ModeI18nKey

func (c *Collaboration) ModeI18nKey() string

type Collaborator

type Collaborator struct {
	*User
	Collaboration *Collaboration
}

Collaborator represents a user with collaboration details.

func (*Collaborator) APIFormat

func (c *Collaborator) APIFormat() *api.Collaborator

type Comment

type Comment struct {
	ID              int64
	Type            CommentType
	PosterID        int64
	Poster          *User  `xorm:"-" json:"-"`
	IssueID         int64  `xorm:"INDEX"`
	Issue           *Issue `xorm:"-" json:"-"`
	CommitID        int64
	Line            int64
	Content         string `xorm:"TEXT"`
	RenderedContent string `xorm:"-" json:"-"`

	Created     time.Time `xorm:"-" json:"-"`
	CreatedUnix int64
	Updated     time.Time `xorm:"-" json:"-"`
	UpdatedUnix int64

	// Reference issue in commit message
	CommitSHA string `xorm:"VARCHAR(40)"`

	Attachments []*Attachment `xorm:"-" json:"-"`

	// For view issue page.
	ShowTag CommentTag `xorm:"-" json:"-"`
}

Comment represents a comment in commit and issue page.

func CreateComment

func CreateComment(opts *CreateCommentOptions) (comment *Comment, err error)

CreateComment creates comment of issue or commit.

func CreateIssueComment

func CreateIssueComment(doer *User, repo *Repository, issue *Issue, content string, attachments []string) (*Comment, error)

CreateIssueComment creates a plain issue comment.

func GetCommentByID

func GetCommentByID(id int64) (*Comment, error)

GetCommentByID returns the comment by given ID.

func GetCommentsByIssueID

func GetCommentsByIssueID(issueID int64) ([]*Comment, error)

GetCommentsByIssueID returns all comments of an issue.

func GetCommentsByIssueIDSince

func GetCommentsByIssueIDSince(issueID, since int64) ([]*Comment, error)

GetCommentsByIssueIDSince returns a list of comments of an issue since a given time point.

func GetCommentsByRepoIDSince

func GetCommentsByRepoIDSince(repoID, since int64) ([]*Comment, error)

GetCommentsByRepoIDSince returns a list of comments for all issues in a repo since a given time point.

func (*Comment) APIFormat

func (c *Comment) APIFormat() *api.Comment

This method assumes following fields have been assigned with valid values: Required - Poster, Issue

func (*Comment) AfterSet

func (c *Comment) AfterSet(colName string, _ xorm.Cell)

func (*Comment) BeforeInsert

func (c *Comment) BeforeInsert()

func (*Comment) BeforeUpdate

func (c *Comment) BeforeUpdate()

func (*Comment) EventTag

func (c *Comment) EventTag() string

EventTag returns unique event hash tag for comment.

func (*Comment) HTMLURL

func (c *Comment) HTMLURL() string

func (*Comment) HashTag

func (c *Comment) HashTag() string

HashTag returns unique hash tag for comment.

func (*Comment) LoadAttributes

func (c *Comment) LoadAttributes() error

type CommentTag

type CommentTag int
const (
	COMMENT_TAG_NONE CommentTag = iota
	COMMENT_TAG_POSTER
	COMMENT_TAG_WRITER
	COMMENT_TAG_OWNER
)

type CommentType

type CommentType int

CommentType defines whether a comment is just a simple comment, an action (like close) or a reference.

const (
	// Plain comment, can be associated with a commit (CommitID > 0) and a line (LineNum > 0)
	COMMENT_TYPE_COMMENT CommentType = iota
	COMMENT_TYPE_REOPEN
	COMMENT_TYPE_CLOSE

	// References.
	COMMENT_TYPE_ISSUE_REF
	// Reference from a commit (not part of a pull request)
	COMMENT_TYPE_COMMIT_REF
	// Reference from a comment
	COMMENT_TYPE_COMMENT_REF
	// Reference from a pull request
	COMMENT_TYPE_PULL_REF
)

type CommitRepoActionOptions

type CommitRepoActionOptions struct {
	PusherName  string
	RepoOwnerID int64
	RepoName    string
	RefFullName string
	OldCommitID string
	NewCommitID string
	Commits     *PushCommits
}

type ComposeHookEnvsOptions

type ComposeHookEnvsOptions struct {
	AuthUser  *User
	OwnerName string
	OwnerSalt string
	RepoID    int64
	RepoName  string
	RepoPath  string
}

type CreateCommentOptions

type CreateCommentOptions struct {
	Type  CommentType
	Doer  *User
	Repo  *Repository
	Issue *Issue

	CommitID    int64
	CommitSHA   string
	LineNum     int64
	Content     string
	Attachments []string // UUIDs of attachments
}

type CreateLoginSourceOpts

type CreateLoginSourceOpts struct {
	Type      LoginType
	Name      string
	Activated bool
	Default   bool
	Config    interface{}
}

type CreateRepoOptions

type CreateRepoOptions struct {
	Name        string
	Description string
	Gitignores  string
	License     string
	Readme      string
	IsPrivate   bool
	IsMirror    bool
	AutoInit    bool
}

type CreateUserOpts

type CreateUserOpts struct {
	Name        string
	Email       string
	Password    string
	LoginSource int64
	Activated   bool
}

type DeleteRepoFileOptions

type DeleteRepoFileOptions struct {
	LastCommitID string
	OldBranch    string
	NewBranch    string
	TreePath     string
	Message      string
}

type DeployKey

type DeployKey struct {
	ID          int64
	KeyID       int64 `xorm:"UNIQUE(s) INDEX"`
	RepoID      int64 `xorm:"UNIQUE(s) INDEX"`
	Name        string
	Fingerprint string
	Content     string `xorm:"-" json:"-"`

	Created           time.Time `xorm:"-" json:"-"`
	CreatedUnix       int64
	Updated           time.Time `xorm:"-" json:"-"` // Note: Updated must below Created for AfterSet.
	UpdatedUnix       int64
	HasRecentActivity bool `xorm:"-" json:"-"`
	HasUsed           bool `xorm:"-" json:"-"`
}

DeployKey represents deploy key information and its relation with repository.

func AddDeployKey

func AddDeployKey(repoID int64, name, content string) (*DeployKey, error)

AddDeployKey add new deploy key to database and authorized_keys file.

func GetDeployKeyByID

func GetDeployKeyByID(id int64) (*DeployKey, error)

GetDeployKeyByID returns deploy key by given ID.

func GetDeployKeyByRepo

func GetDeployKeyByRepo(keyID, repoID int64) (*DeployKey, error)

GetDeployKeyByRepo returns deploy key by given public key ID and repository ID.

func ListDeployKeys

func ListDeployKeys(repoID int64) ([]*DeployKey, error)

ListDeployKeys returns all deploy keys by given repository ID.

func (*DeployKey) AfterSet

func (k *DeployKey) AfterSet(colName string, _ xorm.Cell)

func (*DeployKey) BeforeInsert

func (k *DeployKey) BeforeInsert()

func (*DeployKey) BeforeUpdate

func (k *DeployKey) BeforeUpdate()

func (*DeployKey) GetContent

func (k *DeployKey) GetContent() error

GetContent gets associated public key content.

type DingtalkActionCard

type DingtalkActionCard struct {
	Title          string `json:"title"`
	Text           string `json:"text"`
	HideAvatar     string `json:"hideAvatar"`
	BtnOrientation string `json:"btnOrientation"`
	SingleTitle    string `json:"singleTitle"`
	SingleURL      string `json:"singleURL"`
}

Refer: https://open-doc.dingtalk.com/docs/doc.htm?treeId=257&articleId=105735&docType=1

func NewDingtalkActionCard

func NewDingtalkActionCard(singleTitle, singleURL string) DingtalkActionCard

type DingtalkAtObject

type DingtalkAtObject struct {
	AtMobiles []string `json:"atMobiles"`
	IsAtAll   bool     `json:"isAtAll"`
}

Refer: https://open-doc.dingtalk.com/docs/doc.htm?treeId=257&articleId=105735&docType=1

type DingtalkPayload

type DingtalkPayload struct {
	MsgType    string             `json:"msgtype"`
	At         DingtalkAtObject   `json:"at"`
	ActionCard DingtalkActionCard `json:"actionCard"`
}

Refer: https://open-doc.dingtalk.com/docs/doc.htm?treeId=257&articleId=105735&docType=1

func GetDingtalkPayload

func GetDingtalkPayload(p api.Payloader, event HookEventType) (payload *DingtalkPayload, err error)

TODO: add content

func (*DingtalkPayload) JSONPayload

func (p *DingtalkPayload) JSONPayload() ([]byte, error)

type DiscordEmbedAuthorObject

type DiscordEmbedAuthorObject struct {
	Name    string `json:"name"`
	URL     string `json:"url"`
	IconURL string `json:"icon_url"`
}

type DiscordEmbedFieldObject

type DiscordEmbedFieldObject struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type DiscordEmbedFooterObject

type DiscordEmbedFooterObject struct {
	Text string `json:"text"`
}

type DiscordEmbedObject

type DiscordEmbedObject struct {
	Title       string                     `json:"title"`
	Description string                     `json:"description"`
	URL         string                     `json:"url"`
	Color       int                        `json:"color"`
	Footer      *DiscordEmbedFooterObject  `json:"footer"`
	Author      *DiscordEmbedAuthorObject  `json:"author"`
	Fields      []*DiscordEmbedFieldObject `json:"fields"`
}

type DiscordPayload

type DiscordPayload struct {
	Content   string                `json:"content"`
	Username  string                `json:"username"`
	AvatarURL string                `json:"avatar_url"`
	Embeds    []*DiscordEmbedObject `json:"embeds"`
}

func GetDiscordPayload

func GetDiscordPayload(p api.Payloader, event HookEventType, meta string) (payload *DiscordPayload, err error)

func (*DiscordPayload) JSONPayload

func (p *DiscordPayload) JSONPayload() ([]byte, error)

type EmailAddress

type EmailAddress struct {
	ID          int64
	UID         int64  `xorm:"INDEX NOT NULL" gorm:"INDEX"`
	Email       string `xorm:"UNIQUE NOT NULL" gorm:"UNIQUE"`
	IsActivated bool   `gorm:"NOT NULL;DEFAULT:FALSE"`
	IsPrimary   bool   `xorm:"-" gorm:"-" json:"-"`
}

EmailAddresses is the list of all email addresses of a user. Can contain the primary email address, but is not obligatory.

func GetEmailAddresses

func GetEmailAddresses(uid int64) ([]*EmailAddress, error)

GetEmailAddresses returns all email addresses belongs to given user.

func VerifyActiveEmailCode

func VerifyActiveEmailCode(code, email string) *EmailAddress

verify active code when active account

func (*EmailAddress) Activate

func (email *EmailAddress) Activate() error

type Engine

type Engine interface {
	Delete(interface{}) (int64, error)
	Exec(...interface{}) (sql.Result, error)
	Find(interface{}, ...interface{}) error
	Get(interface{}) (bool, error)
	ID(interface{}) *xorm.Session
	In(string, ...interface{}) *xorm.Session
	Insert(...interface{}) (int64, error)
	InsertOne(interface{}) (int64, error)
	Iterate(interface{}, xorm.IterFunc) error
	Sql(string, ...interface{}) *xorm.Session
	Table(interface{}) *xorm.Session
	Where(interface{}, ...interface{}) *xorm.Session
}

Engine represents a XORM engine or session.

type ErrAccessTokenAlreadyExist

type ErrAccessTokenAlreadyExist struct {
	// contains filtered or unexported fields
}

func (ErrAccessTokenAlreadyExist) Error

func (err ErrAccessTokenAlreadyExist) Error() string

type ErrAccessTokenNotExist

type ErrAccessTokenNotExist struct {
	// contains filtered or unexported fields
}

func (ErrAccessTokenNotExist) Error

func (err ErrAccessTokenNotExist) Error() string

func (ErrAccessTokenNotExist) NotFound

func (ErrAccessTokenNotExist) NotFound() bool

type ErrAttachmentNotExist

type ErrAttachmentNotExist struct {
	// contains filtered or unexported fields
}

func (ErrAttachmentNotExist) Error

func (err ErrAttachmentNotExist) Error() string

func (ErrAttachmentNotExist) NotFound

func (ErrAttachmentNotExist) NotFound() bool

type ErrBranchNotExist

type ErrBranchNotExist struct {
	// contains filtered or unexported fields
}

func (ErrBranchNotExist) Error

func (err ErrBranchNotExist) Error() string

func (ErrBranchNotExist) NotFound

func (ErrBranchNotExist) NotFound() bool

type ErrCommentNotExist

type ErrCommentNotExist struct {
	// contains filtered or unexported fields
}

func (ErrCommentNotExist) Error

func (err ErrCommentNotExist) Error() string

func (ErrCommentNotExist) NotFound

func (ErrCommentNotExist) NotFound() bool

type ErrDeployKeyAlreadyExist

type ErrDeployKeyAlreadyExist struct {
	KeyID  int64
	RepoID int64
}

func (ErrDeployKeyAlreadyExist) Error

func (err ErrDeployKeyAlreadyExist) Error() string

type ErrDeployKeyNameAlreadyUsed

type ErrDeployKeyNameAlreadyUsed struct {
	RepoID int64
	Name   string
}

func (ErrDeployKeyNameAlreadyUsed) Error

func (err ErrDeployKeyNameAlreadyUsed) Error() string

type ErrDeployKeyNotExist

type ErrDeployKeyNotExist struct {
	// contains filtered or unexported fields
}

func (ErrDeployKeyNotExist) Error

func (err ErrDeployKeyNotExist) Error() string

func (ErrDeployKeyNotExist) NotFound

func (ErrDeployKeyNotExist) NotFound() bool

type ErrEmailAlreadyUsed

type ErrEmailAlreadyUsed struct {
	// contains filtered or unexported fields
}

func (ErrEmailAlreadyUsed) Email

func (err ErrEmailAlreadyUsed) Email() string

func (ErrEmailAlreadyUsed) Error

func (err ErrEmailAlreadyUsed) Error() string

type ErrHookTaskNotExist

type ErrHookTaskNotExist struct {
	// contains filtered or unexported fields
}

func (ErrHookTaskNotExist) Error

func (err ErrHookTaskNotExist) Error() string

func (ErrHookTaskNotExist) NotFound

func (ErrHookTaskNotExist) NotFound() bool

type ErrInvalidCloneAddr

type ErrInvalidCloneAddr struct {
	IsURLError         bool
	IsInvalidPath      bool
	IsPermissionDenied bool
}

func (ErrInvalidCloneAddr) Error

func (err ErrInvalidCloneAddr) Error() string

type ErrInvalidTagName

type ErrInvalidTagName struct {
	TagName string
}

func (ErrInvalidTagName) Error

func (err ErrInvalidTagName) Error() string

type ErrIssueNotExist

type ErrIssueNotExist struct {
	// contains filtered or unexported fields
}

func (ErrIssueNotExist) Error

func (err ErrIssueNotExist) Error() string

func (ErrIssueNotExist) NotFound

func (ErrIssueNotExist) NotFound() bool

type ErrKeyAccessDenied

type ErrKeyAccessDenied struct {
	UserID int64
	KeyID  int64
	Note   string
}

func (ErrKeyAccessDenied) Error

func (err ErrKeyAccessDenied) Error() string

type ErrKeyAlreadyExist

type ErrKeyAlreadyExist struct {
	OwnerID int64
	Content string
}

func (ErrKeyAlreadyExist) Error

func (err ErrKeyAlreadyExist) Error() string

type ErrKeyNameAlreadyUsed

type ErrKeyNameAlreadyUsed struct {
	OwnerID int64
	Name    string
}

func (ErrKeyNameAlreadyUsed) Error

func (err ErrKeyNameAlreadyUsed) Error() string

type ErrKeyNotExist

type ErrKeyNotExist struct {
	ID int64
}

func (ErrKeyNotExist) Error

func (err ErrKeyNotExist) Error() string

type ErrKeyUnableVerify

type ErrKeyUnableVerify struct {
	Result string
}

func (ErrKeyUnableVerify) Error

func (err ErrKeyUnableVerify) Error() string

type ErrLFSObjectNotExist

type ErrLFSObjectNotExist struct {
	// contains filtered or unexported fields
}

func (ErrLFSObjectNotExist) Error

func (err ErrLFSObjectNotExist) Error() string

func (ErrLFSObjectNotExist) NotFound

func (ErrLFSObjectNotExist) NotFound() bool

type ErrLabelNotExist

type ErrLabelNotExist struct {
	// contains filtered or unexported fields
}

func (ErrLabelNotExist) Error

func (err ErrLabelNotExist) Error() string

func (ErrLabelNotExist) NotFound

func (ErrLabelNotExist) NotFound() bool

type ErrLastOrgOwner

type ErrLastOrgOwner struct {
	UID int64
}

func (ErrLastOrgOwner) Error

func (err ErrLastOrgOwner) Error() string

type ErrLoginSourceAlreadyExist

type ErrLoginSourceAlreadyExist struct {
	// contains filtered or unexported fields
}

func (ErrLoginSourceAlreadyExist) Error

func (err ErrLoginSourceAlreadyExist) Error() string

type ErrLoginSourceInUse

type ErrLoginSourceInUse struct {
	// contains filtered or unexported fields
}

func (ErrLoginSourceInUse) Error

func (err ErrLoginSourceInUse) Error() string

type ErrLoginSourceMismatch

type ErrLoginSourceMismatch struct {
	// contains filtered or unexported fields
}

func (ErrLoginSourceMismatch) Error

func (err ErrLoginSourceMismatch) Error() string

type ErrLoginSourceNotExist

type ErrLoginSourceNotExist struct {
	// contains filtered or unexported fields
}

func (ErrLoginSourceNotExist) Error

func (err ErrLoginSourceNotExist) Error() string

func (ErrLoginSourceNotExist) NotFound

func (ErrLoginSourceNotExist) NotFound() bool

type ErrMilestoneNotExist

type ErrMilestoneNotExist struct {
	// contains filtered or unexported fields
}

func (ErrMilestoneNotExist) Error

func (err ErrMilestoneNotExist) Error() string

func (ErrMilestoneNotExist) NotFound

func (ErrMilestoneNotExist) NotFound() bool

type ErrNameNotAllowed

type ErrNameNotAllowed struct {
	// contains filtered or unexported fields
}

func (ErrNameNotAllowed) Error

func (err ErrNameNotAllowed) Error() string

func (ErrNameNotAllowed) Value

func (err ErrNameNotAllowed) Value() string

type ErrPullRequestNotExist

type ErrPullRequestNotExist struct {
	// contains filtered or unexported fields
}

func (ErrPullRequestNotExist) Error

func (err ErrPullRequestNotExist) Error() string

func (ErrPullRequestNotExist) NotFound

func (ErrPullRequestNotExist) NotFound() bool

type ErrReachLimitOfRepo

type ErrReachLimitOfRepo struct {
	Limit int
}

func (ErrReachLimitOfRepo) Error

func (err ErrReachLimitOfRepo) Error() string

type ErrReleaseAlreadyExist

type ErrReleaseAlreadyExist struct {
	TagName string
}

func (ErrReleaseAlreadyExist) Error

func (err ErrReleaseAlreadyExist) Error() string

type ErrReleaseNotExist

type ErrReleaseNotExist struct {
	// contains filtered or unexported fields
}

func (ErrReleaseNotExist) Error

func (err ErrReleaseNotExist) Error() string

func (ErrReleaseNotExist) NotFound

func (ErrReleaseNotExist) NotFound() bool

type ErrRepoAlreadyExist

type ErrRepoAlreadyExist struct {
	// contains filtered or unexported fields
}

func (ErrRepoAlreadyExist) Error

func (err ErrRepoAlreadyExist) Error() string

type ErrRepoFileAlreadyExist

type ErrRepoFileAlreadyExist struct {
	FileName string
}

func (ErrRepoFileAlreadyExist) Error

func (err ErrRepoFileAlreadyExist) Error() string

type ErrRepoNotExist

type ErrRepoNotExist struct {
	// contains filtered or unexported fields
}

func (ErrRepoNotExist) Error

func (err ErrRepoNotExist) Error() string

func (ErrRepoNotExist) NotFound

func (ErrRepoNotExist) NotFound() bool

type ErrTeamAlreadyExist

type ErrTeamAlreadyExist struct {
	ID    int64
	OrgID int64
	Name  string
}

func (ErrTeamAlreadyExist) Error

func (err ErrTeamAlreadyExist) Error() string

type ErrTeamNotExist

type ErrTeamNotExist struct {
	// contains filtered or unexported fields
}

func (ErrTeamNotExist) Error

func (err ErrTeamNotExist) Error() string

func (ErrTeamNotExist) NotFound

func (ErrTeamNotExist) NotFound() bool

type ErrTwoFactorNotFound

type ErrTwoFactorNotFound struct {
	// contains filtered or unexported fields
}

func (ErrTwoFactorNotFound) Error

func (err ErrTwoFactorNotFound) Error() string

func (ErrTwoFactorNotFound) NotFound

func (ErrTwoFactorNotFound) NotFound() bool

type ErrTwoFactorRecoveryCodeNotFound

type ErrTwoFactorRecoveryCodeNotFound struct {
	Code string
}

func (ErrTwoFactorRecoveryCodeNotFound) Error

type ErrUpdateTaskNotExist

type ErrUpdateTaskNotExist struct {
	UUID string
}

func (ErrUpdateTaskNotExist) Error

func (err ErrUpdateTaskNotExist) Error() string

type ErrUploadNotExist

type ErrUploadNotExist struct {
	ID   int64
	UUID string
}

func (ErrUploadNotExist) Error

func (err ErrUploadNotExist) Error() string

type ErrUserAlreadyExist

type ErrUserAlreadyExist struct {
	// contains filtered or unexported fields
}

func (ErrUserAlreadyExist) Error

func (err ErrUserAlreadyExist) Error() string

type ErrUserHasOrgs

type ErrUserHasOrgs struct {
	UID int64
}

func (ErrUserHasOrgs) Error

func (err ErrUserHasOrgs) Error() string

type ErrUserNotExist

type ErrUserNotExist struct {
	// contains filtered or unexported fields
}

func (ErrUserNotExist) Error

func (err ErrUserNotExist) Error() string

func (ErrUserNotExist) NotFound

func (ErrUserNotExist) NotFound() bool

type ErrUserOwnRepos

type ErrUserOwnRepos struct {
	UID int64
}

func (ErrUserOwnRepos) Error

func (err ErrUserOwnRepos) Error() string

type ErrWebhookNotExist

type ErrWebhookNotExist struct {
	// contains filtered or unexported fields
}

func (ErrWebhookNotExist) Error

func (err ErrWebhookNotExist) Error() string

func (ErrWebhookNotExist) NotFound

func (ErrWebhookNotExist) NotFound() bool

type ErrWikiAlreadyExist

type ErrWikiAlreadyExist struct {
	Title string
}

func (ErrWikiAlreadyExist) Error

func (err ErrWikiAlreadyExist) Error() string

type FilterMode

type FilterMode string
const (
	FILTER_MODE_YOUR_REPOS FilterMode = "your_repositories"
	FILTER_MODE_ASSIGN     FilterMode = "assigned"
	FILTER_MODE_CREATE     FilterMode = "created_by"
	FILTER_MODE_MENTION    FilterMode = "mentioned"
)

type Follow

type Follow struct {
	ID       int64
	UserID   int64 `xorm:"UNIQUE(follow)"`
	FollowID int64 `xorm:"UNIQUE(follow)"`
}

Follow represents relations of user and his/her followers.

type GitHubConfig

type GitHubConfig struct {
	// the GitHub service endpoint, e.g. https://api.github.com/.
	APIEndpoint string
}

type HookContentType

type HookContentType int
const (
	JSON HookContentType = iota + 1
	FORM
)

func ToHookContentType

func ToHookContentType(name string) HookContentType

ToHookContentType returns HookContentType by given name.

func (HookContentType) Name

func (t HookContentType) Name() string

type HookEvent

type HookEvent struct {
	PushOnly       bool `json:"push_only"`
	SendEverything bool `json:"send_everything"`
	ChooseEvents   bool `json:"choose_events"`

	HookEvents `json:"events"`
}

HookEvent represents events that will delivery hook.

type HookEventType

type HookEventType string
const (
	HOOK_EVENT_CREATE        HookEventType = "create"
	HOOK_EVENT_DELETE        HookEventType = "delete"
	HOOK_EVENT_FORK          HookEventType = "fork"
	HOOK_EVENT_PUSH          HookEventType = "push"
	HOOK_EVENT_ISSUES        HookEventType = "issues"
	HOOK_EVENT_PULL_REQUEST  HookEventType = "pull_request"
	HOOK_EVENT_ISSUE_COMMENT HookEventType = "issue_comment"
	HOOK_EVENT_RELEASE       HookEventType = "release"
)

type HookEvents

type HookEvents struct {
	Create       bool `json:"create"`
	Delete       bool `json:"delete"`
	Fork         bool `json:"fork"`
	Push         bool `json:"push"`
	Issues       bool `json:"issues"`
	PullRequest  bool `json:"pull_request"`
	IssueComment bool `json:"issue_comment"`
	Release      bool `json:"release"`
}

type HookRequest

type HookRequest struct {
	Headers map[string]string `json:"headers"`
}

HookRequest represents hook task request information.

type HookResponse

type HookResponse struct {
	Status  int               `json:"status"`
	Headers map[string]string `json:"headers"`
	Body    string            `json:"body"`
}

HookResponse represents hook task response information.

type HookStatus

type HookStatus int

type HookTask

type HookTask struct {
	ID              int64
	RepoID          int64 `xorm:"INDEX"`
	HookID          int64
	UUID            string
	Type            HookTaskType
	URL             string `xorm:"TEXT"`
	Signature       string `xorm:"TEXT"`
	api.Payloader   `xorm:"-" json:"-"`
	PayloadContent  string `xorm:"TEXT"`
	ContentType     HookContentType
	EventType       HookEventType
	IsSSL           bool
	IsDelivered     bool
	Delivered       int64
	DeliveredString string `xorm:"-" json:"-"`

	// History info.
	IsSucceed       bool
	RequestContent  string        `xorm:"TEXT"`
	RequestInfo     *HookRequest  `xorm:"-" json:"-"`
	ResponseContent string        `xorm:"TEXT"`
	ResponseInfo    *HookResponse `xorm:"-" json:"-"`
}

HookTask represents a hook task.

func GetHookTaskOfWebhookByUUID

func GetHookTaskOfWebhookByUUID(webhookID int64, uuid string) (*HookTask, error)

GetHookTaskOfWebhookByUUID returns hook task of given webhook by UUID.

func HookTasks

func HookTasks(hookID int64, page int) ([]*HookTask, error)

HookTasks returns a list of hook tasks by given conditions.

func (*HookTask) AfterSet

func (t *HookTask) AfterSet(colName string, _ xorm.Cell)

func (*HookTask) BeforeUpdate

func (t *HookTask) BeforeUpdate()

func (*HookTask) ToJSON

func (t *HookTask) ToJSON(v interface{}) string

type HookTaskType

type HookTaskType int
const (
	GOGS HookTaskType = iota + 1
	SLACK
	DISCORD
	DINGTALK
)

func ToHookTaskType

func ToHookTaskType(name string) HookTaskType

ToHookTaskType returns HookTaskType by given name.

func (HookTaskType) Name

func (t HookTaskType) Name() string

type Issue

type Issue struct {
	ID              int64
	RepoID          int64       `xorm:"INDEX UNIQUE(repo_index)"`
	Repo            *Repository `xorm:"-" json:"-"`
	Index           int64       `xorm:"UNIQUE(repo_index)"` // Index in one repository.
	PosterID        int64
	Poster          *User    `xorm:"-" json:"-"`
	Title           string   `xorm:"name"`
	Content         string   `xorm:"TEXT"`
	RenderedContent string   `xorm:"-" json:"-"`
	Labels          []*Label `xorm:"-" json:"-"`
	MilestoneID     int64
	Milestone       *Milestone `xorm:"-" json:"-"`
	Priority        int
	AssigneeID      int64
	Assignee        *User `xorm:"-" json:"-"`
	IsClosed        bool
	IsRead          bool         `xorm:"-" json:"-"`
	IsPull          bool         // Indicates whether is a pull request or not.
	PullRequest     *PullRequest `xorm:"-" json:"-"`
	NumComments     int

	Deadline     time.Time `xorm:"-" json:"-"`
	DeadlineUnix int64
	Created      time.Time `xorm:"-" json:"-"`
	CreatedUnix  int64
	Updated      time.Time `xorm:"-" json:"-"`
	UpdatedUnix  int64

	Attachments []*Attachment `xorm:"-" json:"-"`
	Comments    []*Comment    `xorm:"-" json:"-"`
}

Issue represents an issue or pull request of repository.

func GetIssueByID

func GetIssueByID(id int64) (*Issue, error)

GetIssueByID returns an issue by given ID.

func GetIssueByIndex

func GetIssueByIndex(repoID, index int64) (*Issue, error)

GetIssueByIndex returns issue by index in a repository.

func GetIssueByRef

func GetIssueByRef(ref string) (*Issue, error)

GetIssueByRef returns an Issue specified by a GFM reference, e.g. owner/repo#123.

func GetRawIssueByIndex

func GetRawIssueByIndex(repoID, index int64) (*Issue, error)

GetIssueByIndex returns raw issue without loading attributes by index in a repository.

func Issues

func Issues(opts *IssuesOptions) ([]*Issue, error)

Issues returns a list of issues by given conditions.

func (*Issue) APIFormat

func (issue *Issue) APIFormat() *api.Issue

This method assumes some fields assigned with values: Required - Poster, Labels, Optional - Milestone, Assignee, PullRequest

func (*Issue) AddLabel

func (issue *Issue) AddLabel(doer *User, label *Label) error

AddLabel adds a new label to the issue.

func (*Issue) AddLabels

func (issue *Issue) AddLabels(doer *User, labels []*Label) error

AddLabels adds a list of new labels to the issue.

func (*Issue) AfterSet

func (issue *Issue) AfterSet(colName string, _ xorm.Cell)

func (*Issue) BeforeInsert

func (issue *Issue) BeforeInsert()

func (*Issue) BeforeUpdate

func (issue *Issue) BeforeUpdate()

func (*Issue) ChangeAssignee

func (issue *Issue) ChangeAssignee(doer *User, assigneeID int64) (err error)

func (*Issue) ChangeContent

func (issue *Issue) ChangeContent(doer *User, content string) (err error)

func (*Issue) ChangeStatus

func (issue *Issue) ChangeStatus(doer *User, repo *Repository, isClosed bool) (err error)

ChangeStatus changes issue status to open or closed.

func (*Issue) ChangeTitle

func (issue *Issue) ChangeTitle(doer *User, title string) (err error)

func (*Issue) ClearLabels

func (issue *Issue) ClearLabels(doer *User) (err error)

func (*Issue) GetAssignee

func (issue *Issue) GetAssignee() (err error)

func (*Issue) HTMLURL

func (issue *Issue) HTMLURL() string

func (*Issue) HasLabel

func (issue *Issue) HasLabel(labelID int64) bool

HasLabel returns true if issue has been labeled by given ID.

func (*Issue) HashTag

func (issue *Issue) HashTag() string

HashTag returns unique hash tag for issue.

func (*Issue) IsPoster

func (issue *Issue) IsPoster(uid int64) bool

IsPoster returns true if given user by ID is the poster.

func (*Issue) LoadAttributes

func (issue *Issue) LoadAttributes() error

func (*Issue) MailParticipants

func (issue *Issue) MailParticipants() (err error)

MailParticipants sends new issue thread created emails to repository watchers and mentioned people.

func (*Issue) MailSubject

func (issue *Issue) MailSubject() string

func (*Issue) ReadBy

func (issue *Issue) ReadBy(uid int64) error

ReadBy sets issue to be read by given user.

func (*Issue) RemoveLabel

func (issue *Issue) RemoveLabel(doer *User, label *Label) error

RemoveLabel removes a label from issue by given ID.

func (*Issue) ReplaceLabels

func (issue *Issue) ReplaceLabels(labels []*Label) (err error)

ReplaceLabels removes all current labels and add new labels to the issue.

func (*Issue) State

func (issue *Issue) State() api.StateType

State returns string representation of issue status.

type IssueLabel

type IssueLabel struct {
	ID      int64
	IssueID int64 `xorm:"UNIQUE(s)"`
	LabelID int64 `xorm:"UNIQUE(s)"`
}

IssueLabel represetns an issue-lable relation.

func GetIssueLabels

func GetIssueLabels(issueID int64) ([]*IssueLabel, error)

GetIssueLabels returns all issue-label relations of given issue by ID.

type IssueStats

type IssueStats struct {
	OpenCount, ClosedCount int64
	YourReposCount         int64
	AssignCount            int64
	CreateCount            int64
	MentionCount           int64
}

IssueStats represents issue statistic information.

func GetIssueStats

func GetIssueStats(opts *IssueStatsOptions) *IssueStats

GetIssueStats returns issue statistic information by given conditions.

func GetUserIssueStats

func GetUserIssueStats(repoID, userID int64, repoIDs []int64, filterMode FilterMode, isPull bool) *IssueStats

GetUserIssueStats returns issue statistic information for dashboard by given conditions.

type IssueStatsOptions

type IssueStatsOptions struct {
	RepoID      int64
	UserID      int64
	Labels      string
	MilestoneID int64
	AssigneeID  int64
	FilterMode  FilterMode
	IsPull      bool
}

type IssueUser

type IssueUser struct {
	ID          int64
	UID         int64 `xorm:"INDEX"` // User ID.
	IssueID     int64
	RepoID      int64 `xorm:"INDEX"`
	MilestoneID int64
	IsRead      bool
	IsAssigned  bool
	IsMentioned bool
	IsPoster    bool
	IsClosed    bool
}

IssueUser represents an issue-user relation.

func GetIssueUserPairsByMode

func GetIssueUserPairsByMode(userID, repoID int64, filterMode FilterMode, isClosed bool, page int) ([]*IssueUser, error)

GetIssueUserPairsByMode returns issue-user pairs by given repository and user.

func GetIssueUserPairsByRepoIds

func GetIssueUserPairsByRepoIds(rids []int64, isClosed bool, page int) ([]*IssueUser, error)

GetIssueUserPairsByRepoIds returns issue-user pairs by given repository IDs.

func GetIssueUsers

func GetIssueUsers(rid, uid int64, isClosed bool) ([]*IssueUser, error)

GetIssueUsers returns issue-user pairs by given repository and user.

type IssuesOptions

type IssuesOptions struct {
	UserID      int64
	AssigneeID  int64
	RepoID      int64
	PosterID    int64
	MilestoneID int64
	RepoIDs     []int64
	Page        int
	IsClosed    bool
	IsMention   bool
	IsPull      bool
	Labels      string
	SortType    string
}

type KeyType

type KeyType int

type LDAPConfig

type LDAPConfig struct {
	ldap.Source `ini:"config"`
}

func (*LDAPConfig) SecurityProtocolName

func (cfg *LDAPConfig) SecurityProtocolName() string

type LFSObject

type LFSObject struct {
	RepoID    int64           `gorm:"PRIMARY_KEY;AUTO_INCREMENT:false"`
	OID       lfsutil.OID     `gorm:"PRIMARY_KEY;COLUMN:oid"`
	Size      int64           `gorm:"NOT NULL"`
	Storage   lfsutil.Storage `gorm:"NOT NULL"`
	CreatedAt time.Time       `gorm:"NOT NULL"`
}

LFSObject is the relation between an LFS object and a repository.

type LFSStore

type LFSStore interface {
	// CreateObject creates a LFS object record in database.
	CreateObject(repoID int64, oid lfsutil.OID, size int64, storage lfsutil.Storage) error
	// GetObjectByOID returns the LFS object with given OID. It returns ErrLFSObjectNotExist
	// when not found.
	GetObjectByOID(repoID int64, oid lfsutil.OID) (*LFSObject, error)
	// GetObjectsByOIDs returns LFS objects found within "oids". The returned list could have
	// less elements if some oids were not found.
	GetObjectsByOIDs(repoID int64, oids ...lfsutil.OID) ([]*LFSObject, error)
}

LFSStore is the persistent interface for LFS objects.

NOTE: All methods are sorted in alphabetical order.

var LFS LFSStore

type Label

type Label struct {
	ID              int64
	RepoID          int64 `xorm:"INDEX"`
	Name            string
	Color           string `xorm:"VARCHAR(7)"`
	NumIssues       int
	NumClosedIssues int
	NumOpenIssues   int  `xorm:"-" json:"-"`
	IsChecked       bool `xorm:"-" json:"-"`
}

Label represents a label of repository for issues.

func GetLabelByID

func GetLabelByID(id int64) (*Label, error)

GetLabelByID returns a label by given ID.

func GetLabelOfRepoByID

func GetLabelOfRepoByID(repoID, labelID int64) (*Label, error)

GetLabelOfRepoByID returns a label by ID in given repository.

func GetLabelOfRepoByName

func GetLabelOfRepoByName(repoID int64, labelName string) (*Label, error)

GetLabelOfRepoByName returns a label by name in given repository.

func GetLabelsByIssueID

func GetLabelsByIssueID(issueID int64) ([]*Label, error)

GetLabelsByIssueID returns all labels that belong to given issue by ID.

func GetLabelsByRepoID

func GetLabelsByRepoID(repoID int64) ([]*Label, error)

GetLabelsByRepoID returns all labels that belong to given repository by ID.

func GetLabelsInRepoByIDs

func GetLabelsInRepoByIDs(repoID int64, labelIDs []int64) ([]*Label, error)

GetLabelsInRepoByIDs returns a list of labels by IDs in given repository, it silently ignores label IDs that are not belong to the repository.

func (*Label) APIFormat

func (label *Label) APIFormat() *api.Label

func (*Label) CalOpenIssues

func (label *Label) CalOpenIssues()

CalOpenIssues calculates the open issues of label.

func (*Label) ForegroundColor

func (l *Label) ForegroundColor() template.CSS

ForegroundColor calculates the text color for labels based on their background color.

type ListLoginSourceOpts

type ListLoginSourceOpts struct {
	// Whether to only include activated login sources.
	OnlyActivated bool
}

type LoginSource

type LoginSource struct {
	ID        int64
	Type      LoginType
	Name      string      `xorm:"UNIQUE" gorm:"UNIQUE"`
	IsActived bool        `xorm:"NOT NULL DEFAULT false" gorm:"NOT NULL"`
	IsDefault bool        `xorm:"DEFAULT false"`
	Config    interface{} `xorm:"-" gorm:"-"`
	RawConfig string      `xorm:"TEXT cfg" gorm:"COLUMN:cfg;TYPE:TEXT"`

	Created     time.Time `xorm:"-" gorm:"-" json:"-"`
	CreatedUnix int64
	Updated     time.Time `xorm:"-" gorm:"-" json:"-"`
	UpdatedUnix int64

	File loginSourceFileStore `xorm:"-" gorm:"-" json:"-"`
}

LoginSource represents an external way for authorizing users.

func (*LoginSource) AfterFind

func (s *LoginSource) AfterFind() error

NOTE: This is a GORM query hook.

func (*LoginSource) BeforeCreate

func (s *LoginSource) BeforeCreate()

NOTE: This is a GORM create hook.

func (*LoginSource) BeforeSave

func (s *LoginSource) BeforeSave() (err error)

NOTE: This is a GORM save hook.

func (*LoginSource) BeforeUpdate

func (s *LoginSource) BeforeUpdate()

NOTE: This is a GORM update hook.

func (*LoginSource) GitHub

func (s *LoginSource) GitHub() *GitHubConfig

func (*LoginSource) HasTLS

func (s *LoginSource) HasTLS() bool

func (*LoginSource) IsDLDAP

func (s *LoginSource) IsDLDAP() bool

func (*LoginSource) IsGitHub

func (s *LoginSource) IsGitHub() bool

func (*LoginSource) IsLDAP

func (s *LoginSource) IsLDAP() bool

func (*LoginSource) IsPAM

func (s *LoginSource) IsPAM() bool

func (*LoginSource) IsSMTP

func (s *LoginSource) IsSMTP() bool

func (*LoginSource) LDAP

func (s *LoginSource) LDAP() *LDAPConfig

func (*LoginSource) PAM

func (s *LoginSource) PAM() *PAMConfig

func (*LoginSource) SMTP

func (s *LoginSource) SMTP() *SMTPConfig

func (*LoginSource) SkipVerify

func (s *LoginSource) SkipVerify() bool

func (*LoginSource) TypeName

func (s *LoginSource) TypeName() string

func (*LoginSource) UseTLS

func (s *LoginSource) UseTLS() bool

type LoginSourcesStore

type LoginSourcesStore interface {
	// Create creates a new login source and persist to database.
	// It returns ErrLoginSourceAlreadyExist when a login source with same name already exists.
	Create(opts CreateLoginSourceOpts) (*LoginSource, error)
	// Count returns the total number of login sources.
	Count() int64
	// DeleteByID deletes a login source by given ID.
	// It returns ErrLoginSourceInUse if at least one user is associated with the login source.
	DeleteByID(id int64) error
	// GetByID returns the login source with given ID.
	// It returns ErrLoginSourceNotExist when not found.
	GetByID(id int64) (*LoginSource, error)
	// List returns a list of login sources filtered by options.
	List(opts ListLoginSourceOpts) ([]*LoginSource, error)
	// ResetNonDefault clears default flag for all the other login sources.
	ResetNonDefault(source *LoginSource) error
	// Save persists all values of given login source to database or local file.
	// The Updated field is set to current time automatically.
	Save(t *LoginSource) error
}

LoginSourcesStore is the persistent interface for login sources.

NOTE: All methods are sorted in alphabetical order.

var LoginSources LoginSourcesStore

type LoginType

type LoginType int
const (
	LoginNotype LoginType = iota
	LoginPlain            // 1
	LoginLDAP             // 2
	LoginSMTP             // 3
	LoginPAM              // 4
	LoginDLDAP            // 5
	LoginGitHub           // 6
)

Note: new type must append to the end of list to maintain compatibility. TODO: Move to authutil.

type MergeStyle

type MergeStyle string

MergeStyle represents the approach to merge commits into base branch.

const (
	MERGE_STYLE_REGULAR MergeStyle = "create_merge_commit"
	MERGE_STYLE_REBASE  MergeStyle = "rebase_before_merging"
)

type MigrateRepoOptions

type MigrateRepoOptions struct {
	Name        string
	Description string
	IsPrivate   bool
	IsMirror    bool
	RemoteAddr  string
}

type Milestone

type Milestone struct {
	ID              int64
	RepoID          int64 `xorm:"INDEX"`
	Name            string
	Content         string `xorm:"TEXT"`
	RenderedContent string `xorm:"-" json:"-"`
	IsClosed        bool
	NumIssues       int
	NumClosedIssues int
	NumOpenIssues   int  `xorm:"-" json:"-"`
	Completeness    int  // Percentage(1-100).
	IsOverDue       bool `xorm:"-" json:"-"`

	DeadlineString string    `xorm:"-" json:"-"`
	Deadline       time.Time `xorm:"-" json:"-"`
	DeadlineUnix   int64
	ClosedDate     time.Time `xorm:"-" json:"-"`
	ClosedDateUnix int64
}

Milestone represents a milestone of repository.

func GetMilestoneByRepoID

func GetMilestoneByRepoID(repoID, id int64) (*Milestone, error)

GetWebhookByRepoID returns the milestone in a repository.

func GetMilestones

func GetMilestones(repoID int64, page int, isClosed bool) ([]*Milestone, error)

GetMilestones returns a list of milestones of given repository and status.

func GetMilestonesByRepoID

func GetMilestonesByRepoID(repoID int64) ([]*Milestone, error)

GetMilestonesByRepoID returns all milestones of a repository.

func (*Milestone) APIFormat

func (m *Milestone) APIFormat() *api.Milestone

func (*Milestone) AfterSet

func (m *Milestone) AfterSet(colName string, _ xorm.Cell)

func (*Milestone) BeforeInsert

func (m *Milestone) BeforeInsert()

func (*Milestone) BeforeUpdate

func (m *Milestone) BeforeUpdate()

func (*Milestone) ChangeStatus

func (m *Milestone) ChangeStatus(isClosed bool) error

func (*Milestone) CountIssues

func (m *Milestone) CountIssues(isClosed, includePulls bool) int64

func (*Milestone) State

func (m *Milestone) State() api.StateType

State returns string representation of milestone status.

type Mirror

type Mirror struct {
	ID          int64
	RepoID      int64
	Repo        *Repository `xorm:"-" json:"-"`
	Interval    int         // Hour.
	EnablePrune bool        `xorm:"NOT NULL DEFAULT true"`

	// Last and next sync time of Git data from upstream
	LastSync     time.Time `xorm:"-" json:"-"`
	LastSyncUnix int64     `xorm:"updated_unix"`
	NextSync     time.Time `xorm:"-" json:"-"`
	NextSyncUnix int64     `xorm:"next_update_unix"`
	// contains filtered or unexported fields
}

Mirror represents mirror information of a repository.

func GetMirrorByRepoID

func GetMirrorByRepoID(repoID int64) (*Mirror, error)

GetMirrorByRepoID returns mirror information of a repository.

func (*Mirror) Address

func (m *Mirror) Address() string

Address returns mirror address from Git repository config without credentials.

func (*Mirror) AfterSet

func (m *Mirror) AfterSet(colName string, _ xorm.Cell)

func (*Mirror) BeforeInsert

func (m *Mirror) BeforeInsert()

func (*Mirror) BeforeUpdate

func (m *Mirror) BeforeUpdate()

func (*Mirror) MosaicsAddress

func (m *Mirror) MosaicsAddress() string

MosaicsAddress returns mirror address from Git repository config with credentials under mosaics.

func (*Mirror) RawAddress

func (m *Mirror) RawAddress() string

RawAddress returns raw mirror address directly from Git repository config.

func (*Mirror) SaveAddress

func (m *Mirror) SaveAddress(addr string) error

SaveAddress writes new address to Git repository config.

func (*Mirror) ScheduleNextSync

func (m *Mirror) ScheduleNextSync()

ScheduleNextSync calculates and sets next sync time based on repostiroy mirror setting.

type MirrorRepositoryList

type MirrorRepositoryList []*Repository

func (MirrorRepositoryList) LoadAttributes

func (repos MirrorRepositoryList) LoadAttributes() error

type MirrorSyncPushActionOptions

type MirrorSyncPushActionOptions struct {
	RefName     string
	OldCommitID string
	NewCommitID string
	Commits     *PushCommits
}

type MockAccessTokensStore

type MockAccessTokensStore struct {
	MockCreate     func(userID int64, name string) (*AccessToken, error)
	MockDeleteByID func(userID, id int64) error
	MockGetBySHA   func(sha string) (*AccessToken, error)
	MockList       func(userID int64) ([]*AccessToken, error)
	MockSave       func(t *AccessToken) error
}

func (*MockAccessTokensStore) Create

func (m *MockAccessTokensStore) Create(userID int64, name string) (*AccessToken, error)

func (*MockAccessTokensStore) DeleteByID

func (m *MockAccessTokensStore) DeleteByID(userID, id int64) error

func (*MockAccessTokensStore) GetBySHA

func (m *MockAccessTokensStore) GetBySHA(sha string) (*AccessToken, error)

func (*MockAccessTokensStore) List

func (m *MockAccessTokensStore) List(userID int64) ([]*AccessToken, error)

func (*MockAccessTokensStore) Save

type MockLFSStore

type MockLFSStore struct {
	MockCreateObject     func(repoID int64, oid lfsutil.OID, size int64, storage lfsutil.Storage) error
	MockGetObjectByOID   func(repoID int64, oid lfsutil.OID) (*LFSObject, error)
	MockGetObjectsByOIDs func(repoID int64, oids ...lfsutil.OID) ([]*LFSObject, error)
}

func (*MockLFSStore) CreateObject

func (m *MockLFSStore) CreateObject(repoID int64, oid lfsutil.OID, size int64, storage lfsutil.Storage) error

func (*MockLFSStore) GetObjectByOID

func (m *MockLFSStore) GetObjectByOID(repoID int64, oid lfsutil.OID) (*LFSObject, error)

func (*MockLFSStore) GetObjectsByOIDs

func (m *MockLFSStore) GetObjectsByOIDs(repoID int64, oids ...lfsutil.OID) ([]*LFSObject, error)

type MockPermsStore

type MockPermsStore struct {
	MockAccessMode   func(userID int64, repo *Repository) AccessMode
	MockAuthorize    func(userID int64, repo *Repository, desired AccessMode) bool
	MockSetRepoPerms func(repoID int64, accessMap map[int64]AccessMode) error
}

func (*MockPermsStore) AccessMode

func (m *MockPermsStore) AccessMode(userID int64, repo *Repository) AccessMode

func (*MockPermsStore) Authorize

func (m *MockPermsStore) Authorize(userID int64, repo *Repository, desired AccessMode) bool

func (*MockPermsStore) SetRepoPerms

func (m *MockPermsStore) SetRepoPerms(repoID int64, accessMap map[int64]AccessMode) error

type MockReposStore

type MockReposStore struct {
	MockGetByName func(ownerID int64, name string) (*Repository, error)
}

func (*MockReposStore) GetByName

func (m *MockReposStore) GetByName(ownerID int64, name string) (*Repository, error)

type MockTwoFactorsStore

type MockTwoFactorsStore struct {
	MockCreate        func(userID int64, key, secret string) error
	MockGetByUserID   func(userID int64) (*TwoFactor, error)
	MockIsUserEnabled func(userID int64) bool
}

func (*MockTwoFactorsStore) Create

func (m *MockTwoFactorsStore) Create(userID int64, key, secret string) error

func (*MockTwoFactorsStore) GetByUserID

func (m *MockTwoFactorsStore) GetByUserID(userID int64) (*TwoFactor, error)

func (*MockTwoFactorsStore) IsUserEnabled

func (m *MockTwoFactorsStore) IsUserEnabled(userID int64) bool

type MockUsersStore

type MockUsersStore struct {
	MockAuthenticate  func(username, password string, loginSourceID int64) (*User, error)
	MockCreate        func(opts CreateUserOpts) (*User, error)
	MockGetByEmail    func(email string) (*User, error)
	MockGetByID       func(id int64) (*User, error)
	MockGetByUsername func(username string) (*User, error)
}

func (*MockUsersStore) Authenticate

func (m *MockUsersStore) Authenticate(username, password string, loginSourceID int64) (*User, error)

func (*MockUsersStore) Create

func (m *MockUsersStore) Create(opts CreateUserOpts) (*User, error)

func (*MockUsersStore) GetByEmail

func (m *MockUsersStore) GetByEmail(email string) (*User, error)

func (*MockUsersStore) GetByID

func (m *MockUsersStore) GetByID(id int64) (*User, error)

func (*MockUsersStore) GetByUsername

func (m *MockUsersStore) GetByUsername(username string) (*User, error)

type NewIssueOptions

type NewIssueOptions struct {
	Repo        *Repository
	Issue       *Issue
	LableIDs    []int64
	Attachments []string // In UUID format.
	IsPull      bool
}

type Notice

type Notice struct {
	ID          int64
	Type        NoticeType
	Description string    `xorm:"TEXT"`
	Created     time.Time `xorm:"-" json:"-"`
	CreatedUnix int64
}

Notice represents a system notice for admin.

func Notices

func Notices(page, pageSize int) ([]*Notice, error)

Notices returns number of notices in given page.

func (*Notice) AfterSet

func (n *Notice) AfterSet(colName string, _ xorm.Cell)

func (*Notice) BeforeInsert

func (n *Notice) BeforeInsert()

func (*Notice) TrStr

func (n *Notice) TrStr() string

TrStr returns a translation format string.

type NoticeType

type NoticeType int
const (
	NOTICE_REPOSITORY NoticeType = iota + 1
)

type OrgUser

type OrgUser struct {
	ID       int64
	Uid      int64 `xorm:"INDEX UNIQUE(s)"`
	OrgID    int64 `xorm:"INDEX UNIQUE(s)"`
	IsPublic bool
	IsOwner  bool
	NumTeams int
}

OrgUser represents an organization-user relation.

func GetOrgUsersByOrgID

func GetOrgUsersByOrgID(orgID int64, limit int) ([]*OrgUser, error)

GetOrgUsersByOrgID returns all organization-user relations by organization ID.

type PAMConfig

type PAMConfig struct {
	// The name of the PAM service, e.g. system-auth.
	ServiceName string
}

type PermsStore

type PermsStore interface {
	// AccessMode returns the access mode of given user has to the repository.
	AccessMode(userID int64, repo *Repository) AccessMode
	// Authorize returns true if the user has as good as desired access mode to the repository.
	Authorize(userID int64, repo *Repository, desired AccessMode) bool
	// SetRepoPerms does a full update to which users have which level of access to given repository.
	// Keys of the "accessMap" are user IDs.
	SetRepoPerms(repoID int64, accessMap map[int64]AccessMode) error
}

PermsStore is the persistent interface for permissions.

NOTE: All methods are sorted in alphabetical order.

var Perms PermsStore

type ProtectBranch

type ProtectBranch struct {
	ID                 int64
	RepoID             int64  `xorm:"UNIQUE(protect_branch)"`
	Name               string `xorm:"UNIQUE(protect_branch)"`
	Protected          bool
	RequirePullRequest bool
	EnableWhitelist    bool
	WhitelistUserIDs   string `xorm:"TEXT"`
	WhitelistTeamIDs   string `xorm:"TEXT"`
}

ProtectBranch contains options of a protected branch.

func GetProtectBranchOfRepoByName

func GetProtectBranchOfRepoByName(repoID int64, name string) (*ProtectBranch, error)

GetProtectBranchOfRepoByName returns *ProtectBranch by branch name in given repostiory.

func GetProtectBranchesByRepoID

func GetProtectBranchesByRepoID(repoID int64) ([]*ProtectBranch, error)

GetProtectBranchesByRepoID returns a list of *ProtectBranch in given repostiory.

type ProtectBranchWhitelist

type ProtectBranchWhitelist struct {
	ID              int64
	ProtectBranchID int64
	RepoID          int64  `xorm:"UNIQUE(protect_branch_whitelist)"`
	Name            string `xorm:"UNIQUE(protect_branch_whitelist)"`
	UserID          int64  `xorm:"UNIQUE(protect_branch_whitelist)"`
}

type PublicKey

type PublicKey struct {
	ID          int64
	OwnerID     int64      `xorm:"INDEX NOT NULL"`
	Name        string     `xorm:"NOT NULL"`
	Fingerprint string     `xorm:"NOT NULL"`
	Content     string     `xorm:"TEXT NOT NULL"`
	Mode        AccessMode `xorm:"NOT NULL DEFAULT 2"`
	Type        KeyType    `xorm:"NOT NULL DEFAULT 1"`

	Created           time.Time `xorm:"-" json:"-"`
	CreatedUnix       int64
	Updated           time.Time `xorm:"-" json:"-"` // Note: Updated must below Created for AfterSet.
	UpdatedUnix       int64
	HasRecentActivity bool `xorm:"-" json:"-"`
	HasUsed           bool `xorm:"-" json:"-"`
}

PublicKey represents a user or deploy SSH public key.

func AddPublicKey

func AddPublicKey(ownerID int64, name, content string) (*PublicKey, error)

AddPublicKey adds new public key to database and authorized_keys file.

func GetPublicKeyByID

func GetPublicKeyByID(keyID int64) (*PublicKey, error)

GetPublicKeyByID returns public key by given ID.

func ListPublicKeys

func ListPublicKeys(uid int64) ([]*PublicKey, error)

ListPublicKeys returns a list of public keys belongs to given user.

func SearchPublicKeyByContent

func SearchPublicKeyByContent(content string) (*PublicKey, error)

SearchPublicKeyByContent searches content as prefix (leak e-mail part) and returns public key found.

func (*PublicKey) AfterSet

func (k *PublicKey) AfterSet(colName string, _ xorm.Cell)

func (*PublicKey) AuthorizedString

func (k *PublicKey) AuthorizedString() string

AuthorizedString returns formatted public key string for authorized_keys file.

func (*PublicKey) BeforeInsert

func (k *PublicKey) BeforeInsert()

func (*PublicKey) BeforeUpdate

func (k *PublicKey) BeforeUpdate()

func (*PublicKey) IsDeployKey

func (k *PublicKey) IsDeployKey() bool

IsDeployKey returns true if the public key is used as deploy key.

func (*PublicKey) OmitEmail

func (k *PublicKey) OmitEmail() string

OmitEmail returns content of public key without email address.

type PullRequest

type PullRequest struct {
	ID     int64
	Type   PullRequestType
	Status PullRequestStatus

	IssueID int64  `xorm:"INDEX"`
	Issue   *Issue `xorm:"-" json:"-"`
	Index   int64

	HeadRepoID   int64
	HeadRepo     *Repository `xorm:"-" json:"-"`
	BaseRepoID   int64
	BaseRepo     *Repository `xorm:"-" json:"-"`
	HeadUserName string
	HeadBranch   string
	BaseBranch   string
	MergeBase    string `xorm:"VARCHAR(40)"`

	HasMerged      bool
	MergedCommitID string `xorm:"VARCHAR(40)"`
	MergerID       int64
	Merger         *User     `xorm:"-" json:"-"`
	Merged         time.Time `xorm:"-" json:"-"`
	MergedUnix     int64
}

PullRequest represents relation between pull request and repositories.

func GetPullRequestByID

func GetPullRequestByID(id int64) (*PullRequest, error)

GetPullRequestByID returns a pull request by given ID.

func GetPullRequestByIssueID

func GetPullRequestByIssueID(issueID int64) (*PullRequest, error)

GetPullRequestByIssueID returns pull request by given issue ID.

func GetUnmergedPullRequest

func GetUnmergedPullRequest(headRepoID, baseRepoID int64, headBranch, baseBranch string) (*PullRequest, error)

GetUnmergedPullRequest returnss a pull request that is open and has not been merged by given head/base and repo/branch.

func GetUnmergedPullRequestsByBaseInfo

func GetUnmergedPullRequestsByBaseInfo(repoID int64, branch string) ([]*PullRequest, error)

GetUnmergedPullRequestsByBaseInfo returnss all pull requests that are open and has not been merged by given base information (repo and branch).

func GetUnmergedPullRequestsByHeadInfo

func GetUnmergedPullRequestsByHeadInfo(repoID int64, branch string) ([]*PullRequest, error)

GetUnmergedPullRequestsByHeadInfo returnss all pull requests that are open and has not been merged by given head information (repo and branch).

func (*PullRequest) APIFormat

func (pr *PullRequest) APIFormat() *api.PullRequest

This method assumes following fields have been assigned with valid values: Required - Issue, BaseRepo Optional - HeadRepo, Merger

func (*PullRequest) AddToTaskQueue

func (pr *PullRequest) AddToTaskQueue()

AddToTaskQueue adds itself to pull request test task queue.

func (*PullRequest) AfterSet

func (pr *PullRequest) AfterSet(colName string, _ xorm.Cell)

Note: don't try to get Issue because will end up recursive querying.

func (*PullRequest) BeforeUpdate

func (pr *PullRequest) BeforeUpdate()

func (*PullRequest) CanAutoMerge

func (pr *PullRequest) CanAutoMerge() bool

CanAutoMerge returns true if this pull request can be merged automatically.

func (*PullRequest) IsChecking

func (pr *PullRequest) IsChecking() bool

IsChecking returns true if this pull request is still checking conflict.

func (*PullRequest) LoadAttributes

func (pr *PullRequest) LoadAttributes() error

func (*PullRequest) LoadIssue

func (pr *PullRequest) LoadIssue() (err error)

func (*PullRequest) Merge

func (pr *PullRequest) Merge(doer *User, baseGitRepo *git.Repository, mergeStyle MergeStyle, commitDescription string) (err error)

Merge merges pull request to base repository. FIXME: add repoWorkingPull make sure two merges does not happen at same time.

func (*PullRequest) PushToBaseRepo

func (pr *PullRequest) PushToBaseRepo() (err error)

PushToBaseRepo pushes commits from branches of head repository to corresponding branches of base repository. FIXME: Only push branches that are actually updates?

func (*PullRequest) Update

func (pr *PullRequest) Update() error

Update updates all fields of pull request.

func (*PullRequest) UpdateCols

func (pr *PullRequest) UpdateCols(cols ...string) error

Update updates specific fields of pull request.

func (*PullRequest) UpdatePatch

func (pr *PullRequest) UpdatePatch() (err error)

UpdatePatch generates and saves a new patch.

type PullRequestList

type PullRequestList []*PullRequest

func (PullRequestList) LoadAttributes

func (prs PullRequestList) LoadAttributes() error

type PullRequestStatus

type PullRequestStatus int
const (
	PULL_REQUEST_STATUS_CONFLICT PullRequestStatus = iota
	PULL_REQUEST_STATUS_CHECKING
	PULL_REQUEST_STATUS_MERGEABLE
)

type PullRequestType

type PullRequestType int
const (
	PULL_REQUEST_GOGS PullRequestType = iota
	PLLL_ERQUEST_GIT
)

type PushCommit

type PushCommit struct {
	Sha1           string
	Message        string
	AuthorEmail    string
	AuthorName     string
	CommitterEmail string
	CommitterName  string
	Timestamp      time.Time
}

func CommitToPushCommit

func CommitToPushCommit(commit *git.Commit) *PushCommit

CommitToPushCommit transforms a git.Commit to PushCommit type.

type PushCommits

type PushCommits struct {
	Len        int
	Commits    []*PushCommit
	CompareURL string
	// contains filtered or unexported fields
}

func CommitsToPushCommits

func CommitsToPushCommits(commits []*git.Commit) *PushCommits

func NewPushCommits

func NewPushCommits() *PushCommits
func (pcs *PushCommits) AvatarLink(email string) string

AvatarLink tries to match user in database with e-mail in order to show custom avatar, and falls back to general avatar link.

func (*PushCommits) ToApiPayloadCommits

func (pc *PushCommits) ToApiPayloadCommits(repoPath, repoURL string) ([]*api.PayloadCommit, error)

type PushUpdateOptions

type PushUpdateOptions struct {
	OldCommitID  string
	NewCommitID  string
	FullRefspec  string
	PusherID     int64
	PusherName   string
	RepoUserName string
	RepoName     string
}

type Release

type Release struct {
	ID               int64
	RepoID           int64
	Repo             *Repository `xorm:"-" json:"-"`
	PublisherID      int64
	Publisher        *User `xorm:"-" json:"-"`
	TagName          string
	LowerTagName     string
	Target           string
	Title            string
	Sha1             string `xorm:"VARCHAR(40)"`
	NumCommits       int64
	NumCommitsBehind int64  `xorm:"-" json:"-"`
	Note             string `xorm:"TEXT"`
	IsDraft          bool   `xorm:"NOT NULL DEFAULT false"`
	IsPrerelease     bool

	Created     time.Time `xorm:"-" json:"-"`
	CreatedUnix int64

	Attachments []*Attachment `xorm:"-" json:"-"`
}

Release represents a release of repository.

func GetDraftReleasesByRepoID

func GetDraftReleasesByRepoID(repoID int64) ([]*Release, error)

GetDraftReleasesByRepoID returns all draft releases of repository.

func GetPublishedReleasesByRepoID

func GetPublishedReleasesByRepoID(repoID int64, matches ...string) ([]*Release, error)

GetPublishedReleasesByRepoID returns a list of published releases of repository. If matches is not empty, only published releases in matches will be returned. In any case, drafts won't be returned by this function.

func GetRelease

func GetRelease(repoID int64, tagName string) (*Release, error)

GetRelease returns release by given ID.

func GetReleaseByID

func GetReleaseByID(id int64) (*Release, error)

GetReleaseByID returns release with given ID.

func GetReleasesByRepoID

func GetReleasesByRepoID(repoID int64) ([]*Release, error)

GetReleasesByRepoID returns a list of all releases (including drafts) of given repository.

func (*Release) APIFormat

func (r *Release) APIFormat() *api.Release

This method assumes some fields assigned with values: Required - Publisher

func (*Release) AfterSet

func (r *Release) AfterSet(colName string, _ xorm.Cell)

func (*Release) BeforeInsert

func (r *Release) BeforeInsert()

func (*Release) LoadAttributes

func (r *Release) LoadAttributes() error

type ReleaseSorter

type ReleaseSorter struct {
	// contains filtered or unexported fields
}

func (*ReleaseSorter) Len

func (rs *ReleaseSorter) Len() int

func (*ReleaseSorter) Less

func (rs *ReleaseSorter) Less(i, j int) bool

func (*ReleaseSorter) Swap

func (rs *ReleaseSorter) Swap(i, j int)

type ReposStore

type ReposStore interface {
	// GetByName returns the repository with given owner and name.
	// It returns ErrRepoNotExist when not found.
	GetByName(ownerID int64, name string) (*Repository, error)
}

ReposStore is the persistent interface for repositories.

NOTE: All methods are sorted in alphabetical order.

var Repos ReposStore

type Repository

type Repository struct {
	ID              int64
	OwnerID         int64  `xorm:"UNIQUE(s)" gorm:"UNIQUE_INDEX:s"`
	Owner           *User  `xorm:"-" gorm:"-" json:"-"`
	LowerName       string `xorm:"UNIQUE(s) INDEX NOT NULL" gorm:"UNIQUE_INDEX:s"`
	Name            string `xorm:"INDEX NOT NULL" gorm:"NOT NULL"`
	Description     string `xorm:"VARCHAR(512)" gorm:"TYPE:VARCHAR(512)"`
	Website         string
	DefaultBranch   string
	Size            int64 `xorm:"NOT NULL DEFAULT 0" gorm:"NOT NULL;DEFAULT:0"`
	UseCustomAvatar bool

	// Counters
	NumWatches          int
	NumStars            int
	NumForks            int
	NumIssues           int
	NumClosedIssues     int
	NumOpenIssues       int `xorm:"-" gorm:"-" json:"-"`
	NumPulls            int
	NumClosedPulls      int
	NumOpenPulls        int `xorm:"-" gorm:"-" json:"-"`
	NumMilestones       int `xorm:"NOT NULL DEFAULT 0" gorm:"NOT NULL;DEFAULT:0"`
	NumClosedMilestones int `xorm:"NOT NULL DEFAULT 0" gorm:"NOT NULL;DEFAULT:0"`
	NumOpenMilestones   int `xorm:"-" gorm:"-" json:"-"`
	NumTags             int `xorm:"-" gorm:"-" json:"-"`

	IsPrivate bool
	IsBare    bool

	IsMirror bool
	*Mirror  `xorm:"-" gorm:"-" json:"-"`

	// Advanced settings
	EnableWiki            bool `xorm:"NOT NULL DEFAULT true" gorm:"NOT NULL;DEFAULT:TRUE"`
	AllowPublicWiki       bool
	EnableExternalWiki    bool
	ExternalWikiURL       string
	EnableIssues          bool `xorm:"NOT NULL DEFAULT true" gorm:"NOT NULL;DEFAULT:TRUE"`
	AllowPublicIssues     bool
	EnableExternalTracker bool
	ExternalTrackerURL    string
	ExternalTrackerFormat string
	ExternalTrackerStyle  string
	ExternalMetas         map[string]string `xorm:"-" gorm:"-" json:"-"`
	EnablePulls           bool              `xorm:"NOT NULL DEFAULT true" gorm:"NOT NULL;DEFAULT:TRUE"`
	PullsIgnoreWhitespace bool              `xorm:"NOT NULL DEFAULT false" gorm:"NOT NULL;DEFAULT:FALSE"`
	PullsAllowRebase      bool              `xorm:"NOT NULL DEFAULT false" gorm:"NOT NULL;DEFAULT:FALSE"`

	IsFork   bool `xorm:"NOT NULL DEFAULT false" gorm:"NOT NULL;DEFAULT:FALSE"`
	ForkID   int64
	BaseRepo *Repository `xorm:"-" gorm:"-" json:"-"`

	Created     time.Time `xorm:"-" gorm:"-" json:"-"`
	CreatedUnix int64
	Updated     time.Time `xorm:"-" gorm:"-" json:"-"`
	UpdatedUnix int64
}

Repository contains information of a repository.

func CleanUpMigrateInfo

func CleanUpMigrateInfo(repo *Repository) (*Repository, error)

Finish migrating repository and/or wiki with things that don't need to be done for mirrors.

func CreateRepository

func CreateRepository(doer, owner *User, opts CreateRepoOptions) (_ *Repository, err error)

CreateRepository creates a repository for given user or organization.

func ForkRepository

func ForkRepository(doer, owner *User, baseRepo *Repository, name, desc string) (_ *Repository, err error)

ForkRepository creates a fork of target repository under another user domain.

func GetNonMirrorRepositories

func GetNonMirrorRepositories() ([]*Repository, error)

GetRepositoriesMirror returns only mirror repositories with user.

func GetRecentUpdatedRepositories

func GetRecentUpdatedRepositories(page, pageSize int) (repos []*Repository, err error)

GetRecentUpdatedRepositories returns the list of repositories that are recently updated.

func GetRepositoriesByForkID

func GetRepositoriesByForkID(forkID int64) ([]*Repository, error)

GetRepositoriesByForkID returns all repositories with given fork ID.

func GetRepositoryByID

func GetRepositoryByID(id int64) (*Repository, error)

GetRepositoryByID returns the repository by given id if exists.

func GetRepositoryByName

func GetRepositoryByName(ownerID int64, name string) (*Repository, error)

GetRepositoryByName returns the repository by given name under user if exists. Deprecated: Use Repos.GetByName instead.

func GetRepositoryByRef

func GetRepositoryByRef(ref string) (*Repository, error)

GetRepositoryByRef returns a Repository specified by a GFM reference. See https://help.github.com/articles/writing-on-github#references for more information on the syntax.

func GetUserAndCollaborativeRepositories

func GetUserAndCollaborativeRepositories(userID int64) ([]*Repository, error)

GetUserAndCollaborativeRepositories returns list of repositories the user owns and collaborates.

func GetUserMirrorRepositories

func GetUserMirrorRepositories(userID int64) ([]*Repository, error)

GetUserRepositories returns a list of mirror repositories of given user.

func GetUserRepositories

func GetUserRepositories(opts *UserRepoOptions) ([]*Repository, error)

GetUserRepositories returns a list of repositories of given user.

func HasForkedRepo

func HasForkedRepo(ownerID, repoID int64) (*Repository, bool, error)

HasForkedRepo checks if given user has already forked a repository. When user has already forked, it returns true along with the repository.

func MigrateRepository

func MigrateRepository(doer, owner *User, opts MigrateRepoOptions) (*Repository, error)

MigrateRepository migrates a existing repository from other project hosting.

func Repositories

func Repositories(page, pageSize int) (_ []*Repository, err error)

func RepositoriesWithUsers

func RepositoriesWithUsers(page, pageSize int) (_ []*Repository, err error)

RepositoriesWithUsers returns number of repos in given page.

func SearchRepositoryByName

func SearchRepositoryByName(opts *SearchRepoOptions) (repos []*Repository, count int64, err error)

SearchRepositoryByName takes keyword and part of repository name to search, it returns results in given range and number of total results.

func (*Repository) APIFormat

func (repo *Repository) APIFormat(permission *api.Permission, user ...*User) *api.Repository

This method assumes following fields have been assigned with valid values: Required - BaseRepo (if fork) Arguments that are allowed to be nil: permission

func (*Repository) AddCollaborator

func (repo *Repository) AddCollaborator(u *User) error

AddCollaborator adds new collaboration to a repository with default access mode.

func (*Repository) AddWikiPage

func (repo *Repository) AddWikiPage(doer *User, title, content, message string) error

func (*Repository) AfterFind

func (r *Repository) AfterFind()

NOTE: This is a GORM query hook.

func (*Repository) AfterSet

func (repo *Repository) AfterSet(colName string, _ xorm.Cell)

func (*Repository) AllowsPulls

func (repo *Repository) AllowsPulls() bool

AllowPulls returns true if repository meets the requirements of accepting pulls and has them enabled.

func (repo *Repository) AvatarLink() string

AvatarLink returns repository avatar absolute link.

func (*Repository) BeforeCreate

func (r *Repository) BeforeCreate()

NOTE: This is a GORM create hook.

func (*Repository) BeforeInsert

func (repo *Repository) BeforeInsert()

func (*Repository) BeforeUpdate

func (r *Repository) BeforeUpdate()

NOTE: This is a GORM update hook.

func (*Repository) CanBeForked

func (repo *Repository) CanBeForked() bool

CanBeForked returns true if repository meets the requirements of being forked.

func (*Repository) CanEnableEditor

func (repo *Repository) CanEnableEditor() bool

CanEnableEditor returns true if repository meets the requirements of web editor.

func (*Repository) CanEnablePulls

func (repo *Repository) CanEnablePulls() bool

CanEnablePulls returns true if repository meets the requirements of accepting pulls.

func (*Repository) CanGuestViewIssues

func (repo *Repository) CanGuestViewIssues() bool

func (*Repository) CanGuestViewWiki

func (repo *Repository) CanGuestViewWiki() bool

func (*Repository) ChangeCollaborationAccessMode

func (repo *Repository) ChangeCollaborationAccessMode(userID int64, mode AccessMode) error

ChangeCollaborationAccessMode sets new access mode for the collaboration.

func (*Repository) CheckoutNewBranch

func (repo *Repository) CheckoutNewBranch(oldBranch, newBranch string) error

CheckoutNewBranch checks out to a new branch from the a branch name.

func (repo *Repository) CloneLink() (cl *CloneLink)

CloneLink returns clone URLs of repository.

func (*Repository) ComposeCompareURL

func (repo *Repository) ComposeCompareURL(oldCommitID, newCommitID string) string

func (*Repository) ComposeMetas

func (repo *Repository) ComposeMetas() map[string]string

ComposeMetas composes a map of metas for rendering SHA1 URL and external issue tracker URL.

func (*Repository) CreateNewBranch

func (repo *Repository) CreateNewBranch(oldBranch, newBranch string) (err error)

func (*Repository) CustomAvatarPath

func (repo *Repository) CustomAvatarPath() string

CustomAvatarPath returns repository custom avatar file path.

func (*Repository) DeleteAvatar

func (repo *Repository) DeleteAvatar() error

DeleteAvatar deletes the repository custom avatar.

func (*Repository) DeleteCollaboration

func (repo *Repository) DeleteCollaboration(userID int64) error

func (*Repository) DeleteRepoFile

func (repo *Repository) DeleteRepoFile(doer *User, opts DeleteRepoFileOptions) (err error)

func (*Repository) DeleteWiki

func (repo *Repository) DeleteWiki()

DeleteWiki removes the actual and local copy of repository wiki.

func (*Repository) DeleteWikiPage

func (repo *Repository) DeleteWikiPage(doer *User, title string) (err error)

func (*Repository) DiscardLocalRepoBranchChanges

func (repo *Repository) DiscardLocalRepoBranchChanges(branch string) error

func (*Repository) EditWikiPage

func (repo *Repository) EditWikiPage(doer *User, oldTitle, title, content, message string) error

func (*Repository) FullName

func (repo *Repository) FullName() string

func (*Repository) GetAssigneeByID

func (repo *Repository) GetAssigneeByID(userID int64) (*User, error)

GetAssigneeByID returns the user that has write access of repository by given ID.

func (*Repository) GetAssignees

func (repo *Repository) GetAssignees() (_ []*User, err error)

GetAssignees returns all users that have read access and can be assigned to issues of the repository,

func (*Repository) GetBranch

func (repo *Repository) GetBranch(name string) (*Branch, error)

func (*Repository) GetBranches

func (repo *Repository) GetBranches() ([]*Branch, error)

func (*Repository) GetCollaborators

func (repo *Repository) GetCollaborators() ([]*Collaborator, error)

GetCollaborators returns the collaborators for a repository

func (*Repository) GetDiffPreview

func (repo *Repository) GetDiffPreview(branch, treePath, content string) (diff *gitutil.Diff, err error)

GetDiffPreview produces and returns diff result of a file which is not yet committed.

func (*Repository) GetForks

func (repo *Repository) GetForks() ([]*Repository, error)

func (*Repository) GetMilestoneByID

func (repo *Repository) GetMilestoneByID(milestoneID int64) (*Milestone, error)

GetMilestoneByID returns the milestone belongs to repository by given ID.

func (*Repository) GetMirror

func (repo *Repository) GetMirror() (err error)

func (*Repository) GetOwner

func (repo *Repository) GetOwner() error

func (*Repository) GetStargazers

func (repo *Repository) GetStargazers(page int) ([]*User, error)

func (*Repository) GetWatchers

func (repo *Repository) GetWatchers(page int) ([]*User, error)

Repository.GetWatchers returns range of users watching given repository.

func (*Repository) GetWriters

func (repo *Repository) GetWriters() (_ []*User, err error)

GetWriters returns all users that have write access to the repository.

func (*Repository) GitConfigPath

func (repo *Repository) GitConfigPath() string

func (*Repository) HTMLURL

func (repo *Repository) HTMLURL() string

func (*Repository) HasAccess

func (repo *Repository) HasAccess(userID int64) bool

func (*Repository) HasWiki

func (repo *Repository) HasWiki() bool

HasWiki returns true if repository has wiki.

func (*Repository) InitWiki

func (repo *Repository) InitWiki() error

InitWiki initializes a wiki for repository, it does nothing when repository already has wiki.

func (*Repository) IsBranchRequirePullRequest

func (repo *Repository) IsBranchRequirePullRequest(name string) bool

func (*Repository) IsCollaborator

func (repo *Repository) IsCollaborator(userID int64) bool

func (*Repository) IsOwnedBy

func (repo *Repository) IsOwnedBy(userID int64) bool

func (*Repository) IsPartialPublic

func (repo *Repository) IsPartialPublic() bool

IsPartialPublic returns true if repository is public or allow public access to wiki or issues.

func (*Repository) IssueStats

func (repo *Repository) IssueStats(userID int64, filterMode FilterMode, isPull bool) (int64, int64)

IssueStats returns number of open and closed repository issues by given filter mode.

func (repo *Repository) Link() string

func (*Repository) LoadAttributes

func (repo *Repository) LoadAttributes() error

func (*Repository) LocalCopyPath

func (repo *Repository) LocalCopyPath() string

func (*Repository) LocalWikiPath

func (repo *Repository) LocalWikiPath() string

func (*Repository) MustOwner

func (repo *Repository) MustOwner() *User

MustOwner always returns a valid *User object to avoid conceptually impossible error handling. It creates a fake object that contains error deftail when error occurs.

func (*Repository) NextIssueIndex

func (repo *Repository) NextIssueIndex() int64

FIXME: should have a mutex to prevent producing same index for two issues that are created closely enough.

func (*Repository) PatchPath

func (repo *Repository) PatchPath(index int64) (string, error)

PatchPath returns corresponding patch file path of repository by given issue ID.

func (*Repository) RecalculateAccesses

func (repo *Repository) RecalculateAccesses() error

RecalculateAccesses recalculates all accesses for repository.

func (repo *Repository) RelAvatarLink() string

RelAvatarLink returns relative avatar link to the site domain, which includes app sub-url as prefix. Since Gravatar support not needed here - just check for image path.

func (repo *Repository) RelLink() string

func (*Repository) RepoPath

func (repo *Repository) RepoPath() string

func (*Repository) SavePatch

func (repo *Repository) SavePatch(index int64, patch []byte) error

SavePatch saves patch data to corresponding location by given issue ID.

func (*Repository) UpdateLocalCopyBranch

func (repo *Repository) UpdateLocalCopyBranch(branch string) error

UpdateLocalCopyBranch makes sure local copy of repository in given branch is up-to-date.

func (*Repository) UpdateLocalWiki

func (repo *Repository) UpdateLocalWiki() error

UpdateLocalWiki makes sure the local copy of repository wiki is up-to-date.

func (*Repository) UpdateRepoFile

func (repo *Repository) UpdateRepoFile(doer *User, opts UpdateRepoFileOptions) (err error)

UpdateRepoFile adds or updates a file in repository.

func (*Repository) UpdateSize

func (repo *Repository) UpdateSize() error

func (*Repository) UploadAvatar

func (repo *Repository) UploadAvatar(data []byte) error

UploadAvatar saves custom avatar for repository. FIXME: split uploads to different subdirs in case we have massive number of repositories.

func (*Repository) UploadRepoFiles

func (repo *Repository) UploadRepoFiles(doer *User, opts UploadRepoFileOptions) (err error)
func (repo *Repository) WikiCloneLink() (cl *CloneLink)

WikiCloneLink returns clone URLs of repository wiki.

func (*Repository) WikiPath

func (repo *Repository) WikiPath() string

type RepositoryList

type RepositoryList []*Repository

func (RepositoryList) LoadAttributes

func (repos RepositoryList) LoadAttributes() error

type SMTPConfig

type SMTPConfig struct {
	Auth           string
	Host           string
	Port           int
	AllowedDomains string
	TLS            bool `ini:"tls"`
	SkipVerify     bool
}

type SearchRepoOptions

type SearchRepoOptions struct {
	Keyword  string
	OwnerID  int64
	UserID   int64 // When set results will contain all public/private repositories user has access to
	OrderBy  string
	Private  bool // Include private repositories in results
	Page     int
	PageSize int // Can be smaller than or equal to setting.ExplorePagingNum
}

type SearchUserOptions

type SearchUserOptions struct {
	Keyword  string
	Type     UserType
	OrderBy  string
	Page     int
	PageSize int // Can be smaller than or equal to setting.UI.ExplorePagingNum
}

type SlackAttachment

type SlackAttachment struct {
	Fallback string `json:"fallback"`
	Color    string `json:"color"`
	Title    string `json:"title"`
	Text     string `json:"text"`
}

type SlackMeta

type SlackMeta struct {
	Channel  string `json:"channel"`
	Username string `json:"username"`
	IconURL  string `json:"icon_url"`
	Color    string `json:"color"`
}

type SlackPayload

type SlackPayload struct {
	Channel     string             `json:"channel"`
	Text        string             `json:"text"`
	Username    string             `json:"username"`
	IconURL     string             `json:"icon_url"`
	UnfurlLinks int                `json:"unfurl_links"`
	LinkNames   int                `json:"link_names"`
	Attachments []*SlackAttachment `json:"attachments"`
}

func GetSlackPayload

func GetSlackPayload(p api.Payloader, event HookEventType, meta string) (payload *SlackPayload, err error)

func (*SlackPayload) JSONPayload

func (p *SlackPayload) JSONPayload() ([]byte, error)

type Star

type Star struct {
	ID     int64
	UID    int64 `xorm:"UNIQUE(s)"`
	RepoID int64 `xorm:"UNIQUE(s)"`
}

type Statistic

type Statistic struct {
	Counter struct {
		User, Org, PublicKey,
		Repo, Watch, Star, Action, Access,
		Issue, Comment, Oauth, Follow,
		Mirror, Release, LoginSource, Webhook,
		Milestone, Label, HookTask,
		Team, UpdateTask, Attachment int64
	}
}

func GetStatistic

func GetStatistic() (stats Statistic)

type Team

type Team struct {
	ID          int64
	OrgID       int64 `xorm:"INDEX"`
	LowerName   string
	Name        string
	Description string
	Authorize   AccessMode
	Repos       []*Repository `xorm:"-" json:"-"`
	Members     []*User       `xorm:"-" json:"-"`
	NumRepos    int
	NumMembers  int
}

Team represents a organization team.

func GetTeamByID

func GetTeamByID(teamID int64) (*Team, error)

GetTeamByID returns team by given ID.

func GetTeamOfOrgByName

func GetTeamOfOrgByName(orgID int64, name string) (*Team, error)

GetTeamOfOrgByName returns team by given team name and organization.

func GetTeamsByOrgID

func GetTeamsByOrgID(orgID int64) ([]*Team, error)

GetTeamsByOrgID returns all teams belong to given organization.

func GetTeamsHaveAccessToRepo

func GetTeamsHaveAccessToRepo(orgID, repoID int64, mode AccessMode) ([]*Team, error)

GetTeamsHaveAccessToRepo returns all teams in an organization that have given access level to the repository.

func GetUserTeams

func GetUserTeams(orgID, userID int64) ([]*Team, error)

GetUserTeams returns all teams that user belongs to in given organization.

func (*Team) AddMember

func (t *Team) AddMember(uid int64) error

AddMember adds new membership of the team to the organization, the user will have membership to the organization automatically when needed.

func (*Team) AddRepository

func (t *Team) AddRepository(repo *Repository) (err error)

AddRepository adds new repository to team of organization.

func (*Team) AfterSet

func (t *Team) AfterSet(colName string, _ xorm.Cell)

func (*Team) GetMembers

func (t *Team) GetMembers() (err error)

GetMembers returns all members in team of organization.

func (*Team) GetRepositories

func (t *Team) GetRepositories() error

GetRepositories returns all repositories in team of organization.

func (*Team) HasRepository

func (t *Team) HasRepository(repoID int64) bool

HasRepository returns true if given repository belong to team.

func (*Team) HasWriteAccess

func (t *Team) HasWriteAccess() bool

HasWriteAccess returns true if team has at least write level access mode.

func (*Team) IsMember

func (t *Team) IsMember(userID int64) bool

IsTeamMember returns true if given user is a member of team.

func (*Team) IsOwnerTeam

func (t *Team) IsOwnerTeam() bool

IsOwnerTeam returns true if team is owner team.

func (*Team) RemoveMember

func (t *Team) RemoveMember(uid int64) error

RemoveMember removes member from team of organization.

func (*Team) RemoveRepository

func (t *Team) RemoveRepository(repoID int64) error

RemoveRepository removes repository from team of organization.

type TeamRepo

type TeamRepo struct {
	ID     int64
	OrgID  int64 `xorm:"INDEX"`
	TeamID int64 `xorm:"UNIQUE(s)"`
	RepoID int64 `xorm:"UNIQUE(s)"`
}

TeamRepo represents an team-repository relation.

type TeamUser

type TeamUser struct {
	ID     int64
	OrgID  int64 `xorm:"INDEX"`
	TeamID int64 `xorm:"UNIQUE(s)"`
	UID    int64 `xorm:"UNIQUE(s)"`
}

TeamUser represents an team-user relation.

type TwoFactor

type TwoFactor struct {
	ID          int64
	UserID      int64 `xorm:"UNIQUE" gorm:"UNIQUE"`
	Secret      string
	Created     time.Time `xorm:"-" gorm:"-" json:"-"`
	CreatedUnix int64
}

TwoFactor is a 2FA token of a user.

func (*TwoFactor) AfterFind

func (t *TwoFactor) AfterFind()

NOTE: This is a GORM query hook.

func (*TwoFactor) BeforeCreate

func (t *TwoFactor) BeforeCreate()

NOTE: This is a GORM create hook.

func (*TwoFactor) ValidateTOTP

func (t *TwoFactor) ValidateTOTP(passcode string) (bool, error)

ValidateTOTP returns true if given passcode is valid for two-factor authentication token. It also returns possible validation error.

type TwoFactorRecoveryCode

type TwoFactorRecoveryCode struct {
	ID     int64
	UserID int64
	Code   string `xorm:"VARCHAR(11)"`
	IsUsed bool
}

TwoFactorRecoveryCode represents a two-factor authentication recovery code.

func GetRecoveryCodesByUserID

func GetRecoveryCodesByUserID(userID int64) ([]*TwoFactorRecoveryCode, error)

GetRecoveryCodesByUserID returns all recovery codes of given user.

type TwoFactorsStore

type TwoFactorsStore interface {
	// Create creates a new 2FA token and recovery codes for given user.
	// The "key" is used to encrypt and later decrypt given "secret",
	// which should be configured in site-level and change of the "key"
	// will break all existing 2FA tokens.
	Create(userID int64, key, secret string) error
	// GetByUserID returns the 2FA token of given user.
	// It returns ErrTwoFactorNotFound when not found.
	GetByUserID(userID int64) (*TwoFactor, error)
	// IsUserEnabled returns true if the user has enabled 2FA.
	IsUserEnabled(userID int64) bool
}

TwoFactorsStore is the persistent interface for 2FA.

NOTE: All methods are sorted in alphabetical order.

var TwoFactors TwoFactorsStore

type UpdateRepoFileOptions

type UpdateRepoFileOptions struct {
	LastCommitID string
	OldBranch    string
	NewBranch    string
	OldTreeName  string
	NewTreeName  string
	Message      string
	Content      string
	IsNewFile    bool
}

type Upload

type Upload struct {
	ID   int64
	UUID string `xorm:"uuid UNIQUE"`
	Name string
}

Upload represent a uploaded file to a repo to be deleted when moved

func GetUploadByUUID

func GetUploadByUUID(uuid string) (*Upload, error)

func GetUploadsByUUIDs

func GetUploadsByUUIDs(uuids []string) ([]*Upload, error)

func NewUpload

func NewUpload(name string, buf []byte, file multipart.File) (_ *Upload, err error)

NewUpload creates a new upload object.

func (*Upload) LocalPath

func (upload *Upload) LocalPath() string

LocalPath returns where uploads are temporarily stored in local file system.

type UploadRepoFileOptions

type UploadRepoFileOptions struct {
	LastCommitID string
	OldBranch    string
	NewBranch    string
	TreePath     string
	Message      string
	Files        []string // In UUID format
}

type User

type User struct {
	ID        int64
	LowerName string `xorm:"UNIQUE NOT NULL" gorm:"UNIQUE"`
	Name      string `xorm:"UNIQUE NOT NULL" gorm:"NOT NULL"`
	FullName  string
	// Email is the primary email address (to be used for communication)
	Email       string `xorm:"NOT NULL" gorm:"NOT NULL"`
	Passwd      string `xorm:"NOT NULL" gorm:"NOT NULL"`
	LoginSource int64  `xorm:"NOT NULL DEFAULT 0" gorm:"NOT NULL;DEFAULT:0"`
	LoginName   string
	Type        UserType
	OwnedOrgs   []*User       `xorm:"-" gorm:"-" json:"-"`
	Orgs        []*User       `xorm:"-" gorm:"-" json:"-"`
	Repos       []*Repository `xorm:"-" gorm:"-" json:"-"`
	Location    string
	Website     string
	Rands       string `xorm:"VARCHAR(10)" gorm:"TYPE:VARCHAR(10)"`
	Salt        string `xorm:"VARCHAR(10)" gorm:"TYPE:VARCHAR(10)"`

	Created     time.Time `xorm:"-" gorm:"-" json:"-"`
	CreatedUnix int64
	Updated     time.Time `xorm:"-" gorm:"-" json:"-"`
	UpdatedUnix int64

	// Remember visibility choice for convenience, true for private
	LastRepoVisibility bool
	// Maximum repository creation limit, -1 means use global default
	MaxRepoCreation int `xorm:"NOT NULL DEFAULT -1" gorm:"NOT NULL;DEFAULT:-1"`

	// Permissions
	IsActive         bool // Activate primary email
	IsAdmin          bool
	AllowGitHook     bool
	AllowImportLocal bool // Allow migrate repository by local path
	ProhibitLogin    bool

	// Avatar
	Avatar          string `xorm:"VARCHAR(2048) NOT NULL" gorm:"TYPE:VARCHAR(2048);NOT NULL"`
	AvatarEmail     string `xorm:"NOT NULL" gorm:"NOT NULL"`
	UseCustomAvatar bool

	// Counters
	NumFollowers int
	NumFollowing int `xorm:"NOT NULL DEFAULT 0" gorm:"NOT NULL;DEFAULT:0"`
	NumStars     int
	NumRepos     int

	// For organization
	Description string
	NumTeams    int
	NumMembers  int
	Teams       []*Team `xorm:"-" gorm:"-" json:"-"`
	Members     []*User `xorm:"-" gorm:"-" json:"-"`
}

User represents the object of individual and member of organization.

func GetAssigneeByID

func GetAssigneeByID(repo *Repository, userID int64) (*User, error)

GetAssigneeByID returns the user with write access of repository by given ID.

func GetOrgByName

func GetOrgByName(name string) (*User, error)

GetOrgByName returns organization by given name.

func GetOrgsByUserID

func GetOrgsByUserID(userID int64, showAll bool) ([]*User, error)

GetOrgsByUserID returns a list of organizations that the given user ID has joined.

func GetOrgsByUserIDDesc

func GetOrgsByUserIDDesc(userID int64, desc string, showAll bool) ([]*User, error)

GetOrgsByUserIDDesc returns a list of organizations that the given user ID has joined, ordered descending by the given condition.

func GetOwnedOrgsByUserID

func GetOwnedOrgsByUserID(userID int64) ([]*User, error)

GetOwnedOrgsByUserID returns a list of organizations are owned by given user ID.

func GetOwnedOrgsByUserIDDesc

func GetOwnedOrgsByUserIDDesc(userID int64, desc string) ([]*User, error)

GetOwnedOrganizationsByUserIDDesc returns a list of organizations are owned by given user ID, ordered descending by the given condition.

func GetParticipantsByIssueID

func GetParticipantsByIssueID(issueID int64) ([]*User, error)

GetParticipantsByIssueID returns all users who are participated in comments of an issue.

func GetTeamMembers

func GetTeamMembers(teamID int64) ([]*User, error)

GetTeamMembers returns all members in given team of organization.

func GetUserByEmail

func GetUserByEmail(email string) (*User, error)

GetUserByEmail returns the user object by given e-mail if exists. Deprecated: Use Users.GetByEmail instead.

func GetUserByID

func GetUserByID(id int64) (*User, error)

GetUserByID returns the user object by given ID if exists. Deprecated: Use Users.GetByID instead.

func GetUserByKeyID

func GetUserByKeyID(keyID int64) (*User, error)

func GetUserByName

func GetUserByName(name string) (*User, error)

GetUserByName returns a user by given name. Deprecated: Use Users.GetByUsername instead.

func ListUsers

func ListUsers(page, pageSize int) ([]*User, error)

Users returns number of users in given page.

func LoginViaGitHub

func LoginViaGitHub(login, password string, sourceID int64, cfg *GitHubConfig, autoRegister bool) (*User, error)

func LoginViaLDAP

func LoginViaLDAP(login, password string, source *LoginSource, autoRegister bool) (*User, error)

LoginViaLDAP queries if login/password is valid against the LDAP directory pool, and create a local user if success when enabled.

func LoginViaPAM

func LoginViaPAM(login, password string, sourceID int64, cfg *PAMConfig, autoRegister bool) (*User, error)

LoginViaPAM queries if login/password is valid against the PAM, and create a local user if success when enabled.

func LoginViaSMTP

func LoginViaSMTP(login, password string, sourceID int64, cfg *SMTPConfig, autoRegister bool) (*User, error)

LoginViaSMTP queries if login/password is valid against the SMTP, and create a local user if success when enabled.

func NewGhostUser

func NewGhostUser() *User

NewGhostUser creates and returns a fake user for someone who has deleted his/her account.

func Organizations

func Organizations(page, pageSize int) ([]*User, error)

Organizations returns number of organizations in given page.

func SearchUserByName

func SearchUserByName(opts *SearchUserOptions) (users []*User, _ int64, _ error)

SearchUserByName takes keyword and part of user name to search, it returns results in given range and number of total results.

func ValidateCommitWithEmail

func ValidateCommitWithEmail(c *git.Commit) *User

ValidateCommitWithEmail chceck if author's e-mail of commit is corresponsind to a user.

func VerifyUserActiveCode

func VerifyUserActiveCode(code string) (user *User)

verify active code when active account

func (*User) APIFormat

func (u *User) APIFormat() *api.User

func (*User) AddMember

func (org *User) AddMember(uid int64) error

AddMember adds new member to organization.

func (*User) AfterFind

func (u *User) AfterFind()

NOTE: This is a GORM query hook.

func (*User) AfterSet

func (u *User) AfterSet(colName string, _ xorm.Cell)
func (u *User) AvatarLink() string

AvatarLink returns user avatar absolute link.

func (*User) BeforeCreate

func (u *User) BeforeCreate()

NOTE: This is a GORM create hook.

func (*User) BeforeInsert

func (u *User) BeforeInsert()

func (*User) BeforeUpdate

func (u *User) BeforeUpdate()

func (*User) CanCreateOrganization

func (u *User) CanCreateOrganization() bool

func (*User) CanCreateRepo

func (u *User) CanCreateRepo() bool

func (*User) CanEditGitHook

func (u *User) CanEditGitHook() bool

CanEditGitHook returns true if user can edit Git hooks.

func (*User) CanImportLocal

func (u *User) CanImportLocal() bool

CanImportLocal returns true if user can migrate repository by local path.

func (*User) CustomAvatarPath

func (u *User) CustomAvatarPath() string

CustomAvatarPath returns user custom avatar file path.

func (u *User) DashboardLink() string

DashboardLink returns the user dashboard page link.

func (*User) DeleteAvatar

func (u *User) DeleteAvatar() error

DeleteAvatar deletes the user's custom avatar.

func (*User) DisplayName

func (u *User) DisplayName() string

DisplayName returns full name if it's not empty, returns username otherwise.

func (*User) EncodePassword

func (u *User) EncodePassword()

EncodePassword encodes password to safe format.

func (*User) GenerateActivateCode

func (u *User) GenerateActivateCode() string

GenerateActivateCode generates an activate code based on user information.

func (*User) GenerateEmailActivateCode

func (u *User) GenerateEmailActivateCode(email string) string

GenerateEmailActivateCode generates an activate code based on user information and given e-mail.

func (*User) GenerateRandomAvatar

func (u *User) GenerateRandomAvatar() error

GenerateRandomAvatar generates a random avatar for user.

func (*User) GetAccessibleRepositories

func (user *User) GetAccessibleRepositories(limit int) (repos []*Repository, _ error)

GetAccessibleRepositories finds repositories which the user has access but does not own. If limit is smaller than 1 means returns all found results.

func (*User) GetFollowers

func (u *User) GetFollowers(page int) ([]*User, error)

User.GetFollwoers returns range of user's followers.

func (*User) GetFollowing

func (u *User) GetFollowing(page int) ([]*User, error)

GetFollowing returns range of user's following.

func (*User) GetMembers

func (org *User) GetMembers(limit int) error

GetMembers returns all members of organization.

func (*User) GetMirrorRepositories

func (u *User) GetMirrorRepositories() ([]*Repository, error)

GetRepositories returns mirror repositories that user owns, including private repositories.

func (*User) GetOrganizationCount

func (u *User) GetOrganizationCount() (int64, error)

GetOrganizationCount returns count of membership of organization of user.

func (*User) GetOrganizations

func (u *User) GetOrganizations(showPrivate bool) error

GetOrganizations returns all organizations that user belongs to.

func (*User) GetOwnedOrganizations

func (u *User) GetOwnedOrganizations() (err error)

GetOwnedOrganizations returns all organizations that user owns.

func (*User) GetOwnerTeam

func (org *User) GetOwnerTeam() (*Team, error)

GetOwnerTeam returns owner team of organization.

func (*User) GetRepositories

func (u *User) GetRepositories(page, pageSize int) (err error)

GetRepositories returns repositories that user owns, including private repositories.

func (*User) GetRepositoryAccesses

func (u *User) GetRepositoryAccesses() (map[*Repository]AccessMode, error)

GetRepositoryAccesses finds all repositories with their access mode where a user has access but does not own.

func (*User) GetTeam

func (org *User) GetTeam(name string) (*Team, error)

GetTeamOfOrgByName returns named team of organization.

func (*User) GetTeams

func (org *User) GetTeams() error

GetTeams returns all teams that belong to organization.

func (*User) GetUserMirrorRepositories

func (org *User) GetUserMirrorRepositories(userID int64) ([]*Repository, error)

GetUserMirrorRepositories returns mirror repositories of the organization which the user has access to.

func (*User) GetUserRepositories

func (org *User) GetUserRepositories(userID int64, page, pageSize int) ([]*Repository, int64, error)

GetUserRepositories returns a range of repositories in organization which the user has access to, and total number of records based on given condition.

func (*User) GetUserTeamIDs

func (org *User) GetUserTeamIDs(userID int64) ([]int64, error)

GetUserTeamIDs returns of all team IDs of the organization that user is memeber of.

func (*User) GetUserTeams

func (org *User) GetUserTeams(userID int64) ([]*Team, error)

GetTeams returns all teams that belong to organization, and that the user has joined.

func (*User) HTMLURL

func (u *User) HTMLURL() string

func (*User) HasForkedRepo

func (u *User) HasForkedRepo(repoID int64) bool

HasForkedRepo checks if user has already forked a repository with given ID.

func (u *User) HomeLink() string

HomeLink returns the user or organization home page link.

func (*User) IDStr

func (u *User) IDStr() string

IDStr returns string representation of user's ID.

func (*User) IsAdminOfRepo

func (u *User) IsAdminOfRepo(repo *Repository) bool

IsAdminOfRepo returns true if user has admin or higher access of repository.

func (*User) IsEnabledTwoFactor

func (u *User) IsEnabledTwoFactor() bool

IsEnabledTwoFactor returns true if user has enabled two-factor authentication.

func (*User) IsFollowing

func (u *User) IsFollowing(followID int64) bool

func (*User) IsLocal

func (u *User) IsLocal() bool

returns true if user login type is LoginPlain.

func (*User) IsMailable

func (u *User) IsMailable() bool

IsMailable checks if a user is elegible to receive emails.

func (*User) IsOrgMember

func (org *User) IsOrgMember(uid int64) bool

IsOrgMember returns true if given user is member of organization.

func (*User) IsOrganization

func (u *User) IsOrganization() bool

IsOrganization returns true if user is actually a organization.

func (*User) IsOwnedBy

func (org *User) IsOwnedBy(userID int64) bool

IsOwnedBy returns true if given user is in the owner team.

func (*User) IsPublicMember

func (u *User) IsPublicMember(orgId int64) bool

IsPublicMember returns true if user public his/her membership in give organization.

func (*User) IsUserOrgOwner

func (u *User) IsUserOrgOwner(orgId int64) bool

IsUserOrgOwner returns true if user is in the owner team of given organization.

func (*User) IsWriterOfRepo

func (u *User) IsWriterOfRepo(repo *Repository) bool

IsWriterOfRepo returns true if user has write access to given repository.

func (*User) MailResendCacheKey

func (u *User) MailResendCacheKey() string

MailResendCacheKey returns key used for cache mail resend.

func (*User) NewGitSig

func (u *User) NewGitSig() *git.Signature

NewGitSig generates and returns the signature of given user.

func (u *User) RelAvatarLink() string

RelAvatarLink returns relative avatar link to the site domain, which includes app sub-url as prefix. However, it is possible to return full URL if user enables Gravatar-like service.

func (*User) RemoveMember

func (org *User) RemoveMember(uid int64) error

RemoveMember removes member from organization.

func (*User) RemoveOrgRepo

func (org *User) RemoveOrgRepo(repoID int64) error

RemoveOrgRepo removes all team-repository relations of organization.

func (*User) RepoCreationNum

func (u *User) RepoCreationNum() int

func (*User) ShortName

func (u *User) ShortName(length int) string

func (*User) TeamsHaveAccessToRepo

func (org *User) TeamsHaveAccessToRepo(repoID int64, mode AccessMode) ([]*Team, error)

TeamsHaveAccessToRepo returns all teamsthat have given access level to the repository.

func (*User) TwoFactorCacheKey

func (u *User) TwoFactorCacheKey(passcode string) string

TwoFactorCacheKey returns key used for cache two factor passcode. e.g. TwoFactor_1_012664

func (*User) UploadAvatar

func (u *User) UploadAvatar(data []byte) error

UploadAvatar saves custom avatar for user. FIXME: split uploads to different subdirs in case we have massive number of users.

func (*User) ValidatePassword

func (u *User) ValidatePassword(passwd string) bool

ValidatePassword checks if given password matches the one belongs to the user.

type UserCommit

type UserCommit struct {
	User *User
	*git.Commit
}

UserCommit represents a commit with validation of user.

func ValidateCommitsWithEmails

func ValidateCommitsWithEmails(oldCommits []*git.Commit) []*UserCommit

ValidateCommitsWithEmails checks if authors' e-mails of commits are corresponding to users.

type UserRepoOptions

type UserRepoOptions struct {
	UserID   int64
	Private  bool
	Page     int
	PageSize int
}

type UserType

type UserType int
const (
	UserIndividual UserType = iota // Historic reason to make it starts at 0.
	UserOrganization
)

type UsersStore

type UsersStore interface {
	// Authenticate validates username and password via given login source ID.
	// It returns ErrUserNotExist when the user was not found.
	//
	// When the "loginSourceID" is negative, it aborts the process and returns
	// ErrUserNotExist if the user was not found in the database.
	//
	// When the "loginSourceID" is non-negative, it returns ErrLoginSourceMismatch
	// if the user has different login source ID than the "loginSourceID".
	//
	// When the "loginSourceID" is positive, it tries to authenticate via given
	// login source and creates a new user when not yet exists in the database.
	Authenticate(username, password string, loginSourceID int64) (*User, error)
	// Create creates a new user and persist to database.
	// It returns ErrUserAlreadyExist when a user with same name already exists,
	// or ErrEmailAlreadyUsed if the email has been used by another user.
	Create(opts CreateUserOpts) (*User, error)
	// GetByEmail returns the user (not organization) with given email.
	// It ignores records with unverified emails and returns ErrUserNotExist when not found.
	GetByEmail(email string) (*User, error)
	// GetByID returns the user with given ID. It returns ErrUserNotExist when not found.
	GetByID(id int64) (*User, error)
	// GetByUsername returns the user with given username. It returns ErrUserNotExist when not found.
	GetByUsername(username string) (*User, error)
}

UsersStore is the persistent interface for users.

NOTE: All methods are sorted in alphabetical order.

var Users UsersStore

type Version

type Version struct {
	ID      int64
	Version int64
}

The version table. Should have only one row with id==1

type Watch

type Watch struct {
	ID     int64
	UserID int64 `xorm:"UNIQUE(watch)"`
	RepoID int64 `xorm:"UNIQUE(watch)"`
}

Watch is connection request for receiving repository notification.

func GetWatchers

func GetWatchers(repoID int64) ([]*Watch, error)

GetWatchers returns all watchers of given repository.

type Webhook

type Webhook struct {
	ID           int64
	RepoID       int64
	OrgID        int64
	URL          string `xorm:"url TEXT"`
	ContentType  HookContentType
	Secret       string     `xorm:"TEXT"`
	Events       string     `xorm:"TEXT"`
	*HookEvent   `xorm:"-"` // LEGACY [1.0]: Cannot ignore JSON (i.e. json:"-") here, it breaks old backup archive
	IsSSL        bool       `xorm:"is_ssl"`
	IsActive     bool
	HookTaskType HookTaskType
	Meta         string     `xorm:"TEXT"` // store hook-specific attributes
	LastStatus   HookStatus // Last delivery status

	Created     time.Time `xorm:"-" json:"-"`
	CreatedUnix int64
	Updated     time.Time `xorm:"-" json:"-"`
	UpdatedUnix int64
}

Webhook represents a web hook object.

func GetWebhookByID

func GetWebhookByID(id int64) (*Webhook, error)

GetWebhookByID returns webhook by given ID. Use this function with caution of accessing unauthorized webhook, which means should only be used in non-user interactive functions.

func GetWebhookByOrgID

func GetWebhookByOrgID(orgID, id int64) (*Webhook, error)

GetWebhookByOrgID returns webhook of organization by given ID.

func GetWebhookOfRepoByID

func GetWebhookOfRepoByID(repoID, id int64) (*Webhook, error)

GetWebhookOfRepoByID returns webhook of repository by given ID.

func GetWebhooksByOrgID

func GetWebhooksByOrgID(orgID int64) (ws []*Webhook, err error)

GetWebhooksByOrgID returns all webhooks for an organization.

func GetWebhooksByRepoID

func GetWebhooksByRepoID(repoID int64) ([]*Webhook, error)

GetWebhooksByRepoID returns all webhooks of a repository.

func (*Webhook) AfterSet

func (w *Webhook) AfterSet(colName string, _ xorm.Cell)

func (*Webhook) BeforeInsert

func (w *Webhook) BeforeInsert()

func (*Webhook) BeforeUpdate

func (w *Webhook) BeforeUpdate()

func (*Webhook) EventsArray

func (w *Webhook) EventsArray() []string

func (*Webhook) HasCreateEvent

func (w *Webhook) HasCreateEvent() bool

HasCreateEvent returns true if hook enabled create event.

func (*Webhook) HasDeleteEvent

func (w *Webhook) HasDeleteEvent() bool

HasDeleteEvent returns true if hook enabled delete event.

func (*Webhook) HasForkEvent

func (w *Webhook) HasForkEvent() bool

HasForkEvent returns true if hook enabled fork event.

func (*Webhook) HasIssueCommentEvent

func (w *Webhook) HasIssueCommentEvent() bool

HasIssueCommentEvent returns true if hook enabled issue comment event.

func (*Webhook) HasIssuesEvent

func (w *Webhook) HasIssuesEvent() bool

HasIssuesEvent returns true if hook enabled issues event.

func (*Webhook) HasPullRequestEvent

func (w *Webhook) HasPullRequestEvent() bool

HasPullRequestEvent returns true if hook enabled pull request event.

func (*Webhook) HasPushEvent

func (w *Webhook) HasPushEvent() bool

HasPushEvent returns true if hook enabled push event.

func (*Webhook) HasReleaseEvent

func (w *Webhook) HasReleaseEvent() bool

HasReleaseEvent returns true if hook enabled release event.

func (*Webhook) History

func (w *Webhook) History(page int) ([]*HookTask, error)

History returns history of webhook by given conditions.

func (*Webhook) SlackMeta

func (w *Webhook) SlackMeta() *SlackMeta

func (*Webhook) UpdateEvent

func (w *Webhook) UpdateEvent() error

UpdateEvent handles conversion from HookEvent to Events.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL