public/Connect-Moodle.ps1
|
<#
.SYNOPSIS Connects to a Moodle instance with an authentication token or credentials. .DESCRIPTION Call Connect-Moodle to connect to a Moodle instance (using its URI and credentials or token) before calling other Moodle cmdlets. .PARAMETER Uri The base URI of the Moodle instance. .PARAMETER Credential Specifies a PSCredential object. For more information about the PSCredential object, type Get-Help Get-Credential. The PSCredential object provides the user ID and password for organizational ID credentials. .PARAMETER Token Specifies an authentication token, provided by your Moodle administrator. .EXAMPLE Connect-Moodle https://sandbox.moodledemo.net/ -Credential (Get-Credential) Prompts for your username and password, then connects to the Moodle sandbox demo instance. .NOTES See also: Disconnect-Moodle. #> function Connect-Moodle { [CmdletBinding(DefaultParameterSetName = 'cred')] param ( # The base URI of your Moodle instance. [Parameter(Mandatory, Position = 0)] [Alias('Url')] [uri]$Uri, # Secure login credentials for your Moodle instance. [Parameter(Mandatory, Position = 1, ParameterSetName = 'cred')] [PSCredential] $Credential, # The API token to connect to Moodle. [Parameter(Mandatory, Position = 1, ParameterSetName = 'token')] [string] $Token, # The proxy address needed to reach your Moodle instance. [Parameter(Position = 2)] [uri]$Proxy, # Secure credentials for your proxy server. [Parameter(Position = 3)] [PSCredential] $ProxyCredential, # Use current user credentials for your proxy server. [Parameter(Position = 4)] [switch] $ProxyUseDefaultCredentials ) $proxySettings = @{} if ($Proxy) { $proxySettings.Add("Proxy", $Proxy) if ($ProxyCredential) { $proxySettings.Add("ProxyCredential", $ProxyCredential) } else { if ($ProxyUseDefaultCredentials) { $proxySettings.Add("ProxyUseDefaultCredentials", $true) } } } $function = 'core_webservice_get_site_info' if ($Credential) { # Extract plain text password from credential $marshal = [Runtime.InteropServices.Marshal] $password = $marshal::PtrToStringAuto( $marshal::SecureStringToBSTR($Credential.Password) ) $path = "login/token.php?service=moodle_mobile_app&username=$($Credential.UserName)&password=$password" $result = Invoke-RestMethod -Uri ([uri]::new($Uri, $path)) @proxySettings $Token = $result.token if (!$Token) { throw 'Cannot connect to Moodle instance.' } } $path = "webservice/rest/server.php?wstoken=$Token&wsfunction=$function&moodlewsrestformat=json" $result = Invoke-RestMethod -Uri ([uri]::new($Uri, $path)) @proxySettings if ($result.SiteName) { Write-Verbose "Connected to $($result.SiteName) as user $($result.UserName)." $Script:_MoodleUrl = $Uri $Script:_MoodleToken = $Token $Script:_MoodleProxySettings = $proxySettings } else { throw "Could not connect to $Uri with the given token." } } |