Web.Bugzilla.RedHat

This package is designed to provide an easy-to-use, typesafe interface to querying Bugzilla from Haskell.

A modified version of Web.Bugzilla to support the list fields in Red Hat's modified bugzilla API.

A very simple program using this package might look like this:

  ctx <- newBugzillaContext "bugzilla.example.org"
  let session = anonymousSession ctx
      user = "[e-mail]"
      query = AssignedToField .==. user .&&.
              FlagRequesteeField .==. user .&&.
              (FlagsField `contains` "review" .||. FlagsField `contains` "feedback")
  bugs <- searchBugs session query
  mapM_ (putStrLn . show . bugSummary) bugs

There's a somewhat more in-depth demo program included with the source code to this package.

Connecting to Bugzilla

newBugzillaContext :: BugzillaServer -> IO BugzillaContext

Creates a new BugzillaContext, suitable for connecting to the provided server. You should try to reuse BugzillaContexts whenever possible, because creating them is expensive.

loginSession :: BugzillaContext -> UserEmail -> Text -> IO (Maybe BugzillaSession)

Attempts to create a logged-in BugzillaSession using the provided username and password. Returns Nothing if login fails.

anonymousSession :: BugzillaContext -> BugzillaSession

Creates an anonymous BugzillaSession. Note that some content will be hidden by Bugzilla when you make queries in this state.

type BugzillaServer = Text

data BugzillaContext

Holds information about a BugzillaServer and manages outgoing connections. You can use newBugzillaContext or withBugzillaContext to create one.

data BugzillaSession

A session for Bugzilla queries. Use anonymousSession and loginSession, as appropriate, to create one.

Constructors

AnonymousSession BugzillaContext

LoginSession BugzillaContext BugzillaToken

newtype BugzillaToken

Constructors

BugzillaToken Text

Instances

FromJSON BugzillaToken

Defined in Web.Bugzilla.RedHat.Internal.Network

Methods

parseJSON :: Value -> Parser BugzillaToken

parseJSONList :: Value -> Parser [BugzillaToken]

Querying Bugzilla

searchBugs :: BugzillaSession -> SearchExpression -> IO [Bug]

Searches Bugzilla and returns a list of Bugs. The SearchExpression can be constructed conveniently using the operators in Web.Bugzilla.Search.

searchBugs' :: BugzillaSession -> SearchExpression -> IO [BugId]

Like searchBugs, but returns a list of BugIds. You can retrieve the Bug for each BugId using getBug. The combination of searchBugs' and getBug is much less efficient than searchBugs. searchBugs' is suitable for cases where you won't need to call getBug most of the time - for example, polling to determine whether the set of bugs returned by a query has changed.

searchBugsWithLimit

Arguments

:: BugzillaSession

-> Int

The maximum number of results to return.

-> Int

The offset from the first result to start from.

-> SearchExpression

-> IO [Bug]

Search Bugzilla and returns a limited number of results. You can call this repeatedly and use offset to retrieve the results of a large query incrementally. Note that most Bugzillas won't return all of the results for a very large query by default, but you can request this by calling searchBugsWithLimit with 0 for the limit.

searchBugsWithLimit'

Arguments

:: BugzillaSession

-> Int

The maximum number of results to return.

-> Int

The offset from the first result to start from.

-> SearchExpression

-> IO [BugId]

Like searchBugsWithLimit, but returns a list of BugIds. See searchBugs' for more discussion.

getBug :: BugzillaSession -> BugId -> IO (Maybe Bug)

Retrieve a bug by bug number.

getAttachment :: BugzillaSession -> AttachmentId -> IO (Maybe Attachment)

Retrieve a bug by attachment number.

getAttachments :: BugzillaSession -> BugId -> IO [Attachment]

Get all attachments for a bug.

getComments :: BugzillaSession -> BugId -> IO [Comment]

Get all comments for a bug.

getHistory :: BugzillaSession -> BugId -> IO History

Get the history for a bug.

searchUsers :: BugzillaSession -> Text -> IO [User]

Search user names and emails using a substring search.

getUser :: BugzillaSession -> UserEmail -> IO (Maybe User)

Get a user by email.

getUserById :: BugzillaSession -> UserId -> IO (Maybe User)

Get a user by user ID.

newBzRequest :: BugzillaSession -> [Text] -> QueryText -> Request

sendBzRequest :: FromJSON a => BugzillaSession -> Request -> IO a

intAsText :: Int -> Text

type BugId = Int

type AttachmentId = Int

type CommentId = Int

type UserId = Int

type EventId = Int

type FlagId = Int

type FlagType = Int

type UserEmail = Text

data Field a where

A field which you can search by using searchBugs or track changes to using getHistory. To get a human-readable name for a field, use fieldName.

Constructors

AliasField :: Field [Text]

AssignedToField :: Field UserEmail

AttachmentCreatorField :: Field UserEmail

AttachmentDataField :: Field Text

AttachmentDescriptionField :: Field Text

AttachmentFilenameField :: Field Text

AttachmentIsObsoleteField :: Field Bool

AttachmentIsPatchField :: Field Bool

AttachmentIsPrivateField :: Field Bool

AttachmentMimetypeField :: Field Text

BlocksField :: Field Int

BugIdField :: Field Int

CcField :: Field UserEmail

CcListAccessibleField :: Field Bool

ClassificationField :: Field Text

CommentField :: Field Text

CommentIsPrivateField :: Field Text

CommentTagsField :: Field Text

CommenterField :: Field UserEmail

ComponentField :: Field [Text]

ContentField :: Field Text

CreationDateField :: Field UTCTime

DaysElapsedField :: Field Int

DependsOnField :: Field Int

EverConfirmedField :: Field Bool

FlagRequesteeField :: Field UserEmail

FlagSetterField :: Field UserEmail

FlagsField :: Field Text

GroupField :: Field Text

KeywordsField :: Field [Text]

ChangedField :: Field UTCTime

CommentCountField :: Field Int

OperatingSystemField :: Field Text

HardwareField :: Field Text

PriorityField :: Field Text

ProductField :: Field Text

QaContactField :: Field UserEmail

ReporterField :: Field UserEmail

ReporterAccessibleField :: Field Bool

ResolutionField :: Field Text

RestrictCommentsField :: Field Bool

SeeAlsoField :: Field Text

SeverityField :: Field Text

StatusField :: Field Text

WhiteboardField :: Field Text

SummaryField :: Field Text

TagsField :: Field Text

TargetMilestoneField :: Field Text

TimeSinceAssigneeTouchedField :: Field Int

BugURLField :: Field Text

VersionField :: Field Text

VotesField :: Field Text

CustomField :: Text -> Field Text

Instances

Eq (Field a)

Defined in Web.Bugzilla.RedHat.Internal.Types

Methods

(==) :: Field a -> Field a -> Bool

(/=) :: Field a -> Field a -> Bool

Show (Field a)

Defined in Web.Bugzilla.RedHat.Internal.Types

Methods

showsPrec :: Int -> Field a -> ShowS

show :: Field a -> String

showList :: [Field a] -> ShowS

data User

A Bugzilla user.

Constructors

User

Fields

• userId :: !UserId
• userEmail :: Maybe UserEmail
• userName :: Text
• userRealName :: Text

Instances

Eq User

Defined in Web.Bugzilla.RedHat.Internal.Types

Methods

(==) :: User -> User -> Bool

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

Ord User

Defined in Web.Bugzilla.RedHat.Internal.Types

Methods

compare :: User -> User -> Ordering

(<) :: User -> User -> Bool

(<=) :: User -> User -> Bool

(>) :: User -> User -> Bool

(>=) :: User -> User -> Bool

max :: User -> User -> User

min :: User -> User -> User

Show User

Defined in Web.Bugzilla.RedHat.Internal.Types

Methods

showsPrec :: Int -> User -> ShowS

show :: User -> String

showList :: [User] -> ShowS

FromJSON User

Defined in Web.Bugzilla.RedHat.Internal.Types

Methods

parseJSON :: Value -> Parser User

parseJSONList :: Value -> Parser [User]

data Flag

Flags, which may be set on an attachment or on a bug directly.

Constructors

Flag

Fields

• flagId :: !FlagId
• flagTypeId :: !FlagType
• flagName :: Text
• flagSetter :: UserEmail
• flagStatus :: Text
• flagCreationDate :: UTCTime
• flagModificationDate :: UTCTime
• flagRequestee :: Maybe UserEmail

Instances

Eq Flag

Defined in Web.Bugzilla.RedHat.Internal.Types

Methods

(==) :: Flag -> Flag -> Bool

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

Ord Flag

Defined in Web.Bugzilla.RedHat.Internal.Types

Methods

compare :: Flag -> Flag -> Ordering

(<) :: Flag -> Flag -> Bool

(<=) :: Flag -> Flag -> Bool

(>) :: Flag -> Flag -> Bool

(>=) :: Flag -> Flag -> Bool

max :: Flag -> Flag -> Flag

min :: Flag -> Flag -> Flag

Show Flag

Defined in Web.Bugzilla.RedHat.Internal.Types

Methods

showsPrec :: Int -> Flag -> ShowS

show :: Flag -> String

showList :: [Flag] -> ShowS

FromJSON Flag

Defined in Web.Bugzilla.RedHat.Internal.Types

Methods

parseJSON :: Value -> Parser Flag

parseJSONList :: Value -> Parser [Flag]

data Bug

A Bugzilla bug.

Constructors

Bug

Fields

• bugId :: !BugId
• bugAlias :: Maybe [Text]
• bugAssignedTo :: UserEmail
• bugAssignedToDetail :: User
• bugBlocks :: [BugId]
• bugCc :: [UserEmail]
• bugCcDetail :: [User]
• bugClassification :: Text
• bugComponent :: [Text]
• bugCreationTime :: UTCTime
• bugCreator :: UserEmail
• bugCreatorDetail :: User
• bugDependsOn :: [BugId]
• bugDupeOf :: Maybe BugId
• bugFlags :: Maybe [Flag]
• bugGroups :: [Text]
• bugIsCcAccessible :: Bool
• bugIsConfirmed :: Bool
• bugIsCreatorAccessible :: Bool
• bugIsOpen :: Bool
• bugKeywords :: [Text]
• bugLastChangeTime :: UTCTime
• bugOpSys :: Text
• bugPlatform :: Text
• bugPriority :: Text
• bugProduct :: Text
• bugQaContact :: UserEmail
• bugResolution :: Text
• bugSeeAlso :: [Text]
• bugSeverity :: Text
• bugStatus :: Text
• bugSummary :: Text
• bugTargetMilestone :: Text
• bugUrl :: Text
• bugVersion :: [Text]
• bugWhiteboard :: Text
• bugCustomFields :: HashMap Text Text

Instances

Eq Bug

Defined in Web.Bugzilla.RedHat.Internal.Types

Methods

(==) :: Bug -> Bug -> Bool

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

Show Bug

Defined in Web.Bugzilla.RedHat.Internal.Types

Methods

showsPrec :: Int -> Bug -> ShowS

show :: Bug -> String

showList :: [Bug] -> ShowS

FromJSON Bug

Defined in Web.Bugzilla.RedHat.Internal.Types

Methods

parseJSON :: Value -> Parser Bug

parseJSONList :: Value -> Parser [Bug]

data Attachment

An attachment to a bug.

Constructors

Attachment

Fields

• attachmentId :: !AttachmentId
• attachmentBugId :: !BugId
• attachmentFileName :: Text
• attachmentSummary :: Text
• attachmentCreator :: UserEmail
• attachmentIsPrivate :: Bool
• attachmentIsObsolete :: Bool
• attachmentIsPatch :: Bool
• attachmentFlags :: [Flag]
• attachmentCreationTime :: UTCTime
• attachmentLastChangeTime :: UTCTime
• attachmentContentType :: Text
• attachmentSize :: !Int
• attachmentData :: Text

Instances

Eq Attachment

Defined in Web.Bugzilla.RedHat.Internal.Types

Methods

(==) :: Attachment -> Attachment -> Bool

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

Show Attachment

Defined in Web.Bugzilla.RedHat.Internal.Types

Methods

showsPrec :: Int -> Attachment -> ShowS

show :: Attachment -> String

showList :: [Attachment] -> ShowS

FromJSON Attachment

Defined in Web.Bugzilla.RedHat.Internal.Types

Methods

parseJSON :: Value -> Parser Attachment

parseJSONList :: Value -> Parser [Attachment]

data Comment

A bug comment. To display these the way Bugzilla does, you'll need to call getUser and use the userRealName for each user.

Constructors

Comment

Fields

• commentId :: !CommentId
• commentBugId :: !BugId
• commentAttachmentId :: Maybe AttachmentId
• commentCount :: !Int
• commentText :: Text
• commentCreator :: UserEmail
• commentCreationTime :: UTCTime
• commentIsPrivate :: Bool

Instances

Eq Comment

Defined in Web.Bugzilla.RedHat.Internal.Types

Methods

(==) :: Comment -> Comment -> Bool

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

Show Comment

Defined in Web.Bugzilla.RedHat.Internal.Types

Methods

showsPrec :: Int -> Comment -> ShowS

show :: Comment -> String

showList :: [Comment] -> ShowS

FromJSON Comment

Defined in Web.Bugzilla.RedHat.Internal.Types

Methods

parseJSON :: Value -> Parser Comment

parseJSONList :: Value -> Parser [Comment]

data History

History information for a bug.

Constructors

History

Fields

• historyBugId :: !BugId
• historyEvents :: [HistoryEvent]

Instances

Eq History

Defined in Web.Bugzilla.RedHat.Internal.Types

Methods

(==) :: History -> History -> Bool

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

Show History

Defined in Web.Bugzilla.RedHat.Internal.Types

Methods

showsPrec :: Int -> History -> ShowS

show :: History -> String

showList :: [History] -> ShowS

FromJSON History

Defined in Web.Bugzilla.RedHat.Internal.Types

Methods

parseJSON :: Value -> Parser History

parseJSONList :: Value -> Parser [History]

data HistoryEvent

An event in a bug's history.

Constructors

HistoryEvent

Fields

• historyEventId :: EventId

  A sequential event id.

• historyEventTime :: UTCTime

  When the event occurred.

• historyEventUser :: UserEmail

  Which user was responsible.

• historyEventChanges :: [Change]

  All the changes which are part of this event.

Instances

Eq HistoryEvent

Defined in Web.Bugzilla.RedHat.Internal.Types

Methods

(==) :: HistoryEvent -> HistoryEvent -> Bool

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

Show HistoryEvent

Defined in Web.Bugzilla.RedHat.Internal.Types

Methods

showsPrec :: Int -> HistoryEvent -> ShowS

show :: HistoryEvent -> String

showList :: [HistoryEvent] -> ShowS

FromJSON HistoryEvent

Defined in Web.Bugzilla.RedHat.Internal.Types

Methods

parseJSON :: Value -> Parser HistoryEvent

parseJSONList :: Value -> Parser [HistoryEvent]

data Change

A single change which is part of an event. Different constructors are used according to the type of the field. The Modification describes the value of the field before and after the change.

Constructors

TextFieldChange (Field Text) (Modification Text)

ListFieldChange (Field [Text]) (Modification [Text])

IntFieldChange (Field Int) (Modification Int)

TimeFieldChange (Field UTCTime) (Modification UTCTime)

BoolFieldChange (Field Bool) (Modification Bool)

Instances

Eq Change

Defined in Web.Bugzilla.RedHat.Internal.Types

Methods

(==) :: Change -> Change -> Bool

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

Show Change

Defined in Web.Bugzilla.RedHat.Internal.Types

Methods

showsPrec :: Int -> Change -> ShowS

show :: Change -> String

showList :: [Change] -> ShowS

FromJSON Change

Defined in Web.Bugzilla.RedHat.Internal.Types

Methods

parseJSON :: Value -> Parser Change

parseJSONList :: Value -> Parser [Change]

data (Eq a, Show a) => Modification a

A description of how a field changed during a HistoryEvent.

Constructors

Modification

Fields

• modRemoved :: Maybe a
• modAdded :: Maybe a
• modAttachmentId :: Maybe AttachmentId

Instances

(Eq a, Show a) => Eq (Modification a)

Defined in Web.Bugzilla.RedHat.Internal.Types

Methods

(==) :: Modification a -> Modification a -> Bool

(/=) :: Modification a -> Modification a -> Bool

(Eq a, Show a) => Show (Modification a)

Defined in Web.Bugzilla.RedHat.Internal.Types

Methods

showsPrec :: Int -> Modification a -> ShowS

show :: Modification a -> String

showList :: [Modification a] -> ShowS

fieldName :: Field a -> Text

Provides a human-readable name for a Field.

data BugzillaException

Constructors

BugzillaJSONParseError String

BugzillaAPIError Int String

BugzillaUnexpectedValue String

Instances

Show BugzillaException

Defined in Web.Bugzilla.RedHat.Internal.Network

Methods

showsPrec :: Int -> BugzillaException -> ShowS

show :: BugzillaException -> String

showList :: [BugzillaException] -> ShowS

Exception BugzillaException

Defined in Web.Bugzilla.RedHat.Internal.Network

Methods

toException :: BugzillaException -> SomeException

fromException :: SomeException -> Maybe BugzillaException

displayException :: BugzillaException -> String