protected DCServerFactory.ResultCode sendEmail(
String frEmail, String toEmail, String subj, String body) {
if (StringTools.isBlank(frEmail)) {
Print.logError("'From' Email address not specified");
return DCServerFactory.ResultCode.TRANSMIT_FAIL;
} else if (StringTools.isBlank(toEmail) || !CommandPacketHandler.validateAddress(toEmail)) {
Print.logError("'To' SMS Email address invalid, or not specified");
return DCServerFactory.ResultCode.TRANSMIT_FAIL;
} else if (StringTools.isBlank(subj) && StringTools.isBlank(body)) {
Print.logError("Command string not specified");
return DCServerFactory.ResultCode.INVALID_ARG;
} else {
try {
Print.logInfo("SMS email: to <" + toEmail + ">");
Print.logDebug(" From : " + frEmail);
Print.logDebug(" To : " + toEmail);
Print.logDebug(" Subject: " + subj);
Print.logDebug(" Message: " + body);
SendMail.send(frEmail, toEmail, null, null, subj, body, null);
return DCServerFactory.ResultCode.SUCCESS;
} catch (Throwable t) { // NoClassDefFoundException, ClassNotFoundException
// this will fail if JavaMail support for SendMail is not available.
Print.logWarn("SendMail error: " + t);
return DCServerFactory.ResultCode.TRANSMIT_FAIL;
}
}
}
/* return the DBSelect statement for the specified account/group */
protected static DBSelect _getUserListSelect(String acctId, String groupId) {
/* empty/null account */
if (StringTools.isBlank(acctId)) {
return null;
}
/* empty/null user */
if (StringTools.isBlank(groupId)) {
return null;
}
/* get select */
// DBSelect: SELECT * FROM GroupList WHERE ((accountID='acct') and (groupID='group')) ORDER BY
// userID
DBSelect<GroupList> dsel = new DBSelect<GroupList>(GroupList.getFactory());
dsel.setSelectedFields(GroupList.FLD_userID);
DBWhere dwh = dsel.createDBWhere();
dsel.setWhere(
dwh.WHERE_(
dwh.AND(
dwh.EQ(GroupList.FLD_accountID, acctId), dwh.EQ(GroupList.FLD_groupID, groupId))));
dsel.setOrderByFields(GroupList.FLD_userID);
return dsel;
}
/* return status codes for account/device */
public static int[] getStatusCodes(String accountID, String deviceID) throws DBException {
/* account-id specified? */
if (StringTools.isBlank(accountID)) {
return new int[0];
}
/* device-id specified? */
if (StringTools.isBlank(deviceID)) {
deviceID = ALL_DEVICES;
}
/* select */
// DBSelect: SELECT statucCode FROM StatusCode WHERE (accountID='acct') AND (deviceID='*') ORDER
// BY statucCode
DBSelect<StatusCode> dsel = new DBSelect<StatusCode>(StatusCode.getFactory());
dsel.setSelectedFields(StatusCode.FLD_statusCode);
DBWhere dwh = dsel.createDBWhere();
dsel.setWhere(
dwh.WHERE_(
dwh.AND(
dwh.EQ(StatusCode.FLD_accountID, accountID),
dwh.EQ(StatusCode.FLD_deviceID, deviceID))));
dsel.setOrderByFields(StatusCode.FLD_statusCode);
/* get list */
java.util.List<Integer> codeList = new Vector<Integer>();
Statement stmt = null;
ResultSet rs = null;
try {
stmt = DBConnection.getDefaultConnection().execute(dsel.toString());
rs = stmt.getResultSet();
while (rs.next()) {
int code = rs.getInt(StatusCode.FLD_statusCode);
codeList.add(new Integer(code));
}
} catch (SQLException sqe) {
throw new DBException("Getting StatusCode List", sqe);
} finally {
if (rs != null) {
try {
rs.close();
} catch (Throwable t) {
}
}
if (stmt != null) {
try {
stmt.close();
} catch (Throwable t) {
}
}
}
/* return array of status codes */
int codeListInt[] = new int[codeList.size()];
for (int i = 0; i < codeListInt.length; i++) {
codeListInt[i] = codeList.get(i).intValue();
}
return codeListInt;
}
/** ** Decodes an RTP encoded argument */
public static RTProperties parseRTP(String rtpArg) {
if (!StringTools.isBlank(rtpArg)) {
String s = _des64(rtpArg);
if (!StringTools.isBlank(s)) {
return new RTProperties(s);
}
}
return null;
}
/* return StatusCode */
public static StatusCode findStatusCode(String accountID, String deviceID, int statusCode) {
/* check account status codes */
if (!StringTools.isBlank(accountID)) {
// first, try account/device
if (!StringTools.isBlank(deviceID)) {
try {
StatusCode.Key codeKey = new StatusCode.Key(accountID, deviceID, statusCode);
if (codeKey.exists()) { // may throw DBException
StatusCode code = codeKey.getDBRecord(true);
if (code != null) { // should not be null
return code;
}
}
} catch (DBException dbe) {
// ignore error
}
}
// next, try just the account
try {
StatusCode.Key codeKey = new StatusCode.Key(accountID, statusCode);
if (codeKey.exists()) { // may throw DBException
StatusCode code = codeKey.getDBRecord(true);
if (code != null) { // should not be null
return code;
}
}
} catch (DBException dbe) {
// ignore error
}
}
/* check global status codes */
String sysAdmin = AccountRecord.getSystemAdminAccountID();
if (!StringTools.isBlank(sysAdmin)) {
try {
StatusCode.Key codeKey = new StatusCode.Key(sysAdmin, statusCode);
if (codeKey.exists()) { // may throw DBException
StatusCode code = codeKey.getDBRecord(true);
if (code != null) { // should not be null
return code;
}
}
} catch (DBException dbe) {
// ignore error
}
}
/* icon selector not found */
return null;
}
/* return list of all Devices within the specified DeviceGroup (NOT SCALABLE BEYOND A FEW HUNDRED GROUPS) */
public static java.util.List<String> getUsersForGroup(String acctId, String groupId)
throws DBException {
/* valid account/groupId? */
if (StringTools.isBlank(acctId)) {
return null;
} else if (StringTools.isBlank(groupId)) {
return null;
}
/* get db selector */
DBSelect dsel = GroupList._getUserListSelect(acctId, groupId);
if (dsel == null) {
return null;
}
/* read users for group */
java.util.List<String> usrList = new Vector<String>();
DBConnection dbc = null;
Statement stmt = null;
ResultSet rs = null;
try {
dbc = DBConnection.getDefaultConnection();
stmt = dbc.execute(dsel.toString());
rs = stmt.getResultSet();
while (rs.next()) {
String usrId = rs.getString(GroupList.FLD_userID);
usrList.add(usrId);
}
} catch (SQLException sqe) {
throw new DBException("Get Group GroupeList", sqe);
} finally {
if (rs != null) {
try {
rs.close();
} catch (Throwable t) {
}
}
if (stmt != null) {
try {
stmt.close();
} catch (Throwable t) {
}
}
DBConnection.release(dbc);
}
/* return list */
return usrList;
}
public void setGeozoneID(String gzid) {
if (!StringTools.isBlank(gzid)) {
this.fieldValues.setString(EventData.FLD_geozoneID, gzid);
} else {
this.fieldValues.removeProperty(EventData.FLD_geozoneID);
}
}
/**
* ** Adds an argument to the URI ** @param key The key name of the argument to add ** @param
* value The value of the new key ** @param encode True if <code>value</code> shoudl be hex
* encoded ** @param obfuscate True if <code>value</code> should be obfuscated ** @return This
* URIArg, with the argument added
*/
protected URIArg _addArg(String key, String value, boolean encode, boolean obfuscate) {
if (!StringTools.isBlank(key)) {
String val = encode ? this.encodeArg(value, obfuscate) : value;
this.getKeyValList().add(new KeyVal(key, val));
}
return this;
}
/** ** Scrambles String */
public static String _ens64(String d) {
if (!StringTools.isBlank(d)) {
return Base64.encode(StringTools.getBytes(d), getBase64Alphabet(), Base64Pad);
} else {
return "";
}
}
/* get/create device list entry */
public static GroupList getGroupList(User user, String groupID, boolean createOK)
throws DBException {
// does not return null, if 'createOK' is true
/* User specified? */
if (user == null) {
throw new DBException("User not specified.");
}
String accountID = user.getAccountID();
String userID = user.getUserID();
/* group exists? */
if (StringTools.isBlank(groupID)) {
throw new DBException("DeviceGroup ID not specified.");
} else if (!DeviceGroup.exists(accountID, groupID)) {
throw new DBException("DeviceGroup does not exist: " + accountID + "/" + groupID);
}
/* create/save record */
GroupList.Key grpListKey = new GroupList.Key(accountID, userID, groupID);
if (grpListKey.exists()) { // may throw DBException
// already exists
GroupList listItem = grpListKey.getDBRecord(true);
listItem.setUser(user);
return listItem;
} else if (createOK) {
GroupList listItem = grpListKey.getDBRecord();
listItem.setCreationDefaultValues();
listItem.setUser(user);
return listItem;
} else {
// record doesn't exist, and caller doesn't want us to create it
return null;
}
}
/* set Role access level */
public static boolean deleteAccessLevel(Role role, String aclId) throws DBException {
/* role specified? */
if (role == null) {
return false; // quietly ignore
}
String acctId = role.getAccountID();
String roleId = role.getRoleID();
/* acl-id specified? */
if (StringTools.isBlank(aclId)) {
return false; // quietly ignore
}
/* already deleted? */
boolean aclExists = RoleAcl.exists(acctId, roleId, aclId);
if (!aclExists) {
return false;
}
/* delete */
RoleAcl.Key aclKey = new RoleAcl.Key(acctId, roleId, aclId);
aclKey.delete(true); // also delete dependencies
return true;
}
/* encode "type=<type> ..." into long value */
public static long EncodeFault(String faultProps) {
if (!StringTools.isBlank(faultProps)) {
return DTOBDFault.EncodeFault(new RTProperties(faultProps));
} else {
return 0L;
}
}
/* set Role access level */
public static void setAccessLevel(Role role, String aclId, AccessLevel level) throws DBException {
/* role specified? */
if (role == null) {
throw new DBException("Role not specified.");
}
String acctId = role.getAccountID();
String roleId = role.getRoleID();
/* acl-id specified? */
if (StringTools.isBlank(aclId)) {
throw new DBException("Acl-ID not specified.");
}
/* get/create role */
RoleAcl roleAcl = null;
RoleAcl.Key aclKey = new RoleAcl.Key(acctId, roleId, aclId);
if (aclKey.exists()) { // may throw DBException
roleAcl = RoleAcl.getRoleAcl(role, aclId); // may throw DBException
} else {
roleAcl = aclKey.getDBRecord();
roleAcl.setRole(role);
}
/* set access level */
int levelInt = (level != null) ? level.getIntValue() : AccessLevel.NONE.getIntValue();
roleAcl.setAccessLevel(levelInt);
/* save */
roleAcl.save(); // may throw DBException
}
/**
* ** Adds an argument to the URI ** @param key The key name of the argument to add ** @param rtp
* The RTP encoded values of the new key ** @return This URIArg, with the argument added
*/
public URIArg addArg(String key, RTProperties rtp) {
String r = (rtp != null) ? rtp.toString() : null;
if (!StringTools.isBlank(r)) {
return this._addArg(key, URIArg.encodeRTP(rtp), false /*encode*/, false /*obfuscate*/);
} else {
return this.addArg(key, "");
}
}
/** ** Descrambles String */
public static String _des64(String e) {
if (!StringTools.isBlank(e)) {
byte b[] = Base64.decode(e, getBase64Alphabet(), Base64Pad);
return StringTools.toStringValue(b, ' ');
} else {
return "";
}
}
public void setFieldValue(String fldName, Object fldVal) {
if (!StringTools.isBlank(fldName) && (fldVal != null)) {
if (USE_ALTERNATE_FIELD_MAP) {
this.getAlternateFieldMap().put(fldName, fldVal);
} else {
this.fieldValues.setProperty(fldName, fldVal);
}
}
}
/** ** Gets the SMSoutboubdGateway for the specified name */
public static SMSOutboundGateway GetSMSGateway(String name) {
/* get handler */
if (StringTools.isBlank(name)) {
return null;
} else {
return SmsGatewayHandlerMap.get(name.toLowerCase());
}
}
/**
* ** Gets a virtual DBRecord from the specified remote service ** @param servReq The remote web
* service ** @return The virtual DBRecord (cannot be saved or reloaded)
*/
@SuppressWarnings("unchecked")
public gDBR getVirtualDBRecord(final ServiceRequest servReq) throws DBException {
String CMD_dbget = DBFactory.CMD_dbget;
String TAG_Response = servReq.getTagResponse();
String TAG_Record = DBFactory.TAG_Record;
String ATTR_command = servReq.getAttrCommand();
String ATTR_result = servReq.getAttrResult();
/* send request / get response */
Document xmlDoc = null;
try {
xmlDoc =
servReq.sendRequest(
CMD_dbget,
new ServiceRequest.RequestBody() {
public StringBuffer appendRequestBody(StringBuffer sb, int indent) {
return DBRecordKey.this.toRequestXML(sb, indent);
}
});
} catch (IOException ioe) {
Print.logException("Error", ioe);
throw new DBException("Request read error", ioe);
}
/* parse 'GTSResponse' */
Element gtsResponse = xmlDoc.getDocumentElement();
if (!gtsResponse.getTagName().equalsIgnoreCase(TAG_Response)) {
Print.logError("Request XML does not start with '%s'", TAG_Response);
throw new DBException("Response XML does not begin eith '" + TAG_Response + "'");
}
/* request command/argument */
String cmd = StringTools.trim(gtsResponse.getAttribute(ATTR_command));
String result = StringTools.trim(gtsResponse.getAttribute(ATTR_result));
if (StringTools.isBlank(result)) {
result = StringTools.trim(gtsResponse.getAttribute("type"));
}
if (!result.equalsIgnoreCase("success")) {
Print.logError("Response indicates failure");
throw new DBException("Response does not indicate 'success'");
}
/* Record */
NodeList rcdList = XMLTools.getChildElements(gtsResponse, TAG_Record);
if (rcdList.getLength() <= 0) {
Print.logError("No 'Record' tags");
throw new DBException("GTSResponse does not contain any 'Record' tags");
}
Element rcdElem = (Element) rcdList.item(0);
/* return DBRecord */
gDBR dbr = (gDBR) DBFactory.parseXML_DBRecord(rcdElem);
dbr.setVirtual(true);
return dbr;
}
/* Return specified StatusCode, create if specified */
private static StatusCode _getStatusCode(
String accountID, Account account, String deviceID, int code, boolean createOK)
throws DBException {
// does not return null if 'createOK' is true
/* account-id specified? */
if (StringTools.isBlank(accountID)) {
if (account == null) {
throw new DBException("Account not specified.");
} else {
accountID = account.getAccountID();
}
} else if ((account != null) && !account.getAccountID().equals(accountID)) {
throw new DBException("Account does not match specified AccountID.");
}
/* device-id specified? */
if (StringTools.isBlank(deviceID)) {
// throw new DBException("Device-ID not specified.");
deviceID = ALL_DEVICES;
}
/* get/create entity */
StatusCode.Key scKey = new StatusCode.Key(accountID, deviceID, code);
if (scKey.exists()) { // may throw DBException
StatusCode sc = scKey.getDBRecord(true);
if (account != null) {
sc.setAccount(account);
}
return sc;
} else if (createOK) {
StatusCode sc = scKey.getDBRecord();
if (account != null) {
sc.setAccount(account);
}
sc.setCreationDefaultValues();
return sc; // not yet saved!
} else {
// record doesn't exist, and caller doesn't want us to create it
return null;
}
}
/** ** Descrambles String */
public static String _des64(String e) {
if (!StringTools.isBlank(e)) {
try {
byte b[] = Base64.decode(e, getBase64Alphabet(), Base64Pad);
return StringTools.toStringValue(b, ' ');
} catch (Base64.Base64DecodeException bde) {
Print.logError("Invalid Base64 characters", bde);
return "";
}
} else {
return "";
}
}
public static String GetPropertyString_OBDII(String dtcStr) {
StringBuffer sb = new StringBuffer();
sb.append(PROP_TYPE[0]).append("=").append(NAME_OBDII);
sb.append(" ");
if (!StringTools.isBlank(dtcStr)) {
sb.append(PROP_MIL[0]).append("=").append("1");
sb.append(" ");
sb.append(PROP_DTC[0]).append("=").append(dtcStr);
} else {
sb.append(PROP_MIL[0]).append("=").append("0");
}
return sb.toString();
}
/* Return status code description (used by RuleInfo, RequestProperties) */
public static String getDescription(
String accountID, int statusCode, BasicPrivateLabel pl, String dftDesc) {
/* custom code (record) */
StatusCode code = StatusCode.findStatusCode(accountID, null, statusCode);
if (code != null) {
return code.getDescription();
}
/* default */
if (!StringTools.isBlank(dftDesc)) {
return dftDesc;
} else {
return StatusCodes.GetDescription(statusCode, pl);
}
}
protected String getStringProperty(Device device, String key, String dft) {
DCServerConfig dcs =
(device != null) ? DCServerFactory.getServerConfig(device.getDeviceCode()) : null;
String prop = null;
if (dcs != null) {
prop = dcs.getStringProperty(key, dft);
Print.logInfo("DCServerConfig property '" + key + "' ==> " + prop);
if (StringTools.isBlank(prop) && RTConfig.hasProperty(key)) {
Print.logInfo("(RTConfig property '" + key + "' ==> " + RTConfig.getString(key, "") + ")");
}
} else {
prop = RTConfig.getString(key, dft);
Print.logInfo("RTConfig property '" + key + "' ==> " + prop);
}
return prop;
}
/* Return status code description */
public static String getDescription(
Device device, int statusCode, BasicPrivateLabel bpl, String dftDesc) {
/* device code */
if (device != null) {
StatusCode code = device.getStatusCode(statusCode);
if (code != null) {
return code.getDescription();
}
}
/* default */
if (!StringTools.isBlank(dftDesc)) {
return dftDesc;
} else {
return StatusCodes.GetDescription(statusCode, bpl);
}
}
/** ** Sets the 'host' */
public boolean setHost(String _host) {
String uri = this.getURI();
if (!StringTools.isBlank(_host) && URIArg.isAbsoluteURL(uri)) {
try {
URL oldURI = new URL(uri);
String proto = oldURI.getProtocol();
String host = _host;
int port = oldURI.getPort();
String file = oldURI.getFile();
URL newURI = new URL(proto, host, port, file);
this._setURI(newURI.toString());
return true;
} catch (MalformedURLException mue) {
// error
}
}
return false;
}
protected Device loadDevice(String acctID, String devID) {
if (StringTools.isBlank(acctID)) {
return this.loadDevice(devID); // load ad ModemID
} else {
try {
Account account = Account.getAccount(acctID);
if (account == null) {
Print.logError("Account-ID not found: " + acctID);
return null;
} else {
Device dev = Transport.loadDeviceByTransportID(account, devID);
return dev;
}
} catch (DBException dbe) {
Print.logError("Error getting Device: " + acctID + "/" + devID + " [" + dbe + "]");
return null;
}
}
}
/* return Role access level */
public static AccessLevel getAccessLevel(Role role, String aclId, AccessLevel dftAccess) {
if (role == null) {
return dftAccess;
} else if (StringTools.isBlank(aclId)) {
return dftAccess;
} else {
try {
RoleAcl roleAcl = RoleAcl.getRoleAcl(role, aclId); // may throw DBException
if (roleAcl != null) {
return RoleAcl.getAccessLevel(roleAcl);
} else {
return dftAccess;
}
} catch (DBException dbe) {
// error occurred
return AccessLevel.NONE;
}
}
}
/** ** Add SMS Gateway support provider */
public static void AddSMSGateway(String name, SMSOutboundGateway smsGW) {
/* validate name */
if (StringTools.isBlank(name)) {
Print.logWarn("SMS Gateway name is blank");
return;
} else if (smsGW == null) {
Print.logWarn("SMS Gateway handler is null");
return;
}
/* initialize map? */
if (SmsGatewayHandlerMap == null) {
SmsGatewayHandlerMap = new HashMap<String, SMSOutboundGateway>();
}
/* save handler */
SmsGatewayHandlerMap.put(name.toLowerCase(), smsGW);
Print.logDebug("Added SMS Gateway Handler: " + name);
}
/* Return specified role ACL, create if specified */
public static RoleAcl getRoleAcl(Role role, String aclId, boolean create) throws DBException {
// does not return null
/* role specified? */
if (role == null) {
throw new DBNotFoundException("Role not specified.");
}
String acctId = role.getAccountID();
String roleId = role.getRoleID();
/* acl-id specified? */
if (StringTools.isBlank(aclId)) {
throw new DBNotFoundException("Acl-ID not specified.");
}
/* get/create role */
RoleAcl roleAcl = null;
RoleAcl.Key aclKey = new RoleAcl.Key(acctId, roleId, aclId);
if (!aclKey.exists()) { // may throw DBException
if (create) {
roleAcl = aclKey.getDBRecord();
roleAcl.setRole(role);
roleAcl.setCreationDefaultValues();
return roleAcl; // not yet saved!
} else {
throw new DBNotFoundException("Acl-ID does not exists '" + aclKey + "'");
}
} else if (create) {
// we've been asked to create the Acl, and it already exists
throw new DBAlreadyExistsException("Acl-ID already exists '" + aclKey + "'");
} else {
roleAcl = RoleAcl.getRoleAcl(role, aclId); // may throw DBException
if (roleAcl == null) {
throw new DBException("Unable to read existing Role-ID '" + aclKey + "'");
}
return roleAcl;
}
}
/* create a new StatusCode */
public static StatusCode createNewStatusCode(Account account, String deviceID, int code)
throws DBException {
/* invalid account */
if (account == null) {
throw new DBException("Invalid/Null Account specified");
}
/* invalid code */
if ((code < 0) || (code > 0xFFFF)) {
throw new DBException("Invalid StatusCode specified");
}
/* default to 'ALL' devices */
if (StringTools.isBlank(deviceID)) {
deviceID = ALL_DEVICES;
}
/* create status code */
StatusCode sc = StatusCode.getStatusCode(account, deviceID, code, true); // does not return null
sc.save();
return sc;
}