| commit | author | age | ||
| eb96ea | 1 | /* |
| JM | 2 | * Copyright 2011 gitblit.com. |
| 3 | * | |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); | |
| 5 | * you may not use this file except in compliance with the License. | |
| 6 | * You may obtain a copy of the License at | |
| 7 | * | |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 | |
| 9 | * | |
| 10 | * Unless required by applicable law or agreed to in writing, software | |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, | |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| 13 | * See the License for the specific language governing permissions and | |
| 14 | * limitations under the License. | |
| 15 | */ | |
| 16 | package com.gitblit; | |
| 17 | ||
| 18 | import java.io.File; | |
| 19 | import java.io.IOException; | |
| 20 | import java.text.MessageFormat; | |
| 21 | import java.util.List; | |
| 22 | ||
| 23 | import org.slf4j.Logger; | |
| 24 | import org.slf4j.LoggerFactory; | |
| 25 | ||
| 26 | import com.gitblit.models.TeamModel; | |
| 27 | import com.gitblit.models.UserModel; | |
| 28 | ||
| 29 | /** | |
| 30 | * This class wraps the default user service and is recommended as the starting | |
| 31 | * point for custom user service implementations. | |
| 32 | * | |
| 33 | * This does seem a little convoluted, but the idea is to allow IUserService to | |
| 34 | * evolve with new methods and implementations without breaking custom | |
| 35 | * authentication implementations. | |
| 36 | * | |
| 37 | * The most common implementation of a custom IUserService is to only override | |
| 38 | * authentication and then delegate all other functionality to one of Gitblit's | |
| 39 | * user services. This class optimizes that use-case. | |
| 40 | * | |
| 41 | * Extending GitblitUserService allows for authentication customization without | |
| 42 | * having to keep-up-with IUSerService API changes. | |
| 43 | * | |
| 44 | * @author James Moger | |
| 45 | * | |
| 46 | */ | |
| 47 | public class GitblitUserService implements IUserService { | |
| 48 | ||
| 49 | protected IUserService serviceImpl; | |
| 50 | ||
| 51 | private final Logger logger = LoggerFactory.getLogger(GitblitUserService.class); | |
| 52 | ||
| 53 | public GitblitUserService() { | |
| 54 | } | |
| 55 | ||
| 56 | @Override | |
| 57 | public void setup(IStoredSettings settings) { | |
| 58 | File realmFile = GitBlit.getFileOrFolder(Keys.realm.userService, "users.conf"); | |
| 59 | serviceImpl = createUserService(realmFile); | |
| 60 | } | |
| 61 | ||
| 62 | @SuppressWarnings("deprecation") | |
| 63 | protected IUserService createUserService(File realmFile) { | |
| 64 | IUserService service = null; | |
| 65 | if (realmFile.getName().toLowerCase().endsWith(".properties")) { | |
| 66 | // v0.5.0 - v0.7.0 properties-based realm file | |
| 67 | service = new FileUserService(realmFile); | |
| 68 | } else if (realmFile.getName().toLowerCase().endsWith(".conf")) { | |
| 69 | // v0.8.0+ config-based realm file | |
| 70 | service = new ConfigUserService(realmFile); | |
| 71 | } | |
| 72 | ||
| 73 | assert service != null; | |
| 74 | ||
| e3d0d4 | 75 | if (!realmFile.exists()) { |
| eb96ea | 76 | // Create the Administrator account for a new realm file |
| JM | 77 | try { |
| 78 | realmFile.createNewFile(); | |
| 79 | } catch (IOException x) { | |
| 80 | logger.error(MessageFormat.format("COULD NOT CREATE REALM FILE {0}!", realmFile), x); | |
| 81 | } | |
| 82 | UserModel admin = new UserModel("admin"); | |
| 83 | admin.password = "admin"; | |
| 84 | admin.canAdmin = true; | |
| 85 | admin.excludeFromFederation = true; | |
| 86 | service.updateUserModel(admin); | |
| 87 | } | |
| 88 | ||
| 89 | if (service instanceof FileUserService) { | |
| 90 | // automatically create a users.conf realm file from the original | |
| 91 | // users.properties file | |
| 92 | File usersConfig = new File(realmFile.getParentFile(), "users.conf"); | |
| 93 | if (!usersConfig.exists()) { | |
| 94 | logger.info(MessageFormat.format("Automatically creating {0} based on {1}", | |
| 95 | usersConfig.getAbsolutePath(), realmFile.getAbsolutePath())); | |
| 96 | ConfigUserService configService = new ConfigUserService(usersConfig); | |
| 97 | for (String username : serviceImpl.getAllUsernames()) { | |
| 98 | UserModel userModel = serviceImpl.getUserModel(username); | |
| 99 | configService.updateUserModel(userModel); | |
| 100 | } | |
| 101 | } | |
| 102 | // issue suggestion about switching to users.conf | |
| 103 | logger.warn("Please consider using \"users.conf\" instead of the deprecated \"users.properties\" file"); | |
| 104 | } | |
| 105 | return service; | |
| 106 | } | |
| 107 | ||
| 108 | @Override | |
| 109 | public boolean supportsCookies() { | |
| 110 | return serviceImpl.supportsCookies(); | |
| 111 | } | |
| 112 | ||
| 113 | @Override | |
| 114 | public char[] getCookie(UserModel model) { | |
| 115 | return serviceImpl.getCookie(model); | |
| 116 | } | |
| 117 | ||
| 118 | @Override | |
| 119 | public UserModel authenticate(char[] cookie) { | |
| 120 | return serviceImpl.authenticate(cookie); | |
| 121 | } | |
| 122 | ||
| 123 | @Override | |
| 124 | public UserModel authenticate(String username, char[] password) { | |
| 125 | return serviceImpl.authenticate(username, password); | |
| 126 | } | |
| 127 | ||
| 128 | @Override | |
| 129 | public UserModel getUserModel(String username) { | |
| 130 | return serviceImpl.getUserModel(username); | |
| 131 | } | |
| 132 | ||
| 133 | @Override | |
| 134 | public boolean updateUserModel(UserModel model) { | |
| 135 | return serviceImpl.updateUserModel(model); | |
| 136 | } | |
| 137 | ||
| 138 | @Override | |
| 139 | public boolean updateUserModel(String username, UserModel model) { | |
| 140 | return serviceImpl.updateUserModel(username, model); | |
| 141 | } | |
| 142 | ||
| 143 | @Override | |
| 144 | public boolean deleteUserModel(UserModel model) { | |
| 145 | return serviceImpl.deleteUserModel(model); | |
| 146 | } | |
| 147 | ||
| 148 | @Override | |
| 149 | public boolean deleteUser(String username) { | |
| 150 | return serviceImpl.deleteUser(username); | |
| 151 | } | |
| 152 | ||
| 153 | @Override | |
| 154 | public List<String> getAllUsernames() { | |
| 155 | return serviceImpl.getAllUsernames(); | |
| 156 | } | |
| 157 | ||
| 158 | @Override | |
| 159 | public List<String> getAllTeamNames() { | |
| 160 | return serviceImpl.getAllTeamNames(); | |
| 161 | } | |
| 162 | ||
| 163 | @Override | |
| 164 | public List<String> getTeamnamesForRepositoryRole(String role) { | |
| 165 | return serviceImpl.getTeamnamesForRepositoryRole(role); | |
| 166 | } | |
| 167 | ||
| 168 | @Override | |
| 169 | public boolean setTeamnamesForRepositoryRole(String role, List<String> teamnames) { | |
| 170 | return serviceImpl.setTeamnamesForRepositoryRole(role, teamnames); | |
| 171 | } | |
| 172 | ||
| 173 | @Override | |
| 174 | public TeamModel getTeamModel(String teamname) { | |
| 175 | return serviceImpl.getTeamModel(teamname); | |
| 176 | } | |
| 177 | ||
| 178 | @Override | |
| 179 | public boolean updateTeamModel(TeamModel model) { | |
| 180 | return serviceImpl.updateTeamModel(model); | |
| 181 | } | |
| 182 | ||
| 183 | @Override | |
| 184 | public boolean updateTeamModel(String teamname, TeamModel model) { | |
| 185 | return serviceImpl.updateTeamModel(teamname, model); | |
| 186 | } | |
| 187 | ||
| 188 | @Override | |
| 189 | public boolean deleteTeamModel(TeamModel model) { | |
| 190 | return serviceImpl.deleteTeamModel(model); | |
| 191 | } | |
| 192 | ||
| 193 | @Override | |
| 194 | public boolean deleteTeam(String teamname) { | |
| 195 | return serviceImpl.deleteTeam(teamname); | |
| 196 | } | |
| 197 | ||
| 198 | @Override | |
| 199 | public List<String> getUsernamesForRepositoryRole(String role) { | |
| 200 | return serviceImpl.getUsernamesForRepositoryRole(role); | |
| 201 | } | |
| 202 | ||
| 203 | @Override | |
| 204 | public boolean setUsernamesForRepositoryRole(String role, List<String> usernames) { | |
| 205 | return serviceImpl.setUsernamesForRepositoryRole(role, usernames); | |
| 206 | } | |
| 207 | ||
| 208 | @Override | |
| 209 | public boolean renameRepositoryRole(String oldRole, String newRole) { | |
| 210 | return serviceImpl.renameRepositoryRole(oldRole, newRole); | |
| 211 | } | |
| 212 | ||
| 213 | @Override | |
| 214 | public boolean deleteRepositoryRole(String role) { | |
| 215 | return serviceImpl.deleteRepositoryRole(role); | |
| 216 | } | |
| 217 | } | |
