Merge lp:~stefanor/ibid/multiline-501410 into lp:~ibid-core/ibid/old-trunk-1.6

[Stefano Rivera]

[Jonathan Hitchcock (vhata)]

There may be a few plugins whose responses need tweaking, but the functionality is solid.

review: Approve

[lp:~stefanor/ibid/multiline-501410]

816. By Stefano Rivera on 2009-12-30

Clean up usage output

[Michael Gorven (mgorven)]

I think the conflation should happen in the dispatcher to avoid code
duplication in the sources.
 review needs_fixing

review: Needs Fixing

[lp:~stefanor/ibid/multiline-501410]

817. By Stefano Rivera on 2009-12-30

Move response compatibility-formatting to a core plugin

[Stefano Rivera (stefanor)]

> I think the conflation should happen in the dispatcher to avoid code
> duplication in the sources.

How about r817?

[Jonathan Hitchcock (vhata)]

Still approve - don't like the <action> reply format though - I'd prefer just *action*

[lp:~stefanor/ibid/multiline-501410]

818. By Stefano Rivera on 2009-12-30

Tab -> Space on IRC & SILC

819. By Stefano Rivera on 2009-12-30

Change action ASCIIfication to *action*

[Michael Gorven (mgorven)]

 review approve
 status approved

review: Approve

=== modified file 'ibid/core.py'
--- ibid/core.py	2009-12-21 12:43:58 +0000
+++ ibid/core.py	2009-12-30 18:39:15 +0000
@@ -60,14 +60,7 @@
 
         filtered = []
         for response in event['responses']:
-            source = response['source'].lower()
-            if source == event.source.lower():
-                if (response.get('action', False)
-                        and 'action' not in ibid.sources[source].supports):
-                    response['reply'] = '* %s %s' % (
-                            ibid.config['botname'],
-                            response['reply'],
-                    )
+            if response['source'].lower() == event.source.lower():
                 filtered.append(response)
             else:
                 self.send(response)
@@ -80,14 +73,7 @@
     def send(self, response):
         source = response['source']
         if source in ibid.sources:
-            source = ibid.sources[source]
-            if (response.get('action', False)
-                    and 'action' not in source.supports):
-                response['reply'] = '* %s %s' % (
-                        ibid.config['botname'],
-                        response['reply'],
-                )
-            reactor.callFromThread(source.send, response)
+            reactor.callFromThread(ibid.sources[source].send, response)
             self.log.debug(u"Sent response to non-origin source %s: %s", response['source'], response['reply'])
         else:
             self.log.warning(u'Received response for invalid source %s: %s', response['source'], response['reply'])

=== modified file 'ibid/event.py'
--- ibid/event.py	2009-12-14 13:51:54 +0000
+++ ibid/event.py	2009-12-30 18:39:15 +0000
@@ -30,6 +30,8 @@
         action: True for actions
         notice: True for IRC Notices
         address: False to suppress user addressing, in public
+        conflate: False to suppress conflation and truncation of lines in
+                  sources like IRC and SILC that don't support newlines
         """
         if response is None:
             # We want to detect this now, so we know which plugin is to blame
@@ -42,8 +44,9 @@
             response = {'reply': response}
 
         for k, val in (('target', self.get('channel', None)),
-                ('source', self.source),
-                ('address', True)):
+                       ('source', self.source),
+                       ('address', True),
+                       ('conflate', True)):
             if k not in response:
                 response[k] = val
 

=== modified file 'ibid/plugins/bzr.py'
--- ibid/plugins/bzr.py	2009-11-30 15:10:40 +0000
+++ ibid/plugins/bzr.py	2009-12-30 18:39:15 +0000
@@ -108,9 +108,11 @@
         revno = revno and int(revno) or None
         commits = self.get_commits(repository, revno, full=full)
 
+        output = u''
         for commit in commits:
             if commit:
-                event.addresponse(commit.strip())
+                output += commit.strip()
+        event.addresponse(output, conflate=False)
 
     def get_commits(self, repository, start, end=None, full=None):
         branch = None

=== modified file 'ibid/plugins/core.py'
--- ibid/plugins/core.py	2009-12-05 18:26:45 +0000
+++ ibid/plugins/core.py	2009-12-30 18:39:15 +0000
@@ -169,6 +169,31 @@
                 else:
                     event.processed = True
 
+class Format(Processor):
+    priority = 2000
+
+    def process(self, event):
+        filtered = []
+        for response in event.responses:
+            source = response['source'].lower()
+            supports = ibid.sources[source].supports
+
+            if response.get('action', False) and 'action' not in supports:
+                response['reply'] = u'*%s*' % response['reply']
+
+            if (not response.get('conflate', True)
+                    and 'multiline' not in supports):
+                for line in response['reply'].split('\n'):
+                    r = {'reply': line}
+                    for k in response.iterkeys():
+                        if k not in ('reply', 'conflate'):
+                            r[k] = response[k]
+                    filtered.append(r)
+            else:
+                filtered.append(response)
+
+        event.responses = filtered
+
 class UnicodeWarning(Processor):
     priority = 1950
 

=== modified file 'ibid/plugins/games.py'
--- ibid/plugins/games.py	2009-11-30 15:12:13 +0000
+++ ibid/plugins/games.py	2009-12-30 18:39:15 +0000
@@ -581,14 +581,16 @@
         This state lasts for the whole night. The next state is dawn.
         """
         self.state = self.night
-        event.addresponse(u'Night falls... most villagers are sleeping, '
-                            'but outside, something stirs.')
-        event.addresponse(plural(len(self.wolves),
-                u'Werewolf, you may kill somebody.',
-                u'Werewolves, you may kill somebody.'))
-        event.addresponse(plural(len(self.seers),
-                u"Seer, you may discover somebody's true form.",
-                u"Seers, you may discover somebody's true form."))
+        event.addresponse(
+                u'Night falls... most villagers are sleeping, '
+                u'but outside, something stirs.\n'
+                + plural(len(self.wolves),
+                         u'Werewolf, you may kill somebody.',
+                         u'Werewolves, you may kill somebody.') + '\n'
+                + plural(len(self.seers),
+                         u"Seer, you may discover somebody's true form.",
+                         u"Seers, you may discover somebody's true form."),
+                conflate=False)
         self.say_survivors(event)
 
         self.wolf_targets = {}
@@ -773,15 +775,15 @@
         if 2 * len(self.wolves) >= len(self.roles):
             # werewolves win
             event.addresponse(u'The werewolves devour the remaining '
-                    u'villagers and win. OM NOM NOM.')
-            event.addresponse(u'The winning werewolves were: %s',
-                    human_join(self.wolves))
+                              u'villagers and win. OM NOM NOM.\n'
+                              u'The winning werewolves were: %s',
+                              human_join(self.wolves), conflate=False)
         elif not self.wolves:
             # villagers win
             event.addresponse(u'The villagers have defeated the werewolves. '
-                    'Vigilantism FTW.')
-            event.addresponse(u'The surviving villagers were: %s',
-                    human_join(self.roles))
+                              u'Vigilantism FTW.\n'
+                              u'The surviving villagers were: %s',
+                              human_join(self.roles), conflate=False)
         else:
             return False
 

=== modified file 'ibid/plugins/google.py'
--- ibid/plugins/google.py	2009-12-29 15:52:42 +0000
+++ ibid/plugins/google.py	2009-12-30 18:39:15 +0000
@@ -154,15 +154,18 @@
         try:
             phrase, src_lang, dest_lang = self._parse_request(data)
             chain = set([phrase])
+            output = []
             for i in range(self.chain_length):
                 phrase, src_lang = self._translate(event, phrase,
                                                     src_lang, dest_lang)
                 src_lang, dest_lang = dest_lang, src_lang
-                event.addresponse(phrase)
+                output.append(phrase)
                 if phrase in chain:
                     break
                 chain.add(phrase)
 
+            event.addresponse(u'\n'.join(output), conflate=False)
+
         except TranslationException, e:
             event.addresponse(u"I couldn't translate that: %s.", unicode(e))
 

=== modified file 'ibid/plugins/help.py'
--- ibid/plugins/help.py	2009-07-27 14:00:45 +0000
+++ ibid/plugins/help.py	2009-12-30 18:39:15 +0000
@@ -46,13 +46,22 @@
     def usage(self, event, feature):
         feature = feature.lower()
 
+        output = []
         for processor in ibid.processors:
             for name, klass in inspect.getmembers(processor, inspect.isclass):
                 if hasattr(klass, 'feature') and klass.feature == feature and klass.__doc__:
                     for line in klass.__doc__.strip().splitlines():
-                        event.addresponse(u'Usage: %s', line.strip())
+                        output.append(line.strip())
 
-        if not event.responses:
+        if len(output) == 1:
+            event.addresponse(u'Usage: %s', output[0])
+        elif len(output) > 1:
+            event.addresponse(
+                u"You can use %(feature)s in the following ways:\n%(usage)s", {
+                    'feature': feature,
+                    'usage': u'\n'.join(output)
+                }, conflate=False)
+        else:
             event.addresponse(u"I don't know how to use %s either", feature)
 
 # vi: set et sta sw=4 ts=4:

=== modified file 'ibid/plugins/info.py'
--- ibid/plugins/info.py	2009-10-16 16:31:34 +0000
+++ ibid/plugins/info.py	2009-12-30 18:39:15 +0000
@@ -39,7 +39,6 @@
         code = fortune.wait()
 
         output = unicode_output(output.strip(), 'replace')
-        output = output.replace(u'\t', u' ').replace(u'\n', u' ')
 
         if code == 0:
             return output

=== modified file 'ibid/plugins/lookup.py'
--- ibid/plugins/lookup.py	2009-12-29 15:43:31 +0000
+++ ibid/plugins/lookup.py	2009-12-30 18:39:15 +0000
@@ -62,9 +62,8 @@
 
         soup = get_html_parse_tree('http://bash.org/?%s' % id)
 
-        if id == "random":
-            number = u"".join(soup.find('p', 'quote').find('b').contents)
-            event.addresponse(u'%s:', number)
+        number = u"".join(soup.find('p', 'quote').find('b').contents)
+        output = [u'%s:' % number]
 
         body = soup.find('p', 'qt')
         if not body:
@@ -73,7 +72,8 @@
             for line in body.contents:
                 line = unicode(line).strip()
                 if line != u'<br />':
-                    event.addresponse(line)
+                    output.append(line)
+            event.addresponse(u'\n'.join(output), conflate=False)
 
 help['lastfm'] = u'Lists the tracks last listened to by the specified user.'
 class LastFm(Processor):
@@ -179,7 +179,7 @@
                 item.get('id'),
             )
             text = item.find('text').text
-            return u'%s - %s' % (text, url)
+            return u'%s\n- %s' % (text, url)
 
     @match(r'^(?:fml\s+|http://www\.fmylife\.com/\S+/)(\d+|random|flop|top|last|love|money|kids|work|health|sex|miscellaneous)$')
     def fml(self, event, id):
@@ -264,7 +264,7 @@
                 event.addresponse(line)
             event.addresponse(u'- http://textsfromlastnight.com/view/%i', id)
         else:
-            event.addresponse(u'%(body)s - http://textsfromlastnight.com/view/%(id)i', {
+            event.addresponse(u'%(body)s\n- http://textsfromlastnight.com/view/%(id)i', {
                 'id': id,
                 'body': body[0],
             })
@@ -375,7 +375,7 @@
             url += 's/%i' % id
         else:
             url += 'story.php?id=%i' % id
-        event.addresponse(u'%(body)s - %(url)s', {
+        event.addresponse(u'%(body)s\n- %(url)s', {
             'url': url,
             'body': body,
         })

=== modified file 'ibid/plugins/network.py'
--- ibid/plugins/network.py	2009-07-27 14:00:45 +0000
+++ ibid/plugins/network.py	2009-12-30 18:39:15 +0000
@@ -99,8 +99,7 @@
 
         if code == 0:
             output = unicode_output(output)
-            for line in output.splitlines():
-                event.addresponse(line)
+            event.addresponse(output, conflate=False)
         else:
             error = unicode_output(error.strip())
             event.addresponse(u'Error: %s', error.replace(u'\n', u' '))

=== modified file 'ibid/source/campfire.py'
--- ibid/source/campfire.py	2009-12-28 14:09:20 +0000
+++ ibid/source/campfire.py	2009-12-30 18:39:15 +0000
@@ -78,25 +78,8 @@
             self.say(response['target'], message)
 
     def respond(self, event):
-        if len(event.responses) == 1:
-            self.send(event.responses[0])
-        elif len(event.responses) > 1:
-            # Attempt to merge contiguous responses into a PasteMessage
-            buffer = event.responses[0]
-            buffer['reply'] = buffer['reply'].replace(u'\n', u' ')
-            for r in event.responses[1:]:
-                keys = set(r.keys()).union(set(buffer.keys())) \
-                                    .difference(set(('reply',)))
-                for k in keys:
-                    if k not in buffer or k not in r or buffer[k] != r[k]:
-                        break
-                else:
-                    buffer['reply'] += u'\n' + r['reply'].replace(u'\n', u' ')
-                    continue
-                self.send(buffer)
-                buffer = r
-
-            self.send(buffer)
+        for response in event.responses:
+            self.send(response)
 
     def join(self, room_name):
         return self.join_room(self._locate_room(room_name))
@@ -107,7 +90,7 @@
 class SourceFactory(IbidSourceFactory):
 
     auth = ('implicit',)
-    supports = ('action', 'topic')
+    supports = ('action', 'multiline', 'topic')
 
     subdomain = Option('subdomain', 'Campfire subdomain')
     secure = BoolOption('secure', 'Use https (paid accounts only)', False)

=== modified file 'ibid/source/dc.py'
--- ibid/source/dc.py	2009-12-20 20:02:55 +0000
+++ ibid/source/dc.py	2009-12-30 18:39:15 +0000
@@ -97,7 +97,7 @@
             self.send(response)
 
     def send(self, response):
-        message = response['reply'].replace('\n', ' ')[:490]
+        message = response['reply']
 
         if message:
             for prefix in self.factory.banned_prefixes:
@@ -142,7 +142,7 @@
 class SourceFactory(protocol.ReconnectingClientFactory, IbidSourceFactory):
     protocol = DCBot
 
-    supports = ('action', 'topic')
+    supports = ('action', 'multiline', 'topic')
     auth = ('op',)
 
     port = IntOption('port', 'Server port number', 411)

=== modified file 'ibid/source/irc.py'
--- ibid/source/irc.py	2009-10-31 14:28:20 +0000
+++ ibid/source/irc.py	2009-12-30 18:39:15 +0000
@@ -137,7 +137,7 @@
             self.send(response)
 
     def send(self, response):
-        message = response['reply'].replace('\n', ' ')[:490]
+        message = response['reply'].expandtabs(1).replace('\n', ' ')[:490]
         raw_message = message.encode('utf-8')
 
         # Target may be a connection or a plain nick

=== modified file 'ibid/source/jabber.py'
--- ibid/source/jabber.py	2009-12-24 09:14:32 +0000
+++ ibid/source/jabber.py	2009-12-30 18:39:15 +0000
@@ -137,6 +137,8 @@
 class SourceFactory(client.DeferredClientFactory, IbidSourceFactory):
 
     auth = ('implicit',)
+    supports = ('multiline',)
+
     port = IntOption('port', 'Server port number')
     ssl = BoolOption('ssl', 'Usel SSL', False)
     server = Option('server', 'Server hostname')

=== modified file 'ibid/source/pb.py'
--- ibid/source/pb.py	2009-02-23 20:29:44 +0000
+++ ibid/source/pb.py	2009-12-30 18:39:15 +0000
@@ -33,6 +33,8 @@
 
 class SourceFactory(IbidSourceFactory):
 
+    supports = ('multiline',)
+
     port = IntOption('port', 'Port number to listen on', 8789)
 
     def setServiceParent(self, service):

=== modified file 'ibid/source/silc.py'
--- ibid/source/silc.py	2009-10-31 14:28:20 +0000
+++ ibid/source/silc.py	2009-12-30 18:39:15 +0000
@@ -70,7 +70,8 @@
             self.send(response)
 
     def send(self, response):
-        message = response['reply'].replace('\n', ' ').encode('utf-8')
+        message = response['reply'].expandtabs(1).replace('\n', ' ') \
+                  .encode('utf-8')
         flags=0
         if response.get('action', False):
             flags=4

=== modified file 'ibid/source/smtp.py'
--- ibid/source/smtp.py	2009-10-19 15:07:40 +0000
+++ ibid/source/smtp.py	2009-12-30 18:39:15 +0000
@@ -76,6 +76,8 @@
 
 class SourceFactory(IbidSourceFactory, smtp.SMTPFactory):
 
+    supports = ('multiline',)
+
     port = IntOption('port', 'Port number to listen on', 10025)
     address = Option('address', 'Email address to accept messages for and send from', 'ibid@localhost')
     accept = ListOption('accept', 'Email addresses to accept messages for', [])

=== modified file 'ibid/source/telnet.py'
--- ibid/source/telnet.py	2009-07-10 13:34:44 +0000
+++ ibid/source/telnet.py	2009-12-30 18:39:15 +0000
@@ -52,6 +52,8 @@
 class SourceFactory(protocol.ServerFactory, IbidSourceFactory):
     protocol = TelnetProtocol
 
+    supports = ('multiline',)
+
     port = IntOption('port', 'Port to listen on', 3000)
 
     def __init__(self, name, *args, **kwargs):

=== modified file 'scripts/ibid-plugin'
--- scripts/ibid-plugin	2009-12-21 12:43:58 +0000
+++ scripts/ibid-plugin	2009-12-30 18:39:15 +0000
@@ -58,7 +58,7 @@
 class TestSource(dict):
     type = 'test'
     permissions = []
-    supports = ('action', 'notice')
+    supports = ('action', 'multiline', 'notice')
     logging_name = lambda self, name: name
 
 ibid.sources[u'test_source'] = TestSource()