Skip to content

Extract native share-file preparation from AndroidDocumentsPlugin #93

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
Renakoni merged 1 commit into from
Jul 10, 2026
Merged

Extract native share-file preparation from AndroidDocumentsPlugin #93

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
209 changes: 16 additions & 193 deletions android/app/src/main/java/io/github/renakoni/marktextandroid/AndroidDocumentsPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,6 @@
import java.util.Map;
import java.util.Set;
import java.util.UUID;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

@CapacitorPlugin(name = "AndroidDocuments")
public class AndroidDocumentsPlugin extends Plugin {
Expand All @@ -51,11 +49,6 @@ public class AndroidDocumentsPlugin extends Plugin {
private static final String EVENT_OPEN_WITH_DOCUMENT = "openWithDocument";
private static final String EVENT_SHARE_DOCUMENT = "shareDocument";
private static final String IMPORTED_IMAGE_DIRECTORY = "images";
private static final String SHARE_CACHE_DIRECTORY = "shared-markdown";
private static final Pattern MARKTEXT_IMAGE_SOURCE_PATTERN = Pattern.compile(
"marktext-image://local/([^\\s)]+)",
Pattern.CASE_INSENSITIVE
);
private String lastHandledIncomingIntentId = "";
private String defaultMarkdownEncoding = "utf8";
private boolean autoDetectMarkdownEncoding = true;
Expand Down Expand Up @@ -141,7 +134,7 @@ public void createMarkdownDocument(PluginCall call) {
"text/plain"
}
);
intent.putExtra(Intent.EXTRA_TITLE, normalizeSuggestedMarkdownName(call.getString("suggestedName", "")));
intent.putExtra(Intent.EXTRA_TITLE, SharePreparation.normalizeSuggestedMarkdownName(call.getString("suggestedName", "")));
intent.addFlags(
Intent.FLAG_GRANT_READ_URI_PERMISSION |
Intent.FLAG_GRANT_WRITE_URI_PERMISSION |
Expand Down Expand Up @@ -170,11 +163,11 @@ public void shareMarkdownDocument(PluginCall call) {
return;
}

String suggestedName = normalizeSuggestedMarkdownName(call.getString("suggestedName", ""));
String suggestedName = SharePreparation.normalizeSuggestedMarkdownName(call.getString("suggestedName", ""));
boolean attachImages = call.getBoolean("attachImages", true);
MarkdownWriteOptions writeOptions = getMarkdownWriteOptions(call);
ShareMarkdownPayload sharePayload = attachImages
? buildShareMarkdownPayload(markdown)
? SharePreparation.buildShareMarkdownPayload(markdown, getImportedImageDirectoryFile())
: new ShareMarkdownPayload(markdown, new LinkedHashMap<>());
byte[] bytes;
try {
Expand All @@ -186,13 +179,13 @@ public void shareMarkdownDocument(PluginCall call) {
}

try {
File shareDirectory = getShareCacheDirectory();
Uri markdownUri = writeShareCacheFile(shareDirectory, suggestedName, bytes);
File shareDirectory = SharePreparation.getShareCacheDirectory(getContext());
Uri markdownUri = SharePreparation.writeShareCacheFile(getContext(), shareDirectory, suggestedName, bytes);
ArrayList<Uri> streamUris = new ArrayList<>();
streamUris.add(markdownUri);

for (Map.Entry<String, File> imageEntry : sharePayload.images.entrySet()) {
File sharedImage = copyShareImageFile(shareDirectory, imageEntry.getKey(), imageEntry.getValue());
File sharedImage = SharePreparation.copyShareImageFile(shareDirectory, imageEntry.getKey(), imageEntry.getValue());
streamUris.add(
FileProvider.getUriForFile(
getContext(),
Expand All @@ -213,7 +206,7 @@ public void shareMarkdownDocument(PluginCall call) {
shareIntent.putExtra(Intent.EXTRA_TITLE, suggestedName);
shareIntent.putExtra(Intent.EXTRA_SUBJECT, suggestedName);
shareIntent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
shareIntent.setClipData(buildShareClipData(suggestedName, streamUris));
shareIntent.setClipData(SharePreparation.buildShareClipData(getContext(), suggestedName, streamUris));

Intent chooser = Intent.createChooser(shareIntent, "Share Markdown");
chooser.putExtra(
Expand Down Expand Up @@ -262,7 +255,7 @@ public void shareMarkdownDocuments(PluginCall call) {

MarkdownWriteOptions writeOptions = getMarkdownWriteOptions(call);
try {
File shareDirectory = getShareCacheDirectory();
File shareDirectory = SharePreparation.getShareCacheDirectory(getContext());
ArrayList<Uri> streamUris = new ArrayList<>();
Set<String> usedNames = new java.util.HashSet<>();
long totalBytes = 0;
Expand All @@ -277,15 +270,15 @@ public void shareMarkdownDocuments(PluginCall call) {
}

byte[] bytes = MarkdownCodec.validateBytes(markdown, writeOptions);
String fileName = uniqueShareFileName(
normalizeSuggestedMarkdownName(document.optString("suggestedName", "")),
String fileName = SharePreparation.uniqueShareFileName(
SharePreparation.normalizeSuggestedMarkdownName(document.optString("suggestedName", "")),
usedNames
);
if (firstName == null) {
firstName = fileName;
}

streamUris.add(writeShareCacheFile(shareDirectory, fileName, bytes));
streamUris.add(SharePreparation.writeShareCacheFile(getContext(), shareDirectory, fileName, bytes));
totalBytes += bytes.length;
}

Expand All @@ -300,7 +293,7 @@ public void shareMarkdownDocuments(PluginCall call) {
shareIntent.putExtra(Intent.EXTRA_TITLE, firstName);
shareIntent.putExtra(Intent.EXTRA_SUBJECT, firstName);
shareIntent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
shareIntent.setClipData(buildShareClipData(firstName, streamUris));
shareIntent.setClipData(SharePreparation.buildShareClipData(getContext(), firstName, streamUris));

Intent chooser = Intent.createChooser(shareIntent, "Share Markdown");
chooser.putExtra(
Expand Down Expand Up @@ -347,7 +340,7 @@ public void renameMarkdownDocument(PluginCall call) {
call.reject("A document name is required", "INVALID_DOCUMENT_NAME");
return;
}
String newName = normalizeSuggestedMarkdownName(rawName);
String newName = SharePreparation.normalizeSuggestedMarkdownName(rawName);

try {
if (!DocumentsContract.isDocumentUri(getContext(), uri)) {
Expand Down Expand Up @@ -615,7 +608,7 @@ private void emitSharedStream(Uri uri, Intent intent) {

private void emitSharedText(String markdown, String mimeType, String rawTitle) {
// The parser already gated the MIME type and validated the byte size.
String displayName = normalizeSuggestedMarkdownName(rawTitle);
String displayName = SharePreparation.normalizeSuggestedMarkdownName(rawTitle);
JSObject document = new JSObject();
document.put("canceled", false);
document.put("sourceUri", JSObject.NULL);
Expand Down Expand Up @@ -958,77 +951,6 @@ private Uri parseContentUri(String value) {
return uri;
}

private String normalizeSuggestedMarkdownName(String suggestedName) {
String cleaned = suggestedName == null ? "" : suggestedName.trim();
cleaned = cleaned.replaceAll("[\\\\/:*?\"<>|\\r\\n]+", " ");
cleaned = cleaned.replaceAll("\\s+", " ").trim();
if (cleaned.length() == 0) {
cleaned = "Untitled";
}

String lowerName = cleaned.toLowerCase(Locale.US);
if (
lowerName.endsWith(".md") ||
lowerName.endsWith(".markdown") ||
lowerName.endsWith(".mdown") ||
lowerName.endsWith(".mkdn") ||
lowerName.endsWith(".mkd")
) {
return cleaned;
}
return cleaned + ".md";
}

private ShareMarkdownPayload buildShareMarkdownPayload(String markdown) {
Map<String, File> images = new LinkedHashMap<>();
Matcher matcher = MARKTEXT_IMAGE_SOURCE_PATTERN.matcher(markdown);
StringBuffer rewrittenMarkdown = new StringBuffer();

while (matcher.find()) {
String fileName = normalizeImportedImageFileName(Uri.decode(matcher.group(1)));
if (fileName.length() == 0) {
continue;
}

File importedImage = new File(getImportedImageDirectoryFile(), fileName);
if (!isFileInDirectory(importedImage, getImportedImageDirectoryFile()) || !importedImage.isFile()) {
Log.w(TAG, "Skipping missing Android image during share: " + safeForLog(fileName));
continue;
}

images.put(fileName, importedImage);
matcher.appendReplacement(rewrittenMarkdown, Matcher.quoteReplacement(fileName));
}
// TODO: Add linked Android image attachments when the linked images setting is wired.
matcher.appendTail(rewrittenMarkdown);

return new ShareMarkdownPayload(rewrittenMarkdown.toString(), images);
}

private ClipData buildShareClipData(String suggestedName, ArrayList<Uri> streamUris) {
ClipData clipData = ClipData.newUri(getContext().getContentResolver(), suggestedName, streamUris.get(0));
for (int index = 1; index < streamUris.size(); index++) {
clipData.addItem(new ClipData.Item(streamUris.get(index)));
}
return clipData;
}

private String uniqueShareFileName(String fileName, Set<String> usedNames) {
if (usedNames.add(fileName.toLowerCase(Locale.US))) {
return fileName;
}

int extensionIndex = fileName.lastIndexOf('.');
String baseName = extensionIndex > 0 ? fileName.substring(0, extensionIndex) : fileName;
String extension = extensionIndex > 0 ? fileName.substring(extensionIndex) : "";
for (int counter = 2; ; counter++) {
String candidate = baseName + " " + counter + extension;
if (usedNames.add(candidate.toLowerCase(Locale.US))) {
return candidate;
}
}
}

private int getDocumentFlags(Uri uri) {
try (
Cursor cursor = getContext()
Expand All @@ -1041,70 +963,6 @@ private int getDocumentFlags(Uri uri) {
}
return 0;
}

private File getShareCacheDirectory() throws IOException {
File directory = new File(getContext().getCacheDir(), SHARE_CACHE_DIRECTORY);
if (!directory.exists() && !directory.mkdirs()) {
throw new IOException("Could not create share cache directory");
}
return directory;
}

private Uri writeShareCacheFile(File directory, String displayName, byte[] bytes) throws IOException {
File outputFile = new File(directory, normalizeSuggestedMarkdownName(displayName));
if (!isFileInDirectory(outputFile, directory)) {
throw new SecurityException("Share cache path escaped the expected directory");
}

try (OutputStream output = new FileOutputStream(outputFile, false)) {
output.write(bytes);
output.flush();
}

return FileProvider.getUriForFile(
getContext(),
getContext().getPackageName() + ".fileprovider",
outputFile
);
}

private File copyShareImageFile(File directory, String displayName, File sourceFile) throws IOException {
String normalizedName = normalizeImportedImageFileName(displayName);
if (normalizedName.length() == 0) {
throw new SecurityException("Invalid shared image file name");
}

File outputFile = new File(directory, normalizedName);
if (!isFileInDirectory(outputFile, directory)) {
throw new SecurityException("Shared image path escaped the expected directory");
}

try (
InputStream input = new java.io.FileInputStream(sourceFile);
OutputStream output = new FileOutputStream(outputFile, false)
) {
byte[] buffer = new byte[8192];
int read;
while ((read = input.read(buffer)) != -1) {
output.write(buffer, 0, read);
}
output.flush();
}

return outputFile;
}

private boolean isFileInDirectory(File file, File directory) {
try {
String directoryPath = directory.getCanonicalPath();
String filePath = file.getCanonicalPath();
return filePath.startsWith(directoryPath + File.separator);
} catch (IOException ex) {
Log.w(TAG, "Could not validate file path", ex);
return false;
}
}

private File getImportedImageDirectoryFile() {
return new File(getContext().getFilesDir(), IMPORTED_IMAGE_DIRECTORY);
}
Expand Down Expand Up @@ -1299,7 +1157,7 @@ private boolean isSupportedImage(String displayName, String mimeType) {
return (
mimeType.length() == 0 ||
"application/octet-stream".equals(mimeType)
) && hasSupportedImageExtension(displayName);
) && SharePreparation.hasSupportedImageExtension(displayName);
}

private boolean isSupportedImageMimeType(String mimeType) {
Expand All @@ -1313,18 +1171,6 @@ private boolean isSupportedImageMimeType(String mimeType) {
);
}

private boolean hasSupportedImageExtension(String value) {
String lowerName = value == null ? "" : value.toLowerCase(Locale.US);
return (
lowerName.endsWith(".jpg") ||
lowerName.endsWith(".jpeg") ||
lowerName.endsWith(".png") ||
lowerName.endsWith(".gif") ||
lowerName.endsWith(".webp") ||
lowerName.endsWith(".svg")
);
}

private String normalizeImageDisplayName(String displayName, String mimeType) {
String cleaned = displayName == null ? "" : displayName.trim();
cleaned = cleaned.replaceAll("[\\\\/:*?\"<>|\\r\\n]+", " ");
Expand All @@ -1333,7 +1179,7 @@ private String normalizeImageDisplayName(String displayName, String mimeType) {
cleaned = "Image";
}

if (hasSupportedImageExtension(cleaned)) {
if (SharePreparation.hasSupportedImageExtension(cleaned)) {
return cleaned;
}
return cleaned + extensionForImageMimeType(mimeType);
Expand All @@ -1358,19 +1204,6 @@ private String createStoredImageName(String displayName, String mimeType) {
return System.currentTimeMillis() + "-" + unique + "-" + baseName + extension;
}

private String normalizeImportedImageFileName(String fileName) {
String normalized = fileName == null ? "" : fileName.trim();
if (
normalized.length() == 0 ||
normalized.contains("/") ||
normalized.contains("\\") ||
!hasSupportedImageExtension(normalized)
) {
return "";
}
return normalized;
}

private String extensionFromImageName(String displayName) {
String lowerName = displayName == null ? "" : displayName.toLowerCase(Locale.US);
if (lowerName.endsWith(".jpeg")) {
Expand Down Expand Up @@ -1454,14 +1287,4 @@ private String safeForLog(String value) {
return value.replace('\r', ' ').replace('\n', ' ').trim();
}

private static class ShareMarkdownPayload {

final String markdown;
final Map<String, File> images;

ShareMarkdownPayload(String markdown, Map<String, File> images) {
this.markdown = markdown;
this.images = images;
}
}
}
16 changes: 16 additions & 0 deletions android/app/src/main/java/io/github/renakoni/marktextandroid/ShareMarkdownPayload.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
package io.github.renakoni.marktextandroid;

import java.io.File;
import java.util.Map;

/** Markdown rewritten for sharing plus the image files to attach. */
class ShareMarkdownPayload {

final String markdown;
final Map<String, File> images;

ShareMarkdownPayload(String markdown, Map<String, File> images) {
this.markdown = markdown;
this.images = images;
}
}
Loading
Loading