From e922b89e36bcb7976d8770b9bdc7c222ed21b4c4 Mon Sep 17 00:00:00 2001
From: Andrey Semashev <andrey.semashev@gmail.com>
Date: Wed, 25 Sep 2024 02:37:00 +0300
Subject: [PATCH] Fix doxygen_xml2qbk execution from make_qbk.py.

When b2 invokes doc/make_qbk.py, it passes a relative path to the compiled
doxygen_xml2qbk executable. This path becomes invalid if used from a directory
different from doc, which may happen as make_qbk.py changes the current
directory during its execution. Additionally, doc/index/make_qbk.py invokes
doxygen_xml2qbk unqualified, which requires the executable to be in PATH and
is never the case unless the user has pre-compiled and placed it accordingly.

To fix this, first resolve the paths to doxygen and doxygen_xml2qbk to absolute
paths before changing the current directory. Additionally, pass the resolved
path to doxygen_xml2qbk to doc/index/make_qbk.py via the DOXYGEN_XML2QBK
environment variable.

Fixes https://github.com/boostorg/geometry/issues/1311.
---
 doc/index/make_qbk.py | 19 ++++++++++++++++++-
 doc/make_qbk.py       | 16 ++++++++++++++--
 2 files changed, 32 insertions(+), 3 deletions(-)

diff --git a/doc/index/make_qbk.py b/doc/index/make_qbk.py
index cb99c495df..4a8721d4dc 100755
--- a/doc/index/make_qbk.py
+++ b/doc/index/make_qbk.py
@@ -15,7 +15,24 @@
 
 import os, sys, shutil
 
-cmd = "doxygen_xml2qbk"
+# Resolves the path to an executable and returns an absolute path to it
+def resolve_executable(orig_path):
+    resolved_path = shutil.which(orig_path)
+    if resolved_path is None:
+        raise Exception("%s is not found or not executable" % orig_path)
+    return os.path.abspath(resolved_path)
+
+if 'DOXYGEN_XML2QBK' in os.environ:
+    doxygen_xml2qbk_cmd = os.environ['DOXYGEN_XML2QBK']
+elif '--doxygen-xml2qbk' in sys.argv:
+    doxygen_xml2qbk_cmd = sys.argv[sys.argv.index('--doxygen-xml2qbk')+1]
+else:
+    doxygen_xml2qbk_cmd = 'doxygen_xml2qbk'
+doxygen_xml2qbk_cmd = resolve_executable(doxygen_xml2qbk_cmd)
+os.environ['DOXYGEN_XML2QBK'] = doxygen_xml2qbk_cmd
+doxygen_xml2qbk_cmd = '"' + doxygen_xml2qbk_cmd + '"'
+
+cmd = doxygen_xml2qbk_cmd
 cmd = cmd + " --xml xml/%s.xml"
 cmd = cmd + " --start_include boost/"
 cmd = cmd + " --output_style alt"
diff --git a/doc/make_qbk.py b/doc/make_qbk.py
index 610bcee423..e4df3b19bc 100755
--- a/doc/make_qbk.py
+++ b/doc/make_qbk.py
@@ -20,10 +20,21 @@
 os.chdir(os.path.abspath(script_dir))
 print("Boost.Geometry is making .qbk files in %s" % os.getcwd())
 
+# Resolves the path to an executable and returns an absolute path to it
+def resolve_executable(orig_path):
+    resolved_path = shutil.which(orig_path)
+    if resolved_path is None:
+        raise Exception("%s is not found or not executable" % orig_path)
+    return os.path.abspath(resolved_path)
+
+# Resolve paths to executables early so that commands are executable from arbitrary locations
 if 'DOXYGEN' in os.environ:
     doxygen_cmd = os.environ['DOXYGEN']
 else:
     doxygen_cmd = 'doxygen'
+doxygen_cmd = resolve_executable(doxygen_cmd)
+os.environ['DOXYGEN'] = doxygen_cmd
+doxygen_cmd = '"' + doxygen_cmd + '"'
 
 if 'DOXYGEN_XML2QBK' in os.environ:
     doxygen_xml2qbk_cmd = os.environ['DOXYGEN_XML2QBK']
@@ -31,8 +42,9 @@
     doxygen_xml2qbk_cmd = sys.argv[sys.argv.index('--doxygen-xml2qbk')+1]
 else:
     doxygen_xml2qbk_cmd = 'doxygen_xml2qbk'
-os.environ['PATH'] = os.environ['PATH']+os.pathsep+os.path.dirname(doxygen_xml2qbk_cmd)
-doxygen_xml2qbk_cmd = os.path.basename(doxygen_xml2qbk_cmd)
+doxygen_xml2qbk_cmd = resolve_executable(doxygen_xml2qbk_cmd)
+os.environ['DOXYGEN_XML2QBK'] = doxygen_xml2qbk_cmd
+doxygen_xml2qbk_cmd = '"' + doxygen_xml2qbk_cmd + '"'
 
 cmd = doxygen_xml2qbk_cmd
 cmd = cmd + " --xml doxy/doxygen_output/xml/%s.xml"