src/com/owncloud/android/operations/ExistenceCheckOperation.java

   1 /* ownCloud Android client application
   2  *   Copyright (C) 2012 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.operations;
  19
  20 import org.apache.commons.httpclient.HttpStatus;
  21 import org.apache.commons.httpclient.methods.HeadMethod;
  22
  23 import com.owncloud.android.Log_OC;
  24
  25
  26 import eu.alefzero.webdav.WebdavClient;
  27 import eu.alefzero.webdav.WebdavUtils;
  28 import android.content.Context;
  29 import android.net.ConnectivityManager;
  30
  31 /**
  32  * Operation to check the existence or absence of a path in a remote server.
  33  *
  34  * @author David A. Velasco
  35  */
  36 public class ExistenceCheckOperation extends RemoteOperation {
  37
  38     /** Maximum time to wait for a response from the server in MILLISECONDs.  */
  39     public static final int TIMEOUT = 10000;
  40
  41     private static final String TAG = ExistenceCheckOperation.class.getSimpleName();
  42
  43     private String mPath;
  44     private Context mContext;
  45     private boolean mSuccessIfAbsent;
  46
  47
  48     /**
  49      * Full constructor. Success of the operation will depend upon the value of successIfAbsent.
  50      *
  51      * @param path              Path to append to the URL owned by the client instance.
  52      * @param context           Android application context.
  53      * @param successIfAbsent   When 'true', the operation finishes in success if the path does NOT exist in the remote server (HTTP 404).
  54      */
  55     public ExistenceCheckOperation(String path, Context context, boolean successIfAbsent) {
  56         mPath = (path != null) ? path : "";
  57         mContext = context;
  58         mSuccessIfAbsent = successIfAbsent;
  59     }
  60
  61
  62         @Override
  63         protected RemoteOperationResult run(WebdavClient client) {
  64         if (!isOnline()) {
  65             return new RemoteOperationResult(RemoteOperationResult.ResultCode.NO_NETWORK_CONNECTION);
  66         }
  67         RemoteOperationResult result = null;
  68         HeadMethod head = null;
  69         try {
  70             head = new HeadMethod(client.getBaseUri() + WebdavUtils.encodePath(mPath));
  71             int status = client.executeMethod(head, TIMEOUT, TIMEOUT);
  72             client.exhaustResponse(head.getResponseBodyAsStream());
  73             boolean success = (status == HttpStatus.SC_OK && !mSuccessIfAbsent) || (status == HttpStatus.SC_NOT_FOUND && mSuccessIfAbsent);
  74             result = new RemoteOperationResult(success, status, head.getResponseHeaders());
  75             Log_OC.d(TAG, "Existence check for " + client.getBaseUri() + WebdavUtils.encodePath(mPath) + " targeting for " + (mSuccessIfAbsent ? " absence " : " existence ") + "finished with HTTP status " + status + (!success?"(FAIL)":""));
  76
  77         } catch (Exception e) {
  78             result = new RemoteOperationResult(e);
  79             Log_OC.e(TAG, "Existence check for " + client.getBaseUri() + WebdavUtils.encodePath(mPath) + " targeting for " + (mSuccessIfAbsent ? " absence " : " existence ") + ": " + result.getLogMessage(), result.getException());
  80
  81         } finally {
  82             if (head != null)
  83                 head.releaseConnection();
  84         }
  85         return result;
  86         }
  87
  88     private boolean isOnline() {
  89         ConnectivityManager cm = (ConnectivityManager) mContext
  90                 .getSystemService(Context.CONNECTIVITY_SERVICE);
  91         return cm != null && cm.getActiveNetworkInfo() != null
  92                 && cm.getActiveNetworkInfo().isConnectedOrConnecting();
  93     }
  94
  95
  96 }