diff options
Diffstat (limited to 'glances/folder_list.py')
| -rw-r--r-- | glances/folder_list.py | 192 |
1 files changed, 192 insertions, 0 deletions
diff --git a/glances/folder_list.py b/glances/folder_list.py new file mode 100644 index 00000000..acd1960f --- /dev/null +++ b/glances/folder_list.py @@ -0,0 +1,192 @@ +# -*- coding: utf-8 -*- +# +# This file is part of Glances. +# +# Copyright (C) 2015 Nicolargo <nicolas@nicolargo.com> +# +# 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/>. + +"""Manage the folder list.""" + +import os + +from glances.compat import range +from glances.logger import logger + +# Use the built-in version of scandir/walk if possible, otherwise +# use the scandir module version +scandir_tag = True +try: + # For Python 3.5 or higher + from os import scandir +except ImportError: + # For others... + try: + from scandir import scandir + except ImportError: + scandir_tag = False + + +class FolderList(object): + + """This class describes the optional monitored folder list. + + The folder list is a list of 'important' folder to monitor. + + The list (Python list) is composed of items (Python dict). + An item is defined (dict keys): + * path: Path to the folder + * careful: optional careful threshold (in MB) + * warning: optional warning threshold (in MB) + * critical: optional critical threshold (in MB) + """ + + # Maximum number of items in the list + __folder_list_max_size = 10 + # The folder list + __folder_list = [] + + def __init__(self, config): + """Init the folder list from the configuration file, if it exists.""" + self.config = config + + if self.config is not None and self.config.has_section('folders'): + if scandir_tag: + # Process monitoring list + logger.debug("Folder list configuration detected") + self.__set_folder_list('folders') + else: + logger.error('Scandir not found. Please use Python 3.5+ or install the scandir lib') + else: + self.__folder_list = [] + + def __set_folder_list(self, section): + """Init the monitored folder list. + + The list is defined in the Glances configuration file. + """ + for l in range(1, self.__folder_list_max_size + 1): + value = {} + key = 'folder_' + str(l) + '_' + + # Path is mandatory + try: + value['path'] = self.config.get_value(section, key + 'path') + except Exception as e: + logger.error("Cannot read folder list: {0}".format(e)) + continue + if value['path'] is None: + continue + + # Optional conf keys + for i in ['careful', 'warning', 'critical']: + try: + value[i] = self.config.get_value(section, key + i) + except: + value[i] = None + logger.debug("No {0} threshold for folder {1}".format(i, value["path"])) + + # Add the item to the list + self.__folder_list.append(value) + + def __str__(self): + return str(self.__folder_list) + + def __repr__(self): + return self.__folder_list + + def __getitem__(self, item): + return self.__folder_list[item] + + def __len__(self): + return len(self.__folder_list) + + def __get__(self, item, key): + """Meta function to return key value of item. + + Return None if not defined or item > len(list) + """ + if item < len(self.__folder_list): + try: + return self.__folder_list[item][key] + except Exception: + return None + else: + return None + + def __folder_size(self, path): + """Return the size of the directory given by path + + path: <string>""" + + ret = 0 + for f in scandir(path): + if f.is_dir() and (f.name != '.' or f.name != '..'): + ret += self.__folder_size(os.path.join(path, f.name)) + else: + try: + ret += f.stat().st_size + except OSError: + pass + + return ret + + def update(self): + """Update the command result attributed.""" + # Only continue if monitor list is not empty + if len(self.__folder_list) == 0: + return self.__folder_list + + # Iter upon the folder list + for i in range(len(self.get())): + # Update folder size + try: + self.__folder_list[i]['size'] = self.__folder_size(self.path(i)) + except Exception as e: + self.__folder_list[i]['size'] = None + logger.debug('Can get folder size ({0}). Error: {1}'.format(self.path(i), e)) + + return self.__folder_list + + def get(self): + """Return the monitored list (list of dict).""" + return self.__folder_list + + def set(self, newlist): + """Set the monitored list (list of dict).""" + self.__folder_list = newlist + + def getAll(self): + # Deprecated: use get() + return self.get() + + def setAll(self, newlist): + # Deprecated: use set() + self.set(newlist) + + def path(self, item): + """Return the path of the item number (item).""" + return self.__get__(item, "path") + + def careful(self, item): + """Return the careful threshold of the item number (item).""" + return self.__get__(item, "careful") + + def warning(self, item): + """Return the warning threshold of the item number (item).""" + return self.__get__(item, "warning") + + def critical(self, item): + """Return the critical threshold of the item number (item).""" + return self.__get__(item, "critical") |