");
- for (int i = 0; i < indent; i++) outputFile.print(" ");
- String firstSentence = null;
- if (idx == -1)
- firstSentence = rct;
- else
- firstSentence = rct.substring(0, idx+1);
- String firstSentenceNoTags = API.stuffHTMLTags(firstSentence);
- outputFile.println(firstSentenceNoTags);
- for (int i = 0; i < indent; i++) outputFile.print(" ");
- outputFile.println("");
- }
- }
- }
-
- /**
- * Find the index of the end of the first sentence in the given text,
- * when writing out to an XML file.
- * This is an extended version of the algorithm used by the DocCheck
- * Javadoc doclet. It checks for @tags too.
- *
- * @param text The text to be searched.
- * @return The index of the end of the first sentence. If there is no
- * end, return -1. If there is no useful text, return 0.
- * If the whole doc block comment is wanted (default), return -1.
- */
- public static int endOfFirstSentence(String text) {
- return endOfFirstSentence(text, true);
- }
-
- /**
- * Find the index of the end of the first sentence in the given text.
- * This is an extended version of the algorithm used by the DocCheck
- * Javadoc doclet. It checks for @tags too.
- *
- * @param text The text to be searched.
- * @param writingToXML Set to true when writing out XML.
- * @return The index of the end of the first sentence. If there is no
- * end, return -1. If there is no useful text, return 0.
- * If the whole doc block comment is wanted (default), return -1.
- */
- public static int endOfFirstSentence(String text, boolean writingToXML) {
- if (saveAllDocs && writingToXML)
- return -1;
- int textLen = text.length();
- if (textLen == 0)
- return 0;
- int index = -1;
- // Handle some special cases
- int fromindex = 0;
- int ellipsis = text.indexOf(". . ."); // Handles one instance of this
- if (ellipsis != -1)
- fromindex = ellipsis + 5;
- // If the first non-whitespace character is an @, go beyond it
- int i = 0;
- while (i < textLen && text.charAt(i) == ' ') {
- i++;
- }
- if (text.charAt(i) == '@' && fromindex < textLen-1)
- fromindex = i + 1;
- // Use the brute force approach.
- index = minIndex(index, text.indexOf("? ", fromindex));
- index = minIndex(index, text.indexOf("?\t", fromindex));
- index = minIndex(index, text.indexOf("?\n", fromindex));
- index = minIndex(index, text.indexOf("?\r", fromindex));
- index = minIndex(index, text.indexOf("?\f", fromindex));
- index = minIndex(index, text.indexOf("! ", fromindex));
- index = minIndex(index, text.indexOf("!\t", fromindex));
- index = minIndex(index, text.indexOf("!\n", fromindex));
- index = minIndex(index, text.indexOf("!\r", fromindex));
- index = minIndex(index, text.indexOf("!\f", fromindex));
- index = minIndex(index, text.indexOf(". ", fromindex));
- index = minIndex(index, text.indexOf(".\t", fromindex));
- index = minIndex(index, text.indexOf(".\n", fromindex));
- index = minIndex(index, text.indexOf(".\r", fromindex));
- index = minIndex(index, text.indexOf(".\f", fromindex));
- index = minIndex(index, text.indexOf("@param", fromindex));
- index = minIndex(index, text.indexOf("@return", fromindex));
- index = minIndex(index, text.indexOf("@throw", fromindex));
- index = minIndex(index, text.indexOf("@serial", fromindex));
- index = minIndex(index, text.indexOf("@exception", fromindex));
- index = minIndex(index, text.indexOf("@deprecate", fromindex));
- index = minIndex(index, text.indexOf("@author", fromindex));
- index = minIndex(index, text.indexOf("@since", fromindex));
- index = minIndex(index, text.indexOf("@see", fromindex));
- index = minIndex(index, text.indexOf("@version", fromindex));
- if (doExclude && excludeTag != null)
- index = minIndex(index, text.indexOf(excludeTag));
- index = minIndex(index, text.indexOf("@vtexclude", fromindex));
- index = minIndex(index, text.indexOf("@vtinclude", fromindex));
- index = minIndex(index, text.indexOf("", 2)); // Not at start
- index = minIndex(index, text.indexOf("
", 2)); // Not at start
- index = minIndex(index, text.indexOf(" -1, and return -1
- * only if both indexes = -1.
- * @param i an int index
- * @param j an int index
- * @return an int equal to the minimum index > -1, or -1
- */
- public static int minIndex(int i, int j) {
- if (i == -1) return j;
- if (j == -1) return i;
- return Math.min(i,j);
- }
-
- /**
- * The name of the file where the XML representing the API will be
- * stored.
- */
- public static String outputFileName = null;
-
- /**
- * The identifier of the API being written out in XML, e.g.
- * "SuperProduct 1.3".
- */
- public static String apiIdentifier = null;
-
- /**
- * The file where the XML representing the API will be stored.
- */
- private static PrintWriter outputFile = null;
-
- /**
- * The name of the directory where the XML representing the API will be
- * stored.
- */
- public static String outputDirectory = null;
-
- /**
- * Do not display a class with a lower level of visibility than this.
- * Default is to display all public and protected classes.
- */
- public static String classVisibilityLevel = "protected";
-
- /**
- * Do not display a member with a lower level of visibility than this.
- * Default is to display all public and protected members
- * (constructors, methods, fields).
- */
- public static String memberVisibilityLevel = "protected";
-
- /**
- * If set, then save the entire contents of a doc block comment in the
- * API file. If not set, then just save the first sentence. Default is
- * that this is set.
- */
- public static boolean saveAllDocs = true;
-
- /**
- * If set, exclude program elements marked with whatever the exclude tag
- * is specified as, e.g. "@exclude".
- */
- public static boolean doExclude = false;
-
- /**
- * Exclude program elements marked with this String, e.g. "@exclude".
- */
- public static String excludeTag = null;
-
- /**
- * The base URI for locating necessary DTDs and Schemas. By default, this
- * is "http://www.w3.org". A typical value to use local copies of DTD files
- * might be "file:///C:/jdiff/lib"
- */
- public static String baseURI = "http://www.w3.org";
-
- /**
- * If set, then strip out non-printing characters from documentation.
- * Default is that this is set.
- */
- static boolean stripNonPrintables = true;
-
- /**
- * If set, then add the information about the source file and line number
- * which is available in J2SE1.4. Default is that this is not set.
- */
- static boolean addSrcInfo = false;
-
- /**
- * If set, scan classes with no packages.
- * If the source is a jar file this may duplicates classes, so
- * disable it using the -packagesonly option. Default is that this is
- * not set.
- */
- static boolean packagesOnly = false;
-
- /** Set to enable increased logging verbosity for debugging. */
- private static boolean trace = false;
-
-} //RootDocToXML
diff --git a/thirdparty/jdiff/v-custom/src/jdiff/ScriptReport.java b/thirdparty/jdiff/v-custom/src/jdiff/ScriptReport.java
deleted file mode 100644
index d755378885..0000000000
--- a/thirdparty/jdiff/v-custom/src/jdiff/ScriptReport.java
+++ /dev/null
@@ -1,63 +0,0 @@
-package jdiff;
-
-import java.util.*;
-
-/**
- * Emit a standard text report with only the names
- * of all packages which need a major version number change.
- */
-public class ScriptReport {
-
- /** Default constructor. */
- public ScriptReport() { }
-
- /**
- * Checks to see if the tested module is backwards compatible.
- *
- * @return 100 if no changes
- * 101 if compatible changes
- * 102 if not compatible
- */
- public int run(APIComparator comp) {
- // Get the APIDiff
- APIDiff apiDiff = comp.apiDiff;
-
- if(apiDiff.packagesRemoved.size() > 0) {
- return 102;
- }
-
- Iterator piter = apiDiff.packagesChanged.iterator();
- while (piter.hasNext()) {
- PackageDiff pkgDiff = (PackageDiff)(piter.next());
- if(pkgDiff.classesRemoved.size() > 0) {
- return 102;
- }
-
- Iterator citer = pkgDiff.classesChanged.iterator();
- while(citer.hasNext()) {
- ClassDiff classDiff = (ClassDiff)(citer.next());
- if(classDiff.methodsRemoved.size() > 0) {
- return 102;
- }
-
- Iterator miter = classDiff.methodsChanged.iterator();
- while (miter.hasNext()) {
- // Check if method has different return type
- MemberDiff memberDiff = (MemberDiff)(miter.next());
- if(!memberDiff.oldType_ .equals(memberDiff.newType_)) {
- return 102;
- }
- }
- }
- }
-
- // If there were any changes, but we haven't returned yet
- // they must all be backwards compatible changes
- if(apiDiff.packagesChanged.size() > 0) {
- return 101;
- }
- // If we've reached here there must be no changes at all
- return 100;
- }
-
-}
diff --git a/thirdparty/jdiff/v-custom/src/jdiff/SingleComment.java b/thirdparty/jdiff/v-custom/src/jdiff/SingleComment.java
deleted file mode 100644
index 387dac9e1f..0000000000
--- a/thirdparty/jdiff/v-custom/src/jdiff/SingleComment.java
+++ /dev/null
@@ -1,34 +0,0 @@
-package jdiff;
-
-import java.io.*;
-import java.util.*;
-
-/**
- * Represents a single comment element. Has an identifier and some text.
- *
- * See the file LICENSE.txt for copyright details.
- * @author Matthew Doar, mdoar@pobox.com
- */
-class SingleComment implements Comparable {
-
- /** The identifier for this comment. */
- public String id_ = null;
-
- /** The text of this comment. */
- public String text_ = null;
-
- /** If false, then this comment is inactive. */
- public boolean isUsed_ = true;
-
- public SingleComment(String id, String text) {
- // Escape the commentID in case it contains "<" or ">"
- // characters (generics)
- id_ = id.replaceAll("<", "<").replaceAll(">", ">");;
- text_ = text;
- }
-
- /** Compare two SingleComment objects using just the id. */
- public int compareTo(Object o) {
- return id_.compareTo(((SingleComment)o).id_);
- }
-}
diff --git a/thirdparty/jdiff/v-custom/src/jdiff/StreamReader.java b/thirdparty/jdiff/v-custom/src/jdiff/StreamReader.java
deleted file mode 100644
index 124fe850f2..0000000000
--- a/thirdparty/jdiff/v-custom/src/jdiff/StreamReader.java
+++ /dev/null
@@ -1,36 +0,0 @@
-package jdiff;
-
-import java.util.*;
-import java.io.*;
-
-/**
- * Reads in lines from an input stream and displays them.
- *
- * See the file LICENSE.txt for copyright details.
- * @author Matthew Doar, mdoar@pobox.com.
- */
-class StreamReader extends Thread {
- /** The input stream. */
- InputStream is_;
-
- /** Constructor which takes an InputStream. */
- StreamReader(InputStream is) {
- is_ = is;
- }
-
- /** Method which is called when this thread is started. */
- public void run() {
- try {
- InputStreamReader isr = new InputStreamReader(is_);
- BufferedReader br = new BufferedReader(isr);
- String line = null;
- while((line = br.readLine()) != null)
- System.out.println(line);
- } catch (IOException ioe) {
- System.out.println("IO Error invoking Javadoc");
- ioe.printStackTrace();
- } catch (Exception e) {
- // Ignore read errors which indicate that the process is complete
- }
- }
-}
diff --git a/thirdparty/jdiff/v-custom/src/jdiff/XMLToAPI.java b/thirdparty/jdiff/v-custom/src/jdiff/XMLToAPI.java
deleted file mode 100644
index 8937a66120..0000000000
--- a/thirdparty/jdiff/v-custom/src/jdiff/XMLToAPI.java
+++ /dev/null
@@ -1,377 +0,0 @@
-package jdiff;
-
-import java.io.*;
-import java.util.*;
-
-/* For SAX parsing in APIHandler */
-import org.xml.sax.Attributes;
-import org.xml.sax.SAXException;
-import org.xml.sax.SAXParseException;
-import org.xml.sax.XMLReader;
-import org.xml.sax.InputSource;
-import org.xml.sax.helpers.*;
-
-/**
- * Creates an API object from an XML file. The API object is the internal
- * representation of an API.
- * All methods in this class for populating an API object are static.
- *
- * See the file LICENSE.txt for copyright details.
- * @author Matthew Doar, mdoar@pobox.com
- */
-public class XMLToAPI {
-
- /** The instance of the API object which is populated from the file. */
- private static API api_ = null;
-
- /** Default constructor. */
- private XMLToAPI() {
- }
-
- /**
- * Read the file where the XML representing the API is stored.
- *
- * @param filename The full name of the file containing the XML
- * representing the API
- * @param createGlobalComments If set, then store possible comments
- * @param apiName The simple name of the API file. If -oldapidir and
- * -newapidir are not used, then this is the same as
- * the filename parameter
- */
- public static API readFile(String filename, boolean createGlobalComments,
- String apiName) {
- // The instance of the API object which is populated from the file.
- api_ = new API();
- api_.name_ = apiName; // Checked later
- try {
- XMLReader parser = null;
- DefaultHandler handler = new APIHandler(api_, createGlobalComments);
- try {
- String parserName = System.getProperty("org.xml.sax.driver");
- if (parserName == null) {
- parser = org.xml.sax.helpers.XMLReaderFactory.createXMLReader("org.apache.xerces.parsers.SAXParser");
- } else {
- // Let the underlying mechanisms try to work out which
- // class to instantiate
- parser = org.xml.sax.helpers.XMLReaderFactory.createXMLReader();
- }
- } catch (SAXException saxe) {
- System.out.println("SAXException: " + saxe);
- saxe.printStackTrace();
- System.exit(1);
- }
- if (validateXML) {
- parser.setFeature("http://xml.org/sax/features/namespaces", true);
- parser.setFeature("http://xml.org/sax/features/validation", true);
- parser.setFeature("http://apache.org/xml/features/validation/schema", true);
- }
-
- parser.setContentHandler(handler);
- parser.setErrorHandler(handler);
- parser.parse(new InputSource(new FileInputStream(new File(filename))));
- } catch(org.xml.sax.SAXNotRecognizedException snre) {
- System.out.println("SAX Parser does not recognize feature: " + snre);
- snre.printStackTrace();
- System.exit(1);
- } catch(org.xml.sax.SAXNotSupportedException snse) {
- System.out.println("SAX Parser feature is not supported: " + snse);
- snse.printStackTrace();
- System.exit(1);
- } catch(org.xml.sax.SAXException saxe) {
- System.out.println("SAX Exception parsing file '" + filename + "' : " + saxe);
- saxe.printStackTrace();
- System.exit(1);
- } catch(java.io.IOException ioe) {
- System.out.println("IOException parsing file '" + filename + "' : " + ioe);
- ioe.printStackTrace();
- System.exit(1);
- }
-
- // Add the inherited methods and fields to each class
- addInheritedElements();
- return api_;
- } //readFile()
-
- /**
- * Add the inherited methods and fields to each class in turn.
- */
- public static void addInheritedElements() {
- Iterator iter = api_.packages_.iterator();
- while (iter.hasNext()) {
- PackageAPI pkg = (PackageAPI)(iter.next());
- Iterator iter2 = pkg.classes_.iterator();
- while (iter2.hasNext()) {
- ClassAPI cls = (ClassAPI)(iter2.next());
- // Look up any inherited classes or interfaces
- if (cls.extends_ != null) {
- ClassAPI parent = (ClassAPI)api_.classes_.get(cls.extends_);
- if (parent != null)
- addInheritedElements(cls, parent, cls.extends_);
- }
- if (cls.implements_.size() != 0) {
- Iterator iter3 = cls.implements_.iterator();
- while (iter3.hasNext()) {
- String implName = (String)(iter3.next());
- ClassAPI parent = (ClassAPI)api_.classes_.get(implName);
- if (parent != null)
- addInheritedElements(cls, parent, implName);
- }
- }
- } //while (iter2.hasNext())
- } //while (iter.hasNext())
- }
-
- /**
- * Add all the inherited methods and fields in the second class to
- * the first class, marking them as inherited from the second class.
- * Do not add a method or a field if it is already defined locally.
- *
- * Only elements at the specified visibility level or
- * higher appear in the XML file. All that remains to be tested for
- * a private element, which is never inherited.
- *
- * If the parent class inherits any classes or interfaces, call this
- * method recursively with those parents.
- */
- public static void addInheritedElements(ClassAPI child, ClassAPI parent,
- String fqParentName) {
- if (parent.methods_.size() != 0) {
- Iterator iter = parent.methods_.iterator();
- while (iter.hasNext()) {
- MethodAPI m = (MethodAPI)(iter.next());
- // See if it the method is overridden locally
- boolean overridden = false;
- Iterator iter2 = child.methods_.iterator();
- while (iter2.hasNext()) {
- MethodAPI localM = (MethodAPI)(iter2.next());
- if (localM.name_.compareTo(m.name_) == 0 &&
- localM.getSignature().compareTo(m.getSignature()) == 0)
- overridden = true;
- }
- if (!overridden && m.inheritedFrom_ == null &&
- m.modifiers_.visibility != null &&
- m.modifiers_.visibility.compareTo("private") != 0) {
- MethodAPI m2 = new MethodAPI(m);
- m2.inheritedFrom_ = fqParentName;
- child.methods_.add(m2);
- }
- }
- }
- if (parent.fields_.size() != 0) {
- Iterator iter = parent.fields_.iterator();
- while (iter.hasNext()) {
- FieldAPI f = (FieldAPI)(iter.next());
- if (child.fields_.indexOf(f) == -1 &&
- f.inheritedFrom_ == null &&
- f.modifiers_.visibility != null &&
- f.modifiers_.visibility.compareTo("private") != 0) {
- FieldAPI f2 = new FieldAPI(f);
- f2.inheritedFrom_ = fqParentName;
- child.fields_.add(f2);
- }
- }
- }
-
- // Look up any inherited classes or interfaces
- if (parent.extends_ != null) {
- ClassAPI parent2 = (ClassAPI)api_.classes_.get(parent.extends_);
- if (parent2 != null)
- addInheritedElements(child, parent2, parent.extends_);
- }
- if (parent.implements_.size() != 0) {
- Iterator iter3 = parent.implements_.iterator();
- while (iter3.hasNext()) {
- String implName = (String)(iter3.next());
- ClassAPI parent2 = (ClassAPI)api_.classes_.get(implName);
- if (parent2 != null)
- addInheritedElements(child, parent2, implName);
- }
- }
- }
-
-//
-// Methods to add data to an API object. Called by the XML parser.
-//
-
- /**
- * Set the name of the API object.
- *
- * @param name The name of the package.
- */
- public static void nameAPI(String name) {
- if (name == null) {
- System.out.println("Error: no API identifier found in the XML file '" + api_.name_ + "'");
- System.exit(3);
- }
- // Check the given name against the filename currently stored in
- // the name_ field
- String filename2 = name.replace(' ','_');
- filename2 += ".xml";
- if (filename2.compareTo(api_.name_) != 0) {
- System.out.println("Warning: API identifier in the XML file (" +
- name + ") differs from the name of the file '" +
- api_.name_ + "'");
- }
- api_.name_ = name;
- }
-
- /**
- * Create a new package and add it to the API. Called by the XML parser.
- *
- * @param name The name of the package.
- */
- public static void addPackage(String name) {
- api_.currPkg_ = new PackageAPI(name);
- api_.packages_.add(api_.currPkg_);
- }
-
- /**
- * Create a new class and add it to the current package. Called by the XML parser.
- *
- * @param name The name of the class.
- * @param parent The name of the parent class, null if no class is extended.
- * @param modifiers Modifiers for this class.
- */
- public static void addClass(String name, String parent,
- boolean isAbstract,
- Modifiers modifiers) {
- api_.currClass_ = new ClassAPI(name, parent, false, isAbstract, modifiers);
- api_.currPkg_.classes_.add(api_.currClass_);
- String fqName = api_.currPkg_.name_ + "." + name;
- ClassAPI caOld = (ClassAPI)api_.classes_.put(fqName, api_.currClass_);
- if (caOld != null) {
- System.out.println("Warning: duplicate class : " + fqName + " found. Using the first instance only.");
- }
- }
-
- /**
- * Add an new interface and add it to the current package. Called by the
- * XML parser.
- *
- * @param name The name of the interface.
- * @param parent The name of the parent interface, null if no
- * interface is extended.
- */
- public static void addInterface(String name, String parent,
- boolean isAbstract,
- Modifiers modifiers) {
- api_.currClass_ = new ClassAPI(name, parent, true, isAbstract, modifiers);
- api_.currPkg_.classes_.add(api_.currClass_);
- }
-
- /**
- * Add an inherited interface to the current class. Called by the XML
- * parser.
- *
- * @param name The name of the inherited interface.
- */
- public static void addImplements(String name) {
- api_.currClass_.implements_.add(name);
- }
-
- /**
- * Add a constructor to the current class. Called by the XML parser.
- *
- * @param name The name of the constructor.
- * @param type The type of the constructor.
- * @param modifiers Modifiers for this constructor.
- */
- public static void addCtor(String type, Modifiers modifiers) {
- String t = type;
- if (t == null)
- t = "void";
- api_.currCtor_ = new ConstructorAPI(t, modifiers);
- api_.currClass_.ctors_.add(api_.currCtor_);
- }
-
- /**
- * Add a method to the current class. Called by the XML parser.
- *
- * @param name The name of the method.
- * @param returnType The return type of the method, null if it is void.
- * @param modifiers Modifiers for this method.
- */
- public static void addMethod(String name, String returnType,
- boolean isAbstract, boolean isNative,
- boolean isSynchronized, Modifiers modifiers) {
- String rt = returnType;
- if (rt == null)
- rt = "void";
- api_.currMethod_ = new MethodAPI(name, rt, isAbstract, isNative,
- isSynchronized, modifiers);
- api_.currClass_.methods_.add(api_.currMethod_);
- }
-
- /**
- * Add a field to the current class. Called by the XML parser.
- *
- * @param name The name of the field.
- * @param type The type of the field, null if it is void.
- * @param modifiers Modifiers for this field.
- */
- public static void addField(String name, String type, boolean isTransient,
- boolean isVolatile, String value, Modifiers modifiers) {
- String t = type;
- if (t == null)
- t = "void";
- api_.currField_ = new FieldAPI(name, t, isTransient, isVolatile, value, modifiers);
- api_.currClass_.fields_.add(api_.currField_);
- }
-
- /**
- * Add a parameter to the current method. Called by the XML parser.
- * Constuctors have their type (signature) in an attribute, since it
- * is often shorter and makes parsing a little easier.
- *
- * @param name The name of the parameter.
- * @param type The type of the parameter, null if it is void.
- */
- public static void addParam(String name, String type) {
- String t = type;
- if (t == null)
- t = "void";
- ParamAPI paramAPI = new ParamAPI(name, t);
- api_.currMethod_.params_.add(paramAPI);
- }
-
- /**
- * Add an exception to the current method or constructor.
- * Called by the XML parser.
- *
- * @param name The name of the parameter.
- * @param type The type of the parameter.
- * May be null in JDiff1.0.8 and earlier versions.
- * @param currElement Name of the current element.
- */
- public static void addException(String name, String type, String currElement) {
- String exceptionId = type;
- if (type == null || !showExceptionTypes)
- exceptionId = name;
- if (currElement.compareTo("method") == 0) {
- if (api_.currMethod_.exceptions_.compareTo("no exceptions") == 0)
- api_.currMethod_.exceptions_ = exceptionId;
- else
- api_.currMethod_.exceptions_ += ", " + exceptionId;
- } else {
- if (api_.currCtor_.exceptions_.compareTo("no exceptions") == 0)
- api_.currCtor_.exceptions_ = exceptionId;
- else
- api_.currCtor_.exceptions_ += ", " + exceptionId;
- }
- }
-
- /**
- * If set, validate the XML which represents an API. By default, this is
- * not set for reasons of efficiency, and also because if JDiff generated
- * the XML, it should not need validating.
- */
- public static boolean validateXML = false;
-
- /**
- * If set, then store and display the whole qualified name of exceptions.
- * If not set, then store and display just the name of the exception,
- * which is shorter, but may not detect when an exception changes class,
- * but retains the same name.
- */
- private static boolean showExceptionTypes = true;
-}
diff --git a/update_versions.py b/update_versions.py
deleted file mode 100644
index cd7c025ab9..0000000000
--- a/update_versions.py
+++ /dev/null
@@ -1,971 +0,0 @@
-#
-# Autopsy Forensic Browser
-#
-# Copyright 2012-2013 Basis Technology Corp.
-# Contact: carrier sleuthkit org
-#
-# 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.
-
-
-#######################
-# This script exists to help us determine update the library
-# versions appropriately. See this page for version details.
-#
-# http://wiki.sleuthkit.org/index.php?title=Autopsy_3_Module_Versions
-#
-# The basic idea is that this script uses javadoc/jdiff to
-# compare the current state of the source code to the last
-# tag and identifies if APIs were removed, added, etc.
-#
-# When run from the Autopsy build script, this script will:
-# - Clone Autopsy and checkout to the previous release tag
-# as found in the NEWS.txt file
-# - Auto-discover all modules and packages
-# - Run jdiff, comparing the current and previous modules
-# - Use jdiff's output to determine if each module
-# a) has no changes
-# b) has backwards compatible changes
-# c) has backwards incompatible changes
-# - Based off it's compatibility, updates each module's
-# a) Major version
-# b) Specification version
-# c) Implementation version
-# - Updates the dependencies on each module depending on the
-# updated version numbers
-#
-# Optionally, when run from the command line, one can provide the
-# desired tag to compare the current version to, the directory for
-# the current version of Autopsy, and whether to automatically
-# update the version numbers and dependencies.
-# ------------------------------------------------------------
-
-import errno
-import os
-import shutil
-import stat
-import subprocess
-import sys
-import traceback
-from os import remove, close
-from shutil import move
-from tempfile import mkstemp
-from xml.dom.minidom import parse, parseString
-
-# Jdiff return codes. Described in more detail further on
-NO_CHANGES = 100
-COMPATIBLE = 101
-NON_COMPATIBLE = 102
-ERROR = 1
-
-# Set this to true when developing the script. It does not delete
-# the cloned repo each time - making it much faster to run.
-TESTING = False
-
-# An Autopsy module object
-class Module:
- # Initialize it with a name, return code, and version numbers
- def __init__(self, name=None, ret=None, versions=None):
- self.name = name
- self.ret = ret
- self.versions = versions
- # As a string, the module should be it's name
- def __str__(self):
- return self.name
- def __repr__(self):
- return self.name
- # When compared to another module, the two are equal if the names are the same
- def __cmp__(self, other):
- if isinstance(other, Module):
- if self.name == other.name:
- return 0
- elif self.name < other.name:
- return -1
- else:
- return 1
- return 1
- def __eq__(self, other):
- if isinstance(other, Module):
- if self.name == other.name:
- return True
- return False
- def set_name(self, name):
- self.name = name
- def set_ret(self, ret):
- self.ret = ret
- def set_versions(self, versions):
- self.versions = versions
- def spec(self):
- return self.versions[0]
- def impl(self):
- return self.versions[1]
- def release(self):
- return self.versions[2]
-
-# Representation of the Specification version number
-class Spec:
- # Initialize specification number, where num is a string like x.y
- def __init__(self, num):
- self.third = None
- spec_nums = num.split(".")
- if len(spec_nums) == 3:
- self.final = spec_nums[2]
- self.third = int(self.final)
- l, r = spec_nums[0], spec_nums[1]
-
- self.left = int(l)
- self.right = int(r)
-
- def __str__(self):
- return self.get()
- def __cmp__(self, other):
- if isinstance(other, Spec):
- if self.left == other.left:
- if self.right == other.right:
- return 0
- if self.right < other.right:
- return -1
- return 1
- if self.left < other.left:
- return -1
- return 1
- elif isinstance(other, str):
- l, r = other.split(".")
- if self.left == int(l):
- if self.right == int(r):
- return 0
- if self.right < int(r):
- return -1
- return 1
- if self.left < int(l):
- return -1
- return 1
- return -1
-
- def incrementIncompat(self):
- return str(self.left + 1) + ".0"
- def incrementCompat(self):
- return str(self.left) + "." + str(self.right + 1)
- def get(self):
- spec_str = str(self.left) + "." + str(self.right)
- if self.third is not None:
- spec_str += "." + str(self.final)
- return spec_str
- def set(self, num):
- if isinstance(num, str):
- l, r = num.split(".")
- self.left = int(l)
- self.right = int(r)
- elif isinstance(num, Spec):
- self.left = num.left
- self.right = num.right
- return self
-
-# ================================ #
-# Core Functions #
-# ================================ #
-
-# Given a list of modules and the names for each version, compare
-# the generated jdiff XML for each module and output the jdiff
-# JavaDocs.
-#
-# modules: the list of all modules both versions have in common
-# apiname_tag: the api name of the previous version, most likely the tag
-# apiname_cur: the api name of the current version, most likely "Current"
-#
-# returns the exit code from the modified jdiff.jar
-# return code 1 = error in jdiff
-# return code 100 = no changes
-# return code 101 = compatible changes
-# return code 102 = incompatible changes
-def compare_xml(module, apiname_tag, apiname_cur):
- global docdir
- make_dir(docdir)
- null_file = fix_path(os.path.abspath("./thirdparty/jdiff/v-custom/lib/Null.java"))
- jdiff = fix_path(os.path.abspath("./thirdparty/jdiff/v-custom/jdiff.jar"))
- oldapi = fix_path("build/jdiff-xml/" + apiname_tag + "-" + module.name)
- newapi = fix_path("build/jdiff-xml/" + apiname_cur + "-" + module.name)
- docs = fix_path(docdir + "/" + module.name)
- # Comments are strange. They look for a file with additional user comments in a
- # directory like docs/user_comments_for_xyz. The problem being that xyz is the
- # path to the new/old api. So xyz turns into multiple directories for us.
- # i.e. user_comments_for_build/jdiff-xml/[tag name]-[module name]_to_build/jdiff-xml
- comments = fix_path(docs + "/user_comments_for_build")
- jdiff_com = fix_path(comments + "/jdiff-xml")
- tag_comments = fix_path(jdiff_com + "/" + apiname_tag + "-" + module.name + "_to_build")
- jdiff_tag_com = fix_path(tag_comments + "/jdiff-xml")
-
- if not os.path.exists(jdiff):
- print("JDIFF doesn't exist.")
-
- make_dir(docs)
- make_dir(comments)
- make_dir(jdiff_com)
- make_dir(tag_comments)
- make_dir(jdiff_tag_com)
- make_dir("jdiff-logs")
- log = open("jdiff-logs/COMPARE-" + module.name + ".log", "w")
- cmd = ["javadoc",
- "-doclet", "jdiff.JDiff",
- "-docletpath", jdiff,
- "-d", docs,
- "-oldapi", oldapi,
- "-newapi", newapi,
- "-script",
- null_file]
- try:
- jdiff = subprocess.Popen(cmd, stdout=log, stderr=log)
- jdiff.wait()
- code = jdiff.returncode
- except Exception:
- printt("Error executing javadoc. Exiting...")
- exit(1)
- log.close()
-
- print("Compared XML for " + module.name)
- if code == NO_CHANGES:
- print(" No API changes")
- elif code == COMPATIBLE:
- print(" API Changes are backwards compatible")
- elif code == NON_COMPATIBLE:
- print(" API Changes are not backwards compatible")
- else:
- print(" *Error in XML, most likely an empty module")
- sys.stdout.flush()
- return code
-
-# Generate the jdiff xml for the given module
-# path: path to the autopsy source
-# module: Module object
-# name: api name for jdiff
-def gen_xml(path, modules, name):
- for module in modules:
- # If its the regression test, the source is in the "test" dir
- if module.name == "Testing":
- src = os.path.join(path, module.name, "test", "qa-functional", "src")
- else:
- src = os.path.join(path, module.name, "src")
- # xerces = os.path.abspath("./lib/xerces.jar")
- xml_out = fix_path(os.path.abspath("./build/jdiff-xml/" + name + "-" + module.name))
- jdiff = fix_path(os.path.abspath("./thirdparty/jdiff/v-custom/jdiff.jar"))
- make_dir("build/jdiff-xml")
- make_dir("jdiff-logs")
- log = open("jdiff-logs/GEN_XML-" + name + "-" + module.name + ".log", "w")
- cmd = ["javadoc",
- "-doclet", "jdiff.JDiff",
- "-docletpath", jdiff, # ;" + xerces, <-- previous problems required this
- "-apiname", xml_out, # leaving it in just in case it's needed once again
- "-sourcepath", fix_path(src)]
- cmd = cmd + get_packages(src)
- try:
- jdiff = subprocess.Popen(cmd, stdout=log, stderr=log)
- jdiff.wait()
- except Exception:
- printt("Error executing javadoc. Exiting...")
- exit(1)
- log.close()
- print("Generated XML for " + name + " " + module.name)
- sys.stdout.flush()
-
-# Find all the modules in the given path
-def find_modules(path):
- modules = []
- # Step into each folder in the given path and
- # see if it has manifest.mf - if so, it's a module
- for dir in os.listdir(path):
- directory = os.path.join(path, dir)
- if os.path.isdir(directory):
- for file in os.listdir(directory):
- if file == "manifest.mf":
- modules.append(Module(dir, None, None))
- return modules
-
-# Detects the differences between the source and tag modules
-def module_diff(source_modules, tag_modules):
- added_modules = [x for x in source_modules if x not in tag_modules]
- removed_modules = [x for x in tag_modules if x not in source_modules]
- similar_modules = [x for x in source_modules if x in tag_modules]
-
- added_modules = (added_modules if added_modules else [])
- removed_modules = (removed_modules if removed_modules else [])
- similar_modules = (similar_modules if similar_modules else [])
- return similar_modules, added_modules, removed_modules
-
-# Reads the previous tag from NEWS.txt
-def get_tag(sourcepath):
- news = open(sourcepath + "/NEWS.txt", "r")
- second_instance = False
- for line in news:
- if "----------------" in line:
- if second_instance:
- ver = line.split("VERSION ")[1]
- ver = ver.split(" -")[0]
- return ("autopsy-" + ver).strip()
- else:
- second_instance = True
- continue
- news.close()
-
-
-# ========================================== #
-# Dependency Functions #
-# ========================================== #
-
-# Write a new XML file, copying all the lines from projectxml
-# and replacing the specification version for the code-name-base base
-# with the supplied specification version spec
-def set_dep_spec(projectxml, base, spec):
- print(" Updating Specification version..")
- orig = open(projectxml, "r")
- f, abs_path = mkstemp()
- new_file = open(abs_path, "w")
- found_base = False
- spacing = " "
- sopen = ""
- sclose = "\n"
- for line in orig:
- if base in line:
- found_base = True
- if found_base and sopen in line:
- update = spacing + sopen + str(spec) + sclose
- new_file.write(update)
- else:
- new_file.write(line)
- new_file.close()
- close(f)
- orig.close()
- remove(projectxml)
- move(abs_path, projectxml)
-
-# Write a new XML file, copying all the lines from projectxml
-# and replacing the release version for the code-name-base base
-# with the supplied release version
-def set_dep_release(projectxml, base, release):
- print(" Updating Release version..")
- orig = open(projectxml, "r")
- f, abs_path = mkstemp()
- new_file = open(abs_path, "w")
- found_base = False
- spacing = " "
- ropen = ""
- rclose = "\n"
- for line in orig:
- if base in line:
- found_base = True
- if found_base and ropen in line:
- update = spacing + ropen + str(release) + rclose
- new_file.write(update)
- else:
- new_file.write(line)
- new_file.close()
- close(f)
- orig.close()
- remove(projectxml)
- move(abs_path, projectxml)
-
-# Return the dependency versions in the XML dependency node
-def get_dep_versions(dep):
- run_dependency = dep.getElementsByTagName("run-dependency")[0]
- release_version = run_dependency.getElementsByTagName("release-version")
- if release_version:
- release_version = getTagText(release_version[0].childNodes)
- specification_version = run_dependency.getElementsByTagName("specification-version")
- if specification_version:
- specification_version = getTagText(specification_version[0].childNodes)
- return int(release_version), Spec(specification_version)
-
-# Given a code-name-base, see if it corresponds with any of our modules
-def get_module_from_base(modules, code_name_base):
- for module in modules:
- if "org.sleuthkit.autopsy." + module.name.lower() == code_name_base:
- return module
- return None # If it didn't match one of our modules
-
-# Check the text between two XML tags
-def getTagText(nodelist):
- for node in nodelist:
- if node.nodeType == node.TEXT_NODE:
- return node.data
-
-# Check the projectxml for a dependency on any module in modules
-def check_for_dependencies(projectxml, modules):
- dom = parse(projectxml)
- dep_list = dom.getElementsByTagName("dependency")
- for dep in dep_list:
- code_name_base = dep.getElementsByTagName("code-name-base")[0]
- code_name_base = getTagText(code_name_base.childNodes)
- module = get_module_from_base(modules, code_name_base)
- if module:
- print(" Found dependency on " + module.name)
- release, spec = get_dep_versions(dep)
- if release != module.release() and module.release() is not None:
- set_dep_release(projectxml, code_name_base, module.release())
- else: print(" Release version is correct")
- if spec != module.spec() and module.spec() is not None:
- set_dep_spec(projectxml, code_name_base, module.spec())
- else: print(" Specification version is correct")
-
-# Given the module and the source directory, return
-# the paths to the manifest and project properties files
-def get_dependency_file(module, source):
- projectxml = os.path.join(source, module.name, "nbproject", "project.xml")
- if os.path.isfile(projectxml):
- return projectxml
-
-# Verify/Update the dependencies for each module, basing the dependency
-# version number off the versions in each module
-def update_dependencies(modules, source):
- for module in modules:
- print("Checking the dependencies for " + module.name + "...")
- projectxml = get_dependency_file(module, source)
- if projectxml == None:
- print(" Error finding project xml file")
- else:
- other = [x for x in modules]
- check_for_dependencies(projectxml, other)
- sys.stdout.flush()
-
-# ======================================== #
-# Versioning Functions #
-# ======================================== #
-
-# Return the specification version in the given project.properties/manifest.mf file
-def get_specification(project, manifest):
- try:
- # Try to find it in the project file
- # it will be there if impl version is set to append automatically
- f = open(project, 'r')
- for line in f:
- if "spec.version.base" in line:
- return Spec(line.split("=")[1].strip())
- f.close()
- # If not found there, try the manifest file
- f = open(manifest, 'r')
- for line in f:
- if "OpenIDE-Module-Specification-Version:" in line:
- return Spec(line.split(": ")[1].strip())
- except Exception as e:
- print("Error parsing Specification version for")
- print(project)
- print(e)
-
-# Set the specification version in the given project properties file
-# but if it can't be found there, set it in the manifest file
-def set_specification(project, manifest, num):
- try:
- # First try the project file
- f = open(project, 'r')
- for line in f:
- if "spec.version.base" in line:
- f.close()
- replace(project, line, "spec.version.base=" + str(num) + "\n")
- return
- f.close()
- # If it's not there, try the manifest file
- f = open(manifest, 'r')
- for line in f:
- if "OpenIDE-Module-Specification-Version:" in line:
- f.close()
- replace(manifest, line, "OpenIDE-Module-Specification-Version: " + str(num) + "\n")
- return
- # Otherwise we're out of luck
- print(" Error finding the Specification version to update")
- print(" " + manifest)
- f.close()
- except:
- print(" Error incrementing Specification version for")
- print(" " + project)
-
-# Return the implementation version in the given manifest.mf file
-def get_implementation(manifest):
- try:
- f = open(manifest, 'r')
- for line in f:
- if "OpenIDE-Module-Implementation-Version" in line:
- return int(line.split(": ")[1].strip())
- f.close()
- except:
- print("Error parsing Implementation version for")
- print(manifest)
-
-# Set the implementation version in the given manifest file
-def set_implementation(manifest, num):
- try:
- f = open(manifest, 'r')
- for line in f:
- if "OpenIDE-Module-Implementation-Version" in line:
- f.close()
- replace(manifest, line, "OpenIDE-Module-Implementation-Version: " + str(num) + "\n")
- return
- # If it isn't there, add it
- f.close()
- write_implementation(manifest, num)
- except:
- print(" Error incrementing Implementation version for")
- print(" " + manifest)
-
-# Rewrite the manifest file to include the implementation version
-def write_implementation(manifest, num):
- f = open(manifest, "r")
- contents = f.read()
- contents = contents[:-2] + "OpenIDE-Module-Implementation-Version: " + str(num) + "\n\n"
- f.close()
- f = open(manifest, "w")
- f.write(contents)
- f.close()
-
-# Return the release version in the given manifest.mf file
-def get_release(manifest):
- try:
- f = open(manifest, 'r')
- for line in f:
- if "OpenIDE-Module:" in line:
- return int(line.split("/")[1].strip())
- f.close()
- except:
- #print("Error parsing Release version for")
- #print(manifest)
- return 0
-
-# Set the release version in the given manifest file
-def set_release(manifest, num):
- try:
- f = open(manifest, 'r')
- for line in f:
- if "OpenIDE-Module:" in line:
- f.close()
- index = line.index('/') - len(line) + 1
- newline = line[:index] + str(num)
- replace(manifest, line, newline + "\n")
- return
- print(" Error finding the release version to update")
- print(" " + manifest)
- f.close()
- except:
- print(" Error incrementing release version for")
- print(" " + manifest)
-
-# Given the module and the source directory, return
-# the paths to the manifest and project properties files
-def get_version_files(module, source):
- manifest = os.path.join(source, module.name, "manifest.mf")
- project = os.path.join(source, module.name, "nbproject", "project.properties")
- if os.path.isfile(manifest) and os.path.isfile(project):
- return manifest, project
-
-# Returns a the current version numbers for the module in source
-def get_versions(module, source):
- manifest, project = get_version_files(module, source)
- if manifest == None or project == None:
- print(" Error finding manifeset and project properties files")
- return
- spec = get_specification(project, manifest)
- impl = get_implementation(manifest)
- release = get_release(manifest)
- return [spec, impl, release]
-
-# Update the version numbers for every module in modules
-def update_versions(modules, source):
- for module in modules:
- versions = module.versions
- manifest, project = get_version_files(module, source)
- print("Updating " + module.name + "...")
- if manifest == None or project == None:
- print(" Error finding manifeset and project properties files")
- return
- if module.ret == COMPATIBLE:
- versions = [versions[0].set(versions[0].incrementCompat()), versions[1] + 1, versions[2]]
- set_specification(project, manifest, versions[0])
- set_implementation(manifest, versions[1])
- module.set_versions(versions)
- elif module.ret == NON_COMPATIBLE:
- versions = [versions[0].set(versions[0].incrementIncompat()), versions[1] + 1, versions[2] + 1]
- set_specification(project, manifest, versions[0])
- set_implementation(manifest, versions[1])
- set_release(manifest, versions[2])
- module.set_versions(versions)
- elif module.ret == NO_CHANGES:
- versions = [versions[0], versions[1] + 1, versions[2]]
- set_implementation(manifest, versions[1])
- module.set_versions(versions)
- elif module.ret == None:
- versions = [Spec("1.0"), 1, 1]
- set_specification(project, manifest, versions[0])
- set_implementation(manifest, versions[1])
- set_release(manifest, versions[2])
- module.set_versions(versions)
- sys.stdout.flush()
-
-# Given a list of the added modules, remove the modules
-# which have the correct 'new module default' version number
-def remove_correct_added(modules):
- correct = [x for x in modules]
- for module in modules:
- if module.spec() == "1.0" or module.spec() == "0.0":
- if module.impl() == 1:
- if module.release() == 1 or module.release() == 0:
- correct.remove(module)
- return correct
-
-# ==================================== #
-# Helper Functions #
-# ==================================== #
-
-# Replace pattern with subst in given file
-def replace(file, pattern, subst):
- #Create temp file
- fh, abs_path = mkstemp()
- new_file = open(abs_path,'w')
- old_file = open(file)
- for line in old_file:
- new_file.write(line.replace(pattern, subst))
- #close temp file
- new_file.close()
- close(fh)
- old_file.close()
- #Remove original file
- remove(file)
- #Move new file
- move(abs_path, file)
-
-# Given a list of modules print the version numbers that need changing
-def print_version_updates(modules):
- f = open("gen_version.txt", "a")
- for module in modules:
- versions = module.versions
- if module.ret == COMPATIBLE:
- output = (module.name + ":\n")
- output += ("\tMajor Release:\tNo Change.\n")
- output += ("\tSpecification:\t" + str(versions[0]) + "\t->\t" + str(versions[0].incrementCompat()) + "\n")
- if versions[1] is None:
- output += ("\tImplementation: Not defined\n")
- else:
- output += ("\tImplementation:\t" + str(versions[1]) + "\t->\t" + str(versions[1] + 1) + "\n")
- output += ("\n")
- print(output)
- sys.stdout.flush()
- f.write(output)
- elif module.ret == NON_COMPATIBLE:
- output = (module.name + ":\n")
- output += ("\tMajor Release:\t" + str(versions[2]) + "\t->\t" + str(versions[2] + 1) + "\n")
- output += ("\tSpecification:\t" + str(versions[0]) + "\t->\t" + str(versions[0].incrementIncompat()) + "\n")
- if versions[1] is None:
- output += ("\tImplementation: Not defined\n")
- else:
- output += ("\tImplementation:\t" + str(versions[1]) + "\t->\t" + str(versions[1] + 1) + "\n")
- output += ("\n")
- print(output)
- sys.stdout.flush()
- f.write(output)
- elif module.ret == ERROR:
- output = (module.name + ":\n")
- output += ("\t*Unable to detect necessary changes\n")
- output += ("\tMajor Release:\t\t" + str(versions[2]) + "\n")
- output += ("\tSpecification:\t" + str(versions[0]) + "\n")
- if versions[1] is None:
- output += ("\tImplementation: Not defined\n")
- else:
- output += ("\tImplementation:\t" + str(versions[1]) + "\n")
- output += ("\n")
- print(output)
- f.write(output)
- sys.stdout.flush()
- elif module.ret == NO_CHANGES:
- output = (module.name + ":\n")
- output += ("\tMajor Release:\tNo Change.\n")
- output += ("\tSpecification:\tNo Change.\n")
- if versions[1] is None:
- output += ("\tImplementation: Not defined\n")
- else:
- output += ("\tImplementation:\t" + str(versions[1]) + "\t->\t" + str(versions[1] + 1) + "\n")
- output += ("\n")
- print(output)
- sys.stdout.flush()
- f.write(output)
- elif module.ret is None:
- output = ("Added " + module.name + ":\n")
- if module.release() != 1 and module.release() != 0:
- output += ("\tMajor Release:\t\t" + str(module.release()) + "\t->\t" + "1\n")
- output += ("\n")
- if module.spec() != "1.0" and module.spec() != "0.0":
- output += ("\tSpecification:\t" + str(module.spec()) + "\t->\t" + "1.0\n")
- output += ("\n")
- if module.impl() != 1:
- output += ("\tImplementation:\t" + str(module.impl()) + "\t->\t" + "1\n")
- output += ("\n")
- print(output)
- sys.stdout.flush()
- f.write(output)
- sys.stdout.flush()
- f.close()
-
-# Changes cygwin paths to Windows
-def fix_path(path):
- if "cygdrive" in path:
- new_path = path[11:]
- return "C:/" + new_path
- else:
- return path
-
-# Print a 'title'
-def printt(title):
- print("\n" + title)
- lines = ""
- for letter in title:
- lines += "-"
- print(lines)
- sys.stdout.flush()
-
-# Get a list of package names in the given path
-# The path is expected to be of the form {base}/module/src
-#
-# NOTE: We currently only check for packages of the form
-# org.sleuthkit.autopsy.x
-# If we add other namespaces for commercial modules we will
-# have to add a check here
-def get_packages(path):
- packages = []
- package_path = os.path.join(path, "org", "sleuthkit", "autopsy")
- for folder in os.listdir(package_path):
- package_string = "org.sleuthkit.autopsy."
- packages.append(package_string + folder)
- return packages
-
-# Create the given directory, if it doesn't already exist
-def make_dir(dir):
- try:
- if not os.path.isdir(dir):
- os.mkdir(dir)
- if os.path.isdir(dir):
- return True
- return False
- except:
- print("Exception thrown when creating directory")
- return False
-
-# Delete the given directory, and make sure it is deleted
-def del_dir(dir):
- try:
- if os.path.isdir(dir):
- shutil.rmtree(dir, ignore_errors=False, onerror=handleRemoveReadonly)
- if os.path.isdir(dir):
- return False
- else:
- return True
- return True
- except:
- print("Exception thrown when deleting directory")
- traceback.print_exc()
- return False
-
-# Handle any permisson errors thrown by shutil.rmtree
-def handleRemoveReadonly(func, path, exc):
- excvalue = exc[1]
- if func in (os.rmdir, os.remove) and excvalue.errno == errno.EACCES:
- os.chmod(path, stat.S_IRWXU| stat.S_IRWXG| stat.S_IRWXO) # 0777
- func(path)
- else:
- raise
-
-# Run git clone and git checkout for the tag
-def do_git(tag, tag_dir):
- try:
- printt("Cloning Autopsy tag " + tag + " into dir " + tag_dir + " (this could take a while)...")
- subprocess.call(["git", "clone", "https://github.com/sleuthkit/autopsy.git", tag_dir],
- stdout=subprocess.PIPE)
- printt("Checking out tag " + tag + "...")
- subprocess.call(["git", "checkout", tag],
- stdout=subprocess.PIPE,
- cwd=tag_dir)
- return True
- except Exception as ex:
- print("Error cloning and checking out Autopsy: ", sys.exc_info()[0])
- print(str(ex))
- print("The terminal you are using most likely does not recognize git commands.")
- return False
-
-# Get the flags from argv
-def args():
- try:
- sys.argv.pop(0)
- while sys.argv:
- arg = sys.argv.pop(0)
- if arg == "-h" or arg == "--help":
- return 1
- elif arg == "-t" or arg == "--tag":
- global tag
- tag = sys.argv.pop(0)
- elif arg == "-s" or arg == "--source":
- global source
- source = sys.argv.pop(0)
- elif arg == "-d" or arg == "--dir":
- global docdir
- docdir = sys.argv.pop(0)
- elif arg == "-a" or arg == "--auto":
- global dry
- dry = False
- else:
- raise Exception()
- except:
- pass
-
-# Print script run info
-def printinfo():
- global tag
- global source
- global docdir
- global dry
- printt("Release script information:")
- if source is None:
- source = fix_path(os.path.abspath("."))
- print("Using source directory:\n " + source)
- if tag is None:
- tag = get_tag(source)
- print("Checking out to tag:\n " + tag)
- if docdir is None:
- docdir = fix_path(os.path.abspath("./jdiff-javadocs"))
- print("Generating jdiff JavaDocs in:\n " + docdir)
- if dry is True:
- print("Dry run: will not auto-update version numbers")
- sys.stdout.flush()
-
-# Print the script's usage/help
-def usage():
- return \
- """
- USAGE:
- Compares the API of the current Autopsy source code with a previous
- tagged version. By default, it will detect the previous tag from
- the NEWS file and will not update the versions in the source code.
-
- OPTIONAL FLAGS:
- -t --tag Specify a previous tag to compare to.
- Otherwise the NEWS file will be used.
-
- -d --dir The output directory for the jdiff JavaDocs. If no
- directory is given, the default is jdiff-javadocs/{module}.
-
- -s --source The directory containing Autopsy's source code.
-
- -a --auto Automatically update version numbers (not dry).
-
- -h --help Prints this usage.
- """
-
-# ==================================== #
-# Main Functionality #
-# ==================================== #
-
-# Where the magic happens
-def main():
- global tag; global source; global docdir; global dry
- tag = None; source = None; docdir = None; dry = True
- ret = args()
- if ret:
- print(usage())
- return 0
- printinfo()
-
- # Check if javadoc and jdiff are present.
- jdiff = fix_path(os.path.abspath("./thirdparty/jdiff/v-custom/jdiff.jar"))
- if(not os.path.isfile(jdiff)):
- printt("jdiff not found. Exiting...")
- return 1
- try:
- subprocess.call(["javadoc"], stdout=open(os.devnull, "w"), stderr=subprocess.STDOUT)
- except Exception:
- printt("javadoc not found in path. Exiting...")
- return 1
- # -----------------------------------------------
- # 1) Clone Autopsy, checkout to given tag/commit
- # 2) Get the modules in the clone and the source
- # 3) Generate the xml comparison
- # -----------------------------------------------
- if (not TESTING) and (not del_dir("./build/" + tag)):
- print("\n\n=========================================")
- print(" Failed to delete previous Autopsy clone.")
- print(" Unable to continue...")
- print("=========================================")
- return 1
- tag_dir = os.path.abspath("./build/" + tag)
- if not do_git(tag, tag_dir):
- return 1
- sys.stdout.flush()
- tag_modules = find_modules(tag_dir)
- source_modules = find_modules(source)
-
- printt("Generating jdiff XML reports...")
- apiname_tag = tag
- apiname_cur = "current"
- gen_xml(tag_dir, tag_modules, apiname_tag)
- gen_xml(source, source_modules, apiname_cur)
-
- if not TESTING:
- printt("Deleting cloned Autopsy directory...")
- print("Clone successfully deleted" if del_dir(tag_dir) else "Failed to delete clone")
- sys.stdout.flush()
-
- # -----------------------------------------------------
- # 1) Seperate modules into added, similar, and removed
- # 2) Compare XML for each module
- # -----------------------------------------------------
- printt("Comparing modules found...")
- similar_modules, added_modules, removed_modules = module_diff(source_modules, tag_modules)
- if added_modules or removed_modules:
- for m in added_modules:
- print("+ Added " + m.name)
- sys.stdout.flush()
- for m in removed_modules:
- print("- Removed " + m.name)
- sys.stdout.flush()
- else:
- print("No added or removed modules")
- sys.stdout.flush()
-
- printt("Comparing jdiff outputs...")
- for module in similar_modules:
- module.set_ret(compare_xml(module, apiname_tag, apiname_cur))
- print("Refer to the jdiff-javadocs folder for more details")
-
- # ------------------------------------------------------------
- # 1) Do versioning
- # 2) Auto-update version numbers in files and the_modules list
- # 3) Auto-update dependencies
- # ------------------------------------------------------------
- printt("Auto-detecting version numbers and changes...")
- for module in added_modules:
- module.set_versions(get_versions(module, source))
- for module in similar_modules:
- module.set_versions(get_versions(module, source))
-
- added_modules = remove_correct_added(added_modules)
- the_modules = similar_modules + added_modules
- print_version_updates(the_modules)
-
- if not dry:
- printt("Auto-updating version numbers...")
- update_versions(the_modules, source)
- print("All auto-updates complete")
-
- printt("Detecting and auto-updating dependencies...")
- update_dependencies(the_modules, source)
-
- printt("Deleting jdiff XML...")
- xml_dir = os.path.abspath("./build/jdiff-xml")
- print("XML successfully deleted" if del_dir(xml_dir) else "Failed to delete XML")
-
- print("\n--- Script completed successfully ---")
- return 0
-
-# Start off the script
-if __name__ == "__main__":
- sys.exit(main())