wiki:UserManagerPlugin

Version 21 (modified by rjollos, 22 months ago) (diff)

Added page outline, maintainer and syntax highlighting.

Manage users and teams

Description

Yet another user manager plugin that has the following features:

  • helps managing users (profiles, permissions, authentication (based on AccountManagerPlugin), and any other things based on this plugin's extension points)
  • provides filterable team rosters based on user profiles (+ custom fields)

The main goal of this plugin is to to have a simple, standard way for teams to manage who is on the team. Since trac.admin provides too many places to setup one user, this plugin tries to provide one single page where a project admin can setup all things related to one user.

Note: This plugin is the next step of TeamRosterPlugin. So, in order to use UserManagerPlugin, please disable TeamRosterPlugin, in case you have it enabled. UserManagerPlugin is compatible ~90% with data managed by TeamRosterPlugin, so switching from TeamRosterPlugin to UserManagerPlugin is safe (no data loss).

Bugs/Feature Requests

Check existing bugs and feature requests, but feel also free to create a new ticket.

Download and Source

Download the zipped source, check out from the subversion repository, or browse the source with Trac.

Install

Install the plugin:

For Trac 0.11
easy_install http://trac-hacks.org/svn/usermanagerplugin/0.11

Config

[componets]
tracusermanager.* = enabled

[um_profile-custom]
office = select
office.cols = 20
office.label = Office
office.options = |Bucharest|Boston|San Francisco|New York
office.order = 1

bio = wikitext
bio.cols = 70
bio.rows = 10
bio.label = Bio
bio.order = 2

gim = text
gim.cols = 20
gim.label = Gmail
gim.order = 3

yim = text
yim.cols = 20
yim.label = Yahoo
yim.order = 4

tags = multichecks
tags.label = Tags
tags.options = developer|qa|pm|ux
tags.order = 5

Note: If you also have AccountManagerPlugin installed, you may want to disable its admin interface so you don't have two 'Users' entries in the Admin Accounts section.

[components]
acct_mgr.admin.accountmanageradminpage = disabled

API

from tracusermanager.api import UserManager, User

# Get user by id(username)
user = UserManager(env).get_user( "cbalan" )

# Get active users
team = UserManager(env).get_active_users()
for user in team:
    print user.username
    print user['email']
    print user['bio']

# Search users ( Dummy example: All active developers that have an gmail account )
search_result_list = UserManager(env).search_users(User( role="developer", email="%gmail.com"))
for user in search_result_list:
    print user.username
    print user['role']

# Create new user
UserManager(self.env).create_user(User(username="cbalan", name="Catalin Balan", email="cbalan@optaros.com"))

# Update
user = UserManager(self.env).get_user('cbalan')
user['bio']="""Maecenas ut mauris. Morbi congue nunc ut tortor. Pellentesque molestie cursus enim. 
Praesent gravida consequat mauris. Nulla cursus cursus magna. 
Sed libero. Integer dapibus urna in mauris. 

Fusce fringilla: 
 - Mauris ipsum mauris, semper at, lacinia ultrices, pellentesque eget, arcu. 
 - Etiam vel enim et nunc luctus gravida. Morbi suscipit scelerisque odio. 
 - Mauris porta. 

Nullam dui. Nullam egestas, massa eu condimentum mattis, enim ipsum tincidunt purus, 
vitae vestibulum sapien eros vitae libero.
"""
user.save()

# Remove
UserManager(env).remove_user(user)

Macro

[[UserProfilesList]]                                  # Without arguments returns current active user profiles
[[UserProfilesList(role=developer)]]                  # Returns all userProfiles with role='developer' 
[[UserProfilesList(NOT_role=developer)]]              # Returns all userProfiles with NOT role=developer
[[UserProfilesList(name=%someName%)]]                 # Returns all userProfiles with name like 'someName' 
[[UserProfilesList({id=cbalan},{role=%arh%})]]        # Returns cbalan's profile and user profiles with role='%arh%' 
[[UserProfilesList(|class=someCSS_Class, style=border:1px solid green;padding:12px)]] # Adds style and class attributes to box layout     

Screenshots

admin.profileadmin.permissions
admin.autenticationadmin.profile.customfields
userprofileslist macroadmin

Questions

  • Could you explain the interface?
  • What's the difference between 'Users' and 'External Users'?
  • Some of the screen shots seem like they might be a little out of date.

Recent Changes

[13677] by rjollos on 2014-02-19 12:52:39
Fixed indentation and trimmed whitespace using reindent.py.
[12293] by rjollos on 2012-11-03 22:04:18
Refs #10586: Part of [12286]. Removed unused variable.
[12286] by rjollos on 2012-11-02 22:14:05

Refs #10586:

  • Columns can be sorted on the Users page.
    • Changes are Python 2.4 compatible by choosing and/or clauses in favor of if/else, but code can be refactored and made cleaner in a future revision when the 2.4 compatibility is dropped.
    • The implementation of the query module (primarily query.html, query_results.html, query.py) was used as a guide.
  • Bumped version to 0.5dev.
  • Added a changelog.

Author/Contributors

Author: cbalan
Maintainer: cbalan
Contributors:

Attachments (6)

Download all attachments as: .zip