Merge lp:~stefanor/ibid/factoid-495700 into lp:~ibid-core/ibid/old-trunk-1.6

[Stefano Rivera]

[lp:~stefanor/ibid/factoid-495700]

797. By Stefano Rivera on 2009-12-12

Remove some redundant code

[Michael Gorven (mgorven)]

 review approve

review: Approve

[lp:~stefanor/ibid/factoid-495700]

798. By Stefano Rivera on 2009-12-14

gettatr doesn't work as expected on events

[Jonathan Hitchcock (vhata)]

review: Approve

=== modified file 'ibid/plugins/factoid.py'
--- ibid/plugins/factoid.py	2009-12-11 22:38:52 +0000
+++ ibid/plugins/factoid.py	2009-12-14 13:43:11 +0000
@@ -4,11 +4,13 @@
 import re
 
 from dateutil.tz import tzlocal, tzutc
-from sqlalchemy import Column, Integer, Unicode, DateTime, ForeignKey, UnicodeText, Table, or_
-from sqlalchemy.orm import relation
+from sqlalchemy import Column, Table, ForeignKey, or_, Boolean, Integer, \
+                       Unicode, UnicodeText, DateTime
+from sqlalchemy.orm import relation, synonym
 from sqlalchemy.sql import func
 
-from ibid.plugins import Processor, match, handler, authorise, auth_responses, RPC
+from ibid.plugins import Processor, match, handler, authorise, auth_responses, \
+                         RPC
 from ibid.config import Option, IntOption, ListOption
 from ibid.plugins.identity import get_identities
 from ibid.models import Base, VersionedSchema
@@ -24,17 +26,27 @@
 default_interrogatives = ('what', 'wtf', 'where', 'when', 'who', "what's", "who's")
 
 def strip_name(unstripped):
+    "Apply to factoid names, as we use unstripped matches"
     return re.match(r'^\s*(.*?)[?!.]*\s*$', unstripped, re.DOTALL).group(1)
 
+def escape_name(name):
+    "Turn a $arg factoid name to _%"
+    return name.replace('%', '\\%').replace('_', '\\_').replace('$arg', '_%')
+
+def unescape_name(name):
+    "Turn a _% factoid name to $arg"
+    return name.replace('_%', '$arg').replace('\\%', '%').replace('\\_', '_')
+
 class FactoidName(Base):
     __table__ = Table('factoid_names', Base.metadata,
     Column('id', Integer, primary_key=True),
-    Column('name', UnicodeText, nullable=False, unique=True, index=True,
-            info={'ibid_mysql_index_length': 32}),
+    Column('name', UnicodeText, key='_name', nullable=False, unique=True, index=True,
+           info={'ibid_mysql_index_length': 32}),
     Column('factoid_id', Integer, ForeignKey('factoids.id'), nullable=False, index=True),
     Column('identity_id', Integer, ForeignKey('identities.id'), index=True),
     Column('time', DateTime, nullable=False),
     Column('factpack', Integer, ForeignKey('factpacks.id'), index=True),
+    Column('wild', Boolean, nullable=False, default=False, index=True),
     useexisting=True)
 
     class FactoidNameSchema(VersionedSchema):
@@ -48,12 +60,25 @@
             self.add_index(self.table.c.identity_id)
             self.add_index(self.table.c.factpack)
         def upgrade_4_to_5(self):
-            self.alter_column(Column('name', Unicode(64), nullable=False, unique=True, index=True))
+            self.alter_column(Column('name', Unicode(64), key='_name', nullable=False,
+                                     unique=True, index=True))
         def upgrade_5_to_6(self):
-            self.alter_column(Column('name', UnicodeText, nullable=False,
-                unique=True, index=True, info={'ibid_mysql_index_length': 32}))
+            self.alter_column(Column('name', UnicodeText, key='_name', nullable=False,
+                                     unique=True, index=True,
+                                     info={'ibid_mysql_index_length': 32}))
+        def upgrade_6_to_7(self):
+            self.add_column(Column('wild', Boolean, nullable=False, index=True,
+                                   default=False, server_default='0'))
+            # http://www.sqlalchemy.org/trac/ticket/1400:
+            # We can't use .like() in MySQL
+            for row in self.upgrade_session.query(FactoidName) \
+                    .filter('name LIKE :pattern ESCAPE :escape') \
+                    .params(pattern='%\\_\\%%', escape='\\') \
+                   .all():
+                row.wild = True
+                self.upgrade_session.save_or_update(row)
 
-    __table__.versioned_schema = FactoidNameSchema(__table__, 6)
+    __table__.versioned_schema = FactoidNameSchema(__table__, 7)
 
     def __init__(self, name, identity_id, factoid_id=None, factpack=None):
         self.name = name
@@ -65,6 +90,15 @@
     def __repr__(self):
         return u'<FactoidName %s %s>' % (self.name, self.factoid_id)
 
+    def _get_name(self):
+        return unescape_name(self._name)
+
+    def _set_name(self, name):
+        self.wild = u'$arg' in name
+        self._name = escape_name(name)
+
+    name = synonym('_name', descriptor=property(_get_name, _set_name))
+
 class FactoidValue(Base):
     __table__ = Table('factoid_values', Base.metadata,
     Column('id', Integer, primary_key=True),
@@ -142,13 +176,8 @@
 reply_re = re.compile(r'^\s*<reply>\s*')
 escape_like_re = re.compile(r'([%_\\])')
 
-def escape_name(name):
-    return name.replace('%', '\\%').replace('_', '\\_').replace('$arg', '_%')
-
-def unescape_name(name):
-    return name.replace('_%', '$arg').replace('\\%', '%').replace('\\_', '_')
-
-def get_factoid(session, name, number, pattern, is_regex, all=False, literal=False):
+def get_factoid(session, name, number, pattern, is_regex, all=False,
+                literal=False):
     """session: SQLAlchemy session
     name: Factoid name (can contain arguments unless literal query)
     number: Return factoid[number] (or factoid[number:] for literal queries)
@@ -157,34 +186,55 @@
     all: Return a random factoid from the set if False
     literal: Match factoid name literally (implies all)
     """
-    factoid = None
-    # Reversed LIKE because factoid name contains SQL wildcards if factoid supports arguments
-    query = session.query(Factoid)\
-            .add_entity(FactoidName).join(Factoid.names)\
-            .add_entity(FactoidValue).join(Factoid.values)
+    # First pass for exact matches, if necessary again for wildcard matches
     if literal:
-        query = query.filter(func.lower(FactoidName.name)==escape_name(name).lower())
-    else:
-        query = query.filter(":fact LIKE name ESCAPE :escape").params(fact=name, escape='\\')
-    if pattern:
-        if is_regex:
-            query = query.filter(FactoidValue.value.op('REGEXP')(pattern))
-        else:
-            pattern = "%%%s%%" % escape_like_re.sub(r'\\\1', pattern)
-            # http://www.sqlalchemy.org/trac/ticket/1400: We can't use .like() in MySQL
-            query = query.filter('value LIKE :pattern ESCAPE :escape').params(pattern=pattern, escape='\\')
-    if number:
-        try:
-            if literal:
-                return query.order_by(FactoidValue.id)[int(number) - 1:]
-            else:
-                factoid = query.order_by(FactoidValue.id)[int(number) - 1]
-        except IndexError:
-            return
-    if all or literal:
-        return factoid and [factoid] or query.all()
-    else:
-        return factoid or query.order_by(func.random()).first()
+        passes = (False,)
+    else:
+        passes = (False, True)
+    for wild in passes:
+        factoid = None
+        query = session.query(Factoid)\
+                .add_entity(FactoidName).join(Factoid.names)\
+                .add_entity(FactoidValue).join(Factoid.values)
+        if wild:
+            # Reversed LIKE because factoid name contains SQL wildcards if
+            # factoid supports arguments
+            query = query.filter(':fact LIKE name ESCAPE :escape') \
+                         .params(fact=name, escape='\\')
+        else:
+            query = query.filter(func.lower(FactoidName.name) \
+                                 == escape_name(name).lower())
+        # For normal matches, restrict to the subset applicable
+        if not literal:
+            query = query.filter(FactoidName.wild == wild)
+
+        if pattern:
+            if is_regex:
+                query = query.filter(FactoidValue.value.op('REGEXP')(pattern))
+            else:
+                pattern = '%%%s%%' % escape_like_re.sub(r'\\\1', pattern)
+                # http://www.sqlalchemy.org/trac/ticket/1400:
+                # We can't use .like() in MySQL
+                query = query.filter('value LIKE :pattern ESCAPE :escape') \
+                             .params(pattern=pattern, escape='\\')
+
+        if number:
+            try:
+                if literal:
+                    return query.order_by(FactoidValue.id)[int(number) - 1:]
+                else:
+                    factoid = query.order_by(FactoidValue.id)[int(number) - 1]
+            except IndexError:
+                continue
+        if all or literal:
+            if factoid is not None:
+                return [factoid]
+            else:
+                factoid = query.all()
+        else:
+            factoid = factoid or query.order_by(func.random()).first()
+        if factoid:
+            return factoid
 
 class Utils(Processor):
     u"""literal <name> [( #<from number> | /<pattern>/[r] )]"""
@@ -286,7 +336,7 @@
                 event.addresponse(u"I already know stuff about %s", target)
                 return
 
-            name = FactoidName(escape_name(unicode(target)), event.identity)
+            name = FactoidName(unicode(target), event.identity)
             factoid.names.append(name)
             event.session.save_or_update(factoid)
             event.session.commit()
@@ -347,7 +397,9 @@
         matches = [match for match in query[start:start+limit]]
 
         if matches:
-            event.addresponse(u'; '.join(u'%s [%s]' % (unescape_name(fname.name), len(factoid.values)) for factoid, fname in matches))
+            event.addresponse(u'; '.join(
+                u'%s [%s]' % (fname.name, len(factoid.values))
+                for factoid, fname in matches))
         else:
             event.addresponse(u"I couldn't find anything that matched '%s'" % origpattern)
 
@@ -401,14 +453,12 @@
         if factoid:
             (factoid, fname, fvalue) = factoid
             reply = fvalue.value
-            pattern = re.escape(fname.name).replace(r'\_\%', '(.*)').replace('\\\\\\%', '%').replace('\\\\\\_', '_')
+            oname = fname.name
+            pattern = re.escape(fname.name).replace(r'\$arg', '(.*)')
 
-            position = 1
-            for capture in re.match(pattern, name, re.I).groups():
-                if capture.startswith('$arg'):
-                    return
-                reply = reply.replace('$%s' % position, capture)
-                position = position + 1
+            for i, capture in enumerate(re.match(pattern, name, re.I).groups()):
+                reply = reply.replace('$%s' % (i + 1), capture)
+                oname = oname.replace('$arg', capture, 1)
 
             reply = _interpolate(reply, event)
 
@@ -420,7 +470,7 @@
             if count:
                 return {'address': False, 'reply': reply}
 
-            reply = u'%s %s' % (unescape_name(fname.name), reply)
+            reply = u'%s %s' % (oname, reply)
             return reply
 
 class Set(Processor):
@@ -473,7 +523,7 @@
                 return
         else:
             factoid = Factoid()
-            fname = FactoidName(escape_name(unicode(name)), event.identity)
+            fname = FactoidName(unicode(name), event.identity)
             factoid.names.append(fname)
             event.session.save_or_update(factoid)
             event.session.flush()

=== modified file 'ibid/plugins/log.py'
--- ibid/plugins/log.py	2009-12-11 14:26:39 +0000
+++ ibid/plugins/log.py	2009-12-14 13:43:11 +0000
@@ -64,7 +64,7 @@
 
             file = open(filename, 'a')
             self.logs[filename] = file
-            if getattr(event, 'public', True):
+            if event.get('public', True):
                 chmod(filename, int(self.public_mode, 8))
             else:
                 chmod(filename, int(self.private_mode, 8))

=== modified file 'scripts/ibid-factpack'
--- scripts/ibid-factpack	2009-10-19 15:07:40 +0000
+++ scripts/ibid-factpack	2009-12-14 13:43:11 +0000
@@ -9,7 +9,8 @@
 import ibid
 from ibid.compat import json
 from ibid.config import FileConfig
-from ibid.plugins.factoid import Factoid, FactoidName, FactoidValue, Factpack, escape_name
+from ibid.plugins.factoid import Factoid, FactoidName, FactoidValue, Factpack, \
+                                 escape_name
 
 parser = OptionParser(usage=u'%prog <factpack>')
 parser.add_option('-r', '--remove', action='store_true', help='Remove the named factpack from the database')
@@ -45,7 +46,8 @@
         session.delete(factoid)
 
     if extras and not options.force:
-        print >> stderr, u'The following factoid entries have been added. Use -f to force removal.'
+        print >> stderr, u'The following factoid entries have been added. ' \
+                         u'Use -f to force removal.'
         for extra in extras:
             print extra
         exit(6)
@@ -80,10 +82,13 @@
 for names, values in facts:
     factoid = Factoid(factpack.id)
     for name in names:
-        if session.query(FactoidName).filter(func.lower(FactoidName.name)==escape_name(name).lower()).first():
+        if session.query(FactoidName) \
+                  .filter(func.lower(FactoidName.name)
+                          == escape_name(name).lower()) \
+                  .first():
             existing.append(name)
             continue
-        fname = FactoidName(escape_name(unicode(name)), None, factpack=factpack.id)
+        fname = FactoidName(unicode(name), None, factpack=factpack.id)
         factoid.names.append(fname)
     for value in values:
         fvalue = FactoidValue(unicode(value), None, factpack=factpack.id)
@@ -92,7 +97,9 @@
         session.save(factoid)
 
 if existing and not options.skip:
-    print >> stderr, u'The following factoids already exist in the database. Please remove them before importing this factpack, or use -s to skip them'
+    print >> stderr, u'The following factoids already exist in the database. ' \
+                     u'Please remove them before importing this factpack, ' \
+                     u'or use -s to skip them'
     for name in existing:
         print >> stderr, name
     session.rollback()