repo.go 68 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311
  1. // Copyright 2014 The Gogs Authors. All rights reserved.
  2. // Use of this source code is governed by a MIT-style
  3. // license that can be found in the LICENSE file.
  4. package models
  5. import (
  6. "bytes"
  7. "fmt"
  8. "io/ioutil"
  9. "os"
  10. "os/exec"
  11. "path"
  12. "path/filepath"
  13. "sort"
  14. "strings"
  15. "time"
  16. "github.com/Unknwon/cae/zip"
  17. "github.com/Unknwon/com"
  18. "github.com/go-xorm/xorm"
  19. "github.com/mcuadros/go-version"
  20. log "gopkg.in/clog.v1"
  21. "gopkg.in/ini.v1"
  22. git "github.com/gogits/git-module"
  23. api "github.com/gogits/go-gogs-client"
  24. "github.com/gogits/gogs/models/errors"
  25. "github.com/gogits/gogs/modules/bindata"
  26. "github.com/gogits/gogs/modules/markdown"
  27. "github.com/gogits/gogs/modules/process"
  28. "github.com/gogits/gogs/modules/setting"
  29. "github.com/gogits/gogs/modules/sync"
  30. )
  31. var repoWorkingPool = sync.NewExclusivePool()
  32. var (
  33. Gitignores, Licenses, Readmes, LabelTemplates []string
  34. // Maximum items per page in forks, watchers and stars of a repo
  35. ItemsPerPage = 40
  36. )
  37. func LoadRepoConfig() {
  38. // Load .gitignore and license files and readme templates.
  39. types := []string{"gitignore", "license", "readme", "label"}
  40. typeFiles := make([][]string, 4)
  41. for i, t := range types {
  42. files, err := bindata.AssetDir("conf/" + t)
  43. if err != nil {
  44. log.Fatal(4, "Fail to get %s files: %v", t, err)
  45. }
  46. customPath := path.Join(setting.CustomPath, "conf", t)
  47. if com.IsDir(customPath) {
  48. customFiles, err := com.StatDir(customPath)
  49. if err != nil {
  50. log.Fatal(4, "Fail to get custom %s files: %v", t, err)
  51. }
  52. for _, f := range customFiles {
  53. if !com.IsSliceContainsStr(files, f) {
  54. files = append(files, f)
  55. }
  56. }
  57. }
  58. typeFiles[i] = files
  59. }
  60. Gitignores = typeFiles[0]
  61. Licenses = typeFiles[1]
  62. Readmes = typeFiles[2]
  63. LabelTemplates = typeFiles[3]
  64. sort.Strings(Gitignores)
  65. sort.Strings(Licenses)
  66. sort.Strings(Readmes)
  67. sort.Strings(LabelTemplates)
  68. // Filter out invalid names and promote preferred licenses.
  69. sortedLicenses := make([]string, 0, len(Licenses))
  70. for _, name := range setting.Repository.PreferredLicenses {
  71. if com.IsSliceContainsStr(Licenses, name) {
  72. sortedLicenses = append(sortedLicenses, name)
  73. }
  74. }
  75. for _, name := range Licenses {
  76. if !com.IsSliceContainsStr(setting.Repository.PreferredLicenses, name) {
  77. sortedLicenses = append(sortedLicenses, name)
  78. }
  79. }
  80. Licenses = sortedLicenses
  81. }
  82. func NewRepoContext() {
  83. zip.Verbose = false
  84. // Check Git installation.
  85. if _, err := exec.LookPath("git"); err != nil {
  86. log.Fatal(4, "Fail to test 'git' command: %v (forgotten install?)", err)
  87. }
  88. // Check Git version.
  89. var err error
  90. setting.Git.Version, err = git.BinVersion()
  91. if err != nil {
  92. log.Fatal(4, "Fail to get Git version: %v", err)
  93. }
  94. log.Info("Git Version: %s", setting.Git.Version)
  95. if version.Compare("1.7.1", setting.Git.Version, ">") {
  96. log.Fatal(4, "Gogs requires Git version greater or equal to 1.7.1")
  97. }
  98. git.HookDir = "custom_hooks"
  99. git.HookSampleDir = "hooks"
  100. git.DefaultCommitsPageSize = setting.UI.User.CommitsPagingNum
  101. // Git requires setting user.name and user.email in order to commit changes.
  102. for configKey, defaultValue := range map[string]string{"user.name": "Gogs", "user.email": "gogs@fake.local"} {
  103. if stdout, stderr, err := process.Exec("NewRepoContext(get setting)", "git", "config", "--get", configKey); err != nil || strings.TrimSpace(stdout) == "" {
  104. // ExitError indicates this config is not set
  105. if _, ok := err.(*exec.ExitError); ok || strings.TrimSpace(stdout) == "" {
  106. if _, stderr, gerr := process.Exec("NewRepoContext(set "+configKey+")", "git", "config", "--global", configKey, defaultValue); gerr != nil {
  107. log.Fatal(4, "Fail to set git %s(%s): %s", configKey, gerr, stderr)
  108. }
  109. log.Info("Git config %s set to %s", configKey, defaultValue)
  110. } else {
  111. log.Fatal(4, "Fail to get git %s(%s): %s", configKey, err, stderr)
  112. }
  113. }
  114. }
  115. // Set git some configurations.
  116. if _, stderr, err := process.Exec("NewRepoContext(git config --global core.quotepath false)",
  117. "git", "config", "--global", "core.quotepath", "false"); err != nil {
  118. log.Fatal(4, "Fail to execute 'git config --global core.quotepath false': %s", stderr)
  119. }
  120. RemoveAllWithNotice("Clean up repository temporary data", filepath.Join(setting.AppDataPath, "tmp"))
  121. }
  122. // Repository contains information of a repository.
  123. type Repository struct {
  124. ID int64 `xorm:"pk autoincr"`
  125. OwnerID int64 `xorm:"UNIQUE(s)"`
  126. Owner *User `xorm:"-"`
  127. LowerName string `xorm:"UNIQUE(s) INDEX NOT NULL"`
  128. Name string `xorm:"INDEX NOT NULL"`
  129. Description string
  130. Website string
  131. DefaultBranch string
  132. Size int64 `xorm:"NOT NULL DEFAULT 0"`
  133. NumWatches int
  134. NumStars int
  135. NumForks int
  136. NumIssues int
  137. NumClosedIssues int
  138. NumOpenIssues int `xorm:"-"`
  139. NumPulls int
  140. NumClosedPulls int
  141. NumOpenPulls int `xorm:"-"`
  142. NumMilestones int `xorm:"NOT NULL DEFAULT 0"`
  143. NumClosedMilestones int `xorm:"NOT NULL DEFAULT 0"`
  144. NumOpenMilestones int `xorm:"-"`
  145. NumTags int `xorm:"-"`
  146. IsPrivate bool
  147. IsBare bool
  148. IsMirror bool
  149. *Mirror `xorm:"-"`
  150. // Advanced settings
  151. EnableWiki bool `xorm:"NOT NULL DEFAULT true"`
  152. EnableExternalWiki bool
  153. ExternalWikiURL string
  154. EnableIssues bool `xorm:"NOT NULL DEFAULT true"`
  155. EnableExternalTracker bool
  156. ExternalTrackerURL string
  157. ExternalTrackerFormat string
  158. ExternalTrackerStyle string
  159. ExternalMetas map[string]string `xorm:"-"`
  160. EnablePulls bool `xorm:"NOT NULL DEFAULT true"`
  161. IsFork bool `xorm:"NOT NULL DEFAULT false"`
  162. ForkID int64
  163. BaseRepo *Repository `xorm:"-"`
  164. Created time.Time `xorm:"-"`
  165. CreatedUnix int64
  166. Updated time.Time `xorm:"-"`
  167. UpdatedUnix int64
  168. }
  169. func (repo *Repository) BeforeInsert() {
  170. repo.CreatedUnix = time.Now().Unix()
  171. repo.UpdatedUnix = repo.CreatedUnix
  172. }
  173. func (repo *Repository) BeforeUpdate() {
  174. repo.UpdatedUnix = time.Now().Unix()
  175. }
  176. func (repo *Repository) AfterSet(colName string, _ xorm.Cell) {
  177. switch colName {
  178. case "default_branch":
  179. // FIXME: use models migration to solve all at once.
  180. if len(repo.DefaultBranch) == 0 {
  181. repo.DefaultBranch = "master"
  182. }
  183. case "num_closed_issues":
  184. repo.NumOpenIssues = repo.NumIssues - repo.NumClosedIssues
  185. case "num_closed_pulls":
  186. repo.NumOpenPulls = repo.NumPulls - repo.NumClosedPulls
  187. case "num_closed_milestones":
  188. repo.NumOpenMilestones = repo.NumMilestones - repo.NumClosedMilestones
  189. case "external_tracker_style":
  190. if len(repo.ExternalTrackerStyle) == 0 {
  191. repo.ExternalTrackerStyle = markdown.ISSUE_NAME_STYLE_NUMERIC
  192. }
  193. case "created_unix":
  194. repo.Created = time.Unix(repo.CreatedUnix, 0).Local()
  195. case "updated_unix":
  196. repo.Updated = time.Unix(repo.UpdatedUnix, 0)
  197. }
  198. }
  199. func (repo *Repository) loadAttributes(e Engine) (err error) {
  200. if repo.Owner == nil {
  201. repo.Owner, err = getUserByID(e, repo.OwnerID)
  202. if err != nil {
  203. return fmt.Errorf("getUserByID [%d]: %v", repo.OwnerID, err)
  204. }
  205. }
  206. if repo.IsFork && repo.BaseRepo == nil {
  207. repo.BaseRepo, err = getRepositoryByID(e, repo.ForkID)
  208. if err != nil {
  209. if errors.IsRepoNotExist(err) {
  210. repo.IsFork = false
  211. repo.ForkID = 0
  212. } else {
  213. return fmt.Errorf("getRepositoryByID [%d]: %v", repo.ForkID, err)
  214. }
  215. }
  216. }
  217. return nil
  218. }
  219. func (repo *Repository) LoadAttributes() error {
  220. return repo.loadAttributes(x)
  221. }
  222. // MustOwner always returns a valid *User object to avoid
  223. // conceptually impossible error handling.
  224. // It creates a fake object that contains error deftail
  225. // when error occurs.
  226. func (repo *Repository) MustOwner() *User {
  227. return repo.mustOwner(x)
  228. }
  229. func (repo *Repository) FullName() string {
  230. return repo.MustOwner().Name + "/" + repo.Name
  231. }
  232. func (repo *Repository) HTMLURL() string {
  233. return setting.AppUrl + repo.FullName()
  234. }
  235. // Arguments that are allowed to be nil: permission
  236. func (repo *Repository) APIFormat(permission *api.Permission) *api.Repository {
  237. cloneLink := repo.CloneLink()
  238. return &api.Repository{
  239. ID: repo.ID,
  240. Owner: repo.Owner.APIFormat(),
  241. Name: repo.Name,
  242. FullName: repo.FullName(),
  243. Description: repo.Description,
  244. Private: repo.IsPrivate,
  245. Fork: repo.IsFork,
  246. HTMLURL: repo.HTMLURL(),
  247. SSHURL: cloneLink.SSH,
  248. CloneURL: cloneLink.HTTPS,
  249. Website: repo.Website,
  250. Stars: repo.NumStars,
  251. Forks: repo.NumForks,
  252. Watchers: repo.NumWatches,
  253. OpenIssues: repo.NumOpenIssues,
  254. DefaultBranch: repo.DefaultBranch,
  255. Created: repo.Created,
  256. Updated: repo.Updated,
  257. Permissions: permission,
  258. }
  259. }
  260. func (repo *Repository) getOwner(e Engine) (err error) {
  261. if repo.Owner != nil {
  262. return nil
  263. }
  264. repo.Owner, err = getUserByID(e, repo.OwnerID)
  265. return err
  266. }
  267. func (repo *Repository) GetOwner() error {
  268. return repo.getOwner(x)
  269. }
  270. func (repo *Repository) mustOwner(e Engine) *User {
  271. if err := repo.getOwner(e); err != nil {
  272. return &User{
  273. Name: "error",
  274. FullName: err.Error(),
  275. }
  276. }
  277. return repo.Owner
  278. }
  279. func (repo *Repository) UpdateSize() error {
  280. countObject, err := git.GetRepoSize(repo.RepoPath())
  281. if err != nil {
  282. return fmt.Errorf("GetRepoSize: %v", err)
  283. }
  284. repo.Size = countObject.Size + countObject.SizePack
  285. if _, err = x.Id(repo.ID).Cols("size").Update(repo); err != nil {
  286. return fmt.Errorf("update size: %v", err)
  287. }
  288. return nil
  289. }
  290. // ComposeMetas composes a map of metas for rendering external issue tracker URL.
  291. func (repo *Repository) ComposeMetas() map[string]string {
  292. if !repo.EnableExternalTracker {
  293. return nil
  294. } else if repo.ExternalMetas == nil {
  295. repo.ExternalMetas = map[string]string{
  296. "format": repo.ExternalTrackerFormat,
  297. "user": repo.MustOwner().Name,
  298. "repo": repo.Name,
  299. }
  300. switch repo.ExternalTrackerStyle {
  301. case markdown.ISSUE_NAME_STYLE_ALPHANUMERIC:
  302. repo.ExternalMetas["style"] = markdown.ISSUE_NAME_STYLE_ALPHANUMERIC
  303. default:
  304. repo.ExternalMetas["style"] = markdown.ISSUE_NAME_STYLE_NUMERIC
  305. }
  306. }
  307. return repo.ExternalMetas
  308. }
  309. // DeleteWiki removes the actual and local copy of repository wiki.
  310. func (repo *Repository) DeleteWiki() {
  311. wikiPaths := []string{repo.WikiPath(), repo.LocalWikiPath()}
  312. for _, wikiPath := range wikiPaths {
  313. RemoveAllWithNotice("Delete repository wiki", wikiPath)
  314. }
  315. }
  316. // getUsersWithAccesMode returns users that have at least given access mode to the repository.
  317. func (repo *Repository) getUsersWithAccesMode(e Engine, mode AccessMode) (_ []*User, err error) {
  318. if err = repo.getOwner(e); err != nil {
  319. return nil, err
  320. }
  321. accesses := make([]*Access, 0, 10)
  322. if err = e.Where("repo_id = ? AND mode >= ?", repo.ID, mode).Find(&accesses); err != nil {
  323. return nil, err
  324. }
  325. // Leave a seat for owner itself to append later, but if owner is an organization
  326. // and just waste 1 unit is cheaper than re-allocate memory once.
  327. users := make([]*User, 0, len(accesses)+1)
  328. if len(accesses) > 0 {
  329. userIDs := make([]int64, len(accesses))
  330. for i := 0; i < len(accesses); i++ {
  331. userIDs[i] = accesses[i].UserID
  332. }
  333. if err = e.In("id", userIDs).Find(&users); err != nil {
  334. return nil, err
  335. }
  336. }
  337. if !repo.Owner.IsOrganization() {
  338. users = append(users, repo.Owner)
  339. }
  340. return users, nil
  341. }
  342. // getAssignees returns a list of users who can be assigned to issues in this repository.
  343. func (repo *Repository) getAssignees(e Engine) (_ []*User, err error) {
  344. return repo.getUsersWithAccesMode(e, ACCESS_MODE_READ)
  345. }
  346. // GetAssignees returns all users that have read access and can be assigned to issues
  347. // of the repository,
  348. func (repo *Repository) GetAssignees() (_ []*User, err error) {
  349. return repo.getAssignees(x)
  350. }
  351. // GetAssigneeByID returns the user that has write access of repository by given ID.
  352. func (repo *Repository) GetAssigneeByID(userID int64) (*User, error) {
  353. return GetAssigneeByID(repo, userID)
  354. }
  355. // GetWriters returns all users that have write access to the repository.
  356. func (repo *Repository) GetWriters() (_ []*User, err error) {
  357. return repo.getUsersWithAccesMode(x, ACCESS_MODE_WRITE)
  358. }
  359. // GetMilestoneByID returns the milestone belongs to repository by given ID.
  360. func (repo *Repository) GetMilestoneByID(milestoneID int64) (*Milestone, error) {
  361. return GetMilestoneByRepoID(repo.ID, milestoneID)
  362. }
  363. // IssueStats returns number of open and closed repository issues by given filter mode.
  364. func (repo *Repository) IssueStats(userID int64, filterMode FilterMode, isPull bool) (int64, int64) {
  365. return GetRepoIssueStats(repo.ID, userID, filterMode, isPull)
  366. }
  367. func (repo *Repository) GetMirror() (err error) {
  368. repo.Mirror, err = GetMirrorByRepoID(repo.ID)
  369. return err
  370. }
  371. func (repo *Repository) repoPath(e Engine) string {
  372. return RepoPath(repo.mustOwner(e).Name, repo.Name)
  373. }
  374. func (repo *Repository) RepoPath() string {
  375. return repo.repoPath(x)
  376. }
  377. func (repo *Repository) GitConfigPath() string {
  378. return filepath.Join(repo.RepoPath(), "config")
  379. }
  380. func (repo *Repository) RelLink() string {
  381. return "/" + repo.FullName()
  382. }
  383. func (repo *Repository) Link() string {
  384. return setting.AppSubUrl + "/" + repo.FullName()
  385. }
  386. func (repo *Repository) ComposeCompareURL(oldCommitID, newCommitID string) string {
  387. return fmt.Sprintf("%s/%s/compare/%s...%s", repo.MustOwner().Name, repo.Name, oldCommitID, newCommitID)
  388. }
  389. func (repo *Repository) HasAccess(userID int64) bool {
  390. has, _ := HasAccess(userID, repo, ACCESS_MODE_READ)
  391. return has
  392. }
  393. func (repo *Repository) IsOwnedBy(userID int64) bool {
  394. return repo.OwnerID == userID
  395. }
  396. // CanBeForked returns true if repository meets the requirements of being forked.
  397. func (repo *Repository) CanBeForked() bool {
  398. return !repo.IsBare
  399. }
  400. // CanEnablePulls returns true if repository meets the requirements of accepting pulls.
  401. func (repo *Repository) CanEnablePulls() bool {
  402. return !repo.IsMirror && !repo.IsBare
  403. }
  404. // AllowPulls returns true if repository meets the requirements of accepting pulls and has them enabled.
  405. func (repo *Repository) AllowsPulls() bool {
  406. return repo.CanEnablePulls() && repo.EnablePulls
  407. }
  408. func (repo *Repository) IsBranchRequirePullRequest(name string) bool {
  409. return IsBranchOfRepoRequirePullRequest(repo.ID, name)
  410. }
  411. // CanEnableEditor returns true if repository meets the requirements of web editor.
  412. func (repo *Repository) CanEnableEditor() bool {
  413. return !repo.IsMirror
  414. }
  415. // FIXME: should have a mutex to prevent producing same index for two issues that are created
  416. // closely enough.
  417. func (repo *Repository) NextIssueIndex() int64 {
  418. return int64(repo.NumIssues+repo.NumPulls) + 1
  419. }
  420. func (repo *Repository) LocalCopyPath() string {
  421. return path.Join(setting.AppDataPath, "tmp/local-repo", com.ToStr(repo.ID))
  422. }
  423. // UpdateLocalCopy fetches latest changes of given branch from repoPath to localPath.
  424. // It creates a new clone if local copy does not exist, but does not checks out to a
  425. // specific branch if the local copy belongs to a wiki.
  426. // For existing local copy, it checks out to target branch by default, and safe to
  427. // assume subsequent operations are against target branch when caller has confidence
  428. // about no race condition.
  429. func UpdateLocalCopyBranch(repoPath, localPath, branch string, isWiki bool) (err error) {
  430. if !com.IsExist(localPath) {
  431. // Checkout to a specific branch fails when wiki is an empty repository.
  432. if isWiki {
  433. branch = ""
  434. }
  435. if err = git.Clone(repoPath, localPath, git.CloneRepoOptions{
  436. Timeout: time.Duration(setting.Git.Timeout.Clone) * time.Second,
  437. Branch: branch,
  438. }); err != nil {
  439. return fmt.Errorf("git clone %s: %v", branch, err)
  440. }
  441. } else {
  442. if err = git.Fetch(localPath, git.FetchRemoteOptions{
  443. Prune: true,
  444. }); err != nil {
  445. return fmt.Errorf("git fetch: %v", err)
  446. }
  447. if err = git.Checkout(localPath, git.CheckoutOptions{
  448. Branch: branch,
  449. }); err != nil {
  450. return fmt.Errorf("git checkout %s: %v", branch, err)
  451. }
  452. // Reset to align with remote in case of force push.
  453. if err = git.ResetHEAD(localPath, true, "origin/"+branch); err != nil {
  454. return fmt.Errorf("git reset --hard origin/%s: %v", branch, err)
  455. }
  456. }
  457. return nil
  458. }
  459. // UpdateLocalCopyBranch makes sure local copy of repository in given branch is up-to-date.
  460. func (repo *Repository) UpdateLocalCopyBranch(branch string) error {
  461. return UpdateLocalCopyBranch(repo.RepoPath(), repo.LocalCopyPath(), branch, false)
  462. }
  463. // PatchPath returns corresponding patch file path of repository by given issue ID.
  464. func (repo *Repository) PatchPath(index int64) (string, error) {
  465. if err := repo.GetOwner(); err != nil {
  466. return "", err
  467. }
  468. return filepath.Join(RepoPath(repo.Owner.Name, repo.Name), "pulls", com.ToStr(index)+".patch"), nil
  469. }
  470. // SavePatch saves patch data to corresponding location by given issue ID.
  471. func (repo *Repository) SavePatch(index int64, patch []byte) error {
  472. patchPath, err := repo.PatchPath(index)
  473. if err != nil {
  474. return fmt.Errorf("PatchPath: %v", err)
  475. }
  476. os.MkdirAll(filepath.Dir(patchPath), os.ModePerm)
  477. if err = ioutil.WriteFile(patchPath, patch, 0644); err != nil {
  478. return fmt.Errorf("WriteFile: %v", err)
  479. }
  480. return nil
  481. }
  482. func isRepositoryExist(e Engine, u *User, repoName string) (bool, error) {
  483. has, err := e.Get(&Repository{
  484. OwnerID: u.ID,
  485. LowerName: strings.ToLower(repoName),
  486. })
  487. return has && com.IsDir(RepoPath(u.Name, repoName)), err
  488. }
  489. // IsRepositoryExist returns true if the repository with given name under user has already existed.
  490. func IsRepositoryExist(u *User, repoName string) (bool, error) {
  491. return isRepositoryExist(x, u, repoName)
  492. }
  493. // CloneLink represents different types of clone URLs of repository.
  494. type CloneLink struct {
  495. SSH string
  496. HTTPS string
  497. Git string
  498. }
  499. // ComposeHTTPSCloneURL returns HTTPS clone URL based on given owner and repository name.
  500. func ComposeHTTPSCloneURL(owner, repo string) string {
  501. return fmt.Sprintf("%s%s/%s.git", setting.AppUrl, owner, repo)
  502. }
  503. func (repo *Repository) cloneLink(isWiki bool) *CloneLink {
  504. repoName := repo.Name
  505. if isWiki {
  506. repoName += ".wiki"
  507. }
  508. repo.Owner = repo.MustOwner()
  509. cl := new(CloneLink)
  510. if setting.SSH.Port != 22 {
  511. cl.SSH = fmt.Sprintf("ssh://%s@%s:%d/%s/%s.git", setting.RunUser, setting.SSH.Domain, setting.SSH.Port, repo.Owner.Name, repoName)
  512. } else {
  513. cl.SSH = fmt.Sprintf("%s@%s:%s/%s.git", setting.RunUser, setting.SSH.Domain, repo.Owner.Name, repoName)
  514. }
  515. cl.HTTPS = ComposeHTTPSCloneURL(repo.Owner.Name, repoName)
  516. return cl
  517. }
  518. // CloneLink returns clone URLs of repository.
  519. func (repo *Repository) CloneLink() (cl *CloneLink) {
  520. return repo.cloneLink(false)
  521. }
  522. type MigrateRepoOptions struct {
  523. Name string
  524. Description string
  525. IsPrivate bool
  526. IsMirror bool
  527. RemoteAddr string
  528. }
  529. /*
  530. GitHub, GitLab, Gogs: *.wiki.git
  531. BitBucket: *.git/wiki
  532. */
  533. var commonWikiURLSuffixes = []string{".wiki.git", ".git/wiki"}
  534. // wikiRemoteURL returns accessible repository URL for wiki if exists.
  535. // Otherwise, it returns an empty string.
  536. func wikiRemoteURL(remote string) string {
  537. remote = strings.TrimSuffix(remote, ".git")
  538. for _, suffix := range commonWikiURLSuffixes {
  539. wikiURL := remote + suffix
  540. if git.IsRepoURLAccessible(git.NetworkOptions{
  541. URL: wikiURL,
  542. }) {
  543. return wikiURL
  544. }
  545. }
  546. return ""
  547. }
  548. // MigrateRepository migrates a existing repository from other project hosting.
  549. func MigrateRepository(doer, owner *User, opts MigrateRepoOptions) (*Repository, error) {
  550. repo, err := CreateRepository(doer, owner, CreateRepoOptions{
  551. Name: opts.Name,
  552. Description: opts.Description,
  553. IsPrivate: opts.IsPrivate,
  554. IsMirror: opts.IsMirror,
  555. })
  556. if err != nil {
  557. return nil, err
  558. }
  559. repoPath := RepoPath(owner.Name, opts.Name)
  560. wikiPath := WikiPath(owner.Name, opts.Name)
  561. if owner.IsOrganization() {
  562. t, err := owner.GetOwnerTeam()
  563. if err != nil {
  564. return nil, err
  565. }
  566. repo.NumWatches = t.NumMembers
  567. } else {
  568. repo.NumWatches = 1
  569. }
  570. migrateTimeout := time.Duration(setting.Git.Timeout.Migrate) * time.Second
  571. RemoveAllWithNotice("Repository path erase before creation", repoPath)
  572. if err = git.Clone(opts.RemoteAddr, repoPath, git.CloneRepoOptions{
  573. Mirror: true,
  574. Quiet: true,
  575. Timeout: migrateTimeout,
  576. }); err != nil {
  577. return repo, fmt.Errorf("Clone: %v", err)
  578. }
  579. wikiRemotePath := wikiRemoteURL(opts.RemoteAddr)
  580. if len(wikiRemotePath) > 0 {
  581. RemoveAllWithNotice("Repository wiki path erase before creation", wikiPath)
  582. if err = git.Clone(wikiRemotePath, wikiPath, git.CloneRepoOptions{
  583. Mirror: true,
  584. Quiet: true,
  585. Timeout: migrateTimeout,
  586. }); err != nil {
  587. log.Trace("Fail to clone wiki: %v", err)
  588. RemoveAllWithNotice("Delete repository wiki for initialization failure", wikiPath)
  589. }
  590. }
  591. // Check if repository is empty.
  592. _, stderr, err := com.ExecCmdDir(repoPath, "git", "log", "-1")
  593. if err != nil {
  594. if strings.Contains(stderr, "fatal: bad default revision 'HEAD'") {
  595. repo.IsBare = true
  596. } else {
  597. return repo, fmt.Errorf("check bare: %v - %s", err, stderr)
  598. }
  599. }
  600. if !repo.IsBare {
  601. // Try to get HEAD branch and set it as default branch.
  602. gitRepo, err := git.OpenRepository(repoPath)
  603. if err != nil {
  604. return repo, fmt.Errorf("OpenRepository: %v", err)
  605. }
  606. headBranch, err := gitRepo.GetHEADBranch()
  607. if err != nil {
  608. return repo, fmt.Errorf("GetHEADBranch: %v", err)
  609. }
  610. if headBranch != nil {
  611. repo.DefaultBranch = headBranch.Name
  612. }
  613. if err = repo.UpdateSize(); err != nil {
  614. log.Error(2, "UpdateSize [repo_id: %d]: %v", repo.ID, err)
  615. }
  616. }
  617. if opts.IsMirror {
  618. if _, err = x.InsertOne(&Mirror{
  619. RepoID: repo.ID,
  620. Interval: setting.Mirror.DefaultInterval,
  621. EnablePrune: true,
  622. NextUpdate: time.Now().Add(time.Duration(setting.Mirror.DefaultInterval) * time.Hour),
  623. }); err != nil {
  624. return repo, fmt.Errorf("InsertOne: %v", err)
  625. }
  626. repo.IsMirror = true
  627. return repo, UpdateRepository(repo, false)
  628. }
  629. return CleanUpMigrateInfo(repo)
  630. }
  631. // cleanUpMigrateGitConfig removes mirror info which prevents "push --all".
  632. // This also removes possible user credentials.
  633. func cleanUpMigrateGitConfig(configPath string) error {
  634. cfg, err := ini.Load(configPath)
  635. if err != nil {
  636. return fmt.Errorf("open config file: %v", err)
  637. }
  638. cfg.DeleteSection("remote \"origin\"")
  639. if err = cfg.SaveToIndent(configPath, "\t"); err != nil {
  640. return fmt.Errorf("save config file: %v", err)
  641. }
  642. return nil
  643. }
  644. var hooksTpls = map[string]string{
  645. "pre-receive": "#!/usr/bin/env %s\n\"%s\" hook --config='%s' pre-receive\n",
  646. "update": "#!/usr/bin/env %s\n\"%s\" hook --config='%s' update $1 $2 $3\n",
  647. "post-receive": "#!/usr/bin/env %s\n\"%s\" hook --config='%s' post-receive\n",
  648. }
  649. func createDelegateHooks(repoPath string) (err error) {
  650. for _, name := range git.HookNames {
  651. hookPath := filepath.Join(repoPath, "hooks", name)
  652. if err = ioutil.WriteFile(hookPath,
  653. []byte(fmt.Sprintf(hooksTpls[name], setting.ScriptType, setting.AppPath, setting.CustomConf)),
  654. os.ModePerm); err != nil {
  655. return fmt.Errorf("create delegate hook '%s': %v", hookPath, err)
  656. }
  657. }
  658. return nil
  659. }
  660. // Finish migrating repository and/or wiki with things that don't need to be done for mirrors.
  661. func CleanUpMigrateInfo(repo *Repository) (*Repository, error) {
  662. repoPath := repo.RepoPath()
  663. if err := createDelegateHooks(repoPath); err != nil {
  664. return repo, fmt.Errorf("createDelegateHooks: %v", err)
  665. }
  666. if repo.HasWiki() {
  667. if err := createDelegateHooks(repo.WikiPath()); err != nil {
  668. return repo, fmt.Errorf("createDelegateHooks.(wiki): %v", err)
  669. }
  670. }
  671. if err := cleanUpMigrateGitConfig(repo.GitConfigPath()); err != nil {
  672. return repo, fmt.Errorf("cleanUpMigrateGitConfig: %v", err)
  673. }
  674. if repo.HasWiki() {
  675. if err := cleanUpMigrateGitConfig(path.Join(repo.WikiPath(), "config")); err != nil {
  676. return repo, fmt.Errorf("cleanUpMigrateGitConfig.(wiki): %v", err)
  677. }
  678. }
  679. return repo, UpdateRepository(repo, false)
  680. }
  681. // initRepoCommit temporarily changes with work directory.
  682. func initRepoCommit(tmpPath string, sig *git.Signature) (err error) {
  683. var stderr string
  684. if _, stderr, err = process.ExecDir(-1,
  685. tmpPath, fmt.Sprintf("initRepoCommit (git add): %s", tmpPath),
  686. "git", "add", "--all"); err != nil {
  687. return fmt.Errorf("git add: %s", stderr)
  688. }
  689. if _, stderr, err = process.ExecDir(-1,
  690. tmpPath, fmt.Sprintf("initRepoCommit (git commit): %s", tmpPath),
  691. "git", "commit", fmt.Sprintf("--author='%s <%s>'", sig.Name, sig.Email),
  692. "-m", "Initial commit"); err != nil {
  693. return fmt.Errorf("git commit: %s", stderr)
  694. }
  695. if _, stderr, err = process.ExecDir(-1,
  696. tmpPath, fmt.Sprintf("initRepoCommit (git push): %s", tmpPath),
  697. "git", "push", "origin", "master"); err != nil {
  698. return fmt.Errorf("git push: %s", stderr)
  699. }
  700. return nil
  701. }
  702. type CreateRepoOptions struct {
  703. Name string
  704. Description string
  705. Gitignores string
  706. License string
  707. Readme string
  708. IsPrivate bool
  709. IsMirror bool
  710. AutoInit bool
  711. }
  712. func getRepoInitFile(tp, name string) ([]byte, error) {
  713. relPath := path.Join("conf", tp, strings.TrimLeft(name, "./"))
  714. // Use custom file when available.
  715. customPath := path.Join(setting.CustomPath, relPath)
  716. if com.IsFile(customPath) {
  717. return ioutil.ReadFile(customPath)
  718. }
  719. return bindata.Asset(relPath)
  720. }
  721. func prepareRepoCommit(repo *Repository, tmpDir, repoPath string, opts CreateRepoOptions) error {
  722. // Clone to temprory path and do the init commit.
  723. _, stderr, err := process.Exec(
  724. fmt.Sprintf("initRepository(git clone): %s", repoPath), "git", "clone", repoPath, tmpDir)
  725. if err != nil {
  726. return fmt.Errorf("git clone: %v - %s", err, stderr)
  727. }
  728. // README
  729. data, err := getRepoInitFile("readme", opts.Readme)
  730. if err != nil {
  731. return fmt.Errorf("getRepoInitFile[%s]: %v", opts.Readme, err)
  732. }
  733. cloneLink := repo.CloneLink()
  734. match := map[string]string{
  735. "Name": repo.Name,
  736. "Description": repo.Description,
  737. "CloneURL.SSH": cloneLink.SSH,
  738. "CloneURL.HTTPS": cloneLink.HTTPS,
  739. }
  740. if err = ioutil.WriteFile(filepath.Join(tmpDir, "README.md"),
  741. []byte(com.Expand(string(data), match)), 0644); err != nil {
  742. return fmt.Errorf("write README.md: %v", err)
  743. }
  744. // .gitignore
  745. if len(opts.Gitignores) > 0 {
  746. var buf bytes.Buffer
  747. names := strings.Split(opts.Gitignores, ",")
  748. for _, name := range names {
  749. data, err = getRepoInitFile("gitignore", name)
  750. if err != nil {
  751. return fmt.Errorf("getRepoInitFile[%s]: %v", name, err)
  752. }
  753. buf.WriteString("# ---> " + name + "\n")
  754. buf.Write(data)
  755. buf.WriteString("\n")
  756. }
  757. if buf.Len() > 0 {
  758. if err = ioutil.WriteFile(filepath.Join(tmpDir, ".gitignore"), buf.Bytes(), 0644); err != nil {
  759. return fmt.Errorf("write .gitignore: %v", err)
  760. }
  761. }
  762. }
  763. // LICENSE
  764. if len(opts.License) > 0 {
  765. data, err = getRepoInitFile("license", opts.License)
  766. if err != nil {
  767. return fmt.Errorf("getRepoInitFile[%s]: %v", opts.License, err)
  768. }
  769. if err = ioutil.WriteFile(filepath.Join(tmpDir, "LICENSE"), data, 0644); err != nil {
  770. return fmt.Errorf("write LICENSE: %v", err)
  771. }
  772. }
  773. return nil
  774. }
  775. // initRepository performs initial commit with chosen setup files on behave of doer.
  776. func initRepository(e Engine, repoPath string, doer *User, repo *Repository, opts CreateRepoOptions) (err error) {
  777. // Somehow the directory could exist.
  778. if com.IsExist(repoPath) {
  779. return fmt.Errorf("initRepository: path already exists: %s", repoPath)
  780. }
  781. // Init bare new repository.
  782. if err = git.InitRepository(repoPath, true); err != nil {
  783. return fmt.Errorf("InitRepository: %v", err)
  784. } else if err = createDelegateHooks(repoPath); err != nil {
  785. return fmt.Errorf("createDelegateHooks: %v", err)
  786. }
  787. tmpDir := filepath.Join(os.TempDir(), "gogs-"+repo.Name+"-"+com.ToStr(time.Now().Nanosecond()))
  788. // Initialize repository according to user's choice.
  789. if opts.AutoInit {
  790. os.MkdirAll(tmpDir, os.ModePerm)
  791. defer RemoveAllWithNotice("Delete repository for auto-initialization", tmpDir)
  792. if err = prepareRepoCommit(repo, tmpDir, repoPath, opts); err != nil {
  793. return fmt.Errorf("prepareRepoCommit: %v", err)
  794. }
  795. // Apply changes and commit.
  796. if err = initRepoCommit(tmpDir, doer.NewGitSig()); err != nil {
  797. return fmt.Errorf("initRepoCommit: %v", err)
  798. }
  799. }
  800. // Re-fetch the repository from database before updating it (else it would
  801. // override changes that were done earlier with sql)
  802. if repo, err = getRepositoryByID(e, repo.ID); err != nil {
  803. return fmt.Errorf("getRepositoryByID: %v", err)
  804. }
  805. if !opts.AutoInit {
  806. repo.IsBare = true
  807. }
  808. repo.DefaultBranch = "master"
  809. if err = updateRepository(e, repo, false); err != nil {
  810. return fmt.Errorf("updateRepository: %v", err)
  811. }
  812. return nil
  813. }
  814. var (
  815. reservedRepoNames = []string{".", ".."}
  816. reservedRepoPatterns = []string{"*.git", "*.wiki"}
  817. )
  818. // IsUsableRepoName return an error if given name is a reserved name or pattern.
  819. func IsUsableRepoName(name string) error {
  820. return isUsableName(reservedRepoNames, reservedRepoPatterns, name)
  821. }
  822. func createRepository(e *xorm.Session, doer, owner *User, repo *Repository) (err error) {
  823. if err = IsUsableRepoName(repo.Name); err != nil {
  824. return err
  825. }
  826. has, err := isRepositoryExist(e, owner, repo.Name)
  827. if err != nil {
  828. return fmt.Errorf("IsRepositoryExist: %v", err)
  829. } else if has {
  830. return ErrRepoAlreadyExist{owner.Name, repo.Name}
  831. }
  832. if _, err = e.Insert(repo); err != nil {
  833. return err
  834. }
  835. owner.NumRepos++
  836. // Remember visibility preference.
  837. owner.LastRepoVisibility = repo.IsPrivate
  838. if err = updateUser(e, owner); err != nil {
  839. return fmt.Errorf("updateUser: %v", err)
  840. }
  841. // Give access to all members in owner team.
  842. if owner.IsOrganization() {
  843. t, err := owner.getOwnerTeam(e)
  844. if err != nil {
  845. return fmt.Errorf("getOwnerTeam: %v", err)
  846. } else if err = t.addRepository(e, repo); err != nil {
  847. return fmt.Errorf("addRepository: %v", err)
  848. }
  849. } else {
  850. // Organization automatically called this in addRepository method.
  851. if err = repo.recalculateAccesses(e); err != nil {
  852. return fmt.Errorf("recalculateAccesses: %v", err)
  853. }
  854. }
  855. if err = watchRepo(e, owner.ID, repo.ID, true); err != nil {
  856. return fmt.Errorf("watchRepo: %v", err)
  857. } else if err = newRepoAction(e, doer, owner, repo); err != nil {
  858. return fmt.Errorf("newRepoAction: %v", err)
  859. }
  860. return nil
  861. }
  862. // CreateRepository creates a repository for given user or organization.
  863. func CreateRepository(doer, owner *User, opts CreateRepoOptions) (_ *Repository, err error) {
  864. if !owner.CanCreateRepo() {
  865. return nil, ErrReachLimitOfRepo{owner.MaxRepoCreation}
  866. }
  867. repo := &Repository{
  868. OwnerID: owner.ID,
  869. Owner: owner,
  870. Name: opts.Name,
  871. LowerName: strings.ToLower(opts.Name),
  872. Description: opts.Description,
  873. IsPrivate: opts.IsPrivate,
  874. EnableWiki: true,
  875. EnableIssues: true,
  876. EnablePulls: true,
  877. }
  878. sess := x.NewSession()
  879. defer sessionRelease(sess)
  880. if err = sess.Begin(); err != nil {
  881. return nil, err
  882. }
  883. if err = createRepository(sess, doer, owner, repo); err != nil {
  884. return nil, err
  885. }
  886. // No need for init mirror.
  887. if !opts.IsMirror {
  888. repoPath := RepoPath(owner.Name, repo.Name)
  889. if err = initRepository(sess, repoPath, doer, repo, opts); err != nil {
  890. RemoveAllWithNotice("Delete repository for initialization failure", repoPath)
  891. return nil, fmt.Errorf("initRepository: %v", err)
  892. }
  893. _, stderr, err := process.ExecDir(-1,
  894. repoPath, fmt.Sprintf("CreateRepository 'git update-server-info': %s", repoPath),
  895. "git", "update-server-info")
  896. if err != nil {
  897. return nil, fmt.Errorf("CreateRepository 'git update-server-info': %s", stderr)
  898. }
  899. }
  900. return repo, sess.Commit()
  901. }
  902. func countRepositories(userID int64, private bool) int64 {
  903. sess := x.Where("id > 0")
  904. if userID > 0 {
  905. sess.And("owner_id = ?", userID)
  906. }
  907. if !private {
  908. sess.And("is_private=?", false)
  909. }
  910. count, err := sess.Count(new(Repository))
  911. if err != nil {
  912. log.Error(4, "countRepositories: %v", err)
  913. }
  914. return count
  915. }
  916. // CountRepositories returns number of repositories.
  917. // Argument private only takes effect when it is false,
  918. // set it true to count all repositories.
  919. func CountRepositories(private bool) int64 {
  920. return countRepositories(-1, private)
  921. }
  922. // CountUserRepositories returns number of repositories user owns.
  923. // Argument private only takes effect when it is false,
  924. // set it true to count all repositories.
  925. func CountUserRepositories(userID int64, private bool) int64 {
  926. return countRepositories(userID, private)
  927. }
  928. func Repositories(page, pageSize int) (_ []*Repository, err error) {
  929. repos := make([]*Repository, 0, pageSize)
  930. return repos, x.Limit(pageSize, (page-1)*pageSize).Asc("id").Find(&repos)
  931. }
  932. // RepositoriesWithUsers returns number of repos in given page.
  933. func RepositoriesWithUsers(page, pageSize int) (_ []*Repository, err error) {
  934. repos, err := Repositories(page, pageSize)
  935. if err != nil {
  936. return nil, fmt.Errorf("Repositories: %v", err)
  937. }
  938. for i := range repos {
  939. if err = repos[i].GetOwner(); err != nil {
  940. return nil, err
  941. }
  942. }
  943. return repos, nil
  944. }
  945. // FilterRepositoryWithIssues selects repositories that are using interal issue tracker
  946. // and has disabled external tracker from given set.
  947. // It returns nil if result set is empty.
  948. func FilterRepositoryWithIssues(repoIDs []int64) ([]int64, error) {
  949. if len(repoIDs) == 0 {
  950. return nil, nil
  951. }
  952. repos := make([]*Repository, 0, len(repoIDs))
  953. if err := x.Where("enable_issues=?", true).
  954. And("enable_external_tracker=?", false).
  955. In("id", repoIDs).
  956. Cols("id").
  957. Find(&repos); err != nil {
  958. return nil, fmt.Errorf("filter valid repositories %v: %v", repoIDs, err)
  959. }
  960. if len(repos) == 0 {
  961. return nil, nil
  962. }
  963. repoIDs = make([]int64, len(repos))
  964. for i := range repos {
  965. repoIDs[i] = repos[i].ID
  966. }
  967. return repoIDs, nil
  968. }
  969. // RepoPath returns repository path by given user and repository name.
  970. func RepoPath(userName, repoName string) string {
  971. return filepath.Join(UserPath(userName), strings.ToLower(repoName)+".git")
  972. }
  973. // TransferOwnership transfers all corresponding setting from old user to new one.
  974. func TransferOwnership(doer *User, newOwnerName string, repo *Repository) error {
  975. newOwner, err := GetUserByName(newOwnerName)
  976. if err != nil {
  977. return fmt.Errorf("get new owner '%s': %v", newOwnerName, err)
  978. }
  979. // Check if new owner has repository with same name.
  980. has, err := IsRepositoryExist(newOwner, repo.Name)
  981. if err != nil {
  982. return fmt.Errorf("IsRepositoryExist: %v", err)
  983. } else if has {
  984. return ErrRepoAlreadyExist{newOwnerName, repo.Name}
  985. }
  986. sess := x.NewSession()
  987. defer sessionRelease(sess)
  988. if err = sess.Begin(); err != nil {
  989. return fmt.Errorf("sess.Begin: %v", err)
  990. }
  991. owner := repo.Owner
  992. // Note: we have to set value here to make sure recalculate accesses is based on
  993. // new owner.
  994. repo.OwnerID = newOwner.ID
  995. repo.Owner = newOwner
  996. // Update repository.
  997. if _, err := sess.Id(repo.ID).Update(repo); err != nil {
  998. return fmt.Errorf("update owner: %v", err)
  999. }
  1000. // Remove redundant collaborators.
  1001. collaborators, err := repo.getCollaborators(sess)
  1002. if err != nil {
  1003. return fmt.Errorf("getCollaborators: %v", err)
  1004. }
  1005. // Dummy object.
  1006. collaboration := &Collaboration{RepoID: repo.ID}
  1007. for _, c := range collaborators {
  1008. collaboration.UserID = c.ID
  1009. if c.ID == newOwner.ID || newOwner.IsOrgMember(c.ID) {
  1010. if _, err = sess.Delete(collaboration); err != nil {
  1011. return fmt.Errorf("remove collaborator '%d': %v", c.ID, err)
  1012. }
  1013. }
  1014. }
  1015. // Remove old team-repository relations.
  1016. if owner.IsOrganization() {
  1017. if err = owner.getTeams(sess); err != nil {
  1018. return fmt.Errorf("getTeams: %v", err)
  1019. }
  1020. for _, t := range owner.Teams {
  1021. if !t.hasRepository(sess, repo.ID) {
  1022. continue
  1023. }
  1024. t.NumRepos--
  1025. if _, err := sess.Id(t.ID).AllCols().Update(t); err != nil {
  1026. return fmt.Errorf("decrease team repository count '%d': %v", t.ID, err)
  1027. }
  1028. }
  1029. if err = owner.removeOrgRepo(sess, repo.ID); err != nil {
  1030. return fmt.Errorf("removeOrgRepo: %v", err)
  1031. }
  1032. }
  1033. if newOwner.IsOrganization() {
  1034. t, err := newOwner.getOwnerTeam(sess)
  1035. if err != nil {
  1036. return fmt.Errorf("getOwnerTeam: %v", err)
  1037. } else if err = t.addRepository(sess, repo); err != nil {
  1038. return fmt.Errorf("add to owner team: %v", err)
  1039. }
  1040. } else {
  1041. // Organization called this in addRepository method.
  1042. if err = repo.recalculateAccesses(sess); err != nil {
  1043. return fmt.Errorf("recalculateAccesses: %v", err)
  1044. }
  1045. }
  1046. // Update repository count.
  1047. if _, err = sess.Exec("UPDATE `user` SET num_repos=num_repos+1 WHERE id=?", newOwner.ID); err != nil {
  1048. return fmt.Errorf("increase new owner repository count: %v", err)
  1049. } else if _, err = sess.Exec("UPDATE `user` SET num_repos=num_repos-1 WHERE id=?", owner.ID); err != nil {
  1050. return fmt.Errorf("decrease old owner repository count: %v", err)
  1051. }
  1052. if err = watchRepo(sess, newOwner.ID, repo.ID, true); err != nil {
  1053. return fmt.Errorf("watchRepo: %v", err)
  1054. } else if err = transferRepoAction(sess, doer, owner, repo); err != nil {
  1055. return fmt.Errorf("transferRepoAction: %v", err)
  1056. }
  1057. // Rename remote repository to new path and delete local copy.
  1058. os.MkdirAll(UserPath(newOwner.Name), os.ModePerm)
  1059. if err = os.Rename(RepoPath(owner.Name, repo.Name), RepoPath(newOwner.Name, repo.Name)); err != nil {
  1060. return fmt.Errorf("rename repository directory: %v", err)
  1061. }
  1062. RemoveAllWithNotice("Delete repository local copy", repo.LocalCopyPath())
  1063. // Rename remote wiki repository to new path and delete local copy.
  1064. wikiPath := WikiPath(owner.Name, repo.Name)
  1065. if com.IsExist(wikiPath) {
  1066. RemoveAllWithNotice("Delete repository wiki local copy", repo.LocalWikiPath())
  1067. if err = os.Rename(wikiPath, WikiPath(newOwner.Name, repo.Name)); err != nil {
  1068. return fmt.Errorf("rename repository wiki: %v", err)
  1069. }
  1070. }
  1071. return sess.Commit()
  1072. }
  1073. // ChangeRepositoryName changes all corresponding setting from old repository name to new one.
  1074. func ChangeRepositoryName(u *User, oldRepoName, newRepoName string) (err error) {
  1075. oldRepoName = strings.ToLower(oldRepoName)
  1076. newRepoName = strings.ToLower(newRepoName)
  1077. if err = IsUsableRepoName(newRepoName); err != nil {
  1078. return err
  1079. }
  1080. has, err := IsRepositoryExist(u, newRepoName)
  1081. if err != nil {
  1082. return fmt.Errorf("IsRepositoryExist: %v", err)
  1083. } else if has {
  1084. return ErrRepoAlreadyExist{u.Name, newRepoName}
  1085. }
  1086. repo, err := GetRepositoryByName(u.ID, oldRepoName)
  1087. if err != nil {
  1088. return fmt.Errorf("GetRepositoryByName: %v", err)
  1089. }
  1090. // Change repository directory name
  1091. if err = os.Rename(repo.RepoPath(), RepoPath(u.Name, newRepoName)); err != nil {
  1092. return fmt.Errorf("rename repository directory: %v", err)
  1093. }
  1094. wikiPath := repo.WikiPath()
  1095. if com.IsExist(wikiPath) {
  1096. if err = os.Rename(wikiPath, WikiPath(u.Name, newRepoName)); err != nil {
  1097. return fmt.Errorf("rename repository wiki: %v", err)
  1098. }
  1099. RemoveAllWithNotice("Delete repository wiki local copy", repo.LocalWikiPath())
  1100. }
  1101. RemoveAllWithNotice("Delete repository local copy", repo.LocalCopyPath())
  1102. return nil
  1103. }
  1104. func getRepositoriesByForkID(e Engine, forkID int64) ([]*Repository, error) {
  1105. repos := make([]*Repository, 0, 10)
  1106. return repos, e.Where("fork_id=?", forkID).Find(&repos)
  1107. }
  1108. // GetRepositoriesByForkID returns all repositories with given fork ID.
  1109. func GetRepositoriesByForkID(forkID int64) ([]*Repository, error) {
  1110. return getRepositoriesByForkID(x, forkID)
  1111. }
  1112. func updateRepository(e Engine, repo *Repository, visibilityChanged bool) (err error) {
  1113. repo.LowerName = strings.ToLower(repo.Name)
  1114. if len(repo.Description) > 255 {
  1115. repo.Description = repo.Description[:255]
  1116. }
  1117. if len(repo.Website) > 255 {
  1118. repo.Website = repo.Website[:255]
  1119. }
  1120. if _, err = e.Id(repo.ID).AllCols().Update(repo); err != nil {
  1121. return fmt.Errorf("update: %v", err)
  1122. }
  1123. if visibilityChanged {
  1124. if err = repo.getOwner(e); err != nil {
  1125. return fmt.Errorf("getOwner: %v", err)
  1126. }
  1127. if repo.Owner.IsOrganization() {
  1128. // Organization repository need to recalculate access table when visivility is changed.
  1129. if err = repo.recalculateTeamAccesses(e, 0); err != nil {
  1130. return fmt.Errorf("recalculateTeamAccesses: %v", err)
  1131. }
  1132. }
  1133. // Create/Remove git-daemon-export-ok for git-daemon...
  1134. daemonExportFile := path.Join(repo.RepoPath(), `git-daemon-export-ok`)
  1135. if repo.IsPrivate && com.IsExist(daemonExportFile) {
  1136. if err = os.Remove(daemonExportFile); err != nil {
  1137. log.Error(4, "Failed to remove %s: %v", daemonExportFile, err)
  1138. }
  1139. } else if !repo.IsPrivate && !com.IsExist(daemonExportFile) {
  1140. if f, err := os.Create(daemonExportFile); err != nil {
  1141. log.Error(4, "Failed to create %s: %v", daemonExportFile, err)
  1142. } else {
  1143. f.Close()
  1144. }
  1145. }
  1146. forkRepos, err := getRepositoriesByForkID(e, repo.ID)
  1147. if err != nil {
  1148. return fmt.Errorf("getRepositoriesByForkID: %v", err)
  1149. }
  1150. for i := range forkRepos {
  1151. forkRepos[i].IsPrivate = repo.IsPrivate
  1152. if err = updateRepository(e, forkRepos[i], true); err != nil {
  1153. return fmt.Errorf("updateRepository[%d]: %v", forkRepos[i].ID, err)
  1154. }
  1155. }
  1156. }
  1157. return nil
  1158. }
  1159. func UpdateRepository(repo *Repository, visibilityChanged bool) (err error) {
  1160. sess := x.NewSession()
  1161. defer sessionRelease(sess)
  1162. if err = sess.Begin(); err != nil {
  1163. return err
  1164. }
  1165. if err = updateRepository(x, repo, visibilityChanged); err != nil {
  1166. return fmt.Errorf("updateRepository: %v", err)
  1167. }
  1168. return sess.Commit()
  1169. }
  1170. // DeleteRepository deletes a repository for a user or organization.
  1171. func DeleteRepository(uid, repoID int64) error {
  1172. repo := &Repository{ID: repoID, OwnerID: uid}
  1173. has, err := x.Get(repo)
  1174. if err != nil {
  1175. return err
  1176. } else if !has {
  1177. return errors.RepoNotExist{repoID, uid, ""}
  1178. }
  1179. // In case is a organization.
  1180. org, err := GetUserByID(uid)
  1181. if err != nil {
  1182. return err
  1183. }
  1184. if org.IsOrganization() {
  1185. if err = org.GetTeams(); err != nil {
  1186. return err
  1187. }
  1188. }
  1189. sess := x.NewSession()
  1190. defer sessionRelease(sess)
  1191. if err = sess.Begin(); err != nil {
  1192. return err
  1193. }
  1194. if org.IsOrganization() {
  1195. for _, t := range org.Teams {
  1196. if !t.hasRepository(sess, repoID) {
  1197. continue
  1198. } else if err = t.removeRepository(sess, repo, false); err != nil {
  1199. return err
  1200. }
  1201. }
  1202. }
  1203. if err = deleteBeans(sess,
  1204. &Repository{ID: repoID},
  1205. &Access{RepoID: repo.ID},
  1206. &Action{RepoID: repo.ID},
  1207. &Watch{RepoID: repoID},
  1208. &Star{RepoID: repoID},
  1209. &Mirror{RepoID: repoID},
  1210. &IssueUser{RepoID: repoID},
  1211. &Milestone{RepoID: repoID},
  1212. &Release{RepoID: repoID},
  1213. &Collaboration{RepoID: repoID},
  1214. &PullRequest{BaseRepoID: repoID},
  1215. &ProtectBranch{RepoID: repoID},
  1216. &ProtectBranchWhitelist{RepoID: repoID},
  1217. ); err != nil {
  1218. return fmt.Errorf("deleteBeans: %v", err)
  1219. }
  1220. // Delete comments and attachments.
  1221. issues := make([]*Issue, 0, 25)
  1222. attachmentPaths := make([]string, 0, len(issues))
  1223. if err = sess.Where("repo_id=?", repoID).Find(&issues); err != nil {
  1224. return err
  1225. }
  1226. for i := range issues {
  1227. if _, err = sess.Delete(&Comment{IssueID: issues[i].ID}); err != nil {
  1228. return err
  1229. }
  1230. attachments := make([]*Attachment, 0, 5)
  1231. if err = sess.Where("issue_id=?", issues[i].ID).Find(&attachments); err != nil {
  1232. return err
  1233. }
  1234. for j := range attachments {
  1235. attachmentPaths = append(attachmentPaths, attachments[j].LocalPath())
  1236. }
  1237. if _, err = sess.Delete(&Attachment{IssueID: issues[i].ID}); err != nil {
  1238. return err
  1239. }
  1240. }
  1241. if _, err = sess.Delete(&Issue{RepoID: repoID}); err != nil {
  1242. return err
  1243. }
  1244. if repo.IsFork {
  1245. if _, err = sess.Exec("UPDATE `repository` SET num_forks=num_forks-1 WHERE id=?", repo.ForkID); err != nil {
  1246. return fmt.Errorf("decrease fork count: %v", err)
  1247. }
  1248. }
  1249. if _, err = sess.Exec("UPDATE `user` SET num_repos=num_repos-1 WHERE id=?", uid); err != nil {
  1250. return err
  1251. }
  1252. if err = sess.Commit(); err != nil {
  1253. return fmt.Errorf("Commit: %v", err)
  1254. }
  1255. // Remove repository files.
  1256. repoPath := repo.RepoPath()
  1257. RemoveAllWithNotice("Delete repository files", repoPath)
  1258. repo.DeleteWiki()
  1259. // Remove attachment files.
  1260. for i := range attachmentPaths {
  1261. RemoveAllWithNotice("Delete attachment", attachmentPaths[i])
  1262. }
  1263. if repo.NumForks > 0 {
  1264. if _, err = x.Exec("UPDATE `repository` SET fork_id=0,is_fork=? WHERE fork_id=?", false, repo.ID); err != nil {
  1265. log.Error(4, "reset 'fork_id' and 'is_fork': %v", err)
  1266. }
  1267. }
  1268. return nil
  1269. }
  1270. // GetRepositoryByRef returns a Repository specified by a GFM reference.
  1271. // See https://help.github.com/articles/writing-on-github#references for more information on the syntax.
  1272. func GetRepositoryByRef(ref string) (*Repository, error) {
  1273. n := strings.IndexByte(ref, byte('/'))
  1274. if n < 2 {
  1275. return nil, errors.InvalidRepoReference{ref}
  1276. }
  1277. userName, repoName := ref[:n], ref[n+1:]
  1278. user, err := GetUserByName(userName)
  1279. if err != nil {
  1280. return nil, err
  1281. }
  1282. return GetRepositoryByName(user.ID, repoName)
  1283. }
  1284. // GetRepositoryByName returns the repository by given name under user if exists.
  1285. func GetRepositoryByName(ownerID int64, name string) (*Repository, error) {
  1286. repo := &Repository{
  1287. OwnerID: ownerID,
  1288. LowerName: strings.ToLower(name),
  1289. }
  1290. has, err := x.Get(repo)
  1291. if err != nil {
  1292. return nil, err
  1293. } else if !has {
  1294. return nil, errors.RepoNotExist{0, ownerID, name}
  1295. }
  1296. return repo, repo.LoadAttributes()
  1297. }
  1298. func getRepositoryByID(e Engine, id int64) (*Repository, error) {
  1299. repo := new(Repository)
  1300. has, err := e.Id(id).Get(repo)
  1301. if err != nil {
  1302. return nil, err
  1303. } else if !has {
  1304. return nil, errors.RepoNotExist{id, 0, ""}
  1305. }
  1306. return repo, repo.loadAttributes(e)
  1307. }
  1308. // GetRepositoryByID returns the repository by given id if exists.
  1309. func GetRepositoryByID(id int64) (*Repository, error) {
  1310. return getRepositoryByID(x, id)
  1311. }
  1312. type UserRepoOptions struct {
  1313. UserID int64
  1314. Private bool
  1315. Page int
  1316. PageSize int
  1317. }
  1318. // GetUserRepositories returns a list of repositories of given user.
  1319. func GetUserRepositories(opts *UserRepoOptions) ([]*Repository, error) {
  1320. sess := x.Where("owner_id=?", opts.UserID).Desc("updated_unix")
  1321. if !opts.Private {
  1322. sess.And("is_private=?", false)
  1323. }
  1324. if opts.Page <= 0 {
  1325. opts.Page = 1
  1326. }
  1327. sess.Limit(opts.PageSize, (opts.Page-1)*opts.PageSize)
  1328. repos := make([]*Repository, 0, opts.PageSize)
  1329. return repos, sess.Find(&repos)
  1330. }
  1331. // GetUserRepositories returns a list of mirror repositories of given user.
  1332. func GetUserMirrorRepositories(userID int64) ([]*Repository, error) {
  1333. repos := make([]*Repository, 0, 10)
  1334. return repos, x.Where("owner_id = ?", userID).And("is_mirror = ?", true).Find(&repos)
  1335. }
  1336. // GetRecentUpdatedRepositories returns the list of repositories that are recently updated.
  1337. func GetRecentUpdatedRepositories(page, pageSize int) (repos []*Repository, err error) {
  1338. return repos, x.Limit(pageSize, (page-1)*pageSize).
  1339. Where("is_private=?", false).Limit(pageSize).Desc("updated_unix").Find(&repos)
  1340. }
  1341. // GetUserAndCollaborativeRepositories returns list of repositories the user owns and collaborates.
  1342. func GetUserAndCollaborativeRepositories(userID int64) ([]*Repository, error) {
  1343. repos := make([]*Repository, 0, 10)
  1344. if err := x.Alias("repo").
  1345. Join("INNER", "collaboration", "collaboration.repo_id = repo.id").
  1346. Where("collaboration.user_id = ?", userID).
  1347. Find(&repos); err != nil {
  1348. return nil, fmt.Errorf("select collaborative repositories: %v", err)
  1349. }
  1350. ownRepos := make([]*Repository, 0, 10)
  1351. if err := x.Where("owner_id = ?", userID).Find(&ownRepos); err != nil {
  1352. return nil, fmt.Errorf("select own repositories: %v", err)
  1353. }
  1354. return append(repos, ownRepos...), nil
  1355. }
  1356. func getRepositoryCount(e Engine, u *User) (int64, error) {
  1357. return x.Count(&Repository{OwnerID: u.ID})
  1358. }
  1359. // GetRepositoryCount returns the total number of repositories of user.
  1360. func GetRepositoryCount(u *User) (int64, error) {
  1361. return getRepositoryCount(x, u)
  1362. }
  1363. type SearchRepoOptions struct {
  1364. Keyword string
  1365. OwnerID int64
  1366. UserID int64 // When set results will contain all public/private repositories user has access to
  1367. OrderBy string
  1368. Private bool // Include private repositories in results
  1369. Page int
  1370. PageSize int // Can be smaller than or equal to setting.ExplorePagingNum
  1371. }
  1372. // SearchRepositoryByName takes keyword and part of repository name to search,
  1373. // it returns results in given range and number of total results.
  1374. func SearchRepositoryByName(opts *SearchRepoOptions) (repos []*Repository, _ int64, _ error) {
  1375. if opts.Page <= 0 {
  1376. opts.Page = 1
  1377. }
  1378. repos = make([]*Repository, 0, opts.PageSize)
  1379. sess := x.Alias("repo")
  1380. // Attempt to find repositories that opts.UserID has access to,
  1381. // this does not include other people's private repositories even if opts.UserID is an admin.
  1382. if !opts.Private && opts.UserID > 0 {
  1383. sess.Join("LEFT", "access", "access.repo_id = repo.id").
  1384. Where("(repo.owner_id = ? OR access.user_id = ? OR repo.is_private = ?)", opts.UserID, opts.UserID, false)
  1385. } else {
  1386. // Only return public repositories if opts.Private is not set
  1387. if !opts.Private {
  1388. sess.And("repo.is_private = ?", false)
  1389. }
  1390. }
  1391. if len(opts.Keyword) > 0 {
  1392. sess.And("repo.lower_name LIKE ?", "%"+strings.ToLower(opts.Keyword)+"%")
  1393. }
  1394. if opts.OwnerID > 0 {
  1395. sess.And("repo.owner_id = ?", opts.OwnerID)
  1396. }
  1397. var countSess xorm.Session
  1398. countSess = *sess
  1399. count, err := countSess.Count(new(Repository))
  1400. if err != nil {
  1401. return nil, 0, fmt.Errorf("Count: %v", err)
  1402. }
  1403. if len(opts.OrderBy) > 0 {
  1404. sess.OrderBy("repo." + opts.OrderBy)
  1405. }
  1406. return repos, count, sess.Limit(opts.PageSize, (opts.Page-1)*opts.PageSize).Find(&repos)
  1407. }
  1408. func DeleteOldRepositoryArchives() {
  1409. if taskStatusTable.IsRunning(_CLEAN_OLD_ARCHIVES) {
  1410. return
  1411. }
  1412. taskStatusTable.Start(_CLEAN_OLD_ARCHIVES)
  1413. defer taskStatusTable.Stop(_CLEAN_OLD_ARCHIVES)
  1414. log.Trace("Doing: DeleteOldRepositoryArchives")
  1415. formats := []string{"zip", "targz"}
  1416. oldestTime := time.Now().Add(-setting.Cron.RepoArchiveCleanup.OlderThan)
  1417. if err := x.Where("id > 0").Iterate(new(Repository),
  1418. func(idx int, bean interface{}) error {
  1419. repo := bean.(*Repository)
  1420. basePath := filepath.Join(repo.RepoPath(), "archives")
  1421. for _, format := range formats {
  1422. dirPath := filepath.Join(basePath, format)
  1423. if !com.IsDir(dirPath) {
  1424. continue
  1425. }
  1426. dir, err := os.Open(dirPath)
  1427. if err != nil {
  1428. log.Error(3, "Fail to open directory '%s': %v", dirPath, err)
  1429. continue
  1430. }
  1431. fis, err := dir.Readdir(0)
  1432. dir.Close()
  1433. if err != nil {
  1434. log.Error(3, "Fail to read directory '%s': %v", dirPath, err)
  1435. continue
  1436. }
  1437. for _, fi := range fis {
  1438. if fi.IsDir() || fi.ModTime().After(oldestTime) {
  1439. continue
  1440. }
  1441. archivePath := filepath.Join(dirPath, fi.Name())
  1442. if err = os.Remove(archivePath); err != nil {
  1443. desc := fmt.Sprintf("Fail to health delete archive '%s': %v", archivePath, err)
  1444. log.Warn(desc)
  1445. if err = CreateRepositoryNotice(desc); err != nil {
  1446. log.Error(3, "CreateRepositoryNotice: %v", err)
  1447. }
  1448. }
  1449. }
  1450. }
  1451. return nil
  1452. }); err != nil {
  1453. log.Error(2, "DeleteOldRepositoryArchives: %v", err)
  1454. }
  1455. }
  1456. // DeleteRepositoryArchives deletes all repositories' archives.
  1457. func DeleteRepositoryArchives() error {
  1458. if taskStatusTable.IsRunning(_CLEAN_OLD_ARCHIVES) {
  1459. return nil
  1460. }
  1461. taskStatusTable.Start(_CLEAN_OLD_ARCHIVES)
  1462. defer taskStatusTable.Stop(_CLEAN_OLD_ARCHIVES)
  1463. return x.Where("id > 0").Iterate(new(Repository),
  1464. func(idx int, bean interface{}) error {
  1465. repo := bean.(*Repository)
  1466. return os.RemoveAll(filepath.Join(repo.RepoPath(), "archives"))
  1467. })
  1468. }
  1469. func gatherMissingRepoRecords() ([]*Repository, error) {
  1470. repos := make([]*Repository, 0, 10)
  1471. if err := x.Where("id > 0").Iterate(new(Repository),
  1472. func(idx int, bean interface{}) error {
  1473. repo := bean.(*Repository)
  1474. if !com.IsDir(repo.RepoPath()) {
  1475. repos = append(repos, repo)
  1476. }
  1477. return nil
  1478. }); err != nil {
  1479. if err2 := CreateRepositoryNotice(fmt.Sprintf("gatherMissingRepoRecords: %v", err)); err2 != nil {
  1480. return nil, fmt.Errorf("CreateRepositoryNotice: %v", err)
  1481. }
  1482. }
  1483. return repos, nil
  1484. }
  1485. // DeleteMissingRepositories deletes all repository records that lost Git files.
  1486. func DeleteMissingRepositories() error {
  1487. repos, err := gatherMissingRepoRecords()
  1488. if err != nil {
  1489. return fmt.Errorf("gatherMissingRepoRecords: %v", err)
  1490. }
  1491. if len(repos) == 0 {
  1492. return nil
  1493. }
  1494. for _, repo := range repos {
  1495. log.Trace("Deleting %d/%d...", repo.OwnerID, repo.ID)
  1496. if err := DeleteRepository(repo.OwnerID, repo.ID); err != nil {
  1497. if err2 := CreateRepositoryNotice(fmt.Sprintf("DeleteRepository [%d]: %v", repo.ID, err)); err2 != nil {
  1498. return fmt.Errorf("CreateRepositoryNotice: %v", err)
  1499. }
  1500. }
  1501. }
  1502. return nil
  1503. }
  1504. // ReinitMissingRepositories reinitializes all repository records that lost Git files.
  1505. func ReinitMissingRepositories() error {
  1506. repos, err := gatherMissingRepoRecords()
  1507. if err != nil {
  1508. return fmt.Errorf("gatherMissingRepoRecords: %v", err)
  1509. }
  1510. if len(repos) == 0 {
  1511. return nil
  1512. }
  1513. for _, repo := range repos {
  1514. log.Trace("Initializing %d/%d...", repo.OwnerID, repo.ID)
  1515. if err := git.InitRepository(repo.RepoPath(), true); err != nil {
  1516. if err2 := CreateRepositoryNotice(fmt.Sprintf("InitRepository [%d]: %v", repo.ID, err)); err2 != nil {
  1517. return fmt.Errorf("CreateRepositoryNotice: %v", err)
  1518. }
  1519. }
  1520. }
  1521. return nil
  1522. }
  1523. // SyncRepositoryHooks rewrites all repositories' pre-receive, update and post-receive hooks
  1524. // to make sure the binary and custom conf path are up-to-date.
  1525. func SyncRepositoryHooks() error {
  1526. return x.Where("id > 0").Iterate(new(Repository),
  1527. func(idx int, bean interface{}) error {
  1528. repo := bean.(*Repository)
  1529. if err := createDelegateHooks(repo.RepoPath()); err != nil {
  1530. return err
  1531. }
  1532. if repo.HasWiki() {
  1533. return createDelegateHooks(repo.WikiPath())
  1534. }
  1535. return nil
  1536. })
  1537. }
  1538. // Prevent duplicate running tasks.
  1539. var taskStatusTable = sync.NewStatusTable()
  1540. const (
  1541. _MIRROR_UPDATE = "mirror_update"
  1542. _GIT_FSCK = "git_fsck"
  1543. _CHECK_REPO_STATS = "check_repos_stats"
  1544. _CLEAN_OLD_ARCHIVES = "clean_old_archives"
  1545. )
  1546. // GitFsck calls 'git fsck' to check repository health.
  1547. func GitFsck() {
  1548. if taskStatusTable.IsRunning(_GIT_FSCK) {
  1549. return
  1550. }
  1551. taskStatusTable.Start(_GIT_FSCK)
  1552. defer taskStatusTable.Stop(_GIT_FSCK)
  1553. log.Trace("Doing: GitFsck")
  1554. if err := x.Where("id>0").Iterate(new(Repository),
  1555. func(idx int, bean interface{}) error {
  1556. repo := bean.(*Repository)
  1557. repoPath := repo.RepoPath()
  1558. if err := git.Fsck(repoPath, setting.Cron.RepoHealthCheck.Timeout, setting.Cron.RepoHealthCheck.Args...); err != nil {
  1559. desc := fmt.Sprintf("Fail to health check repository '%s': %v", repoPath, err)
  1560. log.Warn(desc)
  1561. if err = CreateRepositoryNotice(desc); err != nil {
  1562. log.Error(3, "CreateRepositoryNotice: %v", err)
  1563. }
  1564. }
  1565. return nil
  1566. }); err != nil {
  1567. log.Error(2, "GitFsck: %v", err)
  1568. }
  1569. }
  1570. func GitGcRepos() error {
  1571. args := append([]string{"gc"}, setting.Git.GCArgs...)
  1572. return x.Where("id > 0").Iterate(new(Repository),
  1573. func(idx int, bean interface{}) error {
  1574. repo := bean.(*Repository)
  1575. if err := repo.GetOwner(); err != nil {
  1576. return err
  1577. }
  1578. _, stderr, err := process.ExecDir(
  1579. time.Duration(setting.Git.Timeout.GC)*time.Second,
  1580. RepoPath(repo.Owner.Name, repo.Name), "Repository garbage collection",
  1581. "git", args...)
  1582. if err != nil {
  1583. return fmt.Errorf("%v: %v", err, stderr)
  1584. }
  1585. return nil
  1586. })
  1587. }
  1588. type repoChecker struct {
  1589. querySQL, correctSQL string
  1590. desc string
  1591. }
  1592. func repoStatsCheck(checker *repoChecker) {
  1593. results, err := x.Query(checker.querySQL)
  1594. if err != nil {
  1595. log.Error(2, "Select %s: %v", checker.desc, err)
  1596. return
  1597. }
  1598. for _, result := range results {
  1599. id := com.StrTo(result["id"]).MustInt64()
  1600. log.Trace("Updating %s: %d", checker.desc, id)
  1601. _, err = x.Exec(checker.correctSQL, id, id)
  1602. if err != nil {
  1603. log.Error(2, "Update %s[%d]: %v", checker.desc, id, err)
  1604. }
  1605. }
  1606. }
  1607. func CheckRepoStats() {
  1608. if taskStatusTable.IsRunning(_CHECK_REPO_STATS) {
  1609. return
  1610. }
  1611. taskStatusTable.Start(_CHECK_REPO_STATS)
  1612. defer taskStatusTable.Stop(_CHECK_REPO_STATS)
  1613. log.Trace("Doing: CheckRepoStats")
  1614. checkers := []*repoChecker{
  1615. // Repository.NumWatches
  1616. {
  1617. "SELECT repo.id FROM `repository` repo WHERE repo.num_watches!=(SELECT COUNT(*) FROM `watch` WHERE repo_id=repo.id)",
  1618. "UPDATE `repository` SET num_watches=(SELECT COUNT(*) FROM `watch` WHERE repo_id=?) WHERE id=?",
  1619. "repository count 'num_watches'",
  1620. },
  1621. // Repository.NumStars
  1622. {
  1623. "SELECT repo.id FROM `repository` repo WHERE repo.num_stars!=(SELECT COUNT(*) FROM `star` WHERE repo_id=repo.id)",
  1624. "UPDATE `repository` SET num_stars=(SELECT COUNT(*) FROM `star` WHERE repo_id=?) WHERE id=?",
  1625. "repository count 'num_stars'",
  1626. },
  1627. // Label.NumIssues
  1628. {
  1629. "SELECT label.id FROM `label` WHERE label.num_issues!=(SELECT COUNT(*) FROM `issue_label` WHERE label_id=label.id)",
  1630. "UPDATE `label` SET num_issues=(SELECT COUNT(*) FROM `issue_label` WHERE label_id=?) WHERE id=?",
  1631. "label count 'num_issues'",
  1632. },
  1633. // User.NumRepos
  1634. {
  1635. "SELECT `user`.id FROM `user` WHERE `user`.num_repos!=(SELECT COUNT(*) FROM `repository` WHERE owner_id=`user`.id)",
  1636. "UPDATE `user` SET num_repos=(SELECT COUNT(*) FROM `repository` WHERE owner_id=?) WHERE id=?",
  1637. "user count 'num_repos'",
  1638. },
  1639. // Issue.NumComments
  1640. {
  1641. "SELECT `issue`.id FROM `issue` WHERE `issue`.num_comments!=(SELECT COUNT(*) FROM `comment` WHERE issue_id=`issue`.id AND type=0)",
  1642. "UPDATE `issue` SET num_comments=(SELECT COUNT(*) FROM `comment` WHERE issue_id=? AND type=0) WHERE id=?",
  1643. "issue count 'num_comments'",
  1644. },
  1645. }
  1646. for i := range checkers {
  1647. repoStatsCheck(checkers[i])
  1648. }
  1649. // ***** START: Repository.NumClosedIssues *****
  1650. desc := "repository count 'num_closed_issues'"
  1651. results, err := x.Query("SELECT repo.id FROM `repository` repo WHERE repo.num_closed_issues!=(SELECT COUNT(*) FROM `issue` WHERE repo_id=repo.id AND is_closed=? AND is_pull=?)", true, false)
  1652. if err != nil {
  1653. log.Error(2, "Select %s: %v", desc, err)
  1654. } else {
  1655. for _, result := range results {
  1656. id := com.StrTo(result["id"]).MustInt64()
  1657. log.Trace("Updating %s: %d", desc, id)
  1658. _, err = x.Exec("UPDATE `repository` SET num_closed_issues=(SELECT COUNT(*) FROM `issue` WHERE repo_id=? AND is_closed=? AND is_pull=?) WHERE id=?", id, true, false, id)
  1659. if err != nil {
  1660. log.Error(2, "Update %s[%d]: %v", desc, id, err)
  1661. }
  1662. }
  1663. }
  1664. // ***** END: Repository.NumClosedIssues *****
  1665. // FIXME: use checker when stop supporting old fork repo format.
  1666. // ***** START: Repository.NumForks *****
  1667. results, err = x.Query("SELECT repo.id FROM `repository` repo WHERE repo.num_forks!=(SELECT COUNT(*) FROM `repository` WHERE fork_id=repo.id)")
  1668. if err != nil {
  1669. log.Error(2, "Select repository count 'num_forks': %v", err)
  1670. } else {
  1671. for _, result := range results {
  1672. id := com.StrTo(result["id"]).MustInt64()
  1673. log.Trace("Updating repository count 'num_forks': %d", id)
  1674. repo, err := GetRepositoryByID(id)
  1675. if err != nil {
  1676. log.Error(2, "GetRepositoryByID[%d]: %v", id, err)
  1677. continue
  1678. }
  1679. rawResult, err := x.Query("SELECT COUNT(*) FROM `repository` WHERE fork_id=?", repo.ID)
  1680. if err != nil {
  1681. log.Error(2, "Select count of forks[%d]: %v", repo.ID, err)
  1682. continue
  1683. }
  1684. repo.NumForks = int(parseCountResult(rawResult))
  1685. if err = UpdateRepository(repo, false); err != nil {
  1686. log.Error(2, "UpdateRepository[%d]: %v", id, err)
  1687. continue
  1688. }
  1689. }
  1690. }
  1691. // ***** END: Repository.NumForks *****
  1692. }
  1693. type RepositoryList []*Repository
  1694. func (repos RepositoryList) loadAttributes(e Engine) error {
  1695. if len(repos) == 0 {
  1696. return nil
  1697. }
  1698. // Load owners
  1699. set := make(map[int64]*User)
  1700. for i := range repos {
  1701. set[repos[i].OwnerID] = nil
  1702. }
  1703. userIDs := make([]int64, 0, len(set))
  1704. for userID := range set {
  1705. userIDs = append(userIDs, userID)
  1706. }
  1707. users := make([]*User, 0, len(userIDs))
  1708. if err := e.Where("id > 0").In("id", userIDs).Find(&users); err != nil {
  1709. return fmt.Errorf("find users: %v", err)
  1710. }
  1711. for i := range users {
  1712. set[users[i].ID] = users[i]
  1713. }
  1714. for i := range repos {
  1715. repos[i].Owner = set[repos[i].OwnerID]
  1716. }
  1717. return nil
  1718. }
  1719. func (repos RepositoryList) LoadAttributes() error {
  1720. return repos.loadAttributes(x)
  1721. }
  1722. type MirrorRepositoryList []*Repository
  1723. func (repos MirrorRepositoryList) loadAttributes(e Engine) error {
  1724. if len(repos) == 0 {
  1725. return nil
  1726. }
  1727. // Load mirrors.
  1728. repoIDs := make([]int64, 0, len(repos))
  1729. for i := range repos {
  1730. if !repos[i].IsMirror {
  1731. continue
  1732. }
  1733. repoIDs = append(repoIDs, repos[i].ID)
  1734. }
  1735. mirrors := make([]*Mirror, 0, len(repoIDs))
  1736. if err := e.Where("id > 0").In("repo_id", repoIDs).Find(&mirrors); err != nil {
  1737. return fmt.Errorf("find mirrors: %v", err)
  1738. }
  1739. set := make(map[int64]*Mirror)
  1740. for i := range mirrors {
  1741. set[mirrors[i].RepoID] = mirrors[i]
  1742. }
  1743. for i := range repos {
  1744. repos[i].Mirror = set[repos[i].ID]
  1745. }
  1746. return nil
  1747. }
  1748. func (repos MirrorRepositoryList) LoadAttributes() error {
  1749. return repos.loadAttributes(x)
  1750. }
  1751. // __ __ __ .__
  1752. // / \ / \_____ _/ |_ ____ | |__
  1753. // \ \/\/ /\__ \\ __\/ ___\| | \
  1754. // \ / / __ \| | \ \___| Y \
  1755. // \__/\ / (____ /__| \___ >___| /
  1756. // \/ \/ \/ \/
  1757. // Watch is connection request for receiving repository notification.
  1758. type Watch struct {
  1759. ID int64 `xorm:"pk autoincr"`
  1760. UserID int64 `xorm:"UNIQUE(watch)"`
  1761. RepoID int64 `xorm:"UNIQUE(watch)"`
  1762. }
  1763. func isWatching(e Engine, userID, repoID int64) bool {
  1764. has, _ := e.Get(&Watch{0, userID, repoID})
  1765. return has
  1766. }
  1767. // IsWatching checks if user has watched given repository.
  1768. func IsWatching(userID, repoID int64) bool {
  1769. return isWatching(x, userID, repoID)
  1770. }
  1771. func watchRepo(e Engine, userID, repoID int64, watch bool) (err error) {
  1772. if watch {
  1773. if isWatching(e, userID, repoID) {
  1774. return nil
  1775. }
  1776. if _, err = e.Insert(&Watch{RepoID: repoID, UserID: userID}); err != nil {
  1777. return err
  1778. }
  1779. _, err = e.Exec("UPDATE `repository` SET num_watches = num_watches + 1 WHERE id = ?", repoID)
  1780. } else {
  1781. if !isWatching(e, userID, repoID) {
  1782. return nil
  1783. }
  1784. if _, err = e.Delete(&Watch{0, userID, repoID}); err != nil {
  1785. return err
  1786. }
  1787. _, err = e.Exec("UPDATE `repository` SET num_watches = num_watches - 1 WHERE id = ?", repoID)
  1788. }
  1789. return err
  1790. }
  1791. // Watch or unwatch repository.
  1792. func WatchRepo(userID, repoID int64, watch bool) (err error) {
  1793. return watchRepo(x, userID, repoID, watch)
  1794. }
  1795. func getWatchers(e Engine, repoID int64) ([]*Watch, error) {
  1796. watches := make([]*Watch, 0, 10)
  1797. return watches, e.Find(&watches, &Watch{RepoID: repoID})
  1798. }
  1799. // GetWatchers returns all watchers of given repository.
  1800. func GetWatchers(repoID int64) ([]*Watch, error) {
  1801. return getWatchers(x, repoID)
  1802. }
  1803. // Repository.GetWatchers returns range of users watching given repository.
  1804. func (repo *Repository) GetWatchers(page int) ([]*User, error) {
  1805. users := make([]*User, 0, ItemsPerPage)
  1806. sess := x.Limit(ItemsPerPage, (page-1)*ItemsPerPage).Where("watch.repo_id=?", repo.ID)
  1807. if setting.UsePostgreSQL {
  1808. sess = sess.Join("LEFT", "watch", `"user".id=watch.user_id`)
  1809. } else {
  1810. sess = sess.Join("LEFT", "watch", "user.id=watch.user_id")
  1811. }
  1812. return users, sess.Find(&users)
  1813. }
  1814. func notifyWatchers(e Engine, act *Action) error {
  1815. // Add feeds for user self and all watchers.
  1816. watchers, err := getWatchers(e, act.RepoID)
  1817. if err != nil {
  1818. return fmt.Errorf("getWatchers: %v", err)
  1819. }
  1820. // Reset ID to reuse Action object
  1821. act.ID = 0
  1822. // Add feed for actioner.
  1823. act.UserID = act.ActUserID
  1824. if _, err = e.Insert(act); err != nil {
  1825. return fmt.Errorf("insert new action: %v", err)
  1826. }
  1827. for i := range watchers {
  1828. if act.ActUserID == watchers[i].UserID {
  1829. continue
  1830. }
  1831. act.ID = 0
  1832. act.UserID = watchers[i].UserID
  1833. if _, err = e.Insert(act); err != nil {
  1834. return fmt.Errorf("insert new action: %v", err)
  1835. }
  1836. }
  1837. return nil
  1838. }
  1839. // NotifyWatchers creates batch of actions for every watcher.
  1840. func NotifyWatchers(act *Action) error {
  1841. return notifyWatchers(x, act)
  1842. }
  1843. // _________ __
  1844. // / _____// |______ _______
  1845. // \_____ \\ __\__ \\_ __ \
  1846. // / \| | / __ \| | \/
  1847. // /_______ /|__| (____ /__|
  1848. // \/ \/
  1849. type Star struct {
  1850. ID int64 `xorm:"pk autoincr"`
  1851. UID int64 `xorm:"UNIQUE(s)"`
  1852. RepoID int64 `xorm:"UNIQUE(s)"`
  1853. }
  1854. // Star or unstar repository.
  1855. func StarRepo(userID, repoID int64, star bool) (err error) {
  1856. if star {
  1857. if IsStaring(userID, repoID) {
  1858. return nil
  1859. }
  1860. if _, err = x.Insert(&Star{UID: userID, RepoID: repoID}); err != nil {
  1861. return err
  1862. } else if _, err = x.Exec("UPDATE `repository` SET num_stars = num_stars + 1 WHERE id = ?", repoID); err != nil {
  1863. return err
  1864. }
  1865. _, err = x.Exec("UPDATE `user` SET num_stars = num_stars + 1 WHERE id = ?", userID)
  1866. } else {
  1867. if !IsStaring(userID, repoID) {
  1868. return nil
  1869. }
  1870. if _, err = x.Delete(&Star{0, userID, repoID}); err != nil {
  1871. return err
  1872. } else if _, err = x.Exec("UPDATE `repository` SET num_stars = num_stars - 1 WHERE id = ?", repoID); err != nil {
  1873. return err
  1874. }
  1875. _, err = x.Exec("UPDATE `user` SET num_stars = num_stars - 1 WHERE id = ?", userID)
  1876. }
  1877. return err
  1878. }
  1879. // IsStaring checks if user has starred given repository.
  1880. func IsStaring(userID, repoID int64) bool {
  1881. has, _ := x.Get(&Star{0, userID, repoID})
  1882. return has
  1883. }
  1884. func (repo *Repository) GetStargazers(page int) ([]*User, error) {
  1885. users := make([]*User, 0, ItemsPerPage)
  1886. sess := x.Limit(ItemsPerPage, (page-1)*ItemsPerPage).Where("star.repo_id=?", repo.ID)
  1887. if setting.UsePostgreSQL {
  1888. sess = sess.Join("LEFT", "star", `"user".id=star.uid`)
  1889. } else {
  1890. sess = sess.Join("LEFT", "star", "user.id=star.uid")
  1891. }
  1892. return users, sess.Find(&users)
  1893. }
  1894. // ___________ __
  1895. // \_ _____/__________| | __
  1896. // | __)/ _ \_ __ \ |/ /
  1897. // | \( <_> ) | \/ <
  1898. // \___ / \____/|__| |__|_ \
  1899. // \/ \/
  1900. // HasForkedRepo checks if given user has already forked a repository.
  1901. // When user has already forked, it returns true along with the repository.
  1902. func HasForkedRepo(ownerID, repoID int64) (*Repository, bool) {
  1903. repo := new(Repository)
  1904. has, _ := x.Where("owner_id = ? AND fork_id = ?", ownerID, repoID).Get(repo)
  1905. return repo, has
  1906. }
  1907. // ForkRepository creates a fork of target repository under another user domain.
  1908. func ForkRepository(doer, owner *User, baseRepo *Repository, name, desc string) (_ *Repository, err error) {
  1909. repo := &Repository{
  1910. OwnerID: owner.ID,
  1911. Owner: owner,
  1912. Name: name,
  1913. LowerName: strings.ToLower(name),
  1914. Description: desc,
  1915. DefaultBranch: baseRepo.DefaultBranch,
  1916. IsPrivate: baseRepo.IsPrivate,
  1917. IsFork: true,
  1918. ForkID: baseRepo.ID,
  1919. }
  1920. sess := x.NewSession()
  1921. defer sessionRelease(sess)
  1922. if err = sess.Begin(); err != nil {
  1923. return nil, err
  1924. }
  1925. if err = createRepository(sess, doer, owner, repo); err != nil {
  1926. return nil, err
  1927. } else if _, err = sess.Exec("UPDATE `repository` SET num_forks=num_forks+1 WHERE id=?", baseRepo.ID); err != nil {
  1928. return nil, err
  1929. }
  1930. repoPath := repo.repoPath(sess)
  1931. RemoveAllWithNotice("Repository path erase before creation", repoPath)
  1932. _, stderr, err := process.ExecTimeout(10*time.Minute,
  1933. fmt.Sprintf("ForkRepository 'git clone': %s/%s", owner.Name, repo.Name),
  1934. "git", "clone", "--bare", baseRepo.RepoPath(), repoPath)
  1935. if err != nil {
  1936. return nil, fmt.Errorf("git clone: %v", stderr)
  1937. }
  1938. _, stderr, err = process.ExecDir(-1,
  1939. repoPath, fmt.Sprintf("ForkRepository 'git update-server-info': %s", repoPath),
  1940. "git", "update-server-info")
  1941. if err != nil {
  1942. return nil, fmt.Errorf("git update-server-info: %v", err)
  1943. }
  1944. if err = createDelegateHooks(repoPath); err != nil {
  1945. return nil, fmt.Errorf("createDelegateHooks: %v", err)
  1946. }
  1947. if err = sess.Commit(); err != nil {
  1948. return nil, fmt.Errorf("Commit: %v", err)
  1949. }
  1950. if err = repo.UpdateSize(); err != nil {
  1951. log.Error(2, "UpdateSize [repo_id: %d]: %v", repo.ID, err)
  1952. }
  1953. if err = PrepareWebhooks(baseRepo, HOOK_EVENT_FORK, &api.ForkPayload{
  1954. Forkee: repo.APIFormat(nil),
  1955. Repo: baseRepo.APIFormat(nil),
  1956. Sender: doer.APIFormat(),
  1957. }); err != nil {
  1958. log.Error(2, "PrepareWebhooks [repo_id: %d]: %v", baseRepo.ID, err)
  1959. }
  1960. return repo, nil
  1961. }
  1962. func (repo *Repository) GetForks() ([]*Repository, error) {
  1963. forks := make([]*Repository, 0, repo.NumForks)
  1964. return forks, x.Find(&forks, &Repository{ForkID: repo.ID})
  1965. }
  1966. // __________ .__
  1967. // \______ \____________ ____ ____ | |__
  1968. // | | _/\_ __ \__ \ / \_/ ___\| | \
  1969. // | | \ | | \// __ \| | \ \___| Y \
  1970. // |______ / |__| (____ /___| /\___ >___| /
  1971. // \/ \/ \/ \/ \/
  1972. //
  1973. func (repo *Repository) CreateNewBranch(doer *User, oldBranchName, branchName string) (err error) {
  1974. repoWorkingPool.CheckIn(com.ToStr(repo.ID))
  1975. defer repoWorkingPool.CheckOut(com.ToStr(repo.ID))
  1976. localPath := repo.LocalCopyPath()
  1977. if err = discardLocalRepoBranchChanges(localPath, oldBranchName); err != nil {
  1978. return fmt.Errorf("discardLocalRepoChanges: %v", err)
  1979. } else if err = repo.UpdateLocalCopyBranch(oldBranchName); err != nil {
  1980. return fmt.Errorf("UpdateLocalCopyBranch: %v", err)
  1981. }
  1982. if err = repo.CheckoutNewBranch(oldBranchName, branchName); err != nil {
  1983. return fmt.Errorf("CreateNewBranch: %v", err)
  1984. }
  1985. if err = git.Push(localPath, "origin", branchName); err != nil {
  1986. return fmt.Errorf("Push: %v", err)
  1987. }
  1988. return nil
  1989. }