hudson.plugins.ansicolor.AnsiColorNote.java Source code

Introduction

Here is the source code for hudson.plugins.ansicolor.AnsiColorNote.java

Source

/*
 * The MIT License
 * 
 * Copyright (c) 2011 Daniel Doubrovkine
 * 
 * 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.ansicolor;

import hudson.Extension;
import hudson.MarkupText;
import hudson.console.ConsoleAnnotationDescriptor;
import hudson.console.ConsoleAnnotator;
import hudson.console.ConsoleNote;

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.nio.charset.Charset;
import java.util.logging.Level;
import java.util.logging.Logger;

import org.apache.commons.lang.StringEscapeUtils;

public class AnsiColorNote extends ConsoleNote {

    private static final long serialVersionUID = 1L;
    private static final Logger LOG = Logger.getLogger(AnsiColorNote.class.getName());
    private String data;

    private final AnsiColorMap colorMap;

    public AnsiColorNote(String data, final AnsiColorMap colorMap) {
        this.data = data;
        this.colorMap = colorMap;
    }

    /**
     * Return this color note's color map.
     * 
     * @return AnsiColorMap
     */
    public AnsiColorMap getColorMap() {
        return this.colorMap != null ? this.colorMap : AnsiColorMap.Default;
    }

    /**
     * Annotate output that contains ANSI codes and hide raw text.
     */
    @Override
    public ConsoleAnnotator annotate(Object context, MarkupText text, int charPos) {
        try {
            String colorizedData = colorize(StringEscapeUtils.escapeHtml(this.data), this.getColorMap());
            if (!colorizedData.contentEquals(this.data)) {
                text.addMarkup(charPos, colorizedData);
                text.addMarkup(charPos, charPos + text.getText().length(), "<span style=\"display: none;\">",
                        "</span>");
            }
        } catch (Exception e) {
            LOG.log(Level.WARNING, "Failed to add markup to \"" + text + "\"", e);
        }
        return null;
    }

    /**
     * Process a string, convert ANSI markup to HTML.
     * @param data string that may contain ANSI escape characters
     * @return HTML string
     * @throws IOException
     */
    public static String colorize(String data, final AnsiColorMap colorMap) throws IOException {
        ByteArrayOutputStream out = new ByteArrayOutputStream();
        AnsiColorizer colorizer = new AnsiColorizer(out, Charset.defaultCharset(), colorMap);
        byte[] bytes = data.getBytes();
        colorizer.eol(bytes, bytes.length);
        return out.toString();
    }

    public static String encodeTo(String html, final AnsiColorMap colorMap) {
        try {
            return ConsoleNote.removeNotes(new AnsiColorNote(html, colorMap).encode());
        } catch (IOException e) {
            LOG.log(Level.WARNING, "Failed to serialize " + AnsiColorNote.class, e);
            return "";
        }
    }

    @Extension
    public static final class DescriptorImpl extends ConsoleAnnotationDescriptor {
        public String getDisplayName() {
            return "ANSI Color";
        }
    }
}