Package TWiki::Users::HtPasswdUser

Support for htpasswd and htdigest format password files.

Subclass of TWiki::Users::Password . See documentation of that class for descriptions of the methods of this class.

ObjectMethod finish ()

ObjectMethod readOnly () -> boolean

returns true if the password file is not currently modifyable

ObjectMethod getMustChangePassword ($cUID) -> $flag

Returns 1 if the $cUID must change the password, else 0. Returns undef if $cUID not found.

ObjectMethod getUserData ($cUID) -> $dataRef

Return a reference to an array of hashes with user data, used to manage users. Each item is a hash with:

• {name} - name of field, such as "email"
• {title} - title of field, such as "E-mail"
• {value} - value of field, such as "jimmy@example.com"
• {type} - type of field: text, password, checkbox, label
• {size} - size of field, such as 40
• {note} - comment note, if any

User management forms can be build dynamically from this data structure. Each password manager may return a different set of fields.

ObjectMethod setUserData ($cUID,$dataRef)

Set the user data of a user. Same array of hashes as getUserData is assumed, although only {name} and {value} are used.

Returns an empty string if save action is OK, or an error string starting with 'Error: ' if there is an error.