const.py 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200
  1. from flask_babel import lazy_gettext
  2. """
  3. All constants and messages definitions go here
  4. Log messages obey the following rule:
  5. LOGMSG_<SEV>_<MODULE>_<NAME>
  6. <SEV> :- INF | DEB | WAR | ERR
  7. <MODULE> :- SEC
  8. Flash messages obey the following rule:
  9. FLAMSG_<SEV>_<MODULE>_<NAME>
  10. <SEV> :- INF | DEB | WAR | ERR
  11. <MODULE> :- SEC
  12. """
  13. LOGMSG_ERR_SEC_ACCESS_DENIED = "Access is Denied for: %s on: %s"
  14. """ Access denied log message, format with user and view/resource """
  15. LOGMSG_WAR_SEC_LOGIN_FAILED = "Login Failed for user: %s"
  16. LOGMSG_ERR_SEC_CREATE_DB = "DB Creation and initialization failed: %s"
  17. """ security models creation fails, format with error message """
  18. LOGMSG_ERR_SEC_ADD_ROLE = "Add Role: %s"
  19. """ Error adding role, format with err message """
  20. LOGMSG_ERR_SEC_ADD_PERMISSION = "Add Permission: %s"
  21. """ Error adding permission, format with err message """
  22. LOGMSG_ERR_SEC_ADD_VIEWMENU = "Add View Menu Error: %s"
  23. """ Error adding view menu, format with err message """
  24. LOGMSG_ERR_SEC_DEL_PERMISSION = "Del Permission Error: %s"
  25. """ Error deleting permission, format with err message """
  26. LOGMSG_ERR_SEC_ADD_PERMVIEW = "Creation of Permission View Error: %s"
  27. """ Error adding permission view, format with err message """
  28. LOGMSG_ERR_SEC_DEL_PERMVIEW = "Remove Permission from View Error: %s"
  29. """ Error deleting permission view, format with err message """
  30. LOGMSG_WAR_SEC_DEL_PERMVIEW = (
  31. "Refused to delete permission view, assoc with role exists %s.%s %s"
  32. )
  33. LOGMSG_WAR_SEC_DEL_PERMISSION = "Refused to delete, permission %s does not exist"
  34. LOGMSG_WAR_SEC_DEL_VIEWMENU = "Refused to delete, view menu %s does not exist"
  35. LOGMSG_WAR_SEC_DEL_PERM_PVM = "Refused to delete permission %s, PVM exists %s"
  36. LOGMSG_WAR_SEC_DEL_VIEWMENU_PVM = "Refused to delete view menu %s, PVM exists %s"
  37. LOGMSG_ERR_SEC_ADD_PERMROLE = "Add Permission to Role Error: %s"
  38. """ Error adding permission to role, format with err message """
  39. LOGMSG_ERR_SEC_DEL_PERMROLE = "Remove Permission to Role Error: %s"
  40. """ Error deleting permission to role, format with err message """
  41. LOGMSG_ERR_SEC_ADD_REGISTER_USER = "Add Register User Error: %s"
  42. """ Error adding registered user, format with err message """
  43. LOGMSG_ERR_SEC_DEL_REGISTER_USER = "Remove Register User Error: %s"
  44. """ Error deleting registered user, format with err message """
  45. LOGMSG_ERR_SEC_NO_REGISTER_HASH = "Attempt to activate user with false hash: %s"
  46. """ Attempt to activate user with not registered hash, format with hash """
  47. LOGMSG_ERR_SEC_AUTH_LDAP = "LDAP Error %s"
  48. """ Generic LDAP error, format with err message """
  49. LOGMSG_ERR_SEC_AUTH_LDAP_TLS = (
  50. "LDAP Could not activate TLS on established connection with %s"
  51. )
  52. """ LDAP Could not activate TLS on established connection with server """
  53. LOGMSG_ERR_SEC_ADD_USER = "Error adding new user to database. %s"
  54. """ Error adding user, format with err message """
  55. LOGMSG_ERR_SEC_UPD_USER = "Error updating user to database. %s "
  56. """ Error updating user, format with err message """
  57. LOGMSG_WAR_SEC_NO_USER = "No user yet created, use flask fab command to do it."
  58. """ Warning when app starts if no user exists on db """
  59. LOGMSG_WAR_SEC_NOLDAP_OBJ = "No LDAP object found for: %s"
  60. LOGMSG_INF_SEC_ADD_PERMVIEW = "Created Permission View: %s"
  61. """ Info when adding permission view, format with permission view class string """
  62. LOGMSG_INF_SEC_DEL_PERMVIEW = "Removed Permission View: %s on %s"
  63. """ Info when deleting permission view, format with permission name and view name """
  64. LOGMSG_INF_SEC_ADD_PERMROLE = "Added Permission %s to role %s"
  65. """ Info when adding permission to role,
  66. format with permission view class string and role name """
  67. LOGMSG_INF_SEC_DEL_PERMROLE = "Removed Permission %s to role %s"
  68. """ Info when deleting permission to role,
  69. format with permission view class string and role name """
  70. LOGMSG_INF_SEC_ADD_ROLE = "Inserted Role: %s"
  71. """ Info when added role, format with role name """
  72. LOGMSG_INF_SEC_NO_DB = "Security DB not found Creating all Models from Base"
  73. LOGMSG_INF_SEC_ADD_DB = "Security DB Created"
  74. LOGMSG_INF_SEC_ADD_USER = "Added user %s"
  75. """ User added, format with username """
  76. LOGMSG_INF_SEC_UPD_USER = "Updated user %s"
  77. """ User updated, format with username """
  78. LOGMSG_INF_SEC_UPD_ROLE = "Updated role %s"
  79. """ Role updated, format with role name """
  80. LOGMSG_ERR_SEC_UPD_ROLE = "An error occurred updating role %s"
  81. """ Role updated Error, format with role name """
  82. LOGMSG_INF_FAB_ADDON_ADDED = "Registered AddOn: %s"
  83. """ Addon imported and registered """
  84. LOGMSG_ERR_FAB_ADDON_IMPORT = "An error occurred when importing declared addon %s: %s"
  85. """ Error on addon import, format with addon class path and error message """
  86. LOGMSG_ERR_FAB_ADDON_PROCESS = "An error occurred when processing declared addon %s: %s"
  87. """ Error on addon processing (pre, register, post),
  88. format with addon class path and error message """
  89. LOGMSG_ERR_FAB_ADD_PERMISSION_MENU = "Add Permission on Menu Error: %s"
  90. """ Error when adding a permission to a menu, format with err """
  91. LOGMSG_ERR_FAB_ADD_PERMISSION_VIEW = "Add Permission on View Error: %s"
  92. """ Error when adding a permission to a menu, format with err """
  93. LOGMSG_ERR_DBI_ADD_GENERIC = "Add record error: %s"
  94. """ Database add generic error, format with err message """
  95. LOGMSG_ERR_DBI_EDIT_GENERIC = "Edit record error: %s"
  96. """ Database edit generic error, format with err message """
  97. LOGMSG_ERR_DBI_DEL_GENERIC = "Delete record error: %s"
  98. """ Database delete generic error, format with err message """
  99. LOGMSG_WAR_DBI_AVG_ZERODIV = "Zero division on aggregate_avg"
  100. LOGMSG_WAR_FAB_VIEW_EXISTS = "View already exists %s ignoring"
  101. """ Attempt to add an already added view, format with view name """
  102. LOGMSG_WAR_DBI_ADD_INTEGRITY = "Add record integrity error: %s"
  103. """ Dabase integrity error, format with err message """
  104. LOGMSG_WAR_DBI_EDIT_INTEGRITY = "Edit record integrity error: %s"
  105. """ Dabase integrity error, format with err message """
  106. LOGMSG_WAR_DBI_DEL_INTEGRITY = "Delete record integrity error: %s"
  107. """ Dabase integrity error, format with err message """
  108. LOGMSG_INF_FAB_ADD_VIEW = "Registering class %s on menu %s"
  109. """ Inform that view class was added, format with class name, name"""
  110. FLAMSG_ERR_SEC_ACCESS_DENIED = lazy_gettext("Access is Denied")
  111. """ Access denied flash message """
  112. PERMISSION_PREFIX = "can_"
  113. """ Prefix to be concatenated to permission names, and inserted in the backend """
  114. AUTH_OID = 0
  115. AUTH_DB = 1
  116. AUTH_LDAP = 2
  117. AUTH_REMOTE_USER = 3
  118. AUTH_OAUTH = 4
  119. """ Constants for supported authentication types """
  120. # -----------------------------------
  121. # REST API Constants
  122. # -----------------------------------
  123. API_SECURITY_VERSION = "v1"
  124. API_SECURITY_PROVIDER_DB = "db"
  125. API_SECURITY_PROVIDER_LDAP = "ldap"
  126. API_SECURITY_USERNAME_KEY = "username"
  127. API_SECURITY_PASSWORD_KEY = "password"
  128. API_SECURITY_PROVIDER_KEY = "provider"
  129. API_SECURITY_REFRESH_KEY = "refresh"
  130. API_SECURITY_ACCESS_TOKEN_KEY = "access_token"
  131. API_SECURITY_REFRESH_TOKEN_KEY = "refresh_token"
  132. # Response keys
  133. API_ORDER_COLUMNS_RES_KEY = "order_columns"
  134. API_LABEL_COLUMNS_RES_KEY = "label_columns"
  135. API_LIST_COLUMNS_RES_KEY = "list_columns"
  136. API_SHOW_COLUMNS_RES_KEY = "show_columns"
  137. API_ADD_COLUMNS_RES_KEY = "add_columns"
  138. API_EDIT_COLUMNS_RES_KEY = "edit_columns"
  139. API_DESCRIPTION_COLUMNS_RES_KEY = "description_columns"
  140. API_RESULT_RES_KEY = "result"
  141. API_FILTERS_RES_KEY = "filters"
  142. API_PERMISSIONS_RES_KEY = "permissions"
  143. API_LIST_TITLE_RES_KEY = "list_title"
  144. API_ADD_TITLE_RES_KEY = "add_title"
  145. API_EDIT_TITLE_RES_KEY = "edit_title"
  146. API_SHOW_TITLE_RES_KEY = "show_title"
  147. # Request Rison keys
  148. API_URI_RIS_KEY = "q"
  149. API_ORDER_COLUMNS_RIS_KEY = "order_columns"
  150. API_LABEL_COLUMNS_RIS_KEY = "label_columns"
  151. API_LIST_COLUMNS_RIS_KEY = "list_columns"
  152. API_SHOW_COLUMNS_RIS_KEY = "show_columns"
  153. API_ADD_COLUMNS_RIS_KEY = "add_columns"
  154. API_EDIT_COLUMNS_RIS_KEY = "edit_columns"
  155. API_DESCRIPTION_COLUMNS_RIS_KEY = "description_columns"
  156. API_FILTERS_RIS_KEY = "filters"
  157. API_PERMISSIONS_RIS_KEY = "permissions"
  158. API_SELECT_COLUMNS_RIS_KEY = "columns"
  159. API_SELECT_SEL_COLUMNS_RIS_KEY = "select_columns"
  160. API_SELECT_KEYS_RIS_KEY = "keys"
  161. API_ORDER_COLUMN_RIS_KEY = "order_column"
  162. API_ORDER_DIRECTION_RIS_KEY = "order_direction"
  163. API_PAGE_INDEX_RIS_KEY = "page"
  164. API_PAGE_SIZE_RIS_KEY = "page_size"
  165. API_LIST_TITLE_RIS_KEY = "list_title"
  166. API_ADD_TITLE_RIS_KEY = "add_title"
  167. API_EDIT_TITLE_RIS_KEY = "edit_title"
  168. API_SHOW_TITLE_RIS_KEY = "show_title"
  169. # -----------------------------------
  170. # OAuth Provider Constants
  171. # -----------------------------------
  172. MICROSOFT_KEY_SET_URL = "https://login.microsoftonline.com/common/discovery/keys"