Check user prefix for invalid options. Add JavaDoc. Add unit tests.

Florian Zschocke

2013-08-21 0a16a66452e425a19755c6b7a629c8ff0c7ade50

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
package com.gitblit.utils;
 
import com.gitblit.IStoredSettings;
import com.gitblit.Keys;
 
/**
 * Utility functions for model classes that do not fit in any other category.
 *
 * @author Florian Zschocke
 */
public class ModelUtils
{
    /**
     * Default value for the prefix for user repository directories.
     */
    private static final String DEFAULT_USER_REPO_PREFIX = "~";
 
    private static String userRepoPrefix = DEFAULT_USER_REPO_PREFIX;
 
 
 
    /**
     * Set the user repository prefix from configuration settings.
     * @param settings
     */
    public static void setUserRepoPrefix(IStoredSettings settings)
    {
        String newPrefix = DEFAULT_USER_REPO_PREFIX;
        if (settings != null) {
            String prefix = settings.getString(Keys.git.userRepositoryPrefix, DEFAULT_USER_REPO_PREFIX);
            if (prefix != null && !prefix.trim().isEmpty()) {
                if (prefix.charAt(0) == '/') prefix = prefix.substring(1);
                newPrefix = prefix;
            }
        }
 
        userRepoPrefix = newPrefix;
    }
 
 
    /**
     * Get the active user repository project prefix.
     */
    public static String getUserRepoPrefix()
    {
        return userRepoPrefix;
    }
 
 
    /**
     * Get the user project name for a user.
     *
     * @param username name of user
     * @return the active user repository project prefix concatenated with the user name
     */
    public static String getPersonalPath(String username)
    {
        return userRepoPrefix + username.toLowerCase();
    }
 
 
    /**
     * Test if a repository path is for a personal repository.
     *
     * @param name
     *             A project name, a relative path to a repository.
     * @return  true, if the name starts with the active user repository project prefix. False, otherwise.
     */
    public static boolean isPersonalRepository(String name)
    {
        if ( name.startsWith(getUserRepoPrefix()) ) return true;
        return false;
    }
 
 
    /**
     * Test if a repository path is for a personal repository of a specific user.
     *
     * @param username
     *             Name of a user
     * @param name
     *             A project name, a relative path to a repository.
     * @return    true, if the name starts with the active user repository project prefix. False, otherwise.
     */
    public static boolean isUsersPersonalRepository(String username, String name)
    {
        if ( name.equalsIgnoreCase(getPersonalPath(username)) ) return true;
        return false;
    }
 
 
    /**
     * Exrtract a user's name from a personal repository path.
     *
     * @param path
     *             A project name, a relative path to a repository.
     * @return  If the path does not point to a personal repository, an empty string is returned.
     *             Otherwise the name of the user the personal repository belongs to is returned.
     */
    public static String getUserNameFromRepoPath(String path)
    {
        if ( !isPersonalRepository(path) ) return "";
 
        return path.substring(getUserRepoPrefix().length());
    }
 
}