🔍 Code Extractor

Browse Components

• function get_user_access_url

  Retrieves a share URL for a document version and determines the appropriate access level (read/write) for a specific user based on their role (owner, author, reviewer, approver) and the document's current status.

  File: /tf/active/vicechatdev/CDocs/controllers/share_controller.py | Lines: 864-1041

  access-control permissions document-management role-based-access workflow

• function remove_user_access

  Removes a user's access permissions from a specific document version share in FileCloud by delegating to the FileCloud client's remove_user_from_share method.

  File: /tf/active/vicechatdev/CDocs/controllers/share_controller.py | Lines: 844-862

  access-control document-management user-permissions filecloud security

• function update_approver_permissions

  Updates file access permissions for approvers when an approval cycle changes by delegating to the main document permission management function.

  File: /tf/active/vicechatdev/CDocs/controllers/share_controller.py | Lines: 815-842

  permissions approval document-management access-control filecloud

• function update_reviewer_permissions

  Updates file access permissions for reviewers associated with a review cycle by delegating to the main document permission management function.

  File: /tf/active/vicechatdev/CDocs/controllers/share_controller.py | Lines: 786-813

  permissions access-control review-cycle document-management reviewer

• function manage_document_permissions

  Comprehensive function to manage document sharing and user permissions. This function: 1. Creates a share only if needed for active users 2. Adds/updates users with appropriate permissions based on their roles 3. Removes users who shouldn't have access anymore 4. Cleans up shares that are no longer needed 5. Manages ACL entries for write permissions on the document's folder Args: document: The document to manage permissions for Returns: Dict: Result of permission updates with detailed information

  File: /tf/active/vicechatdev/CDocs/controllers/share_controller.py | Lines: 72-784

  function manage_document_permissions

• function get_document_share_url

  Retrieves or creates a shareable URL for a specific document version, checking for existing shares before creating new ones.

  File: /tf/active/vicechatdev/CDocs/controllers/share_controller.py | Lines: 32-70

  document-sharing url-generation filecloud document-management version-control

• function run_permission_check_async

  Launches a background daemon thread to perform document permission checks without blocking the main application thread.

  File: /tf/active/vicechatdev/CDocs/controllers/permission_startup_check.py | Lines: 450-478

  background-task threading permissions async-operation startup

• function ensure_document_version_share_attributes

  Ensures a DocumentVersion object has share_id and share_url attributes, initializing them to None if missing and persisting changes to the database.

  File: /tf/active/vicechatdev/CDocs/controllers/permission_startup_check.py | Lines: 27-64

  attribute-initialization schema-migration defensive-programming database-persistence error-handling

• function get_user_pending_approvals

  Retrieves all pending approval assignments for a specific user, with optional filtering by completion status and date range, returning structured approval data for UI display.

  File: /tf/active/vicechatdev/CDocs/controllers/approval_controller.py | Lines: 1886-1958

  approval-management user-approvals document-workflow pagination date-filtering

• function get_approval

  Retrieves a specific approval cycle by its unique identifier (UID) with optional inclusion of associated document details and approval comments.

  File: /tf/active/vicechatdev/CDocs/controllers/approval_controller.py | Lines: 1793-1881

  approval document-management workflow retrieval controlled-documents

• function remove_approver_from_active_approval

  Removes an approver from an active approval cycle with permission checks, validation, and notification handling.

  File: /tf/active/vicechatdev/CDocs/controllers/approval_controller.py | Lines: 1532-1680

  approval-management document-control permission-check workflow audit-trail

• function add_approver_to_active_approval

  Adds a new approver to an active approval cycle for a controlled document, with optional sequence ordering and custom instructions.

  File: /tf/active/vicechatdev/CDocs/controllers/approval_controller.py | Lines: 1395-1529

  approval-workflow document-management access-control permissions notifications

• function extend_approval_deadline

  Extends the deadline for an active approval cycle, validating permissions and business rules, then notifying affected approvers.

  File: /tf/active/vicechatdev/CDocs/controllers/approval_controller.py | Lines: 1280-1392

  approval-management deadline-extension document-control permission-check audit-trail

• function cancel_approval_cycle

  Cancels an active approval cycle for a controlled document, updating the approval status, notifying approvers, and reverting the document to DRAFT status if no other active approvals exist.

  File: /tf/active/vicechatdev/CDocs/controllers/approval_controller.py | Lines: 1127-1277

  approval-management document-control workflow cancellation permissions

• function close_approval_cycle

  Closes a completed approval cycle and optionally updates the associated document's status, with permission checks, audit logging, and notifications.

  File: /tf/active/vicechatdev/CDocs/controllers/approval_controller.py | Lines: 992-1124

  approval-management document-workflow permission-control status-transition audit-logging

• function complete_approval

  Completes an approval cycle by recording a user's approval decision (APPROVED, REJECTED, etc.) and managing the approval workflow, including sequential approver activation and final cycle completion.

  File: /tf/active/vicechatdev/CDocs/controllers/approval_controller.py | Lines: 792-988

  approval workflow document-management decision-tracking permissions

• function update_approval_comment

  Updates an approval comment's text and/or status with permission checks, audit logging, and notifications for resolved comments.

  File: /tf/active/vicechatdev/CDocs/controllers/approval_controller.py | Lines: 634-789

  approval-workflow comment-management permission-control audit-logging notification

• function add_approval_comment

  Adds a comment to an approval cycle for a controlled document, with support for threaded comments, different comment types, and automatic notifications to relevant stakeholders.

  File: /tf/active/vicechatdev/CDocs/controllers/approval_controller.py | Lines: 444-629

  approval comment document-management collaboration permissions

• function get_document_approval_cycles

  Retrieves all approval cycles associated with a specific document, with optional filtering for active cycles only.

  File: /tf/active/vicechatdev/CDocs/controllers/approval_controller.py | Lines: 287-356

  approval-management document-control database-query neo4j approval-cycles

• function get_approval_cycle

  Retrieves detailed information about an approval cycle by its UID, with optional inclusion of comments and associated document details.

  File: /tf/active/vicechatdev/CDocs/controllers/approval_controller.py | Lines: 195-284

  approval-workflow document-management data-retrieval graph-database neo4j