bobry 17.10.2009 05:33

EmacsПросмотр истории в jabber.el

Как выяснилось с момента моего предыдущего поста, jabber.el грешен не только отсутствием поддержки смайликов, которых мне так не хватало, но и ужасной работой с историей, а точнее, как и в случае со смайликами, полным отсутствием средств для работы с ней. Разумеется, такая ситуация непростительна, для столь замечательного клиента, поэтому смотрим под кат и читаем что у меня получилось :)


the beginning
Итак, первое, с чего мне показалось логичным начать: проинспектировать исходники jabber.el на предмет наличия хоть каких нибудь функций со словом history в названии. Оказалось, что кое-что для работы с историей все таки имеется: интерактивная функция jabber-chat-display-more-backlog, принимающая на вход количество элементов истории, которые необходимо добавить к активному чату, и, как уже скорее всего стало понятно, добавляющая их в начало буфера. Обнаруженные недостатки:
Работает небыстро, как выяснилось, из-за того, что элемент истории сначала считывается из файла, потом преобразуется в fake xmpp message, для того чтобы потом, о ужас! опять быть разобранным в функции, выводящей сообщение на экран
Не позволяет вывести все сообщения, или сообщения за какой то период времени
Может быть использована исключительно внутри буфера с чатом, и только для контакта, к которому этот буфер привязан. (т.е. находясь в процессе разговора с товарищем Vasya@jabber.ru, посмотреть о чем мы там общались с каким нибудь товарищем под jid Vova@jabber.ru не представляется возможным)
В общем вполне очевидно, что вышеупомянутая функция скорее расстраивает, чем удовлетворяет, но просмотр ее кода, вывел меня на другую кажущуюся полезной функцию jabber-history-query, которая обращается к файлу истории для указанного jid и забирает от туда нужное количество записей, за указанный временной интервал:

 1
2
3
4
5
6
7
8
9
10
(defun jabber-history-query (start-time end-time number direction jid-regexp history-file)
"Return a list of vectors, one for each message matching the criteria.
START-TIME and END-TIME are floats as obtained from `float-time'.
Either or both may be nil, meaning no restriction.
NUMBER is the maximum number of messages to return, or t for
unlimited.
DIRECTION is either \"in\" or \"out\", or t for no limit on direction.
JID-REGEXP is a regexp which must match the JID.
HISTORY-FILE is the file in which to search.
...


На удивление, функция напрочь отказывалась работать, так как заявлено и никак не хотела принимать вместо number значение t. (т.е. не разрешала получить все доступные записи, без явного указания их количества) Посему пришлось ее слегка поправить, diff можно узреть ниже:

1
2
3
4
5
6
7
bobry@bobry> diff -iEbwB /usr/share/emacs/site-lisp/jabber-history.el ./jabber-history.el
199a200
> (when (numberp number)
201c202
< (setq lines-collected t)))))))))
---
> (setq lines-collected t))))))))))


В итоге, способ получить список всех записей истории для известного jid был найден. Оставалось только вывести его в отдельный буфер и вуаля -> profit.

jabber-log-get-buffer
Так уж сложилось в jabber.el что каждый буфер имеет свой тип: muc (multi-user chat), chat, muc private etc и для каждого типа имеется переменная с форматом имени для этого буфера. Например:

1
2
(setq jabber-muc-private-buffer-format 
"*-jmuc-priv-%g-%n-*")


Подробно останавливаться на содержании этой переменной особого смысла нет, благо describe-variable может восполнить все пробелы в течение пяти минут. Чтобы не выбиваться из используемого стандарта, я решил, что буферу с историей тоже не помешает своя переменная, а также функция, которая будет эту переменну заполнять используя переданный ей jid:

 1
2
3
4
5
6
7
8
9
10
11
(defvar jabber-log-buffer-format "*-jl-%n-*")


(defun jabber-log-get-buffer (jid)
"Returnes buffer name for a given jid."
(format-spec
jabber-log-buffer-format
(list
(cons ?n (jabber-jid-displayname jid))
(cons ?j (jabber-jid-user jid))
(cons ?r (or (jabber-jid-resource jid) "")))))


jabber-log-show
 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
(defun jabber-log-show (jid)
"Function creates a buffer, contaning history for a given jid."
(interactive
(list (jabber-read-jid-completing "Show history for:")))

(let* ((jid-regexp (concat "^" (regexp-quote (jabber-jid-user jid)) "\\(/.*\\)?$"))
(history-file (jabber-history-filename jid))
(log-entries (jabber-history-query nil nil t t jid-regexp history-file)))

(when log-entries
(with-current-buffer (get-buffer-create (jabber-log-get-buffer jid))
(make-local-variable 'jabber-buffer-connection)
;; FIXME: this won't work right, if there's more then one connection
(setq jabber-buffer-connection (car jabber-connections))
(mapcar 'jabber-log-insert-entry log-entries)
(jabber-chat-buffer-fill-long-lines)
(switch-to-buffer (current-buffer)))
)))


jabber-log-insert-entry
В процессе разбора содержания jabber-chat выяснилось что какая-то общая функция, для вывода информации в буфер отсутствует, зато имеется куча схожих по содержанию функций, делающих одно и то же. Как это не печально, пришлось изобретать свой велосипед, благо примеров в jabber-chat было более чем достаточно.

 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
(defun jabber-log-insert-entry (entry)
"Function inserts formated history entry at point."
(let* ((message-time (jabber-parse-time (aref entry 0)))
(message-body (aref entry 4))
(message-sender (aref entry 2))
(/me-p (string= message-sender "me"))
(jabber-chat-prompt-type
(if /me-p
'jabber-chat-prompt-local
'jabber-chat-prompt-foreign))
(jabber-chat-prompt-format
(if /me-p
jabber-chat-local-prompt-format
jabber-chat-foreign-prompt-format))
username, jid, resource, nickname)

(if /me-p
(let ((state-data (fsm-get-state-data jabber-buffer-connection)))
(setq
username (plist-get state-data :username)
jid (concat username (plist-get state-data :server))
resource (plist-get state-data :resource)
nickname username))
(setq
username (jabber-jid-username message-sender)
jid (jabber-jid-user message-sender)
resource (jabber-jid-resource message-sender)
nickname (jabber-jid-displayname message-sender)))

(insert
(jabber-propertize
(format-spec jabber-chat-prompt-format
(list
(cons ?t (format-time-string jabber-chat-delayed-time-format message-time))
(cons ?n nickname)
(cons ?u username)
(cons ?r resource)
(cons ?j jid)))
'face jabber-chat-prompt-type
'help-echo
(concat (format-time-string "On %Y-%m-%d %H:%M:%S" message-time) " from you"))
message-body "\n")
))


the end
На этом вроде бы и все, понятно, что написанное выше не удовлетворят практически также как и jabber-backlog-show, но зато с этим уже можно работать, дабы реализоваться все столь желанные features: постраничный просмотр, поиск, фильтрация по дате etc.

jabber-history.el | jabber-log-show.el

ЗЫ. любые замечания, дополнения, исправления привествуются!


Тэги: emacs Jabber
+ 4 -
Похожие Поделиться

ZogG 17.10.2009 05:50 #
видно упорядоченный человек написал, ты правда его используешь?
bobry 17.10.2009 06:52 #
lol, что меня выдает?
jabber.el? а как же еще? :)
bosha 17.10.2009 08:26 #
Круто.. Хоть мне и не сильно все это нужно в jabber.el, но все равно было крайне полезно.. Кстати, почему бы diff разработчикам не отправить?
dismay 18.10.2009 00:07 #
Спасибо! обязательно попробую ваше решение.
Кстате что с нотификацией входящих сообщений можете посоветовать, а то пользаю xosd как на емаксвики предложено, но больно оно не симпотичное. Было бы здорово прикрутить к dzen2
bobry 18.10.2009 00:32 #
да бросьте :)
решение то куценькое, надо думать как его ускорить, ибо с большими логами работает ну очень уж медленно. насчет OSD, мне хватает вывода через (message), но думаю к dzen тоже можно прикрутить, но вот ничего хорошего с ходу что-то не приходит