Package net.sourceforge.jnlp.util

Class XDesktopEntry

java.lang.Object

net.sourceforge.jnlp.util.XDesktopEntry

All Implemented Interfaces:

GenericDesktopEntry

public class XDesktopEntry
extends java.lang.Object
implements GenericDesktopEntry

This class builds a (freedesktop.org) desktop entry out of a JNLPFile . This entry can be used to install desktop shortcuts. See xdg-desktop-icon (1) and http://standards.freedesktop.org/desktop-entry-spec/latest/ for more information

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	XDesktopEntry.NonFileProtocolException

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String[]	BROWSERS
static java.lang.String	FAVICON
private JNLPFile	file
private static java.lang.String	GIF
private java.lang.String	iconLocation
private int	iconSize
private static java.lang.String	JPEG
private static java.lang.String	JPG
private static Logger	LOG
private static java.lang.String	MIC
private static java.lang.String	PNG
private static int[]	VALID_ICON_SIZES
(package private) static java.lang.String	XDG_DESKTOP_DIR

Constructor Summary

Constructors

Constructor	Description
XDesktopEntry(JNLPFile file)	Create a XDesktopEntry for the given JNLP file

Method Summary

Modifier and Type	Method	Description
(package private) java.lang.String	cacheAndGetIconLocation()
private void	cacheIcon()	Cache the icon for the desktop entry
private void	cantCache()
private java.io.File	convertToIco(java.io.File source, java.lang.String targetName)
void	createDesktopShortcuts(AccessWarningPaneComplexReturn.ShortcutResult menu, AccessWarningPaneComplexReturn.ShortcutResult desktop)	Create a desktop shortcut for this desktop entry
void	createShortcutOnWindowsDesktop()
void	createWindowsMenu()
private static java.io.File	downloadFavIcon(JNLPFile file)
private static java.lang.String	evaluateLinuxVariables(java.lang.String orig)
private static java.lang.String	evaluateLinuxVariables(java.lang.String orig, java.util.Map<java.lang.String,java.lang.String> variables)
private static java.net.URL	favUrl(java.lang.String delimiter, java.lang.String path, JNLPFile file)
private static java.lang.String	filterQuotes(java.lang.String string)
private static java.lang.String	findAndVerifyBasicDir(java.io.File f, java.lang.String message)
private static java.lang.String	findAndVerifyGeneratedJnlpDir()
private static java.lang.String	findAndVerifyJavawsMenuDir()
private static java.lang.String	findFreedesktopOrgDesktopPath()	Instead of having all this parsing of user-dirs.dirs and replacing variables we can execute `echo $(xdg-user-dir DESKTOP)` and it will do all the job in case approaches below become failing
static java.lang.String	findFreedesktopOrgDesktopPathCatch()
static java.lang.String	getBrowserBin()
(package private) java.lang.String	getContent(boolean menu, AccessWarningPaneComplexReturn.ShortcutResult info)	Returns the contents of the XDesktopEntry as a String.
(package private) static java.io.File	getDesktop()
java.io.File	getDesktopIconFile()
(package private) static java.lang.String	getFreedesktopOrgDesktopPathFrom(java.io.BufferedReader r)
private static java.lang.String	getFreedesktopOrgDesktopPathFrom(java.io.File userDirs)
java.io.File	getGeneratedJnlpFileName()
java.io.File	getLinuxMenuIconFile()
private java.lang.String	getShortcutFileName()
private java.lang.String	getShortcutName()
(package private) java.io.File	getShortcutTmpFile()
private java.lang.String	getUniqueIconName(java.lang.String iconName)
private void	installDesktopLauncher(AccessWarningPaneComplexReturn.ShortcutResult info)	Install this XDesktopEntry into the user's desktop as a launcher.
private void	installMenuLauncher(AccessWarningPaneComplexReturn.ShortcutResult info)	Install this XDesktopEntry into the user's menu.
(package private) static java.util.List<java.lang.String>	possibleFavIconLocations(java.lang.String path)
void	refreshExistingShortcuts(boolean desktop, boolean menu)
private static java.lang.String	sanitize(java.lang.String input)	Sanitizes a string so that it can be used safely in a key=value pair in a desktop entry file.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final Logger LOG

file

private JNLPFile file

iconSize

private int iconSize

iconLocation

private java.lang.String iconLocation

VALID_ICON_SIZES

private static final int[] VALID_ICON_SIZES

GIF

private static final java.lang.String GIF

See Also:

Constant Field Values

JPG

private static final java.lang.String JPG

See Also:

Constant Field Values

JPEG

private static final java.lang.String JPEG

See Also:

Constant Field Values

PNG

private static final java.lang.String PNG

See Also:

Constant Field Values

BROWSERS

public static final java.lang.String[] BROWSERS

FAVICON

public static final java.lang.String FAVICON

See Also:

Constant Field Values

XDG_DESKTOP_DIR

static final java.lang.String XDG_DESKTOP_DIR

See Also:

Constant Field Values

MIC

private static final java.lang.String MIC

See Also:

Constant Field Values

Constructor Detail

XDesktopEntry

public XDesktopEntry(JNLPFile file)

Create a XDesktopEntry for the given JNLP file

Parameters:

file - a JNLPFile that indicates the application to launch

Method Detail

getContent

java.lang.String getContent(boolean menu,
                            AccessWarningPaneComplexReturn.ShortcutResult info)

Returns the contents of the XDesktopEntry as a String.

Parameters:

menu - whether to create this icon to menu

info - result of user's interference

Returns:

string with desktop shortcut specification

getBrowserBin

public static java.lang.String getBrowserBin()

sanitize

private static java.lang.String sanitize(java.lang.String input)

Sanitizes a string so that it can be used safely in a key=value pair in a desktop entry file.

Parameters:

input - a String to sanitize

Returns:

a string safe to use as either the key or the value in the key=value pair in a desktop entry file

getShortcutTmpFile

java.io.File getShortcutTmpFile()

createDesktopShortcuts

public void createDesktopShortcuts(AccessWarningPaneComplexReturn.ShortcutResult menu,
                                   AccessWarningPaneComplexReturn.ShortcutResult desktop)

Create a desktop shortcut for this desktop entry

Specified by:

createDesktopShortcuts in interface GenericDesktopEntry

Parameters:

menu - how to create in menu

desktop - how to create on desktop

installMenuLauncher

private void installMenuLauncher(AccessWarningPaneComplexReturn.ShortcutResult info)

Install this XDesktopEntry into the user's menu.

installDesktopLauncher

private void installDesktopLauncher(AccessWarningPaneComplexReturn.ShortcutResult info)

Install this XDesktopEntry into the user's desktop as a launcher.

refreshExistingShortcuts

public void refreshExistingShortcuts(boolean desktop,
                                     boolean menu)

Specified by:

refreshExistingShortcuts in interface GenericDesktopEntry

getGeneratedJnlpFileName

public java.io.File getGeneratedJnlpFileName()

Specified by:

getGeneratedJnlpFileName in interface GenericDesktopEntry

cacheIcon

private void cacheIcon()
                throws java.io.IOException,
                       XDesktopEntry.NonFileProtocolException

Cache the icon for the desktop entry

Throws:

java.io.IOException

XDesktopEntry.NonFileProtocolException

getUniqueIconName

private java.lang.String getUniqueIconName(java.lang.String iconName)

convertToIco

private java.io.File convertToIco(java.io.File source,
                                  java.lang.String targetName)

cacheAndGetIconLocation

java.lang.String cacheAndGetIconLocation()

possibleFavIconLocations

static java.util.List<java.lang.String> possibleFavIconLocations(java.lang.String path)

favUrl

private static java.net.URL favUrl(java.lang.String delimiter,
                                   java.lang.String path,
                                   JNLPFile file)
                            throws java.net.MalformedURLException

Throws:

java.net.MalformedURLException

downloadFavIcon

private static java.io.File downloadFavIcon(JNLPFile file)

cantCache

private void cantCache()
                throws XDesktopEntry.NonFileProtocolException

Throws:

XDesktopEntry.NonFileProtocolException

getShortcutName

private java.lang.String getShortcutName()

getDesktopIconFile

public java.io.File getDesktopIconFile()

Specified by:

getDesktopIconFile in interface GenericDesktopEntry

getDesktop

static java.io.File getDesktop()

getLinuxMenuIconFile

public java.io.File getLinuxMenuIconFile()

Specified by:

getLinuxMenuIconFile in interface GenericDesktopEntry

getShortcutFileName

private java.lang.String getShortcutFileName()

findAndVerifyGeneratedJnlpDir

private static java.lang.String findAndVerifyGeneratedJnlpDir()

findAndVerifyJavawsMenuDir

private static java.lang.String findAndVerifyJavawsMenuDir()

findAndVerifyBasicDir

private static java.lang.String findAndVerifyBasicDir(java.io.File f,
                                                      java.lang.String message)

findFreedesktopOrgDesktopPathCatch

public static java.lang.String findFreedesktopOrgDesktopPathCatch()

findFreedesktopOrgDesktopPath

private static java.lang.String findFreedesktopOrgDesktopPath()
                                                       throws java.io.IOException

Instead of having all this parsing of user-dirs.dirs and replacing variables we can execute `echo $(xdg-user-dir DESKTOP)` and it will do all the job in case approaches below become failing

Returns:

variables (if declared) and quotation marks (unless escaped) free path

Throws:

java.io.IOException - if no file do not exists or key with desktop do not exists

getFreedesktopOrgDesktopPathFrom

private static java.lang.String getFreedesktopOrgDesktopPathFrom(java.io.File userDirs)
                                                          throws java.io.IOException

Throws:

java.io.IOException

getFreedesktopOrgDesktopPathFrom

static java.lang.String getFreedesktopOrgDesktopPathFrom(java.io.BufferedReader r)
                                                  throws java.io.IOException

Throws:

java.io.IOException

filterQuotes

private static java.lang.String filterQuotes(java.lang.String string)

evaluateLinuxVariables

private static java.lang.String evaluateLinuxVariables(java.lang.String orig)

evaluateLinuxVariables

private static java.lang.String evaluateLinuxVariables(java.lang.String orig,
                                                       java.util.Map<java.lang.String,java.lang.String> variables)

createShortcutOnWindowsDesktop

public void createShortcutOnWindowsDesktop()

Specified by:

createShortcutOnWindowsDesktop in interface GenericDesktopEntry

createWindowsMenu

public void createWindowsMenu()

Specified by:

createWindowsMenu in interface GenericDesktopEntry