Test.WebDriver.Common.Profile

A type for profile preferences. These preference values are used by both Firefox and Opera profiles.

Profiles and profile preferences

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

Eq (Profile b)

Show (Profile b)

newtype PreparedProfile b

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

Constructors

PreparedProfile ByteString

Instances

Eq (PreparedProfile b)

Show (PreparedProfile b)

ToJSON (PreparedProfile s)

FromJSON (PreparedProfile s)

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

Eq ProfilePref

Show ProfilePref

ToJSON ProfilePref

FromJSON ProfilePref

class ToPref a where

A typeclass to convert types to profile preference values

Methods

toPref :: a -> ProfilePref

Instances

ToPref Bool

ToPref Double

ToPref Float

ToPref Int

ToPref Int8

ToPref Int16

ToPref Int32

ToPref Int64

ToPref Integer

ToPref Word

ToPref Word8

ToPref Word16

ToPref Word32

ToPref Word64

ToPref String

ToPref Text

Integral a => ToPref (Ratio a)

HasResolution r => ToPref (Fixed r)

Preferences

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

Retrieve a preference from a profile by key name.

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.

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.

Preparing profiles from disk

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

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

Preparing zipped profiles

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

Profile errors

newtype ProfileParseError

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

Constructors

ProfileParseError String

Instances

Eq ProfileParseError

Read ProfileParseError

Show ProfileParseError

Typeable ProfileParseError

Exception ProfileParseError