/*
* eGov suite of products aim to improve the internal efficiency,transparency,
* accountability and the service delivery of the government organizations.
*
* Copyright (C) <2015> eGovernments Foundation
*
* The updated version of eGov suite of products as by eGovernments Foundation
* is available at http://www.egovernments.org
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see http://www.gnu.org/licenses/ or
* http://www.gnu.org/licenses/gpl.html .
*
* In addition to the terms of the GPL license to be adhered to in using this
* program, the following additional terms are to be complied with:
*
* 1) All versions of this program, verbatim or modified must carry this
* Legal Notice.
*
* 2) Any misrepresentation of the origin of the material is prohibited. It
* is required that all modified versions of this material be marked in
* reasonable ways as different from the original version.
*
* 3) This license does not grant any rights to any user of the program
* with regards to rights under trademark law for use of the trade names
* or trademarks of eGovernments Foundation.
*
* In case of any queries, you can reach eGovernments Foundation at contact@egovernments.org.
*/
package org.egov.infra.messaging.sms;
import org.apache.commons.io.IOUtils;
import org.apache.http.HttpResponse;
import org.apache.http.NameValuePair;
import org.apache.http.client.HttpClient;
import org.apache.http.client.entity.UrlEncodedFormEntity;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.message.BasicNameValuePair;
import org.egov.infra.config.properties.ApplicationProperties;
import org.egov.infra.messaging.MessagePriority;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import static java.nio.charset.StandardCharsets.UTF_8;
import static org.apache.commons.lang3.StringUtils.isNotBlank;
import static org.egov.infra.messaging.MessagePriority.MEDIUM;
@Service
public class SMSService {
private static final Logger LOGGER = LoggerFactory.getLogger(SMSService.class);
private static final String SMS_PRIORITY_PARAM_VALUE = "sms.%s.priority.param.value";
private static final String SENDERID_PARAM_NAME = "sms.sender.req.param.name";
private static final String USERNAME_PARAM_NAME = "sms.sender.username.req.param.name";
private static final String PASWRD_PARAM_NAME = "sms.sender.password.req.param.name";
private static final String DEST_MOBILENUM_PARAM_NAME = "sms.destination.mobile.req.param.name";
private static final String DEST_MESSAGE_PARAM_NAME = "sms.message.req.param.name";
private static final String SMS_EXTRA_REQ_PARAMS = "sms.extra.req.params";
private static final String MOBILE_NUMBER_PREFIX = "mobile.number.prefix";
@Autowired
private ApplicationProperties applicationProperties;
public boolean sendSMS(String mobileNumber, String message) {
return sendSMS(mobileNumber, message, MEDIUM);
}
public boolean sendSMS(String mobileNumber, String message, MessagePriority priority) {
if (applicationProperties.smsEnabled()) {
try {
HttpClient client = HttpClientBuilder.create().build();
HttpPost post = new HttpPost(applicationProperties.smsProviderURL());
List<NameValuePair> urlParameters = new ArrayList<>();
urlParameters.add(new BasicNameValuePair(applicationProperties.getProperty(USERNAME_PARAM_NAME),
applicationProperties.smsSenderUsername()));
urlParameters.add(new BasicNameValuePair(applicationProperties.getProperty(PASWRD_PARAM_NAME),
applicationProperties.smsSenderPassword()));
urlParameters.add(new BasicNameValuePair(applicationProperties.getProperty(SENDERID_PARAM_NAME),
applicationProperties.smsSender()));
urlParameters.add(new BasicNameValuePair(applicationProperties.getProperty(DEST_MOBILENUM_PARAM_NAME),
applicationProperties.getProperty(MOBILE_NUMBER_PREFIX)+mobileNumber));
urlParameters.add(new BasicNameValuePair(applicationProperties.getProperty(DEST_MESSAGE_PARAM_NAME), message));
setAdditionalParameters(urlParameters, priority);
post.setEntity(new UrlEncodedFormEntity(urlParameters, UTF_8));
HttpResponse response = client.execute(post);
String responseCode = IOUtils.toString(response.getEntity().getContent(), UTF_8);
LOGGER.info("SMS sending completed with response code [{}] - [{}]", responseCode,
applicationProperties.smsResponseMessageForCode(responseCode));
return applicationProperties.smsErrorCodes().parallelStream()
.noneMatch(responseCode::startsWith);
} catch (UnsupportedOperationException | IOException e) {
LOGGER.error("Error occurred while sending SMS [%s]", e);
return false;
}
} else {
return false;
}
}
private void setAdditionalParameters(List<NameValuePair> urlParameters, MessagePriority priority) {
if (isNotBlank(applicationProperties.getProperty(SMS_EXTRA_REQ_PARAMS))) {
String[] extraParms = applicationProperties.getProperty(SMS_EXTRA_REQ_PARAMS).split("&");
if (extraParms.length > 0)
for (String extraParm : extraParms) {
String[] paramNameValue = extraParm.split("=");
urlParameters.add(new BasicNameValuePair(paramNameValue[0], paramNameValue[1]));
}
}
if (applicationProperties.getProperty("sms.priority.enabled", Boolean.class)) {
urlParameters.add(new BasicNameValuePair(applicationProperties.getProperty("sms.priority.param.name"),
applicationProperties.getProperty(
String.format(SMS_PRIORITY_PARAM_VALUE, priority.toString()))
));
}
}
}