#!/usr/bin/env python
"""
find.py - Willie Spell Checking Module
Copyright 2011, Michael Yanovich, yanovich.net
Licensed under the Eiffel Forum License 2.

http://willie.dftba.net

Contributions from: Matt Meinwald and Morgan Goose
This module will fix spelling errors if someone corrects them
using the sed notation (s///) commonly found in vi/vim.
"""

import os, re
import cPickle

def give_me_unicode(obj, encoding="utf-8"):
    if isinstance(obj, basestring):
        if not isinstance(obj, unicode):
            obj = unicode(obj, encoding)
    return obj

def load_db(db_file):
    """ load lines from db_file to search_dict """
    if not os.path.isfile(db_file):
        return {}
    search_file = open(db_file, "r")
    search_dict = cPickle.load(search_file)
    search_file.close()
    return search_dict


def save_db(search_dict, db_file):
    """ save search_dict to db_file """
    search_file = open(db_file, "w")
    cPickle.dump(search_dict, search_file)
    search_file.close()

# Create a temporary log of the most recent thing anyone says.
def collectlines(willie, trigger):
    # don't log things in PM
    channel = (trigger.sender).encode("utf-8")
    nick = (trigger.nick).encode("utf-8")
    if not channel.startswith('#'): return
    db_file = os.path.join(willie.config.dotdir, 'find.pickle')
    search_dict = load_db(db_file)
    if channel not in search_dict:
        search_dict[channel] = dict()
    if nick not in search_dict[channel]:
        search_dict[channel][nick] = list()
    templist = search_dict[channel][nick]
    line = trigger.group()
    if line.startswith("s/"):
        return
    elif line.startswith("\x01ACTION"):
        line = line[:-1]
        templist.append(line)
    else:
        templist.append(line)
    del templist[:-10]
    search_dict[channel][nick] = templist
    save_db(search_dict, db_file)
    del search_dict
collectlines.rule = r'.*'
collectlines.priority = 'low'

def findandreplace(willie, trigger):
    # don't bother in PM
    db_file = os.path.join(willie.config.dotdir, 'find.pickle')
    channel = (trigger.sender).encode("utf-8")
    nick = (trigger.nick).encode("utf-8")

    if not channel.startswith('#'): return

    search_dict = load_db(db_file)

    rnick = trigger.group(1) or nick # Correcting other person vs self.

    # only do something if there is conversation to work with
    if channel not in search_dict or rnick not in search_dict[channel]: return

    sep = trigger.group(2)
    rest = trigger.group(3).split(sep)
    me = False # /me command
    flags = ''
    if len(rest) < 2:
        return # need at least a find and replacement value
    elif len(rest) > 2:
        # Word characters immediately after the second separator
        # are considered flags (only g and i now have meaning)
        flags = re.match(r'\w*',rest[2], re.U).group(0)
    #else (len == 2) do nothing special

    count = 'g' in flags and -1 or 1 # Replace unlimited times if /g, else once
    if 'i' in flags:
        regex = re.compile(re.escape(rest[0]),re.U|re.I)
        repl = lambda s: re.sub(regex,rest[1],s,count == 1)
    else:
        repl = lambda s: s.replace(rest[0],rest[1],count)

    for line in reversed(search_dict[channel][rnick]):
        if line.startswith("\x01ACTION"):
            me = True # /me command
            line = line[8:]
        else:
            me = False
        new_phrase = repl(line)
        if new_phrase != line: # we are done
            break

    if not new_phrase or new_phrase == line: return # Didn't find anything

    # Save the new "edited" message.
    templist = search_dict[channel][rnick]
    templist.append((me and '\x01ACTION ' or '') + new_phrase)
    search_dict[channel][rnick] = templist
    save_db(search_dict, db_file)
    del search_dict

    # output
    phrase = nick + (trigger.group(1) and ' thinks ' + rnick or '') + (me and ' ' or " \x02meant\x02 to say: ") + new_phrase
    if me and not trigger.group(1): phrase = '\x02' + phrase + '\x02'
    willie.say(phrase)

# Matches optional whitespace + 's' + optional whitespace + separator character
findandreplace.rule = r'(?u)(?:([^\s:]+)[\s:])?\s*s\s*([^\s\w])(.*)' # May work for both this and "meant" (requires trigger.group(i+1))
findandreplace.priority = 'high'


if __name__ == '__main__':
    print __doc__.strip()