org.opencms.ui.components.CmsUserInfo Maven / Gradle / Ivy
Show all versions of opencms-test Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* 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.
*
* For further information about Alkacon Software, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.ui.components;
import org.opencms.file.CmsObject;
import org.opencms.file.CmsUser;
import org.opencms.main.OpenCms;
import org.opencms.ui.A_CmsUI;
import org.opencms.ui.CmsUserIconHelper;
import org.opencms.ui.CmsVaadinUtils;
import org.opencms.ui.apps.CmsAppWorkplaceUi;
import org.opencms.ui.components.CmsUploadButton.I_UploadListener;
import org.opencms.ui.login.CmsLoginController;
import org.opencms.ui.shared.components.CmsUploadState.UploadType;
import org.opencms.util.CmsStringUtil;
import java.text.DateFormat;
import java.util.Date;
import java.util.Locale;
import com.vaadin.server.ExternalResource;
import com.vaadin.shared.ui.label.ContentMode;
import com.vaadin.ui.Button;
import com.vaadin.ui.Button.ClickEvent;
import com.vaadin.ui.HorizontalLayout;
import com.vaadin.ui.Label;
import com.vaadin.ui.UI;
import com.vaadin.ui.VerticalLayout;
/**
* Displays the current user info.
*/
public class CmsUserInfo extends VerticalLayout {
/** The HTML line break. */
private static final String LINE_BREAK = "
";
/** The serial version id. */
private static final long serialVersionUID = 7215454442218119869L;
/** The info. */
private Label m_info;
/** The info panel. */
private HorizontalLayout m_infoPanel;
/** The logout button. */
private Button m_logout;
/** The preferences. */
private Button m_preferences;
/**
* Constructor.
*
* @param uploadListener the user image upload listener
*/
public CmsUserInfo(I_UploadListener uploadListener) {
CmsVaadinUtils.readAndLocalizeDesign(this, CmsVaadinUtils.getWpMessagesForCurrentLocale(), null);
CmsObject cms = A_CmsUI.getCmsObject();
CmsUser user = cms.getRequestContext().getCurrentUser();
m_info.setContentMode(ContentMode.HTML);
m_info.setValue(generateInfo(cms, UI.getCurrent().getLocale()));
m_infoPanel.addComponent(createImageButton(cms, user, uploadListener), 0);
m_logout.addClickListener(new Button.ClickListener() {
private static final long serialVersionUID = 1L;
public void buttonClick(ClickEvent event) {
logout();
}
});
m_preferences.addClickListener(new Button.ClickListener() {
private static final long serialVersionUID = 1L;
public void buttonClick(ClickEvent event) {
showPreferences();
}
});
// hiding the button for now
m_preferences.setVisible(false);
}
/**
* Generates the user info HTML.
*
* @param cms the cms context
* @param locale the user workplace locale
*
* @return the user info
*/
public static String generateUserInfoHtml(CmsObject cms, Locale locale) {
StringBuffer infoHtml = new StringBuffer(256);
infoHtml.append("
![](\""); "\\"\");")
");
return infoHtml.toString();
}
/**
* Generates the info data HTML.
*
* @param cms the cms context.
* @param locale the locale
*
* @return the info data HTML
*/
private static String generateInfo(CmsObject cms, Locale locale) {
CmsUser user = cms.getRequestContext().getCurrentUser();
StringBuffer infoHtml = new StringBuffer(128);
infoHtml.append("").append(user.getFullName()).append("").append(LINE_BREAK);
if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(user.getEmail())) {
infoHtml.append(user.getEmail()).append(LINE_BREAK);
}
if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(user.getInstitution())) {
infoHtml.append(user.getInstitution()).append(LINE_BREAK);
}
if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(user.getAddress())) {
infoHtml.append(user.getAddress()).append(LINE_BREAK);
}
if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(user.getZipcode())) {
infoHtml.append(user.getZipcode()).append(LINE_BREAK);
}
if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(user.getCity())) {
infoHtml.append(user.getCity()).append(LINE_BREAK);
}
if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(user.getCountry())) {
infoHtml.append(user.getCountry()).append(LINE_BREAK);
}
infoHtml.append(
Messages.get().getBundle(locale).key(
Messages.GUI_USER_INFO_ONLINE_SINCE_1,
DateFormat.getTimeInstance(DateFormat.DEFAULT, locale).format(new Date(user.getLastlogin())))).append(
LINE_BREAK);
infoHtml.append(
org.opencms.workplace.Messages.get().getBundle(locale).key(
org.opencms.workplace.Messages.GUI_LABEL_PROJECT_0));
infoHtml.append(": ");
infoHtml.append(cms.getRequestContext().getCurrentProject().getName()).append(LINE_BREAK);
return infoHtml.toString();
}
/**
* Creates the user image button.
*
* @param cms the cms context
* @param user the current user
* @param uploadListener the upload listener
*
* @return the created button
*/
CmsUploadButton createImageButton(CmsObject cms, CmsUser user, I_UploadListener uploadListener) {
CmsUploadButton button = new CmsUploadButton(
new ExternalResource(OpenCms.getWorkplaceAppManager().getUserIconHelper().getBigIconPath(cms, user)),
CmsUserIconHelper.USER_IMAGE_FOLDER + CmsUserIconHelper.TEMP_FOLDER);
button.getState().setUploadType(UploadType.singlefile);
button.getState().setTargetFileNamePrefix(user.getId().toString());
button.addStyleName("o-user-image");
button.getState().setDialogTitle(
CmsVaadinUtils.getMessageText(Messages.GUI_USER_INFO_UPLOAD_IMAGE_DIALOG_TITLE_0));
if (CmsAppWorkplaceUi.isOnlineProject()) {
button.setEnabled(false);
button.setDescription(
CmsVaadinUtils.getMessageText(org.opencms.ui.apps.Messages.GUI_TOOLBAR_NOT_AVAILABLE_ONLINE_0));
} else {
button.setDescription(CmsVaadinUtils.getMessageText(Messages.GUI_USER_INFO_UPLOAD_IMAGE_0));
}
button.addUploadListener(uploadListener);
return button;
}
/**
* Executes the logout.
*/
void logout() {
CmsLoginController.logout();
}
/**
* Shows the user preferences dialog.
*/
void showPreferences() {
//TODO: implement
}
}