repositories.rb 7.49 KB
Newer Older
1 2
require 'mime/types'

3 4 5 6
module API
  # Projects API
  class Repositories < Grape::API
    before { authenticate! }
7
    before { authorize! :download_code, user_project }
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49

    resource :projects do
      helpers do
        def handle_project_member_errors(errors)
          if errors[:project_access].any?
            error!(errors[:project_access], 422)
          end
          not_found!
        end
      end

      # Get a project repository branches
      #
      # Parameters:
      #   id (required) - The ID of a project
      # Example Request:
      #   GET /projects/:id/repository/branches
      get ":id/repository/branches" do
        present user_project.repo.heads.sort_by(&:name), with: Entities::RepoObject, project: user_project
      end

      # Get a single branch
      #
      # Parameters:
      #   id (required) - The ID of a project
      #   branch (required) - The name of the branch
      # Example Request:
      #   GET /projects/:id/repository/branches/:branch
      get ":id/repository/branches/:branch" do
        @branch = user_project.repo.heads.find { |item| item.name == params[:branch] }
        not_found!("Branch does not exist") if @branch.nil?
        present @branch, with: Entities::RepoObject, project: user_project
      end

      # Protect a single branch
      #
      # Parameters:
      #   id (required) - The ID of a project
      #   branch (required) - The name of the branch
      # Example Request:
      #   PUT /projects/:id/repository/branches/:branch/protect
      put ":id/repository/branches/:branch/protect" do
50
        authorize_admin_project
51

52 53
        @branch = user_project.repository.find_branch(params[:branch])
        not_found! unless @branch
skv's avatar
skv committed
54
        protected_branch = user_project.protected_branches.find_by(name: @branch.name)
55
        user_project.protected_branches.create(name: @branch.name) unless protected_branch
56 57 58 59 60 61 62 63 64 65 66 67

        present @branch, with: Entities::RepoObject, project: user_project
      end

      # Unprotect a single branch
      #
      # Parameters:
      #   id (required) - The ID of a project
      #   branch (required) - The name of the branch
      # Example Request:
      #   PUT /projects/:id/repository/branches/:branch/unprotect
      put ":id/repository/branches/:branch/unprotect" do
68
        authorize_admin_project
69

70 71
        @branch = user_project.repository.find_branch(params[:branch])
        not_found! unless @branch
skv's avatar
skv committed
72
        protected_branch = user_project.protected_branches.find_by(name: @branch.name)
73
        protected_branch.destroy if protected_branch
74 75 76 77 78 79 80 81 82 83 84

        present @branch, with: Entities::RepoObject, project: user_project
      end

      # Get a project repository tags
      #
      # Parameters:
      #   id (required) - The ID of a project
      # Example Request:
      #   GET /projects/:id/repository/tags
      get ":id/repository/tags" do
85
        present user_project.repo.tags.sort_by(&:name).reverse, with: Entities::RepoObject, project: user_project
86 87 88 89 90 91 92 93 94 95
      end

      # Get a project repository commits
      #
      # Parameters:
      #   id (required) - The ID of a project
      #   ref_name (optional) - The name of a repository branch or tag, if not given the default branch is used
      # Example Request:
      #   GET /projects/:id/repository/commits
      get ":id/repository/commits" do
96
        page = (params[:page] || 0).to_i
97 98 99 100 101 102 103
        per_page = (params[:per_page] || 20).to_i
        ref = params[:ref_name] || user_project.try(:default_branch) || 'master'

        commits = user_project.repository.commits(ref, nil, per_page, page * per_page)
        present commits, with: Entities::RepoCommit
      end

104 105 106 107
      # Get a specific commit of a project
      #
      # Parameters:
      #   id (required) - The ID of a project
108 109 110 111 112 113 114
      #   sha (required) - The commit hash or name of a repository branch or tag
      # Example Request:
      #   GET /projects/:id/repository/commits/:sha
      get ":id/repository/commits/:sha" do
        sha = params[:sha]
        commit = user_project.repository.commit(sha)
        not_found! "Commit" unless commit
115
        present commit, with: Entities::RepoCommitDetail
116 117 118 119 120 121
      end

      # Get the diff for a specific commit of a project
      #
      # Parameters:
      #   id (required) - The ID of a project
122 123
      #   sha (required) - The commit or branch name
      # Example Request:
124 125
      #   GET /projects/:id/repository/commits/:sha/diff
      get ":id/repository/commits/:sha/diff" do
126
        sha = params[:sha]
127 128 129
        commit = user_project.repository.commit(sha)
        not_found! "Commit" unless commit
        commit.diffs
130 131
      end

132 133 134 135 136 137 138 139 140 141 142 143
      # Get a project repository tree
      #
      # Parameters:
      #   id (required) - The ID of a project
      #   ref_name (optional) - The name of a repository branch or tag, if not given the default branch is used
      # Example Request:
      #   GET /projects/:id/repository/tree
      get ":id/repository/tree" do
        ref = params[:ref_name] || user_project.try(:default_branch) || 'master'
        path = params[:path] || nil

        commit = user_project.repository.commit(ref)
144
        tree = user_project.repository.tree(commit.id, path)
145

146
        present tree.sorted_entries, with: Entities::RepoTreeObject
147 148
      end

149 150 151 152 153 154 155
      # Get a raw file contents
      #
      # Parameters:
      #   id (required) - The ID of a project
      #   sha (required) - The commit or branch name
      #   filepath (required) - The path to the file to display
      # Example Request:
156 157
      #   GET /projects/:id/repository/blobs/:sha
      get [ ":id/repository/blobs/:sha", ":id/repository/commits/:sha/blob" ] do
158 159 160 161 162 163 164 165 166
        required_attributes! [:filepath]

        ref = params[:sha]

        repo = user_project.repository

        commit = repo.commit(ref)
        not_found! "Commit" unless commit

167 168
        blob = Gitlab::Git::Blob.find(repo, commit.id, params[:filepath])
        not_found! "File" unless blob
169

170
        env['api.format'] = :txt
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192

        content_type blob.mime_type
        present blob.data
      end

      # Get a raw blob contents by blob sha
      #
      # Parameters:
      #   id (required) - The ID of a project
      #   sha (required) - The blob's sha
      # Example Request:
      #   GET /projects/:id/repository/raw_blobs/:sha
      get ":id/repository/raw_blobs/:sha" do
        ref = params[:sha]

        repo = user_project.repository

        blob = Gitlab::Git::Blob.raw(repo, ref)

        not_found! "Blob" unless blob

        env['api.format'] = :txt
193

194 195 196
        content_type blob.mime_type
        present blob.data
      end
197 198 199 200 201

      # Get a an archive of the repository
      #
      # Parameters:
      #   id (required) - The ID of a project
202
      #   sha (optional) - the commit sha to download defaults to the tip of the default branch
203 204
      # Example Request:
      #   GET /projects/:id/repository/archive
205
      get ":id/repository/archive", requirements: { format: Gitlab::Regex.archive_formats_regex } do
206 207 208
        authorize! :download_code, user_project
        repo = user_project.repository
        ref = params[:sha]
209
        format = params[:format]
210 211
        storage_path = Rails.root.join("tmp", "repositories")

212
        file_path = repo.archive_repo(ref, storage_path, format)
213 214 215
        if file_path && File.exists?(file_path)
          data = File.open(file_path, 'rb').read

216 217 218
          header["Content-Disposition"] = "attachment; filename=\"#{File.basename(file_path)}\""

          content_type MIME::Types.type_for(file_path).first.content_type
219 220 221

          env['api.format'] = :binary

222 223 224 225 226
          present data
        else
          not_found!
        end
      end
227 228 229
    end
  end
end