Java tutorial
/** * ownCloud Android client application * * @author masensio * @author David A. Velasco * @author Juan Carlos Gonzlez Cabrero * Copyright (C) 2015 ownCloud Inc. * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License version 2, * as published by the Free Software Foundation. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see <http://www.gnu.org/licenses/>. * */ package com.cerema.cloud2.files; import android.accounts.Account; import android.content.ActivityNotFoundException; import android.content.Context; import android.content.Intent; import android.content.pm.PackageManager; import android.content.pm.ResolveInfo; import android.net.Uri; import android.support.v4.app.DialogFragment; import android.webkit.MimeTypeMap; import android.widget.Toast; import com.cerema.cloud2.R; import com.cerema.cloud2.authentication.AccountUtils; import com.cerema.cloud2.datamodel.OCFile; import com.cerema.cloud2.files.services.FileDownloader.FileDownloaderBinder; import com.cerema.cloud2.files.services.FileUploader.FileUploaderBinder; import com.cerema.cloud2.lib.common.network.WebdavUtils; import com.cerema.cloud2.lib.common.utils.Log_OC; import com.cerema.cloud2.lib.resources.shares.OCShare; import com.cerema.cloud2.lib.resources.shares.ShareType; import com.cerema.cloud2.lib.resources.status.OwnCloudVersion; import com.cerema.cloud2.services.OperationsService; import com.cerema.cloud2.services.observer.FileObserverService; import com.cerema.cloud2.ui.activity.FileActivity; import com.cerema.cloud2.ui.activity.ShareActivity; import com.cerema.cloud2.ui.dialog.ShareLinkToDialog; import com.cerema.cloud2.ui.dialog.SharePasswordDialogFragment; import java.util.List; /** * */ public class FileOperationsHelper { private static final String TAG = FileOperationsHelper.class.getName(); private static final String FTAG_CHOOSER_DIALOG = "CHOOSER_DIALOG"; protected FileActivity mFileActivity = null; /// Identifier of operation in progress which result shouldn't be lost private long mWaitingForOpId = Long.MAX_VALUE; public FileOperationsHelper(FileActivity fileActivity) { mFileActivity = fileActivity; } public void openFile(OCFile file) { if (file != null) { String storagePath = file.getStoragePath(); String encodedStoragePath = WebdavUtils.encodePath(storagePath); Intent intentForSavedMimeType = new Intent(Intent.ACTION_VIEW); intentForSavedMimeType.setDataAndType(Uri.parse("file://" + encodedStoragePath), file.getMimetype()); intentForSavedMimeType .setFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION | Intent.FLAG_GRANT_WRITE_URI_PERMISSION); Intent intentForGuessedMimeType = null; if (storagePath.lastIndexOf('.') >= 0) { String guessedMimeType = MimeTypeMap.getSingleton() .getMimeTypeFromExtension(storagePath.substring(storagePath.lastIndexOf('.') + 1)); if (guessedMimeType != null && !guessedMimeType.equals(file.getMimetype())) { intentForGuessedMimeType = new Intent(Intent.ACTION_VIEW); intentForGuessedMimeType.setDataAndType(Uri.parse("file://" + encodedStoragePath), guessedMimeType); intentForGuessedMimeType.setFlags( Intent.FLAG_GRANT_READ_URI_PERMISSION | Intent.FLAG_GRANT_WRITE_URI_PERMISSION); } } Intent openFileWithIntent; if (intentForGuessedMimeType != null) { openFileWithIntent = intentForGuessedMimeType; } else { openFileWithIntent = intentForSavedMimeType; } List<ResolveInfo> launchables = mFileActivity.getPackageManager() .queryIntentActivities(openFileWithIntent, PackageManager.GET_INTENT_FILTERS); if (launchables != null && launchables.size() > 0) { try { mFileActivity.startActivity(Intent.createChooser(openFileWithIntent, mFileActivity.getString(R.string.actionbar_open_with))); } catch (ActivityNotFoundException anfe) { showNoAppForFileTypeToast(mFileActivity.getApplicationContext()); } } else { showNoAppForFileTypeToast(mFileActivity.getApplicationContext()); } } else { Log_OC.wtf(TAG, "Trying to open a NULL OCFile"); } } /** * Displays a toast stating that no application could be found to open the file. * * @param context the context to be able to show a toast. */ private void showNoAppForFileTypeToast(Context context) { Toast.makeText(context, R.string.file_list_no_app_for_file_type, Toast.LENGTH_SHORT).show(); } /** * Helper method to share a file via a public link. Starts a request to do it in {@link OperationsService} * * @param file The file to share. * @param password Optional password to protect the public share. */ public void shareFileViaLink(OCFile file, String password) { if (isSharedSupported()) { if (file != null) { mFileActivity .showLoadingDialog(mFileActivity.getApplicationContext().getString(R.string.wait_a_moment)); Intent service = new Intent(mFileActivity, OperationsService.class); service.setAction(OperationsService.ACTION_CREATE_SHARE_VIA_LINK); service.putExtra(OperationsService.EXTRA_ACCOUNT, mFileActivity.getAccount()); if (password != null && password.length() > 0) { service.putExtra(OperationsService.EXTRA_SHARE_PASSWORD, password); } service.putExtra(OperationsService.EXTRA_REMOTE_PATH, file.getRemotePath()); mWaitingForOpId = mFileActivity.getOperationsServiceBinder().queueNewOperation(service); } else { Log_OC.wtf(TAG, "Trying to share a NULL OCFile"); // TODO user-level error? } } else { // Show a Message Toast t = Toast.makeText(mFileActivity, mFileActivity.getString(R.string.share_link_no_support_share_api), Toast.LENGTH_LONG); t.show(); } } public void getFileWithLink(OCFile file) { if (isSharedSupported()) { if (file != null) { mFileActivity .showLoadingDialog(mFileActivity.getApplicationContext().getString(R.string.wait_a_moment)); Intent service = new Intent(mFileActivity, OperationsService.class); service.setAction(OperationsService.ACTION_CREATE_SHARE_VIA_LINK); service.putExtra(OperationsService.EXTRA_ACCOUNT, mFileActivity.getAccount()); service.putExtra(OperationsService.EXTRA_REMOTE_PATH, file.getRemotePath()); mWaitingForOpId = mFileActivity.getOperationsServiceBinder().queueNewOperation(service); } else { Log_OC.wtf(TAG, "Trying to share a NULL OCFile"); } } else { // Show a Message Toast t = Toast.makeText(mFileActivity, mFileActivity.getString(R.string.share_link_no_support_share_api), Toast.LENGTH_LONG); t.show(); } } public void shareFileWithLinkToApp(OCFile file, String password, Intent sendIntent) { if (file != null) { mFileActivity .showLoadingDialog(mFileActivity.getApplicationContext().getString(R.string.wait_a_moment)); Intent service = new Intent(mFileActivity, OperationsService.class); service.setAction(OperationsService.ACTION_CREATE_SHARE_VIA_LINK); service.putExtra(OperationsService.EXTRA_ACCOUNT, mFileActivity.getAccount()); service.putExtra(OperationsService.EXTRA_REMOTE_PATH, file.getRemotePath()); service.putExtra(OperationsService.EXTRA_SHARE_PASSWORD, password); service.putExtra(OperationsService.EXTRA_SEND_INTENT, sendIntent); mWaitingForOpId = mFileActivity.getOperationsServiceBinder().queueNewOperation(service); } else { Log_OC.wtf(TAG, "Trying to open a NULL OCFile"); } } /** * Helper method to share a file with a known sharee. Starts a request to do it in {@link OperationsService} * * @param file The file to share. * @param shareeName Name (user name or group name) of the target sharee. * @param shareType The share type determines the sharee type. * @param permissions Permissions to grant to sharee on the shared file. */ public void shareFileWithSharee(OCFile file, String shareeName, ShareType shareType, int permissions) { if (file != null) { // TODO check capability? mFileActivity .showLoadingDialog(mFileActivity.getApplicationContext().getString(R.string.wait_a_moment)); Intent service = new Intent(mFileActivity, OperationsService.class); service.setAction(OperationsService.ACTION_CREATE_SHARE_WITH_SHAREE); service.putExtra(OperationsService.EXTRA_ACCOUNT, mFileActivity.getAccount()); service.putExtra(OperationsService.EXTRA_REMOTE_PATH, file.getRemotePath()); service.putExtra(OperationsService.EXTRA_SHARE_WITH, shareeName); service.putExtra(OperationsService.EXTRA_SHARE_TYPE, shareType); service.putExtra(OperationsService.EXTRA_SHARE_PERMISSIONS, permissions); mWaitingForOpId = mFileActivity.getOperationsServiceBinder().queueNewOperation(service); } else { Log_OC.wtf(TAG, "Trying to share a NULL OCFile"); } } /** * @return 'True' if the server supports the Share API */ public boolean isSharedSupported() { if (mFileActivity.getAccount() != null) { OwnCloudVersion serverVersion = AccountUtils.getServerVersion(mFileActivity.getAccount()); return (serverVersion != null && serverVersion.isSharedSupported()); } return false; } /** * Helper method to unshare a file publicly shared via link. * Starts a request to do it in {@link OperationsService} * * @param file The file to unshare. */ public void unshareFileViaLink(OCFile file) { // Unshare the file: Create the intent Intent unshareService = new Intent(mFileActivity, OperationsService.class); unshareService.setAction(OperationsService.ACTION_UNSHARE); unshareService.putExtra(OperationsService.EXTRA_ACCOUNT, mFileActivity.getAccount()); unshareService.putExtra(OperationsService.EXTRA_REMOTE_PATH, file.getRemotePath()); unshareService.putExtra(OperationsService.EXTRA_SHARE_TYPE, ShareType.PUBLIC_LINK); unshareService.putExtra(OperationsService.EXTRA_SHARE_WITH, ""); queueShareIntent(unshareService); } public void unshareFileWithUserOrGroup(OCFile file, ShareType shareType, String userOrGroup) { // Unshare the file: Create the intent Intent unshareService = new Intent(mFileActivity, OperationsService.class); unshareService.setAction(OperationsService.ACTION_UNSHARE); unshareService.putExtra(OperationsService.EXTRA_ACCOUNT, mFileActivity.getAccount()); unshareService.putExtra(OperationsService.EXTRA_REMOTE_PATH, file.getRemotePath()); unshareService.putExtra(OperationsService.EXTRA_SHARE_TYPE, shareType); unshareService.putExtra(OperationsService.EXTRA_SHARE_WITH, userOrGroup); queueShareIntent(unshareService); } private void queueShareIntent(Intent shareIntent) { if (isSharedSupported()) { // Unshare the file mWaitingForOpId = mFileActivity.getOperationsServiceBinder().queueNewOperation(shareIntent); mFileActivity .showLoadingDialog(mFileActivity.getApplicationContext().getString(R.string.wait_a_moment)); } else { // Show a Message Toast t = Toast.makeText(mFileActivity, mFileActivity.getString(R.string.share_link_no_support_share_api), Toast.LENGTH_LONG); t.show(); } } /** * Show an instance of {@link ShareType} for sharing or unsharing the {@OCFile} received as parameter. * * @param file File to share or unshare. */ public void showShareFile(OCFile file) { Intent intent = new Intent(mFileActivity, ShareActivity.class); intent.putExtra(mFileActivity.EXTRA_FILE, file); intent.putExtra(mFileActivity.EXTRA_ACCOUNT, mFileActivity.getAccount()); mFileActivity.startActivity(intent); } /** * Starts a dialog that requests a password to the user to protect a share link. * * @param file File which public share will be protected by the requested password * @param createShare When 'true', the request for password will be followed by the creation of a new * public link; when 'false', a public share is assumed to exist, and the password * is bound to it. */ public void requestPasswordForShareViaLink(OCFile file, boolean createShare) { SharePasswordDialogFragment dialog = SharePasswordDialogFragment.newInstance(file, createShare); dialog.show(mFileActivity.getSupportFragmentManager(), SharePasswordDialogFragment.PASSWORD_FRAGMENT); } /** * Updates a public share on a file to set its password. * Starts a request to do it in {@link OperationsService} * * @param file File which public share will be protected with a password. * @param password Password to set for the public link; null or empty string to clear * the current password */ public void setPasswordToShareViaLink(OCFile file, String password) { // Set password updating share Intent updateShareIntent = new Intent(mFileActivity, OperationsService.class); updateShareIntent.setAction(OperationsService.ACTION_UPDATE_SHARE); updateShareIntent.putExtra(OperationsService.EXTRA_ACCOUNT, mFileActivity.getAccount()); updateShareIntent.putExtra(OperationsService.EXTRA_REMOTE_PATH, file.getRemotePath()); updateShareIntent.putExtra(OperationsService.EXTRA_SHARE_PASSWORD, (password == null) ? "" : password); queueShareIntent(updateShareIntent); } /** * Updates a public share on a file to set its expiration date. * Starts a request to do it in {@link OperationsService} * * @param file File which public share will be constrained with an expiration date. * @param expirationTimeInMillis Expiration date to set. A negative value clears the current expiration * date, leaving the link unrestricted. Zero makes no change. */ public void setExpirationDateToShareViaLink(OCFile file, long expirationTimeInMillis) { Intent updateShareIntent = new Intent(mFileActivity, OperationsService.class); updateShareIntent.setAction(OperationsService.ACTION_UPDATE_SHARE); updateShareIntent.putExtra(OperationsService.EXTRA_ACCOUNT, mFileActivity.getAccount()); updateShareIntent.putExtra(OperationsService.EXTRA_REMOTE_PATH, file.getRemotePath()); updateShareIntent.putExtra(OperationsService.EXTRA_SHARE_EXPIRATION_DATE_IN_MILLIS, expirationTimeInMillis); queueShareIntent(updateShareIntent); } /** * Updates a share on a file to set its access permissions. * Starts a request to do it in {@link OperationsService} * * @param share {@link OCShare} instance which permissions will be updated. * @param permissions New permissions to set. A value <= 0 makes no update. */ public void setPermissionsToShare(OCShare share, int permissions) { Intent updateShareIntent = new Intent(mFileActivity, OperationsService.class); updateShareIntent.setAction(OperationsService.ACTION_UPDATE_SHARE); updateShareIntent.putExtra(OperationsService.EXTRA_ACCOUNT, mFileActivity.getAccount()); updateShareIntent.putExtra(OperationsService.EXTRA_SHARE_ID, share.getId()); updateShareIntent.putExtra(OperationsService.EXTRA_SHARE_PERMISSIONS, permissions); queueShareIntent(updateShareIntent); } /** * Updates a public share on a folder to set its editing permission. * Starts a request to do it in {@link OperationsService} * * @param folder Folder which editing permission of his public share will be modified. * @param uploadPermission New state of the permission for editing the folder shared via link. */ public void setUploadPermissionsToShare(OCFile folder, boolean uploadPermission) { Intent updateShareIntent = new Intent(mFileActivity, OperationsService.class); updateShareIntent.setAction(OperationsService.ACTION_UPDATE_SHARE); updateShareIntent.putExtra(OperationsService.EXTRA_ACCOUNT, mFileActivity.getAccount()); updateShareIntent.putExtra(OperationsService.EXTRA_REMOTE_PATH, folder.getRemotePath()); updateShareIntent.putExtra(OperationsService.EXTRA_SHARE_PUBLIC_UPLOAD, uploadPermission); queueShareIntent(updateShareIntent); } /** * @return 'True' if the server supports the Search Users API */ public boolean isSearchUsersSupportedSupported() { if (mFileActivity.getAccount() != null) { OwnCloudVersion serverVersion = AccountUtils.getServerVersion(mFileActivity.getAccount()); return (serverVersion != null && serverVersion.isSearchUsersSupported()); } return false; } public void sendDownloadedFile(OCFile file) { if (file != null) { String storagePath = file.getStoragePath(); String encodedStoragePath = WebdavUtils.encodePath(storagePath); Intent sendIntent = new Intent(android.content.Intent.ACTION_SEND); // set MimeType sendIntent.setType(file.getMimetype()); sendIntent.putExtra(Intent.EXTRA_STREAM, Uri.parse("file://" + encodedStoragePath)); sendIntent.putExtra(Intent.ACTION_SEND, true); // Send Action // Show dialog, without the own app String[] packagesToExclude = new String[] { mFileActivity.getPackageName() }; DialogFragment chooserDialog = ShareLinkToDialog.newInstance(sendIntent, packagesToExclude); chooserDialog.show(mFileActivity.getSupportFragmentManager(), FTAG_CHOOSER_DIALOG); } else { Log_OC.wtf(TAG, "Trying to send a NULL OCFile"); } } /** * Request the synchronization of a file or folder with the OC server, including its contents. * * @param file The file or folder to synchronize */ public void syncFile(OCFile file) { if (!file.isFolder()) { Intent intent = new Intent(mFileActivity, OperationsService.class); intent.setAction(OperationsService.ACTION_SYNC_FILE); intent.putExtra(OperationsService.EXTRA_ACCOUNT, mFileActivity.getAccount()); intent.putExtra(OperationsService.EXTRA_REMOTE_PATH, file.getRemotePath()); intent.putExtra(OperationsService.EXTRA_SYNC_FILE_CONTENTS, true); mWaitingForOpId = mFileActivity.getOperationsServiceBinder().queueNewOperation(intent); mFileActivity .showLoadingDialog(mFileActivity.getApplicationContext().getString(R.string.wait_a_moment)); } else { Intent intent = new Intent(mFileActivity, OperationsService.class); intent.setAction(OperationsService.ACTION_SYNC_FOLDER); intent.putExtra(OperationsService.EXTRA_ACCOUNT, mFileActivity.getAccount()); intent.putExtra(OperationsService.EXTRA_REMOTE_PATH, file.getRemotePath()); mFileActivity.startService(intent); } } public void toggleFavorite(OCFile file, boolean isFavorite) { file.setFavorite(isFavorite); mFileActivity.getStorageManager().saveFile(file); /// register the OCFile instance in the observer service to monitor local updates Intent observedFileIntent = FileObserverService.makeObservedFileIntent(mFileActivity, file, mFileActivity.getAccount(), isFavorite); mFileActivity.startService(observedFileIntent); /// immediate content synchronization if (file.isFavorite()) { syncFile(file); } } public void renameFile(OCFile file, String newFilename) { // RenameFile Intent service = new Intent(mFileActivity, OperationsService.class); service.setAction(OperationsService.ACTION_RENAME); service.putExtra(OperationsService.EXTRA_ACCOUNT, mFileActivity.getAccount()); service.putExtra(OperationsService.EXTRA_REMOTE_PATH, file.getRemotePath()); service.putExtra(OperationsService.EXTRA_NEWNAME, newFilename); mWaitingForOpId = mFileActivity.getOperationsServiceBinder().queueNewOperation(service); mFileActivity.showLoadingDialog(mFileActivity.getApplicationContext().getString(R.string.wait_a_moment)); } public void removeFile(OCFile file, boolean onlyLocalCopy) { // RemoveFile Intent service = new Intent(mFileActivity, OperationsService.class); service.setAction(OperationsService.ACTION_REMOVE); service.putExtra(OperationsService.EXTRA_ACCOUNT, mFileActivity.getAccount()); service.putExtra(OperationsService.EXTRA_REMOTE_PATH, file.getRemotePath()); service.putExtra(OperationsService.EXTRA_REMOVE_ONLY_LOCAL, onlyLocalCopy); mWaitingForOpId = mFileActivity.getOperationsServiceBinder().queueNewOperation(service); mFileActivity.showLoadingDialog(mFileActivity.getApplicationContext().getString(R.string.wait_a_moment)); } public void createFolder(String remotePath, boolean createFullPath) { // Create Folder Intent service = new Intent(mFileActivity, OperationsService.class); service.setAction(OperationsService.ACTION_CREATE_FOLDER); service.putExtra(OperationsService.EXTRA_ACCOUNT, mFileActivity.getAccount()); service.putExtra(OperationsService.EXTRA_REMOTE_PATH, remotePath); service.putExtra(OperationsService.EXTRA_CREATE_FULL_PATH, createFullPath); mWaitingForOpId = mFileActivity.getOperationsServiceBinder().queueNewOperation(service); mFileActivity.showLoadingDialog(mFileActivity.getApplicationContext().getString(R.string.wait_a_moment)); } /** * Cancel the transference in downloads (files/folders) and file uploads * @param file OCFile */ public void cancelTransference(OCFile file) { Account account = mFileActivity.getAccount(); if (file.isFolder()) { OperationsService.OperationsServiceBinder opsBinder = mFileActivity.getOperationsServiceBinder(); if (opsBinder != null) { opsBinder.cancel(account, file); } } // for both files and folders FileDownloaderBinder downloaderBinder = mFileActivity.getFileDownloaderBinder(); if (downloaderBinder != null && downloaderBinder.isDownloading(account, file)) { downloaderBinder.cancel(account, file); } FileUploaderBinder uploaderBinder = mFileActivity.getFileUploaderBinder(); if (uploaderBinder != null && uploaderBinder.isUploading(account, file)) { uploaderBinder.cancel(account, file); } } /** * Start move file operation * * @param newfile File where it is going to be moved * @param currentFile File with the previous info */ public void moveFile(OCFile newfile, OCFile currentFile) { // Move files Intent service = new Intent(mFileActivity, OperationsService.class); service.setAction(OperationsService.ACTION_MOVE_FILE); service.putExtra(OperationsService.EXTRA_NEW_PARENT_PATH, newfile.getRemotePath()); service.putExtra(OperationsService.EXTRA_REMOTE_PATH, currentFile.getRemotePath()); service.putExtra(OperationsService.EXTRA_ACCOUNT, mFileActivity.getAccount()); mWaitingForOpId = mFileActivity.getOperationsServiceBinder().queueNewOperation(service); mFileActivity.showLoadingDialog(mFileActivity.getApplicationContext().getString(R.string.wait_a_moment)); } /** * Start copy file operation * * @param newfile File where it is going to be moved * @param currentFile File with the previous info */ public void copyFile(OCFile newfile, OCFile currentFile) { // Copy files Intent service = new Intent(mFileActivity, OperationsService.class); service.setAction(OperationsService.ACTION_COPY_FILE); service.putExtra(OperationsService.EXTRA_NEW_PARENT_PATH, newfile.getRemotePath()); service.putExtra(OperationsService.EXTRA_REMOTE_PATH, currentFile.getRemotePath()); service.putExtra(OperationsService.EXTRA_ACCOUNT, mFileActivity.getAccount()); mWaitingForOpId = mFileActivity.getOperationsServiceBinder().queueNewOperation(service); mFileActivity.showLoadingDialog(mFileActivity.getApplicationContext().getString(R.string.wait_a_moment)); } public long getOpIdWaitingFor() { return mWaitingForOpId; } public void setOpIdWaitingFor(long waitingForOpId) { mWaitingForOpId = waitingForOpId; } /** * @return 'True' if the server doesn't need to check forbidden characters */ public boolean isVersionWithForbiddenCharacters() { if (mFileActivity.getAccount() != null) { OwnCloudVersion serverVersion = AccountUtils.getServerVersion(mFileActivity.getAccount()); return (serverVersion != null && serverVersion.isVersionWithForbiddenCharacters()); } return false; } }