UserDisplayConverter.java

/*
 * (C) Copyright 2009 Nuxeo SA (http://nuxeo.com/) and contributors.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the GNU Lesser General Public License
 * (LGPL) version 2.1 which accompanies this distribution, and is available at
 * http://www.gnu.org/licenses/lgpl.html
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * Contributors:
 *     Anahide Tchertchian
 */
package org.nuxeo.ecm.webapp.security;

import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.convert.Converter;

import org.apache.commons.lang.StringUtils;
import org.nuxeo.ecm.core.api.DocumentModel;
import org.nuxeo.ecm.core.api.NuxeoPrincipal;
import org.nuxeo.ecm.platform.ui.web.directory.DirectoryFunctions;
import org.nuxeo.ecm.platform.ui.web.tag.fn.Functions;
import org.nuxeo.ecm.platform.ui.web.util.ComponentUtils;

/**
 * JSF Converter used for rendering, transforming a user id into the user
 * display name.
 * <p>
 * Sample usage:
 *
 * <pre>
 * <code>
 * lt;h:outputText
 *  converter="#{userSuggestionActions.userConverter}">
 *  <f:attribute name="prefixed" value="false" />
 *  <f:attribute name="userDirectory" value="#{userManager.userDirectoryName}" />
 *  <f:attribute name="userSchema" value="#{userManager.userSchemaName}" />
 *  <f:attribute name="firstNameField" value="firstName" />
 *  <f:attribute name="lastNameField" value="lastName" />
 * lt;/h:outputText>
 * </code>
 * </pre>
 *
 * @author Anahide Tchertchian
 *
 */
public class UserDisplayConverter implements Converter {

    /**
     * Returns given value (does not do any reverse conversion)
     */
    @Override
    public Object getAsObject(FacesContext context, UIComponent component,
            String value) {
        return value;
    }

    /**
     * Tries to build the user display name according to information passed as
     * attribute to the component holding the converter.
     * <p>
     * Handled attributes are:
     * <ul>
     * <li>userDirectory: user directory name</li>
     * <li>userSchema: user schema name</li>
     * <li>firstNameField: field storing the user first name</li>
     * <li>lastNameField: field storing the user last name</li>
     * </ul>
     */
    @Override
    public String getAsString(FacesContext context, UIComponent component,
            Object value) {
        if (value instanceof String && !StringUtils.isEmpty((String) value)) {
            String isPrefixed = (String) ComponentUtils.getAttributeOrExpressionValue(
                    context, component, "prefixed", "false");
            String username;
            if (Boolean.valueOf(isPrefixed)) {
                username = ((String) value).substring(NuxeoPrincipal.PREFIX.length());
            } else {
                username = (String) value;
            }
            String directory = (String) ComponentUtils.getAttributeOrExpressionValue(
                    context, component, "userDirectory", null);
            String firstName = (String) ComponentUtils.getAttributeOrExpressionValue(
                    context, component, "firstNameField", null);
            String lastName = (String) ComponentUtils.getAttributeOrExpressionValue(
                    context, component, "lastNameField", null);
            String email = (String) ComponentUtils.getAttributeOrExpressionValue(
                    context, component, "emailField", null);
            String schema = (String) ComponentUtils.getAttributeOrExpressionValue(
                    context, component, "userSchema", null);

            if (schema != null) {
                try {
                    DocumentModel doc = DirectoryFunctions.getDirectoryEntry(
                            directory, username);
                    if (doc != null) {
                        String firstNameValue = firstName != null ? (String) doc.getProperty(
                                schema, firstName) : null;
                        String lastNameValue = lastName != null ? (String) doc.getProperty(
                                schema, lastName) : null;
                        String emailValue = email != null ? (String) doc.getProperty(
                                schema, email) : null;
                        return Functions.userDisplayNameAndEmail(username,
                                firstNameValue, lastNameValue, emailValue);

                    }
                } catch (Exception e) {
                    throw new RuntimeException(e);
                }
            } else {
                // XXX will return cached entry
                return Functions.userFullName(username);
            }
        }
        if (value != null) {
            return value.toString();
        } else {
            return null;
        }
    }

}