Merge branch 'integration' into depend-on-current-jwat

.gitattributes

@@ -7,3 +7,11 @@
 *.jpx binary
 *.tif binary
 *.wav binary
+
+# Set the default behavior, in case people don't have core.autocrlf set.
+* text=auto
+
+# Explicitly declare text files you want to always be normalized and converted
+# to native line endings on checkout.
+*.html text
+*.css text

.github/workflows/test-pr.yml

@@ -14,8 +14,8 @@ jobs:
         java-version: [8, 11]
 
     steps:
-      - uses: actions/checkout@v3
-      - uses: dorny/paths-filter@v2
+      - uses: actions/checkout@v4
+      - uses: dorny/paths-filter@v3
         id: filter
         with:
           filters: |
@@ -30,23 +30,22 @@ jobs:
               - 'jhove-bbt/scripts/**'
               - 'test-root/corpora/**'
       - name: JDK setup
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
           java-version: ${{ matrix.java-version }}
           distribution: 'temurin'
           cache: maven
       - name: Build with Maven
         run: mvn --batch-mode --update-snapshots install -DjacocoAgg
-      - name: Integration Tests
-        if: (matrix.java-version == 8) && (steps.filter.outputs.jhove == 'true')
+      - name: Integration(matrix.java-version == 8) && (steps.filter.outputs.jhove == 'true')
         run: ./bbt-jhove
         shell: bash
       - name: Test with Maven
         if: (matrix.java-version == 8)
         run: mvn --batch-mode verify -DjacocoAgg
       - name: Upload coverage report
         if: (matrix.java-version == 8)
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: coverage-report
           path: jhove-apps/target/site/jacoco-aggregate/
@@ -61,13 +60,17 @@ jobs:
       - name: Codacy analysis reporting
         uses: codacy/codacy-analysis-cli-action@4.0.0
       - name: Download coverage report
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: coverage-report
           path: jhove-apps/target/site/jacoco-aggregate/
       - name: Codecov coverage reporting
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
         with:
           files: jhove-apps/target/site/jacoco-aggregate/jacoco.xml
-          fail_ci_if_error: true # optional (default = false)
+          fail_ci_if_error: false # optional (default = false)
           verbose: true # optional (default = false)
+          name: codecov-jhove
+          token: ${{ secrets.CODECOV_TOKEN }} # required
+
+

Dockerfile

@@ -2,7 +2,7 @@
 # First build the app on a maven open jdk 11 container
 FROM maven:3-eclipse-temurin-11-focal as dev-builder
 ARG JHOVE_VERSION
-ENV JHOVE_VERSION=${JHOVE_VERSION:-1.27.0-SNAPSHOT}
+ENV JHOVE_VERSION=${JHOVE_VERSION:-1.32.0-RC1}
 
 # Copy the current dev source branch to a local build dir
 COPY . /build/jhove/
@@ -31,7 +31,7 @@ ARG JAVA_OPTS
 ENV JAVA_OPTS=$JAVA_OPTS
 # Specify the veraPDF REST version if you want to (to be used in build automation)
 ARG JHOVE_VERSION
-ENV JHOVE_VERSION=${JHOVE_VERSION:-1.27.0-SNAPSHOT}
+ENV JHOVE_VERSION=${JHOVE_VERSION:-1.32.0-RC1}
 
 # Copy the JRE from the previous stage
 ENV JAVA_HOME=/opt/java/openjdk

docs/CNAME

@@ -0,0 +1 @@
+jhove.openpreservation.org

docs/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gem 'github-pages'
+gem 'html-proofer'

docs/_data/navbar.yml

@@ -0,0 +1,49 @@
+- title: "Getting started"
+  href: "/getting-started/"
+
+- title: "Documentation"
+  href: "/documentation/"
+
+- title: "Modules"
+  href: "/modules/"
+  subcategories:
+    - subtitle: "AIFF"
+      subhref: "aiff/"
+    - subtitle: "ASCII"
+      subhref: "ascii/"
+    - subtitle: "Bytestream"
+      subhref: "bytestream/"
+    - subtitle: "GIF"
+      subhref: "gif/"
+    - subtitle: "GZIP"
+      subhref: "gzip/"
+    - subtitle: "HTML"
+      subhref: "html/"
+    - subtitle: "JPEG"
+      subhref: "jpeg/"
+    - subtitle: "JPEG2000"
+      subhref: "jpeg2000/"
+    - subtitle: "PDF"
+      subhref: "pdf/"
+    - subtitle: "TIFF"
+      subhref: "tiff/"
+    - subtitle: "UTF-8"
+      subhref: "utf8/"
+    - subtitle: "WARC"
+      subhref: "warc/"
+    - subtitle: "WAVE"
+      subhref: "wave/"
+    - subtitle: "XML"
+      subhref: "xml/"
+    - subtitle: "EPUB"
+      subhref: "third-party/epub/"
+    - subtitle: "MP3"
+      subhref: "third-party/mp3/"
+    - subtitle: "ZIP"
+      subhref: "third-party/zip/"
+
+- title: "Resources"
+  href: "/resources/"
+
+- title: "About"
+  href: "/about/"

docs/_includes/footer.html

@@ -0,0 +1,13 @@
+  <footer class="container">
+    <p>
+      Copyright © 2023 Open Preservation Foundation. 
+    </p>
+    <p>
+      Updated October 2023
+    </p>
+  </footer>
+  <!-- jQuery (necessary for Bootstrap's JavaScript plugins) -->
+  <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
+  <!-- Include all compiled plugins (below), or include individual files as needed -->
+  <!-- Latest compiled and minified JavaScript -->
+  <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/js/bootstrap.min.js"></script>

docs/_includes/header.html

@@ -0,0 +1,35 @@
+<head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta name="Description" content="Main page for JHOVE, the JSTOR/Harvard Object Validation Environment">
+    <meta name="keywords" content="JHOVE, JOVE, JSTOR, Harvard, object, validation,
+    environment, Java, extensible, format, AIFF, ASCII, GIF, HTML, JPEG, JPEG2000,
+    2000, PDF, TIFF, UTF-8, WAVE, XML, XMP, Adobe, ISO, ANSI, IETF, RFC">
+    <title>JHOVE | {{ page.title }}</title>
+
+
+    <link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png">
+    <link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32">
+    <link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16">
+    <link rel="manifest" href="/manifest.json">
+    <link rel="mask-icon" href="/safari-pinned-tab.svg" color="#5bbad5">
+    <meta name="apple-mobile-web-app-title" content="JHOVE">
+    <meta name="application-name" content="JHOVE">
+    <meta name="theme-color" content="#ffffff">
+
+    <!-- Bootstrap -->
+    <!-- Latest compiled and minified CSS -->
+    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css">
+    <!-- Optional theme -->
+    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap-theme.min.css">
+    <!-- Our theme -->
+    <link rel="stylesheet" href="/css/jhove.css">
+
+    <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
+    <!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
+    <!--[if lt IE 9]>
+      <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
+      <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
+    <![endif]-->
+</head>

docs/_includes/navbar.html

@@ -0,0 +1,39 @@
+{% assign navurl = page.url | remove: 'index.html' %}
+    <nav class="navbar navbar-default navbar-static-top" role="navigation">
+      <div class="container">
+        <div class="navbar-header">
+          <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
+            <span class="sr-only">Toggle navigation</span>
+            <span class="icon-bar"></span>
+            <span class="icon-bar"></span>
+            <span class="icon-bar"></span>
+          </button>
+          <a class="navbar-brand" href="/" title="JHOVE home page."><img src="/img/jhovelogo-nav.png" alt="JHOVE logo"/></a>
+        </div>
+        <div id="navbar" class="navbar-collapse collapse">
+          <ul class="nav navbar-nav">
+{% for item in include.nav %}
+    {% if item.subcategories != null %}
+        <li class="dropdown">
+          <a href="{{ site.url }}{{ item.href }}" class="dropdown-toggle" data-toggle="dropdown" data-hover="dropdown">{{ item.title }} <span class="caret"></a>
+          <ul class="dropdown-menu">
+          {% for subcategory in item.subcategories %}
+              <li><a href="{{ site.url }}{{ item.href }}{{ subcategory.subhref }}">{{ subcategory.subtitle }}</a></li>
+          {% endfor %}
+          </ul>
+    {% else %}
+
+    <!-- display the top level navigation for items that don’t have a submenu -->
+        {% if item.url == navurl %}
+            <li class="active">
+        {% else %}
+            <li>
+        {% endif %}
+    <a href="{{ site.url }}{{ item.href }}">{{ item.title }}</a>
+    {% endif %}
+    </li>
+{% endfor %}
+          </ul>
+        </div><!--/.nav-collapse -->
+      </div>
+    </nav>

docs/_layouts/page.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html lang="en">
+{% include header.html %}
+<body role="document">
+{% include navbar.html nav=site.data.navbar %}
+  <div class="container theme-showcase" role="main">
+    {{ content }}
+  </div>
+  {% include footer.html %}
+</body>
+</html>

docs/about/index.html

@@ -0,0 +1,62 @@
+---
+title: About
+---
+<!DOCTYPE html>
+<html lang="en">
+{% include header.html %}
+<body role="document">
+
+{% include navbar.html nav=site.data.navbar %}
+<div class="container theme-showcase" role="main">
+<h1>About JHOVE</h1>
+<p>
+    JHOVE is currently maintained by the <a href="http://openpreservation.org">Open Preservation Foundation</a>.
+    Development effort is guided by the JHOVE Product Board, comprising OPF members and software supporters.
+</p>
+<p>
+  The original JHOVE project was a collaboration between <a href="http://www.jstor.org">JSTOR</a> and
+  <a href="http://hul.harvard.edu/">Harvard University Library</a> with funding from the
+  <a href="http://www.mellon.org">Andrew W. Mellon Foundation</a> for the Electronic-Archiving Initiative.
+</p>
+</div>
+<div class="container theme-showcase" role="main">
+  <h2>Support JHOVE</h2>
+  JHOVE is one of the most widely-used digital preservation tools in the community, and it is also used as a component in several commercial digital preservation systems. It is open source meaning it is free to download, use and modify. However, it is not free of costs to host, maintain, support or develop the software. Currently, only OPF members support JHOVE as part of their membership fees.
+  <h2>So, how can you help?</h2>
+      <h3>Become an OPF member</h3>
+  By becoming a member of the OPF, organisations are directly helping to fund the hosting, maintenance, and development of the software ensuring it is robust and reliable.
+  <p>
+      Members can also choose to guide the roadmap and:
+  </p>
+  <ul>
+      <li> Sit on the JHOVE Product Board</li>
+      <li> Vote for bug fixes and enhancements to be included in each release cycle</li>
+      <li> Receive technical support</li>
+  </ul>
+  <p>
+      Find out more: <a href="http://openpreservation.org/about/join/">http://openpreservation.org/about/join/</a>
+  </p>
+  <h3>Donate</h3>
+    Make a donation to support JHOVE development:
+    <form action="https://www.paypal.com/cgi-bin/webscr" method="post" target="_top">
+      <input type="hidden" name="cmd" value="_s-xclick">
+      <input type="hidden" name="hosted_button_id" value="UKRJRX7A5ZJZL">
+      <input type="image" src="/img/paypal-donate.png" border="0" name="submit" alt="PayPal – The safer, easier way to pay online!">
+    </form>
+  <h3>Contribute to JHOVE</h3>
+  <p>
+     We also welcome community contributions. We are looking for users and developers to join our active JHOVE community and help:
+  </p>
+  <ul>
+      <li> Test the software</li>
+      <li> Improve documentation</li>
+      <li> Contribute test files</li>
+  </ul>
+  <p>
+      We run online JHOVE Hack Days where volunteers from around the world work collaboratively to enhance our understanding of JHOVE errors and improve documentation. The <a href="http://openpreservation.org/blog/2017/05/09/jhove-spring-clean/">report</a> from the most recent hack day is published on the Foundation’s website. If you would like to contribute or get involved in the next hack day, please <a href="http://openpreservation.org/about/contact/">contact us</a>.
+   </p>
+   </div>
+    {% include footer.html %}
+
+</body>
+</html>

docs/browserconfig.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<browserconfig>
+  <msapplication>
+    <tile>
+      <square150x150logo src="/mstile-150x150.png"/>
+      <TileColor>#2b5797</TileColor>
+    </tile>
+  </msapplication>
+</browserconfig>