// Near Infinity - An Infinity Engine Browser and Editor
// Copyright (C) 2001 - 2005 Jon Olav Hauglid
// See LICENSE.txt for license information
package org.infinity.check;
import java.awt.BorderLayout;
import java.awt.Component;
import java.awt.FlowLayout;
import java.awt.GridLayout;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.io.BufferedWriter;
import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.swing.BorderFactory;
import javax.swing.ButtonGroup;
import javax.swing.JButton;
import javax.swing.JFileChooser;
import javax.swing.JLabel;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.JRadioButton;
import javax.swing.JScrollPane;
import javax.swing.ProgressMonitor;
import javax.swing.event.ListSelectionEvent;
import javax.swing.event.ListSelectionListener;
import org.infinity.NearInfinity;
import org.infinity.datatype.ResourceRef;
import org.infinity.datatype.StringRef;
import org.infinity.gui.BrowserMenuBar;
import org.infinity.gui.Center;
import org.infinity.gui.ChildFrame;
import org.infinity.gui.SortableTable;
import org.infinity.gui.TableItem;
import org.infinity.gui.ViewFrame;
import org.infinity.gui.WindowBlocker;
import org.infinity.icon.Icons;
import org.infinity.resource.AbstractStruct;
import org.infinity.resource.Profile;
import org.infinity.resource.Resource;
import org.infinity.resource.ResourceFactory;
import org.infinity.resource.StructEntry;
import org.infinity.resource.bcs.BcsResource;
import org.infinity.resource.bcs.Compiler;
import org.infinity.resource.bcs.Decompiler;
import org.infinity.resource.dlg.AbstractCode;
import org.infinity.resource.dlg.Action;
import org.infinity.resource.dlg.DlgResource;
import org.infinity.resource.dlg.State;
import org.infinity.resource.dlg.Transition;
import org.infinity.resource.key.ResourceEntry;
import org.infinity.resource.text.PlainTextResource;
import org.infinity.util.Debugging;
import org.infinity.util.Misc;
import org.infinity.util.StringResource;
public final class ResourceUseChecker implements Runnable, ListSelectionListener, ActionListener
{
private static final String FMT_PROGRESS = "Checking resource %d/%d";
private static final Pattern RESREFPATTERN = Pattern.compile("\\w{3,8}");
private static final String[] FILETYPES = {"2DA", "ARE", "BCS", "BS", "CHR", "CHU", "CRE",
"DLG", "EFF", "INI", "ITM", "PRO", "SPL", "STO",
"VEF", "VVC", "WED", "WMP"};
private static final String[] CHECKTYPES = {"ARE", "BCS", "CRE", "DLG", "EFF", "ITM", "PRO", "SPL", "STO",
"TIS", "VEF", "VVC", "WAV", "WED"};
private final ChildFrame selectframe = new ChildFrame("Find unused files", true);
private final JButton bstart = new JButton("Search", Icons.getIcon(Icons.ICON_FIND_16));
private final JButton bcancel = new JButton("Cancel", Icons.getIcon(Icons.ICON_DELETE_16));
private final JRadioButton[] typeButtons = new JRadioButton[CHECKTYPES.length];
private final List<ResourceEntry> checkList = new ArrayList<ResourceEntry>();
private ChildFrame resultFrame;
private JButton bopen, bopennew, bsave;
private SortableTable table;
private String checkType;
private ProgressMonitor progress;
private int progressIndex;
private List<ResourceEntry> files;
public ResourceUseChecker(Component parent)
{
ButtonGroup bg = new ButtonGroup();
JPanel radioPanel = new JPanel(new GridLayout(0, 1));
for (int i = 0; i < typeButtons.length; i++) {
typeButtons[i] = new JRadioButton(CHECKTYPES[i]);
bg.add(typeButtons[i]);
radioPanel.add(typeButtons[i]);
}
typeButtons[0].setSelected(true);
bstart.setMnemonic('s');
bcancel.setMnemonic('c');
bstart.addActionListener(this);
bcancel.addActionListener(this);
selectframe.getRootPane().setDefaultButton(bstart);
selectframe.setIconImage(Icons.getIcon(Icons.ICON_FIND_16).getImage());
radioPanel.setBorder(BorderFactory.createTitledBorder("Select type to search:"));
JPanel bpanel = new JPanel(new FlowLayout(FlowLayout.CENTER));
bpanel.add(bstart);
bpanel.add(bcancel);
JPanel mainpanel = new JPanel(new BorderLayout());
mainpanel.add(radioPanel, BorderLayout.CENTER);
mainpanel.add(bpanel, BorderLayout.SOUTH);
mainpanel.setBorder(BorderFactory.createEmptyBorder(3, 3, 3, 3));
JPanel pane = (JPanel)selectframe.getContentPane();
pane.setLayout(new BorderLayout());
pane.add(mainpanel, BorderLayout.CENTER);
selectframe.pack();
Center.center(selectframe, parent.getBounds());
selectframe.setVisible(true);
}
// --------------------- Begin Interface ActionListener ---------------------
@Override
public void actionPerformed(ActionEvent event)
{
if (event.getSource() == bstart) {
selectframe.setVisible(false);
for (int i = 0; i < typeButtons.length; i++)
if (typeButtons[i].isSelected()) {
checkType = CHECKTYPES[i];
new Thread(this).start();
return;
}
}
else if (event.getSource() == bcancel)
selectframe.setVisible(false);
else if (event.getSource() == bopen) {
int row = table.getSelectedRow();
if (row != -1) {
ResourceEntry resourceEntry = (ResourceEntry)table.getValueAt(row, 0);
NearInfinity.getInstance().showResourceEntry(resourceEntry);
}
}
else if (event.getSource() == bopennew) {
int row = table.getSelectedRow();
if (row != -1) {
ResourceEntry resourceEntry = (ResourceEntry)table.getValueAt(row, 0);
Resource resource = ResourceFactory.getResource(resourceEntry);
new ViewFrame(resultFrame, resource);
}
}
else if (event.getSource() == bsave) {
JFileChooser fc = new JFileChooser(Profile.getGameRoot().toFile());
fc.setDialogTitle("Save search result");
fc.setSelectedFile(new File(fc.getCurrentDirectory(), "result.txt"));
if (fc.showSaveDialog(resultFrame) == JFileChooser.APPROVE_OPTION) {
Path output = fc.getSelectedFile().toPath();
if (Files.exists(output)) {
String options[] = {"Overwrite", "Cancel"};
if (JOptionPane.showOptionDialog(resultFrame, output + " exists. Overwrite?",
"Save result", JOptionPane.YES_NO_OPTION,
JOptionPane.WARNING_MESSAGE, null, options, options[0]) != 0)
return;
}
try (BufferedWriter bw = Files.newBufferedWriter(output)) {
bw.write("Result of CRE inventory check"); bw.newLine();
bw.write("Number of hits: " + table.getRowCount()); bw.newLine();
for (int i = 0; i < table.getRowCount(); i++) {
bw.write(table.getTableItemAt(i).toString()); bw.newLine();
}
JOptionPane.showMessageDialog(resultFrame, "Result saved to " + output, "Save complete",
JOptionPane.INFORMATION_MESSAGE);
} catch (IOException e) {
JOptionPane.showMessageDialog(resultFrame, "Error while saving " + output,
"Error", JOptionPane.ERROR_MESSAGE);
e.printStackTrace();
}
}
}
}
// --------------------- End Interface ActionListener ---------------------
// --------------------- Begin Interface ListSelectionListener ---------------------
@Override
public void valueChanged(ListSelectionEvent event)
{
bopen.setEnabled(true);
bopennew.setEnabled(true);
}
// --------------------- End Interface ListSelectionListener ---------------------
// --------------------- Begin Interface Runnable ---------------------
@Override
public void run()
{
WindowBlocker blocker = new WindowBlocker(NearInfinity.getInstance());
blocker.setBlocked(true);
try {
files = new ArrayList<ResourceEntry>();
for (final String fileType : FILETYPES) {
files.addAll(ResourceFactory.getResources(fileType));
}
ThreadPoolExecutor executor = Misc.createThreadPool();
progressIndex = 0;
progress = new ProgressMonitor(NearInfinity.getInstance(), "Searching...",
String.format(FMT_PROGRESS, files.size(), files.size()),
0, files.size());
progress.setNote(String.format(FMT_PROGRESS, 0, files.size()));
List<Class<? extends Object>> colClasses = new ArrayList<Class<? extends Object>>(2);
colClasses.add(Object.class); colClasses.add(Object.class);
table = new SortableTable(Arrays.asList(new String[]{"File", "Name"}),
colClasses, Arrays.asList(new Integer[]{200, 200}));
checkList.addAll(ResourceFactory.getResources(checkType));
boolean isCancelled = false;
Debugging.timerReset();
for (int i = 0; i < files.size(); i++) {
Misc.isQueueReady(executor, true, -1);
executor.execute(new Worker(files.get(i)));
if (progress.isCanceled()) {
isCancelled = true;
break;
}
}
// enforcing thread termination if process has been cancelled
if (isCancelled) {
executor.shutdownNow();
} else {
executor.shutdown();
}
// waiting for pending threads to terminate
while (!executor.isTerminated()) {
if (!isCancelled && progress.isCanceled()) {
executor.shutdownNow();
isCancelled = true;
}
try { Thread.sleep(1); } catch (InterruptedException e) {}
}
if (isCancelled) {
JOptionPane.showMessageDialog(NearInfinity.getInstance(), "Operation cancelled",
"Info", JOptionPane.INFORMATION_MESSAGE);
return;
}
for (int i = 0; i < checkList.size(); i++)
table.addTableItem(new UnusedFileTableItem(checkList.get(i)));
if (table.getRowCount() == 0)
JOptionPane.showMessageDialog(NearInfinity.getInstance(), "No unused " + checkType + "s found",
"Info", JOptionPane.INFORMATION_MESSAGE);
else {
table.tableComplete();
resultFrame = new ChildFrame("Result", true);
resultFrame.setIconImage(Icons.getIcon(Icons.ICON_FIND_16).getImage());
bopen = new JButton("Open", Icons.getIcon(Icons.ICON_OPEN_16));
bopennew = new JButton("Open in new window", Icons.getIcon(Icons.ICON_OPEN_16));
bsave = new JButton("Save...", Icons.getIcon(Icons.ICON_SAVE_16));
bopen.setMnemonic('o');
bopennew.setMnemonic('n');
bsave.setMnemonic('s');
resultFrame.getRootPane().setDefaultButton(bopennew);
JPanel panel = new JPanel(new FlowLayout(FlowLayout.CENTER));
panel.add(bopen);
panel.add(bopennew);
panel.add(bsave);
JLabel count = new JLabel(table.getRowCount() + " unused " + checkType + "s found", JLabel.CENTER);
count.setFont(count.getFont().deriveFont((float)count.getFont().getSize() + 2.0f));
JScrollPane scrollTable = new JScrollPane(table);
scrollTable.getViewport().setBackground(table.getBackground());
JPanel pane = (JPanel)resultFrame.getContentPane();
pane.setLayout(new BorderLayout(0, 3));
pane.add(count, BorderLayout.NORTH);
pane.add(scrollTable, BorderLayout.CENTER);
pane.add(panel, BorderLayout.SOUTH);
bopen.setEnabled(false);
bopennew.setEnabled(false);
table.setFont(BrowserMenuBar.getInstance().getScriptFont());
table.addMouseListener(new MouseAdapter()
{
@Override
public void mouseReleased(MouseEvent event)
{
if (event.getClickCount() == 2) {
int row = table.getSelectedRow();
if (row != -1) {
ResourceEntry resourceEntry = (ResourceEntry)table.getValueAt(row, 0);
Resource resource = ResourceFactory.getResource(resourceEntry);
new ViewFrame(resultFrame, resource);
((AbstractStruct)resource).getViewer().selectEntry((String)table.getValueAt(row, 1));
}
}
}
});
bopen.addActionListener(this);
bopennew.addActionListener(this);
bsave.addActionListener(this);
pane.setBorder(BorderFactory.createEmptyBorder(3, 3, 3, 3));
table.getSelectionModel().addListSelectionListener(this);
resultFrame.pack();
Center.center(resultFrame, NearInfinity.getInstance().getBounds());
resultFrame.setVisible(true);
}
} finally {
advanceProgress(true);
blocker.setBlocked(false);
if (files != null) {
files.clear();
files = null;
}
}
Debugging.timerShow("Check completed", Debugging.TimeFormat.MILLISECONDS);
}
// --------------------- End Interface Runnable ---------------------
private void checkDialog(DlgResource dialog)
{
List<StructEntry> flatList = dialog.getList();
for (int i = 0; i < flatList.size(); i++) {
if (flatList.get(i) instanceof ResourceRef) {
ResourceRef ref = (ResourceRef)flatList.get(i);
if (ref.getType().equalsIgnoreCase(checkType)) {
synchronized (checkList) {
for (Iterator<ResourceEntry> j = checkList.iterator(); j.hasNext();) {
if (j.next().toString().equalsIgnoreCase(ref.getResourceName())) {
j.remove();
break;
}
}
}
}
}
else if (flatList.get(i) instanceof AbstractCode) {
AbstractCode code = (AbstractCode)flatList.get(i);
try {
Compiler compiler = new Compiler(code.toString(),
(code instanceof Action) ? Compiler.ScriptType.ACTION :
Compiler.ScriptType.TRIGGER);
String compiled = compiler.getCode();
Decompiler decompiler = new Decompiler(compiled, Decompiler.ScriptType.BCS, true);
if (code instanceof Action) {
decompiler.setScriptType(Decompiler.ScriptType.ACTION);
} else {
decompiler.setScriptType(Decompiler.ScriptType.TRIGGER);
}
decompiler.decompile();
Set<ResourceEntry> resourcesUsed = decompiler.getResourcesUsed();
for (final ResourceEntry resourceEntry : resourcesUsed) {
synchronized (checkList) {
checkList.remove(resourceEntry);
}
}
} catch (Exception e) {
e.printStackTrace();
}
}
else if (checkType.equalsIgnoreCase("WAV") &&
(flatList.get(i) instanceof State || flatList.get(i) instanceof Transition)) {
List<StructEntry> subList = ((AbstractStruct)flatList.get(i)).getFlatList();
for (int j = 0; j < subList.size(); j++) {
if (subList.get(j) instanceof StringRef) {
StringRef ref = (StringRef)subList.get(j);
if (ref.getValue() >= 0) {
String wav = StringResource.getWavResource(ref.getValue());
if (wav != null) {
wav += ".WAV";
synchronized (checkList) {
for (Iterator<ResourceEntry> k = checkList.iterator(); k.hasNext();) {
if (wav.equalsIgnoreCase(k.next().toString())) {
k.remove();
break;
}
}
}
}
}
}
}
}
}
}
private void checkScript(BcsResource script)
{
Decompiler decompiler = new Decompiler(script.getCode(), true);
decompiler.decompile();
Set<ResourceEntry> resourcesUsed = decompiler.getResourcesUsed();
for (final ResourceEntry resourceEntry : resourcesUsed) {
synchronized (checkList) {
checkList.remove(resourceEntry);
}
}
}
private void checkStruct(AbstractStruct struct)
{
List<StructEntry> flatList = struct.getFlatList();
for (int i = 0; i < flatList.size(); i++) {
if (flatList.get(i) instanceof ResourceRef) {
ResourceRef ref = (ResourceRef)flatList.get(i);
if (ref.getType().equalsIgnoreCase(checkType)) {
synchronized (checkList) {
for (Iterator<ResourceEntry> j = checkList.iterator(); j.hasNext();) {
if (j.next().toString().equalsIgnoreCase(ref.getResourceName())) {
j.remove();
break;
}
}
}
}
}
else if (checkType.equalsIgnoreCase("WAV") && flatList.get(i) instanceof StringRef) {
StringRef ref = (StringRef)flatList.get(i);
if (ref.getValue() >= 0) {
String wav = StringResource.getWavResource(ref.getValue());
if (wav != null) {
wav += ".WAV";
synchronized (checkList) {
for (Iterator<ResourceEntry> j = checkList.iterator(); j.hasNext();) {
if (wav.equalsIgnoreCase(j.next().toString())) {
j.remove();
break;
}
}
}
}
}
}
}
}
private void checkTextfile(PlainTextResource text)
{
Matcher m = RESREFPATTERN.matcher(text.getText());
while (m.find()) {
String s = text.getText().substring(m.start(), m.end()) + '.' + checkType;
synchronized (checkList) {
for (Iterator<ResourceEntry> i = checkList.iterator(); i.hasNext();) {
if (i.next().toString().equalsIgnoreCase(s)) {
i.remove();
break;
}
}
}
}
}
private synchronized void advanceProgress(boolean finished)
{
if (progress != null) {
if (finished) {
progressIndex = 0;
progress.close();
progress = null;
} else {
progressIndex++;
if (progressIndex % 100 == 0) {
progress.setNote(String.format(FMT_PROGRESS, progressIndex, files.size()));
}
progress.setProgress(progressIndex);
}
}
}
// -------------------------- INNER CLASSES --------------------------
private static final class UnusedFileTableItem implements TableItem
{
private final ResourceEntry file;
private UnusedFileTableItem(ResourceEntry file)
{
this.file = file;
}
@Override
public Object getObjectAt(int columnIndex)
{
if (columnIndex == 0)
return file;
return file.getSearchString();
}
@Override
public String toString()
{
return String.format("File: %1$s Name: %2$s", file.toString(), file.getSearchString());
}
}
private class Worker implements Runnable
{
private final ResourceEntry entry;
public Worker(ResourceEntry entry)
{
this.entry = entry;
}
@Override
public void run()
{
if (entry != null) {
Resource resource = ResourceFactory.getResource(entry);
if (resource instanceof DlgResource) {
checkDialog((DlgResource)resource);
} else if (resource instanceof BcsResource) {
checkScript((BcsResource)resource);
} else if (resource instanceof PlainTextResource) {
checkTextfile((PlainTextResource)resource);
} else if (resource != null) {
checkStruct((AbstractStruct)resource);
}
}
advanceProgress(false);
}
}
}