Tags:
create new tag
view all tags
---+ Package =TWiki::Users::TWikiUserMapping= The User mapping is the process by which TWiki maps from a username (a login name) to a wikiname and back. It is also where groups are defined. By default TWiki maintains user topics and group topics in the %USERSWEB% that define users and group. These topics are * !TWikiUsers - stores a mapping from usernames to TWiki names * !WikiName - for each user, stores info about the user * !GroupNameGroup - for each group, a topic ending with "Group" stores a list of users who are part of that group. Many sites will want to override this behaviour, for example to get users and groups from a corporate database. This class implements the basic TWiki behaviour using topics to store users, but is also designed to be subclassed so that other services can be used. Subclasses should be named 'XxxxUserMapping' so that configure can find them. %TOC% ---++ ClassMethod *new* <tt>($session,$impl)</tt> Constructs a new user mapping handler of this type, referring to $session for any required TWiki services. ---++ ObjectMethod *finish* <tt>()</tt> Break circular references. ---++ ObjectMethod *supportsRegistration* <tt>() -> false</tt> return 1 if the UserMapper supports registration (ie can create new users) ---++ ObjectMethod *handlesUser* <tt>($cUID,$login,$wikiname) -> $boolean</tt> Called by the TWiki::Users object to determine which loaded mapping to use for a given user. The user can be identified by any of $cUID, $login or $wikiname. Any of these parameters may be undef, and they should be tested in order; cUID first, then login, then wikiname. This mapping is special - for backwards compatibility, it assumes responsibility for _all_ non BaseMapping users. If you're needing to mix the TWikiuserMapping with other mappings, define $this->{mapping_id} = 'TWikiUserMapping_'; ---++ ObjectMethod *login2cUID* <tt>($login,$dontcheck) -> $cUID</tt> Convert a login name to the corresponding canonical user name. The canonical name can be any string of 7-bit alphanumeric and underscore characters, and must correspond 1:1 to the login name. (undef on failure) (if dontcheck is true, return a cUID for a nonexistant user too. This is used for registration) ---++ ObjectMethod *getLoginName* <tt>($cUID) -> login</tt> Converts an internal cUID to that user's login (undef on failure) ---++ ObjectMethod *addUser* <tt>($login,$wikiname,$password,$emails,$mcp) -> $cUID</tt> throws an Error::Simple Add a user to the persistant mapping that maps from usernames to wikinames and vice-versa. The default implementation uses a special topic called "TWikiUsers" in the users web. Subclasses will provide other implementations (usually stubs if they have other ways of mapping usernames to wikinames). Names must be acceptable to $TWiki::cfg{NameFilter} $login must *always* be specified. $wikiname may be undef, in which case the user mapper should make one up. This function must return a *canonical user id* that it uses to uniquely identify the user. This can be the login name, or the wikiname if they are all guaranteed unigue, or some other string consisting only of 7-bit alphanumerics and underscores. if you fail to create a new user (for eg your Mapper has read only access), throw Error::Simple( 'Failed to add user: '.$ph->error()); ---++ ObjectMethod *removeUser* <tt>($cUID) -> $boolean</tt> Delete the users entry. Removes the user from the password manager and user mapping manager. Does *not* remove their personal topics, which may still be linked. ---++ ObjectMethod *getWikiName* <tt>($cUID) -> $wikiname</tt> Map a canonical user name to a wikiname. If it fails to find a WikiName, it will attempt to find a matching loginname, and use an escaped version of that. If there is no matching WikiName or LoginName, it returns undef. ---++ ObjectMethod *userExists* <tt>($cUID) -> $boolean</tt> Determine if the user already exists or not. Whether a user exists or not is determined by the password manager. ---++ ObjectMethod *eachUser* <tt>() -> TWiki::ListIteratorofcUIDs</tt> See baseclass for documentation ---++ ObjectMethod *eachGroupMember* <tt>($group) -> listIteratorofcUIDs</tt> See baseclass for documentation ---++ ObjectMethod *isGroup* <tt>($user) -> boolean</tt> See baseclass for documentation ---++ ObjectMethod *eachGroup* <tt>() -> ListIteratorofgroupnames</tt> See baseclass for documentation ---++ ObjectMethod *eachMembership* <tt>($cUID) -> ListIteratorofgroupsthisuserisin</tt> See baseclass for documentation ---++ ObjectMethod *isAdmin* <tt>($cUID) -> $boolean</tt> True if the user is an admin * is $TWiki::cfg{SuperAdminGroup} * is a member of the $TWiki::cfg{SuperAdminGroup} ---++ ObjectMethod *findUserByEmail* <tt>($email) -> \@cUIDs</tt> * =$email= - email address to look up Return a list of canonical user names for the users that have this email registered with the password manager or the user mapping manager. The password manager is asked first for whether it maps emails. If it doesn't, then the user mapping manager is asked instead. ---++ ObjectMethod *getEmails* <tt>($name) -> @emailAddress</tt> If $name is a user, return their email addresses. If it is a group, return the addresses of everyone in the group. The password manager and user mapping manager are both consulted for emails for each user (where they are actually found is implementation defined). Duplicates are removed from the list. ---++ ObjectMethod *setEmails* <tt>($cUID,@emails) -> boolean</tt> Set the email address(es) for the given user. The password manager is tried first, and if it doesn't want to know the user mapping manager is tried. ---++ StaticMethod *mapper_getEmails* <tt>($session,$user)</tt> Only used if passwordManager->isManagingEmails= = =false (The emails are stored in the user topics. Note: This method is PUBLIC because it is used by the tools/upgrade_emails.pl script, which needs to kick down to the mapper to retrieve email addresses from TWiki topics. ---++ StaticMethod *mapper_setEmails* <tt>($session,$user,@emails)</tt> Only used if =passwordManager->isManagingEmails= = =false=. (emails are stored in user topics ---++ ObjectMethod *getMustChangePassword* <tt>($cUID) -> $flag</tt> Returns 1 if the $cUID must change the password, else 0. Returns undef if $cUID not found. ---++ ObjectMethod *getUserData* <tt>($cUID) -> $dataRef</tt> 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* <tt>($cUID,$dataRef)</tt> Set the user data of a user. Same array of hashes as getUserData is assumed, although only ={name}= and ={value}= are used. ---++ ObjectMethod *findUserByWikiName* <tt>($wikiname) -> listofcUIDsassociatedwiththatwikiname</tt> See baseclass for documentation The $skipExistanceCheck parameter is private to this module, and blocks the standard existence check to avoid reading .htpasswd when checking group memberships). ---++ ObjectMethod *checkPassword* <tt>($login,$password) -> $boolean</tt> Finds if the password is valid for the given user. Returns 1 on success, undef on failure. ---++ ObjectMethod *setPassword* <tt>($cUID,$newPassU,$oldPassU,$mcp) -> $boolean</tt> BEWARE: $user should be a cUID, but is a login when the resetPassword functionality is used. The UserMapper needs to convert either one to a valid login for use by the Password manager TODO: needs fixing If the $oldPassU matches matches the user's password, then it will replace it with $newPassU. If $oldPassU is not correct and not 1, will return 0. If $oldPassU is 1, will force the change irrespective of the existing password, adding the user if necessary. Otherwise returns 1 on success, undef on failure. ---++ ObjectMethod *passwordError* <tt>() -> $string</tt> returns a string indicating the error that happened in the password handlers TODO: these delayed error's should be replaced with Exceptions. returns undef if no error
E
dit
|
A
ttach
|
Watch
|
P
rint version
|
H
istory
: r1
|
B
acklinks
|
V
iew topic
|
Ra
w
edit
|
M
ore topic actions
Topic revision: r1 - 2011-08-21
-
TWikiContributor
Log In
or
Register
TWiki Web
Users
Groups
Index
Search
Changes
Notifications
RSS Feed
Statistics
Preferences
User Reference
ATasteOfTWiki
TextFormattingRules
TWikiVariables
FormattedSearch
QuerySearch
TWikiDocGraphics
TWikiSkinBrowser
InstalledPlugins
Admin Maintenance
Reference Manual
AdminToolsCategory
InterWikis
ManagingWebs
TWikiSiteTools
TWikiPreferences
WebPreferences
Categories
Admin Documentation
Admin Tools
Developer Doc
User Documentation
User Tools
Prenotazioni esami
Laurea Triennale ...
Laurea Triennale
Algebra
Algoritmi
Introduzione agli algoritmi
Algoritmi 1
Algoritmi 2
Algoritmi per la
visualizzazione
Architetture
Prog. sist. digitali
Architetture 2
Basi di Dati
Basi di Dati 1 Inf.
Basi di Dati 1 T.I.
Basi di Dati (I modulo, A-L)
Basi di Dati (I modulo, M-Z)
Basi di Dati 2
Calcolo
Calcolo differenziale
Calcolo integrale
Calcolo delle Probabilitą
Metodi mat. per l'inf. (ex. Logica)
canale AD
canale PZ
Programmazione
Fond. di Programmazione
Metodologie di Programmazione
Prog. di sistemi multicore
Programmazione 2
AD
EO
PZ
Esercitazioni Prog. 2
Lab. Prog. AD
Lab. Prog. EO
Lab. Prog. 2
Prog. a Oggetti
Reti
Arch. di internet
Lab. di prog. di rete
Programmazione Web
Reti di elaboratori
Sistemi operativi
Sistemi Operativi (12 CFU)
Anni precedenti
Sistemi operativi 1
Sistemi operativi 2
Lab. SO 1
Lab. SO 2
Altri corsi
Automi, Calcolabilitą
e Complessitą
Apprendimento Automatico
Economia Aziendale
Elaborazione Immagini
Fisica 2
Grafica 3D
Informatica Giuridica
Laboratorio di Sistemi Interattivi
Linguaggi di Programmazione 3° anno Matematica
Linguaggi e Compilatori
Sistemi Informativi
Tecniche di Sicurezza dei Sistemi
ACSAI ...
ACSAI
Computer Architectures 1
Programming
Laurea Magistrale ...
Laurea Magistrale
Percorsi di studio
Corsi
Algoritmi Avanzati
Algoritmica
Algoritmi e Strutture Dati
Algoritmi per le reti
Architetture degli elaboratori 3
Architetture avanzate e parallele
Autonomous Networking
Big Data Computing
Business Intelligence
Calcolo Intensivo
Complessitą
Computer Systems and Programming
Concurrent Systems
Crittografia
Elaborazione del Linguaggio Naturale
Estrazione inf. dal web
Fisica 3
Gamification Lab
Information Systems
Ingegneria degli Algoritmi
Interazione Multi Modale
Metodi Formali per il Software
Methods in Computer Science Education: Analysis
Methods in Computer Science Education: Design
Prestazioni dei Sistemi di Rete
Prog. avanzata
Internet of Things
Sistemi Centrali
Reti Wireless
Sistemi Biometrici
Sistemi Distribuiti
Sistemi Informativi Geografici
Sistemi operativi 3
Tecniche di Sicurezza basate sui Linguaggi
Teoria della
Dimostrazione
Verifica del software
Visione artificiale
Attivitą complementari
Biologia Computazionale
Design and development of embedded systems for the Internet of Things
Lego Lab
Logic Programming
Pietre miliari della scienza
Prog. di processori multicore
Sistemi per l'interazione locale e remota
Laboratorio di Cyber-Security
Verifica e Validazione di Software Embedded
Altri Webs ...
Altri Webs
Dottorandi
Commissioni
Comm. Didattica
Comm. Didattica_r
Comm. Dottorato
Comm. Erasmus
Comm. Finanziamenti
Comm. Scientifica
Comm Scientifica_r
Corsi esterni
Sistemi Operativi (Matematica)
Perl e Bioperl
ECDL
Fondamenti 1
(NETTUNO)
Tecniche della Programmazione 1° modulo
(NETTUNO)
Seminars in Artificial Intelligence and Robotics: Natural Language Processing
Informatica generale
Primo canale
Secondo canale
II canale A.A. 10-11
Informatica
Informatica per Statistica
Laboratorio di Strumentazione Elettronica e Informatica
Progetti
Nemo
Quis
Remus
TWiki ...
TWiki
Tutto su TWiki
Users
Main
Sandbox
Home
Site map
AA web
AAP web
ACSAI web
AA2021 web
Programming web
AA2021 web
AN web
ASD web
Algebra web
AL web
AA1112 web
AA1213 web
AA1920 web
AA2021 web
MZ web
AA1112 web
AA1213 web
AA1112 web
AA1314 web
AA1415 web
AA1516 web
AA1617 web
AA1819 web
Old web
Algo_par_dis web
Algoreti web
More...
TWiki Web
User registration
Users
Groups
Index
Search
Changes
Notifications
RSS Feed
Statistics
Preferences
View
Raw View
Print version
Find backlinks
History
More topic actions
Edit
Raw edit
Attach file or image
Edit topic preference settings
Set new parent
More topic actions
User Reference
ATasteOfTWiki
TextFormattingRules
TWikiVariables
FormattedSearch
QuerySearch
TWikiDocGraphics
TWikiSkinBrowser
InstalledPlugins
Admin Maintenance
Reference Manual
InterWikis
ManagingUsers
ManagingWebs
TWikiSiteTools
TWikiPreferences
WebPreferences
Categories
Admin Documentation
Admin Tools
Developer Doc
User Documentation
User Tools
Account
Log In
Register User
Questo sito usa cookies, usandolo ne accettate la presenza. (
CookiePolicy
)
Torna al
Dipartimento di Informatica
E
dit
A
ttach
Copyright © 1999-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki?
Send feedback
Note:
Please contribute updates to this topic on TWiki.org at
TWiki:TWiki.TWikiUsersTWikiUserMappingDotPm
.