MessageNotifyUtil.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2013-2015 Basis Technology Corp.
 * Contact: carrier <at> sleuthkit <dot> org
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.sleuthkit.autopsy.coreutils;

import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Date;
import java.util.List;
import java.util.logging.Level;
import javax.swing.Icon;
import javax.swing.ImageIcon;
import org.openide.DialogDisplayer;
import org.openide.NotifyDescriptor;
import org.openide.awt.Notification;
import org.openide.awt.NotificationDisplayer;
import org.openide.util.ImageUtilities;

public class MessageNotifyUtil {

    private MessageNotifyUtil() {
    }

    public enum MessageType {

        INFO(NotifyDescriptor.INFORMATION_MESSAGE, "info-icon-16.png"), //NON-NLS
        ERROR(NotifyDescriptor.ERROR_MESSAGE, "error-icon-16.png"), //NON-NLS
        WARNING(NotifyDescriptor.WARNING_MESSAGE, "warning-icon-16.png"), //NON-NLS
        CONFIRM(NotifyDescriptor.YES_NO_OPTION, "warning-icon-16.png"); //NON-NLS

        private final int notifyDescriptorType;
        private final Icon icon;

        private MessageType(int notifyDescriptorType, String resourceName) {
            this.notifyDescriptorType = notifyDescriptorType;
            if (resourceName == null) {
                icon = new ImageIcon();
            } else {
                icon = loadIcon(resourceName);
            }
        }

        private static Icon loadIcon(String resourceName) {
            Icon icon = ImageUtilities.loadImageIcon("org/sleuthkit/autopsy/images/" + resourceName, false); //NON-NLS
            if (icon == null) {
                Logger logger = Logger.getLogger(org.sleuthkit.autopsy.coreutils.MessageNotifyUtil.MessageType.class.getName());
                logger.log(Level.SEVERE, "Failed to load icon resource: " + resourceName + ". Using blank image."); //NON-NLS NON-NLS
                icon = new ImageIcon();
            }
            return icon;
        }

        int getNotifyDescriptorType() {
            return notifyDescriptorType;
        }

        Icon getIcon() {
            return icon;
        }
    }

    public static class Message {

        private Message() {
        }

        public static DialogDisplayer getDialogDisplayer() {
            return DialogDisplayer.getDefault();
        }

        public static void show(String message, MessageType messageType) {
            getDialogDisplayer().notify(new NotifyDescriptor.Message(message,
                    messageType.getNotifyDescriptorType()));
        }

        public static boolean confirm(String message) {
            return getDialogDisplayer().notify(new NotifyDescriptor.Confirmation(message,
                    MessageType.CONFIRM.getNotifyDescriptorType())) == NotifyDescriptor.YES_OPTION;
        }

        public static void info(String message) {
            show(message, MessageType.INFO);
        }

        public static void error(String message) {
            show(message, MessageType.ERROR);
        }

        public static void warn(String message) {
            show(message, MessageType.WARNING);
        }

    }

    public static class Notify {

        private static final SimpleDateFormat TIME_STAMP_FORMAT = new SimpleDateFormat("MM/dd/yy HH:mm:ss z");

        //notifications to keep track of and to reset when case is closed
        private static final List<Notification> notifications = Collections.synchronizedList(new ArrayList<Notification>());

        private Notify() {
        }

        public static void clear() {
            notifications.stream().forEach((n) -> {
                n.clear();
            });
            notifications.clear();
        }

        public static void show(String title, String message, MessageType type, ActionListener actionListener) {
            Notification newNotification
                    = NotificationDisplayer.getDefault().notify(addTimeStampToTitle(title), type.getIcon(), message, actionListener);
            notifications.add(newNotification);
        }

        public static void show(String title, final String message, final MessageType type) {
            ActionListener actionListener = (ActionEvent e) -> {
                MessageNotifyUtil.Message.show(message, type);
            };

            show(title, message, type, actionListener);
        }

        public static void info(String title, String message) {
            show(title, message, MessageType.INFO);
        }

        public static void error(String title, String message) {
            show(title, message, MessageType.ERROR);
        }

        public static void warn(String title, String message) {
            show(title, message, MessageType.WARNING);
        }

        private static String addTimeStampToTitle(String title) {
            return TIME_STAMP_FORMAT.format(new Date()) + " " + title;
        }
    }
}