Source for file permissions.php

Documentation is available at permissions.php

  1. <?php
  2. /**
  3. * Permission codes for actions
  4. *
  5. * @author     Stuart Prescott
  6. * @copyright  Copyright Stuart Prescott
  7. * @license    http://opensource.org/licenses/gpl-license.php GNU Public License
  8. * @version    $Id$
  9. * @package    Bumblebee
  10. * @subpackage Misc
  11. */
  12.  
  13. /** Load ancillary functions */
  14. require_once 'inc/typeinfo.php';
  15. checkValidInclude();
  16.  
  17. // Activity:
  18. /** Activity: no-op  */
  19. define('BBROLE_NONE',                    $role = 1);
  20. /** Activity: change own password */
  21. define('BBROLE_PASSWD',                 ($role<<=1));
  22. /** Activity: log out */
  23. define('BBROLE_LOGOUT',                 ($role<<=1));
  24. /** Activity: view list  */
  25. define('BBROLE_VIEW_LIST',              ($role<<=1));
  26. /** Activity: view instrument calendar */
  27. define('BBROLE_VIEW_CALENDAR',          ($role<<=1));
  28. /** Activity: view instrument booking sheet into the distant future */
  29. define('BBROLE_VIEW_CALENDAR_FUTURE',   ($role<<=1) | BBROLE_VIEW_CALENDAR);
  30. /** Activity: view instrument bookings */
  31. define('BBROLE_VIEW_BOOKINGS',          ($role<<=1));
  32. /** Activity: view admin details of bookings on the instrument */
  33. define('BBROLE_VIEW_BOOKINGS_DETAILS',  ($role<<=1) | BBROLE_VIEW_BOOKINGS);
  34. /** Activity: make bookings */
  35. define('BBROLE_MAKE_BOOKINGS',          ($role<<=1));
  36. /** Activity: Book instrument any time into the future */
  37. define('BBROLE_MAKE_BOOKINGS_FUTURE',   ($role<<=1) | BBROLE_MAKE_BOOKINGS);
  38. /** Activity: edit all bookings on instrument */
  39. define('BBROLE_EDIT_ALL',               ($role<<=1) | BBROLE_MAKE_BOOKINGS);
  40. /** Activity: Book instrument without timeslot restrictions */
  41. define('BBROLE_MAKE_BOOKINGS_FREE',     ($role<<=1) | BBROLE_MAKE_BOOKINGS);
  42. /** Activity: Delete own bookings with appropriate notice */
  43. define('BBROLE_UNBOOK',                 ($role<<=1));
  44. /** Activity: Delete own bookings without restrictions for appropriate notice  */
  45. define('BBROLE_UNBOOK_PAST',            ($role<<=1) | BBROLE_UNBOOK);
  46. /** Activity: Delete others' bookings */
  47. define('BBROLE_UNBOOK_OTHER',           ($role<<=1) | BBROLE_UNBOOK);
  48.  
  49. /** Activity: edit groups */
  50. define('BBROLE_ADMIN_GROUPS',           ($role<<=1));
  51. /** Activity: edit projects */
  52. define('BBROLE_ADMIN_PROJECTS',         ($role<<=1));
  53. /** Activity: edit users */
  54. define('BBROLE_ADMIN_USERS',            ($role<<=1));
  55. /** Activity: edit instruments */
  56. define('BBROLE_ADMIN_INSTRUMENTS',      ($role<<=1));
  57. /** Activity: edit consumables */
  58. define('BBROLE_ADMIN_CONSUMABLES',      ($role<<=1));
  59. /** Activity: record consumable usage */
  60. define('BBROLE_ADMIN_CONSUME',          ($role<<=1));
  61. /** Activity: edit costs */
  62. define('BBROLE_ADMIN_COSTS',            ($role<<=1));
  63. /** Activity: view deleted bookings */
  64. define('BBROLE_ADMIN_DELETEDBOOKINGS',  ($role<<=1));
  65. /** Activity: masquerade as another */
  66. define('BBROLE_ADMIN_MASQ',             ($role<<=1));
  67. /** Activity: collect email lists  */
  68. define('BBROLE_ADMIN_EMAILLIST',        ($role<<=1));
  69. /** Activity: export data */
  70. define('BBROLE_ADMIN_EXPORT',           ($role<<=1));
  71. /** Activity: send out billing reports  */
  72. define('BBROLE_ADMIN_BILLING',          ($role<<=1));
  73. /** Activity: backup database */
  74. define('BBROLE_ADMIN_BACKUPDB',         ($role<<=1));
  75. /** Activity: change system config */
  76. define('BBROLE_ADMIN_CONFIG',           ($role<<=1));
  77.  
  78. /** Activity: Admin activity flag */
  79. define('BBROLE_ADMIN_BASE',             BBROLE_ADMIN_GROUPS);
  80.  
  81.  
  82. // SYSTEM LEVEL FUNCTIONS: NORMAL USERS
  83. /** Permission: user can view all instruments on list */
  84. define('BBPERM_USER_VIEW_LIST_ALL',       BBROLE_VIEW_LIST);
  85. /** Permission: user can view all instrument calendars */
  86. define('BBPERM_USER_VIEW_CALENDAR_ALL',   BBROLE_VIEW_CALENDAR);
  87. /** Permission: user can view all instrument bookings */
  88. define('BBPERM_USER_VIEW_BOOKINGS_ALL',   BBROLE_VIEW_BOOKINGS);
  89. /** Permission: user do all VIEW actions on all instruments */
  90. define('BBPERM_USER_VIEW_ALL',            BBPERM_USER_VIEW_LIST_ALL | BBPERM_USER_VIEW_CALENDAR_ALL | BBPERM_USER_VIEW_BOOKINGS_ALL);
  91. /** Permission: user can make bookings */
  92. define('BBPERM_USER_MAKE_BOOKINGS_ALL',   BBROLE_MAKE_BOOKINGS);
  93. /** Permission: user can change their own password */
  94. define('BBPERM_USER_PASSWD',              BBROLE_PASSWD);
  95. /** Permission: user log out */
  96. define('BBPERM_USER_LOGOUT',              BBROLE_LOGOUT);
  97. /** Permission: sensible, basic user permissions */
  98. define('BBPERM_USER_BASIC',               BBPERM_USER_LOGOUT | BBPERM_USER_PASSWD);
  99. /** Permission: readonly user permissions */
  100. define('BBPERM_USER_READONLY',            BBPERM_USER_LOGOUT);
  101.  
  102. // SYSTEM LEVEL FUNCTIONS: ADMIN USERS
  103. /** Permission: Permission to edit groups */
  104. define('BBPERM_ADMIN_GROUPS',             BBROLE_ADMIN_GROUPS);
  105. /** Permission: Permission to edit projects */
  106. define('BBPERM_ADMIN_PROJECTS',           BBROLE_ADMIN_PROJECTS);
  107. /** Permission: Permission to edit users */
  108. define('BBPERM_ADMIN_USERS',              BBROLE_ADMIN_USERS);
  109. /** Permission: Permission to edit instruments */
  110. define('BBPERM_ADMIN_INSTRUMENTS',        BBROLE_ADMIN_INSTRUMENTS);
  111. /** Permission: Permission to edit consumables */
  112. define('BBPERM_ADMIN_CONSUMABLES',        BBROLE_ADMIN_CONSUMABLES);
  113. /** Permission: Permission to record consumable usage */
  114. define('BBPERM_ADMIN_CONSUME',            BBROLE_ADMIN_CONSUME);
  115. /** Permission: Permission to edit costs */
  116. define('BBPERM_ADMIN_COSTS',              BBROLE_ADMIN_COSTS);
  117. /** Permission: Permission to view deleted bookings */
  118. define('BBPERM_ADMIN_DELETEDBOOKINGS',    BBROLE_ADMIN_DELETEDBOOKINGS);
  119. /** Permission: user can masquerade as another user on any instrument */
  120. define('BBPERM_ADMIN_MASQ',               BBROLE_ADMIN_MASQ);
  121. /** Permission: Permission to collect email lists  */
  122. define('BBPERM_ADMIN_EMAILLIST',          BBROLE_ADMIN_EMAILLIST);
  123. /** Permission: Permission to export data */
  124. define('BBPERM_ADMIN_EXPORT',             BBROLE_ADMIN_EXPORT);
  125. /** Permission: Permission to send out billing reports  */
  126. define('BBPERM_ADMIN_BILLING',            BBROLE_ADMIN_BILLING);
  127. /** Permission: Permission to backup database */
  128. define('BBPERM_ADMIN_BACKUPDB',           BBROLE_ADMIN_BACKUPDB);
  129. /** Permission: Permission to change system settings */
  130. define('BBPERM_ADMIN_CONFIG',             BBROLE_ADMIN_CONFIG);
  131.  
  132. /** Permission: Admin user can do anything */
  133. define('BBPERM_ADMIN_ALL',              -1);
  134.  
  135. // FINE-GRAINED INSTRUMENT PERMISSIONS
  136. /** Permission: View instrument booking sheet (free/busy only) */
  137. define('BBPERM_INSTR_VIEW',             BBROLE_VIEW_CALENDAR);
  138. /** Permission: View instrument booking sheet without restrictions on viewing future bookings */
  139. define('BBPERM_INSTR_VIEW_FUTURE',      BBROLE_VIEW_CALENDAR_FUTURE);
  140. /** Permission: View bookings on the instrument */
  141. define('BBPERM_INSTR_VIEW_BOOKINGS',    BBROLE_VIEW_BOOKINGS);
  142. /** Permission: View admin details of bookings on the instrument */
  143. define('BBPERM_INSTR_VIEW_DETAILS',     BBROLE_VIEW_BOOKINGS_DETAILS);
  144. /** Permission: May edit all bookings on instrument */
  145. define('BBPERM_INSTR_EDIT_ALL',         BBROLE_EDIT_ALL);
  146. /** Permission: Masquerade as a user on this instrument */
  147. define('BBPERM_INSTR_MASQ',             BBROLE_ADMIN_MASQ);
  148. /** Permission: Book instrument */
  149. define('BBPERM_INSTR_BOOK',             BBROLE_MAKE_BOOKINGS);
  150. /** Permission: Book instrument any time into the future */
  151. define('BBPERM_INSTR_BOOK_FUTURE',      BBROLE_MAKE_BOOKINGS_FUTURE);
  152. /** Permission: Book instrument without timeslot restrictions */
  153. define('BBPERM_INSTR_BOOK_FREE',        BBROLE_MAKE_BOOKINGS_FREE);
  154. /** Permission: Delete own bookings with appropriate notice */
  155. define('BBPERM_INSTR_UNBOOK',           BBROLE_UNBOOK);
  156. /** Permission: Delete own bookings without restrictions for appropriate notice  */
  157. define('BBPERM_INSTR_UNBOOK_PAST',      BBROLE_UNBOOK_PAST);
  158. /** Permission: Delete others' bookings */
  159. define('BBPERM_INSTR_UNBOOK_OTHER',     BBROLE_UNBOOK_OTHER);
  160. /** Permission: Edit an individual instrument's settings */
  161. define('BBPERM_INSTR_EDIT_CONFIG',      BBROLE_ADMIN_INSTRUMENTS);
  162. /** Permission: Basic instrument user permissions */
  163. define('BBPERM_INSTR_BASIC',            BBPERM_INSTR_VIEW | BBPERM_INSTR_VIEW_BOOKINGS | BBPERM_INSTR_BOOK | BBPERM_INSTR_UNBOOK);
  164. /** Permission: Read-only permissions */
  165. define('BBPERM_INSTR_READONLY',         BBPERM_INSTR_VIEW);
  166.  
  167. /** Permission: Instrument admin all functions */
  168. define('BBPERM_INSTR_ALL',               -1);
  169.  
  170. // Anonymous user's permissions:
  171. // BBPERM_USER_LOGOUT
  172.  
  173.  
  174. ?>

Documentation generated on Tue, 06 Mar 2007 10:01:54 +0000 by phpDocumentor 1.3.0