SQLiteTableView.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2018 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.contentviewers;

import java.awt.BorderLayout;
import java.awt.Component;
import java.awt.event.ActionEvent;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import javax.swing.AbstractAction;
import javax.swing.Action;
import javax.swing.JMenu;
import javax.swing.JMenuItem;
import javax.swing.JPanel;
import javax.swing.JTable;
import javax.swing.ListSelectionModel;
import javax.swing.ScrollPaneConstants;
import javax.swing.SwingWorker;
import javax.swing.table.TableCellRenderer;
import javax.swing.table.TableColumn;
import javax.swing.table.TableColumnModel;
import org.netbeans.swing.etable.ETableColumn;
import org.netbeans.swing.etable.ETableColumnModel;
import org.netbeans.swing.outline.Outline;
import org.openide.explorer.ExplorerManager;
import org.openide.nodes.AbstractNode;
import org.openide.nodes.Children;
import org.openide.util.NbBundle;
import org.openide.util.actions.Presenter;

@SuppressWarnings("PMD.SingularField") // UI widgets cause lots of false positives
class SQLiteTableView extends JPanel implements ExplorerManager.Provider {

    private final org.openide.explorer.view.OutlineView outlineView;
    private final Outline outline;
    private final ExplorerManager explorerManager;

    SQLiteTableView() {

        initComponents();
        outlineView = new org.openide.explorer.view.OutlineView();
        add(outlineView, BorderLayout.CENTER);
        outlineView.setPropertyColumns();   // column headers will be set later
        outlineView.setHorizontalScrollBarPolicy(ScrollPaneConstants.HORIZONTAL_SCROLLBAR_ALWAYS);
        outlineView.setVerticalScrollBarPolicy(ScrollPaneConstants.VERTICAL_SCROLLBAR_ALWAYS);

        outline = outlineView.getOutline();

        outline.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
        outline.setAutoResizeMode(JTable.AUTO_RESIZE_OFF);
        outline.setRowSelectionAllowed(false);
        outline.setRootVisible(false);

        outline.setCellSelectionEnabled(true);
        explorerManager = new ExplorerManager();
    }

    @NbBundle.Messages({"SQLiteTableView.DisplayAs.text=Display as",
        "SQLiteTableView.DisplayAsMenuItem.Date=Date",
        "SQLiteTableView.DisplayAsMenuItem.RawData=Raw Data"
    })
    void setupTable(List<Map<String, Object>> tableRows) {

     
        if (Objects.isNull(tableRows) || tableRows.isEmpty()) {
            outlineView.setPropertyColumns();
        } else {

            // Set up the column names
            Map<String, Object> row = tableRows.get(0);
            String[] propStrings = new String[row.size() * 2];
            int i = 0;
            for (Map.Entry<String, Object> col : row.entrySet()) {
                String colName = col.getKey();
                propStrings[2 * i] = colName;
                propStrings[2 * i + 1] = colName;
                i++;
            }

            outlineView.setPropertyColumns(propStrings);
        }
        
        // Hide the 'Nodes' column
        TableColumnModel columnModel = outline.getColumnModel();
        ETableColumn column = (ETableColumn) columnModel.getColumn(0);
        ((ETableColumnModel) columnModel).setColumnHidden(column, true);

        // Set the Nodes for the ExplorerManager.
        // The Swingworker ensures that setColumnWidths() is called after all nodes have been created.
        new SwingWorker<Boolean, Void>() {
            @Override
            protected Boolean doInBackground() throws Exception {

                List<Action> nodeActions = new ArrayList<>();
            
                nodeActions.add(new ParseColAction(Bundle.SQLiteTableView_DisplayAs_text(), outline) );
          
                explorerManager.setRootContext(new AbstractNode(Children.create(new SQLiteTableRowFactory(tableRows, nodeActions), true)));
                return false;
            }

            @Override
            protected void done() {
                super.done();
                
                setColumnWidths();
            }
        }.execute();
        
    }

    private void setColumnWidths() {
        int margin = 4;
        int padding = 8;

         // find the maximum width needed to fit the values for the first N rows, at most
        final int rows = Math.min(20, outline.getRowCount());
        for (int col = 1; col < outline.getColumnCount(); col++) {
            int columnWidthLimit = 500;
            int columnWidth = 50;

            for (int row = 0; row < rows; row++) {
                TableCellRenderer renderer = outline.getCellRenderer(row, col);
                Component comp = outline.prepareRenderer(renderer, row, col);
          
                columnWidth = Math.max(comp.getPreferredSize().width, columnWidth);
            }

            columnWidth += 2 * margin + padding; // add margin and regular padding
            columnWidth = Math.min(columnWidth, columnWidthLimit);
            outline.getColumnModel().getColumn(col).setPreferredWidth(columnWidth);
        }
    }
    
    
    @SuppressWarnings("unchecked")
    // <editor-fold defaultstate="collapsed" desc="Generated Code">//GEN-BEGIN:initComponents
    private void initComponents() {

        setLayout(new java.awt.BorderLayout());
    }// </editor-fold>//GEN-END:initComponents

    @Override
    public ExplorerManager getExplorerManager() {
        return explorerManager;
    }

    // Variables declaration - do not modify//GEN-BEGIN:variables
    // End of variables declaration//GEN-END:variables


    private  class ParseColAction extends AbstractAction  implements Presenter.Popup {
        private final Outline outline;
        private final String displayName;
        
        ParseColAction(String displayName,  Outline outline ) {
            super(displayName);
            this.outline = outline;
            this.displayName = displayName;
        }

        @Override
        public void actionPerformed(ActionEvent e) {
            
        }

        @Override
        public JMenuItem getPopupPresenter() {
             return new DisplayColAsMenu();
        }
        
        private class DisplayColAsMenu extends JMenu {

            DisplayColAsMenu() {
                super(displayName);
                initMenu();
            }
            
            final void initMenu() {
                
                int selCol = outline.getSelectedColumn();
                if (selCol < 0 ) { 
                    selCol = 1;
                }
                
                TableColumnModel columnModel = outline.getColumnModel();
                TableColumn column = columnModel.getColumn(selCol);
                
                JMenuItem parseAsEpochItem = new JMenuItem(Bundle.SQLiteTableView_DisplayAsMenuItem_Date());
                parseAsEpochItem.addActionListener((ActionEvent evt) -> {
                    column.setCellRenderer(new EpochTimeCellRenderer(true));
                });
                parseAsEpochItem.setEnabled(false);
                add(parseAsEpochItem);
                        
                JMenuItem parseAsOriginalItem = new JMenuItem(Bundle.SQLiteTableView_DisplayAsMenuItem_RawData());
                parseAsOriginalItem.addActionListener((ActionEvent evt) -> {
                    column.setCellRenderer(new EpochTimeCellRenderer(false));
                });
                parseAsOriginalItem.setEnabled(false);
                add(parseAsOriginalItem);
                
                // Enable the relevant menuitem based on the current display state of the column
                TableCellRenderer currRenderer = column.getCellRenderer();
                if (currRenderer instanceof EpochTimeCellRenderer) {
                    if (((EpochTimeCellRenderer) currRenderer).isRenderingAsEpoch()) {
                        parseAsOriginalItem.setEnabled(true);
                    } else {
                        parseAsEpochItem.setEnabled(true);
                    }
                }
                else {
                    parseAsEpochItem.setEnabled(true);
                } 
            }
        }
    }
}