idx int64 0 251k | question stringlengths 53 3.53k | target stringlengths 5 1.23k | len_question int64 20 893 | len_target int64 3 238 |
|---|---|---|---|---|
16,700 | def wrapComponent ( comp ) : # if already wrapped, return object if hasattr ( comp , 'paint' ) : return comp # to avoid manually creating a mapping, get all classes in # this module, assume they are the class name appended with Q current_module = sys . modules [ __name__ ] module_classes = { name [ 1 : ] : obj for name , obj in inspect . getmembers ( sys . modules [ __name__ ] , inspect . isclass ) if obj . __module__ == __name__ } # print __name__, module_classes stimclass = comp . __class__ . __name__ qclass = module_classes . get ( stimclass , QStimulusComponent ) return qclass ( comp ) | Wraps a StimulusComponent with a class containing methods for painting and editing . Class will in fact be the same as the component provided but will also be a subclass of QStimulusComponent | 158 | 39 |
16,701 | def paint ( self , painter , rect , palette ) : painter . save ( ) image = img . default ( ) painter . drawImage ( rect , image ) # set text color painter . setPen ( QtGui . QPen ( QtCore . Qt . red ) ) painter . drawText ( rect , QtCore . Qt . AlignLeft , self . __class__ . __name__ ) painter . restore ( ) | Draws a generic visual representation for this component | 88 | 9 |
16,702 | def replace_tags ( cls , raw_filter ) : for k , v in iter ( cls . known_tags . items ( ) ) : raw_filter = raw_filter . replace ( k , v ) return raw_filter | Searches for known tags in the given string and replaces them with the corresponding regular expression . | 50 | 19 |
16,703 | def from_string ( cls , raw_filter , rule_limit ) : parsed_filter = cls . replace_tags ( raw_filter ) regexes = cls . build_regex_list ( parsed_filter , rule_limit ) return cls ( regexes ) | Creates a new Filter instance from the given string . | 60 | 11 |
16,704 | def values ( self ) : result = { } result [ 'fontsz' ] = self . ui . fontszSpnbx . value ( ) result [ 'display_attributes' ] = self . ui . detailWidget . getCheckedDetails ( ) return result | Gets user inputs | 59 | 4 |
16,705 | def flatten_args ( args : list , join = False , * , empty = ( None , [ ] , ( ) , '' ) ) -> list : flat_args = [ ] non_empty_args = ( arg for arg in args if arg not in empty ) for arg in non_empty_args : if isinstance ( arg , ( list , tuple ) ) : flat_args . extend ( flatten_args ( arg ) ) else : flat_args . append ( str ( arg ) ) if join : join = ' ' if join is True else join flat_args = join . join ( flat_args ) return flat_args | Flatten args and remove empty items . | 135 | 8 |
16,706 | def load_object ( obj ) -> object : if isinstance ( obj , str ) : if ':' in obj : module_name , obj_name = obj . split ( ':' ) if not module_name : module_name = '.' else : module_name = obj obj = importlib . import_module ( module_name ) if obj_name : attrs = obj_name . split ( '.' ) for attr in attrs : obj = getattr ( obj , attr ) return obj | Load an object . | 108 | 4 |
16,707 | def escape_args ( cls , * args ) : escaped_args = [ shlex . quote ( str ( arg ) ) for arg in args ] return " " . join ( escaped_args ) | Transforms the given list of unescaped arguments into a suitable shell - escaped str that is ready to be append to the command . | 42 | 27 |
16,708 | def pages_admin_menu ( context , page ) : request = context . get ( 'request' , None ) expanded = False if request and "tree_expanded" in request . COOKIES : cookie_string = urllib . unquote ( request . COOKIES [ 'tree_expanded' ] ) if cookie_string : ids = [ int ( id ) for id in urllib . unquote ( request . COOKIES [ 'tree_expanded' ] ) . split ( ',' ) ] if page . id in ids : expanded = True context . update ( { 'expanded' : expanded , 'page' : page } ) return context | Render the admin table of pages . | 144 | 7 |
16,709 | def findArgs ( args , prefixes ) : return list ( [ arg for arg in args if len ( [ p for p in prefixes if arg . lower ( ) . startswith ( p . lower ( ) ) ] ) > 0 ] ) | Extracts the list of arguments that start with any of the specified prefix values | 52 | 16 |
16,710 | def stripArgs ( args , blacklist ) : blacklist = [ b . lower ( ) for b in blacklist ] return list ( [ arg for arg in args if arg . lower ( ) not in blacklist ] ) | Removes any arguments in the supplied list that are contained in the specified blacklist | 42 | 15 |
16,711 | def capture ( command , input = None , cwd = None , shell = False , raiseOnError = False ) : # Attempt to execute the child process proc = subprocess . Popen ( command , stdin = subprocess . PIPE , stdout = subprocess . PIPE , stderr = subprocess . PIPE , cwd = cwd , shell = shell , universal_newlines = True ) ( stdout , stderr ) = proc . communicate ( input ) # If the child process failed and we were asked to raise an exception, do so if raiseOnError == True and proc . returncode != 0 : raise Exception ( 'child process ' + str ( command ) + ' failed with exit code ' + str ( proc . returncode ) + '\nstdout: "' + stdout + '"' + '\nstderr: "' + stderr + '"' ) return CommandOutput ( proc . returncode , stdout , stderr ) | Executes a child process and captures its output | 210 | 9 |
16,712 | def run ( command , cwd = None , shell = False , raiseOnError = False ) : returncode = subprocess . call ( command , cwd = cwd , shell = shell ) if raiseOnError == True and returncode != 0 : raise Exception ( 'child process ' + str ( command ) + ' failed with exit code ' + str ( returncode ) ) return returncode | Executes a child process and waits for it to complete | 82 | 11 |
16,713 | def setEngineRootOverride ( self , rootDir ) : # Set the new root directory ConfigurationManager . setConfigKey ( 'rootDirOverride' , os . path . abspath ( rootDir ) ) # Check that the specified directory is valid and warn the user if it is not try : self . getEngineVersion ( ) except : print ( 'Warning: the specified directory does not appear to contain a valid version of the Unreal Engine.' ) | Sets a user - specified directory as the root engine directory overriding any auto - detection | 91 | 17 |
16,714 | def getEngineRoot ( self ) : if not hasattr ( self , '_engineRoot' ) : self . _engineRoot = self . _getEngineRoot ( ) return self . _engineRoot | Returns the root directory location of the latest installed version of UE4 | 42 | 13 |
16,715 | def getEngineVersion ( self , outputFormat = 'full' ) : version = self . _getEngineVersionDetails ( ) formats = { 'major' : version [ 'MajorVersion' ] , 'minor' : version [ 'MinorVersion' ] , 'patch' : version [ 'PatchVersion' ] , 'full' : '{}.{}.{}' . format ( version [ 'MajorVersion' ] , version [ 'MinorVersion' ] , version [ 'PatchVersion' ] ) , 'short' : '{}.{}' . format ( version [ 'MajorVersion' ] , version [ 'MinorVersion' ] ) } # Verify that the requested output format is valid if outputFormat not in formats : raise Exception ( 'unreconised version output format "{}"' . format ( outputFormat ) ) return formats [ outputFormat ] | Returns the version number of the latest installed version of UE4 | 179 | 12 |
16,716 | def getEngineChangelist ( self ) : # Newer versions of the engine use the key "CompatibleChangelist", older ones use "Changelist" version = self . _getEngineVersionDetails ( ) if 'CompatibleChangelist' in version : return int ( version [ 'CompatibleChangelist' ] ) else : return int ( version [ 'Changelist' ] ) | Returns the compatible Perforce changelist identifier for the latest installed version of UE4 | 85 | 16 |
16,717 | def isInstalledBuild ( self ) : sentinelFile = os . path . join ( self . getEngineRoot ( ) , 'Engine' , 'Build' , 'InstalledBuild.txt' ) return os . path . exists ( sentinelFile ) | Determines if the Engine is an Installed Build | 54 | 11 |
16,718 | def getEditorBinary ( self , cmdVersion = False ) : return os . path . join ( self . getEngineRoot ( ) , 'Engine' , 'Binaries' , self . getPlatformIdentifier ( ) , 'UE4Editor' + self . _editorPathSuffix ( cmdVersion ) ) | Determines the location of the UE4Editor binary | 67 | 11 |
16,719 | def getProjectDescriptor ( self , dir ) : for project in glob . glob ( os . path . join ( dir , '*.uproject' ) ) : return os . path . realpath ( project ) # No project detected raise UnrealManagerException ( 'could not detect an Unreal project in the current directory' ) | Detects the . uproject descriptor file for the Unreal project in the specified directory | 68 | 16 |
16,720 | def getPluginDescriptor ( self , dir ) : for plugin in glob . glob ( os . path . join ( dir , '*.uplugin' ) ) : return os . path . realpath ( plugin ) # No plugin detected raise UnrealManagerException ( 'could not detect an Unreal plugin in the current directory' ) | Detects the . uplugin descriptor file for the Unreal plugin in the specified directory | 67 | 16 |
16,721 | def getDescriptor ( self , dir ) : try : return self . getProjectDescriptor ( dir ) except : try : return self . getPluginDescriptor ( dir ) except : raise UnrealManagerException ( 'could not detect an Unreal project or plugin in the directory "{}"' . format ( dir ) ) | Detects the descriptor file for either an Unreal project or an Unreal plugin in the specified directory | 67 | 18 |
16,722 | def listThirdPartyLibs ( self , configuration = 'Development' ) : interrogator = self . _getUE4BuildInterrogator ( ) return interrogator . list ( self . getPlatformIdentifier ( ) , configuration , self . _getLibraryOverrides ( ) ) | Lists the supported Unreal - bundled third - party libraries | 59 | 11 |
16,723 | def getThirdpartyLibs ( self , libs , configuration = 'Development' , includePlatformDefaults = True ) : if includePlatformDefaults == True : libs = self . _defaultThirdpartyLibs ( ) + libs interrogator = self . _getUE4BuildInterrogator ( ) return interrogator . interrogate ( self . getPlatformIdentifier ( ) , configuration , libs , self . _getLibraryOverrides ( ) ) | Retrieves the ThirdPartyLibraryDetails instance for Unreal - bundled versions of the specified third - party libraries | 97 | 21 |
16,724 | def getThirdPartyLibCompilerFlags ( self , libs ) : fmt = PrintingFormat . singleLine ( ) if libs [ 0 ] == '--multiline' : fmt = PrintingFormat . multiLine ( ) libs = libs [ 1 : ] platformDefaults = True if libs [ 0 ] == '--nodefaults' : platformDefaults = False libs = libs [ 1 : ] details = self . getThirdpartyLibs ( libs , includePlatformDefaults = platformDefaults ) return details . getCompilerFlags ( self . getEngineRoot ( ) , fmt ) | Retrieves the compiler flags for building against the Unreal - bundled versions of the specified third - party libraries | 130 | 21 |
16,725 | def getThirdPartyLibLinkerFlags ( self , libs ) : fmt = PrintingFormat . singleLine ( ) if libs [ 0 ] == '--multiline' : fmt = PrintingFormat . multiLine ( ) libs = libs [ 1 : ] includeLibs = True if ( libs [ 0 ] == '--flagsonly' ) : includeLibs = False libs = libs [ 1 : ] platformDefaults = True if libs [ 0 ] == '--nodefaults' : platformDefaults = False libs = libs [ 1 : ] details = self . getThirdpartyLibs ( libs , includePlatformDefaults = platformDefaults ) return details . getLinkerFlags ( self . getEngineRoot ( ) , fmt , includeLibs ) | Retrieves the linker flags for building against the Unreal - bundled versions of the specified third - party libraries | 169 | 22 |
16,726 | def getThirdPartyLibCmakeFlags ( self , libs ) : fmt = PrintingFormat . singleLine ( ) if libs [ 0 ] == '--multiline' : fmt = PrintingFormat . multiLine ( ) libs = libs [ 1 : ] platformDefaults = True if libs [ 0 ] == '--nodefaults' : platformDefaults = False libs = libs [ 1 : ] details = self . getThirdpartyLibs ( libs , includePlatformDefaults = platformDefaults ) CMakeCustomFlags . processLibraryDetails ( details ) return details . getCMakeFlags ( self . getEngineRoot ( ) , fmt ) | Retrieves the CMake invocation flags for building against the Unreal - bundled versions of the specified third - party libraries | 141 | 23 |
16,727 | def getThirdPartyLibIncludeDirs ( self , libs ) : platformDefaults = True if libs [ 0 ] == '--nodefaults' : platformDefaults = False libs = libs [ 1 : ] details = self . getThirdpartyLibs ( libs , includePlatformDefaults = platformDefaults ) return details . getIncludeDirectories ( self . getEngineRoot ( ) , delimiter = '\n' ) | Retrieves the list of include directories for building against the Unreal - bundled versions of the specified third - party libraries | 97 | 23 |
16,728 | def getThirdPartyLibFiles ( self , libs ) : platformDefaults = True if libs [ 0 ] == '--nodefaults' : platformDefaults = False libs = libs [ 1 : ] details = self . getThirdpartyLibs ( libs , includePlatformDefaults = platformDefaults ) return details . getLibraryFiles ( self . getEngineRoot ( ) , delimiter = '\n' ) | Retrieves the list of library files for building against the Unreal - bundled versions of the specified third - party libraries | 92 | 23 |
16,729 | def getThirdPartyLibDefinitions ( self , libs ) : platformDefaults = True if libs [ 0 ] == '--nodefaults' : platformDefaults = False libs = libs [ 1 : ] details = self . getThirdpartyLibs ( libs , includePlatformDefaults = platformDefaults ) return details . getPreprocessorDefinitions ( self . getEngineRoot ( ) , delimiter = '\n' ) | Retrieves the list of preprocessor definitions for building against the Unreal - bundled versions of the specified third - party libraries | 95 | 24 |
16,730 | def generateProjectFiles ( self , dir = os . getcwd ( ) , args = [ ] ) : # If the project is a pure Blueprint project, then we cannot generate project files if os . path . exists ( os . path . join ( dir , 'Source' ) ) == False : Utility . printStderr ( 'Pure Blueprint project, nothing to generate project files for.' ) return # Generate the project files genScript = self . getGenerateScript ( ) projectFile = self . getProjectDescriptor ( dir ) Utility . run ( [ genScript , '-project=' + projectFile , '-game' , '-engine' ] + args , cwd = os . path . dirname ( genScript ) , raiseOnError = True ) | Generates IDE project files for the Unreal project in the specified directory | 162 | 13 |
16,731 | def cleanDescriptor ( self , dir = os . getcwd ( ) ) : # Verify that an Unreal project or plugin exists in the specified directory descriptor = self . getDescriptor ( dir ) # Because performing a clean will also delete the engine build itself when using # a source build, we simply delete the `Binaries` and `Intermediate` directories shutil . rmtree ( os . path . join ( dir , 'Binaries' ) , ignore_errors = True ) shutil . rmtree ( os . path . join ( dir , 'Intermediate' ) , ignore_errors = True ) # If we are cleaning a project, also clean any plugins if self . isProject ( descriptor ) : projectPlugins = glob . glob ( os . path . join ( dir , 'Plugins' , '*' ) ) for pluginDir in projectPlugins : self . cleanDescriptor ( pluginDir ) | Cleans the build artifacts for the Unreal project or plugin in the specified directory | 197 | 15 |
16,732 | def buildDescriptor ( self , dir = os . getcwd ( ) , configuration = 'Development' , args = [ ] , suppressOutput = False ) : # Verify that an Unreal project or plugin exists in the specified directory descriptor = self . getDescriptor ( dir ) descriptorType = 'project' if self . isProject ( descriptor ) else 'plugin' # If the project or plugin is Blueprint-only, there is no C++ code to build if os . path . exists ( os . path . join ( dir , 'Source' ) ) == False : Utility . printStderr ( 'Pure Blueprint {}, nothing to build.' . format ( descriptorType ) ) return # Verify that the specified build configuration is valid if configuration not in self . validBuildConfigurations ( ) : raise UnrealManagerException ( 'invalid build configuration "' + configuration + '"' ) # Generate the arguments to pass to UBT target = self . getDescriptorName ( descriptor ) + 'Editor' if self . isProject ( descriptor ) else 'UE4Editor' baseArgs = [ '-{}=' . format ( descriptorType ) + descriptor ] # Perform the build self . _runUnrealBuildTool ( target , self . getPlatformIdentifier ( ) , configuration , baseArgs + args , capture = suppressOutput ) | Builds the editor modules for the Unreal project or plugin in the specified directory using the specified build configuration | 276 | 20 |
16,733 | def runUAT ( self , args ) : Utility . run ( [ self . getRunUATScript ( ) ] + args , cwd = self . getEngineRoot ( ) , raiseOnError = True ) | Runs the Unreal Automation Tool with the supplied arguments | 45 | 11 |
16,734 | def packageProject ( self , dir = os . getcwd ( ) , configuration = 'Shipping' , extraArgs = [ ] ) : # Verify that the specified build configuration is valid if configuration not in self . validBuildConfigurations ( ) : raise UnrealManagerException ( 'invalid build configuration "' + configuration + '"' ) # Strip out the `-NoCompileEditor` flag if the user has specified it, since the Development version # of the Editor modules for the project are needed in order to run the commandlet that cooks content extraArgs = Utility . stripArgs ( extraArgs , [ '-nocompileeditor' ] ) # Prevent the user from specifying multiple `-platform=` or `-targetplatform=` arguments, # and use the current host platform if no platform argument was explicitly specified platformArgs = Utility . findArgs ( extraArgs , [ '-platform=' , '-targetplatform=' ] ) platform = Utility . getArgValue ( platformArgs [ 0 ] ) if len ( platformArgs ) > 0 else self . getPlatformIdentifier ( ) extraArgs = Utility . stripArgs ( extraArgs , platformArgs ) + [ '-platform={}' . format ( platform ) ] # If we are packaging a Shipping build, do not include debug symbols if configuration == 'Shipping' : extraArgs . append ( '-nodebuginfo' ) # Do not create a .pak file when packaging for HTML5 pakArg = '-package' if platform . upper ( ) == 'HTML5' else '-pak' # Invoke UAT to package the build distDir = os . path . join ( os . path . abspath ( dir ) , 'dist' ) self . runUAT ( [ 'BuildCookRun' , '-utf8output' , '-clientconfig=' + configuration , '-serverconfig=' + configuration , '-project=' + self . getProjectDescriptor ( dir ) , '-noP4' , '-cook' , '-allmaps' , '-build' , '-stage' , '-prereqs' , pakArg , '-archive' , '-archivedirectory=' + distDir ] + extraArgs ) | Packages a build of the Unreal project in the specified directory using common packaging options | 464 | 16 |
16,735 | def packagePlugin ( self , dir = os . getcwd ( ) , extraArgs = [ ] ) : # Invoke UAT to package the build distDir = os . path . join ( os . path . abspath ( dir ) , 'dist' ) self . runUAT ( [ 'BuildPlugin' , '-Plugin=' + self . getPluginDescriptor ( dir ) , '-Package=' + distDir ] + extraArgs ) | Packages a build of the Unreal plugin in the specified directory suitable for use as a prebuilt Engine module | 95 | 21 |
16,736 | def packageDescriptor ( self , dir = os . getcwd ( ) , args = [ ] ) : # Verify that an Unreal project or plugin exists in the specified directory descriptor = self . getDescriptor ( dir ) # Perform the packaging step if self . isProject ( descriptor ) : self . packageProject ( dir , args [ 0 ] if len ( args ) > 0 else 'Shipping' , args [ 1 : ] ) else : self . packagePlugin ( dir , args ) | Packages a build of the Unreal project or plugin in the specified directory | 102 | 14 |
16,737 | def runAutomationCommands ( self , projectFile , commands , capture = False ) : # IMPORTANT IMPLEMENTATION NOTE: # We need to format the command as a string and execute it using a shell in order to # ensure the "-ExecCmds" argument will be parsed correctly under Windows. This is because # the WinMain() function uses GetCommandLineW() to retrieve the raw command-line string, # rather than using an argv-style structure. The string is then passed to FParse::Value(), # which checks for the presence of a quote character after the equals sign to determine if # whitespace should be stripped or preserved. Without the quote character, the spaces in the # argument payload will be stripped out, corrupting our list of automation commands and # preventing them from executing correctly. command = '{} {}' . format ( Utility . escapePathForShell ( self . getEditorBinary ( True ) ) , Utility . escapePathForShell ( projectFile ) ) command += ' -game -buildmachine -stdout -fullstdoutlogoutput -forcelogflush -unattended -nopause -nullrhi -nosplash' command += ' -ExecCmds="automation {};quit"' . format ( ';' . join ( commands ) ) if capture == True : return Utility . capture ( command , shell = True ) else : Utility . run ( command , shell = True ) | Invokes the Automation Test commandlet for the specified project with the supplied automation test commands | 301 | 18 |
16,738 | def _getEngineVersionDetails ( self ) : versionFile = os . path . join ( self . getEngineRoot ( ) , 'Engine' , 'Build' , 'Build.version' ) return json . loads ( Utility . readFile ( versionFile ) ) | Parses the JSON version details for the latest installed version of UE4 | 55 | 15 |
16,739 | def _getEngineVersionHash ( self ) : versionDetails = self . _getEngineVersionDetails ( ) hash = hashlib . sha256 ( ) hash . update ( json . dumps ( versionDetails , sort_keys = True , indent = 0 ) . encode ( 'utf-8' ) ) return hash . hexdigest ( ) | Computes the SHA - 256 hash of the JSON version details for the latest installed version of UE4 | 71 | 20 |
16,740 | def _runUnrealBuildTool ( self , target , platform , configuration , args , capture = False ) : platform = self . _transformBuildToolPlatform ( platform ) arguments = [ self . getBuildScript ( ) , target , platform , configuration ] + args if capture == True : return Utility . capture ( arguments , cwd = self . getEngineRoot ( ) , raiseOnError = True ) else : Utility . run ( arguments , cwd = self . getEngineRoot ( ) , raiseOnError = True ) | Invokes UnrealBuildTool with the specified parameters | 108 | 9 |
16,741 | def _getUE4BuildInterrogator ( self ) : ubtLambda = lambda target , platform , config , args : self . _runUnrealBuildTool ( target , platform , config , args , True ) interrogator = UE4BuildInterrogator ( self . getEngineRoot ( ) , self . _getEngineVersionDetails ( ) , self . _getEngineVersionHash ( ) , ubtLambda ) return interrogator | Uses UE4BuildInterrogator to interrogate UnrealBuildTool about third - party library details | 94 | 20 |
16,742 | def getKey ( self , key ) : data = self . getDictionary ( ) if key in data : return data [ key ] else : return None | Retrieves the value for the specified dictionary key | 32 | 10 |
16,743 | def getDictionary ( self ) : if os . path . exists ( self . jsonFile ) : return json . loads ( Utility . readFile ( self . jsonFile ) ) else : return { } | Retrieves the entire data dictionary | 42 | 7 |
16,744 | def setKey ( self , key , value ) : data = self . getDictionary ( ) data [ key ] = value self . setDictionary ( data ) | Sets the value for the specified dictionary key | 34 | 9 |
16,745 | def setDictionary ( self , data ) : # Create the directory containing the JSON file if it doesn't already exist jsonDir = os . path . dirname ( self . jsonFile ) if os . path . exists ( jsonDir ) == False : os . makedirs ( jsonDir ) # Store the dictionary Utility . writeFile ( self . jsonFile , json . dumps ( data ) ) | Overwrites the entire dictionary | 82 | 6 |
16,746 | def list ( self , platformIdentifier , configuration , libOverrides = { } ) : modules = self . _getThirdPartyLibs ( platformIdentifier , configuration ) return sorted ( [ m [ 'Name' ] for m in modules ] + [ key for key in libOverrides ] ) | Returns the list of supported UE4 - bundled third - party libraries | 64 | 13 |
16,747 | def interrogate ( self , platformIdentifier , configuration , libraries , libOverrides = { } ) : # Determine which libraries need their modules parsed by UBT, and which are override-only libModules = list ( [ lib for lib in libraries if lib not in libOverrides ] ) # Check that we have at least one module to parse details = ThirdPartyLibraryDetails ( ) if len ( libModules ) > 0 : # Retrieve the list of third-party library modules from UnrealBuildTool modules = self . _getThirdPartyLibs ( platformIdentifier , configuration ) # Filter the list of modules to include only those that were requested modules = [ m for m in modules if m [ 'Name' ] in libModules ] # Emit a warning if any of the requested modules are not supported names = [ m [ 'Name' ] for m in modules ] unsupported = [ '"' + m + '"' for m in libModules if m not in names ] if len ( unsupported ) > 0 : Utility . printStderr ( 'Warning: unsupported libraries ' + ',' . join ( unsupported ) ) # Some libraries are listed as just the filename without the leading directory (especially prevalent under Windows) for module in modules : if len ( module [ 'PublicAdditionalLibraries' ] ) > 0 and len ( module [ 'PublicLibraryPaths' ] ) > 0 : libPath = ( self . _absolutePaths ( module [ 'PublicLibraryPaths' ] ) ) [ 0 ] libs = list ( [ lib . replace ( '\\' , '/' ) for lib in module [ 'PublicAdditionalLibraries' ] ] ) libs = list ( [ os . path . join ( libPath , lib ) if '/' not in lib else lib for lib in libs ] ) module [ 'PublicAdditionalLibraries' ] = libs # Flatten the lists of paths fields = [ 'Directory' , 'PublicAdditionalLibraries' , 'PublicLibraryPaths' , 'PublicSystemIncludePaths' , 'PublicIncludePaths' , 'PrivateIncludePaths' , 'PublicDefinitions' ] flattened = { } for field in fields : transform = ( lambda l : self . _absolutePaths ( l ) ) if field != 'Definitions' else None flattened [ field ] = self . _flatten ( field , modules , transform ) # Compose the prefix directories from the module root directories, the header and library paths, and their direct parent directories libraryDirectories = flattened [ 'PublicLibraryPaths' ] headerDirectories = flattened [ 'PublicSystemIncludePaths' ] + flattened [ 'PublicIncludePaths' ] + flattened [ 'PrivateIncludePaths' ] modulePaths = flattened [ 'Directory' ] prefixDirectories = list ( set ( flattened [ 'Directory' ] + headerDirectories + libraryDirectories + [ os . path . dirname ( p ) for p in headerDirectories + libraryDirectories ] ) ) # Wrap the results in a ThirdPartyLibraryDetails instance, converting any relative directory paths into absolute ones details = ThirdPartyLibraryDetails ( prefixDirs = prefixDirectories , includeDirs = headerDirectories , linkDirs = libraryDirectories , definitions = flattened [ 'PublicDefinitions' ] , libs = flattened [ 'PublicAdditionalLibraries' ] ) # Apply any overrides overridesToApply = list ( [ libOverrides [ lib ] for lib in libraries if lib in libOverrides ] ) for override in overridesToApply : details . merge ( override ) return details | Interrogates UnrealBuildTool about the build flags for the specified third - party libraries | 756 | 17 |
16,748 | def _flatten ( self , field , items , transform = None ) : # Retrieve the value for each item in the iterable values = [ item [ field ] for item in items ] # Flatten any nested lists flattened = [ ] for value in values : flattened . extend ( [ value ] if isinstance ( value , str ) else value ) # Apply any supplied transformation function return transform ( flattened ) if transform != None else flattened | Extracts the entry field from each item in the supplied iterable flattening any nested lists | 90 | 19 |
16,749 | def _getThirdPartyLibs ( self , platformIdentifier , configuration ) : # If we have previously cached the library list for the current engine version, use the cached data cachedList = CachedDataManager . getCachedDataKey ( self . engineVersionHash , 'ThirdPartyLibraries' ) if cachedList != None : return cachedList # Create a temp directory to hold the JSON file tempDir = tempfile . mkdtemp ( ) jsonFile = os . path . join ( tempDir , 'ubt_output.json' ) # Installed Builds of the Engine only contain a small handful of third-party libraries, rather than the full set # included in a source build of the Engine. However, if the ThirdParty directory from a source build is copied # into an Installed Build and the `InstalledBuild.txt` sentinel file is temporarily renamed, we can get the best # of both worlds and utilise the full set of third-party libraries. Enable this sentinel renaming behaviour only # if you have copied the ThirdParty directory from a source build into your Installed Build, or else the UBT # command will fail trying to rebuild UnrealHeaderTool. sentinelFile = os . path . join ( self . engineRoot , 'Engine' , 'Build' , 'InstalledBuild.txt' ) sentinelBackup = sentinelFile + '.bak' renameSentinel = os . path . exists ( sentinelFile ) and os . environ . get ( 'UE4CLI_SENTINEL_RENAME' , '0' ) == '1' if renameSentinel == True : shutil . move ( sentinelFile , sentinelBackup ) # Invoke UnrealBuildTool in JSON export mode (make sure we specify gathering mode, since this is a prerequisite of JSON export) # (Ensure we always perform sentinel file cleanup even when errors occur) try : args = [ '-Mode=JsonExport' , '-OutputFile=' + jsonFile ] if self . engineVersion [ 'MinorVersion' ] >= 22 else [ '-gather' , '-jsonexport=' + jsonFile , '-SkipBuild' ] self . runUBTFunc ( 'UE4Editor' , platformIdentifier , configuration , args ) finally : if renameSentinel == True : shutil . move ( sentinelBackup , sentinelFile ) # Parse the JSON output result = json . loads ( Utility . readFile ( jsonFile ) ) # Extract the list of third-party library modules # (Note that since UE4.21, modules no longer have a "Type" field, so we must # rely on the "Directory" field filter below to identify third-party libraries) modules = [ result [ 'Modules' ] [ key ] for key in result [ 'Modules' ] ] # Filter out any modules from outside the Engine/Source/ThirdParty directory thirdPartyRoot = os . path . join ( self . engineRoot , 'Engine' , 'Source' , 'ThirdParty' ) thirdparty = list ( [ m for m in modules if thirdPartyRoot in m [ 'Directory' ] ] ) # Remove the temp directory try : shutil . rmtree ( tempDir ) except : pass # Cache the list of libraries for use by subsequent runs CachedDataManager . setCachedDataKey ( self . engineVersionHash , 'ThirdPartyLibraries' , thirdparty ) return thirdparty | Runs UnrealBuildTool in JSON export mode and extracts the list of third - party libraries | 729 | 18 |
16,750 | def processLibraryDetails ( details ) : # If the header include directories list contains any directories we have flags for, add them for includeDir in details . includeDirs : # If the directory path matches any of the substrings in our list, generate the relevant flags for pattern in CUSTOM_FLAGS_FOR_INCLUDE_DIRS : if pattern in includeDir : flag = '-D' + CUSTOM_FLAGS_FOR_INCLUDE_DIRS [ pattern ] + '=' + includeDir details . cmakeFlags . append ( flag ) # If the libraries list contains any libs we have flags for, add them for lib in details . libs : # Extract the name of the library from the filename # (We remove any "lib" prefix or numerical suffix) filename = os . path . basename ( lib ) ( name , ext ) = os . path . splitext ( filename ) libName = name . replace ( 'lib' , '' ) if name . startswith ( 'lib' ) else name libName = libName . rstrip ( '_-1234567890' ) # If the library name matches one in our list, generate its flag if libName in CUSTOM_FLAGS_FOR_LIBS : flag = '-D' + CUSTOM_FLAGS_FOR_LIBS [ libName ] + '=' + lib details . cmakeFlags . append ( flag ) | Processes the supplied ThirdPartyLibraryDetails instance and sets any custom CMake flags | 306 | 16 |
16,751 | def getPlugins ( ) : # Retrieve the list of detected entry points in the ue4cli.plugins group plugins = { entry_point . name : entry_point . load ( ) for entry_point in pkg_resources . iter_entry_points ( 'ue4cli.plugins' ) } # Filter out any invalid plugins plugins = { name : plugins [ name ] for name in plugins if 'action' in plugins [ name ] and 'description' in plugins [ name ] and 'args' in plugins [ name ] and callable ( plugins [ name ] [ 'action' ] ) == True and len ( signature ( plugins [ name ] [ 'action' ] ) . parameters ) == 2 } return plugins | Returns the list of valid ue4cli plugins | 151 | 10 |
16,752 | def getCompilerFlags ( self , engineRoot , fmt ) : return Utility . join ( fmt . delim , self . prefixedStrings ( self . definitionPrefix , self . definitions , engineRoot ) + self . prefixedStrings ( self . includeDirPrefix , self . includeDirs , engineRoot ) + self . resolveRoot ( self . cxxFlags , engineRoot ) , fmt . quotes ) | Constructs the compiler flags string for building against this library | 87 | 11 |
16,753 | def getLinkerFlags ( self , engineRoot , fmt , includeLibs = True ) : components = self . resolveRoot ( self . ldFlags , engineRoot ) if includeLibs == True : components . extend ( self . prefixedStrings ( self . linkerDirPrefix , self . linkDirs , engineRoot ) ) components . extend ( self . resolveRoot ( self . libs , engineRoot ) ) return Utility . join ( fmt . delim , components , fmt . quotes ) | Constructs the linker flags string for building against this library | 105 | 12 |
16,754 | def getPrefixDirectories ( self , engineRoot , delimiter = ' ' ) : return delimiter . join ( self . resolveRoot ( self . prefixDirs , engineRoot ) ) | Returns the list of prefix directories for this library joined using the specified delimiter | 40 | 15 |
16,755 | def getIncludeDirectories ( self , engineRoot , delimiter = ' ' ) : return delimiter . join ( self . resolveRoot ( self . includeDirs , engineRoot ) ) | Returns the list of include directories for this library joined using the specified delimiter | 40 | 15 |
16,756 | def getLinkerDirectories ( self , engineRoot , delimiter = ' ' ) : return delimiter . join ( self . resolveRoot ( self . linkDirs , engineRoot ) ) | Returns the list of linker directories for this library joined using the specified delimiter | 40 | 16 |
16,757 | def getLibraryFiles ( self , engineRoot , delimiter = ' ' ) : return delimiter . join ( self . resolveRoot ( self . libs , engineRoot ) ) | Returns the list of library files for this library joined using the specified delimiter | 37 | 15 |
16,758 | def getPreprocessorDefinitions ( self , engineRoot , delimiter = ' ' ) : return delimiter . join ( self . resolveRoot ( self . definitions , engineRoot ) ) | Returns the list of preprocessor definitions for this library joined using the specified delimiter | 38 | 16 |
16,759 | def getCMakeFlags ( self , engineRoot , fmt ) : return Utility . join ( fmt . delim , [ '-DCMAKE_PREFIX_PATH=' + self . getPrefixDirectories ( engineRoot , ';' ) , '-DCMAKE_INCLUDE_PATH=' + self . getIncludeDirectories ( engineRoot , ';' ) , '-DCMAKE_LIBRARY_PATH=' + self . getLinkerDirectories ( engineRoot , ';' ) , ] + self . resolveRoot ( self . cmakeFlags , engineRoot ) , fmt . quotes ) | Constructs the CMake invocation flags string for building against this library | 133 | 13 |
16,760 | def is_changed ( ) : executed , changed_lines = execute_git ( 'status --porcelain' , output = False ) merge_not_finished = mod_path . exists ( '.git/MERGE_HEAD' ) return changed_lines . strip ( ) or merge_not_finished | Checks if current project has any noncommited changes . | 64 | 12 |
16,761 | def user_agent ( ) : client_name = 'unknown_client_name' try : client_name = os . environ . get ( "EDX_REST_API_CLIENT_NAME" ) or socket . gethostbyname ( socket . gethostname ( ) ) except : # pylint: disable=bare-except pass # using 'unknown_client_name' is good enough. no need to log. return "{} edx-rest-api-client/{} {}" . format ( requests . utils . default_user_agent ( ) , # e.g. "python-requests/2.9.1" __version__ , # version of this client client_name ) | Return a User - Agent that identifies this client . | 155 | 10 |
16,762 | def get_oauth_access_token ( url , client_id , client_secret , token_type = 'jwt' , grant_type = 'client_credentials' , refresh_token = None ) : now = datetime . datetime . utcnow ( ) data = { 'grant_type' : grant_type , 'client_id' : client_id , 'client_secret' : client_secret , 'token_type' : token_type , } if refresh_token : data [ 'refresh_token' ] = refresh_token else : assert grant_type != 'refresh_token' , "refresh_token parameter required" response = requests . post ( url , data = data , headers = { 'User-Agent' : USER_AGENT , } , ) data = response . json ( ) try : access_token = data [ 'access_token' ] expires_in = data [ 'expires_in' ] except KeyError : raise requests . RequestException ( response = response ) expires_at = now + datetime . timedelta ( seconds = expires_in ) return access_token , expires_at | Retrieves OAuth 2 . 0 access token using the given grant type . | 250 | 16 |
16,763 | def request ( self , method , url , * * kwargs ) : # pylint: disable=arguments-differ self . _check_auth ( ) return super ( OAuthAPIClient , self ) . request ( method , url , * * kwargs ) | Overrides Session . request to ensure that the session is authenticated | 61 | 13 |
16,764 | def run_command ( self , scan_id , host , cmd ) : ssh = paramiko . SSHClient ( ) ssh . set_missing_host_key_policy ( paramiko . AutoAddPolicy ( ) ) options = self . get_scan_options ( scan_id ) port = int ( options [ 'port' ] ) timeout = int ( options [ 'ssh_timeout' ] ) # For backward compatibility, consider the legacy mode to get # credentials as scan_option. # First and second modes should be removed in future releases. # On the third case it receives the credentials as a subelement of # the <target>. credentials = self . get_scan_credentials ( scan_id , host ) if ( 'username_password' in options and ':' in options [ 'username_password' ] ) : username , password = options [ 'username_password' ] . split ( ':' , 1 ) elif 'username' in options and options [ 'username' ] : username = options [ 'username' ] password = options [ 'password' ] elif credentials : cred_params = credentials . get ( 'ssh' ) username = cred_params . get ( 'username' , '' ) password = cred_params . get ( 'password' , '' ) else : self . add_scan_error ( scan_id , host = host , value = 'Erroneous username_password value' ) raise ValueError ( 'Erroneous username_password value' ) try : ssh . connect ( hostname = host , username = username , password = password , timeout = timeout , port = port ) except ( paramiko . ssh_exception . AuthenticationException , socket . error ) as err : # Errors: No route to host, connection timeout, authentication # failure etc,. self . add_scan_error ( scan_id , host = host , value = str ( err ) ) return None _ , stdout , _ = ssh . exec_command ( cmd ) result = stdout . readlines ( ) ssh . close ( ) return result | Run a single command via SSH and return the content of stdout or None in case of an Error . A scan error is issued in the latter case . | 432 | 31 |
16,765 | def get_result_xml ( result ) : result_xml = Element ( 'result' ) for name , value in [ ( 'name' , result [ 'name' ] ) , ( 'type' , ResultType . get_str ( result [ 'type' ] ) ) , ( 'severity' , result [ 'severity' ] ) , ( 'host' , result [ 'host' ] ) , ( 'test_id' , result [ 'test_id' ] ) , ( 'port' , result [ 'port' ] ) , ( 'qod' , result [ 'qod' ] ) ] : result_xml . set ( name , str ( value ) ) result_xml . text = result [ 'value' ] return result_xml | Formats a scan result to XML format . | 163 | 9 |
16,766 | def simple_response_str ( command , status , status_text , content = "" ) : response = Element ( '%s_response' % command ) for name , value in [ ( 'status' , str ( status ) ) , ( 'status_text' , status_text ) ] : response . set ( name , str ( value ) ) if isinstance ( content , list ) : for elem in content : response . append ( elem ) elif isinstance ( content , Element ) : response . append ( content ) else : response . text = content return tostring ( response ) | Creates an OSP response XML string . | 125 | 9 |
16,767 | def close_client_stream ( client_stream , unix_path ) : try : client_stream . shutdown ( socket . SHUT_RDWR ) if unix_path : logger . debug ( '%s: Connection closed' , unix_path ) else : peer = client_stream . getpeername ( ) logger . debug ( '%s:%s: Connection closed' , peer [ 0 ] , peer [ 1 ] ) except ( socket . error , OSError ) as exception : logger . debug ( 'Connection closing error: %s' , exception ) client_stream . close ( ) | Closes provided client stream | 130 | 5 |
16,768 | def set_command_attributes ( self , name , attributes ) : if self . command_exists ( name ) : command = self . commands . get ( name ) command [ 'attributes' ] = attributes | Sets the xml attributes of a specified command . | 45 | 10 |
16,769 | def add_scanner_param ( self , name , scanner_param ) : assert name assert scanner_param self . scanner_params [ name ] = scanner_param command = self . commands . get ( 'start_scan' ) command [ 'elements' ] = { 'scanner_params' : { k : v [ 'name' ] for k , v in self . scanner_params . items ( ) } } | Add a scanner parameter . | 90 | 5 |
16,770 | def add_vt ( self , vt_id , name = None , vt_params = None , vt_refs = None , custom = None , vt_creation_time = None , vt_modification_time = None , vt_dependencies = None , summary = None , impact = None , affected = None , insight = None , solution = None , solution_t = None , detection = None , qod_t = None , qod_v = None , severities = None ) : if not vt_id : return - 2 # no valid vt_id if self . vt_id_pattern . fullmatch ( vt_id ) is None : return - 2 # no valid vt_id if vt_id in self . vts : return - 1 # The VT was already in the list. if name is None : name = '' self . vts [ vt_id ] = { 'name' : name } if custom is not None : self . vts [ vt_id ] [ "custom" ] = custom if vt_params is not None : self . vts [ vt_id ] [ "vt_params" ] = vt_params if vt_refs is not None : self . vts [ vt_id ] [ "vt_refs" ] = vt_refs if vt_dependencies is not None : self . vts [ vt_id ] [ "vt_dependencies" ] = vt_dependencies if vt_creation_time is not None : self . vts [ vt_id ] [ "creation_time" ] = vt_creation_time if vt_modification_time is not None : self . vts [ vt_id ] [ "modification_time" ] = vt_modification_time if summary is not None : self . vts [ vt_id ] [ "summary" ] = summary if impact is not None : self . vts [ vt_id ] [ "impact" ] = impact if affected is not None : self . vts [ vt_id ] [ "affected" ] = affected if insight is not None : self . vts [ vt_id ] [ "insight" ] = insight if solution is not None : self . vts [ vt_id ] [ "solution" ] = solution if solution_t is not None : self . vts [ vt_id ] [ "solution_type" ] = solution_t if detection is not None : self . vts [ vt_id ] [ "detection" ] = detection if qod_t is not None : self . vts [ vt_id ] [ "qod_type" ] = qod_t elif qod_v is not None : self . vts [ vt_id ] [ "qod" ] = qod_v if severities is not None : self . vts [ vt_id ] [ "severities" ] = severities return len ( self . vts ) | Add a vulnerability test information . | 672 | 6 |
16,771 | def _preprocess_scan_params ( self , xml_params ) : params = { } for param in xml_params : params [ param . tag ] = param . text or '' # Set default values. for key in self . scanner_params : if key not in params : params [ key ] = self . get_scanner_param_default ( key ) if self . get_scanner_param_type ( key ) == 'selection' : params [ key ] = params [ key ] . split ( '|' ) [ 0 ] # Validate values. for key in params : param_type = self . get_scanner_param_type ( key ) if not param_type : continue if param_type in [ 'integer' , 'boolean' ] : try : params [ key ] = int ( params [ key ] ) except ValueError : raise OSPDError ( 'Invalid %s value' % key , 'start_scan' ) if param_type == 'boolean' : if params [ key ] not in [ 0 , 1 ] : raise OSPDError ( 'Invalid %s value' % key , 'start_scan' ) elif param_type == 'selection' : selection = self . get_scanner_param_default ( key ) . split ( '|' ) if params [ key ] not in selection : raise OSPDError ( 'Invalid %s value' % key , 'start_scan' ) if self . get_scanner_param_mandatory ( key ) and params [ key ] == '' : raise OSPDError ( 'Mandatory %s value is missing' % key , 'start_scan' ) return params | Processes the scan parameters . | 363 | 6 |
16,772 | def process_vts_params ( self , scanner_vts ) : vt_selection = { } filters = list ( ) for vt in scanner_vts : if vt . tag == 'vt_single' : vt_id = vt . attrib . get ( 'id' ) vt_selection [ vt_id ] = { } for vt_value in vt : if not vt_value . attrib . get ( 'id' ) : raise OSPDError ( 'Invalid VT preference. No attribute id' , 'start_scan' ) vt_value_id = vt_value . attrib . get ( 'id' ) vt_value_value = vt_value . text if vt_value . text else '' vt_selection [ vt_id ] [ vt_value_id ] = vt_value_value if vt . tag == 'vt_group' : vts_filter = vt . attrib . get ( 'filter' , None ) if vts_filter is None : raise OSPDError ( 'Invalid VT group. No filter given.' , 'start_scan' ) filters . append ( vts_filter ) vt_selection [ 'vt_groups' ] = filters return vt_selection | Receive an XML object with the Vulnerability Tests an their parameters to be use in a scan and return a dictionary . | 285 | 24 |
16,773 | def process_credentials_elements ( cred_tree ) : credentials = { } for credential in cred_tree : service = credential . attrib . get ( 'service' ) credentials [ service ] = { } credentials [ service ] [ 'type' ] = credential . attrib . get ( 'type' ) if service == 'ssh' : credentials [ service ] [ 'port' ] = credential . attrib . get ( 'port' ) for param in credential : credentials [ service ] [ param . tag ] = param . text return credentials | Receive an XML object with the credentials to run a scan against a given target . | 115 | 17 |
16,774 | def process_targets_element ( cls , scanner_target ) : target_list = [ ] for target in scanner_target : ports = '' credentials = { } for child in target : if child . tag == 'hosts' : hosts = child . text if child . tag == 'ports' : ports = child . text if child . tag == 'credentials' : credentials = cls . process_credentials_elements ( child ) if hosts : target_list . append ( [ hosts , ports , credentials ] ) else : raise OSPDError ( 'No target to scan' , 'start_scan' ) return target_list | Receive an XML object with the target ports and credentials to run a scan against . | 141 | 17 |
16,775 | def finish_scan ( self , scan_id ) : self . set_scan_progress ( scan_id , 100 ) self . set_scan_status ( scan_id , ScanStatus . FINISHED ) logger . info ( "%s: Scan finished." , scan_id ) | Sets a scan as finished . | 60 | 7 |
16,776 | def get_scanner_param_type ( self , param ) : assert isinstance ( param , str ) entry = self . scanner_params . get ( param ) if not entry : return None return entry . get ( 'type' ) | Returns type of a scanner parameter . | 50 | 7 |
16,777 | def get_scanner_param_mandatory ( self , param ) : assert isinstance ( param , str ) entry = self . scanner_params . get ( param ) if not entry : return False return entry . get ( 'mandatory' ) | Returns if a scanner parameter is mandatory . | 52 | 8 |
16,778 | def get_scanner_param_default ( self , param ) : assert isinstance ( param , str ) entry = self . scanner_params . get ( param ) if not entry : return None return entry . get ( 'default' ) | Returns default value of a scanner parameter . | 50 | 8 |
16,779 | def get_scanner_params_xml ( self ) : scanner_params = Element ( 'scanner_params' ) for param_id , param in self . scanner_params . items ( ) : param_xml = SubElement ( scanner_params , 'scanner_param' ) for name , value in [ ( 'id' , param_id ) , ( 'type' , param [ 'type' ] ) ] : param_xml . set ( name , value ) for name , value in [ ( 'name' , param [ 'name' ] ) , ( 'description' , param [ 'description' ] ) , ( 'default' , param [ 'default' ] ) , ( 'mandatory' , param [ 'mandatory' ] ) ] : elem = SubElement ( param_xml , name ) elem . text = str ( value ) return scanner_params | Returns the OSP Daemon s scanner params in xml format . | 187 | 13 |
16,780 | def new_client_stream ( self , sock ) : assert sock newsocket , fromaddr = sock . accept ( ) logger . debug ( "New connection from" " %s:%s" , fromaddr [ 0 ] , fromaddr [ 1 ] ) # NB: Despite the name, ssl.PROTOCOL_SSLv23 selects the highest # protocol version that both the client and server support. In modern # Python versions (>= 3.4) it supports TLS >= 1.0 with SSLv2 and SSLv3 # being disabled. For Python >=3.5, PROTOCOL_SSLv23 is an alias for # PROTOCOL_TLS which should be used once compatibility with Python 3.4 # is no longer desired. try : ssl_socket = ssl . wrap_socket ( newsocket , cert_reqs = ssl . CERT_REQUIRED , server_side = True , certfile = self . certs [ 'cert_file' ] , keyfile = self . certs [ 'key_file' ] , ca_certs = self . certs [ 'ca_file' ] , ssl_version = ssl . PROTOCOL_SSLv23 ) except ( ssl . SSLError , socket . error ) as message : logger . error ( message ) return None return ssl_socket | Returns a new ssl client stream from bind_socket . | 286 | 12 |
16,781 | def write_to_stream ( stream , response , block_len = 1024 ) : try : i_start = 0 i_end = block_len while True : if i_end > len ( response ) : stream ( response [ i_start : ] ) break stream ( response [ i_start : i_end ] ) i_start = i_end i_end += block_len except ( socket . timeout , socket . error ) as exception : logger . debug ( 'Error sending response to the client: %s' , exception ) | Send the response in blocks of the given len using the passed method dependending on the socket type . | 114 | 20 |
16,782 | def handle_client_stream ( self , stream , is_unix = False ) : assert stream data = [ ] stream . settimeout ( 2 ) while True : try : if is_unix : buf = stream . recv ( 1024 ) else : buf = stream . read ( 1024 ) if not buf : break data . append ( buf ) except ( AttributeError , ValueError ) as message : logger . error ( message ) return except ( ssl . SSLError ) as exception : logger . debug ( 'Error: %s' , exception [ 0 ] ) break except ( socket . timeout ) as exception : logger . debug ( 'Error: %s' , exception ) break data = b'' . join ( data ) if len ( data ) <= 0 : logger . debug ( "Empty client stream" ) return try : response = self . handle_command ( data ) except OSPDError as exception : response = exception . as_xml ( ) logger . debug ( 'Command error: %s' , exception . message ) except Exception : logger . exception ( 'While handling client command:' ) exception = OSPDError ( 'Fatal error' , 'error' ) response = exception . as_xml ( ) if is_unix : send_method = stream . send else : send_method = stream . write self . write_to_stream ( send_method , response ) | Handles stream of data received from client . | 296 | 9 |
16,783 | def parallel_scan ( self , scan_id , target ) : try : ret = self . exec_scan ( scan_id , target ) if ret == 0 : self . add_scan_host_detail ( scan_id , name = 'host_status' , host = target , value = '0' ) elif ret == 1 : self . add_scan_host_detail ( scan_id , name = 'host_status' , host = target , value = '1' ) elif ret == 2 : self . add_scan_host_detail ( scan_id , name = 'host_status' , host = target , value = '2' ) else : logger . debug ( '%s: No host status returned' , target ) except Exception as e : self . add_scan_error ( scan_id , name = '' , host = target , value = 'Host process failure (%s).' % e ) logger . exception ( 'While scanning %s:' , target ) else : logger . info ( "%s: Host scan finished." , target ) | Starts the scan with scan_id . | 228 | 9 |
16,784 | def calculate_progress ( self , scan_id ) : t_prog = dict ( ) for target in self . get_scan_target ( scan_id ) : t_prog [ target ] = self . get_scan_target_progress ( scan_id , target ) return sum ( t_prog . values ( ) ) / len ( t_prog ) | Calculate the total scan progress from the partial target progress . | 80 | 13 |
16,785 | def start_scan ( self , scan_id , targets , parallel = 1 ) : os . setsid ( ) multiscan_proc = [ ] logger . info ( "%s: Scan started." , scan_id ) target_list = targets if target_list is None or not target_list : raise OSPDError ( 'Erroneous targets list' , 'start_scan' ) for index , target in enumerate ( target_list ) : while len ( multiscan_proc ) >= parallel : progress = self . calculate_progress ( scan_id ) self . set_scan_progress ( scan_id , progress ) multiscan_proc = self . check_pending_target ( scan_id , multiscan_proc ) time . sleep ( 1 ) #If the scan status is stopped, does not launch anymore target scans if self . get_scan_status ( scan_id ) == ScanStatus . STOPPED : return logger . info ( "%s: Host scan started on ports %s." , target [ 0 ] , target [ 1 ] ) scan_process = multiprocessing . Process ( target = self . parallel_scan , args = ( scan_id , target [ 0 ] ) ) multiscan_proc . append ( ( scan_process , target [ 0 ] ) ) scan_process . start ( ) self . set_scan_status ( scan_id , ScanStatus . RUNNING ) # Wait until all single target were scanned while multiscan_proc : multiscan_proc = self . check_pending_target ( scan_id , multiscan_proc ) if multiscan_proc : progress = self . calculate_progress ( scan_id ) self . set_scan_progress ( scan_id , progress ) time . sleep ( 1 ) # Only set the scan as finished if the scan was not stopped. if self . get_scan_status ( scan_id ) != ScanStatus . STOPPED : self . finish_scan ( scan_id ) | Handle N parallel scans if parallel is greater than 1 . | 429 | 11 |
16,786 | def dry_run_scan ( self , scan_id , targets ) : os . setsid ( ) for _ , target in enumerate ( targets ) : host = resolve_hostname ( target [ 0 ] ) if host is None : logger . info ( "Couldn't resolve %s." , target [ 0 ] ) continue port = self . get_scan_ports ( scan_id , target = target [ 0 ] ) logger . info ( "%s:%s: Dry run mode." , host , port ) self . add_scan_log ( scan_id , name = '' , host = host , value = 'Dry run result' ) self . finish_scan ( scan_id ) | Dry runs a scan . | 148 | 6 |
16,787 | def handle_timeout ( self , scan_id , host ) : self . add_scan_error ( scan_id , host = host , name = "Timeout" , value = "{0} exec timeout." . format ( self . get_scanner_name ( ) ) ) | Handles scanner reaching timeout error . | 59 | 7 |
16,788 | def set_scan_target_progress ( self , scan_id , target , host , progress ) : self . scan_collection . set_target_progress ( scan_id , target , host , progress ) | Sets host s progress which is part of target . | 44 | 11 |
16,789 | def get_help_text ( self ) : txt = str ( '\n' ) for name , info in self . commands . items ( ) : command_txt = "\t{0: <22} {1}\n" . format ( name , info [ 'description' ] ) if info [ 'attributes' ] : command_txt = '' . join ( [ command_txt , "\t Attributes:\n" ] ) for attrname , attrdesc in info [ 'attributes' ] . items ( ) : attr_txt = "\t {0: <22} {1}\n" . format ( attrname , attrdesc ) command_txt = '' . join ( [ command_txt , attr_txt ] ) if info [ 'elements' ] : command_txt = '' . join ( [ command_txt , "\t Elements:\n" , self . elements_as_text ( info [ 'elements' ] ) ] ) txt = '' . join ( [ txt , command_txt ] ) return txt | Returns the help output in plain text format . | 227 | 9 |
16,790 | def elements_as_text ( self , elems , indent = 2 ) : assert elems text = "" for elename , eledesc in elems . items ( ) : if isinstance ( eledesc , dict ) : desc_txt = self . elements_as_text ( eledesc , indent + 2 ) desc_txt = '' . join ( [ '\n' , desc_txt ] ) elif isinstance ( eledesc , str ) : desc_txt = '' . join ( [ eledesc , '\n' ] ) else : assert False , "Only string or dictionary" ele_txt = "\t{0}{1: <22} {2}" . format ( ' ' * indent , elename , desc_txt ) text = '' . join ( [ text , ele_txt ] ) return text | Returns the elems dictionary as formatted plain text . | 178 | 10 |
16,791 | def delete_scan ( self , scan_id ) : if self . get_scan_status ( scan_id ) == ScanStatus . RUNNING : return 0 try : del self . scan_processes [ scan_id ] except KeyError : logger . debug ( 'Scan process for %s not found' , scan_id ) return self . scan_collection . delete_scan ( scan_id ) | Deletes scan_id scan from collection . | 85 | 9 |
16,792 | def get_scan_results_xml ( self , scan_id , pop_res ) : results = Element ( 'results' ) for result in self . scan_collection . results_iterator ( scan_id , pop_res ) : results . append ( get_result_xml ( result ) ) logger . info ( 'Returning %d results' , len ( results ) ) return results | Gets scan_id scan s results in XML format . | 82 | 12 |
16,793 | def get_xml_str ( self , data ) : responses = [ ] for tag , value in data . items ( ) : elem = Element ( tag ) if isinstance ( value , dict ) : for value in self . get_xml_str ( value ) : elem . append ( value ) elif isinstance ( value , list ) : value = ', ' . join ( [ m for m in value ] ) elem . text = value else : elem . text = value responses . append ( elem ) return responses | Creates a string in XML Format using the provided data structure . | 112 | 13 |
16,794 | def get_scan_xml ( self , scan_id , detailed = True , pop_res = False ) : if not scan_id : return Element ( 'scan' ) target = ',' . join ( self . get_scan_target ( scan_id ) ) progress = self . get_scan_progress ( scan_id ) status = self . get_scan_status ( scan_id ) start_time = self . get_scan_start_time ( scan_id ) end_time = self . get_scan_end_time ( scan_id ) response = Element ( 'scan' ) for name , value in [ ( 'id' , scan_id ) , ( 'target' , target ) , ( 'progress' , progress ) , ( 'status' , status . name . lower ( ) ) , ( 'start_time' , start_time ) , ( 'end_time' , end_time ) ] : response . set ( name , str ( value ) ) if detailed : response . append ( self . get_scan_results_xml ( scan_id , pop_res ) ) return response | Gets scan in XML format . | 239 | 7 |
16,795 | def get_vts_xml ( self , vt_id = None , filtered_vts = None ) : vts_xml = Element ( 'vts' ) if vt_id : vts_xml . append ( self . get_vt_xml ( vt_id ) ) elif filtered_vts : for vt_id in filtered_vts : vts_xml . append ( self . get_vt_xml ( vt_id ) ) else : for vt_id in self . vts : vts_xml . append ( self . get_vt_xml ( vt_id ) ) return vts_xml | Gets collection of vulnerability test information in XML format . If vt_id is specified the collection will contain only this vt if found . If no vt_id is specified the collection will contain all vts or those passed in filtered_vts . | 142 | 53 |
16,796 | def handle_command ( self , command ) : try : tree = secET . fromstring ( command ) except secET . ParseError : logger . debug ( "Erroneous client input: %s" , command ) raise OSPDError ( 'Invalid data' ) if not self . command_exists ( tree . tag ) and tree . tag != "authenticate" : raise OSPDError ( 'Bogus command name' ) if tree . tag == "get_version" : return self . handle_get_version_command ( ) elif tree . tag == "start_scan" : return self . handle_start_scan_command ( tree ) elif tree . tag == "stop_scan" : return self . handle_stop_scan_command ( tree ) elif tree . tag == "get_scans" : return self . handle_get_scans_command ( tree ) elif tree . tag == "get_vts" : return self . handle_get_vts_command ( tree ) elif tree . tag == "delete_scan" : return self . handle_delete_scan_command ( tree ) elif tree . tag == "help" : return self . handle_help_command ( tree ) elif tree . tag == "get_scanner_details" : return self . handle_get_scanner_details ( ) else : assert False , "Unhandled command: {0}" . format ( tree . tag ) | Handles an osp command in a string . | 318 | 10 |
16,797 | def run ( self , address , port , unix_path ) : assert address or unix_path if unix_path : sock = bind_unix_socket ( unix_path ) else : sock = bind_socket ( address , port ) if sock is None : return False sock . setblocking ( False ) inputs = [ sock ] outputs = [ ] try : while True : readable , _ , _ = select . select ( inputs , outputs , inputs , SCHEDULER_CHECK_PERIOD ) for r_socket in readable : if unix_path and r_socket is sock : client_stream , _ = sock . accept ( ) logger . debug ( "New connection from %s" , unix_path ) self . handle_client_stream ( client_stream , True ) else : client_stream = self . new_client_stream ( sock ) if client_stream is None : continue self . handle_client_stream ( client_stream , False ) close_client_stream ( client_stream , unix_path ) self . scheduler ( ) except KeyboardInterrupt : logger . info ( "Received Ctrl-C shutting-down ..." ) finally : sock . shutdown ( socket . SHUT_RDWR ) sock . close ( ) | Starts the Daemon handling commands until interrupted . | 268 | 10 |
16,798 | def create_scan ( self , scan_id , targets , options , vts ) : if self . scan_exists ( scan_id ) : logger . info ( "Scan %s exists. Resuming scan." , scan_id ) return self . scan_collection . create_scan ( scan_id , targets , options , vts ) | Creates a new scan . | 73 | 6 |
16,799 | def set_scan_option ( self , scan_id , name , value ) : return self . scan_collection . set_option ( scan_id , name , value ) | Sets a scan s option to a provided value . | 37 | 11 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.