Implementing Trash Bin in Phimpme Android Application
In the Phimpme Android application, users can perform various operations/actions on the photos available, some of the important operations involve renaming an image, sharing an image, deleting image etc. However, when the user performs delete operation for image/images the images are permanently deleted from the storage and there is no option to restore/recover the deleted image. Now imagine a situation where the user accidentally or in a rush deletes photo/photos, and now there is no possible way for the user to recover those accidentally deleted photos, so in such circumstances, the Trash Bin feature could prove to be a breather for the user. So, in this blog post, I will be discussing the implementation of the Trash Bin feature.
Step 1
Firstly, we need to implement the functionality to move the images to bin folder whenever the delete operation is performed. For this, we’d programmatically create a folder naming it .nomedia, so that this folder is not picked up by any other similar application while scanning folders. Now when the user deletes images, a check would be performed first to determine whether the bin folder already exists or not and actions would be performed accordingly(a folder would be created if it doesn’t already exist and the selected photos for deletion would be moved to the bin folder or the deleted photos would be moved directly to the bin folder if its there). Code snippets used to implement the bin folder is provided below.
private boolean addToTrash(){ int no = 0; boolean succ = false; File file = new File(Environment.getExternalStorageDirectory() + “/” + “.nomedia”); if(file.exists() && file.isDirectory()){ if(!all_photos && !fav_photos && editMode){ no = getAlbum().moveSelectedMedia(getApplicationContext(), file.getAbsolutePath()); }else if(all_photos && !fav_photos && editMode){ no = getAlbum().moveAllMedia(getApplicationContext(), file.getAbsolutePath(), selectedMedias); }else if(!editMode && !all_photos && !fav_photos){ no = getAlbum().moveAllMedia(getApplicationContext(), file.getAbsolutePath(), getAlbum().getMedia()); } else{ if(file.mkdir()){ if(!all_photos && !fav_photos && editMode){ no = getAlbum().moveSelectedMedia(getApplicationContext(), file.getAbsolutePath()); }else if(all_photos && !fav_photos && editMode){ no = getAlbum().moveAllMedia(getApplicationContext(), file.getAbsolutePath(), selectedMedias); }else if(!editMode && !all_photos && !fav_photos){ no = getAlbum().moveAllMedia(getApplicationContext(), file.getAbsolutePath(), getAlbum().getMedia()); } // no = getAlbum().moveSelectedMedia(getApplicationContext(), file.getAbsolutePath()); } // clearSelectedPhotos(); return succ; } |
Step 2
Now if all the photos(selected by the user for deletion) are successfully moved to the bin folder, realm objects corresponding to those image files would be created and added to the realm database. The corresponding Realm object would consist of attributes namely oldpath, trashbinpath, time of delete and duration. The realm objects would be used at the time of implementing restore functionality for the trash bin images. The realm model class representing the Trash bin object is provided below.
public class TrashBinRealmModel extends RealmObject { @PrimaryKey private String trashbinpath; private String oldpath; private String datetime; private String timeperiod; public TrashBinRealmModel(){ } public TrashBinRealmModel(String oldpath, String newpath, String datetime, String timeperiod){ this.oldpath = oldpath; this.trashbinpath = newpath; this.datetime = datetime; this.timeperiod = timeperiod; } public void setTrashbinpath(String trashbinpath){ this.trashbinpath = trashbinpath; } public String getTrashbinpath(){ return trashbinpath; } public void setDatetime(String datetime){ this.datetime = datetime; } public String getDatetime(){ return datetime; } public void setOldpath(String oldpath){ this.oldpath = oldpath; } public String getOldpath(){ return oldpath; } public void setTimeperiod(String timeperiod){ this.timeperiod = timeperiod; } public String getTimeperiod(){ return timeperiod; } } |
The implementation for the function to add trash bin objects to Realm database is provided below.
for(int i = 0; i < media.size(); i++){ int index = media.get(i).getPath().lastIndexOf(“/”); String name = media.get(i).getPath().substring(index + 1); realm.beginTransaction(); String trashpath = trashbinpath + “/” + name; TrashBinRealmModel trashBinRealmModel = realm.createObject(TrashBinRealmModel.class, trashpath); trashBinRealmModel.setOldpath(media.get(i).getPath()); trashBinRealmModel.setDatetime(new SimpleDateFormat(“dd/MM/yyyy HH:mm:ss”).format(new Date())); trashBinRealmModel.setTimeperiod(“null”); realm.commitTransaction(); } |
Step 3
Now we need to provide an option to the user to navigate to the Trash bin section to perform the delete(permanently) or restore option. So for the aforementioned action, we’d be adding an option in the navigation drawer menu titled “Trash Bin” clicking on which the Trash Bin section would be displayed to the user. The XML code changes committed to implementing the option has been provided below.
<LinearLayout xmlns:android=“http://schemas.android.com/apk/res/android” android:id=“@+id/ll_drawer_trashbin” android:layout_width=“match_parent” android:layout_height=“wrap_content” android:background=“@drawable/ripple” android:clickable=“true” android:orientation=“horizontal”> <com.mikepenz.iconics.view.IconicsImageView android:id=“@+id/Drawer_trash_Icon” android:layout_width=“@dimen/icon_width_height” android:layout_height=“@dimen/icon_width_height” android:layout_gravity=“center_vertical” android:layout_marginLeft=“@dimen/big_spacing” android:layout_marginRight=“@dimen/big_spacing” app:iiv_icon=“gmd-file-upload”/> <TextView android:id=“@+id/Drawer_trash_Item” android:layout_width=“wrap_content” android:layout_height=“wrap_content” android:paddingBottom=“16dp” android:paddingTop=“16dp” android:text=“Trash Bin” android:textColor=“@color/md_dark_background” android:textSize=“16sp”/> </LinearLayout> |
This is how we have implemented the functionality to rename an image in the Phimpme Android application. To get the full source code, please refer to the Phimpme Android Github repository listed in the resource section below.
Resources
1. Android Developer documentation –https://developer.android.com/reference/java/io/File
2. Github-Phimpme Android Repository –https://github.com/fossasia/phimpme-android/
3. Realm for Android tutorial –https://www.androidhive.info/2016/05/android-working-with-realm-database-replacing-sqlite-core-data/
4. Hiding directories using .nomedia file –http://www.easycodeway.com/2016/08/hide-files-in-android-using-nomedia-file.html