qabel-android's Introduction

The Qabel Android Client

This project provides a Client for targeting Android. It is a small part of the qabel platform.

Introduction

For a comprehensive documentation of the whole Qabel Platform use https://qabel.de as the main source of information. http://qabel.github.io/docs/ may provide additional technical information.

Qabel consists of multiple Projects:

Qabel Android Client
Qabel Desktop Client
Qabel Core is a library that includes the common code between both clients to keep them consistent
Qabel Drop Server is the target server for drop messages according to the Qabel Drop Protocol
Qabel Accounting Server manages Qabel-Accounts that authorize Qabel Box usage according to the Qabel Box Protocol
Qabel Block Server serves as the storage backend according to the Qabel Box Protocol

Install

Official distributions of the Qabel Android Client are provided by the official Qabel website at https://qabel.de/de/qabelnow and via Google Play. Everything below this line describes the usage of the Qabel Android Client for development purposes.

Getting started

Install the Android SDK
Install the SDK version 23. Make sure you install the "Android Support Repository" and the latest "Android SDK build-tools"
Install the NDK
Checkout the project from git
Create the file /qabelbox/src/main/res/values/params.xml with the following contents:

<resources> <string name="hockeykey">dummykey</string> </resources>
Create a local.properties file at the root of your source checkout and add an sdk.dir and ndk.dir entry to it. For example:
```
  sdk.dir=/opt/Android/SDK
  ndk.dir=/opt/Android/NDK
```
Run ./gradlew build
Usage of Android Studio with the Kotlin plugin is recommended for development

Usage

You can run the tests with the following gradle tasks:

./gradlew testDeveloperDebugUnitTest runs the local unit tests
./gradlew spoonDeveloperDebugAndroidTest runs all instrumentation tests on all connected devices and emulators

Development

To run the unit tests directly from Android Studio, you need to change the default options for the JUnit task. Change the vm-options to -ea -Djava.library.path=libs/ so that the android studio testrunner finds the crypto library we use.

Common errors

Cannot run program "".../aapt": error=2, No such file or directory

You are missing some libs for the 32bit aapt. For ubuntu try

sudo apt-get install lib32stdc++6 lib32z1

Structure

The test server addresses are hard coded in TestConstants.java and the live servers are configured in a string ressource servers.xml

Contribution

For issues using the Qabel Android Client, use the feedback feature inside the app (Settings -> Feedback).

Otherwise, use the Issue tracker of GitHub.

Please read the contribution guidelines at https://github.com/Qabel/qabel-core/blob/master/CONTRIBUTING.md carefully.

qabel-android's People

Contributors

Stargazers

Watchers

qabel-android's Issues

Export your identity as a contact

(without the private key.)

JSON
QR code
Backend import-export code
Attach to GUI

Overview of all shares that were sent

Persist message history locally

Search by other metadata

Search by

minimum size
maximum size
modification time

Manually import a contact

From a (json) file which contains the public key and a drop address (maybe additional information)

Box: Integrate Identity Management

English texts

Export identity

as JSON

Remove a share as recipient

Remove a share that is "mounted" locally.

Upload directories

Create identity

Show actual used space as given by the block server

Progress monitor for uploads/downloads in the internal browser

Same as #8, but for not only for the BoxProvider. The internal file browser doesn't use the notifications yet.

Remove a single file share

(by removing the FM)

Backend
Frontend

German texts

Move QblStorage* exceptions into the qabelbox project

The exception classes currently exist only in the pull request Qabel/qabel-core#403 and should be moved into this project.

Show quota as given by the accounting server

Update crypto to Spongycastle

Qabel/qabel-core#415

All in all: Use current core-master, stuff changed.

Keep marked files offline available

Update them on sync events

Remove mounted shares that are no longer accessible

(probably because they were unshared)

Prevent conflicts between the internal browser and the DocumentsProvider

Box: Release beta-1

APK Install
Play Store

Create a folder share

Contact import by scanning a QR code

Given a QR code of a contact
And a user in the contact list fragment
When he clicks on the "Add contact" button
And he clicks on "Scan QR-Code"
Then a QR-scanner starts
And scans the QR-code of the contact
And the contact is imported into his contact list

Given a QR code of a contact that is already known
And a user in the contact list fragment
When he clicks on the "Add contact" button
And he clicks on "Scan QR-Code"
Then a QR-scanner starts
And scans the QR-code of the contact
And a message "Contact is already known" appears

Box: Is there a need for syncing if we use the SAF anyway?

https://developer.android.com/guide/topics/providers/document-provider.html

Other apps can directly open, edit, rename, delete files on Qabel-Box, so I don't think there is any need to automatically sync files on the disk. Instead, we should imo implement proper caching to speed up the tasks that a user would have used syncing for.

Create a file-share

Backend
Frontend

Needed in the backend:
FileMetadata database according to the spec

Cleanup this repository and make it public

Send a share to a contact

Contact list

Redesign the contact list, it should look like in the mock ups.

Provided functions in the contact list:

Import contacts #35 #34
Export contacts (should already have a backend)
Remove contacts

Search by name

Backend
GUI

Search started from the action bar with a simple search by name (case insensitive). The search backend is merged in #132.

The advanced search described in #27 and the enhancement of using cached data is described in #145

qabel / qabel-android Goto Github PK