Changeset f26d9a3e

Timestamp:

2012-11-24T14:10:34Z (12 years ago)

Author:

Wilmer van der Gaast <wilmer@…>

Branches:

master

Children:

5f2f728

Parents:

c751e51

Message:

Add help info for "stream" setting. Also, disable it for non-Twitter accounts.

Files:

• doc/user-guide/commands.xml (modified) (1 diff)
• protocols/twitter/twitter.c (modified) (5 diffs)

doc/user-guide/commands.xml

@@ -1023 +1023 @@
 
         </bitlbee-setting>
+
+        <bitlbee-setting name="stream" type="boolean" scope="account">
+                <default>true</default>
+
+                <description>
+                        <para>
+                                For Twitter accounts, this setting enables use of the Streaming API. This automatically gives you incoming DMs as well.
+                        </para>
+                        
+                        <para>
+                                For other Twitter-like services, this setting is not supported.
+                        </para>
+                </description>
+
+        </bitlbee-setting>
         
         <bitlbee-setting name="target_url_length" type="integer" scope="account">

protocols/twitter/twitter.c

@@ -65 +65 @@
         imcb_log(ic, "Getting initial statuses");
 
-        // Run this once. After this queue the main loop function.
+        // Run this once. After this queue the main loop function (or open the
+        // stream if available).
         twitter_main_loop(ic, -1, 0);
         
@@ -72 +73 @@
                    us the rest. \o/ */
                 twitter_open_stream(ic);
+                
+                /* Stream sends keepalives (empty lines) or actual data at
+                   least twice a minute. Disconnect if this stops. */
                 ic->flags |= OPT_PONGS;
         } else {
@@ -96 +100 @@
                 imcb_log(ic, "Getting contact list");
                 twitter_get_friends_ids(ic, -1);
-                //twitter_get_statuses_friends(ic, -1);
         } else
                 twitter_main_loop_start(ic);
@@ -289 +292 @@
         s = set_add(&acc->set, "strip_newlines", "false", set_eval_bool, acc);
         
-        s = set_add(&acc->set, "stream", "true", set_eval_bool, acc);
-        s->flags |= ACC_SET_OFFLINE_ONLY;
+        if (strcmp(acc->prpl->name, "twitter") == 0) {
+                s = set_add(&acc->set, "stream", "true", set_eval_bool, acc);
+                s->flags |= ACC_SET_OFFLINE_ONLY;
+        }
 }
 
 /**
- * Login method. Since the twitter API works with seperate HTTP request we 
+ * Login method. Since the twitter API works with separate HTTP request we
  * only save the user and pass to the twitter_data object.
  */
@@ -310 +315 @@
                 imc_logout(ic, FALSE);
                 return;
+        }
+
+        if (!strstr(url.host, "twitter.com") &&
+            set_getbool(&ic->acc->set, "stream")) {
+                imcb_error(ic, "Warning: The streaming API is only supported by Twitter, "
+                               "and you seem to be connecting to a different service.");
         }