I2PSnarkServlet (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- javax.servlet.GenericServlet
- - javax.servlet.http.HttpServlet
  - - org.klomp.snark.web.BasicServlet
    - - org.klomp.snark.web.I2PSnarkServlet

All Implemented Interfaces:
Serializable, Servlet, ServletConfig
```
public class I2PSnarkServlet
extends BasicServlet
```
Web interface servlet for I2PSnark torrent management.
This servlet provides the complete web-based user interface for I2PSnark, allowing users to manage their torrents through a browser. It handles:
- Torrent listing and status display
- Adding torrents from files, URLs, or magnet links
- Torrent creation from local files
- Peer management and connection monitoring
- Bandwidth configuration and statistics
- DHT and tracker status
- Comments and ratings system
- File browsing and downloading
- Configuration management
- Theme and localization support
The servlet has been refactored to eliminate Jetty-specific dependencies and works with standard servlet containers.
Security features include:
- CSRF protection via nonces
- Content Security Policy headers
- Input validation and sanitization
- Secure file handling
See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.klomp.snark.web.BasicServlet
  BasicServlet.HttpContent

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) String`	`cspNonce` Csp nonce
`(package private) static char`	`HELLIP` Ellipsis character used to truncate long names.
`(package private) static int`	`MAX_DISPLAYED_FILENAME_LENGTH` Longest file name shown before truncation.
`static String`	`PROP_CONFIG_FILE` Config file path property.
`static String`	`WARBASE` Webapp resource base path.

Fields inherited from class org.klomp.snark.web.BasicServlet
_context, _log, _resourceBase

Constructor Summary
Constructors
Constructor and Description
I2PSnarkServlet()

Constructors
Constructor and Description
`I2PSnarkServlet()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`browserApiAuthorized(boolean enabled, boolean hostAllowed, String providedKey, String configuredKey)` Pure decision function for browser API authorization (unit-testable): requires the API to be enabled and the client to be an allowed host or to present the configured API key.
`static String`	`buildBridgeMetaTag(String baseUrl)` The meta element advertising the base URL of the I2PSnark webapp that served this page, so the I2PSnark Bridge extension's content script can discover the exact origin + context path (host, port, https) and route subsequent magnet: handoffs to it.
`void`	`destroy()` Destroy the servlet.
`void`	`doGet(HttpServletRequest request, HttpServletResponse response)` Handle what we can here, calling super.doGet() for the rest.
`void`	`doPost(HttpServletRequest request, HttpServletResponse response)` Handle what we can here, calling super.doPost() for the rest.
`File`	`getResource(String pathInContext)` We override this to set the file relative to the storage directory for the torrent.
`void`	`init(ServletConfig cfg)` Initialize the servlet.
`boolean`	`isAdvanced()` Returns whether advanced mode is enabled in the router console.
`static boolean`	`isFirefoxFamilyUserAgent(String ua)` Whether the given User-Agent header indicates a Firefox-family browser (Firefox, LibreWolf, Waterfox, Pale Moon, Tor Browser), which can install the I2PSnark Bridge extension.
`static boolean`	`isValidBase32InfoHash(String s)` Validates if a string is a valid 32-base32 character info hash.
`static boolean`	`isValidHexInfoHash(String s)` Validates if a string is a valid 40-hex character info hash.
`static boolean`	`isValidV2InfoHash(String s)` Validates if string is version 2 hex multihash (68 characters starting with "1220").
`static boolean`	`isWindowsUserAgent(String ua)` Whether the given User-Agent header indicates Windows, which gets the PowerShell installer script instead of the shell one.
`(package private) boolean`	`multiDestSortEnabled()` Whether pool badges and pool-based sorting apply: multi-dest mode with more than one active destination.
`(package private) String`	`toIcon(String path)` Returns the icon name representing the file type or mime type of the given file path.
`(package private) static String`	`urlify(String s)` This is for a full URL.
`boolean`	`useSoraFont()` Returns whether the Sora display font should be used.

Methods inherited from class org.klomp.snark.web.BasicServlet
addMimeMapping, addPaths, decodePath, doDelete, doOptions, doTrace, encodePath, getContent, getMimeType, loadMimeMap, passConditionalHeaders, sendData, setResourceBase, setWarBase, writeHeaders

Methods inherited from class javax.servlet.http.HttpServlet
doHead, doPut, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet
getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - cspNonce
```
String cspNonce
```
    Csp nonce
  - HELLIP
```
static final char HELLIP
```
    Ellipsis character used to truncate long names.
    See Also:
    Constant Field Values
  - MAX_DISPLAYED_FILENAME_LENGTH
```
static final int MAX_DISPLAYED_FILENAME_LENGTH
```
    Longest file name shown before truncation.
    See Also:
    Constant Field Values
  - PROP_CONFIG_FILE
```
public static final String PROP_CONFIG_FILE
```
    Config file path property.
    See Also:
    Constant Field Values
  - WARBASE
```
public static final String WARBASE
```
    Webapp resource base path.
    See Also:
    Constant Field Values
- Constructor Detail
  - I2PSnarkServlet
```
public I2PSnarkServlet()
```
- Method Detail
  - browserApiAuthorized
```
public static boolean browserApiAuthorized(boolean enabled,
                                           boolean hostAllowed,
                                           String providedKey,
                                           String configuredKey)
```
    Pure decision function for browser API authorization (unit-testable): requires the API to be enabled and the client to be an allowed host or to present the configured API key.
    Parameters:
    enabled - the browser API enable flag
    hostAllowed - whether the client address is loopback or on the allowlist
    providedKey - the apiKey request parameter, may be null
    configuredKey - the configured API key, may be null or empty
    Returns:
    whether the request is authorized
  - buildBridgeMetaTag
```
public static String buildBridgeMetaTag(String baseUrl)
```
    The meta element advertising the base URL of the I2PSnark webapp that served this page, so the I2PSnark Bridge extension's content script can discover the exact origin + context path (host, port, https) and route subsequent magnet: handoffs to it. This is authoritative even when the context path or listening port differs from the extension's manifest default (e.g. standalone I2PSnark on port 8002, custom console port).
    Parameters:
    baseUrl - the webapp base URL, e.g. http://127.0.0.1:8002/i2psnark
    Returns:
    a single HTML meta line, or empty string when no URL is available
  - destroy
```
public void destroy()
```
    Destroy the servlet.
    Specified by:
    destroy in interface Servlet
    Overrides:
    destroy in class GenericServlet
  - doGet
```
public void doGet(HttpServletRequest request,
                  HttpServletResponse response)
           throws ServletException,
                  IOException
```
    Handle what we can here, calling super.doGet() for the rest.
    Overrides:
    doGet in class BasicServlet
    Throws:
    ServletException
    IOException
  - doPost
```
public void doPost(HttpServletRequest request,
                   HttpServletResponse response)
            throws ServletException,
                   IOException
```
    Handle what we can here, calling super.doPost() for the rest.
    Overrides:
    doPost in class BasicServlet
    Parameters:
    request - the HTTP request
    response - the HTTP response
    Throws:
    ServletException - if a servlet error occurs
    IOException - if an I/O error occurs
  - getResource
```
public File getResource(String pathInContext)
```
    We override this to set the file relative to the storage directory for the torrent.
    Overrides:
    getResource in class BasicServlet
    Parameters:
    pathInContext - should always start with /
    Returns:
    the resource
  - init
```
public void init(ServletConfig cfg)
          throws ServletException
```
    Initialize the servlet.
    Specified by:
    init in interface Servlet
    Overrides:
    init in class BasicServlet
    Parameters:
    cfg - the servlet config
    Throws:
    ServletException - if initialization fails
  - isAdvanced
```
public boolean isAdvanced()
```
    Returns whether advanced mode is enabled in the router console.
    Returns:
    true if advanced mode is enabled
  - isFirefoxFamilyUserAgent
```
public static boolean isFirefoxFamilyUserAgent(String ua)
```
    Whether the given User-Agent header indicates a Firefox-family browser (Firefox, LibreWolf, Waterfox, Pale Moon, Tor Browser), which can install the I2PSnark Bridge extension. Unit-testable; other browsers get the installer-script fallback instead.
    Parameters:
    ua - the User-Agent header, may be null
    Returns:
    true if the UA names Firefox
  - isValidBase32InfoHash
```
public static boolean isValidBase32InfoHash(String s)
```
    Validates if a string is a valid 32-base32 character info hash.
    Returns:
    whether valid base32 info hash
  - isValidHexInfoHash
```
public static boolean isValidHexInfoHash(String s)
```
    Validates if a string is a valid 40-hex character info hash.
    Returns:
    whether valid hex info hash
  - isValidV2InfoHash
```
public static boolean isValidV2InfoHash(String s)
```
    Validates if string is version 2 hex multihash (68 characters starting with "1220").
    Returns:
    whether valid v2 info hash
  - isWindowsUserAgent
```
public static boolean isWindowsUserAgent(String ua)
```
    Whether the given User-Agent header indicates Windows, which gets the PowerShell installer script instead of the shell one.
    Parameters:
    ua - the User-Agent header, may be null
    Returns:
    true if the UA names Windows
  - multiDestSortEnabled
```
boolean multiDestSortEnabled()
```
    Whether pool badges and pool-based sorting apply: multi-dest mode with more than one active destination.
    Returns:
    true when pooled destinations are in use
  - toIcon
```
String toIcon(String path)
```
    Returns the icon name representing the file type or mime type of the given file path. Determines custom icons for certain special cases like i2p install executables.
    Parameters:
    path - the file path or file name to analyze
    Returns:
    a string representing the icon name matching the file type
  - urlify
```
static String urlify(String s)
```
    This is for a full URL. For a path only, use encodePath().
  - useSoraFont
```
public boolean useSoraFont()
```
    Returns whether the Sora display font should be used.
    Returns:
    true if the Sora font is enabled or running in standalone mode

Class I2PSnarkServlet

Nested Class Summary

Nested classes/interfaces inherited from class org.klomp.snark.web.BasicServlet

Field Summary

Fields inherited from class org.klomp.snark.web.BasicServlet

Constructor Summary

Method Summary

Methods inherited from class org.klomp.snark.web.BasicServlet

Methods inherited from class javax.servlet.http.HttpServlet

Methods inherited from class javax.servlet.GenericServlet

Methods inherited from class java.lang.Object

Field Detail

cspNonce

HELLIP

MAX_DISPLAYED_FILENAME_LENGTH

PROP_CONFIG_FILE

WARBASE

Constructor Detail

I2PSnarkServlet

Method Detail

browserApiAuthorized

buildBridgeMetaTag

destroy

doGet

doPost

getResource

init

isAdvanced

isFirefoxFamilyUserAgent

isValidBase32InfoHash

isValidHexInfoHash

isValidV2InfoHash

isWindowsUserAgent

multiDestSortEnabled

toIcon

urlify

useSoraFont