Rearranged some methods in PEP related classes.

git-svn-id: http://svn.igniterealtime.org/svn/repos/openfire/branches@8955 b35dd754-fafc-0310-a699-88a17e54d16e

pep/src/java/org/jivesoftware/openfire/pep/IQPEPHandler.java

@@ -92,7 +92,8 @@ import java.util.concurrent.ConcurrentHashMap;
  * 
  */
 public class IQPEPHandler extends IQHandler implements ServerIdentitiesProvider, ServerFeaturesProvider,
-        UserIdentitiesProvider, UserItemsProvider, PresenceEventListener, RosterEventListener, PacketInterceptor {
+        UserIdentitiesProvider, UserItemsProvider, PresenceEventListener, RosterEventListener,
+        PacketInterceptor {
 
     /**
      * Map of PEP services. Table, Key: bare JID (String); Value: PEPService
@@ -210,10 +211,26 @@ public class IQPEPHandler extends IQHandler implements ServerIdentitiesProvider,
         return info;
     }
 
+    /**
+     * Returns the filteredNodesMap.
+     * 
+     * @return the filteredNodesMap
+     */
+    public Map<String, Set<String>> getFilteredNodesMap() {
+        return filteredNodesMap;
+    }
+
+    /**
+     * Returns the knownRemotePresences map.
+     * 
+     * @return the knownRemotePresences map
+     */
+    public Map<String, Set<JID>> getKnownRemotePresenes() {
+        return knownRemotePresences;
+    }
+
     @Override
     public IQ handleIQ(IQ packet) throws UnauthorizedException {
-        // TODO: Finish implementing ... ;)
-
         if (packet.getTo() == null && packet.getType() == IQ.Type.set) {
             String jidFrom = packet.getFrom().toBareJID();
 
@@ -373,6 +390,34 @@ public class IQPEPHandler extends IQHandler implements ServerIdentitiesProvider,
         pubSubEngine.process(pepService, subscriptionPacket);
     }
 
+    /**
+     * Cancels a subscription to a PEPService's root collection node.
+     * 
+     * @param unsubscriber the JID of the subscriber whose subscription is being canceled.
+     * @param serviceOwner the JID of the owner of the PEP service for which the subscription is being canceled.
+     */
+    private void cancelSubscriptionToPEPService(JID unsubscriber, JID serviceOwner) {
+        // Retrieve recipientJID's PEP service, if it exists.
+        PEPService pepService = pepServices.get(serviceOwner.toBareJID());
+        if (pepService == null) {
+            return;
+        }
+
+        // Cancel unsubscriberJID's subscription to recipientJID's PEP service, if it exists.
+        CollectionNode rootNode = pepService.getRootCollectionNode();
+        NodeSubscription nodeSubscription = rootNode.getSubscription(unsubscriber);
+        if (nodeSubscription != null) {
+            rootNode.cancelSubscription(nodeSubscription);
+
+            if (Log.isDebugEnabled()) {
+                Log.debug("PEP: " + unsubscriber + " subscription to " + serviceOwner + "'s PEP service was cancelled.");
+            }
+        }
+        else {
+            return;
+        }
+    }
+
     /**
      * Implements ServerIdentitiesProvider and UserIdentitiesProvider, adding
      * the PEP identity to the respective disco#info results.
@@ -455,34 +500,7 @@ public class IQPEPHandler extends IQHandler implements ServerIdentitiesProvider,
             Log.debug("PEP: " + unsubscriberJID + " unsubscribed from " + recipientJID + "'s presence.");
         }
 
-        // Retrieve recipientJID's PEP service, if it exists.
-        PEPService pepService = pepServices.get(recipientJID.toBareJID());        
-        if (pepService == null) {
-            return;
-        }
-        
-        // Cancel unsubscriberJID's subscription to recipientJID's PEP service, if it exists.
-        CollectionNode rootNode = pepService.getRootCollectionNode();
-        NodeSubscription nodeSubscription = rootNode.getSubscription(unsubscriberJID);
-        if (nodeSubscription != null) {
-            rootNode.cancelSubscription(nodeSubscription);
-            
-            if (Log.isDebugEnabled()) {
-                Log.debug("PEP: " + unsubscriberJID + " subscription to " + recipientJID + "'s PEP service was cancelled.");
-            }
-        }
-        else {
-            return;
-        }
-        
-        // In the case of both users being local, we must also cancel recipientJID's subscription
-        // to unsubscriberJID's PEP service, if it exists.
-        //unsubscribedToPresence(recipientJID, unsubscriberJID);
-    }
-
-    public void unavailableSession(ClientSession session, Presence presence) {
-        // Do nothing
-
+        cancelSubscriptionToPEPService(unsubscriberJID, recipientJID);
     }
 
     public void availableSession(ClientSession session, Presence presence) {
@@ -505,13 +523,15 @@ public class IQPEPHandler extends IQHandler implements ServerIdentitiesProvider,
 
     }
 
-    public void presenceChanged(ClientSession session, Presence presence) {
-        // Do nothing
+    public void contactDeleted(Roster roster, RosterItem item) {
+        JID rosterOwner = XMPPServer.getInstance().createJID(roster.getUsername(), null);
+        JID deletedContact = item.getJid();
 
+        if (Log.isDebugEnabled()) {
+            Log.debug("PEP: contactDeleted: rosterOwner is " + rosterOwner + " and deletedContact is" + deletedContact);
         }
 
-    public void presencePriorityChanged(ClientSession session, Presence presence) {
-        // Do nothing
+        cancelSubscriptionToPEPService(deletedContact, rosterOwner);
 
     }
 
@@ -667,53 +687,40 @@ public class IQPEPHandler extends IQHandler implements ServerIdentitiesProvider,
     }
 
     /**
-     * Returns the filteredNodesMap.
-     * 
-     * @return the filteredNodesMap
+     *  The following functions are unimplemented required interface methods.
      */
-    public Map<String, Set<String>> getFilteredNodesMap() {
-        return filteredNodesMap;
-    }
+    public void unavailableSession(ClientSession session, Presence presence) {
+        // Do nothing
 
-    /**
-     * Returns the knownRemotePresences map.
-     * 
-     * @return the knownRemotePresences map
-     */
-    public Map<String, Set<JID>> getKnownRemotePresenes() {
-        return knownRemotePresences;
     }
 
-    public boolean addingContact(Roster roster, RosterItem item, boolean persistent) {
-        // TODO Auto-generated method stub
-        return false;
+    public void presenceChanged(ClientSession session, Presence presence) {
+        // Do nothing
+
     }
 
-    public void contactAdded(Roster roster, RosterItem item) {
-        // TODO Auto-generated method stub
+    public void presencePriorityChanged(ClientSession session, Presence presence) {
+        // Do nothing
 
     }
 
-    public void contactDeleted(Roster roster, RosterItem item) {
-        JID rosterOwner = XMPPServer.getInstance().createJID(roster.getUsername(), null);
-        JID deletedContact = item.getJid();
-        
-        if (Log.isDebugEnabled()) {
-            Log.debug("PEP: contactDeleted: rosterOwner is " + rosterOwner + " and deletedContact is" + deletedContact);
+    public boolean addingContact(Roster roster, RosterItem item, boolean persistent) {
+        // Do nothing
+        return false;
     }
 
-        // FIXME: Extract the code in the below method into its own method
-        unsubscribedToPresence(deletedContact, rosterOwner);
+    public void contactAdded(Roster roster, RosterItem item) {
+        // Do nothing
 
     }
 
     public void contactUpdated(Roster roster, RosterItem item) {
-        // TODO Auto-generated method stub
+        // Do nothing
 
     }
 
     public void rosterLoaded(Roster roster) {
-        // TODO Auto-generated method stub
+        // Do nothing
 
     }
 }

pep/src/java/org/jivesoftware/openfire/pep/PEPService.java

@@ -230,28 +230,31 @@ public class PEPService implements PubSubService {
         nodes.put(node.getNodeID(), node);
     }
 
-    public void broadcast(Node node, Message message, Collection<JID> jids) {
-        message.setFrom(getAddress());
-        for (JID jid : jids) {
-            message.setTo(jid);
-            message.setID(node.getNodeID() + "__" + jid.toBareJID() + "__" + StringUtils.randomString(5));
-            router.route(message);
+    public void removeNode(String nodeID) {
+        nodes.remove(nodeID);
     }
+
+    public Node getNode(String nodeID) {
+        return nodes.get(nodeID);
     }
 
-    public boolean canCreateNode(JID creator) {
-        // Node creation is always allowed for sysadmin
-        if (isNodeCreationRestricted() && !isServiceAdmin(creator)) {
-            // The user is not allowed to create nodes
-            return false;
+    public Collection<Node> getNodes() {
+        return nodes.values();
     }
-        return true;
+
+    public CollectionNode getRootCollectionNode() {
+        return rootCollectionNode;
     }
 
     public JID getAddress() {
         return new JID(serviceOwnerJID);
     }
 
+    public String getServiceID() {
+        // The bare JID of the user is the service ID for PEP
+        return serviceOwnerJID;
+    }
+
     public DefaultNodeConfiguration getDefaultNodeConfiguration(boolean leafType) {
         if (leafType) {
             return leafDefaultConfiguration;
@@ -259,25 +262,38 @@ public class PEPService implements PubSubService {
         return collectionDefaultConfiguration;
     }
 
-    public Node getNode(String nodeID) {
-        return nodes.get(nodeID);
+    public Collection<String> getShowPresences(JID subscriber) {
+        return PubSubEngine.getShowPresences(this, subscriber);
     }
 
-    public Collection<Node> getNodes() {
-        return nodes.values();
+    public boolean canCreateNode(JID creator) {
+        // Node creation is always allowed for sysadmin
+        if (isNodeCreationRestricted() && !isServiceAdmin(creator)) {
+            // The user is not allowed to create nodes
+            return false;
         }
-
-    public CollectionNode getRootCollectionNode() {
-        return rootCollectionNode;
+        return true;
     }
 
-    public String getServiceID() {
-        // The bare JID of the user is the service ID for PEP
-        return serviceOwnerJID;
+    /**
+     * Returns true if the the prober is allowed to see the presence of the probee.
+     *
+     * @param prober the user that is trying to probe the presence of another user.
+     * @param probee the username of the uset that is being probed.
+     * @return true if the the prober is allowed to see the presence of the probee.
+     * @throws UserNotFoundException If the probee does not exist in the local server or the prober
+     *         is not present in the roster of the probee.
+     */
+    private boolean canProbePresence(JID prober, JID probee) throws UserNotFoundException {
+        Roster roster;
+        roster = XMPPServer.getInstance().getRosterManager().getRoster(prober.getNode());
+        RosterItem item = roster.getRosterItem(probee);
+
+        if (item.getSubStatus() == RosterItem.SUB_BOTH || item.getSubStatus() == RosterItem.SUB_FROM) {
+            return true;
         }
 
-    public Collection<String> getShowPresences(JID subscriber) {
-        return PubSubEngine.getShowPresences(this, subscriber);
+        return false;
     }
 
     public boolean isCollectionNodesSupported() {
@@ -303,6 +319,10 @@ public class PEPService implements PubSubService {
         }
     }
 
+    public boolean isNodeCreationRestricted() {
+        return nodeCreationRestricted;
+    }
+
     public void presenceSubscriptionNotRequired(Node node, JID user) {
         PubSubEngine.presenceSubscriptionNotRequired(this, node, user);
     }
@@ -311,14 +331,19 @@ public class PEPService implements PubSubService {
         PubSubEngine.presenceSubscriptionRequired(this, node, user);
     }
 
-    public void removeNode(String nodeID) {
-        nodes.remove(nodeID);
-    }
-
     public void send(Packet packet) {
         router.route(packet);
     }
 
+    public void broadcast(Node node, Message message, Collection<JID> jids) {
+        message.setFrom(getAddress());
+        for (JID jid : jids) {
+            message.setTo(jid);
+            message.setID(node.getNodeID() + "__" + jid.toBareJID() + "__" + StringUtils.randomString(5));
+            router.route(message);
+        }
+    }
+
     public void sendNotification(Node node, Message message, JID recipientJID) {
         message.setTo(recipientJID);
         message.setFrom(getAddress());
@@ -336,8 +361,7 @@ public class PEPService implements PubSubService {
         else {
             // Since recipientJID is not local, try to get presence info from cached known remote
             // presences.
-            Map<String, Set<JID>> knownRemotePresences =
-                XMPPServer.getInstance().getIQPEPHandler().getKnownRemotePresenes();
+            Map<String, Set<JID>> knownRemotePresences = XMPPServer.getInstance().getIQPEPHandler().getKnownRemotePresenes();
 
             Set<JID> remotePresenceSet = knownRemotePresences.get(getAddress().toBareJID());
             if (remotePresenceSet != null) {
@@ -443,56 +467,6 @@ public class PEPService implements PubSubService {
         }
     }
 
-    public boolean isNodeCreationRestricted() {
-        return nodeCreationRestricted;
-    }
-
-    public void queueItemToAdd(PublishedItem newItem) {
-        PubSubEngine.queueItemToAdd(this, newItem);
-
-    }
-
-    public void queueItemToRemove(PublishedItem removedItem) {
-        PubSubEngine.queueItemToRemove(this, removedItem);
-
-    }
-
-    public Map<String, Map<String, String>> getBarePresences() {
-        return barePresences;
-    }
-
-    public Queue<PublishedItem> getItemsToAdd() {
-        return itemsToAdd;
-    }
-
-    public Queue<PublishedItem> getItemsToDelete() {
-        return itemsToDelete;
-    }
-
-    public AdHocCommandManager getManager() {
-        return manager;
-    }
-
-    public PublishedItemTask getPublishedItemTask() {
-        return publishedItemTask;
-    }
-
-    public void setPublishedItemTask(PublishedItemTask task) {
-        publishedItemTask = task;
-    }
-
-    public Timer getTimer() {
-        return timer;
-    }
-
-    public int getItemsTaskTimeout() {
-        return items_task_timeout;
-    }
-
-    public void setItemsTaskTimeout(int timeout) {
-        items_task_timeout = timeout;
-    }
-
     /**
      * Sends an event notification for the last published item to the recipient JID. For
      * a PEPService, the last published item is the latest item published for all of the
@@ -539,8 +513,7 @@ public class PEPService implements PubSubService {
         }
         // Send event notification to the subscriber
         Message notification = new Message();
-        Element event = notification.getElement()
-                .addElement("event", "http://jabber.org/protocol/pubsub#event");
+        Element event = notification.getElement().addElement("event", "http://jabber.org/protocol/pubsub#event");
         Element items = event.addElement("items");
         items.addAttribute("node", lastPublishedItem.getNode().getNodeID());
         Element item = items.addElement("item");
@@ -555,31 +528,55 @@ public class PEPService implements PubSubService {
             notification.setBody(LocaleUtils.getLocalizedString("pubsub.notification.message.body"));
         }
         // Include date when published item was created
-        notification.getElement().addElement("x", "jabber:x:delay")
-                .addAttribute("stamp", fastDateFormat.format(lastPublishedItem.getCreationDate()));
+        notification.getElement().addElement("x", "jabber:x:delay").addAttribute("stamp", fastDateFormat.format(lastPublishedItem.getCreationDate()));
         // Send the event notification to the subscriber
         this.sendNotification(subscription.getNode(), notification, subscription.getJID());
     }
 
-    /**
-     * Returns true if the the prober is allowed to see the presence of the probee.
-     *
-     * @param prober the user that is trying to probe the presence of another user.
-     * @param probee the username of the uset that is being probed.
-     * @return true if the the prober is allowed to see the presence of the probee.
-     * @throws UserNotFoundException If the probee does not exist in the local server or the prober
-     *         is not present in the roster of the probee.
-     */
-    private boolean canProbePresence(JID prober, JID probee) throws UserNotFoundException {
-        Roster roster;
-            roster = XMPPServer.getInstance().getRosterManager().getRoster(prober.getNode());
-            RosterItem item = roster.getRosterItem(probee);
+    public void queueItemToAdd(PublishedItem newItem) {
+        PubSubEngine.queueItemToAdd(this, newItem);
 
-            if (item.getSubStatus() == RosterItem.SUB_BOTH || item.getSubStatus() == RosterItem.SUB_FROM) {
-                return true;
     }
 
-        return false;
+    public void queueItemToRemove(PublishedItem removedItem) {
+        PubSubEngine.queueItemToRemove(this, removedItem);
+
+    }
+
+    public Map<String, Map<String, String>> getBarePresences() {
+        return barePresences;
+    }
+
+    public Queue<PublishedItem> getItemsToAdd() {
+        return itemsToAdd;
+    }
+
+    public Queue<PublishedItem> getItemsToDelete() {
+        return itemsToDelete;
+    }
+
+    public AdHocCommandManager getManager() {
+        return manager;
+    }
+
+    public PublishedItemTask getPublishedItemTask() {
+        return publishedItemTask;
+    }
+
+    public void setPublishedItemTask(PublishedItemTask task) {
+        publishedItemTask = task;
+    }
+
+    public Timer getTimer() {
+        return timer;
+    }
+
+    public int getItemsTaskTimeout() {
+        return items_task_timeout;
+    }
+
+    public void setItemsTaskTimeout(int timeout) {
+        items_task_timeout = timeout;
     }
 
 }

pep/src/java/org/jivesoftware/openfire/pubsub/NodeAffiliate.java

@@ -88,8 +88,8 @@ public class NodeAffiliate {
                 Element items = event.addElement("items");
                 items.addAttribute("node", getNode().getNodeID());
                 for (PublishedItem publishedItem : itemsBySubs.get(nodeSubscriptions)) {
-                    // FIXME: This was added for compatibility with PEP supporting clients like Psi.
-                    //        May not be the best of solutions.
+                    // FIXME: This was added for compatibility with PEP supporting clients.
+                    //        Alternate solution needed when XEP-0163 version > 1.0 is released.
                     //
                     // If the node ID looks like a JID, replace it with the published item's node ID.
                     if (getNode().getNodeID().indexOf("@") >= 0) {

pep/src/java/org/jivesoftware/openfire/user/UserManager.java

@@ -377,9 +377,7 @@ public class UserManager implements IQResultListener {
                 for (Iterator it=child.elementIterator("identity"); it.hasNext();) {
                     Element identity = (Element) it.next();
                     String accountType = identity.attributeValue("type");
-                    // FIXME: Not all servers provide these identity types for their regged users.
-                    //        So for PEP testing purposes, let's just assume everyone is registered.
-                    if (true /*"registered".equals(accountType) || "admin".equals(accountType)*/) {
+                    if ("registered".equals(accountType) || "admin".equals(accountType)) {
                         isRegistered = Boolean.TRUE;
                         break;
                     }