OG User Roles (OGUR)

OG User Roles 4.x

The 4.x branch version of OG User Roles (OGUR) is a rewrite of the module for efficiency and speed. Much of the additional features, things that integrated OGUR with other modules, had been impeding the functionality and speed of the original module.

The plan for the future is to move OGUR integration with other modules into OGUR-dependent modules that can be enabled or disabled as need be. Currently, the 4.x version of the module only includes the functionality that the module originally had and does not include the "bonus" features like integration with other modules. See this node for the original discussion that prompted the rewrite.

Please refer to the project page for further, up-to-date information.

The rest of these handbook pages only affect earlier versions than 4.x.

OG User Roles 6.x-1.x and 5.x-3.x

IMPORTANT: The following description and guidelines are related to OG User Roles 6.x-1.x and 5.x-3.x only.

Requires og.module.

Important notes:

• Latest 6.x stable release is NOT compatible with OG 6.x-2.0-rc1. If you are using this version of OG, then please download development release for the time being. See: http://drupal.org/node/432544.
• Latest 5.x and 6.x stable and development releases are now compatible with OG 5.x-8.0 and 6.x-1.1 (respectively) and above. This means that the most current versions of OGUR will NOT work with earlier versions of OG. See these issues: http://drupal.org/node/381092 (5.x) and http://drupal.org/node/369967 (6.x).
• The moderator of the OG module refers to this module as a "hack" (see: http://drupal.org/node/313291#comment-1029133). Here is our response:

  "That it (OGUR) is not supported here is certainly the moderator's prerogative. However, that it is a hack is the moderator's opinion. The og_user_roles module has been in place, used by Drupal users and constantly improved over the past two years. I suggest that interested persons look at the module project page: http://www.drupal.org/project/og_user_roles and the issue queue: http://drupal.org/project/issues/og_user_roles?status=All to make up your own mind.

  Just to set the record straight, basic OGUR functionality (group roles) is fully supported within Drupal 6.x. The key "hack" was incorporated into Drupal core here: http://drupal.org/node/176342

  The OGUR extended component, Taxonomy Access Control/OG Integration (http://groups.drupal.org/node/3700), is not recommended, but provided and supported as it does resolve an important access issue for lots of people."

Read the history of this module: http://drupal.org/node/87679

Other features of this module allow you to:

• Assign a default role to all new users who sign up to your site.
• Allow group admins to define default roles for signups to their groups. http://drupal.org/node/177414
• Notify group admin of new group subscribers. Requires mimemail.module.
• Set a default "Founder" group role for users who create groups.
• Set a default group administrator role for users who are elevated to group admin status.
• Set a default group role for new subscribers to a group.
• Create subgroups. Requires og_subgroups.module. See important notes here: http://drupal.org/node/334886.
• Create and use registration codes for automatic subscription to groups: http://drupal.org/node/217229. Also define "mandatory" registration codes which has the effect of not allowing new users to register to your site without providing a valid code: http://drupal.org/node/394522
• Comes with it's own access control for optionally integrating the taxonomy access control (TAC) and organic groups (OG) modules. See: http://groups.drupal.org/node/3700.
• Disallow all Public Posts: http://drupal.org/node/247488
• Supports Content Access (http://www.drupal.org/project/content_access) and Access Control List (http://www.drupal.org/project/acl) access control modules. See http://groups.drupal.org/node/5392
• Works with OG Vocabulary (http://www.drupal.org/project/og_vocab) module. See this issue: http://drupal.org/node/162649
• Works with modr8 (http://www.drupal.org/project/modr8) module. See this issue: http://drupal.org/node/164092
• Patched for compatibility with Relativity module. See: http://drupal.org/node/166253
• Compatibility with Content Type Administration by Organic Group module. See: http://drupal.org/node/177866
• Optional settings and user.module patch to reset user_access()
  permissons cache: http://drupal.org/node/166566
• Configuration option allows Group Admins to approve new site signups for groups they are admin for.
• Hook provided to allow other OG modules to easily supply Group Node ID. http://drupal.org/node/176703
• Access control for Multiple Node Access. http://groups.drupal.org/node/5392
• Provides block for Group Logo. http://drupal.org/node/256423

Notes:

• If your basic "OG User Roles aren't working", please note the following:
  
  5.x
  It appears that the Drupal caching mechanism is used much more stringently as a result of either 5.7 core or OG 5.x-7.x changes. Assuming OGUR has been installed correctly, this may result in group roles you've assigned to group users not being respected when they should (i.e., when they are in group context). In this case, the solution is to implement the "Clear the Cache" setting in OGUR: http://drupal.org/node/263944.
  
  6.x
  There is a bug in the user_access() function. See http://drupal.org/node/329646 for explanation and appropriate patch. See http://drupal.org/node/325259 for issue background.
• If you do not see ogr_access realm in multinode access table, see: http://drupal.org/node/300421
• Clean URLs is a requirement. http://drupal.org/node/157858 and http://drupal.org/node/155882
• If you are getting a Call to undefined function og_get_types() error, please see: http://drupal.org/node/273289
• This module requires the base url of your site not consist of subdirectories. (i.e., your base site url must be "www.yoursite.com" and not "www.yoursite.com/subdirectory"). See: http://drupal.org/node/155882
• We've had some reported incompatibility between this module and the BuddyList module. http://drupal.org/node/163873. There is resolved here: http://drupal.org/node/166275
• Issue with Drupal core file upload module. Documented here: http://drupal.org/node/166566
• This module changes the "node/add" URL for creating new nodes in group context to "ognodeadd" which can cause problems with some other modules. We have fixed most of the problems that have arisen, and so far, we have tracked the known existing incompatibilities down to the following modules: editablefields http://drupal.org/node/175236 and Formfilter http://drupal.org/node/167184. However, you should be aware that you might be using a module which has this incompatibility with OG User Roles.
• Also, known problem with ognodeadd re-direction with CCK-created group content types where the machine-readable name contains dashes and the human-readable name contains spaces. http://drupal.org/node/178610

DESCRIPTION

This module allows you to, for each group type, specify a list of roles that group administrators are allowed to assign. In the subscriber list (og/users/), a 'configure member roles' tab will appear if both the group type is allowed to configure roles and the current user is an admin for the group.

For example, if you created a "trusted user" role, and a new group called "official group," you could allow administrators of only "official group" to add selected other group members of "official group" to the "trusted user" role (only within "official group"). These administrators would see the "configure member roles" tab. The group members added to the "trusted user" role would only have thse permissions while in the "official group" pages or context.

Furthermore, unlike the original og_roles module, this module will restrict the role you select for the user to the group. So, if you have a role called "contributor", and you assign that role to a user and group using this module, the user will only have the role "contributor" in the specified group, and will not have it in any other group unless you specifically add the role to the user in that group.

Read the history of this module: http://drupal.org/node/87679

This module also has it's own access control for optionally integrating the taxonomy access control (TAC) and organic groups (OG) modules.
See: http://groups.drupal.org/node/3700.

Supports content_access and acl access control modules.
See http://groups.drupal.org/node/5392

Works with og_vocab module. See this issue: http://drupal.org/node/162649

Works with modr8 module. See this issue: http://drupal.org/node/164092

REQUIREMENTS

- Requires the organic groups module.
- Requires the organic groups forums module.
- Requires the mimemail module (if you wish to send automatic notifications).
- Requires the og_subgroups module (if you wish to create subgroups).
- Requires additional code in your theme's style.css
- Requires Clean URLs.
- Requires base url with no subdirectories. (i.e., your base site url must be "www.example.com" and not www.example.com/subdirectory")
- Requires content_access and acl modules (if you wish content_access functionality)

CREDITS

The original og_roles module was Authored and maintained by Farsheed Hamidi-Toosi and Angela Byron of CivicSpace Labs Sponsored by Raven Brooks of BuyBlue.org

The version was modified from their original version.

The initial code cleanup (bringing code more or less into Drupal coding standards) was performed by user frjo: http://drupal.org/node/156939

Code for registration code functionality inspired by "Registration Code" module by Drupal user colan. That module owes it's original code to Drupal user nevets.

Original "Multiple Node Access logic patch" developed by agentrickard: http://drupal.org/node/196922

"Permissions table" functionality sponsored by held69 (http://drupal.org/user/275615). Thank you!