Merge lp:~stefanor/ibid/setup-prompts-515550 into lp:~ibid-core/ibid/old-trunk-1.6

[Stefano Rivera]

[Stefano Rivera (stefanor)]

OK, so maybe this fixes more than one thing, but they are all in ibid-setup

[Michael Gorven (mgorven)]

 review approve

review: Approve

[marcog (marco-gallotta)]

While you're at it, how about making it clearer that what the nick/JID, source and password are? Someone might go choose a totally different nick to their source nick. "source" is quite arb to unaccustomed users. And which password? The one I use on IRC or a new one?

review: Needs Fixing

[Jonathan Hitchcock (vhata)]

+1 for Marco's comment.

I would also say something like "Pick a name for your first source" instead of just "Source name" - the latter sounds like something I should know, instead of something that I can make up.

review: Needs Fixing

[Stefano Rivera (stefanor)]

> While you're at it, how about making it clearer that what the nick/JID, source
> and password are?

Rereview please.

[Michael Gorven (mgorven)]

 review approve

review: Approve

[lp:~stefanor/ibid/setup-prompts-515550]

875. By Stefano Rivera on 2010-02-05

Reword account prompt

876. By Stefano Rivera on 2010-02-05

Reword account password prompt

877. By Stefano Rivera on 2010-02-05

Unicode everywhere

[marcog (marco-gallotta)]

Still not so happy about the lack of error-checking which can end in very weird results, e.g.

Database URL [Default: sqlite:///ibid.db]: foo
Traceback (most recent call last):
  File "scripts/ibid-setup", line 97, in <module>
    db = DatabaseManager(check_schema_versions=False)
...
    "Could not parse rfc1738 URL from string '%s'" % name)
sqlalchemy.exceptions.ArgumentError: Could not parse rfc1738 URL from string 'foo'

Source name example of "freenode" suggests that it has to be the server name. Not sure if this is good or bad.

Source type could have a default of IRC.

Mention that non-{irc,jabber} sources can be configured manually, with pointer to docs.

> Couldn't load trac plugin: argument of type 'NoneType' is not iterable

What?

Mask warnings.

Maybe hide the debug output (keeping info) unless -v is passed. Why is "Database tables created" and all the "Couldn't load" stuff not printed as info messages?

review: Needs Fixing

[lp:~stefanor/ibid/setup-prompts-515550]

878. By Stefano Rivera on 2010-02-05

Suppres trac load exception in ibid-setup by having an ibid.databases dict

879. By Stefano Rivera on 2010-02-05

Raise logging noise floor by default in ibid-setup

880. By Stefano Rivera on 2010-02-05

Relocate module loading to after config file already exists, and complain less

881. By Stefano Rivera on 2010-02-05

We only support IRC and jabber

882. By Stefano Rivera on 2010-02-05

Default to IRC

[Stefano Rivera (stefanor)]

> Still not so happy about the lack of error-checking which can end in very
> weird results, e.g.

I'm ignoring that for now. It's a new bot install, so you can't do serious damage that can't be fixed with rm -rf. https://bugs.edge.launchpad.net/ibid/+bug/517617

> Source name example of "freenode" suggests that it has to be the server name.
> Not sure if this is good or bad.

Marco changed his mind about this.

> Source type could have a default of IRC.

r882.

> Mention that non-{irc,jabber} sources can be configured manually, with pointer
> to docs.

r881.

> > Couldn't load trac plugin: argument of type 'NoneType' is not iterable

r880.

> Mask warnings.

I'll look at that now.

> Maybe hide the debug output (keeping info) unless -v is passed.

r879.

> Why is "Database tables created" and all the "Couldn't load" stuff not printed as
> info messages?

Because info messages are ugly. The ones you see come from elsewhere in ibid. But it's a plausible change request.

[lp:~stefanor/ibid/setup-prompts-515550]

883. By Stefano Rivera on 2010-02-05

Shush SQLAlchemy save_or_update warnings

[Stefano Rivera (stefanor)]

> I'll look at that now.

r883.

[lp:~stefanor/ibid/setup-prompts-515550]

884. By Stefano Rivera on 2010-02-05

Merged from trunk

[marcog (marco-gallotta)]

> > Source type could have a default of IRC.
>
> r882.

Nit-pick, but the default should be specified in [].

> > Mask warnings.
>
> I'll look at that now.

Confirm password:
/var/lib/python-support/python2.6/sqlalchemy/engine/default.py:241: SAWarning: Unicode type received non-unicode bind param value 'a'
  param.append(processors[key](compiled_params[key]))
Account created with admin permissions

review: Needs Fixing

[Stefano Rivera (stefanor)]

> Nit-pick, but the default should be specified in [].

r885.

> Confirm password:
> /var/lib/python-support/python2.6/sqlalchemy/engine/default.py:241: SAWarning:
> Unicode type received non-unicode bind param value 'a'
> param.append(processors[key](compiled_params[key]))

r886.

[lp:~stefanor/ibid/setup-prompts-515550]

885. By Stefano Rivera on 2010-02-05

Make it clear that IRC is default

886. By Stefano Rivera on 2010-02-05

Helper function to decode all input to unicode

[marcog (marco-gallotta)]

review: Approve

[Jonathan Hitchcock (vhata)]

I'm hoping #515550 will make this even greaterer, but this is good for now.

review: Approve

=== modified file 'ibid/__init__.py'
--- ibid/__init__.py	2010-01-31 15:38:34 +0000
+++ ibid/__init__.py	2010-02-05 19:55:18 +0000
@@ -84,7 +84,7 @@
 dispatcher = None
 processors = []
 reloader = None
-databases = None
+databases = {}
 auth = None
 service = None
 options = {}

=== modified file 'ibid/db/__init__.py'
--- ibid/db/__init__.py	2010-02-03 16:06:30 +0000
+++ ibid/db/__init__.py	2010-02-05 19:55:18 +0000
@@ -1,5 +1,6 @@
 # Copyright (c) 2009-2010, Stefano Rivera
 # Released under terms of the MIT/X/Expat Licence. See COPYING for details.
+import warnings as _warnings
 
 from ibid.db.types import TypeDecorator, Integer, DateTime, Boolean, \
                           IbidUnicode, IbidUnicodeText
@@ -10,7 +11,7 @@
 from sqlalchemy.sql import func
 from sqlalchemy.ext.declarative import declarative_base as _declarative_base
 
-from sqlalchemy.exceptions import IntegrityError
+from sqlalchemy.exceptions import IntegrityError, SADeprecationWarning
 
 metadata = _MetaData()
 Base = _declarative_base(metadata=metadata)
@@ -18,4 +19,7 @@
 from ibid.db.versioned_schema import VersionedSchema, SchemaVersionException, \
                                      schema_version_check, upgrade_schemas
 
+# We use SQLAlchemy 0.4 compatible .save_or_update() functions
+_warnings.filterwarnings('ignore', 'Use session.add\(\)', SADeprecationWarning)
+
 # vi: set et sta sw=4 ts=4:

=== modified file 'scripts/ibid-setup'
--- scripts/ibid-setup	2010-01-18 22:13:23 +0000
+++ scripts/ibid-setup	2010-02-05 19:55:18 +0000
@@ -3,15 +3,15 @@
 # Released under terms of the MIT/X/Expat Licence. See COPYING for details.
 
 import logging
+from optparse import OptionParser
 import sys
 from sys import exit, stderr
-from sqlalchemy import create_engine
-from sqlalchemy.orm import sessionmaker
 from getpass import getpass
+from os import getenv
 from os.path import exists
 from shutil import copyfileobj
 
-from pkg_resources import resource_stream
+from pkg_resources import resource_filename, resource_stream
 from twisted.python.modules import getModule
 
 sys.path.insert(0, '.')
@@ -19,76 +19,128 @@
 import ibid
 from ibid.config import FileConfig
 from ibid.core import DatabaseManager
-from ibid.db import metadata, upgrade_schemas
+from ibid.db import upgrade_schemas
 from ibid.db.models import Account, Identity, Permission, Credential
 from ibid.auth import hash
 
-logging.basicConfig(level=logging.DEBUG)
-
-for module in getModule('ibid.plugins').iterModules():
-    try:
-        __import__(module.name)
-    except Exception, e:
-        print >> stderr, u"Couldn't load %s plugin: %s" % (module.name.replace('ibid.plugins.', ''), unicode(e))
+parser = OptionParser(usage="%prog [options...]")
+parser.add_option('-v', '--verbose', action='store_true', default=False,
+        help="Output debugging information")
+
+(options, args) = parser.parse_args()
+
+if options.verbose:
+    logging.basicConfig(level=logging.DEBUG)
+else:
+    logging.basicConfig(level=logging.INFO)
+
+try:
+    encoding = getenv("LANG").split(".")[1]
+except:
+    encoding = "ascii"
+
+def prompt(prompt, secret=False):
+    if secret:
+        r = getpass(prompt)
+    else:
+        r = raw_input(prompt)
+    return unicode(r, encoding)
 
 ibid.options = {'base': '.'}
 if exists('ibid.ini'):
     ibid.config = FileConfig('ibid.ini')
     ibid.config.merge(FileConfig('local.ini'))
     sname = None
-
 else:
-    sample_config = resource_stream('ibid', 'config.ini')
+    sample_config = resource_filename('ibid', 'config.ini')
     ibid.config = FileConfig(sample_config)
 
-    botname = raw_input(u'What would you like to call your bot? ')
+    botname = prompt(u'\nWhat would you like to call your bot? ')
     ibid.config['botname'] = botname
 
-    print u'Please enter the full URL of the database to use, or just press Enter for an SQLite database.'
-    ibid.config.databases['ibid'] = raw_input(u'Database URL: ') or 'sqlite:///ibid.db'
-
-    print u"Please enter the details for the primary source. Press Enter for the default option."
+print u'Loading plugins...'
+for module in getModule('ibid.plugins').iterModules():
+    try:
+        __import__(module.name)
+    except Exception, e:
+        if options.verbose:
+            print >> stderr, u"Couldn't load %s plugin: %s" % (
+                    module.name.replace('ibid.plugins.', ''), unicode(e))
+
+if not exists('ibid.ini'):
+    print u"""
+Database configuration:
+If you want to use the default SQLite database, just press Enter.
+Otherwise please enter a SQLAlchemy database URL.
+Supported databases:
+* mysql://user:pass@host/database
+* postgres://user:pass@host/database (load the CITEXT contrib module first)
+* sqlite:///filename"""
+    ibid.config.databases['ibid'] = prompt(
+            u'Database URL [Default: sqlite:///ibid.db]: '
+        ) or 'sqlite:///ibid.db'
+
+    print u"""
+Source configuration:
+Your bot needs to connect to an IM service (in Ibid terminology, a source) like
+an IRC server or jabber account. Please enter the details for the primary
+source.
+Note: This setup script currently only supports IRC and jabber. You can set up
+other sources manually in ibid.ini.
+
+The source name should be the IRC network name or a generic description for the
+source like 'jabber'.
+"""
     source = {'nick': '$botname'}
-    sname = raw_input(u'Source name (e.g. freenode, atrum, jabber): ')
-    source['server'] = raw_input(u'Server: ')
-    port = raw_input(u'Port: ')
-    if port:
-        source['port'] = port
-    source['type'] = raw_input(u'Source type (irc or jabber): ')
+    sname = prompt(u'Source name (e.g. freenode, jabber): ')
+    source['type'] = prompt(u'Source type (irc, jabber) [Default: irc]: ')
 
-    if source['type'].lower() == 'irc':
-        source['channels'] = [c.strip() for c in raw_input(u'Default channels to join (comma separated): ').split(',')]
+    if source['type'].lower() in (u'irc', u''):
+        source['server'] = prompt(u'IRC Server: ')
+        port = prompt(u'Port [Default: 6667]: ')
+        if port:
+            source['port'] = port
+        source['channels'] = [c.strip() for c in prompt(
+            u'Channels to join (comma separated) [Default: none]: '
+        ).split(u',')]
         source['auth'] = ['hostmask', 'nickserv']
-    elif source['type'].lower() == 'jabber':
-        source['jid'] = raw_input(u'JID: ')
-        source['password'] = getpass(u'Password: ')
-        source['rooms'] = [r.strip() for r in raw_input(u'Default rooms to join (comma separated): ').split(',')]
+    elif source['type'].lower() == u'jabber':
+        source['jid'] = prompt(u'JID (Jabber address): ')
+        source['password'] = prompt(u'Password: ', secret=True)
+        source['rooms'] = [r.strip() for r in prompt(
+            u'MUC rooms to join (comma separated) [Default: none]: '
+        ).split(u',')]
         source['auth'] = ['implicit']
-        source['ssl'] = raw_input(u'SSL (Y/N): ').lower() in ('y', 'yes', 'true')
     else:
-        print 'Invalid source type'
+        print u'Invalid source type.'
         exit(1)
 
     ibid.config.sources[sname] = source
 
     ibid.config.write(open('ibid.ini', 'w'))
     if not exists('logging.ini'):
-        copyfileobj(resource_stream('ibid', 'logging.ini'), open('logging.ini', 'w'))
+        copyfileobj(resource_stream('ibid', 'logging.ini'),
+                    open('logging.ini', 'w'))
 
 db = DatabaseManager(check_schema_versions=False)
 Session = db['ibid']
 upgrade_schemas(Session)
 
-print u'Database tables created'
+print u"""Database tables created
 
-print u'Please enter the details for your account. This account will be given full admin permissions.'
-identity = unicode(raw_input('Nick/JID: '))
-source = sname or unicode(raw_input('Source name: '))
-pass1 = getpass('Password: ')
-pass2 = getpass('Confirm password: ')
+Now we need to create an account for you in the bot so it knows who its
+master is. This account will be given full admin permissions.
+Please enter the details for your account."""
+identity = prompt(u'Your IRC Nick/Jabber ID: ')
+if not identity:
+    print u'Skipping account creation'
+    exit(0)
+source = sname or prompt(u'Source name: ')
+pass1 = prompt(u'Password to identify yourself to the bot: ', secret=True)
+pass2 = prompt(u'Confirm password: ', secret=True)
 
 if pass1 != pass2:
-    print 'Password do not match'
+    print u'Password do not match'
     exit(1)
 
 session = Session()
@@ -97,7 +149,8 @@
 account.identities.append(identity)
 
 for permission in (u'accounts', u'sources', u'plugins', u'core', u'admin',
-    u'config', u'saydo', u'factoidadmin', u'karmaadmin', u'eval'):
+    u'config', u'saydo', u'factoidadmin', u'karmaadmin', u'eval',
+    u'chairmeeting'):
     perm = Permission(permission, u'auth')
     account.permissions.append(perm)
 
@@ -109,6 +162,6 @@
 session.commit()
 session.close()
 
-print 'Account created with admin permissions'
+print u'Account created with admin permissions'
 
 # vi: set et sta sw=4 ts=4: