Coverage Report - org.owasp.dependencycheck.data.update.EngineVersionCheck
 
Classes in this File Line Coverage Branch Coverage Complexity
EngineVersionCheck
47%
37/78
50%
13/26
4.286
 
 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) 2014 Jeremy Long. All Rights Reserved.
 17   
  */
 18   
 package org.owasp.dependencycheck.data.update;
 19   
 
 20   
 import java.io.IOException;
 21   
 import java.net.HttpURLConnection;
 22   
 import java.net.MalformedURLException;
 23   
 import java.net.URL;
 24   
 import org.apache.commons.io.IOUtils;
 25   
 import org.owasp.dependencycheck.data.nvdcve.CveDB;
 26   
 import org.owasp.dependencycheck.data.nvdcve.DatabaseException;
 27   
 import org.owasp.dependencycheck.data.nvdcve.DatabaseProperties;
 28   
 import org.owasp.dependencycheck.data.update.exception.UpdateException;
 29   
 import org.owasp.dependencycheck.utils.DateUtil;
 30   
 import org.owasp.dependencycheck.utils.DependencyVersion;
 31   
 import org.owasp.dependencycheck.utils.Settings;
 32   
 import org.owasp.dependencycheck.utils.URLConnectionFactory;
 33   
 import org.owasp.dependencycheck.utils.URLConnectionFailureException;
 34   
 import org.slf4j.Logger;
 35   
 import org.slf4j.LoggerFactory;
 36   
 
 37   
 /**
 38   
  *
 39   
  * @author Jeremy Long
 40   
  */
 41  2 
 public class EngineVersionCheck implements CachedWebDataSource {
 42   
 
 43   
     /**
 44   
      * Static logger.
 45   
      */
 46  1 
     private static final Logger LOGGER = LoggerFactory.getLogger(EngineVersionCheck.class);
 47   
     /**
 48   
      * The property key indicating when the last version check occurred.
 49   
      */
 50   
     public static final String ENGINE_VERSION_CHECKED_ON = "VersionCheckOn";
 51   
     /**
 52   
      * The property key indicating when the last version check occurred.
 53   
      */
 54   
     public static final String CURRENT_ENGINE_RELEASE = "CurrentEngineRelease";
 55   
     /**
 56   
      * Reference to the Cve Database.
 57   
      */
 58  2 
     private CveDB cveDB = null;
 59   
 
 60   
     /**
 61   
      * The version retrieved from the database properties or web to check against.
 62   
      */
 63   
     private String updateToVersion;
 64   
 
 65   
     /**
 66   
      * Getter for updateToVersion - only used for testing. Represents the version retrieved from the database.
 67   
      *
 68   
      * @return the version to test
 69   
      */
 70   
     protected String getUpdateToVersion() {
 71  0 
         return updateToVersion;
 72   
     }
 73   
 
 74   
     /**
 75   
      * Setter for updateToVersion - only used for testing. Represents the version retrieved from the database.
 76   
      *
 77   
      * @param version the version to test
 78   
      */
 79   
     protected void setUpdateToVersion(String version) {
 80  7 
         updateToVersion = version;
 81  7 
     }
 82   
 
 83   
     @Override
 84   
     public void update() throws UpdateException {
 85   
         try {
 86  0 
             openDatabase();
 87  0 
             LOGGER.debug("Begin Engine Version Check");
 88  0 
             final DatabaseProperties properties = cveDB.getDatabaseProperties();
 89  0 
             final long lastChecked = Long.parseLong(properties.getProperty(ENGINE_VERSION_CHECKED_ON, "0"));
 90  0 
             final long now = System.currentTimeMillis();
 91  0 
             updateToVersion = properties.getProperty(CURRENT_ENGINE_RELEASE, "");
 92  0 
             final String currentVersion = Settings.getString(Settings.KEYS.APPLICATION_VERSION, "0.0.0");
 93  0 
             LOGGER.debug("Last checked: {}", lastChecked);
 94  0 
             LOGGER.debug("Now: {}", now);
 95  0 
             LOGGER.debug("Current version: {}", currentVersion);
 96  0 
             final boolean updateNeeded = shouldUpdate(lastChecked, now, properties, currentVersion);
 97  0 
             if (updateNeeded) {
 98  0 
                 LOGGER.warn("A new version of dependency-check is available. Consider updating to version {}.",
 99   
                         updateToVersion);
 100   
             }
 101  0 
         } catch (DatabaseException ex) {
 102  0 
             LOGGER.debug("Database Exception opening databases to retrieve properties", ex);
 103  0 
             throw new UpdateException("Error occured updating database properties.");
 104   
         } finally {
 105  0 
             closeDatabase();
 106  0 
         }
 107  0 
     }
 108   
 
 109   
     /**
 110   
      * Determines if a new version of the dependency-check engine has been released.
 111   
      *
 112   
      * @param lastChecked the epoch time of the last version check
 113   
      * @param now the current epoch time
 114   
      * @param properties the database properties object
 115   
      * @param currentVersion the current version of dependency-check
 116   
      * @return <code>true</code> if a newer version of the database has been released; otherwise <code>false</code>
 117   
      * @throws UpdateException thrown if there is an error connecting to the github documentation site or accessing the local
 118   
      * database.
 119   
      */
 120   
     protected boolean shouldUpdate(final long lastChecked, final long now, final DatabaseProperties properties,
 121   
             String currentVersion) throws UpdateException {
 122   
         //check every 30 days if we know there is an update, otherwise check every 7 days
 123  7 
         int checkRange = 30;
 124  7 
         if (updateToVersion.isEmpty()) {
 125  2 
             checkRange = 7;
 126   
         }
 127  7 
         if (!DateUtil.withinDateRange(lastChecked, now, checkRange)) {
 128  2 
             LOGGER.debug("Checking web for new version.");
 129  2 
             final String currentRelease = getCurrentReleaseVersion();
 130  2 
             if (currentRelease != null) {
 131  2 
                 final DependencyVersion v = new DependencyVersion(currentRelease);
 132  2 
                 if (v.getVersionParts() != null && v.getVersionParts().size() >= 3) {
 133  2 
                     updateToVersion = v.toString();
 134  2 
                     if (!currentRelease.equals(updateToVersion)) {
 135  0 
                         properties.save(CURRENT_ENGINE_RELEASE, updateToVersion);
 136   
                     } else {
 137  2 
                         properties.save(CURRENT_ENGINE_RELEASE, "");
 138   
                     }
 139  2 
                     properties.save(ENGINE_VERSION_CHECKED_ON, Long.toString(now));
 140   
                 }
 141   
             }
 142  2 
             LOGGER.debug("Current Release: {}", updateToVersion);
 143   
         }
 144  7 
         final DependencyVersion running = new DependencyVersion(currentVersion);
 145  7 
         final DependencyVersion released = new DependencyVersion(updateToVersion);
 146  7 
         if (running.compareTo(released) < 0) {
 147  3 
             LOGGER.debug("Upgrade recommended");
 148  3 
             return true;
 149   
         }
 150  4 
         LOGGER.debug("Upgrade not needed");
 151  4 
         return false;
 152   
     }
 153   
 
 154   
     /**
 155   
      * Opens the CVE and CPE data stores.
 156   
      *
 157   
      * @throws DatabaseException thrown if a data store cannot be opened
 158   
      */
 159   
     protected final void openDatabase() throws DatabaseException {
 160  0 
         if (cveDB != null) {
 161  0 
             return;
 162   
         }
 163  0 
         cveDB = new CveDB();
 164  0 
         cveDB.open();
 165  0 
     }
 166   
 
 167   
     /**
 168   
      * Closes the CVE and CPE data stores.
 169   
      */
 170   
     protected void closeDatabase() {
 171  0 
         if (cveDB != null) {
 172   
             try {
 173  0 
                 cveDB.close();
 174  0 
                 cveDB = null;
 175  0 
             } catch (Throwable ignore) {
 176  0 
                 LOGGER.trace("Error closing the cveDB", ignore);
 177  0 
             }
 178   
         }
 179  0 
     }
 180   
 
 181   
     /**
 182   
      * Retrieves the current released version number from the github documentation site.
 183   
      *
 184   
      * @return the current released version number
 185   
      */
 186   
     protected String getCurrentReleaseVersion() {
 187  3 
         HttpURLConnection conn = null;
 188   
         try {
 189  3 
             final String str = Settings.getString(Settings.KEYS.ENGINE_VERSION_CHECK_URL, "http://jeremylong.github.io/DependencyCheck/current.txt");
 190  3 
             final URL url = new URL(str);
 191  3 
             conn = URLConnectionFactory.createHttpURLConnection(url);
 192  3 
             conn.connect();
 193  3 
             if (conn.getResponseCode() != 200) {
 194  0 
                 return null;
 195   
             }
 196  3 
             final String releaseVersion = IOUtils.toString(conn.getInputStream(), "UTF-8");
 197  3 
             if (releaseVersion != null) {
 198  3 
                 return releaseVersion.trim();
 199   
             }
 200  0 
         } catch (MalformedURLException ex) {
 201  0 
             LOGGER.debug("unable to retrieve current release version of dependency-check", ex);
 202  0 
         } catch (URLConnectionFailureException ex) {
 203  0 
             LOGGER.debug("unable to retrieve current release version of dependency-check", ex);
 204  0 
         } catch (IOException ex) {
 205  0 
             LOGGER.debug("unable to retrieve current release version of dependency-check", ex);
 206   
         } finally {
 207  3 
             if (conn != null) {
 208  3 
                 conn.disconnect();
 209   
             }
 210   
         }
 211  0 
         return null;
 212   
     }
 213   
 }
Report generated by Cobertura 2.1.1 on 11/29/15 7:26 AM.