View Javadoc
1   /*
2    * Copyright (C) 2015, Sasa Zivkov <sasa.zivkov@sap.com>
3    * and other copyright owners as documented in the project's IP log.
4    *
5    * This program and the accompanying materials are made available
6    * under the terms of the Eclipse Distribution License v1.0 which
7    * accompanies this distribution, is reproduced below, and is
8    * available at http://www.eclipse.org/org/documents/edl-v10.php
9    *
10   * All rights reserved.
11   *
12   * Redistribution and use in source and binary forms, with or
13   * without modification, are permitted provided that the following
14   * conditions are met:
15   *
16   * - Redistributions of source code must retain the above copyright
17   *   notice, this list of conditions and the following disclaimer.
18   *
19   * - Redistributions in binary form must reproduce the above
20   *   copyright notice, this list of conditions and the following
21   *   disclaimer in the documentation and/or other materials provided
22   *   with the distribution.
23   *
24   * - Neither the name of the Eclipse Foundation, Inc. nor the
25   *   names of its contributors may be used to endorse or promote
26   *   products derived from this software without specific prior
27   *   written permission.
28   *
29   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30   * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42   */
43  package org.eclipse.jgit.lfs.server;
44  
45  import static java.nio.charset.StandardCharsets.UTF_8;
46  import static javax.servlet.http.HttpServletResponse.SC_OK;
47  import static javax.servlet.http.HttpServletResponse.SC_SERVICE_UNAVAILABLE;
48  
49  import java.io.BufferedReader;
50  import java.io.BufferedWriter;
51  import java.io.IOException;
52  import java.io.InputStreamReader;
53  import java.io.OutputStreamWriter;
54  import java.io.Reader;
55  import java.io.Writer;
56  import java.util.List;
57  
58  import javax.servlet.ServletException;
59  import javax.servlet.http.HttpServlet;
60  import javax.servlet.http.HttpServletRequest;
61  import javax.servlet.http.HttpServletResponse;
62  
63  import com.google.gson.FieldNamingPolicy;
64  import com.google.gson.Gson;
65  import com.google.gson.GsonBuilder;
66  
67  /**
68   * LFS protocol handler implementing the LFS batch API [1]
69   *
70   * [1] https://github.com/github/git-lfs/blob/master/docs/api/http-v1-batch.md
71   *
72   * @since 4.3
73   */
74  public abstract class LfsProtocolServlet extends HttpServlet {
75  
76  	private static final long serialVersionUID = 1L;
77  
78  	private static final String CONTENTTYPE_VND_GIT_LFS_JSON = "application/vnd.git-lfs+json"; //$NON-NLS-1$
79  
80  	private Gson gson = createGson();
81  
82  	/**
83  	 * Get the large file repository
84  	 *
85  	 * @return the large file repository storing large files
86  	 */
87  	protected abstract LargeFileRepository getLargeFileRepository();
88  
89  	@Override
90  	protected void doPost(HttpServletRequest req, HttpServletResponse res)
91  			throws ServletException, IOException {
92  		res.setStatus(SC_OK);
93  		res.setContentType(CONTENTTYPE_VND_GIT_LFS_JSON);
94  
95  		Writer w = new BufferedWriter(
96  				new OutputStreamWriter(res.getOutputStream(), UTF_8));
97  
98  		Reader r = new BufferedReader(new InputStreamReader(req.getInputStream(), UTF_8));
99  		LfsRequest request = gson.fromJson(r, LfsRequest.class);
100 
101 		LargeFileRepository repo = getLargeFileRepository();
102 		if (repo == null) {
103 			res.setStatus(SC_SERVICE_UNAVAILABLE);
104 			return;
105 		}
106 
107 		TransferHandler handler = TransferHandler
108 				.forOperation(request.operation, repo, request.objects);
109 		gson.toJson(handler.process(), w);
110 		w.flush();
111 	}
112 
113 	private static class LfsRequest {
114 		String operation;
115 
116 		List<LfsObject> objects;
117 	}
118 
119 	private static Gson createGson() {
120 		GsonBuilder gb = new GsonBuilder()
121 				.setFieldNamingPolicy(
122 						FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES)
123 				.setPrettyPrinting().disableHtmlEscaping();
124 		return gb.create();
125 	}
126 }