Skip to content

Markdown support in notification #184

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 21, 2021
Merged

Markdown support in notification #184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
90ac114
Removed markdown meta data from notification
Aug 1, 2021
bffae44
Merge remote-tracking branch 'refs/remotes/origin/master'
Aug 2, 2021
156ca47
Added (limited) support for rendering markdown in notification
Aug 4, 2021
cc616a9
Ignore links in notification rendering
Aug 4, 2021
e25bf4c
Fixed missing tables in notification
Aug 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
119 changes: 119 additions & 0 deletions app/src/main/java/com/github/gotify/MarkwonFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
package com.github.gotify;

import android.content.Context;
import android.graphics.Color;
import android.graphics.Typeface;
import android.text.style.BackgroundColorSpan;
import android.text.style.BulletSpan;
import android.text.style.QuoteSpan;
import android.text.style.RelativeSizeSpan;
import android.text.style.StyleSpan;
import android.text.style.TypefaceSpan;
import androidx.annotation.NonNull;
import com.squareup.picasso.Picasso;
import io.noties.markwon.AbstractMarkwonPlugin;
import io.noties.markwon.Markwon;
import io.noties.markwon.MarkwonSpansFactory;
import io.noties.markwon.MarkwonVisitor;
import io.noties.markwon.core.CorePlugin;
import io.noties.markwon.core.CoreProps;
import io.noties.markwon.ext.strikethrough.StrikethroughPlugin;
import io.noties.markwon.ext.tables.TableAwareMovementMethod;
import io.noties.markwon.ext.tables.TablePlugin;
import io.noties.markwon.image.picasso.PicassoImagesPlugin;
import io.noties.markwon.movement.MovementMethodPlugin;
import java.util.Collections;
import org.commonmark.ext.gfm.tables.TableCell;
import org.commonmark.ext.gfm.tables.TablesExtension;
import org.commonmark.node.BlockQuote;
import org.commonmark.node.Code;
import org.commonmark.node.Emphasis;
import org.commonmark.node.Heading;
import org.commonmark.node.Link;
import org.commonmark.node.ListItem;
import org.commonmark.node.StrongEmphasis;
import org.commonmark.parser.Parser;

public class MarkwonFactory {
public static Markwon createForMessage(Context context, Picasso picasso) {
return Markwon.builder(context)
.usePlugin(CorePlugin.create())
.usePlugin(MovementMethodPlugin.create(TableAwareMovementMethod.create()))
.usePlugin(PicassoImagesPlugin.create(picasso))
.usePlugin(StrikethroughPlugin.create())
.usePlugin(TablePlugin.create(context))
.build();
}

public static Markwon createForNotification(Context context, Picasso picasso) {
final float[] headingSizes = {
2.F, 1.5F, 1.17F, 1.F, .83F, .67F,
};

final int bulletGapWidth =
(int) (8 * context.getResources().getDisplayMetrics().density + 0.5F);

return Markwon.builder(context)
.usePlugin(CorePlugin.create())
.usePlugin(PicassoImagesPlugin.create(picasso))
.usePlugin(StrikethroughPlugin.create())
.usePlugin(
new AbstractMarkwonPlugin() {
@Override
public void configureSpansFactory(
@NonNull MarkwonSpansFactory.Builder builder) {
builder.setFactory(
Heading.class,
(configuration, props) ->
new Object[] {
new RelativeSizeSpan(
headingSizes[
CoreProps.HEADING_LEVEL
.require(
props)
- 1]),
new StyleSpan(Typeface.BOLD)
})
.setFactory(
Emphasis.class,
(configuration, props) ->
new StyleSpan(Typeface.ITALIC))
.setFactory(
StrongEmphasis.class,
(configuration, props) ->
new StyleSpan(Typeface.BOLD))
.setFactory(
BlockQuote.class,
(configuration, props) -> new QuoteSpan())
.setFactory(
Code.class,
(configuration, props) ->
new Object[] {
new BackgroundColorSpan(Color.LTGRAY),
new TypefaceSpan("monospace")
})
.setFactory(
ListItem.class,
(configuration, props) ->
new BulletSpan(bulletGapWidth))
.setFactory(Link.class, ((configuration, props) -> null));
}

@Override
public void configureParser(@NonNull Parser.Builder builder) {
builder.extensions(Collections.singleton(TablesExtension.create()));
}

@Override
public void configureVisitor(@NonNull MarkwonVisitor.Builder builder) {
builder.on(
TableCell.class,
(visitor, node) -> {
visitor.visitChildren(node);
visitor.builder().append(' ');
});
}
})
.build();
}
}
8 changes: 6 additions & 2 deletions app/src/main/java/com/github/gotify/messages/Extras.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,15 @@ public final class Extras {
private Extras() {}

public static boolean useMarkdown(Message message) {
if (message.getExtras() == null) {
return useMarkdown(message.getExtras());
}

public static boolean useMarkdown(Map<String, Object> extras) {
if (extras == null) {
return false;
}

Object display = message.getExtras().get("client::display");
Object display = extras.get("client::display");
if (!(display instanceof Map)) {
return false;
}
Expand Down
16 changes: 2 additions & 14 deletions app/src/main/java/com/github/gotify/messages/ListMessageAdapter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,14 @@
import androidx.recyclerview.widget.RecyclerView;
import butterknife.BindView;
import butterknife.ButterKnife;
import com.github.gotify.MarkwonFactory;
import com.github.gotify.R;
import com.github.gotify.Settings;
import com.github.gotify.Utils;
import com.github.gotify.client.model.Message;
import com.github.gotify.messages.provider.MessageWithImage;
import com.squareup.picasso.Picasso;
import io.noties.markwon.Markwon;
import io.noties.markwon.core.CorePlugin;
import io.noties.markwon.ext.strikethrough.StrikethroughPlugin;
import io.noties.markwon.ext.tables.TableAwareMovementMethod;
import io.noties.markwon.ext.tables.TablePlugin;
import io.noties.markwon.image.picasso.PicassoImagesPlugin;
import io.noties.markwon.movement.MovementMethodPlugin;
import java.text.DateFormat;
import java.util.Date;
import java.util.List;
Expand Down Expand Up @@ -61,14 +56,7 @@ public class ListMessageAdapter extends RecyclerView.Adapter<ListMessageAdapter.
this.items = items;
this.delete = delete;

this.markwon =
Markwon.builder(context)
.usePlugin(CorePlugin.create())
.usePlugin(MovementMethodPlugin.create(TableAwareMovementMethod.create()))
.usePlugin(PicassoImagesPlugin.create(picasso))
.usePlugin(StrikethroughPlugin.create())
.usePlugin(TablePlugin.create(context))
.build();
this.markwon = MarkwonFactory.createForMessage(context, picasso);

TIME_FORMAT_RELATIVE =
context.getResources().getString(R.string.time_format_value_relative);
Expand Down
14 changes: 12 additions & 2 deletions app/src/main/java/com/github/gotify/service/WebSocketService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
import androidx.annotation.RequiresApi;
import androidx.core.app.NotificationCompat;
import androidx.core.content.ContextCompat;
import com.github.gotify.MarkwonFactory;
import com.github.gotify.MissedMessageUtil;
import com.github.gotify.NotificationSupport;
import com.github.gotify.R;
Expand All @@ -31,6 +32,7 @@
import com.github.gotify.messages.Extras;
import com.github.gotify.messages.MessagesActivity;
import com.github.gotify.picasso.PicassoHandler;
import io.noties.markwon.Markwon;
import java.util.List;
import java.util.Map;
import java.util.concurrent.atomic.AtomicLong;
Expand All @@ -51,6 +53,7 @@ public class WebSocketService extends Service {
private MissedMessageUtil missingMessageUtil;

private PicassoHandler picassoHandler;
private Markwon markwon;

@Override
public void onCreate() {
Expand All @@ -61,6 +64,7 @@ public void onCreate() {
missingMessageUtil = new MissedMessageUtil(client.createService(MessageApi.class));
Log.i("Create " + getClass().getSimpleName());
picassoHandler = new PicassoHandler(this, settings);
markwon = MarkwonFactory.createForNotification(this, picassoHandler.get());
}

@Override
Expand Down Expand Up @@ -297,13 +301,19 @@ private void showNotification(
.setTicker(getString(R.string.app_name) + " - " + title)
.setGroup(NotificationSupport.Group.MESSAGES)
.setContentTitle(title)
.setContentText(message)
.setStyle(new NotificationCompat.BigTextStyle().bigText(message))
.setDefaults(Notification.DEFAULT_LIGHTS | Notification.DEFAULT_SOUND)
.setLights(Color.CYAN, 1000, 5000)
.setColor(ContextCompat.getColor(getApplicationContext(), R.color.colorPrimary))
.setContentIntent(contentIntent);

CharSequence formattedMessage = message;
if (Extras.useMarkdown(extras)) {
formattedMessage = markwon.toMarkdown(message);
message = formattedMessage.toString();
}
b.setContentText(message);
b.setStyle(new NotificationCompat.BigTextStyle().bigText(formattedMessage));

NotificationManager notificationManager =
(NotificationManager) this.getSystemService(Context.NOTIFICATION_SERVICE);
notificationManager.notify(Utils.longToInt(id), b.build());
Expand Down