Skip to content

Commit

Permalink
Added: Add dynamic shortcuts
Browse files Browse the repository at this point in the history 
Co-authored-by: Fabian Thomas <fabian@fabianthomas.de>
Co-authored-by: agnostic-apollo <agnosticapollo@gmail.com>
  • Loading branch information
@fabian-thomas @agnostic-apollo
fabian-thomas and agnostic-apollo committed Oct 29, 2022
1 parent ad155a6 commit d4771d6
Show file tree
Hide file tree
Showing 4 changed files with 309 additions and 9 deletions.
12 changes: 6 additions & 6 deletions app/src/main/java/com/termux/widget/TermuxCreateShortcutActivity.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -147,10 +147,10 @@ private void createPinnedShortcut(Context context, String shortcutFilePath) {
String shortcutFileName = ShellUtils.getExecutableBasename(shortcutFilePath);

ShortcutInfo.Builder builder = new ShortcutInfo.Builder(context, shortcutFilePath);
builder.setIntent(getExecutionIntent(context, shortcutFilePath));
builder.setIntent(TermuxCreateShortcutActivity.getExecutionIntent(context, shortcutFilePath));
builder.setShortLabel(shortcutFileName);

File shortcutIconFile = getShortcutIconFile(context, shortcutFileName);
File shortcutIconFile = TermuxCreateShortcutActivity.getShortcutIconFile(context, shortcutFileName);
if (shortcutIconFile != null)
builder.setIcon(Icon.createWithBitmap(((BitmapDrawable) Drawable.createFromPath(shortcutIconFile.getAbsolutePath())).getBitmap()));
else
Expand All @@ -165,10 +165,10 @@ private void createStaticShortcut(Context context, String shortcutFilePath) {
String shortcutFileName = ShellUtils.getExecutableBasename(shortcutFilePath);

Intent intent = new Intent();
intent.putExtra(Intent.EXTRA_SHORTCUT_INTENT, getExecutionIntent(context, shortcutFilePath));
intent.putExtra(Intent.EXTRA_SHORTCUT_INTENT, TermuxCreateShortcutActivity.getExecutionIntent(context, shortcutFilePath));
intent.putExtra(Intent.EXTRA_SHORTCUT_NAME, shortcutFileName);

File shortcutIconFile = getShortcutIconFile(context, shortcutFileName);
File shortcutIconFile = TermuxCreateShortcutActivity.getShortcutIconFile(context, shortcutFileName);
if (shortcutIconFile != null)
intent.putExtra(Intent.EXTRA_SHORTCUT_ICON, ((BitmapDrawable) Drawable.createFromPath(shortcutIconFile.getAbsolutePath())).getBitmap());
else
Expand All @@ -179,7 +179,7 @@ private void createStaticShortcut(Context context, String shortcutFilePath) {
setResult(RESULT_OK, intent);
}

private Intent getExecutionIntent(Context context, String shortcutFilePath) {
public static Intent getExecutionIntent(Context context, String shortcutFilePath) {
Uri scriptUri = new Uri.Builder().scheme(TERMUX_SERVICE.URI_SCHEME_SERVICE_EXECUTE).path(shortcutFilePath).build();
Intent executionIntent = new Intent(context, TermuxLaunchShortcutActivity.class);
executionIntent.setAction(TERMUX_SERVICE.ACTION_SERVICE_EXECUTE); // Mandatory for pinned shortcuts
Expand All @@ -189,7 +189,7 @@ private Intent getExecutionIntent(Context context, String shortcutFilePath) {
}

@Nullable
private File getShortcutIconFile(Context context, String shortcutFileName) {
public static File getShortcutIconFile(Context context, String shortcutFileName) {
String errmsg;
String shortcutIconFilePath = FileUtils.getCanonicalPath(
TermuxConstants.TERMUX_SHORTCUT_SCRIPT_ICONS_DIR_PATH +
Expand Down
195 changes: 195 additions & 0 deletions app/src/main/java/com/termux/widget/activities/TermuxWidgetActivity.java
View file
Original file line number Diff line number Diff line change
@@ -1,29 +1,93 @@
package com.termux.widget.activities;

import android.os.Bundle;
import android.view.View;
import android.widget.Button;
import android.widget.LinearLayout;
import android.widget.TextView;
import android.content.Context;
import android.content.Intent;
import android.content.pm.ShortcutInfo;
import android.content.pm.ShortcutManager;
import android.graphics.drawable.BitmapDrawable;
import android.graphics.drawable.Drawable;
import android.graphics.drawable.Icon;
import android.os.Build;

import androidx.annotation.NonNull;
import androidx.annotation.RequiresApi;
import androidx.appcompat.app.AppCompatActivity;

import com.termux.shared.file.FileUtils;
import com.termux.shared.file.TermuxFileUtils;
import com.termux.shared.logger.Logger;
import com.termux.shared.models.errors.Error;
import com.termux.shared.packages.PackageUtils;
import com.termux.shared.termux.TermuxConstants;
import com.termux.widget.R;
import com.termux.shared.shell.ShellUtils;
import com.termux.widget.TermuxWidgetService;
import com.termux.widget.TermuxCreateShortcutActivity;
import com.termux.widget.NaturalOrderComparator;

import java.io.File;
import java.util.Arrays;
import java.util.ArrayList;
import java.util.List;
import java.util.regex.Pattern;

public class TermuxWidgetActivity extends AppCompatActivity {

private static final String LOG_TAG = "TermuxWidgetActivity";

/** Termux:Widget app data home directory path. */
public static final String TERMUX_WIDGET_DATA_HOME_DIR_PATH = TermuxConstants.TERMUX_DATA_HOME_DIR_PATH + "/widget"; // Default: "/data/data/com.termux/files/home/.termux/widget"

/** Termux:Widget app directory path to store scripts/binaries to be used as dynamic shortcuts. */
public static final String TERMUX_WIDGET_DYNAMIC_SHORTCUTS_DIR_PATH = TERMUX_WIDGET_DATA_HOME_DIR_PATH + "/dynamic_shortcuts"; // Default: "/data/data/com.termux/files/home/.termux/widget/dynamic_shortcuts"

public static final String MAX_SHORTCUTS_LIMIT_DOCS_URL = TermuxConstants.TERMUX_WIDGET_GITHUB_REPO_URL + "#max-shortcuts-limit-optional"; // Default: "https://github.com/termux/termux-widget#max-shortcuts-limit-optional"

@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);

Logger.logDebug(LOG_TAG, "onCreate");

setContentView(R.layout.activity_termux_widget);

TextView pluginInfo = findViewById(R.id.textview_plugin_info);
pluginInfo.setText(getString(R.string.plugin_info, TermuxConstants.TERMUX_GITHUB_REPO_URL,
TermuxConstants.TERMUX_WIDGET_GITHUB_REPO_URL));

setDisableLauncherIconViews();
setDynamicShortcutsViews();
}

@Override
protected void onResume() {
super.onResume();

Logger.logVerbose(LOG_TAG, "onResume");

setMaxShortcutsLimitView();
}

private void setMaxShortcutsLimitView() {
LinearLayout maxShortcutsInfoLinearLayout = findViewById(R.id.linearlayout_max_shortcuts_limit_info);
maxShortcutsInfoLinearLayout.setVisibility(View.GONE);
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N_MR1) {
ShortcutManager shortcutManager = getShortcutManager(this, true);
TextView maxShortcutsInfoTextView = findViewById(R.id.textview_max_shortcuts_limit_info);
if (shortcutManager != null) {
maxShortcutsInfoLinearLayout.setVisibility(View.VISIBLE);
maxShortcutsInfoTextView.setText(getString(R.string.msg_max_shortcuts_limit_info,
shortcutManager.getMaxShortcutCountPerActivity(), MAX_SHORTCUTS_LIMIT_DOCS_URL));
}
}
}

private void setDisableLauncherIconViews() {
Button disableLauncherIconButton = findViewById(R.id.btn_disable_launcher_icon);
disableLauncherIconButton.setOnClickListener(v -> {
String message = getString(R.string.msg_disabling_launcher_icon, TermuxConstants.TERMUX_WIDGET_APP_NAME);
Expand All @@ -34,4 +98,135 @@ protected void onCreate(Bundle savedInstanceState) {
});
}

private void setDynamicShortcutsViews() {
LinearLayout dynamicShortcutsLinearLayout = findViewById(R.id.linearlayout_dynamic_shortcuts);

if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N_MR1) {
dynamicShortcutsLinearLayout.setVisibility(View.VISIBLE);

TextView dynamicShortcutsInfoTextView = findViewById(R.id.textview_dynamic_shortcuts_info);
dynamicShortcutsInfoTextView.setText(getString(R.string.msg_dynamic_shortcuts_info,
TermuxFileUtils.getUnExpandedTermuxPath(TERMUX_WIDGET_DYNAMIC_SHORTCUTS_DIR_PATH)));

Button createDynamicShortcutsButton = findViewById(R.id.btn_create_dynamic_shortcuts);
createDynamicShortcutsButton.setOnClickListener(v -> createDynamicShortcuts(TermuxWidgetActivity.this));

Button removeDynamicShortcutsButton = findViewById(R.id.btn_remove_dynamic_shortcuts);
removeDynamicShortcutsButton.setOnClickListener(v -> removeDynamicShortcuts(TermuxWidgetActivity.this));
} else {
dynamicShortcutsLinearLayout.setVisibility(View.GONE);
}
}

@RequiresApi(api = Build.VERSION_CODES.N_MR1)
public static ShortcutManager getShortcutManager(@NonNull Context context, boolean showToast) {
ShortcutManager shortcutManager = (ShortcutManager) context.getSystemService(Context.SHORTCUT_SERVICE);
if (shortcutManager == null) {
Logger.logErrorAndShowToast(showToast ? context : null, LOG_TAG, "Failed to get shortcut manager");
return null;
}
return shortcutManager;
}

private static void enumerateShortcutFiles(List<TermuxWidgetService.TermuxWidgetItem> items, File dir, boolean sorted) {
enumerateShortcutFiles(items, dir, sorted, 0);
}

private static void enumerateShortcutFiles(List<TermuxWidgetService.TermuxWidgetItem> items, File dir, boolean sorted, int depth) {
if (depth > 5) return;

File[] files = dir.listFiles(TermuxWidgetService.SHORTCUT_FILES_FILTER);

if (files == null) return;

if (sorted) {
Arrays.sort(files, (lhs, rhs) -> {
if (lhs.isDirectory() != rhs.isDirectory()) {
return lhs.isDirectory() ? 1 : -1;
}
return NaturalOrderComparator.compare(lhs.getName(), rhs.getName());
});
}

for (File file : files) {
if (file.isDirectory()) {
enumerateShortcutFiles(items, file, sorted, depth + 1);
} else {
items.add(new TermuxWidgetService.TermuxWidgetItem(file, depth));
}
}

}

@RequiresApi(Build.VERSION_CODES.N_MR1)
private void createDynamicShortcuts(@NonNull Context context) {
ShortcutManager shortcutManager = getShortcutManager(context, true);
if (shortcutManager == null) return;

// Create directory if necessary so user more easily finds where to put shortcuts
Error error = FileUtils.createDirectoryFile(TERMUX_WIDGET_DYNAMIC_SHORTCUTS_DIR_PATH);
if (error != null) {
Logger.logError(LOG_TAG, error.toString());
Logger.showToast(this, Error.getMinimalErrorLogString(error), true);
}

List<TermuxWidgetService.TermuxWidgetItem> items = new ArrayList<>();
enumerateShortcutFiles(items, new File(TERMUX_WIDGET_DYNAMIC_SHORTCUTS_DIR_PATH), false);

if (items.size() == 0) {
Logger.showToast(context, getString(R.string.msg_no_shortcut_files_found_in_directory,
TermuxFileUtils.getUnExpandedTermuxPath(TERMUX_WIDGET_DYNAMIC_SHORTCUTS_DIR_PATH)), true);
return;
}

List<ShortcutInfo> shortcuts = new ArrayList<>();
for (TermuxWidgetService.TermuxWidgetItem item : items) {
ShortcutInfo.Builder builder = new ShortcutInfo.Builder(context, item.mFile);
builder.setIntent(TermuxCreateShortcutActivity.getExecutionIntent(context, item.mFile));
builder.setShortLabel(item.mLabel);

File shortcutIconFile = TermuxCreateShortcutActivity.getShortcutIconFile(context, ShellUtils.getExecutableBasename(item.mFile));
if (shortcutIconFile != null)
builder.setIcon(Icon.createWithBitmap(((BitmapDrawable) Drawable.createFromPath(shortcutIconFile.getAbsolutePath())).getBitmap()));
else
builder.setIcon(Icon.createWithResource(context, R.drawable.ic_launcher));

shortcuts.add(builder.build());
}

// Remove shortcuts that can not be added.
int maxShortcuts = shortcutManager.getMaxShortcutCountPerActivity();
Logger.logDebug(LOG_TAG, "Found " + items.size() + " shortcuts and max shortcuts limit is " + maxShortcuts);
if (shortcuts.size() > maxShortcuts) {
Logger.logErrorAndShowToast(context, LOG_TAG, getString(R.string.msg_dynamic_shortcuts_limit_reached, maxShortcuts));
while (shortcuts.size() > maxShortcuts) {
String message = getString(R.string.msg_skipping_shortcut,
shortcuts.get(shortcuts.size() - 1).getId().replaceAll(
"^" + Pattern.quote(TERMUX_WIDGET_DYNAMIC_SHORTCUTS_DIR_PATH + "/"), ""));
Logger.showToast(context, message, false);
Logger.logDebug(LOG_TAG, message);
shortcuts.remove(shortcuts.size() - 1);
}
}

shortcutManager.removeAllDynamicShortcuts();
shortcutManager.addDynamicShortcuts(shortcuts);
Logger.logDebugAndShowToast(context, LOG_TAG, getString(R.string.msg_created_dynamic_shortcuts_successfully, shortcuts.size()));
}

@RequiresApi(Build.VERSION_CODES.N_MR1)
private void removeDynamicShortcuts(@NonNull Context context) {
ShortcutManager shortcutManager = getShortcutManager(context, true);
if (shortcutManager == null) return;

List<ShortcutInfo> shortcuts = shortcutManager.getDynamicShortcuts();
if (shortcuts != null && shortcuts.size() == 0) {
Logger.logDebugAndShowToast(context, LOG_TAG, getString(R.string.msg_no_dynamic_shortcuts_currently_created));
return;
}

shortcutManager.removeAllDynamicShortcuts();
Logger.logDebugAndShowToast(context, LOG_TAG, getString(R.string.msg_removed_dynamic_shortcuts_successfully));
}

}
88 changes: 87 additions & 1 deletion app/src/main/res/layout/activity_termux_widget.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,32 @@
android:textColorLink="?android:textColorLink"
android:autoLink="web"/>



<LinearLayout
android:id="@+id/linearlayout_max_shortcuts_limit_info"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:orientation="vertical">
<View style="@style/ViewDivider"/>

<com.google.android.material.textview.MaterialTextView
android:id="@+id/textview_max_shortcuts_limit_info"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:paddingTop="@dimen/activity_vertical_margin"
android:paddingBottom="@dimen/activity_vertical_margin"
android:gravity="start|center_vertical"
android:textSize="14sp"
android:textStyle="normal"
android:textColor="?android:textColorPrimary"
android:textColorLink="?android:textColorLink"
android:autoLink="web"/>

</LinearLayout>



<View style="@style/ViewDivider"/>

<com.google.android.material.textview.MaterialTextView
Expand All @@ -35,7 +61,7 @@
android:layout_height="wrap_content"
android:paddingBottom="@dimen/activity_vertical_margin"
android:gravity="start|center_vertical"
android:text="@string/msg_disable_launcher_icon_details"
android:text="@string/msg_disable_launcher_icon_info"
android:textSize="14sp"
android:textStyle="normal"
android:textColor="?android:textColorPrimary"
Expand All @@ -54,6 +80,66 @@
android:textColor="?android:textColorPrimary"
app:strokeColor="?android:textColorPrimary"
app:strokeWidth="2dp"/>



<LinearLayout
android:id="@+id/linearlayout_dynamic_shortcuts"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:orientation="vertical">

<View style="@style/ViewDivider"/>

<com.google.android.material.textview.MaterialTextView
android:id="@+id/textview_dynamic_shortcuts_info"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:paddingBottom="@dimen/activity_vertical_margin"
android:gravity="start|center_vertical"
android:textSize="14sp"
android:textStyle="normal"
android:textColor="?android:textColorPrimary"
android:textColorLink="?android:textColorLink"
android:autoLink="web"/>

<LinearLayout
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:orientation="horizontal">

<com.google.android.material.button.MaterialButton
style="@style/Widget.MaterialComponents.Button.OutlinedButton"
android:id="@+id/btn_remove_dynamic_shortcuts"
android:layout_width="0dp"
android:layout_height="wrap_content"
android:layout_weight="1"
android:gravity="center"
android:layout_marginStart="@dimen/content_padding_half"
android:layout_marginEnd="@dimen/content_padding_half"
android:text="@string/action_remove_dynamic_shortcuts"
android:textSize="12sp"
android:textColor="?android:textColorPrimary"
app:strokeColor="?android:textColorPrimary"
app:strokeWidth="2dp"/>

<com.google.android.material.button.MaterialButton
style="@style/Widget.MaterialComponents.Button.OutlinedButton"
android:id="@+id/btn_create_dynamic_shortcuts"
android:layout_width="0dp"
android:layout_height="wrap_content"
android:layout_weight="1"
android:gravity="center"
android:layout_marginStart="@dimen/content_padding_half"
android:layout_marginEnd="@dimen/content_padding_half"
android:text="@string/action_create_dynamic_shortcuts"
android:textSize="12sp"
android:textColor="?android:textColorPrimary"
app:strokeColor="?android:textColorPrimary"
app:strokeWidth="2dp"/>
</LinearLayout>
</LinearLayout>

</LinearLayout>

</ScrollView>
Loading

0 comments on commit d4771d6

Please sign in to comment.