Coverage Report

Coverage Report - org.owasp.dependencycheck.Engine

Classes in this File

Line Coverage

Branch Coverage

Complexity

Engine

54%

102/187

57%

37/64

3.174

 /*
  * This file is part of dependency-check-core.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  *
  * Copyright (c) 2012 Jeremy Long. All Rights Reserved.
  */
 package org.owasp.dependencycheck;
 
 import org.owasp.dependencycheck.analyzer.AnalysisPhase;
 import org.owasp.dependencycheck.analyzer.Analyzer;
 import org.owasp.dependencycheck.analyzer.AnalyzerService;
 import org.owasp.dependencycheck.analyzer.FileTypeAnalyzer;
 import org.owasp.dependencycheck.analyzer.exception.AnalysisException;
 import org.owasp.dependencycheck.data.nvdcve.ConnectionFactory;
 import org.owasp.dependencycheck.data.nvdcve.CveDB;
 import org.owasp.dependencycheck.data.nvdcve.DatabaseException;
 import org.owasp.dependencycheck.data.update.CachedWebDataSource;
 import org.owasp.dependencycheck.data.update.UpdateService;
 import org.owasp.dependencycheck.data.update.exception.UpdateException;
 import org.owasp.dependencycheck.dependency.Dependency;
 import org.owasp.dependencycheck.exception.NoDataException;
 import org.owasp.dependencycheck.utils.InvalidSettingException;
 import org.owasp.dependencycheck.utils.Settings;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import java.io.File;
 import java.io.FileFilter;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.EnumMap;
 import java.util.HashSet;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
 
 /**
  * Scans files, directories, etc. for Dependencies. Analyzers are loaded and used to process the files found by the scan, if a
  * file is encountered and an Analyzer is associated with the file type then the file is turned into a dependency.
  *
  * @author Jeremy Long
  */
 public class Engine implements FileFilter {
 
     /**
      * The list of dependencies.
      */
     private List<Dependency> dependencies = new ArrayList<Dependency>();
     /**
      * A Map of analyzers grouped by Analysis phase.
      */
     private Map<AnalysisPhase, List<Analyzer>> analyzers = new EnumMap<AnalysisPhase, List<Analyzer>>(AnalysisPhase.class);
 
     /**
      * A Map of analyzers grouped by Analysis phase.
      */
     private Set<FileTypeAnalyzer> fileTypeAnalyzers = new HashSet<FileTypeAnalyzer>();
 
     /**
      * The ClassLoader to use when dynamically loading Analyzer and Update services.
      */
     private ClassLoader serviceClassLoader = Thread.currentThread().getContextClassLoader();
     /**
      * The Logger for use throughout the class.
      */
     private static final Logger LOGGER = LoggerFactory.getLogger(Engine.class);
 
     /**
      * Creates a new Engine.
      *
      * @throws DatabaseException thrown if there is an error connecting to the database
      */
     public Engine() throws DatabaseException {
         initializeEngine();
     }
 
     /**
      * Creates a new Engine.
      *
      * @param serviceClassLoader a reference the class loader being used
      * @throws DatabaseException thrown if there is an error connecting to the database
      */
     public Engine(ClassLoader serviceClassLoader) throws DatabaseException {
         this.serviceClassLoader = serviceClassLoader;
         initializeEngine();
     }
 
     /**
      * Creates a new Engine using the specified classloader to dynamically load Analyzer and Update services.
      *
      * @throws DatabaseException thrown if there is an error connecting to the database
      */
     protected final void initializeEngine() throws DatabaseException {
         ConnectionFactory.initialize();
         loadAnalyzers();
     }
 
     /**
      * Properly cleans up resources allocated during analysis.
      */
     public void cleanup() {
         ConnectionFactory.cleanup();
     }
 
     /**
      * Loads the analyzers specified in the configuration file (or system properties).
      */
     private void loadAnalyzers() {
         if (!analyzers.isEmpty()) {
             return;
         }
         for (AnalysisPhase phase : AnalysisPhase.values()) {
             analyzers.put(phase, new ArrayList<Analyzer>());
         }
 
         final AnalyzerService service = new AnalyzerService(serviceClassLoader);
         final Iterator<Analyzer> iterator = service.getAnalyzers();
         while (iterator.hasNext()) {
             final Analyzer a = iterator.next();
             analyzers.get(a.getAnalysisPhase()).add(a);
             if (a instanceof FileTypeAnalyzer) {
                 this.fileTypeAnalyzers.add((FileTypeAnalyzer) a);
             }
         }
     }
 
     /**
      * Get the List of the analyzers for a specific phase of analysis.
      *
      * @param phase the phase to get the configured analyzers.
      * @return the analyzers loaded
      */
     public List<Analyzer> getAnalyzers(AnalysisPhase phase) {
         return analyzers.get(phase);
     }
 
     /**
      * Get the dependencies identified.
      *
      * @return the dependencies identified
      */
     public List<Dependency> getDependencies() {
         return dependencies;
     }
 
     /**
      * Sets the dependencies.
      *
      * @param dependencies the dependencies
      */
     public void setDependencies(List<Dependency> dependencies) {
         this.dependencies = dependencies;
     }
 
     /**
      * Scans an array of files or directories. If a directory is specified, it will be scanned recursively. Any dependencies
      * identified are added to the dependency collection.
      *
      * @param paths an array of paths to files or directories to be analyzed
      * @return the list of dependencies scanned
      * @since v0.3.2.5
      */
     public List<Dependency> scan(String[] paths) {
         final List<Dependency> deps = new ArrayList<Dependency>();
         for (String path : paths) {
             final List<Dependency> d = scan(path);
             if (d != null) {
                 deps.addAll(d);
             }
         }
         return deps;
     }
 
     /**
      * Scans a given file or directory. If a directory is specified, it will be scanned recursively. Any dependencies identified
      * are added to the dependency collection.
      *
      * @param path the path to a file or directory to be analyzed
      * @return the list of dependencies scanned
      */
     public List<Dependency> scan(String path) {
         final File file = new File(path);
         return scan(file);
     }
 
     /**
      * Scans an array of files or directories. If a directory is specified, it will be scanned recursively. Any dependencies
      * identified are added to the dependency collection.
      *
      * @param files an array of paths to files or directories to be analyzed.
      * @return the list of dependencies
      * @since v0.3.2.5
      */
     public List<Dependency> scan(File[] files) {
         final List<Dependency> deps = new ArrayList<Dependency>();
         for (File file : files) {
             final List<Dependency> d = scan(file);
             if (d != null) {
                 deps.addAll(d);
             }
         }
         return deps;
     }
 
     /**
      * Scans a collection of files or directories. If a directory is specified, it will be scanned recursively. Any dependencies
      * identified are added to the dependency collection.
      *
      * @param files a set of paths to files or directories to be analyzed
      * @return the list of dependencies scanned
      * @since v0.3.2.5
      */
     public List<Dependency> scan(Collection<File> files) {
         final List<Dependency> deps = new ArrayList<Dependency>();
         for (File file : files) {
             final List<Dependency> d = scan(file);
             if (d != null) {
                 deps.addAll(d);
             }
         }
         return deps;
     }
 
     /**
      * Scans a given file or directory. If a directory is specified, it will be scanned recursively. Any dependencies identified
      * are added to the dependency collection.
      *
      * @param file the path to a file or directory to be analyzed
      * @return the list of dependencies scanned
      * @since v0.3.2.4
      */
     public List<Dependency> scan(File file) {
         if (file.exists()) {
             if (file.isDirectory()) {
                 return scanDirectory(file);
             } else {
                 final Dependency d = scanFile(file);
                 if (d != null) {
                     final List<Dependency> deps = new ArrayList<Dependency>();
                     deps.add(d);
                     return deps;
                 }
             }
         }
         return null;
     }
 
     /**
      * Recursively scans files and directories. Any dependencies identified are added to the dependency collection.
      *
      * @param dir the directory to scan
      * @return the list of Dependency objects scanned
      */
     protected List<Dependency> scanDirectory(File dir) {
         final File[] files = dir.listFiles();
         final List<Dependency> deps = new ArrayList<Dependency>();
         if (files != null) {
             for (File f : files) {
                 if (f.isDirectory()) {
                     final List<Dependency> d = scanDirectory(f);
                     if (d != null) {
                         deps.addAll(d);
                     }
                 } else {
                     final Dependency d = scanFile(f);
                     deps.add(d);
                 }
             }
         }
         return deps;
     }
 
     /**
      * Scans a specified file. If a dependency is identified it is added to the dependency collection.
      *
      * @param file The file to scan
      * @return the scanned dependency
      */
     protected Dependency scanFile(File file) {
         Dependency dependency = null;
         if (file.isFile()) {
             if (accept(file)) {
                 dependency = new Dependency(file);
                 dependencies.add(dependency);
             }
         } else {
             LOGGER.debug("Path passed to scanFile(File) is not a file: {}. Skipping the file.", file);
         }
         return dependency;
     }
 
     /**
      * Runs the analyzers against all of the dependencies. Since the mutable dependencies list is exposed via
      * {@link #getDependencies()}, this method iterates over a copy of the dependencies list. Thus, the potential for
      * {@link java.util.ConcurrentModificationException}s is avoided, and analyzers may safely add or remove entries from the
      * dependencies list.
      */
     public void analyzeDependencies() {
         boolean autoUpdate = true;
         try {
             autoUpdate = Settings.getBoolean(Settings.KEYS.AUTO_UPDATE);
         } catch (InvalidSettingException ex) {
             LOGGER.debug("Invalid setting for auto-update; using true.");
         }
         if (autoUpdate) {
             doUpdates();
         }
 
         //need to ensure that data exists
         try {
             ensureDataExists();
         } catch (NoDataException ex) {
             LOGGER.error("{}\n\nUnable to continue dependency-check analysis.", ex.getMessage());
             LOGGER.debug("", ex);
             return;
         } catch (DatabaseException ex) {
             LOGGER.error("{}\n\nUnable to continue dependency-check analysis.", ex.getMessage());
             LOGGER.debug("", ex);
             return;
 
         }
 
         LOGGER.debug("\n----------------------------------------------------\nBEGIN ANALYSIS\n----------------------------------------------------");
         LOGGER.info("Analysis Starting");
         final long analysisStart = System.currentTimeMillis();
 
         // analysis phases
         for (AnalysisPhase phase : AnalysisPhase.values()) {
             final List<Analyzer> analyzerList = analyzers.get(phase);
 
             for (Analyzer a : analyzerList) {
                 a = initializeAnalyzer(a);
 
                 /* need to create a copy of the collection because some of the
                  * analyzers may modify it. This prevents ConcurrentModificationExceptions.
                  * This is okay for adds/deletes because it happens per analyzer.
                  */
                 LOGGER.debug("Begin Analyzer '{}'", a.getName());
                 final Set<Dependency> dependencySet = new HashSet<Dependency>(dependencies);
                 for (Dependency d : dependencySet) {
                     boolean shouldAnalyze = true;
                     if (a instanceof FileTypeAnalyzer) {
                         final FileTypeAnalyzer fAnalyzer = (FileTypeAnalyzer) a;
                         shouldAnalyze = fAnalyzer.accept(d.getActualFile());
                     }
                     if (shouldAnalyze) {
                         LOGGER.debug("Begin Analysis of '{}'", d.getActualFilePath());
                         try {
                             a.analyze(d, this);
                         } catch (AnalysisException ex) {
                             LOGGER.warn("An error occurred while analyzing '{}'.", d.getActualFilePath());
                             LOGGER.debug("", ex);
                         } catch (Throwable ex) {
                             //final AnalysisException ax = new AnalysisException(axMsg, ex);
                             LOGGER.warn("An unexpected error occurred during analysis of '{}'", d.getActualFilePath());
                             LOGGER.debug("", ex);
                         }
                     }
                 }
             }
         }
         for (AnalysisPhase phase : AnalysisPhase.values()) {
             final List<Analyzer> analyzerList = analyzers.get(phase);
 
             for (Analyzer a : analyzerList) {
                 closeAnalyzer(a);
             }
         }
 
         LOGGER.debug("\n----------------------------------------------------\nEND ANALYSIS\n----------------------------------------------------");
         LOGGER.info("Analysis Complete ({} ms)", System.currentTimeMillis() - analysisStart);
     }
 
     /**
      * Initializes the given analyzer.
      *
      * @param analyzer the analyzer to initialize
      * @return the initialized analyzer
      */
     protected Analyzer initializeAnalyzer(Analyzer analyzer) {
         try {
             LOGGER.debug("Initializing {}", analyzer.getName());
             analyzer.initialize();
         } catch (Throwable ex) {
             LOGGER.error("Exception occurred initializing {}.", analyzer.getName());
             LOGGER.debug("", ex);
             try {
                 analyzer.close();
             } catch (Throwable ex1) {
                 LOGGER.trace("", ex1);
             }
         }
         return analyzer;
     }
 
     /**
      * Closes the given analyzer.
      *
      * @param analyzer the analyzer to close
      */
     protected void closeAnalyzer(Analyzer analyzer) {
         LOGGER.debug("Closing Analyzer '{}'", analyzer.getName());
         try {
             analyzer.close();
         } catch (Throwable ex) {
             LOGGER.trace("", ex);
         }
     }
 
     /**
      * Cycles through the cached web data sources and calls update on all of them.
      */
     public void doUpdates() {
         LOGGER.info("Checking for updates");
         final long updateStart = System.currentTimeMillis();
         final UpdateService service = new UpdateService(serviceClassLoader);
         final Iterator<CachedWebDataSource> iterator = service.getDataSources();
         while (iterator.hasNext()) {
             final CachedWebDataSource source = iterator.next();
             try {
                 source.update();
             } catch (UpdateException ex) {
                 LOGGER.warn(
                         "Unable to update Cached Web DataSource, using local data instead. Results may not include recent vulnerabilities.");
                 LOGGER.debug("Unable to update details for {}", source.getClass().getName(), ex);
             }
         }
         LOGGER.info("Check for updates complete ({} ms)", System.currentTimeMillis() - updateStart);
     }
 
     /**
      * Returns a full list of all of the analyzers. This is useful for reporting which analyzers where used.
      *
      * @return a list of Analyzers
      */
     public List<Analyzer> getAnalyzers() {
         final List<Analyzer> ret = new ArrayList<Analyzer>();
         for (AnalysisPhase phase : AnalysisPhase.values()) {
             final List<Analyzer> analyzerList = analyzers.get(phase);
             ret.addAll(analyzerList);
         }
         return ret;
     }
 
     /**
      * Checks all analyzers to see if an extension is supported.
      *
      * @param file a file extension
      * @return true or false depending on whether or not the file extension is supported
      */
     @Override
     public boolean accept(File file) {
         if (file == null) {
             return false;
         }
         boolean scan = false;
         for (FileTypeAnalyzer a : this.fileTypeAnalyzers) {
             /* note, we can't break early on this loop as the analyzers need to know if
              they have files to work on prior to initialization */
             scan |= a.accept(file);
         }
         return scan;
     }
 
     /**
      * Returns the set of file type analyzers.
      *
      * @return the set of file type analyzers
      */
     public Set<FileTypeAnalyzer> getFileTypeAnalyzers() {
         return this.fileTypeAnalyzers;
     }
 
     /**
      * Checks the CPE Index to ensure documents exists. If none exist a NoDataException is thrown.
      *
      * @throws NoDataException thrown if no data exists in the CPE Index
      * @throws DatabaseException thrown if there is an exception opening the database
      */
     private void ensureDataExists() throws NoDataException, DatabaseException {
         final CveDB cve = new CveDB();
         try {
             cve.open();
             if (!cve.dataExists()) {
                 throw new NoDataException("No documents exist");
             }
         } catch (DatabaseException ex) {
             throw new NoDataException(ex.getMessage(), ex);
         } finally {
             cve.close();
         }
     }
 }

1		/*
2		* This file is part of dependency-check-core.
3		*
4		* Licensed under the Apache License, Version 2.0 (the "License");
5		* you may not use this file except in compliance with the License.
6		* You may obtain a copy of the License at
7		*
8		* http://www.apache.org/licenses/LICENSE-2.0
9		*
10		* Unless required by applicable law or agreed to in writing, software
11		* distributed under the License is distributed on an "AS IS" BASIS,
12		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13		* See the License for the specific language governing permissions and
14		* limitations under the License.
15		*
16		* Copyright (c) 2012 Jeremy Long. All Rights Reserved.
17		*/
18		package org.owasp.dependencycheck;
19
20		import org.owasp.dependencycheck.analyzer.AnalysisPhase;
21		import org.owasp.dependencycheck.analyzer.Analyzer;
22		import org.owasp.dependencycheck.analyzer.AnalyzerService;
23		import org.owasp.dependencycheck.analyzer.FileTypeAnalyzer;
24		import org.owasp.dependencycheck.analyzer.exception.AnalysisException;
25		import org.owasp.dependencycheck.data.nvdcve.ConnectionFactory;
26		import org.owasp.dependencycheck.data.nvdcve.CveDB;
27		import org.owasp.dependencycheck.data.nvdcve.DatabaseException;
28		import org.owasp.dependencycheck.data.update.CachedWebDataSource;
29		import org.owasp.dependencycheck.data.update.UpdateService;
30		import org.owasp.dependencycheck.data.update.exception.UpdateException;
31		import org.owasp.dependencycheck.dependency.Dependency;
32		import org.owasp.dependencycheck.exception.NoDataException;
33		import org.owasp.dependencycheck.utils.InvalidSettingException;
34		import org.owasp.dependencycheck.utils.Settings;
35		import org.slf4j.Logger;
36		import org.slf4j.LoggerFactory;
37
38		import java.io.File;
39		import java.io.FileFilter;
40		import java.util.ArrayList;
41		import java.util.Collection;
42		import java.util.EnumMap;
43		import java.util.HashSet;
44		import java.util.Iterator;
45		import java.util.List;
46		import java.util.Map;
47		import java.util.Set;
48
49		/**
50		* Scans files, directories, etc. for Dependencies. Analyzers are loaded and used to process the files found by the scan, if a
51		* file is encountered and an Analyzer is associated with the file type then the file is turned into a dependency.
52		*
53		* @author Jeremy Long
54		*/
55		public class Engine implements FileFilter {
56
57		/**
58		* The list of dependencies.
59		*/
60	3	private List<Dependency> dependencies = new ArrayList<Dependency>();
61		/**
62		* A Map of analyzers grouped by Analysis phase.
63		*/
64	3	private Map<AnalysisPhase, List<Analyzer>> analyzers = new EnumMap<AnalysisPhase, List<Analyzer>>(AnalysisPhase.class);
65
66		/**
67		* A Map of analyzers grouped by Analysis phase.
68		*/
69	3	private Set<FileTypeAnalyzer> fileTypeAnalyzers = new HashSet<FileTypeAnalyzer>();
70
71		/**
72		* The ClassLoader to use when dynamically loading Analyzer and Update services.
73		*/
74	3	private ClassLoader serviceClassLoader = Thread.currentThread().getContextClassLoader();
75		/**
76		* The Logger for use throughout the class.
77		*/
78	1	private static final Logger LOGGER = LoggerFactory.getLogger(Engine.class);
79
80		/**
81		* Creates a new Engine.
82		*
83		* @throws DatabaseException thrown if there is an error connecting to the database
84		*/
85	3	public Engine() throws DatabaseException {
86	3	initializeEngine();
87	3	}
88
89		/**
90		* Creates a new Engine.
91		*
92		* @param serviceClassLoader a reference the class loader being used
93		* @throws DatabaseException thrown if there is an error connecting to the database
94		*/
95	0	public Engine(ClassLoader serviceClassLoader) throws DatabaseException {
96	0	this.serviceClassLoader = serviceClassLoader;
97	0	initializeEngine();
98	0	}
99
100		/**
101		* Creates a new Engine using the specified classloader to dynamically load Analyzer and Update services.
102		*
103		* @throws DatabaseException thrown if there is an error connecting to the database
104		*/
105		protected final void initializeEngine() throws DatabaseException {
106	3	ConnectionFactory.initialize();
107	3	loadAnalyzers();
108	3	}
109
110		/**
111		* Properly cleans up resources allocated during analysis.
112		*/
113		public void cleanup() {
114	0	ConnectionFactory.cleanup();
115	0	}
116
117		/**
118		* Loads the analyzers specified in the configuration file (or system properties).
119		*/
120		private void loadAnalyzers() {
121	3	if (!analyzers.isEmpty()) {
122	0	return;
123		}
124	33	for (AnalysisPhase phase : AnalysisPhase.values()) {
125	30	analyzers.put(phase, new ArrayList<Analyzer>());
126		}
127
128	3	final AnalyzerService service = new AnalyzerService(serviceClassLoader);
129	3	final Iterator<Analyzer> iterator = service.getAnalyzers();
130	72	while (iterator.hasNext()) {
131	69	final Analyzer a = iterator.next();
132	69	analyzers.get(a.getAnalysisPhase()).add(a);
133	69	if (a instanceof FileTypeAnalyzer) {
134	45	this.fileTypeAnalyzers.add((FileTypeAnalyzer) a);
135		}
136	69	}
137	3	}
138
139		/**
140		* Get the List of the analyzers for a specific phase of analysis.
141		*
142		* @param phase the phase to get the configured analyzers.
143		* @return the analyzers loaded
144		*/
145		public List<Analyzer> getAnalyzers(AnalysisPhase phase) {
146	0	return analyzers.get(phase);
147		}
148
149		/**
150		* Get the dependencies identified.
151		*
152		* @return the dependencies identified
153		*/
154		public List<Dependency> getDependencies() {
155	45	return dependencies;
156		}
157
158		/**
159		* Sets the dependencies.
160		*
161		* @param dependencies the dependencies
162		*/
163		public void setDependencies(List<Dependency> dependencies) {
164	0	this.dependencies = dependencies;
165	0	}
166
167		/**
168		* Scans an array of files or directories. If a directory is specified, it will be scanned recursively. Any dependencies
169		* identified are added to the dependency collection.
170		*
171		* @param paths an array of paths to files or directories to be analyzed
172		* @return the list of dependencies scanned
173		* @since v0.3.2.5
174		*/
175		public List<Dependency> scan(String[] paths) {
176	0	final List<Dependency> deps = new ArrayList<Dependency>();
177	0	for (String path : paths) {
178	0	final List<Dependency> d = scan(path);
179	0	if (d != null) {
180	0	deps.addAll(d);
181		}
182		}
183	0	return deps;
184		}
185
186		/**
187		* Scans a given file or directory. If a directory is specified, it will be scanned recursively. Any dependencies identified
188		* are added to the dependency collection.
189		*
190		* @param path the path to a file or directory to be analyzed
191		* @return the list of dependencies scanned
192		*/
193		public List<Dependency> scan(String path) {
194	0	final File file = new File(path);
195	0	return scan(file);
196		}
197
198		/**
199		* Scans an array of files or directories. If a directory is specified, it will be scanned recursively. Any dependencies
200		* identified are added to the dependency collection.
201		*
202		* @param files an array of paths to files or directories to be analyzed.
203		* @return the list of dependencies
204		* @since v0.3.2.5
205		*/
206		public List<Dependency> scan(File[] files) {
207	0	final List<Dependency> deps = new ArrayList<Dependency>();
208	0	for (File file : files) {
209	0	final List<Dependency> d = scan(file);
210	0	if (d != null) {
211	0	deps.addAll(d);
212		}
213		}
214	0	return deps;
215		}
216
217		/**
218		* Scans a collection of files or directories. If a directory is specified, it will be scanned recursively. Any dependencies
219		* identified are added to the dependency collection.
220		*
221		* @param files a set of paths to files or directories to be analyzed
222		* @return the list of dependencies scanned
223		* @since v0.3.2.5
224		*/
225		public List<Dependency> scan(Collection<File> files) {
226	0	final List<Dependency> deps = new ArrayList<Dependency>();
227	0	for (File file : files) {
228	0	final List<Dependency> d = scan(file);
229	0	if (d != null) {
230	0	deps.addAll(d);
231		}
232	0	}
233	0	return deps;
234		}
235
236		/**
237		* Scans a given file or directory. If a directory is specified, it will be scanned recursively. Any dependencies identified
238		* are added to the dependency collection.
239		*
240		* @param file the path to a file or directory to be analyzed
241		* @return the list of dependencies scanned
242		* @since v0.3.2.4
243		*/
244		public List<Dependency> scan(File file) {
245	4	if (file.exists()) {
246	4	if (file.isDirectory()) {
247	2	return scanDirectory(file);
248		} else {
249	2	final Dependency d = scanFile(file);
250	2	if (d != null) {
251	2	final List<Dependency> deps = new ArrayList<Dependency>();
252	2	deps.add(d);
253	2	return deps;
254		}
255		}
256		}
257	0	return null;
258		}
259
260		/**
261		* Recursively scans files and directories. Any dependencies identified are added to the dependency collection.
262		*
263		* @param dir the directory to scan
264		* @return the list of Dependency objects scanned
265		*/
266		protected List<Dependency> scanDirectory(File dir) {
267	38	final File[] files = dir.listFiles();
268	38	final List<Dependency> deps = new ArrayList<Dependency>();
269	38	if (files != null) {
270	74	for (File f : files) {
271	36	if (f.isDirectory()) {
272	36	final List<Dependency> d = scanDirectory(f);
273	36	if (d != null) {
274	36	deps.addAll(d);
275		}
276	36	} else {
277	0	final Dependency d = scanFile(f);
278	0	deps.add(d);
279		}
280		}
281		}
282	38	return deps;
283		}
284
285		/**
286		* Scans a specified file. If a dependency is identified it is added to the dependency collection.
287		*
288		* @param file The file to scan
289		* @return the scanned dependency
290		*/
291		protected Dependency scanFile(File file) {
292	2	Dependency dependency = null;
293	2	if (file.isFile()) {
294	2	if (accept(file)) {
295	2	dependency = new Dependency(file);
296	2	dependencies.add(dependency);
297		}
298		} else {
299	0	LOGGER.debug("Path passed to scanFile(File) is not a file: {}. Skipping the file.", file);
300		}
301	2	return dependency;
302		}
303
304		/**
305		* Runs the analyzers against all of the dependencies. Since the mutable dependencies list is exposed via
306		* {@link #getDependencies()}, this method iterates over a copy of the dependencies list. Thus, the potential for
307		* {@link java.util.ConcurrentModificationException}s is avoided, and analyzers may safely add or remove entries from the
308		* dependencies list.
309		*/
310		public void analyzeDependencies() {
311	1	boolean autoUpdate = true;
312		try {
313	1	autoUpdate = Settings.getBoolean(Settings.KEYS.AUTO_UPDATE);
314	0	} catch (InvalidSettingException ex) {
315	0	LOGGER.debug("Invalid setting for auto-update; using true.");
316	1	}
317	1	if (autoUpdate) {
318	0	doUpdates();
319		}
320
321		//need to ensure that data exists
322		try {
323	1	ensureDataExists();
324	0	} catch (NoDataException ex) {
325	0	LOGGER.error("{}\n\nUnable to continue dependency-check analysis.", ex.getMessage());
326	0	LOGGER.debug("", ex);
327	0	return;
328	0	} catch (DatabaseException ex) {
329	0	LOGGER.error("{}\n\nUnable to continue dependency-check analysis.", ex.getMessage());
330	0	LOGGER.debug("", ex);
331	0	return;
332
333	1	}
334
335	1	LOGGER.debug("\n----------------------------------------------------\nBEGIN ANALYSIS\n----------------------------------------------------");
336	1	LOGGER.info("Analysis Starting");
337	1	final long analysisStart = System.currentTimeMillis();
338
339		// analysis phases
340	11	for (AnalysisPhase phase : AnalysisPhase.values()) {
341	10	final List<Analyzer> analyzerList = analyzers.get(phase);
342
343	10	for (Analyzer a : analyzerList) {
344	23	a = initializeAnalyzer(a);
345
346		/* need to create a copy of the collection because some of the
347		* analyzers may modify it. This prevents ConcurrentModificationExceptions.
348		* This is okay for adds/deletes because it happens per analyzer.
349		*/
350	23	LOGGER.debug("Begin Analyzer '{}'", a.getName());
351	23	final Set<Dependency> dependencySet = new HashSet<Dependency>(dependencies);
352	23	for (Dependency d : dependencySet) {
353	46	boolean shouldAnalyze = true;
354	46	if (a instanceof FileTypeAnalyzer) {
355	30	final FileTypeAnalyzer fAnalyzer = (FileTypeAnalyzer) a;
356	30	shouldAnalyze = fAnalyzer.accept(d.getActualFile());
357		}
358	46	if (shouldAnalyze) {
359	20	LOGGER.debug("Begin Analysis of '{}'", d.getActualFilePath());
360		try {
361	20	a.analyze(d, this);
362	0	} catch (AnalysisException ex) {
363	0	LOGGER.warn("An error occurred while analyzing '{}'.", d.getActualFilePath());
364	0	LOGGER.debug("", ex);
365	0	} catch (Throwable ex) {
366		//final AnalysisException ax = new AnalysisException(axMsg, ex);
367	0	LOGGER.warn("An unexpected error occurred during analysis of '{}'", d.getActualFilePath());
368	0	LOGGER.debug("", ex);
369	20	}
370		}
371	46	}
372	23	}
373		}
374	11	for (AnalysisPhase phase : AnalysisPhase.values()) {
375	10	final List<Analyzer> analyzerList = analyzers.get(phase);
376
377	10	for (Analyzer a : analyzerList) {
378	23	closeAnalyzer(a);
379	23	}
380		}
381
382	1	LOGGER.debug("\n----------------------------------------------------\nEND ANALYSIS\n----------------------------------------------------");
383	1	LOGGER.info("Analysis Complete ({} ms)", System.currentTimeMillis() - analysisStart);
384	1	}
385
386		/**
387		* Initializes the given analyzer.
388		*
389		* @param analyzer the analyzer to initialize
390		* @return the initialized analyzer
391		*/
392		protected Analyzer initializeAnalyzer(Analyzer analyzer) {
393		try {
394	23	LOGGER.debug("Initializing {}", analyzer.getName());
395	23	analyzer.initialize();
396	0	} catch (Throwable ex) {
397	0	LOGGER.error("Exception occurred initializing {}.", analyzer.getName());
398	0	LOGGER.debug("", ex);
399		try {
400	0	analyzer.close();
401	0	} catch (Throwable ex1) {
402	0	LOGGER.trace("", ex1);
403	0	}
404	23	}
405	23	return analyzer;
406		}
407
408		/**
409		* Closes the given analyzer.
410		*
411		* @param analyzer the analyzer to close
412		*/
413		protected void closeAnalyzer(Analyzer analyzer) {
414	23	LOGGER.debug("Closing Analyzer '{}'", analyzer.getName());
415		try {
416	23	analyzer.close();
417	0	} catch (Throwable ex) {
418	0	LOGGER.trace("", ex);
419	23	}
420	23	}
421
422		/**
423		* Cycles through the cached web data sources and calls update on all of them.
424		*/
425		public void doUpdates() {
426	0	LOGGER.info("Checking for updates");
427	0	final long updateStart = System.currentTimeMillis();
428	0	final UpdateService service = new UpdateService(serviceClassLoader);
429	0	final Iterator<CachedWebDataSource> iterator = service.getDataSources();
430	0	while (iterator.hasNext()) {
431	0	final CachedWebDataSource source = iterator.next();
432		try {
433	0	source.update();
434	0	} catch (UpdateException ex) {
435	0	LOGGER.warn(
436		"Unable to update Cached Web DataSource, using local data instead. Results may not include recent vulnerabilities.");
437	0	LOGGER.debug("Unable to update details for {}", source.getClass().getName(), ex);
438	0	}
439	0	}
440	0	LOGGER.info("Check for updates complete ({} ms)", System.currentTimeMillis() - updateStart);
441	0	}
442
443		/**
444		* Returns a full list of all of the analyzers. This is useful for reporting which analyzers where used.
445		*
446		* @return a list of Analyzers
447		*/
448		public List<Analyzer> getAnalyzers() {
449	0	final List<Analyzer> ret = new ArrayList<Analyzer>();
450	0	for (AnalysisPhase phase : AnalysisPhase.values()) {
451	0	final List<Analyzer> analyzerList = analyzers.get(phase);
452	0	ret.addAll(analyzerList);
453		}
454	0	return ret;
455		}
456
457		/**
458		* Checks all analyzers to see if an extension is supported.
459		*
460		* @param file a file extension
461		* @return true or false depending on whether or not the file extension is supported
462		*/
463		@Override
464		public boolean accept(File file) {
465	851	if (file == null) {
466	0	return false;
467		}
468	851	boolean scan = false;
469	851	for (FileTypeAnalyzer a : this.fileTypeAnalyzers) {
470		/* note, we can't break early on this loop as the analyzers need to know if
471		they have files to work on prior to initialization */
472	12765	scan \|= a.accept(file);
473	12765	}
474	851	return scan;
475		}
476
477		/**
478		* Returns the set of file type analyzers.
479		*
480		* @return the set of file type analyzers
481		*/
482		public Set<FileTypeAnalyzer> getFileTypeAnalyzers() {
483	0	return this.fileTypeAnalyzers;
484		}
485
486		/**
487		* Checks the CPE Index to ensure documents exists. If none exist a NoDataException is thrown.
488		*
489		* @throws NoDataException thrown if no data exists in the CPE Index
490		* @throws DatabaseException thrown if there is an exception opening the database
491		*/
492		private void ensureDataExists() throws NoDataException, DatabaseException {
493	1	final CveDB cve = new CveDB();
494		try {
495	1	cve.open();
496	1	if (!cve.dataExists()) {
497	0	throw new NoDataException("No documents exist");
498		}
499	0	} catch (DatabaseException ex) {
500	0	throw new NoDataException(ex.getMessage(), ex);
501		} finally {
502	1	cve.close();
503	1	}
504	1	}
505		}