JID 一律使用小写形式存储
[gaetalk.git] / lilytalk.py
blob84131ead5cb9c59c66ba68c537317f69ec3447df
1 #!/usr/bin/env python2
2 # vim:fileencoding=utf-8
4 import re
5 import logging
6 import datetime
8 from google.appengine.ext import db
9 from google.appengine.api import xmpp
11 import utils
12 import config
14 notice = u'这是一个测试群'
15 helpre = re.compile(r'^\W{0,2}help$')
17 #用户所有资源离线时,会加上“完全”二字
18 OFFLINE = u'离线'
19 AWAY = u'离开'
20 XAWAY = u'离开'
21 BUSY = u'忙碌'
22 ONLINE = u'在线'
23 CHAT = u'和我说话吧'
25 NEW = u'加入'
26 LEAVE = u'退出'
27 NICK = u'昵称更改 (%s -> %s)'
28 SNOOZE = u'snooze %ds'
29 BLACK = u'禁言 %s %ds'
30 BLACK_AUTO = u'被禁言 %ds'
31 KICK = u'删除 %s (%s)'
32 ADMIN = u'%s 成为管理员 (by %s)'
33 UNADMIN = u'%s 不再是管理员 (by %s)'
35 STATUS_CODE = {
36 '': ONLINE,
37 'away': AWAY,
38 'dnd': BUSY,
39 'xa': XAWAY,
40 'chat': CHAT,
43 #状态的排序顺序
44 STATUS_LIST = [CHAT, ONLINE, AWAY, XAWAY, BUSY, OFFLINE]
46 timezone = datetime.timedelta(hours=config.timezoneoffset)
48 class User(db.Model):
49 jid = db.StringProperty(required=True, indexed=True)
50 nick = db.StringProperty(required=True, indexed=True)
52 add_date = db.DateTimeProperty(auto_now_add=True)
53 last_online_date = db.DateTimeProperty()
54 last_offline_date = db.DateTimeProperty()
55 last_speak_date = db.DateTimeProperty()
57 msg_count = db.IntegerProperty(required=True, default=0)
58 msg_chars = db.IntegerProperty(required=True, default=0)
59 credit = db.IntegerProperty(required=True, default=0)
61 black_before = db.DateTimeProperty(auto_now_add=True)
62 snooze_before = db.DateTimeProperty()
63 flooding_point = db.IntegerProperty(default=0)
65 avail = db.StringProperty(required=True)
66 is_admin = db.BooleanProperty(required=True, default=False)
67 resources = db.StringListProperty(required=True)
68 #允许他人私信?
69 reject_pm = db.BooleanProperty(default=False)
71 prefix = db.StringProperty(required=True, default=config.default_prefix)
72 nick_pattern = db.StringProperty(required=True, default='[%s]')
73 nick_changed = db.BooleanProperty(required=True, default=False)
74 intro = db.StringProperty()
76 class Log(db.Model):
77 time = db.DateTimeProperty(auto_now_add=True, indexed=True)
78 msg = db.StringProperty(required=True, multiline=True)
79 jid = db.StringProperty()
80 nick = db.StringProperty()
81 type = db.StringProperty(required=True, indexed=True,
82 choices=set(['chat', 'member', 'misc']))
84 def log_msg(sender, msg):
85 l = Log(jid=sender.jid, nick=sender.nick,
86 type='chat', msg=msg)
87 l.put()
89 def log_onoff(sender, action, resource=''):
90 if resource:
91 if action == OFFLINE and not sender.resources:
92 msg = u'完全%s (%s)' % (action, resource)
93 else:
94 msg = '%s (%s)' % (action, resource)
95 else:
96 msg = action
97 l = Log(jid=sender.jid, nick=sender.nick,
98 type='member', msg=msg)
99 l.put()
101 def get_user_by_jid(jid):
102 return User.gql('where jid = :1', jid.lower()).get()
104 def get_user_by_nick(nick):
105 return User.gql('where nick = :1', nick).get()
107 def get_member_list():
108 r = []
109 now = datetime.datetime.now()
110 #一个查询中最多只能有一个不等比较
111 l = User.gql('where avail != :1', OFFLINE)
112 for u in l:
113 r.append(u)
114 return [unicode(x.jid) for x in r \
115 if x.snooze_before is None or x.snooze_before < now]
117 def send_to_all_except(jid, message):
118 if isinstance(jid, str):
119 jids = [x for x in get_member_list() if x != jid]
120 else:
121 jids = [x for x in get_member_list() if x not in jid]
122 logging.debug(jid)
123 logging.debug(jids)
124 try:
125 xmpp.send_message(jids, message)
126 except xmpp.InvalidJidError:
127 pass
129 def send_to_all(message):
130 jids = get_member_list()
131 xmpp.send_message(jids, message)
133 def handle_message(msg):
134 sender = get_user_by_jid(msg.sender.split('/')[0])
135 if sender is None:
136 msg.reply('很抱歉,出错了,请重新添加好友。')
137 return
138 if msg.body.startswith('?OTR:'):
139 msg.reply('不支持 OTR 加密!')
140 return
141 if len(msg.body) > 500:
142 msg.reply('由于技术限制,每条消息最长为 500 字。大段文本请贴 paste 网站。')
143 return
144 if sender.is_admin or sender.jid == config.root:
145 ch = AdminCommand(msg, sender)
146 else:
147 ch = BasicCommand(msg, sender)
148 if not ch.handled:
149 now = datetime.datetime.now()
150 if sender.black_before is not None \
151 and sender.black_before > now:
152 if (datetime.datetime.today()+timezone).date() == \
153 (sender.black_before+timezone).date():
154 format = '%H时%M分%S秒'
155 else:
156 format = '%m月%d日 %H时%M分%S秒'
157 msg.reply('你已被禁言至 ' \
158 + (sender.black_before+timezone).strftime(format))
159 return
161 if sender.last_speak_date is not None:
162 d = now - sender.last_speak_date
163 t = d.seconds
164 if d.days > 0 or t > 60:
165 sender.flooding_point = 0
166 else:
167 k = 1000 / (t * t + 1)
168 if k > 0:
169 sender.flooding_point += k
170 else:
171 sender.flooding_point = 0
173 k = sender.flooding_point / 1500
174 if k > 0:
175 msg.reply('刷屏啊?禁言 %d 分钟!' % k)
176 send_to_all_except(sender.jid,
177 (u'%s 已因刷屏而被禁言 %d 分钟。' % (sender.nick, k)) \
178 .encode('utf-8'))
179 log_onoff(sender, BLACK_AUTO % (60 * k))
180 sender.black_before = now + datetime.timedelta(seconds=60*k)
181 sender.put()
182 return
184 sender.last_speak_date = now
185 sender.snooze_before = None
186 try:
187 sender.msg_count += 1
188 sender.msg_chars += len(msg.body)
189 except TypeError:
190 sender.msg_count = 1
191 sender.msg_chars = len(msg.body)
192 sender.put()
193 body = utils.removelinks(msg.body)
194 for u in User.gql('where avail != :1', OFFLINE):
195 if u.snooze_before is not None and u.snooze_before >= now:
196 continue
197 if u.jid == sender.jid:
198 continue
199 try:
200 message = '%s %s' % (
201 u.nick_pattern % sender.nick,
202 body
204 xmpp.send_message(u.jid, message)
205 except xmpp.InvalidJidError:
206 pass
207 log_msg(sender, msg.body)
209 def try_add_user(jid, show=OFFLINE, resource=''):
210 '''使用 memcache 作为锁添加用户'''
211 L = utils.MemLock('add_user')
212 L.require()
213 try:
214 u = get_user_by_jid(jid)
215 if u is not None:
216 return
217 u = add_user(jid, show, resource)
218 finally:
219 L.release()
220 if show != OFFLINE:
221 log_onoff(u, show, resource)
222 logging.info(u'%s added', jid)
224 def add_user(jid, show=OFFLINE, resource=''):
225 '''resource 在 presence type 为 available 里使用'''
226 nick = jid.split('@')[0]
227 old = User.gql('where nick = :1', nick).get()
228 while old:
229 nick += '_'
230 old = User.gql('where nick = :1', nick).get()
231 u = User(jid=jid.lower(), avail=show, nick=nick)
232 if show != OFFLINE:
233 u.last_online_date = datetime.datetime.now()
234 if resource:
235 u.resources.append(resource)
236 u.put()
237 log_onoff(u, NEW)
238 logging.info(u'%s 已经加入' % jid)
239 send_to_all_except(jid, u'%s 已经加入' % u.nick)
240 xmpp.send_presence(jid, status=notice)
241 xmpp.send_message(jid, u'欢迎 %s 加入!获取使用帮助,请输入 %shelp' % (
242 u.nick, u.prefix))
243 return u
245 class BasicCommand:
246 handled = True
247 def __init__(self, msg, sender):
248 self.sender = sender
249 self.msg = msg
251 if helpre.match(msg.body):
252 self.do_help()
253 elif msg.body.startswith(sender.prefix):
254 cmd = msg.body[len(sender.prefix):].split()
255 try:
256 handle = getattr(self, 'do_' + cmd[0])
257 except AttributeError:
258 msg.reply(u'错误:未知命令 %s' % cmd[0])
259 except IndexError:
260 msg.reply(u'错误:无命令')
261 except UnicodeEncodeError:
262 msg.reply(u'错误:命令名解码失败。此问题在 GAE 升级其 Python 到 3.x 后方能解决。')
263 else:
264 handle(cmd[1:])
265 logging.debug('%s did command %s' % (sender.jid, cmd[0]))
266 else:
267 self.handled = False
269 def do_online(self, args):
270 '''显示在线成员列表'''
271 r = []
272 now = datetime.datetime.now()
273 l = User.gql('where avail != :1', OFFLINE)
274 for u in l:
275 m = u.nick
276 status = u.avail
277 if status != u'在线':
278 m += u' (%s)' % status
279 if u.snooze_before is not None and u.snooze_before > now:
280 m += u' (snoozing)'
281 if u.black_before is not None and u.black_before > now:
282 m += u' (已禁言)'
283 r.append(unicode('* ' + m))
284 r.sort()
285 n = len(r)
286 r.insert(0, u'在线成员列表:')
287 r.append(u'共 %d 人在线。' % n)
288 self.msg.reply(u'\n'.join(r).encode('utf-8'))
290 def do_chatty(self, args):
291 '''显示成员发送的消息数量'''
292 r = []
293 for u in User.gql('ORDER BY msg_chars ASC'):
294 m = u.nick
295 m = u'* %s:\t%5d条,共 %s' % (
296 u.nick, u.msg_count,
297 utils.filesize(u.msg_chars))
298 r.append(m)
299 n = len(r)
300 r.insert(0, u'消息数量排行:')
301 r.append(u'共 %d 人。' % n)
302 self.msg.reply(u'\n'.join(r).encode('utf-8'))
304 def do_nick(self, args):
305 '''更改昵称,需要一个参数'''
306 if len(args) != 1:
307 self.msg.reply('错误:请给出你想到的昵称(不能包含空格)')
308 return
310 q = User.gql('where nick = :1', args[0]).get()
311 if q is not None:
312 self.msg.reply('错误:该昵称已被使用,请使用其它昵称')
313 elif not utils.checkNick(args[0]):
314 self.msg.reply('错误:非法的昵称')
315 else:
316 if not config.nick_can_change and self.sender.nick_changed:
317 self.msg.reply('乖哦,你已经没机会再改昵称了')
318 return
319 old_nick = self.sender.nick
320 log_onoff(self.sender, NICK % (old_nick, args[0]))
321 self.sender.nick = args[0]
322 self.sender.nick_changed = True
323 self.sender.put()
324 send_to_all_except(self.sender.jid,
325 (u'%s 的昵称改成了 %s' % (old_nick, args[0])).encode('utf-8'))
326 self.msg.reply('昵称更改成功!')
327 do_nick.__doc__ += ',最长 %d 字节' % config.nick_maxlen
329 def do_help(self, args=None):
330 '''显示本帮助'''
331 doc = []
332 prefix = self.sender.prefix
333 for c, f in self.__class__.__dict__.items():
334 if c.startswith('do_'):
335 doc.append(u'%s%s:\t%s' % (prefix, c[3:], f.__doc__.decode('utf-8')))
336 for b in self.__class__.__bases__:
337 for c, f in b.__dict__.items():
338 if c.startswith('do_'):
339 doc.append(u'%s%s:\t%s' % (prefix, c[3:], f.__doc__.decode('utf-8')))
340 doc.sort()
341 doc.insert(0, u'命令指南 (当前命令前缀 %s,可设置)' % prefix)
342 doc.append(u'要离开,直接删掉好友即可。')
343 self.msg.reply(u'\n'.join(doc).encode('utf-8'))
345 def do_iam(self, args):
346 '''查看自己的信息'''
347 s = self.sender
348 r = u'昵称:\t\t%s\n消息数:\t\t%d\n消息总量:\t%s\n命令前缀:\t%s\n自我介绍:\t%s' % (
349 s.nick, s.msg_count, utils.filesize(s.msg_chars), s.prefix, s.intro)
350 self.msg.reply(r.encode('utf-8'))
352 def do_m(self, args):
353 '''给某人发私信,需要昵称和内容两个参数。私信不会以任何方式被记录。'''
354 if len(args) < 2:
355 self.msg.reply('请给出昵称和内容。')
356 return
358 target = get_user_by_nick(args[0])
359 if target is None:
360 self.msg.reply('Sorry,查无此人。')
361 return
363 if target.reject_pm:
364 self.msg.reply('很抱歉,对方不授受私信。')
365 return
367 msg = self.msg.body[len(self.sender.prefix):].split(None, 2)[-1]
368 msg = u'_私信_ %s %s' % (target.nick_pattern % self.sender.nick, msg)
369 if xmpp.send_message(target.jid, msg) == xmpp.NO_ERROR:
370 self.msg.reply(u'OK')
371 else:
372 self.msg.reply(u'消息发送失败')
374 def do_snooze(self, args):
375 '''暂停接收消息,参数为时间(默认单位为秒)。再次发送消息时自动清除'''
376 if len(args) != 1:
377 self.msg.reply('你想停止接收消息多久?')
378 return
379 else:
380 try:
381 n = utils.parseTime(args[0])
382 except ValueError:
383 self.msg.reply('Sorry,我无法理解你说的时间。')
384 return
386 try:
387 self.sender.snooze_before = datetime.datetime.now() + datetime.timedelta(seconds=n)
388 except OverflowError:
389 self.msg.reply('Sorry,你不能睡太久。')
390 return
391 self.sender.put()
392 if n == 0:
393 self.msg.reply('你已经醒来。')
394 else:
395 self.msg.reply('OK,停止接收消息 %d 秒。' % n)
396 log_onoff(self.sender, SNOOZE % n)
398 def do_offline(self, args):
399 '''让程序认为你的所有资源已离线。如在你离线时程序仍认为你在线,请使用此命令。'''
400 del self.sender.resources[:]
401 self.sender.avail = OFFLINE
402 self.sender.last_offline_date = datetime.datetime.now()
403 self.sender.put()
404 self.msg.reply('OK,在下次你说你在线之前我都认为你已离线。')
406 def do_old(self, args):
407 '''查询聊天记录,可选一个数字参数。默认为最后20条。特殊参数 OFFLINE 显示离线消息(最多 100 条)'''
408 s = self.sender
409 q = False
410 if not args:
411 q = Log.gql("WHERE type = 'chat' ORDER BY time DESC LIMIT 20")
412 elif len(args) == 1:
413 try:
414 n = int(args[0])
415 if n > 0:
416 q = Log.gql("WHERE type = 'chat' ORDER BY time DESC LIMIT %d" % n)
417 except ValueError:
418 if args[0].upper() == 'OFFLINE':
419 q = Log.gql("WHERE time < :1 AND time > :2 AND type = 'chat' ORDER BY time DESC LIMIT 100", s.last_online_date, s.last_offline_date)
420 else:
421 pass
422 if q is not False:
423 r = []
424 q = list(q)
425 q.reverse()
426 if q:
427 if datetime.datetime.today() - q[0].time > datetime.timedelta(hours=24):
428 show_date = True
429 else:
430 show_date = False
431 for l in q:
432 message = '%s %s %s' % (
433 utils.strftime(l.time, timezone, show_date),
434 s.nick_pattern % l.nick,
435 l.msg
437 r.append(message)
438 if r:
439 self.msg.reply(u'\n'.join(r).encode('utf-8'))
440 else:
441 self.msg.reply('没有符合的聊天记录。')
442 else:
443 self.msg.reply('Oops, 参数不正确哦。')
445 def do_set(self, args):
446 '''设置一些参数。参数格式 key=value;不带参数以查看说明。'''
447 #注意:选项名/值中不能包含空格
448 if len(args) != 1:
449 doc = []
450 for c, f in self.__class__.__dict__.items():
451 if c.startswith('set_'):
452 doc.append(u'* %s:\t%s' % (c[4:], f.__doc__.decode('utf-8')))
453 for b in self.__class__.__bases__:
454 for c, f in b.__dict__.items():
455 if c.startswith('set_'):
456 doc.append(u'* %s:\t%s' % (c[4:], f.__doc__.decode('utf-8')))
457 doc.sort()
458 doc.insert(0, u'设置选项:')
459 self.msg.reply(u'\n'.join(doc).encode('utf-8'))
460 else:
461 msg = self.msg
462 cmd = msg.body.split(None, 1)[1].split('=', 1)
463 if len(cmd) == 1:
464 msg.reply(u'错误:请给出选项值')
465 return
466 try:
467 handle = getattr(self, 'set_' + cmd[0])
468 except AttributeError:
469 msg.reply(u'错误:未知选项 %s' % cmd[0])
470 except IndexError:
471 msg.reply(u'错误:无选项')
472 except UnicodeEncodeError:
473 msg.reply(u'错误:选项名解码失败。此问题在 GAE 升级其 Python 到 3.x 后方能解决。')
474 else:
475 handle(cmd[1])
477 def set_prefix(self, arg):
478 '''设置命令前缀'''
479 self.sender.prefix = arg
480 self.sender.put()
481 self.msg.reply(u'设置成功!')
483 def set_nickpattern(self, arg):
484 '''设置昵称显示格式,用 %s 表示昵称的位置'''
485 try:
486 arg % 'test'
487 except (TypeError, ValueError):
488 self.msg.reply(u'错误:不正确的格式')
489 return
491 self.sender.nick_pattern = arg
492 self.sender.put()
493 self.msg.reply(u'设置成功!')
495 def set_allowpm(self, arg):
496 '''设置是否接受私信,参数为 y (接受)或者 n (拒绝)'''
497 if arg not in 'yn':
498 self.msg.reply(u'错误的参数。')
499 return
501 if arg == 'y':
502 self.sender.reject_pm = False
503 else:
504 self.sender.reject_pm = True
505 self.sender.put()
506 self.msg.reply(u'设置成功!')
508 class AdminCommand(BasicCommand):
509 def do_kick(self, args):
510 '''删除某人。他仍可以重新加入。'''
511 if len(args) != 1:
512 self.msg.reply('请给出昵称。')
513 return
515 target = get_user_by_nick(args[0])
516 if target is None:
517 self.msg.reply('Sorry,查无此人。')
518 return
520 if target.jid == config.root:
521 self.msg.reply('不能删除 root 用户')
522 return
524 targetjid = target.jid
525 targetnick = target.nick
526 target.delete()
527 self.msg.reply((u'OK,删除 %s。' % target.nick).encode('utf-8'))
528 send_to_all_except(self.sender.jid, (u'%s 已被删除。' % self.sender.nick) \
529 .encode('utf-8'))
530 xmpp.send_message(targetjid, u'你已被管理员从此群中删除,请删除该好友。')
531 log_onoff(self.sender, KICK % (targetnick, targetjid))
533 def do_quiet(self, args):
534 '''禁言某人,参数为昵称和时间(默认单位秒)'''
535 if len(args) != 2:
536 self.msg.reply('请给出昵称和时间。')
537 return
538 else:
539 try:
540 n = utils.parseTime(args[1])
541 except ValueError:
542 self.msg.reply('Sorry,我无法理解你说的时间。')
543 return
545 target = get_user_by_nick(args[0])
546 if target is None:
547 self.msg.reply('Sorry,查无此人。')
548 return
550 target.black_before = datetime.datetime.now() + datetime.timedelta(seconds=n)
551 target.put()
552 self.msg.reply((u'OK,禁言 %s %d 秒。' % (target.nick, n)).encode('utf-8'))
553 send_to_all_except((self.sender.jid, target.jid),
554 (u'%s 已被禁言 %s 秒。' % (self.sender.nick, n)) \
555 .encode('utf-8'))
556 xmpp.send_message(target.jid, u'你已被管理员禁言 %d 秒。' % n)
557 log_onoff(self.sender, BLACK % (target.nick, n))
559 def do_admin(self, args):
560 '''将某人添加为管理员'''
561 if len(args) != 1:
562 self.msg.reply(u'请给出昵称。')
563 return
565 target = get_user_by_nick(args[0])
566 if target is None:
567 self.msg.reply(u'Sorry,查无此人。')
568 return
570 if target.is_admin:
571 self.msg.reply(u'%s 已经是管理员了。' % target.nick)
572 return
574 target.is_admin = True
575 target.put()
576 send_to_all_except(target.jid,
577 (u'%s 已成为管理员。' % target.nick) \
578 .encode('utf-8'))
579 xmpp.send_message(target.jid, u'你已是本群管理员。')
580 log_onoff(self.sender, ADMIN % (target.nick, self.sender.nick))
582 def do_unadmin(self, args):
583 '''取消某人管理员的权限'''
584 if len(args) != 1:
585 self.msg.reply(u'请给出昵称。')
586 return
588 target = get_user_by_nick(args[0])
589 if target is None:
590 self.msg.reply(u'Sorry,查无此人。')
591 return
593 if not target.is_admin:
594 self.msg.reply(u'%s 不是管理员。' % target.nick)
595 return
597 target.is_admin = False
598 target.put()
599 send_to_all_except(target.jid,
600 (u'%s 已不再是管理员。' % target.nick) \
601 .encode('utf-8'))
602 xmpp.send_message(target.jid, u'你已不再是本群管理员。')
603 log_onoff(self.sender, UNADMIN % (target.nick, self.sender.nick))