1 /* ownCloud Android client application
2 * Copyright (C) 2012-2014 ownCloud Inc.
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2,
6 * as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 package com
.owncloud
.android
.services
;
20 import java
.io
.IOException
;
21 import java
.util
.Iterator
;
22 import java
.util
.concurrent
.ConcurrentHashMap
;
23 import java
.util
.concurrent
.ConcurrentLinkedQueue
;
24 import java
.util
.concurrent
.ConcurrentMap
;
26 import com
.owncloud
.android
.MainApp
;
27 import com
.owncloud
.android
.R
;
28 import com
.owncloud
.android
.datamodel
.FileDataStorageManager
;
29 import com
.owncloud
.android
.datamodel
.OCFile
;
30 import com
.owncloud
.android
.files
.services
.FileDownloader
;
31 import com
.owncloud
.android
.lib
.common
.OwnCloudAccount
;
32 import com
.owncloud
.android
.lib
.common
.OwnCloudClient
;
33 import com
.owncloud
.android
.lib
.common
.OwnCloudClientManagerFactory
;
34 import com
.owncloud
.android
.lib
.common
.OwnCloudCredentials
;
35 import com
.owncloud
.android
.lib
.common
.OwnCloudCredentialsFactory
;
36 import com
.owncloud
.android
.lib
.common
.accounts
.AccountUtils
.AccountNotFoundException
;
37 import com
.owncloud
.android
.lib
.common
.operations
.OnRemoteOperationListener
;
38 import com
.owncloud
.android
.lib
.common
.operations
.RemoteOperation
;
39 import com
.owncloud
.android
.lib
.common
.operations
.RemoteOperationResult
;
40 import com
.owncloud
.android
.lib
.common
.utils
.Log_OC
;
41 import com
.owncloud
.android
.lib
.resources
.files
.ExistenceCheckRemoteOperation
;
42 import com
.owncloud
.android
.lib
.resources
.shares
.ShareType
;
43 import com
.owncloud
.android
.lib
.resources
.users
.GetRemoteUserNameOperation
;
44 import com
.owncloud
.android
.operations
.common
.SyncOperation
;
45 import com
.owncloud
.android
.operations
.CreateFolderOperation
;
46 import com
.owncloud
.android
.operations
.CreateShareOperation
;
47 import com
.owncloud
.android
.operations
.GetServerInfoOperation
;
48 import com
.owncloud
.android
.operations
.MoveFileOperation
;
49 import com
.owncloud
.android
.operations
.OAuth2GetAccessToken
;
50 import com
.owncloud
.android
.operations
.RemoveFileOperation
;
51 import com
.owncloud
.android
.operations
.RenameFileOperation
;
52 import com
.owncloud
.android
.operations
.SynchronizeFileOperation
;
53 import com
.owncloud
.android
.operations
.SynchronizeFolderOperation
;
54 import com
.owncloud
.android
.operations
.UnshareLinkOperation
;
55 import com
.owncloud
.android
.utils
.FileStorageUtils
;
57 import android
.accounts
.Account
;
58 import android
.accounts
.AccountsException
;
59 import android
.accounts
.AuthenticatorException
;
60 import android
.accounts
.OperationCanceledException
;
61 import android
.app
.Service
;
62 import android
.content
.Intent
;
63 import android
.net
.Uri
;
64 import android
.os
.Binder
;
65 import android
.os
.Handler
;
66 import android
.os
.HandlerThread
;
67 import android
.os
.IBinder
;
68 import android
.os
.Looper
;
69 import android
.os
.Message
;
70 import android
.os
.Process
;
71 import android
.util
.Pair
;
73 public class OperationsService
extends Service
{
75 private static final String TAG
= OperationsService
.class.getSimpleName();
77 public static final String EXTRA_ACCOUNT
= "ACCOUNT";
78 public static final String EXTRA_SERVER_URL
= "SERVER_URL";
79 public static final String EXTRA_OAUTH2_QUERY_PARAMETERS
= "OAUTH2_QUERY_PARAMETERS";
80 public static final String EXTRA_REMOTE_PATH
= "REMOTE_PATH";
81 public static final String EXTRA_SEND_INTENT
= "SEND_INTENT";
82 public static final String EXTRA_NEWNAME
= "NEWNAME";
83 public static final String EXTRA_REMOVE_ONLY_LOCAL
= "REMOVE_LOCAL_COPY";
84 public static final String EXTRA_CREATE_FULL_PATH
= "CREATE_FULL_PATH";
85 public static final String EXTRA_SYNC_FILE_CONTENTS
= "SYNC_FILE_CONTENTS";
86 public static final String EXTRA_RESULT
= "RESULT";
87 public static final String EXTRA_NEW_PARENT_PATH
= "NEW_PARENT_PATH";
88 public static final String EXTRA_FILE
= "FILE";
90 // TODO review if ALL OF THEM are necessary
91 public static final String EXTRA_SUCCESS_IF_ABSENT
= "SUCCESS_IF_ABSENT";
92 public static final String EXTRA_USERNAME
= "USERNAME";
93 public static final String EXTRA_PASSWORD
= "PASSWORD";
94 public static final String EXTRA_AUTH_TOKEN
= "AUTH_TOKEN";
95 public static final String EXTRA_COOKIE
= "COOKIE";
97 public static final String ACTION_CREATE_SHARE
= "CREATE_SHARE";
98 public static final String ACTION_UNSHARE
= "UNSHARE";
99 public static final String ACTION_GET_SERVER_INFO
= "GET_SERVER_INFO";
100 public static final String ACTION_OAUTH2_GET_ACCESS_TOKEN
= "OAUTH2_GET_ACCESS_TOKEN";
101 public static final String ACTION_EXISTENCE_CHECK
= "EXISTENCE_CHECK";
102 public static final String ACTION_GET_USER_NAME
= "GET_USER_NAME";
103 public static final String ACTION_RENAME
= "RENAME";
104 public static final String ACTION_REMOVE
= "REMOVE";
105 public static final String ACTION_CREATE_FOLDER
= "CREATE_FOLDER";
106 public static final String ACTION_SYNC_FILE
= "SYNC_FILE";
107 public static final String ACTION_SYNC_FOLDER
= "SYNC_FOLDER"; // for the moment, just to download
108 public static final String ACTION_CANCEL_SYNC_FOLDER
= "CANCEL_SYNC_FOLDER"; // for the moment, just to download
109 public static final String ACTION_MOVE_FILE
= "MOVE_FILE";
111 public static final String ACTION_OPERATION_ADDED
= OperationsService
.class.getName() + ".OPERATION_ADDED";
112 public static final String ACTION_OPERATION_FINISHED
= OperationsService
.class.getName() + ".OPERATION_FINISHED";
115 private ConcurrentMap
<Integer
, Pair
<RemoteOperation
, RemoteOperationResult
>>
116 mUndispatchedFinishedOperations
=
117 new ConcurrentHashMap
<Integer
, Pair
<RemoteOperation
, RemoteOperationResult
>>();
119 private static class Target
{
120 public Uri mServerUrl
= null
;
121 public Account mAccount
= null
;
122 public String mUsername
= null
;
123 public String mPassword
= null
;
124 public String mAuthToken
= null
;
125 public String mCookie
= null
;
127 public Target(Account account
, Uri serverUrl
, String username
, String password
, String authToken
,
130 mServerUrl
= serverUrl
;
131 mUsername
= username
;
132 mPassword
= password
;
133 mAuthToken
= authToken
;
138 private ServiceHandler mOperationsHandler
;
139 private OperationsServiceBinder mOperationsBinder
;
141 private SyncFolderHandler mSyncFolderHandler
;
144 * Service initialization
147 public void onCreate() {
149 /// First worker thread for most of operations
150 HandlerThread thread
= new HandlerThread("Operations thread", Process
.THREAD_PRIORITY_BACKGROUND
);
152 mOperationsHandler
= new ServiceHandler(thread
.getLooper(), this);
153 mOperationsBinder
= new OperationsServiceBinder(mOperationsHandler
);
155 /// Separated worker thread for download of folders (WIP)
156 thread
= new HandlerThread("Syncfolder thread", Process
.THREAD_PRIORITY_BACKGROUND
);
158 mSyncFolderHandler
= new SyncFolderHandler(thread
.getLooper(), this);
163 * Entry point to add a new operation to the queue of operations.
165 * New operations are added calling to startService(), resulting in a call to this method.
166 * This ensures the service will keep on working although the caller activity goes away.
169 public int onStartCommand(Intent intent
, int flags
, int startId
) {
170 // WIP: for the moment, only SYNC_FOLDER and CANCEL_SYNC_FOLDER is expected here;
171 // the rest of the operations are requested through the Binder
172 if (ACTION_SYNC_FOLDER
.equals(intent
.getAction())) {
173 if (!intent
.hasExtra(EXTRA_ACCOUNT
) || !intent
.hasExtra(EXTRA_REMOTE_PATH
)) {
174 Log_OC
.e(TAG
, "Not enough information provided in intent");
175 return START_NOT_STICKY
;
177 Account account
= intent
.getParcelableExtra(EXTRA_ACCOUNT
);
178 String remotePath
= intent
.getStringExtra(EXTRA_REMOTE_PATH
);
180 Pair
<Account
, String
> itemSyncKey
= new Pair
<Account
, String
>(account
, remotePath
);
182 Pair
<Target
, RemoteOperation
> itemToQueue
= newOperation(intent
);
183 if (itemToQueue
!= null
) {
184 mSyncFolderHandler
.add(account
, remotePath
, (SynchronizeFolderOperation
)itemToQueue
.second
);
185 sendBroadcastNewSyncFolder(account
, remotePath
);
186 Message msg
= mSyncFolderHandler
.obtainMessage();
188 msg
.obj
= itemSyncKey
;
189 mSyncFolderHandler
.sendMessage(msg
);
191 } else if (ACTION_CANCEL_SYNC_FOLDER
.equals(intent
.getAction())) {
192 if (!intent
.hasExtra(EXTRA_ACCOUNT
) || !intent
.hasExtra(EXTRA_FILE
)) {
193 Log_OC
.e(TAG
, "Not enough information provided in intent");
194 return START_NOT_STICKY
;
196 Account account
= intent
.getParcelableExtra(EXTRA_ACCOUNT
);
197 OCFile file
= intent
.getParcelableExtra(EXTRA_FILE
);
200 mSyncFolderHandler
.cancel(account
,file
);
202 Message msg
= mOperationsHandler
.obtainMessage();
204 mOperationsHandler
.sendMessage(msg
);
207 return START_NOT_STICKY
;
211 * TODO remove this method when "folder synchronization" replaces "folder download"; this is a fast and ugly
214 private void sendBroadcastNewSyncFolder(Account account
, String remotePath
) {
215 Intent added
= new Intent(FileDownloader
.getDownloadAddedMessage());
216 added
.putExtra(FileDownloader
.ACCOUNT_NAME
, account
.name
);
217 added
.putExtra(FileDownloader
.EXTRA_REMOTE_PATH
, remotePath
);
218 added
.putExtra(FileDownloader
.EXTRA_FILE_PATH
, FileStorageUtils
.getSavePath(account
.name
) + remotePath
);
219 sendStickyBroadcast(added
);
224 public void onDestroy() {
225 //Log_OC.wtf(TAG, "onDestroy init" );
228 OwnCloudClientManagerFactory
.getDefaultSingleton().
229 saveAllClients(this, MainApp
.getAccountType());
231 // TODO - get rid of these exceptions
232 } catch (AccountNotFoundException e
) {
234 } catch (AuthenticatorException e
) {
236 } catch (OperationCanceledException e
) {
238 } catch (IOException e
) {
242 //Log_OC.wtf(TAG, "Clear mUndispatchedFinisiedOperations" );
243 mUndispatchedFinishedOperations
.clear();
245 //Log_OC.wtf(TAG, "onDestroy end" );
250 * Provides a binder object that clients can use to perform actions on the queue of operations,
251 * except the addition of new operations.
254 public IBinder
onBind(Intent intent
) {
255 //Log_OC.wtf(TAG, "onBind" );
256 return mOperationsBinder
;
261 * Called when ALL the bound clients were unbound.
264 public boolean onUnbind(Intent intent
) {
265 ((OperationsServiceBinder
)mOperationsBinder
).clearListeners();
266 return false
; // not accepting rebinding (default behaviour)
271 * Binder to let client components to perform actions on the queue of operations.
273 * It provides by itself the available operations.
275 public class OperationsServiceBinder
extends Binder
/* implements OnRemoteOperationListener */ {
278 * Map of listeners that will be reported about the end of operations from a {@link OperationsServiceBinder} instance
280 private ConcurrentMap
<OnRemoteOperationListener
, Handler
> mBoundListeners
=
281 new ConcurrentHashMap
<OnRemoteOperationListener
, Handler
>();
283 private ServiceHandler mServiceHandler
= null
;
286 public OperationsServiceBinder(ServiceHandler serviceHandler
) {
287 mServiceHandler
= serviceHandler
;
292 * Cancels an operation
296 public void cancel() {
301 public void clearListeners() {
303 mBoundListeners
.clear();
308 * Adds a listener interested in being reported about the end of operations.
310 * @param listener Object to notify about the end of operations.
311 * @param callbackHandler {@link Handler} to access the listener without breaking Android threading protection.
313 public void addOperationListener (OnRemoteOperationListener listener
, Handler callbackHandler
) {
314 synchronized (mBoundListeners
) {
315 mBoundListeners
.put(listener
, callbackHandler
);
321 * Removes a listener from the list of objects interested in the being reported about the end of operations.
323 * @param listener Object to notify about progress of transfer.
325 public void removeOperationListener (OnRemoteOperationListener listener
) {
326 synchronized (mBoundListeners
) {
327 mBoundListeners
.remove(listener
);
333 * TODO - IMPORTANT: update implementation when more operations are moved into the service
335 * @return 'True' when an operation that enforces the user to wait for completion is in process.
337 public boolean isPerformingBlockingOperation() {
338 return (!mServiceHandler
.mPendingOperations
.isEmpty());
343 * Creates and adds to the queue a new operation, as described by operationIntent.
345 * Calls startService to make the operation is processed by the ServiceHandler.
347 * @param operationIntent Intent describing a new operation to queue and execute.
348 * @return Identifier of the operation created, or null if failed.
350 public long queueNewOperation(Intent operationIntent
) {
351 Pair
<Target
, RemoteOperation
> itemToQueue
= newOperation(operationIntent
);
352 if (itemToQueue
!= null
) {
353 mServiceHandler
.mPendingOperations
.add(itemToQueue
);
354 startService(new Intent(OperationsService
.this, OperationsService
.class));
355 return itemToQueue
.second
.hashCode();
358 return Long
.MAX_VALUE
;
363 public boolean dispatchResultIfFinished(int operationId
, OnRemoteOperationListener listener
) {
364 Pair
<RemoteOperation
, RemoteOperationResult
> undispatched
=
365 mUndispatchedFinishedOperations
.remove(operationId
);
366 if (undispatched
!= null
) {
367 listener
.onRemoteOperationFinish(undispatched
.first
, undispatched
.second
);
369 //Log_OC.wtf(TAG, "Sending callback later");
371 if (!mServiceHandler
.mPendingOperations
.isEmpty()) {
376 //Log_OC.wtf(TAG, "Not finished yet");
382 * Returns True when the file described by 'file' in the ownCloud account 'account' is downloading or waiting to download.
384 * If 'file' is a directory, returns 'true' if some of its descendant files is downloading or waiting to download.
386 * @param account ownCloud account where the remote file is stored.
387 * @param file A file that could be affected
389 public boolean isSynchronizing(Account account
, String remotePath
) {
390 return mSyncFolderHandler
.isSynchronizing(account
, remotePath
);
397 * SyncFolder worker. Performs the pending operations in the order they were requested.
399 * Created with the Looper of a new thread, started in {@link OperationsService#onCreate()}.
401 private static class SyncFolderHandler
extends Handler
{
403 // don't make it a final class, and don't remove the static ; lint will warn about a possible memory leak
405 OperationsService mService
;
407 private ConcurrentMap
<String
,SynchronizeFolderOperation
> mPendingOperations
=
408 new ConcurrentHashMap
<String
,SynchronizeFolderOperation
>();
409 private OwnCloudClient mOwnCloudClient
= null
;
410 private FileDataStorageManager mStorageManager
;
411 private SynchronizeFolderOperation mCurrentSyncOperation
;
414 public SyncFolderHandler(Looper looper
, OperationsService service
) {
416 if (service
== null
) {
417 throw new IllegalArgumentException("Received invalid NULL in parameter 'service'");
423 public boolean isSynchronizing(Account account
, String remotePath
) {
424 if (account
== null
|| remotePath
== null
) return false
;
425 String targetKey
= buildRemoteName(account
, remotePath
);
426 synchronized (mPendingOperations
) {
427 return (mPendingOperations
.containsKey(targetKey
));
433 public void handleMessage(Message msg
) {
434 Pair
<Account
, String
> itemSyncKey
= (Pair
<Account
, String
>) msg
.obj
;
435 doOperation(itemSyncKey
.first
, itemSyncKey
.second
);
436 mService
.stopSelf(msg
.arg1
);
441 * Performs the next operation in the queue
443 private void doOperation(Account account
, String remotePath
) {
445 String syncKey
= buildRemoteName(account
,remotePath
);
447 synchronized(mPendingOperations
) {
448 mCurrentSyncOperation
= mPendingOperations
.get(syncKey
);
451 if (mCurrentSyncOperation
!= null
) {
455 OwnCloudAccount ocAccount
= new OwnCloudAccount(account
, mService
);
456 mOwnCloudClient
= OwnCloudClientManagerFactory
.getDefaultSingleton().
457 getClientFor(ocAccount
, mService
);
458 mStorageManager
= new FileDataStorageManager(
460 mService
.getContentResolver()
463 mCurrentSyncOperation
.execute(mOwnCloudClient
, mStorageManager
);
465 } catch (AccountsException e
) {
466 Log_OC
.e(TAG
, "Error while trying to get autorization", e
);
467 } catch (IOException e
) {
468 Log_OC
.e(TAG
, "Error while trying to get autorization", e
);
470 synchronized(mPendingOperations
) {
471 mPendingOperations
.remove(syncKey
);
477 public void add(Account account
, String remotePath
, SynchronizeFolderOperation syncFolderOperation
){
478 String syncKey
= buildRemoteName(account
,remotePath
);
479 mPendingOperations
.putIfAbsent(syncKey
,syncFolderOperation
);
484 * Cancels a pending or current sync operation.
486 * @param account Owncloud account where the remote file is stored.
489 public void cancel(Account account
, OCFile file
) {
490 SynchronizeFolderOperation syncOperation
= null
;
491 synchronized (mPendingOperations
) {
492 syncOperation
= mPendingOperations
.remove(buildRemoteName(account
, file
.getRemotePath()));
494 if (syncOperation
!= null
) {
495 syncOperation
.cancel();
498 Intent intent
= new Intent( MainApp
.getAppContext(), FileDownloader
.class);
499 intent
.setAction(FileDownloader
.ACTION_CANCEL_FILE_DOWNLOAD
);
500 intent
.putExtra(FileDownloader
.EXTRA_ACCOUNT
, account
);
501 intent
.putExtra(FileDownloader
.EXTRA_FILE
, file
);
502 MainApp
.getAppContext().startService(intent
);
507 * Builds a key from the account and file to download
509 * @param account Account where the file to download is stored
510 * @param path File path
512 private String
buildRemoteName(Account account
, String path
) {
513 return account
.name
+ path
;
519 * Operations worker. Performs the pending operations in the order they were requested.
521 * Created with the Looper of a new thread, started in {@link OperationsService#onCreate()}.
523 private static class ServiceHandler
extends Handler
{
524 // don't make it a final class, and don't remove the static ; lint will warn about a possible memory leak
527 OperationsService mService
;
530 private ConcurrentLinkedQueue
<Pair
<Target
, RemoteOperation
>> mPendingOperations
=
531 new ConcurrentLinkedQueue
<Pair
<Target
, RemoteOperation
>>();
532 private RemoteOperation mCurrentOperation
= null
;
533 private Target mLastTarget
= null
;
534 private OwnCloudClient mOwnCloudClient
= null
;
535 private FileDataStorageManager mStorageManager
;
538 public ServiceHandler(Looper looper
, OperationsService service
) {
540 if (service
== null
) {
541 throw new IllegalArgumentException("Received invalid NULL in parameter 'service'");
547 public void handleMessage(Message msg
) {
549 mService
.stopSelf(msg
.arg1
);
554 * Performs the next operation in the queue
556 private void nextOperation() {
558 //Log_OC.wtf(TAG, "nextOperation init" );
560 Pair
<Target
, RemoteOperation
> next
= null
;
561 synchronized(mPendingOperations
) {
562 next
= mPendingOperations
.peek();
567 mCurrentOperation
= next
.second
;
568 RemoteOperationResult result
= null
;
570 /// prepare client object to send the request to the ownCloud server
571 if (mLastTarget
== null
|| !mLastTarget
.equals(next
.first
)) {
572 mLastTarget
= next
.first
;
573 if (mLastTarget
.mAccount
!= null
) {
574 OwnCloudAccount ocAccount
= new OwnCloudAccount(mLastTarget
.mAccount
, mService
);
575 mOwnCloudClient
= OwnCloudClientManagerFactory
.getDefaultSingleton().
576 getClientFor(ocAccount
, mService
);
577 mStorageManager
= new FileDataStorageManager(
578 mLastTarget
.mAccount
,
579 mService
.getContentResolver()
582 OwnCloudCredentials credentials
= null
;
583 if (mLastTarget
.mUsername
!= null
&&
584 mLastTarget
.mUsername
.length() > 0) {
585 credentials
= OwnCloudCredentialsFactory
.newBasicCredentials(
586 mLastTarget
.mUsername
,
587 mLastTarget
.mPassword
); // basic
589 } else if (mLastTarget
.mAuthToken
!= null
&&
590 mLastTarget
.mAuthToken
.length() > 0) {
591 credentials
= OwnCloudCredentialsFactory
.newBearerCredentials(
592 mLastTarget
.mAuthToken
); // bearer token
594 } else if (mLastTarget
.mCookie
!= null
&&
595 mLastTarget
.mCookie
.length() > 0) {
596 credentials
= OwnCloudCredentialsFactory
.newSamlSsoCredentials(
597 mLastTarget
.mCookie
); // SAML SSO
599 OwnCloudAccount ocAccount
= new OwnCloudAccount(
600 mLastTarget
.mServerUrl
, credentials
);
601 mOwnCloudClient
= OwnCloudClientManagerFactory
.getDefaultSingleton().
602 getClientFor(ocAccount
, mService
);
603 mStorageManager
= null
;
607 /// perform the operation
608 if (mCurrentOperation
instanceof SyncOperation
) {
609 result
= ((SyncOperation
)mCurrentOperation
).execute(mOwnCloudClient
, mStorageManager
);
611 result
= mCurrentOperation
.execute(mOwnCloudClient
);
614 } catch (AccountsException e
) {
615 if (mLastTarget
.mAccount
== null
) {
616 Log_OC
.e(TAG
, "Error while trying to get authorization for a NULL account", e
);
618 Log_OC
.e(TAG
, "Error while trying to get authorization for " + mLastTarget
.mAccount
.name
, e
);
620 result
= new RemoteOperationResult(e
);
622 } catch (IOException e
) {
623 if (mLastTarget
.mAccount
== null
) {
624 Log_OC
.e(TAG
, "Error while trying to get authorization for a NULL account", e
);
626 Log_OC
.e(TAG
, "Error while trying to get authorization for " + mLastTarget
.mAccount
.name
, e
);
628 result
= new RemoteOperationResult(e
);
629 } catch (Exception e
) {
630 if (mLastTarget
.mAccount
== null
) {
631 Log_OC
.e(TAG
, "Unexpected error for a NULL account", e
);
633 Log_OC
.e(TAG
, "Unexpected error for " + mLastTarget
.mAccount
.name
, e
);
635 result
= new RemoteOperationResult(e
);
638 synchronized(mPendingOperations
) {
639 mPendingOperations
.poll();
643 //sendBroadcastOperationFinished(mLastTarget, mCurrentOperation, result);
644 mService
.dispatchResultToOperationListeners(mLastTarget
, mCurrentOperation
, result
);
654 * Creates a new operation, as described by operationIntent.
656 * TODO - move to ServiceHandler (probably)
658 * @param operationIntent Intent describing a new operation to queue and execute.
659 * @return Pair with the new operation object and the information about its target server.
661 private Pair
<Target
, RemoteOperation
> newOperation(Intent operationIntent
) {
662 RemoteOperation operation
= null
;
663 Target target
= null
;
665 if (!operationIntent
.hasExtra(EXTRA_ACCOUNT
) &&
666 !operationIntent
.hasExtra(EXTRA_SERVER_URL
)) {
667 Log_OC
.e(TAG
, "Not enough information provided in intent");
670 Account account
= operationIntent
.getParcelableExtra(EXTRA_ACCOUNT
);
671 String serverUrl
= operationIntent
.getStringExtra(EXTRA_SERVER_URL
);
672 String username
= operationIntent
.getStringExtra(EXTRA_USERNAME
);
673 String password
= operationIntent
.getStringExtra(EXTRA_PASSWORD
);
674 String authToken
= operationIntent
.getStringExtra(EXTRA_AUTH_TOKEN
);
675 String cookie
= operationIntent
.getStringExtra(EXTRA_COOKIE
);
678 (serverUrl
== null
) ? null
: Uri
.parse(serverUrl
),
685 String action
= operationIntent
.getAction();
686 if (action
.equals(ACTION_CREATE_SHARE
)) { // Create Share
687 String remotePath
= operationIntent
.getStringExtra(EXTRA_REMOTE_PATH
);
688 Intent sendIntent
= operationIntent
.getParcelableExtra(EXTRA_SEND_INTENT
);
689 if (remotePath
.length() > 0) {
690 operation
= new CreateShareOperation(remotePath
, ShareType
.PUBLIC_LINK
,
691 "", false
, "", 1, sendIntent
);
694 } else if (action
.equals(ACTION_UNSHARE
)) { // Unshare file
695 String remotePath
= operationIntent
.getStringExtra(EXTRA_REMOTE_PATH
);
696 if (remotePath
.length() > 0) {
697 operation
= new UnshareLinkOperation(
699 OperationsService
.this);
702 } else if (action
.equals(ACTION_GET_SERVER_INFO
)) {
703 // check OC server and get basic information from it
704 operation
= new GetServerInfoOperation(serverUrl
, OperationsService
.this);
706 } else if (action
.equals(ACTION_OAUTH2_GET_ACCESS_TOKEN
)) {
707 /// GET ACCESS TOKEN to the OAuth server
708 String oauth2QueryParameters
=
709 operationIntent
.getStringExtra(EXTRA_OAUTH2_QUERY_PARAMETERS
);
710 operation
= new OAuth2GetAccessToken(
711 getString(R
.string
.oauth2_client_id
),
712 getString(R
.string
.oauth2_redirect_uri
),
713 getString(R
.string
.oauth2_grant_type
),
714 oauth2QueryParameters
);
716 } else if (action
.equals(ACTION_EXISTENCE_CHECK
)) {
718 String remotePath
= operationIntent
.getStringExtra(EXTRA_REMOTE_PATH
);
719 boolean successIfAbsent
= operationIntent
.getBooleanExtra(EXTRA_SUCCESS_IF_ABSENT
, false
);
720 operation
= new ExistenceCheckRemoteOperation(remotePath
, OperationsService
.this, successIfAbsent
);
722 } else if (action
.equals(ACTION_GET_USER_NAME
)) {
724 operation
= new GetRemoteUserNameOperation();
726 } else if (action
.equals(ACTION_RENAME
)) {
727 // Rename file or folder
728 String remotePath
= operationIntent
.getStringExtra(EXTRA_REMOTE_PATH
);
729 String newName
= operationIntent
.getStringExtra(EXTRA_NEWNAME
);
730 operation
= new RenameFileOperation(remotePath
, newName
);
732 } else if (action
.equals(ACTION_REMOVE
)) {
733 // Remove file or folder
734 String remotePath
= operationIntent
.getStringExtra(EXTRA_REMOTE_PATH
);
735 boolean onlyLocalCopy
= operationIntent
.getBooleanExtra(EXTRA_REMOVE_ONLY_LOCAL
, false
);
736 operation
= new RemoveFileOperation(remotePath
, onlyLocalCopy
);
738 } else if (action
.equals(ACTION_CREATE_FOLDER
)) {
740 String remotePath
= operationIntent
.getStringExtra(EXTRA_REMOTE_PATH
);
741 boolean createFullPath
= operationIntent
.getBooleanExtra(EXTRA_CREATE_FULL_PATH
, true
);
742 operation
= new CreateFolderOperation(remotePath
, createFullPath
);
744 } else if (action
.equals(ACTION_SYNC_FILE
)) {
746 String remotePath
= operationIntent
.getStringExtra(EXTRA_REMOTE_PATH
);
747 boolean syncFileContents
= operationIntent
.getBooleanExtra(EXTRA_SYNC_FILE_CONTENTS
, true
);
748 operation
= new SynchronizeFileOperation(
749 remotePath
, account
, syncFileContents
, getApplicationContext()
752 } else if (action
.equals(ACTION_SYNC_FOLDER
)) {
754 String remotePath
= operationIntent
.getStringExtra(EXTRA_REMOTE_PATH
);
755 operation
= new SynchronizeFolderOperation(
756 this, // TODO remove this dependency from construction time
759 System
.currentTimeMillis() // TODO remove this dependency from construction time
762 } else if (action
.equals(ACTION_MOVE_FILE
)) {
764 String remotePath
= operationIntent
.getStringExtra(EXTRA_REMOTE_PATH
);
765 String newParentPath
= operationIntent
.getStringExtra(EXTRA_NEW_PARENT_PATH
);
766 operation
= new MoveFileOperation(remotePath
,newParentPath
,account
);
771 } catch (IllegalArgumentException e
) {
772 Log_OC
.e(TAG
, "Bad information provided in intent: " + e
.getMessage());
776 if (operation
!= null
) {
777 return new Pair
<Target
, RemoteOperation
>(target
, operation
);
785 * Sends a broadcast when a new operation is added to the queue.
787 * Local broadcasts are only delivered to activities in the same process, but can't be done sticky :\
789 * @param target Account or URL pointing to an OC server.
790 * @param operation Added operation.
792 private void sendBroadcastNewOperation(Target target
, RemoteOperation operation
) {
793 Intent intent
= new Intent(ACTION_OPERATION_ADDED
);
794 if (target
.mAccount
!= null
) {
795 intent
.putExtra(EXTRA_ACCOUNT
, target
.mAccount
);
797 intent
.putExtra(EXTRA_SERVER_URL
, target
.mServerUrl
);
799 //LocalBroadcastManager lbm = LocalBroadcastManager.getInstance(this);
800 //lbm.sendBroadcast(intent);
801 sendStickyBroadcast(intent
);
805 // TODO - maybe add a notification for real start of operations
808 * Sends a LOCAL broadcast when an operations finishes in order to the interested activities can update their view
810 * Local broadcasts are only delivered to activities in the same process.
812 * @param target Account or URL pointing to an OC server.
813 * @param operation Finished operation.
814 * @param result Result of the operation.
816 private void sendBroadcastOperationFinished(Target target
, RemoteOperation operation
, RemoteOperationResult result
) {
817 Intent intent
= new Intent(ACTION_OPERATION_FINISHED
);
818 intent
.putExtra(EXTRA_RESULT
, result
);
819 if (target
.mAccount
!= null
) {
820 intent
.putExtra(EXTRA_ACCOUNT
, target
.mAccount
);
822 intent
.putExtra(EXTRA_SERVER_URL
, target
.mServerUrl
);
824 //LocalBroadcastManager lbm = LocalBroadcastManager.getInstance(this);
825 //lbm.sendBroadcast(intent);
826 sendStickyBroadcast(intent
);
831 * Notifies the currently subscribed listeners about the end of an operation.
833 * @param target Account or URL pointing to an OC server.
834 * @param operation Finished operation.
835 * @param result Result of the operation.
837 private void dispatchResultToOperationListeners(
838 Target target
, final RemoteOperation operation
, final RemoteOperationResult result
) {
840 Iterator
<OnRemoteOperationListener
> listeners
= mOperationsBinder
.mBoundListeners
.keySet().iterator();
841 while (listeners
.hasNext()) {
842 final OnRemoteOperationListener listener
= listeners
.next();
843 final Handler handler
= mOperationsBinder
.mBoundListeners
.get(listener
);
844 if (handler
!= null
) {
845 handler
.post(new Runnable() {
848 listener
.onRemoteOperationFinish(operation
, result
);
855 //mOperationResults.put(operation.hashCode(), result);
856 Pair
<RemoteOperation
, RemoteOperationResult
> undispatched
=
857 new Pair
<RemoteOperation
, RemoteOperationResult
>(operation
, result
);
858 mUndispatchedFinishedOperations
.put(operation
.hashCode(), undispatched
);
860 Log_OC
.d(TAG
, "Called " + count
+ " listeners");