com.screenscraper.util.images

Class TwoCaptchaDecoder

java.lang.Object

com.screenscraper.util.images.ImageDecoder

com.screenscraper.util.images.TwoCaptchaDecoder

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class TwoCaptchaDecoder
extends ImageDecoder

A captcha decoder class for https://2captcha.com.

Field Summary

Fields

Modifier and Type	Field and Description
static int	EITHER_NUMERIC_OR_LETTERS_CAPTCHA Constant for captcha can contain both letters and numbers
static int	LETTERS_CAPTCHA Constant for captcha should only contain letters
static int	NUMERIC_CAPTCHA Constant for captcha should only contain numbers
static int	UNSPECIFIED_CAPTCHA_TYPE Constant for captcha type unspecified (let the captcha solver decide how to handle it)

Fields inherited from class com.screenscraper.util.images.ImageDecoder

session

Constructor Summary

Constructors

Constructor and Description
TwoCaptchaDecoder(ScrapingSession session, java.lang.String apiKey) Instantiates a new TwoCaptchaDecoder for the given session with the provided API key.

Method Summary

Modifier and Type	Method and Description
void	close() Closes any resources associated with the decoder.
DecodedImage	decodeFile(java.io.File file) Converts the image given to a DecodedImage that will handle it.
DecodedImage	decodeFile(java.io.File file, boolean phraseContainsTwoWords, boolean isCaseSensitive, int numericFlag, boolean mathCaptcha) Returns the solution to the given captcha image file as a DecodedImage.
double	getBalance() Returns the current balance of the account (if it can be accessed via the API).
com.screenscraper.util.images.TwoCaptchaDecoder.TwoCaptchaResponse	solveReCaptcha2Captcha(java.lang.String siteKey, java.lang.String pageURL) Returns the solution to the given reCaptcha 2.0 captcha.
com.screenscraper.util.images.TwoCaptchaDecoder.TwoCaptchaResponse	solveRotateCaptcha(java.lang.Integer angle, java.io.File... images) Returns the solution to the given rotate captcha.
com.screenscraper.util.images.TwoCaptchaDecoder.TwoCaptchaResponse	solveRotateCaptcha(java.lang.Integer angle, java.io.File image) Returns the solution to the given rotate captcha.
com.screenscraper.util.images.TwoCaptchaDecoder.TwoCaptchaResponse	solveTextCaptcha(java.lang.String text, java.lang.String instructions) Returns the solution to the given text captcha, using the specified instructions.
java.lang.String	toString()

Methods inherited from class com.screenscraper.util.images.ImageDecoder

decodeFile, decodeURL, setAutoCloseAfterScrapeEnds

Methods inherited from class java.lang.Object

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

Field Detail

UNSPECIFIED_CAPTCHA_TYPE

public static final int UNSPECIFIED_CAPTCHA_TYPE

Constant for captcha type unspecified (let the captcha solver decide how to handle it)

See Also:

Constant Field Values

NUMERIC_CAPTCHA

public static final int NUMERIC_CAPTCHA

Constant for captcha should only contain numbers

See Also:

Constant Field Values

LETTERS_CAPTCHA

public static final int LETTERS_CAPTCHA

Constant for captcha should only contain letters

See Also:

Constant Field Values

EITHER_NUMERIC_OR_LETTERS_CAPTCHA

public static final int EITHER_NUMERIC_OR_LETTERS_CAPTCHA

Constant for captcha can contain both letters and numbers

See Also:

Constant Field Values

Constructor Detail

TwoCaptchaDecoder

public TwoCaptchaDecoder(@NotNull
                         ScrapingSession session,
                         @NotNull
                         java.lang.String apiKey)

Instantiates a new TwoCaptchaDecoder for the given session with the provided API key.

Parameters:

session - The current scraping session.

apiKey - Your https://2captcha.com API key.

Method Detail

solveTextCaptcha

@NotNull
public com.screenscraper.util.images.TwoCaptchaDecoder.TwoCaptchaResponse solveTextCaptcha(@NotNull
                                                                                                     java.lang.String text,
                                                                                                     @Nullable
                                                                                                     java.lang.String instructions)

Returns the solution to the given text captcha, using the specified instructions.

Parameters:

text - the text captcha. Cannot exceed 140 characters.

instructions - the instructions to solve the captcha. Cannot exceed 140 characters.

Returns:

the solution to the captcha, as a DecodedImage.

solveReCaptcha2Captcha

@NotNull
public com.screenscraper.util.images.TwoCaptchaDecoder.TwoCaptchaResponse solveReCaptcha2Captcha(@NotNull
                                                                                                           java.lang.String siteKey,
                                                                                                           @NotNull
                                                                                                           java.lang.String pageURL)

Returns the solution to the given reCaptcha 2.0 captcha. Note this will send the current proxy information

Parameters:

siteKey - The google key for the site with reCaptcha 2.0. This value won't change for a site unless the site admin manually updates it.

pageURL - The URL of the page, which is required for captcha resolution to succeed

Returns:

the solution to the captcha, as a DecodedImage.

solveRotateCaptcha

@NotNull
public com.screenscraper.util.images.TwoCaptchaDecoder.TwoCaptchaResponse solveRotateCaptcha(@Nullable
                                                                                                       java.lang.Integer angle,
                                                                                                       java.io.File image)

Returns the solution to the given rotate captcha.

Parameters:

angle - The rotation angle to use (defaults to 40, which is for FunCaptcha)

image - The image that is to be rotated

Returns:

The solution to the captcha, as a DecodedImage. The result value is how many degrees to rotate the image (positive is clockwise, negative is counterclockwise)

solveRotateCaptcha

@NotNull
public com.screenscraper.util.images.TwoCaptchaDecoder.TwoCaptchaResponse solveRotateCaptcha(@Nullable
                                                                                                       java.lang.Integer angle,
                                                                                                       java.io.File... images)

Returns the solution to the given rotate captcha.

Parameters:

angle - The rotation angle to use (defaults to 40, which is for FunCaptcha)

images - The images that are to be rotated

Returns:

The solution to the captcha, as a DecodedImage. The result value is how many degrees to rotate the images (pipe delimited) (positive is clockwise, negative is counterclockwise)

decodeFile

@NotNull
public DecodedImage decodeFile(@NotNull
                                         java.io.File file)

Description copied from class: ImageDecoder

Converts the image given to a DecodedImage that will handle it. Does not delete the file.

Specified by:

decodeFile in class ImageDecoder

Parameters:

file - The image file

Returns:

A DecodedImage used to decode the image

decodeFile

@NotNull
public DecodedImage decodeFile(@NotNull
                                         java.io.File file,
                                         boolean phraseContainsTwoWords,
                                         boolean isCaseSensitive,
                                         int numericFlag,
                                         boolean mathCaptcha)

Returns the solution to the given captcha image file as a DecodedImage. Includes optional additional parameters for specifying characteristics of the captcha.

Parameters:

file - the captcha image file.

phraseContainsTwoWords - false if the captcha only contains one word, true if it contains two.

isCaseSensitive - indicates whether or not the captcha is case sensitive.

numericFlag - specifies the type of captcha. Use static constants provided in this class to specify value.

mathCaptcha - indicates whether or not math is required for the captcha.

Returns:

a DecodedImage object containing the solution to the captcha.

getBalance

public double getBalance()

Description copied from class: ImageDecoder

Returns the current balance of the account (if it can be accessed via the API). Each type of decoder may have it's own interpretation of balance. For example, some may be the amount of images that can still be resolved, others may be a dollar amount

Specified by:

getBalance in class ImageDecoder

Returns:

The current remaining balance in the account, if applicable.

close

public void close()

Description copied from class: ImageDecoder

Closes any resources associated with the decoder. This may include logging out. This method should ALWAYS be called when done with the decoder. Some types of decoders may not need this. Note that once this is called, you should no longer use this decoder, including reporting any images it decoded as bad.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class ImageDecoder

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object