Merge pull request #1 from Rodelph/feature/combine_final_applications

Feature/combine final applications

Author: N.A

.DS_Store

@@ -1,2 +1,2 @@
-PdfGenerator/dist/* filter=lfs diff=lfs merge=lfs -text
-PdfGenerator/wkhtmltopdf/* filter=lfs diff=lfs merge=lfs -text
+ARchivist_document_generator/dist/* filter=lfs diff=lfs merge=lfs -text
+ARchivist_document_generator/wkhtmltopdf/* filter=lfs diff=lfs merge=lfs -text

.gitattributes

@@ -10,16 +10,16 @@
 /[Ll]ogs/
 /[Uu]ser[Ss]ettings/
 
-/PdfGenerator/__pycache__/
-/PdfGenerator/build/
-/PdfGenerator/dist/
-/PdfGenerator/access.txt
-/PdfGenerator/*.spec
-/PdfGenerator/*.zip
-/PdfGenerator/_ARMarker/*
-!/PdfGenerator/_ARMarker/Markers
-/PdfGenerator/_ARMarker/Markers/*.meta
-/PdfGenerator/_ARMarker/Markers/*.asset
+/ARchivist_document_generator/__pycache__/
+/ARchivist_document_generator/build/
+/ARchivist_document_generator/dist/
+/ARchivist_document_generator/access.txt
+/ARchivist_document_generator/*.spec
+/ARchivist_document_generator/*.zip
+/ARchivist_document_generator/_ARMarker/*
+!ARchivist_document_generatorr/_ARMarker/Markers
+/ARchivist_document_generator/_ARMarker/Markers/*.meta
+/ARchivist_document_generator/_ARMarker/Markers/*.asset
 
 # MemoryCaptures can get excessive in size.
 # They also could contain extremely sensitive data
@@ -67,7 +67,6 @@ ExportedObj/
 sysinfo.txt
 
 # Builds
-*.apk
 *.aab
 *.unitypackage
 *.app
@@ -81,3 +80,21 @@ crashlytics-build.properties
 # Temporary auto-generated Android Assets
 /[Aa]ssets/[Ss]treamingAssets/aa.meta
 /[Aa]ssets/[Ss]treamingAssets/aa/*
+
+# More Unity stuff to ignore
+*Library*
+*Logs*
+*Temp*
+*UserSettings*
+*build*
+
+
+# More python stuff to ignore
+*vscode*
+*ipynb_checkpoints*
+*__pycache*
+*PDF/*
+
+
+# More MacOS stuff to ignore
+*DS_Store*

.gitignore

@@ -15,14 +15,21 @@
 from github import Github
 import json
 
+# Check which platform the program is being executed on
 if sys.platform == "win32":
     PATH_TO_WKHTMLTOPDF = r'./wkhtmltopdf/bin/wkhtmltopdf.exe'
 elif sys.platform in ["linux", "linux2"]:
     PATH_TO_WKHTMLTOPDF = r'./wkhtmltopdf/wkhtmltopdf'
 elif sys.platform in ["darwin", "os2", "os2emx"]:
     PATH_TO_WKHTMLTOPDF = r'./wkhtmltopdf/wkhtmltopdf-mcos'
 
+# Coordinates for where to place the qr code
+AP, BP, WID, HEI = 200, 660, 120, 120
+
+# Config setup that looks for the wktml executables within the project
 CONFIG = pdfkit.configuration(wkhtmltopdf=PATH_TO_WKHTMLTOPDF)
+
+# Parameter initialization for files and directories
 OPT = {
     'margin-top': '2in',
     'margin-bottom': '1in',
@@ -32,35 +39,31 @@
 }
 TEMP_PDF_PATH = "./PDF/temp.pdf"
 FINAL_PDF_PATH = "./PDF/output.pdf"
+
+# Creating a unique id for the json data
 UID = str(uuid.uuid4())
 
+# Returns the number of pages in a PDF file.
 def count_pdf_pages(temp_pdf_path):
     with open(temp_pdf_path, 'rb') as file:
         pdf_reader = PdfReader(file)
         return len(pdf_reader.pages)
 
-def get_ar_marker_coordinates(pdf_path):
-    pdf_document = fitz.open(pdf_path)
-    image_list = pdf_document.get_page_images(0, full=True)
-    ar_marker_coordinates = pdf_document[0].get_image_rects(image_list[0][7], transform=True)[0][0]
-    pdf_document.close()
-    return ar_marker_coordinates
-
+# Generates QR codes for each page in the PDF.
 def generate_qr_codes(num_pages, uid_folder_path):
     for p_no in range(num_pages):
-        text = f'{{"id": "{UID}", "page": {p_no + 1}}}'
+        text = f'{{"id": "{UID}", "page": {p_no}}}'
         qr = qrcode.QRCode(version=1, error_correction=qrcode.constants.ERROR_CORRECT_L, box_size=10, border=4)
         qr.add_data(text)
         qr.make(fit=True)
         img = qr.make_image(fill='black', back_color='white')
         img.save(os.path.join(uid_folder_path, f"{p_no}.png"))
 
+# Embeds QR codes and AR markers into each page of the PDF.
 def add_qr_codes_to_pdf(num_pages, temp_pdf_path, final_pdf_path, uid_folder_path):
     pdf_reader = PdfReader(temp_pdf_path)
     pdf_writer = PdfWriter()
 
-    a, b = 200, 660
-    wid, hei = 120, 120
     ar_marker_path = './_ARMarker/Markers/MarkerIcons03.png'
 
     with open(ar_marker_path, 'rb') as marker_file:
@@ -77,8 +80,8 @@ def add_qr_codes_to_pdf(num_pages, temp_pdf_path, final_pdf_path, uid_folder_pat
 
         image_pdf_path = 'image_page.pdf'
         c = canvas.Canvas(image_pdf_path, pagesize=letter)
-        c.drawImage(f"data:image/png;base64,{marker_base64}", a, b, width=wid, height=hei)
-        c.drawImage(f"data:image/png;base64,{qr_base64}", a + wid + 5, b, width=wid, height=hei)
+        c.drawImage(f"data:image/png;base64,{marker_base64}", AP, BP, width=WID, height=HEI)
+        c.drawImage(f"data:image/png;base64,{qr_base64}", AP + WID + 5, BP, width=WID, height=HEI)
         c.save()
 
         with open(image_pdf_path, 'rb') as image_pdf_file:
@@ -92,15 +95,12 @@ def add_qr_codes_to_pdf(num_pages, temp_pdf_path, final_pdf_path, uid_folder_pat
     with open(final_pdf_path, 'wb') as output_pdf:
         pdf_writer.write(output_pdf)
 
+# Extracts hyperlinks from the PDF and updates the JSON bin with metadata.
 def process_pdf_metadata(pdf_path, url):
-    ar_marker_coordinates = get_ar_marker_coordinates(pdf_path)
     doc = fitz.open(pdf_path)
     json_data = {
         'URL': url,
-        'ar_marker_coordinates': [
-            ar_marker_coordinates.x0, ar_marker_coordinates.y0,
-            ar_marker_coordinates.x1, ar_marker_coordinates.y1
-        ],
+        'ar_marker_coordinates': [AP, (792 - (BP + HEI)), (AP + WID), (792 - BP)],
         'pages': []
     }
 
@@ -132,6 +132,7 @@ def process_pdf_metadata(pdf_path, url):
     file_path = f'Assets/CustomAssets/{UID}.json'
     repo.create_file(file_path, "Added entry", file_content)
 
+# Converts a URL to a PDF, generates QR codes, embeds them, processes metadata, and opens the final PDF.
 def making_pdf_qr(path):
     pdfkit.from_url(path, output_path=TEMP_PDF_PATH, configuration=CONFIG, options=OPT, verbose=False)
     num_pages = count_pdf_pages(TEMP_PDF_PATH)
@@ -146,6 +147,7 @@ def making_pdf_qr(path):
     process_pdf_metadata(FINAL_PDF_PATH, path)
     webbrowser.open(FINAL_PDF_PATH)
 
+# Converts a existing HTMLin a local diractory to a PDF, generates QR codes, embeds them, processes metadata, and opens the final PDF.
 def process_pdf_file(file_path):
     num_pages = count_pdf_pages(file_path)
     uid_folder_path = os.path.join("./QR", UID)
@@ -158,6 +160,7 @@ def process_pdf_file(file_path):
     process_pdf_metadata(FINAL_PDF_PATH, file_path)
     webbrowser.open(FINAL_PDF_PATH)
 
+# GUI Application
 class PDFGeneratorApp(QWidget):
     def __init__(self):
         super().__init__()