Text.Recognition.Antigate

Example:

 {-# LANGUAGE OverloadedStrings #-}
 import Text.Recognition.Antigate
 import Data.Default
 import Network
 import Control.Monad
 import Control.Monad.IO.Class
 import Data.ByteString.Lazy hiding (putStrLn)
 import System.Timeout

 myApiKey :: ApiKey
 myApiKey = "0123456789abcdef0123456789abcdef"{api_host="antigate.com"}

 downloadJpegCaptcha :: Manager -> IO ByteString
 downloadJpegCaptcha = undefined

 answerCaptcha :: String -> Manager -> IO Bool
 answerCaptcha = undefined

 main :: IO ()
 main = withSocketsDo $ do
     res <- timeout (30*1000000) $ withManager $ \m -> do
         bytes <- liftIO $ downloadJpegCaptcha m
         (id, answer) <- solveCaptcha def myApiKey def{phrase=True} "captcha.jpg" bytes m
         res <- liftIO $ answerCaptcha answer m
         unless res $ reportBad myApiKey id m
         return res
     case res of
         Nothing -> do
             putStrLn "Timed out"
         Just True -> do
             putStrLn "Solved successfully"
         Just False -> do
             putStrLn "Couldn't solve"

Documentation

data ApiKey

Antigate API access key paired with service provider's host. At least these services claim to support Antigate API: Antigate, Captchabot, Decaptcher, ExpertDecoders, ImageTyperz, DeathByCaptcha and Pixodrom.

Instances

Eq ApiKey

Ord ApiKey

Read ApiKey

Show ApiKey

IsString ApiKey

Default ApiKey

NFData ApiKey

api_key :: ApiKey -> String

This is a record selector

api_host :: ApiKey -> String

default: "antigate.com". This is a record selector

type CaptchaID = Int

data CaptchaConf

Properties of the captcha to be solved. See http://antigate.com/panel.php?action=api

Constructors

CaptchaConf

Fields

phrase :: Bool

• False = default value (one word)
• True = captcha has 2-4 words

regsense :: Bool

• False = default value (case is not important)
• True = captcha is case sensitive

numeric :: Maybe Bool

• Nothing = default value
• Just True = captcha consists from numbers only
• Just False = captcha does not have numbers on it

calc :: Bool

• False = default value
• True = numbers on captcha must be summed

min_len :: Word

• 0 = default value
• >0 = minimum length of captcha text workers required to input

max_len :: Word

• 0 = default value (unlimited)
• >0 = maximum length of captcha text workers required to input

is_russian :: Bool

• False = default value
• True = captcha goes to Russian-speaking worker

max_bid :: Maybe Double

Default value is set on bids page. This parameter allows to control maximum bid without setting it on the bids page.

Instances

Read CaptchaConf

Show CaptchaConf

Default CaptchaConf

NFData CaptchaConf

data ApiResult a

Constructors

OK a

CAPCHA_NOT_READY

captcha is not recognized yet, repeat request withing 1-5 seconds

ERROR_WRONG_USER_KEY

user authorization key is invalid (its length is not 32 bytes as it should be)

ERROR_WRONG_ID_FORMAT

the captcha ID you are sending is non-numeric

ERROR_KEY_DOES_NOT_EXIST

you have set wrong user authorization key in request

ERROR_ZERO_BALANCE

account has zero or negative balance

ERROR_NO_SLOT_AVAILABLE

no idle captcha workers are available at the moment, please try a bit later or try increasing your bid

ERROR_ZERO_CAPTCHA_FILESIZE

the size of the captcha you are uploading or pointing to is zero

ERROR_TOO_BIG_CAPTCHA_FILESIZE

your captcha size is exceeding 100kb limit

ERROR_WRONG_FILE_EXTENSION

your captcha file has wrong extension, the only allowed extensions are gif,jpg,jpeg,png

ERROR_IMAGE_TYPE_NOT_SUPPORTED

Could not determine captcha file type, only allowed formats are JPG, GIF, PNG

ERROR_IP_NOT_ALLOWED

Request with current account key is not allowed from your IP. Please refer to IP list section

ERROR_UNKNOWN String

Instances

Functor ApiResult

Eq a => Eq (ApiResult a)

Read a => Read (ApiResult a)

Show a => Show (ApiResult a)

NFData a => NFData (ApiResult a)

High level

data SolveException

Constructors

SolveExceptionUpload (ApiResult ())

SolveExceptionCheck CaptchaID (ApiResult ())

Instances

Show SolveException

Typeable SolveException

Exception SolveException

NFData SolveException

data SolveConf

Constructors

SolveConf

Fields

api_upload_sleep :: [Int]

how much to sleep while waiting for available slot; in microseconds.

Default: [3000000]

api_check_sleep :: [Int]

how much to sleep between captcha checks; in microseconds.

Default: [6000000,2000000,3000000] -- sleep 6 seconds before checking, on first retry sleep 2 seconds, then always sleep 3 seconds. List can be infinite

api_counter :: Phase -> Int -> IO ()

api_counter will be called at the start of each phase

 api_counter = \phase count -> do
     if count == 0
       then putStrLn $ show phase ++ " began"
       else putStrLn $ show phase ++ " retries: " ++ show count

Default: _ _ -> return ()

api_upload_callback :: CaptchaID -> IO ()

This will be called when upload phase finishes

Instances

Show SolveConf

Default SolveConf

NFData SolveConf

data Phase

Constructors

UploadPhase

CheckPhase

Instances

Bounded Phase

Enum Phase

Eq Phase

Ord Phase

Read Phase

Show Phase

NFData Phase

solveCaptcha

Arguments

:: MonadResource m

=> SolveConf

-> ApiKey

-> CaptchaConf

-> FilePath

image filename (antigate guesses filetype by file extension)

-> ByteString

image contents

-> Manager

HTTP connection manager to use

-> m (CaptchaID, String)

High level function to solve captcha, blocks until answer is provided (about 2-10 seconds).

throws SolveException or HttpException when something goes wrong.

solveCaptchaFromFile :: (MonadBaseControl IO m, MonadResource m) => SolveConf -> ApiKey -> CaptchaConf -> FilePath -> Manager -> m (CaptchaID, String)

Core functions

uploadCaptcha :: MonadResource m => ApiKey -> CaptchaConf -> FilePath -> ByteString -> Manager -> m (ApiResult CaptchaID)

upload captcha for recognition

throws HttpException on network errors.

uploadCaptchaFromFile :: MonadResource m => ApiKey -> CaptchaConf -> FilePath -> Manager -> m (ApiResult CaptchaID)

checkCaptcha :: MonadResource m => ApiKey -> CaptchaID -> Manager -> m (ApiResult String)

retrieve captcha status

throws HttpException on network errors.

checkCaptchas :: MonadResource m => ApiKey -> [CaptchaID] -> Manager -> m [ApiResult String]

retrieve multiple captcha status

throws HttpException on network errors.

reportBad :: MonadResource m => ApiKey -> CaptchaID -> Manager -> m Bool

report bad captcha result

throws HttpException on network errors.

getBalance :: MonadResource m => ApiKey -> Manager -> m Double

retrieve your current account balance

throws HttpException on network errors.

Connection manager

data Manager

Keeps track of open connections for keep-alive. If possible, you should share a single Manager between multiple threads and requests.

newManager :: ManagerSettings -> IO Manager

Create a Manager. You must manually call closeManager to shut it down.

Creating a new Manager is an expensive operation, you are advised to share a single Manager between requests instead.

closeManager :: Manager -> IO ()

Close all connections in a Manager. Afterwards, the Manager can be reused if desired.

Note that this doesn't affect currently in-flight connections, meaning you can safely use it without hurting any queries you may have concurrently running.

withManager :: (MonadIO m, MonadBaseControl IO m, MonadThrow m, MonadUnsafeIO m) => (Manager -> ResourceT m a) -> m a

Create a new manager, use it in the provided function, and then release it.

This function uses the default manager settings. For more control, use withManagerSettings.

Miscellaneous

parseUploadResponse :: String -> ApiResult CaptchaID

Parse antigate's upload response

parseCheckResponse :: String -> ApiResult String

Parse antigate's check response

parseMultiCheckResponse :: String -> ApiResult String

Parse antigate's multi-check response

parseMultiCheckResponses :: String -> [ApiResult String]

Parse antigate's multi-check response

renderApiResult :: ApiResult String -> String

Marshal ApiResult back to its text form