android-notify 1.3__py3-none-any.whl → 1.60.6.dev0__py3-none-any.whl

android_notify/config.py

@@ -0,0 +1,167 @@
+import os, traceback
+
+ON_ANDROID = False
+__version__ = "1.60.6.dev0"
+
+def is_platform_android():
+    if os.getenv("MAIN_ACTIVITY_HOST_CLASS_NAME"):
+        return True
+    kivy_build = os.environ.get('KIVY_BUILD', '')
+    if kivy_build in {'android'}:
+        return True
+    elif 'P4A_BOOTSTRAP' in os.environ:
+        return True
+    elif 'ANDROID_ARGUMENT' in os.environ:
+        return True
+
+    return False
+
+
+def on_flet_app():
+    return os.getenv("MAIN_ACTIVITY_HOST_CLASS_NAME")
+
+
+def get_activity_class_name():
+    ACTIVITY_CLASS_NAME = os.getenv("MAIN_ACTIVITY_HOST_CLASS_NAME")  # flet python
+    if not ACTIVITY_CLASS_NAME:
+        try:
+            from android import config  # type: ignore
+            ACTIVITY_CLASS_NAME = config.JAVA_NAMESPACE
+        except (ImportError, AttributeError):
+            ACTIVITY_CLASS_NAME = 'org.kivy.android'
+    return ACTIVITY_CLASS_NAME
+
+
+if is_platform_android():
+    try:
+        from jnius import cast, autoclass
+    except Exception as error_importing_frm_jnius:
+        print('android-notify: No pjnius, not on android? Error-',error_importing_frm_jnius)
+        # So commandline still works if java isn't installed and get pyjinus import error
+        cast = lambda x: x
+        autoclass = lambda x: None
+
+    try:
+        # Android Imports
+
+        # Get the required Java classes needs to on android to import
+        Bundle = autoclass('android.os.Bundle')
+        String = autoclass('java.lang.String')
+        Intent = autoclass('android.content.Intent')
+        PendingIntent = autoclass('android.app.PendingIntent')
+        BitmapFactory = autoclass('android.graphics.BitmapFactory')
+        BuildVersion = autoclass('android.os.Build$VERSION')
+        NotificationManagerClass = autoclass('android.app.NotificationManager')
+        NotificationChannel = autoclass('android.app.NotificationChannel')
+        RemoteViews = autoclass('android.widget.RemoteViews')
+        AndroidNotification = autoclass("android.app.Notification")
+        Settings = autoclass("android.provider.Settings")
+        Uri = autoclass("android.net.Uri")
+        Manifest = autoclass('android.Manifest$permission')
+
+        ON_ANDROID = bool(RemoteViews)
+    except Exception as e:
+        from .an_types import *
+        print('Exception: ', e)
+        print(traceback.format_exc())
+else:
+    from .an_types import *
+    cast = lambda x: x
+    autoclass = lambda x: None
+
+if ON_ANDROID:
+    try:
+        Color = autoclass('android.graphics.Color')
+
+        # Notification Design
+        NotificationCompatBuilder = autoclass('android.app.Notification$Builder')
+        NotificationCompatBigTextStyle = autoclass('android.app.Notification$BigTextStyle')
+        NotificationCompatBigPictureStyle = autoclass('android.app.Notification$BigPictureStyle')
+        NotificationCompatInboxStyle = autoclass('android.app.Notification$InboxStyle')
+        # NotificationCompatDecoratedCustomViewStyle = autoclass('androidx.core.app.NotificationCompat$DecoratedCustomViewStyle')
+
+    except Exception as styles_import_error:
+        print('styles_import_error: ', styles_import_error)
+
+        from .an_types import *
+else:
+    from .an_types import *
+
+
+def from_service_file():
+    return 'PYTHON_SERVICE_ARGUMENT' in os.environ
+
+
+run_on_ui_thread = None
+if on_flet_app() or from_service_file() or not ON_ANDROID:
+    def run_on_ui_thread(func):
+        """Fallback for Developing on PC"""
+
+        def wrapper(*args, **kwargs):
+            # print("Simulating run on UI thread")
+            return func(*args, **kwargs)
+
+        return wrapper
+else:  # TODO find var for kivy
+    from android.runnable import run_on_ui_thread
+
+
+def get_python_activity():
+    if not ON_ANDROID:
+        from .an_types import PythonActivity
+        return PythonActivity
+    ACTIVITY_CLASS_NAME = get_activity_class_name()
+    if on_flet_app():
+        PythonActivity = autoclass(ACTIVITY_CLASS_NAME)
+    else:
+        PythonActivity = autoclass(ACTIVITY_CLASS_NAME + '.PythonActivity')
+    return PythonActivity
+
+
+def get_python_service():
+    if not ON_ANDROID:
+        return None
+    PythonService = autoclass(get_activity_class_name() + '.PythonService')
+    return PythonService.mService
+
+
+def get_python_activity_context():
+    if not ON_ANDROID:
+        from .an_types import Context
+        return Context
+
+    PythonActivity = get_python_activity()
+    if from_service_file():
+        service = get_python_service()
+        context = service.getApplication().getApplicationContext()
+    else:
+        context = PythonActivity.mActivity
+    return context
+
+
+if ON_ANDROID:
+    context = get_python_activity_context()
+else:
+    context = None
+
+
+def get_notification_manager():
+    if not ON_ANDROID:
+        return None
+    notification_service = context.getSystemService(context.NOTIFICATION_SERVICE)
+    return cast(NotificationManagerClass, notification_service)
+
+
+def app_storage_path():
+    if on_flet_app():
+        return os.path.join(context.getFilesDir().getAbsolutePath(), 'flet')
+    else:
+        try:
+            from android.storage import app_storage_path as kivy_app_storage_path  # type: ignore
+            return kivy_app_storage_path()
+        except Exception as e:
+            return './'  # TODO return file main.py path (not android)
+
+
+def get_package_name():
+    return context.getPackageName()  # package.domain + "." + package.name

android_notify/core.py

@@ -1,50 +1,100 @@
 """ Non-Advanced Stuff """
 import random
-import os
-from jnius import autoclass,cast
+import os, traceback
+from .config import get_python_activity, Manifest, is_platform_android
 
 ON_ANDROID = False
-try:
-    # Get the required Java classes
-    PythonActivity = autoclass('org.kivy.android.PythonActivity')
-    NotificationChannel = autoclass('android.app.NotificationChannel')
-    String = autoclass('java.lang.String')
-    Intent = autoclass('android.content.Intent')
-    PendingIntent = autoclass('android.app.PendingIntent')
-    context = PythonActivity.mActivity # Get the app's context 
-    BitmapFactory = autoclass('android.graphics.BitmapFactory')
-    BuildVersion = autoclass('android.os.Build$VERSION')    
-    ON_ANDROID=True
-except Exception as e:
-    print('This Package Only Runs on Android !!! ---> Check "https://github.com/Fector101/android_notify/" to see design patterns and more info.')
 
-if ON_ANDROID:
+
+def on_flet_app():
+    return os.getenv("MAIN_ACTIVITY_HOST_CLASS_NAME")
+
+
+if is_platform_android():
     try:
-        NotificationManagerCompat = autoclass('androidx.core.app.NotificationManagerCompat')                                       
-        NotificationCompat = autoclass('androidx.core.app.NotificationCompat')
+        from jnius import autoclass  # Needs Java to be installed
+        PythonActivity = get_python_activity()
+        context = PythonActivity.mActivity  # Get the app's context
+        NotificationChannel = autoclass('android.app.NotificationChannel')
+        String = autoclass('java.lang.String')
+        Intent = autoclass('android.content.Intent')
+        PendingIntent = autoclass('android.app.PendingIntent')
+        BitmapFactory = autoclass('android.graphics.BitmapFactory')
+        BuildVersion = autoclass('android.os.Build$VERSION')
+        Notification = autoclass("android.app.Notification")
+        ON_ANDROID = True
+    except Exception as e:
+        print("android-notify: Error importing Java Classes-",e)
+        traceback.print_exc()
+
 
+if ON_ANDROID:
+    try:
+        NotificationManagerCompat = autoclass('android.app.NotificationManager')
         # Notification Design
-        NotificationCompatBuilder = autoclass('androidx.core.app.NotificationCompat$Builder')
-        NotificationCompatBigTextStyle = autoclass('androidx.core.app.NotificationCompat$BigTextStyle')
-        NotificationCompatBigPictureStyle = autoclass('androidx.core.app.NotificationCompat$BigPictureStyle')
-        NotificationCompatInboxStyle = autoclass('androidx.core.app.NotificationCompat$InboxStyle')
+        NotificationCompatBuilder = autoclass('android.app.Notification$Builder')
+        NotificationCompatBigTextStyle = autoclass('android.app.Notification$BigTextStyle')
+        NotificationCompatBigPictureStyle = autoclass('android.app.Notification$BigPictureStyle')
+        NotificationCompatInboxStyle = autoclass('android.app.Notification$InboxStyle')
     except Exception as e:
-        print("""
-        Dependency Error: Add the following in buildozer.spec:
-        * android.gradle_dependencies = androidx.core:core-ktx:1.15.0, androidx.core:core:1.6.0
-        * android.enable_androidx = True
-        * android.permissions = POST_NOTIFICATIONS
-        """)
-
-def asks_permission_if_needed():
+        traceback.print_exc()
+        print("Error importing notification styles")
+
+from .an_utils import can_show_permission_request_popup, open_settings_screen
+
+
+def get_app_root_path():
+    path = ''
+    if on_flet_app():
+        path = os.path.join(context.getFilesDir().getAbsolutePath(), 'flet')
+    else:
+        try:
+            from android.storage import app_storage_path  # type: ignore
+            path = app_storage_path()
+        except Exception as e:
+            print('android-notify- Error getting apk main file path: ', e)
+            return './'
+    return os.path.join(path, 'app')
+
+
+def asks_permission_if_needed(legacy=False, no_androidx=False):
     """
     Ask for permission to send notifications if needed.
+    legacy parameter will replace no_androidx parameter in Future Versions
     """
-    from android.permissions import request_permissions, Permission,check_permission # type: ignore
+    if not ON_ANDROID:
+        print("android_notify- Can't ask permission when not on android")
+        return None
+
+    if BuildVersion.SDK_INT < 33:
+        print("android_notify- On android 12 or less don't need permission")
+        return True
+
+    if not can_show_permission_request_popup():
+        print("""android_notify- Permission to send notifications has been denied permanently.
+This happens when the user denies permission twice from the popup.
+Opening notification settings...
+""")
+        open_settings_screen()
+        return None
+
+    if on_flet_app() or no_androidx or legacy:
+        Activity = autoclass("android.app.Activity")
+        PackageManager = autoclass("android.content.pm.PackageManager")
+
+        permission = Manifest.POST_NOTIFICATIONS
+        granted = context.checkSelfPermission(permission)
+        if granted != PackageManager.PERMISSION_GRANTED:
+            context.requestPermissions([permission], 101)
+    else:  # android package is from p4a which is for kivy
+        try:
+            from android.permissions import request_permissions, Permission, check_permission  # type: ignore
+            permissions = [Permission.POST_NOTIFICATIONS]
+            if not all(check_permission(p) for p in permissions):
+                request_permissions(permissions)
+        except Exception as e:
+            print("android_notify- error trying to request notification access: ", e)
 
-    permissions=[Permission.POST_NOTIFICATIONS]
-    if not all(check_permission(p) for p in permissions):
-        request_permissions(permissions)
 
 def get_image_uri(relative_path):
     """
@@ -52,89 +102,134 @@ def get_image_uri(relative_path):
     :param relative_path: The relative path to the image (e.g., 'assets/imgs/icon.png').
     :return: Absolute URI java Object (e.g., 'file:///path/to/file.png').
     """
-    from android.storage import app_storage_path # type: ignore
-
-    output_path = os.path.join(app_storage_path(),'app', relative_path)
+    app_root_path = get_app_root_path()
+    output_path = os.path.join(app_root_path, relative_path)
     # print(output_path,'output_path')  # /data/user/0/org.laner.lan_ft/files/app/assets/imgs/icon.png
-    
+
     if not os.path.exists(output_path):
-        raise FileNotFoundError(f"Image not found at path: {output_path}")
-    
+        raise FileNotFoundError(f"\nImage not found at path: {output_path}\n")
+
     Uri = autoclass('android.net.Uri')
     return Uri.parse(f"file://{output_path}")
 
 
+def get_icon_object(uri):
+    BitmapFactory = autoclass('android.graphics.BitmapFactory')
+    IconCompat = autoclass('androidx.core.graphics.drawable.IconCompat')
+
+    bitmap = BitmapFactory.decodeStream(context.getContentResolver().openInputStream(uri))
+    return IconCompat.createWithBitmap(bitmap)
+
+
+def insert_app_icon(builder, custom_icon_path):
+    if custom_icon_path:
+        try:
+            uri = get_image_uri(custom_icon_path)
+            icon = get_icon_object(uri)
+            builder.setSmallIcon(icon)
+        except Exception as e:
+            print('android_notify- error: ', e)
+            builder.setSmallIcon(context.getApplicationInfo().icon)
+    else:
+        # print('Found res icon -->',context.getApplicationInfo().icon,'<--')
+        builder.setSmallIcon(context.getApplicationInfo().icon)
+
+
 def send_notification(
-    title:str,
-    message:str,
-    style=None,
-    img_path=None,
-    channel_name="Default Channel",
-    channel_id:str="default_channel"
-    ):
+        title: str,
+        message: str,
+        style=None,
+        img_path=None,
+        channel_name="Default Channel",
+        channel_id: str = "default_channel",
+        custom_app_icon_path="",
+
+        big_picture_path='',
+        large_icon_path='',
+        big_text="",
+        lines=""
+):
     """
     Send a notification on Android.
 
     :param title: Title of the notification.
     :param message: Message body.
-    :param style: Style of the notification ('big_text', 'big_picture', 'inbox', 'large_icon').
+    :param style: deprecated.
     :param img_path: Path to the image resource.
     :param channel_id: Notification channel ID.(Default is lowercase channel name arg in lowercase)
     """
     if not ON_ANDROID:
-        print('This Package Only Runs on Android !!! ---> Check "https://github.com/Fector101/android_notify/" for Documentation.')
-        return
-    asks_permission_if_needed()
-    channel_id=channel_name.replace(' ','_').lower().lower() if not channel_id else channel_id
+        print(
+            'This Package Only Runs on Android !!! ---> Check "https://github.com/Fector101/android_notify/" for Documentation.')
+        return None
+
+    asks_permission_if_needed(legacy=True)
+    channel_id = channel_name.replace(' ', '_').lower().lower() if not channel_id else channel_id
     # Get notification manager
     notification_manager = context.getSystemService(context.NOTIFICATION_SERVICE)
 
     # importance= autoclass('android.app.NotificationManager').IMPORTANCE_HIGH # also works #NotificationManager.IMPORTANCE_DEFAULT
-    importance= NotificationManagerCompat.IMPORTANCE_HIGH #autoclass('android.app.NotificationManager').IMPORTANCE_HIGH also works #NotificationManager.IMPORTANCE_DEFAULT
-    
+    importance = NotificationManagerCompat.IMPORTANCE_HIGH  # autoclass('android.app.NotificationManager').IMPORTANCE_HIGH also works #NotificationManager.IMPORTANCE_DEFAULT
+
     # Notification Channel (Required for Android 8.0+)
     if BuildVersion.SDK_INT >= 26:
-        channel = NotificationChannel(channel_id, channel_name,importance)
+        channel = NotificationChannel(channel_id, channel_name, importance)
         notification_manager.createNotificationChannel(channel)
 
     # Build the notification
     builder = NotificationCompatBuilder(context, channel_id)
     builder.setContentTitle(title)
     builder.setContentText(message)
-    builder.setSmallIcon(context.getApplicationInfo().icon)
-    builder.setDefaults(NotificationCompat.DEFAULT_ALL) 
-    builder.setPriority(NotificationCompat.PRIORITY_HIGH)
-    
-    img=None
+    insert_app_icon(builder, custom_app_icon_path)
+    builder.setDefaults(Notification.DEFAULT_ALL)
+    builder.setPriority(Notification.PRIORITY_HIGH)
+
     if img_path:
+        print(
+            'android_notify- img_path arg deprecated use "large_icon_path or big_picture_path or custom_app_icon_path" instead')
+    if style:
+        print(
+            'android_notify- "style" arg deprecated use args "big_picture_path", "large_icon_path", "big_text", "lines" instead')
+
+    big_picture = None
+    if big_picture_path:
         try:
-            img = get_image_uri(img_path)
+            big_picture = get_image_uri(big_picture_path)
         except FileNotFoundError as e:
-            print('Failed Adding Bitmap: ',e)
-    
+            print('android_notify- Error Getting Uri for big_picture_path: ', e)
+
+    large_icon = None
+    if large_icon_path:
+        try:
+            large_icon = get_image_uri(large_icon_path)
+        except FileNotFoundError as e:
+            print('android_notify- Error Getting Uri for large_icon_path: ', e)
+
     # Apply notification styles
     try:
-        if style == "big_text":
+        if big_text:
             big_text_style = NotificationCompatBigTextStyle()
-            big_text_style.bigText(message)
+            big_text_style.bigText(big_text)
             builder.setStyle(big_text_style)
-        elif style == "big_picture" and img_path:
-            bitmap = BitmapFactory.decodeStream(context.getContentResolver().openInputStream(img))
-            builder.setLargeIcon(bitmap)
-            big_picture_style = NotificationCompatBigPictureStyle().bigPicture(bitmap)
-            builder.setStyle(big_picture_style)
-        elif style == "inbox":
+
+        elif lines:
             inbox_style = NotificationCompatInboxStyle()
-            for line in message.split("\n"):
+            for line in lines.split("\n"):
                 inbox_style.addLine(line)
             builder.setStyle(inbox_style)
-        elif style == "large_icon" and img_path:
-            bitmap = BitmapFactory.decodeStream(context.getContentResolver().openInputStream(img))
+
+        if large_icon:
+            bitmap = BitmapFactory.decodeStream(context.getContentResolver().openInputStream(large_icon))
             builder.setLargeIcon(bitmap)
+
+        if big_picture:
+            bitmap = BitmapFactory.decodeStream(context.getContentResolver().openInputStream(big_picture))
+            big_picture_style = NotificationCompatBigPictureStyle().bigPicture(bitmap)
+            builder.setStyle(big_picture_style)
+
     except Exception as e:
-        print('Failed Adding Style: ',e)
+        print('android_notify- Error Failed Adding Style: ', e)
     # Display the notification
     notification_id = random.randint(0, 100)
     notification_manager.notify(notification_id, builder.build())
     return notification_id
-

android_notify/styles.py

@@ -1,15 +1,25 @@
-class NotificationStyles():
+"""Contains Safe way to call Styles"""
+
+class NotificationStyles:
     """ Safely Adding Styles"""
-    DEFAULT = "simple"
+        
+    # v1.59+
+    # Deprecated
+    # setBigText == Notification(...,big_picture_path="...",style=NotificationStyles.BIG_TEXT)
+    # setLargeIcon == Notification(...,large_icon_path="...",style=NotificationStyles.LARGE_ICON)
+    # setBigPicture == Notification(...,body="...",style=NotificationStyles.BIG_PICTURE)
+    # setLines == Notification(...,lines_txt="...",style=NotificationStyles.INBOX)
+    # Set progress_current_value and progress_max_value for progress style
+
+    # Use .refresh to apply any new changes after .send
     
+    DEFAULT = "simple"
     PROGRESS = "progress"
     INBOX = "inbox"
     BIG_TEXT = "big_text"
-    
     LARGE_ICON = "large_icon"
     BIG_PICTURE = "big_picture"
     BOTH_IMGS = "both_imgs"
-    
-    MESSAGING = "messaging" # TODO
-    CUSTOM = "custom" # TODO
-    
+
+    # MESSAGING = "messaging" # TODO
+    # CUSTOM = "custom" # TODO v1.60