OO-1032 implement read only user property for the user name

src/main/java/org/olat/user/propertyhandlers/UserNameReadOnlyPropertyHandler.java

+/**
+ * <a href="http://www.openolat.org">
+ * OpenOLAT - Online Learning and Training</a><br>
+ * <p>
+ * Licensed under the Apache License, Version 2.0 (the "License"); <br>
+ * you may not use this file except in compliance with the License.<br>
+ * You may obtain a copy of the License at the
+ * <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache homepage</a>
+ * <p>
+ * Unless required by applicable law or agreed to in writing,<br>
+ * software distributed under the License is distributed on an "AS IS" BASIS, <br>
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. <br>
+ * See the License for the specific language governing permissions and <br>
+ * limitations under the License.
+ * <p>
+ * Initial code contributed and copyrighted by<br>
+ * frentix GmbH, http://www.frentix.com
+ * <p>
+ */
+package org.olat.user.propertyhandlers;
+
+import java.util.Collections;
+import java.util.Locale;
+import java.util.Map;
+
+import org.olat.basesecurity.Authentication;
+import org.olat.basesecurity.BaseSecurity;
+import org.olat.basesecurity.BaseSecurityManager;
+import org.olat.core.gui.components.form.ValidationError;
+import org.olat.core.gui.components.form.flexible.FormItem;
+import org.olat.core.gui.components.form.flexible.FormItemContainer;
+import org.olat.core.gui.components.form.flexible.FormUIFactory;
+import org.olat.core.gui.components.form.flexible.elements.TextElement;
+import org.olat.core.id.Identity;
+import org.olat.core.id.User;
+import org.olat.core.id.context.BusinessControlFactory;
+import org.olat.core.id.context.ContextEntry;
+import org.olat.core.util.StringHelper;
+import org.olat.user.AbstractUserPropertyHandler;
+
+/**
+ * <h3>Description:</h3> The UserNameReadOnlyPropertyHandler allows displaying
+ * of the user name. The property is read only and will throw errors when trying
+ * to saving values.
+ * <p>
+ * Initial Date: 04.04.2014 <br>
+ * 
+ * @author gnaegi, http://www.frentix.com
+ */
+public class UserNameReadOnlyPropertyHandler extends AbstractUserPropertyHandler {
+	private String authProvider;
+	
+	/**
+	 * Spring setter for the authentication provider
+	 * @param authProvider
+	 */
+	public void setAuthProvider(String authProvider) {
+		this.authProvider = authProvider;
+	}
+
+	@Override
+	public FormItem addFormItem(Locale locale, User user,
+			String usageIdentifyer, boolean isAdministrativeUser,
+			FormItemContainer formItemContainer) {
+		TextElement tElem = null;
+		
+		tElem = FormUIFactory.getInstance().addTextElement(getName(), i18nFormElementLabelKey(), 127, getInternalValue(user), formItemContainer);
+		tElem.setLabel(i18nFormElementLabelKey(), null);
+		// always read-only
+		tElem.setEnabled(false);
+		return tElem;
+	}
+	
+	@Override
+	public String getUserPropertyAsHTML(User user, Locale locale) {
+		BaseSecurity secMgr = BaseSecurityManager.getInstance();
+		BusinessControlFactory bcFactory = BusinessControlFactory.getInstance();
+		Identity identity = secMgr.findIdentityByUser(user);
+		if (identity != null) {
+			ContextEntry ce = bcFactory.createContextEntry(identity);
+			String homepage = bcFactory.getAsURIString(Collections.singletonList(ce), false);
+			return "<a href='" + homepage + "'>" + StringHelper.escapeHtml(getInternalValue(identity)) + "</a>";			
+		}
+		return "";
+	}
+
+	@Override
+	protected String getInternalValue(User user) {
+		Identity identity = BaseSecurityManager.getInstance().findIdentityByUser(user);
+		return getInternalValue(identity);
+	}
+
+	/**
+	 * lookup username from authentication
+	 * @param identity
+	 * @return
+	 */
+	private String getInternalValue(Identity identity) {
+		if (identity != null) {
+			Authentication auth = BaseSecurityManager.getInstance().findAuthentication(identity, this.authProvider);
+			if (auth != null) {
+				return auth.getAuthusername();
+			}					
+		}
+		return "";
+	}
+
+	@Override
+	protected void setInternalValue(User user, String value) {
+		throw new UnsupportedOperationException("Can not set user names in the read only property.");
+	}
+
+
+	@Override
+	public void updateUserFromFormItem(User user, FormItem formItem) {
+		throw new UnsupportedOperationException("Can not update user names by using the read only property.");
+	}
+
+	@Override
+	public boolean isValid(User user, FormItem formItem,
+			Map<String, String> formContext) {
+		// read only, always true
+		return true;
+	}
+
+	@Override
+	public boolean isValidValue(User user, String value,
+			ValidationError validationError, Locale locale) {
+		// read only, always true
+		return true;
+	}
+
+	@Override
+	public String getStringValue(FormItem formItem) {
+		return ((TextElement) formItem).getValue();
+	}
+
+	@Override
+	public String getStringValue(String displayValue, Locale locale) {
+		return displayValue;
+	}
+
+	@Override
+	public String i18nFormElementLabelKey() {
+		return "username";
+	}
+
+	@Override
+	public String i18nFormElementGroupKey() {
+		return "username";
+	}
+
+	@Override
+	public String i18nColumnDescriptorLabelKey() {
+		return "username";
+	}
+
+}

src/main/java/org/olat/user/propertyhandlers/_spring/userPropertiesContext.xml

@@ -14,6 +14,7 @@
 	<bean id="org.olat.user.UserPropertiesConfig" class="org.olat.user.propertyhandlers.UserPropertiesConfigImpl" init-method="init">
 		<property name="userPropertyHandlers">
 			<list>
+				<ref bean="userPropertyUserName" />
 				<ref bean="userPropertyFirstName" />
 				<ref bean="userPropertyLastName" />
 				<ref bean="userPropertyEmail" />
@@ -96,6 +97,7 @@
 						</property>
 						<property name="userViewReadOnlyProperties">
 							<set>
+								<ref bean="userPropertyUserName" />
 								<ref bean="userPropertyFirstName" />
 								<ref bean="userPropertyLastName" />
 								<ref bean="userPropertyInstitutionalName" />
@@ -282,6 +284,7 @@
 							<list>
 								<ref bean="userPropertyFirstName" />
 								<ref bean="userPropertyLastName" />
+								<ref bean="userPropertyUserName" />
 								<ref bean="userPropertyInstitutionalUserIdentifier" />
 							</list>
 						</property>

src/main/java/org/olat/user/propertyhandlers/_spring/userPropertriesHandlersContext.xml

@@ -9,6 +9,13 @@
 	<!-- 
 		Define all available user properties and its handlers 
 	-->
+	<bean id="userPropertyUserName" class="org.olat.user.propertyhandlers.UserNameReadOnlyPropertyHandler">
+		<property name="name" value="userName" />
+		<property name="group" value="account" />
+		<property name="deletable" value="false" />
+		<property name="authProvider" value="OLAT" /> <!--  could also be ldap, shibboleth, webdav, cal etc -->
+	</bean>
+
 	<bean id="userPropertyFirstName" class="org.olat.user.propertyhandlers.Generic127CharTextPropertyHandler">
 		<property name="name" value="firstName" />
 		<property name="group" value="account" />