incr ver

Bug fixes and a change to license request logic

.cdmurls.json

@@ -0,0 +1,5 @@
+{
+  "CdmUrls": [
+    "https://ollj0gz40d.execute-api.us-west-2.amazonaws.com/default/AudibleCdm"
+  ]
+}

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,30 @@
+---
+name: Bug report
+about: Create a report to help us improve Libation
+title: ''
+labels: bug
+assignees: ''
+---
+
+**Describe the bug**  
+A clear and concise description of what the bug is.
+
+**To Reproduce**  
+Steps to reproduce the behavior:
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**  
+A clear and concise description of what you expected to happen.
+
+**Screenshots**  
+If applicable, add screenshots to help explain your problem.
+
+**Platform**  
+[e.g. Windows 10, Windows 11, Mac, Linux (State distribution)]
+
+**Log Files**  
+Attach your Libation log file here. Logs are typically in your `[user]\Libation` folder. (For example, on windows: `C:\my_username\Libation`) Also within Libation, on the first tab in Settings you can click the button 'Open log folder'

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,31 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+---
+
+**No-go ideas**  
+There are lots of great ideas and many are beyond what we intend to do for Libation. Some good ideas which we do not intend to pursue:
+
+* comprehensive api/cli
+* aax/audiobook import
+* bulk rename of existing files
+* general metadata/tag editor
+* playback features
+* web gui
+* supporting non-audible vendors
+* official docker support
+
+**Is your feature request related to a problem? Please describe.**  
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**  
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**  
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**  
+Add any other context or screenshots about the feature request here.

.github/dependabot.yml

@@ -0,0 +1,8 @@
+---
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/workflows/build-linux.yml

@@ -0,0 +1,132 @@
+# build-linux.yml
+# Reusable workflow that builds the Linux and MacOS (x64 and arm64) versions of Libation.
+---
+name: build
+
+on:
+  workflow_call:
+    inputs:
+      version_override:
+        type: string
+        description: "Version number override"
+        required: false
+      run_unit_tests:
+        type: boolean
+        description: "Skip running unit tests"
+        required: false
+        default: true
+      runs_on:
+        type: string
+        description: "The GitHub hosted runner to use"
+        required: true
+      OS:
+        type: string
+        description: >
+          The operating system targeted by the build.
+
+          There must be a corresponding Bundle_$OS.sh script file in ./Scripts
+        required: true
+      architecture:
+        type: string
+        description: "CPU architecture targeted by the build."
+        required: true
+
+env:
+  DOTNET_CONFIGURATION: "Release"
+  DOTNET_VERSION: "9.0.x"
+  RELEASE_NAME: "chardonnay"
+
+jobs:
+  build:
+    name: "${{ inputs.OS }}-${{ inputs.architecture }}"
+    runs-on: ${{ inputs.runs_on }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: ${{ env.DOTNET_VERSION }}
+        env:
+          NUGET_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Get version
+        id: get_version
+        run: |
+          inputVersion="${{ inputs.version_override }}"
+          if [[ "${#inputVersion}" -gt 0 ]]
+          then
+            version="${inputVersion}"
+          else
+            version="$(grep -Eio -m 1 '<Version>.*</Version>' ./Source/AppScaffolding/AppScaffolding.csproj | sed -r 's/<\/?Version>//g')"
+          fi
+          echo "version=${version}" >> "${GITHUB_OUTPUT}"
+
+      - name: Unit test
+        if: ${{ inputs.run_unit_tests }}
+        working-directory: ./Source
+        run: dotnet test
+
+      - name: Publish
+        id: publish
+        working-directory: ./Source
+        run: |
+          if [[ "${{ inputs.OS }}" == "MacOS" ]]
+          then
+            display_os="macOS"
+            RUNTIME_ID="osx-${{ inputs.architecture }}"
+          else
+            display_os="Linux"
+            RUNTIME_ID="linux-${{ inputs.architecture }}"
+          fi
+
+          OUTPUT="bin/Publish/${display_os}-${{ inputs.architecture }}-${{ env.RELEASE_NAME }}"
+
+          echo "display_os=${display_os}" >> $GITHUB_OUTPUT
+          echo "Runtime Identifier: $RUNTIME_ID"
+          echo "Output Directory: $OUTPUT"
+
+          dotnet publish \
+              LibationAvalonia/LibationAvalonia.csproj \
+              --runtime $RUNTIME_ID \
+              --configuration ${{ env.DOTNET_CONFIGURATION }} \
+              --output $OUTPUT \
+              -p:PublishProfile=LibationAvalonia/Properties/PublishProfiles/${display_os}Profile.pubxml
+          dotnet publish \
+              LoadByOS/${display_os}ConfigApp/${display_os}ConfigApp.csproj \
+              --runtime $RUNTIME_ID \
+              --configuration ${{ env.DOTNET_CONFIGURATION }} \
+              --output $OUTPUT \
+              -p:PublishProfile=LoadByOS/Properties/${display_os}ConfigApp/PublishProfiles/${display_os}Profile.pubxml
+          dotnet publish \
+              LibationCli/LibationCli.csproj \
+              --runtime $RUNTIME_ID \
+              --configuration ${{ env.DOTNET_CONFIGURATION }} \
+              --output $OUTPUT \
+              -p:PublishProfile=LibationCli/Properties/PublishProfiles/${display_os}Profile.pubxml
+          dotnet publish \
+              HangoverAvalonia/HangoverAvalonia.csproj \
+              --runtime $RUNTIME_ID \
+              --configuration ${{ env.DOTNET_CONFIGURATION }} \
+              --output $OUTPUT \
+              -p:PublishProfile=HangoverAvalonia/Properties/PublishProfiles/${display_os}Profile.pubxml
+
+      - name: Build bundle
+        id: bundle
+        working-directory: ./Source/bin/Publish/${{ steps.publish.outputs.display_os }}-${{ inputs.architecture }}-${{ env.RELEASE_NAME }}
+        run: |
+          BUNDLE_DIR=$(pwd)
+          echo "Bundle dir: ${BUNDLE_DIR}"
+          cd ..
+          SCRIPT=../../../Scripts/Bundle_${{ inputs.OS }}.sh
+          chmod +rx ${SCRIPT}
+          ${SCRIPT} "${BUNDLE_DIR}" "${{ steps.get_version.outputs.version }}" "${{ inputs.architecture }}"
+          artifact=$(ls ./bundle)
+          echo "artifact=${artifact}" >> "${GITHUB_OUTPUT}"
+
+      - name: Publish bundle
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ steps.bundle.outputs.artifact }}
+          path: ./Source/bin/Publish/bundle/${{ steps.bundle.outputs.artifact }}
+          if-no-files-found: error
+          retention-days: 7

.github/workflows/build-windows.yml

@@ -0,0 +1,107 @@
+# build-windows.yml
+# Reusable workflow that builds the Windows versions of Libation.
+---
+name: build
+
+on:
+  workflow_call:
+    inputs:
+      version_override:
+        type: string
+        description: "Version number override"
+        required: false
+      run_unit_tests:
+        type: boolean
+        description: "Skip running unit tests"
+        required: false
+        default: true
+
+env:
+  DOTNET_CONFIGURATION: "Release"
+  DOTNET_VERSION: "9.0.x"
+
+jobs:
+  build:
+    name: "${{ matrix.os }}-${{ matrix.release_name }}"
+    runs-on: windows-latest
+    strategy:
+      matrix:
+        os: [Windows]
+        ui: [Avalonia]
+        release_name: [chardonnay]
+        include:
+          - os: Windows
+            ui: WinForms
+            release_name: classic
+            prefix: Classic-
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: ${{ env.DOTNET_VERSION }}
+        env:
+          NUGET_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Get version
+        id: get_version
+        run: |
+          if ("${{ inputs.version_override }}".length -gt 0) {
+            $version = "${{ inputs.version_override }}"
+          } else {
+            $version = (Select-Xml -Path "./Source/AppScaffolding/AppScaffolding.csproj" -XPath "/Project/PropertyGroup/Version").Node.InnerXML.Trim()
+          }
+          "version=$version" >> $env:GITHUB_OUTPUT
+
+      - name: Unit test
+        if: ${{ inputs.run_unit_tests }}
+        working-directory: ./Source
+        run: dotnet test
+
+      - name: Publish
+        working-directory: ./Source
+        run: |
+          dotnet publish `
+              Libation${{ matrix.ui }}/Libation${{ matrix.ui }}.csproj `
+              --configuration ${{ env.DOTNET_CONFIGURATION }} `
+              --output bin/Publish/${{ matrix.os }}-${{ matrix.release_name }} `
+              -p:PublishProfile=Libation${{ matrix.ui }}/Properties/PublishProfiles/${{ matrix.os }}Profile.pubxml
+          dotnet publish `
+              LoadByOS/${{ matrix.os }}ConfigApp/${{ matrix.os }}ConfigApp.csproj `
+              --configuration ${{ env.DOTNET_CONFIGURATION }} `
+              --output bin/Publish/${{ matrix.os }}-${{ matrix.release_name }} `
+              -p:PublishProfile=LoadByOS/${{ matrix.os }}ConfigApp/PublishProfiles/${{ matrix.os }}Profile.pubxml
+          dotnet publish `
+              LibationCli/LibationCli.csproj `
+              --configuration ${{ env.DOTNET_CONFIGURATION }} `
+              --output bin/Publish/${{ matrix.os }}-${{ matrix.release_name }} `
+              -p:DefineConstants="${{ matrix.release_name }}" `
+              -p:PublishProfile=LibationCli/Properties/PublishProfiles/${{ matrix.os }}Profile.pubxml
+          dotnet publish `
+              Hangover${{ matrix.ui }}/Hangover${{ matrix.ui }}.csproj `
+              --configuration ${{ env.DOTNET_CONFIGURATION }} `
+              --output bin/Publish/${{ matrix.os }}-${{ matrix.release_name }} `
+              -p:PublishProfile=Hangover${{ matrix.ui }}/Properties/PublishProfiles/${{ matrix.os }}Profile.pubxml
+
+      - name: Zip artifact
+        id: zip
+        working-directory: ./Source/bin/Publish
+        run: |
+          $bin_dir = "${{ matrix.os }}-${{ matrix.release_name }}\"
+          $delfiles = @(
+            "WindowsConfigApp.exe",
+            "WindowsConfigApp.runtimeconfig.json",
+            "WindowsConfigApp.deps.json"
+            )
+          foreach ($file in $delfiles){ if (test-path $bin_dir$file){ Remove-Item $bin_dir$file } }
+          $artifact="${{ matrix.prefix }}Libation.${{ steps.get_version.outputs.version }}-" + "${{ matrix.os }}".ToLower() + "-${{ matrix.release_name }}"
+          "artifact=$artifact" >> $env:GITHUB_OUTPUT
+          Compress-Archive -Path "${bin_dir}*" -DestinationPath "$artifact.zip"
+
+      - name: Publish artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ steps.zip.outputs.artifact }}.zip
+          path: ./Source/bin/Publish/${{ steps.zip.outputs.artifact }}.zip
+          if-no-files-found: error
+          retention-days: 7

.github/workflows/build.yml

@@ -0,0 +1,49 @@
+# build.yml
+# Reusable workflow that builds Libation for all platforms.
+---
+name: build
+
+on:
+  workflow_call:
+    inputs:
+      version_override:
+        type: string
+        description: "Version number override"
+        required: false
+      run_unit_tests:
+        type: boolean
+        description: "Skip running unit tests"
+        required: false
+        default: true
+
+jobs:
+  windows:
+    uses: ./.github/workflows/build-windows.yml
+    with:
+      version_override: ${{ inputs.version_override }}
+      run_unit_tests: ${{ inputs.run_unit_tests }}
+
+  linux:
+    strategy:
+      matrix:
+        OS: [Redhat, Debian]
+        architecture: [x64, arm64]
+    uses: ./.github/workflows/build-linux.yml
+    with:
+      version_override: ${{ inputs.version_override }}
+      runs_on: ubuntu-latest
+      OS: ${{ matrix.OS }}
+      architecture: ${{ matrix.architecture }}
+      run_unit_tests: ${{ inputs.run_unit_tests }}
+
+  macos:
+    strategy:
+      matrix:
+        architecture: [x64, arm64]
+    uses: ./.github/workflows/build-linux.yml
+    with:
+      version_override: ${{ inputs.version_override }}
+      runs_on: macos-latest
+      OS: MacOS
+      architecture: ${{ matrix.architecture }}
+      run_unit_tests: ${{ inputs.run_unit_tests }}

.github/workflows/docker.yml

@@ -0,0 +1,63 @@
+# docker.yml
+# Reusable workflow that builds a docker image for Libation.
+---
+name: docker
+
+on:
+  workflow_call:
+    inputs:
+      version:
+        type: string
+        description: "Version number"
+        required: true
+      release:
+        type: boolean
+        description: "Is this a release build?"
+        required: true
+    secrets:
+      docker_username:
+        required: true
+      docker_token:
+        required: true
+
+jobs:
+  build_and_push:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to Docker Hub
+        if: ${{ inputs.release }}
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.docker_username }}
+          password: ${{ secrets.docker_token }}
+
+      - name: Generate docker image tags
+        id: metadata
+        uses: docker/metadata-action@v5
+        with:
+          flavor: |
+            latest=true
+          images: |
+            name=${{ secrets.docker_username }}/libation
+          tags: |
+            type=raw,value=${{ inputs.version }},enable=${{ inputs.release }}
+
+      - name: Build and push image
+        uses: docker/build-push-action@v6
+        with:
+          platforms: linux/amd64,linux/arm64
+          push: ${{ steps.metadata.outputs.tags != ''}}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+          tags: ${{ steps.metadata.outputs.tags }}
+          labels: ${{ steps.metadata.outputs.labels }}

.github/workflows/release.yml

@@ -0,0 +1,58 @@
+# release.yml
+# Builds and creates the release on any tags starting with a `v`
+---
+name: release
+on:
+  push:
+    tags:
+      - "v*"
+jobs:
+  prerelease:
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.get_version.outputs.version }}
+    steps:
+      - name: Get tag version
+        id: get_version
+        run: |
+          export TAG="${{ github.ref_name }}"
+          echo "version=${TAG#v}" >> "${GITHUB_OUTPUT}"
+
+  docker:
+    needs: [prerelease]
+    uses: ./.github/workflows/docker.yml
+    with:
+      version: ${{ needs.prerelease.outputs.version }}
+      release: true
+    secrets:
+      docker_username: ${{ secrets.DOCKERHUB_USERNAME }}
+      docker_token: ${{ secrets.DOCKERHUB_TOKEN }}
+
+  build:
+    needs: [prerelease]
+    uses: ./.github/workflows/build.yml
+    with:
+      version_override: ${{ needs.prerelease.outputs.version }}
+      run_unit_tests: false
+
+  release:
+    needs: [prerelease, build]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: artifacts
+          pattern: "*(Classic-)Libation.*"
+
+      - name: Release
+        id: release
+        uses: softprops/action-gh-release@v2
+        with:
+          name: Libation ${{ needs.prerelease.outputs.version }}
+          body: <Put a body here>
+          token: ${{ secrets.GITHUB_TOKEN }}
+          draft: true
+          prerelease: false
+          files: |
+            artifacts/*/*

.github/workflows/validate-appstream-metainfo.yaml

@@ -0,0 +1,22 @@
+name: Validate MetaInfo
+"on":
+  pull_request:
+    branches: ["master"]
+    paths:
+      - .github/workflows/validate-appstream-metainfo.yml
+      - Source/LoadByOS/LinuxConfigApp/com.getlibation.Libation.metainfo.xml
+  push:
+    branches: ["master"]
+    paths:
+      - .github/workflows/validate-appstream-metainfo.yml
+      - Source/LoadByOS/LinuxConfigApp/com.getlibation.Libation.metainfo.xml
+
+jobs:
+  validate-appstream-metainfo:
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/flathub/flatpak-builder-lint:latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Check the MetaInfo file
+        run: flatpak-builder-lint appstream Source/LoadByOS/LinuxConfigApp/com.getlibation.Libation.metainfo.xml

.github/workflows/validate-desktop-file.yaml

@@ -0,0 +1,21 @@
+name: Check desktop file
+"on":
+  pull_request:
+    branches: ["master"]
+    paths:
+      - .github/workflows/validate-desktop-file.yml
+      - Source/LoadByOS/LinuxConfigApp/Libation.desktop
+  push:
+    branches: ["master"]
+    paths:
+      - .github/workflows/validate-desktop-file.yml
+      - Source/LoadByOS/LinuxConfigApp/Libation.desktop
+
+jobs:
+  validate-desktop-file:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: sudo apt --yes install desktop-file-utils
+      - name: Check the desktop file
+        run: desktop-file-validate Source/LoadByOS/LinuxConfigApp/Libation.desktop

.github/workflows/validate.yml

@@ -0,0 +1,22 @@
+# validate.yml
+# Validates that Libation will build on a pull request or push to master.
+---
+name: validate
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  build:
+    uses: ./.github/workflows/build.yml
+  docker:
+    uses: ./.github/workflows/docker.yml
+    with:
+      version: ${GITHUB_SHA}
+      release: false
+    secrets:
+      docker_username: ${{ secrets.DOCKERHUB_USERNAME }}
+      docker_token: ${{ secrets.DOCKERHUB_TOKEN }}

.gitignore

@@ -4,6 +4,7 @@
 ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
 
 # User-specific files
+*.rsuser
 *.suo
 *.user
 *.userosscache
@@ -12,6 +13,9 @@
 # User-specific files (MonoDevelop/Xamarin Studio)
 *.userprefs
 
+# Mono auto generated files
+mono_crash.*
+
 # Build results
 [Dd]ebug/
 [Dd]ebugPublic/
@@ -19,10 +23,15 @@
 [Rr]eleases/
 x64/
 x86/
+[Ww][Ii][Nn]32/
+[Aa][Rr][Mm]/
+[Aa][Rr][Mm]64/
 bld/
 [Bb]in/
 [Oo]bj/
+[Oo]ut/
 [Ll]og/
+[Ll]ogs/
 
 # Visual Studio 2015/2017 cache/options directory
 .vs/
@@ -36,9 +45,10 @@ Generated\ Files/
 [Tt]est[Rr]esult*/
 [Bb]uild[Ll]og.*
 
-# NUNIT
+# NUnit
 *.VisualState.xml
 TestResult.xml
+nunit-*.xml
 
 # Build Results of an ATL Project
 [Dd]ebugPS/
@@ -52,7 +62,9 @@ BenchmarkDotNet.Artifacts/
 project.lock.json
 project.fragment.lock.json
 artifacts/
-**/Properties/launchSettings.json
+
+# ASP.NET Scaffolding
+ScaffoldingReadMe.txt
 
 # StyleCop
 StyleCopReport.xml
@@ -60,7 +72,7 @@ StyleCopReport.xml
 # Files built by Visual Studio
 *_i.c
 *_p.c
-*_i.h
+*_h.h
 *.ilk
 *.meta
 *.obj
@@ -77,6 +89,7 @@ StyleCopReport.xml
 *.tlh
 *.tmp
 *.tmp_proj
+*_wpftmp.csproj
 *.log
 *.vspscc
 *.vssscc
@@ -119,9 +132,6 @@ _ReSharper*/
 *.[Rr]e[Ss]harper
 *.DotSettings.user
 
-# JustCode is a .NET coding add-in
-.JustCode
-
 # TeamCity is a build add-in
 _TeamCity*
 
@@ -132,6 +142,11 @@ _TeamCity*
 .axoCover/*
 !.axoCover/settings.json
 
+# Coverlet is a free, cross platform Code Coverage Tool
+coverage*.json
+coverage*.xml
+coverage*.info
+
 # Visual Studio code coverage results
 *.coverage
 *.coveragexml
@@ -169,7 +184,7 @@ publish/
 *.azurePubxml
 # Note: Comment the next line if you want to checkin your web deploy settings,
 # but database connection strings (with potential passwords) will be unencrypted
-*.pubxml
+#*.pubxml
 *.publishproj
 
 # Microsoft Azure Web App publish settings. Comment the next line if you want to
@@ -179,6 +194,8 @@ PublishScripts/
 
 # NuGet Packages
 *.nupkg
+# NuGet Symbol Packages
+*.snupkg
 # The packages folder can be ignored because of Package Restore
 **/[Pp]ackages/*
 # except build/, which is used as an MSBuild target.
@@ -203,12 +220,14 @@ BundleArtifacts/
 Package.StoreAssociation.xml
 _pkginfo.txt
 *.appx
+*.appxbundle
+*.appxupload
 
 # Visual Studio cache files
 # files ending in .cache can be ignored
 *.[Cc]ache
 # but keep track of directories ending in .cache
-!*.[Cc]ache/
+!?*.[Cc]ache/
 
 # Others
 ClientBin/
@@ -221,7 +240,7 @@ ClientBin/
 *.publishsettings
 orleans.codegen.cs
 
-# Including strong name files can present a security risk 
+# Including strong name files can present a security risk
 # (https://github.com/github/gitignore/pull/2483#issue-259490424)
 #*.snk
 
@@ -252,6 +271,9 @@ ServiceFabricBackup/
 *.bim.layout
 *.bim_*.settings
 *.rptproj.rsuser
+*- [Bb]ackup.rdl
+*- [Bb]ackup ([0-9]).rdl
+*- [Bb]ackup ([0-9][0-9]).rdl
 
 # Microsoft Fakes
 FakesAssemblies/
@@ -287,12 +309,8 @@ paket-files/
 # FAKE - F# Make
 .fake/
 
-# JetBrains Rider
-.idea/
-*.sln.iml
-
-# CodeRush
-.cr/
+# CodeRush personal settings
+.cr/personal
 
 # Python Tools for Visual Studio (PTVS)
 __pycache__/
@@ -317,7 +335,7 @@ __pycache__/
 # OpenCover UI analysis results
 OpenCover/
 
-# Azure Stream Analytics local run output 
+# Azure Stream Analytics local run output
 ASALocalRun/
 
 # MSBuild Binary and Structured Log
@@ -326,10 +344,30 @@ ASALocalRun/
 # NVidia Nsight GPU debugger configuration file
 *.nvuser
 
-# MFractors (Xamarin productivity tool) working folder 
+# MFractors (Xamarin productivity tool) working folder
 .mfractor/
 
+# Local History for Visual Studio
+.localhistory/
+
+# BeatPulse healthcheck temp database
+healthchecksdb
+
+# Backup folder for Package Reference Convert tool in Visual Studio 2017
+MigrationBackup/
+
+# Ionide (cross platform F# VS Code tools) working folder
+.ionide/
+
+# Fody - auto-generated XML schema
+FodyWeavers.xsd
+
+
+### manually ignored files
+
+# Windows shortcuts
+*.lnk
 
-# manually ignored files
 /__TODO.txt
 /DataLayer/LibationContext.db
+*/bin-Avalonia

.releaseindex.json

@@ -0,0 +1,10 @@
+{
+  "WindowsClassic":          "Classic-Libation\\.\\d+\\.\\d+\\.\\d+-win(dows)?-classic\\.zip",
+  "WindowsAvalonia":         "Libation\\.\\d+\\.\\d+\\.\\d+-win(dows)?-chardonnay\\.zip",
+  "LinuxAvalonia":           "Libation\\.\\d+\\.\\d+\\.\\d+-linux-chardonnay-amd64\\.deb",
+  "LinuxAvalonia_RPM":       "Libation\\.\\d+\\.\\d+\\.\\d+-linux-chardonnay-amd64\\.rpm",
+  "MacOSAvalonia":           "Libation\\.\\d+\\.\\d+\\.\\d+-macOS-chardonnay-x64\\.tgz",
+  "LinuxAvalonia_Arm64":     "Libation\\.\\d+\\.\\d+\\.\\d+-linux-chardonnay-arm64\\.deb",
+  "LinuxAvalonia_Arm64_RPM": "Libation\\.\\d+\\.\\d+\\.\\d+-linux-chardonnay-arm64\\.rpm",
+  "MacOSAvalonia_Arm64":     "Libation\\.\\d+\\.\\d+\\.\\d+-macOS-chardonnay-arm64\\.tgz"
+}

.vscode/launch.json

@@ -0,0 +1,21 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+
+        {
+            "name": ".NET Core Launch (console)",
+            "type": "coreclr",
+            "request": "launch",
+            "preLaunchTask": "build",
+            "program": "${workspaceFolder}/Source/bin/Avalonia/Debug/Libation.dll",
+            "args": [],
+            "cwd": "${workspaceFolder}",
+            "stopAtEntry": false,
+            "console": "internalConsole"
+        }
+
+    ]
+}

.vscode/tasks.json

@@ -0,0 +1,42 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "build",
+            "dependsOn": [
+                "build_libation",
+                "build_linuxconfigapp"
+            ]
+        },
+        {
+            "label": "build_libation",
+            "type": "shell",
+            "command": "dotnet",
+            "args": [
+                "build",
+                "${workspaceFolder}/Source/LibationAvalonia/LibationAvalonia.csproj"
+            ],
+            "group": "build",
+            "presentation": {
+                //"reveal": "silent"
+            },
+            "problemMatcher": "$msCompile"
+        },
+        {
+            "label": "build_linuxconfigapp",
+            "type": "shell",
+            "command": "dotnet",
+            "args": [
+                "build",
+                "${workspaceFolder}/Source/LoadByOS/LinuxConfigApp/LinuxConfigApp.csproj"
+            ],
+            "group": "build",
+            "presentation": {
+                //"reveal": "silent"
+            },
+            "problemMatcher": "$msCompile"
+        }
+    ]
+}

AaxDecrypter/AAXChapters.cs

@@ -1,40 +0,0 @@
-using System.Diagnostics;
-using System.Globalization;
-using System.Linq;
-using Dinah.Core.Diagnostics;
-
-namespace AaxDecrypter
-{
-    public class AAXChapters : Chapters
-    {
-        public AAXChapters(string file)
-        {
-            var info = new ProcessStartInfo
-            {
-                FileName = DecryptSupportLibraries.ffprobePath,
-                Arguments = "-loglevel panic -show_chapters -print_format xml \"" + file + "\""
-            };
-            var xml = info.RunHidden().Output;
-
-            var xmlDocument = new System.Xml.XmlDocument();
-            xmlDocument.LoadXml(xml);
-            var chaptersXml = xmlDocument.SelectNodes("/ffprobe/chapters/chapter")
-                .Cast<System.Xml.XmlNode>()
-                .Where(n => n.Name == "chapter");
-
-            foreach (var cnode in chaptersXml)
-            {
-                double startTime = double.Parse(cnode.Attributes["start_time"].Value.Replace(",", "."), CultureInfo.InvariantCulture);
-                double endTime = double.Parse(cnode.Attributes["end_time"].Value.Replace(",", "."), CultureInfo.InvariantCulture);
-
-                string chapterTitle = cnode.ChildNodes
-                    .Cast<System.Xml.XmlNode>()
-                    .Where(childnode => childnode.Attributes["key"].Value == "title")
-                    .Select(childnode => childnode.Attributes["value"].Value)
-                    .FirstOrDefault();
-
-                AddChapter(new Chapter(startTime, endTime, chapterTitle));
-            }
-        }
-    }
-}

AaxDecrypter/AaxDecrypter.csproj

@@ -1,77 +0,0 @@
-<Project Sdk="Microsoft.NET.Sdk">
-
-  <PropertyGroup>
-    <TargetFramework>net5.0</TargetFramework>
-  </PropertyGroup>
-
-  <ItemGroup>
-    <Reference Include="taglib-sharp">
-      <HintPath>lib\taglib-sharp.dll</HintPath>
-    </Reference>
-  </ItemGroup>
-
-  <ItemGroup>
-    <ProjectReference Include="..\..\Dinah.Core\Dinah.Core\Dinah.Core.csproj" />
-  </ItemGroup>
-
-  <ItemGroup>
-    <None Update="DecryptLib\AtomicParsley.exe">
-      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
-    </None>
-    <None Update="DecryptLib\avcodec-57.dll">
-      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
-    </None>
-    <None Update="DecryptLib\avdevice-57.dll">
-      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
-    </None>
-    <None Update="DecryptLib\avfilter-6.dll">
-      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
-    </None>
-    <None Update="DecryptLib\avformat-57.dll">
-      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
-    </None>
-    <None Update="DecryptLib\avutil-55.dll">
-      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
-    </None>
-    <None Update="DecryptLib\cygcrypto-1.0.0.dll">
-      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
-    </None>
-    <None Update="DecryptLib\cyggcc_s-1.dll">
-      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
-    </None>
-    <None Update="DecryptLib\cygmp4v2-2.dll">
-      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
-    </None>
-    <None Update="DecryptLib\cygstdc++-6.dll">
-      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
-    </None>
-    <None Update="DecryptLib\cygwin1.dll">
-      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
-    </None>
-    <None Update="DecryptLib\cygz.dll">
-      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
-    </None>
-    <None Update="DecryptLib\ffmpeg.exe">
-      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
-    </None>
-    <None Update="DecryptLib\ffprobe.exe">
-      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
-    </None>
-    <None Update="DecryptLib\mp4trackdump.exe">
-      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
-    </None>
-    <None Update="DecryptLib\postproc-54.dll">
-      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
-    </None>
-    <None Update="DecryptLib\swresample-2.dll">
-      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
-    </None>
-    <None Update="DecryptLib\swscale-4.dll">
-      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
-    </None>
-    <None Update="DecryptLib\taglib-sharp.dll">
-      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
-    </None>
-  </ItemGroup>
-
-</Project>

AaxDecrypter/AaxToM4bConverter.cs

@@ -1,339 +0,0 @@
-using System;
-using System.Collections.Generic;
-using System.Diagnostics;
-using System.Globalization;
-using System.IO;
-using System.Linq;
-using System.Threading;
-using System.Threading.Tasks;
-using Dinah.Core;
-using Dinah.Core.Diagnostics;
-using Dinah.Core.IO;
-using Dinah.Core.StepRunner;
-
-namespace AaxDecrypter
-{
-    public interface ISimpleAaxToM4bConverter
-    {
-        event EventHandler<int> DecryptProgressUpdate;
-
-        bool Run();
-
-        string AppName { get; set; }
-        string inputFileName { get; }
-        byte[] coverBytes { get;  }
-        string outDir { get; }
-        string outputFileName { get; }
-
-        Chapters chapters { get; }
-        Tags tags { get; }
-        EncodingInfo encodingInfo { get; }
-
-        void SetOutputFilename(string outFileName);
-    }
-    public interface IAdvancedAaxToM4bConverter : ISimpleAaxToM4bConverter
-    {
-        bool Step1_CreateDir();
-        bool Step2_DecryptAax();
-        bool Step3_Chapterize();
-        bool Step4_InsertCoverArt();
-        bool Step5_Cleanup();
-        bool Step6_AddTags();
-        bool End_CreateCue();
-        bool End_CreateNfo();
-    }
-    /// <summary>full c# app. integrated logging. no UI</summary>
-    public class AaxToM4bConverter : IAdvancedAaxToM4bConverter
-    {
-        public event EventHandler<int> DecryptProgressUpdate;
-
-        public string inputFileName { get; }
-        public string decryptKey { get; private set; }
-
-        private StepSequence steps { get; }
-        public byte[] coverBytes { get; private set; }
-
-        public string AppName { get; set; } = nameof(AaxToM4bConverter);
-
-        public string outDir { get; private set; }
-        public string outputFileName { get; private set; }
-
-        public Chapters chapters { get; private set; }
-        public Tags tags { get; private set; }
-        public EncodingInfo encodingInfo { get; private set; }
-
-        private Func<Task<string>> getKeyFuncAsync { get; }
-
-        public static async Task<AaxToM4bConverter> CreateAsync(string inputFile, string decryptKey, Func<Task<string>> getKeyFunc, Chapters chapters = null)
-        {
-            var converter = new AaxToM4bConverter(inputFile, decryptKey, getKeyFunc);
-            converter.chapters = chapters ?? new AAXChapters(inputFile);
-            await converter.prelimProcessing();
-            converter.printPrelim();
-
-            return converter;
-        }
-        private AaxToM4bConverter(string inputFile, string decryptKey, Func<Task<string>> getKeyFunc)
-        {
-			ArgumentValidator.EnsureNotNullOrWhiteSpace(inputFile, nameof(inputFile));
-            if (!File.Exists(inputFile))
-                throw new ArgumentNullException(nameof(inputFile), "File does not exist");
-
-            steps = new StepSequence
-            {
-                Name = "Convert Aax To M4b",
-
-                ["Step 1: Create Dir"] = Step1_CreateDir,
-                ["Step 2: Decrypt Aax"] = Step2_DecryptAax,
-                ["Step 3: Chapterize and tag"] = Step3_Chapterize,
-                ["Step 4: Insert Cover Art"] = Step4_InsertCoverArt,
-                ["Step 5: Cleanup"] = Step5_Cleanup,
-                ["Step 6: Add Tags"] = Step6_AddTags,
-                ["End: Create Cue"] = End_CreateCue,
-                ["End: Create Nfo"] = End_CreateNfo
-            };
-
-            inputFileName = inputFile;
-            this.decryptKey = decryptKey;
-            this.getKeyFuncAsync = getKeyFunc;
-        }
-
-        private async Task prelimProcessing()
-        {
-            tags = new Tags(inputFileName);
-            encodingInfo = new EncodingInfo(inputFileName);
-
-            var defaultFilename = Path.Combine(
-                Path.GetDirectoryName(inputFileName),
-                PathLib.ToPathSafeString(tags.author),
-                PathLib.ToPathSafeString(tags.title) + ".m4b"
-                );
-
-			// set default name
-			SetOutputFilename(defaultFilename);
-
-            await Task.Run(() => saveCover(inputFileName));
-        }
-
-        private void saveCover(string aaxFile)
-        {
-			using var file = TagLib.File.Create(aaxFile, "audio/mp4", TagLib.ReadStyle.Average);
-			coverBytes = file.Tag.Pictures[0].Data.Data;
-		}
-
-        private void printPrelim()
-        {
-            Console.WriteLine($"Audible Book ID = {tags.id}");
-
-            Console.WriteLine($"Book: {tags.title}");
-            Console.WriteLine($"Author: {tags.author}");
-            Console.WriteLine($"Narrator: {tags.narrator}");
-            Console.WriteLine($"Year: {tags.year}");
-            Console.WriteLine($"Total Time: {tags.duration.GetTotalTimeFormatted()} in {chapters.Count} chapters");
-            Console.WriteLine($"WARNING-Source is {encodingInfo.originalBitrate} kbits @ {encodingInfo.sampleRate}Hz, {encodingInfo.channels} channels");
-        }
-
-        public bool Run()
-        {
-            var (IsSuccess, Elapsed) = steps.Run();
-
-            if (!IsSuccess)
-            {
-                Console.WriteLine("WARNING-Conversion failed");
-                return false;
-            }
-
-            var speedup = (int)(tags.duration.TotalSeconds / (long)Elapsed.TotalSeconds);
-            Console.WriteLine("Speedup is " + speedup + "x realtime.");
-            Console.WriteLine("Done");
-            return true;
-        }
-
-        public void SetOutputFilename(string outFileName)
-        {
-            outputFileName = PathLib.ReplaceExtension(outFileName, ".m4b");
-            outDir = Path.GetDirectoryName(outputFileName);
-
-            if (File.Exists(outputFileName))
-                File.Delete(outputFileName);
-        }
-
-        private string outputFileWithNewExt(string extension) => PathLib.ReplaceExtension(outputFileName, extension);
-
-        public bool Step1_CreateDir()
-        {
-            ProcessRunner.WorkingDir = outDir;
-            Directory.CreateDirectory(outDir);
-            return true;
-        }
-
-        public bool Step2_DecryptAax()
-        {
-            DecryptProgressUpdate?.Invoke(this, 0);
-
-            var tempRipFile = Path.Combine(outDir, "funny.aac");
-
-            var fail = "WARNING-Decrypt failure. ";
-
-            int returnCode;
-            if (string.IsNullOrWhiteSpace(decryptKey))
-            {
-                returnCode = getKey_decrypt(tempRipFile);
-            }
-            else
-            {
-                returnCode = decrypt(tempRipFile);
-                if (returnCode == -99)
-                {
-                    Console.WriteLine($"{fail}Incorrect decrypt key: {decryptKey}");
-                    decryptKey = null;
-                    returnCode = getKey_decrypt(tempRipFile);
-                }
-            }
-
-            if (returnCode == 100)
-                Console.WriteLine($"{fail}Thread completed without changing return code. This shouldn't be possible");
-            else if (returnCode == 0)
-            {
-                // success!
-                FileExt.SafeMove(tempRipFile, outputFileWithNewExt(".mp4"));
-                DecryptProgressUpdate?.Invoke(this, 100);
-                return true;
-            }
-            else if (returnCode == -99)
-                Console.WriteLine($"{fail}Incorrect decrypt key: {decryptKey}");
-            else // any other returnCode
-                Console.WriteLine($"{fail}Unknown failure code: {returnCode}");
-
-            FileExt.SafeDelete(tempRipFile);
-            DecryptProgressUpdate?.Invoke(this, 0);
-            return false;
-        }
-
-        private int getKey_decrypt(string tempRipFile)
-        {
-            decryptKey = getKey();
-            return decrypt(tempRipFile);
-        }
-
-        // I am NOT happy about doing async this way. Async needs to be added to Step framework
-        string getKey() => getKeyFuncAsync().GetAwaiter().GetResult();
-
-        private int decrypt(string tempRipFile)
-        {
-            FileExt.SafeDelete(tempRipFile);
-
-            Console.WriteLine("Decrypting with key " + decryptKey);
-
-            var returnCode = 100;
-            var thread = new Thread(() => returnCode = ngDecrypt());
-            thread.Start();
-
-            double fileLen = new FileInfo(inputFileName).Length;
-            while (thread.IsAlive && returnCode == 100)
-            {
-                Thread.Sleep(500);
-                if (File.Exists(tempRipFile))
-                {
-                    double tempLen = new FileInfo(tempRipFile).Length;
-                    var percentProgress = tempLen / fileLen * 100.0;
-                    DecryptProgressUpdate?.Invoke(this, (int)percentProgress);
-                }
-            }
-
-            return returnCode;
-        }
-
-        private int ngDecrypt()
-        {
-            var info = new ProcessStartInfo
-            {
-                FileName = DecryptSupportLibraries.mp4trackdumpPath,
-                Arguments = "-c " + encodingInfo.channels + " -r " + encodingInfo.sampleRate + " \"" + inputFileName + "\""
-            };
-            info.EnvironmentVariables["VARIABLE"] = decryptKey;
-
-            var result = info.RunHidden();
-
-            // bad checksum -- bad decrypt key
-            if (result.Output.Contains("checksums mismatch, aborting!"))
-                return -99;
-
-            return result.ExitCode;
-        }
-
-		// temp file names for steps 3, 4, 5
-        string tempChapsGuid { get; } = Guid.NewGuid().ToString().ToUpper().Replace("-", "");
-        string tempChapsPath => Path.Combine(outDir, $"tempChaps_{tempChapsGuid}.mp4");
-        string mp4_file => outputFileWithNewExt(".mp4");
-        string ff_txt_file => mp4_file + ".ff.txt";
-
-        public bool Step3_Chapterize()
-        {
-            var str1 = "";
-            if (chapters.FirstChapter.StartTime != 0.0)
-            {
-                str1 = " -ss " + chapters.FirstChapter.StartTime.ToString("0.000", CultureInfo.InvariantCulture) + " -t " + chapters.LastChapter.EndTime.ToString("0.000", CultureInfo.InvariantCulture) + " ";
-            }
-
-            var ffmpegTags = tags.GenerateFfmpegTags();
-            var ffmpegChapters = chapters.GenerateFfmpegChapters();
-            File.WriteAllText(ff_txt_file, ffmpegTags + ffmpegChapters);
-
-            var tagAndChapterInfo = new ProcessStartInfo
-            {
-                FileName = DecryptSupportLibraries.ffmpegPath,
-                Arguments = "-y -i \"" + mp4_file + "\" -f ffmetadata -i \"" + ff_txt_file + "\" -map_metadata 1  -bsf:a aac_adtstoasc -c:a copy" + str1 + " -map 0 \"" + tempChapsPath + "\""
-            };
-            tagAndChapterInfo.RunHidden();
-
-            return true;
-        }
-
-        public bool Step4_InsertCoverArt()
-        {
-            // save cover image as temp file
-            var coverPath = Path.Combine(outDir, "cover-" + Guid.NewGuid() + ".jpg");
-            FileExt.CreateFile(coverPath, coverBytes);
-
-            var insertCoverArtInfo = new ProcessStartInfo
-            {
-                FileName = DecryptSupportLibraries.atomicParsleyPath,
-                Arguments = "\"" + tempChapsPath + "\" --encodingTool \"" + AppName + "\" --artwork \"" + coverPath + "\" --overWrite"
-            };
-            insertCoverArtInfo.RunHidden();
-
-            // delete temp file
-            FileExt.SafeDelete(coverPath);
-
-            return true;
-        }
-
-        public bool Step5_Cleanup()
-        {
-            FileExt.SafeDelete(mp4_file);
-            FileExt.SafeDelete(ff_txt_file);
-            FileExt.SafeMove(tempChapsPath, outputFileName);
-
-            return true;
-        }
-
-        public bool Step6_AddTags()
-        {
-            tags.AddAppleTags(outputFileName);
-            return true;
-        }
-
-        public bool End_CreateCue()
-        {
-            File.WriteAllText(outputFileWithNewExt(".cue"), Cue.CreateContents(Path.GetFileName(outputFileName), chapters));
-            return true;
-        }
-
-        public bool End_CreateNfo()
-        {
-            File.WriteAllText(outputFileWithNewExt(".nfo"), NFO.CreateContents(AppName, tags, encodingInfo, chapters));
-            return true;
-        }
-    }
-}

AaxDecrypter/Chapter.cs

@@ -1,27 +0,0 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
-
-namespace AaxDecrypter
-{
-    public class Chapter
-    {
-        public Chapter(double startTime, double endTime, string title)
-        {
-            StartTime = startTime;
-            EndTime = endTime;
-            Title = title;
-        }
-        /// <summary>
-        /// Chapter start time, in seconds.
-        /// </summary>
-        public double StartTime { get; private set; }
-        /// <summary>
-        /// Chapter end time, in seconds.
-        /// </summary>
-        public double EndTime { get; private set; }
-        public string Title { get; private set; }
-    }
-}

AaxDecrypter/Chapters.cs

@@ -1,40 +0,0 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-
-namespace AaxDecrypter
-{
-    public abstract class Chapters
-    {
-        private List<Chapter> _chapterList = new();
-        public int Count => _chapterList.Count;
-        public Chapter FirstChapter => _chapterList[0];
-        public Chapter LastChapter => _chapterList[Count - 1];
-        public IEnumerable<Chapter> ChapterList => _chapterList.AsEnumerable();
-        public IEnumerable<TimeSpan> GetBeginningTimes() => ChapterList.Select(c => TimeSpan.FromSeconds(c.StartTime));
-        protected void AddChapter(Chapter chapter)
-        {
-            _chapterList.Add(chapter);
-        }
-        protected void AddChapters(IEnumerable<Chapter> chapters)
-        {
-            _chapterList.AddRange(chapters);
-        }
-        public string GenerateFfmpegChapters()
-        {
-            var stringBuilder = new StringBuilder();
-
-            foreach (Chapter c in ChapterList)
-            {
-                stringBuilder.Append("[CHAPTER]\n");
-                stringBuilder.Append("TIMEBASE=1/1000\n");
-                stringBuilder.Append("START=" + c.StartTime * 1000 + "\n");
-                stringBuilder.Append("END=" + c.EndTime * 1000 + "\n");
-                stringBuilder.Append("title=" + c.Title + "\n");
-            }
-
-            return stringBuilder.ToString();
-        }
-    }
-}

AaxDecrypter/DecryptSupportLibraries.cs

@@ -1,21 +0,0 @@
-using System.IO;
-
-namespace AaxDecrypter
-{
-    public static class DecryptSupportLibraries
-    {
-        // OTHER EXTERNAL DEPENDENCIES
-        // ffprobe has these pre-req.s as I'm using it:
-        // avcodec-57.dll, avdevice-57.dll, avfilter-6.dll, avformat-57.dll, avutil-55.dll, postproc-54.dll, swresample-2.dll, swscale-4.dll, taglib-sharp.dll
-        //
-        // something else needs the cygwin files (cyg*.dll)
-
-        private static string appPath_ { get; } = Path.GetDirectoryName(Dinah.Core.Exe.FileLocationOnDisk);
-        private static string decryptLib_ { get; } = Path.Combine(appPath_, "DecryptLib");
-
-        public static string ffmpegPath { get; } = Path.Combine(decryptLib_, "ffmpeg.exe");
-        public static string ffprobePath { get; } = Path.Combine(decryptLib_, "ffprobe.exe");
-        public static string atomicParsleyPath { get; } = Path.Combine(decryptLib_, "AtomicParsley.exe");
-        public static string mp4trackdumpPath { get; } = Path.Combine(decryptLib_, "mp4trackdump.exe");
-    }
-}

AaxDecrypter/EncodingInfo.cs

@@ -1,41 +0,0 @@
-using System;
-using System.Diagnostics;
-using Dinah.Core.Diagnostics;
-
-namespace AaxDecrypter
-{
-    public class EncodingInfo
-    {
-        public int sampleRate { get; } = 44100;
-        public int channels { get; } = 2;
-        public int originalBitrate { get; }
-
-        public EncodingInfo(string file)
-        {
-            var info = new ProcessStartInfo
-            {
-                FileName = DecryptSupportLibraries.ffprobePath,
-                Arguments = "-loglevel panic -show_streams -print_format flat \"" + file + "\""
-            };
-            var end = info.RunHidden().Output;
-
-            foreach (string str2 in end.Split('\n'))
-            {
-                string[] strArray = str2.Split('=');
-                switch (strArray[0])
-                {
-                    case "streams.stream.0.channels":
-                        this.channels = int.Parse(strArray[1].Replace("\"", "").TrimEnd('\r', '\n'));
-                        break;
-                    case "streams.stream.0.sample_rate":
-                        this.sampleRate = int.Parse(strArray[1].Replace("\"", "").TrimEnd('\r', '\n'));
-                        break;
-                    case "streams.stream.0.bit_rate":
-                        string s = strArray[1].Replace("\"", "").TrimEnd('\r', '\n');
-                        this.originalBitrate = (int)Math.Round(double.Parse(s) / 1000.0, MidpointRounding.AwayFromZero);
-                        break;
-                }
-            }
-        }
-    }
-}

AaxDecrypter/NFO.cs

@@ -1,54 +0,0 @@
-namespace AaxDecrypter
-{
-    public static class NFO
-    {
-        public static string CreateContents(string ripper, Tags tags, EncodingInfo encodingInfo, Chapters chapters)
-        {
-            var _hours = (int)tags.duration.TotalHours;
-            var myDuration
-                = (_hours > 0 ? _hours + " hours, " : "")
-                + tags.duration.Minutes + " minutes, "
-                + tags.duration.Seconds + " seconds";
-
-            var header
-                = "General Information\r\n"
-                + "===================\r\n"
-                + $" Title:                  {tags.title}\r\n"
-                + $" Author:                 {tags.author}\r\n"
-                + $" Read By:                {tags.narrator}\r\n"
-                + $" Copyright:              {tags.year}\r\n"
-                + $" Audiobook Copyright:    {tags.year}\r\n";
-            if (tags.genre != "")
-                header += $" Genre:                  {tags.genre}\r\n";
-
-            var s
-                = header
-                + $" Publisher:              {tags.publisher}\r\n"
-                + $" Duration:               {myDuration}\r\n"
-                + $" Chapters:               {chapters.Count}\r\n"
-                + "\r\n"
-                + "\r\n"
-                + "Media Information\r\n"
-                + "=================\r\n"
-                + " Source Format:          Audible AAX\r\n"
-                + $" Source Sample Rate:     {encodingInfo.sampleRate} Hz\r\n"
-                + $" Source Channels:        {encodingInfo.channels}\r\n"
-                + $" Source Bitrate:         {encodingInfo.originalBitrate} kbits\r\n"
-                + "\r\n"
-                + " Lossless Encode:        Yes\r\n"
-                + " Encoded Codec:          AAC / M4B\r\n"
-                + $" Encoded Sample Rate:    {encodingInfo.sampleRate} Hz\r\n"
-                + $" Encoded Channels:       {encodingInfo.channels}\r\n"
-                + $" Encoded Bitrate:        {encodingInfo.originalBitrate} kbits\r\n"
-                + "\r\n"
-                + $" Ripper:                 {ripper}\r\n"
-                + "\r\n"
-                + "\r\n"
-                + "Book Description\r\n"
-                + "================\r\n"
-                + tags.comments;
-
-            return s;
-        }
-    }
-}

AaxDecrypter/Tags.cs

@@ -1,67 +0,0 @@
-using System;
-using TagLib;
-using TagLib.Mpeg4;
-using Dinah.Core;
-
-namespace AaxDecrypter
-{
-    public class Tags
-    {
-        public string title { get; }
-        public string album { get; }
-        public string author { get; }
-        public string comments { get; }
-        public string narrator { get; }
-        public string year { get; }
-        public string publisher { get; }
-        public string id { get; }
-        public string genre { get; }
-        public TimeSpan duration { get; }
-
-        // input file
-        public Tags(string file)
-        {
-            using var tagLibFile = TagLib.File.Create(file, "audio/mp4", ReadStyle.Average);
-			title = tagLibFile.Tag.Title.Replace(" (Unabridged)", "");
-			album = tagLibFile.Tag.Album.Replace(" (Unabridged)", "");
-			author = tagLibFile.Tag.FirstPerformer ?? "[unknown]";
-			year = tagLibFile.Tag.Year.ToString();
-			comments = tagLibFile.Tag.Comment ?? "";
-			duration = tagLibFile.Properties.Duration;
-			genre = tagLibFile.Tag.FirstGenre ?? "";
-
-            var tag = tagLibFile.GetTag(TagTypes.Apple, true);
-			publisher = tag.Publisher ?? "";
-			narrator = string.IsNullOrWhiteSpace(tagLibFile.Tag.FirstComposer) ? tag.Narrator : tagLibFile.Tag.FirstComposer;
-			comments = !string.IsNullOrWhiteSpace(tag.LongDescription) ? tag.LongDescription : tag.Description;
-			id = tag.AudibleCDEK;
-		}
-
-        // my best guess of what this step is doing:
-        // re-publish the data we read from the input file => output file
-        public void AddAppleTags(string file)
-        {
-            using var tagLibFile = TagLib.File.Create(file, "audio/mp4", ReadStyle.Average);
-            var tag = (AppleTag)tagLibFile.GetTag(TagTypes.Apple, true);
-			tag.Publisher = publisher;
-			tag.LongDescription = comments;
-			tag.Description = comments;
-            tagLibFile.Save();
-		}
-
-        public string GenerateFfmpegTags()
-            => $";FFMETADATA1"
-            + $"\nmajor_brand=aax"
-            + $"\nminor_version=1"
-            + $"\ncompatible_brands=aax M4B mp42isom"
-            + $"\ndate={year}"
-            + $"\ngenre={genre}"
-            + $"\ntitle={title}"
-            + $"\nartist={author}"
-            + $"\nalbum={album}"
-            + $"\ncomposer={narrator}"
-            + $"\ncomment={comments.Truncate(254)}"
-            + $"\ndescription={comments}"
-            + $"\n";
-    }
-}

ApplicationServices/ApplicationServices.csproj

@@ -1,20 +0,0 @@
-<Project Sdk="Microsoft.NET.Sdk">
-
-  <PropertyGroup>
-    <TargetFramework>net5.0</TargetFramework>
-  </PropertyGroup>
-
-  <ItemGroup>
-    <PackageReference Include="CsvHelper" Version="27.0.2" />
-    <PackageReference Include="NPOI" Version="2.5.3" />
-  </ItemGroup>
-
-  <ItemGroup>
-    <ProjectReference Include="..\..\audible api\AudibleApi\AudibleApiDTOs\AudibleApiDTOs.csproj" />
-    <ProjectReference Include="..\..\audible api\AudibleApi\AudibleApi\AudibleApi.csproj" />
-    <ProjectReference Include="..\DtoImporterService\DtoImporterService.csproj" />
-    <ProjectReference Include="..\InternalUtilities\InternalUtilities.csproj" />
-    <ProjectReference Include="..\LibationSearchEngine\LibationSearchEngine.csproj" />
-  </ItemGroup>
-
-</Project>

ApplicationServices/DbContexts.cs

@@ -1,16 +0,0 @@
-using System;
-using DataLayer;
-using FileManager;
-
-namespace ApplicationServices
-{
-	public static class DbContexts
-	{
-		//// idea for future command/query separation
-		// public static LibationContext GetCommandContext() { }
-		// public static LibationContext GetQueryContext() { }
-
-		public static LibationContext GetContext()
-			=> LibationContext.Create(SqliteStorage.ConnectionString);
-	}
-}

ApplicationServices/LibraryCommands.cs

@@ -1,123 +0,0 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Threading.Tasks;
-using AudibleApi;
-using DataLayer;
-using Dinah.Core;
-using DtoImporterService;
-using InternalUtilities;
-using Serilog;
-
-namespace ApplicationServices
-{
-	public static class LibraryCommands
-	{
-		public static async Task<(int totalCount, int newCount)> ImportAccountAsync(Func<Account, ILoginCallback> loginCallbackFactoryFunc, params Account[] accounts)
-		{
-			if (accounts is null || accounts.Length == 0)
-				return (0, 0);
-
-			try
-			{
-				var importItems = await scanAccountsAsync(loginCallbackFactoryFunc, accounts);
-
-				var totalCount = importItems.Count;
-				Log.Logger.Information($"GetAllLibraryItems: Total count {totalCount}");
-
-				var newCount = await importIntoDbAsync(importItems);
-				Log.Logger.Information($"Import: New count {newCount}");
-
-				await Task.Run(() => SearchEngineCommands.FullReIndex());
-				Log.Logger.Information("FullReIndex: success");
-
-				return (totalCount, newCount);
-			}
-			catch (AudibleApi.Authentication.LoginFailedException lfEx)
-			{
-				lfEx.MoveResponseBodyFile(FileManager.Configuration.Instance.LibationFiles);
-
-				// nuget Serilog.Exceptions would automatically log custom properties
-				//   However, it comes with a scary warning when used with EntityFrameworkCore which I'm not yet ready to implement:
-				//   https://github.com/RehanSaeed/Serilog.Exceptions
-				// work-around: use 3rd param. don't just put exception object in 3rd param -- info overload: stack trace, etc
-				Log.Logger.Error(lfEx, "Error importing library. Login failed. {@DebugInfo}", new {
-					lfEx.RequestUrl,
-					ResponseStatusCodeNumber = (int)lfEx.ResponseStatusCode,
-					ResponseStatusCodeDesc = lfEx.ResponseStatusCode,
-					lfEx.ResponseInputFields,
-					lfEx.ResponseBodyFilePath
-				});
-				throw;
-			}
-			catch (Exception ex)
-			{
-				Log.Logger.Error(ex, "Error importing library");
-				throw;
-			}
-		}
-
-		private static async Task<List<ImportItem>> scanAccountsAsync(Func<Account, ILoginCallback> loginCallbackFactoryFunc, Account[] accounts)
-		{
-			var tasks = new List<Task<List<ImportItem>>>();
-			foreach (var account in accounts)
-			{
-				var callback = loginCallbackFactoryFunc(account);
-
-				// get APIs in serial, esp b/c of logins
-				var api = await AudibleApiActions.GetApiAsync(callback, account);
-
-				// add scanAccountAsync as a TASK: do not await
-				tasks.Add(scanAccountAsync(api, account));
-			}
-
-			// import library in parallel
-			var arrayOfLists = await Task.WhenAll(tasks);
-			var importItems = arrayOfLists.SelectMany(a => a).ToList();
-			return importItems;
-		}
-
-		private static async Task<List<ImportItem>> scanAccountAsync(Api api, Account account)
-		{
-			ArgumentValidator.EnsureNotNull(account, nameof(account));
-
-			Log.Logger.Information("ImportLibraryAsync. {@DebugInfo}", new
-			{
-				Account = account?.MaskedLogEntry ?? "[null]"
-			});
-
-			var dtoItems = await AudibleApiActions.GetLibraryValidatedAsync(api);
-			return dtoItems.Select(d => new ImportItem { DtoItem = d, AccountId = account.AccountId, LocaleName = account.Locale?.Name }).ToList();
-		}
-
-		private static async Task<int> importIntoDbAsync(List<ImportItem> importItems)
-		{
-			using var context = DbContexts.GetContext();
-			var libraryImporter = new LibraryImporter(context);
-			var newCount = await Task.Run(() => libraryImporter.Import(importItems));
-			context.SaveChanges();
-
-			return newCount;
-		}
-
-		public static int UpdateTags(this LibationContext context, Book book, string newTags)
-		{
-			try
-			{
-				book.UserDefinedItem.Tags = newTags;
-
-				var qtyChanges = context.SaveChanges();
-
-				if (qtyChanges > 0)
-					SearchEngineCommands.UpdateBookTags(book);
-
-				return qtyChanges;
-			}
-			catch (Exception ex)
-			{
-				Log.Logger.Error(ex, "Error updating tags");
-				throw;
-			}
-		}
-	}
-}

ApplicationServices/SearchEngineCommands.cs

@@ -1,56 +0,0 @@
-using System;
-using System.IO;
-using DataLayer;
-using LibationSearchEngine;
-
-namespace ApplicationServices
-{
-	public static class SearchEngineCommands
-	{
-		public static void FullReIndex()
-		{
-			var engine = new SearchEngine(DbContexts.GetContext());
-			engine.CreateNewIndex();
-		}
-
-		public static SearchResultSet Search(string searchString) => performSearchEngineFunc_safe(e =>
-			e.Search(searchString)
-		);
-
-		public static void UpdateBookTags(Book book) => performSearchEngineAction_safe(e =>
-			e.UpdateTags(book.AudibleProductId, book.UserDefinedItem.Tags)
-		);
-
-		public static void UpdateIsLiberated(Book book) => performSearchEngineAction_safe(e =>
-			e.UpdateIsLiberated(book.AudibleProductId)
-		);
-
-		private static void performSearchEngineAction_safe(Action<SearchEngine> action)
-		{
-			var engine = new SearchEngine(DbContexts.GetContext());
-			try
-			{
-				action(engine);
-			}
-			catch (FileNotFoundException)
-			{
-				FullReIndex();
-				action(engine);
-			}
-		}
-
-		private static T performSearchEngineFunc_safe<T>(Func<SearchEngine, T> action)
-		{
-			var engine = new SearchEngine(DbContexts.GetContext());
-			try
-			{
-				return action(engine);
-			}
-			catch (FileNotFoundException)
-			{
-				FullReIndex();
-				return action(engine);
-			}
-		}
-	}
-}

DataLayer/Configurations/BookConfig.cs

@@ -1,71 +0,0 @@
-using Microsoft.EntityFrameworkCore;
-using Microsoft.EntityFrameworkCore.Metadata.Builders;
-
-namespace DataLayer.Configurations
-{
-    internal class BookConfig : IEntityTypeConfiguration<Book>
-    {
-        public void Configure(EntityTypeBuilder<Book> entity)
-        {
-            entity.HasKey(b => b.BookId);
-            entity.HasIndex(b => b.AudibleProductId);
-
-            entity.OwnsOne(b => b.Rating);
-
-            //
-            // CRUCIAL: ignore unmapped collections, even get-only
-            //
-            entity.Ignore(nameof(Book.Authors));
-            entity.Ignore(nameof(Book.Narrators));
-			//// these don't seem to matter
-			//entity.Ignore(nameof(Book.AuthorNames));
-			//entity.Ignore(nameof(Book.NarratorNames));
-			//entity.Ignore(nameof(Book.HasPdfs));
-
-			// OwnsMany: "Can only ever appear on navigation properties of other entity types.
-			//  Are automatically loaded, and can only be tracked by a DbContext alongside their owner."
-			entity
-				.OwnsMany(b => b.Supplements, b_s =>
-				{
-					b_s.WithOwner(s => s.Book)
-						.HasForeignKey(s => s.BookId);
-					b_s.HasKey(s => s.SupplementId);
-				});
-            // even though it's owned, we need to map its backing field
-            entity
-                .Metadata
-                .FindNavigation(nameof(Book.Supplements))
-                .SetPropertyAccessMode(PropertyAccessMode.Field);
-
-			// owns it 1:1, store in separate table
-			entity
-				.OwnsOne(b => b.UserDefinedItem, b_udi =>
-				{
-					b_udi.WithOwner(udi => udi.Book)
-						.HasForeignKey(udi => udi.BookId);
-					b_udi.Property(udi => udi.BookId).ValueGeneratedNever();
-					b_udi.ToTable(nameof(Book.UserDefinedItem));
-
-					// owns it 1:1, store in same table
-					b_udi.OwnsOne(udi => udi.Rating);
-				});
-
-			entity
-                .Metadata
-                .FindNavigation(nameof(Book.ContributorsLink))
-                // PropertyAccessMode.Field : Contributions is a get-only property, not a field, so use its backing field
-                .SetPropertyAccessMode(PropertyAccessMode.Field);
-
-            entity
-                .Metadata
-                .FindNavigation(nameof(Book.SeriesLink))
-                // PropertyAccessMode.Field : Series is a get-only property, not a field, so use its backing field
-                .SetPropertyAccessMode(PropertyAccessMode.Field);
-
-            entity
-                .HasOne(b => b.Category)
-                .WithMany()
-                .HasForeignKey(b => b.CategoryId);
-		}
-    }
-}

DataLayer/Configurations/LibraryBookConfig.cs

@@ -1,18 +0,0 @@
-using Microsoft.EntityFrameworkCore;
-using Microsoft.EntityFrameworkCore.Metadata.Builders;
-
-namespace DataLayer.Configurations
-{
-    internal class LibraryBookConfig : IEntityTypeConfiguration<LibraryBook>
-    {
-        public void Configure(EntityTypeBuilder<LibraryBook> entity)
-        {
-            entity.HasKey(b => b.BookId);
-
-            entity
-                .HasOne(le => le.Book)
-                .WithOne()
-                .HasForeignKey<LibraryBook>(le => le.BookId);
-        }
-    }
-}

DataLayer/EfClasses/Role.cs

@@ -1,4 +0,0 @@
-namespace DataLayer
-{
-    public enum Role { Author = 1, Narrator = 2, Publisher = 3 }
-}

DataLayer/EfClasses/SeriesBook.cs

@@ -1,40 +0,0 @@
-using Dinah.Core;
-
-namespace DataLayer
-{
-    public class SeriesBook
-    {
-        internal int SeriesId { get; private set; }
-        internal int BookId { get; private set; }
-
-        /// <summary>
-        /// <para>"index" not "order". This is both for sequence and display</para>
-        /// <para>Float allows for in-between books. eg: 2.5</para>
-        /// <para>To show 2 editions as the same book in a series, give them the same index</para>
-        /// <para>null IS NOT the same as 0. Some series call a book "book 0"</para>
-        /// </summary>
-        public float? Index { get; private set; }
-
-        public Series Series { get; private set; }
-        public Book Book { get; private set; }
-
-        private SeriesBook() { }
-        internal SeriesBook(Series series, Book book, float? index = null)
-        {
-            ArgumentValidator.EnsureNotNull(series, nameof(series));
-            ArgumentValidator.EnsureNotNull(book, nameof(book));
-
-            Series = series;
-            Book = book;
-            Index = index;
-        }
-
-        public void UpdateIndex(float? index)
-        {
-            if (index.HasValue)
-                Index = index.Value;
-        }
-
-		public override string ToString() => $"Series={Series} Book={Book}";
-	}
-}

DataLayer/EfClasses/UserDefinedItem.cs

@@ -1,84 +0,0 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text.RegularExpressions;
-using Dinah.Core;
-
-namespace DataLayer
-{
-    public class UserDefinedItem
-    {
-        internal int BookId { get; private set; }
-        public Book Book { get; private set; }
-
-        private UserDefinedItem() { }
-        internal UserDefinedItem(Book book)
-		{
-			ArgumentValidator.EnsureNotNull(book, nameof(book));
-            Book = book;
-
-			// import previously saved tags
-			ArgumentValidator.EnsureNotNullOrWhiteSpace(book.AudibleProductId, nameof(book.AudibleProductId));
-			Tags = FileManager.TagsPersistence.GetTags(book.AudibleProductId);
-		}
-
-        private string _tags = "";
-        public string Tags
-        {
-            get => _tags;
-            set => _tags = sanitize(value);
-		}
-
-		public IEnumerable<string> TagsEnumerated => Tags == "" ? new string[0] : Tags.Split(null as char[], StringSplitOptions.RemoveEmptyEntries);
-
-		#region sanitize tags: space delimited. Inline/denormalized. Lower case. Alpha numeric and hyphen
-		// only legal chars are letters numbers underscores and separating whitespace
-		//
-		// technically, the only char.s which aren't easily supported are  \  [  ]
-		// however, whitelisting is far safer than blacklisting (eg: new lines, non-printable character)
-		// it's easy to expand whitelist as needed
-		// for lucene, ToLower() isn't needed because search is case-inspecific. for here, it prevents duplicates
-		//
-		// there are also other allowed but misleading characters. eg: the ^ operator defines a 'boost' score
-		// full list of characters which must be escaped:
-		//   + - && || ! ( ) { } [ ] ^ " ~ * ? : \
-		static Regex regex { get; } = new Regex(@"[^\w\d\s_]", RegexOptions.Compiled);
-        private static string sanitize(string input)
-        {
-            if (string.IsNullOrWhiteSpace(input))
-                return "";
-
-            var str = input
-                .Trim()
-                .ToLowerInvariant()
-                // assume a hyphen is supposed to be an underscore
-                .Replace("-", "_");
-
-            var unique = regex
-                // turn illegal characters into a space. this will also take care of turning new lines into spaces
-                .Replace(str, " ")
-                // split and remove excess spaces
-                .Split(new[] { ' ' }, StringSplitOptions.RemoveEmptyEntries)
-                // de-dup
-                .Distinct()
-                // this will prevent order from being relevant
-                .OrderBy(a => a);
-
-            // currently, the string is the canonical set. if we later make the collection into the canonical set:
-            //   var tags = new Hashset<string>(list); // de-dup, order doesn't matter but can seem random due to hashing algo
-            //   var isEqual = tagsNew.SetEquals(tagsOld);
-
-            return string.Join(" ", unique);
-        }
-        #endregion
-
-        // owned: not an optional one-to-one
-        /// <summary>The user's individual book rating</summary>
-        public Rating Rating { get; private set; } = new Rating(0, 0, 0);
-
-        public void UpdateRating(float overallRating, float performanceRating, float storyRating)
-            => Rating.Update(overallRating, performanceRating, storyRating);
-
-		public override string ToString() => $"{Book} {Rating} {Tags}";
-	}
-}

DataLayer/QueryObjects/BookQueries.cs

@@ -1,35 +0,0 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Linq.Expressions;
-using Microsoft.EntityFrameworkCore;
-
-namespace DataLayer
-{
-    public static class BookQueries
-    {
-        public static Book GetBook_Flat_NoTracking(this LibationContext context, string productId)
-            => context
-                .Books
-                .AsNoTracking()
-                .GetBook(productId);
-
-        public static Book GetBook(this IQueryable<Book> books, string productId)
-            => books
-                .GetBooks()
-                .SingleOrDefault(b => b.AudibleProductId == productId);
-
-        /// <summary>This is still IQueryable. YOU MUST CALL ToList() YOURSELF</summary>
-        public static IQueryable<Book> GetBooks(this IQueryable<Book> books, Expression<Func<Book, bool>> predicate)
-            => books
-                .GetBooks()
-                .Where(predicate);
-
-        public static IQueryable<Book> GetBooks(this IQueryable<Book> books)
-            => books
-                // owned items are always loaded. eg: book.UserDefinedItem, book.Supplements
-                .Include(b => b.SeriesLink).ThenInclude(sb => sb.Series)
-                .Include(b => b.ContributorsLink).ThenInclude(c => c.Contributor)
-                .Include(b => b.Category).ThenInclude(c => c.ParentCategory);
-    }
-}

DataLayer/QueryObjects/GenericPaging.cs

@@ -1,19 +0,0 @@
-using System;
-using System.Linq;
-
-namespace DataLayer
-{
-    public static class GenericPaging
-    {
-        public static IQueryable<T> Page<T>(this IQueryable<T> query, int pageNumZeroStart, int pageSize)
-        {
-            if (pageSize < 1)
-                throw new ArgumentOutOfRangeException(nameof(pageSize), "pageSize must be at least 1");
-
-            if (pageNumZeroStart > 0)
-                query = query.Skip(pageNumZeroStart * pageSize);
-
-            return query.Take(pageSize);
-        }
-    }
-}

DataLayer/QueryObjects/LibraryQueries.cs

@@ -1,41 +0,0 @@
-using System.Collections.Generic;
-using System.Linq;
-using Microsoft.EntityFrameworkCore;
-
-namespace DataLayer
-{
-    public static class LibraryQueries
-	{
-		public static List<LibraryBook> GetLibrary_Flat_WithTracking(this LibationContext context)
-			=> context
-				.Library
-				.GetLibrary()
-				.ToList();
-
-		public static List<LibraryBook> GetLibrary_Flat_NoTracking(this LibationContext context)
-            => context
-                .Library
-                .AsNoTracking()
-                .GetLibrary()
-                .ToList();
-
-        public static LibraryBook GetLibraryBook_Flat_NoTracking(this LibationContext context, string productId)
-            => context
-                .Library
-                .AsNoTracking()
-                .GetLibraryBook(productId);
-
-        /// <summary>This is still IQueryable. YOU MUST CALL ToList() YOURSELF</summary>
-        public static IQueryable<LibraryBook> GetLibrary(this IQueryable<LibraryBook> library)
-            => library
-                // owned items are always loaded. eg: book.UserDefinedItem, book.Supplements
-                .Include(le => le.Book).ThenInclude(b => b.SeriesLink).ThenInclude(sb => sb.Series)
-                .Include(le => le.Book).ThenInclude(b => b.ContributorsLink).ThenInclude(c => c.Contributor)
-                .Include(le => le.Book).ThenInclude(b => b.Category).ThenInclude(c => c.ParentCategory);
-
-        public static LibraryBook GetLibraryBook(this IQueryable<LibraryBook> library, string productId)
-            => library
-                .GetLibrary()
-                .SingleOrDefault(le => le.Book.AudibleProductId == productId);
-    }
-}

DataLayer/TagPersistenceInterceptor.cs

@@ -1,30 +0,0 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using Dinah.Core.Collections.Generic;
-using Dinah.EntityFrameworkCore;
-using Microsoft.EntityFrameworkCore;
-
-namespace DataLayer
-{
-    internal class TagPersistenceInterceptor : IDbInterceptor
-    {
-        public void Executed(DbContext context) { }
-
-        public void Executing(DbContext context)
-		{
-			var tagsCollection
-				= context
-				.ChangeTracker
-				.Entries()
-				.Where(e => e.State.In(EntityState.Modified, EntityState.Added))
-				.Select(e => e.Entity as UserDefinedItem)
-				.Where(udi => udi != null)
-				// do NOT filter out entires with blank tags. blank is the valid way to show the absence of tags
-				.Select(t => (t.Book.AudibleProductId, t.Tags))
-				.ToList();
-
-			FileManager.TagsPersistence.Save(tagsCollection);
-		}
-	}
-}

DataLayer/Utilities/LocalDatabaseInfo.cs

@@ -1,38 +0,0 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-
-namespace DataLayer.Utilities
-{
-	public static class LocalDatabaseInfo
-	{
-		public static List<string> GetLocalDBInstances()
-		{
-			// Start the child process.
-			using var p = new System.Diagnostics.Process
-			{
-				StartInfo = new System.Diagnostics.ProcessStartInfo
-				{
-					UseShellExecute = false,
-					RedirectStandardOutput = true,
-					FileName = "cmd.exe",
-					Arguments = "/C sqllocaldb info",
-					CreateNoWindow = true,
-					WindowStyle = System.Diagnostics.ProcessWindowStyle.Hidden
-				}
-			};
-			p.Start();
-			var output = p.StandardOutput.ReadToEnd();
-			p.WaitForExit();
-
-			// if LocalDb is not installed then it will return that 'sqllocaldb' is not recognized as an internal or external command operable program or batch file
-			return string.IsNullOrWhiteSpace(output) || output.Contains("not recognized")
-				? new List<string>()
-				: output
-					.Split(new string[] { Environment.NewLine }, StringSplitOptions.None)
-					.Select(i => i.Trim())
-					.Where(i => !string.IsNullOrEmpty(i))
-					.ToList();
-		}
-	}
-}

DataLayer/_HowTo- EF Core.txt

@@ -1,57 +0,0 @@
-FOR QUICK MIGRATION INSTRUCTIONS:
-_DB_NOTES.txt
-
-
-HOW TO CREATE: EF CORE PROJECT
-==============================
-example is for sqlite but the same works with MsSql
-
-
-nuget
-Microsoft.EntityFrameworkCore.Tools (needed for using Package Manager Console)
-Microsoft.EntityFrameworkCore.Sqlite
-
-MIGRATIONS
-  require core, not standard
-  this can be a problem b/c standard and framework can only reference standard, not core
-TO USE MIGRATIONS (core and/or standard)
-  add to csproj
-    <PropertyGroup>
-      <GenerateRuntimeConfigurationFiles>true</GenerateRuntimeConfigurationFiles>
-    </PropertyGroup>
-TO USE MIGRATIONS AS *BOTH* CORE AND STANDARD
-  edit csproj
-    pluralize this xml tag
-      from: TargetFramework
-      to: TargetFrameworks
-    inside of TargetFrameworks
-      from: netstandard2.1
-      to: netcoreapp3.1;netstandard2.1
-
-run. error
-SQLite Error 1: 'no such table: Blogs'.
-
-set project "Set as StartUp Project"
-
-Tools >> Nuget Package Manager >> Package Manager Console
-default project: Examples\SQLite_NETCore2_0
-
-PM> add-migration InitialCreate
-PM> Update-Database
-
-if add-migration xyz throws and error, don't take the error msg at face value. try again with add-migration xyz -verbose
-
-new sqlite .db file created: Copy always/Copy if newer
-or copy .db file to destination
-
-relative:
-   optionsBuilder.UseSqlite("Data Source=blogging.db");
-absolute  (use fwd slashes):
-   optionsBuilder.UseSqlite("Data Source=C:/foo/bar/blogging.db");
-
-
-REFERENCE ARTICLES
-------------------
-https://docs.microsoft.com/en-us/ef/core/get-started/netcore/new-db-sqlite
-https://carlos.mendible.com/2016/07/11/step-by-step-dotnet-core-and-entity-framework-core/
-https://www.benday.com/2017/12/19/ef-core-2-0-migrations-without-hard-coded-connection-strings/

DataLayer/appsettings.json

@@ -1,6 +0,0 @@
-{
-  "ConnectionStrings": {
-    "// this connection string is ONLY used for DataLayer's Migrations. this appsettings.json file is NOT used at all by application; it is overwritten":  "",
-    "LibationContext": "Data Source=LibationContext.db;Foreign Keys=False;"
-  }
-}

Docker/appsettings.json

@@ -0,0 +1,3 @@
+{
+  "LibationFiles": "/config-internal"
+}

Docker/liberate.sh

@@ -0,0 +1,174 @@
+#!/bin/bash
+
+error() {
+  log "ERROR" "$1"
+}
+
+warn() {
+  log "WARNING" "$1"
+}
+
+info() {
+  log "info" "$1"
+}
+
+debug() {
+  if [ "${LOG_LEVEL}" = "debug" ]; then
+    log "debug" "$1"
+  fi
+}
+
+log() {
+  LEVEL=$1
+  MESSAGE=$2
+  printf "$(date '+%F %T') %s: %s\n" "${LEVEL}" "${MESSAGE}"
+}
+
+init_config_file() {
+  FILE=$1
+  FULLPATH=${LIBATION_CONFIG_DIR}/${FILE}
+  if [ -f ${FULLPATH} ]; then
+    info "loading ${FILE}"
+    cp ${FULLPATH} ${LIBATION_CONFIG_INTERNAL}/
+    return 0
+  else
+    warn "${FULLPATH} not found, creating empty file"
+    echo "{}" > ${LIBATION_CONFIG_INTERNAL}/${FILE}
+    return 1
+  fi
+}
+
+update_settings() {
+  FILE=$1
+  KEY=$2
+  VALUE=$3
+  info "setting ${KEY} to ${VALUE}"
+  echo $(jq --arg k "${KEY}" --arg v "${VALUE}" '.[$k] = $v' ${LIBATION_CONFIG_INTERNAL}/${FILE}) > ${LIBATION_CONFIG_INTERNAL}/${FILE}.tmp
+  mv ${LIBATION_CONFIG_INTERNAL}/${FILE}.tmp ${LIBATION_CONFIG_INTERNAL}/${FILE}
+}
+
+is_mounted() {
+  DIR=$1
+  if grep -qs "${DIR} " /proc/mounts;
+  then
+    return 0
+  else
+    return 1
+  fi
+}
+
+create_db() {
+  DBFILE=$1
+  if [ -f "${DBFILE}" ]; then
+    warn "prexisting database found when creating"
+    return 0
+  else
+    if ! touch "${DBFILE}"; then
+      error "unable to create database, check permissions on host"
+      exit 1
+    fi
+    return 1
+  fi
+}
+
+setup_db() {
+  DBPATH=$1
+  dbpattern="*.db"
+
+  debug "using database directory ${DBPATH}"
+
+  # Figure out the right databse file
+  if [[ -z "${LIBATION_DB_FILE}" ]];
+  then
+    dbCount=$(find "${DBPATH}" -maxdepth 1 -type f -name "${dbpattern}" | wc -l)
+    if [ "${dbCount}" -gt 1 ];
+    then
+      error "too many database files found, set LIBATION_DB_FILE to the filename you wish to use"
+      exit 1
+    elif [ "${dbCount}" -eq 1 ];
+    then
+      files=( ${DBPATH}/${dbpattern} )
+      FILE=${files[0]}
+    else
+      FILE="${DBPATH}/LibationContext.db"
+    fi
+  else
+    FILE="${DBPATH}/${LIBATION_DB_FILE}"
+  fi
+
+  debug "planning to use database ${FILE}"
+
+  if [ -f "${FILE}" ]; then
+    info "database found at ${FILE}"
+  elif [ ${LIBATION_CREATE_DB} = "true" ];
+  then
+    warn "database not found, creating one at ${FILE}"
+    create_db ${FILE}
+  else
+    error "database not found and creation is disabled"
+    exit 1
+  fi
+  ln -s "${FILE}" "${LIBATION_CONFIG_INTERNAL}/LibationContext.db"
+}
+
+run() {
+  info "scanning accounts"
+  /libation/LibationCli scan
+  info "liberating books"
+  /libation/LibationCli liberate
+}
+
+main() {
+  info "initializing libation"
+  init_config_file AccountsSettings.json
+  init_config_file Settings.json
+  
+  info "loading settings"
+  update_settings Settings.json Books /data
+  update_settings Settings.json InProgress /tmp
+
+  info "loading database"
+  # If user provides a separate database mount, use that
+  if is_mounted "${LIBATION_DB_DIR}";
+  then
+    DB_LOCATION=${LIBATION_DB_DIR}
+  # Otherwise, use the config directory
+  else
+    DB_LOCATION=${LIBATION_CONFIG_DIR}
+  fi
+  setup_db ${DB_LOCATION}
+
+  # Try to warn if books dir wasn't mounted in
+  if ! is_mounted "${LIBATION_BOOKS_DIR}";
+  then
+    warn "${LIBATION_BOOKS_DIR} does not appear to be mounted, books will not be saved"
+  fi
+
+  # Let the user know what the run type will be
+  if [[ -z "${SLEEP_TIME}" ]]; then
+    SLEEP_TIME=-1
+  fi
+
+  if [ "${SLEEP_TIME}" == -1 ]; then
+    info "running once"
+  else
+    info "running every ${SLEEP_TIME}"
+  fi
+
+  # loop
+  while true
+  do
+    run
+    
+    # Liberate only once if SLEEP_TIME was set to -1
+    if [ "${SLEEP_TIME}" == -1 ]; then
+      break  
+    fi
+
+    sleep "${SLEEP_TIME}"
+  done
+
+  info "exiting"
+}
+
+main

Dockerfile

@@ -0,0 +1,39 @@
+# Dockerfile
+FROM --platform=${BUILDPLATFORM} mcr.microsoft.com/dotnet/sdk:9.0 AS build
+ARG TARGETARCH
+
+COPY Source /Source
+RUN dotnet publish \
+    /Source/LibationCli/LibationCli.csproj \
+    --arch ${TARGETARCH} \
+    --configuration Release \
+    --output /Source/bin/Publish/Linux-chardonnay \
+    -p:PublishProfile=/Source/LibationCli/Properties/PublishProfiles/LinuxProfile.pubxml
+
+FROM mcr.microsoft.com/dotnet/runtime:9.0
+ARG USER_UID=1001
+ARG USER_GID=1001
+
+# Set the character set that will be used for folder and filenames when liberating
+ENV LANG=C.UTF-8
+ENV LC_ALL=C.UTF-8
+
+ENV SLEEP_TIME=-1
+ENV LIBATION_CONFIG_INTERNAL=/config-internal
+ENV LIBATION_CONFIG_DIR=/config
+ENV LIBATION_DB_DIR=/db
+ENV LIBATION_DB_FILE=
+ENV LIBATION_CREATE_DB=true
+ENV LIBATION_BOOKS_DIR=/data
+
+
+RUN apt-get update && apt-get -y upgrade && \
+    apt-get install -y jq && \
+    mkdir -m777 ${LIBATION_CONFIG_INTERNAL} ${LIBATION_BOOKS_DIR}
+
+COPY --from=build /Source/bin/Publish/Linux-chardonnay /libation
+COPY Docker/* /libation
+
+USER ${USER_UID}:${USER_GID}
+
+CMD ["/libation/liberate.sh"]

Documentation/Advanced.md

@@ -0,0 +1,111 @@
+## [Download Libation](https://github.com/rmcrackan/Libation/releases/latest)
+
+### If you found this useful, tell a friend. If you found this REALLY useful, you can click here to [PayPal.me](https://paypal.me/mcrackan?locale.x=en_us)
+...or just tell more friends. As long as I'm maintaining this software, it will remain **free** and **open source**.
+
+
+
+# Advanced: Table of Contents
+
+- [Files and folders](#files-and-folders)
+- [Settings](#settings)
+- [Custom File Naming](NamingTemplates.md)
+- [Command Line Interface](#command-line-interface)
+- [Custom Theme Colors](#custom-theme-colors) (Chardonnay Only)
+
+
+
+### Files and folders
+
+To make upgrades and reinstalls easier, Libation separates all of its responsibilities to a few different folders. If you don't want to mess with this stuff: ignore it. Read on if you like a little more control over your files.
+
+* In Libation's initial folder are the files that make up the program. Since nothing else is here, just copy new files here to upgrade the program. Delete this folder to delete Libation.
+
+* In a separate folder, Libation keeps track of all of the files it creates like settings and downloaded images. After an upgrade, Libation might think that's its being run for the first time. Just click ADVANCED SETUP and point to this folder. Libation will reload your library and settings.
+
+* The last important folder is the "books location." This is where Libation looks for your downloaded and decrypted books. This is how it knows which books still need to be downloaded. The Audible id must be somewhere in the book's file or folder name for Libation to detect your downloaded book.
+
+### Settings
+
+* Allow Libation to fix up audiobook metadata. After decrypting a title, Libation attempts to fix details like chapters and cover art. Some power users and/or control freaks prefer to manage this themselves. By unchecking this setting, Libation will only decrypt the book and will leave metadata as-is, warts and all.
+
+In addition to the options that are enabled if you allow Libation to "fix up" the audiobook, it does the following:
+
+* Adds the `TCOM` (`@wrt` in M4B files) metadata tag for the narrators.
+* Sets the `©gen` metadata tag for the genres.
+* Unescapes the copyright symbol (replace `©` with `©`)
+* Replaces the recording copyright `(P)` string with `℗`
+* Replaces the chapter markers embedded in the aax file with the chapter markers retrieved from Audible's API.
+* Sets the embedded cover art image with the 500x500 px cover art retrieved from Audible
+
+### Command Line Interface
+
+Libationcli.exe allows limited access to Libation's functionalities as a CLI.
+
+Warnings about relying solely on on the CLI:
+* CLI will not perform any upgrades.
+* It will show that there is an upgrade, but that will likely scroll by too fast to notice.
+* It will not perform all post-upgrade migrations. Some migrations are only be possible by launching GUI.
+
+```
+help
+  libationcli --help
+  
+verb-specific help
+  libationcli scan --help
+  
+scan all libraries
+  libationcli scan
+scan only libraries for specific accounts
+  libationcli scan nickname1 nickname2
+  
+convert all m4b files to mp3
+  libationcli convert
+  
+liberate all books and pdfs
+  libationcli liberate
+liberate pdfs only
+  libationcli liberate --pdf
+  libationcli liberate -p
+  
+export library to file
+  libationcli export --path "C:\foo\bar\my.json" --json
+  libationcli export -p "C:\foo\bar\my.json" -j
+  libationcli export -p "C:\foo\bar\my.csv" --csv
+  libationcli export -p "C:\foo\bar\my.csv" -c
+  libationcli export -p "C:\foo\bar\my.xlsx" --xlsx
+  libationcli export -p "C:\foo\bar\my.xlsx" -x
+
+Set download statuses throughout library based on whether each book's audio file can be found.   
+Must include at least one flag: --downloaded , --not-downloaded.  
+Downloaded: If the audio file can be found, set download status to 'Downloaded'.  
+Not Downloaded: If the audio file cannot be found, set download status to 'Not Downloaded'  
+UI: Visible Books \> Set 'Downloaded' status automatically. Visible books. Prompts before saving changes  
+CLI: Full library. No prompt
+
+  libationcli set-status -d
+  libationcli set-status -n
+  libationcli set-status -d -n
+```
+### Custom Theme Colors
+
+In Libation Chardonnay (not Classic), you may adjust the app colors using the built-in theme editor. Open the Settings window (from the menu bar: Settings > Settings). On the "Important" settings tab, click "Edit Theme Colors".
+
+#### Theme Editor Window
+
+The theme editor has a list of style names and their currently assigned colors. To change a style color, click on the color swatch in the left-hand column to open the color editor for that style. Observe the color changes in real-time on the built-in preview panel on the right-hand side of the theme editor.
+
+You may import or export themes using the buttons at the bottom-left of the theme editor.
+"Cancel" or closing the window will revert any changes you've made in the theme editor.
+"Reset" will reset any changes you've made in the theme editor.
+"Defaults" will restore the application default colors for the active theme ("Light" or "Dark")
+"Save" will save the theme colors to the ChardonnayTheme.json file and close the editor.
+
+Note: you may only edit the currently applied theme ("Light" or "Dark").
+
+#### Video Walkthrough
+The below video demonstrates using the theme editor to make changes to the Dark theme color pallet.
+
+[](https://github.com/user-attachments/assets/05c0cb7f-578f-4465-9691-77d694111349)
+
+

Documentation/Docker.md

@@ -0,0 +1,76 @@
+## [Download Libation](https://github.com/rmcrackan/Libation/releases/latest)
+
+### If you found this useful, tell a friend. If you found this REALLY useful, you can click here to [PayPal.me](https://paypal.me/mcrackan?locale.x=en_us)
+...or just tell more friends. As long as I'm maintaining this software, it will remain **free** and **open source**.
+
+> [!WARNING]
+> ## Breaking Changes
+> * The docker image now runs as user 1001 and group 1001. Make sure that the permissions on your volumes allow user 1001 to read and write to them or see the User section below for other options, or if you're not sure.
+> * `SLEEP_TIME` is now set to `-1` by default. This means the image will run once and exit. If you were relying on the previous default, you'll need to explicitly set the `SLEEP_TIME` environment variable to `30m` to replicate the previous behavior.
+> * The docker image now ignores the values in `Settings.json` for `Books` and `InProgress`. You can now change the folder that books are saved to by using the `LIBATION_BOOKS_DIR` environment variable.
+
+# Disclaimer
+The docker image is provided as-is. We hope it can be useful to you but it is not officially supported.
+
+### Configuration
+Configuration in Libation is handled by two files, `AccountsSettings.json` and `Settings.json`. These files can usually be found in the Libation folder in your user's home directory. The easiest way to configure these is to run the desktop version of Libation and then copy them into a folder, such as `/opt/libation/config`, that you'll volume mount into the image. `Settings.json` is technically optional, and, if not provided, Libation will run using the default settings. Additionally, the `Books` and `InProgress` settings in `Settings.json` will be ignored and the image will instead substitute it's own values.
+
+### Running
+Once the configuration files are copied, the docker image can be run with the following command.
+```
+sudo docker run -d \
+  -v /opt/libation/config:/config \
+  -v /opt/libation/books:/data \
+  --name libation \
+  --restart=always \
+  rmcrackan/libation:latest
+```
+
+By default the container will scan for new books once and download any new ones. This is configurable by passing in a value for the `SLEEP_TIME` environment variable. For example, if you pass in `10m` it will keep running, scan for new books, and download them every 10 minutes.
+
+```
+sudo docker run -d \
+  -v /opt/libation/config:/config \
+  -v /opt/libation/books:/data \
+  -e SLEEP_TIME='10m' \
+  --name libation \
+  --restart=always \
+  rmcrackan/libation:latest
+```
+
+### Environment Variables
+| Env Var  | Default | Description |
+| -------- | ------- | ----------- |
+| SLEEP_TIME  | -1 | Length of time to sleep before doing another scan/download. Set to -1 to run one. |
+| LIBATION_BOOKS_DIR | /data | Folder where books will be saved |
+| LIBATION_CONFIG_DIR | /config | Folder to read configuration from. |
+| LIBATION_DB_DIR    | /db | Optional folder to load database from. If not mounted, will load database from `LIBATION_CONFIG_DIR`. |
+| LIBATION_DB_FILE | | Name of database file to load. By default it will look for all `.db` files and load one if there is only one present. |
+| LIBATION_CREATE_DB | true | Whether or not the image should create a database file if none are found. |
+
+### User
+This docker image runs as user `1001`. In order for the image to function properly, user `1001` must be able to read and write the volumes that are mounted in. If they are not, you will see errors, including [sqlite error](#1060), [Microsoft.Data.Sqlite.SqliteException](#1110), [unable to open database file](#1113), [Microsoft.EntityFrameworkCore.DbUpdateException](#1049)
+
+If you're not sure what your user number is, check the output of the `id` command. Docker should normally run with the number of the user who configured and ran it.
+
+If you want to change the user the image runs as, you can specify `-u <uid>:<gid>`. For example, to run it as user `2000` and group `3000`, you could do the following:
+
+```
+sudo docker run -d \
+  -u 2000:3000 \
+  -v /opt/libation/config:/config \
+  -v /opt/libation/books:/data \
+  --name libation \
+  --restart=always \
+  rmcrackan/libation:latest
+```
+
+If the user it's running as is correct, and it still cannot write, be sure to check whether the files and/or folders might be owned by the wrong user. You can use the `chown` command to change the owner of the file to the correct user and group number, for example: `chown -R 1001:1001 /mnt/audiobooks /mnt/libation-config`
+
+### Advanced Database Options
+The docker image supports an optional database mount location defined by `LIBATION_DB_DIR`. This allows the database to be mounted as read/write, while allowing the rest of the configuration files to be mounted as read only. This is specifically useful if running in Kubernetes where you can use Configmaps and Secrets to define the configuration. If the `LIBATION_DB_DIR` is mounted, it will be used, otherwise it will look for the database in `LIBATION_CONFIG_DIR`. If it does not find the database in the expected location, it will attempt to make an empty database there.
+
+### Getting help
+As mentioned above: docker is not officially supported. I'm adding this at the bottom of the page for anyone serious enough to have read this far. If you've tried everything above and would still like help, you can open an [issue](https://github.com/rmcrackan/Libation/issues). Please include `[docker]` in the title. There are also some docker folks who have offered occasional assistance who you can tag within your issue: `@ducamagnifico` , `@wtanksleyjr` , `@CLHatch`.
+
+**Reminder** that these are just friendly users who are sometimes around. They're *not* our customer support.

Documentation/FrequentlyAskedQuestions.md

@@ -0,0 +1,42 @@
+## [Download Libation](https://github.com/rmcrackan/Libation/releases/latest)
+
+### If you found this useful, tell a friend. If you found this REALLY useful, you can click here to [PayPal.me](https://paypal.me/mcrackan?locale.x=en_us)
+...or just tell more friends. As long as I'm maintaining this software, it will remain **free** and **open source**.
+
+
+
+# Frequently Asked Questions
+
+## Q: What's the difference between 'Classic' and 'Chardonnay'?
+
+**A:** First and most importantly: Classic and Chardonnay have the exact same features.
+
+* **Classic** is Windows only. Its older 'grey boxes' look has a compact design which allows for more information on the screen. Notably, Classic was written using an older, more mature technology which has built-in support for screenreaders.
+
+* **Chardonnay** is available for Windows, Mac, and Linux. Its modern design has a more open look and feel.
+
+## Q: Now that I've downloaded my books, how can I listen to them?
+
+**A:** You can use any app which plays m4b files (or mp3 files if you used that setting). Here are just a few ideas. Disclaimer: I have no affiliation with any of these companies:
+
+* iOS: [BookPlayer](https://apps.apple.com/us/app/bookplayer/id1138219998)
+* iOS: [Bound](https://apps.apple.com/us/app/bound-audiobook-player/id1041727137)
+* Android: [Smart AudioBook Player](https://play.google.com/store/apps/details?id=ak.alizandro.smartaudiobookplayer&hl=en_US&gl=US)
+* Android: [Listen](https://play.google.com/store/apps/details?id=ru.litres.android.audio&hl=en_US&gl=US)
+* Desktop: [VLC](https://www.videolan.org/)
+* Windows Desktop: [Audibly](https://github.com/rstewa/Audibly) -- a desktop player build specifically for audiobooks
+
+Self-hosting online:
+
+* [audiobookshelf](https://www.audiobookshelf.org). On [reddit](https://www.reddit.com/r/audiobookshelf/)
+* [plex](https://www.plex.tv/). Listen with [Prologue](https://prologue.audio/) (iOS)
+
+## Q: I'm having trouble loggin into my Brazil account.
+
+For reasons known only to Jeff Bezos and God, amazon and audible brazil handle logins slightly differently. The external browser login option is not possible for Brazil. [See this ticket for more details.](https://github.com/rmcrackan/Libation/issues/1103)
+
+## Q: How do I use Libation with a South Africa account?
+
+**A:** Like many countries, amazon gives South Africa it's own amazon site. [Unlike many other regions](https://www.audible.com/ep/country-selector) there is not South Africa specific audible site. Use `US` for your region -- ie: audible.com.
+
+(Not exactly a *frequently* asked question but it's come up more than once)

Documentation/GettingStarted.md

@@ -0,0 +1,150 @@
+## [Download Libation](https://github.com/rmcrackan/Libation/releases/latest)
+
+### If you found this useful, tell a friend. If you found this REALLY useful, you can click here to [PayPal.me](https://paypal.me/mcrackan?locale.x=en_us)
+...or just tell more friends. As long as I'm maintaining this software, it will remain **free** and **open source**.
+
+
+
+# Getting started: Table of Contents
+
+- [Download Libation](#download-libation-1)
+- [Installation](#installation)
+- [Create Accounts](#create-accounts)
+- [Import your library](#import-your-library)
+- [Download your books -- DRM-free!](#download-your-books----drm-free)
+- [Download PDF attachments](#download-pdf-attachments)
+- [Details of downloaded files](#details-of-downloaded-files)
+- [Export your library](#export-your-library)
+
+
+
+### [Download Libation](https://github.com/rmcrackan/Libation/releases)
+
+##### Which version? Chardonnay vs Classic
+
+Nearly 100% of the difference is look and feel -- it's a matter of preference.
+
+Chardonnay has an updated look and will work and look the same on Windows, Mac, and Linux.  
+Classic is Windows only. It has an older look because it's built with older, duller, and more mature technology. This tech has built into it better support for things like accessibility for screen readers.
+
+### Installation
+
+* Windows
+
+Extract the zip file to a folder and then run `Libation.exe` from inside of that folder. Do not put it in Program Files. The inability to edit files from there causes problems with configuration and updating.
+
+* [Linux](InstallOnLinux.md)
+* [MacOS](InstallOnMac.md)
+
+### Create Accounts
+
+Create your account(s):
+
+![Create your accounts, menu](images/v40_accounts.png)
+
+New locale options include many more regions including old audible accounts which pre-date the amazon acquisition
+
+![Choose your account locales](images/v40_locales.png)
+
+### Import your library
+
+Be default, Libation will periodically scan the accounts you added above with a checkbox next to them. Nothing for you to do. You can also scan manually.
+
+Select Import > Scan Library:
+
+![Import step 1](images/Import1.png)
+
+Or if you have multiple accounts, you'll get to choose whether to scan all accounts or just the ones you select:
+
+![Import which accounts](images/v40_import.png)
+
+If this is a new installation, or you're scanning an account you haven't scanned before, you'll be prompted to enter your password for the Audible account.
+
+![Login password](images/alt-login1.png)
+
+Enter the password and click Submit. Audible will prompt you with a CAPTCHA image. 
+
+![Login captcha](images/alt-login2.png)
+
+Enter the CAPTCHA answer characters and click Submit. If all has gone well, Libation will start scanning the account. 
+
+In rare instances, the Captcha image/response will fail in an endless loop. If this happens, delete the problem account, and then click Save. Re-add the account and click Save again. Now try to scan the account again. This time, instead of typing your password, click the link that says "Or click here". This will open the Audible External Login dialog shown below.
+
+![Login alternative setup](images/alt-login3.png)
+
+You can either copy the URL shown and paste it into your browser or launch the browser directly by clicking Launch in Browser. Audible will display its standard login page. Login, including answering the CAPTCHA on the next page. In some cases, you might have to approve the login from the email account associated with that login, but once the login is successful, you'll see an error message.
+
+![Login alternative login result](images/alt-login4.png)
+
+This actually means you've successfully logged in. Copy the entire URL shown in your browser and return to Libation. Paste that URL into the text box at the bottom of the Audible External Login window and click Submit.
+
+You'll see this window while it's scanning:
+
+![Import step 2](images/Import2.png)
+
+Success! We see how many new titles are imported:
+
+![Import step 3](images/Import3.png)
+
+### Download your books -- DRM-free!
+
+Automatically download some or all of your audible books. This shows you how much of your library is not yet downloaded and decrypted:
+
+The stoplights will tell you a title's status:
+
+* Green: downloaded and decrypted
+* Yellow: downloaded but still encrypted with DRM
+* Red: not downloaded
+* PDF icon without arrow: downloaded
+* PDF with arrow: not downloaded
+
+Or hover over the button to see the status.
+
+![Liberate book step 1](images/LiberateBook1.png)
+
+Select Liberate > Begin Book Backups
+
+You can also click on the stop light to download only that title and its PDF
+
+![Liberate book step 2](images/LiberateBook2.png)
+
+First the original book with DRM is downloaded
+
+![Liberate book step 3](images/LiberateBook3.png)
+
+Then it's decrypted so you can use it on any device you choose. The very first time you decrypt a book, this step will take a while. Every other book will go much faster. The first time, Libation has to figure out the special decryption key which allows your personal books to be unlocked.
+
+![Liberate book step 4](images/LiberateBook4.png)
+
+And voila! If you have multiple books not yet liberated, Libation will automatically move on to the next.
+
+![Liberate book step 5](images/LiberateBook5.png)
+
+The Audible id must be somewhere in the book's file or folder name for Libation to detect your downloaded book.
+
+### Download PDF attachments
+
+For books which include PDF downloads, Libation can download these for you as well and will attempt to store them with the book. "Book backup" will already download an available PDF. This additional option is useful when Audible adds a PDF to your book after you've already backed it up.
+
+Select Liberate > Begin PDF Backups
+
+![PDF download step 2](images/PdfDownload2.png)
+
+The downloads work just like with books, only with no additional decryption needed.
+
+![PDF download step 3](images/PdfDownload3.png)
+
+### Details of downloaded files
+
+![Post download](images/PostDownload.png)
+
+When you set up Libation, you'll specify a Books directory. Libation looks inside that directory and all subdirectories to look for files or folders with each library book's audible id. This way, organization is completely up to you. When you download + decrypt a book, you get several files
+
+* .m4b: your audiobook in m4b format. This is the most pure version of your audiobook and retains the highest quality. Now that it's decrypted, you can play it on any audio player and put it on any device. If you'd like, you can also use 3rd party tools to turn it into an mp3. The freedom to do what you want with your files was the original inspiration for Libation.
+* .cue: this is a file which logs where chapter breaks occur. Many tools are able to use this if you want to split your book into files along chapter lines.
+
+### Export your library
+
+![Export](images/Export.png)
+
+Export your library to Excel, CSV, or JSON

Documentation/InstallOnLinux.md

@@ -0,0 +1,67 @@
+## [Download Libation](https://github.com/rmcrackan/Libation/releases/latest)
+
+### If you found this useful, tell a friend. If you found this REALLY useful, you can click here to [PayPal.me](https://paypal.me/mcrackan?locale.x=en_us)
+...or just tell more friends. As long as I'm maintaining this software, it will remain **free** and **open source**.
+
+
+## Packaging status
+
+[![Packaging status](https://repology.org/badge/vertical-allrepos/libation.svg)](https://repology.org/project/libation/versions)
+
+New Libation releases are automatically packed into `.deb` and `.rpm` package and are available from the Libation repository's releases page.
+
+Run this command in your terminal to download and install Libation, replacing the url with the latest Libation package url:
+
+### Debian
+  ```Console
+  wget -O libation.deb https://github.com/rmcrackan/Libation/releases/download/vX.X.X/Libation.X.X.X-linux-chardonnay.deb &&
+  sudo apt install ./libation.deb
+  ```
+### Redhat and CentOS
+  ```Console
+  wget -O libation.rpm https://github.com/rmcrackan/Libation/releases/download/vX.X.X/Libation.X.X.X-linux-chardonnay.rpm &&
+  sudo yum install ./libation.rpm
+  ```
+### Fedora
+  ```Console
+  wget -O libation.rpm https://github.com/rmcrackan/Libation/releases/download/vX.X.X/Libation.X.X.X-linux-chardonnay.rpm &&
+  sudo dnf5 install ./libation.rpm
+  ```
+---
+### Arch Linux
+  ```Console
+  yay -S libation
+  ```
+  This package is available on [Arch User Repository](https://aur.archlinux.org/packages/libation), install via your choice of [AUR helpers](https://wiki.archlinux.org/title/AUR_helpers).
+  
+  Thanks to [mhdi](https://aur.archlinux.org/account/mhdi) for taking care of AUR package maintenance.
+### NixOS
+  - Install via `nix-shell`
+    ```Console
+    nix-shell -p libation
+    ```
+    A `nix-shell` will temporarily modify your $PATH environment variable. This can be used to try a piece of software before deciding to permanently install it.
+  - Install via NixOS configuration
+    ```Console
+    environment.systemPackages = [
+      pkgs.libation
+    ];
+    ```
+    Add the following Nix code to your NixOS Configuration, usually located in `/etc/nixos/configuration.nix`
+  - On NixOS via via `nix-env`
+    ```Console
+    nix-env -iA nixos.libation
+    ```
+  - On Non NixOS via `nix-env`
+    ```Console
+    nix-env -iA nixpkgs.libation
+    ```
+    Warning: Using `nix-env` permanently modifies a local profile of installed packages. This must be updated and maintained by the user in the same way as with a traditional package manager.
+
+    Thanks to [TomaSajt](https://github.com/tomasajt) for taking care of Nix package maintenance.
+
+If your desktop uses gtk, you should now see Libation among your applications.
+
+Additionally, you may launch Libation, LibationCli, and Hangover (the Libation recovery app) via the command line using 'libation, libationcli', and 'hangover' aliases respectively.
+
+Report bugs to https://github.com/rmcrackan/Libation/issues

Documentation/InstallOnMac.md

@@ -0,0 +1,82 @@
+## [Download Libation](https://github.com/rmcrackan/Libation/releases/latest)
+
+### If you found this useful, tell a friend. If you found this REALLY useful, you can click here to [PayPal.me](https://paypal.me/mcrackan?locale.x=en_us)
+...or just tell more friends. As long as I'm maintaining this software, it will remain **free** and **open source**.
+
+
+
+# Run Libation on MacOS
+This walkthrough should get you up and running with Libation on your Mac.
+
+## Supports macOS 13 (Ventura) and above
+
+## Install Libation
+
+- Download the file from the latest release and extract it.
+  - Apple Silicon (M1, M2, ...): `Libation.x.x.x-macOS-chardonnay-`**arm64**`.tgz`
+  - Intel: `Libation.x.x.x-macOS-chardonnay-`**x64**`.tgz`
+- Move the extracted Libation app bundle to your applications folder.
+- Right-click on Libation and then click on open
+- The first time, it will not immediately show you an option to open it. Just dismiss the dialog and do the same thing again (right-click -> open) then you will get an option to run the unsigned application. This takes about 10 seconds.
+
+## If this doesn't work
+
+You can add Libation as a safe app without touching Gatekeeper.
+
+- Copy/paste/run the following command. Adjust the file path to the Libation.app on your computer if necessary.
+
+  ```Console
+  xattr -r -d com.apple.quarantine ~/Downloads/Libation.app
+  ```
+- Close the terminal and use Libation!
+
+## If this still doesn't work
+
+- Copy/paste/run the following command (you'll be prompted to enter your Mac password)
+
+  ```Console
+  sudo spctl --master-disable && sudo spctl --add --label "Libation" /Applications/Libation.app && open /Applications/Libation.app && sudo spctl --master-enable
+  ```
+
+* Close the terminal and use Libation!
+
+## "Apple can't check app for malicious software"
+
+From: [How to Open Anyway](https://support.apple.com/guide/mac-help/apple-cant-check-app-for-malicious-software-mchleab3a043/mac):
+
+* On your Mac, choose Apple menu > System Settings, then click Privacy & Security in the sidebar. (You may need to scroll down.)
+* Go to Security, then click Open.
+* Click Open Anyway. This button is available for about an hour after you try to open the app.
+* Enter your login password, then click OK.
+
+## Troubleshooting
+
+If Libation fails to start after completing the above steps, try the following:
+
+1. Right-click the Libation app in your applications folder and select _Show Package Contents_
+2. Open the `Contents` folder and then the `MacOS` folder.
+3. Find the file named `Libation`, right-click it, and then select _Open_.
+
+Libation _should_ launch, and you should now be able to open Libation by just double-clicking the app bundle in your applications folder.
+
+
+## Running Hangover
+
+Libation comes with a recovery app called Hangover. You can start it by running this command:
+```Console
+open /Applications/Libation.app --args hangover
+```
+
+## Running LibationCli
+
+Libation comes with a command-line interface. Unfortunately, due to the way apps are sandboxed on mac, its use is somewhat limited. To open a new sandboxed terminal in LibationCli's directory, run the following command:
+```Console
+open /Applications/Libation.app --args cli
+```
+To use LibationCli from an unsandboxed terminal, you must disable gatekeeper again and run the program directly at `/Applications/Libation.app/Contents/MacOS/LibationCli`
+
+Then use `./LibationCli` to execute a command.
+
+## Get Libation running on Mac
+
+[Run Libation on MacOS](https://user-images.githubusercontent.com/37587114/219271379-a922e4e1-48a0-48e4-bd81-48aa1226a4f5.mp4)

Documentation/NamingTemplates.md

@@ -0,0 +1,153 @@
+## [Download Libation](https://github.com/rmcrackan/Libation/releases/latest)
+
+### If you found this useful, tell a friend. If you found this REALLY useful, you can click here to [PayPal.me](https://paypal.me/mcrackan?locale.x=en_us)
+...or just tell more friends. As long as I'm maintaining this software, it will remain **free** and **open source**.
+
+
+
+# Naming Templates
+File and Folder names can be customized using Libation's built-in tag template naming engine. To edit how folder and file names are created, go to Settings \> Download/Decrypt and edit the naming templates. If you're splitting your audiobook into multiple files by chapter, you can also use a custom template to set each chapter's title metadata tag by editing the template in Settings \> Audio File Options.
+
+These templates apply to both GUI and CLI.
+
+# Table of Contents
+
+- [Template Tags](#template-tags)
+  - [Property Tags](#property-tags)
+  - [Conditional Tags](#conditional-tags)
+- [Tag Formatters](#tag-formatters)
+  - [Text Formatters](#text-formatters)
+  - [Series Formatters](#series-formatters)
+  - [Series List Formatters](#series-list-formatters)
+  - [Name Formatters](#name-formatters)
+  - [Name List Formatters](#name-list-formatters)
+  - [Number Formatters](#number-formatters)
+  - [Date Formatters](#date-formatters)
+
+
+# Template Tags
+
+These are the naming template tags currently supported by Libation.
+
+## Property Tags
+These tags will be replaced in the template with the audiobook's values.
+
+|Tag|Description|Type|
+|-|-|-|
+|\<id\> **†**|Audible book ID (ASIN)|Text|
+|\<title\>|Full title with subtitle|[Text](#text-formatters)|
+|\<title short\>|Title. Stop at first colon|[Text](#text-formatters)|
+|\<audible title\>|Audible's title (does not include subtitle)|[Text](#text-formatters)|
+|\<audible subtitle\>|Audible's subtitle|[Text](#text-formatters)|
+|\<author\>|Author(s)|[Name List](#name-list-formatters)|
+|\<first author\>|First author|[Name](#name-formatters)|
+|\<narrator\>|Narrator(s)|[Name List](#name-list-formatters)|
+|\<first narrator\>|First narrator|[Name](#name-formatters)|
+|\<series\>|All series to which the book belongs (if any)|[Series List](#series-list-formatters)|
+|\<first series\>|First series|[Series](#series-formatters)|
+|\<series#\>|Number order in series (alias for \<first series[{#}]\>|[Number](#number-formatters)|
+|\<bitrate\>|File's original bitrate (Kbps)|[Number](#number-formatters)|
+|\<samplerate\>|File's original audio sample rate|[Number](#number-formatters)|
+|\<channels\>|Number of audio channels|[Number](#number-formatters)|
+|\<account\>|Audible account of this book|[Text](#text-formatters)|
+|\<account nickname\>|Audible account nickname of this book|[Text](#text-formatters)|
+|\<locale\>|Region/country|[Text](#text-formatters)|
+|\<year\>|Year published|[Number](#number-formatters)|
+|\<language\>|Book's language|[Text](#text-formatters)|
+|\<language short\> **†**|Book's language abbreviated. Eg: ENG|Text|
+|\<file date\>|File creation date/time.|[DateTime](#date-formatters)|
+|\<pub date\>|Audiobook publication date|[DateTime](#date-formatters)|
+|\<date added\>|Date the book added to your Audible account|[DateTime](#date-formatters)|
+|\<ch count\> **‡**|Number of chapters|[Number](#number-formatters)|
+|\<ch title\> **‡**|Chapter title|[Text](#text-formatters)|
+|\<ch#\> **‡**|Chapter number|[Number](#number-formatters)|
+|\<ch# 0\> **‡**|Chapter number with leading zeros|[Number](#number-formatters)|
+
+**†** Does not support custom formatting
+
+**‡** Only valid for Chapter Filename and Chapter Tile Metadata
+
+To change how these properties are displayed, [read about custom formatters](#tag-formatters)
+
+## Conditional Tags
+Anything between the opening tag (`<tagname->`) and closing tag (`<-tagname>`) will only appear in the name if the condition evaluates to true. 
+
+|Tag|Description|Type|
+|-|-|-|
+|\<if series-\>...\<-if series\>|Only include if part of a book series or podcast|Conditional|
+|\<if podcast-\>...\<-if podcast\>|Only include if part of a podcast|Conditional|
+|\<if bookseries-\>...\<-if bookseries\>|Only include if part of a book series|Conditional|
+|\<if podcastparent-\>...\<-if podcastparent\>**†**|Only include if item is a podcast series parent|Conditional|
+
+**†** Only affects the podcast series folder naming if "Save all podcast episodes to the series parent folder" option is checked.
+
+For example, <if podcast-\>\<series\>\<-if podcast\> will evaluate to the podcast's series name if the file is a podcast. For audiobooks that are not podcasts, that tag will be blank.
+
+You can invert the condition (instead of displaying the text when the condition is true, display the text when it is false) by playing a '!' symbol before the opening tag name.
+
+As an example, this folder template will place all Liberated podcasts into a "Podcasts" folder and all liberated books (not podcasts) into a "Books" folder.
+
+\<if podcast-\>Podcasts<-if podcast\>\<!if podcast-\>Books\<-if podcast\>\\\<title\>
+
+
+# Tag Formatters
+**Text**, **Name List**, **Number**, and **DateTime** tags can be optionally formatted using format text in square brackets after the tag name. Below is a list of supported formatters for each tag type.
+
+## Text Formatters
+|Formatter|Description|Example Usage|Example Result|
+|-|-|-|-|
+|L|Converts text to lowercase|\<title[L]\>|a study in scarlet꞉ a sherlock holmes novel|
+|U|Converts text to uppercase|\<title short[U]\>|A STUDY IN SCARLET|
+
+## Series Formatters
+|Formatter|Description|Example Usage|Example Result|
+|-|-|-|-|
+|\{N \| # \| ID\}|Formats the series using<br>the series part tags.<br>\{N\} = Series Name<br>\{#\} = Number order in series<br>\{ID\} = Audible Series ID<br><br>Default is \{N\}|`<first series>`<hr>`<first series[{N}]>`<hr>`<first series[{N}, {#}, {ID}]>`|Sherlock Holmes<hr>Sherlock Holmes<hr>Sherlock Holmes, 1, B08376S3R2|
+
+## Series List Formatters
+|Formatter|Description|Example Usage|Example Result|
+|-|-|-|-|
+|separator()|Speficy the text used to join<br>multiple series names.<br><br>Default is ", "|`<series[separator(; )]>`|Sherlock Holmes; Some Other Series|
+|format(\{N \| # \| ID\})|Formats the series properties<br>using the name series tags.<br>See [Series Formatter Usage](#series-formatters) above.|`<series[format({N}, {#})`<br>`separator(; )]>`<hr>`<author[format({L}, {ID}) separator(; )]>`|Sherlock Holmes, 1; Some Other Series, 1<hr>herlock Holmes, B08376S3R2; Some Other Series, B000000000|
+|max(#)|Only use the first # of series<br><br>Default is all series|`<series[max(1)]>`|Sherlock Holmes|
+
+## Name Formatters
+|Formatter|Description|Example Usage|Example Result|
+|-|-|-|-|
+|\{T \| F \| M \| L \| S \| ID\}|Formats the human name using<br>the name part tags.<br>\{T\} = Title (e.g. "Dr.")<br>\{F\} = First name<br>\{M\} = Middle name<br>\{L\} = Last Name<br>\{S\} = Suffix (e.g. "PhD")<br>\{ID\} = Audible Contributor ID<br><br>Default is \{P\} \{F\} \{M\} \{L\} \{S\}|`<first narrator[{L}, {F}]>`<hr>`<first author[{L}, {F} _{ID}_]>`|Fry, Stephen<hr>Doyle, Arthur \_B000AQ43GQ\_;<br>Fry, Stephen \_B000APAGVS\_|
+
+## Name List Formatters
+|Formatter|Description|Example Usage|Example Result|
+|-|-|-|-|
+|separator()|Speficy the text used to join<br>multiple people's names.<br><br>Default is ", "|`<author[separator(; )]>`|Arthur Conan Doyle; Stephen Fry|
+|format(\{T \| F \| M \| L \| S \| ID\})|Formats the human name using<br>the name part tags.<br>See [Name Formatter Usage](#name-formatters) above.|`<author[format({L}, {F})`<br>`separator(; )]>`<hr>`<author[format({L}, {F}`<br>`_{ID}_) separator(; )]>`|Doyle, Arthur; Fry, Stephen<hr>Doyle, Arthur \_B000AQ43GQ\_;<br>Fry, Stephen \_B000APAGVS\_|
+|sort(F \| M \| L)|Sorts the names by first, middle,<br>or last name<br><br>Default is unsorted|`<author[sort(M)]>`|Stephen Fry, Arthur Conan Doyle|
+|max(#)|Only use the first # of names<br><br>Default is all names|`<author[max(1)]>`|Arthur Conan Doyle|
+
+## Number Formatters
+For more custom formatters and examples, [see this guide from Microsoft](https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-numeric-format-strings).
+|Formatter|Description|Example Usage|Example Result|
+|-|-|-|-|
+|\[integer\]|Zero-pads the number|\<bitrate\[4\]\><br>\<series#\[3\]\><br>\<samplerate\[6\]\>|0128<br>001<br>044100|
+|0|Replaces the zero with the corresponding digit if one<br>is present; otherwise, zero appears in the result string.|\<series#\[000.0\]\>|001.0|
+|#|Replaces the "#" symbol with the corresponding digit if one<br> is present; otherwise, no digit appears in the result string|\<series#\[00.##\]\>|01|
+
+## Date Formatters
+Form more standard formatters, [see this guide from Microsoft](https://learn.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings).
+### Standard DateTime Formatters
+|Formatter|Description|Example Usage|Example Result|
+|-|-|-|-|
+|s|Sortable date/time pattern.|\<file date[s]\>|2023-02-14T13:45:30|
+|Y|Year month pattern.|\<file date[Y]\>|February 2023|
+
+### Custom DateTime Formatters
+You can use custom formatters to construct customized DateTime string. For more custom formatters and examples, [see this guide from Microsoft](https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings).
+|Formatter|Description|Example Usage|Example Result|
+|-|-|-|-|
+|yyyy|4-digit year|\<file date[yyyy]\>|2023|
+|yy|2-digit year|\<file date[yy]\>|23|
+|MM|2-digit month|\<file date[MM]\>|02|
+|dd|2-digit day of the month|\<file date[yyyy-MM-dd]\>|2023-02-14|
+|HH<br>mm|The hour, using a 24-hour clock from 00 to 23<br>The minute, from 00 through 59.|\<file date[HH:mm]\>|14:45|
+
+

Documentation/SearchingAndFiltering.md

@@ -0,0 +1,79 @@
+## [Download Libation](https://github.com/rmcrackan/Libation/releases/latest)
+
+### If you found this useful, tell a friend. If you found this REALLY useful, you can click here to [PayPal.me](https://paypal.me/mcrackan?locale.x=en_us)
+...or just tell more friends. As long as I'm maintaining this software, it will remain **free** and **open source**.
+
+
+
+# Searching and filtering: Table of Contents
+
+- [Tags](#tags)
+- [Searches](#searches)
+- [Search examples](#search-examples)
+- [Filters](#filters)
+
+
+
+### Tags
+
+To add tags to a title, click the tags button
+
+![Tags step 1](images/Tags1.png)
+
+Add as many tags as you'd like. Tags are separated by a space. Each tag can contain letters, numbers, and underscores
+
+![Tags step 2](images/Tags2.png)
+
+Tags are saved non-case specific for easy search. There is one special tag "hidden" which will also grey-out the book
+
+![Tags step 3](images/Tags3.png)
+
+To edit tags, just click the button again.
+
+### Searches
+
+Libation's advanced searching is built on the powerful Lucene search engine. Simple searches are effortless and powerful searches are simple. To search, just type and click Filter or press enter
+
+* Type anything in the search box to search common fields: title, authors, narrators, and the book's audible id
+* Use Lucene's "Query Parser Syntax" for advanced searching.
+    * Easy tutorial: http://www.lucenetutorial.com/lucene-query-syntax.html
+    * Full official guide: https://lucene.apache.org/core/2_9_4/queryparsersyntax.html
+* Tons of search fields, specific to audiobooks
+* Synonyms so you don't have to memorize magic words. Eg: author and author**s** will both work
+* Click [?] button for a full list of search fields and synonyms ![Filter options](images/FilterOptionsButton.png)
+* Search by tag like \[this\]
+* When tags have an underscore you can use part of the tag. This is useful for quick categories. The below examples make this more clear.
+
+### Search examples
+
+Search for anything with the word potter
+
+![Search example: potter](images/SearchExamplePotter.png)
+
+If you only want to see Harry Potter
+
+![Search example: "harry potter"](images/SearchExampleHarryPotter.png)
+
+If you only want to see potter except for Harry Potter. You can also use "-" instead of "NOT"
+
+![Search example: "potter NOT harry"](images/SearchExamplePotterNotHarry.png)
+![Search example: "potter -harry"](images/SearchExamplePotterNotHarry2.png)
+
+To see only books written by Neil Gaiman where he also narrates his own book. (If you don't include AND, you'll see everything written by Neil Gaiman and also all books in your library which are self-narrated.)
+
+![Search example: author:gaiman AND authornarrated](images/SearchExampleGaimanAuthorNarrated.png)
+
+I tagged autobiographies as auto_bio and biographies written by someone else as bio. I can get only autobiographies with \[auto_bio\] or get both by searching \[bio\]
+
+![Search example: \[bio\]](images/SearchExampleBio.png)
+![Search example: \[auto_bio\]](images/SearchExampleAutoBio.png)
+
+### Filters
+
+If you have a search you want to save, click Add To Quick Filters to save it in your Quick Filters list. To use it again, select it from the Quick Filters list.
+
+To edit this list go to Quick Filters > Edit quick filters. Here you can re-order the list, delete filters, double-click a filter to edit it, or double-click the bottom blank box to add a new filter.
+
+Check "Quick Filters > Start Libation with 1st filter Default" to have your top filter automatically applied when Libation starts. In this top example, I want to always start without these: at books I've tagged hidden, books I've tagged as free_audible_originals, and books which I have rated.
+
+![default filters](images/FiltersDefault.png)