Studying lack of upload when a file that was not previously down is set as favourite...
[pub/Android/ownCloud.git] / src / com / owncloud / android / files / services / FileUploader.java
index 42033be..c8916ef 100644 (file)
@@ -1,22 +1,39 @@
+/* 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/>.
+ *
+ */
+
 package com.owncloud.android.files.services;
 
 import java.io.File;
 import java.util.AbstractList;
-import java.util.Collections;
-import java.util.HashMap;
 import java.util.Iterator;
-import java.util.Map;
 import java.util.Vector;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ConcurrentMap;
 
+import org.apache.http.HttpStatus;
+import org.apache.jackrabbit.webdav.MultiStatus;
+import org.apache.jackrabbit.webdav.client.methods.PropFindMethod;
+
 import com.owncloud.android.authenticator.AccountAuthenticator;
 import com.owncloud.android.datamodel.FileDataStorageManager;
 import com.owncloud.android.datamodel.OCFile;
 import com.owncloud.android.files.InstantUploadBroadcastReceiver;
-import com.owncloud.android.files.services.FileDownloader.FileDownloaderBinder;
 import com.owncloud.android.operations.ChunkedUploadFileOperation;
-import com.owncloud.android.operations.DownloadFileOperation;
 import com.owncloud.android.operations.RemoteOperationResult;
 import com.owncloud.android.operations.UploadFileOperation;
 import com.owncloud.android.ui.activity.FileDetailActivity;
@@ -24,6 +41,8 @@ import com.owncloud.android.ui.fragment.FileDetailFragment;
 import com.owncloud.android.utils.OwnCloudVersion;
 
 import eu.alefzero.webdav.OnDatatransferProgressListener;
+import eu.alefzero.webdav.WebdavEntry;
+import eu.alefzero.webdav.WebdavUtils;
 
 import com.owncloud.android.network.OwnCloudClientUtils;
 
@@ -42,6 +61,7 @@ import android.os.Looper;
 import android.os.Message;
 import android.os.Process;
 import android.util.Log;
+import android.webkit.MimeTypeMap;
 import android.widget.RemoteViews;
 
 import com.owncloud.android.R;
@@ -73,12 +93,9 @@ public class FileUploader extends Service implements OnDatatransferProgressListe
     private ServiceHandler mServiceHandler;
     private IBinder mBinder;
     private WebdavClient mUploadClient = null;
-    private Account mLastAccount = null, mLastAccountWhereInstantFolderWasCreated = null;
+    private Account mLastAccount = null;
     private FileDataStorageManager mStorageManager;
 
-    //private AbstractList<Account> mAccounts = new Vector<Account>();
-    //private AbstractList<UploadFileOperation> mUploads = new Vector<UploadFileOperation>();
-    //private int mCurrentIndexUpload;
     private ConcurrentMap<String, UploadFileOperation> mPendingUploads = new ConcurrentHashMap<String, UploadFileOperation>();
     private UploadFileOperation mCurrentUpload = null;
     
@@ -86,9 +103,6 @@ public class FileUploader extends Service implements OnDatatransferProgressListe
     private Notification mNotification;
     private int mLastPercent;
     private RemoteViews mDefaultNotificationContentView;
-    /*private long mTotalDataToSend, mSendData;
-    private int mTotalFilesToSend, mPreviousPercent;
-    private int mSuccessCounter;*/
     
     
     /**
@@ -188,13 +202,23 @@ public class FileUploader extends Service implements OnDatatransferProgressListe
         AbstractList<String> requestedUploads = new Vector<String>();
         String uploadKey = null;
         UploadFileOperation newUpload = null;
+        OCFile file = null;
+        FileDataStorageManager storageManager = new FileDataStorageManager(account, getContentResolver());
+        boolean fixed = false;
+        if (isInstant) {
+            fixed = checkAndFixInstantUploadDirectory(storageManager);
+        }
         try {
             for (int i=0; i < localPaths.length; i++) {
                 uploadKey = buildRemoteName(account, remotePaths[i]);
+                file = obtainNewOCFileToUpload(remotePaths[i], localPaths[i], ((mimeTypes!=null)?mimeTypes[i]:(String)null), isInstant, forceOverwrite, storageManager);
                 if (chunked) {
-                    newUpload = new ChunkedUploadFileOperation(account, localPaths[i], remotePaths[i], ((mimeTypes!=null)?mimeTypes[i]:(String)null), isInstant, forceOverwrite);
+                    newUpload = new ChunkedUploadFileOperation(account, file, isInstant, forceOverwrite);
                 } else {
-                    newUpload = new UploadFileOperation(account, localPaths[i], remotePaths[i], (mimeTypes!=null?mimeTypes[i]:(String)null), isInstant, forceOverwrite);
+                    newUpload = new UploadFileOperation(account, file, isInstant, forceOverwrite);
+                }
+                if (fixed && i==0) {
+                    newUpload.setRemoteFolderToBeCreated();
                 }
                 mPendingUploads.putIfAbsent(uploadKey, newUpload);
                 newUpload.addDatatransferProgressListener(this);
@@ -204,6 +228,15 @@ public class FileUploader extends Service implements OnDatatransferProgressListe
         } catch (IllegalArgumentException e) {
             Log.e(TAG, "Not enough information provided in intent: " + e.getMessage());
             return START_NOT_STICKY;
+            
+        } catch (IllegalStateException e) {
+            Log.e(TAG, "Bad information provided in intent: " + e.getMessage());
+            return START_NOT_STICKY;
+            
+        } catch (Exception e) {
+            Log.e(TAG, "Unexpected exception while processing upload intent", e);
+            return START_NOT_STICKY;
+            
         }
         
         if (requestedUploads.size() > 0) {
@@ -246,7 +279,7 @@ public class FileUploader extends Service implements OnDatatransferProgressListe
                 upload = mPendingUploads.remove(buildRemoteName(account, file));
             }
             if (upload != null) {
-                // TODO upload.cancel();
+                upload.cancel();
             }
         }
         
@@ -312,16 +345,6 @@ public class FileUploader extends Service implements OnDatatransferProgressListe
         
         if (mCurrentUpload != null) {
             
-            /// prepare upload statistics
-            /*mTotalDataToSend = mSendData = mPreviousPercent = 0;
-            Iterator<UploadFileOperation> it = mUploads.iterator();
-            while (it.hasNext()) {
-                mTotalDataToSend += new File(it.next().getLocalPath()).length();
-            }
-            mTotalFilesToSend = mUploads.size();
-            Log.d(TAG, "Will upload " + mTotalDataToSend + " bytes, with " + mUploads.size() + " files");*/
-
-        
             notifyUploadStart(mCurrentUpload);
 
             
@@ -332,23 +355,18 @@ public class FileUploader extends Service implements OnDatatransferProgressListe
                 mUploadClient = OwnCloudClientUtils.createOwnCloudClient(mLastAccount, getApplicationContext());
             }
             
-            /// create remote folder for instant uploads, "if necessary" (would be great that HEAD to a folder worked as with files, we should check; but it's not WebDAV standard, anyway
-            if (mCurrentUpload.isInstant() && !mLastAccountWhereInstantFolderWasCreated.equals(mCurrentUpload.getAccount())) {
-                mLastAccountWhereInstantFolderWasCreated = mCurrentUpload.getAccount();
-                createRemoteFolderForInstantUploads(mUploadClient, mStorageManager);
+            /// create remote folder for instant uploads
+            if (mCurrentUpload.isRemoteFolderToBeCreated()) {
+                mUploadClient.createDirectory(InstantUploadBroadcastReceiver.INSTANT_UPLOAD_DIR);    // ignoring result; fail could just mean that it already exists, but local database is not synchronized; the upload will be tried anyway
             }
-        
+
+            
             /// perform the upload
             RemoteOperationResult uploadResult = null;
-            long parentDirId = -1;
             try {
-                File remote = new File(mCurrentUpload.getRemotePath());
-                parentDirId = mStorageManager.getFileByPath(remote.getParent().endsWith("/")?remote.getParent():remote.getParent()+"/").getFileId();
-                File local = new File(mCurrentUpload.getLocalPath());
-                long size = local.length();
                 uploadResult = mCurrentUpload.execute(mUploadClient);
                 if (uploadResult.isSuccess()) {
-                    saveNewOCFile(mCurrentUpload, mStorageManager, parentDirId, size);
+                    saveUploadedFile();
                 }
                 
             } finally {
@@ -360,52 +378,139 @@ public class FileUploader extends Service implements OnDatatransferProgressListe
             /// notify result
             notifyUploadResult(uploadResult, mCurrentUpload);
             
-            sendFinalBroadcast(mCurrentUpload, uploadResult, parentDirId);
+            sendFinalBroadcast(mCurrentUpload, uploadResult);
             
         }
         
     }
 
     /**
-     * Create remote folder for instant uploads if necessary.
+     * Saves a OC File after a successful upload.
+     * 
+     * A PROPFIND is necessary to keep the props in the local database synchronized with the server, 
+     * specially the modification time and Etag (where available)
      * 
-     * @param client            WebdavClient to the ownCloud server.
-     * @param storageManager    Interface to the local database caching the data in the server.
-     * @return                  'True' if the folder exists when the methods finishes.
+     * TODO refactor this ugly thing
      */
-    private boolean createRemoteFolderForInstantUploads(WebdavClient client, FileDataStorageManager storageManager) {
-        boolean result = true;
+    private void saveUploadedFile() {
+        OCFile file = mCurrentUpload.getFile();
+        
+        PropFindMethod propfind = null;
+        RemoteOperationResult result = null;
+        try {
+          propfind = new PropFindMethod(mUploadClient.getBaseUri() + WebdavUtils.encodePath(mCurrentUpload.getRemotePath()));
+          int status = mUploadClient.executeMethod(propfind);
+          boolean isMultiStatus = status == HttpStatus.SC_MULTI_STATUS;
+          if (isMultiStatus) {
+              MultiStatus resp = propfind.getResponseBodyAsMultiStatus();
+              WebdavEntry we = new WebdavEntry(resp.getResponses()[0],
+                                               mUploadClient.getBaseUri().getPath());
+              OCFile newFile = fillOCFile(we);
+              newFile.setStoragePath(file.getStoragePath());
+              newFile.setKeepInSync(file.keepInSync());
+              file = newFile;
+              
+          } else {
+              // this would be a problem
+              mUploadClient.exhaustResponse(propfind.getResponseBodyAsStream());
+          }
+          
+          result = new RemoteOperationResult(isMultiStatus, status);
+          Log.i(TAG, "Update: synchronizing properties for uploaded " + mCurrentUpload.getRemotePath() + ": " + result.getLogMessage());
+          
+        } catch (Exception e) {
+            result = new RemoteOperationResult(e);
+            Log.i(TAG, "Update: synchronizing properties for uploaded " + mCurrentUpload.getRemotePath() + ": " + result.getLogMessage(), e);
+
+        } finally {
+            if (propfind != null)
+                propfind.releaseConnection();
+        }
+
+        if (!result.isSuccess()) {
+            // file was successfully uploaded, but the new time stamp and Etag in the server could not be read; 
+            // just keeping old values :(
+            if (!mCurrentUpload.getRemotePath().equals(file.getRemotePath())) {
+                // true when the file was automatically renamed to avoid an overwrite 
+                OCFile newFile = new OCFile(mCurrentUpload.getRemotePath());
+                newFile.setCreationTimestamp(file.getCreationTimestamp());
+                newFile.setFileLength(file.getFileLength());
+                newFile.setMimetype(file.getMimetype());
+                newFile.setModificationTimestamp(file.getModificationTimestamp());  // this is specially BAD
+                // newFile.setEtag(file.getEtag()) // TODO and this is still worse 
+                file = newFile;
+            }
+        }
+        
+        file.setLastSyncDate(System.currentTimeMillis());
+        mStorageManager.saveFile(file);
+    }
+
+    
+    private OCFile fillOCFile(WebdavEntry we) {
+        OCFile file = new OCFile(we.decodedPath());
+        file.setCreationTimestamp(we.createTimestamp());
+        file.setFileLength(we.contentLength());
+        file.setMimetype(we.contentType());
+        file.setModificationTimestamp(we.modifiedTimesamp());
+        // file.setEtag(mCurrentDownload.getEtag());    // TODO Etag, where available
+        return file;
+    }
+    
+    
+    private boolean checkAndFixInstantUploadDirectory(FileDataStorageManager storageManager) {
         OCFile instantUploadDir = storageManager.getFileByPath(InstantUploadBroadcastReceiver.INSTANT_UPLOAD_DIR);
         if (instantUploadDir == null) {
-            result = client.createDirectory(InstantUploadBroadcastReceiver.INSTANT_UPLOAD_DIR);    // fail could just mean that it already exists, but local database is not synchronized; the upload will be started anyway
+            // first instant upload in the account, or never account not synchronized after the remote InstantUpload folder was created
             OCFile newDir = new OCFile(InstantUploadBroadcastReceiver.INSTANT_UPLOAD_DIR);
             newDir.setMimetype("DIR");
             newDir.setParentId(storageManager.getFileByPath(OCFile.PATH_SEPARATOR).getFileId());
             storageManager.saveFile(newDir);
+            return true;
         }
-        return result;
+        return false;
     }
 
-    /**
-     * Saves a new OC File after a successful upload.
-     * 
-     * @param upload            Upload operation completed.
-     * @param storageManager    Interface to the database where the new OCFile has to be stored.
-     * @param parentDirId       Id of the parent OCFile.
-     * @param size              Size of the file.
-     */
-    private void saveNewOCFile(UploadFileOperation upload, FileDataStorageManager storageManager, long parentDirId, long size) {
-        OCFile newFile = new OCFile(upload.getRemotePath());
-        newFile.setMimetype(upload.getMimeType());
-        newFile.setFileLength(size);
-        newFile.setModificationTimestamp(System.currentTimeMillis());
+    
+    private OCFile obtainNewOCFileToUpload(String remotePath, String localPath, String mimeType, boolean isInstant, boolean forceOverwrite, FileDataStorageManager storageManager) {
+        OCFile newFile = new OCFile(remotePath);
+        newFile.setStoragePath(localPath);
         newFile.setLastSyncDate(0);
-        newFile.setStoragePath(upload.getLocalPath());         
+        newFile.setKeepInSync(forceOverwrite);
+        
+        // size
+        if (localPath != null && localPath.length() > 0) {
+            File localFile = new File(localPath);
+            newFile.setFileLength(localFile.length());
+        }   // don't worry about not assigning size, the problems with localPath are checked when the UploadFileOperation instance is created
+        
+        // MIME type
+        if (mimeType == null || mimeType.length() <= 0) {
+            try {
+                mimeType = MimeTypeMap.getSingleton()
+                    .getMimeTypeFromExtension(
+                            remotePath.substring(remotePath.lastIndexOf('.') + 1));
+            } catch (IndexOutOfBoundsException e) {
+                Log.e(TAG, "Trying to find out MIME type of a file without extension: " + remotePath);
+            }
+        }
+        if (mimeType == null) {
+            mimeType = "application/octet-stream";
+        }
+        newFile.setMimetype(mimeType);
+        
+        // parent dir
+        String parentPath = new File(remotePath).getParent();
+        parentPath = parentPath.endsWith("/")?parentPath:parentPath+"/" ;
+        OCFile parentDir = storageManager.getFileByPath(parentPath);
+        if (parentDir == null) {
+            throw new IllegalStateException("Can not upload a file to a non existing remote location: " + parentPath);
+        }
+        long parentDirId = parentDir.getFileId();
         newFile.setParentId(parentDirId);
-        if (upload.getForceOverwrite())
-            newFile.setKeepInSync(true);
-        storageManager.saveFile(newFile);
+        return newFile;
     }
+    
 
     /**
      * Creates a status notification to show the upload progress
@@ -420,17 +525,15 @@ public class FileUploader extends Service implements OnDatatransferProgressListe
         mDefaultNotificationContentView = mNotification.contentView;
         mNotification.contentView = new RemoteViews(getApplicationContext().getPackageName(), R.layout.progressbar_layout);
         mNotification.contentView.setProgressBar(R.id.status_progress, 100, 0, false);
-        mNotification.contentView.setTextViewText(R.id.status_text, String.format(getString(R.string.uploader_upload_in_progress_content), 0, new File(upload.getLocalPath()).getName()));
+        mNotification.contentView.setTextViewText(R.id.status_text, String.format(getString(R.string.uploader_upload_in_progress_content), 0, new File(upload.getStoragePath()).getName()));
         mNotification.contentView.setImageViewResource(R.id.status_icon, R.drawable.icon);
         
         /// includes a pending intent in the notification showing the details view of the file
-        /* TODO
         Intent showDetailsIntent = new Intent(this, FileDetailActivity.class);
         showDetailsIntent.putExtra(FileDetailFragment.EXTRA_FILE, upload.getFile());
         showDetailsIntent.putExtra(FileDetailFragment.EXTRA_ACCOUNT, upload.getAccount());
         showDetailsIntent.setFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
-        mNotification.contentIntent = PendingIntent.getActivity(getApplicationContext(), 0, showDetailsIntent, PendingIntent.FLAG_UPDATE_CURRENT);
-        */
+        mNotification.contentIntent = PendingIntent.getActivity(getApplicationContext(), (int)System.currentTimeMillis(), showDetailsIntent, 0);
         
         mNotificationManager.notify(R.string.uploader_upload_in_progress_ticker, mNotification);
     }
@@ -479,17 +582,15 @@ public class FileUploader extends Service implements OnDatatransferProgressListe
             mNotification.contentView = mDefaultNotificationContentView;
             
             /// includes a pending intent in the notification showing the details view of the file
-            /*
             Intent showDetailsIntent = new Intent(this, FileDetailActivity.class);
             showDetailsIntent.putExtra(FileDetailFragment.EXTRA_FILE, upload.getFile());
             showDetailsIntent.putExtra(FileDetailFragment.EXTRA_ACCOUNT, upload.getAccount());
             showDetailsIntent.setFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
-            mNotification.contentIntent = PendingIntent.getActivity(getApplicationContext(), 0, showDetailsIntent, PendingIntent.FLAG_UPDATE_CURRENT);
-            */
+            mNotification.contentIntent = PendingIntent.getActivity(getApplicationContext(), (int)System.currentTimeMillis(), showDetailsIntent, 0);
             
             mNotification.setLatestEventInfo(   getApplicationContext(), 
                                                 getString(R.string.uploader_upload_succeeded_ticker), 
-                                                String.format(getString(R.string.uploader_upload_succeeded_content_single), (new File(upload.getLocalPath())).getName()), 
+                                                String.format(getString(R.string.uploader_upload_succeeded_content_single), (new File(upload.getStoragePath())).getName()), 
                                                 mNotification.contentIntent);
             
             mNotificationManager.notify(R.string.uploader_upload_in_progress_ticker, mNotification);    // NOT AN ERROR; uploader_upload_in_progress_ticker is the target, not a new notification
@@ -507,10 +608,10 @@ public class FileUploader extends Service implements OnDatatransferProgressListe
             Notification finalNotification = new Notification(R.drawable.icon, getString(R.string.uploader_upload_failed_ticker), System.currentTimeMillis());
             finalNotification.flags |= Notification.FLAG_AUTO_CANCEL;
             // TODO put something smart in the contentIntent below
-            finalNotification.contentIntent = PendingIntent.getActivity(getApplicationContext(), 0, new Intent(), PendingIntent.FLAG_UPDATE_CURRENT);
+            finalNotification.contentIntent = PendingIntent.getActivity(getApplicationContext(), (int)System.currentTimeMillis(), new Intent(), 0);
             finalNotification.setLatestEventInfo(   getApplicationContext(), 
                                                     getString(R.string.uploader_upload_failed_ticker), 
-                                                    String.format(getString(R.string.uploader_upload_failed_content_single), (new File(upload.getLocalPath())).getName()), 
+                                                    String.format(getString(R.string.uploader_upload_failed_content_single), (new File(upload.getStoragePath())).getName()), 
                                                     finalNotification.contentIntent);
             
             mNotificationManager.notify(R.string.uploader_upload_failed_ticker, finalNotification);
@@ -532,13 +633,13 @@ public class FileUploader extends Service implements OnDatatransferProgressListe
      * @param upload          Finished upload operation
      * @param uploadResult    Result of the upload operation
      */
-    private void sendFinalBroadcast(UploadFileOperation upload, RemoteOperationResult uploadResult, long parentDirId) {
+    private void sendFinalBroadcast(UploadFileOperation upload, RemoteOperationResult uploadResult) {
         Intent end = new Intent(UPLOAD_FINISH_MESSAGE);
-        end.putExtra(EXTRA_REMOTE_PATH, upload.getRemotePath());
-        end.putExtra(EXTRA_FILE_PATH, upload.getLocalPath());
+        end.putExtra(EXTRA_REMOTE_PATH, upload.getRemotePath());    // real remote path, after possible automatic renaming
+        end.putExtra(EXTRA_FILE_PATH, upload.getStoragePath());
         end.putExtra(ACCOUNT_NAME, upload.getAccount().name);
         end.putExtra(EXTRA_UPLOAD_RESULT, uploadResult.isSuccess());
-        end.putExtra(EXTRA_PARENT_DIR_ID, parentDirId);
+        end.putExtra(EXTRA_PARENT_DIR_ID, upload.getFile().getParentId());
         sendBroadcast(end);
     }