View Javadoc
1   /*
2    * Copyright (C) 2008-2009, Google Inc.
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.transport;
45  
46  import java.util.HashMap;
47  import java.util.Map;
48  
49  import org.eclipse.jgit.lib.Config;
50  import org.eclipse.jgit.lib.Config.SectionParser;
51  import org.eclipse.jgit.lib.ObjectChecker;
52  import org.eclipse.jgit.lib.Ref;
53  import org.eclipse.jgit.lib.Repository;
54  import org.eclipse.jgit.util.SystemReader;
55  
56  /**
57   * The standard "transfer", "fetch", "receive", and "uploadpack" configuration
58   * parameters.
59   */
60  public class TransferConfig {
61  	/** Key for {@link Config#get(SectionParser)}. */
62  	public static final Config.SectionParser<TransferConfig> KEY = new SectionParser<TransferConfig>() {
63  		public TransferConfig parse(final Config cfg) {
64  			return new TransferConfig(cfg);
65  		}
66  	};
67  
68  	private final boolean checkReceivedObjects;
69  	private final boolean allowLeadingZeroFileMode;
70  	private final boolean allowInvalidPersonIdent;
71  	private final boolean safeForWindows;
72  	private final boolean safeForMacOS;
73  	private final boolean allowTipSha1InWant;
74  	private final boolean allowReachableSha1InWant;
75  	private final String[] hideRefs;
76  
77  	TransferConfig(final Repository db) {
78  		this(db.getConfig());
79  	}
80  
81  	private TransferConfig(final Config rc) {
82  		checkReceivedObjects = rc.getBoolean(
83  				"fetch", "fsckobjects", //$NON-NLS-1$ //$NON-NLS-2$
84  				rc.getBoolean("transfer", "fsckobjects", false)); //$NON-NLS-1$ //$NON-NLS-2$
85  		allowLeadingZeroFileMode = checkReceivedObjects
86  				&& rc.getBoolean("fsck", "allowLeadingZeroFileMode", false); //$NON-NLS-1$ //$NON-NLS-2$
87  		allowInvalidPersonIdent = checkReceivedObjects
88  				&& rc.getBoolean("fsck", "allowInvalidPersonIdent", false); //$NON-NLS-1$ //$NON-NLS-2$
89  		safeForWindows = checkReceivedObjects
90  				&& rc.getBoolean("fsck", "safeForWindows", //$NON-NLS-1$ //$NON-NLS-2$
91  						SystemReader.getInstance().isWindows());
92  		safeForMacOS = checkReceivedObjects
93  				&& rc.getBoolean("fsck", "safeForMacOS", //$NON-NLS-1$ //$NON-NLS-2$
94  						SystemReader.getInstance().isMacOS());
95  
96  		allowTipSha1InWant = rc.getBoolean(
97  				"uploadpack", "allowtipsha1inwant", false); //$NON-NLS-1$ //$NON-NLS-2$
98  		allowReachableSha1InWant = rc.getBoolean(
99  				"uploadpack", "allowreachablesha1inwant", false); //$NON-NLS-1$ //$NON-NLS-2$
100 		hideRefs = rc.getStringList("uploadpack", null, "hiderefs"); //$NON-NLS-1$ //$NON-NLS-2$
101 	}
102 
103 	/**
104 	 * @return checker to verify fetched objects, or null if checking is not
105 	 *         enabled in the repository configuration.
106 	 * @since 3.6
107 	 */
108 	public ObjectChecker newObjectChecker() {
109 		if (!checkReceivedObjects)
110 			return null;
111 		return new ObjectChecker()
112 			.setAllowLeadingZeroFileMode(allowLeadingZeroFileMode)
113 			.setAllowInvalidPersonIdent(allowInvalidPersonIdent)
114 			.setSafeForWindows(safeForWindows)
115 			.setSafeForMacOS(safeForMacOS);
116 	}
117 
118 	/**
119 	 * @return allow clients to request non-advertised tip SHA-1s?
120 	 * @since 3.1
121 	 */
122 	public boolean isAllowTipSha1InWant() {
123 		return allowTipSha1InWant;
124 	}
125 
126 	/**
127 	 * @return allow clients to request non-tip SHA-1s?
128 	 * @since 4.1
129 	 */
130 	public boolean isAllowReachableSha1InWant() {
131 		return allowReachableSha1InWant;
132 	}
133 
134 	/**
135 	 * @return {@link RefFilter} respecting configured hidden refs.
136 	 * @since 3.1
137 	 */
138 	public RefFilter getRefFilter() {
139 		if (hideRefs.length == 0)
140 			return RefFilter.DEFAULT;
141 
142 		return new RefFilter() {
143 			public Map<String, Ref> filter(Map<String, Ref> refs) {
144 				Map<String, Ref> result = new HashMap<String, Ref>();
145 				for (Map.Entry<String, Ref> e : refs.entrySet()) {
146 					boolean add = true;
147 					for (String hide : hideRefs) {
148 						if (e.getKey().equals(hide) || prefixMatch(hide, e.getKey())) {
149 							add = false;
150 							break;
151 						}
152 					}
153 					if (add)
154 						result.put(e.getKey(), e.getValue());
155 				}
156 				return result;
157 			}
158 
159 			private boolean prefixMatch(String p, String s) {
160 				return p.charAt(p.length() - 1) == '/' && s.startsWith(p);
161 			}
162 		};
163 	}
164 }