idk/i2p.plugins.firefox
1
0
Fork 0
Code Issues 5 Pull Requests Actions Packages Projects Releases Wiki Activity

update index.html

Browse Source
This commit is contained in:
idk
2022-08-27 23:23:11 -04:00
parent 53669601fc
commit f438b6c292
3 changed files with 239 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
I2PBrowser.md
View File

@ -36,6 +36,13 @@ package: net.i2p.i2pfirefox
+ Access: private + Access: private
+ Modifiers: final + Modifiers: final
#### I2PGenericUnsafeBrowser i2pGeneral [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L)
>
+ Access: private
+ Modifiers: final
#### boolean firefox [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L) #### boolean firefox [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L)
> >
@ -56,7 +63,7 @@ package: net.i2p.i2pfirefox
## Methods ## Methods
### launchFirefox [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L30) ### launchFirefox [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L31)
+ Description: + Description:
+ Access: private + Access: private
@ -68,18 +75,7 @@ package: net.i2p.i2pfirefox
| url | String[] | | | url | String[] | |
### launchFirefox [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L34) ### launchChromium [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L35)
+ Description:
+ Access: private
+ return: void
| Name | Type | Description |
| ----- | ----- | ----- |
| privateWindow | boolean | |
### launchChromium [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L38)
+ Description: + Description:
+ Access: private + Access: private
@ -91,7 +87,7 @@ package: net.i2p.i2pfirefox
| url | String[] | | | url | String[] | |
### launchChromium [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L42) ### launchGeneric [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L39)
+ Description: + Description:
+ Access: private + Access: private
@ -100,9 +96,10 @@ package: net.i2p.i2pfirefox
| Name | Type | Description | | Name | Type | Description |
| ----- | ----- | ----- | | ----- | ----- | ----- |
| privateWindow | boolean | | | privateWindow | boolean | |
| url | String[] | |
### hasChromium [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L61) ### hasChromium [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L58)
+ Description: Return true if there is a Chromium available + Description: Return true if there is a Chromium available
+ Access: public + Access: public
@ -111,7 +108,7 @@ package: net.i2p.i2pfirefox
This method has no parameters. This method has no parameters.
### hasFirefox [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L78) ### hasFirefox [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L75)
+ Description: Return true if there is a Firefox variant available + Description: Return true if there is a Firefox variant available
+ Access: public + Access: public
@ -120,7 +117,7 @@ This method has no parameters.
This method has no parameters. This method has no parameters.
### launch [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L97) ### launch [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L94)
+ Description: Populates a profile directory with a proxy configuration. Waits for an HTTP proxy on the port 4444 to be ready. Launches either Firefox or Chromium with the profile directory. + Description: Populates a profile directory with a proxy configuration. Waits for an HTTP proxy on the port 4444 to be ready. Launches either Firefox or Chromium with the profile directory.
+ Access: public + Access: public
@ -132,7 +129,7 @@ This method has no parameters.
| url | String[] | | | url | String[] | |
### launch [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L130) ### launch [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L133)
+ Description: Populates a profile directory with a proxy configuration. Waits for an HTTP proxy on the port 4444 to be ready. Launches either Firefox or Chromium with the profile directory. + Description: Populates a profile directory with a proxy configuration. Waits for an HTTP proxy on the port 4444 to be ready. Launches either Firefox or Chromium with the profile directory.
+ Access: public + Access: public
@ -143,7 +140,7 @@ This method has no parameters.
| privateWindow | boolean | | | privateWindow | boolean | |
### launch [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L141) ### launch [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L144)
+ Description: Populates a profile directory with a proxy configuration. Waits for an HTTP proxy on the port 4444 to be ready. Launches either Firefox or Chromium with the profile directory. + Description: Populates a profile directory with a proxy configuration. Waits for an HTTP proxy on the port 4444 to be ready. Launches either Firefox or Chromium with the profile directory.
+ Access: public + Access: public
@ -152,7 +149,7 @@ This method has no parameters.
This method has no parameters. This method has no parameters.
### ValidURL [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L145) ### ValidURL [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L148)
+ Description: + Description:
+ Access: private + Access: private
@ -164,7 +161,7 @@ This method has no parameters.
| inUrl | String | | | inUrl | String | |
### main [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L155) ### main [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L158)
+ Description: + Description:
+ Access: public + Access: public

216
I2PGenericUnsafeBrowser.md Normal file
View File

@ -0,0 +1,216 @@
# Class I2PGenericUnsafeBrowser [[src]](src/java/net/i2p/i2pfirefox/I2PGenericUnsafeBrowser.java)
>
Access: public
Description:
> I2PChromiumProfileChecker.java Copyright C 2022 idk <hankhill19580@gmail.com> This program is free software: you can redistribute it and/or modify it under the terms of the MIT License. See LICENSE.md for details. This program is distributed in the hope that it will be useful but WITHOUT ANY WARRANTY without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. I2PGenericUnsafeBrowser is a wrapper which sets common environment variables for the process controlled by a processbuilder. ALWAYS ALWAYS ALWAYS try the Firefox and Chromium specific launchers first.
Author: idk
package: net.i2p.i2pfirefox
## Dependencies
<details>
<summary>
Show dependencies
</summary>
<ul>
<li>java.io.File</li>
<li>java.io.IOException</li>
<li>java.net.Socket</li>
<li>java.util.ArrayList</li>
<li>java.util.Scanner</li>
</ul>
</details>
## Member Variables
#### int DEFAULT_TIMEOUT [[src]](src/java/net/i2p/i2pfirefox/I2PGenericUnsafeBrowser.java#L)
>
+ Access: private
+ Modifiers: final
## Methods
### getDefaultWindowsBrowser [[src]](src/java/net/i2p/i2pfirefox/I2PGenericUnsafeBrowser.java#L90)
+ Description: Obtains the default browser for the Windows platform which by now should be Edgium in the worst-case scenario but in case it isn't we can use this function to figure it out. It can find: 1. The current user's HTTPS default browser if they configured it to be non-default 2. The current user's HTTP default browser if they configured it to be non-default 3. Edgium if it's available 4. iexplore if it's not and it will return the first one we find in exactly that order. Adapted from: and from:
+ Access: public
+ Modifiers: static
+ return: String
This method has no parameters.
### getDefaultOutOfRegistry [[src]](src/java/net/i2p/i2pfirefox/I2PGenericUnsafeBrowser.java#L114)
+ Description: obtains information out of the Windows registry.
+ Access: public
+ Modifiers: static
+ return: String
| Name | Type | Description |
| ----- | ----- | ----- |
| hkeyquery | String | registry entry to ask for. |
### scanAPath [[src]](src/java/net/i2p/i2pfirefox/I2PGenericUnsafeBrowser.java#L137)
+ Description:
+ Access: private
+ Modifiers: static
+ return: String
| Name | Type | Description |
| ----- | ----- | ----- |
| dir | String | |
### getAnyUnixBrowser [[src]](src/java/net/i2p/i2pfirefox/I2PGenericUnsafeBrowser.java#L152)
+ Description: Find any browser in our list within a UNIX path
+ Access: public
+ Modifiers: static
+ return: String
This method has no parameters.
### findUnsafeBrowserAnywhere [[src]](src/java/net/i2p/i2pfirefox/I2PGenericUnsafeBrowser.java#L171)
+ Description: Find any usable browser and output the whole path
+ Access: public
+ Modifiers: static
+ return: String
This method has no parameters.
### deleteRuntimeDirectory [[src]](src/java/net/i2p/i2pfirefox/I2PGenericUnsafeBrowser.java#L212)
+ Description: delete the runtime directory
+ Access: public
+ Modifiers: static
+ return: boolean
This method has no parameters.
### runtimeDirectory [[src]](src/java/net/i2p/i2pfirefox/I2PGenericUnsafeBrowser.java#L228)
+ Description: get the runtime directory creating it if create=true
+ Access: public
+ Modifiers: static
+ return: the runtime directory or null if it could not be created
| Name | Type | Description |
| ----- | ----- | ----- |
| create | boolean | if true create the runtime directory if it does not exist |
### runtimeDirectory [[src]](src/java/net/i2p/i2pfirefox/I2PGenericUnsafeBrowser.java#L245)
+ Description: get the correct runtime directory
+ Access: public
+ Modifiers: static
+ return: the runtime directory or null if it could not be created or found
This method has no parameters.
### waitForProxy [[src]](src/java/net/i2p/i2pfirefox/I2PGenericUnsafeBrowser.java#L293)
+ Description: Waits for an HTTP proxy on port 4444 to be ready. Returns false on timeout of 200 seconds.
+ Access: public
+ return: true if the proxy is ready false if it is not.
This method has no parameters.
### waitForProxy [[src]](src/java/net/i2p/i2pfirefox/I2PGenericUnsafeBrowser.java#L305)
+ Description: Waits for an HTTP proxy on port 4444 to be ready. Returns false on timeout of the specified number of seconds.
+ Access: public
+ return: true if the proxy is ready false if it is not.
| Name | Type | Description |
| ----- | ----- | ----- |
| timeout | int | the number of seconds to wait for the proxy to be ready. |
### waitForProxy [[src]](src/java/net/i2p/i2pfirefox/I2PGenericUnsafeBrowser.java#L317)
+ Description: Waits for an HTTP proxy on the specified port to be ready. Returns false on timeout of the specified number of seconds.
+ Access: public
+ return: true if the proxy is ready false if it is not.
| Name | Type | Description |
| ----- | ----- | ----- |
| timeout | int | the number of seconds to wait for the proxy to be ready. |
| port | int | the port to wait for the proxy to be ready on. |
### waitForProxy [[src]](src/java/net/i2p/i2pfirefox/I2PGenericUnsafeBrowser.java#L331)
+ Description: Waits for an HTTP proxy on the specified port to be ready. Returns false on timeout of the specified number of seconds.
+ Access: public
+ return: true if the proxy is ready false if it is not.
| Name | Type | Description |
| ----- | ----- | ----- |
| timeout | int | the number of seconds to wait for the proxy to be ready. |
| port | int | the port to wait for the proxy to be ready on. |
| host | String | the host to wait for the proxy to be ready on. |
### launch [[src]](src/java/net/i2p/i2pfirefox/I2PGenericUnsafeBrowser.java#L346)
+ Description:
+ Access: public
+ return: void
| Name | Type | Description |
| ----- | ----- | ----- |
| privateWindow | boolean | |
| url | String[] | |
### sleep [[src]](src/java/net/i2p/i2pfirefox/I2PGenericUnsafeBrowser.java#L375)
+ Description:
+ Access: private
+ Modifiers: static
+ return: void
| Name | Type | Description |
| ----- | ----- | ----- |
| millis | int | |
### ValidURL [[src]](src/java/net/i2p/i2pfirefox/I2PGenericUnsafeBrowser.java#L383)
+ Description:
+ Access: private
+ Modifiers: static
+ return: String
| Name | Type | Description |
| ----- | ----- | ----- |
| inUrl | String | |
### checkifPortIsOccupied [[src]](src/java/net/i2p/i2pfirefox/I2PGenericUnsafeBrowser.java#L393)
+ Description:
+ Access: private
+ return: boolean
| Name | Type | Description |
| ----- | ----- | ----- |
| port | int | |
| host | String | |

5
index.html
View File

@ -77,6 +77,11 @@
I2PFirefoxProfileUnpacker I2PFirefoxProfileUnpacker
</a> </a>
</li> </li>
<li>
<a href="I2PGenericUnsafeBrowser.html">
I2PGenericUnsafeBrowser
</a>
</li>
<li> <li>
<a href="LICENSE.html"> <a href="LICENSE.html">
LICENSE LICENSE