Merge pull request #15570 from ovitrif/issue/13292-copy-published-post-url

antonis · web-flow · commit bf3b212dc439 · 2021-11-24T13:30:10.000+02:00
Posts List: Add Copy link functionality for posts
diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt
@@ -2,6 +2,7 @@
 
 18.8
 -----
+* [**] Posts List: Adds copy post link functionality [https://github.com/wordpress-mobile/WordPress-Android/pull/15570]
 * [*] Editor: Replace snackbar with compact notice when switching between HTML or Visual mode [https://github.com/wordpress-mobile/WordPress-Android/pull/15583]
 * [*] Fixed an issue where multiple screens were rendered incorrectly in RTL interface languages [https://github.com/wordpress-mobile/WordPress-Android/pull/15597]
 
diff --git a/WordPress/src/main/java/org/wordpress/android/ui/posts/PostActionHandler.kt b/WordPress/src/main/java/org/wordpress/android/ui/posts/PostActionHandler.kt
@@ -1,6 +1,7 @@
 package org.wordpress.android.ui.posts
 
 import android.content.Intent
+import com.google.android.material.snackbar.Snackbar
 import org.wordpress.android.R
 import org.wordpress.android.fluxc.Dispatcher
 import org.wordpress.android.fluxc.generated.PostActionBuilder
@@ -29,12 +30,12 @@ import org.wordpress.android.ui.posts.RemotePreviewLogicHelper.RemotePreviewType
 import org.wordpress.android.ui.uploads.UploadService
 import org.wordpress.android.ui.uploads.UploadUtils
 import org.wordpress.android.ui.utils.UiString.UiStringRes
-import org.wordpress.android.util.ToastUtils
 import org.wordpress.android.util.ToastUtils.Duration
 import org.wordpress.android.viewmodel.helpers.ToastMessageHolder
 import org.wordpress.android.widgets.PostListButtonType
 import org.wordpress.android.widgets.PostListButtonType.BUTTON_CANCEL_PENDING_AUTO_UPLOAD
 import org.wordpress.android.widgets.PostListButtonType.BUTTON_COPY
+import org.wordpress.android.widgets.PostListButtonType.BUTTON_COPY_URL
 import org.wordpress.android.widgets.PostListButtonType.BUTTON_DELETE
 import org.wordpress.android.widgets.PostListButtonType.BUTTON_DELETE_PERMANENTLY
 import org.wordpress.android.widgets.PostListButtonType.BUTTON_EDIT
@@ -98,7 +99,7 @@ class PostActionHandler(
                             showToast = showToast,
                             messageMediaUploading = ToastMessageHolder(
                                     R.string.editor_toast_uploading_please_wait,
-                                    ToastUtils.Duration.SHORT
+                                    Duration.SHORT
                             )
                     )
             )
@@ -115,6 +116,7 @@ class PostActionHandler(
                 }
             }
             BUTTON_COPY -> copyPost(site, post, true)
+            BUTTON_COPY_URL -> triggerPostListAction.invoke(copyUrlAction(post))
             BUTTON_DELETE, BUTTON_DELETE_PERMANENTLY -> {
                 postListDialogHelper.showDeletePostConfirmationDialog(post)
             }
@@ -129,6 +131,22 @@ class PostActionHandler(
         }
     }
 
+    private fun copyUrlAction(post: PostModel) = PostListAction.CopyUrl(
+            site = site,
+            post = post,
+            showSnackbar = showSnackbar,
+            messageSuccess = SnackbarMessageHolder(
+                    UiStringRes(R.string.post_link_copied_to_clipboard),
+                    duration = Snackbar.LENGTH_SHORT,
+                    isImportant = false
+            ),
+            messageError = SnackbarMessageHolder(
+                    UiStringRes(R.string.error_copy_to_clipboard),
+                    duration = Snackbar.LENGTH_SHORT,
+                    isImportant = false
+            )
+    )
+
     private fun cancelPendingAutoUpload(post: PostModel) {
         val msgRes = UploadUtils.cancelPendingAutoUpload(post, dispatcher)
         showSnackbar.invoke(SnackbarMessageHolder(UiStringRes(msgRes)))
diff --git a/WordPress/src/main/java/org/wordpress/android/ui/posts/PostListAction.kt b/WordPress/src/main/java/org/wordpress/android/ui/posts/PostListAction.kt
@@ -1,16 +1,20 @@
 package org.wordpress.android.ui.posts
 
+import android.content.ClipData
 import androidx.fragment.app.FragmentActivity
 import org.wordpress.android.fluxc.model.PostModel
 import org.wordpress.android.fluxc.model.SiteModel
 import org.wordpress.android.push.NativeNotificationsUtils
 import org.wordpress.android.ui.ActivityLauncher
 import org.wordpress.android.ui.PagePostCreationSourcesDetail.POST_FROM_POSTS_LIST
+import org.wordpress.android.ui.pages.SnackbarMessageHolder
 import org.wordpress.android.ui.photopicker.MediaPickerLauncher
 import org.wordpress.android.ui.posts.RemotePreviewLogicHelper.RemotePreviewType
 import org.wordpress.android.ui.prefs.AppPrefs
 import org.wordpress.android.ui.stories.intro.StoriesIntroDialogFragment
 import org.wordpress.android.ui.uploads.UploadService
+import org.wordpress.android.util.AppLog
+import org.wordpress.android.util.clipboardManager
 import org.wordpress.android.viewmodel.helpers.ToastMessageHolder
 
 sealed class PostListAction {
@@ -33,6 +37,13 @@ sealed class PostListAction {
         val post: PostModel,
         val trackAnalytics: Boolean = PostUtils.isFirstTimePublish(post)
     ) : PostListAction()
+    class CopyUrl(
+        val site: SiteModel,
+        val post: PostModel,
+        val showSnackbar: (SnackbarMessageHolder) -> Unit,
+        val messageSuccess: SnackbarMessageHolder,
+        val messageError: SnackbarMessageHolder
+    ) : PostListAction()
 
     class ViewStats(val site: SiteModel, val post: PostModel) : PostListAction()
     class ViewPost(val site: SiteModel, val post: PostModel) : PostListAction()
@@ -91,5 +102,21 @@ fun handlePostListAction(
         is PostListAction.DismissPendingNotification -> {
             NativeNotificationsUtils.dismissNotification(action.pushId, activity)
         }
+        is PostListAction.CopyUrl -> {
+            try {
+                activity.clipboardManager?.setPrimaryClip(
+                        ClipData.newPlainText("${action.post.id}", action.post.link)
+                ) ?: throw NullPointerException("ClipboardManager is not supported on this device")
+
+                action.showSnackbar.invoke(action.messageSuccess)
+            } catch (e: Exception) {
+                /**
+                 * Ignore any exceptions here as certain devices have bugs and will fail.
+                 * See https://crrev.com/542cb9cfcc927295615809b0c99917b09a219d9f for more info.
+                 */
+                AppLog.e(AppLog.T.POSTS, e)
+                action.showSnackbar.invoke(action.messageError)
+            }
+        }
     }
 }
diff --git a/WordPress/src/main/java/org/wordpress/android/ui/posts/PostListActionTracker.kt b/WordPress/src/main/java/org/wordpress/android/ui/posts/PostListActionTracker.kt
@@ -7,6 +7,7 @@ import org.wordpress.android.util.analytics.AnalyticsUtils
 import org.wordpress.android.widgets.PostListButtonType
 import org.wordpress.android.widgets.PostListButtonType.BUTTON_CANCEL_PENDING_AUTO_UPLOAD
 import org.wordpress.android.widgets.PostListButtonType.BUTTON_COPY
+import org.wordpress.android.widgets.PostListButtonType.BUTTON_COPY_URL
 import org.wordpress.android.widgets.PostListButtonType.BUTTON_DELETE
 import org.wordpress.android.widgets.PostListButtonType.BUTTON_DELETE_PERMANENTLY
 import org.wordpress.android.widgets.PostListButtonType.BUTTON_EDIT
@@ -49,6 +50,7 @@ fun trackPostListAction(site: SiteModel, buttonType: PostListButtonType, postDat
         BUTTON_MOVE_TO_DRAFT -> "move_to_draft"
         BUTTON_CANCEL_PENDING_AUTO_UPLOAD -> "cancel_pending_auto_upload"
         BUTTON_SHOW_MOVE_TRASHED_POST_TO_DRAFT_DIALOG -> "show_move_trashed_post_to_draft_post_dialog"
+        BUTTON_COPY_URL -> "copy_url"
     }
 
     AnalyticsUtils.trackWithSiteDetails(statsEvent, site, properties)
diff --git a/WordPress/src/main/java/org/wordpress/android/util/ContextExtensions.kt b/WordPress/src/main/java/org/wordpress/android/util/ContextExtensions.kt
@@ -1,5 +1,6 @@
 package org.wordpress.android.util
 
+import android.content.ClipboardManager
 import android.content.Context
 import android.content.res.ColorStateList
 import android.util.TypedValue
@@ -41,3 +42,10 @@ fun Context.getColorStateListFromAttribute(@AttrRes attribute: Int): ColorStateL
 // https://developer.android.com/reference/android/content/res/Configuration.html#locale
 val Context.currentLocale: Locale
     get() = ConfigurationCompat.getLocales(resources.configuration)[0]
+
+/**
+ * Gets the clipboard manager system service
+ * @see android.content.ClipboardManager
+ */
+val Context.clipboardManager: ClipboardManager?
+    get() = ContextCompat.getSystemService(this, ClipboardManager::class.java)
diff --git a/WordPress/src/main/java/org/wordpress/android/viewmodel/posts/PostListItemUiStateHelper.kt b/WordPress/src/main/java/org/wordpress/android/viewmodel/posts/PostListItemUiStateHelper.kt
@@ -46,6 +46,7 @@ import org.wordpress.android.viewmodel.uistate.ProgressBarUiState
 import org.wordpress.android.widgets.PostListButtonType
 import org.wordpress.android.widgets.PostListButtonType.BUTTON_CANCEL_PENDING_AUTO_UPLOAD
 import org.wordpress.android.widgets.PostListButtonType.BUTTON_COPY
+import org.wordpress.android.widgets.PostListButtonType.BUTTON_COPY_URL
 import org.wordpress.android.widgets.PostListButtonType.BUTTON_DELETE
 import org.wordpress.android.widgets.PostListButtonType.BUTTON_DELETE_PERMANENTLY
 import org.wordpress.android.widgets.PostListButtonType.BUTTON_EDIT
@@ -121,7 +122,7 @@ class PostListItemUiStateHelper @Inject constructor(
                 hasAutoSave = hasAutoSave
         )
         val statusesColor = labelColorUseCase.getLabelsColor(post, uploadUiState, unhandledConflicts, hasAutoSave)
-        val statusesDelimeter = UiStringRes(R.string.multiple_status_label_delimiter)
+        val statusesDelimiter = UiStringRes(R.string.multiple_status_label_delimiter)
         val onSelected = {
             when (postStatus) {
                 TRASHED -> {
@@ -147,7 +148,7 @@ class PostListItemUiStateHelper @Inject constructor(
                 postInfo = postInfo,
                 statuses = statuses,
                 statusesColor = statusesColor,
-                statusesDelimiter = statusesDelimeter,
+                statusesDelimiter = statusesDelimiter,
                 progressBarUiState = getProgressBarState(
                         uploadUiState = uploadUiState,
                         performingCriticalAction = performingCriticalAction
@@ -156,7 +157,7 @@ class PostListItemUiStateHelper @Inject constructor(
                         uploadUiState = uploadUiState,
                         performingCriticalAction = performingCriticalAction
                 ),
-                disableRippleEffect = postStatus == PostStatus.TRASHED
+                disableRippleEffect = postStatus == TRASHED
         )
 
         return PostListItemUiState(
@@ -368,9 +369,9 @@ class PostListItemUiStateHelper @Inject constructor(
         siteHasCapabilitiesToPublish: Boolean,
         statsSupported: Boolean
     ): List<PostListButtonType> {
-        val canRetryUpload = uploadUiState is PostUploadUiState.UploadFailed
+        val canRetryUpload = uploadUiState is UploadFailed
         val canCancelPendingAutoUpload = (uploadUiState is UploadWaitingForConnection ||
-                (uploadUiState is PostUploadUiState.UploadFailed && uploadUiState.isEligibleForAutoUpload))
+                (uploadUiState is UploadFailed && uploadUiState.isEligibleForAutoUpload))
         val canPublishPost = (canRetryUpload || uploadUiState is NothingToUpload || !canCancelPendingAutoUpload) &&
                 (isLocallyChanged || isLocalDraft || postStatus == DRAFT ||
                         (siteHasCapabilitiesToPublish && postStatus == PENDING))
@@ -380,7 +381,8 @@ class PostListItemUiStateHelper @Inject constructor(
                 !isLocalDraft &&
                 !isLocallyChanged
         val canShowCopy = postStatus == PUBLISHED || postStatus == DRAFT
-        val canShowViewButton = !canRetryUpload && postStatus != PostStatus.TRASHED
+        val canShowCopyUrlButton = !isLocalDraft && postStatus != TRASHED
+        val canShowViewButton = !canRetryUpload && postStatus != TRASHED
         val canShowPublishButton = canRetryUpload || canPublishPost
         val buttonTypes = ArrayList<PostListButtonType>()
 
@@ -394,26 +396,17 @@ class PostListItemUiStateHelper @Inject constructor(
 
         if (canShowPublishButton) {
             buttonTypes.add(
-                    if (canRetryUpload) {
-                        BUTTON_RETRY
-                    } else if (!siteHasCapabilitiesToPublish) {
-                        BUTTON_SUBMIT
-                    } else if (postStatus == SCHEDULED && isLocallyChanged) {
-                        BUTTON_SYNC
-                    } else {
-                        BUTTON_PUBLISH
+                    when {
+                        canRetryUpload -> BUTTON_RETRY
+                        !siteHasCapabilitiesToPublish -> BUTTON_SUBMIT
+                        postStatus == SCHEDULED && isLocallyChanged -> BUTTON_SYNC
+                        else -> BUTTON_PUBLISH
                     }
             )
         }
 
         if (canShowViewButton) {
-            buttonTypes.add(
-                    if (isLocalDraft || isLocallyChanged) {
-                        BUTTON_PREVIEW
-                    } else {
-                        BUTTON_VIEW
-                    }
-            )
+            buttonTypes.addViewOrPreviewAction(isLocalDraft || isLocallyChanged)
         }
 
         if (canShowStats) {
@@ -426,17 +419,30 @@ class PostListItemUiStateHelper @Inject constructor(
 
         buttonTypes.addMoveToDraftActionIfAvailable(postStatus)
 
-        when {
-            isLocalDraft -> buttonTypes.add(BUTTON_DELETE)
-            postStatus == TRASHED -> {
-                buttonTypes.add(BUTTON_DELETE_PERMANENTLY)
-            }
-            postStatus != TRASHED -> buttonTypes.add(BUTTON_TRASH)
+        if (canShowCopyUrlButton) {
+            buttonTypes.add(BUTTON_COPY_URL)
         }
 
+        buttonTypes.addDeletingOrTrashAction(isLocalDraft, postStatus)
+
         return buttonTypes
     }
 
+    private fun MutableList<PostListButtonType>.addViewOrPreviewAction(shouldShowPreview: Boolean) {
+        add(if (shouldShowPreview) BUTTON_PREVIEW else BUTTON_VIEW)
+    }
+
+    private fun MutableList<PostListButtonType>.addDeletingOrTrashAction(
+        isLocalDraft: Boolean,
+        postStatus: PostStatus
+    ) {
+        when {
+            isLocalDraft -> add(BUTTON_DELETE)
+            postStatus == TRASHED -> add(BUTTON_DELETE_PERMANENTLY)
+            postStatus != TRASHED -> add(BUTTON_TRASH)
+        }
+    }
+
     private fun MutableList<PostListButtonType>.addMoveToDraftActionIfAvailable(postStatus: PostStatus) {
         val canMovePostToDraft = postStatus == PUBLISHED || postStatus == TRASHED
 
diff --git a/WordPress/src/main/java/org/wordpress/android/widgets/PostListButtonType.kt b/WordPress/src/main/java/org/wordpress/android/widgets/PostListButtonType.kt
@@ -37,7 +37,8 @@ enum class PostListButtonType constructor(
             R.attr.wpColorWarningDark
     ),
     BUTTON_SHOW_MOVE_TRASHED_POST_TO_DRAFT_DIALOG(15, 0, 0, 0),
-    BUTTON_COPY(16, R.string.button_copy, R.drawable.ic_copy_white_24dp, R.attr.colorOnSurface);
+    BUTTON_COPY(16, R.string.button_copy, R.drawable.ic_copy_white_24dp, R.attr.colorOnSurface),
+    BUTTON_COPY_URL(17, R.string.button_copy_link, R.drawable.ic_gridicons_link_white_24dp, R.attr.colorOnSurface);
 
     companion object {
         fun fromInt(value: Int): PostListButtonType? = values().firstOrNull { it.value == value }
diff --git a/WordPress/src/main/res/drawable/ic_gridicons_link_white_24dp.xml b/WordPress/src/main/res/drawable/ic_gridicons_link_white_24dp.xml
@@ -0,0 +1,9 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="24dp"
+    android:height="24dp"
+    android:viewportHeight="24"
+    android:viewportWidth="24">
+    <path
+        android:fillColor="@android:color/white"
+        android:pathData="M17.001,12.999H7.001V10.999H17.001V12.999ZM18.001,6.999H17.001C15.37,6.999 13.936,7.791 13.024,8.999H18.001C19.104,8.999 20.001,9.896 20.001,10.999V12.999C20.001,14.102 19.104,14.999 18.001,14.999H13.024C13.937,16.207 15.371,16.999 17.001,16.999H18.001C19.0618,16.999 20.0793,16.5776 20.8294,15.8275C21.5795,15.0773 22.001,14.0599 22.001,12.999V10.999C22.001,9.9382 21.5795,8.9207 20.8294,8.1706C20.0793,7.4205 19.0618,6.999 18.001,6.999ZM2.001,10.999V12.999C2.001,14.0599 2.4224,15.0773 3.1725,15.8275C3.9227,16.5776 4.9401,16.999 6.001,16.999H7.001C8.631,16.999 10.066,16.207 10.978,14.999H6.001C4.898,14.999 4.001,14.102 4.001,12.999V10.999C4.001,9.896 4.898,8.999 6.001,8.999H10.978C10.066,7.791 8.632,6.999 7.001,6.999H6.001C4.9401,6.999 3.9227,7.4205 3.1725,8.1706C2.4224,8.9207 2.001,9.9382 2.001,10.999V10.999Z" />
+</vector>
diff --git a/WordPress/src/main/res/values/strings.xml b/WordPress/src/main/res/values/strings.xml
@@ -309,6 +309,7 @@
     <string name="button_retry">Retry</string>
     <string name="button_move_to_draft">Move to Draft</string>
     <string name="button_copy">Duplicate</string>
+    <string name="button_copy_link">Copy link</string>
 
     <!-- post uploads -->
     <string name="upload_failed_param">Upload failed for \"%s\"</string>
@@ -504,6 +505,7 @@
     <string name="remove_account">Remove site</string>
 
     <!-- post actions -->
+    <string name="post_link_copied_to_clipboard">Link copied to clipboard</string>
     <string name="post_trashed">Post sent to trash</string>
     <string name="post_trashing">Post is being trashed</string>
     <string name="post_restored">Post restored</string>
diff --git a/WordPress/src/test/java/org/wordpress/android/viewmodel/posts/PostListItemUiStateHelperTest.kt b/WordPress/src/test/java/org/wordpress/android/viewmodel/posts/PostListItemUiStateHelperTest.kt
diff --git a/config/detekt/baseline.xml b/config/detekt/baseline.xml
