123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977 |
- // Copyright 2014 The Gogs Authors. All rights reserved.
- // Copyright 2018 The Gitea Authors. All rights reserved.
- // SPDX-License-Identifier: MIT
-
- package repo
-
- import (
- "bytes"
- "encoding/base64"
- "errors"
- "fmt"
- "io"
- "net/http"
- "path"
- "strings"
- "time"
-
- "code.gitea.io/gitea/models"
- git_model "code.gitea.io/gitea/models/git"
- repo_model "code.gitea.io/gitea/models/repo"
- "code.gitea.io/gitea/models/unit"
- "code.gitea.io/gitea/modules/git"
- "code.gitea.io/gitea/modules/gitrepo"
- "code.gitea.io/gitea/modules/httpcache"
- "code.gitea.io/gitea/modules/lfs"
- "code.gitea.io/gitea/modules/log"
- "code.gitea.io/gitea/modules/setting"
- "code.gitea.io/gitea/modules/storage"
- api "code.gitea.io/gitea/modules/structs"
- "code.gitea.io/gitea/modules/web"
- "code.gitea.io/gitea/routers/common"
- "code.gitea.io/gitea/services/context"
- archiver_service "code.gitea.io/gitea/services/repository/archiver"
- files_service "code.gitea.io/gitea/services/repository/files"
- )
-
- const giteaObjectTypeHeader = "X-Gitea-Object-Type"
-
- // GetRawFile get a file by path on a repository
- func GetRawFile(ctx *context.APIContext) {
- // swagger:operation GET /repos/{owner}/{repo}/raw/{filepath} repository repoGetRawFile
- // ---
- // summary: Get a file from a repository
- // produces:
- // - application/json
- // parameters:
- // - name: owner
- // in: path
- // description: owner of the repo
- // type: string
- // required: true
- // - name: repo
- // in: path
- // description: name of the repo
- // type: string
- // required: true
- // - name: filepath
- // in: path
- // description: filepath of the file to get
- // type: string
- // required: true
- // - name: ref
- // in: query
- // description: "The name of the commit/branch/tag. Default the repository’s default branch (usually master)"
- // type: string
- // required: false
- // responses:
- // 200:
- // description: Returns raw file content.
- // "404":
- // "$ref": "#/responses/notFound"
-
- if ctx.Repo.Repository.IsEmpty {
- ctx.NotFound()
- return
- }
-
- blob, entry, lastModified := getBlobForEntry(ctx)
- if ctx.Written() {
- return
- }
-
- ctx.RespHeader().Set(giteaObjectTypeHeader, string(files_service.GetObjectTypeFromTreeEntry(entry)))
-
- if err := common.ServeBlob(ctx.Base, ctx.Repo.TreePath, blob, lastModified); err != nil {
- ctx.Error(http.StatusInternalServerError, "ServeBlob", err)
- }
- }
-
- // GetRawFileOrLFS get a file by repo's path, redirecting to LFS if necessary.
- func GetRawFileOrLFS(ctx *context.APIContext) {
- // swagger:operation GET /repos/{owner}/{repo}/media/{filepath} repository repoGetRawFileOrLFS
- // ---
- // summary: Get a file or it's LFS object from a repository
- // parameters:
- // - name: owner
- // in: path
- // description: owner of the repo
- // type: string
- // required: true
- // - name: repo
- // in: path
- // description: name of the repo
- // type: string
- // required: true
- // - name: filepath
- // in: path
- // description: filepath of the file to get
- // type: string
- // required: true
- // - name: ref
- // in: query
- // description: "The name of the commit/branch/tag. Default the repository’s default branch (usually master)"
- // type: string
- // required: false
- // responses:
- // 200:
- // description: Returns raw file content.
- // "404":
- // "$ref": "#/responses/notFound"
-
- if ctx.Repo.Repository.IsEmpty {
- ctx.NotFound()
- return
- }
-
- blob, entry, lastModified := getBlobForEntry(ctx)
- if ctx.Written() {
- return
- }
-
- ctx.RespHeader().Set(giteaObjectTypeHeader, string(files_service.GetObjectTypeFromTreeEntry(entry)))
-
- // LFS Pointer files are at most 1024 bytes - so any blob greater than 1024 bytes cannot be an LFS file
- if blob.Size() > 1024 {
- // First handle caching for the blob
- if httpcache.HandleGenericETagTimeCache(ctx.Req, ctx.Resp, `"`+blob.ID.String()+`"`, lastModified) {
- return
- }
-
- // OK not cached - serve!
- if err := common.ServeBlob(ctx.Base, ctx.Repo.TreePath, blob, lastModified); err != nil {
- ctx.ServerError("ServeBlob", err)
- }
- return
- }
-
- // OK, now the blob is known to have at most 1024 bytes we can simply read this in one go (This saves reading it twice)
- dataRc, err := blob.DataAsync()
- if err != nil {
- ctx.ServerError("DataAsync", err)
- return
- }
-
- // FIXME: code from #19689, what if the file is large ... OOM ...
- buf, err := io.ReadAll(dataRc)
- if err != nil {
- _ = dataRc.Close()
- ctx.ServerError("DataAsync", err)
- return
- }
-
- if err := dataRc.Close(); err != nil {
- log.Error("Error whilst closing blob %s reader in %-v. Error: %v", blob.ID, ctx.Repo.Repository, err)
- }
-
- // Check if the blob represents a pointer
- pointer, _ := lfs.ReadPointer(bytes.NewReader(buf))
-
- // if it's not a pointer, just serve the data directly
- if !pointer.IsValid() {
- // First handle caching for the blob
- if httpcache.HandleGenericETagTimeCache(ctx.Req, ctx.Resp, `"`+blob.ID.String()+`"`, lastModified) {
- return
- }
-
- // OK not cached - serve!
- common.ServeContentByReader(ctx.Base, ctx.Repo.TreePath, blob.Size(), bytes.NewReader(buf))
- return
- }
-
- // Now check if there is a MetaObject for this pointer
- meta, err := git_model.GetLFSMetaObjectByOid(ctx, ctx.Repo.Repository.ID, pointer.Oid)
-
- // If there isn't one, just serve the data directly
- if err == git_model.ErrLFSObjectNotExist {
- // Handle caching for the blob SHA (not the LFS object OID)
- if httpcache.HandleGenericETagTimeCache(ctx.Req, ctx.Resp, `"`+blob.ID.String()+`"`, lastModified) {
- return
- }
-
- common.ServeContentByReader(ctx.Base, ctx.Repo.TreePath, blob.Size(), bytes.NewReader(buf))
- return
- } else if err != nil {
- ctx.ServerError("GetLFSMetaObjectByOid", err)
- return
- }
-
- // Handle caching for the LFS object OID
- if httpcache.HandleGenericETagCache(ctx.Req, ctx.Resp, `"`+pointer.Oid+`"`) {
- return
- }
-
- if setting.LFS.Storage.MinioConfig.ServeDirect {
- // If we have a signed url (S3, object storage), redirect to this directly.
- u, err := storage.LFS.URL(pointer.RelativePath(), blob.Name())
- if u != nil && err == nil {
- ctx.Redirect(u.String())
- return
- }
- }
-
- lfsDataRc, err := lfs.ReadMetaObject(meta.Pointer)
- if err != nil {
- ctx.ServerError("ReadMetaObject", err)
- return
- }
- defer lfsDataRc.Close()
-
- common.ServeContentByReadSeeker(ctx.Base, ctx.Repo.TreePath, lastModified, lfsDataRc)
- }
-
- func getBlobForEntry(ctx *context.APIContext) (blob *git.Blob, entry *git.TreeEntry, lastModified *time.Time) {
- entry, err := ctx.Repo.Commit.GetTreeEntryByPath(ctx.Repo.TreePath)
- if err != nil {
- if git.IsErrNotExist(err) {
- ctx.NotFound()
- } else {
- ctx.Error(http.StatusInternalServerError, "GetTreeEntryByPath", err)
- }
- return nil, nil, nil
- }
-
- if entry.IsDir() || entry.IsSubModule() {
- ctx.NotFound("getBlobForEntry", nil)
- return nil, nil, nil
- }
-
- info, _, err := git.Entries([]*git.TreeEntry{entry}).GetCommitsInfo(ctx, ctx.Repo.Commit, path.Dir("/" + ctx.Repo.TreePath)[1:])
- if err != nil {
- ctx.Error(http.StatusInternalServerError, "GetCommitsInfo", err)
- return nil, nil, nil
- }
-
- if len(info) == 1 {
- // Not Modified
- lastModified = &info[0].Commit.Committer.When
- }
- blob = entry.Blob()
-
- return blob, entry, lastModified
- }
-
- // GetArchive get archive of a repository
- func GetArchive(ctx *context.APIContext) {
- // swagger:operation GET /repos/{owner}/{repo}/archive/{archive} repository repoGetArchive
- // ---
- // summary: Get an archive of a repository
- // produces:
- // - application/json
- // parameters:
- // - name: owner
- // in: path
- // description: owner of the repo
- // type: string
- // required: true
- // - name: repo
- // in: path
- // description: name of the repo
- // type: string
- // required: true
- // - name: archive
- // in: path
- // description: the git reference for download with attached archive format (e.g. master.zip)
- // type: string
- // required: true
- // responses:
- // 200:
- // description: success
- // "404":
- // "$ref": "#/responses/notFound"
-
- if ctx.Repo.GitRepo == nil {
- gitRepo, err := gitrepo.OpenRepository(ctx, ctx.Repo.Repository)
- if err != nil {
- ctx.Error(http.StatusInternalServerError, "OpenRepository", err)
- return
- }
- ctx.Repo.GitRepo = gitRepo
- defer gitRepo.Close()
- }
-
- archiveDownload(ctx)
- }
-
- func archiveDownload(ctx *context.APIContext) {
- uri := ctx.Params("*")
- aReq, err := archiver_service.NewRequest(ctx.Repo.Repository.ID, ctx.Repo.GitRepo, uri)
- if err != nil {
- if errors.Is(err, archiver_service.ErrUnknownArchiveFormat{}) {
- ctx.Error(http.StatusBadRequest, "unknown archive format", err)
- } else if errors.Is(err, archiver_service.RepoRefNotFoundError{}) {
- ctx.Error(http.StatusNotFound, "unrecognized reference", err)
- } else {
- ctx.ServerError("archiver_service.NewRequest", err)
- }
- return
- }
-
- archiver, err := aReq.Await(ctx)
- if err != nil {
- ctx.ServerError("archiver.Await", err)
- return
- }
-
- download(ctx, aReq.GetArchiveName(), archiver)
- }
-
- func download(ctx *context.APIContext, archiveName string, archiver *repo_model.RepoArchiver) {
- downloadName := ctx.Repo.Repository.Name + "-" + archiveName
-
- rPath := archiver.RelativePath()
- if setting.RepoArchive.Storage.MinioConfig.ServeDirect {
- // If we have a signed url (S3, object storage), redirect to this directly.
- u, err := storage.RepoArchives.URL(rPath, downloadName)
- if u != nil && err == nil {
- ctx.Redirect(u.String())
- return
- }
- }
-
- // If we have matched and access to release or issue
- fr, err := storage.RepoArchives.Open(rPath)
- if err != nil {
- ctx.ServerError("Open", err)
- return
- }
- defer fr.Close()
-
- ctx.ServeContent(fr, &context.ServeHeaderOptions{
- Filename: downloadName,
- LastModified: archiver.CreatedUnix.AsLocalTime(),
- })
- }
-
- // GetEditorconfig get editor config of a repository
- func GetEditorconfig(ctx *context.APIContext) {
- // swagger:operation GET /repos/{owner}/{repo}/editorconfig/{filepath} repository repoGetEditorConfig
- // ---
- // summary: Get the EditorConfig definitions of a file in a repository
- // produces:
- // - application/json
- // parameters:
- // - name: owner
- // in: path
- // description: owner of the repo
- // type: string
- // required: true
- // - name: repo
- // in: path
- // description: name of the repo
- // type: string
- // required: true
- // - name: filepath
- // in: path
- // description: filepath of file to get
- // type: string
- // required: true
- // - name: ref
- // in: query
- // description: "The name of the commit/branch/tag. Default the repository’s default branch (usually master)"
- // type: string
- // required: false
- // responses:
- // 200:
- // description: success
- // "404":
- // "$ref": "#/responses/notFound"
-
- ec, _, err := ctx.Repo.GetEditorconfig(ctx.Repo.Commit)
- if err != nil {
- if git.IsErrNotExist(err) {
- ctx.NotFound(err)
- } else {
- ctx.Error(http.StatusInternalServerError, "GetEditorconfig", err)
- }
- return
- }
-
- fileName := ctx.Params("filename")
- def, err := ec.GetDefinitionForFilename(fileName)
- if def == nil {
- ctx.NotFound(err)
- return
- }
- ctx.JSON(http.StatusOK, def)
- }
-
- // canWriteFiles returns true if repository is editable and user has proper access level.
- func canWriteFiles(ctx *context.APIContext, branch string) bool {
- return ctx.Repo.CanWriteToBranch(ctx, ctx.Doer, branch) &&
- !ctx.Repo.Repository.IsMirror &&
- !ctx.Repo.Repository.IsArchived
- }
-
- // canReadFiles returns true if repository is readable and user has proper access level.
- func canReadFiles(r *context.Repository) bool {
- return r.Permission.CanRead(unit.TypeCode)
- }
-
- func base64Reader(s string) (io.ReadSeeker, error) {
- b, err := base64.StdEncoding.DecodeString(s)
- if err != nil {
- return nil, err
- }
- return bytes.NewReader(b), nil
- }
-
- // ChangeFiles handles API call for modifying multiple files
- func ChangeFiles(ctx *context.APIContext) {
- // swagger:operation POST /repos/{owner}/{repo}/contents repository repoChangeFiles
- // ---
- // summary: Modify multiple files in a repository
- // consumes:
- // - application/json
- // produces:
- // - application/json
- // parameters:
- // - name: owner
- // in: path
- // description: owner of the repo
- // type: string
- // required: true
- // - name: repo
- // in: path
- // description: name of the repo
- // type: string
- // required: true
- // - name: body
- // in: body
- // required: true
- // schema:
- // "$ref": "#/definitions/ChangeFilesOptions"
- // responses:
- // "201":
- // "$ref": "#/responses/FilesResponse"
- // "403":
- // "$ref": "#/responses/error"
- // "404":
- // "$ref": "#/responses/notFound"
- // "422":
- // "$ref": "#/responses/error"
- // "423":
- // "$ref": "#/responses/repoArchivedError"
-
- apiOpts := web.GetForm(ctx).(*api.ChangeFilesOptions)
-
- if apiOpts.BranchName == "" {
- apiOpts.BranchName = ctx.Repo.Repository.DefaultBranch
- }
-
- var files []*files_service.ChangeRepoFile
- for _, file := range apiOpts.Files {
- contentReader, err := base64Reader(file.ContentBase64)
- if err != nil {
- ctx.Error(http.StatusUnprocessableEntity, "Invalid base64 content", err)
- return
- }
- changeRepoFile := &files_service.ChangeRepoFile{
- Operation: file.Operation,
- TreePath: file.Path,
- FromTreePath: file.FromPath,
- ContentReader: contentReader,
- SHA: file.SHA,
- }
- files = append(files, changeRepoFile)
- }
-
- opts := &files_service.ChangeRepoFilesOptions{
- Files: files,
- Message: apiOpts.Message,
- OldBranch: apiOpts.BranchName,
- NewBranch: apiOpts.NewBranchName,
- Committer: &files_service.IdentityOptions{
- Name: apiOpts.Committer.Name,
- Email: apiOpts.Committer.Email,
- },
- Author: &files_service.IdentityOptions{
- Name: apiOpts.Author.Name,
- Email: apiOpts.Author.Email,
- },
- Dates: &files_service.CommitDateOptions{
- Author: apiOpts.Dates.Author,
- Committer: apiOpts.Dates.Committer,
- },
- Signoff: apiOpts.Signoff,
- }
- if opts.Dates.Author.IsZero() {
- opts.Dates.Author = time.Now()
- }
- if opts.Dates.Committer.IsZero() {
- opts.Dates.Committer = time.Now()
- }
-
- if opts.Message == "" {
- opts.Message = changeFilesCommitMessage(ctx, files)
- }
-
- if filesResponse, err := createOrUpdateFiles(ctx, opts); err != nil {
- handleCreateOrUpdateFileError(ctx, err)
- } else {
- ctx.JSON(http.StatusCreated, filesResponse)
- }
- }
-
- // CreateFile handles API call for creating a file
- func CreateFile(ctx *context.APIContext) {
- // swagger:operation POST /repos/{owner}/{repo}/contents/{filepath} repository repoCreateFile
- // ---
- // summary: Create a file in a repository
- // consumes:
- // - application/json
- // produces:
- // - application/json
- // parameters:
- // - name: owner
- // in: path
- // description: owner of the repo
- // type: string
- // required: true
- // - name: repo
- // in: path
- // description: name of the repo
- // type: string
- // required: true
- // - name: filepath
- // in: path
- // description: path of the file to create
- // type: string
- // required: true
- // - name: body
- // in: body
- // required: true
- // schema:
- // "$ref": "#/definitions/CreateFileOptions"
- // responses:
- // "201":
- // "$ref": "#/responses/FileResponse"
- // "403":
- // "$ref": "#/responses/error"
- // "404":
- // "$ref": "#/responses/notFound"
- // "422":
- // "$ref": "#/responses/error"
- // "423":
- // "$ref": "#/responses/repoArchivedError"
-
- apiOpts := web.GetForm(ctx).(*api.CreateFileOptions)
-
- if apiOpts.BranchName == "" {
- apiOpts.BranchName = ctx.Repo.Repository.DefaultBranch
- }
-
- contentReader, err := base64Reader(apiOpts.ContentBase64)
- if err != nil {
- ctx.Error(http.StatusUnprocessableEntity, "Invalid base64 content", err)
- return
- }
-
- opts := &files_service.ChangeRepoFilesOptions{
- Files: []*files_service.ChangeRepoFile{
- {
- Operation: "create",
- TreePath: ctx.Params("*"),
- ContentReader: contentReader,
- },
- },
- Message: apiOpts.Message,
- OldBranch: apiOpts.BranchName,
- NewBranch: apiOpts.NewBranchName,
- Committer: &files_service.IdentityOptions{
- Name: apiOpts.Committer.Name,
- Email: apiOpts.Committer.Email,
- },
- Author: &files_service.IdentityOptions{
- Name: apiOpts.Author.Name,
- Email: apiOpts.Author.Email,
- },
- Dates: &files_service.CommitDateOptions{
- Author: apiOpts.Dates.Author,
- Committer: apiOpts.Dates.Committer,
- },
- Signoff: apiOpts.Signoff,
- }
- if opts.Dates.Author.IsZero() {
- opts.Dates.Author = time.Now()
- }
- if opts.Dates.Committer.IsZero() {
- opts.Dates.Committer = time.Now()
- }
-
- if opts.Message == "" {
- opts.Message = changeFilesCommitMessage(ctx, opts.Files)
- }
-
- if filesResponse, err := createOrUpdateFiles(ctx, opts); err != nil {
- handleCreateOrUpdateFileError(ctx, err)
- } else {
- fileResponse := files_service.GetFileResponseFromFilesResponse(filesResponse, 0)
- ctx.JSON(http.StatusCreated, fileResponse)
- }
- }
-
- // UpdateFile handles API call for updating a file
- func UpdateFile(ctx *context.APIContext) {
- // swagger:operation PUT /repos/{owner}/{repo}/contents/{filepath} repository repoUpdateFile
- // ---
- // summary: Update a file in a repository
- // consumes:
- // - application/json
- // produces:
- // - application/json
- // parameters:
- // - name: owner
- // in: path
- // description: owner of the repo
- // type: string
- // required: true
- // - name: repo
- // in: path
- // description: name of the repo
- // type: string
- // required: true
- // - name: filepath
- // in: path
- // description: path of the file to update
- // type: string
- // required: true
- // - name: body
- // in: body
- // required: true
- // schema:
- // "$ref": "#/definitions/UpdateFileOptions"
- // responses:
- // "200":
- // "$ref": "#/responses/FileResponse"
- // "403":
- // "$ref": "#/responses/error"
- // "404":
- // "$ref": "#/responses/notFound"
- // "422":
- // "$ref": "#/responses/error"
- // "423":
- // "$ref": "#/responses/repoArchivedError"
- apiOpts := web.GetForm(ctx).(*api.UpdateFileOptions)
- if ctx.Repo.Repository.IsEmpty {
- ctx.Error(http.StatusUnprocessableEntity, "RepoIsEmpty", fmt.Errorf("repo is empty"))
- return
- }
-
- if apiOpts.BranchName == "" {
- apiOpts.BranchName = ctx.Repo.Repository.DefaultBranch
- }
-
- contentReader, err := base64Reader(apiOpts.ContentBase64)
- if err != nil {
- ctx.Error(http.StatusUnprocessableEntity, "Invalid base64 content", err)
- return
- }
-
- opts := &files_service.ChangeRepoFilesOptions{
- Files: []*files_service.ChangeRepoFile{
- {
- Operation: "update",
- ContentReader: contentReader,
- SHA: apiOpts.SHA,
- FromTreePath: apiOpts.FromPath,
- TreePath: ctx.Params("*"),
- },
- },
- Message: apiOpts.Message,
- OldBranch: apiOpts.BranchName,
- NewBranch: apiOpts.NewBranchName,
- Committer: &files_service.IdentityOptions{
- Name: apiOpts.Committer.Name,
- Email: apiOpts.Committer.Email,
- },
- Author: &files_service.IdentityOptions{
- Name: apiOpts.Author.Name,
- Email: apiOpts.Author.Email,
- },
- Dates: &files_service.CommitDateOptions{
- Author: apiOpts.Dates.Author,
- Committer: apiOpts.Dates.Committer,
- },
- Signoff: apiOpts.Signoff,
- }
- if opts.Dates.Author.IsZero() {
- opts.Dates.Author = time.Now()
- }
- if opts.Dates.Committer.IsZero() {
- opts.Dates.Committer = time.Now()
- }
-
- if opts.Message == "" {
- opts.Message = changeFilesCommitMessage(ctx, opts.Files)
- }
-
- if filesResponse, err := createOrUpdateFiles(ctx, opts); err != nil {
- handleCreateOrUpdateFileError(ctx, err)
- } else {
- fileResponse := files_service.GetFileResponseFromFilesResponse(filesResponse, 0)
- ctx.JSON(http.StatusOK, fileResponse)
- }
- }
-
- func handleCreateOrUpdateFileError(ctx *context.APIContext, err error) {
- if models.IsErrUserCannotCommit(err) || models.IsErrFilePathProtected(err) {
- ctx.Error(http.StatusForbidden, "Access", err)
- return
- }
- if git_model.IsErrBranchAlreadyExists(err) || models.IsErrFilenameInvalid(err) || models.IsErrSHADoesNotMatch(err) ||
- models.IsErrFilePathInvalid(err) || models.IsErrRepoFileAlreadyExists(err) {
- ctx.Error(http.StatusUnprocessableEntity, "Invalid", err)
- return
- }
- if git_model.IsErrBranchNotExist(err) || git.IsErrBranchNotExist(err) {
- ctx.Error(http.StatusNotFound, "BranchDoesNotExist", err)
- return
- }
-
- ctx.Error(http.StatusInternalServerError, "UpdateFile", err)
- }
-
- // Called from both CreateFile or UpdateFile to handle both
- func createOrUpdateFiles(ctx *context.APIContext, opts *files_service.ChangeRepoFilesOptions) (*api.FilesResponse, error) {
- if !canWriteFiles(ctx, opts.OldBranch) {
- return nil, repo_model.ErrUserDoesNotHaveAccessToRepo{
- UserID: ctx.Doer.ID,
- RepoName: ctx.Repo.Repository.LowerName,
- }
- }
-
- return files_service.ChangeRepoFiles(ctx, ctx.Repo.Repository, ctx.Doer, opts)
- }
-
- // format commit message if empty
- func changeFilesCommitMessage(ctx *context.APIContext, files []*files_service.ChangeRepoFile) string {
- var (
- createFiles []string
- updateFiles []string
- deleteFiles []string
- )
- for _, file := range files {
- switch file.Operation {
- case "create":
- createFiles = append(createFiles, file.TreePath)
- case "update":
- updateFiles = append(updateFiles, file.TreePath)
- case "delete":
- deleteFiles = append(deleteFiles, file.TreePath)
- }
- }
- message := ""
- if len(createFiles) != 0 {
- message += ctx.Locale.TrString("repo.editor.add", strings.Join(createFiles, ", ")+"\n")
- }
- if len(updateFiles) != 0 {
- message += ctx.Locale.TrString("repo.editor.update", strings.Join(updateFiles, ", ")+"\n")
- }
- if len(deleteFiles) != 0 {
- message += ctx.Locale.TrString("repo.editor.delete", strings.Join(deleteFiles, ", "))
- }
- return strings.Trim(message, "\n")
- }
-
- // DeleteFile Delete a file in a repository
- func DeleteFile(ctx *context.APIContext) {
- // swagger:operation DELETE /repos/{owner}/{repo}/contents/{filepath} repository repoDeleteFile
- // ---
- // summary: Delete a file in a repository
- // consumes:
- // - application/json
- // produces:
- // - application/json
- // parameters:
- // - name: owner
- // in: path
- // description: owner of the repo
- // type: string
- // required: true
- // - name: repo
- // in: path
- // description: name of the repo
- // type: string
- // required: true
- // - name: filepath
- // in: path
- // description: path of the file to delete
- // type: string
- // required: true
- // - name: body
- // in: body
- // required: true
- // schema:
- // "$ref": "#/definitions/DeleteFileOptions"
- // responses:
- // "200":
- // "$ref": "#/responses/FileDeleteResponse"
- // "400":
- // "$ref": "#/responses/error"
- // "403":
- // "$ref": "#/responses/error"
- // "404":
- // "$ref": "#/responses/error"
- // "423":
- // "$ref": "#/responses/repoArchivedError"
-
- apiOpts := web.GetForm(ctx).(*api.DeleteFileOptions)
- if !canWriteFiles(ctx, apiOpts.BranchName) {
- ctx.Error(http.StatusForbidden, "DeleteFile", repo_model.ErrUserDoesNotHaveAccessToRepo{
- UserID: ctx.Doer.ID,
- RepoName: ctx.Repo.Repository.LowerName,
- })
- return
- }
-
- if apiOpts.BranchName == "" {
- apiOpts.BranchName = ctx.Repo.Repository.DefaultBranch
- }
-
- opts := &files_service.ChangeRepoFilesOptions{
- Files: []*files_service.ChangeRepoFile{
- {
- Operation: "delete",
- SHA: apiOpts.SHA,
- TreePath: ctx.Params("*"),
- },
- },
- Message: apiOpts.Message,
- OldBranch: apiOpts.BranchName,
- NewBranch: apiOpts.NewBranchName,
- Committer: &files_service.IdentityOptions{
- Name: apiOpts.Committer.Name,
- Email: apiOpts.Committer.Email,
- },
- Author: &files_service.IdentityOptions{
- Name: apiOpts.Author.Name,
- Email: apiOpts.Author.Email,
- },
- Dates: &files_service.CommitDateOptions{
- Author: apiOpts.Dates.Author,
- Committer: apiOpts.Dates.Committer,
- },
- Signoff: apiOpts.Signoff,
- }
- if opts.Dates.Author.IsZero() {
- opts.Dates.Author = time.Now()
- }
- if opts.Dates.Committer.IsZero() {
- opts.Dates.Committer = time.Now()
- }
-
- if opts.Message == "" {
- opts.Message = changeFilesCommitMessage(ctx, opts.Files)
- }
-
- if filesResponse, err := files_service.ChangeRepoFiles(ctx, ctx.Repo.Repository, ctx.Doer, opts); err != nil {
- if git.IsErrBranchNotExist(err) || models.IsErrRepoFileDoesNotExist(err) || git.IsErrNotExist(err) {
- ctx.Error(http.StatusNotFound, "DeleteFile", err)
- return
- } else if git_model.IsErrBranchAlreadyExists(err) ||
- models.IsErrFilenameInvalid(err) ||
- models.IsErrSHADoesNotMatch(err) ||
- models.IsErrCommitIDDoesNotMatch(err) ||
- models.IsErrSHAOrCommitIDNotProvided(err) {
- ctx.Error(http.StatusBadRequest, "DeleteFile", err)
- return
- } else if models.IsErrUserCannotCommit(err) {
- ctx.Error(http.StatusForbidden, "DeleteFile", err)
- return
- }
- ctx.Error(http.StatusInternalServerError, "DeleteFile", err)
- } else {
- fileResponse := files_service.GetFileResponseFromFilesResponse(filesResponse, 0)
- ctx.JSON(http.StatusOK, fileResponse) // FIXME on APIv2: return http.StatusNoContent
- }
- }
-
- // GetContents Get the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir
- func GetContents(ctx *context.APIContext) {
- // swagger:operation GET /repos/{owner}/{repo}/contents/{filepath} repository repoGetContents
- // ---
- // summary: Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir
- // produces:
- // - application/json
- // parameters:
- // - name: owner
- // in: path
- // description: owner of the repo
- // type: string
- // required: true
- // - name: repo
- // in: path
- // description: name of the repo
- // type: string
- // required: true
- // - name: filepath
- // in: path
- // description: path of the dir, file, symlink or submodule in the repo
- // type: string
- // required: true
- // - name: ref
- // in: query
- // description: "The name of the commit/branch/tag. Default the repository’s default branch (usually master)"
- // type: string
- // required: false
- // responses:
- // "200":
- // "$ref": "#/responses/ContentsResponse"
- // "404":
- // "$ref": "#/responses/notFound"
-
- if !canReadFiles(ctx.Repo) {
- ctx.Error(http.StatusInternalServerError, "GetContentsOrList", repo_model.ErrUserDoesNotHaveAccessToRepo{
- UserID: ctx.Doer.ID,
- RepoName: ctx.Repo.Repository.LowerName,
- })
- return
- }
-
- treePath := ctx.Params("*")
- ref := ctx.FormTrim("ref")
-
- if fileList, err := files_service.GetContentsOrList(ctx, ctx.Repo.Repository, treePath, ref); err != nil {
- if git.IsErrNotExist(err) {
- ctx.NotFound("GetContentsOrList", err)
- return
- }
- ctx.Error(http.StatusInternalServerError, "GetContentsOrList", err)
- } else {
- ctx.JSON(http.StatusOK, fileList)
- }
- }
-
- // GetContentsList Get the metadata of all the entries of the root dir
- func GetContentsList(ctx *context.APIContext) {
- // swagger:operation GET /repos/{owner}/{repo}/contents repository repoGetContentsList
- // ---
- // summary: Gets the metadata of all the entries of the root dir
- // produces:
- // - application/json
- // parameters:
- // - name: owner
- // in: path
- // description: owner of the repo
- // type: string
- // required: true
- // - name: repo
- // in: path
- // description: name of the repo
- // type: string
- // required: true
- // - name: ref
- // in: query
- // description: "The name of the commit/branch/tag. Default the repository’s default branch (usually master)"
- // type: string
- // required: false
- // responses:
- // "200":
- // "$ref": "#/responses/ContentsListResponse"
- // "404":
- // "$ref": "#/responses/notFound"
-
- // same as GetContents(), this function is here because swagger fails if path is empty in GetContents() interface
- GetContents(ctx)
- }
|