Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.yamcs.ui.packetviewer.PacketViewer Maven / Gradle / Ivy
package org.yamcs.ui.packetviewer;
import java.awt.BorderLayout;
import java.awt.Color;
import java.awt.Dimension;
import java.awt.Font;
import java.awt.Insets;
import java.awt.Toolkit;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.ComponentAdapter;
import java.awt.event.ComponentEvent;
import java.awt.event.KeyEvent;
import java.awt.event.WindowEvent;
import java.io.ByteArrayInputStream;
import java.io.EOFException;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.net.URISyntaxException;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Hashtable;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.prefs.Preferences;
import java.util.stream.Collectors;
import javax.swing.AbstractAction;
import javax.swing.Action;
import javax.swing.BorderFactory;
import javax.swing.BoxLayout;
import javax.swing.JButton;
import javax.swing.JCheckBoxMenuItem;
import javax.swing.JComboBox;
import javax.swing.JComponent;
import javax.swing.JFrame;
import javax.swing.JMenu;
import javax.swing.JMenuBar;
import javax.swing.JMenuItem;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JSplitPane;
import javax.swing.JTabbedPane;
import javax.swing.JTable;
import javax.swing.JTextArea;
import javax.swing.JTextField;
import javax.swing.JTextPane;
import javax.swing.JTree;
import javax.swing.KeyStroke;
import javax.swing.ProgressMonitor;
import javax.swing.SwingUtilities;
import javax.swing.SwingWorker;
import javax.swing.UIManager;
import javax.swing.border.Border;
import javax.swing.event.DocumentEvent;
import javax.swing.event.DocumentListener;
import javax.swing.event.TreeSelectionEvent;
import javax.swing.event.TreeSelectionListener;
import javax.swing.plaf.SplitPaneUI;
import javax.swing.plaf.basic.BasicSplitPaneUI;
import javax.swing.text.Style;
import javax.swing.text.StyleConstants;
import javax.swing.text.StyleContext;
import javax.swing.text.StyledDocument;
import javax.swing.tree.DefaultMutableTreeNode;
import javax.swing.tree.DefaultTreeModel;
import javax.swing.tree.TreePath;
import javax.swing.tree.TreeSelectionModel;
import org.jdesktop.swingx.prompt.PromptSupport;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.yamcs.ConfigurationException;
import org.yamcs.ProcessorConfig;
import org.yamcs.TmPacket;
import org.yamcs.YConfiguration;
import org.yamcs.client.BasicAuthCredentials;
import org.yamcs.client.ClientException;
import org.yamcs.client.ConnectionListener;
import org.yamcs.client.MessageListener;
import org.yamcs.client.PacketSubscription;
import org.yamcs.client.YamcsClient;
import org.yamcs.client.base.ServerURL;
import org.yamcs.mdb.DatabaseLoadException;
import org.yamcs.mdb.Mdb;
import org.yamcs.mdb.MdbFactory;
import org.yamcs.mdb.ProcessingData;
import org.yamcs.mdb.XtceTmProcessor;
import org.yamcs.parameter.ContainerParameterValue;
import org.yamcs.parameter.ParameterProcessor;
import org.yamcs.parameter.ParameterValue;
import org.yamcs.parameter.ParameterValueList;
import org.yamcs.protobuf.SubscribePacketsRequest;
import org.yamcs.protobuf.TmPacketData;
import org.yamcs.tctm.CcsdsPacketInputStream;
import org.yamcs.tctm.IssPacketPreprocessor;
import org.yamcs.tctm.PacketInputStream;
import org.yamcs.tctm.PacketPreprocessor;
import org.yamcs.ui.PrefsObject;
import org.yamcs.ui.packetviewer.filter.PacketFilter;
import org.yamcs.ui.packetviewer.filter.ParseException;
import org.yamcs.ui.packetviewer.filter.TokenMgrError;
import org.yamcs.utils.TimeEncoding;
import org.yamcs.utils.YObjectLoader;
import org.yamcs.xtce.Parameter;
import org.yamcs.xtce.SequenceContainer;
import com.google.common.io.CountingInputStream;
public class PacketViewer extends JFrame implements ActionListener,
TreeSelectionListener, ParameterProcessor, ConnectionListener {
private static final long serialVersionUID = 1L;
private static final Logger log = LoggerFactory.getLogger(PacketViewer.class);
public static final Color ERROR_FAINT_BG = new Color(255, 221, 221);
public static final Color ERROR_FAINT_FG = new Color(255, 0, 0);
public static final Border ERROR_BORDER = BorderFactory.createLineBorder(new Color(205, 87, 40));
private static PacketViewer theApp;
private static int maxLines = -1;
Mdb mdb;
private File lastFile;
private JSplitPane hexSplit;
private JTextPane hexText;
private StyledDocument hexDoc;
private Style fixedStyle;
private Style highlightedStyle;
private Style offsetStyle;
private JMenu fileMenu;
private List miRecentFiles;
JMenuItem miAutoScroll;
JMenuItem miAutoSelect;
JComboBox filterField;
private JTextArea logText;
private JScrollPane logScrollpane;
private PacketsTable packetsTable;
private ParametersTable parametersTable;
private JTree structureTree;
private DefaultMutableTreeNode structureRoot;
private DefaultTreeModel structureModel;
private JSplitPane mainsplit;
private FindParameterBar findBar;
private ListPacket currentPacket;
private OpenFileDialog openFileDialog;
private YamcsClient client;
private ConnectDialog connectDialog;
private ConnectData connectData;
Preferences uiPrefs;
// used for decoding full packets
private XtceTmProcessor tmProcessor;
private String defaultNamespace;
private PacketPreprocessor realtimePacketPreprocessor;
private Map fileFormats = new LinkedHashMap<>();
private FileFormat currentFileFormat; // null if listening to server
final static String CFG_PREPRO_CLASS = "packetPreprocessorClassName";
@SuppressWarnings("serial")
public PacketViewer(int maxLines) throws ConfigurationException {
setDefaultCloseOperation(EXIT_ON_CLOSE);
setPreferredSize(new Dimension(1440, 1080));
uiPrefs = Preferences.userNodeForPackage(PacketViewer.class);
YConfiguration config = null;
if (YConfiguration.isDefined("packet-viewer")) {
config = YConfiguration.getConfiguration("packet-viewer");
}
if (config != null) {
defaultNamespace = config.getString("defaultNamespace", null);
readConfig(null, config);
} else {
realtimePacketPreprocessor = new IssPacketPreprocessor(null);
realtimePacketPreprocessor.checkForSequenceDiscontinuity(false);
FileFormat fileFormat = new FileFormat("CCSDS Packets", CcsdsPacketInputStream.class.getName(),
YConfiguration.emptyConfig(), realtimePacketPreprocessor);
fileFormats.put(fileFormat.getName(), fileFormat);
}
// table to the left which shows one row per packet
packetsTable = new PacketsTable(this);
packetsTable.setMaxLines(maxLines);
JScrollPane packetScrollpane = new JScrollPane(packetsTable);
// table to the right which shows one row per parameter in the selected packet
parametersTable = new ParametersTable(this);
JScrollPane tableScrollpane = new JScrollPane(parametersTable);
tableScrollpane.addComponentListener(new ComponentAdapter() {
@Override
public void componentResized(ComponentEvent e) {
if (e.getComponent().getWidth() < parametersTable.getPreferredSize().getWidth()) {
parametersTable.setAutoResizeMode(JTable.AUTO_RESIZE_OFF);
} else {
parametersTable.setAutoResizeMode(JTable.AUTO_RESIZE_ALL_COLUMNS);
}
}
});
// tree to the right which shows the container structure of the selected packet
structureRoot = new DefaultMutableTreeNode();
structureModel = new DefaultTreeModel(structureRoot);
structureTree = new JTree(structureModel);
structureTree.setEditable(false);
structureTree.getSelectionModel().setSelectionMode(TreeSelectionModel.DISCONTIGUOUS_TREE_SELECTION);
structureTree.addTreeSelectionListener(this);
JScrollPane treeScrollpane = new JScrollPane(structureTree);
Insets oldInsets = UIManager.getInsets("TabbedPane.contentBorderInsets");
UIManager.put("TabbedPane.contentBorderInsets", new Insets(0, 0, 0, 0));
JTabbedPane tabpane = new JTabbedPane();
UIManager.put("TabbedPane.contentBorderInsets", oldInsets);
tabpane.add("Parameters", tableScrollpane);
tabpane.add("Structure", treeScrollpane);
findBar = new FindParameterBar(parametersTable);
JPanel parameterPanel = new JPanel(new BorderLayout());
parameterPanel.add(tabpane, BorderLayout.CENTER);
parameterPanel.add(findBar, BorderLayout.SOUTH);
// hexdump panel
hexText = new JTextPane() {
private static final long serialVersionUID = 1L;
@Override
public boolean getScrollableTracksViewportWidth() {
return false; // disable line wrap
}
};
hexDoc = hexText.getStyledDocument();
final Style defStyle = StyleContext.getDefaultStyleContext().getStyle(StyleContext.DEFAULT_STYLE);
fixedStyle = hexDoc.addStyle("fixed", defStyle);
StyleConstants.setFontFamily(fixedStyle, Font.MONOSPACED);
highlightedStyle = hexDoc.addStyle("highlighted", fixedStyle);
StyleConstants.setBackground(highlightedStyle, parametersTable.getSelectionBackground());
StyleConstants.setForeground(highlightedStyle, parametersTable.getSelectionForeground());
offsetStyle = hexDoc.addStyle("offset", fixedStyle);
StyleConstants.setForeground(offsetStyle, Color.GRAY);
hexText.setEditable(false);
JScrollPane hexScrollpane = new JScrollPane(hexText);
hexScrollpane.getViewport().setBackground(hexText.getBackground());
hexSplit = new JSplitPane(JSplitPane.VERTICAL_SPLIT, true, parameterPanel, hexScrollpane);
removeBorders(hexSplit);
hexSplit.setResizeWeight(0.7);
mainsplit = new JSplitPane(JSplitPane.HORIZONTAL_SPLIT, true, packetScrollpane, hexSplit);
removeBorders(mainsplit);
mainsplit.setResizeWeight(0.0);
// log text
logText = new JTextArea(3, 20);
logText.setEditable(false);
logScrollpane = new JScrollPane(logText);
JSplitPane logsplit = new JSplitPane(JSplitPane.VERTICAL_SPLIT, mainsplit, logScrollpane);
removeBorders(logsplit);
logsplit.setResizeWeight(1.0);
logsplit.setContinuousLayout(true);
installMenubar();
JPanel filterBar = new JPanel();
filterBar.setLayout(new BorderLayout());
filterField = new JComboBox<>();
filterField.setEditable(true);
filterBar.add(filterField, BorderLayout.CENTER);
JPanel eastPanel = new JPanel();
eastPanel.setLayout(new BoxLayout(eastPanel, BoxLayout.X_AXIS));
eastPanel.setAlignmentY(CENTER_ALIGNMENT);
JButton clearButton = new JButton();
clearButton.setAction(new AbstractAction("Clear") {
@Override
public void actionPerformed(ActionEvent e) {
filterField.setSelectedIndex(-1);
}
});
eastPanel.add(clearButton);
filterBar.add(eastPanel, BorderLayout.EAST);
JTextField filterEditor = (JTextField) filterField.getEditor().getEditorComponent();
filterEditor.getDocument().addDocumentListener(new DocumentListener() {
@Override
public void insertUpdate(DocumentEvent e) {
changedUpdate(e);
}
@Override
public void removeUpdate(DocumentEvent e) {
changedUpdate(e);
}
@Override
public void changedUpdate(DocumentEvent e) {
String selectedItem = filterEditor.getText();
if (selectedItem != null && !selectedItem.isEmpty() && mdb != null) {
clearButton.setEnabled(true);
try {
new PacketFilter(selectedItem, mdb);
JTextField dummy = new JTextField();
filterEditor.setBackground(dummy.getBackground());
filterEditor.setForeground(dummy.getForeground());
} catch (ParseException | TokenMgrError e1) {
filterEditor.setBackground(ERROR_FAINT_BG);
filterEditor.setForeground(ERROR_FAINT_FG);
}
} else {
clearButton.setEnabled(false);
JTextField dummy = new JTextField();
filterEditor.setBackground(dummy.getBackground());
filterEditor.setForeground(dummy.getForeground());
}
}
});
for (String item : getFilterHistory()) {
filterField.addItem(item);
}
filterField.setSelectedIndex(-1);
filterField.addActionListener(e -> {
try {
String selectedItem = (String) filterField.getSelectedItem();
if (selectedItem != null && !selectedItem.trim().isEmpty()) {
PacketFilter filter = new PacketFilter(selectedItem, mdb);
packetsTable.configureRowFilter(filter);
updateFilterHistory(selectedItem);
filterField.removeAllItems();
for (String item : getFilterHistory()) {
filterField.addItem(item);
}
} else {
packetsTable.configureRowFilter(null);
}
} catch (ParseException | TokenMgrError e1) {
packetsTable.configureRowFilter(null);
}
});
PromptSupport.setPrompt("Display Filter (e.g. my-parameter == 123)", filterEditor);
getContentPane().add(filterBar, BorderLayout.NORTH);
getContentPane().add(logsplit, BorderLayout.CENTER);
clearWindow();
updateTitle();
pack();
setLocationRelativeTo(null); // Center on primary monitor
packetsTable.requestFocusInWindow(); // Take focus away from search box
setVisible(true);
}
private void installMenubar() {
JMenuBar menuBar = new JMenuBar();
setJMenuBar(menuBar);
fileMenu = new JMenu("File");
fileMenu.setMnemonic(KeyEvent.VK_F);
menuBar.add(fileMenu);
// Ctrl on win/linux, Command on mac
int menuKey = Toolkit.getDefaultToolkit().getMenuShortcutKeyMaskEx();
JMenuItem menuitem = new JMenuItem("Open...", KeyEvent.VK_O);
menuitem.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_O, menuKey));
menuitem.setActionCommand("open file");
menuitem.addActionListener(this);
fileMenu.add(menuitem);
menuitem = new JMenuItem("Connect to Yamcs...");
menuitem.setMnemonic(KeyEvent.VK_C);
menuitem.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_Y, menuKey));
menuitem.setActionCommand("connect-yamcs");
menuitem.addActionListener(this);
fileMenu.add(menuitem);
fileMenu.addSeparator();
miRecentFiles = new ArrayList<>();
for (int i = 0; i < 4; i++) {
menuitem = new JMenuItem();
menuitem.setMnemonic(KeyEvent.VK_1 + i);
menuitem.setActionCommand("recent-file-" + i);
menuitem.addActionListener(this);
fileMenu.add(menuitem);
miRecentFiles.add(menuitem);
}
updateMenuWithRecentFiles();
if (!getRecentFiles().isEmpty()) {
fileMenu.addSeparator();
}
/*
* menuitem = new JMenuItem("Preferences", KeyEvent.VK_COMMA);
* menuitem.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_COMMA, menuKey));
* menu.add(menuitem);
* menu.addSeparator();
*/
menuitem = new JMenuItem("Quit", KeyEvent.VK_Q);
menuitem.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_Q, menuKey));
menuitem.setActionCommand("quit");
menuitem.addActionListener(this);
fileMenu.add(menuitem);
JMenu menu = new JMenu("Edit");
menu.setMnemonic(KeyEvent.VK_E);
menuBar.add(menu);
Action openFindBarAction = findBar.getActionMap().get(FindParameterBar.OPEN_ACTION);
menu.add(new JMenuItem(openFindBarAction));
menu.addSeparator();
Action toggleMarkAction = packetsTable.getActionMap().get(PacketsTable.TOGGLE_MARK_ACTION_KEY);
menu.add(new JMenuItem(toggleMarkAction));
menu = new JMenu("Navigate");
menu.setMnemonic(KeyEvent.VK_N);
menuBar.add(menu);
Action goToPacketAction = packetsTable.getActionMap().get(PacketsTable.GO_TO_PACKET_ACTION_KEY);
menu.add(new JMenuItem(goToPacketAction));
menu.addSeparator();
Action backAction = packetsTable.getActionMap().get(PacketsTable.BACK_ACTION_KEY);
menu.add(new JMenuItem(backAction));
Action forwardAction = packetsTable.getActionMap().get(PacketsTable.FORWARD_ACTION_KEY);
menu.add(new JMenuItem(forwardAction));
menu.addSeparator();
Action upAction = packetsTable.getActionMap().get(PacketsTable.UP_ACTION_KEY);
menu.add(new JMenuItem(upAction));
Action downAction = packetsTable.getActionMap().get(PacketsTable.DOWN_ACTION_KEY);
menu.add(new JMenuItem(downAction));
menu = new JMenu("View");
menu.setMnemonic(KeyEvent.VK_V);
menuBar.add(menu);
miAutoScroll = new JCheckBoxMenuItem("Auto-Scroll To Last Packet");
miAutoScroll.setSelected(true);
menu.add(miAutoScroll);
miAutoSelect = new JCheckBoxMenuItem("Auto-Select Last Packet");
miAutoSelect.setSelected(false);
menu.add(miAutoSelect);
menu.addSeparator();
menuitem = new JMenuItem("Clear", KeyEvent.VK_C);
menuitem.setActionCommand("clear");
menuitem.addActionListener(this);
menu.add(menuitem);
}
void updateTitle() {
SwingUtilities.invokeLater(() -> {
StringBuilder title = new StringBuilder("Yamcs Packet Viewer");
if (client != null && client.getWebSocketClient().isConnected()) {
title.append(" [").append(client.getUrl()).append("]");
} else if (lastFile != null) {
title.append(" - ");
title.append(lastFile.getName());
} else {
title.append(" (no file loaded)");
}
setTitle(title.toString());
});
}
void updateMenuWithRecentFiles() {
List recentFiles = getRecentFiles();
int i;
for (i = 0; i < recentFiles.size() && i < miRecentFiles.size(); i++) {
String fileRef = recentFiles.get(i)[0];
int maxChars = 30;
if (fileRef.length() > maxChars) {
// Search first slash from right to left
int slashIndex = fileRef.lastIndexOf(File.separatorChar);
if (fileRef.length() - slashIndex > maxChars - 3) {
// Chop off the end of the string of the last path segment
fileRef = "..." + fileRef.substring(slashIndex, slashIndex + maxChars - 2 * 3) + "...";
} else {
// Output the complete filename, and fill up with initial path segments
fileRef = fileRef.substring(0, maxChars - 3 - (fileRef.length() - slashIndex))
+ "..." + fileRef.substring(slashIndex);
}
}
JMenuItem mi = miRecentFiles.get(i);
mi.setVisible(true);
mi.setText((i + 1) + " " + fileRef);
mi.setToolTipText(recentFiles.get(i)[0]);
}
for (; i < miRecentFiles.size(); i++) {
miRecentFiles.get(i).setVisible(false);
}
}
static void debugLogComponent(String name, JComponent c) {
Insets in = c.getInsets();
System.out.println("component " + name + ": "
+ "min(" + c.getMinimumSize().width + "," + c.getMinimumSize().height + ") "
+ "pref(" + c.getPreferredSize().width + "," + c.getPreferredSize().height + ") "
+ "max(" + c.getMaximumSize().width + "," + c.getMaximumSize().height + ") "
+ "size(" + c.getSize().width + "," + c.getSize().height + ") "
+ "insets(" + in.top + "," + in.left + "," + in.bottom + "," + in.right + ")");
}
@Override
public void log(final String s) {
SwingUtilities.invokeLater(() -> {
if (logText != null) {
logText.append(s + "\n");
logScrollpane.getVerticalScrollBar().setValue(logScrollpane.getVerticalScrollBar().getMaximum());
} else {
System.err.println(s);
}
});
}
void showMessage(String msg) {
SwingUtilities.invokeLater(() -> {
JOptionPane.showMessageDialog(this, msg, getTitle(), JOptionPane.PLAIN_MESSAGE);
});
}
void showError(String msg) {
SwingUtilities.invokeLater(() -> {
JOptionPane.showMessageDialog(this, msg, getTitle(), JOptionPane.ERROR_MESSAGE);
});
}
@Override
public void actionPerformed(ActionEvent ae) {
String cmd = ae.getActionCommand();
if (cmd.equals("quit")) {
processWindowEvent(new WindowEvent(this, WindowEvent.WINDOW_CLOSING));
} else if (cmd.equals("clear")) {
clearWindow();
} else if (cmd.equals("open file")) {
if (openFileDialog == null) {
try {
openFileDialog = new OpenFileDialog(fileFormats);
} catch (ConfigurationException e) {
showError("Cannot load local mdb config: " + e.getMessage());
return;
}
}
int returnVal = openFileDialog.showDialog(this);
if (returnVal == OpenFileDialog.APPROVE_OPTION) {
FileFormat fileFormat = openFileDialog.getSelectedFileFormat();
openFile(openFileDialog.getSelectedFile(), fileFormat, openFileDialog.getSelectedDbConfig());
}
} else if (cmd.equals("connect-yamcs")) {
if (connectDialog == null) {
connectDialog = new ConnectDialog(this, true, true, true);
}
int ret = connectDialog.showDialog();
if (ret == ConnectDialog.APPROVE_OPTION) {
var connectData = connectDialog.getConnectData();
connectYamcs(connectData);
}
} else if (cmd.startsWith("recent-file-")) {
JMenuItem mi = (JMenuItem) ae.getSource();
for (String[] recentFile : getRecentFiles()) {
if (recentFile[0].equals(mi.getToolTipText())) {
if (recentFile.length == 3) {
FileFormat fileFormat = fileFormats.get(recentFile[2]);
if (fileFormat != null) {
openFile(new File(recentFile[0]), fileFormat, recentFile[1]);
break;
}
}
FileFormat fileFormat = fileFormats.values().iterator().next();
openFile(new File(recentFile[0]), fileFormat, recentFile[1]);
break;
}
}
}
}
private void openFile(File file, FileFormat fileFormat, String xtceDb) {
if (!file.exists() || !file.isFile()) {
JOptionPane.showMessageDialog(null, "File not found: " + file, "File not found", JOptionPane.ERROR_MESSAGE);
return;
}
disconnect();
lastFile = file;
if (loadLocalXtcedb(xtceDb)) {
loadFile(fileFormat);
}
updateRecentFiles(lastFile, fileFormat, xtceDb);
currentFileFormat = fileFormat;
}
private boolean loadLocalXtcedb(String configName) {
if (tmProcessor != null) {
tmProcessor.stopAsync();
}
log("Loading local XTCE db " + configName);
try {
mdb = MdbFactory.createInstanceByConfig(configName);
} catch (ConfigurationException | DatabaseLoadException e) {
log.error(e.toString(), e);
showError(e.getMessage());
return false;
}
tmProcessor = new XtceTmProcessor(mdb, getProcessorConfig());
tmProcessor.setParameterProcessor(this);
tmProcessor.startProvidingAll();
tmProcessor.startAsync();
log(String.format("Loaded definition of %d sequence container%s and %d parameter%s",
mdb.getSequenceContainers().size(), (mdb.getSequenceContainers().size() != 1 ? "s" : ""),
mdb.getParameterNames().size(), (mdb.getParameterNames().size() != 1 ? "s" : "")));
packetsTable.setupParameterColumns();
return true;
}
private boolean loadRemoteMissionDatabase(String configName) {
if (tmProcessor != null) {
tmProcessor.stopAsync();
}
String instance = connectData.instance;
log("Loading remote mission database for Yamcs instance " + instance);
try {
byte[] serializedMdb = client.createMissionDatabaseClient(instance).getSerializedJavaDump().get();
try (ObjectInputStream ois = new ObjectInputStream(new ByteArrayInputStream(serializedMdb))) {
Object o = ois.readObject();
mdb = (Mdb) o;
}
} catch (Exception e) {
e.printStackTrace();
showError(e.getMessage());
return false;
}
tmProcessor = new XtceTmProcessor(mdb, getProcessorConfig());
tmProcessor.setParameterProcessor(this);
tmProcessor.startProvidingAll();
tmProcessor.startAsync();
packetsTable.setupParameterColumns();
log("Loaded " + mdb.getSequenceContainers().size() + " sequence containers and "
+ mdb.getParameterNames().size() + " parameters");
return true;
}
private ProcessorConfig getProcessorConfig() {
return new ProcessorConfig();
}
void loadFile(FileFormat fileFormat) {
new SwingWorker() {
ProgressMonitor progress;
int packetCount = 0;
@Override
protected Void doInBackground() throws Exception {
try (CountingInputStream reader = new CountingInputStream(new FileInputStream(lastFile))) {
PacketInputStream packetInputStream = fileFormat.newPacketInputStream(reader);
TmPacket packet;
clearWindow();
int progressMax = (maxLines == -1) ? (int) (lastFile.length() >> 10) : maxLines;
progress = new ProgressMonitor(theApp, String.format("Loading %s", lastFile.getName()), null, 0,
progressMax);
while (!progress.isCanceled()) {
byte[] p = packetInputStream.readPacket();
if (p == null) {
break;
}
PacketPreprocessor packetPreprocessor = fileFormat.getPacketPreprocessor();
packet = packetPreprocessor.process(new TmPacket(TimeEncoding.getWallclockTime(), p));
if (packet != null) {
publish(packet);
packetCount++;
if (packetCount == maxLines) {
break;
}
} else {
log("preprocessor returned null packet");
}
progress.setProgress((maxLines == -1) ? (int) (reader.getCount() >> 10) : packetCount);
}
reader.close();
} catch (EOFException x) {
final String msg = String.format("Encountered end of file while loading %s", lastFile.getName());
log(msg);
} catch (Exception x) {
x.printStackTrace();
final String msg = String.format("Error while loading %s: %s", lastFile.getName(), x.getMessage());
log(msg);
showError(msg);
clearWindow();
lastFile = null;
}
return null;
}
@Override
protected void process(final List chunks) {
for (TmPacket packet : chunks) {
packetsTable.packetReceived(packet);
}
}
@Override
protected void done() {
if (progress != null) {
if (lastFile != null) {
if (progress.isCanceled()) {
clearWindow();
log(String.format("Cancelled loading %s", lastFile.getName()));
} else {
log(String.format("Loaded %d packet%s from \"%s\"",
packetCount,
packetCount != 1 ? "s" : "", lastFile.getPath()));
}
}
progress.close();
}
updateTitle();
}
}.execute();
}
void clearWindow() {
SwingUtilities.invokeLater(() -> {
packetsTable.clear();
parametersTable.clear();
hexText.setText(null);
packetsTable.revalidate();
parametersTable.revalidate();
structureRoot.removeAllChildren();
structureTree.setRootVisible(false);
});
}
void highlightBitRanges(Range[] highlightBits) {
final int linesize = 5 + 5 * 8 + 16 + 1;
int n, tmp, textoffset, binHighStart, binHighStop, ascHighStart, ascHighStop;
// reset styles throughout the document
hexDoc.setCharacterAttributes(0, hexDoc.getLength(), fixedStyle, true);
for (int i = 0; i < hexDoc.getLength(); i += linesize) {
hexDoc.setCharacterAttributes(i, 4, offsetStyle, true);
}
// apply style for highlighted parts
for (Range bitRange : highlightBits) {
if (bitRange == null || bitRange.size == 0) {
continue;
}
final int highlightStartNibble = bitRange.offset / 4;
final int highlightStopNibble = (bitRange.offset + bitRange.size + 3) / 4;
for (n = highlightStartNibble / 32 * 32; n < highlightStopNibble; n += 32) {
binHighStart = 5;
ascHighStart = 5 + 5 * 8;
tmp = highlightStartNibble - n;
if (tmp > 0) {
binHighStart += tmp + (tmp / 4);
ascHighStart += tmp / 2;
}
binHighStop = 5 + 5 * 8 - 1;
ascHighStop = 5 + 5 * 8 + 16;
tmp = n + 32 - highlightStopNibble;
if (tmp > 0) {
binHighStop -= tmp + (tmp / 4);
ascHighStop -= tmp / 2;
}
textoffset = linesize * (n / 32);
// System.out.println(String.format("setCharacterAttributes %d/%d %d %d %d/%d %d/%d",
// highlightStartNibble, highlightStopNibble, n, textoffset, binHighStart, binHighStop, ascHighStart,
// ascHighStop));
hexDoc.setCharacterAttributes(textoffset + binHighStart, binHighStop - binHighStart, highlightedStyle,
true);
hexDoc.setCharacterAttributes(textoffset + ascHighStart, ascHighStop - ascHighStart, highlightedStyle,
true);
}
}
// put the caret into the position of the first item (caret makes itself visible by default)
final int hexScrollPos = (highlightBits.length == 0 || highlightBits[0] == null) ? 0
: (linesize * (highlightBits[0].offset / 128));
hexText.setCaretPosition(hexScrollPos);
}
void connectYamcs(ConnectData connectData) {
disconnect();
this.connectData = connectData;
var clientBuilder = YamcsClient.newBuilder(connectData.serverUrl)
.withConnectionAttempts(10)
.withUserAgent("PacketViewer")
.withVerifyTls(false);
if (connectData.authType == AuthType.BASIC_AUTH && connectData.username != null) {
clientBuilder.withCredentials(new BasicAuthCredentials(connectData.username, connectData.password));
}
client = clientBuilder.build();
client.addConnectionListener(this);
try {
if (connectData.username != null) {
if (connectData.authType == AuthType.STANDARD) {
client.login(connectData.username, connectData.password);
} else if (connectData.authType == AuthType.KERBEROS) {
client.loginWithKerberos(connectData.username);
}
}
client.connectWebSocket();
} catch (ClientException e) {
log.error("Error while connecting", e);
}
currentFileFormat = null;
updateTitle();
}
void disconnect() {
if (client != null) {
client.close();
}
updateTitle();
}
@Override
public void valueChanged(TreeSelectionEvent e) {
TreePath[] paths = structureTree.getSelectionPaths();
Range[] bits = null;
if (paths == null) {
bits = new Range[0];
} else {
bits = new Range[paths.length];
for (int i = 0; i < paths.length; ++i) {
Object last = paths[i].getLastPathComponent();
if (last instanceof TreeEntry) {
TreeEntry te = (TreeEntry) last;
bits[i] = new Range(te.bitOffset, te.bitSize);
} else {
bits[i] = null;
}
}
}
highlightBitRanges(bits);
}
@Override
public void process(final ProcessingData processingData) {
ParameterValueList params = processingData.getTmParams();
SwingUtilities.invokeLater(new Runnable() {
Hashtable containers = new Hashtable<>();
DefaultMutableTreeNode getTreeNode(int startOffset, SequenceContainer sc) {
String sckey = startOffset + ":" + sc.getOpsName();
if (sc.getBaseContainer() == null) {
if (startOffset == 0) {
return structureRoot;
} else {
return containers.computeIfAbsent(sckey, k -> {
TreeContainer tc1 = new TreeContainer(sc);
structureRoot.add(tc1);
return tc1;
});
}
}
TreeContainer tc = containers.computeIfAbsent(sckey, key -> new TreeContainer(sc));
getTreeNode(startOffset, sc.getBaseContainer()).add(tc);
return tc;
}
@Override
public void run() {
parametersTable.clear();
structureRoot.removeAllChildren();
for (ParameterValue value : params) {
// add new leaf to the structure tree
// parameters become leaves, and sequence containers become nodes recursively
if (value instanceof ContainerParameterValue) {
ContainerParameterValue cpv = (ContainerParameterValue) value;
getTreeNode(cpv.getContainerStartOffset(), cpv.getSequenceEntry().getSequenceContainer())
.add(new TreeEntry(cpv));
}
parametersTable.parametersTableModel.addRow(value);
}
structureRoot.setUserObject(currentPacket);
structureModel.nodeStructureChanged(structureRoot);
structureTree.setRootVisible(true);
// expand all nodes
for (TreeContainer tc : containers.values()) {
structureTree.expandPath(new TreePath(tc.getPath()));
}
// build hexdump text
currentPacket.hexdump(hexDoc);
hexText.setCaretPosition(0);
// select first row
parametersTable.setRowSelectionInterval(0, 0);
parametersTable.parametersTableModel.fireTableDataChanged();
}
});
}
public void setSelectedPacket(ListPacket listPacket) {
currentPacket = listPacket;
try {
currentPacket.load(lastFile);
TmPacket packet = new TmPacket(TimeEncoding.getWallclockTime(), listPacket.buf);
PacketPreprocessor packetPreprocessor = getCurrentPacketPreprocessor();
SequenceContainer rootContainer = getCurrentRootContainer();
tmProcessor.processPacket(packetPreprocessor.process(packet), rootContainer);
} catch (IOException x) {
String msg = String.format("Error while loading %s: %s", lastFile.getName(), x.getMessage());
log(msg);
showError(msg);
}
}
SequenceContainer getCurrentRootContainer() {
SequenceContainer rootContainer;
if (currentFileFormat != null && currentFileFormat.getRootContainer() != null) {
rootContainer = mdb.getSequenceContainer(currentFileFormat.getRootContainer());
} else {
rootContainer = mdb.getRootSequenceContainer();
}
if (rootContainer.getBaseContainer() != null) {
log(rootContainer.getQualifiedName() +
" is not a proper root container: it extends " +
rootContainer.getBaseContainer().getQualifiedName());
}
return rootContainer;
}
private PacketPreprocessor getCurrentPacketPreprocessor() {
if (currentFileFormat != null) {
return currentFileFormat.getPacketPreprocessor();
} else {
return realtimePacketPreprocessor;
}
}
@SuppressWarnings("serial")
class TreeContainer extends DefaultMutableTreeNode {
TreeContainer(SequenceContainer sc) {
super(sc.getOpsName(), true);
}
}
@SuppressWarnings("serial")
class TreeEntry extends DefaultMutableTreeNode {
int bitOffset, bitSize;
TreeEntry(ContainerParameterValue value) {
super(String.format("%d/%d %s", value.getAbsoluteBitOffset(), value.getBitSize(),
value.getParameter().getOpsName()), false);
bitOffset = value.getAbsoluteBitOffset();
bitSize = value.getBitSize();
}
}
protected class Range {
int offset, size;
Range(int offset, int size) {
this.offset = offset;
this.size = size;
}
}
@Override
public void connected() {
try {
log("connected to " + client.getHost() + ":" + client.getPort());
if (connectData.useServerMdb) {
if (!loadRemoteMissionDatabase(connectData.instance)) {
return;
}
} else {
if (!loadLocalXtcedb(connectData.localMdbConfig)) {
return;
}
}
PacketSubscription subscription = client.createPacketSubscription();
subscription.addMessageListener(new MessageListener() {
@Override
public void onMessage(TmPacketData message) {
TmPacket pwt = new TmPacket(TimeEncoding.fromProtobufTimestamp(message.getReceptionTime()),
TimeEncoding.fromProtobufTimestamp(message.getGenerationTime()),
message.getSequenceNumber(), message.getPacket().toByteArray());
packetsTable.packetReceived(pwt);
}
@Override
public void onError(Throwable t) {
showError("Error subscribing: " + t.getMessage());
}
});
subscription.sendMessage(SubscribePacketsRequest.newBuilder()
.setInstance(connectData.instance)
.setStream(connectData.streamName)
.build());
} catch (Exception e) {
log(e.toString());
e.printStackTrace();
}
}
@Override
public void connecting() {
log("connecting to " + client.getHost() + ":" + client.getPort());
}
@Override
public void connectionFailed(Throwable cause) {
log("connection to " + client.getHost() + ":" + client.getPort() + " failed: " + cause);
}
@Override
public void disconnected() {
log("disconnected");
}
/**
* Returns the recently opened files from preferences Each entry is a String array with the filename on index 0, and
* the last used XTCE DB for that file on index 1.
*/
@SuppressWarnings("unchecked")
public List getRecentFiles() {
List recentFiles = new ArrayList<>();
Object obj = PrefsObject.getObject(uiPrefs, "RecentlyOpened");
if (obj instanceof ArrayList) {
recentFiles.addAll((ArrayList) obj);
}
// Remove outdated entries
return recentFiles.stream()
.filter(f -> f.length == 3)
.filter(f -> fileFormats.get(f[2]) != null)
.collect(Collectors.toList());
}
private void updateRecentFiles(File file, FileFormat fileFormat, String xtceDb) {
String filename = file.getAbsolutePath();
List recentFiles = getRecentFiles();
boolean exists = false;
for (int i = 0; i < recentFiles.size(); i++) {
String[] entry = recentFiles.get(i);
if (entry[0].equals(filename)) {
entry[1] = xtceDb;
entry[2] = fileFormat.getName();
recentFiles.add(0, recentFiles.remove(i));
exists = true;
}
}
if (!exists) {
recentFiles.add(0, new String[] { filename, xtceDb, fileFormat.getName() });
}
PrefsObject.putObject(uiPrefs, "RecentlyOpened", recentFiles);
// Also update JMenu accordingly
updateMenuWithRecentFiles();
}
@SuppressWarnings("unchecked")
private List getFilterHistory() {
List history = null;
Object obj = PrefsObject.getObject(uiPrefs, "FilterHistory");
if (obj instanceof ArrayList) {
history = (ArrayList) obj;
}
return (history != null) ? history : new ArrayList<>();
}
private void updateFilterHistory(String filter) {
if (filter == null || filter.trim().isEmpty()) {
return;
}
List history = getFilterHistory();
boolean exists = false;
for (int i = 0; i < history.size(); i++) {
String entry = history.get(i);
if (entry.equals(filter)) {
history.add(0, history.remove(i));
exists = true;
}
}
if (!exists) {
history.add(0, filter);
}
if (history.size() > 10) {
history = new ArrayList<>(history.subList(0, 10));
}
PrefsObject.putObject(uiPrefs, "FilterHistory", history);
}
private void removeBorders(JSplitPane splitPane) {
SplitPaneUI ui = splitPane.getUI();
if (ui instanceof BasicSplitPaneUI) { // We don't want to mess with other L&Fs
((BasicSplitPaneUI) ui).getDivider().setBorder(null);
splitPane.setBorder(BorderFactory.createEmptyBorder());
}
}
private static void printUsageAndExit(boolean full) {
System.err.println("usage: packet-viewer [-h] [-l n] -x MDB FILE");
System.err.println(" or: packet-viewer [-h] [-l n] [-x MDB] -i INSTANCE [-s STREAM] URL");
if (full) {
System.err.println();
System.err.println(" FILE The file to open at startup. Requires the use of -x");
System.err.println();
System.err.println(" URL Connect at startup to the given url. Requires the use of -i");
System.err.println();
System.err.println("OPTIONS");
System.err.println(" -h Print a help message and exit");
System.err.println();
System.err.println(" -l n Limit the view to n packets only. If the Packet Viewer is");
System.err.println(" connected to a live instance, only the last n packets will");
System.err.println(" be visible. For offline file consulting, only the first n");
System.err.println(" packets of the file will be displayed.");
System.err.println(" Defaults to 1000 for realtime connections. There is no");
System.err.println(" default limitation for viewing offline files.");
System.err.println();
System.err.println(" -x MDB Name of the applicable MDB as specified in the");
System.err.println(" mdb.yaml configuration file.");
System.err.println();
System.err.println(" -i INSTANCE Yamcs instance name.");
System.err.println();
System.err.println(" -s STREAM Yamcs stream name. Default: tm_realtime.");
System.err.println();
System.err.println("EXAMPLES");
System.err.println(" packet-viewer -l 50 -x my-db packet-file");
System.err.println(" packet-viewer -l 50 -i simulator http://localhost:8090");
}
System.exit(1);
}
private static void printArgsError(String message) {
System.err.println(message);
printUsageAndExit(false);
}
public static void main(String[] args) throws ConfigurationException, URISyntaxException {
// Scan args
String fileOrURL = null;
Map options = new HashMap<>();
for (int i = 0; i < args.length; i++) {
if ("-h".equals(args[i])) {
printUsageAndExit(true);
} else if ("-l".equals(args[i])) {
if (i + 1 < args.length) {
options.put(args[i], args[++i]);
} else {
printArgsError("Number of lines not specified for -l option");
}
} else if ("-x".equals(args[i])) {
if (i + 1 < args.length) {
options.put(args[i], args[++i]);
} else {
printArgsError("Name of MDB not specified for -x option");
}
} else if ("-i".equals(args[i])) {
if (i + 1 < args.length) {
options.put(args[i], args[++i]);
} else {
printArgsError("Name of the instance not specified for -i option");
}
} else if ("-s".equals(args[i])) {
if (i + 1 < args.length) {
options.put(args[i], args[++i]);
} else {
printArgsError("Name of the stream not specified for -s option");
}
} else if ("--etc-dir".equals(args[i])) {
if (i + 1 < args.length) {
options.put(args[i], args[++i]);
} else {
printArgsError("Directory not specified for --etc-dir option");
}
} else if (args[i].startsWith("-")) {
printArgsError("Unknown option: " + args[i]);
} else { // i should now be positioned at [file|url]
if (i == args.length - 1) {
fileOrURL = args[i];
} else {
printArgsError("Too many arguments. Only one file can be opened at a time");
}
}
}
// Do some more preparatory stuff
if (options.containsKey("-l")) {
try {
maxLines = Integer.parseInt((String) options.get("-l"));
} catch (NumberFormatException e) {
printArgsError("-l argument must be integer. Got: " + options.get("-l"));
}
}
boolean isURL = fileOrURL != null && (fileOrURL.startsWith("http://") || fileOrURL.startsWith("https://"));
if (fileOrURL != null) {
if (isURL) {
if (!options.containsKey("-l")) {
maxLines = 1000; // Default for realtime connections
}
if (!options.containsKey("-i")) {
printArgsError("-i argument must be specified when opening a URL");
}
} else { // File
if (!options.containsKey("-x")) {
printArgsError("-x argument must be specified when opening a file");
}
}
}
if (options.containsKey("--etc-dir")) {
Path etcDir = Path.of(options.get("--etc-dir"));
YConfiguration.setupTool(etcDir.toFile());
} else {
YConfiguration.setupTool();
}
// Use XDG convention
var cacheDir = Path.of(System.getProperty("user.home"), ".cache", "packet-viewer");
MdbFactory.setupTool(cacheDir);
// Okay, launch the GUI now
theApp = new PacketViewer(maxLines);
if (fileOrURL != null) {
if (isURL) {
var serverURL = ServerURL.parse(fileOrURL);
var connectData = new ConnectData();
connectData.authType = AuthType.STANDARD;
connectData.serverUrl = serverURL.toString();
connectData.instance = options.get("-i");
connectData.streamName = options.getOrDefault("-s", "tm_realtime");
if (options.containsKey("-x")) {
connectData.useServerMdb = false;
connectData.localMdbConfig = options.get("-x");
} else {
connectData.useServerMdb = true;
}
theApp.connectYamcs(connectData);
} else { // File
var fileFormat = theApp.fileFormats.values().iterator().next();
theApp.openFile(new File(fileOrURL), fileFormat, options.get("-x"));
}
}
}
public void addParameterToTheLeftTable(Parameter selectedParameter) {
packetsTable.addParameterColumn(selectedParameter);
}
public String getDefaultNamespace() {
return defaultNamespace;
}
private PacketPreprocessor loadPacketPreprocessor(String instance, YConfiguration config) {
String packetPreprocessorClassName = config.getString(CFG_PREPRO_CLASS, IssPacketPreprocessor.class.getName());
try {
if (config.containsKey("packetPreprocessorArgs")) {
YConfiguration packetPreprocessorArgs = config.getConfig("packetPreprocessorArgs");
PacketPreprocessor preprocessor = YObjectLoader.loadObject(packetPreprocessorClassName, instance,
packetPreprocessorArgs);
preprocessor.checkForSequenceDiscontinuity(false);
return preprocessor;
} else {
PacketPreprocessor preprocessor = YObjectLoader.loadObject(packetPreprocessorClassName, instance);
preprocessor.checkForSequenceDiscontinuity(false);
return preprocessor;
}
} catch (ConfigurationException e) {
log.error("Cannot instantiate the packet preprocessor", e);
throw e;
}
}
protected void readConfig(String instance, YConfiguration config) {
realtimePacketPreprocessor = loadPacketPreprocessor(instance, config);
if (config.containsKey("fileFormats")) {
List fileFormatsConfig = config.getConfigList("fileFormats");
for (YConfiguration fileFormatConfig : fileFormatsConfig) {
String name = fileFormatConfig.getString("name");
String packetInputStreamClassName = fileFormatConfig.getString("packetInputStreamClassName");
YConfiguration packetInputStreamArgs = fileFormatConfig.getConfigOrEmpty("packetInputStreamArgs");
PacketPreprocessor filePacketPreprocessor = realtimePacketPreprocessor;
if (fileFormatConfig.containsKey(CFG_PREPRO_CLASS)) {
filePacketPreprocessor = loadPacketPreprocessor(instance, fileFormatConfig);
}
FileFormat fileFormat = new FileFormat(name, packetInputStreamClassName, packetInputStreamArgs,
filePacketPreprocessor);
fileFormat.setRootContainer(fileFormatConfig.getString("rootContainer", null));
fileFormats.put(name, fileFormat);
}
} else {
String defaultFormatName = "CCSDS Packets";
String defaultPacketInputStreamClassName = CcsdsPacketInputStream.class.getName();
YConfiguration defaultPacketInputStreamArgs = YConfiguration.emptyConfig();
// Legacy. Over time exclusive use of fileFormats is preferred
if (config.containsKey("packetInputStreamClassName")) {
defaultFormatName = "Default";
defaultPacketInputStreamClassName = config.getString("packetInputStreamClassName");
defaultPacketInputStreamArgs = config.getConfigOrEmpty("packetInputStreamArgs");
}
fileFormats.put(defaultFormatName, new FileFormat(
defaultFormatName, defaultPacketInputStreamClassName, defaultPacketInputStreamArgs,
realtimePacketPreprocessor));
}
}
}
