features.user.inc 7.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269
  1. <?php
  2. /**
  3. * Implements hook_features_api().
  4. */
  5. function user_features_api() {
  6. return array(
  7. 'user_role' => array(
  8. 'name' => t('Roles'),
  9. 'feature_source' => TRUE,
  10. 'default_hook' => 'user_default_roles',
  11. 'default_file' => FEATURES_DEFAULTS_INCLUDED,
  12. ),
  13. 'user_permission' => array(
  14. 'name' => t('Permissions'),
  15. 'feature_source' => TRUE,
  16. 'default_hook' => 'user_default_permissions',
  17. 'default_file' => FEATURES_DEFAULTS_INCLUDED,
  18. ),
  19. );
  20. }
  21. /**
  22. * Implements hook_features_export().
  23. */
  24. function user_permission_features_export($data, &$export, $module_name = '') {
  25. $export['dependencies']['features'] = 'features';
  26. // Ensure the modules that provide the given permissions are included as dependencies.
  27. $map = user_permission_get_modules();
  28. foreach ($data as $perm) {
  29. if (isset($map[$perm])) {
  30. $perm_module = $map[$perm];
  31. $export['dependencies'][$perm_module] = $perm_module;
  32. $export['features']['user_permission'][$perm] = $perm;
  33. }
  34. }
  35. return array();
  36. }
  37. /**
  38. * Implements hook_features_export_options().
  39. */
  40. function user_permission_features_export_options() {
  41. $modules = array();
  42. $module_info = system_get_info('module');
  43. foreach (module_implements('permission') as $module) {
  44. $modules[$module_info[$module]['name']] = $module;
  45. }
  46. ksort($modules);
  47. $options = array();
  48. foreach ($modules as $display_name => $module) {
  49. if ($permissions = module_invoke($module, 'permission')) {
  50. foreach ($permissions as $perm => $perm_item) {
  51. $options[$perm] = strip_tags("{$display_name}: {$perm_item['title']}");
  52. }
  53. }
  54. }
  55. return $options;
  56. }
  57. /**
  58. * Implements hook_features_export_render().
  59. */
  60. function user_permission_features_export_render($module, $data) {
  61. $perm_modules = &drupal_static(__FUNCTION__ . '_perm_modules');
  62. if (!isset($perm_modules)) {
  63. $perm_modules = user_permission_get_modules();
  64. }
  65. $code = array();
  66. $code[] = ' $permissions = array();';
  67. $code[] = '';
  68. $permissions = _user_features_get_permissions();
  69. foreach ($data as $perm_name) {
  70. $permission = array();
  71. $permission['name'] = $perm_name;
  72. if (!empty($permissions[$perm_name])) {
  73. sort($permissions[$perm_name]);
  74. $permission['roles'] = drupal_map_assoc($permissions[$perm_name]);
  75. }
  76. else {
  77. $permission['roles'] = array();
  78. }
  79. if (isset($perm_modules[$perm_name])) {
  80. $permission['module'] = $perm_modules[$perm_name];
  81. }
  82. $perm_identifier = features_var_export($perm_name);
  83. $perm_export = features_var_export($permission, ' ');
  84. $code[] = " // Exported permission: {$perm_name}.";
  85. $code[] = " \$permissions[{$perm_identifier}] = {$perm_export};";
  86. $code[] = "";
  87. }
  88. $code[] = ' return $permissions;';
  89. $code = implode("\n", $code);
  90. return array('user_default_permissions' => $code);
  91. }
  92. /**
  93. * Implements hook_features_revert().
  94. */
  95. function user_permission_features_revert($module) {
  96. user_permission_features_rebuild($module);
  97. }
  98. /**
  99. * Implements hook_features_rebuild().
  100. * Iterate through default permissions and update the permissions map.
  101. *
  102. * @param $module
  103. * The module whose default user permissions should be rebuilt.
  104. */
  105. function user_permission_features_rebuild($module) {
  106. if ($defaults = features_get_default('user_permission', $module)) {
  107. // Make sure the list of available node types is up to date, especially when
  108. // installing multiple features at once, for example from an install profile
  109. // or via drush.
  110. node_types_rebuild();
  111. $roles = _user_features_get_roles();
  112. $permissions_by_role = _user_features_get_permissions(FALSE);
  113. foreach ($defaults as $permission) {
  114. $perm = $permission['name'];
  115. foreach ($roles as $role) {
  116. if (in_array($role, $permission['roles'])) {
  117. $permissions_by_role[$role][$perm] = TRUE;
  118. }
  119. else {
  120. $permissions_by_role[$role][$perm] = FALSE;
  121. }
  122. }
  123. }
  124. // Write the updated permissions.
  125. foreach ($roles as $rid => $role) {
  126. if (isset($permissions_by_role[$role])) {
  127. user_role_change_permissions($rid, $permissions_by_role[$role]);
  128. }
  129. }
  130. }
  131. }
  132. /**
  133. * Implements hook_features_export().
  134. */
  135. function user_role_features_export($data, &$export, $module_name = '') {
  136. $export['dependencies']['features'] = 'features';
  137. $map = features_get_default_map('user_role', 'name');
  138. foreach ($data as $role) {
  139. // Role is provided by another module. Add dependency.
  140. if (isset($map[$role]) && $map[$role] != $module_name) {
  141. $export['dependencies'][$map[$role]] = $map[$role];
  142. }
  143. // Export.
  144. elseif(user_role_load_by_name($role)) {
  145. $export['features']['user_role'][$role] = $role;
  146. }
  147. }
  148. return array();
  149. }
  150. /**
  151. * Implements hook_features_export_options().
  152. */
  153. function user_role_features_export_options() {
  154. return drupal_map_assoc(_user_features_get_roles(FALSE));
  155. }
  156. /**
  157. * Implements hook_features_export_render().
  158. */
  159. function user_role_features_export_render($module, $data) {
  160. $code = array();
  161. $code[] = ' $roles = array();';
  162. $code[] = '';
  163. foreach ($data as $name) {
  164. if ($role = user_role_load_by_name($name)) {
  165. unset($role->rid);
  166. $role_identifier = features_var_export($name);
  167. $role_export = features_var_export($role , ' ');
  168. $code[] = " // Exported role: {$name}.";
  169. $code[] = " \$roles[{$role_identifier}] = {$role_export};";
  170. $code[] = "";
  171. }
  172. }
  173. $code[] = ' return $roles;';
  174. $code = implode("\n", $code);
  175. return array('user_default_roles' => $code);
  176. }
  177. /**
  178. * Implements hook_features_revert().
  179. */
  180. function user_role_features_revert($module) {
  181. user_role_features_rebuild($module);
  182. }
  183. /**
  184. * Implements hook_features_rebuild().
  185. */
  186. function user_role_features_rebuild($module) {
  187. if ($defaults = features_get_default('user_role', $module)) {
  188. foreach ($defaults as $role) {
  189. $role = (object) $role;
  190. if ($existing = user_role_load_by_name($role->name)) {
  191. $role->rid = $existing->rid;
  192. }
  193. user_role_save($role);
  194. }
  195. }
  196. }
  197. /**
  198. * Generate $rid => $role with role names untranslated.
  199. */
  200. function _user_features_get_roles($builtin = TRUE) {
  201. $roles = array();
  202. foreach (user_roles() as $rid => $name) {
  203. switch ($rid) {
  204. case DRUPAL_ANONYMOUS_RID:
  205. if ($builtin) {
  206. $roles[$rid] = 'anonymous user';
  207. }
  208. break;
  209. case DRUPAL_AUTHENTICATED_RID:
  210. if ($builtin) {
  211. $roles[$rid] = 'authenticated user';
  212. }
  213. break;
  214. default:
  215. $roles[$rid] = $name;
  216. break;
  217. }
  218. }
  219. return $roles;
  220. }
  221. /**
  222. * Represent the current state of permissions as a perm to role name array map.
  223. */
  224. function _user_features_get_permissions($by_role = TRUE) {
  225. $map = user_permission_get_modules();
  226. $roles = _user_features_get_roles();
  227. $permissions = array();
  228. foreach (user_role_permissions($roles) as $rid => $role_permissions) {
  229. if ($by_role) {
  230. foreach (array_keys(array_filter($role_permissions)) as $permission) {
  231. if (isset($map[$permission])) {
  232. $permissions[$permission][] = $roles[$rid];
  233. }
  234. }
  235. }
  236. else {
  237. $permissions[$roles[$rid]] = array();
  238. foreach ($role_permissions as $permission => $status) {
  239. if (isset($map[$permission])) {
  240. $permissions[$roles[$rid]][$permission] = $status;
  241. }
  242. }
  243. }
  244. }
  245. return $permissions;
  246. }