Java tutorial
/* * Copyright 2015 OpenMarket Ltd * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package im.vector.activity; import android.annotation.SuppressLint; import android.app.Activity; import android.app.AlarmManager; import android.app.AlertDialog; import android.app.DownloadManager; import android.app.PendingIntent; import android.content.ActivityNotFoundException; import android.content.Context; import android.content.DialogInterface; import android.content.Intent; import android.net.Uri; import android.os.Build; import android.os.Environment; import android.preference.PreferenceManager; import android.support.v4.app.FragmentActivity; import android.support.v4.app.FragmentManager; import android.text.TextUtils; import android.util.Log; import android.widget.ArrayAdapter; import android.widget.EditText; import android.widget.Toast; import org.matrix.androidsdk.MXSession; import org.matrix.androidsdk.data.Room; import org.matrix.androidsdk.data.RoomState; import org.matrix.androidsdk.data.RoomSummary; import org.matrix.androidsdk.db.MXMediasCache; import org.matrix.androidsdk.rest.callback.ApiCallback; import org.matrix.androidsdk.rest.callback.SimpleApiCallback; import org.matrix.androidsdk.rest.model.MatrixError; import org.matrix.androidsdk.rest.model.RoomMember; import im.vector.VectorApp; import im.vector.Matrix; import im.vector.MyPresenceManager; import im.vector.R; import im.vector.contacts.ContactsManager; import im.vector.contacts.PIDsRetriever; import im.vector.fragments.AccountsSelectionDialogFragment; import im.vector.services.EventStreamService; import im.vector.util.RageShake; import java.io.File; import java.io.FileInputStream; import java.io.FileOutputStream; import java.util.ArrayList; import java.util.Collection; import java.util.Collections; import java.util.Comparator; import me.leolin.shortcutbadger.ShortcutBadger; /** * Contains useful functions which are called in multiple activities. */ public class CommonActivityUtils { private static final String LOG_TAG = "CommonActivityUtils"; public static void logout(Activity activity, MXSession session, Boolean clearCredentials) { // stop the service EventStreamService eventStreamService = EventStreamService.getInstance(); ArrayList<String> matrixIds = new ArrayList<String>(); matrixIds.add(session.getMyUser().userId); eventStreamService.stopAccounts(matrixIds); // Publish to the server that we're now offline MyPresenceManager.getInstance(activity, session).advertiseOffline(); MyPresenceManager.remove(session); // unregister from the GCM. Matrix.getInstance(activity).getSharedGcmRegistrationManager().unregisterSession(session, null); // clear credentials Matrix.getInstance(activity).clearSession(activity, session, clearCredentials); } public static Boolean shouldRestartApp() { EventStreamService eventStreamService = EventStreamService.getInstance(); return !Matrix.hasValidSessions() || (null == eventStreamService); } /** * Restart the application after 100ms * @param activity activity */ public static void restartApp(Context activity) { PendingIntent mPendingIntent = PendingIntent.getActivity(activity, 314159, new Intent(activity, LoginActivity.class), PendingIntent.FLAG_CANCEL_CURRENT); // so restart the application after 100ms AlarmManager mgr = (AlarmManager) activity.getSystemService(activity.ALARM_SERVICE); mgr.set(AlarmManager.RTC, System.currentTimeMillis() + 50, mPendingIntent); System.exit(0); } /** * Logout the current user. * @param activity the caller activity */ public static void logout(Activity activity) { stopEventStream(activity); try { ShortcutBadger.setBadge(activity, 0); } catch (Exception e) { } // warn that the user logs out Collection<MXSession> sessions = Matrix.getMXSessions(activity); for (MXSession session : sessions) { // Publish to the server that we're now offline MyPresenceManager.getInstance(activity, session).advertiseOffline(); MyPresenceManager.remove(session); } // clear the preferences PreferenceManager.getDefaultSharedPreferences(activity).edit().clear().commit(); // clear credentials Matrix.getInstance(activity).clearSessions(activity, true); // reset the GCM Matrix.getInstance(activity).getSharedGcmRegistrationManager().reset(); // reset the contacts PIDsRetriever.getIntance().reset(); ContactsManager.reset(); MXMediasCache.clearThumbnailsCache(activity); // go to login page activity.startActivity(new Intent(activity, LoginActivity.class)); activity.finish(); } public static void disconnect(Activity activity) { stopEventStream(activity); activity.finish(); Matrix.getInstance(activity).mHasBeenDisconnected = true; } private static void sendEventStreamAction(Context context, EventStreamService.StreamAction action) { Context appContext = context.getApplicationContext(); // kill active connections Intent killStreamService = new Intent(appContext, EventStreamService.class); killStreamService.putExtra(EventStreamService.EXTRA_STREAM_ACTION, action.ordinal()); appContext.startService(killStreamService); } public static void stopEventStream(Context context) { Log.d(LOG_TAG, "stopEventStream"); sendEventStreamAction(context, EventStreamService.StreamAction.STOP); } public static void pauseEventStream(Context context) { Log.d(LOG_TAG, "pauseEventStream"); sendEventStreamAction(context, EventStreamService.StreamAction.PAUSE); } public static void resumeEventStream(Context context) { Log.d(LOG_TAG, "resumeEventStream"); sendEventStreamAction(context, EventStreamService.StreamAction.RESUME); } public static void catchupEventStream(Context context) { if (VectorApp.isAppInBackground()) { Log.d(LOG_TAG, "catchupEventStream"); sendEventStreamAction(context, EventStreamService.StreamAction.CATCHUP); } } public static void onGcmUpdate(Context context) { Log.d(LOG_TAG, "onGcmUpdate"); sendEventStreamAction(context, EventStreamService.StreamAction.GCM_STATUS_UPDATE); } public static void startEventStreamService(Context context) { // the events stream service is launched // either the application has never be launched // or the service has been killed on low memory if (EventStreamService.getInstance() == null) { ArrayList<String> matrixIds = new ArrayList<String>(); Collection<MXSession> sessions = Matrix.getInstance(context.getApplicationContext()).getSessions(); if ((null != sessions) && (sessions.size() > 0)) { Log.d(LOG_TAG, "restart EventStreamService"); for (MXSession session : sessions) { Boolean isSessionReady = session.getDataHandler().getStore().isReady(); if (!isSessionReady) { session.getDataHandler().getStore().open(); } // session to activate matrixIds.add(session.getCredentials().userId); } Intent intent = new Intent(context, EventStreamService.class); intent.putExtra(EventStreamService.EXTRA_MATRIX_IDS, matrixIds.toArray(new String[matrixIds.size()])); intent.putExtra(EventStreamService.EXTRA_STREAM_ACTION, EventStreamService.StreamAction.START.ordinal()); context.startService(intent); } } } public static void updateUnreadMessagesBadge(Context context, int badgeValue) { try { ShortcutBadger.setBadge(context, badgeValue); } catch (Exception e) { } } public interface OnSubmitListener { public void onSubmit(String text); public void onCancelled(); } public static AlertDialog createEditTextAlert(Activity context, String title, String hint, String initialText, final OnSubmitListener listener) { final AlertDialog.Builder alert = new AlertDialog.Builder(context); final EditText input = new EditText(context); if (hint != null) { input.setHint(hint); } if (initialText != null) { input.setText(initialText); } alert.setTitle(title); alert.setView(input); alert.setPositiveButton(R.string.ok, new DialogInterface.OnClickListener() { public void onClick(DialogInterface dialog, int whichButton) { String value = input.getText().toString().trim(); listener.onSubmit(value); } }); alert.setNegativeButton(R.string.cancel, new DialogInterface.OnClickListener() { public void onClick(DialogInterface dialog, int whichButton) { dialog.cancel(); } }); alert.setOnCancelListener(new DialogInterface.OnCancelListener() { @Override public void onCancel(DialogInterface dialog) { listener.onCancelled(); } }); AlertDialog dialog = alert.create(); // add the dialog to be rendered in the screenshot RageShake.getInstance().registerDialog(dialog); return dialog; } public static void goToRoomPage(final String matrixId, final String roomId, final Activity fromActivity, final Intent intentParam) { goToRoomPage(Matrix.getMXSession(fromActivity, matrixId), roomId, fromActivity, intentParam); } public static void goToRoomPage(final MXSession aSession, final String roomId, final Activity fromActivity, final Intent intentParam) { // check first if the 1:1 room already exists MXSession session = (aSession == null) ? Matrix.getMXSession(fromActivity, null) : aSession; // sanity check if ((null == session) || !session.isActive()) { return; } final MXSession fSession = session; Room room = session.getDataHandler().getRoom(roomId); // do not open a leaving room. // it does not make. if ((null != room) && (room.isLeaving())) { return; } fromActivity.runOnUiThread(new Runnable() { @Override public void run() { // if the activity is not the home activity if (!(fromActivity instanceof HomeActivity)) { // pop to the home activity Intent intent = new Intent(fromActivity, HomeActivity.class); intent.setFlags(android.content.Intent.FLAG_ACTIVITY_CLEAR_TOP | android.content.Intent.FLAG_ACTIVITY_SINGLE_TOP); intent.putExtra(HomeActivity.EXTRA_JUMP_TO_ROOM_ID, roomId); intent.putExtra(HomeActivity.EXTRA_JUMP_MATRIX_ID, fSession.getCredentials().userId); if (null != intentParam) { intent.putExtra(HomeActivity.EXTRA_ROOM_INTENT, intentParam); } fromActivity.startActivity(intent); } else { // already to the home activity // so just need to open the room activity Intent intent = new Intent(fromActivity, RoomActivity.class); intent.putExtra(RoomActivity.EXTRA_ROOM_ID, roomId); intent.putExtra(RoomActivity.EXTRA_MATRIX_ID, fSession.getCredentials().userId); if (null != intentParam) { intent.putExtra(HomeActivity.EXTRA_ROOM_INTENT, intentParam); } fromActivity.startActivity(intent); } } }); } public static void goToOneToOneRoom(final String matrixId, final String otherUserId, final Activity fromActivity, final ApiCallback<Void> callback) { goToOneToOneRoom(Matrix.getMXSession(fromActivity, matrixId), otherUserId, fromActivity, callback); } public static void goToOneToOneRoom(final MXSession aSession, final String otherUserId, final Activity fromActivity, final ApiCallback<Void> callback) { // sanity check if (null == otherUserId) { return; } // check first if the 1:1 room already exists MXSession session = (aSession == null) ? Matrix.getMXSession(fromActivity, null) : aSession; // no session is provided if (null == session) { // get the default one. session = Matrix.getInstance(fromActivity.getApplicationContext()).getDefaultSession(); } // sanity check if ((null == session) || !session.isActive()) { return; } final MXSession fSession = session; // so, list the existing room, and search the 2 users room with this other users String roomId = null; Collection<Room> rooms = session.getDataHandler().getStore().getRooms(); for (Room room : rooms) { Collection<RoomMember> members = room.getMembers(); if (members.size() == 2) { for (RoomMember member : members) { if (member.getUserId().equals(otherUserId)) { roomId = room.getRoomId(); break; } } } } // the room already exists -> switch to it if (null != roomId) { CommonActivityUtils.goToRoomPage(session, roomId, fromActivity, null); // everything is ok if (null != callback) { callback.onSuccess(null); } } else { session.createRoom(null, null, RoomState.VISIBILITY_PRIVATE, null, new SimpleApiCallback<String>(fromActivity) { @Override public void onSuccess(String roomId) { final Room room = fSession.getDataHandler().getRoom(roomId); room.invite(otherUserId, new SimpleApiCallback<Void>(this) { @Override public void onSuccess(Void info) { CommonActivityUtils.goToRoomPage(fSession, room.getRoomId(), fromActivity, null); callback.onSuccess(null); } @Override public void onMatrixError(MatrixError e) { if (null != callback) { callback.onMatrixError(e); } } @Override public void onNetworkError(Exception e) { if (null != callback) { callback.onNetworkError(e); } } @Override public void onUnexpectedError(Exception e) { if (null != callback) { callback.onUnexpectedError(e); } } }); } @Override public void onMatrixError(MatrixError e) { if (null != callback) { callback.onMatrixError(e); } } @Override public void onNetworkError(Exception e) { if (null != callback) { callback.onNetworkError(e); } } @Override public void onUnexpectedError(Exception e) { if (null != callback) { callback.onUnexpectedError(e); } } }); } } /** * Check if the userId format is valid with the matrix standard. * It should start with a @ and ends with the home server suffix. * * @param userId the userID to check * @param homeServerSuffix the home server suffix * @return the checked user ID */ public static String checkUserId(String userId, String homeServerSuffix) { String res = userId; if (res.length() > 0) { res = res.trim(); if (!res.startsWith("@")) { res = "@" + res; } if (res.indexOf(":") < 0) { res += homeServerSuffix; } } return res; } /** * Offer to send some dedicated intent data to an existing room * @param fromActivity the caller activity * @param intent the intent param */ public static void sendFilesTo(final Activity fromActivity, final Intent intent) { if (Matrix.getMXSessions(fromActivity).size() == 1) { sendFilesTo(fromActivity, intent, Matrix.getMXSession(fromActivity, null)); } else if (fromActivity instanceof FragmentActivity) { FragmentManager fm = ((FragmentActivity) fromActivity).getSupportFragmentManager(); AccountsSelectionDialogFragment fragment = (AccountsSelectionDialogFragment) fm .findFragmentByTag(MXCActionBarActivity.TAG_FRAGMENT_ACCOUNT_SELECTION_DIALOG); if (fragment != null) { fragment.dismissAllowingStateLoss(); } fragment = AccountsSelectionDialogFragment.newInstance(Matrix.getMXSessions(fromActivity)); fragment.setListener(new AccountsSelectionDialogFragment.AccountsListener() { @Override public void onSelected(final MXSession session) { fromActivity.runOnUiThread(new Runnable() { @Override public void run() { sendFilesTo(fromActivity, intent, session); } }); } }); fragment.show(fm, MXCActionBarActivity.TAG_FRAGMENT_ACCOUNT_SELECTION_DIALOG); } } /** * Offer to send some dedicated intent data to an existing room * @param fromActivity the caller activity * @param intent the intent param * @param session the session/ */ public static void sendFilesTo(final Activity fromActivity, final Intent intent, final MXSession session) { // sanity check if ((null == session) || !session.isActive()) { return; } final ArrayList<RoomSummary> mergedSummaries = new ArrayList<RoomSummary>(); mergedSummaries.addAll(session.getDataHandler().getStore().getSummaries()); Collections.sort(mergedSummaries, new Comparator<RoomSummary>() { @Override public int compare(RoomSummary lhs, RoomSummary rhs) { if (lhs == null || lhs.getLatestEvent() == null) { return 1; } else if (rhs == null || rhs.getLatestEvent() == null) { return -1; } if (lhs.getLatestEvent().getOriginServerTs() > rhs.getLatestEvent().getOriginServerTs()) { return -1; } else if (lhs.getLatestEvent().getOriginServerTs() < rhs.getLatestEvent().getOriginServerTs()) { return 1; } return 0; } }); AlertDialog.Builder builderSingle = new AlertDialog.Builder(fromActivity); builderSingle.setTitle(fromActivity.getText(R.string.send_files_in)); final ArrayAdapter<String> arrayAdapter = new ArrayAdapter<String>(fromActivity, R.layout.dialog_room_selection); for (RoomSummary summary : mergedSummaries) { arrayAdapter.add(summary.getRoomName()); } builderSingle.setNegativeButton(fromActivity.getText(R.string.cancel), new DialogInterface.OnClickListener() { @Override public void onClick(DialogInterface dialog, int which) { dialog.dismiss(); } }); builderSingle.setAdapter(arrayAdapter, new DialogInterface.OnClickListener() { @Override public void onClick(DialogInterface dialog, final int which) { dialog.dismiss(); fromActivity.runOnUiThread(new Runnable() { @Override public void run() { RoomSummary summary = mergedSummaries.get(which); CommonActivityUtils.goToRoomPage(session, summary.getRoomId(), fromActivity, intent); } }); } }); builderSingle.show(); } /** * Parse an userIDS text into a list. * * @param userIDsText the userIDs text. * @param homeServerSuffix the home server suffix * @return the userIDs list. */ public static ArrayList<String> parseUserIDsList(String userIDsText, String homeServerSuffix) { ArrayList<String> userIDsList = new ArrayList<String>(); if (!TextUtils.isEmpty(userIDsText)) { userIDsText = userIDsText.trim(); if (!TextUtils.isEmpty(userIDsText)) { // they are separated by a ; String[] splitItems = userIDsText.split(";"); for (int i = 0; i < splitItems.length; i++) { String item = splitItems[i]; // avoid null name if (item.length() > 0) { // add missing @ or home suffix String checkedItem = CommonActivityUtils.checkUserId(item, homeServerSuffix); // not yet added ? -> add it if (userIDsList.indexOf(checkedItem) < 0) { checkedItem.trim(); userIDsList.add(checkedItem); } } } } } return userIDsList; } /** * @param context the context * @param filename the filename * @return true if a file named "filename" is stored in the downloads directory */ public static Boolean doesFileExistInDownloads(Context context, String filename) { File dstDir = Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_DOWNLOADS); if (dstDir != null) { dstDir.mkdirs(); } File dstFile = new File(dstDir, filename); return dstFile.exists(); } /** * Save a media in the downloads directory and offer to open it with a third party application. * @param activity the activity * @param savedMediaPath the media path * @param mimeType the media mime type. */ public static void openMedia(final Activity activity, final String savedMediaPath, final String mimeType) { if ((null != activity) && (null != savedMediaPath)) { activity.runOnUiThread(new Runnable() { @Override public void run() { try { File file = new File(savedMediaPath); Intent intent = new Intent(); intent.setAction(android.content.Intent.ACTION_VIEW); intent.setDataAndType(Uri.fromFile(file), mimeType); activity.startActivity(intent); } catch (ActivityNotFoundException e) { Toast.makeText(activity, e.getLocalizedMessage(), Toast.LENGTH_LONG).show(); } catch (Exception e) { } } }); } } /** * Copy a file into a dstPath directory. * The output filename can be provided. * The output file is not overriden if it is already exist. * @param context the context * @param sourceFile the file source path * @param dstDirPath the dst path * @param outputFilename optional the output filename * @return the downloads file path if the file exists or has been properly saved */ public static String saveFileInto(Context context, File sourceFile, String dstDirPath, String outputFilename) { // sanity check if ((null == sourceFile) || (null == dstDirPath)) { return null; } // defines another name for the external media String dstFileName; // build a filename is not provided if (null == outputFilename) { // extract the file extension from the uri int dotPos = sourceFile.getName().lastIndexOf("."); String fileExt = ""; if (dotPos > 0) { fileExt = sourceFile.getName().substring(dotPos); } dstFileName = "MatrixConsole_" + System.currentTimeMillis() + fileExt; } else { dstFileName = outputFilename; } File dstDir = Environment.getExternalStoragePublicDirectory(dstDirPath); if (dstDir != null) { dstDir.mkdirs(); } File dstFile = new File(dstDir, dstFileName); // Copy source file to destination FileInputStream inputStream = null; FileOutputStream outputStream = null; try { // create only the if (!dstFile.exists()) { dstFile.createNewFile(); inputStream = new FileInputStream(sourceFile); outputStream = new FileOutputStream(dstFile); byte[] buffer = new byte[1024 * 10]; int len; while ((len = inputStream.read(buffer)) != -1) { outputStream.write(buffer, 0, len); } } } catch (Exception e) { dstFile = null; } finally { // Close resources try { if (inputStream != null) inputStream.close(); if (outputStream != null) outputStream.close(); } catch (Exception e) { } } if (null != dstFile) { return dstFile.getAbsolutePath(); } else { return null; } } /** * Save a media URI into the download directory * @param context the context * @param srcFile the source file. * @param filename the filename (optional) * @return the downloads file path */ @SuppressLint("NewApi") public static String saveMediaIntoDownloads(Context context, File srcFile, String filename, String mimeType) { String fullFilePath = saveFileInto(context, srcFile, Environment.DIRECTORY_DOWNLOADS, filename); if (android.os.Build.VERSION.SDK_INT >= Build.VERSION_CODES.HONEYCOMB) { if (null != fullFilePath) { DownloadManager downloadManager = (DownloadManager) context .getSystemService(Context.DOWNLOAD_SERVICE); try { File file = new File(fullFilePath); downloadManager.addCompletedDownload(file.getName(), file.getName(), true, mimeType, file.getAbsolutePath(), file.length(), true); } catch (Exception e) { } } } return fullFilePath; } /** * Save an image URI into the gallery * @param context the context. * @param sourceFile the image path to save. */ public static String saveImageIntoGallery(Context context, File sourceFile) { String filePath = saveFileInto(context, sourceFile, Environment.DIRECTORY_PICTURES, null); if (null != filePath) { // This broadcasts that there's been a change in the media directory context.sendBroadcast( new Intent(Intent.ACTION_MEDIA_SCANNER_SCAN_FILE, Uri.fromFile(new File(filePath)))); } return filePath; } }