data_forms.py 17.1 KB
Newer Older
louiz’'s avatar
louiz’ committed
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
# Copyright 2010-2011 Le Coz Florent <louiz@louiz.org>
#
# This file is part of Poezio.
#
# Poezio is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, version 3 of the License.
#
# Poezio is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Poezio.  If not, see <http://www.gnu.org/licenses/>.

"""
Defines the data-forms Tab and all the Windows for it.
"""

import logging
log = logging.getLogger(__name__)
import curses

from windows import g_lock
import windows
from tabs import Tab

class DataFormsTab(Tab):
    """
    A tab contaning various window type, displaying
    a form that the user needs to fill.
    """
louiz’'s avatar
louiz’ committed
34 35
    def __init__(self, form, on_cancel, on_send, kwargs):
        Tab.__init__(self)
louiz’'s avatar
louiz’ committed
36 37 38 39
        self._form = form
        self._on_cancel = on_cancel
        self._on_send = on_send
        self._kwargs = kwargs
louiz’'s avatar
louiz’ committed
40
        self.fields = []
louiz’'s avatar
louiz’ committed
41 42 43 44
        for field in self._form:
            self.fields.append(field)
        self.topic_win = windows.Topic()
        self.tab_win = windows.GlobalInfoBar()
louiz’'s avatar
louiz’ committed
45
        self.form_win = FormWin(form, self.height-4, self.width, 1, 0)
louiz’'s avatar
louiz’ committed
46
        self.help_win = windows.HelpText("Ctrl+Y: send form, Ctrl+G: cancel")
louiz’'s avatar
louiz’ committed
47
        self.help_win_dyn = windows.HelpText()
louiz’'s avatar
louiz’ committed
48 49 50 51 52 53 54 55
        self.key_func['KEY_UP'] = self.form_win.go_to_previous_input
        self.key_func['KEY_DOWN'] = self.form_win.go_to_next_input
        self.key_func['^G'] = self.on_cancel
        self.key_func['^Y'] = self.on_send
        self.resize()

    def on_cancel(self):
        self._on_cancel(self._form)
56
        return True
louiz’'s avatar
louiz’ committed
57 58 59 60 61

    def on_send(self):
        self._form.reply()
        self.form_win.reply()
        self._on_send(self._form)
62
        return True
louiz’'s avatar
louiz’ committed
63 64 65

    def on_input(self, key):
        if key in self.key_func:
louiz’'s avatar
louiz’ committed
66
            res = self.key_func[key]()
67 68
            if res:
                return res
louiz’'s avatar
louiz’ committed
69
            self.help_win_dyn.refresh(self.form_win.get_help_message())
70
            self.form_win.refresh_current_input()
louiz’'s avatar
louiz’ committed
71 72
        else:
            self.form_win.on_input(key)
louiz’'s avatar
louiz’ committed
73 74

    def resize(self):
louiz’'s avatar
louiz’ committed
75 76
        self.topic_win.resize(1, self.width, 0, 0)
        self.tab_win.resize(1, self.width, self.height-2, 0)
louiz’'s avatar
louiz’ committed
77
        self.form_win.resize(self.height-4, self.width, 1, 0)
louiz’'s avatar
louiz’ committed
78 79
        self.help_win.resize(1, self.width, self.height-1, 0)
        self.help_win_dyn.resize(1, self.width, self.height-3, 0)
louiz’'s avatar
louiz’ committed
80 81
        self.lines = []

82
    def refresh(self):
louiz’'s avatar
louiz’ committed
83
        self.topic_win.refresh(self._form['title'])
84
        self.tab_win.refresh()
louiz’'s avatar
louiz’ committed
85
        self.help_win.refresh()
louiz’'s avatar
louiz’ committed
86
        self.help_win_dyn.refresh(self.form_win.get_help_message())
louiz’'s avatar
louiz’ committed
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
        self.form_win.refresh()

class FieldInput(object):
    """
    All input type in a data form should inherite this class,
    in addition with windows.Input or any relevant class from the
    'windows' library.
    """
    def __init__(self, field):
        self._field = field
        self.color = 14

    def set_color(self, color):
        self.color = color
        self.refresh()

    def update_field_value(self, value):
        raise NotImplementedError

    def resize(self, height, width, y, x):
louiz’'s avatar
louiz’ committed
107
        self._resize(height, width, y, x)
louiz’'s avatar
louiz’ committed
108 109 110 111 112 113 114 115 116 117

    def is_dummy(self):
        return False

    def reply(self):
        """
        Set the correct response value in the field
        """
        raise NotImplementedError

louiz’'s avatar
louiz’ committed
118 119 120 121 122 123 124
    def get_help_message(self):
        """
        Should return a string explaining the keys of the input.
        Will be displayed at each refresh on a line at the bottom of the tab.
        """
        return ''

louiz’'s avatar
louiz’ committed
125
class DummyInput(FieldInput, windows.Win):
louiz’'s avatar
louiz’ committed
126 127 128
    """
    Used for fields that do not require any input ('fixed')
    """
louiz’'s avatar
louiz’ committed
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
    def __init__(self, field):
        FieldInput.__init__(self, field)
        windows.Win.__init__(self)

    def do_command(self):
        return

    def refresh(self):
        return

    def is_dummy(self):
        return True

class BooleanWin(FieldInput, windows.Win):
    def __init__(self, field):
        FieldInput.__init__(self, field)
        windows.Win.__init__(self)
        self.last_key = 'KEY_RIGHT'
        self.value = bool(field.getValue())

    def do_command(self, key):
        if key == 'KEY_LEFT' or key == 'KEY_RIGHT':
            self.value = not self.value
            self.last_key = key
        self.refresh()

    def refresh(self):
        with g_lock:
            self._win.attron(curses.color_pair(self.color))
            self.addnstr(0, 0, ' '*(8), self.width)
            self.addstr(0, 2, "%s"%self.value)
            self.addstr(0, 8, '→')
            self.addstr(0, 0, '←')
            if self.last_key == 'KEY_RIGHT':
                self.addstr(0, 8, '')
            else:
                self.addstr(0, 0, '')
            self._win.attroff(curses.color_pair(self.color))
            self._refresh()

    def reply(self):
        self._field['label'] = ''
        self._field.setAnswer(self.value)

louiz’'s avatar
louiz’ committed
173 174 175
    def get_help_message(self):
        return '← and →: change the value between True and False'

176 177 178 179 180 181 182 183
class TextMultiWin(FieldInput, windows.Win):
    def __init__(self, field):
        FieldInput.__init__(self, field)
        windows.Win.__init__(self)
        self.options = field.getValue()
        self.val_pos = 0
        self.edition_input = None
        if not isinstance(self.options, list):
184 185 186 187
            if isinstance(self.options, str):
                self.options = [self.options]
            else:
                self.options = []
188 189 190 191 192 193 194 195 196 197
        self.options.append('')

    def do_command(self, key):
        if not self.edition_input:
            if key == 'KEY_LEFT':
                if self.val_pos > 0:
                    self.val_pos -= 1
            elif key == 'KEY_RIGHT':
                if self.val_pos < len(self.options)-1:
                    self.val_pos += 1
198
            elif key == '^M':
199 200 201 202 203 204
                self.edition_input = windows.Input()
                self.edition_input.color = self.color
                self.edition_input.resize(self.height, self.width, self.y, self.x)
                self.edition_input.text = self.options[self.val_pos]
                self.edition_input.key_end()
        else:
205
            if key == '^M':
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
                self.options[self.val_pos] = self.edition_input.get_text()
                if not self.options[self.val_pos] and self.val_pos != len(self.options) -1:
                    del self.options[self.val_pos]
                    if self.val_pos == len(self.options) -1:
                        self.val_pos -= 1
                self.edition_input = None
                if not self.options or self.options[-1] != '':
                    self.options.append('')
            else:
                self.edition_input.do_command(key)
        self.refresh()

    def refresh(self):
        if not self.edition_input:
            with g_lock:
                self._win.attron(curses.color_pair(self.color))
                self.addnstr(0, 0, ' '*self.width, self.width)
                option = self.options[self.val_pos]
                self.addstr(0, self.width//2-len(option)//2, option)
                if self.val_pos > 0:
                    self.addstr(0, 0, '←')
                if self.val_pos < len(self.options)-1:
                    self.addstr(0, self.width-1, '→')
                self._win.attroff(curses.color_pair(self.color))
                self._refresh()
        else:
            self.edition_input.refresh()

    def reply(self):
        values = [val for val in self.options if val]
        self._field.setAnswer(values)

louiz’'s avatar
louiz’ committed
238 239 240 241 242 243 244 245 246 247 248
    def get_help_message(self):
        if not self.edition_input:
            help_msg = '← and →: browse the available entries. '
            if self.val_pos == len(self.options)-1:
                help_msg += 'Enter: add an entry'
            else:
                help_msg += 'Enter: edit this entry'
        else:
            help_msg = 'Enter: finish editing this entry.'
        return help_msg

louiz’'s avatar
louiz’ committed
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
class ListMultiWin(FieldInput, windows.Win):
    def __init__(self, field):
        FieldInput.__init__(self, field)
        windows.Win.__init__(self)
        values = field.getValue()
        self.options = [[option, True if option['value'] in values else False]\
                            for option in field.getOptions()]
        self.val_pos = 0

    def do_command(self, key):
        if key == 'KEY_LEFT':
            if self.val_pos > 0:
                self.val_pos -= 1
        elif key == 'KEY_RIGHT':
            if self.val_pos < len(self.options)-1:
                self.val_pos += 1
        elif key == ' ':
            self.options[self.val_pos][1] = not self.options[self.val_pos][1]
        else:
            return
        self.refresh()

    def refresh(self):
        with g_lock:
            self._win.attron(curses.color_pair(self.color))
            self.addnstr(0, 0, ' '*self.width, self.width)
            if self.val_pos > 0:
                self.addstr(0, 0, '←')
            if self.val_pos < len(self.options)-1:
                self.addstr(0, self.width-1, '→')
            option = self.options[self.val_pos]
            self.addstr(0, self.width//2-len(option)//2, option[0]['label'])
            self.addstr(0, 2, '✔' if option[1] else '☐')
            self._win.attroff(curses.color_pair(self.color))
            self._refresh()

    def reply(self):
        self._field['label'] = ''
        self._field.delOptions()
        values = [option[0]['value'] for option in self.options if option[1] is True]
        self._field.setAnswer(values)

louiz’'s avatar
louiz’ committed
291 292 293
    def get_help_message(self):
        return '←, →: Switch between the value. Space: select or unselect a value'

louiz’'s avatar
louiz’ committed
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
class ListSingleWin(FieldInput, windows.Win):
    def __init__(self, field):
        FieldInput.__init__(self, field)
        windows.Win.__init__(self)
        # the option list never changes
        self.options = field.getOptions()
        # val_pos is the position of the currently selected option
        self.val_pos = 0
        for i, option in enumerate(self.options):
            if field.getValue() == option['value']:
                self.val_pos = i

    def do_command(self, key):
        if key == 'KEY_LEFT':
            if self.val_pos > 0:
                self.val_pos -= 1
        elif key == 'KEY_RIGHT':
            if self.val_pos < len(self.options)-1:
                self.val_pos += 1
        else:
            return
        self.refresh()

    def refresh(self):
        with g_lock:
            self._win.attron(curses.color_pair(self.color))
            self.addnstr(0, 0, ' '*self.width, self.width)
            if self.val_pos > 0:
                self.addstr(0, 0, '←')
            if self.val_pos < len(self.options)-1:
                self.addstr(0, self.width-1, '→')
            option = self.options[self.val_pos]['label']
            self.addstr(0, self.width//2-len(option)//2, option)
            self._win.attroff(curses.color_pair(self.color))
            self._refresh()

    def reply(self):
        self._field['label'] = ''
        self._field.delOptions()
        self._field.setAnswer(self.options[self.val_pos]['value'])

louiz’'s avatar
louiz’ committed
335 336 337
    def get_help_message(self):
        return '←, →: Select a value amongst the others'

louiz’'s avatar
louiz’ committed
338 339 340 341 342 343 344 345 346 347 348 349 350
class TextSingleWin(FieldInput, windows.Input):
    def __init__(self, field):
        FieldInput.__init__(self, field)
        windows.Input.__init__(self)
        self.text = field.getValue() if isinstance(field.getValue(), str)\
            else ""
        self.pos = len(self.text)
        self.color = 14

    def reply(self):
        self._field['label'] = ''
        self._field.setAnswer(self.get_text())

louiz’'s avatar
louiz’ committed
351 352 353
    def get_help_message(self):
        return 'Edit the text'

louiz’'s avatar
louiz’ committed
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
class TextPrivateWin(TextSingleWin):
    def __init__(self, field):
        TextSingleWin.__init__(self, field)

    def rewrite_text(self):
        with g_lock:
            self._win.erase()
            if self.color:
                self._win.attron(curses.color_pair(self.color))
            self.addstr('*'*len(self.text[self.line_pos:self.line_pos+self.width-1]))
            if self.color:
                (y, x) = self._win.getyx()
                size = self.width-x
                self.addnstr(' '*size, size, curses.color_pair(self.color))
            self.addstr(0, self.pos, '')
            if self.color:
                self._win.attroff(curses.color_pair(self.color))
            self._refresh()

louiz’'s avatar
louiz’ committed
373 374 375
    def get_help_message(self):
        return 'Edit the secret text'

louiz’'s avatar
louiz’ committed
376 377 378 379 380 381 382 383
class FormWin(object):
    """
    A window, with some subwins (the various inputs).
    On init, create all the subwins.
    On resize, move and resize all the subwin and define how the text will be written
    On refresh, write all the text, and refresh all the subwins
    """
    input_classes = {'boolean': BooleanWin,
louiz’'s avatar
louiz’ committed
384
                     'fixed': DummyInput,
385
                     'jid-multi': TextMultiWin,
louiz’'s avatar
louiz’ committed
386
                     'jid-single': TextSingleWin,
louiz’'s avatar
louiz’ committed
387 388
                     'list-multi': ListMultiWin,
                     'list-single': ListSingleWin,
389
                     'text-multi': TextMultiWin,
louiz’'s avatar
louiz’ committed
390
                     'text-private': TextPrivateWin,
louiz’'s avatar
louiz’ committed
391 392
                     'text-single': TextSingleWin,
                     }
louiz’'s avatar
louiz’ committed
393 394 395 396 397 398 399 400 401 402
    def __init__(self, form, height, width, y, x):
        self._form = form
        self._win = curses.newwin(height, width, y, x)
        self.current_input = 0
        self.inputs = []        # dict list
        for (name, field) in self._form.getFields():
            if field['type'] == 'hidden':
                continue
            try:
                input_class = self.input_classes[field['type']]
louiz’'s avatar
louiz’ committed
403
            except IndexError:
404
                continue
louiz’'s avatar
louiz’ committed
405
            label = field['label']
406
            desc = field['desc']
louiz’'s avatar
louiz’ committed
407 408 409 410
            if field['type'] == 'fixed':
                label = field.getValue()
            inp = input_class(field)
            self.inputs.append({'label':label,
411
                                'description': desc,
louiz’'s avatar
louiz’ committed
412 413 414 415 416 417
                                'input':inp})

    def resize(self, height, width, y, x):
        self._win.resize(height, width)
        self.height = height
        self.width = width
418 419
        if self.current_input >= self.height-2:
            self.current_input = self.height-1
louiz’'s avatar
louiz’ committed
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436

    def reply(self):
        """
        Set the response values in the form, for each field
        from the corresponding input
        """
        for inp in self.inputs:
            if inp['input'].is_dummy():
                continue
            else:
                inp['input'].reply()
        self._form['title'] = ''
        self._form['instructions'] = ''

    def go_to_next_input(self):
        if not self.inputs:
            return
437
        if self.current_input == len(self.inputs) - 1 or self.current_input >= self.height-1:
louiz’'s avatar
louiz’ committed
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
            return
        self.inputs[self.current_input]['input'].set_color(14)
        self.current_input += 1
        jump = 0
        while self.current_input+jump != len(self.inputs) - 1 and self.inputs[self.current_input+jump]['input'].is_dummy():
            jump += 1
        if self.inputs[self.current_input+jump]['input'].is_dummy():
            return
        self.current_input += jump
        self.inputs[self.current_input]['input'].set_color(13)

    def go_to_previous_input(self):
        if not self.inputs:
            return
        if self.current_input == 0:
            return
        self.inputs[self.current_input]['input'].set_color(14)
        self.current_input -= 1
        jump = 0
        while self.current_input-jump > 0 and self.inputs[self.current_input+jump]['input'].is_dummy():
            jump += 1
        if self.inputs[self.current_input+jump]['input'].is_dummy():
            return
        self.current_input -= jump
        self.inputs[self.current_input]['input'].set_color(13)

    def on_input(self, key):
        if not self.inputs:
            return
        self.inputs[self.current_input]['input'].do_command(key)

    def refresh(self):
        with g_lock:
            self._win.erase()
            y = 0
            i = 0
            for name, field in self._form.getFields():
                if field['type'] == 'hidden':
                    continue
                label = self.inputs[i]['label']
                self._win.addstr(y, 0, label)
                self.inputs[i]['input'].resize(1, self.width//3, y+1, 2*self.width//3)
louiz’'s avatar
louiz’ committed
480
                # TODO: display the field description
louiz’'s avatar
louiz’ committed
481 482
                y += 1
                i += 1
483 484
                if y >= self.height:
                    break
louiz’'s avatar
louiz’ committed
485
            self._win.refresh()
486 487 488
        for i, inp in enumerate(self.inputs):
            if i >= self.height:
                break
louiz’'s avatar
louiz’ committed
489
            inp['input'].refresh()
490 491 492 493 494
        if self.current_input < self.height-1:
            self.inputs[self.current_input]['input'].set_color(13)
            self.inputs[self.current_input]['input'].refresh()

    def refresh_current_input(self):
louiz’'s avatar
louiz’ committed
495
        self.inputs[self.current_input]['input'].refresh()
louiz’'s avatar
louiz’ committed
496 497

    def get_help_message(self):
498
        if self.current_input < self.height-1 and self.inputs[self.current_input]['input']:
louiz’'s avatar
louiz’ committed
499 500
            return self.inputs[self.current_input]['input'].get_help_message()
        return ''