Team Algol : Android Messenger application for DHIS2
- Vladislav Georgiev Alfredov <email@example.com>
- Tomáš Livora <firstname.lastname@example.org>
- Mathias Ciarlo Thorstensen <email@example.com>
- Hans Fredrik Fahle <firstname.lastname@example.org>
- Jiader Chou <email@example.com>
Summary of Requirements
- Reduce data usage
- Implement local data storage
- Implement local data caching
- Redesign user interface to follow Material design guidelines
- Android application
- REST calls to DHIS2 for authentication and user information
- XMPP messaging
- Google cloud services communication ?
- DHIS2 instance
- XMPP server (previously: https://github.com/niclashalvorsen/DHISOpenfire and:https://github.com/niclashalvorsen/Openfire-DHISAuthentication)
- Google Cloud services on DHIS2 server ? (https://github.com/niclashalvorsen/DHIS2-GCMSupport)
Importing to android studio:
- Open android studio.
- Click import project
- Select Gradle project.
- Find the "build.gradle" file inside the app folder and select it.
(This way you use the gradle plugin from android studio)
Details about how we will solve the task, and component-like view of it go here...
- Go over the libraries and decide which is worth using: (time to implement the functionality ourselves + testing vs the resource cost of using the library + going over the library interface
- asmack.jar (Xmpp code redesign to comply with maven): https://github.com/igniterealtime/Smack/wiki/Smack-4.1-Readme-and-Upgrade-Guide
reactiveX (Observables): https://github.com/ReactiveX/RxAndroid
- butterknife (activities & ui): http://jakewharton.github.io/butterknife/
- Material Design (UI ): https://www.google.com/design/spec/material-design/introduction.html
ormLite (sql orm for android): http://ormlite.com/sqlite_java_android_orm.shtml
DHIS2 Android sdk: https://github.com/dhis2/dhis2-android-sdk
- Rest interface/layer redesign.
- Rest Session storage? Use Persistance layer or Cache layer ?
- How would the rest calls hit/miss the cache?
- Is the DHIS2 api satisfactory ?
- Persistance layer
Use the OrmLite library ?
- Store data on app start/exit
- Provide interface for the Rest Layer
- Cache layer.
- If requested object in memory return it. If not use persistance layer to get it. If not on disk return null/empty list, informing that it is not cached.
- Go over all the ui and redo it to use Material design. Maybe use butterknife for activities as well ?
- Test the app. Test all the corner cases.
- Unit tests on android : https://developer.android.com/training/activity-testing/activity-unit-testing.html
- Milestone (8th November)
- Analysis of previous solution
- Work planning according to the findings: Result: We split the app up in four sections/areas, assigning people to each.
- Xmpp client/server/api (Thomas)
- Caching (REST/XMPP) (Vladislav)
- REST client/server/api (Mathias and Jiader)
- GUI and Matherial Design (Hans)
- Milestone (22nd November)
- Run own instance of DHIS2 (all)
- Update REST API calls, use ReactiveX library and reduce the number of calls and amount of data transfered (Mathias and Jiader)
- Fix Openfire DHIS authentication library and run Openfire XMPP server (Tomas)
- Caching: Fix problem with long reopening of the application and improve local storage (Vladislav)
- Analyze XMPPSessionStore.[done]
- Compare RESTClient to XMPPClient.[done]
- Go trough Activities, Fragments and anonymous asynchronious tasks that relate to REST calls and caching. [done]
- Implement RESTSessionStorage class and methods to set/get *Model lists of objects/objects [done]
- Refactor XMPPSessionStorage if nessesary [not nessesary]
- Milestone (4th December)
- Update Smack client library and fix XMPP issues (Tomas)
- Run DHIS with Openfire on publicly accessible server (Tomas)
- Improve GUI using Butter Knife and Material design (Hans)
- Inprove the caching of InboxModel, implement conversation caching and analyze InterpretationsModel's data usage. Possibly implementing caching for interpretations. (Vladislav).
- Implement caching for the User Profile. [done]
- Implement ways to store cache for different users.[done] RESTSessionStorage can select an instance of the class for the user.
- Implement ways to intentionally skip the cache. (ex: when clicking the refresh button). [done]
- Implement caching for the conversations. [done] A list of the conversation messages is attached to InboxModel.messages, and InboxModel.members holds the users. And this is refreshed when the InboxModel.read == false. Also when a conversation is updated (ie already in cache), the REST call only gets the messages from the server, without the users. This saves data.
- Merge pages retrieved from the server into the cached inboxModel page. [done]
- Improve the overall caching class structure. [done] By abstracting the page/list caching methods into a CacheList<Type extends CopyAttributes> class and CopyAttributes<Type> interface.
- Analyze the Interpretations. [done] Result: Interpretations functionality is incomplete: Cannot get next page, there is no reload button. Thus implementing caching for it is unnecessary. But I have written initial implementation /stub for the caching, similiar to the inboxModel one, bothi in RESTSessionStorage.java and in InterpretationFragment.java. I also cleaned up the InterpretationsFragment class in the process.
- Overall REST client debugging. [done] There is a bug that I couldn't figure out: Sometimes pages start being added twice to the lists. Also for some reason every single AsyncTask is ran twice.
- Final delivery (11th December)
- Run DHIS2 with GCM extension (Tomas)
- Store the memory caches to a file and restore from that file on app start. Using plain files & json or https://github.com/Jearil/SimpleNoSQL or https://github.com/couchbase/couchbase-lite-android (Vladislav)
- Stabilize the application
- Measure traffic usage
- Write unit tests for every component of the application
How to run the application
Follow the instructions. If you do not want to run your own local server, skip first two steps and choose address 184.108.40.206 (our testing server) from the list.
Note: The app works with the DHIS2 demo servers as well. (The xmpp chat functionality however, won't work with the DHIS2 demo server.)
- DHIS Server
- download DHIS 2 Live package
- unzip it somewhere on your machine
- run the script based on your platform (either dhis2-live.exe or startup.sh)
- Openfire XMPP Server
- clone Openfire-DHISAuthentication repository
- build the project using Maven (dhis.provider-1.0.0-SNAPSHOT.jar should be created in target directory)
- download the latest Openfire server for your platform
- run the installer or unzip the archive
- copy dhis.provider-1.0.0-SNAPSHOT.jar generated before to openfire/lib directory
- copy ~/.m2/repository/net/iharder/base64/2.3.8/base64-2.3.8.jar to openfire/lib directory
- run Openfire from openfire/bin directory (./openfire start for Linux systems)
- go to Openfire Admin Console and go throught the basic setup if you want
- go to System Properties and change provider.auth.className to org.hisp.dhis.provider.DHISAuthProvider
- restart the server (./openfire restart for Linux systems)
- make sure your firewall does not block port 5222
- DHIS Messenger for Android
- clone DHISmessenger repository and open the project in Android Studio
- build and run the application (either using Android Emulator or your Android smartphone)
- make sure your phone is connected to the Internet
- in the application enter your computer's external IP address (you can find it with ifconfig command on Linux systems)
- log in using username admin and password district
- Source code (dhis2msg organization on GitHub)
- Weekly in-person meetings
- group sessions (Group 1, Tuesday 10:15 - 12:00)
- during or after the lecture (Thursday 12:15 - 14:00)
- Online communication
Application layout before vs. now
- The layout before we started working on the application:
- The layout after we worked on the application: