Skip to content

Refactoring and code cleanup #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
guusdk merged 2 commits into from
Sep 15, 2025
Merged

Refactoring and code cleanup #29

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7403734
refactor: Use Java features
stokito Sep 14, 2025
1d8787a
refactor: use for each instead of iterator
stokito Sep 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
140 changes: 73 additions & 67 deletions src/java/org/jivesoftware/openfire/plugin/SearchPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,8 @@
import org.xmpp.resultsetmanagement.ResultSet;
import org.xmpp.resultsetmanagement.ResultSetImpl;

import static java.lang.String.CASE_INSENSITIVE_ORDER;

/**
* Provides support for Jabber Search (<a href="http://www.xmpp.org/extensions/xep-0055.html">XEP-0055</a>).
* <p>
Expand Down Expand Up @@ -100,23 +102,22 @@ public class SearchPlugin implements Component, Plugin, PropertyEventListener {

private static String serverName;

private TreeMap<String, String> fieldLookup = new TreeMap<String, String>(new CaseInsensitiveComparator());
private TreeMap<String, String> fieldLookup = new TreeMap<>(CASE_INSENSITIVE_ORDER);
private Map<String, String> reverseFieldLookup = new HashMap<String, String>();

/**
* A list of field names that are valid in jabber:iq:search
*/
public final static Collection<String> validSearchRequestFields = new ArrayList<String>();
static {
validSearchRequestFields.add("first");
validSearchRequestFields.add("last");
validSearchRequestFields.add("nick");
validSearchRequestFields.add("email");
validSearchRequestFields.add("x"); // extended info
public final static Collection<String> validSearchRequestFields = Arrays.asList(
"first",
"last",
"nick",
"email",
"x", // extended info

// result set management (XEP-0059)
validSearchRequestFields.add("set");
}
"set"
);

public SearchPlugin() {
serviceName = JiveGlobals.getProperty(SERVICENAME, "search");
Expand Down Expand Up @@ -284,17 +285,22 @@ private IQ handleIQRequest(IQ iq) {
return replyPacket;
}

if (namespace.equals(NAMESPACE_JABBER_IQ_SEARCH)) {
replyPacket = handleSearchRequest(iq);
} else if (namespace.equals(IQDiscoInfoHandler.NAMESPACE_DISCO_INFO)) {
replyPacket = handleDiscoInfo(iq);
} else if (namespace.equals(IQDiscoItemsHandler.NAMESPACE_DISCO_ITEMS)) {
replyPacket = IQ.createResultIQ(iq);
replyPacket.setChildElement("query", IQDiscoItemsHandler.NAMESPACE_DISCO_ITEMS);
} else {
// don't known what to do with this.
replyPacket = IQ.createResultIQ(iq);
replyPacket.setError(Condition.feature_not_implemented);
switch (namespace) {
case NAMESPACE_JABBER_IQ_SEARCH:
replyPacket = handleSearchRequest(iq);
break;
case IQDiscoInfoHandler.NAMESPACE_DISCO_INFO:
replyPacket = handleDiscoInfo(iq);
break;
case IQDiscoItemsHandler.NAMESPACE_DISCO_ITEMS:
replyPacket = IQ.createResultIQ(iq);
replyPacket.setChildElement("query", IQDiscoItemsHandler.NAMESPACE_DISCO_ITEMS);
break;
default:
// don't known what to do with this.
replyPacket = IQ.createResultIQ(iq);
replyPacket.setError(Condition.feature_not_implemented);
break;
}

return replyPacket;
Expand Down Expand Up @@ -659,9 +665,7 @@ private Hashtable<String, String> extractSearchQuery(Element incomingForm) {
// since not all clients request which fields are available for
// searching attempt to match submitted fields with available search
// fields
Iterator<Element> iter = incomingForm.elementIterator();
while (iter.hasNext()) {
Element element = iter.next();
for (Element element : incomingForm.elements()) {
String name = element.getName();

if (fieldLookup.containsKey(name)) {
Expand Down Expand Up @@ -692,10 +696,7 @@ private Hashtable<String, String> extractExtendedSearchQuery(Element incomingFor
List<String> searchFields = new ArrayList<String>();
String search = "";

Iterator<Element> fields = dataform.elementIterator("field");
while (fields.hasNext()) {
Element searchField = fields.next();

for (Element searchField : dataform.elements("field")) {
String field = searchField.attributeValue("var");
String value = "";
if (searchField.element("value") != null) {
Expand Down Expand Up @@ -784,19 +785,22 @@ private IQ replyNonDataFormResult(Collection<User> users, IQ packet) {

// return to the client the same fields that were submitted
for (String field : reverseFieldLookup.keySet()) {
if ("Username".equals(field)) {
Element element = item.addElement(reverseFieldLookup.get(field));
element.addText(username);
}

if ("Name".equals(field)) {
Element element = item.addElement(reverseFieldLookup.get(field));
element.addText(user.isNameVisible() ? removeNull(user.getName()) : "");
}

if ("Email".equals(field)) {
Element element = item.addElement(reverseFieldLookup.get(field));
element.addText(user.isEmailVisible() ? removeNull(user.getEmail()) : "");
switch (field) {
case "Username": {
Element element = item.addElement(reverseFieldLookup.get(field));
element.addText(username);
break;
}
case "Name": {
Element element = item.addElement(reverseFieldLookup.get(field));
element.addText(user.isNameVisible() ? removeNull(user.getName()) : "");
break;
}
case "Email": {
Element element = item.addElement(reverseFieldLookup.get(field));
element.addText(user.isEmailVisible() ? removeNull(user.getEmail()) : "");
break;
}
}
}
}
Expand Down Expand Up @@ -843,7 +847,7 @@ public boolean getServiceEnabled() {
*/
public void setServiceEnabled(boolean enabled) {
serviceEnabled = enabled;
JiveGlobals.setProperty(SERVICEENABLED, enabled ? "true" : "false");
JiveGlobals.setProperty(SERVICEENABLED, Boolean.toString(enabled));
}

/**
Expand Down Expand Up @@ -897,7 +901,7 @@ public boolean isGroupOnly() {
*/
public void setGroupOnly(boolean groupOnly) {
this.groupOnly = groupOnly;
JiveGlobals.setProperty(GROUPONLY, groupOnly ? "true" : "false");
JiveGlobals.setProperty(GROUPONLY, Boolean.toString(groupOnly));
}

/*
Expand All @@ -906,14 +910,19 @@ public void setGroupOnly(boolean groupOnly) {
* @see org.jivesoftware.util.PropertyEventListener#propertySet(java.lang.String, java.util.Map)
*/
public void propertySet(String property, Map<String, Object> params) {
if (property.equals(SERVICEENABLED)) {
this.serviceEnabled = Boolean.parseBoolean((String) params.get("value"));
} else if (property.equals(SERVICENAME)) {
changeServiceName((String) params.get("value"));
} else if (property.equals(EXCLUDEDFIELDS)) {
excludedFields = StringUtils.stringToCollection(JiveGlobals.getProperty(EXCLUDEDFIELDS, (String) params.get("value")));
} else if (property.equals(GROUPONLY)) {
this.groupOnly = Boolean.parseBoolean((String) params.get("value"));
switch (property) {
case SERVICEENABLED:
this.serviceEnabled = Boolean.parseBoolean((String) params.get("value"));
break;
case SERVICENAME:
changeServiceName((String) params.get("value"));
break;
case EXCLUDEDFIELDS:
excludedFields = StringUtils.stringToCollection(JiveGlobals.getProperty(EXCLUDEDFIELDS, (String) params.get("value")));
break;
case GROUPONLY:
this.groupOnly = Boolean.parseBoolean((String) params.get("value"));
break;
}
}

Expand All @@ -923,14 +932,19 @@ public void propertySet(String property, Map<String, Object> params) {
* @see org.jivesoftware.util.PropertyEventListener#propertyDeleted(java.lang.String, java.util.Map)
*/
public void propertyDeleted(String property, Map<String, Object> params) {
if (property.equals(SERVICEENABLED)) {
this.serviceEnabled = true;
} else if (property.equals(SERVICENAME)) {
changeServiceName("search");
} else if (property.equals(EXCLUDEDFIELDS)) {
excludedFields = new ArrayList<String>();
} else if (property.equals(GROUPONLY)) {
this.groupOnly = false;
switch (property) {
case SERVICEENABLED:
this.serviceEnabled = true;
break;
case SERVICENAME:
changeServiceName("search");
break;
case EXCLUDEDFIELDS:
excludedFields = new ArrayList<>();
break;
case GROUPONLY:
this.groupOnly = false;
break;
}
}

Expand Down Expand Up @@ -977,14 +991,6 @@ private void changeServiceName(String serviceName) {
this.serviceName = serviceName;
}

/**
* Comparator that compares String objects, ignoring capitalization.
*/
private class CaseInsensitiveComparator implements Comparator<String> {
public int compare(String s1, String s2) {
return s1.compareToIgnoreCase(s2);
}
}

/**
* Returns the trimmed argument, or an empty String object of null was supplied as an argument.
Expand Down