Merge pull request #749 from KelvinTegelaar/dev

pull[bot] · web-flow · commit 8aac5161ef35 · 2026-02-11T00:41:10.000Z
[pull] dev from KelvinTegelaar:dev
diff --git a/Modules/CIPPCore/Public/Entrypoints/Activity Triggers/CIPPDBCache/Push-ExecCIPPDBCache.ps1 b/Modules/CIPPCore/Public/Entrypoints/Activity Triggers/CIPPDBCache/Push-ExecCIPPDBCache.ps1
@@ -15,6 +15,7 @@ function Push-ExecCIPPDBCache {
     $Name = $Item.Name
     $TenantFilter = $Item.TenantFilter
     $QueueId = $Item.QueueId
+    $Types = $Item.Types
 
     try {
         Write-Information "Collecting $Name for tenant $TenantFilter"
@@ -38,6 +39,13 @@ function Push-ExecCIPPDBCache {
             $CacheFunctionParams.QueueId = $QueueId
         }
 
+        # Add Types if provided (for Mailboxes function)
+        if ($Types) {
+            $CacheFunctionParams.Types = $Types
+        }
+
+        Write-Information "Executing $FullFunctionName with parameters: $(($CacheFunctionParams.GetEnumerator() | ForEach-Object { "$($_.Key)=$($_.Value)" }) -join ', '))"
+
         # Execute the cache function
         & $FullFunctionName @CacheFunctionParams
 
diff --git a/Modules/CIPPCore/Public/Entrypoints/Activity Triggers/Push-CIPPDBCacheData.ps1 b/Modules/CIPPCore/Public/Entrypoints/Activity Triggers/Push-CIPPDBCacheData.ps1
@@ -99,7 +99,6 @@ function Push-CIPPDBCacheData {
                 'ExoPresetSecurityPolicy'
                 'ExoTenantAllowBlockList'
                 'Mailboxes'
-                'MailboxRules'
                 'CASMailboxes'
                 'MailboxUsage'
                 'OneDriveUsage'
diff --git a/Modules/CIPPCore/Public/Entrypoints/Activity Triggers/Push-GetMailboxRulesBatch.ps1 b/Modules/CIPPCore/Public/Entrypoints/Activity Triggers/Push-GetMailboxRulesBatch.ps1
@@ -0,0 +1,55 @@
+function Push-GetMailboxRulesBatch {
+    <#
+    .SYNOPSIS
+        Caches mailbox rules for a batch of mailboxes
+
+    .PARAMETER InputObject
+        The batch object containing TenantFilter and Mailboxes array
+    #>
+    [CmdletBinding()]
+    param($Item)
+
+    $TenantFilter = $Item.TenantFilter
+    $Mailboxes = $Item.Mailboxes
+    $BatchNumber = $Item.BatchNumber
+    $TotalBatches = $Item.TotalBatches
+    $QueueId = $Item.QueueId
+
+    try {
+        Write-Information "Processing mailbox rules batch $BatchNumber/$TotalBatches for tenant $TenantFilter with $($Mailboxes.Count) mailboxes"
+
+        # Build bulk request for mailbox rules
+        $Request = $Mailboxes | ForEach-Object {
+            @{
+                OperationGuid = $_
+                CmdletInput   = @{
+                    CmdletName = 'Get-InboxRule'
+                    Parameters = @{
+                        Mailbox = $_
+                    }
+                }
+            }
+        }
+
+        $Rules = New-ExoBulkRequest -tenantid $TenantFilter -cmdletArray @($Request) | Where-Object { $_.Identity }
+
+        Write-Information "Retrieved $($Rules.Count) rules from batch $BatchNumber/$TotalBatches"
+
+        # Add metadata and return for aggregation
+        if (($Rules | Measure-Object).Count -gt 0) {
+            $RulesWithMetadata = foreach ($Rule in $Rules) {
+                $Rule | Add-Member -NotePropertyName 'Tenant' -NotePropertyValue $TenantFilter -Force
+                $Rule | Add-Member -NotePropertyName 'UserPrincipalName' -NotePropertyValue $Rule.OperationGuid -Force
+                $Rule
+            }
+            return , $RulesWithMetadata
+        } else {
+            Write-Information "No rules found in batch $BatchNumber/$TotalBatches"
+            return , @()
+        }
+
+    } catch {
+        Write-LogMessage -API 'CIPPDBCache' -tenant $TenantFilter -message "Failed to process mailbox rules batch $BatchNumber/$TotalBatches : $($_.Exception.Message)" -sev Error -LogData (Get-CippException -Exception $_)
+        throw
+    }
+}
diff --git a/Modules/CIPPCore/Public/Entrypoints/Activity Triggers/Push-StoreMailboxRules.ps1 b/Modules/CIPPCore/Public/Entrypoints/Activity Triggers/Push-StoreMailboxRules.ps1
@@ -0,0 +1,68 @@
+function Push-StoreMailboxRules {
+    <#
+    .SYNOPSIS
+        Post-execution function to aggregate and store all mailbox rules
+
+    .DESCRIPTION
+        Collects results from all batches and stores them in the reporting database
+
+    .FUNCTIONALITY
+        Entrypoint
+    #>
+    [CmdletBinding()]
+    param($Item)
+
+    $TenantFilter = $Item.Parameters.TenantFilter
+    $Results = $Item.Results
+
+    try {
+        Write-Information "Storing mailbox rules for tenant $TenantFilter"
+        Write-Information "Received $($Results.Count) batch results"
+
+        # Aggregate all rules from batches
+        $AllRules = [System.Collections.Generic.List[object]]::new()
+
+        foreach ($BatchResult in $Results) {
+            # Activity functions may return an array
+            $ActualResult = $BatchResult
+            if ($BatchResult -is [array] -and $BatchResult.Count -gt 0) {
+                Write-Information "Result is array with $($BatchResult.Count) elements"
+                # If first element is array of rules, use it
+                if ($BatchResult[0] -is [array]) {
+                    $ActualResult = $BatchResult[0]
+                } else {
+                    $ActualResult = $BatchResult
+                }
+            }
+
+            if ($ActualResult) {
+                if ($ActualResult -is [array]) {
+                    Write-Information "Adding $($ActualResult.Count) rules from batch"
+                    $AllRules.AddRange($ActualResult)
+                } else {
+                    Write-Information 'Adding 1 rule from batch'
+                    $AllRules.Add($ActualResult)
+                }
+            }
+        }
+
+        Write-Information "Aggregated $($AllRules.Count) total mailbox rules"
+
+        # Store all rules
+        if ($AllRules.Count -gt 0) {
+            $AllRules | Add-CIPPDbItem -TenantFilter $TenantFilter -Type 'MailboxRules' -AddCount
+            Write-LogMessage -API 'CIPPDBCache' -tenant $TenantFilter -message "Cached $($AllRules.Count) mailbox rules" -sev Info
+        } else {
+            # Store empty result to indicate successful check with no rules
+            @() | Add-CIPPDbItem -TenantFilter $TenantFilter -Type 'MailboxRules' -AddCount
+            Write-LogMessage -API 'CIPPDBCache' -tenant $TenantFilter -message 'No mailbox rules found to cache' -sev Info
+        }
+
+        return
+
+    } catch {
+        $ErrorMsg = "Failed to store mailbox rules for tenant $TenantFilter : $($_.Exception.Message)"
+        Write-LogMessage -API 'CIPPDBCache' -tenant $TenantFilter -message $ErrorMsg -sev Error
+        throw $ErrorMsg
+    }
+}
diff --git a/Modules/CIPPCore/Public/Entrypoints/HTTP Functions/CIPP/Core/Invoke-ExecCIPPDBCache.ps1 b/Modules/CIPPCore/Public/Entrypoints/HTTP Functions/CIPP/Core/Invoke-ExecCIPPDBCache.ps1
@@ -11,8 +11,9 @@ function Invoke-ExecCIPPDBCache {
     $APIName = $Request.Params.CIPPEndpoint
     $TenantFilter = $Request.Query.TenantFilter
     $Name = $Request.Query.Name
+    $Types = $Request.Query.Types
 
-    Write-Information "ExecCIPPDBCache called with Name: '$Name', TenantFilter: '$TenantFilter'"
+    Write-Information "ExecCIPPDBCache called with Name: '$Name', TenantFilter: '$TenantFilter', Types: '$Types'"
 
     try {
         if ([string]::IsNullOrEmpty($Name)) {
@@ -30,8 +31,6 @@ function Invoke-ExecCIPPDBCache {
             throw "Cache function '$FunctionName' not found"
         }
 
-        Write-LogMessage -API $APIName -tenant $TenantFilter -message "Starting CIPP DB cache for $Name" -sev Info
-
         # Create queue entry for tracking
         $QueueName = if ($TenantFilter -eq 'AllTenants') {
             "$Name Cache Sync (All Tenants)"
@@ -45,13 +44,18 @@ function Invoke-ExecCIPPDBCache {
             $Queue = New-CippQueueEntry -Name $QueueName -TotalTasks ($TenantList | Measure-Object).Count
 
             $Batch = $TenantList | ForEach-Object {
-                [PSCustomObject]@{
+                $BatchItem = [PSCustomObject]@{
                     FunctionName = 'ExecCIPPDBCache'
-                    QueueName    = "$Name Cache - $($_.defaultDomainName)"
                     Name         = $Name
+                    QueueName    = "$Name Cache - $($_.defaultDomainName)"
                     TenantFilter = $_.defaultDomainName
                     QueueId      = $Queue.RowKey
                 }
+                # Add Types parameter if provided
+                if ($Types) {
+                    $BatchItem | Add-Member -NotePropertyName 'Types' -NotePropertyValue @($Types -split ',') -Force
+                }
+                $BatchItem
             }
 
             $InputObject = [PSCustomObject]@{
@@ -60,28 +64,33 @@ function Invoke-ExecCIPPDBCache {
                 SkipLog          = $false
             }
 
-            Write-LogMessage -API $APIName -tenant $TenantFilter -message "Starting CIPP DB cache for $Name across $($TenantList.Count) tenants" -sev Info
+            Write-LogMessage -Headers $Request.Headers -API $APIName -tenant $TenantFilter -message "Starting CIPP DB cache for $Name across $($TenantList.Count) tenants" -sev Info
         } else {
             # Single tenant
             $Queue = New-CippQueueEntry -Name $QueueName -TotalTasks 1
 
+            $BatchItem = [PSCustomObject]@{
+                FunctionName = 'ExecCIPPDBCache'
+                Name         = $Name
+                QueueName    = "$Name Cache - $TenantFilter"
+                TenantFilter = $TenantFilter
+                QueueId      = $Queue.RowKey
+            }
+            # Add Types parameter if provided
+            if ($Types) {
+                $BatchItem | Add-Member -NotePropertyName 'Types' -NotePropertyValue @($Types -split ',') -Force
+            }
+
             $InputObject = [PSCustomObject]@{
-                Batch            = @([PSCustomObject]@{
-                        QueueName    = "$Name Cache - $TenantFilter"
-                        FunctionName = 'ExecCIPPDBCache'
-                        Name         = $Name
-                        TenantFilter = $TenantFilter
-                        QueueId      = $Queue.RowKey
-                    })
+                Batch            = @($BatchItem)
                 OrchestratorName = "CIPPDBCache_${Name}_$TenantFilter"
                 SkipLog          = $false
             }
+            Write-LogMessage -Headers $Request.Headers -API $APIName -tenant $TenantFilter -message "Starting CIPP DB cache for $Name on tenant $TenantFilter" -sev Info
         }
 
         $InstanceId = Start-NewOrchestration -FunctionName 'CIPPOrchestrator' -InputObject ($InputObject | ConvertTo-Json -Compress -Depth 5)
 
-        Write-LogMessage -API $APIName -tenant $TenantFilter -message "Started CIPP DB cache orchestrator for $Name with instance ID: $InstanceId" -sev Info
-
         $ResultsMessage = if ($TenantFilter -eq 'AllTenants') {
             "Successfully started cache operation for $Name for all tenants"
         } else {
diff --git a/Modules/CIPPCore/Public/Entrypoints/Orchestrator Functions/Start-UserTasksOrchestrator.ps1 b/Modules/CIPPCore/Public/Entrypoints/Orchestrator Functions/Start-UserTasksOrchestrator.ps1
@@ -151,11 +151,6 @@ function Start-UserTasksOrchestrator {
         # Process each tenant batch separately
         foreach ($ProcessedBatch in $ProcessedBatches) {
             $TenantName = $ProcessedBatch[0].Parameters.TenantFilter
-            Write-Information "Processing batch for tenant: $TenantName with $($ProcessedBatch.Count) tasks..."
-            Write-Information 'Tasks by command:'
-            $ProcessedBatch | Group-Object -Property Command | ForEach-Object {
-                Write-Information " - $($_.Name): $($_.Count)"
-            }
 
             # Create queue entry for each tenant batch
             $Queue = New-CippQueueEntry -Name "Scheduled Tasks - $TenantName"
diff --git a/Modules/CIPPCore/Public/Entrypoints/Timer Functions/Start-TableCleanup.ps1 b/Modules/CIPPCore/Public/Entrypoints/Timer Functions/Start-TableCleanup.ps1
@@ -65,6 +65,16 @@ function Start-TableCleanup {
                 Property = @('PartitionKey', 'RowKey', 'ETag')
             }
         }
+        @{
+            FunctionName   = 'TableCleanupTask'
+            Type           = 'CleanupRule'
+            TableName      = 'CippStandardsReports'
+            DataTableProps = @{
+                Filter   = "Timestamp lt datetime'$((Get-Date).AddDays(-7).ToUniversalTime().ToString('yyyy-MM-ddTHH:mm:ssZ'))'"
+                First    = 10000
+                Property = @('PartitionKey', 'RowKey', 'ETag')
+            }
+        }
         @{
             FunctionName = 'TableCleanupTask'
             Type         = 'DeleteTable'
diff --git a/Modules/CIPPCore/Public/Get-CIPPLicenseOverview.ps1 b/Modules/CIPPCore/Public/Get-CIPPLicenseOverview.ps1
@@ -56,6 +56,13 @@ function Get-CIPPLicenseOverview {
     $LicenseTable = Get-CIPPTable -TableName ExcludedLicenses
     $ExcludedSkuList = Get-CIPPAzDataTableEntity @LicenseTable
 
+    # If no excluded licenses exist, initialize them
+    if ($ExcludedSkuList.Count -lt 1) {
+        Write-Information 'Excluded licenses table is empty. Initializing from config file.'
+        $null = Initialize-CIPPExcludedLicenses
+        $ExcludedSkuList = Get-CIPPAzDataTableEntity @LicenseTable
+    }
+
     $AllLicensedUsers = @(($Results | Where-Object { $_.id -eq 'licensedUsers' }).body.value)
     $UsersBySku = @{}
     foreach ($User in $AllLicensedUsers) {
diff --git a/Modules/CIPPCore/Public/Remove-CIPPDbItem.ps1 b/Modules/CIPPCore/Public/Remove-CIPPDbItem.ps1
@@ -0,0 +1,76 @@
+function Remove-CIPPDbItem {
+    <#
+    .SYNOPSIS
+        Remove an item from the CIPP Reporting database
+
+    .DESCRIPTION
+        Removes a specific item from the CippReportingDB table using partition key (tenant) and row key (item ID)
+
+    .PARAMETER TenantFilter
+        The tenant domain or GUID (partition key)
+
+    .PARAMETER Type
+        The type of data being removed (used to find and update count)
+
+    .PARAMETER ItemId
+        The item ID or identifier to remove (used in row key)
+
+    .EXAMPLE
+        Remove-CIPPDbItem -TenantFilter 'contoso.onmicrosoft.com' -Type 'MailboxRules' -ItemId 'rule-id-123'
+    #>
+    [CmdletBinding()]
+    param(
+        [Parameter(Mandatory = $true)]
+        [string]$TenantFilter,
+
+        [Parameter(Mandatory = $true)]
+        [string]$Type,
+
+        [Parameter(Mandatory = $true)]
+        [string]$ItemId
+    )
+
+    try {
+        $Table = Get-CippTable -tablename 'CippReportingDB'
+
+        # Sanitize the ItemId for RowKey (same as in Add-CIPPDbItem)
+        $SanitizedId = $ItemId -replace '[/\\#?]', '_' -replace '[\u0000-\u001F\u007F-\u009F]', ''
+        $RowKey = "$Type-$SanitizedId"
+
+        # Try to get the entity
+        $Filter = "PartitionKey eq '$TenantFilter' and RowKey eq '$RowKey'"
+        $Entity = Get-CIPPAzDataTableEntity @Table -Filter $Filter
+
+        if ($Entity) {
+            # Remove the entity
+            Remove-AzDataTableEntity @Table -Entity $Entity -Force
+            Write-LogMessage -API 'CIPPDbItem' -tenant $TenantFilter -message "Removed $Type item with ID: $ItemId" -sev Debug
+
+            # Always decrement count
+            try {
+                $CountRowKey = "$Type-Count"
+                $CountFilter = "PartitionKey eq '$TenantFilter' and RowKey eq '$CountRowKey'"
+                $CountEntity = Get-CIPPAzDataTableEntity @Table -Filter $CountFilter
+
+                if ($CountEntity -and $CountEntity.DataCount -gt 0) {
+                    $CountEntity.DataCount = [int]$CountEntity.DataCount - 1
+                    Add-CIPPAzDataTableEntity @Table -Entity @{
+                        PartitionKey = $CountEntity.PartitionKey
+                        RowKey       = $CountEntity.RowKey
+                        DataCount    = $CountEntity.DataCount
+                        ETag         = $CountEntity.ETag
+                    } -Force | Out-Null
+                    Write-LogMessage -API 'CIPPDbItem' -tenant $TenantFilter -message "Decremented $Type count to $($CountEntity.DataCount)" -sev Debug
+                }
+            } catch {
+                Write-LogMessage -API 'CIPPDbItem' -tenant $TenantFilter -message "Failed to decrement count for $Type : $($_.Exception.Message)" -sev Warning
+            }
+        } else {
+            Write-LogMessage -API 'CIPPDbItem' -tenant $TenantFilter -message "Item not found for removal: $Type with ID $ItemId" -sev Debug
+        }
+
+    } catch {
+        Write-LogMessage -API 'CIPPDbItem' -tenant $TenantFilter -message "Failed to remove $Type item: $($_.Exception.Message)" -sev Error -LogData (Get-CippException -Exception $_)
+        throw
+    }
+}
diff --git a/Modules/CIPPCore/Public/Remove-CIPPMailboxRule.ps1 b/Modules/CIPPCore/Public/Remove-CIPPMailboxRule.ps1
@@ -22,7 +22,7 @@ function Remove-CIPPMailboxRule {
                 Write-LogMessage -headers $Headers -API $APIName -message $Message -Sev 'Info' -tenant $TenantFilter
                 return $Message
             } else {
-                ForEach ($rule in $Rules) {
+                foreach ($rule in $Rules) {
                     $null = New-ExoRequest -tenantid $TenantFilter -cmdlet 'Remove-InboxRule' -Anchor $Username -cmdParams @{Identity = $rule.Identity }
                 }
                 $Message = "Successfully deleted all rules for $($Username)"
@@ -41,6 +41,14 @@ function Remove-CIPPMailboxRule {
             $null = New-ExoRequest -tenantid $TenantFilter -cmdlet 'Remove-InboxRule' -Anchor $Username -cmdParams @{Identity = $RuleId }
             $Message = "Successfully deleted mailbox rule $($RuleName) for $($Username)"
             Write-LogMessage -headers $Headers -API $APIName -message "Deleted mailbox rule $($RuleName) for $($Username)" -Sev 'Info' -tenant $TenantFilter
+
+            # Remove from cache if it exists
+            try {
+                Remove-CIPPDbItem -TenantFilter $TenantFilter -Type 'MailboxRules' -ItemId $RuleId
+            } catch {
+                Write-LogMessage -headers $Headers -API $APIName -message "Rule deleted but failed to remove from cache: $($_.Exception.Message)" -Sev 'Warning' -tenant $TenantFilter
+            }
+
             return $Message
         } catch {
             $ErrorMessage = Get-CippException -Exception $_
diff --git a/Modules/CIPPCore/Public/Set-CIPPDBCacheMailboxRules.ps1 b/Modules/CIPPCore/Public/Set-CIPPDBCacheMailboxRules.ps1
diff --git a/Modules/CIPPCore/Public/Set-CIPPDBCacheMailboxes.ps1 b/Modules/CIPPCore/Public/Set-CIPPDBCacheMailboxes.ps1
diff --git a/Modules/CIPPCore/Public/Set-CIPPMailboxRule.ps1 b/Modules/CIPPCore/Public/Set-CIPPMailboxRule.ps1
diff --git a/Modules/CIPPCore/Public/Update-CIPPDbItem.ps1 b/Modules/CIPPCore/Public/Update-CIPPDbItem.ps1
diff --git a/Tools/Initialize-DevEnvironment.ps1 b/Tools/Initialize-DevEnvironment.ps1
