Test.WebDriver.Firefox.Profile

A module for working with Firefox profiles. Firefox profiles are manipulated in pure code and then "prepared" for network transmission.

Profiles

data Firefox

Phantom type used in the parameters of Profile and PreparedProfile

data Profile b

This structure allows you to construct and manipulate profiles in pure code, deferring execution of IO operations until the profile is "prepared". This type is shared by both Firefox and Opera profiles; when a distinction must be made, the phantom type parameter is used to differentiate.

Constructors

Profile

Fields

• profileFiles :: HashMap FilePath FilePath

  A mapping from relative destination filepaths to source filepaths found on the filesystem. When the profile is prepared, these source filepaths will be moved to their destinations within the profile directory.

  Using the destination path as the key ensures that there is one unique source path going to each destination path.

• profilePrefs :: HashMap Text ProfilePref

  A map of profile preferences. These are the settings found in the profile's prefs.js, and entries found in about:config

Instances

Show (Profile b)

Defined in Test.WebDriver.Common.Profile

Methods

showsPrec :: Int -> Profile b -> ShowS

show :: Profile b -> String

showList :: [Profile b] -> ShowS

Eq (Profile b)

Defined in Test.WebDriver.Common.Profile

Methods

(==) :: Profile b -> Profile b -> Bool

(/=) :: Profile b -> Profile b -> Bool

data PreparedProfile b

Represents a profile that has been prepared for network transmission. The profile cannot be modified in this form.

Instances

FromJSON (PreparedProfile s)

Defined in Test.WebDriver.Common.Profile

Methods

parseJSON :: Value -> Parser (PreparedProfile s)

parseJSONList :: Value -> Parser [PreparedProfile s]

ToJSON (PreparedProfile s)

Defined in Test.WebDriver.Common.Profile

Methods

toJSON :: PreparedProfile s -> Value

toEncoding :: PreparedProfile s -> Encoding

toJSONList :: [PreparedProfile s] -> Value

toEncodingList :: [PreparedProfile s] -> Encoding

Show (PreparedProfile b)

Defined in Test.WebDriver.Common.Profile

Methods

showsPrec :: Int -> PreparedProfile b -> ShowS

show :: PreparedProfile b -> String

showList :: [PreparedProfile b] -> ShowS

Eq (PreparedProfile b)

Defined in Test.WebDriver.Common.Profile

Methods

(==) :: PreparedProfile b -> PreparedProfile b -> Bool

(/=) :: PreparedProfile b -> PreparedProfile b -> Bool

defaultProfile :: Profile Firefox

Default Firefox Profile, used when no profile is supplied.

Preferences

data ProfilePref

A profile preference value. This is the subset of JSON values that excludes arrays, objects, and null.

Constructors

PrefInteger !Integer

PrefDouble !Double

PrefString !Text

PrefBool !Bool

Instances

FromJSON ProfilePref

Defined in Test.WebDriver.Common.Profile

Methods

parseJSON :: Value -> Parser ProfilePref

parseJSONList :: Value -> Parser [ProfilePref]

ToJSON ProfilePref

Defined in Test.WebDriver.Common.Profile

Methods

toJSON :: ProfilePref -> Value

toEncoding :: ProfilePref -> Encoding

toJSONList :: [ProfilePref] -> Value

toEncodingList :: [ProfilePref] -> Encoding

Show ProfilePref

Defined in Test.WebDriver.Common.Profile

Methods

showsPrec :: Int -> ProfilePref -> ShowS

show :: ProfilePref -> String

showList :: [ProfilePref] -> ShowS

Eq ProfilePref

Defined in Test.WebDriver.Common.Profile

Methods

(==) :: ProfilePref -> ProfilePref -> Bool

(/=) :: ProfilePref -> ProfilePref -> Bool

ToPref ProfilePref

Defined in Test.WebDriver.Common.Profile

Methods

toPref :: ProfilePref -> ProfilePref

class ToPref a where

A typeclass to convert types to profile preference values

Methods

toPref :: a -> ProfilePref

Instances

ToPref Int16

Defined in Test.WebDriver.Common.Profile

Methods

toPref :: Int16 -> ProfilePref

ToPref Int32

Defined in Test.WebDriver.Common.Profile

Methods

toPref :: Int32 -> ProfilePref

ToPref Int64

Defined in Test.WebDriver.Common.Profile

Methods

toPref :: Int64 -> ProfilePref

ToPref Int8

Defined in Test.WebDriver.Common.Profile

Methods

toPref :: Int8 -> ProfilePref

ToPref Word16

Defined in Test.WebDriver.Common.Profile

Methods

toPref :: Word16 -> ProfilePref

ToPref Word32

Defined in Test.WebDriver.Common.Profile

Methods

toPref :: Word32 -> ProfilePref

ToPref Word64

Defined in Test.WebDriver.Common.Profile

Methods

toPref :: Word64 -> ProfilePref

ToPref Word8

Defined in Test.WebDriver.Common.Profile

Methods

toPref :: Word8 -> ProfilePref

ToPref Text

Defined in Test.WebDriver.Common.Profile

Methods

toPref :: Text -> ProfilePref

ToPref ProfilePref

Defined in Test.WebDriver.Common.Profile

Methods

toPref :: ProfilePref -> ProfilePref

ToPref String

Defined in Test.WebDriver.Common.Profile

Methods

toPref :: String -> ProfilePref

ToPref Integer

Defined in Test.WebDriver.Common.Profile

Methods

toPref :: Integer -> ProfilePref

ToPref Bool

Defined in Test.WebDriver.Common.Profile

Methods

toPref :: Bool -> ProfilePref

ToPref Double

Defined in Test.WebDriver.Common.Profile

Methods

toPref :: Double -> ProfilePref

ToPref Float

Defined in Test.WebDriver.Common.Profile

Methods

toPref :: Float -> ProfilePref

ToPref Int

Defined in Test.WebDriver.Common.Profile

Methods

toPref :: Int -> ProfilePref

ToPref Word

Defined in Test.WebDriver.Common.Profile

Methods

toPref :: Word -> ProfilePref

Integral a => ToPref (Ratio a)

Defined in Test.WebDriver.Common.Profile

Methods

toPref :: Ratio a -> ProfilePref

HasResolution r => ToPref (Fixed r)

Defined in Test.WebDriver.Common.Profile

Methods

toPref :: Fixed r -> ProfilePref

addPref :: ToPref a => Text -> a -> Profile b -> Profile b

Add a new preference entry to a profile, overwriting any existing entry with the same key.

getPref :: Text -> Profile b -> Maybe ProfilePref

Retrieve a preference from a profile by key name.

deletePref :: Text -> Profile b -> Profile b

Delete an existing preference entry from a profile. This operation is silent if the preference wasn't found.

Extensions

addExtension :: FilePath -> Profile b -> Profile b

Add a new extension to the profile. The file path should refer to a .xpi file or an extension directory on the filesystem.

deleteExtension :: String -> Profile b -> Profile b

Delete an existing extension from the profile. The string parameter should refer to an .xpi file or directory located within the extensions directory of the profile. This operation has no effect if the extension was never added to the profile.

hasExtension :: String -> Profile b -> Bool

Determines if a profile contains the given extension. specified as an .xpi file or directory name

Other files and directories

addFile :: FilePath -> FilePath -> Profile b -> Profile b

Add a file to the profile directory. The first argument is the source of the file on the local filesystem. The second argument is the destination as a path relative to a profile directory. Overwrites any file that previously pointed to the same destination

deleteFile :: FilePath -> Profile b -> Profile b

Delete a file from the profile directory. The first argument is the name of file within the profile directory.

hasFile :: String -> Profile b -> Bool

Determines if a profile contains the given file, specified as a path relative to the profile directory.

Miscellaneous profile operations

unionProfiles :: Profile b -> Profile b -> Profile b

Takes the union of two profiles. This is the union of their HashMap fields.

onProfileFiles :: Profile b -> (HashMap FilePath FilePath -> HashMap FilePath FilePath) -> Profile b

Modifies the profileFiles field of a profile

onProfilePrefs :: Profile b -> (HashMap Text ProfilePref -> HashMap Text ProfilePref) -> Profile b

Modifies the profilePrefs field of a profile.

Loading and preparing profiles

prepareProfile :: MonadBaseControl IO m => Profile Firefox -> m (PreparedProfile Firefox)

Prepare a firefox profile for network transmission. Internally, this function constructs a Firefox profile within a temp directory, archives it as a zip file, and then base64 encodes the zipped data. The temporary directory is deleted afterwards.

NOTE: because this function has to copy the profile files into a a temp directory before zip archiving them, this operation is likely to be slow for large profiles. In such a case, consider using prepareLoadedProfile_ or prepareZippedProfile instead.

prepareTempProfile :: MonadBaseControl IO m => (Profile Firefox -> Profile Firefox) -> m (PreparedProfile Firefox)

Apply a function on a default profile, and prepare the result. The Profile passed to the handler function is the default profile used by sessions when Nothing is specified

Preparing profiles from disk

loadProfile :: MonadBaseControl IO m => FilePath -> m (Profile Firefox)

Load an existing profile from the file system. Any prepared changes made to the Profile will have no effect to the profile on disk.

To make automated browser run smoothly, preferences found in defaultProfile are automatically merged into the preferences of the on-disk-- profile. The on-disk profile's preference will override those found in the default profile.

prepareLoadedProfile :: MonadBaseControl IO m => FilePath -> (Profile Firefox -> Profile Firefox) -> m (PreparedProfile Firefox)

Convenience function to load an existing Firefox profile from disk, apply a handler function, and then prepare the result for network transmission.

NOTE: like prepareProfile, the same caveat about large profiles applies.

prepareLoadedProfile_ :: MonadBase IO m => FilePath -> m (PreparedProfile a)

Efficiently load an existing profile from disk and prepare it for network transmission.

Preparing zip archives

prepareZippedProfile :: MonadBase IO m => FilePath -> m (PreparedProfile a)

Prepare a zip file of a profile on disk for network transmission. This function is very efficient at loading large profiles from disk.

prepareZipArchive :: Archive -> PreparedProfile a

Prepare a zip archive of a profile for network transmission.

prepareRawZip :: ByteString -> PreparedProfile a

Prepare a ByteString of raw zip data for network transmission

Preferences parsing error

newtype ProfileParseError

An error occured while attempting to parse a profile's preference file.

Constructors

ProfileParseError String

Instances

Exception ProfileParseError

Defined in Test.WebDriver.Common.Profile

Methods

toException :: ProfileParseError -> SomeException

fromException :: SomeException -> Maybe ProfileParseError

displayException :: ProfileParseError -> String

Read ProfileParseError

Defined in Test.WebDriver.Common.Profile

Methods

readsPrec :: Int -> ReadS ProfileParseError

readList :: ReadS [ProfileParseError]

readPrec :: ReadPrec ProfileParseError

readListPrec :: ReadPrec [ProfileParseError]

Show ProfileParseError

Defined in Test.WebDriver.Common.Profile

Methods

showsPrec :: Int -> ProfileParseError -> ShowS

show :: ProfileParseError -> String

showList :: [ProfileParseError] -> ShowS

Eq ProfileParseError

Defined in Test.WebDriver.Common.Profile

Methods

(==) :: ProfileParseError -> ProfileParseError -> Bool

(/=) :: ProfileParseError -> ProfileParseError -> Bool