James Moger
2013-07-02 2e4b03f7fe33ed5b84ec98ce689f3e1cabf97bff
1
2
3
4
5
6
7
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
/*
 * 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.git;
 
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
 
import javax.servlet.http.HttpServletRequest;
 
import org.eclipse.jgit.lib.Ref;
import org.eclipse.jgit.lib.Repository;
import org.eclipse.jgit.transport.RefFilter;
import org.eclipse.jgit.transport.UploadPack;
import org.eclipse.jgit.transport.resolver.ServiceNotAuthorizedException;
import org.eclipse.jgit.transport.resolver.ServiceNotEnabledException;
import org.eclipse.jgit.transport.resolver.UploadPackFactory;
 
import com.gitblit.GitBlit;
import com.gitblit.models.UserModel;
 
/**
 * The upload pack factory creates an upload pack which controls what refs are
 * advertised to cloning/pulling clients.
 * 
 * @author James Moger
 * 
 * @param <X> the connection type
 */
public class GitblitUploadPackFactory<X> implements UploadPackFactory<X> {
 
    @Override
    public UploadPack create(X req, Repository db)
            throws ServiceNotEnabledException, ServiceNotAuthorizedException {
 
        UserModel user = UserModel.ANONYMOUS;
        int timeout = 0;
 
        if (req instanceof HttpServletRequest) {
            // http/https request may or may not be authenticated 
            user = GitBlit.self().authenticate((HttpServletRequest) req);
            if (user == null) {
                user = UserModel.ANONYMOUS;
            }
        } else if (req instanceof GitDaemonClient) {
            // git daemon request is always anonymous
            GitDaemonClient client = (GitDaemonClient) req;
            // set timeout from Git daemon
            timeout = client.getDaemon().getTimeout();
        }
 
        RefFilter refFilter = new UserRefFilter(user);
        UploadPack up = new UploadPack(db);
        up.setRefFilter(refFilter);
        up.setTimeout(timeout);
        
        return up;
    }
 
    /**
     * Restricts advertisement of certain refs based on the permission of the
     * requesting user.
     */
    public static class UserRefFilter implements RefFilter {
        
        final UserModel user;
        
        public UserRefFilter(UserModel user) {
            this.user = user;
        }
        
        @Override
        public Map<String, Ref> filter(Map<String, Ref> refs) {
            if (user.canAdmin()) {
                // admins can see all refs
                return refs;
            }
 
            // normal users can not clone any gitblit refs
            // JGit's RefMap is custom and does not support iterator removal :(
            List<String> toRemove = new ArrayList<String>();
            for (String ref : refs.keySet()) {
                if (ref.startsWith("refs/gitblit/")) {
                    toRemove.add(ref);
                }
            }
            for (String ref : toRemove) {
                refs.remove(ref);
            }
            return refs;
        }
    }
}