Skip to content

Commit

Permalink
TiffTools: unsafe method of creating DataHandle<Location> became pack…
Browse files Browse the repository at this point in the history
…age-private (it does not resolve the basic problem, described in scijava/scijava-common#469 , but helps to reduce a risk)
  • Loading branch information
Daniel-Alievsky committed Aug 7, 2023
1 parent 0c9a995 commit 06329d3
Show file tree
Hide file tree
Showing 3 changed files with 74 additions and 9 deletions.
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
<dependency>
<groupId>org.scijava</groupId>
<artifactId>scijava-common</artifactId>
<version>2.95.1</version>
<version>2.96.0</version>
</dependency>
</dependencies>
<build>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -535,27 +535,35 @@ public static DataHandle<Location> getExistingFileHandle(Path file) throws FileN
throw new FileNotFoundException("File " + file
+ (Files.exists(file) ? " is not a regular file" : " does not exist"));
}
return getFileHandle(file);
DataHandle<Location> fileHandle = getFileHandle(file);
fileHandle.set(new BytesLocation(100));
return fileHandle;
}

public static DataHandle<Location> getFileHandle(Path file) {
static DataHandle<Location> getFileHandle(Path file) {
Objects.requireNonNull(file, "Null file");
return getFileHandle(new FileLocation(file.toFile()));
}

/**
* Warning: you should never call {@link DataHandle#set(Object)} method of the returned result!
* It can lead to unpredictable <tt>ClassCastException</tt>.
*/
@SuppressWarnings("rawtypes, unchecked")
public static DataHandle<Location> getFileHandle(FileLocation fileLocation) {
static DataHandle<Location> getFileHandle(FileLocation fileLocation) {
Objects.requireNonNull(fileLocation, "Null fileLocation");
FileHandle fileHandle = new FileHandle();
fileHandle.set(fileLocation);
FileHandle fileHandle = new FileHandle(fileLocation);
return (DataHandle) fileHandle;
}

/**
* Warning: you should never call {@link DataHandle#set(Object)} method of the returned result!
* It can lead to unpredictable <tt>ClassCastException</tt>.
*/
@SuppressWarnings("rawtypes, unchecked")
public static DataHandle<Location> getBytesHandle(BytesLocation bytesLocation) {
static DataHandle<Location> getBytesHandle(BytesLocation bytesLocation) {
Objects.requireNonNull(bytesLocation, "Null bytesLocation");
BytesHandle bytesHandle = new BytesHandle();
bytesHandle.set(bytesLocation);
BytesHandle bytesHandle = new BytesHandle(bytesLocation);
return (DataHandle) bytesHandle;
}

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
/*
* The MIT License (MIT)
*
* Copyright (c) 2017-2023 Daniel Alievsky, AlgART Laboratory (http://algart.net)
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/

package net.algart.matrices.io.formats.tiff.bridges.scifio.tests.legacy;

import io.scif.SCIFIO;
import io.scif.formats.tiff.TiffParser;
import org.scijava.Context;
import org.scijava.io.handle.DataHandle;
import org.scijava.io.location.BytesLocation;
import org.scijava.io.location.FileLocation;
import org.scijava.io.location.Location;

import java.io.File;

public class FileHandleGenericsBug {
public static void main(String[] args) {
if (args.length < 1) {
System.out.println("Usage:");
System.out.println(" " + FileHandleGenericsBug.class.getName() + " some_tiff_file");
return;
}
final File file = new File(args[0]);

Context context = new SCIFIO().getContext();
TiffParser parser = new TiffParser(context, new FileLocation(file));
DataHandle<Location> stream = parser.getStream();
System.out.println("Successfully opened: " + stream.getLocation());

BytesLocation bytesLocation = new BytesLocation(1000);
stream.set(bytesLocation); // - crash!! java.lang.ClassCastException

System.out.println("This operator will not be performed");
context.close();
}
}

0 comments on commit 06329d3

Please sign in to comment.