net.imagej.updater.util

Class UpdaterUtil

java.lang.Object

net.imagej.updater.util.UpdaterUtil

public final class UpdaterUtil
extends Object

Utility methods for use with the net.imagej.updater package and subpackages.

Class functionality:

• Calculate timestamps of files
• Calculate the checksums of files
• Get the absolute path (prefix()) of the ImageJ directory
• Copy a file over to a particular location

Author:

Johannes Schindelin

Field Summary

Fields

Modifier and Type	Field and Description
static char[]	hex
static String	MAIN_URL
static String	PREFS_USER
static String	SSH_HOST
static String	UPDATE_DIRECTORY
static String	XML_COMPRESSED

Method Summary

Modifier and Type	Method and Description
static boolean	canExecute(File file)
static long	currentTimestamp()
static MessageDigest	getDigest()
static String	getDigest(String path, File file)
static String	getJarDigest(File file)
static String	getJarDigest(File file, boolean treatPropertiesSpecially, boolean treatManifestsSpecially)
static String	getJarDigest(File file, boolean treatPropertiesSpecially, boolean treatManifestsSpecially, boolean keepOnlyMainClassInManifest)
static long	getLastModified(URL url)
static org.scijava.log.LogService	getLogService() Get a log service.
static List<String>	getObsoleteDigests(String path, File file) Handle previous methods to calculate the checksums gracefully Earlier, we simply checksummed all the contents in .jar files.
static String	getPlatform() Deprecated. Use Platforms.current() instead.
static long	getTimestamp(File file)
static boolean	isGPRActivated(File ijRoot) Determines whether the ImageJ root directory has been moved to an area dictated by macOS's Gatekeeper Path Randomization feature.
static boolean	isProtectedLocation(File ijRoot) Determines whether the ImageJ root directory is in an area protected by the OS.
static <T> Iterable<T>	iterate(Enumeration<T> en)
static <T> String	join(String delimiter, Iterable<T> list)
static URLConnection	openConnection(URL url) Open a connection to a URL.
static InputStream	openStream(URL url) Open a stream to a URL.
static boolean	patchInfoPList(File infoPList, String executable)
static String	prettyPrintTimestamp(long timestamp)
protected static String	readFile(File file)
static byte[]	readStreamAsBytes(InputStream input)
static String	stripPrefix(String string, String prefix)
static String	stripSuffix(String string, String suffix)
static String	timestamp(Calendar date)
static String	timestamp(long millis)
static long	timestamp2millis(long timestamp)
static long	timestamp2millis(String timestamp)
static String	toCamelCase(String string) CamelCases a String.
static String	toHex(byte[] bytes)
static void	updateDigest(InputStream input, MessageDigest digest)
static void	useSystemProxies()
protected static void	writeFile(File file, String contents)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAIN_URL

public static String MAIN_URL

UPDATE_DIRECTORY

public static String UPDATE_DIRECTORY

SSH_HOST

public static String SSH_HOST

XML_COMPRESSED

public static final String XML_COMPRESSED

See Also:

Constant Field Values

PREFS_USER

public static final String PREFS_USER

See Also:

Constant Field Values

hex

public static final char[] hex

Method Detail

getPlatform

@Deprecated
public static String getPlatform()

Deprecated. Use Platforms.current() instead.

stripSuffix

public static String stripSuffix(String string,
                                 String suffix)

stripPrefix

public static String stripPrefix(String string,
                                 String prefix)

getDigest

public static String getDigest(String path,
                               File file)
                        throws NoSuchAlgorithmException,
                               FileNotFoundException,
                               IOException,
                               UnsupportedEncodingException

Throws:

NoSuchAlgorithmException

FileNotFoundException

IOException

UnsupportedEncodingException

getDigest

public static MessageDigest getDigest()
                               throws NoSuchAlgorithmException

Throws:

NoSuchAlgorithmException

getObsoleteDigests

public static List<String> getObsoleteDigests(String path,
                                              File file)
                                       throws FileNotFoundException,
                                              IOException

Handle previous methods to calculate the checksums gracefully Earlier, we simply checksummed all the contents in .jar files. But that leads to files marked as modified all the time when Maven rebuilds them. So we changed the way they are checksummed. Let's handle old checksums, too, though, by simply adding them to the previous versions.

Parameters:

path - the path relative to the ImageJ directory

file - the file

Throws:

IOException

FileNotFoundException

updateDigest

public static void updateDigest(InputStream input,
                                MessageDigest digest)
                         throws IOException

Throws:

IOException

toHex

public static String toHex(byte[] bytes)

getJarDigest

public static String getJarDigest(File file)
                           throws FileNotFoundException,
                                  IOException

Throws:

FileNotFoundException

IOException

getJarDigest

public static String getJarDigest(File file,
                                  boolean treatPropertiesSpecially,
                                  boolean treatManifestsSpecially)
                           throws FileNotFoundException,
                                  IOException

Throws:

FileNotFoundException

IOException

getJarDigest

public static String getJarDigest(File file,
                                  boolean treatPropertiesSpecially,
                                  boolean treatManifestsSpecially,
                                  boolean keepOnlyMainClassInManifest)
                           throws FileNotFoundException,
                                  IOException

Throws:

FileNotFoundException

IOException

currentTimestamp

public static long currentTimestamp()

getTimestamp

public static long getTimestamp(File file)

timestamp

public static String timestamp(long millis)

timestamp

public static String timestamp(Calendar date)

timestamp2millis

public static long timestamp2millis(long timestamp)

timestamp2millis

public static long timestamp2millis(String timestamp)

prettyPrintTimestamp

public static String prettyPrintTimestamp(long timestamp)

join

public static <T> String join(String delimiter,
                              Iterable<T> list)

useSystemProxies

public static void useSystemProxies()

getLastModified

public static long getLastModified(URL url)

openStream

public static InputStream openStream(URL url)
                              throws IOException

Open a stream to a URL.

Parameters:

url - the URL to open

Throws:

IOException

openConnection

public static URLConnection openConnection(URL url)
                                    throws IOException

Open a connection to a URL.

Parameters:

url - the URL to open

Throws:

IOException

readStreamAsBytes

public static byte[] readStreamAsBytes(InputStream input)
                                throws IOException

Throws:

IOException

readFile

protected static String readFile(File file)
                          throws IOException

Throws:

IOException

writeFile

protected static void writeFile(File file,
                                String contents)
                         throws IOException

Throws:

IOException

canExecute

public static boolean canExecute(File file)

isGPRActivated

public static boolean isGPRActivated(File ijRoot)

Determines whether the ImageJ root directory has been moved to an area dictated by macOS's Gatekeeper Path Randomization feature. This happens when the application is downloaded, unpacked, and launched without first moving the application to a different folder such as Applications.

Parameters:

ijRoot - the root directory to test

Returns:

whether the directory is protected by GPR

isProtectedLocation

public static boolean isProtectedLocation(File ijRoot)

Determines whether the ImageJ root directory is in an area protected by the OS.

On Windows Vista and later, C:\Program Files is a protected location.

Parameters:

ijRoot - the root directory to test

Returns:

whether the directory is protected by the OS

patchInfoPList

public static boolean patchInfoPList(File infoPList,
                                     String executable)
                              throws IOException

Throws:

IOException

iterate

public static <T> Iterable<T> iterate(Enumeration<T> en)

getLogService

public static org.scijava.log.LogService getLogService()

Get a log service. This works around version skews (where the StderrLogService cannot be found).

Returns:

the log service

toCamelCase

public static String toCamelCase(String string)

CamelCases a String.