From f20254217f7e6bb88750de0eaee9e75faf040551 Mon Sep 17 00:00:00 2001
From: ziprandom <ziprandom@gmail.com>
Date: Wed, 22 Jun 2022 13:58:50 +0000
Subject: [PATCH] POST_CONSUME_SCRIPT: add documents archive_path

---
 docs/advanced_usage.rst             | 1 +
 scripts/post-consumption-example.sh | 1 +
 src/documents/consumer.py           | 1 +
 3 files changed, 3 insertions(+)

diff --git a/docs/advanced_usage.rst b/docs/advanced_usage.rst
index d32d633b9..ba5b3cbaa 100644
--- a/docs/advanced_usage.rst
+++ b/docs/advanced_usage.rst
@@ -165,6 +165,7 @@ into paperless. It receives the following environment variables:
 * ``DOCUMENT_MODIFIED``
 * ``DOCUMENT_ADDED``
 * ``DOCUMENT_SOURCE_PATH``
+* ``DOCUMENT_ARCHIVE_PATH``
 * ``DOCUMENT_THUMBNAIL_PATH``
 * ``DOCUMENT_DOWNLOAD_URL``
 * ``DOCUMENT_THUMBNAIL_URL``
diff --git a/scripts/post-consumption-example.sh b/scripts/post-consumption-example.sh
index 81bfa3d48..6e42b1bc3 100755
--- a/scripts/post-consumption-example.sh
+++ b/scripts/post-consumption-example.sh
@@ -6,6 +6,7 @@ A document with an id of ${DOCUMENT_ID} was just consumed.  I know the
 following additional information about it:
 
 * Generated File Name: ${DOCUMENT_FILE_NAME}
+* Archive Path: ${DOCUMENT_ARCHIVE_PATH}
 * Source Path: ${DOCUMENT_SOURCE_PATH}
 * Created: ${DOCUMENT_CREATED}
 * Added: ${DOCUMENT_ADDED}
diff --git a/src/documents/consumer.py b/src/documents/consumer.py
index 474f9df8a..5673d159a 100644
--- a/src/documents/consumer.py
+++ b/src/documents/consumer.py
@@ -170,6 +170,7 @@ class Consumer(LoggingMixin):
         script_env["DOCUMENT_ADDED"] = str(document.added)
         script_env["DOCUMENT_FILE_NAME"] = document.get_public_filename()
         script_env["DOCUMENT_SOURCE_PATH"] = os.path.normpath(document.source_path)
+        script_env["DOCUMENT_ARCHIVE_PATH"] = os.path.normpath(str(document.archive_path))
         script_env["DOCUMENT_THUMBNAIL_PATH"] = os.path.normpath(
             document.thumbnail_path
         )