OneDrive.psm1
|
function Get-ODAuthentication { <# .DESCRIPTION Connect to OneDrive for authentication with a given client id (get your free client id on https://apps.dev.microsoft.com) For a step-by-step guide reade this blog post: https://www.sepago.com/node/2994 .PARAMETER ClientID ClientID of your "app" from https://apps.dev.microsoft.com .PARAMETER AppKey The client secret for your OneDrive "app". If AppKey is set the authentication mode is "code." Code authentication returns a refresh token to refresh your authentication token unattended. .PARAMETER Scope Comma-separated string defining the authentication scope (https://dev.onedrive.com/auth/msa_oauth.htm). Default: "onedrive.readwrite,offline_access". .PARAMETER RefreshToken Refreshes the authentication token unattended with this refresh token. .PARAMETER AutoAccept In token mode the accept button in the web form is pressed automatically. .PARAMETER RedirectURI Code authentication requires a correct URI. Use the same as in the app registration e.g. http://localhost/logon. Default is https://login.live.com/oauth20_desktop.srf. Don't use this parameter for token-based authentication. .EXAMPLE $Authentication=Get-ODAuthentication -ClientID "0000000012345678" $AuthToken=$Authentication.access_token Connect to OneDrive for authentication and save the token to $AuthToken .NOTES Author: Marcel Meurer, marcel.meurer@sepago.de, Twitter: MarcelMeurer #> PARAM( [Parameter(Mandatory=$True)] [string]$ClientID = "unknown", [string]$Scope = "onedrive.readwrite,offline_access", [string]$RedirectURI ="https://login.live.com/oauth20_desktop.srf", [string]$AppKey="", [string]$RefreshToken="", [switch]$AutoAccept, [switch]$LogOut ) $Authentication="" if ($AppKey -eq "") { $Type="token" } else { $Type="code" } if ($RefreshToken -ne "") { write-debug("A refresh token is given. Try to refresh it in code mode.") $body="client_id=$ClientID&redirect_URI=$RedirectURI&client_secret=$AppKey&refresh_token="+$RefreshToken+"&grant_type=refresh_token" $webRequest=Invoke-WebRequest -Method POST -Uri "https://login.microsoftonline.com/common/oauth2/v2.0/token" -ContentType "application/x-www-form-URLencoded" -Body $Body -UseBasicParsing $Authentication = $webRequest.Content | ConvertFrom-Json } else { write-debug("Authentication mode: " +$Type) [Reflection.Assembly]::LoadWithPartialName("System.Windows.Forms") | out-null [Reflection.Assembly]::LoadWithPartialName("System.Drawing") | out-null [Reflection.Assembly]::LoadWithPartialName("System.Web") | out-null if ($Logout) { $URIGetAccessToken="https://login.live.com/logout.srf" } else { $URIGetAccessTokenRedirect=$RedirectURI $URIGetAccessToken="https://login.live.com/oauth20_authorize.srf?client_id="+$ClientID+"&scope="+$Scope+"&response_type="+$Type+"&redirect_URI="+$URIGetAccessTokenRedirect } $form = New-Object Windows.Forms.Form $form.text = "Authenticate to OneDrive" $form.size = New-Object Drawing.size @(700,600) $form.Width = 675 $form.Height = 750 $web=New-object System.Windows.Forms.WebBrowser $web.IsWebBrowserContextMenuEnabled = $true $web.Width = 600 $web.Height = 700 $web.Location = "25, 25" $web.navigate($URIGetAccessToken) $DocComplete = { if ($web.Url.AbsoluteUri -match "access_token=|error|code=|logout") {$form.Close() } if ($web.DocumentText -like '*ucaccept*') { if ($AutoAccept) {$web.Document.GetElementById("idBtn_Accept").InvokeMember("click")} } } $web.Add_DocumentCompleted($DocComplete) $form.Controls.Add($web) $form.showdialog() | out-null # Build object from last URI (which should contains the token) $ReturnURI=($web.Url).ToString().Replace("#","&") if ($LogOut) {return "Logout"} if ($Type -eq "code") { write-debug("Getting code to redeem token") $Authentication = New-Object PSObject ForEach ($element in $ReturnURI.Split("?")[1].Split("&")) { $Authentication | add-member Noteproperty $element.split("=")[0] $element.split("=")[1] } if ($Authentication.code) { $body="client_id=$ClientID&redirect_URI=$RedirectURI&client_secret=$AppKey&code="+$Authentication.code+"&grant_type=authorization_code" $webRequest=Invoke-WebRequest -Method POST -Uri "https://login.microsoftonline.com/common/oauth2/v2.0/token" -ContentType "application/x-www-form-urlencoded" -Body $Body -UseBasicParsing $Authentication = $webRequest.Content | ConvertFrom-Json } else { write-error("Cannot get authentication code. Error: "+$ReturnURI) } } else { $Authentication = New-Object PSObject ForEach ($element in $ReturnURI.Split("?")[1].Split("&")) { $Authentication | add-member Noteproperty $element.split("=")[0] $element.split("=")[1] } if ($Authentication.PSobject.Properties.name -match "expires_in") { $Authentication | add-member Noteproperty "expires" ([System.DateTime]::Now.AddSeconds($Authentication.expires_in)) } } } if (!($Authentication.PSobject.Properties.name -match "expires_in")) { write-warning("There is maybe an errror, because there is no access_token!") } return $Authentication } function Get-ODWebContent { <# .DESCRIPTION Internal function to interact with the OneDrive API .PARAMETER AccessToken A valid access token for bearer authorization. .PARAMETER rURI Relative path to the API. .PARAMETER Method Webrequest method like PUT, GET, ... .PARAMETER Body Payload of a webrequest. .PARAMETER BinaryMode Do not convert response to JSON. .NOTES Author: Marcel Meurer, marcel.meurer@sepago.de, Twitter: MarcelMeurer #> PARAM( [Parameter(Mandatory=$True)] [string]$AccessToken, [string]$rURI = "", [ValidateSet("PUT","GET","POST","PATCH","DELETE")] [String]$Method="GET", [String]$Body, [switch]$BinaryMode ) if ($Body -eq "") { $xBody=$null } else { $xBody=$Body } $ODRootURI="https://api.onedrive.com/v1.0" try { $webRequest=Invoke-WebRequest -Method $Method -Uri ($ODRootURI+$rURI) -Header @{ Authorization = "BEARER "+$AccessToken} -ContentType "application/json" -Body $xBody -UseBasicParsing -ErrorAction SilentlyContinue } catch { write-error("Cannot access the api. Webrequest return code is: "+$_.Exception.Response.StatusCode+"`n"+$_.Exception.Response.StatusDescription) break } switch ($webRequest.StatusCode) { 200 { if (!$BinaryMode) {$responseObject = ConvertFrom-Json $webRequest.Content} return $responseObject } 201 { write-debug("Success: "+$webRequest.StatusCode+" - "+$webRequest.StatusDescription) if (!$BinaryMode) {$responseObject = ConvertFrom-Json $webRequest.Content} return $responseObject } 204 { write-debug("Success: "+$webRequest.StatusCode+" - "+$webRequest.StatusDescription+" (item deleted)") $responseObject = "0" return $responseObject } default {write-warning("Cannot access the api. Webrequest return code is: "+$webRequest.StatusCode+"`n"+$webRequest.StatusDescription)} } } function Get-ODDrives { <# .DESCRIPTION Get user's drives. .PARAMETER AccessToken A valid access token for bearer authorization. .EXAMPLE Get-ODDrives -AccessToken $AuthToken List all OneDrives available for your account (there is normally only one). .NOTES Author: Marcel Meurer, marcel.meurer@sepago.de, Twitter: MarcelMeurer #> PARAM( [Parameter(Mandatory=$True)] [string]$AccessToken ) $ResponseObject=Get-ODWebContent -AccessToken $AccessToken -Method GET -rURI "/drives" return $ResponseObject.Value } function Format-ODPathorIDString { <# .DESCRIPTION Formats a given path like '/myFolder/mySubfolder/myFile' into an expected URI format .PARAMETER Path Specifies the path of an element. If it is not given, the path is "/" .PARAMETER ElementID Specifies the id of an element. If Path and ElementID are given, the ElementID is used with a warning .PARAMETER DriveID Specifies the OneDrive drive id. If not set, the default drive is used .NOTES Author: Marcel Meurer, marcel.meurer@sepago.de, Twitter: MarcelMeurer #> PARAM( [string]$Path="", [string]$DriveID="", [string]$ElementID="" ) if (!$ElementID -eq "") { # Use ElementID parameters if (!$Path -eq "") {write-debug("Warning: Path and ElementID parameters are set. Only ElementID is used!")} return "/drive/items/"+$ElementID } else { # Use Path parameter # replace some special characters $Path = ((((($Path -replace '%', '%25') -replace ' ', ' ') -replace '=', '%3d') -replace '\+', '%2b') -replace '&', '%26') -replace '#', '%23' # remove substring starts with "?" if ($Path.Contains("?")) {$Path=$Path.Substring(1,$Path.indexof("?")-1)} # replace "\" with "/" $Path=$Path.Replace("\","/") # filter possible string at the end "/children" (case insensitive) $Path=$Path+"/" $Path=$Path -replace "/children/","" # encoding of URL parts $tmpString="" foreach ($Sub in $Path.Split("/")) {$tmpString+=$Sub+"/"} $Path=$tmpString # remove last "/" if exist $Path=$Path.TrimEnd("/") # insert drive part of URL if ($DriveID -eq "") { # Default drive $Path="/drive/root:"+$Path+":" } else { # Named drive $Path="/drives/"+$DriveID+"/root:"+$Path+":" } return $Path } } function Get-ODItemProperty { <# .DESCRIPTION Get the properties of an item (file or folder). .PARAMETER AccessToken A valid access token for bearer authorization. .PARAMETER Path Specifies the path to the element/item. If not given, the properties of your default root drive are listed. .PARAMETER ElementID Specifies the id of the element/item. If Path and ElementID are given, the ElementID is used with a warning. .PARAMETER SelectProperties Specifies a comma-separated list of the properties to be returned for file and folder objects (case sensitive). If not set, name, size, lastModifiedDateTime and id are used. (See https://dev.onedrive.com/odata/optional-query-parameters.htm). If you use -SelectProperties "", all properties are listed. Warning: A complex "content.downloadUrl" is listed/generated for download files without authentication for several hours. .PARAMETER DriveID Specifies the OneDrive drive id. If not set, the default drive is used. .EXAMPLE Get-ODItemProperty -AccessToken $AuthToken -Path "/Data/documents/2016/AzureML with PowerShell.docx" Get the default set of metadata for a file or folder (name, size, lastModifiedDateTime, id) Get-ODItemProperty -AccessToken $AuthToken -ElementID 8BADCFF017EAA324!12169 -SelectProperties "" Get all metadata of a file or folder by element id ("" select all properties) .NOTES Author: Marcel Meurer, marcel.meurer@sepago.de, Twitter: MarcelMeurer #> PARAM( [Parameter(Mandatory=$True)] [string]$AccessToken, [string]$Path="/", [string]$ElementID="", [string]$SelectProperties="name,size,lastModifiedDateTime,id", [string]$DriveID="" ) return Get-ODChildItems -AccessToken $AccessToken -Path $Path -ElementID $ElementID -SelectProperties $SelectProperties -DriveID $DriveID -ItemPropertyMode } function Get-ODChildItems { <# .DESCRIPTION Get child items of a path. Return count is not limited. .PARAMETER AccessToken A valid access token for bearer authorization. .PARAMETER Path Specifies the path of elements to be listed. If not given, the path is "/". .PARAMETER ElementID Specifies the id of an element. If Path and ElementID are given, the ElementID is used with a warning. .PARAMETER SelectProperties Specifies a comma-separated list of the properties to be returned for file and folder objects (case sensitive). If not set, name, size, lastModifiedDateTime and id are used. (See https://dev.onedrive.com/odata/optional-query-parameters.htm). If you use -SelectProperties "", all properties are listed. Warning: A complex "content.downloadUrl" is listed/generated for download files without authentication for several hours. .PARAMETER DriveID Specifies the OneDrive drive id. If not set, the default drive is used. .EXAMPLE Get-ODChildItems -AccessToken $AuthToken -Path "/" | ft Lists files and folders in your OneDrives root folder and displays name, size, lastModifiedDateTime, id and folder property as a table Get-ODChildItems -AccessToken $AuthToken -Path "/" -SelectProperties "" Lists files and folders in your OneDrives root folder and displays all properties .NOTES Author: Marcel Meurer, marcel.meurer@sepago.de, Twitter: MarcelMeurer #> PARAM( [Parameter(Mandatory=$True)] [string]$AccessToken, [string]$Path="/", [string]$ElementID="", [string]$SelectProperties="name,size,lastModifiedDateTime,id", [string]$DriveID="", [Parameter(DontShow)] [switch]$ItemPropertyMode, [Parameter(DontShow)] [string]$SearchText ) $ODRootURI="https://api.onedrive.com/v1.0" if ($Path.Contains('$skiptoken=')) { # Recursive mode of odata.nextLink detection write-debug("Recursive call") $rURI=$Path } else { $rURI=Format-ODPathorIDString -path $Path -ElementID $ElementID -DriveID $DriveID $rURI=$rURI.Replace("::","") $SelectProperties=$SelectProperties.Replace(" ","") if ($SelectProperties -eq "") { $opt="" } else { $SelectProperties=$SelectProperties.Replace(" ","")+",folder" $opt="?select="+$SelectProperties } if ($ItemPropertyMode) { # item property mode $rURI=$rURI+$opt } else { if (!$SearchText -eq "") { # Search mode $opt="/view.search?q="+$SearchText+"&select="+$SelectProperties $rURI=$rURI+$opt } else { # child item mode $rURI=$rURI+"/children"+$opt } } } write-debug("Accessing API with GET to "+$rURI) $ResponseObject=Get-ODWebContent -AccessToken $AccessToken -Method GET -rURI $rURI if ($ResponseObject.PSobject.Properties.name -match "@odata.nextLink") { write-debug("Getting more elements form service (@odata.nextLink is present)") write-debug("LAST: "+$ResponseObject.value.count) Get-ODChildItems -AccessToken $AccessToken -SelectProperties $SelectProperties -Path $ResponseObject."@odata.nextLink".Replace($ODRootURI,"") } if ($ItemPropertyMode) { # item property mode return $ResponseObject } else { # child item mode return $ResponseObject.value } } function Search-ODItems { <# .DESCRIPTION Search for items starting from Path or ElementID. .PARAMETER AccessToken A valid access token for bearer authorization. .PARAMETER SearchText Specifies search string. .PARAMETER Path Specifies the path of the folder to start the search. If not given, the path is "/". .PARAMETER ElementID Specifies the element id of the folder to start the search. If Path and ElementID are given, the ElementID is used with a warning. .PARAMETER SelectProperties Specifies a comma-separated list of the properties to be returned for file and folder objects (case sensitive). If not set, name, size, lastModifiedDateTime and id are used. (See https://dev.onedrive.com/odata/optional-query-parameters.htm). If you use -SelectProperties "", all properties are listed. Warning: A complex "content.downloadUrl" is listed/generated for download files without authentication for several hours. .PARAMETER DriveID Specifies the OneDrive drive id. If not set, the default drive is used. .EXAMPLE Search-ODItems -AccessToken $AuthToken -Path "/My pictures" -SearchText "FolderA" Searches for items in a sub folder recursively. Take a look at OneDrives API documentation to see how search (preview) works (file and folder names, in files, …) .NOTES Author: Marcel Meurer, marcel.meurer@sepago.de, Twitter: MarcelMeurer #> PARAM( [Parameter(Mandatory=$True)] [string]$AccessToken, [Parameter(Mandatory=$True)] [string]$SearchText, [string]$Path="/", [string]$ElementID="", [string]$SelectProperties="name,size,lastModifiedDateTime,id", [string]$DriveID="" ) return Get-ODChildItems -AccessToken $AccessToken -Path $Path -ElementID $ElementID -SelectProperties $SelectProperties -DriveID $DriveID -SearchText $SearchText } function New-ODFolder { <# .DESCRIPTION Create a new folder. .PARAMETER AccessToken A valid access token for bearer authorization. .PARAMETER FolderName Name of the new folder. .PARAMETER Path Specifies the parent path for the new folder. If not given, the path is "/". .PARAMETER ElementID Specifies the element id for the new folder. If Path and ElementID are given, the ElementID is used with a warning. .PARAMETER DriveID Specifies the OneDrive drive id. If not set, the default drive is used. .EXAMPLE New-ODFolder -AccessToken $AuthToken -Path "/data/documents" -FolderName "2016" Creates a new folder "2016" under "/data/documents" .NOTES Author: Marcel Meurer, marcel.meurer@sepago.de, Twitter: MarcelMeurer #> PARAM( [Parameter(Mandatory=$True)] [string]$AccessToken, [Parameter(Mandatory=$True)] [string]$FolderName, [string]$Path="/", [string]$ElementID="", [string]$DriveID="" ) $rURI=Format-ODPathorIDString -path $Path -ElementID $ElementID -DriveID $DriveID $rURI=$rURI+"/children" return Get-ODWebContent -AccessToken $AccessToken -Method POST -rURI $rURI -Body ('{"name": "'+$FolderName+'","folder": { },"@name.conflictBehavior": "fail"}') } function Remove-ODItem { <# .DESCRIPTION Delete an item (folder or file). .PARAMETER AccessToken A valid access token for bearer authorization. .PARAMETER Path Specifies the path of the item to be deleted. .PARAMETER ElementID Specifies the element id of the item to be deleted. .PARAMETER DriveID Specifies the OneDrive drive id. If not set, the default drive is used. .EXAMPLE Remove-ODItem -AccessToken $AuthToken -Path "/Data/documents/2016/Azure-big-picture.old.docx" Deletes an item .NOTES Author: Marcel Meurer, marcel.meurer@sepago.de, Twitter: MarcelMeurer #> PARAM( [Parameter(Mandatory=$True)] [string]$AccessToken, [string]$Path="", [string]$ElementID="", [string]$DriveID="" ) if (($ElementID+$Path) -eq "") { write-error("Path nor ElementID is set") } else { $rURI=Format-ODPathorIDString -path $Path -ElementID $ElementID -DriveID $DriveID return Get-ODWebContent -AccessToken $AccessToken -Method DELETE -rURI $rURI } } function Get-ODItem { <# .DESCRIPTION Download an item/file. Warning: A local file will be overwritten. .PARAMETER AccessToken A valid access token for bearer authorization. .PARAMETER Path Specifies the path of the file to download. .PARAMETER ElementID Specifies the element id of the file to download. If Path and ElementID are given, the ElementID is used with a warning. .PARAMETER DriveID Specifies the OneDrive drive id. If not set, the default drive is used. .PARAMETER LocalPath Save file to path (if not given, the current local path is used). .PARAMETER LocalFileName Local filename. If not given, the file name of OneDrive is used. .EXAMPLE Get-ODItem -AccessToken $AuthToken -Path "/Data/documents/2016/Powershell array custom objects.docx" Downloads a file from OneDrive .NOTES Author: Marcel Meurer, marcel.meurer@sepago.de, Twitter: MarcelMeurer #> PARAM( [Parameter(Mandatory=$True)] [string]$AccessToken, [string]$Path="", [string]$ElementID="", [string]$DriveID="", [string]$LocalPath="", [string]$LocalFileName ) if (($ElementID+$Path) -eq "") { write-error("Path nor ElementID is set") } else { $Download=Get-ODItemProperty -AccessToken $AccessToken -Path $Path -ElementID $ElementID -DriveID $DriveID -SelectProperties "name,@content.downloadUrl" if ($LocalPath -eq "") {$LocalPath=Get-Location} if ($LocalFileName -eq "") { $SaveTo=$LocalPath.TrimEnd("\")+"\"+$Download.name } else { $SaveTo=$LocalPath.TrimEnd("\")+"\"+$LocalFileName } try { [System.Net.WebClient]::WebClient $client = New-Object System.Net.WebClient $client.DownloadFile($Download."@content.downloadUrl",$SaveTo) write-verbose("Download complete") return 0 } catch { write-error("Download error: "+$_.Exception.Response.StatusCode+"`n"+$_.Exception.Response.StatusDescription) return -1 } } } function Add-ODItem { <# .DESCRIPTION Upload an item/file. Warning: An existing file will be overwritten. .PARAMETER AccessToken A valid access token for bearer authorization. .PARAMETER Path Specifies the path for the upload folder. If not given, the path is "/". .PARAMETER ElementID Specifies the element id for the upload folder. If Path and ElementID are given, the ElementID is used with a warning. .PARAMETER DriveID Specifies the OneDrive drive id. If not set, the default drive is used. .PARAMETER LocalFile Path and file of the local file to be uploaded (C:\data\data.csv). .EXAMPLE Add-ODItem -AccessToken $AuthToken -Path "/Data/documents/2016" -LocalFile "AzureML with PowerShell.docx" Upload a file to OneDrive "/data/documents/2016" .NOTES Author: Marcel Meurer, marcel.meurer@sepago.de, Twitter: MarcelMeurer #> PARAM( [Parameter(Mandatory=$True)] [string]$AccessToken, [string]$Path="/", [string]$ElementID="", [string]$DriveID="", [Parameter(Mandatory=$True)] [string]$LocalFile="" ) $rURI=Format-ODPathorIDString -path $Path -ElementID $ElementID -DriveID $DriveID try { $ODRootURI="https://api.onedrive.com/v1.0" $rURI=(($ODRootURI+$rURI).TrimEnd(":")+"/"+[System.IO.Path]::GetFileName($LocalFile)+":/content").Replace("/root/","/root:/") return $webRequest=Invoke-WebRequest -Method PUT -InFile $LocalFile -Uri $rURI -Header @{ Authorization = "BEARER "+$AccessToken} -ContentType "multipart/form-data" -UseBasicParsing -ErrorAction SilentlyContinue } catch { write-error("Upload error: "+$_.Exception.Response.StatusCode+"`n"+$_.Exception.Response.StatusDescription) return -1 } } function Move-ODItem { <# .DESCRIPTION Moves a file to a new location or renames it. .PARAMETER AccessToken A valid access token for bearer authorization. .PARAMETER Path Specifies the path of the file to be moved. .PARAMETER ElementID Specifies the element id of the file to be moved. If Path and ElementID are given, the ElementID is used with a warning. .PARAMETER DriveID Specifies the OneDrive drive id. If not set, the default drive is used. .PARAMETER TargetPath Save file to the target path in the same OneDrive drive (ElementID for the target path is not supported yet). .PARAMETER NewName The new name of the file. If missing, the file will only be moved. .EXAMPLE Move-ODItem -AccessToken $at -path "/Notes.txt" -TargetPath "/x" -NewName "_Notes.txt" Moves and renames a file in one step Move-ODItem -AccessToken $at -path "/Notes.txt" -NewName "_Notes.txt" # Rename a file Move-ODItem -AccessToken $at -path "/Notes.txt" -TargetPath "/x" # Move a file .NOTES Author: Marcel Meurer, marcel.meurer@sepago.de, Twitter: MarcelMeurer #> PARAM( [Parameter(Mandatory=$True)] [string]$AccessToken, [string]$Path="", [string]$ElementID="", [string]$DriveID="", [string]$TargetPath="", [string]$NewName="" ) if (($ElementID+$Path) -eq "") { write-error("Path nor ElementID is set") } else { if (($TargetPath+$NewName) -eq "") { write-error("TargetPath nor NewName is set") } else { $body='{' if (!$NewName -eq "") { $body=$body+'"name": "'+$NewName+'"' If (!$TargetPath -eq "") { $body=$body+',' } } if (!$TargetPath -eq "") { $rTURI=Format-ODPathorIDString -path $TargetPath -DriveID $DriveID $body=$body+'"parentReference" : {"path": "'+$rTURI+'"}' } $body=$body+'}' $rURI=Format-ODPathorIDString -path $Path -ElementID $ElementID -DriveID $DriveID return Get-ODWebContent -AccessToken $AccessToken -Method PATCH -rURI $rURI -Body $body } } } |