Merge pull request #813 from owncloud/download_folder__improved_cancellation
[pub/Android/ownCloud.git] / src / com / owncloud / android / services / OperationsService.java
1 /* ownCloud Android client application
2 * Copyright (C) 2012-2014 ownCloud Inc.
3 *
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.
7 *
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.
12 *
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/>.
15 *
16 */
17
18 package com.owncloud.android.services;
19
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;
25
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;
56
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;
72
73 public class OperationsService extends Service {
74
75 private static final String TAG = OperationsService.class.getSimpleName();
76
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";
89
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";
96
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";
110
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";
113
114
115 private ConcurrentMap<Integer, Pair<RemoteOperation, RemoteOperationResult>>
116 mUndispatchedFinishedOperations =
117 new ConcurrentHashMap<Integer, Pair<RemoteOperation, RemoteOperationResult>>();
118
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;
126
127 public Target(Account account, Uri serverUrl, String username, String password, String authToken,
128 String cookie) {
129 mAccount = account;
130 mServerUrl = serverUrl;
131 mUsername = username;
132 mPassword = password;
133 mAuthToken = authToken;
134 mCookie = cookie;
135 }
136 }
137
138 private ServiceHandler mOperationsHandler;
139 private OperationsServiceBinder mOperationsBinder;
140
141 private SyncFolderHandler mSyncFolderHandler;
142
143 /**
144 * Service initialization
145 */
146 @Override
147 public void onCreate() {
148 super.onCreate();
149 /// First worker thread for most of operations
150 HandlerThread thread = new HandlerThread("Operations thread", Process.THREAD_PRIORITY_BACKGROUND);
151 thread.start();
152 mOperationsHandler = new ServiceHandler(thread.getLooper(), this);
153 mOperationsBinder = new OperationsServiceBinder(mOperationsHandler);
154
155 /// Separated worker thread for download of folders (WIP)
156 thread = new HandlerThread("Syncfolder thread", Process.THREAD_PRIORITY_BACKGROUND);
157 thread.start();
158 mSyncFolderHandler = new SyncFolderHandler(thread.getLooper(), this);
159 }
160
161
162 /**
163 * Entry point to add a new operation to the queue of operations.
164 *
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.
167 */
168 @Override
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;
176 }
177 Account account = intent.getParcelableExtra(EXTRA_ACCOUNT);
178 String remotePath = intent.getStringExtra(EXTRA_REMOTE_PATH);
179
180 Pair<Account, String> itemSyncKey = new Pair<Account , String>(account, remotePath);
181
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();
187 msg.arg1 = startId;
188 msg.obj = itemSyncKey;
189 mSyncFolderHandler.sendMessage(msg);
190 }
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;
195 }
196 Account account = intent.getParcelableExtra(EXTRA_ACCOUNT);
197 OCFile file = intent.getParcelableExtra(EXTRA_FILE);
198
199 // Cancel operation
200 mSyncFolderHandler.cancel(account,file);
201 } else {
202 Message msg = mOperationsHandler.obtainMessage();
203 msg.arg1 = startId;
204 mOperationsHandler.sendMessage(msg);
205 }
206
207 return START_NOT_STICKY;
208 }
209
210 /**
211 * TODO remove this method when "folder synchronization" replaces "folder download"; this is a fast and ugly
212 * patch.
213 */
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);
220 }
221
222
223 @Override
224 public void onDestroy() {
225 //Log_OC.wtf(TAG, "onDestroy init" );
226 // Saving cookies
227 try {
228 OwnCloudClientManagerFactory.getDefaultSingleton().
229 saveAllClients(this, MainApp.getAccountType());
230
231 // TODO - get rid of these exceptions
232 } catch (AccountNotFoundException e) {
233 e.printStackTrace();
234 } catch (AuthenticatorException e) {
235 e.printStackTrace();
236 } catch (OperationCanceledException e) {
237 e.printStackTrace();
238 } catch (IOException e) {
239 e.printStackTrace();
240 }
241
242 //Log_OC.wtf(TAG, "Clear mUndispatchedFinisiedOperations" );
243 mUndispatchedFinishedOperations.clear();
244
245 //Log_OC.wtf(TAG, "onDestroy end" );
246 super.onDestroy();
247 }
248
249 /**
250 * Provides a binder object that clients can use to perform actions on the queue of operations,
251 * except the addition of new operations.
252 */
253 @Override
254 public IBinder onBind(Intent intent) {
255 //Log_OC.wtf(TAG, "onBind" );
256 return mOperationsBinder;
257 }
258
259
260 /**
261 * Called when ALL the bound clients were unbound.
262 */
263 @Override
264 public boolean onUnbind(Intent intent) {
265 ((OperationsServiceBinder)mOperationsBinder).clearListeners();
266 return false; // not accepting rebinding (default behaviour)
267 }
268
269
270 /**
271 * Binder to let client components to perform actions on the queue of operations.
272 *
273 * It provides by itself the available operations.
274 */
275 public class OperationsServiceBinder extends Binder /* implements OnRemoteOperationListener */ {
276
277 /**
278 * Map of listeners that will be reported about the end of operations from a {@link OperationsServiceBinder} instance
279 */
280 private ConcurrentMap<OnRemoteOperationListener, Handler> mBoundListeners =
281 new ConcurrentHashMap<OnRemoteOperationListener, Handler>();
282
283 private ServiceHandler mServiceHandler = null;
284
285
286 public OperationsServiceBinder(ServiceHandler serviceHandler) {
287 mServiceHandler = serviceHandler;
288 }
289
290
291 /**
292 * Cancels an operation
293 *
294 * TODO
295 */
296 public void cancel() {
297 // TODO
298 }
299
300
301 public void clearListeners() {
302
303 mBoundListeners.clear();
304 }
305
306
307 /**
308 * Adds a listener interested in being reported about the end of operations.
309 *
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.
312 */
313 public void addOperationListener (OnRemoteOperationListener listener, Handler callbackHandler) {
314 synchronized (mBoundListeners) {
315 mBoundListeners.put(listener, callbackHandler);
316 }
317 }
318
319
320 /**
321 * Removes a listener from the list of objects interested in the being reported about the end of operations.
322 *
323 * @param listener Object to notify about progress of transfer.
324 */
325 public void removeOperationListener (OnRemoteOperationListener listener) {
326 synchronized (mBoundListeners) {
327 mBoundListeners.remove(listener);
328 }
329 }
330
331
332 /**
333 * TODO - IMPORTANT: update implementation when more operations are moved into the service
334 *
335 * @return 'True' when an operation that enforces the user to wait for completion is in process.
336 */
337 public boolean isPerformingBlockingOperation() {
338 return (!mServiceHandler.mPendingOperations.isEmpty());
339 }
340
341
342 /**
343 * Creates and adds to the queue a new operation, as described by operationIntent.
344 *
345 * Calls startService to make the operation is processed by the ServiceHandler.
346 *
347 * @param operationIntent Intent describing a new operation to queue and execute.
348 * @return Identifier of the operation created, or null if failed.
349 */
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();
356
357 } else {
358 return Long.MAX_VALUE;
359 }
360 }
361
362
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);
368 return true;
369 //Log_OC.wtf(TAG, "Sending callback later");
370 } else {
371 if (!mServiceHandler.mPendingOperations.isEmpty()) {
372 return true;
373 } else {
374 return false;
375 }
376 //Log_OC.wtf(TAG, "Not finished yet");
377 }
378 }
379
380
381 /**
382 * Returns True when the file described by 'file' in the ownCloud account 'account' is downloading or waiting to download.
383 *
384 * If 'file' is a directory, returns 'true' if some of its descendant files is downloading or waiting to download.
385 *
386 * @param account ownCloud account where the remote file is stored.
387 * @param file A file that could be affected
388 */
389 public boolean isSynchronizing(Account account, String remotePath) {
390 return mSyncFolderHandler.isSynchronizing(account, remotePath);
391 }
392
393 }
394
395
396 /**
397 * SyncFolder worker. Performs the pending operations in the order they were requested.
398 *
399 * Created with the Looper of a new thread, started in {@link OperationsService#onCreate()}.
400 */
401 private static class SyncFolderHandler extends Handler {
402
403 // don't make it a final class, and don't remove the static ; lint will warn about a possible memory leak
404
405 OperationsService mService;
406
407 private ConcurrentMap<String,SynchronizeFolderOperation> mPendingOperations =
408 new ConcurrentHashMap<String,SynchronizeFolderOperation>();
409 private OwnCloudClient mOwnCloudClient = null;
410 private FileDataStorageManager mStorageManager;
411 private SynchronizeFolderOperation mCurrentSyncOperation;
412
413
414 public SyncFolderHandler(Looper looper, OperationsService service) {
415 super(looper);
416 if (service == null) {
417 throw new IllegalArgumentException("Received invalid NULL in parameter 'service'");
418 }
419 mService = service;
420 }
421
422
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));
428 }
429 }
430
431
432 @Override
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);
437 }
438
439
440 /**
441 * Performs the next operation in the queue
442 */
443 private void doOperation(Account account, String remotePath) {
444
445 String syncKey = buildRemoteName(account,remotePath);
446
447 synchronized(mPendingOperations) {
448 mCurrentSyncOperation = mPendingOperations.get(syncKey);
449 }
450
451 if (mCurrentSyncOperation != null) {
452
453 try {
454
455 OwnCloudAccount ocAccount = new OwnCloudAccount(account, mService);
456 mOwnCloudClient = OwnCloudClientManagerFactory.getDefaultSingleton().
457 getClientFor(ocAccount, mService);
458 mStorageManager = new FileDataStorageManager(
459 account,
460 mService.getContentResolver()
461 );
462
463 mCurrentSyncOperation.execute(mOwnCloudClient, mStorageManager);
464
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);
469 } finally {
470 synchronized(mPendingOperations) {
471 mPendingOperations.remove(syncKey);
472 }
473 }
474 }
475 }
476
477 public void add(Account account, String remotePath, SynchronizeFolderOperation syncFolderOperation){
478 String syncKey = buildRemoteName(account,remotePath);
479 mPendingOperations.putIfAbsent(syncKey,syncFolderOperation);
480 }
481
482
483 /**
484 * Cancels a pending or current sync operation.
485 *
486 * @param account Owncloud account where the remote file is stored.
487 * @param file File
488 */
489 public void cancel(Account account, OCFile file) {
490 SynchronizeFolderOperation syncOperation = null;
491 synchronized (mPendingOperations) {
492 syncOperation = mPendingOperations.remove(buildRemoteName(account, file.getRemotePath()));
493 }
494 if (syncOperation != null) {
495 syncOperation.cancel();
496 }
497
498 /// cancellation of download needs to be done separately in any case; a SynchronizeFolderOperation
499 // may finish much sooner than the real download of the files in the folder
500 Intent intent = new Intent(mService, FileDownloader.class);
501 intent.setAction(FileDownloader.ACTION_CANCEL_FILE_DOWNLOAD);
502 intent.putExtra(FileDownloader.EXTRA_ACCOUNT, account);
503 intent.putExtra(FileDownloader.EXTRA_FILE, file);
504 mService.startService(intent);
505 }
506
507 /**
508 * Builds a key from the account and file to download
509 *
510 * @param account Account where the file to download is stored
511 * @param path File path
512 */
513 private String buildRemoteName(Account account, String path) {
514 return account.name + path;
515 }
516 }
517
518
519 /**
520 * Operations worker. Performs the pending operations in the order they were requested.
521 *
522 * Created with the Looper of a new thread, started in {@link OperationsService#onCreate()}.
523 */
524 private static class ServiceHandler extends Handler {
525 // don't make it a final class, and don't remove the static ; lint will warn about a possible memory leak
526
527
528 OperationsService mService;
529
530
531 private ConcurrentLinkedQueue<Pair<Target, RemoteOperation>> mPendingOperations =
532 new ConcurrentLinkedQueue<Pair<Target, RemoteOperation>>();
533 private RemoteOperation mCurrentOperation = null;
534 private Target mLastTarget = null;
535 private OwnCloudClient mOwnCloudClient = null;
536 private FileDataStorageManager mStorageManager;
537
538
539 public ServiceHandler(Looper looper, OperationsService service) {
540 super(looper);
541 if (service == null) {
542 throw new IllegalArgumentException("Received invalid NULL in parameter 'service'");
543 }
544 mService = service;
545 }
546
547 @Override
548 public void handleMessage(Message msg) {
549 nextOperation();
550 mService.stopSelf(msg.arg1);
551 }
552
553
554 /**
555 * Performs the next operation in the queue
556 */
557 private void nextOperation() {
558
559 //Log_OC.wtf(TAG, "nextOperation init" );
560
561 Pair<Target, RemoteOperation> next = null;
562 synchronized(mPendingOperations) {
563 next = mPendingOperations.peek();
564 }
565
566 if (next != null) {
567
568 mCurrentOperation = next.second;
569 RemoteOperationResult result = null;
570 try {
571 /// prepare client object to send the request to the ownCloud server
572 if (mLastTarget == null || !mLastTarget.equals(next.first)) {
573 mLastTarget = next.first;
574 if (mLastTarget.mAccount != null) {
575 OwnCloudAccount ocAccount = new OwnCloudAccount(mLastTarget.mAccount, mService);
576 mOwnCloudClient = OwnCloudClientManagerFactory.getDefaultSingleton().
577 getClientFor(ocAccount, mService);
578 mStorageManager = new FileDataStorageManager(
579 mLastTarget.mAccount,
580 mService.getContentResolver()
581 );
582 } else {
583 OwnCloudCredentials credentials = null;
584 if (mLastTarget.mUsername != null &&
585 mLastTarget.mUsername.length() > 0) {
586 credentials = OwnCloudCredentialsFactory.newBasicCredentials(
587 mLastTarget.mUsername,
588 mLastTarget.mPassword); // basic
589
590 } else if (mLastTarget.mAuthToken != null &&
591 mLastTarget.mAuthToken.length() > 0) {
592 credentials = OwnCloudCredentialsFactory.newBearerCredentials(
593 mLastTarget.mAuthToken); // bearer token
594
595 } else if (mLastTarget.mCookie != null &&
596 mLastTarget.mCookie.length() > 0) {
597 credentials = OwnCloudCredentialsFactory.newSamlSsoCredentials(
598 mLastTarget.mCookie); // SAML SSO
599 }
600 OwnCloudAccount ocAccount = new OwnCloudAccount(
601 mLastTarget.mServerUrl, credentials);
602 mOwnCloudClient = OwnCloudClientManagerFactory.getDefaultSingleton().
603 getClientFor(ocAccount, mService);
604 mStorageManager = null;
605 }
606 }
607
608 /// perform the operation
609 if (mCurrentOperation instanceof SyncOperation) {
610 result = ((SyncOperation)mCurrentOperation).execute(mOwnCloudClient, mStorageManager);
611 } else {
612 result = mCurrentOperation.execute(mOwnCloudClient);
613 }
614
615 } catch (AccountsException e) {
616 if (mLastTarget.mAccount == null) {
617 Log_OC.e(TAG, "Error while trying to get authorization for a NULL account", e);
618 } else {
619 Log_OC.e(TAG, "Error while trying to get authorization for " + mLastTarget.mAccount.name, e);
620 }
621 result = new RemoteOperationResult(e);
622
623 } catch (IOException e) {
624 if (mLastTarget.mAccount == null) {
625 Log_OC.e(TAG, "Error while trying to get authorization for a NULL account", e);
626 } else {
627 Log_OC.e(TAG, "Error while trying to get authorization for " + mLastTarget.mAccount.name, e);
628 }
629 result = new RemoteOperationResult(e);
630 } catch (Exception e) {
631 if (mLastTarget.mAccount == null) {
632 Log_OC.e(TAG, "Unexpected error for a NULL account", e);
633 } else {
634 Log_OC.e(TAG, "Unexpected error for " + mLastTarget.mAccount.name, e);
635 }
636 result = new RemoteOperationResult(e);
637
638 } finally {
639 synchronized(mPendingOperations) {
640 mPendingOperations.poll();
641 }
642 }
643
644 //sendBroadcastOperationFinished(mLastTarget, mCurrentOperation, result);
645 mService.dispatchResultToOperationListeners(mLastTarget, mCurrentOperation, result);
646 }
647 }
648
649
650
651 }
652
653
654 /**
655 * Creates a new operation, as described by operationIntent.
656 *
657 * TODO - move to ServiceHandler (probably)
658 *
659 * @param operationIntent Intent describing a new operation to queue and execute.
660 * @return Pair with the new operation object and the information about its target server.
661 */
662 private Pair<Target , RemoteOperation> newOperation(Intent operationIntent) {
663 RemoteOperation operation = null;
664 Target target = null;
665 try {
666 if (!operationIntent.hasExtra(EXTRA_ACCOUNT) &&
667 !operationIntent.hasExtra(EXTRA_SERVER_URL)) {
668 Log_OC.e(TAG, "Not enough information provided in intent");
669
670 } else {
671 Account account = operationIntent.getParcelableExtra(EXTRA_ACCOUNT);
672 String serverUrl = operationIntent.getStringExtra(EXTRA_SERVER_URL);
673 String username = operationIntent.getStringExtra(EXTRA_USERNAME);
674 String password = operationIntent.getStringExtra(EXTRA_PASSWORD);
675 String authToken = operationIntent.getStringExtra(EXTRA_AUTH_TOKEN);
676 String cookie = operationIntent.getStringExtra(EXTRA_COOKIE);
677 target = new Target(
678 account,
679 (serverUrl == null) ? null : Uri.parse(serverUrl),
680 username,
681 password,
682 authToken,
683 cookie
684 );
685
686 String action = operationIntent.getAction();
687 if (action.equals(ACTION_CREATE_SHARE)) { // Create Share
688 String remotePath = operationIntent.getStringExtra(EXTRA_REMOTE_PATH);
689 Intent sendIntent = operationIntent.getParcelableExtra(EXTRA_SEND_INTENT);
690 if (remotePath.length() > 0) {
691 operation = new CreateShareOperation(remotePath, ShareType.PUBLIC_LINK,
692 "", false, "", 1, sendIntent);
693 }
694
695 } else if (action.equals(ACTION_UNSHARE)) { // Unshare file
696 String remotePath = operationIntent.getStringExtra(EXTRA_REMOTE_PATH);
697 if (remotePath.length() > 0) {
698 operation = new UnshareLinkOperation(
699 remotePath,
700 OperationsService.this);
701 }
702
703 } else if (action.equals(ACTION_GET_SERVER_INFO)) {
704 // check OC server and get basic information from it
705 operation = new GetServerInfoOperation(serverUrl, OperationsService.this);
706
707 } else if (action.equals(ACTION_OAUTH2_GET_ACCESS_TOKEN)) {
708 /// GET ACCESS TOKEN to the OAuth server
709 String oauth2QueryParameters =
710 operationIntent.getStringExtra(EXTRA_OAUTH2_QUERY_PARAMETERS);
711 operation = new OAuth2GetAccessToken(
712 getString(R.string.oauth2_client_id),
713 getString(R.string.oauth2_redirect_uri),
714 getString(R.string.oauth2_grant_type),
715 oauth2QueryParameters);
716
717 } else if (action.equals(ACTION_EXISTENCE_CHECK)) {
718 // Existence Check
719 String remotePath = operationIntent.getStringExtra(EXTRA_REMOTE_PATH);
720 boolean successIfAbsent = operationIntent.getBooleanExtra(EXTRA_SUCCESS_IF_ABSENT, false);
721 operation = new ExistenceCheckRemoteOperation(remotePath, OperationsService.this, successIfAbsent);
722
723 } else if (action.equals(ACTION_GET_USER_NAME)) {
724 // Get User Name
725 operation = new GetRemoteUserNameOperation();
726
727 } else if (action.equals(ACTION_RENAME)) {
728 // Rename file or folder
729 String remotePath = operationIntent.getStringExtra(EXTRA_REMOTE_PATH);
730 String newName = operationIntent.getStringExtra(EXTRA_NEWNAME);
731 operation = new RenameFileOperation(remotePath, newName);
732
733 } else if (action.equals(ACTION_REMOVE)) {
734 // Remove file or folder
735 String remotePath = operationIntent.getStringExtra(EXTRA_REMOTE_PATH);
736 boolean onlyLocalCopy = operationIntent.getBooleanExtra(EXTRA_REMOVE_ONLY_LOCAL, false);
737 operation = new RemoveFileOperation(remotePath, onlyLocalCopy);
738
739 } else if (action.equals(ACTION_CREATE_FOLDER)) {
740 // Create Folder
741 String remotePath = operationIntent.getStringExtra(EXTRA_REMOTE_PATH);
742 boolean createFullPath = operationIntent.getBooleanExtra(EXTRA_CREATE_FULL_PATH, true);
743 operation = new CreateFolderOperation(remotePath, createFullPath);
744
745 } else if (action.equals(ACTION_SYNC_FILE)) {
746 // Sync file
747 String remotePath = operationIntent.getStringExtra(EXTRA_REMOTE_PATH);
748 boolean syncFileContents = operationIntent.getBooleanExtra(EXTRA_SYNC_FILE_CONTENTS, true);
749 operation = new SynchronizeFileOperation(
750 remotePath, account, syncFileContents, getApplicationContext()
751 );
752
753 } else if (action.equals(ACTION_SYNC_FOLDER)) {
754 // Sync file
755 String remotePath = operationIntent.getStringExtra(EXTRA_REMOTE_PATH);
756 operation = new SynchronizeFolderOperation(
757 this, // TODO remove this dependency from construction time
758 remotePath,
759 account,
760 System.currentTimeMillis() // TODO remove this dependency from construction time
761 );
762
763 } else if (action.equals(ACTION_MOVE_FILE)) {
764 // Move file/folder
765 String remotePath = operationIntent.getStringExtra(EXTRA_REMOTE_PATH);
766 String newParentPath = operationIntent.getStringExtra(EXTRA_NEW_PARENT_PATH);
767 operation = new MoveFileOperation(remotePath,newParentPath,account);
768 }
769
770 }
771
772 } catch (IllegalArgumentException e) {
773 Log_OC.e(TAG, "Bad information provided in intent: " + e.getMessage());
774 operation = null;
775 }
776
777 if (operation != null) {
778 return new Pair<Target , RemoteOperation>(target, operation);
779 } else {
780 return null;
781 }
782 }
783
784
785 /**
786 * Sends a broadcast when a new operation is added to the queue.
787 *
788 * Local broadcasts are only delivered to activities in the same process, but can't be done sticky :\
789 *
790 * @param target Account or URL pointing to an OC server.
791 * @param operation Added operation.
792 */
793 private void sendBroadcastNewOperation(Target target, RemoteOperation operation) {
794 Intent intent = new Intent(ACTION_OPERATION_ADDED);
795 if (target.mAccount != null) {
796 intent.putExtra(EXTRA_ACCOUNT, target.mAccount);
797 } else {
798 intent.putExtra(EXTRA_SERVER_URL, target.mServerUrl);
799 }
800 //LocalBroadcastManager lbm = LocalBroadcastManager.getInstance(this);
801 //lbm.sendBroadcast(intent);
802 sendStickyBroadcast(intent);
803 }
804
805
806 // TODO - maybe add a notification for real start of operations
807
808 /**
809 * Sends a LOCAL broadcast when an operations finishes in order to the interested activities can update their view
810 *
811 * Local broadcasts are only delivered to activities in the same process.
812 *
813 * @param target Account or URL pointing to an OC server.
814 * @param operation Finished operation.
815 * @param result Result of the operation.
816 */
817 private void sendBroadcastOperationFinished(Target target, RemoteOperation operation, RemoteOperationResult result) {
818 Intent intent = new Intent(ACTION_OPERATION_FINISHED);
819 intent.putExtra(EXTRA_RESULT, result);
820 if (target.mAccount != null) {
821 intent.putExtra(EXTRA_ACCOUNT, target.mAccount);
822 } else {
823 intent.putExtra(EXTRA_SERVER_URL, target.mServerUrl);
824 }
825 //LocalBroadcastManager lbm = LocalBroadcastManager.getInstance(this);
826 //lbm.sendBroadcast(intent);
827 sendStickyBroadcast(intent);
828 }
829
830
831 /**
832 * Notifies the currently subscribed listeners about the end of an operation.
833 *
834 * @param target Account or URL pointing to an OC server.
835 * @param operation Finished operation.
836 * @param result Result of the operation.
837 */
838 private void dispatchResultToOperationListeners(
839 Target target, final RemoteOperation operation, final RemoteOperationResult result) {
840 int count = 0;
841 Iterator<OnRemoteOperationListener> listeners = mOperationsBinder.mBoundListeners.keySet().iterator();
842 while (listeners.hasNext()) {
843 final OnRemoteOperationListener listener = listeners.next();
844 final Handler handler = mOperationsBinder.mBoundListeners.get(listener);
845 if (handler != null) {
846 handler.post(new Runnable() {
847 @Override
848 public void run() {
849 listener.onRemoteOperationFinish(operation, result);
850 }
851 });
852 count += 1;
853 }
854 }
855 if (count == 0) {
856 //mOperationResults.put(operation.hashCode(), result);
857 Pair<RemoteOperation, RemoteOperationResult> undispatched =
858 new Pair<RemoteOperation, RemoteOperationResult>(operation, result);
859 mUndispatchedFinishedOperations.put(operation.hashCode(), undispatched);
860 }
861 Log_OC.d(TAG, "Called " + count + " listeners");
862 }
863 }