Worked on Jump List format support and documentation

Author: joachimmetz

.github/workflows/test_docker.yml

@@ -18,7 +18,7 @@ jobs:
     - name: Install dependencies
       run: |
         dnf copr -y enable @gift/dev
-        dnf install -y @development-tools python3 python3-devel libfwsi-python3 libgzipf-python3 liblnk-python3 libolecf-python3 libregf-python3 python3-dfdatetime python3-dtfabric python3-lz4 python3-pyyaml python3-setuptools
+        dnf install -y @development-tools python3 python3-devel libfwps-python3 libfwsi-python3 libgzipf-python3 liblnk-python3 libolecf-python3 libregf-python3 python3-dfdatetime python3-dtfabric python3-lz4 python3-pyyaml python3-setuptools
     - name: Run tests
       env:
         LANG: C.utf8
@@ -58,7 +58,7 @@ jobs:
       run: |
         add-apt-repository -y ppa:gift/dev
         apt-get update -q
-        apt-get install -y build-essential python3 python3-dev libfwsi-python3 libgzipf-python3 liblnk-python3 libolecf-python3 libregf-python3 python3-dfdatetime python3-distutils python3-dtfabric python3-lz4 python3-setuptools python3-yaml
+        apt-get install -y build-essential python3 python3-dev libfwps-python3 libfwsi-python3 libgzipf-python3 liblnk-python3 libolecf-python3 libregf-python3 python3-dfdatetime python3-distutils python3-dtfabric python3-lz4 python3-setuptools python3-yaml
     - name: Run tests
       env:
         LANG: en_US.UTF-8

.github/workflows/test_tox.yml

@@ -46,7 +46,7 @@ jobs:
         add-apt-repository -y ppa:deadsnakes/ppa
         add-apt-repository -y ppa:gift/dev
         apt-get update -q
-        apt-get install -y build-essential git libffi-dev python${{ matrix.python-version }} python${{ matrix.python-version }}-dev python${{ matrix.python-version }}-venv libfwsi-python3 libgzipf-python3 liblnk-python3 libolecf-python3 libregf-python3 python3-dfdatetime python3-distutils python3-dtfabric python3-lz4 python3-pip python3-setuptools python3-yaml
+        apt-get install -y build-essential git libffi-dev python${{ matrix.python-version }} python${{ matrix.python-version }}-dev python${{ matrix.python-version }}-venv libfwps-python3 libfwsi-python3 libgzipf-python3 liblnk-python3 libolecf-python3 libregf-python3 python3-dfdatetime python3-distutils python3-dtfabric python3-lz4 python3-pip python3-setuptools python3-yaml
     - name: Install tox
       run: |
         python3 -m pip install tox

config/appveyor/install.ps1

@@ -1,6 +1,6 @@
 # Script to set up tests on AppVeyor Windows.
 
-$Dependencies = "PyYAML dfdatetime dtfabric libfwsi libgzipf liblnk libolecf libregf lz4"
+$Dependencies = "PyYAML dfdatetime dtfabric libfwps libfwsi libgzipf liblnk libolecf libregf lz4"
 $Dependencies = ${Dependencies} -split " "
 
 $Output = Invoke-Expression -Command "git clone https://github.com/log2timeline/l2tdevtools.git ..\l2tdevtools 2>&1"

config/dpkg/control

@@ -15,7 +15,7 @@ Description: Data files for dtFormats
 
 Package: python3-dtformats
 Architecture: all
-Depends: dtformats-data (>= ${binary:Version}), libfwsi-python3 (>= 20150606), libgzipf-python3 (>= 20221229), liblnk-python3 (>= 20150830), libolecf-python3 (>= 20151223), libregf-python3 (>= 20150315), python3-dfdatetime (>= 20180510), python3-dtfabric (>= 20220127), python3-lz4 (>= 0.10.0), python3-yaml (>= 3.10), ${misc:Depends}
+Depends: dtformats-data (>= ${binary:Version}), libfwps-python3 (>= 20230131), libfwsi-python3 (>= 20150606), libgzipf-python3 (>= 20221229), liblnk-python3 (>= 20230205), libolecf-python3 (>= 20151223), libregf-python3 (>= 20150315), python3-dfdatetime (>= 20180510), python3-dtfabric (>= 20220127), python3-lz4 (>= 0.10.0), python3-yaml (>= 3.10), ${misc:Depends}
 Description: Python 3 module of dtFormats
  dtFormats is a collection of various file formats.
 

dependencies.ini

@@ -18,6 +18,14 @@ pypi_name: lz4
 rpm_name: python3-lz4
 version_property: __version__
 
+[pyfwps]
+dpkg_name: libfwps-python3
+l2tbinaries_name: libfwps
+minimum_version: 20230131
+pypi_name: libfwps-python
+rpm_name: libfwps-python3
+version_property: get_version()
+
 [pyfwsi]
 dpkg_name: libfwsi-python3
 l2tbinaries_name: libfwsi
@@ -28,7 +36,6 @@ version_property: get_version()
 
 [pygzipf]
 dpkg_name: libgzipf-python3
-is_optional: true
 l2tbinaries_name: libgzipf
 minimum_version: 20221229
 pypi_name: libgzipf-python
@@ -38,7 +45,7 @@ version_property: get_version()
 [pylnk]
 dpkg_name: liblnk-python3
 l2tbinaries_name: liblnk
-minimum_version: 20150830
+minimum_version: 20230205
 pypi_name: liblnk-python
 rpm_name: liblnk-python3
 version_property: get_version()

documentation/Jump lists format.asciidoc

@@ -29,7 +29,7 @@ specification.
 == License
 
 ....
-Copyright (C) 2014-2019, Joachim Metz <[email protected]>.
+Copyright (C) 2014-2023, Joachim Metz <[email protected]>.
 Permission is granted to copy, distribute and/or modify this document under the
 terms of the GNU Free Documentation License, Version 1.3 or any later version
 published by the Free Software Foundation; with no Invariant Sections, no
@@ -46,9 +46,10 @@ in the section entitled "GNU Free Documentation License".
 | 0.0.1 | J.B. Metz | July 2014 | Initial version based on earlier notes.
 | 0.0.2 | J.B. Metz | November 2014 | Switched to asccidoc format.
 | 0.0.3 | J.B. Metz | August 2015 | Additional information about Jump lists stored in the Windows Registry.
-| 0.0.4 | J.B. Metz | February 2016 | Additional information about version 3 automatic destinations jump lists with thanks to E. Zimmerman.
-| 0.0.5 | J.B. Metz | March 2016 | Additional information about version 4 automatic destinations jump lists with thanks to E. Zimmerman.
+| 0.0.4 | J.B. Metz | February 2016 | Additional information about format version 3 automatic destinations jump lists with thanks to E. Zimmerman.
+| 0.0.5 | J.B. Metz | March 2016 | Additional information about format version 4 automatic destinations jump lists with thanks to E. Zimmerman.
 | 0.0.6 | J.B. Metz | June 2019 | Corrected typos and formatting changes.
+| 0.0.7 | J.B. Metz | February 2023 | Additional information about format version 2.
 |===
 
 :numbered:
@@ -93,6 +94,9 @@ The DestList stream consists of:
 * A DestList header
 * An array of DestList entries
 
+[NOTE]
+The DestList stream can be 0 of bytes in size if the file is empty.
+
 ==== DestList header
 
 The DestList header is 32 bytes of size and consists of:
@@ -162,9 +166,9 @@ The path points to:
 * a directory [yellow-background]*containing LNK files?*
 * A XML .library-ms file
 
-===== DestList entry - version 3
+===== DestList entry - version 2 or later
 
-The DestList entry - version 3 is variable of size and consists of:
+The DestList entry - version 2 or later is variable of size and consists of:
 
 [cols="1,1,1,5",options="header"]
 |===