1 /*
2 * Copyright (C) 2015, 2017, Dariusz Luksza <dariusz@luksza.org>
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
44 package org.eclipse.jgit.lfs.lib;
45
46 import java.io.IOException;
47
48 import org.eclipse.jgit.errors.IncorrectObjectTypeException;
49 import org.eclipse.jgit.errors.MissingObjectException;
50 import org.eclipse.jgit.lfs.LfsPointer;
51 import org.eclipse.jgit.lib.ObjectId;
52 import org.eclipse.jgit.lib.ObjectLoader;
53 import org.eclipse.jgit.lib.ObjectStream;
54 import org.eclipse.jgit.treewalk.TreeWalk;
55 import org.eclipse.jgit.treewalk.filter.TreeFilter;
56
57 /**
58 * Detects Large File pointers, as described in [1] in Git repository.
59 *
60 * [1] https://github.com/github/git-lfs/blob/master/docs/spec.md
61 *
62 * @since 4.7
63 */
64 public class LfsPointerFilter extends TreeFilter {
65
66 private LfsPointer pointer;
67
68 /**
69 * @return {@link LfsPointer} or {@code null}
70 */
71 public LfsPointer getPointer() {
72 return pointer;
73 }
74
75 @Override
76 public boolean include(TreeWalk walk) throws MissingObjectException,
77 IncorrectObjectTypeException, IOException {
78 pointer = null;
79 if (walk.isSubtree()) {
80 return walk.isRecursive();
81 }
82 ObjectId objectId = walk.getObjectId(0);
83 ObjectLoader object = walk.getObjectReader().open(objectId);
84 if (object.getSize() > 1024) {
85 return false;
86 }
87
88 try (ObjectStream stream = object.openStream()) {
89 pointer = LfsPointer.parseLfsPointer(stream);
90 return pointer != null;
91 }
92 }
93
94 @Override
95 public boolean shouldBeRecursive() {
96 return false;
97 }
98
99 @Override
100 public TreeFilter clone() {
101 return new LfsPointerFilter();
102 }
103 }