CapabilitiesUtil.kt 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290
  1. /*
  2. * Nextcloud Talk - Android Client
  3. *
  4. * SPDX-FileCopyrightText: 2023-2024 Marcel Hibbe <dev@mhibbe.de>
  5. * SPDX-FileCopyrightText: 2021 Andy Scherzinger <info@andy-scherzinger.de>
  6. * SPDX-FileCopyrightText: 2017-2018 Mario Danic <mario@lovelyhq.com>
  7. * SPDX-License-Identifier: GPL-3.0-or-later
  8. */
  9. package com.nextcloud.talk.utils
  10. import android.util.Log
  11. import com.nextcloud.talk.data.user.model.User
  12. import com.nextcloud.talk.models.json.capabilities.SpreedCapability
  13. enum class SpreedFeatures(val value: String) {
  14. RECORDING_V1("recording-v1"),
  15. REACTIONS("reactions"),
  16. RAISE_HAND("raise-hand"),
  17. DIRECT_MENTION_FLAG("direct-mention-flag"),
  18. CONVERSATION_CALL_FLAGS("conversation-call-flags"),
  19. SILENT_SEND("silent-send"),
  20. MENTION_FLAG("mention-flag"),
  21. DELETE_MESSAGES("delete-messages"),
  22. READ_ONLY_ROOMS("read-only-rooms"),
  23. RICH_OBJECT_LIST_MEDIA("rich-object-list-media"),
  24. SILENT_CALL("silent-call"),
  25. MESSAGE_EXPIRATION("message-expiration"),
  26. WEBINARY_LOBBY("webinary-lobby"),
  27. VOICE_MESSAGE_SHARING("voice-message-sharing"),
  28. INVITE_GROUPS_AND_MAILS("invite-groups-and-mails"),
  29. CIRCLES_SUPPORT("circles-support"),
  30. LAST_ROOM_ACTIVITY("last-room-activity"),
  31. NOTIFICATION_LEVELS("notification-levels"),
  32. CLEAR_HISTORY("clear-history"),
  33. AVATAR("avatar"),
  34. LISTABLE_ROOMS("listable-rooms"),
  35. LOCKED_ONE_TO_ONE_ROOMS("locked-one-to-one-rooms"),
  36. TEMP_USER_AVATAR_API("temp-user-avatar-api"),
  37. PHONEBOOK_SEARCH("phonebook-search"),
  38. GEO_LOCATION_SHARING("geo-location-sharing"),
  39. TALK_POLLS("talk-polls"),
  40. FAVORITES("favorites"),
  41. CHAT_READ_MARKER("chat-read-marker"),
  42. CHAT_UNREAD("chat-unread"),
  43. EDIT_MESSAGES("edit-messages"),
  44. REMIND_ME_LATER("remind-me-later"),
  45. CHAT_V2("chat-v2"),
  46. SIP_SUPPORT("sip-support"),
  47. SIGNALING_V3("signaling-v3"),
  48. ROOM_DESCRIPTION("room-description"),
  49. UNIFIED_SEARCH("unified-search"),
  50. LOCKED_ONE_TO_ONE("locked-one-to-one-rooms"),
  51. CHAT_PERMISSION("chat-permission"),
  52. CONVERSATION_PERMISSION("conversation-permissions"),
  53. FEDERATION_V1("federation-v1"),
  54. DELETE_MESSAGES_UNLIMITED("delete-messages-unlimited"),
  55. BAN_V1("ban-v1"),
  56. EDIT_MESSAGES_NOTE_TO_SELF("edit-messages-note-to-self"),
  57. ARCHIVE_CONVERSATIONS("archived-conversations-v2")
  58. }
  59. @Suppress("TooManyFunctions")
  60. object CapabilitiesUtil {
  61. //region Version checks
  62. fun isServerEOL(serverVersion: Int?): Boolean {
  63. if (serverVersion == null) {
  64. Log.w(TAG, "serverVersion is unknown. It is assumed that it is up to date")
  65. return false
  66. }
  67. return (serverVersion < SERVER_VERSION_MIN_SUPPORTED)
  68. }
  69. fun isServerAlmostEOL(serverVersion: Int?): Boolean {
  70. if (serverVersion == null) {
  71. Log.w(TAG, "serverVersion is unknown. It is assumed that it is up to date")
  72. return false
  73. }
  74. return (serverVersion < SERVER_VERSION_SUPPORT_WARNING)
  75. }
  76. // endregion
  77. //region CoreCapabilities
  78. @JvmStatic
  79. fun isLinkPreviewAvailable(user: User): Boolean =
  80. user.capabilities?.coreCapability?.referenceApi != null &&
  81. user.capabilities?.coreCapability?.referenceApi == "true"
  82. fun canGeneratePrettyURL(user: User): Boolean = user.capabilities?.coreCapability?.modRewriteWorking == true
  83. // endregion
  84. //region SpreedCapabilities
  85. @JvmStatic
  86. fun hasSpreedFeatureCapability(spreedCapabilities: SpreedCapability, spreedFeatures: SpreedFeatures): Boolean {
  87. if (spreedCapabilities.features != null) {
  88. return spreedCapabilities.features!!.contains(spreedFeatures.value)
  89. }
  90. return false
  91. }
  92. fun isSharedItemsAvailable(spreedCapabilities: SpreedCapability): Boolean =
  93. hasSpreedFeatureCapability(spreedCapabilities, SpreedFeatures.RICH_OBJECT_LIST_MEDIA)
  94. fun getMessageMaxLength(spreedCapabilities: SpreedCapability): Int {
  95. if (spreedCapabilities.config?.containsKey("chat") == true) {
  96. val chatConfigHashMap = spreedCapabilities.config!!["chat"]
  97. if (chatConfigHashMap?.containsKey("max-length") == true) {
  98. val chatSize = (chatConfigHashMap["max-length"]!!.toString()).toInt()
  99. return if (chatSize > 0) {
  100. chatSize
  101. } else {
  102. DEFAULT_CHAT_SIZE
  103. }
  104. }
  105. }
  106. return DEFAULT_CHAT_SIZE
  107. }
  108. fun isReadStatusAvailable(spreedCapabilities: SpreedCapability): Boolean {
  109. if (spreedCapabilities.config?.containsKey("chat") == true) {
  110. val map: Map<String, Any>? = spreedCapabilities.config!!["chat"]
  111. return map != null && map.containsKey("read-privacy")
  112. }
  113. return false
  114. }
  115. @JvmStatic
  116. fun isCallRecordingAvailable(spreedCapabilities: SpreedCapability): Boolean {
  117. if (hasSpreedFeatureCapability(spreedCapabilities, SpreedFeatures.RECORDING_V1) &&
  118. spreedCapabilities.config?.containsKey("call") == true
  119. ) {
  120. val map: Map<String, Any>? = spreedCapabilities.config!!["call"]
  121. if (map != null && map.containsKey("recording")) {
  122. return (map["recording"].toString()).toBoolean()
  123. }
  124. }
  125. return false
  126. }
  127. @JvmStatic
  128. fun getAttachmentFolder(spreedCapabilities: SpreedCapability): String {
  129. if (spreedCapabilities.config?.containsKey("attachments") == true) {
  130. val map = spreedCapabilities.config!!["attachments"]
  131. if (map?.containsKey("folder") == true) {
  132. return map["folder"].toString()
  133. }
  134. }
  135. return "/Talk"
  136. }
  137. fun isConversationDescriptionEndpointAvailable(spreedCapabilities: SpreedCapability): Boolean =
  138. hasSpreedFeatureCapability(spreedCapabilities, SpreedFeatures.ROOM_DESCRIPTION)
  139. fun isUnifiedSearchAvailable(spreedCapabilities: SpreedCapability): Boolean =
  140. hasSpreedFeatureCapability(spreedCapabilities, SpreedFeatures.UNIFIED_SEARCH)
  141. fun isAbleToCall(spreedCapabilities: SpreedCapability): Boolean =
  142. if (
  143. spreedCapabilities.config?.containsKey("call") == true &&
  144. spreedCapabilities.config!!["call"] != null &&
  145. spreedCapabilities.config!!["call"]!!.containsKey("enabled")
  146. ) {
  147. java.lang.Boolean.parseBoolean(spreedCapabilities.config!!["call"]!!["enabled"].toString())
  148. } else {
  149. // older nextcloud versions without the capability can't disable the calls
  150. true
  151. }
  152. fun isCallReactionsSupported(user: User?): Boolean {
  153. if (user?.capabilities != null) {
  154. val capabilities = user.capabilities
  155. return capabilities?.spreedCapability?.config?.containsKey("call") == true &&
  156. capabilities.spreedCapability!!.config!!["call"] != null &&
  157. capabilities.spreedCapability!!.config!!["call"]!!.containsKey("supported-reactions")
  158. }
  159. return false
  160. }
  161. fun isTranslationsSupported(spreedCapabilities: SpreedCapability): Boolean =
  162. spreedCapabilities.config?.containsKey("chat") == true &&
  163. spreedCapabilities.config!!["chat"] != null &&
  164. spreedCapabilities.config!!["chat"]!!.containsKey("has-translation-providers") &&
  165. spreedCapabilities.config!!["chat"]!!["has-translation-providers"] == true
  166. fun getRecordingConsentType(spreedCapabilities: SpreedCapability): Int {
  167. if (
  168. spreedCapabilities.config?.containsKey("call") == true &&
  169. spreedCapabilities.config!!["call"] != null &&
  170. spreedCapabilities.config!!["call"]!!.containsKey("recording-consent")
  171. ) {
  172. return when (
  173. spreedCapabilities.config!!["call"]!!["recording-consent"].toString()
  174. .toInt()
  175. ) {
  176. 1 -> RECORDING_CONSENT_REQUIRED
  177. 2 -> RECORDING_CONSENT_DEPEND_ON_CONVERSATION
  178. else -> RECORDING_CONSENT_NOT_REQUIRED
  179. }
  180. }
  181. return RECORDING_CONSENT_NOT_REQUIRED
  182. }
  183. fun isBanningAvailable(spreedCapabilities: SpreedCapability): Boolean =
  184. hasSpreedFeatureCapability(spreedCapabilities, SpreedFeatures.BAN_V1)
  185. // endregion
  186. //region SpreedCapabilities that can't be used with federation as the settings for them are global
  187. fun isReadStatusPrivate(user: User): Boolean {
  188. if (user.capabilities?.spreedCapability?.config?.containsKey("chat") == true) {
  189. val map = user.capabilities!!.spreedCapability!!.config!!["chat"]
  190. if (map?.containsKey("read-privacy") == true) {
  191. return (map["read-privacy"]!!.toString()).toInt() == 1
  192. }
  193. }
  194. return false
  195. }
  196. fun isTypingStatusAvailable(user: User): Boolean {
  197. if (user.capabilities?.spreedCapability?.config?.containsKey("chat") == true) {
  198. val map = user.capabilities!!.spreedCapability!!.config!!["chat"]
  199. return map != null && map.containsKey("typing-privacy")
  200. }
  201. return false
  202. }
  203. fun isTypingStatusPrivate(user: User): Boolean {
  204. if (user.capabilities?.spreedCapability?.config?.containsKey("chat") == true) {
  205. val map = user.capabilities!!.spreedCapability!!.config!!["chat"]
  206. if (map?.containsKey("typing-privacy") == true) {
  207. return (map["typing-privacy"]!!.toString()).toInt() == 1
  208. }
  209. }
  210. return false
  211. }
  212. fun isFederationAvailable(user: User): Boolean =
  213. hasSpreedFeatureCapability(user.capabilities!!.spreedCapability!!, SpreedFeatures.FEDERATION_V1) &&
  214. user.capabilities!!.spreedCapability!!.config?.containsKey("federation") == true &&
  215. user.capabilities!!.spreedCapability!!.config!!["federation"] != null &&
  216. user.capabilities!!.spreedCapability!!.config!!["federation"]!!.containsKey("enabled")
  217. // endregion
  218. //region ThemingCapabilities
  219. fun getServerName(user: User?): String? {
  220. if (user?.capabilities?.themingCapability != null) {
  221. return user.capabilities!!.themingCapability!!.name
  222. }
  223. return ""
  224. }
  225. // endregion
  226. //region ProvisioningCapabilities
  227. fun canEditScopes(user: User): Boolean =
  228. user.capabilities?.provisioningCapability?.accountPropertyScopesVersion != null &&
  229. user.capabilities!!.provisioningCapability!!.accountPropertyScopesVersion!! > 1
  230. // endregion
  231. //region UserStatusCapabilities
  232. @JvmStatic
  233. fun isUserStatusAvailable(user: User): Boolean =
  234. user.capabilities?.userStatusCapability?.enabled == true &&
  235. user.capabilities?.userStatusCapability?.supportsEmoji == true
  236. fun isRestoreStatusAvailable(user: User): Boolean {
  237. return user.capabilities?.userStatusCapability?.restore == true
  238. }
  239. // endregion
  240. private val TAG = CapabilitiesUtil::class.java.simpleName
  241. const val DEFAULT_CHAT_SIZE = 1000
  242. const val RECORDING_CONSENT_NOT_REQUIRED = 0
  243. const val RECORDING_CONSENT_REQUIRED = 1
  244. const val RECORDING_CONSENT_DEPEND_ON_CONVERSATION = 2
  245. private const val SERVER_VERSION_MIN_SUPPORTED = 17
  246. private const val SERVER_VERSION_SUPPORT_WARNING = 26
  247. }