#Requires -Version 5.1
<#
    JbTecWiz Support Centre -- generated fix script

    Fault : "File is locked for editing by another user" -- including when that user is you
    Fix   : Release a SharePoint or OneDrive lock
    Source: https://jbtecwiz.com/support/win-office-file-locked

    Run as     : The browser, as the document owner or a site administrator
    Expect     : 30 minutes
    Risk       : low
    Reversible : yes

    WHEN THIS IS THE RIGHT FIX
    The file is in SharePoint, Teams or OneDrive.

    HOW TO UNDO IT
    Discarding a checkout loses changes that were never checked in -- check
    version history first if that is a concern.

    This script walks the fix one step at a time and asks before each
    one. Steps with no command are things you do yourself -- it prints
    those and waits. Run with -DryRun to print without executing.
#>

[CmdletBinding()]
param(
    # Print every step and command without running anything.
    [switch]$DryRun,
    # Do not ask before each step. Read the script first if you use this.
    [switch]$Unattended
)

$ErrorActionPreference = 'Stop'
$script:Failed = 0

# This fix is documented as needing an elevated session.
$id = [Security.Principal.WindowsIdentity]::GetCurrent()
if (-not (New-Object Security.Principal.WindowsPrincipal $id).IsInRole(
        [Security.Principal.WindowsBuiltInRole]::Administrator)) {
    Write-Host ''
    Write-Host '  This fix needs an elevated PowerShell.' -ForegroundColor Yellow
    Write-Host '  Close this window, right-click PowerShell, Run as administrator,'
    Write-Host '  and run the script again.'
    Write-Host ''
    exit 3
}

function Write-Rule { param([string]$Text)
    Write-Host ''
    Write-Host ('-' * 70) -ForegroundColor DarkGray
    if ($Text) { Write-Host $Text -ForegroundColor Cyan }
}

function Show-Prose { param([string]$Text, [string]$Colour = "Gray")
    if (-not $Text) { return }
    $words = $Text -split "\s+"; $line = "  "
    foreach ($w in $words) {
        if (($line.Length + $w.Length) -gt 74) { Write-Host $line -ForegroundColor $Colour; $line = "  " }
        $line += "$w "
    }
    if ($line.Trim()) { Write-Host $line -ForegroundColor $Colour }
}

function Invoke-Step {
    param(
        [int]$Number, [string]$Do, [string]$Why,
        [scriptblock]$Command, [switch]$Manual, [string]$Shell = "powershell"
    )
    Write-Rule "  Step $Number of 5"
    Show-Prose $Do "White"
    if ($Why) { Write-Host ""; Show-Prose $Why "DarkGray" }

    if ($Manual) {
        Write-Host ''
        Write-Host '  -> Do this yourself, then press Enter to carry on.' -ForegroundColor Yellow
        if (-not $Unattended -and -not $DryRun) { [void](Read-Host) }
        return
    }

    Write-Host ''
    foreach ($l in ($Command.ToString().Trim() -split "`n")) {
        Write-Host ("    " + $l.Trim()) -ForegroundColor Green
    }
    Write-Host ''

    if ($DryRun) { Write-Host "  (dry run -- not executed)" -ForegroundColor DarkGray; return }
    if (-not $Unattended) {
        $a = Read-Host "  Run this step? [Y]es / [S]kip / [Q]uit"
        if ($a -match "^[Qq]") { Write-Host "  Stopped at your request."; exit 0 }
        if ($a -match "^[Ss]") { Write-Host "  Skipped." -ForegroundColor DarkGray; return }
    }
    try { & $Command }
    catch {
        $script:Failed++
        Write-Host ("  Step $Number failed: " + $_.Exception.Message) -ForegroundColor Red
        Show-Prose "The rest of the fix may depend on this. Read the write-up before carrying on." "Red"
        if (-not $Unattended) {
            $c = Read-Host "  Carry on anyway? [y/N]"
            if ($c -notmatch "^[Yy]") { exit 1 }
        }
    }
}

Write-Rule
Write-Host '  "File is locked for editing by another user" -- including when that user is you' -ForegroundColor White
Write-Host '  Release a SharePoint or OneDrive lock' -ForegroundColor Cyan
Write-Host ''
Write-Host '  Risk: low   Reversible   30 minutes'
Write-Rule

if (-not $Unattended -and -not $DryRun) {
    $go = Read-Host '  Ready? [y/N]'
    if ($go -notmatch "^[Yy]") { Write-Host "  Nothing was changed."; exit 0 }
}

Invoke-Step -Number 1 -Do 'Open the library in the browser and check whether the file shows as checked out. A checked-out file shows a small green arrow, and its Checked Out To column names the holder.' -Manual

Invoke-Step -Number 2 -Do 'If it is checked out, discard the checkout from the library -- the  menu -> More -> Discard check out. A site administrator can do this for anyone else''s checkout.' -Manual

Invoke-Step -Number 3 -Do 'If it is not checked out, wait ten minutes. A short-term lock is taken when a client opens the file and is released automatically when the client disappears; there is no way to clear it early and no reason to.' -Why 'This is the step people skip, and it is why the same file is reported three times in twenty minutes. The lock expires on its own.' -Manual

Invoke-Step -Number 4 -Do 'Have the user close Office completely and let the sync client settle, since a local Office process holding the file will keep re-taking the lock.' -Command {
    Get-Process WINWORD,EXCEL,POWERPNT -ErrorAction SilentlyContinue | Stop-Process -Force
}

Invoke-Step -Number 5 -Do 'If the document keeps locking for one user only, check they are opening it from the sync client or the browser and not through a mapped drive to the SharePoint URL, which does not participate in co-authoring properly.' -Manual

Write-Rule "  Confirm it worked"
Show-Prose 'The file opens for editing in the browser and in the desktop application, and version history shows the new save.' 'White'

Write-Rule
if ($script:Failed -gt 0) {
    Write-Host ("  Finished with " + $script:Failed + " failed step(s).") -ForegroundColor Yellow
    Show-Prose 'Read the full write-up at https://jbtecwiz.com/support/win-office-file-locked' 'Yellow'
} else {
    Write-Host '  Finished.' -ForegroundColor Green
}
Write-Host ''
Show-Prose 'To undo: Discarding a checkout loses changes that were never checked in -- check version history first if that is a concern.' 'DarkGray'
Write-Rule