Send inactive user mail reminder (#546)

* Add functionality to query notebook apps and count them in the get apps endpoint

* add the send inactive user mail reminder  endpoint

Author: CHRISTOPHERKADOGO

api_docs.yml

@@ -775,7 +775,36 @@ paths:
           description: "Bad request"
         500:
           description: "Internal Server Error"
-
+  "/users/inactive_user_reminder":
+    post:
+      tags:
+        - inactive_user_reminder
+      parameters:
+        - in: header
+          name: Authorization
+          required: true
+          type: string
+          description: "Bearer [token]"
+        - in: query
+          name: value
+          required: true
+          type: integer
+          description: "Numeric value for the time period"
+        - in: query
+          name: unit
+          required: true
+          type: string
+          enum: [hours, days, months]
+          description: "Unit of time (hours/days/months)"
+      produces:
+        - application/json
+      responses:
+        200:
+          description: "Success"
+        400:
+          description: "Bad request - Invalid parameters"
+        500:
+          description: "Internal Server Error"
   "/clusters":
     post:
       tags:

app/controllers/__init__.py

@@ -4,7 +4,7 @@
 from .users import (
     UsersView, UserLoginView, UserEmailVerificationView, UserFollowersView, UserFollowView,
     EmailVerificationRequest, ForgotPasswordView, ResetPasswordView, UserDisableView, UserEnableView,
-    UserDetailView, AdminLoginView, OAuthView, UserDataSummaryView, UserAdminUpdateView, InActiveUsersView)
+    UserDetailView, AdminLoginView, OAuthView, UserDataSummaryView, UserAdminUpdateView, InActiveUsersView, SendInactiveUserMailReminder)
 from .deployments import DeploymentsView
 from .clusters import (
     ClustersView, ClusterDetailView, ClusterNamespacesView,

app/controllers/users.py

@@ -3,9 +3,10 @@
 import os
 from types import SimpleNamespace
 from app.helpers.activity_logger import log_activity
+from app.helpers.inactiveUser_notification import send_inactive_notification_to_user
 from app.helpers.kube import disable_project, enable_project
 from flask import current_app, render_template
-from flask_restful import Resource, request
+from flask_restful import Resource, request,reqparse
 from flask_bcrypt import Bcrypt
 from app.schemas import UserSchema, UserGraphSchema, ActivityLogSchema
 from app.models.user import User
@@ -1334,3 +1335,74 @@ def get(self, user_id):
             status='success',
             data=dict(followers=json.loads(users_data))
         ), 200
+
+
+
+class SendInactiveUserMailReminder(Resource):
+    @admin_required
+    def post(self):
+
+        parser = reqparse.RequestParser()
+        parser.add_argument('value', type=int, required=True, 
+                          help='Time period value is required')
+        parser.add_argument('unit', type=str, required=True, 
+                          choices=('hours', 'days', 'months'),
+                          help='Time unit must be hours, days, or months')
+
+        args = parser.parse_args()
+        value = args['value']
+        unit = args['unit'].lower()
+
+        now = datetime.now()
+        if unit == 'hours':
+            lower_threshold = now - timedelta(hours=value)
+            upper_threshold = now - timedelta(hours=value-1)
+        elif unit == 'days':
+            lower_threshold = now - timedelta(days=value)
+            upper_threshold = now - timedelta(days=value-1)
+        else:  
+            lower_threshold = now - timedelta(days=value * 30)
+            upper_threshold = now - timedelta(days=(value-1) * 30) 
+        
+       
+        inactive_users = User.query.filter(
+            User.last_seen <= upper_threshold,
+            User.last_seen > lower_threshold,
+        
+            User.verified == True,  
+            User.disabled == False, 
+            User.admin_disabled == False  
+        ).all()
+        
+        already_notified = set()  
+
+        emails_sent = 0
+        errors = []
+        
+        for user in inactive_users:
+            try:
+                success = send_inactive_notification_to_user(
+                    email=user.email,
+                    name=user.name,
+                    app=current_app._get_current_object(),
+                    template="user/inactive_user_reminder.html",
+                    subject="Checking In: Your Crane Cloud Account",
+                    date=now.strftime("%m/%d/%Y"),
+                    is_success_template=True
+                )
+                
+                if success:
+                    emails_sent += 1
+                    already_notified.add(user.email)
+                else:
+                    errors.append(f"Failed to send email to {user.email}")
+                    
+            except Exception as e:
+                errors.append(f"Error sending email to {user.email}: {str(e)}")
+        
+        return dict(
+            status='success',
+            message=f'Successfully sent {emails_sent} reminder emails',
+            total_users_processed=len(inactive_users),
+            errors=errors if errors else None
+        ), 200

app/helpers/inactiveUser_notification.py

@@ -0,0 +1,20 @@
+from flask import render_template
+from .email import send_email
+from flask import Flask, request
+
+
+def send_inactive_notification_to_user(email, name, app, template, subject, date, is_success_template=None):
+    try:
+        html = render_template(template,
+                              name=name, 
+                              success=is_success_template) 
+        
+        result = send_email(email, subject, html, email, app)
+        if result is None:
+            return True
+
+        return result
+        
+    except Exception as e:
+        print(f"Error in send_inactive_notification_to_user: {str(e)}")
+        return False  

app/routes/__init__.py

@@ -15,7 +15,7 @@
     BillingInvoiceView, BillingInvoiceNotificationView, SystemSummaryView, CreditDetailView, ProjectUsersView, ProjectUsersTransferView, AppReviseView,
     ProjectUsersHandleInviteView, ClusterProjectsView, ProjectDisableView, ProjectEnableView, AppRedeployView, AppDisableView, AppEnableView,
     TagsView, TagsDetailView, TagFollowingView, GenericSearchView, MLProjectAppsView,
-    UserDisableView, UserEnableView, AppDockerWebhookListenerView, UserFollowersView, UserFollowView, ProjectFollowingView, ActivityFeedView)
+    UserDisableView, UserEnableView, AppDockerWebhookListenerView, UserFollowersView, UserFollowView, ProjectFollowingView, ActivityFeedView,SendInactiveUserMailReminder,)
 from app.controllers.app import AppRevisionsView
 from app.controllers.billing_invoice import BillingInvoiceDetailView
 from app.controllers.receipts import BillingReceiptsDetailView, BillingReceiptsView
@@ -193,3 +193,7 @@
 
 # system status
 api.add_resource(SystemSummaryView, '/system_summary')
+
+# Send inactive user mail reminder
+api.add_resource(SendInactiveUserMailReminder, '/users/inactive_user_reminder',
+                 endpoint='inactive_user_reminder')