Updated library reference

[pub/Android/ownCloud.git] / src / com / owncloud / android / files / services / FileObserverService.java

diff --git a/src/com/owncloud/android/files/services/FileObserverService.java b/src/com/owncloud/android/files/services/FileObserverService.java
index effa520..1bcd8d6 100644 (file)
--- a/src/com/owncloud/android/files/services/FileObserverService.java
+++ b/src/com/owncloud/android/files/services/FileObserverService.java
@@ -1,10 +1,10 @@
 /* ownCloud Android client application
  *   Copyright (C) 2012 Bartek Przybylski
 /* ownCloud Android client application
  *   Copyright (C) 2012 Bartek Przybylski

+ *   Copyright (C) 2012-2013 ownCloud Inc.

  *
  *   This program is free software: you can redistribute it and/or modify
  *
  *   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.
+ *   it under the terms of the GNU General Public License version 2,
+ *   as published by the Free Software Foundation.

  *
  *   This program is distributed in the hope that it will be useful,
  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  *
  *   This program is distributed in the hope that it will be useful,
  *   but WITHOUT ANY WARRANTY; without even the implied warranty of


@@ -19,16 +19,18 @@
 package com.owncloud.android.files.services;
 
 import java.io.File;
 package com.owncloud.android.files.services;
 
 import java.io.File;

-import java.util.ArrayList;
-import java.util.List;
+import java.util.HashMap;
+import java.util.Map;

 
 

+import com.owncloud.android.MainApp;

 import com.owncloud.android.datamodel.FileDataStorageManager;
 import com.owncloud.android.datamodel.OCFile;
 import com.owncloud.android.db.ProviderMeta.ProviderTableMeta;
 import com.owncloud.android.files.OwnCloudFileObserver;
 import com.owncloud.android.datamodel.FileDataStorageManager;
 import com.owncloud.android.datamodel.OCFile;
 import com.owncloud.android.db.ProviderMeta.ProviderTableMeta;
 import com.owncloud.android.files.OwnCloudFileObserver;

-import com.owncloud.android.files.OwnCloudFileObserver.FileObserverStatusListener;
-import com.owncloud.android.ui.activity.ConflictsResolveActivity;
+import com.owncloud.android.operations.SynchronizeFileOperation;

 import com.owncloud.android.utils.FileStorageUtils;
 import com.owncloud.android.utils.FileStorageUtils;

+import com.owncloud.android.utils.Log_OC;
+

 
 import android.accounts.Account;
 import android.accounts.AccountManager;
 
 import android.accounts.Account;
 import android.accounts.AccountManager;


@@ -40,25 +42,23 @@ import android.content.IntentFilter;
 import android.database.Cursor;
 import android.os.Binder;
 import android.os.IBinder;
 import android.database.Cursor;
 import android.os.Binder;
 import android.os.IBinder;

-import android.util.Log;
-
-public class FileObserverService extends Service implements FileObserverStatusListener {

 
 

-    public final static String KEY_FILE_CMD = "KEY_FILE_CMD";
-    public final static String KEY_CMD_ARG_FILE = "KEY_CMD_ARG_FILE";
-    public final static String KEY_CMD_ARG_ACCOUNT = "KEY_CMD_ARG_ACCOUNT";
+public class FileObserverService extends Service {

 
     public final static int CMD_INIT_OBSERVED_LIST = 1;
     public final static int CMD_ADD_OBSERVED_FILE = 2;
     public final static int CMD_DEL_OBSERVED_FILE = 3;
 
     public final static int CMD_INIT_OBSERVED_LIST = 1;
     public final static int CMD_ADD_OBSERVED_FILE = 2;
     public final static int CMD_DEL_OBSERVED_FILE = 3;

-    public final static int CMD_ADD_DOWNLOADING_FILE = 4;
+
+    public final static String KEY_FILE_CMD = "KEY_FILE_CMD";
+    public final static String KEY_CMD_ARG_FILE = "KEY_CMD_ARG_FILE";
+    public final static String KEY_CMD_ARG_ACCOUNT = "KEY_CMD_ARG_ACCOUNT";

 
     private static String TAG = FileObserverService.class.getSimpleName();
 
     private static String TAG = FileObserverService.class.getSimpleName();

-    private static List<OwnCloudFileObserver> mObservers;
-    private static List<DownloadCompletedReceiver> mDownloadReceivers;
-    private static Object mReceiverListLock = new Object();
-    private IBinder mBinder = new LocalBinder();

 
 

+    private static Map<String, OwnCloudFileObserver> mObserversMap;
+    private static DownloadCompletedReceiverBis mDownloadReceiver;
+    private IBinder mBinder = new LocalBinder();
+    

     public class LocalBinder extends Binder {
         FileObserverService getService() {
             return FileObserverService.this;
     public class LocalBinder extends Binder {
         FileObserverService getService() {
             return FileObserverService.this;


@@ -66,6 +66,30 @@ public class FileObserverService extends Service implements FileObserverStatusLi
     }
     
     @Override
     }
     
     @Override

+    public void onCreate() {
+        super.onCreate();
+        mDownloadReceiver = new DownloadCompletedReceiverBis();
+        
+        IntentFilter filter = new IntentFilter();
+        filter.addAction(FileDownloader.getDownloadAddedMessage());
+        filter.addAction(FileDownloader.getDownloadFinishMessage());        
+        registerReceiver(mDownloadReceiver, filter);
+        
+        mObserversMap = new HashMap<String, OwnCloudFileObserver>();
+        //initializeObservedList();
+    }
+    
+    
+    @Override
+    public void onDestroy() {
+        unregisterReceiver(mDownloadReceiver);
+        mObserversMap = null;   // TODO study carefully the life cycle of Services to grant the best possible observance
+        Log_OC.d(TAG, "Bye, bye");
+        super.onDestroy();
+    }
+    
+    
+    @Override

     public IBinder onBind(Intent intent) {
         return mBinder;
     }
     public IBinder onBind(Intent intent) {
         return mBinder;
     }


@@ -80,7 +104,7 @@ public class FileObserverService extends Service implements FileObserverStatusLi
         }
             
         if (!intent.hasExtra(KEY_FILE_CMD)) {
         }
             
         if (!intent.hasExtra(KEY_FILE_CMD)) {

-            Log.e(TAG, "No KEY_FILE_CMD argument given");
+            Log_OC.e(TAG, "No KEY_FILE_CMD argument given");

             return Service.START_STICKY;
         }
 
             return Service.START_STICKY;
         }
 


@@ -96,30 +120,29 @@ public class FileObserverService extends Service implements FileObserverStatusLi
                 removeObservedFile( (OCFile)intent.getParcelableExtra(KEY_CMD_ARG_FILE), 
                                     (Account)intent.getParcelableExtra(KEY_CMD_ARG_ACCOUNT));
                 break;
                 removeObservedFile( (OCFile)intent.getParcelableExtra(KEY_CMD_ARG_FILE), 
                                     (Account)intent.getParcelableExtra(KEY_CMD_ARG_ACCOUNT));
                 break;

-            case CMD_ADD_DOWNLOADING_FILE:
-                addDownloadingFile( (OCFile)intent.getParcelableExtra(KEY_CMD_ARG_FILE),
-                                    (Account)intent.getParcelableExtra(KEY_CMD_ARG_ACCOUNT));
-                break;

             default:
             default:

-                Log.wtf(TAG, "Incorrect key given");
+                Log_OC.wtf(TAG, "Incorrect key given");

         }
 
         return Service.START_STICKY;
     }
 
         }
 
         return Service.START_STICKY;
     }
 

+    
+    /**
+     * Read from the local database the list of files that must to be kept synchronized and 
+     * starts file observers to monitor local changes on them
+     */

     private void initializeObservedList() {
     private void initializeObservedList() {

-        if (mObservers != null) return; // nothing to do here
-        mObservers = new ArrayList<OwnCloudFileObserver>();
-        mDownloadReceivers = new ArrayList<DownloadCompletedReceiver>();
+        mObserversMap.clear();

         Cursor c = getContentResolver().query(
                 ProviderTableMeta.CONTENT_URI,
                 null,
                 ProviderTableMeta.FILE_KEEP_IN_SYNC + " = ?",
                 new String[] {String.valueOf(1)},
                 null);
         Cursor c = getContentResolver().query(
                 ProviderTableMeta.CONTENT_URI,
                 null,
                 ProviderTableMeta.FILE_KEEP_IN_SYNC + " = ?",
                 new String[] {String.valueOf(1)},
                 null);

-        if (!c.moveToFirst()) return;
+        if (c == null || !c.moveToFirst()) return;

         AccountManager acm = AccountManager.get(this);
         AccountManager acm = AccountManager.get(this);

-        Account[] accounts = acm.getAccounts();
+        Account[] accounts = acm.getAccountsByType(MainApp.getAccountType());

         do {
             Account account = null;
             for (Account a : accounts)
         do {
             Account account = null;
             for (Account a : accounts)


@@ -135,94 +158,58 @@ public class FileObserverService extends Service implements FileObserverStatusLi
                 continue;
 
             String path = c.getString(c.getColumnIndex(ProviderTableMeta.FILE_STORAGE_PATH));
                 continue;
 
             String path = c.getString(c.getColumnIndex(ProviderTableMeta.FILE_STORAGE_PATH));

+            if (path == null || path.length() <= 0)
+                continue;

             OwnCloudFileObserver observer =
             OwnCloudFileObserver observer =

-                    new OwnCloudFileObserver(path, OwnCloudFileObserver.CHANGES_ONLY);
-            observer.setContext(getApplicationContext());
-            observer.setAccount(account);
-            observer.setStorageManager(storage);
-            observer.setOCFile(storage.getFileByPath(c.getString(c.getColumnIndex(ProviderTableMeta.FILE_PATH))));
-            observer.addObserverStatusListener(this);
-            observer.startWatching();
-            mObservers.add(observer);
-            Log.d(TAG, "Started watching file " + path);
+                    new OwnCloudFileObserver(   path, 
+                                                account, 
+                                                getApplicationContext());
+            mObserversMap.put(path, observer);
+            if (new File(path).exists()) {
+                observer.startWatching();
+                Log_OC.d(TAG, "Started watching file " + path);
+            }

             
         } while (c.moveToNext());
         c.close();
     }
     
             
         } while (c.moveToNext());
         c.close();
     }
     

+    

     /**
      * Registers the local copy of a remote file to be observed for local changes,
      * an automatically updated in the ownCloud server.
     /**
      * Registers the local copy of a remote file to be observed for local changes,
      * an automatically updated in the ownCloud server.

+     * 
+     * This method does NOT perform a {@link SynchronizeFileOperation} over the file. 

      *
      *

-     * If there is no local copy of the remote file, a request to download it is send
-     * to the FileDownloader service. The observation is delayed until the download
-     * is finished.
+     * TODO We are ignoring that, currently, a local file can be linked to different files
+     * in ownCloud if it's uploaded several times. That's something pending to update: we 
+     * will avoid that the same local file is linked to different remote files.

      * 
      * @param file      Object representing a remote file which local copy must be observed.
      * @param account   OwnCloud account containing file.
      */
     private void addObservedFile(OCFile file, Account account) {
         if (file == null) {
      * 
      * @param file      Object representing a remote file which local copy must be observed.
      * @param account   OwnCloud account containing file.
      */
     private void addObservedFile(OCFile file, Account account) {
         if (file == null) {

-            Log.e(TAG, "Trying to observe a NULL file");
+            Log_OC.e(TAG, "Trying to add a NULL file to observer");

             return;
         }
             return;
         }

-        if (mObservers == null) {
-            // this is very rare case when service was killed by system
-            // and observers list was deleted in that procedure
-            initializeObservedList();
-        }

         String localPath = file.getStoragePath();
         String localPath = file.getStoragePath();

-        if (!file.isDown()) {
-            // this is a file downloading / to be download for the first time
+        if (localPath == null || localPath.length() <= 0) { // file downloading / to be download for the first time

             localPath = FileStorageUtils.getDefaultSavePathFor(account.name, file);
         }
             localPath = FileStorageUtils.getDefaultSavePathFor(account.name, file);
         }

-        OwnCloudFileObserver tmpObserver = null, observer = null;
-        for (int i = 0; i < mObservers.size(); ++i) {
-            tmpObserver = mObservers.get(i);
-            if (tmpObserver.getPath().equals(localPath)) {
-                observer = tmpObserver;
-            }
-            tmpObserver.setContext(getApplicationContext());   // 'refreshing' context to all the observers? why?
-        }
+        OwnCloudFileObserver observer = mObserversMap.get(localPath);

         if (observer == null) {
             /// the local file was never registered to observe before
         if (observer == null) {
             /// the local file was never registered to observe before

-            observer = new OwnCloudFileObserver(localPath, OwnCloudFileObserver.CHANGES_ONLY);
-            //Account account = AccountUtils.getCurrentOwnCloudAccount(getApplicationContext());
-            observer.setAccount(account);
-            FileDataStorageManager storage =
-                    new FileDataStorageManager(account, getContentResolver());  // I don't trust in this resolver's life span...
-            observer.setStorageManager(storage);
-            //observer.setOCFile(storage.getFileByLocalPath(path));   // ISSUE 10 - the fix in FileDetailsFragment to avoid path == null was not enough; it the file was never down before, this sets a NULL OCFile in the observer
-            observer.setOCFile(file);
-            observer.addObserverStatusListener(this);
-            observer.setContext(getApplicationContext());
-            
-        } else {
-            /* LET'S IGNORE THAT, CURRENTLY, A LOCAL FILE CAN BE LINKED TO DIFFERENT FILES IN OWNCLOUD;
-             * we should change that
-             * 
-            /// the local file is already observed for some other OCFile(s)
-            observer.addOCFile(account, file);  // OCFiles should have a reference to the account containing them to not be confused
-            */ 
-        }
-
-        mObservers.add(observer);
-        Log.d(TAG, "Observer added for path " + localPath);
+            observer = new OwnCloudFileObserver(    localPath, 
+                                                    account, 
+                                                    getApplicationContext());
+            mObserversMap.put(localPath, observer);
+            Log_OC.d(TAG, "Observer added for path " + localPath);

         
         

-        if (!file.isDown()) {
-            // if the file is not down, it can't be observed for changes
-            DownloadCompletedReceiver receiver = new DownloadCompletedReceiver(localPath, observer);
-            registerReceiver(receiver, new IntentFilter(FileDownloader.DOWNLOAD_FINISH_MESSAGE));
-
-            Intent i = new Intent(this, FileDownloader.class);
-            i.putExtra(FileDownloader.EXTRA_ACCOUNT, account);
-            i.putExtra(FileDownloader.EXTRA_FILE, file);
-            startService(i);
-            
-        } else {
-            observer.startWatching();
-            Log.d(TAG, "Started watching " + localPath);
-            
+            if (file.isDown()) {
+                observer.startWatching();
+                Log_OC.d(TAG, "Started watching " + localPath);
+            }   // else - the observance can't be started on a file not already down; mDownloadReceiver will get noticed when the download of the file finishes

         }
         
     }
         }
         
     }


@@ -231,128 +218,60 @@ public class FileObserverService extends Service implements FileObserverStatusLi
     /**
      * Unregisters the local copy of a remote file to be observed for local changes.
      *
     /**
      * Unregisters the local copy of a remote file to be observed for local changes.
      *

+     * Starts to watch it, if the file has a local copy to watch.
+     * 
+     * TODO We are ignoring that, currently, a local file can be linked to different files
+     * in ownCloud if it's uploaded several times. That's something pending to update: we 
+     * will avoid that the same local file is linked to different remote files.
+     *

      * @param file      Object representing a remote file which local copy must be not observed longer.
      * @param account   OwnCloud account containing file.
      */
     private void removeObservedFile(OCFile file, Account account) {
         if (file == null) {
      * @param file      Object representing a remote file which local copy must be not observed longer.
      * @param account   OwnCloud account containing file.
      */
     private void removeObservedFile(OCFile file, Account account) {
         if (file == null) {

-            Log.e(TAG, "Trying to unobserve a NULL file");
+            Log_OC.e(TAG, "Trying to remove a NULL file");

             return;
         }
             return;
         }

-        if (mObservers == null) {
-            initializeObservedList();
-        }

         String localPath = file.getStoragePath();
         String localPath = file.getStoragePath();

-        if (!file.isDown()) {
-            // this happens when a file not in the device is set to be kept synchronized, and quickly unset again,
-            // while the download is not finished
+        if (localPath == null || localPath.length() <= 0) {

             localPath = FileStorageUtils.getDefaultSavePathFor(account.name, file);
         }
         
             localPath = FileStorageUtils.getDefaultSavePathFor(account.name, file);
         }
         

-        for (int i = 0; i < mObservers.size(); ++i) {
-            OwnCloudFileObserver observer = mObservers.get(i);
-            if (observer.getPath().equals(localPath)) {
-                observer.stopWatching();
-                mObservers.remove(i);       // assuming, again, that a local file can be only linked to only ONE remote file; currently false
-                if (!file.isDown()) {
-                    // TODO unregister download receiver ;forget this until list of receivers is replaced for a single receiver
-                }
-                Log.d(TAG, "Stopped watching " + localPath);
-                break;
-            }
+        OwnCloudFileObserver observer = mObserversMap.get(localPath);
+        if (observer != null) {
+            observer.stopWatching();
+            mObserversMap.remove(observer);
+            Log_OC.d(TAG, "Stopped watching " + localPath);

         }
         
     }
 
         }
         
     }
 

-    
+

     /**
     /**

-     * Temporarily disables the observance of a file that is going to be download.
-     *
-     * @param file      Object representing the remote file which local copy must not be observed temporarily.
-     * @param account   OwnCloud account containing file.
+     *  Private receiver listening to events broadcast by the FileDownloader service.
+     * 
+     *  Starts and stops the observance on registered files when they are being download,
+     *  in order to avoid to start unnecessary synchronizations. 

      */
      */

-    private void addDownloadingFile(OCFile file, Account account) {
-        OwnCloudFileObserver observer = null;
-        for (OwnCloudFileObserver o : mObservers) {
-            if (o.getRemotePath().equals(file.getRemotePath()) && o.getAccount().equals(account)) {
-                observer = o;
-                break;
-            }
-        }
-        if (observer == null) {
-            Log.e(TAG, "Couldn't find observer for remote file " + file.getRemotePath());
-            return;
-        }
-        observer.stopWatching();
-        DownloadCompletedReceiver dcr = new DownloadCompletedReceiver(observer.getPath(), observer);
-        registerReceiver(dcr, new IntentFilter(FileDownloader.DOWNLOAD_FINISH_MESSAGE));
-    }
-
-    
-    private static void addReceiverToList(DownloadCompletedReceiver r) {
-        synchronized(mReceiverListLock) {
-            mDownloadReceivers.add(r);
-        }
-    }
-    
-    private static void removeReceiverFromList(DownloadCompletedReceiver r) {
-        synchronized(mReceiverListLock) {
-            mDownloadReceivers.remove(r);
-        }
-    }
-
-    @Override
-    public void OnObservedFileStatusUpdate(String localPath, String remotePath, Account account, Status status) {
-        switch (status) {
-            case CONFLICT:
-            {
-                // ISSUE 5: if the user is not running the app (this is a service!), this can be very intrusive; a notification should be preferred
-                Intent i = new Intent(getApplicationContext(), ConflictsResolveActivity.class);
-                i.setFlags(i.getFlags() | Intent.FLAG_ACTIVITY_NEW_TASK);
-                i.putExtra("remotepath", remotePath);
-                i.putExtra("localpath", localPath);
-                i.putExtra("account", account);
-                startActivity(i);
-                break;
-            }
-            case SENDING_TO_UPLOADER:
-            case INCORRECT_MASK:
-                break;
-            default:
-                Log.wtf(TAG, "Unhandled status " + status);
-        }
-    }
-
-    private class DownloadCompletedReceiver extends BroadcastReceiver {
-        String mPath;
-        OwnCloudFileObserver mObserver;
-        
-        public DownloadCompletedReceiver(String path, OwnCloudFileObserver observer) {
-            mPath = path;
-            mObserver = observer;
-            addReceiverToList(this);
-        }
+    private class DownloadCompletedReceiverBis extends BroadcastReceiver {

         
         @Override
         public void onReceive(Context context, Intent intent) {
         
         @Override
         public void onReceive(Context context, Intent intent) {

-            if (mPath.equals(intent.getStringExtra(FileDownloader.EXTRA_FILE_PATH))) {
-                if ((new File(mPath)).exists()) {   
-                    // the download could be successful, or not; in both cases, the file could be down, due to a former download or upload
-                    context.unregisterReceiver(this);
-                    removeReceiverFromList(this);
-                    mObserver.startWatching();
-                    Log.d(TAG, "Started watching " + mPath);
-                    return;
-                }   // else - keep waiting for a future retry of the download ; 
-                    // mObserver.startWatching() won't ever work if the file is not in the device when it's called 
+            String downloadPath = intent.getStringExtra(FileDownloader.EXTRA_FILE_PATH);
+            OwnCloudFileObserver observer = mObserversMap.get(downloadPath);
+            if (observer != null) {
+                if (intent.getAction().equals(FileDownloader.getDownloadFinishMessage()) &&
+                        new File(downloadPath).exists()) {  // the download could be successful. not; in both cases, the file could be down, due to a former download or upload   
+                    observer.startWatching();
+                    Log_OC.d(TAG, "Watching again " + downloadPath);
+                
+                } else if (intent.getAction().equals(FileDownloader.getDownloadAddedMessage())) {
+                    observer.stopWatching();
+                    Log_OC.d(TAG, "Disabling observance of " + downloadPath);
+                } 

             }
         }
         
             }
         }
         

-        @Override
-        public boolean equals(Object o) {
-            if (o instanceof DownloadCompletedReceiver)
-                return mPath.equals(((DownloadCompletedReceiver)o).mPath);
-            return super.equals(o);
-        }

     }
     }

+    

 }
 }