2019-04-25 13:06:53 -04:00
// Copyright 2014 The Gogs Authors. All rights reserved.
2020-09-15 22:01:41 -04:00
// Copyright 2020 The Gitea Authors. All rights reserved.
2019-04-25 13:06:53 -04:00
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.
package gitea
import (
"bytes"
"encoding/json"
"fmt"
2020-05-27 09:48:09 -04:00
"net/url"
2020-09-15 22:01:41 -04:00
"strings"
2019-04-25 13:06:53 -04:00
"time"
)
// Permission represents a set of permissions
type Permission struct {
Admin bool ` json:"admin" `
Push bool ` json:"push" `
Pull bool ` json:"pull" `
}
// Repository represents a repository
type Repository struct {
2019-10-13 11:13:33 -04:00
ID int64 ` json:"id" `
Owner * User ` json:"owner" `
Name string ` json:"name" `
FullName string ` json:"full_name" `
Description string ` json:"description" `
Empty bool ` json:"empty" `
Private bool ` json:"private" `
Fork bool ` json:"fork" `
Parent * Repository ` json:"parent" `
Mirror bool ` json:"mirror" `
Size int ` json:"size" `
HTMLURL string ` json:"html_url" `
SSHURL string ` json:"ssh_url" `
CloneURL string ` json:"clone_url" `
OriginalURL string ` json:"original_url" `
Website string ` json:"website" `
Stars int ` json:"stars_count" `
Forks int ` json:"forks_count" `
Watchers int ` json:"watchers_count" `
OpenIssues int ` json:"open_issues_count" `
DefaultBranch string ` json:"default_branch" `
Archived bool ` json:"archived" `
Created time . Time ` json:"created_at" `
Updated time . Time ` json:"updated_at" `
Permissions * Permission ` json:"permissions,omitempty" `
HasIssues bool ` json:"has_issues" `
HasWiki bool ` json:"has_wiki" `
HasPullRequests bool ` json:"has_pull_requests" `
IgnoreWhitespaceConflicts bool ` json:"ignore_whitespace_conflicts" `
AllowMerge bool ` json:"allow_merge_commits" `
AllowRebase bool ` json:"allow_rebase" `
AllowRebaseMerge bool ` json:"allow_rebase_explicit" `
AllowSquash bool ` json:"allow_squash_merge" `
AvatarURL string ` json:"avatar_url" `
2019-04-25 13:06:53 -04:00
}
2020-09-15 22:01:41 -04:00
// RepoType represent repo type
type RepoType string
const (
// RepoTypeNone dont specify a type
RepoTypeNone RepoType = ""
// RepoTypeSource is the default repo type
RepoTypeSource RepoType = "source"
// RepoTypeFork is a repo witch was forked from an other one
RepoTypeFork RepoType = "fork"
// RepoTypeMirror represents an mirror repo
RepoTypeMirror RepoType = "mirror"
)
2020-11-14 05:31:01 -05:00
// TrustModel represent how git signatures are handled in a repository
type TrustModel string
const (
// TrustModelDefault use TM set by global config
TrustModelDefault TrustModel = "default"
// TrustModelCollaborator gpg signature has to be owned by a repo collaborator
TrustModelCollaborator TrustModel = "collaborator"
// TrustModelCommitter gpg signature has to match committer
TrustModelCommitter TrustModel = "committer"
// TrustModelCollaboratorCommitter gpg signature has to match committer and owned by a repo collaborator
TrustModelCollaboratorCommitter TrustModel = "collaboratorcommitter"
)
2020-05-27 09:48:09 -04:00
// ListReposOptions options for listing repositories
type ListReposOptions struct {
ListOptions
}
2019-04-25 13:06:53 -04:00
// ListMyRepos lists all repositories for the authenticated user that has access to.
2020-09-15 22:01:41 -04:00
func ( c * Client ) ListMyRepos ( opt ListReposOptions ) ( [ ] * Repository , * Response , error ) {
2020-05-27 09:48:09 -04:00
opt . setDefaults ( )
repos := make ( [ ] * Repository , 0 , opt . PageSize )
2020-09-15 22:01:41 -04:00
resp , err := c . getParsedResponse ( "GET" , fmt . Sprintf ( "/user/repos?%s" , opt . getURLQuery ( ) . Encode ( ) ) , nil , nil , & repos )
return repos , resp , err
2019-04-25 13:06:53 -04:00
}
// ListUserRepos list all repositories of one user by user's name
2020-09-15 22:01:41 -04:00
func ( c * Client ) ListUserRepos ( user string , opt ListReposOptions ) ( [ ] * Repository , * Response , error ) {
2020-05-27 09:48:09 -04:00
opt . setDefaults ( )
repos := make ( [ ] * Repository , 0 , opt . PageSize )
2020-09-15 22:01:41 -04:00
resp , err := c . getParsedResponse ( "GET" , fmt . Sprintf ( "/users/%s/repos?%s" , user , opt . getURLQuery ( ) . Encode ( ) ) , nil , nil , & repos )
return repos , resp , err
2020-05-27 09:48:09 -04:00
}
// ListOrgReposOptions options for a organization's repositories
type ListOrgReposOptions struct {
ListOptions
2019-04-25 13:06:53 -04:00
}
// ListOrgRepos list all repositories of one organization by organization's name
2020-09-15 22:01:41 -04:00
func ( c * Client ) ListOrgRepos ( org string , opt ListOrgReposOptions ) ( [ ] * Repository , * Response , error ) {
2020-05-27 09:48:09 -04:00
opt . setDefaults ( )
repos := make ( [ ] * Repository , 0 , opt . PageSize )
2020-09-15 22:01:41 -04:00
resp , err := c . getParsedResponse ( "GET" , fmt . Sprintf ( "/orgs/%s/repos?%s" , org , opt . getURLQuery ( ) . Encode ( ) ) , nil , nil , & repos )
return repos , resp , err
2020-05-27 09:48:09 -04:00
}
// SearchRepoOptions options for searching repositories
type SearchRepoOptions struct {
ListOptions
2020-09-15 22:01:41 -04:00
// The keyword to query
Keyword string
// Limit search to repositories with keyword as topic
KeywordIsTopic bool
// Include search of keyword within repository description
KeywordInDescription bool
/ *
User Filter
* /
// Repo Owner
OwnerID int64
// Stared By UserID
StarredByUserID int64
/ *
Repo Attributes
* /
// pubic, private or all repositories (defaults to all)
IsPrivate * bool
// archived, non-archived or all repositories (defaults to all)
IsArchived * bool
// Exclude template repos from search
ExcludeTemplate bool
// Filter by "fork", "source", "mirror"
Type RepoType
/ *
Sort Filters
* /
// sort repos by attribute. Supported values are "alpha", "created", "updated", "size", and "id". Default is "alpha"
Sort string
// sort order, either "asc" (ascending) or "desc" (descending). Default is "asc", ignored if "sort" is not specified.
Order string
// Repo owner to prioritize in the results
PrioritizedByOwnerID int64
/ *
Cover EdgeCases
* /
// if set all other options are ignored and this string is used as query
RawQuery string
2020-05-27 09:48:09 -04:00
}
// QueryEncode turns options into querystring argument
func ( opt * SearchRepoOptions ) QueryEncode ( ) string {
query := opt . getURLQuery ( )
if opt . Keyword != "" {
query . Add ( "q" , opt . Keyword )
}
2020-09-15 22:01:41 -04:00
if opt . KeywordIsTopic {
query . Add ( "topic" , "true" )
2020-05-27 09:48:09 -04:00
}
2020-09-15 22:01:41 -04:00
if opt . KeywordInDescription {
query . Add ( "includeDesc" , "true" )
2020-05-27 09:48:09 -04:00
}
2020-09-15 22:01:41 -04:00
// User Filter
if opt . OwnerID > 0 {
query . Add ( "uid" , fmt . Sprintf ( "%d" , opt . OwnerID ) )
query . Add ( "exclusive" , "true" )
2020-05-27 09:48:09 -04:00
}
2020-09-15 22:01:41 -04:00
if opt . StarredByUserID > 0 {
query . Add ( "starredBy" , fmt . Sprintf ( "%d" , opt . StarredByUserID ) )
2020-05-27 09:48:09 -04:00
}
2020-09-15 22:01:41 -04:00
// Repo Attributes
if opt . IsPrivate != nil {
query . Add ( "is_private" , fmt . Sprintf ( "%v" , opt . IsPrivate ) )
}
if opt . IsArchived != nil {
query . Add ( "archived" , fmt . Sprintf ( "%v" , opt . IsArchived ) )
}
if opt . ExcludeTemplate {
query . Add ( "template" , "false" )
}
if len ( opt . Type ) != 0 {
query . Add ( "mode" , string ( opt . Type ) )
}
2020-05-27 09:48:09 -04:00
2020-09-15 22:01:41 -04:00
// Sort Filters
2020-05-27 09:48:09 -04:00
if opt . Sort != "" {
query . Add ( "sort" , opt . Sort )
}
2020-09-15 22:01:41 -04:00
if opt . PrioritizedByOwnerID > 0 {
query . Add ( "priority_owner_id" , fmt . Sprintf ( "%d" , opt . PrioritizedByOwnerID ) )
}
if opt . Order != "" {
query . Add ( "order" , opt . Order )
}
2020-05-27 09:48:09 -04:00
return query . Encode ( )
}
type searchRepoResponse struct {
Repos [ ] * Repository ` json:"data" `
}
// SearchRepos searches for repositories matching the given filters
2020-09-15 22:01:41 -04:00
func ( c * Client ) SearchRepos ( opt SearchRepoOptions ) ( [ ] * Repository , * Response , error ) {
2020-05-27 09:48:09 -04:00
opt . setDefaults ( )
2020-09-15 22:01:41 -04:00
repos := new ( searchRepoResponse )
2020-05-27 09:48:09 -04:00
link , _ := url . Parse ( "/repos/search" )
2020-09-15 22:01:41 -04:00
if len ( opt . RawQuery ) != 0 {
link . RawQuery = opt . RawQuery
} else {
link . RawQuery = opt . QueryEncode ( )
// IsPrivate only works on gitea >= 1.12.0
2020-11-14 05:31:01 -05:00
if err := c . checkServerVersionGreaterThanOrEqual ( version1_12_0 ) ; err != nil && opt . IsPrivate != nil {
2020-09-15 22:01:41 -04:00
if * opt . IsPrivate {
// private repos only not supported on gitea <= 1.11.x
return nil , nil , err
}
link . Query ( ) . Add ( "private" , "false" )
}
}
resp , err := c . getParsedResponse ( "GET" , link . String ( ) , nil , nil , & repos )
return repos . Repos , resp , err
2019-04-25 13:06:53 -04:00
}
// CreateRepoOption options when creating repository
type CreateRepoOption struct {
// Name of the repository to create
2019-10-13 11:13:33 -04:00
Name string ` json:"name" `
2019-04-25 13:06:53 -04:00
// Description of the repository to create
2019-10-13 11:13:33 -04:00
Description string ` json:"description" `
2019-04-25 13:06:53 -04:00
// Whether the repository is private
Private bool ` json:"private" `
2019-10-13 11:13:33 -04:00
// Issue Label set to use
IssueLabels string ` json:"issue_labels" `
2019-04-25 13:06:53 -04:00
// Whether the repository should be auto-intialized?
AutoInit bool ` json:"auto_init" `
2020-11-14 05:31:01 -05:00
// Whether the repository is template
Template bool ` json:"template" `
2019-04-25 13:06:53 -04:00
// Gitignores to use
Gitignores string ` json:"gitignores" `
// License to use
License string ` json:"license" `
// Readme of the repository to create
Readme string ` json:"readme" `
2020-05-27 09:48:09 -04:00
// DefaultBranch of the repository (used when initializes and in template)
DefaultBranch string ` json:"default_branch" `
2020-11-14 05:31:01 -05:00
// TrustModel of the repository
TrustModel TrustModel ` json:"trust_model" `
2019-04-25 13:06:53 -04:00
}
2020-09-15 22:01:41 -04:00
// Validate the CreateRepoOption struct
2020-11-14 05:31:01 -05:00
func ( opt CreateRepoOption ) Validate ( c * Client ) error {
2020-09-15 22:01:41 -04:00
if len ( strings . TrimSpace ( opt . Name ) ) == 0 {
return fmt . Errorf ( "name is empty" )
}
2020-11-14 05:31:01 -05:00
if len ( opt . Name ) > 100 {
return fmt . Errorf ( "name has more than 100 chars" )
}
if len ( opt . Description ) > 255 {
return fmt . Errorf ( "name has more than 255 chars" )
}
if len ( opt . DefaultBranch ) > 100 {
return fmt . Errorf ( "name has more than 100 chars" )
}
if len ( opt . TrustModel ) != 0 {
if err := c . CheckServerVersionConstraint ( ">=1.13.0" ) ; err != nil {
return err
}
}
2020-09-15 22:01:41 -04:00
return nil
}
2019-04-25 13:06:53 -04:00
// CreateRepo creates a repository for authenticated user.
2020-09-15 22:01:41 -04:00
func ( c * Client ) CreateRepo ( opt CreateRepoOption ) ( * Repository , * Response , error ) {
2020-11-14 05:31:01 -05:00
if err := opt . Validate ( c ) ; err != nil {
2020-09-15 22:01:41 -04:00
return nil , nil , err
}
2019-04-25 13:06:53 -04:00
body , err := json . Marshal ( & opt )
if err != nil {
2020-09-15 22:01:41 -04:00
return nil , nil , err
2019-04-25 13:06:53 -04:00
}
repo := new ( Repository )
2020-09-15 22:01:41 -04:00
resp , err := c . getParsedResponse ( "POST" , "/user/repos" , jsonHeader , bytes . NewReader ( body ) , repo )
return repo , resp , err
2019-04-25 13:06:53 -04:00
}
// CreateOrgRepo creates an organization repository for authenticated user.
2020-09-15 22:01:41 -04:00
func ( c * Client ) CreateOrgRepo ( org string , opt CreateRepoOption ) ( * Repository , * Response , error ) {
2020-11-14 05:31:01 -05:00
if err := opt . Validate ( c ) ; err != nil {
2020-09-15 22:01:41 -04:00
return nil , nil , err
}
2019-04-25 13:06:53 -04:00
body , err := json . Marshal ( & opt )
if err != nil {
2020-09-15 22:01:41 -04:00
return nil , nil , err
2019-04-25 13:06:53 -04:00
}
repo := new ( Repository )
2020-09-15 22:01:41 -04:00
resp , err := c . getParsedResponse ( "POST" , fmt . Sprintf ( "/org/%s/repos" , org ) , jsonHeader , bytes . NewReader ( body ) , repo )
return repo , resp , err
2019-04-25 13:06:53 -04:00
}
// GetRepo returns information of a repository of given owner.
2020-09-15 22:01:41 -04:00
func ( c * Client ) GetRepo ( owner , reponame string ) ( * Repository , * Response , error ) {
2019-04-25 13:06:53 -04:00
repo := new ( Repository )
2020-09-15 22:01:41 -04:00
resp , err := c . getParsedResponse ( "GET" , fmt . Sprintf ( "/repos/%s/%s" , owner , reponame ) , nil , nil , repo )
return repo , resp , err
2019-04-25 13:06:53 -04:00
}
2019-10-13 11:13:33 -04:00
// EditRepoOption options when editing a repository's properties
type EditRepoOption struct {
// name of the repository
Name * string ` json:"name,omitempty" `
// a short description of the repository.
Description * string ` json:"description,omitempty" `
// a URL with more information about the repository.
Website * string ` json:"website,omitempty" `
// either `true` to make the repository private or `false` to make it public.
// Note: you will get a 422 error if the organization restricts changing repository visibility to organization
// owners and a non-owner tries to change the value of private.
Private * bool ` json:"private,omitempty" `
// either `true` to enable issues for this repository or `false` to disable them.
HasIssues * bool ` json:"has_issues,omitempty" `
// either `true` to enable the wiki for this repository or `false` to disable it.
HasWiki * bool ` json:"has_wiki,omitempty" `
// sets the default branch for this repository.
DefaultBranch * string ` json:"default_branch,omitempty" `
// either `true` to allow pull requests, or `false` to prevent pull request.
HasPullRequests * bool ` json:"has_pull_requests,omitempty" `
// either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace. `has_pull_requests` must be `true`.
IgnoreWhitespaceConflicts * bool ` json:"ignore_whitespace_conflicts,omitempty" `
// either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. `has_pull_requests` must be `true`.
AllowMerge * bool ` json:"allow_merge_commits,omitempty" `
// either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. `has_pull_requests` must be `true`.
AllowRebase * bool ` json:"allow_rebase,omitempty" `
// either `true` to allow rebase with explicit merge commits (--no-ff), or `false` to prevent rebase with explicit merge commits. `has_pull_requests` must be `true`.
AllowRebaseMerge * bool ` json:"allow_rebase_explicit,omitempty" `
// either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. `has_pull_requests` must be `true`.
AllowSquash * bool ` json:"allow_squash_merge,omitempty" `
// set to `true` to archive this repository.
Archived * bool ` json:"archived,omitempty" `
}
// EditRepo edit the properties of a repository
2020-09-15 22:01:41 -04:00
func ( c * Client ) EditRepo ( owner , reponame string , opt EditRepoOption ) ( * Repository , * Response , error ) {
2019-10-13 11:13:33 -04:00
body , err := json . Marshal ( & opt )
if err != nil {
2020-09-15 22:01:41 -04:00
return nil , nil , err
2019-10-13 11:13:33 -04:00
}
repo := new ( Repository )
2020-09-15 22:01:41 -04:00
resp , err := c . getParsedResponse ( "PATCH" , fmt . Sprintf ( "/repos/%s/%s" , owner , reponame ) , jsonHeader , bytes . NewReader ( body ) , repo )
return repo , resp , err
2019-10-13 11:13:33 -04:00
}
2019-04-25 13:06:53 -04:00
// DeleteRepo deletes a repository of user or organization.
2020-09-15 22:01:41 -04:00
func ( c * Client ) DeleteRepo ( owner , repo string ) ( * Response , error ) {
_ , resp , err := c . getResponse ( "DELETE" , fmt . Sprintf ( "/repos/%s/%s" , owner , repo ) , nil , nil )
return resp , err
2019-04-25 13:06:53 -04:00
}
2020-09-15 22:01:41 -04:00
// MirrorSync adds a mirrored repository to the mirror sync queue.
func ( c * Client ) MirrorSync ( owner , repo string ) ( * Response , error ) {
_ , resp , err := c . getResponse ( "POST" , fmt . Sprintf ( "/repos/%s/%s/mirror-sync" , owner , repo ) , nil , nil )
return resp , err
2019-04-25 13:06:53 -04:00
}
2020-09-15 22:01:41 -04:00
// GetRepoLanguages return language stats of a repo
func ( c * Client ) GetRepoLanguages ( owner , repo string ) ( map [ string ] int64 , * Response , error ) {
langMap := make ( map [ string ] int64 )
data , resp , err := c . getResponse ( "GET" , fmt . Sprintf ( "/repos/%s/%s/languages" , owner , repo ) , jsonHeader , nil )
2019-04-25 13:06:53 -04:00
if err != nil {
2020-09-15 22:01:41 -04:00
return nil , resp , err
2019-04-25 13:06:53 -04:00
}
2020-09-15 22:01:41 -04:00
if err = json . Unmarshal ( data , & langMap ) ; err != nil {
return nil , resp , err
}
return langMap , resp , nil
2019-04-25 13:06:53 -04:00
}
2020-09-15 22:01:41 -04:00
// ArchiveType represent supported archive formats by gitea
type ArchiveType string
const (
// ZipArchive represent zip format
ZipArchive ArchiveType = ".zip"
// TarGZArchive represent tar.gz format
TarGZArchive ArchiveType = ".tar.gz"
)
// GetArchive get an archive of a repository by git reference
// e.g.: ref -> master, 70b7c74b33, v1.2.1, ...
func ( c * Client ) GetArchive ( owner , repo , ref string , ext ArchiveType ) ( [ ] byte , * Response , error ) {
return c . getResponse ( "GET" , fmt . Sprintf ( "/repos/%s/%s/archive/%s%s" , owner , repo , url . PathEscape ( ref ) , ext ) , nil , nil )
2019-04-25 13:06:53 -04:00
}