ro.agrade.jira.qanda.issuepanel.UIFormatter.java Source code

Introduction

Here is the source code for ro.agrade.jira.qanda.issuepanel.UIFormatter.java

Source

/*
 * Copyright (c) AGRADE Software. Please read src/main/resources/META-INF/LICENSE
 * or online document at: https://github.com/rdumitriu/jira-qanda/wiki/LICENSE
 *
 * Created on 1/19/13
 */
package ro.agrade.jira.qanda.issuepanel;

import java.text.*;
import java.util.*;

import com.atlassian.core.util.HTMLUtils;
import com.atlassian.jira.avatar.Avatar.Size;
import com.atlassian.jira.avatar.AvatarService;
import com.atlassian.jira.config.properties.ApplicationProperties;
import com.atlassian.jira.issue.Issue;
import com.atlassian.jira.issue.RendererManager;
import com.atlassian.jira.issue.fields.renderer.IssueRenderContext;
import com.atlassian.jira.security.JiraAuthenticationContext;
import com.atlassian.jira.user.ApplicationUser;
import com.atlassian.jira.user.util.UserManager;
import com.atlassian.jira.util.JiraVelocityHelper;
import com.atlassian.jira.util.JiraVelocityUtils;
import com.atlassian.velocity.JiraVelocityManager;
import com.atlassian.velocity.VelocityHelper;
import com.atlassian.velocity.htmlsafe.HtmlSafe;
import org.apache.commons.lang.StringEscapeUtils;

import com.atlassian.velocity.htmlsafe.HtmlSafeAnnotationUtils;
import org.apache.commons.lang.StringEscapeUtils;
import ro.agrade.jira.qanda.utils.JIRAUtils;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * Formats the
 *
 * @author Radu Dumitriu (rdumitriu@gmail.com)
 * @since 1.0
 */
public class UIFormatter {
    private static final Log LOG = LogFactory.getLog(UIFormatter.class);

    private final UserManager userManager;
    private final JiraAuthenticationContext authContext;
    private final String baseURL;
    private final RendererManager rendererMgr;
    private final IssueRenderContext renderContext;
    private final AvatarService avatarService;
    private static final String STDFORMAT = "yyyy-MM-dd HH:mm";

    public UIFormatter(final UserManager userManager, final JiraAuthenticationContext authContext,
            final AvatarService avatarService, final ApplicationProperties properties,
            final RendererManager rendererMgr, final Issue issue) {
        this.userManager = userManager;
        this.authContext = authContext;
        this.avatarService = avatarService;
        this.baseURL = JIRAUtils.getRelativeJIRAPath(properties);
        this.rendererMgr = rendererMgr;
        this.renderContext = new IssueRenderContext(issue);
    }

    /**
     * Formats the TS
     * @param ts the timestamp
     * @return the formatted TS, as a string
     */
    @HtmlSafe
    public String formatTimeStamp(long ts) {
        Date d = new Date();
        d.setTime(ts);
        DateFormat fmt = new SimpleDateFormat(STDFORMAT, authContext.getLocale());
        return fmt.format(d);
    }

    /**
     * Formats the user to put a link to her/his profile. At this very moment we do not
     * care if the user has the right to view the profile (we can safely assume that
     * in most projects profiles to the other members can be seen)
     *
     * @param user the user
     * @return the user link
     */
    @HtmlSafe
    public String formatUser(String user) {
        ApplicationUser userObj = null;
        String avatarUrl = null;
        try {
            userObj = JIRAUtils.toUserObject(userManager, user);
            avatarUrl = avatarService.getAvatarUrlNoPermCheck(userObj, Size.SMALL).toString();
        } catch (Throwable t) {
            /* we do not care */ }
        if (null == userObj) {
            return user; // unknown, deleted
        }
        return String.format(
                "<a class='qandaemails user-hover %s' %s rel='%s' href=\"%s/secure/ViewProfile.jspa?name=%s\">%s</a>",
                avatarUrl != null ? "user-avatar" : "",
                avatarUrl != null ? String.format("style=\"background-image: url(%s);\"", avatarUrl) : "",
                StringEscapeUtils.escapeHtml(userObj.getName()), baseURL,
                StringEscapeUtils.escapeHtml(userObj.getName()),
                StringEscapeUtils.escapeHtml(userObj.getDisplayName()));
    }

    /**
     * Wiki style formatter for our text
     * @param text the text to be formatted
     * @return the formatted text
     */
    @HtmlSafe
    public String formatText(String text) {
        return rendererMgr.getRendererForType("atlassian-wiki-renderer").render(text, renderContext);
    }
}