CapabilitiesUtil.kt 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300
  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. }
  58. @Suppress("TooManyFunctions")
  59. object CapabilitiesUtil {
  60. //region Version checks
  61. fun isServerEOL(serverVersion: Int?): Boolean {
  62. if (serverVersion == null) {
  63. Log.w(TAG, "serverVersion is unknown. It is assumed that it is up to date")
  64. return false
  65. }
  66. return (serverVersion < SERVER_VERSION_MIN_SUPPORTED)
  67. }
  68. fun isServerAlmostEOL(serverVersion: Int?): Boolean {
  69. if (serverVersion == null) {
  70. Log.w(TAG, "serverVersion is unknown. It is assumed that it is up to date")
  71. return false
  72. }
  73. return (serverVersion < SERVER_VERSION_SUPPORT_WARNING)
  74. }
  75. // endregion
  76. //region CoreCapabilities
  77. @JvmStatic
  78. fun isLinkPreviewAvailable(user: User): Boolean {
  79. return user.capabilities?.coreCapability?.referenceApi != null &&
  80. user.capabilities?.coreCapability?.referenceApi == "true"
  81. }
  82. fun canGeneratePrettyURL(user: User): Boolean {
  83. return user.capabilities?.coreCapability?.modRewriteWorking == true
  84. }
  85. // endregion
  86. //region SpreedCapabilities
  87. @JvmStatic
  88. fun hasSpreedFeatureCapability(spreedCapabilities: SpreedCapability, spreedFeatures: SpreedFeatures): Boolean {
  89. if (spreedCapabilities.features != null) {
  90. return spreedCapabilities.features!!.contains(spreedFeatures.value)
  91. }
  92. return false
  93. }
  94. fun isSharedItemsAvailable(spreedCapabilities: SpreedCapability): Boolean {
  95. return hasSpreedFeatureCapability(spreedCapabilities, SpreedFeatures.RICH_OBJECT_LIST_MEDIA)
  96. }
  97. fun getMessageMaxLength(spreedCapabilities: SpreedCapability): Int {
  98. if (spreedCapabilities.config?.containsKey("chat") == true) {
  99. val chatConfigHashMap = spreedCapabilities.config!!["chat"]
  100. if (chatConfigHashMap?.containsKey("max-length") == true) {
  101. val chatSize = (chatConfigHashMap["max-length"]!!.toString()).toInt()
  102. return if (chatSize > 0) {
  103. chatSize
  104. } else {
  105. DEFAULT_CHAT_SIZE
  106. }
  107. }
  108. }
  109. return DEFAULT_CHAT_SIZE
  110. }
  111. fun isReadStatusAvailable(spreedCapabilities: SpreedCapability): Boolean {
  112. if (spreedCapabilities.config?.containsKey("chat") == true) {
  113. val map: Map<String, Any>? = spreedCapabilities.config!!["chat"]
  114. return map != null && map.containsKey("read-privacy")
  115. }
  116. return false
  117. }
  118. @JvmStatic
  119. fun isCallRecordingAvailable(spreedCapabilities: SpreedCapability): Boolean {
  120. if (hasSpreedFeatureCapability(spreedCapabilities, SpreedFeatures.RECORDING_V1) &&
  121. spreedCapabilities.config?.containsKey("call") == true
  122. ) {
  123. val map: Map<String, Any>? = spreedCapabilities.config!!["call"]
  124. if (map != null && map.containsKey("recording")) {
  125. return (map["recording"].toString()).toBoolean()
  126. }
  127. }
  128. return false
  129. }
  130. @JvmStatic
  131. fun getAttachmentFolder(spreedCapabilities: SpreedCapability): String {
  132. if (spreedCapabilities.config?.containsKey("attachments") == true) {
  133. val map = spreedCapabilities.config!!["attachments"]
  134. if (map?.containsKey("folder") == true) {
  135. return map["folder"].toString()
  136. }
  137. }
  138. return "/Talk"
  139. }
  140. fun isConversationDescriptionEndpointAvailable(spreedCapabilities: SpreedCapability): Boolean {
  141. return hasSpreedFeatureCapability(spreedCapabilities, SpreedFeatures.ROOM_DESCRIPTION)
  142. }
  143. fun isUnifiedSearchAvailable(spreedCapabilities: SpreedCapability): Boolean {
  144. if (!hasSpreedFeatureCapability(spreedCapabilities, SpreedFeatures.FEDERATION_V1)) {
  145. return false
  146. }
  147. return hasSpreedFeatureCapability(spreedCapabilities, SpreedFeatures.UNIFIED_SEARCH)
  148. }
  149. fun isAbleToCall(spreedCapabilities: SpreedCapability): Boolean {
  150. return if (
  151. spreedCapabilities.config?.containsKey("call") == true &&
  152. spreedCapabilities.config!!["call"] != null &&
  153. spreedCapabilities.config!!["call"]!!.containsKey("enabled")
  154. ) {
  155. java.lang.Boolean.parseBoolean(spreedCapabilities.config!!["call"]!!["enabled"].toString())
  156. } else {
  157. // older nextcloud versions without the capability can't disable the calls
  158. true
  159. }
  160. }
  161. fun isCallReactionsSupported(user: User?): Boolean {
  162. if (user?.capabilities != null) {
  163. val capabilities = user.capabilities
  164. return capabilities?.spreedCapability?.config?.containsKey("call") == true &&
  165. capabilities.spreedCapability!!.config!!["call"] != null &&
  166. capabilities.spreedCapability!!.config!!["call"]!!.containsKey("supported-reactions")
  167. }
  168. return false
  169. }
  170. fun isTranslationsSupported(spreedCapabilities: SpreedCapability): Boolean {
  171. return spreedCapabilities.config?.containsKey("chat") == true &&
  172. spreedCapabilities.config!!["chat"] != null &&
  173. spreedCapabilities.config!!["chat"]!!.containsKey("has-translation-providers") &&
  174. spreedCapabilities.config!!["chat"]!!["has-translation-providers"] == true
  175. }
  176. fun getRecordingConsentType(spreedCapabilities: SpreedCapability): Int {
  177. if (
  178. spreedCapabilities.config?.containsKey("call") == true &&
  179. spreedCapabilities.config!!["call"] != null &&
  180. spreedCapabilities.config!!["call"]!!.containsKey("recording-consent")
  181. ) {
  182. return when (
  183. spreedCapabilities.config!!["call"]!!["recording-consent"].toString()
  184. .toInt()
  185. ) {
  186. 1 -> RECORDING_CONSENT_REQUIRED
  187. 2 -> RECORDING_CONSENT_DEPEND_ON_CONVERSATION
  188. else -> RECORDING_CONSENT_NOT_REQUIRED
  189. }
  190. }
  191. return RECORDING_CONSENT_NOT_REQUIRED
  192. }
  193. fun isBanningAvailable(spreedCapabilities: SpreedCapability): Boolean {
  194. return hasSpreedFeatureCapability(spreedCapabilities, SpreedFeatures.BAN_V1)
  195. }
  196. // endregion
  197. //region SpreedCapabilities that can't be used with federation as the settings for them are global
  198. fun isReadStatusPrivate(user: User): Boolean {
  199. if (user.capabilities?.spreedCapability?.config?.containsKey("chat") == true) {
  200. val map = user.capabilities!!.spreedCapability!!.config!!["chat"]
  201. if (map?.containsKey("read-privacy") == true) {
  202. return (map["read-privacy"]!!.toString()).toInt() == 1
  203. }
  204. }
  205. return false
  206. }
  207. fun isTypingStatusAvailable(user: User): Boolean {
  208. if (user.capabilities?.spreedCapability?.config?.containsKey("chat") == true) {
  209. val map = user.capabilities!!.spreedCapability!!.config!!["chat"]
  210. return map != null && map.containsKey("typing-privacy")
  211. }
  212. return false
  213. }
  214. fun isTypingStatusPrivate(user: User): Boolean {
  215. if (user.capabilities?.spreedCapability?.config?.containsKey("chat") == true) {
  216. val map = user.capabilities!!.spreedCapability!!.config!!["chat"]
  217. if (map?.containsKey("typing-privacy") == true) {
  218. return (map["typing-privacy"]!!.toString()).toInt() == 1
  219. }
  220. }
  221. return false
  222. }
  223. fun isFederationAvailable(user: User): Boolean {
  224. return hasSpreedFeatureCapability(user.capabilities!!.spreedCapability!!, SpreedFeatures.FEDERATION_V1) &&
  225. user.capabilities!!.spreedCapability!!.config?.containsKey("federation") == true &&
  226. user.capabilities!!.spreedCapability!!.config!!["federation"] != null &&
  227. user.capabilities!!.spreedCapability!!.config!!["federation"]!!.containsKey("enabled")
  228. }
  229. // endregion
  230. //region ThemingCapabilities
  231. fun getServerName(user: User?): String? {
  232. if (user?.capabilities?.themingCapability != null) {
  233. return user.capabilities!!.themingCapability!!.name
  234. }
  235. return ""
  236. }
  237. // endregion
  238. //region ProvisioningCapabilities
  239. fun canEditScopes(user: User): Boolean {
  240. return user.capabilities?.provisioningCapability?.accountPropertyScopesVersion != null &&
  241. user.capabilities!!.provisioningCapability!!.accountPropertyScopesVersion!! > 1
  242. }
  243. // endregion
  244. //region UserStatusCapabilities
  245. @JvmStatic
  246. fun isUserStatusAvailable(user: User): Boolean {
  247. return user.capabilities?.userStatusCapability?.enabled == true &&
  248. user.capabilities?.userStatusCapability?.supportsEmoji == true
  249. }
  250. // endregion
  251. private val TAG = CapabilitiesUtil::class.java.simpleName
  252. const val DEFAULT_CHAT_SIZE = 1000
  253. const val RECORDING_CONSENT_NOT_REQUIRED = 0
  254. const val RECORDING_CONSENT_REQUIRED = 1
  255. const val RECORDING_CONSENT_DEPEND_ON_CONVERSATION = 2
  256. private const val SERVER_VERSION_MIN_SUPPORTED = 17
  257. private const val SERVER_VERSION_SUPPORT_WARNING = 26
  258. }