Browse Components - Code Extractor

function validate_document_structure

Validates the structural integrity of a DOCX document by checking if it contains all required sections specified in the document type template configuration.

File: /tf/active/vicechatdev/CDocs/utils/document_processor.py | Lines: 310-364

document-validation docx structure-validation template-compliance file-processing

function validate_document

Validates document files by checking file size, extension, and optionally performing type-specific structural validation for supported document formats.

File: /tf/active/vicechatdev/CDocs/utils/document_processor.py | Lines: 276-308

validation document-processing file-upload file-validation document-management

function extract_metadata_pdf

Extracts metadata from PDF files including title, author, creation date, page count, and other document properties using PyPDF2 library.

File: /tf/active/vicechatdev/CDocs/utils/document_processor.py | Lines: 220-274

pdf metadata extraction document-processing file-parsing

function extract_metadata_docx

Extracts comprehensive metadata from Microsoft Word DOCX files, including document properties, statistics, and fallback title extraction from content or filename.

File: /tf/active/vicechatdev/CDocs/utils/document_processor.py | Lines: 167-218

docx metadata-extraction document-processing file-analysis microsoft-word

function extract_metadata

Extracts metadata from file content by analyzing the file type and computing file properties including hash, size, and type-specific metadata.

File: /tf/active/vicechatdev/CDocs/utils/document_processor.py | Lines: 103-165

metadata-extraction file-processing document-analysis hash-computation file-type-detection

function process_document

Processes a document file (DOCX, DOC, or PDF) and extracts comprehensive metadata including file information, content metadata, and cryptographic hash.

File: /tf/active/vicechatdev/CDocs/utils/document_processor.py | Lines: 41-101

document-processing metadata-extraction file-handling pdf docx

class DocumentProcessingError

Custom exception class for handling errors that occur during document processing operations.

File: /tf/active/vicechatdev/CDocs/utils/document_processor.py | Lines: 37-39

exception error-handling document-processing custom-exception error

class ControlledDocumentConverter

A comprehensive document converter class that transforms controlled documents into archived PDFs with signature pages, audit trails, hash-based integrity verification, and PDF/A compliance for long-term archival.

File: /tf/active/vicechatdev/CDocs/utils/document_converter.py | Lines: 29-325

document-conversion pdf-generation audit-trail document-control archival

function schedule_reminders

Automated scheduled task that sends reminder and overdue notifications for pending reviews and approvals that are due within 3 days or past their due date.

File: /tf/active/vicechatdev/CDocs/utils/notifications.py | Lines: 1572-1709

scheduled-task notifications reminders neo4j graph-database

function notify_approval

Sends approval notifications to designated approvers for a document version, supporting multiple notification types (requested, reminder, overdue, completed, rejected, signed) with email and in-app notifications.

File: /tf/active/vicechatdev/CDocs/utils/notifications.py | Lines: 1326-1457

notification approval email document-management workflow

function notify_review

Sends review notifications to specified reviewers for a document review cycle, supporting multiple notification types (requested, reminder, overdue, completed).

File: /tf/active/vicechatdev/CDocs/utils/notifications.py | Lines: 1236-1324

notification review document-management email workflow

function send_notification

Sends in-app notifications to one or more users and optionally sends corresponding email notifications using templates.

File: /tf/active/vicechatdev/CDocs/utils/notifications.py | Lines: 1132-1234

notification email messaging user-communication multi-channel

function delete_all_notifications

Deletes all notifications or only read notifications for a specific user from a Neo4j graph database.

File: /tf/active/vicechatdev/CDocs/utils/notifications.py | Lines: 1104-1130

notifications database neo4j cypher delete

function delete_notification

Deletes a notification node from a Neo4j graph database by its unique identifier (UID).

File: /tf/active/vicechatdev/CDocs/utils/notifications.py | Lines: 1080-1102

database neo4j notification delete crud

function count_user_notifications

Counts the total number of notifications for a specific user in a Neo4j graph database, with an option to filter for only unread notifications.

File: /tf/active/vicechatdev/CDocs/utils/notifications.py | Lines: 1046-1078

notifications neo4j graph-database cypher-query user-management

function get_user_notifications

Retrieves notifications for a specific user from a Neo4j graph database, with options for filtering unread notifications and pagination support.

File: /tf/active/vicechatdev/CDocs/utils/notifications.py | Lines: 992-1044

notifications neo4j graph-database user-management pagination

function mark_notification_read

Updates a notification's read status in a Neo4j graph database and sets a timestamp when marked as read.

File: /tf/active/vicechatdev/CDocs/utils/notifications.py | Lines: 963-990

notification database neo4j graph-database read-status

function create_notification

Creates an in-app notification for a user in a graph database, linking it to the user and optionally to a related resource.

File: /tf/active/vicechatdev/CDocs/utils/notifications.py | Lines: 882-961

notification in-app-notification graph-database neo4j user-notification

function html_to_text

Converts HTML content to plain text by removing HTML tags, decoding common HTML entities, and normalizing whitespace.

File: /tf/active/vicechatdev/CDocs/utils/notifications.py | Lines: 852-878

html text-conversion html-parsing text-extraction html-entities

function render_template

Renders a template string by replacing placeholders with data values and processing conditional blocks (if/endif tags).

File: /tf/active/vicechatdev/CDocs/utils/notifications.py | Lines: 704-850

template-rendering string-formatting conditional-logic placeholder-replacement text-processing