nextcloud-commons

• What is this
• How to use
• Modules
  • exception
  • sso-glide
  • markdown
• Development
• License

What is this

Many Android clients for Nextcloud apps need similar mechanisms. To reduce maintenance efforts and provide a similar look & feel, this library aims to provide tooling and support which can be useful for various Android clients.

How to use

Add this dependency to your build.gradle-file to include all modules at once:

implementation 'com.github.stefan-niedermann:nextcloud-commons:2.3.3'

Modules

exception

implementation 'com.github.stefan-niedermann.nextcloud-commons:exception:2.3.3'

This is a util class which provides methods for generating a rich stacktrace from a throwable containing additional information like the used files app and OS versions.

Usage

try {
  // …
} catch (Exception exception) {
  String debug = ExceptionUtil.getDebugInfos(context, exception);
}

Example

App Version: 2.17.1
App Version Code: 2017001
Server App Version: 3.2.0
App Flavor: dev

Files App Version Code: 30120090

---

OS Version: 4.14.112+(5775370)
OS API Level: 29
Device: generic_x86_64
Manufacturer: unknown
Model (and Product): Android SDK built for x86_64 (sdk_phone_x86_64)

---

java.lang.RuntimeException: Unable to start activity ComponentInfo{it.niedermann.owncloud.notes.dev/it.niedermann.owncloud.notes.main.MainActivity}: java.lang.NumberFormatException: For input string: "ASDF"
	at android.app.ActivityThread.performLaunchActivity(ActivityThread.java:3270)
	at android.app.ActivityThread.handleLaunchActivity(ActivityThread.java:3409)
	at android.app.servertransaction.LaunchActivityItem.execute(LaunchActivityItem.java:83)
	at android.app.servertransaction.TransactionExecutor.executeCallbacks(TransactionExecutor.java:135)
	at android.app.servertransaction.TransactionExecutor.execute(TransactionExecutor.java:95)
	at android.app.ActivityThread$H.handleMessage(ActivityThread.java:2016)
	at android.os.Handler.dispatchMessage(Handler.java:107)
	at android.os.Looper.loop(Looper.java:214)
	at android.app.ActivityThread.main(ActivityThread.java:7356)
	at java.lang.reflect.Method.invoke(Native Method)
	at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:492)
	at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:930)
Caused by: java.lang.NumberFormatException: For input string: "ASDF"
	at java.lang.Integer.parseInt(Integer.java:615)
	at java.lang.Integer.parseInt(Integer.java:650)
	at it.niedermann.owncloud.notes.main.MainActivity.onCreate(MainActivity.java:180)
	at android.app.Activity.performCreate(Activity.java:7802)
	at android.app.Activity.performCreate(Activity.java:7791)
	at android.app.Instrumentation.callActivityOnCreate(Instrumentation.java:1299)
	at android.app.ActivityThread.performLaunchActivity(ActivityThread.java:3245)
	... 11 more

sso-glide

implementation 'com.github.stefan-niedermann.nextcloud-commons:sso-glide:2.3.3'

This is a Glide-integration module. If you are using Single Sign On you may want to also fetch avatars or other images via Glide but with the SSO network stack to avoid problems with self-signed certificates, 2fa and so on.

To make it work, you need also this dependencies in your build.gradle-file:

implementation 'com.github.bumptech.glide:glide:4.11.0'
annotationProcessor 'com.github.bumptech.glide:compiler:4.11.0'

Usage

Then create a custom AppGlideModule at the place you want, like this:

@GlideModule
public class CustomAppGlideModule extends AppGlideModule {
  @Override
  public void registerComponents(@NonNull Context context, @NonNull Glide glide, @NonNull Registry registry) {
    super.registerComponents(context, glide, registry);
  }
}

Glide will automatically recognize the custom AppGlideModule and process this library module.

Glide.with(context)
     .load("https://nextcloud.example.com/index.php/avatar/username/32")
     .into(myImageView);

will make a request from the user which is stored as the current SingleSignOn account (see here).

If you need to perform the request from another account (for example to display avatars in an account switcher), you can use a SingleSignOnUrl instance as Url:

Glide.with(context)
     .load(new SingleSignOnUrl(ssoAccount, "https://nextcloud.example.com/index.php/avatar/username/32"))
     .into(myImageView);

The sso-glide module also supports some automatic URL rewrites, such as:

Glide.with(context)
   // URLs from file shares with and without /index.php segment, with and without trailing / character
     .load("https://nextcloud.example.com/s/Wr99tjfBCs96kxZ")
     .load("https://nextcloud.example.com/s/Wr99tjfBCs96kxZ/")
     .load("https://nextcloud.example.com/index.php/s/Wr99tjfBCs96kxZ")
     .load("https://nextcloud.example.com/index.php/s/Wr99tjfBCs96kxZ/")
     .load("https://nextcloud.example.com/index.php/s/Wr99tjfBCs96kxZ/download")
     .load("https://nextcloud.example.com/index.php/s/Wr99tjfBCs96kxZ/download/")
   // File ID URLs with and without /index.php segment, with and without trailing / character
     .load("https://nextcloud.example.com/f/123456")
     .load("https://nextcloud.example.com/f/123456/")
     .load("https://nextcloud.example.com/index.php/f/123456")
     .load("https://nextcloud.example.com/index.php/f/123456/")
   // Everything mentioned above, if the nextcloud is not located at the root directory
     .load("https://example.com/my-fancy-nextcloud/f/123456")
   // There is a fallback for every URL or path which does not start with /index.php or /remote.php
   // In this case we will assume a path in the users directory (which needs to be properly URL encoded)
     .load("/foo.png")
     .load("/foo%20bar.png")
     .load("/foo/bar%20baz.png")
     .into(myImageView);

markdown

implementation('com.github.stefan-niedermann.nextcloud-commons:markdown:2.3.3') {
  exclude group: 'org.jetbrains', module: 'annotations-java5'
}

This contains a markdown editor and viewer based on Markwon.

Usage

The UI widgets MarkdownViewerImpl and MarkdownEditorImpl can just be treated as a TextView or an EditText:

<it.niedermann.android.markdown.MarkdownViewerImpl
    android:layout_width="match_parent"
    android:layout_height="wrap_content" />

<it.niedermann.android.markdown.MarkdownEditorImpl
    android:layout_width="match_parent"
    android:layout_height="wrap_content" />

You can implement against the MarkdownEditor interface, which allows you to add some special behavior like

• highlight search terms
• intercept link clicks
• render user avatars next to @user mentions

The MarkdownUtil provides some helper tools to work with markdown.

Development

If you want to add this repository to your project to develop this library or use the latest version, you can add the following code to your gradle files:

settings.gradle

// for markdown
include ':markdown'
project(':markdown').projectDir = new File(settingsDir, '../nextcloud-commons/markdown')

// for sso-glide
include ':sso-glide'
project(':sso-glide').projectDir = new File(settingsDir, '../nextcloud-commons/sso-glide')

// for exception
include ':exception'
project(':exception').projectDir = new File(settingsDir, '../nextcloud-commons/exception')

// It is also possible to provide absolute path's instead of relative ones.

build.gradle

(the app one, not the project-one)

dependencies {
    // …

    implementation project(':markdown')
    implementation project(':sso-glide')
    implementation project(':exception')
    
    // …
}

You do not need to add all libraries, just add the ones you want to use in your project. You also have to remove versioned libraries from above if you added them.

However, it is not adivisable to check those into version control, because anyone else will not be able to build your project without having the local libraries configured.

📓 License

This project is licensed under the GNU GENERAL PUBLIC LICENSE.