From 63168aacd63d712f67ca8c5b448f637729cdc2de Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Mon, 25 Feb 2013 08:46:10 -0500
Subject: [PATCH] Documentation
---
src/com/gitblit/RedmineUserService.java | 123 ++++++++++++++++++++++++++++++----------
1 files changed, 91 insertions(+), 32 deletions(-)
diff --git a/src/com/gitblit/RedmineUserService.java b/src/com/gitblit/RedmineUserService.java
index 6ff61c7..9d571e3 100644
--- a/src/com/gitblit/RedmineUserService.java
+++ b/src/com/gitblit/RedmineUserService.java
@@ -9,8 +9,11 @@
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+import com.gitblit.Constants.AccountType;
import com.gitblit.models.UserModel;
+import com.gitblit.utils.ArrayUtils;
import com.gitblit.utils.ConnectionUtils;
+import com.gitblit.utils.StringUtils;
import com.google.gson.Gson;
/**
@@ -44,7 +47,7 @@
public void setup(IStoredSettings settings) {
this.settings = settings;
- String file = settings.getString(Keys.realm.redmine.backingUserService, "users.conf");
+ String file = settings.getString(Keys.realm.redmine.backingUserService, "${baseFolder}/users.conf");
File realmFile = GitBlit.getFileOrFolder(file);
serviceImpl = createUserService(realmFile);
@@ -70,53 +73,110 @@
public boolean supportsTeamMembershipChanges() {
return false;
}
-
- @Override
- public boolean supportsCookies() {
- return false;
- }
+
+ @Override
+ protected AccountType getAccountType() {
+ return AccountType.REDMINE;
+ }
@Override
public UserModel authenticate(String username, char[] password) {
- String urlText = this.settings.getString(Keys.realm.redmine.url, "");
- if (!urlText.endsWith("/")) {
- urlText.concat("/");
- }
- String apiKey = String.valueOf(password);
+ if (isLocalAccount(username)) {
+ // local account, bypass Redmine authentication
+ return super.authenticate(username, password);
+ }
+ String jsonString = null;
try {
- String jsonString = getCurrentUserAsJson(urlText, apiKey);
-
- RedmineCurrent current = new Gson().fromJson(jsonString, RedmineCurrent.class);
- String login = current.user.login;
-
- if (username.equalsIgnoreCase(login)) {
- UserModel userModel = new UserModel(login);
- userModel.displayName = current.user.firstname + " " + current.user.lastname;
- userModel.emailAddress = current.user.mail;
- userModel.canAdmin = true;
- return userModel;
- }
-
- } catch (IOException e) {
- logger.error("authenticate", e);
+ // first attempt by username/password
+ jsonString = getCurrentUserAsJson(username, password);
+ } catch (Exception e1) {
+ logger.warn("Failed to authenticate via username/password against Redmine");
+ try {
+ // second attempt is by apikey
+ jsonString = getCurrentUserAsJson(null, password);
+ username = null;
+ } catch (Exception e2) {
+ logger.error("Failed to authenticate via apikey against Redmine", e2);
+ return null;
+ }
}
- return null;
+
+ if (StringUtils.isEmpty(jsonString)) {
+ logger.error("Received empty authentication response from Redmine");
+ return null;
+ }
+
+ RedmineCurrent current = null;
+ try {
+ current = new Gson().fromJson(jsonString, RedmineCurrent.class);
+ } catch (Exception e) {
+ logger.error("Failed to deserialize Redmine json response: " + jsonString, e);
+ return null;
+ }
+
+ if (StringUtils.isEmpty(username)) {
+ // if the username has been reset because of apikey authentication
+ // then use the email address of the user. this is the original
+ // behavior as contributed by github/mallowlabs
+ username = current.user.mail;
+ }
+
+ UserModel user = getUserModel(username);
+ if (user == null) // create user object for new authenticated user
+ user = new UserModel(username.toLowerCase());
+
+ // create a user cookie
+ if (StringUtils.isEmpty(user.cookie) && !ArrayUtils.isEmpty(password)) {
+ user.cookie = StringUtils.getSHA1(user.username + new String(password));
+ }
+
+ // update user attributes from Redmine
+ user.accountType = getAccountType();
+ user.displayName = current.user.firstname + " " + current.user.lastname;
+ user.emailAddress = current.user.mail;
+ user.password = ExternalAccount;
+ if (!StringUtils.isEmpty(current.user.login)) {
+ // only admin users can get login name
+ // evidently this is an undocumented behavior of Redmine
+ user.canAdmin = true;
+ }
+
+ // TODO consider Redmine group mapping for team membership
+ // http://www.redmine.org/projects/redmine/wiki/Rest_Users
+
+ // push the changes to the backing user service
+ super.updateUserModel(user);
+
+ return user;
}
- private String getCurrentUserAsJson(String url, String apiKey) throws IOException {
+ private String getCurrentUserAsJson(String username, char [] password) throws IOException {
if (testingJson != null) { // for testing
return testingJson;
}
- String apiUrl = url + "users/current.json?key=" + apiKey;
- HttpURLConnection http = (HttpURLConnection) ConnectionUtils.openConnection(apiUrl, null, null);
+ String url = this.settings.getString(Keys.realm.redmine.url, "");
+ if (!url.endsWith("/")) {
+ url.concat("/");
+ }
+ HttpURLConnection http;
+ if (username == null) {
+ // apikey authentication
+ String apiKey = String.valueOf(password);
+ String apiUrl = url + "users/current.json?key=" + apiKey;
+ http = (HttpURLConnection) ConnectionUtils.openConnection(apiUrl, null, null);
+ } else {
+ // username/password BASIC authentication
+ String apiUrl = url + "users/current.json";
+ http = (HttpURLConnection) ConnectionUtils.openConnection(apiUrl, username, password);
+ }
http.setRequestMethod("GET");
http.connect();
InputStreamReader reader = new InputStreamReader(http.getInputStream());
return IOUtils.toString(reader);
}
-
+
/**
* set json response. do NOT invoke from production code.
* @param json json
@@ -124,5 +184,4 @@
public void setTestingCurrentUserAsJson(String json) {
this.testingJson = json;
}
-
}
--
Gitblit v1.9.1