hudson.plugins.timestamper.TimestampFormatter.java Source code

Introduction

Here is the source code for hudson.plugins.timestamper.TimestampFormatter.java

Source

/*
 * The MIT License
 * 
 * Copyright (c) 2013 Steven G. Brown
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package hudson.plugins.timestamper;

import hudson.MarkupText;

import java.io.Serializable;
import java.util.Date;

import javax.annotation.concurrent.Immutable;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;

import org.apache.commons.lang.time.DurationFormatUtils;
import org.apache.commons.lang.time.FastDateFormat;

import com.google.common.base.Function;

/**
 * Formats a time-stamp to be displayed in the console log page, according to
 * the current settings.
 * 
 * @author Steven G. Brown
 * @since 1.5
 */
@Immutable
public final class TimestampFormatter implements Serializable {

    private static final long serialVersionUID = 1L;

    /**
     * Function that converts a time-stamp to a formatted string representation of
     * that time-stamp.
     */
    private final Function<Timestamp, String> formatTimestamp;

    /**
     * Create a new {@link TimestampFormatter}.
     * 
     * @param systemTimeFormat
     *          the system clock time format
     * @param elapsedTimeFormat
     *          the elapsed time format
     * @param request
     *          the current HTTP request
     */
    public TimestampFormatter(String systemTimeFormat, String elapsedTimeFormat, HttpServletRequest request) {
        String cookieValue = null;
        Cookie[] cookies = request.getCookies();
        if (cookies != null) {
            for (Cookie cookie : cookies) {
                if ("jenkins-timestamper".equals(cookie.getName())) {
                    cookieValue = cookie.getValue();
                    break;
                }
            }
        }

        if ("elapsed".equalsIgnoreCase(cookieValue)) {
            formatTimestamp = new ElapsedTimeFormatFunction(elapsedTimeFormat);
        } else if ("none".equalsIgnoreCase(cookieValue)) {
            formatTimestamp = new EmptyFormatFunction();
        } else {
            // "system", no cookie, or unrecognised cookie
            formatTimestamp = new SystemTimeFormatFunction(systemTimeFormat);
        }
    }

    /**
     * Format the given time-stamp and add it to the mark-up text.
     * 
     * @param text
     *          the mark-up text
     * @param timestamp
     *          the time-stamp to format
     */
    public void markup(MarkupText text, Timestamp timestamp) {
        String timestampString = formatTimestamp.apply(timestamp);
        // Wrap the time-stamp in a span element, which is used to detect the
        // time-stamp when inspecting the page with Javascript.
        String markup = "<span class=\"timestamp\">" + timestampString + "</span>";
        // Add as end tag, which will be inserted prior to tags added by other
        // console notes (e.g. AntTargetNote).
        text.addMarkup(0, 0, "", markup);
    }

    /**
     * Function that converts a time-stamp to the system clock time format.
     */
    private static class SystemTimeFormatFunction implements Function<Timestamp, String>, Serializable {

        private static final long serialVersionUID = 1L;

        private final String systemTimeFormat;

        SystemTimeFormatFunction(String systemTimeFormat) {
            this.systemTimeFormat = systemTimeFormat;
        }

        public String apply(Timestamp timestamp) {
            return FastDateFormat.getInstance(systemTimeFormat).format(new Date(timestamp.millisSinceEpoch));
        }
    }

    /**
     * Function that converts a time-stamp to the elapsed time format.
     */
    private static class ElapsedTimeFormatFunction implements Function<Timestamp, String>, Serializable {

        private static final long serialVersionUID = 1L;

        private final String elapsedTimeFormat;

        ElapsedTimeFormatFunction(String elapsedTimeFormat) {
            this.elapsedTimeFormat = elapsedTimeFormat;
        }

        public String apply(Timestamp timestamp) {
            return DurationFormatUtils.formatDuration(timestamp.elapsedMillis, elapsedTimeFormat);
        }
    }

    /**
     * Function that converts any time-stamp to an empty string.
     */
    private static class EmptyFormatFunction implements Function<Timestamp, String>, Serializable {

        private static final long serialVersionUID = 1L;

        EmptyFormatFunction() {
        }

        public String apply(Timestamp timestamp) {
            return "";
        }
    }
}