com.gitblit.DownloadZipServlet.java Source code

Introduction

Here is the source code for com.gitblit.DownloadZipServlet.java

Source

/*
 * Copyright 2011 gitblit.com.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.gitblit;

import java.io.IOException;
import java.text.MessageFormat;
import java.text.ParseException;
import java.util.Date;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletResponse;

import org.eclipse.jgit.lib.Repository;
import org.eclipse.jgit.revwalk.RevCommit;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.gitblit.utils.JGitUtils;
import com.gitblit.utils.MarkdownUtils;
import com.gitblit.utils.StringUtils;

/**
 * Streams out a zip file from the specified repository for any tree path at any
 * revision.
 * 
 * @author James Moger
 * 
 */
public class DownloadZipServlet extends HttpServlet {

    private static final long serialVersionUID = 1L;

    private transient Logger logger = LoggerFactory.getLogger(DownloadZipServlet.class);

    public DownloadZipServlet() {
        super();
    }

    /**
     * Returns an url to this servlet for the specified parameters.
     * 
     * @param baseURL
     * @param repository
     * @param objectId
     * @param path
     * @return an url
     */
    public static String asLink(String baseURL, String repository, String objectId, String path) {
        if (baseURL.length() > 0 && baseURL.charAt(baseURL.length() - 1) == '/') {
            baseURL = baseURL.substring(0, baseURL.length() - 1);
        }
        return baseURL + Constants.ZIP_PATH + "?r=" + repository + (path == null ? "" : ("&p=" + path))
                + (objectId == null ? "" : ("&h=" + objectId));
    }

    /**
     * Creates a zip stream from the repository of the requested data.
     * 
     * @param request
     * @param response
     * @throws javax.servlet.ServletException
     * @throws java.io.IOException
     */
    private void processRequest(javax.servlet.http.HttpServletRequest request,
            javax.servlet.http.HttpServletResponse response)
            throws javax.servlet.ServletException, java.io.IOException {
        if (!GitBlit.getBoolean(Keys.web.allowZipDownloads, true)) {
            logger.warn("Zip downloads are disabled");
            response.sendError(HttpServletResponse.SC_FORBIDDEN);
            return;
        }

        String repository = request.getParameter("r");
        String basePath = request.getParameter("p");
        String objectId = request.getParameter("h");

        try {
            String name = repository;
            if (name.indexOf('/') > -1) {
                name = name.substring(name.lastIndexOf('/') + 1);
            }

            if (!StringUtils.isEmpty(basePath)) {
                name += "-" + basePath.replace('/', '_');
            }
            if (!StringUtils.isEmpty(objectId)) {
                name += "-" + objectId;
            }

            Repository r = GitBlit.self().getRepository(repository);
            if (r == null) {
                error(response, MessageFormat.format("# Error\nFailed to find repository {0}", repository));
                return;
            }
            RevCommit commit = JGitUtils.getCommit(r, objectId);
            if (commit == null) {
                error(response, MessageFormat.format("# Error\nFailed to find commit {0}", objectId));
                r.close();
                return;
            }
            Date date = JGitUtils.getCommitDate(commit);

            String contentType = "application/octet-stream";
            response.setContentType(contentType + "; charset=" + response.getCharacterEncoding());
            response.setHeader("Content-Disposition", "attachment; filename=\"" + name + ".zip" + "\"");
            response.setDateHeader("Last-Modified", date.getTime());
            response.setHeader("Cache-Control", "no-cache");
            response.setHeader("Pragma", "no-cache");
            response.setDateHeader("Expires", 0);

            try {
                JGitUtils.zip(r, basePath, objectId, response.getOutputStream());
                response.flushBuffer();
            } catch (Throwable t) {
                logger.error("Failed to write attachment to client", t);
            }

            // close the repository
            r.close();
        } catch (Throwable t) {
            logger.error("Failed to write attachment to client", t);
        }
    }

    private void error(HttpServletResponse response, String mkd)
            throws ServletException, IOException, ParseException {
        String content = MarkdownUtils.transformMarkdown(mkd);
        response.setContentType("text/html; charset=" + Constants.ENCODING);
        response.getWriter().write(content);
    }

    @Override
    protected void doPost(javax.servlet.http.HttpServletRequest request,
            javax.servlet.http.HttpServletResponse response)
            throws javax.servlet.ServletException, java.io.IOException {
        processRequest(request, response);
    }

    @Override
    protected void doGet(javax.servlet.http.HttpServletRequest request,
            javax.servlet.http.HttpServletResponse response)
            throws javax.servlet.ServletException, java.io.IOException {
        processRequest(request, response);
    }
}