DefaultLegacyOpener.java

/*
 * #%L
 * ImageJ2 software for multidimensional image processing and analysis.
 * %%
 * Copyright (C) 2009 - 2024 ImageJ2 developers.
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * #L%
 */

package net.imagej.legacy.plugin;

import ij.ImagePlus;

import io.scif.Metadata;
import io.scif.app.SCIFIOApp;
import io.scif.img.SCIFIOImgPlus;

import java.io.IOException;
import java.util.concurrent.Future;

import net.imagej.Dataset;
import net.imagej.display.DefaultImageDisplay;
import net.imagej.display.ImageDisplay;
import net.imagej.legacy.IJ1Helper;
import net.imagej.legacy.ImageJ2Options;
import net.imagej.legacy.LegacyImageMap;
import net.imagej.legacy.LegacyService;

import org.scijava.Cancelable;
import org.scijava.Context;
import org.scijava.Priority;
import org.scijava.app.App;
import org.scijava.app.AppService;
import org.scijava.command.CommandInfo;
import org.scijava.command.CommandService;
import org.scijava.display.DisplayService;
import org.scijava.io.IOPlugin;
import org.scijava.io.IOService;
import org.scijava.log.LogService;
import org.scijava.module.Module;
import org.scijava.module.ModuleService;
import org.scijava.options.OptionsService;
import org.scijava.plugin.Plugin;
import org.scijava.plugin.PluginService;
import org.scijava.service.Service;

/**
 * The default {@link LegacyOpener} plugin.
 * <p>
 * When the {@link net.imagej.legacy.DefaultLegacyHooks} are installed, the
 * {@link LegacyOpener} plugin (if any) is given a chance to handle various
 * {@code open} requests from ImageJ 1.x by using IJ2.
 * </p>
 * 
 * @author Mark Hiner
 */
@Plugin(type = LegacyOpener.class, priority = Priority.LOW)
public class DefaultLegacyOpener implements LegacyOpener {

	private static final String EAGER = "eager";

	private LegacyService legacyService;
	private DisplayService displayService;
	private ModuleService moduleService;
	private CommandService commandService;
	private OptionsService optionsService;
	private AppService appService;
	private IOService ioService;
	private LogService logService;
	private PluginService pluginService;

	private IOPlugin<?> getEagerHandler(String path) {
		return ioService.getPlugins() //
			.stream() //
			.filter(info -> info.is(EAGER)) //
			// HACK: This crappier map syntax with cast is needed to make javac happy.
			.map(info -> (IOPlugin<?>) pluginService.createInstance(info)) //
			.filter(io -> io.supportsOpen(path)) //
			.findFirst() //
			.orElse(null);
	}

	@Override
	public Object open(String path, final int planeIndex,
		final boolean displayResult)
	{
		final Context c = IJ1Helper.getLegacyContext();

		legacyService = getCached(legacyService, LegacyService.class, c);
		displayService = getCached(displayService, DisplayService.class, c);
		moduleService = getCached(moduleService, ModuleService.class, c);
		commandService = getCached(commandService, CommandService.class, c);
		optionsService = getCached(optionsService, OptionsService.class, c);
		appService = getCached(appService, AppService.class, c);
		ioService = getCached(ioService, IOService.class, c);
		logService = getCached(logService, LogService.class, c);
		pluginService = getCached(pluginService, PluginService.class, c);

		// Check to see if SCIFIO has been disabled
		final boolean newStyleIO =
			optionsService.getOptions(ImageJ2Options.class).isSciJavaIO();

		// Ensure path is not null.
		if (path == null) {
			// Display a file chooser dialog for the user to select a path.
			// This dialog replaces the original ImageJ's file chooser, which
			// normally happens later in the case of the File > Open code path.
			final CommandInfo command = commandService.getCommand(GetPath.class);
			final String[] selectedPath = new String[1];
			final Future<Module> result =
				moduleService.run(command, true, "path", selectedPath);
			final Module module = moduleService.waitFor(result);
			// Check if the module failed.
			if (module == null) return null; // fall back to original ImageJ
			// Check if the module was canceled.
			if (module instanceof Cancelable && //
				(((Cancelable) module).isCanceled()))
			{
				return Boolean.TRUE; // cancel the operation
			}
			path = selectedPath[0];
		}
		if (path == null) return Boolean.TRUE; // cancel the operation

		// And now it's time to open the path to get the data!
		final Object data;
		try {
			if (newStyleIO) {
				// With ImageJ2-style I/O enabled, we ask the SciJava I/O
				// service to open the data using any available I/O plugin.
				final IOPlugin<?> opener = ioService.getOpener(path);
				if (opener == null) {
					logService.warn("No appropriate format found: " + path);
					return path;
				}
				data = opener.open(path);
				if (data == null) {
					logService.warn("Opening was canceled.");
					return path;
				}
			}
			else {
				// With ImageJ2-style I/O disabled, we let the original ImageJ
				// operate on the file path the way it normally would... EXCEPT:
				// before falling back, we give the IOService's *eager* IOPlugins
				// a chance to handle it, before the original ImageJ kicks in.
				// An eager plugin is an IOPlugin with attrs = { @Attr("eager") }.
				// This concept is distinct from a high-priority I/O plugin,
				// because it partitions the list of IOPlugins into two parts:
				// those allowed to run here, before the original ImageJ logic,
				// and those which are not allowed to do so (the default).
				try {
					final IOPlugin<?> io = getEagerHandler(path);
					if (io == null) {
						logService.debug("No appropriate eager I/O plugin found: " + path);
						return path; // fall back to original ImageJ
					}
					data = io.open(path);
					if (data == null) {
						logService.debug("Eager I/O plugin '" + io.getClass().getName() + "' opened nothing.");
						return path; // fall back to original ImageJ
					}
				}
				catch (final IOException exc) {
					legacyService.handleException(exc);
					return path; // fall back to original ImageJ
				}
			}
		}
		catch (final IOException exc) {
			legacyService.handleException(exc);
			return path; // fall back to original ImageJ
		}

		return handleData(c, data, path, displayResult);
	}

	// -- Helper methods --

	private Object handleData(Context c, Object data, String path, boolean displayResult) {
		if (data == null) return path;

		if (data instanceof Dataset) {
			final Dataset d = (Dataset) data;
			ImagePlus imp = null;

			if (displayResult) {

				// --- HACK ---
				// We should be using the DisplayService here, which would
				// publish a DisplayCreatedEvent. However right now that
				// causes deadlock issues due to the EventBus sharing the AWT EDT.
				// If the ThreadService is converted to using its own off-EDT dedicated
				// EventBus we can go back to the DisplayService mechanism.
				// See https://github.com/scijava/scijava-common/issues/144

				final ImageDisplay imageDisplay = new DefaultImageDisplay();
				imageDisplay.setContext(c);
				imageDisplay.display(d);

				final LegacyImageMap imageMap = legacyService.getImageMap();
				imp = imageMap.registerDisplay(imageDisplay);
				imp.setTitle(d.getName());
				imp.show();
				// --- HACK ---
				// We're not leaning on the IJ1 Framework as much so we have
				// to reset this field after calling show, which sets it false.
				legacyService.getIJ1Helper().setCheckNameDuplicates(true);

				legacyService.getIJ1Helper().updateRecentMenu(
					((Dataset) data).getImgPlus().getSource());
			}
			else {
				// Register the dataset, without creating a display
				imp = legacyService.getImageMap().registerDataset(d);
			}
			// TODO remove usage of SCIFIO classes after migrating ImageMetadata
			// framework to imagej-common
			// Set information about how this dataset was opened.
			String loadingInfo = "";
			App app = appService.getApp(SCIFIOApp.NAME);
			// Get the SCIFIO version
			if (app != null) {
				loadingInfo +=
					"SCIFIO version: " + app.getVersion() + "\n";
			}
			// Get the SCIFIO format
			if (((Dataset) data).getImgPlus() instanceof SCIFIOImgPlus) {
				final SCIFIOImgPlus<?> scifioImp =
					(SCIFIOImgPlus<?>) ((Dataset) data).getImgPlus();
				final Metadata metadata = scifioImp.getMetadata();
				if (metadata != null) {
					loadingInfo +=
						"File format: " + metadata.getFormatName() + "\n";
				}
			}

			if (imp != null) {
				final String existingInfo = (String) imp.getProperty("Info");
				if (existingInfo != null) {
					loadingInfo += existingInfo;
				}
				imp.setProperty("Info", loadingInfo);
				return imp;
			}
		}
		return data;
	}

	private <T extends Service> T getCached(T service, Class<T> serviceClass, Context ctx) {
		if (service != null) return service;
		return ctx.getService(serviceClass);
	}
}