27767614355

Committed 18 Jun 2026 02:44PM UTC coverage: 63.728% (+0.05%) from 63.675%

Build # 27767614355

Build Type

Pull #6206

github

Committed by

web-flow

Commit Message

Merge a4627fcce into 3ae412ec1

Pull Request Pull Request #6206: Require Get Alerts privilege to read all users' alerts

Coverage Stats

10 of 13 new or added lines in 2 files covered. (76.92%)

2 existing lines in 2 files now uncovered.

23940 of 37566 relevant lines covered (63.73%)

0.64 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/api/src/main/java/org/openmrs/scheduler/tasks/AlertReminderTask.java

/**
 * This Source Code Form is subject to the terms of the Mozilla Public License,
 * v. 2.0. If a copy of the MPL was not distributed with this file, You can
 * obtain one at http://mozilla.org/MPL/2.0/. OpenMRS is also distributed under
 * the terms of the Healthcare Disclaimer located at http://openmrs.org/license.
 *
 * Copyright (C) OpenMRS Inc. OpenMRS is a registered trademark and the OpenMRS
 * graphic logo is a trademark of OpenMRS Inc.
 */
package org.openmrs.scheduler.tasks;

import java.util.Collection;
import java.util.HashSet;

import org.openmrs.User;
import org.openmrs.api.context.Context;
import org.openmrs.notification.Alert;
import org.openmrs.notification.AlertRecipient;
import org.openmrs.notification.Message;
import org.openmrs.notification.MessageException;
import org.openmrs.util.PrivilegeConstants;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Sample implementation of task that shows how to send emails to users/roles via message service.
 */
public class AlertReminderTask extends AbstractTask {
        
        // Logger 
        private static final Logger log = LoggerFactory.getLogger(AlertReminderTask.class);
        
        /**
         * Send alert reminder email to user(s) associated with the alert.
         */
        @Override
        public void execute() {
                try {
                        // Get all unread alerts
                        // TODO Change to getAllAlerts(Boolean includeRead, Boolean includeExpired);
                        // getAllAlerts requires the Get Alerts privilege; this system task reads every
                        // user's alerts to notify them, so grant the privilege for the duration of the read.
                        Collection<Alert> alerts;
                        Context.addProxyPrivilege(PrivilegeConstants.GET_ALERTS);
                        try {
                                alerts = Context.getAlertService().getAllAlerts(false);
                        } finally {
                                Context.removeProxyPrivilege(PrivilegeConstants.GET_ALERTS);
                        }

                        // Send alert notifications to users who have unread alerts
                        sendAlertNotifications(alerts);
                        
                }
                catch (Exception e) {
                        log.error("Failed to send alert notifications", e);
                }
        }
        
        /**
         * Send alerts
         * 
         * @param alerts the unread alerts
         */
        private void sendAlertNotifications(Collection<Alert> alerts) {
                
                try {
                        
                        // Create a new message
                        Message message = Context.getMessageService().createMessage("Alert Reminder", "You have unread alerts.");
                        
                        // Get all recipients
                        Collection<User> users = getRecipients(alerts);
                        
                        // Send a message to each person only once
                        Context.getMessageService().sendMessage(message, users);
                        
                }
                catch (MessageException e) {
                        log.error("Failed to send message", e);
                }
        }
        
        /**
         * Get the recipients of all unread alerts.
         * 
         * @param alerts
         * @return the users who have not read the alerts
         */
        private Collection<User> getRecipients(Collection<Alert> alerts) {
                Collection<User> users = new HashSet<>();
                for (Alert alert : alerts) {
                        log.debug("Send email to alert recipient(s) ...");
                        if (!alert.isAlertRead() && alert.getRecipients() != null) {
                                for (AlertRecipient recipient : alert.getRecipients()) {
                                        if (!recipient.isAlertRead() && recipient.getRecipient() != null) {
                                                users.add(recipient.getRecipient());
                                        }
                                }
                        }
                }
                return users;
        }
        
}

1	/**
2	* This Source Code Form is subject to the terms of the Mozilla Public License,
3	* v. 2.0. If a copy of the MPL was not distributed with this file, You can
4	* obtain one at http://mozilla.org/MPL/2.0/. OpenMRS is also distributed under
5	* the terms of the Healthcare Disclaimer located at http://openmrs.org/license.
6	*
7	* Copyright (C) OpenMRS Inc. OpenMRS is a registered trademark and the OpenMRS
8	* graphic logo is a trademark of OpenMRS Inc.
9	*/
10	package org.openmrs.scheduler.tasks;
11
12	import java.util.Collection;
13	import java.util.HashSet;
14
15	import org.openmrs.User;
16	import org.openmrs.api.context.Context;
17	import org.openmrs.notification.Alert;
18	import org.openmrs.notification.AlertRecipient;
19	import org.openmrs.notification.Message;
20	import org.openmrs.notification.MessageException;
21	import org.openmrs.util.PrivilegeConstants;
22	import org.slf4j.Logger;
23	import org.slf4j.LoggerFactory;
24
25	/**
26	* Sample implementation of task that shows how to send emails to users/roles via message service.
27	*/
28	public class AlertReminderTask extends AbstractTask {	×
29
30	// Logger
31	private static final Logger log = LoggerFactory.getLogger(AlertReminderTask.class);	×
32
33	/**
34	* Send alert reminder email to user(s) associated with the alert.
35	*/
36	@Override
37	public void execute() {
38	try {
39	// Get all unread alerts
40	// TODO Change to getAllAlerts(Boolean includeRead, Boolean includeExpired);
41	// getAllAlerts requires the Get Alerts privilege; this system task reads every
42	// user's alerts to notify them, so grant the privilege for the duration of the read.
43	Collection<Alert> alerts;
NEW 44	Context.addProxyPrivilege(PrivilegeConstants.GET_ALERTS);	×
45	try {
NEW 46	alerts = Context.getAlertService().getAllAlerts(false);	×
47	} finally {
NEW 48	Context.removeProxyPrivilege(PrivilegeConstants.GET_ALERTS);	×
49	}
50
51	// Send alert notifications to users who have unread alerts
52	sendAlertNotifications(alerts);	×
53
54	}
55	catch (Exception e) {	×
56	log.error("Failed to send alert notifications", e);	×
57	}	×
58	}	×
59
60	/**
61	* Send alerts
62	*
63	* @param alerts the unread alerts
64	*/
65	private void sendAlertNotifications(Collection<Alert> alerts) {
66
67	try {
68
69	// Create a new message
70	Message message = Context.getMessageService().createMessage("Alert Reminder", "You have unread alerts.");	×
71
72	// Get all recipients
73	Collection<User> users = getRecipients(alerts);	×
74
75	// Send a message to each person only once
76	Context.getMessageService().sendMessage(message, users);	×
77
78	}
79	catch (MessageException e) {	×
80	log.error("Failed to send message", e);	×
81	}	×
82	}	×
83
84	/**
85	* Get the recipients of all unread alerts.
86	*
87	* @param alerts
88	* @return the users who have not read the alerts
89	*/
90	private Collection<User> getRecipients(Collection<Alert> alerts) {
91	Collection<User> users = new HashSet<>();	×
92	for (Alert alert : alerts) {	×
93	log.debug("Send email to alert recipient(s) ...");	×
94	if (!alert.isAlertRead() && alert.getRecipients() != null) {	×
95	for (AlertRecipient recipient : alert.getRecipients()) {	×
96	if (!recipient.isAlertRead() && recipient.getRecipient() != null) {	×
97	users.add(recipient.getRecipient());	×
98	}
99	}	×
100	}
101	}	×
102	return users;	×
103	}
104
105	}

openmrs / openmrs-core / 27767614355

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous