Codec.Xlsx.Types.Protection

Documentation

data SheetProtection

Sheet protection options to enforce and specify that it needs to be protected

TODO: algorithms specified in the spec with hashes, salts and spin counts

See 18.3.1.85 "sheetProtection (Sheet Protection Options)" (p. 1694)

Constructors

SheetProtection

Fields

• _sprLegacyPassword :: Maybe LegacyPassword

  Specifies the legacy hash of the password required for editing this worksheet.

  See Part 4, 15.3.1.6 "Additional attribute for sheetProtection element (Part 1, §18.3.1.85)" (p. 229)

• _sprSheet :: Bool

  the value of this attribute dictates whether the other attributes of SheetProtection should be applied

• _sprAutoFilter :: Bool

  AutoFilters should not be allowed to operate when the sheet is protected

• _sprDeleteColumns :: Bool

  deleting columns should not be allowed when the sheet is protected

• _sprDeleteRows :: Bool

  deleting rows should not be allowed when the sheet is protected

• _sprFormatCells :: Bool

  formatting cells should not be allowed when the sheet is protected

• _sprFormatColumns :: Bool

  formatting columns should not be allowed when the sheet is protected

• _sprFormatRows :: Bool

  formatting rows should not be allowed when the sheet is protected

• _sprInsertColumns :: Bool

  inserting columns should not be allowed when the sheet is protected

• _sprInsertHyperlinks :: Bool

  inserting hyperlinks should not be allowed when the sheet is protected

• _sprInsertRows :: Bool

  inserting rows should not be allowed when the sheet is protected

• _sprObjects :: Bool

  editing of objects should not be allowed when the sheet is protected

• _sprPivotTables :: Bool

  PivotTables should not be allowed to operate when the sheet is protected

• _sprScenarios :: Bool

  Scenarios should not be edited when the sheet is protected

• _sprSelectLockedCells :: Bool

  selection of locked cells should not be allowed when the sheet is protected

• _sprSelectUnlockedCells :: Bool

  selection of unlocked cells should not be allowed when the sheet is protected

• _sprSort :: Bool

  sorting should not be allowed when the sheet is protected

Instances

Eq SheetProtection

Defined in Codec.Xlsx.Types.Protection

Methods

(==) :: SheetProtection -> SheetProtection -> Bool

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

Show SheetProtection

Defined in Codec.Xlsx.Types.Protection

Methods

showsPrec :: Int -> SheetProtection -> ShowS

show :: SheetProtection -> String

showList :: [SheetProtection] -> ShowS

Generic SheetProtection

Defined in Codec.Xlsx.Types.Protection

Associated Types

type Rep SheetProtection :: Type -> Type

Methods

from :: SheetProtection -> Rep SheetProtection x

to :: Rep SheetProtection x -> SheetProtection

NFData SheetProtection

Defined in Codec.Xlsx.Types.Protection

Methods

rnf :: SheetProtection -> ()

FromXenoNode SheetProtection

Defined in Codec.Xlsx.Types.Protection

Methods

fromXenoNode :: Node -> Either Text SheetProtection

FromCursor SheetProtection

Defined in Codec.Xlsx.Types.Protection

Methods

fromCursor :: Cursor -> [SheetProtection]

ToElement SheetProtection

Defined in Codec.Xlsx.Types.Protection

Methods

toElement :: Name -> SheetProtection -> Element

type Rep SheetProtection

Defined in Codec.Xlsx.Types.Protection

type Rep SheetProtection = D1 ('MetaData "SheetProtection" "Codec.Xlsx.Types.Protection" "xlsx-1.0.0.1-inplace" 'False) (C1 ('MetaCons "SheetProtection" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "_sprLegacyPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe LegacyPassword)) :*: S1 ('MetaSel ('Just "_sprSheet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "_sprAutoFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "_sprDeleteColumns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))) :*: ((S1 ('MetaSel ('Just "_sprDeleteRows") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "_sprFormatCells") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "_sprFormatColumns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "_sprFormatRows") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))) :*: (((S1 ('MetaSel ('Just "_sprInsertColumns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "_sprInsertHyperlinks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "_sprInsertRows") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "_sprObjects") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))) :*: ((S1 ('MetaSel ('Just "_sprPivotTables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "_sprScenarios") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "_sprSelectLockedCells") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "_sprSelectUnlockedCells") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "_sprSort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))))))

fullSheetProtection :: SheetProtection

protection of all sheet features which could be protected

noSheetProtection :: SheetProtection

no sheet protection at all

data LegacyPassword

Instances

Eq LegacyPassword

Defined in Codec.Xlsx.Types.Protection

Methods

(==) :: LegacyPassword -> LegacyPassword -> Bool

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

Show LegacyPassword

Defined in Codec.Xlsx.Types.Protection

Methods

showsPrec :: Int -> LegacyPassword -> ShowS

show :: LegacyPassword -> String

showList :: [LegacyPassword] -> ShowS

Generic LegacyPassword

Defined in Codec.Xlsx.Types.Protection

Associated Types

type Rep LegacyPassword :: Type -> Type

Methods

from :: LegacyPassword -> Rep LegacyPassword x

to :: Rep LegacyPassword x -> LegacyPassword

NFData LegacyPassword

Defined in Codec.Xlsx.Types.Protection

Methods

rnf :: LegacyPassword -> ()

FromAttrBs LegacyPassword

Defined in Codec.Xlsx.Types.Protection

Methods

fromAttrBs :: ByteString -> Either Text LegacyPassword

FromAttrVal LegacyPassword

Defined in Codec.Xlsx.Types.Protection

Methods

fromAttrVal :: Reader LegacyPassword

ToAttrVal LegacyPassword

Defined in Codec.Xlsx.Types.Protection

Methods

toAttrVal :: LegacyPassword -> Text

type Rep LegacyPassword

Defined in Codec.Xlsx.Types.Protection

type Rep LegacyPassword = D1 ('MetaData "LegacyPassword" "Codec.Xlsx.Types.Protection" "xlsx-1.0.0.1-inplace" 'True) (C1 ('MetaCons "LegacyPassword" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

legacyPassword :: Text -> LegacyPassword

Creates legacy XOR hashed password.

Note: The implementation is known to work only for ASCII symbols, if you know how to encode properly others - an email or a PR will be highly apperciated

See Part 4, 14.7.1 "Legacy Password Hash Algorithm" (p. 73) and Part 4, 15.2.3 "Additional attributes for workbookProtection element (Part 1, §18.2.29)" (p. 220) and Par 4, 15.3.1.6 "Additional attribute for sheetProtection element (Part 1, §18.3.1.85)" (p. 229)

Lenses

sprLegacyPassword :: Lens' SheetProtection (Maybe LegacyPassword)

sprSheet :: Lens' SheetProtection Bool

sprObjects :: Lens' SheetProtection Bool

sprScenarios :: Lens' SheetProtection Bool

sprFormatCells :: Lens' SheetProtection Bool

sprFormatColumns :: Lens' SheetProtection Bool

sprFormatRows :: Lens' SheetProtection Bool

sprInsertColumns :: Lens' SheetProtection Bool

sprInsertRows :: Lens' SheetProtection Bool

sprInsertHyperlinks :: Lens' SheetProtection Bool

sprDeleteColumns :: Lens' SheetProtection Bool

sprDeleteRows :: Lens' SheetProtection Bool

sprSelectLockedCells :: Lens' SheetProtection Bool

sprSort :: Lens' SheetProtection Bool

sprAutoFilter :: Lens' SheetProtection Bool

sprPivotTables :: Lens' SheetProtection Bool

sprSelectUnlockedCells :: Lens' SheetProtection Bool