glances_curses.py 38.8 KB
Newer Older
1 2
# -*- coding: utf-8 -*-
#
3
# This file is part of Glances.
4
#
A
Alessio Sergi 已提交
5
# Copyright (C) 2017 Nicolargo <nicolas@nicolargo.com>
6 7 8 9 10 11 12 13 14 15 16 17 18 19
#
# Glances is free software; you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Glances 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 Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.

A
PEP 257  
Alessio Sergi 已提交
20 21
"""Curses interface class."""

N
Nicolargo 已提交
22
import re
A
flake8  
Alessio Sergi 已提交
23
import sys
24

25
from glances.compat import u, itervalues
A
Alessio Sergi 已提交
26
from glances.globals import OSX, WINDOWS
27 28 29 30
from glances.logger import logger
from glances.logs import glances_logs
from glances.processes import glances_processes
from glances.timer import Timer
31

A
Alessio Sergi 已提交
32
# Import curses library for "normal" operating system
A
Alessio Sergi 已提交
33
if not WINDOWS:
34 35 36
    try:
        import curses
        import curses.panel
37
        from curses.textpad import Textbox
38
    except ImportError:
39
        logger.critical("Curses module not found. Glances cannot start in standalone mode.")
40
        sys.exit(1)
41 42


43
class _GlancesCurses(object):
44

A
PEP 257  
Alessio Sergi 已提交
45 46 47
    """This class manages the curses display (and key pressed).

    Note: It is a private class, use GlancesCursesClient or GlancesCursesBrowser.
48
    """
49

50 51 52 53 54
    _hotkeys = {
        '0': {'switch': 'disable_irix'},
        '1': {'switch': 'percpu'},
        '2': {'switch': 'disable_left_sidebar'},
        '3': {'switch': 'disable_quicklook'},
55
        '6': {'switch': 'meangpu'},
56 57 58 59 60 61 62
        '/': {'switch': 'process_short_name'},
        'd': {'switch': 'disable_diskio'},
        'A': {'switch': 'disable_amps'},
        'b': {'switch': 'byte'},
        'B': {'switch': 'diskio_iops'},
        'D': {'switch': 'disable_docker'},
        'F': {'switch': 'fs_free_space'},
63
        'G': {'switch': 'disable_gpu'},
64 65 66 67 68
        'h': {'switch': 'help_tag'},
        'I': {'switch': 'disable_ip'},
        'l': {'switch': 'disable_alert'},
        'M': {'switch': 'reset_minmax_tag'},
        'n': {'switch': 'disable_network'},
N
nicolargo 已提交
69
        'N': {'switch': 'disable_now'},
70
        'P': {'switch': 'disable_ports'},
71
        'Q': {'switch': 'enable_irq'},
72 73 74 75 76 77 78 79 80 81 82 83
        'R': {'switch': 'disable_raid'},
        's': {'switch': 'disable_sensors'},
        'T': {'switch': 'network_sum'},
        'U': {'switch': 'network_cumul'},
        'W': {'switch': 'disable_wifi'},
        # Processes sort hotkeys
        'a': {'auto_sort': True, 'sort_key': 'cpu_percent'},
        'c': {'auto_sort': False, 'sort_key': 'cpu_percent'},
        'i': {'auto_sort': False, 'sort_key': 'io_counters'},
        'm': {'auto_sort': False, 'sort_key': 'memory_percent'},
        'p': {'auto_sort': False, 'sort_key': 'name'},
        't': {'auto_sort': False, 'sort_key': 'cpu_times'},
84
        'u': {'auto_sort': False, 'sort_key': 'username'}
85 86
    }

87 88 89
    def __init__(self, config=None, args=None):
        # Init
        self.config = config
90
        self.args = args
N
Nicolas Hennion 已提交
91

92 93 94 95 96 97 98 99 100 101 102
        # Init windows positions
        self.term_w = 80
        self.term_h = 24

        # Space between stats
        self.space_between_column = 3
        self.space_between_line = 2

        # Init the curses screen
        self.screen = curses.initscr()
        if not self.screen:
A
Alessio Sergi 已提交
103
            logger.critical("Cannot init the curses library.\n")
N
Nicolas Hennion 已提交
104
            sys.exit(1)
105

106 107 108 109
        # Load the 'outputs' section of the configuration file
        # - Init the theme (default is black)
        self.theme = {'name': 'black'}

110 111 112
        # Load configuration file
        self.load_config(config)

113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
        # Init cursor
        self._init_cursor()

        # Init the colors
        self._init_colors()

        # Init main window
        self.term_window = self.screen.subwin(0, 0)

        # Init refresh time
        self.__refresh_time = args.time

        # Init edit filter tag
        self.edit_filter = False

128 129 130
        # Init the process min/max reset
        self.args.reset_minmax_tag = False

131 132 133 134 135 136 137 138
        # Catch key pressed with non blocking mode
        self.no_flash_cursor()
        self.term_window.nodelay(1)
        self.pressedkey = -1

        # History tag
        self._init_history()

139
    def load_config(self, config):
140
        """Load the outputs section of the configuration file."""
141
        # Load the theme
142
        if config is not None and config.has_section('outputs'):
143 144
            logger.debug('Read the outputs section in the configuration file')
            self.theme['name'] = config.get_value('outputs', 'curse_theme', default='black')
145
            logger.debug('Theme for the curse interface: {}'.format(self.theme['name']))
146 147

    def is_theme(self, name):
148
        """Return True if the theme *name* should be used."""
149 150
        return getattr(self.args, 'theme_' + name) or self.theme['name'] == name

151
    def _init_history(self):
152
        """Init the history option."""
153 154

        self.reset_history_tag = False
N
nicolargo 已提交
155 156 157 158 159 160 161 162 163
        self.graph_tag = False
        if self.args.export_graph:
            logger.info('Export graphs function enabled with output path %s' %
                        self.args.path_graph)
            from glances.exports.graph import GlancesGraph
            self.glances_graph = GlancesGraph(self.args.path_graph)
            if not self.glances_graph.graph_enabled():
                self.args.export_graph = False
                logger.error('Export graphs disabled')
164 165

    def _init_cursor(self):
166
        """Init cursors."""
167

168 169 170 171
        if hasattr(curses, 'noecho'):
            curses.noecho()
        if hasattr(curses, 'cbreak'):
            curses.cbreak()
N
Nicolargo 已提交
172
        self.set_cursor(0)
173

174
    def _init_colors(self):
175
        """Init the Curses color layout."""
176 177 178 179 180 181 182

        # Set curses options
        if hasattr(curses, 'start_color'):
            curses.start_color()
        if hasattr(curses, 'use_default_colors'):
            curses.use_default_colors()

183
        # Init colors
184 185
        if self.args.disable_bold:
            A_BOLD = 0
186
            self.args.disable_bg = True
187 188
        else:
            A_BOLD = curses.A_BOLD
189 190 191 192 193 194 195

        self.title_color = A_BOLD
        self.title_underline_color = A_BOLD | curses.A_UNDERLINE
        self.help_color = A_BOLD

        if curses.has_colors():
            # The screen is compatible with a colored design
196
            if self.is_theme('white'):
197
                # White theme: black ==> white
N
Nicolargo 已提交
198 199 200
                curses.init_pair(1, curses.COLOR_BLACK, -1)
            else:
                curses.init_pair(1, curses.COLOR_WHITE, -1)
201
            if self.args.disable_bg:
202 203 204 205
                curses.init_pair(2, curses.COLOR_RED, -1)
                curses.init_pair(3, curses.COLOR_GREEN, -1)
                curses.init_pair(4, curses.COLOR_BLUE, -1)
                curses.init_pair(5, curses.COLOR_MAGENTA, -1)
206 207 208 209 210
            else:
                curses.init_pair(2, curses.COLOR_WHITE, curses.COLOR_RED)
                curses.init_pair(3, curses.COLOR_WHITE, curses.COLOR_GREEN)
                curses.init_pair(4, curses.COLOR_WHITE, curses.COLOR_BLUE)
                curses.init_pair(5, curses.COLOR_WHITE, curses.COLOR_MAGENTA)
211 212 213 214 215
            curses.init_pair(6, curses.COLOR_RED, -1)
            curses.init_pair(7, curses.COLOR_GREEN, -1)
            curses.init_pair(8, curses.COLOR_BLUE, -1)

            # Colors text styles
216 217 218 219
            if curses.COLOR_PAIRS > 8:
                try:
                    curses.init_pair(9, curses.COLOR_MAGENTA, -1)
                except Exception:
220
                    if self.is_theme('white'):
221 222 223 224 225 226
                        curses.init_pair(9, curses.COLOR_BLACK, -1)
                    else:
                        curses.init_pair(9, curses.COLOR_WHITE, -1)
                try:
                    curses.init_pair(10, curses.COLOR_CYAN, -1)
                except Exception:
227
                    if self.is_theme('white'):
228 229 230 231
                        curses.init_pair(10, curses.COLOR_BLACK, -1)
                    else:
                        curses.init_pair(10, curses.COLOR_WHITE, -1)

232 233
                self.ifWARNING_color2 = curses.color_pair(9) | A_BOLD
                self.ifCRITICAL_color2 = curses.color_pair(6) | A_BOLD
234 235
                self.filter_color = curses.color_pair(10) | A_BOLD

236
            self.no_color = curses.color_pair(1)
A
Alessio Sergi 已提交
237
            self.default_color = curses.color_pair(3) | A_BOLD
238 239
            self.nice_color = curses.color_pair(9)
            self.cpu_time_color = curses.color_pair(9)
240 241 242
            self.ifCAREFUL_color = curses.color_pair(4) | A_BOLD
            self.ifWARNING_color = curses.color_pair(5) | A_BOLD
            self.ifCRITICAL_color = curses.color_pair(2) | A_BOLD
243
            self.default_color2 = curses.color_pair(7)
244
            self.ifCAREFUL_color2 = curses.color_pair(8) | A_BOLD
245

246
        else:
247 248
            # The screen is NOT compatible with a colored design
            # switch to B&W text styles
249 250
            self.no_color = curses.A_NORMAL
            self.default_color = curses.A_NORMAL
251
            self.nice_color = A_BOLD
252
            self.cpu_time_color = A_BOLD
253 254 255 256 257 258 259
            self.ifCAREFUL_color = curses.A_UNDERLINE
            self.ifWARNING_color = A_BOLD
            self.ifCRITICAL_color = curses.A_REVERSE
            self.default_color2 = curses.A_NORMAL
            self.ifCAREFUL_color2 = curses.A_UNDERLINE
            self.ifWARNING_color2 = A_BOLD
            self.ifCRITICAL_color2 = curses.A_REVERSE
N
Nicolargo 已提交
260
            self.filter_color = A_BOLD
261 262

        # Define the colors list (hash table) for stats
263
        self.colors_list = {
264 265 266
            'DEFAULT': self.no_color,
            'UNDERLINE': curses.A_UNDERLINE,
            'BOLD': A_BOLD,
267
            'SORT': A_BOLD,
268
            'OK': self.default_color2,
269
            'MAX': self.default_color2 | curses.A_BOLD,
N
Nicolargo 已提交
270
            'FILTER': self.filter_color,
271
            'TITLE': self.title_color,
272 273
            'PROCESS': self.default_color2,
            'STATUS': self.default_color2,
274
            'NICE': self.nice_color,
275
            'CPU_TIME': self.cpu_time_color,
276 277 278 279 280 281
            'CAREFUL': self.ifCAREFUL_color2,
            'WARNING': self.ifWARNING_color2,
            'CRITICAL': self.ifCRITICAL_color2,
            'OK_LOG': self.default_color,
            'CAREFUL_LOG': self.ifCAREFUL_color,
            'WARNING_LOG': self.ifWARNING_color,
282 283
            'CRITICAL_LOG': self.ifCRITICAL_color,
            'PASSWORD': curses.A_PROTECT
284 285
        }

286 287 288 289 290 291
    def flash_cursor(self):
        self.term_window.keypad(1)

    def no_flash_cursor(self):
        self.term_window.keypad(0)

N
Nicolargo 已提交
292
    def set_cursor(self, value):
A
PEP 257  
Alessio Sergi 已提交
293 294 295 296 297 298
        """Configure the curse cursor apparence.

        0: invisible
        1: visible
        2: very visible
        """
N
Nicolargo 已提交
299 300 301 302 303 304
        if hasattr(curses, 'curs_set'):
            try:
                curses.curs_set(value)
            except Exception:
                pass

305
    def get_key(self, window):
A
PEP 257  
Alessio Sergi 已提交
306
        # Catch ESC key AND numlock key (issue #163)
307 308 309 310
        keycode = [0, 0]
        keycode[0] = window.getch()
        keycode[1] = window.getch()

N
Nicolargo 已提交
311
        if keycode != [-1, -1]:
N
Nicolargo 已提交
312
            logger.debug("Keypressed (code: %s)" % keycode)
N
Nicolargo 已提交
313

314 315 316 317 318 319
        if keycode[0] == 27 and keycode[1] != -1:
            # Do not escape on specials keys
            return -1
        else:
            return keycode[0]

N
Nicolargo 已提交
320
    def __catch_key(self, return_to_browser=False):
A
PEP 257  
Alessio Sergi 已提交
321
        # Catch the pressed key
322
        self.pressedkey = self.get_key(self.term_window)
323

324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
        # Actions (available in the global hotkey dict)...
        for hotkey in self._hotkeys:
            if self.pressedkey == ord(hotkey) and 'switch' in self._hotkeys[hotkey]:
                setattr(self.args,
                        self._hotkeys[hotkey]['switch'],
                        not getattr(self.args,
                                    self._hotkeys[hotkey]['switch']))
            if self.pressedkey == ord(hotkey) and 'auto_sort' in self._hotkeys[hotkey]:
                setattr(glances_processes,
                        'auto_sort',
                        self._hotkeys[hotkey]['auto_sort'])
            if self.pressedkey == ord(hotkey) and 'sort_key' in self._hotkeys[hotkey]:
                setattr(glances_processes,
                        'sort_key',
                        self._hotkeys[hotkey]['sort_key'])

        # Other actions...
341 342
        if self.pressedkey == ord('\x1b') or self.pressedkey == ord('q'):
            # 'ESC'|'q' > Quit
N
Nicolargo 已提交
343 344 345 346 347 348
            if return_to_browser:
                logger.info("Stop Glances client and return to the browser")
            else:
                self.end()
                logger.info("Stop Glances")
                sys.exit(0)
349
        elif self.pressedkey == ord('\n'):
N
Nicolargo 已提交
350 351
            # 'ENTER' > Edit the process filter
            self.edit_filter = not self.edit_filter
N
nicolargo 已提交
352
        elif self.pressedkey == ord('4'):
N
nicolargo 已提交
353
            self.args.full_quicklook = not self.args.full_quicklook
N
nicolargo 已提交
354 355 356 357 358
            if self.args.full_quicklook:
                self.enable_fullquicklook()
            else:
                self.disable_fullquicklook()
        elif self.pressedkey == ord('5'):
N
nicolargo 已提交
359
            self.args.disable_top = not self.args.disable_top
N
nicolargo 已提交
360 361 362 363
            if self.args.disable_top:
                self.disable_top()
            else:
                self.enable_top()
364 365 366 367 368 369 370
        elif self.pressedkey == ord('e'):
            # 'e' > Enable/Disable process extended
            self.args.enable_process_extended = not self.args.enable_process_extended
            if not self.args.enable_process_extended:
                glances_processes.disable_extended()
            else:
                glances_processes.enable_extended()
371 372 373
        elif self.pressedkey == ord('E'):
            # 'E' > Erase the process filter
            glances_processes.process_filter = None
374 375 376
        elif self.pressedkey == ord('f'):
            # 'f' > Show/hide fs / folder stats
            self.args.disable_fs = not self.args.disable_fs
N
nicolargo 已提交
377
            self.args.disable_folders = not self.args.disable_folders
N
nicolargo 已提交
378 379 380
        elif self.pressedkey == ord('g'):
            # 'g' > Generate graph from history
            self.graph_tag = not self.graph_tag
N
nicolargo 已提交
381 382 383
        elif self.pressedkey == ord('r'):
            # 'r' > Reset graph history
            self.reset_history_tag = not self.reset_history_tag
384 385 386 387 388 389
        elif self.pressedkey == ord('w'):
            # 'w' > Delete finished warning logs
            glances_logs.clean()
        elif self.pressedkey == ord('x'):
            # 'x' > Delete finished warning and critical logs
            glances_logs.clean(critical=True)
390
        elif self.pressedkey == ord('z'):
391
            # 'z' > Enable or disable processes
392 393 394 395 396
            self.args.disable_process = not self.args.disable_process
            if self.args.disable_process:
                glances_processes.disable()
            else:
                glances_processes.enable()
397

398 399 400
        # Return the key code
        return self.pressedkey

401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
    def disable_top(self):
        """Disable the top panel"""
        self.args.disable_quicklook = True
        self.args.disable_cpu = True
        self.args.disable_mem = True
        self.args.disable_memswap = True
        self.args.disable_load = True

    def enable_top(self):
        """Enable the top panel"""
        self.args.disable_quicklook = False
        self.args.disable_cpu = False
        self.args.disable_mem = False
        self.args.disable_memswap = False
        self.args.disable_load = False

    def disable_fullquicklook(self):
        """Disable the full quicklook mode"""
        self.args.disable_quicklook = False
        self.args.disable_cpu = False
        self.args.disable_mem = False
        self.args.disable_memswap = False

    def enable_fullquicklook(self):
        """Disable the full quicklook mode"""
        self.args.disable_quicklook = False
        self.args.disable_cpu = True
        self.args.disable_mem = True
        self.args.disable_memswap = True

431
    def end(self):
432
        """Shutdown the curses window."""
N
Nicolas Hennion 已提交
433 434 435 436 437 438 439 440 441
        if hasattr(curses, 'echo'):
            curses.echo()
        if hasattr(curses, 'nocbreak'):
            curses.nocbreak()
        if hasattr(curses, 'curs_set'):
            try:
                curses.curs_set(1)
            except Exception:
                pass
442
        curses.endwin()
443

444
    def init_line_column(self):
445
        """Init the line and column position for the curses interface."""
446 447
        self.init_line()
        self.init_column()
448 449

    def init_line(self):
450
        """Init the line position for the curses interface."""
451 452 453 454
        self.line = 0
        self.next_line = 0

    def init_column(self):
455
        """Init the column position for the curses interface."""
456 457 458 459
        self.column = 0
        self.next_column = 0

    def new_line(self):
A
PEP 257  
Alessio Sergi 已提交
460
        """New line in the curses interface."""
461 462 463
        self.line = self.next_line

    def new_column(self):
A
PEP 257  
Alessio Sergi 已提交
464
        """New column in the curses interface."""
465 466
        self.column = self.next_column

N
nicolargo 已提交
467
    def __get_stat_display(self, stats, plugin_max_width):
468 469 470 471 472 473
        """Return a dict of dict with all the stats display
        * key: plugin name
        * value: dict returned by the get_stats_display Plugin method

        :returns: dict of dict
        """
N
nicolargo 已提交
474
        ret = {}
475 476 477 478
        for p in stats.getAllPlugins():
            if p in ['network', 'wifi', 'irq', 'fs', 'folders']:
                ret[p] = stats.get_plugin(p).get_stats_display(
                    args=self.args, max_width=plugin_max_width)
479 480 481
            elif p in ['quicklook']:
                # Grab later because we need plugin size
                continue
482 483 484 485 486 487 488 489
            else:
                # system, uptime, cpu, percpu, gpu, load, mem, memswap, ip,
                # ... diskio, raid, sensors, ports, now, docker, processcount,
                # ... amps, alert
                try:
                    ret[p] = stats.get_plugin(p).get_stats_display(args=self.args)
                except AttributeError:
                    ret[p] = None
N
nicolargo 已提交
490
        if self.args.percpu:
491
            ret['cpu'] = ret['percpu']
N
nicolargo 已提交
492 493
        return ret

494
    def display(self, stats, cs_status=None):
A
PEP 257  
Alessio Sergi 已提交
495
        """Display stats on the screen.
496

497 498 499
        stats: Stats database to display
        cs_status:
            "None": standalone or server mode
500 501
            "Connected": Client is connected to a Glances server
            "SNMP": Client is connected to a SNMP server
502
            "Disconnected": Client is disconnected from the server
503 504 505 506

        Return:
            True if the stats have been displayed
            False if the help have been displayed
507
        """
508 509
        # Init the internal line/column for Glances Curses
        self.init_line_column()
510

511 512 513 514 515 516 517 518 519 520 521 522
        # No processes list in SNMP mode
        if cs_status == 'SNMP':
            # so... more space for others plugins
            plugin_max_width = 43
        else:
            plugin_max_width = None

        # Update the stats messages
        ###########################

        # Update the client server status
        self.args.cs_status = cs_status
N
nicolargo 已提交
523
        __stat_display = self.__get_stat_display(stats, plugin_max_width)
524

525
        # Adapt number of processes to the available space
526
        max_processes_displayed = self.screen.getmaxyx()[0] - 11 - \
N
nicolargo 已提交
527 528
            self.get_stats_display_height(__stat_display["alert"]) - \
            self.get_stats_display_height(__stat_display["docker"])
529 530 531 532 533
        try:
            if self.args.enable_process_extended and not self.args.process_tree:
                max_processes_displayed -= 4
        except AttributeError:
            pass
534
        if max_processes_displayed < 0:
535
            max_processes_displayed = 0
536 537
        if (glances_processes.max_processes is None or
                glances_processes.max_processes != max_processes_displayed):
538
            logger.debug("Set number of displayed processes to {}".format(max_processes_displayed))
539
            glances_processes.max_processes = max_processes_displayed
540

N
nicolargo 已提交
541
        __stat_display["processlist"] = stats.get_plugin(
542
            'processlist').get_stats_display(args=self.args)
543

544 545 546 547
        # Display the stats on the curses interface
        ###########################################

        # Help screen (on top of the other stats)
548
        if self.args.help_tag:
549
            # Display the stats...
550 551
            self.display_plugin(
                stats.get_plugin('help').get_stats_display(args=self.args))
552 553 554
            # ... and exit
            return False

555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
        # =====================================
        # Display first line (system+ip+uptime)
        # =====================================
        self.__display_firstline(__stat_display)

        # ==============================================================
        # Display second line (<SUMMARY>+CPU|PERCPU+<GPU>+LOAD+MEM+SWAP)
        # ==============================================================
        self.__display_secondline(__stat_display, stats)

        # ==================================================================
        # Display left sidebar (NETWORK+PORTS+DISKIO+FS+SENSORS+Current time)
        # ==================================================================
        self.__display_left(__stat_display)

        # ====================================
        # Display right stats (process and co)
        # ====================================
        self.__display_right(__stat_display)

        # History option
        # Generate history graph
        if self.graph_tag and self.args.export_graph:
            self.display_popup(
                'Generate graphs history in {}\nPlease wait...'.format(
                    self.glances_graph.get_output_folder()))
            self.display_popup(
                'Generate graphs history in {}\nDone: {} graphs generated'.format(
                    self.glances_graph.get_output_folder(),
                    self.glances_graph.generate_graph(stats)))
        elif self.reset_history_tag and self.args.export_graph:
            self.display_popup('Reset graph history')
            self.glances_graph.reset(stats)
        elif (self.graph_tag or self.reset_history_tag) and not self.args.export_graph:
            try:
                self.glances_graph.graph_enabled()
            except Exception:
                self.display_popup('Graph disabled\nEnable it using --export-graph')
            else:
                self.display_popup('Graph disabled')
        self.graph_tag = False
        self.reset_history_tag = False

        # Display edit filter popup
        # Only in standalone mode (cs_status is None)
        if self.edit_filter and cs_status is None:
            new_filter = self.display_popup(
                'Process filter pattern: \n\n' +
                'Examples:\n' +
                '- python\n' +
                '- .*python.*\n' +
                '- \/usr\/lib.*\n' +
                '- name:.*nautilus.*\n' +
                '- cmdline:.*glances.*\n' +
                '- username:nicolargo\n' +
                '- username:^root        ',
                is_input=True,
                input_value=glances_processes.process_filter_input)
            glances_processes.process_filter = new_filter
        elif self.edit_filter and cs_status is not None:
            self.display_popup('Process filter only available in standalone mode')
        self.edit_filter = False

        return True

    def __display_firstline(self, stat_display):
        """Display the first line in the Curses interface.

        system + ip + uptime
        """
625 626 627
        # Space between column
        self.space_between_column = 0
        self.new_line()
628
        l_uptime = self.get_stats_display_width(stat_display["system"]) \
N
nicolargo 已提交
629
            + self.space_between_column \
630 631
            + self.get_stats_display_width(stat_display["ip"]) + 3 \
            + self.get_stats_display_width(stat_display["uptime"])
632
        self.display_plugin(
633 634
            stat_display["system"],
            display_optional=(self.screen.getmaxyx()[1] >= l_uptime))
635
        self.new_column()
636
        self.display_plugin(stat_display["ip"])
637 638 639
        # Space between column
        self.space_between_column = 3
        self.new_column()
640
        self.display_plugin(stat_display["uptime"])
A
Alessio Sergi 已提交
641

642 643 644 645 646
    def __display_secondline(self, stat_display, stats):
        """Display the second line in the Curses interface.

        <QUICKLOOK> + CPU|PERCPU + <GPU> + MEM + SWAP + LOAD
        """
647
        self.init_column()
648
        self.new_line()
649

N
Nicolargo 已提交
650
        # Init quicklook
651
        stat_display['quicklook'] = {'msgdict': []}
652

653 654 655
        # Dict for plugins width
        plugin_widths = {'quicklook': 0}
        for p in ['cpu', 'gpu', 'mem', 'memswap', 'load']:
N
nicolargo 已提交
656
            plugin_widths[p] = self.get_stats_display_width(stat_display[p]) if hasattr(self.args, 'disable_' + p) and p in stat_display else 0
657

658 659
        # Width of all plugins
        stats_width = sum(itervalues(plugin_widths))
660 661

        # Number of plugin but quicklook
662
        stats_number = (
663 664 665 666 667
            int(not self.args.disable_cpu and stat_display["cpu"]['msgdict'] != []) +
            int(not self.args.disable_gpu and stat_display["gpu"]['msgdict'] != []) +
            int(not self.args.disable_mem and stat_display["mem"]['msgdict'] != []) +
            int(not self.args.disable_memswap and stat_display["memswap"]['msgdict'] != []) +
            int(not self.args.disable_load and stat_display["load"]['msgdict'] != []))
668 669 670

        if not self.args.disable_quicklook:
            # Quick look is in the place !
671
            if self.args.full_quicklook:
672
                quicklook_width = self.screen.getmaxyx()[1] - (stats_width + 8 + stats_number * self.space_between_column)
673
            else:
674
                quicklook_width = min(self.screen.getmaxyx()[1] - (stats_width + 8 + stats_number * self.space_between_column), 79)
N
Nicolargo 已提交
675
            try:
676
                stat_display["quicklook"] = stats.get_plugin(
N
Nicolargo 已提交
677 678 679 680
                    'quicklook').get_stats_display(max_width=quicklook_width, args=self.args)
            except AttributeError as e:
                logger.debug("Quicklook plugin not available (%s)" % e)
            else:
681 682
                plugin_widths['quicklook'] = self.get_stats_display_width(stat_display["quicklook"])
                stats_width = sum(itervalues(plugin_widths)) + 1
683
            self.space_between_column = 1
684
            self.display_plugin(stat_display["quicklook"])
685 686 687 688
            self.new_column()

        # Compute spaces between plugins
        # Note: Only one space between Quicklook and others
689 690 691
        plugin_display_optional = {}
        for p in ['cpu', 'gpu', 'mem', 'memswap', 'load']:
            plugin_display_optional[p] = True
692
        if stats_number > 1:
693
            self.space_between_column = max(1, int((self.screen.getmaxyx()[1] - stats_width) / (stats_number - 1)))
694 695 696 697 698 699 700
            for p in ['mem', 'cpu']:
                # No space ? Remove optional stats
                if self.space_between_column < 3:
                    plugin_display_optional[p] = False
                    plugin_widths[p] = self.get_stats_display_width(stat_display[p], without_option=True) if hasattr(self.args, 'disable_' + p) else 0
                    stats_width = sum(itervalues(plugin_widths)) + 1
                    self.space_between_column = max(1, int((self.screen.getmaxyx()[1] - stats_width) / (stats_number - 1)))
701 702 703 704
        else:
            self.space_between_column = 0

        # Display CPU, MEM, SWAP and LOAD
705
        for p in ['cpu', 'gpu', 'mem', 'memswap', 'load']:
N
nicolargo 已提交
706 707 708
            if p in stat_display:
                self.display_plugin(stat_display[p],
                                    display_optional=plugin_display_optional[p])
709 710 711
            if p is not 'load':
                # Skip last column
                self.new_column()
712

713 714 715
        # Space between column
        self.space_between_column = 3

716 717 718
        # Backup line position
        self.saved_line = self.next_line

719 720 721 722 723
    def __display_left(self, stat_display):
        """Display the left sidebar in the Curses interface.

        network+wifi+ports+diskio+fs+irq+folders+raid+sensors+now
        """
724
        self.init_column()
N
nicolargo 已提交
725 726 727 728 729 730
        if not self.args.disable_left_sidebar:
            for s in ['network', 'wifi', 'ports', 'diskio', 'fs', 'irq',
                      'folders', 'raid', 'sensors', 'now']:
                if hasattr(self.args, 'disable_' + s) and s in stat_display:
                    self.new_line()
                    self.display_plugin(stat_display[s])
731

732 733 734 735 736
    def __display_right(self, stat_display):
        """Display the right sidebar in the Curses interface.

        docker + processcount + amps + processlist + alert
        """
737
        # If space available...
738
        if self.screen.getmaxyx()[1] > 52:
739 740
            # Restore line position
            self.next_line = self.saved_line
741 742 743

            # Display right sidebar
            # DOCKER+PROCESS_COUNT+AMPS+PROCESS_LIST+ALERT
744
            self.new_column()
745
            self.new_line()
746
            self.display_plugin(stat_display["docker"])
747
            self.new_line()
748
            self.display_plugin(stat_display["processcount"])
749
            self.new_line()
750
            self.display_plugin(stat_display["amps"])
751
            self.new_line()
752 753
            self.display_plugin(stat_display["processlist"],
                                display_optional=(self.screen.getmaxyx()[1] > 102),
754
                                display_additional=(not OSX),
755
                                max_y=(self.screen.getmaxyx()[0] - self.get_stats_display_height(stat_display["alert"]) - 2))
756
            self.new_line()
757
            self.display_plugin(stat_display["alert"])
758

759 760
    def display_popup(self, message,
                      size_x=None, size_y=None,
N
Nicolargo 已提交
761 762
                      duration=3,
                      is_input=False,
N
Nicolargo 已提交
763
                      input_size=30,
N
Nicolargo 已提交
764
                      input_value=None):
765
        """
A
PEP 257  
Alessio Sergi 已提交
766 767
        Display a centered popup.

N
Nicolargo 已提交
768 769 770 771 772
        If is_input is False:
         Display a centered popup with the given message during duration seconds
         If size_x and size_y: set the popup size
         else set it automatically
         Return True if the popup could be displayed
A
PEP 257  
Alessio Sergi 已提交
773

N
Nicolargo 已提交
774 775 776 777
        If is_input is True:
         Display a centered popup with the given message and a input field
         If size_x and size_y: set the popup size
         else set it automatically
778
         Return the input string or None if the field is empty
779 780
        """
        # Center the popup
N
Nicolargo 已提交
781
        sentence_list = message.split('\n')
782
        if size_x is None:
N
Nicolargo 已提交
783
            size_x = len(max(sentence_list, key=len)) + 4
N
Nicolargo 已提交
784 785 786
            # Add space for the input field
            if is_input:
                size_x += input_size
787
        if size_y is None:
N
Nicolargo 已提交
788
            size_y = len(sentence_list) + 4
789 790 791 792
        screen_x = self.screen.getmaxyx()[1]
        screen_y = self.screen.getmaxyx()[0]
        if size_x > screen_x or size_y > screen_y:
            # No size to display the popup => abord
793
            return False
794 795
        pos_x = int((screen_x - size_x) / 2)
        pos_y = int((screen_y - size_y) / 2)
796 797 798

        # Create the popup
        popup = curses.newwin(size_y, size_x, pos_y, pos_x)
799

800 801 802 803
        # Fill the popup
        popup.border()

        # Add the message
N
nicolargo 已提交
804
        for y, m in enumerate(message.split('\n')):
805 806
            popup.addnstr(2 + y, 2, m, len(m))

A
Alessio Sergi 已提交
807
        if is_input and not WINDOWS:
N
Nicolargo 已提交
808 809
            # Create a subwindow for the text field
            subpop = popup.derwin(1, input_size, 2, 2 + len(m))
810
            subpop.attron(self.colors_list['FILTER'])
N
Nicolargo 已提交
811 812 813 814 815 816 817 818
            # Init the field with the current value
            if input_value is not None:
                subpop.addnstr(0, 0, input_value, len(input_value))
            # Display the popup
            popup.refresh()
            subpop.refresh()
            # Create the textbox inside the subwindows
            self.set_cursor(2)
819
            self.flash_cursor()
A
Alessio Sergi 已提交
820
            textbox = GlancesTextbox(subpop, insert_mode=False)
N
Nicolargo 已提交
821 822
            textbox.edit()
            self.set_cursor(0)
823
            self.no_flash_cursor()
N
Nicolargo 已提交
824
            if textbox.gather() != '':
N
Nicolargo 已提交
825
                logger.debug(
826
                    "User enters the following string: %s" % textbox.gather())
N
Nicolargo 已提交
827 828
                return textbox.gather()[:-1]
            else:
829
                logger.debug("User centers an empty string")
N
Nicolargo 已提交
830 831 832 833
                return None
        else:
            # Display the popup
            popup.refresh()
834
            self.wait(duration * 1000)
N
Nicolargo 已提交
835
            return True
836

837
    def display_plugin(self, plugin_stats,
838
                       display_optional=True,
839
                       display_additional=True,
840
                       max_y=65535):
A
PEP 257  
Alessio Sergi 已提交
841 842
        """Display the plugin_stats on the screen.

843 844
        If display_optional=True display the optional stats
        If display_additional=True display additionnal stats
845 846
        max_y do not display line > max_y
        """
847 848 849
        # Exit if:
        # - the plugin_stats message is empty
        # - the display tag = False
850
        if plugin_stats is None or not plugin_stats['msgdict'] or not plugin_stats['display']:
851
            # Exit
852 853 854 855 856 857 858
            return 0

        # Get the screen size
        screen_x = self.screen.getmaxyx()[1]
        screen_y = self.screen.getmaxyx()[0]

        # Set the upper/left position of the message
859
        if plugin_stats['align'] == 'right':
860
            # Right align (last column)
861
            display_x = screen_x - self.get_stats_display_width(plugin_stats)
862
        else:
863
            display_x = self.column
864
        if plugin_stats['align'] == 'bottom':
865
            # Bottom (last line)
866
            display_y = screen_y - self.get_stats_display_height(plugin_stats)
867
        else:
868
            display_y = self.line
869

870 871
        # Display
        x = display_x
872
        x_max = x
873 874 875
        y = display_y
        for m in plugin_stats['msgdict']:
            # New line
876
            if m['msg'].startswith('\n'):
877
                # Go to the next line
878
                y += 1
879 880 881 882
                # Return to the first column
                x = display_x
                continue
            # Do not display outside the screen
883
            if x < 0:
884
                continue
885
            if not m['splittable'] and (x + len(m['msg']) > screen_x):
886
                continue
887
            if y < 0 or (y + 1 > screen_y) or (y > max_y):
888 889
                break
            # If display_optional = False do not display optional stats
890
            if not display_optional and m['optional']:
891
                continue
892 893 894
            # If display_additional = False do not display additional stats
            if not display_additional and m['additional']:
                continue
895 896 897
            # Is it possible to display the stat with the current screen size
            # !!! Crach if not try/except... Why ???
            try:
A
Alessio Sergi 已提交
898 899
                self.term_window.addnstr(y, x,
                                         m['msg'],
900 901
                                         # Do not disply outside the screen
                                         screen_x - x,
902
                                         self.colors_list[m['decoration']])
A
Alessio Sergi 已提交
903
            except Exception:
904 905 906
                pass
            else:
                # New column
A
Alessio Sergi 已提交
907 908 909 910
                # Python 2: we need to decode to get real screen size because
                # UTF-8 special tree chars occupy several bytes.
                # Python 3: strings are strings and bytes are bytes, all is
                # good.
N
Nicolargo 已提交
911 912 913 914 915
                try:
                    x += len(u(m['msg']))
                except UnicodeDecodeError:
                    # Quick and dirty hack for issue #745
                    pass
916 917
                if x > x_max:
                    x_max = x
918 919

        # Compute the next Glances column/line position
N
Nicolargo 已提交
920 921
        self.next_column = max(
            self.next_column, x_max + self.space_between_column)
922
        self.next_line = max(self.next_line, y + self.space_between_line)
923 924

    def erase(self):
A
PEP 257  
Alessio Sergi 已提交
925
        """Erase the content of the screen."""
926 927
        self.term_window.erase()

928
    def flush(self, stats, cs_status=None):
A
PEP 257  
Alessio Sergi 已提交
929 930
        """Clear and update the screen.

931 932 933 934 935 936 937
        stats: Stats database to display
        cs_status:
            "None": standalone or server mode
            "Connected": Client is connected to the server
            "Disconnected": Client is disconnected from the server
        """
        self.erase()
938
        self.display(stats, cs_status=cs_status)
939

940
    def update(self, stats, cs_status=None, return_to_browser=False):
A
PEP 257  
Alessio Sergi 已提交
941 942 943 944
        """Update the screen.

        Wait for __refresh_time sec / catch key every 100 ms.

N
Nicolargo 已提交
945
        INPUT
946 947 948 949 950
        stats: Stats database to display
        cs_status:
            "None": standalone or server mode
            "Connected": Client is connected to the server
            "Disconnected": Client is disconnected from the server
N
Nicolargo 已提交
951 952 953 954 955 956 957
        return_to_browser:
            True: Do not exist, return to the browser list
            False: Exit and return to the shell

        OUPUT
        True: Exit key has been pressed
        False: Others cases...
958 959
        """
        # Flush display
960
        self.flush(stats, cs_status=cs_status)
961 962

        # Wait
N
Nicolargo 已提交
963
        exitkey = False
964
        countdown = Timer(self.__refresh_time)
N
Nicolargo 已提交
965
        while not countdown.finished() and not exitkey:
966
            # Getkey
N
Nicolargo 已提交
967 968 969 970
            pressedkey = self.__catch_key(return_to_browser=return_to_browser)
            # Is it an exit key ?
            exitkey = (pressedkey == ord('\x1b') or pressedkey == ord('q'))
            if not exitkey and pressedkey > -1:
971
                # Redraw display
972
                self.flush(stats, cs_status=cs_status)
973
            # Wait 100ms...
974
            self.wait()
975

N
Nicolargo 已提交
976 977
        return exitkey

978 979 980 981
    def wait(self, delay=100):
        """Wait delay in ms"""
        curses.napms(100)

982
    def get_stats_display_width(self, curse_msg, without_option=False):
A
PEP 257  
Alessio Sergi 已提交
983
        """Return the width of the formatted curses message.
984

A
PEP 257  
Alessio Sergi 已提交
985 986
        The height is defined by the maximum line.
        """
987
        try:
988
            if without_option:
989
                # Size without options
A
flake8  
Alessio Sergi 已提交
990
                c = len(max(''.join([(re.sub(r'[^\x00-\x7F]+', ' ', i['msg']) if not i['optional'] else "")
991
                                     for i in curse_msg['msgdict']]).split('\n'), key=len))
992 993
            else:
                # Size with all options
A
flake8  
Alessio Sergi 已提交
994
                c = len(max(''.join([re.sub(r'[^\x00-\x7F]+', ' ', i['msg'])
995
                                     for i in curse_msg['msgdict']]).split('\n'), key=len))
A
Alessio Sergi 已提交
996
        except Exception:
997 998 999 1000
            return 0
        else:
            return c

1001
    def get_stats_display_height(self, curse_msg):
A
PEP 257  
Alessio Sergi 已提交
1002
        r"""Return the height of the formatted curses message.
1003

A
PEP 257  
Alessio Sergi 已提交
1004 1005
        The height is defined by the number of '\n' (new line).
        """
1006
        try:
A
Alessio Sergi 已提交
1007
            c = [i['msg'] for i in curse_msg['msgdict']].count('\n')
A
Alessio Sergi 已提交
1008
        except Exception:
1009 1010 1011
            return 0
        else:
            return c + 1
N
Nicolargo 已提交
1012

1013

1014 1015
class GlancesCursesStandalone(_GlancesCurses):

A
PEP 257  
Alessio Sergi 已提交
1016
    """Class for the Glances curse standalone."""
1017 1018 1019 1020

    pass


1021 1022
class GlancesCursesClient(_GlancesCurses):

A
PEP 257  
Alessio Sergi 已提交
1023
    """Class for the Glances curse client."""
1024 1025 1026 1027

    pass


A
Alessio Sergi 已提交
1028
if not WINDOWS:
1029
    class GlancesTextbox(Textbox, object):
1030

1031 1032
        def __init__(self, *args, **kwargs):
            super(GlancesTextbox, self).__init__(*args, **kwargs)
1033

N
Nicolargo 已提交
1034
        def do_command(self, ch):
1035
            if ch == 10:  # Enter
N
Nicolargo 已提交
1036
                return 0
1037
            if ch == 127:  # Back
N
Nicolargo 已提交
1038
                return 8
1039
            return super(GlancesTextbox, self).do_command(ch)