From f68d10abc7d74dd93a2368e56b14285578704199 Mon Sep 17 00:00:00 2001
From: "David A. Velasco" <dvelasco@solidgear.es>
Date: Tue, 4 Dec 2012 12:49:18 +0100
Subject: [PATCH] Give the user the option to move all the foreign files into
 the ownCloud local folder when the try to copy them during an account
 synchronization failed

---
 AndroidManifest.xml                                |   3 +-
 res/layout-v14/generic_explanation.xml             |  68 ++++++
 res/layout/generic_explanation.xml                 |  23 ++
 res/values/strings.xml                             |  12 +-
 .../android/syncadapter/FileSyncAdapter.java       |  17 +-
 .../ErrorsWhileCopyingHandlerActivity.java         | 258 +++++++++++++++++++++
 .../ui/activity/GenericExplanationActivity.java    |   2 +-
 .../ui/dialog/IndeterminateProgressDialog.java     |  74 ++++++
 8 files changed, 441 insertions(+), 16 deletions(-)
 create mode 100644 res/layout-v14/generic_explanation.xml
 create mode 100644 src/com/owncloud/android/ui/activity/ErrorsWhileCopyingHandlerActivity.java
 create mode 100644 src/com/owncloud/android/ui/dialog/IndeterminateProgressDialog.java

diff --git a/AndroidManifest.xml b/AndroidManifest.xml
index b2998b56..4886f9bd 100644
--- a/AndroidManifest.xml
+++ b/AndroidManifest.xml
@@ -132,7 +132,8 @@
         <activity android:name=".extensions.ExtensionsListActivity"></activity>
         <activity android:name=".ui.activity.AccountSelectActivity" android:uiOptions="none" android:label="@string/prefs_accounts"></activity>
         <activity android:name=".ui.activity.ConflictsResolveActivity"/>
-        <activity android:name="com.owncloud.android.ui.activity.GenericExplanationActivity"/>
+        <activity android:name=".ui.activity.GenericExplanationActivity"/>
+        <activity android:name=".ui.activity.ErrorsWhileCopyingHandlerActivity"/>
         
         <service android:name=".files.services.FileUploader" >
         </service>
diff --git a/res/layout-v14/generic_explanation.xml b/res/layout-v14/generic_explanation.xml
new file mode 100644
index 00000000..641ed1f0
--- /dev/null
+++ b/res/layout-v14/generic_explanation.xml
@@ -0,0 +1,68 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- 
+  ownCloud Android client application
+
+  Copyright (C) 2012  Bartek Przybylski
+  This program is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ -->
+<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
+    android:layout_width="match_parent"
+    android:layout_height="match_parent"
+    android:background="@color/owncloud_white" 
+    android:id="@+id/explanation"
+    android:orientation="vertical">
+
+	<TextView
+		android:id="@+id/message"
+		android:layout_width="match_parent"
+		android:layout_height="0dp"
+		android:layout_weight="2"
+	    android:padding="10dip"
+	    android:scrollbarAlwaysDrawVerticalTrack="true"
+		android:text="@string/text_placeholder" 
+		/>
+    
+	<ListView 
+	    android:id="@+id/list"
+	    android:layout_width="match_parent"
+	    android:layout_height="0dp"
+		android:layout_weight="3"
+	    android:padding="10dip"
+	    />
+	    
+    <LinearLayout
+        android:id="@+id/buttons"
+        android:layout_width="match_parent"
+        android:layout_height="wrap_content"
+        android:gravity="center"
+        android:orientation="horizontal" >
+
+        <!-- 'OK' / 'CANCEL' BUTTONS CHANGE THEIR ORDER FROM ANDROID 4.0 ; THANKS, GOOGLE -->
+        <Button
+            android:id="@+id/cancel"
+            android:layout_width="wrap_content"
+            android:layout_height="wrap_content"
+            android:layout_weight="1"
+            android:text="@string/common_cancel" />
+
+		<Button
+		    android:id="@+id/ok"
+		    android:layout_width="wrap_content"
+		    android:layout_height="wrap_content"
+		    android:layout_weight="1"
+		    android:text="@string/common_ok" />
+		
+	</LinearLayout>
+	
+</LinearLayout>
\ No newline at end of file
diff --git a/res/layout/generic_explanation.xml b/res/layout/generic_explanation.xml
index 45305532..fbd055e6 100644
--- a/res/layout/generic_explanation.xml
+++ b/res/layout/generic_explanation.xml
@@ -41,4 +41,27 @@
 	    android:padding="10dip"
 	    />
 	    
+    <LinearLayout
+        android:id="@+id/buttons"
+        android:layout_width="match_parent"
+        android:layout_height="wrap_content"
+        android:gravity="center"
+        android:orientation="horizontal" >
+
+		<Button
+		    android:id="@+id/ok"
+		    android:layout_width="wrap_content"
+		    android:layout_height="wrap_content"
+		    android:layout_weight="1"
+		    android:text="@string/common_ok" />
+		
+        <Button
+            android:id="@+id/cancel"
+            android:layout_width="wrap_content"
+            android:layout_height="wrap_content"
+            android:layout_weight="1"
+            android:text="@string/common_cancel" />
+
+	</LinearLayout>
+	
 </LinearLayout>
\ No newline at end of file
diff --git a/res/values/strings.xml b/res/values/strings.xml
index 270b952a..80bc4629 100644
--- a/res/values/strings.xml
+++ b/res/values/strings.xml
@@ -118,10 +118,14 @@
 	<string name="sync_fail_in_favourites_content">Contents of %1$d files could not be sync\'ed (%2$d conflicts)</string>
 	<string name="sync_foreign_files_forgotten_ticker">Some local files were forgotten</string>
 	<string name="sync_foreign_files_forgotten_content">%1$d files out of the ownCloud directory could not be copied into</string>
-	<string name="sync_foreign_files_forgotten_explanation">"From version 1.3.16, uploaded files are copied to the local ownCloud folder to avoid problems when the same local file is uploaded to different folders or accounts.\n\nSome files uploaded in the past could not be copied during the account synchronization. %1$s will not track their current location anymore. You will need to download them again to access their contents from this app.\n\nSee below the list of untracked local files and the remote files in in %2$s they were linked to.</string>
-    <string name="sync_foreign_files_forgotten_remote_prefix">"Remote: "</string>
-    <string name="sync_foreign_files_forgotten_local_prefix">"Local: "</string>
-	
+	<string name="sync_foreign_files_forgotten_explanation">"As of version 1.3.16, files uploaded from this device are copied into the local %1$s folder to prevent data loss when a single file is synced with multiple accounts.\n\nDue to this change, all files uploaded in previous versions of this app were copied into the %2$s folder. However, an error prevented the completion of this operation during account synchronization. You may either leave the file(s) as is and remove the link to %3$s, or move the file(s) into the %1$s directory and retain the link to %4$s.\n\nListed below are the local file(s), and the the remote file(s) in %5$s they were linked to.</string>
+    
+    <string name="foreign_files_move">"Move all"</string>
+    <string name="foreign_files_success">"All files were moved"</string>
+    <string name="foreign_files_fail">"Some files could not be moved"</string>
+    <string name="foreign_files_local_text">"Local: %1$s"</string>
+	<string name="foreign_files_remote_text">"Remote: %1$s"</string>
+    	
 	<string name="use_ssl">Use Secure Connection</string>
     <string name="location_no_provider">ownCloud cannot track your device. Please check your location settings</string>
     
diff --git a/src/com/owncloud/android/syncadapter/FileSyncAdapter.java b/src/com/owncloud/android/syncadapter/FileSyncAdapter.java
index 2d88646e..e112347a 100644
--- a/src/com/owncloud/android/syncadapter/FileSyncAdapter.java
+++ b/src/com/owncloud/android/syncadapter/FileSyncAdapter.java
@@ -35,7 +35,7 @@ import com.owncloud.android.operations.RemoteOperationResult;
 import com.owncloud.android.operations.SynchronizeFolderOperation;
 import com.owncloud.android.operations.UpdateOCVersionOperation;
 import com.owncloud.android.operations.RemoteOperationResult.ResultCode;
-import com.owncloud.android.ui.activity.GenericExplanationActivity;
+import com.owncloud.android.ui.activity.ErrorsWhileCopyingHandlerActivity;
 import android.accounts.Account;
 import android.app.Notification;
 import android.app.NotificationManager;
@@ -346,17 +346,14 @@ public class FileSyncAdapter extends AbstractOwnCloudSyncAdapter {
         notification.flags |= Notification.FLAG_AUTO_CANCEL;
 
         /// includes a pending intent in the notification showing a more detailed explanation
-        Intent explanationIntent = new Intent(getContext(), GenericExplanationActivity.class);
-        String message = String.format(getContext().getString(R.string.sync_foreign_files_forgotten_explanation), getContext().getString(R.string.app_name), getAccount().name);
-        explanationIntent.putExtra(GenericExplanationActivity.MESSAGE, message);
+        Intent explanationIntent = new Intent(getContext(), ErrorsWhileCopyingHandlerActivity.class);
+        explanationIntent.putExtra(ErrorsWhileCopyingHandlerActivity.EXTRA_ACCOUNT, getAccount());
         ArrayList<String> remotePaths = new ArrayList<String>();
         ArrayList<String> localPaths = new ArrayList<String>();
-        for (String remote : mForgottenLocalFiles.keySet()) {
-           remotePaths.add(getContext().getString(R.string.sync_foreign_files_forgotten_remote_prefix) + remote);
-           localPaths.add(getContext().getString(R.string.sync_foreign_files_forgotten_local_prefix) + mForgottenLocalFiles.get(remote));
-        }
-        explanationIntent.putExtra(GenericExplanationActivity.EXTRA_LIST, localPaths);
-        explanationIntent.putExtra(GenericExplanationActivity.EXTRA_LIST_2, remotePaths);  
+        remotePaths.addAll(mForgottenLocalFiles.keySet());
+        localPaths.addAll(mForgottenLocalFiles.values());
+        explanationIntent.putExtra(ErrorsWhileCopyingHandlerActivity.EXTRA_LOCAL_PATHS, localPaths);
+        explanationIntent.putExtra(ErrorsWhileCopyingHandlerActivity.EXTRA_REMOTE_PATHS, remotePaths);  
         explanationIntent.setFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
         
         notification.contentIntent = PendingIntent.getActivity(getContext().getApplicationContext(), (int)System.currentTimeMillis(), explanationIntent, 0);
diff --git a/src/com/owncloud/android/ui/activity/ErrorsWhileCopyingHandlerActivity.java b/src/com/owncloud/android/ui/activity/ErrorsWhileCopyingHandlerActivity.java
new file mode 100644
index 00000000..01e45749
--- /dev/null
+++ b/src/com/owncloud/android/ui/activity/ErrorsWhileCopyingHandlerActivity.java
@@ -0,0 +1,258 @@
+package com.owncloud.android.ui.activity;
+
+import java.io.File;
+import java.util.ArrayList;
+
+import android.accounts.Account;
+import android.content.Context;
+import android.content.Intent;
+import android.os.AsyncTask;
+import android.os.Bundle;
+import android.os.Handler;
+import android.support.v4.app.DialogFragment;
+import android.text.method.ScrollingMovementMethod;
+import android.util.Log;
+import android.view.LayoutInflater;
+import android.view.View;
+import android.view.View.OnClickListener;
+import android.view.ViewGroup;
+import android.widget.ArrayAdapter;
+import android.widget.Button;
+import android.widget.ListView;
+import android.widget.TextView;
+import android.widget.Toast;
+
+import com.actionbarsherlock.app.SherlockFragmentActivity;
+import com.owncloud.android.R;
+import com.owncloud.android.datamodel.FileDataStorageManager;
+import com.owncloud.android.datamodel.OCFile;
+import com.owncloud.android.ui.dialog.IndeterminateProgressDialog;
+import com.owncloud.android.utils.FileStorageUtils;
+
+
+/**
+ * Activity reporting errors occurred when local files uploaded to an ownCloud account with an app in
+ * version under 1.3.16 where being copied to the ownCloud local folder.
+ * 
+ * Allows the user move the files to the ownCloud local folder, or let them unlinked to the remote
+ * files.
+ * 
+ * Shown when the error notification summarizing the list of errors is clicked by the user.
+ * 
+ * @author David A. Velasco
+ */
+public class ErrorsWhileCopyingHandlerActivity  extends SherlockFragmentActivity implements OnClickListener {
+
+    private static final String TAG = ErrorsWhileCopyingHandlerActivity.class.getSimpleName();
+    
+    public static final String EXTRA_ACCOUNT = ErrorsWhileCopyingHandlerActivity.class.getCanonicalName() + ".EXTRA_ACCOUNT";
+    public static final String EXTRA_LOCAL_PATHS = ErrorsWhileCopyingHandlerActivity.class.getCanonicalName() + ".EXTRA_LOCAL_PATHS";
+    public static final String EXTRA_REMOTE_PATHS = ErrorsWhileCopyingHandlerActivity.class.getCanonicalName() + ".EXTRA_REMOTE_PATHS";
+
+    private static final String WAIT_DIALOG_TAG = "WAIT_DIALOG";
+    
+    protected Account mAccount;
+    protected FileDataStorageManager mStorageManager;
+    protected ArrayList<String> mLocalPaths;
+    protected ArrayList<String> mRemotePaths;
+    protected ArrayAdapter<String> mAdapter;
+    protected Handler mHandler;
+    private DialogFragment mCurrentDialog;
+    
+    /**
+     * {@link}
+     */
+    @Override
+    protected void onCreate(Bundle savedInstanceState) {
+        super.onCreate(savedInstanceState);
+        
+        /// read extra parameters in intent
+        Intent intent = getIntent();
+        mAccount = intent.getParcelableExtra(EXTRA_ACCOUNT);
+        mRemotePaths = intent.getStringArrayListExtra(EXTRA_REMOTE_PATHS);
+        mLocalPaths = intent.getStringArrayListExtra(EXTRA_LOCAL_PATHS);
+        mStorageManager = new FileDataStorageManager(mAccount, getContentResolver());
+        mHandler = new Handler();
+        if (mCurrentDialog != null) {
+            mCurrentDialog.dismiss();
+            mCurrentDialog = null;
+        }
+        
+        /// load generic layout
+        setContentView(R.layout.generic_explanation);
+        
+        /// customize text message
+        TextView textView = (TextView) findViewById(R.id.message);
+        String appName = getString(R.string.app_name);
+        String message = String.format(getString(R.string.sync_foreign_files_forgotten_explanation), appName, appName, appName, appName, mAccount.name);
+        textView.setText(message);
+        textView.setMovementMethod(new ScrollingMovementMethod());
+        
+        /// load the list of local and remote files that failed
+        ListView listView = (ListView) findViewById(R.id.list);
+        if (mLocalPaths != null && mLocalPaths.size() > 0) {
+            mAdapter = new ErrorsWhileCopyingListAdapter();
+            listView.setAdapter(mAdapter);
+        } else {
+            listView.setVisibility(View.GONE);
+            mAdapter = null;
+        }
+        
+        /// customize buttons
+        Button cancelBtn = (Button) findViewById(R.id.cancel);
+        Button okBtn = (Button) findViewById(R.id.ok);
+        okBtn.setText(R.string.foreign_files_move);
+        cancelBtn.setOnClickListener(this);
+        okBtn.setOnClickListener(this);
+    }
+    
+    
+    /**
+     * Customized adapter, showing the local files as main text in two-lines list item and the remote files
+     * as the secondary text. 
+     * 
+     * @author David A. Velasco
+     */
+    public class ErrorsWhileCopyingListAdapter extends ArrayAdapter<String> {
+        
+        ErrorsWhileCopyingListAdapter() {
+            super(ErrorsWhileCopyingHandlerActivity.this, android.R.layout.two_line_list_item, android.R.id.text1, mLocalPaths);
+        }
+
+        @Override
+        public boolean isEnabled(int position) {
+            return false;
+        }
+        
+        /**
+         * {@inheritDoc}
+         */
+        @Override
+        public View getView (int position, View convertView, ViewGroup parent) {
+            View view = convertView;
+            if (view == null) {
+                LayoutInflater vi = (LayoutInflater) getSystemService(Context.LAYOUT_INFLATER_SERVICE);
+                view = vi.inflate(android.R.layout.two_line_list_item, null);
+            }
+            if (view != null)  {
+                String localPath = getItem(position);
+                if (localPath != null) {
+                    TextView text1 = (TextView) view.findViewById(android.R.id.text1);
+                    if (text1 != null) {
+                        text1.setText(String.format(getString(R.string.foreign_files_local_text), localPath));
+                    }
+                }
+                if (mRemotePaths != null && mRemotePaths.size() > 0 && position >= 0 && position < mRemotePaths.size()) {
+                    TextView text2 = (TextView) view.findViewById(android.R.id.text2);
+                    String remotePath = mRemotePaths.get(position);
+                    if (text2 != null && remotePath != null) {
+                        text2.setText(String.format(getString(R.string.foreign_files_remote_text), remotePath));
+                    }
+                }
+            }
+            return view;
+        }
+    }
+
+
+    /**
+     * Listener method to perform the MOVE / CANCEL action available in this activity.
+     * 
+     * @param v     Clicked view (button MOVE or CANCEL)
+     */
+    @Override
+    public void onClick(View v) {
+        if (v.getId() == R.id.ok) {
+            /// perform movement operation in background thread
+            Log.d(TAG, "Clicked MOVE, start movement");
+            new MoveFilesTask().execute();            
+            
+        } else if (v.getId() == R.id.cancel) {
+            /// just finish
+            Log.d(TAG, "Clicked CANCEL, bye");
+            finish();
+            
+        } else {
+            Log.e(TAG, "Clicked phantom button, id: " + v.getId());
+        }
+    }
+
+    
+    /**
+     * Asynchronous task performing the move of all the local files to the ownCloud folder.
+     * 
+     * @author David A. Velasco
+     */
+    private class MoveFilesTask extends AsyncTask<Void, Void, Boolean> {
+
+        /**
+         * Updates the UI before trying the movement
+         */
+        @Override
+        protected void onPreExecute () {
+            /// progress dialog and disable 'Move' button
+            mCurrentDialog = IndeterminateProgressDialog.newInstance(R.string.wait_a_moment, false);
+            mCurrentDialog.show(getSupportFragmentManager(), WAIT_DIALOG_TAG);
+            findViewById(R.id.ok).setEnabled(false);
+        }
+        
+        
+        /**
+         * Performs the movement
+         * 
+         * @return     'False' when the movement of any file fails.
+         */
+        @Override
+        protected Boolean doInBackground(Void... params) {
+            while (!mLocalPaths.isEmpty()) {
+                String currentPath = mLocalPaths.get(0);
+                File currentFile = new File(currentPath);
+                String expectedPath = FileStorageUtils.getSavePath(mAccount.name) + mRemotePaths.get(0);
+                File expectedFile = new File(expectedPath);
+
+                if (expectedFile.equals(currentFile) || currentFile.renameTo(expectedFile)) {
+                    // SUCCESS
+                    OCFile file = mStorageManager.getFileByPath(mRemotePaths.get(0));
+                    file.setStoragePath(expectedPath);
+                    mStorageManager.saveFile(file);
+                    mRemotePaths.remove(0);
+                    mLocalPaths.remove(0);
+                        
+                } else {
+                    // FAIL
+                    return false;   
+                }
+            }
+            return true;
+        }
+
+        /**
+         * Updates the activity UI after the movement of local files is tried.
+         * 
+         * If the movement was successful for all the files, finishes the activity immediately.
+         * 
+         * In other case, the list of remaining files is still available to retry the movement.
+         * 
+         * @result      'True' when the movement was successful.
+         */
+        @Override
+        protected void onPostExecute(Boolean result) {
+            mAdapter.notifyDataSetChanged();
+            mCurrentDialog.dismiss();
+            mCurrentDialog = null;
+            findViewById(R.id.ok).setEnabled(true);
+            
+            if (result) {
+                // nothing else to do in this activity
+                Toast t = Toast.makeText(ErrorsWhileCopyingHandlerActivity.this, getString(R.string.foreign_files_success), Toast.LENGTH_LONG);
+                t.show();
+                finish();
+                
+            } else {
+                Toast t = Toast.makeText(ErrorsWhileCopyingHandlerActivity.this, getString(R.string.foreign_files_fail), Toast.LENGTH_LONG);
+                t.show();
+            }
+        }
+    }    
+
+}
diff --git a/src/com/owncloud/android/ui/activity/GenericExplanationActivity.java b/src/com/owncloud/android/ui/activity/GenericExplanationActivity.java
index ccf3de86..a45383f3 100644
--- a/src/com/owncloud/android/ui/activity/GenericExplanationActivity.java
+++ b/src/com/owncloud/android/ui/activity/GenericExplanationActivity.java
@@ -17,7 +17,7 @@ import com.actionbarsherlock.app.SherlockFragmentActivity;
 import com.owncloud.android.R;
 
 /**
- * Activity showing a text message and, optionally, a couple of scrollable lists of texts.
+ * Activity showing a text message and, optionally, a couple list of single or paired text strings.
  * 
  * Added to show explanations for notifications when the user clicks on them, and there no place
  * better to show them.
diff --git a/src/com/owncloud/android/ui/dialog/IndeterminateProgressDialog.java b/src/com/owncloud/android/ui/dialog/IndeterminateProgressDialog.java
new file mode 100644
index 00000000..4f9305b0
--- /dev/null
+++ b/src/com/owncloud/android/ui/dialog/IndeterminateProgressDialog.java
@@ -0,0 +1,74 @@
+package com.owncloud.android.ui.dialog;
+
+import android.app.Dialog;
+import android.app.ProgressDialog;
+import android.content.DialogInterface;
+import android.content.DialogInterface.OnKeyListener;
+import android.os.Bundle;
+import android.view.KeyEvent;
+
+import com.actionbarsherlock.app.SherlockDialogFragment;
+import com.owncloud.android.R;
+
+public class IndeterminateProgressDialog extends SherlockDialogFragment {
+
+    private static final String ARG_MESSAGE_ID = IndeterminateProgressDialog.class.getCanonicalName() + ".ARG_MESSAGE_ID";
+    private static final String ARG_CANCELABLE = IndeterminateProgressDialog.class.getCanonicalName() + ".ARG_CANCELABLE";
+
+
+    /**
+     * Public factory method to get dialog instances.
+     * 
+     * @param messageId     Resource id for a message to show in the dialog.
+     * @param cancelable    If 'true', the dialog can be cancelled by the user input (BACK button, touch outside...)
+     * @return              New dialog instance, ready to show.
+     */
+    public static IndeterminateProgressDialog newInstance(int messageId, boolean cancelable) {
+        IndeterminateProgressDialog fragment = new IndeterminateProgressDialog();
+        Bundle args = new Bundle();
+        args.putInt(ARG_MESSAGE_ID, messageId);
+        args.putBoolean(ARG_CANCELABLE, cancelable);
+        fragment.setArguments(args);
+        return fragment;
+    }
+
+    
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public Dialog onCreateDialog(Bundle savedInstanceState) {
+        /// create indeterminate progress dialog
+        final ProgressDialog dialog = new ProgressDialog(getActivity());
+        dialog.setIndeterminate(true);
+        
+        /// set message
+        int messageId = getArguments().getInt(ARG_MESSAGE_ID, R.string.text_placeholder);
+        dialog.setMessage(getString(messageId));
+        
+        /// set cancellation behavior
+        boolean cancelable = getArguments().getBoolean(ARG_CANCELABLE, false);
+        if (!cancelable) {
+            dialog.setCancelable(false);
+            // disable the back button
+            OnKeyListener keyListener = new OnKeyListener() {
+                @Override
+                public boolean onKey(DialogInterface dialog, int keyCode,
+                        KeyEvent event) {
+
+                    if( keyCode == KeyEvent.KEYCODE_BACK){                  
+                        return true;
+                    }
+                    return false;
+                }
+
+            };
+            dialog.setOnKeyListener(keyListener);
+        }
+        
+        return dialog;
+    }    
+    
+}
+
+
-- 
2.11.0