rename DbHandler to UploadDbHandler. Increase DB version. Fix UploadStatus enum.

src/com/owncloud/android/db/DbHandler.java → src/com/owncloud/android/db/UploadDbHandler.java

@@ -27,22 +27,32 @@ import android.database.sqlite.SQLiteDatabase;
 import android.database.sqlite.SQLiteOpenHelper;
 
 /**
- * Custom database helper for ownCloud
+ * Database helper for storing list of files to be uploaded, including status information for each file.
  * 
  * @author Bartek Przybylski
+ * @author LukeOwncloud
  * 
  */
-public class DbHandler {
+public class UploadDbHandler {
     private SQLiteDatabase mDB;
     private OpenerHelper mHelper;
     private final String mDatabaseName;
-    private final int mDatabaseVersion = 3;
+    private final int mDatabaseVersion = 4;
 
-    private final String TABLE_INSTANT_UPLOAD = "instant_upload";
+    static private final String TABLE_UPLOAD = "list_of_uploads";
 
-    public enum UploadStatus {UPLOAD_STATUS_UPLOAD_LATER, UPLOAD_STATUS_UPLOAD_FAILED};
+    public enum UploadStatus {
+        UPLOAD_STATUS_UPLOAD_LATER(0), UPLOAD_STATUS_UPLOAD_FAILED(1);
+        private final int value;
+        private UploadStatus(int value) {
+            this.value = value;
+        }
+        public int getValue() {
+            return value;
+        }
+    };
     
-    public DbHandler(Context context) {
+    public UploadDbHandler(Context context) {
         mDatabaseName = MainApp.getDBName();
         mHelper = new OpenerHelper(context);
         mDB = mHelper.getWritableDatabase();
@@ -53,42 +63,46 @@ public class DbHandler {
     }
 
     /**
-     * Store a file persistantly for upload.
-     * @param filepath
-     * @param account
-     * @param message
-     * @return
+     * Store a file persistently for upload.
+     * @param filepath local file path to file
+     * @param account account for uploading
+     * @param message optional message. can be null.
+     * @return false if an error occurred, else true. 
      */
     public boolean putFileForLater(String filepath, String account, String message) {
         ContentValues cv = new ContentValues();
         cv.put("path", filepath);
         cv.put("account", account);
-        cv.put("attempt", String.valueOf(UploadStatus.UPLOAD_STATUS_UPLOAD_LATER));
+        cv.put("attempt", UploadStatus.UPLOAD_STATUS_UPLOAD_LATER.getValue());
         cv.put("message", message);
-        long result = mDB.insert(TABLE_INSTANT_UPLOAD, null, cv);
-        Log_OC.d(TABLE_INSTANT_UPLOAD, "putFileForLater returns with: " + result + " for file: " + filepath);
+        long result = mDB.insert(TABLE_UPLOAD, null, cv);
+        Log_OC.d(TABLE_UPLOAD, "putFileForLater returns with: " + result + " for file: " + filepath);
         return result != -1;
     }
 
     /**
      * Update upload status of file.
      * 
-     * @param filepath
-     * @param status
-     * @param message
-     * @return
+     * @param filepath local file path to file. used as identifier.
+     * @param status new status.
+     * @param message new message.
+     * @return 1 if file status was updated, else 0.
      */
     public int updateFileState(String filepath, UploadStatus status, String message) {
         ContentValues cv = new ContentValues();
-        cv.put("attempt", String.valueOf(status));
+        cv.put("attempt", status.getValue());
         cv.put("message", message);
-        int result = mDB.update(TABLE_INSTANT_UPLOAD, cv, "path=?", new String[] { filepath });
-        Log_OC.d(TABLE_INSTANT_UPLOAD, "updateFileState returns with: " + result + " for file: " + filepath);
+        int result = mDB.update(TABLE_UPLOAD, cv, "path=?", new String[] { filepath });
+        Log_OC.d(TABLE_UPLOAD, "updateFileState returns with: " + result + " for file: " + filepath);
         return result;
     }
 
+    /**
+     * Get all files with status {@link UploadStatus}.UPLOAD_STATUS_UPLOAD_LATER.
+     * @return
+     */
     public Cursor getAwaitingFiles() {
-        return mDB.query(TABLE_INSTANT_UPLOAD, null, "attempt=" + UploadStatus.UPLOAD_STATUS_UPLOAD_LATER, null, null, null, null);
+        return mDB.query(TABLE_UPLOAD, null, "attempt=" + UploadStatus.UPLOAD_STATUS_UPLOAD_LATER, null, null, null, null);
     }
 
   //ununsed until now. uncomment if needed.
@@ -107,8 +121,8 @@ public class DbHandler {
      * @return true when one or more pending files was removed
      */
     public boolean removePendingFile(String localPath) {
-        long result = mDB.delete(TABLE_INSTANT_UPLOAD, "path = ?", new String[] { localPath });
-        Log_OC.d(TABLE_INSTANT_UPLOAD, "delete returns with: " + result + " for file: " + localPath);
+        long result = mDB.delete(TABLE_UPLOAD, "path = ?", new String[] { localPath });
+        Log_OC.d(TABLE_UPLOAD, "delete returns with: " + result + " for file: " + localPath);
         return result != 0;
 
     }
@@ -120,16 +134,16 @@ public class DbHandler {
 
         @Override
         public void onCreate(SQLiteDatabase db) {
-            db.execSQL("CREATE TABLE " + TABLE_INSTANT_UPLOAD + " (" + " _id INTEGER PRIMARY KEY, " + " path TEXT,"
+            db.execSQL("CREATE TABLE " + TABLE_UPLOAD + " (" + " _id INTEGER PRIMARY KEY, " + " path TEXT,"
                     + " account TEXT,attempt INTEGER,message TEXT);");
         }
 
         @Override
         public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
             if (oldVersion < 2) {
-                db.execSQL("ALTER TABLE " + TABLE_INSTANT_UPLOAD + " ADD COLUMN attempt INTEGER;");
+                db.execSQL("ALTER TABLE " + TABLE_UPLOAD + " ADD COLUMN attempt INTEGER;");
             }
-            db.execSQL("ALTER TABLE " + TABLE_INSTANT_UPLOAD + " ADD COLUMN message TEXT;");
+            db.execSQL("ALTER TABLE " + TABLE_UPLOAD + " ADD COLUMN message TEXT;");
 
         }
     }

src/com/owncloud/android/files/InstantUploadBroadcastReceiver.java

@@ -22,7 +22,7 @@ import java.io.File;
 
 import com.owncloud.android.MainApp;
 import com.owncloud.android.authentication.AccountUtils;
-import com.owncloud.android.db.DbHandler;
+import com.owncloud.android.db.UploadDbHandler;
 import com.owncloud.android.files.services.FileUploader;
 import com.owncloud.android.lib.common.utils.Log_OC;
 import com.owncloud.android.utils.FileStorageUtils;
@@ -105,7 +105,7 @@ public class InstantUploadBroadcastReceiver extends BroadcastReceiver {
         Log_OC.d(TAG, file_path + "");
 
         // save always temporally the picture to upload
-        DbHandler db = new DbHandler(context);
+        UploadDbHandler db = new UploadDbHandler(context);
         db.putFileForLater(file_path, account.name, null);
         db.close();
 
@@ -178,7 +178,7 @@ public class InstantUploadBroadcastReceiver extends BroadcastReceiver {
         if (!intent.hasExtra(ConnectivityManager.EXTRA_NO_CONNECTIVITY)
                 && isOnline(context)
                 && (!instantPictureUploadViaWiFiOnly(context) || (instantPictureUploadViaWiFiOnly(context) == isConnectedViaWiFi(context) == true))) {
-            DbHandler db = new DbHandler(context);
+            UploadDbHandler db = new UploadDbHandler(context);
             Cursor c = db.getAwaitingFiles();
             if (c.moveToFirst()) {
                 do {

src/com/owncloud/android/files/services/FileUploader.java

@@ -50,7 +50,7 @@ import com.owncloud.android.authentication.AccountUtils;
 import com.owncloud.android.authentication.AuthenticatorActivity;
 import com.owncloud.android.datamodel.FileDataStorageManager;
 import com.owncloud.android.datamodel.OCFile;
-import com.owncloud.android.db.DbHandler;
+import com.owncloud.android.db.UploadDbHandler;
 import com.owncloud.android.lib.common.OwnCloudAccount;
 import com.owncloud.android.lib.common.OwnCloudClient;
 import com.owncloud.android.lib.common.OwnCloudClientManagerFactory;
@@ -770,9 +770,9 @@ public class FileUploader extends Service {
                 mNotificationBuilder.setContentText(content);
     
                 if (upload.isInstant()) {
-                    DbHandler db = null;
+                    UploadDbHandler db = null;
                     try {
-                        db = new DbHandler(this.getBaseContext());
+                        db = new UploadDbHandler(this.getBaseContext());
                         String message = uploadResult.getLogMessage() + " errorCode: " +
                                 uploadResult.getCode();
                         Log_OC.e(TAG, message + " Http-Code: " + uploadResult.getHttpCode());
@@ -780,7 +780,7 @@ public class FileUploader extends Service {
                             //message = getString(R.string.failed_upload_quota_exceeded_text);
                             if (db.updateFileState(
                                     upload.getOriginalStoragePath(), 
-                                    DbHandler.UploadStatus.UPLOAD_STATUS_UPLOAD_FAILED,
+                                    UploadDbHandler.UploadStatus.UPLOAD_STATUS_UPLOAD_FAILED,
                                     message) == 0) {
                                 db.putFileForLater(
                                         upload.getOriginalStoragePath(), 
@@ -802,7 +802,7 @@ public class FileUploader extends Service {
             
             if (uploadResult.isSuccess()) {
                 
-                DbHandler db = new DbHandler(this.getBaseContext());
+                UploadDbHandler db = new UploadDbHandler(this.getBaseContext());
                 db.removePendingFile(mCurrentUpload.getOriginalStoragePath());
                 db.close();
 

src/com/owncloud/android/ui/activity/Preferences.java

@@ -50,7 +50,7 @@ import com.owncloud.android.MainApp;
 import com.owncloud.android.R;
 import com.owncloud.android.authentication.AccountUtils;
 import com.owncloud.android.authentication.AuthenticatorActivity;
-import com.owncloud.android.db.DbHandler;
+import com.owncloud.android.db.UploadDbHandler;
 import com.owncloud.android.lib.common.utils.Log_OC;
 import com.owncloud.android.ui.LongClickableCheckBoxPreference;
 import com.owncloud.android.utils.DisplayUtils;
@@ -66,7 +66,7 @@ public class Preferences extends SherlockPreferenceActivity implements AccountMa
     
     private static final String TAG = "OwnCloudPreferences";
 
-    private DbHandler mDbHandler;
+    private UploadDbHandler mDbHandler;
     private CheckBoxPreference pCode;
     private Preference pAboutApp;
 
@@ -81,7 +81,7 @@ public class Preferences extends SherlockPreferenceActivity implements AccountMa
     @Override
     public void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
-        mDbHandler = new DbHandler(getBaseContext());
+        mDbHandler = new UploadDbHandler(getBaseContext());
         addPreferencesFromResource(R.xml.preferences);
 
         ActionBar actionBar = getSherlock().getActionBar();