Source code for plaso.output.manager

# -*- coding: utf-8 -*-
"""Output plugin manager."""

from __future__ import unicode_literals

from plaso.output import interface


[docs]class OutputManager(object): """Output module manager.""" _disabled_output_classes = {} _output_classes = {}
[docs] @classmethod def DeregisterOutput(cls, output_class): """Deregisters an output class. The output classes are identified based on their NAME attribute. Args: output_class (type): output module class. Raises: KeyError: if output class is not set for the corresponding data type. """ output_class_name = output_class.NAME.lower() if output_class_name in cls._disabled_output_classes: class_dict = cls._disabled_output_classes else: class_dict = cls._output_classes if output_class_name not in class_dict: raise KeyError( 'Output class not set for name: {0:s}.'.format( output_class.NAME)) del class_dict[output_class_name]
[docs] @classmethod def GetDisabledOutputClasses(cls): """Retrieves the disabled output classes and its associated name. Yields: tuple[str, type]: output module name and class. """ for output_class in cls._disabled_output_classes.values(): yield output_class.NAME, output_class
[docs] @classmethod def GetOutputClass(cls, name): """Retrieves the output class for a specific name. Args: name (str): name of the output module. Returns: type: output module class. Raises: KeyError: if there is no output class found with the supplied name. ValueError: if name is not a string. """ if not isinstance(name, str): raise ValueError('Name attribute is not a string.') name = name.lower() if name not in cls._output_classes: raise KeyError( 'Name: [{0:s}] not registered as an output module.'.format(name)) return cls._output_classes[name]
[docs] @classmethod def GetOutputClasses(cls): """Retrieves the available output classes its associated name. Yields: tuple[str, type]: output class name and type object. """ for output_class in cls._output_classes.values(): yield output_class.NAME, output_class
[docs] @classmethod def HasOutputClass(cls, name): """Determines if a specific output class is registered with the manager. Args: name (str): name of the output module. Returns: bool: True if the output class is registered. """ if not isinstance(name, str): return False return name.lower() in cls._output_classes
[docs] @classmethod def IsLinearOutputModule(cls, name): """Determines if a specific output class is a linear output module. Args: name (str): name of the output module. Returns: True: if the output module is linear. """ name = name.lower() output_class = cls._output_classes.get(name, None) if not output_class: output_class = cls._disabled_output_classes.get(name, None) if output_class: return issubclass(output_class, interface.LinearOutputModule) return False
[docs] @classmethod def NewOutputModule(cls, name, output_mediator): """Creates a new output module object for the specified output format. Args: name (str): name of the output module. output_mediator (OutputMediator): output mediator. Returns: OutputModule: output module. Raises: KeyError: if there is no output class found with the supplied name. ValueError: if name is not a string. """ output_class = cls.GetOutputClass(name) return output_class(output_mediator)
[docs] @classmethod def RegisterOutput(cls, output_class, disabled=False): """Registers an output class. The output classes are identified based on their NAME attribute. Args: output_class (type): output module class. disabled (Optional[bool]): True if the output module is disabled due to the module not loading correctly or not. Raises: KeyError: if output class is already set for the corresponding name. """ output_name = output_class.NAME.lower() if disabled: class_dict = cls._disabled_output_classes else: class_dict = cls._output_classes if output_name in class_dict: raise KeyError(( 'Output class already set for name: {0:s}.').format( output_class.NAME)) class_dict[output_name] = output_class
[docs] @classmethod def RegisterOutputs(cls, output_classes, disabled=False): """Registers output classes. The output classes are identified based on their NAME attribute. Args: output_classes (list[type]): output module classes. disabled (Optional[bool]): True if the output module is disabled due to the module not loading correctly or not. Raises: KeyError: if output class is already set for the corresponding name. """ for output_class in output_classes: cls.RegisterOutput(output_class, disabled)