'Sign in with Twitter' button img

[quix0rs-gnu-social.git] / plugins / RSSCloud / RSSCloudNotifier.php

diff --git a/plugins/RSSCloud/RSSCloudNotifier.php b/plugins/RSSCloud/RSSCloudNotifier.php
index 909cf5c9f39a46dfd18e437f1555261da948b969..d454691c80ec5ee028d814505b212aebe776d1b7 100644 (file)
--- a/plugins/RSSCloud/RSSCloudNotifier.php
+++ b/plugins/RSSCloud/RSSCloudNotifier.php
@@ -31,10 +31,29 @@ if (!defined('STATUSNET')) {
     exit(1);
 }
 
-class RSSCloudNotifier {
-
+/**
+ * Class for notifying cloud-enabled RSS aggregators that StatusNet
+ * feeds have been updated.
+ *
+ * @category Plugin
+ * @package  StatusNet
+ * @author   Zach Copley <zach@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link     http://status.net/
+ **/
+class RSSCloudNotifier
+{
     const MAX_FAILURES = 3;
 
+    /**
+     * Send an HTTP GET to the notification handler with a
+     * challenge string to see if it repsonds correctly.
+     *
+     * @param string $endpoint URL of the notification handler
+     * @param string $feed     the feed being subscribed to
+     *
+     * @return boolean success
+     */
     function challenge($endpoint, $feed)
     {
         $code   = common_confirmation_code(128);
@@ -42,10 +61,11 @@ class RSSCloudNotifier {
         $url    = $endpoint . '?' . http_build_query($params);
 
         try {
-            $client = new HTTPClient();
+            $client   = new HTTPClient();
             $response = $client->get($url);
         } catch (HTTP_Request2_Exception $e) {
-            common_log(LOG_INFO, 'RSSCloud plugin - failure testing notify handler ' .
+            common_log(LOG_INFO,
+                       'RSSCloud plugin - failure testing notify handler ' .
                        $endpoint . ' - '  . $e->getMessage());
             return false;
         }
@@ -60,7 +80,7 @@ class RSSCloudNotifier {
             // NOTE: the spec says that the body must contain the string
             // challenge.  It doesn't say that the body must contain the
             // challenge string ONLY, although that seems to be the way
-            // the other implementations have interpreted it.
+            // the other implementors have interpreted it.
 
             if (strpos($body, $code) !== false) {
                 common_log(LOG_INFO, 'RSSCloud plugin - ' .
@@ -82,13 +102,23 @@ class RSSCloudNotifier {
         }
     }
 
-    function postUpdate($endpoint, $feed) {
+    /**
+     * HTTP POST a notification that a feed has been updated
+     * ('ping the cloud').
+     *
+     * @param String $endpoint URL of the notification handler
+     * @param String $feed     the feed being subscribed to
+     *
+     * @return boolean success
+     */
+    function postUpdate($endpoint, $feed)
+    {
 
         $headers  = array();
         $postdata = array('url' => $feed);
 
         try {
-            $client = new HTTPClient();
+            $client   = new HTTPClient();
             $response = $client->post($endpoint, $headers, $postdata);
         } catch (HTTP_Request2_Exception $e) {
             common_log(LOG_INFO, 'RSSCloud plugin - failure notifying ' .
@@ -111,12 +141,21 @@ class RSSCloudNotifier {
         }
     }
 
+    /**
+     * Notify all subscribers to a profile feed that it has changed.
+     *
+     * @param Profile $profile the profile whose feed has been
+     *        updated
+     *
+     * @return boolean success
+     */
     function notify($profile)
     {
         $feed = common_path('api/statuses/user_timeline/') .
           $profile->nickname . '.rss';
 
         $cloudSub = new RSSCloudSubscription();
+
         $cloudSub->subscribed = $profile->id;
 
         if ($cloudSub->find()) {
@@ -131,6 +170,18 @@ class RSSCloudNotifier {
         return true;
     }
 
+    /**
+     * Handle problems posting cloud notifications. Increment the failure
+     * count, or delete the subscription if the maximum number of failures
+     * is exceeded.
+     *
+     * XXX: Redo with proper DB_DataObject methods once I figure out what
+     * what the problem is with pluginized DB_DataObjects. -Z
+     *
+     * @param RSSCloudSubscription $cloudSub the subscription in question
+     *
+     * @return boolean success
+     */
     function handleFailure($cloudSub)
     {
         $failCnt = $cloudSub->failures + 1;
@@ -138,7 +189,8 @@ class RSSCloudNotifier {
         if ($failCnt == self::MAX_FAILURES) {
 
             common_log(LOG_INFO,
-                       'Deleting RSSCloud subcription (max failure count reached), profile: ' .
+                       'Deleting RSSCloud subcription ' .
+                       '(max failure count reached), profile: ' .
                        $cloudSub->subscribed .
                        ' handler: ' .
                        $cloudSub->url);
@@ -161,7 +213,8 @@ class RSSCloudNotifier {
 
         } else {
 
-            common_debug('Updating failure count on RSSCloud subscription. ' . $failCnt);
+            common_debug('Updating failure count on RSSCloud subscription. ' .
+                         $failCnt);
 
             $failCnt = $cloudSub->failures + 1;
 
@@ -172,15 +225,15 @@ class RSSCloudNotifier {
               ' WHERE subscribed = ' . $cloudSub->subscribed .
               ' AND url = \'' . $cloudSub->url . '\'';
 
-            common_debug($qry);
-
             $result = $cloudSub->query($qry);
 
             if (!$result) {
                 common_log_db_error($cloudsub, 'UPDATE', __FILE__);
-                common_log(LOG_ERR, 'Could not update failure count on RSSCloud subscription');
+                common_log(LOG_ERR,
+                           'Could not update failure ' .
+                           'count on RSSCloud subscription');
             }
-         }
+        }
     }
 
 }