pubsub.py 16.1 KB
Newer Older
louiz’'s avatar
louiz’ committed
1
# Copyright 2010-2011 Florent Le Coz <louiz@louiz.org>
2 3 4 5
#
# This file is part of Poezio.
#
# Poezio is free software: you can redistribute it and/or modify
6
# it under the terms of the zlib license. See the COPYING file.
7 8 9 10

import logging
log = logging.getLogger(__name__)

11
import os
12
import curses
13 14
import tempfile
import subprocess
15 16

import tabs
17 18
import windows
import atom_parser
19

20 21 22
from config import config

from datetime import datetime
mathieui's avatar
mathieui committed
23
from sleekxmpp.xmlstream import ET
24

25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
ATOM_XMLNS = "http://www.w3.org/2005/Atom"

item_template = \
"""
-- About you
-- Your name
Author: %(author)s

-- Your jid (e.g. xmpp:romeo@example.com) or website’s url (http://example.com)
URI: xmpp:%(jid)s

-- Your email address (e.g. romeo@mail.com)
email: 
Title: 

-- Please use the form dd/mm/yyy hh:mm:ss, or leave empty
-- If you leave the date empty it will automatically be filled with the current time and date (recommended)
Date: 

--- body --- Until the end of file, this will be your item's body

"""

def parse_template(lines):
    """
    takes a template string (splitted by lines) and returns a dict with the correstponding values
    """
    lines = [line.lower() for line in lines]
    res = {}
    reading_body = False
    body = []
    for line in lines:
        if line.startswith('--- body ---'):
            reading_body = True
            continue
        if reading_body:
            body.append(line)
            continue
        if line.startswith('-- '):
            continue
        for value in ('author', 'uri', 'email', 'title', 'date'):
            if line.startswith('%s:' % (value,)):
                res[value] = line.split(':', 1)[1].strip()
    res['body'] = ''.join(body)
    return res

def create_entry_from_dict(dic):
    """
    Takes a dict with the correct values and returns an ET.Element
    representing an Atom entry
    """
    entry_elem = ET.Element('entry', xmlns=ATOM_XMLNS)

    author_elem = ET.Element('author', xmlns=ATOM_XMLNS)
    if dic.get('author'):
        name_elem = ET.Element('name', xmlns=ATOM_XMLNS)
        name_elem.text = dic.get('author')
        author_elem.append(name_elem)
    if dic.get('uri'):
        uri_elem = ET.Element('uri', xmlns=ATOM_XMLNS)
        uri_elem.text = dic.get('uri')
        author_elem.append(uri_elem)
    if dic.get('email'):
        email_elem = ET.Element('email', xmlns=ATOM_XMLNS)
        email_elem.text = dic.get('email')
        author_elem.append(email_elem)
    entry_elem.append(author_elem)
    if dic.get('title'):
        title_elem = ET.Element('title', xmlns=ATOM_XMLNS)
        title_elem.text = dic.get('title')
        entry_elem.append(title_elem)
    # TODO
    # if dic.get('date'):
    date_elem =  ET.Element('published', xmlns=ATOM_XMLNS)
    date_elem.text = '%s' % datetime.now()
    entry_elem.append(date_elem)
    summary_elem = ET.Element('summary', xmlns=ATOM_XMLNS)
    summary_elem.text = dic.get('body') or ''
    entry_elem.append(summary_elem)
    return entry_elem

106 107
class PubsubNode(object):
    node_type = None            # unknown yet
108
    def __init__(self, name, parent=None):
109 110
        self.items = []
        self.name = name
111
        self.parent = parent
112 113 114 115


class LeafNode(PubsubNode):
    node_type = "leaf"
116 117
    def __init__(self, name, parent=None):
        PubsubNode.__init__(self, name, parent)
118 119 120 121


class CollectionNode(PubsubNode):
    node_type = "collection"
122 123
    def __init__(self, name, parent=None):
        PubsubNode.__init__(self, name, parent)
124 125 126 127 128
        self.subnodes = []


class PubsubItem(object):
    def __init__(self, idd, content):
129
        self.id = idd
130
        self.content = content
131
        self.parsed_content = atom_parser.parse_atom_entry(content)
132

133 134 135 136 137 138 139
    def to_dict(self, columns):
        """
        returns a dict of the values listed in columns
        """
        ret = {}
        for col in columns:
            ret[col] = self.__dict__.get(col) or ''
140 141 142
        if self.parsed_content:
            ret['title'] = self.parsed_content.get('title')
            ret['author'] = self.parsed_content['author'].get('name')
143
        return ret
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161

class PubsubBrowserTab(tabs.Tab):
    """
    A tab containing a pubsub browser letting the user
    list nodes and items, view, add and delete items, etc
    """
    def __init__(self, server):
        """
        Server is the name of the pubsub server, for example:
        pubsub.example.com
        All action done in this tab will be made on that server.
        """
        tabs.Tab.__init__(self)
        self.current_node = None # the subnode we are listing. None means the root
        self.server = server
        self.nodes = []         # the lower level of nodes

        self.upper_message = windows.Topic()
162
        self.set_info_message('Loading')
163 164 165 166 167 168 169

        # Node List View
        node_columns = ('node', 'name',)
        self.node_list_header = windows.ColumnHeaderWin(node_columns)
        self.node_listview = windows.ListWin(node_columns)

        # Item List View
170
        item_columns = ('title', 'author', 'id')
171 172 173
        self.item_list_header = windows.ColumnHeaderWin(item_columns)
        self.item_listview = windows.ListWin(item_columns)

174 175 176
        # Vertical Separator
        self.vertical_separator = windows.VerticalSeparator()

177 178
        # Item viewer
        self.item_viewer = windows.SimpleTextWin('')
179 180 181 182
        self.default_help_message = windows.HelpText("“c”: create a node.")
        self.input = self.default_help_message

        self.key_func['c'] = self.command_create_node
183
        self.key_func['p'] = self.command_publish_item
184 185
        self.key_func["M-KEY_DOWN"] = self.scroll_node_down
        self.key_func["M-KEY_UP"] = self.scroll_node_up
186 187
        self.key_func["KEY_DOWN"] = self.item_listview.move_cursor_down
        self.key_func["KEY_UP"] = self.item_listview.move_cursor_up
188
        self.key_func["^M"] = self.open_selected_item
189 190 191 192
        self.resize()

        self.get_nodes()

193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
    def command_publish_item(self):
        self.core.background = True
        editor = config.get('editor', '') or os.getenv('EDITOR') or 'vi'
        log.debug('Starting item edition with command %s' % editor)
        tmpfile = tempfile.NamedTemporaryFile(mode='r+')
        tmpfile.write(item_template % {'author': self.core.xmpp.boundjid.user, 'jid': self.core.xmpp.boundjid.bare})
        tmpfile.flush()
        process = subprocess.call(editor.split() + [tmpfile.name])
        tmpfile.flush()
        tmpfile.seek(0)
        item_dict = parse_template(tmpfile.readlines())
        tmpfile.close()
        log.debug('[%s]' % item_dict)

        self.core.background = False
        self.core.full_screen_redraw()
        entry = create_entry_from_dict(item_dict)
        self.publish_item(entry, self.get_selected_node_name())

    def publish_item(self, content, node_name):
        """
        publish the given item on the given node
        """
        def callback(res):
            if res:
                self.set_info_message('Item published')
            else:
                self.set_info_message('Item not published')
            self.force_refresh()

        self.core.xmpp.plugin['xep_0060'].setItem(self.server, node_name, content, callback=callback)

225 226 227 228 229 230
    def set_info_message(self, message):
        """
        Set an informative message in the upper line, near the server name
        """
        self.upper_message.set_message('Pubsub server: %s/%s [%s]' % (self.server, self.current_node or '', message))

231 232 233 234 235 236 237 238 239 240 241
    def resize(self):
        self.upper_message.resize(1, self.width, 0, 0)
        self.tab_win.resize(1, self.width, self.height-2, 0)

        column_size = {'node': self.width//4,
                       'name': self.width//4,}
        self.node_list_header.resize_columns(column_size)
        self.node_list_header.resize(1, self.width//2, 1, 0)
        self.node_listview.resize_columns(column_size)
        self.node_listview.resize(self.height//2-2, self.width//2, 2, 0)

242 243 244 245
        w = self.width//2
        column_size = {'id': w//8,
                       'title':w//8*5,
                       'author':w//8*2}
246 247 248
        self.item_list_header.resize_columns(column_size)
        self.item_list_header.resize(self.height//2+1, self.width//2, self.height//2, 0)
        self.item_listview.resize_columns(column_size)
249
        self.item_listview.resize(self.height//2-3, self.width//2, self.height//2+1, 0)
250

251 252 253
        self.vertical_separator.resize(self.height-3, 1, 1, self.width//2)

        self.item_viewer.resize(self.height-3, self.width//2+1, 1, self.width//2+1)
254 255 256 257 258 259 260 261 262 263 264
        self.input.resize(1, self.width, self.height-1, 0)

    def refresh(self):
        if self.need_resize:
            self.resize()
        log.debug('  TAB   Refresh: %s'%self.__class__.__name__)
        self.upper_message.refresh()
        self.node_list_header.refresh()
        self.node_listview.refresh()
        self.item_list_header.refresh()
        self.item_listview.refresh()
265
        self.item_viewer.refresh()
266
        self.tab_win.refresh()
267
        self.vertical_separator.refresh()
268 269
        self.input.refresh()

270 271 272 273
    def force_refresh(self):
        if self.core.current_tab() is self:
            self.core.refresh_window()

274 275 276 277 278 279 280 281 282 283
    def get_name(self):
        return '%s@@pubsubbrowser' % (self.server,)

    def on_input(self, key):
        res = self.input.do_command(key)
        if res:
            return True
        if key in self.key_func:
            return self.key_func[key]()

284 285 286 287 288 289 290 291 292 293 294 295
    def get_selected_node_name(self):
        """
        From the node_view_list, returns the node name of the selected
        one. None can be returned
        """
        line = self.node_listview.get_selected_row()
        if not line:
            return None
        return line['node']

    def get_node_by_name(self, name):
        """
296
        in the currently browsed node (or on the root), return the node with that name
297 298 299 300 301 302 303
        """
        nodes = self.current_node and self.current_node.subnodes or self.nodes
        for node in nodes:
            if node.name == name:
                return node
        return None

304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
    def get_item_by_id(self, idd):
        """
        in the currently selected node, return the item with that id
        """
        selected_node_name = self.get_selected_node_name()
        if not selected_node_name:
            return None
        selected_node = self.get_node_by_name(selected_node_name)
        if not selected_node:
            return None
        for item in selected_node.items:
            if item.id == idd:
                return item
        return None

    def get_selected_item_id(self):
        """
        returns the id of the currently selected item
        """
        line = self.item_listview.get_selected_row()
        if not line:
            return None
        return line['id']

328 329 330 331
    def get_items(self, node):
        """
        Get all items in the given node
        """
332 333 334 335 336 337 338 339 340 341 342 343 344 345
        def callback(items):
            item_list = []
            if items:
                for it in items:
                    item_list.append(PubsubItem(it.attrib['id'], it))
                node.items = item_list
                log.debug('get_selected_node_name: %s' % self.get_selected_node_name())
                if self.get_selected_node_name() == node.name:
                    self.display_items_from_node(node)
            log.debug('Item on node %s: %s' % (node.name, item_list))
            self.set_info_message('Items received')
            self.force_refresh()

        self.core.xmpp.plugin['xep_0060'].get_items(self.server, node.name, callback=callback)
346

347 348 349 350 351 352
    def display_items_from_node(self, node):
        """
        takes a node, and set fill the item_listview with that
        node’s items
        """
        columns = self.item_list_header.get_columns()
353
        self.item_listview.empty()
354 355
        log.debug('display_items_from_node: %s' % node.items)
        for item in node.items:
356
            line = item.to_dict(columns)
357 358
            self.item_listview.lines.append(item.to_dict(columns))

359 360 361 362 363 364 365 366 367 368 369 370
    def add_nodes(self, node_list, parent=None):
        """
        Add Node objects to the list of the parent.
        If parent is None, they are added to the root list.
        If the current selected node is parent, we add
        them directly to the node_listview
        """
        log.debug('Adding nodes to %s: %s' % (node_list, parent,))
        if not parent:
            list_to_append = self.nodes
        else:
            list_to_append = parent.nodes
371
        self.node_listview.add_lines(node_list)
372 373 374 375 376 377 378 379 380 381
        for node in node_list:
            new_node = LeafNode(node['node'])
            list_to_append.append(new_node)
            self.get_items(new_node)

    def get_nodes(self, node=None):
        """
        Get all subnodes of the given node. If no node is given, get
        the root nodes
        """
382 383
        def callback(nodes):
            lines = [{'name': nodes[node] or '',
384
                  'node': node} for node in nodes.keys()]
385 386 387 388
            self.add_nodes(lines)
            self.set_info_message('Nodes received')
            self.force_refresh()
        self.core.xmpp.plugin['xep_0060'].get_nodes(self.server, callback=callback)
389 390

    def create_node(self, node_name):
391
        def callback(res):
392 393
            if res:
                self.node_listview.add_lines([{'name': '', 'node': node_name}])
394 395 396
                self.set_info_message('Node created')
            else:
                self.set_info_message('Node not created')
397
            self.reset_help_message()
398
            self.force_refresh()
399
        if node_name:
400
            self.core.xmpp.plugin['xep_0060'].create_node(self.server, node_name, callback=callback)
401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
        return True

    def reset_help_message(self, txt=None):
        """
        Just reset the help message when a command ends
        """
        curses.curs_set(0)
        self.input = self.default_help_message
        return True

    def command_create_node(self):
        """
        Prompt for a node name and create it on Enter key
        """
        curses.curs_set(1)
        self.input = windows.CommandInput("[Create node]", self.reset_help_message, self.create_node, None)
        self.input.resize(1, self.width, self.height-1, 0)
        return True
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443

    def scroll_node_up(self):
        """
        scroll the node up, and update the item list if needed
        """
        selected_node_before = self.get_selected_node_name()
        self.node_listview.move_cursor_up()
        selected_node_after = self.get_selected_node_name()
        if selected_node_after is not selected_node_before:
            self.display_items_from_node(self.get_node_by_name(selected_node_after))
            return True
        return False

    def scroll_node_down(self):
        """
        scroll the node down, and update the item list if needed
        """
        selected_node_before = self.get_selected_node_name()
        self.node_listview.move_cursor_down()
        selected_node_after = self.get_selected_node_name()
        if selected_node_after is not selected_node_before:
            self.display_items_from_node(self.get_node_by_name(selected_node_after))
            return True
        return False

444 445 446 447 448 449 450 451
    def open_selected_item(self):
        """
        displays the currently selected item in the item view window
        """
        selected_item = self.get_item_by_id(self.get_selected_item_id())
        if not selected_item:
            return
        log.debug('Content: %s'%ET.tostring(selected_item.content))
louiz’'s avatar
louiz’ committed
452
        entry = atom_parser.parse_atom_entry(selected_item.content)
453 454 455 456
        if not entry:
            self.item_viewer._text = str(ET.tostring(selected_item.content))
        else:
            self.item_viewer._text = \
457 458 459 460 461 462 463 464 465 466 467 468 469 470
"""\x193Title:\x19o %(title)s
\x193Author:\x19o %(author_name)s (%(author_uri)s)
%(dates)s\x193Link:\x19o %(link)s

\x193Summary:\x19o
%(summary)s
""" % {'title': entry.get('title') or '',
       'author_name': entry['author'].get('name') or '',
       'author_uri': entry['author'].get('uri') or '',
       'link': entry.get('link_href') or '',
       'summary': entry.get('summary') or '',
       'dates': '\x193Published:\x19o %(published)s\n%(updated)s' % {'published':entry.get('published') or '',
                                                                'updated': '' if (entry.get('updated') is None) or (entry.get('published') == entry.get('updated')) else '\x193Published:\x19o %s\n' % entry.get('updated')}
       }
471 472
        self.item_viewer.rebuild_text()
        return True