X ftdZddlZddlmZddlmZmZmZmZm Z m Z ddl m Z m Z ddlmZejeZGdde jje ZGd d e ZdS) zDefines the automagic interfaces for populating the context before a plugin runs. Automagic objects attempt to automatically fill configuration values that a user has not filled. N)ABCMeta)AnyListOptionalTupleTypeUnion) constants interfaces) requirementsceZdZdZdZ gZ dejjde ddffd Z ddejjde dej j d e jdeeef d Z ddejjde d ej j d eeeej j dfeej j fdedeee ej j ff dZxZS)AutomagicInterfaceaClass that defines an automagic component that can help fulfill `Requirements` These classes are callable with the following parameters: Args: context: The context in which to store configuration data that the automagic might populate config_path: Configuration path where the configurable's data under the context's config lives configurable: The top level configurable whose requirements may need satisfying progress_callback: An optional function accepting a percentage and optional description to indicate progress during long calculations .. note:: The `context` provided here may be different to that provided during initialization. The `context` provided at initialization should be used for local configuration of the automagic itself, the `context` provided during the call is to be populated by the automagic. context config_pathreturnNct|||D]R}t|tjjtjtj tj fstdSdS)NzpAutomagic requirements must be a SimpleTypeRequirement, ChoiceRequirement, ListRequirement or VersionRequirement) super__init__get_requirements isinstancer configurationSimpleTypeRequirementr ChoiceRequirementListRequirementVersionRequirement TypeError)selfrrargskwargs requirement __class__s \/home/panchajanya/Development/work/volatility3/volatility3/framework/interfaces/automagic.pyrzAutomagicInterface.__init__0s +...0022  K,B 2 0 3   G   r!progress_callbackcgS)z)Runs the automagic over the configurable.)rrrr!r%s r#__call__zAutomagicInterface.__call__Fs  r$Trequirement_rootrequirement_type.shortcutc Rtj||j}g}| }t ||r0|s|||r|||fnd}|r8|jD]} || ||| ||z }|S)aDetermines if there is actually an unfulfilled `Requirement` waiting. This ensures we do not carry out an expensive search when there is no need for a particular `Requirement` Args: context: Context on which to operate config_path: Configuration path of the top-level requirement requirement_root: Top-level requirement whose subrequirements will all be searched requirement_type: Type of requirement to find shortcut: Only returns requirements that live under unsatisfied requirements Returns: A list of tuples containing the config_path, sub_config_path and requirement identifying the unsatisfied `Requirements` T) r r path_joinnamer unsatisfiedappendr valuesfind_requirements) rrrr)r*r+sub_config_pathresultsrecursesubreqs r#r2z$AutomagicInterface.find_requirementsSs4%2<< ).  TV, &(8 9 9  D*66w LL D1ABCCCG  *7>>@@  411_f6Fr$N)T)__name__ __module__ __qualname____doc__priorityexclusion_listr rContextInterfacestrrrRequirementInterfacer ProgressCallbackrrrr(r rrboolr2 __classcell__)r"s@r#rrs&HGNh#4  69= #4 -B  %5  $s)  ,))#4))%2G )  $z/DEsJ K )> ? A )) eC1FFG H))))))))r$r) metaclassc eZdZUdZdZ gZeeed< e d de j j dede jdee jjfd Ze d ZdS) StackerLayerInterfacezClass that takes a lower layer and attempts to build on it. stack_order determines the order (from low to high) that stacking layers should be attempted lower levels should have lower `stack_orders` rr=Nr layer_namer%rcdS)aMethod to determine whether this builder can operate on the named layer. If so, modify the context appropriately. Returns the name of any new layer stacked on top of this layer or None. The stacking is therefore strictly linear rather than tree driven. Configuration options provided by the context are ignored, and defaults are to be used by this method to build a space where possible. Args: context: Context in which to construct the higher layer layer_name: Name of the layer to stack on top of progress_callback: A callback function to indicate progress through a scan (if one is necessary) Nr')clsrrGr%s r#stackzStackerLayerInterface.stacksr$c:tddS)NzgReads to this layer are slow, it's recommended to use the layerwriter plugin once to produce a raw file)vollogwarning)rIs r#stacker_slow_warningz*StackerLayerInterface.stacker_slow_warnings% u     r$r7)r8r9r:r; stack_orderr=rr?__annotations__ classmethodr rr>r rArlayersDataLayerInterfacerJrNr'r$r#rFrFsKG "NDI"""b 9=   #4  %5  *#6 7    [ *  [   r$rF)r;loggingabcrtypingrrrrrr volatility3.frameworkr r #volatility3.framework.configurationr getLoggerr8rLrConfigurableInterfacerrFr'r$r#r[s ::::::::::::::::77777777<<<<<<  8 $ $hhhhh2ghhhhV' ' ' ' ' g' ' ' ' ' ' r$